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