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