1 /* 2 * Copyright (c) 1991, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * This code is derived from software contributed to Berkeley by 6 * Berkeley Software Design, Inc. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 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. 23 * 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 34 * SUCH DAMAGE. 35 * 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.10 2004/03/20 16:27:41 drhodus Exp $ 39 */ 40 41 #ifndef _SYS_CDEFS_H_ 42 #define _SYS_CDEFS_H_ 43 44 #if defined(__cplusplus) 45 #define __BEGIN_DECLS extern "C" { 46 #define __END_DECLS } 47 #else 48 #define __BEGIN_DECLS 49 #define __END_DECLS 50 #endif 51 52 /* 53 * Macro to test if we are using a specific version of gcc or later. 54 */ 55 #ifdef __GNUC__ 56 #define __GNUC_PREREQ__(ma, mi) \ 57 (__GNUC__ > (ma) || __GNUC__ == (ma) && __GNUC_MINOR__ >= (mi)) 58 #else 59 #define __GNUC_PREREQ__(ma, mi) \ 60 0 61 #endif 62 63 /* 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. 67 * 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 70 * bytes. 71 * 72 * XXX: This macro and related macros will eventually move to a MD 73 * header, but currently, we do need such a hierarchy. 74 */ 75 #define VM_CACHELINE_SIZE 32 76 77 /* 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. 85 * 86 * __XSTRING is like __STRING, but it expands any macros in its argument 87 * first. It is only available with ANSI C. 88 */ 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 */ 95 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 */ 101 #else 102 #ifndef __GNUC__ 103 #define __inline /* delete GCC keyword */ 104 #endif /* !__GNUC__ */ 105 #endif /* !__cplusplus */ 106 107 #else /* !(__STDC__ || __cplusplus) */ 108 #define __P(protos) () /* traditional C preprocessor */ 109 #define __CONCAT(x,y) x/**/y 110 #define __STRING(x) "x" 111 112 #ifndef __GNUC__ 113 #define __const /* delete pseudo-ANSI C keywords */ 114 #define __inline 115 #define __signed 116 #define __volatile 117 /* 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. 124 */ 125 #ifndef NO_ANSI_KEYWORDS 126 #define const /* delete ANSI C keywords */ 127 #define inline 128 #define signed 129 #define volatile 130 #endif /* !NO_ANSI_KEYWORDS */ 131 #endif /* !__GNUC__ */ 132 #endif /* !(__STDC__ || __cplusplus) */ 133 134 /* 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). 140 */ 141 #ifdef lint 142 143 #define __dead2 144 #define __pure2 145 #define __unused 146 #define __packed 147 #define __aligned(x) 148 #define __section(x) 149 #define __always_inline 150 #define __nonnull(x) 151 152 #else 153 154 #if !__GNUC_PREREQ__(2, 5) 155 #define __dead2 156 #define __pure2 157 #define __unused 158 #endif 159 160 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 && __GNUC_MINOR__ < 7 161 #define __dead2 __attribute__((__noreturn__)) 162 #define __pure2 __attribute__((__const__)) 163 #define __unused 164 #endif 165 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))) 173 #endif 174 175 #if __GNUC_PREREQ__(3, 1) 176 #define __always_inline __attribute__((__always_inline__)) 177 #else 178 #define __always_inline 179 #endif 180 181 #if __GNUC_PREREQ__(3, 3) 182 #define __nonnull(x) __attribute__((__nonnull__(x))) 183 #else 184 #define __nonnull(x) 185 #endif 186 187 /* XXX: should use `#if __STDC_VERSION__ < 199901'. */ 188 #if !__GNUC_PREREQ__(2, 7) 189 #define __func__ NULL 190 #endif 191 192 #endif /* LINT */ 193 194 /* XXX: should use `#if __STDC_VERSION__ < 199901'. */ 195 #if !(__GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3) 196 #define __func__ NULL 197 #endif 198 199 #if __GNUC__ >= 2 && !defined(__STRICT_ANSI__) || __STDC_VERSION__ >= 199901 200 #define __LONG_LONG_SUPPORTED 201 #endif 202 203 /* 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. 208 */ 209 #if !(__GNUC__ == 2 && __GNUC_MINOR__ == 95) 210 #if __STDC_VERSION__ < 199901 211 #define __restrict 212 #else 213 #define __restrict restrict 214 #endif 215 #endif 216 217 /* 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). 222 */ 223 #if __GNUC__ < 2 || __GNUC__ == 2 && __GNUC_MINOR__ < 7 224 #define __printflike(fmtarg, firstvararg) 225 #define __scanflike(fmtarg, firstvararg) 226 #else 227 #define __printflike(fmtarg, firstvararg) \ 228 __attribute__((__format__ (__printf__, fmtarg, firstvararg))) 229 #define __scanflike(fmtarg, firstvararg) \ 230 __attribute__((__format__ (__scanf__, fmtarg, firstvararg))) 231 #endif 232 233 #if __GNUC__ < 3 234 #define __ARRAY_ZERO 0 235 #else 236 #define __ARRAY_ZERO 237 #endif 238 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))) 243 #else 244 #define __printf0like(fmtarg, firstvararg) 245 #endif 246 247 /* 248 * Handy GCC based macros: 249 * 250 * __cachealign: 251 * 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. 257 * 258 * __usereg: 259 * 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. 263 * 264 * !!NOTE - USAGE INFORMATION!! 265 * 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. 269 * 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 272 * type functions. 273 * 274 * In other words, AVOID MISUSE OF THESE MACROS. :-) 275 */ 276 #ifdef __GNUC__ 277 #define __cachealign __attribute__((aligned(VM_CACHELINE_SIZE))) 278 #define __usereg __attribute__((regparm(3))) 279 #else 280 #define __cachealign 281 #define __usereg 282 #endif 283 284 #ifdef __GNUC__ 285 #define __strong_reference(sym,aliassym) \ 286 extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym))); 287 #ifdef __STDC__ 288 #define __weak_reference(sym,alias) \ 289 __asm__(".weak " #alias); \ 290 __asm__(".equ " #alias ", " #sym) 291 #define __warn_references(sym,msg) \ 292 __asm__(".section .gnu.warning." #sym); \ 293 __asm__(".asciz \"" msg "\""); \ 294 __asm__(".previous") 295 #else 296 #define __weak_reference(sym,alias) \ 297 __asm__(".weak alias"); \ 298 __asm__(".equ alias, sym") 299 #define __warn_references(sym,msg) \ 300 __asm__(".section .gnu.warning.sym"); \ 301 __asm__(".asciz \"msg\""); \ 302 __asm__(".previous") 303 #endif /* __STDC__ */ 304 #endif /* __GNUC__ */ 305 306 #if defined(__GNUC__) 307 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"") 308 #endif 309 310 #ifndef __RCSID 311 #define __RCSID(s) __IDSTRING(rcsid,s) 312 #endif 313 314 #ifndef __RCSID_SOURCE 315 #define __RCSID_SOURCE(s) __IDSTRING(rcsid_source,s) 316 #endif 317 318 #ifndef __COPYRIGHT 319 #define __COPYRIGHT(s) __IDSTRING(copyright,s) 320 #endif 321 322 #ifndef __DECONST 323 #define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var)) 324 #endif 325 326 #ifndef __DEVOLATILE 327 #define __DEVOLATILE(type, var) ((type)(uintptr_t)(volatile void *)(var)) 328 #endif 329 330 #ifndef __DEQUALIFY 331 #define __DEQUALIFY(type, var) ((type)(uintptr_t)(const volatile void *)(var)) 332 #endif 333 334 /*- 335 * The following definitions are an extension of the behavior originally 336 * implemented in <sys/_posix.h>, but with a different level of granularity. 337 * POSIX.1 requires that the macros we test be defined before any standard 338 * header file is included. 339 * 340 * Here's a quick run-down of the versions: 341 * defined(_POSIX_SOURCE) 1003.1-1988 342 * _POSIX_C_SOURCE == 1 1003.1-1990 343 * _POSIX_C_SOURCE == 2 1003.2-1992 C Language Binding Option 344 * _POSIX_C_SOURCE == 199309 1003.1b-1993 345 * _POSIX_C_SOURCE == 199506 1003.1c-1995, 1003.1i-1995, 346 * and the omnibus ISO/IEC 9945-1: 1996 347 * _POSIX_C_SOURCE == 200112 1003.1-2001 348 * 349 * In addition, the X/Open Portability Guide, which is now the Single UNIX 350 * Specification, defines a feature-test macro which indicates the version of 351 * that specification, and which subsumes _POSIX_C_SOURCE. 352 * 353 * Our macros begin with two underscores to avoid namespace screwage. 354 */ 355 356 #if defined(_POSIX_C_SOURCE) 357 358 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */ 359 #if _POSIX_C_SOURCE == 1 360 #undef _POSIX_C_SOURCE /* Probably illegal, but beyond caring now. */ 361 #define _POSIX_C_SOURCE 199009 362 #endif 363 364 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */ 365 #if _POSIX_C_SOURCE == 2 366 #undef _POSIX_C_SOURCE 367 #define _POSIX_C_SOURCE 199209 368 #endif 369 370 #endif /* _POSIX_C_SOURCE */ 371 372 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */ 373 #ifdef _XOPEN_SOURCE 374 #if _XOPEN_SOURCE - 0 >= 600 375 #define __XSI_VISIBLE 600 376 #undef _POSIX_C_SOURCE 377 #define _POSIX_C_SOURCE 200112 378 #elif _XOPEN_SOURCE - 0 >= 500 379 #define __XSI_VISIBLE 500 380 #undef _POSIX_C_SOURCE 381 #define _POSIX_C_SOURCE 199506 382 #endif 383 #endif 384 385 /* 386 * Deal with all versions of POSIX. The ordering relative to the tests above is 387 * important. 388 */ 389 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE) 390 #define _POSIX_C_SOURCE 198808 391 #endif 392 #ifdef _POSIX_C_SOURCE 393 #if _POSIX_C_SOURCE >= 200112 394 #define __POSIX_VISIBLE 200112 395 #define __ISO_C_VISIBLE 1999 396 #elif _POSIX_C_SOURCE >= 199506 397 #define __POSIX_VISIBLE 199506 398 #define __ISO_C_VISIBLE 1990 399 #elif _POSIX_C_SOURCE >= 199309 400 #define __POSIX_VISIBLE 199309 401 #define __ISO_C_VISIBLE 1990 402 #elif _POSIX_C_SOURCE >= 199209 403 #define __POSIX_VISIBLE 199209 404 #define __ISO_C_VISIBLE 1990 405 #elif _POSIX_C_SOURCE >= 199009 406 #define __POSIX_VISIBLE 199009 407 #define __ISO_C_VISIBLE 1990 408 #else 409 #define __POSIX_VISIBLE 198808 410 #define __ISO_C_VISIBLE 0 411 #endif /* _POSIX_C_SOURCE */ 412 #else 413 /*- 414 * Deal with _ANSI_SOURCE: 415 * If it is defined, and no other compilation environment is explicitly 416 * requested, then define our internal feature-test macros to zero. This 417 * makes no difference to the preprocessor (undefined symbols in preprocessing 418 * expressions are defined to have value zero), but makes it more convenient for 419 * a test program to print out the values. 420 * 421 * If a program mistakenly defines _ANSI_SOURCE and some other macro such as 422 * _POSIX_C_SOURCE, we will assume that it wants the broader compilation 423 * environment (and in fact we will never get here). 424 */ 425 #ifdef _ANSI_SOURCE /* Hide almost everything. */ 426 #define __POSIX_VISIBLE 0 427 #define __XSI_VISIBLE 0 428 #define __BSD_VISIBLE 0 429 #define __ISO_C_VISIBLE 1990 430 #else /* Default environment: show everything. */ 431 #define __POSIX_VISIBLE 200112 432 #define __XSI_VISIBLE 600 433 #define __BSD_VISIBLE 1 434 #define __ISO_C_VISIBLE 1999 435 #endif 436 #endif 437 438 #endif /* !_SYS_CDEFS_H_ */ 439