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 the GPL.
8 * Licensed under the GPL version 2, see the file LICENSE in this tarball.
30 #include <sys/ioctl.h>
32 #include <sys/socket.h>
35 #include <sys/types.h>
40 /* Try to pull in PATH_MAX */
42 #include <sys/param.h>
46 #ifdef HAVE_SYS_STATFS_H
47 #include <sys/statfs.h>
50 #include <selinux/selinux.h>
51 #include <selinux/context.h>
52 #include <selinux/flask.h>
53 #include <selinux/av_permissions.h>
55 #if ENABLE_LOCALE_SUPPORT
58 # define setlocale(x,y) ((void)0)
65 #if ENABLE_FEATURE_SHADOWPASSWDS
66 # if !ENABLE_USE_BB_SHADOW
67 /* If using busybox's shadow implementation, do not include the shadow.h
68 * header as the toolchain may not provide it at all.
73 #if defined __FreeBSD__
74 # include <netinet/in.h>
75 # include <arpa/inet.h>
76 #elif defined __APPLE__
77 # include <netinet/in.h>
79 # include <arpa/inet.h>
80 # if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
81 /* We #define socklen_t *after* includes, otherwise we get
82 * typedef redefinition errors from system headers
83 * (in case "is it defined already" detection above failed)
85 # define socklen_t bb_socklen_t
86 typedef unsigned socklen_t;
91 /* Some libc's forget to declare these, do it ourself */
93 extern char **environ;
94 #if defined(__GLIBC__) && __GLIBC__ < 2
95 int vdprintf(int d, const char *format, va_list ap);
97 /* klogctl is in libc's klog.h, but we cheat and not #include that */
98 int klogctl(int type, char *b, int len);
99 /* This is declared here rather than #including <libgen.h> in order to avoid
100 * confusing the two versions of basename. See the dirname/basename man page
102 #if !defined __FreeBSD__
103 char *dirname(char *path);
105 /* Include our own copy of struct sysinfo to avoid binary compatibility
106 * problems with Linux 2.4, which changed things. Grumble, grumble. */
108 long uptime; /* Seconds since boot */
109 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
110 unsigned long totalram; /* Total usable main memory size */
111 unsigned long freeram; /* Available memory size */
112 unsigned long sharedram; /* Amount of shared memory */
113 unsigned long bufferram; /* Memory used by buffers */
114 unsigned long totalswap; /* Total swap space size */
115 unsigned long freeswap; /* swap space still available */
116 unsigned short procs; /* Number of current processes */
117 unsigned short pad; /* Padding needed for m68k */
118 unsigned long totalhigh; /* Total high memory size */
119 unsigned long freehigh; /* Available high memory size */
120 unsigned int mem_unit; /* Memory unit size in bytes */
121 char _f[20 - 2 * sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
123 int sysinfo(struct sysinfo* info);
125 # define PATH_MAX 256
132 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
133 /* (don't include system headers after this until corresponding pop!) */
134 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
137 #if ENABLE_USE_BB_PWD_GRP
141 #if ENABLE_FEATURE_SHADOWPASSWDS
142 # if ENABLE_USE_BB_SHADOW
143 # include "shadow_.h"
147 /* Tested to work correctly with all int types (IIRC :]) */
148 #define MAXINT(T) (T)( \
151 : (T)~((T)1 << (sizeof(T)*8-1)) \
154 #define MININT(T) (T)( \
157 : ((T)1 << (sizeof(T)*8-1)) \
160 /* Large file support */
161 /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
162 * (stat, lseek etc) mapped to "largefile" variants by libc.
163 * Practically it means that open() automatically has O_LARGEFILE added
164 * and all filesize/file_offset parameters and struct members are "large"
165 * (in today's world - signed 64bit). For full support of large files,
166 * we need a few helper #defines (below) and careful use of off_t
167 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
169 /* CONFIG_LFS is on */
170 # if ULONG_MAX > 0xffffffff
171 /* "long" is long enough on this system */
172 typedef unsigned long uoff_t;
173 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
174 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
175 # define BB_STRTOOFF bb_strtoul
176 # define STRTOOFF strtoul
177 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
180 /* "long" is too short, need "long long" */
181 typedef unsigned long long uoff_t;
182 # define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
183 # define BB_STRTOOFF bb_strtoull
184 # define STRTOOFF strtoull
185 # define OFF_FMT "ll"
188 /* CONFIG_LFS is off */
189 # if UINT_MAX == 0xffffffff
190 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
191 * gcc will throw warnings on printf("%d", off_t). Crap... */
192 typedef unsigned long uoff_t;
193 # define XATOOFF(a) xatoi_u(a)
194 # define BB_STRTOOFF bb_strtou
195 # define STRTOOFF strtol
198 typedef unsigned long uoff_t;
199 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
200 # define BB_STRTOOFF bb_strtoul
201 # define STRTOOFF strtol
205 /* scary. better ideas? (but do *test* them first!) */
206 #define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
208 /* Some useful definitions */
210 #define FALSE ((int) 0)
212 #define TRUE ((int) 1)
214 #define SKIP ((int) 2)
217 #define MTAB_GETMOUNTPT '1'
218 #define MTAB_GETDEVICE '2'
220 #define BUF_SIZE 8192
221 #define EXPAND_ALLOC 1024
223 /* Macros for min/max. */
225 #define MIN(a,b) (((a)<(b))?(a):(b))
229 #define MAX(a,b) (((a)>(b))?(a):(b))
232 /* buffer allocation schemes */
233 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
234 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
235 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
236 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
238 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
239 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
240 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
241 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
243 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
244 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
245 #define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
249 #if defined(__GLIBC__)
250 /* glibc uses __errno_location() to get a ptr to errno */
251 /* We can just memorize it once - no multithreading in busybox :) */
252 extern int *const bb_errno;
254 #define errno (*bb_errno)
257 unsigned long long monotonic_ns(void) FAST_FUNC;
258 unsigned long long monotonic_us(void) FAST_FUNC;
259 unsigned long long monotonic_ms(void) FAST_FUNC;
260 unsigned monotonic_sec(void) FAST_FUNC;
262 extern void chomp(char *s) FAST_FUNC;
263 extern void trim(char *s) FAST_FUNC;
264 extern char *skip_whitespace(const char *) FAST_FUNC;
265 extern char *skip_non_whitespace(const char *) FAST_FUNC;
266 extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
268 extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
270 //TODO: supply a pointer to char[11] buffer (avoid statics)?
271 extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
272 extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
273 enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
274 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
275 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
276 FILEUTILS_RECUR = 1 << 2, /* -R */
277 FILEUTILS_FORCE = 1 << 3, /* -f */
278 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
279 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
280 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
281 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
282 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
284 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
285 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
288 #define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
289 extern int remove_file(const char *path, int flags) FAST_FUNC;
290 /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
291 * the source, not copy (unless "source" is a directory).
292 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
293 * work coreutils-compatibly. */
294 extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
297 ACTION_RECURSE = (1 << 0),
298 ACTION_FOLLOWLINKS = (1 << 1),
299 ACTION_FOLLOWLINKS_L0 = (1 << 2),
300 ACTION_DEPTHFIRST = (1 << 3),
301 /*ACTION_REVERSE = (1 << 4), - unused */
302 ACTION_QUIET = (1 << 5),
303 ACTION_DANGLING_OK = (1 << 6),
305 typedef uint8_t recurse_flags_t;
306 extern int recursive_action(const char *fileName, unsigned flags,
307 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
308 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
309 void* userData, unsigned depth) FAST_FUNC;
310 extern int device_open(const char *device, int mode) FAST_FUNC;
311 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
312 extern int xgetpty(char *line) FAST_FUNC;
313 extern int get_console_fd_or_die(void) FAST_FUNC;
314 extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
315 extern char *find_block_device(const char *path) FAST_FUNC;
316 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
317 extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
318 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
319 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
320 /* "short" copy can be detected by return value < size */
321 /* this helper yells "short read!" if param is not -1 */
322 extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
323 extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
324 /* xxxx_strip version can modify its parameter:
328 * "abc/def/" -> "def" !!
330 extern char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
331 /* "abc/def/" -> "" and it never modifies 'path' */
332 extern char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
334 int ndelay_on(int fd) FAST_FUNC;
335 int ndelay_off(int fd) FAST_FUNC;
336 int close_on_exec_on(int fd) FAST_FUNC;
337 void xdup2(int, int) FAST_FUNC;
338 void xmove_fd(int, int) FAST_FUNC;
341 DIR *xopendir(const char *path) FAST_FUNC;
342 DIR *warn_opendir(const char *path) FAST_FUNC;
344 char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
345 char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
346 char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
347 /* !RETURNS_MALLOC: it's a realloc-like function */
348 char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
350 char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
354 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
355 * otherwise would kill us, except for those resulting from bugs:
356 * SIGSEGV, SIGILL, SIGFPE.
357 * Other fatal signals not included (TODO?):
358 * SIGBUS Bus error (bad memory access)
359 * SIGPOLL Pollable event. Synonym of SIGIO
360 * SIGPROF Profiling timer expired
361 * SIGSYS Bad argument to routine
362 * SIGTRAP Trace/breakpoint trap
364 * The only known arch with some of these sigs not fitting
365 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
366 * Dance around with long long to guard against that...
368 BB_FATAL_SIGS = (int)(0
372 + (1LL << SIGPIPE) // Write to pipe with no readers
373 + (1LL << SIGQUIT) // Quit from keyboard
374 + (1LL << SIGABRT) // Abort signal from abort(3)
375 + (1LL << SIGALRM) // Timer signal from alarm(2)
376 + (1LL << SIGVTALRM) // Virtual alarm clock
377 + (1LL << SIGXCPU) // CPU time limit exceeded
378 + (1LL << SIGXFSZ) // File size limit exceeded
379 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
383 void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
384 /* Unlike signal() and bb_signals, sets handler with sigaction()
385 * and in a way that while signal handler is run, no other signals
386 * will be blocked; syscalls will not be restarted: */
387 void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
388 /* syscalls like read() will be interrupted with EINTR: */
389 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
390 /* syscalls like read() won't be interrupted (though select/poll will be): */
391 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
392 void wait_for_any_sig(void) FAST_FUNC;
393 void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
394 void sig_block(int sig) FAST_FUNC;
395 void sig_unblock(int sig) FAST_FUNC;
396 /* Will do sigaction(signum, act, NULL): */
397 int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
398 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
399 int sigprocmask_allsigs(int how) FAST_FUNC;
400 /* Standard handler which just records signo */
401 extern smallint bb_got_signal;
402 void record_signo(int signo); /* not FAST_FUNC! */
405 void xsetgid(gid_t gid) FAST_FUNC;
406 void xsetuid(uid_t uid) FAST_FUNC;
407 void xchdir(const char *path) FAST_FUNC;
408 void xchroot(const char *path) FAST_FUNC;
409 void xsetenv(const char *key, const char *value) FAST_FUNC;
410 void bb_unsetenv(const char *key) FAST_FUNC;
411 void xunlink(const char *pathname) FAST_FUNC;
412 void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
413 int xopen(const char *pathname, int flags) FAST_FUNC;
414 int xopen_nonblocking(const char *pathname) FAST_FUNC;
415 int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
416 int open_or_warn(const char *pathname, int flags) FAST_FUNC;
417 int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
418 int open_or_warn_stdin(const char *pathname) FAST_FUNC;
419 void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
420 int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
421 off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
422 off_t fdlength(int fd) FAST_FUNC;
424 uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
425 const char *override,
426 unsigned override_units,
429 void xpipe(int filedes[2]) FAST_FUNC;
430 /* In this form code with pipes is much more readable */
431 struct fd_pair { int rd; int wr; };
432 #define piped_pair(pair) pipe(&((pair).rd))
433 #define xpiped_pair(pair) xpipe(&((pair).rd))
435 /* Useful for having small structure members/global variables */
436 typedef int8_t socktype_t;
437 typedef int8_t family_t;
438 struct BUG_too_small {
439 char BUG_socktype_t_too_small[(0
446 char BUG_family_t_too_small[(0
463 void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
464 time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
467 int xsocket(int domain, int type, int protocol) FAST_FUNC;
468 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
469 void xlisten(int s, int backlog) FAST_FUNC;
470 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
471 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
472 socklen_t tolen) FAST_FUNC;
473 /* SO_REUSEADDR allows a server to rebind to an address that is already
474 * "in use" by old connections to e.g. previous server instance which is
475 * killed or crashed. Without it bind will fail until all such connections
476 * time out. Linux does not allow multiple live binds on same ip:port
477 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
478 * Turn it on before you call bind(). */
479 void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
480 int setsockopt_broadcast(int fd) FAST_FUNC;
481 int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
482 /* NB: returns port in host byte order */
483 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
484 typedef struct len_and_sockaddr {
488 struct sockaddr_in sin;
489 #if ENABLE_FEATURE_IPV6
490 struct sockaddr_in6 sin6;
495 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
496 LSA_SIZEOF_SA = sizeof(
499 struct sockaddr_in sin;
500 #if ENABLE_FEATURE_IPV6
501 struct sockaddr_in6 sin6;
506 /* Create stream socket, and allocate suitable lsa.
507 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
508 * af == AF_UNSPEC will result in trying to create IPv6 socket,
509 * and if kernel doesn't support it, fall back to IPv4.
510 * This is useful if you plan to bind to resulting local lsa.
512 #if ENABLE_FEATURE_IPV6
513 int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
515 int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
516 #define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
518 int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
519 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
520 * numeric IP ("N.N.N.N") or numeric IPv6 address,
521 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
522 * Only if there is no suffix, port argument is used */
523 /* NB: these set SO_REUSEADDR before bind */
524 int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
525 int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
526 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
527 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
528 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
529 * If there is no suffix, port argument is used */
530 int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
531 /* Connect to peer identified by lsa */
532 int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
533 /* Get local address of bound or accepted socket */
534 len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
535 /* Get remote address of connected or accepted socket */
536 len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
537 /* Return malloc'ed len_and_sockaddr with socket address of host:port
538 * Currently will return IPv4 or IPv6 sockaddrs only
539 * (depending on host), but in theory nothing prevents e.g.
540 * UNIX socket address being returned, IPX sockaddr etc...
541 * On error does bb_error_msg and returns NULL */
542 len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
543 /* Version which dies on error */
544 len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
545 len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
546 /* Same, useful if you want to force family (e.g. IPv6) */
547 #if !ENABLE_FEATURE_IPV6
548 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
549 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
551 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
552 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
554 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
555 * otherwise no-op. Useful for ftp.
556 * NB: does NOT do htons() internally, just direct assignment. */
557 void set_nport(len_and_sockaddr *lsa, unsigned port) FAST_FUNC;
558 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
559 int get_nport(const struct sockaddr *sa) FAST_FUNC;
560 /* Reverse DNS. Returns NULL on failure. */
561 char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
562 /* This one doesn't append :PORTNUM */
563 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
564 /* This one also doesn't fall back to dotted IP (returns NULL) */
565 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
566 /* inet_[ap]ton on steroids */
567 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
568 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
569 // "old" (ipv4 only) API
570 // users: traceroute.c hostname.c - use _list_ of all IPs
571 struct hostent *xgethostbyname(const char *name) FAST_FUNC;
572 // Also mount.c and inetd.c are using gethostbyname(),
573 // + inet_common.c has additional IPv4-only stuff
576 void socket_want_pktinfo(int fd) FAST_FUNC;
577 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
578 const struct sockaddr *to,
579 const struct sockaddr *from,
580 socklen_t tolen) FAST_FUNC;
581 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
582 struct sockaddr *from,
584 socklen_t sa_size) FAST_FUNC;
587 char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
588 char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
589 void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
590 char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
591 char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
592 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
593 * But potentially slow, don't use in one-billion-times loops */
594 int bb_putchar(int ch) FAST_FUNC;
595 /* Note: does not use stdio, writes to fd 2 directly */
596 int bb_putchar_stderr(char ch) FAST_FUNC;
597 char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
598 // gcc-4.1.1 still isn't good enough at optimizing it
599 // (+200 bytes compared to macro)
600 //static ALWAYS_INLINE
601 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
602 //static ALWAYS_INLINE
603 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
604 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
605 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
606 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
607 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
608 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
610 typedef struct uni_stat_t {
612 unsigned unicode_count;
613 unsigned unicode_width;
615 /* Returns a string with unprintable chars replaced by '?' or
616 * SUBST_WCHAR. This function is unicode-aware. */
617 const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
618 /* Prints unprintable char ch as ^C or M-c to file
619 * (M-c is used only if ch is ORed with PRINTABLE_META),
620 * else it is printed as-is (except for ch = 0x9b) */
621 enum { PRINTABLE_META = 0x100 };
622 void fputc_printable(int ch, FILE *file) FAST_FUNC;
624 /* dmalloc will redefine these to it's own implementation. It is safe
625 * to have the prototypes here unconditionally. */
626 void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
627 void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
628 void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
629 void *xrealloc(void *old, size_t size) FAST_FUNC;
630 /* After xrealloc_vector(v, 4, idx) it's ok to use
631 * at least v[idx] and v[idx+1], for all idx values.
632 * shift specifies how many new elements are added (1: 2, 2: 4... 8: 256...)
633 * when all elements are used up. New elements are zeroed out. */
634 #define xrealloc_vector(vector, shift, idx) \
635 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
636 void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
639 extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
640 extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count) FAST_FUNC;
641 // NB: will return short read on error, not -1,
642 // if some data was read before error occurred
643 extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
644 extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
645 extern unsigned char xread_char(int fd) FAST_FUNC;
646 extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
647 extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
648 // Reads one line a-la fgets (but doesn't save terminating '\n').
649 // Reads byte-by-byte. Useful when it is important to not read ahead.
650 // Bytes are appended to pfx (which must be malloced, or NULL).
651 extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p) FAST_FUNC;
652 /* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
653 extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
654 /* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
655 extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
656 /* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
657 #if ENABLE_FEATURE_SEAMLESS_LZMA \
658 || ENABLE_FEATURE_SEAMLESS_BZ2 \
659 || ENABLE_FEATURE_SEAMLESS_GZ \
660 /* || ENABLE_FEATURE_SEAMLESS_Z */
661 extern void setup_unzip_on_fd(int fd /*, int fail_if_not_detected*/) FAST_FUNC;
663 # define setup_unzip_on_fd(...) ((void)0)
665 /* Autodetects .gz etc */
666 extern int open_zipped(const char *fname) FAST_FUNC;
667 extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
668 /* Never returns NULL */
669 extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
671 extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
672 // NB: will return short write on error, not -1,
673 // if some data was written before error occurred
674 extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
675 extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
676 extern void xwrite_str(int fd, const char *str) FAST_FUNC;
677 extern ssize_t full_write1_str(const char *str) FAST_FUNC;
678 extern ssize_t full_write2_str(const char *str) FAST_FUNC;
679 extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
681 /* Close fd, but check for failures (some types of write errors) */
682 extern void xclose(int fd) FAST_FUNC;
684 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
685 extern void xprint_and_close_file(FILE *file) FAST_FUNC;
687 extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
688 extern char *bb_get_chunk_with_continuation(FILE *file, int *end, int *lineno) FAST_FUNC;
689 /* Reads up to (and including) TERMINATING_STRING: */
690 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
691 /* Same, with limited max size, and returns the length (excluding NUL): */
692 extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
693 /* Chops off TERMINATING_STRING from the end: */
694 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
695 /* Reads up to (and including) "\n" or NUL byte: */
696 extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
697 /* Chops off '\n' from the end, unlike fgets: */
698 extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
699 /* Same, but doesn't try to conserve space (may have some slack after the end) */
700 /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
702 void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
703 void die_if_ferror_stdout(void) FAST_FUNC;
704 int fflush_all(void) FAST_FUNC;
705 void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
706 int fclose_if_not_stdin(FILE *file) FAST_FUNC;
707 FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
708 /* Prints warning to stderr and returns NULL on failure: */
709 FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
710 /* "Opens" stdin if filename is special, else just opens file: */
711 FILE* xfopen_stdin(const char *filename) FAST_FUNC;
712 FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
713 FILE* fopen_for_read(const char *path) FAST_FUNC;
714 FILE* xfopen_for_read(const char *path) FAST_FUNC;
715 FILE* fopen_for_write(const char *path) FAST_FUNC;
716 FILE* xfopen_for_write(const char *path) FAST_FUNC;
717 FILE* xfdopen_for_read(int fd) FAST_FUNC;
718 FILE* xfdopen_for_write(int fd) FAST_FUNC;
720 int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
721 void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
723 /* Wrapper which restarts poll on EINTR or ENOMEM.
724 * On other errors complains [perror("poll")] and returns.
725 * Warning! May take (much) longer than timeout_ms to return!
726 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
727 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
729 char *safe_gethostname(void) FAST_FUNC;
730 char *safe_getdomainname(void) FAST_FUNC;
732 /* Convert each alpha char in str to lower-case */
733 char* str_tolower(char *str) FAST_FUNC;
735 char *utoa(unsigned n) FAST_FUNC;
736 char *itoa(int n) FAST_FUNC;
737 /* Returns a pointer past the formatted number, does NOT null-terminate */
738 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
739 char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
740 /* Intelligent formatters of bignums */
741 void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
742 void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
743 /* If block_size == 0, display size without fractional part,
744 * else display (size * block_size) with one decimal digit.
745 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
746 * else divide by display_unit and do not use suffix. */
747 #define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
748 #define HUMAN_READABLE_MAX_WIDTH_STR "7"
749 //TODO: provide pointer to buf (avoid statics)?
750 const char *make_human_readable_str(unsigned long long size,
751 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
752 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
753 char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
755 char* hex2bin(char *dst, const char *str, int count) FAST_FUNC;
757 /* Generate a UUID */
758 void generate_uuid(uint8_t *buf) FAST_FUNC;
760 /* Last element is marked by mult == 0 */
767 /* Using xatoi() instead of naive atoi() is not always convenient -
768 * in many places people want *non-negative* values, but store them
769 * in signed int. Therefore we need this one:
770 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
771 int xatoi_u(const char *numstr) FAST_FUNC;
772 /* Useful for reading port numbers */
773 uint16_t xatou16(const char *numstr) FAST_FUNC;
776 /* These parse entries in /etc/passwd and /etc/group. This is desirable
777 * for BusyBox since we want to avoid using the glibc NSS stuff, which
778 * increases target size and is often not needed on embedded systems. */
779 long xuname2uid(const char *name) FAST_FUNC;
780 long xgroup2gid(const char *name) FAST_FUNC;
781 /* wrapper: allows string to contain numeric uid or gid */
782 unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
783 /* from chpst. Does not die, returns 0 on failure */
788 /* always sets uid and gid */
789 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
790 /* always sets uid and gid, allows numeric; exits on failure */
791 void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
792 /* chown-like handling of "user[:[group]" */
793 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
794 struct passwd* xgetpwnam(const char *name) FAST_FUNC;
795 struct group* xgetgrnam(const char *name) FAST_FUNC;
796 struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
797 struct group* xgetgrgid(gid_t gid) FAST_FUNC;
798 char* xuid2uname(uid_t uid) FAST_FUNC;
799 char* xgid2group(gid_t gid) FAST_FUNC;
800 char* uid2uname(uid_t uid) FAST_FUNC;
801 char* gid2group(gid_t gid) FAST_FUNC;
802 char* uid2uname_utoa(long uid) FAST_FUNC;
803 char* gid2group_utoa(long gid) FAST_FUNC;
804 /* versions which cache results (useful for ps, ls etc) */
805 const char* get_cached_username(uid_t uid) FAST_FUNC;
806 const char* get_cached_groupname(gid_t gid) FAST_FUNC;
807 void clear_username_cache(void) FAST_FUNC;
808 /* internally usernames are saved in fixed-sized char[] buffers */
809 enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
810 #if ENABLE_FEATURE_CHECK_NAMES
811 void die_if_bad_username(const char* name) FAST_FUNC;
813 #define die_if_bad_username(name) ((void)(name))
816 #if ENABLE_FEATURE_UTMP
817 void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
818 void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
820 # define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
821 # define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
824 int execable_file(const char *name) FAST_FUNC;
825 char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
826 int exists_execable(const char *filename) FAST_FUNC;
828 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
829 * but it may exec busybox and call applet instead of searching PATH.
831 #if ENABLE_FEATURE_PREFER_APPLETS
832 int bb_execvp(const char *file, char *const argv[]) FAST_FUNC;
833 #define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
834 #define BB_EXECLP(prog,cmd,...) \
835 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
838 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
839 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
842 /* NOMMU friendy fork+exec: */
843 pid_t spawn(char **argv) FAST_FUNC;
844 pid_t xspawn(char **argv) FAST_FUNC;
846 pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
847 pid_t wait_any_nohang(int *wstat) FAST_FUNC;
848 /* wait4pid: unlike waitpid, waits ONLY for one process.
849 * Returns sig + 0x180 if child is killed by signal.
850 * It's safe to pass negative 'pids' from failed [v]fork -
851 * wait4pid will return -1 (and will not clobber [v]fork's errno).
852 * IOW: rc = wait4pid(spawn(argv));
853 * if (rc < 0) bb_perror_msg("%s", argv[0]);
854 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
856 int wait4pid(pid_t pid) FAST_FUNC;
857 /* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
858 int spawn_and_wait(char **argv) FAST_FUNC;
859 struct nofork_save_area {
861 const char *applet_name;
862 int xfunc_error_retval;
863 uint32_t option_mask32;
867 void save_nofork_data(struct nofork_save_area *save) FAST_FUNC;
868 void restore_nofork_data(struct nofork_save_area *save) FAST_FUNC;
869 /* Does NOT check that applet is NOFORK, just blindly runs it */
870 int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
871 int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv) FAST_FUNC;
873 /* Helpers for daemonization.
875 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
877 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
878 * rexec's itself on NOMMU with argv passed as command line.
879 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
880 * from the start. (It will detect it and not reexec again second time).
881 * You have to audit carefully that you don't do something twice as a result
882 * (opening files/sockets, parsing config files etc...)!
884 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
885 * (will do setsid()).
887 * fork_or_rexec(argv) = bare-bones "fork" on MMU,
888 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
889 * On MMU ignores argv.
891 * Helper for network daemons in foreground mode:
893 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
894 * to /dev/null if they are not.
897 DAEMON_CHDIR_ROOT = 1,
898 DAEMON_DEVNULL_STDIO = 2,
899 DAEMON_CLOSE_EXTRA_FDS = 4,
900 DAEMON_ONLY_SANITIZE = 8, /* internal use */
903 pid_t fork_or_rexec(void) FAST_FUNC;
904 enum { re_execed = 0 };
905 # define fork_or_rexec(argv) fork_or_rexec()
906 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
907 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
909 void re_exec(char **argv) NORETURN FAST_FUNC;
910 pid_t fork_or_rexec(char **argv) FAST_FUNC;
911 extern bool re_execed;
912 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
913 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
914 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
915 # define fork() BUG_fork_is_unavailable_on_nommu()
916 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
917 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
919 void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
920 void bb_sanitize_stdio(void) FAST_FUNC;
921 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
922 int sanitize_env_if_suid(void) FAST_FUNC;
925 char* single_argv(char **argv) FAST_FUNC;
926 extern const char *const bb_argv_dash[]; /* "-", NULL */
927 extern const char *opt_complementary;
928 #if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
929 #define No_argument "\0"
930 #define Required_argument "\001"
931 #define Optional_argument "\002"
932 extern const char *applet_long_options;
934 extern uint32_t option_mask32;
935 extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
938 typedef struct llist_t {
940 struct llist_t *link;
942 void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
943 void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
944 void *llist_pop(llist_t **elm) FAST_FUNC;
945 void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
946 void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
947 llist_t *llist_rev(llist_t *list) FAST_FUNC;
948 llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
949 /* BTW, surprisingly, changing API to
950 * llist_t *llist_add_to(llist_t *old_head, void *data)
951 * etc does not result in smaller code... */
953 /* start_stop_daemon and udhcpc are special - they want
954 * to create pidfiles regardless of FEATURE_PIDFILE */
955 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
956 /* True only if we created pidfile which is *file*, not /dev/null etc */
957 extern smallint wrote_pidfile;
958 void write_pidfile(const char *path) FAST_FUNC;
959 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
961 enum { wrote_pidfile = 0 };
962 #define write_pidfile(path) ((void)0)
963 #define remove_pidfile(path) ((void)0)
968 LOGMODE_STDIO = (1 << 0),
969 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
970 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
972 extern const char *msg_eol;
973 extern smallint logmode;
974 extern int die_sleep;
975 extern int xfunc_error_retval;
976 extern jmp_buf die_jmp;
977 extern void xfunc_die(void) NORETURN FAST_FUNC;
978 extern void bb_show_usage(void) NORETURN FAST_FUNC;
979 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
980 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
981 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
982 extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
983 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
984 extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
985 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
986 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
987 extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
988 extern void bb_perror_nomsg(void) FAST_FUNC;
989 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
990 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
992 /* We need to export XXX_main from libbusybox
993 * only if we build "individual" binaries
995 #if ENABLE_FEATURE_INDIVIDUAL
996 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
998 #define MAIN_EXTERNALLY_VISIBLE
1002 /* Applets which are useful from another applets */
1003 int bb_cat(char** argv);
1004 /* If shell needs them, they exist even if not enabled as applets */
1005 int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1006 int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1007 int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1008 int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
1009 /* Similar, but used by chgrp, not shell */
1010 int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
1012 int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1013 /* Don't need IF_xxx() guard for these */
1014 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1015 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1018 void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
1023 int create_icmp_socket(void) FAST_FUNC;
1024 int create_icmp6_socket(void) FAST_FUNC;
1026 /* This structure defines protocol families and their handlers. */
1032 char* FAST_FUNC (*print)(unsigned char *);
1033 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1034 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1035 void FAST_FUNC (*herror)(char *text);
1036 int FAST_FUNC (*rprint)(int options);
1037 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
1038 /* may modify src */
1039 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
1041 /* This structure defines hardware protocols and their handlers. */
1047 char* FAST_FUNC (*print)(unsigned char *);
1048 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1049 int FAST_FUNC (*activate)(int fd);
1050 int suppress_null_addr;
1052 extern smallint interface_opt_a;
1053 int display_interfaces(char *ifname) FAST_FUNC;
1054 #if ENABLE_FEATURE_HWIB
1055 int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1057 #define in_ib(a, b) 1 /* fail */
1059 const struct aftype *get_aftype(const char *name) FAST_FUNC;
1060 const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1061 const struct hwtype *get_hwntype(int type) FAST_FUNC;
1064 #ifndef BUILD_INDIVIDUAL
1065 extern int find_applet_by_name(const char *name) FAST_FUNC;
1066 /* Returns only if applet is not found. */
1067 extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
1068 extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
1071 #ifdef HAVE_MNTENT_H
1072 extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
1073 extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
1075 extern void erase_mtab(const char * name) FAST_FUNC;
1076 extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1077 extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1079 extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1081 # define bb_warn_ignoring_args(arg) ((void)0)
1084 extern int get_linux_version_code(void) FAST_FUNC;
1086 extern char *query_loop(const char *device) FAST_FUNC;
1087 extern int del_loop(const char *device) FAST_FUNC;
1088 /* If *devname is not NULL, use that name, otherwise try to find free one,
1089 * malloc and return it in *devname.
1090 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
1091 extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
1093 /* Like bb_ask below, but asks on stdin with no timeout. */
1094 char *bb_ask_stdin(const char * prompt) FAST_FUNC;
1095 //TODO: pass buf pointer or return allocated buf (avoid statics)?
1096 char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
1097 int bb_ask_confirmation(void) FAST_FUNC;
1099 int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
1102 * Config file parser
1105 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1106 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1107 // TODO: COLLAPSE and TRIM seem to always go in pair
1108 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1109 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
1110 // keep a copy of current line
1111 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
1112 // PARSE_ESCAPE = 0x00400000, // process escape sequences in tokens
1114 // * remove leading and trailing delimiters and collapse
1115 // multiple delimiters into one
1116 // * warn and continue if less than mintokens delimiters found
1117 // * grab everything into last token
1118 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
1120 typedef struct parser_t {
1126 parser_t* config_open(const char *filename) FAST_FUNC;
1127 parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
1128 int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1129 #define config_read(parser, tokens, max, min, str, flags) \
1130 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1131 void config_close(parser_t *parser) FAST_FUNC;
1133 /* Concatenate path and filename to new allocated buffer.
1134 * Add "/" only as needed (no duplicate "//" are produced).
1135 * If path is NULL, it is assumed to be "/".
1136 * filename should not be NULL. */
1137 char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1138 char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1139 const char *bb_basename(const char *name) FAST_FUNC;
1140 /* NB: can violate const-ness (similarly to strchr) */
1141 char *last_char_is(const char *s, int c) FAST_FUNC;
1144 int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1146 int get_signum(const char *name) FAST_FUNC;
1147 const char *get_signame(int number) FAST_FUNC;
1148 void print_signames(void) FAST_FUNC;
1150 char *bb_simplify_path(const char *path) FAST_FUNC;
1151 /* Returns ptr to NUL */
1152 char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
1154 #define FAIL_DELAY 3
1155 extern void bb_do_delay(int seconds) FAST_FUNC;
1156 extern void change_identity(const struct passwd *pw) FAST_FUNC;
1157 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
1158 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) FAST_FUNC;
1160 extern void renew_current_security_context(void) FAST_FUNC;
1161 extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1162 extern context_t set_security_context_component(security_context_t cur_context,
1163 char *user, char *role, char *type, char *range) FAST_FUNC;
1164 extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1165 extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1167 #define selinux_preserve_fcontext(fdesc) ((void)0)
1169 extern void selinux_or_die(void) FAST_FUNC;
1171 /* setup_environment:
1172 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
1173 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1175 * USER=pw->pw_name, LOGNAME=pw->pw_name
1176 * PATH=bb_default_[root_]path
1179 * else if change_env = 1:
1180 * if not root (if pw->pw_uid != 0):
1181 * USER=pw->pw_name, LOGNAME=pw->pw_name
1186 #define SETUP_ENV_CHANGEENV (1 << 0)
1187 #define SETUP_ENV_CLEARENV (1 << 1)
1188 #define SETUP_ENV_TO_TMP (1 << 2)
1189 extern void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1190 extern int correct_password(const struct passwd *pw) FAST_FUNC;
1191 /* Returns a malloced string */
1192 #if !ENABLE_USE_BB_CRYPT
1193 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1195 extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1196 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1197 /* rnd is additional random input. New one is returned.
1198 * Useful if you call crypt_make_salt many times in a row:
1199 * rnd = crypt_make_salt(buf1, 4, 0);
1200 * rnd = crypt_make_salt(buf2, 4, rnd);
1201 * rnd = crypt_make_salt(buf3, 4, rnd);
1202 * (otherwise we risk having same salt generated)
1204 extern int crypt_make_salt(char *p, int cnt, int rnd) FAST_FUNC;
1206 /* Returns number of lines changed, or -1 on error */
1207 #if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1208 #define update_passwd(filename, username, data, member) \
1209 update_passwd(filename, username, data)
1211 extern int update_passwd(const char *filename,
1212 const char *username,
1214 const char *member) FAST_FUNC;
1216 int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1217 int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1218 int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1219 int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1220 const char *nth_string(const char *strings, int n) FAST_FUNC;
1222 extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1223 extern void print_login_prompt(void) FAST_FUNC;
1225 char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
1226 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1227 int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1229 int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1231 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1232 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1233 int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1234 #if ENABLE_IOCTL_HEX2STR_ERROR
1235 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1236 int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1237 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1238 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1240 int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1241 int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1242 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1243 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1246 char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1247 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1248 void reset_ino_dev_hashtable(void) FAST_FUNC;
1250 /* At least glibc has horrendously large inline for this, so wrap it */
1251 unsigned long long bb_makedev(unsigned int major, unsigned int minor) FAST_FUNC;
1253 #define makedev(a,b) bb_makedev(a,b)
1257 /* "Keycodes" that report an escape sequence.
1258 * We use something which fits into signed char,
1259 * yet doesn't represent any valid Unicode character.
1260 * Also, -1 is reserved for error indication and we don't use it. */
1268 KEYCODE_INSERT = -8,
1269 KEYCODE_DELETE = -9,
1270 KEYCODE_PAGEUP = -10,
1271 KEYCODE_PAGEDOWN = -11,
1273 KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1274 KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
1275 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1276 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
1287 KEYCODE_FUN10 = -21,
1288 KEYCODE_FUN11 = -22,
1289 KEYCODE_FUN12 = -23,
1291 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
1292 /* How long is the longest ESC sequence we know?
1293 * We want it big enough to be able to contain
1294 * cursor position sequence "ESC [ 9999 ; 9999 R"
1296 KEYCODE_BUFFER_SIZE = 16
1298 /* Note: fd may be in blocking or non-blocking mode, both make sense.
1299 * For one, less uses non-blocking mode.
1300 * Only the first read syscall inside read_key may block indefinitely
1301 * (unless fd is in non-blocking mode),
1302 * subsequent reads will time out after a few milliseconds.
1303 * Return of -1 means EOF or error (errno == 0 on EOF).
1304 * buffer[0] is used as a counter of buffered chars and must be 0
1307 * -2: do not poll for input;
1308 * -1: poll(-1) (i.e. block);
1309 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
1311 int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
1312 void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
1315 #if ENABLE_FEATURE_EDITING
1316 /* It's NOT just ENABLEd or disabled. It's a number: */
1317 # ifdef CONFIG_FEATURE_EDITING_HISTORY
1318 # define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1320 # define MAX_HISTORY 0
1322 typedef struct line_input_t {
1324 const char *path_lookup;
1328 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1329 unsigned cnt_history_in_file;
1330 const char *hist_file;
1332 char *history[MAX_HISTORY + 1];
1336 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1337 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1338 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1339 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1340 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
1341 WITH_PATH_LOOKUP = 0x20,
1342 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1344 line_input_t *new_line_input_t(int flags) FAST_FUNC;
1345 /* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1346 /* maxsize must be >= 2.
1348 * -1 on read errors or EOF, or on bare Ctrl-D,
1349 * 0 on ctrl-C (the line entered is still returned in 'command'),
1350 * >0 length of input string, including terminating '\n'
1352 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state) FAST_FUNC;
1354 #define MAX_HISTORY 0
1355 int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1356 #define read_line_input(prompt, command, maxsize, state) \
1357 read_line_input(prompt, command, maxsize)
1362 # ifdef TASK_COMM_LEN
1363 enum { COMM_LEN = TASK_COMM_LEN };
1365 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1366 enum { COMM_LEN = 16 };
1369 typedef struct procps_status_t {
1371 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
1372 uint8_t shift_pages_to_bytes;
1373 uint8_t shift_pages_to_kb;
1374 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1378 IF_SELINUX(char *context;)
1379 /* Everything below must contain no ptrs to malloc'ed data:
1380 * it is memset(0) for each process in procps_scan() */
1381 unsigned long vsz, rss; /* we round it to kbytes */
1382 unsigned long stime, utime;
1383 unsigned long start_time;
1390 #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1395 unsigned tty_major,tty_minor;
1396 #if ENABLE_FEATURE_TOPMEM
1397 unsigned long mapped_rw;
1398 unsigned long mapped_ro;
1399 unsigned long shared_clean;
1400 unsigned long shared_dirty;
1401 unsigned long private_clean;
1402 unsigned long private_dirty;
1403 unsigned long stack;
1406 /* basename of executable in exec(2), read from /proc/N/stat
1407 * (if executable is symlink or script, it is NOT replaced
1408 * by link target or interpreter name) */
1409 char comm[COMM_LEN];
1410 /* user/group? - use passwd/group parsing functions */
1411 #if ENABLE_FEATURE_TOP_SMP_PROCESS
1412 int last_seen_on_cpu;
1415 /* flag bits for procps_scan(xx, flags) calls */
1417 PSSCAN_PID = 1 << 0,
1418 PSSCAN_PPID = 1 << 1,
1419 PSSCAN_PGID = 1 << 2,
1420 PSSCAN_SID = 1 << 3,
1421 PSSCAN_UIDGID = 1 << 4,
1422 PSSCAN_COMM = 1 << 5,
1423 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
1424 PSSCAN_ARGV0 = 1 << 7,
1425 PSSCAN_EXE = 1 << 8,
1426 PSSCAN_STATE = 1 << 9,
1427 PSSCAN_VSZ = 1 << 10,
1428 PSSCAN_RSS = 1 << 11,
1429 PSSCAN_STIME = 1 << 12,
1430 PSSCAN_UTIME = 1 << 13,
1431 PSSCAN_TTY = 1 << 14,
1432 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1433 /* NB: used by find_pid_by_name(). Any applet using it
1434 * needs to be mentioned here. */
1435 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1436 || ENABLE_PGREP || ENABLE_PKILL
1440 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
1441 PSSCAN_START_TIME = 1 << 18,
1442 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1443 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1444 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1445 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
1446 /* These are all retrieved from proc/NN/stat in one go: */
1447 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
1448 /**/ | PSSCAN_COMM | PSSCAN_STATE
1449 /**/ | PSSCAN_VSZ | PSSCAN_RSS
1450 /**/ | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
1451 /**/ | PSSCAN_TTY | PSSCAN_NICE
1454 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1455 void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1456 procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
1457 /* Format cmdline (up to col chars) into char buf[size] */
1458 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1459 void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
1460 pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1461 pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
1464 extern const char bb_uuenc_tbl_base64[];
1465 extern const char bb_uuenc_tbl_std[];
1466 void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
1468 typedef struct sha1_ctx_t {
1469 uint32_t hash[8]; /* 5, +3 elements for sha256 */
1471 uint8_t wbuffer[64]; /* NB: always correctly aligned for uint64_t */
1472 void (*process_block)(struct sha1_ctx_t*) FAST_FUNC;
1474 void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1475 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx) FAST_FUNC;
1476 void sha1_end(void *resbuf, sha1_ctx_t *ctx) FAST_FUNC;
1477 typedef struct sha1_ctx_t sha256_ctx_t;
1478 void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1479 #define sha256_hash sha1_hash
1480 #define sha256_end sha1_end
1481 typedef struct sha512_ctx_t {
1483 uint64_t total64[2];
1484 uint8_t wbuffer[128]; /* NB: always correctly aligned for uint64_t */
1486 void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1487 void sha512_hash(const void *buffer, size_t len, sha512_ctx_t *ctx) FAST_FUNC;
1488 void sha512_end(void *resbuf, sha512_ctx_t *ctx) FAST_FUNC;
1490 typedef struct md5_ctx_t {
1500 /* libbb/md5prime.c uses a bit different one: */
1501 typedef struct md5_ctx_t {
1502 uint32_t state[4]; /* state (ABCD) */
1503 uint32_t count[2]; /* number of bits, modulo 2^64 (lsb first) */
1504 unsigned char buffer[64]; /* input buffer */
1507 void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1508 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx) FAST_FUNC;
1509 void md5_end(void *resbuf, md5_ctx_t *ctx) FAST_FUNC;
1512 uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1514 typedef struct masks_labels_t {
1518 int print_flags_separated(const int *masks, const char *labels,
1519 int flags, const char *separator) FAST_FUNC;
1520 int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
1522 typedef struct bb_progress_t {
1524 unsigned lastupdate_sec;
1529 void bb_progress_init(bb_progress_t *p) FAST_FUNC;
1530 void bb_progress_update(bb_progress_t *p, const char *curfile,
1531 off_t beg_range, off_t transferred,
1532 off_t totalsize) FAST_FUNC;
1534 extern const char *applet_name;
1535 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1536 extern const char bb_banner[];
1537 extern const char bb_msg_memory_exhausted[];
1538 extern const char bb_msg_invalid_date[];
1539 extern const char bb_msg_read_error[];
1540 extern const char bb_msg_write_error[];
1541 extern const char bb_msg_unknown[];
1542 extern const char bb_msg_can_not_create_raw_socket[];
1543 extern const char bb_msg_perm_denied_are_you_root[];
1544 extern const char bb_msg_you_must_be_root[];
1545 extern const char bb_msg_requires_arg[];
1546 extern const char bb_msg_invalid_arg[];
1547 extern const char bb_msg_standard_input[];
1548 extern const char bb_msg_standard_output[];
1550 extern const char bb_str_default[];
1551 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1552 extern const char bb_hexdigits_upcase[];
1554 extern const char bb_path_mtab_file[];
1555 extern const char bb_path_passwd_file[];
1556 extern const char bb_path_shadow_file[];
1557 extern const char bb_path_gshadow_file[];
1558 extern const char bb_path_group_file[];
1559 extern const char bb_path_motd_file[];
1560 extern const char bb_path_wtmp_file[];
1561 extern const char bb_dev_null[];
1562 extern const char bb_busybox_exec_path[];
1563 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1564 * but I want to save a few bytes here */
1565 extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1566 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1567 #define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1569 extern const int const_int_0;
1570 extern const int const_int_1;
1573 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1574 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1575 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1576 /* This struct is deliberately not defined. */
1577 /* See docs/keep_data_small.txt */
1579 /* '*const' ptr makes gcc optimize code much better.
1580 * Magic prevents ptr_to_globals from going into rodata.
1581 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1582 extern struct globals *const ptr_to_globals;
1583 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1584 #define barrier() __asm__ __volatile__("":::"memory")
1585 #define SET_PTR_TO_GLOBALS(x) do { \
1586 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
1590 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1591 * use bb_default_login_shell and following defines.
1592 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1593 * don't forget to change increment constant. */
1594 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
1595 extern const char bb_default_login_shell[];
1597 #define DEFAULT_SHELL (bb_default_login_shell+1)
1599 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1601 #if ENABLE_FEATURE_DEVFS
1602 # define CURRENT_VC "/dev/vc/0"
1603 # define VC_1 "/dev/vc/1"
1604 # define VC_2 "/dev/vc/2"
1605 # define VC_3 "/dev/vc/3"
1606 # define VC_4 "/dev/vc/4"
1607 # define VC_5 "/dev/vc/5"
1608 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1609 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1610 respective serial ports .. as such, we can't use the common device paths for
1612 # define SC_0 "/dev/ttsc/0"
1613 # define SC_1 "/dev/ttsc/1"
1614 # define SC_FORMAT "/dev/ttsc/%d"
1616 # define SC_0 "/dev/tts/0"
1617 # define SC_1 "/dev/tts/1"
1618 # define SC_FORMAT "/dev/tts/%d"
1620 # define VC_FORMAT "/dev/vc/%d"
1621 # define LOOP_FORMAT "/dev/loop/%d"
1622 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1623 # define LOOP_NAME "/dev/loop/"
1624 # define FB_0 "/dev/fb/0"
1626 # define CURRENT_VC "/dev/tty0"
1627 # define VC_1 "/dev/tty1"
1628 # define VC_2 "/dev/tty2"
1629 # define VC_3 "/dev/tty3"
1630 # define VC_4 "/dev/tty4"
1631 # define VC_5 "/dev/tty5"
1632 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1633 # define SC_0 "/dev/ttySC0"
1634 # define SC_1 "/dev/ttySC1"
1635 # define SC_FORMAT "/dev/ttySC%d"
1637 # define SC_0 "/dev/ttyS0"
1638 # define SC_1 "/dev/ttyS1"
1639 # define SC_FORMAT "/dev/ttyS%d"
1641 # define VC_FORMAT "/dev/tty%d"
1642 # define LOOP_FORMAT "/dev/loop%d"
1643 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1644 # define LOOP_NAME "/dev/loop"
1645 # define FB_0 "/dev/fb0"
1648 /* The following devices are the same on devfs and non-devfs systems. */
1649 #define CURRENT_TTY "/dev/tty"
1650 #define DEV_CONSOLE "/dev/console"
1653 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1656 /* We redefine ctype macros. Unicode-correct handling of char types
1657 * can't be done with such byte-oriented operations anyway,
1658 * we don't lose anything.
1676 /* We save ~500 bytes on isdigit alone.
1677 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
1679 /* These work the same for ASCII and Unicode,
1680 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
1681 #define isascii(a) ((unsigned char)(a) <= 0x7f)
1682 #define isdigit(a) ((unsigned char)((a) - '0') <= 9)
1683 #define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1684 #define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
1685 #define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
1686 #define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1687 #define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
1688 /* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
1689 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
1691 #define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
1692 // Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1693 #define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1694 // Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
1695 #define isalnum(a) bb_ascii_isalnum(a)
1696 static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1698 unsigned char b = a - '0';
1702 return b <= 'z' - 'a';
1704 #define isxdigit(a) bb_ascii_isxdigit(a)
1705 static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1707 unsigned char b = a - '0';
1711 return b <= 'f' - 'a';
1713 #define toupper(a) bb_ascii_toupper(a)
1714 static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1716 unsigned char b = a - 'a';
1717 if (b <= ('z' - 'a'))
1721 #define tolower(a) bb_ascii_tolower(a)
1722 static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1724 unsigned char b = a - 'A';
1725 if (b <= ('Z' - 'A'))
1730 /* In ASCII and Unicode, these are likely to be very different.
1731 * Let's prevent ambiguous usage from the start */
1732 #define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1733 #define isprint(a) isprint_is_ambiguous_dont_use(a)
1734 /* NB: must not treat EOF as isgraph or isprint */
1735 #define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1736 #define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1739 POP_SAVED_FUNCTION_VISIBILITY