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