include/libbb.h

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