Update.
[platform/upstream/glibc.git] / include / features.h
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.
3
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.
8
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.
13
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.  */
18
19 #ifndef _FEATURES_H
20 #define _FEATURES_H     1
21
22 /* These are defined by the user (or the compiler)
23    to specify the desired environment:
24
25    __STRICT_ANSI__      ISO Standard C.
26    _ISOC9X_SOURCE       Extensions to ISO C 89 from ISO C 9x.
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.
42
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.
48
49    These are defined by this file and are used by the
50    header files to decide what to declare or define:
51
52    __USE_ISOC9X         Define ISO C 9X 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.
68
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.
73
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.  */
79
80
81 /* Undefine everything, so we get a clean slate.  */
82 #undef  __USE_ISOC9X
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
100
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
106
107 /* Always use ISO C things.  */
108 #define __USE_ANSI      1
109
110
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
118
119 /* If _GNU_SOURCE was defined by the user, turn on all the other features.  */
120 #ifdef _GNU_SOURCE
121 # undef  _ISOC9X_SOURCE
122 # define _ISOC9X_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  500
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
138
139 /* If nothing (other than _GNU_SOURCE) is defined,
140    define _BSD_SOURCE and _SVID_SOURCE.  */
141 #if (!defined __STRICT_ANSI__ && !defined _ISOC9X_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
148
149 /* This is to enable the ISO C 9x extension.  It will go away as soon
150    as this standard is officially released.  */
151 #ifdef _ISOC9X_SOURCE
152 # define __USE_ISOC9X   1
153 #endif
154
155 /* If none of the ANSI/POSIX macros are defined, use POSIX.1 and POSIX.2
156    (and IEEE Std 1003.1b-1993 unless _XOPEN_SOURCE is defined).  */
157 #if (!defined __STRICT_ANSI__ && !defined _POSIX_SOURCE && \
158      !defined _POSIX_C_SOURCE)
159 # define _POSIX_SOURCE  1
160 # if defined _XOPEN_SOURCE && (_XOPEN_SOURCE - 0) != 500
161 #  define _POSIX_C_SOURCE       2
162 # else
163 #  define _POSIX_C_SOURCE       199506L
164 # endif
165 #endif
166
167 #if defined _POSIX_SOURCE || _POSIX_C_SOURCE >= 1 || defined _XOPEN_SOURCE
168 # define __USE_POSIX    1
169 #endif
170
171 #if defined _POSIX_C_SOURCE && _POSIX_C_SOURCE >= 2 || defined _XOPEN_SOURCE
172 # define __USE_POSIX2   1
173 #endif
174
175 #if (_POSIX_C_SOURCE - 0) >= 199309L
176 # define __USE_POSIX199309      1
177 #endif
178
179 #if (_POSIX_C_SOURCE - 0) >= 199506L
180 # define __USE_POSIX199506      1
181 #endif
182
183 #ifdef  _XOPEN_SOURCE
184 # define __USE_XOPEN    1
185 # if (_XOPEN_SOURCE - 0) == 500
186 #  define __USE_XOPEN_EXTENDED  1
187 #  define __USE_UNIX98  1
188 #  undef _LARGEFILE_SOURCE
189 #  define _LARGEFILE_SOURCE     1
190 # else
191 #  ifdef _XOPEN_SOURCE_EXTENDED
192 #   define __USE_XOPEN_EXTENDED 1
193 #  endif
194 # endif
195 #endif
196
197 #ifdef _LARGEFILE_SOURCE
198 # define __USE_LARGEFILE        1
199 #endif
200
201 #ifdef _LARGEFILE64_SOURCE
202 # define __USE_LARGEFILE64      1
203 #endif
204
205 #if defined _FILE_OFFSET_BITS && _FILE_OFFSET_BITS == 64
206 # define __USE_FILE_OFFSET64    1
207 #endif
208
209 #if defined _BSD_SOURCE || defined _SVID_SOURCE
210 # define __USE_MISC     1
211 #endif
212
213 #ifdef  _BSD_SOURCE
214 # define __USE_BSD      1
215 #endif
216
217 #ifdef  _SVID_SOURCE
218 # define __USE_SVID     1
219 #endif
220
221 #ifdef  _GNU_SOURCE
222 # define __USE_GNU      1
223 #endif
224
225 #if defined _REENTRANT || defined _THREAD_SAFE
226 # define __USE_REENTRANT        1
227 #endif
228
229 /* We do support the IEC 559 math functionality, real and complex.  */
230 #define __STDC_IEC_559__                1
231 #define __STDC_IEC_559_COMPLEX__        1
232
233 /* This macro indicates that the installed library is the GNU C Library.
234    For historic reasons the value now is 6 and this will stay from now
235    on.  The use of this variable is deprecated.  Use __GLIBC__ and
236    __GLIBC_MINOR__ now (see below) when you want to test for a specific
237    GNU C library version and use the values in <gnu/lib-names.h> to get
238    the sonames of the shared libraries.  */
239 #undef  __GNU_LIBRARY__
240 #define __GNU_LIBRARY__ 6
241
242 /* Major and minor version number of the GNU C library package.  Use
243    these macros to test for features in specific releases.  */
244 #define __GLIBC__       2
245 #define __GLIBC_MINOR__ 2
246
247 /* Convenience macros to test the versions of glibc and gcc.
248    Use them like this:
249    #if __GNUC_PREREQ (2,8)
250    ... code requiring gcc 2.8 or later ...
251    #endif
252    Note - they won't work for gcc1 or glibc1, since the _MINOR macros
253    were not defined then.  */
254 #if defined __GNUC__ && defined __GNUC_MINOR__
255 # define __GNUC_PREREQ(maj, min) \
256         ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
257 #else
258 # define __GNUC_PREREQ(maj, min) 0
259 #endif
260
261 #define __GLIBC_PREREQ(maj, min) \
262         ((__GLIBC__ << 16) + __GLIBC_MINOR__ >= ((maj) << 16) + (min))
263
264 /* This is here only because every header file already includes this one.  */
265 #ifndef __ASSEMBLER__
266 #ifndef _SYS_CDEFS_H
267 # include <sys/cdefs.h>
268 #endif
269
270 /* If we don't have __REDIRECT, prototypes will be missing if
271    __USE_FILE_OFFSET64 but not __USE_LARGEFILE[64]. */
272 # if defined __USE_FILE_OFFSET64 && !defined __REDIRECT
273 #  define __USE_LARGEFILE
274 #  define __USE_LARGEFILE64
275 # endif
276
277 #endif  /* !ASSEMBLER */
278
279 /* Decide whether we can define 'extern inline' functions in headers.  */
280 #if __GNUC_PREREQ (2, 7) && defined __OPTIMIZE__ && !defined __OPTIMIZE_SIZE__
281 # define __USE_EXTERN_INLINES   1
282 #endif
283
284 /* This is here only because every header file already includes this one.  */
285 #ifndef _LIBC
286 /* Get the definitions of all the appropriate `__stub_FUNCTION' symbols.
287    <gnu/stubs.h> contains `#define __stub_FUNCTION' when FUNCTION is a stub
288    which will always return failure (and set errno to ENOSYS).
289
290    We avoid including <gnu/stubs.h> when compiling the C library itself to
291    avoid a dependency loop.  stubs.h depends on every object file.  If
292    this #include were done for the library source code, then every object
293    file would depend on stubs.h.  */
294
295 # include <gnu/stubs.h>
296 #endif
297
298 #endif  /* features.h  */