xref: /xnu-8020.140.41/bsd/sys/cdefs.h (revision 27b03b360a988dfd3dfdf34262bb0042026747cc)
1 /*
2  * Copyright (c) 2000-2018 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /* Copyright 1995 NeXT Computer, Inc. All rights reserved. */
29 /*
30  * Copyright (c) 1991, 1993
31  *	The Regents of the University of California.  All rights reserved.
32  *
33  * This code is derived from software contributed to Berkeley by
34  * Berkeley Software Design, Inc.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  * 3. All advertising materials mentioning features or use of this software
45  *    must display the following acknowledgement:
46  *	This product includes software developed by the University of
47  *	California, Berkeley and its contributors.
48  * 4. Neither the name of the University nor the names of its contributors
49  *    may be used to endorse or promote products derived from this software
50  *    without specific prior written permission.
51  *
52  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
53  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
54  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
55  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
56  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
57  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
58  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
59  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
60  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
61  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
62  * SUCH DAMAGE.
63  *
64  *	@(#)cdefs.h	8.8 (Berkeley) 1/9/95
65  */
66 
67 #ifndef _CDEFS_H_
68 #define _CDEFS_H_
69 
70 #if defined(__cplusplus)
71 #define __BEGIN_DECLS   extern "C" {
72 #define __END_DECLS     }
73 #else
74 #define __BEGIN_DECLS
75 #define __END_DECLS
76 #endif
77 
78 /* This SDK is designed to work with clang and specific versions of
79  * gcc >= 4.0 with Apple's patch sets */
80 #if !defined(__GNUC__) || __GNUC__ < 4
81 #warning "Unsupported compiler detected"
82 #endif
83 
84 /*
85  * Compatibility with compilers and environments that don't support compiler
86  * feature checking function-like macros.
87  */
88 #ifndef __has_builtin
89 #define __has_builtin(x) 0
90 #endif
91 #ifndef __has_include
92 #define __has_include(x) 0
93 #endif
94 #ifndef __has_feature
95 #define __has_feature(x) 0
96 #endif
97 #ifndef __has_attribute
98 #define __has_attribute(x) 0
99 #endif
100 #ifndef __has_extension
101 #define __has_extension(x) 0
102 #endif
103 
104 /*
105  * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
106  * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
107  * The __CONCAT macro is a bit tricky -- make sure you don't put spaces
108  * in between its arguments.  __CONCAT can also concatenate double-quoted
109  * strings produced by the __STRING macro, but this only works with ANSI C.
110  */
111 #if defined(__STDC__) || defined(__cplusplus)
112 #define __P(protos)     protos          /* full-blown ANSI C */
113 #define __CONCAT(x, y)   x ## y
114 #define __STRING(x)     #x
115 
116 #define __const         const           /* define reserved names to standard */
117 #define __signed        signed
118 #define __volatile      volatile
119 #if defined(__cplusplus)
120 #define __inline        inline          /* convert to C++ keyword */
121 #else
122 #ifndef __GNUC__
123 #define __inline                        /* delete GCC keyword */
124 #endif /* !__GNUC__ */
125 #endif /* !__cplusplus */
126 
127 #else   /* !(__STDC__ || __cplusplus) */
128 #define __P(protos)     ()              /* traditional C preprocessor */
129 #define __CONCAT(x, y)   x /**/ y
130 #define __STRING(x)     "x"
131 
132 #ifndef __GNUC__
133 #define __const                         /* delete pseudo-ANSI C keywords */
134 #define __inline
135 #define __signed
136 #define __volatile
137 #endif  /* !__GNUC__ */
138 
139 /*
140  * In non-ANSI C environments, new programs will want ANSI-only C keywords
141  * deleted from the program and old programs will want them left alone.
142  * When using a compiler other than gcc, programs using the ANSI C keywords
143  * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
144  * When using "gcc -traditional", we assume that this is the intent; if
145  * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
146  */
147 #ifndef NO_ANSI_KEYWORDS
148 #define const           __const                 /* convert ANSI C keywords */
149 #define inline          __inline
150 #define signed          __signed
151 #define volatile        __volatile
152 #endif /* !NO_ANSI_KEYWORDS */
153 #endif /* !(__STDC__ || __cplusplus) */
154 
155 /*
156  * __pure2 can be used for functions that are only a function of their scalar
157  * arguments (meaning they can't dereference pointers).
158  *
159  * __stateful_pure can be used for functions that have no side effects,
160  * but depend on the state of the memory.
161  */
162 #define __dead2         __attribute__((__noreturn__))
163 #define __pure2         __attribute__((__const__))
164 #define __stateful_pure __attribute__((__pure__))
165 
166 /* __unused denotes variables and functions that may not be used, preventing
167  * the compiler from warning about it if not used.
168  */
169 #define __unused        __attribute__((__unused__))
170 
171 /* __used forces variables and functions to be included even if it appears
172  * to the compiler that they are not used (and would thust be discarded).
173  */
174 #define __used          __attribute__((__used__))
175 
176 /* __cold marks code used for debugging or that is rarely taken
177  * and tells the compiler to optimize for size and outline code.
178  */
179 #if __has_attribute(cold)
180 #define __cold          __attribute__((__cold__))
181 #else
182 #define __cold
183 #endif
184 
185 /* __exported denotes symbols that should be exported even when symbols
186  * are hidden by default.
187  * __exported_push/_exported_pop are pragmas used to delimit a range of
188  *  symbols that should be exported even when symbols are hidden by default.
189  */
190 #define __exported      __attribute__((__visibility__("default")))
191 #define __exported_push _Pragma("GCC visibility push(default)")
192 #define __exported_pop  _Pragma("GCC visibility pop")
193 
194 /* __deprecated causes the compiler to produce a warning when encountering
195  * code using the deprecated functionality.
196  * __deprecated_msg() does the same, and compilers that support it will print
197  * a message along with the deprecation warning.
198  * This may require turning on such warning with the -Wdeprecated flag.
199  * __deprecated_enum_msg() should be used on enums, and compilers that support
200  * it will print the deprecation warning.
201  * __kpi_deprecated() specifically indicates deprecation of kernel programming
202  * interfaces in Kernel.framework used by KEXTs.
203  */
204 #define __deprecated    __attribute__((__deprecated__))
205 
206 #if __has_extension(attribute_deprecated_with_message) || \
207         (defined(__GNUC__) && ((__GNUC__ >= 5) || ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 5))))
208 	#define __deprecated_msg(_msg) __attribute__((__deprecated__(_msg)))
209 #else
210 	#define __deprecated_msg(_msg) __attribute__((__deprecated__))
211 #endif
212 
213 #if __has_extension(enumerator_attributes)
214 	#define __deprecated_enum_msg(_msg) __deprecated_msg(_msg)
215 #else
216 	#define __deprecated_enum_msg(_msg)
217 #endif
218 
219 #if defined(KERNEL) && !defined(KERNEL_PRIVATE)
220 #define __kpi_deprecated(_msg) __deprecated_msg(_msg)
221 #else /* !defined(KERNEL) || defined(KERNEL_PRIVATE) */
222 #define __kpi_deprecated(_msg)
223 #endif /* !defined(KERNEL) || defined(KERNEL_PRIVATE) */
224 
225 /* __unavailable causes the compiler to error out when encountering
226  * code using the tagged function
227  */
228 #if __has_attribute(unavailable)
229 #define __unavailable __attribute__((__unavailable__))
230 #else
231 #define __unavailable
232 #endif
233 
234 #if defined(KERNEL) && !defined(KERNEL_PRIVATE)
235 #define __kpi_unavailable __unavailable
236 #else /* !defined(KERNEL) || defined(KERNEL_PRIVATE) */
237 #define __kpi_unavailable
238 #endif /* !defined(KERNEL) || defined(KERNEL_PRIVATE) */
239 
240 #if XNU_KERNEL_PRIVATE
241 /* This macro is meant to be used for kpi deprecated to x86 3rd parties
242  * but should be marked as unavailable for arm macOS devices.
243  * XNU:                         nothing (API is still available)
244  * 1st party kexts:             __deprecated
245  * 3rd party kexts macOS x86:   __deprecated
246  * 3rd party kexts macOS arm:   __unavailable
247  */
248 #define __kpi_deprecated_arm64_macos_unavailable
249 #elif !KERNEL || !PLATFORM_MacOSX
250 #define __kpi_deprecated_arm64_macos_unavailable
251 #elif KERNEL_PRIVATE
252 #define __kpi_deprecated_arm64_macos_unavailable __deprecated
253 #elif defined(__arm64__)
254 #define __kpi_deprecated_arm64_macos_unavailable __unavailable
255 #else
256 #define __kpi_deprecated_arm64_macos_unavailable __deprecated
257 #endif /* XNU_KERNEL_PRIVATE */
258 
259 /* Delete pseudo-keywords wherever they are not available or needed. */
260 #ifndef __dead
261 #define __dead
262 #define __pure
263 #endif
264 
265 /*
266  * We use `__restrict' as a way to define the `restrict' type qualifier
267  * without disturbing older software that is unaware of C99 keywords.
268  */
269 #if __STDC_VERSION__ < 199901
270 #define __restrict
271 #else
272 #define __restrict      restrict
273 #endif
274 
275 /* Compatibility with compilers and environments that don't support the
276  * nullability feature.
277  */
278 
279 #if !__has_feature(nullability)
280 #ifndef __nullable
281 #define __nullable
282 #endif
283 #ifndef __nonnull
284 #define __nonnull
285 #endif
286 #ifndef __null_unspecified
287 #define __null_unspecified
288 #endif
289 #ifndef _Nullable
290 #define _Nullable
291 #endif
292 #ifndef _Nonnull
293 #define _Nonnull
294 #endif
295 #ifndef _Null_unspecified
296 #define _Null_unspecified
297 #endif
298 #endif
299 
300 /*
301  * __disable_tail_calls causes the compiler to not perform tail call
302  * optimization inside the marked function.
303  */
304 #if __has_attribute(disable_tail_calls)
305 #define __disable_tail_calls    __attribute__((__disable_tail_calls__))
306 #else
307 #define __disable_tail_calls
308 #endif
309 
310 /*
311  * __not_tail_called causes the compiler to prevent tail call optimization
312  * on statically bound calls to the function.  It has no effect on indirect
313  * calls.  Virtual functions, objective-c methods, and functions marked as
314  * "always_inline" cannot be marked as __not_tail_called.
315  */
316 #if __has_attribute(not_tail_called)
317 #define __not_tail_called       __attribute__((__not_tail_called__))
318 #else
319 #define __not_tail_called
320 #endif
321 
322 /*
323  * __result_use_check warns callers of a function that not using the function
324  * return value is a bug, i.e. dismissing malloc() return value results in a
325  * memory leak.
326  */
327 #if __has_attribute(warn_unused_result)
328 #define __result_use_check __attribute__((__warn_unused_result__))
329 #else
330 #define __result_use_check
331 #endif
332 
333 /*
334  * __swift_unavailable causes the compiler to mark a symbol as specifically
335  * unavailable in Swift, regardless of any other availability in C.
336  */
337 #if __has_feature(attribute_availability_swift)
338 #define __swift_unavailable(_msg)       __attribute__((__availability__(swift, unavailable, message=_msg)))
339 #else
340 #define __swift_unavailable(_msg)
341 #endif
342 
343 /*
344  * __abortlike is the attribute to put on functions like abort() that are
345  * typically used to mark assertions. These optimize the codegen
346  * for outlining while still maintaining debugability.
347  */
348 #ifndef __abortlike
349 #define __abortlike __dead2 __cold __not_tail_called
350 #endif
351 
352 /* Declaring inline functions within headers is error-prone due to differences
353  * across various versions of the C language and extensions.  __header_inline
354  * can be used to declare inline functions within system headers.  In cases
355  * where you want to force inlining instead of letting the compiler make
356  * the decision, you can use __header_always_inline.
357  *
358  * Be aware that using inline for functions which compilers may also provide
359  * builtins can behave differently under various compilers.  If you intend to
360  * provide an inline version of such a function, you may want to use a macro
361  * instead.
362  *
363  * The check for !__GNUC__ || __clang__ is because gcc doesn't correctly
364  * support c99 inline in some cases:
365  * http://gcc.gnu.org/bugzilla/show_bug.cgi?id=55965
366  */
367 
368 #if defined(__cplusplus) || \
369         (__STDC_VERSION__ >= 199901L && \
370         !defined(__GNUC_GNU_INLINE__) && \
371         (!defined(__GNUC__) || defined(__clang__)))
372 # define __header_inline           inline
373 #elif defined(__GNUC__) && defined(__GNUC_STDC_INLINE__)
374 # define __header_inline           extern __inline __attribute__((__gnu_inline__))
375 #elif defined(__GNUC__)
376 # define __header_inline           extern __inline
377 #else
378 /* If we land here, we've encountered an unsupported compiler,
379  * so hopefully it understands static __inline as a fallback.
380  */
381 # define __header_inline           static __inline
382 #endif
383 
384 #ifdef __GNUC__
385 # define __header_always_inline    __header_inline __attribute__ ((__always_inline__))
386 #else
387 /* Unfortunately, we're using a compiler that we don't know how to force to
388  * inline.  Oh well.
389  */
390 # define __header_always_inline    __header_inline
391 #endif
392 
393 /*
394  * Compiler-dependent macros that bracket portions of code where the
395  * "-Wunreachable-code" warning should be ignored. Please use sparingly.
396  */
397 #if defined(__clang__)
398 # define __unreachable_ok_push \
399 	 _Pragma("clang diagnostic push") \
400 	 _Pragma("clang diagnostic ignored \"-Wunreachable-code\"")
401 # define __unreachable_ok_pop \
402 	 _Pragma("clang diagnostic pop")
403 #elif defined(__GNUC__) && ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
404 # define __unreachable_ok_push \
405 	 _Pragma("GCC diagnostic push") \
406 	 _Pragma("GCC diagnostic ignored \"-Wunreachable-code\"")
407 # define __unreachable_ok_pop \
408 	 _Pragma("GCC diagnostic pop")
409 #else
410 # define __unreachable_ok_push
411 # define __unreachable_ok_pop
412 #endif
413 
414 /*
415  * Compiler-dependent macros to declare that functions take printf-like
416  * or scanf-like arguments.  They are null except for versions of gcc
417  * that are known to support the features properly.  Functions declared
418  * with these attributes will cause compilation warnings if there is a
419  * mismatch between the format string and subsequent function parameter
420  * types.
421  */
422 #define __printflike(fmtarg, firstvararg) \
423 	__attribute__((__format__ (__printf__, fmtarg, firstvararg)))
424 #define __printf0like(fmtarg, firstvararg) \
425 	__attribute__((__format__ (__printf0__, fmtarg, firstvararg)))
426 #define __scanflike(fmtarg, firstvararg) \
427 	__attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
428 #define __osloglike(fmtarg, firstvararg) \
429 	__attribute__((__format__ (__os_log__, fmtarg, firstvararg)))
430 
431 #define __IDSTRING(name, string) static const char name[] __used = string
432 
433 #ifndef __COPYRIGHT
434 #define __COPYRIGHT(s) __IDSTRING(copyright,s)
435 #endif
436 
437 #ifndef __RCSID
438 #define __RCSID(s) __IDSTRING(rcsid,s)
439 #endif
440 
441 #ifndef __SCCSID
442 #define __SCCSID(s) __IDSTRING(sccsid,s)
443 #endif
444 
445 #ifndef __PROJECT_VERSION
446 #define __PROJECT_VERSION(s) __IDSTRING(project_version,s)
447 #endif
448 
449 /* Source compatibility only, ID string not emitted in object file */
450 #ifndef __FBSDID
451 #define __FBSDID(s)
452 #endif
453 
454 #ifndef __DECONST
455 #define __DECONST(type, var)    __CAST_AWAY_QUALIFIER(var, const, type)
456 #endif
457 
458 #ifndef __DEVOLATILE
459 #define __DEVOLATILE(type, var) __CAST_AWAY_QUALIFIER(var, volatile, type)
460 #endif
461 
462 #ifndef __DEQUALIFY
463 #define __DEQUALIFY(type, var)  __CAST_AWAY_QUALIFIER(var, const volatile, type)
464 #endif
465 
466 /*
467  * __alloc_size can be used to label function arguments that represent the
468  * size of memory that the function allocates and returns. The one-argument
469  * form labels a single argument that gives the allocation size (where the
470  * arguments are numbered from 1):
471  *
472  * void	*malloc(size_t __size) __alloc_size(1);
473  *
474  * The two-argument form handles the case where the size is calculated as the
475  * product of two arguments:
476  *
477  * void	*calloc(size_t __count, size_t __size) __alloc_size(1,2);
478  */
479 #ifndef __alloc_size
480 #if __has_attribute(alloc_size)
481 #define __alloc_size(...) __attribute__((alloc_size(__VA_ARGS__)))
482 #else
483 #define __alloc_size(...)
484 #endif
485 #endif // __alloc_size
486 
487 /*
488  * COMPILATION ENVIRONMENTS -- see compat(5) for additional detail
489  *
490  * DEFAULT	By default newly complied code will get POSIX APIs plus
491  *		Apple API extensions in scope.
492  *
493  *		Most users will use this compilation environment to avoid
494  *		behavioral differences between 32 and 64 bit code.
495  *
496  * LEGACY	Defining _NONSTD_SOURCE will get pre-POSIX APIs plus Apple
497  *		API extensions in scope.
498  *
499  *		This is generally equivalent to the Tiger release compilation
500  *		environment, except that it cannot be applied to 64 bit code;
501  *		its use is discouraged.
502  *
503  *		We expect this environment to be deprecated in the future.
504  *
505  * STRICT	Defining _POSIX_C_SOURCE or _XOPEN_SOURCE restricts the
506  *		available APIs to exactly the set of APIs defined by the
507  *		corresponding standard, based on the value defined.
508  *
509  *		A correct, portable definition for _POSIX_C_SOURCE is 200112L.
510  *		A correct, portable definition for _XOPEN_SOURCE is 600L.
511  *
512  *		Apple API extensions are not visible in this environment,
513  *		which can cause Apple specific code to fail to compile,
514  *		or behave incorrectly if prototypes are not in scope or
515  *		warnings about missing prototypes are not enabled or ignored.
516  *
517  * In any compilation environment, for correct symbol resolution to occur,
518  * function prototypes must be in scope.  It is recommended that all Apple
519  * tools users add either the "-Wall" or "-Wimplicit-function-declaration"
520  * compiler flags to their projects to be warned when a function is being
521  * used without a prototype in scope.
522  */
523 
524 /* These settings are particular to each product. */
525 #ifdef KERNEL
526 #define __DARWIN_ONLY_64_BIT_INO_T      0
527 #define __DARWIN_ONLY_UNIX_CONFORMANCE  0
528 #define __DARWIN_ONLY_VERS_1050         0
529 #if defined(__x86_64__)
530 #define __DARWIN_SUF_DARWIN14   "_darwin14"
531 #define __DARWIN14_ALIAS(sym)   __asm("_" __STRING(sym) __DARWIN_SUF_DARWIN14)
532 #else
533 #define __DARWIN14_ALIAS(sym)
534 #endif
535 #else /* !KERNEL */
536 #ifdef PLATFORM_iPhoneOS
537 /* Platform: iPhoneOS */
538 #define __DARWIN_ONLY_64_BIT_INO_T      1
539 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
540 #define __DARWIN_ONLY_VERS_1050         1
541 #endif /* PLATFORM_iPhoneOS */
542 #ifdef PLATFORM_iPhoneSimulator
543 /* Platform: iPhoneSimulator */
544 #define __DARWIN_ONLY_64_BIT_INO_T      1
545 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
546 #define __DARWIN_ONLY_VERS_1050         1
547 #endif /* PLATFORM_iPhoneSimulator */
548 #ifdef PLATFORM_tvOS
549 /* Platform: tvOS */
550 #define __DARWIN_ONLY_64_BIT_INO_T      1
551 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
552 #define __DARWIN_ONLY_VERS_1050         1
553 #endif /* PLATFORM_tvOS */
554 #ifdef PLATFORM_AppleTVOS
555 /* Platform: AppleTVOS */
556 #define __DARWIN_ONLY_64_BIT_INO_T      1
557 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
558 #define __DARWIN_ONLY_VERS_1050         1
559 #endif /* PLATFORM_AppleTVOS */
560 #ifdef PLATFORM_tvSimulator
561 /* Platform: tvSimulator */
562 #define __DARWIN_ONLY_64_BIT_INO_T      1
563 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
564 #define __DARWIN_ONLY_VERS_1050         1
565 #endif /* PLATFORM_tvSimulator */
566 #ifdef PLATFORM_AppleTVSimulator
567 /* Platform: AppleTVSimulator */
568 #define __DARWIN_ONLY_64_BIT_INO_T      1
569 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
570 #define __DARWIN_ONLY_VERS_1050         1
571 #endif /* PLATFORM_AppleTVSimulator */
572 #ifdef PLATFORM_iPhoneOSNano
573 /* Platform: iPhoneOSNano */
574 #define __DARWIN_ONLY_64_BIT_INO_T      1
575 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
576 #define __DARWIN_ONLY_VERS_1050         1
577 #endif /* PLATFORM_iPhoneOSNano */
578 #ifdef PLATFORM_iPhoneNanoSimulator
579 /* Platform: iPhoneNanoSimulator */
580 #define __DARWIN_ONLY_64_BIT_INO_T      1
581 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
582 #define __DARWIN_ONLY_VERS_1050         1
583 #endif /* PLATFORM_iPhoneNanoSimulator */
584 #ifdef PLATFORM_WatchOS
585 /* Platform: WatchOS */
586 #define __DARWIN_ONLY_64_BIT_INO_T      1
587 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
588 #define __DARWIN_ONLY_VERS_1050         1
589 #endif /* PLATFORM_WatchOS */
590 #ifdef PLATFORM_WatchSimulator
591 /* Platform: WatchSimulator */
592 #define __DARWIN_ONLY_64_BIT_INO_T      1
593 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
594 #define __DARWIN_ONLY_VERS_1050         1
595 #endif /* PLATFORM_WatchSimulator */
596 #ifdef PLATFORM_BridgeOS
597 /* Platform: BridgeOS */
598 #define __DARWIN_ONLY_64_BIT_INO_T      1
599 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
600 #define __DARWIN_ONLY_VERS_1050         1
601 #endif /* PLATFORM_BridgeOS */
602 #ifdef PLATFORM_DriverKit
603 /* Platform: DriverKit */
604 #define __DARWIN_ONLY_64_BIT_INO_T      1
605 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
606 #define __DARWIN_ONLY_VERS_1050         1
607 #endif /* PLATFORM_DriverKit */
608 #ifdef PLATFORM_MacOSX
609 /* Platform: MacOSX */
610 #if defined(__i386__)
611 #define __DARWIN_ONLY_64_BIT_INO_T      0
612 #define __DARWIN_ONLY_UNIX_CONFORMANCE  0
613 #define __DARWIN_ONLY_VERS_1050         0
614 #elif defined(__x86_64__)
615 #define __DARWIN_ONLY_64_BIT_INO_T      0
616 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
617 #define __DARWIN_ONLY_VERS_1050         0
618 #else
619 #define __DARWIN_ONLY_64_BIT_INO_T      1
620 #define __DARWIN_ONLY_UNIX_CONFORMANCE  1
621 #define __DARWIN_ONLY_VERS_1050         1
622 #endif
623 #endif /* PLATFORM_MacOSX */
624 #endif /* KERNEL */
625 
626 /*
627  * The __DARWIN_ALIAS macros are used to do symbol renaming; they allow
628  * legacy code to use the old symbol, thus maintaining binary compatibility
629  * while new code can use a standards compliant version of the same function.
630  *
631  * __DARWIN_ALIAS is used by itself if the function signature has not
632  * changed, it is used along with a #ifdef check for __DARWIN_UNIX03
633  * if the signature has changed.  Because the __LP64__ environment
634  * only supports UNIX03 semantics it causes __DARWIN_UNIX03 to be
635  * defined, but causes __DARWIN_ALIAS to do no symbol mangling.
636  *
637  * As a special case, when XCode is used to target a specific version of the
638  * OS, the manifest constant __ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__
639  * will be defined by the compiler, with the digits representing major version
640  * time 100 + minor version times 10 (e.g. 10.5 := 1050).  If we are targeting
641  * pre-10.5, and it is the default compilation environment, revert the
642  * compilation environment to pre-__DARWIN_UNIX03.
643  */
644 #if !defined(__DARWIN_UNIX03)
645 #  if defined(KERNEL)
646 #    define __DARWIN_UNIX03     0
647 #  elif __DARWIN_ONLY_UNIX_CONFORMANCE
648 #    if defined(_NONSTD_SOURCE)
649 #      error "Can't define _NONSTD_SOURCE when only UNIX conformance is available."
650 #    endif /* _NONSTD_SOURCE */
651 #    define __DARWIN_UNIX03     1
652 #  elif defined(__ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__) && ((__ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ - 0) < 1040)
653 #    define __DARWIN_UNIX03     0
654 #  elif defined(_DARWIN_C_SOURCE) || defined(_XOPEN_SOURCE) || defined(_POSIX_C_SOURCE)
655 #    if defined(_NONSTD_SOURCE)
656 #      error "Can't define both _NONSTD_SOURCE and any of _DARWIN_C_SOURCE, _XOPEN_SOURCE or _POSIX_C_SOURCE."
657 #    endif /* _NONSTD_SOURCE */
658 #    define __DARWIN_UNIX03     1
659 #  elif defined(_NONSTD_SOURCE)
660 #    define __DARWIN_UNIX03     0
661 #  else /* default */
662 #    if defined(__ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__) && ((__ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ - 0) < 1050)
663 #      define __DARWIN_UNIX03   0
664 #    else /* __ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ >= 1050 */
665 #      define __DARWIN_UNIX03   1
666 #    endif /* __ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ >= 1050 */
667 #  endif /* _DARWIN_C_SOURCE || _XOPEN_SOURCE || _POSIX_C_SOURCE || __LP64__ */
668 #endif /* !__DARWIN_UNIX03 */
669 
670 #if !defined(__DARWIN_64_BIT_INO_T)
671 #  if defined(KERNEL)
672 #    define __DARWIN_64_BIT_INO_T 0
673 #  elif defined(_DARWIN_USE_64_BIT_INODE)
674 #    if defined(_DARWIN_NO_64_BIT_INODE)
675 #      error "Can't define both _DARWIN_USE_64_BIT_INODE and _DARWIN_NO_64_BIT_INODE."
676 #    endif /* _DARWIN_NO_64_BIT_INODE */
677 #    define __DARWIN_64_BIT_INO_T 1
678 #  elif defined(_DARWIN_NO_64_BIT_INODE)
679 #    if __DARWIN_ONLY_64_BIT_INO_T
680 #      error "Can't define _DARWIN_NO_64_BIT_INODE when only 64-bit inodes are available."
681 #    endif /* __DARWIN_ONLY_64_BIT_INO_T */
682 #    define __DARWIN_64_BIT_INO_T 0
683 #  else /* default */
684 #    if __DARWIN_ONLY_64_BIT_INO_T
685 #      define __DARWIN_64_BIT_INO_T 1
686 #    elif defined(__ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__) && ((__ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ - 0) < 1060) || __DARWIN_UNIX03 == 0
687 #      define __DARWIN_64_BIT_INO_T 0
688 #    else /* default */
689 #      define __DARWIN_64_BIT_INO_T 1
690 #    endif /* __DARWIN_ONLY_64_BIT_INO_T */
691 #  endif
692 #endif /* !__DARWIN_64_BIT_INO_T */
693 
694 #if !defined(__DARWIN_VERS_1050)
695 #  if defined(KERNEL)
696 #    define __DARWIN_VERS_1050 0
697 #  elif __DARWIN_ONLY_VERS_1050
698 #    define __DARWIN_VERS_1050 1
699 #  elif defined(__ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__) && ((__ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ - 0) < 1050) || __DARWIN_UNIX03 == 0
700 #    define __DARWIN_VERS_1050 0
701 #  else /* default */
702 #    define __DARWIN_VERS_1050 1
703 #  endif
704 #endif /* !__DARWIN_VERS_1050 */
705 
706 #if !defined(__DARWIN_NON_CANCELABLE)
707 #  if defined(KERNEL)
708 #    define __DARWIN_NON_CANCELABLE 0
709 #  else /* default */
710 #    define __DARWIN_NON_CANCELABLE 0
711 #  endif
712 #endif /* !__DARWIN_NON_CANCELABLE */
713 
714 /*
715  * symbol suffixes used for symbol versioning
716  */
717 #if __DARWIN_UNIX03
718 #  if __DARWIN_ONLY_UNIX_CONFORMANCE
719 #    define __DARWIN_SUF_UNIX03         /* nothing */
720 #  else /* !__DARWIN_ONLY_UNIX_CONFORMANCE */
721 #    define __DARWIN_SUF_UNIX03         "$UNIX2003"
722 #  endif /* __DARWIN_ONLY_UNIX_CONFORMANCE */
723 
724 #  if __DARWIN_64_BIT_INO_T
725 #    if __DARWIN_ONLY_64_BIT_INO_T
726 #      define __DARWIN_SUF_64_BIT_INO_T /* nothing */
727 #    else /* !__DARWIN_ONLY_64_BIT_INO_T */
728 #      define __DARWIN_SUF_64_BIT_INO_T "$INODE64"
729 #    endif /* __DARWIN_ONLY_64_BIT_INO_T */
730 #  else /* !__DARWIN_64_BIT_INO_T */
731 #    define __DARWIN_SUF_64_BIT_INO_T   /* nothing */
732 #  endif /* __DARWIN_64_BIT_INO_T */
733 
734 #  if __DARWIN_VERS_1050
735 #    if __DARWIN_ONLY_VERS_1050
736 #      define __DARWIN_SUF_1050         /* nothing */
737 #    else /* !__DARWIN_ONLY_VERS_1050 */
738 #      define __DARWIN_SUF_1050         "$1050"
739 #    endif /* __DARWIN_ONLY_VERS_1050 */
740 #  else /* !__DARWIN_VERS_1050 */
741 #    define __DARWIN_SUF_1050           /* nothing */
742 #  endif /* __DARWIN_VERS_1050 */
743 
744 #  if __DARWIN_NON_CANCELABLE
745 #    define __DARWIN_SUF_NON_CANCELABLE "$NOCANCEL"
746 #  else /* !__DARWIN_NON_CANCELABLE */
747 #    define __DARWIN_SUF_NON_CANCELABLE /* nothing */
748 #  endif /* __DARWIN_NON_CANCELABLE */
749 
750 #else /* !__DARWIN_UNIX03 */
751 #  define __DARWIN_SUF_UNIX03           /* nothing */
752 #  define __DARWIN_SUF_64_BIT_INO_T     /* nothing */
753 #  define __DARWIN_SUF_NON_CANCELABLE   /* nothing */
754 #  define __DARWIN_SUF_1050             /* nothing */
755 #endif /* __DARWIN_UNIX03 */
756 
757 #define __DARWIN_SUF_EXTSN              "$DARWIN_EXTSN"
758 
759 /*
760  * symbol versioning macros
761  */
762 #define __DARWIN_ALIAS(sym)             __asm("_" __STRING(sym) __DARWIN_SUF_UNIX03)
763 #define __DARWIN_ALIAS_C(sym)           __asm("_" __STRING(sym) __DARWIN_SUF_NON_CANCELABLE __DARWIN_SUF_UNIX03)
764 #define __DARWIN_ALIAS_I(sym)           __asm("_" __STRING(sym) __DARWIN_SUF_64_BIT_INO_T __DARWIN_SUF_UNIX03)
765 #define __DARWIN_NOCANCEL(sym)          __asm("_" __STRING(sym) __DARWIN_SUF_NON_CANCELABLE)
766 #define __DARWIN_INODE64(sym)           __asm("_" __STRING(sym) __DARWIN_SUF_64_BIT_INO_T)
767 
768 #define __DARWIN_1050(sym)              __asm("_" __STRING(sym) __DARWIN_SUF_1050)
769 #define __DARWIN_1050ALIAS(sym)         __asm("_" __STRING(sym) __DARWIN_SUF_1050 __DARWIN_SUF_UNIX03)
770 #define __DARWIN_1050ALIAS_C(sym)       __asm("_" __STRING(sym) __DARWIN_SUF_1050 __DARWIN_SUF_NON_CANCELABLE __DARWIN_SUF_UNIX03)
771 #define __DARWIN_1050ALIAS_I(sym)       __asm("_" __STRING(sym) __DARWIN_SUF_1050 __DARWIN_SUF_64_BIT_INO_T __DARWIN_SUF_UNIX03)
772 #define __DARWIN_1050INODE64(sym)       __asm("_" __STRING(sym) __DARWIN_SUF_1050 __DARWIN_SUF_64_BIT_INO_T)
773 
774 #define __DARWIN_EXTSN(sym)             __asm("_" __STRING(sym) __DARWIN_SUF_EXTSN)
775 #define __DARWIN_EXTSN_C(sym)           __asm("_" __STRING(sym) __DARWIN_SUF_EXTSN __DARWIN_SUF_NON_CANCELABLE)
776 #if XNU_KERNEL_PRIVATE
777 #define __XNU_INTERNAL(sym)             __asm("_" __STRING(sym) "$XNU_INTERNAL") __attribute__((used))
778 #endif
779 
780 /*
781  * symbol release macros
782  */
783 #ifdef KERNEL
784 #define __DARWIN_ALIAS_STARTING(_mac, _iphone, x)
785 #else
786 #include <sys/_symbol_aliasing.h>
787 
788 #if defined(__ENVIRONMENT_IPHONE_OS_VERSION_MIN_REQUIRED__)
789 #define __DARWIN_ALIAS_STARTING(_mac, _iphone, x)   __DARWIN_ALIAS_STARTING_IPHONE_##_iphone(x)
790 #elif defined(__ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__)
791 #define __DARWIN_ALIAS_STARTING(_mac, _iphone, x)   __DARWIN_ALIAS_STARTING_MAC_##_mac(x)
792 #else
793 #define __DARWIN_ALIAS_STARTING(_mac, _iphone, x)   x
794 #endif
795 #endif /* KERNEL */
796 
797 
798 /*
799  * POSIX.1 requires that the macros we test be defined before any standard
800  * header file is included.  This permits us to convert values for feature
801  * testing, as necessary, using only _POSIX_C_SOURCE.
802  *
803  * Here's a quick run-down of the versions:
804  *  defined(_POSIX_SOURCE)		1003.1-1988
805  *  _POSIX_C_SOURCE == 1L		1003.1-1990
806  *  _POSIX_C_SOURCE == 2L		1003.2-1992 C Language Binding Option
807  *  _POSIX_C_SOURCE == 199309L		1003.1b-1993
808  *  _POSIX_C_SOURCE == 199506L		1003.1c-1995, 1003.1i-1995,
809  *					and the omnibus ISO/IEC 9945-1: 1996
810  *  _POSIX_C_SOURCE == 200112L		1003.1-2001
811  *  _POSIX_C_SOURCE == 200809L		1003.1-2008
812  *
813  * In addition, the X/Open Portability Guide, which is now the Single UNIX
814  * Specification, defines a feature-test macro which indicates the version of
815  * that specification, and which subsumes _POSIX_C_SOURCE.
816  */
817 
818 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1L. */
819 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 1L
820 #undef _POSIX_C_SOURCE
821 #define _POSIX_C_SOURCE         199009L
822 #endif
823 
824 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2L. */
825 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 2L
826 #undef _POSIX_C_SOURCE
827 #define _POSIX_C_SOURCE         199209L
828 #endif
829 
830 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
831 #ifdef _XOPEN_SOURCE
832 #if _XOPEN_SOURCE - 0L >= 700L && (!defined(_POSIX_C_SOURCE) || _POSIX_C_SOURCE - 0L < 200809L)
833 #undef _POSIX_C_SOURCE
834 #define _POSIX_C_SOURCE         200809L
835 #elif _XOPEN_SOURCE - 0L >= 600L && (!defined(_POSIX_C_SOURCE) || _POSIX_C_SOURCE - 0L < 200112L)
836 #undef _POSIX_C_SOURCE
837 #define _POSIX_C_SOURCE         200112L
838 #elif _XOPEN_SOURCE - 0L >= 500L && (!defined(_POSIX_C_SOURCE) || _POSIX_C_SOURCE - 0L < 199506L)
839 #undef _POSIX_C_SOURCE
840 #define _POSIX_C_SOURCE         199506L
841 #endif
842 #endif
843 
844 /*
845  * Deal with all versions of POSIX.  The ordering relative to the tests above is
846  * important.
847  */
848 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
849 #define _POSIX_C_SOURCE         198808L
850 #endif
851 
852 /* POSIX C deprecation macros */
853 #ifdef KERNEL
854 #define __POSIX_C_DEPRECATED(ver)
855 #else
856 #include <sys/_posix_availability.h>
857 
858 #define __POSIX_C_DEPRECATED(ver) ___POSIX_C_DEPRECATED_STARTING_##ver
859 #endif
860 
861 /*
862  * Set a single macro which will always be defined and can be used to determine
863  * the appropriate namespace.  For POSIX, these values will correspond to
864  * _POSIX_C_SOURCE value.  Currently there are two additional levels corresponding
865  * to ANSI (_ANSI_SOURCE) and Darwin extensions (_DARWIN_C_SOURCE)
866  */
867 #define __DARWIN_C_ANSI         010000L
868 #define __DARWIN_C_FULL         900000L
869 
870 #if   defined(_ANSI_SOURCE)
871 #define __DARWIN_C_LEVEL        __DARWIN_C_ANSI
872 #elif defined(_POSIX_C_SOURCE) && !defined(_DARWIN_C_SOURCE) && !defined(_NONSTD_SOURCE)
873 #define __DARWIN_C_LEVEL        _POSIX_C_SOURCE
874 #else
875 #define __DARWIN_C_LEVEL        __DARWIN_C_FULL
876 #endif
877 
878 /* If the developer has neither requested a strict language mode nor a version
879  * of POSIX, turn on functionality provided by __STDC_WANT_LIB_EXT1__ as part
880  * of __DARWIN_C_FULL.
881  */
882 #if !defined(__STDC_WANT_LIB_EXT1__) && !defined(__STRICT_ANSI__) && __DARWIN_C_LEVEL >= __DARWIN_C_FULL
883 #define __STDC_WANT_LIB_EXT1__ 1
884 #endif
885 
886 /*
887  * long long is not supported in c89 (__STRICT_ANSI__), but g++ -ansi and
888  * c99 still want long longs.  While not perfect, we allow long longs for
889  * g++.
890  */
891 #if (defined(__STRICT_ANSI__) && (__STDC_VERSION__ - 0 < 199901L) && !defined(__GNUG__))
892 #define __DARWIN_NO_LONG_LONG 1
893 #else
894 #define __DARWIN_NO_LONG_LONG 0
895 #endif
896 
897 /*****************************************
898 *  Public darwin-specific feature macros
899 *****************************************/
900 
901 /*
902  * _DARWIN_FEATURE_64_BIT_INODE indicates that the ino_t type is 64-bit, and
903  * structures modified for 64-bit inodes (like struct stat) will be used.
904  */
905 #if __DARWIN_64_BIT_INO_T
906 #define _DARWIN_FEATURE_64_BIT_INODE            1
907 #endif
908 
909 /*
910  * _DARWIN_FEATURE_64_ONLY_BIT_INODE indicates that the ino_t type may only
911  * be 64-bit; there is no support for 32-bit ino_t when this macro is defined
912  * (and non-zero).  There is no struct stat64 either, as the regular
913  * struct stat will already be the 64-bit version.
914  */
915 #if __DARWIN_ONLY_64_BIT_INO_T
916 #define _DARWIN_FEATURE_ONLY_64_BIT_INODE       1
917 #endif
918 
919 /*
920  * _DARWIN_FEATURE_ONLY_VERS_1050 indicates that only those APIs updated
921  * in 10.5 exists; no pre-10.5 variants are available.
922  */
923 #if __DARWIN_ONLY_VERS_1050
924 #define _DARWIN_FEATURE_ONLY_VERS_1050          1
925 #endif
926 
927 /*
928  * _DARWIN_FEATURE_ONLY_UNIX_CONFORMANCE indicates only UNIX conforming API
929  * are available (the legacy BSD APIs are not available)
930  */
931 #if __DARWIN_ONLY_UNIX_CONFORMANCE
932 #define _DARWIN_FEATURE_ONLY_UNIX_CONFORMANCE   1
933 #endif
934 
935 /*
936  * _DARWIN_FEATURE_UNIX_CONFORMANCE indicates whether UNIX conformance is on,
937  * and specifies the conformance level (3 is SUSv3)
938  */
939 #if __DARWIN_UNIX03
940 #define _DARWIN_FEATURE_UNIX_CONFORMANCE        3
941 #endif
942 
943 #if defined(DRIVERKIT) && !defined(KERNEL)
944 /*
945  * __DRIVERKIT_LIBC__ indicates to the C++ standard library headers and
946  * similar components that only the restricted set of standard C library
947  * functionality and headers for the DriverKit userspace driver environment
948  * are available.
949  */
950 #define __DRIVERKIT_LIBC__                      1
951 #endif /* defined(DRIVERKIT) && !defined(KERNEL) */
952 
953 /*
954  * This macro casts away the qualifier from the variable
955  *
956  * Note: use at your own risk, removing qualifiers can result in
957  * catastrophic run-time failures.
958  */
959 #ifndef __CAST_AWAY_QUALIFIER
960 #define __CAST_AWAY_QUALIFIER(variable, qualifier, type)  (type) (long)(variable)
961 #endif
962 
963 /*
964  * __XNU_PRIVATE_EXTERN is a linkage decoration indicating that a symbol can be
965  * used from other compilation units, but not other libraries or executables.
966  */
967 #ifndef __XNU_PRIVATE_EXTERN
968 #define __XNU_PRIVATE_EXTERN __attribute__((visibility("hidden")))
969 #endif
970 
971 #if __has_include(<ptrcheck.h>)
972 #include <ptrcheck.h>
973 #else
974 /*
975  * We intentionally define to nothing pointer attributes which do not have an
976  * impact on the ABI. __indexable and __bidi_indexable are not defined because
977  * of the ABI incompatibility that makes the diagnostic preferable.
978  */
979 #define __has_ptrcheck 0
980 #define __single
981 #define __unsafe_indexable
982 #define __counted_by(N)
983 #define __sized_by(N)
984 #define __ended_by(E)
985 
986 /*
987  * Similarly, we intentionally define to nothing the
988  * __ptrcheck_abi_assume_single and __ptrcheck_abi_assume_unsafe_indexable
989  * macros because they do not lead to an ABI incompatibility. However, we do not
990  * define the indexable and unsafe_indexable ones because the diagnostic is
991  * better than the silent ABI break.
992  */
993 #define __ptrcheck_abi_assume_single()
994 #define __ptrcheck_abi_assume_unsafe_indexable()
995 
996 /* __unsafe_forge intrinsics are defined as regular C casts. */
997 #define __unsafe_forge_bidi_indexable(T, P, S) ((T)(P))
998 #define __unsafe_forge_single(T, P) ((T)(P))
999 
1000 /* decay operates normally; attribute is meaningless without pointer checks. */
1001 #define __array_decay_dicards_count_in_parameters
1002 #endif /* !__has_include(<ptrcheck.h>) */
1003 
1004 #define __ASSUME_PTR_ABI_SINGLE_BEGIN       __ptrcheck_abi_assume_single()
1005 #define __ASSUME_PTR_ABI_SINGLE_END         __ptrcheck_abi_assume_unsafe_indexable()
1006 
1007 #if __has_ptrcheck
1008 #define __header_indexable                  __indexable
1009 #define __header_bidi_indexable             __bidi_indexable
1010 #else
1011 #define __header_indexable
1012 #define __header_bidi_indexable
1013 #endif
1014 
1015 /*
1016  * Architecture validation for current SDK
1017  */
1018 #if !defined(__sys_cdefs_arch_unknown__) && defined(__i386__)
1019 #elif !defined(__sys_cdefs_arch_unknown__) && defined(__x86_64__)
1020 #elif !defined(__sys_cdefs_arch_unknown__) && defined(__arm__)
1021 #elif !defined(__sys_cdefs_arch_unknown__) && defined(__arm64__)
1022 #else
1023 #error Unsupported architecture
1024 #endif
1025 
1026 #ifdef XNU_KERNEL_PRIVATE
1027 /*
1028  * Selectively ignore cast alignment warnings
1029  */
1030 #define __IGNORE_WCASTALIGN(x) _Pragma("clang diagnostic push")                     \
1031 	                       _Pragma("clang diagnostic ignored \"-Wcast-align\"") \
1032 	                       x                                                    \
1033 	                       _Pragma("clang diagnostic pop")
1034 #endif
1035 
1036 #if defined(PRIVATE) || defined(KERNEL)
1037 /*
1038  * Check if __probable and __improbable have already been defined elsewhere.
1039  * These macros inform the compiler (and humans) about which branches are likely
1040  * to be taken.
1041  */
1042 #if !defined(__probable) && !defined(__improbable)
1043 #define __probable(x)   __builtin_expect(!!(x), 1)
1044 #define __improbable(x) __builtin_expect(!!(x), 0)
1045 #endif /* !defined(__probable) && !defined(__improbable) */
1046 
1047 #define __container_of(ptr, type, field) __extension__({ \
1048 	        const __typeof__(((type *)NULL)->field) *__ptr = (ptr); \
1049 	        (type *)((uintptr_t)__ptr - offsetof(type, field)); \
1050 	})
1051 
1052 #endif /* KERNEL || PRIVATE */
1053 
1054 #define __compiler_barrier() __asm__ __volatile__("" ::: "memory")
1055 
1056 #if __has_attribute(enum_extensibility)
1057 #define __enum_open __attribute__((__enum_extensibility__(open)))
1058 #define __enum_closed __attribute__((__enum_extensibility__(closed)))
1059 #else
1060 #define __enum_open
1061 #define __enum_closed
1062 #endif // __has_attribute(enum_extensibility)
1063 
1064 #if __has_attribute(flag_enum)
1065 #define __enum_options __attribute__((__flag_enum__))
1066 #else
1067 #define __enum_options
1068 #endif
1069 
1070 /*
1071  * Similar to OS_ENUM/OS_CLOSED_ENUM/OS_OPTIONS/OS_CLOSED_OPTIONS
1072  *
1073  * This provides more advanced type checking on compilers supporting
1074  * the proper extensions, even in C.
1075  */
1076 #if __has_feature(objc_fixed_enum) || __has_extension(cxx_fixed_enum) || \
1077         __has_extension(cxx_strong_enums)
1078 #define __enum_decl(_name, _type, ...) \
1079 	        typedef enum : _type __VA_ARGS__ __enum_open _name
1080 #define __enum_closed_decl(_name, _type, ...) \
1081 	        typedef enum : _type __VA_ARGS__ __enum_closed _name
1082 #define __options_decl(_name, _type, ...) \
1083 	        typedef enum : _type __VA_ARGS__ __enum_open __enum_options _name
1084 #define __options_closed_decl(_name, _type, ...) \
1085 	        typedef enum : _type __VA_ARGS__ __enum_closed __enum_options _name
1086 #else
1087 #define __enum_decl(_name, _type, ...) \
1088 	        typedef _type _name; enum __VA_ARGS__ __enum_open
1089 #define __enum_closed_decl(_name, _type, ...) \
1090 	        typedef _type _name; enum __VA_ARGS__ __enum_closed
1091 #define __options_decl(_name, _type, ...) \
1092 	        typedef _type _name; enum __VA_ARGS__ __enum_open __enum_options
1093 #define __options_closed_decl(_name, _type, ...) \
1094 	        typedef _type _name; enum __VA_ARGS__ __enum_closed __enum_options
1095 #endif
1096 
1097 #if XNU_KERNEL_PRIVATE
1098 /*
1099  * __xnu_struct_group() can be used to declare a set of fields to be grouped
1100  * together logically in order to perform safer memory operations
1101  * (assignment, zeroing, ...) on them.
1102  */
1103 #ifdef __cplusplus
1104 #define __xnu_struct_group(group_type, group_name, ...) \
1105 	struct group_type __VA_ARGS__; \
1106 	union { \
1107 	    struct __VA_ARGS__; \
1108 	    struct group_type group_name; \
1109 	}
1110 #else
1111 #define __xnu_struct_group(group_type, group_name, ...) \
1112 	union { \
1113 	    struct __VA_ARGS__; \
1114 	    struct group_type __VA_ARGS__ group_name; \
1115 	}
1116 #endif
1117 #endif /* XNU_KERNEL_PRIVATE */
1118 
1119 #if defined(KERNEL) && __has_attribute(xnu_usage_semantics)
1120 /*
1121  * These macros can be used to annotate type definitions or scalar structure
1122  * fields to inform the compiler about which semantic they have with regards
1123  * to the content of the underlying memory represented by such type or field.
1124  *
1125  * This information is used in the analysis of the types performed by the
1126  * signature based type segregation implemented in kalloc.
1127  */
1128 #define __kernel_ptr_semantics __attribute__((xnu_usage_semantics("pointer")))
1129 #define __kernel_data_semantics __attribute__((xnu_usage_semantics("data")))
1130 #define __kernel_dual_semantics __attribute__((xnu_usage_semantics("pointer", "data")))
1131 
1132 #else  /* defined(KERNEL) && __has_attribute(xnu_usage_semantics) */
1133 
1134 #define __kernel_ptr_semantics
1135 #define __kernel_data_semantics
1136 #define __kernel_dual_semantics
1137 
1138 #endif /* defined(KERNEL) && __has_attribute(xnu_usage_semantics) */
1139 
1140 #endif /* !_CDEFS_H_ */
1141