309c7ab82b365cece445e07765975ef3e1c5528f
[asterisk/asterisk.git] / include / asterisk / lock.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * General Asterisk channel definitions.
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #ifndef _ASTERISK_LOCK_H
15 #define _ASTERISK_LOCK_H
16
17 #include <pthread.h>
18 #include <netdb.h>
19
20 #define AST_PTHREADT_NULL (pthread_t) -1
21 #define AST_PTHREADT_STOP (pthread_t) -2
22
23 #ifdef __APPLE__
24 /* Provide the Linux initializers for MacOS X */
25 #define PTHREAD_MUTEX_RECURSIVE_NP                                      PTHREAD_MUTEX_RECURSIVE
26 #define PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP           { 0x4d555458, \
27                                                                                                            { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, \
28                                                                                                                  0x20 } }
29 #endif
30
31 #ifdef __FreeBSD__
32 #ifdef __GNUC__
33 #define AST_MUTEX_INIT_W_CONSTRUCTORS
34 #else
35 #define AST_MUTEX_INIT_ON_FIRST_USE
36 #endif
37 #endif /* __FreeBSD__ */
38
39 #ifdef DEBUG_THREADS
40
41 #ifdef THREAD_CRASH
42 #define DO_THREAD_CRASH do { *((int *)(0)) = 1; } while(0)
43 #endif
44
45 #include <errno.h>
46 #include <string.h>
47 #include <stdio.h>
48 #include <unistd.h>
49
50 /* From now on, Asterisk REQUIRES Recursive (not error checking) mutexes
51    and will not run without them. */
52 #ifdef PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
53 #define AST_MUTEX_INIT_VAULE      { PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP, NULL, 0, NULL, 0 }
54 #define AST_MUTEX_KIND             PTHREAD_MUTEX_RECURSIVE_NP
55 #else
56 #define AST_MUTEX_INIT_VAULE      { PTHREAD_MUTEX_INITIALIZER, NULL, 0, NULL, 0 }
57 #define AST_MUTEX_KIND             PTHREAD_MUTEX_RECURSIVE
58 #endif /* PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP */
59
60 struct ast_mutex_info {
61         pthread_mutex_t mutex;
62         char *file;
63         int lineno;
64         char *func;
65         pthread_t thread;
66 };
67
68 typedef struct ast_mutex_info ast_mutex_t;
69
70 static inline int ast_pthread_mutex_init(ast_mutex_t *t, pthread_mutexattr_t *attr) 
71 {
72         t->file = NULL;
73         t->lineno = 0;
74         t->func = 0;
75         t->thread  = 0;
76         return pthread_mutex_init(&t->mutex, attr);
77 }
78
79 static inline int ast_mutex_init(ast_mutex_t *t)
80 {
81         static pthread_mutexattr_t  attr;
82         pthread_mutexattr_init(&attr);
83         pthread_mutexattr_settype(&attr, AST_MUTEX_KIND);
84         return ast_pthread_mutex_init(t, &attr);
85 }
86
87 #if defined(AST_MUTEX_INIT_W_CONSTRUCTORS)
88 /* if AST_MUTEX_INIT_W_CONSTRUCTORS is defined, use file scope
89  constrictors/destructors to create/destroy mutexes.  */ 
90 #define __AST_MUTEX_DEFINE(scope,mutex) \
91         scope ast_mutex_t mutex = AST_MUTEX_INIT_VAULE; \
92 static void  __attribute__ ((constructor)) init_##mutex(void) \
93 { \
94         ast_mutex_init(&mutex); \
95 } \
96 static void  __attribute__ ((destructor)) fini_##mutex(void) \
97 { \
98         ast_mutex_destroy(&mutex); \
99 }
100 #elif defined(AST_MUTEX_INIT_ON_FIRST_USE) || !defined(AST_MUTEX_INIT_W_CONSTRUCTORS)
101 /* if AST_MUTEX_INIT_ON_FIRST_USE is defined, mutexes are created on
102  first use.  The performance impact on FreeBSD should be small since
103  the pthreads library does this itself to initialize errror checking
104  (defaulty type) mutexes.  If nither is defined, the pthreads librariy
105  does the initialization itself on first use. */ 
106 #define __AST_MUTEX_DEFINE(scope,mutex) \
107         scope ast_mutex_t mutex = AST_MUTEX_INIT_VAULE
108 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
109
110 static inline int __ast_pthread_mutex_lock(char *filename, int lineno, char *func, ast_mutex_t *t)
111 {
112         int res;
113 #ifdef AST_MUTEX_INIT_ON_FIRST_USE
114         if(*t->mutex == (ast_mutex_t)AST_MUTEX_KIND)
115                 ast_mutex_init(t->mutex);
116 #endif
117         res = pthread_mutex_lock(&t->mutex);
118         if (!res) {
119                 t->file = filename;
120                 t->lineno = lineno;
121                 t->func = func;
122                 t->thread = pthread_self();
123         } else {
124                 fprintf(stderr, "%s line %d (%s): Error obtaining mutex: %s\n",
125                         filename, lineno, func, strerror(errno));
126 #ifdef THREAD_CRASH
127                 DO_THREAD_CRASH;
128 #endif
129         }
130         return res;
131 }
132
133 #define ast_mutex_lock(a) __ast_pthread_mutex_lock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a)
134
135 static inline int __ast_pthread_mutex_trylock(char *filename, int lineno, char *func, ast_mutex_t *t) {
136         int res;
137 #ifdef AST_MUTEX_INIT_ON_FIRST_USE
138         if(*t->mutex == (ast_mutex_t)AST_MUTEX_KIND)
139                 ast_mutex_init(t->mutex);
140 #endif
141         res = pthread_mutex_trylock(&t->mutex);
142         if (!res) {
143                 t->file = filename;
144                 t->lineno = lineno;
145                 t->func = func;
146                 t->thread = pthread_self();
147         }
148         return res;
149 }
150
151 #define ast_mutex_trylock(a) __ast_pthread_mutex_trylock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a)
152
153 static inline int __ast_pthread_mutex_unlock(char *filename, int lineno, char *func, ast_mutex_t *t) {
154         int res;
155         /* Assumes lock is actually held */
156         t->file = NULL;
157         t->lineno = 0;
158         t->func = NULL;
159         t->thread = 0;
160         res = pthread_mutex_unlock(&t->mutex);
161         if (res) {
162                 fprintf(stderr, "%s line %d (%s): Error releasing mutex: %s\n", 
163                                 filename, lineno, func, strerror(res));
164 #ifdef THREAD_CRASH
165                 DO_THREAD_CRASH;
166 #endif
167         }
168         return res;
169 }
170
171 #define ast_mutex_unlock(a) __ast_pthread_mutex_unlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a)
172
173 static inline int __ast_pthread_mutex_destroy(char *filename, int lineno, char *func, ast_mutex_t *t)
174 {
175         int res;
176         t->file = NULL;
177         t->lineno = 0;
178         t->func = NULL;
179         t->thread = 0;
180         res = pthread_mutex_destroy(&t->mutex);
181         if (res) 
182                 fprintf(stderr, "%s line %d (%s): Error destroying mutex: %s\n",
183                                 filename, lineno, func, strerror(res));
184         return res;
185 }
186
187 #define ast_mutex_destroy(a) __ast_pthread_mutex_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, a)
188
189 #define pthread_mutex_t use_ast_mutex_t_instead_of_pthread_mutex_t
190 #define pthread_mutex_lock use_ast_mutex_lock_instead_of_pthread_mutex_lock
191 #define pthread_mutex_unlock use_ast_mutex_unlock_instead_of_pthread_mutex_unlock
192 #define pthread_mutex_trylock use_ast_mutex_trylock_instead_of_pthread_mutex_trylock
193 #define pthread_mutex_init use_ast_pthread_mutex_init_instead_of_pthread_mutex_init
194 #define pthread_mutex_destroy use_ast_pthread_mutex_destroy_instead_of_pthread_mutex_destroy
195
196 #else /* DEBUG_THREADS */
197
198 /* From now on, Asterisk REQUIRES Recursive (not error checking) mutexes
199    and will not run without them. */
200 #ifdef PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
201 #define AST_MUTEX_INIT_VAULE      PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
202 #define AST_MUTEX_KIND             PTHREAD_MUTEX_RECURSIVE_NP
203 #else
204 #define AST_MUTEX_INIT_VAULE      PTHREAD_MUTEX_INITIALIZER
205 #define AST_MUTEX_KIND             PTHREAD_MUTEX_RECURSIVE
206 #endif /* PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP */
207
208 typedef pthread_mutex_t ast_mutex_t;
209
210 static inline int ast_mutex_init(ast_mutex_t *pmutex)
211 {
212         pthread_mutexattr_t attr;
213         pthread_mutexattr_init(&attr);
214         pthread_mutexattr_settype(&attr, AST_MUTEX_KIND);
215         return pthread_mutex_init(pmutex, &attr);
216 }
217 #define ast_pthread_mutex_init(pmutex,a) pthread_mutex_init(pmutex,a)
218 #define ast_mutex_unlock(pmutex) pthread_mutex_unlock(pmutex)
219 #define ast_mutex_destroy(pmutex) pthread_mutex_destroy(pmutex)
220
221 #if defined(AST_MUTEX_INIT_W_CONSTRUCTORS)
222 /* if AST_MUTEX_INIT_W_CONSTRUCTORS is defined, use file scope
223  constrictors/destructors to create/destroy mutexes.  */ 
224 #define __AST_MUTEX_DEFINE(scope,mutex) \
225         scope ast_mutex_t mutex = AST_MUTEX_INIT_VAULE; \
226 static void  __attribute__ ((constructor)) init_##mutex(void) \
227 { \
228         ast_mutex_init(&mutex); \
229 } \
230 static void  __attribute__ ((destructor)) fini_##mutex(void) \
231 { \
232         ast_mutex_destroy(&mutex); \
233 }
234
235 #define ast_mutex_lock(pmutex) pthread_mutex_lock(pmutex)
236 #define ast_mutex_trylock(pmutex) pthread_mutex_trylock(pmutex)
237
238 #elif defined(AST_MUTEX_INIT_ON_FIRST_USE)
239 /* if AST_MUTEX_INIT_ON_FIRST_USE is defined, mutexes are created on
240  first use.  The performance impact on FreeBSD should be small since
241  the pthreads library does this itself to initialize errror checking
242  (defaulty type) mutexes.*/ 
243 #define __AST_MUTEX_DEFINE(scope,mutex) \
244         scope ast_mutex_t mutex = AST_MUTEX_INIT_VAULE
245
246 static inline int ast_mutex_lock(ast_mutex_t *pmutex)
247 {
248   if(*pmutex == (ast_mutex_t)AST_MUTEX_KIND)
249     ast_mutex_init(pmutex);
250   return pthread_mutex_lock(pmutex);
251 }
252 static inline int ast_mutex_trylock(ast_mutex_t *pmutex)
253 {
254   if(*pmutex == (ast_mutex_t)AST_MUTEX_KIND)
255     ast_mutex_init(pmutex);
256   return pthread_mutex_trylock(pmutex);
257 }
258 #else
259 /* By default, use static initialization of mutexes.*/ 
260 #define __AST_MUTEX_DEFINE(scope,mutex) \
261         scope ast_mutex_t mutex = AST_MUTEX_INIT_VAULE
262 #define ast_mutex_lock(pmutex) pthread_mutex_lock(pmutex)
263 #define ast_mutex_trylock(pmutex) pthread_mutex_trylock(pmutex)
264 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
265
266 #endif /* DEBUG_THREADS */
267
268 #define AST_MUTEX_DEFINE_STATIC(mutex) __AST_MUTEX_DEFINE(static,mutex)
269 #define AST_MUTEX_DEFINE_EXPORTED(mutex) __AST_MUTEX_DEFINE(/**/,mutex)
270
271
272 #define AST_MUTEX_INITIALIZER __use_AST_MUTEX_DEFINE_STATIC_rather_than_AST_MUTEX_INITIALIZER__
273 #define gethostbyname __gethostbyname__is__not__reentrant__use__ast_gethostbyname__instead__
274
275 #endif