97deac143fdd0994654b9eb75fecd06018cc711c
[asterisk/asterisk.git] / include / asterisk / lock.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief General Asterisk channel locking definitions.
21  *
22  * - See \ref LockDef
23  */
24
25 /* \page LockDef Asterisk thread locking models
26  *
27  * This file provides several different implementation of the functions,
28  * depending on the platform, the use of DEBUG_THREADS, and the way
29  * global mutexes are initialized.
30  *
31  * \par At the moment, we have 3 ways to initialize global mutexes, depending on
32  *
33  *  - \b static: the mutex is assigned the value AST_MUTEX_INIT_VALUE
34  *        this is done at compile time, and is the way used on Linux.
35  *        This method is not applicable to all platforms e.g. when the
36  *        initialization needs that some code is run.
37  *
38  *  - \b on first use: the mutex is assigned a magic value at compile time,
39  *        and ast_mutex_init() is called when this magic value is detected.
40  *        This technique is generally applicable, though it has a bit of
41  *        overhead on each access to check whether initialization is needed.
42  *        On the other hand, the overall cost of a mutex_lock operation
43  *        is such that this overhead is often negligible.
44
45  *  - \b through constructors: for each mutex, a constructor function is
46  *        defined, which then runs when the program (or the module)
47  *        starts. The problem with this approach is that there is a
48  *        lot of code duplication (a new block of code is created for
49  *        each mutex). Also, it does not prevent a user from declaring
50  *        a global mutex without going through the wrapper macros,
51  *        so sane programming practices are still required.
52  *
53  * Eventually we should converge on a single method for all platforms.
54  */
55
56 #ifndef _ASTERISK_LOCK_H
57 #define _ASTERISK_LOCK_H
58
59 /* internal macro to profile mutexes. Only computes the delay on
60  * non-blocking calls.
61  */
62 #ifndef HAVE_MTX_PROFILE
63 #define __MTX_PROF(a)   return pthread_mutex_lock((a))
64 #else
65 #define __MTX_PROF(a)   do {                    \
66         int i;                                  \
67         /* profile only non-blocking events */  \
68         ast_mark(mtx_prof, 1);                  \
69         i = pthread_mutex_trylock((a));         \
70         ast_mark(mtx_prof, 0);                  \
71         if (!i)                                 \
72                 return i;                       \
73         else                                    \
74                 return pthread_mutex_lock((a)); \
75         } while (0)
76 #endif  /* HAVE_MTX_PROFILE */
77
78 #include <pthread.h>
79 #include <netdb.h>
80 #include <time.h>
81 #include <sys/param.h>
82
83 #include "asterisk/logger.h"
84
85 #define AST_PTHREADT_NULL (pthread_t) -1
86 #define AST_PTHREADT_STOP (pthread_t) -2
87
88 #ifdef __APPLE__
89 /* Provide the Linux initializers for MacOS X */
90 #define PTHREAD_MUTEX_RECURSIVE_NP                      PTHREAD_MUTEX_RECURSIVE
91 #define PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP          { 0x4d555458, \
92                                                         { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, \
93                                                         0x20 } }
94 #endif
95
96 #ifdef BSD
97 #if 1 && defined( __GNUC__)
98 #define AST_MUTEX_INIT_W_CONSTRUCTORS
99 #else
100 #define AST_MUTEX_INIT_ON_FIRST_USE
101 #endif
102 #endif /* BSD */
103
104 /* From now on, Asterisk REQUIRES Recursive (not error checking) mutexes
105    and will not run without them. */
106 #if defined(__CYGWIN__)
107 #define PTHREAD_MUTEX_RECURSIVE_NP      PTHREAD_MUTEX_RECURSIVE
108 #define PTHREAD_MUTEX_INIT_VALUE        (ast_mutex_t)18
109 #define AST_MUTEX_KIND                  PTHREAD_MUTEX_RECURSIVE_NP
110 #elif defined(PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP)
111 #define PTHREAD_MUTEX_INIT_VALUE        PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
112 #define AST_MUTEX_KIND                  PTHREAD_MUTEX_RECURSIVE_NP
113 #else
114 #define PTHREAD_MUTEX_INIT_VALUE        PTHREAD_MUTEX_INITIALIZER
115 #define AST_MUTEX_KIND                  PTHREAD_MUTEX_RECURSIVE
116 #endif /* PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP */
117
118 #ifdef SOLARIS
119 #define AST_MUTEX_INIT_W_CONSTRUCTORS
120 #endif
121
122 #ifdef DEBUG_THREADS
123
124 #define __ast_mutex_logger(...)  do { if (canlog) ast_log(LOG_ERROR, __VA_ARGS__); else fprintf(stderr, __VA_ARGS__); } while (0)
125
126 #ifdef THREAD_CRASH
127 #define DO_THREAD_CRASH do { *((int *)(0)) = 1; } while(0)
128 #endif
129
130 #include <errno.h>
131 #include <string.h>
132 #include <stdio.h>
133 #include <unistd.h>
134
135 #define AST_MUTEX_INIT_VALUE { PTHREAD_MUTEX_INIT_VALUE, { NULL }, { 0 }, 0, { NULL }, { 0 } }
136
137 #define AST_MAX_REENTRANCY 10
138
139 struct ast_mutex_info {
140         pthread_mutex_t mutex;
141         const char *file[AST_MAX_REENTRANCY];
142         int lineno[AST_MAX_REENTRANCY];
143         int reentrancy;
144         const char *func[AST_MAX_REENTRANCY];
145         pthread_t thread[AST_MAX_REENTRANCY];
146 };
147
148 typedef struct ast_mutex_info ast_mutex_t;
149
150 typedef pthread_cond_t ast_cond_t;
151
152 static inline int __ast_pthread_mutex_init_attr(const char *filename, int lineno, const char *func,
153                                                 const char *mutex_name, ast_mutex_t *t,
154                                                 pthread_mutexattr_t *attr) 
155 {
156 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
157         int canlog = strcmp(filename, "logger.c");
158
159         if ((t->mutex) != ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
160                 __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is already initialized.\n",
161                                    filename, lineno, func, mutex_name);
162                 __ast_mutex_logger("%s line %d (%s): Error: previously initialization of mutex '%s'.\n",
163                                    t->file[0], t->lineno[0], t->func[0], mutex_name);
164 #ifdef THREAD_CRASH
165                 DO_THREAD_CRASH;
166 #endif
167                 return 0;
168         }
169 #endif
170
171         t->file[0] = filename;
172         t->lineno[0] = lineno;
173         t->func[0] = func;
174         t->thread[0]  = 0;
175         t->reentrancy = 0;
176
177         return pthread_mutex_init(&t->mutex, attr);
178 }
179
180 static inline int __ast_pthread_mutex_init(const char *filename, int lineno, const char *func,
181                                            const char *mutex_name, ast_mutex_t *t)
182 {
183         static pthread_mutexattr_t  attr;
184
185         pthread_mutexattr_init(&attr);
186         pthread_mutexattr_settype(&attr, AST_MUTEX_KIND);
187
188         return __ast_pthread_mutex_init_attr(filename, lineno, func, mutex_name, t, &attr);
189 }
190 #define ast_mutex_init(pmutex) __ast_pthread_mutex_init(__FILE__, __LINE__, __PRETTY_FUNCTION__, #pmutex, pmutex)
191
192 static inline int __ast_pthread_mutex_destroy(const char *filename, int lineno, const char *func,
193                                                 const char *mutex_name, ast_mutex_t *t)
194 {
195         int res;
196         int canlog = strcmp(filename, "logger.c");
197
198 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
199         if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
200                 __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized.\n",
201                                    filename, lineno, func, mutex_name);
202         }
203 #endif
204
205         res = pthread_mutex_trylock(&t->mutex);
206         switch (res) {
207         case 0:
208                 pthread_mutex_unlock(&t->mutex);
209                 break;
210         case EINVAL:
211                 __ast_mutex_logger("%s line %d (%s): Error: attempt to destroy invalid mutex '%s'.\n",
212                                   filename, lineno, func, mutex_name);
213                 break;
214         case EBUSY:
215                 __ast_mutex_logger("%s line %d (%s): Error: attempt to destroy locked mutex '%s'.\n",
216                                    filename, lineno, func, mutex_name);
217                 __ast_mutex_logger("%s line %d (%s): Error: '%s' was locked here.\n",
218                                    t->file[t->reentrancy-1], t->lineno[t->reentrancy-1], t->func[t->reentrancy-1], mutex_name);
219                 break;
220         }
221
222         if ((res = pthread_mutex_destroy(&t->mutex)))
223                 __ast_mutex_logger("%s line %d (%s): Error destroying mutex: %s\n",
224                                    filename, lineno, func, strerror(res));
225 #ifndef PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
226         else
227                 t->mutex = PTHREAD_MUTEX_INIT_VALUE;
228 #endif
229         t->file[0] = filename;
230         t->lineno[0] = lineno;
231         t->func[0] = func;
232
233         return res;
234 }
235
236 #if defined(AST_MUTEX_INIT_W_CONSTRUCTORS)
237 /*! \brief  if AST_MUTEX_INIT_W_CONSTRUCTORS is defined, use file scope
238  constrictors/destructors to create/destroy mutexes.  */
239 #define __AST_MUTEX_DEFINE(scope,mutex) \
240         scope ast_mutex_t mutex = AST_MUTEX_INIT_VALUE; \
241 static void  __attribute__ ((constructor)) init_##mutex(void) \
242 { \
243         ast_mutex_init(&mutex); \
244 } \
245 static void  __attribute__ ((destructor)) fini_##mutex(void) \
246 { \
247         ast_mutex_destroy(&mutex); \
248 }
249 #elif defined(AST_MUTEX_INIT_ON_FIRST_USE)
250 /*! \note
251  if AST_MUTEX_INIT_ON_FIRST_USE is defined, mutexes are created on
252  first use.  The performance impact on FreeBSD should be small since
253  the pthreads library does this itself to initialize errror checking
254  (defaulty type) mutexes.  If nither is defined, the pthreads librariy
255  does the initialization itself on first use. 
256 */ 
257 #define __AST_MUTEX_DEFINE(scope,mutex) \
258         scope ast_mutex_t mutex = AST_MUTEX_INIT_VALUE
259 #else /* AST_MUTEX_INIT_W_CONSTRUCTORS */
260 /* By default, use static initialization of mutexes.*/ 
261 #define __AST_MUTEX_DEFINE(scope,mutex) \
262         scope ast_mutex_t mutex = AST_MUTEX_INIT_VALUE
263 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
264
265 static inline int __ast_pthread_mutex_lock(const char *filename, int lineno, const char *func,
266                                            const char* mutex_name, ast_mutex_t *t)
267 {
268         int res;
269         int canlog = strcmp(filename, "logger.c");
270
271 #if defined(AST_MUTEX_INIT_W_CONSTRUCTORS) || defined(AST_MUTEX_INIT_ON_FIRST_USE)
272         if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
273 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
274                 __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized.\n",
275                                  filename, lineno, func, mutex_name);
276 #endif
277                 ast_mutex_init(t);
278         }
279 #endif /* defined(AST_MUTEX_INIT_W_CONSTRUCTORS) || defined(AST_MUTEX_INIT_ON_FIRST_USE) */
280
281 #ifdef DETECT_DEADLOCKS
282         {
283                 time_t seconds = time(NULL);
284                 time_t current;
285                 do {
286 #ifdef  HAVE_MTX_PROFILE
287                         ast_mark(mtx_prof, 1);
288 #endif
289                         res = pthread_mutex_trylock(&t->mutex);
290 #ifdef  HAVE_MTX_PROFILE
291                         ast_mark(mtx_prof, 0);
292 #endif
293                         if (res == EBUSY) {
294                                 current = time(NULL);
295                                 if ((current - seconds) && (!((current - seconds) % 5))) {
296                                         __ast_mutex_logger("%s line %d (%s): Deadlock? waited %d sec for mutex '%s'?\n",
297                                                            filename, lineno, func, (int)(current - seconds), mutex_name);
298                                         __ast_mutex_logger("%s line %d (%s): '%s' was locked here.\n",
299                                                            t->file[t->reentrancy-1], t->lineno[t->reentrancy-1],
300                                                            t->func[t->reentrancy-1], mutex_name);
301                                 }
302                                 usleep(200);
303                         }
304                 } while (res == EBUSY);
305         }
306 #else
307 #ifdef  HAVE_MTX_PROFILE
308         ast_mark(mtx_prof, 1);
309         res = pthread_mutex_trylock(&t->mutex);
310         ast_mark(mtx_prof, 0);
311         if (res)
312 #endif
313         res = pthread_mutex_lock(&t->mutex);
314 #endif /* DETECT_DEADLOCKS */
315
316         if (!res) {
317                 if (t->reentrancy < AST_MAX_REENTRANCY) {
318                         t->file[t->reentrancy] = filename;
319                         t->lineno[t->reentrancy] = lineno;
320                         t->func[t->reentrancy] = func;
321                         t->thread[t->reentrancy] = pthread_self();
322                         t->reentrancy++;
323                 } else {
324                         __ast_mutex_logger("%s line %d (%s): '%s' really deep reentrancy!\n",
325                                                            filename, lineno, func, mutex_name);
326                 }
327         } else {
328                 __ast_mutex_logger("%s line %d (%s): Error obtaining mutex: %s\n",
329                                    filename, lineno, func, strerror(errno));
330 #ifdef THREAD_CRASH
331                 DO_THREAD_CRASH;
332 #endif
333         }
334
335         return res;
336 }
337
338 static inline int __ast_pthread_mutex_trylock(const char *filename, int lineno, const char *func,
339                                               const char* mutex_name, ast_mutex_t *t)
340 {
341         int res;
342         int canlog = strcmp(filename, "logger.c");
343
344 #if defined(AST_MUTEX_INIT_W_CONSTRUCTORS) || defined(AST_MUTEX_INIT_ON_FIRST_USE)
345         if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
346 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
347
348                 __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized.\n",
349                                    filename, lineno, func, mutex_name);
350 #endif
351                 ast_mutex_init(t);
352         }
353 #endif /* defined(AST_MUTEX_INIT_W_CONSTRUCTORS) || defined(AST_MUTEX_INIT_ON_FIRST_USE) */
354
355         if (!(res = pthread_mutex_trylock(&t->mutex))) {
356                 if (t->reentrancy < AST_MAX_REENTRANCY) {
357                         t->file[t->reentrancy] = filename;
358                         t->lineno[t->reentrancy] = lineno;
359                         t->func[t->reentrancy] = func;
360                         t->thread[t->reentrancy] = pthread_self();
361                         t->reentrancy++;
362                 } else {
363                         __ast_mutex_logger("%s line %d (%s): '%s' really deep reentrancy!\n",
364                                                            filename, lineno, func, mutex_name);
365                 }
366         }
367
368         return res;
369 }
370
371 static inline int __ast_pthread_mutex_unlock(const char *filename, int lineno, const char *func,
372                                              const char *mutex_name, ast_mutex_t *t)
373 {
374         int res;
375         int canlog = strcmp(filename, "logger.c");
376
377 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
378         if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
379                 __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized.\n",
380                                    filename, lineno, func, mutex_name);
381         }
382 #endif
383
384         if (t->reentrancy && (t->thread[t->reentrancy-1] != pthread_self())) {
385                 __ast_mutex_logger("%s line %d (%s): attempted unlock mutex '%s' without owning it!\n",
386                                    filename, lineno, func, mutex_name);
387                 __ast_mutex_logger("%s line %d (%s): '%s' was locked here.\n",
388                                    t->file[t->reentrancy-1], t->lineno[t->reentrancy-1], t->func[t->reentrancy-1], mutex_name);
389 #ifdef THREAD_CRASH
390                 DO_THREAD_CRASH;
391 #endif
392         }
393
394         if (--t->reentrancy < 0) {
395                 __ast_mutex_logger("%s line %d (%s): mutex '%s' freed more times than we've locked!\n",
396                                    filename, lineno, func, mutex_name);
397                 t->reentrancy = 0;
398         }
399
400         if (t->reentrancy < AST_MAX_REENTRANCY) {
401                 t->file[t->reentrancy] = NULL;
402                 t->lineno[t->reentrancy] = 0;
403                 t->func[t->reentrancy] = NULL;
404                 t->thread[t->reentrancy] = 0;
405         }
406
407         if ((res = pthread_mutex_unlock(&t->mutex))) {
408                 __ast_mutex_logger("%s line %d (%s): Error releasing mutex: %s\n", 
409                                    filename, lineno, func, strerror(res));
410 #ifdef THREAD_CRASH
411                 DO_THREAD_CRASH;
412 #endif
413         }
414
415         return res;
416 }
417
418 static inline int __ast_cond_init(const char *filename, int lineno, const char *func,
419                                   const char *cond_name, ast_cond_t *cond, pthread_condattr_t *cond_attr)
420 {
421         return pthread_cond_init(cond, cond_attr);
422 }
423
424 static inline int __ast_cond_signal(const char *filename, int lineno, const char *func,
425                                     const char *cond_name, ast_cond_t *cond)
426 {
427         return pthread_cond_signal(cond);
428 }
429
430 static inline int __ast_cond_broadcast(const char *filename, int lineno, const char *func,
431                                        const char *cond_name, ast_cond_t *cond)
432 {
433         return pthread_cond_broadcast(cond);
434 }
435
436 static inline int __ast_cond_destroy(const char *filename, int lineno, const char *func,
437                                      const char *cond_name, ast_cond_t *cond)
438 {
439         return pthread_cond_destroy(cond);
440 }
441
442 static inline int __ast_cond_wait(const char *filename, int lineno, const char *func,
443                                   const char *cond_name, const char *mutex_name,
444                                   ast_cond_t *cond, ast_mutex_t *t)
445 {
446         int res;
447         int canlog = strcmp(filename, "logger.c");
448
449 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
450         if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
451                 __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized.\n",
452                                    filename, lineno, func, mutex_name);
453         }
454 #endif
455
456         if (t->reentrancy && (t->thread[t->reentrancy-1] != pthread_self())) {
457                 __ast_mutex_logger("%s line %d (%s): attempted unlock mutex '%s' without owning it!\n",
458                                    filename, lineno, func, mutex_name);
459                 __ast_mutex_logger("%s line %d (%s): '%s' was locked here.\n",
460                                    t->file[t->reentrancy-1], t->lineno[t->reentrancy-1], t->func[t->reentrancy-1], mutex_name);
461 #ifdef THREAD_CRASH
462                 DO_THREAD_CRASH;
463 #endif
464         }
465
466         if (--t->reentrancy < 0) {
467                 __ast_mutex_logger("%s line %d (%s): mutex '%s' freed more times than we've locked!\n",
468                                    filename, lineno, func, mutex_name);
469                 t->reentrancy = 0;
470         }
471
472         if (t->reentrancy < AST_MAX_REENTRANCY) {
473                 t->file[t->reentrancy] = NULL;
474                 t->lineno[t->reentrancy] = 0;
475                 t->func[t->reentrancy] = NULL;
476                 t->thread[t->reentrancy] = 0;
477         }
478
479         if ((res = pthread_cond_wait(cond, &t->mutex))) {
480                 __ast_mutex_logger("%s line %d (%s): Error waiting on condition mutex '%s'\n", 
481                                    filename, lineno, func, strerror(res));
482 #ifdef THREAD_CRASH
483                 DO_THREAD_CRASH;
484 #endif
485         } else {
486                 if (t->reentrancy < AST_MAX_REENTRANCY) {
487                         t->file[t->reentrancy] = filename;
488                         t->lineno[t->reentrancy] = lineno;
489                         t->func[t->reentrancy] = func;
490                         t->thread[t->reentrancy] = pthread_self();
491                         t->reentrancy++;
492                 } else {
493                         __ast_mutex_logger("%s line %d (%s): '%s' really deep reentrancy!\n",
494                                                            filename, lineno, func, mutex_name);
495                 }
496         }
497
498         return res;
499 }
500
501 static inline int __ast_cond_timedwait(const char *filename, int lineno, const char *func,
502                                        const char *cond_name, const char *mutex_name, ast_cond_t *cond,
503                                        ast_mutex_t *t, const struct timespec *abstime)
504 {
505         int res;
506         int canlog = strcmp(filename, "logger.c");
507
508 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
509         if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
510                 __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized.\n",
511                                    filename, lineno, func, mutex_name);
512         }
513 #endif
514
515         if (t->reentrancy && (t->thread[t->reentrancy-1] != pthread_self())) {
516                 __ast_mutex_logger("%s line %d (%s): attempted unlock mutex '%s' without owning it!\n",
517                                    filename, lineno, func, mutex_name);
518                 __ast_mutex_logger("%s line %d (%s): '%s' was locked here.\n",
519                                    t->file[t->reentrancy-1], t->lineno[t->reentrancy-1], t->func[t->reentrancy-1], mutex_name);
520 #ifdef THREAD_CRASH
521                 DO_THREAD_CRASH;
522 #endif
523         }
524
525         if (--t->reentrancy < 0) {
526                 __ast_mutex_logger("%s line %d (%s): mutex '%s' freed more times than we've locked!\n",
527                                    filename, lineno, func, mutex_name);
528                 t->reentrancy = 0;
529         }
530
531         if (t->reentrancy < AST_MAX_REENTRANCY) {
532                 t->file[t->reentrancy] = NULL;
533                 t->lineno[t->reentrancy] = 0;
534                 t->func[t->reentrancy] = NULL;
535                 t->thread[t->reentrancy] = 0;
536         }
537
538         if ((res = pthread_cond_timedwait(cond, &t->mutex, abstime)) && (res != ETIMEDOUT)) {
539                 __ast_mutex_logger("%s line %d (%s): Error waiting on condition mutex '%s'\n", 
540                                    filename, lineno, func, strerror(res));
541 #ifdef THREAD_CRASH
542                 DO_THREAD_CRASH;
543 #endif
544         } else {
545                 if (t->reentrancy < AST_MAX_REENTRANCY) {
546                         t->file[t->reentrancy] = filename;
547                         t->lineno[t->reentrancy] = lineno;
548                         t->func[t->reentrancy] = func;
549                         t->thread[t->reentrancy] = pthread_self();
550                         t->reentrancy++;
551                 } else {
552                         __ast_mutex_logger("%s line %d (%s): '%s' really deep reentrancy!\n",
553                                                            filename, lineno, func, mutex_name);
554                 }
555         }
556
557         return res;
558 }
559
560 #define ast_mutex_destroy(a) __ast_pthread_mutex_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
561 #define ast_mutex_lock(a) __ast_pthread_mutex_lock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
562 #define ast_mutex_unlock(a) __ast_pthread_mutex_unlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
563 #define ast_mutex_trylock(a) __ast_pthread_mutex_trylock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
564 #define ast_cond_init(cond, attr) __ast_cond_init(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond, attr)
565 #define ast_cond_destroy(cond) __ast_cond_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
566 #define ast_cond_signal(cond) __ast_cond_signal(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
567 #define ast_cond_broadcast(cond) __ast_cond_broadcast(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
568 #define ast_cond_wait(cond, mutex) __ast_cond_wait(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, #mutex, cond, mutex)
569 #define ast_cond_timedwait(cond, mutex, time) __ast_cond_timedwait(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, #mutex, cond, mutex, time)
570
571 #else /* !DEBUG_THREADS */
572
573
574 #define AST_MUTEX_INIT_VALUE    PTHREAD_MUTEX_INIT_VALUE
575
576
577 typedef pthread_mutex_t ast_mutex_t;
578
579 static inline int ast_mutex_init(ast_mutex_t *pmutex)
580 {
581         pthread_mutexattr_t attr;
582         pthread_mutexattr_init(&attr);
583         pthread_mutexattr_settype(&attr, AST_MUTEX_KIND);
584         return pthread_mutex_init(pmutex, &attr);
585 }
586
587 #define ast_pthread_mutex_init(pmutex,a) pthread_mutex_init(pmutex,a)
588
589 static inline int ast_mutex_unlock(ast_mutex_t *pmutex)
590 {
591         return pthread_mutex_unlock(pmutex);
592 }
593
594 static inline int ast_mutex_destroy(ast_mutex_t *pmutex)
595 {
596         return pthread_mutex_destroy(pmutex);
597 }
598
599 #if defined(AST_MUTEX_INIT_W_CONSTRUCTORS)
600 /* if AST_MUTEX_INIT_W_CONSTRUCTORS is defined, use file scope
601  constrictors/destructors to create/destroy mutexes.  */ 
602 #define __AST_MUTEX_DEFINE(scope,mutex) \
603         scope ast_mutex_t mutex = AST_MUTEX_INIT_VALUE; \
604 static void  __attribute__ ((constructor)) init_##mutex(void) \
605 { \
606         ast_mutex_init(&mutex); \
607 } \
608 static void  __attribute__ ((destructor)) fini_##mutex(void) \
609 { \
610         ast_mutex_destroy(&mutex); \
611 }
612
613 static inline int ast_mutex_lock(ast_mutex_t *pmutex)
614 {
615         __MTX_PROF(pmutex);
616 }
617
618 static inline int ast_mutex_trylock(ast_mutex_t *pmutex)
619 {
620         return pthread_mutex_trylock(pmutex);
621 }
622
623 #elif defined(AST_MUTEX_INIT_ON_FIRST_USE)
624 /* if AST_MUTEX_INIT_ON_FIRST_USE is defined, mutexes are created on
625  first use.  The performance impact on FreeBSD should be small since
626  the pthreads library does this itself to initialize errror checking
627  (defaulty type) mutexes.*/ 
628 #define __AST_MUTEX_DEFINE(scope,mutex) \
629         scope ast_mutex_t mutex = AST_MUTEX_INIT_VALUE
630
631 static inline int ast_mutex_lock(ast_mutex_t *pmutex)
632 {
633         if (*pmutex == (ast_mutex_t)AST_MUTEX_KIND)
634                 ast_mutex_init(pmutex);
635         __MTX_PROF(pmutex);
636 }
637
638 static inline int ast_mutex_trylock(ast_mutex_t *pmutex)
639 {
640         if (*pmutex == (ast_mutex_t)AST_MUTEX_KIND)
641                 ast_mutex_init(pmutex);
642         return pthread_mutex_trylock(pmutex);
643 }
644 #else
645 /* By default, use static initialization of mutexes.*/ 
646 #define __AST_MUTEX_DEFINE(scope,mutex) \
647         scope ast_mutex_t mutex = AST_MUTEX_INIT_VALUE
648
649 static inline int ast_mutex_lock(ast_mutex_t *pmutex)
650 {
651         __MTX_PROF(pmutex);
652 }
653
654 static inline int ast_mutex_trylock(ast_mutex_t *pmutex)
655 {
656         return pthread_mutex_trylock(pmutex);
657 }
658
659 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
660
661 typedef pthread_cond_t ast_cond_t;
662
663 static inline int ast_cond_init(ast_cond_t *cond, pthread_condattr_t *cond_attr)
664 {
665         return pthread_cond_init(cond, cond_attr);
666 }
667
668 static inline int ast_cond_signal(ast_cond_t *cond)
669 {
670         return pthread_cond_signal(cond);
671 }
672
673 static inline int ast_cond_broadcast(ast_cond_t *cond)
674 {
675         return pthread_cond_broadcast(cond);
676 }
677
678 static inline int ast_cond_destroy(ast_cond_t *cond)
679 {
680         return pthread_cond_destroy(cond);
681 }
682
683 static inline int ast_cond_wait(ast_cond_t *cond, ast_mutex_t *t)
684 {
685         return pthread_cond_wait(cond, t);
686 }
687
688 static inline int ast_cond_timedwait(ast_cond_t *cond, ast_mutex_t *t, const struct timespec *abstime)
689 {
690         return pthread_cond_timedwait(cond, t, abstime);
691 }
692
693 #endif /* !DEBUG_THREADS */
694
695 #define pthread_mutex_t use_ast_mutex_t_instead_of_pthread_mutex_t
696 #define pthread_mutex_lock use_ast_mutex_lock_instead_of_pthread_mutex_lock
697 #define pthread_mutex_unlock use_ast_mutex_unlock_instead_of_pthread_mutex_unlock
698 #define pthread_mutex_trylock use_ast_mutex_trylock_instead_of_pthread_mutex_trylock
699 #define pthread_mutex_init use_ast_mutex_init_instead_of_pthread_mutex_init
700 #define pthread_mutex_destroy use_ast_mutex_destroy_instead_of_pthread_mutex_destroy
701 #define pthread_cond_t use_ast_cond_t_instead_of_pthread_cond_t
702 #define pthread_cond_init use_ast_cond_init_instead_of_pthread_cond_init
703 #define pthread_cond_destroy use_ast_cond_destroy_instead_of_pthread_cond_destroy
704 #define pthread_cond_signal use_ast_cond_signal_instead_of_pthread_cond_signal
705 #define pthread_cond_broadcast use_ast_cond_broadcast_instead_of_pthread_cond_broadcast
706 #define pthread_cond_wait use_ast_cond_wait_instead_of_pthread_cond_wait
707 #define pthread_cond_timedwait use_ast_cond_timedwait_instead_of_pthread_cond_timedwait
708
709 #define AST_MUTEX_DEFINE_STATIC(mutex) __AST_MUTEX_DEFINE(static,mutex)
710
711 #define AST_MUTEX_INITIALIZER __use_AST_MUTEX_DEFINE_STATIC_rather_than_AST_MUTEX_INITIALIZER__
712
713 #define gethostbyname __gethostbyname__is__not__reentrant__use__ast_gethostbyname__instead__
714 #ifndef __linux__
715 #define pthread_create __use_ast_pthread_create_instead__
716 #endif
717
718 /*
719  * Initial support for atomic instructions.
720  * For platforms that have it, use the native cpu instruction to
721  * implement them. For other platforms, resort to a 'slow' version
722  * (defined in utils.c) that protects the atomic instruction with
723  * a single lock.
724  * The slow versions is always available, for testing purposes,
725  * as ast_atomic_fetchadd_int_slow()
726  */
727
728 int ast_atomic_fetchadd_int_slow(volatile int *p, int v);
729
730 #include "asterisk/inline_api.h"
731
732 /*! \brief Atomically add v to *pp and return * the previous value of *p.
733  * This can be used to handle reference counts, and the return value
734  * can be used to generate unique identifiers.
735  */
736
737 #if defined ( __i386__)
738 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
739 {
740         __asm __volatile (
741         "       lock   xaddl   %0, %1 ;        "
742         : "+r" (v),                     /* 0 (result) */   
743           "=m" (*p)                     /* 1 */
744         : "m" (*p));                    /* 2 */
745         return (v);
746 })
747 #else   /* low performance version in utils.c */
748 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
749 {
750         return ast_atomic_fetchadd_int_slow(p, v);
751 })
752 #endif
753
754 /*! \brief decrement *p by 1 and return true if the variable has reached 0.
755  * Useful e.g. to check if a refcount has reached 0.
756  */
757 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
758 {
759         int a = ast_atomic_fetchadd_int(p, -1);
760         return a == 1; /* true if the value is 0 now (so it was 1 previously) */
761 }
762 )
763
764 #endif /* _ASTERISK_LOCK_H */