xref: /minix3/minix/lib/libvassert/vassert.h (revision 433d6423c39e34ec4b79c950597bb2d236f886be)
1 #ifndef _VASSERT_H_
2 #define _VASSERT_H_
3 
4 #ifdef __cplusplus
5 extern "C"
6 {
7 #endif /*__cplusplus*/
8 
9 #define ALIGNED(n) __attribute__((__aligned__(n)))
10 #define VASSERT_TRIGGER_OFFSET 1221
11 #define VASSERT_PAGE_SIZE      4096
12 
13 /* Need to align at 4K. */
14 /* Ensure the inReplay flag is on its own page. */
15 #pragma pack(1)
16 typedef struct VAssert_StateWrapper {
17    char space1[VASSERT_TRIGGER_OFFSET];
18    volatile char inReplay;
19    char space[VASSERT_PAGE_SIZE - VASSERT_TRIGGER_OFFSET - sizeof(char)];
20 } VAssert_StateWrapper;
21 #pragma pack()
22 
23 extern VAssert_StateWrapper vassert_state;
24 
25 /*
26  * User-selectable standard functions.
27  * XXX: Document these, in coordination with the SDK docs.
28  */
29 
30 #if defined(__KERNEL__)
31 #  define KERNEL_VASSERT
32 #endif
33 
34 #ifdef KERNEL_VASSERT
35 
36 #  ifndef VASSERT_CUSTOM_ASSERT
37 #     define VASSERT_CUSTOM_ASSERT(expr)
38 #  endif
39 
40 #  ifndef VASSERT_CUSTOM_ABORT
41 #     include <linux/kernel.h>
42 #     define VASSERT_CUSTOM_ABORT() ((void)0) // printk(KERN_ALERT"VAssert abort at %s: %d", __FILE__, __LINE__)
43 #  endif
44 
45 #  ifndef VASSERT_CUSTOM_LOG
46 #     include <linux/kernel.h>
47 #     define VASSERT_CUSTOM_LOG printk
48 #  endif
49 
50 #else
51 #  ifndef VASSERT_CUSTOM_ASSERT
52 #     include <assert.h>
53 #     define VASSERT_CUSTOM_ASSERT assert
54 #  endif
55 
56 #  ifndef VASSERT_CUSTOM_ABORT
57 #     include <stdlib.h>
58 #     define VASSERT_CUSTOM_ABORT abort
59 #  endif
60 
61 #  ifndef VASSERT_CUSTOM_LOG
62 #     include <stdio.h>
63 #     define VASSERT_CUSTOM_LOG printf
64 #  endif
65 #endif
66 
67 /* Results: 0 if successful, -1 if not. */
68 // XXX need to automatic de-register trigger page when the program quits
69 extern char VAssert_Init(void);
70 extern char VAssert_Uninit(void);
71 
72 /*
73  * These functions should not be called directly; they need to be wrapped.
74  */
75 extern void VAssert_LogMain(const char *format, ...);
76 extern void VAssert_GoLiveMain(void);
77 extern void VAssert_ReturnToReplayMain(void);
78 extern char VAssert_Trace(size_t max_size);
79 
80 #ifdef VASSERT_ALWAYS_EXECUTE
81 
82 #define VAssert_Assert(expr)              \
83 do {                                      \
84    VASSERT_CUSTOM_ASSERT(expr);           \
85 } while (0)
86 
87 #define VAssert_Log(args)                 \
88 do {                                      \
89    VASSERT_CUSTOM_LOG args;               \
90 } while (0)
91 
92 #define VAssert_BeginBlock
93 #define VAssert_EndBlock
94 
95 #else /* VASSERT_ALWAYS_EXECUTE */
96 
97 #define VAssert_Assert(expr)              \
98 do {                                      \
99    if (vassert_state.inReplay) {          \
100       if (!(expr)) {                      \
101          VAssert_GoLiveMain();            \
102          VASSERT_CUSTOM_ABORT();          \
103       } else {                            \
104          VAssert_ReturnToReplayMain();    \
105       }                                   \
106    }                                      \
107 } while (0)
108 
109 #define VAssert_Log(args)                 \
110 do {                                      \
111    if (vassert_state.inReplay) {          \
112       VAssert_LogMain args;               \
113       VAssert_ReturnToReplayMain();       \
114    }                                      \
115 } while (0)
116 
117 #define VAssert_BeginBlock if (vassert_state.inReplay)
118 #define VAssert_EndBlock VAssert_ReturnToReplayMain()
119 
120 #endif /* VASSERT_ALWAYS_EXECUTE */
121 
122 /*
123  * Record/Replay functionality
124  */
125 /*
126  * Results: True if successful, false if not.
127  * Input: True to start recording, false to stop.
128  */
129 extern char VAssert_SetRecordingMain(char start);
130 
131 #define VAssert_StartRecording() VAssert_SetRecordingMain(1)
132 #define VAssert_StopRecording() VAssert_SetRecordingMain(0)
133 
134 #ifdef __cplusplus
135 }
136 #endif /*__cplusplus*/
137 
138 #endif /*_VASSERT_H_*/
139