Update.
[glibc.git] / include / features.h
bloba3e5c142a7c1859acc6f2020a755d76c6d550691
1 /* Copyright (C) 1991,92,93,95,96,97,98,99 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Library General Public License for more details.
14 You should have received a copy of the GNU Library General Public
15 License along with the GNU C Library; see the file COPYING.LIB. If not,
16 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 Boston, MA 02111-1307, USA. */
19 #ifndef _FEATURES_H
20 #define _FEATURES_H 1
22 /* These are defined by the user (or the compiler)
23 to specify the desired environment:
25 __STRICT_ANSI__ ISO Standard C.
26 _ISOC99_SOURCE Extensions to ISO C89 from ISO C99.
27 _POSIX_SOURCE IEEE Std 1003.1.
28 _POSIX_C_SOURCE If ==1, like _POSIX_SOURCE; if >=2 add IEEE Std 1003.2;
29 if >=199309L, add IEEE Std 1003.1b-1993;
30 if >=199506L, add IEEE Std 1003.1c-1995
31 _XOPEN_SOURCE Includes POSIX and XPG things. Set to 500 if
32 Single Unix conformance is wanted.
33 _XOPEN_SOURCE_EXTENDED XPG things and X/Open Unix extensions.
34 _LARGEFILE_SOURCE Some more functions for correct standard I/O.
35 _LARGEFILE64_SOURCE Additional functionality from LFS for large files.
36 _FILE_OFFSET_BITS=N Select default filesystem interface.
37 _BSD_SOURCE ISO C, POSIX, and 4.3BSD things.
38 _SVID_SOURCE ISO C, POSIX, and SVID things.
39 _GNU_SOURCE All of the above, plus GNU extensions.
40 _REENTRANT Select additionally reentrant object.
41 _THREAD_SAFE Same as _REENTRANT, often used by other systems.
43 The `-ansi' switch to the GNU C compiler defines __STRICT_ANSI__.
44 If none of these are defined, the default is all but _GNU_SOURCE.
45 If more than one of these are defined, they accumulate.
46 For example __STRICT_ANSI__, _POSIX_SOURCE and _POSIX_C_SOURCE
47 together give you ISO C, 1003.1, and 1003.2, but nothing else.
49 These are defined by this file and are used by the
50 header files to decide what to declare or define:
52 __USE_ISOC99 Define ISO C99 things.
53 __USE_POSIX Define IEEE Std 1003.1 things.
54 __USE_POSIX2 Define IEEE Std 1003.2 things.
55 __USE_POSIX199309 Define IEEE Std 1003.1, and .1b things.
56 __USE_POSIX199506 Define IEEE Std 1003.1, .1b, .1c and .1i things.
57 __USE_XOPEN Define XPG things.
58 __USE_XOPEN_EXTENDED Define X/Open Unix things.
59 __USE_UNIX98 Define Single Unix V2 things.
60 __USE_LARGEFILE64 Define LFS things with separate names.
61 __USE_FILE_OFFSET64 Define 64bit interface as default.
62 __USE_BSD Define 4.3BSD things.
63 __USE_SVID Define SVID things.
64 __USE_MISC Define things common to BSD and System V Unix.
65 __USE_GNU Define GNU extensions.
66 __USE_REENTRANT Define reentrant/thread-safe *_r functions.
67 __FAVOR_BSD Favor 4.3BSD things in cases of conflict.
69 The macros `__GNU_LIBRARY__', `__GLIBC__', and `__GLIBC_MINOR__' are
70 defined by this file unconditionally. `__GNU_LIBRARY__' is provided
71 only for compatibility. All new code should use the other symbols
72 to test for features.
74 All macros listed above as possibly being defined by this file are
75 explicitly undefined if they are not explicitly defined.
76 Feature-test macros that are not defined by the user or compiler
77 but are implied by the other feature-test macros defined (or by the
78 lack of any definitions) are defined by the file. */
81 /* Undefine everything, so we get a clean slate. */
82 #undef __USE_ISOC99
83 #undef __USE_POSIX
84 #undef __USE_POSIX2
85 #undef __USE_POSIX199309
86 #undef __USE_POSIX199506
87 #undef __USE_XOPEN
88 #undef __USE_XOPEN_EXTENDED
89 #undef __USE_UNIX98
90 #undef __USE_LARGEFILE
91 #undef __USE_LARGEFILE64
92 #undef __USE_FILE_OFFSET64
93 #undef __USE_BSD
94 #undef __USE_SVID
95 #undef __USE_MISC
96 #undef __USE_GNU
97 #undef __USE_REENTRANT
98 #undef __FAVOR_BSD
99 #undef __KERNEL_STRICT_NAMES
101 /* Suppress kernel-name space pollution unless user expressedly asks
102 for it. */
103 #ifndef _LOOSE_KERNEL_NAMES
104 # define __KERNEL_STRICT_NAMES
105 #endif
107 /* Always use ISO C things. */
108 #define __USE_ANSI 1
111 /* If _BSD_SOURCE was defined by the user, favor BSD over POSIX. */
112 #if defined _BSD_SOURCE && \
113 !(defined _POSIX_SOURCE || defined _POSIX_C_SOURCE || \
114 defined _XOPEN_SOURCE || defined _XOPEN_SOURCE_EXTENDED || \
115 defined _GNU_SOURCE || defined _SVID_SOURCE)
116 # define __FAVOR_BSD 1
117 #endif
119 /* If _GNU_SOURCE was defined by the user, turn on all the other features. */
120 #ifdef _GNU_SOURCE
121 # undef _ISOC99_SOURCE
122 # define _ISOC99_SOURCE 1
123 # undef _POSIX_SOURCE
124 # define _POSIX_SOURCE 1
125 # undef _POSIX_C_SOURCE
126 # define _POSIX_C_SOURCE 199506L
127 # undef _XOPEN_SOURCE
128 # define _XOPEN_SOURCE 600
129 # undef _XOPEN_SOURCE_EXTENDED
130 # define _XOPEN_SOURCE_EXTENDED 1
131 # undef _LARGEFILE64_SOURCE
132 # define _LARGEFILE64_SOURCE 1
133 # undef _BSD_SOURCE
134 # define _BSD_SOURCE 1
135 # undef _SVID_SOURCE
136 # define _SVID_SOURCE 1
137 #endif
139 /* If nothing (other than _GNU_SOURCE) is defined,
140 define _BSD_SOURCE and _SVID_SOURCE. */
141 #if (!defined __STRICT_ANSI__ && !defined _ISOC99_SOURCE && \
142 !defined _POSIX_SOURCE && !defined _POSIX_C_SOURCE && \
143 !defined _XOPEN_SOURCE && !defined _XOPEN_SOURCE_EXTENDED && \
144 !defined _BSD_SOURCE && !defined _SVID_SOURCE)
145 # define _BSD_SOURCE 1
146 # define _SVID_SOURCE 1
147 #endif
149 /* This is to enable the ISO C99 extension. Also recognize the old macro
150 which was used prior to the standard acceptance. This macro will
151 eventually go away and the features enabled by default once the ISO C99
152 standard is widely adopted. */
153 #if defined _ISOC99_SOURCE || defined _ISOC9X_SOURCE
154 # define __USE_ISOC99 1
155 #endif
157 /* If none of the ANSI/POSIX macros are defined, use POSIX.1 and POSIX.2
158 (and IEEE Std 1003.1b-1993 unless _XOPEN_SOURCE is defined). */
159 #if (!defined __STRICT_ANSI__ && !defined _POSIX_SOURCE && \
160 !defined _POSIX_C_SOURCE)
161 # define _POSIX_SOURCE 1
162 # if defined _XOPEN_SOURCE && (_XOPEN_SOURCE - 0) != 500
163 # define _POSIX_C_SOURCE 2
164 # else
165 # define _POSIX_C_SOURCE 199506L
166 # endif
167 #endif
169 #if defined _POSIX_SOURCE || _POSIX_C_SOURCE >= 1 || defined _XOPEN_SOURCE
170 # define __USE_POSIX 1
171 #endif
173 #if defined _POSIX_C_SOURCE && _POSIX_C_SOURCE >= 2 || defined _XOPEN_SOURCE
174 # define __USE_POSIX2 1
175 #endif
177 #if (_POSIX_C_SOURCE - 0) >= 199309L
178 # define __USE_POSIX199309 1
179 #endif
181 #if (_POSIX_C_SOURCE - 0) >= 199506L
182 # define __USE_POSIX199506 1
183 #endif
185 #ifdef _XOPEN_SOURCE
186 # define __USE_XOPEN 1
187 # if (_XOPEN_SOURCE - 0) >= 500
188 # define __USE_XOPEN_EXTENDED 1
189 # define __USE_UNIX98 1
190 # undef _LARGEFILE_SOURCE
191 # define _LARGEFILE_SOURCE 1
192 # if (_XOPEN_SOURCE - 0) == 600
193 # define __USE_XOPEN2K 1
194 # endif
195 # else
196 # ifdef _XOPEN_SOURCE_EXTENDED
197 # define __USE_XOPEN_EXTENDED 1
198 # endif
199 # endif
200 #endif
202 #ifdef _LARGEFILE_SOURCE
203 # define __USE_LARGEFILE 1
204 #endif
206 #ifdef _LARGEFILE64_SOURCE
207 # define __USE_LARGEFILE64 1
208 #endif
210 #if defined _FILE_OFFSET_BITS && _FILE_OFFSET_BITS == 64
211 # define __USE_FILE_OFFSET64 1
212 #endif
214 #if defined _BSD_SOURCE || defined _SVID_SOURCE
215 # define __USE_MISC 1
216 #endif
218 #ifdef _BSD_SOURCE
219 # define __USE_BSD 1
220 #endif
222 #ifdef _SVID_SOURCE
223 # define __USE_SVID 1
224 #endif
226 #ifdef _GNU_SOURCE
227 # define __USE_GNU 1
228 #endif
230 #if defined _REENTRANT || defined _THREAD_SAFE
231 # define __USE_REENTRANT 1
232 #endif
234 /* We do support the IEC 559 math functionality, real and complex. */
235 #define __STDC_IEC_559__ 1
236 #define __STDC_IEC_559_COMPLEX__ 1
238 /* This macro indicates that the installed library is the GNU C Library.
239 For historic reasons the value now is 6 and this will stay from now
240 on. The use of this variable is deprecated. Use __GLIBC__ and
241 __GLIBC_MINOR__ now (see below) when you want to test for a specific
242 GNU C library version and use the values in <gnu/lib-names.h> to get
243 the sonames of the shared libraries. */
244 #undef __GNU_LIBRARY__
245 #define __GNU_LIBRARY__ 6
247 /* Major and minor version number of the GNU C library package. Use
248 these macros to test for features in specific releases. */
249 #define __GLIBC__ 2
250 #define __GLIBC_MINOR__ 2
252 /* Convenience macros to test the versions of glibc and gcc.
253 Use them like this:
254 #if __GNUC_PREREQ (2,8)
255 ... code requiring gcc 2.8 or later ...
256 #endif
257 Note - they won't work for gcc1 or glibc1, since the _MINOR macros
258 were not defined then. */
259 #if defined __GNUC__ && defined __GNUC_MINOR__
260 # define __GNUC_PREREQ(maj, min) \
261 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
262 #else
263 # define __GNUC_PREREQ(maj, min) 0
264 #endif
266 #define __GLIBC_PREREQ(maj, min) \
267 ((__GLIBC__ << 16) + __GLIBC_MINOR__ >= ((maj) << 16) + (min))
269 /* This is here only because every header file already includes this one. */
270 #ifndef __ASSEMBLER__
271 #ifndef _SYS_CDEFS_H
272 # include <sys/cdefs.h>
273 #endif
275 /* If we don't have __REDIRECT, prototypes will be missing if
276 __USE_FILE_OFFSET64 but not __USE_LARGEFILE[64]. */
277 # if defined __USE_FILE_OFFSET64 && !defined __REDIRECT
278 # define __USE_LARGEFILE
279 # define __USE_LARGEFILE64
280 # endif
282 #endif /* !ASSEMBLER */
284 /* Decide whether we can define 'extern inline' functions in headers. */
285 #if __GNUC_PREREQ (2, 7) && defined __OPTIMIZE__ && !defined __OPTIMIZE_SIZE__
286 # define __USE_EXTERN_INLINES 1
287 #endif
289 /* This is here only because every header file already includes this one. */
290 #ifndef _LIBC
291 /* Get the definitions of all the appropriate `__stub_FUNCTION' symbols.
292 <gnu/stubs.h> contains `#define __stub_FUNCTION' when FUNCTION is a stub
293 which will always return failure (and set errno to ENOSYS).
295 We avoid including <gnu/stubs.h> when compiling the C library itself to
296 avoid a dependency loop. stubs.h depends on every object file. If
297 this #include were done for the library source code, then every object
298 file would depend on stubs.h. */
300 # include <gnu/stubs.h>
301 #endif
303 #endif /* features.h */