sys/sys/cdefs.h

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