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)
72 #if !ENABLE_USE_BB_PWD_GRP
76 #if ENABLE_FEATURE_SHADOWPASSWDS
77 # if !ENABLE_USE_BB_SHADOW
82 /* Some libc's forget to declare these, do it ourself */
83 extern char **environ;
85 /* Set the group set for the current user to GROUPS (N of them). */
86 int setgroups(size_t n, const gid_t *groups);
87 #if defined(__GLIBC__) && __GLIBC__ < 2
88 int vdprintf(int d, const char *format, va_list ap);
90 /* klogctl is in libc's klog.h, but we cheat and not #include that */
91 int klogctl(int type, char *b, int len);
92 /* This is declared here rather than #including <libgen.h> in order to avoid
93 * confusing the two versions of basename. See the dirname/basename man page
95 char *dirname(char *path);
96 /* Include our own copy of struct sysinfo to avoid binary compatibility
97 * problems with Linux 2.4, which changed things. Grumble, grumble. */
99 long uptime; /* Seconds since boot */
100 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
101 unsigned long totalram; /* Total usable main memory size */
102 unsigned long freeram; /* Available memory size */
103 unsigned long sharedram; /* Amount of shared memory */
104 unsigned long bufferram; /* Memory used by buffers */
105 unsigned long totalswap; /* Total swap space size */
106 unsigned long freeswap; /* swap space still available */
107 unsigned short procs; /* Number of current processes */
108 unsigned short pad; /* Padding needed for m68k */
109 unsigned long totalhigh; /* Total high memory size */
110 unsigned long freehigh; /* Available high memory size */
111 unsigned int mem_unit; /* Memory unit size in bytes */
112 char _f[20 - 2*sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
114 int sysinfo(struct sysinfo* info);
117 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
118 /* (don't include system headers after this until corresponding pop!) */
119 #if __GNUC_PREREQ(4,1)
120 # pragma GCC visibility push(hidden)
124 #if ENABLE_USE_BB_PWD_GRP
128 #if ENABLE_FEATURE_SHADOWPASSWDS
129 # if ENABLE_USE_BB_SHADOW
130 # include "shadow_.h"
134 /* Tested to work correctly with all int types (IIRC :]) */
135 #define MAXINT(T) (T)( \
138 : (T)~((T)1 << (sizeof(T)*8-1)) \
141 #define MININT(T) (T)( \
144 : ((T)1 << (sizeof(T)*8-1)) \
147 /* Large file support */
148 /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
149 * (stat, lseek etc) mapped to "largefile" variants by libc.
150 * Practically it means that open() automatically has O_LARGEFILE added
151 * and all filesize/file_offset parameters and struct members are "large"
152 * (in today's world - signed 64bit). For full support of large files,
153 * we need a few helper #defines (below) and careful use of off_t
154 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
156 /* CONFIG_LFS is on */
157 # if ULONG_MAX > 0xffffffff
158 /* "long" is long enough on this system */
159 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
160 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
161 # define BB_STRTOOFF bb_strtoul
162 # define STRTOOFF strtoul
163 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
166 /* "long" is too short, need "long long" */
167 # define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
168 # define BB_STRTOOFF bb_strtoull
169 # define STRTOOFF strtoull
170 # define OFF_FMT "ll"
173 /* CONFIG_LFS is off */
174 # if UINT_MAX == 0xffffffff
175 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
176 * gcc will throw warnings on printf("%d", off_t). Crap... */
177 # define XATOOFF(a) xatoi_u(a)
178 # define BB_STRTOOFF bb_strtou
179 # define STRTOOFF strtol
182 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
183 # define BB_STRTOOFF bb_strtoul
184 # define STRTOOFF strtol
188 /* scary. better ideas? (but do *test* them first!) */
189 #define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
191 /* Some useful definitions */
193 #define FALSE ((int) 0)
195 #define TRUE ((int) 1)
197 #define SKIP ((int) 2)
200 #define MTAB_GETMOUNTPT '1'
201 #define MTAB_GETDEVICE '2'
203 #define BUF_SIZE 8192
204 #define EXPAND_ALLOC 1024
206 /* Macros for min/max. */
208 #define MIN(a,b) (((a)<(b))?(a):(b))
212 #define MAX(a,b) (((a)>(b))?(a):(b))
215 /* buffer allocation schemes */
216 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
217 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
218 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
219 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
221 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
222 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
223 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
224 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
226 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
227 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
228 #define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
232 #if defined(__GLIBC__)
233 /* glibc uses __errno_location() to get a ptr to errno */
234 /* We can just memorize it once - no multithreading in busybox :) */
235 extern int *const bb_errno;
237 #define errno (*bb_errno)
240 unsigned long long monotonic_ns(void) FAST_FUNC;
241 unsigned long long monotonic_us(void) FAST_FUNC;
242 unsigned monotonic_sec(void) FAST_FUNC;
244 extern void chomp(char *s) FAST_FUNC;
245 extern void trim(char *s) FAST_FUNC;
246 extern char *skip_whitespace(const char *) FAST_FUNC;
247 extern char *skip_non_whitespace(const char *) FAST_FUNC;
248 extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
250 //TODO: supply a pointer to char[11] buffer (avoid statics)?
251 extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
252 extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
253 enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
254 FILEUTILS_PRESERVE_STATUS = 1,
255 FILEUTILS_DEREFERENCE = 2,
258 FILEUTILS_INTERACTIVE = 0x10,
259 FILEUTILS_MAKE_HARDLINK = 0x20,
260 FILEUTILS_MAKE_SOFTLINK = 0x40,
261 FILEUTILS_DEREF_SOFTLINK = 0x80,
263 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x100,
264 FILEUTILS_SET_SECURITY_CONTEXT = 0x200
267 #define FILEUTILS_CP_OPTSTR "pdRfilsL" USE_SELINUX("c")
268 extern int remove_file(const char *path, int flags) FAST_FUNC;
269 /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
270 * the source, not copy (unless "source" is a directory).
271 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
272 * work coreutils-compatibly. */
273 extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
276 ACTION_RECURSE = (1 << 0),
277 ACTION_FOLLOWLINKS = (1 << 1),
278 ACTION_FOLLOWLINKS_L0 = (1 << 2),
279 ACTION_DEPTHFIRST = (1 << 3),
280 /*ACTION_REVERSE = (1 << 4), - unused */
281 ACTION_QUIET = (1 << 5),
283 extern int recursive_action(const char *fileName, unsigned flags,
284 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
285 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
286 void* userData, unsigned depth) FAST_FUNC;
287 extern int device_open(const char *device, int mode) FAST_FUNC;
288 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
289 extern int xgetpty(char *line) FAST_FUNC;
290 extern int get_console_fd_or_die(void) FAST_FUNC;
291 extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
292 extern char *find_block_device(const char *path) FAST_FUNC;
293 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
294 extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
295 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
296 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
297 /* "short" copy can be detected by return value < size */
298 /* this helper yells "short read!" if param is not -1 */
299 extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
300 extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
301 /* xxxx_strip version can modify its parameter:
305 * "abc/def/" -> "def" !!
307 extern char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
308 /* "abc/def/" -> "" and it never modifies 'path' */
309 extern char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
311 int ndelay_on(int fd) FAST_FUNC;
312 int ndelay_off(int fd) FAST_FUNC;
313 int close_on_exec_on(int fd) FAST_FUNC;
314 void xdup2(int, int) FAST_FUNC;
315 void xmove_fd(int, int) FAST_FUNC;
318 DIR *xopendir(const char *path) FAST_FUNC;
319 DIR *warn_opendir(const char *path) FAST_FUNC;
321 /* UNUSED: char *xmalloc_realpath(const char *path) FAST_FUNC; */
322 char *xmalloc_readlink(const char *path) FAST_FUNC;
323 char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC;
324 char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
326 char *xmalloc_follow_symlinks(const char *path) FAST_FUNC;
330 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
331 * otherwise would kill us, except for those resulting from bugs:
332 * SIGSEGV, SIGILL, SIGFPE.
333 * Other fatal signals not included (TODO?):
334 * SIGBUS Bus error (bad memory access)
335 * SIGPOLL Pollable event. Synonym of SIGIO
336 * SIGPROF Profiling timer expired
337 * SIGSYS Bad argument to routine
338 * SIGTRAP Trace/breakpoint trap
340 * The only known arch with some of these sigs not fitting
341 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
342 * Dance around with long long to guard against that...
344 BB_FATAL_SIGS = (int)(0
348 + (1LL << SIGPIPE) // Write to pipe with no readers
349 + (1LL << SIGQUIT) // Quit from keyboard
350 + (1LL << SIGABRT) // Abort signal from abort(3)
351 + (1LL << SIGALRM) // Timer signal from alarm(2)
352 + (1LL << SIGVTALRM) // Virtual alarm clock
353 + (1LL << SIGXCPU) // CPU time limit exceeded
354 + (1LL << SIGXFSZ) // File size limit exceeded
355 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
359 void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
360 /* Unlike signal() and bb_signals, sets handler with sigaction()
361 * and in a way that while signal handler is run, no other signals
362 * will be blocked: */
363 void bb_signals_recursive(int sigs, void (*f)(int)) FAST_FUNC;
364 /* syscalls like read() will be interrupted with EINTR: */
365 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
366 /* syscalls like read() won't be interrupted (though select/poll will be): */
367 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
368 void wait_for_any_sig(void) FAST_FUNC;
369 void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
370 void sig_block(int sig) FAST_FUNC;
371 void sig_unblock(int sig) FAST_FUNC;
372 /* Will do sigaction(signum, act, NULL): */
373 int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
374 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
375 int sigprocmask_allsigs(int how) FAST_FUNC;
378 void xsetgid(gid_t gid) FAST_FUNC;
379 void xsetuid(uid_t uid) FAST_FUNC;
380 void xchdir(const char *path) FAST_FUNC;
381 void xchroot(const char *path) FAST_FUNC;
382 void xsetenv(const char *key, const char *value) FAST_FUNC;
383 void xunlink(const char *pathname) FAST_FUNC;
384 void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
385 int xopen(const char *pathname, int flags) FAST_FUNC FAST_FUNC;
386 int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
387 int open_or_warn(const char *pathname, int flags) FAST_FUNC;
388 int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
389 int open_or_warn_stdin(const char *pathname) FAST_FUNC;
390 void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
391 int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
392 off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
393 off_t fdlength(int fd) FAST_FUNC;
395 void xpipe(int filedes[2]) FAST_FUNC;
396 /* In this form code with pipes is much more readable */
397 struct fd_pair { int rd; int wr; };
398 #define piped_pair(pair) pipe(&((pair).rd))
399 #define xpiped_pair(pair) xpipe(&((pair).rd))
401 /* Useful for having small structure members/global variables */
402 typedef int8_t socktype_t;
403 typedef int8_t family_t;
404 struct BUG_too_small {
405 char BUG_socktype_t_too_small[(0
412 char BUG_family_t_too_small[(0
429 int xsocket(int domain, int type, int protocol) FAST_FUNC;
430 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
431 void xlisten(int s, int backlog) FAST_FUNC;
432 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
433 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
434 socklen_t tolen) FAST_FUNC;
435 /* SO_REUSEADDR allows a server to rebind to an address that is already
436 * "in use" by old connections to e.g. previous server instance which is
437 * killed or crashed. Without it bind will fail until all such connections
438 * time out. Linux does not allow multiple live binds on same ip:port
439 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
440 * Turn it on before you call bind(). */
441 void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
442 int setsockopt_broadcast(int fd) FAST_FUNC;
443 /* NB: returns port in host byte order */
444 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
445 typedef struct len_and_sockaddr {
449 struct sockaddr_in sin;
450 #if ENABLE_FEATURE_IPV6
451 struct sockaddr_in6 sin6;
456 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
457 LSA_SIZEOF_SA = sizeof(
460 struct sockaddr_in sin;
461 #if ENABLE_FEATURE_IPV6
462 struct sockaddr_in6 sin6;
467 /* Create stream socket, and allocate suitable lsa.
468 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
469 * af == AF_UNSPEC will result in trying to create IPv6 socket,
470 * and if kernel doesn't support it, IPv4.
472 #if ENABLE_FEATURE_IPV6
473 int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
475 int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
476 #define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
478 int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
479 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
480 * numeric IP ("N.N.N.N") or numeric IPv6 address,
481 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
482 * Only if there is no suffix, port argument is used */
483 /* NB: these set SO_REUSEADDR before bind */
484 int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
485 int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
486 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
487 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
488 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
489 * If there is no suffix, port argument is used */
490 int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
491 /* Connect to peer identified by lsa */
492 int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
493 /* Return malloc'ed len_and_sockaddr with socket address of host:port
494 * Currently will return IPv4 or IPv6 sockaddrs only
495 * (depending on host), but in theory nothing prevents e.g.
496 * UNIX socket address being returned, IPX sockaddr etc...
497 * On error does bb_error_msg and returns NULL */
498 len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC;
499 /* Version which dies on error */
500 len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC;
501 len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC;
502 /* Same, useful if you want to force family (e.g. IPv6) */
503 #if !ENABLE_FEATURE_IPV6
504 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
505 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
507 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC;
508 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC;
510 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
511 * otherwise no-op. Useful for ftp.
512 * NB: does NOT do htons() internally, just direct assignment. */
513 void set_nport(len_and_sockaddr *lsa, unsigned port) FAST_FUNC;
514 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
515 int get_nport(const struct sockaddr *sa) FAST_FUNC;
516 /* Reverse DNS. Returns NULL on failure. */
517 char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC;
518 /* This one doesn't append :PORTNUM */
519 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC;
520 /* This one also doesn't fall back to dotted IP (returns NULL) */
521 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC;
522 /* inet_[ap]ton on steroids */
523 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC;
524 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC;
525 // "old" (ipv4 only) API
526 // users: traceroute.c hostname.c - use _list_ of all IPs
527 struct hostent *xgethostbyname(const char *name) FAST_FUNC;
528 // Also mount.c and inetd.c are using gethostbyname(),
529 // + inet_common.c has additional IPv4-only stuff
532 void socket_want_pktinfo(int fd) FAST_FUNC;
533 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
534 const struct sockaddr *to,
535 const struct sockaddr *from,
536 socklen_t tolen) FAST_FUNC;
537 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
538 struct sockaddr *from,
540 socklen_t sa_size) FAST_FUNC;
542 char *xstrdup(const char *s) FAST_FUNC;
543 char *xstrndup(const char *s, int n) FAST_FUNC;
544 void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
545 char *safe_strncpy(char *dst, const char *src, size_t size) 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 /* Reads up to (and including) TERMINATING_STRING: */
617 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC;
618 /* Chops off TERMINATING_STRING from the end: */
619 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC;
620 /* Reads up to (and including) "\n" or NUL byte: */
621 extern char *xmalloc_fgets(FILE *file) FAST_FUNC;
622 /* Chops off '\n' from the end, unlike fgets: */
623 extern char *xmalloc_fgetline(FILE *file) FAST_FUNC;
624 /* Same, but doesn't try to conserve space (may have some slack after the end) */
625 /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC; */
627 extern void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
628 extern void die_if_ferror_stdout(void) FAST_FUNC;
629 extern void xfflush_stdout(void) FAST_FUNC;
630 extern void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
631 extern int fclose_if_not_stdin(FILE *file) FAST_FUNC;
632 extern FILE *xfopen(const char *filename, const char *mode) FAST_FUNC;
633 /* Prints warning to stderr and returns NULL on failure: */
634 extern FILE *fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
635 /* "Opens" stdin if filename is special, else just opens file: */
636 extern FILE *xfopen_stdin(const char *filename) FAST_FUNC;
637 extern FILE *fopen_or_warn_stdin(const char *filename) FAST_FUNC;
638 extern FILE* fopen_for_read(const char *path) FAST_FUNC;
639 extern FILE* xfopen_for_read(const char *path) FAST_FUNC;
640 extern FILE* fopen_for_write(const char *path) FAST_FUNC;
641 extern FILE* xfopen_for_write(const char *path) FAST_FUNC;
643 int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
644 void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
646 /* Wrapper which restarts poll on EINTR or ENOMEM.
647 * On other errors complains [perror("poll")] and returns.
648 * Warning! May take (much) longer than timeout_ms to return!
649 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
650 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
652 char *safe_gethostname(void) FAST_FUNC;
653 char *safe_getdomainname(void) FAST_FUNC;
655 /* Convert each alpha char in str to lower-case */
656 char* str_tolower(char *str) FAST_FUNC;
658 char *utoa(unsigned n) FAST_FUNC;
659 char *itoa(int n) FAST_FUNC;
660 /* Returns a pointer past the formatted number, does NOT null-terminate */
661 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
662 char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
663 /* Intelligent formatters of bignums */
664 void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
665 void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
666 //TODO: provide pointer to buf (avoid statics)?
667 const char *make_human_readable_str(unsigned long long size,
668 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
669 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
670 char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
672 /* Last element is marked by mult == 0 */
679 /* Using xatoi() instead of naive atoi() is not always convenient -
680 * in many places people want *non-negative* values, but store them
681 * in signed int. Therefore we need this one:
682 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
683 int xatoi_u(const char *numstr) FAST_FUNC;
684 /* Useful for reading port numbers */
685 uint16_t xatou16(const char *numstr) FAST_FUNC;
688 /* These parse entries in /etc/passwd and /etc/group. This is desirable
689 * for BusyBox since we want to avoid using the glibc NSS stuff, which
690 * increases target size and is often not needed on embedded systems. */
691 long xuname2uid(const char *name) FAST_FUNC;
692 long xgroup2gid(const char *name) FAST_FUNC;
693 /* wrapper: allows string to contain numeric uid or gid */
694 unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
695 /* from chpst. Does not die, returns 0 on failure */
700 /* always sets uid and gid */
701 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
702 /* always sets uid and gid, allows numeric; exits on failure */
703 void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
704 /* chown-like handling of "user[:[group]" */
705 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
706 /* bb_getpwuid, bb_getgrgid:
707 * bb_getXXXid(buf, bufsz, id) - copy user/group name or id
708 * as a string to buf, return user/group name or NULL
709 * bb_getXXXid(NULL, 0, id) - return user/group name or NULL
710 * bb_getXXXid(NULL, -1, id) - return user/group name or exit
712 char *bb_getpwuid(char *name, int bufsize, long uid) FAST_FUNC;
713 char *bb_getgrgid(char *group, int bufsize, long gid) FAST_FUNC;
714 /* versions which cache results (useful for ps, ls etc) */
715 const char* get_cached_username(uid_t uid) FAST_FUNC;
716 const char* get_cached_groupname(gid_t gid) FAST_FUNC;
717 void clear_username_cache(void) FAST_FUNC;
718 /* internally usernames are saved in fixed-sized char[] buffers */
719 enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
720 #if ENABLE_FEATURE_CHECK_NAMES
721 void die_if_bad_username(const char* name) FAST_FUNC;
723 #define die_if_bad_username(name) ((void)(name))
726 int execable_file(const char *name) FAST_FUNC;
727 char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
728 int exists_execable(const char *filename) FAST_FUNC;
730 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
731 * but it may exec busybox and call applet instead of searching PATH.
733 #if ENABLE_FEATURE_PREFER_APPLETS
734 int bb_execvp(const char *file, char *const argv[]) FAST_FUNC;
735 #define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
736 #define BB_EXECLP(prog,cmd,...) \
737 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
740 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
741 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
744 /* NOMMU friendy fork+exec */
745 pid_t spawn(char **argv) FAST_FUNC;
746 pid_t xspawn(char **argv) FAST_FUNC;
748 int safe_waitpid(int pid, int *wstat, int options) FAST_FUNC;
749 /* Unlike waitpid, waits ONLY for one process.
750 * It's safe to pass negative 'pids' from failed [v]fork -
751 * wait4pid will return -1 (and will not clobber [v]fork's errno).
752 * IOW: rc = wait4pid(spawn(argv));
753 * if (rc < 0) bb_perror_msg("%s", argv[0]);
754 * if (rc > 0) bb_error_msg("exit code: %d", rc);
756 int wait4pid(int pid) FAST_FUNC;
757 int wait_any_nohang(int *wstat) FAST_FUNC;
758 #define wait_crashed(w) ((w) & 127)
759 #define wait_exitcode(w) ((w) >> 8)
760 #define wait_stopsig(w) ((w) >> 8)
761 #define wait_stopped(w) (((w) & 127) == 127)
762 /* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
763 int spawn_and_wait(char **argv) FAST_FUNC;
764 struct nofork_save_area {
766 const char *applet_name;
767 int xfunc_error_retval;
768 uint32_t option_mask32;
772 void save_nofork_data(struct nofork_save_area *save) FAST_FUNC;
773 void restore_nofork_data(struct nofork_save_area *save) FAST_FUNC;
774 /* Does NOT check that applet is NOFORK, just blindly runs it */
775 int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
776 int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv) FAST_FUNC;
778 /* Helpers for daemonization.
780 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
782 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
783 * rexec's itself on NOMMU with argv passed as command line.
784 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
785 * from the start. (It will detect it and not reexec again second time).
786 * You have to audit carefully that you don't do something twice as a result
787 * (opening files/sockets, parsing config files etc...)!
789 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
790 * (will do setsid()).
792 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
793 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
794 * Currently used for openvt and setsid. On MMU ignores argv.
796 * Helper for network daemons in foreground mode:
798 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
799 * to /dev/null if they are not.
802 DAEMON_CHDIR_ROOT = 1,
803 DAEMON_DEVNULL_STDIO = 2,
804 DAEMON_CLOSE_EXTRA_FDS = 4,
805 DAEMON_ONLY_SANITIZE = 8, /* internal use */
808 void forkexit_or_rexec(void) FAST_FUNC;
809 enum { re_execed = 0 };
810 # define forkexit_or_rexec(argv) forkexit_or_rexec()
811 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
812 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
814 void re_exec(char **argv) NORETURN FAST_FUNC;
815 void forkexit_or_rexec(char **argv) FAST_FUNC;
816 extern bool re_execed;
817 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
818 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
819 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
820 # define fork() BUG_fork_is_unavailable_on_nommu()
821 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
822 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
824 void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
825 void bb_sanitize_stdio(void) FAST_FUNC;
826 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
827 int sanitize_env_if_suid(void) FAST_FUNC;
830 extern const char *const bb_argv_dash[]; /* "-", NULL */
831 extern const char *opt_complementary;
832 #if ENABLE_GETOPT_LONG
833 #define No_argument "\0"
834 #define Required_argument "\001"
835 #define Optional_argument "\002"
836 extern const char *applet_long_options;
838 extern uint32_t option_mask32;
839 extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
842 typedef struct llist_t {
844 struct llist_t *link;
846 void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
847 void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
848 void *llist_pop(llist_t **elm) FAST_FUNC;
849 void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
850 void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
851 llist_t *llist_rev(llist_t *list) FAST_FUNC;
852 /* BTW, surprisingly, changing API to
853 * llist_t *llist_add_to(llist_t *old_head, void *data)
854 * etc does not result in smaller code... */
856 /* start_stop_daemon and udhcpc are special - they want
857 * to create pidfiles regardless of FEATURE_PIDFILE */
858 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
859 /* True only if we created pidfile which is *file*, not /dev/null etc */
860 extern smallint wrote_pidfile;
861 void write_pidfile(const char *path) FAST_FUNC;
862 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
864 enum { wrote_pidfile = 0 };
865 #define write_pidfile(path) ((void)0)
866 #define remove_pidfile(path) ((void)0)
871 LOGMODE_STDIO = (1 << 0),
872 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
873 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
875 extern const char *msg_eol;
876 extern smallint logmode;
877 extern int die_sleep;
878 extern int xfunc_error_retval;
879 extern jmp_buf die_jmp;
880 extern void xfunc_die(void) NORETURN FAST_FUNC;
881 extern void bb_show_usage(void) NORETURN FAST_FUNC;
882 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
883 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
884 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
885 extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
886 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
887 extern void bb_simple_perror_msg_and_die(const char *s) __attribute__ ((noreturn)) FAST_FUNC;
888 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
889 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
890 extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
891 extern void bb_perror_nomsg(void) FAST_FUNC;
892 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
893 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
895 /* We need to export XXX_main from libbusybox
896 * only if we build "individual" binaries
898 #if ENABLE_FEATURE_INDIVIDUAL
899 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
901 #define MAIN_EXTERNALLY_VISIBLE
905 /* Applets which are useful from another applets */
906 int bb_cat(char** argv);
907 /* If shell needs them, they exist even if not enabled as applets */
908 int echo_main(int argc, char** argv) USE_ECHO(MAIN_EXTERNALLY_VISIBLE);
909 int printf_main(int argc, char **argv) USE_PRINTF(MAIN_EXTERNALLY_VISIBLE);
910 int test_main(int argc, char **argv) USE_TEST(MAIN_EXTERNALLY_VISIBLE);
911 int kill_main(int argc, char **argv) USE_KILL(MAIN_EXTERNALLY_VISIBLE);
912 /* Similar, but used by chgrp, not shell */
913 int chown_main(int argc, char **argv) USE_CHOWN(MAIN_EXTERNALLY_VISIBLE);
914 /* Don't need USE_xxx() guard for these */
915 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
916 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
917 int bbunpack(char **argv,
918 char* (*make_new_name)(char *filename),
919 USE_DESKTOP(long long) int (*unpacker)(void)
922 void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
927 int create_icmp_socket(void) FAST_FUNC;
928 int create_icmp6_socket(void) FAST_FUNC;
930 /* This structure defines protocol families and their handlers. */
936 char* FAST_FUNC (*print)(unsigned char *);
937 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
938 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
939 void FAST_FUNC (*herror)(char *text);
940 int FAST_FUNC (*rprint)(int options);
941 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
943 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
945 /* This structure defines hardware protocols and their handlers. */
951 char* FAST_FUNC (*print)(unsigned char *);
952 int FAST_FUNC (*input)(const char *, struct sockaddr *);
953 int FAST_FUNC (*activate)(int fd);
954 int suppress_null_addr;
956 extern smallint interface_opt_a;
957 int display_interfaces(char *ifname) FAST_FUNC;
958 #if ENABLE_FEATURE_HWIB
959 int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
961 #define in_ib(a, b) 1 /* fail */
963 const struct aftype *get_aftype(const char *name) FAST_FUNC;
964 const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
965 const struct hwtype *get_hwntype(int type) FAST_FUNC;
968 #ifndef BUILD_INDIVIDUAL
969 extern int find_applet_by_name(const char *name) FAST_FUNC;
970 /* Returns only if applet is not found. */
971 extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
972 extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
976 extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
977 extern struct mntent *find_mount_point(const char *name, const char *table) FAST_FUNC;
979 extern void erase_mtab(const char * name) FAST_FUNC;
980 extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
981 extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
982 extern void bb_warn_ignoring_args(int n) FAST_FUNC;
984 extern int get_linux_version_code(void) FAST_FUNC;
986 extern char *query_loop(const char *device) FAST_FUNC;
987 extern int del_loop(const char *device) FAST_FUNC;
988 /* If *devname is not NULL, use that name, otherwise try to find free one,
989 * malloc and return it in *devname.
990 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
991 extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
994 //TODO: pass buf pointer or return allocated buf (avoid statics)?
995 char *bb_askpass(int timeout, const char * prompt) FAST_FUNC;
996 int bb_ask_confirmation(void) FAST_FUNC;
998 int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
1001 * Config file parser
1004 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1005 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1006 // TODO: COLLAPSE and TRIM seem to always go in pair
1007 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1008 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
1009 // keep a copy of current line
1010 PARSE_KEEP_COPY = 0x00200000 * ENABLE_DEBUG_CROND_OPTION,
1011 // PARSE_ESCAPE = 0x00400000, // process escape sequences in tokens
1013 // * remove leading and trailing delimiters and collapse
1014 // multiple delimiters into one
1015 // * warn and continue if less than mintokens delimiters found
1016 // * grab everything into last token
1017 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
1019 typedef struct parser_t {
1025 parser_t* config_open(const char *filename) FAST_FUNC;
1026 parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
1027 int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1028 #define config_read(parser, tokens, max, min, str, flags) \
1029 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1030 void config_close(parser_t *parser) FAST_FUNC;
1032 /* Concatenate path and filename to new allocated buffer.
1033 * Add "/" only as needed (no duplicate "//" are produced).
1034 * If path is NULL, it is assumed to be "/".
1035 * filename should not be NULL. */
1036 char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1037 char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1038 const char *bb_basename(const char *name) FAST_FUNC;
1039 /* NB: can violate const-ness (similarly to strchr) */
1040 char *last_char_is(const char *s, int c) FAST_FUNC;
1043 int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1045 int get_signum(const char *name) FAST_FUNC;
1046 const char *get_signame(int number) FAST_FUNC;
1047 void print_signames(void) FAST_FUNC;
1049 char *bb_simplify_path(const char *path) FAST_FUNC;
1051 #define FAIL_DELAY 3
1052 extern void bb_do_delay(int seconds) FAST_FUNC;
1053 extern void change_identity(const struct passwd *pw) FAST_FUNC;
1054 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
1055 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) FAST_FUNC;
1057 extern void renew_current_security_context(void) FAST_FUNC;
1058 extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1059 extern context_t set_security_context_component(security_context_t cur_context,
1060 char *user, char *role, char *type, char *range) FAST_FUNC;
1061 extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1062 extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1064 #define selinux_preserve_fcontext(fdesc) ((void)0)
1066 extern void selinux_or_die(void) FAST_FUNC;
1067 extern int restricted_shell(const char *shell) FAST_FUNC;
1069 /* setup_environment:
1070 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1072 * USER=pw->pw_name, LOGNAME=pw->pw_name
1073 * PATH=bb_default_[root_]path
1076 * else if change_env = 1:
1077 * if not root (if pw->pw_uid != 0):
1078 * USER=pw->pw_name, LOGNAME=pw->pw_name
1083 extern void setup_environment(const char *shell, int clear_env, int change_env, const struct passwd *pw) FAST_FUNC;
1084 extern int correct_password(const struct passwd *pw) FAST_FUNC;
1085 /* Returns a malloced string */
1086 #if !ENABLE_USE_BB_CRYPT
1087 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1089 extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1090 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1091 /* rnd is additional random input. New one is returned.
1092 * Useful if you call crypt_make_salt many times in a row:
1093 * rnd = crypt_make_salt(buf1, 4, 0);
1094 * rnd = crypt_make_salt(buf2, 4, rnd);
1095 * rnd = crypt_make_salt(buf3, 4, rnd);
1096 * (otherwise we risk having same salt generated)
1098 extern int crypt_make_salt(char *p, int cnt, int rnd) FAST_FUNC;
1099 /* Returns number of lines changed, or -1 on error */
1100 extern int update_passwd(const char *filename, const char *username,
1101 const char *new_pw) FAST_FUNC;
1103 int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1104 int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1105 int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1106 int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1107 const char *nth_string(const char *strings, int n) FAST_FUNC;
1109 extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1110 extern void print_login_prompt(void) FAST_FUNC;
1112 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1113 int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1115 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1116 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1117 int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1118 #if ENABLE_IOCTL_HEX2STR_ERROR
1119 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1120 int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1121 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1122 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1124 int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1125 int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1126 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1127 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1130 char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1131 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1132 void reset_ino_dev_hashtable(void) FAST_FUNC;
1134 /* At least glibc has horrendously large inline for this, so wrap it */
1135 unsigned long long bb_makedev(unsigned int major, unsigned int minor) FAST_FUNC;
1137 #define makedev(a,b) bb_makedev(a,b)
1141 #if ENABLE_FEATURE_EDITING
1142 /* It's NOT just ENABLEd or disabled. It's a number: */
1143 #ifdef CONFIG_FEATURE_EDITING_HISTORY
1144 #define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1146 #define MAX_HISTORY 0
1148 typedef struct line_input_t {
1150 const char *path_lookup;
1154 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
1155 char *history[MAX_HISTORY + 1];
1159 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1160 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1161 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1162 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1163 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
1164 WITH_PATH_LOOKUP = 0x20,
1165 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1167 line_input_t *new_line_input_t(int flags) FAST_FUNC;
1169 * -1 on read errors or EOF, or on bare Ctrl-D,
1170 * 0 on ctrl-C (the line entered is still returned in 'command'),
1171 * >0 length of input string, including terminating '\n'
1173 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state) FAST_FUNC;
1175 int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1176 #define read_line_input(prompt, command, maxsize, state) \
1177 read_line_input(prompt, command, maxsize)
1182 #ifdef TASK_COMM_LEN
1183 enum { COMM_LEN = TASK_COMM_LEN };
1185 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1186 enum { COMM_LEN = 16 };
1189 typedef struct procps_status_t {
1191 uint8_t shift_pages_to_bytes;
1192 uint8_t shift_pages_to_kb;
1193 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1196 USE_SELINUX(char *context;)
1197 /* Everything below must contain no ptrs to malloc'ed data:
1198 * it is memset(0) for each process in procps_scan() */
1199 unsigned long vsz, rss; /* we round it to kbytes */
1200 unsigned long stime, utime;
1201 unsigned long start_time;
1208 unsigned tty_major,tty_minor;
1209 #if ENABLE_FEATURE_TOPMEM
1210 unsigned long mapped_rw;
1211 unsigned long mapped_ro;
1212 unsigned long shared_clean;
1213 unsigned long shared_dirty;
1214 unsigned long private_clean;
1215 unsigned long private_dirty;
1216 unsigned long stack;
1219 /* basename of executable in exec(2), read from /proc/N/stat
1220 * (if executable is symlink or script, it is NOT replaced
1221 * by link target or interpreter name) */
1222 char comm[COMM_LEN];
1223 /* user/group? - use passwd/group parsing functions */
1226 PSSCAN_PID = 1 << 0,
1227 PSSCAN_PPID = 1 << 1,
1228 PSSCAN_PGID = 1 << 2,
1229 PSSCAN_SID = 1 << 3,
1230 PSSCAN_UIDGID = 1 << 4,
1231 PSSCAN_COMM = 1 << 5,
1232 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
1233 PSSCAN_ARGV0 = 1 << 7,
1234 /* PSSCAN_EXE = 1 << 8, - not implemented */
1235 PSSCAN_STATE = 1 << 9,
1236 PSSCAN_VSZ = 1 << 10,
1237 PSSCAN_RSS = 1 << 11,
1238 PSSCAN_STIME = 1 << 12,
1239 PSSCAN_UTIME = 1 << 13,
1240 PSSCAN_TTY = 1 << 14,
1241 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1242 PSSCAN_ARGVN = (1 << 16) * (ENABLE_PGREP || ENABLE_PKILL || ENABLE_PIDOF),
1243 USE_SELINUX(PSSCAN_CONTEXT = 1 << 17,)
1244 PSSCAN_START_TIME = 1 << 18,
1245 /* These are all retrieved from proc/NN/stat in one go: */
1246 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
1247 | PSSCAN_COMM | PSSCAN_STATE
1248 | PSSCAN_VSZ | PSSCAN_RSS
1249 | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
1252 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1253 void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1254 procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
1255 /* Format cmdline (up to col chars) into char buf[col+1] */
1256 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1257 void read_cmdline(char *buf, int col, unsigned pid, const char *comm) FAST_FUNC;
1258 pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1259 pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
1262 extern const char bb_uuenc_tbl_base64[];
1263 extern const char bb_uuenc_tbl_std[];
1264 void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
1266 typedef struct sha1_ctx_t {
1271 void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1272 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx) FAST_FUNC;
1273 void *sha1_end(void *resbuf, sha1_ctx_t *ctx) FAST_FUNC;
1275 typedef struct md5_ctx_t {
1284 void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1285 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx) FAST_FUNC;
1286 void *md5_end(void *resbuf, md5_ctx_t *ctx) FAST_FUNC;
1288 uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1290 typedef struct masks_labels_t {
1294 int print_flags_separated(const int *masks, const char *labels,
1295 int flags, const char *separator) FAST_FUNC;
1296 int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
1299 extern const char *applet_name;
1300 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1301 extern const char bb_banner[];
1302 extern const char bb_msg_memory_exhausted[];
1303 extern const char bb_msg_invalid_date[];
1304 extern const char bb_msg_read_error[];
1305 extern const char bb_msg_write_error[];
1306 extern const char bb_msg_unknown[];
1307 extern const char bb_msg_can_not_create_raw_socket[];
1308 extern const char bb_msg_perm_denied_are_you_root[];
1309 extern const char bb_msg_requires_arg[];
1310 extern const char bb_msg_invalid_arg[];
1311 extern const char bb_msg_standard_input[];
1312 extern const char bb_msg_standard_output[];
1314 extern const char bb_str_default[];
1315 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1316 extern const char bb_hexdigits_upcase[];
1318 extern const char bb_path_mtab_file[];
1319 extern const char bb_path_passwd_file[];
1320 extern const char bb_path_shadow_file[];
1321 extern const char bb_path_gshadow_file[];
1322 extern const char bb_path_group_file[];
1323 extern const char bb_path_motd_file[];
1324 extern const char bb_path_wtmp_file[];
1325 extern const char bb_dev_null[];
1326 extern const char bb_busybox_exec_path[];
1327 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1328 * but I want to save a few bytes here */
1329 extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1330 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1331 #define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1333 extern const int const_int_0;
1334 extern const int const_int_1;
1340 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1341 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1342 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1343 /* This struct is deliberately not defined. */
1344 /* See docs/keep_data_small.txt */
1346 /* '*const' ptr makes gcc optimize code much better.
1347 * Magic prevents ptr_to_globals from going into rodata.
1348 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1349 extern struct globals *const ptr_to_globals;
1350 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1351 #define barrier() __asm__ __volatile__("":::"memory")
1352 #define SET_PTR_TO_GLOBALS(x) do { \
1353 (*(struct globals**)&ptr_to_globals) = (x); \
1357 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1358 * use bb_default_login_shell and following defines.
1359 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1360 * don't forget to change increment constant. */
1361 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
1362 extern const char bb_default_login_shell[];
1364 #define DEFAULT_SHELL (bb_default_login_shell+1)
1366 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1368 #if ENABLE_FEATURE_DEVFS
1369 # define CURRENT_VC "/dev/vc/0"
1370 # define VC_1 "/dev/vc/1"
1371 # define VC_2 "/dev/vc/2"
1372 # define VC_3 "/dev/vc/3"
1373 # define VC_4 "/dev/vc/4"
1374 # define VC_5 "/dev/vc/5"
1375 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1376 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1377 respective serial ports .. as such, we can't use the common device paths for
1379 # define SC_0 "/dev/ttsc/0"
1380 # define SC_1 "/dev/ttsc/1"
1381 # define SC_FORMAT "/dev/ttsc/%d"
1383 # define SC_0 "/dev/tts/0"
1384 # define SC_1 "/dev/tts/1"
1385 # define SC_FORMAT "/dev/tts/%d"
1387 # define VC_FORMAT "/dev/vc/%d"
1388 # define LOOP_FORMAT "/dev/loop/%d"
1389 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1390 # define LOOP_NAME "/dev/loop/"
1391 # define FB_0 "/dev/fb/0"
1393 # define CURRENT_VC "/dev/tty0"
1394 # define VC_1 "/dev/tty1"
1395 # define VC_2 "/dev/tty2"
1396 # define VC_3 "/dev/tty3"
1397 # define VC_4 "/dev/tty4"
1398 # define VC_5 "/dev/tty5"
1399 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1400 # define SC_0 "/dev/ttySC0"
1401 # define SC_1 "/dev/ttySC1"
1402 # define SC_FORMAT "/dev/ttySC%d"
1404 # define SC_0 "/dev/ttyS0"
1405 # define SC_1 "/dev/ttyS1"
1406 # define SC_FORMAT "/dev/ttyS%d"
1408 # define VC_FORMAT "/dev/tty%d"
1409 # define LOOP_FORMAT "/dev/loop%d"
1410 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1411 # define LOOP_NAME "/dev/loop"
1412 # define FB_0 "/dev/fb0"
1415 /* The following devices are the same on devfs and non-devfs systems. */
1416 #define CURRENT_TTY "/dev/tty"
1417 #define DEV_CONSOLE "/dev/console"
1420 #ifndef RB_POWER_OFF
1421 /* Stop system and switch power off if possible. */
1422 #define RB_POWER_OFF 0x4321fedc
1425 /* Make sure we call functions instead of macros. */
1439 /* This one is more efficient - we save ~400 bytes */
1441 #define isdigit(a) ((unsigned)((a) - '0') <= 9)
1443 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1446 #if __GNUC_PREREQ(4,1)
1447 # pragma GCC visibility pop
1451 #endif /* __LIBBUSYBOX_H__ */