3 * Copyright (c) 1991, 1993
4 * The Regents of the University of California. All rights reserved.
6 * This code is derived from software contributed to Berkeley by
7 * Berkeley Software Design, Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * © Portions Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
33 * @(#)cdefs.h 8.8 (Berkeley) 1/9/95
34 * $FreeBSD: src/sys/sys/cdefs.h,v 1.88.2.1 2005/10/09 07:48:48 netchild Exp $
44 #if defined(__cplusplus)
45 #define __BEGIN_DECLS extern "C" {
53 * This code has been put in place to help reduce the addition of
54 * compiler specific defines in FreeBSD code. It helps to aid in
55 * having a compiler-agnostic source tree.
58 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
60 #if __GNUC__ >= 3 || defined(__INTEL_COMPILER)
61 #define __GNUCLIKE_ASM 3
62 #define __GNUCLIKE_MATH_BUILTIN_CONSTANTS
64 #define __GNUCLIKE_ASM 2
66 #define __GNUCLIKE___TYPEOF 1
67 #define __GNUCLIKE___OFFSETOF 1
68 #define __GNUCLIKE___SECTION 1
70 #define __GNUCLIKE_ATTRIBUTE_MODE_DI 1
72 #ifndef __INTEL_COMPILER
73 # define __GNUCLIKE_CTOR_SECTION_HANDLING 1
76 #define __GNUCLIKE_BUILTIN_CONSTANT_P 1
77 # if defined(__INTEL_COMPILER) && defined(__cplusplus) \
78 && __INTEL_COMPILER < 800
79 # undef __GNUCLIKE_BUILTIN_CONSTANT_P
82 #if (__GNUC_MINOR__ > 95 || __GNUC__ >= 3) && !defined(__INTEL_COMPILER)
83 # define __GNUCLIKE_BUILTIN_VARARGS 1
84 # define __GNUCLIKE_BUILTIN_STDARG 1
85 # define __GNUCLIKE_BUILTIN_VAALIST 1
89 # define __GNUC_VA_LIST_COMPATIBILITY 1
92 #ifndef __INTEL_COMPILER
93 # define __GNUCLIKE_BUILTIN_NEXT_ARG 1
94 # define __GNUCLIKE_MATH_BUILTIN_RELOPS
97 #define __GNUCLIKE_BUILTIN_MEMCPY 1
99 /* XXX: if __GNUC__ >= 2: not tested everywhere originally, where replaced */
100 #define __CC_SUPPORTS_INLINE 1
101 #define __CC_SUPPORTS___INLINE 1
102 #define __CC_SUPPORTS___INLINE__ 1
104 #define __CC_SUPPORTS___FUNC__ 1
105 #define __CC_SUPPORTS_WARNING 1
107 #define __CC_SUPPORTS_VARADIC_XXX 1 /* see varargs.h */
109 #define __CC_SUPPORTS_DYNAMIC_ARRAY_INIT 1
111 /* XXX: sys/dev/mpt/mpilib/mpi_type.h uses it, someone should review it */
112 #define __CC_INT_IS_32BIT 1
114 #endif /* __GNUC__ || __INTEL_COMPILER */
117 * Macro to test if we're using a specific version of gcc or later.
119 #if defined(__GNUC__) && !defined(__INTEL_COMPILER)
120 #define __GNUC_PREREQ__(ma, mi) \
121 (__GNUC__ > (ma) || __GNUC__ == (ma) && __GNUC_MINOR__ >= (mi))
123 #define __GNUC_PREREQ__(ma, mi) 0
127 * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
128 * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
129 * The __CONCAT macro is a bit tricky to use if it must work in non-ANSI
130 * mode -- there must be no spaces between its arguments, and for nested
131 * __CONCAT's, all the __CONCAT's must be at the left. __CONCAT can also
132 * concatenate double-quoted strings produced by the __STRING macro, but
133 * this only works with ANSI C.
135 * __XSTRING is like __STRING, but it expands any macros in its argument
136 * first. It is only available with ANSI C.
138 #if defined(__STDC__) || defined(__cplusplus)
139 #define __P(protos) protos /* full-blown ANSI C */
140 #define __CONCAT1(x,y) x ## y
141 #define __CONCAT(x,y) __CONCAT1(x,y)
142 #define __STRING(x) #x /* stringify without expanding x */
143 #define __XSTRING(x) __STRING(x) /* expand x, then stringify */
145 #define __const const /* define reserved names to standard */
146 #define __signed signed
147 #define __volatile volatile
148 #if defined(__cplusplus)
149 #define __inline inline /* convert to C++ keyword */
151 #if !(defined(__CC_SUPPORTS___INLINE))
152 #define __inline /* delete GCC keyword */
153 #endif /* ! __CC_SUPPORTS___INLINE */
154 #endif /* !__cplusplus */
156 #else /* !(__STDC__ || __cplusplus) */
157 #define __P(protos) () /* traditional C preprocessor */
158 #define __CONCAT(x,y) x/**/y
159 #define __STRING(x) "x"
161 #if !defined(__CC_SUPPORTS___INLINE)
162 #define __const /* delete pseudo-ANSI C keywords */
167 * In non-ANSI C environments, new programs will want ANSI-only C keywords
168 * deleted from the program and old programs will want them left alone.
169 * When using a compiler other than gcc, programs using the ANSI C keywords
170 * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
171 * When using "gcc -traditional", we assume that this is the intent; if
172 * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
174 #ifndef NO_ANSI_KEYWORDS
175 #define const /* delete ANSI C keywords */
179 #endif /* !NO_ANSI_KEYWORDS */
180 #endif /* !__CC_SUPPORTS___INLINE */
181 #endif /* !(__STDC__ || __cplusplus) */
184 * Compiler-dependent macros to help declare dead (non-returning) and
185 * pure (no side effects) functions, and unused variables. They are
186 * null except for versions of gcc that are known to support the features
187 * properly (old versions of gcc-2 supported the dead and pure features
188 * in a different (wrong) way). If we do not provide an implementation
189 * for a given compiler, let the compile fail if it is told to use
190 * a feature that we cannot live without.
200 #if !__GNUC_PREREQ__(2, 5) && !defined(__INTEL_COMPILER)
205 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 && __GNUC_MINOR__ < 7 && !defined(__INTEL_COMPILER)
206 #define __dead2 __attribute__((__noreturn__))
207 #define __pure2 __attribute__((__const__))
209 /* XXX Find out what to do for __packed, __aligned and __section */
211 #if __GNUC_PREREQ__(2, 7)
212 #define __dead2 __attribute__((__noreturn__))
213 #define __pure2 __attribute__((__const__))
214 #define __unused __attribute__((__unused__))
215 #define __used __attribute__((__used__))
216 #define __packed __attribute__((__packed__))
217 #define __aligned(x) __attribute__((__aligned__(x)))
218 #define __section(x) __attribute__((__section__(x)))
220 #if defined(__INTEL_COMPILER)
221 #define __dead2 __attribute__((__noreturn__))
222 #define __pure2 __attribute__((__const__))
223 #define __unused __attribute__((__unused__))
224 #define __used __attribute__((__used__))
225 #define __packed __attribute__((__packed__))
226 #define __aligned(x) __attribute__((__aligned__(x)))
227 #define __section(x) __attribute__((__section__(x)))
231 #if __GNUC_PREREQ__(2, 96)
232 #define __pure __attribute__((__pure__))
237 #if __GNUC_PREREQ__(3, 1) || (defined(__INTEL_COMPILER) && __INTEL_COMPILER >= 800)
238 #define __always_inline __attribute__((__always_inline__))
240 #define __always_inline
243 #if __GNUC_PREREQ__(3, 3)
244 #define __nonnull(x) __attribute__((__nonnull__(x)))
249 /* XXX: should use `#if __STDC_VERSION__ < 199901'. */
250 #if __STDC_VERSION__ < 199901
251 #if !__GNUC_PREREQ__(2, 7) && !defined(__INTEL_COMPILER)
256 #if (defined(__INTEL_COMPILER) || (defined(__GNUC__) && __GNUC__ >= 2)) && !defined(__STRICT_ANSI__) || __STDC_VERSION__ >= 199901
258 #ifndef __LONG_LONG_SUPPORTED
259 #define __LONG_LONG_SUPPORTED
260 #endif /* __LONG_LONG_SUPPORTED */
262 #define __LONG_LONG_SUPPORTED
263 #endif /* __SYMBIAN32__ */
267 #if ((defined(__ARMCC__) && (__ARMCC_VERSION > 220000) ) || (defined(__WINSCW__)))
268 #ifndef __LONG_LONG_SUPPORTED
269 #define __LONG_LONG_SUPPORTED
270 #endif /* __LONG_LONG_SUPPORTED */
272 #endif /*__SYMBIAN32__*/
276 * GCC 2.95 provides `__restrict' as an extension to C90 to support the
277 * C99-specific `restrict' type qualifier. We happen to use `__restrict' as
278 * a way to define the `restrict' type qualifier without disturbing older
279 * software that is unaware of C99 keywords.
281 #if !(__GNUC__ == 2 && __GNUC_MINOR__ == 95)
282 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901
285 #define __restrict restrict
290 * GNU C version 2.96 adds explicit branch prediction so that
291 * the CPU back-end can hint the processor and also so that
292 * code blocks can be reordered such that the predicted path
293 * sees a more linear flow, thus improving cache behavior, etc.
295 * The following two macros provide us with a way to utilize this
296 * compiler feature. Use __predict_true() if you expect the expression
297 * to evaluate to true, and __predict_false() if you expect the
298 * expression to evaluate to false.
300 * A few notes about usage:
302 * * Generally, __predict_false() error condition checks (unless
303 * you have some _strong_ reason to do otherwise, in which case
304 * document it), and/or __predict_true() `no-error' condition
305 * checks, assuming you want to optimize for the no-error case.
307 * * Other than that, if you don't know the likelihood of a test
308 * succeeding from empirical or other `hard' evidence, don't
311 * * These are meant to be used in places that are run `a lot'.
312 * It is wasteful to make predictions in code that is run
313 * seldomly (e.g. at subsystem initialization time) as the
314 * basic block reordering that this affects can often generate
317 #if __GNUC_PREREQ__(2, 96)
318 #define __predict_true(exp) __builtin_expect((exp), 1)
319 #define __predict_false(exp) __builtin_expect((exp), 0)
321 #define __predict_true(exp) (exp)
322 #define __predict_false(exp) (exp)
326 * We define this here since <stddef.h>, <sys/queue.h>, and <sys/types.h>
329 #if !defined(__cplusplus)
330 #define __offsetof(type, field) ((size_t)(&((type *)0)->field))
332 #if defined(__GNUC__)
334 #define __offsetof(type, field) \
335 (__builtin_offsetof (type,field))
337 #define __offsetof(type, field) \
338 (__offsetof__ (type,field))
341 #define __offsetof(type, field) (reinterpret_cast <size_t> \
342 (&reinterpret_cast <const volatile char &> \
343 (static_cast<type *> (0)->field)))
347 #define __rangeof(type, start, end) \
348 (__offsetof(type, end) - __offsetof(type, start))
351 * Compiler-dependent macros to declare that functions take printf-like
352 * or scanf-like arguments. They are null except for versions of gcc
353 * that are known to support the features properly (old versions of gcc-2
354 * didn't permit keeping the keywords out of the application namespace).
356 #if !__GNUC_PREREQ__(2, 7) && !defined(__INTEL_COMPILER)
357 #define __printflike(fmtarg, firstvararg)
358 #define __scanflike(fmtarg, firstvararg)
360 #define __printflike(fmtarg, firstvararg) \
361 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
362 #define __scanflike(fmtarg, firstvararg) \
363 __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
366 /* Compiler-dependent macros that rely on FreeBSD-specific extensions. */
367 #if __FreeBSD_cc_version >= 300001 && defined(__GNUC__) && !defined(__INTEL_COMPILER)
368 #define __printf0like(fmtarg, firstvararg) \
369 __attribute__((__format__ (__printf0__, fmtarg, firstvararg)))
371 #define __printf0like(fmtarg, firstvararg)
374 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
375 #ifndef __INTEL_COMPILER
376 #define __strong_reference(sym,aliassym) \
377 extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym)));
380 #define __weak_reference(sym,alias) \
381 __asm__(".weak " #alias); \
382 __asm__(".equ " #alias ", " #sym)
383 #define __warn_references(sym,msg) \
384 __asm__(".section .gnu.warning." #sym); \
385 __asm__(".asciz \"" msg "\""); \
388 #define __weak_reference(sym,alias) \
389 __asm__(".weak alias"); \
390 __asm__(".equ alias, sym")
391 #define __warn_references(sym,msg) \
392 __asm__(".section .gnu.warning.sym"); \
393 __asm__(".asciz \"msg\""); \
395 #endif /* __STDC__ */
396 #endif /* __GNUC__ || __INTEL_COMPILER */
398 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
399 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"")
402 * The following definition might not work well if used in header files,
403 * but it should be better than nothing. If you want a "do nothing"
404 * version, then it should generate some harmless declaration, such as:
405 * #define __IDSTRING(name,string) struct __hack
407 #define __IDSTRING(name,string) static const char name[] __unused = string
411 * Embed the rcs id of a source file in the resulting library. Note that in
412 * more recent ELF binutils, we use .ident allowing the ID to be stripped.
414 * __FBSDID("$FreeBSD: src/sys/sys/cdefs.h,v 1.88.2.1 2005/10/09 07:48:48 netchild Exp $");
417 #if !defined(lint) && !defined(STRIP_FBSDID)
418 #define __FBSDID(s) __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
420 #define __FBSDID(s) struct __hack
426 #define __RCSID(s) __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
428 #define __RCSID(s) struct __hack
432 #ifndef __RCSID_SOURCE
433 #ifndef NO__RCSID_SOURCE
434 #define __RCSID_SOURCE(s) __IDSTRING(__CONCAT(__rcsid_source_,__LINE__),s)
436 #define __RCSID_SOURCE(s) struct __hack
442 #define __SCCSID(s) __IDSTRING(__CONCAT(__sccsid_,__LINE__),s)
444 #define __SCCSID(s) struct __hack
449 #ifndef NO__COPYRIGHT
450 #define __COPYRIGHT(s) __IDSTRING(__CONCAT(__copyright_,__LINE__),s)
452 #define __COPYRIGHT(s) struct __hack
457 #define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var))
461 #define __DEVOLATILE(type, var) ((type)(uintptr_t)(volatile void *)(var))
465 #define __DEQUALIFY(type, var) ((type)(uintptr_t)(const volatile void *)(var))
469 * The following definitions are an extension of the behavior originally
470 * implemented in <sys/_posix.h>, but with a different level of granularity.
471 * POSIX.1 requires that the macros we test be defined before any standard
472 * header file is included.
474 * Here's a quick run-down of the versions:
475 * defined(_POSIX_SOURCE) 1003.1-1988
476 * _POSIX_C_SOURCE == 1 1003.1-1990
477 * _POSIX_C_SOURCE == 2 1003.2-1992 C Language Binding Option
478 * _POSIX_C_SOURCE == 199309 1003.1b-1993
479 * _POSIX_C_SOURCE == 199506 1003.1c-1995, 1003.1i-1995,
480 * and the omnibus ISO/IEC 9945-1: 1996
481 * _POSIX_C_SOURCE == 200112 1003.1-2001
483 * In addition, the X/Open Portability Guide, which is now the Single UNIX
484 * Specification, defines a feature-test macro which indicates the version of
485 * that specification, and which subsumes _POSIX_C_SOURCE.
487 * Our macros begin with two underscores to avoid namespace screwage.
490 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */
491 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 1
492 #undef _POSIX_C_SOURCE /* Probably illegal, but beyond caring now. */
493 #define _POSIX_C_SOURCE 199009
496 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */
497 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 2
498 #undef _POSIX_C_SOURCE
499 #define _POSIX_C_SOURCE 199209
502 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
504 #if _XOPEN_SOURCE - 0 >= 600
505 #define __XSI_VISIBLE 600
506 #undef _POSIX_C_SOURCE
507 #define _POSIX_C_SOURCE 200112
508 #elif _XOPEN_SOURCE - 0 >= 500
509 #define __XSI_VISIBLE 500
510 #undef _POSIX_C_SOURCE
511 #define _POSIX_C_SOURCE 199506
516 * Deal with all versions of POSIX. The ordering relative to the tests above is
519 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
520 #define _POSIX_C_SOURCE 198808
522 #ifdef _POSIX_C_SOURCE
523 #if _POSIX_C_SOURCE >= 200112
525 #define __XSI_VISIBLE 600
526 #define __BSD_VISIBLE 1
527 #endif //__SYMBIAN32__
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 200112
571 #define __XSI_VISIBLE 600
572 #define __BSD_VISIBLE 1
573 #define __ISO_C_VISIBLE 1999
577 #endif /* !_SYS_CDEFS_H_ */