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