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