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.
30 #include <sys/ioctl.h>
32 #include <sys/socket.h>
35 #include <sys/types.h>
40 #include <sys/param.h>
44 #ifdef HAVE_SYS_STATFS_H
45 # include <sys/statfs.h>
48 # include <selinux/selinux.h>
49 # include <selinux/context.h>
50 # include <selinux/flask.h>
51 # include <selinux/av_permissions.h>
53 #if ENABLE_FEATURE_UTMP
56 #if ENABLE_LOCALE_SUPPORT
59 # define setlocale(x,y) ((void)0)
66 #if ENABLE_FEATURE_SHADOWPASSWDS
67 # if !ENABLE_USE_BB_SHADOW
68 /* If using busybox's shadow implementation, do not include the shadow.h
69 * header as the toolchain may not provide it at all.
74 /* Just in case libc doesn't define some of these... */
76 #define _PATH_PASSWD "/etc/passwd"
79 #define _PATH_GROUP "/etc/group"
82 #define _PATH_SHADOW "/etc/shadow"
85 #define _PATH_GSHADOW "/etc/gshadow"
87 #if defined __FreeBSD__ || defined __OpenBSD__
88 # include <netinet/in.h>
89 # include <arpa/inet.h>
90 #elif defined __APPLE__
91 # include <netinet/in.h>
93 # include <arpa/inet.h>
94 # if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
95 /* We #define socklen_t *after* includes, otherwise we get
96 * typedef redefinition errors from system headers
97 * (in case "is it defined already" detection above failed)
99 # define socklen_t bb_socklen_t
100 typedef unsigned socklen_t;
103 #ifndef HAVE_CLEARENV
104 # define clearenv() do { if (environ) environ[0] = NULL; } while (0)
106 #ifndef HAVE_FDATASYNC
107 # define fdatasync fsync
114 /* Some libc's forget to declare these, do it ourself */
116 extern char **environ;
117 #if defined(__GLIBC__) && __GLIBC__ < 2
118 int vdprintf(int d, const char *format, va_list ap);
120 /* klogctl is in libc's klog.h, but we cheat and not #include that */
121 int klogctl(int type, char *b, int len);
122 /* This is declared here rather than #including <libgen.h> in order to avoid
123 * confusing the two versions of basename. See the dirname/basename man page
125 #if !defined __FreeBSD__
126 char *dirname(char *path);
128 /* Include our own copy of struct sysinfo to avoid binary compatibility
129 * problems with Linux 2.4, which changed things. Grumble, grumble. */
131 long uptime; /* Seconds since boot */
132 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
133 unsigned long totalram; /* Total usable main memory size */
134 unsigned long freeram; /* Available memory size */
135 unsigned long sharedram; /* Amount of shared memory */
136 unsigned long bufferram; /* Memory used by buffers */
137 unsigned long totalswap; /* Total swap space size */
138 unsigned long freeswap; /* swap space still available */
139 unsigned short procs; /* Number of current processes */
140 unsigned short pad; /* Padding needed for m68k */
141 unsigned long totalhigh; /* Total high memory size */
142 unsigned long freehigh; /* Available high memory size */
143 unsigned int mem_unit; /* Memory unit size in bytes */
144 char _f[20 - 2 * sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
146 int sysinfo(struct sysinfo* info);
148 # define PATH_MAX 256
155 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
156 /* (don't include system headers after this until corresponding pop!) */
157 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
160 #if ENABLE_USE_BB_PWD_GRP
164 #if ENABLE_FEATURE_SHADOWPASSWDS
165 # if ENABLE_USE_BB_SHADOW
166 # include "shadow_.h"
170 /* Tested to work correctly with all int types (IIRC :]) */
171 #define MAXINT(T) (T)( \
174 : (T)~((T)1 << (sizeof(T)*8-1)) \
177 #define MININT(T) (T)( \
180 : ((T)1 << (sizeof(T)*8-1)) \
183 /* Large file support */
184 /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
185 * (stat, lseek etc) mapped to "largefile" variants by libc.
186 * Practically it means that open() automatically has O_LARGEFILE added
187 * and all filesize/file_offset parameters and struct members are "large"
188 * (in today's world - signed 64bit). For full support of large files,
189 * we need a few helper #defines (below) and careful use of off_t
190 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
192 /* CONFIG_LFS is on */
193 # if ULONG_MAX > 0xffffffff
194 /* "long" is long enough on this system */
195 typedef unsigned long uoff_t;
196 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
197 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
198 # define BB_STRTOOFF bb_strtoul
199 # define STRTOOFF strtoul
200 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
203 /* "long" is too short, need "long long" */
204 typedef unsigned long long uoff_t;
205 # define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
206 # define BB_STRTOOFF bb_strtoull
207 # define STRTOOFF strtoull
208 # define OFF_FMT "ll"
211 /* CONFIG_LFS is off */
212 # if UINT_MAX == 0xffffffff
213 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
214 * gcc will throw warnings on printf("%d", off_t). Crap... */
215 typedef unsigned long uoff_t;
216 # define XATOOFF(a) xatoi_positive(a)
217 # define BB_STRTOOFF bb_strtou
218 # define STRTOOFF strtol
221 typedef unsigned long uoff_t;
222 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
223 # define BB_STRTOOFF bb_strtoul
224 # define STRTOOFF strtol
228 /* scary. better ideas? (but do *test* them first!) */
229 #define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
231 /* Some useful definitions */
233 #define FALSE ((int) 0)
235 #define TRUE ((int) 1)
237 #define SKIP ((int) 2)
240 #define MTAB_GETMOUNTPT '1'
241 #define MTAB_GETDEVICE '2'
243 #define BUF_SIZE 8192
244 #define EXPAND_ALLOC 1024
246 /* Macros for min/max. */
248 #define MIN(a,b) (((a)<(b))?(a):(b))
252 #define MAX(a,b) (((a)>(b))?(a):(b))
255 /* buffer allocation schemes */
256 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
257 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
258 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
259 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
261 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
262 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
263 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
264 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
266 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
267 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
268 #define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
272 #if defined(__GLIBC__)
273 /* glibc uses __errno_location() to get a ptr to errno */
274 /* We can just memorize it once - no multithreading in busybox :) */
275 extern int *const bb_errno;
277 #define errno (*bb_errno)
280 #if !(ULONG_MAX > 0xffffffff)
281 /* Only 32-bit CPUs need this, 64-bit ones use inlined version */
282 uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
285 unsigned long long monotonic_ns(void) FAST_FUNC;
286 unsigned long long monotonic_us(void) FAST_FUNC;
287 unsigned long long monotonic_ms(void) FAST_FUNC;
288 unsigned monotonic_sec(void) FAST_FUNC;
290 extern void chomp(char *s) FAST_FUNC;
291 extern void trim(char *s) FAST_FUNC;
292 extern char *skip_whitespace(const char *) FAST_FUNC;
293 extern char *skip_non_whitespace(const char *) FAST_FUNC;
294 extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
296 extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
298 //TODO: supply a pointer to char[11] buffer (avoid statics)?
299 extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
300 extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
301 enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
302 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
303 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
304 FILEUTILS_RECUR = 1 << 2, /* -R */
305 FILEUTILS_FORCE = 1 << 3, /* -f */
306 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
307 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
308 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
309 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
310 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
312 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
313 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
316 #define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
317 extern int remove_file(const char *path, int flags) FAST_FUNC;
318 /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
319 * the source, not copy (unless "source" is a directory).
320 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
321 * work coreutils-compatibly. */
322 extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
325 ACTION_RECURSE = (1 << 0),
326 ACTION_FOLLOWLINKS = (1 << 1),
327 ACTION_FOLLOWLINKS_L0 = (1 << 2),
328 ACTION_DEPTHFIRST = (1 << 3),
329 /*ACTION_REVERSE = (1 << 4), - unused */
330 ACTION_QUIET = (1 << 5),
331 ACTION_DANGLING_OK = (1 << 6),
333 typedef uint8_t recurse_flags_t;
334 extern int recursive_action(const char *fileName, unsigned flags,
335 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
336 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
337 void* userData, unsigned depth) FAST_FUNC;
338 extern int device_open(const char *device, int mode) FAST_FUNC;
339 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
340 extern int xgetpty(char *line) FAST_FUNC;
341 extern int get_console_fd_or_die(void) FAST_FUNC;
342 extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
343 extern char *find_block_device(const char *path) FAST_FUNC;
344 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
345 extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
346 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
347 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
348 /* "short" copy can be detected by return value < size */
349 /* this helper yells "short read!" if param is not -1 */
350 extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
351 extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
352 char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
353 /* xxxx_strip version can modify its parameter:
357 * "abc/def/" -> "def" !!
359 extern char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
360 /* "abc/def/" -> "" and it never modifies 'path' */
361 extern char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
363 void ndelay_on(int fd) FAST_FUNC;
364 void ndelay_off(int fd) FAST_FUNC;
365 void close_on_exec_on(int fd) FAST_FUNC;
366 void xdup2(int, int) FAST_FUNC;
367 void xmove_fd(int, int) FAST_FUNC;
370 DIR *xopendir(const char *path) FAST_FUNC;
371 DIR *warn_opendir(const char *path) FAST_FUNC;
373 char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
374 char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
375 char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
376 /* !RETURNS_MALLOC: it's a realloc-like function */
377 char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
379 char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
383 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
384 * otherwise would kill us, except for those resulting from bugs:
385 * SIGSEGV, SIGILL, SIGFPE.
386 * Other fatal signals not included (TODO?):
387 * SIGBUS Bus error (bad memory access)
388 * SIGPOLL Pollable event. Synonym of SIGIO
389 * SIGPROF Profiling timer expired
390 * SIGSYS Bad argument to routine
391 * SIGTRAP Trace/breakpoint trap
393 * The only known arch with some of these sigs not fitting
394 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
395 * Dance around with long long to guard against that...
397 BB_FATAL_SIGS = (int)(0
401 + (1LL << SIGPIPE) // Write to pipe with no readers
402 + (1LL << SIGQUIT) // Quit from keyboard
403 + (1LL << SIGABRT) // Abort signal from abort(3)
404 + (1LL << SIGALRM) // Timer signal from alarm(2)
405 + (1LL << SIGVTALRM) // Virtual alarm clock
406 + (1LL << SIGXCPU) // CPU time limit exceeded
407 + (1LL << SIGXFSZ) // File size limit exceeded
408 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
412 void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
413 /* Unlike signal() and bb_signals, sets handler with sigaction()
414 * and in a way that while signal handler is run, no other signals
415 * will be blocked; syscalls will not be restarted: */
416 void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
417 /* syscalls like read() will be interrupted with EINTR: */
418 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
419 /* syscalls like read() won't be interrupted (though select/poll will be): */
420 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
421 void wait_for_any_sig(void) FAST_FUNC;
422 void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
423 void sig_block(int sig) FAST_FUNC;
424 void sig_unblock(int sig) FAST_FUNC;
425 /* Will do sigaction(signum, act, NULL): */
426 int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
427 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
428 int sigprocmask_allsigs(int how) FAST_FUNC;
429 /* Standard handler which just records signo */
430 extern smallint bb_got_signal;
431 void record_signo(int signo); /* not FAST_FUNC! */
434 void xsetgid(gid_t gid) FAST_FUNC;
435 void xsetuid(uid_t uid) FAST_FUNC;
436 void xchdir(const char *path) FAST_FUNC;
437 void xchroot(const char *path) FAST_FUNC;
438 void xsetenv(const char *key, const char *value) FAST_FUNC;
439 void bb_unsetenv(const char *key) FAST_FUNC;
440 void bb_unsetenv_and_free(char *key) FAST_FUNC;
441 void xunlink(const char *pathname) FAST_FUNC;
442 void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
443 void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
444 int xopen(const char *pathname, int flags) FAST_FUNC;
445 int xopen_nonblocking(const char *pathname) FAST_FUNC;
446 int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
447 int open_or_warn(const char *pathname, int flags) FAST_FUNC;
448 int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
449 int open_or_warn_stdin(const char *pathname) FAST_FUNC;
450 int xopen_stdin(const char *pathname) FAST_FUNC;
451 void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
452 int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
453 off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
454 int xmkstemp(char *template) FAST_FUNC;
455 off_t fdlength(int fd) FAST_FUNC;
457 uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
458 const char *override,
459 unsigned override_units,
462 void xpipe(int filedes[2]) FAST_FUNC;
463 /* In this form code with pipes is much more readable */
464 struct fd_pair { int rd; int wr; };
465 #define piped_pair(pair) pipe(&((pair).rd))
466 #define xpiped_pair(pair) xpipe(&((pair).rd))
468 /* Useful for having small structure members/global variables */
469 typedef int8_t socktype_t;
470 typedef int8_t family_t;
471 struct BUG_too_small {
472 char BUG_socktype_t_too_small[(0
479 char BUG_family_t_too_small[(0
496 void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
497 time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
500 int xsocket(int domain, int type, int protocol) FAST_FUNC;
501 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
502 void xlisten(int s, int backlog) FAST_FUNC;
503 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
504 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
505 socklen_t tolen) FAST_FUNC;
506 /* SO_REUSEADDR allows a server to rebind to an address that is already
507 * "in use" by old connections to e.g. previous server instance which is
508 * killed or crashed. Without it bind will fail until all such connections
509 * time out. Linux does not allow multiple live binds on same ip:port
510 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
511 * Turn it on before you call bind(). */
512 void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
513 int setsockopt_broadcast(int fd) FAST_FUNC;
514 int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
515 /* NB: returns port in host byte order */
516 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
517 typedef struct len_and_sockaddr {
521 struct sockaddr_in sin;
522 #if ENABLE_FEATURE_IPV6
523 struct sockaddr_in6 sin6;
528 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
529 LSA_SIZEOF_SA = sizeof(
532 struct sockaddr_in sin;
533 #if ENABLE_FEATURE_IPV6
534 struct sockaddr_in6 sin6;
539 /* Create stream socket, and allocate suitable lsa.
540 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
541 * af == AF_UNSPEC will result in trying to create IPv6 socket,
542 * and if kernel doesn't support it, fall back to IPv4.
543 * This is useful if you plan to bind to resulting local lsa.
545 #if ENABLE_FEATURE_IPV6
546 int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
548 int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
549 #define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
551 int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
552 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
553 * numeric IP ("N.N.N.N") or numeric IPv6 address,
554 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
555 * Only if there is no suffix, port argument is used */
556 /* NB: these set SO_REUSEADDR before bind */
557 int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
558 int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
559 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
560 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
561 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
562 * If there is no suffix, port argument is used */
563 int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
564 /* Connect to peer identified by lsa */
565 int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
566 /* Get local address of bound or accepted socket */
567 len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
568 /* Get remote address of connected or accepted socket */
569 len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
570 /* Return malloc'ed len_and_sockaddr with socket address of host:port
571 * Currently will return IPv4 or IPv6 sockaddrs only
572 * (depending on host), but in theory nothing prevents e.g.
573 * UNIX socket address being returned, IPX sockaddr etc...
574 * On error does bb_error_msg and returns NULL */
575 len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
576 /* Version which dies on error */
577 len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
578 len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
579 /* Same, useful if you want to force family (e.g. IPv6) */
580 #if !ENABLE_FEATURE_IPV6
581 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
582 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
584 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
585 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
587 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
588 * otherwise no-op. Useful for ftp.
589 * NB: does NOT do htons() internally, just direct assignment. */
590 void set_nport(len_and_sockaddr *lsa, unsigned port) FAST_FUNC;
591 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
592 int get_nport(const struct sockaddr *sa) FAST_FUNC;
593 /* Reverse DNS. Returns NULL on failure. */
594 char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
595 /* This one doesn't append :PORTNUM */
596 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
597 /* This one also doesn't fall back to dotted IP (returns NULL) */
598 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
599 /* inet_[ap]ton on steroids */
600 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
601 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
602 // "old" (ipv4 only) API
603 // users: traceroute.c hostname.c - use _list_ of all IPs
604 struct hostent *xgethostbyname(const char *name) FAST_FUNC;
605 // Also mount.c and inetd.c are using gethostbyname(),
606 // + inet_common.c has additional IPv4-only stuff
609 void socket_want_pktinfo(int fd) FAST_FUNC;
610 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
611 const struct sockaddr *to,
612 const struct sockaddr *from,
613 socklen_t tolen) FAST_FUNC;
614 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
615 struct sockaddr *from,
617 socklen_t sa_size) FAST_FUNC;
620 char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
621 char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
622 void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
623 char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
624 char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
625 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
626 * But potentially slow, don't use in one-billion-times loops */
627 int bb_putchar(int ch) FAST_FUNC;
628 /* Note: does not use stdio, writes to fd 2 directly */
629 int bb_putchar_stderr(char ch) FAST_FUNC;
630 char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
631 // gcc-4.1.1 still isn't good enough at optimizing it
632 // (+200 bytes compared to macro)
633 //static ALWAYS_INLINE
634 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
635 //static ALWAYS_INLINE
636 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
637 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
638 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
639 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
640 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
641 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
643 typedef struct uni_stat_t {
645 unsigned unicode_count;
646 unsigned unicode_width;
648 /* Returns a string with unprintable chars replaced by '?' or
649 * SUBST_WCHAR. This function is unicode-aware. */
650 const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
651 /* Prints unprintable char ch as ^C or M-c to file
652 * (M-c is used only if ch is ORed with PRINTABLE_META),
653 * else it is printed as-is (except for ch = 0x9b) */
654 enum { PRINTABLE_META = 0x100 };
655 void fputc_printable(int ch, FILE *file) FAST_FUNC;
657 /* dmalloc will redefine these to it's own implementation. It is safe
658 * to have the prototypes here unconditionally. */
659 void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
660 void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
661 void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
662 void *xrealloc(void *old, size_t size) FAST_FUNC;
663 /* After xrealloc_vector(v, 4, idx) it's ok to use
664 * at least v[idx] and v[idx+1], for all idx values.
665 * shift specifies how many new elements are added (1: 2, 2: 4... 8: 256...)
666 * when all elements are used up. New elements are zeroed out. */
667 #define xrealloc_vector(vector, shift, idx) \
668 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
669 void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
672 extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
673 extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count) FAST_FUNC;
674 // NB: will return short read on error, not -1,
675 // if some data was read before error occurred
676 extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
677 extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
678 extern unsigned char xread_char(int fd) FAST_FUNC;
679 extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
680 extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
681 // Reads one line a-la fgets (but doesn't save terminating '\n').
682 // Reads byte-by-byte. Useful when it is important to not read ahead.
683 // Bytes are appended to pfx (which must be malloced, or NULL).
684 extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p) FAST_FUNC;
685 /* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
686 extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
687 /* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
688 extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
689 /* Never returns NULL */
690 extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
691 /* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
692 #if ENABLE_FEATURE_SEAMLESS_LZMA \
693 || ENABLE_FEATURE_SEAMLESS_BZ2 \
694 || ENABLE_FEATURE_SEAMLESS_GZ \
695 /* || ENABLE_FEATURE_SEAMLESS_Z */
696 extern void setup_unzip_on_fd(int fd /*, int fail_if_not_detected*/) FAST_FUNC;
698 # define setup_unzip_on_fd(...) ((void)0)
700 /* Autodetects .gz etc */
701 extern int open_zipped(const char *fname) FAST_FUNC;
702 extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
704 extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
705 // NB: will return short write on error, not -1,
706 // if some data was written before error occurred
707 extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
708 extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
709 extern void xwrite_str(int fd, const char *str) FAST_FUNC;
710 extern ssize_t full_write1_str(const char *str) FAST_FUNC;
711 extern ssize_t full_write2_str(const char *str) FAST_FUNC;
712 extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
714 /* Close fd, but check for failures (some types of write errors) */
715 extern void xclose(int fd) FAST_FUNC;
717 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
718 extern void xprint_and_close_file(FILE *file) FAST_FUNC;
720 extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
721 extern char *bb_get_chunk_with_continuation(FILE *file, int *end, int *lineno) FAST_FUNC;
722 /* Reads up to (and including) TERMINATING_STRING: */
723 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
724 /* Same, with limited max size, and returns the length (excluding NUL): */
725 extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
726 /* Chops off TERMINATING_STRING from the end: */
727 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
728 /* Reads up to (and including) "\n" or NUL byte: */
729 extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
730 /* Chops off '\n' from the end, unlike fgets: */
731 extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
732 /* Same, but doesn't try to conserve space (may have some slack after the end) */
733 /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
735 void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
736 void die_if_ferror_stdout(void) FAST_FUNC;
737 int fflush_all(void) FAST_FUNC;
738 void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
739 int fclose_if_not_stdin(FILE *file) FAST_FUNC;
740 FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
741 /* Prints warning to stderr and returns NULL on failure: */
742 FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
743 /* "Opens" stdin if filename is special, else just opens file: */
744 FILE* xfopen_stdin(const char *filename) FAST_FUNC;
745 FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
746 FILE* fopen_for_read(const char *path) FAST_FUNC;
747 FILE* xfopen_for_read(const char *path) FAST_FUNC;
748 FILE* fopen_for_write(const char *path) FAST_FUNC;
749 FILE* xfopen_for_write(const char *path) FAST_FUNC;
750 FILE* xfdopen_for_read(int fd) FAST_FUNC;
751 FILE* xfdopen_for_write(int fd) FAST_FUNC;
753 int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
754 void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
756 /* Wrapper which restarts poll on EINTR or ENOMEM.
757 * On other errors complains [perror("poll")] and returns.
758 * Warning! May take (much) longer than timeout_ms to return!
759 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
760 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
762 char *safe_gethostname(void) FAST_FUNC;
763 char *safe_getdomainname(void) FAST_FUNC;
765 /* Convert each alpha char in str to lower-case */
766 char* str_tolower(char *str) FAST_FUNC;
768 char *utoa(unsigned n) FAST_FUNC;
769 char *itoa(int n) FAST_FUNC;
770 /* Returns a pointer past the formatted number, does NOT null-terminate */
771 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
772 char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
773 /* Intelligent formatters of bignums */
774 void smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
775 void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
776 /* If block_size == 0, display size without fractional part,
777 * else display (size * block_size) with one decimal digit.
778 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
779 * else divide by display_unit and do not use suffix. */
780 #define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
781 #define HUMAN_READABLE_MAX_WIDTH_STR "7"
782 //TODO: provide pointer to buf (avoid statics)?
783 const char *make_human_readable_str(unsigned long long size,
784 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
785 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
786 char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
788 char* hex2bin(char *dst, const char *str, int count) FAST_FUNC;
790 /* Generate a UUID */
791 void generate_uuid(uint8_t *buf) FAST_FUNC;
793 /* Last element is marked by mult == 0 */
801 /* Using xatoi() instead of naive atoi() is not always convenient -
802 * in many places people want *non-negative* values, but store them
803 * in signed int. Therefore we need this one:
804 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
805 * It should really be named xatoi_nonnegative (since it allows 0),
806 * but that would be too long.
808 int xatoi_positive(const char *numstr) FAST_FUNC;
810 /* Useful for reading port numbers */
811 uint16_t xatou16(const char *numstr) FAST_FUNC;
814 /* These parse entries in /etc/passwd and /etc/group. This is desirable
815 * for BusyBox since we want to avoid using the glibc NSS stuff, which
816 * increases target size and is often not needed on embedded systems. */
817 long xuname2uid(const char *name) FAST_FUNC;
818 long xgroup2gid(const char *name) FAST_FUNC;
819 /* wrapper: allows string to contain numeric uid or gid */
820 unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
821 /* from chpst. Does not die, returns 0 on failure */
826 /* always sets uid and gid */
827 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
828 /* always sets uid and gid, allows numeric; exits on failure */
829 void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
830 /* chown-like handling of "user[:[group]" */
831 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
832 struct passwd* xgetpwnam(const char *name) FAST_FUNC;
833 struct group* xgetgrnam(const char *name) FAST_FUNC;
834 struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
835 struct group* xgetgrgid(gid_t gid) FAST_FUNC;
836 char* xuid2uname(uid_t uid) FAST_FUNC;
837 char* xgid2group(gid_t gid) FAST_FUNC;
838 char* uid2uname(uid_t uid) FAST_FUNC;
839 char* gid2group(gid_t gid) FAST_FUNC;
840 char* uid2uname_utoa(long uid) FAST_FUNC;
841 char* gid2group_utoa(long gid) FAST_FUNC;
842 /* versions which cache results (useful for ps, ls etc) */
843 const char* get_cached_username(uid_t uid) FAST_FUNC;
844 const char* get_cached_groupname(gid_t gid) FAST_FUNC;
845 void clear_username_cache(void) FAST_FUNC;
846 /* internally usernames are saved in fixed-sized char[] buffers */
847 enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
848 #if ENABLE_FEATURE_CHECK_NAMES
849 void die_if_bad_username(const char* name) FAST_FUNC;
851 #define die_if_bad_username(name) ((void)(name))
854 #if ENABLE_FEATURE_UTMP
855 void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
856 void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
858 # define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
859 # define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
862 int execable_file(const char *name) FAST_FUNC;
863 char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
864 int exists_execable(const char *filename) FAST_FUNC;
866 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
867 * but it may exec busybox and call applet instead of searching PATH.
869 #if ENABLE_FEATURE_PREFER_APPLETS
870 int bb_execvp(const char *file, char *const argv[]) FAST_FUNC;
871 #define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
872 #define BB_EXECLP(prog,cmd,...) \
873 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
876 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
877 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
879 int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
881 /* xvfork() can't be a _function_, return after vfork mangles stack
882 * in the parent. It must be a macro. */
885 pid_t bb__xvfork_pid = vfork(); \
886 if (bb__xvfork_pid < 0) \
887 bb_perror_msg_and_die("vfork"); \
891 pid_t xfork(void) FAST_FUNC;
894 /* NOMMU friendy fork+exec: */
895 pid_t spawn(char **argv) FAST_FUNC;
896 pid_t xspawn(char **argv) FAST_FUNC;
898 pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
899 pid_t wait_any_nohang(int *wstat) FAST_FUNC;
900 /* wait4pid: unlike waitpid, waits ONLY for one process.
901 * Returns sig + 0x180 if child is killed by signal.
902 * It's safe to pass negative 'pids' from failed [v]fork -
903 * wait4pid will return -1 (and will not clobber [v]fork's errno).
904 * IOW: rc = wait4pid(spawn(argv));
905 * if (rc < 0) bb_perror_msg("%s", argv[0]);
906 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
908 int wait4pid(pid_t pid) FAST_FUNC;
909 /* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
910 int spawn_and_wait(char **argv) FAST_FUNC;
911 struct nofork_save_area {
913 const char *applet_name;
914 uint32_t option_mask32;
916 uint8_t xfunc_error_retval;
919 void save_nofork_data(struct nofork_save_area *save) FAST_FUNC;
920 void restore_nofork_data(struct nofork_save_area *save) FAST_FUNC;
921 /* Does NOT check that applet is NOFORK, just blindly runs it */
922 int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
923 int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv) FAST_FUNC;
925 /* Helpers for daemonization.
927 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
929 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
930 * rexec's itself on NOMMU with argv passed as command line.
931 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
932 * from the start. (It will detect it and not reexec again second time).
933 * You have to audit carefully that you don't do something twice as a result
934 * (opening files/sockets, parsing config files etc...)!
936 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
937 * (will do setsid()).
939 * fork_or_rexec(argv) = bare-bones fork on MMU,
940 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
941 * On MMU ignores argv.
943 * Helper for network daemons in foreground mode:
945 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
946 * to /dev/null if they are not.
949 DAEMON_CHDIR_ROOT = 1,
950 DAEMON_DEVNULL_STDIO = 2,
951 DAEMON_CLOSE_EXTRA_FDS = 4,
952 DAEMON_ONLY_SANITIZE = 8, /* internal use */
955 enum { re_execed = 0 };
956 # define fork_or_rexec(argv) xfork()
957 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
958 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
960 extern bool re_execed;
961 void re_exec(char **argv) NORETURN FAST_FUNC;
962 pid_t fork_or_rexec(char **argv) FAST_FUNC;
963 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
964 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
965 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
966 # define fork() BUG_fork_is_unavailable_on_nommu()
967 # define xfork() BUG_fork_is_unavailable_on_nommu()
968 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
969 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
971 void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
972 void bb_sanitize_stdio(void) FAST_FUNC;
973 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
974 int sanitize_env_if_suid(void) FAST_FUNC;
977 char* single_argv(char **argv) FAST_FUNC;
978 extern const char *const bb_argv_dash[]; /* "-", NULL */
979 extern const char *opt_complementary;
980 #if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
981 #define No_argument "\0"
982 #define Required_argument "\001"
983 #define Optional_argument "\002"
984 extern const char *applet_long_options;
986 extern uint32_t option_mask32;
987 extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
990 typedef struct llist_t {
992 struct llist_t *link;
994 void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
995 void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
996 void *llist_pop(llist_t **elm) FAST_FUNC;
997 void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
998 void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
999 llist_t *llist_rev(llist_t *list) FAST_FUNC;
1000 llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
1001 /* BTW, surprisingly, changing API to
1002 * llist_t *llist_add_to(llist_t *old_head, void *data)
1003 * etc does not result in smaller code... */
1005 /* start_stop_daemon and udhcpc are special - they want
1006 * to create pidfiles regardless of FEATURE_PIDFILE */
1007 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
1008 /* True only if we created pidfile which is *file*, not /dev/null etc */
1009 extern smallint wrote_pidfile;
1010 void write_pidfile(const char *path) FAST_FUNC;
1011 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
1013 enum { wrote_pidfile = 0 };
1014 #define write_pidfile(path) ((void)0)
1015 #define remove_pidfile(path) ((void)0)
1020 LOGMODE_STDIO = (1 << 0),
1021 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
1022 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1024 extern const char *msg_eol;
1025 extern smallint logmode;
1026 extern int die_sleep;
1027 extern uint8_t xfunc_error_retval;
1028 extern jmp_buf die_jmp;
1029 extern void xfunc_die(void) NORETURN FAST_FUNC;
1030 extern void bb_show_usage(void) NORETURN FAST_FUNC;
1031 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1032 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1033 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1034 extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1035 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1036 extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
1037 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1038 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1039 extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
1040 extern void bb_perror_nomsg(void) FAST_FUNC;
1041 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1042 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
1044 /* We need to export XXX_main from libbusybox
1045 * only if we build "individual" binaries
1047 #if ENABLE_FEATURE_INDIVIDUAL
1048 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1050 #define MAIN_EXTERNALLY_VISIBLE
1054 /* Applets which are useful from another applets */
1055 int bb_cat(char** argv);
1056 /* If shell needs them, they exist even if not enabled as applets */
1057 int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1058 int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1059 int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1060 int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
1061 /* Similar, but used by chgrp, not shell */
1062 int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
1064 int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1065 /* Don't need IF_xxx() guard for these */
1066 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1067 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1070 void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
1075 int create_icmp_socket(void) FAST_FUNC;
1076 int create_icmp6_socket(void) FAST_FUNC;
1078 /* This structure defines protocol families and their handlers. */
1084 char* FAST_FUNC (*print)(unsigned char *);
1085 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1086 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1087 void FAST_FUNC (*herror)(char *text);
1088 int FAST_FUNC (*rprint)(int options);
1089 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
1090 /* may modify src */
1091 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
1093 /* This structure defines hardware protocols and their handlers. */
1099 char* FAST_FUNC (*print)(unsigned char *);
1100 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1101 int FAST_FUNC (*activate)(int fd);
1102 int suppress_null_addr;
1104 extern smallint interface_opt_a;
1105 int display_interfaces(char *ifname) FAST_FUNC;
1106 #if ENABLE_FEATURE_HWIB
1107 int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
1109 #define in_ib(a, b) 1 /* fail */
1111 const struct aftype *get_aftype(const char *name) FAST_FUNC;
1112 const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1113 const struct hwtype *get_hwntype(int type) FAST_FUNC;
1116 #ifndef BUILD_INDIVIDUAL
1117 extern int find_applet_by_name(const char *name) FAST_FUNC;
1118 /* Returns only if applet is not found. */
1119 extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
1120 extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
1123 #ifdef HAVE_MNTENT_H
1124 extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
1125 extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
1127 extern void erase_mtab(const char * name) FAST_FUNC;
1128 extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1129 extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1131 extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1133 # define bb_warn_ignoring_args(arg) ((void)0)
1136 extern int get_linux_version_code(void) FAST_FUNC;
1138 extern char *query_loop(const char *device) FAST_FUNC;
1139 extern int del_loop(const char *device) FAST_FUNC;
1140 /* If *devname is not NULL, use that name, otherwise try to find free one,
1141 * malloc and return it in *devname.
1142 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
1143 extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
1145 /* Like bb_ask below, but asks on stdin with no timeout. */
1146 char *bb_ask_stdin(const char * prompt) FAST_FUNC;
1147 //TODO: pass buf pointer or return allocated buf (avoid statics)?
1148 char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
1149 int bb_ask_confirmation(void) FAST_FUNC;
1151 int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
1154 * Config file parser
1157 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1158 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1159 // TODO: COLLAPSE and TRIM seem to always go in pair
1160 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1161 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
1162 // keep a copy of current line
1163 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
1164 // PARSE_ESCAPE = 0x00400000, // process escape sequences in tokens
1166 // * remove leading and trailing delimiters and collapse
1167 // multiple delimiters into one
1168 // * warn and continue if less than mintokens delimiters found
1169 // * grab everything into last token
1170 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
1172 typedef struct parser_t {
1178 parser_t* config_open(const char *filename) FAST_FUNC;
1179 parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
1180 /* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
1181 int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1182 #define config_read(parser, tokens, max, min, str, flags) \
1183 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1184 void config_close(parser_t *parser) FAST_FUNC;
1186 /* Concatenate path and filename to new allocated buffer.
1187 * Add "/" only as needed (no duplicate "//" are produced).
1188 * If path is NULL, it is assumed to be "/".
1189 * filename should not be NULL. */
1190 char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1191 char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1192 const char *bb_basename(const char *name) FAST_FUNC;
1193 /* NB: can violate const-ness (similarly to strchr) */
1194 char *last_char_is(const char *s, int c) FAST_FUNC;
1197 int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1199 int get_signum(const char *name) FAST_FUNC;
1200 const char *get_signame(int number) FAST_FUNC;
1201 void print_signames(void) FAST_FUNC;
1203 char *bb_simplify_path(const char *path) FAST_FUNC;
1204 /* Returns ptr to NUL */
1205 char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
1207 #define FAIL_DELAY 3
1208 extern void bb_do_delay(int seconds) FAST_FUNC;
1209 extern void change_identity(const struct passwd *pw) FAST_FUNC;
1210 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
1212 extern void renew_current_security_context(void) FAST_FUNC;
1213 extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1214 extern context_t set_security_context_component(security_context_t cur_context,
1215 char *user, char *role, char *type, char *range) FAST_FUNC;
1216 extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1217 extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1219 #define selinux_preserve_fcontext(fdesc) ((void)0)
1221 extern void selinux_or_die(void) FAST_FUNC;
1224 /* systemd support */
1225 #define SD_LISTEN_FDS_START 3
1226 int sd_listen_fds(void);
1229 /* setup_environment:
1230 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
1231 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1233 * USER=pw->pw_name, LOGNAME=pw->pw_name
1234 * PATH=bb_default_[root_]path
1237 * else if change_env = 1:
1238 * if not root (if pw->pw_uid != 0):
1239 * USER=pw->pw_name, LOGNAME=pw->pw_name
1244 #define SETUP_ENV_CHANGEENV (1 << 0)
1245 #define SETUP_ENV_CLEARENV (1 << 1)
1246 #define SETUP_ENV_TO_TMP (1 << 2)
1247 extern void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1248 extern int correct_password(const struct passwd *pw) FAST_FUNC;
1249 /* Returns a malloced string */
1250 #if !ENABLE_USE_BB_CRYPT
1251 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1253 extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1254 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1255 /* rnd is additional random input. New one is returned.
1256 * Useful if you call crypt_make_salt many times in a row:
1257 * rnd = crypt_make_salt(buf1, 4, 0);
1258 * rnd = crypt_make_salt(buf2, 4, rnd);
1259 * rnd = crypt_make_salt(buf3, 4, rnd);
1260 * (otherwise we risk having same salt generated)
1262 extern int crypt_make_salt(char *p, int cnt, int rnd) FAST_FUNC;
1264 /* Returns number of lines changed, or -1 on error */
1265 #if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1266 #define update_passwd(filename, username, data, member) \
1267 update_passwd(filename, username, data)
1269 extern int update_passwd(const char *filename,
1270 const char *username,
1272 const char *member) FAST_FUNC;
1274 int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1275 int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1276 int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1277 int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1278 const char *nth_string(const char *strings, int n) FAST_FUNC;
1280 extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1281 extern void print_login_prompt(void) FAST_FUNC;
1283 char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
1284 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1285 int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1287 int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1289 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1290 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1291 int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1292 #if ENABLE_IOCTL_HEX2STR_ERROR
1293 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1294 int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1295 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1296 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1298 int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1299 int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1300 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1301 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1304 char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1305 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1306 void reset_ino_dev_hashtable(void) FAST_FUNC;
1308 /* At least glibc has horrendously large inline for this, so wrap it */
1309 unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
1311 #define makedev(a,b) bb_makedev(a,b)
1315 /* "Keycodes" that report an escape sequence.
1316 * We use something which fits into signed char,
1317 * yet doesn't represent any valid Unicode character.
1318 * Also, -1 is reserved for error indication and we don't use it. */
1326 KEYCODE_INSERT = -8,
1327 KEYCODE_DELETE = -9,
1328 KEYCODE_PAGEUP = -10,
1329 KEYCODE_PAGEDOWN = -11,
1331 KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1332 KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
1333 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1334 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
1345 KEYCODE_FUN10 = -21,
1346 KEYCODE_FUN11 = -22,
1347 KEYCODE_FUN12 = -23,
1349 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
1350 /* How long is the longest ESC sequence we know?
1351 * We want it big enough to be able to contain
1352 * cursor position sequence "ESC [ 9999 ; 9999 R"
1354 KEYCODE_BUFFER_SIZE = 16
1356 /* Note: fd may be in blocking or non-blocking mode, both make sense.
1357 * For one, less uses non-blocking mode.
1358 * Only the first read syscall inside read_key may block indefinitely
1359 * (unless fd is in non-blocking mode),
1360 * subsequent reads will time out after a few milliseconds.
1361 * Return of -1 means EOF or error (errno == 0 on EOF).
1362 * buffer[0] is used as a counter of buffered chars and must be 0
1365 * -2: do not poll for input;
1366 * -1: poll(-1) (i.e. block);
1367 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
1369 int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
1370 void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
1373 #if ENABLE_FEATURE_EDITING
1374 /* It's NOT just ENABLEd or disabled. It's a number: */
1375 # ifdef CONFIG_FEATURE_EDITING_HISTORY
1376 # define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1378 # define MAX_HISTORY 0
1380 typedef struct line_input_t {
1382 const char *path_lookup;
1386 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1387 unsigned cnt_history_in_file;
1388 const char *hist_file;
1390 char *history[MAX_HISTORY + 1];
1394 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1395 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1396 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1397 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1398 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
1399 WITH_PATH_LOOKUP = 0x20,
1400 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1402 line_input_t *new_line_input_t(int flags) FAST_FUNC;
1403 /* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1404 /* maxsize must be >= 2.
1406 * -1 on read errors or EOF, or on bare Ctrl-D,
1407 * 0 on ctrl-C (the line entered is still returned in 'command'),
1408 * >0 length of input string, including terminating '\n'
1410 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state) FAST_FUNC;
1412 #define MAX_HISTORY 0
1413 int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1414 #define read_line_input(prompt, command, maxsize, state) \
1415 read_line_input(prompt, command, maxsize)
1420 # ifdef TASK_COMM_LEN
1421 enum { COMM_LEN = TASK_COMM_LEN };
1423 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1424 enum { COMM_LEN = 16 };
1429 unsigned long mapped_rw;
1430 unsigned long mapped_ro;
1431 unsigned long shared_clean;
1432 unsigned long shared_dirty;
1433 unsigned long private_clean;
1434 unsigned long private_dirty;
1435 unsigned long stack;
1436 unsigned long smap_pss, smap_swap;
1437 unsigned long smap_size;
1438 unsigned long smap_start;
1444 #define procps_read_smaps(pid, total, cb, data) \
1445 procps_read_smaps(pid, total)
1447 int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1448 void (*cb)(struct smaprec *, void *), void *data);
1450 typedef struct procps_status_t {
1452 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
1453 uint8_t shift_pages_to_bytes;
1454 uint8_t shift_pages_to_kb;
1455 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1459 IF_SELINUX(char *context;)
1460 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
1461 /* Everything below must contain no ptrs to malloc'ed data:
1462 * it is memset(0) for each process in procps_scan() */
1463 unsigned long vsz, rss; /* we round it to kbytes */
1464 unsigned long stime, utime;
1465 unsigned long start_time;
1472 #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1477 unsigned tty_major,tty_minor;
1478 #if ENABLE_FEATURE_TOPMEM
1479 struct smaprec smaps;
1482 /* basename of executable in exec(2), read from /proc/N/stat
1483 * (if executable is symlink or script, it is NOT replaced
1484 * by link target or interpreter name) */
1485 char comm[COMM_LEN];
1486 /* user/group? - use passwd/group parsing functions */
1487 #if ENABLE_FEATURE_TOP_SMP_PROCESS
1488 int last_seen_on_cpu;
1491 /* flag bits for procps_scan(xx, flags) calls */
1493 PSSCAN_PID = 1 << 0,
1494 PSSCAN_PPID = 1 << 1,
1495 PSSCAN_PGID = 1 << 2,
1496 PSSCAN_SID = 1 << 3,
1497 PSSCAN_UIDGID = 1 << 4,
1498 PSSCAN_COMM = 1 << 5,
1499 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
1500 PSSCAN_ARGV0 = 1 << 7,
1501 PSSCAN_EXE = 1 << 8,
1502 PSSCAN_STATE = 1 << 9,
1503 PSSCAN_VSZ = 1 << 10,
1504 PSSCAN_RSS = 1 << 11,
1505 PSSCAN_STIME = 1 << 12,
1506 PSSCAN_UTIME = 1 << 13,
1507 PSSCAN_TTY = 1 << 14,
1508 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1509 /* NB: used by find_pid_by_name(). Any applet using it
1510 * needs to be mentioned here. */
1511 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1512 || ENABLE_PGREP || ENABLE_PKILL
1516 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
1517 PSSCAN_START_TIME = 1 << 18,
1518 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1519 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1520 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1521 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
1522 /* These are all retrieved from proc/NN/stat in one go: */
1523 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
1524 /**/ | PSSCAN_COMM | PSSCAN_STATE
1525 /**/ | PSSCAN_VSZ | PSSCAN_RSS
1526 /**/ | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
1527 /**/ | PSSCAN_TTY | PSSCAN_NICE
1530 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1531 void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1532 procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
1533 /* Format cmdline (up to col chars) into char buf[size] */
1534 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1535 void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
1536 pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1537 pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
1538 int starts_with_cpu(const char *str) FAST_FUNC;
1539 unsigned get_cpu_count(void) FAST_FUNC;
1542 extern const char bb_uuenc_tbl_base64[];
1543 extern const char bb_uuenc_tbl_std[];
1544 void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
1546 BASE64_FLAG_UU_STOP = 0x100,
1547 /* Sign-extends to a value which never matches fgetc result: */
1548 BASE64_FLAG_NO_STOP_CHAR = 0x80,
1550 void FAST_FUNC read_base64(FILE *src_stream, FILE *dst_stream, int flags);
1552 typedef struct md5_ctx_t {
1553 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1554 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
1555 uint64_t total64; /* must be directly before hash[] */
1556 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1558 typedef struct md5_ctx_t sha1_ctx_t;
1559 typedef struct md5_ctx_t sha256_ctx_t;
1560 typedef struct sha512_ctx_t {
1561 uint64_t total64[2]; /* must be directly before hash[] */
1563 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
1565 void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1566 void md5_hash(md5_ctx_t *ctx, const void *data, size_t length) FAST_FUNC;
1567 void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1568 void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1569 #define sha1_hash md5_hash
1570 void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1571 void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1572 #define sha256_hash md5_hash
1573 #define sha256_end sha1_end
1574 void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1575 void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1576 void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
1578 extern uint32_t *global_crc32_table;
1579 uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1580 uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1581 uint32_t crc32_block_endian0(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1583 typedef struct masks_labels_t {
1587 int print_flags_separated(const int *masks, const char *labels,
1588 int flags, const char *separator) FAST_FUNC;
1589 int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
1591 typedef struct bb_progress_t {
1593 unsigned lastupdate_sec;
1598 void bb_progress_init(bb_progress_t *p) FAST_FUNC;
1599 void bb_progress_update(bb_progress_t *p, const char *curfile,
1600 off_t beg_range, off_t transferred,
1601 off_t totalsize) FAST_FUNC;
1603 extern const char *applet_name;
1605 /* Some older linkers don't perform string merging, we used to have common strings
1606 * as global arrays to do it by hand. But:
1607 * (1) newer linkers do it themselves,
1608 * (2) however, they DONT merge string constants with global arrays,
1609 * even if the value is the same (!). Thus global arrays actually
1610 * increased size a bit: for example, "/etc/passwd" string from libc
1611 * wasn't merged with bb_path_passwd_file[] array!
1612 * Therefore now we use #defines.
1614 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1615 extern const char bb_banner[];
1616 extern const char bb_msg_memory_exhausted[];
1617 extern const char bb_msg_invalid_date[];
1618 #define bb_msg_read_error "read error"
1619 #define bb_msg_write_error "write error"
1620 extern const char bb_msg_unknown[];
1621 extern const char bb_msg_can_not_create_raw_socket[];
1622 extern const char bb_msg_perm_denied_are_you_root[];
1623 extern const char bb_msg_you_must_be_root[];
1624 extern const char bb_msg_requires_arg[];
1625 extern const char bb_msg_invalid_arg[];
1626 extern const char bb_msg_standard_input[];
1627 extern const char bb_msg_standard_output[];
1629 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1630 extern const char bb_hexdigits_upcase[];
1632 extern const char bb_path_wtmp_file[];
1634 /* Busybox mount uses either /proc/mounts or /etc/mtab to
1635 * get the list of currently mounted filesystems */
1636 #define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1638 #define bb_path_passwd_file _PATH_PASSWD
1639 #define bb_path_group_file _PATH_GROUP
1640 #define bb_path_shadow_file _PATH_SHADOW
1641 #define bb_path_gshadow_file _PATH_GSHADOW
1643 #define bb_path_motd_file "/etc/motd"
1645 #define bb_dev_null "/dev/null"
1646 extern const char bb_busybox_exec_path[];
1647 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1648 * but I want to save a few bytes here */
1649 extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1650 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1651 #define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1653 extern const int const_int_0;
1654 extern const int const_int_1;
1657 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1658 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1659 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1660 /* This struct is deliberately not defined. */
1661 /* See docs/keep_data_small.txt */
1663 /* '*const' ptr makes gcc optimize code much better.
1664 * Magic prevents ptr_to_globals from going into rodata.
1665 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1666 extern struct globals *const ptr_to_globals;
1667 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1668 #define barrier() __asm__ __volatile__("":::"memory")
1669 #define SET_PTR_TO_GLOBALS(x) do { \
1670 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
1674 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1675 * use bb_default_login_shell and following defines.
1676 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1677 * don't forget to change increment constant. */
1678 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
1679 extern const char bb_default_login_shell[];
1681 #define DEFAULT_SHELL (bb_default_login_shell+1)
1683 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1685 /* The following devices are the same on all systems. */
1686 #define CURRENT_TTY "/dev/tty"
1687 #define DEV_CONSOLE "/dev/console"
1689 #if defined(__FreeBSD_kernel__)
1690 # define CURRENT_VC CURRENT_TTY
1691 # define VC_1 "/dev/ttyv0"
1692 # define VC_2 "/dev/ttyv1"
1693 # define VC_3 "/dev/ttyv2"
1694 # define VC_4 "/dev/ttyv3"
1695 # define VC_5 "/dev/ttyv4"
1696 # define VC_FORMAT "/dev/ttyv%d"
1697 #elif defined(__GNU__)
1698 # define CURRENT_VC CURRENT_TTY
1699 # define VC_1 "/dev/tty1"
1700 # define VC_2 "/dev/tty2"
1701 # define VC_3 "/dev/tty3"
1702 # define VC_4 "/dev/tty4"
1703 # define VC_5 "/dev/tty5"
1704 # define VC_FORMAT "/dev/tty%d"
1705 #elif ENABLE_FEATURE_DEVFS
1706 /*Linux, obsolete devfs names */
1707 # define CURRENT_VC "/dev/vc/0"
1708 # define VC_1 "/dev/vc/1"
1709 # define VC_2 "/dev/vc/2"
1710 # define VC_3 "/dev/vc/3"
1711 # define VC_4 "/dev/vc/4"
1712 # define VC_5 "/dev/vc/5"
1713 # define VC_FORMAT "/dev/vc/%d"
1714 # define LOOP_FORMAT "/dev/loop/%d"
1715 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1716 # define LOOP_NAME "/dev/loop/"
1717 # define FB_0 "/dev/fb/0"
1719 /*Linux, normal names */
1720 # define CURRENT_VC "/dev/tty0"
1721 # define VC_1 "/dev/tty1"
1722 # define VC_2 "/dev/tty2"
1723 # define VC_3 "/dev/tty3"
1724 # define VC_4 "/dev/tty4"
1725 # define VC_5 "/dev/tty5"
1726 # define VC_FORMAT "/dev/tty%d"
1727 # define LOOP_FORMAT "/dev/loop%d"
1728 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1729 # define LOOP_NAME "/dev/loop"
1730 # define FB_0 "/dev/fb0"
1734 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1737 /* We redefine ctype macros. Unicode-correct handling of char types
1738 * can't be done with such byte-oriented operations anyway,
1739 * we don't lose anything.
1757 /* We save ~500 bytes on isdigit alone.
1758 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
1760 /* These work the same for ASCII and Unicode,
1761 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
1762 #define isascii(a) ((unsigned char)(a) <= 0x7f)
1763 #define isdigit(a) ((unsigned char)((a) - '0') <= 9)
1764 #define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1765 #define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
1766 #define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
1767 #define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1768 #define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
1769 /* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
1770 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
1772 #define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
1773 // Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1774 #define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1775 // Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
1776 #define isalnum(a) bb_ascii_isalnum(a)
1777 static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1779 unsigned char b = a - '0';
1783 return b <= 'z' - 'a';
1785 #define isxdigit(a) bb_ascii_isxdigit(a)
1786 static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1788 unsigned char b = a - '0';
1792 return b <= 'f' - 'a';
1794 #define toupper(a) bb_ascii_toupper(a)
1795 static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1797 unsigned char b = a - 'a';
1798 if (b <= ('z' - 'a'))
1802 #define tolower(a) bb_ascii_tolower(a)
1803 static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1805 unsigned char b = a - 'A';
1806 if (b <= ('Z' - 'A'))
1811 /* In ASCII and Unicode, these are likely to be very different.
1812 * Let's prevent ambiguous usage from the start */
1813 #define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1814 #define isprint(a) isprint_is_ambiguous_dont_use(a)
1815 /* NB: must not treat EOF as isgraph or isprint */
1816 #define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1817 #define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1820 POP_SAVED_FUNCTION_VISIBILITY