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
89 #if ENABLE_LOCALE_SUPPORT
92 # define setlocale(x,y) ((void)0)
97 /* Just in case libc doesn't define some of these... */
99 #define _PATH_PASSWD "/etc/passwd"
102 #define _PATH_GROUP "/etc/group"
105 #define _PATH_SHADOW "/etc/shadow"
107 #ifndef _PATH_GSHADOW
108 #define _PATH_GSHADOW "/etc/gshadow"
110 #if defined __FreeBSD__ || defined __OpenBSD__
111 # include <netinet/in.h>
112 # include <arpa/inet.h>
113 #elif defined __APPLE__
114 # include <netinet/in.h>
116 # include <arpa/inet.h>
117 # if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
118 /* We #define socklen_t *after* includes, otherwise we get
119 * typedef redefinition errors from system headers
120 * (in case "is it defined already" detection above failed)
122 # define socklen_t bb_socklen_t
123 typedef unsigned socklen_t;
126 #ifndef HAVE_CLEARENV
127 # define clearenv() do { if (environ) environ[0] = NULL; } while (0)
129 #ifndef HAVE_FDATASYNC
130 # define fdatasync fsync
137 /* Some libc's forget to declare these, do it ourself */
139 extern char **environ;
140 #if defined(__GLIBC__) && __GLIBC__ < 2
141 int vdprintf(int d, const char *format, va_list ap);
143 /* klogctl is in libc's klog.h, but we cheat and not #include that */
144 int klogctl(int type, char *b, int len);
146 # define PATH_MAX 256
153 /* Busybox does not use threads, we can speed up stdio. */
154 #ifdef HAVE_UNLOCKED_STDIO
156 # define getc(stream) getc_unlocked(stream)
158 # define getchar() getchar_unlocked()
160 # define putc(c, stream) putc_unlocked(c, stream)
162 # define putchar(c) putchar_unlocked(c)
164 # define fgetc(stream) getc_unlocked(stream)
166 # define fputc(c, stream) putc_unlocked(c, stream)
168 /* Above functions are required by POSIX.1-2008, below ones are extensions */
169 #ifdef HAVE_UNLOCKED_LINE_OPS
171 # define fgets(s, n, stream) fgets_unlocked(s, n, stream)
173 # define fputs(s, stream) fputs_unlocked(s, stream)
177 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
178 /* (don't include system headers after this until corresponding pop!) */
179 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
182 #if ENABLE_USE_BB_PWD_GRP
186 #if ENABLE_FEATURE_SHADOWPASSWDS
187 # if ENABLE_USE_BB_SHADOW
188 # include "shadow_.h"
192 /* Tested to work correctly with all int types (IIRC :]) */
193 #define MAXINT(T) (T)( \
196 : (T)~((T)1 << (sizeof(T)*8-1)) \
199 #define MININT(T) (T)( \
202 : ((T)1 << (sizeof(T)*8-1)) \
205 /* Large file support */
206 /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
207 * (stat, lseek etc) mapped to "largefile" variants by libc.
208 * Practically it means that open() automatically has O_LARGEFILE added
209 * and all filesize/file_offset parameters and struct members are "large"
210 * (in today's world - signed 64bit). For full support of large files,
211 * we need a few helper #defines (below) and careful use of off_t
212 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
214 /* CONFIG_LFS is on */
215 # if ULONG_MAX > 0xffffffff
216 /* "long" is long enough on this system */
217 typedef unsigned long uoff_t;
218 # define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
219 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
220 # define BB_STRTOOFF bb_strtoul
221 # define STRTOOFF strtoul
222 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
225 /* "long" is too short, need "long long" */
226 typedef unsigned long long uoff_t;
227 # define XATOOFF(a) xatoull_range((a), 0, LLONG_MAX)
228 # define BB_STRTOOFF bb_strtoull
229 # define STRTOOFF strtoull
230 # define OFF_FMT "ll"
233 /* CONFIG_LFS is off */
234 # if UINT_MAX == 0xffffffff
235 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
236 * gcc will throw warnings on printf("%d", off_t). Crap... */
237 typedef unsigned long uoff_t;
238 # define XATOOFF(a) xatoi_positive(a)
239 # define BB_STRTOOFF bb_strtou
240 # define STRTOOFF strtol
243 typedef unsigned long uoff_t;
244 # define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
245 # define BB_STRTOOFF bb_strtoul
246 # define STRTOOFF strtol
250 /* scary. better ideas? (but do *test* them first!) */
251 #define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
252 /* Users report bionic to use 32-bit off_t even if LARGEFILE support is requested.
253 * We misdetected that. Don't let it build:
255 struct BUG_off_t_size_is_misdetected {
256 char BUG_off_t_size_is_misdetected[sizeof(off_t) == sizeof(uoff_t) ? 1 : -1];
259 /* Some useful definitions */
261 #define FALSE ((int) 0)
263 #define TRUE ((int) 1)
265 #define SKIP ((int) 2)
267 /* Macros for min/max. */
269 #define MIN(a,b) (((a)<(b))?(a):(b))
273 #define MAX(a,b) (((a)>(b))?(a):(b))
276 /* buffer allocation schemes */
277 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
278 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
279 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
280 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
282 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
283 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
284 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
285 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
287 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
288 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
289 #define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
293 #if defined(__GLIBC__)
294 /* glibc uses __errno_location() to get a ptr to errno */
295 /* We can just memorize it once - no multithreading in busybox :) */
296 extern int *const bb_errno;
298 #define errno (*bb_errno)
301 #if !(ULONG_MAX > 0xffffffff)
302 /* Only 32-bit CPUs need this, 64-bit ones use inlined version */
303 uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
306 unsigned long long monotonic_ns(void) FAST_FUNC;
307 unsigned long long monotonic_us(void) FAST_FUNC;
308 unsigned long long monotonic_ms(void) FAST_FUNC;
309 unsigned monotonic_sec(void) FAST_FUNC;
311 extern void chomp(char *s) FAST_FUNC;
312 extern void trim(char *s) FAST_FUNC;
313 extern char *skip_whitespace(const char *) FAST_FUNC;
314 extern char *skip_non_whitespace(const char *) FAST_FUNC;
315 extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
317 extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
319 //TODO: supply a pointer to char[11] buffer (avoid statics)?
320 extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
321 extern int is_directory(const char *name, int followLinks) FAST_FUNC;
322 enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
323 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
324 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
325 FILEUTILS_RECUR = 1 << 2, /* -R */
326 FILEUTILS_FORCE = 1 << 3, /* -f */
327 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
328 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
329 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
330 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
331 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
333 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
334 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
336 FILEUTILS_IGNORE_CHMOD_ERR = 1 << 11,
338 FILEUTILS_VERBOSE = (1 << 12) * ENABLE_FEATURE_VERBOSE,
340 #define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
341 extern int remove_file(const char *path, int flags) FAST_FUNC;
342 /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
343 * the source, not copy (unless "source" is a directory).
344 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
345 * work coreutils-compatibly. */
346 extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
349 ACTION_RECURSE = (1 << 0),
350 ACTION_FOLLOWLINKS = (1 << 1),
351 ACTION_FOLLOWLINKS_L0 = (1 << 2),
352 ACTION_DEPTHFIRST = (1 << 3),
353 /*ACTION_REVERSE = (1 << 4), - unused */
354 ACTION_QUIET = (1 << 5),
355 ACTION_DANGLING_OK = (1 << 6),
357 typedef uint8_t recurse_flags_t;
358 extern int recursive_action(const char *fileName, unsigned flags,
359 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
360 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
361 void* userData, unsigned depth) FAST_FUNC;
362 extern int device_open(const char *device, int mode) FAST_FUNC;
363 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
364 extern int xgetpty(char *line) FAST_FUNC;
365 extern int get_console_fd_or_die(void) FAST_FUNC;
366 extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
367 extern char *find_block_device(const char *path) FAST_FUNC;
368 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
369 extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
370 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
371 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
372 /* "short" copy can be detected by return value < size */
373 /* this helper yells "short read!" if param is not -1 */
374 extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
376 extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
377 char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
378 /* xxxx_strip version can modify its parameter:
382 * "abc/def/" -> "def" !!
384 char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
385 /* "abc/def/" -> "" and it never modifies 'path' */
386 char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
387 /* Simpler version: does not special case "/" string */
388 const char *bb_basename(const char *name) FAST_FUNC;
389 /* NB: can violate const-ness (similarly to strchr) */
390 char *last_char_is(const char *s, int c) FAST_FUNC;
391 const char* endofname(const char *name) FAST_FUNC;
393 void ndelay_on(int fd) FAST_FUNC;
394 void ndelay_off(int fd) FAST_FUNC;
395 void close_on_exec_on(int fd) FAST_FUNC;
396 void xdup2(int, int) FAST_FUNC;
397 void xmove_fd(int, int) FAST_FUNC;
400 DIR *xopendir(const char *path) FAST_FUNC;
401 DIR *warn_opendir(const char *path) FAST_FUNC;
403 char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
404 char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
405 char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
406 /* !RETURNS_MALLOC: it's a realloc-like function */
407 char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
409 char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
413 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
414 * otherwise would kill us, except for those resulting from bugs:
415 * SIGSEGV, SIGILL, SIGFPE.
416 * Other fatal signals not included (TODO?):
417 * SIGBUS Bus error (bad memory access)
418 * SIGPOLL Pollable event. Synonym of SIGIO
419 * SIGPROF Profiling timer expired
420 * SIGSYS Bad argument to routine
421 * SIGTRAP Trace/breakpoint trap
423 * The only known arch with some of these sigs not fitting
424 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
425 * Dance around with long long to guard against that...
427 BB_FATAL_SIGS = (int)(0
431 + (1LL << SIGPIPE) // Write to pipe with no readers
432 + (1LL << SIGQUIT) // Quit from keyboard
433 + (1LL << SIGABRT) // Abort signal from abort(3)
434 + (1LL << SIGALRM) // Timer signal from alarm(2)
435 + (1LL << SIGVTALRM) // Virtual alarm clock
436 + (1LL << SIGXCPU) // CPU time limit exceeded
437 + (1LL << SIGXFSZ) // File size limit exceeded
438 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
442 void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
443 /* Unlike signal() and bb_signals, sets handler with sigaction()
444 * and in a way that while signal handler is run, no other signals
445 * will be blocked; syscalls will not be restarted: */
446 void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
447 /* syscalls like read() will be interrupted with EINTR: */
448 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
449 /* syscalls like read() won't be interrupted (though select/poll will be): */
450 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
451 void wait_for_any_sig(void) FAST_FUNC;
452 void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
453 void sig_block(int sig) FAST_FUNC;
454 void sig_unblock(int sig) FAST_FUNC;
455 /* Will do sigaction(signum, act, NULL): */
456 int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
457 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
458 int sigprocmask_allsigs(int how) FAST_FUNC;
459 /* Standard handler which just records signo */
460 extern smallint bb_got_signal;
461 void record_signo(int signo); /* not FAST_FUNC! */
464 void xsetgid(gid_t gid) FAST_FUNC;
465 void xsetuid(uid_t uid) FAST_FUNC;
466 void xsetegid(gid_t egid) FAST_FUNC;
467 void xseteuid(uid_t euid) FAST_FUNC;
468 void xchdir(const char *path) FAST_FUNC;
469 void xchroot(const char *path) FAST_FUNC;
470 void xsetenv(const char *key, const char *value) FAST_FUNC;
471 void bb_unsetenv(const char *key) FAST_FUNC;
472 void bb_unsetenv_and_free(char *key) FAST_FUNC;
473 void xunlink(const char *pathname) FAST_FUNC;
474 void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
475 void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
476 int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
477 int open_or_warn(const char *pathname, int flags) FAST_FUNC;
478 int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
479 int xopen(const char *pathname, int flags) FAST_FUNC;
480 int xopen_nonblocking(const char *pathname) FAST_FUNC;
481 int xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g) FAST_FUNC;
482 int open_or_warn_stdin(const char *pathname) FAST_FUNC;
483 int xopen_stdin(const char *pathname) FAST_FUNC;
484 void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
485 int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
486 off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
487 int xmkstemp(char *template) FAST_FUNC;
488 off_t fdlength(int fd) FAST_FUNC;
490 uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
491 const char *override,
492 unsigned override_units,
495 void xpipe(int filedes[2]) FAST_FUNC;
496 /* In this form code with pipes is much more readable */
497 struct fd_pair { int rd; int wr; };
498 #define piped_pair(pair) pipe(&((pair).rd))
499 #define xpiped_pair(pair) xpipe(&((pair).rd))
501 /* Useful for having small structure members/global variables */
502 typedef int8_t socktype_t;
503 typedef int8_t family_t;
504 struct BUG_too_small {
505 char BUG_socktype_t_too_small[(0
512 char BUG_family_t_too_small[(0
529 void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
530 time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
531 char *strftime_HHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
532 char *strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
534 int xsocket(int domain, int type, int protocol) FAST_FUNC;
535 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
536 void xlisten(int s, int backlog) FAST_FUNC;
537 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
538 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
539 socklen_t tolen) FAST_FUNC;
540 /* SO_REUSEADDR allows a server to rebind to an address that is already
541 * "in use" by old connections to e.g. previous server instance which is
542 * killed or crashed. Without it bind will fail until all such connections
543 * time out. Linux does not allow multiple live binds on same ip:port
544 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
545 * Turn it on before you call bind(). */
546 void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
547 int setsockopt_broadcast(int fd) FAST_FUNC;
548 int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
549 /* NB: returns port in host byte order */
550 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
551 typedef struct len_and_sockaddr {
555 struct sockaddr_in sin;
556 #if ENABLE_FEATURE_IPV6
557 struct sockaddr_in6 sin6;
562 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
563 LSA_SIZEOF_SA = sizeof(
566 struct sockaddr_in sin;
567 #if ENABLE_FEATURE_IPV6
568 struct sockaddr_in6 sin6;
573 /* Create stream socket, and allocate suitable lsa.
574 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
575 * af == AF_UNSPEC will result in trying to create IPv6 socket,
576 * and if kernel doesn't support it, fall back to IPv4.
577 * This is useful if you plan to bind to resulting local lsa.
579 int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
580 int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
581 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
582 * numeric IP ("N.N.N.N") or numeric IPv6 address,
583 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
584 * Only if there is no suffix, port argument is used */
585 /* NB: these set SO_REUSEADDR before bind */
586 int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
587 int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
588 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
589 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
590 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
591 * If there is no suffix, port argument is used */
592 int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
593 /* Connect to peer identified by lsa */
594 int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
595 /* Get local address of bound or accepted socket */
596 len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
597 /* Get remote address of connected or accepted socket */
598 len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
599 /* Return malloc'ed len_and_sockaddr with socket address of host:port
600 * Currently will return IPv4 or IPv6 sockaddrs only
601 * (depending on host), but in theory nothing prevents e.g.
602 * UNIX socket address being returned, IPX sockaddr etc...
603 * On error does bb_error_msg and returns NULL */
604 len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
605 /* Version which dies on error */
606 len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
607 len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
608 /* Same, useful if you want to force family (e.g. IPv6) */
609 #if !ENABLE_FEATURE_IPV6
610 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
611 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
613 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
614 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
616 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
617 * otherwise no-op. Useful for ftp.
618 * NB: does NOT do htons() internally, just direct assignment. */
619 void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
620 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
621 int get_nport(const struct sockaddr *sa) FAST_FUNC;
622 /* Reverse DNS. Returns NULL on failure. */
623 char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
624 /* This one doesn't append :PORTNUM */
625 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
626 /* This one also doesn't fall back to dotted IP (returns NULL) */
627 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
628 /* inet_[ap]ton on steroids */
629 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
630 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
631 // "old" (ipv4 only) API
632 // users: traceroute.c hostname.c - use _list_ of all IPs
633 struct hostent *xgethostbyname(const char *name) FAST_FUNC;
634 // Also mount.c and inetd.c are using gethostbyname(),
635 // + inet_common.c has additional IPv4-only stuff
638 void socket_want_pktinfo(int fd) FAST_FUNC;
639 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
640 const struct sockaddr *to,
641 const struct sockaddr *from,
642 socklen_t tolen) FAST_FUNC;
643 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
644 struct sockaddr *from,
646 socklen_t sa_size) FAST_FUNC;
648 uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
650 char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
651 char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
652 void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
653 char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
654 char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
655 unsigned count_strstr(const char *str, const char *sub) FAST_FUNC;
656 char *xmalloc_substitute_string(const char *src, int count, const char *sub, const char *repl) FAST_FUNC;
657 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
658 * But potentially slow, don't use in one-billion-times loops */
659 int bb_putchar(int ch) FAST_FUNC;
660 /* Note: does not use stdio, writes to fd 2 directly */
661 int bb_putchar_stderr(char ch) FAST_FUNC;
662 char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
663 // gcc-4.1.1 still isn't good enough at optimizing it
664 // (+200 bytes compared to macro)
665 //static ALWAYS_INLINE
666 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
667 //static ALWAYS_INLINE
668 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
669 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
670 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
671 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
672 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
673 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
675 typedef struct uni_stat_t {
677 unsigned unicode_count;
678 unsigned unicode_width;
680 /* Returns a string with unprintable chars replaced by '?' or
681 * SUBST_WCHAR. This function is unicode-aware. */
682 const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
683 /* Prints unprintable char ch as ^C or M-c to file
684 * (M-c is used only if ch is ORed with PRINTABLE_META),
685 * else it is printed as-is (except for ch = 0x9b) */
686 enum { PRINTABLE_META = 0x100 };
687 void fputc_printable(int ch, FILE *file) FAST_FUNC;
688 /* Return a string that is the printable representation of character ch.
689 * Buffer must hold at least four characters. */
691 VISIBLE_ENDLINE = 1 << 0,
692 VISIBLE_SHOW_TABS = 1 << 1,
694 void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
696 /* dmalloc will redefine these to it's own implementation. It is safe
697 * to have the prototypes here unconditionally. */
698 void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
699 void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
700 void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
701 void *xrealloc(void *old, size_t size) FAST_FUNC;
702 /* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
703 * at least v[idx] and v[idx+1], for all idx values.
704 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
705 * when all elements are used up. New elements are zeroed out.
706 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
707 * skipping an index is a bad bug - it may miss a realloc!
709 #define xrealloc_vector(vector, shift, idx) \
710 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
711 void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
714 extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
715 extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count, int loop_on_EINTR) FAST_FUNC;
716 // NB: will return short read on error, not -1,
717 // if some data was read before error occurred
718 extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
719 extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
720 extern unsigned char xread_char(int fd) FAST_FUNC;
721 extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
722 extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
723 // Reads one line a-la fgets (but doesn't save terminating '\n').
724 // Reads byte-by-byte. Useful when it is important to not read ahead.
725 // Bytes are appended to pfx (which must be malloced, or NULL).
726 extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
727 /* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
728 extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
729 /* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
730 extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
731 /* Never returns NULL */
732 extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
735 # define bb_arg_max() ((unsigned)ARG_MAX)
736 #elif defined _SC_ARG_MAX
737 unsigned bb_arg_max(void) FAST_FUNC;
739 # define bb_arg_max() ((unsigned)(32 * 1024))
741 unsigned bb_clk_tck(void) FAST_FUNC;
743 #define SEAMLESS_COMPRESSION (0 \
744 || ENABLE_FEATURE_SEAMLESS_XZ \
745 || ENABLE_FEATURE_SEAMLESS_LZMA \
746 || ENABLE_FEATURE_SEAMLESS_BZ2 \
747 || ENABLE_FEATURE_SEAMLESS_GZ \
748 || ENABLE_FEATURE_SEAMLESS_Z)
750 #if SEAMLESS_COMPRESSION
751 /* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
752 extern int setup_unzip_on_fd(int fd, int fail_if_not_compressed) FAST_FUNC;
753 /* Autodetects .gz etc */
754 extern int open_zipped(const char *fname, int fail_if_not_compressed) FAST_FUNC;
756 # define setup_unzip_on_fd(...) (0)
757 # define open_zipped(fname, fail_if_not_compressed) open((fname), O_RDONLY);
759 extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
761 extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
762 // NB: will return short write on error, not -1,
763 // if some data was written before error occurred
764 extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
765 extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
766 extern void xwrite_str(int fd, const char *str) FAST_FUNC;
767 extern ssize_t full_write1_str(const char *str) FAST_FUNC;
768 extern ssize_t full_write2_str(const char *str) FAST_FUNC;
769 extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
771 /* Close fd, but check for failures (some types of write errors) */
772 extern void xclose(int fd) FAST_FUNC;
774 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
775 extern void xprint_and_close_file(FILE *file) FAST_FUNC;
777 /* Reads a line from a text file, up to a newline or NUL byte, inclusive.
778 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
779 * end of line. If end isn't NULL, length of the chunk is stored in it.
780 * Returns NULL if EOF/error.
782 extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
783 /* Reads up to (and including) TERMINATING_STRING: */
784 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
785 /* Same, with limited max size, and returns the length (excluding NUL): */
786 extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
787 /* Chops off TERMINATING_STRING from the end: */
788 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
789 /* Reads up to (and including) "\n" or NUL byte: */
790 extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
791 /* Chops off '\n' from the end, unlike fgets: */
792 extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
793 /* Same, but doesn't try to conserve space (may have some slack after the end) */
794 /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
796 void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
797 void die_if_ferror_stdout(void) FAST_FUNC;
798 int fflush_all(void) FAST_FUNC;
799 void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
800 int fclose_if_not_stdin(FILE *file) FAST_FUNC;
801 FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
802 /* Prints warning to stderr and returns NULL on failure: */
803 FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
804 /* "Opens" stdin if filename is special, else just opens file: */
805 FILE* xfopen_stdin(const char *filename) FAST_FUNC;
806 FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
807 FILE* fopen_for_read(const char *path) FAST_FUNC;
808 FILE* xfopen_for_read(const char *path) FAST_FUNC;
809 FILE* fopen_for_write(const char *path) FAST_FUNC;
810 FILE* xfopen_for_write(const char *path) FAST_FUNC;
811 FILE* xfdopen_for_read(int fd) FAST_FUNC;
812 FILE* xfdopen_for_write(int fd) FAST_FUNC;
814 int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
815 void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
817 /* Wrapper which restarts poll on EINTR or ENOMEM.
818 * On other errors complains [perror("poll")] and returns.
819 * Warning! May take (much) longer than timeout_ms to return!
820 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
821 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
823 char *safe_gethostname(void) FAST_FUNC;
825 /* Convert each alpha char in str to lower-case */
826 char* str_tolower(char *str) FAST_FUNC;
828 char *utoa(unsigned n) FAST_FUNC;
829 char *itoa(int n) FAST_FUNC;
830 /* Returns a pointer past the formatted number, does NOT null-terminate */
831 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
832 char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
833 /* Intelligent formatters of bignums */
834 char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
835 char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
836 /* If block_size == 0, display size without fractional part,
837 * else display (size * block_size) with one decimal digit.
838 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
839 * else divide by display_unit and do not use suffix. */
840 #define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
841 #define HUMAN_READABLE_MAX_WIDTH_STR "7"
842 //TODO: provide pointer to buf (avoid statics)?
843 const char *make_human_readable_str(unsigned long long size,
844 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
845 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
846 char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
848 char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
850 /* Generate a UUID */
851 void generate_uuid(uint8_t *buf) FAST_FUNC;
853 /* Last element is marked by mult == 0 */
858 extern const struct suffix_mult bkm_suffixes[];
859 #define km_suffixes (bkm_suffixes + 1)
864 /* Using xatoi() instead of naive atoi() is not always convenient -
865 * in many places people want *non-negative* values, but store them
866 * in signed int. Therefore we need this one:
867 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
868 * It should really be named xatoi_nonnegative (since it allows 0),
869 * but that would be too long.
871 int xatoi_positive(const char *numstr) FAST_FUNC;
873 /* Useful for reading port numbers */
874 uint16_t xatou16(const char *numstr) FAST_FUNC;
877 /* These parse entries in /etc/passwd and /etc/group. This is desirable
878 * for BusyBox since we want to avoid using the glibc NSS stuff, which
879 * increases target size and is often not needed on embedded systems. */
880 long xuname2uid(const char *name) FAST_FUNC;
881 long xgroup2gid(const char *name) FAST_FUNC;
882 /* wrapper: allows string to contain numeric uid or gid */
883 unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
884 /* from chpst. Does not die, returns 0 on failure */
889 /* always sets uid and gid */
890 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
891 /* always sets uid and gid, allows numeric; exits on failure */
892 void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
893 /* chown-like handling of "user[:[group]" */
894 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
895 struct passwd* xgetpwnam(const char *name) FAST_FUNC;
896 struct group* xgetgrnam(const char *name) FAST_FUNC;
897 struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
898 struct group* xgetgrgid(gid_t gid) FAST_FUNC;
899 char* xuid2uname(uid_t uid) FAST_FUNC;
900 char* xgid2group(gid_t gid) FAST_FUNC;
901 char* uid2uname(uid_t uid) FAST_FUNC;
902 char* gid2group(gid_t gid) FAST_FUNC;
903 char* uid2uname_utoa(uid_t uid) FAST_FUNC;
904 char* gid2group_utoa(gid_t gid) FAST_FUNC;
905 /* versions which cache results (useful for ps, ls etc) */
906 const char* get_cached_username(uid_t uid) FAST_FUNC;
907 const char* get_cached_groupname(gid_t gid) FAST_FUNC;
908 void clear_username_cache(void) FAST_FUNC;
909 /* internally usernames are saved in fixed-sized char[] buffers */
910 enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
911 #if ENABLE_FEATURE_CHECK_NAMES
912 void die_if_bad_username(const char* name) FAST_FUNC;
914 #define die_if_bad_username(name) ((void)(name))
917 #if ENABLE_FEATURE_UTMP
918 void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
919 void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
921 # define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
922 # define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
926 int file_is_executable(const char *name) FAST_FUNC;
927 char *find_executable(const char *filename, char **PATHp) FAST_FUNC;
928 int executable_exists(const char *filename) FAST_FUNC;
930 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
931 * but it may exec busybox and call applet instead of searching PATH.
933 #if ENABLE_FEATURE_PREFER_APPLETS
934 int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
935 #define BB_EXECLP(prog,cmd,...) \
937 if (find_applet_by_name(prog) >= 0) \
938 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
939 execlp(prog, cmd, __VA_ARGS__); \
942 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
943 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
945 int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
947 /* xvfork() can't be a _function_, return after vfork mangles stack
948 * in the parent. It must be a macro. */
951 pid_t bb__xvfork_pid = vfork(); \
952 if (bb__xvfork_pid < 0) \
953 bb_perror_msg_and_die("vfork"); \
957 pid_t xfork(void) FAST_FUNC;
960 /* NOMMU friendy fork+exec: */
961 pid_t spawn(char **argv) FAST_FUNC;
962 pid_t xspawn(char **argv) FAST_FUNC;
964 pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
965 pid_t wait_any_nohang(int *wstat) FAST_FUNC;
966 /* wait4pid: unlike waitpid, waits ONLY for one process.
967 * Returns sig + 0x180 if child is killed by signal.
968 * It's safe to pass negative 'pids' from failed [v]fork -
969 * wait4pid will return -1 (and will not clobber [v]fork's errno).
970 * IOW: rc = wait4pid(spawn(argv));
971 * if (rc < 0) bb_perror_msg("%s", argv[0]);
972 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
974 int wait4pid(pid_t pid) FAST_FUNC;
975 /* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
976 int spawn_and_wait(char **argv) FAST_FUNC;
977 /* Does NOT check that applet is NOFORK, just blindly runs it */
978 int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
980 /* Helpers for daemonization.
982 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
984 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
985 * rexec's itself on NOMMU with argv passed as command line.
986 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
987 * from the start. (It will detect it and not reexec again second time).
988 * You have to audit carefully that you don't do something twice as a result
989 * (opening files/sockets, parsing config files etc...)!
991 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
992 * (will do setsid()).
994 * fork_or_rexec(argv) = bare-bones fork on MMU,
995 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
996 * On MMU ignores argv.
998 * Helper for network daemons in foreground mode:
1000 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
1001 * to /dev/null if they are not.
1004 DAEMON_CHDIR_ROOT = 1,
1005 DAEMON_DEVNULL_STDIO = 2,
1006 DAEMON_CLOSE_EXTRA_FDS = 4,
1007 DAEMON_ONLY_SANITIZE = 8, /* internal use */
1008 DAEMON_DOUBLE_FORK = 16, /* double fork to avoid controlling tty */
1011 enum { re_execed = 0 };
1012 # define fork_or_rexec(argv) xfork()
1013 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1014 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
1016 extern bool re_execed;
1017 /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1018 * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1020 void re_exec(char **argv) NORETURN FAST_FUNC;
1021 pid_t fork_or_rexec(char **argv) FAST_FUNC;
1022 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1023 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1024 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
1025 # define fork() BUG_fork_is_unavailable_on_nommu()
1026 # define xfork() BUG_fork_is_unavailable_on_nommu()
1027 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1028 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
1030 void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1031 void bb_sanitize_stdio(void) FAST_FUNC;
1032 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
1033 int sanitize_env_if_suid(void) FAST_FUNC;
1036 char* single_argv(char **argv) FAST_FUNC;
1037 extern const char *const bb_argv_dash[]; /* "-", NULL */
1038 extern const char *opt_complementary;
1039 #if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
1040 #define No_argument "\0"
1041 #define Required_argument "\001"
1042 #define Optional_argument "\002"
1043 extern const char *applet_long_options;
1045 extern uint32_t option_mask32;
1046 extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
1049 /* Having next pointer as a first member allows easy creation
1050 * of "llist-compatible" structs, and using llist_FOO functions
1053 typedef struct llist_t {
1054 struct llist_t *link;
1057 void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1058 void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1059 void *llist_pop(llist_t **elm) FAST_FUNC;
1060 void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1061 void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1062 llist_t *llist_rev(llist_t *list) FAST_FUNC;
1063 llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
1064 /* BTW, surprisingly, changing API to
1065 * llist_t *llist_add_to(llist_t *old_head, void *data)
1066 * etc does not result in smaller code... */
1068 /* start_stop_daemon and udhcpc are special - they want
1069 * to create pidfiles regardless of FEATURE_PIDFILE */
1070 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
1071 /* True only if we created pidfile which is *file*, not /dev/null etc */
1072 extern smallint wrote_pidfile;
1073 void write_pidfile(const char *path) FAST_FUNC;
1074 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
1076 enum { wrote_pidfile = 0 };
1077 #define write_pidfile(path) ((void)0)
1078 #define remove_pidfile(path) ((void)0)
1083 LOGMODE_STDIO = (1 << 0),
1084 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
1085 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1087 extern const char *msg_eol;
1088 extern smallint syslog_level;
1089 extern smallint logmode;
1090 extern int die_sleep;
1091 extern uint8_t xfunc_error_retval;
1092 extern jmp_buf die_jmp;
1093 extern void xfunc_die(void) NORETURN FAST_FUNC;
1094 extern void bb_show_usage(void) NORETURN FAST_FUNC;
1095 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1096 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1097 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1098 extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1099 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1100 extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
1101 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1102 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1103 extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
1104 extern void bb_perror_nomsg(void) FAST_FUNC;
1105 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1106 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
1108 /* We need to export XXX_main from libbusybox
1109 * only if we build "individual" binaries
1111 #if ENABLE_FEATURE_INDIVIDUAL
1112 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1114 #define MAIN_EXTERNALLY_VISIBLE
1118 /* Applets which are useful from another applets */
1119 int bb_cat(char** argv);
1120 /* If shell needs them, they exist even if not enabled as applets */
1121 int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1122 int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1123 int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1124 int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
1125 /* Similar, but used by chgrp, not shell */
1126 int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
1128 int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1129 /* Don't need IF_xxx() guard for these */
1130 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1131 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1134 void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
1139 /* This structure defines protocol families and their handlers. */
1145 char* FAST_FUNC (*print)(unsigned char *);
1146 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1147 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1148 void FAST_FUNC (*herror)(char *text);
1149 int FAST_FUNC (*rprint)(int options);
1150 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
1151 /* may modify src */
1152 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
1154 /* This structure defines hardware protocols and their handlers. */
1160 char* FAST_FUNC (*print)(unsigned char *);
1161 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1162 int FAST_FUNC (*activate)(int fd);
1163 int suppress_null_addr;
1165 extern smallint interface_opt_a;
1166 int display_interfaces(char *ifname) FAST_FUNC;
1167 int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1168 #if ENABLE_FEATURE_HWIB
1169 int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1171 #define in_ib(a, b) 1 /* fail */
1173 const struct aftype *get_aftype(const char *name) FAST_FUNC;
1174 const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1175 const struct hwtype *get_hwntype(int type) FAST_FUNC;
1178 #ifndef BUILD_INDIVIDUAL
1179 extern int find_applet_by_name(const char *name) FAST_FUNC;
1180 /* Returns only if applet is not found. */
1181 extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
1182 extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
1185 #ifdef HAVE_MNTENT_H
1186 extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
1187 extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
1189 extern void erase_mtab(const char * name) FAST_FUNC;
1190 extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1191 extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1193 extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1195 # define bb_warn_ignoring_args(arg) ((void)0)
1198 extern int get_linux_version_code(void) FAST_FUNC;
1200 extern char *query_loop(const char *device) FAST_FUNC;
1201 extern int del_loop(const char *device) FAST_FUNC;
1202 /* If *devname is not NULL, use that name, otherwise try to find free one,
1203 * malloc and return it in *devname.
1204 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
1205 extern int set_loop(char **devname, const char *file, unsigned long long offset, int ro) FAST_FUNC;
1207 /* Like bb_ask below, but asks on stdin with no timeout. */
1208 char *bb_ask_stdin(const char * prompt) FAST_FUNC;
1209 //TODO: pass buf pointer or return allocated buf (avoid statics)?
1210 char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
1211 int bb_ask_confirmation(void) FAST_FUNC;
1213 int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
1216 * Config file parser
1219 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1220 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1221 // TODO: COLLAPSE and TRIM seem to always go in pair
1222 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1223 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
1224 // keep a copy of current line
1225 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
1226 PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
1228 // * remove leading and trailing delimiters and collapse
1229 // multiple delimiters into one
1230 // * warn and continue if less than mintokens delimiters found
1231 // * grab everything into last token
1232 // * comments are recognized even if they aren't the first char
1233 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
1235 typedef struct parser_t {
1239 size_t line_alloc, nline_alloc;
1242 parser_t* config_open(const char *filename) FAST_FUNC;
1243 parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
1244 /* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
1245 int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1246 #define config_read(parser, tokens, max, min, str, flags) \
1247 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1248 void config_close(parser_t *parser) FAST_FUNC;
1250 /* Concatenate path and filename to new allocated buffer.
1251 * Add "/" only as needed (no duplicate "//" are produced).
1252 * If path is NULL, it is assumed to be "/".
1253 * filename should not be NULL. */
1254 char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1255 /* Returns NULL on . and .. */
1256 char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1259 int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1261 int get_signum(const char *name) FAST_FUNC;
1262 const char *get_signame(int number) FAST_FUNC;
1263 void print_signames(void) FAST_FUNC;
1265 char *bb_simplify_path(const char *path) FAST_FUNC;
1266 /* Returns ptr to NUL */
1267 char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
1269 #define LOGIN_FAIL_DELAY 3
1270 extern void bb_do_delay(int seconds) FAST_FUNC;
1271 extern void change_identity(const struct passwd *pw) FAST_FUNC;
1272 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
1274 /* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1275 * Note that getpwuid result might need xstrdup'ing
1276 * if there is a possibility of intervening getpwxxx() calls.
1278 const char *get_shell_name(void) FAST_FUNC;
1281 extern void renew_current_security_context(void) FAST_FUNC;
1282 extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1283 extern context_t set_security_context_component(security_context_t cur_context,
1284 char *user, char *role, char *type, char *range) FAST_FUNC;
1285 extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1286 extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1288 #define selinux_preserve_fcontext(fdesc) ((void)0)
1290 extern void selinux_or_die(void) FAST_FUNC;
1293 /* systemd support */
1294 #define SD_LISTEN_FDS_START 3
1295 int sd_listen_fds(void);
1298 /* setup_environment:
1299 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
1300 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1302 * USER=pw->pw_name, LOGNAME=pw->pw_name
1303 * PATH=bb_default_[root_]path
1306 * else if change_env = 1:
1307 * if not root (if pw->pw_uid != 0):
1308 * USER=pw->pw_name, LOGNAME=pw->pw_name
1313 #define SETUP_ENV_CHANGEENV (1 << 0)
1314 #define SETUP_ENV_CLEARENV (1 << 1)
1315 #define SETUP_ENV_TO_TMP (1 << 2)
1316 #define SETUP_ENV_NO_CHDIR (1 << 4)
1317 void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1318 void nuke_str(char *str) FAST_FUNC;
1319 int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1320 int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
1321 /* Returns a malloced string */
1322 #if !ENABLE_USE_BB_CRYPT
1323 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1325 extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1326 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1328 * rnd is additional random input. New one is returned.
1329 * Useful if you call crypt_make_salt many times in a row:
1330 * rnd = crypt_make_salt(buf1, 4, 0);
1331 * rnd = crypt_make_salt(buf2, 4, rnd);
1332 * rnd = crypt_make_salt(buf3, 4, rnd);
1333 * (otherwise we risk having same salt generated)
1335 extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1336 /* "$N$" + sha_salt_16_bytes + NUL */
1337 #define MAX_PW_SALT_LEN (3 + 16 + 1)
1338 extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1341 /* Returns number of lines changed, or -1 on error */
1342 #if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1343 #define update_passwd(filename, username, data, member) \
1344 update_passwd(filename, username, data)
1346 extern int update_passwd(const char *filename,
1347 const char *username,
1349 const char *member) FAST_FUNC;
1351 int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1352 int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1353 int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1354 int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1355 const char *nth_string(const char *strings, int n) FAST_FUNC;
1357 extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1358 extern void print_login_prompt(void) FAST_FUNC;
1360 char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
1361 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1362 int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1364 int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1366 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1367 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1368 int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1369 #if ENABLE_IOCTL_HEX2STR_ERROR
1370 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1371 int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1372 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1373 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1375 int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1376 int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1377 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1378 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1381 char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1382 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1383 void reset_ino_dev_hashtable(void) FAST_FUNC;
1385 /* At least glibc has horrendously large inline for this, so wrap it */
1386 unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
1388 #define makedev(a,b) bb_makedev(a,b)
1392 /* "Keycodes" that report an escape sequence.
1393 * We use something which fits into signed char,
1394 * yet doesn't represent any valid Unicode character.
1395 * Also, -1 is reserved for error indication and we don't use it. */
1403 KEYCODE_INSERT = -8,
1404 KEYCODE_DELETE = -9,
1405 KEYCODE_PAGEUP = -10,
1406 KEYCODE_PAGEDOWN = -11,
1407 // -12 is reserved for Alt/Ctrl/Shift-TAB
1418 KEYCODE_FUN10 = -22,
1419 KEYCODE_FUN11 = -23,
1420 KEYCODE_FUN12 = -24,
1422 /* Be sure that last defined value is small enough
1423 * to not interfere with Alt/Ctrl/Shift bits.
1424 * So far we do not exceed -31 (0xfff..fffe1),
1425 * which gives us three upper bits in LSB to play with.
1427 //KEYCODE_SHIFT_TAB = (-12) & ~0x80,
1428 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1429 //KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1430 //KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
1431 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1432 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
1433 //KEYCODE_ALT_UP = KEYCODE_UP & ~0x20,
1434 //KEYCODE_ALT_DOWN = KEYCODE_DOWN & ~0x20,
1435 KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
1436 KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
1438 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
1439 /* How long is the longest ESC sequence we know?
1440 * We want it big enough to be able to contain
1441 * cursor position sequence "ESC [ 9999 ; 9999 R"
1443 KEYCODE_BUFFER_SIZE = 16
1445 /* Note: fd may be in blocking or non-blocking mode, both make sense.
1446 * For one, less uses non-blocking mode.
1447 * Only the first read syscall inside read_key may block indefinitely
1448 * (unless fd is in non-blocking mode),
1449 * subsequent reads will time out after a few milliseconds.
1450 * Return of -1 means EOF or error (errno == 0 on EOF).
1451 * buffer[0] is used as a counter of buffered chars and must be 0
1454 * -2: do not poll for input;
1455 * -1: poll(-1) (i.e. block);
1456 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
1458 int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
1459 void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
1462 #if ENABLE_FEATURE_EDITING
1463 /* It's NOT just ENABLEd or disabled. It's a number: */
1464 # if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
1465 # define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1466 unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
1468 # define MAX_HISTORY 0
1470 typedef struct line_input_t {
1472 const char *path_lookup;
1476 int max_history; /* must never be <= 0 */
1477 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1478 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1479 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1480 * in on-disk history"
1481 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1482 * also in on-disk history (and thus need to be skipped on save)"
1484 unsigned cnt_history_in_file;
1485 const char *hist_file;
1487 char *history[MAX_HISTORY + 1];
1491 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1492 TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1493 USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1494 VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
1495 WITH_PATH_LOOKUP = 0x10,
1496 FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1498 line_input_t *new_line_input_t(int flags) FAST_FUNC;
1499 /* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1501 * maxsize must be >= 2.
1503 * -1 on read errors or EOF, or on bare Ctrl-D,
1504 * 0 on ctrl-C (the line entered is still returned in 'command'),
1505 * >0 length of input string, including terminating '\n'
1507 int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize, int timeout) FAST_FUNC;
1508 void show_history(const line_input_t *st) FAST_FUNC;
1509 # if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1510 void save_history(line_input_t *st);
1513 #define MAX_HISTORY 0
1514 int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1515 #define read_line_input(state, prompt, command, maxsize, timeout) \
1516 read_line_input(prompt, command, maxsize)
1521 # ifdef TASK_COMM_LEN
1522 enum { COMM_LEN = TASK_COMM_LEN };
1524 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1525 enum { COMM_LEN = 16 };
1530 unsigned long mapped_rw;
1531 unsigned long mapped_ro;
1532 unsigned long shared_clean;
1533 unsigned long shared_dirty;
1534 unsigned long private_clean;
1535 unsigned long private_dirty;
1536 unsigned long stack;
1537 unsigned long smap_pss, smap_swap;
1538 unsigned long smap_size;
1539 unsigned long smap_start;
1545 #define procps_read_smaps(pid, total, cb, data) \
1546 procps_read_smaps(pid, total)
1548 int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1549 void (*cb)(struct smaprec *, void *), void *data);
1551 typedef struct procps_status_t {
1553 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
1554 uint8_t shift_pages_to_bytes;
1555 uint8_t shift_pages_to_kb;
1556 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1560 IF_SELINUX(char *context;)
1561 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
1562 /* Everything below must contain no ptrs to malloc'ed data:
1563 * it is memset(0) for each process in procps_scan() */
1564 unsigned long vsz, rss; /* we round it to kbytes */
1565 unsigned long stime, utime;
1566 unsigned long start_time;
1573 #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1578 unsigned tty_major,tty_minor;
1579 #if ENABLE_FEATURE_TOPMEM
1580 struct smaprec smaps;
1583 /* basename of executable in exec(2), read from /proc/N/stat
1584 * (if executable is symlink or script, it is NOT replaced
1585 * by link target or interpreter name) */
1586 char comm[COMM_LEN];
1587 /* user/group? - use passwd/group parsing functions */
1588 #if ENABLE_FEATURE_TOP_SMP_PROCESS
1589 int last_seen_on_cpu;
1592 /* flag bits for procps_scan(xx, flags) calls */
1594 PSSCAN_PID = 1 << 0,
1595 PSSCAN_PPID = 1 << 1,
1596 PSSCAN_PGID = 1 << 2,
1597 PSSCAN_SID = 1 << 3,
1598 PSSCAN_UIDGID = 1 << 4,
1599 PSSCAN_COMM = 1 << 5,
1600 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
1601 PSSCAN_ARGV0 = 1 << 7,
1602 PSSCAN_EXE = 1 << 8,
1603 PSSCAN_STATE = 1 << 9,
1604 PSSCAN_VSZ = 1 << 10,
1605 PSSCAN_RSS = 1 << 11,
1606 PSSCAN_STIME = 1 << 12,
1607 PSSCAN_UTIME = 1 << 13,
1608 PSSCAN_TTY = 1 << 14,
1609 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1610 /* NB: used by find_pid_by_name(). Any applet using it
1611 * needs to be mentioned here. */
1612 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1613 || ENABLE_PGREP || ENABLE_PKILL
1617 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
1618 PSSCAN_START_TIME = 1 << 18,
1619 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1620 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1621 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1622 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
1624 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1625 void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1626 procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
1627 /* Format cmdline (up to col chars) into char buf[size] */
1628 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1629 void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
1630 pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1631 pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
1632 int starts_with_cpu(const char *str) FAST_FUNC;
1633 unsigned get_cpu_count(void) FAST_FUNC;
1636 /* Use strict=1 if you process input from untrusted source:
1637 * it will return NULL on invalid %xx (bad hex chars)
1638 * and str + 1 if decoded char is / or NUL.
1639 * In non-strict mode, it always succeeds (returns str),
1640 * and also it additionally decoded '+' to space.
1642 char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
1645 extern const char bb_uuenc_tbl_base64[] ALIGN1;
1646 extern const char bb_uuenc_tbl_std[] ALIGN1;
1647 void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
1649 BASE64_FLAG_UU_STOP = 0x100,
1650 /* Sign-extends to a value which never matches fgetc result: */
1651 BASE64_FLAG_NO_STOP_CHAR = 0x80,
1653 const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
1654 void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
1656 typedef struct md5_ctx_t {
1657 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1658 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
1659 uint64_t total64; /* must be directly before hash[] */
1660 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1662 typedef struct md5_ctx_t sha1_ctx_t;
1663 typedef struct md5_ctx_t sha256_ctx_t;
1664 typedef struct sha512_ctx_t {
1665 uint64_t total64[2]; /* must be directly before hash[] */
1667 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
1669 typedef struct sha3_ctx_t {
1671 unsigned bytes_queued;
1673 void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1674 void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1675 void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1676 void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1677 #define sha1_hash md5_hash
1678 void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1679 void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1680 #define sha256_hash md5_hash
1681 #define sha256_end sha1_end
1682 void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1683 void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1684 void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
1685 void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
1686 void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1687 void sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
1689 extern uint32_t *global_crc32_table;
1690 uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1691 uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1692 uint32_t crc32_block_endian0(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1694 typedef struct masks_labels_t {
1698 int print_flags_separated(const int *masks, const char *labels,
1699 int flags, const char *separator) FAST_FUNC;
1700 int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
1702 typedef struct bb_progress_t {
1704 unsigned last_update_sec;
1705 unsigned last_change_sec;
1707 const char *curfile;
1710 #define is_bb_progress_inited(p) ((p)->curfile != NULL)
1711 #define bb_progress_free(p) do { \
1712 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1713 (p)->curfile = NULL; \
1715 void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
1716 void bb_progress_update(bb_progress_t *p,
1719 uoff_t totalsize) FAST_FUNC;
1722 extern const char *applet_name;
1724 /* Some older linkers don't perform string merging, we used to have common strings
1725 * as global arrays to do it by hand. But:
1726 * (1) newer linkers do it themselves,
1727 * (2) however, they DONT merge string constants with global arrays,
1728 * even if the value is the same (!). Thus global arrays actually
1729 * increased size a bit: for example, "/etc/passwd" string from libc
1730 * wasn't merged with bb_path_passwd_file[] array!
1731 * Therefore now we use #defines.
1733 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1734 extern const char bb_banner[] ALIGN1;
1735 extern const char bb_msg_memory_exhausted[] ALIGN1;
1736 extern const char bb_msg_invalid_date[] ALIGN1;
1737 #define bb_msg_read_error "read error"
1738 #define bb_msg_write_error "write error"
1739 extern const char bb_msg_unknown[] ALIGN1;
1740 extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
1741 extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
1742 extern const char bb_msg_you_must_be_root[] ALIGN1;
1743 extern const char bb_msg_requires_arg[] ALIGN1;
1744 extern const char bb_msg_invalid_arg[] ALIGN1;
1745 extern const char bb_msg_standard_input[] ALIGN1;
1746 extern const char bb_msg_standard_output[] ALIGN1;
1748 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1749 extern const char bb_hexdigits_upcase[] ALIGN1;
1751 extern const char bb_path_wtmp_file[] ALIGN1;
1753 /* Busybox mount uses either /proc/mounts or /etc/mtab to
1754 * get the list of currently mounted filesystems */
1755 #define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1757 #define bb_path_passwd_file _PATH_PASSWD
1758 #define bb_path_group_file _PATH_GROUP
1759 #define bb_path_shadow_file _PATH_SHADOW
1760 #define bb_path_gshadow_file _PATH_GSHADOW
1762 #define bb_path_motd_file "/etc/motd"
1764 #define bb_dev_null "/dev/null"
1765 extern const char bb_busybox_exec_path[] ALIGN1;
1766 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1767 * but I want to save a few bytes here */
1768 extern const char bb_PATH_root_path[] ALIGN1; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1769 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1770 #define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1772 extern const int const_int_0;
1773 extern const int const_int_1;
1776 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1777 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1778 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1779 /* This struct is deliberately not defined. */
1780 /* See docs/keep_data_small.txt */
1782 /* '*const' ptr makes gcc optimize code much better.
1783 * Magic prevents ptr_to_globals from going into rodata.
1784 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1785 extern struct globals *const ptr_to_globals;
1786 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1787 #define barrier() __asm__ __volatile__("":::"memory")
1788 #define SET_PTR_TO_GLOBALS(x) do { \
1789 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
1792 #define FREE_PTR_TO_GLOBALS() do { \
1793 if (ENABLE_FEATURE_CLEAN_UP) { \
1794 free(ptr_to_globals); \
1798 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1799 * use bb_default_login_shell and following defines.
1800 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1801 * don't forget to change increment constant. */
1802 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
1803 extern const char bb_default_login_shell[] ALIGN1;
1805 #define DEFAULT_SHELL (bb_default_login_shell+1)
1807 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1809 /* The following devices are the same on all systems. */
1810 #define CURRENT_TTY "/dev/tty"
1811 #define DEV_CONSOLE "/dev/console"
1813 #if defined(__FreeBSD_kernel__)
1814 # define CURRENT_VC CURRENT_TTY
1815 # define VC_1 "/dev/ttyv0"
1816 # define VC_2 "/dev/ttyv1"
1817 # define VC_3 "/dev/ttyv2"
1818 # define VC_4 "/dev/ttyv3"
1819 # define VC_5 "/dev/ttyv4"
1820 # define VC_FORMAT "/dev/ttyv%d"
1821 #elif defined(__GNU__)
1822 # define CURRENT_VC CURRENT_TTY
1823 # define VC_1 "/dev/tty1"
1824 # define VC_2 "/dev/tty2"
1825 # define VC_3 "/dev/tty3"
1826 # define VC_4 "/dev/tty4"
1827 # define VC_5 "/dev/tty5"
1828 # define VC_FORMAT "/dev/tty%d"
1829 #elif ENABLE_FEATURE_DEVFS
1830 /*Linux, obsolete devfs names */
1831 # define CURRENT_VC "/dev/vc/0"
1832 # define VC_1 "/dev/vc/1"
1833 # define VC_2 "/dev/vc/2"
1834 # define VC_3 "/dev/vc/3"
1835 # define VC_4 "/dev/vc/4"
1836 # define VC_5 "/dev/vc/5"
1837 # define VC_FORMAT "/dev/vc/%d"
1838 # define LOOP_FORMAT "/dev/loop/%u"
1839 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1840 # define LOOP_NAME "/dev/loop/"
1841 # define FB_0 "/dev/fb/0"
1843 /*Linux, normal names */
1844 # define CURRENT_VC "/dev/tty0"
1845 # define VC_1 "/dev/tty1"
1846 # define VC_2 "/dev/tty2"
1847 # define VC_3 "/dev/tty3"
1848 # define VC_4 "/dev/tty4"
1849 # define VC_5 "/dev/tty5"
1850 # define VC_FORMAT "/dev/tty%d"
1851 # define LOOP_FORMAT "/dev/loop%u"
1852 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1853 # define LOOP_NAME "/dev/loop"
1854 # define FB_0 "/dev/fb0"
1858 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1861 /* We redefine ctype macros. Unicode-correct handling of char types
1862 * can't be done with such byte-oriented operations anyway,
1863 * we don't lose anything.
1881 /* We save ~500 bytes on isdigit alone.
1882 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
1884 /* These work the same for ASCII and Unicode,
1885 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
1886 #define isascii(a) ((unsigned char)(a) <= 0x7f)
1887 #define isdigit(a) ((unsigned char)((a) - '0') <= 9)
1888 #define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1889 #define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
1890 #define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
1891 #define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1892 #define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
1893 /* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
1894 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
1896 #define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
1897 // Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1898 #define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1899 // Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
1900 #define isalnum(a) bb_ascii_isalnum(a)
1901 static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1903 unsigned char b = a - '0';
1907 return b <= 'z' - 'a';
1909 #define isxdigit(a) bb_ascii_isxdigit(a)
1910 static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1912 unsigned char b = a - '0';
1916 return b <= 'f' - 'a';
1918 #define toupper(a) bb_ascii_toupper(a)
1919 static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1921 unsigned char b = a - 'a';
1922 if (b <= ('z' - 'a'))
1926 #define tolower(a) bb_ascii_tolower(a)
1927 static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1929 unsigned char b = a - 'A';
1930 if (b <= ('Z' - 'A'))
1935 /* In ASCII and Unicode, these are likely to be very different.
1936 * Let's prevent ambiguous usage from the start */
1937 #define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1938 #define isprint(a) isprint_is_ambiguous_dont_use(a)
1939 /* NB: must not treat EOF as isgraph or isprint */
1940 #define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1941 #define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1944 /* Simple unit-testing framework */
1946 typedef void (*bbunit_testfunc)(void);
1948 struct bbunit_listelem {
1949 struct bbunit_listelem* next;
1951 bbunit_testfunc testfunc;
1954 void bbunit_registertest(struct bbunit_listelem* test);
1955 void bbunit_settestfailed(void);
1957 #define BBUNIT_DEFINE_TEST(NAME) \
1958 static void bbunit_##NAME##_test(void); \
1959 static struct bbunit_listelem bbunit_##NAME##_elem = { \
1961 .testfunc = bbunit_##NAME##_test, \
1963 static void INIT_LAST bbunit_##NAME##_register(void) \
1965 bbunit_registertest(&bbunit_##NAME##_elem); \
1967 static void bbunit_##NAME##_test(void)
1970 * Both 'goto bbunit_end' and 'break' are here only to get rid
1971 * of compiler warnings.
1973 #define BBUNIT_ENDTEST \
1980 #define BBUNIT_PRINTASSERTFAIL \
1983 "[ERROR] Assertion failed in file %s, line %d", \
1984 __FILE__, __LINE__); \
1987 #define BBUNIT_ASSERTION_FAILED \
1989 bbunit_settestfailed(); \
1995 * For now we only offer assertions which cause tests to fail
1996 * immediately. In the future 'expects' might be added too -
1997 * similar to those offered by the gtest framework.
1999 #define BBUNIT_ASSERT_EQ(EXPECTED, ACTUAL) \
2001 if ((EXPECTED) != (ACTUAL)) { \
2002 BBUNIT_PRINTASSERTFAIL; \
2003 bb_error_msg("[ERROR] '%s' isn't equal to '%s'", \
2004 #EXPECTED, #ACTUAL); \
2005 BBUNIT_ASSERTION_FAILED; \
2009 #define BBUNIT_ASSERT_NOTEQ(EXPECTED, ACTUAL) \
2011 if ((EXPECTED) == (ACTUAL)) { \
2012 BBUNIT_PRINTASSERTFAIL; \
2013 bb_error_msg("[ERROR] '%s' is equal to '%s'", \
2014 #EXPECTED, #ACTUAL); \
2015 BBUNIT_ASSERTION_FAILED; \
2019 #define BBUNIT_ASSERT_NOTNULL(PTR) \
2021 if ((PTR) == NULL) { \
2022 BBUNIT_PRINTASSERTFAIL; \
2023 bb_error_msg("[ERROR] '%s' is NULL!", #PTR); \
2024 BBUNIT_ASSERTION_FAILED; \
2028 #define BBUNIT_ASSERT_NULL(PTR) \
2030 if ((PTR) != NULL) { \
2031 BBUNIT_PRINTASSERTFAIL; \
2032 bb_error_msg("[ERROR] '%s' is not NULL!", #PTR); \
2033 BBUNIT_ASSERTION_FAILED; \
2037 #define BBUNIT_ASSERT_FALSE(STATEMENT) \
2039 if ((STATEMENT)) { \
2040 BBUNIT_PRINTASSERTFAIL; \
2041 bb_error_msg("[ERROR] Statement '%s' evaluated to true!", \
2043 BBUNIT_ASSERTION_FAILED; \
2047 #define BBUNIT_ASSERT_TRUE(STATEMENT) \
2049 if (!(STATEMENT)) { \
2050 BBUNIT_PRINTASSERTFAIL; \
2051 bb_error_msg("[ERROR] Statement '%s' evaluated to false!", \
2053 BBUNIT_ASSERTION_FAILED; \
2057 #define BBUNIT_ASSERT_STREQ(STR1, STR2) \
2059 if (strcmp(STR1, STR2) != 0) { \
2060 BBUNIT_PRINTASSERTFAIL; \
2061 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2062 "are not the same", STR1, STR2); \
2063 BBUNIT_ASSERTION_FAILED; \
2067 #define BBUNIT_ASSERT_STRNOTEQ(STR1, STR2) \
2069 if (strcmp(STR1, STR2) == 0) { \
2070 BBUNIT_PRINTASSERTFAIL; \
2071 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2072 "are the same, but were " \
2073 "expected to differ", STR1, STR2); \
2074 BBUNIT_ASSERTION_FAILED; \
2079 POP_SAVED_FUNCTION_VISIBILITY