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