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