git.maemo.org Git - busybox4maemo/blob - 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 <sys/poll.h>
  29 #include <sys/ioctl.h>
  30 #include <sys/mman.h>
  31 #include <sys/socket.h>
  32 #include <sys/stat.h>
  33 #include <sys/time.h>
  34 #include <sys/types.h>
  35 #include <sys/wait.h>
  36 #include <termios.h>
  37 #include <time.h>
  38 #include <unistd.h>
  39 #include <utime.h>
  40 /* Try to pull in PATH_MAX */
  41 #include <limits.h>
  42 #include <sys/param.h>
  43 #ifndef PATH_MAX
  44 #define PATH_MAX 256
  45 #endif
  46
  47 #ifdef HAVE_MNTENT_H
  48 #include <mntent.h>
  49 #endif
  50
  51 #ifdef HAVE_SYS_STATFS_H
  52 #include <sys/statfs.h>
  53 #endif
  54
  55 #if ENABLE_SELINUX
  56 #include <selinux/selinux.h>
  57 #include <selinux/context.h>
  58 #include <selinux/flask.h>
  59 #include <selinux/av_permissions.h>
  60 #endif
  61
  62 #if ENABLE_LOCALE_SUPPORT
  63 #include <locale.h>
  64 #else
  65 #define setlocale(x,y) ((void)0)
  66 #endif
  67
  68 #include "pwd_.h"
  69 #include "grp_.h"
  70 /* ifdef it out, because it may include <shadow.h> */
  71 /* and we may not even _have_ <shadow.h>! */
  72 #if ENABLE_FEATURE_SHADOWPASSWDS
  73 #include "shadow_.h"
  74 #endif
  75
  76 /* Some libc's don't declare it, help them */
  77 extern char **environ;
  78
  79 #if defined(__GLIBC__) && __GLIBC__ < 2
  80 int vdprintf(int d, const char *format, va_list ap);
  81 #endif
  82 /* klogctl is in libc's klog.h, but we cheat and not #include that */
  83 int klogctl(int type, char *b, int len);
  84 /* This is declared here rather than #including <libgen.h> in order to avoid
  85  * confusing the two versions of basename.  See the dirname/basename man page
  86  * for details. */
  87 char *dirname(char *path);
  88 /* Include our own copy of struct sysinfo to avoid binary compatibility
  89  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
  90 struct sysinfo {
  91         long uptime;                    /* Seconds since boot */
  92         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
  93         unsigned long totalram;         /* Total usable main memory size */
  94         unsigned long freeram;          /* Available memory size */
  95         unsigned long sharedram;        /* Amount of shared memory */
  96         unsigned long bufferram;        /* Memory used by buffers */
  97         unsigned long totalswap;        /* Total swap space size */
  98         unsigned long freeswap;         /* swap space still available */
  99         unsigned short procs;           /* Number of current processes */
 100         unsigned short pad;                     /* Padding needed for m68k */
 101         unsigned long totalhigh;        /* Total high memory size */
 102         unsigned long freehigh;         /* Available high memory size */
 103         unsigned int mem_unit;          /* Memory unit size in bytes */
 104         char _f[20 - 2*sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
 105 };
 106 int sysinfo(struct sysinfo* info);
 107
 108
 109 /* Tested to work correctly with all int types (IIRC :]) */
 110 #define MAXINT(T) (T)( \
 111         ((T)-1) > 0 \
 112         ? (T)-1 \
 113         : (T)~((T)1 << (sizeof(T)*8-1)) \
 114         )
 115
 116 #define MININT(T) (T)( \
 117         ((T)-1) > 0 \
 118         ? (T)0 \
 119         : ((T)1 << (sizeof(T)*8-1)) \
 120         )
 121
 122 /* Large file support */
 123 /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
 124  * (stat, lseek etc) mapped to "largefile" variants by libc.
 125  * Practically it means that open() automatically has O_LARGEFILE added
 126  * and all filesize/file_offset parameters and struct members are "large"
 127  * (in today's world - signed 64bit). For full support of large files,
 128  * we need a few helper #defines (below) and careful use of off_t
 129  * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
 130 #if ENABLE_LFS
 131 /* CONFIG_LFS is on */
 132 # if ULONG_MAX > 0xffffffff
 133 /* "long" is long enough on this system */
 134 #  define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
 135 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
 136 #  define BB_STRTOOFF bb_strtoul
 137 #  define STRTOOFF strtoul
 138 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
 139 #  define OFF_FMT "l"
 140 # else
 141 /* "long" is too short, need "long long" */
 142 #  define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
 143 #  define BB_STRTOOFF bb_strtoull
 144 #  define STRTOOFF strtoull
 145 #  define OFF_FMT "ll"
 146 # endif
 147 #else
 148 /* CONFIG_LFS is off */
 149 # if UINT_MAX == 0xffffffff
 150 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
 151  * gcc will throw warnings on printf("%d", off_t). Crap... */
 152 #  define XATOOFF(a) xatoi_u(a)
 153 #  define BB_STRTOOFF bb_strtou
 154 #  define STRTOOFF strtol
 155 #  define OFF_FMT "l"
 156 # else
 157 #  define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
 158 #  define BB_STRTOOFF bb_strtoul
 159 #  define STRTOOFF strtol
 160 #  define OFF_FMT "l"
 161 # endif
 162 #endif
 163 /* scary. better ideas? (but do *test* them first!) */
 164 #define OFF_T_MAX  ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
 165
 166 /* Some useful definitions */
 167 #undef FALSE
 168 #define FALSE   ((int) 0)
 169 #undef TRUE
 170 #define TRUE    ((int) 1)
 171 #undef SKIP
 172 #define SKIP    ((int) 2)
 173
 174 /* for mtab.c */
 175 #define MTAB_GETMOUNTPT '1'
 176 #define MTAB_GETDEVICE  '2'
 177
 178 #define BUF_SIZE        8192
 179 #define EXPAND_ALLOC    1024
 180
 181 /* Macros for min/max.  */
 182 #ifndef MIN
 183 #define MIN(a,b) (((a)<(b))?(a):(b))
 184 #endif
 185
 186 #ifndef MAX
 187 #define MAX(a,b) (((a)>(b))?(a):(b))
 188 #endif
 189
 190 /* buffer allocation schemes */
 191 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
 192 #define RESERVE_CONFIG_BUFFER(buffer,len)  char buffer[len]
 193 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
 194 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
 195 #else
 196 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
 197 #define RESERVE_CONFIG_BUFFER(buffer,len)  static          char buffer[len]
 198 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
 199 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
 200 #else
 201 #define RESERVE_CONFIG_BUFFER(buffer,len)  char *buffer = xmalloc(len)
 202 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
 203 #define RELEASE_CONFIG_BUFFER(buffer)      free(buffer)
 204 #endif
 205 #endif
 206
 207 #if defined(__GLIBC__)
 208 /* glibc uses __errno_location() to get a ptr to errno */
 209 /* We can just memorize it once - no multithreading in busybox :) */
 210 extern int *const bb_errno;
 211 #undef errno
 212 #define errno (*bb_errno)
 213 #endif
 214
 215 unsigned long long monotonic_us(void);
 216 unsigned monotonic_sec(void);
 217
 218 extern void chomp(char *s);
 219 extern void trim(char *s);
 220 extern char *skip_whitespace(const char *);
 221 extern char *skip_non_whitespace(const char *);
 222
 223 //TODO: supply a pointer to char[11] buffer (avoid statics)?
 224 extern const char *bb_mode_string(mode_t mode);
 225 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
 226 extern int remove_file(const char *path, int flags);
 227 extern int copy_file(const char *source, const char *dest, int flags);
 228 enum {
 229         ACTION_RECURSE        = (1 << 0),
 230         ACTION_FOLLOWLINKS    = (1 << 1),
 231         ACTION_FOLLOWLINKS_L0 = (1 << 2),
 232         ACTION_DEPTHFIRST     = (1 << 3),
 233         /*ACTION_REVERSE      = (1 << 4), - unused */
 234 };
 235 extern int recursive_action(const char *fileName, unsigned flags,
 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, unsigned depth);
 239 extern int device_open(const char *device, int mode);
 240 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
 241 extern int getpty(char *line);
 242 extern int get_console_fd(void);
 243 extern char *find_block_device(const char *path);
 244 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
 245 extern off_t bb_copyfd_eof(int fd1, int fd2);
 246 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
 247 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
 248 /* "short" copy can be detected by return value < size */
 249 /* this helper yells "short read!" if param is not -1 */
 250 extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
 251 extern char bb_process_escape_sequence(const char **ptr);
 252 /* xxxx_strip version can modify its parameter:
 253  * "/"        -> "/"
 254  * "abc"      -> "abc"
 255  * "abc/def"  -> "def"
 256  * "abc/def/" -> "def" !!
 257  */
 258 extern char *bb_get_last_path_component_strip(char *path);
 259 /* "abc/def/" -> "" and it never modifies 'path' */
 260 extern char *bb_get_last_path_component_nostrip(const char *path);
 261
 262 int ndelay_on(int fd);
 263 int ndelay_off(int fd);
 264 int close_on_exec_on(int fd);
 265 void xdup2(int, int);
 266 void xmove_fd(int, int);
 267
 268
 269 DIR *xopendir(const char *path);
 270 DIR *warn_opendir(const char *path);
 271
 272 /* UNUSED: char *xmalloc_realpath(const char *path); */
 273 char *xmalloc_readlink(const char *path);
 274 char *xmalloc_readlink_or_warn(const char *path);
 275 char *xrealloc_getcwd_or_warn(char *cwd);
 276
 277 char *xmalloc_follow_symlinks(const char *path);
 278
 279
 280 enum {
 281         /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
 282          * otherwise would kill us, except for those resulting from bugs:
 283          * SIGSEGV, SIGILL, SIGFPE.
 284          * Other fatal signals not included (TODO?):
 285          * SIGBUS   Bus error (bad memory access)
 286          * SIGPOLL  Pollable event. Synonym of SIGIO
 287          * SIGPROF  Profiling timer expired
 288          * SIGSYS   Bad argument to routine
 289          * SIGTRAP  Trace/breakpoint trap
 290          */
 291         BB_FATAL_SIGS = (int)(0
 292                 + (1LL << SIGHUP)
 293                 + (1LL << SIGINT)
 294                 + (1LL << SIGTERM)
 295                 + (1LL << SIGPIPE)   // Write to pipe with no readers
 296                 + (1LL << SIGQUIT)   // Quit from keyboard
 297                 + (1LL << SIGABRT)   // Abort signal from abort(3)
 298                 + (1LL << SIGALRM)   // Timer signal from alarm(2)
 299                 + (1LL << SIGVTALRM) // Virtual alarm clock
 300                 + (1LL << SIGXCPU)   // CPU time limit exceeded
 301                 + (1LL << SIGXFSZ)   // File size limit exceeded
 302                 + (1LL << SIGUSR1)   // Yes kids, these are also fatal!
 303                 + (1LL << SIGUSR2)
 304                 + 0),
 305 };
 306 void bb_signals(int sigs, void (*f)(int));
 307 /* Unlike signal() and bb_signals, sets handler with sigaction()
 308  * and in a way that while signal handler is run, no other signals
 309  * will be blocked: */
 310 void bb_signals_recursive(int sigs, void (*f)(int));
 311 /* syscalls like read() will be interrupted with EINTR: */
 312 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int));
 313 /* syscalls like read() won't be interrupted (though select/poll will be): */
 314 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int));
 315 void wait_for_any_sig(void);
 316 void kill_myself_with_sig(int sig) ATTRIBUTE_NORETURN;
 317 void sig_block(int sig);
 318 void sig_unblock(int sig);
 319 /* Will do sigaction(signum, act, NULL): */
 320 int sigaction_set(int sig, const struct sigaction *act);
 321 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
 322 int sigprocmask_allsigs(int how);
 323
 324
 325 void xsetgid(gid_t gid);
 326 void xsetuid(uid_t uid);
 327 void xchdir(const char *path);
 328 void xchroot(const char *path);
 329 void xsetenv(const char *key, const char *value);
 330 void xunlink(const char *pathname);
 331 void xstat(const char *pathname, struct stat *buf);
 332 int xopen(const char *pathname, int flags);
 333 int xopen3(const char *pathname, int flags, int mode);
 334 int open_or_warn(const char *pathname, int flags);
 335 int open3_or_warn(const char *pathname, int flags, int mode);
 336 int open_or_warn_stdin(const char *pathname);
 337 void xrename(const char *oldpath, const char *newpath);
 338 int rename_or_warn(const char *oldpath, const char *newpath);
 339 off_t xlseek(int fd, off_t offset, int whence);
 340 off_t fdlength(int fd);
 341
 342 void xpipe(int filedes[2]);
 343 /* In this form code with pipes is much more readable */
 344 struct fd_pair { int rd; int wr; };
 345 #define piped_pair(pair)  pipe(&((pair).rd))
 346 #define xpiped_pair(pair) xpipe(&((pair).rd))
 347
 348 /* Useful for having small structure members/global variables */
 349 typedef int8_t socktype_t;
 350 typedef int8_t family_t;
 351 struct BUG_too_small {
 352         char BUG_socktype_t_too_small[(0
 353                         | SOCK_STREAM
 354                         | SOCK_DGRAM
 355                         | SOCK_RDM
 356                         | SOCK_SEQPACKET
 357                         | SOCK_RAW
 358                         ) <= 127 ? 1 : -1];
 359         char BUG_family_t_too_small[(0
 360                         | AF_UNSPEC
 361                         | AF_INET
 362                         | AF_INET6
 363                         | AF_UNIX
 364 #ifdef AF_PACKET
 365                         | AF_PACKET
 366 #endif
 367 #ifdef AF_NETLINK
 368                         | AF_NETLINK
 369 #endif
 370                         /* | AF_DECnet */
 371                         /* | AF_IPX */
 372                         ) <= 127 ? 1 : -1];
 373 };
 374
 375
 376 int xsocket(int domain, int type, int protocol);
 377 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
 378 void xlisten(int s, int backlog);
 379 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
 380 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
 381                                 socklen_t tolen);
 382 /* SO_REUSEADDR allows a server to rebind to an address that is already
 383  * "in use" by old connections to e.g. previous server instance which is
 384  * killed or crashed. Without it bind will fail until all such connections
 385  * time out. Linux does not allow multiple live binds on same ip:port
 386  * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
 387  * Turn it on before you call bind(). */
 388 void setsockopt_reuseaddr(int fd); /* On Linux this never fails. */
 389 int setsockopt_broadcast(int fd);
 390 /* NB: returns port in host byte order */
 391 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
 392 typedef struct len_and_sockaddr {
 393         socklen_t len;
 394         union {
 395                 struct sockaddr sa;
 396                 struct sockaddr_in sin;
 397 #if ENABLE_FEATURE_IPV6
 398                 struct sockaddr_in6 sin6;
 399 #endif
 400         } u;
 401 } len_and_sockaddr;
 402 enum {
 403         LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
 404         LSA_SIZEOF_SA = sizeof(
 405                 union {
 406                         struct sockaddr sa;
 407                         struct sockaddr_in sin;
 408 #if ENABLE_FEATURE_IPV6
 409                         struct sockaddr_in6 sin6;
 410 #endif
 411                 }
 412         )
 413 };
 414 /* Create stream socket, and allocate suitable lsa.
 415  * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
 416  * af == AF_UNSPEC will result in trying to create IPv6 socket,
 417  * and if kernel doesn't support it, IPv4.
 418  */
 419 #if ENABLE_FEATURE_IPV6
 420 int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type);
 421 #else
 422 int xsocket_type(len_and_sockaddr **lsap, int sock_type);
 423 #define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
 424 #endif
 425 int xsocket_stream(len_and_sockaddr **lsap);
 426 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
 427  * numeric IP ("N.N.N.N") or numeric IPv6 address,
 428  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
 429  * Only if there is no suffix, port argument is used */
 430 /* NB: these set SO_REUSEADDR before bind */
 431 int create_and_bind_stream_or_die(const char *bindaddr, int port);
 432 int create_and_bind_dgram_or_die(const char *bindaddr, int port);
 433 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
 434  * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
 435  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
 436  * If there is no suffix, port argument is used */
 437 int create_and_connect_stream_or_die(const char *peer, int port);
 438 /* Connect to peer identified by lsa */
 439 int xconnect_stream(const len_and_sockaddr *lsa);
 440 /* Return malloc'ed len_and_sockaddr with socket address of host:port
 441  * Currently will return IPv4 or IPv6 sockaddrs only
 442  * (depending on host), but in theory nothing prevents e.g.
 443  * UNIX socket address being returned, IPX sockaddr etc...
 444  * On error does bb_error_msg and returns NULL */
 445 len_and_sockaddr* host2sockaddr(const char *host, int port);
 446 /* Version which dies on error */
 447 len_and_sockaddr* xhost2sockaddr(const char *host, int port);
 448 len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
 449 /* Same, useful if you want to force family (e.g. IPv6) */
 450 #if !ENABLE_FEATURE_IPV6
 451 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
 452 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
 453 #else
 454 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
 455 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
 456 #endif
 457 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
 458  * otherwise no-op. Useful for ftp.
 459  * NB: does NOT do htons() internally, just direct assignment. */
 460 void set_nport(len_and_sockaddr *lsa, unsigned port);
 461 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
 462 int get_nport(const struct sockaddr *sa);
 463 /* Reverse DNS. Returns NULL on failure. */
 464 char* xmalloc_sockaddr2host(const struct sockaddr *sa);
 465 /* This one doesn't append :PORTNUM */
 466 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa);
 467 /* This one also doesn't fall back to dotted IP (returns NULL) */
 468 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa);
 469 /* inet_[ap]ton on steroids */
 470 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa);
 471 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa);
 472 // "old" (ipv4 only) API
 473 // users: traceroute.c hostname.c - use _list_ of all IPs
 474 struct hostent *xgethostbyname(const char *name);
 475 // Also mount.c and inetd.c are using gethostbyname(),
 476 // + inet_common.c has additional IPv4-only stuff
 477
 478
 479 void socket_want_pktinfo(int fd);
 480 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
 481                 const struct sockaddr *to,
 482                 const struct sockaddr *from,
 483                 socklen_t tolen);
 484 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
 485                 struct sockaddr *from,
 486                 struct sockaddr *to,
 487                 socklen_t sa_size);
 488
 489 char *xstrdup(const char *s);
 490 char *xstrndup(const char *s, int n);
 491 char *safe_strncpy(char *dst, const char *src, size_t size);
 492 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
 493  * But potentially slow, don't use in one-billion-times loops */
 494 int bb_putchar(int ch);
 495 char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
 496 /* Prints unprintable chars ch as ^C or M-c to file
 497  * (M-c is used only if ch is ORed with PRINTABLE_META),
 498  * else it is printed as-is (except for ch = 0x9b) */
 499 enum { PRINTABLE_META = 0x100 };
 500 void fputc_printable(int ch, FILE *file);
 501 // gcc-4.1.1 still isn't good enough at optimizing it
 502 // (+200 bytes compared to macro)
 503 //static ALWAYS_INLINE
 504 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
 505 //static ALWAYS_INLINE
 506 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
 507 #define LONE_DASH(s)     ((s)[0] == '-' && !(s)[1])
 508 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
 509 #define LONE_CHAR(s,c)     ((s)[0] == (c) && !(s)[1])
 510 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
 511 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
 512
 513 /* dmalloc will redefine these to it's own implementation. It is safe
 514  * to have the prototypes here unconditionally.  */
 515 extern void *malloc_or_warn(size_t size);
 516 extern void *xmalloc(size_t size);
 517 extern void *xzalloc(size_t size);
 518 extern void *xrealloc(void *old, size_t size);
 519
 520 extern ssize_t safe_read(int fd, void *buf, size_t count);
 521 extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count);
 522 // NB: will return short read on error, not -1,
 523 // if some data was read before error occurred
 524 extern ssize_t full_read(int fd, void *buf, size_t count);
 525 extern void xread(int fd, void *buf, size_t count);
 526 extern unsigned char xread_char(int fd);
 527 // Read one line a-la fgets. Uses one read(), works only on seekable streams
 528 extern char *reads(int fd, char *buf, size_t count);
 529 // Read one line a-la fgets. Reads byte-by-byte.
 530 // Useful when it is important to not read ahead.
 531 // Bytes are appended to pfx (which must be malloced, or NULL).
 532 extern char *xmalloc_reads(int fd, char *pfx);
 533 extern ssize_t read_close(int fd, void *buf, size_t count);
 534 extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
 535 extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
 536
 537 extern ssize_t safe_write(int fd, const void *buf, size_t count);
 538 // NB: will return short write on error, not -1,
 539 // if some data was written before error occurred
 540 extern ssize_t full_write(int fd, const void *buf, size_t count);
 541 extern void xwrite(int fd, const void *buf, size_t count);
 542
 543 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
 544 extern void xprint_and_close_file(FILE *file);
 545 /* Reads up to (and including) TERMINATING_STRING: */
 546 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
 547 /* Chops off TERMINATING_STRING: from the end: */
 548 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string);
 549 /* Reads up to (and including) "\n" or NUL byte */
 550 extern char *xmalloc_fgets(FILE *file);
 551 /* Chops off '\n' from the end, unlike fgets: */
 552 extern char *xmalloc_getline(FILE *file);
 553 extern char *bb_get_chunk_from_file(FILE *file, int *end);
 554 extern void die_if_ferror(FILE *file, const char *msg);
 555 extern void die_if_ferror_stdout(void);
 556 extern void xfflush_stdout(void);
 557 extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
 558 extern int fclose_if_not_stdin(FILE *file);
 559 extern FILE *xfopen(const char *filename, const char *mode);
 560 /* Prints warning to stderr and returns NULL on failure: */
 561 extern FILE *fopen_or_warn(const char *filename, const char *mode);
 562 /* "Opens" stdin if filename is special, else just opens file: */
 563 extern FILE *xfopen_stdin(const char *filename);
 564 extern FILE *fopen_or_warn_stdin(const char *filename);
 565
 566 int bb_pstrcmp(const void *a, const void *b);
 567 void qsort_string_vector(char **sv, unsigned count);
 568
 569 /* Wrapper which restarts poll on EINTR or ENOMEM.
 570  * On other errors complains [perror("poll")] and returns.
 571  * Warning! May take (much) longer than timeout_ms to return!
 572  * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
 573 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms);
 574
 575 char *safe_gethostname(void);
 576
 577 /* Convert each alpha char in str to lower-case */
 578 char* str_tolower(char *str);
 579
 580 char *utoa(unsigned n);
 581 char *itoa(int n);
 582 /* Returns a pointer past the formatted number, does NOT null-terminate */
 583 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen);
 584 char *itoa_to_buf(int n, char *buf, unsigned buflen);
 585 /* Intelligent formatters of bignums */
 586 void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale);
 587 void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale);
 588 //TODO: provide pointer to buf (avoid statics)?
 589 const char *make_human_readable_str(unsigned long long size,
 590                 unsigned long block_size, unsigned long display_unit);
 591 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
 592 char *bin2hex(char *buf, const char *cp, int count);
 593
 594 /* Last element is marked by mult == 0 */
 595 struct suffix_mult {
 596         char suffix[4];
 597         unsigned mult;
 598 };
 599 #include "xatonum.h"
 600 /* Specialized: */
 601 /* Using xatoi() instead of naive atoi() is not always convenient -
 602  * in many places people want *non-negative* values, but store them
 603  * in signed int. Therefore we need this one:
 604  * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
 605 int xatoi_u(const char *numstr);
 606 /* Useful for reading port numbers */
 607 uint16_t xatou16(const char *numstr);
 608
 609
 610 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
 611  * for BusyBox since we want to avoid using the glibc NSS stuff, which
 612  * increases target size and is often not needed on embedded systems.  */
 613 long xuname2uid(const char *name);
 614 long xgroup2gid(const char *name);
 615 /* wrapper: allows string to contain numeric uid or gid */
 616 unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
 617 /* from chpst. Does not die, returns 0 on failure */
 618 struct bb_uidgid_t {
 619         uid_t uid;
 620         gid_t gid;
 621 };
 622 /* always sets uid and gid */
 623 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
 624 /* chown-like handling of "user[:[group]" */
 625 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
 626 /* bb_getpwuid, bb_getgrgid:
 627  * bb_getXXXid(buf, bufsz, id) - copy user/group name or id
 628  *              as a string to buf, return user/group name or NULL
 629  * bb_getXXXid(NULL, 0, id) - return user/group name or NULL
 630  * bb_getXXXid(NULL, -1, id) - return user/group name or exit
 631 */
 632 char *bb_getpwuid(char *name, int bufsize, long uid);
 633 char *bb_getgrgid(char *group, int bufsize, long gid);
 634 /* versions which cache results (useful for ps, ls etc) */
 635 const char* get_cached_username(uid_t uid);
 636 const char* get_cached_groupname(gid_t gid);
 637 void clear_username_cache(void);
 638 /* internally usernames are saved in fixed-sized char[] buffers */
 639 enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
 640 #if ENABLE_FEATURE_CHECK_NAMES
 641 void die_if_bad_username(const char* name);
 642 #else
 643 #define die_if_bad_username(name) ((void)(name))
 644 #endif
 645
 646 int execable_file(const char *name);
 647 char *find_execable(const char *filename);
 648 int exists_execable(const char *filename);
 649
 650 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
 651  * but it may exec busybox and call applet instead of searching PATH.
 652  */
 653 #if ENABLE_FEATURE_PREFER_APPLETS
 654 int bb_execvp(const char *file, char *const argv[]);
 655 #define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
 656 #define BB_EXECLP(prog,cmd,...) \
 657         execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
 658                 cmd, __VA_ARGS__)
 659 #else
 660 #define BB_EXECVP(prog,cmd)     execvp(prog,cmd)
 661 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
 662 #endif
 663
 664 /* NOMMU friendy fork+exec */
 665 pid_t spawn(char **argv);
 666 pid_t xspawn(char **argv);
 667
 668 int safe_waitpid(int pid, int *wstat, int options);
 669 /* Unlike waitpid, waits ONLY for one process.
 670  * It's safe to pass negative 'pids' from failed [v]fork -
 671  * wait4pid will return -1 (and will not clobber [v]fork's errno).
 672  * IOW: rc = wait4pid(spawn(argv));
 673  *      if (rc < 0) bb_perror_msg("%s", argv[0]);
 674  *      if (rc > 0) bb_error_msg("exit code: %d", rc);
 675  */
 676 int wait4pid(int pid);
 677 int wait_any_nohang(int *wstat);
 678 #define wait_crashed(w) ((w) & 127)
 679 #define wait_exitcode(w) ((w) >> 8)
 680 #define wait_stopsig(w) ((w) >> 8)
 681 #define wait_stopped(w) (((w) & 127) == 127)
 682 /* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
 683 int spawn_and_wait(char **argv);
 684 struct nofork_save_area {
 685         jmp_buf die_jmp;
 686         const char *applet_name;
 687         int xfunc_error_retval;
 688         uint32_t option_mask32;
 689         int die_sleep;
 690         smallint saved;
 691 };
 692 void save_nofork_data(struct nofork_save_area *save);
 693 void restore_nofork_data(struct nofork_save_area *save);
 694 /* Does NOT check that applet is NOFORK, just blindly runs it */
 695 int run_nofork_applet(int applet_no, char **argv);
 696 int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv);
 697
 698 /* Helpers for daemonization.
 699  *
 700  * bb_daemonize(flags) = daemonize, does not compile on NOMMU
 701  *
 702  * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
 703  *      rexec's itself on NOMMU with argv passed as command line.
 704  * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
 705  * from the start. (It will detect it and not reexec again second time).
 706  * You have to audit carefully that you don't do something twice as a result
 707  * (opening files/sockets, parsing config files etc...)!
 708  *
 709  * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
 710  * (will do setsid()).
 711  *
 712  * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
 713  *      "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
 714  *      Currently used for openvt and setsid. On MMU ignores argv.
 715  *
 716  * Helper for network daemons in foreground mode:
 717  *
 718  * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
 719  * to /dev/null if they are not.
 720  */
 721 enum {
 722         DAEMON_CHDIR_ROOT = 1,
 723         DAEMON_DEVNULL_STDIO = 2,
 724         DAEMON_CLOSE_EXTRA_FDS = 4,
 725         DAEMON_ONLY_SANITIZE = 8, /* internal use */
 726 };
 727 #if BB_MMU
 728   void forkexit_or_rexec(void);
 729   enum { re_execed = 0 };
 730 # define forkexit_or_rexec(argv)            forkexit_or_rexec()
 731 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
 732 # define bb_daemonize(flags)                bb_daemonize_or_rexec(flags, bogus)
 733 #else
 734   void re_exec(char **argv) ATTRIBUTE_NORETURN;
 735   void forkexit_or_rexec(char **argv);
 736   extern bool re_execed;
 737   int  BUG_fork_is_unavailable_on_nommu(void);
 738   int  BUG_daemon_is_unavailable_on_nommu(void);
 739   void BUG_bb_daemonize_is_unavailable_on_nommu(void);
 740 # define fork()          BUG_fork_is_unavailable_on_nommu()
 741 # define daemon(a,b)     BUG_daemon_is_unavailable_on_nommu()
 742 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
 743 #endif
 744 void bb_daemonize_or_rexec(int flags, char **argv);
 745 void bb_sanitize_stdio(void);
 746 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
 747 int sanitize_env_if_suid(void);
 748
 749
 750 extern const char *const bb_argv_dash[]; /* "-", NULL */
 751 extern const char *opt_complementary;
 752 #if ENABLE_GETOPT_LONG
 753 #define No_argument "\0"
 754 #define Required_argument "\001"
 755 #define Optional_argument "\002"
 756 extern const char *applet_long_options;
 757 #endif
 758 extern uint32_t option_mask32;
 759 extern uint32_t getopt32(char **argv, const char *applet_opts, ...);
 760
 761
 762 typedef struct llist_t {
 763         char *data;
 764         struct llist_t *link;
 765 } llist_t;
 766 void llist_add_to(llist_t **old_head, void *data);
 767 void llist_add_to_end(llist_t **list_head, void *data);
 768 void *llist_pop(llist_t **elm);
 769 void llist_unlink(llist_t **head, llist_t *elm);
 770 void llist_free(llist_t *elm, void (*freeit)(void *data));
 771 llist_t *llist_rev(llist_t *list);
 772 /* BTW, surprisingly, changing API to
 773  *   llist_t *llist_add_to(llist_t *old_head, void *data)
 774  * etc does not result in smaller code... */
 775
 776 /* start_stop_daemon and udhcpc are special - they want
 777  * to create pidfiles regardless of FEATURE_PIDFILE */
 778 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
 779 /* True only if we created pidfile which is *file*, not /dev/null etc */
 780 extern smallint wrote_pidfile;
 781 void write_pidfile(const char *path);
 782 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
 783 #else
 784 enum { wrote_pidfile = 0 };
 785 #define write_pidfile(path)  ((void)0)
 786 #define remove_pidfile(path) ((void)0)
 787 #endif
 788
 789 enum {
 790         LOGMODE_NONE = 0,
 791         LOGMODE_STDIO = (1 << 0),
 792         LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
 793         LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
 794 };
 795 extern const char *msg_eol;
 796 extern smallint logmode;
 797 extern int die_sleep;
 798 extern int xfunc_error_retval;
 799 extern jmp_buf die_jmp;
 800 extern void xfunc_die(void) ATTRIBUTE_NORETURN;
 801 extern void bb_show_usage(void) ATTRIBUTE_NORETURN;
 802 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
 803 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
 804 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
 805 extern void bb_simple_perror_msg(const char *s);
 806 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
 807 extern void bb_simple_perror_msg_and_die(const char *s) __attribute__ ((noreturn));
 808 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
 809 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
 810 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
 811 extern void bb_perror_nomsg(void);
 812 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
 813 extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
 814
 815 /* We need to export XXX_main from libbusybox
 816  * only if we build "individual" binaries
 817  */
 818 #if ENABLE_FEATURE_INDIVIDUAL
 819 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
 820 #else
 821 #define MAIN_EXTERNALLY_VISIBLE
 822 #endif
 823
 824
 825 /* applets which are useful from another applets */
 826 int bb_cat(char** argv);
 827 int echo_main(int argc, char** argv) MAIN_EXTERNALLY_VISIBLE;
 828 int test_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 829 int kill_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 830 #if ENABLE_ROUTE
 831 void bb_displayroutes(int noresolve, int netstatfmt);
 832 #endif
 833 int chown_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 834 #if ENABLE_GUNZIP
 835 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 836 #endif
 837 #if ENABLE_BUNZIP2
 838 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 839 #endif
 840 int bbunpack(char **argv,
 841         char* (*make_new_name)(char *filename),
 842         USE_DESKTOP(long long) int (*unpacker)(void)
 843 );
 844
 845
 846 /* Networking */
 847 int create_icmp_socket(void);
 848 int create_icmp6_socket(void);
 849 /* interface.c */
 850 /* This structure defines protocol families and their handlers. */
 851 struct aftype {
 852         const char *name;
 853         const char *title;
 854         int af;
 855         int alen;
 856         char *(*print) (unsigned char *);
 857         const char *(*sprint) (struct sockaddr *, int numeric);
 858         int (*input) (/*int type,*/ const char *bufp, struct sockaddr *);
 859         void (*herror) (char *text);
 860         int (*rprint) (int options);
 861         int (*rinput) (int typ, int ext, char **argv);
 862
 863         /* may modify src */
 864         int (*getmask) (char *src, struct sockaddr * mask, char *name);
 865 };
 866 /* This structure defines hardware protocols and their handlers. */
 867 struct hwtype {
 868         const char *name;
 869         const char *title;
 870         int type;
 871         int alen;
 872         char *(*print) (unsigned char *);
 873         int (*input) (const char *, struct sockaddr *);
 874         int (*activate) (int fd);
 875         int suppress_null_addr;
 876 };
 877 extern smallint interface_opt_a;
 878 int display_interfaces(char *ifname);
 879 const struct aftype *get_aftype(const char *name);
 880 const struct hwtype *get_hwtype(const char *name);
 881 const struct hwtype *get_hwntype(int type);
 882
 883
 884 #ifndef BUILD_INDIVIDUAL
 885 extern int find_applet_by_name(const char *name);
 886 /* Returns only if applet is not found. */
 887 extern void run_applet_and_exit(const char *name, char **argv);
 888 extern void run_applet_no_and_exit(int a, char **argv) ATTRIBUTE_NORETURN;
 889 #endif
 890
 891 #ifdef HAVE_MNTENT_H
 892 extern int match_fstype(const struct mntent *mt, const char *fstypes);
 893 extern struct mntent *find_mount_point(const char *name, const char *table);
 894 #endif
 895 extern void erase_mtab(const char * name);
 896 extern unsigned int tty_baud_to_value(speed_t speed);
 897 extern speed_t tty_value_to_baud(unsigned int value);
 898 extern void bb_warn_ignoring_args(int n);
 899
 900 extern int get_linux_version_code(void);
 901
 902 extern char *query_loop(const char *device);
 903 extern int del_loop(const char *device);
 904 /* If *devname is not NULL, use that name, otherwise try to find free one,
 905  * malloc and return it in *devname.
 906  * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
 907 extern int set_loop(char **devname, const char *file, unsigned long long offset);
 908
 909
 910 //TODO: pass buf pointer or return allocated buf (avoid statics)?
 911 char *bb_askpass(int timeout, const char * prompt);
 912 int bb_ask_confirmation(void);
 913
 914 extern int bb_parse_mode(const char* s, mode_t* theMode);
 915
 916 char *concat_path_file(const char *path, const char *filename);
 917 char *concat_subpath_file(const char *path, const char *filename);
 918 const char *bb_basename(const char *name);
 919 /* NB: can violate const-ness (similarly to strchr) */
 920 char *last_char_is(const char *s, int c);
 921
 922
 923 USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
 924 int inflate(int in, int out);
 925
 926
 927 int bb_make_directory(char *path, long mode, int flags);
 928
 929 int get_signum(const char *name);
 930 const char *get_signame(int number);
 931 void print_signames(void);
 932
 933 char *bb_simplify_path(const char *path);
 934
 935 #define FAIL_DELAY 3
 936 extern void bb_do_delay(int seconds);
 937 extern void change_identity(const struct passwd *pw);
 938 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) ATTRIBUTE_NORETURN;
 939 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
 940 #if ENABLE_SELINUX
 941 extern void renew_current_security_context(void);
 942 extern void set_current_security_context(security_context_t sid);
 943 extern context_t set_security_context_component(security_context_t cur_context,
 944                                                 char *user, char *role, char *type, char *range);
 945 extern void setfscreatecon_or_die(security_context_t scontext);
 946 extern void selinux_preserve_fcontext(int fdesc);
 947 #else
 948 #define selinux_preserve_fcontext(fdesc) ((void)0)
 949 #endif
 950 extern void selinux_or_die(void);
 951 extern int restricted_shell(const char *shell);
 952
 953 /* setup_environment:
 954  * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
 955  *   TERM=(old value)
 956  *   USER=pw->pw_name, LOGNAME=pw->pw_name
 957  *   PATH=bb_default_[root_]path
 958  *   HOME=pw->pw_dir
 959  *   SHELL=shell
 960  * else if change_env = 1:
 961  *   if not root (if pw->pw_uid != 0):
 962  *     USER=pw->pw_name, LOGNAME=pw->pw_name
 963  *   HOME=pw->pw_dir
 964  *   SHELL=shell
 965  * else does nothing
 966  */
 967 extern void setup_environment(const char *shell, int clear_env, int change_env, const struct passwd *pw);
 968 extern int correct_password(const struct passwd *pw);
 969 /* Returns a ptr to static storage */
 970 extern char *pw_encrypt(const char *clear, const char *salt);
 971 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
 972
 973 int index_in_str_array(const char *const string_array[], const char *key);
 974 int index_in_strings(const char *strings, const char *key);
 975 int index_in_substr_array(const char *const string_array[], const char *key);
 976 int index_in_substrings(const char *strings, const char *key);
 977 const char *nth_string(const char *strings, int n);
 978
 979 extern void print_login_issue(const char *issue_file, const char *tty);
 980 extern void print_login_prompt(void);
 981
 982 /* rnd is additional random input. New one is returned.
 983  * Useful if you call crypt_make_salt many times in a row:
 984  * rnd = crypt_make_salt(buf1, 4, 0);
 985  * rnd = crypt_make_salt(buf2, 4, rnd);
 986  * rnd = crypt_make_salt(buf3, 4, rnd);
 987  * (otherwise we risk having same salt generated)
 988  */
 989 extern int crypt_make_salt(char *p, int cnt, int rnd);
 990
 991 /* Returns number of lines changed, or -1 on error */
 992 extern int update_passwd(const char *filename, const char *username,
 993                         const char *new_pw);
 994
 995 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
 996 int get_terminal_width_height(int fd, int *width, int *height);
 997
 998 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
 999 void ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
