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