include/libbb.h

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