git.sur5r.net Git - bacula/bacula/blob - bacula/src/lib/lockmgr.h

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2008-2008 Free Software Foundation Europe e.V.
   5
   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.
  12
  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.
  17
  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
  21    02110-1301, USA.
  22
  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.
  27 */
  28
  29 #ifndef _LOCKMGR_H
  30 #define _LOCKMGR_H 1
  31
  32 /*
  33  * P and V op that don't use the lock manager (for memory allocation or on
  34  * win32)
  35  */
  36 void lmgr_p(pthread_mutex_t *m);
  37 void lmgr_v(pthread_mutex_t *m);
  38
  39 #ifdef _USE_LOCKMGR
  40
  41 typedef struct bthread_mutex_t
  42 {
  43    pthread_mutex_t mutex;
  44    int priority;
  45 } bthread_mutex_t;
  46
  47 /*
  48  * We decide that a thread won't lock more than LMGR_MAX_LOCK at the same time
  49  */
  50 #define LMGR_MAX_LOCK 32
  51
  52 int bthread_cond_wait_p(pthread_cond_t *cond,
  53                         bthread_mutex_t *mutex,
  54                         const char *file="*unknown*", int line=0);
  55
  56 int bthread_cond_timedwait_p(pthread_cond_t *cond,
  57                              bthread_mutex_t *mutex,
  58                              const struct timespec * abstime,
  59                              const char *file="*unknown*", int line=0);
  60
  61 /* Same with real pthread_mutex_t */
  62 int bthread_cond_wait_p(pthread_cond_t *cond,
  63                         pthread_mutex_t *mutex,
  64                         const char *file="*unknown*", int line=0);
  65
  66 int bthread_cond_timedwait_p(pthread_cond_t *cond,
  67                              pthread_mutex_t *mutex,
  68                              const struct timespec * abstime,
  69                              const char *file="*unknown*", int line=0);
  70
  71 /* Replacement of pthread_mutex_lock()  but with real pthread_mutex_t */
  72 int bthread_mutex_lock_p(pthread_mutex_t *m,
  73                          const char *file="*unknown*", int line=0);
  74
  75 /* Replacement for pthread_mutex_unlock() but with real pthread_mutex_t */
  76 int bthread_mutex_unlock_p(pthread_mutex_t *m,
  77                            const char *file="*unknown*", int line=0);
  78
  79 /* Replacement of pthread_mutex_lock() */
  80 int bthread_mutex_lock_p(bthread_mutex_t *m,
  81                          const char *file="*unknown*", int line=0);
  82
  83 /* Replacement of pthread_mutex_unlock() */
  84 int bthread_mutex_unlock_p(bthread_mutex_t *m,
  85                            const char *file="*unknown*", int line=0);
  86
  87 /*
  88  * Use them when you want use your lock yourself (ie rwlock)
  89  */
  90
  91 /* Call before requesting the lock */
  92 void lmgr_pre_lock(void *m, int prio=0,
  93                    const char *file="*unknown*", int line=0);
  94
  95 /* Call after getting it */
  96 void lmgr_post_lock();
  97
  98 /* Same as pre+post lock */
  99 void lmgr_do_lock(void *m, int prio=0,
 100                   const char *file="*unknown*", int line=0);
 101
 102 /* Call just before releasing the lock */
 103 void lmgr_do_unlock(void *m);
 104
 105 int bthread_mutex_init(bthread_mutex_t *m, const pthread_mutexattr_t *attr);
 106 int bthread_mutex_destroy(bthread_mutex_t *m);
 107 void bthread_mutex_set_priority(bthread_mutex_t *m, int prio);
 108
 109 /* init/destroy for real pthread_mutex_t object */
 110 int bthread_mutex_init(pthread_mutex_t *m, const pthread_mutexattr_t *attr);
 111 int bthread_mutex_destroy(pthread_mutex_t *m);
 112
 113 /*
 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
 116  */
 117 void lmgr_init_thread();
 118
 119 /*
 120  * Call this function at the end of the thread
 121  */
 122 void lmgr_cleanup_thread();
 123
 124 /*
 125  * Call this at the end of the program, it will release the
 126  * global lock manager
 127  */
 128 void lmgr_cleanup_main();
 129
 130 /*
 131  * Dump each lmgr_thread_t object to stdout
 132  */
 133 void lmgr_dump();
 134
 135 /*
 136  * Search a deadlock
 137  */
 138 bool lmgr_detect_deadlock();
 139
 140 /*
 141  * Search a deadlock after a fatal signal
 142  * no lock are granted, so the program must be
 143  * stopped.
 144  */
 145 bool lmgr_detect_deadlock_unlocked();
 146
 147 /*
 148  * This function will run your thread with lmgr_init_thread() and
 149  * lmgr_cleanup_thread().
 150  */
 151 int lmgr_thread_create(pthread_t *thread,
 152                        const pthread_attr_t *attr,
 153                        void *(*start_routine)(void*), void *arg);
 154
 155 /*
 156  * Define _LOCKMGR_COMPLIANT to use real pthread functions
 157  */
 158
 159 #define BTHREAD_MUTEX_NO_PRIORITY     {PTHREAD_MUTEX_INITIALIZER, 0}
 160 #define BTHREAD_MUTEX_PRIORITY_1      {PTHREAD_MUTEX_INITIALIZER, 1}
 161 #define BTHREAD_MUTEX_PRIORITY_2      {PTHREAD_MUTEX_INITIALIZER, 2}
 162 #define BTHREAD_MUTEX_PRIORITY_3      {PTHREAD_MUTEX_INITIALIZER, 3}
 163 #define BTHREAD_MUTEX_PRIORITY_4      {PTHREAD_MUTEX_INITIALIZER, 4}
 164 #define BTHREAD_MUTEX_INITIALIZER     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
 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__)
 169
 170 #ifdef _LOCKMGR_COMPLIANT
 171 # define P(x) lmgr_p(&(x))
 172 # define V(x) lmgr_v(&(x))
 173 #else
 174 # define P(x)                   bthread_mutex_lock_p(&(x), __FILE__, __LINE__)
 175 # define V(x)                   bthread_mutex_unlock_p(&(x), __FILE__, __LINE__)
 176 # define pthread_create(a, b, c, d)      lmgr_thread_create(a,b,c,d)
 177 # define pthread_mutex_lock(x)           bthread_mutex_lock(x)
 178 # define pthread_mutex_unlock(x)         bthread_mutex_unlock(x)
 179 # define pthread_cond_wait(x,y)          bthread_cond_wait(x,y)
 180 # define pthread_cond_timedwait(x,y,z)   bthread_cond_timedwait(x,y,z)
 181 # define pthread_mutex_init(x,y)         bthread_mutex_init(x,y)
 182 # define pthread_mutex_destroy(x)        bthread_mutex_destroy(x)
 183 #endif
 184
 185 #else   /* _USE_LOCKMGR */
 186
 187 # define lmgr_detect_deadloc()
 188 # define lmgr_dump()
 189 # define lmgr_init_thread()
 190 # define lmgr_cleanup_thread()
 191 # define lmgr_pre_lock(m, f, l)
 192 # define lmgr_post_lock()
 193 # define lmgr_do_lock(m, f, l)
 194 # define lmgr_do_unlock(m)
 195 # define lmgr_cleanup_main()
 196 # define bthread_mutex_set_priority(a)
 197 # define bthread_mutex_init(a,b)     pthread_mutex_init(a,b)
 198 # define bthread_mutex_destroy(a)    pthread_mutex_destroy(a)
 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_NO_PRIORITY  PTHREAD_MUTEX_INITIALIZER
 207 # define BTHREAD_MUTEX_PRIORITY_1   PTHREAD_MUTEX_INITIALIZER
 208 # define BTHREAD_MUTEX_PRIORITY_2   PTHREAD_MUTEX_INITIALIZER
 209 # define BTHREAD_MUTEX_PRIORITY_3   PTHREAD_MUTEX_INITIALIZER
 210 # define BTHREAD_MUTEX_PRIORITY_4   PTHREAD_MUTEX_INITIALIZER
 211 # define BTHREAD_MUTEX_INITIALIZER  PTHREAD_MUTEX_INITIALIZER
 212 #endif  /* _USE_LOCKMGR */
 213
 214 #endif  /* _LOCKMGR_H */