1 /* vi: set sw=4 ts=4: */
3 * Copyright 2006, Bernhard Reutner-Fischer
5 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
8 #define BB_PLATFORM_H 1
11 /* Convenience macros to test the version of gcc. */
13 #if defined __GNUC__ && defined __GNUC_MINOR__
14 # define __GNUC_PREREQ(maj, min) \
15 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
17 # define __GNUC_PREREQ(maj, min) 0
20 /* __restrict is known in EGCS 1.2 and above. */
21 #if !__GNUC_PREREQ(2,92)
27 #if !__GNUC_PREREQ(2,7)
28 # ifndef __attribute__
29 # define __attribute__(x)
34 #if defined(__STDC_VERSION__) && __STDC_VERSION__ > 199901L
36 #elif __GNUC_PREREQ(2,7)
37 # define inline __inline__
43 # define __const const
46 #define UNUSED_PARAM __attribute__ ((__unused__))
47 #define NORETURN __attribute__ ((__noreturn__))
49 #if __GNUC_PREREQ(4,5)
50 # define bb_unreachable(altcode) __builtin_unreachable()
52 # define bb_unreachable(altcode) altcode
55 /* "The malloc attribute is used to tell the compiler that a function
56 * may be treated as if any non-NULL pointer it returns cannot alias
57 * any other pointer valid when the function returns. This will often
58 * improve optimization. Standard functions with this property include
59 * malloc and calloc. realloc-like functions have this property as long
60 * as the old pointer is never referred to (including comparing it
61 * to the new pointer) after the function returns a non-NULL value."
63 #define RETURNS_MALLOC __attribute__ ((malloc))
64 #define PACKED __attribute__ ((__packed__))
65 #define ALIGNED(m) __attribute__ ((__aligned__(m)))
67 /* __NO_INLINE__: some gcc's do not honor inlining! :( */
68 #if __GNUC_PREREQ(3,0) && !defined(__NO_INLINE__)
69 # define ALWAYS_INLINE __attribute__ ((always_inline)) inline
70 /* I've seen a toolchain where I needed __noinline__ instead of noinline */
71 # define NOINLINE __attribute__((__noinline__))
73 # define DEPRECATED __attribute__ ((__deprecated__))
74 # define UNUSED_PARAM_RESULT __attribute__ ((warn_unused_result))
77 # define UNUSED_PARAM_RESULT
80 # define ALWAYS_INLINE inline
83 # define UNUSED_PARAM_RESULT
86 /* used by unit test machinery to run registration functions before calling main() */
87 #define INIT_FUNC __attribute__ ((constructor))
89 /* -fwhole-program makes all symbols local. The attribute externally_visible
90 * forces a symbol global. */
91 #if __GNUC_PREREQ(4,1)
92 # define EXTERNALLY_VISIBLE __attribute__(( visibility("default") ))
93 //__attribute__ ((__externally_visible__))
95 # define EXTERNALLY_VISIBLE
98 /* At 4.4 gcc become much more anal about this, need to use "aliased" types */
99 #if __GNUC_PREREQ(4,4)
100 # define FIX_ALIASING __attribute__((__may_alias__))
102 # define FIX_ALIASING
105 /* We use __extension__ in some places to suppress -pedantic warnings
106 * about GCC extensions. This feature didn't work properly before
108 #if !__GNUC_PREREQ(2,8)
109 # ifndef __extension__
110 # define __extension__
114 /* FAST_FUNC is a qualifier which (possibly) makes function call faster
115 * and/or smaller by using modified ABI. It is usually only needed
116 * on non-static, busybox internal functions. Recent versions of gcc
117 * optimize statics automatically. FAST_FUNC on static is required
118 * only if you need to match a function pointer's type.
119 * FAST_FUNC may not work well with -flto so allow user to disable this.
123 # if __GNUC_PREREQ(3,0) && defined(i386)
124 /* stdcall makes callee to pop arguments from stack, not caller */
125 # define FAST_FUNC __attribute__((regparm(3),stdcall))
126 /* #elif ... - add your favorite arch today! */
132 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
133 /* (don't include system headers after this until corresponding pop!) */
134 #if __GNUC_PREREQ(4,1) && !defined(__CYGWIN__)
135 # define PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN _Pragma("GCC visibility push(hidden)")
136 # define POP_SAVED_FUNCTION_VISIBILITY _Pragma("GCC visibility pop")
138 # define PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
139 # define POP_SAVED_FUNCTION_VISIBILITY
142 /* gcc-2.95 had no va_copy but only __va_copy. */
143 #if !__GNUC_PREREQ(3,0)
145 # if !defined va_copy && defined __va_copy
146 # define va_copy(d,s) __va_copy((d),(s))
151 /* ---- Endian Detection ------------------------------------ */
154 #if defined(__digital__) && defined(__unix__)
156 #elif defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
157 || defined(__APPLE__)
158 # include <sys/resource.h> /* rlimit */
159 # include <machine/endian.h>
160 # define bswap_64 __bswap64
161 # define bswap_32 __bswap32
162 # define bswap_16 __bswap16
164 # include <byteswap.h>
168 #if defined(__BYTE_ORDER) && __BYTE_ORDER == __BIG_ENDIAN
169 # define BB_BIG_ENDIAN 1
170 # define BB_LITTLE_ENDIAN 0
171 #elif defined(__BYTE_ORDER) && __BYTE_ORDER == __LITTLE_ENDIAN
172 # define BB_BIG_ENDIAN 0
173 # define BB_LITTLE_ENDIAN 1
174 #elif defined(_BYTE_ORDER) && _BYTE_ORDER == _BIG_ENDIAN
175 # define BB_BIG_ENDIAN 1
176 # define BB_LITTLE_ENDIAN 0
177 #elif defined(_BYTE_ORDER) && _BYTE_ORDER == _LITTLE_ENDIAN
178 # define BB_BIG_ENDIAN 0
179 # define BB_LITTLE_ENDIAN 1
180 #elif defined(BYTE_ORDER) && BYTE_ORDER == BIG_ENDIAN
181 # define BB_BIG_ENDIAN 1
182 # define BB_LITTLE_ENDIAN 0
183 #elif defined(BYTE_ORDER) && BYTE_ORDER == LITTLE_ENDIAN
184 # define BB_BIG_ENDIAN 0
185 # define BB_LITTLE_ENDIAN 1
186 #elif defined(__386__)
187 # define BB_BIG_ENDIAN 0
188 # define BB_LITTLE_ENDIAN 1
190 # error "Can't determine endianness"
193 #if ULONG_MAX > 0xffffffff
194 # define bb_bswap_64(x) bswap_64(x)
197 /* SWAP_LEnn means "convert CPU<->little_endian by swapping bytes" */
199 # define SWAP_BE16(x) (x)
200 # define SWAP_BE32(x) (x)
201 # define SWAP_BE64(x) (x)
202 # define SWAP_LE16(x) bswap_16(x)
203 # define SWAP_LE32(x) bswap_32(x)
204 # define SWAP_LE64(x) bb_bswap_64(x)
205 # define IF_BIG_ENDIAN(...) __VA_ARGS__
206 # define IF_LITTLE_ENDIAN(...)
208 # define SWAP_BE16(x) bswap_16(x)
209 # define SWAP_BE32(x) bswap_32(x)
210 # define SWAP_BE64(x) bb_bswap_64(x)
211 # define SWAP_LE16(x) (x)
212 # define SWAP_LE32(x) (x)
213 # define SWAP_LE64(x) (x)
214 # define IF_BIG_ENDIAN(...)
215 # define IF_LITTLE_ENDIAN(...) __VA_ARGS__
219 /* ---- Unaligned access ------------------------------------ */
222 typedef int bb__aliased_int FIX_ALIASING;
223 typedef long bb__aliased_long FIX_ALIASING;
224 typedef uint16_t bb__aliased_uint16_t FIX_ALIASING;
225 typedef uint32_t bb__aliased_uint32_t FIX_ALIASING;
226 typedef uint64_t bb__aliased_uint64_t FIX_ALIASING;
228 /* NB: unaligned parameter should be a pointer, aligned one -
229 * a lvalue. This makes it more likely to not swap them by mistake
231 #if defined(i386) || defined(__x86_64__) || defined(__powerpc__)
232 # define BB_UNALIGNED_MEMACCESS_OK 1
233 # define move_from_unaligned_int(v, intp) ((v) = *(bb__aliased_int*)(intp))
234 # define move_from_unaligned_long(v, longp) ((v) = *(bb__aliased_long*)(longp))
235 # define move_from_unaligned16(v, u16p) ((v) = *(bb__aliased_uint16_t*)(u16p))
236 # define move_from_unaligned32(v, u32p) ((v) = *(bb__aliased_uint32_t*)(u32p))
237 # define move_to_unaligned16(u16p, v) (*(bb__aliased_uint16_t*)(u16p) = (v))
238 # define move_to_unaligned32(u32p, v) (*(bb__aliased_uint32_t*)(u32p) = (v))
239 # define move_to_unaligned64(u64p, v) (*(bb__aliased_uint64_t*)(u64p) = (v))
240 /* #elif ... - add your favorite arch today! */
242 # define BB_UNALIGNED_MEMACCESS_OK 0
243 /* performs reasonably well (gcc usually inlines memcpy here) */
244 # define move_from_unaligned_int(v, intp) (memcpy(&(v), (intp), sizeof(int)))
245 # define move_from_unaligned_long(v, longp) (memcpy(&(v), (longp), sizeof(long)))
246 # define move_from_unaligned16(v, u16p) (memcpy(&(v), (u16p), 2))
247 # define move_from_unaligned32(v, u32p) (memcpy(&(v), (u32p), 4))
248 # define move_to_unaligned16(u16p, v) do { \
249 uint16_t __t = (v); \
250 memcpy((u16p), &__t, 2); \
252 # define move_to_unaligned32(u32p, v) do { \
253 uint32_t __t = (v); \
254 memcpy((u32p), &__t, 4); \
256 # define move_to_unaligned64(u64p, v) do { \
257 uint64_t __t = (v); \
258 memcpy((u64p), &__t, 8); \
262 /* Unaligned, fixed-endian accessors */
263 #define get_unaligned_le32(buf) ({ uint32_t v; move_from_unaligned32(v, buf); SWAP_LE32(v); })
264 #define get_unaligned_be32(buf) ({ uint32_t v; move_from_unaligned32(v, buf); SWAP_BE32(v); })
265 #define put_unaligned_le32(val, buf) move_to_unaligned32(buf, SWAP_LE32(val))
266 #define put_unaligned_be32(val, buf) move_to_unaligned32(buf, SWAP_BE32(val))
268 /* unxz needs an aligned fixed-endian accessor.
269 * (however, the compiler does not realize it's aligned, the cast is still necessary)
271 #define get_le32(u32p) ({ uint32_t v = *(bb__aliased_uint32_t*)(u32p); SWAP_LE32(v); })
274 /* ---- Size-saving "small" ints (arch-dependent) ----------- */
276 #if defined(i386) || defined(__x86_64__) || defined(__mips__) || defined(__cris__)
277 /* add other arches which benefit from this... */
278 typedef signed char smallint;
279 typedef unsigned char smalluint;
281 /* for arches where byte accesses generate larger code: */
282 typedef int smallint;
283 typedef unsigned smalluint;
286 /* ISO C Standard: 7.16 Boolean type and values <stdbool.h> */
287 #if (defined __digital__ && defined __unix__)
288 /* old system without (proper) C99 support */
289 # define bool smalluint
291 /* modern system, so use it */
292 # include <stdbool.h>
296 /*----- Kernel versioning ------------------------------------*/
298 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
301 # define UCLIBC_VERSION KERNEL_VERSION(__UCLIBC_MAJOR__, __UCLIBC_MINOR__, __UCLIBC_SUBLEVEL__)
303 # define UCLIBC_VERSION 0
307 /* ---- Miscellaneous --------------------------------------- */
309 #if defined __GLIBC__ \
310 || defined __UCLIBC__ \
311 || defined __dietlibc__ \
312 || defined __BIONIC__ \
313 || defined _NEWLIB_VERSION
314 # include <features.h>
317 /* Define bb_setpgrp */
318 #if defined(__digital__) && defined(__unix__)
319 /* use legacy setpgrp(pid_t, pid_t) for now. move to platform.c */
320 # define bb_setpgrp() do { pid_t __me = getpid(); setpgrp(__me, __me); } while (0)
322 # define bb_setpgrp() setpgrp()
325 /* fdprintf is more readable, we used it before dprintf was standardized */
327 #define fdprintf dprintf
329 /* Useful for defeating gcc's alignment of "char message[]"-like data */
330 #if !defined(__s390__)
331 /* on s390[x], non-word-aligned data accesses require larger code */
332 # define ALIGN1 __attribute__((aligned(1)))
333 # define ALIGN2 __attribute__((aligned(2)))
334 # define ALIGN4 __attribute__((aligned(4)))
336 /* Arches which MUST have 2 or 4 byte alignment for everything are here */
343 * For 0.9.29 and svn, __ARCH_USE_MMU__ indicates no-mmu reliably.
344 * For earlier versions there is no reliable way to check if we are building
345 * for a mmu-less system.
347 #if ENABLE_NOMMU || \
348 (defined __UCLIBC__ && \
349 UCLIBC_VERSION > KERNEL_VERSION(0, 9, 28) && \
350 !defined __ARCH_USE_MMU__)
352 # define USE_FOR_NOMMU(...) __VA_ARGS__
353 # define USE_FOR_MMU(...)
356 # define USE_FOR_NOMMU(...)
357 # define USE_FOR_MMU(...) __VA_ARGS__
360 #if defined(__digital__) && defined(__unix__)
361 # include <standards.h>
362 # include <inttypes.h>
364 # if !defined ADJ_OFFSET_SINGLESHOT && defined MOD_CLKA && defined MOD_OFFSET
365 # define ADJ_OFFSET_SINGLESHOT (MOD_CLKA | MOD_OFFSET)
367 # if !defined ADJ_FREQUENCY && defined MOD_FREQUENCY
368 # define ADJ_FREQUENCY MOD_FREQUENCY
370 # if !defined ADJ_TIMECONST && defined MOD_TIMECONST
371 # define ADJ_TIMECONST MOD_TIMECONST
373 # if !defined ADJ_TICK && defined MOD_CLKB
374 # define ADJ_TICK MOD_CLKB
378 #if defined(__CYGWIN__)
379 # define MAXSYMLINKS SYMLOOP_MAX
382 #if defined(ANDROID) || defined(__ANDROID__)
383 # define BB_ADDITIONAL_PATH ":/system/sbin:/system/bin:/system/xbin"
384 # define SYS_ioprio_set __NR_ioprio_set
385 # define SYS_ioprio_get __NR_ioprio_get
389 /* ---- Who misses what? ------------------------------------ */
391 /* Assume all these functions and header files exist by default.
392 * Platforms where it is not true will #undef them below.
394 #define HAVE_CLEARENV 1
395 #define HAVE_FDATASYNC 1
396 #define HAVE_DPRINTF 1
397 #define HAVE_MEMRCHR 1
398 #define HAVE_MKDTEMP 1
399 #define HAVE_TTYNAME_R 1
400 #define HAVE_PTSNAME_R 1
401 #define HAVE_SETBIT 1
402 #define HAVE_SIGHANDLER_T 1
403 #define HAVE_STPCPY 1
404 #define HAVE_MEMPCPY 1
405 #define HAVE_STRCASESTR 1
406 #define HAVE_STRCHRNUL 1
407 #define HAVE_STRSEP 1
408 #define HAVE_STRSIGNAL 1
409 #define HAVE_STRVERSCMP 1
410 #define HAVE_VASPRINTF 1
411 #define HAVE_USLEEP 1
412 #define HAVE_UNLOCKED_STDIO 1
413 #define HAVE_UNLOCKED_LINE_OPS 1
414 #define HAVE_GETLINE 1
416 #define HAVE_MNTENT_H 1
417 #define HAVE_NET_ETHERNET_H 1
418 #define HAVE_SYS_STATFS_H 1
419 #define HAVE_PRINTF_PERCENTM 1
421 #if defined(__UCLIBC__)
422 # if UCLIBC_VERSION < KERNEL_VERSION(0, 9, 32)
423 # undef HAVE_STRVERSCMP
425 # if UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 30)
426 # ifndef __UCLIBC_SUSV3_LEGACY__
432 #if defined(__WATCOMC__)
439 # undef HAVE_STRCASESTR
440 # undef HAVE_STRCHRNUL
442 # undef HAVE_STRSIGNAL
443 # undef HAVE_STRVERSCMP
444 # undef HAVE_VASPRINTF
445 # undef HAVE_UNLOCKED_STDIO
446 # undef HAVE_UNLOCKED_LINE_OPS
447 # undef HAVE_NET_ETHERNET_H
450 #if defined(__CYGWIN__)
451 # undef HAVE_CLEARENV
452 # undef HAVE_FDPRINTF
454 # undef HAVE_PTSNAME_R
455 # undef HAVE_STRVERSCMP
456 # undef HAVE_UNLOCKED_LINE_OPS
459 /* These BSD-derived OSes share many similarities */
460 #if (defined __digital__ && defined __unix__) \
461 || defined __APPLE__ \
462 || defined __OpenBSD__ || defined __NetBSD__
463 # undef HAVE_CLEARENV
464 # undef HAVE_FDATASYNC
466 # undef HAVE_MNTENT_H
467 # undef HAVE_PTSNAME_R
468 # undef HAVE_SYS_STATFS_H
469 # undef HAVE_SIGHANDLER_T
470 # undef HAVE_STRVERSCMP
473 # undef HAVE_UNLOCKED_STDIO
474 # undef HAVE_UNLOCKED_LINE_OPS
475 # undef HAVE_PRINTF_PERCENTM
478 #if defined(__dietlibc__)
479 # undef HAVE_STRCHRNUL
482 #if defined(__APPLE__)
483 # undef HAVE_STRCHRNUL
486 #if defined(__FreeBSD__)
487 /* users say mempcpy is not present in FreeBSD 9.x */
489 # undef HAVE_CLEARENV
490 # undef HAVE_FDATASYNC
491 # undef HAVE_MNTENT_H
492 # undef HAVE_PTSNAME_R
493 # undef HAVE_SYS_STATFS_H
494 # undef HAVE_SIGHANDLER_T
495 # undef HAVE_STRVERSCMP
497 # undef HAVE_UNLOCKED_LINE_OPS
498 # undef HAVE_PRINTF_PERCENTM
499 # include <osreldate.h>
500 # if __FreeBSD_version < 1000029
501 # undef HAVE_STRCHRNUL /* FreeBSD added strchrnul() between 1000028 and 1000029 */
505 #if defined(__NetBSD__)
506 # define HAVE_GETLINE 1 /* Recent NetBSD versions have getline() */
509 #if defined(__digital__) && defined(__unix__)
513 #if defined(ANDROID) || defined(__ANDROID__)
514 # if __ANDROID_API__ < 8
515 /* ANDROID < 8 has no [f]dprintf at all */
517 # elif __ANDROID_API__ < 21
518 /* ANDROID < 21 has fdprintf */
519 # define dprintf fdprintf
521 /* ANDROID >= 21 has standard dprintf */
523 # if __ANDROID_API__ < 21
524 # undef HAVE_TTYNAME_R
529 # undef HAVE_STRCHRNUL
530 # undef HAVE_STRVERSCMP
531 # undef HAVE_UNLOCKED_LINE_OPS
532 # undef HAVE_NET_ETHERNET_H
533 # undef HAVE_PRINTF_PERCENTM
537 * Now, define prototypes for all the functions defined in platform.c
538 * These must come after all the HAVE_* macros are defined (or not)
542 extern int dprintf(int fd, const char *format, ...);
546 extern void *memrchr(const void *s, int c, size_t n) FAST_FUNC;
550 extern char *mkdtemp(char *template) FAST_FUNC;
553 #ifndef HAVE_TTYNAME_R
554 #define ttyname_r bb_ttyname_r
555 extern int ttyname_r(int fd, char *buf, size_t buflen);
559 # define setbit(a, b) ((a)[(b) >> 3] |= 1 << ((b) & 7))
560 # define clrbit(a, b) ((a)[(b) >> 3] &= ~(1 << ((b) & 7)))
563 #ifndef HAVE_SIGHANDLER_T
564 typedef void (*sighandler_t)(int);
568 extern char *stpcpy(char *p, const char *to_add) FAST_FUNC;
573 /* In case we are wrong about !HAVE_MEMPCPY, and toolchain _does_ have
574 * mempcpy(), avoid colliding with it:
576 #define mempcpy bb__mempcpy
577 static ALWAYS_INLINE void *mempcpy(void *dest, const void *src, size_t len)
579 return memcpy(dest, src, len) + len;
583 #ifndef HAVE_STRCASESTR
584 extern char *strcasestr(const char *s, const char *pattern) FAST_FUNC;
587 #ifndef HAVE_STRCHRNUL
588 extern char *strchrnul(const char *s, int c) FAST_FUNC;
592 extern char *strsep(char **stringp, const char *delim) FAST_FUNC;
595 #ifndef HAVE_STRSIGNAL
596 /* Not exactly the same: instead of "Stopped" it shows "STOP" etc */
597 # define strsignal(sig) get_signame(sig)
601 extern int usleep(unsigned) FAST_FUNC;
604 #ifndef HAVE_VASPRINTF
605 extern int vasprintf(char **string_ptr, const char *format, va_list p) FAST_FUNC;
609 # include <stdio.h> /* for FILE */
610 # include <sys/types.h> /* size_t */
611 extern ssize_t getline(char **lineptr, size_t *n, FILE *stream) FAST_FUNC;