← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to mysys/thr_mutex.c

  • Committer: brian
  • Date: 2008-06-25 05:29:13 UTC
  • Revision ID: brian@localhost.localdomain-20080625052913-6upwo0jsrl4lnapl
clean slate

Show diffs side-by-side

added added

removed removed

Lines of Context:
mysys/thr_mutex.c
 
1
/* Copyright (C) 2000-2003 MySQL AB
 
2
 
 
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.
 
6
 
 
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.
 
11
 
 
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 */
 
15
 
 
16
/* This makes a wrapper for mutex handling to make it easier to debug mutex */
 
17
 
 
18
#include <my_global.h>
 
19
#if defined(TARGET_OS_LINUX) && !defined (__USE_UNIX98)
 
20
#define __USE_UNIX98                    /* To get rw locks under Linux */
 
21
#endif
 
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"
 
26
#include <m_string.h>
 
27
 
 
28
#ifndef DO_NOT_REMOVE_THREAD_WRAPPERS
 
29
/* Remove 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))
 
39
#endif
 
40
#endif /* DO_NOT_REMOVE_THREAD_WRAPPERS */
 
41
 
 
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;
 
46
#endif
 
47
 
 
48
void safe_mutex_global_init(void)
 
49
{
 
50
  pthread_mutex_init(&THR_LOCK_mutex,MY_MUTEX_INIT_FAST);
 
51
}
 
52
 
 
53
 
 
54
int safe_mutex_init(safe_mutex_t *mp,
 
55
                    const pthread_mutexattr_t *attr __attribute__((unused)),
 
56
                    const char *file,
 
57
                    uint line)
 
58
{
 
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 */
 
63
  mp->file= file;
 
64
  mp->line= line;
 
65
 
 
66
#ifdef SAFE_MUTEX_DETECT_DESTROY
 
67
  /*
 
68
    Monitor the freeing of mutexes.  This code depends on single thread init
 
69
    and destroy
 
70
  */
 
71
  if ((mp->info= (safe_mutex_info_t *) malloc(sizeof(safe_mutex_info_t))))
 
72
  {
 
73
    struct st_safe_mutex_info_t *info =mp->info;
 
74
 
 
75
    info->init_file= file;
 
76
    info->init_line= line;
 
77
    info->prev= NULL;
 
78
    info->next= NULL;
 
79
 
 
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;
 
84
    safe_mutex_count++;
 
85
    pthread_mutex_unlock(&THR_LOCK_mutex);
 
86
  }
 
87
#else
 
88
  thread_safe_increment(safe_mutex_count, &THR_LOCK_mutex);
 
89
#endif /* SAFE_MUTEX_DETECT_DESTROY */
 
90
  return 0;
 
91
}
 
92
 
 
93
 
 
94
int safe_mutex_lock(safe_mutex_t *mp, my_bool try_lock, const char *file, uint line)
 
95
{
 
96
  int error;
 
97
  if (!mp->file)
 
98
  {
 
99
    fprintf(stderr,
 
100
            "safe_mutex: Trying to lock unitialized mutex at %s, line %d\n",
 
101
            file, line);
 
102
    fflush(stderr);
 
103
    abort();
 
104
  }
 
105
 
 
106
  pthread_mutex_lock(&mp->global);
 
107
  if (mp->count > 0)
 
108
  {
 
109
    if (try_lock)
 
110
    {
 
111
      pthread_mutex_unlock(&mp->global);
 
112
      return EBUSY;
 
113
    }
 
114
    else if (pthread_equal(pthread_self(),mp->thread))
 
115
    {
 
116
      fprintf(stderr,
 
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());
 
120
      fflush(stderr);
 
121
      abort();
 
122
    }
 
123
  }
 
124
  pthread_mutex_unlock(&mp->global);
 
125
 
 
126
  /*
 
127
    If we are imitating trylock(), we need to take special
 
128
    precautions.
 
129
 
 
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.
 
135
 
 
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
 
140
      of trylock().
 
141
   */
 
142
  if (try_lock)
 
143
  {
 
144
    error= pthread_mutex_trylock(&mp->mutex);
 
145
    if (error == EBUSY)
 
146
      return error;
 
147
  }
 
148
  else
 
149
    error= pthread_mutex_lock(&mp->mutex);
 
150
 
 
151
  if (error || (error=pthread_mutex_lock(&mp->global)))
 
152
  {
 
153
    fprintf(stderr,"Got error %d when trying to lock mutex at %s, line %d\n",
 
154
            error, file, line);
 
155
    fflush(stderr);
 
156
    abort();
 
157
  }
 
158
  mp->thread= pthread_self();
 
159
  if (mp->count++)
 
160
  {
 
161
    fprintf(stderr,"safe_mutex: Error in thread libray: Got mutex at %s, \
 
162
line %d more than 1 time\n", file,line);
 
163
    fflush(stderr);
 
164
    abort();
 
165
  }
 
166
  mp->file= file;
 
167
  mp->line=line;
 
168
  pthread_mutex_unlock(&mp->global);
 
169
  return error;
 
170
}
 
171
 
 
172
 
 
173
int safe_mutex_unlock(safe_mutex_t *mp,const char *file, uint line)
 
174
{
 
175
  int error;
 
176
  pthread_mutex_lock(&mp->global);
 
177
  if (mp->count == 0)
 
178
  {
 
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);
 
181
    fflush(stderr);
 
182
    abort();
 
183
  }
 
184
  if (!pthread_equal(pthread_self(),mp->thread))
 
185
  {
 
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);
 
188
    fflush(stderr);
 
189
    abort();
 
190
  }
 
