include/platform.h

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Copyright 2006, Bernhard Reutner-Fischer
   4  *
   5  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
   6  */
   7 #ifndef BB_PLATFORM_H
   8 #define BB_PLATFORM_H 1
   9
  10
  11 /* Convenience macros to test the version of gcc. */
  12 #undef __GNUC_PREREQ
  13 #if defined __GNUC__ && defined __GNUC_MINOR__
  14 # define __GNUC_PREREQ(maj, min) \
  15                 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
  16 #else
  17 # define __GNUC_PREREQ(maj, min) 0
  18 #endif
  19
  20 /* __restrict is known in EGCS 1.2 and above. */
  21 #if !__GNUC_PREREQ(2,92)
  22 # ifndef __restrict
  23 #  define __restrict
  24 # endif
  25 #endif
  26
  27 #if !__GNUC_PREREQ(2,7)
  28 # ifndef __attribute__
  29 #  define __attribute__(x)
  30 # endif
  31 #endif
  32
  33 #undef inline
  34 #if defined(__STDC_VERSION__) && __STDC_VERSION__ > 199901L
  35 /* it's a keyword */
  36 #elif __GNUC_PREREQ(2,7)
  37 # define inline __inline__
  38 #else
  39 # define inline
  40 #endif
  41
  42 #ifndef __const
  43 # define __const const
  44 #endif
  45
  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."
  55  */
  56 #define RETURNS_MALLOC __attribute__ ((malloc))
  57 #define PACKED __attribute__ ((__packed__))
  58 #define ALIGNED(m) __attribute__ ((__aligned__(m)))
  59
  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__))
  65 # if !ENABLE_WERROR
  66 #  define DEPRECATED __attribute__ ((__deprecated__))
  67 #  define UNUSED_PARAM_RESULT __attribute__ ((warn_unused_result))
  68 # else
  69 #  define DEPRECATED
  70 #  define UNUSED_PARAM_RESULT
  71 # endif
  72 #else
  73 # define ALWAYS_INLINE inline
  74 # define NOINLINE
  75 # define DEPRECATED
  76 # define UNUSED_PARAM_RESULT
  77 #endif
  78
  79 /* -fwhole-program makes all symbols local. The attribute externally_visible
  80  * forces a symbol global.  */
  81 #if __GNUC_PREREQ(4,1)
  82 # define EXTERNALLY_VISIBLE __attribute__(( visibility("default") ))
  83 //__attribute__ ((__externally_visible__))
  84 #else
  85 # define EXTERNALLY_VISIBLE
  86 #endif
  87
  88 /* At 4.4 gcc become much more anal about this, need to use "aliased" types */
  89 #if __GNUC_PREREQ(4,4)
  90 # define FIX_ALIASING __attribute__((__may_alias__))
  91 #else
  92 # define FIX_ALIASING
  93 #endif
  94
  95 /* We use __extension__ in some places to suppress -pedantic warnings
  96  * about GCC extensions.  This feature didn't work properly before
  97  * gcc 2.8.  */
  98 #if !__GNUC_PREREQ(2,8)
  99 # ifndef __extension__
 100 #  define __extension__
 101 # endif
 102 #endif
 103
 104 /* FAST_FUNC is a qualifier which (possibly) makes function call faster
 105  * and/or smaller by using modified ABI. It is usually only needed
 106  * on non-static, busybox internal functions. Recent versions of gcc
 107  * optimize statics automatically. FAST_FUNC on static is required
 108  * only if you need to match a function pointer's type */
 109 #if __GNUC_PREREQ(3,0) && defined(i386) /* || defined(__x86_64__)? */
 110 /* stdcall makes callee to pop arguments from stack, not caller */
 111 # define FAST_FUNC __attribute__((regparm(3),stdcall))
 112 /* #elif ... - add your favorite arch today! */
 113 #else
 114 # define FAST_FUNC
 115 #endif
 116
 117 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
 118 /* (don't include system headers after this until corresponding pop!) */
 119 #if __GNUC_PREREQ(4,1) && !defined(__CYGWIN__)
 120 # define PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN _Pragma("GCC visibility push(hidden)")
 121 # define POP_SAVED_FUNCTION_VISIBILITY              _Pragma("GCC visibility pop")
 122 #else
 123 # define PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
 124 # define POP_SAVED_FUNCTION_VISIBILITY
 125 #endif
 126
 127 /* gcc-2.95 had no va_copy but only __va_copy. */
 128 #if !__GNUC_PREREQ(3,0)
 129 # include <stdarg.h>
 130 # if !defined va_copy && defined __va_copy
 131 #  define va_copy(d,s) __va_copy((d),(s))
 132 # endif
 133 #endif
 134
 135
 136 /* ---- Endian Detection ------------------------------------ */
 137
 138 #include <limits.h>
 139 #if defined(__digital__) && defined(__unix__)
 140 # include <sex.h>
 141 #elif defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
 142    || defined(__APPLE__)
 143 # include <sys/resource.h>  /* rlimit */
 144 # include <machine/endian.h>
 145 # define bswap_64 __bswap64
 146 # define bswap_32 __bswap32
 147 # define bswap_16 __bswap16
 148 #else
 149 # include <byteswap.h>
 150 # include <endian.h>
 151 #endif
 152
 153 #if defined(__BYTE_ORDER) && __BYTE_ORDER == __BIG_ENDIAN
 154 # define BB_BIG_ENDIAN 1
 155 # define BB_LITTLE_ENDIAN 0
 156 #elif defined(__BYTE_ORDER) && __BYTE_ORDER == __LITTLE_ENDIAN
 157 # define BB_BIG_ENDIAN 0
 158 # define BB_LITTLE_ENDIAN 1
 159 #elif defined(_BYTE_ORDER) && _BYTE_ORDER == _BIG_ENDIAN
 160 # define BB_BIG_ENDIAN 1
 161 # define BB_LITTLE_ENDIAN 0
 162 #elif defined(_BYTE_ORDER) && _BYTE_ORDER == _LITTLE_ENDIAN
 163 # define BB_BIG_ENDIAN 0
 164 # define BB_LITTLE_ENDIAN 1
 165 #elif defined(BYTE_ORDER) && BYTE_ORDER == BIG_ENDIAN
 166 # define BB_BIG_ENDIAN 1
 167 # define BB_LITTLE_ENDIAN 0
 168 #elif defined(BYTE_ORDER) && BYTE_ORDER == LITTLE_ENDIAN
 169 # define BB_BIG_ENDIAN 0
 170 # define BB_LITTLE_ENDIAN 1
 171 #elif defined(__386__)
 172 # define BB_BIG_ENDIAN 0
 173 # define BB_LITTLE_ENDIAN 1
 174 #else
 175 # error "Can't determine endianness"
 176 #endif
 177
 178 #if ULONG_MAX > 0xffffffff
 179 # define bb_bswap_64(x) bswap_64(x)
 180 #endif
 181
 182 /* SWAP_LEnn means "convert CPU<->little_endian by swapping bytes" */
 183 #if BB_BIG_ENDIAN
 184 # define SWAP_BE16(x) (x)
 185 # define SWAP_BE32(x) (x)
 186 # define SWAP_BE64(x) (x)
 187 # define SWAP_LE16(x) bswap_16(x)
 188 # define SWAP_LE32(x) bswap_32(x)
 189 # define SWAP_LE64(x) bb_bswap_64(x)
 190 # define IF_BIG_ENDIAN(...) __VA_ARGS__
 191 # define IF_LITTLE_ENDIAN(...)
 192 #else
 193 # define SWAP_BE16(x) bswap_16(x)
 194 # define SWAP_BE32(x) bswap_32(x)
 195 # define SWAP_BE64(x) bb_bswap_64(x)
 196 # define SWAP_LE16(x) (x)
 197 # define SWAP_LE32(x) (x)
 198 # define SWAP_LE64(x) (x)
 199 # define IF_BIG_ENDIAN(...)
 200 # define IF_LITTLE_ENDIAN(...) __VA_ARGS__
 201 #endif
 202
 203
 204 /* ---- Unaligned access ------------------------------------ */
 205
 206 #include <stdint.h>
 207 typedef int      bb__aliased_int      FIX_ALIASING;
 208 typedef long     bb__aliased_long     FIX_ALIASING;
 209 typedef uint16_t bb__aliased_uint16_t FIX_ALIASING;
 210 typedef uint32_t bb__aliased_uint32_t FIX_ALIASING;
 211 typedef uint64_t bb__aliased_uint64_t FIX_ALIASING;
 212
 213 /* NB: unaligned parameter should be a pointer, aligned one -
 214  * a lvalue. This makes it more likely to not swap them by mistake
 215  */
 216 #if defined(i386) || defined(__x86_64__) || defined(__powerpc__)
 217 # define move_from_unaligned_int(v, intp)  ((v) = *(bb__aliased_int*)(intp))
 218 # define move_from_unaligned_long(v, longp) ((v) = *(bb__aliased_long*)(longp))
 219 # define move_from_unaligned16(v, u16p) ((v) = *(bb__aliased_uint16_t*)(u16p))
 220 # define move_from_unaligned32(v, u32p) ((v) = *(bb__aliased_uint32_t*)(u32p))
 221 # define move_to_unaligned16(u16p, v)   (*(bb__aliased_uint16_t*)(u16p) = (v))
 222 # define move_to_unaligned32(u32p, v)   (*(bb__aliased_uint32_t*)(u32p) = (v))
 223 /* #elif ... - add your favorite arch today! */
 224 #else
 225 /* performs reasonably well (gcc usually inlines memcpy here) */
 226 # define move_from_unaligned_int(v, intp) (memcpy(&(v), (intp), sizeof(int)))
 227 # define move_from_unaligned_long(v, longp) (memcpy(&(v), (longp), sizeof(long)))
 228 # define move_from_unaligned16(v, u16p) (memcpy(&(v), (u16p), 2))
 229 # define move_from_unaligned32(v, u32p) (memcpy(&(v), (u32p), 4))
 230 # define move_to_unaligned16(u16p, v) do { \
 231         uint16_t __t = (v); \
 232         memcpy((u16p), &__t, 2); \
 233 } while (0)
 234 # define move_to_unaligned32(u32p, v) do { \
 235         uint32_t __t = (v); \
 236         memcpy((u32p), &__t, 4); \
 237 } while (0)
 238 #endif
 239
 240
 241 /* ---- Size-saving "small" ints (arch-dependent) ----------- */
 242
 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
 263 /*----- Kernel versioning ------------------------------------*/
 264
 265 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
 266
 267 #ifdef __UCLIBC__
 268 # define UCLIBC_VERSION KERNEL_VERSION(__UCLIBC_MAJOR__, __UCLIBC_MINOR__, __UCLIBC_SUBLEVEL__)
 269 #else
 270 # define UCLIBC_VERSION 0
 271 #endif
 272
 273
 274 /* ---- Miscellaneous --------------------------------------- */
 275
 276 #if defined __GLIBC__ \
 277  || defined __UCLIBC__ \
 278  || defined __dietlibc__ \
 279  || defined __BIONIC__ \
 280  || defined _NEWLIB_VERSION
 281 # include <features.h>
 282 #endif
 283
 284 /* Define bb_setpgrp */
 285 #if defined(__digital__) && defined(__unix__)
 286 /* use legacy setpgrp(pid_t, pid_t) for now.  move to platform.c */
 287 # define bb_setpgrp() do { pid_t __me = getpid(); setpgrp(__me, __me); } while (0)
 288 #else
 289 # define bb_setpgrp() setpgrp()
 290 #endif
 291
 292 /* fdprintf is more readable, we used it before dprintf was standardized */
 293 #include <unistd.h>
 294 #define fdprintf dprintf
 295
 296 /* Useful for defeating gcc's alignment of "char message[]"-like data */
 297 #if !defined(__s390__)
 298     /* on s390[x], non-word-aligned data accesses require larger code */
 299 # define ALIGN1 __attribute__((aligned(1)))
 300 # define ALIGN2 __attribute__((aligned(2)))
 301 # define ALIGN4 __attribute__((aligned(4)))
 302 #else
 303 /* Arches which MUST have 2 or 4 byte alignment for everything are here */
 304 # define ALIGN1
 305 # define ALIGN2
 306 # define ALIGN4
 307 #endif
 308
 309 /*
 310  * For 0.9.29 and svn, __ARCH_USE_MMU__ indicates no-mmu reliably.
 311  * For earlier versions there is no reliable way to check if we are building
 312  * for a mmu-less system.
 313  */
 314 #if ENABLE_NOMMU || \
 315     (defined __UCLIBC__ && \
 316      UCLIBC_VERSION > KERNEL_VERSION(0, 9, 28) && \
 317      !defined __ARCH_USE_MMU__)
 318 # define BB_MMU 0
 319 # define USE_FOR_NOMMU(...) __VA_ARGS__
 320 # define USE_FOR_MMU(...)
 321 #else
 322 # define BB_MMU 1
 323 # define USE_FOR_NOMMU(...)
 324 # define USE_FOR_MMU(...) __VA_ARGS__
 325 #endif
 326
 327 #if defined(__digital__) && defined(__unix__)
 328 # include <standards.h>
 329 # include <inttypes.h>
 330 # define PRIu32 "u"
 331 # if !defined ADJ_OFFSET_SINGLESHOT && defined MOD_CLKA && defined MOD_OFFSET
 332 #  define ADJ_OFFSET_SINGLESHOT (MOD_CLKA | MOD_OFFSET)
 333 # endif
 334 # if !defined ADJ_FREQUENCY && defined MOD_FREQUENCY
 335 #  define ADJ_FREQUENCY MOD_FREQUENCY
 336 # endif
 337 # if !defined ADJ_TIMECONST && defined MOD_TIMECONST
 338 #  define ADJ_TIMECONST MOD_TIMECONST
 339 # endif
 340 # if !defined ADJ_TICK && defined MOD_CLKB
 341 #  define ADJ_TICK MOD_CLKB
 342 # endif
 343 #endif
 344
 345 #if defined(__CYGWIN__)
 346 # define MAXSYMLINKS SYMLOOP_MAX
 347 #endif
 348
 349 #if defined(ANDROID) || defined(__ANDROID__)
 350 # define BB_ADDITIONAL_PATH ":/system/sbin:/system/bin:/system/xbin"
 351 # define SYS_ioprio_set __NR_ioprio_set
 352 # define SYS_ioprio_get __NR_ioprio_get
 353 #endif
 354
 355
 356 /* ---- Who misses what? ------------------------------------ */
 357
 358 /* Assume all these functions and header files exist by default.
 359  * Platforms where it is not true will #undef them below.
 360  */
 361 #define HAVE_CLEARENV 1
 362 #define HAVE_FDATASYNC 1
 363 #define HAVE_DPRINTF 1
 364 #define HAVE_MEMRCHR 1
 365 #define HAVE_MKDTEMP 1
 366 #define HAVE_PTSNAME_R 1
 367 #define HAVE_SETBIT 1
 368 #define HAVE_SIGHANDLER_T 1
 369 #define HAVE_STPCPY 1
 370 #define HAVE_STRCASESTR 1
 371 #define HAVE_STRCHRNUL 1
 372 #define HAVE_STRSEP 1
 373 #define HAVE_STRSIGNAL 1
 374 #define HAVE_STRVERSCMP 1
 375 #define HAVE_VASPRINTF 1
 376 #define HAVE_UNLOCKED_STDIO 1
 377 #define HAVE_UNLOCKED_LINE_OPS 1
 378 #define HAVE_GETLINE 1
 379 #define HAVE_XTABS 1
 380 #define HAVE_MNTENT_H 1
 381 #define HAVE_NET_ETHERNET_H 1
 382 #define HAVE_SYS_STATFS_H 1
 383
 384 #if defined(__UCLIBC__) && UCLIBC_VERSION < KERNEL_VERSION(0, 9, 32)
 385 # undef HAVE_STRVERSCMP
 386 #endif
 387
 388 #if defined(__dietlibc__)
 389 # undef HAVE_STRCHRNUL
 390 #endif
 391
 392 #if defined(__WATCOMC__)
 393 # undef HAVE_DPRINTF
 394 # undef HAVE_GETLINE
 395 # undef HAVE_MEMRCHR
 396 # undef HAVE_MKDTEMP
 397 # undef HAVE_SETBIT
 398 # undef HAVE_STPCPY
 399 # undef HAVE_STRCASESTR
 400 # undef HAVE_STRCHRNUL
 401 # undef HAVE_STRSEP
 402 # undef HAVE_STRSIGNAL
 403 # undef HAVE_STRVERSCMP
 404 # undef HAVE_VASPRINTF
 405 # undef HAVE_UNLOCKED_STDIO
 406 # undef HAVE_UNLOCKED_LINE_OPS
 407 # undef HAVE_NET_ETHERNET_H
 408 #endif
 409
 410 #if defined(__CYGWIN__)
 411 # undef HAVE_CLEARENV
 412 # undef HAVE_FDPRINTF
 413 # undef HAVE_MEMRCHR
 414 # undef HAVE_PTSNAME_R
 415 # undef HAVE_STRVERSCMP
 416 # undef HAVE_UNLOCKED_LINE_OPS
 417 #endif
 418
 419 /* These BSD-derived OSes share many similarities */
 420 #if (defined __digital__ && defined __unix__) \
 421  || defined __APPLE__ \
 422  || defined __FreeBSD__ || defined __OpenBSD__ || defined __NetBSD__
 423 # undef HAVE_CLEARENV
 424 # undef HAVE_FDATASYNC
 425 # undef HAVE_GETLINE
 426 # undef HAVE_MNTENT_H
 427 # undef HAVE_PTSNAME_R
 428 # undef HAVE_SYS_STATFS_H
 429 # undef HAVE_SIGHANDLER_T
 430 # undef HAVE_STRVERSCMP
 431 # undef HAVE_XTABS
 432 # undef HAVE_DPRINTF
 433 # undef HAVE_UNLOCKED_STDIO
 434 # undef HAVE_UNLOCKED_LINE_OPS
 435 #endif
 436
 437 #if defined(__FreeBSD__) || defined(__APPLE__)
 438 # undef HAVE_STRCHRNUL
 439 #endif
 440
 441 #if defined(__NetBSD__)
 442 # define HAVE_GETLINE 1  /* Recent NetBSD versions have getline() */
 443 #endif
 444
 445 #if defined(__digital__) && defined(__unix__)
 446 # undef HAVE_STPCPY
 447 #endif
 448
 449 #if defined(ANDROID) || defined(__ANDROID__)
 450 # undef HAVE_DPRINTF
 451 # undef HAVE_GETLINE
 452 # undef HAVE_STPCPY
 453 # undef HAVE_STRCHRNUL
 454 # undef HAVE_STRVERSCMP
 455 # undef HAVE_UNLOCKED_LINE_OPS
 456 # undef HAVE_NET_ETHERNET_H
 457 #endif
 458
 459 /*
 460  * Now, define prototypes for all the functions defined in platform.c
 461  * These must come after all the HAVE_* macros are defined (or not)
 462  */
 463
 464 #ifndef HAVE_DPRINTF
 465 extern int dprintf(int fd, const char *format, ...);
 466 #endif
 467
 468 #ifndef HAVE_MEMRCHR
 469 extern void *memrchr(const void *s, int c, size_t n) FAST_FUNC;
 470 #endif
 471
 472 #ifndef HAVE_MKDTEMP
 473 extern char *mkdtemp(char *template) FAST_FUNC;
 474 #endif
 475
 476 #ifndef HAVE_SETBIT
 477 # define setbit(a, b)  ((a)[(b) >> 3] |= 1 << ((b) & 7))
 478 # define clrbit(a, b)  ((a)[(b) >> 3] &= ~(1 << ((b) & 7)))
 479 #endif
 480
 481 #ifndef HAVE_SIGHANDLER_T
 482 typedef void (*sighandler_t)(int);
 483 #endif
 484
 485 #ifndef HAVE_STPCPY
 486 extern char *stpcpy(char *p, const char *to_add) FAST_FUNC;
 487 #endif
 488
 489 #ifndef HAVE_STRCASESTR
 490 extern char *strcasestr(const char *s, const char *pattern) FAST_FUNC;
 491 #endif
 492
 493 #ifndef HAVE_STRCHRNUL
 494 extern char *strchrnul(const char *s, int c) FAST_FUNC;
 495 #endif
 496
 497 #ifndef HAVE_STRSEP
 498 extern char *strsep(char **stringp, const char *delim) FAST_FUNC;
 499 #endif
 500
 501 #ifndef HAVE_STRSIGNAL
 502 /* Not exactly the same: instead of "Stopped" it shows "STOP" etc */
 503 # define strsignal(sig) get_signame(sig)
 504 #endif
 505
 506 #ifndef HAVE_VASPRINTF
 507 extern int vasprintf(char **string_ptr, const char *format, va_list p) FAST_FUNC;
 508 #endif
 509
 510 #ifndef HAVE_GETLINE
 511 # include <stdio.h> /* for FILE */
 512 # include <sys/types.h> /* size_t */
 513 extern ssize_t getline(char **lineptr, size_t *n, FILE *stream) FAST_FUNC;
 514 #endif
 515
 516 #endif