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