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 "mysys_priv.h"
20
#if defined(TARGET_OS_LINUX) && !defined (__USE_UNIX98)
21
#define __USE_UNIX98 /* To get rw locks under Linux */
23
#if defined(SAFE_MUTEX)
24
#undef SAFE_MUTEX /* Avoid safe_mutex redefinitions */
25
#include <mysys/my_static.h>
26
#include <mystrings/m_string.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 uint32_t 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 *, const char *file, uint32_t line)
57
memset(mp, 0, sizeof(*mp));
58
pthread_mutex_init(&mp->global,MY_MUTEX_INIT_ERRCHK);
59
pthread_mutex_init(&mp->mutex,attr);
60
/* Mark that mutex is initialized */
64
#ifdef SAFE_MUTEX_DETECT_DESTROY
66
Monitor the freeing of mutexes. This code depends on single thread init
69
if ((mp->info= (safe_mutex_info_t *) malloc(sizeof(safe_mutex_info_t))))
71
struct st_safe_mutex_info_t *info =mp->info;
73
info->init_file= file;
74
info->init_line= line;
78
pthread_mutex_lock(&THR_LOCK_mutex);
79
if ((info->next= safe_mutex_root))
80
safe_mutex_root->prev= info;
81
safe_mutex_root= info;
83
pthread_mutex_unlock(&THR_LOCK_mutex);
86
thread_safe_increment(safe_mutex_count, &THR_LOCK_mutex);
87
#endif /* SAFE_MUTEX_DETECT_DESTROY */
92
int safe_mutex_lock(safe_mutex_t *mp, bool try_lock, const char *file, uint32_t line)
98
"safe_mutex: Trying to lock unitialized mutex at %s, line %d\n",
104
pthread_mutex_lock(&mp->global);
109
pthread_mutex_unlock(&mp->global);
112
else if (pthread_equal(pthread_self(),mp->thread))
115
"safe_mutex: Trying to lock mutex at %s, line %d, when the"
116
" mutex was already locked at %s, line %d in thread %s\n",
117
file,line,mp->file, mp->line, my_thread_name());
122
pthread_mutex_unlock(&mp->global);
125
If we are imitating trylock(), we need to take special
128
- We cannot use pthread_mutex_lock() only since another thread can
129
overtake this thread and take the lock before this thread
130
causing pthread_mutex_trylock() to hang. In this case, we should
131
just return EBUSY. Hence, we use pthread_mutex_trylock() to be
132
able to return immediately.
134
- We cannot just use trylock() and continue execution below, since
135
this would generate an error and abort execution if the thread
136
was overtaken and trylock() returned EBUSY . In this case, we
137
instead just return EBUSY, since this is the expected behaviour
142
error= pthread_mutex_trylock(&mp->mutex);
147
error= pthread_mutex_lock(&mp->mutex);
149
if (error || (error=pthread_mutex_lock(&mp->global)))
151
fprintf(stderr,"Got error %d when trying to lock mutex at %s, line %d\n",
156
mp->thread= pthread_self();
159
fprintf(stderr,"safe_mutex: Error in thread libray: Got mutex at %s, \
160
line %d more than 1 time\n", file,line);
166
pthread_mutex_unlock(&mp->global);
171
int safe_mutex_unlock(safe_mutex_t *mp,const char *file, uint32_t line)
174
pthread_mutex_lock(&mp->global);
177
fprintf(stderr,"safe_mutex: Trying to unlock mutex that wasn't locked at %s, line %d\n Last used at %s, line: %d\n",
178
file,line,mp->file ? mp->file : "",mp->line);
182
if (!pthread_equal(pthread_self(),mp->thread))
184
fprintf(stderr,"safe_mutex: Trying to unlock mutex at %s, line %d that was locked by another thread at: %s, line: %d\n",
185
file,line,mp->file,mp->line);
191
error=pthread_mutex_unlock(&mp->mutex);
194
fprintf(stderr,"safe_mutex: Got error: %d (%d) when trying to unlock mutex at %s, line %d\n", error, errno, file, line);
198
pthread_mutex_unlock(&mp->global);
203
int safe_cond_wait(pthread_cond_t *cond, safe_mutex_t *mp, const char *file,
207
pthread_mutex_lock(&mp->global);
210
fprintf(stderr,"safe_mutex: Trying to cond_wait on a unlocked mutex at %s, line %d\n",file,line);
214
if (!pthread_equal(pthread_self(),mp->thread))
216
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",
217
file,line,mp->file,mp->line);
222
if (mp->count-- != 1)
224
fprintf(stderr,"safe_mutex: Count was %d on locked mutex at %s, line %d\n",
225
mp->count+1, file, line);
229
pthread_mutex_unlock(&mp->global);
230
error=pthread_cond_wait(cond,&mp->mutex);
231
pthread_mutex_lock(&mp->global);
234
fprintf(stderr,"safe_mutex: Got error: %d (%d) when doing a safe_mutex_wait at %s, line %d\n", error, errno, file, line);
238
mp->thread=pthread_self();
242
"safe_mutex: Count was %d in thread 0x%lx when locking mutex at %s, line %d\n",
243
mp->count-1, my_thread_dbug_id(), file, line);
249
pthread_mutex_unlock(&mp->global);
254
int safe_cond_timedwait(pthread_cond_t *cond, safe_mutex_t *mp,
255
struct timespec *abstime,
256
const char *file, uint32_t line)
259
pthread_mutex_lock(&mp->global);
260
if (mp->count != 1 || !pthread_equal(pthread_self(),mp->thread))
262
fprintf(stderr,"safe_mutex: Trying to cond_wait at %s, line %d on a not hold mutex\n",file,line);
266
mp->count--; /* Mutex will be released */
267
pthread_mutex_unlock(&mp->global);
268
error=pthread_cond_timedwait(cond,&mp->mutex,abstime);
270
if (error && (error != EINTR && error != ETIMEDOUT && error != ETIME))
272
fprintf(stderr,"safe_mutex: Got error: %d (%d) when doing a safe_mutex_timedwait at %s, line %d\n", error, errno, file, line);
275
pthread_mutex_lock(&mp->global);
276
mp->thread=pthread_self();
280
"safe_mutex: Count was %d in thread 0x%lx when locking mutex at %s, line %d (error: %d (%d))\n",
281
mp->count-1, my_thread_dbug_id(), file, line, error, error);
287
pthread_mutex_unlock(&mp->global);
292
int safe_mutex_destroy(safe_mutex_t *mp, const char *file, uint32_t line)
298
"safe_mutex: Trying to destroy unitialized mutex at %s, line %d\n",
305
fprintf(stderr,"safe_mutex: Trying to destroy a mutex that was locked at %s, line %d at %s, line %d\n",
306
mp->file,mp->line, file, line);
310
if (pthread_mutex_destroy(&mp->global))
312
if (pthread_mutex_destroy(&mp->mutex))
314
mp->file= 0; /* Mark destroyed */
316
#ifdef SAFE_MUTEX_DETECT_DESTROY
319
struct st_safe_mutex_info_t *info= mp->info;
320
pthread_mutex_lock(&THR_LOCK_mutex);
323
info->prev->next = info->next;
325
safe_mutex_root = info->next;
327
info->next->prev = info->prev;
330
pthread_mutex_unlock(&THR_LOCK_mutex);
332
mp->info= NULL; /* Get crash if double free */
335
thread_safe_sub(safe_mutex_count, 1, &THR_LOCK_mutex);
336
#endif /* SAFE_MUTEX_DETECT_DESTROY */
342
Free global resources and check that all mutex has been destroyed
346
file Print errors on this file
350
In MySQL one may get one warning for a mutex created in my_thr_init.c
351
This is ok, as this thread may not yet have been exited.
354
void safe_mutex_end(int *)
356
if (!safe_mutex_count) /* safetly */
357
pthread_mutex_destroy(&THR_LOCK_mutex);
358
#ifdef SAFE_MUTEX_DETECT_DESTROY
362
if (safe_mutex_count)
364
fprintf(file, "Warning: Not destroyed mutex: %lu\n", safe_mutex_count);
368
struct st_safe_mutex_info_t *ptr;
369
for (ptr= safe_mutex_root ; ptr ; ptr= ptr->next)
371
fprintf(file, "\tMutex initiated at line %4u in '%s'\n",
372
ptr->init_line, ptr->init_file);
376
#endif /* SAFE_MUTEX_DETECT_DESTROY */
379
#endif /* THREAD && SAFE_MUTEX */