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.9 2004/03/13 12:39:56 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, 5)
160 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 && __GNUC_MINOR__ < 7
161 #define __dead2 __attribute__((__noreturn__))
162 #define __pure2 __attribute__((__const__))
166 #if __GNUC_PREREQ__(2, 7)
167 #define __dead2 __attribute__((__noreturn__))
168 #define __pure2 __attribute__((__const__))
169 #define __unused __attribute__((__unused__))
170 #define __packed __attribute__((__packed__))
171 #define __aligned(x) __attribute__((__aligned__(x)))
172 #define __section(x) __attribute__((__section__(x)))
175 #if __GNUC_PREREQ__(3, 1)
176 #define __always_inline __attribute__((__always_inline__))
178 #define __always_inline
181 #if __GNUC_PREREQ__(3, 3)
182 #define __nonnull(x) __attribute__((__nonnull__(x)))
187 /* XXX: should use `#if __STDC_VERSION__ < 199901'. */
188 #if !__GNUC_PREREQ__(2, 7)
189 #define __func__ NULL
194 /* XXX: should use `#if __STDC_VERSION__ < 199901'. */
195 #if !(__GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3)
196 #define __func__ NULL
199 #if __GNUC__ >= 2 && !defined(__STRICT_ANSI__) || __STDC_VERSION__ >= 199901
200 #define __LONG_LONG_SUPPORTED
204 * GCC 2.95 provides `__restrict' as an extention to C90 to support the
205 * C99-specific `restrict' type qualifier. We happen to use `__restrict' as
206 * a way to define the `restrict' type qualifier without disturbing older
207 * software that is unaware of C99 keywords.
209 #if !(__GNUC__ == 2 && __GNUC_MINOR__ == 95)
210 #if __STDC_VERSION__ < 199901
213 #define __restrict restrict
218 * Compiler-dependent macros to declare that functions take printf-like
219 * or scanf-like arguments. They are null except for versions of gcc
220 * that are known to support the features properly (old versions of gcc-2
221 * didn't permit keeping the keywords out of the application namespace).
223 #if __GNUC__ < 2 || __GNUC__ == 2 && __GNUC_MINOR__ < 7
224 #define __printflike(fmtarg, firstvararg)
225 #define __scanflike(fmtarg, firstvararg)
227 #define __printflike(fmtarg, firstvararg) \
228 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
229 #define __scanflike(fmtarg, firstvararg) \
230 __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
234 #define __ARRAY_ZERO 0
239 /* Compiler-dependent macros that rely on FreeBSD-specific extensions. */
240 #if defined(__DragonFly__) || __FreeBSD_cc_version >= 300001
241 #define __printf0like(fmtarg, firstvararg) \
242 __attribute__((__format__ (__printf0__, fmtarg, firstvararg)))
244 #define __printf0like(fmtarg, firstvararg)
248 * Handy GCC based macros:
252 * The __cachealign macro can be used for cache line aligning structures
253 * of small to medium size. It aligns the particular structure or
254 * storage type to a system default cache line alignment, thus giving us
255 * a much more better cache utilization by making the hardware work at
256 * its best burst speeds.
260 * The __usereg macro can/should be used when a function contains
261 * arguments not more than 3. It can be very useful to us due to the
262 * message-passing nature of the kernel.
264 * !!NOTE - USAGE INFORMATION!!
266 * The __cachealign macro should not be used for data structures that are
267 * as big struct proc, struct vnode, struct thread, and other structs which
268 * are as big as them; simply because it will be useless in that case.
270 * The __usereg macro should be used whenever possible, i.e., when a function
271 * does not exceed more than 3 arguments, and should not be used for vararg
274 * In other words, AVOID MISUSE OF THESE MACROS. :-)
277 #define __cachealign __attribute__((aligned(VM_CACHELINE_SIZE)))
278 #define __usereg __attribute__((regparm(3)))
285 #define __strong_reference(sym,aliassym) \
286 extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym)));
289 #define __weak_reference(sym,alias) \
290 __asm__(".weak " #alias); \
291 __asm__(".equ " #alias ", " #sym)
292 #define __warn_references(sym,msg) \
293 __asm__(".section .gnu.warning." #sym); \
294 __asm__(".asciz \"" msg "\""); \
297 #define __weak_reference(sym,alias) \
298 __asm__(".weak alias"); \
299 __asm__(".equ alias, sym")
300 #define __warn_references(sym,msg) \
301 __asm__(".section .gnu.warning.sym"); \
302 __asm__(".asciz \"msg\""); \
304 #endif /* __STDC__ */
307 #define __weak_reference(sym,alias) \
308 __asm__(".stabs \"_" #alias "\",11,0,0,0"); \
309 __asm__(".stabs \"_" #sym "\",1,0,0,0")
310 #define __warn_references(sym,msg) \
311 __asm__(".stabs \"" msg "\",30,0,0,0"); \
312 __asm__(".stabs \"_" #sym "\",1,0,0,0")
314 #define __weak_reference(sym,alias) \
315 __asm__(".stabs \"_/**/alias\",11,0,0,0"); \
316 __asm__(".stabs \"_/**/sym\",1,0,0,0")
317 #define __warn_references(sym,msg) \
318 __asm__(".stabs msg,30,0,0,0"); \
319 __asm__(".stabs \"_/**/sym\",1,0,0,0")
320 #endif /* __STDC__ */
322 #endif /* __GNUC__ */
324 #if defined(__GNUC__) && defined(__ELF__)
325 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"")
327 #define __IDSTRING(name,string) static const char name[] __unused = string
331 #define __RCSID(s) __IDSTRING(rcsid,s)
334 #ifndef __RCSID_SOURCE
335 #define __RCSID_SOURCE(s) __IDSTRING(rcsid_source,s)
339 #define __COPYRIGHT(s) __IDSTRING(copyright,s)
343 #define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var))
347 #define __DEVOLATILE(type, var) ((type)(uintptr_t)(volatile void *)(var))
351 #define __DEQUALIFY(type, var) ((type)(uintptr_t)(const volatile void *)(var))
355 * The following definitions are an extension of the behavior originally
356 * implemented in <sys/_posix.h>, but with a different level of granularity.
357 * POSIX.1 requires that the macros we test be defined before any standard
358 * header file is included.
360 * Here's a quick run-down of the versions:
361 * defined(_POSIX_SOURCE) 1003.1-1988
362 * _POSIX_C_SOURCE == 1 1003.1-1990
363 * _POSIX_C_SOURCE == 2 1003.2-1992 C Language Binding Option
364 * _POSIX_C_SOURCE == 199309 1003.1b-1993
365 * _POSIX_C_SOURCE == 199506 1003.1c-1995, 1003.1i-1995,
366 * and the omnibus ISO/IEC 9945-1: 1996
367 * _POSIX_C_SOURCE == 200112 1003.1-2001
369 * In addition, the X/Open Portability Guide, which is now the Single UNIX
370 * Specification, defines a feature-test macro which indicates the version of
371 * that specification, and which subsumes _POSIX_C_SOURCE.
373 * Our macros begin with two underscores to avoid namespace screwage.
376 #if defined(_POSIX_C_SOURCE)
378 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */
379 #if _POSIX_C_SOURCE == 1
380 #undef _POSIX_C_SOURCE /* Probably illegal, but beyond caring now. */
381 #define _POSIX_C_SOURCE 199009
384 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */
385 #if _POSIX_C_SOURCE == 2
386 #undef _POSIX_C_SOURCE
387 #define _POSIX_C_SOURCE 199209
390 #endif /* _POSIX_C_SOURCE */
392 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
394 #if _XOPEN_SOURCE - 0 >= 600
395 #define __XSI_VISIBLE 600
396 #undef _POSIX_C_SOURCE
397 #define _POSIX_C_SOURCE 200112
398 #elif _XOPEN_SOURCE - 0 >= 500
399 #define __XSI_VISIBLE 500
400 #undef _POSIX_C_SOURCE
401 #define _POSIX_C_SOURCE 199506
406 * Deal with all versions of POSIX. The ordering relative to the tests above is
409 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
410 #define _POSIX_C_SOURCE 198808
412 #ifdef _POSIX_C_SOURCE
413 #if _POSIX_C_SOURCE >= 200112
414 #define __POSIX_VISIBLE 200112
415 #define __ISO_C_VISIBLE 1999
416 #elif _POSIX_C_SOURCE >= 199506
417 #define __POSIX_VISIBLE 199506
418 #define __ISO_C_VISIBLE 1990
419 #elif _POSIX_C_SOURCE >= 199309
420 #define __POSIX_VISIBLE 199309
421 #define __ISO_C_VISIBLE 1990
422 #elif _POSIX_C_SOURCE >= 199209
423 #define __POSIX_VISIBLE 199209
424 #define __ISO_C_VISIBLE 1990
425 #elif _POSIX_C_SOURCE >= 199009
426 #define __POSIX_VISIBLE 199009
427 #define __ISO_C_VISIBLE 1990
429 #define __POSIX_VISIBLE 198808
430 #define __ISO_C_VISIBLE 0
431 #endif /* _POSIX_C_SOURCE */
434 * Deal with _ANSI_SOURCE:
435 * If it is defined, and no other compilation environment is explicitly
436 * requested, then define our internal feature-test macros to zero. This
437 * makes no difference to the preprocessor (undefined symbols in preprocessing
438 * expressions are defined to have value zero), but makes it more convenient for
439 * a test program to print out the values.
441 * If a program mistakenly defines _ANSI_SOURCE and some other macro such as
442 * _POSIX_C_SOURCE, we will assume that it wants the broader compilation
443 * environment (and in fact we will never get here).
445 #ifdef _ANSI_SOURCE /* Hide almost everything. */
446 #define __POSIX_VISIBLE 0
447 #define __XSI_VISIBLE 0
448 #define __BSD_VISIBLE 0
449 #define __ISO_C_VISIBLE 1990
450 #else /* Default environment: show everything. */
451 #define __POSIX_VISIBLE 200112
452 #define __XSI_VISIBLE 600
453 #define __BSD_VISIBLE 1
454 #define __ISO_C_VISIBLE 1999
458 #endif /* !_SYS_CDEFS_H_ */