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 GPL.
   7  *
   8  * Licensed under GPLv2, see file LICENSE in this source tree.
   9  */
  10 #ifndef LIBBB_H
  11 #define LIBBB_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 #if defined __UCLIBC__ /* TODO: and glibc? */
  24 /* use inlined versions of these: */
  25 # define sigfillset(s)    __sigfillset(s)
  26 # define sigemptyset(s)   __sigemptyset(s)
  27 # define sigisemptyset(s) __sigisemptyset(s)
  28 #endif
  29 #include <stdint.h>
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <stdarg.h>
  33 #include <stddef.h>
  34 #include <string.h>
  35 #include <sys/poll.h>
  36 #include <sys/ioctl.h>
  37 #include <sys/mman.h>
  38 #include <sys/socket.h>
  39 #include <sys/stat.h>
  40 #include <sys/time.h>
  41 #include <sys/types.h>
  42 #ifndef major
  43 # include <sys/sysmacros.h>
  44 #endif
  45 #include <sys/wait.h>
  46 #include <termios.h>
  47 #include <time.h>
  48 #include <sys/param.h>
  49 #ifdef HAVE_MNTENT_H
  50 # include <mntent.h>
  51 #endif
  52 #ifdef HAVE_SYS_STATFS_H
  53 # include <sys/statfs.h>
  54 #endif
  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 #if ENABLE_FEATURE_UTMP
  62 # include <utmp.h>
  63 #endif
  64 #if ENABLE_LOCALE_SUPPORT
  65 # include <locale.h>
  66 #else
  67 # define setlocale(x,y) ((void)0)
  68 #endif
  69 #ifdef DMALLOC
  70 # include <dmalloc.h>
  71 #endif
  72 #include <pwd.h>
  73 #include <grp.h>
  74 #if ENABLE_FEATURE_SHADOWPASSWDS
  75 # if !ENABLE_USE_BB_SHADOW
  76 /* If using busybox's shadow implementation, do not include the shadow.h
  77  * header as the toolchain may not provide it at all.
  78  */
  79 #  include <shadow.h>
  80 # endif
  81 #endif
  82 /* Just in case libc doesn't define some of these... */
  83 #ifndef _PATH_PASSWD
  84 #define _PATH_PASSWD  "/etc/passwd"
  85 #endif
  86 #ifndef _PATH_GROUP
  87 #define _PATH_GROUP   "/etc/group"
  88 #endif
  89 #ifndef _PATH_SHADOW
  90 #define _PATH_SHADOW  "/etc/shadow"
  91 #endif
  92 #ifndef _PATH_GSHADOW
  93 #define _PATH_GSHADOW "/etc/gshadow"
  94 #endif
  95 #if defined __FreeBSD__ || defined __OpenBSD__
  96 # include <netinet/in.h>
  97 # include <arpa/inet.h>
  98 #elif defined __APPLE__
  99 # include <netinet/in.h>
 100 #else
 101 # include <arpa/inet.h>
 102 # if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
 103 /* We #define socklen_t *after* includes, otherwise we get
 104  * typedef redefinition errors from system headers
 105  * (in case "is it defined already" detection above failed)
 106  */
 107 #  define socklen_t bb_socklen_t
 108    typedef unsigned socklen_t;
 109 # endif
 110 #endif
 111 #ifndef HAVE_CLEARENV
 112 # define clearenv() do { if (environ) environ[0] = NULL; } while (0)
 113 #endif
 114 #ifndef HAVE_FDATASYNC
 115 # define fdatasync fsync
 116 #endif
 117 #ifndef HAVE_XTABS
 118 # define XTABS TAB3
 119 #endif
 120
 121
 122 /* Some libc's forget to declare these, do it ourself */
 123
 124 extern char **environ;
 125 #if defined(__GLIBC__) && __GLIBC__ < 2
 126 int vdprintf(int d, const char *format, va_list ap);
 127 #endif
 128 /* klogctl is in libc's klog.h, but we cheat and not #include that */
 129 int klogctl(int type, char *b, int len);
 130 /* This is declared here rather than #including <libgen.h> in order to avoid
 131  * confusing the two versions of basename.  See the dirname/basename man page
 132  * for details. */
 133 #if !defined __FreeBSD__
 134 char *dirname(char *path);
 135 #endif
 136 /* Include our own copy of struct sysinfo to avoid binary compatibility
 137  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
 138 struct sysinfo {
 139         long uptime;                    /* Seconds since boot */
 140         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
 141         unsigned long totalram;         /* Total usable main memory size */
 142         unsigned long freeram;          /* Available memory size */
 143         unsigned long sharedram;        /* Amount of shared memory */
 144         unsigned long bufferram;        /* Memory used by buffers */
 145         unsigned long totalswap;        /* Total swap space size */
 146         unsigned long freeswap;         /* swap space still available */
 147         unsigned short procs;           /* Number of current processes */
 148         unsigned short pad;                     /* Padding needed for m68k */
 149         unsigned long totalhigh;        /* Total high memory size */
 150         unsigned long freehigh;         /* Available high memory size */
 151         unsigned int mem_unit;          /* Memory unit size in bytes */
 152         char _f[20 - 2 * sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
 153 };
 154 int sysinfo(struct sysinfo* info);
 155 #ifndef PATH_MAX
 156 # define PATH_MAX 256
 157 #endif
 158 #ifndef BUFSIZ
 159 # define BUFSIZ 4096
 160 #endif
 161
 162
 163 /* Busybox does not use threads, we can speed up stdio. */
 164 #ifdef HAVE_UNLOCKED_STDIO
 165 # undef  getc
 166 # define getc(stream) getc_unlocked(stream)
 167 # undef  getchar
 168 # define getchar() getchar_unlocked()
 169 # undef  putc
 170 # define putc(c, stream) putc_unlocked(c, stream)
 171 # undef  putchar
 172 # define putchar(c) putchar_unlocked(c)
 173 # undef  fgetc
 174 # define fgetc(stream) getc_unlocked(stream)
 175 # undef  fputc
 176 # define fputc(c, stream) putc_unlocked(c, stream)
 177 #endif
 178 /* Above functions are required by POSIX.1-2008, below ones are extensions */
 179 #ifdef HAVE_UNLOCKED_LINE_OPS
 180 # undef  fgets
 181 # define fgets(s, n, stream) fgets_unlocked(s, n, stream)
 182 # undef  fputs
 183 # define fputs(s, stream) fputs_unlocked(s, stream)
 184 #endif
 185
 186
 187 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
 188 /* (don't include system headers after this until corresponding pop!) */
 189 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
 190
 191
 192 #if ENABLE_USE_BB_PWD_GRP
 193 # include "pwd_.h"
 194 # include "grp_.h"
 195 #endif
 196 #if ENABLE_FEATURE_SHADOWPASSWDS
 197 # if ENABLE_USE_BB_SHADOW
 198 #  include "shadow_.h"
 199 # endif
 200 #endif
 201
 202 /* Tested to work correctly with all int types (IIRC :]) */
 203 #define MAXINT(T) (T)( \
 204         ((T)-1) > 0 \
 205         ? (T)-1 \
 206         : (T)~((T)1 << (sizeof(T)*8-1)) \
 207         )
 208
 209 #define MININT(T) (T)( \
 210         ((T)-1) > 0 \
 211         ? (T)0 \
 212         : ((T)1 << (sizeof(T)*8-1)) \
 213         )
 214
 215 /* Large file support */
 216 /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
 217  * (stat, lseek etc) mapped to "largefile" variants by libc.
 218  * Practically it means that open() automatically has O_LARGEFILE added
 219  * and all filesize/file_offset parameters and struct members are "large"
 220  * (in today's world - signed 64bit). For full support of large files,
 221  * we need a few helper #defines (below) and careful use of off_t
 222  * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
 223 #if ENABLE_LFS
 224 /* CONFIG_LFS is on */
 225 # if ULONG_MAX > 0xffffffff
 226 /* "long" is long enough on this system */
 227 typedef unsigned long uoff_t;
 228 #  define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
 229 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
 230 #  define BB_STRTOOFF bb_strtoul
 231 #  define STRTOOFF strtoul
 232 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
 233 #  define OFF_FMT "l"
 234 # else
 235 /* "long" is too short, need "long long" */
 236 typedef unsigned long long uoff_t;
 237 #  define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
 238 #  define BB_STRTOOFF bb_strtoull
 239 #  define STRTOOFF strtoull
 240 #  define OFF_FMT "ll"
 241 # endif
 242 #else
 243 /* CONFIG_LFS is off */
 244 # if UINT_MAX == 0xffffffff
 245 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
 246  * gcc will throw warnings on printf("%d", off_t). Crap... */
 247 typedef unsigned long uoff_t;
 248 #  define XATOOFF(a) xatoi_positive(a)
 249 #  define BB_STRTOOFF bb_strtou
 250 #  define STRTOOFF strtol
 251 #  define OFF_FMT "l"
 252 # else
 253 typedef unsigned long uoff_t;
 254 #  define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
 255 #  define BB_STRTOOFF bb_strtoul
 256 #  define STRTOOFF strtol
 257 #  define OFF_FMT "l"
 258 # endif
 259 #endif
 260 /* scary. better ideas? (but do *test* them first!) */
 261 #define OFF_T_MAX  ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
 262
 263 /* Some useful definitions */
 264 #undef FALSE
 265 #define FALSE   ((int) 0)
 266 #undef TRUE
 267 #define TRUE    ((int) 1)
 268 #undef SKIP
 269 #define SKIP    ((int) 2)
 270
 271 /* for mtab.c */
 272 #define MTAB_GETMOUNTPT '1'
 273 #define MTAB_GETDEVICE  '2'
 274
 275 #define BUF_SIZE        8192
 276 #define EXPAND_ALLOC    1024
 277
 278 /* Macros for min/max.  */
 279 #ifndef MIN
 280 #define MIN(a,b) (((a)<(b))?(a):(b))
 281 #endif
 282
 283 #ifndef MAX
 284 #define MAX(a,b) (((a)>(b))?(a):(b))
 285 #endif
 286
 287 /* buffer allocation schemes */
 288 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
 289 #define RESERVE_CONFIG_BUFFER(buffer,len)  char buffer[len]
 290 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
 291 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
 292 #else
 293 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
 294 #define RESERVE_CONFIG_BUFFER(buffer,len)  static          char buffer[len]
 295 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
 296 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
 297 #else
 298 #define RESERVE_CONFIG_BUFFER(buffer,len)  char *buffer = xmalloc(len)
 299 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
 300 #define RELEASE_CONFIG_BUFFER(buffer)      free(buffer)
 301 #endif
 302 #endif
 303
 304 #if defined(__GLIBC__)
 305 /* glibc uses __errno_location() to get a ptr to errno */
 306 /* We can just memorize it once - no multithreading in busybox :) */
 307 extern int *const bb_errno;
 308 #undef errno
 309 #define errno (*bb_errno)
 310 #endif
 311
 312 #if !(ULONG_MAX > 0xffffffff)
 313 /* Only 32-bit CPUs need this, 64-bit ones use inlined version */
 314 uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
 315 #endif
 316
 317 unsigned long long monotonic_ns(void) FAST_FUNC;
 318 unsigned long long monotonic_us(void) FAST_FUNC;
 319 unsigned long long monotonic_ms(void) FAST_FUNC;
 320 unsigned monotonic_sec(void) FAST_FUNC;
 321
 322 extern void chomp(char *s) FAST_FUNC;
 323 extern void trim(char *s) FAST_FUNC;
 324 extern char *skip_whitespace(const char *) FAST_FUNC;
 325 extern char *skip_non_whitespace(const char *) FAST_FUNC;
 326 extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
 327
 328 extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
 329
 330 //TODO: supply a pointer to char[11] buffer (avoid statics)?
 331 extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
 332 extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
 333 enum {  /* DO NOT CHANGE THESE VALUES!  cp.c, mv.c, install.c depend on them. */
 334         FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
 335         FILEUTILS_DEREFERENCE     = 1 << 1, /* !-d */
 336         FILEUTILS_RECUR           = 1 << 2, /* -R */
 337         FILEUTILS_FORCE           = 1 << 3, /* -f */
 338         FILEUTILS_INTERACTIVE     = 1 << 4, /* -i */
 339         FILEUTILS_MAKE_HARDLINK   = 1 << 5, /* -l */
 340         FILEUTILS_MAKE_SOFTLINK   = 1 << 6, /* -s */
 341         FILEUTILS_DEREF_SOFTLINK  = 1 << 7, /* -L */
 342         FILEUTILS_DEREFERENCE_L0  = 1 << 8, /* -H */
 343 #if ENABLE_SELINUX
 344         FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
 345         FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
 346 #endif
 347 };
 348 #define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
 349 extern int remove_file(const char *path, int flags) FAST_FUNC;
 350 /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
 351  * the source, not copy (unless "source" is a directory).
 352  * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
 353  * work coreutils-compatibly. */
 354 extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
 355
 356 enum {
 357         ACTION_RECURSE        = (1 << 0),
 358         ACTION_FOLLOWLINKS    = (1 << 1),
 359         ACTION_FOLLOWLINKS_L0 = (1 << 2),
 360         ACTION_DEPTHFIRST     = (1 << 3),
 361         /*ACTION_REVERSE      = (1 << 4), - unused */
 362         ACTION_QUIET          = (1 << 5),
 363         ACTION_DANGLING_OK    = (1 << 6),
 364 };
 365 typedef uint8_t recurse_flags_t;
 366 extern int recursive_action(const char *fileName, unsigned flags,
 367         int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
 368         int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
 369         void* userData, unsigned depth) FAST_FUNC;
 370 extern int device_open(const char *device, int mode) FAST_FUNC;
 371 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
 372 extern int xgetpty(char *line) FAST_FUNC;
 373 extern int get_console_fd_or_die(void) FAST_FUNC;
 374 extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
 375 extern char *find_block_device(const char *path) FAST_FUNC;
 376 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
 377 extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
 378 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
 379 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
 380 /* "short" copy can be detected by return value < size */
 381 /* this helper yells "short read!" if param is not -1 */
 382 extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
 383
 384 extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
 385 char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
 386 /* xxxx_strip version can modify its parameter:
 387  * "/"        -> "/"
 388  * "abc"      -> "abc"
 389  * "abc/def"  -> "def"
 390  * "abc/def/" -> "def" !!
 391  */
 392 char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
 393 /* "abc/def/" -> "" and it never modifies 'path' */
 394 char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
 395 /* Simpler version: does not special case "/" string */
 396 const char *bb_basename(const char *name) FAST_FUNC;
 397 /* NB: can violate const-ness (similarly to strchr) */
 398 char *last_char_is(const char *s, int c) FAST_FUNC;
 399
 400 void ndelay_on(int fd) FAST_FUNC;
 401 void ndelay_off(int fd) FAST_FUNC;
 402 void close_on_exec_on(int fd) FAST_FUNC;
 403 void xdup2(int, int) FAST_FUNC;
 404 void xmove_fd(int, int) FAST_FUNC;
 405
 406
 407 DIR *xopendir(const char *path) FAST_FUNC;
 408 DIR *warn_opendir(const char *path) FAST_FUNC;
 409
 410 char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
 411 char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
 412 char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
 413 /* !RETURNS_MALLOC: it's a realloc-like function */
 414 char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
 415
 416 char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
 417
 418
 419 enum {
 420         /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
 421          * otherwise would kill us, except for those resulting from bugs:
 422          * SIGSEGV, SIGILL, SIGFPE.
 423          * Other fatal signals not included (TODO?):
 424          * SIGBUS   Bus error (bad memory access)
 425          * SIGPOLL  Pollable event. Synonym of SIGIO
 426          * SIGPROF  Profiling timer expired
 427          * SIGSYS   Bad argument to routine
 428          * SIGTRAP  Trace/breakpoint trap
 429          *
 430          * The only known arch with some of these sigs not fitting
 431          * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
 432          * Dance around with long long to guard against that...
 433          */
 434         BB_FATAL_SIGS = (int)(0
 435                 + (1LL << SIGHUP)
 436                 + (1LL << SIGINT)
 437                 + (1LL << SIGTERM)
 438                 + (1LL << SIGPIPE)   // Write to pipe with no readers
 439                 + (1LL << SIGQUIT)   // Quit from keyboard
 440                 + (1LL << SIGABRT)   // Abort signal from abort(3)
 441                 + (1LL << SIGALRM)   // Timer signal from alarm(2)
 442                 + (1LL << SIGVTALRM) // Virtual alarm clock
 443                 + (1LL << SIGXCPU)   // CPU time limit exceeded
 444                 + (1LL << SIGXFSZ)   // File size limit exceeded
 445                 + (1LL << SIGUSR1)   // Yes kids, these are also fatal!
 446                 + (1LL << SIGUSR2)
 447                 + 0),
 448 };
 449 void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
 450 /* Unlike signal() and bb_signals, sets handler with sigaction()
 451  * and in a way that while signal handler is run, no other signals
 452  * will be blocked; syscalls will not be restarted: */
 453 void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
 454 /* syscalls like read() will be interrupted with EINTR: */
 455 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
 456 /* syscalls like read() won't be interrupted (though select/poll will be): */
 457 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
 458 void wait_for_any_sig(void) FAST_FUNC;
 459 void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
 460 void sig_block(int sig) FAST_FUNC;
 461 void sig_unblock(int sig) FAST_FUNC;
 462 /* Will do sigaction(signum, act, NULL): */
 463 int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
 464 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
 465 int sigprocmask_allsigs(int how) FAST_FUNC;
 466 /* Standard handler which just records signo */
 467 extern smallint bb_got_signal;
 468 void record_signo(int signo); /* not FAST_FUNC! */
 469
 470
 471 void xsetgid(gid_t gid) FAST_FUNC;
 472 void xsetuid(uid_t uid) FAST_FUNC;
 473 void xchdir(const char *path) FAST_FUNC;
 474 void xchroot(const char *path) FAST_FUNC;
 475 void xsetenv(const char *key, const char *value) FAST_FUNC;
 476 void bb_unsetenv(const char *key) FAST_FUNC;
 477 void bb_unsetenv_and_free(char *key) FAST_FUNC;
 478 void xunlink(const char *pathname) FAST_FUNC;
 479 void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
 480 void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
 481 int xopen(const char *pathname, int flags) FAST_FUNC;
 482 int xopen_nonblocking(const char *pathname) FAST_FUNC;
 483 int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
 484 int open_or_warn(const char *pathname, int flags) FAST_FUNC;
 485 int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
 486 int open_or_warn_stdin(const char *pathname) FAST_FUNC;
 487 int xopen_stdin(const char *pathname) FAST_FUNC;
 488 void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
 489 int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
 490 off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
 491 int xmkstemp(char *template) FAST_FUNC;
 492 off_t fdlength(int fd) FAST_FUNC;
 493
 494 uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
 495                 const char *override,
 496                 unsigned override_units,
 497                 int extend);
 498
 499 void xpipe(int filedes[2]) FAST_FUNC;
 500 /* In this form code with pipes is much more readable */
 501 struct fd_pair { int rd; int wr; };
 502 #define piped_pair(pair)  pipe(&((pair).rd))
 503 #define xpiped_pair(pair) xpipe(&((pair).rd))
 504
 505 /* Useful for having small structure members/global variables */
 506 typedef int8_t socktype_t;
 507 typedef int8_t family_t;
 508 struct BUG_too_small {
 509         char BUG_socktype_t_too_small[(0
 510                         | SOCK_STREAM
 511                         | SOCK_DGRAM
 512                         | SOCK_RDM
 513                         | SOCK_SEQPACKET
 514                         | SOCK_RAW
 515                         ) <= 127 ? 1 : -1];
 516         char BUG_family_t_too_small[(0
 517                         | AF_UNSPEC
 518                         | AF_INET
 519                         | AF_INET6
 520                         | AF_UNIX
 521 #ifdef AF_PACKET
 522                         | AF_PACKET
 523 #endif
 524 #ifdef AF_NETLINK
 525                         | AF_NETLINK
 526 #endif
 527                         /* | AF_DECnet */
 528                         /* | AF_IPX */
 529                         ) <= 127 ? 1 : -1];
 530 };
 531
 532
 533 void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
 534 time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
 535
 536
 537 int xsocket(int domain, int type, int protocol) FAST_FUNC;
 538 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
 539 void xlisten(int s, int backlog) FAST_FUNC;
 540 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
 541 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
 542                                 socklen_t tolen) FAST_FUNC;
 543 /* SO_REUSEADDR allows a server to rebind to an address that is already
 544  * "in use" by old connections to e.g. previous server instance which is
 545  * killed or crashed. Without it bind will fail until all such connections
 546  * time out. Linux does not allow multiple live binds on same ip:port
 547  * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
 548  * Turn it on before you call bind(). */
 549 void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
 550 int setsockopt_broadcast(int fd) FAST_FUNC;
 551 int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
 552 /* NB: returns port in host byte order */
 553 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
 554 typedef struct len_and_sockaddr {
 555         socklen_t len;
 556         union {
 557                 struct sockaddr sa;
 558                 struct sockaddr_in sin;
 559 #if ENABLE_FEATURE_IPV6
 560                 struct sockaddr_in6 sin6;
 561 #endif
 562         } u;
 563 } len_and_sockaddr;
 564 enum {
 565         LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
 566         LSA_SIZEOF_SA = sizeof(
 567                 union {
 568                         struct sockaddr sa;
 569                         struct sockaddr_in sin;
 570 #if ENABLE_FEATURE_IPV6
 571                         struct sockaddr_in6 sin6;
 572 #endif
 573                 }
 574         )
 575 };
 576 /* Create stream socket, and allocate suitable lsa.
 577  * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
 578  * af == AF_UNSPEC will result in trying to create IPv6 socket,
 579  * and if kernel doesn't support it, fall back to IPv4.
 580  * This is useful if you plan to bind to resulting local lsa.
 581  */
 582 #if ENABLE_FEATURE_IPV6
 583 int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
 584 #else
 585 int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
 586 #define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
 587 #endif
 588 int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
 589 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
 590  * numeric IP ("N.N.N.N") or numeric IPv6 address,
 591  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
 592  * Only if there is no suffix, port argument is used */
 593 /* NB: these set SO_REUSEADDR before bind */
 594 int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
 595 int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
 596 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
 597  * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
 598  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
 599  * If there is no suffix, port argument is used */
 600 int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
 601 /* Connect to peer identified by lsa */
 602 int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
 603 /* Get local address of bound or accepted socket */
 604 len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
 605 /* Get remote address of connected or accepted socket */
 606 len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
 607 /* Return malloc'ed len_and_sockaddr with socket address of host:port
 608  * Currently will return IPv4 or IPv6 sockaddrs only
 609  * (depending on host), but in theory nothing prevents e.g.
 610  * UNIX socket address being returned, IPX sockaddr etc...
 611  * On error does bb_error_msg and returns NULL */
 612 len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
 613 /* Version which dies on error */
 614 len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
 615 len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
 616 /* Same, useful if you want to force family (e.g. IPv6) */
 617 #if !ENABLE_FEATURE_IPV6
 618 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
 619 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
 620 #else
 621 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
 622 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
 623 #endif
 624 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
 625  * otherwise no-op. Useful for ftp.
 626  * NB: does NOT do htons() internally, just direct assignment. */
 627 void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
 628 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
 629 int get_nport(const struct sockaddr *sa) FAST_FUNC;
 630 /* Reverse DNS. Returns NULL on failure. */
 631 char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 632 /* This one doesn't append :PORTNUM */
 633 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 634 /* This one also doesn't fall back to dotted IP (returns NULL) */
 635 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 636 /* inet_[ap]ton on steroids */
 637 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 638 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
 639 // "old" (ipv4 only) API
 640 // users: traceroute.c hostname.c - use _list_ of all IPs
 641 struct hostent *xgethostbyname(const char *name) FAST_FUNC;
 642 // Also mount.c and inetd.c are using gethostbyname(),
 643 // + inet_common.c has additional IPv4-only stuff
 644
 645
 646 void socket_want_pktinfo(int fd) FAST_FUNC;
 647 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
 648                 const struct sockaddr *to,
 649                 const struct sockaddr *from,
 650                 socklen_t tolen) FAST_FUNC;
 651 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
 652                 struct sockaddr *from,
 653                 struct sockaddr *to,
 654                 socklen_t sa_size) FAST_FUNC;
 655
 656
 657 char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
 658 char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
 659 void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
 660 char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
 661 char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
 662 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
 663  * But potentially slow, don't use in one-billion-times loops */
 664 int bb_putchar(int ch) FAST_FUNC;
 665 /* Note: does not use stdio, writes to fd 2 directly */
 666 int bb_putchar_stderr(char ch) FAST_FUNC;
 667 char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
 668 // gcc-4.1.1 still isn't good enough at optimizing it
 669 // (+200 bytes compared to macro)
 670 //static ALWAYS_INLINE
 671 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
 672 //static ALWAYS_INLINE
 673 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
 674 #define LONE_DASH(s)     ((s)[0] == '-' && !(s)[1])
 675 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
 676 #define LONE_CHAR(s,c)     ((s)[0] == (c) && !(s)[1])
 677 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
 678 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
 679
 680 typedef struct uni_stat_t {
 681         unsigned byte_count;
 682         unsigned unicode_count;
 683         unsigned unicode_width;
 684 } uni_stat_t;
 685 /* Returns a string with unprintable chars replaced by '?' or
 686  * SUBST_WCHAR. This function is unicode-aware. */
 687 const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
 688 /* Prints unprintable char ch as ^C or M-c to file
 689  * (M-c is used only if ch is ORed with PRINTABLE_META),
 690  * else it is printed as-is (except for ch = 0x9b) */
 691 enum { PRINTABLE_META = 0x100 };
 692 void fputc_printable(int ch, FILE *file) FAST_FUNC;
 693
 694 /* dmalloc will redefine these to it's own implementation. It is safe
 695  * to have the prototypes here unconditionally.  */
 696 void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
 697 void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
 698 void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
 699 void *xrealloc(void *old, size_t size) FAST_FUNC;
 700 /* After xrealloc_vector(v, 4, idx) it's ok to use
 701  * at least v[idx] and v[idx+1], for all idx values.
 702  * shift specifies how many new elements are added (1: 2, 2: 4... 8: 256...)
 703  * when all elements are used up. New elements are zeroed out. */
 704 #define xrealloc_vector(vector, shift, idx) \
 705         xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
 706 void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
 707
 708
 709 extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
 710 extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count, int loop_on_EINTR) FAST_FUNC;
 711 // NB: will return short read on error, not -1,
 712 // if some data was read before error occurred
 713 extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
 714 extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
 715 extern unsigned char xread_char(int fd) FAST_FUNC;
 716 extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
 717 extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
 718 // Reads one line a-la fgets (but doesn't save terminating '\n').
 719 // Reads byte-by-byte. Useful when it is important to not read ahead.
 720 // Bytes are appended to pfx (which must be malloced, or NULL).
 721 extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
 722 /* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
 723 extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 724 /* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
 725 extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 726 /* Never returns NULL */
 727 extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 728 /* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
 729 #if ENABLE_FEATURE_SEAMLESS_LZMA \
 730  || ENABLE_FEATURE_SEAMLESS_BZ2 \
 731  || ENABLE_FEATURE_SEAMLESS_GZ \
 732  /* || ENABLE_FEATURE_SEAMLESS_Z */
 733 extern void setup_unzip_on_fd(int fd /*, int fail_if_not_detected*/) FAST_FUNC;
 734 #else
 735 # define setup_unzip_on_fd(...) ((void)0)
 736 #endif
 737 /* Autodetects .gz etc */
 738 extern int open_zipped(const char *fname) FAST_FUNC;
 739 extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 740
 741 extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
 742 // NB: will return short write on error, not -1,
 743 // if some data was written before error occurred
 744 extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
 745 extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
 746 extern void xwrite_str(int fd, const char *str) FAST_FUNC;
 747 extern ssize_t full_write1_str(const char *str) FAST_FUNC;
 748 extern ssize_t full_write2_str(const char *str) FAST_FUNC;
 749 extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
 750
 751 /* Close fd, but check for failures (some types of write errors) */
 752 extern void xclose(int fd) FAST_FUNC;
 753
 754 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
 755 extern void xprint_and_close_file(FILE *file) FAST_FUNC;
 756
 757 /* Reads a line from a text file, up to a newline or NUL byte, inclusive.
 758  * Returns malloc'ed char*. If end is NULL '\n' isn't considered
 759  * end of line. If end isn't NULL, length of the chunk is stored in it.
 760  * Returns NULL if EOF/error.
 761  */
 762 extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
 763 /* Reads up to (and including) TERMINATING_STRING: */
 764 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
 765 /* Same, with limited max size, and returns the length (excluding NUL): */
 766 extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
 767 /* Chops off TERMINATING_STRING from the end: */
 768 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
 769 /* Reads up to (and including) "\n" or NUL byte: */
 770 extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
 771 /* Chops off '\n' from the end, unlike fgets: */
 772 extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
 773 /* Same, but doesn't try to conserve space (may have some slack after the end) */
 774 /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
 775
 776 void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
 777 void die_if_ferror_stdout(void) FAST_FUNC;
 778 int fflush_all(void) FAST_FUNC;
 779 void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
 780 int fclose_if_not_stdin(FILE *file) FAST_FUNC;
 781 FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
 782 /* Prints warning to stderr and returns NULL on failure: */
 783 FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
 784 /* "Opens" stdin if filename is special, else just opens file: */
 785 FILE* xfopen_stdin(const char *filename) FAST_FUNC;
 786 FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
 787 FILE* fopen_for_read(const char *path) FAST_FUNC;
 788 FILE* xfopen_for_read(const char *path) FAST_FUNC;
 789 FILE* fopen_for_write(const char *path) FAST_FUNC;
 790 FILE* xfopen_for_write(const char *path) FAST_FUNC;
 791 FILE* xfdopen_for_read(int fd) FAST_FUNC;
 792 FILE* xfdopen_for_write(int fd) FAST_FUNC;
 793
 794 int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
 795 void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
 796
 797 /* Wrapper which restarts poll on EINTR or ENOMEM.
 798  * On other errors complains [perror("poll")] and returns.
 799  * Warning! May take (much) longer than timeout_ms to return!
 800  * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
 801 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
 802
 803 char *safe_gethostname(void) FAST_FUNC;
 804 char *safe_getdomainname(void) FAST_FUNC;
 805
 806 /* Convert each alpha char in str to lower-case */
 807 char* str_tolower(char *str) FAST_FUNC;
 808
 809 char *utoa(unsigned n) FAST_FUNC;
 810 char *itoa(int n) FAST_FUNC;
 811 /* Returns a pointer past the formatted number, does NOT null-terminate */
 812 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
 813 char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
 814 /* Intelligent formatters of bignums */
 815 void smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
 816 void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
 817 /* If block_size == 0, display size without fractional part,
 818  * else display (size * block_size) with one decimal digit.
 819  * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
 820  * else divide by display_unit and do not use suffix. */
 821 #define HUMAN_READABLE_MAX_WIDTH      7  /* "1024.0G" */
 822 #define HUMAN_READABLE_MAX_WIDTH_STR "7"
 823 //TODO: provide pointer to buf (avoid statics)?
 824 const char *make_human_readable_str(unsigned long long size,
 825                 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
 826 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
 827 char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
 828 /* Reverse */
 829 char* hex2bin(char *dst, const char *str, int count) FAST_FUNC;
 830
 831 /* Generate a UUID */
 832 void generate_uuid(uint8_t *buf) FAST_FUNC;
 833
 834 /* Last element is marked by mult == 0 */
 835 struct suffix_mult {
 836         char suffix[4];
 837         unsigned mult;
 838 };
 839 #include "xatonum.h"
 840 /* Specialized: */
 841
 842 /* Using xatoi() instead of naive atoi() is not always convenient -
 843  * in many places people want *non-negative* values, but store them
 844  * in signed int. Therefore we need this one:
 845  * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
 846  * It should really be named xatoi_nonnegative (since it allows 0),
 847  * but that would be too long.
 848  */
 849 int xatoi_positive(const char *numstr) FAST_FUNC;
 850
 851 /* Useful for reading port numbers */
 852 uint16_t xatou16(const char *numstr) FAST_FUNC;
 853
 854
 855 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
 856  * for BusyBox since we want to avoid using the glibc NSS stuff, which
 857  * increases target size and is often not needed on embedded systems.  */
 858 long xuname2uid(const char *name) FAST_FUNC;
 859 long xgroup2gid(const char *name) FAST_FUNC;
 860 /* wrapper: allows string to contain numeric uid or gid */
 861 unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
 862 /* from chpst. Does not die, returns 0 on failure */
 863 struct bb_uidgid_t {
 864         uid_t uid;
 865         gid_t gid;
 866 };
 867 /* always sets uid and gid */
 868 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
 869 /* always sets uid and gid, allows numeric; exits on failure */
 870 void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
 871 /* chown-like handling of "user[:[group]" */
 872 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
 873 struct passwd* xgetpwnam(const char *name) FAST_FUNC;
 874 struct group* xgetgrnam(const char *name) FAST_FUNC;
 875 struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
 876 struct group* xgetgrgid(gid_t gid) FAST_FUNC;
 877 char* xuid2uname(uid_t uid) FAST_FUNC;
 878 char* xgid2group(gid_t gid) FAST_FUNC;
 879 char* uid2uname(uid_t uid) FAST_FUNC;
 880 char* gid2group(gid_t gid) FAST_FUNC;
 881 char* uid2uname_utoa(uid_t uid) FAST_FUNC;
 882 char* gid2group_utoa(gid_t gid) FAST_FUNC;
 883 /* versions which cache results (useful for ps, ls etc) */
 884 const char* get_cached_username(uid_t uid) FAST_FUNC;
 885 const char* get_cached_groupname(gid_t gid) FAST_FUNC;
 886 void clear_username_cache(void) FAST_FUNC;
 887 /* internally usernames are saved in fixed-sized char[] buffers */
 888 enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
 889 #if ENABLE_FEATURE_CHECK_NAMES
 890 void die_if_bad_username(const char* name) FAST_FUNC;
 891 #else
 892 #define die_if_bad_username(name) ((void)(name))
 893 #endif
 894
 895 #if ENABLE_FEATURE_UTMP
 896 void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
 897 void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
 898 #else
 899 # define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
 900 # define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
 901 #endif
 902
 903
 904 int execable_file(const char *name) FAST_FUNC;
 905 char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
 906 int exists_execable(const char *filename) FAST_FUNC;
 907
 908 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
 909  * but it may exec busybox and call applet instead of searching PATH.
 910  */
 911 #if ENABLE_FEATURE_PREFER_APPLETS
 912 int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
 913 #define BB_EXECLP(prog,cmd,...) \
 914         do { \
 915                 if (find_applet_by_name(prog) >= 0) \
 916                         execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
 917                 execlp(prog, cmd, __VA_ARGS__); \
 918         } while (0)
 919 #else
 920 #define BB_EXECVP(prog,cmd)     execvp(prog,cmd)
 921 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
 922 #endif
 923 int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
 924
 925 /* xvfork() can't be a _function_, return after vfork mangles stack
 926  * in the parent. It must be a macro. */
 927 #define xvfork() \
 928 ({ \
 929         pid_t bb__xvfork_pid = vfork(); \
 930         if (bb__xvfork_pid < 0) \
 931                 bb_perror_msg_and_die("vfork"); \
 932         bb__xvfork_pid; \
 933 })
 934 #if BB_MMU
 935 pid_t xfork(void) FAST_FUNC;
 936 #endif
 937
 938 /* NOMMU friendy fork+exec: */
 939 pid_t spawn(char **argv) FAST_FUNC;
 940 pid_t xspawn(char **argv) FAST_FUNC;
 941
 942 pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
 943 pid_t wait_any_nohang(int *wstat) FAST_FUNC;
 944 /* wait4pid: unlike waitpid, waits ONLY for one process.
 945  * Returns sig + 0x180 if child is killed by signal.
 946  * It's safe to pass negative 'pids' from failed [v]fork -
 947  * wait4pid will return -1 (and will not clobber [v]fork's errno).
 948  * IOW: rc = wait4pid(spawn(argv));
 949  *      if (rc < 0) bb_perror_msg("%s", argv[0]);
 950  *      if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
 951  */
 952 int wait4pid(pid_t pid) FAST_FUNC;
 953 /* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
 954 int spawn_and_wait(char **argv) FAST_FUNC;
 955 /* Does NOT check that applet is NOFORK, just blindly runs it */
 956 int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
 957
 958 /* Helpers for daemonization.
 959  *
 960  * bb_daemonize(flags) = daemonize, does not compile on NOMMU
 961  *
 962  * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
 963  *      rexec's itself on NOMMU with argv passed as command line.
 964  * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
 965  * from the start. (It will detect it and not reexec again second time).
 966  * You have to audit carefully that you don't do something twice as a result
 967  * (opening files/sockets, parsing config files etc...)!
 968  *
 969  * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
 970  * (will do setsid()).
 971  *
 972  * fork_or_rexec(argv) = bare-bones fork on MMU,
 973  *      "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
 974  *      On MMU ignores argv.
 975  *
 976  * Helper for network daemons in foreground mode:
 977  *
 978  * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
 979  * to /dev/null if they are not.
 980  */
 981 enum {
 982         DAEMON_CHDIR_ROOT = 1,
 983         DAEMON_DEVNULL_STDIO = 2,
 984         DAEMON_CLOSE_EXTRA_FDS = 4,
 985         DAEMON_ONLY_SANITIZE = 8, /* internal use */
 986 };
 987 #if BB_MMU
 988   enum { re_execed = 0 };
 989 # define fork_or_rexec(argv)                xfork()
 990 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
 991 # define bb_daemonize(flags)                bb_daemonize_or_rexec(flags, bogus)
 992 #else
 993   extern bool re_execed;
 994   void re_exec(char **argv) NORETURN FAST_FUNC;
 995   pid_t fork_or_rexec(char **argv) FAST_FUNC;
 996   int  BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
 997   int  BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
 998   void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
 999 # define fork()          BUG_fork_is_unavailable_on_nommu()
1000 # define xfork()         BUG_fork_is_unavailable_on_nommu()
1001 # define daemon(a,b)     BUG_daemon_is_unavailable_on_nommu()
1002 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
1003 #endif
1004 void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1005 void bb_sanitize_stdio(void) FAST_FUNC;
1006 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
1007 int sanitize_env_if_suid(void) FAST_FUNC;
1008
1009
1010 char* single_argv(char **argv) FAST_FUNC;
1011 extern const char *const bb_argv_dash[]; /* "-", NULL */
1012 extern const char *opt_complementary;
1013 #if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
1014 #define No_argument "\0"
1015 #define Required_argument "\001"
1016 #define Optional_argument "\002"
1017 extern const char *applet_long_options;
1018 #endif
1019 extern uint32_t option_mask32;
1020 extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
1021
1022
1023 /* Having next pointer as a first member allows easy creation
1024  * of "llist-compatible" structs, and using llist_FOO functions
1025  * on them.
1026  */
1027 typedef struct llist_t {
1028         struct llist_t *link;
1029         char *data;
1030 } llist_t;
1031 void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1032 void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1033 void *llist_pop(llist_t **elm) FAST_FUNC;
1034 void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1035 void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1036 llist_t *llist_rev(llist_t *list) FAST_FUNC;
1037 llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
1038 /* BTW, surprisingly, changing API to
1039  *   llist_t *llist_add_to(llist_t *old_head, void *data)
1040  * etc does not result in smaller code... */
1041
1042 /* start_stop_daemon and udhcpc are special - they want
1043  * to create pidfiles regardless of FEATURE_PIDFILE */
1044 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
1045 /* True only if we created pidfile which is *file*, not /dev/null etc */
1046 extern smallint wrote_pidfile;
1047 void write_pidfile(const char *path) FAST_FUNC;
1048 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
1049 #else
1050 enum { wrote_pidfile = 0 };
1051 #define write_pidfile(path)  ((void)0)
1052 #define remove_pidfile(path) ((void)0)
1053 #endif
1054
1055 enum {
1056         LOGMODE_NONE = 0,
1057         LOGMODE_STDIO = (1 << 0),
1058         LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
1059         LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1060 };
1061 extern const char *msg_eol;
1062 extern smallint logmode;
1063 extern int die_sleep;
1064 extern uint8_t xfunc_error_retval;
1065 extern jmp_buf die_jmp;
1066 extern void xfunc_die(void) NORETURN FAST_FUNC;
1067 extern void bb_show_usage(void) NORETURN FAST_FUNC;
1068 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1069 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1070 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1071 extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1072 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1073 extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
1074 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1075 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1076 extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
1077 extern void bb_perror_nomsg(void) FAST_FUNC;
1078 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1079 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
1080
1081 /* We need to export XXX_main from libbusybox
1082  * only if we build "individual" binaries
1083  */
1084 #if ENABLE_FEATURE_INDIVIDUAL
1085 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1086 #else
1087 #define MAIN_EXTERNALLY_VISIBLE
1088 #endif
1089
1090
1091 /* Applets which are useful from another applets */
1092 int bb_cat(char** argv);
1093 /* If shell needs them, they exist even if not enabled as applets */
1094 int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1095 int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1096 int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1097 int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
1098 /* Similar, but used by chgrp, not shell */
1099 int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
1100 /* Used by ftpd */
1101 int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1102 /* Don't need IF_xxx() guard for these */
1103 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1104 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1105
1106 #if ENABLE_ROUTE
1107 void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
1108 #endif
1109
1110
1111 /* Networking */
1112 int create_icmp_socket(void) FAST_FUNC;
1113 int create_icmp6_socket(void) FAST_FUNC;
1114 /* interface.c */
1115 /* This structure defines protocol families and their handlers. */
1116 struct aftype {
1117         const char *name;
1118         const char *title;
1119         int af;
1120         int alen;
1121         char*       FAST_FUNC (*print)(unsigned char *);
1122         const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1123         int         FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1124         void        FAST_FUNC (*herror)(char *text);
1125         int         FAST_FUNC (*rprint)(int options);
1126         int         FAST_FUNC (*rinput)(int typ, int ext, char **argv);
1127         /* may modify src */
1128         int         FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
1129 };
1130 /* This structure defines hardware protocols and their handlers. */
1131 struct hwtype {
1132         const char *name;
1133         const char *title;
1134         int type;
1135         int alen;
1136         char* FAST_FUNC (*print)(unsigned char *);
1137         int   FAST_FUNC (*input)(const char *, struct sockaddr *);
1138         int   FAST_FUNC (*activate)(int fd);
1139         int suppress_null_addr;
1140 };
1141 extern smallint interface_opt_a;
1142 int display_interfaces(char *ifname) FAST_FUNC;
1143 #if ENABLE_FEATURE_HWIB
1144 int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1145 #else
1146 #define in_ib(a, b) 1 /* fail */
1147 #endif
1148 const struct aftype *get_aftype(const char *name) FAST_FUNC;
1149 const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1150 const struct hwtype *get_hwntype(int type) FAST_FUNC;
1151
1152
1153 #ifndef BUILD_INDIVIDUAL
1154 extern int find_applet_by_name(const char *name) FAST_FUNC;
1155 /* Returns only if applet is not found. */
1156 extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
1157 extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
1158 #endif
1159
1160 #ifdef HAVE_MNTENT_H
1161 extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
1162 extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
1163 #endif
1164 extern void erase_mtab(const char * name) FAST_FUNC;
1165 extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1166 extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1167 #if ENABLE_DESKTOP
1168 extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1169 #else
1170 # define bb_warn_ignoring_args(arg) ((void)0)
1171 #endif
1172
1173 extern int get_linux_version_code(void) FAST_FUNC;
1174
1175 extern char *query_loop(const char *device) FAST_FUNC;
1176 extern int del_loop(const char *device) FAST_FUNC;
1177 /* If *devname is not NULL, use that name, otherwise try to find free one,
1178  * malloc and return it in *devname.
1179  * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
1180 extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
1181
1182 /* Like bb_ask below, but asks on stdin with no timeout.  */
1183 char *bb_ask_stdin(const char * prompt) FAST_FUNC;
1184 //TODO: pass buf pointer or return allocated buf (avoid statics)?
1185 char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
1186 int bb_ask_confirmation(void) FAST_FUNC;
1187
1188 int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
1189
1190 /*
1191  * Config file parser
1192  */
1193 enum {
1194         PARSE_COLLAPSE  = 0x00010000, // treat consecutive delimiters as one
1195         PARSE_TRIM      = 0x00020000, // trim leading and trailing delimiters
1196 // TODO: COLLAPSE and TRIM seem to always go in pair
1197         PARSE_GREEDY    = 0x00040000, // last token takes entire remainder of the line
1198         PARSE_MIN_DIE   = 0x00100000, // die if < min tokens found
1199         // keep a copy of current line
1200         PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
1201 //      PARSE_ESCAPE    = 0x00400000, // process escape sequences in tokens
1202         // NORMAL is:
1203         // * remove leading and trailing delimiters and collapse
1204         //   multiple delimiters into one
1205         // * warn and continue if less than mintokens delimiters found
1206         // * grab everything into last token
1207         PARSE_NORMAL    = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
1208 };
1209 typedef struct parser_t {
1210         FILE *fp;
1211         char *data;
1212         char *line, *nline;
1213         size_t line_alloc, nline_alloc;
1214         int lineno;
1215 } parser_t;
1216 parser_t* config_open(const char *filename) FAST_FUNC;
1217 parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
1218 /* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
1219 int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1220 #define config_read(parser, tokens, max, min, str, flags) \
1221         config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1222 void config_close(parser_t *parser) FAST_FUNC;
1223
1224 /* Concatenate path and filename to new allocated buffer.
1225  * Add "/" only as needed (no duplicate "//" are produced).
1226  * If path is NULL, it is assumed to be "/".
1227  * filename should not be NULL. */
1228 char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1229 /* Returns NULL on . and .. */
1230 char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1231
1232
1233 int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1234
1235 int get_signum(const char *name) FAST_FUNC;
1236 const char *get_signame(int number) FAST_FUNC;
1237 void print_signames(void) FAST_FUNC;
1238
1239 char *bb_simplify_path(const char *path) FAST_FUNC;
1240 /* Returns ptr to NUL */
1241 char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
1242
1243 #define LOGIN_FAIL_DELAY 3
1244 extern void bb_do_delay(int seconds) FAST_FUNC;
1245 extern void change_identity(const struct passwd *pw) FAST_FUNC;
1246 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
1247
1248 /* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1249  * Note that getpwuid result might need xstrdup'ing
1250  * if there is a possibility of intervening getpwxxx() calls.
1251  */
1252 const char *get_shell_name(void);
1253
1254 #if ENABLE_SELINUX
1255 extern void renew_current_security_context(void) FAST_FUNC;
1256 extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1257 extern context_t set_security_context_component(security_context_t cur_context,
1258                                                 char *user, char *role, char *type, char *range) FAST_FUNC;
1259 extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1260 extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1261 #else
1262 #define selinux_preserve_fcontext(fdesc) ((void)0)
1263 #endif
1264 extern void selinux_or_die(void) FAST_FUNC;
1265
1266
1267 /* systemd support */
1268 #define SD_LISTEN_FDS_START 3
1269 int sd_listen_fds(void);
1270
1271
1272 /* setup_environment:
1273  * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
1274  * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1275  *   TERM=(old value)
1276  *   USER=pw->pw_name, LOGNAME=pw->pw_name
1277  *   PATH=bb_default_[root_]path
1278  *   HOME=pw->pw_dir
1279  *   SHELL=shell
1280  * else if change_env = 1:
1281  *   if not root (if pw->pw_uid != 0):
1282  *     USER=pw->pw_name, LOGNAME=pw->pw_name
1283  *   HOME=pw->pw_dir
1284  *   SHELL=shell
1285  * else does nothing
1286  */
1287 #define SETUP_ENV_CHANGEENV (1 << 0)
1288 #define SETUP_ENV_CLEARENV  (1 << 1)
1289 #define SETUP_ENV_TO_TMP    (1 << 2)
1290 extern void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1291 extern int correct_password(const struct passwd *pw) FAST_FUNC;
1292 /* Returns a malloced string */
1293 #if !ENABLE_USE_BB_CRYPT
1294 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1295 #endif
1296 extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1297 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1298 /*
1299  * rnd is additional random input. New one is returned.
1300  * Useful if you call crypt_make_salt many times in a row:
1301  * rnd = crypt_make_salt(buf1, 4, 0);
1302  * rnd = crypt_make_salt(buf2, 4, rnd);
1303  * rnd = crypt_make_salt(buf3, 4, rnd);
1304  * (otherwise we risk having same salt generated)
1305  */
1306 extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1307 /* "$N$" + sha_salt_16_bytes + NUL */
1308 #define MAX_PW_SALT_LEN (3 + 16 + 1)
1309 extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1310
1311
1312 /* Returns number of lines changed, or -1 on error */
1313 #if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1314 #define update_passwd(filename, username, data, member) \
1315         update_passwd(filename, username, data)
1316 #endif
1317 extern int update_passwd(const char *filename,
1318                 const char *username,
1319                 const char *data,
1320                 const char *member) FAST_FUNC;
1321
1322 int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1323 int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1324 int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1325 int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1326 const char *nth_string(const char *strings, int n) FAST_FUNC;
1327
1328 extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1329 extern void print_login_prompt(void) FAST_FUNC;
1330
1331 char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
1332 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1333 int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1334
1335 int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1336
1337 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1338 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1339 int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1340 #if ENABLE_IOCTL_HEX2STR_ERROR
1341 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1342 int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1343 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1344 #define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp,#request)
1345 #else
1346 int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1347 int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1348 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1349 #define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp)
1350 #endif
1351
1352 char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1353 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1354 void reset_ino_dev_hashtable(void) FAST_FUNC;
1355 #ifdef __GLIBC__
1356 /* At least glibc has horrendously large inline for this, so wrap it */
1357 unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
1358 #undef makedev
1359 #define makedev(a,b) bb_makedev(a,b)
1360 #endif
1361
1362
1363 /* "Keycodes" that report an escape sequence.
1364  * We use something which fits into signed char,
1365  * yet doesn't represent any valid Unicode character.
1366  * Also, -1 is reserved for error indication and we don't use it. */
1367 enum {
1368         KEYCODE_UP       =  -2,
1369         KEYCODE_DOWN     =  -3,
1370         KEYCODE_RIGHT    =  -4,
1371         KEYCODE_LEFT     =  -5,
1372         KEYCODE_HOME     =  -6,
1373         KEYCODE_END      =  -7,
1374         KEYCODE_INSERT   =  -8,
1375         KEYCODE_DELETE   =  -9,
1376         KEYCODE_PAGEUP   = -10,
1377         KEYCODE_PAGEDOWN = -11,
1378
1379         KEYCODE_CTRL_UP    = KEYCODE_UP    & ~0x40,
1380         KEYCODE_CTRL_DOWN  = KEYCODE_DOWN  & ~0x40,
1381         KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1382         KEYCODE_CTRL_LEFT  = KEYCODE_LEFT  & ~0x40,
1383 #if 0
1384         KEYCODE_FUN1     = -12,
1385         KEYCODE_FUN2     = -13,
1386         KEYCODE_FUN3     = -14,
1387         KEYCODE_FUN4     = -15,
1388         KEYCODE_FUN5     = -16,
1389         KEYCODE_FUN6     = -17,
1390         KEYCODE_FUN7     = -18,
1391         KEYCODE_FUN8     = -19,
1392         KEYCODE_FUN9     = -20,
1393         KEYCODE_FUN10    = -21,
1394         KEYCODE_FUN11    = -22,
1395         KEYCODE_FUN12    = -23,
1396 #endif
1397         KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
1398         /* How long is the longest ESC sequence we know?
1399          * We want it big enough to be able to contain
1400          * cursor position sequence "ESC [ 9999 ; 9999 R"
1401          */
1402         KEYCODE_BUFFER_SIZE = 16
1403 };
1404 /* Note: fd may be in blocking or non-blocking mode, both make sense.
1405  * For one, less uses non-blocking mode.
1406  * Only the first read syscall inside read_key may block indefinitely
1407  * (unless fd is in non-blocking mode),
1408  * subsequent reads will time out after a few milliseconds.
1409  * Return of -1 means EOF or error (errno == 0 on EOF).
1410  * buffer[0] is used as a counter of buffered chars and must be 0
1411  * on first call.
1412  * timeout:
1413  * -2: do not poll for input;
1414  * -1: poll(-1) (i.e. block);
1415  * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
1416  */
1417 int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
1418 void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
1419
1420
1421 #if ENABLE_FEATURE_EDITING
1422 /* It's NOT just ENABLEd or disabled. It's a number: */
1423 # if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
1424 #  define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1425 unsigned size_from_HISTFILESIZE(const char *hp);
1426 # else
1427 #  define MAX_HISTORY 0
1428 # endif
1429 typedef struct line_input_t {
1430         int flags;
1431         const char *path_lookup;
1432 # if MAX_HISTORY
1433         int cnt_history;
1434         int cur_history;
1435         int max_history; /* must never be <= 0 */
1436 #  if ENABLE_FEATURE_EDITING_SAVEHISTORY
1437         unsigned cnt_history_in_file;
1438         const char *hist_file;
1439 #  endif
1440         char *history[MAX_HISTORY + 1];
1441 # endif
1442 } line_input_t;
1443 enum {
1444         DO_HISTORY = 1 * (MAX_HISTORY > 0),
1445         SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1446         TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1447         USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1448         VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
1449         WITH_PATH_LOOKUP = 0x20,
1450         FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1451 };
1452 line_input_t *new_line_input_t(int flags) FAST_FUNC;
1453 /* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1454 /*
1455  * maxsize must be >= 2.
1456  * Returns:
1457  * -1 on read errors or EOF, or on bare Ctrl-D,
1458  * 0  on ctrl-C (the line entered is still returned in 'command'),
1459  * >0 length of input string, including terminating '\n'
1460  */
1461 int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize, int timeout) FAST_FUNC;
1462 #else
1463 #define MAX_HISTORY 0
1464 int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1465 #define read_line_input(state, prompt, command, maxsize, timeout) \
1466         read_line_input(prompt, command, maxsize)
1467 #endif
1468
1469
1470 #ifndef COMM_LEN
1471 # ifdef TASK_COMM_LEN
1472 enum { COMM_LEN = TASK_COMM_LEN };
1473 # else
1474 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1475 enum { COMM_LEN = 16 };
1476 # endif
1477 #endif
1478
1479 struct smaprec {
1480         unsigned long mapped_rw;
1481         unsigned long mapped_ro;
1482         unsigned long shared_clean;
1483         unsigned long shared_dirty;
1484         unsigned long private_clean;
1485         unsigned long private_dirty;
1486         unsigned long stack;
1487         unsigned long smap_pss, smap_swap;
1488         unsigned long smap_size;
1489         unsigned long smap_start;
1490         char smap_mode[5];
1491         char *smap_name;
1492 };
1493
1494 #if !ENABLE_PMAP
1495 #define procps_read_smaps(pid, total, cb, data) \
1496         procps_read_smaps(pid, total)
1497 #endif
1498 int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1499                       void (*cb)(struct smaprec *, void *), void *data);
1500
1501 typedef struct procps_status_t {
1502         DIR *dir;
1503         IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
1504         uint8_t shift_pages_to_bytes;
1505         uint8_t shift_pages_to_kb;
1506 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1507         uint16_t argv_len;
1508         char *argv0;
1509         char *exe;
1510         IF_SELINUX(char *context;)
1511         IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
1512         /* Everything below must contain no ptrs to malloc'ed data:
1513          * it is memset(0) for each process in procps_scan() */
1514         unsigned long vsz, rss; /* we round it to kbytes */
1515         unsigned long stime, utime;
1516         unsigned long start_time;
1517         unsigned pid;
1518         unsigned ppid;
1519         unsigned pgid;
1520         unsigned sid;
1521         unsigned uid;
1522         unsigned gid;
1523 #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1524         unsigned ruid;
1525         unsigned rgid;
1526         int niceness;
1527 #endif
1528         unsigned tty_major,tty_minor;
1529 #if ENABLE_FEATURE_TOPMEM
1530         struct smaprec smaps;
1531 #endif
1532         char state[4];
1533         /* basename of executable in exec(2), read from /proc/N/stat
1534          * (if executable is symlink or script, it is NOT replaced
1535          * by link target or interpreter name) */
1536         char comm[COMM_LEN];
1537         /* user/group? - use passwd/group parsing functions */
1538 #if ENABLE_FEATURE_TOP_SMP_PROCESS
1539         int last_seen_on_cpu;
1540 #endif
1541 } procps_status_t;
1542 /* flag bits for procps_scan(xx, flags) calls */
1543 enum {
1544         PSSCAN_PID      = 1 << 0,
1545         PSSCAN_PPID     = 1 << 1,
1546         PSSCAN_PGID     = 1 << 2,
1547         PSSCAN_SID      = 1 << 3,
1548         PSSCAN_UIDGID   = 1 << 4,
1549         PSSCAN_COMM     = 1 << 5,
1550         /* PSSCAN_CMD      = 1 << 6, - use read_cmdline instead */
1551         PSSCAN_ARGV0    = 1 << 7,
1552         PSSCAN_EXE      = 1 << 8,
1553         PSSCAN_STATE    = 1 << 9,
1554         PSSCAN_VSZ      = 1 << 10,
1555         PSSCAN_RSS      = 1 << 11,
1556         PSSCAN_STIME    = 1 << 12,
1557         PSSCAN_UTIME    = 1 << 13,
1558         PSSCAN_TTY      = 1 << 14,
1559         PSSCAN_SMAPS    = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1560         /* NB: used by find_pid_by_name(). Any applet using it
1561          * needs to be mentioned here. */
1562         PSSCAN_ARGVN    = (1 << 16) * (ENABLE_KILLALL
1563                                 || ENABLE_PGREP || ENABLE_PKILL
1564                                 || ENABLE_PIDOF
1565                                 || ENABLE_SESTATUS
1566                                 ),
1567         PSSCAN_CONTEXT  = (1 << 17) * ENABLE_SELINUX,
1568         PSSCAN_START_TIME = 1 << 18,
1569         PSSCAN_CPU      = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1570         PSSCAN_NICE     = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1571         PSSCAN_RUIDGID  = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1572         PSSCAN_TASKS    = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
1573 };
1574 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1575 void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1576 procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
1577 /* Format cmdline (up to col chars) into char buf[size] */
1578 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1579 void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
1580 pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1581 pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
1582 int starts_with_cpu(const char *str) FAST_FUNC;
1583 unsigned get_cpu_count(void) FAST_FUNC;
1584
1585
1586 extern const char bb_uuenc_tbl_base64[];
1587 extern const char bb_uuenc_tbl_std[];
1588 void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
1589 enum {
1590         BASE64_FLAG_UU_STOP = 0x100,
1591         /* Sign-extends to a value which never matches fgetc result: */
1592         BASE64_FLAG_NO_STOP_CHAR = 0x80,
1593 };
1594 void FAST_FUNC read_base64(FILE *src_stream, FILE *dst_stream, int flags);
1595
1596 typedef struct md5_ctx_t {
1597         uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1598         void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
1599         uint64_t total64;    /* must be directly before hash[] */
1600         uint32_t hash[8];    /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1601 } md5_ctx_t;
1602 typedef struct md5_ctx_t sha1_ctx_t;
1603 typedef struct md5_ctx_t sha256_ctx_t;
1604 typedef struct sha512_ctx_t {
1605         uint64_t total64[2];  /* must be directly before hash[] */
1606         uint64_t hash[8];
1607         uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
1608 } sha512_ctx_t;
1609 void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1610 void md5_hash(md5_ctx_t *ctx, const void *data, size_t length) FAST_FUNC;
1611 void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1612 void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1613 #define sha1_hash md5_hash
1614 void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1615 void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1616 #define sha256_hash md5_hash
1617 #define sha256_end  sha1_end
1618 void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1619 void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1620 void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
1621
1622 extern uint32_t *global_crc32_table;
1623 uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1624 uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1625 uint32_t crc32_block_endian0(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1626
1627 typedef struct masks_labels_t {
1628         const char *labels;
1629         const int masks[];
1630 } masks_labels_t;
1631 int print_flags_separated(const int *masks, const char *labels,
1632                 int flags, const char *separator) FAST_FUNC;
1633 int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
1634
1635 typedef struct bb_progress_t {
1636         unsigned last_size;
1637         unsigned last_update_sec;
1638         unsigned last_change_sec;
1639         unsigned start_sec;
1640         const char *curfile;
1641 } bb_progress_t;
1642
1643 #define is_bb_progress_inited(p) ((p)->curfile != NULL)
1644 #define bb_progress_free(p) do { \
1645         if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1646         (p)->curfile = NULL; \
1647 } while (0)
1648 void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
1649 void bb_progress_update(bb_progress_t *p,
1650                         uoff_t beg_range,
1651                         uoff_t transferred,
1652                         uoff_t totalsize) FAST_FUNC;
1653
1654
1655 extern const char *applet_name;
1656
1657 /* Some older linkers don't perform string merging, we used to have common strings
1658  * as global arrays to do it by hand. But:
1659  * (1) newer linkers do it themselves,
1660  * (2) however, they DONT merge string constants with global arrays,
1661  * even if the value is the same (!). Thus global arrays actually
1662  * increased size a bit: for example, "/etc/passwd" string from libc
1663  * wasn't merged with bb_path_passwd_file[] array!
1664  * Therefore now we use #defines.
1665  */
1666 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1667 extern const char bb_banner[];
1668 extern const char bb_msg_memory_exhausted[];
1669 extern const char bb_msg_invalid_date[];
1670 #define bb_msg_read_error "read error"
1671 #define bb_msg_write_error "write error"
1672 extern const char bb_msg_unknown[];
1673 extern const char bb_msg_can_not_create_raw_socket[];
1674 extern const char bb_msg_perm_denied_are_you_root[];
1675 extern const char bb_msg_you_must_be_root[];
1676 extern const char bb_msg_requires_arg[];
1677 extern const char bb_msg_invalid_arg[];
1678 extern const char bb_msg_standard_input[];
1679 extern const char bb_msg_standard_output[];
1680
1681 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1682 extern const char bb_hexdigits_upcase[];
1683
1684 extern const char bb_path_wtmp_file[];
1685
1686 /* Busybox mount uses either /proc/mounts or /etc/mtab to
1687  * get the list of currently mounted filesystems */
1688 #define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1689
1690 #define bb_path_passwd_file  _PATH_PASSWD
1691 #define bb_path_group_file   _PATH_GROUP
1692 #define bb_path_shadow_file  _PATH_SHADOW
1693 #define bb_path_gshadow_file _PATH_GSHADOW
1694
1695 #define bb_path_motd_file "/etc/motd"
1696
1697 #define bb_dev_null "/dev/null"
1698 extern const char bb_busybox_exec_path[];
1699 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1700  * but I want to save a few bytes here */
1701 extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1702 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1703 #define bb_default_path      (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1704
1705 extern const int const_int_0;
1706 extern const int const_int_1;
1707
1708
1709 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1710 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1711 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1712 /* This struct is deliberately not defined. */
1713 /* See docs/keep_data_small.txt */
1714 struct globals;
1715 /* '*const' ptr makes gcc optimize code much better.
1716  * Magic prevents ptr_to_globals from going into rodata.
1717  * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1718 extern struct globals *const ptr_to_globals;
1719 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1720 #define barrier() __asm__ __volatile__("":::"memory")
1721 #define SET_PTR_TO_GLOBALS(x) do { \
1722         (*(struct globals**)&ptr_to_globals) = (void*)(x); \
1723         barrier(); \
1724 } while (0)
1725
1726 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1727  * use bb_default_login_shell and following defines.
1728  * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1729  * don't forget to change increment constant. */
1730 #define LIBBB_DEFAULT_LOGIN_SHELL  "-/bin/sh"
1731 extern const char bb_default_login_shell[];
1732 /* "/bin/sh" */
1733 #define DEFAULT_SHELL              (bb_default_login_shell+1)
1734 /* "sh" */
1735 #define DEFAULT_SHELL_SHORT_NAME   (bb_default_login_shell+6)
1736
1737 /* The following devices are the same on all systems.  */
1738 #define CURRENT_TTY "/dev/tty"
1739 #define DEV_CONSOLE "/dev/console"
1740
1741 #if defined(__FreeBSD_kernel__)
1742 # define CURRENT_VC CURRENT_TTY
1743 # define VC_1 "/dev/ttyv0"
1744 # define VC_2 "/dev/ttyv1"
1745 # define VC_3 "/dev/ttyv2"
1746 # define VC_4 "/dev/ttyv3"
1747 # define VC_5 "/dev/ttyv4"
1748 # define VC_FORMAT "/dev/ttyv%d"
1749 #elif defined(__GNU__)
1750 # define CURRENT_VC CURRENT_TTY
1751 # define VC_1 "/dev/tty1"
1752 # define VC_2 "/dev/tty2"
1753 # define VC_3 "/dev/tty3"
1754 # define VC_4 "/dev/tty4"
1755 # define VC_5 "/dev/tty5"
1756 # define VC_FORMAT "/dev/tty%d"
1757 #elif ENABLE_FEATURE_DEVFS
1758 /*Linux, obsolete devfs names */
1759 # define CURRENT_VC "/dev/vc/0"
1760 # define VC_1 "/dev/vc/1"
1761 # define VC_2 "/dev/vc/2"
1762 # define VC_3 "/dev/vc/3"
1763 # define VC_4 "/dev/vc/4"
1764 # define VC_5 "/dev/vc/5"
1765 # define VC_FORMAT "/dev/vc/%d"
1766 # define LOOP_FORMAT "/dev/loop/%d"
1767 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1768 # define LOOP_NAME "/dev/loop/"
1769 # define FB_0 "/dev/fb/0"
1770 #else
1771 /*Linux, normal names */
1772 # define CURRENT_VC "/dev/tty0"
1773 # define VC_1 "/dev/tty1"
1774 # define VC_2 "/dev/tty2"
1775 # define VC_3 "/dev/tty3"
1776 # define VC_4 "/dev/tty4"
1777 # define VC_5 "/dev/tty5"
1778 # define VC_FORMAT "/dev/tty%d"
1779 # define LOOP_FORMAT "/dev/loop%d"
1780 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1781 # define LOOP_NAME "/dev/loop"
1782 # define FB_0 "/dev/fb0"
1783 #endif
1784
1785
1786 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1787
1788
1789 /* We redefine ctype macros. Unicode-correct handling of char types
1790  * can't be done with such byte-oriented operations anyway,
1791  * we don't lose anything.
1792  */
1793 #undef isalnum
1794 #undef isalpha
1795 #undef isascii
1796 #undef isblank
1797 #undef iscntrl
1798 #undef isdigit
1799 #undef isgraph
1800 #undef islower
1801 #undef isprint
1802 #undef ispunct
1803 #undef isspace
1804 #undef isupper
1805 #undef isxdigit
1806 #undef toupper
1807 #undef tolower
1808
1809 /* We save ~500 bytes on isdigit alone.
1810  * BTW, x86 likes (unsigned char) cast more than (unsigned). */
1811
1812 /* These work the same for ASCII and Unicode,
1813  * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
1814 #define isascii(a) ((unsigned char)(a) <= 0x7f)
1815 #define isdigit(a) ((unsigned char)((a) - '0') <= 9)
1816 #define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1817 #define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
1818 #define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
1819 #define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1820 #define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
1821 /* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
1822  * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
1823  */
1824 #define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
1825 // Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1826 #define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1827 // Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
1828 #define isalnum(a) bb_ascii_isalnum(a)
1829 static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1830 {
1831         unsigned char b = a - '0';
1832         if (b <= 9)
1833                 return (b <= 9);
1834         b = (a|0x20) - 'a';
1835         return b <= 'z' - 'a';
1836 }
1837 #define isxdigit(a) bb_ascii_isxdigit(a)
1838 static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1839 {
1840         unsigned char b = a - '0';
1841         if (b <= 9)
1842                 return (b <= 9);
1843         b = (a|0x20) - 'a';
1844         return b <= 'f' - 'a';
1845 }
1846 #define toupper(a) bb_ascii_toupper(a)
1847 static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1848 {
1849         unsigned char b = a - 'a';
1850         if (b <= ('z' - 'a'))
1851                 a -= 'a' - 'A';
1852         return a;
1853 }
1854 #define tolower(a) bb_ascii_tolower(a)
1855 static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1856 {
1857         unsigned char b = a - 'A';
1858         if (b <= ('Z' - 'A'))
1859                 a += 'a' - 'A';
1860         return a;
1861 }
1862
1863 /* In ASCII and Unicode, these are likely to be very different.
1864  * Let's prevent ambiguous usage from the start */
1865 #define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1866 #define isprint(a) isprint_is_ambiguous_dont_use(a)
1867 /* NB: must not treat EOF as isgraph or isprint */
1868 #define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1869 #define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1870
1871
1872 POP_SAVED_FUNCTION_VISIBILITY
1873
1874 #endif