nologin: make it possible to build it as single applet
[oweals/busybox.git] / 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 #include <paths.h>
24 #if defined __UCLIBC__ /* TODO: and glibc? */
25 /* use inlined versions of these: */
26 # define sigfillset(s)    __sigfillset(s)
27 # define sigemptyset(s)   __sigemptyset(s)
28 # define sigisemptyset(s) __sigisemptyset(s)
29 #endif
30 #include <stdint.h>
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <stdarg.h>
34 #include <stddef.h>
35 #include <string.h>
36 /* There are two incompatible basename's, let's not use them! */
37 /* See the dirname/basename man page for details */
38 #include <libgen.h> /* dirname,basename */
39 #undef basename
40 #define basename dont_use_basename
41 #include <poll.h>
42 #include <sys/ioctl.h>
43 #include <sys/mman.h>
44 #include <sys/resource.h>
45 #include <sys/socket.h>
46 #include <sys/stat.h>
47 #include <sys/time.h>
48 #include <sys/types.h>
49 #if !defined(major) || defined(__GLIBC__)
50 # include <sys/sysmacros.h>
51 #endif
52 #include <sys/wait.h>
53 #include <termios.h>
54 #include <time.h>
55 #include <sys/param.h>
56 #include <pwd.h>
57 #include <grp.h>
58 #if ENABLE_FEATURE_SHADOWPASSWDS
59 # if !ENABLE_USE_BB_SHADOW
60 /* If using busybox's shadow implementation, do not include the shadow.h
61  * header as the toolchain may not provide it at all.
62  */
63 #  include <shadow.h>
64 # endif
65 #endif
66 #if defined(ANDROID) || defined(__ANDROID__)
67 # define endpwent() ((void)0)
68 # define endgrent() ((void)0)
69 #endif
70 #ifdef HAVE_MNTENT_H
71 # include <mntent.h>
72 #endif
73 #ifdef HAVE_SYS_STATFS_H
74 # include <sys/statfs.h>
75 #endif
76 /* Don't do this here:
77  * #include <sys/sysinfo.h>
78  * Some linux/ includes pull in conflicting definition
79  * of struct sysinfo (only in some toolchanins), which breaks build.
80  * Include sys/sysinfo.h only in those files which need it.
81  */
82 #if ENABLE_SELINUX
83 # include <selinux/selinux.h>
84 # include <selinux/context.h>
85 #endif
86 #if ENABLE_FEATURE_UTMP
87 # if defined __UCLIBC__ && ( \
88     (UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 32) \
89      && UCLIBC_VERSION < KERNEL_VERSION(0, 9, 34) \
90      && defined __UCLIBC_HAS_UTMPX__ \
91     ) || ( \
92          UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 34) \
93         ) \
94   )
95 #  include <utmpx.h>
96 # elif defined __UCLIBC__
97 #  include <utmp.h>
98 #  define utmpx utmp
99 #  define setutxent setutent
100 #  define endutxent endutent
101 #  define getutxent getutent
102 #  define getutxid getutid
103 #  define getutxline getutline
104 #  define pututxline pututline
105 #  define utmpxname utmpname
106 #  define updwtmpx updwtmp
107 #  define _PATH_UTMPX _PATH_UTMP
108 # else
109 #  include <utmp.h>
110 #  include <utmpx.h>
111 #  if defined _PATH_UTMP && !defined _PATH_UTMPX
112 #   define _PATH_UTMPX _PATH_UTMP
113 #  endif
114 # endif
115 #endif
116 #if ENABLE_LOCALE_SUPPORT
117 # include <locale.h>
118 #else
119 # define setlocale(x,y) ((void)0)
120 #endif
121 #ifdef DMALLOC
122 # include <dmalloc.h>
123 #endif
124 /* Just in case libc doesn't define some of these... */
125 #ifndef _PATH_PASSWD
126 #define _PATH_PASSWD  "/etc/passwd"
127 #endif
128 #ifndef _PATH_GROUP
129 #define _PATH_GROUP   "/etc/group"
130 #endif
131 #ifndef _PATH_SHADOW
132 #define _PATH_SHADOW  "/etc/shadow"
133 #endif
134 #ifndef _PATH_GSHADOW
135 #define _PATH_GSHADOW "/etc/gshadow"
136 #endif
137 #if defined __FreeBSD__ || defined __OpenBSD__
138 # include <netinet/in.h>
139 # include <arpa/inet.h>
140 #elif defined __APPLE__
141 # include <netinet/in.h>
142 #else
143 # include <arpa/inet.h>
144 //This breaks on bionic:
145 //# if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
146 ///* We #define socklen_t *after* includes, otherwise we get
147 // * typedef redefinition errors from system headers
148 // * (in case "is it defined already" detection above failed)
149 // */
150 //#  define socklen_t bb_socklen_t
151 //   typedef unsigned socklen_t;
152 //# endif
153 //if this is still needed, add a fix along the lines of
154 //  ifdef SPECIFIC_BROKEN_LIBC_CHECK / typedef socklen_t / endif
155 //in platform.h instead!
156 #endif
157 #ifndef HAVE_CLEARENV
158 # define clearenv() do { if (environ) environ[0] = NULL; } while (0)
159 #endif
160 #ifndef HAVE_FDATASYNC
161 # define fdatasync fsync
162 #endif
163 #ifndef HAVE_XTABS
164 # define XTABS TAB3
165 #endif
166 /*
167  * Use '%m' to append error string on platforms that support it,
168  * '%s' and strerror() on those that don't.
169  */
170 #ifdef HAVE_PRINTF_PERCENTM
171 # define STRERROR_FMT    "%m"
172 # define STRERROR_ERRNO  /*nothing*/
173 #else
174 # define STRERROR_FMT    "%s"
175 # define STRERROR_ERRNO  ,strerror(errno)
176 #endif
177
178
179 /* Some libc's forget to declare these, do it ourself */
180
181 extern char **environ;
182 /* klogctl is in libc's klog.h, but we cheat and not #include that */
183 int klogctl(int type, char *b, int len);
184 #ifndef PATH_MAX
185 # define PATH_MAX 256
186 #endif
187 #ifndef BUFSIZ
188 # define BUFSIZ 4096
189 #endif
190
191
192 /* Busybox does not use threads, we can speed up stdio. */
193 #ifdef HAVE_UNLOCKED_STDIO
194 # undef  getc
195 # define getc(stream)   getc_unlocked(stream)
196 # undef  getchar
197 # define getchar()      getchar_unlocked()
198 # undef  putc
199 # define putc(c,stream) putc_unlocked(c,stream)
200 # undef  putchar
201 # define putchar(c)     putchar_unlocked(c)
202 # undef  fgetc
203 # define fgetc(stream)  getc_unlocked(stream)
204 # undef  fputc
205 # define fputc(c,stream) putc_unlocked(c,stream)
206 #endif
207 /* Above functions are required by POSIX.1-2008, below ones are extensions */
208 #ifdef HAVE_UNLOCKED_LINE_OPS
209 # undef  fgets
210 # define fgets(s,n,stream) fgets_unlocked(s,n,stream)
211 # undef  fputs
212 # define fputs(s,stream) fputs_unlocked(s,stream)
213 /* musl <= 1.1.15 does not support fflush_unlocked(NULL) */
214 //# undef  fflush
215 //# define fflush(stream) fflush_unlocked(stream)
216 # undef  feof
217 # define feof(stream)   feof_unlocked(stream)
218 # undef  ferror
219 # define ferror(stream) ferror_unlocked(stream)
220 # undef  fileno
221 # define fileno(stream) fileno_unlocked(stream)
222 #endif
223
224
225 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
226 /* (don't include system headers after this until corresponding pop!) */
227 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
228
229
230 #if ENABLE_USE_BB_PWD_GRP
231 # include "pwd_.h"
232 # include "grp_.h"
233 #endif
234 #if ENABLE_FEATURE_SHADOWPASSWDS
235 # if ENABLE_USE_BB_SHADOW
236 #  include "shadow_.h"
237 # endif
238 #endif
239
240 /* Tested to work correctly with all int types (IIRC :]) */
241 #define MAXINT(T) (T)( \
242         ((T)-1) > 0 \
243         ? (T)-1 \
244         : (T)~((T)1 << (sizeof(T)*8-1)) \
245         )
246
247 #define MININT(T) (T)( \
248         ((T)-1) > 0 \
249         ? (T)0 \
250         : ((T)1 << (sizeof(T)*8-1)) \
251         )
252
253 /* Large file support */
254 /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
255  * (stat, lseek etc) mapped to "largefile" variants by libc.
256  * Practically it means that open() automatically has O_LARGEFILE added
257  * and all filesize/file_offset parameters and struct members are "large"
258  * (in today's world - signed 64bit). For full support of large files,
259  * we need a few helper #defines (below) and careful use of off_t
260  * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
261 #if ENABLE_LFS
262 /* CONFIG_LFS is on */
263 # if ULONG_MAX > 0xffffffff
264 /* "long" is long enough on this system */
265 typedef unsigned long uoff_t;
266 #  define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
267 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
268 #  define BB_STRTOOFF bb_strtoul
269 #  define STRTOOFF strtoul
270 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
271 #  define OFF_FMT "l"
272 # else
273 /* "long" is too short, need "long long" */
274 typedef unsigned long long uoff_t;
275 #  define XATOOFF(a) xatoull_range((a), 0, LLONG_MAX)
276 #  define BB_STRTOOFF bb_strtoull
277 #  define STRTOOFF strtoull
278 #  define OFF_FMT "ll"
279 # endif
280 #else
281 /* CONFIG_LFS is off */
282 # if UINT_MAX == 0xffffffff
283 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
284  * gcc will throw warnings on printf("%d", off_t). Crap... */
285 typedef unsigned long uoff_t;
286 #  define XATOOFF(a) xatoi_positive(a)
287 #  define BB_STRTOOFF bb_strtou
288 #  define STRTOOFF strtol
289 #  define OFF_FMT "l"
290 # else
291 typedef unsigned long uoff_t;
292 #  define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
293 #  define BB_STRTOOFF bb_strtoul
294 #  define STRTOOFF strtol
295 #  define OFF_FMT "l"
296 # endif
297 #endif
298 /* scary. better ideas? (but do *test* them first!) */
299 #define OFF_T_MAX  ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
300 /* Users report bionic to use 32-bit off_t even if LARGEFILE support is requested.
301  * On musl, !ENABLE_LFS on 32-bit arches thinks that off_t is 32-bit.
302  * We misdetected that. Don't let it build:
303  */
304 struct BUG_off_t_size_is_misdetected {
305         char BUG_off_t_size_is_misdetected[sizeof(off_t) == sizeof(uoff_t) ? 1 : -1];
306 };
307
308 /* Some useful definitions */
309 #undef FALSE
310 #define FALSE   ((int) 0)
311 #undef TRUE
312 #define TRUE    ((int) 1)
313 #undef SKIP
314 #define SKIP    ((int) 2)
315
316 /* Macros for min/max.  */
317 #ifndef MIN
318 #define MIN(a,b) (((a)<(b))?(a):(b))
319 #endif
320
321 #ifndef MAX
322 #define MAX(a,b) (((a)>(b))?(a):(b))
323 #endif
324
325 /* buffer allocation schemes */
326 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
327 #define RESERVE_CONFIG_BUFFER(buffer,len)  char buffer[len]
328 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
329 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
330 #else
331 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
332 #define RESERVE_CONFIG_BUFFER(buffer,len)  static          char buffer[len]
333 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
334 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
335 #else
336 #define RESERVE_CONFIG_BUFFER(buffer,len)  char *buffer = xmalloc(len)
337 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
338 #define RELEASE_CONFIG_BUFFER(buffer)      free(buffer)
339 #endif
340 #endif
341
342 #if defined(__GLIBC__)
343 /* glibc uses __errno_location() to get a ptr to errno */
344 /* We can just memorize it once - no multithreading in busybox :) */
345 extern int *const bb_errno;
346 #undef errno
347 #define errno (*bb_errno)
348 #endif
349
350 #if !(ULONG_MAX > 0xffffffff)
351 /* Only 32-bit CPUs need this, 64-bit ones use inlined version */
352 uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
353 #endif
354
355 unsigned long FAST_FUNC isqrt(unsigned long long N);
356
357 unsigned long long monotonic_ns(void) FAST_FUNC;
358 unsigned long long monotonic_us(void) FAST_FUNC;
359 unsigned long long monotonic_ms(void) FAST_FUNC;
360 unsigned monotonic_sec(void) FAST_FUNC;
361
362 extern void chomp(char *s) FAST_FUNC;
363 extern char *trim(char *s) FAST_FUNC;
364 extern char *skip_whitespace(const char *) FAST_FUNC;
365 extern char *skip_non_whitespace(const char *) FAST_FUNC;
366 extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
367
368 extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
369
370 /* dmalloc will redefine these to it's own implementation. It is safe
371  * to have the prototypes here unconditionally.  */
372 void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
373 void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
374 void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
375 void *xrealloc(void *old, size_t size) FAST_FUNC;
376 /* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
377  * at least v[idx] and v[idx+1], for all idx values.
378  * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
379  * when all elements are used up. New elements are zeroed out.
380  * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
381  * skipping an index is a bad bug - it may miss a realloc!
382  */
383 #define xrealloc_vector(vector, shift, idx) \
384         xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
385 void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
386 char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
387 char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
388 void *xmemdup(const void *s, int n) FAST_FUNC RETURNS_MALLOC;
389
390
391 //TODO: supply a pointer to char[11] buffer (avoid statics)?
392 extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
393 extern int is_directory(const char *name, int followLinks) FAST_FUNC;
394 enum {  /* cp.c, mv.c, install.c depend on these values. CAREFUL when changing them! */
395         FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
396         FILEUTILS_DEREFERENCE     = 1 << 1, /* !-d */
397         FILEUTILS_RECUR           = 1 << 2, /* -R */
398         FILEUTILS_FORCE           = 1 << 3, /* -f */
399         FILEUTILS_INTERACTIVE     = 1 << 4, /* -i */
400         FILEUTILS_MAKE_HARDLINK   = 1 << 5, /* -l */
401         FILEUTILS_MAKE_SOFTLINK   = 1 << 6, /* -s */
402         FILEUTILS_DEREF_SOFTLINK  = 1 << 7, /* -L */
403         FILEUTILS_DEREFERENCE_L0  = 1 << 8, /* -H */
404         /* -a = -pdR (mapped in cp.c) */
405         /* -r = -dR  (mapped in cp.c) */
406         /* -P = -d   (mapped in cp.c) */
407         FILEUTILS_VERBOSE         = (1 << 12) * ENABLE_FEATURE_VERBOSE, /* -v */
408         FILEUTILS_UPDATE          = 1 << 13, /* -u */
409         FILEUTILS_NO_TARGET_DIR   = 1 << 14, /* -T */
410 #if ENABLE_SELINUX
411         FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 15, /* -c */
412 #endif
413         FILEUTILS_RMDEST          = 1 << (16 - !ENABLE_SELINUX), /* --remove-destination */
414         /* bit 17 skipped for "cp --parents" */
415         FILEUTILS_REFLINK         = 1 << (18 - !ENABLE_SELINUX), /* cp --reflink=auto */
416         FILEUTILS_REFLINK_ALWAYS  = 1 << (19 - !ENABLE_SELINUX), /* cp --reflink[=always] */
417         /*
418          * Hole. cp may have some bits set here,
419          * they should not affect remove_file()/copy_file()
420          */
421 #if ENABLE_SELINUX
422         FILEUTILS_SET_SECURITY_CONTEXT = 1 << 30,
423 #endif
424         FILEUTILS_IGNORE_CHMOD_ERR = 1 << 31,
425 };
426 #define FILEUTILS_CP_OPTSTR "pdRfilsLHarPvuT" IF_SELINUX("c")
427 extern int remove_file(const char *path, int flags) FAST_FUNC;
428 /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
429  * the source, not copy (unless "source" is a directory).
430  * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
431  * work coreutils-compatibly. */
432 extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
433
434 enum {
435         ACTION_RECURSE        = (1 << 0),
436         ACTION_FOLLOWLINKS    = (1 << 1),
437         ACTION_FOLLOWLINKS_L0 = (1 << 2),
438         ACTION_DEPTHFIRST     = (1 << 3),
439         /*ACTION_REVERSE      = (1 << 4), - unused */
440         ACTION_QUIET          = (1 << 5),
441         ACTION_DANGLING_OK    = (1 << 6),
442 };
443 typedef uint8_t recurse_flags_t;
444 extern int recursive_action(const char *fileName, unsigned flags,
445         int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
446         int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
447         void* userData, unsigned depth) FAST_FUNC;
448 extern int device_open(const char *device, int mode) FAST_FUNC;
449 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
450 extern int xgetpty(char *line) FAST_FUNC;
451 extern int get_console_fd_or_die(void) FAST_FUNC;
452 extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
453 extern char *find_block_device(const char *path) FAST_FUNC;
454 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
455 extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
456 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
457 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
458 /* "short" copy can be detected by return value < size */
459 /* this helper yells "short read!" if param is not -1 */
460 extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
461
462 extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
463 char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
464 /* xxxx_strip version can modify its parameter:
465  * "/"        -> "/"
466  * "abc"      -> "abc"
467  * "abc/def"  -> "def"
468  * "abc/def/" -> "def" !!
469  */
470 char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
471 /* "abc/def/" -> "" and it never modifies 'path' */
472 char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
473 /* Simpler version: does not special case "/" string */
474 const char *bb_basename(const char *name) FAST_FUNC;
475 /* NB: can violate const-ness (similarly to strchr) */
476 char *last_char_is(const char *s, int c) FAST_FUNC;
477 const char* endofname(const char *name) FAST_FUNC;
478 char *is_prefixed_with(const char *string, const char *key) FAST_FUNC;
479 char *is_suffixed_with(const char *string, const char *key) FAST_FUNC;
480
481 int ndelay_on(int fd) FAST_FUNC;
482 int ndelay_off(int fd) FAST_FUNC;
483 void close_on_exec_on(int fd) FAST_FUNC;
484 void xdup2(int, int) FAST_FUNC;
485 void xmove_fd(int, int) FAST_FUNC;
486
487
488 DIR *xopendir(const char *path) FAST_FUNC;
489 DIR *warn_opendir(const char *path) FAST_FUNC;
490
491 char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
492 char *xmalloc_realpath_coreutils(const char *path) FAST_FUNC RETURNS_MALLOC;
493 char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
494 char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
495 /* !RETURNS_MALLOC: it's a realloc-like function */
496 char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
497
498 char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
499
500
501 enum {
502         /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
503          * otherwise would kill us, except for those resulting from bugs:
504          * SIGSEGV, SIGILL, SIGFPE.
505          * Other fatal signals not included (TODO?):
506          * SIGBUS   Bus error (bad memory access)
507          * SIGPOLL  Pollable event. Synonym of SIGIO
508          * SIGPROF  Profiling timer expired
509          * SIGSYS   Bad argument to routine
510          * SIGTRAP  Trace/breakpoint trap
511          *
512          * The only known arch with some of these sigs not fitting
513          * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
514          * Dance around with long long to guard against that...
515          */
516         BB_FATAL_SIGS = (int)(0
517                 + (1LL << SIGHUP)
518                 + (1LL << SIGINT)
519                 + (1LL << SIGTERM)
520                 + (1LL << SIGPIPE)   // Write to pipe with no readers
521                 + (1LL << SIGQUIT)   // Quit from keyboard
522                 + (1LL << SIGABRT)   // Abort signal from abort(3)
523                 + (1LL << SIGALRM)   // Timer signal from alarm(2)
524                 + (1LL << SIGVTALRM) // Virtual alarm clock
525                 + (1LL << SIGXCPU)   // CPU time limit exceeded
526                 + (1LL << SIGXFSZ)   // File size limit exceeded
527                 + (1LL << SIGUSR1)   // Yes kids, these are also fatal!
528                 + (1LL << SIGUSR2)
529                 + 0),
530 };
531 void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
532 /* Unlike signal() and bb_signals, sets handler with sigaction()
533  * and in a way that while signal handler is run, no other signals
534  * will be blocked; syscalls will not be restarted: */
535 void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
536 /* syscalls like read() will be interrupted with EINTR: */
537 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
538 /* syscalls like read() won't be interrupted (though select/poll will be): */
539 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
540 void wait_for_any_sig(void) FAST_FUNC;
541 void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
542 void sig_block(int sig) FAST_FUNC;
543 void sig_unblock(int sig) FAST_FUNC;
544 /* Will do sigaction(signum, act, NULL): */
545 int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
546 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
547 int sigprocmask_allsigs(int how) FAST_FUNC;
548 /* Return old set in the same set: */
549 int sigprocmask2(int how, sigset_t *set) FAST_FUNC;
550 /* Standard handler which just records signo */
551 extern smallint bb_got_signal;
552 void record_signo(int signo); /* not FAST_FUNC! */
553
554
555 void xsetgid(gid_t gid) FAST_FUNC;
556 void xsetuid(uid_t uid) FAST_FUNC;
557 void xsetegid(gid_t egid) FAST_FUNC;
558 void xseteuid(uid_t euid) FAST_FUNC;
559 void xchdir(const char *path) FAST_FUNC;
560 void xfchdir(int fd) FAST_FUNC;
561 void xchroot(const char *path) FAST_FUNC;
562 void xsetenv(const char *key, const char *value) FAST_FUNC;
563 void bb_unsetenv(const char *key) FAST_FUNC;
564 void bb_unsetenv_and_free(char *key) FAST_FUNC;
565 void xunlink(const char *pathname) FAST_FUNC;
566 void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
567 void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
568 int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
569 int open_or_warn(const char *pathname, int flags) FAST_FUNC;
570 int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
571 int xopen(const char *pathname, int flags) FAST_FUNC;
572 int xopen_nonblocking(const char *pathname) FAST_FUNC;
573 int xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g) FAST_FUNC;
574 int open_or_warn_stdin(const char *pathname) FAST_FUNC;
575 int xopen_stdin(const char *pathname) FAST_FUNC;
576 void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
577 int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
578 off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
579 int xmkstemp(char *template) FAST_FUNC;
580 off_t fdlength(int fd) FAST_FUNC;
581
582 uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
583                 const char *override,
584                 unsigned override_units,
585                 int extend);
586
587 void xpipe(int filedes[2]) FAST_FUNC;
588 /* In this form code with pipes is much more readable */
589 struct fd_pair { int rd; int wr; };
590 #define piped_pair(pair)  pipe(&((pair).rd))
591 #define xpiped_pair(pair) xpipe(&((pair).rd))
592
593 /* Useful for having small structure members/global variables */
594 typedef int8_t socktype_t;
595 typedef int8_t family_t;
596 struct BUG_too_small {
597         char BUG_socktype_t_too_small[(0
598                         | SOCK_STREAM
599                         | SOCK_DGRAM
600                         | SOCK_RDM
601                         | SOCK_SEQPACKET
602                         | SOCK_RAW
603                         ) <= 127 ? 1 : -1];
604         char BUG_family_t_too_small[(0
605                         | AF_UNSPEC
606                         | AF_INET
607                         | AF_INET6
608                         | AF_UNIX
609 #ifdef AF_PACKET
610                         | AF_PACKET
611 #endif
612 #ifdef AF_NETLINK
613                         | AF_NETLINK
614 #endif
615                         /* | AF_DECnet */
616                         /* | AF_IPX */
617                         ) <= 127 ? 1 : -1];
618 };
619
620
621 void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
622 time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
623 char *strftime_HHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
624 char *strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
625
626 int xsocket(int domain, int type, int protocol) FAST_FUNC;
627 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
628 void xlisten(int s, int backlog) FAST_FUNC;
629 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
630 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
631                                 socklen_t tolen) FAST_FUNC;
632
633 int setsockopt_int(int fd, int level, int optname, int optval) FAST_FUNC;
634 int setsockopt_1(int fd, int level, int optname) FAST_FUNC;
635 int setsockopt_SOL_SOCKET_int(int fd, int optname, int optval) FAST_FUNC;
636 int setsockopt_SOL_SOCKET_1(int fd, int optname) FAST_FUNC;
637 /* SO_REUSEADDR allows a server to rebind to an address that is already
638  * "in use" by old connections to e.g. previous server instance which is
639  * killed or crashed. Without it bind will fail until all such connections
640  * time out. Linux does not allow multiple live binds on same ip:port
641  * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
642  * Turn it on before you call bind(). */
643 void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
644 int setsockopt_keepalive(int fd) FAST_FUNC;
645 int setsockopt_broadcast(int fd) FAST_FUNC;
646 int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
647 int bb_getsockname(int sockfd, void *addr, socklen_t addrlen) FAST_FUNC;
648 /* NB: returns port in host byte order */
649 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
650 #if ENABLE_FEATURE_ETC_SERVICES
651 # define bb_lookup_std_port(portstr, protocol, portnum) bb_lookup_port(portstr, protocol, portnum)
652 #else
653 # define bb_lookup_std_port(portstr, protocol, portnum) (portnum)
654 #endif
655 typedef struct len_and_sockaddr {
656         socklen_t len;
657         union {
658                 struct sockaddr sa;
659                 struct sockaddr_in sin;
660 #if ENABLE_FEATURE_IPV6
661                 struct sockaddr_in6 sin6;
662 #endif
663         } u;
664 } len_and_sockaddr;
665 enum {
666         LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
667         LSA_SIZEOF_SA = sizeof(
668                 union {
669                         struct sockaddr sa;
670                         struct sockaddr_in sin;
671 #if ENABLE_FEATURE_IPV6
672                         struct sockaddr_in6 sin6;
673 #endif
674                 }
675         )
676 };
677 /* Create stream socket, and allocate suitable lsa.
678  * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
679  * af == AF_UNSPEC will result in trying to create IPv6 socket,
680  * and if kernel doesn't support it, fall back to IPv4.
681  * This is useful if you plan to bind to resulting local lsa.
682  */
683 int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
684 int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
685 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
686  * numeric IP ("N.N.N.N") or numeric IPv6 address,
687  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
688  * Only if there is no suffix, port argument is used */
689 /* NB: these set SO_REUSEADDR before bind */
690 int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
691 int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
692 int create_and_bind_to_netlink(int proto, int grp, unsigned rcvbuf) FAST_FUNC;
693 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
694  * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
695  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
696  * If there is no suffix, port argument is used */
697 int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
698 /* Connect to peer identified by lsa */
699 int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
700 /* Get local address of bound or accepted socket */
701 len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
702 /* Get remote address of connected or accepted socket */
703 len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
704 /* Return malloc'ed len_and_sockaddr with socket address of host:port
705  * Currently will return IPv4 or IPv6 sockaddrs only
706  * (depending on host), but in theory nothing prevents e.g.
707  * UNIX socket address being returned, IPX sockaddr etc...
708  * On error does bb_error_msg and returns NULL */
709 len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
710 /* Version which dies on error */
711 len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
712 len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
713 /* Same, useful if you want to force family (e.g. IPv6) */
714 #if !ENABLE_FEATURE_IPV6
715 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
716 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
717 #else
718 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
719 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
720 #endif
721 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
722  * otherwise no-op. Useful for ftp.
723  * NB: does NOT do htons() internally, just direct assignment. */
724 void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
725 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
726 int get_nport(const struct sockaddr *sa) FAST_FUNC;
727 /* Reverse DNS. Returns NULL on failure. */
728 char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
729 /* This one doesn't append :PORTNUM */
730 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
731 /* This one also doesn't fall back to dotted IP (returns NULL) */
732 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
733 /* inet_[ap]ton on steroids */
734 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
735 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
736 // "old" (ipv4 only) API
737 // users: traceroute.c hostname.c - use _list_ of all IPs
738 struct hostent *xgethostbyname(const char *name) FAST_FUNC;
739 // Also mount.c and inetd.c are using gethostbyname(),
740 // + inet_common.c has additional IPv4-only stuff
741
742
743 struct tls_aes {
744         uint32_t key[60];
745         unsigned rounds;
746 };
747 #define TLS_MAX_MAC_SIZE 32
748 #define TLS_MAX_KEY_SIZE 32
749 #define TLS_MAX_IV_SIZE   4
750 struct tls_handshake_data; /* opaque */
751 typedef struct tls_state {
752         unsigned flags;
753
754         int ofd;
755         int ifd;
756
757         unsigned min_encrypted_len_on_read;
758         uint16_t cipher_id;
759         unsigned MAC_size;
760         unsigned key_size;
761         unsigned IV_size;
762
763         uint8_t *outbuf;
764         int     outbuf_size;
765
766         int     inbuf_size;
767         int     ofs_to_buffered;
768         int     buffered_size;
769         uint8_t *inbuf;
770
771         struct tls_handshake_data *hsd;
772
773         // RFC 5246
774         // sequence number
775         //   Each connection state contains a sequence number, which is
776         //   maintained separately for read and write states.  The sequence
777         //   number MUST be set to zero whenever a connection state is made the
778         //   active state.  Sequence numbers are of type uint64 and may not
779         //   exceed 2^64-1.
780         /*uint64_t read_seq64_be;*/
781         uint64_t write_seq64_be;
782
783         /*uint8_t *server_write_MAC_key;*/
784         uint8_t *client_write_key;
785         uint8_t *server_write_key;
786         uint8_t *client_write_IV;
787         uint8_t *server_write_IV;
788         uint8_t client_write_MAC_key[TLS_MAX_MAC_SIZE];
789         uint8_t server_write_MAC_k__[TLS_MAX_MAC_SIZE];
790         uint8_t client_write_k__[TLS_MAX_KEY_SIZE];
791         uint8_t server_write_k__[TLS_MAX_KEY_SIZE];
792         uint8_t client_write_I_[TLS_MAX_IV_SIZE];
793         uint8_t server_write_I_[TLS_MAX_IV_SIZE];
794
795         struct tls_aes aes_encrypt;
796         struct tls_aes aes_decrypt;
797         uint8_t H[16]; //used by AES_GCM
798 } tls_state_t;
799
800 static inline tls_state_t *new_tls_state(void)
801 {
802         tls_state_t *tls = xzalloc(sizeof(*tls));
803         return tls;
804 }
805 void tls_handshake(tls_state_t *tls, const char *sni) FAST_FUNC;
806 #define TLSLOOP_EXIT_ON_LOCAL_EOF (1 << 0)
807 void tls_run_copy_loop(tls_state_t *tls, unsigned flags) FAST_FUNC;
808
809
810 void socket_want_pktinfo(int fd) FAST_FUNC;
811 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
812                 const struct sockaddr *to,
813                 const struct sockaddr *from,
814                 socklen_t tolen) FAST_FUNC;
815 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
816                 struct sockaddr *from,
817                 struct sockaddr *to,
818                 socklen_t sa_size) FAST_FUNC;
819
820 uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
821 int parse_pasv_epsv(char *buf) FAST_FUNC;
822
823 /* 0 if argv[0] is NULL: */
824 unsigned string_array_len(char **argv) FAST_FUNC;
825 void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
826 char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
827 char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
828 unsigned count_strstr(const char *str, const char *sub) FAST_FUNC;
829 char *xmalloc_substitute_string(const char *src, int count, const char *sub, const char *repl) FAST_FUNC;
830 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
831  * But potentially slow, don't use in one-billion-times loops */
832 int bb_putchar(int ch) FAST_FUNC;
833 /* Note: does not use stdio, writes to fd 2 directly */
834 int bb_putchar_stderr(char ch) FAST_FUNC;
835 char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
836 char *auto_string(char *str) FAST_FUNC;
837 // gcc-4.1.1 still isn't good enough at optimizing it
838 // (+200 bytes compared to macro)
839 //static ALWAYS_INLINE
840 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
841 //static ALWAYS_INLINE
842 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
843 #define LONE_DASH(s)     ((s)[0] == '-' && !(s)[1])
844 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
845 #define LONE_CHAR(s,c)     ((s)[0] == (c) && !(s)[1])
846 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
847 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
848
849 typedef struct uni_stat_t {
850         unsigned byte_count;
851         unsigned unicode_count;
852         unsigned unicode_width;
853 } uni_stat_t;
854 /* Returns a string with unprintable chars replaced by '?' or
855  * SUBST_WCHAR. This function is unicode-aware. */
856 const char* FAST_FUNC printable_string(const char *str);
857 const char* FAST_FUNC printable_string2(uni_stat_t *stats, const char *str);
858 /* Prints unprintable char ch as ^C or M-c to file
859  * (M-c is used only if ch is ORed with PRINTABLE_META),
860  * else it is printed as-is (except for ch = 0x9b) */
861 enum { PRINTABLE_META = 0x100 };
862 void fputc_printable(int ch, FILE *file) FAST_FUNC;
863 /* Return a string that is the printable representation of character ch.
864  * Buffer must hold at least four characters. */
865 enum {
866         VISIBLE_ENDLINE   = 1 << 0,
867         VISIBLE_SHOW_TABS = 1 << 1,
868 };
869 void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
870
871 extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
872 extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count) FAST_FUNC;
873 // NB: will return short read on error, not -1,
874 // if some data was read before error occurred
875 extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
876 extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
877 extern unsigned char xread_char(int fd) FAST_FUNC;
878 extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
879 extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
880 // Reads one line a-la fgets (but doesn't save terminating '\n').
881 // Reads byte-by-byte. Useful when it is important to not read ahead.
882 // Bytes are appended to pfx (which must be malloced, or NULL).
883 extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
884 /* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
885 extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
886 extern void *xmalloc_read_with_initial_buf(int fd, size_t *maxsz_p, char *buf, size_t total) FAST_FUNC;
887 /* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
888 extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
889 /* Never returns NULL */
890 extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
891
892 #if defined(ARG_MAX) && (ARG_MAX >= 60*1024 || !defined(_SC_ARG_MAX))
893 /* Use _constant_ maximum if: defined && (big enough || no variable one exists) */
894 # define bb_arg_max() ((unsigned)ARG_MAX)
895 #elif defined(_SC_ARG_MAX)
896 /* Else use variable one (a bit more expensive) */
897 unsigned bb_arg_max(void) FAST_FUNC;
898 #else
899 /* If all else fails */
900 # define bb_arg_max() ((unsigned)(32 * 1024))
901 #endif
902 unsigned bb_clk_tck(void) FAST_FUNC;
903
904 #define SEAMLESS_COMPRESSION (0 \
905  || ENABLE_FEATURE_SEAMLESS_XZ \
906  || ENABLE_FEATURE_SEAMLESS_LZMA \
907  || ENABLE_FEATURE_SEAMLESS_BZ2 \
908  || ENABLE_FEATURE_SEAMLESS_GZ \
909  || ENABLE_FEATURE_SEAMLESS_Z)
910
911 #if SEAMLESS_COMPRESSION
912 /* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
913 int setup_unzip_on_fd(int fd, int fail_if_not_compressed) FAST_FUNC;
914 /* Autodetects .gz etc */
915 extern int open_zipped(const char *fname, int fail_if_not_compressed) FAST_FUNC;
916 extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
917 #else
918 # define setup_unzip_on_fd(...) (0)
919 # define open_zipped(fname, fail_if_not_compressed)  open((fname), O_RDONLY);
920 # define xmalloc_open_zipped_read_close(fname, maxsz_p) xmalloc_open_read_close((fname), (maxsz_p))
921 #endif
922 /* lzma has no signature, need a little helper. NB: exist only for ENABLE_FEATURE_SEAMLESS_LZMA=y */
923 void setup_lzma_on_fd(int fd) FAST_FUNC;
924
925 extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
926 // NB: will return short write on error, not -1,
927 // if some data was written before error occurred
928 extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
929 extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
930 extern void xwrite_str(int fd, const char *str) FAST_FUNC;
931 extern ssize_t full_write1_str(const char *str) FAST_FUNC;
932 extern ssize_t full_write2_str(const char *str) FAST_FUNC;
933 extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
934
935 /* Close fd, but check for failures (some types of write errors) */
936 extern void xclose(int fd) FAST_FUNC;
937
938 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
939 extern void xprint_and_close_file(FILE *file) FAST_FUNC;
940
941 /* Reads a line from a text file, up to a newline or NUL byte, inclusive.
942  * Returns malloc'ed char*. If end is NULL '\n' isn't considered
943  * end of line. If end isn't NULL, length of the chunk is stored in it.
944  * Returns NULL if EOF/error.
945  */
946 extern char *bb_get_chunk_from_file(FILE *file, size_t *end) FAST_FUNC;
947 /* Reads up to (and including) TERMINATING_STRING: */
948 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
949 /* Same, with limited max size, and returns the length (excluding NUL): */
950 extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
951 /* Chops off TERMINATING_STRING from the end: */
952 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
953 /* Reads up to (and including) "\n" or NUL byte: */
954 extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
955 /* Chops off '\n' from the end, unlike fgets: */
956 extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
957 /* Same, but doesn't try to conserve space (may have some slack after the end) */
958 /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
959
960 void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
961 void die_if_ferror_stdout(void) FAST_FUNC;
962 int fflush_all(void) FAST_FUNC;
963 void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
964 int fclose_if_not_stdin(FILE *file) FAST_FUNC;
965 FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
966 /* Prints warning to stderr and returns NULL on failure: */
967 FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
968 /* "Opens" stdin if filename is special, else just opens file: */
969 FILE* xfopen_stdin(const char *filename) FAST_FUNC;
970 FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
971 FILE* fopen_for_read(const char *path) FAST_FUNC;
972 FILE* xfopen_for_read(const char *path) FAST_FUNC;
973 FILE* fopen_for_write(const char *path) FAST_FUNC;
974 FILE* xfopen_for_write(const char *path) FAST_FUNC;
975 FILE* xfdopen_for_read(int fd) FAST_FUNC;
976 FILE* xfdopen_for_write(int fd) FAST_FUNC;
977
978 int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
979 void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
980
981 /* Wrapper which restarts poll on EINTR or ENOMEM.
982  * On other errors complains [perror("poll")] and returns.
983  * Warning! May take (much) longer than timeout_ms to return!
984  * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
985 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
986
987 char *safe_gethostname(void) FAST_FUNC;
988
989 /* Convert each alpha char in str to lower-case */
990 char* str_tolower(char *str) FAST_FUNC;
991
992 char *utoa(unsigned n) FAST_FUNC;
993 char *itoa(int n) FAST_FUNC;
994 /* Returns a pointer past the formatted number, does NOT null-terminate */
995 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
996 char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
997 /* Intelligent formatters of bignums */
998 char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
999 char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
1000 /* If block_size == 0, display size without fractional part,
1001  * else display (size * block_size) with one decimal digit.
1002  * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
1003  * else divide by display_unit and do not use suffix. */
1004 #define HUMAN_READABLE_MAX_WIDTH      7  /* "1024.0G" */
1005 #define HUMAN_READABLE_MAX_WIDTH_STR "7"
1006 //TODO: provide pointer to buf (avoid statics)?
1007 const char *make_human_readable_str(unsigned long long size,
1008                 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
1009 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
1010 char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
1011 /* Reverse */
1012 char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
1013
1014 /* Generate a UUID */
1015 void generate_uuid(uint8_t *buf) FAST_FUNC;
1016
1017 /* Last element is marked by mult == 0 */
1018 struct suffix_mult {
1019         char suffix[4];
1020         unsigned mult;
1021 };
1022 extern const struct suffix_mult bkm_suffixes[];
1023 #define km_suffixes (bkm_suffixes + 1)
1024 extern const struct suffix_mult cwbkMG_suffixes[];
1025 #define kMG_suffixes (cwbkMG_suffixes + 3)
1026 extern const struct suffix_mult kmg_i_suffixes[];
1027
1028 #include "xatonum.h"
1029 /* Specialized: */
1030
1031 /* Using xatoi() instead of naive atoi() is not always convenient -
1032  * in many places people want *non-negative* values, but store them
1033  * in signed int. Therefore we need this one:
1034  * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
1035  * It should really be named xatoi_nonnegative (since it allows 0),
1036  * but that would be too long.
1037  */
1038 int xatoi_positive(const char *numstr) FAST_FUNC;
1039
1040 /* Useful for reading port numbers */
1041 uint16_t xatou16(const char *numstr) FAST_FUNC;
1042
1043 #if ENABLE_FLOAT_DURATION
1044 typedef double duration_t;
1045 void sleep_for_duration(duration_t duration) FAST_FUNC;
1046 #define DURATION_FMT "f"
1047 #else
1048 typedef unsigned duration_t;
1049 #define sleep_for_duration(duration) sleep(duration)
1050 #define DURATION_FMT "u"
1051 #endif
1052 duration_t parse_duration_str(char *str) FAST_FUNC;
1053
1054 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
1055  * for BusyBox since we want to avoid using the glibc NSS stuff, which
1056  * increases target size and is often not needed on embedded systems.  */
1057 long xuname2uid(const char *name) FAST_FUNC;
1058 long xgroup2gid(const char *name) FAST_FUNC;
1059 /* wrapper: allows string to contain numeric uid or gid */
1060 unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
1061 struct bb_uidgid_t {
1062         uid_t uid;
1063         gid_t gid;
1064 };
1065 /* always sets uid and gid; returns 0 on failure */
1066 int get_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
1067 /* always sets uid and gid; exits on failure */
1068 void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
1069 /* chown-like handling of "user[:[group]" */
1070 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
1071 struct passwd* xgetpwnam(const char *name) FAST_FUNC;
1072 struct group* xgetgrnam(const char *name) FAST_FUNC;
1073 struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
1074 struct group* xgetgrgid(gid_t gid) FAST_FUNC;
1075 char* xuid2uname(uid_t uid) FAST_FUNC;
1076 char* xgid2group(gid_t gid) FAST_FUNC;
1077 char* uid2uname(uid_t uid) FAST_FUNC;
1078 char* gid2group(gid_t gid) FAST_FUNC;
1079 char* uid2uname_utoa(uid_t uid) FAST_FUNC;
1080 char* gid2group_utoa(gid_t gid) FAST_FUNC;
1081 /* versions which cache results (useful for ps, ls etc) */
1082 const char* get_cached_username(uid_t uid) FAST_FUNC;
1083 const char* get_cached_groupname(gid_t gid) FAST_FUNC;
1084 void clear_username_cache(void) FAST_FUNC;
1085 /* internally usernames are saved in fixed-sized char[] buffers */
1086 enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
1087 #if ENABLE_FEATURE_CHECK_NAMES
1088 void die_if_bad_username(const char* name) FAST_FUNC;
1089 #else
1090 #define die_if_bad_username(name) ((void)(name))
1091 #endif
1092 /*
1093  * Returns (-1) terminated malloced result of getgroups().
1094  * Reallocs group_array (useful for repeated calls).
1095  * ngroups is an initial size of array. It is rounded up to 32 for realloc.
1096  * ngroups is updated on return.
1097  * ngroups can be NULL: bb_getgroups(NULL, NULL) is valid usage.
1098  * Dies on errors (on Linux, only xrealloc can cause this, not internal getgroups call).
1099  */
1100 gid_t *bb_getgroups(int *ngroups, gid_t *group_array) FAST_FUNC;
1101
1102 #if ENABLE_FEATURE_UTMP
1103 void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
1104 void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
1105 void FAST_FUNC update_utmp_DEAD_PROCESS(pid_t pid);
1106 #else
1107 # define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
1108 # define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
1109 # define update_utmp_DEAD_PROCESS(pid) ((void)0)
1110 #endif
1111
1112
1113 int file_is_executable(const char *name) FAST_FUNC;
1114 char *find_executable(const char *filename, char **PATHp) FAST_FUNC;
1115 int executable_exists(const char *filename) FAST_FUNC;
1116
1117 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
1118  * but it may exec busybox and call applet instead of searching PATH.
1119  */
1120 #if ENABLE_FEATURE_PREFER_APPLETS
1121 int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
1122 #define BB_EXECLP(prog,cmd,...) \
1123         do { \
1124                 if (find_applet_by_name(prog) >= 0) \
1125                         execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
1126                 execlp(prog, cmd, __VA_ARGS__); \
1127         } while (0)
1128 #else
1129 #define BB_EXECVP(prog,cmd)     execvp(prog,cmd)
1130 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
1131 #endif
1132 void BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
1133 void exec_prog_or_SHELL(char **argv) NORETURN FAST_FUNC;
1134
1135 /* xvfork() can't be a _function_, return after vfork in child mangles stack
1136  * in the parent. It must be a macro. */
1137 #define xvfork() \
1138 ({ \
1139         pid_t bb__xvfork_pid = vfork(); \
1140         if (bb__xvfork_pid < 0) \
1141                 bb_simple_perror_msg_and_die("vfork"); \
1142         bb__xvfork_pid; \
1143 })
1144 #if BB_MMU
1145 pid_t xfork(void) FAST_FUNC;
1146 #endif
1147 void xvfork_parent_waits_and_exits(void) FAST_FUNC;
1148
1149 /* NOMMU friendy fork+exec: */
1150 pid_t spawn(char **argv) FAST_FUNC;
1151 pid_t xspawn(char **argv) FAST_FUNC;
1152
1153 pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
1154 pid_t wait_any_nohang(int *wstat) FAST_FUNC;
1155 /* wait4pid: unlike waitpid, waits ONLY for one process.
1156  * Returns sig + 0x180 if child is killed by signal.
1157  * It's safe to pass negative 'pids' from failed [v]fork -
1158  * wait4pid will return -1 (and will not clobber [v]fork's errno).
1159  * IOW: rc = wait4pid(spawn(argv));
1160  *      if (rc < 0) bb_perror_msg("%s", argv[0]);
1161  *      if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
1162  */
1163 int wait4pid(pid_t pid) FAST_FUNC;
1164 int wait_for_exitstatus(pid_t pid) FAST_FUNC;
1165 /************************************************************************/
1166 /* spawn_and_wait/run_nofork_applet/run_applet_no_and_exit need to work */
1167 /* carefully together to reinit some global state while not disturbing  */
1168 /* other. Be careful if you change them. Consult docs/nofork_noexec.txt */
1169 /************************************************************************/
1170 /* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
1171 int spawn_and_wait(char **argv) FAST_FUNC;
1172 /* Does NOT check that applet is NOFORK, just blindly runs it */
1173 int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
1174 void run_noexec_applet_and_exit(int a, const char *name, char **argv) NORETURN FAST_FUNC;
1175 #ifndef BUILD_INDIVIDUAL
1176 int find_applet_by_name(const char *name) FAST_FUNC;
1177 void run_applet_no_and_exit(int a, const char *name, char **argv) NORETURN FAST_FUNC;
1178 #endif
1179 #if defined(__linux__)
1180 void set_task_comm(const char *comm) FAST_FUNC;
1181 #else
1182 # define set_task_comm(name) ((void)0)
1183 #endif
1184
1185 /* Helpers for daemonization.
1186  *
1187  * bb_daemonize(flags) = daemonize, does not compile on NOMMU
1188  *
1189  * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
1190  *      rexec's itself on NOMMU with argv passed as command line.
1191  * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
1192  * from the start. (It will detect it and not reexec again second time).
1193  * You have to audit carefully that you don't do something twice as a result
1194  * (opening files/sockets, parsing config files etc...)!
1195  *
1196  * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
1197  * (will do setsid()).
1198  *
1199  * fork_or_rexec(argv) = bare-bones fork on MMU,
1200  *      "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
1201  *      On MMU ignores argv.
1202  *
1203  * Helper for network daemons in foreground mode:
1204  *
1205  * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
1206  * to /dev/null if they are not.
1207  */
1208 enum {
1209         DAEMON_CHDIR_ROOT      = 1 << 0,
1210         DAEMON_DEVNULL_STDIO   = 1 << 1,
1211         DAEMON_CLOSE_EXTRA_FDS = 1 << 2,
1212         DAEMON_ONLY_SANITIZE   = 1 << 3, /* internal use */
1213         //DAEMON_DOUBLE_FORK     = 1 << 4, /* double fork to avoid controlling tty */
1214 };
1215 #if BB_MMU
1216   enum { re_execed = 0 };
1217 # define fork_or_rexec(argv)                xfork()
1218 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1219 # define bb_daemonize(flags)                bb_daemonize_or_rexec(flags, bogus)
1220 #else
1221   extern bool re_execed;
1222   /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1223    * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1224    */
1225   void re_exec(char **argv) NORETURN FAST_FUNC;
1226   pid_t fork_or_rexec(char **argv) FAST_FUNC;
1227   int  BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1228   int  BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1229   void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
1230 # define fork()          BUG_fork_is_unavailable_on_nommu()
1231 # define xfork()         BUG_fork_is_unavailable_on_nommu()
1232 # define daemon(a,b)     BUG_daemon_is_unavailable_on_nommu()
1233 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
1234 #endif
1235 void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1236 void bb_sanitize_stdio(void) FAST_FUNC;
1237 #define bb_daemon_helper(arg) bb_daemonize_or_rexec((arg) | DAEMON_ONLY_SANITIZE, NULL)
1238 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
1239 int sanitize_env_if_suid(void) FAST_FUNC;
1240
1241
1242 /* For top, ps. Some argv[i] are replaced by malloced "-opt" strings */
1243 void make_all_argv_opts(char **argv) FAST_FUNC;
1244 char* single_argv(char **argv) FAST_FUNC;
1245 extern const char *const bb_argv_dash[]; /* { "-", NULL } */
1246 extern uint32_t option_mask32;
1247 uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
1248 # define No_argument "\0"
1249 # define Required_argument "\001"
1250 # define Optional_argument "\002"
1251 #if ENABLE_LONG_OPTS
1252 uint32_t getopt32long(char **argv, const char *optstring, const char *longopts, ...) FAST_FUNC;
1253 #else
1254 #define getopt32long(argv,optstring,longopts,...) \
1255         getopt32(argv,optstring,##__VA_ARGS__)
1256 #endif
1257 /* BSD-derived getopt() functions require that optind be set to 1 in
1258  * order to reset getopt() state.  This used to be generally accepted
1259  * way of resetting getopt().  However, glibc's getopt()
1260  * has additional getopt() state beyond optind (specifically, glibc
1261  * extensions such as '+' and '-' at the start of the string), and requires
1262  * that optind be set to zero to reset its state.  BSD-derived versions
1263  * of getopt() misbehaved if optind is set to 0 in order to reset getopt(),
1264  * and glibc's getopt() used to coredump if optind is set 1 in order
1265  * to reset getopt().
1266  * Then BSD introduced additional variable "optreset" which should be
1267  * set to 1 in order to reset getopt().  Sigh.  Standards, anyone?
1268  *
1269  * By ~2008, OpenBSD 3.4 was changed to survive glibc-like optind = 0
1270  * (to interpret it as if optreset was set).
1271  */
1272 #if 1 /*def __GLIBC__*/
1273 #define GETOPT_RESET() (optind = 0)
1274 #else /* BSD style */
1275 #define GETOPT_RESET() (optind = 1)
1276 #endif
1277
1278
1279 /* Having next pointer as a first member allows easy creation
1280  * of "llist-compatible" structs, and using llist_FOO functions
1281  * on them.
1282  */
1283 typedef struct llist_t {
1284         struct llist_t *link;
1285         char *data;
1286 } llist_t;
1287 void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1288 void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1289 void *llist_pop(llist_t **elm) FAST_FUNC;
1290 void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1291 void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1292 llist_t *llist_rev(llist_t *list) FAST_FUNC;
1293 llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
1294 /* BTW, surprisingly, changing API to
1295  *   llist_t *llist_add_to(llist_t *old_head, void *data)
1296  * etc does not result in smaller code... */
1297
1298 /* start_stop_daemon and udhcpc are special - they want
1299  * to create pidfiles regardless of FEATURE_PIDFILE */
1300 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
1301 /* True only if we created pidfile which is *file*, not /dev/null etc */
1302 extern smallint wrote_pidfile;
1303 void write_pidfile(const char *path) FAST_FUNC;
1304 void write_pidfile_std_path_and_ext(const char *path) FAST_FUNC;
1305 void remove_pidfile_std_path_and_ext(const char *path) FAST_FUNC;
1306 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
1307 #else
1308 enum { wrote_pidfile = 0 };
1309 #define write_pidfile_std_path_and_ext(path)  ((void)0)
1310 #define remove_pidfile_std_path_and_ext(path) ((void)0)
1311 #define write_pidfile(path)  ((void)0)
1312 #define remove_pidfile(path) ((void)0)
1313 #endif
1314
1315 enum {
1316         LOGMODE_NONE = 0,
1317         LOGMODE_STDIO = (1 << 0),
1318         LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
1319         LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1320 };
1321 extern const char *msg_eol;
1322 extern smallint logmode;
1323 extern uint8_t xfunc_error_retval;
1324 extern void (*die_func)(void);
1325 void xfunc_die(void) NORETURN FAST_FUNC;
1326 void bb_show_usage(void) NORETURN FAST_FUNC;
1327 void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1328 void bb_simple_error_msg(const char *s) FAST_FUNC;
1329 void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1330 void bb_simple_error_msg_and_die(const char *s) NORETURN FAST_FUNC;
1331 void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1332 void bb_simple_perror_msg(const char *s) FAST_FUNC;
1333 void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1334 void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
1335 void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1336 void bb_simple_herror_msg(const char *s) FAST_FUNC;
1337 void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1338 void bb_simple_herror_msg_and_die(const char *s) NORETURN FAST_FUNC;
1339 void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
1340 void bb_perror_nomsg(void) FAST_FUNC;
1341 void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
1342 void bb_die_memory_exhausted(void) NORETURN FAST_FUNC;
1343 void bb_logenv_override(void) FAST_FUNC;
1344
1345 #if ENABLE_FEATURE_SYSLOG_INFO
1346 void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1347 void bb_simple_info_msg(const char *s) FAST_FUNC;
1348 void bb_vinfo_msg(const char *s, va_list p) FAST_FUNC;
1349 #else
1350 #define bb_info_msg bb_error_msg
1351 #define bb_simple_info_msg bb_simple_error_msg
1352 #define bb_vinfo_msg(s,p) bb_verror_msg(s,p,NULL)
1353 #endif
1354
1355 #if ENABLE_WARN_SIMPLE_MSG
1356 /* If enabled, cause calls to bb_error_msg() et al that only take a single
1357  * parameter to generate a warning.
1358  */
1359 static inline void __attribute__ ((deprecated("use bb_simple_error_msg instead")))
1360         bb_not_simple_error_msg(const char *s) { bb_simple_error_msg(s); }
1361 static inline void __attribute__ ((deprecated("use bb_simple_error_msg_and_die instead"))) NORETURN
1362         bb_not_simple_error_msg_and_die(const char *s) { bb_simple_error_msg_and_die(s); }
1363 static inline void __attribute__ ((deprecated("use bb_simple_perror_msg instead")))
1364         bb_not_simple_perror_msg(const char *s) { bb_simple_perror_msg(s); }
1365 static inline void __attribute__ ((deprecated("use bb_simple_perror_msg_and_die instead"))) NORETURN
1366         bb_not_simple_perror_msg_and_die(const char *s) { bb_simple_perror_msg_and_die(s); }
1367 static inline void __attribute__ ((deprecated("use bb_simple_herror_msg instead")))
1368         bb_not_simple_herror_msg(const char *s) { bb_simple_herror_msg(s); }
1369 static inline void __attribute__ ((deprecated("use bb_simple_herror_msg_and_die instead"))) NORETURN
1370         bb_not_simple_herror_msg_and_die(const char *s) { bb_simple_herror_msg_and_die(s); }
1371 static inline void __attribute__ ((deprecated("use bb_simple_info_msg instead")))
1372         bb_not_simple_info_msg(const char *s) { bb_simple_info_msg(s); }
1373 /* Override bb_error_msg() and related functions with macros that will
1374  * substitute them for the equivalent bb_not_simple_error_msg() function when
1375  * they are used with only a single parameter. Macro approach inspired by
1376  * https://gustedt.wordpress.com/2010/06/08/detect-empty-macro-arguments and
1377  * https://gustedt.wordpress.com/2010/06/03/default-arguments-for-c99
1378  */
1379 #define _ARG18(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, ...) _17
1380 #define BB_MSG_KIND(...)           _ARG18(__VA_ARGS__, , , , , , , , , , , , , , , , , _not_simple)
1381 #define _BB_MSG(name, kind, ...)   bb##kind##name(__VA_ARGS__)
1382 #define BB_MSG(name, kind, ...)    _BB_MSG(name, kind, __VA_ARGS__)
1383 #define bb_error_msg(...)          BB_MSG(_error_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1384 #define bb_error_msg_and_die(...)  BB_MSG(_error_msg_and_die, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1385 #define bb_perror_msg(...)         BB_MSG(_perror_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1386 #define bb_perror_msg_and_die(...) BB_MSG(_perror_msg_and_die, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1387 #define bb_herror_msg(...)         BB_MSG(_herror_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1388 #define bb_herror_msg_and_die(...) BB_MSG(_herror_msg_and_die, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1389 #if ENABLE_FEATURE_SYSLOG_INFO
1390 #define bb_info_msg(...)           BB_MSG(_info_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1391 #endif
1392 #endif
1393
1394 /* We need to export XXX_main from libbusybox
1395  * only if we build "individual" binaries
1396  */
1397 #if ENABLE_FEATURE_INDIVIDUAL
1398 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1399 #else
1400 #define MAIN_EXTERNALLY_VISIBLE
1401 #endif
1402
1403 /* Embedded script support */
1404 char *get_script_content(unsigned n) FAST_FUNC;
1405 int scripted_main(int argc, char** argv) MAIN_EXTERNALLY_VISIBLE;
1406
1407 /* Applets which are useful from another applets */
1408 int bb_cat(char** argv) FAST_FUNC;
1409 int ash_main(int argc, char** argv)
1410 #if ENABLE_ASH || ENABLE_SH_IS_ASH || ENABLE_BASH_IS_ASH
1411                 MAIN_EXTERNALLY_VISIBLE
1412 #endif
1413 ;
1414 int hush_main(int argc, char** argv)
1415 #if ENABLE_HUSH || ENABLE_SH_IS_HUSH || ENABLE_BASH_IS_HUSH
1416                 MAIN_EXTERNALLY_VISIBLE
1417 #endif
1418 ;
1419 /* If shell needs them, they exist even if not enabled as applets */
1420 int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1421 int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1422 int test_main(int argc, char **argv)
1423 #if ENABLE_TEST || ENABLE_TEST1 || ENABLE_TEST2
1424                 MAIN_EXTERNALLY_VISIBLE
1425 #endif
1426 ;
1427 int kill_main(int argc, char **argv)
1428 #if ENABLE_KILL || ENABLE_KILLALL || ENABLE_KILLALL5
1429                 MAIN_EXTERNALLY_VISIBLE
1430 #endif
1431 ;
1432 /* Similar, but used by chgrp, not shell */
1433 int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
1434 /* Used by ftpd */
1435 int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1436 /* Don't need IF_xxx() guard for these */
1437 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1438 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1439
1440 #if ENABLE_ROUTE
1441 void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
1442 #endif
1443
1444 struct number_state {
1445         unsigned width;
1446         unsigned start;
1447         unsigned inc;
1448         const char *sep;
1449         const char *empty_str;
1450         smallint all, nonempty;
1451 };
1452 int print_numbered_lines(struct number_state *ns, const char *filename) FAST_FUNC;
1453
1454
1455 /* Networking */
1456 /* This structure defines protocol families and their handlers. */
1457 struct aftype {
1458         const char *name;
1459         const char *title;
1460         int af;
1461         int alen;
1462         char*       FAST_FUNC (*print)(unsigned char *);
1463         const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1464         int         FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1465         void        FAST_FUNC (*herror)(char *text);
1466         int         FAST_FUNC (*rprint)(int options);
1467         int         FAST_FUNC (*rinput)(int typ, int ext, char **argv);
1468         /* may modify src */
1469         int         FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
1470 };
1471 /* This structure defines hardware protocols and their handlers. */
1472 struct hwtype {
1473         const char *name;
1474         const char *title;
1475         int type;
1476         int alen;
1477         char* FAST_FUNC (*print)(unsigned char *);
1478         int   FAST_FUNC (*input)(const char *, struct sockaddr *);
1479         int   FAST_FUNC (*activate)(int fd);
1480         int suppress_null_addr;
1481 };
1482 #define IFNAME_SHOW_DOWNED_TOO ((char*)(intptr_t)1)
1483 int display_interfaces(char *ifname) FAST_FUNC;
1484 int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1485 #if ENABLE_FEATURE_HWIB
1486 int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1487 #else
1488 #define in_ib(a, b) 1 /* fail */
1489 #endif
1490 const struct aftype *get_aftype(const char *name) FAST_FUNC;
1491 const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1492 const struct hwtype *get_hwntype(int type) FAST_FUNC;
1493
1494
1495 extern int fstype_matches(const char *fstype, const char *comma_list) FAST_FUNC;
1496 #ifdef HAVE_MNTENT_H
1497 extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
1498 #endif
1499 extern void erase_mtab(const char * name) FAST_FUNC;
1500 extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1501 extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1502 #if ENABLE_DESKTOP
1503 extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1504 #else
1505 # define bb_warn_ignoring_args(arg) ((void)0)
1506 #endif
1507
1508 extern int get_linux_version_code(void) FAST_FUNC;
1509
1510 char *query_loop(const char *device) FAST_FUNC;
1511 int get_free_loop(void) FAST_FUNC;
1512 int del_loop(const char *device) FAST_FUNC;
1513 /*
1514  * If *devname is not NULL, use that name, otherwise try to find free one,
1515  * malloc and return it in *devname.
1516  * return value is the opened fd to the loop device, or < on error
1517  */
1518 int set_loop(char **devname, const char *file, unsigned long long offset, unsigned flags) FAST_FUNC;
1519 /* These constants match linux/loop.h (without BB_ prefix): */
1520 #define BB_LO_FLAGS_READ_ONLY 1
1521 #define BB_LO_FLAGS_AUTOCLEAR 4
1522 #define BB_LO_FLAGS_PARTSCAN  8
1523
1524 /* Returns malloced str */
1525 char *bb_ask_noecho(int fd, int timeout, const char *prompt) FAST_FUNC;
1526 /* Like bb_ask_noecho, but asks on stdin with no timeout.  */
1527 char *bb_ask_noecho_stdin(const char *prompt) FAST_FUNC;
1528
1529 int bb_ask_y_confirmation_FILE(FILE *fp) FAST_FUNC;
1530 int bb_ask_y_confirmation(void) FAST_FUNC;
1531
1532 /* Returns -1 if input is invalid. current_mode is a base for e.g. "u+rw" */
1533 int bb_parse_mode(const char* s, unsigned cur_mode) FAST_FUNC;
1534
1535 /*
1536  * Config file parser
1537  */
1538 enum {
1539         PARSE_COLLAPSE  = 0x00010000, // treat consecutive delimiters as one
1540         PARSE_TRIM      = 0x00020000, // trim leading and trailing delimiters
1541 // TODO: COLLAPSE and TRIM seem to always go in pair
1542         PARSE_GREEDY    = 0x00040000, // last token takes entire remainder of the line
1543         PARSE_MIN_DIE   = 0x00100000, // die if < min tokens found
1544         // keep a copy of current line
1545         PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
1546         PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
1547         PARSE_ALT_COMMENTS = 0x00800000, // delim[0] and delim[1] are two different allowed comment chars
1548         // (so far, delim[0] will only work as comment char for full-line comment)
1549         // (IOW: it works as if PARSE_EOL_COMMENTS is not set. sysctl applet is okay with this)
1550         PARSE_WS_COMMENTS  = 0x01000000, // comments are recognized even if there is whitespace before
1551         // ("line start><space><tab><space>#comment" is also comment, not only "line start>#comment")
1552         // NORMAL is:
1553         // * remove leading and trailing delimiters and collapse
1554         //   multiple delimiters into one
1555         // * warn and continue if less than mintokens delimiters found
1556         // * grab everything into last token
1557         // * comments are recognized even if they aren't the first char
1558         PARSE_NORMAL    = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
1559 };
1560 typedef struct parser_t {
1561         FILE *fp;
1562         char *data;
1563         char *line, *nline;
1564         size_t line_alloc, nline_alloc;
1565         int lineno;
1566 } parser_t;
1567 parser_t* config_open(const char *filename) FAST_FUNC;
1568 parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
1569 /* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
1570 int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1571 #define config_read(parser, tokens, max, min, str, flags) \
1572         config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1573 void config_close(parser_t *parser) FAST_FUNC;
1574
1575 /* Concatenate path and filename to new allocated buffer.
1576  * Add "/" only as needed (no duplicate "//" are produced).
1577  * If path is NULL, it is assumed to be "/".
1578  * filename should not be NULL. */
1579 char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1580 /* Returns NULL on . and .. */
1581 char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1582
1583
1584 int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1585
1586 int get_signum(const char *name) FAST_FUNC;
1587 const char *get_signame(int number) FAST_FUNC;
1588 void print_signames(void) FAST_FUNC;
1589
1590 char *bb_simplify_path(const char *path) FAST_FUNC;
1591 /* Returns ptr to NUL */
1592 char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
1593
1594 #ifndef LOGIN_FAIL_DELAY
1595 #define LOGIN_FAIL_DELAY 3
1596 #endif
1597 extern void bb_do_delay(int seconds) FAST_FUNC;
1598 extern void change_identity(const struct passwd *pw) FAST_FUNC;
1599 extern void run_shell(const char *shell, int loginshell, const char **args) NORETURN FAST_FUNC;
1600
1601 /* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1602  * Note that getpwuid result might need xstrdup'ing
1603  * if there is a possibility of intervening getpwxxx() calls.
1604  */
1605 const char *get_shell_name(void) FAST_FUNC;
1606
1607 #if ENABLE_FEATURE_SETPRIV_CAPABILITIES || ENABLE_RUN_INIT
1608 unsigned cap_name_to_number(const char *cap) FAST_FUNC;
1609 void printf_cap(const char *pfx, unsigned cap_no) FAST_FUNC;
1610 void drop_capability(int cap_ordinal) FAST_FUNC;
1611 /* Structures inside "struct caps" are Linux-specific and libcap-specific: */
1612 #define DEFINE_STRUCT_CAPS \
1613 struct caps { \
1614         struct __user_cap_header_struct header; \
1615         unsigned u32s; \
1616         struct __user_cap_data_struct data[2]; \
1617 }
1618 void getcaps(void *caps) FAST_FUNC;
1619 #endif
1620
1621 #if ENABLE_SELINUX
1622 extern void renew_current_security_context(void) FAST_FUNC;
1623 extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1624 extern context_t set_security_context_component(security_context_t cur_context,
1625                                                 char *user, char *role, char *type, char *range) FAST_FUNC;
1626 extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1627 extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1628 #else
1629 #define selinux_preserve_fcontext(fdesc) ((void)0)
1630 #endif
1631 extern void selinux_or_die(void) FAST_FUNC;
1632
1633
1634 /* setup_environment:
1635  * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
1636  * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1637  *   TERM=(old value)
1638  *   USER=pw->pw_name, LOGNAME=pw->pw_name
1639  *   PATH=bb_default_[root_]path
1640  *   HOME=pw->pw_dir
1641  *   SHELL=shell
1642  * else if change_env = 1:
1643  *   if not root (if pw->pw_uid != 0):
1644  *     USER=pw->pw_name, LOGNAME=pw->pw_name
1645  *   HOME=pw->pw_dir
1646  *   SHELL=shell
1647  * else does nothing
1648  *
1649  * NB: CHANGEENV and CLEARENV use setenv() - this leaks memory!
1650  * If setup_environment() is used is vforked child, this leaks memory _in parent too_!
1651  */
1652 #define SETUP_ENV_CHANGEENV (1 << 0)
1653 #define SETUP_ENV_CLEARENV  (1 << 1)
1654 #define SETUP_ENV_TO_TMP    (1 << 2)
1655 #define SETUP_ENV_NO_CHDIR  (1 << 4)
1656 void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1657 void nuke_str(char *str) FAST_FUNC;
1658 #if ENABLE_FEATURE_SECURETTY && !ENABLE_PAM
1659 int is_tty_secure(const char *short_tty) FAST_FUNC;
1660 #else
1661 static ALWAYS_INLINE int is_tty_secure(const char *short_tty UNUSED_PARAM) { return 1; }
1662 #endif
1663 #define CHECKPASS_PW_HAS_EMPTY_PASSWORD 2
1664 int check_password(const struct passwd *pw, const char *plaintext) FAST_FUNC;
1665 int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1666 int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
1667 /* Returns a malloced string */
1668 #if !ENABLE_USE_BB_CRYPT
1669 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1670 #endif
1671 extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1672 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1673 /*
1674  * rnd is additional random input. New one is returned.
1675  * Useful if you call crypt_make_salt many times in a row:
1676  * rnd = crypt_make_salt(buf1, 4, 0);
1677  * rnd = crypt_make_salt(buf2, 4, rnd);
1678  * rnd = crypt_make_salt(buf3, 4, rnd);
1679  * (otherwise we risk having same salt generated)
1680  */
1681 extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1682 /* "$N$" + sha_salt_16_bytes + NUL */
1683 #define MAX_PW_SALT_LEN (3 + 16 + 1)
1684 extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1685
1686
1687 /* Returns number of lines changed, or -1 on error */
1688 #if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1689 #define update_passwd(filename, username, data, member) \
1690         update_passwd(filename, username, data)
1691 #endif
1692 extern int update_passwd(const char *filename,
1693                 const char *username,
1694                 const char *data,
1695                 const char *member) FAST_FUNC;
1696
1697 int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1698 int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1699 int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1700 int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1701 const char *nth_string(const char *strings, int n) FAST_FUNC;
1702
1703 extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1704 extern void print_login_prompt(void) FAST_FUNC;
1705
1706 char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
1707 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1708 int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1709 int get_terminal_width(int fd) FAST_FUNC;
1710
1711 int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1712 #define TERMIOS_CLEAR_ISIG      (1 << 0)
1713 #define TERMIOS_RAW_CRNL_INPUT  (1 << 1)
1714 #define TERMIOS_RAW_CRNL_OUTPUT (1 << 2)
1715 #define TERMIOS_RAW_CRNL        (TERMIOS_RAW_CRNL_INPUT|TERMIOS_RAW_CRNL_OUTPUT)
1716 #define TERMIOS_RAW_INPUT       (1 << 3)
1717 int get_termios_and_make_raw(int fd, struct termios *newterm, struct termios *oldterm, int flags) FAST_FUNC;
1718 int set_termios_to_raw(int fd, struct termios *oldterm, int flags) FAST_FUNC;
1719
1720 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1721 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1722 int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1723 #if ENABLE_IOCTL_HEX2STR_ERROR
1724 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1725 int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1726 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1727 #define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp,#request)
1728 #else
1729 int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1730 int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1731 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1732 #define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp)
1733 #endif
1734
1735 char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1736 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1737 void reset_ino_dev_hashtable(void) FAST_FUNC;
1738 #ifdef __GLIBC__
1739 /* At least glibc has horrendously large inline for this, so wrap it */
1740 unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
1741 #undef makedev
1742 #define makedev(a,b) bb_makedev(a,b)
1743 #endif
1744
1745
1746 /* "Keycodes" that report an escape sequence.
1747  * We use something which fits into signed char,
1748  * yet doesn't represent any valid Unicode character.
1749  * Also, -1 is reserved for error indication and we don't use it. */
1750 enum {
1751         KEYCODE_UP        =  -2,
1752         KEYCODE_DOWN      =  -3,
1753         KEYCODE_RIGHT     =  -4,
1754         KEYCODE_LEFT      =  -5,
1755         KEYCODE_HOME      =  -6,
1756         KEYCODE_END       =  -7,
1757         KEYCODE_INSERT    =  -8,
1758         KEYCODE_DELETE    =  -9,
1759         KEYCODE_PAGEUP    = -10,
1760         KEYCODE_PAGEDOWN  = -11,
1761         KEYCODE_BACKSPACE = -12, /* Used only if Alt/Ctrl/Shifted */
1762         KEYCODE_D         = -13, /* Used only if Alted */
1763 #if 0
1764         KEYCODE_FUN1      = ,
1765         KEYCODE_FUN2      = ,
1766         KEYCODE_FUN3      = ,
1767         KEYCODE_FUN4      = ,
1768         KEYCODE_FUN5      = ,
1769         KEYCODE_FUN6      = ,
1770         KEYCODE_FUN7      = ,
1771         KEYCODE_FUN8      = ,
1772         KEYCODE_FUN9      = ,
1773         KEYCODE_FUN10     = ,
1774         KEYCODE_FUN11     = ,
1775         KEYCODE_FUN12     = ,
1776 #endif
1777         /* ^^^^^ Be sure that last defined value is small enough.
1778          * Current read_key() code allows going up to -32 (0xfff..fffe0).
1779          * This gives three upper bits in LSB to play with:
1780          * KEYCODE_foo values are 0xfff..fffXX, lowest XX bits are: scavvvvv,
1781          * s=0 if SHIFT, c=0 if CTRL, a=0 if ALT,
1782          * vvvvv bits are the same for same key regardless of "shift bits".
1783          */
1784         //KEYCODE_SHIFT_...   = KEYCODE_...   & ~0x80,
1785         KEYCODE_CTRL_RIGHT    = KEYCODE_RIGHT & ~0x40,
1786         KEYCODE_CTRL_LEFT     = KEYCODE_LEFT  & ~0x40,
1787         KEYCODE_ALT_RIGHT     = KEYCODE_RIGHT & ~0x20,
1788         KEYCODE_ALT_LEFT      = KEYCODE_LEFT  & ~0x20,
1789         KEYCODE_ALT_BACKSPACE = KEYCODE_BACKSPACE & ~0x20,
1790         KEYCODE_ALT_D         = KEYCODE_D     & ~0x20,
1791
1792         KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
1793         /* How long is the longest ESC sequence we know?
1794          * We want it big enough to be able to contain
1795          * cursor position sequence "ESC [ 9999 ; 9999 R"
1796          */
1797         KEYCODE_BUFFER_SIZE = 16
1798 };
1799 /* Note: fd may be in blocking or non-blocking mode, both make sense.
1800  * For one, less uses non-blocking mode.
1801  * Only the first read syscall inside read_key may block indefinitely
1802  * (unless fd is in non-blocking mode),
1803  * subsequent reads will time out after a few milliseconds.
1804  * Return of -1 means EOF or error (errno == 0 on EOF).
1805  * buffer[0] is used as a counter of buffered chars and must be 0
1806  * on first call.
1807  * timeout:
1808  * -2: do not poll(-1) for input - read() it, return on EAGAIN at once
1809  * -1: poll(-1) (i.e. block even on NONBLOCKed fd)
1810  * >=0: poll() for TIMEOUT milliseconds, return -1/EAGAIN on timeout
1811  */
1812 int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
1813 void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
1814
1815
1816 #if ENABLE_FEATURE_EDITING
1817 /* It's NOT just ENABLEd or disabled. It's a number: */
1818 # if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
1819 #  define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1820 unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
1821 # else
1822 #  define MAX_HISTORY 0
1823 # endif
1824 typedef const char *get_exe_name_t(int i) FAST_FUNC;
1825 typedef struct line_input_t {
1826         int flags;
1827         int timeout;
1828         const char *path_lookup;
1829 # if ENABLE_FEATURE_TAB_COMPLETION \
1830 && (ENABLE_ASH  || ENABLE_SH_IS_ASH  || ENABLE_BASH_IS_ASH \
1831 ||  ENABLE_HUSH || ENABLE_SH_IS_HUSH || ENABLE_BASH_IS_HUSH \
1832 )
1833         /* function to fetch additional application-specific names to match */
1834         get_exe_name_t *get_exe_name;
1835 #  define EDITING_HAS_get_exe_name 1
1836 # endif
1837 # if MAX_HISTORY
1838         int cnt_history;
1839         int cur_history;
1840         int max_history; /* must never be <= 0 */
1841 #  if ENABLE_FEATURE_EDITING_SAVEHISTORY
1842         /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1843          * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1844          * in on-disk history"
1845          * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1846          * also in on-disk history (and thus need to be skipped on save)"
1847          */
1848         unsigned cnt_history_in_file;
1849         const char *hist_file;
1850 #  endif
1851         char *history[MAX_HISTORY + 1];
1852 # endif
1853 } line_input_t;
1854 enum {
1855         DO_HISTORY       = 1 * (MAX_HISTORY > 0),
1856         TAB_COMPLETION   = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1857         USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1858         VI_MODE          = 8 * ENABLE_FEATURE_EDITING_VI,
1859         WITH_PATH_LOOKUP = 0x10,
1860         FOR_SHELL        = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1861 };
1862 line_input_t *new_line_input_t(int flags) FAST_FUNC;
1863 void free_line_input_t(line_input_t *n) FAST_FUNC;
1864 /*
1865  * maxsize must be >= 2.
1866  * Returns:
1867  * -1 on read errors or EOF, or on bare Ctrl-D,
1868  * 0  on ctrl-C (the line entered is still returned in 'command'),
1869  * >0 length of input string, including terminating '\n'
1870  */
1871 int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize) FAST_FUNC;
1872 void show_history(const line_input_t *st) FAST_FUNC;
1873 # if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1874 void save_history(line_input_t *st);
1875 # endif
1876 #else
1877 #define MAX_HISTORY 0
1878 int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1879 #define read_line_input(state, prompt, command, maxsize) \
1880         read_line_input(prompt, command, maxsize)
1881 #endif
1882
1883 #ifndef EDITING_HAS_get_exe_name
1884 # define EDITING_HAS_get_exe_name 0
1885 #endif
1886
1887
1888 #ifndef COMM_LEN
1889 # ifdef TASK_COMM_LEN
1890 enum { COMM_LEN = TASK_COMM_LEN };
1891 # else
1892 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1893 enum { COMM_LEN = 16 };
1894 # endif
1895 #endif
1896
1897 struct smaprec {
1898         unsigned long mapped_rw;
1899         unsigned long mapped_ro;
1900         unsigned long shared_clean;
1901         unsigned long shared_dirty;
1902         unsigned long private_clean;
1903         unsigned long private_dirty;
1904         unsigned long stack;
1905         unsigned long smap_pss, smap_swap;
1906         unsigned long smap_size;
1907         // For mixed 32/64 userspace, 32-bit pmap still needs
1908         // 64-bit field here to correctly show 64-bit processes:
1909         unsigned long long smap_start;
1910         // (strictly speaking, other fields need to be wider too,
1911         // but they are in kbytes, not bytes, and they hold sizes,
1912         // not start addresses, sizes tend to be less than 4 terabytes)
1913         char smap_mode[5];
1914         char *smap_name;
1915 };
1916
1917 #if !ENABLE_PMAP
1918 #define procps_read_smaps(pid, total, cb, data) \
1919         procps_read_smaps(pid, total)
1920 #endif
1921 int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1922                 void (*cb)(struct smaprec *, void *), void *data);
1923
1924 typedef struct procps_status_t {
1925         DIR *dir;
1926         IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
1927         uint8_t shift_pages_to_bytes;
1928         uint8_t shift_pages_to_kb;
1929 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1930         uint16_t argv_len;
1931         char *argv0;
1932         char *exe;
1933         IF_SELINUX(char *context;)
1934         IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
1935         /* Everything below must contain no ptrs to malloc'ed data:
1936          * it is memset(0) for each process in procps_scan() */
1937         unsigned long vsz, rss; /* we round it to kbytes */
1938         unsigned long stime, utime;
1939         unsigned long start_time;
1940         unsigned pid;
1941         unsigned ppid;
1942         unsigned pgid;
1943         unsigned sid;
1944         unsigned uid;
1945         unsigned gid;
1946 #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1947         unsigned ruid;
1948         unsigned rgid;
1949         int niceness;
1950 #endif
1951         unsigned tty_major,tty_minor;
1952 #if ENABLE_FEATURE_TOPMEM
1953         struct smaprec smaps;
1954 #endif
1955         char state[4];
1956         /* basename of executable in exec(2), read from /proc/N/stat
1957          * (if executable is symlink or script, it is NOT replaced
1958          * by link target or interpreter name) */
1959         char comm[COMM_LEN];
1960         /* user/group? - use passwd/group parsing functions */
1961 #if ENABLE_FEATURE_TOP_SMP_PROCESS
1962         int last_seen_on_cpu;
1963 #endif
1964 } procps_status_t;
1965 /* flag bits for procps_scan(xx, flags) calls */
1966 enum {
1967         PSSCAN_PID      = 1 << 0,
1968         PSSCAN_PPID     = 1 << 1,
1969         PSSCAN_PGID     = 1 << 2,
1970         PSSCAN_SID      = 1 << 3,
1971         PSSCAN_UIDGID   = 1 << 4,
1972         PSSCAN_COMM     = 1 << 5,
1973         /* PSSCAN_CMD      = 1 << 6, - use read_cmdline instead */
1974         PSSCAN_ARGV0    = 1 << 7,
1975         PSSCAN_EXE      = 1 << 8,
1976         PSSCAN_STATE    = 1 << 9,
1977         PSSCAN_VSZ      = 1 << 10,
1978         PSSCAN_RSS      = 1 << 11,
1979         PSSCAN_STIME    = 1 << 12,
1980         PSSCAN_UTIME    = 1 << 13,
1981         PSSCAN_TTY      = 1 << 14,
1982         PSSCAN_SMAPS    = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1983         /* NB: used by find_pid_by_name(). Any applet using it
1984          * needs to be mentioned here. */
1985         PSSCAN_ARGVN    = (1 << 16) * (ENABLE_KILLALL
1986                                 || ENABLE_PGREP || ENABLE_PKILL
1987                                 || ENABLE_PIDOF
1988                                 || ENABLE_SESTATUS
1989                                 ),
1990         PSSCAN_CONTEXT  = (1 << 17) * ENABLE_SELINUX,
1991         PSSCAN_START_TIME = 1 << 18,
1992         PSSCAN_CPU      = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1993         PSSCAN_NICE     = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1994         PSSCAN_RUIDGID  = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1995         PSSCAN_TASKS    = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
1996 };
1997 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1998 void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1999 procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
2000 /* Format cmdline (up to col chars) into char buf[size] */
2001 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
2002 void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
2003 pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
2004 pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
2005 int starts_with_cpu(const char *str) FAST_FUNC;
2006 unsigned get_cpu_count(void) FAST_FUNC;
2007
2008
2009 /* Use strict=1 if you process input from untrusted source:
2010  * it will return NULL on invalid %xx (bad hex chars)
2011  * and str + 1 if decoded char is / or NUL.
2012  * In non-strict mode, it always succeeds (returns str),
2013  * and also it additionally decoded '+' to space.
2014  */
2015 char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
2016
2017
2018 extern const char bb_uuenc_tbl_base64[] ALIGN1;
2019 extern const char bb_uuenc_tbl_std[] ALIGN1;
2020 void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
2021 enum {
2022         BASE64_FLAG_UU_STOP = 0x100,
2023         /* Sign-extends to a value which never matches fgetc result: */
2024         BASE64_FLAG_NO_STOP_CHAR = 0x80,
2025 };
2026 const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
2027 void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
2028
2029 typedef struct md5_ctx_t {
2030         uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
2031         void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
2032         uint64_t total64;    /* must be directly before hash[] */
2033         uint32_t hash[8];    /* 4 elements for md5, 5 for sha1, 8 for sha256 */
2034 } md5_ctx_t;
2035 typedef struct md5_ctx_t sha1_ctx_t;
2036 typedef struct md5_ctx_t sha256_ctx_t;
2037 typedef struct sha512_ctx_t {
2038         uint64_t total64[2];  /* must be directly before hash[] */
2039         uint64_t hash[8];
2040         uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
2041 } sha512_ctx_t;
2042 typedef struct sha3_ctx_t {
2043         uint64_t state[25];
2044         unsigned bytes_queued;
2045         unsigned input_block_bytes;
2046 } sha3_ctx_t;
2047 void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
2048 void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
2049 unsigned md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
2050 void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
2051 #define sha1_hash md5_hash
2052 unsigned sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
2053 void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
2054 #define sha256_hash md5_hash
2055 #define sha256_end  sha1_end
2056 void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
2057 void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
2058 unsigned sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
2059 void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
2060 void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
2061 unsigned sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
2062 /* TLS benefits from knowing that sha1 and sha256 share these. Give them "agnostic" names too */
2063 typedef struct md5_ctx_t md5sha_ctx_t;
2064 #define md5sha_hash md5_hash
2065 #define sha_end sha1_end
2066
2067 extern uint32_t *global_crc32_table;
2068 uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
2069 uint32_t *crc32_new_table_le(void) FAST_FUNC;
2070 uint32_t *global_crc32_new_table_le(void) FAST_FUNC;
2071 uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
2072 uint32_t crc32_block_endian0(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
2073
2074 typedef struct masks_labels_t {
2075         const char *labels;
2076         const int masks[];
2077 } masks_labels_t;
2078 int print_flags_separated(const int *masks, const char *labels,
2079                 int flags, const char *separator) FAST_FUNC;
2080 int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
2081
2082 typedef struct bb_progress_t {
2083         unsigned last_size;
2084         unsigned last_update_sec;
2085         unsigned last_change_sec;
2086         unsigned start_sec;
2087         /*unsigned last_eta;*/
2088         const char *curfile;
2089 } bb_progress_t;
2090
2091 #define is_bb_progress_inited(p) ((p)->curfile != NULL)
2092 #define bb_progress_free(p) do { \
2093         if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
2094         (p)->curfile = NULL; \
2095 } while (0)
2096 void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
2097 int bb_progress_update(bb_progress_t *p,
2098                         uoff_t beg_range,
2099                         uoff_t transferred,
2100                         uoff_t totalsize) FAST_FUNC;
2101
2102 unsigned ubi_devnum_from_devname(const char *str) FAST_FUNC;
2103 int ubi_get_volid_by_name(unsigned ubi_devnum, const char *vol_name) FAST_FUNC;
2104
2105
2106 extern const char *applet_name;
2107
2108 /* Some older linkers don't perform string merging, we used to have common strings
2109  * as global arrays to do it by hand. But:
2110  * (1) newer linkers do it themselves,
2111  * (2) however, they DONT merge string constants with global arrays,
2112  * even if the value is the same (!). Thus global arrays actually
2113  * increased size a bit: for example, "/etc/passwd" string from libc
2114  * wasn't merged with bb_path_passwd_file[] array!
2115  * Therefore now we use #defines.
2116  */
2117 /* "BusyBox vN.N.N (timestamp or extra_version)" */
2118 extern const char bb_banner[] ALIGN1;
2119 extern const char bb_msg_memory_exhausted[] ALIGN1;
2120 extern const char bb_msg_invalid_date[] ALIGN1;
2121 #define bb_msg_read_error "read error"
2122 #define bb_msg_write_error "write error"
2123 extern const char bb_msg_unknown[] ALIGN1;
2124 extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
2125 extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
2126 extern const char bb_msg_you_must_be_root[] ALIGN1;
2127 extern const char bb_msg_requires_arg[] ALIGN1;
2128 extern const char bb_msg_invalid_arg_to[] ALIGN1;
2129 extern const char bb_msg_standard_input[] ALIGN1;
2130 extern const char bb_msg_standard_output[] ALIGN1;
2131
2132 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
2133 extern const char bb_hexdigits_upcase[] ALIGN1;
2134
2135 extern const char bb_path_wtmp_file[] ALIGN1;
2136
2137 /* Busybox mount uses either /proc/mounts or /etc/mtab to
2138  * get the list of currently mounted filesystems */
2139 #define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
2140
2141 #define bb_path_passwd_file  _PATH_PASSWD
2142 #define bb_path_group_file   _PATH_GROUP
2143 #define bb_path_shadow_file  _PATH_SHADOW
2144 #define bb_path_gshadow_file _PATH_GSHADOW
2145
2146 #define bb_path_motd_file "/etc/motd"
2147
2148 #define bb_dev_null "/dev/null"
2149 extern const char bb_busybox_exec_path[] ALIGN1;
2150 /* allow default system PATH to be extended via CFLAGS */
2151 #ifndef BB_ADDITIONAL_PATH
2152 #define BB_ADDITIONAL_PATH ""
2153 #endif
2154 #define BB_PATH_ROOT_PATH "PATH=/sbin:/usr/sbin:/bin:/usr/bin" BB_ADDITIONAL_PATH
2155 extern const char bb_PATH_root_path[] ALIGN1; /* BB_PATH_ROOT_PATH */
2156 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
2157 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
2158  * but I want to save a few bytes here:
2159  */
2160 #define bb_default_path      (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
2161
2162 extern const int const_int_0;
2163 //extern const int const_int_1;
2164
2165 /* This struct is deliberately not defined. */
2166 /* See docs/keep_data_small.txt */
2167 struct globals;
2168 /* '*const' ptr makes gcc optimize code much better.
2169  * Magic prevents ptr_to_globals from going into rodata.
2170  * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
2171 extern struct globals *const ptr_to_globals;
2172
2173 #if defined(__clang_major__) && __clang_major__ >= 9
2174 /* Clang/llvm drops assignment to "constant" storage. Silently.
2175  * Needs serious convincing to not eliminate the store.
2176  */
2177 static ALWAYS_INLINE void* not_const_pp(const void *p)
2178 {
2179         void *pp;
2180         __asm__ __volatile__(
2181                 "# forget that p points to const"
2182                 : /*outputs*/ "=r" (pp)
2183                 : /*inputs*/ "0" (p)
2184         );
2185         return pp;
2186 }
2187 #else
2188 static ALWAYS_INLINE void* not_const_pp(const void *p) { return (void*)p; }
2189 #endif
2190
2191 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
2192 #define barrier() __asm__ __volatile__("":::"memory")
2193 #define SET_PTR_TO_GLOBALS(x) do { \
2194         (*(struct globals**)not_const_pp(&ptr_to_globals)) = (void*)(x); \
2195         barrier(); \
2196 } while (0)
2197
2198 #define FREE_PTR_TO_GLOBALS() do { \
2199         if (ENABLE_FEATURE_CLEAN_UP) { \
2200                 free(ptr_to_globals); \
2201         } \
2202 } while (0)
2203
2204 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
2205  * use bb_default_login_shell and following defines.
2206  * If you change LIBBB_DEFAULT_LOGIN_SHELL,
2207  * don't forget to change increment constant. */
2208 #define LIBBB_DEFAULT_LOGIN_SHELL  "-/bin/sh"
2209 extern const char bb_default_login_shell[] ALIGN1;
2210 /* "/bin/sh" */
2211 #define DEFAULT_SHELL              (bb_default_login_shell+1)
2212 /* "sh" */
2213 #define DEFAULT_SHELL_SHORT_NAME   (bb_default_login_shell+6)
2214
2215 /* The following devices are the same on all systems.  */
2216 #define CURRENT_TTY "/dev/tty"
2217 #define DEV_CONSOLE "/dev/console"
2218
2219 #if defined(__FreeBSD_kernel__)
2220 # define CURRENT_VC CURRENT_TTY
2221 # define VC_1 "/dev/ttyv0"
2222 # define VC_2 "/dev/ttyv1"
2223 # define VC_3 "/dev/ttyv2"
2224 # define VC_4 "/dev/ttyv3"
2225 # define VC_5 "/dev/ttyv4"
2226 # define VC_FORMAT "/dev/ttyv%d"
2227 #elif defined(__GNU__)
2228 # define CURRENT_VC CURRENT_TTY
2229 # define VC_1 "/dev/tty1"
2230 # define VC_2 "/dev/tty2"
2231 # define VC_3 "/dev/tty3"
2232 # define VC_4 "/dev/tty4"
2233 # define VC_5 "/dev/tty5"
2234 # define VC_FORMAT "/dev/tty%d"
2235 #elif ENABLE_FEATURE_DEVFS
2236 /*Linux, obsolete devfs names */
2237 # define CURRENT_VC "/dev/vc/0"
2238 # define VC_1 "/dev/vc/1"
2239 # define VC_2 "/dev/vc/2"
2240 # define VC_3 "/dev/vc/3"
2241 # define VC_4 "/dev/vc/4"
2242 # define VC_5 "/dev/vc/5"
2243 # define VC_FORMAT "/dev/vc/%d"
2244 # define LOOP_FORMAT "/dev/loop/%u"
2245 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
2246 # define LOOP_NAME "/dev/loop/"
2247 # define FB_0 "/dev/fb/0"
2248 #else
2249 /*Linux, normal names */
2250 # define CURRENT_VC "/dev/tty0"
2251 # define VC_1 "/dev/tty1"
2252 # define VC_2 "/dev/tty2"
2253 # define VC_3 "/dev/tty3"
2254 # define VC_4 "/dev/tty4"
2255 # define VC_5 "/dev/tty5"
2256 # define VC_FORMAT "/dev/tty%d"
2257 # define LOOP_FORMAT "/dev/loop%u"
2258 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
2259 # define LOOP_NAME "/dev/loop"
2260 # define FB_0 "/dev/fb0"
2261 #endif
2262
2263 // storage helpers for mk*fs utilities
2264 char BUG_wrong_field_size(void);
2265 #define STORE_LE(field, value) \
2266 do { \
2267         if (sizeof(field) == 4) \
2268                 field = SWAP_LE32((uint32_t)(value)); \
2269         else if (sizeof(field) == 2) \
2270                 field = SWAP_LE16((uint16_t)(value)); \
2271         else if (sizeof(field) == 1) \
2272                 field = (uint8_t)(value); \
2273         else \
2274                 BUG_wrong_field_size(); \
2275 } while (0)
2276
2277 #define FETCH_LE32(field) \
2278         (sizeof(field) == 4 ? SWAP_LE32(field) : BUG_wrong_field_size())
2279
2280
2281 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
2282 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
2283
2284
2285 /* We redefine ctype macros. Unicode-correct handling of char types
2286  * can't be done with such byte-oriented operations anyway,
2287  * we don't lose anything.
2288  */
2289 #undef isalnum
2290 #undef isalpha
2291 #undef isascii
2292 #undef isblank
2293 #undef iscntrl
2294 #undef isdigit
2295 #undef isgraph
2296 #undef islower
2297 #undef isprint
2298 #undef ispunct
2299 #undef isspace
2300 #undef isupper
2301 #undef isxdigit
2302 #undef toupper
2303 #undef tolower
2304
2305 /* We save ~500 bytes on isdigit alone.
2306  * BTW, x86 likes (unsigned char) cast more than (unsigned). */
2307
2308 /* These work the same for ASCII and Unicode,
2309  * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
2310 #define isascii(a) ((unsigned char)(a) <= 0x7f)
2311 #define isdigit(a) ((unsigned char)((a) - '0') <= 9)
2312 #define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
2313 #define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
2314 #define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
2315 #define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
2316 #define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
2317 /* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
2318  * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
2319  */
2320 #define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
2321 // Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
2322 #define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
2323 // Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
2324 #define isalnum(a) bb_ascii_isalnum(a)
2325 static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
2326 {
2327         unsigned char b = a - '0';
2328         if (b <= 9)
2329                 return (b <= 9);
2330         b = (a|0x20) - 'a';
2331         return b <= 'z' - 'a';
2332 }
2333 #define isxdigit(a) bb_ascii_isxdigit(a)
2334 static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
2335 {
2336         unsigned char b = a - '0';
2337         if (b <= 9)
2338                 return (b <= 9);
2339         b = (a|0x20) - 'a';
2340         return b <= 'f' - 'a';
2341 }
2342 #define toupper(a) bb_ascii_toupper(a)
2343 static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
2344 {
2345         unsigned char b = a - 'a';
2346         if (b <= ('z' - 'a'))
2347                 a -= 'a' - 'A';
2348         return a;
2349 }
2350 #define tolower(a) bb_ascii_tolower(a)
2351 static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
2352 {
2353         unsigned char b = a - 'A';
2354         if (b <= ('Z' - 'A'))
2355                 a += 'a' - 'A';
2356         return a;
2357 }
2358
2359 /* In ASCII and Unicode, these are likely to be very different.
2360  * Let's prevent ambiguous usage from the start */
2361 #define isgraph(a) isgraph_is_ambiguous_dont_use(a)
2362 #define isprint(a) isprint_is_ambiguous_dont_use(a)
2363 /* NB: must not treat EOF as isgraph or isprint */
2364 #define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
2365 #define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
2366
2367
2368 /* Simple unit-testing framework */
2369
2370 typedef void (*bbunit_testfunc)(void);
2371
2372 struct bbunit_listelem {
2373         const char* name;
2374         bbunit_testfunc testfunc;
2375 };
2376
2377 void bbunit_registertest(struct bbunit_listelem* test);
2378 void bbunit_settestfailed(void);
2379
2380 #define BBUNIT_DEFINE_TEST(NAME) \
2381         static void bbunit_##NAME##_test(void); \
2382         static struct bbunit_listelem bbunit_##NAME##_elem = { \
2383                 .name = #NAME, \
2384                 .testfunc = bbunit_##NAME##_test, \
2385         }; \
2386         static void INIT_FUNC bbunit_##NAME##_register(void) \
2387         { \
2388                 bbunit_registertest(&bbunit_##NAME##_elem); \
2389         } \
2390         static void bbunit_##NAME##_test(void)
2391
2392 /*
2393  * Both 'goto bbunit_end' and 'break' are here only to get rid
2394  * of compiler warnings.
2395  */
2396 #define BBUNIT_ENDTEST \
2397         do { \
2398                 goto bbunit_end; \
2399         bbunit_end: \
2400                 break; \
2401         } while (0)
2402
2403 #define BBUNIT_PRINTASSERTFAIL \
2404         do { \
2405                 bb_error_msg( \
2406                         "[ERROR] Assertion failed in file %s, line %d", \
2407                         __FILE__, __LINE__); \
2408         } while (0)
2409
2410 #define BBUNIT_ASSERTION_FAILED \
2411         do { \
2412                 bbunit_settestfailed(); \
2413                 goto bbunit_end; \
2414         } while (0)
2415
2416 /*
2417  * Assertions.
2418  * For now we only offer assertions which cause tests to fail
2419  * immediately. In the future 'expects' might be added too -
2420  * similar to those offered by the gtest framework.
2421  */
2422 #define BBUNIT_ASSERT_EQ(EXPECTED, ACTUAL) \
2423         do { \
2424                 if ((EXPECTED) != (ACTUAL)) { \
2425                         BBUNIT_PRINTASSERTFAIL; \
2426                         bb_error_msg("[ERROR] '%s' isn't equal to '%s'", \
2427                                                 #EXPECTED, #ACTUAL); \
2428                         BBUNIT_ASSERTION_FAILED; \
2429                 } \
2430         } while (0)
2431
2432 #define BBUNIT_ASSERT_NOTEQ(EXPECTED, ACTUAL) \
2433         do { \
2434                 if ((EXPECTED) == (ACTUAL)) { \
2435                         BBUNIT_PRINTASSERTFAIL; \
2436                         bb_error_msg("[ERROR] '%s' is equal to '%s'", \
2437                                                 #EXPECTED, #ACTUAL); \
2438                         BBUNIT_ASSERTION_FAILED; \
2439                 } \
2440         } while (0)
2441
2442 #define BBUNIT_ASSERT_NOTNULL(PTR) \
2443         do { \
2444                 if ((PTR) == NULL) { \
2445                         BBUNIT_PRINTASSERTFAIL; \
2446                         bb_error_msg("[ERROR] '%s' is NULL!", #PTR); \
2447                         BBUNIT_ASSERTION_FAILED; \
2448                 } \
2449         } while (0)
2450
2451 #define BBUNIT_ASSERT_NULL(PTR) \
2452         do { \
2453                 if ((PTR) != NULL) { \
2454                         BBUNIT_PRINTASSERTFAIL; \
2455                         bb_error_msg("[ERROR] '%s' is not NULL!", #PTR); \
2456                         BBUNIT_ASSERTION_FAILED; \
2457                 } \
2458         } while (0)
2459
2460 #define BBUNIT_ASSERT_FALSE(STATEMENT) \
2461         do { \
2462                 if ((STATEMENT)) { \
2463                         BBUNIT_PRINTASSERTFAIL; \
2464                         bb_error_msg("[ERROR] Statement '%s' evaluated to true!", \
2465                                                                 #STATEMENT); \
2466                         BBUNIT_ASSERTION_FAILED; \
2467                 } \
2468         } while (0)
2469
2470 #define BBUNIT_ASSERT_TRUE(STATEMENT) \
2471         do { \
2472                 if (!(STATEMENT)) { \
2473                         BBUNIT_PRINTASSERTFAIL; \
2474                         bb_error_msg("[ERROR] Statement '%s' evaluated to false!", \
2475                                         #STATEMENT); \
2476                         BBUNIT_ASSERTION_FAILED; \
2477                 } \
2478         } while (0)
2479
2480 #define BBUNIT_ASSERT_STREQ(STR1, STR2) \
2481         do { \
2482                 if (strcmp(STR1, STR2) != 0) { \
2483                         BBUNIT_PRINTASSERTFAIL; \
2484                         bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2485                                         "are not the same", STR1, STR2); \
2486                         BBUNIT_ASSERTION_FAILED; \
2487                 } \
2488         } while (0)
2489
2490 #define BBUNIT_ASSERT_STRNOTEQ(STR1, STR2) \
2491         do { \
2492                 if (strcmp(STR1, STR2) == 0) { \
2493                         BBUNIT_PRINTASSERTFAIL; \
2494                         bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2495                                         "are the same, but were " \
2496                                         "expected to differ", STR1, STR2); \
2497                         BBUNIT_ASSERTION_FAILED; \
2498                 } \
2499         } while (0)
2500
2501
2502 POP_SAVED_FUNCTION_VISIBILITY
2503
2504 #endif