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