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;
 691/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
 692 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
 693 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
 694 * If there is no suffix, port argument is used */
 695int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
 696/* Connect to peer identified by lsa */
 697int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
 698/* Get local address of bound or accepted socket */
 699len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
 700/* Get remote address of connected or accepted socket */
 701len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
 702/* Return malloc'ed len_and_sockaddr with socket address of host:port
 703 * Currently will return IPv4 or IPv6 sockaddrs only
 704 * (depending on host), but in theory nothing prevents e.g.
 705 * UNIX socket address being returned, IPX sockaddr etc...
 706 * On error does bb_error_msg and returns NULL */
 707len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
 708/* Version which dies on error */
 709len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
 710len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
 711/* Same, useful if you want to force family (e.g. IPv6) */
 712#if !ENABLE_FEATURE_IPV6
 713#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
 714#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
 715#else
 716len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
 717len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
 718#endif
 719/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
 720 * otherwise no-op. Useful for ftp.
 721 * NB: does NOT do htons() internally, just direct assignment. */
 722void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
 723/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
 724int get_nport(const struct sockaddr *sa) FAST_FUNC;
 725/* Reverse DNS. Returns NULL on failure. */
 726char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 727/* This one doesn't append :PORTNUM */
 728char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 729/* This one also doesn't fall back to dotted IP (returns NULL) */
 730char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 731/* inet_[ap]ton on steroids */
 732char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 733char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 734// "old" (ipv4 only) API
 735// users: traceroute.c hostname.c - use _list_ of all IPs
 736struct hostent *xgethostbyname(const char *name) FAST_FUNC;
 737// Also mount.c and inetd.c are using gethostbyname(),
 738// + inet_common.c has additional IPv4-only stuff
 739
 740
 741struct tls_aes {
 742        uint32_t key[60];
 743        unsigned rounds;
 744};
 745#define TLS_MAX_MAC_SIZE 32
 746#define TLS_MAX_KEY_SIZE 32
 747#define TLS_MAX_IV_SIZE   4
 748struct tls_handshake_data; /* opaque */
 749typedef struct tls_state {
 750        unsigned flags;
 751
 752        int ofd;
 753        int ifd;
 754
 755        unsigned min_encrypted_len_on_read;
 756        uint16_t cipher_id;
 757        unsigned MAC_size;
 758        unsigned key_size;
 759        unsigned IV_size;
 760
 761        uint8_t *outbuf;
 762        int     outbuf_size;
 763
 764        int     inbuf_size;
 765        int     ofs_to_buffered;
 766        int     buffered_size;
 767        uint8_t *inbuf;
 768
 769        struct tls_handshake_data *hsd;
 770
 771        // RFC 5246
 772        // sequence number
 773        //   Each connection state contains a sequence number, which is
 774        //   maintained separately for read and write states.  The sequence
 775        //   number MUST be set to zero whenever a connection state is made the
 776        //   active state.  Sequence numbers are of type uint64 and may not
 777        //   exceed 2^64-1.
 778        /*uint64_t read_seq64_be;*/
 779        uint64_t write_seq64_be;
 780
 781        /*uint8_t *server_write_MAC_key;*/
 782        uint8_t *client_write_key;
 783        uint8_t *server_write_key;
 784        uint8_t *client_write_IV;
 785        uint8_t *server_write_IV;
 786        uint8_t client_write_MAC_key[TLS_MAX_MAC_SIZE];
 787        uint8_t server_write_MAC_k__[TLS_MAX_MAC_SIZE];
 788        uint8_t client_write_k__[TLS_MAX_KEY_SIZE];
 789        uint8_t server_write_k__[TLS_MAX_KEY_SIZE];
 790        uint8_t client_write_I_[TLS_MAX_IV_SIZE];
 791        uint8_t server_write_I_[TLS_MAX_IV_SIZE];
 792
 793        struct tls_aes aes_encrypt;
 794        struct tls_aes aes_decrypt;
 795        uint8_t H[16]; //used by AES_GCM
 796} tls_state_t;
 797
 798static inline tls_state_t *new_tls_state(void)
 799{
 800        tls_state_t *tls = xzalloc(sizeof(*tls));
 801        return tls;
 802}
 803void tls_handshake(tls_state_t *tls, const char *sni) FAST_FUNC;
 804#define TLSLOOP_EXIT_ON_LOCAL_EOF (1 << 0)
 805void tls_run_copy_loop(tls_state_t *tls, unsigned flags) FAST_FUNC;
 806
 807
 808void socket_want_pktinfo(int fd) FAST_FUNC;
 809ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
 810                const struct sockaddr *to,
 811                const struct sockaddr *from,
 812                socklen_t tolen) FAST_FUNC;
 813ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
 814                struct sockaddr *from,
 815                struct sockaddr *to,
 816                socklen_t sa_size) FAST_FUNC;
 817
 818uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
 819int parse_pasv_epsv(char *buf) FAST_FUNC;
 820
 821/* 0 if argv[0] is NULL: */
 822unsigned string_array_len(char **argv) FAST_FUNC;
 823void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
 824char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
 825char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
 826unsigned count_strstr(const char *str, const char *sub) FAST_FUNC;
 827char *xmalloc_substitute_string(const char *src, int count, const char *sub, const char *repl) FAST_FUNC;
 828/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
 829 * But potentially slow, don't use in one-billion-times loops */
 830int bb_putchar(int ch) FAST_FUNC;
 831/* Note: does not use stdio, writes to fd 2 directly */
 832int bb_putchar_stderr(char ch) FAST_FUNC;
 833char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
 834char *auto_string(char *str) FAST_FUNC;
 835// gcc-4.1.1 still isn't good enough at optimizing it
 836// (+200 bytes compared to macro)
 837//static ALWAYS_INLINE
 838//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
 839//static ALWAYS_INLINE
 840//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
 841#define LONE_DASH(s)     ((s)[0] == '-' && !(s)[1])
 842#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
 843#define LONE_CHAR(s,c)     ((s)[0] == (c) && !(s)[1])
 844#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
 845#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
 846
 847typedef struct uni_stat_t {
 848        unsigned byte_count;
 849        unsigned unicode_count;
 850        unsigned unicode_width;
 851} uni_stat_t;
 852/* Returns a string with unprintable chars replaced by '?' or
 853 * SUBST_WCHAR. This function is unicode-aware. */
 854const char* FAST_FUNC printable_string(const char *str);
 855const char* FAST_FUNC printable_string2(uni_stat_t *stats, const char *str);
 856/* Prints unprintable char ch as ^C or M-c to file
 857 * (M-c is used only if ch is ORed with PRINTABLE_META),
 858 * else it is printed as-is (except for ch = 0x9b) */
 859enum { PRINTABLE_META = 0x100 };
 860void fputc_printable(int ch, FILE *file) FAST_FUNC;
 861/* Return a string that is the printable representation of character ch.
 862 * Buffer must hold at least four characters. */
 863enum {
 864        VISIBLE_ENDLINE   = 1 << 0,
 865        VISIBLE_SHOW_TABS = 1 << 1,
 866};
 867void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
 868
 869extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
 870extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count) FAST_FUNC;
 871// NB: will return short read on error, not -1,
 872// if some data was read before error occurred
 873extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
 874extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
 875extern unsigned char xread_char(int fd) FAST_FUNC;
 876extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
 877extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
 878// Reads one line a-la fgets (but doesn't save terminating '\n').
 879// Reads byte-by-byte. Useful when it is important to not read ahead.
 880// Bytes are appended to pfx (which must be malloced, or NULL).
 881extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
 882/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
 883extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 884/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
 885extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 886/* Never returns NULL */
 887extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 888
 889#if defined(ARG_MAX) && (ARG_MAX >= 60*1024 || !defined(_SC_ARG_MAX))
 890/* Use _constant_ maximum if: defined && (big enough || no variable one exists) */
 891# define bb_arg_max() ((unsigned)ARG_MAX)
 892#elif defined(_SC_ARG_MAX)
 893/* Else use variable one (a bit more expensive) */
 894unsigned bb_arg_max(void) FAST_FUNC;
 895#else
 896/* If all else fails */
 897# define bb_arg_max() ((unsigned)(32 * 1024))
 898#endif
 899unsigned bb_clk_tck(void) FAST_FUNC;
 900
 901#define SEAMLESS_COMPRESSION (0 \
 902 || ENABLE_FEATURE_SEAMLESS_XZ \
 903 || ENABLE_FEATURE_SEAMLESS_LZMA \
 904 || ENABLE_FEATURE_SEAMLESS_BZ2 \
 905 || ENABLE_FEATURE_SEAMLESS_GZ \
 906 || ENABLE_FEATURE_SEAMLESS_Z)
 907
 908#if SEAMLESS_COMPRESSION
 909/* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
 910int setup_unzip_on_fd(int fd, int fail_if_not_compressed) FAST_FUNC;
 911/* Autodetects .gz etc */
 912extern int open_zipped(const char *fname, int fail_if_not_compressed) FAST_FUNC;
 913extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 914#else
 915# define setup_unzip_on_fd(...) (0)
 916# define open_zipped(fname, fail_if_not_compressed)  open((fname), O_RDONLY);
 917# define xmalloc_open_zipped_read_close(fname, maxsz_p) xmalloc_open_read_close((fname), (maxsz_p))
 918#endif
 919/* lzma has no signature, need a little helper. NB: exist only for ENABLE_FEATURE_SEAMLESS_LZMA=y */
 920void setup_lzma_on_fd(int fd) FAST_FUNC;
 921
 922extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
 923// NB: will return short write on error, not -1,
 924// if some data was written before error occurred
 925extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
 926extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
 927extern void xwrite_str(int fd, const char *str) FAST_FUNC;
 928extern ssize_t full_write1_str(const char *str) FAST_FUNC;
 929extern ssize_t full_write2_str(const char *str) FAST_FUNC;
 930extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
 931
 932/* Close fd, but check for failures (some types of write errors) */
 933extern void xclose(int fd) FAST_FUNC;
 934
 935/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
 936extern void xprint_and_close_file(FILE *file) FAST_FUNC;
 937
 938/* Reads a line from a text file, up to a newline or NUL byte, inclusive.
 939 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
 940 * end of line. If end isn't NULL, length of the chunk is stored in it.
 941 * Returns NULL if EOF/error.
 942 */
 943extern char *bb_get_chunk_from_file(FILE *file, size_t *end) FAST_FUNC;
 944/* Reads up to (and including) TERMINATING_STRING: */
 945extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
 946/* Same, with limited max size, and returns the length (excluding NUL): */
 947extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 948/* Chops off TERMINATING_STRING from the end: */
 949extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
 950/* Reads up to (and including) "\n" or NUL byte: */
 951extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
 952/* Chops off '\n' from the end, unlike fgets: */
 953extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
 954/* Same, but doesn't try to conserve space (may have some slack after the end) */
 955/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
 956
 957void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
 958void die_if_ferror_stdout(void) FAST_FUNC;
 959int fflush_all(void) FAST_FUNC;
 960void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
 961int fclose_if_not_stdin(FILE *file) FAST_FUNC;
 962FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
 963/* Prints warning to stderr and returns NULL on failure: */
 964FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
 965/* "Opens" stdin if filename is special, else just opens file: */
 966FILE* xfopen_stdin(const char *filename) FAST_FUNC;
 967FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
 968FILE* fopen_for_read(const char *path) FAST_FUNC;
 969FILE* xfopen_for_read(const char *path) FAST_FUNC;
 970FILE* fopen_for_write(const char *path) FAST_FUNC;
 971FILE* xfopen_for_write(const char *path) FAST_FUNC;
 972FILE* xfdopen_for_read(int fd) FAST_FUNC;
 973FILE* xfdopen_for_write(int fd) FAST_FUNC;
 974
 975int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
 976void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
 977
 978/* Wrapper which restarts poll on EINTR or ENOMEM.
 979 * On other errors complains [perror("poll")] and returns.
 980 * Warning! May take (much) longer than timeout_ms to return!
 981 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
 982int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
 983
 984char *safe_gethostname(void) FAST_FUNC;
 985
 986/* Convert each alpha char in str to lower-case */
 987char* str_tolower(char *str) FAST_FUNC;
 988
 989char *utoa(unsigned n) FAST_FUNC;
 990char *itoa(int n) FAST_FUNC;
 991/* Returns a pointer past the formatted number, does NOT null-terminate */
 992char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
 993char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
 994/* Intelligent formatters of bignums */
 995char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
 996char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
 997/* If block_size == 0, display size without fractional part,
 998 * else display (size * block_size) with one decimal digit.
 999 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
1000 * else divide by display_unit and do not use suffix. */
1001#define HUMAN_READABLE_MAX_WIDTH      7  /* "1024.0G" */
1002#define HUMAN_READABLE_MAX_WIDTH_STR "7"
1003//TODO: provide pointer to buf (avoid statics)?
1004const char *make_human_readable_str(unsigned long long size,
1005                unsigned long block_size, unsigned long display_unit) FAST_FUNC;
1006/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
1007char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
1008/* Reverse */
1009char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
1010
1011/* Generate a UUID */
1012void generate_uuid(uint8_t *buf) FAST_FUNC;
1013
1014/* Last element is marked by mult == 0 */
1015struct suffix_mult {
1016        char suffix[4];
1017        unsigned mult;
1018};
1019extern const struct suffix_mult bkm_suffixes[];
1020#define km_suffixes (bkm_suffixes + 1)
1021extern const struct suffix_mult cwbkMG_suffixes[];
1022#define kMG_suffixes (cwbkMG_suffixes + 3)
1023extern const struct suffix_mult kmg_i_suffixes[];
1024
1025#include "xatonum.h"
1026/* Specialized: */
1027
1028/* Using xatoi() instead of naive atoi() is not always convenient -
1029 * in many places people want *non-negative* values, but store them
1030 * in signed int. Therefore we need this one:
1031 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
1032 * It should really be named xatoi_nonnegative (since it allows 0),
1033 * but that would be too long.
1034 */
1035int xatoi_positive(const char *numstr) FAST_FUNC;
1036
1037/* Useful for reading port numbers */
1038uint16_t xatou16(const char *numstr) FAST_FUNC;
1039
1040#if ENABLE_FLOAT_DURATION
1041typedef double duration_t;
1042void sleep_for_duration(duration_t duration) FAST_FUNC;
1043#else
1044typedef unsigned duration_t;
1045#define sleep_for_duration(duration) sleep(duration)
1046#endif
1047duration_t parse_duration_str(char *str) FAST_FUNC;
1048
1049/* These parse entries in /etc/passwd and /etc/group.  This is desirable
1050 * for BusyBox since we want to avoid using the glibc NSS stuff, which
1051 * increases target size and is often not needed on embedded systems.  */
1052long xuname2uid(const char *name) FAST_FUNC;
1053long xgroup2gid(const char *name) FAST_FUNC;
1054/* wrapper: allows string to contain numeric uid or gid */
1055unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
1056struct bb_uidgid_t {
1057        uid_t uid;
1058        gid_t gid;
1059};
1060/* always sets uid and gid; returns 0 on failure */
1061int get_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
1062/* always sets uid and gid; exits on failure */
1063void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
1064/* chown-like handling of "user[:[group]" */
1065void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
1066struct passwd* xgetpwnam(const char *name) FAST_FUNC;
1067struct group* xgetgrnam(const char *name) FAST_FUNC;
1068struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
1069struct group* xgetgrgid(gid_t gid) FAST_FUNC;
1070char* xuid2uname(uid_t uid) FAST_FUNC;
1071char* xgid2group(gid_t gid) FAST_FUNC;
1072char* uid2uname(uid_t uid) FAST_FUNC;
1073char* gid2group(gid_t gid) FAST_FUNC;
1074char* uid2uname_utoa(uid_t uid) FAST_FUNC;
1075char* gid2group_utoa(gid_t gid) FAST_FUNC;
1076/* versions which cache results (useful for ps, ls etc) */
1077const char* get_cached_username(uid_t uid) FAST_FUNC;
1078const char* get_cached_groupname(gid_t gid) FAST_FUNC;
1079void clear_username_cache(void) FAST_FUNC;
1080/* internally usernames are saved in fixed-sized char[] buffers */
1081enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
1082#if ENABLE_FEATURE_CHECK_NAMES
1083void die_if_bad_username(const char* name) FAST_FUNC;
1084#else
1085#define die_if_bad_username(name) ((void)(name))
1086#endif
1087/*
1088 * Returns (-1) terminated malloced result of getgroups().
1089 * Reallocs group_array (useful for repeated calls).
1090 * ngroups is an initial size of array. It is rounded up to 32 for realloc.
1091 * ngroups is updated on return.
1092 * ngroups can be NULL: bb_getgroups(NULL, NULL) is valid usage.
1093 * Dies on errors (on Linux, only xrealloc can cause this, not internal getgroups call).
1094 */
1095gid_t *bb_getgroups(int *ngroups, gid_t *group_array) FAST_FUNC;
1096
1097#if ENABLE_FEATURE_UTMP
1098void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
1099void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
1100void FAST_FUNC update_utmp_DEAD_PROCESS(pid_t pid);
1101#else
1102# define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
1103# define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
1104# define update_utmp_DEAD_PROCESS(pid) ((void)0)
1105#endif
1106
1107
1108int file_is_executable(const char *name) FAST_FUNC;
1109char *find_executable(const char *filename, char **PATHp) FAST_FUNC;
1110int executable_exists(const char *filename) FAST_FUNC;
1111
1112/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
1113 * but it may exec busybox and call applet instead of searching PATH.
1114 */
1115#if ENABLE_FEATURE_PREFER_APPLETS
1116int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
1117#define BB_EXECLP(prog,cmd,...) \
1118        do { \
1119                if (find_applet_by_name(prog) >= 0) \
1120                        execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
1121                execlp(prog, cmd, __VA_ARGS__); \
1122        } while (0)
1123#else
1124#define BB_EXECVP(prog,cmd)     execvp(prog,cmd)
1125#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
1126#endif
1127void BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
1128void exec_prog_or_SHELL(char **argv) NORETURN FAST_FUNC;
1129
1130/* xvfork() can't be a _function_, return after vfork in child mangles stack
1131 * in the parent. It must be a macro. */
1132#define xvfork() \
1133({ \
1134        pid_t bb__xvfork_pid = vfork(); \
1135        if (bb__xvfork_pid < 0) \
1136                bb_perror_msg_and_die("vfork"); \
1137        bb__xvfork_pid; \
1138})
1139#if BB_MMU
1140pid_t xfork(void) FAST_FUNC;
1141#endif
1142void xvfork_parent_waits_and_exits(void) FAST_FUNC;
1143
1144/* NOMMU friendy fork+exec: */
1145pid_t spawn(char **argv) FAST_FUNC;
1146pid_t xspawn(char **argv) FAST_FUNC;
1147
1148pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
1149pid_t wait_any_nohang(int *wstat) FAST_FUNC;
1150/* wait4pid: unlike waitpid, waits ONLY for one process.
1151 * Returns sig + 0x180 if child is killed by signal.
1152 * It's safe to pass negative 'pids' from failed [v]fork -
1153 * wait4pid will return -1 (and will not clobber [v]fork's errno).
1154 * IOW: rc = wait4pid(spawn(argv));
1155 *      if (rc < 0) bb_perror_msg("%s", argv[0]);
1156 *      if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
1157 */
1158int wait4pid(pid_t pid) FAST_FUNC;
1159int wait_for_exitstatus(pid_t pid) FAST_FUNC;
1160/************************************************************************/
1161/* spawn_and_wait/run_nofork_applet/run_applet_no_and_exit need to work */
1162/* carefully together to reinit some global state while not disturbing  */
1163/* other. Be careful if you change them. Consult docs/nofork_noexec.txt */
1164/************************************************************************/
1165/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
1166int spawn_and_wait(char **argv) FAST_FUNC;
1167/* Does NOT check that applet is NOFORK, just blindly runs it */
1168int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
1169void run_noexec_applet_and_exit(int a, const char *name, char **argv) NORETURN FAST_FUNC;
1170#ifndef BUILD_INDIVIDUAL
1171int find_applet_by_name(const char *name) FAST_FUNC;
1172void run_applet_no_and_exit(int a, const char *name, char **argv) NORETURN FAST_FUNC;
1173#endif
1174#if defined(__linux__)
1175void set_task_comm(const char *comm) FAST_FUNC;
1176#else
1177# define set_task_comm(name) ((void)0)
1178#endif
1179
1180/* Helpers for daemonization.
1181 *
1182 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
1183 *
1184 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
1185 *      rexec's itself on NOMMU with argv passed as command line.
1186 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
1187 * from the start. (It will detect it and not reexec again second time).
1188 * You have to audit carefully that you don't do something twice as a result
1189 * (opening files/sockets, parsing config files etc...)!
1190 *
1191 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
1192 * (will do setsid()).
1193 *
1194 * fork_or_rexec(argv) = bare-bones fork on MMU,
1195 *      "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
1196 *      On MMU ignores argv.
1197 *
1198 * Helper for network daemons in foreground mode:
1199 *
1200 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
1201 * to /dev/null if they are not.
1202 */
1203enum {
1204        DAEMON_CHDIR_ROOT = 1,
1205        DAEMON_DEVNULL_STDIO = 2,
1206        DAEMON_CLOSE_EXTRA_FDS = 4,
1207        DAEMON_ONLY_SANITIZE = 8, /* internal use */
1208        DAEMON_DOUBLE_FORK = 16, /* double fork to avoid controlling tty */
1209};
1210#if BB_MMU
1211  enum { re_execed = 0 };
1212# define fork_or_rexec(argv)                xfork()
1213# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1214# define bb_daemonize(flags)                bb_daemonize_or_rexec(flags, bogus)
1215#else
1216  extern bool re_execed;
1217  /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1218   * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1219   */
1220  void re_exec(char **argv) NORETURN FAST_FUNC;
1221  pid_t fork_or_rexec(char **argv) FAST_FUNC;
1222  int  BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1223  int  BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1224  void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
1225# define fork()          BUG_fork_is_unavailable_on_nommu()
1226# define xfork()         BUG_fork_is_unavailable_on_nommu()
1227# define daemon(a,b)     BUG_daemon_is_unavailable_on_nommu()
1228# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
1229#endif
1230void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1231void bb_sanitize_stdio(void) FAST_FUNC;
1232#define bb_daemon_helper(arg) bb_daemonize_or_rexec((arg) | DAEMON_ONLY_SANITIZE, NULL)
1233/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
1234int sanitize_env_if_suid(void) FAST_FUNC;
1235
1236
1237/* For top, ps. Some argv[i] are replaced by malloced "-opt" strings */
1238void make_all_argv_opts(char **argv) FAST_FUNC;
1239char* single_argv(char **argv) FAST_FUNC;
1240extern const char *const bb_argv_dash[]; /* { "-", NULL } */
1241extern uint32_t option_mask32;
1242uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
1243# define No_argument "\0"
1244# define Required_argument "\001"
1245# define Optional_argument "\002"
1246#if ENABLE_LONG_OPTS
1247uint32_t getopt32long(char **argv, const char *optstring, const char *longopts, ...) FAST_FUNC;
1248#else
1249#define getopt32long(argv,optstring,longopts,...) \
1250        getopt32(argv,optstring,##__VA_ARGS__)
1251#endif
1252/* BSD-derived getopt() functions require that optind be set to 1 in
1253 * order to reset getopt() state.  This used to be generally accepted
1254 * way of resetting getopt().  However, glibc's getopt()
1255 * has additional getopt() state beyond optind (specifically, glibc
1256 * extensions such as '+' and '-' at the start of the string), and requires
1257 * that optind be set to zero to reset its state.  BSD-derived versions
1258 * of getopt() misbehaved if optind is set to 0 in order to reset getopt(),
1259 * and glibc's getopt() used to coredump if optind is set 1 in order
1260 * to reset getopt().
1261 * Then BSD introduced additional variable "optreset" which should be
1262 * set to 1 in order to reset getopt().  Sigh.  Standards, anyone?
1263 *
1264 * By ~2008, OpenBSD 3.4 was changed to survive glibc-like optind = 0
1265 * (to interpret it as if optreset was set).
1266 */
1267#if 1 /*def __GLIBC__*/
1268#define GETOPT_RESET() (optind = 0)
1269#else /* BSD style */
1270#define GETOPT_RESET() (optind = 1)
1271#endif
1272
1273
1274/* Having next pointer as a first member allows easy creation
1275 * of "llist-compatible" structs, and using llist_FOO functions
1276 * on them.
1277 */
1278typedef struct llist_t {
1279        struct llist_t *link;
1280        char *data;
1281} llist_t;
1282void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1283void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1284void *llist_pop(llist_t **elm) FAST_FUNC;
1285void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1286void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1287llist_t *llist_rev(llist_t *list) FAST_FUNC;
1288llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
1289/* BTW, surprisingly, changing API to
1290 *   llist_t *llist_add_to(llist_t *old_head, void *data)
1291 * etc does not result in smaller code... */
1292
1293/* start_stop_daemon and udhcpc are special - they want
1294 * to create pidfiles regardless of FEATURE_PIDFILE */
1295#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
1296/* True only if we created pidfile which is *file*, not /dev/null etc */
1297extern smallint wrote_pidfile;
1298void write_pidfile(const char *path) FAST_FUNC;
1299#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
1300#else
1301enum { wrote_pidfile = 0 };
1302#define write_pidfile(path)  ((void)0)
1303#define remove_pidfile(path) ((void)0)
1304#endif
1305
1306enum {
1307        LOGMODE_NONE = 0,
1308        LOGMODE_STDIO = (1 << 0),
1309        LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
1310        LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1311};
1312extern const char *msg_eol;
1313extern smallint syslog_level;
1314extern smallint logmode;
1315extern uint8_t xfunc_error_retval;
1316extern void (*die_func)(void);
1317void xfunc_die(void) NORETURN FAST_FUNC;
1318void bb_show_usage(void) NORETURN FAST_FUNC;
1319void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1320void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1321void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1322void bb_simple_perror_msg(const char *s) FAST_FUNC;
1323void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1324void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
1325void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1326void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1327void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
1328void bb_perror_nomsg(void) FAST_FUNC;
1329void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
1330void bb_die_memory_exhausted(void) NORETURN FAST_FUNC;
1331void bb_logenv_override(void) FAST_FUNC;
1332
1333/* We need to export XXX_main from libbusybox
1334 * only if we build "individual" binaries
1335 */
1336#if ENABLE_FEATURE_INDIVIDUAL
1337#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1338#else
1339#define MAIN_EXTERNALLY_VISIBLE
1340#endif
1341
1342/* Embedded script support */
1343char *get_script_content(unsigned n) FAST_FUNC;
1344int scripted_main(int argc, char** argv);
1345
1346/* Applets which are useful from another applets */
1347int bb_cat(char** argv) FAST_FUNC;
1348int ash_main(int argc, char** argv)
1349#if ENABLE_ASH || ENABLE_SH_IS_ASH || ENABLE_BASH_IS_ASH
1350                MAIN_EXTERNALLY_VISIBLE
1351#endif
1352;
1353int hush_main(int argc, char** argv)
1354#if ENABLE_HUSH || ENABLE_SH_IS_HUSH || ENABLE_BASH_IS_HUSH
1355                MAIN_EXTERNALLY_VISIBLE
1356#endif
1357;
1358/* If shell needs them, they exist even if not enabled as applets */
1359int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1360int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1361int test_main(int argc, char **argv)
1362#if ENABLE_TEST || ENABLE_TEST1 || ENABLE_TEST2
1363                MAIN_EXTERNALLY_VISIBLE
1364#endif
1365;
1366int kill_main(int argc, char **argv)
1367#if ENABLE_KILL || ENABLE_KILLALL || ENABLE_KILLALL5
1368                MAIN_EXTERNALLY_VISIBLE
1369#endif
1370;
1371/* Similar, but used by chgrp, not shell */
1372int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
1373/* Used by ftpd */
1374int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1375/* Don't need IF_xxx() guard for these */
1376int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1377int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1378
1379#if ENABLE_ROUTE
1380void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
1381#endif
1382
1383struct number_state {
1384        unsigned width;
1385        unsigned start;
1386        unsigned inc;
1387        const char *sep;
1388        const char *empty_str;
1389        smallint all, nonempty;
1390};
1391int print_numbered_lines(struct number_state *ns, const char *filename) FAST_FUNC;
1392
1393
1394/* Networking */
1395/* This structure defines protocol families and their handlers. */
1396struct aftype {
1397        const char *name;
1398        const char *title;
1399        int af;
1400        int alen;
1401        char*       FAST_FUNC (*print)(unsigned char *);
1402        const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1403        int         FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1404        void        FAST_FUNC (*herror)(char *text);
1405        int         FAST_FUNC (*rprint)(int options);
1406        int         FAST_FUNC (*rinput)(int typ, int ext, char **argv);
1407        /* may modify src */
1408        int         FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
1409};
1410/* This structure defines hardware protocols and their handlers. */
1411struct hwtype {
1412        const char *name;
1413        const char *title;
1414        int type;
1415        int alen;
1416        char* FAST_FUNC (*print)(unsigned char *);
1417        int   FAST_FUNC (*input)(const char *, struct sockaddr *);
1418        int   FAST_FUNC (*activate)(int fd);
1419        int suppress_null_addr;
1420};
1421#define IFNAME_SHOW_DOWNED_TOO ((char*)(intptr_t)1)
1422int display_interfaces(char *ifname) FAST_FUNC;
1423int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1424#if ENABLE_FEATURE_HWIB
1425int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1426#else
1427#define in_ib(a, b) 1 /* fail */
1428#endif
1429const struct aftype *get_aftype(const char *name) FAST_FUNC;
1430const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1431const struct hwtype *get_hwntype(int type) FAST_FUNC;
1432
1433
1434extern int fstype_matches(const char *fstype, const char *comma_list) FAST_FUNC;
1435#ifdef HAVE_MNTENT_H
1436extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
1437#endif
1438extern void erase_mtab(const char * name) FAST_FUNC;
1439extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1440extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1441#if ENABLE_DESKTOP
1442extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1443#else
1444# define bb_warn_ignoring_args(arg) ((void)0)
1445#endif
1446
1447extern int get_linux_version_code(void) FAST_FUNC;
1448
1449extern char *query_loop(const char *device) FAST_FUNC;
1450extern int del_loop(const char *device) FAST_FUNC;
1451/*
1452 * If *devname is not NULL, use that name, otherwise try to find free one,
1453 * malloc and return it in *devname.
1454 * return value is the opened fd to the loop device, or < on error
1455 */
1456extern int set_loop(char **devname, const char *file, unsigned long long offset, unsigned flags) FAST_FUNC;
1457/* These constants match linux/loop.h (without BB_ prefix): */
1458#define BB_LO_FLAGS_READ_ONLY 1
1459#define BB_LO_FLAGS_AUTOCLEAR 4
1460
1461/* Returns malloced str */
1462char *bb_ask_noecho(int fd, int timeout, const char *prompt) FAST_FUNC;
1463/* Like bb_ask_noecho, but asks on stdin with no timeout.  */
1464char *bb_ask_noecho_stdin(const char *prompt) FAST_FUNC;
1465
1466int bb_ask_y_confirmation_FILE(FILE *fp) FAST_FUNC;
1467int bb_ask_y_confirmation(void) FAST_FUNC;
1468
1469/* Returns -1 if input is invalid. current_mode is a base for e.g. "u+rw" */
1470int bb_parse_mode(const char* s, unsigned cur_mode) FAST_FUNC;
1471
1472/*
1473 * Config file parser
1474 */
1475enum {
1476        PARSE_COLLAPSE  = 0x00010000, // treat consecutive delimiters as one
1477        PARSE_TRIM      = 0x00020000, // trim leading and trailing delimiters
1478// TODO: COLLAPSE and TRIM seem to always go in pair
1479        PARSE_GREEDY    = 0x00040000, // last token takes entire remainder of the line
1480        PARSE_MIN_DIE   = 0x00100000, // die if < min tokens found
1481        // keep a copy of current line
1482        PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
1483        PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
1484        PARSE_ALT_COMMENTS = 0x00800000, // delim[0] and delim[1] are two different allowed comment chars
1485        // (so far, delim[0] will only work as comment char for full-line comment)
1486        // (IOW: it works as if PARSE_EOL_COMMENTS is not set. sysctl applet is okay with this)
1487        PARSE_WS_COMMENTS  = 0x01000000, // comments are recognized even if there is whitespace before
1488        // ("line start><space><tab><space>#comment" is also comment, not only "line start>#comment")
1489        // NORMAL is:
1490        // * remove leading and trailing delimiters and collapse
1491        //   multiple delimiters into one
1492        // * warn and continue if less than mintokens delimiters found
1493        // * grab everything into last token
1494        // * comments are recognized even if they aren't the first char
1495        PARSE_NORMAL    = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
1496};
1497typedef struct parser_t {
1498        FILE *fp;
1499        char *data;
1500        char *line, *nline;
1501        size_t line_alloc, nline_alloc;
1502        int lineno;
1503} parser_t;
1504parser_t* config_open(const char *filename) FAST_FUNC;
1505parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
1506/* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
1507int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1508#define config_read(parser, tokens, max, min, str, flags) \
1509        config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1510void config_close(parser_t *parser) FAST_FUNC;
1511
1512/* Concatenate path and filename to new allocated buffer.
1513 * Add "/" only as needed (no duplicate "//" are produced).
1514 * If path is NULL, it is assumed to be "/".
1515 * filename should not be NULL. */
1516char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1517/* Returns NULL on . and .. */
1518char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1519
1520
1521int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1522
1523int get_signum(const char *name) FAST_FUNC;
1524const char *get_signame(int number) FAST_FUNC;
1525void print_signames(void) FAST_FUNC;
1526
1527char *bb_simplify_path(const char *path) FAST_FUNC;
1528/* Returns ptr to NUL */
1529char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
1530
1531#ifndef LOGIN_FAIL_DELAY
1532#define LOGIN_FAIL_DELAY 3
1533#endif
1534extern void bb_do_delay(int seconds) FAST_FUNC;
1535extern void change_identity(const struct passwd *pw) FAST_FUNC;
1536extern void run_shell(const char *shell, int loginshell, const char **args) NORETURN FAST_FUNC;
1537
1538/* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1539 * Note that getpwuid result might need xstrdup'ing
1540 * if there is a possibility of intervening getpwxxx() calls.
1541 */
1542const char *get_shell_name(void) FAST_FUNC;
1543
1544#if ENABLE_FEATURE_SETPRIV_CAPABILITIES || ENABLE_RUN_INIT
1545unsigned cap_name_to_number(const char *cap) FAST_FUNC;
1546void printf_cap(const char *pfx, unsigned cap_no) FAST_FUNC;
1547void drop_capability(int cap_ordinal) FAST_FUNC;
1548/* Structures inside "struct caps" are Linux-specific and libcap-specific: */
1549#define DEFINE_STRUCT_CAPS \
1550struct caps { \
1551        struct __user_cap_header_struct header; \
1552        unsigned u32s; \
1553        struct __user_cap_data_struct data[2]; \
1554}
1555void getcaps(void *caps) FAST_FUNC;
1556#endif
1557
1558#if ENABLE_SELINUX
1559extern void renew_current_security_context(void) FAST_FUNC;
1560extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1561extern context_t set_security_context_component(security_context_t cur_context,
1562                                                char *user, char *role, char *type, char *range) FAST_FUNC;
1563extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1564extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1565#else
1566#define selinux_preserve_fcontext(fdesc) ((void)0)
1567#endif
1568extern void selinux_or_die(void) FAST_FUNC;
1569
1570
1571/* setup_environment:
1572 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
1573 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1574 *   TERM=(old value)
1575 *   USER=pw->pw_name, LOGNAME=pw->pw_name
1576 *   PATH=bb_default_[root_]path
1577 *   HOME=pw->pw_dir
1578 *   SHELL=shell
1579 * else if change_env = 1:
1580 *   if not root (if pw->pw_uid != 0):
1581 *     USER=pw->pw_name, LOGNAME=pw->pw_name
1582 *   HOME=pw->pw_dir
1583 *   SHELL=shell
1584 * else does nothing
1585 *
1586 * NB: CHANGEENV and CLEARENV use setenv() - this leaks memory!
1587 * If setup_environment() is used is vforked child, this leaks memory _in parent too_!
1588 */
1589#define SETUP_ENV_CHANGEENV (1 << 0)
1590#define SETUP_ENV_CLEARENV  (1 << 1)
1591#define SETUP_ENV_TO_TMP    (1 << 2)
1592#define SETUP_ENV_NO_CHDIR  (1 << 4)
1593void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1594void nuke_str(char *str) FAST_FUNC;
1595#if ENABLE_FEATURE_SECURETTY && !ENABLE_PAM
1596int is_tty_secure(const char *short_tty) FAST_FUNC;
1597#else
1598static ALWAYS_INLINE int is_tty_secure(const char *short_tty UNUSED_PARAM) { return 1; }
1599#endif
1600#define CHECKPASS_PW_HAS_EMPTY_PASSWORD 2
1601int check_password(const struct passwd *pw, const char *plaintext) FAST_FUNC;
1602int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1603int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
1604/* Returns a malloced string */
1605#if !ENABLE_USE_BB_CRYPT
1606#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1607#endif
1608extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1609extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1610/*
1611 * rnd is additional random input. New one is returned.
1612 * Useful if you call crypt_make_salt many times in a row:
1613 * rnd = crypt_make_salt(buf1, 4, 0);
1614 * rnd = crypt_make_salt(buf2, 4, rnd);
1615 * rnd = crypt_make_salt(buf3, 4, rnd);
1616 * (otherwise we risk having same salt generated)
1617 */
1618extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1619/* "$N$" + sha_salt_16_bytes + NUL */
1620#define MAX_PW_SALT_LEN (3 + 16 + 1)
1621extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1622
1623
1624/* Returns number of lines changed, or -1 on error */
1625#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1626#define update_passwd(filename, username, data, member) \
1627        update_passwd(filename, username, data)
1628#endif
1629extern int update_passwd(const char *filename,
1630                const char *username,
1631                const char *data,
1632                const char *member) FAST_FUNC;
1633
1634int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1635int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1636int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1637int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1638const char *nth_string(const char *strings, int n) FAST_FUNC;
1639
1640extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1641extern void print_login_prompt(void) FAST_FUNC;
1642
1643char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
1644/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1645int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1646int get_terminal_width(int fd) FAST_FUNC;
1647
1648int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1649#define TERMIOS_CLEAR_ISIG      (1 << 0)
1650#define TERMIOS_RAW_CRNL_INPUT  (1 << 1)
1651#define TERMIOS_RAW_CRNL_OUTPUT (1 << 2)
1652#define TERMIOS_RAW_CRNL        (TERMIOS_RAW_CRNL_INPUT|TERMIOS_RAW_CRNL_OUTPUT)
1653#define TERMIOS_RAW_INPUT       (1 << 3)
1654int get_termios_and_make_raw(int fd, struct termios *newterm, struct termios *oldterm, int flags) FAST_FUNC;
1655int set_termios_to_raw(int fd, struct termios *oldterm, int flags) FAST_FUNC;
1656
1657/* NB: "unsigned request" is crucial! "int request" will break some arches! */
1658int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1659int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1660#if ENABLE_IOCTL_HEX2STR_ERROR
1661int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1662int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1663#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1664#define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp,#request)
1665#else
1666int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1667int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1668#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1669#define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp)
1670#endif
1671
1672char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1673void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1674void reset_ino_dev_hashtable(void) FAST_FUNC;
1675#ifdef __GLIBC__
1676/* At least glibc has horrendously large inline for this, so wrap it */
1677unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
1678#undef makedev
1679#define makedev(a,b) bb_makedev(a,b)
1680#endif
1681
1682
1683/* "Keycodes" that report an escape sequence.
1684 * We use something which fits into signed char,
1685 * yet doesn't represent any valid Unicode character.
1686 * Also, -1 is reserved for error indication and we don't use it. */
1687enum {
1688        KEYCODE_UP        =  -2,
1689        KEYCODE_DOWN      =  -3,
1690        KEYCODE_RIGHT     =  -4,
1691        KEYCODE_LEFT      =  -5,
1692        KEYCODE_HOME      =  -6,
1693        KEYCODE_END       =  -7,
1694        KEYCODE_INSERT    =  -8,
1695        KEYCODE_DELETE    =  -9,
1696        KEYCODE_PAGEUP    = -10,
1697        KEYCODE_PAGEDOWN  = -11,
1698        KEYCODE_BACKSPACE = -12, /* Used only if Alt/Ctrl/Shifted */
1699        KEYCODE_D         = -13, /* Used only if Alted */
1700#if 0
1701        KEYCODE_FUN1      = ,
1702        KEYCODE_FUN2      = ,
1703        KEYCODE_FUN3      = ,
1704        KEYCODE_FUN4      = ,
1705        KEYCODE_FUN5      = ,
1706        KEYCODE_FUN6      = ,
1707        KEYCODE_FUN7      = ,
1708        KEYCODE_FUN8      = ,
1709        KEYCODE_FUN9      = ,
1710        KEYCODE_FUN10     = ,
1711        KEYCODE_FUN11     = ,
1712        KEYCODE_FUN12     = ,
1713#endif
1714        /* ^^^^^ Be sure that last defined value is small enough.
1715         * Current read_key() code allows going up to -32 (0xfff..fffe0).
1716         * This gives three upper bits in LSB to play with:
1717         * KEYCODE_foo values are 0xfff..fffXX, lowest XX bits are: scavvvvv,
1718         * s=0 if SHIFT, c=0 if CTRL, a=0 if ALT,
1719         * vvvvv bits are the same for same key regardless of "shift bits".
1720         */
1721        //KEYCODE_SHIFT_...   = KEYCODE_...   & ~0x80,
1722        KEYCODE_CTRL_RIGHT    = KEYCODE_RIGHT & ~0x40,
1723        KEYCODE_CTRL_LEFT     = KEYCODE_LEFT  & ~0x40,
1724        KEYCODE_ALT_RIGHT     = KEYCODE_RIGHT & ~0x20,
1725        KEYCODE_ALT_LEFT      = KEYCODE_LEFT  & ~0x20,
1726        KEYCODE_ALT_BACKSPACE = KEYCODE_BACKSPACE & ~0x20,
1727        KEYCODE_ALT_D         = KEYCODE_D     & ~0x20,
1728
1729        KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
1730        /* How long is the longest ESC sequence we know?
1731         * We want it big enough to be able to contain
1732         * cursor position sequence "ESC [ 9999 ; 9999 R"
1733         */
1734        KEYCODE_BUFFER_SIZE = 16
1735};
1736/* Note: fd may be in blocking or non-blocking mode, both make sense.
1737 * For one, less uses non-blocking mode.
1738 * Only the first read syscall inside read_key may block indefinitely
1739 * (unless fd is in non-blocking mode),
1740 * subsequent reads will time out after a few milliseconds.
1741 * Return of -1 means EOF or error (errno == 0 on EOF).
1742 * buffer[0] is used as a counter of buffered chars and must be 0
1743 * on first call.
1744 * timeout:
1745 * -2: do not poll(-1) for input - read() it, return on EAGAIN at once
1746 * -1: poll(-1) (i.e. block even on NONBLOCKed fd)
1747 * >=0: poll() for TIMEOUT milliseconds, return -1/EAGAIN on timeout
1748 */
1749int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
1750void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
1751
1752
1753#if ENABLE_FEATURE_EDITING
1754/* It's NOT just ENABLEd or disabled. It's a number: */
1755# if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
1756#  define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1757unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
1758# else
1759#  define MAX_HISTORY 0
1760# endif
1761typedef struct line_input_t {
1762        int flags;
1763        int timeout;
1764        const char *path_lookup;
1765# if MAX_HISTORY
1766        int cnt_history;
1767        int cur_history;
1768        int max_history; /* must never be <= 0 */
1769#  if ENABLE_FEATURE_EDITING_SAVEHISTORY
1770        /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1771         * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1772         * in on-disk history"
1773         * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1774         * also in on-disk history (and thus need to be skipped on save)"
1775         */
1776        unsigned cnt_history_in_file;
1777        const char *hist_file;
1778#  endif
1779        char *history[MAX_HISTORY + 1];
1780# endif
1781} line_input_t;
1782enum {
1783        DO_HISTORY       = 1 * (MAX_HISTORY > 0),
1784        TAB_COMPLETION   = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1785        USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1786        VI_MODE          = 8 * ENABLE_FEATURE_EDITING_VI,
1787        WITH_PATH_LOOKUP = 0x10,
1788        FOR_SHELL        = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1789};
1790line_input_t *new_line_input_t(int flags) FAST_FUNC;
1791void free_line_input_t(line_input_t *n) FAST_FUNC;
1792/*
1793 * maxsize must be >= 2.
1794 * Returns:
1795 * -1 on read errors or EOF, or on bare Ctrl-D,
1796 * 0  on ctrl-C (the line entered is still returned in 'command'),
1797 * >0 length of input string, including terminating '\n'
1798 */
1799int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize) FAST_FUNC;
1800void show_history(const line_input_t *st) FAST_FUNC;
1801# if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1802void save_history(line_input_t *st);
1803# endif
1804#else
1805#define MAX_HISTORY 0
1806int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1807#define read_line_input(state, prompt, command, maxsize) \
1808        read_line_input(prompt, command, maxsize)
1809#endif
1810
1811
1812#ifndef COMM_LEN
1813# ifdef TASK_COMM_LEN
1814enum { COMM_LEN = TASK_COMM_LEN };
1815# else
1816/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1817enum { COMM_LEN = 16 };
1818# endif
1819#endif
1820
1821struct smaprec {
1822        unsigned long mapped_rw;
1823        unsigned long mapped_ro;
1824        unsigned long shared_clean;
1825        unsigned long shared_dirty;
1826        unsigned long private_clean;
1827        unsigned long private_dirty;
1828        unsigned long stack;
1829        unsigned long smap_pss, smap_swap;
1830        unsigned long smap_size;
1831        unsigned long smap_start;
1832        char smap_mode[5];
1833        char *smap_name;
1834};
1835
1836#if !ENABLE_PMAP
1837#define procps_read_smaps(pid, total, cb, data) \
1838        procps_read_smaps(pid, total)
1839#endif
1840int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1841                void (*cb)(struct smaprec *, void *), void *data);
1842
1843typedef struct procps_status_t {
1844        DIR *dir;
1845        IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
1846        uint8_t shift_pages_to_bytes;
1847        uint8_t shift_pages_to_kb;
1848/* Fields are set to 0/NULL if failed to determine (or not requested) */
1849        uint16_t argv_len;
1850        char *argv0;
1851        char *exe;
1852        IF_SELINUX(char *context;)
1853        IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
1854        /* Everything below must contain no ptrs to malloc'ed data:
1855         * it is memset(0) for each process in procps_scan() */
1856        unsigned long vsz, rss; /* we round it to kbytes */
1857        unsigned long stime, utime;
1858        unsigned long start_time;
1859        unsigned pid;
1860        unsigned ppid;
1861        unsigned pgid;
1862        unsigned sid;
1863        unsigned uid;
1864        unsigned gid;
1865#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1866        unsigned ruid;
1867        unsigned rgid;
1868        int niceness;
1869#endif
1870        unsigned tty_major,tty_minor;
1871#if ENABLE_FEATURE_TOPMEM
1872        struct smaprec smaps;
1873#endif
1874        char state[4];
1875        /* basename of executable in exec(2), read from /proc/N/stat
1876         * (if executable is symlink or script, it is NOT replaced
1877         * by link target or interpreter name) */
1878        char comm[COMM_LEN];
1879        /* user/group? - use passwd/group parsing functions */
1880#if ENABLE_FEATURE_TOP_SMP_PROCESS
1881        int last_seen_on_cpu;
1882#endif
1883} procps_status_t;
1884/* flag bits for procps_scan(xx, flags) calls */
1885enum {
1886        PSSCAN_PID      = 1 << 0,
1887        PSSCAN_PPID     = 1 << 1,
1888        PSSCAN_PGID     = 1 << 2,
1889        PSSCAN_SID      = 1 << 3,
1890        PSSCAN_UIDGID   = 1 << 4,
1891        PSSCAN_COMM     = 1 << 5,
1892        /* PSSCAN_CMD      = 1 << 6, - use read_cmdline instead */
1893        PSSCAN_ARGV0    = 1 << 7,
1894        PSSCAN_EXE      = 1 << 8,
1895        PSSCAN_STATE    = 1 << 9,
1896        PSSCAN_VSZ      = 1 << 10,
1897        PSSCAN_RSS      = 1 << 11,
1898        PSSCAN_STIME    = 1 << 12,
1899        PSSCAN_UTIME    = 1 << 13,
1900        PSSCAN_TTY      = 1 << 14,
1901        PSSCAN_SMAPS    = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1902        /* NB: used by find_pid_by_name(). Any applet using it
1903         * needs to be mentioned here. */
1904        PSSCAN_ARGVN    = (1 << 16) * (ENABLE_KILLALL
1905                                || ENABLE_PGREP || ENABLE_PKILL
1906                                || ENABLE_PIDOF
1907                                || ENABLE_SESTATUS
1908                                ),
1909        PSSCAN_CONTEXT  = (1 << 17) * ENABLE_SELINUX,
1910        PSSCAN_START_TIME = 1 << 18,
1911        PSSCAN_CPU      = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1912        PSSCAN_NICE     = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1913        PSSCAN_RUIDGID  = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1914        PSSCAN_TASKS    = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
1915};
1916//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1917void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1918procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
1919/* Format cmdline (up to col chars) into char buf[size] */
1920/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1921void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
1922pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1923pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
1924int starts_with_cpu(const char *str) FAST_FUNC;
1925unsigned get_cpu_count(void) FAST_FUNC;
1926
1927
1928/* Use strict=1 if you process input from untrusted source:
1929 * it will return NULL on invalid %xx (bad hex chars)
1930 * and str + 1 if decoded char is / or NUL.
1931 * In non-strict mode, it always succeeds (returns str),
1932 * and also it additionally decoded '+' to space.
1933 */
1934char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
1935
1936
1937extern const char bb_uuenc_tbl_base64[] ALIGN1;
1938extern const char bb_uuenc_tbl_std[] ALIGN1;
1939void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
1940enum {
1941        BASE64_FLAG_UU_STOP = 0x100,
1942        /* Sign-extends to a value which never matches fgetc result: */
1943        BASE64_FLAG_NO_STOP_CHAR = 0x80,
1944};
1945const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
1946void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
1947
1948typedef struct md5_ctx_t {
1949        uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1950        void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
1951        uint64_t total64;    /* must be directly before hash[] */
1952        uint32_t hash[8];    /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1953} md5_ctx_t;
1954typedef struct md5_ctx_t sha1_ctx_t;
1955typedef struct md5_ctx_t sha256_ctx_t;
1956typedef struct sha512_ctx_t {
1957        uint64_t total64[2];  /* must be directly before hash[] */
1958        uint64_t hash[8];
1959        uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
1960} sha512_ctx_t;
1961typedef struct sha3_ctx_t {
1962        uint64_t state[25];
1963        unsigned bytes_queued;
1964        unsigned input_block_bytes;
1965} sha3_ctx_t;
1966void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1967void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1968unsigned md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1969void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1970#define sha1_hash md5_hash
1971unsigned sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1972void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1973#define sha256_hash md5_hash
1974#define sha256_end  sha1_end
1975void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1976void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1977unsigned sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
1978void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
1979void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1980unsigned sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
1981/* TLS benefits from knowing that sha1 and sha256 share these. Give them "agnostic" names too */
1982typedef struct md5_ctx_t md5sha_ctx_t;
1983#define md5sha_hash md5_hash
1984#define sha_end sha1_end
1985
1986extern uint32_t *global_crc32_table;
1987uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1988uint32_t *crc32_new_table_le(void) FAST_FUNC;
1989uint32_t *global_crc32_new_table_le(void) FAST_FUNC;
1990uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1991uint32_t crc32_block_endian0(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1992
1993typedef struct masks_labels_t {
1994        const char *labels;
1995        const int masks[];
1996} masks_labels_t;
1997int print_flags_separated(const int *masks, const char *labels,
1998                int flags, const char *separator) FAST_FUNC;
1999int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
2000
2001typedef struct bb_progress_t {
2002        unsigned last_size;
2003        unsigned last_update_sec;
2004        unsigned last_change_sec;
2005        unsigned start_sec;
2006        /*unsigned last_eta;*/
2007        const char *curfile;
2008} bb_progress_t;
2009
2010#define is_bb_progress_inited(p) ((p)->curfile != NULL)
2011#define bb_progress_free(p) do { \
2012        if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
2013        (p)->curfile = NULL; \
2014} while (0)
2015void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
2016int bb_progress_update(bb_progress_t *p,
2017                        uoff_t beg_range,
2018                        uoff_t transferred,
2019                        uoff_t totalsize) FAST_FUNC;
2020
2021unsigned ubi_devnum_from_devname(const char *str) FAST_FUNC;
2022int ubi_get_volid_by_name(unsigned ubi_devnum, const char *vol_name) FAST_FUNC;
2023
2024
2025extern const char *applet_name;
2026
2027/* Some older linkers don't perform string merging, we used to have common strings
2028 * as global arrays to do it by hand. But:
2029 * (1) newer linkers do it themselves,
2030 * (2) however, they DONT merge string constants with global arrays,
2031 * even if the value is the same (!). Thus global arrays actually
2032 * increased size a bit: for example, "/etc/passwd" string from libc
2033 * wasn't merged with bb_path_passwd_file[] array!
2034 * Therefore now we use #defines.
2035 */
2036/* "BusyBox vN.N.N (timestamp or extra_version)" */
2037extern const char bb_banner[] ALIGN1;
2038extern const char bb_msg_memory_exhausted[] ALIGN1;
2039extern const char bb_msg_invalid_date[] ALIGN1;
2040#define bb_msg_read_error "read error"
2041#define bb_msg_write_error "write error"
2042extern const char bb_msg_unknown[] ALIGN1;
2043extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
2044extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
2045extern const char bb_msg_you_must_be_root[] ALIGN1;
2046extern const char bb_msg_requires_arg[] ALIGN1;
2047extern const char bb_msg_invalid_arg_to[] ALIGN1;
2048extern const char bb_msg_standard_input[] ALIGN1;
2049extern const char bb_msg_standard_output[] ALIGN1;
2050
2051/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
2052extern const char bb_hexdigits_upcase[] ALIGN1;
2053
2054extern const char bb_path_wtmp_file[] ALIGN1;
2055
2056/* Busybox mount uses either /proc/mounts or /etc/mtab to
2057 * get the list of currently mounted filesystems */
2058#define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
2059
2060#define bb_path_passwd_file  _PATH_PASSWD
2061#define bb_path_group_file   _PATH_GROUP
2062#define bb_path_shadow_file  _PATH_SHADOW
2063#define bb_path_gshadow_file _PATH_GSHADOW
2064
2065#define bb_path_motd_file "/etc/motd"
2066
2067#define bb_dev_null "/dev/null"
2068extern const char bb_busybox_exec_path[] ALIGN1;
2069/* allow default system PATH to be extended via CFLAGS */
2070#ifndef BB_ADDITIONAL_PATH
2071#define BB_ADDITIONAL_PATH ""
2072#endif
2073#define BB_PATH_ROOT_PATH "PATH=/sbin:/usr/sbin:/bin:/usr/bin" BB_ADDITIONAL_PATH
2074extern const char bb_PATH_root_path[] ALIGN1; /* BB_PATH_ROOT_PATH */
2075#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
2076/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
2077 * but I want to save a few bytes here:
2078 */
2079#define bb_default_path      (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
2080
2081extern const int const_int_0;
2082//extern const int const_int_1;
2083
2084/* This struct is deliberately not defined. */
2085/* See docs/keep_data_small.txt */
2086struct globals;
2087/* '*const' ptr makes gcc optimize code much better.
2088 * Magic prevents ptr_to_globals from going into rodata.
2089 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
2090extern struct globals *const ptr_to_globals;
2091/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
2092#define barrier() __asm__ __volatile__("":::"memory")
2093#define SET_PTR_TO_GLOBALS(x) do { \
2094        (*(struct globals**)&ptr_to_globals) = (void*)(x); \
2095        barrier(); \
2096} while (0)
2097#define FREE_PTR_TO_GLOBALS() do { \
2098        if (ENABLE_FEATURE_CLEAN_UP) { \
2099                free(ptr_to_globals); \
2100        } \
2101} while (0)
2102
2103/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
2104 * use bb_default_login_shell and following defines.
2105 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
2106 * don't forget to change increment constant. */
2107#define LIBBB_DEFAULT_LOGIN_SHELL  "-/bin/sh"
2108extern const char bb_default_login_shell[] ALIGN1;
2109/* "/bin/sh" */
2110#define DEFAULT_SHELL              (bb_default_login_shell+1)
2111/* "sh" */
2112#define DEFAULT_SHELL_SHORT_NAME   (bb_default_login_shell+6)
2113
2114/* The following devices are the same on all systems.  */
2115#define CURRENT_TTY "/dev/tty"
2116#define DEV_CONSOLE "/dev/console"
2117
2118#if defined(__FreeBSD_kernel__)
2119# define CURRENT_VC CURRENT_TTY
2120# define VC_1 "/dev/ttyv0"
2121# define VC_2 "/dev/ttyv1"
2122# define VC_3 "/dev/ttyv2"
2123# define VC_4 "/dev/ttyv3"
2124# define VC_5 "/dev/ttyv4"
2125# define VC_FORMAT "/dev/ttyv%d"
2126#elif defined(__GNU__)
2127# define CURRENT_VC CURRENT_TTY
2128# define VC_1 "/dev/tty1"
2129# define VC_2 "/dev/tty2"
2130# define VC_3 "/dev/tty3"
2131# define VC_4 "/dev/tty4"
2132# define VC_5 "/dev/tty5"
2133# define VC_FORMAT "/dev/tty%d"
2134#elif ENABLE_FEATURE_DEVFS
2135/*Linux, obsolete devfs names */
2136# define CURRENT_VC "/dev/vc/0"
2137# define VC_1 "/dev/vc/1"
2138# define VC_2 "/dev/vc/2"
2139# define VC_3 "/dev/vc/3"
2140# define VC_4 "/dev/vc/4"
2141# define VC_5 "/dev/vc/5"
2142# define VC_FORMAT "/dev/vc/%d"
2143# define LOOP_FORMAT "/dev/loop/%u"
2144# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
2145# define LOOP_NAME "/dev/loop/"
2146# define FB_0 "/dev/fb/0"
2147#else
2148/*Linux, normal names */
2149# define CURRENT_VC "/dev/tty0"
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# define LOOP_FORMAT "/dev/loop%u"
2157# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
2158# define LOOP_NAME "/dev/loop"
2159# define FB_0 "/dev/fb0"
2160#endif
2161
2162// storage helpers for mk*fs utilities
2163char BUG_wrong_field_size(void);
2164#define STORE_LE(field, value) \
2165do { \
2166        if (sizeof(field) == 4) \
2167                field = SWAP_LE32((uint32_t)(value)); \
2168        else if (sizeof(field) == 2) \
2169                field = SWAP_LE16((uint16_t)(value)); \
2170        else if (sizeof(field) == 1) \
2171                field = (uint8_t)(value); \
2172        else \
2173                BUG_wrong_field_size(); \
2174} while (0)
2175
2176#define FETCH_LE32(field) \
2177        (sizeof(field) == 4 ? SWAP_LE32(field) : BUG_wrong_field_size())
2178
2179
2180#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
2181#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
2182
2183
2184/* We redefine ctype macros. Unicode-correct handling of char types
2185 * can't be done with such byte-oriented operations anyway,
2186 * we don't lose anything.
2187 */
2188#undef isalnum
2189#undef isalpha
2190#undef isascii
2191#undef isblank
2192#undef iscntrl
2193#undef isdigit
2194#undef isgraph
2195#undef islower
2196#undef isprint
2197#undef ispunct
2198#undef isspace
2199#undef isupper
2200#undef isxdigit
2201#undef toupper
2202#undef tolower
2203
2204/* We save ~500 bytes on isdigit alone.
2205 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
2206
2207/* These work the same for ASCII and Unicode,
2208 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
2209#define isascii(a) ((unsigned char)(a) <= 0x7f)
2210#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
2211#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
2212#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
2213#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
2214#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
2215#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
2216/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
2217 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
2218 */
2219#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
2220// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
2221#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
2222// Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
2223#define isalnum(a) bb_ascii_isalnum(a)
2224static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
2225{
2226        unsigned char b = a - '0';
2227        if (b <= 9)
2228                return (b <= 9);
2229        b = (a|0x20) - 'a';
2230        return b <= 'z' - 'a';
2231}
2232#define isxdigit(a) bb_ascii_isxdigit(a)
2233static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
2234{
2235        unsigned char b = a - '0';
2236        if (b <= 9)
2237                return (b <= 9);
2238        b = (a|0x20) - 'a';
2239        return b <= 'f' - 'a';
2240}
2241#define toupper(a) bb_ascii_toupper(a)
2242static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
2243{
2244        unsigned char b = a - 'a';
2245        if (b <= ('z' - 'a'))
2246                a -= 'a' - 'A';
2247        return a;
2248}
2249#define tolower(a) bb_ascii_tolower(a)
2250static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
2251{
2252        unsigned char b = a - 'A';
2253        if (b <= ('Z' - 'A'))
2254                a += 'a' - 'A';
2255        return a;
2256}
2257
2258/* In ASCII and Unicode, these are likely to be very different.
2259 * Let's prevent ambiguous usage from the start */
2260#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
2261#define isprint(a) isprint_is_ambiguous_dont_use(a)
2262/* NB: must not treat EOF as isgraph or isprint */
2263#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
2264#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
2265
2266
2267/* Simple unit-testing framework */
2268
2269typedef void (*bbunit_testfunc)(void);
2270
2271struct bbunit_listelem {
2272        const char* name;
2273        bbunit_testfunc testfunc;
2274};
2275
2276void bbunit_registertest(struct bbunit_listelem* test);
2277void bbunit_settestfailed(void);
2278
2279#define BBUNIT_DEFINE_TEST(NAME) \
2280        static void bbunit_##NAME##_test(void); \
2281        static struct bbunit_listelem bbunit_##NAME##_elem = { \
2282                .name = #NAME, \
2283                .testfunc = bbunit_##NAME##_test, \
2284        }; \
2285        static void INIT_FUNC bbunit_##NAME##_register(void) \
2286        { \
2287                bbunit_registertest(&bbunit_##NAME##_elem); \
2288        } \
2289        static void bbunit_##NAME##_test(void)
2290
2291/*
2292 * Both 'goto bbunit_end' and 'break' are here only to get rid
2293 * of compiler warnings.
2294 */
2295#define BBUNIT_ENDTEST \
2296        do { \
2297                goto bbunit_end; \
2298        bbunit_end: \
2299                break; \
2300        } while (0)
2301
2302#define BBUNIT_PRINTASSERTFAIL \
2303        do { \
2304                bb_error_msg( \
2305                        "[ERROR] Assertion failed in file %s, line %d", \
2306                        __FILE__, __LINE__); \
2307        } while (0)
2308
2309#define BBUNIT_ASSERTION_FAILED \
2310        do { \
2311                bbunit_settestfailed(); \
2312                goto bbunit_end; \
2313        } while (0)
2314
2315/*
2316 * Assertions.
2317 * For now we only offer assertions which cause tests to fail
2318 * immediately. In the future 'expects' might be added too -
2319 * similar to those offered by the gtest framework.
2320 */
2321#define BBUNIT_ASSERT_EQ(EXPECTED, ACTUAL) \
2322        do { \
2323                if ((EXPECTED) != (ACTUAL)) { \
2324                        BBUNIT_PRINTASSERTFAIL; \
2325                        bb_error_msg("[ERROR] '%s' isn't equal to '%s'", \
2326                                                #EXPECTED, #ACTUAL); \
2327                        BBUNIT_ASSERTION_FAILED; \
2328                } \
2329        } while (0)
2330
2331#define BBUNIT_ASSERT_NOTEQ(EXPECTED, ACTUAL) \
2332        do { \
2333                if ((EXPECTED) == (ACTUAL)) { \
2334                        BBUNIT_PRINTASSERTFAIL; \
2335                        bb_error_msg("[ERROR] '%s' is equal to '%s'", \
2336                                                #EXPECTED, #ACTUAL); \
2337                        BBUNIT_ASSERTION_FAILED; \
2338                } \
2339        } while (0)
2340
2341#define BBUNIT_ASSERT_NOTNULL(PTR) \
2342        do { \
2343                if ((PTR) == NULL) { \
2344                        BBUNIT_PRINTASSERTFAIL; \
2345                        bb_error_msg("[ERROR] '%s' is NULL!", #PTR); \
2346                        BBUNIT_ASSERTION_FAILED; \
2347                } \
2348        } while (0)
2349
2350#define BBUNIT_ASSERT_NULL(PTR) \
2351        do { \
2352                if ((PTR) != NULL) { \
2353                        BBUNIT_PRINTASSERTFAIL; \
2354                        bb_error_msg("[ERROR] '%s' is not NULL!", #PTR); \
2355                        BBUNIT_ASSERTION_FAILED; \
2356                } \
2357        } while (0)
2358
2359#define BBUNIT_ASSERT_FALSE(STATEMENT) \
2360        do { \
2361                if ((STATEMENT)) { \
2362                        BBUNIT_PRINTASSERTFAIL; \
2363                        bb_error_msg("[ERROR] Statement '%s' evaluated to true!", \
2364                                                                #STATEMENT); \
2365                        BBUNIT_ASSERTION_FAILED; \
2366                } \
2367        } while (0)
2368
2369#define BBUNIT_ASSERT_TRUE(STATEMENT) \
2370        do { \
2371                if (!(STATEMENT)) { \
2372                        BBUNIT_PRINTASSERTFAIL; \
2373                        bb_error_msg("[ERROR] Statement '%s' evaluated to false!", \
2374                                        #STATEMENT); \
2375                        BBUNIT_ASSERTION_FAILED; \
2376                } \
2377        } while (0)
2378
2379#define BBUNIT_ASSERT_STREQ(STR1, STR2) \
2380        do { \
2381                if (strcmp(STR1, STR2) != 0) { \
2382                        BBUNIT_PRINTASSERTFAIL; \
2383                        bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2384                                        "are not the same", STR1, STR2); \
2385                        BBUNIT_ASSERTION_FAILED; \
2386                } \
2387        } while (0)
2388
2389#define BBUNIT_ASSERT_STRNOTEQ(STR1, STR2) \
2390        do { \
2391                if (strcmp(STR1, STR2) == 0) { \
2392                        BBUNIT_PRINTASSERTFAIL; \
2393                        bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2394                                        "are the same, but were " \
2395                                        "expected to differ", STR1, STR2); \
2396                        BBUNIT_ASSERTION_FAILED; \
2397                } \
2398        } while (0)
2399
2400
2401POP_SAVED_FUNCTION_VISIBILITY
2402
2403#endif
2404