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
30 #include <sys/ioctl.h>
32 #include <sys/socket.h>
34 #include <sys/statfs.h>
36 #include <sys/types.h>
44 #include <selinux/selinux.h>
45 #include <selinux/context.h>
48 #if ENABLE_LOCALE_SUPPORT
51 #define setlocale(x,y) ((void)0)
56 /* ifdef it out, because it may include <shadow.h> */
57 /* and we may not even _have_ <shadow.h>! */
58 #if ENABLE_FEATURE_SHADOWPASSWDS
62 /* Try to pull in PATH_MAX */
64 #include <sys/param.h>
69 /* Tested to work correctly (IIRC :]) */
70 #define MAXINT(T) (T)( \
73 : (T)~((T)1 << (sizeof(T)*8-1)) \
76 #define MININT(T) (T)( \
79 : ((T)1 << (sizeof(T)*8-1)) \
82 /* Large file support */
83 /* Note that CONFIG_LFS forces bbox to be built with all common ops
84 * (stat, lseek etc) mapped to "largefile" variants by libc.
85 * Practically it means that open() automatically has O_LARGEFILE added
86 * and all filesize/file_offset parameters and struct members are "large"
87 * (in today's world - signed 64bit). For full support of large files,
88 * we need a few helper #defines (below) and careful use of off_t
89 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
91 /* CONFIG_LFS is on */
92 # if ULONG_MAX > 0xffffffff
93 /* "long" is long enough on this system */
94 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
95 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
96 # define BB_STRTOOFF bb_strtoul
97 # define STRTOOFF strtoul
98 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
101 /* "long" is too short, need "long long" */
102 # define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
103 # define BB_STRTOOFF bb_strtoull
104 # define STRTOOFF strtoull
105 # define OFF_FMT "ll"
108 /* CONFIG_LFS is off */
109 # if UINT_MAX == 0xffffffff
110 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
111 * gcc will throw warnings on printf("%d", off_t). Crap... */
112 # define XATOOFF(a) xatoi_u(a)
113 # define BB_STRTOOFF bb_strtou
114 # define STRTOOFF strtol
117 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
118 # define BB_STRTOOFF bb_strtoul
119 # define STRTOOFF strtol
123 /* scary. better ideas? (but do *test* them first!) */
124 #define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
126 /* Some useful definitions */
128 #define FALSE ((int) 0)
130 #define TRUE ((int) 1)
132 #define SKIP ((int) 2)
135 #define MTAB_GETMOUNTPT '1'
136 #define MTAB_GETDEVICE '2'
138 #define BUF_SIZE 8192
139 #define EXPAND_ALLOC 1024
141 /* Macros for min/max. */
143 #define MIN(a,b) (((a)<(b))?(a):(b))
147 #define MAX(a,b) (((a)>(b))?(a):(b))
150 /* buffer allocation schemes */
151 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
152 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
153 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
154 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
156 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
157 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
158 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
159 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
161 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
162 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
163 #define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
168 #if defined(__GLIBC__)
169 /* glibc uses __errno_location() to get a ptr to errno */
170 /* We can just memorize it once - no multithreading in busybox :) */
171 extern int *const bb_errno;
173 #define errno (*bb_errno)
176 #if defined(__GLIBC__) && __GLIBC__ < 2
177 int vdprintf(int d, const char *format, va_list ap);
179 // This is declared here rather than #including <libgen.h> in order to avoid
180 // confusing the two versions of basename. See the dirname/basename man page
182 char *dirname(char *path);
183 /* Include our own copy of struct sysinfo to avoid binary compatibility
184 * problems with Linux 2.4, which changed things. Grumble, grumble. */
186 long uptime; /* Seconds since boot */
187 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
188 unsigned long totalram; /* Total usable main memory size */
189 unsigned long freeram; /* Available memory size */
190 unsigned long sharedram; /* Amount of shared memory */
191 unsigned long bufferram; /* Memory used by buffers */
192 unsigned long totalswap; /* Total swap space size */
193 unsigned long freeswap; /* swap space still available */
194 unsigned short procs; /* Number of current processes */
195 unsigned short pad; /* Padding needed for m68k */
196 unsigned long totalhigh; /* Total high memory size */
197 unsigned long freehigh; /* Available high memory size */
198 unsigned int mem_unit; /* Memory unit size in bytes */
199 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
201 int sysinfo(struct sysinfo* info);
203 unsigned long long monotonic_us(void);
204 unsigned monotonic_sec(void);
206 extern void chomp(char *s);
207 extern void trim(char *s);
208 extern char *skip_whitespace(const char *);
209 extern char *skip_non_whitespace(const char *);
211 //TODO: supply a pointer to char[11] buffer (avoid statics)?
212 extern const char *bb_mode_string(mode_t mode);
213 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
214 extern int remove_file(const char *path, int flags);
215 extern int copy_file(const char *source, const char *dest, int flags);
217 ACTION_RECURSE = (1 << 0),
218 ACTION_FOLLOWLINKS = (1 << 1),
219 ACTION_FOLLOWLINKS_L0 = (1 << 2),
220 ACTION_DEPTHFIRST = (1 << 3),
221 /*ACTION_REVERSE = (1 << 4), - unused */
223 extern int recursive_action(const char *fileName, unsigned flags,
224 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
225 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
226 void* userData, unsigned depth);
227 extern int device_open(const char *device, int mode);
228 extern int get_console_fd(void);
229 extern char *find_block_device(const char *path);
230 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
231 extern off_t bb_copyfd_eof(int fd1, int fd2);
232 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
233 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
234 /* "short" copy can be detected by return value < size */
235 /* this helper yells "short read!" if param is not -1 */
236 extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
237 extern char bb_process_escape_sequence(const char **ptr);
238 /* TODO: sometimes modifies its parameter, which
239 * makes it rather inconvenient at times: */
240 extern char *bb_get_last_path_component(char *path);
242 int ndelay_on(int fd);
243 int ndelay_off(int fd);
244 void xmove_fd(int, int);
247 DIR *xopendir(const char *path);
248 DIR *warn_opendir(const char *path);
250 char *xrealloc_getcwd_or_warn(char *cwd);
251 char *xmalloc_readlink_or_warn(const char *path);
252 char *xmalloc_realpath(const char *path);
255 //TODO: signal(sid, f) is the same? then why?
256 extern void sig_catch(int,void (*)(int));
257 //#define sig_ignore(s) (sig_catch((s), SIG_IGN))
258 //#define sig_uncatch(s) (sig_catch((s), SIG_DFL))
259 extern void sig_block(int);
260 extern void sig_unblock(int);
261 /* UNUSED: extern void sig_blocknone(void); */
262 extern void sig_pause(void);
265 void xsetgid(gid_t gid);
266 void xsetuid(uid_t uid);
267 void xchdir(const char *path);
268 void xsetenv(const char *key, const char *value);
269 void xunlink(const char *pathname);
270 void xstat(const char *pathname, struct stat *buf);
271 int xopen(const char *pathname, int flags);
272 int xopen3(const char *pathname, int flags, int mode);
273 int open_or_warn(const char *pathname, int flags);
274 int open3_or_warn(const char *pathname, int flags, int mode);
275 void xpipe(int filedes[2]);
276 off_t xlseek(int fd, off_t offset, int whence);
277 off_t fdlength(int fd);
279 int xsocket(int domain, int type, int protocol);
280 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
281 void xlisten(int s, int backlog);
282 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
283 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
285 int setsockopt_reuseaddr(int fd);
286 int setsockopt_broadcast(int fd);
287 /* NB: returns port in host byte order */
288 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
289 typedef struct len_and_sockaddr {
293 struct sockaddr_in sin;
294 #if ENABLE_FEATURE_IPV6
295 struct sockaddr_in6 sin6;
300 LSA_SIZEOF_SA = sizeof(
303 struct sockaddr_in sin;
304 #if ENABLE_FEATURE_IPV6
305 struct sockaddr_in6 sin6;
310 /* Create stream socket, and allocate suitable lsa.
311 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
312 * af == AF_UNSPEC will result in trying to create IPv6, and
313 * if kernel doesn't support it, IPv4.
315 int xsocket_type(len_and_sockaddr **lsap, USE_FEATURE_IPV6(int af,) int sock_type);
316 int xsocket_stream(len_and_sockaddr **lsap);
317 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
318 * numeric IP ("N.N.N.N") or numeric IPv6 address,
319 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
320 * Only if there is no suffix, port argument is used */
321 int create_and_bind_stream_or_die(const char *bindaddr, int port);
322 int create_and_bind_dgram_or_die(const char *bindaddr, int port);
323 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
324 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
325 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
326 * If there is no suffix, port argument is used */
327 int create_and_connect_stream_or_die(const char *peer, int port);
328 /* Connect to peer identified by lsa */
329 int xconnect_stream(const len_and_sockaddr *lsa);
330 /* Return malloc'ed len_and_sockaddr with socket address of host:port
331 * Currently will return IPv4 or IPv6 sockaddrs only
332 * (depending on host), but in theory nothing prevents e.g.
333 * UNIX socket address being returned, IPX sockaddr etc...
334 * On error does bb_error_msg and returns NULL */
335 len_and_sockaddr* host2sockaddr(const char *host, int port);
336 /* Version which dies on error */
337 len_and_sockaddr* xhost2sockaddr(const char *host, int port);
338 len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
339 #if ENABLE_FEATURE_IPV6
340 /* Same, useful if you want to force family (e.g. IPv6) */
341 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
342 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
344 /* [we evaluate af: think about "host_and_af2sockaddr(..., af++)"] */
345 #define host_and_af2sockaddr(host, port, af) ((void)(af), host2sockaddr((host), (port)))
346 #define xhost_and_af2sockaddr(host, port, af) ((void)(af), xhost2sockaddr((host), (port)))
348 /* Assign sin[6]_port member if the socket is of corresponding type,
349 * otherwise no-op. Useful for ftp.
350 * NB: does NOT do htons() internally, just direct assignment. */
351 void set_nport(len_and_sockaddr *lsa, unsigned port);
352 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
353 int get_nport(const struct sockaddr *sa);
354 /* Reverse DNS. Returns NULL on failure. */
355 char* xmalloc_sockaddr2host(const struct sockaddr *sa, socklen_t salen);
356 /* This one doesn't append :PORTNUM */
357 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa, socklen_t salen);
358 /* This one also doesn't fall back to dotted IP (returns NULL) */
359 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa, socklen_t salen);
360 /* inet_[ap]ton on steroids */
361 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa, socklen_t salen);
362 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa, socklen_t salen);
363 // "old" (ipv4 only) API
364 // users: traceroute.c hostname.c - use _list_ of all IPs
365 struct hostent *xgethostbyname(const char *name);
366 // Also mount.c and inetd.c are using gethostbyname(),
367 // + inet_common.c has additional IPv4-only stuff
370 void socket_want_pktinfo(int fd);
371 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
372 const struct sockaddr *from, const struct sockaddr *to,
374 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
375 struct sockaddr *from, struct sockaddr *to,
379 extern char *xstrdup(const char *s);
380 extern char *xstrndup(const char *s, int n);
381 extern char *safe_strncpy(char *dst, const char *src, size_t size);
382 extern char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
383 // gcc-4.1.1 still isn't good enough at optimizing it
384 // (+200 bytes compared to macro)
385 //static ALWAYS_INLINE
386 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
387 //static ALWAYS_INLINE
388 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
389 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
390 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
391 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
392 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
393 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
395 /* dmalloc will redefine these to it's own implementation. It is safe
396 * to have the prototypes here unconditionally. */
397 extern void *malloc_or_warn(size_t size);
398 extern void *xmalloc(size_t size);
399 extern void *xzalloc(size_t size);
400 extern void *xrealloc(void *old, size_t size);
402 extern ssize_t safe_read(int fd, void *buf, size_t count);
403 extern ssize_t full_read(int fd, void *buf, size_t count);
404 extern void xread(int fd, void *buf, size_t count);
405 extern unsigned char xread_char(int fd);
406 // Read one line a-la fgets. Uses one read(), works only on seekable streams
407 extern char *reads(int fd, char *buf, size_t count);
408 // Read one line a-la fgets. Reads byte-by-byte.
409 // Useful when it is important to not read ahead.
410 extern char *xmalloc_reads(int fd, char *pfx);
411 extern ssize_t read_close(int fd, void *buf, size_t count);
412 extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
413 extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
415 extern ssize_t safe_write(int fd, const void *buf, size_t count);
416 extern ssize_t full_write(int fd, const void *buf, size_t count);
417 extern void xwrite(int fd, const void *buf, size_t count);
419 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
420 extern void xprint_and_close_file(FILE *file);
421 extern char *xmalloc_fgets(FILE *file);
422 /* Read up to (and including) TERMINATING_STRING: */
423 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
424 /* Chops off '\n' from the end, unlike fgets: */
425 extern char *xmalloc_getline(FILE *file);
426 extern char *bb_get_chunk_from_file(FILE *file, int *end);
427 extern void die_if_ferror(FILE *file, const char *msg);
428 extern void die_if_ferror_stdout(void);
429 extern void xfflush_stdout(void);
430 extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
431 extern int fclose_if_not_stdin(FILE *file);
432 extern FILE *xfopen(const char *filename, const char *mode);
433 /* Prints warning to stderr and returns NULL on failure: */
434 extern FILE *fopen_or_warn(const char *filename, const char *mode);
435 /* "Opens" stdin if filename is special, else just opens file: */
436 extern FILE *fopen_or_warn_stdin(const char *filename);
438 /* Convert each alpha char in str to lower-case */
439 extern char* str_tolower(char *str);
441 char *utoa(unsigned n);
443 /* Returns a pointer past the formatted number, does NOT null-terminate */
444 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen);
445 char *itoa_to_buf(int n, char *buf, unsigned buflen);
446 void smart_ulltoa5(unsigned long long ul, char buf[5]);
447 //TODO: provide pointer to buf (avoid statics)?
448 const char *make_human_readable_str(unsigned long long size,
449 unsigned long block_size, unsigned long display_unit);
450 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
451 char *bin2hex(char *buf, const char *cp, int count);
459 /* Using xatoi() instead of naive atoi() is not always convenient -
460 * in many places people want *non-negative* values, but store them
461 * in signed int. Therefore we need this one:
462 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
463 int xatoi_u(const char *numstr);
464 /* Useful for reading port numbers */
465 uint16_t xatou16(const char *numstr);
468 /* These parse entries in /etc/passwd and /etc/group. This is desirable
469 * for BusyBox since we want to avoid using the glibc NSS stuff, which
470 * increases target size and is often not needed on embedded systems. */
471 long xuname2uid(const char *name);
472 long xgroup2gid(const char *name);
473 /* wrapper: allows string to contain numeric uid or gid */
474 unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
475 /* from chpst. Does not die, returns 0 on failure */
480 /* always sets uid and gid */
481 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
482 /* chown-like handling of "user[:[group]" */
483 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
485 /*extern char *bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);*/
486 char *bb_getpwuid(char *name, long uid, int bufsize);
487 char *bb_getgrgid(char *group, long gid, int bufsize);
488 /* versions which cache results (useful for ps, ls etc) */
489 const char* get_cached_username(uid_t uid);
490 const char* get_cached_groupname(gid_t gid);
491 void clear_username_cache(void);
492 /* internally usernames are saved in fixed-sized char[] buffers */
493 enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
497 int execable_file(const char *name);
498 char *find_execable(const char *filename);
499 int exists_execable(const char *filename);
501 #if ENABLE_FEATURE_PREFER_APPLETS
502 int bb_execvp(const char *file, char *const argv[]);
503 #define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
504 #define BB_EXECLP(prog,cmd,...) \
505 execlp((find_applet_by_name(prog)) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
508 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
509 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
512 /* NOMMU friendy fork+exec */
513 pid_t spawn(char **argv);
514 pid_t xspawn(char **argv);
516 /* Unlike waitpid, waits ONLY for one process,
517 * It's safe to pass negative 'pids' from failed [v]fork -
518 * wait4pid will return -1 (and will not clobber [v]fork's errno).
519 * IOW: rc = wait4pid(spawn(argv));
520 * if (rc < 0) bb_perror_msg("%s", argv[0]);
521 * if (rc > 0) bb_error_msg("exit code: %d", rc);
523 int wait4pid(int pid);
524 int wait_pid(int *wstat, int pid);
525 int wait_nohang(int *wstat);
526 #define wait_crashed(w) ((w) & 127)
527 #define wait_exitcode(w) ((w) >> 8)
528 #define wait_stopsig(w) ((w) >> 8)
529 #define wait_stopped(w) (((w) & 127) == 127)
530 /* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
531 int spawn_and_wait(char **argv);
532 struct nofork_save_area {
534 const struct bb_applet *current_applet;
535 int xfunc_error_retval;
536 uint32_t option_mask32;
540 void save_nofork_data(struct nofork_save_area *save);
541 void restore_nofork_data(struct nofork_save_area *save);
542 /* Does NOT check that applet is NOFORK, just blindly runs it */
543 int run_nofork_applet(const struct bb_applet *a, char **argv);
544 int run_nofork_applet_prime(struct nofork_save_area *old, const struct bb_applet *a, char **argv);
546 /* Helpers for daemonization.
548 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
550 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
551 * rexec's itself on NOMMU with argv passed as command line.
552 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
553 * from the start. (It will detect it and not reexec again second time).
554 * You have to audit carefully that you don't do something twice as a result
555 * (opening files/sockets, parsing config files etc...)!
557 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
558 * (will do setsid()).
560 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
561 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
562 * Currently used for openvt. On MMU ignores argv.
564 * Helper for network daemons in foreground mode:
566 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
567 * to /dev/null if they are not.
570 DAEMON_CHDIR_ROOT = 1,
571 DAEMON_DEVNULL_STDIO = /* 2 */ 0, /* no users so far */
572 DAEMON_CLOSE_EXTRA_FDS = 4,
573 DAEMON_ONLY_SANITIZE = 8, /* internal use */
576 void forkexit_or_rexec(void);
577 # define forkexit_or_rexec(argv) forkexit_or_rexec()
578 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
579 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
581 void forkexit_or_rexec(char **argv);
582 extern bool re_execed;
583 # define fork() BUG_fork_is_unavailable_on_nommu()
584 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
585 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
587 void bb_daemonize_or_rexec(int flags, char **argv);
588 void bb_sanitize_stdio(void);
591 extern const char *opt_complementary;
592 #if ENABLE_GETOPT_LONG
593 extern const struct option *applet_long_options;
595 extern uint32_t option_mask32;
596 extern uint32_t getopt32(int argc, char **argv, const char *applet_opts, ...);
599 typedef struct llist_t {
601 struct llist_t *link;
603 void llist_add_to(llist_t **old_head, void *data);
604 void llist_add_to_end(llist_t **list_head, void *data);
605 void *llist_pop(llist_t **elm);
606 void llist_unlink(llist_t **head, llist_t *elm);
607 void llist_free(llist_t *elm, void (*freeit)(void *data));
608 llist_t *llist_rev(llist_t *list);
609 /* BTW, surprisingly, changing API to
610 * llist_t *llist_add_to(llist_t *old_head, void *data)
611 * etc does not result in smaller code... */
614 #if ENABLE_FEATURE_PIDFILE
615 int write_pidfile(const char *path);
616 #define remove_pidfile(f) ((void)unlink(f))
618 /* Why? #defining it to 1 gives "warning: statement with no effect"... */
619 static ALWAYS_INLINE int write_pidfile(const char *path) { return 1; }
620 #define remove_pidfile(f) ((void)0)
625 LOGMODE_STDIO = 1<<0,
626 LOGMODE_SYSLOG = 1<<1,
627 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
629 extern const char *msg_eol;
630 extern smallint logmode;
631 extern int die_sleep;
632 extern int xfunc_error_retval;
633 extern jmp_buf die_jmp;
634 extern void xfunc_die(void) ATTRIBUTE_NORETURN;
635 extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
636 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
637 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
638 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
639 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
640 extern void bb_vherror_msg(const char *s, va_list p);
641 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
642 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
643 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
644 extern void bb_perror_nomsg(void);
645 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
646 /* These are used internally -- you shouldn't need to use them */
647 extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
648 extern void bb_vperror_msg(const char *s, va_list p);
649 extern void bb_vinfo_msg(const char *s, va_list p);
652 /* applets which are useful from another applets */
653 int bb_cat(char** argv);
654 int bb_echo(char** argv);
655 int test_main(int argc, char** argv);
656 int kill_main(int argc, char **argv);
658 void bb_displayroutes(int noresolve, int netstatfmt);
660 int chown_main(int argc, char **argv);
662 int gunzip_main(int argc, char **argv);
664 int bbunpack(char **argv,
665 char* (*make_new_name)(char *filename),
666 USE_DESKTOP(long long) int (*unpacker)(void)
671 int create_icmp_socket(void);
672 int create_icmp6_socket(void);
674 /* This structure defines protocol families and their handlers. */
680 char *(*print) (unsigned char *);
681 const char *(*sprint) (struct sockaddr *, int numeric);
682 int (*input) (/*int type,*/ const char *bufp, struct sockaddr *);
683 void (*herror) (char *text);
684 int (*rprint) (int options);
685 int (*rinput) (int typ, int ext, char **argv);
688 int (*getmask) (char *src, struct sockaddr * mask, char *name);
690 /* This structure defines hardware protocols and their handlers. */
696 char *(*print) (unsigned char *);
697 int (*input) (const char *, struct sockaddr *);
698 int (*activate) (int fd);
699 int suppress_null_addr;
701 extern smallint interface_opt_a;
702 int display_interfaces(char *ifname);
703 const struct aftype *get_aftype(const char *name);
704 const struct hwtype *get_hwtype(const char *name);
705 const struct hwtype *get_hwntype(int type);
708 #ifndef BUILD_INDIVIDUAL
709 extern const struct bb_applet *find_applet_by_name(const char *name);
710 /* Returns only if applet is not found. */
711 extern void run_applet_and_exit(const char *name, char **argv);
712 extern void run_current_applet_and_exit(char **argv) ATTRIBUTE_NORETURN;
715 extern int match_fstype(const struct mntent *mt, const char *fstypes);
716 extern struct mntent *find_mount_point(const char *name, const char *table);
717 extern void erase_mtab(const char * name);
718 extern unsigned int tty_baud_to_value(speed_t speed);
719 extern speed_t tty_value_to_baud(unsigned int value);
720 extern void bb_warn_ignoring_args(int n);
722 extern int get_linux_version_code(void);
724 extern char *query_loop(const char *device);
725 extern int del_loop(const char *device);
726 extern int set_loop(char **device, const char *file, unsigned long long offset);
729 //TODO: pass buf pointer or return allocated buf (avoid statics)?
730 char *bb_askpass(int timeout, const char * prompt);
731 int bb_ask_confirmation(void);
732 int klogctl(int type, char * b, int len);
734 extern int bb_parse_mode(const char* s, mode_t* theMode);
736 char *concat_path_file(const char *path, const char *filename);
737 char *concat_subpath_file(const char *path, const char *filename);
738 const char *bb_basename(const char *name);
739 /* NB: can violate const-ness (similarly to strchr) */
740 char *last_char_is(const char *s, int c);
743 USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
744 int inflate(int in, int out);
747 int bb_make_directory(char *path, long mode, int flags);
749 int get_signum(const char *name);
750 const char *get_signame(int number);
752 char *bb_simplify_path(const char *path);
755 extern void bb_do_delay(int seconds);
756 extern void change_identity(const struct passwd *pw);
757 extern const char *change_identity_e2str(const struct passwd *pw);
758 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
760 extern void renew_current_security_context(void);
761 extern void set_current_security_context(security_context_t sid);
762 extern context_t set_security_context_component(security_context_t cur_context,
763 char *user, char *role, char *type, char *range);
764 extern void setfscreatecon_or_die(security_context_t scontext);
766 extern void selinux_or_die(void);
767 extern int restricted_shell(const char *shell);
768 extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
769 extern int correct_password(const struct passwd *pw);
770 /* Returns a ptr to static storage */
771 extern char *pw_encrypt(const char *clear, const char *salt);
772 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
773 extern int index_in_str_array(const char * const string_array[], const char *key);
774 extern int index_in_substr_array(const char * const string_array[], const char *key);
775 extern void print_login_issue(const char *issue_file, const char *tty);
776 extern void print_login_prompt(void);
778 /* rnd is additional random input. New one is returned.
779 * Useful if you call crypt_make_salt many times in a row:
780 * rnd = crypt_make_salt(buf1, 4, 0);
781 * rnd = crypt_make_salt(buf2, 4, rnd);
782 * rnd = crypt_make_salt(buf3, 4, rnd);
783 * (otherwise we risk having same salt generated)
785 extern int crypt_make_salt(char *p, int cnt, int rnd);
787 /* Returns number of lines changed, or -1 on error */
788 extern int update_passwd(const char *filename, const char *username,
791 int get_terminal_width_height(const int fd, int *width, int *height);
793 int ioctl_or_perror(int fd, int request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
794 void ioctl_or_perror_and_die(int fd, int request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
795 #if ENABLE_IOCTL_HEX2STR_ERROR
796 int bb_ioctl_or_warn(int fd, int request, void *argp, const char *ioctl_name);
797 void bb_xioctl(int fd, int request, void *argp, const char *ioctl_name);
798 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
799 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
801 int bb_ioctl_or_warn(int fd, int request, void *argp);
802 void bb_xioctl(int fd, int request, void *argp);
803 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
804 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
807 char *is_in_ino_dev_hashtable(const struct stat *statbuf);
808 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
809 void reset_ino_dev_hashtable(void);
811 /* At least glibc has horrendously large inline for this, so wrap it */
812 unsigned long long bb_makedev(unsigned int major, unsigned int minor);
814 #define makedev(a,b) bb_makedev(a,b)
818 #if ENABLE_FEATURE_EDITING
819 /* It's NOT just ENABLEd or disabled. It's a number: */
820 #ifdef CONFIG_FEATURE_EDITING_HISTORY
821 #define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
823 #define MAX_HISTORY 0
825 typedef struct line_input_t {
827 const char *path_lookup;
831 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
832 char *history[MAX_HISTORY + 1];
836 DO_HISTORY = 1 * (MAX_HISTORY > 0),
837 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
838 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
839 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
840 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
841 WITH_PATH_LOOKUP = 0x20,
842 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
844 line_input_t *new_line_input_t(int flags);
845 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
847 int read_line_input(const char* prompt, char* command, int maxsize);
848 #define read_line_input(prompt, command, maxsize, state) \
849 read_line_input(prompt, command, maxsize)
855 enum { COMM_LEN = TASK_COMM_LEN };
857 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
858 enum { COMM_LEN = 16 };
863 /* Fields are set to 0/NULL if failed to determine (or not requested) */
867 USE_SELINUX(char *context;)
868 /* Everything below must contain no ptrs to malloc'ed data:
869 * it is memset(0) for each process in procps_scan() */
870 unsigned vsz, rss; /* we round it to kbytes */
871 unsigned long stime, utime;
878 unsigned tty_major,tty_minor;
880 /* basename of executable in exec(2), read from /proc/N/stat
881 * (if executable is symlink or script, it is NOT replaced
882 * by link target or interpreter name) */
884 /* user/group? - use passwd/group parsing functions */
888 PSSCAN_PPID = 1 << 1,
889 PSSCAN_PGID = 1 << 2,
891 PSSCAN_UIDGID = 1 << 4,
892 PSSCAN_COMM = 1 << 5,
893 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
894 PSSCAN_ARGV0 = 1 << 7,
895 /* PSSCAN_EXE = 1 << 8, - not implemented */
896 PSSCAN_STATE = 1 << 9,
897 PSSCAN_VSZ = 1 << 10,
898 PSSCAN_RSS = 1 << 11,
899 PSSCAN_STIME = 1 << 12,
900 PSSCAN_UTIME = 1 << 13,
901 PSSCAN_TTY = 1 << 14,
902 USE_SELINUX(PSSCAN_CONTEXT = 1 << 15,)
903 /* These are all retrieved from proc/NN/stat in one go: */
904 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
905 | PSSCAN_COMM | PSSCAN_STATE
906 | PSSCAN_VSZ | PSSCAN_RSS
907 | PSSCAN_STIME | PSSCAN_UTIME
910 procps_status_t* alloc_procps_scan(int flags);
911 void free_procps_scan(procps_status_t* sp);
912 procps_status_t* procps_scan(procps_status_t* sp, int flags);
913 /* Format cmdline (up to col chars) into char buf[col+1] */
914 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
915 void read_cmdline(char *buf, int col, unsigned pid, const char *comm);
916 pid_t *find_pid_by_name(const char* procName);
917 pid_t *pidlist_reverse(pid_t *pidList);
920 extern const char bb_uuenc_tbl_base64[];
921 extern const char bb_uuenc_tbl_std[];
922 void bb_uuencode(char *store, const void *s, int length, const char *tbl);
924 typedef struct sha1_ctx_t {
929 void sha1_begin(sha1_ctx_t *ctx);
930 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
931 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
933 typedef struct md5_ctx_t {
942 void md5_begin(md5_ctx_t *ctx);
943 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
944 void *md5_end(void *resbuf, md5_ctx_t *ctx);
946 uint32_t *crc32_filltable(uint32_t *tbl256, int endian);
949 enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
950 FILEUTILS_PRESERVE_STATUS = 1,
951 FILEUTILS_DEREFERENCE = 2,
954 FILEUTILS_INTERACTIVE = 0x10,
955 FILEUTILS_MAKE_HARDLINK = 0x20,
956 FILEUTILS_MAKE_SOFTLINK = 0x40,
958 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x80,
959 FILEUTILS_SET_SECURITY_CONTEXT = 0x100
963 #define FILEUTILS_CP_OPTSTR "pdRfils" USE_SELINUX("c")
964 extern const struct bb_applet *current_applet;
965 extern const char *applet_name;
966 /* "BusyBox vN.N.N (timestamp or extra_vestion)" */
967 extern const char bb_banner[];
968 extern const char bb_msg_memory_exhausted[];
969 extern const char bb_msg_invalid_date[];
970 extern const char bb_msg_read_error[];
971 extern const char bb_msg_write_error[];
972 extern const char bb_msg_unknown[];
973 extern const char bb_msg_can_not_create_raw_socket[];
974 extern const char bb_msg_perm_denied_are_you_root[];
975 extern const char bb_msg_requires_arg[];
976 extern const char bb_msg_invalid_arg[];
977 extern const char bb_msg_standard_input[];
978 extern const char bb_msg_standard_output[];
980 extern const char bb_str_default[];
981 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
982 extern const char bb_hexdigits_upcase[];
984 extern const char bb_path_mtab_file[];
985 extern const char bb_path_passwd_file[];
986 extern const char bb_path_shadow_file[];
987 extern const char bb_path_gshadow_file[];
988 extern const char bb_path_group_file[];
989 extern const char bb_path_motd_file[];
990 extern const char bb_path_wtmp_file[];
991 extern const char bb_dev_null[];
992 extern const char bb_busybox_exec_path[];
993 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
994 * but I want to save a few bytes here */
995 extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
996 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
997 #define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
999 extern const int const_int_0;
1000 extern const int const_int_1;
1006 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1007 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1008 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1009 /* This struct is deliberately not defined. */
1010 /* See docs/keep_data_small.txt */
1012 /* '*const' ptr makes gcc optimize code much better.
1013 * Magic prevents ptr_to_globals from going into rodata
1014 * If you want to assign a value, use PTR_TO_GLOBALS = xxx */
1015 extern struct globals *const ptr_to_globals;
1016 #define PTR_TO_GLOBALS (*(struct globals**)&ptr_to_globals)
1019 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1020 * use bb_default_login_shell and following defines.
1021 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1022 * don't forget to change increment constant. */
1023 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
1024 extern const char bb_default_login_shell[];
1026 #define DEFAULT_SHELL (bb_default_login_shell+1)
1028 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1031 #if ENABLE_FEATURE_DEVFS
1032 # define CURRENT_VC "/dev/vc/0"
1033 # define VC_1 "/dev/vc/1"
1034 # define VC_2 "/dev/vc/2"
1035 # define VC_3 "/dev/vc/3"
1036 # define VC_4 "/dev/vc/4"
1037 # define VC_5 "/dev/vc/5"
1038 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1039 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1040 respective serial ports .. as such, we can't use the common device paths for
1042 # define SC_0 "/dev/ttsc/0"
1043 # define SC_1 "/dev/ttsc/1"
1044 # define SC_FORMAT "/dev/ttsc/%d"
1046 # define SC_0 "/dev/tts/0"
1047 # define SC_1 "/dev/tts/1"
1048 # define SC_FORMAT "/dev/tts/%d"
1050 # define VC_FORMAT "/dev/vc/%d"
1051 # define LOOP_FORMAT "/dev/loop/%d"
1052 # define LOOP_NAME "/dev/loop/"
1053 # define FB_0 "/dev/fb/0"
1055 # define CURRENT_VC "/dev/tty0"
1056 # define VC_1 "/dev/tty1"
1057 # define VC_2 "/dev/tty2"
1058 # define VC_3 "/dev/tty3"
1059 # define VC_4 "/dev/tty4"
1060 # define VC_5 "/dev/tty5"
1061 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1062 # define SC_0 "/dev/ttySC0"
1063 # define SC_1 "/dev/ttySC1"
1064 # define SC_FORMAT "/dev/ttySC%d"
1066 # define SC_0 "/dev/ttyS0"
1067 # define SC_1 "/dev/ttyS1"
1068 # define SC_FORMAT "/dev/ttyS%d"
1070 # define VC_FORMAT "/dev/tty%d"
1071 # define LOOP_FORMAT "/dev/loop%d"
1072 # define LOOP_NAME "/dev/loop"
1073 # define FB_0 "/dev/fb0"
1076 /* The following devices are the same on devfs and non-devfs systems. */
1077 #define CURRENT_TTY "/dev/tty"
1078 #define DEV_CONSOLE "/dev/console"
1081 #ifndef RB_POWER_OFF
1082 /* Stop system and switch power off if possible. */
1083 #define RB_POWER_OFF 0x4321fedc
1086 /* Make sure we call functions instead of macros. */
1100 /* This one is more efficient - we save ~400 bytes */
1102 #define isdigit(a) ((unsigned)((a) - '0') <= 9)
1106 #include <dmalloc.h>
1110 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
1112 #endif /* __LIBBUSYBOX_H__ */