cdc1151ad3794aa291f26adc6002abffacdf3b0d
[platform/upstream/busybox.git] / include / platform.h
1 /* vi: set sw=4 ts=4: */
2 /*
3    Copyright 2006, Bernhard Fischer
4
5    Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
6 */
7 #ifndef __PLATFORM_H
8 #define __PLATFORM_H    1
9
10 /* Convenience macros to test the version of gcc. */
11 #undef __GNUC_PREREQ
12 #if defined __GNUC__ && defined __GNUC_MINOR__
13 # define __GNUC_PREREQ(maj, min) \
14                 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
15 #else
16 # define __GNUC_PREREQ(maj, min) 0
17 #endif
18
19 /* __restrict is known in EGCS 1.2 and above. */
20 #if !__GNUC_PREREQ(2,92)
21 # ifndef __restrict
22 #  define __restrict     /* Ignore */
23 # endif
24 #endif
25
26 /* Define macros for some gcc attributes.  This permits us to use the
27    macros freely, and know that they will come into play for the
28    version of gcc in which they are supported.  */
29
30 #if !__GNUC_PREREQ(2,7)
31 # ifndef __attribute__
32 #  define __attribute__(x)
33 # endif
34 #endif
35
36 #undef inline
37 #if defined(__STDC_VERSION__) && __STDC_VERSION__ > 199901L
38 /* it's a keyword */
39 #else
40 # if __GNUC_PREREQ(2,7)
41 #  define inline __inline__
42 # else
43 #  define inline
44 # endif
45 #endif
46
47 #ifndef __const
48 # define __const const
49 #endif
50
51 #define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
52 #define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
53 #define ATTRIBUTE_PACKED __attribute__ ((__packed__))
54 #define ATTRIBUTE_ALIGNED(m) __attribute__ ((__aligned__(m)))
55 /* __NO_INLINE__: some gcc's do not honor inlining! :( */
56 #if __GNUC_PREREQ(3,0) && !defined(__NO_INLINE__)
57 # define ALWAYS_INLINE __attribute__ ((always_inline)) inline
58 /* I've seen a toolchain where I needed __noinline__ instead of noinline */
59 # define NOINLINE      __attribute__((__noinline__))
60 # if !ENABLE_WERROR
61 #  define ATTRIBUTE_DEPRECATED __attribute__ ((__deprecated__))
62 #  define ATTRIBUTE_UNUSED_RESULT __attribute__ ((warn_unused_result))
63 # else
64 #  define ATTRIBUTE_DEPRECATED /* n/a */
65 #  define ATTRIBUTE_UNUSED_RESULT /* n/a */
66 # endif
67 #else
68 # define ALWAYS_INLINE inline /* n/a */
69 # define NOINLINE /* n/a */
70 # define ATTRIBUTE_DEPRECATED /* n/a */
71 # define ATTRIBUTE_UNUSED_RESULT /* n/a */
72 #endif
73
74 /* -fwhole-program makes all symbols local. The attribute externally_visible
75    forces a symbol global.  */
76 #if __GNUC_PREREQ(4,1)
77 # define EXTERNALLY_VISIBLE __attribute__(( visibility("default") ))
78 //__attribute__ ((__externally_visible__))
79 #else
80 # define EXTERNALLY_VISIBLE
81 #endif /* GNUC >= 4.1 */
82
83 /* We use __extension__ in some places to suppress -pedantic warnings
84    about GCC extensions.  This feature didn't work properly before
85    gcc 2.8.  */
86 #if !__GNUC_PREREQ(2,8)
87 # ifndef __extension__
88 #  define __extension__
89 # endif
90 #endif
91
92 /* gcc-2.95 had no va_copy but only __va_copy. */
93 #if !__GNUC_PREREQ(3,0)
94 # include <stdarg.h>
95 # if !defined va_copy && defined __va_copy
96 #  define va_copy(d,s) __va_copy((d),(s))
97 # endif
98 #endif
99
100 /* ---- Endian Detection ------------------------------------ */
101
102 #if (defined __digital__ && defined __unix__)
103 # include <sex.h>
104 # define __BIG_ENDIAN__ (BYTE_ORDER == BIG_ENDIAN)
105 # define __BYTE_ORDER BYTE_ORDER
106 #elif !defined __APPLE__
107 # include <byteswap.h>
108 # include <endian.h>
109 #endif
110
111 #ifdef __BIG_ENDIAN__
112 # define BB_BIG_ENDIAN 1
113 # define BB_LITTLE_ENDIAN 0
114 #elif __BYTE_ORDER == __BIG_ENDIAN
115 # define BB_BIG_ENDIAN 1
116 # define BB_LITTLE_ENDIAN 0
117 #else
118 # define BB_BIG_ENDIAN 0
119 # define BB_LITTLE_ENDIAN 1
120 #endif
121
122 #if BB_BIG_ENDIAN
123 #define SWAP_BE16(x) (x)
124 #define SWAP_BE32(x) (x)
125 #define SWAP_BE64(x) (x)
126 #define SWAP_LE16(x) bswap_16(x)
127 #define SWAP_LE32(x) bswap_32(x)
128 #define SWAP_LE64(x) bswap_64(x)
129 #else
130 #define SWAP_BE16(x) bswap_16(x)
131 #define SWAP_BE32(x) bswap_32(x)
132 #define SWAP_BE64(x) bswap_64(x)
133 #define SWAP_LE16(x) (x)
134 #define SWAP_LE32(x) (x)
135 #define SWAP_LE64(x) (x)
136 #endif
137
138 /* ---- Unaligned access ------------------------------------ */
139
140 /* parameter is supposed to be an uint32_t* ptr */
141 #if defined(i386) || defined(__x86_64__) /* + other arches? */
142 #define get_unaligned_u32p(u32p) (*(u32p))
143 #else
144 /* performs reasonably well (gcc usually inlines memcpy here) */
145 #define get_unaligned_u32p(u32p) ({ uint32_t __t; memcpy(&__t, (u32p), 4); __t; })
146 #endif
147
148 /* ---- Networking ------------------------------------------ */
149
150 #ifndef __APPLE__
151 # include <arpa/inet.h>
152 # ifndef __socklen_t_defined
153 typedef int socklen_t;
154 # endif
155 #else
156 # include <netinet/in.h>
157 #endif
158
159 /* ---- Compiler dependent settings ------------------------- */
160
161 #if (defined __digital__ && defined __unix__) || defined __APPLE__
162 # undef HAVE_MNTENT_H
163 # undef HAVE_SYS_STATFS_H
164 #else
165 # define HAVE_MNTENT_H 1
166 # define HAVE_SYS_STATFS_H 1
167 #endif /* ___digital__ && __unix__ */
168
169 /* linux/loop.h relies on __u64. Make sure we have that as a proper type
170  * until userspace is widely fixed.  */
171 #if (defined __INTEL_COMPILER && !defined __GNUC__) || \
172         (defined __GNUC__ && defined __STRICT_ANSI__)
173 __extension__ typedef __signed__ long long __s64;
174 __extension__ typedef unsigned long long __u64;
175 #endif
176
177 /*----- Kernel versioning ------------------------------------*/
178
179 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
180
181 /* ---- Miscellaneous --------------------------------------- */
182
183 #if defined(__GNU_LIBRARY__) && __GNU_LIBRARY__ < 5 && \
184         !defined(__dietlibc__) && \
185         !defined(_NEWLIB_VERSION) && \
186         !(defined __digital__ && defined __unix__)
187 # error "Sorry, this libc version is not supported :("
188 #endif
189
190 /* Don't perpetuate e2fsck crap into the headers.  Clean up e2fsck instead. */
191
192 #if defined __GLIBC__ || defined __UCLIBC__ \
193         || defined __dietlibc__ || defined _NEWLIB_VERSION
194 #include <features.h>
195 #define HAVE_FEATURES_H
196 #include <stdint.h>
197 #define HAVE_STDINT_H
198 #elif !defined __APPLE__
199 /* Largest integral types.  */
200 #if __BIG_ENDIAN__
201 typedef long                intmax_t;
202 typedef unsigned long       uintmax_t;
203 #else
204 __extension__
205 typedef long long           intmax_t;
206 __extension__
207 typedef unsigned long long  uintmax_t;
208 #endif
209 #endif
210
211 /* Size-saving "small" ints (arch-dependent) */
212 #if defined(i386) || defined(__x86_64__) || defined(__mips__) || defined(__cris__)
213 /* add other arches which benefit from this... */
214 typedef signed char smallint;
215 typedef unsigned char smalluint;
216 #else
217 /* for arches where byte accesses generate larger code: */
218 typedef int smallint;
219 typedef unsigned smalluint;
220 #endif
221
222 /* ISO C Standard:  7.16  Boolean type and values  <stdbool.h> */
223 #if (defined __digital__ && defined __unix__)
224 /* old system without (proper) C99 support */
225 #define bool smalluint
226 #else
227 /* modern system, so use it */
228 #include <stdbool.h>
229 #endif
230
231 /* Try to defeat gcc's alignment of "char message[]"-like data */
232 #if 1 /* if needed: !defined(arch1) && !defined(arch2) */
233 #define ALIGN1 __attribute__((aligned(1)))
234 #define ALIGN2 __attribute__((aligned(2)))
235 #else
236 /* Arches which MUST have 2 or 4 byte alignment for everything are here */
237 #define ALIGN1
238 #define ALIGN2
239 #endif
240
241
242 /* uclibc does not implement daemon() for no-mmu systems.
243  * For 0.9.29 and svn, __ARCH_USE_MMU__ indicates no-mmu reliably.
244  * For earlier versions there is no reliable way to check if we are building
245  * for a mmu-less system.
246  */
247 #if ENABLE_NOMMU || \
248     (defined __UCLIBC__ && __UCLIBC_MAJOR__ >= 0 && __UCLIBC_MINOR__ >= 9 && \
249     __UCLIBC_SUBLEVEL__ > 28 && !defined __ARCH_USE_MMU__)
250 #define BB_MMU 0
251 #define USE_FOR_NOMMU(...) __VA_ARGS__
252 #define USE_FOR_MMU(...)
253 #else
254 #define BB_MMU 1
255 #define USE_FOR_NOMMU(...)
256 #define USE_FOR_MMU(...) __VA_ARGS__
257 #endif
258
259 /* Platforms that haven't got dprintf need to implement fdprintf() in
260  * libbb.  This would require a platform.c.  It's not going to be cleaned
261  * out of the tree, so stop saying it should be. */
262 #if !defined(__dietlibc__)
263 /* Needed for: glibc */
264 /* Not needed for: dietlibc */
265 /* Others: ?? (add as needed) */
266 #define fdprintf dprintf
267 #endif
268
269 #if defined(__dietlibc__)
270 static ALWAYS_INLINE char* strchrnul(const char *s, char c)
271 {
272         while (*s && *s != c) ++s;
273         return (char*)s;
274 }
275 #endif
276
277 /* Don't use lchown with glibc older than 2.1.x ... uClibc lacks it */
278 #if (defined __GLIBC__ && __GLIBC__ <= 2 && __GLIBC_MINOR__ < 1) || \
279     defined __UC_LIBC__
280 # define lchown chown
281 #endif
282
283 #if (defined __digital__ && defined __unix__)
284 #include <standards.h>
285 #define HAVE_STANDARDS_H
286 #include <inttypes.h>
287 #define HAVE_INTTYPES_H
288 #define PRIu32 "u"
289
290 /* use legacy setpgrp(pid_t,pid_t) for now.  move to platform.c */
291 #define bb_setpgrp() do { pid_t __me = getpid(); setpgrp(__me,__me); } while (0)
292
293 #if !defined ADJ_OFFSET_SINGLESHOT && defined MOD_CLKA && defined MOD_OFFSET
294 #define ADJ_OFFSET_SINGLESHOT (MOD_CLKA | MOD_OFFSET)
295 #endif
296 #if !defined ADJ_FREQUENCY && defined MOD_FREQUENCY
297 #define ADJ_FREQUENCY MOD_FREQUENCY
298 #endif
299 #if !defined ADJ_TIMECONST && defined MOD_TIMECONST
300 #define ADJ_TIMECONST MOD_TIMECONST
301 #endif
302 #if !defined ADJ_TICK && defined MOD_CLKB
303 #define ADJ_TICK MOD_CLKB
304 #endif
305
306 #else
307 #define bb_setpgrp() setpgrp()
308 #endif
309
310 #if defined(__linux__)
311 #include <sys/mount.h>
312 /* Make sure we have all the new mount flags we actually try to use. */
313 #ifndef MS_BIND
314 #define MS_BIND        (1<<12)
315 #endif
316 #ifndef MS_MOVE
317 #define MS_MOVE        (1<<13)
318 #endif
319 #ifndef MS_RECURSIVE
320 #define MS_RECURSIVE   (1<<14)
321 #endif
322 #ifndef MS_SILENT
323 #define MS_SILENT      (1<<15)
324 #endif
325
326 /* The shared subtree stuff, which went in around 2.6.15. */
327 #ifndef MS_UNBINDABLE
328 #define MS_UNBINDABLE  (1<<17)
329 #endif
330 #ifndef MS_PRIVATE
331 #define MS_PRIVATE     (1<<18)
332 #endif
333 #ifndef MS_SLAVE
334 #define MS_SLAVE       (1<<19)
335 #endif
336 #ifndef MS_SHARED
337 #define MS_SHARED      (1<<20)
338 #endif
339
340
341 #if !defined(BLKSSZGET)
342 #define BLKSSZGET _IO(0x12, 104)
343 #endif
344 #if !defined(BLKGETSIZE64)
345 #define BLKGETSIZE64 _IOR(0x12,114,size_t)
346 #endif
347 #endif
348
349 #endif  /* platform.h   */