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