/* Copyright (c) 2000-2008 MySQL AB, 2008, 2009 Sun Microsystems, Inc. Use is subject to license terms. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ /* Functions to handle initializating and allocationg of all mysys & debug thread variables. */ #include "mysys_priv.h" #include #include #ifdef THREAD #ifdef USE_TLS pthread_key(struct st_my_thread_var*, THR_KEY_mysys); #else pthread_key(struct st_my_thread_var, THR_KEY_mysys); #endif /* USE_TLS */ pthread_mutex_t THR_LOCK_malloc,THR_LOCK_open, THR_LOCK_lock,THR_LOCK_isam,THR_LOCK_myisam,THR_LOCK_heap, THR_LOCK_net, THR_LOCK_charset, THR_LOCK_threads, THR_LOCK_time, THR_LOCK_myisam_mmap; pthread_cond_t THR_COND_threads; uint THR_thread_count= 0; uint my_thread_end_wait_time= 5; #if !defined(HAVE_LOCALTIME_R) || !defined(HAVE_GMTIME_R) pthread_mutex_t LOCK_localtime_r; #endif #ifndef HAVE_GETHOSTBYNAME_R pthread_mutex_t LOCK_gethostbyname_r; #endif #ifdef TARGET_OS_LINUX /* Dummy thread spawned in my_thread_global_init() below to avoid race conditions in NPTL pthread_exit code. */ static pthread_handler_t nptl_pthread_exit_hack_handler(void *arg __attribute((unused))) { /* Do nothing! */ pthread_exit(0); return 0; } #endif /* TARGET_OS_LINUX */ /** Initialize thread attributes. */ void my_threadattr_global_init(void) { #ifdef PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP /* Set mutex type to "fast" a.k.a "adaptive" In this case the thread may steal the mutex from some other thread that is waiting for the same mutex. This will save us some context switches but may cause a thread to 'starve forever' while waiting for the mutex (not likely if the code within the mutex is short). */ pthread_mutexattr_init(&my_fast_mutexattr); /* ?= MY_MUTEX_INIT_FAST */ pthread_mutexattr_settype(&my_fast_mutexattr, PTHREAD_MUTEX_ADAPTIVE_NP); #endif #ifdef PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP /* Set mutex type to "errorcheck" */ pthread_mutexattr_init(&my_errorcheck_mutexattr); pthread_mutexattr_settype(&my_errorcheck_mutexattr, PTHREAD_MUTEX_ERRORCHECK); #endif } static uint get_thread_lib(void); /* initialize thread environment SYNOPSIS my_thread_global_init() RETURN 0 ok 1 error (Couldn't create THR_KEY_mysys) */ my_bool my_thread_global_init(void) { int pth_ret; thd_lib_detected= get_thread_lib(); if ((pth_ret= pthread_key_create(&THR_KEY_mysys, NULL)) != 0) { fprintf(stderr,"Can't initialize threads: error %d\n", pth_ret); return 1; } #ifdef TARGET_OS_LINUX /* BUG#24507: Race conditions inside current NPTL pthread_exit() implementation. To avoid a possible segmentation fault during concurrent executions of pthread_exit(), a dummy thread is spawned which initializes internal variables of pthread lib. See bug description for a full explanation. TODO: Remove this code when fixed versions of glibc6 are in common use. */ if (thd_lib_detected == THD_LIB_NPTL) { pthread_t dummy_thread; pthread_attr_t dummy_thread_attr; pthread_attr_init(&dummy_thread_attr); pthread_attr_setdetachstate(&dummy_thread_attr, PTHREAD_CREATE_JOINABLE); if (pthread_create(&dummy_thread,&dummy_thread_attr, nptl_pthread_exit_hack_handler, NULL) == 0) (void)pthread_join(dummy_thread, NULL); } #endif /* TARGET_OS_LINUX */ /* Mutex used by my_thread_init() and after my_thread_destroy_mutex() */ my_pthread_mutex_init(&THR_LOCK_threads, MY_MUTEX_INIT_FAST, "THR_LOCK_threads", MYF_NO_DEADLOCK_DETECTION); my_pthread_mutex_init(&THR_LOCK_malloc, MY_MUTEX_INIT_FAST, "THR_LOCK_malloc", MYF_NO_DEADLOCK_DETECTION); if (my_thread_init()) return 1; /* Mutex uses by mysys */ pthread_mutex_init(&THR_LOCK_open,MY_MUTEX_INIT_FAST); pthread_mutex_init(&THR_LOCK_lock,MY_MUTEX_INIT_FAST); pthread_mutex_init(&THR_LOCK_isam,MY_MUTEX_INIT_SLOW); pthread_mutex_init(&THR_LOCK_myisam,MY_MUTEX_INIT_SLOW); pthread_mutex_init(&THR_LOCK_myisam_mmap,MY_MUTEX_INIT_FAST); pthread_mutex_init(&THR_LOCK_heap,MY_MUTEX_INIT_FAST); pthread_mutex_init(&THR_LOCK_net,MY_MUTEX_INIT_FAST); pthread_mutex_init(&THR_LOCK_charset,MY_MUTEX_INIT_FAST); pthread_mutex_init(&THR_LOCK_time,MY_MUTEX_INIT_FAST); pthread_cond_init(&THR_COND_threads, NULL); #if defined( __WIN__) || defined(OS2) win_pthread_init(); #endif #if !defined(HAVE_LOCALTIME_R) || !defined(HAVE_GMTIME_R) pthread_mutex_init(&LOCK_localtime_r,MY_MUTEX_INIT_SLOW); #endif #ifndef HAVE_GETHOSTBYNAME_R pthread_mutex_init(&LOCK_gethostbyname_r,MY_MUTEX_INIT_SLOW); #endif return 0; } /** Wait for all threads in system to die @fn my_wait_for_other_threads_to_die() @param number_of_threads Wait until this number of threads @retval 0 Less or equal to number_of_threads left @retval 1 Wait failed */ my_bool my_wait_for_other_threads_to_die(uint number_of_threads) { struct timespec abstime; my_bool all_threads_killed= 1; set_timespec(abstime, my_thread_end_wait_time); pthread_mutex_lock(&THR_LOCK_threads); while (THR_thread_count > number_of_threads) { int error= pthread_cond_timedwait(&THR_COND_threads, &THR_LOCK_threads, &abstime); if (error == ETIMEDOUT || error == ETIME) { all_threads_killed= 0; break; } } pthread_mutex_unlock(&THR_LOCK_threads); return all_threads_killed; } /** End the mysys thread system. Called when ending the last thread */ void my_thread_global_end(void) { my_bool all_threads_killed; if (!(all_threads_killed= my_wait_for_other_threads_to_die(0))) { #ifdef HAVE_PTHREAD_KILL /* We shouldn't give an error here, because if we don't have pthread_kill(), programs like mysqld can't ensure that all threads are killed when we enter here. */ if (THR_thread_count) fprintf(stderr, "Error in my_thread_global_end(): %d threads didn't exit\n", THR_thread_count); #endif } pthread_key_delete(THR_KEY_mysys); if (all_threads_killed) { pthread_mutex_destroy(&THR_LOCK_threads); pthread_cond_destroy(&THR_COND_threads); pthread_mutex_destroy(&THR_LOCK_malloc); } } /* Free all mutex used by mysys */ void my_thread_destroy_mutex(void) { struct st_my_thread_var *tmp; tmp= my_pthread_getspecific(struct st_my_thread_var*,THR_KEY_mysys); if (tmp) { safe_mutex_free_deadlock_data(&tmp->mutex); } pthread_mutex_destroy(&THR_LOCK_open); pthread_mutex_destroy(&THR_LOCK_lock); pthread_mutex_destroy(&THR_LOCK_isam); pthread_mutex_destroy(&THR_LOCK_myisam); pthread_mutex_destroy(&THR_LOCK_myisam_mmap); pthread_mutex_destroy(&THR_LOCK_heap); pthread_mutex_destroy(&THR_LOCK_net); pthread_mutex_destroy(&THR_LOCK_time); pthread_mutex_destroy(&THR_LOCK_charset); #if !defined(HAVE_LOCALTIME_R) || !defined(HAVE_GMTIME_R) pthread_mutex_destroy(&LOCK_localtime_r); #endif #ifndef HAVE_GETHOSTBYNAME_R pthread_mutex_destroy(&LOCK_gethostbyname_r); #endif } static my_thread_id thread_id= 0; /* Allocate thread specific memory for the thread, used by mysys and dbug SYNOPSIS my_thread_init() NOTES We can't use mutex_locks here if we are using windows as we may have compiled the program with SAFE_MUTEX, in which case the checking of mutex_locks will not work until the pthread_self thread specific variable is initialized. This function may called multiple times for a thread, for example if one uses my_init() followed by mysql_server_init(). RETURN 0 ok 1 Fatal error; mysys/dbug functions can't be used */ my_bool my_thread_init(void) { struct st_my_thread_var *tmp; my_bool error=0; #ifdef EXTRA_DEBUG_THREADS fprintf(stderr,"my_thread_init(): thread_id: 0x%lx\n", (ulong) pthread_self()); #endif #if !defined(__WIN__) || defined(USE_TLS) if (my_pthread_getspecific(struct st_my_thread_var *,THR_KEY_mysys)) { #ifdef EXTRA_DEBUG_THREADS fprintf(stderr,"my_thread_init() called more than once in thread 0x%lx\n", (long) pthread_self()); #endif goto end; } if (!(tmp= (struct st_my_thread_var *) calloc(1, sizeof(*tmp)))) { error= 1; goto end; } pthread_setspecific(THR_KEY_mysys,tmp); #else /* defined(__WIN__) && !(defined(USE_TLS) */ /* Skip initialization if the thread specific variable is already initialized */ if (THR_KEY_mysys.init) goto end; tmp= &THR_KEY_mysys; #endif #if defined(__WIN__) && defined(EMBEDDED_LIBRARY) tmp->pthread_self= (pthread_t) getpid(); #else tmp->pthread_self= pthread_self(); #endif my_pthread_mutex_init(&tmp->mutex, MY_MUTEX_INIT_FAST, "mysys_var->mutex", 0); pthread_cond_init(&tmp->suspend, NULL); tmp->stack_ends_here= (char*)&tmp + STACK_DIRECTION * (long)my_thread_stack_size; pthread_mutex_lock(&THR_LOCK_threads); tmp->id= ++thread_id; ++THR_thread_count; pthread_mutex_unlock(&THR_LOCK_threads); tmp->init= 1; #ifndef DBUG_OFF /* Generate unique name for thread */ (void) my_thread_name(); #endif end: return error; } /* Deallocate memory used by the thread for book-keeping SYNOPSIS my_thread_end() NOTE This may be called multiple times for a thread. This happens for example when one calls 'mysql_server_init()' mysql_server_end() and then ends with a mysql_end(). */ void my_thread_end(void) { struct st_my_thread_var *tmp; tmp= my_pthread_getspecific(struct st_my_thread_var*,THR_KEY_mysys); #ifdef EXTRA_DEBUG_THREADS fprintf(stderr,"my_thread_end(): tmp: 0x%lx pthread_self: 0x%lx thread_id: %ld\n", (long) tmp, (long) pthread_self(), tmp ? (long) tmp->id : 0L); #endif if (tmp && tmp->init) { #if !defined(__bsdi__) && !defined(__OpenBSD__) /* bsdi and openbsd 3.5 dumps core here */ pthread_cond_destroy(&tmp->suspend); #endif pthread_mutex_destroy(&tmp->mutex); #if !defined(DBUG_OFF) /* tmp->dbug is allocated inside DBUG library */ if (tmp->dbug) { DBUG_POP(); free(tmp->dbug); tmp->dbug=0; } #endif #if !defined(__WIN__) || defined(USE_TLS) #ifndef DBUG_OFF /* To find bugs when accessing unallocated data */ bfill(tmp, sizeof(tmp), 0x8F); #endif free(tmp); #else tmp->init= 0; #endif #if !defined(__WIN__) || defined(USE_TLS) pthread_setspecific(THR_KEY_mysys,0); #endif /* Decrement counter for number of running threads. We are using this in my_thread_global_end() to wait until all threads have called my_thread_end and thus freed all memory they have allocated in my_thread_init() and DBUG_xxxx */ pthread_mutex_lock(&THR_LOCK_threads); DBUG_ASSERT(THR_thread_count != 0); if (--THR_thread_count == 0) pthread_cond_signal(&THR_COND_threads); pthread_mutex_unlock(&THR_LOCK_threads); } else { #if !defined(__WIN__) || defined(USE_TLS) pthread_setspecific(THR_KEY_mysys,0); #endif } } struct st_my_thread_var *_my_thread_var(void) { return my_pthread_getspecific(struct st_my_thread_var*,THR_KEY_mysys); } #ifndef DBUG_OFF /* Return pointer to DBUG for holding current state */ extern void **my_thread_var_dbug() { struct st_my_thread_var *tmp= my_pthread_getspecific(struct st_my_thread_var*,THR_KEY_mysys); return tmp && tmp->init ? &tmp->dbug : 0; } #endif /* Return pointer to mutex_in_use */ safe_mutex_t **my_thread_var_mutex_in_use() { struct st_my_thread_var *tmp= my_pthread_getspecific(struct st_my_thread_var*,THR_KEY_mysys); return tmp ? &tmp->mutex_in_use : 0; } /**************************************************************************** Get name of current thread. ****************************************************************************/ my_thread_id my_thread_dbug_id() { return my_thread_var->id; } #ifdef DBUG_OFF const char *my_thread_name(void) { return "no_name"; } #else const char *my_thread_name(void) { char name_buff[100]; struct st_my_thread_var *tmp=my_thread_var; if (!tmp->name[0]) { my_thread_id id= my_thread_dbug_id(); sprintf(name_buff,"T@%lu", (ulong) id); strmake(tmp->name,name_buff,THREAD_NAME_SIZE); } return tmp->name; } #endif /* DBUG_OFF */ static uint get_thread_lib(void) { #ifdef _CS_GNU_LIBPTHREAD_VERSION char buff[64]; confstr(_CS_GNU_LIBPTHREAD_VERSION, buff, sizeof(buff)); if (!strncasecmp(buff, "NPTL", 4)) return THD_LIB_NPTL; if (!strncasecmp(buff, "linuxthreads", 12)) return THD_LIB_LT; #endif return THD_LIB_OTHER; } #endif /* THREAD */