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 */ 39 40 #ifndef _SYS_CDEFS_H_ 41 #define _SYS_CDEFS_H_ 42 43 /* 44 * Macro to test if we are using a specific version of gcc or later. 45 */ 46 #if defined(__GNUC__) && !defined(__INTEL_COMPILER) 47 #define __GNUC_PREREQ__(ma, mi) \ 48 (__GNUC__ > (ma) || __GNUC__ == (ma) && __GNUC_MINOR__ >= (mi)) 49 #else 50 #define __GNUC_PREREQ__(ma, mi) 0 51 #endif 52 53 #if defined(__cplusplus) 54 #if __GNUC_PREREQ__(4, 0) 55 #define __BEGIN_DECLS _Pragma("GCC visibility push(default)") extern "C" { 56 #define __END_DECLS } _Pragma("GCC visibility pop") 57 #else 58 #define __BEGIN_DECLS extern "C" { 59 #define __END_DECLS } 60 #endif 61 #else 62 #define __BEGIN_DECLS 63 #define __END_DECLS 64 #endif 65 66 /* 67 * The __VM_CACHELINE_SIZE macro defines the common cache line alignment 68 * size that can be found across most recent and somewhat latest Intel 69 * hardware, i.e. L1 cache sizes etc. 70 * 71 * If needed, this value can be TUNED. Suitable values for this macro 72 * are 32, 64 and 128 bytes. The unit of measurement for this macro is 73 * bytes. 74 * 75 * XXX: This macro and related macros will eventually move to a MD 76 * header, but currently, we do need such a hierarchy. 77 */ 78 #define __VM_CACHELINE_SIZE 64 79 #define __VM_CACHELINE_ALIGN(n) \ 80 (((n) + __VM_CACHELINE_SIZE - 1) / __VM_CACHELINE_SIZE) 81 82 /* 83 * The __CONCAT macro is used to concatenate parts of symbol names, e.g. 84 * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo. 85 * The __CONCAT macro is a bit tricky to use if it must work in non-ANSI 86 * mode -- there must be no spaces between its arguments, and for nested 87 * __CONCAT's, all the __CONCAT's must be at the left. __CONCAT can also 88 * concatenate double-quoted strings produced by the __STRING macro, but 89 * this only works with ANSI C. 90 * 91 * __XSTRING is like __STRING, but it expands any macros in its argument 92 * first. It is only available with ANSI C. 93 */ 94 #if defined(__STDC__) || defined(__cplusplus) 95 #define __P(protos) protos /* full-blown ANSI C */ 96 #define __CONCAT1(x,y) x ## y 97 #define __CONCAT(x,y) __CONCAT1(x,y) 98 #define __STRING(x) #x /* stringify without expanding x */ 99 #define __XSTRING(x) __STRING(x) /* expand x, then stringify */ 100 101 #define __const const /* define reserved names to standard */ 102 #define __signed signed 103 #define __volatile volatile 104 #if defined(__cplusplus) 105 #define __inline inline /* convert to C++ keyword */ 106 #else 107 #ifndef __GNUC__ 108 #define __inline /* delete GCC keyword */ 109 #endif /* !__GNUC__ */ 110 #endif /* !__cplusplus */ 111 112 #else /* !(__STDC__ || __cplusplus) */ 113 #define __P(protos) () /* traditional C preprocessor */ 114 #define __CONCAT(x,y) x/**/y 115 #define __STRING(x) "x" 116 117 #ifndef __GNUC__ 118 #define __const /* delete pseudo-ANSI C keywords */ 119 #define __inline 120 #define __signed 121 #define __volatile 122 /* 123 * In non-ANSI C environments, new programs will want ANSI-only C keywords 124 * deleted from the program and old programs will want them left alone. 125 * When using a compiler other than gcc, programs using the ANSI C keywords 126 * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS. 127 * When using "gcc -traditional", we assume that this is the intent; if 128 * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone. 129 */ 130 #ifndef NO_ANSI_KEYWORDS 131 #define const /* delete ANSI C keywords */ 132 #define inline 133 #define signed 134 #define volatile 135 #endif /* !NO_ANSI_KEYWORDS */ 136 #endif /* !__GNUC__ */ 137 #endif /* !(__STDC__ || __cplusplus) */ 138 139 /* 140 * Compiler-dependent macros to help declare dead (non-returning) and 141 * pure (no side effects) functions, and unused variables. They are 142 * null except for versions of gcc that are known to support the features 143 * properly (old versions of gcc-2 supported the dead and pure features 144 * in a different (wrong) way). 145 */ 146 #ifdef lint 147 148 #define __dead2 149 #define __pure 150 #define __pure2 151 #define __unused 152 #define __packed 153 #define __aligned(x) 154 #define __section(x) 155 #define __always_inline 156 #define __nonnull(x) 157 158 #else 159 160 #if !__GNUC_PREREQ__(2, 7) 161 #define __dead2 162 #define __pure2 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__(2, 96) 176 #define __pure __attribute__((__pure__)) 177 #else 178 #define __pure __pure2 179 #endif 180 181 #if __GNUC_PREREQ__(3, 1) 182 #define __always_inline __attribute__((__always_inline__)) 183 #define __noinline __attribute__((__noinline__)) 184 #else 185 #define __always_inline 186 #define __noinline 187 #endif 188 189 #if __GNUC_PREREQ__(3, 3) 190 #define __nonnull(x) __attribute__((__nonnull__(x))) 191 #define __used __attribute__((__used__)) 192 #else 193 #define __nonnull(x) 194 #define __used __unused 195 #endif 196 197 #endif /* LINT */ 198 199 #if !__GNUC_PREREQ__(2, 7) && __STDC_VERSION < 199901 200 #define __func__ NULL 201 #endif 202 203 #if (__GNUC_PREREQ__(2, 0) && !defined(__STRICT_ANSI)) || \ 204 __STDC_VERSION__ >= 199901 205 #define __LONG_LONG_SUPPORTED 206 #endif 207 208 /* 209 * GNU C version 2.96 adds explicit branch prediction so that 210 * the CPU back-end can hint the processor and also so that 211 * code blocks can be reordered such that the predicted path 212 * sees a more linear flow, thus improving cache behavior, etc. 213 * 214 * The following two macros provide us with a way to utilize this 215 * compiler feature. Use __predict_true() if you expect the expression 216 * to evaluate to true, and __predict_false() if you expect the 217 * expression to evaluate to false. 218 * 219 * A few notes about usage: 220 * 221 * * Generally, __predict_false() error condition checks (unless 222 * you have some _strong_ reason to do otherwise, in which case 223 * document it), and/or __predict_true() `no-error' condition 224 * checks, assuming you want to optimize for the no-error case. 225 * 226 * * Other than that, if you don't know the likelihood of a test 227 * succeeding from empirical or other `hard' evidence, don't 228 * make predictions. 229 * 230 * * These are meant to be used in places that are run `a lot'. 231 * It is wasteful to make predictions in code that is run 232 * seldomly (e.g. at subsystem initialization time) as the 233 * basic block reordering that this affects can often generate 234 * larger code. 235 */ 236 #if __GNUC_PREREQ__(2, 96) 237 #define __predict_true(exp) __builtin_expect((exp), 1) 238 #define __predict_false(exp) __builtin_expect((exp), 0) 239 #else 240 #define __predict_true(exp) (exp) 241 #define __predict_false(exp) (exp) 242 #endif 243 244 /* 245 * GCC 2.95 and later provides `__restrict' as an extention to C90 to support 246 * the C99-specific `restrict' type qualifier. We happen to use `__restrict' 247 * as a way to define the `restrict' type qualifier without disturbing older 248 * software that is unaware of C99 keywords. 249 */ 250 #if !__GNUC_PREREQ__(2, 95) 251 #if __STDC_VERSION__ < 199901 252 #define __restrict 253 #else 254 #define __restrict restrict 255 #endif 256 #endif 257 258 /* 259 * Compiler-dependent macros to declare that functions take printf-like 260 * or scanf-like arguments. They are null except for versions of gcc 261 * that are known to support the features properly (old versions of gcc-2 262 * didn't permit keeping the keywords out of the application namespace). 263 * 264 * The printf0like macro for GCC 2 uses DragonFly specific compiler extensions. 265 */ 266 #if !__GNUC_PREREQ__(2, 7) 267 #define __printflike(fmtarg, firstvararg) 268 #define __scanflike(fmtarg, firstvararg) 269 #define __printf0like(fmtarg, firstvararg) 270 #define __format_arg(fmtarg) 271 #elif __GNUC_PREREQ__(3, 0) 272 #define __printflike(fmtarg, firstvararg) \ 273 __attribute__((__nonnull__(fmtarg), \ 274 __format__ (__printf__, fmtarg, firstvararg))) 275 #define __printf0like(fmtarg, firstvararg) \ 276 __attribute__((__format__ (__printf__, fmtarg, firstvararg))) 277 #define __scanflike(fmtarg, firstvararg) \ 278 __attribute__((__format__ (__scanf__, fmtarg, firstvararg))) 279 #define __format_arg(fmtarg) \ 280 __attribute__((__format_arg__ (fmtarg))) 281 282 #else 283 #define __printflike(fmtarg, firstvararg) \ 284 __attribute__((__format__ (__printf__, fmtarg, firstvararg))) 285 #define __printf0like(fmtarg, firstvararg) \ 286 __attribute__((__format__ (__printf0__, fmtarg, firstvararg))) 287 #define __scanflike(fmtarg, firstvararg) \ 288 __attribute__((__format__ (__scanf__, fmtarg, firstvararg))) 289 #define __format_arg(fmtarg) \ 290 __attribute__((__format_arg__ (fmtarg))) 291 292 #endif 293 294 #if !__GNUC_PREREQ__(3, 0) 295 #define __ARRAY_ZERO 0 296 #else 297 #define __ARRAY_ZERO 298 #endif 299 300 #if __GNUC_PREREQ__(4, 0) 301 #define __dso_public __attribute__((__visibility__("default"))) 302 #define __dso_hidden __attribute__((__visibility__("hidden"))) 303 #else 304 #define __dso_public 305 #define __dso_hidden 306 #endif 307 308 /* 309 * A convenient constructor macro, GCC 4.3.0 added priority support to 310 * constructors, provide a compatible interface for both. 311 */ 312 #if __GNUC_PREREQ__(4, 3) 313 #define __constructor(prio) __attribute__((constructor(prio))) 314 #else 315 #define __constructor(prio) __attribute__((constructor)) 316 #endif 317 318 /* 319 * Handy GCC based macros: 320 * 321 * __cachealign: 322 * 323 * The __cachealign macro can be used for cache line aligning structures 324 * of small to medium size. It aligns the particular structure or 325 * storage type to a system default cache line alignment, thus giving us 326 * a much more better cache utilization by making the hardware work at 327 * its best burst speeds. 328 * 329 * __usereg: 330 * 331 * The __usereg macro can/should be used when a function contains 332 * arguments not more than 3. It can be very useful to us due to the 333 * message-passing nature of the kernel. 334 * 335 * !!NOTE - USAGE INFORMATION!! 336 * 337 * The __cachealign macro should not be used for data structures that are 338 * as big struct proc, struct vnode, struct thread, and other structs which 339 * are as big as them; simply because it will be useless in that case. 340 * 341 * The __usereg macro should be used whenever possible, i.e., when a function 342 * does not exceed more than 3 arguments, and should not be used for vararg 343 * type functions. 344 * 345 * In other words, AVOID MISUSE OF THESE MACROS. :-) 346 */ 347 #ifdef __GNUC__ 348 #define __cachealign __attribute__((__aligned__(__VM_CACHELINE_SIZE))) 349 #define __usereg __attribute__((__regparm__(3))) 350 #else 351 #define __cachealign 352 #define __usereg 353 #endif 354 355 #ifdef __GNUC__ 356 #define __strong_reference(sym,aliassym) \ 357 extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym))); 358 #define __weak_reference(sym,alias) \ 359 __asm__(".weak " #alias); \ 360 __asm__(".equ " #alias ", " #sym) 361 #define __warn_references(sym,msg) \ 362 __asm__(".section .gnu.warning." #sym); \ 363 __asm__(".asciz \"" msg "\""); \ 364 __asm__(".previous") 365 #endif /* __GNUC__ */ 366 367 #if defined(__GNUC__) 368 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"") 369 #endif 370 371 #ifndef __RCSID 372 #define __RCSID(s) __IDSTRING(rcsid,s) 373 #endif 374 375 #ifndef __RCSID_SOURCE 376 #define __RCSID_SOURCE(s) __IDSTRING(rcsid_source,s) 377 #endif 378 379 #ifndef __COPYRIGHT 380 #define __COPYRIGHT(s) __IDSTRING(copyright,s) 381 #endif 382 383 #ifndef __DECONST 384 #define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var)) 385 #endif 386 387 #ifndef __DEVOLATILE 388 #define __DEVOLATILE(type, var) ((type)(uintptr_t)(volatile void *)(var)) 389 #endif 390 391 #ifndef __DEQUALIFY 392 #define __DEQUALIFY(type, var) ((type)(uintptr_t)(const volatile void *)(var)) 393 #endif 394 395 /*- 396 * The following definitions are an extension of the behavior originally 397 * implemented in <sys/_posix.h>, but with a different level of granularity. 398 * POSIX.1 requires that the macros we test be defined before any standard 399 * header file is included. 400 * 401 * Here's a quick run-down of the versions: 402 * defined(_POSIX_SOURCE) 1003.1-1988 403 * _POSIX_C_SOURCE == 1 1003.1-1990 404 * _POSIX_C_SOURCE == 2 1003.2-1992 C Language Binding Option 405 * _POSIX_C_SOURCE == 199309 1003.1b-1993 406 * _POSIX_C_SOURCE == 199506 1003.1c-1995, 1003.1i-1995, 407 * and the omnibus ISO/IEC 9945-1: 1996 408 * _POSIX_C_SOURCE == 200112 1003.1-2001 409 * _POSIX_C_SOURCE == 200809 1003.1-2008 410 * 411 * In addition, the X/Open Portability Guide, which is now the Single UNIX 412 * Specification, defines a feature-test macro which indicates the version of 413 * that specification, and which subsumes _POSIX_C_SOURCE. 414 * 415 * Our macros begin with two underscores to avoid namespace screwage. 416 */ 417 418 /* 419 * If no special macro was specified, make the DragonFly extensions 420 * available. Also make them available when requested so. 421 */ 422 #if (!defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE) && \ 423 !defined(_ANSI_SOURCE) && !defined(_C99_SOURCE)) || \ 424 defined(_DRAGONFLY_SOURCE) || defined(_NETBSD_SOURCE) 425 #define __DF_VISIBLE 1 426 #else 427 #define __DF_VISIBLE 0 428 #endif 429 430 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */ 431 #if defined(_POSIX_C_SOURCE) && (_POSIX_C_SOURCE - 0) == 1 432 #undef _POSIX_C_SOURCE /* Probably illegal, but beyond caring now. */ 433 #define _POSIX_C_SOURCE 199009 434 #endif 435 436 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */ 437 #if defined(_POSIX_C_SOURCE) && (_POSIX_C_SOURCE - 0) == 2 438 #undef _POSIX_C_SOURCE 439 #define _POSIX_C_SOURCE 199209 440 #endif 441 442 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */ 443 #ifdef _XOPEN_SOURCE 444 #if _XOPEN_SOURCE - 0 >= 700 445 #define __XSI_VISIBLE 700 446 #undef _POSIX_C_SOURCE 447 #define _POSIX_C_SOURCE 200809 448 #elif _XOPEN_SOURCE - 0 >= 600 449 #define __XSI_VISIBLE 600 450 #undef _POSIX_C_SOURCE 451 #define _POSIX_C_SOURCE 200112 452 #elif _XOPEN_SOURCE - 0 >= 500 453 #define __XSI_VISIBLE 500 454 #undef _POSIX_C_SOURCE 455 #define _POSIX_C_SOURCE 199506 456 #endif 457 #endif 458 459 /* 460 * Deal with all versions of POSIX. The ordering relative to the tests above is 461 * important. 462 */ 463 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE) 464 #define _POSIX_C_SOURCE 198808 465 #endif 466 #ifdef _POSIX_C_SOURCE 467 #if (_POSIX_C_SOURCE - 0) >= 200809 468 #define __POSIX_VISIBLE 200809 469 #define __ISO_C_VISIBLE 1999 470 #elif (_POSIX_C_SOURCE - 0) >= 200112 471 #define __POSIX_VISIBLE 200112 472 #define __ISO_C_VISIBLE 1999 473 #elif (_POSIX_C_SOURCE - 0) >= 199506 474 #define __POSIX_VISIBLE 199506 475 #define __ISO_C_VISIBLE 1990 476 #elif (_POSIX_C_SOURCE - 0) >= 199309 477 #define __POSIX_VISIBLE 199309 478 #define __ISO_C_VISIBLE 1990 479 #elif (_POSIX_C_SOURCE - 0) >= 199209 480 #define __POSIX_VISIBLE 199209 481 #define __ISO_C_VISIBLE 1990 482 #elif (_POSIX_C_SOURCE - 0) >= 199009 483 #define __POSIX_VISIBLE 199009 484 #define __ISO_C_VISIBLE 1990 485 #else 486 #define __POSIX_VISIBLE 198808 487 #define __ISO_C_VISIBLE 0 488 #endif /* _POSIX_C_SOURCE */ 489 #else 490 /*- 491 * Deal with _ANSI_SOURCE: 492 * If it is defined, and no other compilation environment is explicitly 493 * requested, then define our internal feature-test macros to zero. This 494 * makes no difference to the preprocessor (undefined symbols in preprocessing 495 * expressions are defined to have value zero), but makes it more convenient for 496 * a test program to print out the values. 497 * 498 * If a program mistakenly defines _ANSI_SOURCE and some other macro such as 499 * _POSIX_C_SOURCE, we will assume that it wants the broader compilation 500 * environment (and in fact we will never get here). 501 */ 502 #ifdef _ANSI_SOURCE /* Hide almost everything. */ 503 #define __POSIX_VISIBLE 0 504 #define __XSI_VISIBLE 0 505 #define __BSD_VISIBLE 0 506 #define __ISO_C_VISIBLE 1990 507 #elif defined(_C99_SOURCE) /* Localism to specify strict C99 env. */ 508 #define __POSIX_VISIBLE 0 509 #define __XSI_VISIBLE 0 510 #define __BSD_VISIBLE 0 511 #define __ISO_C_VISIBLE 1999 512 #else /* Default environment: show everything. */ 513 #define __POSIX_VISIBLE 200112 514 #define __XSI_VISIBLE 600 515 #define __BSD_VISIBLE 1 516 #define __ISO_C_VISIBLE 1999 517 #endif 518 #endif 519 520 /* 521 * GLOBL macro exists to preserve __start_set_* and __stop_set_* sections 522 * of kernel modules which are discarded from binutils 2.17.50+ otherwise. 523 */ 524 525 #define __GLOBL1(sym) __asm__(".globl " #sym) 526 #define __GLOBL(sym) __GLOBL1(sym) 527 528 #endif /* !_SYS_CDEFS_H_ */ 529