Upgrade openssh. 1/2
[dragonfly.git] / sys / sys / cdefs.h
1 /*
2  * Copyright (c) 1991, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Berkeley Software Design, Inc.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *      @(#)cdefs.h     8.8 (Berkeley) 1/9/95
33  * $FreeBSD: src/sys/sys/cdefs.h,v 1.28.2.8 2002/09/18 04:05:13 mikeh Exp $
34  */
35
36 #ifndef _SYS_CDEFS_H_
37 #define _SYS_CDEFS_H_
38
39 /*
40  * Testing against Clang-specific extensions.
41  */
42 #ifndef __has_attribute
43 #define __has_attribute(x)      0
44 #endif
45 #ifndef __has_extension
46 #define __has_extension         __has_feature
47 #endif
48 #ifndef __has_feature
49 #define __has_feature(x)        0
50 #endif
51 #ifndef __has_include
52 #define __has_include(x)        0
53 #endif
54 #ifndef __has_builtin
55 #define __has_builtin(x)        0
56 #endif
57
58 /*
59  * Macro to test if we are using a specific version of gcc or later.
60  */
61 #if defined(__GNUC__) && !defined(__INTEL_COMPILER)
62 #define __GNUC_PREREQ__(ma, mi) \
63         (__GNUC__ > (ma) || __GNUC__ == (ma) && __GNUC_MINOR__ >= (mi))
64 #else
65 #define __GNUC_PREREQ__(ma, mi) 0
66 #endif
67
68 #if defined(__cplusplus)
69 #if __GNUC_PREREQ__(4, 0)
70 #define __BEGIN_DECLS   _Pragma("GCC visibility push(default)") extern "C" {
71 #define __END_DECLS     } _Pragma("GCC visibility pop")
72 #else
73 #define __BEGIN_DECLS   extern "C" {
74 #define __END_DECLS     }
75 #endif
76 #else
77 #define __BEGIN_DECLS
78 #define __END_DECLS
79 #endif
80
81 /*
82  * The __VM_CACHELINE_SIZE macro defines the common cache line alignment
83  * size that can be found across most recent and somewhat latest Intel
84  * hardware, i.e. L1 cache sizes etc.
85  *
86  * If needed, this value can be TUNED.  Suitable values for this macro
87  * are 32, 64 and 128 bytes.  The unit of measurement for this macro is
88  * bytes.
89  *
90  * XXX: This macro and related macros will eventually move to a MD
91  * header, but currently, we do need such a hierarchy.
92  */
93 #define __VM_CACHELINE_SIZE     64
94 #define __VM_CACHELINE_MASK     (__VM_CACHELINE_SIZE - 1)
95 #define __VM_CACHELINE_ALIGN(n) \
96         (((n) + __VM_CACHELINE_MASK) & ~__VM_CACHELINE_MASK)
97
98 /*
99  * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
100  * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
101  * The __CONCAT macro is a bit tricky to use if it must work in non-ANSI
102  * mode -- there must be no spaces between its arguments, and for nested
103  * __CONCAT's, all the __CONCAT's must be at the left.  __CONCAT can also
104  * concatenate double-quoted strings produced by the __STRING macro, but
105  * this only works with ANSI C.
106  *
107  * __XSTRING is like __STRING, but it expands any macros in its argument
108  * first.  It is only available with ANSI C.
109  */
110 #if defined(__STDC__) || defined(__cplusplus)
111 #define __P(protos)     protos          /* full-blown ANSI C */
112 #define __CONCAT1(x,y)  x ## y
113 #define __CONCAT(x,y)   __CONCAT1(x,y)
114 #define __STRING(x)     #x              /* stringify without expanding x */
115 #define __XSTRING(x)    __STRING(x)     /* expand x, then stringify */
116
117 #define __const         const           /* define reserved names to standard */
118 #define __signed        signed
119 #define __volatile      volatile
120 #if defined(__cplusplus)
121 #define __inline        inline          /* convert to C++ keyword */
122 #else
123 #ifndef __GNUC__
124 #define __inline                        /* delete GCC keyword */
125 #endif /* !__GNUC__ */
126 #endif /* !__cplusplus */
127
128 #else   /* !(__STDC__ || __cplusplus) */
129 #define __P(protos)     ()              /* traditional C preprocessor */
130 #define __CONCAT(x,y)   x/**/y
131 #define __STRING(x)     "x"
132
133 #ifndef __GNUC__
134 #define __const                         /* delete pseudo-ANSI C keywords */
135 #define __inline
136 #define __signed
137 #define __volatile
138 /*
139  * In non-ANSI C environments, new programs will want ANSI-only C keywords
140  * deleted from the program and old programs will want them left alone.
141  * When using a compiler other than gcc, programs using the ANSI C keywords
142  * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
143  * When using "gcc -traditional", we assume that this is the intent; if
144  * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
145  */
146 #ifndef NO_ANSI_KEYWORDS
147 #define const                           /* delete ANSI C keywords */
148 #define inline
149 #define signed
150 #define volatile
151 #endif  /* !NO_ANSI_KEYWORDS */
152 #endif  /* !__GNUC__ */
153 #endif  /* !(__STDC__ || __cplusplus) */
154
155 /*
156  * Compiler-dependent macros to help declare dead (non-returning) and
157  * pure (no side effects) functions, and unused variables.  They are
158  * null except for versions of gcc that are known to support the features
159  * properly (old versions of gcc-2 supported the dead and pure features
160  * in a different (wrong) way).
161  */
162 #define __weak_symbol   __attribute__((__weak__))
163 #if __GNUC_PREREQ__(2, 7)
164 #define __dead2         __attribute__((__noreturn__))
165 #define __pure2         __attribute__((__const__))
166 #define __unused        __attribute__((__unused__))
167 #define __packed        __attribute__((__packed__))
168 #define __aligned(x)    __attribute__((__aligned__(x)))
169 #define __section(x)    __attribute__((__section__(x)))
170 #else
171 #define __dead2
172 #define __pure2
173 #define __unused
174 #endif
175
176 #if __GNUC_PREREQ__(2, 96)
177 #define __malloclike    __attribute__((__malloc__))
178 #define __pure          __attribute__((__pure__))
179 #else
180 #define __malloclike
181 #define __pure          __pure2
182 #endif
183
184 #if __GNUC_PREREQ__(3, 1)
185 #define __always_inline __attribute__((__always_inline__))
186 #define __noinline      __attribute__((__noinline__))
187 #else
188 #define __always_inline
189 #define __noinline
190 #endif
191
192 #if __GNUC_PREREQ__(3, 3)
193 #define __nonnull(...)  __attribute__((__nonnull__(__VA_ARGS__)))
194 #define __used          __attribute__((__used__))
195 #else
196 #define __nonnull(...)
197 #define __used          __unused
198 #endif
199
200 #if __GNUC_PREREQ__(3, 4)
201 #define __heedresult    __attribute__((__warn_unused_result__))
202 #else
203 #define __heedresult
204 #endif
205
206 #if __GNUC_PREREQ__(4, 1)
207 #define __returns_twice __attribute__((__returns_twice__))
208 #else
209 #define __returns_twice
210 #endif
211
212 #if __GNUC_PREREQ__(4, 6) || __has_builtin(__builtin_unreachable)
213 #define __unreachable() __builtin_unreachable()
214 #else
215 #define __unreachable() ((void)0)
216 #endif
217
218 #if __GNUC_PREREQ__(4, 3) || __has_attribute(__alloc_size__)
219 #define __alloc_size(x)         __attribute__((__alloc_size__(x)))
220 #define __alloc_size2(n, x)     __attribute__((__alloc_size__(n, x)))
221 #else
222 #define __alloc_size(x)
223 #define __alloc_size2(n, x)
224 #endif
225
226 #if __GNUC_PREREQ__(4, 9) || __has_attribute(__alloc_align__)
227 #define __alloc_align(x)        __attribute__((__alloc_align__(x)))
228 #else
229 #define __alloc_align(x)
230 #endif
231
232 #if !__GNUC_PREREQ__(2, 7) && __STDC_VERSION__ < 199901
233 #define __func__        NULL
234 #endif
235
236 #if (__GNUC_PREREQ__(2, 0) && !defined(__STRICT_ANSI__)) || \
237     __STDC_VERSION__ >= 199901
238 #define __LONG_LONG_SUPPORTED
239 #endif
240
241 /* C++11 exposes a load of C99 stuff */
242 #if defined(__cplusplus) && __cplusplus >= 201103L
243 #define __LONG_LONG_SUPPORTED
244 #ifndef __STDC_LIMIT_MACROS
245 #define __STDC_LIMIT_MACROS
246 #endif
247 #ifndef __STDC_CONSTANT_MACROS
248 #define __STDC_CONSTANT_MACROS
249 #endif
250 #endif
251
252 /*
253  * GCC 2.95 and later provides `__restrict' as an extension to C90 to support
254  * the C99-specific `restrict' type qualifier.  We happen to use `__restrict'
255  * as a way to define the `restrict' type qualifier without disturbing older
256  * software that is unaware of C99 keywords.
257  */
258 #if !__GNUC_PREREQ__(2, 95)
259 #if __STDC_VERSION__ < 199901
260 #define __restrict
261 #else
262 #define __restrict      restrict
263 #endif
264 #endif
265
266 /*
267  * C99 allows to declare arrays as non-overlapping.
268  */
269 #if __GNUC_PREREQ__(3, 1) && !defined(__GNUG__)
270 #define __restrict_arr  __restrict
271 #else
272 #ifdef __GNUC__
273 #define __restrict_arr
274 #else
275 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901
276 #define __restrict_arr  restrict
277 #else
278 #define __restrict_arr
279 #endif
280 #endif
281 #endif
282
283 /*
284  * GNU C version 2.96 adds explicit branch prediction so that
285  * the CPU back-end can hint the processor and also so that
286  * code blocks can be reordered such that the predicted path
287  * sees a more linear flow, thus improving cache behavior, etc.
288  *
289  * The following two macros provide us with a way to utilize this
290  * compiler feature.  Use __predict_true() if you expect the expression
291  * to evaluate to true, and __predict_false() if you expect the
292  * expression to evaluate to false.
293  *
294  * A few notes about usage:
295  *
296  *      * Generally, __predict_false() error condition checks (unless
297  *        you have some _strong_ reason to do otherwise, in which case
298  *        document it), and/or __predict_true() `no-error' condition
299  *        checks, assuming you want to optimize for the no-error case.
300  *
301  *      * Other than that, if you don't know the likelihood of a test
302  *        succeeding from empirical or other `hard' evidence, don't
303  *        make predictions.
304  *
305  *      * These are meant to be used in places that are run `a lot'.
306  *        It is wasteful to make predictions in code that is run
307  *        seldomly (e.g. at subsystem initialization time) as the
308  *        basic block reordering that this affects can often generate
309  *        larger code.
310  */
311 #if __GNUC_PREREQ__(2, 96)
312 #define __predict_true(exp)     __builtin_expect((exp), 1)
313 #define __predict_false(exp)    __builtin_expect((exp), 0)
314 #else
315 #define __predict_true(exp)     (exp)
316 #define __predict_false(exp)    (exp)
317 #endif
318
319 /*
320  * We define this here since <stddef.h>, <sys/queue.h>, and <sys/types.h>
321  * require it.
322  */
323 #if __GNUC_PREREQ__(4, 1)
324 #define __offsetof(type, field) __builtin_offsetof(type, field)
325 #else
326 #ifndef __cplusplus
327 #define __offsetof(type, field) \
328         ((__size_t)(__uintptr_t)((const volatile void *)&((type *)0)->field))
329 #else
330 #define __offsetof(type, field)                                 \
331         (__offsetof__ (reinterpret_cast <__size_t>              \
332                  (&reinterpret_cast <const volatile char &>     \
333                   (static_cast<type *> (0)->field))))
334 #endif
335 #endif
336
337 /*
338  * Compiler-dependent macros to declare that functions take printf-like
339  * or scanf-like arguments.  They are null except for versions of gcc
340  * that are known to support the features properly (old versions of gcc-2
341  * didn't permit keeping the keywords out of the application namespace).
342  *
343  * The printf0like macro for GCC 2 uses DragonFly specific compiler extensions.
344  */
345 #if !__GNUC_PREREQ__(2, 7)
346 #define __printflike(fmtarg, firstvararg)
347 #define __scanflike(fmtarg, firstvararg)
348 #define __printf0like(fmtarg, firstvararg)
349 #define __format_arg(fmtarg)
350 #define __strfmonlike(fmtarg, firstvararg)
351 #define __strftimelike(fmtarg, firstvararg)
352
353 #elif __GNUC_PREREQ__(3, 0)
354 #define __printflike(fmtarg, firstvararg) \
355             __attribute__((__nonnull__(fmtarg), \
356                           __format__ (__printf__, fmtarg, firstvararg)))
357 #define __printf0like(fmtarg, firstvararg) \
358             __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
359 #define __scanflike(fmtarg, firstvararg) \
360             __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
361 #define __format_arg(fmtarg) \
362             __attribute__((__format_arg__ (fmtarg)))
363 #define __strfmonlike(fmtarg, firstvararg) \
364             __attribute__((__format__ (__strfmon__, fmtarg, firstvararg)))
365 #define __strftimelike(fmtarg, firstvararg) \
366             __attribute__((__format__ (__strftime__, fmtarg, firstvararg)))
367
368 #else
369 #define __printflike(fmtarg, firstvararg) \
370             __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
371 #define __printf0like(fmtarg, firstvararg) \
372             __attribute__((__format__ (__printf0__, fmtarg, firstvararg)))
373 #define __scanflike(fmtarg, firstvararg) \
374             __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
375 #define __format_arg(fmtarg) \
376             __attribute__((__format_arg__ (fmtarg)))
377 #define __strfmonlike(fmtarg, firstvararg) \
378             __attribute__((__format__ (__strfmon__, fmtarg, firstvararg)))
379 #define __strftimelike(fmtarg, firstvararg) \
380             __attribute__((__format__ (__strftime__, fmtarg, firstvararg)))
381 #endif
382
383 #if !__GNUC_PREREQ__(3, 0)
384 #define __ARRAY_ZERO    0
385 #else
386 #define __ARRAY_ZERO
387 #endif
388
389 #if __GNUC_PREREQ__(4, 0)
390 #define __dso_public    __attribute__((__visibility__("default")))
391 #define __dso_hidden    __attribute__((__visibility__("hidden")))
392 #else
393 #define __dso_public
394 #define __dso_hidden
395 #endif
396
397 /*
398  * A convenient constructor macro, GCC 4.3.0 added priority support to
399  * constructors, provide a compatible interface for both.
400  */
401 #if __GNUC_PREREQ__(4, 3)
402 #define __constructor(prio)     __attribute__((constructor(prio)))
403 #else
404 #define __constructor(prio)     __attribute__((constructor))
405 #endif
406
407 /*
408  * Handy GCC based macros:
409  *
410  *      __cachealign:
411  *
412  *      The __cachealign macro can be used for cache line aligning structures
413  *      of small to medium size.  It aligns the particular structure or
414  *      storage type to a system default cache line alignment, thus giving us
415  *      a much more better cache utilization by making the hardware work at
416  *      its best burst speeds.
417  *
418  *      __usereg:
419  *
420  *      The __usereg macro can/should be used when a function contains
421  *      arguments not more than 3.  It can be very useful to us due to the
422  *      message-passing nature of the kernel.
423  *
424  * !!NOTE - USAGE INFORMATION!!
425  *
426  * The __cachealign macro should not be used for data structures that are
427  * as big struct proc, struct vnode, struct thread, and other structs which
428  * are as big as them; simply because it will be useless in that case.
429  *
430  * The __usereg macro should be used whenever possible, i.e., when a function
431  * does not exceed more than 3 arguments, and should not be used for vararg
432  * type functions.
433  *
434  * In other words, AVOID MISUSE OF THESE MACROS. :-)
435  */
436 #ifdef __GNUC__
437 #define __cachealign    __attribute__((__aligned__(__VM_CACHELINE_SIZE)))
438 #define __usereg        __attribute__((__regparm__(3)))
439 #else
440 #define __cachealign
441 #define __usereg
442 #endif
443
444 #ifdef __GNUC__
445 #define __strong_reference(sym,aliassym)        \
446         extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym)))
447 #define __weak_reference(sym,aliassym)  \
448         __strong_reference(sym,aliassym) __attribute__ ((__weak__))
449 #define __weak_reference_asm(sym,alias) \
450         __asm__(".weak " #alias);       \
451         __asm__(".equ "  #alias ", " #sym)
452 #define __warn_references(sym,msg)      \
453         __asm__(".section .gnu.warning." #sym); \
454         __asm__(".asciz \"" msg "\"");  \
455         __asm__(".previous")
456 #define __sym_compat(sym,impl,verid)    \
457         __asm__(".symver " #impl ", " #sym "@" #verid)
458 #define __sym_default(sym,impl,verid)   \
459         __asm__(".symver " #impl ", " #sym "@@@" #verid)
460 #endif  /* __GNUC__ */
461
462 #if defined(__GNUC__)
463 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"")
464 #endif
465
466 #ifndef __RCSID
467 #define __RCSID(s)              struct __hack
468 #endif
469
470 #ifndef __RCSID_SOURCE
471 #define __RCSID_SOURCE(s)       struct __hack
472 #endif
473
474 #ifndef __SCCSID
475 #define __SCCSID(s)             struct __hack
476 #endif
477
478 #ifndef __FBSDID
479 #define __FBSDID(s)             struct __hack
480 #endif
481
482 #ifndef __COPYRIGHT
483 #define __COPYRIGHT(s)          struct __hack
484 #endif
485
486 #ifndef __DECONST
487 #define __DECONST(type, var)    ((type)(__uintptr_t)(const void *)(var))
488 #endif
489
490 #ifndef __DEVOLATILE
491 #define __DEVOLATILE(type, var) ((type)(__uintptr_t)(volatile void *)(var))
492 #endif
493
494 #ifndef __DEQUALIFY
495 #define __DEQUALIFY(type, var)  ((type)(__uintptr_t)(const volatile void *)(var))
496 #endif
497
498 /*
499  * Keywords added in C11.
500  */
501
502 #if !__GNUC_PREREQ__(2, 95)
503 #define __alignof(x)    __offsetof(struct { char __a; x __b; }, __b)
504 #endif
505
506 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
507
508 #if !__has_extension(c_alignas)
509 #if (defined(__cplusplus) && __cplusplus >= 201103L) || \
510     __has_extension(cxx_alignas)
511 #define _Alignas(x)             alignas(x)
512 #else
513 /* XXX: Only emulates _Alignas(constant-expression); not _Alignas(type-name). */
514 #define _Alignas(x)             __aligned(x)
515 #endif
516 #endif
517
518 #if defined(__cplusplus) && __cplusplus >= 201103L
519 #define _Alignof(x)             alignof(x)
520 #else
521 #define _Alignof(x)             __alignof(x)
522 #endif
523
524 #if !defined(_Noreturn)
525 #define _Noreturn               __dead2
526 #endif
527
528 #if !__has_extension(c_static_assert)
529 #if (defined(__cplusplus) && __cplusplus >= 201103L) || \
530     __has_extension(cxx_static_assert)
531 #define _Static_assert(x, y)    static_assert(x, y)
532 #elif !__GNUC_PREREQ__(4, 6)
533 #define _Static_assert(x, y)    struct __hack
534 #ifdef _KERNEL
535 #define CTASSERT(x)             _CTASSERT(x, __LINE__)
536 #define _CTASSERT(x, y)         __CTASSERT(x, y)
537 #define __CTASSERT(x, y)        typedef char __assert ## y[(x) ? 1 : -1]
538 #endif
539 #endif
540
541 /*
542  * GCC 4.7 has -std=c++11 but does not support thread_local.
543  */
544 #if !__has_extension(c_thread_local)
545 #if (defined(__cplusplus) && __cplusplus >= 201103L && __GNUC_PREREQ__(4, 8)) || \
546     __has_extension(cxx_thread_local)
547 #define _Thread_local           thread_local
548 #else
549 #define _Thread_local           __thread
550 #endif
551 #endif
552 #endif
553
554 #endif /* __STDC_VERSION__ || __STDC_VERSION__ < 201112L */
555
556 #if defined(_KERNEL) && !defined(CTASSERT)
557 #define CTASSERT(x)             _Static_assert(x, \
558                                     "compile-time assertion failed")
559 #endif
560
561 /*
562  * Emulation of C11 _Generic().  Unlike the previously defined C11
563  * keywords, it is not possible to implement this using exactly the same
564  * syntax.  Therefore implement something similar under the name
565  * __generic().  Unlike _Generic(), this macro can only distinguish
566  * between a single type, so it requires nested invocations to
567  * distinguish multiple cases.
568  */
569
570 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
571 #define __generic(expr, t, yes, no)                                     \
572         _Generic(expr, t: yes, default: no)
573 #elif __GNUC_PREREQ__(3, 1) && !defined(__cplusplus)
574 #define __generic(expr, t, yes, no)                                     \
575         __builtin_choose_expr(                                          \
576             __builtin_types_compatible_p(__typeof(expr), t), yes, no)
577 #endif
578
579 /*-
580  * POSIX.1 requires that the macros we test be defined before any standard
581  * header file is included.
582  *
583  * Here's a quick run-down of the versions:
584  *  defined(_POSIX_SOURCE)              1003.1-1988
585  *  _POSIX_C_SOURCE == 1                1003.1-1990
586  *  _POSIX_C_SOURCE == 2                1003.2-1992 C Language Binding Option
587  *  _POSIX_C_SOURCE == 199309           1003.1b-1993
588  *  _POSIX_C_SOURCE == 199506           1003.1c-1995, 1003.1i-1995,
589  *                                      and the omnibus ISO/IEC 9945-1: 1996
590  *  _POSIX_C_SOURCE == 200112           1003.1-2001
591  *  _POSIX_C_SOURCE == 200809           1003.1-2008
592  *
593  * In addition, the X/Open Portability Guide, which is now the Single UNIX
594  * Specification, defines a feature-test macro which indicates the version of
595  * that specification, and which subsumes _POSIX_C_SOURCE.
596  *
597  * Our macros begin with two underscores to avoid namespace screwage.
598  */
599
600 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */
601 #if defined(_POSIX_C_SOURCE) && (_POSIX_C_SOURCE - 0) == 1
602 #undef _POSIX_C_SOURCE          /* Probably illegal, but beyond caring now. */
603 #define _POSIX_C_SOURCE         199009
604 #endif
605
606 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */
607 #if defined(_POSIX_C_SOURCE) && (_POSIX_C_SOURCE - 0) == 2
608 #undef _POSIX_C_SOURCE
609 #define _POSIX_C_SOURCE         199209
610 #endif
611
612 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
613 #ifdef _XOPEN_SOURCE
614 #if _XOPEN_SOURCE - 0 >= 700
615 #define __XSI_VISIBLE           700
616 #undef _POSIX_C_SOURCE
617 #define _POSIX_C_SOURCE         200809
618 #elif _XOPEN_SOURCE - 0 >= 600
619 #define __XSI_VISIBLE           600
620 #undef _POSIX_C_SOURCE
621 #define _POSIX_C_SOURCE         200112
622 #elif _XOPEN_SOURCE - 0 >= 500
623 #define __XSI_VISIBLE           500
624 #undef _POSIX_C_SOURCE
625 #define _POSIX_C_SOURCE         199506
626 #endif
627 #endif
628
629 /*
630  * Deal with all versions of POSIX.  The ordering relative to the tests above is
631  * important.
632  */
633 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
634 #define _POSIX_C_SOURCE         198808
635 #endif
636 #ifdef _POSIX_C_SOURCE
637 #if (_POSIX_C_SOURCE - 0) >= 200809
638 #define __POSIX_VISIBLE         200809
639 #define __ISO_C_VISIBLE         1999
640 #elif (_POSIX_C_SOURCE - 0) >= 200112
641 #define __POSIX_VISIBLE         200112
642 #define __ISO_C_VISIBLE         1999
643 #elif (_POSIX_C_SOURCE - 0) >= 199506
644 #define __POSIX_VISIBLE         199506
645 #define __ISO_C_VISIBLE         1990
646 #elif (_POSIX_C_SOURCE - 0) >= 199309
647 #define __POSIX_VISIBLE         199309
648 #define __ISO_C_VISIBLE         1990
649 #elif (_POSIX_C_SOURCE - 0) >= 199209
650 #define __POSIX_VISIBLE         199209
651 #define __ISO_C_VISIBLE         1990
652 #elif (_POSIX_C_SOURCE - 0) >= 199009
653 #define __POSIX_VISIBLE         199009
654 #define __ISO_C_VISIBLE         1990
655 #else
656 #define __POSIX_VISIBLE         198808
657 #define __ISO_C_VISIBLE         0
658 #endif /* _POSIX_C_SOURCE */
659 #else
660 /*-
661  * Deal with _ANSI_SOURCE:
662  * If it is defined, and no other compilation environment is explicitly
663  * requested, then define our internal feature-test macros to zero.  This
664  * makes no difference to the preprocessor (undefined symbols in preprocessing
665  * expressions are defined to have value zero), but makes it more convenient for
666  * a test program to print out the values.
667  *
668  * If a program mistakenly defines _ANSI_SOURCE and some other macro such as
669  * _POSIX_C_SOURCE, we will assume that it wants the broader compilation
670  * environment (and in fact we will never get here).
671  */
672 #if defined(_ANSI_SOURCE)       /* Hide almost everything. */
673 #define __POSIX_VISIBLE         0
674 #define __XSI_VISIBLE           0
675 #define __BSD_VISIBLE           0
676 #define __ISO_C_VISIBLE         1990
677 #define __EXT1_VISIBLE          0
678 #elif defined(_C99_SOURCE)      /* Localism to specify strict C99 env. */
679 #define __POSIX_VISIBLE         0
680 #define __XSI_VISIBLE           0
681 #define __BSD_VISIBLE           0
682 #define __ISO_C_VISIBLE         1999
683 #define __EXT1_VISIBLE          0
684 #elif defined(_C11_SOURCE)      /* Localism to specify strict C11 env. */
685 #define __POSIX_VISIBLE         0
686 #define __XSI_VISIBLE           0
687 #define __BSD_VISIBLE           0
688 #define __ISO_C_VISIBLE         2011
689 #define __EXT1_VISIBLE          0
690 #else                           /* Default environment: show everything. */
691 #define __POSIX_VISIBLE         200809
692 #define __XSI_VISIBLE           700
693 #define __BSD_VISIBLE           1
694 #define __ISO_C_VISIBLE         2011
695 #define __EXT1_VISIBLE          1
696 #endif
697 #endif
698
699 /* User override __EXT1_VISIBLE */
700 #if defined(__STDC_WANT_LIB_EXT1__)
701 #undef  __EXT1_VISIBLE
702 #if __STDC_WANT_LIB_EXT1__
703 #define __EXT1_VISIBLE          1
704 #else
705 #define __EXT1_VISIBLE          0
706 #endif
707 #endif /* __STDC_WANT_LIB_EXT1__ */
708
709 #ifndef __BSD_VISIBLE
710 #define __BSD_VISIBLE           0
711 #endif
712 #ifndef __EXT1_VISIBLE
713 #define __EXT1_VISIBLE          0
714 #endif
715
716 /*
717  * GLOBL macro exists to preserve __start_set_* and __stop_set_* sections
718  * of kernel modules which are discarded from binutils 2.17.50+ otherwise.
719  */
720
721 #define __GLOBL1(sym)   __asm__(".globl " #sym)
722 #define __GLOBL(sym)    __GLOBL1(sym)
723
724 #endif /* !_SYS_CDEFS_H_ */