include/libbb.h

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