8e5bd87d620e56f6d13a2489611bd218cbe6686b
[people/xl0/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 dbg_autocolourise ( unsigned long id );
131 extern void dbg_decolourise ( void );
132 extern void dbg_hex_dump_da ( unsigned long dispaddr,
133                               const void *data, unsigned long len );
134
135 /* Compatibility with existing Makefile */
136 #if DEBUG_SYMBOL >= 1
137 #if DEBUG_SYMBOL >= 2
138 #define DBGLVL 3
139 #else
140 #define DBGLVL 1
141 #endif
142 #else
143 #define DBGLVL 0
144 #endif
145
146 #define DBGLVL_LOG      1
147 #define DBG_LOG         ( DBGLVL & DBGLVL_LOG )
148 #define DBGLVL_EXTRA    2
149 #define DBG_EXTRA       ( DBGLVL & DBGLVL_EXTRA )
150
151 /**
152  * Print debugging message if we are at a certain debug level
153  *
154  * @v level             Debug level
155  * @v ...               printf() argument list
156  */
157 #define DBG_IF( level, ... ) do {                               \
158                 if ( DBG_ ## level ) {                          \
159                         dbg_printf ( __VA_ARGS__ );             \
160                 }                                               \
161         } while ( 0 )
162
163 /**
164  * Print a hex dump if we are at a certain debug level
165  *
166  * @v level             Debug level
167  * @v dispaddr          Display address
168  * @v data              Data to print
169  * @v len               Length of data
170  */
171 #define DBG_HDA_IF( level, dispaddr, data, len )  do {          \
172                 if ( DBG_ ## level ) {                          \
173                         union {                                 \
174                                 unsigned long ul;               \
175                                 typeof ( dispaddr ) raw;        \
176                         } da;                                   \
177                         da.raw = dispaddr;                      \
178                         dbg_hex_dump_da ( da.ul, data, len );   \
179                 }                                               \
180         } while ( 0 )
181
182 /**
183  * Print a hex dump if we are at a certain debug level
184  *
185  * @v level             Debug level
186  * @v data              Data to print
187  * @v len               Length of data
188  */
189 #define DBG_HD_IF( level, data, len ) do {                      \
190                 DBG_HDA_IF ( level, data, data, len );          \
191         } while ( 0 )
192
193 /**
194  * Select colour for debug messages if we are at a certain debug level
195  *
196  * @v level             Debug level
197  * @v id                Message stream ID
198  */
199 #define DBG_AC_IF( level, id ) do {                             \
200                 if ( DBG_ ## level ) {                          \
201                         union {                                 \
202                                 unsigned long ul;               \
203                                 typeof ( id ) raw;              \
204                         } stream;                               \
205                         stream.raw = id;                        \
206                         dbg_autocolourise ( stream.ul );        \
207                 }                                               \
208         } while ( 0 )
209
210 /**
211  * Revert colour for debug messages if we are at a certain debug level
212  *
213  * @v level             Debug level
214  */
215 #define DBG_DC_IF( level ) do {                                 \
216                 if ( DBG_ ## level ) {                          \
217                         dbg_decolourise();                      \
218                 }                                               \
219         } while ( 0 )
220
221 /* Autocolourising versions of the DBGxxx_IF() macros */
222
223 #define DBGC_IF( level, id, ... ) do {                          \
224                 DBG_AC_IF ( level, id );                        \
225                 DBG_IF ( level, __VA_ARGS__ );                  \
226                 DBG_DC_IF ( level );                            \
227         } while ( 0 )
228
229 #define DBGC_HDA_IF( level, id, ... ) do {                      \
230                 DBG_AC_IF ( level, id );                        \
231                 DBG_HDA_IF ( level, __VA_ARGS__ );              \
232                 DBG_DC_IF ( level );                            \
233         } while ( 0 )
234
235 #define DBGC_HD_IF( level, id, ... ) do {                       \
236                 DBG_AC_IF ( level, id );                        \
237                 DBG_HD_IF ( level, __VA_ARGS__ );               \
238                 DBG_DC_IF ( level );                            \
239         } while ( 0 )
240
241 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( LOG, ... )*/
242
243 #define DBG( ... )      DBG_IF ( LOG, __VA_ARGS__ )
244 #define DBG_HDA( ... )  DBG_HDA_IF ( LOG, __VA_ARGS__ )
245 #define DBG_HD( ... )   DBG_HD_IF ( LOG, __VA_ARGS__ )
246 #define DBGC( ... )     DBGC_IF ( LOG, __VA_ARGS__ )
247 #define DBGC_HDA( ... ) DBGC_HDA_IF ( LOG, __VA_ARGS__ )
248 #define DBGC_HD( ... )  DBGC_HD_IF ( LOG, __VA_ARGS__ )
249
250 /* Backwards compatibility */
251 #define DBG2( ... )     DBG_IF ( EXTRA, __VA_ARGS__ )
252
253 #if DEBUG_SYMBOL == 0
254 #define NDEBUG
255 #endif
256
257 /** Declare a data structure as packed. */
258 #define PACKED __attribute__ (( packed ))
259
260 /** Declare a variable or data structure as unused. */
261 #define __unused __attribute__ (( unused ))
262
263 /**
264  * Declare a function as used.
265  *
266  * Necessary only if the function is called only from assembler code.
267  */
268 #define __used __attribute__ (( used ))
269
270 /** Declare a data structure to be aligned with 16-byte alignment */
271 #define __aligned __attribute__ (( aligned ( 16 ) ))
272
273 /**
274  * Shared data.
275  *
276  * To save space in the binary when multiple-driver images are
277  * compiled, uninitialised data areas can be shared between drivers.
278  * This will typically be used to share statically-allocated receive
279  * and transmit buffers between drivers.
280  *
281  * Use as e.g.
282  *
283  * @code
284  *
285  *   struct {
286  *      char    rx_buf[NUM_RX_BUF][RX_BUF_SIZE];
287  *      char    tx_buf[TX_BUF_SIZE];
288  *   } my_static_data __shared;
289  *
290  * @endcode
291  *
292  */
293 #define __shared __asm__ ( "_shared_bss" )
294
295 #endif /* ASSEMBLY */
296
297 #endif /* COMPILER_H */