1 /* vi: set sw=4 ts=4: */
3 * Busybox main internal header file
5 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
6 * Permission has been granted to redistribute this code under the GPL.
8 * Licensed under the GPL version 2, see the file LICENSE in this tarball.
10 #ifndef __LIBBUSYBOX_H__
11 #define __LIBBUSYBOX_H__ 1
29 #include <sys/ioctl.h>
31 #include <sys/socket.h>
34 #include <sys/types.h>
40 /* Try to pull in PATH_MAX */
42 #include <sys/param.h>
51 #ifdef HAVE_SYS_STATFS_H
52 #include <sys/statfs.h>
56 #include <selinux/selinux.h>
57 #include <selinux/context.h>
58 #include <selinux/flask.h>
59 #include <selinux/av_permissions.h>
62 #if ENABLE_LOCALE_SUPPORT
65 #define setlocale(x,y) ((void)0)
74 #if ENABLE_FEATURE_SHADOWPASSWDS
78 /* Some libc's forget to declare these, do it ourself */
80 extern char **environ;
81 #if defined(__GLIBC__) && __GLIBC__ < 2
82 int vdprintf(int d, const char *format, va_list ap);
84 /* klogctl is in libc's klog.h, but we cheat and not #include that */
85 int klogctl(int type, char *b, int len);
86 /* This is declared here rather than #including <libgen.h> in order to avoid
87 * confusing the two versions of basename. See the dirname/basename man page
89 char *dirname(char *path);
90 /* Include our own copy of struct sysinfo to avoid binary compatibility
91 * problems with Linux 2.4, which changed things. Grumble, grumble. */
93 long uptime; /* Seconds since boot */
94 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
95 unsigned long totalram; /* Total usable main memory size */
96 unsigned long freeram; /* Available memory size */
97 unsigned long sharedram; /* Amount of shared memory */
98 unsigned long bufferram; /* Memory used by buffers */
99 unsigned long totalswap; /* Total swap space size */
100 unsigned long freeswap; /* swap space still available */
101 unsigned short procs; /* Number of current processes */
102 unsigned short pad; /* Padding needed for m68k */
103 unsigned long totalhigh; /* Total high memory size */
104 unsigned long freehigh; /* Available high memory size */
105 unsigned int mem_unit; /* Memory unit size in bytes */
106 char _f[20 - 2 * sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
108 int sysinfo(struct sysinfo* info);
111 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
112 /* (don't include system headers after this until corresponding pop!) */
113 #if __GNUC_PREREQ(4,1)
114 # pragma GCC visibility push(hidden)
118 #if ENABLE_USE_BB_PWD_GRP
122 #if ENABLE_FEATURE_SHADOWPASSWDS
123 # if ENABLE_USE_BB_SHADOW
124 # include "shadow_.h"
128 /* Tested to work correctly with all int types (IIRC :]) */
129 #define MAXINT(T) (T)( \
132 : (T)~((T)1 << (sizeof(T)*8-1)) \
135 #define MININT(T) (T)( \
138 : ((T)1 << (sizeof(T)*8-1)) \
141 /* Large file support */
142 /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
143 * (stat, lseek etc) mapped to "largefile" variants by libc.
144 * Practically it means that open() automatically has O_LARGEFILE added
145 * and all filesize/file_offset parameters and struct members are "large"
146 * (in today's world - signed 64bit). For full support of large files,
147 * we need a few helper #defines (below) and careful use of off_t
148 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
150 /* CONFIG_LFS is on */
151 # if ULONG_MAX > 0xffffffff
152 /* "long" is long enough on this system */
153 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
154 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
155 # define BB_STRTOOFF bb_strtoul
156 # define STRTOOFF strtoul
157 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
160 /* "long" is too short, need "long long" */
161 # define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
162 # define BB_STRTOOFF bb_strtoull
163 # define STRTOOFF strtoull
164 # define OFF_FMT "ll"
167 /* CONFIG_LFS is off */
168 # if UINT_MAX == 0xffffffff
169 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
170 * gcc will throw warnings on printf("%d", off_t). Crap... */
171 # define XATOOFF(a) xatoi_u(a)
172 # define BB_STRTOOFF bb_strtou
173 # define STRTOOFF strtol
176 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
177 # define BB_STRTOOFF bb_strtoul
178 # define STRTOOFF strtol
182 /* scary. better ideas? (but do *test* them first!) */
183 #define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
185 /* Some useful definitions */
187 #define FALSE ((int) 0)
189 #define TRUE ((int) 1)
191 #define SKIP ((int) 2)
194 #define MTAB_GETMOUNTPT '1'
195 #define MTAB_GETDEVICE '2'
197 #define BUF_SIZE 8192
198 #define EXPAND_ALLOC 1024
200 /* Macros for min/max. */
202 #define MIN(a,b) (((a)<(b))?(a):(b))
206 #define MAX(a,b) (((a)>(b))?(a):(b))
209 /* buffer allocation schemes */
210 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
211 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
212 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
213 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
215 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
216 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
217 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
218 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
220 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
221 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
222 #define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
226 #if defined(__GLIBC__)
227 /* glibc uses __errno_location() to get a ptr to errno */
228 /* We can just memorize it once - no multithreading in busybox :) */
229 extern int *const bb_errno;
231 #define errno (*bb_errno)
234 unsigned long long monotonic_ns(void) FAST_FUNC;
235 unsigned long long monotonic_us(void) FAST_FUNC;
236 unsigned monotonic_sec(void) FAST_FUNC;
238 extern void chomp(char *s) FAST_FUNC;
239 extern void trim(char *s) FAST_FUNC;
240 extern char *skip_whitespace(const char *) FAST_FUNC;
241 extern char *skip_non_whitespace(const char *) FAST_FUNC;
242 extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
244 //TODO: supply a pointer to char[11] buffer (avoid statics)?
245 extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
246 extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
247 enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
248 FILEUTILS_PRESERVE_STATUS = 1,
249 FILEUTILS_DEREFERENCE = 2,
252 FILEUTILS_INTERACTIVE = 0x10,
253 FILEUTILS_MAKE_HARDLINK = 0x20,
254 FILEUTILS_MAKE_SOFTLINK = 0x40,
255 FILEUTILS_DEREF_SOFTLINK = 0x80,
257 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x100,
258 FILEUTILS_SET_SECURITY_CONTEXT = 0x200
261 #define FILEUTILS_CP_OPTSTR "pdRfilsL" USE_SELINUX("c")
262 extern int remove_file(const char *path, int flags) FAST_FUNC;
263 /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
264 * the source, not copy (unless "source" is a directory).
265 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
266 * work coreutils-compatibly. */
267 extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
270 ACTION_RECURSE = (1 << 0),
271 ACTION_FOLLOWLINKS = (1 << 1),
272 ACTION_FOLLOWLINKS_L0 = (1 << 2),
273 ACTION_DEPTHFIRST = (1 << 3),
274 /*ACTION_REVERSE = (1 << 4), - unused */
275 ACTION_QUIET = (1 << 5),
277 extern int recursive_action(const char *fileName, unsigned flags,
278 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
279 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
280 void* userData, unsigned depth) FAST_FUNC;
281 extern int device_open(const char *device, int mode) FAST_FUNC;
282 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
283 extern int xgetpty(char *line) FAST_FUNC;
284 extern int get_console_fd_or_die(void) FAST_FUNC;
285 extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
286 extern char *find_block_device(const char *path) FAST_FUNC;
287 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
288 extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
289 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
290 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
291 /* "short" copy can be detected by return value < size */
292 /* this helper yells "short read!" if param is not -1 */
293 extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
294 extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
295 /* xxxx_strip version can modify its parameter:
299 * "abc/def/" -> "def" !!
301 extern char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
302 /* "abc/def/" -> "" and it never modifies 'path' */
303 extern char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
305 int ndelay_on(int fd) FAST_FUNC;
306 int ndelay_off(int fd) FAST_FUNC;
307 int close_on_exec_on(int fd) FAST_FUNC;
308 void xdup2(int, int) FAST_FUNC;
309 void xmove_fd(int, int) FAST_FUNC;
312 DIR *xopendir(const char *path) FAST_FUNC;
313 DIR *warn_opendir(const char *path) FAST_FUNC;
315 /* UNUSED: char *xmalloc_realpath(const char *path) FAST_FUNC; */
316 char *xmalloc_readlink(const char *path) FAST_FUNC;
317 char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC;
318 char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
320 char *xmalloc_follow_symlinks(const char *path) FAST_FUNC;
324 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
325 * otherwise would kill us, except for those resulting from bugs:
326 * SIGSEGV, SIGILL, SIGFPE.
327 * Other fatal signals not included (TODO?):
328 * SIGBUS Bus error (bad memory access)
329 * SIGPOLL Pollable event. Synonym of SIGIO
330 * SIGPROF Profiling timer expired
331 * SIGSYS Bad argument to routine
332 * SIGTRAP Trace/breakpoint trap
334 * The only known arch with some of these sigs not fitting
335 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
336 * Dance around with long long to guard against that...
338 BB_FATAL_SIGS = (int)(0
342 + (1LL << SIGPIPE) // Write to pipe with no readers
343 + (1LL << SIGQUIT) // Quit from keyboard
344 + (1LL << SIGABRT) // Abort signal from abort(3)
345 + (1LL << SIGALRM) // Timer signal from alarm(2)
346 + (1LL << SIGVTALRM) // Virtual alarm clock
347 + (1LL << SIGXCPU) // CPU time limit exceeded
348 + (1LL << SIGXFSZ) // File size limit exceeded
349 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
353 void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
354 /* Unlike signal() and bb_signals, sets handler with sigaction()
355 * and in a way that while signal handler is run, no other signals
356 * will be blocked; syscalls will not be restarted: */
357 void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
358 /* syscalls like read() will be interrupted with EINTR: */
359 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
360 /* syscalls like read() won't be interrupted (though select/poll will be): */
361 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
362 void wait_for_any_sig(void) FAST_FUNC;
363 void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
364 void sig_block(int sig) FAST_FUNC;
365 void sig_unblock(int sig) FAST_FUNC;
366 /* Will do sigaction(signum, act, NULL): */
367 int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
368 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
369 int sigprocmask_allsigs(int how) FAST_FUNC;
370 /* Standard handler which just records signo */
371 extern smallint bb_got_signal;
372 void record_signo(int signo); /* not FAST_FUNC! */
375 void xsetgid(gid_t gid) FAST_FUNC;
376 void xsetuid(uid_t uid) FAST_FUNC;
377 void xchdir(const char *path) FAST_FUNC;
378 void xchroot(const char *path) FAST_FUNC;
379 void xsetenv(const char *key, const char *value) FAST_FUNC;
380 void bb_unsetenv(const char *key) FAST_FUNC;
381 void xunlink(const char *pathname) FAST_FUNC;
382 void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
383 int xopen(const char *pathname, int flags) FAST_FUNC FAST_FUNC;
384 int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
385 int open_or_warn(const char *pathname, int flags) FAST_FUNC;
386 int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
387 int open_or_warn_stdin(const char *pathname) FAST_FUNC;
388 void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
389 int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
390 off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
391 off_t fdlength(int fd) FAST_FUNC;
393 void xpipe(int filedes[2]) FAST_FUNC;
394 /* In this form code with pipes is much more readable */
395 struct fd_pair { int rd; int wr; };
396 #define piped_pair(pair) pipe(&((pair).rd))
397 #define xpiped_pair(pair) xpipe(&((pair).rd))
399 /* Useful for having small structure members/global variables */
400 typedef int8_t socktype_t;
401 typedef int8_t family_t;
402 struct BUG_too_small {
403 char BUG_socktype_t_too_small[(0
410 char BUG_family_t_too_small[(0
427 int xsocket(int domain, int type, int protocol) FAST_FUNC;
428 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
429 void xlisten(int s, int backlog) FAST_FUNC;
430 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
431 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
432 socklen_t tolen) FAST_FUNC;
433 /* SO_REUSEADDR allows a server to rebind to an address that is already
434 * "in use" by old connections to e.g. previous server instance which is
435 * killed or crashed. Without it bind will fail until all such connections
436 * time out. Linux does not allow multiple live binds on same ip:port
437 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
438 * Turn it on before you call bind(). */
439 void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
440 int setsockopt_broadcast(int fd) FAST_FUNC;
441 int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
442 /* NB: returns port in host byte order */
443 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
444 typedef struct len_and_sockaddr {
448 struct sockaddr_in sin;
449 #if ENABLE_FEATURE_IPV6
450 struct sockaddr_in6 sin6;
455 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
456 LSA_SIZEOF_SA = sizeof(
459 struct sockaddr_in sin;
460 #if ENABLE_FEATURE_IPV6
461 struct sockaddr_in6 sin6;
466 /* Create stream socket, and allocate suitable lsa.
467 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
468 * af == AF_UNSPEC will result in trying to create IPv6 socket,
469 * and if kernel doesn't support it, IPv4.
471 #if ENABLE_FEATURE_IPV6
472 int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
474 int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
475 #define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
477 int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
478 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
479 * numeric IP ("N.N.N.N") or numeric IPv6 address,
480 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
481 * Only if there is no suffix, port argument is used */
482 /* NB: these set SO_REUSEADDR before bind */
483 int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
484 int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
485 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
486 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
487 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
488 * If there is no suffix, port argument is used */
489 int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
490 /* Connect to peer identified by lsa */
491 int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
492 /* Return malloc'ed len_and_sockaddr with socket address of host:port
493 * Currently will return IPv4 or IPv6 sockaddrs only
494 * (depending on host), but in theory nothing prevents e.g.
495 * UNIX socket address being returned, IPX sockaddr etc...
496 * On error does bb_error_msg and returns NULL */
497 len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC;
498 /* Version which dies on error */
499 len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC;
500 len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC;
501 /* Same, useful if you want to force family (e.g. IPv6) */
502 #if !ENABLE_FEATURE_IPV6
503 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
504 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
506 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC;
507 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC;
509 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
510 * otherwise no-op. Useful for ftp.
511 * NB: does NOT do htons() internally, just direct assignment. */
512 void set_nport(len_and_sockaddr *lsa, unsigned port) FAST_FUNC;
513 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
514 int get_nport(const struct sockaddr *sa) FAST_FUNC;
515 /* Reverse DNS. Returns NULL on failure. */
516 char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC;
517 /* This one doesn't append :PORTNUM */
518 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC;
519 /* This one also doesn't fall back to dotted IP (returns NULL) */
520 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC;
521 /* inet_[ap]ton on steroids */
522 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC;
523 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC;
524 // "old" (ipv4 only) API
525 // users: traceroute.c hostname.c - use _list_ of all IPs
526 struct hostent *xgethostbyname(const char *name) FAST_FUNC;
527 // Also mount.c and inetd.c are using gethostbyname(),
528 // + inet_common.c has additional IPv4-only stuff
531 void socket_want_pktinfo(int fd) FAST_FUNC;
532 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
533 const struct sockaddr *to,
534 const struct sockaddr *from,
535 socklen_t tolen) FAST_FUNC;
536 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
537 struct sockaddr *from,
539 socklen_t sa_size) FAST_FUNC;
541 char *xstrdup(const char *s) FAST_FUNC;
542 char *xstrndup(const char *s, int n) FAST_FUNC;
543 void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
544 char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
545 char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
546 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
547 * But potentially slow, don't use in one-billion-times loops */
548 int bb_putchar(int ch) FAST_FUNC;
549 char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
550 /* Prints unprintable chars ch as ^C or M-c to file
551 * (M-c is used only if ch is ORed with PRINTABLE_META),
552 * else it is printed as-is (except for ch = 0x9b) */
553 enum { PRINTABLE_META = 0x100 };
554 void fputc_printable(int ch, FILE *file) FAST_FUNC;
555 // gcc-4.1.1 still isn't good enough at optimizing it
556 // (+200 bytes compared to macro)
557 //static ALWAYS_INLINE
558 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
559 //static ALWAYS_INLINE
560 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
561 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
562 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
563 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
564 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
565 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
567 /* dmalloc will redefine these to it's own implementation. It is safe
568 * to have the prototypes here unconditionally. */
569 void *malloc_or_warn(size_t size) FAST_FUNC;
570 void *xmalloc(size_t size) FAST_FUNC;
571 void *xzalloc(size_t size) FAST_FUNC;
572 void *xrealloc(void *old, size_t size) FAST_FUNC;
573 /* After xrealloc_vector(v, 4, idx) it's ok to use
574 * at least v[idx] and v[idx+1], for all idx values.
575 * shift specifies how many new elements are added (1: 2, 2: 4... 8: 256...)
576 * when all elements are used up. New elements are zeroed out. */
577 #define xrealloc_vector(vector, shift, idx) \
578 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
579 void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
582 extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
583 extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count) FAST_FUNC;
584 // NB: will return short read on error, not -1,
585 // if some data was read before error occurred
586 extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
587 extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
588 extern unsigned char xread_char(int fd) FAST_FUNC;
589 extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
590 extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
591 // Reads one line a-la fgets (but doesn't save terminating '\n').
592 // Reads byte-by-byte. Useful when it is important to not read ahead.
593 // Bytes are appended to pfx (which must be malloced, or NULL).
594 extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p) FAST_FUNC;
595 /* Reads block up to *maxsz_p (default: MAX_INT(ssize_t)) */
596 extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC;
597 /* Returns NULL if file can't be opened */
598 extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC;
599 /* Autodetects .gz etc */
600 extern int open_zipped(const char *fname) FAST_FUNC;
601 extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC;
602 /* Never returns NULL */
603 extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC;
605 extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
606 // NB: will return short write on error, not -1,
607 // if some data was written before error occurred
608 extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
609 extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
610 extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
612 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
613 extern void xprint_and_close_file(FILE *file) FAST_FUNC;
615 extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
616 extern char *bb_get_chunk_with_continuation(FILE *file, int *end, int *lineno) FAST_FUNC;
617 /* Reads up to (and including) TERMINATING_STRING: */
618 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC;
619 /* Chops off TERMINATING_STRING from the end: */
620 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC;
621 /* Reads up to (and including) "\n" or NUL byte: */
622 extern char *xmalloc_fgets(FILE *file) FAST_FUNC;
623 /* Chops off '\n' from the end, unlike fgets: */
624 extern char *xmalloc_fgetline(FILE *file) FAST_FUNC;
625 /* Same, but doesn't try to conserve space (may have some slack after the end) */
626 /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC; */
628 extern void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
629 extern void die_if_ferror_stdout(void) FAST_FUNC;
630 extern void xfflush_stdout(void) FAST_FUNC;
631 extern void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
632 extern int fclose_if_not_stdin(FILE *file) FAST_FUNC;
633 extern FILE *xfopen(const char *filename, const char *mode) FAST_FUNC;
634 /* Prints warning to stderr and returns NULL on failure: */
635 extern FILE *fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
636 /* "Opens" stdin if filename is special, else just opens file: */
637 extern FILE *xfopen_stdin(const char *filename) FAST_FUNC;
638 extern FILE *fopen_or_warn_stdin(const char *filename) FAST_FUNC;
639 extern FILE* fopen_for_read(const char *path) FAST_FUNC;
640 extern FILE* xfopen_for_read(const char *path) FAST_FUNC;
641 extern FILE* fopen_for_write(const char *path) FAST_FUNC;
642 extern FILE* xfopen_for_write(const char *path) FAST_FUNC;
644 int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
645 void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
647 /* Wrapper which restarts poll on EINTR or ENOMEM.
648 * On other errors complains [perror("poll")] and returns.
649 * Warning! May take (much) longer than timeout_ms to return!
650 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
651 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
653 char *safe_gethostname(void) FAST_FUNC;
654 char *safe_getdomainname(void) FAST_FUNC;
656 /* Convert each alpha char in str to lower-case */
657 char* str_tolower(char *str) FAST_FUNC;
659 char *utoa(unsigned n) FAST_FUNC;
660 char *itoa(int n) FAST_FUNC;
661 /* Returns a pointer past the formatted number, does NOT null-terminate */
662 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
663 char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
664 /* Intelligent formatters of bignums */
665 void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
666 void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
667 //TODO: provide pointer to buf (avoid statics)?
668 const char *make_human_readable_str(unsigned long long size,
669 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
670 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
671 char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
673 /* Last element is marked by mult == 0 */
680 /* Using xatoi() instead of naive atoi() is not always convenient -
681 * in many places people want *non-negative* values, but store them
682 * in signed int. Therefore we need this one:
683 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
684 int xatoi_u(const char *numstr) FAST_FUNC;
685 /* Useful for reading port numbers */
686 uint16_t xatou16(const char *numstr) FAST_FUNC;
689 /* These parse entries in /etc/passwd and /etc/group. This is desirable
690 * for BusyBox since we want to avoid using the glibc NSS stuff, which
691 * increases target size and is often not needed on embedded systems. */
692 long xuname2uid(const char *name) FAST_FUNC;
693 long xgroup2gid(const char *name) FAST_FUNC;
694 /* wrapper: allows string to contain numeric uid or gid */
695 unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
696 /* from chpst. Does not die, returns 0 on failure */
701 /* always sets uid and gid */
702 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
703 /* always sets uid and gid, allows numeric; exits on failure */
704 void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
705 /* chown-like handling of "user[:[group]" */
706 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
707 struct passwd* xgetpwnam(const char *name) FAST_FUNC;
708 struct group* xgetgrnam(const char *name) FAST_FUNC;
709 struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
710 struct group* xgetgrgid(gid_t gid) FAST_FUNC;
711 char* xuid2uname(uid_t uid) FAST_FUNC;
712 char* xgid2group(gid_t gid) FAST_FUNC;
713 char* uid2uname(uid_t uid) FAST_FUNC;
714 char* gid2group(gid_t gid) FAST_FUNC;
715 char* uid2uname_utoa(long uid) FAST_FUNC;
716 char* gid2group_utoa(long gid) FAST_FUNC;
717 /* versions which cache results (useful for ps, ls etc) */
718 const char* get_cached_username(uid_t uid) FAST_FUNC;
719 const char* get_cached_groupname(gid_t gid) FAST_FUNC;
720 void clear_username_cache(void) FAST_FUNC;
721 /* internally usernames are saved in fixed-sized char[] buffers */
722 enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
723 #if ENABLE_FEATURE_CHECK_NAMES
724 void die_if_bad_username(const char* name) FAST_FUNC;
726 #define die_if_bad_username(name) ((void)(name))
729 int execable_file(const char *name) FAST_FUNC;
730 char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
731 int exists_execable(const char *filename) FAST_FUNC;
733 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
734 * but it may exec busybox and call applet instead of searching PATH.
736 #if ENABLE_FEATURE_PREFER_APPLETS
737 int bb_execvp(const char *file, char *const argv[]) FAST_FUNC;
738 #define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
739 #define BB_EXECLP(prog,cmd,...) \
740 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
743 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
744 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
747 /* NOMMU friendy fork+exec */
748 pid_t spawn(char **argv) FAST_FUNC;
749 pid_t xspawn(char **argv) FAST_FUNC;
751 pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
752 /* Unlike waitpid, waits ONLY for one process.
753 * It's safe to pass negative 'pids' from failed [v]fork -
754 * wait4pid will return -1 (and will not clobber [v]fork's errno).
755 * IOW: rc = wait4pid(spawn(argv));
756 * if (rc < 0) bb_perror_msg("%s", argv[0]);
757 * if (rc > 0) bb_error_msg("exit code: %d", rc);
759 int wait4pid(pid_t pid) FAST_FUNC;
760 pid_t wait_any_nohang(int *wstat) FAST_FUNC;
761 #define wait_crashed(w) ((w) & 127)
762 #define wait_exitcode(w) ((w) >> 8)
763 #define wait_stopsig(w) ((w) >> 8)
764 #define wait_stopped(w) (((w) & 127) == 127)
765 /* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
766 pid_t spawn_and_wait(char **argv) FAST_FUNC;
767 struct nofork_save_area {
769 const char *applet_name;
770 int xfunc_error_retval;
771 uint32_t option_mask32;
775 void save_nofork_data(struct nofork_save_area *save) FAST_FUNC;
776 void restore_nofork_data(struct nofork_save_area *save) FAST_FUNC;
777 /* Does NOT check that applet is NOFORK, just blindly runs it */
778 int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
779 int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv) FAST_FUNC;
781 /* Helpers for daemonization.
783 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
785 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
786 * rexec's itself on NOMMU with argv passed as command line.
787 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
788 * from the start. (It will detect it and not reexec again second time).
789 * You have to audit carefully that you don't do something twice as a result
790 * (opening files/sockets, parsing config files etc...)!
792 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
793 * (will do setsid()).
795 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
796 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
797 * Currently used for setsid only. On MMU ignores argv.
799 * Helper for network daemons in foreground mode:
801 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
802 * to /dev/null if they are not.
805 DAEMON_CHDIR_ROOT = 1,
806 DAEMON_DEVNULL_STDIO = 2,
807 DAEMON_CLOSE_EXTRA_FDS = 4,
808 DAEMON_ONLY_SANITIZE = 8, /* internal use */
811 void forkexit_or_rexec(void) FAST_FUNC;
812 enum { re_execed = 0 };
813 # define forkexit_or_rexec(argv) forkexit_or_rexec()
814 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
815 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
817 void re_exec(char **argv) NORETURN FAST_FUNC;
818 void forkexit_or_rexec(char **argv) FAST_FUNC;
819 extern bool re_execed;
820 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
821 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
822 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
823 # define fork() BUG_fork_is_unavailable_on_nommu()
824 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
825 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
827 void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
828 void bb_sanitize_stdio(void) FAST_FUNC;
829 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
830 int sanitize_env_if_suid(void) FAST_FUNC;
833 extern const char *const bb_argv_dash[]; /* "-", NULL */
834 extern const char *opt_complementary;
835 #if ENABLE_GETOPT_LONG
836 #define No_argument "\0"
837 #define Required_argument "\001"
838 #define Optional_argument "\002"
839 extern const char *applet_long_options;
841 extern uint32_t option_mask32;
842 extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
845 typedef struct llist_t {
847 struct llist_t *link;
849 void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
850 void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
851 void *llist_pop(llist_t **elm) FAST_FUNC;
852 void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
853 void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
854 llist_t *llist_rev(llist_t *list) FAST_FUNC;
855 /* BTW, surprisingly, changing API to
856 * llist_t *llist_add_to(llist_t *old_head, void *data)
857 * etc does not result in smaller code... */
859 /* start_stop_daemon and udhcpc are special - they want
860 * to create pidfiles regardless of FEATURE_PIDFILE */
861 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
862 /* True only if we created pidfile which is *file*, not /dev/null etc */
863 extern smallint wrote_pidfile;
864 void write_pidfile(const char *path) FAST_FUNC;
865 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
867 enum { wrote_pidfile = 0 };
868 #define write_pidfile(path) ((void)0)
869 #define remove_pidfile(path) ((void)0)
874 LOGMODE_STDIO = (1 << 0),
875 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
876 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
878 extern const char *msg_eol;
879 extern smallint logmode;
880 extern int die_sleep;
881 extern int xfunc_error_retval;
882 extern jmp_buf die_jmp;
883 extern void xfunc_die(void) NORETURN FAST_FUNC;
884 extern void bb_show_usage(void) NORETURN FAST_FUNC;
885 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
886 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
887 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
888 extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
889 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
890 extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
891 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
892 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
893 extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
894 extern void bb_perror_nomsg(void) FAST_FUNC;
895 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
896 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
898 /* We need to export XXX_main from libbusybox
899 * only if we build "individual" binaries
901 #if ENABLE_FEATURE_INDIVIDUAL
902 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
904 #define MAIN_EXTERNALLY_VISIBLE
908 /* Applets which are useful from another applets */
909 int bb_cat(char** argv);
910 /* If shell needs them, they exist even if not enabled as applets */
911 int echo_main(int argc, char** argv) USE_ECHO(MAIN_EXTERNALLY_VISIBLE);
912 int printf_main(int argc, char **argv) USE_PRINTF(MAIN_EXTERNALLY_VISIBLE);
913 int test_main(int argc, char **argv) USE_TEST(MAIN_EXTERNALLY_VISIBLE);
914 int kill_main(int argc, char **argv) USE_KILL(MAIN_EXTERNALLY_VISIBLE);
915 /* Similar, but used by chgrp, not shell */
916 int chown_main(int argc, char **argv) USE_CHOWN(MAIN_EXTERNALLY_VISIBLE);
917 /* Don't need USE_xxx() guard for these */
918 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
919 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
922 void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
926 /* "Keycodes" that report an escape sequence.
927 * We use something which fits into signed char,
928 * yet doesn't represent any valid Unicode characher.
929 * Also, -1 is reserved for error indication and we don't use it. */
939 KEYCODE_PAGEUP = -10,
940 KEYCODE_PAGEDOWN = -11,
955 /* How long the longest ESC sequence we know? */
956 KEYCODE_BUFFER_SIZE = 4
958 int read_key(int fd, smalluint *nbuffered, char *buffer) FAST_FUNC;
962 int create_icmp_socket(void) FAST_FUNC;
963 int create_icmp6_socket(void) FAST_FUNC;
965 /* This structure defines protocol families and their handlers. */
971 char* FAST_FUNC (*print)(unsigned char *);
972 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
973 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
974 void FAST_FUNC (*herror)(char *text);
975 int FAST_FUNC (*rprint)(int options);
976 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
978 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
980 /* This structure defines hardware protocols and their handlers. */
986 char* FAST_FUNC (*print)(unsigned char *);
987 int FAST_FUNC (*input)(const char *, struct sockaddr *);
988 int FAST_FUNC (*activate)(int fd);
989 int suppress_null_addr;
991 extern smallint interface_opt_a;
992 int display_interfaces(char *ifname) FAST_FUNC;
993 #if ENABLE_FEATURE_HWIB
994 int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
996 #define in_ib(a, b) 1 /* fail */
998 const struct aftype *get_aftype(const char *name) FAST_FUNC;
999 const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1000 const struct hwtype *get_hwntype(int type) FAST_FUNC;
1003 #ifndef BUILD_INDIVIDUAL
1004 extern int find_applet_by_name(const char *name) FAST_FUNC;
1005 /* Returns only if applet is not found. */
1006 extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
1007 extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
1010 #ifdef HAVE_MNTENT_H
1011 extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
1012 extern struct mntent *find_mount_point(const char *name, const char *table) FAST_FUNC;
1014 extern void erase_mtab(const char * name) FAST_FUNC;
1015 extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1016 extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1017 extern void bb_warn_ignoring_args(int n) FAST_FUNC;
1019 extern int get_linux_version_code(void) FAST_FUNC;
1021 extern char *query_loop(const char *device) FAST_FUNC;
1022 extern int del_loop(const char *device) FAST_FUNC;
1023 /* If *devname is not NULL, use that name, otherwise try to find free one,
1024 * malloc and return it in *devname.
1025 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
1026 extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
1028 /* Like bb_ask below, but asks on stdin with no timeout. */
1029 char *bb_ask_stdin(const char * prompt) FAST_FUNC;
1030 //TODO: pass buf pointer or return allocated buf (avoid statics)?
1031 char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
1032 int bb_ask_confirmation(void) FAST_FUNC;
1034 int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
1037 * Config file parser
1040 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1041 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1042 // TODO: COLLAPSE and TRIM seem to always go in pair
1043 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1044 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
1045 // keep a copy of current line
1046 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
1047 // PARSE_ESCAPE = 0x00400000, // process escape sequences in tokens
1049 // * remove leading and trailing delimiters and collapse
1050 // multiple delimiters into one
1051 // * warn and continue if less than mintokens delimiters found
1052 // * grab everything into last token
1053 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
1055 typedef struct parser_t {
1061 parser_t* config_open(const char *filename) FAST_FUNC;
1062 parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
1063 int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1064 #define config_read(parser, tokens, max, min, str, flags) \
1065 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1066 void config_close(parser_t *parser) FAST_FUNC;
1068 /* Concatenate path and filename to new allocated buffer.
1069 * Add "/" only as needed (no duplicate "//" are produced).
1070 * If path is NULL, it is assumed to be "/".
1071 * filename should not be NULL. */
1072 char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1073 char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1074 const char *bb_basename(const char *name) FAST_FUNC;
1075 /* NB: can violate const-ness (similarly to strchr) */
1076 char *last_char_is(const char *s, int c) FAST_FUNC;
1079 int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1081 int get_signum(const char *name) FAST_FUNC;
1082 const char *get_signame(int number) FAST_FUNC;
1083 void print_signames(void) FAST_FUNC;
1085 char *bb_simplify_path(const char *path) FAST_FUNC;
1087 #define FAIL_DELAY 3
1088 extern void bb_do_delay(int seconds) FAST_FUNC;
1089 extern void change_identity(const struct passwd *pw) FAST_FUNC;
1090 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
1091 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) FAST_FUNC;
1093 extern void renew_current_security_context(void) FAST_FUNC;
1094 extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1095 extern context_t set_security_context_component(security_context_t cur_context,
1096 char *user, char *role, char *type, char *range) FAST_FUNC;
1097 extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1098 extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1100 #define selinux_preserve_fcontext(fdesc) ((void)0)
1102 extern void selinux_or_die(void) FAST_FUNC;
1103 extern int restricted_shell(const char *shell) FAST_FUNC;
1105 /* setup_environment:
1106 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1108 * USER=pw->pw_name, LOGNAME=pw->pw_name
1109 * PATH=bb_default_[root_]path
1112 * else if change_env = 1:
1113 * if not root (if pw->pw_uid != 0):
1114 * USER=pw->pw_name, LOGNAME=pw->pw_name
1119 extern void setup_environment(const char *shell, int clear_env, int change_env, const struct passwd *pw) FAST_FUNC;
1120 extern int correct_password(const struct passwd *pw) FAST_FUNC;
1121 /* Returns a malloced string */
1122 #if !ENABLE_USE_BB_CRYPT
1123 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1125 extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1126 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1127 /* rnd is additional random input. New one is returned.
1128 * Useful if you call crypt_make_salt many times in a row:
1129 * rnd = crypt_make_salt(buf1, 4, 0);
1130 * rnd = crypt_make_salt(buf2, 4, rnd);
1131 * rnd = crypt_make_salt(buf3, 4, rnd);
1132 * (otherwise we risk having same salt generated)
1134 extern int crypt_make_salt(char *p, int cnt, int rnd) FAST_FUNC;
1135 /* Returns number of lines changed, or -1 on error */
1136 extern int update_passwd(const char *filename, const char *username,
1137 const char *new_pw) FAST_FUNC;
1139 int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1140 int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1141 int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1142 int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1143 const char *nth_string(const char *strings, int n) FAST_FUNC;
1145 extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1146 extern void print_login_prompt(void) FAST_FUNC;
1148 char *xmalloc_ttyname(int fd) FAST_FUNC;
1149 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1150 int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1152 int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1154 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1155 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1156 int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1157 #if ENABLE_IOCTL_HEX2STR_ERROR
1158 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1159 int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1160 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1161 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1163 int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1164 int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1165 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1166 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1169 char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1170 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1171 void reset_ino_dev_hashtable(void) FAST_FUNC;
1173 /* At least glibc has horrendously large inline for this, so wrap it */
1174 unsigned long long bb_makedev(unsigned int major, unsigned int minor) FAST_FUNC;
1176 #define makedev(a,b) bb_makedev(a,b)
1180 #if ENABLE_FEATURE_EDITING
1181 /* It's NOT just ENABLEd or disabled. It's a number: */
1182 #ifdef CONFIG_FEATURE_EDITING_HISTORY
1183 #define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1185 #define MAX_HISTORY 0
1187 typedef struct line_input_t {
1189 const char *path_lookup;
1193 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
1194 char *history[MAX_HISTORY + 1];
1198 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1199 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1200 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1201 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1202 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
1203 WITH_PATH_LOOKUP = 0x20,
1204 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1206 line_input_t *new_line_input_t(int flags) FAST_FUNC;
1208 * -1 on read errors or EOF, or on bare Ctrl-D,
1209 * 0 on ctrl-C (the line entered is still returned in 'command'),
1210 * >0 length of input string, including terminating '\n'
1212 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state) FAST_FUNC;
1214 int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1215 #define read_line_input(prompt, command, maxsize, state) \
1216 read_line_input(prompt, command, maxsize)
1221 #ifdef TASK_COMM_LEN
1222 enum { COMM_LEN = TASK_COMM_LEN };
1224 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1225 enum { COMM_LEN = 16 };
1228 typedef struct procps_status_t {
1230 uint8_t shift_pages_to_bytes;
1231 uint8_t shift_pages_to_kb;
1232 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1235 USE_SELINUX(char *context;)
1236 /* Everything below must contain no ptrs to malloc'ed data:
1237 * it is memset(0) for each process in procps_scan() */
1238 unsigned long vsz, rss; /* we round it to kbytes */
1239 unsigned long stime, utime;
1240 unsigned long start_time;
1247 unsigned tty_major,tty_minor;
1248 #if ENABLE_FEATURE_TOPMEM
1249 unsigned long mapped_rw;
1250 unsigned long mapped_ro;
1251 unsigned long shared_clean;
1252 unsigned long shared_dirty;
1253 unsigned long private_clean;
1254 unsigned long private_dirty;
1255 unsigned long stack;
1258 /* basename of executable in exec(2), read from /proc/N/stat
1259 * (if executable is symlink or script, it is NOT replaced
1260 * by link target or interpreter name) */
1261 char comm[COMM_LEN];
1262 /* user/group? - use passwd/group parsing functions */
1263 #if ENABLE_FEATURE_TOP_SMP_PROCESS
1264 int last_seen_on_cpu;
1268 PSSCAN_PID = 1 << 0,
1269 PSSCAN_PPID = 1 << 1,
1270 PSSCAN_PGID = 1 << 2,
1271 PSSCAN_SID = 1 << 3,
1272 PSSCAN_UIDGID = 1 << 4,
1273 PSSCAN_COMM = 1 << 5,
1274 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
1275 PSSCAN_ARGV0 = 1 << 7,
1276 /* PSSCAN_EXE = 1 << 8, - not implemented */
1277 PSSCAN_STATE = 1 << 9,
1278 PSSCAN_VSZ = 1 << 10,
1279 PSSCAN_RSS = 1 << 11,
1280 PSSCAN_STIME = 1 << 12,
1281 PSSCAN_UTIME = 1 << 13,
1282 PSSCAN_TTY = 1 << 14,
1283 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1284 /* NB: used by find_pid_by_name(). Any applet using it
1285 * needs to be mentioned here. */
1286 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1287 || ENABLE_PGREP || ENABLE_PKILL
1291 USE_SELINUX(PSSCAN_CONTEXT = 1 << 17,)
1292 PSSCAN_START_TIME = 1 << 18,
1293 PSSCAN_CPU = 1 << 19,
1294 /* These are all retrieved from proc/NN/stat in one go: */
1295 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
1296 /**/ | PSSCAN_COMM | PSSCAN_STATE
1297 /**/ | PSSCAN_VSZ | PSSCAN_RSS
1298 /**/ | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
1300 #if ENABLE_FEATURE_TOP_SMP_PROCESS
1304 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1305 void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1306 procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
1307 /* Format cmdline (up to col chars) into char buf[col+1] */
1308 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1309 void read_cmdline(char *buf, int col, unsigned pid, const char *comm) FAST_FUNC;
1310 pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1311 pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
1314 extern const char bb_uuenc_tbl_base64[];
1315 extern const char bb_uuenc_tbl_std[];
1316 void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
1318 typedef struct sha1_ctx_t {
1323 void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1324 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx) FAST_FUNC;
1325 void sha1_end(void *resbuf, sha1_ctx_t *ctx) FAST_FUNC;
1326 typedef struct sha256_ctx_t {
1328 uint32_t total[2]; /* rename to "count"? */
1330 char buffer[128]; /* NB: always correctly aligned for uint32_t */
1332 void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1333 void sha256_hash(const void *buffer, size_t len, sha256_ctx_t *ctx) FAST_FUNC;
1334 void sha256_end(void *resbuf, sha256_ctx_t *ctx) FAST_FUNC;
1335 typedef struct sha512_ctx_t {
1339 char buffer[256]; /* NB: always correctly aligned for uint64_t */
1341 void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1342 void sha512_hash(const void *buffer, size_t len, sha512_ctx_t *ctx) FAST_FUNC;
1343 void sha512_end(void *resbuf, sha512_ctx_t *ctx) FAST_FUNC;
1345 typedef struct md5_ctx_t {
1355 /* libbb/md5prime.c uses a bit different one: */
1356 typedef struct md5_ctx_t {
1357 uint32_t state[4]; /* state (ABCD) */
1358 uint32_t count[2]; /* number of bits, modulo 2^64 (lsb first) */
1359 unsigned char buffer[64]; /* input buffer */
1362 void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1363 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx) FAST_FUNC;
1364 void md5_end(void *resbuf, md5_ctx_t *ctx) FAST_FUNC;
1367 uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1369 typedef struct masks_labels_t {
1373 int print_flags_separated(const int *masks, const char *labels,
1374 int flags, const char *separator) FAST_FUNC;
1375 int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
1378 extern const char *applet_name;
1379 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1380 extern const char bb_banner[];
1381 extern const char bb_msg_memory_exhausted[];
1382 extern const char bb_msg_invalid_date[];
1383 extern const char bb_msg_read_error[];
1384 extern const char bb_msg_write_error[];
1385 extern const char bb_msg_unknown[];
1386 extern const char bb_msg_can_not_create_raw_socket[];
1387 extern const char bb_msg_perm_denied_are_you_root[];
1388 extern const char bb_msg_requires_arg[];
1389 extern const char bb_msg_invalid_arg[];
1390 extern const char bb_msg_standard_input[];
1391 extern const char bb_msg_standard_output[];
1393 extern const char bb_str_default[];
1394 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1395 extern const char bb_hexdigits_upcase[];
1397 extern const char bb_path_mtab_file[];
1398 extern const char bb_path_passwd_file[];
1399 extern const char bb_path_shadow_file[];
1400 extern const char bb_path_gshadow_file[];
1401 extern const char bb_path_group_file[];
1402 extern const char bb_path_motd_file[];
1403 extern const char bb_path_wtmp_file[];
1404 extern const char bb_dev_null[];
1405 extern const char bb_busybox_exec_path[];
1406 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1407 * but I want to save a few bytes here */
1408 extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1409 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1410 #define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1412 extern const int const_int_0;
1413 extern const int const_int_1;
1419 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1420 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1421 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1422 /* This struct is deliberately not defined. */
1423 /* See docs/keep_data_small.txt */
1425 /* '*const' ptr makes gcc optimize code much better.
1426 * Magic prevents ptr_to_globals from going into rodata.
1427 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1428 extern struct globals *const ptr_to_globals;
1429 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1430 #define barrier() __asm__ __volatile__("":::"memory")
1431 #define SET_PTR_TO_GLOBALS(x) do { \
1432 (*(struct globals**)&ptr_to_globals) = (x); \
1436 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1437 * use bb_default_login_shell and following defines.
1438 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1439 * don't forget to change increment constant. */
1440 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
1441 extern const char bb_default_login_shell[];
1443 #define DEFAULT_SHELL (bb_default_login_shell+1)
1445 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1447 #if ENABLE_FEATURE_DEVFS
1448 # define CURRENT_VC "/dev/vc/0"
1449 # define VC_1 "/dev/vc/1"
1450 # define VC_2 "/dev/vc/2"
1451 # define VC_3 "/dev/vc/3"
1452 # define VC_4 "/dev/vc/4"
1453 # define VC_5 "/dev/vc/5"
1454 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1455 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1456 respective serial ports .. as such, we can't use the common device paths for
1458 # define SC_0 "/dev/ttsc/0"
1459 # define SC_1 "/dev/ttsc/1"
1460 # define SC_FORMAT "/dev/ttsc/%d"
1462 # define SC_0 "/dev/tts/0"
1463 # define SC_1 "/dev/tts/1"
1464 # define SC_FORMAT "/dev/tts/%d"
1466 # define VC_FORMAT "/dev/vc/%d"
1467 # define LOOP_FORMAT "/dev/loop/%d"
1468 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1469 # define LOOP_NAME "/dev/loop/"
1470 # define FB_0 "/dev/fb/0"
1472 # define CURRENT_VC "/dev/tty0"
1473 # define VC_1 "/dev/tty1"
1474 # define VC_2 "/dev/tty2"
1475 # define VC_3 "/dev/tty3"
1476 # define VC_4 "/dev/tty4"
1477 # define VC_5 "/dev/tty5"
1478 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1479 # define SC_0 "/dev/ttySC0"
1480 # define SC_1 "/dev/ttySC1"
1481 # define SC_FORMAT "/dev/ttySC%d"
1483 # define SC_0 "/dev/ttyS0"
1484 # define SC_1 "/dev/ttyS1"
1485 # define SC_FORMAT "/dev/ttyS%d"
1487 # define VC_FORMAT "/dev/tty%d"
1488 # define LOOP_FORMAT "/dev/loop%d"
1489 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1490 # define LOOP_NAME "/dev/loop"
1491 # define FB_0 "/dev/fb0"
1494 /* The following devices are the same on devfs and non-devfs systems. */
1495 #define CURRENT_TTY "/dev/tty"
1496 #define DEV_CONSOLE "/dev/console"
1499 #ifndef RB_POWER_OFF
1500 /* Stop system and switch power off if possible. */
1501 #define RB_POWER_OFF 0x4321fedc
1504 /* Make sure we call functions instead of macros. */
1518 /* This one is more efficient - we save ~400 bytes */
1520 #define isdigit(a) ((unsigned)((a) - '0') <= 9)
1522 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1525 #if __GNUC_PREREQ(4,1)
1526 # pragma GCC visibility pop
1530 #endif /* __LIBBUSYBOX_H__ */