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