1
/* Copyright (C) 2000-2003 MySQL AB
3
This program is free software; you can redistribute it and/or modify
4
it under the terms of the GNU General Public License as published by
5
the Free Software Foundation; version 2 of the License.
7
This program is distributed in the hope that it will be useful,
8
but WITHOUT ANY WARRANTY; without even the implied warranty of
9
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10
GNU General Public License for more details.
12
You should have received a copy of the GNU General Public License
13
along with this program; if not, write to the Free Software
14
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
16
/* This makes a wrapper for mutex handling to make it easier to debug mutex */
18
#include <my_global.h>
19
#if defined(TARGET_OS_LINUX) && !defined (__USE_UNIX98)
20
#define __USE_UNIX98 /* To get rw locks under Linux */
22
#if defined(THREAD) && defined(SAFE_MUTEX)
23
#undef SAFE_MUTEX /* Avoid safe_mutex redefinitions */
24
#include "mysys_priv.h"
25
#include "my_static.h"
28
#ifndef DO_NOT_REMOVE_THREAD_WRAPPERS
30
#undef pthread_mutex_t
31
#undef pthread_mutex_init
32
#undef pthread_mutex_lock
33
#undef pthread_mutex_unlock
34
#undef pthread_mutex_destroy
35
#undef pthread_cond_wait
36
#undef pthread_cond_timedwait
37
#ifdef HAVE_NONPOSIX_PTHREAD_MUTEX_INIT
38
#define pthread_mutex_init(a,b) my_pthread_mutex_init((a),(b))
40
#endif /* DO_NOT_REMOVE_THREAD_WRAPPERS */
42
static pthread_mutex_t THR_LOCK_mutex;
43
static ulong safe_mutex_count= 0; /* Number of mutexes created */
44
#ifdef SAFE_MUTEX_DETECT_DESTROY
45
static struct st_safe_mutex_info_t *safe_mutex_root= NULL;
48
void safe_mutex_global_init(void)
50
pthread_mutex_init(&THR_LOCK_mutex,MY_MUTEX_INIT_FAST);
54
int safe_mutex_init(safe_mutex_t *mp,
55
const pthread_mutexattr_t *attr __attribute__((unused)),
59
bzero((char*) mp,sizeof(*mp));
60
pthread_mutex_init(&mp->global,MY_MUTEX_INIT_ERRCHK);
61
pthread_mutex_init(&mp->mutex,attr);
62
/* Mark that mutex is initialized */
66
#ifdef SAFE_MUTEX_DETECT_DESTROY
68
Monitor the freeing of mutexes. This code depends on single thread init
71
if ((mp->info= (safe_mutex_info_t *) malloc(sizeof(safe_mutex_info_t))))
73
struct st_safe_mutex_info_t *info =mp->info;
75
info->init_file= file;
76
info->init_line= line;
80
pthread_mutex_lock(&THR_LOCK_mutex);
81
if ((info->next= safe_mutex_root))
82
safe_mutex_root->prev= info;
83
safe_mutex_root= info;
85
pthread_mutex_unlock(&THR_LOCK_mutex);
88
thread_safe_increment(safe_mutex_count, &THR_LOCK_mutex);
89
#endif /* SAFE_MUTEX_DETECT_DESTROY */
94
int safe_mutex_lock(safe_mutex_t *mp, my_bool try_lock, const char *file, uint line)
100
"safe_mutex: Trying to lock unitialized mutex at %s, line %d\n",
106
pthread_mutex_lock(&mp->global);
111
pthread_mutex_unlock(&mp->global);
114
else if (pthread_equal(pthread_self(),mp->thread))
117
"safe_mutex: Trying to lock mutex at %s, line %d, when the"
118
" mutex was already locked at %s, line %d in thread %s\n",
119
file,line,mp->file, mp->line, my_thread_name());
124
pthread_mutex_unlock(&mp->global);
127
If we are imitating trylock(), we need to take special
130
- We cannot use pthread_mutex_lock() only since another thread can
131
overtake this thread and take the lock before this thread
132
causing pthread_mutex_trylock() to hang. In this case, we should
133
just return EBUSY. Hence, we use pthread_mutex_trylock() to be
134
able to return immediately.
136
- We cannot just use trylock() and continue execution below, since
137
this would generate an error and abort execution if the thread
138
was overtaken and trylock() returned EBUSY . In this case, we
139
instead just return EBUSY, since this is the expected behaviour
144
error= pthread_mutex_trylock(&mp->mutex);
149
error= pthread_mutex_lock(&mp->mutex);
151
if (error || (error=pthread_mutex_lock(&mp->global)))
153
fprintf(stderr,"Got error %d when trying to lock mutex at %s, line %d\n",
158
mp->thread= pthread_self();
161
fprintf(stderr,"safe_mutex: Error in thread libray: Got mutex at %s, \
162
line %d more than 1 time\n", file,line);
168
pthread_mutex_unlock(&mp->global);
173
int safe_mutex_unlock(safe_mutex_t *mp,const char *file, uint line)
176
pthread_mutex_lock(&mp->global);
179
fprintf(stderr,"safe_mutex: Trying to unlock mutex that wasn't locked at %s, line %d\n Last used at %s, line: %d\n",
180
file,line,mp->file ? mp->file : "",mp->line);
184
if (!pthread_equal(pthread_self(),mp->thread))
186
fprintf(stderr,"safe_mutex: Trying to unlock mutex at %s, line %d that was locked by another thread at: %s, line: %d\n",
187
file,line,mp->file,mp->line);
194
pthread_mutex_unlock(&mp->mutex);
197
error=pthread_mutex_unlock(&mp->mutex);
200
fprintf(stderr,"safe_mutex: Got error: %d (%d) when trying to unlock mutex at %s, line %d\n", error, errno, file, line);
205
pthread_mutex_unlock(&mp->global);
210
int safe_cond_wait(pthread_cond_t *cond, safe_mutex_t *mp, const char *file,
214
pthread_mutex_lock(&mp->global);
217
fprintf(stderr,"safe_mutex: Trying to cond_wait on a unlocked mutex at %s, line %d\n",file,line);
221
if (!pthread_equal(pthread_self(),mp->thread))
223
fprintf(stderr,"safe_mutex: Trying to cond_wait on a mutex at %s, line %d that was locked by another thread at: %s, line: %d\n",
224
file,line,mp->file,mp->line);
229
if (mp->count-- != 1)
231
fprintf(stderr,"safe_mutex: Count was %d on locked mutex at %s, line %d\n",
232
mp->count+1, file, line);
236
pthread_mutex_unlock(&mp->global);
237
error=pthread_cond_wait(cond,&mp->mutex);
238
pthread_mutex_lock(&mp->global);
241
fprintf(stderr,"safe_mutex: Got error: %d (%d) when doing a safe_mutex_wait at %s, line %d\n", error, errno, file, line);
245
mp->thread=pthread_self();
249
"safe_mutex: Count was %d in thread 0x%lx when locking mutex at %s, line %d\n",
250
mp->count-1, my_thread_dbug_id(), file, line);
256
pthread_mutex_unlock(&mp->global);
261
int safe_cond_timedwait(pthread_cond_t *cond, safe_mutex_t *mp,
262
struct timespec *abstime,
263
const char *file, uint line)
266
pthread_mutex_lock(&mp->global);
267
if (mp->count != 1 || !pthread_equal(pthread_self(),mp->thread))
269
fprintf(stderr,"safe_mutex: Trying to cond_wait at %s, line %d on a not hold mutex\n",file,line);
273
mp->count--; /* Mutex will be released */
274
pthread_mutex_unlock(&mp->global);
275
error=pthread_cond_timedwait(cond,&mp->mutex,abstime);
277
if (error && (error != EINTR && error != ETIMEDOUT && error != ETIME))
279
fprintf(stderr,"safe_mutex: Got error: %d (%d) when doing a safe_mutex_timedwait at %s, line %d\n", error, errno, file, line);
282
pthread_mutex_lock(&mp->global);
283
mp->thread=pthread_self();
287
"safe_mutex: Count was %d in thread 0x%lx when locking mutex at %s, line %d (error: %d (%d))\n",
288
mp->count-1, my_thread_dbug_id(), file, line, error, error);
294
pthread_mutex_unlock(&mp->global);
299
int safe_mutex_destroy(safe_mutex_t *mp, const char *file, uint line)
305
"safe_mutex: Trying to destroy unitialized mutex at %s, line %d\n",
312
fprintf(stderr,"safe_mutex: Trying to destroy a mutex that was locked at %s, line %d at %s, line %d\n",
313
mp->file,mp->line, file, line);
318
pthread_mutex_destroy(&mp->global);
319
pthread_mutex_destroy(&mp->mutex);
321
if (pthread_mutex_destroy(&mp->global))
323
if (pthread_mutex_destroy(&mp->mutex))
326
mp->file= 0; /* Mark destroyed */
328
#ifdef SAFE_MUTEX_DETECT_DESTROY
331
struct st_safe_mutex_info_t *info= mp->info;
332
pthread_mutex_lock(&THR_LOCK_mutex);
335
info->prev->next = info->next;
337
safe_mutex_root = info->next;
339
info->next->prev = info->prev;
342
pthread_mutex_unlock(&THR_LOCK_mutex);
344
mp->info= NULL; /* Get crash if double free */
347
thread_safe_sub(safe_mutex_count, 1, &THR_LOCK_mutex);
348
#endif /* SAFE_MUTEX_DETECT_DESTROY */
354
Free global resources and check that all mutex has been destroyed
358
file Print errors on this file
361
We can't use DBUG_PRINT() here as we have in my_end() disabled
362
DBUG handling before calling this function.
364
In MySQL one may get one warning for a mutex created in my_thr_init.c
365
This is ok, as this thread may not yet have been exited.
368
void safe_mutex_end(FILE *file __attribute__((unused)))
370
if (!safe_mutex_count) /* safetly */
371
pthread_mutex_destroy(&THR_LOCK_mutex);
372
#ifdef SAFE_MUTEX_DETECT_DESTROY
376
if (safe_mutex_count)
378
fprintf(file, "Warning: Not destroyed mutex: %lu\n", safe_mutex_count);
382
struct st_safe_mutex_info_t *ptr;
383
for (ptr= safe_mutex_root ; ptr ; ptr= ptr->next)
385
fprintf(file, "\tMutex initiated at line %4u in '%s'\n",
386
ptr->init_line, ptr->init_file);
390
#endif /* SAFE_MUTEX_DETECT_DESTROY */
393
#endif /* THREAD && SAFE_MUTEX */
395
#if defined(THREAD) && defined(MY_PTHREAD_FASTMUTEX) && !defined(SAFE_MUTEX)
397
#include "mysys_priv.h"
398
#include "my_static.h"
399
#include <m_string.h>
403
#include <myisampack.h>
404
#include <mysys_err.h>
407
#undef pthread_mutex_t
408
#undef pthread_mutex_init
409
#undef pthread_mutex_lock
410
#undef pthread_mutex_trylock
411
#undef pthread_mutex_unlock
412
#undef pthread_mutex_destroy
413
#undef pthread_cond_wait
414
#undef pthread_cond_timedwait
416
ulong mutex_delay(ulong delayloops)
423
for (i = 0; i < delayloops * 50; i++)
429
#define MY_PTHREAD_FASTMUTEX_SPINS 8
430
#define MY_PTHREAD_FASTMUTEX_DELAY 4
432
static int cpu_count= 0;
434
int my_pthread_fastmutex_init(my_pthread_fastmutex_t *mp,
435
const pthread_mutexattr_t *attr)
437
if ((cpu_count > 1) && (attr == MY_MUTEX_INIT_FAST))
438
mp->spins= MY_PTHREAD_FASTMUTEX_SPINS;
442
return pthread_mutex_init(&mp->mutex, attr);
446
Park-Miller random number generator. A simple linear congruential
447
generator that operates in multiplicative group of integers modulo n.
449
x_{k+1} = (x_k g) mod n
451
Popular pair of parameters: n = 2^32 − 5 = 4294967291 and g = 279470273.
452
The period of the generator is about 2^31.
453
Largest value that can be returned: 2147483646 (RAND_MAX)
457
S. K. Park and K. W. Miller
458
"Random number generators: good ones are hard to find"
459
Commun. ACM, October 1988, Volume 31, No 10, pages 1192-1201.
462
static double park_rng(my_pthread_fastmutex_t *mp)
464
mp->rng_state= ((my_ulonglong)mp->rng_state * 279470273U) % 4294967291U;
465
return (mp->rng_state / 2147483647.0);
468
int my_pthread_fastmutex_lock(my_pthread_fastmutex_t *mp)
472
uint maxdelay= MY_PTHREAD_FASTMUTEX_DELAY;
474
for (i= 0; i < mp->spins; i++)
476
res= pthread_mutex_trylock(&mp->mutex);
484
mutex_delay(maxdelay);
485
maxdelay += park_rng(mp) * MY_PTHREAD_FASTMUTEX_DELAY + 1;
487
return pthread_mutex_lock(&mp->mutex);
491
void fastmutex_global_init(void)
493
#ifdef _SC_NPROCESSORS_CONF
494
cpu_count= sysconf(_SC_NPROCESSORS_CONF);
498
#endif /* defined(THREAD) && defined(MY_PTHREAD_FASTMUTEX) && !defined(SAFE_MUTEX) */