191
  mp->thread= 0;
 
192
  mp->count--;
 
193
  error=pthread_mutex_unlock(&mp->mutex);
 
194
  if (error)
 
195
  {
 
196
    fprintf(stderr,"safe_mutex: Got error: %d (%d) when trying to unlock mutex at %s, line %d\n", error, errno, file, line);
 
197
    fflush(stderr);
 
198
    abort();
 
199
  }
 
200
  pthread_mutex_unlock(&mp->global);
 
201
  return error;
 
202
}
 
203
 
 
204
 
 
205
int safe_cond_wait(pthread_cond_t *cond, safe_mutex_t *mp, const char *file,
 
206
                   uint line)
 
207
{
 
208
  int error;
 
209
  pthread_mutex_lock(&mp->global);
 
210
  if (mp->count == 0)
 
211
  {
 
212
    fprintf(stderr,"safe_mutex: Trying to cond_wait on a unlocked mutex at %s, line %d\n",file,line);
 
213
    fflush(stderr);
 
214
    abort();
 
215
  }
 
216
  if (!pthread_equal(pthread_self(),mp->thread))
 
217
  {
 
218
    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",
 
219
            file,line,mp->file,mp->line);
 
220
    fflush(stderr);
 
221
    abort();
 
222
  }
 
223
 
 
224
  if (mp->count-- != 1)
 
225
  {
 
226
    fprintf(stderr,"safe_mutex:  Count was %d on locked mutex at %s, line %d\n",
 
227
            mp->count+1, file, line);
 
228
    fflush(stderr);
 
229
    abort();
 
230
  }
 
231
  pthread_mutex_unlock(&mp->global);
 
232
  error=pthread_cond_wait(cond,&mp->mutex);
 
233
  pthread_mutex_lock(&mp->global);
 
234
  if (error)
 
235
  {
 
236
    fprintf(stderr,"safe_mutex: Got error: %d (%d) when doing a safe_mutex_wait at %s, line %d\n", error, errno, file, line);
 
237
    fflush(stderr);
 
238
    abort();
 
239
  }
 
240
  mp->thread=pthread_self();
 
241
  if (mp->count++)
 
242
  {
 
243
    fprintf(stderr,
 
244
            "safe_mutex:  Count was %d in thread 0x%lx when locking mutex at %s, line %d\n",
 
245
            mp->count-1, my_thread_dbug_id(), file, line);
 
246
    fflush(stderr);
 
247
    abort();
 
248
  }
 
249
  mp->file= file;
 
250
  mp->line=line;
 
251
  pthread_mutex_unlock(&mp->global);
 
252
  return error;
 
253
}
 
254
 
 
255
 
 
256
int safe_cond_timedwait(pthread_cond_t *cond, safe_mutex_t *mp,
 
257
                        struct timespec *abstime,
 
258
                        const char *file, uint line)
 
