130 lines
4.1 KiB
C
130 lines
4.1 KiB
C
/*
|
|
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, you can obtain one at https://mozilla.org/MPL/2.0/.
|
|
*
|
|
* See the COPYRIGHT file distributed with this work for additional
|
|
* information regarding copyright ownership.
|
|
*/
|
|
|
|
#ifndef ISC_MUTEX_H
|
|
#define ISC_MUTEX_H 1
|
|
|
|
/*! \file */
|
|
|
|
#include <pthread.h>
|
|
#include <stdio.h>
|
|
|
|
#include <isc/lang.h>
|
|
#include <isc/result.h> /* for ISC_R_ codes */
|
|
|
|
ISC_LANG_BEGINDECLS
|
|
|
|
#define ISC_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
|
|
|
|
/*!
|
|
* Supply mutex attributes that enable deadlock detection
|
|
* (helpful when debugging). This is system dependent and
|
|
* currently only supported on NetBSD.
|
|
*/
|
|
#if ISC_MUTEX_DEBUG && defined(__NetBSD__) && defined(PTHREAD_MUTEX_ERRORCHECK)
|
|
extern pthread_mutexattr_t isc__mutex_attrs;
|
|
#define ISC__MUTEX_ATTRS &isc__mutex_attrs
|
|
#else /* if ISC_MUTEX_DEBUG && defined(__NetBSD__) && \
|
|
* defined(PTHREAD_MUTEX_ERRORCHECK) */
|
|
#define ISC__MUTEX_ATTRS NULL
|
|
#endif /* if ISC_MUTEX_DEBUG && defined(__NetBSD__) && \
|
|
* defined(PTHREAD_MUTEX_ERRORCHECK) */
|
|
|
|
/* XXX We could do fancier error handling... */
|
|
|
|
/*!
|
|
* Define ISC_MUTEX_PROFILE to turn on profiling of mutexes by line. When
|
|
* enabled, isc_mutex_stats() can be used to print a table showing the
|
|
* number of times each type of mutex was locked and the amount of time
|
|
* waiting to obtain the lock.
|
|
*/
|
|
#ifndef ISC_MUTEX_PROFILE
|
|
#define ISC_MUTEX_PROFILE 0
|
|
#endif /* ifndef ISC_MUTEX_PROFILE */
|
|
|
|
#if ISC_MUTEX_PROFILE
|
|
typedef struct isc_mutexstats isc_mutexstats_t;
|
|
|
|
typedef struct {
|
|
pthread_mutex_t mutex; /*%< The actual mutex. */
|
|
isc_mutexstats_t *stats; /*%< Mutex statistics. */
|
|
} isc_mutex_t;
|
|
#else /* if ISC_MUTEX_PROFILE */
|
|
typedef pthread_mutex_t isc_mutex_t;
|
|
#endif /* if ISC_MUTEX_PROFILE */
|
|
|
|
#if ISC_MUTEX_PROFILE
|
|
#define isc_mutex_init(mp) isc_mutex_init_profile((mp), __FILE__, __LINE__)
|
|
#else /* if ISC_MUTEX_PROFILE */
|
|
#if ISC_MUTEX_DEBUG && defined(PTHREAD_MUTEX_ERRORCHECK)
|
|
#define isc_mutex_init(mp) isc_mutex_init_errcheck((mp))
|
|
#else /* if ISC_MUTEX_DEBUG && defined(PTHREAD_MUTEX_ERRORCHECK) */
|
|
#define isc_mutex_init(mp) isc__mutex_init((mp), __FILE__, __LINE__)
|
|
void
|
|
isc__mutex_init(isc_mutex_t *mp, const char *file, unsigned int line);
|
|
#endif /* if ISC_MUTEX_DEBUG && defined(PTHREAD_MUTEX_ERRORCHECK) */
|
|
#endif /* if ISC_MUTEX_PROFILE */
|
|
|
|
#if ISC_MUTEX_PROFILE
|
|
#define isc_mutex_lock(mp) isc_mutex_lock_profile((mp), __FILE__, __LINE__)
|
|
#else /* if ISC_MUTEX_PROFILE */
|
|
#define isc_mutex_lock(mp) \
|
|
((pthread_mutex_lock((mp)) == 0) ? ISC_R_SUCCESS : ISC_R_UNEXPECTED)
|
|
#endif /* if ISC_MUTEX_PROFILE */
|
|
|
|
#if ISC_MUTEX_PROFILE
|
|
#define isc_mutex_unlock(mp) isc_mutex_unlock_profile((mp), __FILE__, __LINE__)
|
|
#else /* if ISC_MUTEX_PROFILE */
|
|
#define isc_mutex_unlock(mp) \
|
|
((pthread_mutex_unlock((mp)) == 0) ? ISC_R_SUCCESS : ISC_R_UNEXPECTED)
|
|
#endif /* if ISC_MUTEX_PROFILE */
|
|
|
|
#if ISC_MUTEX_PROFILE
|
|
#define isc_mutex_trylock(mp) \
|
|
((pthread_mutex_trylock((&(mp)->mutex)) == 0) ? ISC_R_SUCCESS \
|
|
: ISC_R_LOCKBUSY)
|
|
#else /* if ISC_MUTEX_PROFILE */
|
|
#define isc_mutex_trylock(mp) \
|
|
((pthread_mutex_trylock((mp)) == 0) ? ISC_R_SUCCESS : ISC_R_LOCKBUSY)
|
|
#endif /* if ISC_MUTEX_PROFILE */
|
|
|
|
#if ISC_MUTEX_PROFILE
|
|
#define isc_mutex_destroy(mp) \
|
|
RUNTIME_CHECK(pthread_mutex_destroy((&(mp)->mutex)) == 0)
|
|
#else /* if ISC_MUTEX_PROFILE */
|
|
#define isc_mutex_destroy(mp) RUNTIME_CHECK(pthread_mutex_destroy((mp)) == 0)
|
|
#endif /* if ISC_MUTEX_PROFILE */
|
|
|
|
#if ISC_MUTEX_PROFILE
|
|
#define isc_mutex_stats(fp) isc_mutex_statsprofile(fp);
|
|
#else /* if ISC_MUTEX_PROFILE */
|
|
#define isc_mutex_stats(fp)
|
|
#endif /* if ISC_MUTEX_PROFILE */
|
|
|
|
#if ISC_MUTEX_PROFILE
|
|
|
|
void
|
|
isc_mutex_init_profile(isc_mutex_t *mp, const char *_file, int _line);
|
|
isc_result_t
|
|
isc_mutex_lock_profile(isc_mutex_t *mp, const char *_file, int _line);
|
|
isc_result_t
|
|
isc_mutex_unlock_profile(isc_mutex_t *mp, const char *_file, int _line);
|
|
|
|
void
|
|
isc_mutex_statsprofile(FILE *fp);
|
|
#endif /* ISC_MUTEX_PROFILE */
|
|
|
|
void
|
|
isc_mutex_init_errcheck(isc_mutex_t *mp);
|
|
|
|
ISC_LANG_ENDDECLS
|
|
#endif /* ISC_MUTEX_H */
|