include/libbb.h

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Busybox main internal header file
   4  *
   5  * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
   6  * Permission has been granted to redistribute this code under GPL.
   7  *
   8  * Licensed under GPLv2, see file LICENSE in this source tree.
   9  */
  10 #ifndef LIBBB_H
  11 #define LIBBB_H 1
  12
  13 #include "platform.h"
  14
  15 #include <ctype.h>
  16 #include <dirent.h>
  17 #include <errno.h>
  18 #include <fcntl.h>
  19 #include <inttypes.h>
  20 #include <netdb.h>
  21 #include <setjmp.h>
  22 #include <signal.h>
  23 #include <paths.h>
  24 #if defined __UCLIBC__ /* TODO: and glibc? */
  25 /* use inlined versions of these: */
  26 # define sigfillset(s)    __sigfillset(s)
  27 # define sigemptyset(s)   __sigemptyset(s)
  28 # define sigisemptyset(s) __sigisemptyset(s)
  29 #endif
  30 #include <stdint.h>
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <stdarg.h>
  34 #include <stddef.h>
  35 #include <string.h>
  36 /* There are two incompatible basename's, let's not use them! */
  37 /* See the dirname/basename man page for details */
  38 #include <libgen.h> /* dirname,basename */
  39 #undef basename
  40 #define basename dont_use_basename
  41 #include <poll.h>
  42 #include <sys/ioctl.h>
  43 #include <sys/mman.h>
  44 #include <sys/socket.h>
  45 #include <sys/stat.h>
  46 #include <sys/time.h>
  47 #include <sys/types.h>
  48 #if !defined(major) || defined(__GLIBC__)
  49 # include <sys/sysmacros.h>
  50 #endif
  51 #include <sys/wait.h>
  52 #include <termios.h>
  53 #include <time.h>
  54 #include <sys/param.h>
  55 #include <pwd.h>
  56 #include <grp.h>
  57 #if ENABLE_FEATURE_SHADOWPASSWDS
  58 # if !ENABLE_USE_BB_SHADOW
  59 /* If using busybox's shadow implementation, do not include the shadow.h
  60  * header as the toolchain may not provide it at all.
  61  */
  62 #  include <shadow.h>
  63 # endif
  64 #endif
  65 #if defined(ANDROID) || defined(__ANDROID__)
  66 # define endpwent() ((void)0)
  67 # define endgrent() ((void)0)
  68 #endif
  69 #ifdef HAVE_MNTENT_H
  70 # include <mntent.h>
  71 #endif
  72 #ifdef HAVE_SYS_STATFS_H
  73 # include <sys/statfs.h>
  74 #endif
  75 /* Don't do this here:
  76  * #include <sys/sysinfo.h>
  77  * Some linux/ includes pull in conflicting definition
  78  * of struct sysinfo (only in some toolchanins), which breaks build.
  79  * Include sys/sysinfo.h only in those files which need it.
  80  */
  81 #if ENABLE_SELINUX
  82 # include <selinux/selinux.h>
  83 # include <selinux/context.h>
  84 #endif
  85 #if ENABLE_FEATURE_UTMP
  86 # if defined __UCLIBC__ && ( \
  87     (UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 32) \
  88      && UCLIBC_VERSION < KERNEL_VERSION(0, 9, 34) \
  89      && defined __UCLIBC_HAS_UTMPX__ \
  90     ) || ( \
  91          UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 34) \
  92         ) \
  93   )
  94 #  include <utmpx.h>
  95 # elif defined __UCLIBC__
  96 #  include <utmp.h>
  97 #  define utmpx utmp
  98 #  define setutxent setutent
  99 #  define endutxent endutent
 100 #  define getutxent getutent
 101 #  define getutxid getutid
 102 #  define getutxline getutline
 103 #  define pututxline pututline
 104 #  define utmpxname utmpname
 105 #  define updwtmpx updwtmp
 106 #  define _PATH_UTMPX _PATH_UTMP
 107 # else
 108 #  include <utmp.h>
 109 #  include <utmpx.h>
 110 #  if defined _PATH_UTMP && !defined _PATH_UTMPX
 111 #   define _PATH_UTMPX _PATH_UTMP
 112 #  endif
 113 # endif
 114 #endif
 115 #if ENABLE_LOCALE_SUPPORT
 116 # include <locale.h>
 117 #else
 118 # define setlocale(x,y) ((void)0)
 119 #endif
 120 #ifdef DMALLOC
 121 # include <dmalloc.h>
 122 #endif
 123 /* Just in case libc doesn't define some of these... */
 124 #ifndef _PATH_PASSWD
 125 #define _PATH_PASSWD  "/etc/passwd"
 126 #endif
 127 #ifndef _PATH_GROUP
 128 #define _PATH_GROUP   "/etc/group"
 129 #endif
 130 #ifndef _PATH_SHADOW
 131 #define _PATH_SHADOW  "/etc/shadow"
 132 #endif
 133 #ifndef _PATH_GSHADOW
 134 #define _PATH_GSHADOW "/etc/gshadow"
 135 #endif
 136 #if defined __FreeBSD__ || defined __OpenBSD__
 137 # include <netinet/in.h>
 138 # include <arpa/inet.h>
 139 #elif defined __APPLE__
 140 # include <netinet/in.h>
 141 #else
 142 # include <arpa/inet.h>
 143 //This breaks on bionic:
 144 //# if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
 145 ///* We #define socklen_t *after* includes, otherwise we get
 146 // * typedef redefinition errors from system headers
 147 // * (in case "is it defined already" detection above failed)
 148 // */
 149 //#  define socklen_t bb_socklen_t
 150 //   typedef unsigned socklen_t;
 151 //# endif
 152 //if this is still needed, add a fix along the lines of
 153 //  ifdef SPECIFIC_BROKEN_LIBC_CHECK / typedef socklen_t / endif
 154 //in platform.h instead!
 155 #endif
 156 #ifndef HAVE_CLEARENV
 157 # define clearenv() do { if (environ) environ[0] = NULL; } while (0)
 158 #endif
 159 #ifndef HAVE_FDATASYNC
 160 # define fdatasync fsync
 161 #endif
 162 #ifndef HAVE_XTABS
 163 # define XTABS TAB3
 164 #endif
 165
 166
 167 /* Some libc's forget to declare these, do it ourself */
 168
 169 extern char **environ;
 170 #if defined(__GLIBC__) && __GLIBC__ < 2
 171 int vdprintf(int d, const char *format, va_list ap);
 172 #endif
 173 /* klogctl is in libc's klog.h, but we cheat and not #include that */
 174 int klogctl(int type, char *b, int len);
 175 #ifndef PATH_MAX
 176 # define PATH_MAX 256
 177 #endif
 178 #ifndef BUFSIZ
 179 # define BUFSIZ 4096
 180 #endif
 181
 182
 183 /* Busybox does not use threads, we can speed up stdio. */
 184 #ifdef HAVE_UNLOCKED_STDIO
 185 # undef  getc
 186 # define getc(stream)   getc_unlocked(stream)
 187 # undef  getchar
 188 # define getchar()      getchar_unlocked()
 189 # undef  putc
 190 # define putc(c,stream) putc_unlocked(c,stream)
 191 # undef  putchar
 192 # define putchar(c)     putchar_unlocked(c)
 193 # undef  fgetc
 194 # define fgetc(stream)  getc_unlocked(stream)
 195 # undef  fputc
 196 # define fputc(c,stream) putc_unlocked(c,stream)
 197 #endif
 198 /* Above functions are required by POSIX.1-2008, below ones are extensions */
 199 #ifdef HAVE_UNLOCKED_LINE_OPS
 200 # undef  fgets
 201 # define fgets(s,n,stream) fgets_unlocked(s,n,stream)
 202 # undef  fputs
 203 # define fputs(s,stream) fputs_unlocked(s,stream)
 204 /* musl <= 1.1.15 does not support fflush_unlocked(NULL) */
 205 //# undef  fflush
 206 //# define fflush(stream) fflush_unlocked(stream)
 207 # undef  feof
 208 # define feof(stream)   feof_unlocked(stream)
 209 # undef  ferror
 210 # define ferror(stream) ferror_unlocked(stream)
 211 # undef  fileno
 212 # define fileno(stream) fileno_unlocked(stream)
 213 #endif
 214
 215
 216 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
 217 /* (don't include system headers after this until corresponding pop!) */
 218 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
 219
 220
 221 #if ENABLE_USE_BB_PWD_GRP
 222 # include "pwd_.h"
 223 # include "grp_.h"
 224 #endif
 225 #if ENABLE_FEATURE_SHADOWPASSWDS
 226 # if ENABLE_USE_BB_SHADOW
 227 #  include "shadow_.h"
 228 # endif
 229 #endif
 230
 231 /* Tested to work correctly with all int types (IIRC :]) */
 232 #define MAXINT(T) (T)( \
 233         ((T)-1) > 0 \
 234         ? (T)-1 \
 235         : (T)~((T)1 << (sizeof(T)*8-1)) \
 236         )
 237
 238 #define MININT(T) (T)( \
 239         ((T)-1) > 0 \
 240         ? (T)0 \
 241         : ((T)1 << (sizeof(T)*8-1)) \
 242         )
 243
 244 /* Large file support */
 245 /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
 246  * (stat, lseek etc) mapped to "largefile" variants by libc.
 247  * Practically it means that open() automatically has O_LARGEFILE added
 248  * and all filesize/file_offset parameters and struct members are "large"
 249  * (in today's world - signed 64bit). For full support of large files,
 250  * we need a few helper #defines (below) and careful use of off_t
 251  * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
 252 #if ENABLE_LFS
 253 /* CONFIG_LFS is on */
 254 # if ULONG_MAX > 0xffffffff
 255 /* "long" is long enough on this system */
 256 typedef unsigned long uoff_t;
 257 #  define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
 258 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
 259 #  define BB_STRTOOFF bb_strtoul
 260 #  define STRTOOFF strtoul
 261 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
 262 #  define OFF_FMT "l"
 263 # else
 264 /* "long" is too short, need "long long" */
 265 typedef unsigned long long uoff_t;
 266 #  define XATOOFF(a) xatoull_range((a), 0, LLONG_MAX)
 267 #  define BB_STRTOOFF bb_strtoull
 268 #  define STRTOOFF strtoull
 269 #  define OFF_FMT "ll"
 270 # endif
 271 #else
 272 /* CONFIG_LFS is off */
 273 # if UINT_MAX == 0xffffffff
 274 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
 275  * gcc will throw warnings on printf("%d", off_t). Crap... */
 276 typedef unsigned long uoff_t;
 277 #  define XATOOFF(a) xatoi_positive(a)
 278 #  define BB_STRTOOFF bb_strtou
 279 #  define STRTOOFF strtol
 280 #  define OFF_FMT "l"
 281 # else
 282 typedef unsigned long uoff_t;
 283 #  define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
 284 #  define BB_STRTOOFF bb_strtoul
 285 #  define STRTOOFF strtol
 286 #  define OFF_FMT "l"
 287 # endif
 288 #endif
 289 /* scary. better ideas? (but do *test* them first!) */
 290 #define OFF_T_MAX  ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
 291 /* Users report bionic to use 32-bit off_t even if LARGEFILE support is requested.
 292  * We misdetected that. Don't let it build:
 293  */
 294 struct BUG_off_t_size_is_misdetected {
 295         char BUG_off_t_size_is_misdetected[sizeof(off_t) == sizeof(uoff_t) ? 1 : -1];
 296 };
 297
 298 /* Some useful definitions */
 299 #undef FALSE
 300 #define FALSE   ((int) 0)
 301 #undef TRUE
 302 #define TRUE    ((int) 1)
 303 #undef SKIP
 304 #define SKIP    ((int) 2)
 305
 306 /* Macros for min/max.  */
 307 #ifndef MIN
 308 #define MIN(a,b) (((a)<(b))?(a):(b))
 309 #endif
 310
 311 #ifndef MAX
 312 #define MAX(a,b) (((a)>(b))?(a):(b))
 313 #endif
 314
 315 /* buffer allocation schemes */
 316 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
 317 #define RESERVE_CONFIG_BUFFER(buffer,len)  char buffer[len]
 318 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
 319 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
 320 #else
 321 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
 322 #define RESERVE_CONFIG_BUFFER(buffer,len)  static          char buffer[len]
 323 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
 324 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
 325 #else
 326 #define RESERVE_CONFIG_BUFFER(buffer,len)  char *buffer = xmalloc(len)
 327 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
 328 #define RELEASE_CONFIG_BUFFER(buffer)      free(buffer)
 329 #endif
 330 #endif
 331
 332 #if defined(__GLIBC__)
 333 /* glibc uses __errno_location() to get a ptr to errno */
 334 /* We can just memorize it once - no multithreading in busybox :) */
 335 extern int *const bb_errno;
 336 #undef errno
 337 #define errno (*bb_errno)
 338 #endif
 339
 340 #if !(ULONG_MAX > 0xffffffff)
 341 /* Only 32-bit CPUs need this, 64-bit ones use inlined version */
 342 uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
 343 #endif
 344
 345 unsigned long FAST_FUNC isqrt(unsigned long long N);
 346
 347 unsigned long long monotonic_ns(void) FAST_FUNC;
 348 unsigned long long monotonic_us(void) FAST_FUNC;
 349 unsigned long long monotonic_ms(void) FAST_FUNC;
 350 unsigned monotonic_sec(void) FAST_FUNC;
 351
 352 extern void chomp(char *s) FAST_FUNC;
 353 extern void trim(char *s) FAST_FUNC;
 354 extern char *skip_whitespace(const char *) FAST_FUNC;
 355 extern char *skip_non_whitespace(const char *) FAST_FUNC;
 356 extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
 357
 358 extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
 359
 360 /* dmalloc will redefine these to it's own implementation. It is safe
 361  * to have the prototypes here unconditionally.  */
 362 void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
 363 void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
 364 void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
 365 void *xrealloc(void *old, size_t size) FAST_FUNC;
 366 /* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
 367  * at least v[idx] and v[idx+1], for all idx values.
 368  * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
 369  * when all elements are used up. New elements are zeroed out.
 370  * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
 371  * skipping an index is a bad bug - it may miss a realloc!
 372  */
 373 #define xrealloc_vector(vector, shift, idx) \
 374         xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
 375 void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
 376 char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
 377 char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
 378 void *xmemdup(const void *s, int n) FAST_FUNC RETURNS_MALLOC;
 379
 380
 381 //TODO: supply a pointer to char[11] buffer (avoid statics)?
 382 extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
 383 extern int is_directory(const char *name, int followLinks) FAST_FUNC;
 384 enum {  /* cp.c, mv.c, install.c depend on these values. CAREFUL when changing them! */
 385         FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
 386         FILEUTILS_DEREFERENCE     = 1 << 1, /* !-d */
 387         FILEUTILS_RECUR           = 1 << 2, /* -R */
 388         FILEUTILS_FORCE           = 1 << 3, /* -f */
 389         FILEUTILS_INTERACTIVE     = 1 << 4, /* -i */
 390         FILEUTILS_MAKE_HARDLINK   = 1 << 5, /* -l */
 391         FILEUTILS_MAKE_SOFTLINK   = 1 << 6, /* -s */
 392         FILEUTILS_DEREF_SOFTLINK  = 1 << 7, /* -L */
 393         FILEUTILS_DEREFERENCE_L0  = 1 << 8, /* -H */
 394         /* -a = -pdR (mapped in cp.c) */
 395         /* -r = -dR  (mapped in cp.c) */
 396         /* -P = -d   (mapped in cp.c) */
 397         FILEUTILS_VERBOSE         = (1 << 12) * ENABLE_FEATURE_VERBOSE, /* -v */
 398         FILEUTILS_UPDATE          = 1 << 13, /* -u */
 399 #if ENABLE_SELINUX
 400         FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 14, /* -c */
 401 #endif
 402         FILEUTILS_RMDEST          = 1 << (15 - !ENABLE_SELINUX), /* --remove-destination */
 403         /*
 404          * Hole. cp may have some bits set here,
 405          * they should not affect remove_file()/copy_file()
 406          */
 407 #if ENABLE_SELINUX
 408         FILEUTILS_SET_SECURITY_CONTEXT = 1 << 30,
 409 #endif
 410         FILEUTILS_IGNORE_CHMOD_ERR = 1 << 31,
 411 };
 412 #define FILEUTILS_CP_OPTSTR "pdRfilsLHarPvu" IF_SELINUX("c")
 413 extern int remove_file(const char *path, int flags) FAST_FUNC;
 414 /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
 415  * the source, not copy (unless "source" is a directory).
 416  * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
 417  * work coreutils-compatibly. */
 418 extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
 419
 420 enum {
 421         ACTION_RECURSE        = (1 << 0),
 422         ACTION_FOLLOWLINKS    = (1 << 1),
 423         ACTION_FOLLOWLINKS_L0 = (1 << 2),
 424         ACTION_DEPTHFIRST     = (1 << 3),
 425         /*ACTION_REVERSE      = (1 << 4), - unused */
 426         ACTION_QUIET          = (1 << 5),
 427         ACTION_DANGLING_OK    = (1 << 6),
 428 };
 429 typedef uint8_t recurse_flags_t;
 430 extern int recursive_action(const char *fileName, unsigned flags,
 431         int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
 432         int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
 433         void* userData, unsigned depth) FAST_FUNC;
 434 extern int device_open(const char *device, int mode) FAST_FUNC;
 435 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
 436 extern int xgetpty(char *line) FAST_FUNC;
 437 extern int get_console_fd_or_die(void) FAST_FUNC;
 438 extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
 439 extern char *find_block_device(const char *path) FAST_FUNC;
 440 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
 441 extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
 442 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
 443 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
 444 /* "short" copy can be detected by return value < size */
 445 /* this helper yells "short read!" if param is not -1 */
 446 extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
 447
 448 extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
 449 char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
 450 /* xxxx_strip version can modify its parameter:
 451  * "/"        -> "/"
 452  * "abc"      -> "abc"
 453  * "abc/def"  -> "def"
 454  * "abc/def/" -> "def" !!
 455  */
 456 char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
 457 /* "abc/def/" -> "" and it never modifies 'path' */
 458 char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
 459 /* Simpler version: does not special case "/" string */
 460 const char *bb_basename(const char *name) FAST_FUNC;
 461 /* NB: can violate const-ness (similarly to strchr) */
 462 char *last_char_is(const char *s, int c) FAST_FUNC;
 463 const char* endofname(const char *name) FAST_FUNC;
 464 char *is_prefixed_with(const char *string, const char *key) FAST_FUNC;
 465 char *is_suffixed_with(const char *string, const char *key) FAST_FUNC;
 466
 467 int ndelay_on(int fd) FAST_FUNC;
 468 int ndelay_off(int fd) FAST_FUNC;
 469 void close_on_exec_on(int fd) FAST_FUNC;
 470 void xdup2(int, int) FAST_FUNC;
 471 void xmove_fd(int, int) FAST_FUNC;
 472
 473
 474 DIR *xopendir(const char *path) FAST_FUNC;
 475 DIR *warn_opendir(const char *path) FAST_FUNC;
 476
 477 char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
 478 char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
 479 char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
 480 /* !RETURNS_MALLOC: it's a realloc-like function */
 481 char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
 482
 483 char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
 484
 485
 486 enum {
 487         /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
 488          * otherwise would kill us, except for those resulting from bugs:
 489          * SIGSEGV, SIGILL, SIGFPE.
 490          * Other fatal signals not included (TODO?):
 491          * SIGBUS   Bus error (bad memory access)
 492          * SIGPOLL  Pollable event. Synonym of SIGIO
 493          * SIGPROF  Profiling timer expired
 494          * SIGSYS   Bad argument to routine
 495          * SIGTRAP  Trace/breakpoint trap
 496          *
 497          * The only known arch with some of these sigs not fitting
 498          * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
 499          * Dance around with long long to guard against that...
 500          */
 501         BB_FATAL_SIGS = (int)(0
 502                 + (1LL << SIGHUP)
 503                 + (1LL << SIGINT)
 504                 + (1LL << SIGTERM)
 505                 + (1LL << SIGPIPE)   // Write to pipe with no readers
 506                 + (1LL << SIGQUIT)   // Quit from keyboard
 507                 + (1LL << SIGABRT)   // Abort signal from abort(3)
 508                 + (1LL << SIGALRM)   // Timer signal from alarm(2)
 509                 + (1LL << SIGVTALRM) // Virtual alarm clock
 510                 + (1LL << SIGXCPU)   // CPU time limit exceeded
 511                 + (1LL << SIGXFSZ)   // File size limit exceeded
 512                 + (1LL << SIGUSR1)   // Yes kids, these are also fatal!
 513                 + (1LL << SIGUSR2)
 514                 + 0),
 515 };
 516 void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
 517 /* Unlike signal() and bb_signals, sets handler with sigaction()
 518  * and in a way that while signal handler is run, no other signals
 519  * will be blocked; syscalls will not be restarted: */
 520 void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
 521 /* syscalls like read() will be interrupted with EINTR: */
 522 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
 523 /* syscalls like read() won't be interrupted (though select/poll will be): */
 524 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
 525 void wait_for_any_sig(void) FAST_FUNC;
 526 void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
 527 void sig_block(int sig) FAST_FUNC;
 528 void sig_unblock(int sig) FAST_FUNC;
 529 /* Will do sigaction(signum, act, NULL): */
 530 int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
 531 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
 532 int sigprocmask_allsigs(int how) FAST_FUNC;
 533 /* Standard handler which just records signo */
 534 extern smallint bb_got_signal;
 535 void record_signo(int signo); /* not FAST_FUNC! */
 536
 537
 538 void xsetgid(gid_t gid) FAST_FUNC;
 539 void xsetuid(uid_t uid) FAST_FUNC;
 540 void xsetegid(gid_t egid) FAST_FUNC;
 541 void xseteuid(uid_t euid) FAST_FUNC;
 542 void xchdir(const char *path) FAST_FUNC;
 543 void xfchdir(int fd) FAST_FUNC;
 544 void xchroot(const char *path) FAST_FUNC;
 545 void xsetenv(const char *key, const char *value) FAST_FUNC;
 546 void bb_unsetenv(const char *key) FAST_FUNC;
 547 void bb_unsetenv_and_free(char *key) FAST_FUNC;
 548 void xunlink(const char *pathname) FAST_FUNC;
 549 void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
 550 void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
 551 int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
 552 int open_or_warn(const char *pathname, int flags) FAST_FUNC;
 553 int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
 554 int xopen(const char *pathname, int flags) FAST_FUNC;
 555 int xopen_nonblocking(const char *pathname) FAST_FUNC;
 556 int xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g) FAST_FUNC;
 557 int open_or_warn_stdin(const char *pathname) FAST_FUNC;
 558 int xopen_stdin(const char *pathname) FAST_FUNC;
 559 void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
 560 int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
 561 off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
 562 int xmkstemp(char *template) FAST_FUNC;
 563 off_t fdlength(int fd) FAST_FUNC;
 564
 565 uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
 566                 const char *override,
 567                 unsigned override_units,
 568                 int extend);
 569
 570 void xpipe(int filedes[2]) FAST_FUNC;
 571 /* In this form code with pipes is much more readable */
 572 struct fd_pair { int rd; int wr; };
 573 #define piped_pair(pair)  pipe(&((pair).rd))
 574 #define xpiped_pair(pair) xpipe(&((pair).rd))
 575
 576 /* Useful for having small structure members/global variables */
 577 typedef int8_t socktype_t;
 578 typedef int8_t family_t;
 579 struct BUG_too_small {
 580         char BUG_socktype_t_too_small[(0
 581                         | SOCK_STREAM
 582                         | SOCK_DGRAM
 583                         | SOCK_RDM
 584                         | SOCK_SEQPACKET
 585                         | SOCK_RAW
 586                         ) <= 127 ? 1 : -1];
 587         char BUG_family_t_too_small[(0
 588                         | AF_UNSPEC
 589                         | AF_INET
 590                         | AF_INET6
 591                         | AF_UNIX
 592 #ifdef AF_PACKET
 593                         | AF_PACKET
 594 #endif
 595 #ifdef AF_NETLINK
 596                         | AF_NETLINK
 597 #endif
 598                         /* | AF_DECnet */
 599                         /* | AF_IPX */
 600                         ) <= 127 ? 1 : -1];
 601 };
 602
 603
 604 void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
 605 time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
 606 char *strftime_HHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
 607 char *strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
 608
 609 int xsocket(int domain, int type, int protocol) FAST_FUNC;
 610 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
 611 void xlisten(int s, int backlog) FAST_FUNC;
 612 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
 613 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
 614                                 socklen_t tolen) FAST_FUNC;
 615
 616 int setsockopt_int(int fd, int level, int optname, int optval) FAST_FUNC;
 617 int setsockopt_1(int fd, int level, int optname) FAST_FUNC;
 618 int setsockopt_SOL_SOCKET_int(int fd, int optname, int optval) FAST_FUNC;
 619 int setsockopt_SOL_SOCKET_1(int fd, int optname) FAST_FUNC;
 620 /* SO_REUSEADDR allows a server to rebind to an address that is already
 621  * "in use" by old connections to e.g. previous server instance which is
 622  * killed or crashed. Without it bind will fail until all such connections
 623  * time out. Linux does not allow multiple live binds on same ip:port
 624  * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
 625  * Turn it on before you call bind(). */
 626 void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
 627 int setsockopt_keepalive(int fd) FAST_FUNC;
 628 int setsockopt_broadcast(int fd) FAST_FUNC;
 629 int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
 630 /* NB: returns port in host byte order */
 631 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
 632 typedef struct len_and_sockaddr {
 633         socklen_t len;
 634         union {
 635                 struct sockaddr sa;
 636                 struct sockaddr_in sin;
 637 #if ENABLE_FEATURE_IPV6
 638                 struct sockaddr_in6 sin6;
 639 #endif
 640         } u;
 641 } len_and_sockaddr;
 642 enum {
 643         LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
 644         LSA_SIZEOF_SA = sizeof(
 645                 union {
 646                         struct sockaddr sa;
 647                         struct sockaddr_in sin;
 648 #if ENABLE_FEATURE_IPV6
 649                         struct sockaddr_in6 sin6;
 650 #endif
 651                 }
 652         )
 653 };
 654 /* Create stream socket, and allocate suitable lsa.
 655  * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
 656  * af == AF_UNSPEC will result in trying to create IPv6 socket,
 657  * and if kernel doesn't support it, fall back to IPv4.
 658  * This is useful if you plan to bind to resulting local lsa.
 659  */
 660 int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
 661 int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
 662 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
 663  * numeric IP ("N.N.N.N") or numeric IPv6 address,
 664  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
 665  * Only if there is no suffix, port argument is used */
 666 /* NB: these set SO_REUSEADDR before bind */
 667 int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
 668 int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
 669 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
 670  * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
 671  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
 672  * If there is no suffix, port argument is used */
 673 int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
 674 /* Connect to peer identified by lsa */
 675 int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
 676 /* Get local address of bound or accepted socket */
 677 len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
 678 /* Get remote address of connected or accepted socket */
 679 len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
 680 /* Return malloc'ed len_and_sockaddr with socket address of host:port
 681  * Currently will return IPv4 or IPv6 sockaddrs only
 682  * (depending on host), but in theory nothing prevents e.g.
 683  * UNIX socket address being returned, IPX sockaddr etc...
 684  * On error does bb_error_msg and returns NULL */
 685 len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
 686 /* Version which dies on error */
 687 len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
 688 len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
 689 /* Same, useful if you want to force family (e.g. IPv6) */
 690 #if !ENABLE_FEATURE_IPV6
 691 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
 692 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
 693 #else
 694 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
 695 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
 696 #endif
 697 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
 698  * otherwise no-op. Useful for ftp.
 699  * NB: does NOT do htons() internally, just direct assignment. */
 700 void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
 701 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
 702 int get_nport(const struct sockaddr *sa) FAST_FUNC;
 703 /* Reverse DNS. Returns NULL on failure. */
 704 char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 705 /* This one doesn't append :PORTNUM */
 706 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 707 /* This one also doesn't fall back to dotted IP (returns NULL) */
 708 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 709 /* inet_[ap]ton on steroids */
 710 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 711 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 712 // "old" (ipv4 only) API
 713 // users: traceroute.c hostname.c - use _list_ of all IPs
 714 struct hostent *xgethostbyname(const char *name) FAST_FUNC;
 715 // Also mount.c and inetd.c are using gethostbyname(),
 716 // + inet_common.c has additional IPv4-only stuff
 717
 718
 719 #define TLS_MAX_MAC_SIZE 32
 720 #define TLS_MAX_KEY_SIZE 32
 721 struct tls_handshake_data; /* opaque */
 722 typedef struct tls_state {
 723         int ofd;
 724         int ifd;
 725
 726         unsigned min_encrypted_len_on_read;
 727         uint16_t cipher_id;
 728         uint8_t  encrypt_on_write;
 729         unsigned MAC_size;
 730         unsigned key_size;
 731
 732         uint8_t *outbuf;
 733         int     outbuf_size;
 734
 735         int     inbuf_size;
 736         int     ofs_to_buffered;
 737         int     buffered_size;
 738         uint8_t *inbuf;
 739
 740         struct tls_handshake_data *hsd;
 741
 742         // RFC 5246
 743         // sequence number
 744         //   Each connection state contains a sequence number, which is
 745         //   maintained separately for read and write states.  The sequence
 746         //   number MUST be set to zero whenever a connection state is made the
 747         //   active state.  Sequence numbers are of type uint64 and may not
 748         //   exceed 2^64-1.
 749         /*uint64_t read_seq64_be;*/
 750         uint64_t write_seq64_be;
 751
 752         uint8_t *client_write_key;
 753         uint8_t *server_write_key;
 754         uint8_t client_write_MAC_key[TLS_MAX_MAC_SIZE];
 755         uint8_t server_write_MAC_k__[TLS_MAX_MAC_SIZE];
 756         uint8_t client_write_k__[TLS_MAX_KEY_SIZE];
 757         uint8_t server_write_k__[TLS_MAX_KEY_SIZE];
 758 } tls_state_t;
 759
 760 static inline tls_state_t *new_tls_state(void)
 761 {
 762         tls_state_t *tls = xzalloc(sizeof(*tls));
 763         return tls;
 764 }
 765 void tls_handshake(tls_state_t *tls, const char *sni) FAST_FUNC;
 766 void tls_run_copy_loop(tls_state_t *tls) FAST_FUNC;
 767
 768
 769 void socket_want_pktinfo(int fd) FAST_FUNC;
 770 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
 771                 const struct sockaddr *to,
 772                 const struct sockaddr *from,
 773                 socklen_t tolen) FAST_FUNC;
 774 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
 775                 struct sockaddr *from,
 776                 struct sockaddr *to,
 777                 socklen_t sa_size) FAST_FUNC;
 778
 779 uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
 780
 781 void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
 782 char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
 783 char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
 784 unsigned count_strstr(const char *str, const char *sub) FAST_FUNC;
 785 char *xmalloc_substitute_string(const char *src, int count, const char *sub, const char *repl) FAST_FUNC;
 786 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
 787  * But potentially slow, don't use in one-billion-times loops */
 788 int bb_putchar(int ch) FAST_FUNC;
 789 /* Note: does not use stdio, writes to fd 2 directly */
 790 int bb_putchar_stderr(char ch) FAST_FUNC;
 791 char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
 792 char *auto_string(char *str) FAST_FUNC;
 793 // gcc-4.1.1 still isn't good enough at optimizing it
 794 // (+200 bytes compared to macro)
 795 //static ALWAYS_INLINE
 796 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
 797 //static ALWAYS_INLINE
 798 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
 799 #define LONE_DASH(s)     ((s)[0] == '-' && !(s)[1])
 800 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
 801 #define LONE_CHAR(s,c)     ((s)[0] == (c) && !(s)[1])
 802 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
 803 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
 804
 805 typedef struct uni_stat_t {
 806         unsigned byte_count;
 807         unsigned unicode_count;
 808         unsigned unicode_width;
 809 } uni_stat_t;
 810 /* Returns a string with unprintable chars replaced by '?' or
 811  * SUBST_WCHAR. This function is unicode-aware. */
 812 const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
 813 /* Prints unprintable char ch as ^C or M-c to file
 814  * (M-c is used only if ch is ORed with PRINTABLE_META),
 815  * else it is printed as-is (except for ch = 0x9b) */
 816 enum { PRINTABLE_META = 0x100 };
 817 void fputc_printable(int ch, FILE *file) FAST_FUNC;
 818 /* Return a string that is the printable representation of character ch.
 819  * Buffer must hold at least four characters. */
 820 enum {
 821         VISIBLE_ENDLINE   = 1 << 0,
 822         VISIBLE_SHOW_TABS = 1 << 1,
 823 };
 824 void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
 825
 826 extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
 827 extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count) FAST_FUNC;
 828 // NB: will return short read on error, not -1,
 829 // if some data was read before error occurred
 830 extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
 831 extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
 832 extern unsigned char xread_char(int fd) FAST_FUNC;
 833 extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
 834 extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
 835 // Reads one line a-la fgets (but doesn't save terminating '\n').
 836 // Reads byte-by-byte. Useful when it is important to not read ahead.
 837 // Bytes are appended to pfx (which must be malloced, or NULL).
 838 extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
 839 /* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
 840 extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 841 /* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
 842 extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 843 /* Never returns NULL */
 844 extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 845
 846 #if defined(ARG_MAX) && (ARG_MAX >= 60*1024 || !defined(_SC_ARG_MAX))
 847 /* Use _constant_ maximum if: defined && (big enough || no variable one exists) */
 848 # define bb_arg_max() ((unsigned)ARG_MAX)
 849 #elif defined(_SC_ARG_MAX)
 850 /* Else use variable one (a bit more expensive) */
 851 unsigned bb_arg_max(void) FAST_FUNC;
 852 #else
 853 /* If all else fails */
 854 # define bb_arg_max() ((unsigned)(32 * 1024))
 855 #endif
 856 unsigned bb_clk_tck(void) FAST_FUNC;
 857
 858 #define SEAMLESS_COMPRESSION (0 \
 859  || ENABLE_FEATURE_SEAMLESS_XZ \
 860  || ENABLE_FEATURE_SEAMLESS_LZMA \
 861  || ENABLE_FEATURE_SEAMLESS_BZ2 \
 862  || ENABLE_FEATURE_SEAMLESS_GZ \
 863  || ENABLE_FEATURE_SEAMLESS_Z)
 864
 865 #if SEAMLESS_COMPRESSION
 866 /* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
 867 extern int setup_unzip_on_fd(int fd, int fail_if_not_compressed) FAST_FUNC;
 868 /* Autodetects .gz etc */
 869 extern int open_zipped(const char *fname, int fail_if_not_compressed) FAST_FUNC;
 870 extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 871 #else
 872 # define setup_unzip_on_fd(...) (0)
 873 # define open_zipped(fname, fail_if_not_compressed)  open((fname), O_RDONLY);
 874 # define xmalloc_open_zipped_read_close(fname, maxsz_p) xmalloc_open_read_close((fname), (maxsz_p))
 875 #endif
 876
 877 extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
 878 // NB: will return short write on error, not -1,
 879 // if some data was written before error occurred
 880 extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
 881 extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
 882 extern void xwrite_str(int fd, const char *str) FAST_FUNC;
 883 extern ssize_t full_write1_str(const char *str) FAST_FUNC;
 884 extern ssize_t full_write2_str(const char *str) FAST_FUNC;
 885 extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
 886
 887 /* Close fd, but check for failures (some types of write errors) */
 888 extern void xclose(int fd) FAST_FUNC;
 889
 890 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
 891 extern void xprint_and_close_file(FILE *file) FAST_FUNC;
 892
 893 /* Reads a line from a text file, up to a newline or NUL byte, inclusive.
 894  * Returns malloc'ed char*. If end is NULL '\n' isn't considered
 895  * end of line. If end isn't NULL, length of the chunk is stored in it.
 896  * Returns NULL if EOF/error.
 897  */
 898 extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
 899 /* Reads up to (and including) TERMINATING_STRING: */
 900 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
 901 /* Same, with limited max size, and returns the length (excluding NUL): */
 902 extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 903 /* Chops off TERMINATING_STRING from the end: */
 904 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
 905 /* Reads up to (and including) "\n" or NUL byte: */
 906 extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
 907 /* Chops off '\n' from the end, unlike fgets: */
 908 extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
 909 /* Same, but doesn't try to conserve space (may have some slack after the end) */
 910 /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
 911
 912 void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
 913 void die_if_ferror_stdout(void) FAST_FUNC;
 914 int fflush_all(void) FAST_FUNC;
 915 void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
 916 int fclose_if_not_stdin(FILE *file) FAST_FUNC;
 917 FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
 918 /* Prints warning to stderr and returns NULL on failure: */
 919 FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
 920 /* "Opens" stdin if filename is special, else just opens file: */
 921 FILE* xfopen_stdin(const char *filename) FAST_FUNC;
 922 FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
 923 FILE* fopen_for_read(const char *path) FAST_FUNC;
 924 FILE* xfopen_for_read(const char *path) FAST_FUNC;
 925 FILE* fopen_for_write(const char *path) FAST_FUNC;
 926 FILE* xfopen_for_write(const char *path) FAST_FUNC;
 927 FILE* xfdopen_for_read(int fd) FAST_FUNC;
 928 FILE* xfdopen_for_write(int fd) FAST_FUNC;
 929
 930 int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
 931 void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
 932
 933 /* Wrapper which restarts poll on EINTR or ENOMEM.
 934  * On other errors complains [perror("poll")] and returns.
 935  * Warning! May take (much) longer than timeout_ms to return!
 936  * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
 937 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
 938
 939 char *safe_gethostname(void) FAST_FUNC;
 940
 941 /* Convert each alpha char in str to lower-case */
 942 char* str_tolower(char *str) FAST_FUNC;
 943
 944 char *utoa(unsigned n) FAST_FUNC;
 945 char *itoa(int n) FAST_FUNC;
 946 /* Returns a pointer past the formatted number, does NOT null-terminate */
 947 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
 948 char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
 949 /* Intelligent formatters of bignums */
 950 char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
 951 char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
 952 /* If block_size == 0, display size without fractional part,
 953  * else display (size * block_size) with one decimal digit.
 954  * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
 955  * else divide by display_unit and do not use suffix. */
 956 #define HUMAN_READABLE_MAX_WIDTH      7  /* "1024.0G" */
 957 #define HUMAN_READABLE_MAX_WIDTH_STR "7"
 958 //TODO: provide pointer to buf (avoid statics)?
 959 const char *make_human_readable_str(unsigned long long size,
 960                 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
 961 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
 962 char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
 963 /* Reverse */
 964 char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
 965
 966 /* Generate a UUID */
 967 void generate_uuid(uint8_t *buf) FAST_FUNC;
 968
 969 /* Last element is marked by mult == 0 */
 970 struct suffix_mult {
 971         char suffix[4];
 972         unsigned mult;
 973 };
 974 extern const struct suffix_mult bkm_suffixes[];
 975 #define km_suffixes (bkm_suffixes + 1)
 976 extern const struct suffix_mult cwbkMG_suffixes[];
 977 #define kMG_suffixes (cwbkMG_suffixes + 3)
 978 extern const struct suffix_mult kmg_i_suffixes[];
 979
 980 #include "xatonum.h"
 981 /* Specialized: */
 982
 983 /* Using xatoi() instead of naive atoi() is not always convenient -
 984  * in many places people want *non-negative* values, but store them
 985  * in signed int. Therefore we need this one:
 986  * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
 987  * It should really be named xatoi_nonnegative (since it allows 0),
 988  * but that would be too long.
 989  */
 990 int xatoi_positive(const char *numstr) FAST_FUNC;
 991
 992 /* Useful for reading port numbers */
 993 uint16_t xatou16(const char *numstr) FAST_FUNC;
 994
 995
 996 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
 997  * for BusyBox since we want to avoid using the glibc NSS stuff, which
 998  * increases target size and is often not needed on embedded systems.  */
 999 long xuname2uid(const char *name) FAST_FUNC;
1000 long xgroup2gid(const char *name) FAST_FUNC;
1001 /* wrapper: allows string to contain numeric uid or gid */
1002 unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
1003 struct bb_uidgid_t {
1004         uid_t uid;
1005         gid_t gid;
1006 };
1007 /* always sets uid and gid; returns 0 on failure */
1008 int get_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
1009 /* always sets uid and gid; exits on failure */
1010 void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
1011 /* chown-like handling of "user[:[group]" */
1012 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
1013 struct passwd* xgetpwnam(const char *name) FAST_FUNC;
1014 struct group* xgetgrnam(const char *name) FAST_FUNC;
1015 struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
1016 struct group* xgetgrgid(gid_t gid) FAST_FUNC;
1017 char* xuid2uname(uid_t uid) FAST_FUNC;
1018 char* xgid2group(gid_t gid) FAST_FUNC;
1019 char* uid2uname(uid_t uid) FAST_FUNC;
1020 char* gid2group(gid_t gid) FAST_FUNC;
1021 char* uid2uname_utoa(uid_t uid) FAST_FUNC;
1022 char* gid2group_utoa(gid_t gid) FAST_FUNC;
1023 /* versions which cache results (useful for ps, ls etc) */
1024 const char* get_cached_username(uid_t uid) FAST_FUNC;
1025 const char* get_cached_groupname(gid_t gid) FAST_FUNC;
1026 void clear_username_cache(void) FAST_FUNC;
1027 /* internally usernames are saved in fixed-sized char[] buffers */
1028 enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
1029 #if ENABLE_FEATURE_CHECK_NAMES
1030 void die_if_bad_username(const char* name) FAST_FUNC;
1031 #else
1032 #define die_if_bad_username(name) ((void)(name))
1033 #endif
1034
1035 #if ENABLE_FEATURE_UTMP
1036 void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
1037 void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
1038 void FAST_FUNC update_utmp_DEAD_PROCESS(pid_t pid);
1039 #else
1040 # define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
1041 # define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
1042 # define update_utmp_DEAD_PROCESS(pid) ((void)0)
1043 #endif
1044
1045
1046 int file_is_executable(const char *name) FAST_FUNC;
1047 char *find_executable(const char *filename, char **PATHp) FAST_FUNC;
1048 int executable_exists(const char *filename) FAST_FUNC;
1049
1050 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
1051  * but it may exec busybox and call applet instead of searching PATH.
1052  */
1053 #if ENABLE_FEATURE_PREFER_APPLETS
1054 int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
1055 #define BB_EXECLP(prog,cmd,...) \
1056         do { \
1057                 if (find_applet_by_name(prog) >= 0) \
1058                         execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
1059                 execlp(prog, cmd, __VA_ARGS__); \
1060         } while (0)
1061 #else
1062 #define BB_EXECVP(prog,cmd)     execvp(prog,cmd)
1063 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
1064 #endif
1065 void BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
1066 void exec_prog_or_SHELL(char **argv) NORETURN FAST_FUNC;
1067
1068 /* xvfork() can't be a _function_, return after vfork in child mangles stack
1069  * in the parent. It must be a macro. */
1070 #define xvfork() \
1071 ({ \
1072         pid_t bb__xvfork_pid = vfork(); \
1073         if (bb__xvfork_pid < 0) \
1074                 bb_perror_msg_and_die("vfork"); \
1075         bb__xvfork_pid; \
1076 })
1077 #if BB_MMU
1078 pid_t xfork(void) FAST_FUNC;
1079 #endif
1080 void xvfork_parent_waits_and_exits(void) FAST_FUNC;
1081
1082 /* NOMMU friendy fork+exec: */
1083 pid_t spawn(char **argv) FAST_FUNC;
1084 pid_t xspawn(char **argv) FAST_FUNC;
1085
1086 pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
1087 pid_t wait_any_nohang(int *wstat) FAST_FUNC;
1088 /* wait4pid: unlike waitpid, waits ONLY for one process.
1089  * Returns sig + 0x180 if child is killed by signal.
1090  * It's safe to pass negative 'pids' from failed [v]fork -
1091  * wait4pid will return -1 (and will not clobber [v]fork's errno).
1092  * IOW: rc = wait4pid(spawn(argv));
1093  *      if (rc < 0) bb_perror_msg("%s", argv[0]);
1094  *      if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
1095  */
1096 int wait4pid(pid_t pid) FAST_FUNC;
1097 int wait_for_exitstatus(pid_t pid) FAST_FUNC;
1098 /************************************************************************/
1099 /* spawn_and_wait/run_nofork_applet/run_applet_no_and_exit need to work */
1100 /* carefully together to reinit some global state while not disturbing  */
1101 /* other. Be careful if you change them. Consult docs/nofork_noexec.txt */
1102 /************************************************************************/
1103 /* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
1104 int spawn_and_wait(char **argv) FAST_FUNC;
1105 /* Does NOT check that applet is NOFORK, just blindly runs it */
1106 int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
1107 #ifndef BUILD_INDIVIDUAL
1108 extern int find_applet_by_name(const char *name) FAST_FUNC;
1109 extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
1110 #endif
1111
1112 /* Helpers for daemonization.
1113  *
1114  * bb_daemonize(flags) = daemonize, does not compile on NOMMU
1115  *
1116  * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
1117  *      rexec's itself on NOMMU with argv passed as command line.
1118  * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
1119  * from the start. (It will detect it and not reexec again second time).
1120  * You have to audit carefully that you don't do something twice as a result
1121  * (opening files/sockets, parsing config files etc...)!
1122  *
1123  * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
1124  * (will do setsid()).
1125  *
1126  * fork_or_rexec(argv) = bare-bones fork on MMU,
1127  *      "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
1128  *      On MMU ignores argv.
1129  *
1130  * Helper for network daemons in foreground mode:
1131  *
1132  * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
1133  * to /dev/null if they are not.
1134  */
1135 enum {
1136         DAEMON_CHDIR_ROOT = 1,
1137         DAEMON_DEVNULL_STDIO = 2,
1138         DAEMON_CLOSE_EXTRA_FDS = 4,
1139         DAEMON_ONLY_SANITIZE = 8, /* internal use */
1140         DAEMON_DOUBLE_FORK = 16, /* double fork to avoid controlling tty */
1141 };
1142 #if BB_MMU
1143   enum { re_execed = 0 };
1144 # define fork_or_rexec(argv)                xfork()
1145 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1146 # define bb_daemonize(flags)                bb_daemonize_or_rexec(flags, bogus)
1147 #else
1148   extern bool re_execed;
1149   /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1150    * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1151    */
1152   void re_exec(char **argv) NORETURN FAST_FUNC;
1153   pid_t fork_or_rexec(char **argv) FAST_FUNC;
1154   int  BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1155   int  BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1156   void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
1157 # define fork()          BUG_fork_is_unavailable_on_nommu()
1158 # define xfork()         BUG_fork_is_unavailable_on_nommu()
1159 # define daemon(a,b)     BUG_daemon_is_unavailable_on_nommu()
1160 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
1161 #endif
1162 void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1163 void bb_sanitize_stdio(void) FAST_FUNC;
1164 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
1165 int sanitize_env_if_suid(void) FAST_FUNC;
1166
1167
1168 char* single_argv(char **argv) FAST_FUNC;
1169 extern const char *const bb_argv_dash[]; /* "-", NULL */
1170 extern const char *opt_complementary;
1171 #if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
1172 #define No_argument "\0"
1173 #define Required_argument "\001"
1174 #define Optional_argument "\002"
1175 extern const char *applet_long_options;
1176 #endif
1177 extern uint32_t option_mask32;
1178 extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
1179 /* BSD-derived getopt() functions require that optind be set to 1 in
1180  * order to reset getopt() state.  This used to be generally accepted
1181  * way of resetting getopt().  However, glibc's getopt()
1182  * has additional getopt() state beyond optind (specifically, glibc
1183  * extensions such as '+' and '-' at the start of the string), and requires
1184  * that optind be set to zero to reset its state.  BSD-derived versions
1185  * of getopt() misbehaved if optind is set to 0 in order to reset getopt(),
1186  * and glibc's getopt() used to coredump if optind is set 1 in order
1187  * to reset getopt().
1188  * Then BSD introduced additional variable "optreset" which should be
1189  * set to 1 in order to reset getopt().  Sigh.  Standards, anyone?
1190  *
1191  * By ~2008, OpenBSD 3.4 was changed to survive glibc-like optind = 0
1192  * (to interpret it as if optreset was set).
1193  */
1194 #ifdef __GLIBC__
1195 #define GETOPT_RESET() (optind = 0)
1196 #else /* BSD style */
1197 #define GETOPT_RESET() (optind = 1)
1198 #endif
1199
1200
1201 /* Having next pointer as a first member allows easy creation
1202  * of "llist-compatible" structs, and using llist_FOO functions
1203  * on them.
1204  */
1205 typedef struct llist_t {
1206         struct llist_t *link;
1207         char *data;
1208 } llist_t;
1209 void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1210 void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1211 void *llist_pop(llist_t **elm) FAST_FUNC;
1212 void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1213 void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1214 llist_t *llist_rev(llist_t *list) FAST_FUNC;
1215 llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
1216 /* BTW, surprisingly, changing API to
1217  *   llist_t *llist_add_to(llist_t *old_head, void *data)
1218  * etc does not result in smaller code... */
1219
1220 /* start_stop_daemon and udhcpc are special - they want
1221  * to create pidfiles regardless of FEATURE_PIDFILE */
1222 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
1223 /* True only if we created pidfile which is *file*, not /dev/null etc */
1224 extern smallint wrote_pidfile;
1225 void write_pidfile(const char *path) FAST_FUNC;
1226 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
1227 #else
1228 enum { wrote_pidfile = 0 };
1229 #define write_pidfile(path)  ((void)0)
1230 #define remove_pidfile(path) ((void)0)
1231 #endif
1232
1233 enum {
1234         LOGMODE_NONE = 0,
1235         LOGMODE_STDIO = (1 << 0),
1236         LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
1237         LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1238 };
1239 extern const char *msg_eol;
1240 extern smallint syslog_level;
1241 extern smallint logmode;
1242 extern uint8_t xfunc_error_retval;
1243 extern void (*die_func)(void);
1244 extern void xfunc_die(void) NORETURN FAST_FUNC;
1245 extern void bb_show_usage(void) NORETURN FAST_FUNC;
1246 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1247 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1248 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1249 extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1250 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1251 extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
1252 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1253 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1254 extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
1255 extern void bb_perror_nomsg(void) FAST_FUNC;
1256 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
1257 extern void bb_logenv_override(void) FAST_FUNC;
1258
1259 /* We need to export XXX_main from libbusybox
1260  * only if we build "individual" binaries
1261  */
1262 #if ENABLE_FEATURE_INDIVIDUAL
1263 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1264 #else
1265 #define MAIN_EXTERNALLY_VISIBLE
1266 #endif
1267
1268
1269 /* Applets which are useful from another applets */
1270 int bb_cat(char** argv) FAST_FUNC;
1271 /* If shell needs them, they exist even if not enabled as applets */
1272 int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1273 int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1274 int test_main(int argc, char **argv)
1275 #if ENABLE_TEST || ENABLE_TEST1 || ENABLE_TEST2
1276                 MAIN_EXTERNALLY_VISIBLE
1277 #endif
1278 ;
1279 int kill_main(int argc, char **argv)
1280 #if ENABLE_KILL || ENABLE_KILLALL || ENABLE_KILLALL5
1281                 MAIN_EXTERNALLY_VISIBLE
1282 #endif
1283 ;
1284 /* Similar, but used by chgrp, not shell */
1285 int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
1286 /* Used by ftpd */
1287 int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1288 /* Don't need IF_xxx() guard for these */
1289 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1290 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1291
1292 #if ENABLE_ROUTE
1293 void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
1294 #endif
1295
1296 struct number_state {
1297         unsigned width;
1298         unsigned start;
1299         unsigned inc;
1300         const char *sep;
1301         const char *empty_str;
1302         smallint all, nonempty;
1303 };
1304 void print_numbered_lines(struct number_state *ns, const char *filename) FAST_FUNC;
1305
1306
1307 /* Networking */
1308 /* This structure defines protocol families and their handlers. */
1309 struct aftype {
1310         const char *name;
1311         const char *title;
1312         int af;
1313         int alen;
1314         char*       FAST_FUNC (*print)(unsigned char *);
1315         const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1316         int         FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1317         void        FAST_FUNC (*herror)(char *text);
1318         int         FAST_FUNC (*rprint)(int options);
1319         int         FAST_FUNC (*rinput)(int typ, int ext, char **argv);
1320         /* may modify src */
1321         int         FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
1322 };
1323 /* This structure defines hardware protocols and their handlers. */
1324 struct hwtype {
1325         const char *name;
1326         const char *title;
1327         int type;
1328         int alen;
1329         char* FAST_FUNC (*print)(unsigned char *);
1330         int   FAST_FUNC (*input)(const char *, struct sockaddr *);
1331         int   FAST_FUNC (*activate)(int fd);
1332         int suppress_null_addr;
1333 };
1334 extern smallint interface_opt_a;
1335 int display_interfaces(char *ifname) FAST_FUNC;
1336 int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1337 #if ENABLE_FEATURE_HWIB
1338 int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1339 #else
1340 #define in_ib(a, b) 1 /* fail */
1341 #endif
1342 const struct aftype *get_aftype(const char *name) FAST_FUNC;
1343 const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1344 const struct hwtype *get_hwntype(int type) FAST_FUNC;
1345
1346
1347 extern int fstype_matches(const char *fstype, const char *comma_list) FAST_FUNC;
1348 #ifdef HAVE_MNTENT_H
1349 extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
1350 #endif
1351 extern void erase_mtab(const char * name) FAST_FUNC;
1352 extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1353 extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1354 #if ENABLE_DESKTOP
1355 extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1356 #else
1357 # define bb_warn_ignoring_args(arg) ((void)0)
1358 #endif
1359
1360 extern int get_linux_version_code(void) FAST_FUNC;
1361
1362 extern char *query_loop(const char *device) FAST_FUNC;
1363 extern int del_loop(const char *device) FAST_FUNC;
1364 /*
1365  * If *devname is not NULL, use that name, otherwise try to find free one,
1366  * malloc and return it in *devname.
1367  * return value is the opened fd to the loop device, or < on error
1368  */
1369 extern int set_loop(char **devname, const char *file, unsigned long long offset, unsigned flags) FAST_FUNC;
1370 /* These constants match linux/loop.h (without BB_ prefix): */
1371 #define BB_LO_FLAGS_READ_ONLY 1
1372 #define BB_LO_FLAGS_AUTOCLEAR 4
1373
1374 /* Like bb_ask below, but asks on stdin with no timeout.  */
1375 char *bb_ask_stdin(const char * prompt) FAST_FUNC;
1376 //TODO: pass buf pointer or return allocated buf (avoid statics)?
1377 char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
1378 int bb_ask_confirmation(void) FAST_FUNC;
1379
1380 /* Returns -1 if input is invalid. current_mode is a base for e.g. "u+rw" */
1381 int bb_parse_mode(const char* s, unsigned cur_mode) FAST_FUNC;
1382
1383 /*
1384  * Config file parser
1385  */
1386 enum {
1387         PARSE_COLLAPSE  = 0x00010000, // treat consecutive delimiters as one
1388         PARSE_TRIM      = 0x00020000, // trim leading and trailing delimiters
1389 // TODO: COLLAPSE and TRIM seem to always go in pair
1390         PARSE_GREEDY    = 0x00040000, // last token takes entire remainder of the line
1391         PARSE_MIN_DIE   = 0x00100000, // die if < min tokens found
1392         // keep a copy of current line
1393         PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
1394         PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
1395         // NORMAL is:
1396         // * remove leading and trailing delimiters and collapse
1397         //   multiple delimiters into one
1398         // * warn and continue if less than mintokens delimiters found
1399         // * grab everything into last token
1400         // * comments are recognized even if they aren't the first char
1401         PARSE_NORMAL    = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
1402 };
1403 typedef struct parser_t {
1404         FILE *fp;
1405         char *data;
1406         char *line, *nline;
1407         size_t line_alloc, nline_alloc;
1408         int lineno;
1409 } parser_t;
1410 parser_t* config_open(const char *filename) FAST_FUNC;
1411 parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
1412 /* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
1413 int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1414 #define config_read(parser, tokens, max, min, str, flags) \
1415         config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1416 void config_close(parser_t *parser) FAST_FUNC;
1417
1418 /* Concatenate path and filename to new allocated buffer.
1419  * Add "/" only as needed (no duplicate "//" are produced).
1420  * If path is NULL, it is assumed to be "/".
1421  * filename should not be NULL. */
1422 char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1423 /* Returns NULL on . and .. */
1424 char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1425
1426
1427 int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1428
1429 int get_signum(const char *name) FAST_FUNC;
1430 const char *get_signame(int number) FAST_FUNC;
1431 void print_signames(void) FAST_FUNC;
1432
1433 char *bb_simplify_path(const char *path) FAST_FUNC;
1434 /* Returns ptr to NUL */
1435 char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
1436
1437 #ifndef LOGIN_FAIL_DELAY
1438 #define LOGIN_FAIL_DELAY 3
1439 #endif
1440 extern void bb_do_delay(int seconds) FAST_FUNC;
1441 extern void change_identity(const struct passwd *pw) FAST_FUNC;
1442 extern void run_shell(const char *shell, int loginshell, const char **args) NORETURN FAST_FUNC;
1443
1444 /* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1445  * Note that getpwuid result might need xstrdup'ing
1446  * if there is a possibility of intervening getpwxxx() calls.
1447  */
1448 const char *get_shell_name(void) FAST_FUNC;
1449
1450 #if ENABLE_SELINUX
1451 extern void renew_current_security_context(void) FAST_FUNC;
1452 extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1453 extern context_t set_security_context_component(security_context_t cur_context,
1454                                                 char *user, char *role, char *type, char *range) FAST_FUNC;
1455 extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1456 extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1457 #else
1458 #define selinux_preserve_fcontext(fdesc) ((void)0)
1459 #endif
1460 extern void selinux_or_die(void) FAST_FUNC;
1461
1462
1463 /* setup_environment:
1464  * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
1465  * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1466  *   TERM=(old value)
1467  *   USER=pw->pw_name, LOGNAME=pw->pw_name
1468  *   PATH=bb_default_[root_]path
1469  *   HOME=pw->pw_dir
1470  *   SHELL=shell
1471  * else if change_env = 1:
1472  *   if not root (if pw->pw_uid != 0):
1473  *     USER=pw->pw_name, LOGNAME=pw->pw_name
1474  *   HOME=pw->pw_dir
1475  *   SHELL=shell
1476  * else does nothing
1477  */
1478 #define SETUP_ENV_CHANGEENV (1 << 0)
1479 #define SETUP_ENV_CLEARENV  (1 << 1)
1480 #define SETUP_ENV_TO_TMP    (1 << 2)
1481 #define SETUP_ENV_NO_CHDIR  (1 << 4)
1482 void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1483 void nuke_str(char *str) FAST_FUNC;
1484 #if ENABLE_FEATURE_SECURETTY && !ENABLE_PAM
1485 int check_securetty(const char *short_tty) FAST_FUNC;
1486 #else
1487 static ALWAYS_INLINE int check_securetty(const char *short_tty UNUSED_PARAM) { return 1; }
1488 #endif
1489 #define CHECKPASS_PW_HAS_EMPTY_PASSWORD 2
1490 int check_password(const struct passwd *pw, const char *plaintext) FAST_FUNC;
1491 int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1492 int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
1493 /* Returns a malloced string */
1494 #if !ENABLE_USE_BB_CRYPT
1495 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1496 #endif
1497 extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1498 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1499 /*
1500  * rnd is additional random input. New one is returned.
1501  * Useful if you call crypt_make_salt many times in a row:
1502  * rnd = crypt_make_salt(buf1, 4, 0);
1503  * rnd = crypt_make_salt(buf2, 4, rnd);
1504  * rnd = crypt_make_salt(buf3, 4, rnd);
1505  * (otherwise we risk having same salt generated)
1506  */
1507 extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1508 /* "$N$" + sha_salt_16_bytes + NUL */
1509 #define MAX_PW_SALT_LEN (3 + 16 + 1)
1510 extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1511
1512
1513 /* Returns number of lines changed, or -1 on error */
1514 #if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1515 #define update_passwd(filename, username, data, member) \
1516         update_passwd(filename, username, data)
1517 #endif
1518 extern int update_passwd(const char *filename,
1519                 const char *username,
1520                 const char *data,
1521                 const char *member) FAST_FUNC;
1522
1523 int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1524 int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1525 int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1526 int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1527 const char *nth_string(const char *strings, int n) FAST_FUNC;
1528
1529 extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1530 extern void print_login_prompt(void) FAST_FUNC;
1531
1532 char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
1533 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1534 int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1535 int get_terminal_width(int fd) FAST_FUNC;
1536
1537 int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1538 #define TERMIOS_CLEAR_ISIG (1 << 0)
1539 #define TERMIOS_RAW_CRNL   (1 << 1)
1540 #define TERMIOS_RAW_INPUT  (1 << 2)
1541 int set_termios_to_raw(int fd, struct termios *oldterm, int flags) FAST_FUNC;
1542
1543 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1544 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1545 int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1546 #if ENABLE_IOCTL_HEX2STR_ERROR
1547 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1548 int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1549 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1550 #define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp,#request)
1551 #else
1552 int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1553 int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1554 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1555 #define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp)
1556 #endif
1557
1558 char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1559 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1560 void reset_ino_dev_hashtable(void) FAST_FUNC;
1561 #ifdef __GLIBC__
1562 /* At least glibc has horrendously large inline for this, so wrap it */
1563 unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
1564 #undef makedev
1565 #define makedev(a,b) bb_makedev(a,b)
1566 #endif
1567
1568
1569 /* "Keycodes" that report an escape sequence.
1570  * We use something which fits into signed char,
1571  * yet doesn't represent any valid Unicode character.
1572  * Also, -1 is reserved for error indication and we don't use it. */
1573 enum {
1574         KEYCODE_UP        =  -2,
1575         KEYCODE_DOWN      =  -3,
1576         KEYCODE_RIGHT     =  -4,
1577         KEYCODE_LEFT      =  -5,
1578         KEYCODE_HOME      =  -6,
1579         KEYCODE_END       =  -7,
1580         KEYCODE_INSERT    =  -8,
1581         KEYCODE_DELETE    =  -9,
1582         KEYCODE_PAGEUP    = -10,
1583         KEYCODE_PAGEDOWN  = -11,
1584         KEYCODE_BACKSPACE = -12, /* Used only if Alt/Ctrl/Shifted */
1585         KEYCODE_D         = -13, /* Used only if Alted */
1586 #if 0
1587         KEYCODE_FUN1      = ,
1588         KEYCODE_FUN2      = ,
1589         KEYCODE_FUN3      = ,
1590         KEYCODE_FUN4      = ,
1591         KEYCODE_FUN5      = ,
1592         KEYCODE_FUN6      = ,
1593         KEYCODE_FUN7      = ,
1594         KEYCODE_FUN8      = ,
1595         KEYCODE_FUN9      = ,
1596         KEYCODE_FUN10     = ,
1597         KEYCODE_FUN11     = ,
1598         KEYCODE_FUN12     = ,
1599 #endif
1600         /* ^^^^^ Be sure that last defined value is small enough.
1601          * Current read_key() code allows going up to -32 (0xfff..fffe0).
1602          * This gives three upper bits in LSB to play with:
1603          * KEYCODE_foo values are 0xfff..fffXX, lowest XX bits are: scavvvvv,
1604          * s=0 if SHIFT, c=0 if CTRL, a=0 if ALT,
1605          * vvvvv bits are the same for same key regardless of "shift bits".
1606          */
1607         //KEYCODE_SHIFT_...   = KEYCODE_...   & ~0x80,
1608         KEYCODE_CTRL_RIGHT    = KEYCODE_RIGHT & ~0x40,
1609         KEYCODE_CTRL_LEFT     = KEYCODE_LEFT  & ~0x40,
1610         KEYCODE_ALT_RIGHT     = KEYCODE_RIGHT & ~0x20,
1611         KEYCODE_ALT_LEFT      = KEYCODE_LEFT  & ~0x20,
1612         KEYCODE_ALT_BACKSPACE = KEYCODE_BACKSPACE & ~0x20,
1613         KEYCODE_ALT_D         = KEYCODE_D     & ~0x20,
1614
1615         KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
1616         /* How long is the longest ESC sequence we know?
1617          * We want it big enough to be able to contain
1618          * cursor position sequence "ESC [ 9999 ; 9999 R"
1619          */
1620         KEYCODE_BUFFER_SIZE = 16
1621 };
1622 /* Note: fd may be in blocking or non-blocking mode, both make sense.
1623  * For one, less uses non-blocking mode.
1624  * Only the first read syscall inside read_key may block indefinitely
1625  * (unless fd is in non-blocking mode),
1626  * subsequent reads will time out after a few milliseconds.
1627  * Return of -1 means EOF or error (errno == 0 on EOF).
1628  * buffer[0] is used as a counter of buffered chars and must be 0
1629  * on first call.
1630  * timeout:
1631  * -2: do not poll for input;
1632  * -1: poll(-1) (i.e. block);
1633  * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
1634  */
1635 int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
1636 void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
1637
1638
1639 #if ENABLE_FEATURE_EDITING
1640 /* It's NOT just ENABLEd or disabled. It's a number: */
1641 # if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
1642 #  define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1643 unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
1644 # else
1645 #  define MAX_HISTORY 0
1646 # endif
1647 typedef struct line_input_t {
1648         int flags;
1649         const char *path_lookup;
1650 # if MAX_HISTORY
1651         int cnt_history;
1652         int cur_history;
1653         int max_history; /* must never be <= 0 */
1654 #  if ENABLE_FEATURE_EDITING_SAVEHISTORY
1655         /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1656          * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1657          * in on-disk history"
1658          * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1659          * also in on-disk history (and thus need to be skipped on save)"
1660          */
1661         unsigned cnt_history_in_file;
1662         const char *hist_file;
1663 #  endif
1664         char *history[MAX_HISTORY + 1];
1665 # endif
1666 } line_input_t;
1667 enum {
1668         DO_HISTORY       = 1 * (MAX_HISTORY > 0),
1669         TAB_COMPLETION   = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1670         USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1671         VI_MODE          = 8 * ENABLE_FEATURE_EDITING_VI,
1672         WITH_PATH_LOOKUP = 0x10,
1673         FOR_SHELL        = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1674 };
1675 line_input_t *new_line_input_t(int flags) FAST_FUNC;
1676 /* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1677 /*
1678  * maxsize must be >= 2.
1679  * Returns:
1680  * -1 on read errors or EOF, or on bare Ctrl-D,
1681  * 0  on ctrl-C (the line entered is still returned in 'command'),
1682  * >0 length of input string, including terminating '\n'
1683  */
1684 int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize, int timeout) FAST_FUNC;
1685 void show_history(const line_input_t *st) FAST_FUNC;
1686 # if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1687 void save_history(line_input_t *st);
1688 # endif
1689 #else
1690 #define MAX_HISTORY 0
1691 int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1692 #define read_line_input(state, prompt, command, maxsize, timeout) \
1693         read_line_input(prompt, command, maxsize)
1694 #endif
1695
1696
1697 #ifndef COMM_LEN
1698 # ifdef TASK_COMM_LEN
1699 enum { COMM_LEN = TASK_COMM_LEN };
1700 # else
1701 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1702 enum { COMM_LEN = 16 };
1703 # endif
1704 #endif
1705
1706 struct smaprec {
1707         unsigned long mapped_rw;
1708         unsigned long mapped_ro;
1709         unsigned long shared_clean;
1710         unsigned long shared_dirty;
1711         unsigned long private_clean;
1712         unsigned long private_dirty;
1713         unsigned long stack;
1714         unsigned long smap_pss, smap_swap;
1715         unsigned long smap_size;
1716         unsigned long smap_start;
1717         char smap_mode[5];
1718         char *smap_name;
1719 };
1720
1721 #if !ENABLE_PMAP
1722 #define procps_read_smaps(pid, total, cb, data) \
1723         procps_read_smaps(pid, total)
1724 #endif
1725 int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1726                 void (*cb)(struct smaprec *, void *), void *data);
1727
1728 typedef struct procps_status_t {
1729         DIR *dir;
1730         IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
1731         uint8_t shift_pages_to_bytes;
1732         uint8_t shift_pages_to_kb;
1733 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1734         uint16_t argv_len;
1735         char *argv0;
1736         char *exe;
1737         IF_SELINUX(char *context;)
1738         IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
1739         /* Everything below must contain no ptrs to malloc'ed data:
1740          * it is memset(0) for each process in procps_scan() */
1741         unsigned long vsz, rss; /* we round it to kbytes */
1742         unsigned long stime, utime;
1743         unsigned long start_time;
1744         unsigned pid;
1745         unsigned ppid;
1746         unsigned pgid;
1747         unsigned sid;
1748         unsigned uid;
1749         unsigned gid;
1750 #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1751         unsigned ruid;
1752         unsigned rgid;
1753         int niceness;
1754 #endif
1755         unsigned tty_major,tty_minor;
1756 #if ENABLE_FEATURE_TOPMEM
1757         struct smaprec smaps;
1758 #endif
1759         char state[4];
1760         /* basename of executable in exec(2), read from /proc/N/stat
1761          * (if executable is symlink or script, it is NOT replaced
1762          * by link target or interpreter name) */
1763         char comm[COMM_LEN];
1764         /* user/group? - use passwd/group parsing functions */
1765 #if ENABLE_FEATURE_TOP_SMP_PROCESS
1766         int last_seen_on_cpu;
1767 #endif
1768 } procps_status_t;
1769 /* flag bits for procps_scan(xx, flags) calls */
1770 enum {
1771         PSSCAN_PID      = 1 << 0,
1772         PSSCAN_PPID     = 1 << 1,
1773         PSSCAN_PGID     = 1 << 2,
1774         PSSCAN_SID      = 1 << 3,
1775         PSSCAN_UIDGID   = 1 << 4,
1776         PSSCAN_COMM     = 1 << 5,
1777         /* PSSCAN_CMD      = 1 << 6, - use read_cmdline instead */
1778         PSSCAN_ARGV0    = 1 << 7,
1779         PSSCAN_EXE      = 1 << 8,
1780         PSSCAN_STATE    = 1 << 9,
1781         PSSCAN_VSZ      = 1 << 10,
1782         PSSCAN_RSS      = 1 << 11,
1783         PSSCAN_STIME    = 1 << 12,
1784         PSSCAN_UTIME    = 1 << 13,
1785         PSSCAN_TTY      = 1 << 14,
1786         PSSCAN_SMAPS    = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1787         /* NB: used by find_pid_by_name(). Any applet using it
1788          * needs to be mentioned here. */
1789         PSSCAN_ARGVN    = (1 << 16) * (ENABLE_KILLALL
1790                                 || ENABLE_PGREP || ENABLE_PKILL
1791                                 || ENABLE_PIDOF
1792                                 || ENABLE_SESTATUS
1793                                 ),
1794         PSSCAN_CONTEXT  = (1 << 17) * ENABLE_SELINUX,
1795         PSSCAN_START_TIME = 1 << 18,
1796         PSSCAN_CPU      = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1797         PSSCAN_NICE     = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1798         PSSCAN_RUIDGID  = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1799         PSSCAN_TASKS    = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
1800 };
1801 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1802 void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1803 procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
1804 /* Format cmdline (up to col chars) into char buf[size] */
1805 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1806 void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
1807 pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1808 pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
1809 int starts_with_cpu(const char *str) FAST_FUNC;
1810 unsigned get_cpu_count(void) FAST_FUNC;
1811
1812
1813 /* Use strict=1 if you process input from untrusted source:
1814  * it will return NULL on invalid %xx (bad hex chars)
1815  * and str + 1 if decoded char is / or NUL.
1816  * In non-strict mode, it always succeeds (returns str),
1817  * and also it additionally decoded '+' to space.
1818  */
1819 char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
1820
1821
1822 extern const char bb_uuenc_tbl_base64[] ALIGN1;
1823 extern const char bb_uuenc_tbl_std[] ALIGN1;
1824 void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
1825 enum {
1826         BASE64_FLAG_UU_STOP = 0x100,
1827         /* Sign-extends to a value which never matches fgetc result: */
1828         BASE64_FLAG_NO_STOP_CHAR = 0x80,
1829 };
1830 const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
1831 void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
1832
1833 typedef struct md5_ctx_t {
1834         uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1835         void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
1836         uint64_t total64;    /* must be directly before hash[] */
1837         uint32_t hash[8];    /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1838 } md5_ctx_t;
1839 typedef struct md5_ctx_t sha1_ctx_t;
1840 typedef struct md5_ctx_t sha256_ctx_t;
1841 typedef struct sha512_ctx_t {
1842         uint64_t total64[2];  /* must be directly before hash[] */
1843         uint64_t hash[8];
1844         uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
1845 } sha512_ctx_t;
1846 typedef struct sha3_ctx_t {
1847         uint64_t state[25];
1848         unsigned bytes_queued;
1849         unsigned input_block_bytes;
1850 } sha3_ctx_t;
1851 void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1852 void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1853 unsigned md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1854 void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1855 #define sha1_hash md5_hash
1856 unsigned sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1857 void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1858 #define sha256_hash md5_hash
1859 #define sha256_end  sha1_end
1860 void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1861 void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1862 unsigned sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
1863 void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
1864 void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1865 unsigned sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
1866 /* TLS benefits from knowing that sha1 and sha256 share these. Give them "agnostic" names too */
1867 typedef struct md5_ctx_t md5sha_ctx_t;
1868 #define md5sha_hash md5_hash
1869 #define sha_end sha1_end
1870
1871 extern uint32_t *global_crc32_table;
1872 uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1873 uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1874 uint32_t crc32_block_endian0(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1875
1876 typedef struct masks_labels_t {
1877         const char *labels;
1878         const int masks[];
1879 } masks_labels_t;
1880 int print_flags_separated(const int *masks, const char *labels,
1881                 int flags, const char *separator) FAST_FUNC;
1882 int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
1883
1884 typedef struct bb_progress_t {
1885         unsigned last_size;
1886         unsigned last_update_sec;
1887         unsigned last_change_sec;
1888         unsigned start_sec;
1889         const char *curfile;
1890 } bb_progress_t;
1891
1892 #define is_bb_progress_inited(p) ((p)->curfile != NULL)
1893 #define bb_progress_free(p) do { \
1894         if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1895         (p)->curfile = NULL; \
1896 } while (0)
1897 void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
1898 void bb_progress_update(bb_progress_t *p,
1899                         uoff_t beg_range,
1900                         uoff_t transferred,
1901                         uoff_t totalsize) FAST_FUNC;
1902
1903 unsigned ubi_devnum_from_devname(const char *str) FAST_FUNC;
1904 int ubi_get_volid_by_name(unsigned ubi_devnum, const char *vol_name) FAST_FUNC;
1905
1906
1907 extern const char *applet_name;
1908
1909 /* Some older linkers don't perform string merging, we used to have common strings
1910  * as global arrays to do it by hand. But:
1911  * (1) newer linkers do it themselves,
1912  * (2) however, they DONT merge string constants with global arrays,
1913  * even if the value is the same (!). Thus global arrays actually
1914  * increased size a bit: for example, "/etc/passwd" string from libc
1915  * wasn't merged with bb_path_passwd_file[] array!
1916  * Therefore now we use #defines.
1917  */
1918 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1919 extern const char bb_banner[] ALIGN1;
1920 extern const char bb_msg_memory_exhausted[] ALIGN1;
1921 extern const char bb_msg_invalid_date[] ALIGN1;
1922 #define bb_msg_read_error "read error"
1923 #define bb_msg_write_error "write error"
1924 extern const char bb_msg_unknown[] ALIGN1;
1925 extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
1926 extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
1927 extern const char bb_msg_you_must_be_root[] ALIGN1;
1928 extern const char bb_msg_requires_arg[] ALIGN1;
1929 extern const char bb_msg_invalid_arg_to[] ALIGN1;
1930 extern const char bb_msg_standard_input[] ALIGN1;
1931 extern const char bb_msg_standard_output[] ALIGN1;
1932
1933 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1934 extern const char bb_hexdigits_upcase[] ALIGN1;
1935
1936 extern const char bb_path_wtmp_file[] ALIGN1;
1937
1938 /* Busybox mount uses either /proc/mounts or /etc/mtab to
1939  * get the list of currently mounted filesystems */
1940 #define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1941
1942 #define bb_path_passwd_file  _PATH_PASSWD
1943 #define bb_path_group_file   _PATH_GROUP
1944 #define bb_path_shadow_file  _PATH_SHADOW
1945 #define bb_path_gshadow_file _PATH_GSHADOW
1946
1947 #define bb_path_motd_file "/etc/motd"
1948
1949 #define bb_dev_null "/dev/null"
1950 extern const char bb_busybox_exec_path[] ALIGN1;
1951 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1952  * but I want to save a few bytes here */
1953 extern const char bb_PATH_root_path[] ALIGN1; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1954 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1955 #define bb_default_path      (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1956
1957 extern const int const_int_0;
1958 //extern const int const_int_1;
1959
1960 /* This struct is deliberately not defined. */
1961 /* See docs/keep_data_small.txt */
1962 struct globals;
1963 /* '*const' ptr makes gcc optimize code much better.
1964  * Magic prevents ptr_to_globals from going into rodata.
1965  * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1966 extern struct globals *const ptr_to_globals;
1967 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1968 #define barrier() __asm__ __volatile__("":::"memory")
1969 #define SET_PTR_TO_GLOBALS(x) do { \
1970         (*(struct globals**)&ptr_to_globals) = (void*)(x); \
1971         barrier(); \
1972 } while (0)
1973 #define FREE_PTR_TO_GLOBALS() do { \
1974         if (ENABLE_FEATURE_CLEAN_UP) { \
1975                 free(ptr_to_globals); \
1976         } \
1977 } while (0)
1978
1979 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1980  * use bb_default_login_shell and following defines.
1981  * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1982  * don't forget to change increment constant. */
1983 #define LIBBB_DEFAULT_LOGIN_SHELL  "-/bin/sh"
1984 extern const char bb_default_login_shell[] ALIGN1;
1985 /* "/bin/sh" */
1986 #define DEFAULT_SHELL              (bb_default_login_shell+1)
1987 /* "sh" */
1988 #define DEFAULT_SHELL_SHORT_NAME   (bb_default_login_shell+6)
1989
1990 /* The following devices are the same on all systems.  */
1991 #define CURRENT_TTY "/dev/tty"
1992 #define DEV_CONSOLE "/dev/console"
1993
1994 #if defined(__FreeBSD_kernel__)
1995 # define CURRENT_VC CURRENT_TTY
1996 # define VC_1 "/dev/ttyv0"
1997 # define VC_2 "/dev/ttyv1"
1998 # define VC_3 "/dev/ttyv2"
1999 # define VC_4 "/dev/ttyv3"
2000 # define VC_5 "/dev/ttyv4"
2001 # define VC_FORMAT "/dev/ttyv%d"
2002 #elif defined(__GNU__)
2003 # define CURRENT_VC CURRENT_TTY
2004 # define VC_1 "/dev/tty1"
2005 # define VC_2 "/dev/tty2"
2006 # define VC_3 "/dev/tty3"
2007 # define VC_4 "/dev/tty4"
2008 # define VC_5 "/dev/tty5"
2009 # define VC_FORMAT "/dev/tty%d"
2010 #elif ENABLE_FEATURE_DEVFS
2011 /*Linux, obsolete devfs names */
2012 # define CURRENT_VC "/dev/vc/0"
2013 # define VC_1 "/dev/vc/1"
2014 # define VC_2 "/dev/vc/2"
2015 # define VC_3 "/dev/vc/3"
2016 # define VC_4 "/dev/vc/4"
2017 # define VC_5 "/dev/vc/5"
2018 # define VC_FORMAT "/dev/vc/%d"
2019 # define LOOP_FORMAT "/dev/loop/%u"
2020 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
2021 # define LOOP_NAME "/dev/loop/"
2022 # define FB_0 "/dev/fb/0"
2023 #else
2024 /*Linux, normal names */
2025 # define CURRENT_VC "/dev/tty0"
2026 # define VC_1 "/dev/tty1"
2027 # define VC_2 "/dev/tty2"
2028 # define VC_3 "/dev/tty3"
2029 # define VC_4 "/dev/tty4"
2030 # define VC_5 "/dev/tty5"
2031 # define VC_FORMAT "/dev/tty%d"
2032 # define LOOP_FORMAT "/dev/loop%u"
2033 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
2034 # define LOOP_NAME "/dev/loop"
2035 # define FB_0 "/dev/fb0"
2036 #endif
2037
2038
2039 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
2040 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
2041
2042
2043 /* We redefine ctype macros. Unicode-correct handling of char types
2044  * can't be done with such byte-oriented operations anyway,
2045  * we don't lose anything.
2046  */
2047 #undef isalnum
2048 #undef isalpha
2049 #undef isascii
2050 #undef isblank
2051 #undef iscntrl
2052 #undef isdigit
2053 #undef isgraph
2054 #undef islower
2055 #undef isprint
2056 #undef ispunct
2057 #undef isspace
2058 #undef isupper
2059 #undef isxdigit
2060 #undef toupper
2061 #undef tolower
2062
2063 /* We save ~500 bytes on isdigit alone.
2064  * BTW, x86 likes (unsigned char) cast more than (unsigned). */
2065
2066 /* These work the same for ASCII and Unicode,
2067  * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
2068 #define isascii(a) ((unsigned char)(a) <= 0x7f)
2069 #define isdigit(a) ((unsigned char)((a) - '0') <= 9)
2070 #define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
2071 #define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
2072 #define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
2073 #define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
2074 #define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
2075 /* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
2076  * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
2077  */
2078 #define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
2079 // Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
2080 #define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
2081 // Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
2082 #define isalnum(a) bb_ascii_isalnum(a)
2083 static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
2084 {
2085         unsigned char b = a - '0';
2086         if (b <= 9)
2087                 return (b <= 9);
2088         b = (a|0x20) - 'a';
2089         return b <= 'z' - 'a';
2090 }
2091 #define isxdigit(a) bb_ascii_isxdigit(a)
2092 static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
2093 {
2094         unsigned char b = a - '0';
2095         if (b <= 9)
2096                 return (b <= 9);
2097         b = (a|0x20) - 'a';
2098         return b <= 'f' - 'a';
2099 }
2100 #define toupper(a) bb_ascii_toupper(a)
2101 static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
2102 {
2103         unsigned char b = a - 'a';
2104         if (b <= ('z' - 'a'))
2105                 a -= 'a' - 'A';
2106         return a;
2107 }
2108 #define tolower(a) bb_ascii_tolower(a)
2109 static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
2110 {
2111         unsigned char b = a - 'A';
2112         if (b <= ('Z' - 'A'))
2113                 a += 'a' - 'A';
2114         return a;
2115 }
2116
2117 /* In ASCII and Unicode, these are likely to be very different.
2118  * Let's prevent ambiguous usage from the start */
2119 #define isgraph(a) isgraph_is_ambiguous_dont_use(a)
2120 #define isprint(a) isprint_is_ambiguous_dont_use(a)
2121 /* NB: must not treat EOF as isgraph or isprint */
2122 #define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
2123 #define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
2124
2125
2126 /* Simple unit-testing framework */
2127
2128 typedef void (*bbunit_testfunc)(void);
2129
2130 struct bbunit_listelem {
2131         const char* name;
2132         bbunit_testfunc testfunc;
2133 };
2134
2135 void bbunit_registertest(struct bbunit_listelem* test);
2136 void bbunit_settestfailed(void);
2137
2138 #define BBUNIT_DEFINE_TEST(NAME) \
2139         static void bbunit_##NAME##_test(void); \
2140         static struct bbunit_listelem bbunit_##NAME##_elem = { \
2141                 .name = #NAME, \
2142                 .testfunc = bbunit_##NAME##_test, \
2143         }; \
2144         static void INIT_FUNC bbunit_##NAME##_register(void) \
2145         { \
2146                 bbunit_registertest(&bbunit_##NAME##_elem); \
2147         } \
2148         static void bbunit_##NAME##_test(void)
2149
2150 /*
2151  * Both 'goto bbunit_end' and 'break' are here only to get rid
2152  * of compiler warnings.
2153  */
2154 #define BBUNIT_ENDTEST \
2155         do { \
2156                 goto bbunit_end; \
2157         bbunit_end: \
2158                 break; \
2159         } while (0)
2160
2161 #define BBUNIT_PRINTASSERTFAIL \
2162         do { \
2163                 bb_error_msg( \
2164                         "[ERROR] Assertion failed in file %s, line %d", \
2165                         __FILE__, __LINE__); \
2166         } while (0)
2167
2168 #define BBUNIT_ASSERTION_FAILED \
2169         do { \
2170                 bbunit_settestfailed(); \
2171                 goto bbunit_end; \
2172         } while (0)
2173
2174 /*
2175  * Assertions.
2176  * For now we only offer assertions which cause tests to fail
2177  * immediately. In the future 'expects' might be added too -
2178  * similar to those offered by the gtest framework.
2179  */
2180 #define BBUNIT_ASSERT_EQ(EXPECTED, ACTUAL) \
2181         do { \
2182                 if ((EXPECTED) != (ACTUAL)) { \
2183                         BBUNIT_PRINTASSERTFAIL; \
2184                         bb_error_msg("[ERROR] '%s' isn't equal to '%s'", \
2185                                                 #EXPECTED, #ACTUAL); \
2186                         BBUNIT_ASSERTION_FAILED; \
2187                 } \
2188         } while (0)
2189
2190 #define BBUNIT_ASSERT_NOTEQ(EXPECTED, ACTUAL) \
2191         do { \
2192                 if ((EXPECTED) == (ACTUAL)) { \
2193                         BBUNIT_PRINTASSERTFAIL; \
2194                         bb_error_msg("[ERROR] '%s' is equal to '%s'", \
2195                                                 #EXPECTED, #ACTUAL); \
2196                         BBUNIT_ASSERTION_FAILED; \
2197                 } \
2198         } while (0)
2199
2200 #define BBUNIT_ASSERT_NOTNULL(PTR) \
2201         do { \
2202                 if ((PTR) == NULL) { \
2203                         BBUNIT_PRINTASSERTFAIL; \
2204                         bb_error_msg("[ERROR] '%s' is NULL!", #PTR); \
2205                         BBUNIT_ASSERTION_FAILED; \
2206                 } \
2207         } while (0)
2208
2209 #define BBUNIT_ASSERT_NULL(PTR) \
2210         do { \
2211                 if ((PTR) != NULL) { \
2212                         BBUNIT_PRINTASSERTFAIL; \
2213                         bb_error_msg("[ERROR] '%s' is not NULL!", #PTR); \
2214                         BBUNIT_ASSERTION_FAILED; \
2215                 } \
2216         } while (0)
2217
2218 #define BBUNIT_ASSERT_FALSE(STATEMENT) \
2219         do { \
2220                 if ((STATEMENT)) { \
2221                         BBUNIT_PRINTASSERTFAIL; \
2222                         bb_error_msg("[ERROR] Statement '%s' evaluated to true!", \
2223                                                                 #STATEMENT); \
2224                         BBUNIT_ASSERTION_FAILED; \
2225                 } \
2226         } while (0)
2227
2228 #define BBUNIT_ASSERT_TRUE(STATEMENT) \
2229         do { \
2230                 if (!(STATEMENT)) { \
2231                         BBUNIT_PRINTASSERTFAIL; \
2232                         bb_error_msg("[ERROR] Statement '%s' evaluated to false!", \
2233                                         #STATEMENT); \
2234                         BBUNIT_ASSERTION_FAILED; \
2235                 } \
2236         } while (0)
2237
2238 #define BBUNIT_ASSERT_STREQ(STR1, STR2) \
2239         do { \
2240                 if (strcmp(STR1, STR2) != 0) { \
2241                         BBUNIT_PRINTASSERTFAIL; \
2242                         bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2243                                         "are not the same", STR1, STR2); \
2244                         BBUNIT_ASSERTION_FAILED; \
2245                 } \
2246         } while (0)
2247
2248 #define BBUNIT_ASSERT_STRNOTEQ(STR1, STR2) \
2249         do { \
2250                 if (strcmp(STR1, STR2) == 0) { \
2251                         BBUNIT_PRINTASSERTFAIL; \
2252                         bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2253                                         "are the same, but were " \
2254                                         "expected to differ", STR1, STR2); \
2255                         BBUNIT_ASSERTION_FAILED; \
2256                 } \
2257         } while (0)
2258
2259
2260 POP_SAVED_FUNCTION_VISIBILITY
2261
2262 #endif