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