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