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