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