f4ea32eecb65189a8a59ee27f86fb3d4d1511047
[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 /** @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 /** @def DBG2
104  *
105  * Print a level 2 debugging message.
106  *
107  * As for DBG().  DBG2() takes effect only when the debugging level is
108  * 2 or greater.
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 #include "console.h"
122 #define DEBUG_SYMBOL_STR _XSTR ( DEBUG_SYMBOL )
123 __asm__ ( ".equ\tDEBUG_LEVEL, " DEBUG_SYMBOL_STR );
124 #endif
125
126 /** Do not print
127  *
128  * This function is used only for printf()-style format string
129  * checking.  The function body does not exist, and no reference to it
130  * should ever appear in any compiled object.
131  */
132 extern int __attribute__ (( format ( printf, 1, 2 ) ))
133 __do_not_printf ( const char *fmt, ... );
134
135 #define DBG_PRINT(...) printf ( __VA_ARGS__ )
136 #define DBG_DISCARD(...) do {                                   \
137                 if ( 0 ) __do_not_printf ( __VA_ARGS__ );       \
138         } while ( 0 )
139
140 #define DBG  DBG_DISCARD
141 #define DBG2 DBG_DISCARD
142
143 #if DEBUG_SYMBOL >= 1
144 #undef DBG
145 #define DBG DBG_PRINT
146 #endif
147
148 #if DEBUG_SYMBOL >= 2
149 #undef DBG2
150 #define DBG2 DBG_PRINT
151 #endif
152
153 #if DEBUG_SYMBOL == 0
154 #define NDEBUG
155 #endif
156
157 /** Declare a data structure as packed. */
158 #define PACKED __attribute__ (( packed ))
159
160 /** 
161  * Declare a variable or data structure as unused.
162  *
163  * Note that using #__unused on a static global variable (such as a
164  * table structure as mentioned in tables.h) is necessary in order to
165  * inhibit compiler warnings.
166  *
167  */
168 #define __unused __attribute__ (( unused ))
169
170 /**
171  * Declare a function as used.
172  *
173  * Necessary only if the function is called only from assembler code.
174  * You cannot use this attribute for static global variables; use
175  * #__unused instead.
176  *
177  */
178 #define __used __attribute__ (( used ))
179
180 /** Declare a data structure to be aligned with 16-byte alignment */
181 #define __aligned __attribute__ (( aligned ( 16 ) ))
182
183 /**
184  * Shared data.
185  *
186  * To save space in the binary when multiple-driver images are
187  * compiled, uninitialised data areas can be shared between drivers.
188  * This will typically be used to share statically-allocated receive
189  * and transmit buffers between drivers.
190  *
191  * Use as e.g.
192  *
193  * @code
194  *
195  *   struct {
196  *      char    rx_buf[NUM_RX_BUF][RX_BUF_SIZE];
197  *      char    tx_buf[TX_BUF_SIZE];
198  *   } my_static_data __shared;
199  *
200  * @endcode
201  *
202  */
203 #define __shared __asm__ ( "_shared_bss" )
204
205 #endif /* ASSEMBLY */
206
207 #endif /* COMPILER_H */