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