add platform tweaks
[oweals/busybox.git] / include / platform.h
1 /* vi: set sw=4 ts=4: */
2 /*
3    Copyright 2006, Bernhard Reutner-Fischer
4
5    Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
6 */
7 #ifndef BB_PLATFORM_H
8 #define BB_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
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 UNUSED_PARAM __attribute__ ((__unused__))
52 #define NORETURN __attribute__ ((__noreturn__))
53 #define PACKED __attribute__ ((__packed__))
54 #define 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 DEPRECATED __attribute__ ((__deprecated__))
62 #  define UNUSED_PARAM_RESULT __attribute__ ((warn_unused_result))
63 # else
64 #  define DEPRECATED
65 #  define UNUSED_PARAM_RESULT
66 # endif
67 #else
68 # define ALWAYS_INLINE inline
69 # define NOINLINE
70 # define DEPRECATED
71 # define UNUSED_PARAM_RESULT
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
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 /* FAST_FUNC is a qualifier which (possibly) makes function call faster
101  * and/or smaller by using modified ABI. It is usually only needed
102  * on non-static, busybox internal functions. Recent versions of gcc
103  * optimize statics automatically. FAST_FUNC on static is required
104  * only if you need to match a function pointer's type */
105 #if __GNUC_PREREQ(3,0) && defined(i386) /* || defined(__x86_64__)? */
106 /* stdcall makes callee to pop arguments from stack, not caller */
107 # define FAST_FUNC __attribute__((regparm(3),stdcall))
108 /* #elif ... - add your favorite arch today! */
109 #else
110 # define FAST_FUNC
111 #endif
112
113 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
114 /* (don't include system headers after this until corresponding pop!) */
115 #if __GNUC_PREREQ(4,1)
116 # define PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN _Pragma("GCC visibility push(hidden)")
117 # define POP_SAVED_FUNCTION_VISIBILITY              _Pragma("GCC visibility pop")
118 #else
119 # define PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
120 # define POP_SAVED_FUNCTION_VISIBILITY
121 #endif
122
123 /* ---- Endian Detection ------------------------------------ */
124
125 #if (defined __digital__ && defined __unix__)
126 # include <sex.h>
127 # define __BIG_ENDIAN__ (BYTE_ORDER == BIG_ENDIAN)
128 # define __BYTE_ORDER BYTE_ORDER
129 #elif !defined __APPLE__
130 # include <byteswap.h>
131 # include <endian.h>
132 #endif
133
134 #ifdef __BIG_ENDIAN__
135 # define BB_BIG_ENDIAN 1
136 # define BB_LITTLE_ENDIAN 0
137 #elif __BYTE_ORDER == __BIG_ENDIAN
138 # define BB_BIG_ENDIAN 1
139 # define BB_LITTLE_ENDIAN 0
140 #else
141 # define BB_BIG_ENDIAN 0
142 # define BB_LITTLE_ENDIAN 1
143 #endif
144
145 /* SWAP_LEnn means "convert CPU<->little_endian by swapping bytes" */
146 #if BB_BIG_ENDIAN
147 # define SWAP_BE16(x) (x)
148 # define SWAP_BE32(x) (x)
149 # define SWAP_BE64(x) (x)
150 # define SWAP_LE16(x) bswap_16(x)
151 # define SWAP_LE32(x) bswap_32(x)
152 # define SWAP_LE64(x) bswap_64(x)
153 #else
154 # define SWAP_BE16(x) bswap_16(x)
155 # define SWAP_BE32(x) bswap_32(x)
156 # define SWAP_BE64(x) bswap_64(x)
157 # define SWAP_LE16(x) (x)
158 # define SWAP_LE32(x) (x)
159 # define SWAP_LE64(x) (x)
160 #endif
161
162 /* ---- Unaligned access ------------------------------------ */
163
164 /* NB: unaligned parameter should be a pointer, aligned one -
165  * a lvalue. This makes it more likely to not swap them by mistake
166  */
167 #if defined(i386) || defined(__x86_64__)
168 # define move_from_unaligned16(v, u16p) ((v) = *(uint16_t*)(u16p))
169 # define move_from_unaligned32(v, u32p) ((v) = *(uint32_t*)(u32p))
170 # define move_to_unaligned32(u32p, v)   (*(uint32_t*)(u32p) = (v))
171 /* #elif ... - add your favorite arch today! */
172 #else
173 /* performs reasonably well (gcc usually inlines memcpy here) */
174 # define move_from_unaligned16(v, u16p) (memcpy(&(v), (u16p), 2))
175 # define move_from_unaligned32(v, u32p) (memcpy(&(v), (u32p), 4))
176 # define move_to_unaligned32(u32p, v) do { \
177         uint32_t __t = (v); \
178         memcpy((u32p), &__t, 4); \
179 } while (0)
180 #endif
181
182 /* ---- Networking ------------------------------------------ */
183
184 #ifndef __APPLE__
185 # include <arpa/inet.h>
186 # ifndef __socklen_t_defined
187 typedef int socklen_t;
188 # endif
189 #else
190 # include <netinet/in.h>
191 #endif
192
193 /* ---- Compiler dependent settings ------------------------- */
194
195 #if (defined __digital__ && defined __unix__) || defined __APPLE__
196 # undef HAVE_MNTENT_H
197 # undef HAVE_SYS_STATFS_H
198 #else
199 # define HAVE_MNTENT_H 1
200 # define HAVE_SYS_STATFS_H 1
201 #endif /* ___digital__ && __unix__ */
202
203 /* linux/loop.h relies on __u64. Make sure we have that as a proper type
204  * until userspace is widely fixed.  */
205 #if (defined __INTEL_COMPILER && !defined __GNUC__) || \
206         (defined __GNUC__ && defined __STRICT_ANSI__)
207 __extension__ typedef long long __s64;
208 __extension__ typedef unsigned long long __u64;
209 #endif
210
211 /*----- Kernel versioning ------------------------------------*/
212
213 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
214
215 /* ---- Miscellaneous --------------------------------------- */
216
217 #if defined(__GNU_LIBRARY__) && __GNU_LIBRARY__ < 5 && \
218         !defined(__dietlibc__) && \
219         !defined(_NEWLIB_VERSION) && \
220         !(defined __digital__ && defined __unix__)
221 # error "Sorry, this libc version is not supported :("
222 #endif
223
224 /* Don't perpetuate e2fsck crap into the headers.  Clean up e2fsck instead. */
225
226 #if defined __GLIBC__ || defined __UCLIBC__ \
227         || defined __dietlibc__ || defined _NEWLIB_VERSION
228 # include <features.h>
229 # define HAVE_FEATURES_H
230 # include <stdint.h>
231 # define HAVE_STDINT_H
232 #elif !defined __APPLE__
233 /* Largest integral types.  */
234 # if __BIG_ENDIAN__
235 typedef long                intmax_t;
236 typedef unsigned long       uintmax_t;
237 # else
238 __extension__
239 typedef long long           intmax_t;
240 __extension__
241 typedef unsigned long long  uintmax_t;
242 # endif
243 #endif
244
245 /* Size-saving "small" ints (arch-dependent) */
246 #if defined(i386) || defined(__x86_64__) || defined(__mips__) || defined(__cris__)
247 /* add other arches which benefit from this... */
248 typedef signed char smallint;
249 typedef unsigned char smalluint;
250 #else
251 /* for arches where byte accesses generate larger code: */
252 typedef int smallint;
253 typedef unsigned smalluint;
254 #endif
255
256 /* ISO C Standard:  7.16  Boolean type and values  <stdbool.h> */
257 #if (defined __digital__ && defined __unix__)
258 /* old system without (proper) C99 support */
259 # define bool smalluint
260 #else
261 /* modern system, so use it */
262 # include <stdbool.h>
263 #endif
264
265 /* Try to defeat gcc's alignment of "char message[]"-like data */
266 #if 1 /* if needed: !defined(arch1) && !defined(arch2) */
267 # define ALIGN1 __attribute__((aligned(1)))
268 # define ALIGN2 __attribute__((aligned(2)))
269 #else
270 /* Arches which MUST have 2 or 4 byte alignment for everything are here */
271 # define ALIGN1
272 # define ALIGN2
273 #endif
274
275
276 /* uclibc does not implement daemon() for no-mmu systems.
277  * For 0.9.29 and svn, __ARCH_USE_MMU__ indicates no-mmu reliably.
278  * For earlier versions there is no reliable way to check if we are building
279  * for a mmu-less system.
280  */
281 #if ENABLE_NOMMU || \
282     (defined __UCLIBC__ && __UCLIBC_MAJOR__ >= 0 && __UCLIBC_MINOR__ >= 9 && \
283     __UCLIBC_SUBLEVEL__ > 28 && !defined __ARCH_USE_MMU__)
284 # define BB_MMU 0
285 # define USE_FOR_NOMMU(...) __VA_ARGS__
286 # define USE_FOR_MMU(...)
287 #else
288 # define BB_MMU 1
289 # define USE_FOR_NOMMU(...)
290 # define USE_FOR_MMU(...) __VA_ARGS__
291 #endif
292
293 /* Platforms that haven't got dprintf need to implement fdprintf() in
294  * libbb.  This would require a platform.c.  It's not going to be cleaned
295  * out of the tree, so stop saying it should be. */
296 #if !defined(__dietlibc__)
297 /* Needed for: glibc */
298 /* Not needed for: dietlibc */
299 /* Others: ?? (add as needed) */
300 # define fdprintf dprintf
301 #endif
302
303 #if defined(__dietlibc__)
304 static ALWAYS_INLINE char* strchrnul(const char *s, char c)
305 {
306         while (*s && *s != c) ++s;
307         return (char*)s;
308 }
309 #endif
310
311 /* Don't use lchown with glibc older than 2.1.x ... uClibc lacks it */
312 #if (defined __GLIBC__ && __GLIBC__ <= 2 && __GLIBC_MINOR__ < 1) || \
313     defined __UC_LIBC__
314 # define lchown chown
315 #endif
316
317 #if (defined __digital__ && defined __unix__)
318
319 # include <standards.h>
320 # define HAVE_STANDARDS_H
321 # include <inttypes.h>
322 # define HAVE_INTTYPES_H
323 # define PRIu32 "u"
324 /* use legacy setpgrp(pid_t,pid_t) for now.  move to platform.c */
325 # define bb_setpgrp() do { pid_t __me = getpid(); setpgrp(__me,__me); } while (0)
326 # if !defined ADJ_OFFSET_SINGLESHOT && defined MOD_CLKA && defined MOD_OFFSET
327 #  define ADJ_OFFSET_SINGLESHOT (MOD_CLKA | MOD_OFFSET)
328 # endif
329 # if !defined ADJ_FREQUENCY && defined MOD_FREQUENCY
330 #  define ADJ_FREQUENCY MOD_FREQUENCY
331 # endif
332 # if !defined ADJ_TIMECONST && defined MOD_TIMECONST
333 #  define ADJ_TIMECONST MOD_TIMECONST
334 # endif
335 # if !defined ADJ_TICK && defined MOD_CLKB
336 #  define ADJ_TICK MOD_CLKB
337 # endif
338
339 #else /* !__digital__ */
340
341 # define bb_setpgrp() setpgrp()
342
343 #endif
344
345 #if defined(__linux__)
346 # include <sys/mount.h>
347 /* Make sure we have all the new mount flags we actually try to use. */
348 # ifndef MS_BIND
349 #  define MS_BIND        (1 << 12)
350 # endif
351 # ifndef MS_MOVE
352 #  define MS_MOVE        (1 << 13)
353 # endif
354 # ifndef MS_RECURSIVE
355 #  define MS_RECURSIVE   (1 << 14)
356 # endif
357 # ifndef MS_SILENT
358 #  define MS_SILENT      (1 << 15)
359 # endif
360 /* The shared subtree stuff, which went in around 2.6.15. */
361 # ifndef MS_UNBINDABLE
362 #  define MS_UNBINDABLE  (1 << 17)
363 # endif
364 # ifndef MS_PRIVATE
365 #  define MS_PRIVATE     (1 << 18)
366 # endif
367 # ifndef MS_SLAVE
368 #  define MS_SLAVE       (1 << 19)
369 # endif
370 # ifndef MS_SHARED
371 #  define MS_SHARED      (1 << 20)
372 # endif
373 # ifndef MS_RELATIME
374 #  define MS_RELATIME    (1 << 21)
375 # endif
376
377 # if !defined(BLKSSZGET)
378 #  define BLKSSZGET _IO(0x12, 104)
379 # endif
380 # if !defined(BLKGETSIZE64)
381 #  define BLKGETSIZE64 _IOR(0x12,114,size_t)
382 # endif
383 #endif
384
385 /* The field domainname of struct utsname is Linux specific. */
386 #if !defined(__linux__)
387 # define HAVE_NO_UTSNAME_DOMAINNAME
388 #endif
389
390 /* If this system doesn't have IUCLC bit in struct termios::c_iflag... */
391 #ifndef IUCLC
392 # define IUCLC 0
393 #endif
394
395 #endif