2 * Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1998-2002 Internet Software Consortium.
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.
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.
18 /* $Id: mutex.h,v 1.23.26.3 2004/03/08 09:04:55 marka Exp $ */
26 #include <isc/result.h> /* for ISC_R_ codes */
29 * Supply mutex attributes that enable deadlock detection
30 * (helpful when debugging). This is system dependent and
31 * currently only supported on NetBSD.
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
37 #define ISC__MUTEX_ATTRS NULL
40 /* XXX We could do fancier error handling... */
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.
48 #ifndef ISC_MUTEX_PROFILE
49 #define ISC_MUTEX_PROFILE 0
53 typedef struct isc_mutexstats isc_mutexstats_t;
56 pthread_mutex_t mutex; /* The actual mutex. */
57 isc_mutexstats_t * stats; /* Mutex statistics. */
60 typedef pthread_mutex_t isc_mutex_t;
65 #define isc_mutex_init(mp) \
66 isc_mutex_init_profile((mp), __FILE__, __LINE__)
68 #if ISC_MUTEX_DEBUG && defined(PTHREAD_MUTEX_ERRORCHECK)
69 #define isc_mutex_init(mp) \
70 isc_mutex_init_errcheck((mp))
72 #define isc_mutex_init(mp) \
73 ((pthread_mutex_init((mp), ISC__MUTEX_ATTRS) == 0) ? \
74 ISC_R_SUCCESS : ISC_R_UNEXPECTED)
79 #define isc_mutex_lock(mp) \
80 isc_mutex_lock_profile((mp), __FILE__, __LINE__)
82 #define isc_mutex_lock(mp) \
83 ((pthread_mutex_lock((mp)) == 0) ? \
84 ISC_R_SUCCESS : ISC_R_UNEXPECTED)
88 #define isc_mutex_unlock(mp) \
89 isc_mutex_unlock_profile((mp), __FILE__, __LINE__)
91 #define isc_mutex_unlock(mp) \
92 ((pthread_mutex_unlock((mp)) == 0) ? \
93 ISC_R_SUCCESS : ISC_R_UNEXPECTED)
97 #define isc_mutex_trylock(mp) \
98 ((pthread_mutex_trylock((&(mp)->mutex)) == 0) ? \
99 ISC_R_SUCCESS : ISC_R_LOCKBUSY)
101 #define isc_mutex_trylock(mp) \
102 ((pthread_mutex_trylock((mp)) == 0) ? \
103 ISC_R_SUCCESS : ISC_R_LOCKBUSY)
106 #if ISC_MUTEX_PROFILE
107 #define isc_mutex_destroy(mp) \
108 ((pthread_mutex_destroy((&(mp)->mutex)) == 0) ? \
109 ISC_R_SUCCESS : ISC_R_UNEXPECTED)
111 #define isc_mutex_destroy(mp) \
112 ((pthread_mutex_destroy((mp)) == 0) ? \
113 ISC_R_SUCCESS : ISC_R_UNEXPECTED)
116 #if ISC_MUTEX_PROFILE
117 #define isc_mutex_stats(fp) isc_mutex_statsprofile(fp);
119 #define isc_mutex_stats(fp)
122 #if ISC_MUTEX_PROFILE
125 isc_mutex_init_profile(isc_mutex_t *mp, const char * _file, int _line);
127 isc_mutex_lock_profile(isc_mutex_t *mp, const char * _file, int _line);
129 isc_mutex_unlock_profile(isc_mutex_t *mp, const char * _file, int _line);
132 isc_mutex_statsprofile(FILE *fp);
135 isc_mutex_init_errcheck(isc_mutex_t *mp);
137 #endif /* ISC_MUTEX_PROFILE */
139 #endif /* ISC_MUTEX_H */