6b2a4fd88188557de4232c2daf57c04accc6f5b7
[kopensolaris-gnu/glibc.git] / misc / sys / cdefs.h
1 /* Copyright (C) 1992-2001, 2002, 2004, 2005, 2006, 2007
2    Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Lesser General Public
7    License as published by the Free Software Foundation; either
8    version 2.1 of the License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Lesser General Public License for more details.
14
15    You should have received a copy of the GNU Lesser General Public
16    License along with the GNU C Library; if not, write to the Free
17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18    02111-1307 USA.  */
19
20 #ifndef _SYS_CDEFS_H
21 #define _SYS_CDEFS_H    1
22
23 /* We are almost always included from features.h. */
24 #ifndef _FEATURES_H
25 # include <features.h>
26 #endif
27
28 /* The GNU libc does not support any K&R compilers or the traditional mode
29    of ISO C compilers anymore.  Check for some of the combinations not
30    anymore supported.  */
31 #if defined __GNUC__ && !defined __STDC__
32 # error "You need a ISO C conforming compiler to use the glibc headers"
33 #endif
34
35 /* Some user header file might have defined this before.  */
36 #undef  __P
37 #undef  __PMT
38
39 #ifdef __GNUC__
40
41 /* GCC can always grok prototypes.  For C++ programs we add throw()
42    to help it optimize the function calls.  But this works only with
43    gcc 2.8.x and egcs.  For gcc 3.2 and up we even mark C functions
44    as non-throwing using a function attribute since programs can use
45    the -fexceptions options for C code as well.  */
46 # if !defined __cplusplus && __GNUC_PREREQ (3, 3)
47 #  define __THROW       __attribute__ ((__nothrow__))
48 #  define __NTH(fct)    __attribute__ ((__nothrow__)) fct
49 # else
50 #  if defined __cplusplus && __GNUC_PREREQ (2,8)
51 #   define __THROW      throw ()
52 #   define __NTH(fct)   fct throw ()
53 #  else
54 #   define __THROW
55 #   define __NTH(fct)   fct
56 #  endif
57 # endif
58
59 #else   /* Not GCC.  */
60
61 # define __inline               /* No inline functions.  */
62
63 # define __THROW
64 # define __NTH(fct)     fct
65
66 # define __const        const
67 # define __signed       signed
68 # define __volatile     volatile
69
70 #endif  /* GCC.  */
71
72 /* These two macros are not used in glibc anymore.  They are kept here
73    only because some other projects expect the macros to be defined.  */
74 #define __P(args)       args
75 #define __PMT(args)     args
76
77 /* For these things, GCC behaves the ANSI way normally,
78    and the non-ANSI way under -traditional.  */
79
80 #define __CONCAT(x,y)   x ## y
81 #define __STRING(x)     #x
82
83 /* This is not a typedef so `const __ptr_t' does the right thing.  */
84 #define __ptr_t void *
85 #define __long_double_t  long double
86
87
88 /* C++ needs to know that types and declarations are C, not C++.  */
89 #ifdef  __cplusplus
90 # define __BEGIN_DECLS  extern "C" {
91 # define __END_DECLS    }
92 #else
93 # define __BEGIN_DECLS
94 # define __END_DECLS
95 #endif
96
97
98 /* The standard library needs the functions from the ISO C90 standard
99    in the std namespace.  At the same time we want to be safe for
100    future changes and we include the ISO C99 code in the non-standard
101    namespace __c99.  The C++ wrapper header take case of adding the
102    definitions to the global namespace.  */
103 #if defined __cplusplus && defined _GLIBCPP_USE_NAMESPACES
104 # define __BEGIN_NAMESPACE_STD  namespace std {
105 # define __END_NAMESPACE_STD    }
106 # define __USING_NAMESPACE_STD(name) using std::name;
107 # define __BEGIN_NAMESPACE_C99  namespace __c99 {
108 # define __END_NAMESPACE_C99    }
109 # define __USING_NAMESPACE_C99(name) using __c99::name;
110 #else
111 /* For compatibility we do not add the declarations into any
112    namespace.  They will end up in the global namespace which is what
113    old code expects.  */
114 # define __BEGIN_NAMESPACE_STD
115 # define __END_NAMESPACE_STD
116 # define __USING_NAMESPACE_STD(name)
117 # define __BEGIN_NAMESPACE_C99
118 # define __END_NAMESPACE_C99
119 # define __USING_NAMESPACE_C99(name)
120 #endif
121
122
123 /* Support for bounded pointers.  */
124 #ifndef __BOUNDED_POINTERS__
125 # define __bounded      /* nothing */
126 # define __unbounded    /* nothing */
127 # define __ptrvalue     /* nothing */
128 #endif
129
130
131 /* Fortify support.  */
132 #define __bos(ptr) __builtin_object_size (ptr, __USE_FORTIFY_LEVEL > 1)
133 #define __bos0(ptr) __builtin_object_size (ptr, 0)
134 #define __warndecl(name, msg) extern void name (void)
135 #define __errordecl(name, msg) extern void name (void)
136
137
138 /* Support for flexible arrays.  */
139 #if __GNUC_PREREQ (2,97)
140 /* GCC 2.97 supports C99 flexible array members.  */
141 # define __flexarr      []
142 #else
143 # ifdef __GNUC__
144 #  define __flexarr     [0]
145 # else
146 #  if defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L
147 #   define __flexarr    []
148 #  else
149 /* Some other non-C99 compiler.  Approximate with [1].  */
150 #   define __flexarr    [1]
151 #  endif
152 # endif
153 #endif
154
155
156 /* __asm__ ("xyz") is used throughout the headers to rename functions
157    at the assembly language level.  This is wrapped by the __REDIRECT
158    macro, in order to support compilers that can do this some other
159    way.  When compilers don't support asm-names at all, we have to do
160    preprocessor tricks instead (which don't have exactly the right
161    semantics, but it's the best we can do).
162
163    Example:
164    int __REDIRECT(setpgrp, (__pid_t pid, __pid_t pgrp), setpgid); */
165
166 #if defined __GNUC__ && __GNUC__ >= 2
167
168 # define __REDIRECT(name, proto, alias) name proto __asm__ (__ASMNAME (#alias))
169 # ifdef __cplusplus
170 #  define __REDIRECT_NTH(name, proto, alias) \
171      name proto __THROW __asm__ (__ASMNAME (#alias))
172 # else
173 #  define __REDIRECT_NTH(name, proto, alias) \
174      name proto __asm__ (__ASMNAME (#alias)) __THROW
175 # endif
176 # define __ASMNAME(cname)  __ASMNAME2 (__USER_LABEL_PREFIX__, cname)
177 # define __ASMNAME2(prefix, cname) __STRING (prefix) cname
178
179 /*
180 #elif __SOME_OTHER_COMPILER__
181
182 # define __REDIRECT(name, proto, alias) name proto; \
183         _Pragma("let " #name " = " #alias)
184 */
185 #endif
186
187 /* GCC has various useful declarations that can be made with the
188    `__attribute__' syntax.  All of the ways we use this do fine if
189    they are omitted for compilers that don't understand it. */
190 #if !defined __GNUC__ || __GNUC__ < 2
191 # define __attribute__(xyz)     /* Ignore */
192 #endif
193
194 /* At some point during the gcc 2.96 development the `malloc' attribute
195    for functions was introduced.  We don't want to use it unconditionally
196    (although this would be possible) since it generates warnings.  */
197 #if __GNUC_PREREQ (2,96)
198 # define __attribute_malloc__ __attribute__ ((__malloc__))
199 #else
200 # define __attribute_malloc__ /* Ignore */
201 #endif
202
203 /* At some point during the gcc 2.96 development the `pure' attribute
204    for functions was introduced.  We don't want to use it unconditionally
205    (although this would be possible) since it generates warnings.  */
206 #if __GNUC_PREREQ (2,96)
207 # define __attribute_pure__ __attribute__ ((__pure__))
208 #else
209 # define __attribute_pure__ /* Ignore */
210 #endif
211
212 /* At some point during the gcc 3.1 development the `used' attribute
213    for functions was introduced.  We don't want to use it unconditionally
214    (although this would be possible) since it generates warnings.  */
215 #if __GNUC_PREREQ (3,1)
216 # define __attribute_used__ __attribute__ ((__used__))
217 # define __attribute_noinline__ __attribute__ ((__noinline__))
218 #else
219 # define __attribute_used__ __attribute__ ((__unused__))
220 # define __attribute_noinline__ /* Ignore */
221 #endif
222
223 /* gcc allows marking deprecated functions.  */
224 #if __GNUC_PREREQ (3,2)
225 # define __attribute_deprecated__ __attribute__ ((__deprecated__))
226 #else
227 # define __attribute_deprecated__ /* Ignore */
228 #endif
229
230 /* At some point during the gcc 2.8 development the `format_arg' attribute
231    for functions was introduced.  We don't want to use it unconditionally
232    (although this would be possible) since it generates warnings.
233    If several `format_arg' attributes are given for the same function, in
234    gcc-3.0 and older, all but the last one are ignored.  In newer gccs,
235    all designated arguments are considered.  */
236 #if __GNUC_PREREQ (2,8)
237 # define __attribute_format_arg__(x) __attribute__ ((__format_arg__ (x)))
238 #else
239 # define __attribute_format_arg__(x) /* Ignore */
240 #endif
241
242 /* At some point during the gcc 2.97 development the `strfmon' format
243    attribute for functions was introduced.  We don't want to use it
244    unconditionally (although this would be possible) since it
245    generates warnings.  */
246 #if __GNUC_PREREQ (2,97)
247 # define __attribute_format_strfmon__(a,b) \
248   __attribute__ ((__format__ (__strfmon__, a, b)))
249 #else
250 # define __attribute_format_strfmon__(a,b) /* Ignore */
251 #endif
252
253 /* The nonull function attribute allows to mark pointer parameters which
254    must not be NULL.  */
255 #if __GNUC_PREREQ (3,3)
256 # define __nonnull(params) __attribute__ ((__nonnull__ params))
257 #else
258 # define __nonnull(params)
259 #endif
260
261 /* If fortification mode, we warn about unused results of certain
262    function calls which can lead to problems.  */
263 #if __GNUC_PREREQ (3,4)
264 # define __attribute_warn_unused_result__ \
265    __attribute__ ((__warn_unused_result__))
266 # if __USE_FORTIFY_LEVEL > 0
267 #  define __wur __attribute_warn_unused_result__
268 # endif
269 #else
270 # define __attribute_warn_unused_result__ /* empty */
271 #endif
272 #ifndef __wur
273 # define __wur /* Ignore */
274 #endif
275
276 /* Forces a function to be always inlined.  */
277 #if __GNUC_PREREQ (3,2)
278 # define __always_inline __inline __attribute__ ((__always_inline__))
279 #else
280 # define __always_inline __inline
281 #endif
282
283 /* GCC 4.3 and above with -std=c99 or -std=gnu99 implements ISO C99
284    inline semantics, unless -fgnu89-inline is used.  */
285 #if !defined __cplusplus || __GNUC_PREREQ (4,3) \
286     || (defined __GNUC_RH_RELEASE__ && __GNUC__ == 4 \
287         && __GNUC_MINOR__ == 1 && __GNUC_PATCHLEVEL__ == 2 \
288         && __GNUC_RH_RELEASE__ >= 23)
289 # if defined __GNUC_STDC_INLINE__ || defined __cplusplus
290 #  define __extern_inline extern __inline __attribute__ ((__gnu_inline__))
291 #  define __extern_always_inline \
292   extern __always_inline __attribute__ ((__gnu_inline__))
293 # else
294 #  define __extern_inline extern __inline
295 #  define __extern_always_inline extern __always_inline
296 # endif
297 #endif
298
299 /* GCC 4.3 and above allow passing all anonymous arguments of an
300    __extern_always_inline function to some other vararg function.  */
301 #if __GNUC_PREREQ (4,3) \
302     || (defined __GNUC_RH_RELEASE__ && __GNUC__ == 4 \
303         && __GNUC_MINOR__ == 1 && __GNUC_PATCHLEVEL__ == 2 \
304         && __GNUC_RH_RELEASE__ >= 23)
305 # define __va_arg_pack() __builtin_va_arg_pack ()
306 # define __va_arg_pack_len() __builtin_va_arg_pack_len ()
307 #endif
308
309 /* It is possible to compile containing GCC extensions even if GCC is
310    run in pedantic mode if the uses are carefully marked using the
311    `__extension__' keyword.  But this is not generally available before
312    version 2.8.  */
313 #if !__GNUC_PREREQ (2,8)
314 # define __extension__          /* Ignore */
315 #endif
316
317 /* __restrict is known in EGCS 1.2 and above. */
318 #if !__GNUC_PREREQ (2,92)
319 # define __restrict     /* Ignore */
320 #endif
321
322 /* ISO C99 also allows to declare arrays as non-overlapping.  The syntax is
323      array_name[restrict]
324    GCC 3.1 supports this.  */
325 #if __GNUC_PREREQ (3,1) && !defined __GNUG__
326 # define __restrict_arr __restrict
327 #else
328 # ifdef __GNUC__
329 #  define __restrict_arr        /* Not supported in old GCC.  */
330 # else
331 #  if defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L
332 #   define __restrict_arr       restrict
333 #  else
334 /* Some other non-C99 compiler.  */
335 #   define __restrict_arr       /* Not supported.  */
336 #  endif
337 # endif
338 #endif
339
340 #include <bits/wordsize.h>
341
342 #if defined __LONG_DOUBLE_MATH_OPTIONAL && defined __NO_LONG_DOUBLE_MATH
343 # define __LDBL_COMPAT 1
344 # ifdef __REDIRECT
345 #  define __LDBL_REDIR1(name, proto, alias) __REDIRECT (name, proto, alias)
346 #  define __LDBL_REDIR(name, proto) \
347   __LDBL_REDIR1 (name, proto, __nldbl_##name)
348 #  define __LDBL_REDIR1_NTH(name, proto, alias) __REDIRECT_NTH (name, proto, alias)
349 #  define __LDBL_REDIR_NTH(name, proto) \
350   __LDBL_REDIR1_NTH (name, proto, __nldbl_##name)
351 #  define __LDBL_REDIR1_DECL(name, alias) \
352   extern __typeof (name) name __asm (__ASMNAME (#alias));
353 #  define __LDBL_REDIR_DECL(name) \
354   extern __typeof (name) name __asm (__ASMNAME ("__nldbl_" #name));
355 # endif
356 #endif
357 #if !defined __LDBL_COMPAT || !defined __REDIRECT
358 # define __LDBL_REDIR1(name, proto, alias) name proto
359 # define __LDBL_REDIR(name, proto) name proto
360 # define __LDBL_REDIR1_NTH(name, proto, alias) name proto __THROW
361 # define __LDBL_REDIR_NTH(name, proto) name proto __THROW
362 # define __LDBL_REDIR_DECL(name)
363 #endif
364
365 #endif   /* sys/cdefs.h */