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