2
0
mirror of https://github.com/xcat2/xNBA.git synced 2024-12-14 15:21:32 +00:00
xNBA/src/include/compiler.h
2007-07-24 17:11:31 +01:00

314 lines
8.2 KiB
C

#ifndef COMPILER_H
#define COMPILER_H
/*
* Doxygen can't cope with some of the more esoteric areas of C, so we
* make its life simpler.
*
*/
#ifdef DOXYGEN
#define __attribute__(x)
#endif
/** @file
*
* Global compiler definitions.
*
* This file is implicitly included by every @c .c file in Etherboot.
* It defines global macros such as DBG().
*
* We arrange for each object to export the symbol @c obj_OBJECT
* (where @c OBJECT is the object name, e.g. @c rtl8139) as a global
* symbol, so that the linker can drag in selected object files from
* the library using <tt> -u obj_OBJECT </tt>.
*
*/
/* Not quite sure why cpp requires two levels of macro call in order
* to actually expand OBJECT...
*/
#undef _H1
#define _H1( x, y ) x ## y
#undef _H2
#define _H2( x, y ) _H1 ( x, y )
#define PREFIX_OBJECT(prefix) _H2 ( prefix, OBJECT )
#define OBJECT_SYMBOL PREFIX_OBJECT(obj_)
#undef _STR
#define _STR(s) #s
#undef _XSTR
#define _XSTR(s) _STR(s)
#define OBJECT_SYMBOL_STR _XSTR ( OBJECT_SYMBOL )
#ifdef ASSEMBLY
.globl OBJECT_SYMBOL
.equ OBJECT_SYMBOL, 0
#else /* ASSEMBLY */
__asm__ ( ".globl\t" OBJECT_SYMBOL_STR );
__asm__ ( ".equ\t" OBJECT_SYMBOL_STR ", 0" );
/**
* Drag in an object by object name.
*
* Macro to allow objects to explicitly drag in other objects by
* object name. Used by config.c.
*
*/
#define REQUIRE_OBJECT(object) \
__asm__ ( ".equ\tneed_" #object ", obj_" #object );
/** @def DBG
*
* Print a debugging message.
*
* The debug level is set at build time by specifying the @c DEBUG=
* parameter on the @c make command line. For example, to enable
* debugging for the PCI bus functions (in pci.c) in a @c .dsk image
* for the @c rtl8139 card, you could use the command line
*
* @code
*
* make bin/rtl8139.dsk DEBUG=pci
*
* @endcode
*
* This will enable the debugging statements (DBG()) in pci.c. If
* debugging is not enabled, DBG() statements will be ignored.
*
* You can enable debugging in several objects simultaneously by
* separating them with commas, as in
*
* @code
*
* make bin/rtl8139.dsk DEBUG=pci,buffer,heap
*
* @endcode
*
* You can increase the debugging level for an object by specifying it
* with @c :N, where @c N is the level, as in
*
* @code
*
* make bin/rtl8139.dsk DEBUG=pci,buffer:2,heap
*
* @endcode
*
* which would enable debugging for the PCI, buffer-handling and
* heap-allocation code, with the buffer-handling code at level 2.
*
*/
/*
* If debug_OBJECT is set to a true value, the macro DBG(...) will
* expand to printf(...) when compiling OBJECT, and the symbol
* DEBUG_LEVEL will be inserted into the object file.
*
*/
#define DEBUG_SYMBOL PREFIX_OBJECT(debug_)
#if DEBUG_SYMBOL
#define DEBUG_SYMBOL_STR _XSTR ( DEBUG_SYMBOL )
__asm__ ( ".equ\tDBGLVL, " DEBUG_SYMBOL_STR );
#endif
/** printf() for debugging
*
* This function exists so that the DBG() macros can expand to
* printf() calls without dragging the printf() prototype into scope.
*
* As far as the compiler is concerned, dbg_printf() and printf() are
* completely unrelated calls; it's only at the assembly stage that
* references to the dbg_printf symbol are collapsed into references
* to the printf symbol.
*/
extern int __attribute__ (( format ( printf, 1, 2 ) ))
dbg_printf ( const char *fmt, ... ) asm ( "printf" );
extern void dbg_autocolourise ( unsigned long id );
extern void dbg_decolourise ( void );
extern void dbg_hex_dump_da ( unsigned long dispaddr,
const void *data, unsigned long len );
/* Compatibility with existing Makefile */
#if DEBUG_SYMBOL
#define DBGLVL DEBUG_SYMBOL
#else
#define DBGLVL 0
#endif
#define DBGLVL_LOG 1
#define DBG_LOG ( DBGLVL & DBGLVL_LOG )
#define DBGLVL_EXTRA 2
#define DBG_EXTRA ( DBGLVL & DBGLVL_EXTRA )
#define DBGLVL_PROFILE 4
#define DBG_PROFILE ( DBGLVL & DBGLVL_PROFILE )
/**
* Print debugging message if we are at a certain debug level
*
* @v level Debug level
* @v ... printf() argument list
*/
#define DBG_IF( level, ... ) do { \
if ( DBG_ ## level ) { \
dbg_printf ( __VA_ARGS__ ); \
} \
} while ( 0 )
/**
* Print a hex dump if we are at a certain debug level
*
* @v level Debug level
* @v dispaddr Display address
* @v data Data to print
* @v len Length of data
*/
#define DBG_HDA_IF( level, dispaddr, data, len ) do { \
if ( DBG_ ## level ) { \
union { \
unsigned long ul; \
typeof ( dispaddr ) raw; \
} da; \
da.raw = dispaddr; \
dbg_hex_dump_da ( da.ul, data, len ); \
} \
} while ( 0 )
/**
* Print a hex dump if we are at a certain debug level
*
* @v level Debug level
* @v data Data to print
* @v len Length of data
*/
#define DBG_HD_IF( level, data, len ) do { \
DBG_HDA_IF ( level, data, data, len ); \
} while ( 0 )
/**
* Select colour for debug messages if we are at a certain debug level
*
* @v level Debug level
* @v id Message stream ID
*/
#define DBG_AC_IF( level, id ) do { \
if ( DBG_ ## level ) { \
union { \
unsigned long ul; \
typeof ( id ) raw; \
} dbg_stream; \
dbg_stream.raw = id; \
dbg_autocolourise ( dbg_stream.ul ); \
} \
} while ( 0 )
/**
* Revert colour for debug messages if we are at a certain debug level
*
* @v level Debug level
*/
#define DBG_DC_IF( level ) do { \
if ( DBG_ ## level ) { \
dbg_decolourise(); \
} \
} while ( 0 )
/* Autocolourising versions of the DBGxxx_IF() macros */
#define DBGC_IF( level, id, ... ) do { \
DBG_AC_IF ( level, id ); \
DBG_IF ( level, __VA_ARGS__ ); \
DBG_DC_IF ( level ); \
} while ( 0 )
#define DBGC_HDA_IF( level, id, ... ) do { \
DBG_AC_IF ( level, id ); \
DBG_HDA_IF ( level, __VA_ARGS__ ); \
DBG_DC_IF ( level ); \
} while ( 0 )
#define DBGC_HD_IF( level, id, ... ) do { \
DBG_AC_IF ( level, id ); \
DBG_HD_IF ( level, __VA_ARGS__ ); \
DBG_DC_IF ( level ); \
} while ( 0 )
/* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( LOG, ... )*/
#define DBG( ... ) DBG_IF ( LOG, __VA_ARGS__ )
#define DBG_HDA( ... ) DBG_HDA_IF ( LOG, __VA_ARGS__ )
#define DBG_HD( ... ) DBG_HD_IF ( LOG, __VA_ARGS__ )
#define DBGC( ... ) DBGC_IF ( LOG, __VA_ARGS__ )
#define DBGC_HDA( ... ) DBGC_HDA_IF ( LOG, __VA_ARGS__ )
#define DBGC_HD( ... ) DBGC_HD_IF ( LOG, __VA_ARGS__ )
/* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( EXTRA, ... )*/
#define DBG2( ... ) DBG_IF ( EXTRA, __VA_ARGS__ )
#define DBG2_HDA( ... ) DBG_HDA_IF ( EXTRA, __VA_ARGS__ )
#define DBG2_HD( ... ) DBG_HD_IF ( EXTRA, __VA_ARGS__ )
#define DBGC2( ... ) DBGC_IF ( EXTRA, __VA_ARGS__ )
#define DBGC2_HDA( ... ) DBGC_HDA_IF ( EXTRA, __VA_ARGS__ )
#define DBGC2_HD( ... ) DBGC_HD_IF ( EXTRA, __VA_ARGS__ )
/* Versions of the DBGxxx_IF() macros that imply DBGxxx_IF( PROFILE, ... )*/
#define DBGP( ... ) DBG_IF ( PROFILE, __VA_ARGS__ )
#define DBGP_HDA( ... ) DBG_HDA_IF ( PROFILE, __VA_ARGS__ )
#define DBGP_HD( ... ) DBG_HD_IF ( PROFILE, __VA_ARGS__ )
#define DBGCP( ... ) DBGC_IF ( PROFILE, __VA_ARGS__ )
#define DBGCP_HDA( ... ) DBGC_HDA_IF ( PROFILE, __VA_ARGS__ )
#define DBGCP_HD( ... ) DBGC_HD_IF ( PROFILE, __VA_ARGS__ )
#if DEBUG_SYMBOL == 0
#define NDEBUG
#endif
/** Select file identifier for errno.h (if used) */
#define ERRFILE PREFIX_OBJECT ( ERRFILE_ )
/** Declare a data structure as packed. */
#define PACKED __attribute__ (( packed ))
/** Declare a variable or data structure as unused. */
#define __unused __attribute__ (( unused ))
/**
* Declare a function as used.
*
* Necessary only if the function is called only from assembler code.
*/
#define __used __attribute__ (( used ))
/** Declare a data structure to be aligned with 16-byte alignment */
#define __aligned __attribute__ (( aligned ( 16 ) ))
/**
* Shared data.
*
* To save space in the binary when multiple-driver images are
* compiled, uninitialised data areas can be shared between drivers.
* This will typically be used to share statically-allocated receive
* and transmit buffers between drivers.
*
* Use as e.g.
*
* @code
*
* struct {
* char rx_buf[NUM_RX_BUF][RX_BUF_SIZE];
* char tx_buf[TX_BUF_SIZE];
* } my_static_data __shared;
*
* @endcode
*
*/
#define __shared __asm__ ( "_shared_bss" )
#endif /* ASSEMBLY */
#endif /* COMPILER_H */