Force syntax-checking on assertions even in non-asserting builds.
[people/xl0/gpxe.git] / src / include / assert.h
1 #ifndef _ASSERT_H
2 #define _ASSERT_H
3
4 /** @file
5  *
6  * Assertions
7  *
8  * This file provides two assertion macros: assert() (for run-time
9  * assertions) and linker_assert() (for link-time assertions).
10  *
11  */
12
13 #ifdef NDEBUG
14 #define ASSERTING 0
15 #else
16 #define ASSERTING 1
17 #endif
18
19 /** printf() for assertions
20  *
21  * This function exists so that the assert() macro can expand to
22  * printf() calls without dragging the printf() prototype into scope.
23  *
24  * As far as the compiler is concerned, assert_printf() and printf() are
25  * completely unrelated calls; it's only at the assembly stage that
26  * references to the assert_printf symbol are collapsed into references
27  * to the printf symbol.
28  */
29 extern int __attribute__ (( format ( printf, 1, 2 ) )) 
30 assert_printf ( const char *fmt, ... ) asm ( "printf" );
31
32 /**
33  * Assert a condition at run-time.
34  *
35  * If the condition is not true, a debug message will be printed.
36  * Assertions only take effect in debug-enabled builds (see DBG()).
37  *
38  * @todo Make an assertion failure abort the program
39  *
40  */
41 #define assert( condition )                                                \
42         do {                                                               \
43                 if ( ASSERTING && ! (condition) ) {                        \
44                         assert_printf ( "assert(%s) failed at %s line "    \
45                                         "%d [%s]\n", #condition, __FILE__, \
46                                         __LINE__, __FUNCTION__ );          \
47                 }                                                          \
48         } while ( 0 )
49
50 /**
51  * Assert a condition at link-time.
52  *
53  * If the condition is not true, the link will fail with an unresolved
54  * symbol (error_symbol).
55  *
56  * This macro is gPXE-specific.  Do not use this macro in code
57  * intended to be portable.
58  *
59  */
60 #define linker_assert( condition, error_symbol )        \
61         if ( ! (condition) ) {                          \
62                 extern void error_symbol ( void );      \
63                 error_symbol();                         \
64         }
65
66 #endif /* _ASSERT_H */