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