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