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