1 /* vi: set sw=4 ts=4: */
3 * Busybox main internal header file
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.
8 * Licensed under GPLv2, see file LICENSE in this source tree.
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)
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 */
40 #define basename dont_use_basename
42 #include <sys/ioctl.h>
44 #include <sys/socket.h>
47 #include <sys/types.h>
49 # include <sys/sysmacros.h>
54 #include <sys/param.h>
57 #if ENABLE_FEATURE_SHADOWPASSWDS
58 # if !ENABLE_USE_BB_SHADOW
59 /* If using busybox's shadow implementation, do not include the shadow.h
60 * header as the toolchain may not provide it at all.
65 #if defined(ANDROID) || defined(__ANDROID__)
66 # define endpwent() ((void)0)
67 # define endgrent() ((void)0)
72 #ifdef HAVE_SYS_STATFS_H
73 # include <sys/statfs.h>
75 /* Don't do this here:
76 * #include <sys/sysinfo.h>
77 * Some linux/ includes pull in conflicting definition
78 * of struct sysinfo (only in some toolchanins), which breaks build.
79 * Include sys/sysinfo.h only in those files which need it.
82 # include <selinux/selinux.h>
83 # include <selinux/context.h>
84 # include <selinux/flask.h>
85 # include <selinux/av_permissions.h>
87 #if ENABLE_FEATURE_UTMP
88 # if defined __UCLIBC__ && ( \
89 (UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 32) \
90 && UCLIBC_VERSION < KERNEL_VERSION(0, 9, 34) \
91 && defined __UCLIBC_HAS_UTMPX__ \
93 UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 34) \
97 # elif defined __UCLIBC__
100 # define setutxent setutent
101 # define endutxent endutent
102 # define getutxent getutent
103 # define getutxid getutid
104 # define getutxline getutline
105 # define pututxline pututline
106 # define utmpxname utmpname
107 # define updwtmpx updwtmp
108 # define _PATH_UTMPX _PATH_UTMP
112 # if defined _PATH_UTMP && !defined _PATH_UTMPX
113 # define _PATH_UTMPX _PATH_UTMP
117 #if ENABLE_LOCALE_SUPPORT
120 # define setlocale(x,y) ((void)0)
123 # include <dmalloc.h>
125 /* Just in case libc doesn't define some of these... */
127 #define _PATH_PASSWD "/etc/passwd"
130 #define _PATH_GROUP "/etc/group"
133 #define _PATH_SHADOW "/etc/shadow"
135 #ifndef _PATH_GSHADOW
136 #define _PATH_GSHADOW "/etc/gshadow"
138 #if defined __FreeBSD__ || defined __OpenBSD__
139 # include <netinet/in.h>
140 # include <arpa/inet.h>
141 #elif defined __APPLE__
142 # include <netinet/in.h>
144 # include <arpa/inet.h>
145 //This breaks on bionic:
146 //# if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
147 ///* We #define socklen_t *after* includes, otherwise we get
148 // * typedef redefinition errors from system headers
149 // * (in case "is it defined already" detection above failed)
151 //# define socklen_t bb_socklen_t
152 // typedef unsigned socklen_t;
154 //if this is still needed, add a fix along the lines of
155 // ifdef SPECIFIC_BROKEN_LIBC_CHECK / typedef socklen_t / endif
156 //in platform.h instead!
158 #ifndef HAVE_CLEARENV
159 # define clearenv() do { if (environ) environ[0] = NULL; } while (0)
161 #ifndef HAVE_FDATASYNC
162 # define fdatasync fsync
169 /* Some libc's forget to declare these, do it ourself */
171 extern char **environ;
172 #if defined(__GLIBC__) && __GLIBC__ < 2
173 int vdprintf(int d, const char *format, va_list ap);
175 /* klogctl is in libc's klog.h, but we cheat and not #include that */
176 int klogctl(int type, char *b, int len);
178 # define PATH_MAX 256
185 /* Busybox does not use threads, we can speed up stdio. */
186 #ifdef HAVE_UNLOCKED_STDIO
188 # define getc(stream) getc_unlocked(stream)
190 # define getchar() getchar_unlocked()
192 # define putc(c,stream) putc_unlocked(c,stream)
194 # define putchar(c) putchar_unlocked(c)
196 # define fgetc(stream) getc_unlocked(stream)
198 # define fputc(c,stream) putc_unlocked(c,stream)
200 /* Above functions are required by POSIX.1-2008, below ones are extensions */
201 #ifdef HAVE_UNLOCKED_LINE_OPS
203 # define fgets(s,n,stream) fgets_unlocked(s,n,stream)
205 # define fputs(s,stream) fputs_unlocked(s,stream)
206 /* musl <= 1.1.15 does not support fflush_unlocked(NULL) */
208 //# define fflush(stream) fflush_unlocked(stream)
210 # define feof(stream) feof_unlocked(stream)
212 # define ferror(stream) ferror_unlocked(stream)
214 # define fileno(stream) fileno_unlocked(stream)
218 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
219 /* (don't include system headers after this until corresponding pop!) */
220 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
223 #if ENABLE_USE_BB_PWD_GRP
227 #if ENABLE_FEATURE_SHADOWPASSWDS
228 # if ENABLE_USE_BB_SHADOW
229 # include "shadow_.h"
233 /* Tested to work correctly with all int types (IIRC :]) */
234 #define MAXINT(T) (T)( \
237 : (T)~((T)1 << (sizeof(T)*8-1)) \
240 #define MININT(T) (T)( \
243 : ((T)1 << (sizeof(T)*8-1)) \
246 /* Large file support */
247 /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
248 * (stat, lseek etc) mapped to "largefile" variants by libc.
249 * Practically it means that open() automatically has O_LARGEFILE added
250 * and all filesize/file_offset parameters and struct members are "large"
251 * (in today's world - signed 64bit). For full support of large files,
252 * we need a few helper #defines (below) and careful use of off_t
253 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
255 /* CONFIG_LFS is on */
256 # if ULONG_MAX > 0xffffffff
257 /* "long" is long enough on this system */
258 typedef unsigned long uoff_t;
259 # define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
260 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
261 # define BB_STRTOOFF bb_strtoul
262 # define STRTOOFF strtoul
263 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
266 /* "long" is too short, need "long long" */
267 typedef unsigned long long uoff_t;
268 # define XATOOFF(a) xatoull_range((a), 0, LLONG_MAX)
269 # define BB_STRTOOFF bb_strtoull
270 # define STRTOOFF strtoull
271 # define OFF_FMT "ll"
274 /* CONFIG_LFS is off */
275 # if UINT_MAX == 0xffffffff
276 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
277 * gcc will throw warnings on printf("%d", off_t). Crap... */
278 typedef unsigned long uoff_t;
279 # define XATOOFF(a) xatoi_positive(a)
280 # define BB_STRTOOFF bb_strtou
281 # define STRTOOFF strtol
284 typedef unsigned long uoff_t;
285 # define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
286 # define BB_STRTOOFF bb_strtoul
287 # define STRTOOFF strtol
291 /* scary. better ideas? (but do *test* them first!) */
292 #define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
293 /* Users report bionic to use 32-bit off_t even if LARGEFILE support is requested.
294 * We misdetected that. Don't let it build:
296 struct BUG_off_t_size_is_misdetected {
297 char BUG_off_t_size_is_misdetected[sizeof(off_t) == sizeof(uoff_t) ? 1 : -1];
300 /* Some useful definitions */
302 #define FALSE ((int) 0)
304 #define TRUE ((int) 1)
306 #define SKIP ((int) 2)
308 /* Macros for min/max. */
310 #define MIN(a,b) (((a)<(b))?(a):(b))
314 #define MAX(a,b) (((a)>(b))?(a):(b))
317 /* buffer allocation schemes */
318 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
319 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
320 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
321 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
323 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
324 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
325 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
326 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
328 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
329 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
330 #define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
334 #if defined(__GLIBC__)
335 /* glibc uses __errno_location() to get a ptr to errno */
336 /* We can just memorize it once - no multithreading in busybox :) */
337 extern int *const bb_errno;
339 #define errno (*bb_errno)
342 #if !(ULONG_MAX > 0xffffffff)
343 /* Only 32-bit CPUs need this, 64-bit ones use inlined version */
344 uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
347 unsigned long long monotonic_ns(void) FAST_FUNC;
348 unsigned long long monotonic_us(void) FAST_FUNC;
349 unsigned long long monotonic_ms(void) FAST_FUNC;
350 unsigned monotonic_sec(void) FAST_FUNC;
352 extern void chomp(char *s) FAST_FUNC;
353 extern void trim(char *s) FAST_FUNC;
354 extern char *skip_whitespace(const char *) FAST_FUNC;
355 extern char *skip_non_whitespace(const char *) FAST_FUNC;
356 extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
358 extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
360 //TODO: supply a pointer to char[11] buffer (avoid statics)?
361 extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
362 extern int is_directory(const char *name, int followLinks) FAST_FUNC;
363 enum { /* cp.c, mv.c, install.c depend on these values. CAREFUL when changing them! */
364 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
365 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
366 FILEUTILS_RECUR = 1 << 2, /* -R */
367 FILEUTILS_FORCE = 1 << 3, /* -f */
368 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
369 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
370 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
371 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
372 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
373 /* -a = -pdR (mapped in cp.c) */
374 /* -r = -dR (mapped in cp.c) */
375 /* -P = -d (mapped in cp.c) */
376 FILEUTILS_VERBOSE = (1 << 12) * ENABLE_FEATURE_VERBOSE, /* -v */
377 FILEUTILS_UPDATE = 1 << 13, /* -u */
379 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 14, /* -c */
381 FILEUTILS_RMDEST = 1 << (15 - !ENABLE_SELINUX), /* --remove-destination */
383 * Hole. cp may have some bits set here,
384 * they should not affect remove_file()/copy_file()
387 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 30,
389 FILEUTILS_IGNORE_CHMOD_ERR = 1 << 31,
391 #define FILEUTILS_CP_OPTSTR "pdRfilsLHarPvu" IF_SELINUX("c")
392 extern int remove_file(const char *path, int flags) FAST_FUNC;
393 /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
394 * the source, not copy (unless "source" is a directory).
395 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
396 * work coreutils-compatibly. */
397 extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
400 ACTION_RECURSE = (1 << 0),
401 ACTION_FOLLOWLINKS = (1 << 1),
402 ACTION_FOLLOWLINKS_L0 = (1 << 2),
403 ACTION_DEPTHFIRST = (1 << 3),
404 /*ACTION_REVERSE = (1 << 4), - unused */
405 ACTION_QUIET = (1 << 5),
406 ACTION_DANGLING_OK = (1 << 6),
408 typedef uint8_t recurse_flags_t;
409 extern int recursive_action(const char *fileName, unsigned flags,
410 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
411 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
412 void* userData, unsigned depth) FAST_FUNC;
413 extern int device_open(const char *device, int mode) FAST_FUNC;
414 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
415 extern int xgetpty(char *line) FAST_FUNC;
416 extern int get_console_fd_or_die(void) FAST_FUNC;
417 extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
418 extern char *find_block_device(const char *path) FAST_FUNC;
419 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
420 extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
421 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
422 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
423 /* "short" copy can be detected by return value < size */
424 /* this helper yells "short read!" if param is not -1 */
425 extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
427 extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
428 char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
429 /* xxxx_strip version can modify its parameter:
433 * "abc/def/" -> "def" !!
435 char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
436 /* "abc/def/" -> "" and it never modifies 'path' */
437 char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
438 /* Simpler version: does not special case "/" string */
439 const char *bb_basename(const char *name) FAST_FUNC;
440 /* NB: can violate const-ness (similarly to strchr) */
441 char *last_char_is(const char *s, int c) FAST_FUNC;
442 const char* endofname(const char *name) FAST_FUNC;
443 char *is_prefixed_with(const char *string, const char *key) FAST_FUNC;
444 char *is_suffixed_with(const char *string, const char *key) FAST_FUNC;
446 int ndelay_on(int fd) FAST_FUNC;
447 int ndelay_off(int fd) FAST_FUNC;
448 void close_on_exec_on(int fd) FAST_FUNC;
449 void xdup2(int, int) FAST_FUNC;
450 void xmove_fd(int, int) FAST_FUNC;
453 DIR *xopendir(const char *path) FAST_FUNC;
454 DIR *warn_opendir(const char *path) FAST_FUNC;
456 char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
457 char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
458 char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
459 /* !RETURNS_MALLOC: it's a realloc-like function */
460 char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
462 char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
466 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
467 * otherwise would kill us, except for those resulting from bugs:
468 * SIGSEGV, SIGILL, SIGFPE.
469 * Other fatal signals not included (TODO?):
470 * SIGBUS Bus error (bad memory access)
471 * SIGPOLL Pollable event. Synonym of SIGIO
472 * SIGPROF Profiling timer expired
473 * SIGSYS Bad argument to routine
474 * SIGTRAP Trace/breakpoint trap
476 * The only known arch with some of these sigs not fitting
477 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
478 * Dance around with long long to guard against that...
480 BB_FATAL_SIGS = (int)(0
484 + (1LL << SIGPIPE) // Write to pipe with no readers
485 + (1LL << SIGQUIT) // Quit from keyboard
486 + (1LL << SIGABRT) // Abort signal from abort(3)
487 + (1LL << SIGALRM) // Timer signal from alarm(2)
488 + (1LL << SIGVTALRM) // Virtual alarm clock
489 + (1LL << SIGXCPU) // CPU time limit exceeded
490 + (1LL << SIGXFSZ) // File size limit exceeded
491 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
495 void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
496 /* Unlike signal() and bb_signals, sets handler with sigaction()
497 * and in a way that while signal handler is run, no other signals
498 * will be blocked; syscalls will not be restarted: */
499 void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
500 /* syscalls like read() will be interrupted with EINTR: */
501 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
502 /* syscalls like read() won't be interrupted (though select/poll will be): */
503 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
504 void wait_for_any_sig(void) FAST_FUNC;
505 void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
506 void sig_block(int sig) FAST_FUNC;
507 void sig_unblock(int sig) FAST_FUNC;
508 /* Will do sigaction(signum, act, NULL): */
509 int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
510 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
511 int sigprocmask_allsigs(int how) FAST_FUNC;
512 /* Standard handler which just records signo */
513 extern smallint bb_got_signal;
514 void record_signo(int signo); /* not FAST_FUNC! */
517 void xsetgid(gid_t gid) FAST_FUNC;
518 void xsetuid(uid_t uid) FAST_FUNC;
519 void xsetegid(gid_t egid) FAST_FUNC;
520 void xseteuid(uid_t euid) FAST_FUNC;
521 void xchdir(const char *path) FAST_FUNC;
522 void xfchdir(int fd) FAST_FUNC;
523 void xchroot(const char *path) FAST_FUNC;
524 void xsetenv(const char *key, const char *value) FAST_FUNC;
525 void bb_unsetenv(const char *key) FAST_FUNC;
526 void bb_unsetenv_and_free(char *key) FAST_FUNC;
527 void xunlink(const char *pathname) FAST_FUNC;
528 void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
529 void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
530 int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
531 int open_or_warn(const char *pathname, int flags) FAST_FUNC;
532 int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
533 int xopen(const char *pathname, int flags) FAST_FUNC;
534 int xopen_nonblocking(const char *pathname) FAST_FUNC;
535 int xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g) FAST_FUNC;
536 int open_or_warn_stdin(const char *pathname) FAST_FUNC;
537 int xopen_stdin(const char *pathname) FAST_FUNC;
538 void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
539 int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
540 off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
541 int xmkstemp(char *template) FAST_FUNC;
542 off_t fdlength(int fd) FAST_FUNC;
544 uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
545 const char *override,
546 unsigned override_units,
549 void xpipe(int filedes[2]) FAST_FUNC;
550 /* In this form code with pipes is much more readable */
551 struct fd_pair { int rd; int wr; };
552 #define piped_pair(pair) pipe(&((pair).rd))
553 #define xpiped_pair(pair) xpipe(&((pair).rd))
555 /* Useful for having small structure members/global variables */
556 typedef int8_t socktype_t;
557 typedef int8_t family_t;
558 struct BUG_too_small {
559 char BUG_socktype_t_too_small[(0
566 char BUG_family_t_too_small[(0
583 void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
584 time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
585 char *strftime_HHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
586 char *strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
588 int xsocket(int domain, int type, int protocol) FAST_FUNC;
589 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
590 void xlisten(int s, int backlog) FAST_FUNC;
591 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
592 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
593 socklen_t tolen) FAST_FUNC;
595 int setsockopt_int(int fd, int level, int optname, int optval) FAST_FUNC;
596 int setsockopt_1(int fd, int level, int optname) FAST_FUNC;
597 int setsockopt_SOL_SOCKET_int(int fd, int optname, int optval) FAST_FUNC;
598 int setsockopt_SOL_SOCKET_1(int fd, int optname) FAST_FUNC;
599 /* SO_REUSEADDR allows a server to rebind to an address that is already
600 * "in use" by old connections to e.g. previous server instance which is
601 * killed or crashed. Without it bind will fail until all such connections
602 * time out. Linux does not allow multiple live binds on same ip:port
603 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
604 * Turn it on before you call bind(). */
605 void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
606 int setsockopt_keepalive(int fd) FAST_FUNC;
607 int setsockopt_broadcast(int fd) FAST_FUNC;
608 int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
609 /* NB: returns port in host byte order */
610 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
611 typedef struct len_and_sockaddr {
615 struct sockaddr_in sin;
616 #if ENABLE_FEATURE_IPV6
617 struct sockaddr_in6 sin6;
622 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
623 LSA_SIZEOF_SA = sizeof(
626 struct sockaddr_in sin;
627 #if ENABLE_FEATURE_IPV6
628 struct sockaddr_in6 sin6;
633 /* Create stream socket, and allocate suitable lsa.
634 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
635 * af == AF_UNSPEC will result in trying to create IPv6 socket,
636 * and if kernel doesn't support it, fall back to IPv4.
637 * This is useful if you plan to bind to resulting local lsa.
639 int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
640 int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
641 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
642 * numeric IP ("N.N.N.N") or numeric IPv6 address,
643 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
644 * Only if there is no suffix, port argument is used */
645 /* NB: these set SO_REUSEADDR before bind */
646 int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
647 int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
648 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
649 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
650 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
651 * If there is no suffix, port argument is used */
652 int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
653 /* Connect to peer identified by lsa */
654 int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
655 /* Get local address of bound or accepted socket */
656 len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
657 /* Get remote address of connected or accepted socket */
658 len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
659 /* Return malloc'ed len_and_sockaddr with socket address of host:port
660 * Currently will return IPv4 or IPv6 sockaddrs only
661 * (depending on host), but in theory nothing prevents e.g.
662 * UNIX socket address being returned, IPX sockaddr etc...
663 * On error does bb_error_msg and returns NULL */
664 len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
665 /* Version which dies on error */
666 len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
667 len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
668 /* Same, useful if you want to force family (e.g. IPv6) */
669 #if !ENABLE_FEATURE_IPV6
670 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
671 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
673 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
674 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
676 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
677 * otherwise no-op. Useful for ftp.
678 * NB: does NOT do htons() internally, just direct assignment. */
679 void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
680 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
681 int get_nport(const struct sockaddr *sa) FAST_FUNC;
682 /* Reverse DNS. Returns NULL on failure. */
683 char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
684 /* This one doesn't append :PORTNUM */
685 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
686 /* This one also doesn't fall back to dotted IP (returns NULL) */
687 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
688 /* inet_[ap]ton on steroids */
689 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
690 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
691 // "old" (ipv4 only) API
692 // users: traceroute.c hostname.c - use _list_ of all IPs
693 struct hostent *xgethostbyname(const char *name) FAST_FUNC;
694 // Also mount.c and inetd.c are using gethostbyname(),
695 // + inet_common.c has additional IPv4-only stuff
698 void socket_want_pktinfo(int fd) FAST_FUNC;
699 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
700 const struct sockaddr *to,
701 const struct sockaddr *from,
702 socklen_t tolen) FAST_FUNC;
703 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
704 struct sockaddr *from,
706 socklen_t sa_size) FAST_FUNC;
708 uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
710 char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
711 char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
712 void *xmemdup(const void *s, int n) FAST_FUNC RETURNS_MALLOC;
713 void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
714 char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
715 char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
716 unsigned count_strstr(const char *str, const char *sub) FAST_FUNC;
717 char *xmalloc_substitute_string(const char *src, int count, const char *sub, const char *repl) FAST_FUNC;
718 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
719 * But potentially slow, don't use in one-billion-times loops */
720 int bb_putchar(int ch) FAST_FUNC;
721 /* Note: does not use stdio, writes to fd 2 directly */
722 int bb_putchar_stderr(char ch) FAST_FUNC;
723 char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
724 char *auto_string(char *str) FAST_FUNC;
725 // gcc-4.1.1 still isn't good enough at optimizing it
726 // (+200 bytes compared to macro)
727 //static ALWAYS_INLINE
728 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
729 //static ALWAYS_INLINE
730 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
731 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
732 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
733 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
734 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
735 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
737 typedef struct uni_stat_t {
739 unsigned unicode_count;
740 unsigned unicode_width;
742 /* Returns a string with unprintable chars replaced by '?' or
743 * SUBST_WCHAR. This function is unicode-aware. */
744 const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
745 /* Prints unprintable char ch as ^C or M-c to file
746 * (M-c is used only if ch is ORed with PRINTABLE_META),
747 * else it is printed as-is (except for ch = 0x9b) */
748 enum { PRINTABLE_META = 0x100 };
749 void fputc_printable(int ch, FILE *file) FAST_FUNC;
750 /* Return a string that is the printable representation of character ch.
751 * Buffer must hold at least four characters. */
753 VISIBLE_ENDLINE = 1 << 0,
754 VISIBLE_SHOW_TABS = 1 << 1,
756 void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
758 /* dmalloc will redefine these to it's own implementation. It is safe
759 * to have the prototypes here unconditionally. */
760 void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
761 void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
762 void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
763 void *xrealloc(void *old, size_t size) FAST_FUNC;
764 /* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
765 * at least v[idx] and v[idx+1], for all idx values.
766 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
767 * when all elements are used up. New elements are zeroed out.
768 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
769 * skipping an index is a bad bug - it may miss a realloc!
771 #define xrealloc_vector(vector, shift, idx) \
772 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
773 void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
776 extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
777 extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count) FAST_FUNC;
778 // NB: will return short read on error, not -1,
779 // if some data was read before error occurred
780 extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
781 extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
782 extern unsigned char xread_char(int fd) FAST_FUNC;
783 extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
784 extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
785 // Reads one line a-la fgets (but doesn't save terminating '\n').
786 // Reads byte-by-byte. Useful when it is important to not read ahead.
787 // Bytes are appended to pfx (which must be malloced, or NULL).
788 extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
789 /* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
790 extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
791 /* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
792 extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
793 /* Never returns NULL */
794 extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
796 #if defined(ARG_MAX) && (ARG_MAX >= 60*1024 || !defined(_SC_ARG_MAX))
797 /* Use _constant_ maximum if: defined && (big enough || no variable one exists) */
798 # define bb_arg_max() ((unsigned)ARG_MAX)
799 #elif defined(_SC_ARG_MAX)
800 /* Else use variable one (a bit more expensive) */
801 unsigned bb_arg_max(void) FAST_FUNC;
803 /* If all else fails */
804 # define bb_arg_max() ((unsigned)(32 * 1024))
806 unsigned bb_clk_tck(void) FAST_FUNC;
808 #define SEAMLESS_COMPRESSION (0 \
809 || ENABLE_FEATURE_SEAMLESS_XZ \
810 || ENABLE_FEATURE_SEAMLESS_LZMA \
811 || ENABLE_FEATURE_SEAMLESS_BZ2 \
812 || ENABLE_FEATURE_SEAMLESS_GZ \
813 || ENABLE_FEATURE_SEAMLESS_Z)
815 #if SEAMLESS_COMPRESSION
816 /* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
817 extern int setup_unzip_on_fd(int fd, int fail_if_not_compressed) FAST_FUNC;
818 /* Autodetects .gz etc */
819 extern int open_zipped(const char *fname, int fail_if_not_compressed) FAST_FUNC;
820 extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
822 # define setup_unzip_on_fd(...) (0)
823 # define open_zipped(fname, fail_if_not_compressed) open((fname), O_RDONLY);
824 # define xmalloc_open_zipped_read_close(fname, maxsz_p) xmalloc_open_read_close((fname), (maxsz_p))
827 extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
828 // NB: will return short write on error, not -1,
829 // if some data was written before error occurred
830 extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
831 extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
832 extern void xwrite_str(int fd, const char *str) FAST_FUNC;
833 extern ssize_t full_write1_str(const char *str) FAST_FUNC;
834 extern ssize_t full_write2_str(const char *str) FAST_FUNC;
835 extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
837 /* Close fd, but check for failures (some types of write errors) */
838 extern void xclose(int fd) FAST_FUNC;
840 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
841 extern void xprint_and_close_file(FILE *file) FAST_FUNC;
843 /* Reads a line from a text file, up to a newline or NUL byte, inclusive.
844 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
845 * end of line. If end isn't NULL, length of the chunk is stored in it.
846 * Returns NULL if EOF/error.
848 extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
849 /* Reads up to (and including) TERMINATING_STRING: */
850 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
851 /* Same, with limited max size, and returns the length (excluding NUL): */
852 extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
853 /* Chops off TERMINATING_STRING from the end: */
854 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
855 /* Reads up to (and including) "\n" or NUL byte: */
856 extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
857 /* Chops off '\n' from the end, unlike fgets: */
858 extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
859 /* Same, but doesn't try to conserve space (may have some slack after the end) */
860 /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
862 void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
863 void die_if_ferror_stdout(void) FAST_FUNC;
864 int fflush_all(void) FAST_FUNC;
865 void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
866 int fclose_if_not_stdin(FILE *file) FAST_FUNC;
867 FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
868 /* Prints warning to stderr and returns NULL on failure: */
869 FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
870 /* "Opens" stdin if filename is special, else just opens file: */
871 FILE* xfopen_stdin(const char *filename) FAST_FUNC;
872 FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
873 FILE* fopen_for_read(const char *path) FAST_FUNC;
874 FILE* xfopen_for_read(const char *path) FAST_FUNC;
875 FILE* fopen_for_write(const char *path) FAST_FUNC;
876 FILE* xfopen_for_write(const char *path) FAST_FUNC;
877 FILE* xfdopen_for_read(int fd) FAST_FUNC;
878 FILE* xfdopen_for_write(int fd) FAST_FUNC;
880 int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
881 void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
883 /* Wrapper which restarts poll on EINTR or ENOMEM.
884 * On other errors complains [perror("poll")] and returns.
885 * Warning! May take (much) longer than timeout_ms to return!
886 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
887 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
889 char *safe_gethostname(void) FAST_FUNC;
891 /* Convert each alpha char in str to lower-case */
892 char* str_tolower(char *str) FAST_FUNC;
894 char *utoa(unsigned n) FAST_FUNC;
895 char *itoa(int n) FAST_FUNC;
896 /* Returns a pointer past the formatted number, does NOT null-terminate */
897 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
898 char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
899 /* Intelligent formatters of bignums */
900 char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
901 char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
902 /* If block_size == 0, display size without fractional part,
903 * else display (size * block_size) with one decimal digit.
904 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
905 * else divide by display_unit and do not use suffix. */
906 #define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
907 #define HUMAN_READABLE_MAX_WIDTH_STR "7"
908 //TODO: provide pointer to buf (avoid statics)?
909 const char *make_human_readable_str(unsigned long long size,
910 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
911 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
912 char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
914 char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
916 /* Generate a UUID */
917 void generate_uuid(uint8_t *buf) FAST_FUNC;
919 /* Last element is marked by mult == 0 */
924 extern const struct suffix_mult bkm_suffixes[];
925 #define km_suffixes (bkm_suffixes + 1)
926 extern const struct suffix_mult cwbkMG_suffixes[];
927 #define kMG_suffixes (cwbkMG_suffixes + 3)
932 /* Using xatoi() instead of naive atoi() is not always convenient -
933 * in many places people want *non-negative* values, but store them
934 * in signed int. Therefore we need this one:
935 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
936 * It should really be named xatoi_nonnegative (since it allows 0),
937 * but that would be too long.
939 int xatoi_positive(const char *numstr) FAST_FUNC;
941 /* Useful for reading port numbers */
942 uint16_t xatou16(const char *numstr) FAST_FUNC;
945 /* These parse entries in /etc/passwd and /etc/group. This is desirable
946 * for BusyBox since we want to avoid using the glibc NSS stuff, which
947 * increases target size and is often not needed on embedded systems. */
948 long xuname2uid(const char *name) FAST_FUNC;
949 long xgroup2gid(const char *name) FAST_FUNC;
950 /* wrapper: allows string to contain numeric uid or gid */
951 unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
956 /* always sets uid and gid; returns 0 on failure */
957 int get_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
958 /* always sets uid and gid; exits on failure */
959 void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
960 /* chown-like handling of "user[:[group]" */
961 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
962 struct passwd* xgetpwnam(const char *name) FAST_FUNC;
963 struct group* xgetgrnam(const char *name) FAST_FUNC;
964 struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
965 struct group* xgetgrgid(gid_t gid) FAST_FUNC;
966 char* xuid2uname(uid_t uid) FAST_FUNC;
967 char* xgid2group(gid_t gid) FAST_FUNC;
968 char* uid2uname(uid_t uid) FAST_FUNC;
969 char* gid2group(gid_t gid) FAST_FUNC;
970 char* uid2uname_utoa(uid_t uid) FAST_FUNC;
971 char* gid2group_utoa(gid_t gid) FAST_FUNC;
972 /* versions which cache results (useful for ps, ls etc) */
973 const char* get_cached_username(uid_t uid) FAST_FUNC;
974 const char* get_cached_groupname(gid_t gid) FAST_FUNC;
975 void clear_username_cache(void) FAST_FUNC;
976 /* internally usernames are saved in fixed-sized char[] buffers */
977 enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
978 #if ENABLE_FEATURE_CHECK_NAMES
979 void die_if_bad_username(const char* name) FAST_FUNC;
981 #define die_if_bad_username(name) ((void)(name))
984 #if ENABLE_FEATURE_UTMP
985 void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
986 void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
987 void FAST_FUNC update_utmp_DEAD_PROCESS(pid_t pid);
989 # define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
990 # define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
991 # define update_utmp_DEAD_PROCESS(pid) ((void)0)
995 int file_is_executable(const char *name) FAST_FUNC;
996 char *find_executable(const char *filename, char **PATHp) FAST_FUNC;
997 int executable_exists(const char *filename) FAST_FUNC;
999 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
1000 * but it may exec busybox and call applet instead of searching PATH.
1002 #if ENABLE_FEATURE_PREFER_APPLETS
1003 int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
1004 #define BB_EXECLP(prog,cmd,...) \
1006 if (find_applet_by_name(prog) >= 0) \
1007 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
1008 execlp(prog, cmd, __VA_ARGS__); \
1011 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
1012 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
1014 void BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
1015 void exec_prog_or_SHELL(char **argv) NORETURN FAST_FUNC;
1017 /* xvfork() can't be a _function_, return after vfork in child mangles stack
1018 * in the parent. It must be a macro. */
1021 pid_t bb__xvfork_pid = vfork(); \
1022 if (bb__xvfork_pid < 0) \
1023 bb_perror_msg_and_die("vfork"); \
1027 pid_t xfork(void) FAST_FUNC;
1029 void xvfork_parent_waits_and_exits(void) FAST_FUNC;
1031 /* NOMMU friendy fork+exec: */
1032 pid_t spawn(char **argv) FAST_FUNC;
1033 pid_t xspawn(char **argv) FAST_FUNC;
1035 pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
1036 pid_t wait_any_nohang(int *wstat) FAST_FUNC;
1037 /* wait4pid: unlike waitpid, waits ONLY for one process.
1038 * Returns sig + 0x180 if child is killed by signal.
1039 * It's safe to pass negative 'pids' from failed [v]fork -
1040 * wait4pid will return -1 (and will not clobber [v]fork's errno).
1041 * IOW: rc = wait4pid(spawn(argv));
1042 * if (rc < 0) bb_perror_msg("%s", argv[0]);
1043 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
1045 int wait4pid(pid_t pid) FAST_FUNC;
1046 int wait_for_exitstatus(pid_t pid) FAST_FUNC;
1047 /* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
1048 int spawn_and_wait(char **argv) FAST_FUNC;
1049 /* Does NOT check that applet is NOFORK, just blindly runs it */
1050 int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
1052 /* Helpers for daemonization.
1054 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
1056 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
1057 * rexec's itself on NOMMU with argv passed as command line.
1058 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
1059 * from the start. (It will detect it and not reexec again second time).
1060 * You have to audit carefully that you don't do something twice as a result
1061 * (opening files/sockets, parsing config files etc...)!
1063 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
1064 * (will do setsid()).
1066 * fork_or_rexec(argv) = bare-bones fork on MMU,
1067 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
1068 * On MMU ignores argv.
1070 * Helper for network daemons in foreground mode:
1072 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
1073 * to /dev/null if they are not.
1076 DAEMON_CHDIR_ROOT = 1,
1077 DAEMON_DEVNULL_STDIO = 2,
1078 DAEMON_CLOSE_EXTRA_FDS = 4,
1079 DAEMON_ONLY_SANITIZE = 8, /* internal use */
1080 DAEMON_DOUBLE_FORK = 16, /* double fork to avoid controlling tty */
1083 enum { re_execed = 0 };
1084 # define fork_or_rexec(argv) xfork()
1085 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1086 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
1088 extern bool re_execed;
1089 /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1090 * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1092 void re_exec(char **argv) NORETURN FAST_FUNC;
1093 pid_t fork_or_rexec(char **argv) FAST_FUNC;
1094 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1095 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1096 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
1097 # define fork() BUG_fork_is_unavailable_on_nommu()
1098 # define xfork() BUG_fork_is_unavailable_on_nommu()
1099 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1100 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
1102 void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1103 void bb_sanitize_stdio(void) FAST_FUNC;
1104 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
1105 int sanitize_env_if_suid(void) FAST_FUNC;
1108 char* single_argv(char **argv) FAST_FUNC;
1109 extern const char *const bb_argv_dash[]; /* "-", NULL */
1110 extern const char *opt_complementary;
1111 #if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
1112 #define No_argument "\0"
1113 #define Required_argument "\001"
1114 #define Optional_argument "\002"
1115 extern const char *applet_long_options;
1117 extern uint32_t option_mask32;
1118 extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
1121 /* Having next pointer as a first member allows easy creation
1122 * of "llist-compatible" structs, and using llist_FOO functions
1125 typedef struct llist_t {
1126 struct llist_t *link;
1129 void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1130 void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1131 void *llist_pop(llist_t **elm) FAST_FUNC;
1132 void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1133 void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1134 llist_t *llist_rev(llist_t *list) FAST_FUNC;
1135 llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
1136 /* BTW, surprisingly, changing API to
1137 * llist_t *llist_add_to(llist_t *old_head, void *data)
1138 * etc does not result in smaller code... */
1140 /* start_stop_daemon and udhcpc are special - they want
1141 * to create pidfiles regardless of FEATURE_PIDFILE */
1142 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
1143 /* True only if we created pidfile which is *file*, not /dev/null etc */
1144 extern smallint wrote_pidfile;
1145 void write_pidfile(const char *path) FAST_FUNC;
1146 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
1148 enum { wrote_pidfile = 0 };
1149 #define write_pidfile(path) ((void)0)
1150 #define remove_pidfile(path) ((void)0)
1155 LOGMODE_STDIO = (1 << 0),
1156 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
1157 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1159 extern const char *msg_eol;
1160 extern smallint syslog_level;
1161 extern smallint logmode;
1162 extern uint8_t xfunc_error_retval;
1163 extern void (*die_func)(void);
1164 extern void xfunc_die(void) NORETURN FAST_FUNC;
1165 extern void bb_show_usage(void) NORETURN FAST_FUNC;
1166 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1167 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1168 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1169 extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1170 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1171 extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
1172 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1173 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1174 extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
1175 extern void bb_perror_nomsg(void) FAST_FUNC;
1176 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
1177 extern void bb_logenv_override(void) FAST_FUNC;
1179 /* We need to export XXX_main from libbusybox
1180 * only if we build "individual" binaries
1182 #if ENABLE_FEATURE_INDIVIDUAL
1183 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1185 #define MAIN_EXTERNALLY_VISIBLE
1189 /* Applets which are useful from another applets */
1190 int bb_cat(char** argv);
1191 /* If shell needs them, they exist even if not enabled as applets */
1192 int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1193 int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1194 int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1195 int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
1196 /* Similar, but used by chgrp, not shell */
1197 int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
1199 int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1200 /* Don't need IF_xxx() guard for these */
1201 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1202 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1205 void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
1210 /* This structure defines protocol families and their handlers. */
1216 char* FAST_FUNC (*print)(unsigned char *);
1217 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1218 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1219 void FAST_FUNC (*herror)(char *text);
1220 int FAST_FUNC (*rprint)(int options);
1221 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
1222 /* may modify src */
1223 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
1225 /* This structure defines hardware protocols and their handlers. */
1231 char* FAST_FUNC (*print)(unsigned char *);
1232 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1233 int FAST_FUNC (*activate)(int fd);
1234 int suppress_null_addr;
1236 extern smallint interface_opt_a;
1237 int display_interfaces(char *ifname) FAST_FUNC;
1238 int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1239 #if ENABLE_FEATURE_HWIB
1240 int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1242 #define in_ib(a, b) 1 /* fail */
1244 const struct aftype *get_aftype(const char *name) FAST_FUNC;
1245 const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1246 const struct hwtype *get_hwntype(int type) FAST_FUNC;
1249 #ifndef BUILD_INDIVIDUAL
1250 extern int find_applet_by_name(const char *name) FAST_FUNC;
1251 extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
1254 #ifdef HAVE_MNTENT_H
1255 extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
1256 extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
1258 extern void erase_mtab(const char * name) FAST_FUNC;
1259 extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1260 extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1262 extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1264 # define bb_warn_ignoring_args(arg) ((void)0)
1267 extern int get_linux_version_code(void) FAST_FUNC;
1269 extern char *query_loop(const char *device) FAST_FUNC;
1270 extern int del_loop(const char *device) FAST_FUNC;
1271 /* If *devname is not NULL, use that name, otherwise try to find free one,
1272 * malloc and return it in *devname.
1273 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
1274 extern int set_loop(char **devname, const char *file, unsigned long long offset, int ro) FAST_FUNC;
1276 /* Like bb_ask below, but asks on stdin with no timeout. */
1277 char *bb_ask_stdin(const char * prompt) FAST_FUNC;
1278 //TODO: pass buf pointer or return allocated buf (avoid statics)?
1279 char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
1280 int bb_ask_confirmation(void) FAST_FUNC;
1282 /* Returns -1 if input is invalid. current_mode is a base for e.g. "u+rw" */
1283 int bb_parse_mode(const char* s, unsigned cur_mode) FAST_FUNC;
1286 * Config file parser
1289 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1290 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1291 // TODO: COLLAPSE and TRIM seem to always go in pair
1292 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1293 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
1294 // keep a copy of current line
1295 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
1296 PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
1298 // * remove leading and trailing delimiters and collapse
1299 // multiple delimiters into one
1300 // * warn and continue if less than mintokens delimiters found
1301 // * grab everything into last token
1302 // * comments are recognized even if they aren't the first char
1303 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
1305 typedef struct parser_t {
1309 size_t line_alloc, nline_alloc;
1312 parser_t* config_open(const char *filename) FAST_FUNC;
1313 parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
1314 /* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
1315 int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1316 #define config_read(parser, tokens, max, min, str, flags) \
1317 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1318 void config_close(parser_t *parser) FAST_FUNC;
1320 /* Concatenate path and filename to new allocated buffer.
1321 * Add "/" only as needed (no duplicate "//" are produced).
1322 * If path is NULL, it is assumed to be "/".
1323 * filename should not be NULL. */
1324 char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1325 /* Returns NULL on . and .. */
1326 char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1329 int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1331 int get_signum(const char *name) FAST_FUNC;
1332 const char *get_signame(int number) FAST_FUNC;
1333 void print_signames(void) FAST_FUNC;
1335 char *bb_simplify_path(const char *path) FAST_FUNC;
1336 /* Returns ptr to NUL */
1337 char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
1339 #ifndef LOGIN_FAIL_DELAY
1340 #define LOGIN_FAIL_DELAY 3
1342 extern void bb_do_delay(int seconds) FAST_FUNC;
1343 extern void change_identity(const struct passwd *pw) FAST_FUNC;
1344 extern void run_shell(const char *shell, int loginshell, const char **args) NORETURN FAST_FUNC;
1346 /* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1347 * Note that getpwuid result might need xstrdup'ing
1348 * if there is a possibility of intervening getpwxxx() calls.
1350 const char *get_shell_name(void) FAST_FUNC;
1353 extern void renew_current_security_context(void) FAST_FUNC;
1354 extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1355 extern context_t set_security_context_component(security_context_t cur_context,
1356 char *user, char *role, char *type, char *range) FAST_FUNC;
1357 extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1358 extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1360 #define selinux_preserve_fcontext(fdesc) ((void)0)
1362 extern void selinux_or_die(void) FAST_FUNC;
1365 /* setup_environment:
1366 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
1367 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1369 * USER=pw->pw_name, LOGNAME=pw->pw_name
1370 * PATH=bb_default_[root_]path
1373 * else if change_env = 1:
1374 * if not root (if pw->pw_uid != 0):
1375 * USER=pw->pw_name, LOGNAME=pw->pw_name
1380 #define SETUP_ENV_CHANGEENV (1 << 0)
1381 #define SETUP_ENV_CLEARENV (1 << 1)
1382 #define SETUP_ENV_TO_TMP (1 << 2)
1383 #define SETUP_ENV_NO_CHDIR (1 << 4)
1384 void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1385 void nuke_str(char *str) FAST_FUNC;
1386 int check_password(const struct passwd *pw, const char *plaintext) FAST_FUNC;
1387 int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1388 int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
1389 /* Returns a malloced string */
1390 #if !ENABLE_USE_BB_CRYPT
1391 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1393 extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1394 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1396 * rnd is additional random input. New one is returned.
1397 * Useful if you call crypt_make_salt many times in a row:
1398 * rnd = crypt_make_salt(buf1, 4, 0);
1399 * rnd = crypt_make_salt(buf2, 4, rnd);
1400 * rnd = crypt_make_salt(buf3, 4, rnd);
1401 * (otherwise we risk having same salt generated)
1403 extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1404 /* "$N$" + sha_salt_16_bytes + NUL */
1405 #define MAX_PW_SALT_LEN (3 + 16 + 1)
1406 extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1409 /* Returns number of lines changed, or -1 on error */
1410 #if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1411 #define update_passwd(filename, username, data, member) \
1412 update_passwd(filename, username, data)
1414 extern int update_passwd(const char *filename,
1415 const char *username,
1417 const char *member) FAST_FUNC;
1419 int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1420 int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1421 int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1422 int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1423 const char *nth_string(const char *strings, int n) FAST_FUNC;
1425 extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1426 extern void print_login_prompt(void) FAST_FUNC;
1428 char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
1429 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1430 int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1431 int get_terminal_width(int fd) FAST_FUNC;
1433 int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1435 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1436 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1437 int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1438 #if ENABLE_IOCTL_HEX2STR_ERROR
1439 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1440 int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1441 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1442 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1444 int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1445 int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1446 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1447 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1450 char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1451 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1452 void reset_ino_dev_hashtable(void) FAST_FUNC;
1454 /* At least glibc has horrendously large inline for this, so wrap it */
1455 unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
1457 #define makedev(a,b) bb_makedev(a,b)
1461 /* "Keycodes" that report an escape sequence.
1462 * We use something which fits into signed char,
1463 * yet doesn't represent any valid Unicode character.
1464 * Also, -1 is reserved for error indication and we don't use it. */
1472 KEYCODE_INSERT = -8,
1473 KEYCODE_DELETE = -9,
1474 KEYCODE_PAGEUP = -10,
1475 KEYCODE_PAGEDOWN = -11,
1476 // -12 is reserved for Alt/Ctrl/Shift-TAB
1487 KEYCODE_FUN10 = -22,
1488 KEYCODE_FUN11 = -23,
1489 KEYCODE_FUN12 = -24,
1491 /* Be sure that last defined value is small enough
1492 * to not interfere with Alt/Ctrl/Shift bits.
1493 * So far we do not exceed -31 (0xfff..fffe1),
1494 * which gives us three upper bits in LSB to play with.
1496 //KEYCODE_SHIFT_TAB = (-12) & ~0x80,
1497 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1498 //KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1499 //KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
1500 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1501 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
1502 //KEYCODE_ALT_UP = KEYCODE_UP & ~0x20,
1503 //KEYCODE_ALT_DOWN = KEYCODE_DOWN & ~0x20,
1504 KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
1505 KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
1507 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
1508 /* How long is the longest ESC sequence we know?
1509 * We want it big enough to be able to contain
1510 * cursor position sequence "ESC [ 9999 ; 9999 R"
1512 KEYCODE_BUFFER_SIZE = 16
1514 /* Note: fd may be in blocking or non-blocking mode, both make sense.
1515 * For one, less uses non-blocking mode.
1516 * Only the first read syscall inside read_key may block indefinitely
1517 * (unless fd is in non-blocking mode),
1518 * subsequent reads will time out after a few milliseconds.
1519 * Return of -1 means EOF or error (errno == 0 on EOF).
1520 * buffer[0] is used as a counter of buffered chars and must be 0
1523 * -2: do not poll for input;
1524 * -1: poll(-1) (i.e. block);
1525 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
1527 int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
1528 void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
1531 #if ENABLE_FEATURE_EDITING
1532 /* It's NOT just ENABLEd or disabled. It's a number: */
1533 # if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
1534 # define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1535 unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
1537 # define MAX_HISTORY 0
1539 typedef struct line_input_t {
1541 const char *path_lookup;
1545 int max_history; /* must never be <= 0 */
1546 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1547 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1548 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1549 * in on-disk history"
1550 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1551 * also in on-disk history (and thus need to be skipped on save)"
1553 unsigned cnt_history_in_file;
1554 const char *hist_file;
1556 char *history[MAX_HISTORY + 1];
1560 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1561 TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1562 USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1563 VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
1564 WITH_PATH_LOOKUP = 0x10,
1565 FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1567 line_input_t *new_line_input_t(int flags) FAST_FUNC;
1568 /* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1570 * maxsize must be >= 2.
1572 * -1 on read errors or EOF, or on bare Ctrl-D,
1573 * 0 on ctrl-C (the line entered is still returned in 'command'),
1574 * >0 length of input string, including terminating '\n'
1576 int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize, int timeout) FAST_FUNC;
1577 void show_history(const line_input_t *st) FAST_FUNC;
1578 # if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1579 void save_history(line_input_t *st);
1582 #define MAX_HISTORY 0
1583 int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1584 #define read_line_input(state, prompt, command, maxsize, timeout) \
1585 read_line_input(prompt, command, maxsize)
1590 # ifdef TASK_COMM_LEN
1591 enum { COMM_LEN = TASK_COMM_LEN };
1593 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1594 enum { COMM_LEN = 16 };
1599 unsigned long mapped_rw;
1600 unsigned long mapped_ro;
1601 unsigned long shared_clean;
1602 unsigned long shared_dirty;
1603 unsigned long private_clean;
1604 unsigned long private_dirty;
1605 unsigned long stack;
1606 unsigned long smap_pss, smap_swap;
1607 unsigned long smap_size;
1608 unsigned long smap_start;
1614 #define procps_read_smaps(pid, total, cb, data) \
1615 procps_read_smaps(pid, total)
1617 int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1618 void (*cb)(struct smaprec *, void *), void *data);
1620 typedef struct procps_status_t {
1622 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
1623 uint8_t shift_pages_to_bytes;
1624 uint8_t shift_pages_to_kb;
1625 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1629 IF_SELINUX(char *context;)
1630 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
1631 /* Everything below must contain no ptrs to malloc'ed data:
1632 * it is memset(0) for each process in procps_scan() */
1633 unsigned long vsz, rss; /* we round it to kbytes */
1634 unsigned long stime, utime;
1635 unsigned long start_time;
1642 #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1647 unsigned tty_major,tty_minor;
1648 #if ENABLE_FEATURE_TOPMEM
1649 struct smaprec smaps;
1652 /* basename of executable in exec(2), read from /proc/N/stat
1653 * (if executable is symlink or script, it is NOT replaced
1654 * by link target or interpreter name) */
1655 char comm[COMM_LEN];
1656 /* user/group? - use passwd/group parsing functions */
1657 #if ENABLE_FEATURE_TOP_SMP_PROCESS
1658 int last_seen_on_cpu;
1661 /* flag bits for procps_scan(xx, flags) calls */
1663 PSSCAN_PID = 1 << 0,
1664 PSSCAN_PPID = 1 << 1,
1665 PSSCAN_PGID = 1 << 2,
1666 PSSCAN_SID = 1 << 3,
1667 PSSCAN_UIDGID = 1 << 4,
1668 PSSCAN_COMM = 1 << 5,
1669 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
1670 PSSCAN_ARGV0 = 1 << 7,
1671 PSSCAN_EXE = 1 << 8,
1672 PSSCAN_STATE = 1 << 9,
1673 PSSCAN_VSZ = 1 << 10,
1674 PSSCAN_RSS = 1 << 11,
1675 PSSCAN_STIME = 1 << 12,
1676 PSSCAN_UTIME = 1 << 13,
1677 PSSCAN_TTY = 1 << 14,
1678 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1679 /* NB: used by find_pid_by_name(). Any applet using it
1680 * needs to be mentioned here. */
1681 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1682 || ENABLE_PGREP || ENABLE_PKILL
1686 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
1687 PSSCAN_START_TIME = 1 << 18,
1688 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1689 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1690 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1691 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
1693 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1694 void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1695 procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
1696 /* Format cmdline (up to col chars) into char buf[size] */
1697 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1698 void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
1699 pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1700 pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
1701 int starts_with_cpu(const char *str) FAST_FUNC;
1702 unsigned get_cpu_count(void) FAST_FUNC;
1705 /* Use strict=1 if you process input from untrusted source:
1706 * it will return NULL on invalid %xx (bad hex chars)
1707 * and str + 1 if decoded char is / or NUL.
1708 * In non-strict mode, it always succeeds (returns str),
1709 * and also it additionally decoded '+' to space.
1711 char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
1714 extern const char bb_uuenc_tbl_base64[] ALIGN1;
1715 extern const char bb_uuenc_tbl_std[] ALIGN1;
1716 void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
1718 BASE64_FLAG_UU_STOP = 0x100,
1719 /* Sign-extends to a value which never matches fgetc result: */
1720 BASE64_FLAG_NO_STOP_CHAR = 0x80,
1722 const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
1723 void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
1725 typedef struct md5_ctx_t {
1726 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1727 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
1728 uint64_t total64; /* must be directly before hash[] */
1729 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1731 typedef struct md5_ctx_t sha1_ctx_t;
1732 typedef struct md5_ctx_t sha256_ctx_t;
1733 typedef struct sha512_ctx_t {
1734 uint64_t total64[2]; /* must be directly before hash[] */
1736 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
1738 typedef struct sha3_ctx_t {
1740 unsigned bytes_queued;
1741 unsigned input_block_bytes;
1743 void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1744 void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1745 void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1746 void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1747 #define sha1_hash md5_hash
1748 void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1749 void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1750 #define sha256_hash md5_hash
1751 #define sha256_end sha1_end
1752 void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1753 void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1754 void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
1755 void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
1756 void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1757 void sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
1759 extern uint32_t *global_crc32_table;
1760 uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1761 uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1762 uint32_t crc32_block_endian0(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1764 typedef struct masks_labels_t {
1768 int print_flags_separated(const int *masks, const char *labels,
1769 int flags, const char *separator) FAST_FUNC;
1770 int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
1772 typedef struct bb_progress_t {
1774 unsigned last_update_sec;
1775 unsigned last_change_sec;
1777 const char *curfile;
1780 #define is_bb_progress_inited(p) ((p)->curfile != NULL)
1781 #define bb_progress_free(p) do { \
1782 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1783 (p)->curfile = NULL; \
1785 void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
1786 void bb_progress_update(bb_progress_t *p,
1789 uoff_t totalsize) FAST_FUNC;
1791 unsigned ubi_devnum_from_devname(const char *str) FAST_FUNC;
1792 int ubi_get_volid_by_name(unsigned ubi_devnum, const char *vol_name) FAST_FUNC;
1795 extern const char *applet_name;
1797 /* Some older linkers don't perform string merging, we used to have common strings
1798 * as global arrays to do it by hand. But:
1799 * (1) newer linkers do it themselves,
1800 * (2) however, they DONT merge string constants with global arrays,
1801 * even if the value is the same (!). Thus global arrays actually
1802 * increased size a bit: for example, "/etc/passwd" string from libc
1803 * wasn't merged with bb_path_passwd_file[] array!
1804 * Therefore now we use #defines.
1806 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1807 extern const char bb_banner[] ALIGN1;
1808 extern const char bb_msg_memory_exhausted[] ALIGN1;
1809 extern const char bb_msg_invalid_date[] ALIGN1;
1810 #define bb_msg_read_error "read error"
1811 #define bb_msg_write_error "write error"
1812 extern const char bb_msg_unknown[] ALIGN1;
1813 extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
1814 extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
1815 extern const char bb_msg_you_must_be_root[] ALIGN1;
1816 extern const char bb_msg_requires_arg[] ALIGN1;
1817 extern const char bb_msg_invalid_arg_to[] ALIGN1;
1818 extern const char bb_msg_standard_input[] ALIGN1;
1819 extern const char bb_msg_standard_output[] ALIGN1;
1821 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1822 extern const char bb_hexdigits_upcase[] ALIGN1;
1824 extern const char bb_path_wtmp_file[] ALIGN1;
1826 /* Busybox mount uses either /proc/mounts or /etc/mtab to
1827 * get the list of currently mounted filesystems */
1828 #define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1830 #define bb_path_passwd_file _PATH_PASSWD
1831 #define bb_path_group_file _PATH_GROUP
1832 #define bb_path_shadow_file _PATH_SHADOW
1833 #define bb_path_gshadow_file _PATH_GSHADOW
1835 #define bb_path_motd_file "/etc/motd"
1837 #define bb_dev_null "/dev/null"
1838 extern const char bb_busybox_exec_path[] ALIGN1;
1839 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1840 * but I want to save a few bytes here */
1841 extern const char bb_PATH_root_path[] ALIGN1; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1842 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1843 #define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1845 extern const int const_int_0;
1846 //extern const int const_int_1;
1848 /* This struct is deliberately not defined. */
1849 /* See docs/keep_data_small.txt */
1851 /* '*const' ptr makes gcc optimize code much better.
1852 * Magic prevents ptr_to_globals from going into rodata.
1853 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1854 extern struct globals *const ptr_to_globals;
1855 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1856 #define barrier() __asm__ __volatile__("":::"memory")
1857 #define SET_PTR_TO_GLOBALS(x) do { \
1858 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
1861 #define FREE_PTR_TO_GLOBALS() do { \
1862 if (ENABLE_FEATURE_CLEAN_UP) { \
1863 free(ptr_to_globals); \
1867 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1868 * use bb_default_login_shell and following defines.
1869 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1870 * don't forget to change increment constant. */
1871 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
1872 extern const char bb_default_login_shell[] ALIGN1;
1874 #define DEFAULT_SHELL (bb_default_login_shell+1)
1876 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1878 /* The following devices are the same on all systems. */
1879 #define CURRENT_TTY "/dev/tty"
1880 #define DEV_CONSOLE "/dev/console"
1882 #if defined(__FreeBSD_kernel__)
1883 # define CURRENT_VC CURRENT_TTY
1884 # define VC_1 "/dev/ttyv0"
1885 # define VC_2 "/dev/ttyv1"
1886 # define VC_3 "/dev/ttyv2"
1887 # define VC_4 "/dev/ttyv3"
1888 # define VC_5 "/dev/ttyv4"
1889 # define VC_FORMAT "/dev/ttyv%d"
1890 #elif defined(__GNU__)
1891 # define CURRENT_VC CURRENT_TTY
1892 # define VC_1 "/dev/tty1"
1893 # define VC_2 "/dev/tty2"
1894 # define VC_3 "/dev/tty3"
1895 # define VC_4 "/dev/tty4"
1896 # define VC_5 "/dev/tty5"
1897 # define VC_FORMAT "/dev/tty%d"
1898 #elif ENABLE_FEATURE_DEVFS
1899 /*Linux, obsolete devfs names */
1900 # define CURRENT_VC "/dev/vc/0"
1901 # define VC_1 "/dev/vc/1"
1902 # define VC_2 "/dev/vc/2"
1903 # define VC_3 "/dev/vc/3"
1904 # define VC_4 "/dev/vc/4"
1905 # define VC_5 "/dev/vc/5"
1906 # define VC_FORMAT "/dev/vc/%d"
1907 # define LOOP_FORMAT "/dev/loop/%u"
1908 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1909 # define LOOP_NAME "/dev/loop/"
1910 # define FB_0 "/dev/fb/0"
1912 /*Linux, normal names */
1913 # define CURRENT_VC "/dev/tty0"
1914 # define VC_1 "/dev/tty1"
1915 # define VC_2 "/dev/tty2"
1916 # define VC_3 "/dev/tty3"
1917 # define VC_4 "/dev/tty4"
1918 # define VC_5 "/dev/tty5"
1919 # define VC_FORMAT "/dev/tty%d"
1920 # define LOOP_FORMAT "/dev/loop%u"
1921 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1922 # define LOOP_NAME "/dev/loop"
1923 # define FB_0 "/dev/fb0"
1927 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1928 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
1931 /* We redefine ctype macros. Unicode-correct handling of char types
1932 * can't be done with such byte-oriented operations anyway,
1933 * we don't lose anything.
1951 /* We save ~500 bytes on isdigit alone.
1952 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
1954 /* These work the same for ASCII and Unicode,
1955 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
1956 #define isascii(a) ((unsigned char)(a) <= 0x7f)
1957 #define isdigit(a) ((unsigned char)((a) - '0') <= 9)
1958 #define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1959 #define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
1960 #define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
1961 #define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1962 #define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
1963 /* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
1964 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
1966 #define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
1967 // Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1968 #define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1969 // Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
1970 #define isalnum(a) bb_ascii_isalnum(a)
1971 static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1973 unsigned char b = a - '0';
1977 return b <= 'z' - 'a';
1979 #define isxdigit(a) bb_ascii_isxdigit(a)
1980 static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1982 unsigned char b = a - '0';
1986 return b <= 'f' - 'a';
1988 #define toupper(a) bb_ascii_toupper(a)
1989 static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1991 unsigned char b = a - 'a';
1992 if (b <= ('z' - 'a'))
1996 #define tolower(a) bb_ascii_tolower(a)
1997 static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1999 unsigned char b = a - 'A';
2000 if (b <= ('Z' - 'A'))
2005 /* In ASCII and Unicode, these are likely to be very different.
2006 * Let's prevent ambiguous usage from the start */
2007 #define isgraph(a) isgraph_is_ambiguous_dont_use(a)
2008 #define isprint(a) isprint_is_ambiguous_dont_use(a)
2009 /* NB: must not treat EOF as isgraph or isprint */
2010 #define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
2011 #define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
2014 /* Simple unit-testing framework */
2016 typedef void (*bbunit_testfunc)(void);
2018 struct bbunit_listelem {
2020 bbunit_testfunc testfunc;
2023 void bbunit_registertest(struct bbunit_listelem* test);
2024 void bbunit_settestfailed(void);
2026 #define BBUNIT_DEFINE_TEST(NAME) \
2027 static void bbunit_##NAME##_test(void); \
2028 static struct bbunit_listelem bbunit_##NAME##_elem = { \
2030 .testfunc = bbunit_##NAME##_test, \
2032 static void INIT_FUNC bbunit_##NAME##_register(void) \
2034 bbunit_registertest(&bbunit_##NAME##_elem); \
2036 static void bbunit_##NAME##_test(void)
2039 * Both 'goto bbunit_end' and 'break' are here only to get rid
2040 * of compiler warnings.
2042 #define BBUNIT_ENDTEST \
2049 #define BBUNIT_PRINTASSERTFAIL \
2052 "[ERROR] Assertion failed in file %s, line %d", \
2053 __FILE__, __LINE__); \
2056 #define BBUNIT_ASSERTION_FAILED \
2058 bbunit_settestfailed(); \
2064 * For now we only offer assertions which cause tests to fail
2065 * immediately. In the future 'expects' might be added too -
2066 * similar to those offered by the gtest framework.
2068 #define BBUNIT_ASSERT_EQ(EXPECTED, ACTUAL) \
2070 if ((EXPECTED) != (ACTUAL)) { \
2071 BBUNIT_PRINTASSERTFAIL; \
2072 bb_error_msg("[ERROR] '%s' isn't equal to '%s'", \
2073 #EXPECTED, #ACTUAL); \
2074 BBUNIT_ASSERTION_FAILED; \
2078 #define BBUNIT_ASSERT_NOTEQ(EXPECTED, ACTUAL) \
2080 if ((EXPECTED) == (ACTUAL)) { \
2081 BBUNIT_PRINTASSERTFAIL; \
2082 bb_error_msg("[ERROR] '%s' is equal to '%s'", \
2083 #EXPECTED, #ACTUAL); \
2084 BBUNIT_ASSERTION_FAILED; \
2088 #define BBUNIT_ASSERT_NOTNULL(PTR) \
2090 if ((PTR) == NULL) { \
2091 BBUNIT_PRINTASSERTFAIL; \
2092 bb_error_msg("[ERROR] '%s' is NULL!", #PTR); \
2093 BBUNIT_ASSERTION_FAILED; \
2097 #define BBUNIT_ASSERT_NULL(PTR) \
2099 if ((PTR) != NULL) { \
2100 BBUNIT_PRINTASSERTFAIL; \
2101 bb_error_msg("[ERROR] '%s' is not NULL!", #PTR); \
2102 BBUNIT_ASSERTION_FAILED; \
2106 #define BBUNIT_ASSERT_FALSE(STATEMENT) \
2108 if ((STATEMENT)) { \
2109 BBUNIT_PRINTASSERTFAIL; \
2110 bb_error_msg("[ERROR] Statement '%s' evaluated to true!", \
2112 BBUNIT_ASSERTION_FAILED; \
2116 #define BBUNIT_ASSERT_TRUE(STATEMENT) \
2118 if (!(STATEMENT)) { \
2119 BBUNIT_PRINTASSERTFAIL; \
2120 bb_error_msg("[ERROR] Statement '%s' evaluated to false!", \
2122 BBUNIT_ASSERTION_FAILED; \
2126 #define BBUNIT_ASSERT_STREQ(STR1, STR2) \
2128 if (strcmp(STR1, STR2) != 0) { \
2129 BBUNIT_PRINTASSERTFAIL; \
2130 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2131 "are not the same", STR1, STR2); \
2132 BBUNIT_ASSERTION_FAILED; \
2136 #define BBUNIT_ASSERT_STRNOTEQ(STR1, STR2) \
2138 if (strcmp(STR1, STR2) == 0) { \
2139 BBUNIT_PRINTASSERTFAIL; \
2140 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2141 "are the same, but were " \
2142 "expected to differ", STR1, STR2); \
2143 BBUNIT_ASSERTION_FAILED; \
2148 POP_SAVED_FUNCTION_VISIBILITY
projects / oweals / busybox.git / blob