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