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