cdefs.h 13 KB

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