1000 #if ENABLE_IOCTL_HEX2STR_ERROR
1001 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name);
1002 void bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name);
1003 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1004 #define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp,#request)
1005 #else
1006 int bb_ioctl_or_warn(int fd, unsigned request, void *argp);
1007 void bb_xioctl(int fd, unsigned request, void *argp);
1008 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1009 #define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp)
1010 #endif
1011
1012 char *is_in_ino_dev_hashtable(const struct stat *statbuf);
1013 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
1014 void reset_ino_dev_hashtable(void);
1015 #ifdef __GLIBC__
1016 /* At least glibc has horrendously large inline for this, so wrap it */
1017 unsigned long long bb_makedev(unsigned int major, unsigned int minor);
1018 #undef makedev
1019 #define makedev(a,b) bb_makedev(a,b)
1020 #endif
1021
1022
1023 #if ENABLE_FEATURE_EDITING
1024 /* It's NOT just ENABLEd or disabled. It's a number: */
1025 #ifdef CONFIG_FEATURE_EDITING_HISTORY
1026 #define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1027 #else
1028 #define MAX_HISTORY 0
1029 #endif
1030 typedef struct line_input_t {
1031         int flags;
1032         const char *path_lookup;
1033 #if MAX_HISTORY
1034         int cnt_history;
1035         int cur_history;
1036         USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
1037         char *history[MAX_HISTORY + 1];
1038 #endif
1039 } line_input_t;
1040 enum {
1041         DO_HISTORY = 1 * (MAX_HISTORY > 0),
1042         SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1043         TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1044         USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1045         VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
1046         WITH_PATH_LOOKUP = 0x20,
1047         FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1048 };
1049 line_input_t *new_line_input_t(int flags);
1050 /* Returns:
1051  * -1 on read errors or EOF, or on bare Ctrl-D,
1052  * 0  on ctrl-C (the line entered is still returned in 'command'),
1053  * >0 length of input string, including terminating '\n'
1054  */
1055 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
1056 #else
1057 int read_line_input(const char* prompt, char* command, int maxsize);
1058 #define read_line_input(prompt, command, maxsize, state) \
1059         read_line_input(prompt, command, maxsize)
1060 #endif
1061
1062
1063 #ifndef COMM_LEN
1064 #ifdef TASK_COMM_LEN
1065 enum { COMM_LEN = TASK_COMM_LEN };
1066 #else
1067 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1068 enum { COMM_LEN = 16 };
1069 #endif
1070 #endif
1071 typedef struct procps_status_t {
1072         DIR *dir;
1073         uint8_t shift_pages_to_bytes;
1074         uint8_t shift_pages_to_kb;
1075 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1076         char *argv0;
1077         USE_SELINUX(char *context;)
1078         /* Everything below must contain no ptrs to malloc'ed data:
1079          * it is memset(0) for each process in procps_scan() */
1080         unsigned long vsz, rss; /* we round it to kbytes */
1081         unsigned long stime, utime;
1082         unsigned long start_time;
1083         unsigned pid;
1084         unsigned ppid;
1085         unsigned pgid;
1086         unsigned sid;
1087         unsigned uid;
1088         unsigned gid;
1089         unsigned tty_major,tty_minor;
1090 #if ENABLE_FEATURE_TOPMEM
1091         unsigned long mapped_rw;
1092         unsigned long mapped_ro;
1093         unsigned long shared_clean;
1094         unsigned long shared_dirty;
1095         unsigned long private_clean;
1096         unsigned long private_dirty;
1097         unsigned long stack;
1098 #endif
1099         char state[4];
1100         /* basename of executable in exec(2), read from /proc/N/stat
1101          * (if executable is symlink or script, it is NOT replaced
1102          * by link target or interpreter name) */
1103         char comm[COMM_LEN];
1104         /* user/group? - use passwd/group parsing functions */
1105 } procps_status_t;
1106 enum {
1107         PSSCAN_PID      = 1 << 0,
1108         PSSCAN_PPID     = 1 << 1,
1109         PSSCAN_PGID     = 1 << 2,
1110         PSSCAN_SID      = 1 << 3,
1111         PSSCAN_UIDGID   = 1 << 4,
1112         PSSCAN_COMM     = 1 << 5,
1113         /* PSSCAN_CMD      = 1 << 6, - use read_cmdline instead */
1114         PSSCAN_ARGV0    = 1 << 7,
1115         /* PSSCAN_EXE      = 1 << 8, - not implemented */
1116         PSSCAN_STATE    = 1 << 9,
1117         PSSCAN_VSZ      = 1 << 10,
1118         PSSCAN_RSS      = 1 << 11,
1119         PSSCAN_STIME    = 1 << 12,
1120         PSSCAN_UTIME    = 1 << 13,
1121         PSSCAN_TTY      = 1 << 14,
1122         PSSCAN_SMAPS    = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1123         PSSCAN_ARGVN    = (1 << 16) * (ENABLE_PGREP | ENABLE_PKILL),
1124         USE_SELINUX(PSSCAN_CONTEXT = 1 << 17,)
1125         PSSCAN_START_TIME = 1 << 18,
1126         /* These are all retrieved from proc/NN/stat in one go: */
1127         PSSCAN_STAT     = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
1128                         | PSSCAN_COMM | PSSCAN_STATE
1129                         | PSSCAN_VSZ | PSSCAN_RSS
1130                         | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
1131                         | PSSCAN_TTY,
1132 };
1133 //procps_status_t* alloc_procps_scan(void);
1134 void free_procps_scan(procps_status_t* sp);
1135 procps_status_t* procps_scan(procps_status_t* sp, int flags);
1136 /* Format cmdline (up to col chars) into char buf[col+1] */
1137 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1138 void read_cmdline(char *buf, int col, unsigned pid, const char *comm);
1139 pid_t *find_pid_by_name(const char* procName);
1140 pid_t *pidlist_reverse(pid_t *pidList);
1141
1142
1143 extern const char bb_uuenc_tbl_base64[];
1144 extern const char bb_uuenc_tbl_std[];
1145 void bb_uuencode(char *store, const void *s, int length, const char *tbl);
1146
1147 typedef struct sha1_ctx_t {
1148         uint32_t count[2];
1149         uint32_t hash[5];
1150         uint32_t wbuf[16];
1151 } sha1_ctx_t;
1152 void sha1_begin(sha1_ctx_t *ctx);
1153 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
1154 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
1155
1156 typedef struct md5_ctx_t {
1157         uint32_t A;
1158         uint32_t B;
1159         uint32_t C;
1160         uint32_t D;
1161         uint64_t total;
1162         uint32_t buflen;
1163         char buffer[128];
1164 } md5_ctx_t;
1165 void md5_begin(md5_ctx_t *ctx);
1166 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
1167 void *md5_end(void *resbuf, md5_ctx_t *ctx);
1168
1169 uint32_t *crc32_filltable(uint32_t *tbl256, int endian);
1170
1171
1172 enum {  /* DO NOT CHANGE THESE VALUES!  cp.c, mv.c, install.c depend on them. */
1173         FILEUTILS_PRESERVE_STATUS = 1,
1174         FILEUTILS_DEREFERENCE = 2,
1175         FILEUTILS_RECUR = 4,
1176         FILEUTILS_FORCE = 8,
1177         FILEUTILS_INTERACTIVE = 0x10,
1178         FILEUTILS_MAKE_HARDLINK = 0x20,
1179         FILEUTILS_MAKE_SOFTLINK = 0x40,
1180 #if ENABLE_SELINUX
1181         FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x80,
1182         FILEUTILS_SET_SECURITY_CONTEXT = 0x100
1183 #endif
1184 };
1185
1186 #define FILEUTILS_CP_OPTSTR "pdRfils" USE_SELINUX("c")
1187 extern const char *applet_name;
1188 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1189 extern const char bb_banner[];
1190 extern const char bb_msg_memory_exhausted[];
1191 extern const char bb_msg_invalid_date[];
1192 extern const char bb_msg_read_error[];
1193 extern const char bb_msg_write_error[];
1194 extern const char bb_msg_unknown[];
1195 extern const char bb_msg_can_not_create_raw_socket[];
1196 extern const char bb_msg_perm_denied_are_you_root[];
1197 extern const char bb_msg_requires_arg[];
1198 extern const char bb_msg_invalid_arg[];
1199 extern const char bb_msg_standard_input[];
1200 extern const char bb_msg_standard_output[];
1201
1202 extern const char bb_str_default[];
1203 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1204 extern const char bb_hexdigits_upcase[];
1205
1206 extern const char bb_path_mtab_file[];
1207 extern const char bb_path_passwd_file[];
1208 extern const char bb_path_shadow_file[];
1209 extern const char bb_path_gshadow_file[];
1210 extern const char bb_path_group_file[];
1211 extern const char bb_path_motd_file[];
1212 extern const char bb_path_wtmp_file[];
1213 extern const char bb_dev_null[];
1214 extern const char bb_busybox_exec_path[];
1215 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1216  * but I want to save a few bytes here */
1217 extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1218 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1219 #define bb_default_path      (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1220
1221 extern const int const_int_0;
1222 extern const int const_int_1;
1223
1224
1225 #ifndef BUFSIZ
1226 #define BUFSIZ 4096
1227 #endif
1228 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1229 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1230 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1231 /* This struct is deliberately not defined. */
1232 /* See docs/keep_data_small.txt */
1233 struct globals;
1234 /* '*const' ptr makes gcc optimize code much better.
1235  * Magic prevents ptr_to_globals from going into rodata.
1236  * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1237 extern struct globals *const ptr_to_globals;
1238 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1239 #define barrier() asm volatile("":::"memory")
1240 #define SET_PTR_TO_GLOBALS(x) do { \
1241         (*(struct globals**)&ptr_to_globals) = (x); \
1242         barrier(); \
1243 } while (0)
1244
1245 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1246  * use bb_default_login_shell and following defines.
1247  * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1248  * don't forget to change increment constant. */
1249 #define LIBBB_DEFAULT_LOGIN_SHELL      "-/bin/sh"
1250 extern const char bb_default_login_shell[];
1251 /* "/bin/sh" */
1252 #define DEFAULT_SHELL     (bb_default_login_shell+1)
1253 /* "sh" */
1254 #define DEFAULT_SHELL_SHORT_NAME     (bb_default_login_shell+6)
1255
1256
1257 #if ENABLE_FEATURE_DEVFS
1258 # define CURRENT_VC "/dev/vc/0"
1259 # define VC_1 "/dev/vc/1"
1260 # define VC_2 "/dev/vc/2"
1261 # define VC_3 "/dev/vc/3"
1262 # define VC_4 "/dev/vc/4"
1263 # define VC_5 "/dev/vc/5"
1264 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1265 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1266    respective serial ports .. as such, we can't use the common device paths for
1267    these. -- PFM */
1268 #  define SC_0 "/dev/ttsc/0"
1269 #  define SC_1 "/dev/ttsc/1"
1270 #  define SC_FORMAT "/dev/ttsc/%d"
1271 #else
1272 #  define SC_0 "/dev/tts/0"
1273 #  define SC_1 "/dev/tts/1"
1274 #  define SC_FORMAT "/dev/tts/%d"
1275 #endif
1276 # define VC_FORMAT "/dev/vc/%d"
1277 # define LOOP_FORMAT "/dev/loop/%d"
1278 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1279 # define LOOP_NAME "/dev/loop/"
1280 # define FB_0 "/dev/fb/0"
1281 #else
1282 # define CURRENT_VC "/dev/tty0"
1283 # define VC_1 "/dev/tty1"
1284 # define VC_2 "/dev/tty2"
1285 # define VC_3 "/dev/tty3"
1286 # define VC_4 "/dev/tty4"
1287 # define VC_5 "/dev/tty5"
1288 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1289 #  define SC_0 "/dev/ttySC0"
1290 #  define SC_1 "/dev/ttySC1"
1291 #  define SC_FORMAT "/dev/ttySC%d"
1292 #else
1293 #  define SC_0 "/dev/ttyS0"
1294 #  define SC_1 "/dev/ttyS1"
1295 #  define SC_FORMAT "/dev/ttyS%d"
1296 #endif
1297 # define VC_FORMAT "/dev/tty%d"
1298 # define LOOP_FORMAT "/dev/loop%d"
1299 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1300 # define LOOP_NAME "/dev/loop"
1301 # define FB_0 "/dev/fb0"
1302 #endif
1303
1304 /* The following devices are the same on devfs and non-devfs systems.  */
1305 #define CURRENT_TTY "/dev/tty"
1306 #define DEV_CONSOLE "/dev/console"
1307
1308
1309 #ifndef RB_POWER_OFF
1310 /* Stop system and switch power off if possible.  */
1311 #define RB_POWER_OFF   0x4321fedc
1312 #endif
1313
1314 /* Make sure we call functions instead of macros.  */
1315 #undef isalnum
1316 #undef isalpha
1317 #undef isascii
1318 #undef isblank
1319 #undef iscntrl
1320 #undef isgraph
1321 #undef islower
1322 #undef isprint
1323 #undef ispunct
1324 #undef isspace
1325 #undef isupper
1326 #undef isxdigit
1327
1328 /* This one is more efficient - we save ~400 bytes */
1329 #undef isdigit
1330 #define isdigit(a) ((unsigned)((a) - '0') <= 9)
1331
1332
1333 #ifdef DMALLOC
1334 #include <dmalloc.h>
1335 #endif
1336
1337 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
1338
1339 #endif /* __LIBBUSYBOX_H__ */