include/libbb.h

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