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