226 lines
7.4 KiB
C
226 lines
7.4 KiB
C
/*
|
|
* Copyright (C) 1998-2001 Internet Software Consortium.
|
|
*
|
|
* Permission to use, copy, modify, and distribute this software for any
|
|
* purpose with or without fee is hereby granted, provided that the above
|
|
* copyright notice and this permission notice appear in all copies.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
|
|
* DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
|
|
* INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
|
|
* INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
|
|
* FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
|
|
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
|
|
* WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
|
|
/* $Id: util.h,v 1.23 2001/11/30 01:59:38 gson Exp $ */
|
|
|
|
#ifndef ISC_UTIL_H
|
|
#define ISC_UTIL_H 1
|
|
|
|
/*
|
|
* NOTE:
|
|
*
|
|
* This file is not to be included from any <isc/???.h> (or other) library
|
|
* files.
|
|
*
|
|
* Including this file puts several macros in your name space that are
|
|
* not protected (as all the other ISC functions/macros do) by prepending
|
|
* ISC_ or isc_ to the name.
|
|
*/
|
|
|
|
/***
|
|
*** General Macros.
|
|
***/
|
|
|
|
/*
|
|
* Use this to hide unused function arguments.
|
|
*
|
|
* int
|
|
* foo(char *bar)
|
|
* {
|
|
* UNUSED(bar);
|
|
* }
|
|
*/
|
|
#define UNUSED(x) (void)(x)
|
|
|
|
#define ISC_MAX(a, b) ((a) > (b) ? (a) : (b))
|
|
#define ISC_MIN(a, b) ((a) < (b) ? (a) : (b))
|
|
|
|
/*
|
|
* Use this to remove the const qualifier of a variable to assign it to
|
|
* a non-const variable or pass it as a non-const function argument ...
|
|
* but only when you are sure it won't then be changed!
|
|
* This is necessary to sometimes shut up some compilers
|
|
* (as with gcc -Wcast-qual) when there is just no other good way to avoid the
|
|
* situation.
|
|
*/
|
|
#define DE_CONST(konst, var) \
|
|
do { \
|
|
union { const void *k; void *v; } _u; \
|
|
_u.k = konst; \
|
|
var = _u.v; \
|
|
} while (0)
|
|
|
|
/*
|
|
* Use this in translation units that would otherwise be empty, to
|
|
* suppress compiler warnings.
|
|
*/
|
|
#define EMPTY_TRANSLATION_UNIT static void isc__empty(void) { isc__empty(); }
|
|
|
|
/*
|
|
* We use macros instead of calling the routines directly because
|
|
* the capital letters make the locking stand out.
|
|
*
|
|
* We RUNTIME_CHECK for success since in general there's no way
|
|
* for us to continue if they fail.
|
|
*/
|
|
|
|
#ifdef ISC_UTIL_TRACEON
|
|
#define ISC_UTIL_TRACE(a) a
|
|
#include <stdio.h> /* Required for fprintf/stderr when tracing. */
|
|
#include <isc/msgs.h> /* Required for isc_msgcat when tracing. */
|
|
#else
|
|
#define ISC_UTIL_TRACE(a)
|
|
#endif
|
|
|
|
#include <isc/result.h> /* Contractual promise. */
|
|
|
|
#define LOCK(lp) do { \
|
|
ISC_UTIL_TRACE(fprintf(stderr, "%s %p %s %d\n", \
|
|
isc_msgcat_get(isc_msgcat, ISC_MSGSET_UTIL, \
|
|
ISC_MSG_LOCKING, "LOCKING"), \
|
|
(lp), __FILE__, __LINE__)); \
|
|
RUNTIME_CHECK(isc_mutex_lock((lp)) == ISC_R_SUCCESS); \
|
|
ISC_UTIL_TRACE(fprintf(stderr, "%s %p %s %d\n", \
|
|
isc_msgcat_get(isc_msgcat, ISC_MSGSET_UTIL, \
|
|
ISC_MSG_LOCKED, "LOCKED"), \
|
|
(lp), __FILE__, __LINE__)); \
|
|
} while (0)
|
|
#define UNLOCK(lp) do { \
|
|
RUNTIME_CHECK(isc_mutex_unlock((lp)) == ISC_R_SUCCESS); \
|
|
ISC_UTIL_TRACE(fprintf(stderr, "%s %p %s %d\n", \
|
|
isc_msgcat_get(isc_msgcat, ISC_MSGSET_UTIL, \
|
|
ISC_MSG_UNLOCKED, "UNLOCKED"), \
|
|
(lp), __FILE__, __LINE__)); \
|
|
} while (0)
|
|
#define ISLOCKED(lp) (1)
|
|
#define DESTROYLOCK(lp) \
|
|
RUNTIME_CHECK(isc_mutex_destroy((lp)) == ISC_R_SUCCESS)
|
|
|
|
|
|
#define BROADCAST(cvp) do { \
|
|
ISC_UTIL_TRACE(fprintf(stderr, "%s %p %s %d\n", \
|
|
isc_msgcat_get(isc_msgcat, ISC_MSGSET_UTIL, \
|
|
ISC_MSG_BROADCAST, "BROADCAST"),\
|
|
(cvp), __FILE__, __LINE__)); \
|
|
RUNTIME_CHECK(isc_condition_broadcast((cvp)) == ISC_R_SUCCESS); \
|
|
} while (0)
|
|
#define SIGNAL(cvp) do { \
|
|
ISC_UTIL_TRACE(fprintf(stderr, "%s %p %s %d\n", \
|
|
isc_msgcat_get(isc_msgcat, ISC_MSGSET_UTIL, \
|
|
ISC_MSG_SIGNAL, "SIGNAL"), \
|
|
(cvp), __FILE__, __LINE__)); \
|
|
RUNTIME_CHECK(isc_condition_signal((cvp)) == ISC_R_SUCCESS); \
|
|
} while (0)
|
|
#define WAIT(cvp, lp) do { \
|
|
ISC_UTIL_TRACE(fprintf(stderr, "%s %p %s %p %s %d\n", \
|
|
isc_msgcat_get(isc_msgcat, ISC_MSGSET_UTIL, \
|
|
ISC_MSG_UTILWAIT, "WAIT"), \
|
|
(cvp), \
|
|
isc_msgcat_get(isc_msgcat, ISC_MSGSET_UTIL, \
|
|
ISC_MSG_LOCK, "LOCK"), \
|
|
(lp), __FILE__, __LINE__)); \
|
|
RUNTIME_CHECK(isc_condition_wait((cvp), (lp)) == ISC_R_SUCCESS); \
|
|
ISC_UTIL_TRACE(fprintf(stderr, "%s %p %s %p %s %d\n", \
|
|
isc_msgcat_get(isc_msgcat, ISC_MSGSET_UTIL, \
|
|
ISC_MSG_WAITED, "WAITED"), \
|
|
(cvp), \
|
|
isc_msgcat_get(isc_msgcat, ISC_MSGSET_UTIL, \
|
|
ISC_MSG_LOCKED, "LOCKED"), \
|
|
(lp), __FILE__, __LINE__)); \
|
|
} while (0)
|
|
|
|
/*
|
|
* isc_condition_waituntil can return ISC_R_TIMEDOUT, so we
|
|
* don't RUNTIME_CHECK the result.
|
|
*
|
|
* XXX Also, can't really debug this then...
|
|
*/
|
|
|
|
#define WAITUNTIL(cvp, lp, tp) \
|
|
isc_condition_waituntil((cvp), (lp), (tp))
|
|
|
|
#define RWLOCK(lp, t) do { \
|
|
ISC_UTIL_TRACE(fprintf(stderr, "%s %p, %d %s %d\n", \
|
|
isc_msgcat_get(isc_msgcat, ISC_MSGSET_UTIL, \
|
|
ISC_MSG_RWLOCK, "RWLOCK"), \
|
|
(lp), (t), __FILE__, __LINE__)); \
|
|
RUNTIME_CHECK(isc_rwlock_lock((lp), (t)) == ISC_R_SUCCESS); \
|
|
ISC_UTIL_TRACE(fprintf(stderr, "%s %p, %d %s %d\n", \
|
|
isc_msgcat_get(isc_msgcat, ISC_MSGSET_UTIL, \
|
|
ISC_MSG_RWLOCKED, "RWLOCKED"), \
|
|
(lp), (t), __FILE__, __LINE__)); \
|
|
} while (0)
|
|
#define RWUNLOCK(lp, t) do { \
|
|
ISC_UTIL_TRACE(fprintf(stderr, "%s %p, %d %s %d\n", \
|
|
isc_msgcat_get(isc_msgcat, ISC_MSGSET_UTIL, \
|
|
ISC_MSG_RWUNLOCK, "RWUNLOCK"), \
|
|
(lp), (t), __FILE__, __LINE__)); \
|
|
RUNTIME_CHECK(isc_rwlock_unlock((lp), (t)) == ISC_R_SUCCESS); \
|
|
} while (0)
|
|
|
|
#define DESTROYMUTEXBLOCK(bp, n) \
|
|
RUNTIME_CHECK(isc_mutexblock_destroy((bp), (n)) == ISC_R_SUCCESS)
|
|
|
|
/*
|
|
* List Macros.
|
|
*/
|
|
#include <isc/list.h> /* Contractual promise. */
|
|
|
|
#define LIST(type) ISC_LIST(type)
|
|
#define INIT_LIST(type) ISC_LIST_INIT(type)
|
|
#define LINK(type) ISC_LINK(type)
|
|
#define INIT_LINK(elt, link) ISC_LINK_INIT(elt, link)
|
|
#define HEAD(list) ISC_LIST_HEAD(list)
|
|
#define TAIL(list) ISC_LIST_TAIL(list)
|
|
#define EMPTY(list) ISC_LIST_EMPTY(list)
|
|
#define PREV(elt, link) ISC_LIST_PREV(elt, link)
|
|
#define NEXT(elt, link) ISC_LIST_NEXT(elt, link)
|
|
#define APPEND(list, elt, link) ISC_LIST_APPEND(list, elt, link)
|
|
#define PREPEND(list, elt, link) ISC_LIST_PREPEND(list, elt, link)
|
|
#define UNLINK(list, elt, link) ISC_LIST_UNLINK(list, elt, link)
|
|
#define ENQUEUE(list, elt, link) ISC_LIST_APPEND(list, elt, link)
|
|
#define DEQUEUE(list, elt, link) ISC_LIST_UNLINK(list, elt, link)
|
|
#define INSERTBEFORE(li, b, e, ln) ISC_LIST_INSERTBEFORE(li, b, e, ln)
|
|
#define INSERTAFTER(li, a, e, ln) ISC_LIST_INSERTAFTER(li, a, e, ln)
|
|
#define APPENDLIST(list1, list2, link) ISC_LIST_APPENDLIST(list1, list2, link)
|
|
|
|
/*
|
|
* Assertions
|
|
*/
|
|
#include <isc/assertions.h> /* Contractual promise. */
|
|
|
|
#define REQUIRE(e) ISC_REQUIRE(e)
|
|
#define ENSURE(e) ISC_ENSURE(e)
|
|
#define INSIST(e) ISC_INSIST(e)
|
|
#define INVARIANT(e) ISC_INVARIANT(e)
|
|
|
|
/*
|
|
* Errors
|
|
*/
|
|
#include <isc/error.h> /* Contractual promise. */
|
|
|
|
#define UNEXPECTED_ERROR isc_error_unexpected
|
|
#define FATAL_ERROR isc_error_fatal
|
|
#define RUNTIME_CHECK(cond) ISC_ERROR_RUNTIMECHECK(cond)
|
|
|
|
/*
|
|
* Time
|
|
*/
|
|
#define TIME_NOW(tp) RUNTIME_CHECK(isc_time_now((tp)) == ISC_R_SUCCESS)
|
|
|
|
#endif /* ISC_UTIL_H */
|