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