top: don't lie in help screen about "-d 1" being valid
[oweals/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 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 /* n/a */
65 #  define UNUSED_PARAM_RESULT /* n/a */
66 # endif
67 #else
68 # define ALWAYS_INLINE inline /* n/a */
69 # define NOINLINE /* n/a */
70 # define DEPRECATED /* n/a */
71 # define UNUSED_PARAM_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 /* 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 /* ---- Endian Detection ------------------------------------ */
114
115 #if (defined __digital__ && defined __unix__)
116 # include <sex.h>
117 # define __BIG_ENDIAN__ (BYTE_ORDER == BIG_ENDIAN)
118 # define __BYTE_ORDER BYTE_ORDER
119 #elif !defined __APPLE__
120 # include <byteswap.h>
121 # include <endian.h>
122 #endif
123
124 #ifdef __BIG_ENDIAN__
125 # define BB_BIG_ENDIAN 1
126 # define BB_LITTLE_ENDIAN 0
127 #elif __BYTE_ORDER == __BIG_ENDIAN
128 # define BB_BIG_ENDIAN 1
129 # define BB_LITTLE_ENDIAN 0
130 #else
131 # define BB_BIG_ENDIAN 0
132 # define BB_LITTLE_ENDIAN 1
133 #endif
134
135 #if BB_BIG_ENDIAN
136 #define SWAP_BE16(x) (x)
137 #define SWAP_BE32(x) (x)
138 #define SWAP_BE64(x) (x)
139 #define SWAP_LE16(x) bswap_16(x)
140 #define SWAP_LE32(x) bswap_32(x)
141 #define SWAP_LE64(x) bswap_64(x)
142 #else
143 #define SWAP_BE16(x) bswap_16(x)
144 #define SWAP_BE32(x) bswap_32(x)
145 #define SWAP_BE64(x) bswap_64(x)
146 #define SWAP_LE16(x) (x)
147 #define SWAP_LE32(x) (x)
148 #define SWAP_LE64(x) (x)
149 #endif
150
151 /* ---- Unaligned access ------------------------------------ */
152
153 /* parameter is supposed to be an uint32_t* ptr */
154 #if defined(i386) || defined(__x86_64__)
155 #define get_unaligned_u32p(u32p) (*(u32p))
156 /* #elif ... - add your favorite arch today! */
157 #else
158 /* performs reasonably well (gcc usually inlines memcpy here) */
159 #define get_unaligned_u32p(u32p) ({ uint32_t __t; memcpy(&__t, (u32p), 4); __t; })
160 #endif
161
162 /* ---- Networking ------------------------------------------ */
163
164 #ifndef __APPLE__
165 # include <arpa/inet.h>
166 # ifndef __socklen_t_defined
167 typedef int socklen_t;
168 # endif
169 #else
170 # include <netinet/in.h>
171 #endif
172
173 /* ---- Compiler dependent settings ------------------------- */
174
175 #if (defined __digital__ && defined __unix__) || defined __APPLE__
176 # undef HAVE_MNTENT_H
177 # undef HAVE_SYS_STATFS_H
178 #else
179 # define HAVE_MNTENT_H 1
180 # define HAVE_SYS_STATFS_H 1
181 #endif /* ___digital__ && __unix__ */
182
183 /* linux/loop.h relies on __u64. Make sure we have that as a proper type
184  * until userspace is widely fixed.  */
185 #if (defined __INTEL_COMPILER && !defined __GNUC__) || \
186         (defined __GNUC__ && defined __STRICT_ANSI__)
187 __extension__ typedef __signed__ long long __s64;
188 __extension__ typedef unsigned long long __u64;
189 #endif
190
191 /*----- Kernel versioning ------------------------------------*/
192
193 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
194
195 /* ---- Miscellaneous --------------------------------------- */
196
197 #if defined(__GNU_LIBRARY__) && __GNU_LIBRARY__ < 5 && \
198         !defined(__dietlibc__) && \
199         !defined(_NEWLIB_VERSION) && \
200         !(defined __digital__ && defined __unix__)
201 # error "Sorry, this libc version is not supported :("
202 #endif
203
204 /* Don't perpetuate e2fsck crap into the headers.  Clean up e2fsck instead. */
205
206 #if defined __GLIBC__ || defined __UCLIBC__ \
207         || defined __dietlibc__ || defined _NEWLIB_VERSION
208 #include <features.h>
209 #define HAVE_FEATURES_H
210 #include <stdint.h>
211 #define HAVE_STDINT_H
212 #elif !defined __APPLE__
213 /* Largest integral types.  */
214 #if __BIG_ENDIAN__
215 typedef long                intmax_t;
216 typedef unsigned long       uintmax_t;
217 #else
218 __extension__
219 typedef long long           intmax_t;
220 __extension__
221 typedef unsigned long long  uintmax_t;
222 #endif
223 #endif
224
225 /* Size-saving "small" ints (arch-dependent) */
226 #if defined(i386) || defined(__x86_64__) || defined(__mips__) || defined(__cris__)
227 /* add other arches which benefit from this... */
228 typedef signed char smallint;
229 typedef unsigned char smalluint;
230 #else
231 /* for arches where byte accesses generate larger code: */
232 typedef int smallint;
233 typedef unsigned smalluint;
234 #endif
235
236 /* ISO C Standard:  7.16  Boolean type and values  <stdbool.h> */
237 #if (defined __digital__ && defined __unix__)
238 /* old system without (proper) C99 support */
239 #define bool smalluint
240 #else
241 /* modern system, so use it */
242 #include <stdbool.h>
243 #endif
244
245 /* Try to defeat gcc's alignment of "char message[]"-like data */
246 #if 1 /* if needed: !defined(arch1) && !defined(arch2) */
247 #define ALIGN1 __attribute__((aligned(1)))
248 #define ALIGN2 __attribute__((aligned(2)))
249 #else
250 /* Arches which MUST have 2 or 4 byte alignment for everything are here */
251 #define ALIGN1
252 #define ALIGN2
253 #endif
254
255
256 /* uclibc does not implement daemon() for no-mmu systems.
257  * For 0.9.29 and svn, __ARCH_USE_MMU__ indicates no-mmu reliably.
258  * For earlier versions there is no reliable way to check if we are building
259  * for a mmu-less system.
260  */
261 #if ENABLE_NOMMU || \
262     (defined __UCLIBC__ && __UCLIBC_MAJOR__ >= 0 && __UCLIBC_MINOR__ >= 9 && \
263     __UCLIBC_SUBLEVEL__ > 28 && !defined __ARCH_USE_MMU__)
264 #define BB_MMU 0
265 #define USE_FOR_NOMMU(...) __VA_ARGS__
266 #define USE_FOR_MMU(...)
267 #else
268 #define BB_MMU 1
269 #define USE_FOR_NOMMU(...)
270 #define USE_FOR_MMU(...) __VA_ARGS__
271 #endif
272
273 /* Platforms that haven't got dprintf need to implement fdprintf() in
274  * libbb.  This would require a platform.c.  It's not going to be cleaned
275  * out of the tree, so stop saying it should be. */
276 #if !defined(__dietlibc__)
277 /* Needed for: glibc */
278 /* Not needed for: dietlibc */
279 /* Others: ?? (add as needed) */
280 #define fdprintf dprintf
281 #endif
282
283 #if defined(__dietlibc__)
284 static ALWAYS_INLINE char* strchrnul(const char *s, char c)
285 {
286         while (*s && *s != c) ++s;
287         return (char*)s;
288 }
289 #endif
290
291 /* Don't use lchown with glibc older than 2.1.x ... uClibc lacks it */
292 #if (defined __GLIBC__ && __GLIBC__ <= 2 && __GLIBC_MINOR__ < 1) || \
293     defined __UC_LIBC__
294 # define lchown chown
295 #endif
296
297 #if (defined __digital__ && defined __unix__)
298 #include <standards.h>
299 #define HAVE_STANDARDS_H
300 #include <inttypes.h>
301 #define HAVE_INTTYPES_H
302 #define PRIu32 "u"
303
304 /* use legacy setpgrp(pid_t,pid_t) for now.  move to platform.c */
305 #define bb_setpgrp() do { pid_t __me = getpid(); setpgrp(__me,__me); } while (0)
306
307 #if !defined ADJ_OFFSET_SINGLESHOT && defined MOD_CLKA && defined MOD_OFFSET
308 #define ADJ_OFFSET_SINGLESHOT (MOD_CLKA | MOD_OFFSET)
309 #endif
310 #if !defined ADJ_FREQUENCY && defined MOD_FREQUENCY
311 #define ADJ_FREQUENCY MOD_FREQUENCY
312 #endif
313 #if !defined ADJ_TIMECONST && defined MOD_TIMECONST
314 #define ADJ_TIMECONST MOD_TIMECONST
315 #endif
316 #if !defined ADJ_TICK && defined MOD_CLKB
317 #define ADJ_TICK MOD_CLKB
318 #endif
319
320 #else
321 #define bb_setpgrp() setpgrp()
322 #endif
323
324 #if defined(__linux__)
325 #include <sys/mount.h>
326 /* Make sure we have all the new mount flags we actually try to use. */
327 #ifndef MS_BIND
328 #define MS_BIND        (1<<12)
329 #endif
330 #ifndef MS_MOVE
331 #define MS_MOVE        (1<<13)
332 #endif
333 #ifndef MS_RECURSIVE
334 #define MS_RECURSIVE   (1<<14)
335 #endif
336 #ifndef MS_SILENT
337 #define MS_SILENT      (1<<15)
338 #endif
339
340 /* The shared subtree stuff, which went in around 2.6.15. */
341 #ifndef MS_UNBINDABLE
342 #define MS_UNBINDABLE  (1<<17)
343 #endif
344 #ifndef MS_PRIVATE
345 #define MS_PRIVATE     (1<<18)
346 #endif
347 #ifndef MS_SLAVE
348 #define MS_SLAVE       (1<<19)
349 #endif
350 #ifndef MS_SHARED
351 #define MS_SHARED      (1<<20)
352 #endif
353 #ifndef MS_RELATIME
354 #define MS_RELATIME   (1 << 21)
355 #endif
356
357 #if !defined(BLKSSZGET)
358 #define BLKSSZGET _IO(0x12, 104)
359 #endif
360 #if !defined(BLKGETSIZE64)
361 #define BLKGETSIZE64 _IOR(0x12,114,size_t)
362 #endif
363 #endif
364
365 #endif  /* platform.h   */