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 * 4. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 * @(#)cdefs.h 8.8 (Berkeley) 1/9/95
33 * $FreeBSD$
34 */
35
36 #ifndef _SYS_CDEFS_H_
37 #define _SYS_CDEFS_H_
38
39 #if defined(__cplusplus)
40 #define __BEGIN_DECLS extern "C" {
41 #define __END_DECLS }
42 #else
43 #define __BEGIN_DECLS
44 #define __END_DECLS
45 #endif
46
47 /*
48 * This code has been put in place to help reduce the addition of
49 * compiler specific defines in FreeBSD code. It helps to aid in
50 * having a compiler-agnostic source tree.
51 */
52
53 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
54
55 #if __GNUC__ >= 3 || defined(__INTEL_COMPILER)
56 #define __GNUCLIKE_ASM 3
57 #define __GNUCLIKE_MATH_BUILTIN_CONSTANTS
58 #else
59 #define __GNUCLIKE_ASM 2
60 #endif
61 #define __GNUCLIKE___TYPEOF 1
62 #define __GNUCLIKE___OFFSETOF 1
63 #define __GNUCLIKE___SECTION 1
64
65 #define __GNUCLIKE_ATTRIBUTE_MODE_DI 1
66
67 #ifndef __INTEL_COMPILER
68 # define __GNUCLIKE_CTOR_SECTION_HANDLING 1
69 #endif
70
71 #define __GNUCLIKE_BUILTIN_CONSTANT_P 1
72 # if defined(__INTEL_COMPILER) && defined(__cplusplus) \
73 && __INTEL_COMPILER < 800
74 # undef __GNUCLIKE_BUILTIN_CONSTANT_P
75 # endif
76
77 #if (__GNUC_MINOR__ > 95 || __GNUC__ >= 3) && !defined(__INTEL_COMPILER)
78 # define __GNUCLIKE_BUILTIN_VARARGS 1
79 # define __GNUCLIKE_BUILTIN_STDARG 1
80 # define __GNUCLIKE_BUILTIN_VAALIST 1
81 #endif
82
83 #if defined(__GNUC__)
84 # define __GNUC_VA_LIST_COMPATIBILITY 1
85 #endif
86
87 #ifndef __INTEL_COMPILER
88 # define __GNUCLIKE_BUILTIN_NEXT_ARG 1
89 # define __GNUCLIKE_MATH_BUILTIN_RELOPS
90 #endif
91
92 #define __GNUCLIKE_BUILTIN_MEMCPY 1
93
94 /* XXX: if __GNUC__ >= 2: not tested everywhere originally, where replaced */
95 #define __CC_SUPPORTS_INLINE 1
96 #define __CC_SUPPORTS___INLINE 1
97 #define __CC_SUPPORTS___INLINE__ 1
98
99 #define __CC_SUPPORTS___FUNC__ 1
100 #define __CC_SUPPORTS_WARNING 1
101
102 #define __CC_SUPPORTS_VARADIC_XXX 1 /* see varargs.h */
103
104 #define __CC_SUPPORTS_DYNAMIC_ARRAY_INIT 1
105
106 /* XXX: sys/dev/mpt/mpilib/mpi_type.h uses it, someone should review it */
107 #define __CC_INT_IS_32BIT 1
108
109 #endif /* __GNUC__ || __INTEL_COMPILER */
110
111 /*
112 * Macro to test if we're using a specific version of gcc or later.
113 */
114 #if defined(__GNUC__) && !defined(__INTEL_COMPILER)
115 #define __GNUC_PREREQ__(ma, mi) \
116 (__GNUC__ > (ma) || __GNUC__ == (ma) && __GNUC_MINOR__ >= (mi))
117 #else
118 #define __GNUC_PREREQ__(ma, mi) 0
119 #endif
120
121 /*
122 * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
123 * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
124 * The __CONCAT macro is a bit tricky to use if it must work in non-ANSI
125 * mode -- there must be no spaces between its arguments, and for nested
126 * __CONCAT's, all the __CONCAT's must be at the left. __CONCAT can also
127 * concatenate double-quoted strings produced by the __STRING macro, but
128 * this only works with ANSI C.
129 *
130 * __XSTRING is like __STRING, but it expands any macros in its argument
131 * first. It is only available with ANSI C.
132 */
133 #if defined(__STDC__) || defined(__cplusplus)
134 #define __P(protos) protos /* full-blown ANSI C */
135 #define __CONCAT1(x,y) x ## y
136 #define __CONCAT(x,y) __CONCAT1(x,y)
137 #define __STRING(x) #x /* stringify without expanding x */
138 #define __XSTRING(x) __STRING(x) /* expand x, then stringify */
139
140 #define __const const /* define reserved names to standard */
141 #define __signed signed
142 #define __volatile volatile
143 #if defined(__cplusplus)
144 #define __inline inline /* convert to C++ keyword */
145 #else
146 #if !(defined(__CC_SUPPORTS___INLINE))
147 #define __inline /* delete GCC keyword */
148 #endif /* ! __CC_SUPPORTS___INLINE */
149 #endif /* !__cplusplus */
150
151 #else /* !(__STDC__ || __cplusplus) */
152 #define __P(protos) () /* traditional C preprocessor */
153 #define __CONCAT(x,y) x/**/y
154 #define __STRING(x) "x"
155
156 #if !defined(__CC_SUPPORTS___INLINE)
157 #define __const /* delete pseudo-ANSI C keywords */
158 #define __inline
159 #define __signed
160 #define __volatile
161 /*
162 * In non-ANSI C environments, new programs will want ANSI-only C keywords
163 * deleted from the program and old programs will want them left alone.
164 * When using a compiler other than gcc, programs using the ANSI C keywords
165 * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
166 * When using "gcc -traditional", we assume that this is the intent; if
167 * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
168 */
169 #ifndef NO_ANSI_KEYWORDS
170 #define const /* delete ANSI C keywords */
171 #define inline
172 #define signed
173 #define volatile
174 #endif /* !NO_ANSI_KEYWORDS */
175 #endif /* !__CC_SUPPORTS___INLINE */
176 #endif /* !(__STDC__ || __cplusplus) */
177
178 /*
179 * Compiler-dependent macros to help declare dead (non-returning) and
180 * pure (no side effects) functions, and unused variables. They are
181 * null except for versions of gcc that are known to support the features
182 * properly (old versions of gcc-2 supported the dead and pure features
183 * in a different (wrong) way). If we do not provide an implementation
184 * for a given compiler, let the compile fail if it is told to use
185 * a feature that we cannot live without.
186 */
187 #ifdef lint
188 #define __dead2
189 #define __pure2
190 #define __unused
191 #define __packed
192 #define __aligned(x)
193 #define __section(x)
194 #else
195 #if !__GNUC_PREREQ__(2, 5) && !defined(__INTEL_COMPILER)
196 #define __dead2
197 #define __pure2
198 #define __unused
199 #endif
200 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 && __GNUC_MINOR__ < 7 && !defined(__INTEL_COMPILER)
201 #define __dead2 __attribute__((__noreturn__))
202 #define __pure2 __attribute__((__const__))
203 #define __unused
204 /* XXX Find out what to do for __packed, __aligned and __section */
205 #endif
206 #if __GNUC_PREREQ__(2, 7)
207 #define __dead2 __attribute__((__noreturn__))
208 #define __pure2 __attribute__((__const__))
209 #define __unused __attribute__((__unused__))
210 #define __used __attribute__((__used__))
211 #define __packed __attribute__((__packed__))
212 #define __aligned(x) __attribute__((__aligned__(x)))
213 #define __section(x) __attribute__((__section__(x)))
214 #endif
215 #if defined(__INTEL_COMPILER)
216 #define __dead2 __attribute__((__noreturn__))
217 #define __pure2 __attribute__((__const__))
218 #define __unused __attribute__((__unused__))
219 #define __used __attribute__((__used__))
220 #define __packed __attribute__((__packed__))
221 #define __aligned(x) __attribute__((__aligned__(x)))
222 #define __section(x) __attribute__((__section__(x)))
223 #endif
224 #endif
225
226 #if __GNUC_PREREQ__(2, 96)
227 #define __pure __attribute__((__pure__))
228 #else
229 #define __pure
230 #endif
231
232 #if __GNUC_PREREQ__(3, 1) || (defined(__INTEL_COMPILER) && __INTEL_COMPILER >= 800)
233 #define __always_inline __attribute__((__always_inline__))
234 #else
235 #define __always_inline
236 #endif
237
238 #if __GNUC_PREREQ__(3, 3)
239 #define __nonnull(x) __attribute__((__nonnull__(x)))
240 #else
241 #define __nonnull(x)
242 #endif
243
244 /* XXX: should use `#if __STDC_VERSION__ < 199901'. */
245 #if !__GNUC_PREREQ__(2, 7) && !defined(__INTEL_COMPILER)
246 #define __func__ NULL
247 #endif
248
249 #if (defined(__INTEL_COMPILER) || (defined(__GNUC__) && __GNUC__ >= 2)) && !defined(__STRICT_ANSI__) || __STDC_VERSION__ >= 199901
250 #define __LONG_LONG_SUPPORTED
251 #endif
252
253 /*
254 * GCC 2.95 provides `__restrict' as an extension to C90 to support the
255 * C99-specific `restrict' type qualifier. We happen to use `__restrict' as
256 * a way to define the `restrict' type qualifier without disturbing older
257 * software that is unaware of C99 keywords.
258 */
259 #if !(__GNUC__ == 2 && __GNUC_MINOR__ == 95)
260 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901
261 #define __restrict
262 #else
263 #define __restrict restrict
264 #endif
265 #endif
266
267 /*
268 * GNU C version 2.96 adds explicit branch prediction so that
269 * the CPU back-end can hint the processor and also so that
270 * code blocks can be reordered such that the predicted path
271 * sees a more linear flow, thus improving cache behavior, etc.
272 *
273 * The following two macros provide us with a way to utilize this
274 * compiler feature. Use __predict_true() if you expect the expression
275 * to evaluate to true, and __predict_false() if you expect the
276 * expression to evaluate to false.
277 *
278 * A few notes about usage:
279 *
280 * * Generally, __predict_false() error condition checks (unless
281 * you have some _strong_ reason to do otherwise, in which case
282 * document it), and/or __predict_true() `no-error' condition
283 * checks, assuming you want to optimize for the no-error case.
284 *
285 * * Other than that, if you don't know the likelihood of a test
286 * succeeding from empirical or other `hard' evidence, don't
287 * make predictions.
288 *
289 * * These are meant to be used in places that are run `a lot'.
290 * It is wasteful to make predictions in code that is run
291 * seldomly (e.g. at subsystem initialization time) as the
292 * basic block reordering that this affects can often generate
293 * larger code.
294 */
295 #if __GNUC_PREREQ__(2, 96)
296 #define __predict_true(exp) __builtin_expect((exp), 1)
297 #define __predict_false(exp) __builtin_expect((exp), 0)
298 #else
299 #define __predict_true(exp) (exp)
300 #define __predict_false(exp) (exp)
301 #endif
302
303 /*
304 * We define this here since <stddef.h>, <sys/queue.h>, and <sys/types.h>
305 * require it.
306 */
307 #if __GNUC_PREREQ__(4, 1)
308 #define __offsetof(type, field) __builtin_offsetof(type, field)
309 #else
310 #ifndef __cplusplus
311 #define __offsetof(type, field) ((size_t)(&((type *)0)->field))
312 #else
313 #define __offsetof(type, field) \
314 (__offsetof__ (reinterpret_cast <size_t> \
315 (&reinterpret_cast <const volatile char &> \
316 (static_cast<type *> (0)->field))))
317 #endif
318 #endif
319 #define __rangeof(type, start, end) \
320 (__offsetof(type, end) - __offsetof(type, start))
321
322 /*
323 * Compiler-dependent macros to declare that functions take printf-like
324 * or scanf-like arguments. They are null except for versions of gcc
325 * that are known to support the features properly (old versions of gcc-2
326 * didn't permit keeping the keywords out of the application namespace).
327 */
328 #if !__GNUC_PREREQ__(2, 7) && !defined(__INTEL_COMPILER)
329 #define __printflike(fmtarg, firstvararg)
330 #define __scanflike(fmtarg, firstvararg)
331 #define __format_arg(fmtarg)
332 #else
333 #define __printflike(fmtarg, firstvararg) \
334 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
335 #define __scanflike(fmtarg, firstvararg) \
336 __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
337 #define __format_arg(fmtarg) __attribute__((__format_arg__ (fmtarg)))
338 #endif
339
340 /* Compiler-dependent macros that rely on FreeBSD-specific extensions. */
341 #if __FreeBSD_cc_version >= 300001 && defined(__GNUC__) && !defined(__INTEL_COMPILER)
342 #define __printf0like(fmtarg, firstvararg) \
343 __attribute__((__format__ (__printf0__, fmtarg, firstvararg)))
344 #else
345 #define __printf0like(fmtarg, firstvararg)
346 #endif
347
348 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
349 #ifndef __INTEL_COMPILER
350 #define __strong_reference(sym,aliassym) \
351 extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym)));
352 #endif
353 #ifdef __STDC__
354 #define __weak_reference(sym,alias) \
355 __asm__(".weak " #alias); \
356 __asm__(".equ " #alias ", " #sym)
357 #define __warn_references(sym,msg) \
358 __asm__(".section .gnu.warning." #sym); \
359 __asm__(".asciz \"" msg "\""); \
360 __asm__(".previous")
361 #else
362 #define __weak_reference(sym,alias) \
363 __asm__(".weak alias"); \
364 __asm__(".equ alias, sym")
365 #define __warn_references(sym,msg) \
366 __asm__(".section .gnu.warning.sym"); \
367 __asm__(".asciz \"msg\""); \
368 __asm__(".previous")
369 #endif /* __STDC__ */
370 #endif /* __GNUC__ || __INTEL_COMPILER */
371
372 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
373 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"")
374 #else
375 /*
376 * The following definition might not work well if used in header files,
377 * but it should be better than nothing. If you want a "do nothing"
378 * version, then it should generate some harmless declaration, such as:
379 * #define __IDSTRING(name,string) struct __hack
380 */
381 #define __IDSTRING(name,string) static const char name[] __unused = string
382 #endif
383
384 /*
385 * Embed the rcs id of a source file in the resulting library. Note that in
386 * more recent ELF binutils, we use .ident allowing the ID to be stripped.
387 * Usage:
388 * __FBSDID("$FreeBSD$");
389 */
390 #ifndef __FBSDID
391 #if !defined(lint) && !defined(STRIP_FBSDID)
392 #define __FBSDID(s) __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
393 #else
394 #define __FBSDID(s) struct __hack
395 #endif
396 #endif
397
398 #ifndef __RCSID
399 #ifndef NO__RCSID
400 #define __RCSID(s) __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
401 #else
402 #define __RCSID(s) struct __hack
403 #endif
404 #endif
405
406 #ifndef __RCSID_SOURCE
407 #ifndef NO__RCSID_SOURCE
408 #define __RCSID_SOURCE(s) __IDSTRING(__CONCAT(__rcsid_source_,__LINE__),s)
409 #else
410 #define __RCSID_SOURCE(s) struct __hack
411 #endif
412 #endif
413
414 #ifndef __SCCSID
415 #ifndef NO__SCCSID
416 #define __SCCSID(s) __IDSTRING(__CONCAT(__sccsid_,__LINE__),s)
417 #else
418 #define __SCCSID(s) struct __hack
419 #endif
420 #endif
421
422 #ifndef __COPYRIGHT
423 #ifndef NO__COPYRIGHT
424 #define __COPYRIGHT(s) __IDSTRING(__CONCAT(__copyright_,__LINE__),s)
425 #else
426 #define __COPYRIGHT(s) struct __hack
427 #endif
428 #endif
429
430 #ifndef __DECONST
431 #define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var))
432 #endif
433
434 #ifndef __DEVOLATILE
435 #define __DEVOLATILE(type, var) ((type)(uintptr_t)(volatile void *)(var))
436 #endif
437
438 #ifndef __DEQUALIFY
439 #define __DEQUALIFY(type, var) ((type)(uintptr_t)(const volatile void *)(var))
440 #endif
441
442 /*-
443 * The following definitions are an extension of the behavior originally
444 * implemented in <sys/_posix.h>, but with a different level of granularity.
445 * POSIX.1 requires that the macros we test be defined before any standard
446 * header file is included.
447 *
448 * Here's a quick run-down of the versions:
449 * defined(_POSIX_SOURCE) 1003.1-1988
450 * _POSIX_C_SOURCE == 1 1003.1-1990
451 * _POSIX_C_SOURCE == 2 1003.2-1992 C Language Binding Option
452 * _POSIX_C_SOURCE == 199309 1003.1b-1993
453 * _POSIX_C_SOURCE == 199506 1003.1c-1995, 1003.1i-1995,
454 * and the omnibus ISO/IEC 9945-1: 1996
455 * _POSIX_C_SOURCE == 200112 1003.1-2001
456 *
457 * In addition, the X/Open Portability Guide, which is now the Single UNIX
458 * Specification, defines a feature-test macro which indicates the version of
459 * that specification, and which subsumes _POSIX_C_SOURCE.
460 *
461 * Our macros begin with two underscores to avoid namespace screwage.
462 */
463
464 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */
465 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 1
466 #undef _POSIX_C_SOURCE /* Probably illegal, but beyond caring now. */
467 #define _POSIX_C_SOURCE 199009
468 #endif
469
470 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */
471 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 2
472 #undef _POSIX_C_SOURCE
473 #define _POSIX_C_SOURCE 199209
474 #endif
475
476 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
477 #ifdef _XOPEN_SOURCE
478 #if _XOPEN_SOURCE - 0 >= 600
479 #define __XSI_VISIBLE 600
480 #undef _POSIX_C_SOURCE
481 #define _POSIX_C_SOURCE 200112
482 #elif _XOPEN_SOURCE - 0 >= 500
483 #define __XSI_VISIBLE 500
484 #undef _POSIX_C_SOURCE
485 #define _POSIX_C_SOURCE 199506
486 #endif
487 #endif
488
489 /*
490 * Deal with all versions of POSIX. The ordering relative to the tests above is
491 * important.
492 */
493 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
494 #define _POSIX_C_SOURCE 198808
495 #endif
496 #ifdef _POSIX_C_SOURCE
497 #if _POSIX_C_SOURCE >= 200112
498 #define __POSIX_VISIBLE 200112
499 #define __ISO_C_VISIBLE 1999
500 #elif _POSIX_C_SOURCE >= 199506
501 #define __POSIX_VISIBLE 199506
502 #define __ISO_C_VISIBLE 1990
503 #elif _POSIX_C_SOURCE >= 199309
504 #define __POSIX_VISIBLE 199309
505 #define __ISO_C_VISIBLE 1990
506 #elif _POSIX_C_SOURCE >= 199209
507 #define __POSIX_VISIBLE 199209
508 #define __ISO_C_VISIBLE 1990
509 #elif _POSIX_C_SOURCE >= 199009
510 #define __POSIX_VISIBLE 199009
511 #define __ISO_C_VISIBLE 1990
512 #else
513 #define __POSIX_VISIBLE 198808
514 #define __ISO_C_VISIBLE 0
515 #endif /* _POSIX_C_SOURCE */
516 #else
517 /*-
518 * Deal with _ANSI_SOURCE:
519 * If it is defined, and no other compilation environment is explicitly
520 * requested, then define our internal feature-test macros to zero. This
521 * makes no difference to the preprocessor (undefined symbols in preprocessing
522 * expressions are defined to have value zero), but makes it more convenient for
523 * a test program to print out the values.
524 *
525 * If a program mistakenly defines _ANSI_SOURCE and some other macro such as
526 * _POSIX_C_SOURCE, we will assume that it wants the broader compilation
527 * environment (and in fact we will never get here).
528 */
529 #if defined(_ANSI_SOURCE) /* Hide almost everything. */
530 #define __POSIX_VISIBLE 0
531 #define __XSI_VISIBLE 0
532 #define __BSD_VISIBLE 0
533 #define __ISO_C_VISIBLE 1990
534 #elif defined(_C99_SOURCE) /* Localism to specify strict C99 env. */
535 #define __POSIX_VISIBLE 0
536 #define __XSI_VISIBLE 0
537 #define __BSD_VISIBLE 0
538 #define __ISO_C_VISIBLE 1999
539 #else /* Default environment: show everything. */
540 #define __POSIX_VISIBLE 200112
541 #define __XSI_VISIBLE 600
542 #define __BSD_VISIBLE 1
543 #define __ISO_C_VISIBLE 1999
544 #endif
545 #endif
546
547 #endif /* !_SYS_CDEFS_H_ */
Cache object: 630867c5feff0f7cbe70031a78749b2b
|