2 Bacula® - The Network Backup Solution
4 Copyright (C) 2008-2010 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation, which is
11 listed in the file LICENSE.
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
32 #include "mutex_list.h" /* Manage mutex with priority in a central place */
35 * P and V op that don't use the lock manager (for memory allocation or on
38 void lmgr_p(pthread_mutex_t *m);
39 void lmgr_v(pthread_mutex_t *m);
43 typedef struct bthread_mutex_t
45 pthread_mutex_t mutex;
50 * We decide that a thread won't lock more than LMGR_MAX_LOCK at the same time
52 #define LMGR_MAX_LOCK 32
54 int bthread_cond_wait_p(pthread_cond_t *cond,
55 bthread_mutex_t *mutex,
56 const char *file="*unknown*", int line=0);
58 int bthread_cond_timedwait_p(pthread_cond_t *cond,
59 bthread_mutex_t *mutex,
60 const struct timespec * abstime,
61 const char *file="*unknown*", int line=0);
63 /* Same with real pthread_mutex_t */
64 int bthread_cond_wait_p(pthread_cond_t *cond,
65 pthread_mutex_t *mutex,
66 const char *file="*unknown*", int line=0);
68 int bthread_cond_timedwait_p(pthread_cond_t *cond,
69 pthread_mutex_t *mutex,
70 const struct timespec * abstime,
71 const char *file="*unknown*", int line=0);
73 /* Replacement of pthread_mutex_lock() but with real pthread_mutex_t */
74 int bthread_mutex_lock_p(pthread_mutex_t *m,
75 const char *file="*unknown*", int line=0);
77 /* Replacement for pthread_mutex_unlock() but with real pthread_mutex_t */
78 int bthread_mutex_unlock_p(pthread_mutex_t *m,
79 const char *file="*unknown*", int line=0);
81 /* Replacement of pthread_mutex_lock() */
82 int bthread_mutex_lock_p(bthread_mutex_t *m,
83 const char *file="*unknown*", int line=0);
85 /* Replacement of pthread_mutex_unlock() */
86 int bthread_mutex_unlock_p(bthread_mutex_t *m,
87 const char *file="*unknown*", int line=0);
90 * Use them when you want use your lock yourself (ie rwlock)
93 /* Call before requesting the lock */
94 void lmgr_pre_lock(void *m, int prio=0,
95 const char *file="*unknown*", int line=0);
97 /* Call after getting it */
98 void lmgr_post_lock();
100 /* Same as pre+post lock */
101 void lmgr_do_lock(void *m, int prio=0,
102 const char *file="*unknown*", int line=0);
104 /* Call just before releasing the lock */
105 void lmgr_do_unlock(void *m);
107 /* We use C++ mangling to make integration eaysier */
108 int pthread_mutex_init(bthread_mutex_t *m, const pthread_mutexattr_t *attr);
109 int pthread_mutex_destroy(bthread_mutex_t *m);
111 void bthread_mutex_set_priority(bthread_mutex_t *m, int prio);
114 * Each thread have to call this function to put a lmgr_thread_t object
115 * in the stack and be able to call mutex_lock/unlock
117 void lmgr_init_thread();
120 * Call this function at the end of the thread
122 void lmgr_cleanup_thread();
125 * Call this at the end of the program, it will release the
126 * global lock manager
128 void lmgr_cleanup_main();
131 * Dump each lmgr_thread_t object to stdout
138 bool lmgr_detect_deadlock();
141 * Search a deadlock after a fatal signal
142 * no lock are granted, so the program must be
145 bool lmgr_detect_deadlock_unlocked();
148 * This function will run your thread with lmgr_init_thread() and
149 * lmgr_cleanup_thread().
151 int lmgr_thread_create(pthread_t *thread,
152 const pthread_attr_t *attr,
153 void *(*start_routine)(void*), void *arg);
155 #define BTHREAD_MUTEX_NO_PRIORITY {PTHREAD_MUTEX_INITIALIZER, 0}
156 #define BTHREAD_MUTEX_INITIALIZER BTHREAD_MUTEX_NO_PRIORITY
158 /* Define USE_LOCKMGR_PRIORITY to detect mutex wrong order */
159 #ifdef USE_LOCKMGR_PRIORITY
160 # define BTHREAD_MUTEX_PRIORITY(p) {PTHREAD_MUTEX_INITIALIZER, p}
162 # define BTHREAD_MUTEX_PRIORITY(p) BTHREAD_MUTEX_NO_PRIORITY
165 #define bthread_mutex_lock(x) bthread_mutex_lock_p(x, __FILE__, __LINE__)
166 #define bthread_mutex_unlock(x) bthread_mutex_unlock_p(x, __FILE__, __LINE__)
167 #define bthread_cond_wait(x,y) bthread_cond_wait_p(x,y, __FILE__, __LINE__)
168 #define bthread_cond_timedwait(x,y,z) bthread_cond_timedwait_p(x,y,z, __FILE__, __LINE__)
171 * Define _LOCKMGR_COMPLIANT to use real pthread functions
174 #ifdef _LOCKMGR_COMPLIANT
175 # define P(x) lmgr_p(&(x))
176 # define V(x) lmgr_v(&(x))
178 # define P(x) bthread_mutex_lock_p(&(x), __FILE__, __LINE__)
179 # define V(x) bthread_mutex_unlock_p(&(x), __FILE__, __LINE__)
180 # define pthread_create(a, b, c, d) lmgr_thread_create(a,b,c,d)
181 # define pthread_mutex_lock(x) bthread_mutex_lock(x)
182 # define pthread_mutex_unlock(x) bthread_mutex_unlock(x)
183 # define pthread_cond_wait(x,y) bthread_cond_wait(x,y)
184 # define pthread_cond_timedwait(x,y,z) bthread_cond_timedwait(x,y,z)
187 #else /* _USE_LOCKMGR */
189 # define lmgr_detect_deadloc()
191 # define lmgr_init_thread()
192 # define lmgr_cleanup_thread()
193 # define lmgr_pre_lock(m, prio, f, l)
194 # define lmgr_post_lock()
195 # define lmgr_do_lock(m, prio, f, l)
196 # define lmgr_do_unlock(m)
197 # define lmgr_cleanup_main()
198 # define bthread_mutex_set_priority(a,b)
199 # define bthread_mutex_lock(a) pthread_mutex_lock(a)
200 # define bthread_mutex_unlock(a) pthread_mutex_unlock(a)
201 # define lmgr_cond_wait(a,b) pthread_cond_wait(a,b)
202 # define lmgr_cond_timedwait(a,b,c) pthread_cond_timedwait(a,b,c)
203 # define bthread_mutex_t pthread_mutex_t
204 # define P(x) lmgr_p(&(x))
205 # define V(x) lmgr_v(&(x))
206 # define BTHREAD_MUTEX_PRIORITY(p) PTHREAD_MUTEX_INITIALIZER
207 # define BTHREAD_MUTEX_NO_PRIORITY PTHREAD_MUTEX_INITIALIZER
208 # define BTHREAD_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
209 #endif /* _USE_LOCKMGR */
211 #endif /* _LOCKMGR_H */