5c42d1eb27b726c6d4e317df6397d685740c3963
[asterisk/asterisk.git] / include / asterisk / lock.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2010, 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 <time.h>
53 #include <sys/param.h>
54 #ifdef HAVE_BKTR
55 #include <execinfo.h>
56 #endif
57
58 #ifndef HAVE_PTHREAD_RWLOCK_TIMEDWRLOCK
59 #include "asterisk/time.h"
60 #endif
61
62 #include "asterisk/logger.h"
63
64 #define AST_PTHREADT_NULL (pthread_t) -1
65 #define AST_PTHREADT_STOP (pthread_t) -2
66
67 #if (defined(SOLARIS) || defined(BSD))
68 #define AST_MUTEX_INIT_W_CONSTRUCTORS
69 #endif /* SOLARIS || BSD */
70
71 /* Asterisk REQUIRES recursive (not error checking) mutexes
72    and will not run without them. */
73 #if defined(HAVE_PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP) && defined(HAVE_PTHREAD_MUTEX_RECURSIVE_NP)
74 #define PTHREAD_MUTEX_INIT_VALUE        PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
75 #define AST_MUTEX_KIND                  PTHREAD_MUTEX_RECURSIVE_NP
76 #else
77 #define PTHREAD_MUTEX_INIT_VALUE        PTHREAD_MUTEX_INITIALIZER
78 #define AST_MUTEX_KIND                  PTHREAD_MUTEX_RECURSIVE
79 #endif /* PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP */
80
81 #ifdef HAVE_PTHREAD_RWLOCK_INITIALIZER
82 #define __AST_RWLOCK_INIT_VALUE         PTHREAD_RWLOCK_INITIALIZER
83 #else  /* HAVE_PTHREAD_RWLOCK_INITIALIZER */
84 #define __AST_RWLOCK_INIT_VALUE         {0}
85 #endif /* HAVE_PTHREAD_RWLOCK_INITIALIZER */
86
87 #ifdef HAVE_BKTR
88 #define AST_LOCK_TRACK_INIT_VALUE { { NULL }, { 0 }, 0, { NULL }, { 0 }, {{{ 0 }}}, PTHREAD_MUTEX_INIT_VALUE }
89 #else
90 #define AST_LOCK_TRACK_INIT_VALUE { { NULL }, { 0 }, 0, { NULL }, { 0 }, PTHREAD_MUTEX_INIT_VALUE }
91 #endif
92
93 #define AST_MUTEX_INIT_VALUE { AST_LOCK_TRACK_INIT_VALUE, 1, PTHREAD_MUTEX_INIT_VALUE }
94 #define AST_MUTEX_INIT_VALUE_NOTRACKING { AST_LOCK_TRACK_INIT_VALUE, 0, PTHREAD_MUTEX_INIT_VALUE }
95
96 #define AST_RWLOCK_INIT_VALUE { AST_LOCK_TRACK_INIT_VALUE, 1, __AST_RWLOCK_INIT_VALUE }
97 #define AST_RWLOCK_INIT_VALUE_NOTRACKING { AST_LOCK_TRACK_INIT_VALUE, 0, __AST_RWLOCK_INIT_VALUE }
98
99 #define AST_MAX_REENTRANCY 10
100
101 struct ast_channel;
102
103 struct ast_lock_track {
104         const char *file[AST_MAX_REENTRANCY];
105         int lineno[AST_MAX_REENTRANCY];
106         int reentrancy;
107         const char *func[AST_MAX_REENTRANCY];
108         pthread_t thread[AST_MAX_REENTRANCY];
109 #ifdef HAVE_BKTR
110         struct ast_bt backtrace[AST_MAX_REENTRANCY];
111 #endif
112         pthread_mutex_t reentr_mutex;
113 };
114
115 /*! \brief Structure for mutex and tracking information.
116  *
117  * We have tracking information in this structure regardless of DEBUG_THREADS being enabled.
118  * The information will just be ignored in the core if a module does not request it..
119  */
120 struct ast_mutex_info {
121         /*! Track which thread holds this mutex */
122         struct ast_lock_track track;
123         unsigned int tracking:1;
124         pthread_mutex_t mutex;
125 };
126
127 /*! \brief Structure for rwlock and tracking information.
128  *
129  * We have tracking information in this structure regardless of DEBUG_THREADS being enabled.
130  * The information will just be ignored in the core if a module does not request it..
131  */
132 struct ast_rwlock_info {
133         /*! Track which thread holds this lock */
134         struct ast_lock_track track;
135         unsigned int tracking:1;
136         pthread_rwlock_t lock;
137 };
138
139 typedef struct ast_mutex_info ast_mutex_t;
140
141 typedef struct ast_rwlock_info ast_rwlock_t;
142
143 typedef pthread_cond_t ast_cond_t;
144
145 int __ast_pthread_mutex_init(int tracking, const char *filename, int lineno, const char *func, const char *mutex_name, ast_mutex_t *t);
146 int __ast_pthread_mutex_destroy(const char *filename, int lineno, const char *func, const char *mutex_name, ast_mutex_t *t);
147 int __ast_pthread_mutex_lock(const char *filename, int lineno, const char *func, const char* mutex_name, ast_mutex_t *t);
148 int __ast_pthread_mutex_trylock(const char *filename, int lineno, const char *func, const char* mutex_name, ast_mutex_t *t);
149 int __ast_pthread_mutex_unlock(const char *filename, int lineno, const char *func, const char *mutex_name, ast_mutex_t *t);
150
151 #define ast_mutex_init(pmutex)            __ast_pthread_mutex_init(1, __FILE__, __LINE__, __PRETTY_FUNCTION__, #pmutex, pmutex)
152 #define ast_mutex_init_notracking(pmutex) __ast_pthread_mutex_init(0, __FILE__, __LINE__, __PRETTY_FUNCTION__, #pmutex, pmutex)
153 #define ast_mutex_destroy(a)              __ast_pthread_mutex_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
154 #define ast_mutex_lock(a)                 __ast_pthread_mutex_lock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
155 #define ast_mutex_unlock(a)               __ast_pthread_mutex_unlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
156 #define ast_mutex_trylock(a)              __ast_pthread_mutex_trylock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
157
158
159 int __ast_cond_init(const char *filename, int lineno, const char *func, const char *cond_name, ast_cond_t *cond, pthread_condattr_t *cond_attr);
160 int __ast_cond_signal(const char *filename, int lineno, const char *func, const char *cond_name, ast_cond_t *cond);
161 int __ast_cond_broadcast(const char *filename, int lineno, const char *func, const char *cond_name, ast_cond_t *cond);
162 int __ast_cond_destroy(const char *filename, int lineno, const char *func, const char *cond_name, ast_cond_t *cond);
163 int __ast_cond_wait(const char *filename, int lineno, const char *func, const char *cond_name, const char *mutex_name, ast_cond_t *cond, ast_mutex_t *t);
164 int __ast_cond_timedwait(const char *filename, int lineno, const char *func, const char *cond_name, const char *mutex_name, ast_cond_t *cond, ast_mutex_t *t, const struct timespec *abstime);
165
166 #define ast_cond_init(cond, attr)             __ast_cond_init(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond, attr)
167 #define ast_cond_destroy(cond)                __ast_cond_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
168 #define ast_cond_signal(cond)                 __ast_cond_signal(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
169 #define ast_cond_broadcast(cond)              __ast_cond_broadcast(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
170 #define ast_cond_wait(cond, mutex)            __ast_cond_wait(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, #mutex, cond, mutex)
171 #define ast_cond_timedwait(cond, mutex, time) __ast_cond_timedwait(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, #mutex, cond, mutex, time)
172
173
174 int __ast_rwlock_init(int tracking, const char *filename, int lineno, const char *func, const char *rwlock_name, ast_rwlock_t *t);
175 int __ast_rwlock_destroy(const char *filename, int lineno, const char *func, const char *rwlock_name, ast_rwlock_t *t);
176 int __ast_rwlock_unlock(ast_rwlock_t *t, const char *name, const char *filename, int line, const char *func);
177 int __ast_rwlock_rdlock(ast_rwlock_t *t, const char *name, const char *filename, int line, const char *func);
178 int __ast_rwlock_wrlock(ast_rwlock_t *t, const char *name, const char *filename, int line, const char *func);
179 int __ast_rwlock_timedrdlock(ast_rwlock_t *t, const char *name, const struct timespec *abs_timeout, const char *filename, int line, const char *func);
180 int __ast_rwlock_timedwrlock(ast_rwlock_t *t, const char *name, const struct timespec *abs_timeout, const char *filename, int line, const char *func);
181 int __ast_rwlock_tryrdlock(ast_rwlock_t *t, const char *name, const char *filename, int line, const char *func);
182 int __ast_rwlock_trywrlock(ast_rwlock_t *t, const char *name, const char *filename, int line, const char *func);
183
184 /*!
185  * \brief wrapper for rwlock with tracking enabled
186  * \return 0 on success, non zero for error
187  * \since 1.6.1
188  */
189 #define ast_rwlock_init(rwlock)            __ast_rwlock_init(1, __FILE__, __LINE__, __PRETTY_FUNCTION__, #rwlock, rwlock)
190
191 /*!
192  * \brief wrapper for ast_rwlock_init with tracking disabled
193  * \return 0 on success, non zero for error
194  * \since 1.6.1
195  */
196 #define ast_rwlock_init_notracking(rwlock) __ast_rwlock_init(0, __FILE__, __LINE__, __PRETTY_FUNCTION__, #rwlock, rwlock)
197
198 #define ast_rwlock_destroy(rwlock)         __ast_rwlock_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #rwlock, rwlock)
199 #define ast_rwlock_unlock(a)               __ast_rwlock_unlock(a, #a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
200 #define ast_rwlock_rdlock(a)               __ast_rwlock_rdlock(a, #a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
201 #define ast_rwlock_wrlock(a)               __ast_rwlock_wrlock(a, #a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
202 #define ast_rwlock_tryrdlock(a)            __ast_rwlock_tryrdlock(a, #a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
203 #define ast_rwlock_trywrlock(a)            __ast_rwlock_trywrlock(a, #a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
204 #define ast_rwlock_timedrdlock(a, b)       __ast_rwlock_timedrdlock(a, #a, b, __FILE__, __LINE__, __PRETTY_FUNCTION__)
205 #define ast_rwlock_timedwrlock(a, b)       __ast_rwlock_timedwrlock(a, #a, b, __FILE__, __LINE__, __PRETTY_FUNCTION__)
206
207 #define ROFFSET ((lt->reentrancy > 0) ? (lt->reentrancy-1) : 0)
208
209 #ifdef DEBUG_THREADS
210
211 #define __ast_mutex_logger(...)  do { if (canlog) ast_log(LOG_ERROR, __VA_ARGS__); else fprintf(stderr, __VA_ARGS__); } while (0)
212
213 #ifdef THREAD_CRASH
214 #define DO_THREAD_CRASH do { *((int *)(0)) = 1; } while(0)
215 #else
216 #define DO_THREAD_CRASH do { } while (0)
217 #endif
218
219 #include <errno.h>
220
221 enum ast_lock_type {
222         AST_MUTEX,
223         AST_RDLOCK,
224         AST_WRLOCK,
225 };
226
227 /*!
228  * \brief Store lock info for the current thread
229  *
230  * This function gets called in ast_mutex_lock() and ast_mutex_trylock() so
231  * that information about this lock can be stored in this thread's
232  * lock info struct.  The lock is marked as pending as the thread is waiting
233  * on the lock.  ast_mark_lock_acquired() will mark it as held by this thread.
234  */
235 #if !defined(LOW_MEMORY)
236 #ifdef HAVE_BKTR
237 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
238         int line_num, const char *func, const char *lock_name, void *lock_addr, struct ast_bt *bt);
239 #else
240 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
241         int line_num, const char *func, const char *lock_name, void *lock_addr);
242 #endif /* HAVE_BKTR */
243
244 #else
245
246 #ifdef HAVE_BKTR
247 #define ast_store_lock_info(I,DONT,CARE,ABOUT,THE,PARAMETERS,BUD)
248 #else
249 #define ast_store_lock_info(I,DONT,CARE,ABOUT,THE,PARAMETERS)
250 #endif /* HAVE_BKTR */
251 #endif /* !defined(LOW_MEMORY) */
252
253 /*!
254  * \brief Mark the last lock as acquired
255  */
256 #if !defined(LOW_MEMORY)
257 void ast_mark_lock_acquired(void *lock_addr);
258 #else
259 #define ast_mark_lock_acquired(ignore)
260 #endif
261
262 /*!
263  * \brief Mark the last lock as failed (trylock)
264  */
265 #if !defined(LOW_MEMORY)
266 void ast_mark_lock_failed(void *lock_addr);
267 #else
268 #define ast_mark_lock_failed(ignore)
269 #endif
270
271 /*!
272  * \brief remove lock info for the current thread
273  *
274  * this gets called by ast_mutex_unlock so that information on the lock can
275  * be removed from the current thread's lock info struct.
276  */
277 #if !defined(LOW_MEMORY)
278 #ifdef HAVE_BKTR
279 void ast_remove_lock_info(void *lock_addr, struct ast_bt *bt);
280 #else
281 void ast_remove_lock_info(void *lock_addr);
282 #endif /* HAVE_BKTR */
283 #else
284 #ifdef HAVE_BKTR
285 #define ast_remove_lock_info(ignore,me)
286 #else
287 #define ast_remove_lock_info(ignore)
288 #endif /* HAVE_BKTR */
289 #endif /* !defined(LOW_MEMORY) */
290
291 #ifdef HAVE_BKTR
292 static inline void __dump_backtrace(struct ast_bt *bt, int canlog)
293 {
294         char **strings;
295
296         ssize_t i;
297
298         strings = backtrace_symbols(bt->addresses, bt->num_frames);
299
300         for (i = 0; i < bt->num_frames; i++)
301                 __ast_mutex_logger("%s\n", strings[i]);
302
303         free(strings);
304 }
305 #endif
306
307 /*!
308  * \brief log info for the current lock with ast_log().
309  *
310  * this function would be mostly for debug. If you come across a lock
311  * that is unexpectedly but momentarily locked, and you wonder who
312  * are fighting with for the lock, this routine could be called, IF
313  * you have the thread debugging stuff turned on.
314  * \param this_lock_addr lock address to return lock information
315  * \since 1.6.1
316  */
317 void log_show_lock(void *this_lock_addr);
318
319 /*!
320  * \brief retrieve lock info for the specified mutex
321  *
322  * this gets called during deadlock avoidance, so that the information may
323  * be preserved as to what location originally acquired the lock.
324  */
325 #if !defined(LOW_MEMORY)
326 int ast_find_lock_info(void *lock_addr, char *filename, size_t filename_size, int *lineno, char *func, size_t func_size, char *mutex_name, size_t mutex_name_size);
327 #else
328 #define ast_find_lock_info(a,b,c,d,e,f,g,h) -1
329 #endif
330
331 /*!
332  * \brief Unlock a lock briefly
333  *
334  * used during deadlock avoidance, to preserve the original location where
335  * a lock was originally acquired.
336  */
337 #define CHANNEL_DEADLOCK_AVOIDANCE(chan) \
338         do { \
339                 char __filename[80], __func[80], __mutex_name[80]; \
340                 int __lineno; \
341                 int __res = ast_find_lock_info(ao2_object_get_lockaddr(chan), __filename, sizeof(__filename), &__lineno, __func, sizeof(__func), __mutex_name, sizeof(__mutex_name)); \
342                 ast_channel_unlock(chan); \
343                 usleep(1); \
344                 if (__res < 0) { /* Shouldn't ever happen, but just in case... */ \
345                         ast_channel_lock(chan); \
346                 } else { \
347                         __ao2_lock(chan, __filename, __func, __lineno, __mutex_name); \
348                 } \
349         } while (0)
350
351 #define DEADLOCK_AVOIDANCE(lock) \
352         do { \
353                 char __filename[80], __func[80], __mutex_name[80]; \
354                 int __lineno; \
355                 int __res = ast_find_lock_info(lock, __filename, sizeof(__filename), &__lineno, __func, sizeof(__func), __mutex_name, sizeof(__mutex_name)); \
356                 ast_mutex_unlock(lock); \
357                 usleep(1); \
358                 if (__res < 0) { /* Shouldn't ever happen, but just in case... */ \
359                         ast_mutex_lock(lock); \
360                 } else { \
361                         __ast_pthread_mutex_lock(__filename, __lineno, __func, __mutex_name, lock); \
362                 } \
363         } while (0)
364
365 /*!
366  * \brief Deadlock avoidance unlock
367  *
368  * In certain deadlock avoidance scenarios, there is more than one lock to be
369  * unlocked and relocked.  Therefore, this pair of macros is provided for that
370  * purpose.  Note that every DLA_UNLOCK _MUST_ be paired with a matching
371  * DLA_LOCK.  The intent of this pair of macros is to be used around another
372  * set of deadlock avoidance code, mainly CHANNEL_DEADLOCK_AVOIDANCE, as the
373  * locking order specifies that we may safely lock a channel, followed by its
374  * pvt, with no worries about a deadlock.  In any other scenario, this macro
375  * may not be safe to use.
376  */
377 #define DLA_UNLOCK(lock) \
378         do { \
379                 char __filename[80], __func[80], __mutex_name[80]; \
380                 int __lineno; \
381                 int __res = ast_find_lock_info(lock, __filename, sizeof(__filename), &__lineno, __func, sizeof(__func), __mutex_name, sizeof(__mutex_name)); \
382                 ast_mutex_unlock(lock);
383
384 /*!
385  * \brief Deadlock avoidance lock
386  *
387  * In certain deadlock avoidance scenarios, there is more than one lock to be
388  * unlocked and relocked.  Therefore, this pair of macros is provided for that
389  * purpose.  Note that every DLA_UNLOCK _MUST_ be paired with a matching
390  * DLA_LOCK.  The intent of this pair of macros is to be used around another
391  * set of deadlock avoidance code, mainly CHANNEL_DEADLOCK_AVOIDANCE, as the
392  * locking order specifies that we may safely lock a channel, followed by its
393  * pvt, with no worries about a deadlock.  In any other scenario, this macro
394  * may not be safe to use.
395  */
396 #define DLA_LOCK(lock) \
397                 if (__res < 0) { /* Shouldn't ever happen, but just in case... */ \
398                         ast_mutex_lock(lock); \
399                 } else { \
400                         __ast_pthread_mutex_lock(__filename, __lineno, __func, __mutex_name, lock); \
401                 } \
402         } while (0)
403
404 static inline void ast_reentrancy_lock(struct ast_lock_track *lt)
405 {
406         pthread_mutex_lock(&lt->reentr_mutex);
407 }
408
409 static inline void ast_reentrancy_unlock(struct ast_lock_track *lt)
410 {
411         pthread_mutex_unlock(&lt->reentr_mutex);
412 }
413
414 static inline void ast_reentrancy_init(struct ast_lock_track *lt)
415 {
416         int i;
417         pthread_mutexattr_t reentr_attr;
418
419         for (i = 0; i < AST_MAX_REENTRANCY; i++) {
420                 lt->file[i] = NULL;
421                 lt->lineno[i] = 0;
422                 lt->func[i] = NULL;
423                 lt->thread[i] = 0;
424 #ifdef HAVE_BKTR
425                 memset(&lt->backtrace[i], 0, sizeof(lt->backtrace[i]));
426 #endif
427         }
428
429         lt->reentrancy = 0;
430
431         pthread_mutexattr_init(&reentr_attr);
432         pthread_mutexattr_settype(&reentr_attr, AST_MUTEX_KIND);
433         pthread_mutex_init(&lt->reentr_mutex, &reentr_attr);
434         pthread_mutexattr_destroy(&reentr_attr);
435 }
436
437 static inline void delete_reentrancy_cs(struct ast_lock_track *lt)
438 {
439         pthread_mutex_destroy(&lt->reentr_mutex);
440 }
441
442 #else /* !DEBUG_THREADS */
443
444 #define CHANNEL_DEADLOCK_AVOIDANCE(chan) \
445         ast_channel_unlock(chan); \
446         usleep(1); \
447         ast_channel_lock(chan);
448
449 #define DEADLOCK_AVOIDANCE(lock) \
450         ast_mutex_unlock(lock); \
451         usleep(1); \
452         ast_mutex_lock(lock);
453
454 #define DLA_UNLOCK(lock) ast_mutex_unlock(lock)
455
456 #define DLA_LOCK(lock) ast_mutex_lock(lock)
457
458 #endif /* !DEBUG_THREADS */
459
460 #if defined(AST_MUTEX_INIT_W_CONSTRUCTORS)
461 /*
462  * If AST_MUTEX_INIT_W_CONSTRUCTORS is defined, use file scope constructors
463  * and destructors to create/destroy global mutexes.
464  */
465 #define __AST_MUTEX_DEFINE(scope, mutex, init_val, track)       \
466         scope ast_mutex_t mutex = init_val;                     \
467 static void  __attribute__((constructor)) init_##mutex(void)    \
468 {                                                               \
469         if (track)                                              \
470                 ast_mutex_init(&mutex);                         \
471         else                                                    \
472                 ast_mutex_init_notracking(&mutex);              \
473 }                                                               \
474                                                                 \
475 static void  __attribute__((destructor)) fini_##mutex(void)     \
476 {                                                               \
477         ast_mutex_destroy(&mutex);                              \
478 }
479 #else /* !AST_MUTEX_INIT_W_CONSTRUCTORS */
480 /* By default, use static initialization of mutexes. */
481 #define __AST_MUTEX_DEFINE(scope, mutex, init_val, track) scope ast_mutex_t mutex = init_val
482 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
483
484 #define AST_MUTEX_DEFINE_STATIC(mutex) __AST_MUTEX_DEFINE(static, mutex, AST_MUTEX_INIT_VALUE, 1)
485 #define AST_MUTEX_DEFINE_STATIC_NOTRACKING(mutex) __AST_MUTEX_DEFINE(static, mutex, AST_MUTEX_INIT_VALUE_NOTRACKING, 0)
486
487
488 /* Statically declared read/write locks */
489 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
490 #define __AST_RWLOCK_DEFINE(scope, rwlock, init_val, track) \
491         scope ast_rwlock_t rwlock = init_val; \
492 static void  __attribute__((constructor)) init_##rwlock(void) \
493 { \
494         if (track) \
495                 ast_rwlock_init(&rwlock); \
496         else \
497                 ast_rwlock_init_notracking(&rwlock); \
498 } \
499 static void  __attribute__((destructor)) fini_##rwlock(void) \
500 { \
501         ast_rwlock_destroy(&rwlock); \
502 }
503 #else
504 #define __AST_RWLOCK_DEFINE(scope, rwlock, init_val, track) scope ast_rwlock_t rwlock = init_val
505 #endif
506
507 #define AST_RWLOCK_DEFINE_STATIC(rwlock) __AST_RWLOCK_DEFINE(static, rwlock, AST_RWLOCK_INIT_VALUE, 1)
508 #define AST_RWLOCK_DEFINE_STATIC_NOTRACKING(rwlock) __AST_RWLOCK_DEFINE(static, rwlock, AST_RWLOCK_INIT_VALUE_NOTRACKING, 0)
509
510 #ifndef __CYGWIN__      /* temporary disabled for cygwin */
511 #define pthread_mutex_t         use_ast_mutex_t_instead_of_pthread_mutex_t
512 #define pthread_cond_t          use_ast_cond_t_instead_of_pthread_cond_t
513 #endif
514 #define pthread_mutex_lock      use_ast_mutex_lock_instead_of_pthread_mutex_lock
515 #define pthread_mutex_unlock    use_ast_mutex_unlock_instead_of_pthread_mutex_unlock
516 #define pthread_mutex_trylock   use_ast_mutex_trylock_instead_of_pthread_mutex_trylock
517 #define pthread_mutex_init      use_ast_mutex_init_instead_of_pthread_mutex_init
518 #define pthread_mutex_destroy   use_ast_mutex_destroy_instead_of_pthread_mutex_destroy
519 #define pthread_cond_init       use_ast_cond_init_instead_of_pthread_cond_init
520 #define pthread_cond_destroy    use_ast_cond_destroy_instead_of_pthread_cond_destroy
521 #define pthread_cond_signal     use_ast_cond_signal_instead_of_pthread_cond_signal
522 #define pthread_cond_broadcast  use_ast_cond_broadcast_instead_of_pthread_cond_broadcast
523 #define pthread_cond_wait       use_ast_cond_wait_instead_of_pthread_cond_wait
524 #define pthread_cond_timedwait  use_ast_cond_timedwait_instead_of_pthread_cond_timedwait
525
526 #define AST_MUTEX_INITIALIZER __use_AST_MUTEX_DEFINE_STATIC_rather_than_AST_MUTEX_INITIALIZER__
527
528 #define gethostbyname __gethostbyname__is__not__reentrant__use__ast_gethostbyname__instead__
529
530 #ifndef __linux__
531 #define pthread_create __use_ast_pthread_create_instead__
532 #endif
533
534 /*
535  * Support for atomic instructions.
536  * For platforms that have it, use the native cpu instruction to
537  * implement them. For other platforms, resort to a 'slow' version
538  * (defined in utils.c) that protects the atomic instruction with
539  * a single lock.
540  * The slow versions is always available, for testing purposes,
541  * as ast_atomic_fetchadd_int_slow()
542  */
543
544 int ast_atomic_fetchadd_int_slow(volatile int *p, int v);
545
546 #include "asterisk/inline_api.h"
547
548 #if defined(HAVE_OSX_ATOMICS)
549 #include "libkern/OSAtomic.h"
550 #endif
551
552 /*! \brief Atomically add v to *p and return * the previous value of *p.
553  * This can be used to handle reference counts, and the return value
554  * can be used to generate unique identifiers.
555  */
556
557 #if defined(HAVE_GCC_ATOMICS)
558 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
559 {
560         return __sync_fetch_and_add(p, v);
561 })
562 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 4)
563 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
564 {
565         return OSAtomicAdd32(v, (int32_t *) p) - v;
566 })
567 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 8)
568 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
569 {
570         return OSAtomicAdd64(v, (int64_t *) p) - v;
571 #elif defined (__i386__) || defined(__x86_64__)
572 #ifdef sun
573 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
574 {
575         __asm __volatile (
576         "       lock;  xaddl   %0, %1 ;        "
577         : "+r" (v),                     /* 0 (result) */
578           "=m" (*p)                     /* 1 */
579         : "m" (*p));                    /* 2 */
580         return (v);
581 })
582 #else /* ifndef sun */
583 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
584 {
585         __asm __volatile (
586         "       lock   xaddl   %0, %1 ;        "
587         : "+r" (v),                     /* 0 (result) */
588           "=m" (*p)                     /* 1 */
589         : "m" (*p));                    /* 2 */
590         return (v);
591 })
592 #endif
593 #else   /* low performance version in utils.c */
594 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
595 {
596         return ast_atomic_fetchadd_int_slow(p, v);
597 })
598 #endif
599
600 /*! \brief decrement *p by 1 and return true if the variable has reached 0.
601  * Useful e.g. to check if a refcount has reached 0.
602  */
603 #if defined(HAVE_GCC_ATOMICS)
604 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
605 {
606         return __sync_sub_and_fetch(p, 1) == 0;
607 })
608 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 4)
609 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
610 {
611         return OSAtomicAdd32( -1, (int32_t *) p) == 0;
612 })
613 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 8)
614 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
615 {
616         return OSAtomicAdd64( -1, (int64_t *) p) == 0;
617 #else
618 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
619 {
620         int a = ast_atomic_fetchadd_int(p, -1);
621         return a == 1; /* true if the value is 0 now (so it was 1 previously) */
622 })
623 #endif
624
625 #endif /* _ASTERISK_LOCK_H */