libc/include/sys/cdefs.h

   1 /*      $NetBSD: cdefs.h,v 1.58 2004/12/11 05:59:00 christos Exp $      */
   2
   3 /*
   4  * Copyright (c) 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Berkeley Software Design, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)cdefs.h     8.8 (Berkeley) 1/9/95
  35  */
  36
  37 #ifndef _SYS_CDEFS_H_
  38 #define _SYS_CDEFS_H_
  39
  40 /*
  41  * Testing against Clang-specific extensions.
  42  */
  43
  44 #ifndef __has_extension
  45 #define __has_extension         __has_feature
  46 #endif
  47 #ifndef __has_feature
  48 #define __has_feature(x)        0
  49 #endif
  50 #ifndef __has_include
  51 #define __has_include(x)        0
  52 #endif
  53 #ifndef __has_builtin
  54 #define __has_builtin(x)        0
  55 #endif
  56
  57
  58 /*
  59  * Macro to test if we're using a GNU C compiler of a specific vintage
  60  * or later, for e.g. features that appeared in a particular version
  61  * of GNU C.  Usage:
  62  *
  63  *      #if __GNUC_PREREQ(major, minor)
  64  *      ...cool feature...
  65  *      #else
  66  *      ...delete feature...
  67  *      #endif
  68  */
  69 #ifdef __GNUC__
  70 #define __GNUC_PREREQ(x, y)                                             \
  71         ((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) ||                  \
  72          (__GNUC__ > (x)))
  73 #else
  74 #define __GNUC_PREREQ(x, y)     0
  75 #endif
  76
  77 #include <sys/cdefs_elf.h>
  78
  79 #if defined(__cplusplus)
  80 #define __BEGIN_DECLS           extern "C" {
  81 #define __END_DECLS             }
  82 #define __static_cast(x,y)      static_cast<x>(y)
  83 #else
  84 #define __BEGIN_DECLS
  85 #define __END_DECLS
  86 #define __static_cast(x,y)      (x)y
  87 #endif
  88
  89 /*
  90  * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
  91  * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
  92  * The __CONCAT macro is a bit tricky -- make sure you don't put spaces
  93  * in between its arguments.  __CONCAT can also concatenate double-quoted
  94  * strings produced by the __STRING macro, but this only works with ANSI C.
  95  */
  96
  97 #define ___STRING(x)    __STRING(x)
  98 #define ___CONCAT(x,y)  __CONCAT(x,y)
  99
 100 #if defined(__STDC__) || defined(__cplusplus)
 101 #define __P(protos)     protos          /* full-blown ANSI C */
 102 #define __CONCAT(x,y)   x ## y
 103 #define __STRING(x)     #x
 104
 105 #define __const         const           /* define reserved names to standard */
 106 #define __signed        signed
 107 #define __volatile      volatile
 108 #if defined(__cplusplus)
 109 #define __inline        inline          /* convert to C++ keyword */
 110 #else
 111 #if !defined(__GNUC__) && !defined(__lint__)
 112 #define __inline                        /* delete GCC keyword */
 113 #endif /* !__GNUC__  && !__lint__ */
 114 #endif /* !__cplusplus */
 115
 116 #else   /* !(__STDC__ || __cplusplus) */
 117 #define __P(protos)     ()              /* traditional C preprocessor */
 118 #define __CONCAT(x,y)   x/**/y
 119 #define __STRING(x)     "x"
 120
 121 #ifndef __GNUC__
 122 #define __const                         /* delete pseudo-ANSI C keywords */
 123 #define __inline
 124 #define __signed
 125 #define __volatile
 126 #endif  /* !__GNUC__ */
 127
 128 /*
 129  * In non-ANSI C environments, new programs will want ANSI-only C keywords
 130  * deleted from the program and old programs will want them left alone.
 131  * Programs using the ANSI C keywords const, inline etc. as normal
 132  * identifiers should define -DNO_ANSI_KEYWORDS.
 133  */
 134 #ifndef NO_ANSI_KEYWORDS
 135 #define const           __const         /* convert ANSI C keywords */
 136 #define inline          __inline
 137 #define signed          __signed
 138 #define volatile        __volatile
 139 #endif /* !NO_ANSI_KEYWORDS */
 140 #endif  /* !(__STDC__ || __cplusplus) */
 141
 142 /*
 143  * Used for internal auditing of the NetBSD source tree.
 144  */
 145 #ifdef __AUDIT__
 146 #define __aconst        __const
 147 #else
 148 #define __aconst
 149 #endif
 150
 151 /*
 152  * The following macro is used to remove const cast-away warnings
 153  * from gcc -Wcast-qual; it should be used with caution because it
 154  * can hide valid errors; in particular most valid uses are in
 155  * situations where the API requires it, not to cast away string
 156  * constants. We don't use *intptr_t on purpose here and we are
 157  * explicit about unsigned long so that we don't have additional
 158  * dependencies.
 159  */
 160 #define __UNCONST(a)    ((void *)(unsigned long)(const void *)(a))
 161
 162 /*
 163  * GCC2 provides __extension__ to suppress warnings for various GNU C
 164  * language extensions under "-ansi -pedantic".
 165  */
 166 #if !__GNUC_PREREQ(2, 0)
 167 #define __extension__           /* delete __extension__ if non-gcc or gcc1 */
 168 #endif
 169
 170 /*
 171  * GCC1 and some versions of GCC2 declare dead (non-returning) and
 172  * pure (no side effects) functions using "volatile" and "const";
 173  * unfortunately, these then cause warnings under "-ansi -pedantic".
 174  * GCC2 uses a new, peculiar __attribute__((attrs)) style.  All of
 175  * these work for GNU C++ (modulo a slight glitch in the C++ grammar
 176  * in the distribution version of 2.5.5).
 177  */
 178 #if !__GNUC_PREREQ(2, 5)
 179 #define __attribute__(x)        /* delete __attribute__ if non-gcc or gcc1 */
 180 #if defined(__GNUC__) && !defined(__STRICT_ANSI__)
 181 #define __dead          __volatile
 182 #define __pure          __const
 183 #endif
 184 #endif
 185
 186 /* Delete pseudo-keywords wherever they are not available or needed. */
 187 #ifndef __dead
 188 #define __dead
 189 #define __pure
 190 #endif
 191
 192 #if __GNUC_PREREQ(2, 7)
 193 #define __unused        __attribute__((__unused__))
 194 #else
 195 #define __unused        /* delete */
 196 #endif
 197
 198 #define __pure2 __attribute__((__const__)) /* Android-added: used by FreeBSD libm */
 199
 200 #if __GNUC_PREREQ(3, 1)
 201 #define __used          __attribute__((__used__))
 202 #else
 203 #define __used          /* delete */
 204 #endif
 205
 206 #if __GNUC_PREREQ(2, 7)
 207 #define __packed        __attribute__((__packed__))
 208 #define __aligned(x)    __attribute__((__aligned__(x)))
 209 #define __section(x)    __attribute__((__section__(x)))
 210 #elif defined(__lint__)
 211 #define __packed        /* delete */
 212 #define __aligned(x)    /* delete */
 213 #define __section(x)    /* delete */
 214 #else
 215 #define __packed        error: no __packed for this compiler
 216 #define __aligned(x)    error: no __aligned for this compiler
 217 #define __section(x)    error: no __section for this compiler
 218 #endif
 219
 220 #if !__GNUC_PREREQ(2, 8)
 221 #define __extension__
 222 #endif
 223
 224 #if __GNUC_PREREQ(2, 8)
 225 #define __statement(x)  __extension__(x)
 226 #elif defined(lint)
 227 #define __statement(x)  (0)
 228 #else
 229 #define __statement(x)  (x)
 230 #endif
 231
 232 #define __nonnull(args) __attribute__((__nonnull__ args))
 233
 234 #define __printflike(x, y) __attribute__((__format__(printf, x, y))) __nonnull((x))
 235 #define __scanflike(x, y) __attribute__((__format__(scanf, x, y))) __nonnull((x))
 236
 237 /*
 238  * C99 defines the restrict type qualifier keyword, which was made available
 239  * in GCC 2.92.
 240  */
 241 #if defined(__STDC__VERSION__) && __STDC_VERSION__ >= 199901L
 242 #define __restrict      restrict
 243 #else
 244 #if !__GNUC_PREREQ(2, 92)
 245 #define __restrict      /* delete __restrict when not supported */
 246 #endif
 247 #endif
 248
 249 /*
 250  * C99 defines __func__ predefined identifier, which was made available
 251  * in GCC 2.95.
 252  */
 253 #if !defined(__STDC_VERSION__) || !(__STDC_VERSION__ >= 199901L)
 254 #if __GNUC_PREREQ(2, 6)
 255 #define __func__        __PRETTY_FUNCTION__
 256 #elif __GNUC_PREREQ(2, 4)
 257 #define __func__        __FUNCTION__
 258 #else
 259 #define __func__        ""
 260 #endif
 261 #endif /* !(__STDC_VERSION__ >= 199901L) */
 262
 263 #if defined(_KERNEL)
 264 #if defined(NO_KERNEL_RCSIDS)
 265 #undef __KERNEL_RCSID
 266 #define __KERNEL_RCSID(_n, _s)          /* nothing */
 267 #endif /* NO_KERNEL_RCSIDS */
 268 #endif /* _KERNEL */
 269
 270 /*
 271  * A barrier to stop the optimizer from moving code or assume live
 272  * register values. This is gcc specific, the version is more or less
 273  * arbitrary, might work with older compilers.
 274  */
 275 #if __GNUC_PREREQ(2, 95)
 276 #define __insn_barrier()        __asm __volatile("":::"memory")
 277 #else
 278 #define __insn_barrier()        /* */
 279 #endif
 280
 281 /*
 282  * GNU C version 2.96 adds explicit branch prediction so that
 283  * the CPU back-end can hint the processor and also so that
 284  * code blocks can be reordered such that the predicted path
 285  * sees a more linear flow, thus improving cache behavior, etc.
 286  *
 287  * The following two macros provide us with a way to use this
 288  * compiler feature.  Use __predict_true() if you expect the expression
 289  * to evaluate to true, and __predict_false() if you expect the
 290  * expression to evaluate to false.
 291  *
 292  * A few notes about usage:
 293  *
 294  *      * Generally, __predict_false() error condition checks (unless
 295  *        you have some _strong_ reason to do otherwise, in which case
 296  *        document it), and/or __predict_true() `no-error' condition
 297  *        checks, assuming you want to optimize for the no-error case.
 298  *
 299  *      * Other than that, if you don't know the likelihood of a test
 300  *        succeeding from empirical or other `hard' evidence, don't
 301  *        make predictions.
 302  *
 303  *      * These are meant to be used in places that are run `a lot'.
 304  *        It is wasteful to make predictions in code that is run
 305  *        seldomly (e.g. at subsystem initialization time) as the
 306  *        basic block reordering that this affects can often generate
 307  *        larger code.
 308  */
 309 #if __GNUC_PREREQ(2, 96)
 310 #define __predict_true(exp)     __builtin_expect((exp) != 0, 1)
 311 #define __predict_false(exp)    __builtin_expect((exp) != 0, 0)
 312 #else
 313 #define __predict_true(exp)     (exp)
 314 #define __predict_false(exp)    (exp)
 315 #endif
 316
 317 #if __GNUC_PREREQ(2, 96)
 318 #define __noreturn    __attribute__((__noreturn__))
 319 #define __mallocfunc  __attribute__((malloc))
 320 #define __purefunc    __attribute__((pure))
 321 #else
 322 #define __noreturn
 323 #define __mallocfunc
 324 #define __purefunc
 325 #endif
 326
 327 #if __GNUC_PREREQ(3, 1)
 328 #define __always_inline __attribute__((__always_inline__))
 329 #else
 330 #define __always_inline
 331 #endif
 332
 333 #if __GNUC_PREREQ(3, 4)
 334 #define __wur __attribute__((__warn_unused_result__))
 335 #else
 336 #define __wur
 337 #endif
 338
 339 #if __GNUC_PREREQ(4, 3)
 340 #define __errordecl(name, msg) extern void name(void) __attribute__((__error__(msg)))
 341 #define __warnattr(msg) __attribute__((__warning__(msg)))
 342 #else
 343 #define __errordecl(name, msg) extern void name(void)
 344 #define __warnattr(msg)
 345 #endif
 346
 347 /*
 348  * Some BSD source needs these macros.
 349  * Originally they embedded the rcs versions of each source file
 350  * in the generated binary. We strip strings during build anyway,.
 351  */
 352 #define __IDSTRING(_prefix,_s) /* nothing */
 353 #define __COPYRIGHT(_s) /* nothing */
 354 #define __FBSDID(_s) /* nothing */
 355 #define __RCSID(_s) /* nothing */
 356 #define __SCCSID(_s) /* nothing */
 357
 358 /*
 359  * _BSD_SOURCE and _GNU_SOURCE are expected to be defined by callers before
 360  * any standard header file is included. In those header files we test
 361  * against __USE_BSD and __USE_GNU. glibc does this in <features.h> but we
 362  * do it in <sys/cdefs.h> instead because that's where our existing
 363  * _POSIX_C_SOURCE tests were, and we're already confident that <sys/cdefs.h>
 364  * is included everywhere it should be.
 365  *
 366  * The _GNU_SOURCE test needs to come before any _BSD_SOURCE or _POSIX* tests
 367  * because _GNU_SOURCE implies everything else.
 368  */
 369 #if defined(_GNU_SOURCE)
 370 # define __USE_GNU 1
 371 # undef _POSIX_SOURCE
 372 # define _POSIX_SOURCE 1
 373 # undef _POSIX_C_SOURCE
 374 # define _POSIX_C_SOURCE 200809L
 375 # undef _BSD_SOURCE
 376 # define _BSD_SOURCE 1
 377 #endif
 378
 379 #if defined(_BSD_SOURCE)
 380 # define __USE_BSD 1
 381 #endif
 382
 383 /*-
 384  * POSIX.1 requires that the macros we test be defined before any standard
 385  * header file is included.
 386  *
 387  * Here's a quick run-down of the versions:
 388  *  defined(_POSIX_SOURCE)              1003.1-1988
 389  *  _POSIX_C_SOURCE == 1                1003.1-1990
 390  *  _POSIX_C_SOURCE == 2                1003.2-1992 C Language Binding Option
 391  *  _POSIX_C_SOURCE == 199309           1003.1b-1993
 392  *  _POSIX_C_SOURCE == 199506           1003.1c-1995, 1003.1i-1995,
 393  *                                      and the omnibus ISO/IEC 9945-1: 1996
 394  *  _POSIX_C_SOURCE == 200112           1003.1-2001
 395  *  _POSIX_C_SOURCE == 200809           1003.1-2008
 396  *
 397  * In addition, the X/Open Portability Guide, which is now the Single UNIX
 398  * Specification, defines a feature-test macro which indicates the version of
 399  * that specification, and which subsumes _POSIX_C_SOURCE.
 400  *
 401  * Our macros begin with two underscores to avoid namespace screwage.
 402  */
 403
 404 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */
 405 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 1
 406 #undef _POSIX_C_SOURCE          /* Probably illegal, but beyond caring now. */
 407 #define _POSIX_C_SOURCE         199009
 408 #endif
 409
 410 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */
 411 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 2
 412 #undef _POSIX_C_SOURCE
 413 #define _POSIX_C_SOURCE         199209
 414 #endif
 415
 416 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
 417 #ifdef _XOPEN_SOURCE
 418 #if _XOPEN_SOURCE - 0 >= 700
 419 #define __XSI_VISIBLE           700
 420 #undef _POSIX_C_SOURCE
 421 #define _POSIX_C_SOURCE         200809
 422 #elif _XOPEN_SOURCE - 0 >= 600
 423 #define __XSI_VISIBLE           600
 424 #undef _POSIX_C_SOURCE
 425 #define _POSIX_C_SOURCE         200112
 426 #elif _XOPEN_SOURCE - 0 >= 500
 427 #define __XSI_VISIBLE           500
 428 #undef _POSIX_C_SOURCE
 429 #define _POSIX_C_SOURCE         199506
 430 #endif
 431 #endif
 432
 433 /*
 434  * Deal with all versions of POSIX.  The ordering relative to the tests above is
 435  * important.
 436  */
 437 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
 438 #define _POSIX_C_SOURCE         198808
 439 #endif
 440 #ifdef _POSIX_C_SOURCE
 441 #if _POSIX_C_SOURCE >= 200809
 442 #define __POSIX_VISIBLE         200809
 443 #define __ISO_C_VISIBLE         1999
 444 #elif _POSIX_C_SOURCE >= 200112
 445 #define __POSIX_VISIBLE         200112
 446 #define __ISO_C_VISIBLE         1999
 447 #elif _POSIX_C_SOURCE >= 199506
 448 #define __POSIX_VISIBLE         199506
 449 #define __ISO_C_VISIBLE         1990
 450 #elif _POSIX_C_SOURCE >= 199309
 451 #define __POSIX_VISIBLE         199309
 452 #define __ISO_C_VISIBLE         1990
 453 #elif _POSIX_C_SOURCE >= 199209
 454 #define __POSIX_VISIBLE         199209
 455 #define __ISO_C_VISIBLE         1990
 456 #elif _POSIX_C_SOURCE >= 199009
 457 #define __POSIX_VISIBLE         199009
 458 #define __ISO_C_VISIBLE         1990
 459 #else
 460 #define __POSIX_VISIBLE         198808
 461 #define __ISO_C_VISIBLE         0
 462 #endif /* _POSIX_C_SOURCE */
 463 #else
 464 /*-
 465  * Deal with _ANSI_SOURCE:
 466  * If it is defined, and no other compilation environment is explicitly
 467  * requested, then define our internal feature-test macros to zero.  This
 468  * makes no difference to the preprocessor (undefined symbols in preprocessing
 469  * expressions are defined to have value zero), but makes it more convenient for
 470  * a test program to print out the values.
 471  *
 472  * If a program mistakenly defines _ANSI_SOURCE and some other macro such as
 473  * _POSIX_C_SOURCE, we will assume that it wants the broader compilation
 474  * environment (and in fact we will never get here).
 475  */
 476 #if defined(_ANSI_SOURCE)       /* Hide almost everything. */
 477 #define __POSIX_VISIBLE         0
 478 #define __XSI_VISIBLE           0
 479 #define __BSD_VISIBLE           0
 480 #define __ISO_C_VISIBLE         1990
 481 #elif defined(_C99_SOURCE)      /* Localism to specify strict C99 env. */
 482 #define __POSIX_VISIBLE         0
 483 #define __XSI_VISIBLE           0
 484 #define __BSD_VISIBLE           0
 485 #define __ISO_C_VISIBLE         1999
 486 #else                           /* Default environment: show everything. */
 487 #define __POSIX_VISIBLE         200809
 488 #define __XSI_VISIBLE           700
 489 #define __BSD_VISIBLE           1
 490 #define __ISO_C_VISIBLE         1999
 491 #endif
 492 #endif
 493
 494 /*
 495  * Default values.
 496  */
 497 #ifndef __XPG_VISIBLE
 498 # define __XPG_VISIBLE          700
 499 #endif
 500 #ifndef __POSIX_VISIBLE
 501 # define __POSIX_VISIBLE        200809
 502 #endif
 503 #ifndef __ISO_C_VISIBLE
 504 # define __ISO_C_VISIBLE        1999
 505 #endif
 506 #ifndef __BSD_VISIBLE
 507 # define __BSD_VISIBLE          1
 508 #endif
 509
 510 #define  __BIONIC__   1
 511 #include <android/api-level.h>
 512
 513 /* glibc compatibility. */
 514 #if __LP64__
 515 #define __WORDSIZE 64
 516 #else
 517 #define __WORDSIZE 32
 518 #endif
 519
 520 /*
 521  * When _FORTIFY_SOURCE is defined, automatic bounds checking is
 522  * added to commonly used libc functions. If a buffer overrun is
 523  * detected, the program is safely aborted.
 524  *
 525  * See
 526  * http://gcc.gnu.org/onlinedocs/gcc/Object-Size-Checking.html for details.
 527  */
 528 #if defined(_FORTIFY_SOURCE) && _FORTIFY_SOURCE > 0 && defined(__OPTIMIZE__) && __OPTIMIZE__ > 0
 529 #define __BIONIC_FORTIFY 1
 530 #if _FORTIFY_SOURCE == 2
 531 #define __bos(s) __builtin_object_size((s), 1)
 532 #else
 533 #define __bos(s) __builtin_object_size((s), 0)
 534 #endif
 535 #define __bos0(s) __builtin_object_size((s), 0)
 536
 537 #define __BIONIC_FORTIFY_INLINE extern __inline__ __always_inline __attribute__((gnu_inline))
 538 #endif
 539 #define __BIONIC_FORTIFY_UNKNOWN_SIZE ((size_t) -1)
 540
 541 /* Used to tag non-static symbols that are private and never exposed by the shared library. */
 542 #define __LIBC_HIDDEN__ __attribute__((visibility("hidden")))
 543
 544 /* Like __LIBC_HIDDEN__, but preserves binary compatibility for LP32. */
 545 #ifdef __LP64__
 546 #define __LIBC64_HIDDEN__ __LIBC_HIDDEN__
 547 #else
 548 #define __LIBC64_HIDDEN__ __LIBC_ABI_PUBLIC__
 549 #endif
 550
 551 /* Used to tag non-static symbols that are public and exposed by the shared library. */
 552 #define __LIBC_ABI_PUBLIC__ __attribute__((visibility ("default")))
 553
 554 /* Used to rename functions so that the compiler emits a call to 'x' rather than the function this was applied to. */
 555 #define __RENAME(x) __asm__(#x)
 556
 557 #endif /* !_SYS_CDEFS_H_ */