2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1991, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Berkeley Software Design, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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
34 * @(#)cdefs.h 8.8 (Berkeley) 1/9/95
40 #if defined(_KERNEL) && defined(_STANDALONE)
41 #error "_KERNEL and _STANDALONE are mutually exclusive"
45 * Testing against Clang-specific extensions.
47 #ifndef __has_attribute
48 #define __has_attribute(x) 0
50 #ifndef __has_extension
51 #define __has_extension __has_feature
54 #define __has_feature(x) 0
57 #define __has_include(x) 0
60 #define __has_builtin(x) 0
63 #if defined(__cplusplus)
64 #define __BEGIN_DECLS extern "C" {
72 * This code has been put in place to help reduce the addition of
73 * compiler specific defines in FreeBSD code. It helps to aid in
74 * having a compiler-agnostic source tree.
80 #define __GNUCLIKE_ASM 3
81 #define __GNUCLIKE_MATH_BUILTIN_CONSTANTS
83 #define __GNUCLIKE_ASM 2
85 #define __GNUCLIKE___TYPEOF 1
86 #define __GNUCLIKE___SECTION 1
88 #define __GNUCLIKE_CTOR_SECTION_HANDLING 1
90 #define __GNUCLIKE_BUILTIN_CONSTANT_P 1
92 #if (__GNUC_MINOR__ > 95 || __GNUC__ >= 3)
93 #define __GNUCLIKE_BUILTIN_VARARGS 1
94 #define __GNUCLIKE_BUILTIN_STDARG 1
95 #define __GNUCLIKE_BUILTIN_VAALIST 1
98 #define __GNUC_VA_LIST_COMPATIBILITY 1
101 * Compiler memory barriers, specific to gcc and clang.
103 #define __compiler_membar() __asm __volatile(" " : : : "memory")
105 #define __GNUCLIKE_BUILTIN_NEXT_ARG 1
106 #define __GNUCLIKE_MATH_BUILTIN_RELOPS
108 #define __GNUCLIKE_BUILTIN_MEMCPY 1
110 /* XXX: if __GNUC__ >= 2: not tested everywhere originally, where replaced */
111 #define __CC_SUPPORTS_INLINE 1
112 #define __CC_SUPPORTS___INLINE 1
113 #define __CC_SUPPORTS___INLINE__ 1
115 #define __CC_SUPPORTS___FUNC__ 1
116 #define __CC_SUPPORTS_WARNING 1
118 #define __CC_SUPPORTS_VARADIC_XXX 1 /* see varargs.h */
120 #define __CC_SUPPORTS_DYNAMIC_ARRAY_INIT 1
122 #endif /* __GNUC__ */
125 * Macro to test if we're using a specific version of gcc or later.
127 #if defined(__GNUC__)
128 #define __GNUC_PREREQ__(ma, mi) \
129 (__GNUC__ > (ma) || __GNUC__ == (ma) && __GNUC_MINOR__ >= (mi))
131 #define __GNUC_PREREQ__(ma, mi) 0
135 * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
136 * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
137 * The __CONCAT macro is a bit tricky to use if it must work in non-ANSI
138 * mode -- there must be no spaces between its arguments, and for nested
139 * __CONCAT's, all the __CONCAT's must be at the left. __CONCAT can also
140 * concatenate double-quoted strings produced by the __STRING macro, but
141 * this only works with ANSI C.
143 * __XSTRING is like __STRING, but it expands any macros in its argument
144 * first. It is only available with ANSI C.
146 #if defined(__STDC__) || defined(__cplusplus)
147 #define __P(protos) protos /* full-blown ANSI C */
148 #define __CONCAT1(x,y) x ## y
149 #define __CONCAT(x,y) __CONCAT1(x,y)
150 #define __STRING(x) #x /* stringify without expanding x */
151 #define __XSTRING(x) __STRING(x) /* expand x, then stringify */
153 #define __const const /* define reserved names to standard */
154 #define __signed signed
155 #define __volatile volatile
156 #if defined(__cplusplus)
157 #define __inline inline /* convert to C++ keyword */
159 #if !(defined(__CC_SUPPORTS___INLINE))
160 #define __inline /* delete GCC keyword */
161 #endif /* ! __CC_SUPPORTS___INLINE */
162 #endif /* !__cplusplus */
164 #else /* !(__STDC__ || __cplusplus) */
165 #define __P(protos) () /* traditional C preprocessor */
166 #define __CONCAT(x,y) x/**/y
167 #define __STRING(x) "x"
169 #if !defined(__CC_SUPPORTS___INLINE)
170 #define __const /* delete pseudo-ANSI C keywords */
175 * In non-ANSI C environments, new programs will want ANSI-only C keywords
176 * deleted from the program and old programs will want them left alone.
177 * When using a compiler other than gcc, programs using the ANSI C keywords
178 * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
179 * When using "gcc -traditional", we assume that this is the intent; if
180 * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
182 #ifndef NO_ANSI_KEYWORDS
183 #define const /* delete ANSI C keywords */
187 #endif /* !NO_ANSI_KEYWORDS */
188 #endif /* !__CC_SUPPORTS___INLINE */
189 #endif /* !(__STDC__ || __cplusplus) */
192 * Compiler-dependent macros to help declare dead (non-returning) and
193 * pure (no side effects) functions, and unused variables. They are
194 * null except for versions of gcc that are known to support the features
195 * properly (old versions of gcc-2 supported the dead and pure features
196 * in a different (wrong) way). If we do not provide an implementation
197 * for a given compiler, let the compile fail if it is told to use
198 * a feature that we cannot live without.
200 #define __weak_symbol __attribute__((__weak__))
201 #if !__GNUC_PREREQ__(2, 5)
206 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 && __GNUC_MINOR__ < 7
207 #define __dead2 __attribute__((__noreturn__))
208 #define __pure2 __attribute__((__const__))
210 /* XXX Find out what to do for __packed, __aligned and __section */
212 #if __GNUC_PREREQ__(2, 7)
213 #define __dead2 __attribute__((__noreturn__))
214 #define __pure2 __attribute__((__const__))
215 #define __unused __attribute__((__unused__))
216 #define __used __attribute__((__used__))
217 #define __packed __attribute__((__packed__))
218 #define __aligned(x) __attribute__((__aligned__(x)))
219 #define __section(x) __attribute__((__section__(x)))
221 #if __GNUC_PREREQ__(4, 3) || __has_attribute(__alloc_size__)
222 #define __alloc_size(x) __attribute__((__alloc_size__(x)))
223 #define __alloc_size2(n, x) __attribute__((__alloc_size__(n, x)))
225 #define __alloc_size(x)
226 #define __alloc_size2(n, x)
228 #if __GNUC_PREREQ__(4, 9) || __has_attribute(__alloc_align__)
229 #define __alloc_align(x) __attribute__((__alloc_align__(x)))
231 #define __alloc_align(x)
234 #if !__GNUC_PREREQ__(2, 95)
235 #define __alignof(x) __offsetof(struct { char __a; x __b; }, __b)
239 * Keywords added in C11.
242 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
244 #if !__has_extension(c_alignas)
245 #if (defined(__cplusplus) && __cplusplus >= 201103L) || \
246 __has_extension(cxx_alignas)
247 #define _Alignas(x) alignas(x)
249 /* XXX: Only emulates _Alignas(constant-expression); not _Alignas(type-name). */
250 #define _Alignas(x) __aligned(x)
254 #if defined(__cplusplus) && __cplusplus >= 201103L
255 #define _Alignof(x) alignof(x)
257 #define _Alignof(x) __alignof(x)
260 #if !defined(__cplusplus) && !__has_extension(c_atomic) && \
261 !__has_extension(cxx_atomic) && !__GNUC_PREREQ__(4, 7)
263 * No native support for _Atomic(). Place object in structure to prevent
264 * most forms of direct non-atomic access.
266 #define _Atomic(T) struct { T volatile __val; }
269 #if defined(__cplusplus) && __cplusplus >= 201103L
270 #define _Noreturn [[noreturn]]
272 #define _Noreturn __dead2
275 #if !__has_extension(c_static_assert)
276 #if (defined(__cplusplus) && __cplusplus >= 201103L) || \
277 __has_extension(cxx_static_assert)
278 #define _Static_assert(x, y) static_assert(x, y)
279 #elif __GNUC_PREREQ__(4,6) && !defined(__cplusplus)
280 /* Nothing, gcc 4.6 and higher has _Static_assert built-in */
281 #elif defined(__COUNTER__)
282 #define _Static_assert(x, y) __Static_assert(x, __COUNTER__)
283 #define __Static_assert(x, y) ___Static_assert(x, y)
284 #define ___Static_assert(x, y) typedef char __assert_ ## y[(x) ? 1 : -1] \
287 #define _Static_assert(x, y) struct __hack
291 #if !__has_extension(c_thread_local)
293 * XXX: Some compilers (Clang 3.3, GCC 4.7) falsely announce C++11 mode
294 * without actually supporting the thread_local keyword. Don't check for
295 * the presence of C++11 when defining _Thread_local.
297 #if /* (defined(__cplusplus) && __cplusplus >= 201103L) || */ \
298 __has_extension(cxx_thread_local)
299 #define _Thread_local thread_local
301 #define _Thread_local __thread
305 #endif /* __STDC_VERSION__ || __STDC_VERSION__ < 201112L */
308 * Emulation of C11 _Generic(). Unlike the previously defined C11
309 * keywords, it is not possible to implement this using exactly the same
310 * syntax. Therefore implement something similar under the name
311 * __generic(). Unlike _Generic(), this macro can only distinguish
312 * between a single type, so it requires nested invocations to
313 * distinguish multiple cases.
315 * Note that the comma operator is used to force expr to decay in
316 * order to match _Generic().
319 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L) || \
320 __has_extension(c_generic_selections)
321 #define __generic(expr, t, yes, no) \
322 _Generic(expr, t: yes, default: no)
323 #elif __GNUC_PREREQ__(3, 1) && !defined(__cplusplus)
324 #define __generic(expr, t, yes, no) \
325 __builtin_choose_expr( \
326 __builtin_types_compatible_p(__typeof((0, (expr))), t), yes, no)
330 * C99 Static array indices in function parameter declarations. Syntax such as:
331 * void bar(int myArray[static 10]);
332 * is allowed in C99 but not in C++. Define __min_size appropriately so
333 * headers using it can be compiled in either language. Use like this:
334 * void bar(int myArray[__min_size(10)]);
336 #if !defined(__cplusplus) && \
337 (defined(__clang__) || __GNUC_PREREQ__(4, 6)) && \
338 (!defined(__STDC_VERSION__) || (__STDC_VERSION__ >= 199901))
339 #define __min_size(x) static (x)
341 #define __min_size(x) (x)
344 #if __GNUC_PREREQ__(2, 96)
345 #define __malloc_like __attribute__((__malloc__))
346 #define __pure __attribute__((__pure__))
348 #define __malloc_like
352 #if __GNUC_PREREQ__(3, 1)
353 #define __always_inline __attribute__((__always_inline__))
355 #define __always_inline
358 #if __GNUC_PREREQ__(3, 1)
359 #define __noinline __attribute__ ((__noinline__))
364 #if __GNUC_PREREQ__(3, 4)
365 #define __fastcall __attribute__((__fastcall__))
366 #define __result_use_check __attribute__((__warn_unused_result__))
369 #define __result_use_check
372 #if __GNUC_PREREQ__(4, 1)
373 #define __returns_twice __attribute__((__returns_twice__))
375 #define __returns_twice
378 #if __GNUC_PREREQ__(4, 6) || __has_builtin(__builtin_unreachable)
379 #define __unreachable() __builtin_unreachable()
381 #define __unreachable() ((void)0)
384 /* XXX: should use `#if __STDC_VERSION__ < 199901'. */
385 #if !__GNUC_PREREQ__(2, 7)
386 #define __func__ NULL
389 #if (defined(__GNUC__) && __GNUC__ >= 2) && !defined(__STRICT_ANSI__) || __STDC_VERSION__ >= 199901
390 #define __LONG_LONG_SUPPORTED
393 /* C++11 exposes a load of C99 stuff */
394 #if defined(__cplusplus) && __cplusplus >= 201103L
395 #define __LONG_LONG_SUPPORTED
396 #ifndef __STDC_LIMIT_MACROS
397 #define __STDC_LIMIT_MACROS
399 #ifndef __STDC_CONSTANT_MACROS
400 #define __STDC_CONSTANT_MACROS
405 * We use `__restrict' as a way to define the `restrict' type qualifier
406 * without disturbing older software that is unaware of C99 keywords.
407 * GCC also provides `__restrict' as an extension to support C99-style
408 * restricted pointers in other language modes.
410 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901
411 #define __restrict restrict
412 #elif !__GNUC_PREREQ__(2, 95)
417 * GNU C version 2.96 adds explicit branch prediction so that
418 * the CPU back-end can hint the processor and also so that
419 * code blocks can be reordered such that the predicted path
420 * sees a more linear flow, thus improving cache behavior, etc.
422 * The following two macros provide us with a way to utilize this
423 * compiler feature. Use __predict_true() if you expect the expression
424 * to evaluate to true, and __predict_false() if you expect the
425 * expression to evaluate to false.
427 * A few notes about usage:
429 * * Generally, __predict_false() error condition checks (unless
430 * you have some _strong_ reason to do otherwise, in which case
431 * document it), and/or __predict_true() `no-error' condition
432 * checks, assuming you want to optimize for the no-error case.
434 * * Other than that, if you don't know the likelihood of a test
435 * succeeding from empirical or other `hard' evidence, don't
438 * * These are meant to be used in places that are run `a lot'.
439 * It is wasteful to make predictions in code that is run
440 * seldomly (e.g. at subsystem initialization time) as the
441 * basic block reordering that this affects can often generate
444 #if __GNUC_PREREQ__(2, 96)
445 #define __predict_true(exp) __builtin_expect((exp), 1)
446 #define __predict_false(exp) __builtin_expect((exp), 0)
448 #define __predict_true(exp) (exp)
449 #define __predict_false(exp) (exp)
452 #if __GNUC_PREREQ__(4, 0)
453 #define __null_sentinel __attribute__((__sentinel__))
454 #define __exported __attribute__((__visibility__("default")))
455 #define __hidden __attribute__((__visibility__("hidden")))
457 #define __null_sentinel
463 * We define this here since <stddef.h>, <sys/queue.h>, and <sys/types.h>
466 #if __GNUC_PREREQ__(4, 1)
467 #define __offsetof(type, field) __builtin_offsetof(type, field)
470 #define __offsetof(type, field) \
471 ((__size_t)(__uintptr_t)((const volatile void *)&((type *)0)->field))
473 #define __offsetof(type, field) \
474 (__offsetof__ (reinterpret_cast <__size_t> \
475 (&reinterpret_cast <const volatile char &> \
476 (static_cast<type *> (0)->field))))
479 #define __rangeof(type, start, end) \
480 (__offsetof(type, end) - __offsetof(type, start))
483 * Given the pointer x to the member m of the struct s, return
484 * a pointer to the containing structure. When using GCC, we first
485 * assign pointer x to a local variable, to check that its type is
486 * compatible with member m.
488 #if __GNUC_PREREQ__(3, 1)
489 #define __containerof(x, s, m) ({ \
490 const volatile __typeof(((s *)0)->m) *__x = (x); \
491 __DEQUALIFY(s *, (const volatile char *)__x - __offsetof(s, m));\
494 #define __containerof(x, s, m) \
495 __DEQUALIFY(s *, (const volatile char *)(x) - __offsetof(s, m))
499 * Compiler-dependent macros to declare that functions take printf-like
500 * or scanf-like arguments. They are null except for versions of gcc
501 * that are known to support the features properly (old versions of gcc-2
502 * didn't permit keeping the keywords out of the application namespace).
504 #if !__GNUC_PREREQ__(2, 7)
505 #define __printflike(fmtarg, firstvararg)
506 #define __scanflike(fmtarg, firstvararg)
507 #define __format_arg(fmtarg)
508 #define __strfmonlike(fmtarg, firstvararg)
509 #define __strftimelike(fmtarg, firstvararg)
511 #define __printflike(fmtarg, firstvararg) \
512 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
513 #define __scanflike(fmtarg, firstvararg) \
514 __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
515 #define __format_arg(fmtarg) __attribute__((__format_arg__ (fmtarg)))
516 #define __strfmonlike(fmtarg, firstvararg) \
517 __attribute__((__format__ (__strfmon__, fmtarg, firstvararg)))
518 #define __strftimelike(fmtarg, firstvararg) \
519 __attribute__((__format__ (__strftime__, fmtarg, firstvararg)))
522 /* Compiler-dependent macros that rely on FreeBSD-specific extensions. */
523 #if defined(__FreeBSD_cc_version) && __FreeBSD_cc_version >= 300001 && \
525 #define __printf0like(fmtarg, firstvararg) \
526 __attribute__((__format__ (__printf0__, fmtarg, firstvararg)))
528 #define __printf0like(fmtarg, firstvararg)
531 #if defined(__GNUC__)
532 #define __strong_reference(sym,aliassym) \
533 extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym)))
535 #define __weak_reference(sym,alias) \
536 __asm__(".weak " #alias); \
537 __asm__(".equ " #alias ", " #sym)
538 #define __warn_references(sym,msg) \
539 __asm__(".section .gnu.warning." #sym); \
540 __asm__(".asciz \"" msg "\""); \
542 #define __sym_compat(sym,impl,verid) \
543 __asm__(".symver " #impl ", " #sym "@" #verid)
544 #define __sym_default(sym,impl,verid) \
545 __asm__(".symver " #impl ", " #sym "@@@" #verid)
547 #define __weak_reference(sym,alias) \
548 __asm__(".weak alias"); \
549 __asm__(".equ alias, sym")
550 #define __warn_references(sym,msg) \
551 __asm__(".section .gnu.warning.sym"); \
552 __asm__(".asciz \"msg\""); \
554 #define __sym_compat(sym,impl,verid) \
555 __asm__(".symver impl, sym@verid")
556 #define __sym_default(impl,sym,verid) \
557 __asm__(".symver impl, sym@@@verid")
558 #endif /* __STDC__ */
559 #endif /* __GNUC__ */
561 #define __GLOBL(sym) __asm__(".globl " __XSTRING(sym))
562 #define __WEAK(sym) __asm__(".weak " __XSTRING(sym))
564 #if defined(__GNUC__)
565 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"")
568 * The following definition might not work well if used in header files,
569 * but it should be better than nothing. If you want a "do nothing"
570 * version, then it should generate some harmless declaration, such as:
571 * #define __IDSTRING(name,string) struct __hack
573 #define __IDSTRING(name,string) static const char name[] __unused = string
577 * Embed the rcs id of a source file in the resulting library. Note that in
578 * more recent ELF binutils, we use .ident allowing the ID to be stripped.
582 #if !defined(STRIP_FBSDID)
583 #define __FBSDID(s) __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
585 #define __FBSDID(s) struct __hack
591 #define __RCSID(s) __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
593 #define __RCSID(s) struct __hack
597 #ifndef __RCSID_SOURCE
598 #ifndef NO__RCSID_SOURCE
599 #define __RCSID_SOURCE(s) __IDSTRING(__CONCAT(__rcsid_source_,__LINE__),s)
601 #define __RCSID_SOURCE(s) struct __hack
607 #define __SCCSID(s) __IDSTRING(__CONCAT(__sccsid_,__LINE__),s)
609 #define __SCCSID(s) struct __hack
614 #ifndef NO__COPYRIGHT
615 #define __COPYRIGHT(s) __IDSTRING(__CONCAT(__copyright_,__LINE__),s)
617 #define __COPYRIGHT(s) struct __hack
622 #define __DECONST(type, var) ((type)(__uintptr_t)(const void *)(var))
626 #define __DEVOLATILE(type, var) ((type)(__uintptr_t)(volatile void *)(var))
630 #define __DEQUALIFY(type, var) ((type)(__uintptr_t)(const volatile void *)(var))
634 * The following definitions are an extension of the behavior originally
635 * implemented in <sys/_posix.h>, but with a different level of granularity.
636 * POSIX.1 requires that the macros we test be defined before any standard
637 * header file is included.
639 * Here's a quick run-down of the versions (and some informal names)
640 * defined(_POSIX_SOURCE) 1003.1-1988
641 * encoded as 198808 below
642 * _POSIX_C_SOURCE == 1 1003.1-1990
643 * encoded as 199009 below
644 * _POSIX_C_SOURCE == 2 1003.2-1992 C Language Binding Option
645 * encoded as 199209 below
646 * _POSIX_C_SOURCE == 199309 1003.1b-1993
647 * (1003.1 Issue 4, Single Unix Spec v1, Unix 93)
648 * _POSIX_C_SOURCE == 199506 1003.1c-1995, 1003.1i-1995,
649 * and the omnibus ISO/IEC 9945-1: 1996
650 * (1003.1 Issue 5, Single Unix Spec v2, Unix 95)
651 * _POSIX_C_SOURCE == 200112 1003.1-2001 (1003.1 Issue 6, Unix 03)
652 * _POSIX_C_SOURCE == 200809 1003.1-2008 (1003.1 Issue 7)
653 * IEEE Std 1003.1-2017 (Rev of 1003.1-2008) is
654 * 1003.1-2008 with two TCs applied with
655 * _POSIX_C_SOURCE=200809 and _XOPEN_SOURCE=700
657 * In addition, the X/Open Portability Guide, which is now the Single UNIX
658 * Specification, defines a feature-test macro which indicates the version of
659 * that specification, and which subsumes _POSIX_C_SOURCE.
661 * Our macros begin with two underscores to avoid namespace screwage.
664 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */
665 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 1
666 #undef _POSIX_C_SOURCE /* Probably illegal, but beyond caring now. */
667 #define _POSIX_C_SOURCE 199009
670 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */
671 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 2
672 #undef _POSIX_C_SOURCE
673 #define _POSIX_C_SOURCE 199209
676 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
678 #if _XOPEN_SOURCE - 0 >= 700
679 #define __XSI_VISIBLE 700
680 #undef _POSIX_C_SOURCE
681 #define _POSIX_C_SOURCE 200809
682 #elif _XOPEN_SOURCE - 0 >= 600
683 #define __XSI_VISIBLE 600
684 #undef _POSIX_C_SOURCE
685 #define _POSIX_C_SOURCE 200112
686 #elif _XOPEN_SOURCE - 0 >= 500
687 #define __XSI_VISIBLE 500
688 #undef _POSIX_C_SOURCE
689 #define _POSIX_C_SOURCE 199506
694 * Deal with all versions of POSIX. The ordering relative to the tests above is
697 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
698 #define _POSIX_C_SOURCE 198808
700 #ifdef _POSIX_C_SOURCE
701 #if _POSIX_C_SOURCE >= 200809
702 #define __POSIX_VISIBLE 200809
703 #define __ISO_C_VISIBLE 1999
704 #elif _POSIX_C_SOURCE >= 200112
705 #define __POSIX_VISIBLE 200112
706 #define __ISO_C_VISIBLE 1999
707 #elif _POSIX_C_SOURCE >= 199506
708 #define __POSIX_VISIBLE 199506
709 #define __ISO_C_VISIBLE 1990
710 #elif _POSIX_C_SOURCE >= 199309
711 #define __POSIX_VISIBLE 199309
712 #define __ISO_C_VISIBLE 1990
713 #elif _POSIX_C_SOURCE >= 199209
714 #define __POSIX_VISIBLE 199209
715 #define __ISO_C_VISIBLE 1990
716 #elif _POSIX_C_SOURCE >= 199009
717 #define __POSIX_VISIBLE 199009
718 #define __ISO_C_VISIBLE 1990
720 #define __POSIX_VISIBLE 198808
721 #define __ISO_C_VISIBLE 0
722 #endif /* _POSIX_C_SOURCE */
724 * Both glibc and OpenBSD enable c11 features when _ISOC11_SOURCE is defined, or
725 * when compiling with -stdc=c11. A strict reading of the standard would suggest
726 * doing it only for the former. However, a strict reading also requires C99
727 * mode only, so building with C11 is already undefined. Follow glibc's and
728 * OpenBSD's lead for this non-standard configuration for maximum compatibility.
730 #if _ISOC11_SOURCE || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L)
731 #undef __ISO_C_VISIBLE
732 #define __ISO_C_VISIBLE 2011
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.
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).
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
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
780 #define __EXT1_VISIBLE 0
782 #endif /* __STDC_WANT_LIB_EXT1__ */
785 * Old versions of GCC use non-standard ARM arch symbols; acle-compat.h
786 * translates them to __ARM_ARCH and the modern feature symbols defined by ARM.
788 #if defined(__arm__) && !defined(__ARM_ARCH)
789 #include <machine/acle-compat.h>
793 * Nullability qualifiers: currently only supported by Clang.
795 #if !(defined(__clang__) && __has_feature(nullability))
798 #define _Null_unspecified
799 #define __NULLABILITY_PRAGMA_PUSH
800 #define __NULLABILITY_PRAGMA_POP
802 #define __NULLABILITY_PRAGMA_PUSH _Pragma("clang diagnostic push") \
803 _Pragma("clang diagnostic ignored \"-Wnullability-completeness\"")
804 #define __NULLABILITY_PRAGMA_POP _Pragma("clang diagnostic pop")
808 * Type Safety Checking
810 * Clang provides additional attributes to enable checking type safety
811 * properties that cannot be enforced by the C type system.
814 #if __has_attribute(__argument_with_type_tag__) && \
815 __has_attribute(__type_tag_for_datatype__)
816 #define __arg_type_tag(arg_kind, arg_idx, type_tag_idx) \
817 __attribute__((__argument_with_type_tag__(arg_kind, arg_idx, type_tag_idx)))
818 #define __datatype_type_tag(kind, type) \
819 __attribute__((__type_tag_for_datatype__(kind, type)))
821 #define __arg_type_tag(arg_kind, arg_idx, type_tag_idx)
822 #define __datatype_type_tag(kind, type)
828 * Clang provides support for doing basic thread-safety tests at
829 * compile-time, by marking which locks will/should be held when
830 * entering/leaving a functions.
832 * Furthermore, it is also possible to annotate variables and structure
833 * members to enforce that they are only accessed when certain locks are
837 #if __has_extension(c_thread_safety_attributes)
838 #define __lock_annotate(x) __attribute__((x))
840 #define __lock_annotate(x)
843 /* Structure implements a lock. */
844 #define __lockable __lock_annotate(lockable)
846 /* Function acquires an exclusive or shared lock. */
847 #define __locks_exclusive(...) \
848 __lock_annotate(exclusive_lock_function(__VA_ARGS__))
849 #define __locks_shared(...) \
850 __lock_annotate(shared_lock_function(__VA_ARGS__))
852 /* Function attempts to acquire an exclusive or shared lock. */
853 #define __trylocks_exclusive(...) \
854 __lock_annotate(exclusive_trylock_function(__VA_ARGS__))
855 #define __trylocks_shared(...) \
856 __lock_annotate(shared_trylock_function(__VA_ARGS__))
858 /* Function releases a lock. */
859 #define __unlocks(...) __lock_annotate(unlock_function(__VA_ARGS__))
861 /* Function asserts that an exclusive or shared lock is held. */
862 #define __asserts_exclusive(...) \
863 __lock_annotate(assert_exclusive_lock(__VA_ARGS__))
864 #define __asserts_shared(...) \
865 __lock_annotate(assert_shared_lock(__VA_ARGS__))
867 /* Function requires that an exclusive or shared lock is or is not held. */
868 #define __requires_exclusive(...) \
869 __lock_annotate(exclusive_locks_required(__VA_ARGS__))
870 #define __requires_shared(...) \
871 __lock_annotate(shared_locks_required(__VA_ARGS__))
872 #define __requires_unlocked(...) \
873 __lock_annotate(locks_excluded(__VA_ARGS__))
875 /* Function should not be analyzed. */
876 #define __no_lock_analysis __lock_annotate(no_thread_safety_analysis)
879 * Function or variable should not be sanitized, e.g., by AddressSanitizer.
880 * GCC has the nosanitize attribute, but as a function attribute only, and
881 * warns on use as a variable attribute.
883 #if __has_attribute(no_sanitize) && defined(__clang__)
885 #define __nosanitizeaddress __attribute__((no_sanitize("kernel-address")))
886 #define __nosanitizememory __attribute__((no_sanitize("kernel-memory")))
888 #define __nosanitizeaddress __attribute__((no_sanitize("address")))
889 #define __nosanitizememory __attribute__((no_sanitize("memory")))
891 #define __nosanitizethread __attribute__((no_sanitize("thread")))
893 #define __nosanitizeaddress
894 #define __nosanitizememory
895 #define __nosanitizethread
899 * Make it possible to opt out of stack smashing protection.
901 #if __has_attribute(no_stack_protector)
902 #define __nostackprotector __attribute__((no_stack_protector))
904 #define __nostackprotector \
905 __attribute__((__optimize__("-fno-stack-protector")))
908 /* Guard variables and structure members by lock. */
909 #define __guarded_by(x) __lock_annotate(guarded_by(x))
910 #define __pt_guarded_by(x) __lock_annotate(pt_guarded_by(x))
912 /* Alignment builtins for better type checking and improved code generation. */
913 /* Provide fallback versions for other compilers (GCC/Clang < 10): */
914 #if !__has_builtin(__builtin_is_aligned)
915 #define __builtin_is_aligned(x, align) \
916 (((__uintptr_t)x & ((align) - 1)) == 0)
918 #if !__has_builtin(__builtin_align_up)
919 #define __builtin_align_up(x, align) \
920 ((__typeof__(x))(((__uintptr_t)(x)+((align)-1))&(~((align)-1))))
922 #if !__has_builtin(__builtin_align_down)
923 #define __builtin_align_down(x, align) \
924 ((__typeof__(x))((x)&(~((align)-1))))
927 #define __align_up(x, y) __builtin_align_up(x, y)
928 #define __align_down(x, y) __builtin_align_down(x, y)
929 #define __is_aligned(x, y) __builtin_is_aligned(x, y)
931 #endif /* !_SYS_CDEFS_H_ */