[linker] Expand and correct symbol requirement macros
[people/mcb30/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
163 /** Always provide the symbol for the current object (defined by -DOBJECT) */
164 PROVIDE_SYMBOL ( OBJECT_SYMBOL );
165
166 /** Explicitly require another object */
167 #define REQUIRE_OBJECT( _obj ) REQUIRE_SYMBOL ( obj_ ## _obj )
168
169 /** Pull in another object if it exists */
170 #define REQUEST_OBJECT( _obj ) REQUEST_SYMBOL ( obj_ ## _obj )
171
172 /** @} */
173
174 /** Select file identifier for errno.h (if used) */
175 #define ERRFILE PREFIX_OBJECT ( ERRFILE_ )
176
177 /** @defgroup dbg Debugging infrastructure
178  * @{
179  */
180 #ifndef ASSEMBLY
181
182 /** @def DBG
183  *
184  * Print a debugging message.
185  *
186  * The debug level is set at build time by specifying the @c DEBUG=
187  * parameter on the @c make command line.  For example, to enable
188  * debugging for the PCI bus functions (in pci.c) in a @c .dsk image
189  * for the @c rtl8139 card, you could use the command line
190  *
191  * @code
192  *
193  *   make bin/rtl8139.dsk DEBUG=pci
194  *
195  * @endcode
196  *
197  * This will enable the debugging statements (DBG()) in pci.c.  If
198  * debugging is not enabled, DBG() statements will be ignored.
199  *
200  * You can enable debugging in several objects simultaneously by
201  * separating them with commas, as in
202  *
203  * @code
204  *
205  *   make bin/rtl8139.dsk DEBUG=pci,buffer,heap
206  *
207  * @endcode
208  *
209  * You can increase the debugging level for an object by specifying it
210  * with @c :N, where @c N is the level, as in
211  *
212  * @code
213  *
214  *   make bin/rtl8139.dsk DEBUG=pci,buffer:2,heap
215  *
216  * @endcode
217  *
218  * which would enable debugging for the PCI, buffer-handling and
219  * heap-allocation code, with the buffer-handling code at level 2.
220  *
221  */
222
223 /*
224  * If debug_OBJECT is set to a true value, the macro DBG(...) will
225  * expand to printf(...) when compiling OBJECT, and the symbol
226  * DEBUG_LEVEL will be inserted into the object file.
227  *
228  */
229 #define DEBUG_SYMBOL PREFIX_OBJECT ( debug_ )
230
231 /** printf() for debugging
232  *
233  * This function exists so that the DBG() macros can expand to
234  * printf() calls without dragging the printf() prototype into scope.
235  *
236  * As far as the compiler is concerned, dbg_printf() and printf() are
237  * completely unrelated calls; it's only at the assembly stage that
238  * references to the dbg_printf symbol are collapsed into references
239  * to the printf symbol.
240  */
241 extern int __attribute__ (( format ( printf, 1, 2 ) )) 
242 dbg_printf ( const char *fmt, ... ) asm ( "printf" );
243
244 extern void dbg_autocolourise ( unsigned long id );
245 extern void dbg_decolourise ( void );
246 extern void dbg_hex_dump_da ( unsigned long dispaddr,
247                               const void *data, unsigned long len );
248
249 #if DEBUG_SYMBOL
250 #define DBGLVL_MAX DEBUG_SYMBOL
251 #else
252 #define DBGLVL_MAX 0
253 #endif
254
255 /* Allow for selective disabling of enabled debug levels */
256 #if DBGLVL_MAX
257 int __debug_disable;
258 #define DBGLVL ( DBGLVL_MAX & ~__debug_disable )
259 #define DBG_DISABLE( level ) do {                               \
260         __debug_disable |= ( (level) & DBGLVL_MAX );            \
261         } while ( 0 )
262 #define DBG_ENABLE( level ) do {                                \
263         __debug_disable &= ~( (level) & DBGLVL_MAX );           \
264         } while ( 0 )
265 #else
266 #define DBGLVL 0
267 #define DBG_DISABLE( level ) do { } while ( 0 )
268 #define DBG_ENABLE( level ) do { } while ( 0 )
269 #endif
270
271 #define DBGLVL_LOG      1
272 #define DBG_LOG         ( DBGLVL & DBGLVL_LOG )
273 #define DBGLVL_EXTRA    2
274 #define DBG_EXTRA       ( DBGLVL & DBGLVL_EXTRA )
275 #define DBGLVL_PROFILE  4
276 #define DBG_PROFILE     ( DBGLVL & DBGLVL_PROFILE )
277 #define DBGLVL_IO       8
278 #define DBG_IO          ( DBGLVL & DBGLVL_IO )
279
280 /**
281  * Print debugging message if we are at a certain debug level
282  *
283  * @v level             Debug level
284  * @v ...               printf() argument list
285  */
286 #define DBG_IF( level, ... ) do {                               \
287                 if ( DBG_ ## level ) {                          \
288                         dbg_printf ( __VA_ARGS__ );             \
289                 }                                               \
290         } while ( 0 )
291
292 /**
293  * Print a hex dump if we are at a certain debug level
294  *
295  * @v level             Debug level
296  * @v dispaddr          Display address
297  * @v data              Data to print
298  * @v len               Length of data
299  */
300 #define DBG_HDA_IF( level, dispaddr, data, len )  do {          \
301                 if ( DBG_ ## level ) {                          \
302                         union {                                 \
303                                 unsigned long ul;               \
304                                 typeof ( dispaddr ) raw;        \
305                         } da;                                   \
306                         da.raw = dispaddr;                      \
307                         dbg_hex_dump_da ( da.ul, data, len );   \
308                 }                                               \
309         } while ( 0 )
310
311 /**
312  * Print a hex dump if we are at a certain debug level
313  *
314  * @v level             Debug level
315  * @v data              Data to print
316  * @v len               Length of data
317  */
318 #define DBG_HD_IF( level, data, len ) do {                      \
319                 const void *_data = data;                       \
320                 DBG_HDA_IF ( level, _data, _data, len );        \
321         } while ( 0 )
322
323 /**
324  * Select colour for debug messages if we are at a certain debug level
325  *
326  * @v level             Debug level
327  * @v id                Message stream ID
328  */
329 #define DBG_AC_IF( level, id ) do {                             \
330                 if ( DBG_ ## level ) {                          \
331                         union {                                 \
332                                 unsigned long ul;               \
333                                 typeof ( id ) raw;              \
334                         } dbg_stream;                           \
335                         dbg_stream.raw = id;                    \
336                         dbg_autocolourise ( dbg_stream.ul );    \
337                 }                                               \
338         } while ( 0 )
339
340 /**
341  * Revert colour for debug messages if we are at a certain debug level
342  *
343  * @v level             Debug level
344  */
345 #define DBG_DC_IF( level ) do {                                 \
346                 if ( DBG_ ## level ) {                          \
347                         dbg_decolourise();                      \
348                 }                                               \
349         } while ( 0 )
350
351 /* Autocolourising versions of the DBGxxx_IF() macros */
352
353 #define DBGC_IF( level, id, ... ) do {                          \
354                 DBG_AC_IF ( level, id );                        \
355                 DBG_IF ( level, __VA_ARGS__ );                  \
356                 DBG_DC_IF ( level );                            \
357         } while ( 0 )
358
359 #define DBGC_HDA_IF( level, id, ... ) do {                      \
360                 DBG_AC_IF ( level, id );                        \
361                 DBG_HDA_IF ( level, __VA_ARGS__ );              \
362                 DBG_DC_IF ( level );                            \
363         } while ( 0 )
364
365 #define DBGC_HD_IF( level, id, ... ) do {                       \
366                 DBG_AC_IF ( level, id );                        \
367                 DBG_HD_IF ( level, __VA_ARGS__ );               \
368                 DBG_DC_IF ( level );                            \
369         } while ( 0 )
370
371 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( LOG, ... )*/
372
373 #define DBG( ... )              DBG_IF          ( LOG, __VA_ARGS__ )
374 #define DBG_HDA( ... )          DBG_HDA_IF      ( LOG, __VA_ARGS__ )
375 #define DBG_HD( ... )           DBG_HD_IF       ( LOG, __VA_ARGS__ )
376 #define DBGC( ... )             DBGC_IF         ( LOG, __VA_ARGS__ )
377 #define DBGC_HDA( ... )         DBGC_HDA_IF     ( LOG, __VA_ARGS__ )
378 #define DBGC_HD( ... )          DBGC_HD_IF      ( LOG, __VA_ARGS__ )
379
380 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( EXTRA, ... )*/
381
382 #define DBG2( ... )             DBG_IF          ( EXTRA, __VA_ARGS__ )
383 #define DBG2_HDA( ... )         DBG_HDA_IF      ( EXTRA, __VA_ARGS__ )
384 #define DBG2_HD( ... )          DBG_HD_IF       ( EXTRA, __VA_ARGS__ )
385 #define DBGC2( ... )            DBGC_IF         ( EXTRA, __VA_ARGS__ )
386 #define DBGC2_HDA( ... )        DBGC_HDA_IF     ( EXTRA, __VA_ARGS__ )
387 #define DBGC2_HD( ... )         DBGC_HD_IF      ( EXTRA, __VA_ARGS__ )
388
389 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( PROFILE, ... )*/
390
391 #define DBGP( ... )             DBG_IF          ( PROFILE, __VA_ARGS__ )
392 #define DBGP_HDA( ... )         DBG_HDA_IF      ( PROFILE, __VA_ARGS__ )
393 #define DBGP_HD( ... )          DBG_HD_IF       ( PROFILE, __VA_ARGS__ )
394 #define DBGCP( ... )            DBGC_IF         ( PROFILE, __VA_ARGS__ )
395 #define DBGCP_HDA( ... )        DBGC_HDA_IF     ( PROFILE, __VA_ARGS__ )
396 #define DBGCP_HD( ... )         DBGC_HD_IF      ( PROFILE, __VA_ARGS__ )
397
398 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( IO, ... )*/
399
400 #define DBGIO( ... )            DBG_IF          ( IO, __VA_ARGS__ )
401 #define DBGIO_HDA( ... )        DBG_HDA_IF      ( IO, __VA_ARGS__ )
402 #define DBGIO_HD( ... )         DBG_HD_IF       ( IO, __VA_ARGS__ )
403 #define DBGCIO( ... )           DBGC_IF         ( IO, __VA_ARGS__ )
404 #define DBGCIO_HDA( ... )       DBGC_HDA_IF     ( IO, __VA_ARGS__ )
405 #define DBGCIO_HD( ... )        DBGC_HD_IF      ( IO, __VA_ARGS__ )
406
407
408 #if DEBUG_SYMBOL == 0
409 #define NDEBUG
410 #endif
411
412 #endif /* ASSEMBLY */
413 /** @} */
414
415 /** @defgroup attrs Miscellaneous attributes
416  * @{
417  */
418 #ifndef ASSEMBLY
419
420 /** Declare a data structure as packed. */
421 #define PACKED __attribute__ (( packed ))
422
423 /** Declare a variable or data structure as unused. */
424 #define __unused __attribute__ (( unused ))
425
426 /**
427  * Declare a function as pure - i.e. without side effects
428  */
429 #define __pure __attribute__ (( pure ))
430
431 /**
432  * Declare a function as const - i.e. it does not access global memory
433  * (including dereferencing pointers passed to it) at all.
434  * Must also not call any non-const functions.
435  */
436 #define __const __attribute__ (( const ))
437
438 /**
439  * Declare a function's pointer parameters as non-null - i.e. force
440  * compiler to check pointers at compile time and enable possible
441  * optimizations based on that fact
442  */
443 #define __nonnull __attribute__ (( nonnull ))
444
445 /**
446  * Declare a pointer returned by a function as a unique memory address
447  * as returned by malloc-type functions.
448  */
449 #define __malloc __attribute__ (( malloc ))
450
451 /**
452  * Declare a function as used.
453  *
454  * Necessary only if the function is called only from assembler code.
455  */
456 #define __used __attribute__ (( used ))
457
458 /** Declare a data structure to be aligned with 16-byte alignment */
459 #define __aligned __attribute__ (( aligned ( 16 ) ))
460
461 /** Declare a function to be always inline */
462 #define __always_inline __attribute__ (( always_inline ))
463
464 /**
465  * Shared data.
466  *
467  * To save space in the binary when multiple-driver images are
468  * compiled, uninitialised data areas can be shared between drivers.
469  * This will typically be used to share statically-allocated receive
470  * and transmit buffers between drivers.
471  *
472  * Use as e.g.
473  *
474  * @code
475  *
476  *   struct {
477  *      char    rx_buf[NUM_RX_BUF][RX_BUF_SIZE];
478  *      char    tx_buf[TX_BUF_SIZE];
479  *   } my_static_data __shared;
480  *
481  * @endcode
482  *
483  */
484 #define __shared __asm__ ( "_shared_bss" ) __aligned
485
486 #endif /* ASSEMBLY */
487 /** @} */
488
489 /**
490  * Optimisation barrier
491  */
492 #ifndef ASSEMBLY
493 #define barrier() __asm__ __volatile__ ( "" : : : "memory" )
494 #endif /* ASSEMBLY */
495
496 /**
497  * @defgroup licences Licence declarations
498  *
499  * For reasons that are partly historical, various different files
500  * within the gPXE codebase have differing licences.
501  *
502  * @{
503  */
504
505 /** Declare a file as being in the public domain
506  *
507  * This licence declaration is applicable when a file states itself to
508  * be in the public domain.
509  */
510 #define FILE_LICENCE_PUBLIC_DOMAIN \
511         PROVIDE_SYMBOL ( __licence_public_domain )
512
513 /** Declare a file as being under version 2 (or later) of the GNU GPL
514  *
515  * This licence declaration is applicable when a file states itself to
516  * be licensed under the GNU GPL; "either version 2 of the License, or
517  * (at your option) any later version".
518  */
519 #define FILE_LICENCE_GPL2_OR_LATER \
520         PROVIDE_SYMBOL ( __licence_gpl2_or_later )
521
522 /** Declare a file as being under version 2 of the GNU GPL
523  *
524  * This licence declaration is applicable when a file states itself to
525  * be licensed under version 2 of the GPL, and does not include the
526  * "or, at your option, any later version" clause.
527  */
528 #define FILE_LICENCE_GPL2_ONLY \
529         PROVIDE_SYMBOL ( __licence_gpl2_only )
530
531 /** Declare a file as being under any version of the GNU GPL
532  *
533  * This licence declaration is applicable when a file states itself to
534  * be licensed under the GPL, but does not specify a version.
535  *
536  * According to section 9 of the GPLv2, "If the Program does not
537  * specify a version number of this License, you may choose any
538  * version ever published by the Free Software Foundation".
539  */
540 #define FILE_LICENCE_GPL_ANY \
541         PROVIDE_SYMBOL ( __licence_gpl_any )
542
543 /** Declare a file as being under the three-clause BSD licence
544  *
545  * This licence declaration is applicable when a file states itself to
546  * be licensed under terms allowing redistribution in source and
547  * binary forms (with or without modification) provided that:
548  *
549  *     redistributions of source code retain the copyright notice,
550  *     list of conditions and any attached disclaimers
551  *
552  *     redistributions in binary form reproduce the copyright notice,
553  *     list of conditions and any attached disclaimers in the
554  *     documentation and/or other materials provided with the
555  *     distribution
556  *
557  *     the name of the author is not used to endorse or promote
558  *     products derived from the software without specific prior
559  *     written permission
560  *
561  * It is not necessary for the file to explicitly state that it is
562  * under a "BSD" licence; only that the licensing terms be
563  * functionally equivalent to the standard three-clause BSD licence.
564  */
565 #define FILE_LICENCE_BSD3 \
566         PROVIDE_SYMBOL ( __licence_bsd3 )
567
568 /** Declare a file as being under the two-clause BSD licence
569  *
570  * This licence declaration is applicable when a file states itself to
571  * be licensed under terms allowing redistribution in source and
572  * binary forms (with or without modification) provided that:
573  *
574  *     redistributions of source code retain the copyright notice,
575  *     list of conditions and any attached disclaimers
576  *
577  *     redistributions in binary form reproduce the copyright notice,
578  *     list of conditions and any attached disclaimers in the
579  *     documentation and/or other materials provided with the
580  *     distribution
581  *
582  * It is not necessary for the file to explicitly state that it is
583  * under a "BSD" licence; only that the licensing terms be
584  * functionally equivalent to the standard two-clause BSD licence.
585  */
586 #define FILE_LICENCE_BSD2 \
587         PROVIDE_SYMBOL ( __licence_bsd2 )
588
589 /** Declare a file as being under the one-clause MIT-style licence
590  *
591  * This licence declaration is applicable when a file states itself to
592  * be licensed under terms allowing redistribution for any purpose
593  * with or without fee, provided that the copyright notice and
594  * permission notice appear in all copies.
595  */
596 #define FILE_LICENCE_MIT \
597         PROVIDE_SYMBOL ( __licence_mit )
598
599 /** Declare a particular licence as applying to a file */
600 #define FILE_LICENCE( _licence ) FILE_LICENCE_ ## _licence
601
602 /** @} */
603
604 /* This file itself is under GPLv2-or-later */
605 FILE_LICENCE ( GPL2_OR_LATER );
606
607 #include <bits/compiler.h>
608
609 #endif /* COMPILER_H */