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