1 /* vi: set sw=4 ts=4: */
3 * Busybox main internal header file
5 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
6 * Permission has been granted to redistribute this code under GPL.
8 * Licensed under GPLv2, see file LICENSE in this source tree.
23 #if defined __UCLIBC__ /* TODO: and glibc? */
24 /* use inlined versions of these: */
25 # define sigfillset(s) __sigfillset(s)
26 # define sigemptyset(s) __sigemptyset(s)
27 # define sigisemptyset(s) __sigisemptyset(s)
35 /* There are two incompatible basename's, let not use them! */
36 /* See the dirname/basename man page for details */
37 #include <libgen.h> /* dirname,basename */
39 #define basename dont_use_basename
41 #include <sys/ioctl.h>
43 #include <sys/socket.h>
46 #include <sys/types.h>
48 # include <sys/sysmacros.h>
53 #include <sys/param.h>
56 #if ENABLE_FEATURE_SHADOWPASSWDS
57 # if !ENABLE_USE_BB_SHADOW
58 /* If using busybox's shadow implementation, do not include the shadow.h
59 * header as the toolchain may not provide it at all.
64 #if defined(ANDROID) || defined(__ANDROID__)
65 # define endpwent() ((void)0)
66 # define endgrent() ((void)0)
71 #ifdef HAVE_SYS_STATFS_H
72 # include <sys/statfs.h>
74 /* Don't do this here:
75 * #include <sys/sysinfo.h>
76 * Some linux/ includes pull in conflicting definition
77 * of struct sysinfo (only in some toolchanins), which breaks build.
78 * Include sys/sysinfo.h only in those files which need it.
81 # include <selinux/selinux.h>
82 # include <selinux/context.h>
83 # include <selinux/flask.h>
84 # include <selinux/av_permissions.h>
86 #if ENABLE_FEATURE_UTMP
89 #if ENABLE_LOCALE_SUPPORT
92 # define setlocale(x,y) ((void)0)
97 /* Just in case libc doesn't define some of these... */
99 #define _PATH_PASSWD "/etc/passwd"
102 #define _PATH_GROUP "/etc/group"
105 #define _PATH_SHADOW "/etc/shadow"
107 #ifndef _PATH_GSHADOW
108 #define _PATH_GSHADOW "/etc/gshadow"
110 #if defined __FreeBSD__ || defined __OpenBSD__
111 # include <netinet/in.h>
112 # include <arpa/inet.h>
113 #elif defined __APPLE__
114 # include <netinet/in.h>
116 # include <arpa/inet.h>
117 # if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
118 /* We #define socklen_t *after* includes, otherwise we get
119 * typedef redefinition errors from system headers
120 * (in case "is it defined already" detection above failed)
122 # define socklen_t bb_socklen_t
123 typedef unsigned socklen_t
;
126 #ifndef HAVE_CLEARENV
127 # define clearenv() do { if (environ) environ[0] = NULL; } while (0)
129 #ifndef HAVE_FDATASYNC
130 # define fdatasync fsync
137 /* Some libc's forget to declare these, do it ourself */
139 extern char **environ
;
140 #if defined(__GLIBC__) && __GLIBC__ < 2
141 int vdprintf(int d
, const char *format
, va_list ap
);
143 /* klogctl is in libc's klog.h, but we cheat and not #include that */
144 int klogctl(int type
, char *b
, int len
);
146 # define PATH_MAX 256
153 /* Busybox does not use threads, we can speed up stdio. */
154 #ifdef HAVE_UNLOCKED_STDIO
156 # define getc(stream) getc_unlocked(stream)
158 # define getchar() getchar_unlocked()
160 # define putc(c, stream) putc_unlocked(c, stream)
162 # define putchar(c) putchar_unlocked(c)
164 # define fgetc(stream) getc_unlocked(stream)
166 # define fputc(c, stream) putc_unlocked(c, stream)
168 /* Above functions are required by POSIX.1-2008, below ones are extensions */
169 #ifdef HAVE_UNLOCKED_LINE_OPS
171 # define fgets(s, n, stream) fgets_unlocked(s, n, stream)
173 # define fputs(s, stream) fputs_unlocked(s, stream)
177 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
178 /* (don't include system headers after this until corresponding pop!) */
179 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
182 #if ENABLE_USE_BB_PWD_GRP
186 #if ENABLE_FEATURE_SHADOWPASSWDS
187 # if ENABLE_USE_BB_SHADOW
188 # include "shadow_.h"
192 /* Tested to work correctly with all int types (IIRC :]) */
193 #define MAXINT(T) (T)( \
196 : (T)~((T)1 << (sizeof(T)*8-1)) \
199 #define MININT(T) (T)( \
202 : ((T)1 << (sizeof(T)*8-1)) \
205 /* Large file support */
206 /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
207 * (stat, lseek etc) mapped to "largefile" variants by libc.
208 * Practically it means that open() automatically has O_LARGEFILE added
209 * and all filesize/file_offset parameters and struct members are "large"
210 * (in today's world - signed 64bit). For full support of large files,
211 * we need a few helper #defines (below) and careful use of off_t
212 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
214 /* CONFIG_LFS is on */
215 # if ULONG_MAX > 0xffffffff
216 /* "long" is long enough on this system */
217 typedef unsigned long uoff_t
;
218 # define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
219 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
220 # define BB_STRTOOFF bb_strtoul
221 # define STRTOOFF strtoul
222 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
225 /* "long" is too short, need "long long" */
226 typedef unsigned long long uoff_t
;
227 # define XATOOFF(a) xatoull_range((a), 0, LLONG_MAX)
228 # define BB_STRTOOFF bb_strtoull
229 # define STRTOOFF strtoull
230 # define OFF_FMT "ll"
233 /* CONFIG_LFS is off */
234 # if UINT_MAX == 0xffffffff
235 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
236 * gcc will throw warnings on printf("%d", off_t). Crap... */
237 typedef unsigned long uoff_t
;
238 # define XATOOFF(a) xatoi_positive(a)
239 # define BB_STRTOOFF bb_strtou
240 # define STRTOOFF strtol
243 typedef unsigned long uoff_t
;
244 # define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
245 # define BB_STRTOOFF bb_strtoul
246 # define STRTOOFF strtol
250 /* scary. better ideas? (but do *test* them first!) */
251 #define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
252 /* Users report bionic to use 32-bit off_t even if LARGEFILE support is requested.
253 * We misdetected that. Don't let it build:
255 struct BUG_off_t_size_is_misdetected
{
256 char BUG_off_t_size_is_misdetected
[sizeof(off_t
) == sizeof(uoff_t
) ? 1 : -1];
259 /* Some useful definitions */
261 #define FALSE ((int) 0)
263 #define TRUE ((int) 1)
265 #define SKIP ((int) 2)
267 /* Macros for min/max. */
269 #define MIN(a,b) (((a)<(b))?(a):(b))
273 #define MAX(a,b) (((a)>(b))?(a):(b))
276 /* buffer allocation schemes */
277 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
278 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
279 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
280 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
282 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
283 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
284 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
285 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
287 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
288 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
289 #define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
293 #if defined(__GLIBC__)
294 /* glibc uses __errno_location() to get a ptr to errno */
295 /* We can just memorize it once - no multithreading in busybox :) */
296 extern int *const bb_errno
;
298 #define errno (*bb_errno)
301 #if !(ULONG_MAX > 0xffffffff)
302 /* Only 32-bit CPUs need this, 64-bit ones use inlined version */
303 uint64_t bb_bswap_64(uint64_t x
) FAST_FUNC
;
306 unsigned long long monotonic_ns(void) FAST_FUNC
;
307 unsigned long long monotonic_us(void) FAST_FUNC
;
308 unsigned long long monotonic_ms(void) FAST_FUNC
;
309 unsigned monotonic_sec(void) FAST_FUNC
;
311 extern void chomp(char *s
) FAST_FUNC
;
312 extern void trim(char *s
) FAST_FUNC
;
313 extern char *skip_whitespace(const char *) FAST_FUNC
;
314 extern char *skip_non_whitespace(const char *) FAST_FUNC
;
315 extern char *skip_dev_pfx(const char *tty_name
) FAST_FUNC
;
317 extern char *strrstr(const char *haystack
, const char *needle
) FAST_FUNC
;
319 //TODO: supply a pointer to char[11] buffer (avoid statics)?
320 extern const char *bb_mode_string(mode_t mode
) FAST_FUNC
;
321 extern int is_directory(const char *name
, int followLinks
) FAST_FUNC
;
322 enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
323 FILEUTILS_PRESERVE_STATUS
= 1 << 0, /* -p */
324 FILEUTILS_DEREFERENCE
= 1 << 1, /* !-d */
325 FILEUTILS_RECUR
= 1 << 2, /* -R */
326 FILEUTILS_FORCE
= 1 << 3, /* -f */
327 FILEUTILS_INTERACTIVE
= 1 << 4, /* -i */
328 FILEUTILS_MAKE_HARDLINK
= 1 << 5, /* -l */
329 FILEUTILS_MAKE_SOFTLINK
= 1 << 6, /* -s */
330 FILEUTILS_DEREF_SOFTLINK
= 1 << 7, /* -L */
331 FILEUTILS_DEREFERENCE_L0
= 1 << 8, /* -H */
333 FILEUTILS_PRESERVE_SECURITY_CONTEXT
= 1 << 9, /* -c */
334 FILEUTILS_SET_SECURITY_CONTEXT
= 1 << 10,
337 #define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
338 extern int remove_file(const char *path
, int flags
) FAST_FUNC
;
339 /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
340 * the source, not copy (unless "source" is a directory).
341 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
342 * work coreutils-compatibly. */
343 extern int copy_file(const char *source
, const char *dest
, int flags
) FAST_FUNC
;
346 ACTION_RECURSE
= (1 << 0),
347 ACTION_FOLLOWLINKS
= (1 << 1),
348 ACTION_FOLLOWLINKS_L0
= (1 << 2),
349 ACTION_DEPTHFIRST
= (1 << 3),
350 /*ACTION_REVERSE = (1 << 4), - unused */
351 ACTION_QUIET
= (1 << 5),
352 ACTION_DANGLING_OK
= (1 << 6),
354 typedef uint8_t recurse_flags_t
;
355 extern int recursive_action(const char *fileName
, unsigned flags
,
356 int FAST_FUNC (*fileAction
)(const char *fileName
, struct stat
* statbuf
, void* userData
, int depth
),
357 int FAST_FUNC (*dirAction
)(const char *fileName
, struct stat
* statbuf
, void* userData
, int depth
),
358 void* userData
, unsigned depth
) FAST_FUNC
;
359 extern int device_open(const char *device
, int mode
) FAST_FUNC
;
360 enum { GETPTY_BUFSIZE
= 16 }; /* more than enough for "/dev/ttyXXX" */
361 extern int xgetpty(char *line
) FAST_FUNC
;
362 extern int get_console_fd_or_die(void) FAST_FUNC
;
363 extern void console_make_active(int fd
, const int vt_num
) FAST_FUNC
;
364 extern char *find_block_device(const char *path
) FAST_FUNC
;
365 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
366 extern off_t
bb_copyfd_eof(int fd1
, int fd2
) FAST_FUNC
;
367 extern off_t
bb_copyfd_size(int fd1
, int fd2
, off_t size
) FAST_FUNC
;
368 extern void bb_copyfd_exact_size(int fd1
, int fd2
, off_t size
) FAST_FUNC
;
369 /* "short" copy can be detected by return value < size */
370 /* this helper yells "short read!" if param is not -1 */
371 extern void complain_copyfd_and_die(off_t sz
) NORETURN FAST_FUNC
;
373 extern char bb_process_escape_sequence(const char **ptr
) FAST_FUNC
;
374 char* strcpy_and_process_escape_sequences(char *dst
, const char *src
) FAST_FUNC
;
375 /* xxxx_strip version can modify its parameter:
379 * "abc/def/" -> "def" !!
381 char *bb_get_last_path_component_strip(char *path
) FAST_FUNC
;
382 /* "abc/def/" -> "" and it never modifies 'path' */
383 char *bb_get_last_path_component_nostrip(const char *path
) FAST_FUNC
;
384 /* Simpler version: does not special case "/" string */
385 const char *bb_basename(const char *name
) FAST_FUNC
;
386 /* NB: can violate const-ness (similarly to strchr) */
387 char *last_char_is(const char *s
, int c
) FAST_FUNC
;
389 void ndelay_on(int fd
) FAST_FUNC
;
390 void ndelay_off(int fd
) FAST_FUNC
;
391 void close_on_exec_on(int fd
) FAST_FUNC
;
392 void xdup2(int, int) FAST_FUNC
;
393 void xmove_fd(int, int) FAST_FUNC
;
396 DIR *xopendir(const char *path
) FAST_FUNC
;
397 DIR *warn_opendir(const char *path
) FAST_FUNC
;
399 char *xmalloc_realpath(const char *path
) FAST_FUNC RETURNS_MALLOC
;
400 char *xmalloc_readlink(const char *path
) FAST_FUNC RETURNS_MALLOC
;
401 char *xmalloc_readlink_or_warn(const char *path
) FAST_FUNC RETURNS_MALLOC
;
402 /* !RETURNS_MALLOC: it's a realloc-like function */
403 char *xrealloc_getcwd_or_warn(char *cwd
) FAST_FUNC
;
405 char *xmalloc_follow_symlinks(const char *path
) FAST_FUNC RETURNS_MALLOC
;
409 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
410 * otherwise would kill us, except for those resulting from bugs:
411 * SIGSEGV, SIGILL, SIGFPE.
412 * Other fatal signals not included (TODO?):
413 * SIGBUS Bus error (bad memory access)
414 * SIGPOLL Pollable event. Synonym of SIGIO
415 * SIGPROF Profiling timer expired
416 * SIGSYS Bad argument to routine
417 * SIGTRAP Trace/breakpoint trap
419 * The only known arch with some of these sigs not fitting
420 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
421 * Dance around with long long to guard against that...
423 BB_FATAL_SIGS
= (int)(0
427 + (1LL << SIGPIPE
) // Write to pipe with no readers
428 + (1LL << SIGQUIT
) // Quit from keyboard
429 + (1LL << SIGABRT
) // Abort signal from abort(3)
430 + (1LL << SIGALRM
) // Timer signal from alarm(2)
431 + (1LL << SIGVTALRM
) // Virtual alarm clock
432 + (1LL << SIGXCPU
) // CPU time limit exceeded
433 + (1LL << SIGXFSZ
) // File size limit exceeded
434 + (1LL << SIGUSR1
) // Yes kids, these are also fatal!
438 void bb_signals(int sigs
, void (*f
)(int)) FAST_FUNC
;
439 /* Unlike signal() and bb_signals, sets handler with sigaction()
440 * and in a way that while signal handler is run, no other signals
441 * will be blocked; syscalls will not be restarted: */
442 void bb_signals_recursive_norestart(int sigs
, void (*f
)(int)) FAST_FUNC
;
443 /* syscalls like read() will be interrupted with EINTR: */
444 void signal_no_SA_RESTART_empty_mask(int sig
, void (*handler
)(int)) FAST_FUNC
;
445 /* syscalls like read() won't be interrupted (though select/poll will be): */
446 void signal_SA_RESTART_empty_mask(int sig
, void (*handler
)(int)) FAST_FUNC
;
447 void wait_for_any_sig(void) FAST_FUNC
;
448 void kill_myself_with_sig(int sig
) NORETURN FAST_FUNC
;
449 void sig_block(int sig
) FAST_FUNC
;
450 void sig_unblock(int sig
) FAST_FUNC
;
451 /* Will do sigaction(signum, act, NULL): */
452 int sigaction_set(int sig
, const struct sigaction
*act
) FAST_FUNC
;
453 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
454 int sigprocmask_allsigs(int how
) FAST_FUNC
;
455 /* Standard handler which just records signo */
456 extern smallint bb_got_signal
;
457 void record_signo(int signo
); /* not FAST_FUNC! */
460 void xsetgid(gid_t gid
) FAST_FUNC
;
461 void xsetuid(uid_t uid
) FAST_FUNC
;
462 void xchdir(const char *path
) FAST_FUNC
;
463 void xchroot(const char *path
) FAST_FUNC
;
464 void xsetenv(const char *key
, const char *value
) FAST_FUNC
;
465 void bb_unsetenv(const char *key
) FAST_FUNC
;
466 void bb_unsetenv_and_free(char *key
) FAST_FUNC
;
467 void xunlink(const char *pathname
) FAST_FUNC
;
468 void xstat(const char *pathname
, struct stat
*buf
) FAST_FUNC
;
469 void xfstat(int fd
, struct stat
*buf
, const char *errmsg
) FAST_FUNC
;
470 int xopen(const char *pathname
, int flags
) FAST_FUNC
;
471 int xopen_nonblocking(const char *pathname
) FAST_FUNC
;
472 int xopen3(const char *pathname
, int flags
, int mode
) FAST_FUNC
;
473 int open_or_warn(const char *pathname
, int flags
) FAST_FUNC
;
474 int open3_or_warn(const char *pathname
, int flags
, int mode
) FAST_FUNC
;
475 int open_or_warn_stdin(const char *pathname
) FAST_FUNC
;
476 int xopen_stdin(const char *pathname
) FAST_FUNC
;
477 void xrename(const char *oldpath
, const char *newpath
) FAST_FUNC
;
478 int rename_or_warn(const char *oldpath
, const char *newpath
) FAST_FUNC
;
479 off_t
xlseek(int fd
, off_t offset
, int whence
) FAST_FUNC
;
480 int xmkstemp(char *template) FAST_FUNC
;
481 off_t
fdlength(int fd
) FAST_FUNC
;
483 uoff_t FAST_FUNC
get_volume_size_in_bytes(int fd
,
484 const char *override
,
485 unsigned override_units
,
488 void xpipe(int filedes
[2]) FAST_FUNC
;
489 /* In this form code with pipes is much more readable */
490 struct fd_pair
{ int rd
; int wr
; };
491 #define piped_pair(pair) pipe(&((pair).rd))
492 #define xpiped_pair(pair) xpipe(&((pair).rd))
494 /* Useful for having small structure members/global variables */
495 typedef int8_t socktype_t
;
496 typedef int8_t family_t
;
497 struct BUG_too_small
{
498 char BUG_socktype_t_too_small
[(0
505 char BUG_family_t_too_small
[(0
522 void parse_datestr(const char *date_str
, struct tm
*ptm
) FAST_FUNC
;
523 time_t validate_tm_time(const char *date_str
, struct tm
*ptm
) FAST_FUNC
;
526 int xsocket(int domain
, int type
, int protocol
) FAST_FUNC
;
527 void xbind(int sockfd
, struct sockaddr
*my_addr
, socklen_t addrlen
) FAST_FUNC
;
528 void xlisten(int s
, int backlog
) FAST_FUNC
;
529 void xconnect(int s
, const struct sockaddr
*s_addr
, socklen_t addrlen
) FAST_FUNC
;
530 ssize_t
xsendto(int s
, const void *buf
, size_t len
, const struct sockaddr
*to
,
531 socklen_t tolen
) FAST_FUNC
;
532 /* SO_REUSEADDR allows a server to rebind to an address that is already
533 * "in use" by old connections to e.g. previous server instance which is
534 * killed or crashed. Without it bind will fail until all such connections
535 * time out. Linux does not allow multiple live binds on same ip:port
536 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
537 * Turn it on before you call bind(). */
538 void setsockopt_reuseaddr(int fd
) FAST_FUNC
; /* On Linux this never fails. */
539 int setsockopt_broadcast(int fd
) FAST_FUNC
;
540 int setsockopt_bindtodevice(int fd
, const char *iface
) FAST_FUNC
;
541 /* NB: returns port in host byte order */
542 unsigned bb_lookup_port(const char *port
, const char *protocol
, unsigned default_port
) FAST_FUNC
;
543 typedef struct len_and_sockaddr
{
547 struct sockaddr_in sin
;
548 #if ENABLE_FEATURE_IPV6
549 struct sockaddr_in6 sin6
;
554 LSA_LEN_SIZE
= offsetof(len_and_sockaddr
, u
),
555 LSA_SIZEOF_SA
= sizeof(
558 struct sockaddr_in sin
;
559 #if ENABLE_FEATURE_IPV6
560 struct sockaddr_in6 sin6
;
565 /* Create stream socket, and allocate suitable lsa.
566 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
567 * af == AF_UNSPEC will result in trying to create IPv6 socket,
568 * and if kernel doesn't support it, fall back to IPv4.
569 * This is useful if you plan to bind to resulting local lsa.
571 int xsocket_type(len_and_sockaddr
**lsap
, int af
, int sock_type
) FAST_FUNC
;
572 int xsocket_stream(len_and_sockaddr
**lsap
) FAST_FUNC
;
573 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
574 * numeric IP ("N.N.N.N") or numeric IPv6 address,
575 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
576 * Only if there is no suffix, port argument is used */
577 /* NB: these set SO_REUSEADDR before bind */
578 int create_and_bind_stream_or_die(const char *bindaddr
, int port
) FAST_FUNC
;
579 int create_and_bind_dgram_or_die(const char *bindaddr
, int port
) FAST_FUNC
;
580 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
581 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
582 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
583 * If there is no suffix, port argument is used */
584 int create_and_connect_stream_or_die(const char *peer
, int port
) FAST_FUNC
;
585 /* Connect to peer identified by lsa */
586 int xconnect_stream(const len_and_sockaddr
*lsa
) FAST_FUNC
;
587 /* Get local address of bound or accepted socket */
588 len_and_sockaddr
*get_sock_lsa(int fd
) FAST_FUNC RETURNS_MALLOC
;
589 /* Get remote address of connected or accepted socket */
590 len_and_sockaddr
*get_peer_lsa(int fd
) FAST_FUNC RETURNS_MALLOC
;
591 /* Return malloc'ed len_and_sockaddr with socket address of host:port
592 * Currently will return IPv4 or IPv6 sockaddrs only
593 * (depending on host), but in theory nothing prevents e.g.
594 * UNIX socket address being returned, IPX sockaddr etc...
595 * On error does bb_error_msg and returns NULL */
596 len_and_sockaddr
* host2sockaddr(const char *host
, int port
) FAST_FUNC RETURNS_MALLOC
;
597 /* Version which dies on error */
598 len_and_sockaddr
* xhost2sockaddr(const char *host
, int port
) FAST_FUNC RETURNS_MALLOC
;
599 len_and_sockaddr
* xdotted2sockaddr(const char *host
, int port
) FAST_FUNC RETURNS_MALLOC
;
600 /* Same, useful if you want to force family (e.g. IPv6) */
601 #if !ENABLE_FEATURE_IPV6
602 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
603 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
605 len_and_sockaddr
* host_and_af2sockaddr(const char *host
, int port
, sa_family_t af
) FAST_FUNC RETURNS_MALLOC
;
606 len_and_sockaddr
* xhost_and_af2sockaddr(const char *host
, int port
, sa_family_t af
) FAST_FUNC RETURNS_MALLOC
;
608 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
609 * otherwise no-op. Useful for ftp.
610 * NB: does NOT do htons() internally, just direct assignment. */
611 void set_nport(struct sockaddr
*sa
, unsigned port
) FAST_FUNC
;
612 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
613 int get_nport(const struct sockaddr
*sa
) FAST_FUNC
;
614 /* Reverse DNS. Returns NULL on failure. */
615 char* xmalloc_sockaddr2host(const struct sockaddr
*sa
) FAST_FUNC RETURNS_MALLOC
;
616 /* This one doesn't append :PORTNUM */
617 char* xmalloc_sockaddr2host_noport(const struct sockaddr
*sa
) FAST_FUNC RETURNS_MALLOC
;
618 /* This one also doesn't fall back to dotted IP (returns NULL) */
619 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr
*sa
) FAST_FUNC RETURNS_MALLOC
;
620 /* inet_[ap]ton on steroids */
621 char* xmalloc_sockaddr2dotted(const struct sockaddr
*sa
) FAST_FUNC RETURNS_MALLOC
;
622 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr
*sa
) FAST_FUNC RETURNS_MALLOC
;
623 // "old" (ipv4 only) API
624 // users: traceroute.c hostname.c - use _list_ of all IPs
625 struct hostent
*xgethostbyname(const char *name
) FAST_FUNC
;
626 // Also mount.c and inetd.c are using gethostbyname(),
627 // + inet_common.c has additional IPv4-only stuff
630 void socket_want_pktinfo(int fd
) FAST_FUNC
;
631 ssize_t
send_to_from(int fd
, void *buf
, size_t len
, int flags
,
632 const struct sockaddr
*to
,
633 const struct sockaddr
*from
,
634 socklen_t tolen
) FAST_FUNC
;
635 ssize_t
recv_from_to(int fd
, void *buf
, size_t len
, int flags
,
636 struct sockaddr
*from
,
638 socklen_t sa_size
) FAST_FUNC
;
640 uint16_t inet_cksum(uint16_t *addr
, int len
) FAST_FUNC
;
642 char *xstrdup(const char *s
) FAST_FUNC RETURNS_MALLOC
;
643 char *xstrndup(const char *s
, int n
) FAST_FUNC RETURNS_MALLOC
;
644 void overlapping_strcpy(char *dst
, const char *src
) FAST_FUNC
;
645 char *safe_strncpy(char *dst
, const char *src
, size_t size
) FAST_FUNC
;
646 char *strncpy_IFNAMSIZ(char *dst
, const char *src
) FAST_FUNC
;
647 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
648 * But potentially slow, don't use in one-billion-times loops */
649 int bb_putchar(int ch
) FAST_FUNC
;
650 /* Note: does not use stdio, writes to fd 2 directly */
651 int bb_putchar_stderr(char ch
) FAST_FUNC
;
652 char *xasprintf(const char *format
, ...) __attribute__ ((format(printf
, 1, 2))) FAST_FUNC RETURNS_MALLOC
;
653 // gcc-4.1.1 still isn't good enough at optimizing it
654 // (+200 bytes compared to macro)
655 //static ALWAYS_INLINE
656 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
657 //static ALWAYS_INLINE
658 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
659 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
660 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
661 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
662 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
663 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
665 typedef struct uni_stat_t
{
667 unsigned unicode_count
;
668 unsigned unicode_width
;
670 /* Returns a string with unprintable chars replaced by '?' or
671 * SUBST_WCHAR. This function is unicode-aware. */
672 const char* FAST_FUNC
printable_string(uni_stat_t
*stats
, const char *str
);
673 /* Prints unprintable char ch as ^C or M-c to file
674 * (M-c is used only if ch is ORed with PRINTABLE_META),
675 * else it is printed as-is (except for ch = 0x9b) */
676 enum { PRINTABLE_META
= 0x100 };
677 void fputc_printable(int ch
, FILE *file
) FAST_FUNC
;
679 /* dmalloc will redefine these to it's own implementation. It is safe
680 * to have the prototypes here unconditionally. */
681 void *malloc_or_warn(size_t size
) FAST_FUNC RETURNS_MALLOC
;
682 void *xmalloc(size_t size
) FAST_FUNC RETURNS_MALLOC
;
683 void *xzalloc(size_t size
) FAST_FUNC RETURNS_MALLOC
;
684 void *xrealloc(void *old
, size_t size
) FAST_FUNC
;
685 /* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
686 * at least v[idx] and v[idx+1], for all idx values.
687 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
688 * when all elements are used up. New elements are zeroed out.
689 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
690 * skipping an index is a bad bug - it may miss a realloc!
692 #define xrealloc_vector(vector, shift, idx) \
693 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
694 void* xrealloc_vector_helper(void *vector
, unsigned sizeof_and_shift
, int idx
) FAST_FUNC
;
697 extern ssize_t
safe_read(int fd
, void *buf
, size_t count
) FAST_FUNC
;
698 extern ssize_t
nonblock_immune_read(int fd
, void *buf
, size_t count
, int loop_on_EINTR
) FAST_FUNC
;
699 // NB: will return short read on error, not -1,
700 // if some data was read before error occurred
701 extern ssize_t
full_read(int fd
, void *buf
, size_t count
) FAST_FUNC
;
702 extern void xread(int fd
, void *buf
, size_t count
) FAST_FUNC
;
703 extern unsigned char xread_char(int fd
) FAST_FUNC
;
704 extern ssize_t
read_close(int fd
, void *buf
, size_t maxsz
) FAST_FUNC
;
705 extern ssize_t
open_read_close(const char *filename
, void *buf
, size_t maxsz
) FAST_FUNC
;
706 // Reads one line a-la fgets (but doesn't save terminating '\n').
707 // Reads byte-by-byte. Useful when it is important to not read ahead.
708 // Bytes are appended to pfx (which must be malloced, or NULL).
709 extern char *xmalloc_reads(int fd
, size_t *maxsz_p
) FAST_FUNC
;
710 /* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
711 extern void *xmalloc_read(int fd
, size_t *maxsz_p
) FAST_FUNC RETURNS_MALLOC
;
712 /* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
713 extern void *xmalloc_open_read_close(const char *filename
, size_t *maxsz_p
) FAST_FUNC RETURNS_MALLOC
;
714 /* Never returns NULL */
715 extern void *xmalloc_xopen_read_close(const char *filename
, size_t *maxsz_p
) FAST_FUNC RETURNS_MALLOC
;
717 #define SEAMLESS_COMPRESSION (0 \
718 || ENABLE_FEATURE_SEAMLESS_XZ \
719 || ENABLE_FEATURE_SEAMLESS_LZMA \
720 || ENABLE_FEATURE_SEAMLESS_BZ2 \
721 || ENABLE_FEATURE_SEAMLESS_GZ \
722 || ENABLE_FEATURE_SEAMLESS_Z)
724 #if SEAMLESS_COMPRESSION
725 /* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
726 extern int setup_unzip_on_fd(int fd
, int fail_if_not_detected
) FAST_FUNC
;
727 /* Autodetects .gz etc */
728 extern int open_zipped(const char *fname
) FAST_FUNC
;
730 # define setup_unzip_on_fd(...) (0)
731 # define open_zipped(fname) open((fname), O_RDONLY);
733 extern void *xmalloc_open_zipped_read_close(const char *fname
, size_t *maxsz_p
) FAST_FUNC RETURNS_MALLOC
;
735 extern ssize_t
safe_write(int fd
, const void *buf
, size_t count
) FAST_FUNC
;
736 // NB: will return short write on error, not -1,
737 // if some data was written before error occurred
738 extern ssize_t
full_write(int fd
, const void *buf
, size_t count
) FAST_FUNC
;
739 extern void xwrite(int fd
, const void *buf
, size_t count
) FAST_FUNC
;
740 extern void xwrite_str(int fd
, const char *str
) FAST_FUNC
;
741 extern ssize_t
full_write1_str(const char *str
) FAST_FUNC
;
742 extern ssize_t
full_write2_str(const char *str
) FAST_FUNC
;
743 extern void xopen_xwrite_close(const char* file
, const char *str
) FAST_FUNC
;
745 /* Close fd, but check for failures (some types of write errors) */
746 extern void xclose(int fd
) FAST_FUNC
;
748 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
749 extern void xprint_and_close_file(FILE *file
) FAST_FUNC
;
751 /* Reads a line from a text file, up to a newline or NUL byte, inclusive.
752 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
753 * end of line. If end isn't NULL, length of the chunk is stored in it.
754 * Returns NULL if EOF/error.
756 extern char *bb_get_chunk_from_file(FILE *file
, int *end
) FAST_FUNC
;
757 /* Reads up to (and including) TERMINATING_STRING: */
758 extern char *xmalloc_fgets_str(FILE *file
, const char *terminating_string
) FAST_FUNC RETURNS_MALLOC
;
759 /* Same, with limited max size, and returns the length (excluding NUL): */
760 extern char *xmalloc_fgets_str_len(FILE *file
, const char *terminating_string
, size_t *maxsz_p
) FAST_FUNC RETURNS_MALLOC
;
761 /* Chops off TERMINATING_STRING from the end: */
762 extern char *xmalloc_fgetline_str(FILE *file
, const char *terminating_string
) FAST_FUNC RETURNS_MALLOC
;
763 /* Reads up to (and including) "\n" or NUL byte: */
764 extern char *xmalloc_fgets(FILE *file
) FAST_FUNC RETURNS_MALLOC
;
765 /* Chops off '\n' from the end, unlike fgets: */
766 extern char *xmalloc_fgetline(FILE *file
) FAST_FUNC RETURNS_MALLOC
;
767 /* Same, but doesn't try to conserve space (may have some slack after the end) */
768 /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
770 void die_if_ferror(FILE *file
, const char *msg
) FAST_FUNC
;
771 void die_if_ferror_stdout(void) FAST_FUNC
;
772 int fflush_all(void) FAST_FUNC
;
773 void fflush_stdout_and_exit(int retval
) NORETURN FAST_FUNC
;
774 int fclose_if_not_stdin(FILE *file
) FAST_FUNC
;
775 FILE* xfopen(const char *filename
, const char *mode
) FAST_FUNC
;
776 /* Prints warning to stderr and returns NULL on failure: */
777 FILE* fopen_or_warn(const char *filename
, const char *mode
) FAST_FUNC
;
778 /* "Opens" stdin if filename is special, else just opens file: */
779 FILE* xfopen_stdin(const char *filename
) FAST_FUNC
;
780 FILE* fopen_or_warn_stdin(const char *filename
) FAST_FUNC
;
781 FILE* fopen_for_read(const char *path
) FAST_FUNC
;
782 FILE* xfopen_for_read(const char *path
) FAST_FUNC
;
783 FILE* fopen_for_write(const char *path
) FAST_FUNC
;
784 FILE* xfopen_for_write(const char *path
) FAST_FUNC
;
785 FILE* xfdopen_for_read(int fd
) FAST_FUNC
;
786 FILE* xfdopen_for_write(int fd
) FAST_FUNC
;
788 int bb_pstrcmp(const void *a
, const void *b
) /* not FAST_FUNC! */;
789 void qsort_string_vector(char **sv
, unsigned count
) FAST_FUNC
;
791 /* Wrapper which restarts poll on EINTR or ENOMEM.
792 * On other errors complains [perror("poll")] and returns.
793 * Warning! May take (much) longer than timeout_ms to return!
794 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
795 int safe_poll(struct pollfd
*ufds
, nfds_t nfds
, int timeout_ms
) FAST_FUNC
;
797 char *safe_gethostname(void) FAST_FUNC
;
798 char *safe_getdomainname(void) FAST_FUNC
;
800 /* Convert each alpha char in str to lower-case */
801 char* str_tolower(char *str
) FAST_FUNC
;
803 char *utoa(unsigned n
) FAST_FUNC
;
804 char *itoa(int n
) FAST_FUNC
;
805 /* Returns a pointer past the formatted number, does NOT null-terminate */
806 char *utoa_to_buf(unsigned n
, char *buf
, unsigned buflen
) FAST_FUNC
;
807 char *itoa_to_buf(int n
, char *buf
, unsigned buflen
) FAST_FUNC
;
808 /* Intelligent formatters of bignums */
809 void smart_ulltoa4(unsigned long long ul
, char buf
[4], const char *scale
) FAST_FUNC
;
810 void smart_ulltoa5(unsigned long long ul
, char buf
[5], const char *scale
) FAST_FUNC
;
811 /* If block_size == 0, display size without fractional part,
812 * else display (size * block_size) with one decimal digit.
813 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
814 * else divide by display_unit and do not use suffix. */
815 #define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
816 #define HUMAN_READABLE_MAX_WIDTH_STR "7"
817 //TODO: provide pointer to buf (avoid statics)?
818 const char *make_human_readable_str(unsigned long long size
,
819 unsigned long block_size
, unsigned long display_unit
) FAST_FUNC
;
820 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
821 char *bin2hex(char *dst
, const char *src
, int count
) FAST_FUNC
;
823 char* hex2bin(char *dst
, const char *src
, int count
) FAST_FUNC
;
825 /* Generate a UUID */
826 void generate_uuid(uint8_t *buf
) FAST_FUNC
;
827 /* expand UUID to human readable format */
828 char *unparse_uuid(const uint8_t *uu
, char *out
) FAST_FUNC
;
830 int parse_uuid(const char *in
, uint8_t *uuid
) FAST_FUNC
;
832 /* Last element is marked by mult == 0 */
840 /* Using xatoi() instead of naive atoi() is not always convenient -
841 * in many places people want *non-negative* values, but store them
842 * in signed int. Therefore we need this one:
843 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
844 * It should really be named xatoi_nonnegative (since it allows 0),
845 * but that would be too long.
847 int xatoi_positive(const char *numstr
) FAST_FUNC
;
849 /* Useful for reading port numbers */
850 uint16_t xatou16(const char *numstr
) FAST_FUNC
;
853 /* These parse entries in /etc/passwd and /etc/group. This is desirable
854 * for BusyBox since we want to avoid using the glibc NSS stuff, which
855 * increases target size and is often not needed on embedded systems. */
856 long xuname2uid(const char *name
) FAST_FUNC
;
857 long xgroup2gid(const char *name
) FAST_FUNC
;
858 /* wrapper: allows string to contain numeric uid or gid */
859 unsigned long get_ug_id(const char *s
, long FAST_FUNC (*xname2id
)(const char *)) FAST_FUNC
;
860 /* from chpst. Does not die, returns 0 on failure */
865 /* always sets uid and gid */
866 int get_uidgid(struct bb_uidgid_t
*, const char*, int numeric_ok
) FAST_FUNC
;
867 /* always sets uid and gid, allows numeric; exits on failure */
868 void xget_uidgid(struct bb_uidgid_t
*, const char*) FAST_FUNC
;
869 /* chown-like handling of "user[:[group]" */
870 void parse_chown_usergroup_or_die(struct bb_uidgid_t
*u
, char *user_group
) FAST_FUNC
;
871 struct passwd
* xgetpwnam(const char *name
) FAST_FUNC
;
872 struct group
* xgetgrnam(const char *name
) FAST_FUNC
;
873 struct passwd
* xgetpwuid(uid_t uid
) FAST_FUNC
;
874 struct group
* xgetgrgid(gid_t gid
) FAST_FUNC
;
875 char* xuid2uname(uid_t uid
) FAST_FUNC
;
876 char* xgid2group(gid_t gid
) FAST_FUNC
;
877 char* uid2uname(uid_t uid
) FAST_FUNC
;
878 char* gid2group(gid_t gid
) FAST_FUNC
;
879 char* uid2uname_utoa(uid_t uid
) FAST_FUNC
;
880 char* gid2group_utoa(gid_t gid
) FAST_FUNC
;
881 /* versions which cache results (useful for ps, ls etc) */
882 const char* get_cached_username(uid_t uid
) FAST_FUNC
;
883 const char* get_cached_groupname(gid_t gid
) FAST_FUNC
;
884 void clear_username_cache(void) FAST_FUNC
;
885 /* internally usernames are saved in fixed-sized char[] buffers */
886 enum { USERNAME_MAX_SIZE
= 32 - sizeof(uid_t
) };
887 #if ENABLE_FEATURE_CHECK_NAMES
888 void die_if_bad_username(const char* name
) FAST_FUNC
;
890 #define die_if_bad_username(name) ((void)(name))
893 #if ENABLE_FEATURE_UTMP
894 void FAST_FUNC
write_new_utmp(pid_t pid
, int new_type
, const char *tty_name
, const char *username
, const char *hostname
);
895 void FAST_FUNC
update_utmp(pid_t pid
, int new_type
, const char *tty_name
, const char *username
, const char *hostname
);
897 # define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
898 # define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
902 int execable_file(const char *name
) FAST_FUNC
;
903 char *find_execable(const char *filename
, char **PATHp
) FAST_FUNC
;
904 int exists_execable(const char *filename
) FAST_FUNC
;
906 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
907 * but it may exec busybox and call applet instead of searching PATH.
909 #if ENABLE_FEATURE_PREFER_APPLETS
910 int BB_EXECVP(const char *file
, char *const argv
[]) FAST_FUNC
;
911 #define BB_EXECLP(prog,cmd,...) \
913 if (find_applet_by_name(prog) >= 0) \
914 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
915 execlp(prog, cmd, __VA_ARGS__); \
918 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
919 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
921 int BB_EXECVP_or_die(char **argv
) NORETURN FAST_FUNC
;
923 /* xvfork() can't be a _function_, return after vfork mangles stack
924 * in the parent. It must be a macro. */
927 pid_t bb__xvfork_pid = vfork(); \
928 if (bb__xvfork_pid < 0) \
929 bb_perror_msg_and_die("vfork"); \
933 pid_t
xfork(void) FAST_FUNC
;
936 /* NOMMU friendy fork+exec: */
937 pid_t
spawn(char **argv
) FAST_FUNC
;
938 pid_t
xspawn(char **argv
) FAST_FUNC
;
940 pid_t
safe_waitpid(pid_t pid
, int *wstat
, int options
) FAST_FUNC
;
941 pid_t
wait_any_nohang(int *wstat
) FAST_FUNC
;
942 /* wait4pid: unlike waitpid, waits ONLY for one process.
943 * Returns sig + 0x180 if child is killed by signal.
944 * It's safe to pass negative 'pids' from failed [v]fork -
945 * wait4pid will return -1 (and will not clobber [v]fork's errno).
946 * IOW: rc = wait4pid(spawn(argv));
947 * if (rc < 0) bb_perror_msg("%s", argv[0]);
948 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
950 int wait4pid(pid_t pid
) FAST_FUNC
;
951 /* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
952 int spawn_and_wait(char **argv
) FAST_FUNC
;
953 /* Does NOT check that applet is NOFORK, just blindly runs it */
954 int run_nofork_applet(int applet_no
, char **argv
) FAST_FUNC
;
956 /* Helpers for daemonization.
958 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
960 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
961 * rexec's itself on NOMMU with argv passed as command line.
962 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
963 * from the start. (It will detect it and not reexec again second time).
964 * You have to audit carefully that you don't do something twice as a result
965 * (opening files/sockets, parsing config files etc...)!
967 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
968 * (will do setsid()).
970 * fork_or_rexec(argv) = bare-bones fork on MMU,
971 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
972 * On MMU ignores argv.
974 * Helper for network daemons in foreground mode:
976 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
977 * to /dev/null if they are not.
980 DAEMON_CHDIR_ROOT
= 1,
981 DAEMON_DEVNULL_STDIO
= 2,
982 DAEMON_CLOSE_EXTRA_FDS
= 4,
983 DAEMON_ONLY_SANITIZE
= 8, /* internal use */
984 DAEMON_DOUBLE_FORK
= 16, /* double fork to avoid controlling tty */
987 enum { re_execed
= 0 };
988 # define fork_or_rexec(argv) xfork()
989 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
990 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
992 extern bool re_execed
;
993 /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
994 * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
996 void re_exec(char **argv
) NORETURN FAST_FUNC
;
997 pid_t
fork_or_rexec(char **argv
) FAST_FUNC
;
998 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC
;
999 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC
;
1000 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC
;
1001 # define fork() BUG_fork_is_unavailable_on_nommu()
1002 # define xfork() BUG_fork_is_unavailable_on_nommu()
1003 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1004 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
1006 void bb_daemonize_or_rexec(int flags
, char **argv
) FAST_FUNC
;
1007 void bb_sanitize_stdio(void) FAST_FUNC
;
1008 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
1009 int sanitize_env_if_suid(void) FAST_FUNC
;
1012 char* single_argv(char **argv
) FAST_FUNC
;
1013 extern const char *const bb_argv_dash
[]; /* "-", NULL */
1014 extern const char *opt_complementary
;
1015 #if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
1016 #define No_argument "\0"
1017 #define Required_argument "\001"
1018 #define Optional_argument "\002"
1019 extern const char *applet_long_options
;
1021 extern uint32_t option_mask32
;
1022 extern uint32_t getopt32(char **argv
, const char *applet_opts
, ...) FAST_FUNC
;
1025 /* Having next pointer as a first member allows easy creation
1026 * of "llist-compatible" structs, and using llist_FOO functions
1029 typedef struct llist_t
{
1030 struct llist_t
*link
;
1033 void llist_add_to(llist_t
**old_head
, void *data
) FAST_FUNC
;
1034 void llist_add_to_end(llist_t
**list_head
, void *data
) FAST_FUNC
;
1035 void *llist_pop(llist_t
**elm
) FAST_FUNC
;
1036 void llist_unlink(llist_t
**head
, llist_t
*elm
) FAST_FUNC
;
1037 void llist_free(llist_t
*elm
, void (*freeit
)(void *data
)) FAST_FUNC
;
1038 llist_t
*llist_rev(llist_t
*list
) FAST_FUNC
;
1039 llist_t
*llist_find_str(llist_t
*first
, const char *str
) FAST_FUNC
;
1040 /* BTW, surprisingly, changing API to
1041 * llist_t *llist_add_to(llist_t *old_head, void *data)
1042 * etc does not result in smaller code... */
1044 /* start_stop_daemon and udhcpc are special - they want
1045 * to create pidfiles regardless of FEATURE_PIDFILE */
1046 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
1047 /* True only if we created pidfile which is *file*, not /dev/null etc */
1048 extern smallint wrote_pidfile
;
1049 void write_pidfile(const char *path
) FAST_FUNC
;
1050 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
1052 enum { wrote_pidfile
= 0 };
1053 #define write_pidfile(path) ((void)0)
1054 #define remove_pidfile(path) ((void)0)
1059 LOGMODE_STDIO
= (1 << 0),
1060 LOGMODE_SYSLOG
= (1 << 1) * ENABLE_FEATURE_SYSLOG
,
1061 LOGMODE_BOTH
= LOGMODE_SYSLOG
+ LOGMODE_STDIO
,
1063 extern const char *msg_eol
;
1064 extern smallint logmode
;
1065 extern int die_sleep
;
1066 extern uint8_t xfunc_error_retval
;
1067 extern jmp_buf die_jmp
;
1068 extern void xfunc_die(void) NORETURN FAST_FUNC
;
1069 extern void bb_show_usage(void) NORETURN FAST_FUNC
;
1070 extern void bb_error_msg(const char *s
, ...) __attribute__ ((format (printf
, 1, 2))) FAST_FUNC
;
1071 extern void bb_error_msg_and_die(const char *s
, ...) __attribute__ ((noreturn
, format (printf
, 1, 2))) FAST_FUNC
;
1072 extern void bb_perror_msg(const char *s
, ...) __attribute__ ((format (printf
, 1, 2))) FAST_FUNC
;
1073 extern void bb_simple_perror_msg(const char *s
) FAST_FUNC
;
1074 extern void bb_perror_msg_and_die(const char *s
, ...) __attribute__ ((noreturn
, format (printf
, 1, 2))) FAST_FUNC
;
1075 extern void bb_simple_perror_msg_and_die(const char *s
) NORETURN FAST_FUNC
;
1076 extern void bb_herror_msg(const char *s
, ...) __attribute__ ((format (printf
, 1, 2))) FAST_FUNC
;
1077 extern void bb_herror_msg_and_die(const char *s
, ...) __attribute__ ((noreturn
, format (printf
, 1, 2))) FAST_FUNC
;
1078 extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC
;
1079 extern void bb_perror_nomsg(void) FAST_FUNC
;
1080 extern void bb_info_msg(const char *s
, ...) __attribute__ ((format (printf
, 1, 2))) FAST_FUNC
;
1081 extern void bb_verror_msg(const char *s
, va_list p
, const char *strerr
) FAST_FUNC
;
1083 /* We need to export XXX_main from libbusybox
1084 * only if we build "individual" binaries
1086 #if ENABLE_FEATURE_INDIVIDUAL
1087 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1089 #define MAIN_EXTERNALLY_VISIBLE
1093 /* Applets which are useful from another applets */
1094 int bb_cat(char** argv
);
1095 /* If shell needs them, they exist even if not enabled as applets */
1096 int echo_main(int argc
, char** argv
) IF_ECHO(MAIN_EXTERNALLY_VISIBLE
);
1097 int printf_main(int argc
, char **argv
) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE
);
1098 int test_main(int argc
, char **argv
) IF_TEST(MAIN_EXTERNALLY_VISIBLE
);
1099 int kill_main(int argc
, char **argv
) IF_KILL(MAIN_EXTERNALLY_VISIBLE
);
1100 /* Similar, but used by chgrp, not shell */
1101 int chown_main(int argc
, char **argv
) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE
);
1103 int ls_main(int argc
, char **argv
) IF_LS(MAIN_EXTERNALLY_VISIBLE
);
1104 /* Don't need IF_xxx() guard for these */
1105 int gunzip_main(int argc
, char **argv
) MAIN_EXTERNALLY_VISIBLE
;
1106 int bunzip2_main(int argc
, char **argv
) MAIN_EXTERNALLY_VISIBLE
;
1109 void bb_displayroutes(int noresolve
, int netstatfmt
) FAST_FUNC
;
1114 int create_icmp_socket(void) FAST_FUNC
;
1115 int create_icmp6_socket(void) FAST_FUNC
;
1117 /* This structure defines protocol families and their handlers. */
1123 char* FAST_FUNC (*print
)(unsigned char *);
1124 const char* FAST_FUNC (*sprint
)(struct sockaddr
*, int numeric
);
1125 int FAST_FUNC (*input
)(/*int type,*/ const char *bufp
, struct sockaddr
*);
1126 void FAST_FUNC (*herror
)(char *text
);
1127 int FAST_FUNC (*rprint
)(int options
);
1128 int FAST_FUNC (*rinput
)(int typ
, int ext
, char **argv
);
1129 /* may modify src */
1130 int FAST_FUNC (*getmask
)(char *src
, struct sockaddr
*mask
, char *name
);
1132 /* This structure defines hardware protocols and their handlers. */
1138 char* FAST_FUNC (*print
)(unsigned char *);
1139 int FAST_FUNC (*input
)(const char *, struct sockaddr
*);
1140 int FAST_FUNC (*activate
)(int fd
);
1141 int suppress_null_addr
;
1143 extern smallint interface_opt_a
;
1144 int display_interfaces(char *ifname
) FAST_FUNC
;
1145 #if ENABLE_FEATURE_HWIB
1146 int in_ib(const char *bufp
, struct sockaddr
*sap
) FAST_FUNC
;
1148 #define in_ib(a, b) 1 /* fail */
1150 const struct aftype
*get_aftype(const char *name
) FAST_FUNC
;
1151 const struct hwtype
*get_hwtype(const char *name
) FAST_FUNC
;
1152 const struct hwtype
*get_hwntype(int type
) FAST_FUNC
;
1155 #ifndef BUILD_INDIVIDUAL
1156 extern int find_applet_by_name(const char *name
) FAST_FUNC
;
1157 /* Returns only if applet is not found. */
1158 extern void run_applet_and_exit(const char *name
, char **argv
) FAST_FUNC
;
1159 extern void run_applet_no_and_exit(int a
, char **argv
) NORETURN FAST_FUNC
;
1162 #ifdef HAVE_MNTENT_H
1163 extern int match_fstype(const struct mntent
*mt
, const char *fstypes
) FAST_FUNC
;
1164 extern struct mntent
*find_mount_point(const char *name
, int subdir_too
) FAST_FUNC
;
1166 extern void erase_mtab(const char * name
) FAST_FUNC
;
1167 extern unsigned int tty_baud_to_value(speed_t speed
) FAST_FUNC
;
1168 extern speed_t
tty_value_to_baud(unsigned int value
) FAST_FUNC
;
1170 extern void bb_warn_ignoring_args(char *arg
) FAST_FUNC
;
1172 # define bb_warn_ignoring_args(arg) ((void)0)
1175 extern int get_linux_version_code(void) FAST_FUNC
;
1177 extern char *query_loop(const char *device
) FAST_FUNC
;
1178 extern int del_loop(const char *device
) FAST_FUNC
;
1179 /* If *devname is not NULL, use that name, otherwise try to find free one,
1180 * malloc and return it in *devname.
1181 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
1182 extern int set_loop(char **devname
, const char *file
, unsigned long long offset
, int ro
) FAST_FUNC
;
1184 /* Like bb_ask below, but asks on stdin with no timeout. */
1185 char *bb_ask_stdin(const char * prompt
) FAST_FUNC
;
1186 //TODO: pass buf pointer or return allocated buf (avoid statics)?
1187 char *bb_ask(const int fd
, int timeout
, const char * prompt
) FAST_FUNC
;
1188 int bb_ask_confirmation(void) FAST_FUNC
;
1190 int bb_parse_mode(const char* s
, mode_t
* theMode
) FAST_FUNC
;
1193 * Config file parser
1196 PARSE_COLLAPSE
= 0x00010000, // treat consecutive delimiters as one
1197 PARSE_TRIM
= 0x00020000, // trim leading and trailing delimiters
1198 // TODO: COLLAPSE and TRIM seem to always go in pair
1199 PARSE_GREEDY
= 0x00040000, // last token takes entire remainder of the line
1200 PARSE_MIN_DIE
= 0x00100000, // die if < min tokens found
1201 // keep a copy of current line
1202 PARSE_KEEP_COPY
= 0x00200000 * ENABLE_FEATURE_CROND_D
,
1203 PARSE_EOL_COMMENTS
= 0x00400000, // comments are recognized even if they aren't the first char
1205 // * remove leading and trailing delimiters and collapse
1206 // multiple delimiters into one
1207 // * warn and continue if less than mintokens delimiters found
1208 // * grab everything into last token
1209 // * comments are recognized even if they aren't the first char
1210 PARSE_NORMAL
= PARSE_COLLAPSE
| PARSE_TRIM
| PARSE_GREEDY
| PARSE_EOL_COMMENTS
,
1212 typedef struct parser_t
{
1216 size_t line_alloc
, nline_alloc
;
1219 parser_t
* config_open(const char *filename
) FAST_FUNC
;
1220 parser_t
* config_open2(const char *filename
, FILE* FAST_FUNC (*fopen_func
)(const char *path
)) FAST_FUNC
;
1221 /* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
1222 int config_read(parser_t
*parser
, char **tokens
, unsigned flags
, const char *delims
) FAST_FUNC
;
1223 #define config_read(parser, tokens, max, min, str, flags) \
1224 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1225 void config_close(parser_t
*parser
) FAST_FUNC
;
1227 /* Concatenate path and filename to new allocated buffer.
1228 * Add "/" only as needed (no duplicate "//" are produced).
1229 * If path is NULL, it is assumed to be "/".
1230 * filename should not be NULL. */
1231 char *concat_path_file(const char *path
, const char *filename
) FAST_FUNC
;
1232 /* Returns NULL on . and .. */
1233 char *concat_subpath_file(const char *path
, const char *filename
) FAST_FUNC
;
1236 int bb_make_directory(char *path
, long mode
, int flags
) FAST_FUNC
;
1238 int get_signum(const char *name
) FAST_FUNC
;
1239 const char *get_signame(int number
) FAST_FUNC
;
1240 void print_signames(void) FAST_FUNC
;
1242 char *bb_simplify_path(const char *path
) FAST_FUNC
;
1243 /* Returns ptr to NUL */
1244 char *bb_simplify_abs_path_inplace(char *path
) FAST_FUNC
;
1246 #define LOGIN_FAIL_DELAY 3
1247 extern void bb_do_delay(int seconds
) FAST_FUNC
;
1248 extern void change_identity(const struct passwd
*pw
) FAST_FUNC
;
1249 extern void run_shell(const char *shell
, int loginshell
, const char *command
, const char **additional_args
) NORETURN FAST_FUNC
;
1251 /* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1252 * Note that getpwuid result might need xstrdup'ing
1253 * if there is a possibility of intervening getpwxxx() calls.
1255 const char *get_shell_name(void);
1258 extern void renew_current_security_context(void) FAST_FUNC
;
1259 extern void set_current_security_context(security_context_t sid
) FAST_FUNC
;
1260 extern context_t
set_security_context_component(security_context_t cur_context
,
1261 char *user
, char *role
, char *type
, char *range
) FAST_FUNC
;
1262 extern void setfscreatecon_or_die(security_context_t scontext
) FAST_FUNC
;
1263 extern void selinux_preserve_fcontext(int fdesc
) FAST_FUNC
;
1265 #define selinux_preserve_fcontext(fdesc) ((void)0)
1267 extern void selinux_or_die(void) FAST_FUNC
;
1270 /* systemd support */
1271 #define SD_LISTEN_FDS_START 3
1272 int sd_listen_fds(void);
1275 /* setup_environment:
1276 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
1277 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1279 * USER=pw->pw_name, LOGNAME=pw->pw_name
1280 * PATH=bb_default_[root_]path
1283 * else if change_env = 1:
1284 * if not root (if pw->pw_uid != 0):
1285 * USER=pw->pw_name, LOGNAME=pw->pw_name
1290 #define SETUP_ENV_CHANGEENV (1 << 0)
1291 #define SETUP_ENV_CLEARENV (1 << 1)
1292 #define SETUP_ENV_TO_TMP (1 << 2)
1293 extern void setup_environment(const char *shell
, int flags
, const struct passwd
*pw
) FAST_FUNC
;
1294 extern int correct_password(const struct passwd
*pw
) FAST_FUNC
;
1295 /* Returns a malloced string */
1296 #if !ENABLE_USE_BB_CRYPT
1297 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1299 extern char *pw_encrypt(const char *clear
, const char *salt
, int cleanup
) FAST_FUNC
;
1300 extern int obscure(const char *old
, const char *newval
, const struct passwd
*pwdp
) FAST_FUNC
;
1302 * rnd is additional random input. New one is returned.
1303 * Useful if you call crypt_make_salt many times in a row:
1304 * rnd = crypt_make_salt(buf1, 4, 0);
1305 * rnd = crypt_make_salt(buf2, 4, rnd);
1306 * rnd = crypt_make_salt(buf3, 4, rnd);
1307 * (otherwise we risk having same salt generated)
1309 extern int crypt_make_salt(char *p
, int cnt
/*, int rnd*/) FAST_FUNC
;
1310 /* "$N$" + sha_salt_16_bytes + NUL */
1311 #define MAX_PW_SALT_LEN (3 + 16 + 1)
1312 extern char* crypt_make_pw_salt(char p
[MAX_PW_SALT_LEN
], const char *algo
) FAST_FUNC
;
1315 /* Returns number of lines changed, or -1 on error */
1316 #if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1317 #define update_passwd(filename, username, data, member) \
1318 update_passwd(filename, username, data)
1320 extern int update_passwd(const char *filename
,
1321 const char *username
,
1323 const char *member
) FAST_FUNC
;
1325 int index_in_str_array(const char *const string_array
[], const char *key
) FAST_FUNC
;
1326 int index_in_strings(const char *strings
, const char *key
) FAST_FUNC
;
1327 int index_in_substr_array(const char *const string_array
[], const char *key
) FAST_FUNC
;
1328 int index_in_substrings(const char *strings
, const char *key
) FAST_FUNC
;
1329 const char *nth_string(const char *strings
, int n
) FAST_FUNC
;
1331 extern void print_login_issue(const char *issue_file
, const char *tty
) FAST_FUNC
;
1332 extern void print_login_prompt(void) FAST_FUNC
;
1334 char *xmalloc_ttyname(int fd
) FAST_FUNC RETURNS_MALLOC
;
1335 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1336 int get_terminal_width_height(int fd
, unsigned *width
, unsigned *height
) FAST_FUNC
;
1338 int tcsetattr_stdin_TCSANOW(const struct termios
*tp
) FAST_FUNC
;
1340 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1341 int ioctl_or_perror(int fd
, unsigned request
, void *argp
, const char *fmt
,...) __attribute__ ((format (printf
, 4, 5))) FAST_FUNC
;
1342 int ioctl_or_perror_and_die(int fd
, unsigned request
, void *argp
, const char *fmt
,...) __attribute__ ((format (printf
, 4, 5))) FAST_FUNC
;
1343 #if ENABLE_IOCTL_HEX2STR_ERROR
1344 int bb_ioctl_or_warn(int fd
, unsigned request
, void *argp
, const char *ioctl_name
) FAST_FUNC
;
1345 int bb_xioctl(int fd
, unsigned request
, void *argp
, const char *ioctl_name
) FAST_FUNC
;
1346 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1347 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1349 int bb_ioctl_or_warn(int fd
, unsigned request
, void *argp
) FAST_FUNC
;
1350 int bb_xioctl(int fd
, unsigned request
, void *argp
) FAST_FUNC
;
1351 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1352 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1355 char *is_in_ino_dev_hashtable(const struct stat
*statbuf
) FAST_FUNC
;
1356 void add_to_ino_dev_hashtable(const struct stat
*statbuf
, const char *name
) FAST_FUNC
;
1357 void reset_ino_dev_hashtable(void) FAST_FUNC
;
1359 /* At least glibc has horrendously large inline for this, so wrap it */
1360 unsigned long long bb_makedev(unsigned major
, unsigned minor
) FAST_FUNC
;
1362 #define makedev(a,b) bb_makedev(a,b)
1366 /* "Keycodes" that report an escape sequence.
1367 * We use something which fits into signed char,
1368 * yet doesn't represent any valid Unicode character.
1369 * Also, -1 is reserved for error indication and we don't use it. */
1377 KEYCODE_INSERT
= -8,
1378 KEYCODE_DELETE
= -9,
1379 KEYCODE_PAGEUP
= -10,
1380 KEYCODE_PAGEDOWN
= -11,
1381 // -12 is reserved for Alt/Ctrl/Shift-TAB
1392 KEYCODE_FUN10
= -22,
1393 KEYCODE_FUN11
= -23,
1394 KEYCODE_FUN12
= -24,
1396 /* Be sure that last defined value is small enough
1397 * to not interfere with Alt/Ctrl/Shift bits.
1398 * So far we do not exceed -31 (0xfff..fffe1),
1399 * which gives us three upper bits in LSB to play with.
1401 //KEYCODE_SHIFT_TAB = (-12) & ~0x80,
1402 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1403 //KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1404 //KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
1405 KEYCODE_CTRL_RIGHT
= KEYCODE_RIGHT
& ~0x40,
1406 KEYCODE_CTRL_LEFT
= KEYCODE_LEFT
& ~0x40,
1407 //KEYCODE_ALT_UP = KEYCODE_UP & ~0x20,
1408 //KEYCODE_ALT_DOWN = KEYCODE_DOWN & ~0x20,
1409 KEYCODE_ALT_RIGHT
= KEYCODE_RIGHT
& ~0x20,
1410 KEYCODE_ALT_LEFT
= KEYCODE_LEFT
& ~0x20,
1412 KEYCODE_CURSOR_POS
= -0x100, /* 0xfff..fff00 */
1413 /* How long is the longest ESC sequence we know?
1414 * We want it big enough to be able to contain
1415 * cursor position sequence "ESC [ 9999 ; 9999 R"
1417 KEYCODE_BUFFER_SIZE
= 16
1419 /* Note: fd may be in blocking or non-blocking mode, both make sense.
1420 * For one, less uses non-blocking mode.
1421 * Only the first read syscall inside read_key may block indefinitely
1422 * (unless fd is in non-blocking mode),
1423 * subsequent reads will time out after a few milliseconds.
1424 * Return of -1 means EOF or error (errno == 0 on EOF).
1425 * buffer[0] is used as a counter of buffered chars and must be 0
1428 * -2: do not poll for input;
1429 * -1: poll(-1) (i.e. block);
1430 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
1432 int64_t read_key(int fd
, char *buffer
, int timeout
) FAST_FUNC
;
1433 void read_key_ungets(char *buffer
, const char *str
, unsigned len
) FAST_FUNC
;
1436 #if ENABLE_FEATURE_EDITING
1437 /* It's NOT just ENABLEd or disabled. It's a number: */
1438 # if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
1439 # define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1440 unsigned size_from_HISTFILESIZE(const char *hp
);
1442 # define MAX_HISTORY 0
1444 typedef struct line_input_t
{
1446 const char *path_lookup
;
1450 int max_history
; /* must never be <= 0 */
1451 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1452 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1453 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1454 * in on-disk history"
1455 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1456 * also in on-disk history (and thus need to be skipped on save)"
1458 unsigned cnt_history_in_file
;
1459 const char *hist_file
;
1461 char *history
[MAX_HISTORY
+ 1];
1465 DO_HISTORY
= 1 * (MAX_HISTORY
> 0),
1466 TAB_COMPLETION
= 2 * ENABLE_FEATURE_TAB_COMPLETION
,
1467 USERNAME_COMPLETION
= 4 * ENABLE_FEATURE_USERNAME_COMPLETION
,
1468 VI_MODE
= 8 * ENABLE_FEATURE_EDITING_VI
,
1469 WITH_PATH_LOOKUP
= 0x10,
1470 FOR_SHELL
= DO_HISTORY
| TAB_COMPLETION
| USERNAME_COMPLETION
,
1472 line_input_t
*new_line_input_t(int flags
) FAST_FUNC
;
1473 /* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1475 * maxsize must be >= 2.
1477 * -1 on read errors or EOF, or on bare Ctrl-D,
1478 * 0 on ctrl-C (the line entered is still returned in 'command'),
1479 * >0 length of input string, including terminating '\n'
1481 int read_line_input(line_input_t
*st
, const char *prompt
, char *command
, int maxsize
, int timeout
) FAST_FUNC
;
1482 # if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1483 void save_history(line_input_t
*st
);
1486 #define MAX_HISTORY 0
1487 int read_line_input(const char* prompt
, char* command
, int maxsize
) FAST_FUNC
;
1488 #define read_line_input(state, prompt, command, maxsize, timeout) \
1489 read_line_input(prompt, command, maxsize)
1494 # ifdef TASK_COMM_LEN
1495 enum { COMM_LEN
= TASK_COMM_LEN
};
1497 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1498 enum { COMM_LEN
= 16 };
1503 unsigned long mapped_rw
;
1504 unsigned long mapped_ro
;
1505 unsigned long shared_clean
;
1506 unsigned long shared_dirty
;
1507 unsigned long private_clean
;
1508 unsigned long private_dirty
;
1509 unsigned long stack
;
1510 unsigned long smap_pss
, smap_swap
;
1511 unsigned long smap_size
;
1512 unsigned long smap_start
;
1518 #define procps_read_smaps(pid, total, cb, data) \
1519 procps_read_smaps(pid, total)
1521 int FAST_FUNC
procps_read_smaps(pid_t pid
, struct smaprec
*total
,
1522 void (*cb
)(struct smaprec
*, void *), void *data
);
1524 typedef struct procps_status_t
{
1526 IF_FEATURE_SHOW_THREADS(DIR *task_dir
;)
1527 uint8_t shift_pages_to_bytes
;
1528 uint8_t shift_pages_to_kb
;
1529 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1533 IF_SELINUX(char *context
;)
1534 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid
;)
1535 /* Everything below must contain no ptrs to malloc'ed data:
1536 * it is memset(0) for each process in procps_scan() */
1537 unsigned long vsz
, rss
; /* we round it to kbytes */
1538 unsigned long stime
, utime
;
1539 unsigned long start_time
;
1546 #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1551 unsigned tty_major
,tty_minor
;
1552 #if ENABLE_FEATURE_TOPMEM
1553 struct smaprec smaps
;
1556 /* basename of executable in exec(2), read from /proc/N/stat
1557 * (if executable is symlink or script, it is NOT replaced
1558 * by link target or interpreter name) */
1559 char comm
[COMM_LEN
];
1560 /* user/group? - use passwd/group parsing functions */
1561 #if ENABLE_FEATURE_TOP_SMP_PROCESS
1562 int last_seen_on_cpu
;
1565 /* flag bits for procps_scan(xx, flags) calls */
1567 PSSCAN_PID
= 1 << 0,
1568 PSSCAN_PPID
= 1 << 1,
1569 PSSCAN_PGID
= 1 << 2,
1570 PSSCAN_SID
= 1 << 3,
1571 PSSCAN_UIDGID
= 1 << 4,
1572 PSSCAN_COMM
= 1 << 5,
1573 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
1574 PSSCAN_ARGV0
= 1 << 7,
1575 PSSCAN_EXE
= 1 << 8,
1576 PSSCAN_STATE
= 1 << 9,
1577 PSSCAN_VSZ
= 1 << 10,
1578 PSSCAN_RSS
= 1 << 11,
1579 PSSCAN_STIME
= 1 << 12,
1580 PSSCAN_UTIME
= 1 << 13,
1581 PSSCAN_TTY
= 1 << 14,
1582 PSSCAN_SMAPS
= (1 << 15) * ENABLE_FEATURE_TOPMEM
,
1583 /* NB: used by find_pid_by_name(). Any applet using it
1584 * needs to be mentioned here. */
1585 PSSCAN_ARGVN
= (1 << 16) * (ENABLE_KILLALL
1586 || ENABLE_PGREP
|| ENABLE_PKILL
1590 PSSCAN_CONTEXT
= (1 << 17) * ENABLE_SELINUX
,
1591 PSSCAN_START_TIME
= 1 << 18,
1592 PSSCAN_CPU
= (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS
,
1593 PSSCAN_NICE
= (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
,
1594 PSSCAN_RUIDGID
= (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
,
1595 PSSCAN_TASKS
= (1 << 22) * ENABLE_FEATURE_SHOW_THREADS
,
1597 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1598 void free_procps_scan(procps_status_t
* sp
) FAST_FUNC
;
1599 procps_status_t
* procps_scan(procps_status_t
* sp
, int flags
) FAST_FUNC
;
1600 /* Format cmdline (up to col chars) into char buf[size] */
1601 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1602 void read_cmdline(char *buf
, int size
, unsigned pid
, const char *comm
) FAST_FUNC
;
1603 pid_t
*find_pid_by_name(const char* procName
) FAST_FUNC
;
1604 pid_t
*pidlist_reverse(pid_t
*pidList
) FAST_FUNC
;
1605 int starts_with_cpu(const char *str
) FAST_FUNC
;
1606 unsigned get_cpu_count(void) FAST_FUNC
;
1609 /* Use strict=1 if you process input from untrusted source:
1610 * it will return NULL on invalid %xx (bad hex chars)
1611 * and str + 1 if decoded char is / or NUL.
1612 * In non-strict mode, it always succeeds (returns str),
1613 * and also it additionally decoded '+' to space.
1615 char *percent_decode_in_place(char *str
, int strict
) FAST_FUNC
;
1618 extern const char bb_uuenc_tbl_base64
[];
1619 extern const char bb_uuenc_tbl_std
[];
1620 void bb_uuencode(char *store
, const void *s
, int length
, const char *tbl
) FAST_FUNC
;
1622 BASE64_FLAG_UU_STOP
= 0x100,
1623 /* Sign-extends to a value which never matches fgetc result: */
1624 BASE64_FLAG_NO_STOP_CHAR
= 0x80,
1626 const char *decode_base64(char **pp_dst
, const char *src
) FAST_FUNC
;
1627 void read_base64(FILE *src_stream
, FILE *dst_stream
, int flags
) FAST_FUNC
;
1629 typedef struct md5_ctx_t
{
1630 uint8_t wbuffer
[64]; /* always correctly aligned for uint64_t */
1631 void (*process_block
)(struct md5_ctx_t
*) FAST_FUNC
;
1632 uint64_t total64
; /* must be directly before hash[] */
1633 uint32_t hash
[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1635 typedef struct md5_ctx_t sha1_ctx_t
;
1636 typedef struct md5_ctx_t sha256_ctx_t
;
1637 typedef struct sha512_ctx_t
{
1638 uint64_t total64
[2]; /* must be directly before hash[] */
1640 uint8_t wbuffer
[128]; /* always correctly aligned for uint64_t */
1642 void md5_begin(md5_ctx_t
*ctx
) FAST_FUNC
;
1643 void md5_hash(md5_ctx_t
*ctx
, const void *data
, size_t length
) FAST_FUNC
;
1644 void md5_end(md5_ctx_t
*ctx
, void *resbuf
) FAST_FUNC
;
1645 void sha1_begin(sha1_ctx_t
*ctx
) FAST_FUNC
;
1646 #define sha1_hash md5_hash
1647 void sha1_end(sha1_ctx_t
*ctx
, void *resbuf
) FAST_FUNC
;
1648 void sha256_begin(sha256_ctx_t
*ctx
) FAST_FUNC
;
1649 #define sha256_hash md5_hash
1650 #define sha256_end sha1_end
1651 void sha512_begin(sha512_ctx_t
*ctx
) FAST_FUNC
;
1652 void sha512_hash(sha512_ctx_t
*ctx
, const void *buffer
, size_t len
) FAST_FUNC
;
1653 void sha512_end(sha512_ctx_t
*ctx
, void *resbuf
) FAST_FUNC
;
1655 extern uint32_t *global_crc32_table
;
1656 uint32_t *crc32_filltable(uint32_t *tbl256
, int endian
) FAST_FUNC
;
1657 uint32_t crc32_block_endian1(uint32_t val
, const void *buf
, unsigned len
, uint32_t *crc_table
) FAST_FUNC
;
1658 uint32_t crc32_block_endian0(uint32_t val
, const void *buf
, unsigned len
, uint32_t *crc_table
) FAST_FUNC
;
1660 typedef struct masks_labels_t
{
1664 int print_flags_separated(const int *masks
, const char *labels
,
1665 int flags
, const char *separator
) FAST_FUNC
;
1666 int print_flags(const masks_labels_t
*ml
, int flags
) FAST_FUNC
;
1668 typedef struct bb_progress_t
{
1670 unsigned last_update_sec
;
1671 unsigned last_change_sec
;
1673 const char *curfile
;
1676 #define is_bb_progress_inited(p) ((p)->curfile != NULL)
1677 #define bb_progress_free(p) do { \
1678 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1679 (p)->curfile = NULL; \
1681 void bb_progress_init(bb_progress_t
*p
, const char *curfile
) FAST_FUNC
;
1682 void bb_progress_update(bb_progress_t
*p
,
1685 uoff_t totalsize
) FAST_FUNC
;
1688 extern const char *applet_name
;
1690 /* Some older linkers don't perform string merging, we used to have common strings
1691 * as global arrays to do it by hand. But:
1692 * (1) newer linkers do it themselves,
1693 * (2) however, they DONT merge string constants with global arrays,
1694 * even if the value is the same (!). Thus global arrays actually
1695 * increased size a bit: for example, "/etc/passwd" string from libc
1696 * wasn't merged with bb_path_passwd_file[] array!
1697 * Therefore now we use #defines.
1699 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1700 extern const char bb_banner
[];
1701 extern const char bb_msg_memory_exhausted
[];
1702 extern const char bb_msg_invalid_date
[];
1703 #define bb_msg_read_error "read error"
1704 #define bb_msg_write_error "write error"
1705 extern const char bb_msg_unknown
[];
1706 extern const char bb_msg_can_not_create_raw_socket
[];
1707 extern const char bb_msg_perm_denied_are_you_root
[];
1708 extern const char bb_msg_you_must_be_root
[];
1709 extern const char bb_msg_requires_arg
[];
1710 extern const char bb_msg_invalid_arg
[];
1711 extern const char bb_msg_standard_input
[];
1712 extern const char bb_msg_standard_output
[];
1714 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1715 extern const char bb_hexdigits_upcase
[];
1717 extern const char bb_path_wtmp_file
[];
1719 /* Busybox mount uses either /proc/mounts or /etc/mtab to
1720 * get the list of currently mounted filesystems */
1721 #define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1723 #define bb_path_passwd_file _PATH_PASSWD
1724 #define bb_path_group_file _PATH_GROUP
1725 #define bb_path_shadow_file _PATH_SHADOW
1726 #define bb_path_gshadow_file _PATH_GSHADOW
1728 #define bb_path_motd_file "/etc/motd"
1730 #define bb_dev_null "/dev/null"
1731 extern const char bb_busybox_exec_path
[];
1732 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1733 * but I want to save a few bytes here */
1734 extern const char bb_PATH_root_path
[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1735 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1736 #define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin:/opt/sbin"))
1738 extern const int const_int_0
;
1739 extern const int const_int_1
;
1742 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1743 enum { COMMON_BUFSIZE
= (BUFSIZ
>= 256*sizeof(void*) ? BUFSIZ
+1 : 256*sizeof(void*)) };
1744 extern char bb_common_bufsiz1
[COMMON_BUFSIZE
];
1745 /* This struct is deliberately not defined. */
1746 /* See docs/keep_data_small.txt */
1748 /* '*const' ptr makes gcc optimize code much better.
1749 * Magic prevents ptr_to_globals from going into rodata.
1750 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1751 extern struct globals
*const ptr_to_globals
;
1752 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1753 #define barrier() __asm__ __volatile__("":::"memory")
1754 #define SET_PTR_TO_GLOBALS(x) do { \
1755 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
1759 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1760 * use bb_default_login_shell and following defines.
1761 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1762 * don't forget to change increment constant. */
1763 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
1764 extern const char bb_default_login_shell
[];
1766 #define DEFAULT_SHELL (bb_default_login_shell+1)
1768 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1770 /* The following devices are the same on all systems. */
1771 #define CURRENT_TTY "/dev/tty"
1772 #define DEV_CONSOLE "/dev/console"
1774 #if defined(__FreeBSD_kernel__)
1775 # define CURRENT_VC CURRENT_TTY
1776 # define VC_1 "/dev/ttyv0"
1777 # define VC_2 "/dev/ttyv1"
1778 # define VC_3 "/dev/ttyv2"
1779 # define VC_4 "/dev/ttyv3"
1780 # define VC_5 "/dev/ttyv4"
1781 # define VC_FORMAT "/dev/ttyv%d"
1782 #elif defined(__GNU__)
1783 # define CURRENT_VC CURRENT_TTY
1784 # define VC_1 "/dev/tty1"
1785 # define VC_2 "/dev/tty2"
1786 # define VC_3 "/dev/tty3"
1787 # define VC_4 "/dev/tty4"
1788 # define VC_5 "/dev/tty5"
1789 # define VC_FORMAT "/dev/tty%d"
1790 #elif ENABLE_FEATURE_DEVFS
1791 /*Linux, obsolete devfs names */
1792 # define CURRENT_VC "/dev/vc/0"
1793 # define VC_1 "/dev/vc/1"
1794 # define VC_2 "/dev/vc/2"
1795 # define VC_3 "/dev/vc/3"
1796 # define VC_4 "/dev/vc/4"
1797 # define VC_5 "/dev/vc/5"
1798 # define VC_FORMAT "/dev/vc/%d"
1799 # define LOOP_FORMAT "/dev/loop/%d"
1800 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1801 # define LOOP_NAME "/dev/loop/"
1802 # define FB_0 "/dev/fb/0"
1804 /*Linux, normal names */
1805 # define CURRENT_VC "/dev/tty0"
1806 # define VC_1 "/dev/tty1"
1807 # define VC_2 "/dev/tty2"
1808 # define VC_3 "/dev/tty3"
1809 # define VC_4 "/dev/tty4"
1810 # define VC_5 "/dev/tty5"
1811 # define VC_FORMAT "/dev/tty%d"
1812 # define LOOP_FORMAT "/dev/loop%d"
1813 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1814 # define LOOP_NAME "/dev/loop"
1815 # define FB_0 "/dev/fb0"
1819 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1822 /* We redefine ctype macros. Unicode-correct handling of char types
1823 * can't be done with such byte-oriented operations anyway,
1824 * we don't lose anything.
1842 /* We save ~500 bytes on isdigit alone.
1843 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
1845 /* These work the same for ASCII and Unicode,
1846 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
1847 #define isascii(a) ((unsigned char)(a) <= 0x7f)
1848 #define isdigit(a) ((unsigned char)((a) - '0') <= 9)
1849 #define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1850 #define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
1851 #define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
1852 #define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1853 #define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
1854 /* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
1855 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
1857 #define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
1858 // Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1859 #define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1860 // Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
1861 #define isalnum(a) bb_ascii_isalnum(a)
1862 static ALWAYS_INLINE
int bb_ascii_isalnum(unsigned char a
)
1864 unsigned char b
= a
- '0';
1868 return b
<= 'z' - 'a';
1870 #define isxdigit(a) bb_ascii_isxdigit(a)
1871 static ALWAYS_INLINE
int bb_ascii_isxdigit(unsigned char a
)
1873 unsigned char b
= a
- '0';
1877 return b
<= 'f' - 'a';
1879 #define toupper(a) bb_ascii_toupper(a)
1880 static ALWAYS_INLINE
unsigned char bb_ascii_toupper(unsigned char a
)
1882 unsigned char b
= a
- 'a';
1883 if (b
<= ('z' - 'a'))
1887 #define tolower(a) bb_ascii_tolower(a)
1888 static ALWAYS_INLINE
unsigned char bb_ascii_tolower(unsigned char a
)
1890 unsigned char b
= a
- 'A';
1891 if (b
<= ('Z' - 'A'))
1896 /* In ASCII and Unicode, these are likely to be very different.
1897 * Let's prevent ambiguous usage from the start */
1898 #define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1899 #define isprint(a) isprint_is_ambiguous_dont_use(a)
1900 /* NB: must not treat EOF as isgraph or isprint */
1901 #define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1902 #define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1905 POP_SAVED_FUNCTION_VISIBILITY