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