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