badvpn/misc/debugerror.h
2018-12-30 15:51:55 +01:00

93 lines
2.8 KiB
C

/**
* @file debugerror.h
* @author Ambroz Bizjak <ambrop7@gmail.com>
*
* @section LICENSE
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the author nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @section DESCRIPTION
*
* Mechanism for ensuring an object is destroyed from inside an error handler
* or its jobs.
*/
#ifndef BADVPN_MISC_DEBUGERROR_H
#define BADVPN_MISC_DEBUGERROR_H
#include <misc/debug.h>
#include <base/BPending.h>
#ifndef NDEBUG
#define DEBUGERROR(de, call) \
{ \
ASSERT(!BPending_IsSet(&(de)->job)) \
BPending_Set(&(de)->job); \
(call); \
}
#else
#define DEBUGERROR(de, call) { (call); }
#endif
typedef struct {
#ifndef NDEBUG
BPending job;
#else
int dummy_field; // struct must have at least one field
#endif
} DebugError;
static void DebugError_Init (DebugError *o, BPendingGroup *pg);
static void DebugError_Free (DebugError *o);
static void DebugError_AssertNoError (DebugError *o);
#ifndef NDEBUG
static void _DebugError_job_handler (DebugError *o)
{
ASSERT(0);
}
#endif
void DebugError_Init (DebugError *o, BPendingGroup *pg)
{
#ifndef NDEBUG
BPending_Init(&o->job, pg, (BPending_handler)_DebugError_job_handler, o);
#endif
}
void DebugError_Free (DebugError *o)
{
#ifndef NDEBUG
BPending_Free(&o->job);
#endif
}
void DebugError_AssertNoError (DebugError *o)
{
#ifndef NDEBUG
ASSERT(!BPending_IsSet(&o->job))
#endif
}
#endif