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