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