259
{
 
260
  int error;
 
261
  pthread_mutex_lock(&mp->global);
 
262
  if (mp->count != 1 || !pthread_equal(pthread_self(),mp->thread))
 
263
  {
 
264
    fprintf(stderr,"safe_mutex: Trying to cond_wait at %s, line %d on a not hold mutex\n",file,line);
 
265
    fflush(stderr);
 
266
    abort();
 
267
  }
 
268
  mp->count--;                                  /* Mutex will be released */
 
269
  pthread_mutex_unlock(&mp->global);
 
270
  error=pthread_cond_timedwait(cond,&mp->mutex,abstime);
 
271
#ifdef EXTRA_DEBUG
 
272
  if (error && (error != EINTR && error != ETIMEDOUT && error != ETIME))
 
273
  {
 
274
    fprintf(stderr,"safe_mutex: Got error: %d (%d) when doing a safe_mutex_timedwait at %s, line %d\n", error, errno, file, line);
 
275
  }
 
276
#endif
 
277
  pthread_mutex_lock(&mp->global);
 
278
  mp->thread=pthread_self();
 
279
  if (mp->count++)
 
280
  {
 
281
    fprintf(stderr,
 
282
            "safe_mutex:  Count was %d in thread 0x%lx when locking mutex at %s, line %d (error: %d (%d))\n",
 
283
            mp->count-1, my_thread_dbug_id(), file, line, error, error);
 
284
    fflush(stderr);
 
285
    abort();
 
286
  }
 
287
  mp->file= file;
 
288
  mp->line=line;
 
289
  pthread_mutex_unlock(&mp->global);
 
290
  return error;
 
291
}
 
292
 
 
293
 
 
294
int safe_mutex_destroy(safe_mutex_t *mp, const char *file, uint line)
 
295
{
 
296
  int error=0;
 
297
  if (!mp->file)
 
298
  {
 
299
    fprintf(stderr,
 
300
            "safe_mutex: Trying to destroy unitialized mutex at %s, line %d\n",
 
301
            file, line);
 
302
    fflush(stderr);
 
303
    abort();
 
304
  }
 
305
  if (mp->count != 0)
 
306
  {
 
307
    fprintf(stderr,"safe_mutex: Trying to destroy a mutex that was locked at %s, line %d at %s, line %d\n",
 
308
            mp->file,mp->line, file, line);
 
309
    fflush(stderr);
 
310
    abort();
 
311
  }
 
312
  if (pthread_mutex_destroy(&mp->global))
 
313
    error=1;
 
314
  if (pthread_mutex_destroy(&mp->mutex))
 
315
    error=1;
 
316
  mp->file= 0;                                  /* Mark destroyed */
 
317
 
 
318
#ifdef SAFE_MUTEX_DETECT_DESTROY
 
319
  if (mp->info)
 
320
  {
 
321
    struct st_safe_mutex_info_t *info= mp->info;
 
322
    pthread_mutex_lock(&THR_LOCK_mutex);
 
323
 
 
324
    if (info->prev)
 
325
      info->prev->next = info->next;
 
326
    else
 
327
      safe_mutex_root = info->next;
 
328
    if (info->next)
 
329
      info->next->prev = info->prev;
 
330
    safe_mutex_count--;
 
331
 
 
332
    pthread_mutex_unlock(&THR_LOCK_mutex);
 
333
    free(info);
 
334
    mp->info= NULL;                             /* Get crash if double free */
 
335
  }
 
336
#else
 
337
  thread_safe_sub(safe_mutex_count, 1, &THR_LOCK_mutex);
 
338
#endif /* SAFE_MUTEX_DETECT_DESTROY */
 
339
  return error;
 
340
}
 
341
 
 
342
 
 
343
/*
 
344
  Free global resources and check that all mutex has been destroyed
 
345
 
 
346
  SYNOPSIS
 
347
    safe_mutex_end()
 
348
    file                Print errors on this file
 
349
 
 
350
  NOTES
 
351
    We can't use DBUG_PRINT() here as we have in my_end() disabled
 
352
    DBUG handling before calling this function.
 
353
 
 
354
   In MySQL one may get one warning for a mutex created in my_thr_init.c
 
355
   This is ok, as this thread may not yet have been exited.
 
356
*/
 
357
 
 
358
void safe_mutex_end(FILE *file __attribute__((unused)))
 
