BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file debugerror.h
3 * @author Ambroz Bizjak <ambrop7@gmail.com>
4 *
5 * @section LICENSE
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of the author nor the
15 * names of its contributors may be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * @section DESCRIPTION
30 *
31 * Mechanism for ensuring an object is destroyed from inside an error handler
32 * or its jobs.
33 */
34  
35 #ifndef BADVPN_MISC_DEBUGERROR_H
36 #define BADVPN_MISC_DEBUGERROR_H
37  
38 #include <misc/debug.h>
39 #include <base/BPending.h>
40  
41 #ifndef NDEBUG
42 #define DEBUGERROR(de, call) \
43 { \
44 ASSERT(!BPending_IsSet(&(de)->job)) \
45 BPending_Set(&(de)->job); \
46 (call); \
47 }
48 #else
49 #define DEBUGERROR(de, call) { (call); }
50 #endif
51  
52 typedef struct {
53 #ifndef NDEBUG
54 BPending job;
55 #else
56 int dummy_field; // struct must have at least one field
57 #endif
58 } DebugError;
59  
60 static void DebugError_Init (DebugError *o, BPendingGroup *pg);
61 static void DebugError_Free (DebugError *o);
62 static void DebugError_AssertNoError (DebugError *o);
63  
64 #ifndef NDEBUG
65 static void _DebugError_job_handler (DebugError *o)
66 {
67 ASSERT(0);
68 }
69 #endif
70  
71 void DebugError_Init (DebugError *o, BPendingGroup *pg)
72 {
73 #ifndef NDEBUG
74 BPending_Init(&o->job, pg, (BPending_handler)_DebugError_job_handler, o);
75 #endif
76 }
77  
78 void DebugError_Free (DebugError *o)
79 {
80 #ifndef NDEBUG
81 BPending_Free(&o->job);
82 #endif
83 }
84  
85 void DebugError_AssertNoError (DebugError *o)
86 {
87 #ifndef NDEBUG
88 ASSERT(!BPending_IsSet(&o->job))
89 #endif
90 }
91  
92 #endif