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