359
{
 
360
  if (!safe_mutex_count)                        /* safetly */
 
361
    pthread_mutex_destroy(&THR_LOCK_mutex);
 
362
#ifdef SAFE_MUTEX_DETECT_DESTROY
 
363
  if (!file)
 
364
    return;
 
365
 
 
366
  if (safe_mutex_count)
 
367
  {
 
368
    fprintf(file, "Warning: Not destroyed mutex: %lu\n", safe_mutex_count);
 
369
    (void) fflush(file);
 
370
  }
 
371
  {
 
372
    struct st_safe_mutex_info_t *ptr;
 
373
    for (ptr= safe_mutex_root ; ptr ; ptr= ptr->next)
 
374
    {
 
375
      fprintf(file, "\tMutex initiated at line %4u in '%s'\n",
 
376
              ptr->init_line, ptr->init_file);
 
377
      (void) fflush(file);
 
378
    }
 
379
  }
 
380
#endif /* SAFE_MUTEX_DETECT_DESTROY */
 
381
}
 
382
 
 
383
#endif /* THREAD && SAFE_MUTEX */
 
384
 
 
385
#if defined(THREAD) && defined(MY_PTHREAD_FASTMUTEX) && !defined(SAFE_MUTEX)
 
386
 
 
387
#include "mysys_priv.h"
 
388
#include "my_static.h"
 
389
#include <m_string.h>
 
390
 
 
391
#include <m_ctype.h>
 
392
#include <hash.h>
 
393
#include <myisampack.h>
 
394
#include <mysys_err.h>
 
395
#include <my_sys.h>
 
396
 
 
397
#undef pthread_mutex_t
 
398
#undef pthread_mutex_init
 
399
#undef pthread_mutex_lock
 
400
#undef pthread_mutex_trylock
 
401
#undef pthread_mutex_unlock
 
402
#undef pthread_mutex_destroy
 
403
#undef pthread_cond_wait
 
404
#undef pthread_cond_timedwait
 
405
 
 
406
ulong mutex_delay(ulong delayloops)
 
407
{
 
408
  ulong i;
 
409
  volatile ulong j;
 
410
 
 
411
  j = 0;
 
412
 
 
413
  for (i = 0; i < delayloops * 50; i++)
 
414
    j += i;
 
415
 
 
416
  return(j); 
 
417
}       
 
418
 
 
419
#define MY_PTHREAD_FASTMUTEX_SPINS 8
 
420
#define MY_PTHREAD_FASTMUTEX_DELAY 4
 
421
 
 
422
static int cpu_count= 0;
 
423
 
 
424
int my_pthread_fastmutex_init(my_pthread_fastmutex_t *mp,
 
425
                              const pthread_mutexattr_t *attr)
 
426
{
 
427
  if ((cpu_count > 1) && (attr == MY_MUTEX_INIT_FAST))
 
428
    mp->spins= MY_PTHREAD_FASTMUTEX_SPINS; 
 
429
  else
 
430
    mp->spins= 0;
 
431
  return pthread_mutex_init(&mp->mutex, attr); 
 
432
}
 
433
 
 
434
int my_pthread_fastmutex_lock(my_pthread_fastmutex_t *mp)
 
435
{
 
436
  int   res;
 
437
  uint  i;
 
438
  uint  maxdelay= MY_PTHREAD_FASTMUTEX_DELAY;
 
439
 
 
440
  for (i= 0; i < mp->spins; i++)
 
441
  {
 
442
    res= pthread_mutex_trylock(&mp->mutex);
 
443
 
 
444
    if (res == 0)
 
445
      return 0;
 
446
 
 
447
    if (res != EBUSY)
 
448
      return res;
 
449
 
 
450
    mutex_delay(maxdelay);
 
451
    maxdelay += ((double) random() / (double) RAND_MAX) * 
 
452
                MY_PTHREAD_FASTMUTEX_DELAY + 1;
 
453
  }
 
454
  return pthread_mutex_lock(&mp->mutex);
 
455
}
 
456
 
 
457
 
 
458
void fastmutex_global_init(void)
 
459
{
 
460
#ifdef _SC_NPROCESSORS_CONF
 
461
  cpu_count= sysconf(_SC_NPROCESSORS_CONF);
 
462
#endif
 
463
}
 
464
  
 
465
#endif /* defined(THREAD) && defined(MY_PTHREAD_FASTMUTEX) && !defined(SAFE_MUTEX) */