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