contrib/bind-9.2.4rc7/lib/isc/pthreads/include/isc/mutex.h

   1 /*
   2  * Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1998-2001  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  * PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* $Id: mutex.h,v 1.23.2.1 2004/03/09 06:12:08 marka Exp $ */
  19
  20 #ifndef ISC_MUTEX_H
  21 #define ISC_MUTEX_H 1
  22
  23 #include <pthread.h>
  24 #include <stdio.h>
  25
  26 #include <isc/result.h>         /* for ISC_R_ codes */
  27
  28 /*
  29  * Supply mutex attributes that enable deadlock detection
  30  * (helpful when debugging).  This is system dependent and
  31  * currently only supported on NetBSD.
  32  */
  33 #if ISC_MUTEX_DEBUG && defined(__NetBSD__) && defined(PTHREAD_MUTEX_ERRORCHECK)
  34 extern pthread_mutexattr_t isc__mutex_attrs;
  35 #define ISC__MUTEX_ATTRS &isc__mutex_attrs
  36 #else
  37 #define ISC__MUTEX_ATTRS NULL
  38 #endif
  39
  40 /* XXX We could do fancier error handling... */
  41
  42 /*
  43  * Define ISC_MUTEX_PROFILE to turn on profiling of mutexes by line.  When
  44  * enabled, isc_mutex_stats() can be used to print a table showing the
  45  * number of times each type of mutex was locked and the amount of time
  46  * waiting to obtain the lock.
  47  */
  48 #ifndef ISC_MUTEX_PROFILE
  49 #define ISC_MUTEX_PROFILE 0
  50 #endif
  51
  52 #if ISC_MUTEX_PROFILE
  53 typedef struct isc_mutexstats isc_mutexstats_t;
  54
  55 typedef struct {
  56         pthread_mutex_t         mutex;  /* The actual mutex. */
  57         isc_mutexstats_t *      stats;  /* Mutex statistics. */
  58 } isc_mutex_t;
  59 #else
  60 typedef pthread_mutex_t isc_mutex_t;
  61 #endif
  62
  63
  64 #if ISC_MUTEX_PROFILE
  65 #define isc_mutex_init(mp) \
  66         isc_mutex_init_profile((mp), __FILE__, __LINE__)
  67 #else
  68 #define isc_mutex_init(mp) \
  69         ((pthread_mutex_init((mp), ISC__MUTEX_ATTRS) == 0) ? \
  70          ISC_R_SUCCESS : ISC_R_UNEXPECTED)
  71 #endif
  72
  73 #if ISC_MUTEX_PROFILE
  74 #define isc_mutex_lock(mp) \
  75         isc_mutex_lock_profile((mp), __FILE__, __LINE__)
  76 #else
  77 #define isc_mutex_lock(mp) \
  78         ((pthread_mutex_lock((mp)) == 0) ? \
  79          ISC_R_SUCCESS : ISC_R_UNEXPECTED)
  80 #endif
  81
  82 #if ISC_MUTEX_PROFILE
  83 #define isc_mutex_unlock(mp) \
  84         isc_mutex_unlock_profile((mp), __FILE__, __LINE__)
  85 #else
  86 #define isc_mutex_unlock(mp) \
  87         ((pthread_mutex_unlock((mp)) == 0) ? \
  88          ISC_R_SUCCESS : ISC_R_UNEXPECTED)
  89 #endif
  90
  91 #if ISC_MUTEX_PROFILE
  92 #define isc_mutex_trylock(mp) \
  93         ((pthread_mutex_trylock((&(mp)->mutex)) == 0) ? \
  94          ISC_R_SUCCESS : ISC_R_LOCKBUSY)
  95 #else
  96 #define isc_mutex_trylock(mp) \
  97         ((pthread_mutex_trylock((mp)) == 0) ? \
  98          ISC_R_SUCCESS : ISC_R_LOCKBUSY)
  99 #endif
 100
 101 #if ISC_MUTEX_PROFILE
 102 #define isc_mutex_destroy(mp) \
 103         ((pthread_mutex_destroy((&(mp)->mutex)) == 0) ? \
 104          ISC_R_SUCCESS : ISC_R_UNEXPECTED)
 105 #else
 106 #define isc_mutex_destroy(mp) \
 107         ((pthread_mutex_destroy((mp)) == 0) ? \
 108          ISC_R_SUCCESS : ISC_R_UNEXPECTED)
 109 #endif
 110
 111 #if ISC_MUTEX_PROFILE
 112 #define isc_mutex_stats(fp) isc_mutex_statsprofile(fp);
 113 #else
 114 #define isc_mutex_stats(fp)
 115 #endif
 116
 117 #if ISC_MUTEX_PROFILE
 118
 119 isc_result_t
 120 isc_mutex_init_profile(isc_mutex_t *mp, const char * _file, int _line);
 121 isc_result_t
 122 isc_mutex_lock_profile(isc_mutex_t *mp, const char * _file, int _line);
 123 isc_result_t
 124 isc_mutex_unlock_profile(isc_mutex_t *mp, const char * _file, int _line);
 125
 126 void
 127 isc_mutex_statsprofile(FILE *fp);
 128
 129 #endif /* ISC_MUTEX_PROFILE */
 130
 131 #endif /* ISC_MUTEX_H */