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