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