47fd5f63d2a7395047da43cb6a7049b255d970be
[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     /* 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
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)   (memcpy((u32p), &(v), 4))
177 #endif
178
179 /* ---- Networking ------------------------------------------ */
180
181 #ifndef __APPLE__
182 # include <arpa/inet.h>
183 # ifndef __socklen_t_defined
184 typedef int socklen_t;
185 # endif
186 #else
187 # include <netinet/in.h>
188 #endif
189
190 /* ---- Compiler dependent settings ------------------------- */
191
192 #if (defined __digital__ && defined __unix__) || defined __APPLE__
193 # undef HAVE_MNTENT_H
194 # undef HAVE_SYS_STATFS_H
195 #else
196 # define HAVE_MNTENT_H 1
197 # define HAVE_SYS_STATFS_H 1
198 #endif /* ___digital__ && __unix__ */
199
200 /* linux/loop.h relies on __u64. Make sure we have that as a proper type
201  * until userspace is widely fixed.  */
202 #if (defined __INTEL_COMPILER && !defined __GNUC__) || \
203         (defined __GNUC__ && defined __STRICT_ANSI__)
204 __extension__ typedef long long __s64;
205 __extension__ typedef unsigned long long __u64;
206 #endif
207
208 /*----- Kernel versioning ------------------------------------*/
209
210 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
211
212 /* ---- Miscellaneous --------------------------------------- */
213
214 #if defined(__GNU_LIBRARY__) && __GNU_LIBRARY__ < 5 && \
215         !defined(__dietlibc__) && \
216         !defined(_NEWLIB_VERSION) && \
217         !(defined __digital__ && defined __unix__)
218 # error "Sorry, this libc version is not supported :("
219 #endif
220
221 /* Don't perpetuate e2fsck crap into the headers.  Clean up e2fsck instead. */
222
223 #if defined __GLIBC__ || defined __UCLIBC__ \
224         || defined __dietlibc__ || defined _NEWLIB_VERSION
225 #include <features.h>
226 #define HAVE_FEATURES_H
227 #include <stdint.h>
228 #define HAVE_STDINT_H
229 #elif !defined __APPLE__
230 /* Largest integral types.  */
231 #if __BIG_ENDIAN__
232 typedef long                intmax_t;
233 typedef unsigned long       uintmax_t;
234 #else
235 __extension__
236 typedef long long           intmax_t;
237 __extension__
238 typedef unsigned long long  uintmax_t;
239 #endif
240 #endif
241
242 /* Size-saving "small" ints (arch-dependent) */
243 #if defined(i386) || defined(__x86_64__) || defined(__mips__) || defined(__cris__)
244 /* add other arches which benefit from this... */
245 typedef signed char smallint;
246 typedef unsigned char smalluint;
247 #else
248 /* for arches where byte accesses generate larger code: */
249 typedef int smallint;
250 typedef unsigned smalluint;
251 #endif
252
253 /* ISO C Standard:  7.16  Boolean type and values  <stdbool.h> */
254 #if (defined __digital__ && defined __unix__)
255 /* old system without (proper) C99 support */
256 #define bool smalluint
257 #else
258 /* modern system, so use it */
259 #include <stdbool.h>
260 #endif
261
262 /* Try to defeat gcc's alignment of "char message[]"-like data */
263 #if 1 /* if needed: !defined(arch1) && !defined(arch2) */
264 #define ALIGN1 __attribute__((aligned(1)))
265 #define ALIGN2 __attribute__((aligned(2)))
266 #else
267 /* Arches which MUST have 2 or 4 byte alignment for everything are here */
268 #define ALIGN1
269 #define ALIGN2
270 #endif
271
272
273 /* uclibc does not implement daemon() for no-mmu systems.
274  * For 0.9.29 and svn, __ARCH_USE_MMU__ indicates no-mmu reliably.
275  * For earlier versions there is no reliable way to check if we are building
276  * for a mmu-less system.
277  */
278 #if ENABLE_NOMMU || \
279     (defined __UCLIBC__ && __UCLIBC_MAJOR__ >= 0 && __UCLIBC_MINOR__ >= 9 && \
280     __UCLIBC_SUBLEVEL__ > 28 && !defined __ARCH_USE_MMU__)
281 #define BB_MMU 0
282 #define USE_FOR_NOMMU(...) __VA_ARGS__
283 #define USE_FOR_MMU(...)
284 #else
285 #define BB_MMU 1
286 #define USE_FOR_NOMMU(...)
287 #define USE_FOR_MMU(...) __VA_ARGS__
288 #endif
289
290 /* Platforms that haven't got dprintf need to implement fdprintf() in
291  * libbb.  This would require a platform.c.  It's not going to be cleaned
292  * out of the tree, so stop saying it should be. */
293 #if !defined(__dietlibc__)
294 /* Needed for: glibc */
295 /* Not needed for: dietlibc */
296 /* Others: ?? (add as needed) */
297 #define fdprintf dprintf
298 #endif
299
300 #if defined(__dietlibc__)
301 static ALWAYS_INLINE char* strchrnul(const char *s, char c)
302 {
303         while (*s && *s != c) ++s;
304         return (char*)s;
305 }
306 #endif
307
308 /* Don't use lchown with glibc older than 2.1.x ... uClibc lacks it */
309 #if (defined __GLIBC__ && __GLIBC__ <= 2 && __GLIBC_MINOR__ < 1) || \
310     defined __UC_LIBC__
311 # define lchown chown
312 #endif
313
314 #if (defined __digital__ && defined __unix__)
315
316 # include <standards.h>
317 # define HAVE_STANDARDS_H
318 # include <inttypes.h>
319 # define HAVE_INTTYPES_H
320 # define PRIu32 "u"
321 /* use legacy setpgrp(pid_t,pid_t) for now.  move to platform.c */
322 # define bb_setpgrp() do { pid_t __me = getpid(); setpgrp(__me,__me); } while (0)
323
324 # if !defined ADJ_OFFSET_SINGLESHOT && defined MOD_CLKA && defined MOD_OFFSET
325 #  define ADJ_OFFSET_SINGLESHOT (MOD_CLKA | MOD_OFFSET)
326 # endif
327 # if !defined ADJ_FREQUENCY && defined MOD_FREQUENCY
328 #  define ADJ_FREQUENCY MOD_FREQUENCY
329 # endif
330 # if !defined ADJ_TIMECONST && defined MOD_TIMECONST
331 #  define ADJ_TIMECONST MOD_TIMECONST
332 # endif
333 # if !defined ADJ_TICK && defined MOD_CLKB
334 #  define ADJ_TICK MOD_CLKB
335 # endif
336
337 #else /* !__digital__ */
338
339 # define bb_setpgrp() setpgrp()
340
341 #endif
342
343 #if defined(__linux__)
344 #include <sys/mount.h>
345 /* Make sure we have all the new mount flags we actually try to use. */
346 #ifndef MS_BIND
347 #define MS_BIND        (1<<12)
348 #endif
349 #ifndef MS_MOVE
350 #define MS_MOVE        (1<<13)
351 #endif
352 #ifndef MS_RECURSIVE
353 #define MS_RECURSIVE   (1<<14)
354 #endif
355 #ifndef MS_SILENT
356 #define MS_SILENT      (1<<15)
357 #endif
358
359 /* The shared subtree stuff, which went in around 2.6.15. */
360 #ifndef MS_UNBINDABLE
361 #define MS_UNBINDABLE  (1<<17)
362 #endif
363 #ifndef MS_PRIVATE
364 #define MS_PRIVATE     (1<<18)
365 #endif
366 #ifndef MS_SLAVE
367 #define MS_SLAVE       (1<<19)
368 #endif
369 #ifndef MS_SHARED
370 #define MS_SHARED      (1<<20)
371 #endif
372 #ifndef MS_RELATIME
373 #define MS_RELATIME   (1 << 21)
374 #endif
375
376 #if !defined(BLKSSZGET)
377 #define BLKSSZGET _IO(0x12, 104)
378 #endif
379 #if !defined(BLKGETSIZE64)
380 #define BLKGETSIZE64 _IOR(0x12,114,size_t)
381 #endif
382 #endif
383
384 #endif