include/libbb.h

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