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