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.
23 #if defined __UCLIBC__ /* TODO: and glibc? */
24 /* use inlined versions of these: */
25 # define sigfillset(s) __sigfillset(s)
26 # define sigemptyset(s) __sigemptyset(s)
27 # define sigisemptyset(s) __sigisemptyset(s)
35 /* There are two incompatible basename's, let's not use them! */
36 /* See the dirname/basename man page for details */
37 #include <libgen.h> /* dirname,basename */
39 #define basename dont_use_basename
41 #include <sys/ioctl.h>
43 #include <sys/socket.h>
46 #include <sys/types.h>
48 # include <sys/sysmacros.h>
53 #include <sys/param.h>
56 #if ENABLE_FEATURE_SHADOWPASSWDS
57 # if !ENABLE_USE_BB_SHADOW
58 /* If using busybox's shadow implementation, do not include the shadow.h
59 * header as the toolchain may not provide it at all.
64 #if defined(ANDROID) || defined(__ANDROID__)
65 # define endpwent() ((void)0)
66 # define endgrent() ((void)0)
71 #ifdef HAVE_SYS_STATFS_H
72 # include <sys/statfs.h>
74 /* Don't do this here:
75 * #include <sys/sysinfo.h>
76 * Some linux/ includes pull in conflicting definition
77 * of struct sysinfo (only in some toolchanins), which breaks build.
78 * Include sys/sysinfo.h only in those files which need it.
81 # include <selinux/selinux.h>
82 # include <selinux/context.h>
83 # include <selinux/flask.h>
84 # include <selinux/av_permissions.h>
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__ \
92 UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 34) \
96 # elif defined __UCLIBC__
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
112 #if ENABLE_LOCALE_SUPPORT
115 # define setlocale(x,y) ((void)0)
118 # include <dmalloc.h>
120 /* Just in case libc doesn't define some of these... */
122 #define _PATH_PASSWD "/etc/passwd"
125 #define _PATH_GROUP "/etc/group"
128 #define _PATH_SHADOW "/etc/shadow"
130 #ifndef _PATH_GSHADOW
131 #define _PATH_GSHADOW "/etc/gshadow"
133 #if defined __FreeBSD__ || defined __OpenBSD__
134 # include <netinet/in.h>
135 # include <arpa/inet.h>
136 #elif defined __APPLE__
137 # include <netinet/in.h>
139 # include <arpa/inet.h>
140 # if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
141 /* We #define socklen_t *after* includes, otherwise we get
142 * typedef redefinition errors from system headers
143 * (in case "is it defined already" detection above failed)
145 # define socklen_t bb_socklen_t
146 typedef unsigned socklen_t;
149 #ifndef HAVE_CLEARENV
150 # define clearenv() do { if (environ) environ[0] = NULL; } while (0)
152 #ifndef HAVE_FDATASYNC
153 # define fdatasync fsync
160 /* Some libc's forget to declare these, do it ourself */
162 extern char **environ;
163 #if defined(__GLIBC__) && __GLIBC__ < 2
164 int vdprintf(int d, const char *format, va_list ap);
166 /* klogctl is in libc's klog.h, but we cheat and not #include that */
167 int klogctl(int type, char *b, int len);
169 # define PATH_MAX 256
176 /* Busybox does not use threads, we can speed up stdio. */
177 #ifdef HAVE_UNLOCKED_STDIO
179 # define getc(stream) getc_unlocked(stream)
181 # define getchar() getchar_unlocked()
183 # define putc(c, stream) putc_unlocked(c, stream)
185 # define putchar(c) putchar_unlocked(c)
187 # define fgetc(stream) getc_unlocked(stream)
189 # define fputc(c, stream) putc_unlocked(c, stream)
191 /* Above functions are required by POSIX.1-2008, below ones are extensions */
192 #ifdef HAVE_UNLOCKED_LINE_OPS
194 # define fgets(s, n, stream) fgets_unlocked(s, n, stream)
196 # define fputs(s, stream) fputs_unlocked(s, stream)
200 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
201 /* (don't include system headers after this until corresponding pop!) */
202 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
205 #if ENABLE_USE_BB_PWD_GRP
209 #if ENABLE_FEATURE_SHADOWPASSWDS
210 # if ENABLE_USE_BB_SHADOW
211 # include "shadow_.h"
215 /* Tested to work correctly with all int types (IIRC :]) */
216 #define MAXINT(T) (T)( \
219 : (T)~((T)1 << (sizeof(T)*8-1)) \
222 #define MININT(T) (T)( \
225 : ((T)1 << (sizeof(T)*8-1)) \
228 /* Large file support */
229 /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
230 * (stat, lseek etc) mapped to "largefile" variants by libc.
231 * Practically it means that open() automatically has O_LARGEFILE added
232 * and all filesize/file_offset parameters and struct members are "large"
233 * (in today's world - signed 64bit). For full support of large files,
234 * we need a few helper #defines (below) and careful use of off_t
235 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
237 /* CONFIG_LFS is on */
238 # if ULONG_MAX > 0xffffffff
239 /* "long" is long enough on this system */
240 typedef unsigned long uoff_t;
241 # define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
242 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
243 # define BB_STRTOOFF bb_strtoul
244 # define STRTOOFF strtoul
245 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
248 /* "long" is too short, need "long long" */
249 typedef unsigned long long uoff_t;
250 # define XATOOFF(a) xatoull_range((a), 0, LLONG_MAX)
251 # define BB_STRTOOFF bb_strtoull
252 # define STRTOOFF strtoull
253 # define OFF_FMT "ll"
256 /* CONFIG_LFS is off */
257 # if UINT_MAX == 0xffffffff
258 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
259 * gcc will throw warnings on printf("%d", off_t). Crap... */
260 typedef unsigned long uoff_t;
261 # define XATOOFF(a) xatoi_positive(a)
262 # define BB_STRTOOFF bb_strtou
263 # define STRTOOFF strtol
266 typedef unsigned long uoff_t;
267 # define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
268 # define BB_STRTOOFF bb_strtoul
269 # define STRTOOFF strtol
273 /* scary. better ideas? (but do *test* them first!) */
274 #define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
275 /* Users report bionic to use 32-bit off_t even if LARGEFILE support is requested.
276 * We misdetected that. Don't let it build:
278 struct BUG_off_t_size_is_misdetected {
279 char BUG_off_t_size_is_misdetected[sizeof(off_t) == sizeof(uoff_t) ? 1 : -1];
282 /* Some useful definitions */
284 #define FALSE ((int) 0)
286 #define TRUE ((int) 1)
288 #define SKIP ((int) 2)
290 /* Macros for min/max. */
292 #define MIN(a,b) (((a)<(b))?(a):(b))
296 #define MAX(a,b) (((a)>(b))?(a):(b))
299 /* buffer allocation schemes */
300 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
301 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
302 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
303 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
305 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
306 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
307 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
308 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
310 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
311 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
312 #define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
316 #if defined(__GLIBC__)
317 /* glibc uses __errno_location() to get a ptr to errno */
318 /* We can just memorize it once - no multithreading in busybox :) */
319 extern int *const bb_errno;
321 #define errno (*bb_errno)
324 #if !(ULONG_MAX > 0xffffffff)
325 /* Only 32-bit CPUs need this, 64-bit ones use inlined version */
326 uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
329 unsigned long long monotonic_ns(void) FAST_FUNC;
330 unsigned long long monotonic_us(void) FAST_FUNC;
331 unsigned long long monotonic_ms(void) FAST_FUNC;
332 unsigned monotonic_sec(void) FAST_FUNC;
334 extern void chomp(char *s) FAST_FUNC;
335 extern void trim(char *s) FAST_FUNC;
336 extern char *skip_whitespace(const char *) FAST_FUNC;
337 extern char *skip_non_whitespace(const char *) FAST_FUNC;
338 extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
340 extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
342 //TODO: supply a pointer to char[11] buffer (avoid statics)?
343 extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
344 extern int is_directory(const char *name, int followLinks) FAST_FUNC;
345 enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
346 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
347 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
348 FILEUTILS_RECUR = 1 << 2, /* -R */
349 FILEUTILS_FORCE = 1 << 3, /* -f */
350 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
351 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
352 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
353 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
354 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
356 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
357 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
359 FILEUTILS_IGNORE_CHMOD_ERR = 1 << 11,
361 FILEUTILS_VERBOSE = (1 << 12) * ENABLE_FEATURE_VERBOSE,
363 #define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
364 extern int remove_file(const char *path, int flags) FAST_FUNC;
365 /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
366 * the source, not copy (unless "source" is a directory).
367 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
368 * work coreutils-compatibly. */
369 extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
372 ACTION_RECURSE = (1 << 0),
373 ACTION_FOLLOWLINKS = (1 << 1),
374 ACTION_FOLLOWLINKS_L0 = (1 << 2),
375 ACTION_DEPTHFIRST = (1 << 3),
376 /*ACTION_REVERSE = (1 << 4), - unused */
377 ACTION_QUIET = (1 << 5),
378 ACTION_DANGLING_OK = (1 << 6),
380 typedef uint8_t recurse_flags_t;
381 extern int recursive_action(const char *fileName, unsigned flags,
382 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
383 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
384 void* userData, unsigned depth) FAST_FUNC;
385 extern int device_open(const char *device, int mode) FAST_FUNC;
386 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
387 extern int xgetpty(char *line) FAST_FUNC;
388 extern int get_console_fd_or_die(void) FAST_FUNC;
389 extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
390 extern char *find_block_device(const char *path) FAST_FUNC;
391 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
392 extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
393 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
394 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
395 /* "short" copy can be detected by return value < size */
396 /* this helper yells "short read!" if param is not -1 */
397 extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
399 extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
400 char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
401 /* xxxx_strip version can modify its parameter:
405 * "abc/def/" -> "def" !!
407 char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
408 /* "abc/def/" -> "" and it never modifies 'path' */
409 char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
410 /* Simpler version: does not special case "/" string */
411 const char *bb_basename(const char *name) FAST_FUNC;
412 /* NB: can violate const-ness (similarly to strchr) */
413 char *last_char_is(const char *s, int c) FAST_FUNC;
414 const char* endofname(const char *name) FAST_FUNC;
415 char *is_prefixed_with(const char *string, const char *key) FAST_FUNC;
416 char *is_suffixed_with(const char *string, const char *key) FAST_FUNC;
418 int ndelay_on(int fd) FAST_FUNC;
419 int ndelay_off(int fd) FAST_FUNC;
420 void close_on_exec_on(int fd) FAST_FUNC;
421 void xdup2(int, int) FAST_FUNC;
422 void xmove_fd(int, int) FAST_FUNC;
425 DIR *xopendir(const char *path) FAST_FUNC;
426 DIR *warn_opendir(const char *path) FAST_FUNC;
428 char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
429 char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
430 char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
431 /* !RETURNS_MALLOC: it's a realloc-like function */
432 char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
434 char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
438 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
439 * otherwise would kill us, except for those resulting from bugs:
440 * SIGSEGV, SIGILL, SIGFPE.
441 * Other fatal signals not included (TODO?):
442 * SIGBUS Bus error (bad memory access)
443 * SIGPOLL Pollable event. Synonym of SIGIO
444 * SIGPROF Profiling timer expired
445 * SIGSYS Bad argument to routine
446 * SIGTRAP Trace/breakpoint trap
448 * The only known arch with some of these sigs not fitting
449 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
450 * Dance around with long long to guard against that...
452 BB_FATAL_SIGS = (int)(0
456 + (1LL << SIGPIPE) // Write to pipe with no readers
457 + (1LL << SIGQUIT) // Quit from keyboard
458 + (1LL << SIGABRT) // Abort signal from abort(3)
459 + (1LL << SIGALRM) // Timer signal from alarm(2)
460 + (1LL << SIGVTALRM) // Virtual alarm clock
461 + (1LL << SIGXCPU) // CPU time limit exceeded
462 + (1LL << SIGXFSZ) // File size limit exceeded
463 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
467 void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
468 /* Unlike signal() and bb_signals, sets handler with sigaction()
469 * and in a way that while signal handler is run, no other signals
470 * will be blocked; syscalls will not be restarted: */
471 void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
472 /* syscalls like read() will be interrupted with EINTR: */
473 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
474 /* syscalls like read() won't be interrupted (though select/poll will be): */
475 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
476 void wait_for_any_sig(void) FAST_FUNC;
477 void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
478 void sig_block(int sig) FAST_FUNC;
479 void sig_unblock(int sig) FAST_FUNC;
480 /* Will do sigaction(signum, act, NULL): */
481 int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
482 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
483 int sigprocmask_allsigs(int how) FAST_FUNC;
484 /* Standard handler which just records signo */
485 extern smallint bb_got_signal;
486 void record_signo(int signo); /* not FAST_FUNC! */
489 void xsetgid(gid_t gid) FAST_FUNC;
490 void xsetuid(uid_t uid) FAST_FUNC;
491 void xsetegid(gid_t egid) FAST_FUNC;
492 void xseteuid(uid_t euid) FAST_FUNC;
493 void xchdir(const char *path) FAST_FUNC;
494 void xchroot(const char *path) FAST_FUNC;
495 void xsetenv(const char *key, const char *value) FAST_FUNC;
496 void bb_unsetenv(const char *key) FAST_FUNC;
497 void bb_unsetenv_and_free(char *key) FAST_FUNC;
498 void xunlink(const char *pathname) FAST_FUNC;
499 void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
500 void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
501 int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
502 int open_or_warn(const char *pathname, int flags) FAST_FUNC;
503 int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
504 int xopen(const char *pathname, int flags) FAST_FUNC;
505 int xopen_nonblocking(const char *pathname) FAST_FUNC;
506 int xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g) FAST_FUNC;
507 int open_or_warn_stdin(const char *pathname) FAST_FUNC;
508 int xopen_stdin(const char *pathname) FAST_FUNC;
509 void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
510 int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
511 off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
512 int xmkstemp(char *template) FAST_FUNC;
513 off_t fdlength(int fd) FAST_FUNC;
515 uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
516 const char *override,
517 unsigned override_units,
520 void xpipe(int filedes[2]) FAST_FUNC;
521 /* In this form code with pipes is much more readable */
522 struct fd_pair { int rd; int wr; };
523 #define piped_pair(pair) pipe(&((pair).rd))
524 #define xpiped_pair(pair) xpipe(&((pair).rd))
526 /* Useful for having small structure members/global variables */
527 typedef int8_t socktype_t;
528 typedef int8_t family_t;
529 struct BUG_too_small {
530 char BUG_socktype_t_too_small[(0
537 char BUG_family_t_too_small[(0
554 void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
555 time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
556 char *strftime_HHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
557 char *strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
559 int xsocket(int domain, int type, int protocol) FAST_FUNC;
560 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
561 void xlisten(int s, int backlog) FAST_FUNC;
562 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
563 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
564 socklen_t tolen) FAST_FUNC;
566 int setsockopt_int(int fd, int level, int optname, int optval) FAST_FUNC;
567 int setsockopt_1(int fd, int level, int optname) FAST_FUNC;
568 int setsockopt_SOL_SOCKET_int(int fd, int optname, int optval) FAST_FUNC;
569 int setsockopt_SOL_SOCKET_1(int fd, int optname) FAST_FUNC;
570 /* SO_REUSEADDR allows a server to rebind to an address that is already
571 * "in use" by old connections to e.g. previous server instance which is
572 * killed or crashed. Without it bind will fail until all such connections
573 * time out. Linux does not allow multiple live binds on same ip:port
574 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
575 * Turn it on before you call bind(). */
576 void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
577 int setsockopt_keepalive(int fd) FAST_FUNC;
578 int setsockopt_broadcast(int fd) FAST_FUNC;
579 int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
580 /* NB: returns port in host byte order */
581 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
582 typedef struct len_and_sockaddr {
586 struct sockaddr_in sin;
587 #if ENABLE_FEATURE_IPV6
588 struct sockaddr_in6 sin6;
593 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
594 LSA_SIZEOF_SA = sizeof(
597 struct sockaddr_in sin;
598 #if ENABLE_FEATURE_IPV6
599 struct sockaddr_in6 sin6;
604 /* Create stream socket, and allocate suitable lsa.
605 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
606 * af == AF_UNSPEC will result in trying to create IPv6 socket,
607 * and if kernel doesn't support it, fall back to IPv4.
608 * This is useful if you plan to bind to resulting local lsa.
610 int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
611 int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
612 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
613 * numeric IP ("N.N.N.N") or numeric IPv6 address,
614 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
615 * Only if there is no suffix, port argument is used */
616 /* NB: these set SO_REUSEADDR before bind */
617 int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
618 int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
619 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
620 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
621 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
622 * If there is no suffix, port argument is used */
623 int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
624 /* Connect to peer identified by lsa */
625 int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
626 /* Get local address of bound or accepted socket */
627 len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
628 /* Get remote address of connected or accepted socket */
629 len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
630 /* Return malloc'ed len_and_sockaddr with socket address of host:port
631 * Currently will return IPv4 or IPv6 sockaddrs only
632 * (depending on host), but in theory nothing prevents e.g.
633 * UNIX socket address being returned, IPX sockaddr etc...
634 * On error does bb_error_msg and returns NULL */
635 len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
636 /* Version which dies on error */
637 len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
638 len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
639 /* Same, useful if you want to force family (e.g. IPv6) */
640 #if !ENABLE_FEATURE_IPV6
641 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
642 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
644 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
645 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
647 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
648 * otherwise no-op. Useful for ftp.
649 * NB: does NOT do htons() internally, just direct assignment. */
650 void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
651 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
652 int get_nport(const struct sockaddr *sa) FAST_FUNC;
653 /* Reverse DNS. Returns NULL on failure. */
654 char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
655 /* This one doesn't append :PORTNUM */
656 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
657 /* This one also doesn't fall back to dotted IP (returns NULL) */
658 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
659 /* inet_[ap]ton on steroids */
660 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
661 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
662 // "old" (ipv4 only) API
663 // users: traceroute.c hostname.c - use _list_ of all IPs
664 struct hostent *xgethostbyname(const char *name) FAST_FUNC;
665 // Also mount.c and inetd.c are using gethostbyname(),
666 // + inet_common.c has additional IPv4-only stuff
669 void socket_want_pktinfo(int fd) FAST_FUNC;
670 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
671 const struct sockaddr *to,
672 const struct sockaddr *from,
673 socklen_t tolen) FAST_FUNC;
674 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
675 struct sockaddr *from,
677 socklen_t sa_size) FAST_FUNC;
679 uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
681 char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
682 char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
683 void *xmemdup(const void *s, int n) FAST_FUNC RETURNS_MALLOC;
684 void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
685 char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
686 char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
687 unsigned count_strstr(const char *str, const char *sub) FAST_FUNC;
688 char *xmalloc_substitute_string(const char *src, int count, const char *sub, const char *repl) FAST_FUNC;
689 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
690 * But potentially slow, don't use in one-billion-times loops */
691 int bb_putchar(int ch) FAST_FUNC;
692 /* Note: does not use stdio, writes to fd 2 directly */
693 int bb_putchar_stderr(char ch) FAST_FUNC;
694 char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
695 char *auto_string(char *str) FAST_FUNC;
696 // gcc-4.1.1 still isn't good enough at optimizing it
697 // (+200 bytes compared to macro)
698 //static ALWAYS_INLINE
699 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
700 //static ALWAYS_INLINE
701 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
702 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
703 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
704 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
705 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
706 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
708 typedef struct uni_stat_t {
710 unsigned unicode_count;
711 unsigned unicode_width;
713 /* Returns a string with unprintable chars replaced by '?' or
714 * SUBST_WCHAR. This function is unicode-aware. */
715 const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
716 /* Prints unprintable char ch as ^C or M-c to file
717 * (M-c is used only if ch is ORed with PRINTABLE_META),
718 * else it is printed as-is (except for ch = 0x9b) */
719 enum { PRINTABLE_META = 0x100 };
720 void fputc_printable(int ch, FILE *file) FAST_FUNC;
721 /* Return a string that is the printable representation of character ch.
722 * Buffer must hold at least four characters. */
724 VISIBLE_ENDLINE = 1 << 0,
725 VISIBLE_SHOW_TABS = 1 << 1,
727 void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
729 /* dmalloc will redefine these to it's own implementation. It is safe
730 * to have the prototypes here unconditionally. */
731 void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
732 void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
733 void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
734 void *xrealloc(void *old, size_t size) FAST_FUNC;
735 /* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
736 * at least v[idx] and v[idx+1], for all idx values.
737 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
738 * when all elements are used up. New elements are zeroed out.
739 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
740 * skipping an index is a bad bug - it may miss a realloc!
742 #define xrealloc_vector(vector, shift, idx) \
743 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
744 void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
747 extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
748 extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count) FAST_FUNC;
749 // NB: will return short read on error, not -1,
750 // if some data was read before error occurred
751 extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
752 extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
753 extern unsigned char xread_char(int fd) FAST_FUNC;
754 extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
755 extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
756 // Reads one line a-la fgets (but doesn't save terminating '\n').
757 // Reads byte-by-byte. Useful when it is important to not read ahead.
758 // Bytes are appended to pfx (which must be malloced, or NULL).
759 extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
760 /* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
761 extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
762 /* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
763 extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
764 /* Never returns NULL */
765 extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
767 #if defined(ARG_MAX) && (ARG_MAX >= 60*1024 || !defined(_SC_ARG_MAX))
768 /* Use _constant_ maximum if: defined && (big enough || no variable one exists) */
769 # define bb_arg_max() ((unsigned)ARG_MAX)
770 #elif defined(_SC_ARG_MAX)
771 /* Else use variable one (a bit more expensive) */
772 unsigned bb_arg_max(void) FAST_FUNC;
774 /* If all else fails */
775 # define bb_arg_max() ((unsigned)(32 * 1024))
777 unsigned bb_clk_tck(void) FAST_FUNC;
779 #define SEAMLESS_COMPRESSION (0 \
780 || ENABLE_FEATURE_SEAMLESS_XZ \
781 || ENABLE_FEATURE_SEAMLESS_LZMA \
782 || ENABLE_FEATURE_SEAMLESS_BZ2 \
783 || ENABLE_FEATURE_SEAMLESS_GZ \
784 || ENABLE_FEATURE_SEAMLESS_Z)
786 #if SEAMLESS_COMPRESSION
787 /* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
788 extern int setup_unzip_on_fd(int fd, int fail_if_not_compressed) FAST_FUNC;
789 /* Autodetects .gz etc */
790 extern int open_zipped(const char *fname, int fail_if_not_compressed) FAST_FUNC;
791 extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
793 # define setup_unzip_on_fd(...) (0)
794 # define open_zipped(fname, fail_if_not_compressed) open((fname), O_RDONLY);
795 # define xmalloc_open_zipped_read_close(fname, maxsz_p) xmalloc_open_read_close((fname), (maxsz_p))
798 extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
799 // NB: will return short write on error, not -1,
800 // if some data was written before error occurred
801 extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
802 extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
803 extern void xwrite_str(int fd, const char *str) FAST_FUNC;
804 extern ssize_t full_write1_str(const char *str) FAST_FUNC;
805 extern ssize_t full_write2_str(const char *str) FAST_FUNC;
806 extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
808 /* Close fd, but check for failures (some types of write errors) */
809 extern void xclose(int fd) FAST_FUNC;
811 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
812 extern void xprint_and_close_file(FILE *file) FAST_FUNC;
814 /* Reads a line from a text file, up to a newline or NUL byte, inclusive.
815 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
816 * end of line. If end isn't NULL, length of the chunk is stored in it.
817 * Returns NULL if EOF/error.
819 extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
820 /* Reads up to (and including) TERMINATING_STRING: */
821 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
822 /* Same, with limited max size, and returns the length (excluding NUL): */
823 extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
824 /* Chops off TERMINATING_STRING from the end: */
825 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
826 /* Reads up to (and including) "\n" or NUL byte: */
827 extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
828 /* Chops off '\n' from the end, unlike fgets: */
829 extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
830 /* Same, but doesn't try to conserve space (may have some slack after the end) */
831 /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
833 void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
834 void die_if_ferror_stdout(void) FAST_FUNC;
835 int fflush_all(void) FAST_FUNC;
836 void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
837 int fclose_if_not_stdin(FILE *file) FAST_FUNC;
838 FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
839 /* Prints warning to stderr and returns NULL on failure: */
840 FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
841 /* "Opens" stdin if filename is special, else just opens file: */
842 FILE* xfopen_stdin(const char *filename) FAST_FUNC;
843 FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
844 FILE* fopen_for_read(const char *path) FAST_FUNC;
845 FILE* xfopen_for_read(const char *path) FAST_FUNC;
846 FILE* fopen_for_write(const char *path) FAST_FUNC;
847 FILE* xfopen_for_write(const char *path) FAST_FUNC;
848 FILE* xfdopen_for_read(int fd) FAST_FUNC;
849 FILE* xfdopen_for_write(int fd) FAST_FUNC;
851 int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
852 void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
854 /* Wrapper which restarts poll on EINTR or ENOMEM.
855 * On other errors complains [perror("poll")] and returns.
856 * Warning! May take (much) longer than timeout_ms to return!
857 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
858 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
860 char *safe_gethostname(void) FAST_FUNC;
862 /* Convert each alpha char in str to lower-case */
863 char* str_tolower(char *str) FAST_FUNC;
865 char *utoa(unsigned n) FAST_FUNC;
866 char *itoa(int n) FAST_FUNC;
867 /* Returns a pointer past the formatted number, does NOT null-terminate */
868 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
869 char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
870 /* Intelligent formatters of bignums */
871 char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
872 char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
873 /* If block_size == 0, display size without fractional part,
874 * else display (size * block_size) with one decimal digit.
875 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
876 * else divide by display_unit and do not use suffix. */
877 #define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
878 #define HUMAN_READABLE_MAX_WIDTH_STR "7"
879 //TODO: provide pointer to buf (avoid statics)?
880 const char *make_human_readable_str(unsigned long long size,
881 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
882 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
883 char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
885 char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
887 /* Generate a UUID */
888 void generate_uuid(uint8_t *buf) FAST_FUNC;
890 /* Last element is marked by mult == 0 */
895 extern const struct suffix_mult bkm_suffixes[];
896 #define km_suffixes (bkm_suffixes + 1)
897 extern const struct suffix_mult cwbkMG_suffixes[];
898 #define kMG_suffixes (cwbkMG_suffixes + 3)
903 /* Using xatoi() instead of naive atoi() is not always convenient -
904 * in many places people want *non-negative* values, but store them
905 * in signed int. Therefore we need this one:
906 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
907 * It should really be named xatoi_nonnegative (since it allows 0),
908 * but that would be too long.
910 int xatoi_positive(const char *numstr) FAST_FUNC;
912 /* Useful for reading port numbers */
913 uint16_t xatou16(const char *numstr) FAST_FUNC;
916 /* These parse entries in /etc/passwd and /etc/group. This is desirable
917 * for BusyBox since we want to avoid using the glibc NSS stuff, which
918 * increases target size and is often not needed on embedded systems. */
919 long xuname2uid(const char *name) FAST_FUNC;
920 long xgroup2gid(const char *name) FAST_FUNC;
921 /* wrapper: allows string to contain numeric uid or gid */
922 unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
927 /* always sets uid and gid; returns 0 on failure */
928 int get_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
929 /* always sets uid and gid; exits on failure */
930 void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
931 /* chown-like handling of "user[:[group]" */
932 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
933 struct passwd* xgetpwnam(const char *name) FAST_FUNC;
934 struct group* xgetgrnam(const char *name) FAST_FUNC;
935 struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
936 struct group* xgetgrgid(gid_t gid) FAST_FUNC;
937 char* xuid2uname(uid_t uid) FAST_FUNC;
938 char* xgid2group(gid_t gid) FAST_FUNC;
939 char* uid2uname(uid_t uid) FAST_FUNC;
940 char* gid2group(gid_t gid) FAST_FUNC;
941 char* uid2uname_utoa(uid_t uid) FAST_FUNC;
942 char* gid2group_utoa(gid_t gid) FAST_FUNC;
943 /* versions which cache results (useful for ps, ls etc) */
944 const char* get_cached_username(uid_t uid) FAST_FUNC;
945 const char* get_cached_groupname(gid_t gid) FAST_FUNC;
946 void clear_username_cache(void) FAST_FUNC;
947 /* internally usernames are saved in fixed-sized char[] buffers */
948 enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
949 #if ENABLE_FEATURE_CHECK_NAMES
950 void die_if_bad_username(const char* name) FAST_FUNC;
952 #define die_if_bad_username(name) ((void)(name))
955 #if ENABLE_FEATURE_UTMP
956 void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
957 void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
958 void FAST_FUNC update_utmp_DEAD_PROCESS(pid_t pid);
960 # define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
961 # define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
962 # define update_utmp_DEAD_PROCESS(pid) ((void)0)
966 int file_is_executable(const char *name) FAST_FUNC;
967 char *find_executable(const char *filename, char **PATHp) FAST_FUNC;
968 int executable_exists(const char *filename) FAST_FUNC;
970 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
971 * but it may exec busybox and call applet instead of searching PATH.
973 #if ENABLE_FEATURE_PREFER_APPLETS
974 int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
975 #define BB_EXECLP(prog,cmd,...) \
977 if (find_applet_by_name(prog) >= 0) \
978 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
979 execlp(prog, cmd, __VA_ARGS__); \
982 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
983 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
985 int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
987 /* xvfork() can't be a _function_, return after vfork mangles stack
988 * in the parent. It must be a macro. */
991 pid_t bb__xvfork_pid = vfork(); \
992 if (bb__xvfork_pid < 0) \
993 bb_perror_msg_and_die("vfork"); \
997 pid_t xfork(void) FAST_FUNC;
1000 /* NOMMU friendy fork+exec: */
1001 pid_t spawn(char **argv) FAST_FUNC;
1002 pid_t xspawn(char **argv) FAST_FUNC;
1004 pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
1005 pid_t wait_any_nohang(int *wstat) FAST_FUNC;
1006 /* wait4pid: unlike waitpid, waits ONLY for one process.
1007 * Returns sig + 0x180 if child is killed by signal.
1008 * It's safe to pass negative 'pids' from failed [v]fork -
1009 * wait4pid will return -1 (and will not clobber [v]fork's errno).
1010 * IOW: rc = wait4pid(spawn(argv));
1011 * if (rc < 0) bb_perror_msg("%s", argv[0]);
1012 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
1014 int wait4pid(pid_t pid) FAST_FUNC;
1015 /* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
1016 int spawn_and_wait(char **argv) FAST_FUNC;
1017 /* Does NOT check that applet is NOFORK, just blindly runs it */
1018 int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
1020 /* Helpers for daemonization.
1022 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
1024 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
1025 * rexec's itself on NOMMU with argv passed as command line.
1026 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
1027 * from the start. (It will detect it and not reexec again second time).
1028 * You have to audit carefully that you don't do something twice as a result
1029 * (opening files/sockets, parsing config files etc...)!
1031 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
1032 * (will do setsid()).
1034 * fork_or_rexec(argv) = bare-bones fork on MMU,
1035 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
1036 * On MMU ignores argv.
1038 * Helper for network daemons in foreground mode:
1040 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
1041 * to /dev/null if they are not.
1044 DAEMON_CHDIR_ROOT = 1,
1045 DAEMON_DEVNULL_STDIO = 2,
1046 DAEMON_CLOSE_EXTRA_FDS = 4,
1047 DAEMON_ONLY_SANITIZE = 8, /* internal use */
1048 DAEMON_DOUBLE_FORK = 16, /* double fork to avoid controlling tty */
1051 enum { re_execed = 0 };
1052 # define fork_or_rexec(argv) xfork()
1053 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1054 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
1056 extern bool re_execed;
1057 /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1058 * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1060 void re_exec(char **argv) NORETURN FAST_FUNC;
1061 pid_t fork_or_rexec(char **argv) FAST_FUNC;
1062 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1063 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1064 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
1065 # define fork() BUG_fork_is_unavailable_on_nommu()
1066 # define xfork() BUG_fork_is_unavailable_on_nommu()
1067 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1068 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
1070 void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1071 void bb_sanitize_stdio(void) FAST_FUNC;
1072 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
1073 int sanitize_env_if_suid(void) FAST_FUNC;
1076 char* single_argv(char **argv) FAST_FUNC;
1077 extern const char *const bb_argv_dash[]; /* "-", NULL */
1078 extern const char *opt_complementary;
1079 #if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
1080 #define No_argument "\0"
1081 #define Required_argument "\001"
1082 #define Optional_argument "\002"
1083 extern const char *applet_long_options;
1085 extern uint32_t option_mask32;
1086 extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
1089 /* Having next pointer as a first member allows easy creation
1090 * of "llist-compatible" structs, and using llist_FOO functions
1093 typedef struct llist_t {
1094 struct llist_t *link;
1097 void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1098 void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1099 void *llist_pop(llist_t **elm) FAST_FUNC;
1100 void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1101 void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1102 llist_t *llist_rev(llist_t *list) FAST_FUNC;
1103 llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
1104 /* BTW, surprisingly, changing API to
1105 * llist_t *llist_add_to(llist_t *old_head, void *data)
1106 * etc does not result in smaller code... */
1108 /* start_stop_daemon and udhcpc are special - they want
1109 * to create pidfiles regardless of FEATURE_PIDFILE */
1110 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
1111 /* True only if we created pidfile which is *file*, not /dev/null etc */
1112 extern smallint wrote_pidfile;
1113 void write_pidfile(const char *path) FAST_FUNC;
1114 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
1116 enum { wrote_pidfile = 0 };
1117 #define write_pidfile(path) ((void)0)
1118 #define remove_pidfile(path) ((void)0)
1123 LOGMODE_STDIO = (1 << 0),
1124 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
1125 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1127 extern const char *msg_eol;
1128 extern smallint syslog_level;
1129 extern smallint logmode;
1130 extern uint8_t xfunc_error_retval;
1131 extern void (*die_func)(void);
1132 extern void xfunc_die(void) NORETURN FAST_FUNC;
1133 extern void bb_show_usage(void) NORETURN FAST_FUNC;
1134 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1135 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1136 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1137 extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1138 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1139 extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
1140 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1141 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1142 extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
1143 extern void bb_perror_nomsg(void) FAST_FUNC;
1144 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1145 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
1146 extern void bb_logenv_override(void) FAST_FUNC;
1148 /* We need to export XXX_main from libbusybox
1149 * only if we build "individual" binaries
1151 #if ENABLE_FEATURE_INDIVIDUAL
1152 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1154 #define MAIN_EXTERNALLY_VISIBLE
1158 /* Applets which are useful from another applets */
1159 int bb_cat(char** argv);
1160 /* If shell needs them, they exist even if not enabled as applets */
1161 int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1162 int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1163 int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1164 int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
1165 /* Similar, but used by chgrp, not shell */
1166 int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
1168 int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1169 /* Don't need IF_xxx() guard for these */
1170 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1171 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1174 void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
1179 /* This structure defines protocol families and their handlers. */
1185 char* FAST_FUNC (*print)(unsigned char *);
1186 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1187 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1188 void FAST_FUNC (*herror)(char *text);
1189 int FAST_FUNC (*rprint)(int options);
1190 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
1191 /* may modify src */
1192 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
1194 /* This structure defines hardware protocols and their handlers. */
1200 char* FAST_FUNC (*print)(unsigned char *);
1201 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1202 int FAST_FUNC (*activate)(int fd);
1203 int suppress_null_addr;
1205 extern smallint interface_opt_a;
1206 int display_interfaces(char *ifname) FAST_FUNC;
1207 int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1208 #if ENABLE_FEATURE_HWIB
1209 int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1211 #define in_ib(a, b) 1 /* fail */
1213 const struct aftype *get_aftype(const char *name) FAST_FUNC;
1214 const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1215 const struct hwtype *get_hwntype(int type) FAST_FUNC;
1218 #ifndef BUILD_INDIVIDUAL
1219 extern int find_applet_by_name(const char *name) FAST_FUNC;
1220 /* Returns only if applet is not found. */
1221 extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
1222 extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
1225 #ifdef HAVE_MNTENT_H
1226 extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
1227 extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
1229 extern void erase_mtab(const char * name) FAST_FUNC;
1230 extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1231 extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1233 extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1235 # define bb_warn_ignoring_args(arg) ((void)0)
1238 extern int get_linux_version_code(void) FAST_FUNC;
1240 extern char *query_loop(const char *device) FAST_FUNC;
1241 extern int del_loop(const char *device) FAST_FUNC;
1242 /* If *devname is not NULL, use that name, otherwise try to find free one,
1243 * malloc and return it in *devname.
1244 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
1245 extern int set_loop(char **devname, const char *file, unsigned long long offset, int ro) FAST_FUNC;
1247 /* Like bb_ask below, but asks on stdin with no timeout. */
1248 char *bb_ask_stdin(const char * prompt) FAST_FUNC;
1249 //TODO: pass buf pointer or return allocated buf (avoid statics)?
1250 char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
1251 int bb_ask_confirmation(void) FAST_FUNC;
1253 /* Returns -1 if input is invalid. current_mode is a base for e.g. "u+rw" */
1254 int bb_parse_mode(const char* s, unsigned cur_mode) FAST_FUNC;
1257 * Config file parser
1260 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1261 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1262 // TODO: COLLAPSE and TRIM seem to always go in pair
1263 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1264 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
1265 // keep a copy of current line
1266 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
1267 PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
1269 // * remove leading and trailing delimiters and collapse
1270 // multiple delimiters into one
1271 // * warn and continue if less than mintokens delimiters found
1272 // * grab everything into last token
1273 // * comments are recognized even if they aren't the first char
1274 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
1276 typedef struct parser_t {
1280 size_t line_alloc, nline_alloc;
1283 parser_t* config_open(const char *filename) FAST_FUNC;
1284 parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
1285 /* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
1286 int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1287 #define config_read(parser, tokens, max, min, str, flags) \
1288 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1289 void config_close(parser_t *parser) FAST_FUNC;
1291 /* Concatenate path and filename to new allocated buffer.
1292 * Add "/" only as needed (no duplicate "//" are produced).
1293 * If path is NULL, it is assumed to be "/".
1294 * filename should not be NULL. */
1295 char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1296 /* Returns NULL on . and .. */
1297 char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1300 int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1302 int get_signum(const char *name) FAST_FUNC;
1303 const char *get_signame(int number) FAST_FUNC;
1304 void print_signames(void) FAST_FUNC;
1306 char *bb_simplify_path(const char *path) FAST_FUNC;
1307 /* Returns ptr to NUL */
1308 char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
1310 #ifndef LOGIN_FAIL_DELAY
1311 #define LOGIN_FAIL_DELAY 3
1313 extern void bb_do_delay(int seconds) FAST_FUNC;
1314 extern void change_identity(const struct passwd *pw) FAST_FUNC;
1315 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
1317 /* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1318 * Note that getpwuid result might need xstrdup'ing
1319 * if there is a possibility of intervening getpwxxx() calls.
1321 const char *get_shell_name(void) FAST_FUNC;
1324 extern void renew_current_security_context(void) FAST_FUNC;
1325 extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1326 extern context_t set_security_context_component(security_context_t cur_context,
1327 char *user, char *role, char *type, char *range) FAST_FUNC;
1328 extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1329 extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1331 #define selinux_preserve_fcontext(fdesc) ((void)0)
1333 extern void selinux_or_die(void) FAST_FUNC;
1336 /* systemd support */
1337 #define SD_LISTEN_FDS_START 3
1338 int sd_listen_fds(void);
1341 /* setup_environment:
1342 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
1343 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1345 * USER=pw->pw_name, LOGNAME=pw->pw_name
1346 * PATH=bb_default_[root_]path
1349 * else if change_env = 1:
1350 * if not root (if pw->pw_uid != 0):
1351 * USER=pw->pw_name, LOGNAME=pw->pw_name
1356 #define SETUP_ENV_CHANGEENV (1 << 0)
1357 #define SETUP_ENV_CLEARENV (1 << 1)
1358 #define SETUP_ENV_TO_TMP (1 << 2)
1359 #define SETUP_ENV_NO_CHDIR (1 << 4)
1360 void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1361 void nuke_str(char *str) FAST_FUNC;
1362 int check_password(const struct passwd *pw, const char *plaintext) FAST_FUNC;
1363 int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1364 int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
1365 /* Returns a malloced string */
1366 #if !ENABLE_USE_BB_CRYPT
1367 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1369 extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1370 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1372 * rnd is additional random input. New one is returned.
1373 * Useful if you call crypt_make_salt many times in a row:
1374 * rnd = crypt_make_salt(buf1, 4, 0);
1375 * rnd = crypt_make_salt(buf2, 4, rnd);
1376 * rnd = crypt_make_salt(buf3, 4, rnd);
1377 * (otherwise we risk having same salt generated)
1379 extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1380 /* "$N$" + sha_salt_16_bytes + NUL */
1381 #define MAX_PW_SALT_LEN (3 + 16 + 1)
1382 extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1385 /* Returns number of lines changed, or -1 on error */
1386 #if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1387 #define update_passwd(filename, username, data, member) \
1388 update_passwd(filename, username, data)
1390 extern int update_passwd(const char *filename,
1391 const char *username,
1393 const char *member) FAST_FUNC;
1395 int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1396 int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1397 int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1398 int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1399 const char *nth_string(const char *strings, int n) FAST_FUNC;
1401 extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1402 extern void print_login_prompt(void) FAST_FUNC;
1404 char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
1405 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1406 int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1408 int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1410 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1411 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1412 int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1413 #if ENABLE_IOCTL_HEX2STR_ERROR
1414 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1415 int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1416 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1417 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1419 int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1420 int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1421 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1422 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1425 char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1426 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1427 void reset_ino_dev_hashtable(void) FAST_FUNC;
1429 /* At least glibc has horrendously large inline for this, so wrap it */
1430 unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
1432 #define makedev(a,b) bb_makedev(a,b)
1436 /* "Keycodes" that report an escape sequence.
1437 * We use something which fits into signed char,
1438 * yet doesn't represent any valid Unicode character.
1439 * Also, -1 is reserved for error indication and we don't use it. */
1447 KEYCODE_INSERT = -8,
1448 KEYCODE_DELETE = -9,
1449 KEYCODE_PAGEUP = -10,
1450 KEYCODE_PAGEDOWN = -11,
1451 // -12 is reserved for Alt/Ctrl/Shift-TAB
1462 KEYCODE_FUN10 = -22,
1463 KEYCODE_FUN11 = -23,
1464 KEYCODE_FUN12 = -24,
1466 /* Be sure that last defined value is small enough
1467 * to not interfere with Alt/Ctrl/Shift bits.
1468 * So far we do not exceed -31 (0xfff..fffe1),
1469 * which gives us three upper bits in LSB to play with.
1471 //KEYCODE_SHIFT_TAB = (-12) & ~0x80,
1472 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1473 //KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1474 //KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
1475 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1476 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
1477 //KEYCODE_ALT_UP = KEYCODE_UP & ~0x20,
1478 //KEYCODE_ALT_DOWN = KEYCODE_DOWN & ~0x20,
1479 KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
1480 KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
1482 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
1483 /* How long is the longest ESC sequence we know?
1484 * We want it big enough to be able to contain
1485 * cursor position sequence "ESC [ 9999 ; 9999 R"
1487 KEYCODE_BUFFER_SIZE = 16
1489 /* Note: fd may be in blocking or non-blocking mode, both make sense.
1490 * For one, less uses non-blocking mode.
1491 * Only the first read syscall inside read_key may block indefinitely
1492 * (unless fd is in non-blocking mode),
1493 * subsequent reads will time out after a few milliseconds.
1494 * Return of -1 means EOF or error (errno == 0 on EOF).
1495 * buffer[0] is used as a counter of buffered chars and must be 0
1498 * -2: do not poll for input;
1499 * -1: poll(-1) (i.e. block);
1500 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
1502 int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
1503 void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
1506 #if ENABLE_FEATURE_EDITING
1507 /* It's NOT just ENABLEd or disabled. It's a number: */
1508 # if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
1509 # define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1510 unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
1512 # define MAX_HISTORY 0
1514 typedef struct line_input_t {
1516 const char *path_lookup;
1520 int max_history; /* must never be <= 0 */
1521 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1522 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1523 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1524 * in on-disk history"
1525 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1526 * also in on-disk history (and thus need to be skipped on save)"
1528 unsigned cnt_history_in_file;
1529 const char *hist_file;
1531 char *history[MAX_HISTORY + 1];
1535 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1536 TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1537 USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1538 VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
1539 WITH_PATH_LOOKUP = 0x10,
1540 FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1542 line_input_t *new_line_input_t(int flags) FAST_FUNC;
1543 /* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1545 * maxsize must be >= 2.
1547 * -1 on read errors or EOF, or on bare Ctrl-D,
1548 * 0 on ctrl-C (the line entered is still returned in 'command'),
1549 * >0 length of input string, including terminating '\n'
1551 int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize, int timeout) FAST_FUNC;
1552 void show_history(const line_input_t *st) FAST_FUNC;
1553 # if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1554 void save_history(line_input_t *st);
1557 #define MAX_HISTORY 0
1558 int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1559 #define read_line_input(state, prompt, command, maxsize, timeout) \
1560 read_line_input(prompt, command, maxsize)
1565 # ifdef TASK_COMM_LEN
1566 enum { COMM_LEN = TASK_COMM_LEN };
1568 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1569 enum { COMM_LEN = 16 };
1574 unsigned long mapped_rw;
1575 unsigned long mapped_ro;
1576 unsigned long shared_clean;
1577 unsigned long shared_dirty;
1578 unsigned long private_clean;
1579 unsigned long private_dirty;
1580 unsigned long stack;
1581 unsigned long smap_pss, smap_swap;
1582 unsigned long smap_size;
1583 unsigned long smap_start;
1589 #define procps_read_smaps(pid, total, cb, data) \
1590 procps_read_smaps(pid, total)
1592 int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1593 void (*cb)(struct smaprec *, void *), void *data);
1595 typedef struct procps_status_t {
1597 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
1598 uint8_t shift_pages_to_bytes;
1599 uint8_t shift_pages_to_kb;
1600 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1604 IF_SELINUX(char *context;)
1605 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
1606 /* Everything below must contain no ptrs to malloc'ed data:
1607 * it is memset(0) for each process in procps_scan() */
1608 unsigned long vsz, rss; /* we round it to kbytes */
1609 unsigned long stime, utime;
1610 unsigned long start_time;
1617 #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1622 unsigned tty_major,tty_minor;
1623 #if ENABLE_FEATURE_TOPMEM
1624 struct smaprec smaps;
1627 /* basename of executable in exec(2), read from /proc/N/stat
1628 * (if executable is symlink or script, it is NOT replaced
1629 * by link target or interpreter name) */
1630 char comm[COMM_LEN];
1631 /* user/group? - use passwd/group parsing functions */
1632 #if ENABLE_FEATURE_TOP_SMP_PROCESS
1633 int last_seen_on_cpu;
1636 /* flag bits for procps_scan(xx, flags) calls */
1638 PSSCAN_PID = 1 << 0,
1639 PSSCAN_PPID = 1 << 1,
1640 PSSCAN_PGID = 1 << 2,
1641 PSSCAN_SID = 1 << 3,
1642 PSSCAN_UIDGID = 1 << 4,
1643 PSSCAN_COMM = 1 << 5,
1644 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
1645 PSSCAN_ARGV0 = 1 << 7,
1646 PSSCAN_EXE = 1 << 8,
1647 PSSCAN_STATE = 1 << 9,
1648 PSSCAN_VSZ = 1 << 10,
1649 PSSCAN_RSS = 1 << 11,
1650 PSSCAN_STIME = 1 << 12,
1651 PSSCAN_UTIME = 1 << 13,
1652 PSSCAN_TTY = 1 << 14,
1653 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1654 /* NB: used by find_pid_by_name(). Any applet using it
1655 * needs to be mentioned here. */
1656 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1657 || ENABLE_PGREP || ENABLE_PKILL
1661 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
1662 PSSCAN_START_TIME = 1 << 18,
1663 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1664 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1665 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1666 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
1668 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1669 void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1670 procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
1671 /* Format cmdline (up to col chars) into char buf[size] */
1672 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1673 void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
1674 pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1675 pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
1676 int starts_with_cpu(const char *str) FAST_FUNC;
1677 unsigned get_cpu_count(void) FAST_FUNC;
1680 /* Use strict=1 if you process input from untrusted source:
1681 * it will return NULL on invalid %xx (bad hex chars)
1682 * and str + 1 if decoded char is / or NUL.
1683 * In non-strict mode, it always succeeds (returns str),
1684 * and also it additionally decoded '+' to space.
1686 char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
1689 extern const char bb_uuenc_tbl_base64[] ALIGN1;
1690 extern const char bb_uuenc_tbl_std[] ALIGN1;
1691 void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
1693 BASE64_FLAG_UU_STOP = 0x100,
1694 /* Sign-extends to a value which never matches fgetc result: */
1695 BASE64_FLAG_NO_STOP_CHAR = 0x80,
1697 const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
1698 void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
1700 typedef struct md5_ctx_t {
1701 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1702 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
1703 uint64_t total64; /* must be directly before hash[] */
1704 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1706 typedef struct md5_ctx_t sha1_ctx_t;
1707 typedef struct md5_ctx_t sha256_ctx_t;
1708 typedef struct sha512_ctx_t {
1709 uint64_t total64[2]; /* must be directly before hash[] */
1711 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
1713 typedef struct sha3_ctx_t {
1715 unsigned bytes_queued;
1717 void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1718 void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1719 void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1720 void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1721 #define sha1_hash md5_hash
1722 void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1723 void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1724 #define sha256_hash md5_hash
1725 #define sha256_end sha1_end
1726 void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1727 void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1728 void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
1729 void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
1730 void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1731 void sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
1733 extern uint32_t *global_crc32_table;
1734 uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1735 uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1736 uint32_t crc32_block_endian0(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1738 typedef struct masks_labels_t {
1742 int print_flags_separated(const int *masks, const char *labels,
1743 int flags, const char *separator) FAST_FUNC;
1744 int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
1746 typedef struct bb_progress_t {
1748 unsigned last_update_sec;
1749 unsigned last_change_sec;
1751 const char *curfile;
1754 #define is_bb_progress_inited(p) ((p)->curfile != NULL)
1755 #define bb_progress_free(p) do { \
1756 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1757 (p)->curfile = NULL; \
1759 void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
1760 void bb_progress_update(bb_progress_t *p,
1763 uoff_t totalsize) FAST_FUNC;
1766 extern const char *applet_name;
1768 /* Some older linkers don't perform string merging, we used to have common strings
1769 * as global arrays to do it by hand. But:
1770 * (1) newer linkers do it themselves,
1771 * (2) however, they DONT merge string constants with global arrays,
1772 * even if the value is the same (!). Thus global arrays actually
1773 * increased size a bit: for example, "/etc/passwd" string from libc
1774 * wasn't merged with bb_path_passwd_file[] array!
1775 * Therefore now we use #defines.
1777 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1778 extern const char bb_banner[] ALIGN1;
1779 extern const char bb_msg_memory_exhausted[] ALIGN1;
1780 extern const char bb_msg_invalid_date[] ALIGN1;
1781 #define bb_msg_read_error "read error"
1782 #define bb_msg_write_error "write error"
1783 extern const char bb_msg_unknown[] ALIGN1;
1784 extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
1785 extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
1786 extern const char bb_msg_you_must_be_root[] ALIGN1;
1787 extern const char bb_msg_requires_arg[] ALIGN1;
1788 extern const char bb_msg_invalid_arg_to[] ALIGN1;
1789 extern const char bb_msg_standard_input[] ALIGN1;
1790 extern const char bb_msg_standard_output[] ALIGN1;
1792 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1793 extern const char bb_hexdigits_upcase[] ALIGN1;
1795 extern const char bb_path_wtmp_file[] ALIGN1;
1797 /* Busybox mount uses either /proc/mounts or /etc/mtab to
1798 * get the list of currently mounted filesystems */
1799 #define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1801 #define bb_path_passwd_file _PATH_PASSWD
1802 #define bb_path_group_file _PATH_GROUP
1803 #define bb_path_shadow_file _PATH_SHADOW
1804 #define bb_path_gshadow_file _PATH_GSHADOW
1806 #define bb_path_motd_file "/etc/motd"
1808 #define bb_dev_null "/dev/null"
1809 extern const char bb_busybox_exec_path[] ALIGN1;
1810 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1811 * but I want to save a few bytes here */
1812 extern const char bb_PATH_root_path[] ALIGN1; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1813 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1814 #define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1816 extern const int const_int_0;
1817 //extern const int const_int_1;
1820 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1821 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1822 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1823 /* This struct is deliberately not defined. */
1824 /* See docs/keep_data_small.txt */
1826 /* '*const' ptr makes gcc optimize code much better.
1827 * Magic prevents ptr_to_globals from going into rodata.
1828 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1829 extern struct globals *const ptr_to_globals;
1830 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1831 #define barrier() __asm__ __volatile__("":::"memory")
1832 #define SET_PTR_TO_GLOBALS(x) do { \
1833 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
1836 #define FREE_PTR_TO_GLOBALS() do { \
1837 if (ENABLE_FEATURE_CLEAN_UP) { \
1838 free(ptr_to_globals); \
1842 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1843 * use bb_default_login_shell and following defines.
1844 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1845 * don't forget to change increment constant. */
1846 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
1847 extern const char bb_default_login_shell[] ALIGN1;
1849 #define DEFAULT_SHELL (bb_default_login_shell+1)
1851 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1853 /* The following devices are the same on all systems. */
1854 #define CURRENT_TTY "/dev/tty"
1855 #define DEV_CONSOLE "/dev/console"
1857 #if defined(__FreeBSD_kernel__)
1858 # define CURRENT_VC CURRENT_TTY
1859 # define VC_1 "/dev/ttyv0"
1860 # define VC_2 "/dev/ttyv1"
1861 # define VC_3 "/dev/ttyv2"
1862 # define VC_4 "/dev/ttyv3"
1863 # define VC_5 "/dev/ttyv4"
1864 # define VC_FORMAT "/dev/ttyv%d"
1865 #elif defined(__GNU__)
1866 # define CURRENT_VC CURRENT_TTY
1867 # define VC_1 "/dev/tty1"
1868 # define VC_2 "/dev/tty2"
1869 # define VC_3 "/dev/tty3"
1870 # define VC_4 "/dev/tty4"
1871 # define VC_5 "/dev/tty5"
1872 # define VC_FORMAT "/dev/tty%d"
1873 #elif ENABLE_FEATURE_DEVFS
1874 /*Linux, obsolete devfs names */
1875 # define CURRENT_VC "/dev/vc/0"
1876 # define VC_1 "/dev/vc/1"
1877 # define VC_2 "/dev/vc/2"
1878 # define VC_3 "/dev/vc/3"
1879 # define VC_4 "/dev/vc/4"
1880 # define VC_5 "/dev/vc/5"
1881 # define VC_FORMAT "/dev/vc/%d"
1882 # define LOOP_FORMAT "/dev/loop/%u"
1883 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1884 # define LOOP_NAME "/dev/loop/"
1885 # define FB_0 "/dev/fb/0"
1887 /*Linux, normal names */
1888 # define CURRENT_VC "/dev/tty0"
1889 # define VC_1 "/dev/tty1"
1890 # define VC_2 "/dev/tty2"
1891 # define VC_3 "/dev/tty3"
1892 # define VC_4 "/dev/tty4"
1893 # define VC_5 "/dev/tty5"
1894 # define VC_FORMAT "/dev/tty%d"
1895 # define LOOP_FORMAT "/dev/loop%u"
1896 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1897 # define LOOP_NAME "/dev/loop"
1898 # define FB_0 "/dev/fb0"
1902 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1903 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
1906 /* We redefine ctype macros. Unicode-correct handling of char types
1907 * can't be done with such byte-oriented operations anyway,
1908 * we don't lose anything.
1926 /* We save ~500 bytes on isdigit alone.
1927 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
1929 /* These work the same for ASCII and Unicode,
1930 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
1931 #define isascii(a) ((unsigned char)(a) <= 0x7f)
1932 #define isdigit(a) ((unsigned char)((a) - '0') <= 9)
1933 #define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1934 #define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
1935 #define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
1936 #define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1937 #define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
1938 /* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
1939 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
1941 #define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
1942 // Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1943 #define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1944 // Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
1945 #define isalnum(a) bb_ascii_isalnum(a)
1946 static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1948 unsigned char b = a - '0';
1952 return b <= 'z' - 'a';
1954 #define isxdigit(a) bb_ascii_isxdigit(a)
1955 static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1957 unsigned char b = a - '0';
1961 return b <= 'f' - 'a';
1963 #define toupper(a) bb_ascii_toupper(a)
1964 static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1966 unsigned char b = a - 'a';
1967 if (b <= ('z' - 'a'))
1971 #define tolower(a) bb_ascii_tolower(a)
1972 static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1974 unsigned char b = a - 'A';
1975 if (b <= ('Z' - 'A'))
1980 /* In ASCII and Unicode, these are likely to be very different.
1981 * Let's prevent ambiguous usage from the start */
1982 #define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1983 #define isprint(a) isprint_is_ambiguous_dont_use(a)
1984 /* NB: must not treat EOF as isgraph or isprint */
1985 #define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1986 #define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1989 /* Simple unit-testing framework */
1991 typedef void (*bbunit_testfunc)(void);
1993 struct bbunit_listelem {
1995 bbunit_testfunc testfunc;
1998 void bbunit_registertest(struct bbunit_listelem* test);
1999 void bbunit_settestfailed(void);
2001 #define BBUNIT_DEFINE_TEST(NAME) \
2002 static void bbunit_##NAME##_test(void); \
2003 static struct bbunit_listelem bbunit_##NAME##_elem = { \
2005 .testfunc = bbunit_##NAME##_test, \
2007 static void INIT_FUNC bbunit_##NAME##_register(void) \
2009 bbunit_registertest(&bbunit_##NAME##_elem); \
2011 static void bbunit_##NAME##_test(void)
2014 * Both 'goto bbunit_end' and 'break' are here only to get rid
2015 * of compiler warnings.
2017 #define BBUNIT_ENDTEST \
2024 #define BBUNIT_PRINTASSERTFAIL \
2027 "[ERROR] Assertion failed in file %s, line %d", \
2028 __FILE__, __LINE__); \
2031 #define BBUNIT_ASSERTION_FAILED \
2033 bbunit_settestfailed(); \
2039 * For now we only offer assertions which cause tests to fail
2040 * immediately. In the future 'expects' might be added too -
2041 * similar to those offered by the gtest framework.
2043 #define BBUNIT_ASSERT_EQ(EXPECTED, ACTUAL) \
2045 if ((EXPECTED) != (ACTUAL)) { \
2046 BBUNIT_PRINTASSERTFAIL; \
2047 bb_error_msg("[ERROR] '%s' isn't equal to '%s'", \
2048 #EXPECTED, #ACTUAL); \
2049 BBUNIT_ASSERTION_FAILED; \
2053 #define BBUNIT_ASSERT_NOTEQ(EXPECTED, ACTUAL) \
2055 if ((EXPECTED) == (ACTUAL)) { \
2056 BBUNIT_PRINTASSERTFAIL; \
2057 bb_error_msg("[ERROR] '%s' is equal to '%s'", \
2058 #EXPECTED, #ACTUAL); \
2059 BBUNIT_ASSERTION_FAILED; \
2063 #define BBUNIT_ASSERT_NOTNULL(PTR) \
2065 if ((PTR) == NULL) { \
2066 BBUNIT_PRINTASSERTFAIL; \
2067 bb_error_msg("[ERROR] '%s' is NULL!", #PTR); \
2068 BBUNIT_ASSERTION_FAILED; \
2072 #define BBUNIT_ASSERT_NULL(PTR) \
2074 if ((PTR) != NULL) { \
2075 BBUNIT_PRINTASSERTFAIL; \
2076 bb_error_msg("[ERROR] '%s' is not NULL!", #PTR); \
2077 BBUNIT_ASSERTION_FAILED; \
2081 #define BBUNIT_ASSERT_FALSE(STATEMENT) \
2083 if ((STATEMENT)) { \
2084 BBUNIT_PRINTASSERTFAIL; \
2085 bb_error_msg("[ERROR] Statement '%s' evaluated to true!", \
2087 BBUNIT_ASSERTION_FAILED; \
2091 #define BBUNIT_ASSERT_TRUE(STATEMENT) \
2093 if (!(STATEMENT)) { \
2094 BBUNIT_PRINTASSERTFAIL; \
2095 bb_error_msg("[ERROR] Statement '%s' evaluated to false!", \
2097 BBUNIT_ASSERTION_FAILED; \
2101 #define BBUNIT_ASSERT_STREQ(STR1, STR2) \
2103 if (strcmp(STR1, STR2) != 0) { \
2104 BBUNIT_PRINTASSERTFAIL; \
2105 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2106 "are not the same", STR1, STR2); \
2107 BBUNIT_ASSERTION_FAILED; \
2111 #define BBUNIT_ASSERT_STRNOTEQ(STR1, STR2) \
2113 if (strcmp(STR1, STR2) == 0) { \
2114 BBUNIT_PRINTASSERTFAIL; \
2115 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2116 "are the same, but were " \
2117 "expected to differ", STR1, STR2); \
2118 BBUNIT_ASSERTION_FAILED; \
2123 POP_SAVED_FUNCTION_VISIBILITY