cbc2926b36017f346e41020ffe28e88cf7dc72fb
[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 Asterisk locking-related definitions:
21  * - ast_mutext_t, ast_rwlock_t and related functions;
22  * - atomic arithmetic instructions;
23  * - wrappers for channel locking.
24  *
25  * - See \ref LockDef
26  */
27
28 /*! \page LockDef Asterisk thread locking models
29  *
30  * This file provides different implementation of the functions,
31  * depending on the platform, the use of DEBUG_THREADS, and the way
32  * module-level mutexes are initialized.
33  *
34  *  - \b static: the mutex is assigned the value AST_MUTEX_INIT_VALUE
35  *        this is done at compile time, and is the way used on Linux.
36  *        This method is not applicable to all platforms e.g. when the
37  *        initialization needs that some code is run.
38  *
39  *  - \b through constructors: for each mutex, a constructor function is
40  *        defined, which then runs when the program (or the module)
41  *        starts. The problem with this approach is that there is a
42  *        lot of code duplication (a new block of code is created for
43  *        each mutex). Also, it does not prevent a user from declaring
44  *        a global mutex without going through the wrapper macros,
45  *        so sane programming practices are still required.
46  */
47
48 #ifndef _ASTERISK_LOCK_H
49 #define _ASTERISK_LOCK_H
50
51 #include <pthread.h>
52 #include <sys/param.h>
53
54 #include "asterisk/logger.h"
55
56 /* internal macro to profile mutexes. Only computes the delay on
57  * non-blocking calls.
58  */
59 #ifndef HAVE_MTX_PROFILE
60 #define __MTX_PROF(a)   return pthread_mutex_lock((a))
61 #else
62 #define __MTX_PROF(a)   do {                    \
63         int i;                                  \
64         /* profile only non-blocking events */  \
65         ast_mark(mtx_prof, 1);                  \
66         i = pthread_mutex_trylock((a));         \
67         ast_mark(mtx_prof, 0);                  \
68         if (!i)                                 \
69                 return i;                       \
70         else                                    \
71                 return pthread_mutex_lock((a)); \
72         } while (0)
73 #endif  /* HAVE_MTX_PROFILE */
74
75 #define AST_PTHREADT_NULL (pthread_t) -1
76 #define AST_PTHREADT_STOP (pthread_t) -2
77
78 #if defined(SOLARIS) || defined(BSD)
79 #define AST_MUTEX_INIT_W_CONSTRUCTORS
80 #endif /* SOLARIS || BSD */
81
82 /* Asterisk REQUIRES recursive (not error checking) mutexes
83    and will not run without them. */
84 #if defined(HAVE_PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP) && defined(HAVE_PTHREAD_MUTEX_RECURSIVE_NP)
85 #define PTHREAD_MUTEX_INIT_VALUE        PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
86 #define AST_MUTEX_KIND                  PTHREAD_MUTEX_RECURSIVE_NP
87 #else
88 #define PTHREAD_MUTEX_INIT_VALUE        PTHREAD_MUTEX_INITIALIZER
89 #define AST_MUTEX_KIND                  PTHREAD_MUTEX_RECURSIVE
90 #endif /* PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP */
91
92 /*
93  * Definition of ast_mutex_t, ast_cont_d and related functions with/without debugging
94  * (search for DEBUG_THREADS to find the start/end of the sections).
95  *
96  * The non-debug code contains just wrappers for the corresponding pthread functions.
97  * The debug code tracks usage and tries to identify deadlock situations.
98  */
99 #ifdef DEBUG_THREADS
100
101 #define __ast_mutex_logger(...)  do { if (canlog) ast_log(LOG_ERROR, __VA_ARGS__); else fprintf(stderr, __VA_ARGS__); } while (0)
102
103 #ifdef THREAD_CRASH
104 #define DO_THREAD_CRASH do { *((int *)(0)) = 1; } while(0)
105 #else
106 #define DO_THREAD_CRASH do { } while (0)
107 #endif
108
109 #include <errno.h>
110
111 #define AST_MUTEX_INIT_VALUE { PTHREAD_MUTEX_INIT_VALUE, 1, { NULL }, { 0 }, 0, { NULL }, { 0 }, PTHREAD_MUTEX_INIT_VALUE }
112 #define AST_MUTEX_INIT_VALUE_NOTRACKING \
113                              { PTHREAD_MUTEX_INIT_VALUE, 0, { NULL }, { 0 }, 0, { NULL }, { 0 }, PTHREAD_MUTEX_INIT_VALUE }
114
115 #define AST_MAX_REENTRANCY 10
116
117 struct ast_channel;
118
119 struct ast_mutex_info {
120         pthread_mutex_t mutex;
121         /*! Track which thread holds this lock */
122         unsigned int track:1;
123         const char *file[AST_MAX_REENTRANCY];
124         int lineno[AST_MAX_REENTRANCY];
125         int reentrancy;
126         const char *func[AST_MAX_REENTRANCY];
127         pthread_t thread[AST_MAX_REENTRANCY];
128         pthread_mutex_t reentr_mutex;
129 };
130
131 typedef struct ast_mutex_info ast_mutex_t;
132
133 typedef pthread_cond_t ast_cond_t;
134
135 static pthread_mutex_t empty_mutex;
136
137 enum ast_lock_type {
138         AST_MUTEX,
139         AST_RDLOCK,
140         AST_WRLOCK,
141 };
142
143 /*!
144  * \brief Store lock info for the current thread
145  *
146  * This function gets called in ast_mutex_lock() and ast_mutex_trylock() so
147  * that information about this lock can be stored in this thread's
148  * lock info struct.  The lock is marked as pending as the thread is waiting
149  * on the lock.  ast_mark_lock_acquired() will mark it as held by this thread.
150  */
151 #if !defined(LOW_MEMORY)
152 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
153         int line_num, const char *func, const char *lock_name, void *lock_addr);
154 #else
155 #define ast_store_lock_info(I,DONT,CARE,ABOUT,THE,PARAMETERS)
156 #endif
157
158
159 /*!
160  * \brief Mark the last lock as acquired
161  */
162 #if !defined(LOW_MEMORY)
163 void ast_mark_lock_acquired(void *lock_addr);
164 #else
165 #define ast_mark_lock_acquired(ignore)
166 #endif
167
168 /*!
169  * \brief Mark the last lock as failed (trylock)
170  */
171 #if !defined(LOW_MEMORY)
172 void ast_mark_lock_failed(void *lock_addr);
173 #else
174 #define ast_mark_lock_failed(ignore)
175 #endif
176
177 /*!
178  * \brief remove lock info for the current thread
179  *
180  * this gets called by ast_mutex_unlock so that information on the lock can
181  * be removed from the current thread's lock info struct.
182  */
183 #if !defined(LOW_MEMORY)
184 void ast_remove_lock_info(void *lock_addr);
185 #else
186 #define ast_remove_lock_info(ignore)
187 #endif
188
189
190
191 /*!
192  * \brief log info for the current lock with ast_log().
193  *
194  * this function would be mostly for debug. If you come across a lock
195  * that is unexpectedly but momentarily locked, and you wonder who
196  * are fighting with for the lock, this routine could be called, IF
197  * you have the thread debugging stuff turned on.
198  */
199 void log_show_lock(void *this_lock_addr);
200
201 static void __attribute__((constructor)) init_empty_mutex(void)
202 {
203         memset(&empty_mutex, 0, sizeof(empty_mutex));
204 }
205
206 static inline void ast_reentrancy_lock(ast_mutex_t *p_ast_mutex)
207 {
208         pthread_mutex_lock(&p_ast_mutex->reentr_mutex);
209 }
210
211 static inline void ast_reentrancy_unlock(ast_mutex_t *p_ast_mutex)
212 {
213         pthread_mutex_unlock(&p_ast_mutex->reentr_mutex);
214 }
215
216 static inline void ast_reentrancy_init(ast_mutex_t *p_ast_mutex)
217 {
218         int i;
219         pthread_mutexattr_t reentr_attr;
220
221         for (i = 0; i < AST_MAX_REENTRANCY; i++) {
222                 p_ast_mutex->file[i] = NULL;
223                 p_ast_mutex->lineno[i] = 0;
224                 p_ast_mutex->func[i] = NULL;
225                 p_ast_mutex->thread[i] = 0;
226         }
227
228         p_ast_mutex->reentrancy = 0;
229
230         pthread_mutexattr_init(&reentr_attr);
231         pthread_mutexattr_settype(&reentr_attr, AST_MUTEX_KIND);
232         pthread_mutex_init(&p_ast_mutex->reentr_mutex, &reentr_attr);
233         pthread_mutexattr_destroy(&reentr_attr);
234 }
235
236 static inline void delete_reentrancy_cs(ast_mutex_t * p_ast_mutex)
237 {
238         pthread_mutex_destroy(&p_ast_mutex->reentr_mutex);
239 }
240
241 static inline int __ast_pthread_mutex_init(int track, const char *filename, int lineno, const char *func,
242                                                 const char *mutex_name, ast_mutex_t *t) 
243 {
244         int res;
245         pthread_mutexattr_t  attr;
246
247 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
248
249         if ((t->mutex) != ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
250 /*
251                 int canlog = strcmp(filename, "logger.c") & track;
252                 __ast_mutex_logger("%s line %d (%s): NOTICE: mutex '%s' is already initialized.\n",
253                                    filename, lineno, func, mutex_name);
254                 DO_THREAD_CRASH;
255 */
256                 return 0;
257         }
258
259 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
260
261         ast_reentrancy_init(t);
262         t->track = track;
263
264         pthread_mutexattr_init(&attr);
265         pthread_mutexattr_settype(&attr, AST_MUTEX_KIND);
266
267         res = pthread_mutex_init(&t->mutex, &attr);
268         pthread_mutexattr_destroy(&attr);
269         return res;
270 }
271
272 #define ast_mutex_init(pmutex) __ast_pthread_mutex_init(1, __FILE__, __LINE__, __PRETTY_FUNCTION__, #pmutex, pmutex)
273 #define ast_mutex_init_notracking(pmutex) \
274         __ast_pthread_mutex_init(0, __FILE__, __LINE__, __PRETTY_FUNCTION__, #pmutex, pmutex)
275
276 static inline int __ast_pthread_mutex_destroy(const char *filename, int lineno, const char *func,
277                                                 const char *mutex_name, ast_mutex_t *t)
278 {
279         int res;
280         int canlog = strcmp(filename, "logger.c") & t->track;
281
282 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
283         if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
284                 /* Don't try to uninitialize non initialized mutex
285                  * This may no effect on linux
286                  * And always ganerate core on *BSD with 
287                  * linked libpthread
288                  * This not error condition if the mutex created on the fly.
289                  */
290                 __ast_mutex_logger("%s line %d (%s): NOTICE: mutex '%s' is uninitialized.\n",
291                                    filename, lineno, func, mutex_name);
292                 return 0;
293         }
294 #endif
295
296         res = pthread_mutex_trylock(&t->mutex);
297         switch (res) {
298         case 0:
299                 pthread_mutex_unlock(&t->mutex);
300                 break;
301         case EINVAL:
302                 __ast_mutex_logger("%s line %d (%s): Error: attempt to destroy invalid mutex '%s'.\n",
303                                   filename, lineno, func, mutex_name);
304                 break;
305         case EBUSY:
306                 __ast_mutex_logger("%s line %d (%s): Error: attempt to destroy locked mutex '%s'.\n",
307                                    filename, lineno, func, mutex_name);
308                 ast_reentrancy_lock(t);
309                 __ast_mutex_logger("%s line %d (%s): Error: '%s' was locked here.\n",
310                             t->file[t->reentrancy-1], t->lineno[t->reentrancy-1], t->func[t->reentrancy-1], mutex_name);
311                 ast_reentrancy_unlock(t);
312                 break;
313         }
314
315         if ((res = pthread_mutex_destroy(&t->mutex)))
316                 __ast_mutex_logger("%s line %d (%s): Error destroying mutex %s: %s\n",
317                                    filename, lineno, func, mutex_name, strerror(res));
318 #ifndef PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
319         else
320                 t->mutex = PTHREAD_MUTEX_INIT_VALUE;
321 #endif
322         ast_reentrancy_lock(t);
323         t->file[0] = filename;
324         t->lineno[0] = lineno;
325         t->func[0] = func;
326         t->reentrancy = 0;
327         t->thread[0] = 0;
328         ast_reentrancy_unlock(t);
329         delete_reentrancy_cs(t);
330
331         return res;
332 }
333
334 static inline int __ast_pthread_mutex_lock(const char *filename, int lineno, const char *func,
335                                            const char* mutex_name, ast_mutex_t *t)
336 {
337         int res;
338         int canlog = strcmp(filename, "logger.c") & t->track;
339
340 #if defined(AST_MUTEX_INIT_W_CONSTRUCTORS)
341         if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
342                 /* Don't warn abount uninitialized mutex.
343                  * Simple try to initialize it.
344                  * May be not needed in linux system.
345                  */
346                 res = __ast_pthread_mutex_init(t->track, filename, lineno, func, mutex_name, t);
347                 if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
348                         __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized and unable to initialize.\n",
349                                          filename, lineno, func, mutex_name);
350                         return res;
351                 }               
352         }
353 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
354
355         if (t->track)
356                 ast_store_lock_info(AST_MUTEX, filename, lineno, func, mutex_name, &t->mutex);
357
358 #ifdef DETECT_DEADLOCKS
359         {
360                 time_t seconds = time(NULL);
361                 time_t wait_time, reported_wait = 0;
362                 do {
363 #ifdef  HAVE_MTX_PROFILE
364                         ast_mark(mtx_prof, 1);
365 #endif
366                         res = pthread_mutex_trylock(&t->mutex);
367 #ifdef  HAVE_MTX_PROFILE
368                         ast_mark(mtx_prof, 0);
369 #endif
370                         if (res == EBUSY) {
371                                 wait_time = time(NULL) - seconds;
372                                 if (wait_time > reported_wait && (wait_time % 5) == 0) {
373                                         __ast_mutex_logger("%s line %d (%s): Deadlock? waited %d sec for mutex '%s'?\n",
374                                                            filename, lineno, func, (int) wait_time, mutex_name);
375                                         ast_reentrancy_lock(t);
376                                         __ast_mutex_logger("%s line %d (%s): '%s' was locked here.\n",
377                                                            t->file[t->reentrancy-1], t->lineno[t->reentrancy-1],
378                                                            t->func[t->reentrancy-1], mutex_name);
379                                         ast_reentrancy_unlock(t);
380                                         reported_wait = wait_time;
381                                 }
382                                 usleep(200);
383                         }
384                 } while (res == EBUSY);
385         }
386 #else
387 #ifdef  HAVE_MTX_PROFILE
388         ast_mark(mtx_prof, 1);
389         res = pthread_mutex_trylock(&t->mutex);
390         ast_mark(mtx_prof, 0);
391         if (res)
392 #endif
393         res = pthread_mutex_lock(&t->mutex);
394 #endif /* DETECT_DEADLOCKS */
395
396         if (!res) {
397                 ast_reentrancy_lock(t);
398                 if (t->reentrancy < AST_MAX_REENTRANCY) {
399                         t->file[t->reentrancy] = filename;
400                         t->lineno[t->reentrancy] = lineno;
401                         t->func[t->reentrancy] = func;
402                         t->thread[t->reentrancy] = pthread_self();
403                         t->reentrancy++;
404                 } else {
405                         __ast_mutex_logger("%s line %d (%s): '%s' really deep reentrancy!\n",
406                                                            filename, lineno, func, mutex_name);
407                 }
408                 ast_reentrancy_unlock(t);
409                 if (t->track)
410                         ast_mark_lock_acquired(&t->mutex);
411         } else {
412                 if (t->track)
413                         ast_remove_lock_info(&t->mutex);
414                 __ast_mutex_logger("%s line %d (%s): Error obtaining mutex: %s\n",
415                                    filename, lineno, func, strerror(res));
416                 DO_THREAD_CRASH;
417         }
418
419         return res;
420 }
421
422 static inline int __ast_pthread_mutex_trylock(const char *filename, int lineno, const char *func,
423                                               const char* mutex_name, ast_mutex_t *t)
424 {
425         int res;
426         int canlog = strcmp(filename, "logger.c") & t->track;
427
428 #if defined(AST_MUTEX_INIT_W_CONSTRUCTORS)
429         if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
430                 /* Don't warn abount uninitialized mutex.
431                  * Simple try to initialize it.
432                  * May be not needed in linux system.
433                  */
434                 res = __ast_pthread_mutex_init(t->track, filename, lineno, func, mutex_name, t);
435                 if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
436                         __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized and unable to initialize.\n",
437                                          filename, lineno, func, mutex_name);
438                         return res;
439                 }               
440         }
441 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
442
443         if (t->track)
444                 ast_store_lock_info(AST_MUTEX, filename, lineno, func, mutex_name, &t->mutex);
445
446         if (!(res = pthread_mutex_trylock(&t->mutex))) {
447                 ast_reentrancy_lock(t);
448                 if (t->reentrancy < AST_MAX_REENTRANCY) {
449                         t->file[t->reentrancy] = filename;
450                         t->lineno[t->reentrancy] = lineno;
451                         t->func[t->reentrancy] = func;
452                         t->thread[t->reentrancy] = pthread_self();
453                         t->reentrancy++;
454                 } else {
455                         __ast_mutex_logger("%s line %d (%s): '%s' really deep reentrancy!\n",
456                                            filename, lineno, func, mutex_name);
457                 }
458                 ast_reentrancy_unlock(t);
459                 if (t->track)
460                         ast_mark_lock_acquired(&t->mutex);
461         } else if (t->track) {
462                 ast_mark_lock_failed(&t->mutex);
463         }
464
465         return res;
466 }
467
468 static inline int __ast_pthread_mutex_unlock(const char *filename, int lineno, const char *func,
469                                              const char *mutex_name, ast_mutex_t *t)
470 {
471         int res;
472         int canlog = strcmp(filename, "logger.c") & t->track;
473
474 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
475         if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
476                 __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized.\n",
477                                    filename, lineno, func, mutex_name);
478                 res = __ast_pthread_mutex_init(t->track, filename, lineno, func, mutex_name, t);
479                 if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
480                         __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized and unable to initialize.\n",
481                                          filename, lineno, func, mutex_name);
482                 }
483                 return res;
484         }
485 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
486
487         ast_reentrancy_lock(t);
488         if (t->reentrancy && (t->thread[t->reentrancy-1] != pthread_self())) {
489                 __ast_mutex_logger("%s line %d (%s): attempted unlock mutex '%s' without owning it!\n",
490                                    filename, lineno, func, mutex_name);
491                 __ast_mutex_logger("%s line %d (%s): '%s' was locked here.\n",
492                                    t->file[t->reentrancy-1], t->lineno[t->reentrancy-1], t->func[t->reentrancy-1], mutex_name);
493                 DO_THREAD_CRASH;
494         }
495
496         if (--t->reentrancy < 0) {
497                 __ast_mutex_logger("%s line %d (%s): mutex '%s' freed more times than we've locked!\n",
498                                    filename, lineno, func, mutex_name);
499                 t->reentrancy = 0;
500         }
501
502         if (t->reentrancy < AST_MAX_REENTRANCY) {
503                 t->file[t->reentrancy] = NULL;
504                 t->lineno[t->reentrancy] = 0;
505                 t->func[t->reentrancy] = NULL;
506                 t->thread[t->reentrancy] = 0;
507         }
508         ast_reentrancy_unlock(t);
509
510         if (t->track)
511                 ast_remove_lock_info(&t->mutex);
512
513         if ((res = pthread_mutex_unlock(&t->mutex))) {
514                 __ast_mutex_logger("%s line %d (%s): Error releasing mutex: %s\n", 
515                                    filename, lineno, func, strerror(res));
516                 DO_THREAD_CRASH;
517         }
518
519         return res;
520 }
521
522 static inline int __ast_cond_init(const char *filename, int lineno, const char *func,
523                                   const char *cond_name, ast_cond_t *cond, pthread_condattr_t *cond_attr)
524 {
525         return pthread_cond_init(cond, cond_attr);
526 }
527
528 static inline int __ast_cond_signal(const char *filename, int lineno, const char *func,
529                                     const char *cond_name, ast_cond_t *cond)
530 {
531         return pthread_cond_signal(cond);
532 }
533
534 static inline int __ast_cond_broadcast(const char *filename, int lineno, const char *func,
535                                        const char *cond_name, ast_cond_t *cond)
536 {
537         return pthread_cond_broadcast(cond);
538 }
539
540 static inline int __ast_cond_destroy(const char *filename, int lineno, const char *func,
541                                      const char *cond_name, ast_cond_t *cond)
542 {
543         return pthread_cond_destroy(cond);
544 }
545
546 static inline int __ast_cond_wait(const char *filename, int lineno, const char *func,
547                                   const char *cond_name, const char *mutex_name,
548                                   ast_cond_t *cond, ast_mutex_t *t)
549 {
550         int res;
551         int canlog = strcmp(filename, "logger.c") & t->track;
552
553 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
554         if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
555                 __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized.\n",
556                                    filename, lineno, func, mutex_name);
557                 res = __ast_pthread_mutex_init(t->track, filename, lineno, func, mutex_name, t);
558                 if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
559                         __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized and unable to initialize.\n",
560                                          filename, lineno, func, mutex_name);
561                 }
562                 return res;
563         }
564 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
565
566         ast_reentrancy_lock(t);
567         if (t->reentrancy && (t->thread[t->reentrancy-1] != pthread_self())) {
568                 __ast_mutex_logger("%s line %d (%s): attempted unlock mutex '%s' without owning it!\n",
569                                    filename, lineno, func, mutex_name);
570                 __ast_mutex_logger("%s line %d (%s): '%s' was locked here.\n",
571                                    t->file[t->reentrancy-1], t->lineno[t->reentrancy-1], t->func[t->reentrancy-1], mutex_name);
572                 DO_THREAD_CRASH;
573         }
574
575         if (--t->reentrancy < 0) {
576                 __ast_mutex_logger("%s line %d (%s): mutex '%s' freed more times than we've locked!\n",
577                                    filename, lineno, func, mutex_name);
578                 t->reentrancy = 0;
579         }
580
581         if (t->reentrancy < AST_MAX_REENTRANCY) {
582                 t->file[t->reentrancy] = NULL;
583                 t->lineno[t->reentrancy] = 0;
584                 t->func[t->reentrancy] = NULL;
585                 t->thread[t->reentrancy] = 0;
586         }
587         ast_reentrancy_unlock(t);
588
589         if (t->track)
590                 ast_remove_lock_info(&t->mutex);
591
592         if ((res = pthread_cond_wait(cond, &t->mutex))) {
593                 __ast_mutex_logger("%s line %d (%s): Error waiting on condition mutex '%s'\n", 
594                                    filename, lineno, func, strerror(res));
595                 DO_THREAD_CRASH;
596         } else {
597                 ast_reentrancy_lock(t);
598                 if (t->reentrancy < AST_MAX_REENTRANCY) {
599                         t->file[t->reentrancy] = filename;
600                         t->lineno[t->reentrancy] = lineno;
601                         t->func[t->reentrancy] = func;
602                         t->thread[t->reentrancy] = pthread_self();
603                         t->reentrancy++;
604                 } else {
605                         __ast_mutex_logger("%s line %d (%s): '%s' really deep reentrancy!\n",
606                                                            filename, lineno, func, mutex_name);
607                 }
608                 ast_reentrancy_unlock(t);
609
610                 if (t->track)
611                         ast_store_lock_info(AST_MUTEX, filename, lineno, func, mutex_name, &t->mutex);
612         }
613
614         return res;
615 }
616
617 static inline int __ast_cond_timedwait(const char *filename, int lineno, const char *func,
618                                        const char *cond_name, const char *mutex_name, ast_cond_t *cond,
619                                        ast_mutex_t *t, const struct timespec *abstime)
620 {
621         int res;
622         int canlog = strcmp(filename, "logger.c") & t->track;
623
624 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
625         if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
626                 __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized.\n",
627                                    filename, lineno, func, mutex_name);
628                 res = __ast_pthread_mutex_init(t->track, filename, lineno, func, mutex_name, t);
629                 if ((t->mutex) == ((pthread_mutex_t) PTHREAD_MUTEX_INITIALIZER)) {
630                         __ast_mutex_logger("%s line %d (%s): Error: mutex '%s' is uninitialized and unable to initialize.\n",
631                                          filename, lineno, func, mutex_name);
632                 }
633                 return res;
634         }
635 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
636
637         ast_reentrancy_lock(t);
638         if (t->reentrancy && (t->thread[t->reentrancy-1] != pthread_self())) {
639                 __ast_mutex_logger("%s line %d (%s): attempted unlock mutex '%s' without owning it!\n",
640                                    filename, lineno, func, mutex_name);
641                 __ast_mutex_logger("%s line %d (%s): '%s' was locked here.\n",
642                                    t->file[t->reentrancy-1], t->lineno[t->reentrancy-1], t->func[t->reentrancy-1], mutex_name);
643                 DO_THREAD_CRASH;
644         }
645
646         if (--t->reentrancy < 0) {
647                 __ast_mutex_logger("%s line %d (%s): mutex '%s' freed more times than we've locked!\n",
648                                    filename, lineno, func, mutex_name);
649                 t->reentrancy = 0;
650         }
651
652         if (t->reentrancy < AST_MAX_REENTRANCY) {
653                 t->file[t->reentrancy] = NULL;
654                 t->lineno[t->reentrancy] = 0;
655                 t->func[t->reentrancy] = NULL;
656                 t->thread[t->reentrancy] = 0;
657         }
658         ast_reentrancy_unlock(t);
659
660         if (t->track)
661                 ast_remove_lock_info(&t->mutex);
662
663         if ((res = pthread_cond_timedwait(cond, &t->mutex, abstime)) && (res != ETIMEDOUT)) {
664                 __ast_mutex_logger("%s line %d (%s): Error waiting on condition mutex '%s'\n", 
665                                    filename, lineno, func, strerror(res));
666                 DO_THREAD_CRASH;
667         } else {
668                 ast_reentrancy_lock(t);
669                 if (t->reentrancy < AST_MAX_REENTRANCY) {
670                         t->file[t->reentrancy] = filename;
671                         t->lineno[t->reentrancy] = lineno;
672                         t->func[t->reentrancy] = func;
673                         t->thread[t->reentrancy] = pthread_self();
674                         t->reentrancy++;
675                 } else {
676                         __ast_mutex_logger("%s line %d (%s): '%s' really deep reentrancy!\n",
677                                                            filename, lineno, func, mutex_name);
678                 }
679                 ast_reentrancy_unlock(t);
680
681                 if (t->track)
682                         ast_store_lock_info(AST_MUTEX, filename, lineno, func, mutex_name, &t->mutex);
683         }
684
685         return res;
686 }
687
688 #define ast_mutex_destroy(a)                    __ast_pthread_mutex_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
689 #define ast_mutex_lock(a)                       __ast_pthread_mutex_lock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
690 #define ast_mutex_unlock(a)                     __ast_pthread_mutex_unlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
691 #define ast_mutex_trylock(a)                    __ast_pthread_mutex_trylock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
692 #define ast_cond_init(cond, attr)               __ast_cond_init(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond, attr)
693 #define ast_cond_destroy(cond)                  __ast_cond_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
694 #define ast_cond_signal(cond)                   __ast_cond_signal(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
695 #define ast_cond_broadcast(cond)                __ast_cond_broadcast(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
696 #define ast_cond_wait(cond, mutex)              __ast_cond_wait(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, #mutex, cond, mutex)
697 #define ast_cond_timedwait(cond, mutex, time)   __ast_cond_timedwait(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, #mutex, cond, mutex, time)
698
699 #else /* !DEBUG_THREADS */
700
701
702 typedef pthread_mutex_t ast_mutex_t;
703
704 #define AST_MUTEX_INIT_VALUE                    ((ast_mutex_t) PTHREAD_MUTEX_INIT_VALUE)
705 #define AST_MUTEX_INIT_VALUE_NOTRACKING         ((ast_mutex_t) PTHREAD_MUTEX_INIT_VALUE)
706
707 #define ast_mutex_init_notracking(m)            ast_mutex_init(m)
708
709 static inline int ast_mutex_init(ast_mutex_t *pmutex)
710 {
711         int res;
712         pthread_mutexattr_t attr;
713
714         pthread_mutexattr_init(&attr);
715         pthread_mutexattr_settype(&attr, AST_MUTEX_KIND);
716
717         res = pthread_mutex_init(pmutex, &attr);
718         pthread_mutexattr_destroy(&attr);
719         return res;
720 }
721
722 #define ast_pthread_mutex_init(pmutex,a) pthread_mutex_init(pmutex,a)
723
724 static inline int ast_mutex_unlock(ast_mutex_t *pmutex)
725 {
726         return pthread_mutex_unlock(pmutex);
727 }
728
729 static inline int ast_mutex_destroy(ast_mutex_t *pmutex)
730 {
731         return pthread_mutex_destroy(pmutex);
732 }
733
734 static inline int ast_mutex_lock(ast_mutex_t *pmutex)
735 {
736         __MTX_PROF(pmutex);
737 }
738
739 static inline int ast_mutex_trylock(ast_mutex_t *pmutex)
740 {
741         return pthread_mutex_trylock(pmutex);
742 }
743
744 typedef pthread_cond_t ast_cond_t;
745
746 static inline int ast_cond_init(ast_cond_t *cond, pthread_condattr_t *cond_attr)
747 {
748         return pthread_cond_init(cond, cond_attr);
749 }
750
751 static inline int ast_cond_signal(ast_cond_t *cond)
752 {
753         return pthread_cond_signal(cond);
754 }
755
756 static inline int ast_cond_broadcast(ast_cond_t *cond)
757 {
758         return pthread_cond_broadcast(cond);
759 }
760
761 static inline int ast_cond_destroy(ast_cond_t *cond)
762 {
763         return pthread_cond_destroy(cond);
764 }
765
766 static inline int ast_cond_wait(ast_cond_t *cond, ast_mutex_t *t)
767 {
768         return pthread_cond_wait(cond, t);
769 }
770
771 static inline int ast_cond_timedwait(ast_cond_t *cond, ast_mutex_t *t, const struct timespec *abstime)
772 {
773         return pthread_cond_timedwait(cond, t, abstime);
774 }
775
776 #endif /* !DEBUG_THREADS */
777
778 #if defined(AST_MUTEX_INIT_W_CONSTRUCTORS)
779 /*
780  * If AST_MUTEX_INIT_W_CONSTRUCTORS is defined, use file scope constructors
781  * and destructors to create/destroy global mutexes.
782  */
783 #define __AST_MUTEX_DEFINE(scope, mutex, init_val, track)       \
784         scope ast_mutex_t mutex = init_val;                     \
785 static void  __attribute__ ((constructor)) init_##mutex(void)   \
786 {                                                               \
787         if (track)                                              \
788                 ast_mutex_init(&mutex);                         \
789         else                                                    \
790                 ast_mutex_init_notracking(&mutex);              \
791 }                                                               \
792                                                                 \
793 static void  __attribute__ ((destructor)) fini_##mutex(void)    \
794 {                                                               \
795         ast_mutex_destroy(&mutex);                              \
796 }
797 #else /* !AST_MUTEX_INIT_W_CONSTRUCTORS */
798 /* By default, use static initialization of mutexes. */ 
799 #define __AST_MUTEX_DEFINE(scope, mutex, init_val, track)       scope ast_mutex_t mutex = init_val
800 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
801
802 #ifndef __CYGWIN__      /* temporary disabled for cygwin */
803 #define pthread_mutex_t         use_ast_mutex_t_instead_of_pthread_mutex_t
804 #define pthread_cond_t          use_ast_cond_t_instead_of_pthread_cond_t
805 #endif
806 #define pthread_mutex_lock      use_ast_mutex_lock_instead_of_pthread_mutex_lock
807 #define pthread_mutex_unlock    use_ast_mutex_unlock_instead_of_pthread_mutex_unlock
808 #define pthread_mutex_trylock   use_ast_mutex_trylock_instead_of_pthread_mutex_trylock
809 #define pthread_mutex_init      use_ast_mutex_init_instead_of_pthread_mutex_init
810 #define pthread_mutex_destroy   use_ast_mutex_destroy_instead_of_pthread_mutex_destroy
811 #define pthread_cond_init       use_ast_cond_init_instead_of_pthread_cond_init
812 #define pthread_cond_destroy    use_ast_cond_destroy_instead_of_pthread_cond_destroy
813 #define pthread_cond_signal     use_ast_cond_signal_instead_of_pthread_cond_signal
814 #define pthread_cond_broadcast  use_ast_cond_broadcast_instead_of_pthread_cond_broadcast
815 #define pthread_cond_wait       use_ast_cond_wait_instead_of_pthread_cond_wait
816 #define pthread_cond_timedwait  use_ast_cond_timedwait_instead_of_pthread_cond_timedwait
817
818 #define AST_MUTEX_DEFINE_STATIC(mutex)                  __AST_MUTEX_DEFINE(static, mutex, AST_MUTEX_INIT_VALUE, 1)
819 #define AST_MUTEX_DEFINE_STATIC_NOTRACKING(mutex)       __AST_MUTEX_DEFINE(static, mutex, AST_MUTEX_INIT_VALUE_NOTRACKING, 0)
820
821 #define AST_MUTEX_INITIALIZER __use_AST_MUTEX_DEFINE_STATIC_rather_than_AST_MUTEX_INITIALIZER__
822
823 #define gethostbyname __gethostbyname__is__not__reentrant__use__ast_gethostbyname__instead__
824
825 #ifndef __linux__
826 #define pthread_create __use_ast_pthread_create_instead__
827 #endif
828
829 /*
830  * Same as above, definitions of ast_rwlock_t for the various cases:
831  * simple wrappers for the pthread equivalent in the non-debug case,
832  * more sophisticated tracking in the debug case.
833  */
834
835 typedef pthread_rwlock_t ast_rwlock_t;
836
837 #ifdef HAVE_PTHREAD_RWLOCK_INITIALIZER
838 #define AST_RWLOCK_INIT_VALUE PTHREAD_RWLOCK_INITIALIZER
839 #else
840 #define AST_RWLOCK_INIT_VALUE { 0 }
841 #endif
842
843 #ifdef DEBUG_THREADS
844
845 #define ast_rwlock_init(rwlock)         __ast_rwlock_init(__FILE__, __LINE__, __PRETTY_FUNCTION__, #rwlock, rwlock)
846 #define ast_rwlock_destroy(rwlock)      __ast_rwlock_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #rwlock, rwlock)
847 #define ast_rwlock_unlock(a)            _ast_rwlock_unlock(a, # a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
848 #define ast_rwlock_rdlock(a)            _ast_rwlock_rdlock(a, # a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
849 #define ast_rwlock_wrlock(a)            _ast_rwlock_wrlock(a, # a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
850 #define ast_rwlock_tryrdlock(a)         _ast_rwlock_tryrdlock(a, # a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
851 #define ast_rwlock_trywrlock(a) _ast_rwlock_trywrlock(a, # a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
852
853
854 static inline int __ast_rwlock_init(const char *filename, int lineno, const char *func, const char *rwlock_name, ast_rwlock_t *prwlock)
855 {
856         int res;
857         pthread_rwlockattr_t attr;
858 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
859         int canlog = strcmp(filename, "logger.c");
860
861         if (*prwlock != ((ast_rwlock_t) AST_RWLOCK_INIT_VALUE)) {
862                 __ast_mutex_logger("%s line %d (%s): Warning: rwlock '%s' is already initialized.\n",
863                                 filename, lineno, func, rwlock_name);
864                 return 0;
865         }
866 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
867         pthread_rwlockattr_init(&attr);
868
869 #ifdef HAVE_PTHREAD_RWLOCK_PREFER_WRITER_NP
870         pthread_rwlockattr_setkind_np(&attr, PTHREAD_RWLOCK_PREFER_WRITER_NP);
871 #endif
872
873         res = pthread_rwlock_init(prwlock, &attr);
874         pthread_rwlockattr_destroy(&attr);
875         return res;
876 }
877
878
879 static inline int __ast_rwlock_destroy(const char *filename, int lineno, const char *func, const char *rwlock_name, ast_rwlock_t *prwlock)
880 {
881         int res;
882         int canlog = strcmp(filename, "logger.c");
883
884 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
885         if (*prwlock == ((ast_rwlock_t) AST_RWLOCK_INIT_VALUE)) {
886                 __ast_mutex_logger("%s line %d (%s): Warning: rwlock '%s' is uninitialized.\n",
887                                    filename, lineno, func, rwlock_name);
888                 return 0;
889         }
890 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
891         
892         if ((res = pthread_rwlock_destroy(prwlock)))
893                 __ast_mutex_logger("%s line %d (%s): Error destroying rwlock %s: %s\n",
894                                 filename, lineno, func, rwlock_name, strerror(res));
895
896         return res;
897 }
898
899
900 static inline int _ast_rwlock_unlock(ast_rwlock_t *lock, const char *name,
901         const char *file, int line, const char *func)
902 {
903         int res;
904 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
905         int canlog = strcmp(file, "logger.c");
906
907         if (*lock == ((ast_rwlock_t) AST_RWLOCK_INIT_VALUE)) {
908                 __ast_mutex_logger("%s line %d (%s): Warning: rwlock '%s' is uninitialized.\n",
909                                    file, line, func, name);
910                 res = __ast_rwlock_init(file, line, func, name, lock);
911                 if (*lock == ((ast_rwlock_t) AST_RWLOCK_INIT_VALUE)) {
912                         __ast_mutex_logger("%s line %d (%s): Error: rwlock '%s' is uninitialized and unable to initialize.\n",
913                                         file, line, func, name);
914                 }
915                 return res;
916         }
917 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
918         
919         res = pthread_rwlock_unlock(lock);
920         ast_remove_lock_info(lock);
921         return res;
922 }
923
924
925 static inline int _ast_rwlock_rdlock(ast_rwlock_t *lock, const char *name,
926         const char *file, int line, const char *func)
927 {
928         int res;
929 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
930         int canlog = strcmp(file, "logger.c");
931         
932         if (*lock == ((ast_rwlock_t) AST_RWLOCK_INIT_VALUE)) {
933                  /* Don't warn abount uninitialized lock.
934                   * Simple try to initialize it.
935                   * May be not needed in linux system.
936                   */
937                 res = __ast_rwlock_init(file, line, func, name, lock);
938                 if (*lock == ((ast_rwlock_t) AST_RWLOCK_INIT_VALUE)) {
939                         __ast_mutex_logger("%s line %d (%s): Error: rwlock '%s' is uninitialized and unable to initialize.\n",
940                                         file, line, func, name);
941                         return res;
942                 }
943         }
944 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
945         
946         ast_store_lock_info(AST_RDLOCK, file, line, func, name, lock);
947         res = pthread_rwlock_rdlock(lock);
948         if (!res)
949                 ast_mark_lock_acquired(lock);
950         else
951                 ast_remove_lock_info(lock);
952         return res;
953 }
954
955
956 static inline int _ast_rwlock_wrlock(ast_rwlock_t *lock, const char *name,
957         const char *file, int line, const char *func)
958 {
959         int res;
960 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
961         int canlog = strcmp(file, "logger.c");
962         
963         if (*lock == ((ast_rwlock_t) AST_RWLOCK_INIT_VALUE)) {
964                  /* Don't warn abount uninitialized lock.
965                   * Simple try to initialize it.
966                   * May be not needed in linux system.
967                   */
968                 res = __ast_rwlock_init(file, line, func, name, lock);
969                 if (*lock == ((ast_rwlock_t) AST_RWLOCK_INIT_VALUE)) {
970                         __ast_mutex_logger("%s line %d (%s): Error: rwlock '%s' is uninitialized and unable to initialize.\n",
971                                         file, line, func, name);
972                         return res;
973                 }
974         }
975 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
976
977         ast_store_lock_info(AST_WRLOCK, file, line, func, name, lock);
978         res = pthread_rwlock_wrlock(lock);
979         if (!res)
980                 ast_mark_lock_acquired(lock);
981         else
982                 ast_remove_lock_info(lock);
983         return res;
984 }
985
986
987 static inline int _ast_rwlock_tryrdlock(ast_rwlock_t *lock, const char *name,
988         const char *file, int line, const char *func)
989 {
990         int res;
991 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
992         int canlog = strcmp(file, "logger.c");
993         
994         if (*lock == ((ast_rwlock_t) AST_RWLOCK_INIT_VALUE)) {
995                  /* Don't warn abount uninitialized lock.
996                   * Simple try to initialize it.
997                   * May be not needed in linux system.
998                   */
999                 res = __ast_rwlock_init(file, line, func, name, lock);
1000                 if (*lock == ((ast_rwlock_t) AST_RWLOCK_INIT_VALUE)) {
1001                         __ast_mutex_logger("%s line %d (%s): Error: rwlock '%s' is uninitialized and unable to initialize.\n",
1002                                         file, line, func, name);
1003                         return res;
1004                 }
1005         }
1006 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
1007
1008         ast_store_lock_info(AST_RDLOCK, file, line, func, name, lock);
1009         res = pthread_rwlock_tryrdlock(lock);
1010         if (!res)
1011                 ast_mark_lock_acquired(lock);
1012         else
1013                 ast_remove_lock_info(lock);
1014         return res;
1015 }
1016
1017
1018 static inline int _ast_rwlock_trywrlock(ast_rwlock_t *lock, const char *name,
1019         const char *file, int line, const char *func)
1020 {
1021         int res;
1022 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
1023         int canlog = strcmp(file, "logger.c");
1024         
1025         if (*lock == ((ast_rwlock_t) AST_RWLOCK_INIT_VALUE)) {
1026                  /* Don't warn abount uninitialized lock.
1027                   * Simple try to initialize it.
1028                   * May be not needed in linux system.
1029                   */
1030                 res = __ast_rwlock_init(file, line, func, name, lock);
1031                 if (*lock == ((ast_rwlock_t) AST_RWLOCK_INIT_VALUE)) {
1032                         __ast_mutex_logger("%s line %d (%s): Error: rwlock '%s' is uninitialized and unable to initialize.\n",
1033                                         file, line, func, name);
1034                         return res;
1035                 }
1036         }
1037 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
1038
1039         ast_store_lock_info(AST_WRLOCK, file, line, func, name, lock);
1040         res = pthread_rwlock_trywrlock(lock);
1041         if (!res)
1042                 ast_mark_lock_acquired(lock);
1043         else
1044                 ast_remove_lock_info(lock);
1045         return res;
1046 }
1047
1048 #else /* !DEBUG_THREADS */
1049
1050 static inline int ast_rwlock_init(ast_rwlock_t *prwlock)
1051 {
1052         int res;
1053         pthread_rwlockattr_t attr;
1054
1055         pthread_rwlockattr_init(&attr);
1056
1057 #ifdef HAVE_PTHREAD_RWLOCK_PREFER_WRITER_NP
1058         pthread_rwlockattr_setkind_np(&attr, PTHREAD_RWLOCK_PREFER_WRITER_NP);
1059 #endif
1060
1061         res = pthread_rwlock_init(prwlock, &attr);
1062         pthread_rwlockattr_destroy(&attr);
1063         return res;
1064 }
1065
1066 static inline int ast_rwlock_destroy(ast_rwlock_t *prwlock)
1067 {
1068         return pthread_rwlock_destroy(prwlock);
1069 }
1070
1071 static inline int ast_rwlock_unlock(ast_rwlock_t *prwlock)
1072 {
1073         return pthread_rwlock_unlock(prwlock);
1074 }
1075
1076 static inline int ast_rwlock_rdlock(ast_rwlock_t *prwlock)
1077 {
1078         return pthread_rwlock_rdlock(prwlock);
1079 }
1080
1081 static inline int ast_rwlock_tryrdlock(ast_rwlock_t *prwlock)
1082 {
1083         return pthread_rwlock_tryrdlock(prwlock);
1084 }
1085
1086 static inline int ast_rwlock_wrlock(ast_rwlock_t *prwlock)
1087 {
1088         return pthread_rwlock_wrlock(prwlock);
1089 }
1090
1091 static inline int ast_rwlock_trywrlock(ast_rwlock_t *prwlock)
1092 {
1093         return pthread_rwlock_trywrlock(prwlock);
1094 }
1095 #endif /* !DEBUG_THREADS */
1096
1097 /* Statically declared read/write locks */
1098
1099 #ifndef HAVE_PTHREAD_RWLOCK_INITIALIZER
1100 #define __AST_RWLOCK_DEFINE(scope, rwlock)                      \
1101         scope ast_rwlock_t rwlock;                              \
1102 static void  __attribute__ ((constructor)) init_##rwlock(void)  \
1103 {                                                               \
1104         ast_rwlock_init(&rwlock);                               \
1105 }                                                               \
1106                                                                 \
1107 static void  __attribute__ ((destructor)) fini_##rwlock(void)   \
1108 {                                                               \
1109         ast_rwlock_destroy(&rwlock);                            \
1110 }
1111 #else
1112 #define __AST_RWLOCK_DEFINE(scope, rwlock)      scope ast_rwlock_t rwlock = AST_RWLOCK_INIT_VALUE
1113 #endif
1114
1115 #define AST_RWLOCK_DEFINE_STATIC(rwlock) __AST_RWLOCK_DEFINE(static, rwlock)
1116
1117 /*
1118  * Support for atomic instructions.
1119  * For platforms that have it, use the native cpu instruction to
1120  * implement them. For other platforms, resort to a 'slow' version
1121  * (defined in utils.c) that protects the atomic instruction with
1122  * a single lock.
1123  * The slow versions is always available, for testing purposes,
1124  * as ast_atomic_fetchadd_int_slow()
1125  */
1126
1127 int ast_atomic_fetchadd_int_slow(volatile int *p, int v);
1128
1129 #include "asterisk/inline_api.h"
1130
1131 #if defined(HAVE_OSX_ATOMICS)
1132 #include "libkern/OSAtomic.h"
1133 #endif
1134
1135 /*! \brief Atomically add v to *p and return * the previous value of *p.
1136  * This can be used to handle reference counts, and the return value
1137  * can be used to generate unique identifiers.
1138  */
1139
1140 #if defined(HAVE_GCC_ATOMICS)
1141 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
1142 {
1143         return __sync_fetch_and_add(p, v);
1144 })
1145 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 4)
1146 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
1147 {
1148         return OSAtomicAdd32(v, (int32_t *) p) - v;
1149 })
1150 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 8)
1151 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
1152 {
1153         return OSAtomicAdd64(v, (int64_t *) p) - v;
1154 #elif defined (__i386__) || defined(__x86_64__)
1155 #ifdef sun
1156 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
1157 {
1158         __asm __volatile (
1159         "       lock;  xaddl   %0, %1 ;        "
1160         : "+r" (v),                     /* 0 (result) */   
1161           "=m" (*p)                     /* 1 */
1162         : "m" (*p));                    /* 2 */
1163         return (v);
1164 })
1165 #else /* ifndef sun */
1166 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
1167 {
1168         __asm __volatile (
1169         "       lock   xaddl   %0, %1 ;        "
1170         : "+r" (v),                     /* 0 (result) */   
1171           "=m" (*p)                     /* 1 */
1172         : "m" (*p));                    /* 2 */
1173         return (v);
1174 })
1175 #endif
1176 #else   /* low performance version in utils.c */
1177 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
1178 {
1179         return ast_atomic_fetchadd_int_slow(p, v);
1180 })
1181 #endif
1182
1183 /*! \brief decrement *p by 1 and return true if the variable has reached 0.
1184  * Useful e.g. to check if a refcount has reached 0.
1185  */
1186 #if defined(HAVE_GCC_ATOMICS)
1187 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
1188 {
1189         return __sync_sub_and_fetch(p, 1) == 0;
1190 })
1191 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 4)
1192 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
1193 {
1194         return OSAtomicAdd32( -1, (int32_t *) p) == 0;
1195 })
1196 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 8)
1197 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
1198 {
1199         return OSAtomicAdd64( -1, (int64_t *) p) == 0;
1200 #else
1201 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
1202 {
1203         int a = ast_atomic_fetchadd_int(p, -1);
1204         return a == 1; /* true if the value is 0 now (so it was 1 previously) */
1205 })
1206 #endif
1207
1208 #ifndef DEBUG_CHANNEL_LOCKS
1209 /*! \brief Lock a channel. If DEBUG_CHANNEL_LOCKS is defined 
1210         in the Makefile, print relevant output for debugging */
1211 #define ast_channel_lock(x)             ast_mutex_lock(&x->lock_dont_use)
1212 /*! \brief Unlock a channel. If DEBUG_CHANNEL_LOCKS is defined 
1213         in the Makefile, print relevant output for debugging */
1214 #define ast_channel_unlock(x)           ast_mutex_unlock(&x->lock_dont_use)
1215 /*! \brief Try locking a channel. If DEBUG_CHANNEL_LOCKS is defined 
1216         in the Makefile, print relevant output for debugging */
1217 #define ast_channel_trylock(x)          ast_mutex_trylock(&x->lock_dont_use)
1218 #else
1219
1220 #define ast_channel_lock(a) __ast_channel_lock(a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1221 /*! \brief Lock AST channel (and print debugging output)
1222 \note You need to enable DEBUG_CHANNEL_LOCKS for this function */
1223 int __ast_channel_lock(struct ast_channel *chan, const char *file, int lineno, const char *func);
1224
1225 #define ast_channel_unlock(a) __ast_channel_unlock(a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1226 /*! \brief Unlock AST channel (and print debugging output)
1227 \note You need to enable DEBUG_CHANNEL_LOCKS for this function
1228 */
1229 int __ast_channel_unlock(struct ast_channel *chan, const char *file, int lineno, const char *func);
1230
1231 #define ast_channel_trylock(a) __ast_channel_trylock(a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1232 /*! \brief Lock AST channel (and print debugging output)
1233 \note   You need to enable DEBUG_CHANNEL_LOCKS for this function */
1234 int __ast_channel_trylock(struct ast_channel *chan, const char *file, int lineno, const char *func);
1235 #endif
1236
1237 #endif /* _ASTERISK_LOCK_H */