Added auto-colourising DBGC() macro
[gpxe.git] / src / include / compiler.h
1 #ifndef COMPILER_H
2 #define COMPILER_H
3
4 /*
5  * Doxygen can't cope with some of the more esoteric areas of C, so we
6  * make its life simpler.
7  *
8  */
9 #ifdef DOXYGEN
10 #define __attribute__(x)
11 #endif
12
13 /** @file
14  *
15  * Global compiler definitions.
16  *
17  * This file is implicitly included by every @c .c file in Etherboot.
18  * It defines global macros such as DBG().
19  *
20  * We arrange for each object to export the symbol @c obj_OBJECT
21  * (where @c OBJECT is the object name, e.g. @c rtl8139) as a global
22  * symbol, so that the linker can drag in selected object files from
23  * the library using <tt> -u obj_OBJECT </tt>.
24  *
25  */
26
27 /* Not quite sure why cpp requires two levels of macro call in order
28  * to actually expand OBJECT...
29  */
30 #undef _H1
31 #define _H1( x, y ) x ## y
32 #undef _H2
33 #define _H2( x, y ) _H1 ( x, y )
34 #define PREFIX_OBJECT(prefix) _H2 ( prefix, OBJECT )
35 #define OBJECT_SYMBOL PREFIX_OBJECT(obj_)
36 #undef _STR
37 #define _STR(s) #s
38 #undef _XSTR
39 #define _XSTR(s) _STR(s)
40 #define OBJECT_SYMBOL_STR _XSTR ( OBJECT_SYMBOL )
41
42 #ifdef ASSEMBLY
43
44         .globl  OBJECT_SYMBOL
45         .equ    OBJECT_SYMBOL, 0
46
47 #else /* ASSEMBLY */
48
49 __asm__ ( ".globl\t" OBJECT_SYMBOL_STR );
50 __asm__ ( ".equ\t" OBJECT_SYMBOL_STR ", 0" );
51
52 /**
53  * Drag in an object by object name.
54  *
55  * Macro to allow objects to explicitly drag in other objects by
56  * object name.  Used by config.c.
57  *
58  */
59 #define REQUIRE_OBJECT(object) \
60         __asm__ ( ".equ\tneed_" #object ", obj_" #object );
61
62 /** @def DBG
63  *
64  * Print a debugging message.
65  *
66  * The debug level is set at build time by specifying the @c DEBUG=
67  * parameter on the @c make command line.  For example, to enable
68  * debugging for the PCI bus functions (in pci.c) in a @c .dsk image
69  * for the @c rtl8139 card, you could use the command line
70  *
71  * @code
72  *
73  *   make bin/rtl8139.dsk DEBUG=pci
74  *
75  * @endcode
76  *
77  * This will enable the debugging statements (DBG()) in pci.c.  If
78  * debugging is not enabled, DBG() statements will be ignored.
79  *
80  * You can enable debugging in several objects simultaneously by
81  * separating them with commas, as in
82  *
83  * @code
84  *
85  *   make bin/rtl8139.dsk DEBUG=pci,buffer,heap
86  *
87  * @endcode
88  *
89  * You can increase the debugging level for an object by specifying it
90  * with @c :N, where @c N is the level, as in
91  *
92  * @code
93  *
94  *   make bin/rtl8139.dsk DEBUG=pci,buffer:2,heap
95  *
96  * @endcode
97  *
98  * which would enable debugging for the PCI, buffer-handling and
99  * heap-allocation code, with the buffer-handling code at level 2.
100  *
101  */
102
103 /*
104  * If debug_OBJECT is set to a true value, the macro DBG(...) will
105  * expand to printf(...) when compiling OBJECT, and the symbol
106  * DEBUG_LEVEL will be inserted into the object file.
107  *
108  */
109 #define DEBUG_SYMBOL PREFIX_OBJECT(debug_)
110
111 #if DEBUG_SYMBOL
112 #include "console.h"
113 #define DEBUG_SYMBOL_STR _XSTR ( DEBUG_SYMBOL )
114 __asm__ ( ".equ\tDBGLVL, " DEBUG_SYMBOL_STR );
115 #endif
116
117 /** printf() for debugging
118  *
119  * This function exists so that the DBG() macros can expand to
120  * printf() calls without dragging the printf() prototype into scope.
121  *
122  * As far as the compiler is concerned, dbg_printf() and printf() are
123  * completely unrelated calls; it's only at the assembly stage that
124  * references to the dbg_printf symbol are collapsed into references
125  * to the printf symbol.
126  */
127 extern int __attribute__ (( format ( printf, 1, 2 ) )) 
128 dbg_printf ( const char *fmt, ... ) asm ( "printf" );
129
130 extern void __attribute__ (( format ( printf, 2, 3 ) )) 
131 dbg_printf_autocolour ( void *id, const char *fmt, ... );
132
133 /* Compatibility with existing Makefile */
134 #if DEBUG_SYMBOL >= 1
135 #if DEBUG_SYMBOL >= 2
136 #define DBGLVL 3
137 #else
138 #define DBGLVL 1
139 #endif
140 #else
141 #define DBGLVL 0
142 #endif
143
144 #define DBGLVL_LOG      1
145 #define DBG_LOG         ( DBGLVL & DBGLVL_LOG )
146 #define DBGLVL_EXTRA    2
147 #define DBG_EXTRA       ( DBGLVL & DBGLVL_EXTRA )
148
149 #define DBG_IF( level, ... ) do {                               \
150                 if ( DBG_ ## level ) {                          \
151                         dbg_printf ( __VA_ARGS__ );             \
152                 }                                               \
153         } while ( 0 )
154
155 #define DBGC_IF( level, ... ) do {                              \
156                 if ( DBG_ ## level ) {                          \
157                         dbg_printf_autocolour ( __VA_ARGS__ );  \
158                 }                                               \
159         } while ( 0 )
160
161 #define DBG( ... )      DBG_IF ( LOG, __VA_ARGS__ )
162 #define DBG2( ... )     DBG_IF ( EXTRA, __VA_ARGS__ )
163 #define DBGC( ... )     DBGC_IF ( LOG, __VA_ARGS__ )
164
165 #if DEBUG_SYMBOL == 0
166 #define NDEBUG
167 #endif
168
169 /** Declare a data structure as packed. */
170 #define PACKED __attribute__ (( packed ))
171
172 /** Declare a variable or data structure as unused. */
173 #define __unused __attribute__ (( unused ))
174
175 /**
176  * Declare a function as used.
177  *
178  * Necessary only if the function is called only from assembler code.
179  */
180 #define __used __attribute__ (( used ))
181
182 /** Declare a data structure to be aligned with 16-byte alignment */
183 #define __aligned __attribute__ (( aligned ( 16 ) ))
184
185 /**
186  * Shared data.
187  *
188  * To save space in the binary when multiple-driver images are
189  * compiled, uninitialised data areas can be shared between drivers.
190  * This will typically be used to share statically-allocated receive
191  * and transmit buffers between drivers.
192  *
193  * Use as e.g.
194  *
195  * @code
196  *
197  *   struct {
198  *      char    rx_buf[NUM_RX_BUF][RX_BUF_SIZE];
199  *      char    tx_buf[TX_BUF_SIZE];
200  *   } my_static_data __shared;
201  *
202  * @endcode
203  *
204  */
205 #define __shared __asm__ ( "_shared_bss" )
206
207 #endif /* ASSEMBLY */
208
209 #endif /* COMPILER_H */