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 * 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.
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
36 * @(#)cdefs.h 8.8 (Berkeley) 1/9/95
37 * $FreeBSD: src/sys/sys/cdefs.h,v 1.28.2.8 2002/09/18 04:05:13 mikeh Exp $
38 * $DragonFly: src/sys/sys/cdefs.h,v 1.14 2005/02/04 22:28:23 joerg Exp $
44 #if defined(__cplusplus)
45 #define __BEGIN_DECLS extern "C" {
53 * Macro to test if we are using a specific version of gcc or later.
56 #define __GNUC_PREREQ__(ma, mi) \
57 (__GNUC__ > (ma) || __GNUC__ == (ma) && __GNUC_MINOR__ >= (mi))
59 #define __GNUC_PREREQ__(ma, mi) \
64 * The __VM_CACHELINE_SIZE macro defines the common cache line alignment
65 * size that can be found across most recent and somewhat latest Intel
66 * hardware, i.e. L1 cache sizes etc.
68 * If needed, this value can be TUNED. Suitable values for this macro
69 * are 32, 64 and 128 bytes. The unit of measurement for this macro is
72 * XXX: This macro and related macros will eventually move to a MD
73 * header, but currently, we do need such a hierarchy.
75 #define __VM_CACHELINE_SIZE 32
78 * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
79 * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
80 * The __CONCAT macro is a bit tricky to use if it must work in non-ANSI
81 * mode -- there must be no spaces between its arguments, and for nested
82 * __CONCAT's, all the __CONCAT's must be at the left. __CONCAT can also
83 * concatenate double-quoted strings produced by the __STRING macro, but
84 * this only works with ANSI C.
86 * __XSTRING is like __STRING, but it expands any macros in its argument
87 * first. It is only available with ANSI C.
89 #if defined(__STDC__) || defined(__cplusplus)
90 #define __P(protos) protos /* full-blown ANSI C */
91 #define __CONCAT1(x,y) x ## y
92 #define __CONCAT(x,y) __CONCAT1(x,y)
93 #define __STRING(x) #x /* stringify without expanding x */
94 #define __XSTRING(x) __STRING(x) /* expand x, then stringify */
96 #define __const const /* define reserved names to standard */
97 #define __signed signed
98 #define __volatile volatile
99 #if defined(__cplusplus)
100 #define __inline inline /* convert to C++ keyword */
103 #define __inline /* delete GCC keyword */
104 #endif /* !__GNUC__ */
105 #endif /* !__cplusplus */
107 #else /* !(__STDC__ || __cplusplus) */
108 #define __P(protos) () /* traditional C preprocessor */
109 #define __CONCAT(x,y) x/**/y
110 #define __STRING(x) "x"
113 #define __const /* delete pseudo-ANSI C keywords */
118 * In non-ANSI C environments, new programs will want ANSI-only C keywords
119 * deleted from the program and old programs will want them left alone.
120 * When using a compiler other than gcc, programs using the ANSI C keywords
121 * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
122 * When using "gcc -traditional", we assume that this is the intent; if
123 * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
125 #ifndef NO_ANSI_KEYWORDS
126 #define const /* delete ANSI C keywords */
130 #endif /* !NO_ANSI_KEYWORDS */
131 #endif /* !__GNUC__ */
132 #endif /* !(__STDC__ || __cplusplus) */
135 * Compiler-dependent macros to help declare dead (non-returning) and
136 * pure (no side effects) functions, and unused variables. They are
137 * null except for versions of gcc that are known to support the features
138 * properly (old versions of gcc-2 supported the dead and pure features
139 * in a different (wrong) way).
149 #define __always_inline
154 #if !__GNUC_PREREQ__(2, 7)
160 #if __GNUC_PREREQ__(2, 7)
161 #define __dead2 __attribute__((__noreturn__))
162 #define __pure2 __attribute__((__const__))
163 #define __unused __attribute__((__unused__))
164 #define __packed __attribute__((__packed__))
165 #define __aligned(x) __attribute__((__aligned__(x)))
166 #define __section(x) __attribute__((__section__(x)))
169 #if __GNUC_PREREQ__(3, 1)
170 #define __always_inline __attribute__((__always_inline__))
172 #define __always_inline
175 #if __GNUC_PREREQ__(3, 3)
176 #define __nonnull(x) __attribute__((__nonnull__(x)))
177 #define __used __attribute__((__used__))
180 #define __used __unused
185 #if !__GNUC_PREREQ__(2, 7) && __STDC_VERSION < 199901
186 #define __func__ NULL
189 #if (__GNUC_PREREQ__(2, 0) && !defined(__STRICT_ANSI)) || \
190 __STDC_VERSION__ >= 199901
191 #define __LONG_LONG_SUPPORTED
195 * GCC 2.95 and later provides `__restrict' as an extention to C90 to support
196 * the C99-specific `restrict' type qualifier. We happen to use `__restrict'
197 * as a way to define the `restrict' type qualifier without disturbing older
198 * software that is unaware of C99 keywords.
200 #if !__GNUC_PREREQ__(2, 95)
201 #if __STDC_VERSION__ < 199901
204 #define __restrict restrict
209 * Compiler-dependent macros to declare that functions take printf-like
210 * or scanf-like arguments. They are null except for versions of gcc
211 * that are known to support the features properly (old versions of gcc-2
212 * didn't permit keeping the keywords out of the application namespace).
214 * The printf0like macro for GCC 2 uses DragonFly specific compiler extensions.
216 #if !__GNUC_PREREQ__(2, 7)
217 #define __printflike(fmtarg, firstvararg)
218 #define __scanflike(fmtarg, firstvararg)
219 #define __printf0like(fmtarg, firstvararg)
220 #elif __GNUC_PREREQ__(3, 0)
221 #define __printflike(fmtarg, firstvararg) \
222 __attribute__((__nonnull__(fmtarg), \
223 __format__ (__printf__, fmtarg, firstvararg)))
224 #define __printf0like(fmtarg, firstvararg) \
225 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
226 #define __scanflike(fmtarg, firstvararg) \
227 __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
230 #define __printflike(fmtarg, firstvararg) \
231 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
232 #define __printf0like(fmtarg, firstvararg) \
233 __attribute__((__format__ (__printf0__, fmtarg, firstvararg)))
234 #define __scanflike(fmtarg, firstvararg) \
235 __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
238 #if !__GNUC_PREREQ__(3, 0)
239 #define __ARRAY_ZERO 0
245 * Handy GCC based macros:
249 * The __cachealign macro can be used for cache line aligning structures
250 * of small to medium size. It aligns the particular structure or
251 * storage type to a system default cache line alignment, thus giving us
252 * a much more better cache utilization by making the hardware work at
253 * its best burst speeds.
257 * The __usereg macro can/should be used when a function contains
258 * arguments not more than 3. It can be very useful to us due to the
259 * message-passing nature of the kernel.
261 * !!NOTE - USAGE INFORMATION!!
263 * The __cachealign macro should not be used for data structures that are
264 * as big struct proc, struct vnode, struct thread, and other structs which
265 * are as big as them; simply because it will be useless in that case.
267 * The __usereg macro should be used whenever possible, i.e., when a function
268 * does not exceed more than 3 arguments, and should not be used for vararg
271 * In other words, AVOID MISUSE OF THESE MACROS. :-)
274 #define __cachealign __attribute__((__aligned__(__VM_CACHELINE_SIZE)))
275 #define __usereg __attribute__((__regparm__(3)))
282 #define __strong_reference(sym,aliassym) \
283 extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym)));
284 #define __weak_reference(sym,alias) \
285 __asm__(".weak " #alias); \
286 __asm__(".equ " #alias ", " #sym)
287 #define __warn_references(sym,msg) \
288 __asm__(".section .gnu.warning." #sym); \
289 __asm__(".asciz \"" msg "\""); \
291 #endif /* __GNUC__ */
293 #if defined(__GNUC__)
294 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"")
298 #define __RCSID(s) __IDSTRING(rcsid,s)
301 #ifndef __RCSID_SOURCE
302 #define __RCSID_SOURCE(s) __IDSTRING(rcsid_source,s)
306 #define __COPYRIGHT(s) __IDSTRING(copyright,s)
310 #define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var))
314 #define __DEVOLATILE(type, var) ((type)(uintptr_t)(volatile void *)(var))
318 #define __DEQUALIFY(type, var) ((type)(uintptr_t)(const volatile void *)(var))
322 * The following definitions are an extension of the behavior originally
323 * implemented in <sys/_posix.h>, but with a different level of granularity.
324 * POSIX.1 requires that the macros we test be defined before any standard
325 * header file is included.
327 * Here's a quick run-down of the versions:
328 * defined(_POSIX_SOURCE) 1003.1-1988
329 * _POSIX_C_SOURCE == 1 1003.1-1990
330 * _POSIX_C_SOURCE == 2 1003.2-1992 C Language Binding Option
331 * _POSIX_C_SOURCE == 199309 1003.1b-1993
332 * _POSIX_C_SOURCE == 199506 1003.1c-1995, 1003.1i-1995,
333 * and the omnibus ISO/IEC 9945-1: 1996
334 * _POSIX_C_SOURCE == 200112 1003.1-2001
336 * In addition, the X/Open Portability Guide, which is now the Single UNIX
337 * Specification, defines a feature-test macro which indicates the version of
338 * that specification, and which subsumes _POSIX_C_SOURCE.
340 * Our macros begin with two underscores to avoid namespace screwage.
343 #if defined(_POSIX_C_SOURCE)
345 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */
346 #if _POSIX_C_SOURCE == 1
347 #undef _POSIX_C_SOURCE /* Probably illegal, but beyond caring now. */
348 #define _POSIX_C_SOURCE 199009
351 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */
352 #if _POSIX_C_SOURCE == 2
353 #undef _POSIX_C_SOURCE
354 #define _POSIX_C_SOURCE 199209
357 #endif /* _POSIX_C_SOURCE */
359 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
361 #if _XOPEN_SOURCE - 0 >= 600
362 #define __XSI_VISIBLE 600
363 #undef _POSIX_C_SOURCE
364 #define _POSIX_C_SOURCE 200112
365 #elif _XOPEN_SOURCE - 0 >= 500
366 #define __XSI_VISIBLE 500
367 #undef _POSIX_C_SOURCE
368 #define _POSIX_C_SOURCE 199506
373 * Deal with all versions of POSIX. The ordering relative to the tests above is
376 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
377 #define _POSIX_C_SOURCE 198808
379 #ifdef _POSIX_C_SOURCE
380 #if _POSIX_C_SOURCE >= 200112
381 #define __POSIX_VISIBLE 200112
382 #define __ISO_C_VISIBLE 1999
383 #elif _POSIX_C_SOURCE >= 199506
384 #define __POSIX_VISIBLE 199506
385 #define __ISO_C_VISIBLE 1990
386 #elif _POSIX_C_SOURCE >= 199309
387 #define __POSIX_VISIBLE 199309
388 #define __ISO_C_VISIBLE 1990
389 #elif _POSIX_C_SOURCE >= 199209
390 #define __POSIX_VISIBLE 199209
391 #define __ISO_C_VISIBLE 1990
392 #elif _POSIX_C_SOURCE >= 199009
393 #define __POSIX_VISIBLE 199009
394 #define __ISO_C_VISIBLE 1990
396 #define __POSIX_VISIBLE 198808
397 #define __ISO_C_VISIBLE 0
398 #endif /* _POSIX_C_SOURCE */
401 * Deal with _ANSI_SOURCE:
402 * If it is defined, and no other compilation environment is explicitly
403 * requested, then define our internal feature-test macros to zero. This
404 * makes no difference to the preprocessor (undefined symbols in preprocessing
405 * expressions are defined to have value zero), but makes it more convenient for
406 * a test program to print out the values.
408 * If a program mistakenly defines _ANSI_SOURCE and some other macro such as
409 * _POSIX_C_SOURCE, we will assume that it wants the broader compilation
410 * environment (and in fact we will never get here).
412 #ifdef _ANSI_SOURCE /* Hide almost everything. */
413 #define __POSIX_VISIBLE 0
414 #define __XSI_VISIBLE 0
415 #define __BSD_VISIBLE 0
416 #define __ISO_C_VISIBLE 1990
417 #elif defined(_C99_SOURCE) /* Localism to specify strict C99 env. */
418 #define __POSIX_VISIBLE 0
419 #define __XSI_VISIBLE 0
420 #define __BSD_VISIBLE 0
421 #define __ISO_C_VISIBLE 1999
422 #else /* Default environment: show everything. */
423 #define __POSIX_VISIBLE 200112
424 #define __XSI_VISIBLE 600
425 #define __BSD_VISIBLE 1
426 #define __ISO_C_VISIBLE 1999
430 #endif /* !_SYS_CDEFS_H_ */