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