include/libbb.h

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