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 #define DEBUG_SYMBOL_STR _XSTR ( DEBUG_SYMBOL )
 113 __asm__ ( ".equ\tDBGLVL, " DEBUG_SYMBOL_STR );
 114 #endif
 115
 116 /** printf() for debugging
 117  *
 118  * This function exists so that the DBG() macros can expand to
 119  * printf() calls without dragging the printf() prototype into scope.
 120  *
 121  * As far as the compiler is concerned, dbg_printf() and printf() are
 122  * completely unrelated calls; it's only at the assembly stage that
 123  * references to the dbg_printf symbol are collapsed into references
 124  * to the printf symbol.
 125  */
 126 extern int __attribute__ (( format ( printf, 1, 2 ) ))
 127 dbg_printf ( const char *fmt, ... ) asm ( "printf" );
 128
 129 extern void dbg_autocolourise ( unsigned long id );
 130 extern void dbg_decolourise ( void );
 131 extern void dbg_hex_dump_da ( unsigned long dispaddr,
 132                               const void *data, unsigned long len );
 133
 134 #if DEBUG_SYMBOL
 135 #define DBGLVL_MAX DEBUG_SYMBOL
 136 #else
 137 #define DBGLVL_MAX 0
 138 #endif
 139
 140 /* Allow for selective disabling of enabled debug levels */
 141 #if DBGLVL_MAX
 142 int __debug_disable;
 143 #define DBGLVL ( DBGLVL_MAX & ~__debug_disable )
 144 #define DBG_DISABLE( level ) do {                               \
 145         __debug_disable |= ( (level) & DBGLVL_MAX );            \
 146         } while ( 0 )
 147 #define DBG_ENABLE( level ) do {                                \
 148         __debug_disable &= ~( (level) & DBGLVL_MAX );           \
 149         } while ( 0 )
 150 #else
 151 #define DBGLVL 0
 152 #define DBG_DISABLE( level ) do { } while ( 0 )
 153 #define DBG_ENABLE( level ) do { } while ( 0 )
 154 #endif
 155
 156 #define DBGLVL_LOG      1
 157 #define DBG_LOG         ( DBGLVL & DBGLVL_LOG )
 158 #define DBGLVL_EXTRA    2
 159 #define DBG_EXTRA       ( DBGLVL & DBGLVL_EXTRA )
 160 #define DBGLVL_PROFILE  4
 161 #define DBG_PROFILE     ( DBGLVL & DBGLVL_PROFILE )
 162 #define DBGLVL_IO       8
 163 #define DBG_IO          ( DBGLVL & DBGLVL_IO )
 164
 165 /**
 166  * Print debugging message if we are at a certain debug level
 167  *
 168  * @v level             Debug level
 169  * @v ...               printf() argument list
 170  */
 171 #define DBG_IF( level, ... ) do {                               \
 172                 if ( DBG_ ## level ) {                          \
 173                         dbg_printf ( __VA_ARGS__ );             \
 174                 }                                               \
 175         } while ( 0 )
 176
 177 /**
 178  * Print a hex dump if we are at a certain debug level
 179  *
 180  * @v level             Debug level
 181  * @v dispaddr          Display address
 182  * @v data              Data to print
 183  * @v len               Length of data
 184  */
 185 #define DBG_HDA_IF( level, dispaddr, data, len )  do {          \
 186                 if ( DBG_ ## level ) {                          \
 187                         union {                                 \
 188                                 unsigned long ul;               \
 189                                 typeof ( dispaddr ) raw;        \
 190                         } da;                                   \
 191                         da.raw = dispaddr;                      \
 192                         dbg_hex_dump_da ( da.ul, data, len );   \
 193                 }                                               \
 194         } while ( 0 )
 195
 196 /**
 197  * Print a hex dump if we are at a certain debug level
 198  *
 199  * @v level             Debug level
 200  * @v data              Data to print
 201  * @v len               Length of data
 202  */
 203 #define DBG_HD_IF( level, data, len ) do {                      \
 204                 DBG_HDA_IF ( level, data, data, len );          \
 205         } while ( 0 )
 206
 207 /**
 208  * Select colour for debug messages if we are at a certain debug level
 209  *
 210  * @v level             Debug level
 211  * @v id                Message stream ID
 212  */
 213 #define DBG_AC_IF( level, id ) do {                             \
 214                 if ( DBG_ ## level ) {                          \
 215                         union {                                 \
 216                                 unsigned long ul;               \
 217                                 typeof ( id ) raw;              \
 218                         } dbg_stream;                           \
 219                         dbg_stream.raw = id;                    \
 220                         dbg_autocolourise ( dbg_stream.ul );    \
 221                 }                                               \
 222         } while ( 0 )
 223
 224 /**
 225  * Revert colour for debug messages if we are at a certain debug level
 226  *
 227  * @v level             Debug level
 228  */
 229 #define DBG_DC_IF( level ) do {                                 \
 230                 if ( DBG_ ## level ) {                          \
 231                         dbg_decolourise();                      \
 232                 }                                               \
 233         } while ( 0 )
 234
 235 /* Autocolourising versions of the DBGxxx_IF() macros */
 236
 237 #define DBGC_IF( level, id, ... ) do {                          \
 238                 DBG_AC_IF ( level, id );                        \
 239                 DBG_IF ( level, __VA_ARGS__ );                  \
 240                 DBG_DC_IF ( level );                            \
 241         } while ( 0 )
 242
 243 #define DBGC_HDA_IF( level, id, ... ) do {                      \
 244                 DBG_AC_IF ( level, id );                        \
 245                 DBG_HDA_IF ( level, __VA_ARGS__ );              \
 246                 DBG_DC_IF ( level );                            \
 247         } while ( 0 )
 248
 249 #define DBGC_HD_IF( level, id, ... ) do {                       \
 250                 DBG_AC_IF ( level, id );                        \
 251                 DBG_HD_IF ( level, __VA_ARGS__ );               \
 252                 DBG_DC_IF ( level );                            \
 253         } while ( 0 )
 254
 255 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( LOG, ... )*/
 256
 257 #define DBG( ... )              DBG_IF          ( LOG, __VA_ARGS__ )
 258 #define DBG_HDA( ... )          DBG_HDA_IF      ( LOG, __VA_ARGS__ )
 259 #define DBG_HD( ... )           DBG_HD_IF       ( LOG, __VA_ARGS__ )
 260 #define DBGC( ... )             DBGC_IF         ( LOG, __VA_ARGS__ )
 261 #define DBGC_HDA( ... )         DBGC_HDA_IF     ( LOG, __VA_ARGS__ )
 262 #define DBGC_HD( ... )          DBGC_HD_IF      ( LOG, __VA_ARGS__ )
 263
 264 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( EXTRA, ... )*/
 265
 266 #define DBG2( ... )             DBG_IF          ( EXTRA, __VA_ARGS__ )
 267 #define DBG2_HDA( ... )         DBG_HDA_IF      ( EXTRA, __VA_ARGS__ )
 268 #define DBG2_HD( ... )          DBG_HD_IF       ( EXTRA, __VA_ARGS__ )
 269 #define DBGC2( ... )            DBGC_IF         ( EXTRA, __VA_ARGS__ )
 270 #define DBGC2_HDA( ... )        DBGC_HDA_IF     ( EXTRA, __VA_ARGS__ )
 271 #define DBGC2_HD( ... )         DBGC_HD_IF      ( EXTRA, __VA_ARGS__ )
 272
 273 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( PROFILE, ... )*/
 274
 275 #define DBGP( ... )             DBG_IF          ( PROFILE, __VA_ARGS__ )
 276 #define DBGP_HDA( ... )         DBG_HDA_IF      ( PROFILE, __VA_ARGS__ )
 277 #define DBGP_HD( ... )          DBG_HD_IF       ( PROFILE, __VA_ARGS__ )
 278 #define DBGCP( ... )            DBGC_IF         ( PROFILE, __VA_ARGS__ )
 279 #define DBGCP_HDA( ... )        DBGC_HDA_IF     ( PROFILE, __VA_ARGS__ )
 280 #define DBGCP_HD( ... )         DBGC_HD_IF      ( PROFILE, __VA_ARGS__ )
 281
 282 /* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( IO, ... )*/
 283
 284 #define DBGIO( ... )            DBG_IF          ( IO, __VA_ARGS__ )
 285 #define DBGIO_HDA( ... )        DBG_HDA_IF      ( IO, __VA_ARGS__ )
 286 #define DBGIO_HD( ... )         DBG_HD_IF       ( IO, __VA_ARGS__ )
 287 #define DBGCIO( ... )           DBGC_IF         ( IO, __VA_ARGS__ )
 288 #define DBGCIO_HDA( ... )       DBGC_HDA_IF     ( IO, __VA_ARGS__ )
 289 #define DBGCIO_HD( ... )        DBGC_HD_IF      ( IO, __VA_ARGS__ )
 290
 291
 292 #if DEBUG_SYMBOL == 0
 293 #define NDEBUG
 294 #endif
 295
 296 /** Select file identifier for errno.h (if used) */
 297 #define ERRFILE PREFIX_OBJECT ( ERRFILE_ )
 298
 299 /** Declare a data structure as packed. */
 300 #define PACKED __attribute__ (( packed ))
 301
 302 /** Declare a variable or data structure as unused. */
 303 #define __unused __attribute__ (( unused ))
 304
 305 /** Apply standard C calling conventions */
 306 #define __cdecl __attribute__ (( cdecl , regparm(0) ))
 307
 308 /**
 309  * Declare a function as pure - i.e. without side effects
 310  */
 311 #define __pure __attribute__ (( pure ))
 312
 313 /**
 314  * Declare a function as const - i.e. it does not access global memory
 315  * (including dereferencing pointers passed to it) at all.
 316  * Must also not call any non-const functions.
 317  */
 318 #define __const __attribute__ (( const ))
 319
 320 /**
 321  * Declare a function's pointer parameters as non-null - i.e. force
 322  * compiler to check pointers at compile time and enable possible
 323  * optimizations based on that fact
 324  */
 325 #define __nonnull __attribute__ (( nonnull ))
 326
 327 /**
 328  * Declare a pointer returned by a function as a unique memory address
 329  * as returned by malloc-type functions.
 330  */
 331 #define __malloc __attribute__ (( malloc ))
 332
 333 /**
 334  * Declare a function as used.
 335  *
 336  * Necessary only if the function is called only from assembler code.
 337  */
 338 #define __used __attribute__ (( used ))
 339
 340 /** Declare a data structure to be aligned with 16-byte alignment */
 341 #define __aligned __attribute__ (( aligned ( 16 ) ))
 342
 343 /** Declare a function to be always inline */
 344 #define __always_inline __attribute__ (( always_inline ))
 345
 346 /**
 347  * Shared data.
 348  *
 349  * To save space in the binary when multiple-driver images are
 350  * compiled, uninitialised data areas can be shared between drivers.
 351  * This will typically be used to share statically-allocated receive
 352  * and transmit buffers between drivers.
 353  *
 354  * Use as e.g.
 355  *
 356  * @code
 357  *
 358  *   struct {
 359  *      char    rx_buf[NUM_RX_BUF][RX_BUF_SIZE];
 360  *      char    tx_buf[TX_BUF_SIZE];
 361  *   } my_static_data __shared;
 362  *
 363  * @endcode
 364  *
 365  */
 366 #define __shared __asm__ ( "_shared_bss" ) __aligned
 367
 368 /**
 369  * Optimisation barrier
 370  */
 371 #define barrier() __asm__ __volatile__ ( "" : : : "memory" )
 372
 373 #endif /* ASSEMBLY */
 374
 375 #endif /* COMPILER_H */