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 #ifndef __INTEL_COMPILER
66 # define __GNUCLIKE_CTOR_SECTION_HANDLING 1
69 #define __GNUCLIKE_BUILTIN_CONSTANT_P 1
70 # if defined(__INTEL_COMPILER) && defined(__cplusplus) \
71 && __INTEL_COMPILER < 800
72 # undef __GNUCLIKE_BUILTIN_CONSTANT_P
75 #if (__GNUC_MINOR__ > 95 || __GNUC__ >= 3) && !defined(__INTEL_COMPILER)
76 # define __GNUCLIKE_BUILTIN_VARARGS 1
77 # define __GNUCLIKE_BUILTIN_STDARG 1
78 # define __GNUCLIKE_BUILTIN_VAALIST 1
82 # define __GNUC_VA_LIST_COMPATIBILITY 1
85 #ifndef __INTEL_COMPILER
86 # define __GNUCLIKE_BUILTIN_NEXT_ARG 1
87 # define __GNUCLIKE_MATH_BUILTIN_RELOPS
90 #define __GNUCLIKE_BUILTIN_MEMCPY 1
92 /* XXX: if __GNUC__ >= 2: not tested everywhere originally, where replaced */
93 #define __CC_SUPPORTS_INLINE 1
94 #define __CC_SUPPORTS___INLINE 1
95 #define __CC_SUPPORTS___INLINE__ 1
97 #define __CC_SUPPORTS___FUNC__ 1
98 #define __CC_SUPPORTS_WARNING 1
100 #define __CC_SUPPORTS_VARADIC_XXX 1 /* see varargs.h */
102 #define __CC_SUPPORTS_DYNAMIC_ARRAY_INIT 1
104 #endif /* __GNUC__ || __INTEL_COMPILER */
107 * Macro to test if we're using a specific version of gcc or later.
109 #if defined(__GNUC__) && !defined(__INTEL_COMPILER)
110 #define __GNUC_PREREQ__(ma, mi) \
111 (__GNUC__ > (ma) || __GNUC__ == (ma) && __GNUC_MINOR__ >= (mi))
113 #define __GNUC_PREREQ__(ma, mi) 0
117 * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
118 * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
119 * The __CONCAT macro is a bit tricky to use if it must work in non-ANSI
120 * mode -- there must be no spaces between its arguments, and for nested
121 * __CONCAT's, all the __CONCAT's must be at the left. __CONCAT can also
122 * concatenate double-quoted strings produced by the __STRING macro, but
123 * this only works with ANSI C.
125 * __XSTRING is like __STRING, but it expands any macros in its argument
126 * first. It is only available with ANSI C.
128 #if defined(__STDC__) || defined(__cplusplus)
129 #define __P(protos) protos /* full-blown ANSI C */
130 #define __CONCAT1(x,y) x ## y
131 #define __CONCAT(x,y) __CONCAT1(x,y)
132 #define __STRING(x) #x /* stringify without expanding x */
133 #define __XSTRING(x) __STRING(x) /* expand x, then stringify */
135 #define __const const /* define reserved names to standard */
136 #define __signed signed
137 #define __volatile volatile
138 #if defined(__cplusplus)
139 #define __inline inline /* convert to C++ keyword */
141 #if !(defined(__CC_SUPPORTS___INLINE))
142 #define __inline /* delete GCC keyword */
143 #endif /* ! __CC_SUPPORTS___INLINE */
144 #endif /* !__cplusplus */
146 #else /* !(__STDC__ || __cplusplus) */
147 #define __P(protos) () /* traditional C preprocessor */
148 #define __CONCAT(x,y) x/**/y
149 #define __STRING(x) "x"
151 #if !defined(__CC_SUPPORTS___INLINE)
152 #define __const /* delete pseudo-ANSI C keywords */
157 * In non-ANSI C environments, new programs will want ANSI-only C keywords
158 * deleted from the program and old programs will want them left alone.
159 * When using a compiler other than gcc, programs using the ANSI C keywords
160 * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
161 * When using "gcc -traditional", we assume that this is the intent; if
162 * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
164 #ifndef NO_ANSI_KEYWORDS
165 #define const /* delete ANSI C keywords */
169 #endif /* !NO_ANSI_KEYWORDS */
170 #endif /* !__CC_SUPPORTS___INLINE */
171 #endif /* !(__STDC__ || __cplusplus) */
174 * Compiler-dependent macros to help declare dead (non-returning) and
175 * pure (no side effects) functions, and unused variables. They are
176 * null except for versions of gcc that are known to support the features
177 * properly (old versions of gcc-2 supported the dead and pure features
178 * in a different (wrong) way). If we do not provide an implementation
179 * for a given compiler, let the compile fail if it is told to use
180 * a feature that we cannot live without.
190 #if !__GNUC_PREREQ__(2, 5) && !defined(__INTEL_COMPILER)
195 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 && __GNUC_MINOR__ < 7 && !defined(__INTEL_COMPILER)
196 #define __dead2 __attribute__((__noreturn__))
197 #define __pure2 __attribute__((__const__))
199 /* XXX Find out what to do for __packed, __aligned and __section */
201 #if __GNUC_PREREQ__(2, 7)
202 #define __dead2 __attribute__((__noreturn__))
203 #define __pure2 __attribute__((__const__))
204 #define __unused __attribute__((__unused__))
205 #define __used __attribute__((__used__))
206 #define __packed __attribute__((__packed__))
207 #define __aligned(x) __attribute__((__aligned__(x)))
208 #define __section(x) __attribute__((__section__(x)))
210 #if defined(__INTEL_COMPILER)
211 #define __dead2 __attribute__((__noreturn__))
212 #define __pure2 __attribute__((__const__))
213 #define __unused __attribute__((__unused__))
214 #define __used __attribute__((__used__))
215 #define __packed __attribute__((__packed__))
216 #define __aligned(x) __attribute__((__aligned__(x)))
217 #define __section(x) __attribute__((__section__(x)))
221 #if __GNUC_PREREQ__(2, 96)
222 #define __malloc_like __attribute__((__malloc__))
223 #define __pure __attribute__((__pure__))
225 #define __malloc_like
229 #if __GNUC_PREREQ__(3, 1) || (defined(__INTEL_COMPILER) && __INTEL_COMPILER >= 800)
230 #define __always_inline __attribute__((__always_inline__))
232 #define __always_inline
235 #if __GNUC_PREREQ__(3, 1)
236 #define __noinline __attribute__ ((__noinline__))
241 #if __GNUC_PREREQ__(3, 3)
242 #define __nonnull(x) __attribute__((__nonnull__(x)))
247 /* XXX: should use `#if __STDC_VERSION__ < 199901'. */
248 #if !__GNUC_PREREQ__(2, 7) && !defined(__INTEL_COMPILER)
249 #define __func__ NULL
252 #if (defined(__INTEL_COMPILER) || (defined(__GNUC__) && __GNUC__ >= 2)) && !defined(__STRICT_ANSI__) || __STDC_VERSION__ >= 199901
253 #define __LONG_LONG_SUPPORTED
257 * GCC 2.95 provides `__restrict' as an extension to C90 to support the
258 * C99-specific `restrict' type qualifier. We happen to use `__restrict' as
259 * a way to define the `restrict' type qualifier without disturbing older
260 * software that is unaware of C99 keywords.
262 #if !(__GNUC__ == 2 && __GNUC_MINOR__ == 95)
263 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901 || defined(lint)
266 #define __restrict restrict
271 * GNU C version 2.96 adds explicit branch prediction so that
272 * the CPU back-end can hint the processor and also so that
273 * code blocks can be reordered such that the predicted path
274 * sees a more linear flow, thus improving cache behavior, etc.
276 * The following two macros provide us with a way to utilize this
277 * compiler feature. Use __predict_true() if you expect the expression
278 * to evaluate to true, and __predict_false() if you expect the
279 * expression to evaluate to false.
281 * A few notes about usage:
283 * * Generally, __predict_false() error condition checks (unless
284 * you have some _strong_ reason to do otherwise, in which case
285 * document it), and/or __predict_true() `no-error' condition
286 * checks, assuming you want to optimize for the no-error case.
288 * * Other than that, if you don't know the likelihood of a test
289 * succeeding from empirical or other `hard' evidence, don't
292 * * These are meant to be used in places that are run `a lot'.
293 * It is wasteful to make predictions in code that is run
294 * seldomly (e.g. at subsystem initialization time) as the
295 * basic block reordering that this affects can often generate
298 #if __GNUC_PREREQ__(2, 96)
299 #define __predict_true(exp) __builtin_expect((exp), 1)
300 #define __predict_false(exp) __builtin_expect((exp), 0)
302 #define __predict_true(exp) (exp)
303 #define __predict_false(exp) (exp)
306 #if __GNUC_PREREQ__(4, 2)
307 #define __hidden __attribute__((__visibility__("hidden")))
308 #define __exported __attribute__((__visibility__("default")))
315 * We define this here since <stddef.h>, <sys/queue.h>, and <sys/types.h>
318 #if __GNUC_PREREQ__(4, 1)
319 #define __offsetof(type, field) __builtin_offsetof(type, field)
322 #define __offsetof(type, field) ((size_t)(&((type *)0)->field))
324 #define __offsetof(type, field) \
325 (__offsetof__ (reinterpret_cast <size_t> \
326 (&reinterpret_cast <const volatile char &> \
327 (static_cast<type *> (0)->field))))
330 #define __rangeof(type, start, end) \
331 (__offsetof(type, end) - __offsetof(type, start))
334 * Compiler-dependent macros to declare that functions take printf-like
335 * or scanf-like arguments. They are null except for versions of gcc
336 * that are known to support the features properly (old versions of gcc-2
337 * didn't permit keeping the keywords out of the application namespace).
339 #if !__GNUC_PREREQ__(2, 7) && !defined(__INTEL_COMPILER)
340 #define __printflike(fmtarg, firstvararg)
341 #define __scanflike(fmtarg, firstvararg)
342 #define __format_arg(fmtarg)
344 #define __printflike(fmtarg, firstvararg) \
345 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
346 #define __scanflike(fmtarg, firstvararg) \
347 __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
348 #define __format_arg(fmtarg) __attribute__((__format_arg__ (fmtarg)))
351 /* Compiler-dependent macros that rely on FreeBSD-specific extensions. */
352 #if __FreeBSD_cc_version >= 300001 && defined(__GNUC__) && !defined(__INTEL_COMPILER)
353 #define __printf0like(fmtarg, firstvararg) \
354 __attribute__((__format__ (__printf0__, fmtarg, firstvararg)))
356 #define __printf0like(fmtarg, firstvararg)
359 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
360 #ifndef __INTEL_COMPILER
361 #define __strong_reference(sym,aliassym) \
362 extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym)))
365 #define __weak_reference(sym,alias) \
366 __asm__(".weak " #alias); \
367 __asm__(".equ " #alias ", " #sym)
368 #define __warn_references(sym,msg) \
369 __asm__(".section .gnu.warning." #sym); \
370 __asm__(".asciz \"" msg "\""); \
372 #define __sym_compat(sym,impl,verid) \
373 __asm__(".symver " #impl ", " #sym "@" #verid)
374 #define __sym_default(sym,impl,verid) \
375 __asm__(".symver " #impl ", " #sym "@@" #verid)
377 #define __weak_reference(sym,alias) \
378 __asm__(".weak alias"); \
379 __asm__(".equ alias, sym")
380 #define __warn_references(sym,msg) \
381 __asm__(".section .gnu.warning.sym"); \
382 __asm__(".asciz \"msg\""); \
384 #define __sym_compat(sym,impl,verid) \
385 __asm__(".symver impl, sym@verid")
386 #define __sym_default(impl,sym,verid) \
387 __asm__(".symver impl, sym@@verid")
388 #endif /* __STDC__ */
389 #endif /* __GNUC__ || __INTEL_COMPILER */
391 #define __GLOBL1(sym) __asm__(".globl " #sym)
392 #define __GLOBL(sym) __GLOBL1(sym)
394 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
395 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"")
398 * The following definition might not work well if used in header files,
399 * but it should be better than nothing. If you want a "do nothing"
400 * version, then it should generate some harmless declaration, such as:
401 * #define __IDSTRING(name,string) struct __hack
403 #define __IDSTRING(name,string) static const char name[] __unused = string
407 * Embed the rcs id of a source file in the resulting library. Note that in
408 * more recent ELF binutils, we use .ident allowing the ID to be stripped.
410 * __FBSDID("$FreeBSD$");
413 #if !defined(lint) && !defined(STRIP_FBSDID)
414 #define __FBSDID(s) __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
416 #define __FBSDID(s) struct __hack
422 #define __RCSID(s) __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
424 #define __RCSID(s) struct __hack
428 #ifndef __RCSID_SOURCE
429 #ifndef NO__RCSID_SOURCE
430 #define __RCSID_SOURCE(s) __IDSTRING(__CONCAT(__rcsid_source_,__LINE__),s)
432 #define __RCSID_SOURCE(s) struct __hack
438 #define __SCCSID(s) __IDSTRING(__CONCAT(__sccsid_,__LINE__),s)
440 #define __SCCSID(s) struct __hack
445 #ifndef NO__COPYRIGHT
446 #define __COPYRIGHT(s) __IDSTRING(__CONCAT(__copyright_,__LINE__),s)
448 #define __COPYRIGHT(s) struct __hack
453 #define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var))
457 #define __DEVOLATILE(type, var) ((type)(uintptr_t)(volatile void *)(var))
461 #define __DEQUALIFY(type, var) ((type)(uintptr_t)(const volatile void *)(var))
465 * The following definitions are an extension of the behavior originally
466 * implemented in <sys/_posix.h>, but with a different level of granularity.
467 * POSIX.1 requires that the macros we test be defined before any standard
468 * header file is included.
470 * Here's a quick run-down of the versions:
471 * defined(_POSIX_SOURCE) 1003.1-1988
472 * _POSIX_C_SOURCE == 1 1003.1-1990
473 * _POSIX_C_SOURCE == 2 1003.2-1992 C Language Binding Option
474 * _POSIX_C_SOURCE == 199309 1003.1b-1993
475 * _POSIX_C_SOURCE == 199506 1003.1c-1995, 1003.1i-1995,
476 * and the omnibus ISO/IEC 9945-1: 1996
477 * _POSIX_C_SOURCE == 200112 1003.1-2001
478 * _POSIX_C_SOURCE == 200809 1003.1-2008
480 * In addition, the X/Open Portability Guide, which is now the Single UNIX
481 * Specification, defines a feature-test macro which indicates the version of
482 * that specification, and which subsumes _POSIX_C_SOURCE.
484 * Our macros begin with two underscores to avoid namespace screwage.
487 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */
488 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 1
489 #undef _POSIX_C_SOURCE /* Probably illegal, but beyond caring now. */
490 #define _POSIX_C_SOURCE 199009
493 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */
494 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 2
495 #undef _POSIX_C_SOURCE
496 #define _POSIX_C_SOURCE 199209
499 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
501 #if _XOPEN_SOURCE - 0 >= 700
502 #define __XSI_VISIBLE 700
503 #undef _POSIX_C_SOURCE
504 #define _POSIX_C_SOURCE 200809
505 #elif _XOPEN_SOURCE - 0 >= 600
506 #define __XSI_VISIBLE 600
507 #undef _POSIX_C_SOURCE
508 #define _POSIX_C_SOURCE 200112
509 #elif _XOPEN_SOURCE - 0 >= 500
510 #define __XSI_VISIBLE 500
511 #undef _POSIX_C_SOURCE
512 #define _POSIX_C_SOURCE 199506
517 * Deal with all versions of POSIX. The ordering relative to the tests above is
520 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
521 #define _POSIX_C_SOURCE 198808
523 #ifdef _POSIX_C_SOURCE
524 #if _POSIX_C_SOURCE >= 200809
525 #define __POSIX_VISIBLE 200809
526 #define __ISO_C_VISIBLE 1999
527 #elif _POSIX_C_SOURCE >= 200112
528 #define __POSIX_VISIBLE 200112
529 #define __ISO_C_VISIBLE 1999
530 #elif _POSIX_C_SOURCE >= 199506
531 #define __POSIX_VISIBLE 199506
532 #define __ISO_C_VISIBLE 1990
533 #elif _POSIX_C_SOURCE >= 199309
534 #define __POSIX_VISIBLE 199309
535 #define __ISO_C_VISIBLE 1990
536 #elif _POSIX_C_SOURCE >= 199209
537 #define __POSIX_VISIBLE 199209
538 #define __ISO_C_VISIBLE 1990
539 #elif _POSIX_C_SOURCE >= 199009
540 #define __POSIX_VISIBLE 199009
541 #define __ISO_C_VISIBLE 1990
543 #define __POSIX_VISIBLE 198808
544 #define __ISO_C_VISIBLE 0
545 #endif /* _POSIX_C_SOURCE */
548 * Deal with _ANSI_SOURCE:
549 * If it is defined, and no other compilation environment is explicitly
550 * requested, then define our internal feature-test macros to zero. This
551 * makes no difference to the preprocessor (undefined symbols in preprocessing
552 * expressions are defined to have value zero), but makes it more convenient for
553 * a test program to print out the values.
555 * If a program mistakenly defines _ANSI_SOURCE and some other macro such as
556 * _POSIX_C_SOURCE, we will assume that it wants the broader compilation
557 * environment (and in fact we will never get here).
559 #if defined(_ANSI_SOURCE) /* Hide almost everything. */
560 #define __POSIX_VISIBLE 0
561 #define __XSI_VISIBLE 0
562 #define __BSD_VISIBLE 0
563 #define __ISO_C_VISIBLE 1990
564 #elif defined(_C99_SOURCE) /* Localism to specify strict C99 env. */
565 #define __POSIX_VISIBLE 0
566 #define __XSI_VISIBLE 0
567 #define __BSD_VISIBLE 0
568 #define __ISO_C_VISIBLE 1999
569 #else /* Default environment: show everything. */
570 #define __POSIX_VISIBLE 200809
571 #define __XSI_VISIBLE 700
572 #define __BSD_VISIBLE 1
573 #define __ISO_C_VISIBLE 1999
577 #endif /* !_SYS_CDEFS_H_ */