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  * 4. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      @(#)cdefs.h     8.8 (Berkeley) 1/9/95
  33  * $FreeBSD$
  34  */
  35
  36 #ifndef _SYS_CDEFS_H_
  37 #define _SYS_CDEFS_H_
  38
  39 /*
  40  * Testing against Clang-specific extensions.
  41  */
  42
  43 #ifndef __has_extension
  44 #define __has_extension         __has_feature
  45 #endif
  46 #ifndef __has_feature
  47 #define __has_feature(x)        0
  48 #endif
  49 #ifndef __has_include
  50 #define __has_include(x)        0
  51 #endif
  52 #ifndef __has_builtin
  53 #define __has_builtin(x)        0
  54 #endif
  55
  56 #if defined(__cplusplus)
  57 #define __BEGIN_DECLS   extern "C" {
  58 #define __END_DECLS     }
  59 #else
  60 #define __BEGIN_DECLS
  61 #define __END_DECLS
  62 #endif
  63
  64 /*
  65  * This code has been put in place to help reduce the addition of
  66  * compiler specific defines in FreeBSD code.  It helps to aid in
  67  * having a compiler-agnostic source tree.
  68  */
  69
  70 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
  71
  72 #if __GNUC__ >= 3 || defined(__INTEL_COMPILER)
  73 #define __GNUCLIKE_ASM 3
  74 #define __GNUCLIKE_MATH_BUILTIN_CONSTANTS
  75 #else
  76 #define __GNUCLIKE_ASM 2
  77 #endif
  78 #define __GNUCLIKE___TYPEOF 1
  79 #define __GNUCLIKE___OFFSETOF 1
  80 #define __GNUCLIKE___SECTION 1
  81
  82 #ifndef __INTEL_COMPILER
  83 # define __GNUCLIKE_CTOR_SECTION_HANDLING 1
  84 #endif
  85
  86 #define __GNUCLIKE_BUILTIN_CONSTANT_P 1
  87 # if defined(__INTEL_COMPILER) && defined(__cplusplus) \
  88     && __INTEL_COMPILER < 800
  89 #  undef __GNUCLIKE_BUILTIN_CONSTANT_P
  90 # endif
  91
  92 #if (__GNUC_MINOR__ > 95 || __GNUC__ >= 3) && !defined(__INTEL_COMPILER)
  93 # define __GNUCLIKE_BUILTIN_VARARGS 1
  94 # define __GNUCLIKE_BUILTIN_STDARG 1
  95 # define __GNUCLIKE_BUILTIN_VAALIST 1
  96 #endif
  97
  98 #if defined(__GNUC__)
  99 # define __GNUC_VA_LIST_COMPATIBILITY 1
 100 #endif
 101
 102 /*
 103  * Compiler memory barriers, specific to gcc and clang.
 104  */
 105 #if defined(__GNUC__)
 106 #define __compiler_membar()     __asm __volatile(" " : : : "memory")
 107 #endif
 108
 109 #ifndef __INTEL_COMPILER
 110 # define __GNUCLIKE_BUILTIN_NEXT_ARG 1
 111 # define __GNUCLIKE_MATH_BUILTIN_RELOPS
 112 #endif
 113
 114 #define __GNUCLIKE_BUILTIN_MEMCPY 1
 115
 116 /* XXX: if __GNUC__ >= 2: not tested everywhere originally, where replaced */
 117 #define __CC_SUPPORTS_INLINE 1
 118 #define __CC_SUPPORTS___INLINE 1
 119 #define __CC_SUPPORTS___INLINE__ 1
 120
 121 #define __CC_SUPPORTS___FUNC__ 1
 122 #define __CC_SUPPORTS_WARNING 1
 123
 124 #define __CC_SUPPORTS_VARADIC_XXX 1 /* see varargs.h */
 125
 126 #define __CC_SUPPORTS_DYNAMIC_ARRAY_INIT 1
 127
 128 #endif /* __GNUC__ || __INTEL_COMPILER */
 129
 130 /*
 131  * Macro to test if we're using a specific version of gcc or later.
 132  */
 133 #if defined(__GNUC__) && !defined(__INTEL_COMPILER)
 134 #define __GNUC_PREREQ__(ma, mi) \
 135         (__GNUC__ > (ma) || __GNUC__ == (ma) && __GNUC_MINOR__ >= (mi))
 136 #else
 137 #define __GNUC_PREREQ__(ma, mi) 0
 138 #endif
 139
 140 /*
 141  * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
 142  * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
 143  * The __CONCAT macro is a bit tricky to use if it must work in non-ANSI
 144  * mode -- there must be no spaces between its arguments, and for nested
 145  * __CONCAT's, all the __CONCAT's must be at the left.  __CONCAT can also
 146  * concatenate double-quoted strings produced by the __STRING macro, but
 147  * this only works with ANSI C.
 148  *
 149  * __XSTRING is like __STRING, but it expands any macros in its argument
 150  * first.  It is only available with ANSI C.
 151  */
 152 #if defined(__STDC__) || defined(__cplusplus)
 153 #define __P(protos)     protos          /* full-blown ANSI C */
 154 #define __CONCAT1(x,y)  x ## y
 155 #define __CONCAT(x,y)   __CONCAT1(x,y)
 156 #define __STRING(x)     #x              /* stringify without expanding x */
 157 #define __XSTRING(x)    __STRING(x)     /* expand x, then stringify */
 158
 159 #define __const         const           /* define reserved names to standard */
 160 #define __signed        signed
 161 #define __volatile      volatile
 162 #if defined(__cplusplus)
 163 #define __inline        inline          /* convert to C++ keyword */
 164 #else
 165 #if !(defined(__CC_SUPPORTS___INLINE))
 166 #define __inline                        /* delete GCC keyword */
 167 #endif /* ! __CC_SUPPORTS___INLINE */
 168 #endif /* !__cplusplus */
 169
 170 #else   /* !(__STDC__ || __cplusplus) */
 171 #define __P(protos)     ()              /* traditional C preprocessor */
 172 #define __CONCAT(x,y)   x/**/y
 173 #define __STRING(x)     "x"
 174
 175 #if !defined(__CC_SUPPORTS___INLINE)
 176 #define __const                         /* delete pseudo-ANSI C keywords */
 177 #define __inline
 178 #define __signed
 179 #define __volatile
 180 /*
 181  * In non-ANSI C environments, new programs will want ANSI-only C keywords
 182  * deleted from the program and old programs will want them left alone.
 183  * When using a compiler other than gcc, programs using the ANSI C keywords
 184  * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
 185  * When using "gcc -traditional", we assume that this is the intent; if
 186  * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
 187  */
 188 #ifndef NO_ANSI_KEYWORDS
 189 #define const                           /* delete ANSI C keywords */
 190 #define inline
 191 #define signed
 192 #define volatile
 193 #endif  /* !NO_ANSI_KEYWORDS */
 194 #endif  /* !__CC_SUPPORTS___INLINE */
 195 #endif  /* !(__STDC__ || __cplusplus) */
 196
 197 /*
 198  * Compiler-dependent macros to help declare dead (non-returning) and
 199  * pure (no side effects) functions, and unused variables.  They are
 200  * null except for versions of gcc that are known to support the features
 201  * properly (old versions of gcc-2 supported the dead and pure features
 202  * in a different (wrong) way).  If we do not provide an implementation
 203  * for a given compiler, let the compile fail if it is told to use
 204  * a feature that we cannot live without.
 205  */
 206 #ifdef lint
 207 #define __dead2
 208 #define __pure2
 209 #define __unused
 210 #define __packed
 211 #define __aligned(x)
 212 #define __section(x)
 213 #define __weak
 214 #else
 215 #define __weak          __attribute__((__weak__))
 216 #if !__GNUC_PREREQ__(2, 5) && !defined(__INTEL_COMPILER)
 217 #define __dead2
 218 #define __pure2
 219 #define __unused
 220 #endif
 221 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 && __GNUC_MINOR__ < 7 && !defined(__INTEL_COMPILER)
 222 #define __dead2         __attribute__((__noreturn__))
 223 #define __pure2         __attribute__((__const__))
 224 #define __unused
 225 /* XXX Find out what to do for __packed, __aligned and __section */
 226 #endif
 227 #if __GNUC_PREREQ__(2, 7)
 228 #define __dead2         __attribute__((__noreturn__))
 229 #define __pure2         __attribute__((__const__))
 230 #define __unused        __attribute__((__unused__))
 231 #define __used          __attribute__((__used__))
 232 #define __packed        __attribute__((__packed__))
 233 #define __aligned(x)    __attribute__((__aligned__(x)))
 234 #define __section(x)    __attribute__((__section__(x)))
 235 #endif
 236 #if defined(__INTEL_COMPILER)
 237 #define __dead2         __attribute__((__noreturn__))
 238 #define __pure2         __attribute__((__const__))
 239 #define __unused        __attribute__((__unused__))
 240 #define __used          __attribute__((__used__))
 241 #define __packed        __attribute__((__packed__))
 242 #define __aligned(x)    __attribute__((__aligned__(x)))
 243 #define __section(x)    __attribute__((__section__(x)))
 244 #endif
 245 #endif
 246
 247 #if !__GNUC_PREREQ__(2, 95)
 248 #define __alignof(x)    __offsetof(struct { char __a; x __b; }, __b)
 249 #endif
 250
 251 /*
 252  * Keywords added in C11.
 253  */
 254
 255 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
 256
 257 #if !__has_extension(c_alignas) && !__GNUC_PREREQ__(4, 7)
 258 #if (defined(__cplusplus) && __cplusplus >= 201103L) || \
 259     __has_extension(cxx_alignas)
 260 #define _Alignas(x)             alignas(x)
 261 #else
 262 /* XXX: Only emulates _Alignas(constant-expression); not _Alignas(type-name). */
 263 #define _Alignas(x)             __aligned(x)
 264 #endif
 265 #endif
 266
 267 #if !__GNUC_PREREQ__(4, 7)
 268 #if defined(__cplusplus) && __cplusplus >= 201103L
 269 #define _Alignof(x)             alignof(x)
 270 #else
 271 #define _Alignof(x)             __alignof(x)
 272 #endif
 273 #endif
 274
 275 #if !__has_extension(c_atomic) && !__has_extension(cxx_atomic)
 276 /*
 277  * No native support for _Atomic(). Place object in structure to prevent
 278  * most forms of direct non-atomic access.
 279  */
 280 #define _Atomic(T)              struct { T volatile __val; }
 281 #endif
 282
 283 #if !__GNUC_PREREQ__(4, 7)
 284 #if defined(__cplusplus) && __cplusplus >= 201103L
 285 #define _Noreturn               [[noreturn]]
 286 #else
 287 #define _Noreturn               __dead2
 288 #endif
 289 #endif
 290
 291 #if !__has_extension(c_static_assert) && !__GNUC_PREREQ__(4, 7)
 292 #if (defined(__cplusplus) && __cplusplus >= 201103L) || \
 293     __has_extension(cxx_static_assert)
 294 #define _Static_assert(x, y)    static_assert(x, y)
 295 #elif defined(__COUNTER__)
 296 #define _Static_assert(x, y)    __Static_assert(x, __COUNTER__)
 297 #define __Static_assert(x, y)   ___Static_assert(x, y)
 298 #define ___Static_assert(x, y)  typedef char __assert_ ## y[(x) ? 1 : -1]
 299 #else
 300 #define _Static_assert(x, y)    struct __hack
 301 #endif
 302 #endif
 303
 304 #if !__has_extension(c_thread_local) && !__GNUC_PREREQ__(4, 9)
 305 /*
 306  * XXX: Some compilers (Clang 3.3, GCC 4.7) falsely announce C++11 mode
 307  * without actually supporting the thread_local keyword. Don't check for
 308  * the presence of C++11 when defining _Thread_local.
 309  */
 310 #if /* (defined(__cplusplus) && __cplusplus >= 201103L) || */ \
 311     __has_extension(cxx_thread_local)
 312 #define _Thread_local           thread_local
 313 #else
 314 #define _Thread_local           __thread
 315 #endif
 316 #endif
 317
 318 #endif /* __STDC_VERSION__ || __STDC_VERSION__ < 201112L */
 319
 320 /*
 321  * Emulation of C11 _Generic().  Unlike the previously defined C11
 322  * keywords, it is not possible to implement this using exactly the same
 323  * syntax.  Therefore implement something similar under the name
 324  * __generic().  Unlike _Generic(), this macro can only distinguish
 325  * between a single type, so it requires nested invocations to
 326  * distinguish multiple cases.
 327  */
 328
 329 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L) || \
 330     __has_extension(c_generic_selections) || __GNUC_PREREQ__(4, 9)
 331 #define __generic(expr, t, yes, no)                                     \
 332         _Generic(expr, t: yes, default: no)
 333 #elif __GNUC_PREREQ__(3, 1) && !defined(__cplusplus)
 334 #define __generic(expr, t, yes, no)                                     \
 335         __builtin_choose_expr(                                          \
 336             __builtin_types_compatible_p(__typeof(expr), t), yes, no)
 337 #endif
 338
 339 #if __GNUC_PREREQ__(2, 96)
 340 #define __malloc_like   __attribute__((__malloc__))
 341 #define __pure          __attribute__((__pure__))
 342 #else
 343 #define __malloc_like
 344 #define __pure
 345 #endif
 346
 347 #if __GNUC_PREREQ__(3, 1) || (defined(__INTEL_COMPILER) && __INTEL_COMPILER >= 800)
 348 #define __always_inline __attribute__((__always_inline__))
 349 #else
 350 #define __always_inline
 351 #endif
 352
 353 #if __GNUC_PREREQ__(3, 1)
 354 #define __noinline      __attribute__ ((__noinline__))
 355 #else
 356 #define __noinline
 357 #endif
 358
 359 #if __GNUC_PREREQ__(3, 3)
 360 #define __nonnull(x)    __attribute__((__nonnull__(x)))
 361 #else
 362 #define __nonnull(x)
 363 #endif
 364
 365 #if __GNUC_PREREQ__(3, 4)
 366 #define __fastcall      __attribute__((__fastcall__))
 367 #else
 368 #define __fastcall
 369 #endif
 370
 371 #if __GNUC_PREREQ__(4, 1)
 372 #define __returns_twice __attribute__((__returns_twice__))
 373 #else
 374 #define __returns_twice
 375 #endif
 376
 377 /* XXX: should use `#if __STDC_VERSION__ < 199901'. */
 378 #if !__GNUC_PREREQ__(2, 7) && !defined(__INTEL_COMPILER)
 379 #define __func__        NULL
 380 #endif
 381
 382 #if (defined(__INTEL_COMPILER) || (defined(__GNUC__) && __GNUC__ >= 2)) && !defined(__STRICT_ANSI__) || __STDC_VERSION__ >= 199901
 383 #define __LONG_LONG_SUPPORTED
 384 #endif
 385
 386 /* C++11 exposes a load of C99 stuff */
 387 #if defined(__cplusplus) && __cplusplus >= 201103L
 388 #define __LONG_LONG_SUPPORTED
 389 #ifndef __STDC_LIMIT_MACROS
 390 #define __STDC_LIMIT_MACROS
 391 #endif
 392 #ifndef __STDC_CONSTANT_MACROS
 393 #define __STDC_CONSTANT_MACROS
 394 #endif
 395 #endif
 396
 397 /*
 398  * GCC 2.95 provides `__restrict' as an extension to C90 to support the
 399  * C99-specific `restrict' type qualifier.  We happen to use `__restrict' as
 400  * a way to define the `restrict' type qualifier without disturbing older
 401  * software that is unaware of C99 keywords.
 402  */
 403 #if !(__GNUC__ == 2 && __GNUC_MINOR__ == 95)
 404 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901 || defined(lint)
 405 #define __restrict
 406 #else
 407 #define __restrict      restrict
 408 #endif
 409 #endif
 410
 411 /*
 412  * GNU C version 2.96 adds explicit branch prediction so that
 413  * the CPU back-end can hint the processor and also so that
 414  * code blocks can be reordered such that the predicted path
 415  * sees a more linear flow, thus improving cache behavior, etc.
 416  *
 417  * The following two macros provide us with a way to utilize this
 418  * compiler feature.  Use __predict_true() if you expect the expression
 419  * to evaluate to true, and __predict_false() if you expect the
 420  * expression to evaluate to false.
 421  *
 422  * A few notes about usage:
 423  *
 424  *      * Generally, __predict_false() error condition checks (unless
 425  *        you have some _strong_ reason to do otherwise, in which case
 426  *        document it), and/or __predict_true() `no-error' condition
 427  *        checks, assuming you want to optimize for the no-error case.
 428  *
 429  *      * Other than that, if you don't know the likelihood of a test
 430  *        succeeding from empirical or other `hard' evidence, don't
 431  *        make predictions.
 432  *
 433  *      * These are meant to be used in places that are run `a lot'.
 434  *        It is wasteful to make predictions in code that is run
 435  *        seldomly (e.g. at subsystem initialization time) as the
 436  *        basic block reordering that this affects can often generate
 437  *        larger code.
 438  */
 439 #if __GNUC_PREREQ__(2, 96)
 440 #define __predict_true(exp)     __builtin_expect((exp), 1)
 441 #define __predict_false(exp)    __builtin_expect((exp), 0)
 442 #else
 443 #define __predict_true(exp)     (exp)
 444 #define __predict_false(exp)    (exp)
 445 #endif
 446
 447 #if __GNUC_PREREQ__(4, 2)
 448 #define __hidden        __attribute__((__visibility__("hidden")))
 449 #define __exported      __attribute__((__visibility__("default")))
 450 #else
 451 #define __hidden
 452 #define __exported
 453 #endif
 454
 455 /*
 456  * We define this here since <stddef.h>, <sys/queue.h>, and <sys/types.h>
 457  * require it.
 458  */
 459 #if __GNUC_PREREQ__(4, 1)
 460 #define __offsetof(type, field)  __builtin_offsetof(type, field)
 461 #else
 462 #ifndef __cplusplus
 463 #define __offsetof(type, field) \
 464         ((__size_t)(__uintptr_t)((const volatile void *)&((type *)0)->field))
 465 #else
 466 #define __offsetof(type, field)                                 \
 467   (__offsetof__ (reinterpret_cast <__size_t>                    \
 468                  (&reinterpret_cast <const volatile char &>     \
 469                   (static_cast<type *> (0)->field))))
 470 #endif
 471 #endif
 472 #define __rangeof(type, start, end) \
 473         (__offsetof(type, end) - __offsetof(type, start))
 474
 475 /*
 476  * Given the pointer x to the member m of the struct s, return
 477  * a pointer to the containing structure.  When using GCC, we first
 478  * assign pointer x to a local variable, to check that its type is
 479  * compatible with member m.
 480  */
 481 #if __GNUC_PREREQ__(3, 1)
 482 #define __containerof(x, s, m) ({                                       \
 483         const volatile __typeof(((s *)0)->m) *__x = (x);                \
 484         __DEQUALIFY(s *, (const volatile char *)__x - __offsetof(s, m));\
 485 })
 486 #else
 487 #define __containerof(x, s, m)                                          \
 488         __DEQUALIFY(s *, (const volatile char *)(x) - __offsetof(s, m))
 489 #endif
 490
 491 /*
 492  * Compiler-dependent macros to declare that functions take printf-like
 493  * or scanf-like arguments.  They are null except for versions of gcc
 494  * that are known to support the features properly (old versions of gcc-2
 495  * didn't permit keeping the keywords out of the application namespace).
 496  */
 497 #if !__GNUC_PREREQ__(2, 7) && !defined(__INTEL_COMPILER)
 498 #define __printflike(fmtarg, firstvararg)
 499 #define __scanflike(fmtarg, firstvararg)
 500 #define __format_arg(fmtarg)
 501 #define __strfmonlike(fmtarg, firstvararg)
 502 #define __strftimelike(fmtarg, firstvararg)
 503 #else
 504 #define __printflike(fmtarg, firstvararg) \
 505             __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
 506 #define __scanflike(fmtarg, firstvararg) \
 507             __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
 508 #define __format_arg(fmtarg)    __attribute__((__format_arg__ (fmtarg)))
 509 #define __strfmonlike(fmtarg, firstvararg) \
 510             __attribute__((__format__ (__strfmon__, fmtarg, firstvararg)))
 511 #define __strftimelike(fmtarg, firstvararg) \
 512             __attribute__((__format__ (__strftime__, fmtarg, firstvararg)))
 513 #endif
 514
 515 /* Compiler-dependent macros that rely on FreeBSD-specific extensions. */
 516 #if defined(__FreeBSD_cc_version) && __FreeBSD_cc_version >= 300001 && \
 517     defined(__GNUC__) && !defined(__INTEL_COMPILER)
 518 #define __printf0like(fmtarg, firstvararg) \
 519             __attribute__((__format__ (__printf0__, fmtarg, firstvararg)))
 520 #else
 521 #define __printf0like(fmtarg, firstvararg)
 522 #endif
 523
 524 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
 525 #ifndef __INTEL_COMPILER
 526 #define __strong_reference(sym,aliassym)        \
 527         extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym)))
 528 #endif
 529 #ifdef __STDC__
 530 #define __weak_reference(sym,alias)     \
 531         __asm__(".weak " #alias);       \
 532         __asm__(".equ "  #alias ", " #sym)
 533 #define __warn_references(sym,msg)      \
 534         __asm__(".section .gnu.warning." #sym); \
 535         __asm__(".asciz \"" msg "\"");  \
 536         __asm__(".previous")
 537 #define __sym_compat(sym,impl,verid)    \
 538         __asm__(".symver " #impl ", " #sym "@" #verid)
 539 #define __sym_default(sym,impl,verid)   \
 540         __asm__(".symver " #impl ", " #sym "@@" #verid)
 541 #else
 542 #define __weak_reference(sym,alias)     \
 543         __asm__(".weak alias");         \
 544         __asm__(".equ alias, sym")
 545 #define __warn_references(sym,msg)      \
 546         __asm__(".section .gnu.warning.sym"); \
 547         __asm__(".asciz \"msg\"");      \
 548         __asm__(".previous")
 549 #define __sym_compat(sym,impl,verid)    \
 550         __asm__(".symver impl, sym@verid")
 551 #define __sym_default(impl,sym,verid)   \
 552         __asm__(".symver impl, sym@@verid")
 553 #endif  /* __STDC__ */
 554 #endif  /* __GNUC__ || __INTEL_COMPILER */
 555
 556 #define __GLOBL1(sym)   __asm__(".globl " #sym)
 557 #define __GLOBL(sym)    __GLOBL1(sym)
 558
 559 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
 560 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"")
 561 #else
 562 /*
 563  * The following definition might not work well if used in header files,
 564  * but it should be better than nothing.  If you want a "do nothing"
 565  * version, then it should generate some harmless declaration, such as:
 566  *    #define __IDSTRING(name,string)   struct __hack
 567  */
 568 #define __IDSTRING(name,string) static const char name[] __unused = string
 569 #endif
 570
 571 /*
 572  * Embed the rcs id of a source file in the resulting library.  Note that in
 573  * more recent ELF binutils, we use .ident allowing the ID to be stripped.
 574  * Usage:
 575  *      __FBSDID("$FreeBSD$");
 576  */
 577 #ifndef __FBSDID
 578 #if !defined(lint) && !defined(STRIP_FBSDID)
 579 #define __FBSDID(s)     __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
 580 #else
 581 #define __FBSDID(s)     struct __hack
 582 #endif
 583 #endif
 584
 585 #ifndef __RCSID
 586 #ifndef NO__RCSID
 587 #define __RCSID(s)      __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
 588 #else
 589 #define __RCSID(s)      struct __hack
 590 #endif
 591 #endif
 592
 593 #ifndef __RCSID_SOURCE
 594 #ifndef NO__RCSID_SOURCE
 595 #define __RCSID_SOURCE(s)       __IDSTRING(__CONCAT(__rcsid_source_,__LINE__),s)
 596 #else
 597 #define __RCSID_SOURCE(s)       struct __hack
 598 #endif
 599 #endif
 600
 601 #ifndef __SCCSID
 602 #ifndef NO__SCCSID
 603 #define __SCCSID(s)     __IDSTRING(__CONCAT(__sccsid_,__LINE__),s)
 604 #else
 605 #define __SCCSID(s)     struct __hack
 606 #endif
 607 #endif
 608
 609 #ifndef __COPYRIGHT
 610 #ifndef NO__COPYRIGHT
 611 #define __COPYRIGHT(s)  __IDSTRING(__CONCAT(__copyright_,__LINE__),s)
 612 #else
 613 #define __COPYRIGHT(s)  struct __hack
 614 #endif
 615 #endif
 616
 617 #ifndef __DECONST
 618 #define __DECONST(type, var)    ((type)(__uintptr_t)(const void *)(var))
 619 #endif
 620
 621 #ifndef __DEVOLATILE
 622 #define __DEVOLATILE(type, var) ((type)(__uintptr_t)(volatile void *)(var))
 623 #endif
 624
 625 #ifndef __DEQUALIFY
 626 #define __DEQUALIFY(type, var)  ((type)(__uintptr_t)(const volatile void *)(var))
 627 #endif
 628
 629 /*-
 630  * The following definitions are an extension of the behavior originally
 631  * implemented in <sys/_posix.h>, but with a different level of granularity.
 632  * POSIX.1 requires that the macros we test be defined before any standard
 633  * header file is included.
 634  *
 635  * Here's a quick run-down of the versions:
 636  *  defined(_POSIX_SOURCE)              1003.1-1988
 637  *  _POSIX_C_SOURCE == 1                1003.1-1990
 638  *  _POSIX_C_SOURCE == 2                1003.2-1992 C Language Binding Option
 639  *  _POSIX_C_SOURCE == 199309           1003.1b-1993
 640  *  _POSIX_C_SOURCE == 199506           1003.1c-1995, 1003.1i-1995,
 641  *                                      and the omnibus ISO/IEC 9945-1: 1996
 642  *  _POSIX_C_SOURCE == 200112           1003.1-2001
 643  *  _POSIX_C_SOURCE == 200809           1003.1-2008
 644  *
 645  * In addition, the X/Open Portability Guide, which is now the Single UNIX
 646  * Specification, defines a feature-test macro which indicates the version of
 647  * that specification, and which subsumes _POSIX_C_SOURCE.
 648  *
 649  * Our macros begin with two underscores to avoid namespace screwage.
 650  */
 651
 652 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */
 653 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 1
 654 #undef _POSIX_C_SOURCE          /* Probably illegal, but beyond caring now. */
 655 #define _POSIX_C_SOURCE         199009
 656 #endif
 657
 658 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */
 659 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 2
 660 #undef _POSIX_C_SOURCE
 661 #define _POSIX_C_SOURCE         199209
 662 #endif
 663
 664 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
 665 #ifdef _XOPEN_SOURCE
 666 #if _XOPEN_SOURCE - 0 >= 700
 667 #define __XSI_VISIBLE           700
 668 #undef _POSIX_C_SOURCE
 669 #define _POSIX_C_SOURCE         200809
 670 #elif _XOPEN_SOURCE - 0 >= 600
 671 #define __XSI_VISIBLE           600
 672 #undef _POSIX_C_SOURCE
 673 #define _POSIX_C_SOURCE         200112
 674 #elif _XOPEN_SOURCE - 0 >= 500
 675 #define __XSI_VISIBLE           500
 676 #undef _POSIX_C_SOURCE
 677 #define _POSIX_C_SOURCE         199506
 678 #endif
 679 #endif
 680
 681 /*
 682  * Deal with all versions of POSIX.  The ordering relative to the tests above is
 683  * important.
 684  */
 685 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
 686 #define _POSIX_C_SOURCE         198808
 687 #endif
 688 #ifdef _POSIX_C_SOURCE
 689 #if _POSIX_C_SOURCE >= 200809
 690 #define __POSIX_VISIBLE         200809
 691 #define __ISO_C_VISIBLE         1999
 692 #elif _POSIX_C_SOURCE >= 200112
 693 #define __POSIX_VISIBLE         200112
 694 #define __ISO_C_VISIBLE         1999
 695 #elif _POSIX_C_SOURCE >= 199506
 696 #define __POSIX_VISIBLE         199506
 697 #define __ISO_C_VISIBLE         1990
 698 #elif _POSIX_C_SOURCE >= 199309
 699 #define __POSIX_VISIBLE         199309
 700 #define __ISO_C_VISIBLE         1990
 701 #elif _POSIX_C_SOURCE >= 199209
 702 #define __POSIX_VISIBLE         199209
 703 #define __ISO_C_VISIBLE         1990
 704 #elif _POSIX_C_SOURCE >= 199009
 705 #define __POSIX_VISIBLE         199009
 706 #define __ISO_C_VISIBLE         1990
 707 #else
 708 #define __POSIX_VISIBLE         198808
 709 #define __ISO_C_VISIBLE         0
 710 #endif /* _POSIX_C_SOURCE */
 711 #else
 712 /*-
 713  * Deal with _ANSI_SOURCE:
 714  * If it is defined, and no other compilation environment is explicitly
 715  * requested, then define our internal feature-test macros to zero.  This
 716  * makes no difference to the preprocessor (undefined symbols in preprocessing
 717  * expressions are defined to have value zero), but makes it more convenient for
 718  * a test program to print out the values.
 719  *
 720  * If a program mistakenly defines _ANSI_SOURCE and some other macro such as
 721  * _POSIX_C_SOURCE, we will assume that it wants the broader compilation
 722  * environment (and in fact we will never get here).
 723  */
 724 #if defined(_ANSI_SOURCE)       /* Hide almost everything. */
 725 #define __POSIX_VISIBLE         0
 726 #define __XSI_VISIBLE           0
 727 #define __BSD_VISIBLE           0
 728 #define __ISO_C_VISIBLE         1990
 729 #elif defined(_C99_SOURCE)      /* Localism to specify strict C99 env. */
 730 #define __POSIX_VISIBLE         0
 731 #define __XSI_VISIBLE           0
 732 #define __BSD_VISIBLE           0
 733 #define __ISO_C_VISIBLE         1999
 734 #elif defined(_C11_SOURCE)      /* Localism to specify strict C11 env. */
 735 #define __POSIX_VISIBLE         0
 736 #define __XSI_VISIBLE           0
 737 #define __BSD_VISIBLE           0
 738 #define __ISO_C_VISIBLE         2011
 739 #else                           /* Default environment: show everything. */
 740 #define __POSIX_VISIBLE         200809
 741 #define __XSI_VISIBLE           700
 742 #define __BSD_VISIBLE           1
 743 #define __ISO_C_VISIBLE         2011
 744 #endif
 745 #endif
 746
 747 #if defined(__mips) || defined(__powerpc64__)
 748 #define __NO_TLS 1
 749 #endif
 750
 751 /*
 752  * Lock annotations.
 753  *
 754  * Clang provides support for doing basic thread-safety tests at
 755  * compile-time, by marking which locks will/should be held when
 756  * entering/leaving a functions.
 757  *
 758  * Furthermore, it is also possible to annotate variables and structure
 759  * members to enforce that they are only accessed when certain locks are
 760  * held.
 761  */
 762
 763 #if __has_extension(c_thread_safety_attributes)
 764 #define __lock_annotate(x)      __attribute__((x))
 765 #else
 766 #define __lock_annotate(x)
 767 #endif
 768
 769 /* Structure implements a lock. */
 770 #define __lockable              __lock_annotate(lockable)
 771
 772 /* Function acquires an exclusive or shared lock. */
 773 #define __locks_exclusive(...) \
 774         __lock_annotate(exclusive_lock_function(__VA_ARGS__))
 775 #define __locks_shared(...) \
 776         __lock_annotate(shared_lock_function(__VA_ARGS__))
 777
 778 /* Function attempts to acquire an exclusive or shared lock. */
 779 #define __trylocks_exclusive(...) \
 780         __lock_annotate(exclusive_trylock_function(__VA_ARGS__))
 781 #define __trylocks_shared(...) \
 782         __lock_annotate(shared_trylock_function(__VA_ARGS__))
 783
 784 /* Function releases a lock. */
 785 #define __unlocks(...)          __lock_annotate(unlock_function(__VA_ARGS__))
 786
 787 /* Function asserts that an exclusive or shared lock is held. */
 788 #define __asserts_exclusive(...) \
 789         __lock_annotate(assert_exclusive_lock(__VA_ARGS__))
 790 #define __asserts_shared(...) \
 791         __lock_annotate(assert_shared_lock(__VA_ARGS__))
 792
 793 /* Function requires that an exclusive or shared lock is or is not held. */
 794 #define __requires_exclusive(...) \
 795         __lock_annotate(exclusive_locks_required(__VA_ARGS__))
 796 #define __requires_shared(...) \
 797         __lock_annotate(shared_locks_required(__VA_ARGS__))
 798 #define __requires_unlocked(...) \
 799         __lock_annotate(locks_excluded(__VA_ARGS__))
 800
 801 /* Function should not be analyzed. */
 802 #define __no_lock_analysis      __lock_annotate(no_thread_safety_analysis)
 803
 804 /* Guard variables and structure members by lock. */
 805 #define __guarded_by(x)         __lock_annotate(guarded_by(x))
 806 #define __pt_guarded_by(x)      __lock_annotate(pt_guarded_by(x))
 807
 808 #endif /* !_SYS_CDEFS_H_ */