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 */
282 extern int recursive_action(const char *fileName, unsigned flags,
283 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
284 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
285 void* userData, unsigned depth) FAST_FUNC;
286 extern int device_open(const char *device, int mode) FAST_FUNC;
287 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
288 extern int xgetpty(char *line) FAST_FUNC;
289 extern int get_console_fd(void) FAST_FUNC;
290 extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
291 extern char *find_block_device(const char *path) FAST_FUNC;
292 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
293 extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
294 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
295 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
296 /* "short" copy can be detected by return value < size */
297 /* this helper yells "short read!" if param is not -1 */
298 extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
299 extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
300 /* xxxx_strip version can modify its parameter:
304 * "abc/def/" -> "def" !!
306 extern char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
307 /* "abc/def/" -> "" and it never modifies 'path' */
308 extern char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
310 int ndelay_on(int fd) FAST_FUNC;
311 int ndelay_off(int fd) FAST_FUNC;
312 int close_on_exec_on(int fd) FAST_FUNC;
313 void xdup2(int, int) FAST_FUNC;
314 void xmove_fd(int, int) FAST_FUNC;
317 DIR *xopendir(const char *path) FAST_FUNC;
318 DIR *warn_opendir(const char *path) FAST_FUNC;
320 /* UNUSED: char *xmalloc_realpath(const char *path) FAST_FUNC; */
321 char *xmalloc_readlink(const char *path) FAST_FUNC;
322 char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC;
323 char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
325 char *xmalloc_follow_symlinks(const char *path) FAST_FUNC;
329 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
330 * otherwise would kill us, except for those resulting from bugs:
331 * SIGSEGV, SIGILL, SIGFPE.
332 * Other fatal signals not included (TODO?):
333 * SIGBUS Bus error (bad memory access)
334 * SIGPOLL Pollable event. Synonym of SIGIO
335 * SIGPROF Profiling timer expired
336 * SIGSYS Bad argument to routine
337 * SIGTRAP Trace/breakpoint trap
339 * The only known arch with some of these sigs not fitting
340 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
341 * Dance around with long long to guard against that...
343 BB_FATAL_SIGS = (int)(0
347 + (1LL << SIGPIPE) // Write to pipe with no readers
348 + (1LL << SIGQUIT) // Quit from keyboard
349 + (1LL << SIGABRT) // Abort signal from abort(3)
350 + (1LL << SIGALRM) // Timer signal from alarm(2)
351 + (1LL << SIGVTALRM) // Virtual alarm clock
352 + (1LL << SIGXCPU) // CPU time limit exceeded
353 + (1LL << SIGXFSZ) // File size limit exceeded
354 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
358 void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
359 /* Unlike signal() and bb_signals, sets handler with sigaction()
360 * and in a way that while signal handler is run, no other signals
361 * will be blocked: */
362 void bb_signals_recursive(int sigs, void (*f)(int)) FAST_FUNC;
363 /* syscalls like read() will be interrupted with EINTR: */
364 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
365 /* syscalls like read() won't be interrupted (though select/poll will be): */
366 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
367 void wait_for_any_sig(void) FAST_FUNC;
368 void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
369 void sig_block(int sig) FAST_FUNC;
370 void sig_unblock(int sig) FAST_FUNC;
371 /* Will do sigaction(signum, act, NULL): */
372 int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
373 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
374 int sigprocmask_allsigs(int how) FAST_FUNC;
377 void xsetgid(gid_t gid) FAST_FUNC;
378 void xsetuid(uid_t uid) FAST_FUNC;
379 void xchdir(const char *path) FAST_FUNC;
380 void xchroot(const char *path) FAST_FUNC;
381 void xsetenv(const char *key, const char *value) FAST_FUNC;
382 void xunlink(const char *pathname) FAST_FUNC;
383 void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
384 int xopen(const char *pathname, int flags) FAST_FUNC FAST_FUNC;
385 int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
386 int open_or_warn(const char *pathname, int flags) FAST_FUNC;
387 int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
388 int open_or_warn_stdin(const char *pathname) FAST_FUNC;
389 void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
390 int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
391 off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
392 off_t fdlength(int fd) FAST_FUNC;
394 void xpipe(int filedes[2]) FAST_FUNC;
395 /* In this form code with pipes is much more readable */
396 struct fd_pair { int rd; int wr; };
397 #define piped_pair(pair) pipe(&((pair).rd))
398 #define xpiped_pair(pair) xpipe(&((pair).rd))
400 /* Useful for having small structure members/global variables */
401 typedef int8_t socktype_t;
402 typedef int8_t family_t;
403 struct BUG_too_small {
404 char BUG_socktype_t_too_small[(0
411 char BUG_family_t_too_small[(0
428 int xsocket(int domain, int type, int protocol) FAST_FUNC;
429 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
430 void xlisten(int s, int backlog) FAST_FUNC;
431 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
432 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
433 socklen_t tolen) FAST_FUNC;
434 /* SO_REUSEADDR allows a server to rebind to an address that is already
435 * "in use" by old connections to e.g. previous server instance which is
436 * killed or crashed. Without it bind will fail until all such connections
437 * time out. Linux does not allow multiple live binds on same ip:port
438 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
439 * Turn it on before you call bind(). */
440 void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
441 int setsockopt_broadcast(int fd) 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 char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
544 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
545 * But potentially slow, don't use in one-billion-times loops */
546 int bb_putchar(int ch) FAST_FUNC;
547 char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
548 /* Prints unprintable chars ch as ^C or M-c to file
549 * (M-c is used only if ch is ORed with PRINTABLE_META),
550 * else it is printed as-is (except for ch = 0x9b) */
551 enum { PRINTABLE_META = 0x100 };
552 void fputc_printable(int ch, FILE *file) FAST_FUNC;
553 // gcc-4.1.1 still isn't good enough at optimizing it
554 // (+200 bytes compared to macro)
555 //static ALWAYS_INLINE
556 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
557 //static ALWAYS_INLINE
558 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
559 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
560 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
561 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
562 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
563 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
565 /* dmalloc will redefine these to it's own implementation. It is safe
566 * to have the prototypes here unconditionally. */
567 void *malloc_or_warn(size_t size) FAST_FUNC;
568 void *xmalloc(size_t size) FAST_FUNC;
569 void *xzalloc(size_t size) FAST_FUNC;
570 void *xrealloc(void *old, size_t size) FAST_FUNC;
571 #define xrealloc_vector(vector, shift, idx) \
572 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
573 void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
576 extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
577 extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count) FAST_FUNC;
578 // NB: will return short read on error, not -1,
579 // if some data was read before error occurred
580 extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
581 extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
582 extern unsigned char xread_char(int fd) FAST_FUNC;
583 // Reads one line a-la fgets (but doesn't save terminating '\n').
584 // Uses single full_read() call, works only on seekable streams.
585 extern char *reads(int fd, char *buf, size_t count) FAST_FUNC;
586 extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
587 extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
588 // Reads one line a-la fgets (but doesn't save terminating '\n').
589 // Reads byte-by-byte. Useful when it is important to not read ahead.
590 // Bytes are appended to pfx (which must be malloced, or NULL).
591 extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p) FAST_FUNC;
592 /* Reads block up to *maxsz_p (default: MAX_INT(ssize_t)) */
593 extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC;
594 /* Returns NULL if file can't be opened */
595 extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC;
596 /* Autodetects .gz etc */
597 extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC;
598 /* Never returns NULL */
599 extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC;
601 extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
602 // NB: will return short write on error, not -1,
603 // if some data was written before error occurred
604 extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
605 extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
606 extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
608 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
609 extern void xprint_and_close_file(FILE *file) FAST_FUNC;
610 /* Reads up to (and including) TERMINATING_STRING: */
611 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC;
612 /* Chops off TERMINATING_STRING from the end: */
613 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC;
614 /* Reads up to (and including) "\n" or NUL byte: */
615 extern char *xmalloc_fgets(FILE *file) FAST_FUNC;
616 /* Chops off '\n' from the end, unlike fgets: */
617 extern char *xmalloc_fgetline(FILE *file) FAST_FUNC;
618 extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
619 extern void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
620 extern void die_if_ferror_stdout(void) FAST_FUNC;
621 extern void xfflush_stdout(void) FAST_FUNC;
622 extern void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
623 extern int fclose_if_not_stdin(FILE *file) FAST_FUNC;
624 extern FILE *xfopen(const char *filename, const char *mode) FAST_FUNC;
625 /* Prints warning to stderr and returns NULL on failure: */
626 extern FILE *fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
627 /* "Opens" stdin if filename is special, else just opens file: */
628 extern FILE *xfopen_stdin(const char *filename) FAST_FUNC;
629 extern FILE *fopen_or_warn_stdin(const char *filename) FAST_FUNC;
631 int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
632 void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
634 /* Wrapper which restarts poll on EINTR or ENOMEM.
635 * On other errors complains [perror("poll")] and returns.
636 * Warning! May take (much) longer than timeout_ms to return!
637 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
638 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
640 char *safe_gethostname(void) FAST_FUNC;
641 char *safe_getdomainname(void) FAST_FUNC;
643 /* Convert each alpha char in str to lower-case */
644 char* str_tolower(char *str) FAST_FUNC;
646 char *utoa(unsigned n) FAST_FUNC;
647 char *itoa(int n) FAST_FUNC;
648 /* Returns a pointer past the formatted number, does NOT null-terminate */
649 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
650 char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
651 /* Intelligent formatters of bignums */
652 void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
653 void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
654 //TODO: provide pointer to buf (avoid statics)?
655 const char *make_human_readable_str(unsigned long long size,
656 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
657 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
658 char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
660 /* Last element is marked by mult == 0 */
667 /* Using xatoi() instead of naive atoi() is not always convenient -
668 * in many places people want *non-negative* values, but store them
669 * in signed int. Therefore we need this one:
670 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
671 int xatoi_u(const char *numstr) FAST_FUNC;
672 /* Useful for reading port numbers */
673 uint16_t xatou16(const char *numstr) FAST_FUNC;
676 /* These parse entries in /etc/passwd and /etc/group. This is desirable
677 * for BusyBox since we want to avoid using the glibc NSS stuff, which
678 * increases target size and is often not needed on embedded systems. */
679 long xuname2uid(const char *name) FAST_FUNC;
680 long xgroup2gid(const char *name) FAST_FUNC;
681 /* wrapper: allows string to contain numeric uid or gid */
682 unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
683 /* from chpst. Does not die, returns 0 on failure */
688 /* always sets uid and gid */
689 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
690 /* chown-like handling of "user[:[group]" */
691 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
692 /* bb_getpwuid, bb_getgrgid:
693 * bb_getXXXid(buf, bufsz, id) - copy user/group name or id
694 * as a string to buf, return user/group name or NULL
695 * bb_getXXXid(NULL, 0, id) - return user/group name or NULL
696 * bb_getXXXid(NULL, -1, id) - return user/group name or exit
698 char *bb_getpwuid(char *name, int bufsize, long uid) FAST_FUNC;
699 char *bb_getgrgid(char *group, int bufsize, long gid) FAST_FUNC;
700 /* versions which cache results (useful for ps, ls etc) */
701 const char* get_cached_username(uid_t uid) FAST_FUNC;
702 const char* get_cached_groupname(gid_t gid) FAST_FUNC;
703 void clear_username_cache(void) FAST_FUNC;
704 /* internally usernames are saved in fixed-sized char[] buffers */
705 enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
706 #if ENABLE_FEATURE_CHECK_NAMES
707 void die_if_bad_username(const char* name) FAST_FUNC;
709 #define die_if_bad_username(name) ((void)(name))
712 int execable_file(const char *name) FAST_FUNC;
713 char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
714 int exists_execable(const char *filename) FAST_FUNC;
716 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
717 * but it may exec busybox and call applet instead of searching PATH.
719 #if ENABLE_FEATURE_PREFER_APPLETS
720 int bb_execvp(const char *file, char *const argv[]) FAST_FUNC;
721 #define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
722 #define BB_EXECLP(prog,cmd,...) \
723 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
726 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
727 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
730 /* NOMMU friendy fork+exec */
731 pid_t spawn(char **argv) FAST_FUNC;
732 pid_t xspawn(char **argv) FAST_FUNC;
734 int safe_waitpid(int pid, int *wstat, int options) FAST_FUNC;
735 /* Unlike waitpid, waits ONLY for one process.
736 * It's safe to pass negative 'pids' from failed [v]fork -
737 * wait4pid will return -1 (and will not clobber [v]fork's errno).
738 * IOW: rc = wait4pid(spawn(argv));
739 * if (rc < 0) bb_perror_msg("%s", argv[0]);
740 * if (rc > 0) bb_error_msg("exit code: %d", rc);
742 int wait4pid(int pid) FAST_FUNC;
743 int wait_any_nohang(int *wstat) FAST_FUNC;
744 #define wait_crashed(w) ((w) & 127)
745 #define wait_exitcode(w) ((w) >> 8)
746 #define wait_stopsig(w) ((w) >> 8)
747 #define wait_stopped(w) (((w) & 127) == 127)
748 /* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
749 int spawn_and_wait(char **argv) FAST_FUNC;
750 struct nofork_save_area {
752 const char *applet_name;
753 int xfunc_error_retval;
754 uint32_t option_mask32;
758 void save_nofork_data(struct nofork_save_area *save) FAST_FUNC;
759 void restore_nofork_data(struct nofork_save_area *save) FAST_FUNC;
760 /* Does NOT check that applet is NOFORK, just blindly runs it */
761 int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
762 int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv) FAST_FUNC;
764 /* Helpers for daemonization.
766 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
768 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
769 * rexec's itself on NOMMU with argv passed as command line.
770 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
771 * from the start. (It will detect it and not reexec again second time).
772 * You have to audit carefully that you don't do something twice as a result
773 * (opening files/sockets, parsing config files etc...)!
775 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
776 * (will do setsid()).
778 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
779 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
780 * Currently used for openvt and setsid. On MMU ignores argv.
782 * Helper for network daemons in foreground mode:
784 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
785 * to /dev/null if they are not.
788 DAEMON_CHDIR_ROOT = 1,
789 DAEMON_DEVNULL_STDIO = 2,
790 DAEMON_CLOSE_EXTRA_FDS = 4,
791 DAEMON_ONLY_SANITIZE = 8, /* internal use */
794 void forkexit_or_rexec(void) FAST_FUNC;
795 enum { re_execed = 0 };
796 # define forkexit_or_rexec(argv) forkexit_or_rexec()
797 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
798 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
800 void re_exec(char **argv) NORETURN FAST_FUNC;
801 void forkexit_or_rexec(char **argv) FAST_FUNC;
802 extern bool re_execed;
803 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
804 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
805 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
806 # define fork() BUG_fork_is_unavailable_on_nommu()
807 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
808 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
810 void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
811 void bb_sanitize_stdio(void) FAST_FUNC;
812 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
813 int sanitize_env_if_suid(void) FAST_FUNC;
816 extern const char *const bb_argv_dash[]; /* "-", NULL */
817 extern const char *opt_complementary;
818 #if ENABLE_GETOPT_LONG
819 #define No_argument "\0"
820 #define Required_argument "\001"
821 #define Optional_argument "\002"
822 extern const char *applet_long_options;
824 extern uint32_t option_mask32;
825 extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
828 typedef struct llist_t {
830 struct llist_t *link;
832 void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
833 void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
834 void *llist_pop(llist_t **elm) FAST_FUNC;
835 void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
836 void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
837 llist_t *llist_rev(llist_t *list) FAST_FUNC;
838 /* BTW, surprisingly, changing API to
839 * llist_t *llist_add_to(llist_t *old_head, void *data)
840 * etc does not result in smaller code... */
842 /* start_stop_daemon and udhcpc are special - they want
843 * to create pidfiles regardless of FEATURE_PIDFILE */
844 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
845 /* True only if we created pidfile which is *file*, not /dev/null etc */
846 extern smallint wrote_pidfile;
847 void write_pidfile(const char *path) FAST_FUNC;
848 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
850 enum { wrote_pidfile = 0 };
851 #define write_pidfile(path) ((void)0)
852 #define remove_pidfile(path) ((void)0)
857 LOGMODE_STDIO = (1 << 0),
858 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
859 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
861 extern const char *msg_eol;
862 extern smallint logmode;
863 extern int die_sleep;
864 extern int xfunc_error_retval;
865 extern jmp_buf die_jmp;
866 extern void xfunc_die(void) NORETURN FAST_FUNC;
867 extern void bb_show_usage(void) NORETURN FAST_FUNC;
868 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
869 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
870 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
871 extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
872 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
873 extern void bb_simple_perror_msg_and_die(const char *s) __attribute__ ((noreturn)) FAST_FUNC;
874 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
875 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
876 extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
877 extern void bb_perror_nomsg(void) FAST_FUNC;
878 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
879 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
881 /* We need to export XXX_main from libbusybox
882 * only if we build "individual" binaries
884 #if ENABLE_FEATURE_INDIVIDUAL
885 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
887 #define MAIN_EXTERNALLY_VISIBLE
891 /* Applets which are useful from another applets */
892 int bb_cat(char** argv);
893 /* If shell needs them, they exist even if not enabled as applets */
894 int echo_main(int argc, char** argv) USE_ECHO(MAIN_EXTERNALLY_VISIBLE);
895 int printf_main(int argc, char **argv) USE_PRINTF(MAIN_EXTERNALLY_VISIBLE);
896 int test_main(int argc, char **argv) USE_TEST(MAIN_EXTERNALLY_VISIBLE);
897 int kill_main(int argc, char **argv) USE_KILL(MAIN_EXTERNALLY_VISIBLE);
898 /* Similar, but used by chgrp, not shell */
899 int chown_main(int argc, char **argv) USE_CHOWN(MAIN_EXTERNALLY_VISIBLE);
900 /* Don't need USE_xxx() guard for these */
901 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
902 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
903 int bbunpack(char **argv,
904 char* (*make_new_name)(char *filename),
905 USE_DESKTOP(long long) int (*unpacker)(void)
908 void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
913 int create_icmp_socket(void) FAST_FUNC;
914 int create_icmp6_socket(void) FAST_FUNC;
916 /* This structure defines protocol families and their handlers. */
922 char* FAST_FUNC (*print)(unsigned char *);
923 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
924 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
925 void FAST_FUNC (*herror)(char *text);
926 int FAST_FUNC (*rprint)(int options);
927 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
929 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
931 /* This structure defines hardware protocols and their handlers. */
937 char* FAST_FUNC (*print)(unsigned char *);
938 int FAST_FUNC (*input)(const char *, struct sockaddr *);
939 int FAST_FUNC (*activate)(int fd);
940 int suppress_null_addr;
942 extern smallint interface_opt_a;
943 int display_interfaces(char *ifname) FAST_FUNC;
944 #if ENABLE_FEATURE_HWIB
945 int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
947 #define in_ib(a, b) 1 /* fail */
949 const struct aftype *get_aftype(const char *name) FAST_FUNC;
950 const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
951 const struct hwtype *get_hwntype(int type) FAST_FUNC;
954 #ifndef BUILD_INDIVIDUAL
955 extern int find_applet_by_name(const char *name) FAST_FUNC;
956 /* Returns only if applet is not found. */
957 extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
958 extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
962 extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
963 extern struct mntent *find_mount_point(const char *name, const char *table) FAST_FUNC;
965 extern void erase_mtab(const char * name) FAST_FUNC;
966 extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
967 extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
968 extern void bb_warn_ignoring_args(int n) FAST_FUNC;
970 extern int get_linux_version_code(void) FAST_FUNC;
972 extern char *query_loop(const char *device) FAST_FUNC;
973 extern int del_loop(const char *device) FAST_FUNC;
974 /* If *devname is not NULL, use that name, otherwise try to find free one,
975 * malloc and return it in *devname.
976 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
977 extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
980 //TODO: pass buf pointer or return allocated buf (avoid statics)?
981 char *bb_askpass(int timeout, const char * prompt) FAST_FUNC;
982 int bb_ask_confirmation(void) FAST_FUNC;
984 extern int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
986 /* Concatenate path and filename to new allocated buffer.
987 * Add "/" only as needed (no duplicate "//" are produced).
988 * If path is NULL, it is assumed to be "/".
989 * filename should not be NULL. */
990 char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
991 char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
992 const char *bb_basename(const char *name) FAST_FUNC;
993 /* NB: can violate const-ness (similarly to strchr) */
994 char *last_char_is(const char *s, int c) FAST_FUNC;
997 USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out) FAST_FUNC;
998 int inflate(int in, int out) FAST_FUNC;
1001 int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1003 int get_signum(const char *name) FAST_FUNC;
1004 const char *get_signame(int number) FAST_FUNC;
1005 void print_signames(void) FAST_FUNC;
1007 char *bb_simplify_path(const char *path) FAST_FUNC;
1009 #define FAIL_DELAY 3
1010 extern void bb_do_delay(int seconds) FAST_FUNC;
1011 extern void change_identity(const struct passwd *pw) FAST_FUNC;
1012 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
1013 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) FAST_FUNC;
1015 extern void renew_current_security_context(void) FAST_FUNC;
1016 extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1017 extern context_t set_security_context_component(security_context_t cur_context,
1018 char *user, char *role, char *type, char *range) FAST_FUNC;
1019 extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1020 extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1022 #define selinux_preserve_fcontext(fdesc) ((void)0)
1024 extern void selinux_or_die(void) FAST_FUNC;
1025 extern int restricted_shell(const char *shell) FAST_FUNC;
1027 /* setup_environment:
1028 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1030 * USER=pw->pw_name, LOGNAME=pw->pw_name
1031 * PATH=bb_default_[root_]path
1034 * else if change_env = 1:
1035 * if not root (if pw->pw_uid != 0):
1036 * USER=pw->pw_name, LOGNAME=pw->pw_name
1041 extern void setup_environment(const char *shell, int clear_env, int change_env, const struct passwd *pw) FAST_FUNC;
1042 extern int correct_password(const struct passwd *pw) FAST_FUNC;
1043 /* Returns a malloced string */
1044 #if !ENABLE_USE_BB_CRYPT
1045 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1047 extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1048 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1049 /* rnd is additional random input. New one is returned.
1050 * Useful if you call crypt_make_salt many times in a row:
1051 * rnd = crypt_make_salt(buf1, 4, 0);
1052 * rnd = crypt_make_salt(buf2, 4, rnd);
1053 * rnd = crypt_make_salt(buf3, 4, rnd);
1054 * (otherwise we risk having same salt generated)
1056 extern int crypt_make_salt(char *p, int cnt, int rnd) FAST_FUNC;
1057 /* Returns number of lines changed, or -1 on error */
1058 extern int update_passwd(const char *filename, const char *username,
1059 const char *new_pw) FAST_FUNC;
1061 int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1062 int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1063 int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1064 int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1065 const char *nth_string(const char *strings, int n) FAST_FUNC;
1067 extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1068 extern void print_login_prompt(void) FAST_FUNC;
1070 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1071 int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1073 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1074 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1075 int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1076 #if ENABLE_IOCTL_HEX2STR_ERROR
1077 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1078 int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1079 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1080 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1082 int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1083 int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1084 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1085 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1088 char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1089 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1090 void reset_ino_dev_hashtable(void) FAST_FUNC;
1092 /* At least glibc has horrendously large inline for this, so wrap it */
1093 unsigned long long bb_makedev(unsigned int major, unsigned int minor) FAST_FUNC;
1095 #define makedev(a,b) bb_makedev(a,b)
1099 #if ENABLE_FEATURE_EDITING
1100 /* It's NOT just ENABLEd or disabled. It's a number: */
1101 #ifdef CONFIG_FEATURE_EDITING_HISTORY
1102 #define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1104 #define MAX_HISTORY 0
1106 typedef struct line_input_t {
1108 const char *path_lookup;
1112 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
1113 char *history[MAX_HISTORY + 1];
1117 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1118 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1119 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1120 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1121 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
1122 WITH_PATH_LOOKUP = 0x20,
1123 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1125 line_input_t *new_line_input_t(int flags) FAST_FUNC;
1127 * -1 on read errors or EOF, or on bare Ctrl-D,
1128 * 0 on ctrl-C (the line entered is still returned in 'command'),
1129 * >0 length of input string, including terminating '\n'
1131 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state) FAST_FUNC;
1133 int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1134 #define read_line_input(prompt, command, maxsize, state) \
1135 read_line_input(prompt, command, maxsize)
1140 #ifdef TASK_COMM_LEN
1141 enum { COMM_LEN = TASK_COMM_LEN };
1143 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1144 enum { COMM_LEN = 16 };
1147 typedef struct procps_status_t {
1149 uint8_t shift_pages_to_bytes;
1150 uint8_t shift_pages_to_kb;
1151 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1153 USE_SELINUX(char *context;)
1154 /* Everything below must contain no ptrs to malloc'ed data:
1155 * it is memset(0) for each process in procps_scan() */
1156 unsigned long vsz, rss; /* we round it to kbytes */
1157 unsigned long stime, utime;
1158 unsigned long start_time;
1165 unsigned tty_major,tty_minor;
1166 #if ENABLE_FEATURE_TOPMEM
1167 unsigned long mapped_rw;
1168 unsigned long mapped_ro;
1169 unsigned long shared_clean;
1170 unsigned long shared_dirty;
1171 unsigned long private_clean;
1172 unsigned long private_dirty;
1173 unsigned long stack;
1176 /* basename of executable in exec(2), read from /proc/N/stat
1177 * (if executable is symlink or script, it is NOT replaced
1178 * by link target or interpreter name) */
1179 char comm[COMM_LEN];
1180 /* user/group? - use passwd/group parsing functions */
1183 PSSCAN_PID = 1 << 0,
1184 PSSCAN_PPID = 1 << 1,
1185 PSSCAN_PGID = 1 << 2,
1186 PSSCAN_SID = 1 << 3,
1187 PSSCAN_UIDGID = 1 << 4,
1188 PSSCAN_COMM = 1 << 5,
1189 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
1190 PSSCAN_ARGV0 = 1 << 7,
1191 /* PSSCAN_EXE = 1 << 8, - not implemented */
1192 PSSCAN_STATE = 1 << 9,
1193 PSSCAN_VSZ = 1 << 10,
1194 PSSCAN_RSS = 1 << 11,
1195 PSSCAN_STIME = 1 << 12,
1196 PSSCAN_UTIME = 1 << 13,
1197 PSSCAN_TTY = 1 << 14,
1198 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1199 PSSCAN_ARGVN = (1 << 16) * (ENABLE_PGREP | ENABLE_PKILL),
1200 USE_SELINUX(PSSCAN_CONTEXT = 1 << 17,)
1201 PSSCAN_START_TIME = 1 << 18,
1202 /* These are all retrieved from proc/NN/stat in one go: */
1203 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
1204 | PSSCAN_COMM | PSSCAN_STATE
1205 | PSSCAN_VSZ | PSSCAN_RSS
1206 | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
1209 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1210 void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1211 procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
1212 /* Format cmdline (up to col chars) into char buf[col+1] */
1213 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1214 void read_cmdline(char *buf, int col, unsigned pid, const char *comm) FAST_FUNC;
1215 pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1216 pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
1219 extern const char bb_uuenc_tbl_base64[];
1220 extern const char bb_uuenc_tbl_std[];
1221 void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
1223 typedef struct sha1_ctx_t {
1228 void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1229 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx) FAST_FUNC;
1230 void *sha1_end(void *resbuf, sha1_ctx_t *ctx) FAST_FUNC;
1232 typedef struct md5_ctx_t {
1241 void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1242 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx) FAST_FUNC;
1243 void *md5_end(void *resbuf, md5_ctx_t *ctx) FAST_FUNC;
1245 uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1247 typedef struct masks_labels_t {
1251 int print_flags_separated(const int *masks, const char *labels,
1252 int flags, const char *separator) FAST_FUNC;
1253 int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
1256 extern const char *applet_name;
1257 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1258 extern const char bb_banner[];
1259 extern const char bb_msg_memory_exhausted[];
1260 extern const char bb_msg_invalid_date[];
1261 extern const char bb_msg_read_error[];
1262 extern const char bb_msg_write_error[];
1263 extern const char bb_msg_unknown[];
1264 extern const char bb_msg_can_not_create_raw_socket[];
1265 extern const char bb_msg_perm_denied_are_you_root[];
1266 extern const char bb_msg_requires_arg[];
1267 extern const char bb_msg_invalid_arg[];
1268 extern const char bb_msg_standard_input[];
1269 extern const char bb_msg_standard_output[];
1271 extern const char bb_str_default[];
1272 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1273 extern const char bb_hexdigits_upcase[];
1275 extern const char bb_path_mtab_file[];
1276 extern const char bb_path_passwd_file[];
1277 extern const char bb_path_shadow_file[];
1278 extern const char bb_path_gshadow_file[];
1279 extern const char bb_path_group_file[];
1280 extern const char bb_path_motd_file[];
1281 extern const char bb_path_wtmp_file[];
1282 extern const char bb_dev_null[];
1283 extern const char bb_busybox_exec_path[];
1284 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1285 * but I want to save a few bytes here */
1286 extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1287 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1288 #define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1290 extern const int const_int_0;
1291 extern const int const_int_1;
1297 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1298 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1299 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1300 /* This struct is deliberately not defined. */
1301 /* See docs/keep_data_small.txt */
1303 /* '*const' ptr makes gcc optimize code much better.
1304 * Magic prevents ptr_to_globals from going into rodata.
1305 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1306 extern struct globals *const ptr_to_globals;
1307 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1308 #define barrier() __asm__ __volatile__("":::"memory")
1309 #define SET_PTR_TO_GLOBALS(x) do { \
1310 (*(struct globals**)&ptr_to_globals) = (x); \
1314 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1315 * use bb_default_login_shell and following defines.
1316 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1317 * don't forget to change increment constant. */
1318 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
1319 extern const char bb_default_login_shell[];
1321 #define DEFAULT_SHELL (bb_default_login_shell+1)
1323 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1325 #if ENABLE_FEATURE_DEVFS
1326 # define CURRENT_VC "/dev/vc/0"
1327 # define VC_1 "/dev/vc/1"
1328 # define VC_2 "/dev/vc/2"
1329 # define VC_3 "/dev/vc/3"
1330 # define VC_4 "/dev/vc/4"
1331 # define VC_5 "/dev/vc/5"
1332 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1333 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1334 respective serial ports .. as such, we can't use the common device paths for
1336 # define SC_0 "/dev/ttsc/0"
1337 # define SC_1 "/dev/ttsc/1"
1338 # define SC_FORMAT "/dev/ttsc/%d"
1340 # define SC_0 "/dev/tts/0"
1341 # define SC_1 "/dev/tts/1"
1342 # define SC_FORMAT "/dev/tts/%d"
1344 # define VC_FORMAT "/dev/vc/%d"
1345 # define LOOP_FORMAT "/dev/loop/%d"
1346 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1347 # define LOOP_NAME "/dev/loop/"
1348 # define FB_0 "/dev/fb/0"
1350 # define CURRENT_VC "/dev/tty0"
1351 # define VC_1 "/dev/tty1"
1352 # define VC_2 "/dev/tty2"
1353 # define VC_3 "/dev/tty3"
1354 # define VC_4 "/dev/tty4"
1355 # define VC_5 "/dev/tty5"
1356 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1357 # define SC_0 "/dev/ttySC0"
1358 # define SC_1 "/dev/ttySC1"
1359 # define SC_FORMAT "/dev/ttySC%d"
1361 # define SC_0 "/dev/ttyS0"
1362 # define SC_1 "/dev/ttyS1"
1363 # define SC_FORMAT "/dev/ttyS%d"
1365 # define VC_FORMAT "/dev/tty%d"
1366 # define LOOP_FORMAT "/dev/loop%d"
1367 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1368 # define LOOP_NAME "/dev/loop"
1369 # define FB_0 "/dev/fb0"
1372 /* The following devices are the same on devfs and non-devfs systems. */
1373 #define CURRENT_TTY "/dev/tty"
1374 #define DEV_CONSOLE "/dev/console"
1377 #ifndef RB_POWER_OFF
1378 /* Stop system and switch power off if possible. */
1379 #define RB_POWER_OFF 0x4321fedc
1382 /* Make sure we call functions instead of macros. */
1396 /* This one is more efficient - we save ~400 bytes */
1398 #define isdigit(a) ((unsigned)((a) - '0') <= 9)
1400 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1403 #if __GNUC_PREREQ(4,1)
1404 # pragma GCC visibility pop
1408 #endif /* __LIBBUSYBOX_H__ */