FreeBSD/Linux Kernel Cross Reference
sys/sys/cdefs.h
1 /*
2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * This code is derived from software contributed to Berkeley by
6 * Berkeley Software Design, Inc.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * @(#)cdefs.h 8.8 (Berkeley) 1/9/95
37 * $FreeBSD: releng/5.1/sys/sys/cdefs.h 113679 2003-04-18 18:59:34Z bde $
38 */
39
40 #ifndef _SYS_CDEFS_H_
41 #define _SYS_CDEFS_H_
42
43 #if defined(__cplusplus)
44 #define __BEGIN_DECLS extern "C" {
45 #define __END_DECLS }
46 #else
47 #define __BEGIN_DECLS
48 #define __END_DECLS
49 #endif
50
51 /*
52 * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
53 * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
54 * The __CONCAT macro is a bit tricky to use if it must work in non-ANSI
55 * mode -- there must be no spaces between its arguments, and for nested
56 * __CONCAT's, all the __CONCAT's must be at the left. __CONCAT can also
57 * concatenate double-quoted strings produced by the __STRING macro, but
58 * this only works with ANSI C.
59 *
60 * __XSTRING is like __STRING, but it expands any macros in its argument
61 * first. It is only available with ANSI C.
62 */
63 #if defined(__STDC__) || defined(__cplusplus)
64 #define __P(protos) protos /* full-blown ANSI C */
65 #define __CONCAT1(x,y) x ## y
66 #define __CONCAT(x,y) __CONCAT1(x,y)
67 #define __STRING(x) #x /* stringify without expanding x */
68 #define __XSTRING(x) __STRING(x) /* expand x, then stringify */
69
70 #define __const const /* define reserved names to standard */
71 #define __signed signed
72 #define __volatile volatile
73 #if defined(__cplusplus)
74 #define __inline inline /* convert to C++ keyword */
75 #else
76 #ifndef __GNUC__
77 #define __inline /* delete GCC keyword */
78 #endif /* !__GNUC__ */
79 #endif /* !__cplusplus */
80
81 #else /* !(__STDC__ || __cplusplus) */
82 #define __P(protos) () /* traditional C preprocessor */
83 #define __CONCAT(x,y) x/**/y
84 #define __STRING(x) "x"
85
86 #ifndef __GNUC__
87 #define __const /* delete pseudo-ANSI C keywords */
88 #define __inline
89 #define __signed
90 #define __volatile
91 /*
92 * In non-ANSI C environments, new programs will want ANSI-only C keywords
93 * deleted from the program and old programs will want them left alone.
94 * When using a compiler other than gcc, programs using the ANSI C keywords
95 * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
96 * When using "gcc -traditional", we assume that this is the intent; if
97 * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
98 */
99 #ifndef NO_ANSI_KEYWORDS
100 #define const /* delete ANSI C keywords */
101 #define inline
102 #define signed
103 #define volatile
104 #endif /* !NO_ANSI_KEYWORDS */
105 #endif /* !__GNUC__ */
106 #endif /* !(__STDC__ || __cplusplus) */
107
108 /*
109 * Compiler-dependent macros to help declare dead (non-returning) and
110 * pure (no side effects) functions, and unused variables. They are
111 * null except for versions of gcc that are known to support the features
112 * properly (old versions of gcc-2 supported the dead and pure features
113 * in a different (wrong) way). If we do not provide an implementation
114 * for a given compiler, let the compile fail if it is told to use
115 * a feature that we cannot live without.
116 */
117 #ifdef lint
118 #define __dead2
119 #define __pure2
120 #define __unused
121 #define __packed
122 #define __aligned(x)
123 #define __section(x)
124 #else
125 #if __GNUC__ < 2 || __GNUC__ == 2 && __GNUC_MINOR__ < 5
126 #define __dead2
127 #define __pure2
128 #define __unused
129 #endif
130 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 && __GNUC_MINOR__ < 7
131 #define __dead2 __attribute__((__noreturn__))
132 #define __pure2 __attribute__((__const__))
133 #define __unused
134 /* XXX Find out what to do for __packed, __aligned and __section */
135 #endif
136 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ == 3
137 #define __dead2 __attribute__((__noreturn__))
138 #define __pure2 __attribute__((__const__))
139 #define __unused __attribute__((__unused__))
140 #define __packed __attribute__((__packed__))
141 #define __aligned(x) __attribute__((__aligned__(x)))
142 #define __section(x) __attribute__((__section__(x)))
143 #endif
144 #endif
145
146 /* XXX: should use `#if __STDC_VERSION__ < 199901'. */
147 #if !(__GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3)
148 #define __func__ NULL
149 #endif
150
151 #if __GNUC__ >= 2 && !defined(__STRICT_ANSI__) || __STDC_VERSION__ >= 199901
152 #define __LONG_LONG_SUPPORTED
153 #endif
154
155 /*
156 * GCC 2.95 provides `__restrict' as an extension to C90 to support the
157 * C99-specific `restrict' type qualifier. We happen to use `__restrict' as
158 * a way to define the `restrict' type qualifier without disturbing older
159 * software that is unaware of C99 keywords.
160 */
161 #if !(__GNUC__ == 2 && __GNUC_MINOR__ == 95)
162 #if __STDC_VERSION__ < 199901
163 #define __restrict
164 #else
165 #define __restrict restrict
166 #endif
167 #endif
168
169 /*
170 * We define this here since <stddef.h>, <sys/queue.h>, and <sys/types.h>
171 * require it.
172 */
173 #define __offsetof(type, field) ((size_t)(&((type *)0)->field))
174
175 /*
176 * Compiler-dependent macros to declare that functions take printf-like
177 * or scanf-like arguments. They are null except for versions of gcc
178 * that are known to support the features properly (old versions of gcc-2
179 * didn't permit keeping the keywords out of the application namespace).
180 */
181 #if __GNUC__ < 2 || __GNUC__ == 2 && __GNUC_MINOR__ < 7
182 #define __printflike(fmtarg, firstvararg)
183 #define __scanflike(fmtarg, firstvararg)
184 #else
185 #define __printflike(fmtarg, firstvararg) \
186 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
187 #define __scanflike(fmtarg, firstvararg) \
188 __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
189 #endif
190
191 /* Compiler-dependent macros that rely on FreeBSD-specific extensions. */
192 #if __FreeBSD_cc_version >= 300001
193 #define __printf0like(fmtarg, firstvararg) \
194 __attribute__((__format__ (__printf0__, fmtarg, firstvararg)))
195 #else
196 #define __printf0like(fmtarg, firstvararg)
197 #endif
198
199 #ifdef __GNUC__
200 #define __strong_reference(sym,aliassym) \
201 extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym)));
202 #ifdef __STDC__
203 #define __weak_reference(sym,alias) \
204 __asm__(".weak " #alias); \
205 __asm__(".equ " #alias ", " #sym)
206 #define __warn_references(sym,msg) \
207 __asm__(".section .gnu.warning." #sym); \
208 __asm__(".asciz \"" msg "\""); \
209 __asm__(".previous")
210 #else
211 #define __weak_reference(sym,alias) \
212 __asm__(".weak alias"); \
213 __asm__(".equ alias, sym")
214 #define __warn_references(sym,msg) \
215 __asm__(".section .gnu.warning.sym"); \
216 __asm__(".asciz \"msg\""); \
217 __asm__(".previous")
218 #endif /* __STDC__ */
219 #endif /* __GNUC__ */
220
221 #ifdef __GNUC__
222 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"")
223 #else
224 /*
225 * This doesn't work in header files. But it may be better than nothing.
226 * The alternative is: #define __IDSTRING(name,string) [nothing]
227 */
228 #define __IDSTRING(name,string) static const char name[] __unused = string
229 #endif
230
231 /*
232 * Embed the rcs id of a source file in the resulting library. Note that in
233 * more recent ELF binutils, we use .ident allowing the ID to be stripped.
234 * Usage:
235 * __FBSDID("$FreeBSD: releng/5.1/sys/sys/cdefs.h 113679 2003-04-18 18:59:34Z bde $");
236 */
237 #ifndef __FBSDID
238 #if !defined(lint) && !defined(STRIP_FBSDID)
239 #define __FBSDID(s) __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
240 #else
241 #define __FBSDID(s) struct __hack
242 #endif
243 #endif
244
245 #ifndef __RCSID
246 #ifndef NO__RCSID
247 #define __RCSID(s) __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
248 #else
249 #define __RCSID(s)
250 #endif
251 #endif
252
253 #ifndef __RCSID_SOURCE
254 #ifndef NO__RCSID_SOURCE
255 #define __RCSID_SOURCE(s) __IDSTRING(__CONCAT(__rcsid_source_,__LINE__),s)
256 #else
257 #define __RCSID_SOURCE(s)
258 #endif
259 #endif
260
261 #ifndef __SCCSID
262 #ifndef NO__SCCSID
263 #define __SCCSID(s) __IDSTRING(__CONCAT(__sccsid_,__LINE__),s)
264 #else
265 #define __SCCSID(s)
266 #endif
267 #endif
268
269 #ifndef __COPYRIGHT
270 #ifndef NO__COPYRIGHT
271 #define __COPYRIGHT(s) __IDSTRING(__CONCAT(__copyright_,__LINE__),s)
272 #else
273 #define __COPYRIGHT(s)
274 #endif
275 #endif
276
277 #ifndef __DECONST
278 #define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var))
279 #endif
280
281 #ifndef __DEVOLATILE
282 #define __DEVOLATILE(type, var) ((type)(uintptr_t)(volatile void *)(var))
283 #endif
284
285 #ifndef __DEQUALIFY
286 #define __DEQUALIFY(type, var) ((type)(uintptr_t)(const volatile void *)(var))
287 #endif
288
289 /*-
290 * The following definitions are an extension of the behavior originally
291 * implemented in <sys/_posix.h>, but with a different level of granularity.
292 * POSIX.1 requires that the macros we test be defined before any standard
293 * header file is included.
294 *
295 * Here's a quick run-down of the versions:
296 * defined(_POSIX_SOURCE) 1003.1-1988
297 * _POSIX_C_SOURCE == 1 1003.1-1990
298 * _POSIX_C_SOURCE == 2 1003.2-1992 C Language Binding Option
299 * _POSIX_C_SOURCE == 199309 1003.1b-1993
300 * _POSIX_C_SOURCE == 199506 1003.1c-1995, 1003.1i-1995,
301 * and the omnibus ISO/IEC 9945-1: 1996
302 * _POSIX_C_SOURCE == 200112 1003.1-2001
303 *
304 * In addition, the X/Open Portability Guide, which is now the Single UNIX
305 * Specification, defines a feature-test macro which indicates the version of
306 * that specification, and which subsumes _POSIX_C_SOURCE.
307 *
308 * Our macros begin with two underscores to avoid namespace screwage.
309 */
310
311 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */
312 #if _POSIX_C_SOURCE == 1
313 #undef _POSIX_C_SOURCE /* Probably illegal, but beyond caring now. */
314 #define _POSIX_C_SOURCE 199009
315 #endif
316
317 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */
318 #if _POSIX_C_SOURCE == 2
319 #undef _POSIX_C_SOURCE
320 #define _POSIX_C_SOURCE 199209
321 #endif
322
323 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
324 #ifdef _XOPEN_SOURCE
325 #if _XOPEN_SOURCE - 0 >= 600
326 #define __XSI_VISIBLE 600
327 #undef _POSIX_C_SOURCE
328 #define _POSIX_C_SOURCE 200112
329 #elif _XOPEN_SOURCE - 0 >= 500
330 #define __XSI_VISIBLE 500
331 #undef _POSIX_C_SOURCE
332 #define _POSIX_C_SOURCE 199506
333 #endif
334 #endif
335
336 /*
337 * Deal with all versions of POSIX. The ordering relative to the tests above is
338 * important.
339 */
340 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
341 #define _POSIX_C_SOURCE 198808
342 #endif
343 #ifdef _POSIX_C_SOURCE
344 #if _POSIX_C_SOURCE >= 200112
345 #define __POSIX_VISIBLE 200112
346 #define __ISO_C_VISIBLE 1999
347 #elif _POSIX_C_SOURCE >= 199506
348 #define __POSIX_VISIBLE 199506
349 #define __ISO_C_VISIBLE 1990
350 #elif _POSIX_C_SOURCE >= 199309
351 #define __POSIX_VISIBLE 199309
352 #define __ISO_C_VISIBLE 1990
353 #elif _POSIX_C_SOURCE >= 199209
354 #define __POSIX_VISIBLE 199209
355 #define __ISO_C_VISIBLE 1990
356 #elif _POSIX_C_SOURCE >= 199009
357 #define __POSIX_VISIBLE 199009
358 #define __ISO_C_VISIBLE 1990
359 #else
360 #define __POSIX_VISIBLE 198808
361 #define __ISO_C_VISIBLE 0
362 #endif /* _POSIX_C_SOURCE */
363 #else
364 /*-
365 * Deal with _ANSI_SOURCE:
366 * If it is defined, and no other compilation environment is explicitly
367 * requested, then define our internal feature-test macros to zero. This
368 * makes no difference to the preprocessor (undefined symbols in preprocessing
369 * expressions are defined to have value zero), but makes it more convenient for
370 * a test program to print out the values.
371 *
372 * If a program mistakenly defines _ANSI_SOURCE and some other macro such as
373 * _POSIX_C_SOURCE, we will assume that it wants the broader compilation
374 * environment (and in fact we will never get here).
375 */
376 #if defined(_ANSI_SOURCE) /* Hide almost everything. */
377 #define __POSIX_VISIBLE 0
378 #define __XSI_VISIBLE 0
379 #define __BSD_VISIBLE 0
380 #define __ISO_C_VISIBLE 1990
381 #elif defined(_C99_SOURCE) /* Localism to specify strict C99 env. */
382 #define __POSIX_VISIBLE 0
383 #define __XSI_VISIBLE 0
384 #define __BSD_VISIBLE 0
385 #define __ISO_C_VISIBLE 1999
386 #else /* Default environment: show everything. */
387 #define __POSIX_VISIBLE 200112
388 #define __XSI_VISIBLE 600
389 #define __BSD_VISIBLE 1
390 #define __ISO_C_VISIBLE 1999
391 #endif
392 #endif
393
394 #endif /* !_SYS_CDEFS_H_ */
Cache object: e27ed9326d4b21890d03e5771d8039e4
|