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