cdefs.h revision b2eb09a9ed9e08d9e49f4245d1959b2ca3fbaaf8
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#if !defined(_STANDALONE) && !defined(_KERNEL) 271#ifdef __GNUC__ 272#define __RENAME(x) ___RENAME(x) 273#else 274#ifdef __lint__ 275#define __RENAME(x) __symbolrename(x) 276#else 277#error "No function renaming possible" 278#endif /* __lint__ */ 279#endif /* __GNUC__ */ 280#else /* _STANDALONE || _KERNEL */ 281#define __RENAME(x) no renaming in kernel or standalone environment 282#endif 283 284/* 285 * A barrier to stop the optimizer from moving code or assume live 286 * register values. This is gcc specific, the version is more or less 287 * arbitrary, might work with older compilers. 288 */ 289#if __GNUC_PREREQ(2, 95) 290#define __insn_barrier() __asm __volatile("":::"memory") 291#else 292#define __insn_barrier() /* */ 293#endif 294 295/* 296 * GNU C version 2.96 adds explicit branch prediction so that 297 * the CPU back-end can hint the processor and also so that 298 * code blocks can be reordered such that the predicted path 299 * sees a more linear flow, thus improving cache behavior, etc. 300 * 301 * The following two macros provide us with a way to use this 302 * compiler feature. Use __predict_true() if you expect the expression 303 * to evaluate to true, and __predict_false() if you expect the 304 * expression to evaluate to false. 305 * 306 * A few notes about usage: 307 * 308 * * Generally, __predict_false() error condition checks (unless 309 * you have some _strong_ reason to do otherwise, in which case 310 * document it), and/or __predict_true() `no-error' condition 311 * checks, assuming you want to optimize for the no-error case. 312 * 313 * * Other than that, if you don't know the likelihood of a test 314 * succeeding from empirical or other `hard' evidence, don't 315 * make predictions. 316 * 317 * * These are meant to be used in places that are run `a lot'. 318 * It is wasteful to make predictions in code that is run 319 * seldomly (e.g. at subsystem initialization time) as the 320 * basic block reordering that this affects can often generate 321 * larger code. 322 */ 323#if __GNUC_PREREQ(2, 96) 324#define __predict_true(exp) __builtin_expect((exp) != 0, 1) 325#define __predict_false(exp) __builtin_expect((exp) != 0, 0) 326#else 327#define __predict_true(exp) (exp) 328#define __predict_false(exp) (exp) 329#endif 330 331#if __GNUC_PREREQ(2, 96) 332#define __noreturn __attribute__((__noreturn__)) 333#define __mallocfunc __attribute__((malloc)) 334#define __purefunc __attribute__((pure)) 335#else 336#define __noreturn 337#define __mallocfunc 338#define __purefunc 339#endif 340 341#if __GNUC_PREREQ(3, 1) 342#define __always_inline __attribute__((__always_inline__)) 343#else 344#define __always_inline 345#endif 346 347#if __GNUC_PREREQ(3, 4) 348#define __wur __attribute__((__warn_unused_result__)) 349#else 350#define __wur 351#endif 352 353#if __GNUC_PREREQ(4, 3) 354#define __errordecl(name, msg) extern void name(void) __attribute__((__error__(msg))) 355#define __warnattr(msg) __attribute__((__warning__(msg))) 356#else 357#define __errordecl(name, msg) extern void name(void) 358#define __warnattr(msg) 359#endif 360 361/* 362 * Macros for manipulating "link sets". Link sets are arrays of pointers 363 * to objects, which are gathered up by the linker. 364 * 365 * Object format-specific code has provided us with the following macros: 366 * 367 * __link_set_add_text(set, sym) 368 * Add a reference to the .text symbol `sym' to `set'. 369 * 370 * __link_set_add_rodata(set, sym) 371 * Add a reference to the .rodata symbol `sym' to `set'. 372 * 373 * __link_set_add_data(set, sym) 374 * Add a reference to the .data symbol `sym' to `set'. 375 * 376 * __link_set_add_bss(set, sym) 377 * Add a reference to the .bss symbol `sym' to `set'. 378 * 379 * __link_set_decl(set, ptype) 380 * Provide an extern declaration of the set `set', which 381 * contains an array of the pointer type `ptype'. This 382 * macro must be used by any code which wishes to reference 383 * the elements of a link set. 384 * 385 * __link_set_start(set) 386 * This points to the first slot in the link set. 387 * 388 * __link_set_end(set) 389 * This points to the (non-existent) slot after the last 390 * entry in the link set. 391 * 392 * __link_set_count(set) 393 * Count the number of entries in link set `set'. 394 * 395 * In addition, we provide the following macros for accessing link sets: 396 * 397 * __link_set_foreach(pvar, set) 398 * Iterate over the link set `set'. Because a link set is 399 * an array of pointers, pvar must be declared as "type **pvar", 400 * and the actual entry accessed as "*pvar". 401 * 402 * __link_set_entry(set, idx) 403 * Access the link set entry at index `idx' from set `set'. 404 */ 405#define __link_set_foreach(pvar, set) \ 406 for (pvar = __link_set_start(set); pvar < __link_set_end(set); pvar++) 407 408#define __link_set_entry(set, idx) (__link_set_begin(set)[idx]) 409 410/* 411 * Some of the FreeBSD sources used in Bionic need this. 412 * Originally, this is used to embed the rcs versions of each source file 413 * in the generated binary. We certainly don't want this in Bionic. 414 */ 415#define __FBSDID(s) /* nothing */ 416 417/*- 418 * The following definitions are an extension of the behavior originally 419 * implemented in <sys/_posix.h>, but with a different level of granularity. 420 * POSIX.1 requires that the macros we test be defined before any standard 421 * header file is included. 422 * 423 * Here's a quick run-down of the versions: 424 * defined(_POSIX_SOURCE) 1003.1-1988 425 * _POSIX_C_SOURCE == 1 1003.1-1990 426 * _POSIX_C_SOURCE == 2 1003.2-1992 C Language Binding Option 427 * _POSIX_C_SOURCE == 199309 1003.1b-1993 428 * _POSIX_C_SOURCE == 199506 1003.1c-1995, 1003.1i-1995, 429 * and the omnibus ISO/IEC 9945-1: 1996 430 * _POSIX_C_SOURCE == 200112 1003.1-2001 431 * _POSIX_C_SOURCE == 200809 1003.1-2008 432 * 433 * In addition, the X/Open Portability Guide, which is now the Single UNIX 434 * Specification, defines a feature-test macro which indicates the version of 435 * that specification, and which subsumes _POSIX_C_SOURCE. 436 * 437 * Our macros begin with two underscores to avoid namespace screwage. 438 */ 439 440/* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */ 441#if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 1 442#undef _POSIX_C_SOURCE /* Probably illegal, but beyond caring now. */ 443#define _POSIX_C_SOURCE 199009 444#endif 445 446/* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */ 447#if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 2 448#undef _POSIX_C_SOURCE 449#define _POSIX_C_SOURCE 199209 450#endif 451 452/* Deal with various X/Open Portability Guides and Single UNIX Spec. */ 453#ifdef _XOPEN_SOURCE 454#if _XOPEN_SOURCE - 0 >= 700 455#define __XSI_VISIBLE 700 456#undef _POSIX_C_SOURCE 457#define _POSIX_C_SOURCE 200809 458#elif _XOPEN_SOURCE - 0 >= 600 459#define __XSI_VISIBLE 600 460#undef _POSIX_C_SOURCE 461#define _POSIX_C_SOURCE 200112 462#elif _XOPEN_SOURCE - 0 >= 500 463#define __XSI_VISIBLE 500 464#undef _POSIX_C_SOURCE 465#define _POSIX_C_SOURCE 199506 466#endif 467#endif 468 469/* 470 * Deal with all versions of POSIX. The ordering relative to the tests above is 471 * important. 472 */ 473#if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE) 474#define _POSIX_C_SOURCE 198808 475#endif 476#ifdef _POSIX_C_SOURCE 477#if _POSIX_C_SOURCE >= 200809 478#define __POSIX_VISIBLE 200809 479#define __ISO_C_VISIBLE 1999 480#elif _POSIX_C_SOURCE >= 200112 481#define __POSIX_VISIBLE 200112 482#define __ISO_C_VISIBLE 1999 483#elif _POSIX_C_SOURCE >= 199506 484#define __POSIX_VISIBLE 199506 485#define __ISO_C_VISIBLE 1990 486#elif _POSIX_C_SOURCE >= 199309 487#define __POSIX_VISIBLE 199309 488#define __ISO_C_VISIBLE 1990 489#elif _POSIX_C_SOURCE >= 199209 490#define __POSIX_VISIBLE 199209 491#define __ISO_C_VISIBLE 1990 492#elif _POSIX_C_SOURCE >= 199009 493#define __POSIX_VISIBLE 199009 494#define __ISO_C_VISIBLE 1990 495#else 496#define __POSIX_VISIBLE 198808 497#define __ISO_C_VISIBLE 0 498#endif /* _POSIX_C_SOURCE */ 499#else 500/*- 501 * Deal with _ANSI_SOURCE: 502 * If it is defined, and no other compilation environment is explicitly 503 * requested, then define our internal feature-test macros to zero. This 504 * makes no difference to the preprocessor (undefined symbols in preprocessing 505 * expressions are defined to have value zero), but makes it more convenient for 506 * a test program to print out the values. 507 * 508 * If a program mistakenly defines _ANSI_SOURCE and some other macro such as 509 * _POSIX_C_SOURCE, we will assume that it wants the broader compilation 510 * environment (and in fact we will never get here). 511 */ 512#if defined(_ANSI_SOURCE) /* Hide almost everything. */ 513#define __POSIX_VISIBLE 0 514#define __XSI_VISIBLE 0 515#define __BSD_VISIBLE 0 516#define __ISO_C_VISIBLE 1990 517#elif defined(_C99_SOURCE) /* Localism to specify strict C99 env. */ 518#define __POSIX_VISIBLE 0 519#define __XSI_VISIBLE 0 520#define __BSD_VISIBLE 0 521#define __ISO_C_VISIBLE 1999 522#else /* Default environment: show everything. */ 523#define __POSIX_VISIBLE 200809 524#define __XSI_VISIBLE 700 525#define __BSD_VISIBLE 1 526#define __ISO_C_VISIBLE 1999 527#endif 528#endif 529 530/* 531 * Default values. 532 */ 533#ifndef __XPG_VISIBLE 534# define __XPG_VISIBLE 700 535#endif 536#ifndef __POSIX_VISIBLE 537# define __POSIX_VISIBLE 200809 538#endif 539#ifndef __ISO_C_VISIBLE 540# define __ISO_C_VISIBLE 1999 541#endif 542#ifndef __BSD_VISIBLE 543# define __BSD_VISIBLE 1 544#endif 545 546#define __BIONIC__ 1 547#include <android/api-level.h> 548 549/* glibc compatibility. */ 550#if __LP64__ 551#define __WORDSIZE 64 552#else 553#define __WORDSIZE 32 554#endif 555 556/* 557 * When _FORTIFY_SOURCE is defined, automatic bounds checking is 558 * added to commonly used libc functions. If a buffer overrun is 559 * detected, the program is safely aborted. 560 * 561 * See 562 * http://gcc.gnu.org/onlinedocs/gcc/Object-Size-Checking.html for details. 563 */ 564#if defined(_FORTIFY_SOURCE) && _FORTIFY_SOURCE > 0 && defined(__OPTIMIZE__) && __OPTIMIZE__ > 0 565#define __BIONIC_FORTIFY 1 566#if _FORTIFY_SOURCE == 2 567#define __bos(s) __builtin_object_size((s), 1) 568#else 569#define __bos(s) __builtin_object_size((s), 0) 570#endif 571#define __bos0(s) __builtin_object_size((s), 0) 572 573#define __BIONIC_FORTIFY_INLINE \ 574 extern __inline__ \ 575 __attribute__ ((always_inline)) \ 576 __attribute__ ((gnu_inline)) 577#endif 578#define __BIONIC_FORTIFY_UNKNOWN_SIZE ((size_t) -1) 579 580#endif /* !_SYS_CDEFS_H_ */ 581