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