f481f38ae6217d8d786a72781a57c7d53b469683
[people/cooldavid/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 /* Force visibility of all symbols to "hidden", i.e. inform gcc that
28  * all symbol references resolve strictly within our final binary.
29  * This avoids unnecessary PLT/GOT entries on x86_64.
30  *
31  * This is a stronger claim than specifying "-fvisibility=hidden",
32  * since it also affects symbols marked with "extern".
33  */
34 #ifndef ASSEMBLY
35 #if __GNUC__ >= 4
36 #pragma GCC visibility push(hidden)
37 #endif
38 #endif /* ASSEMBLY */
39
40 #undef _S1
41 #undef _S2
42 #undef _C1
43 #undef _C2
44
45 /** Concatenate non-expanded arguments */
46 #define _C1( x, y ) x ## y
47 /** Concatenate expanded arguments */
48 #define _C2( x, y ) _C1 ( x, y )
49
50 /** Stringify non-expanded argument */
51 #define _S1( x ) #x
52 /** Stringify expanded argument */
53 #define _S2( x ) _S1 ( x )
54
55 /**
56  * @defgroup symmacros Macros to provide or require explicit symbols
57  * @{
58  */
59
60 /** Provide a symbol within this object file */
61 #ifdef ASSEMBLY
62 #define PROVIDE_SYMBOL( _sym )                          \
63         .globl  _sym ;                                  \
64         .comm   _sym, 0
65 #else /* ASSEMBLY */
66 #define PROVIDE_SYMBOL( _sym )                          \
67         char _sym[0]
68 #endif /* ASSEMBLY */
69
70 /** Require a symbol within this object file
71  *
72  * The symbol is referenced by a relocation in a discarded section, so
73  * if it is not available at link time the link will fail.
74  */
75 #ifdef ASSEMBLY
76 #define REQUIRE_SYMBOL( _sym )                          \
77         .section ".discard", "a", @progbits ;           \
78         .extern _sym ;                                  \
79         .long   _sym ;                                  \
80         .previous
81 #else /* ASSEMBLY */
82 #define REQUIRE_SYMBOL( _sym )                          \
83         extern char _sym;                               \
84         static char * _C2 ( _C2 ( __require_, _sym ), _C2 ( _, __LINE__ ) ) \
85                 __attribute__ (( section ( ".discard" ), used )) \
86                 = &_sym
87 #endif
88
89 /** Request that a symbol be available at runtime
90  *
91  * The requested symbol is entered as undefined into the symbol table
92  * for this object, so the linker will pull in other object files as
93  * necessary to satisfy the reference. However, the undefined symbol
94  * is not referenced in any relocations, so the link can still succeed
95  * if no file contains it.
96  *
97  * A symbol passed to this macro may not be referenced anywhere
98  * else in the file. If you want to do that, see IMPORT_SYMBOL().
99  */
100 #ifdef ASSEMBLY
101 #define REQUEST_SYMBOL( _sym )                          \
102         .equ    __need_ ## _sym, _sym
103 #else /* ASSEMBLY */
104 #define REQUEST_SYMBOL( _sym )                          \
105         __asm__ ( ".equ\t__need_" #_sym ", " #_sym )
106 #endif /* ASSEMBLY */
107
108 /** Set up a symbol to be usable in another file by IMPORT_SYMBOL()
109  *
110  * The symbol must already be marked as global.
111  */
112 #define EXPORT_SYMBOL( _sym )   PROVIDE_SYMBOL ( __export_ ## _sym )
113
114 /** Make a symbol usable to this file if available at link time
115  *
116  * If no file passed to the linker contains the symbol, it will have
117  * @c NULL value to future uses. Keep in mind that the symbol value is
118  * really the @e address of a variable or function; see the code
119  * snippet below.
120  *
121  * In C using IMPORT_SYMBOL, you must specify the declaration as the
122  * second argument, for instance
123  *
124  * @code
125  *   IMPORT_SYMBOL ( my_func, int my_func ( int arg ) );
126  *   IMPORT_SYMBOL ( my_var, int my_var );
127  *
128  *   void use_imports ( void ) {
129  *      if ( my_func && &my_var )
130  *         my_var = my_func ( my_var );
131  *   }
132  * @endcode
133  *
134  * GCC considers a weak declaration to override a strong one no matter
135  * which comes first, so it is safe to include a header file declaring
136  * the imported symbol normally, but providing the declaration to
137  * IMPORT_SYMBOL is still required.
138  *
139  * If no EXPORT_SYMBOL declaration exists for the imported symbol in
140  * another file, the behavior will be most likely be identical to that
141  * for an unavailable symbol.
142  */
143 #ifdef ASSEMBLY
144 #define IMPORT_SYMBOL( _sym )                           \
145         REQUEST_SYMBOL ( __export_ ## _sym ) ;          \
146         .weak   _sym
147 #else /* ASSEMBLY */
148 #define IMPORT_SYMBOL( _sym, _decl )                    \
149         REQUEST_SYMBOL ( __export_ ## _sym ) ;          \
150         extern _decl __attribute__ (( weak ))
151 #endif
152
153 /** @} */
154
155 /**
156  * @defgroup objmacros Macros to provide or require explicit objects
157  * @{
158  */
159
160 #define PREFIX_OBJECT( _prefix ) _C2 ( _prefix, OBJECT )
161 #define OBJECT_SYMBOL PREFIX_OBJECT ( obj_ )
162 #define REQUEST_EXPANDED( _sym ) REQUEST_SYMBOL ( _sym )
163 #define CONFIG_SYMBOL PREFIX_OBJECT ( obj_config_ )
164
165 /** Always provide the symbol for the current object (defined by -DOBJECT) */
166 PROVIDE_SYMBOL ( OBJECT_SYMBOL );
167
168 /** Pull in an object-specific configuration file if available */
169 REQUEST_EXPANDED ( CONFIG_SYMBOL );
170
171 /** Explicitly require another object */
172 #define REQUIRE_OBJECT( _obj ) REQUIRE_SYMBOL ( obj_ ## _obj )
173
174 /** Pull in another object if it exists */
175 #define REQUEST_OBJECT( _obj ) REQUEST_SYMBOL ( obj_ ## _obj )
176
177 /** @} */
178
179 /** Select file identifier for errno.h (if used) */
180 #define ERRFILE PREFIX_OBJECT ( ERRFILE_ )
181
182 /** @defgroup dbg Debugging infrastructure
183  * @{
184  */
185 #ifndef ASSEMBLY
186
187 /** @def DBG
188  *
189  * Print a debugging message.
190  *
191  * The debug level is set at build time by specifying the @c DEBUG=
192  * parameter on the @c make command line.  For example, to enable
193  * debugging for the PCI bus functions (in pci.c) in a @c .dsk image
194  * for the @c rtl8139 card, you could use the command line
195  *
196  * @code
197  *
198  *   make bin/rtl8139.dsk DEBUG=pci
199  *
200  * @endcode
201  *
202  * This will enable the debugging statements (DBG()) in pci.c.  If
203  * debugging is not enabled, DBG() statements will be ignored.
204  *
205  * You can enable debugging in several objects simultaneously by
206  * separating them with commas, as in
207  *
208  * @code
209  *
210  *   make bin/rtl8139.dsk DEBUG=pci,buffer,heap
211  *
212  * @endcode
213  *
214  * You can increase the debugging level for an object by specifying it
215  * with @c :N, where @c N is the level, as in
216  *
217  * @code
218  *
219  *   make bin/rtl8139.dsk DEBUG=pci,buffer:2,heap
220  *
221  * @endcode
222  *
223  * which would enable debugging for the PCI, buffer-handling and
224  * heap-allocation code, with the buffer-handling code at level 2.
225  *
226  */
227
228 /*
229  * If debug_OBJECT is set to a true value, the macro DBG(...) will
230  * expand to printf(...) when compiling OBJECT, and the symbol
231  * DEBUG_LEVEL will be inserted into the object file.
232  *
233  */
234 #define DEBUG_SYMBOL PREFIX_OBJECT ( debug_ )
235
236 /** printf() for debugging
237  *
238  * This function exists so that the DBG() macros can expand to
239  * printf() calls without dragging the printf() prototype into scope.
240  *
241  * As far as the compiler is concerned, dbg_printf() and printf() are
242  * completely unrelated calls; it's only at the assembly stage that
243  * references to the dbg_printf symbol are collapsed into references
244  * to the printf symbol.
245  */
246 extern int __attribute__ (( format ( printf, 1, 2 ) )) 
247 dbg_printf ( const char *fmt, ... ) asm ( "printf" );
248
249 extern void dbg_autocolourise ( unsigned long id );
250 extern void dbg_decolourise ( void );
251 extern void dbg_hex_dump_da ( unsigned long dispaddr,
252                               const void *data, unsigned long len );
253
254 #if DEBUG_SYMBOL
255 #define DBGLVL_MAX DEBUG_SYMBOL
256 #else
257 #define DBGLVL_MAX 0
258 #endif
259
260 /* Allow for selective disabling of enabled debug levels */
261 #if DBGLVL_MAX
262 int __debug_disable;
263 #define DBGLVL ( DBGLVL_MAX & ~__debug_disable )
264 #define DBG_DISABLE( level ) do {                               \
265         __debug_disable |= ( (level) & DBGLVL_MAX );            \
266         } while ( 0 )
267 #define DBG_ENABLE( level ) do {                                \
268         __debug_disable &= ~( (level) & DBGLVL_MAX );           \
269         } while ( 0 )
270 #else
271 #define DBGLVL 0
272 #define DBG_DISABLE( level ) do { } while ( 0 )
273 #define DBG_ENABLE( level ) do { } while ( 0 )
274 #endif
275
276 #define DBGLVL_LOG      1
277 #define DBG_LOG         ( DBGLVL & DBGLVL_LOG )
278 #define DBGLVL_EXTRA    2
279 #define DBG_EXTRA       ( DBGLVL & DBGLVL_EXTRA )
280 #define DBGLVL_PROFILE  4
281 #define DBG_PROFILE     ( DBGLVL & DBGLVL_PROFILE )
282 #define DBGLVL_IO       8
283 #define DBG_IO          ( DBGLVL & DBGLVL_IO )
284
285 /**
286  * Print debugging message if we are at a certain debug level
287  *
288  * @v level             Debug level
289  * @v ...               printf() argument list
290  */
291 #define DBG_IF( level, ... ) do {                               \
292                 if ( DBG_ ## level ) {                          \
293                         dbg_printf ( __VA_ARGS__ );             \
294                 }                                               \
295         } while ( 0 )
296
297 /**
298  * Print a hex dump if we are at a certain debug level
299  *
300  * @v level             Debug level
301  * @v dispaddr          Display address
302  * @v data              Data to print
303  * @v len               Length of data
304  */
305 #define DBG_HDA_IF( level, dispaddr, data, len )  do {          \
306                 if ( DBG_ ## level ) {                          \
307                         union {                                 \
308                                 unsigned long ul;               \
309                                 typeof ( dispaddr ) raw;        \
310                         } da;                                   \
311                         da.raw = dispaddr;                      \
312                         dbg_hex_dump_da ( da.ul, data, len );   \
313                 }                                               \
314         } while ( 0 )
315
316 /**
317  * Print a hex dump if we are at a certain debug level
318  *
319  * @v level             Debug level
320  * @v data              Data to print
321  * @v len               Length of data
322  */
323 #define DBG_HD_IF( level, data, len ) do {                      \
324                 const void *_data = data;                       \
325                 DBG_HDA_IF ( level, _data, _data, len );        \
326         } while ( 0 )
327
328 /**
329  * Select colour for debug messages if we are at a certain debug level
330  *
331  * @v level             Debug level
332  * @v id                Message stream ID
333  */
334 #define DBG_AC_IF( level, id ) do {                             \
335                 if ( DBG_ ## level ) {                          \
336                         union {                                 \
337                                 unsigned long ul;               \
338                                 typeof ( id ) raw;              \
339                         } dbg_stream;                           \
340                         dbg_stream.raw = id;                    \
341                         dbg_autocolourise ( dbg_stream.ul );    \
342                 }                                               \
343         } while ( 0 )
344
345 /**
346  * Revert colour for debug messages if we are at a certain debug level
347  *
348  * @v level             Debug level
349  */
350 #define DBG_DC_IF( level ) do {                                 \
351                 if ( DBG_ ## level ) {                          \
352                         dbg_decolourise();                      \
353                 }                                               \
354         } while ( 0 )
355
356 /* Autocolourising versions of the DBGxxx_IF() macros */
357
358 #define DBGC_IF( level, id, ... ) do {                          \
359                 DBG_AC_IF ( level, id );                        \
360                 DBG_IF ( level, __VA_ARGS__ );                  \
361                 DBG_DC_IF ( level );                            \
362         } while ( 0 )
363
364 #define DBGC_HDA_IF( level, id, ... ) do {                      \
365                 DBG_AC_IF ( level, id );                        \
366                 DBG_HDA_IF ( level, __VA_ARGS__ );              \
367                 DBG_DC_IF ( level );                            \
368         } while ( 0 )
369
370 #define DBGC_HD_IF( level, id, ... ) do {                       \
371                 DBG_AC_IF ( level, id );                        \
372                 DBG_HD_IF ( level, __VA_ARGS__ );               \
373                 DBG_DC_IF ( level );                            \
374         } while ( 0 )
375
376 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( LOG, ... )*/
377
378 #define DBG( ... )              DBG_IF          ( LOG, __VA_ARGS__ )
379 #define DBG_HDA( ... )          DBG_HDA_IF      ( LOG, __VA_ARGS__ )
380 #define DBG_HD( ... )           DBG_HD_IF       ( LOG, __VA_ARGS__ )
381 #define DBGC( ... )             DBGC_IF         ( LOG, __VA_ARGS__ )
382 #define DBGC_HDA( ... )         DBGC_HDA_IF     ( LOG, __VA_ARGS__ )
383 #define DBGC_HD( ... )          DBGC_HD_IF      ( LOG, __VA_ARGS__ )
384
385 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( EXTRA, ... )*/
386
387 #define DBG2( ... )             DBG_IF          ( EXTRA, __VA_ARGS__ )
388 #define DBG2_HDA( ... )         DBG_HDA_IF      ( EXTRA, __VA_ARGS__ )
389 #define DBG2_HD( ... )          DBG_HD_IF       ( EXTRA, __VA_ARGS__ )
390 #define DBGC2( ... )            DBGC_IF         ( EXTRA, __VA_ARGS__ )
391 #define DBGC2_HDA( ... )        DBGC_HDA_IF     ( EXTRA, __VA_ARGS__ )
392 #define DBGC2_HD( ... )         DBGC_HD_IF      ( EXTRA, __VA_ARGS__ )
393
394 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( PROFILE, ... )*/
395
396 #define DBGP( ... )             DBG_IF          ( PROFILE, __VA_ARGS__ )
397 #define DBGP_HDA( ... )         DBG_HDA_IF      ( PROFILE, __VA_ARGS__ )
398 #define DBGP_HD( ... )          DBG_HD_IF       ( PROFILE, __VA_ARGS__ )
399 #define DBGCP( ... )            DBGC_IF         ( PROFILE, __VA_ARGS__ )
400 #define DBGCP_HDA( ... )        DBGC_HDA_IF     ( PROFILE, __VA_ARGS__ )
401 #define DBGCP_HD( ... )         DBGC_HD_IF      ( PROFILE, __VA_ARGS__ )
402
403 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( IO, ... )*/
404
405 #define DBGIO( ... )            DBG_IF          ( IO, __VA_ARGS__ )
406 #define DBGIO_HDA( ... )        DBG_HDA_IF      ( IO, __VA_ARGS__ )
407 #define DBGIO_HD( ... )         DBG_HD_IF       ( IO, __VA_ARGS__ )
408 #define DBGCIO( ... )           DBGC_IF         ( IO, __VA_ARGS__ )
409 #define DBGCIO_HDA( ... )       DBGC_HDA_IF     ( IO, __VA_ARGS__ )
410 #define DBGCIO_HD( ... )        DBGC_HD_IF      ( IO, __VA_ARGS__ )
411
412
413 #if DEBUG_SYMBOL == 0
414 #define NDEBUG
415 #endif
416
417 #endif /* ASSEMBLY */
418 /** @} */
419
420 /** @defgroup attrs Miscellaneous attributes
421  * @{
422  */
423 #ifndef ASSEMBLY
424
425 /** Declare a data structure as packed. */
426 #define PACKED __attribute__ (( packed ))
427
428 /** Declare a variable or data structure as unused. */
429 #define __unused __attribute__ (( unused ))
430
431 /**
432  * Declare a function as pure - i.e. without side effects
433  */
434 #define __pure __attribute__ (( pure ))
435
436 /**
437  * Declare a function as const - i.e. it does not access global memory
438  * (including dereferencing pointers passed to it) at all.
439  * Must also not call any non-const functions.
440  */
441 #define __const __attribute__ (( const ))
442
443 /**
444  * Declare a function's pointer parameters as non-null - i.e. force
445  * compiler to check pointers at compile time and enable possible
446  * optimizations based on that fact
447  */
448 #define __nonnull __attribute__ (( nonnull ))
449
450 /**
451  * Declare a pointer returned by a function as a unique memory address
452  * as returned by malloc-type functions.
453  */
454 #define __malloc __attribute__ (( malloc ))
455
456 /**
457  * Declare a function as used.
458  *
459  * Necessary only if the function is called only from assembler code.
460  */
461 #define __used __attribute__ (( used ))
462
463 /** Declare a data structure to be aligned with 16-byte alignment */
464 #define __aligned __attribute__ (( aligned ( 16 ) ))
465
466 /** Declare a function to be always inline */
467 #define __always_inline __attribute__ (( always_inline ))
468
469 /**
470  * Shared data.
471  *
472  * To save space in the binary when multiple-driver images are
473  * compiled, uninitialised data areas can be shared between drivers.
474  * This will typically be used to share statically-allocated receive
475  * and transmit buffers between drivers.
476  *
477  * Use as e.g.
478  *
479  * @code
480  *
481  *   struct {
482  *      char    rx_buf[NUM_RX_BUF][RX_BUF_SIZE];
483  *      char    tx_buf[TX_BUF_SIZE];
484  *   } my_static_data __shared;
485  *
486  * @endcode
487  *
488  */
489 #define __shared __asm__ ( "_shared_bss" ) __aligned
490
491 #endif /* ASSEMBLY */
492 /** @} */
493
494 /**
495  * Optimisation barrier
496  */
497 #ifndef ASSEMBLY
498 #define barrier() __asm__ __volatile__ ( "" : : : "memory" )
499 #endif /* ASSEMBLY */
500
501 /**
502  * @defgroup licences Licence declarations
503  *
504  * For reasons that are partly historical, various different files
505  * within the gPXE codebase have differing licences.
506  *
507  * @{
508  */
509
510 /** Declare a file as being in the public domain
511  *
512  * This licence declaration is applicable when a file states itself to
513  * be in the public domain.
514  */
515 #define FILE_LICENCE_PUBLIC_DOMAIN \
516         PROVIDE_SYMBOL ( __licence_public_domain )
517
518 /** Declare a file as being under version 2 (or later) of the GNU GPL
519  *
520  * This licence declaration is applicable when a file states itself to
521  * be licensed under the GNU GPL; "either version 2 of the License, or
522  * (at your option) any later version".
523  */
524 #define FILE_LICENCE_GPL2_OR_LATER \
525         PROVIDE_SYMBOL ( __licence_gpl2_or_later )
526
527 /** Declare a file as being under version 2 of the GNU GPL
528  *
529  * This licence declaration is applicable when a file states itself to
530  * be licensed under version 2 of the GPL, and does not include the
531  * "or, at your option, any later version" clause.
532  */
533 #define FILE_LICENCE_GPL2_ONLY \
534         PROVIDE_SYMBOL ( __licence_gpl2_only )
535
536 /** Declare a file as being under any version of the GNU GPL
537  *
538  * This licence declaration is applicable when a file states itself to
539  * be licensed under the GPL, but does not specify a version.
540  *
541  * According to section 9 of the GPLv2, "If the Program does not
542  * specify a version number of this License, you may choose any
543  * version ever published by the Free Software Foundation".
544  */
545 #define FILE_LICENCE_GPL_ANY \
546         PROVIDE_SYMBOL ( __licence_gpl_any )
547
548 /** Declare a file as being under the three-clause BSD licence
549  *
550  * This licence declaration is applicable when a file states itself to
551  * be licensed under terms allowing redistribution in source and
552  * binary forms (with or without modification) provided that:
553  *
554  *     redistributions of source code retain the copyright notice,
555  *     list of conditions and any attached disclaimers
556  *
557  *     redistributions in binary form reproduce the copyright notice,
558  *     list of conditions and any attached disclaimers in the
559  *     documentation and/or other materials provided with the
560  *     distribution
561  *
562  *     the name of the author is not used to endorse or promote
563  *     products derived from the software without specific prior
564  *     written permission
565  *
566  * It is not necessary for the file to explicitly state that it is
567  * under a "BSD" licence; only that the licensing terms be
568  * functionally equivalent to the standard three-clause BSD licence.
569  */
570 #define FILE_LICENCE_BSD3 \
571         PROVIDE_SYMBOL ( __licence_bsd3 )
572
573 /** Declare a file as being under the two-clause BSD licence
574  *
575  * This licence declaration is applicable when a file states itself to
576  * be licensed under terms allowing redistribution in source and
577  * binary forms (with or without modification) provided that:
578  *
579  *     redistributions of source code retain the copyright notice,
580  *     list of conditions and any attached disclaimers
581  *
582  *     redistributions in binary form reproduce the copyright notice,
583  *     list of conditions and any attached disclaimers in the
584  *     documentation and/or other materials provided with the
585  *     distribution
586  *
587  * It is not necessary for the file to explicitly state that it is
588  * under a "BSD" licence; only that the licensing terms be
589  * functionally equivalent to the standard two-clause BSD licence.
590  */
591 #define FILE_LICENCE_BSD2 \
592         PROVIDE_SYMBOL ( __licence_bsd2 )
593
594 /** Declare a file as being under the one-clause MIT-style licence
595  *
596  * This licence declaration is applicable when a file states itself to
597  * be licensed under terms allowing redistribution for any purpose
598  * with or without fee, provided that the copyright notice and
599  * permission notice appear in all copies.
600  */
601 #define FILE_LICENCE_MIT \
602         PROVIDE_SYMBOL ( __licence_mit )
603
604 /** Declare a particular licence as applying to a file */
605 #define FILE_LICENCE( _licence ) FILE_LICENCE_ ## _licence
606
607 /** @} */
608
609 /* This file itself is under GPLv2-or-later */
610 FILE_LICENCE ( GPL2_OR_LATER );
611
612 #include <bits/compiler.h>
613
614 #endif /* COMPILER_H */