7b5a58d6231b881a453fab2f3ab1219dc9b1ff8c
[people/lynusvaz/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 /* Force visibility of all symbols to "hidden", i.e. inform gcc that
63  * all symbol references resolve strictly within our final binary.
64  * This avoids unnecessary PLT/GOT entries on x86_64.
65  *
66  * This is a stronger claim than specifying "-fvisibility=hidden",
67  * since it also affects symbols marked with "extern".
68  */
69 #pragma GCC visibility push(hidden)
70
71 /** @def DBG
72  *
73  * Print a debugging message.
74  *
75  * The debug level is set at build time by specifying the @c DEBUG=
76  * parameter on the @c make command line.  For example, to enable
77  * debugging for the PCI bus functions (in pci.c) in a @c .dsk image
78  * for the @c rtl8139 card, you could use the command line
79  *
80  * @code
81  *
82  *   make bin/rtl8139.dsk DEBUG=pci
83  *
84  * @endcode
85  *
86  * This will enable the debugging statements (DBG()) in pci.c.  If
87  * debugging is not enabled, DBG() statements will be ignored.
88  *
89  * You can enable debugging in several objects simultaneously by
90  * separating them with commas, as in
91  *
92  * @code
93  *
94  *   make bin/rtl8139.dsk DEBUG=pci,buffer,heap
95  *
96  * @endcode
97  *
98  * You can increase the debugging level for an object by specifying it
99  * with @c :N, where @c N is the level, as in
100  *
101  * @code
102  *
103  *   make bin/rtl8139.dsk DEBUG=pci,buffer:2,heap
104  *
105  * @endcode
106  *
107  * which would enable debugging for the PCI, buffer-handling and
108  * heap-allocation code, with the buffer-handling code at level 2.
109  *
110  */
111
112 /*
113  * If debug_OBJECT is set to a true value, the macro DBG(...) will
114  * expand to printf(...) when compiling OBJECT, and the symbol
115  * DEBUG_LEVEL will be inserted into the object file.
116  *
117  */
118 #define DEBUG_SYMBOL PREFIX_OBJECT(debug_)
119
120 #if DEBUG_SYMBOL
121 #define DEBUG_SYMBOL_STR _XSTR ( DEBUG_SYMBOL )
122 __asm__ ( ".equ\tDBGLVL, " DEBUG_SYMBOL_STR );
123 #endif
124
125 /** printf() for debugging
126  *
127  * This function exists so that the DBG() macros can expand to
128  * printf() calls without dragging the printf() prototype into scope.
129  *
130  * As far as the compiler is concerned, dbg_printf() and printf() are
131  * completely unrelated calls; it's only at the assembly stage that
132  * references to the dbg_printf symbol are collapsed into references
133  * to the printf symbol.
134  */
135 extern int __attribute__ (( format ( printf, 1, 2 ) )) 
136 dbg_printf ( const char *fmt, ... ) asm ( "printf" );
137
138 extern void dbg_autocolourise ( unsigned long id );
139 extern void dbg_decolourise ( void );
140 extern void dbg_hex_dump_da ( unsigned long dispaddr,
141                               const void *data, unsigned long len );
142
143 #if DEBUG_SYMBOL
144 #define DBGLVL_MAX DEBUG_SYMBOL
145 #else
146 #define DBGLVL_MAX 0
147 #endif
148
149 /* Allow for selective disabling of enabled debug levels */
150 #if DBGLVL_MAX
151 int __debug_disable;
152 #define DBGLVL ( DBGLVL_MAX & ~__debug_disable )
153 #define DBG_DISABLE( level ) do {                               \
154         __debug_disable |= ( (level) & DBGLVL_MAX );            \
155         } while ( 0 )
156 #define DBG_ENABLE( level ) do {                                \
157         __debug_disable &= ~( (level) & DBGLVL_MAX );           \
158         } while ( 0 )
159 #else
160 #define DBGLVL 0
161 #define DBG_DISABLE( level ) do { } while ( 0 )
162 #define DBG_ENABLE( level ) do { } while ( 0 )
163 #endif
164
165 #define DBGLVL_LOG      1
166 #define DBG_LOG         ( DBGLVL & DBGLVL_LOG )
167 #define DBGLVL_EXTRA    2
168 #define DBG_EXTRA       ( DBGLVL & DBGLVL_EXTRA )
169 #define DBGLVL_PROFILE  4
170 #define DBG_PROFILE     ( DBGLVL & DBGLVL_PROFILE )
171 #define DBGLVL_IO       8
172 #define DBG_IO          ( DBGLVL & DBGLVL_IO )
173
174 /**
175  * Print debugging message if we are at a certain debug level
176  *
177  * @v level             Debug level
178  * @v ...               printf() argument list
179  */
180 #define DBG_IF( level, ... ) do {                               \
181                 if ( DBG_ ## level ) {                          \
182                         dbg_printf ( __VA_ARGS__ );             \
183                 }                                               \
184         } while ( 0 )
185
186 /**
187  * Print a hex dump if we are at a certain debug level
188  *
189  * @v level             Debug level
190  * @v dispaddr          Display address
191  * @v data              Data to print
192  * @v len               Length of data
193  */
194 #define DBG_HDA_IF( level, dispaddr, data, len )  do {          \
195                 if ( DBG_ ## level ) {                          \
196                         union {                                 \
197                                 unsigned long ul;               \
198                                 typeof ( dispaddr ) raw;        \
199                         } da;                                   \
200                         da.raw = dispaddr;                      \
201                         dbg_hex_dump_da ( da.ul, data, len );   \
202                 }                                               \
203         } while ( 0 )
204
205 /**
206  * Print a hex dump if we are at a certain debug level
207  *
208  * @v level             Debug level
209  * @v data              Data to print
210  * @v len               Length of data
211  */
212 #define DBG_HD_IF( level, data, len ) do {                      \
213                 DBG_HDA_IF ( level, data, data, len );          \
214         } while ( 0 )
215
216 /**
217  * Select colour for debug messages if we are at a certain debug level
218  *
219  * @v level             Debug level
220  * @v id                Message stream ID
221  */
222 #define DBG_AC_IF( level, id ) do {                             \
223                 if ( DBG_ ## level ) {                          \
224                         union {                                 \
225                                 unsigned long ul;               \
226                                 typeof ( id ) raw;              \
227                         } dbg_stream;                           \
228                         dbg_stream.raw = id;                    \
229                         dbg_autocolourise ( dbg_stream.ul );    \
230                 }                                               \
231         } while ( 0 )
232
233 /**
234  * Revert colour for debug messages if we are at a certain debug level
235  *
236  * @v level             Debug level
237  */
238 #define DBG_DC_IF( level ) do {                                 \
239                 if ( DBG_ ## level ) {                          \
240                         dbg_decolourise();                      \
241                 }                                               \
242         } while ( 0 )
243
244 /* Autocolourising versions of the DBGxxx_IF() macros */
245
246 #define DBGC_IF( level, id, ... ) do {                          \
247                 DBG_AC_IF ( level, id );                        \
248                 DBG_IF ( level, __VA_ARGS__ );                  \
249                 DBG_DC_IF ( level );                            \
250         } while ( 0 )
251
252 #define DBGC_HDA_IF( level, id, ... ) do {                      \
253                 DBG_AC_IF ( level, id );                        \
254                 DBG_HDA_IF ( level, __VA_ARGS__ );              \
255                 DBG_DC_IF ( level );                            \
256         } while ( 0 )
257
258 #define DBGC_HD_IF( level, id, ... ) do {                       \
259                 DBG_AC_IF ( level, id );                        \
260                 DBG_HD_IF ( level, __VA_ARGS__ );               \
261                 DBG_DC_IF ( level );                            \
262         } while ( 0 )
263
264 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( LOG, ... )*/
265
266 #define DBG( ... )              DBG_IF          ( LOG, __VA_ARGS__ )
267 #define DBG_HDA( ... )          DBG_HDA_IF      ( LOG, __VA_ARGS__ )
268 #define DBG_HD( ... )           DBG_HD_IF       ( LOG, __VA_ARGS__ )
269 #define DBGC( ... )             DBGC_IF         ( LOG, __VA_ARGS__ )
270 #define DBGC_HDA( ... )         DBGC_HDA_IF     ( LOG, __VA_ARGS__ )
271 #define DBGC_HD( ... )          DBGC_HD_IF      ( LOG, __VA_ARGS__ )
272
273 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( EXTRA, ... )*/
274
275 #define DBG2( ... )             DBG_IF          ( EXTRA, __VA_ARGS__ )
276 #define DBG2_HDA( ... )         DBG_HDA_IF      ( EXTRA, __VA_ARGS__ )
277 #define DBG2_HD( ... )          DBG_HD_IF       ( EXTRA, __VA_ARGS__ )
278 #define DBGC2( ... )            DBGC_IF         ( EXTRA, __VA_ARGS__ )
279 #define DBGC2_HDA( ... )        DBGC_HDA_IF     ( EXTRA, __VA_ARGS__ )
280 #define DBGC2_HD( ... )         DBGC_HD_IF      ( EXTRA, __VA_ARGS__ )
281
282 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( PROFILE, ... )*/
283
284 #define DBGP( ... )             DBG_IF          ( PROFILE, __VA_ARGS__ )
285 #define DBGP_HDA( ... )         DBG_HDA_IF      ( PROFILE, __VA_ARGS__ )
286 #define DBGP_HD( ... )          DBG_HD_IF       ( PROFILE, __VA_ARGS__ )
287 #define DBGCP( ... )            DBGC_IF         ( PROFILE, __VA_ARGS__ )
288 #define DBGCP_HDA( ... )        DBGC_HDA_IF     ( PROFILE, __VA_ARGS__ )
289 #define DBGCP_HD( ... )         DBGC_HD_IF      ( PROFILE, __VA_ARGS__ )
290
291 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( IO, ... )*/
292
293 #define DBGIO( ... )            DBG_IF          ( IO, __VA_ARGS__ )
294 #define DBGIO_HDA( ... )        DBG_HDA_IF      ( IO, __VA_ARGS__ )
295 #define DBGIO_HD( ... )         DBG_HD_IF       ( IO, __VA_ARGS__ )
296 #define DBGCIO( ... )           DBGC_IF         ( IO, __VA_ARGS__ )
297 #define DBGCIO_HDA( ... )       DBGC_HDA_IF     ( IO, __VA_ARGS__ )
298 #define DBGCIO_HD( ... )        DBGC_HD_IF      ( IO, __VA_ARGS__ )
299
300
301 #if DEBUG_SYMBOL == 0
302 #define NDEBUG
303 #endif
304
305 /** Select file identifier for errno.h (if used) */
306 #define ERRFILE PREFIX_OBJECT ( ERRFILE_ )
307
308 /** Declare a data structure as packed. */
309 #define PACKED __attribute__ (( packed ))
310
311 /** Declare a variable or data structure as unused. */
312 #define __unused __attribute__ (( unused ))
313
314 /**
315  * Declare a function as pure - i.e. without side effects
316  */
317 #define __pure __attribute__ (( pure ))
318
319 /**
320  * Declare a function as const - i.e. it does not access global memory
321  * (including dereferencing pointers passed to it) at all.
322  * Must also not call any non-const functions.
323  */
324 #define __const __attribute__ (( const ))
325
326 /**
327  * Declare a function's pointer parameters as non-null - i.e. force
328  * compiler to check pointers at compile time and enable possible
329  * optimizations based on that fact
330  */
331 #define __nonnull __attribute__ (( nonnull ))
332
333 /**
334  * Declare a pointer returned by a function as a unique memory address
335  * as returned by malloc-type functions.
336  */
337 #define __malloc __attribute__ (( malloc ))
338
339 /**
340  * Declare a function as used.
341  *
342  * Necessary only if the function is called only from assembler code.
343  */
344 #define __used __attribute__ (( used ))
345
346 /** Declare a data structure to be aligned with 16-byte alignment */
347 #define __aligned __attribute__ (( aligned ( 16 ) ))
348
349 /** Declare a function to be always inline */
350 #define __always_inline __attribute__ (( always_inline ))
351
352 /**
353  * Shared data.
354  *
355  * To save space in the binary when multiple-driver images are
356  * compiled, uninitialised data areas can be shared between drivers.
357  * This will typically be used to share statically-allocated receive
358  * and transmit buffers between drivers.
359  *
360  * Use as e.g.
361  *
362  * @code
363  *
364  *   struct {
365  *      char    rx_buf[NUM_RX_BUF][RX_BUF_SIZE];
366  *      char    tx_buf[TX_BUF_SIZE];
367  *   } my_static_data __shared;
368  *
369  * @endcode
370  *
371  */
372 #define __shared __asm__ ( "_shared_bss" ) __aligned
373
374 /**
375  * Optimisation barrier
376  */
377 #define barrier() __asm__ __volatile__ ( "" : : : "memory" )
378
379 #endif /* ASSEMBLY */
380
381 #include <bits/compiler.h>
382
383 #endif /* COMPILER_H */