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