include/libbb.h

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