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 #define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
339 extern int remove_file(const char *path, int flags) FAST_FUNC;
340 /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
341 * the source, not copy (unless "source" is a directory).
342 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
343 * work coreutils-compatibly. */
344 extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
347 ACTION_RECURSE = (1 << 0),
348 ACTION_FOLLOWLINKS = (1 << 1),
349 ACTION_FOLLOWLINKS_L0 = (1 << 2),
350 ACTION_DEPTHFIRST = (1 << 3),
351 /*ACTION_REVERSE = (1 << 4), - unused */
352 ACTION_QUIET = (1 << 5),
353 ACTION_DANGLING_OK = (1 << 6),
355 typedef uint8_t recurse_flags_t;
356 extern int recursive_action(const char *fileName, unsigned flags,
357 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
358 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
359 void* userData, unsigned depth) FAST_FUNC;
360 extern int device_open(const char *device, int mode) FAST_FUNC;
361 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
362 extern int xgetpty(char *line) FAST_FUNC;
363 extern int get_console_fd_or_die(void) FAST_FUNC;
364 extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
365 extern char *find_block_device(const char *path) FAST_FUNC;
366 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
367 extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
368 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
369 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
370 /* "short" copy can be detected by return value < size */
371 /* this helper yells "short read!" if param is not -1 */
372 extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
374 extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
375 char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
376 /* xxxx_strip version can modify its parameter:
380 * "abc/def/" -> "def" !!
382 char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
383 /* "abc/def/" -> "" and it never modifies 'path' */
384 char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
385 /* Simpler version: does not special case "/" string */
386 const char *bb_basename(const char *name) FAST_FUNC;
387 /* NB: can violate const-ness (similarly to strchr) */
388 char *last_char_is(const char *s, int c) FAST_FUNC;
389 const char* endofname(const char *name) FAST_FUNC;
391 void ndelay_on(int fd) FAST_FUNC;
392 void ndelay_off(int fd) FAST_FUNC;
393 void close_on_exec_on(int fd) FAST_FUNC;
394 void xdup2(int, int) FAST_FUNC;
395 void xmove_fd(int, int) FAST_FUNC;
398 DIR *xopendir(const char *path) FAST_FUNC;
399 DIR *warn_opendir(const char *path) FAST_FUNC;
401 char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
402 char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
403 char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
404 /* !RETURNS_MALLOC: it's a realloc-like function */
405 char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
407 char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
411 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
412 * otherwise would kill us, except for those resulting from bugs:
413 * SIGSEGV, SIGILL, SIGFPE.
414 * Other fatal signals not included (TODO?):
415 * SIGBUS Bus error (bad memory access)
416 * SIGPOLL Pollable event. Synonym of SIGIO
417 * SIGPROF Profiling timer expired
418 * SIGSYS Bad argument to routine
419 * SIGTRAP Trace/breakpoint trap
421 * The only known arch with some of these sigs not fitting
422 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
423 * Dance around with long long to guard against that...
425 BB_FATAL_SIGS = (int)(0
429 + (1LL << SIGPIPE) // Write to pipe with no readers
430 + (1LL << SIGQUIT) // Quit from keyboard
431 + (1LL << SIGABRT) // Abort signal from abort(3)
432 + (1LL << SIGALRM) // Timer signal from alarm(2)
433 + (1LL << SIGVTALRM) // Virtual alarm clock
434 + (1LL << SIGXCPU) // CPU time limit exceeded
435 + (1LL << SIGXFSZ) // File size limit exceeded
436 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
440 void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
441 /* Unlike signal() and bb_signals, sets handler with sigaction()
442 * and in a way that while signal handler is run, no other signals
443 * will be blocked; syscalls will not be restarted: */
444 void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
445 /* syscalls like read() will be interrupted with EINTR: */
446 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
447 /* syscalls like read() won't be interrupted (though select/poll will be): */
448 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
449 void wait_for_any_sig(void) FAST_FUNC;
450 void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
451 void sig_block(int sig) FAST_FUNC;
452 void sig_unblock(int sig) FAST_FUNC;
453 /* Will do sigaction(signum, act, NULL): */
454 int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
455 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
456 int sigprocmask_allsigs(int how) FAST_FUNC;
457 /* Standard handler which just records signo */
458 extern smallint bb_got_signal;
459 void record_signo(int signo); /* not FAST_FUNC! */
462 void xsetgid(gid_t gid) FAST_FUNC;
463 void xsetuid(uid_t uid) FAST_FUNC;
464 void xsetegid(gid_t egid) FAST_FUNC;
465 void xseteuid(uid_t euid) FAST_FUNC;
466 void xchdir(const char *path) FAST_FUNC;
467 void xchroot(const char *path) FAST_FUNC;
468 void xsetenv(const char *key, const char *value) FAST_FUNC;
469 void bb_unsetenv(const char *key) FAST_FUNC;
470 void bb_unsetenv_and_free(char *key) FAST_FUNC;
471 void xunlink(const char *pathname) FAST_FUNC;
472 void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
473 void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
474 int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
475 int open_or_warn(const char *pathname, int flags) FAST_FUNC;
476 int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
477 int xopen(const char *pathname, int flags) FAST_FUNC;
478 int xopen_nonblocking(const char *pathname) FAST_FUNC;
479 int xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g) FAST_FUNC;
480 int open_or_warn_stdin(const char *pathname) FAST_FUNC;
481 int xopen_stdin(const char *pathname) FAST_FUNC;
482 void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
483 int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
484 off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
485 int xmkstemp(char *template) FAST_FUNC;
486 off_t fdlength(int fd) FAST_FUNC;
488 uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
489 const char *override,
490 unsigned override_units,
493 void xpipe(int filedes[2]) FAST_FUNC;
494 /* In this form code with pipes is much more readable */
495 struct fd_pair { int rd; int wr; };
496 #define piped_pair(pair) pipe(&((pair).rd))
497 #define xpiped_pair(pair) xpipe(&((pair).rd))
499 /* Useful for having small structure members/global variables */
500 typedef int8_t socktype_t;
501 typedef int8_t family_t;
502 struct BUG_too_small {
503 char BUG_socktype_t_too_small[(0
510 char BUG_family_t_too_small[(0
527 void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
528 time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
529 char *strftime_HHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
530 char *strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
532 int xsocket(int domain, int type, int protocol) FAST_FUNC;
533 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
534 void xlisten(int s, int backlog) FAST_FUNC;
535 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
536 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
537 socklen_t tolen) FAST_FUNC;
538 /* SO_REUSEADDR allows a server to rebind to an address that is already
539 * "in use" by old connections to e.g. previous server instance which is
540 * killed or crashed. Without it bind will fail until all such connections
541 * time out. Linux does not allow multiple live binds on same ip:port
542 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
543 * Turn it on before you call bind(). */
544 void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
545 int setsockopt_broadcast(int fd) FAST_FUNC;
546 int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
547 /* NB: returns port in host byte order */
548 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
549 typedef struct len_and_sockaddr {
553 struct sockaddr_in sin;
554 #if ENABLE_FEATURE_IPV6
555 struct sockaddr_in6 sin6;
560 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
561 LSA_SIZEOF_SA = sizeof(
564 struct sockaddr_in sin;
565 #if ENABLE_FEATURE_IPV6
566 struct sockaddr_in6 sin6;
571 /* Create stream socket, and allocate suitable lsa.
572 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
573 * af == AF_UNSPEC will result in trying to create IPv6 socket,
574 * and if kernel doesn't support it, fall back to IPv4.
575 * This is useful if you plan to bind to resulting local lsa.
577 int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
578 int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
579 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
580 * numeric IP ("N.N.N.N") or numeric IPv6 address,
581 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
582 * Only if there is no suffix, port argument is used */
583 /* NB: these set SO_REUSEADDR before bind */
584 int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
585 int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
586 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
587 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
588 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
589 * If there is no suffix, port argument is used */
590 int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
591 /* Connect to peer identified by lsa */
592 int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
593 /* Get local address of bound or accepted socket */
594 len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
595 /* Get remote address of connected or accepted socket */
596 len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
597 /* Return malloc'ed len_and_sockaddr with socket address of host:port
598 * Currently will return IPv4 or IPv6 sockaddrs only
599 * (depending on host), but in theory nothing prevents e.g.
600 * UNIX socket address being returned, IPX sockaddr etc...
601 * On error does bb_error_msg and returns NULL */
602 len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
603 /* Version which dies on error */
604 len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
605 len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
606 /* Same, useful if you want to force family (e.g. IPv6) */
607 #if !ENABLE_FEATURE_IPV6
608 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
609 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
611 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
612 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
614 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
615 * otherwise no-op. Useful for ftp.
616 * NB: does NOT do htons() internally, just direct assignment. */
617 void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
618 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
619 int get_nport(const struct sockaddr *sa) FAST_FUNC;
620 /* Reverse DNS. Returns NULL on failure. */
621 char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
622 /* This one doesn't append :PORTNUM */
623 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
624 /* This one also doesn't fall back to dotted IP (returns NULL) */
625 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
626 /* inet_[ap]ton on steroids */
627 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
628 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
629 // "old" (ipv4 only) API
630 // users: traceroute.c hostname.c - use _list_ of all IPs
631 struct hostent *xgethostbyname(const char *name) FAST_FUNC;
632 // Also mount.c and inetd.c are using gethostbyname(),
633 // + inet_common.c has additional IPv4-only stuff
636 void socket_want_pktinfo(int fd) FAST_FUNC;
637 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
638 const struct sockaddr *to,
639 const struct sockaddr *from,
640 socklen_t tolen) FAST_FUNC;
641 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
642 struct sockaddr *from,
644 socklen_t sa_size) FAST_FUNC;
646 uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
648 char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
649 char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
650 void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
651 char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
652 char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
653 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
654 * But potentially slow, don't use in one-billion-times loops */
655 int bb_putchar(int ch) FAST_FUNC;
656 /* Note: does not use stdio, writes to fd 2 directly */
657 int bb_putchar_stderr(char ch) FAST_FUNC;
658 char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
659 // gcc-4.1.1 still isn't good enough at optimizing it
660 // (+200 bytes compared to macro)
661 //static ALWAYS_INLINE
662 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
663 //static ALWAYS_INLINE
664 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
665 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
666 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
667 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
668 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
669 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
671 typedef struct uni_stat_t {
673 unsigned unicode_count;
674 unsigned unicode_width;
676 /* Returns a string with unprintable chars replaced by '?' or
677 * SUBST_WCHAR. This function is unicode-aware. */
678 const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
679 /* Prints unprintable char ch as ^C or M-c to file
680 * (M-c is used only if ch is ORed with PRINTABLE_META),
681 * else it is printed as-is (except for ch = 0x9b) */
682 enum { PRINTABLE_META = 0x100 };
683 void fputc_printable(int ch, FILE *file) FAST_FUNC;
684 /* Return a string that is the printable representation of character ch.
685 * Buffer must hold at least four characters. */
687 VISIBLE_ENDLINE = 1 << 0,
688 VISIBLE_SHOW_TABS = 1 << 1,
690 void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
692 /* dmalloc will redefine these to it's own implementation. It is safe
693 * to have the prototypes here unconditionally. */
694 void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
695 void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
696 void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
697 void *xrealloc(void *old, size_t size) FAST_FUNC;
698 /* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
699 * at least v[idx] and v[idx+1], for all idx values.
700 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
701 * when all elements are used up. New elements are zeroed out.
702 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
703 * skipping an index is a bad bug - it may miss a realloc!
705 #define xrealloc_vector(vector, shift, idx) \
706 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
707 void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
710 extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
711 extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count, int loop_on_EINTR) FAST_FUNC;
712 // NB: will return short read on error, not -1,
713 // if some data was read before error occurred
714 extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
715 extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
716 extern unsigned char xread_char(int fd) FAST_FUNC;
717 extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
718 extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
719 // Reads one line a-la fgets (but doesn't save terminating '\n').
720 // Reads byte-by-byte. Useful when it is important to not read ahead.
721 // Bytes are appended to pfx (which must be malloced, or NULL).
722 extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
723 /* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
724 extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
725 /* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
726 extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
727 /* Never returns NULL */
728 extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
730 #define SEAMLESS_COMPRESSION (0 \
731 || ENABLE_FEATURE_SEAMLESS_XZ \
732 || ENABLE_FEATURE_SEAMLESS_LZMA \
733 || ENABLE_FEATURE_SEAMLESS_BZ2 \
734 || ENABLE_FEATURE_SEAMLESS_GZ \
735 || ENABLE_FEATURE_SEAMLESS_Z)
737 #if SEAMLESS_COMPRESSION
738 /* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
739 extern int setup_unzip_on_fd(int fd, int fail_if_not_detected) FAST_FUNC;
740 /* Autodetects .gz etc */
741 extern int open_zipped(const char *fname) FAST_FUNC;
743 # define setup_unzip_on_fd(...) (0)
744 # define open_zipped(fname) open((fname), O_RDONLY);
746 extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
748 extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
749 // NB: will return short write on error, not -1,
750 // if some data was written before error occurred
751 extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
752 extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
753 extern void xwrite_str(int fd, const char *str) FAST_FUNC;
754 extern ssize_t full_write1_str(const char *str) FAST_FUNC;
755 extern ssize_t full_write2_str(const char *str) FAST_FUNC;
756 extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
758 /* Close fd, but check for failures (some types of write errors) */
759 extern void xclose(int fd) FAST_FUNC;
761 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
762 extern void xprint_and_close_file(FILE *file) FAST_FUNC;
764 /* Reads a line from a text file, up to a newline or NUL byte, inclusive.
765 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
766 * end of line. If end isn't NULL, length of the chunk is stored in it.
767 * Returns NULL if EOF/error.
769 extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
770 /* Reads up to (and including) TERMINATING_STRING: */
771 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
772 /* Same, with limited max size, and returns the length (excluding NUL): */
773 extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
774 /* Chops off TERMINATING_STRING from the end: */
775 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
776 /* Reads up to (and including) "\n" or NUL byte: */
777 extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
778 /* Chops off '\n' from the end, unlike fgets: */
779 extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
780 /* Same, but doesn't try to conserve space (may have some slack after the end) */
781 /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
783 void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
784 void die_if_ferror_stdout(void) FAST_FUNC;
785 int fflush_all(void) FAST_FUNC;
786 void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
787 int fclose_if_not_stdin(FILE *file) FAST_FUNC;
788 FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
789 /* Prints warning to stderr and returns NULL on failure: */
790 FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
791 /* "Opens" stdin if filename is special, else just opens file: */
792 FILE* xfopen_stdin(const char *filename) FAST_FUNC;
793 FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
794 FILE* fopen_for_read(const char *path) FAST_FUNC;
795 FILE* xfopen_for_read(const char *path) FAST_FUNC;
796 FILE* fopen_for_write(const char *path) FAST_FUNC;
797 FILE* xfopen_for_write(const char *path) FAST_FUNC;
798 FILE* xfdopen_for_read(int fd) FAST_FUNC;
799 FILE* xfdopen_for_write(int fd) FAST_FUNC;
801 int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
802 void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
804 /* Wrapper which restarts poll on EINTR or ENOMEM.
805 * On other errors complains [perror("poll")] and returns.
806 * Warning! May take (much) longer than timeout_ms to return!
807 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
808 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
810 char *safe_gethostname(void) FAST_FUNC;
812 /* Convert each alpha char in str to lower-case */
813 char* str_tolower(char *str) FAST_FUNC;
815 char *utoa(unsigned n) FAST_FUNC;
816 char *itoa(int n) FAST_FUNC;
817 /* Returns a pointer past the formatted number, does NOT null-terminate */
818 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
819 char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
820 /* Intelligent formatters of bignums */
821 char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
822 char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
823 /* If block_size == 0, display size without fractional part,
824 * else display (size * block_size) with one decimal digit.
825 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
826 * else divide by display_unit and do not use suffix. */
827 #define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
828 #define HUMAN_READABLE_MAX_WIDTH_STR "7"
829 //TODO: provide pointer to buf (avoid statics)?
830 const char *make_human_readable_str(unsigned long long size,
831 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
832 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
833 char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
835 char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
837 /* Generate a UUID */
838 void generate_uuid(uint8_t *buf) FAST_FUNC;
840 /* Last element is marked by mult == 0 */
845 extern const struct suffix_mult bkm_suffixes[];
846 #define km_suffixes (bkm_suffixes + 1)
851 /* Using xatoi() instead of naive atoi() is not always convenient -
852 * in many places people want *non-negative* values, but store them
853 * in signed int. Therefore we need this one:
854 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
855 * It should really be named xatoi_nonnegative (since it allows 0),
856 * but that would be too long.
858 int xatoi_positive(const char *numstr) FAST_FUNC;
860 /* Useful for reading port numbers */
861 uint16_t xatou16(const char *numstr) FAST_FUNC;
864 /* These parse entries in /etc/passwd and /etc/group. This is desirable
865 * for BusyBox since we want to avoid using the glibc NSS stuff, which
866 * increases target size and is often not needed on embedded systems. */
867 long xuname2uid(const char *name) FAST_FUNC;
868 long xgroup2gid(const char *name) FAST_FUNC;
869 /* wrapper: allows string to contain numeric uid or gid */
870 unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
871 /* from chpst. Does not die, returns 0 on failure */
876 /* always sets uid and gid */
877 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
878 /* always sets uid and gid, allows numeric; exits on failure */
879 void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
880 /* chown-like handling of "user[:[group]" */
881 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
882 struct passwd* xgetpwnam(const char *name) FAST_FUNC;
883 struct group* xgetgrnam(const char *name) FAST_FUNC;
884 struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
885 struct group* xgetgrgid(gid_t gid) FAST_FUNC;
886 char* xuid2uname(uid_t uid) FAST_FUNC;
887 char* xgid2group(gid_t gid) FAST_FUNC;
888 char* uid2uname(uid_t uid) FAST_FUNC;
889 char* gid2group(gid_t gid) FAST_FUNC;
890 char* uid2uname_utoa(uid_t uid) FAST_FUNC;
891 char* gid2group_utoa(gid_t gid) FAST_FUNC;
892 /* versions which cache results (useful for ps, ls etc) */
893 const char* get_cached_username(uid_t uid) FAST_FUNC;
894 const char* get_cached_groupname(gid_t gid) FAST_FUNC;
895 void clear_username_cache(void) FAST_FUNC;
896 /* internally usernames are saved in fixed-sized char[] buffers */
897 enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
898 #if ENABLE_FEATURE_CHECK_NAMES
899 void die_if_bad_username(const char* name) FAST_FUNC;
901 #define die_if_bad_username(name) ((void)(name))
904 #if ENABLE_FEATURE_UTMP
905 void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
906 void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
908 # define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
909 # define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
913 int execable_file(const char *name) FAST_FUNC;
914 char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
915 int exists_execable(const char *filename) FAST_FUNC;
917 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
918 * but it may exec busybox and call applet instead of searching PATH.
920 #if ENABLE_FEATURE_PREFER_APPLETS
921 int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
922 #define BB_EXECLP(prog,cmd,...) \
924 if (find_applet_by_name(prog) >= 0) \
925 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
926 execlp(prog, cmd, __VA_ARGS__); \
929 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
930 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
932 int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
934 /* xvfork() can't be a _function_, return after vfork mangles stack
935 * in the parent. It must be a macro. */
938 pid_t bb__xvfork_pid = vfork(); \
939 if (bb__xvfork_pid < 0) \
940 bb_perror_msg_and_die("vfork"); \
944 pid_t xfork(void) FAST_FUNC;
947 /* NOMMU friendy fork+exec: */
948 pid_t spawn(char **argv) FAST_FUNC;
949 pid_t xspawn(char **argv) FAST_FUNC;
951 pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
952 pid_t wait_any_nohang(int *wstat) FAST_FUNC;
953 /* wait4pid: unlike waitpid, waits ONLY for one process.
954 * Returns sig + 0x180 if child is killed by signal.
955 * It's safe to pass negative 'pids' from failed [v]fork -
956 * wait4pid will return -1 (and will not clobber [v]fork's errno).
957 * IOW: rc = wait4pid(spawn(argv));
958 * if (rc < 0) bb_perror_msg("%s", argv[0]);
959 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
961 int wait4pid(pid_t pid) FAST_FUNC;
962 /* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
963 int spawn_and_wait(char **argv) FAST_FUNC;
964 /* Does NOT check that applet is NOFORK, just blindly runs it */
965 int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
967 /* Helpers for daemonization.
969 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
971 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
972 * rexec's itself on NOMMU with argv passed as command line.
973 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
974 * from the start. (It will detect it and not reexec again second time).
975 * You have to audit carefully that you don't do something twice as a result
976 * (opening files/sockets, parsing config files etc...)!
978 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
979 * (will do setsid()).
981 * fork_or_rexec(argv) = bare-bones fork on MMU,
982 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
983 * On MMU ignores argv.
985 * Helper for network daemons in foreground mode:
987 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
988 * to /dev/null if they are not.
991 DAEMON_CHDIR_ROOT = 1,
992 DAEMON_DEVNULL_STDIO = 2,
993 DAEMON_CLOSE_EXTRA_FDS = 4,
994 DAEMON_ONLY_SANITIZE = 8, /* internal use */
995 DAEMON_DOUBLE_FORK = 16, /* double fork to avoid controlling tty */
998 enum { re_execed = 0 };
999 # define fork_or_rexec(argv) xfork()
1000 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1001 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
1003 extern bool re_execed;
1004 /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1005 * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1007 void re_exec(char **argv) NORETURN FAST_FUNC;
1008 pid_t fork_or_rexec(char **argv) FAST_FUNC;
1009 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1010 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1011 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
1012 # define fork() BUG_fork_is_unavailable_on_nommu()
1013 # define xfork() BUG_fork_is_unavailable_on_nommu()
1014 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1015 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
1017 void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1018 void bb_sanitize_stdio(void) FAST_FUNC;
1019 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
1020 int sanitize_env_if_suid(void) FAST_FUNC;
1023 char* single_argv(char **argv) FAST_FUNC;
1024 extern const char *const bb_argv_dash[]; /* "-", NULL */
1025 extern const char *opt_complementary;
1026 #if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
1027 #define No_argument "\0"
1028 #define Required_argument "\001"
1029 #define Optional_argument "\002"
1030 extern const char *applet_long_options;
1032 extern uint32_t option_mask32;
1033 extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
1036 /* Having next pointer as a first member allows easy creation
1037 * of "llist-compatible" structs, and using llist_FOO functions
1040 typedef struct llist_t {
1041 struct llist_t *link;
1044 void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1045 void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1046 void *llist_pop(llist_t **elm) FAST_FUNC;
1047 void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1048 void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1049 llist_t *llist_rev(llist_t *list) FAST_FUNC;
1050 llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
1051 /* BTW, surprisingly, changing API to
1052 * llist_t *llist_add_to(llist_t *old_head, void *data)
1053 * etc does not result in smaller code... */
1055 /* start_stop_daemon and udhcpc are special - they want
1056 * to create pidfiles regardless of FEATURE_PIDFILE */
1057 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
1058 /* True only if we created pidfile which is *file*, not /dev/null etc */
1059 extern smallint wrote_pidfile;
1060 void write_pidfile(const char *path) FAST_FUNC;
1061 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
1063 enum { wrote_pidfile = 0 };
1064 #define write_pidfile(path) ((void)0)
1065 #define remove_pidfile(path) ((void)0)
1070 LOGMODE_STDIO = (1 << 0),
1071 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
1072 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1074 extern const char *msg_eol;
1075 extern smallint logmode;
1076 extern int die_sleep;
1077 extern uint8_t xfunc_error_retval;
1078 extern jmp_buf die_jmp;
1079 extern void xfunc_die(void) NORETURN FAST_FUNC;
1080 extern void bb_show_usage(void) NORETURN FAST_FUNC;
1081 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1082 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1083 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1084 extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1085 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1086 extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
1087 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1088 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1089 extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
1090 extern void bb_perror_nomsg(void) FAST_FUNC;
1091 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1092 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
1094 /* We need to export XXX_main from libbusybox
1095 * only if we build "individual" binaries
1097 #if ENABLE_FEATURE_INDIVIDUAL
1098 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1100 #define MAIN_EXTERNALLY_VISIBLE
1104 /* Applets which are useful from another applets */
1105 int bb_cat(char** argv);
1106 /* If shell needs them, they exist even if not enabled as applets */
1107 int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1108 int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1109 int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1110 int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
1111 /* Similar, but used by chgrp, not shell */
1112 int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
1114 int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1115 /* Don't need IF_xxx() guard for these */
1116 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1117 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1120 void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
1125 /* This structure defines protocol families and their handlers. */
1131 char* FAST_FUNC (*print)(unsigned char *);
1132 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1133 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1134 void FAST_FUNC (*herror)(char *text);
1135 int FAST_FUNC (*rprint)(int options);
1136 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
1137 /* may modify src */
1138 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
1140 /* This structure defines hardware protocols and their handlers. */
1146 char* FAST_FUNC (*print)(unsigned char *);
1147 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1148 int FAST_FUNC (*activate)(int fd);
1149 int suppress_null_addr;
1151 extern smallint interface_opt_a;
1152 int display_interfaces(char *ifname) FAST_FUNC;
1153 int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1154 #if ENABLE_FEATURE_HWIB
1155 int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1157 #define in_ib(a, b) 1 /* fail */
1159 const struct aftype *get_aftype(const char *name) FAST_FUNC;
1160 const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1161 const struct hwtype *get_hwntype(int type) FAST_FUNC;
1164 #ifndef BUILD_INDIVIDUAL
1165 extern int find_applet_by_name(const char *name) FAST_FUNC;
1166 /* Returns only if applet is not found. */
1167 extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
1168 extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
1171 #ifdef HAVE_MNTENT_H
1172 extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
1173 extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
1175 extern void erase_mtab(const char * name) FAST_FUNC;
1176 extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1177 extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1179 extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1181 # define bb_warn_ignoring_args(arg) ((void)0)
1184 extern int get_linux_version_code(void) FAST_FUNC;
1186 extern char *query_loop(const char *device) FAST_FUNC;
1187 extern int del_loop(const char *device) FAST_FUNC;
1188 /* If *devname is not NULL, use that name, otherwise try to find free one,
1189 * malloc and return it in *devname.
1190 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
1191 extern int set_loop(char **devname, const char *file, unsigned long long offset, int ro) FAST_FUNC;
1193 /* Like bb_ask below, but asks on stdin with no timeout. */
1194 char *bb_ask_stdin(const char * prompt) FAST_FUNC;
1195 //TODO: pass buf pointer or return allocated buf (avoid statics)?
1196 char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
1197 int bb_ask_confirmation(void) FAST_FUNC;
1199 int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
1202 * Config file parser
1205 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1206 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1207 // TODO: COLLAPSE and TRIM seem to always go in pair
1208 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1209 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
1210 // keep a copy of current line
1211 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
1212 PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
1214 // * remove leading and trailing delimiters and collapse
1215 // multiple delimiters into one
1216 // * warn and continue if less than mintokens delimiters found
1217 // * grab everything into last token
1218 // * comments are recognized even if they aren't the first char
1219 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
1221 typedef struct parser_t {
1225 size_t line_alloc, nline_alloc;
1228 parser_t* config_open(const char *filename) FAST_FUNC;
1229 parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
1230 /* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
1231 int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1232 #define config_read(parser, tokens, max, min, str, flags) \
1233 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1234 void config_close(parser_t *parser) FAST_FUNC;
1236 /* Concatenate path and filename to new allocated buffer.
1237 * Add "/" only as needed (no duplicate "//" are produced).
1238 * If path is NULL, it is assumed to be "/".
1239 * filename should not be NULL. */
1240 char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1241 /* Returns NULL on . and .. */
1242 char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1245 int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1247 int get_signum(const char *name) FAST_FUNC;
1248 const char *get_signame(int number) FAST_FUNC;
1249 void print_signames(void) FAST_FUNC;
1251 char *bb_simplify_path(const char *path) FAST_FUNC;
1252 /* Returns ptr to NUL */
1253 char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
1255 #define LOGIN_FAIL_DELAY 3
1256 extern void bb_do_delay(int seconds) FAST_FUNC;
1257 extern void change_identity(const struct passwd *pw) FAST_FUNC;
1258 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
1260 /* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1261 * Note that getpwuid result might need xstrdup'ing
1262 * if there is a possibility of intervening getpwxxx() calls.
1264 const char *get_shell_name(void) FAST_FUNC;
1267 extern void renew_current_security_context(void) FAST_FUNC;
1268 extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1269 extern context_t set_security_context_component(security_context_t cur_context,
1270 char *user, char *role, char *type, char *range) FAST_FUNC;
1271 extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1272 extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1274 #define selinux_preserve_fcontext(fdesc) ((void)0)
1276 extern void selinux_or_die(void) FAST_FUNC;
1279 /* systemd support */
1280 #define SD_LISTEN_FDS_START 3
1281 int sd_listen_fds(void);
1284 /* setup_environment:
1285 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
1286 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1288 * USER=pw->pw_name, LOGNAME=pw->pw_name
1289 * PATH=bb_default_[root_]path
1292 * else if change_env = 1:
1293 * if not root (if pw->pw_uid != 0):
1294 * USER=pw->pw_name, LOGNAME=pw->pw_name
1299 #define SETUP_ENV_CHANGEENV (1 << 0)
1300 #define SETUP_ENV_CLEARENV (1 << 1)
1301 #define SETUP_ENV_TO_TMP (1 << 2)
1302 #define SETUP_ENV_NO_CHDIR (1 << 4)
1303 extern void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1304 extern int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1305 extern int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
1306 /* Returns a malloced string */
1307 #if !ENABLE_USE_BB_CRYPT
1308 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1310 extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1311 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1313 * rnd is additional random input. New one is returned.
1314 * Useful if you call crypt_make_salt many times in a row:
1315 * rnd = crypt_make_salt(buf1, 4, 0);
1316 * rnd = crypt_make_salt(buf2, 4, rnd);
1317 * rnd = crypt_make_salt(buf3, 4, rnd);
1318 * (otherwise we risk having same salt generated)
1320 extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1321 /* "$N$" + sha_salt_16_bytes + NUL */
1322 #define MAX_PW_SALT_LEN (3 + 16 + 1)
1323 extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1326 /* Returns number of lines changed, or -1 on error */
1327 #if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1328 #define update_passwd(filename, username, data, member) \
1329 update_passwd(filename, username, data)
1331 extern int update_passwd(const char *filename,
1332 const char *username,
1334 const char *member) FAST_FUNC;
1336 int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1337 int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1338 int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1339 int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1340 const char *nth_string(const char *strings, int n) FAST_FUNC;
1342 extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1343 extern void print_login_prompt(void) FAST_FUNC;
1345 char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
1346 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1347 int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1349 int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1351 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1352 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1353 int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1354 #if ENABLE_IOCTL_HEX2STR_ERROR
1355 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1356 int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1357 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1358 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1360 int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1361 int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1362 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1363 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1366 char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1367 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1368 void reset_ino_dev_hashtable(void) FAST_FUNC;
1370 /* At least glibc has horrendously large inline for this, so wrap it */
1371 unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
1373 #define makedev(a,b) bb_makedev(a,b)
1377 /* "Keycodes" that report an escape sequence.
1378 * We use something which fits into signed char,
1379 * yet doesn't represent any valid Unicode character.
1380 * Also, -1 is reserved for error indication and we don't use it. */
1388 KEYCODE_INSERT = -8,
1389 KEYCODE_DELETE = -9,
1390 KEYCODE_PAGEUP = -10,
1391 KEYCODE_PAGEDOWN = -11,
1392 // -12 is reserved for Alt/Ctrl/Shift-TAB
1403 KEYCODE_FUN10 = -22,
1404 KEYCODE_FUN11 = -23,
1405 KEYCODE_FUN12 = -24,
1407 /* Be sure that last defined value is small enough
1408 * to not interfere with Alt/Ctrl/Shift bits.
1409 * So far we do not exceed -31 (0xfff..fffe1),
1410 * which gives us three upper bits in LSB to play with.
1412 //KEYCODE_SHIFT_TAB = (-12) & ~0x80,
1413 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1414 //KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1415 //KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
1416 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1417 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
1418 //KEYCODE_ALT_UP = KEYCODE_UP & ~0x20,
1419 //KEYCODE_ALT_DOWN = KEYCODE_DOWN & ~0x20,
1420 KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
1421 KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
1423 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
1424 /* How long is the longest ESC sequence we know?
1425 * We want it big enough to be able to contain
1426 * cursor position sequence "ESC [ 9999 ; 9999 R"
1428 KEYCODE_BUFFER_SIZE = 16
1430 /* Note: fd may be in blocking or non-blocking mode, both make sense.
1431 * For one, less uses non-blocking mode.
1432 * Only the first read syscall inside read_key may block indefinitely
1433 * (unless fd is in non-blocking mode),
1434 * subsequent reads will time out after a few milliseconds.
1435 * Return of -1 means EOF or error (errno == 0 on EOF).
1436 * buffer[0] is used as a counter of buffered chars and must be 0
1439 * -2: do not poll for input;
1440 * -1: poll(-1) (i.e. block);
1441 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
1443 int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
1444 void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
1447 #if ENABLE_FEATURE_EDITING
1448 /* It's NOT just ENABLEd or disabled. It's a number: */
1449 # if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
1450 # define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1451 unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
1453 # define MAX_HISTORY 0
1455 typedef struct line_input_t {
1457 const char *path_lookup;
1461 int max_history; /* must never be <= 0 */
1462 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1463 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1464 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1465 * in on-disk history"
1466 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1467 * also in on-disk history (and thus need to be skipped on save)"
1469 unsigned cnt_history_in_file;
1470 const char *hist_file;
1472 char *history[MAX_HISTORY + 1];
1476 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1477 TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1478 USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1479 VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
1480 WITH_PATH_LOOKUP = 0x10,
1481 FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1483 line_input_t *new_line_input_t(int flags) FAST_FUNC;
1484 /* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1486 * maxsize must be >= 2.
1488 * -1 on read errors or EOF, or on bare Ctrl-D,
1489 * 0 on ctrl-C (the line entered is still returned in 'command'),
1490 * >0 length of input string, including terminating '\n'
1492 int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize, int timeout) FAST_FUNC;
1493 void show_history(const line_input_t *st) FAST_FUNC;
1494 # if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1495 void save_history(line_input_t *st);
1498 #define MAX_HISTORY 0
1499 int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1500 #define read_line_input(state, prompt, command, maxsize, timeout) \
1501 read_line_input(prompt, command, maxsize)
1506 # ifdef TASK_COMM_LEN
1507 enum { COMM_LEN = TASK_COMM_LEN };
1509 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1510 enum { COMM_LEN = 16 };
1515 unsigned long mapped_rw;
1516 unsigned long mapped_ro;
1517 unsigned long shared_clean;
1518 unsigned long shared_dirty;
1519 unsigned long private_clean;
1520 unsigned long private_dirty;
1521 unsigned long stack;
1522 unsigned long smap_pss, smap_swap;
1523 unsigned long smap_size;
1524 unsigned long smap_start;
1530 #define procps_read_smaps(pid, total, cb, data) \
1531 procps_read_smaps(pid, total)
1533 int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1534 void (*cb)(struct smaprec *, void *), void *data);
1536 typedef struct procps_status_t {
1538 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
1539 uint8_t shift_pages_to_bytes;
1540 uint8_t shift_pages_to_kb;
1541 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1545 IF_SELINUX(char *context;)
1546 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
1547 /* Everything below must contain no ptrs to malloc'ed data:
1548 * it is memset(0) for each process in procps_scan() */
1549 unsigned long vsz, rss; /* we round it to kbytes */
1550 unsigned long stime, utime;
1551 unsigned long start_time;
1558 #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1563 unsigned tty_major,tty_minor;
1564 #if ENABLE_FEATURE_TOPMEM
1565 struct smaprec smaps;
1568 /* basename of executable in exec(2), read from /proc/N/stat
1569 * (if executable is symlink or script, it is NOT replaced
1570 * by link target or interpreter name) */
1571 char comm[COMM_LEN];
1572 /* user/group? - use passwd/group parsing functions */
1573 #if ENABLE_FEATURE_TOP_SMP_PROCESS
1574 int last_seen_on_cpu;
1577 /* flag bits for procps_scan(xx, flags) calls */
1579 PSSCAN_PID = 1 << 0,
1580 PSSCAN_PPID = 1 << 1,
1581 PSSCAN_PGID = 1 << 2,
1582 PSSCAN_SID = 1 << 3,
1583 PSSCAN_UIDGID = 1 << 4,
1584 PSSCAN_COMM = 1 << 5,
1585 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
1586 PSSCAN_ARGV0 = 1 << 7,
1587 PSSCAN_EXE = 1 << 8,
1588 PSSCAN_STATE = 1 << 9,
1589 PSSCAN_VSZ = 1 << 10,
1590 PSSCAN_RSS = 1 << 11,
1591 PSSCAN_STIME = 1 << 12,
1592 PSSCAN_UTIME = 1 << 13,
1593 PSSCAN_TTY = 1 << 14,
1594 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1595 /* NB: used by find_pid_by_name(). Any applet using it
1596 * needs to be mentioned here. */
1597 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1598 || ENABLE_PGREP || ENABLE_PKILL
1602 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
1603 PSSCAN_START_TIME = 1 << 18,
1604 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1605 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1606 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1607 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
1609 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1610 void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1611 procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
1612 /* Format cmdline (up to col chars) into char buf[size] */
1613 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1614 void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
1615 pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1616 pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
1617 int starts_with_cpu(const char *str) FAST_FUNC;
1618 unsigned get_cpu_count(void) FAST_FUNC;
1621 /* Use strict=1 if you process input from untrusted source:
1622 * it will return NULL on invalid %xx (bad hex chars)
1623 * and str + 1 if decoded char is / or NUL.
1624 * In non-strict mode, it always succeeds (returns str),
1625 * and also it additionally decoded '+' to space.
1627 char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
1630 extern const char bb_uuenc_tbl_base64[] ALIGN1;
1631 extern const char bb_uuenc_tbl_std[] ALIGN1;
1632 void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
1634 BASE64_FLAG_UU_STOP = 0x100,
1635 /* Sign-extends to a value which never matches fgetc result: */
1636 BASE64_FLAG_NO_STOP_CHAR = 0x80,
1638 const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
1639 void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
1641 typedef struct md5_ctx_t {
1642 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1643 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
1644 uint64_t total64; /* must be directly before hash[] */
1645 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1647 typedef struct md5_ctx_t sha1_ctx_t;
1648 typedef struct md5_ctx_t sha256_ctx_t;
1649 typedef struct sha512_ctx_t {
1650 uint64_t total64[2]; /* must be directly before hash[] */
1652 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
1654 typedef struct sha3_ctx_t {
1656 unsigned bytes_queued;
1658 void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1659 void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1660 void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1661 void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1662 #define sha1_hash md5_hash
1663 void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1664 void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1665 #define sha256_hash md5_hash
1666 #define sha256_end sha1_end
1667 void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1668 void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1669 void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
1670 void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
1671 void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1672 void sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
1674 extern uint32_t *global_crc32_table;
1675 uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1676 uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1677 uint32_t crc32_block_endian0(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1679 typedef struct masks_labels_t {
1683 int print_flags_separated(const int *masks, const char *labels,
1684 int flags, const char *separator) FAST_FUNC;
1685 int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
1687 typedef struct bb_progress_t {
1689 unsigned last_update_sec;
1690 unsigned last_change_sec;
1692 const char *curfile;
1695 #define is_bb_progress_inited(p) ((p)->curfile != NULL)
1696 #define bb_progress_free(p) do { \
1697 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1698 (p)->curfile = NULL; \
1700 void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
1701 void bb_progress_update(bb_progress_t *p,
1704 uoff_t totalsize) FAST_FUNC;
1707 extern const char *applet_name;
1709 /* Some older linkers don't perform string merging, we used to have common strings
1710 * as global arrays to do it by hand. But:
1711 * (1) newer linkers do it themselves,
1712 * (2) however, they DONT merge string constants with global arrays,
1713 * even if the value is the same (!). Thus global arrays actually
1714 * increased size a bit: for example, "/etc/passwd" string from libc
1715 * wasn't merged with bb_path_passwd_file[] array!
1716 * Therefore now we use #defines.
1718 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1719 extern const char bb_banner[] ALIGN1;
1720 extern const char bb_msg_memory_exhausted[] ALIGN1;
1721 extern const char bb_msg_invalid_date[] ALIGN1;
1722 #define bb_msg_read_error "read error"
1723 #define bb_msg_write_error "write error"
1724 extern const char bb_msg_unknown[] ALIGN1;
1725 extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
1726 extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
1727 extern const char bb_msg_you_must_be_root[] ALIGN1;
1728 extern const char bb_msg_requires_arg[] ALIGN1;
1729 extern const char bb_msg_invalid_arg[] ALIGN1;
1730 extern const char bb_msg_standard_input[] ALIGN1;
1731 extern const char bb_msg_standard_output[] ALIGN1;
1733 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1734 extern const char bb_hexdigits_upcase[] ALIGN1;
1736 extern const char bb_path_wtmp_file[] ALIGN1;
1738 /* Busybox mount uses either /proc/mounts or /etc/mtab to
1739 * get the list of currently mounted filesystems */
1740 #define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1742 #define bb_path_passwd_file _PATH_PASSWD
1743 #define bb_path_group_file _PATH_GROUP
1744 #define bb_path_shadow_file _PATH_SHADOW
1745 #define bb_path_gshadow_file _PATH_GSHADOW
1747 #define bb_path_motd_file "/etc/motd"
1749 #define bb_dev_null "/dev/null"
1750 extern const char bb_busybox_exec_path[] ALIGN1;
1751 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1752 * but I want to save a few bytes here */
1753 extern const char bb_PATH_root_path[] ALIGN1; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1754 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1755 #define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1757 extern const int const_int_0;
1758 extern const int const_int_1;
1761 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1762 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1763 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1764 /* This struct is deliberately not defined. */
1765 /* See docs/keep_data_small.txt */
1767 /* '*const' ptr makes gcc optimize code much better.
1768 * Magic prevents ptr_to_globals from going into rodata.
1769 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1770 extern struct globals *const ptr_to_globals;
1771 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1772 #define barrier() __asm__ __volatile__("":::"memory")
1773 #define SET_PTR_TO_GLOBALS(x) do { \
1774 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
1777 #define FREE_PTR_TO_GLOBALS() do { \
1778 if (ENABLE_FEATURE_CLEAN_UP) { \
1779 free(ptr_to_globals); \
1783 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1784 * use bb_default_login_shell and following defines.
1785 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1786 * don't forget to change increment constant. */
1787 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
1788 extern const char bb_default_login_shell[] ALIGN1;
1790 #define DEFAULT_SHELL (bb_default_login_shell+1)
1792 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1794 /* The following devices are the same on all systems. */
1795 #define CURRENT_TTY "/dev/tty"
1796 #define DEV_CONSOLE "/dev/console"
1798 #if defined(__FreeBSD_kernel__)
1799 # define CURRENT_VC CURRENT_TTY
1800 # define VC_1 "/dev/ttyv0"
1801 # define VC_2 "/dev/ttyv1"
1802 # define VC_3 "/dev/ttyv2"
1803 # define VC_4 "/dev/ttyv3"
1804 # define VC_5 "/dev/ttyv4"
1805 # define VC_FORMAT "/dev/ttyv%d"
1806 #elif defined(__GNU__)
1807 # define CURRENT_VC CURRENT_TTY
1808 # define VC_1 "/dev/tty1"
1809 # define VC_2 "/dev/tty2"
1810 # define VC_3 "/dev/tty3"
1811 # define VC_4 "/dev/tty4"
1812 # define VC_5 "/dev/tty5"
1813 # define VC_FORMAT "/dev/tty%d"
1814 #elif ENABLE_FEATURE_DEVFS
1815 /*Linux, obsolete devfs names */
1816 # define CURRENT_VC "/dev/vc/0"
1817 # define VC_1 "/dev/vc/1"
1818 # define VC_2 "/dev/vc/2"
1819 # define VC_3 "/dev/vc/3"
1820 # define VC_4 "/dev/vc/4"
1821 # define VC_5 "/dev/vc/5"
1822 # define VC_FORMAT "/dev/vc/%d"
1823 # define LOOP_FORMAT "/dev/loop/%u"
1824 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1825 # define LOOP_NAME "/dev/loop/"
1826 # define FB_0 "/dev/fb/0"
1828 /*Linux, normal names */
1829 # define CURRENT_VC "/dev/tty0"
1830 # define VC_1 "/dev/tty1"
1831 # define VC_2 "/dev/tty2"
1832 # define VC_3 "/dev/tty3"
1833 # define VC_4 "/dev/tty4"
1834 # define VC_5 "/dev/tty5"
1835 # define VC_FORMAT "/dev/tty%d"
1836 # define LOOP_FORMAT "/dev/loop%u"
1837 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1838 # define LOOP_NAME "/dev/loop"
1839 # define FB_0 "/dev/fb0"
1843 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1846 /* We redefine ctype macros. Unicode-correct handling of char types
1847 * can't be done with such byte-oriented operations anyway,
1848 * we don't lose anything.
1866 /* We save ~500 bytes on isdigit alone.
1867 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
1869 /* These work the same for ASCII and Unicode,
1870 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
1871 #define isascii(a) ((unsigned char)(a) <= 0x7f)
1872 #define isdigit(a) ((unsigned char)((a) - '0') <= 9)
1873 #define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1874 #define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
1875 #define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
1876 #define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1877 #define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
1878 /* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
1879 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
1881 #define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
1882 // Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1883 #define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1884 // Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
1885 #define isalnum(a) bb_ascii_isalnum(a)
1886 static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1888 unsigned char b = a - '0';
1892 return b <= 'z' - 'a';
1894 #define isxdigit(a) bb_ascii_isxdigit(a)
1895 static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1897 unsigned char b = a - '0';
1901 return b <= 'f' - 'a';
1903 #define toupper(a) bb_ascii_toupper(a)
1904 static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1906 unsigned char b = a - 'a';
1907 if (b <= ('z' - 'a'))
1911 #define tolower(a) bb_ascii_tolower(a)
1912 static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1914 unsigned char b = a - 'A';
1915 if (b <= ('Z' - 'A'))
1920 /* In ASCII and Unicode, these are likely to be very different.
1921 * Let's prevent ambiguous usage from the start */
1922 #define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1923 #define isprint(a) isprint_is_ambiguous_dont_use(a)
1924 /* NB: must not treat EOF as isgraph or isprint */
1925 #define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1926 #define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1929 POP_SAVED_FUNCTION_VISIBILITY