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__))
48 /* "The malloc attribute is used to tell the compiler that a function
49 * may be treated as if any non-NULL pointer it returns cannot alias
50 * any other pointer valid when the function returns. This will often
51 * improve optimization. Standard functions with this property include
52 * malloc and calloc. realloc-like functions have this property as long
53 * as the old pointer is never referred to (including comparing it
54 * to the new pointer) after the function returns a non-NULL value."
56 #define RETURNS_MALLOC __attribute__ ((malloc))
57 #define PACKED __attribute__ ((__packed__))
58 #define ALIGNED(m) __attribute__ ((__aligned__(m)))
60 /* __NO_INLINE__: some gcc's do not honor inlining! :( */
61 #if __GNUC_PREREQ(3,0) && !defined(__NO_INLINE__)
62 # define ALWAYS_INLINE __attribute__ ((always_inline)) inline
63 /* I've seen a toolchain where I needed __noinline__ instead of noinline */
64 # define NOINLINE __attribute__((__noinline__))
66 # define DEPRECATED __attribute__ ((__deprecated__))
67 # define UNUSED_PARAM_RESULT __attribute__ ((warn_unused_result))
70 # define UNUSED_PARAM_RESULT
73 # define ALWAYS_INLINE inline
76 # define UNUSED_PARAM_RESULT
79 /* used by unit test machinery to run registration functions before calling main() */
80 #define INIT_FUNC __attribute__ ((constructor))
82 /* -fwhole-program makes all symbols local. The attribute externally_visible
83 * forces a symbol global. */
84 #if __GNUC_PREREQ(4,1)
85 # define EXTERNALLY_VISIBLE __attribute__(( visibility("default") ))
86 //__attribute__ ((__externally_visible__))
88 # define EXTERNALLY_VISIBLE
91 /* At 4.4 gcc become much more anal about this, need to use "aliased" types */
92 #if __GNUC_PREREQ(4,4)
93 # define FIX_ALIASING __attribute__((__may_alias__))
98 /* We use __extension__ in some places to suppress -pedantic warnings
99 * about GCC extensions. This feature didn't work properly before
101 #if !__GNUC_PREREQ(2,8)
102 # ifndef __extension__
103 # define __extension__
107 /* FAST_FUNC is a qualifier which (possibly) makes function call faster
108 * and/or smaller by using modified ABI. It is usually only needed
109 * on non-static, busybox internal functions. Recent versions of gcc
110 * optimize statics automatically. FAST_FUNC on static is required
111 * only if you need to match a function pointer's type.
112 * FAST_FUNC may not work well with -flto so allow user to disable this.
116 # if __GNUC_PREREQ(3,0) && defined(i386)
117 /* stdcall makes callee to pop arguments from stack, not caller */
118 # define FAST_FUNC __attribute__((regparm(3),stdcall))
119 /* #elif ... - add your favorite arch today! */
125 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
126 /* (don't include system headers after this until corresponding pop!) */
127 #if __GNUC_PREREQ(4,1) && !defined(__CYGWIN__)
128 # define PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN _Pragma("GCC visibility push(hidden)")
129 # define POP_SAVED_FUNCTION_VISIBILITY _Pragma("GCC visibility pop")
131 # define PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
132 # define POP_SAVED_FUNCTION_VISIBILITY
135 /* gcc-2.95 had no va_copy but only __va_copy. */
136 #if !__GNUC_PREREQ(3,0)
138 # if !defined va_copy && defined __va_copy
139 # define va_copy(d,s) __va_copy((d),(s))
144 /* ---- Endian Detection ------------------------------------ */
147 #if defined(__digital__) && defined(__unix__)
149 #elif defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
150 || defined(__APPLE__)
151 # include <sys/resource.h> /* rlimit */
152 # include <machine/endian.h>
153 # define bswap_64 __bswap64
154 # define bswap_32 __bswap32
155 # define bswap_16 __bswap16
157 # include <byteswap.h>
161 #if defined(__BYTE_ORDER) && __BYTE_ORDER == __BIG_ENDIAN
162 # define BB_BIG_ENDIAN 1
163 # define BB_LITTLE_ENDIAN 0
164 #elif defined(__BYTE_ORDER) && __BYTE_ORDER == __LITTLE_ENDIAN
165 # define BB_BIG_ENDIAN 0
166 # define BB_LITTLE_ENDIAN 1
167 #elif defined(_BYTE_ORDER) && _BYTE_ORDER == _BIG_ENDIAN
168 # define BB_BIG_ENDIAN 1
169 # define BB_LITTLE_ENDIAN 0
170 #elif defined(_BYTE_ORDER) && _BYTE_ORDER == _LITTLE_ENDIAN
171 # define BB_BIG_ENDIAN 0
172 # define BB_LITTLE_ENDIAN 1
173 #elif defined(BYTE_ORDER) && BYTE_ORDER == BIG_ENDIAN
174 # define BB_BIG_ENDIAN 1
175 # define BB_LITTLE_ENDIAN 0
176 #elif defined(BYTE_ORDER) && BYTE_ORDER == LITTLE_ENDIAN
177 # define BB_BIG_ENDIAN 0
178 # define BB_LITTLE_ENDIAN 1
179 #elif defined(__386__)
180 # define BB_BIG_ENDIAN 0
181 # define BB_LITTLE_ENDIAN 1
183 # error "Can't determine endianness"
186 #if ULONG_MAX > 0xffffffff
187 # define bb_bswap_64(x) bswap_64(x)
190 /* SWAP_LEnn means "convert CPU<->little_endian by swapping bytes" */
192 # define SWAP_BE16(x) (x)
193 # define SWAP_BE32(x) (x)
194 # define SWAP_BE64(x) (x)
195 # define SWAP_LE16(x) bswap_16(x)
196 # define SWAP_LE32(x) bswap_32(x)
197 # define SWAP_LE64(x) bb_bswap_64(x)
198 # define IF_BIG_ENDIAN(...) __VA_ARGS__
199 # define IF_LITTLE_ENDIAN(...)
201 # define SWAP_BE16(x) bswap_16(x)
202 # define SWAP_BE32(x) bswap_32(x)
203 # define SWAP_BE64(x) bb_bswap_64(x)
204 # define SWAP_LE16(x) (x)
205 # define SWAP_LE32(x) (x)
206 # define SWAP_LE64(x) (x)
207 # define IF_BIG_ENDIAN(...)
208 # define IF_LITTLE_ENDIAN(...) __VA_ARGS__
212 /* ---- Unaligned access ------------------------------------ */
215 typedef int bb__aliased_int FIX_ALIASING;
216 typedef long bb__aliased_long FIX_ALIASING;
217 typedef uint16_t bb__aliased_uint16_t FIX_ALIASING;
218 typedef uint32_t bb__aliased_uint32_t FIX_ALIASING;
219 typedef uint64_t bb__aliased_uint64_t FIX_ALIASING;
221 /* NB: unaligned parameter should be a pointer, aligned one -
222 * a lvalue. This makes it more likely to not swap them by mistake
224 #if defined(i386) || defined(__x86_64__) || defined(__powerpc__)
225 # define BB_UNALIGNED_MEMACCESS_OK 1
226 # define move_from_unaligned_int(v, intp) ((v) = *(bb__aliased_int*)(intp))
227 # define move_from_unaligned_long(v, longp) ((v) = *(bb__aliased_long*)(longp))
228 # define move_from_unaligned16(v, u16p) ((v) = *(bb__aliased_uint16_t*)(u16p))
229 # define move_from_unaligned32(v, u32p) ((v) = *(bb__aliased_uint32_t*)(u32p))
230 # define move_to_unaligned16(u16p, v) (*(bb__aliased_uint16_t*)(u16p) = (v))
231 # define move_to_unaligned32(u32p, v) (*(bb__aliased_uint32_t*)(u32p) = (v))
232 /* #elif ... - add your favorite arch today! */
234 # define BB_UNALIGNED_MEMACCESS_OK 0
235 /* performs reasonably well (gcc usually inlines memcpy here) */
236 # define move_from_unaligned_int(v, intp) (memcpy(&(v), (intp), sizeof(int)))
237 # define move_from_unaligned_long(v, longp) (memcpy(&(v), (longp), sizeof(long)))
238 # define move_from_unaligned16(v, u16p) (memcpy(&(v), (u16p), 2))
239 # define move_from_unaligned32(v, u32p) (memcpy(&(v), (u32p), 4))
240 # define move_to_unaligned16(u16p, v) do { \
241 uint16_t __t = (v); \
242 memcpy((u16p), &__t, 2); \
244 # define move_to_unaligned32(u32p, v) do { \
245 uint32_t __t = (v); \
246 memcpy((u32p), &__t, 4); \
251 /* ---- Size-saving "small" ints (arch-dependent) ----------- */
253 #if defined(i386) || defined(__x86_64__) || defined(__mips__) || defined(__cris__)
254 /* add other arches which benefit from this... */
255 typedef signed char smallint;
256 typedef unsigned char smalluint;
258 /* for arches where byte accesses generate larger code: */
259 typedef int smallint;
260 typedef unsigned smalluint;
263 /* ISO C Standard: 7.16 Boolean type and values <stdbool.h> */
264 #if (defined __digital__ && defined __unix__)
265 /* old system without (proper) C99 support */
266 # define bool smalluint
268 /* modern system, so use it */
269 # include <stdbool.h>
273 /*----- Kernel versioning ------------------------------------*/
275 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
278 # define UCLIBC_VERSION KERNEL_VERSION(__UCLIBC_MAJOR__, __UCLIBC_MINOR__, __UCLIBC_SUBLEVEL__)
280 # define UCLIBC_VERSION 0
284 /* ---- Miscellaneous --------------------------------------- */
286 #if defined __GLIBC__ \
287 || defined __UCLIBC__ \
288 || defined __dietlibc__ \
289 || defined __BIONIC__ \
290 || defined _NEWLIB_VERSION
291 # include <features.h>
294 /* Define bb_setpgrp */
295 #if defined(__digital__) && defined(__unix__)
296 /* use legacy setpgrp(pid_t, pid_t) for now. move to platform.c */
297 # define bb_setpgrp() do { pid_t __me = getpid(); setpgrp(__me, __me); } while (0)
299 # define bb_setpgrp() setpgrp()
302 /* fdprintf is more readable, we used it before dprintf was standardized */
304 #define fdprintf dprintf
306 /* Useful for defeating gcc's alignment of "char message[]"-like data */
307 #if !defined(__s390__)
308 /* on s390[x], non-word-aligned data accesses require larger code */
309 # define ALIGN1 __attribute__((aligned(1)))
310 # define ALIGN2 __attribute__((aligned(2)))
311 # define ALIGN4 __attribute__((aligned(4)))
313 /* Arches which MUST have 2 or 4 byte alignment for everything are here */
320 * For 0.9.29 and svn, __ARCH_USE_MMU__ indicates no-mmu reliably.
321 * For earlier versions there is no reliable way to check if we are building
322 * for a mmu-less system.
324 #if ENABLE_NOMMU || \
325 (defined __UCLIBC__ && \
326 UCLIBC_VERSION > KERNEL_VERSION(0, 9, 28) && \
327 !defined __ARCH_USE_MMU__)
329 # define USE_FOR_NOMMU(...) __VA_ARGS__
330 # define USE_FOR_MMU(...)
333 # define USE_FOR_NOMMU(...)
334 # define USE_FOR_MMU(...) __VA_ARGS__
337 #if defined(__digital__) && defined(__unix__)
338 # include <standards.h>
339 # include <inttypes.h>
341 # if !defined ADJ_OFFSET_SINGLESHOT && defined MOD_CLKA && defined MOD_OFFSET
342 # define ADJ_OFFSET_SINGLESHOT (MOD_CLKA | MOD_OFFSET)
344 # if !defined ADJ_FREQUENCY && defined MOD_FREQUENCY
345 # define ADJ_FREQUENCY MOD_FREQUENCY
347 # if !defined ADJ_TIMECONST && defined MOD_TIMECONST
348 # define ADJ_TIMECONST MOD_TIMECONST
350 # if !defined ADJ_TICK && defined MOD_CLKB
351 # define ADJ_TICK MOD_CLKB
355 #if defined(__CYGWIN__)
356 # define MAXSYMLINKS SYMLOOP_MAX
359 #if defined(ANDROID) || defined(__ANDROID__)
360 # define BB_ADDITIONAL_PATH ":/system/sbin:/system/bin:/system/xbin"
361 # define SYS_ioprio_set __NR_ioprio_set
362 # define SYS_ioprio_get __NR_ioprio_get
366 /* ---- Who misses what? ------------------------------------ */
368 /* Assume all these functions and header files exist by default.
369 * Platforms where it is not true will #undef them below.
371 #define HAVE_CLEARENV 1
372 #define HAVE_FDATASYNC 1
373 #define HAVE_DPRINTF 1
374 #define HAVE_MEMRCHR 1
375 #define HAVE_MKDTEMP 1
376 #define HAVE_TTYNAME_R 1
377 #define HAVE_PTSNAME_R 1
378 #define HAVE_SETBIT 1
379 #define HAVE_SIGHANDLER_T 1
380 #define HAVE_STPCPY 1
381 #define HAVE_MEMPCPY 1
382 #define HAVE_STRCASESTR 1
383 #define HAVE_STRCHRNUL 1
384 #define HAVE_STRSEP 1
385 #define HAVE_STRSIGNAL 1
386 #define HAVE_STRVERSCMP 1
387 #define HAVE_VASPRINTF 1
388 #define HAVE_USLEEP 1
389 #define HAVE_UNLOCKED_STDIO 1
390 #define HAVE_UNLOCKED_LINE_OPS 1
391 #define HAVE_GETLINE 1
393 #define HAVE_MNTENT_H 1
394 #define HAVE_NET_ETHERNET_H 1
395 #define HAVE_SYS_STATFS_H 1
397 #if defined(__UCLIBC__)
398 # if UCLIBC_VERSION < KERNEL_VERSION(0, 9, 32)
399 # undef HAVE_STRVERSCMP
401 # if UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 30)
402 # ifndef __UCLIBC_SUSV3_LEGACY__
408 #if defined(__WATCOMC__)
415 # undef HAVE_STRCASESTR
416 # undef HAVE_STRCHRNUL
418 # undef HAVE_STRSIGNAL
419 # undef HAVE_STRVERSCMP
420 # undef HAVE_VASPRINTF
421 # undef HAVE_UNLOCKED_STDIO
422 # undef HAVE_UNLOCKED_LINE_OPS
423 # undef HAVE_NET_ETHERNET_H
426 #if defined(__CYGWIN__)
427 # undef HAVE_CLEARENV
428 # undef HAVE_FDPRINTF
430 # undef HAVE_PTSNAME_R
431 # undef HAVE_STRVERSCMP
432 # undef HAVE_UNLOCKED_LINE_OPS
435 /* These BSD-derived OSes share many similarities */
436 #if (defined __digital__ && defined __unix__) \
437 || defined __APPLE__ \
438 || defined __OpenBSD__ || defined __NetBSD__
439 # undef HAVE_CLEARENV
440 # undef HAVE_FDATASYNC
442 # undef HAVE_MNTENT_H
443 # undef HAVE_PTSNAME_R
444 # undef HAVE_SYS_STATFS_H
445 # undef HAVE_SIGHANDLER_T
446 # undef HAVE_STRVERSCMP
449 # undef HAVE_UNLOCKED_STDIO
450 # undef HAVE_UNLOCKED_LINE_OPS
453 #if defined(__dietlibc__)
454 # undef HAVE_STRCHRNUL
457 #if defined(__APPLE__)
458 # undef HAVE_STRCHRNUL
461 #if defined(__FreeBSD__)
462 /* users say mempcpy is not present in FreeBSD 9.x */
464 # undef HAVE_CLEARENV
465 # 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
472 # undef HAVE_UNLOCKED_LINE_OPS
473 # include <osreldate.h>
474 # if __FreeBSD_version < 1000029
475 # undef HAVE_STRCHRNUL /* FreeBSD added strchrnul() between 1000028 and 1000029 */
479 #if defined(__NetBSD__)
480 # define HAVE_GETLINE 1 /* Recent NetBSD versions have getline() */
483 #if defined(__digital__) && defined(__unix__)
487 #if defined(ANDROID) || defined(__ANDROID__)
488 # if __ANDROID_API__ < 8
489 /* ANDROID < 8 has no [f]dprintf at all */
491 # elif __ANDROID_API__ < 21
492 /* ANDROID < 21 has fdprintf */
493 # define dprintf fdprintf
495 /* ANDROID >= 21 has standard dprintf */
497 # if __ANDROID_API__ < 21
498 # undef HAVE_TTYNAME_R
503 # undef HAVE_STRCHRNUL
504 # undef HAVE_STRVERSCMP
505 # undef HAVE_UNLOCKED_LINE_OPS
506 # undef HAVE_NET_ETHERNET_H
510 * Now, define prototypes for all the functions defined in platform.c
511 * These must come after all the HAVE_* macros are defined (or not)
515 extern int dprintf(int fd, const char *format, ...);
519 extern void *memrchr(const void *s, int c, size_t n) FAST_FUNC;
523 extern char *mkdtemp(char *template) FAST_FUNC;
526 #ifndef HAVE_TTYNAME_R
527 #define ttyname_r bb_ttyname_r
528 extern int ttyname_r(int fd, char *buf, size_t buflen);
532 # define setbit(a, b) ((a)[(b) >> 3] |= 1 << ((b) & 7))
533 # define clrbit(a, b) ((a)[(b) >> 3] &= ~(1 << ((b) & 7)))
536 #ifndef HAVE_SIGHANDLER_T
537 typedef void (*sighandler_t)(int);
541 extern char *stpcpy(char *p, const char *to_add) FAST_FUNC;
546 /* In case we are wrong about !HAVE_MEMPCPY, and toolchain _does_ have
547 * mempcpy(), avoid colliding with it:
549 #define mempcpy bb__mempcpy
550 static ALWAYS_INLINE void *mempcpy(void *dest, const void *src, size_t len)
552 return memcpy(dest, src, len) + len;
556 #ifndef HAVE_STRCASESTR
557 extern char *strcasestr(const char *s, const char *pattern) FAST_FUNC;
560 #ifndef HAVE_STRCHRNUL
561 extern char *strchrnul(const char *s, int c) FAST_FUNC;
565 extern char *strsep(char **stringp, const char *delim) FAST_FUNC;
568 #ifndef HAVE_STRSIGNAL
569 /* Not exactly the same: instead of "Stopped" it shows "STOP" etc */
570 # define strsignal(sig) get_signame(sig)
574 extern int usleep(unsigned) FAST_FUNC;
577 #ifndef HAVE_VASPRINTF
578 extern int vasprintf(char **string_ptr, const char *format, va_list p) FAST_FUNC;
582 # include <stdio.h> /* for FILE */
583 # include <sys/types.h> /* size_t */
584 extern ssize_t getline(char **lineptr, size_t *n, FILE *stream) FAST_FUNC;