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