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