2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * Berkeley Software Design, Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
32 * @(#)cdefs.h 8.8 (Berkeley) 1/9/95
39 #if defined(__cplusplus)
40 #define __BEGIN_DECLS extern "C" {
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.
53 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
55 #if __GNUC__ >= 3 || defined(__INTEL_COMPILER)
56 #define __GNUCLIKE_ASM 3
57 #define __GNUCLIKE_MATH_BUILTIN_CONSTANTS
59 #define __GNUCLIKE_ASM 2
61 #define __GNUCLIKE___TYPEOF 1
62 #define __GNUCLIKE___OFFSETOF 1
63 #define __GNUCLIKE___SECTION 1
65 #define __GNUCLIKE_ATTRIBUTE_MODE_DI 1
67 #ifndef __INTEL_COMPILER
68 # define __GNUCLIKE_CTOR_SECTION_HANDLING 1
71 #define __GNUCLIKE_BUILTIN_CONSTANT_P 1
72 # if defined(__INTEL_COMPILER) && defined(__cplusplus) \
73 && __INTEL_COMPILER < 800
74 # undef __GNUCLIKE_BUILTIN_CONSTANT_P
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
84 # define __GNUC_VA_LIST_COMPATIBILITY 1
87 #ifndef __INTEL_COMPILER
88 # define __GNUCLIKE_BUILTIN_NEXT_ARG 1
89 # define __GNUCLIKE_MATH_BUILTIN_RELOPS
92 #define __GNUCLIKE_BUILTIN_MEMCPY 1
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
99 #define __CC_SUPPORTS___FUNC__ 1
100 #define __CC_SUPPORTS_WARNING 1
102 #define __CC_SUPPORTS_VARADIC_XXX 1 /* see varargs.h */
104 #define __CC_SUPPORTS_DYNAMIC_ARRAY_INIT 1
106 /* XXX: sys/dev/mpt/mpilib/mpi_type.h uses it, someone should review it */
107 #define __CC_INT_IS_32BIT 1
109 #endif /* __GNUC__ || __INTEL_COMPILER */
112 * Macro to test if we're using a specific version of gcc or later.
114 #if defined(__GNUC__) && !defined(__INTEL_COMPILER)
115 #define __GNUC_PREREQ__(ma, mi) \
116 (__GNUC__ > (ma) || __GNUC__ == (ma) && __GNUC_MINOR__ >= (mi))
118 #define __GNUC_PREREQ__(ma, mi) 0
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.
130 * __XSTRING is like __STRING, but it expands any macros in its argument
131 * first. It is only available with ANSI C.
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 */
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 */
146 #if !(defined(__CC_SUPPORTS___INLINE))
147 #define __inline /* delete GCC keyword */
148 #endif /* ! __CC_SUPPORTS___INLINE */
149 #endif /* !__cplusplus */
151 #else /* !(__STDC__ || __cplusplus) */
152 #define __P(protos) () /* traditional C preprocessor */
153 #define __CONCAT(x,y) x/**/y
154 #define __STRING(x) "x"
156 #if !defined(__CC_SUPPORTS___INLINE)
157 #define __const /* delete pseudo-ANSI C keywords */
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.
169 #ifndef NO_ANSI_KEYWORDS
170 #define const /* delete ANSI C keywords */
174 #endif /* !NO_ANSI_KEYWORDS */
175 #endif /* !__CC_SUPPORTS___INLINE */
176 #endif /* !(__STDC__ || __cplusplus) */
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.
195 #if !__GNUC_PREREQ__(2, 5) && !defined(__INTEL_COMPILER)
200 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 && __GNUC_MINOR__ < 7 && !defined(__INTEL_COMPILER)
201 #define __dead2 __attribute__((__noreturn__))
202 #define __pure2 __attribute__((__const__))
204 /* XXX Find out what to do for __packed, __aligned and __section */
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)))
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)))
226 #if __GNUC_PREREQ__(2, 96)
227 #define __pure __attribute__((__pure__))
232 #if __GNUC_PREREQ__(3, 1) || (defined(__INTEL_COMPILER) && __INTEL_COMPILER >= 800)
233 #define __always_inline __attribute__((__always_inline__))
235 #define __always_inline
238 #if __GNUC_PREREQ__(4, 2) /* actually 4.1.3 */
239 #define __gnu89_inline __attribute__((__gnu_inline__)) __inline
241 #define __gnu89_inline
244 #if __GNUC_PREREQ__(3, 1)
245 #define __noinline __attribute__ ((__noinline__))
250 #if __GNUC_PREREQ__(3, 3)
251 #define __nonnull(x) __attribute__((__nonnull__(x)))
256 /* XXX: should use `#if __STDC_VERSION__ < 199901'. */
257 #if !__GNUC_PREREQ__(2, 7) && !defined(__INTEL_COMPILER)
258 #define __func__ NULL
261 #if (defined(__INTEL_COMPILER) || (defined(__GNUC__) && __GNUC__ >= 2)) && !defined(__STRICT_ANSI__) || __STDC_VERSION__ >= 199901
262 #define __LONG_LONG_SUPPORTED
266 * GCC 2.95 provides `__restrict' as an extension to C90 to support the
267 * C99-specific `restrict' type qualifier. We happen to use `__restrict' as
268 * a way to define the `restrict' type qualifier without disturbing older
269 * software that is unaware of C99 keywords.
271 #if !(__GNUC__ == 2 && __GNUC_MINOR__ == 95)
272 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901
275 #define __restrict restrict
280 * GNU C version 2.96 adds explicit branch prediction so that
281 * the CPU back-end can hint the processor and also so that
282 * code blocks can be reordered such that the predicted path
283 * sees a more linear flow, thus improving cache behavior, etc.
285 * The following two macros provide us with a way to utilize this
286 * compiler feature. Use __predict_true() if you expect the expression
287 * to evaluate to true, and __predict_false() if you expect the
288 * expression to evaluate to false.
290 * A few notes about usage:
292 * * Generally, __predict_false() error condition checks (unless
293 * you have some _strong_ reason to do otherwise, in which case
294 * document it), and/or __predict_true() `no-error' condition
295 * checks, assuming you want to optimize for the no-error case.
297 * * Other than that, if you don't know the likelihood of a test
298 * succeeding from empirical or other `hard' evidence, don't
301 * * These are meant to be used in places that are run `a lot'.
302 * It is wasteful to make predictions in code that is run
303 * seldomly (e.g. at subsystem initialization time) as the
304 * basic block reordering that this affects can often generate
307 #if __GNUC_PREREQ__(2, 96)
308 #define __predict_true(exp) __builtin_expect((exp), 1)
309 #define __predict_false(exp) __builtin_expect((exp), 0)
311 #define __predict_true(exp) (exp)
312 #define __predict_false(exp) (exp)
316 * We define this here since <stddef.h>, <sys/queue.h>, and <sys/types.h>
319 #if __GNUC_PREREQ__(4, 1)
320 #define __offsetof(type, field) __builtin_offsetof(type, field)
323 #define __offsetof(type, field) ((size_t)(&((type *)0)->field))
325 #define __offsetof(type, field) \
326 (__offsetof__ (reinterpret_cast <size_t> \
327 (&reinterpret_cast <const volatile char &> \
328 (static_cast<type *> (0)->field))))
331 #define __rangeof(type, start, end) \
332 (__offsetof(type, end) - __offsetof(type, start))
335 * Compiler-dependent macros to declare that functions take printf-like
336 * or scanf-like arguments. They are null except for versions of gcc
337 * that are known to support the features properly (old versions of gcc-2
338 * didn't permit keeping the keywords out of the application namespace).
340 #if !__GNUC_PREREQ__(2, 7) && !defined(__INTEL_COMPILER)
341 #define __printflike(fmtarg, firstvararg)
342 #define __scanflike(fmtarg, firstvararg)
343 #define __format_arg(fmtarg)
345 #define __printflike(fmtarg, firstvararg) \
346 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
347 #define __scanflike(fmtarg, firstvararg) \
348 __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
349 #define __format_arg(fmtarg) __attribute__((__format_arg__ (fmtarg)))
352 /* Compiler-dependent macros that rely on FreeBSD-specific extensions. */
353 #if __FreeBSD_cc_version >= 300001 && defined(__GNUC__) && !defined(__INTEL_COMPILER)
354 #define __printf0like(fmtarg, firstvararg) \
355 __attribute__((__format__ (__printf0__, fmtarg, firstvararg)))
357 #define __printf0like(fmtarg, firstvararg)
360 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
361 #ifndef __INTEL_COMPILER
362 #define __strong_reference(sym,aliassym) \
363 extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym)))
366 #define __weak_reference(sym,alias) \
367 __asm__(".weak " #alias); \
368 __asm__(".equ " #alias ", " #sym)
369 #define __warn_references(sym,msg) \
370 __asm__(".section .gnu.warning." #sym); \
371 __asm__(".asciz \"" msg "\""); \
373 #define __sym_compat(sym,impl,verid) \
374 __asm__(".symver " #impl ", " #sym "@" #verid)
375 #define __sym_default(sym,impl,verid) \
376 __asm__(".symver " #impl ", " #sym "@@" #verid)
378 #define __weak_reference(sym,alias) \
379 __asm__(".weak alias"); \
380 __asm__(".equ alias, sym")
381 #define __warn_references(sym,msg) \
382 __asm__(".section .gnu.warning.sym"); \
383 __asm__(".asciz \"msg\""); \
385 #define __sym_compat(sym,impl,verid) \
386 __asm__(".symver impl, sym@verid")
387 #define __sym_default(impl,sym,verid) \
388 __asm__(".symver impl, sym@@verid")
389 #endif /* __STDC__ */
390 #endif /* __GNUC__ || __INTEL_COMPILER */
392 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
393 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"")
396 * The following definition might not work well if used in header files,
397 * but it should be better than nothing. If you want a "do nothing"
398 * version, then it should generate some harmless declaration, such as:
399 * #define __IDSTRING(name,string) struct __hack
401 #define __IDSTRING(name,string) static const char name[] __unused = string
405 * Embed the rcs id of a source file in the resulting library. Note that in
406 * more recent ELF binutils, we use .ident allowing the ID to be stripped.
408 * __FBSDID("$FreeBSD$");
411 #if !defined(lint) && !defined(STRIP_FBSDID)
412 #define __FBSDID(s) __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
414 #define __FBSDID(s) struct __hack
420 #define __RCSID(s) __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
422 #define __RCSID(s) struct __hack
426 #ifndef __RCSID_SOURCE
427 #ifndef NO__RCSID_SOURCE
428 #define __RCSID_SOURCE(s) __IDSTRING(__CONCAT(__rcsid_source_,__LINE__),s)
430 #define __RCSID_SOURCE(s) struct __hack
436 #define __SCCSID(s) __IDSTRING(__CONCAT(__sccsid_,__LINE__),s)
438 #define __SCCSID(s) struct __hack
443 #ifndef NO__COPYRIGHT
444 #define __COPYRIGHT(s) __IDSTRING(__CONCAT(__copyright_,__LINE__),s)
446 #define __COPYRIGHT(s) struct __hack
451 #define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var))
455 #define __DEVOLATILE(type, var) ((type)(uintptr_t)(volatile void *)(var))
459 #define __DEQUALIFY(type, var) ((type)(uintptr_t)(const volatile void *)(var))
463 * The following definitions are an extension of the behavior originally
464 * implemented in <sys/_posix.h>, but with a different level of granularity.
465 * POSIX.1 requires that the macros we test be defined before any standard
466 * header file is included.
468 * Here's a quick run-down of the versions:
469 * defined(_POSIX_SOURCE) 1003.1-1988
470 * _POSIX_C_SOURCE == 1 1003.1-1990
471 * _POSIX_C_SOURCE == 2 1003.2-1992 C Language Binding Option
472 * _POSIX_C_SOURCE == 199309 1003.1b-1993
473 * _POSIX_C_SOURCE == 199506 1003.1c-1995, 1003.1i-1995,
474 * and the omnibus ISO/IEC 9945-1: 1996
475 * _POSIX_C_SOURCE == 200112 1003.1-2001
477 * In addition, the X/Open Portability Guide, which is now the Single UNIX
478 * Specification, defines a feature-test macro which indicates the version of
479 * that specification, and which subsumes _POSIX_C_SOURCE.
481 * Our macros begin with two underscores to avoid namespace screwage.
484 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */
485 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 1
486 #undef _POSIX_C_SOURCE /* Probably illegal, but beyond caring now. */
487 #define _POSIX_C_SOURCE 199009
490 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */
491 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 2
492 #undef _POSIX_C_SOURCE
493 #define _POSIX_C_SOURCE 199209
496 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
498 #if _XOPEN_SOURCE - 0 >= 600
499 #define __XSI_VISIBLE 600
500 #undef _POSIX_C_SOURCE
501 #define _POSIX_C_SOURCE 200112
502 #elif _XOPEN_SOURCE - 0 >= 500
503 #define __XSI_VISIBLE 500
504 #undef _POSIX_C_SOURCE
505 #define _POSIX_C_SOURCE 199506
510 * Deal with all versions of POSIX. The ordering relative to the tests above is
513 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
514 #define _POSIX_C_SOURCE 198808
516 #ifdef _POSIX_C_SOURCE
517 #if _POSIX_C_SOURCE >= 200112
518 #define __POSIX_VISIBLE 200112
519 #define __ISO_C_VISIBLE 1999
520 #elif _POSIX_C_SOURCE >= 199506
521 #define __POSIX_VISIBLE 199506
522 #define __ISO_C_VISIBLE 1990
523 #elif _POSIX_C_SOURCE >= 199309
524 #define __POSIX_VISIBLE 199309
525 #define __ISO_C_VISIBLE 1990
526 #elif _POSIX_C_SOURCE >= 199209
527 #define __POSIX_VISIBLE 199209
528 #define __ISO_C_VISIBLE 1990
529 #elif _POSIX_C_SOURCE >= 199009
530 #define __POSIX_VISIBLE 199009
531 #define __ISO_C_VISIBLE 1990
533 #define __POSIX_VISIBLE 198808
534 #define __ISO_C_VISIBLE 0
535 #endif /* _POSIX_C_SOURCE */
538 * Deal with _ANSI_SOURCE:
539 * If it is defined, and no other compilation environment is explicitly
540 * requested, then define our internal feature-test macros to zero. This
541 * makes no difference to the preprocessor (undefined symbols in preprocessing
542 * expressions are defined to have value zero), but makes it more convenient for
543 * a test program to print out the values.
545 * If a program mistakenly defines _ANSI_SOURCE and some other macro such as
546 * _POSIX_C_SOURCE, we will assume that it wants the broader compilation
547 * environment (and in fact we will never get here).
549 #if defined(_ANSI_SOURCE) /* Hide almost everything. */
550 #define __POSIX_VISIBLE 0
551 #define __XSI_VISIBLE 0
552 #define __BSD_VISIBLE 0
553 #define __ISO_C_VISIBLE 1990
554 #elif defined(_C99_SOURCE) /* Localism to specify strict C99 env. */
555 #define __POSIX_VISIBLE 0
556 #define __XSI_VISIBLE 0
557 #define __BSD_VISIBLE 0
558 #define __ISO_C_VISIBLE 1999
559 #else /* Default environment: show everything. */
560 #define __POSIX_VISIBLE 200112
561 #define __XSI_VISIBLE 600
562 #define __BSD_VISIBLE 1
563 #define __ISO_C_VISIBLE 1999
567 #endif /* !_SYS_CDEFS_H_ */