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