sys/sys/cdefs.h

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