Kannel: Open Source WAP and SMS gateway  svn-r5335
thread.h
Go to the documentation of this file.
1 /* ====================================================================
2  * The Kannel Software License, Version 1.0
3  *
4  * Copyright (c) 2001-2018 Kannel Group
5  * Copyright (c) 1998-2001 WapIT Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Kannel Group (http://www.kannel.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Kannel" and "Kannel Group" must not be used to
28  * endorse or promote products derived from this software without
29  * prior written permission. For written permission, please
30  * contact org@kannel.org.
31  *
32  * 5. Products derived from this software may not be called "Kannel",
33  * nor may "Kannel" appear in their name, without prior written
34  * permission of the Kannel Group.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS
40  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
41  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
42  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
43  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
44  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
45  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
46  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Kannel Group. For more information on
51  * the Kannel Group, please see <http://www.kannel.org/>.
52  *
53  * Portions of this software are based upon software originally written at
54  * WapIT Ltd., Helsinki, Finland for the Kannel project.
55  */
56 
57 /*
58  * thread.h - thread manipulation
59  */
60 
61 #ifndef GW_THREAD_H
62 #define GW_THREAD_H
63 
64 #include "gw-config.h"
65 
66 #if !HAVE_PTHREAD_H
67 #error "You need POSIX.1 threads and <pthread.h> header file"
68 #endif
69 
70 #include <pthread.h>
71 
72 /*
73  * Wrapper around pthread_mutex_t to avoid problems with recursive calls
74  * to pthread_mutex_trylock on Linux (at least).
75  */
76 typedef struct {
77  pthread_mutex_t mutex;
78  long owner;
79  int dynamic;
80 #ifdef MUTEX_STATS
81  unsigned char *filename;
82  int lineno;
83  long locks;
84  long collisions;
85 #endif
86 } Mutex;
87 
88 
89 /*
90  * Create a Mutex.
91  */
92 #ifdef MUTEX_STATS
93 #define mutex_create() gw_claim_area(mutex_create_measured(mutex_create_real(), \
94  __FILE__, __LINE__))
95 #else
96 #define mutex_create() gw_claim_area(mutex_create_real())
97 #endif
98 
99 /*
100  * Create a Mutex. Call these functions via the macro defined above.
101  */
102 Mutex *mutex_create_measured(Mutex *mutex, char *filename, int lineno);
103 Mutex *mutex_create_real(void);
104 
105 
106 /*
107  * Initialize a statically allocated Mutex. We need those inside gwlib
108  * modules that are in turn used by the mutex wrapper, such as "gwmem" and
109  * "protected".
110  */
111 #ifdef MUTEX_STATS
112 #define mutex_init_static(mutex) \
113  mutex_create_measured(mutex_init_static_real(mutex), __FILE__, __LINE__)
114 #else
115 #define mutex_init_static(mutex) \
116  mutex_init_static_real(mutex)
117 #endif
118 
119 Mutex *mutex_init_static_real(Mutex *mutex);
120 
121 
122 /*
123  * Destroy a Mutex.
124  */
125 void mutex_destroy(Mutex *mutex);
126 
127 
128 /* lock given mutex. PANIC if fails (non-initialized mutex or other
129  * coding error) */
130 #define mutex_lock(m) mutex_lock_real(m, __FILE__, __LINE__, __func__)
131 void mutex_lock_real(Mutex *mutex, char *file, int line, const char *func);
132 
133 
134 /* unlock given mutex, PANIC if fails (so do not call for non-locked) */
135 /* returns 0 if ok 1 if failure for debugging */
136 #define mutex_unlock(m) mutex_unlock_real(m, __FILE__, __LINE__, __func__)
137 int mutex_unlock_real(Mutex *mutex, char *file, int line, const char *func);
138 
139 
140 /*
141  * Try to lock given mutex, returns -1 if mutex is NULL; 0 if mutex acquired; otherwise
142  * EBUSY. PANIC if mutex was not properly initialized before.
143  */
144 #define mutex_trylock(m) mutex_trylock_real(m, __FILE__, __LINE__, __func__)
145 int mutex_trylock_real(Mutex *mutex, const char *file, int line, const char *func);
146 
147 #endif
148 
149 
mutex_trylock_real
int mutex_trylock_real(Mutex *mutex, const char *file, int line, const char *func)
Definition: thread.c:165
Mutex::dynamic
int dynamic
Definition: thread.h:79
file
FILE * file
Definition: log.c:169
locks
static Mutex locks[NUM_LOCKS]
Definition: protected.c:88
mutex_lock_real
void mutex_lock_real(Mutex *mutex, char *file, int line, const char *func)
Definition: thread.c:121
mutex_init_static_real
Mutex * mutex_init_static_real(Mutex *mutex)
Definition: thread.c:89
mutex
Mutex * mutex
Definition: fakewap.c:238
mutex_create_real
Mutex * mutex_create_real(void)
Definition: thread.c:78
Mutex::mutex
pthread_mutex_t mutex
Definition: thread.h:77
filename
char filename[FILENAME_MAX+1]
Definition: log.c:171
mutex_unlock_real
int mutex_unlock_real(Mutex *mutex, char *file, int line, const char *func)
Definition: thread.c:146
Mutex
Definition: thread.h:76
mutex_destroy
void mutex_destroy(Mutex *mutex)
Definition: thread.c:97
Mutex::owner
long owner
Definition: thread.h:78
mutex_create_measured
Mutex * mutex_create_measured(Mutex *mutex, char *filename, int lineno)
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.