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