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 /* Assume all these functions exist by default.  Platforms where it is not
  11  * true will #undef them below.
  12  */
  13 #define HAVE_FDPRINTF 1
  14 #define HAVE_MEMRCHR 1
  15 #define HAVE_MKDTEMP 1
  16 #define HAVE_SETBIT 1
  17 #define HAVE_SIGHANDLER_T 1
  18 #define HAVE_STRCASESTR 1
  19 #define HAVE_STRCHRNUL 1
  20 #define HAVE_STRSEP 1
  21 #define HAVE_STRSIGNAL 1
  22 #define HAVE_VASPRINTF 1
  23
  24 /* Convenience macros to test the version of gcc. */
  25 #undef __GNUC_PREREQ
  26 #if defined __GNUC__ && defined __GNUC_MINOR__
  27 # define __GNUC_PREREQ(maj, min) \
  28                 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
  29 #else
  30 # define __GNUC_PREREQ(maj, min) 0
  31 #endif
  32
  33 /* __restrict is known in EGCS 1.2 and above. */
  34 #if !__GNUC_PREREQ(2,92)
  35 # ifndef __restrict
  36 #  define __restrict
  37 # endif
  38 #endif
  39
  40 /* Define macros for some gcc attributes.  This permits us to use the
  41    macros freely, and know that they will come into play for the
  42    version of gcc in which they are supported.  */
  43
  44 #if !__GNUC_PREREQ(2,7)
  45 # ifndef __attribute__
  46 #  define __attribute__(x)
  47 # endif
  48 #endif
  49
  50 #undef inline
  51 #if defined(__STDC_VERSION__) && __STDC_VERSION__ > 199901L
  52 /* it's a keyword */
  53 #elif __GNUC_PREREQ(2,7)
  54 # define inline __inline__
  55 #else
  56 # define inline
  57 #endif
  58
  59 #ifndef __const
  60 # define __const const
  61 #endif
  62
  63 #define UNUSED_PARAM __attribute__ ((__unused__))
  64 #define NORETURN __attribute__ ((__noreturn__))
  65 /* "The malloc attribute is used to tell the compiler that a function
  66  * may be treated as if any non-NULL pointer it returns cannot alias
  67  * any other pointer valid when the function returns. This will often
  68  * improve optimization. Standard functions with this property include
  69  * malloc and calloc. realloc-like functions have this property as long
  70  * as the old pointer is never referred to (including comparing it
  71  * to the new pointer) after the function returns a non-NULL value."
  72  */
  73 #define RETURNS_MALLOC __attribute__ ((malloc))
  74 #define PACKED __attribute__ ((__packed__))
  75 #define ALIGNED(m) __attribute__ ((__aligned__(m)))
  76
  77 /* __NO_INLINE__: some gcc's do not honor inlining! :( */
  78 #if __GNUC_PREREQ(3,0) && !defined(__NO_INLINE__)
  79 # define ALWAYS_INLINE __attribute__ ((always_inline)) inline
  80 /* I've seen a toolchain where I needed __noinline__ instead of noinline */
  81 # define NOINLINE      __attribute__((__noinline__))
  82 # if !ENABLE_WERROR
  83 #  define DEPRECATED __attribute__ ((__deprecated__))
  84 #  define UNUSED_PARAM_RESULT __attribute__ ((warn_unused_result))
  85 # else
  86 #  define DEPRECATED
  87 #  define UNUSED_PARAM_RESULT
  88 # endif
  89 #else
  90 # define ALWAYS_INLINE inline
  91 # define NOINLINE
  92 # define DEPRECATED
  93 # define UNUSED_PARAM_RESULT
  94 #endif
  95
  96 /* -fwhole-program makes all symbols local. The attribute externally_visible
  97    forces a symbol global.  */
  98 #if __GNUC_PREREQ(4,1)
  99 # define EXTERNALLY_VISIBLE __attribute__(( visibility("default") ))
 100 //__attribute__ ((__externally_visible__))
 101 #else
 102 # define EXTERNALLY_VISIBLE
 103 #endif
 104
 105 /* At 4.4 gcc become much more anal about this, need to use "aliased" types */
 106 #if __GNUC_PREREQ(4,4)
 107 # define FIX_ALIASING __attribute__((__may_alias__))
 108 #else
 109 # define FIX_ALIASING
 110 #endif
 111
 112 /* We use __extension__ in some places to suppress -pedantic warnings
 113    about GCC extensions.  This feature didn't work properly before
 114    gcc 2.8.  */
 115 #if !__GNUC_PREREQ(2,8)
 116 # ifndef __extension__
 117 #  define __extension__
 118 # endif
 119 #endif
 120
 121 /* gcc-2.95 had no va_copy but only __va_copy. */
 122 #if !__GNUC_PREREQ(3,0)
 123 # include <stdarg.h>
 124 # if !defined va_copy && defined __va_copy
 125 #  define va_copy(d,s) __va_copy((d),(s))
 126 # endif
 127 #endif
 128
 129 /* FAST_FUNC is a qualifier which (possibly) makes function call faster
 130  * and/or smaller by using modified ABI. It is usually only needed
 131  * on non-static, busybox internal functions. Recent versions of gcc
 132  * optimize statics automatically. FAST_FUNC on static is required
 133  * only if you need to match a function pointer's type */
 134 #if __GNUC_PREREQ(3,0) && defined(i386) /* || defined(__x86_64__)? */
 135 /* stdcall makes callee to pop arguments from stack, not caller */
 136 # define FAST_FUNC __attribute__((regparm(3),stdcall))
 137 /* #elif ... - add your favorite arch today! */
 138 #else
 139 # define FAST_FUNC
 140 #endif
 141
 142 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
 143 /* (don't include system headers after this until corresponding pop!) */
 144 #if __GNUC_PREREQ(4,1)
 145 # define PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN _Pragma("GCC visibility push(hidden)")
 146 # define POP_SAVED_FUNCTION_VISIBILITY              _Pragma("GCC visibility pop")
 147 #else
 148 # define PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
 149 # define POP_SAVED_FUNCTION_VISIBILITY
 150 #endif
 151
 152 /* ---- Endian Detection ------------------------------------ */
 153
 154 #include <limits.h>
 155 #if defined(__digital__) && defined(__unix__)
 156 # include <sex.h>
 157 #elif defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
 158    || defined(__APPLE__)
 159 # include <sys/resource.h>  /* rlimit */
 160 # include <machine/endian.h>
 161 # define bswap_64 __bswap64
 162 # define bswap_32 __bswap32
 163 # define bswap_16 __bswap16
 164 #else
 165 # include <byteswap.h>
 166 # include <endian.h>
 167 #endif
 168
 169 #if defined(__BYTE_ORDER) && __BYTE_ORDER == __BIG_ENDIAN
 170 # define BB_BIG_ENDIAN 1
 171 # define BB_LITTLE_ENDIAN 0
 172 #elif defined(__BYTE_ORDER) && __BYTE_ORDER == __LITTLE_ENDIAN
 173 # define BB_BIG_ENDIAN 0
 174 # define BB_LITTLE_ENDIAN 1
 175 #elif defined(_BYTE_ORDER) && _BYTE_ORDER == _BIG_ENDIAN
 176 # define BB_BIG_ENDIAN 1
 177 # define BB_LITTLE_ENDIAN 0
 178 #elif defined(_BYTE_ORDER) && _BYTE_ORDER == _LITTLE_ENDIAN
 179 # define BB_BIG_ENDIAN 0
 180 # define BB_LITTLE_ENDIAN 1
 181 #elif defined(BYTE_ORDER) && BYTE_ORDER == BIG_ENDIAN
 182 # define BB_BIG_ENDIAN 1
 183 # define BB_LITTLE_ENDIAN 0
 184 #elif defined(BYTE_ORDER) && BYTE_ORDER == LITTLE_ENDIAN
 185 # define BB_BIG_ENDIAN 0
 186 # define BB_LITTLE_ENDIAN 1
 187 #elif defined(__386__)
 188 # define BB_BIG_ENDIAN 0
 189 # define BB_LITTLE_ENDIAN 1
 190 #else
 191 # error "Can't determine endianness"
 192 #endif
 193
 194 #if ULONG_MAX > 0xffffffff
 195 # define bb_bswap_64(x) bswap_64(x)
 196 #endif
 197
 198 /* SWAP_LEnn means "convert CPU<->little_endian by swapping bytes" */
 199 #if BB_BIG_ENDIAN
 200 # define SWAP_BE16(x) (x)
 201 # define SWAP_BE32(x) (x)
 202 # define SWAP_BE64(x) (x)
 203 # define SWAP_LE16(x) bswap_16(x)
 204 # define SWAP_LE32(x) bswap_32(x)
 205 # define SWAP_LE64(x) bb_bswap_64(x)
 206 # define IF_BIG_ENDIAN(...) __VA_ARGS__
 207 # define IF_LITTLE_ENDIAN(...)
 208 #else
 209 # define SWAP_BE16(x) bswap_16(x)
 210 # define SWAP_BE32(x) bswap_32(x)
 211 # define SWAP_BE64(x) bb_bswap_64(x)
 212 # define SWAP_LE16(x) (x)
 213 # define SWAP_LE32(x) (x)
 214 # define SWAP_LE64(x) (x)
 215 # define IF_BIG_ENDIAN(...)
 216 # define IF_LITTLE_ENDIAN(...) __VA_ARGS__
 217 #endif
 218
 219 /* ---- Unaligned access ------------------------------------ */
 220
 221 /* NB: unaligned parameter should be a pointer, aligned one -
 222  * a lvalue. This makes it more likely to not swap them by mistake
 223  */
 224 #if defined(i386) || defined(__x86_64__) || defined(__powerpc__)
 225 # include <stdint.h>
 226 typedef int      bb__aliased_int      FIX_ALIASING;
 227 typedef uint16_t bb__aliased_uint16_t FIX_ALIASING;
 228 typedef uint32_t bb__aliased_uint32_t FIX_ALIASING;
 229 # define move_from_unaligned_int(v, intp) ((v) = *(bb__aliased_int*)(intp))
 230 # define move_from_unaligned16(v, u16p) ((v) = *(bb__aliased_uint16_t*)(u16p))
 231 # define move_from_unaligned32(v, u32p) ((v) = *(bb__aliased_uint32_t*)(u32p))
 232 # define move_to_unaligned16(u16p, v)   (*(bb__aliased_uint16_t*)(u16p) = (v))
 233 # define move_to_unaligned32(u32p, v)   (*(bb__aliased_uint32_t*)(u32p) = (v))
 234 /* #elif ... - add your favorite arch today! */
 235 #else
 236 /* performs reasonably well (gcc usually inlines memcpy here) */
 237 # define move_from_unaligned_int(v, intp) (memcpy(&(v), (intp), sizeof(int)))
 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, 4); \
 243 } while (0)
 244 # define move_to_unaligned32(u32p, v) do { \
 245         uint32_t __t = (v); \
 246         memcpy((u32p), &__t, 4); \
 247 } while (0)
 248 #endif
 249
 250 /* ---- Compiler dependent settings ------------------------- */
 251
 252 #if (defined __digital__ && defined __unix__) \
 253  || defined __APPLE__ \
 254  || defined __FreeBSD__ || defined __OpenBSD__ || defined __NetBSD__
 255 # undef HAVE_MNTENT_H
 256 # undef HAVE_SYS_STATFS_H
 257 # undef HAVE_SIGHANDLER_T
 258 #else
 259 # define HAVE_MNTENT_H 1
 260 # define HAVE_SYS_STATFS_H 1
 261 #endif
 262
 263 /*----- Kernel versioning ------------------------------------*/
 264
 265 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
 266
 267 /* ---- Miscellaneous --------------------------------------- */
 268
 269 #if defined __GLIBC__ || defined __UCLIBC__ \
 270  || defined __dietlibc__ || defined _NEWLIB_VERSION
 271 # include <features.h>
 272 #endif
 273
 274 /* Size-saving "small" ints (arch-dependent) */
 275 #if defined(i386) || defined(__x86_64__) || defined(__mips__) || defined(__cris__)
 276 /* add other arches which benefit from this... */
 277 typedef signed char smallint;
 278 typedef unsigned char smalluint;
 279 #else
 280 /* for arches where byte accesses generate larger code: */
 281 typedef int smallint;
 282 typedef unsigned smalluint;
 283 #endif
 284
 285 /* ISO C Standard:  7.16  Boolean type and values  <stdbool.h> */
 286 #if (defined __digital__ && defined __unix__)
 287 /* old system without (proper) C99 support */
 288 # define bool smalluint
 289 #else
 290 /* modern system, so use it */
 291 # include <stdbool.h>
 292 #endif
 293
 294 /* Try to defeat gcc's alignment of "char message[]"-like data */
 295 #if 1 /* if needed: !defined(arch1) && !defined(arch2) */
 296 # define ALIGN1 __attribute__((aligned(1)))
 297 # define ALIGN2 __attribute__((aligned(2)))
 298 # define ALIGN4 __attribute__((aligned(4)))
 299 #else
 300 /* Arches which MUST have 2 or 4 byte alignment for everything are here */
 301 # define ALIGN1
 302 # define ALIGN2
 303 # define ALIGN4
 304 #endif
 305
 306
 307 /* uclibc does not implement daemon() for no-mmu systems.
 308  * For 0.9.29 and svn, __ARCH_USE_MMU__ indicates no-mmu reliably.
 309  * For earlier versions there is no reliable way to check if we are building
 310  * for a mmu-less system.
 311  */
 312 #if ENABLE_NOMMU || \
 313     (defined __UCLIBC__ && __UCLIBC_MAJOR__ >= 0 && __UCLIBC_MINOR__ >= 9 && \
 314     __UCLIBC_SUBLEVEL__ > 28 && !defined __ARCH_USE_MMU__)
 315 # define BB_MMU 0
 316 # define USE_FOR_NOMMU(...) __VA_ARGS__
 317 # define USE_FOR_MMU(...)
 318 #else
 319 # define BB_MMU 1
 320 # define USE_FOR_NOMMU(...)
 321 # define USE_FOR_MMU(...) __VA_ARGS__
 322 #endif
 323
 324 /* Don't use lchown with glibc older than 2.1.x */
 325 #if defined(__GLIBC__) && __GLIBC__ <= 2 && __GLIBC_MINOR__ < 1
 326 # define lchown chown
 327 #endif
 328
 329 #if defined(__digital__) && defined(__unix__)
 330
 331 # include <standards.h>
 332 # include <inttypes.h>
 333 # define PRIu32 "u"
 334 /* use legacy setpgrp(pid_t,pid_t) for now.  move to platform.c */
 335 # define bb_setpgrp() do { pid_t __me = getpid(); setpgrp(__me, __me); } while (0)
 336 # if !defined ADJ_OFFSET_SINGLESHOT && defined MOD_CLKA && defined MOD_OFFSET
 337 #  define ADJ_OFFSET_SINGLESHOT (MOD_CLKA | MOD_OFFSET)
 338 # endif
 339 # if !defined ADJ_FREQUENCY && defined MOD_FREQUENCY
 340 #  define ADJ_FREQUENCY MOD_FREQUENCY
 341 # endif
 342 # if !defined ADJ_TIMECONST && defined MOD_TIMECONST
 343 #  define ADJ_TIMECONST MOD_TIMECONST
 344 # endif
 345 # if !defined ADJ_TICK && defined MOD_CLKB
 346 #  define ADJ_TICK MOD_CLKB
 347 # endif
 348
 349 #else
 350
 351 # define bb_setpgrp() setpgrp()
 352
 353 #endif
 354
 355 #if defined(__GLIBC__)
 356 # define fdprintf dprintf
 357 #endif
 358
 359 #if defined(__dietlibc__)
 360 # undef HAVE_STRCHRNUL
 361 #endif
 362
 363 #if defined(__WATCOMC__)
 364 # undef HAVE_FDPRINTF
 365 # undef HAVE_MEMRCHR
 366 # undef HAVE_MKDTEMP
 367 # undef HAVE_SETBIT
 368 # undef HAVE_STRCASESTR
 369 # undef HAVE_STRCHRNUL
 370 # undef HAVE_STRSEP
 371 # undef HAVE_STRSIGNAL
 372 # undef HAVE_VASPRINTF
 373 #endif
 374
 375 #if defined(__FreeBSD__)
 376 # undef HAVE_STRCHRNUL
 377 #endif
 378
 379 /*
 380  * Now, define prototypes for all the functions defined in platform.c
 381  * These must come after all the HAVE_* macros are defined (or not)
 382  */
 383
 384 #ifndef HAVE_FDPRINTF
 385 extern int fdprintf(int fd, const char *format, ...);
 386 #endif
 387
 388 #ifndef HAVE_MEMRCHR
 389 extern void *memrchr(const void *s, int c, size_t n) FAST_FUNC;
 390 #endif
 391
 392 #ifndef HAVE_MKDTEMP
 393 extern char *mkdtemp(char *template) FAST_FUNC;
 394 #endif
 395
 396 #ifndef HAVE_SETBIT
 397 # define setbit(a, b)  ((a)[(b) >> 3] |= 1 << ((b) & 7))
 398 # define clrbit(a, b)  ((a)[(b) >> 3] &= ~(1 << ((b) & 7)))
 399 #endif
 400
 401 #ifndef HAVE_SIGHANDLER_T
 402 typedef void (*sighandler_t)(int);
 403 #endif
 404
 405 #ifndef HAVE_STRCASESTR
 406 extern char *strcasestr(const char *s, const char *pattern) FAST_FUNC;
 407 #endif
 408
 409 #ifndef HAVE_STRCHRNUL
 410 extern char *strchrnul(const char *s, int c) FAST_FUNC;
 411 #endif
 412
 413 #ifndef HAVE_STRSEP
 414 extern char *strsep(char **stringp, const char *delim) FAST_FUNC;
 415 #endif
 416
 417 #ifndef HAVE_STRSIGNAL
 418 /* Not exactly the same: instead of "Stopped" it shows "STOP" etc */
 419 # define strsignal(sig) get_signame(sig)
 420 #endif
 421
 422 #ifndef HAVE_VASPRINTF
 423 extern int vasprintf(char **string_ptr, const char *format, va_list p) FAST_FUNC;
 424 #endif
 425
 426 #endif