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 <strings.h> - said to be obsolete */
31 #include <sys/ioctl.h>
33 #include <sys/socket.h>
35 #include <sys/statfs.h>
37 #include <sys/types.h>
45 #include <selinux/selinux.h>
46 #include <selinux/context.h>
49 #if ENABLE_LOCALE_SUPPORT
52 #define setlocale(x,y) ((void)0)
57 /* ifdef it out, because it may include <shadow.h> */
58 /* and we may not even _have_ <shadow.h>! */
59 #if ENABLE_FEATURE_SHADOWPASSWDS
63 /* Try to pull in PATH_MAX */
65 #include <sys/param.h>
70 /* Tested to work correctly (IIRC :]) */
71 #define MAXINT(T) (T)( \
74 : (T)~((T)1 << (sizeof(T)*8-1)) \
77 #define MININT(T) (T)( \
80 : ((T)1 << (sizeof(T)*8-1)) \
83 /* Large file support */
84 /* Note that CONFIG_LFS forces bbox to be built with all common ops
85 * (stat, lseek etc) mapped to "largefile" variants by libc.
86 * Practically it means that open() automatically has O_LARGEFILE added
87 * and all filesize/file_offset parameters and struct members are "large"
88 * (in today's world - signed 64bit). For full support of large files,
89 * we need a few helper #defines (below) and careful use of off_t
90 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
92 /* CONFIG_LFS is on */
93 # if ULONG_MAX > 0xffffffff
94 /* "long" is long enough on this system */
95 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
96 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
97 # define BB_STRTOOFF bb_strtoul
98 # define STRTOOFF strtoul
99 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
102 /* "long" is too short, need "long long" */
103 # define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
104 # define BB_STRTOOFF bb_strtoull
105 # define STRTOOFF strtoull
106 # define OFF_FMT "ll"
109 /* CONFIG_LFS is off */
110 # if UINT_MAX == 0xffffffff
111 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
112 * gcc will throw warnings on printf("%d", off_t). Crap... */
113 # define XATOOFF(a) xatoi_u(a)
114 # define BB_STRTOOFF bb_strtou
115 # define STRTOOFF strtol
118 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
119 # define BB_STRTOOFF bb_strtoul
120 # define STRTOOFF strtol
124 /* scary. better ideas? (but do *test* them first!) */
125 #define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
127 /* Some useful definitions */
129 #define FALSE ((int) 0)
131 #define TRUE ((int) 1)
133 #define SKIP ((int) 2)
136 #define MTAB_GETMOUNTPT '1'
137 #define MTAB_GETDEVICE '2'
139 #define BUF_SIZE 8192
140 #define EXPAND_ALLOC 1024
142 /* Macros for min/max. */
144 #define MIN(a,b) (((a)<(b))?(a):(b))
148 #define MAX(a,b) (((a)>(b))?(a):(b))
151 /* buffer allocation schemes */
152 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
153 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
154 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
155 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
157 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
158 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
159 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
160 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
162 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
163 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
164 #define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
169 #if defined(__GLIBC__)
170 /* glibc uses __errno_location() to get a ptr to errno */
171 /* We can just memorize it once - no multithreading in busybox :) */
172 extern int *const bb_errno;
174 #define errno (*bb_errno)
177 #if defined(__GLIBC__) && __GLIBC__ < 2
178 int vdprintf(int d, const char *format, va_list ap);
180 // This is declared here rather than #including <libgen.h> in order to avoid
181 // confusing the two versions of basename. See the dirname/basename man page
183 char *dirname(char *path);
184 /* Include our own copy of struct sysinfo to avoid binary compatibility
185 * problems with Linux 2.4, which changed things. Grumble, grumble. */
187 long uptime; /* Seconds since boot */
188 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
189 unsigned long totalram; /* Total usable main memory size */
190 unsigned long freeram; /* Available memory size */
191 unsigned long sharedram; /* Amount of shared memory */
192 unsigned long bufferram; /* Memory used by buffers */
193 unsigned long totalswap; /* Total swap space size */
194 unsigned long freeswap; /* swap space still available */
195 unsigned short procs; /* Number of current processes */
196 unsigned short pad; /* Padding needed for m68k */
197 unsigned long totalhigh; /* Total high memory size */
198 unsigned long freehigh; /* Available high memory size */
199 unsigned int mem_unit; /* Memory unit size in bytes */
200 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
202 int sysinfo(struct sysinfo* info);
204 unsigned long long monotonic_us(void);
205 unsigned monotonic_sec(void);
207 extern void chomp(char *s);
208 extern void trim(char *s);
209 extern char *skip_whitespace(const char *);
210 extern char *skip_non_whitespace(const char *);
212 //TODO: supply a pointer to char[11] buffer (avoid statics)?
213 extern const char *bb_mode_string(mode_t mode);
214 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
215 extern int remove_file(const char *path, int flags);
216 extern int copy_file(const char *source, const char *dest, int flags);
218 ACTION_RECURSE = (1 << 0),
219 ACTION_FOLLOWLINKS = (1 << 1),
220 ACTION_FOLLOWLINKS_L0 = (1 << 2),
221 ACTION_DEPTHFIRST = (1 << 3),
222 /*ACTION_REVERSE = (1 << 4), - unused */
224 extern int recursive_action(const char *fileName, unsigned flags,
225 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
226 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
227 void* userData, unsigned depth);
228 extern int device_open(const char *device, int mode);
229 extern int get_console_fd(void);
230 extern char *find_block_device(const char *path);
231 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
232 extern off_t bb_copyfd_eof(int fd1, int fd2);
233 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
234 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
235 /* "short" copy can be detected by return value < size */
236 /* this helper yells "short read!" if param is not -1 */
237 extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
238 extern char bb_process_escape_sequence(const char **ptr);
239 /* TODO: sometimes modifies its parameter, which
240 * makes it rather inconvenient at times: */
241 extern char *bb_get_last_path_component(char *path);
243 int ndelay_on(int fd);
244 int ndelay_off(int fd);
245 void xdup2(int, int);
246 void xmove_fd(int, int);
249 DIR *xopendir(const char *path);
250 DIR *warn_opendir(const char *path);
252 /* UNUSED: char *xmalloc_realpath(const char *path); */
253 char *xmalloc_readlink(const char *path);
254 char *xmalloc_readlink_or_warn(const char *path);
255 char *xrealloc_getcwd_or_warn(char *cwd);
258 //TODO: signal(sid, f) is the same? then why?
259 extern void sig_catch(int,void (*)(int));
260 //#define sig_ignore(s) (sig_catch((s), SIG_IGN))
261 //#define sig_uncatch(s) (sig_catch((s), SIG_DFL))
262 extern void sig_block(int);
263 extern void sig_unblock(int);
264 /* UNUSED: extern void sig_blocknone(void); */
265 extern void sig_pause(void);
268 void xsetgid(gid_t gid);
269 void xsetuid(uid_t uid);
270 void xchdir(const char *path);
271 void xsetenv(const char *key, const char *value);
272 void xunlink(const char *pathname);
273 void xstat(const char *pathname, struct stat *buf);
274 int xopen(const char *pathname, int flags);
275 int xopen3(const char *pathname, int flags, int mode);
276 int open_or_warn(const char *pathname, int flags);
277 int open3_or_warn(const char *pathname, int flags, int mode);
278 void xpipe(int filedes[2]);
279 off_t xlseek(int fd, off_t offset, int whence);
280 off_t fdlength(int fd);
282 int xsocket(int domain, int type, int protocol);
283 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
284 void xlisten(int s, int backlog);
285 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
286 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
288 /* SO_REUSEADDR allows a server to rebind to an address that is already
289 * "in use" by old connections to e.g. previous server instance which is
290 * killed or crashed. Without it bind will fail until all such connections
291 * time out. Linux does not allow multiple live binds on same ip:port
292 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
293 * Turn it on before you call bind(). */
294 void setsockopt_reuseaddr(int fd); /* On Linux this never fails. */
295 int setsockopt_broadcast(int fd);
296 /* NB: returns port in host byte order */
297 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
298 typedef struct len_and_sockaddr {
302 struct sockaddr_in sin;
303 #if ENABLE_FEATURE_IPV6
304 struct sockaddr_in6 sin6;
309 LSA_SIZEOF_SA = sizeof(
312 struct sockaddr_in sin;
313 #if ENABLE_FEATURE_IPV6
314 struct sockaddr_in6 sin6;
319 /* Create stream socket, and allocate suitable lsa.
320 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
321 * af == AF_UNSPEC will result in trying to create IPv6 socket,
322 * and if kernel doesn't support it, IPv4.
324 int xsocket_type(len_and_sockaddr **lsap, USE_FEATURE_IPV6(int af,) int sock_type);
325 int xsocket_stream(len_and_sockaddr **lsap);
326 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
327 * numeric IP ("N.N.N.N") or numeric IPv6 address,
328 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
329 * Only if there is no suffix, port argument is used */
330 /* NB: these set SO_REUSEADDR before bind */
331 int create_and_bind_stream_or_die(const char *bindaddr, int port);
332 int create_and_bind_dgram_or_die(const char *bindaddr, int port);
333 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
334 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
335 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
336 * If there is no suffix, port argument is used */
337 int create_and_connect_stream_or_die(const char *peer, int port);
338 /* Connect to peer identified by lsa */
339 int xconnect_stream(const len_and_sockaddr *lsa);
340 /* Return malloc'ed len_and_sockaddr with socket address of host:port
341 * Currently will return IPv4 or IPv6 sockaddrs only
342 * (depending on host), but in theory nothing prevents e.g.
343 * UNIX socket address being returned, IPX sockaddr etc...
344 * On error does bb_error_msg and returns NULL */
345 len_and_sockaddr* host2sockaddr(const char *host, int port);
346 /* Version which dies on error */
347 len_and_sockaddr* xhost2sockaddr(const char *host, int port);
348 len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
349 #if ENABLE_FEATURE_IPV6
350 /* Same, useful if you want to force family (e.g. IPv6) */
351 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
352 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
354 /* [we evaluate af: think about "host_and_af2sockaddr(..., af++)"] */
355 #define host_and_af2sockaddr(host, port, af) ((void)(af), host2sockaddr((host), (port)))
356 #define xhost_and_af2sockaddr(host, port, af) ((void)(af), xhost2sockaddr((host), (port)))
358 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
359 * otherwise no-op. Useful for ftp.
360 * NB: does NOT do htons() internally, just direct assignment. */
361 void set_nport(len_and_sockaddr *lsa, unsigned port);
362 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
363 int get_nport(const struct sockaddr *sa);
364 /* Reverse DNS. Returns NULL on failure. */
365 char* xmalloc_sockaddr2host(const struct sockaddr *sa);
366 /* This one doesn't append :PORTNUM */
367 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa);
368 /* This one also doesn't fall back to dotted IP (returns NULL) */
369 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa);
370 /* inet_[ap]ton on steroids */
371 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa);
372 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa);
373 // "old" (ipv4 only) API
374 // users: traceroute.c hostname.c - use _list_ of all IPs
375 struct hostent *xgethostbyname(const char *name);
376 // Also mount.c and inetd.c are using gethostbyname(),
377 // + inet_common.c has additional IPv4-only stuff
380 void socket_want_pktinfo(int fd);
381 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
382 const struct sockaddr *from, const struct sockaddr *to,
384 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
385 struct sockaddr *from, struct sockaddr *to,
389 extern char *xstrdup(const char *s);
390 extern char *xstrndup(const char *s, int n);
391 extern char *safe_strncpy(char *dst, const char *src, size_t size);
392 extern char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
393 // gcc-4.1.1 still isn't good enough at optimizing it
394 // (+200 bytes compared to macro)
395 //static ALWAYS_INLINE
396 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
397 //static ALWAYS_INLINE
398 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
399 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
400 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
401 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
402 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
403 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
405 /* dmalloc will redefine these to it's own implementation. It is safe
406 * to have the prototypes here unconditionally. */
407 extern void *malloc_or_warn(size_t size);
408 extern void *xmalloc(size_t size);
409 extern void *xzalloc(size_t size);
410 extern void *xrealloc(void *old, size_t size);
412 extern ssize_t safe_read(int fd, void *buf, size_t count);
413 extern ssize_t full_read(int fd, void *buf, size_t count);
414 extern void xread(int fd, void *buf, size_t count);
415 extern unsigned char xread_char(int fd);
416 // Read one line a-la fgets. Uses one read(), works only on seekable streams
417 extern char *reads(int fd, char *buf, size_t count);
418 // Read one line a-la fgets. Reads byte-by-byte.
419 // Useful when it is important to not read ahead.
420 extern char *xmalloc_reads(int fd, char *pfx);
421 extern ssize_t read_close(int fd, void *buf, size_t count);
422 extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
423 extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
425 extern ssize_t safe_write(int fd, const void *buf, size_t count);
426 extern ssize_t full_write(int fd, const void *buf, size_t count);
427 extern void xwrite(int fd, const void *buf, size_t count);
429 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
430 extern void xprint_and_close_file(FILE *file);
431 extern char *xmalloc_fgets(FILE *file);
432 /* Read up to (and including) TERMINATING_STRING: */
433 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
434 /* Chops off '\n' from the end, unlike fgets: */
435 extern char *xmalloc_getline(FILE *file);
436 extern char *bb_get_chunk_from_file(FILE *file, int *end);
437 extern void die_if_ferror(FILE *file, const char *msg);
438 extern void die_if_ferror_stdout(void);
439 extern void xfflush_stdout(void);
440 extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
441 extern int fclose_if_not_stdin(FILE *file);
442 extern FILE *xfopen(const char *filename, const char *mode);
443 /* Prints warning to stderr and returns NULL on failure: */
444 extern FILE *fopen_or_warn(const char *filename, const char *mode);
445 /* "Opens" stdin if filename is special, else just opens file: */
446 extern FILE *fopen_or_warn_stdin(const char *filename);
448 /* Convert each alpha char in str to lower-case */
449 extern char* str_tolower(char *str);
451 char *utoa(unsigned n);
453 /* Returns a pointer past the formatted number, does NOT null-terminate */
454 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen);
455 char *itoa_to_buf(int n, char *buf, unsigned buflen);
456 void smart_ulltoa5(unsigned long long ul, char buf[5]);
457 //TODO: provide pointer to buf (avoid statics)?
458 const char *make_human_readable_str(unsigned long long size,
459 unsigned long block_size, unsigned long display_unit);
460 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
461 char *bin2hex(char *buf, const char *cp, int count);
463 /* Last element is marked by mult == 0 */
470 /* Using xatoi() instead of naive atoi() is not always convenient -
471 * in many places people want *non-negative* values, but store them
472 * in signed int. Therefore we need this one:
473 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
474 int xatoi_u(const char *numstr);
475 /* Useful for reading port numbers */
476 uint16_t xatou16(const char *numstr);
479 /* These parse entries in /etc/passwd and /etc/group. This is desirable
480 * for BusyBox since we want to avoid using the glibc NSS stuff, which
481 * increases target size and is often not needed on embedded systems. */
482 long xuname2uid(const char *name);
483 long xgroup2gid(const char *name);
484 /* wrapper: allows string to contain numeric uid or gid */
485 unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
486 /* from chpst. Does not die, returns 0 on failure */
491 /* always sets uid and gid */
492 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
493 /* chown-like handling of "user[:[group]" */
494 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
495 /* bb_getpwuid, bb_getgrgid:
496 * bb_getXXXid(buf, bufsz, id) - copy user/group name or id
497 * as a string to buf, return user/group name or NULL
498 * bb_getXXXid(NULL, 0, id) - return user/group name or NULL
499 * bb_getXXXid(NULL, -1, id) - return user/group name or exit
501 char *bb_getpwuid(char *name, int bufsize, long uid);
502 char *bb_getgrgid(char *group, int bufsize, long gid);
503 /* versions which cache results (useful for ps, ls etc) */
504 const char* get_cached_username(uid_t uid);
505 const char* get_cached_groupname(gid_t gid);
506 void clear_username_cache(void);
507 /* internally usernames are saved in fixed-sized char[] buffers */
508 enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
512 int execable_file(const char *name);
513 char *find_execable(const char *filename);
514 int exists_execable(const char *filename);
516 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
517 * but it may exec busybox and call applet instead of searching PATH.
519 #if ENABLE_FEATURE_PREFER_APPLETS
520 int bb_execvp(const char *file, char *const argv[]);
521 #define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
522 #define BB_EXECLP(prog,cmd,...) \
523 execlp((find_applet_by_name(prog)) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
526 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
527 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
530 /* NOMMU friendy fork+exec */
531 pid_t spawn(char **argv);
532 pid_t xspawn(char **argv);
534 /* Unlike waitpid, waits ONLY for one process,
535 * It's safe to pass negative 'pids' from failed [v]fork -
536 * wait4pid will return -1 (and will not clobber [v]fork's errno).
537 * IOW: rc = wait4pid(spawn(argv));
538 * if (rc < 0) bb_perror_msg("%s", argv[0]);
539 * if (rc > 0) bb_error_msg("exit code: %d", rc);
541 int wait4pid(int pid);
542 int wait_pid(int *wstat, int pid);
543 int wait_nohang(int *wstat);
544 #define wait_crashed(w) ((w) & 127)
545 #define wait_exitcode(w) ((w) >> 8)
546 #define wait_stopsig(w) ((w) >> 8)
547 #define wait_stopped(w) (((w) & 127) == 127)
548 /* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
549 int spawn_and_wait(char **argv);
550 struct nofork_save_area {
552 const struct bb_applet *current_applet;
553 int xfunc_error_retval;
554 uint32_t option_mask32;
558 void save_nofork_data(struct nofork_save_area *save);
559 void restore_nofork_data(struct nofork_save_area *save);
560 /* Does NOT check that applet is NOFORK, just blindly runs it */
561 int run_nofork_applet(const struct bb_applet *a, char **argv);
562 int run_nofork_applet_prime(struct nofork_save_area *old, const struct bb_applet *a, char **argv);
564 /* Helpers for daemonization.
566 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
568 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
569 * rexec's itself on NOMMU with argv passed as command line.
570 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
571 * from the start. (It will detect it and not reexec again second time).
572 * You have to audit carefully that you don't do something twice as a result
573 * (opening files/sockets, parsing config files etc...)!
575 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
576 * (will do setsid()).
578 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
579 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
580 * Currently used for openvt. On MMU ignores argv.
582 * Helper for network daemons in foreground mode:
584 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
585 * to /dev/null if they are not.
588 DAEMON_CHDIR_ROOT = 1,
589 DAEMON_DEVNULL_STDIO = 2,
590 DAEMON_CLOSE_EXTRA_FDS = 4,
591 DAEMON_ONLY_SANITIZE = 8, /* internal use */
594 void forkexit_or_rexec(void);
595 enum { re_execed = 0 };
596 # define forkexit_or_rexec(argv) forkexit_or_rexec()
597 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
598 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
600 void re_exec(char **argv) ATTRIBUTE_NORETURN;
601 void forkexit_or_rexec(char **argv);
602 extern bool re_execed;
603 # define fork() BUG_fork_is_unavailable_on_nommu()
604 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
605 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
607 void bb_daemonize_or_rexec(int flags, char **argv);
608 void bb_sanitize_stdio(void);
611 extern const char *opt_complementary;
612 #if ENABLE_GETOPT_LONG
613 #define No_argument "\0"
614 #define Required_argument "\001"
615 #define Optional_argument "\002"
616 extern const char *applet_long_options;
618 extern uint32_t option_mask32;
619 extern uint32_t getopt32(char **argv, const char *applet_opts, ...);
622 typedef struct llist_t {
624 struct llist_t *link;
626 void llist_add_to(llist_t **old_head, void *data);
627 void llist_add_to_end(llist_t **list_head, void *data);
628 void *llist_pop(llist_t **elm);
629 void llist_unlink(llist_t **head, llist_t *elm);
630 void llist_free(llist_t *elm, void (*freeit)(void *data));
631 llist_t *llist_rev(llist_t *list);
632 /* BTW, surprisingly, changing API to
633 * llist_t *llist_add_to(llist_t *old_head, void *data)
634 * etc does not result in smaller code... */
636 /* start_stop_daemon and udhcpc are special - they want
637 * to create pidfiles regardless of FEATURE_PIDFILE */
638 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
639 /* True only if we created pidfile which is *file*, not /dev/null etc */
640 extern smallint wrote_pidfile;
641 void write_pidfile(const char *path);
642 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
644 enum { wrote_pidfile = 0 };
645 #define write_pidfile(path) ((void)0)
646 #define remove_pidfile(path) ((void)0)
651 LOGMODE_STDIO = (1 << 0),
652 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
653 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
655 extern const char *msg_eol;
656 extern smallint logmode;
657 extern int die_sleep;
658 extern int xfunc_error_retval;
659 extern jmp_buf die_jmp;
660 extern void xfunc_die(void) ATTRIBUTE_NORETURN;
661 extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
662 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
663 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
664 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
665 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
666 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
667 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
668 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
669 extern void bb_perror_nomsg(void);
670 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
671 extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
674 /* applets which are useful from another applets */
675 int bb_cat(char** argv);
676 int bb_echo(char** argv);
677 int test_main(int argc, char** argv);
678 int kill_main(int argc, char **argv);
680 void bb_displayroutes(int noresolve, int netstatfmt);
682 int chown_main(int argc, char **argv);
684 int gunzip_main(int argc, char **argv);
686 int bbunpack(char **argv,
687 char* (*make_new_name)(char *filename),
688 USE_DESKTOP(long long) int (*unpacker)(void)
693 int create_icmp_socket(void);
694 int create_icmp6_socket(void);
696 /* This structure defines protocol families and their handlers. */
702 char *(*print) (unsigned char *);
703 const char *(*sprint) (struct sockaddr *, int numeric);
704 int (*input) (/*int type,*/ const char *bufp, struct sockaddr *);
705 void (*herror) (char *text);
706 int (*rprint) (int options);
707 int (*rinput) (int typ, int ext, char **argv);
710 int (*getmask) (char *src, struct sockaddr * mask, char *name);
712 /* This structure defines hardware protocols and their handlers. */
718 char *(*print) (unsigned char *);
719 int (*input) (const char *, struct sockaddr *);
720 int (*activate) (int fd);
721 int suppress_null_addr;
723 extern smallint interface_opt_a;
724 int display_interfaces(char *ifname);
725 const struct aftype *get_aftype(const char *name);
726 const struct hwtype *get_hwtype(const char *name);
727 const struct hwtype *get_hwntype(int type);
730 #ifndef BUILD_INDIVIDUAL
731 extern const struct bb_applet *find_applet_by_name(const char *name);
732 /* Returns only if applet is not found. */
733 extern void run_applet_and_exit(const char *name, char **argv);
734 extern void run_current_applet_and_exit(char **argv) ATTRIBUTE_NORETURN;
737 extern int match_fstype(const struct mntent *mt, const char *fstypes);
738 extern struct mntent *find_mount_point(const char *name, const char *table);
739 extern void erase_mtab(const char * name);
740 extern unsigned int tty_baud_to_value(speed_t speed);
741 extern speed_t tty_value_to_baud(unsigned int value);
742 extern void bb_warn_ignoring_args(int n);
744 extern int get_linux_version_code(void);
746 extern char *query_loop(const char *device);
747 extern int del_loop(const char *device);
748 /* If *devname is not NULL, use that name, otherwise try to find free one,
749 * malloc and return it in *devname.
750 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
751 extern int set_loop(char **devname, const char *file, unsigned long long offset);
754 //TODO: pass buf pointer or return allocated buf (avoid statics)?
755 char *bb_askpass(int timeout, const char * prompt);
756 int bb_ask_confirmation(void);
757 int klogctl(int type, char * b, int len);
759 extern int bb_parse_mode(const char* s, mode_t* theMode);
761 char *concat_path_file(const char *path, const char *filename);
762 char *concat_subpath_file(const char *path, const char *filename);
763 const char *bb_basename(const char *name);
764 /* NB: can violate const-ness (similarly to strchr) */
765 char *last_char_is(const char *s, int c);
768 USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
769 int inflate(int in, int out);
772 int bb_make_directory(char *path, long mode, int flags);
774 int get_signum(const char *name);
775 const char *get_signame(int number);
777 char *bb_simplify_path(const char *path);
780 extern void bb_do_delay(int seconds);
781 extern void change_identity(const struct passwd *pw);
782 extern const char *change_identity_e2str(const struct passwd *pw);
783 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) ATTRIBUTE_NORETURN;
784 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
786 extern void renew_current_security_context(void);
787 extern void set_current_security_context(security_context_t sid);
788 extern context_t set_security_context_component(security_context_t cur_context,
789 char *user, char *role, char *type, char *range);
790 extern void setfscreatecon_or_die(security_context_t scontext);
792 extern void selinux_or_die(void);
793 extern int restricted_shell(const char *shell);
795 /* setup_environment:
796 * if loginshell = 1: cd(pw->pw_dir), clear environment, then set
798 * USER=pw->pw_name, LOGNAME=pw->pw_name
799 * PATH=bb_default_[root_]path
802 * else if changeenv = 1:
803 * if not root (if pw->pw_uid != 0):
804 * USER=pw->pw_name, LOGNAME=pw->pw_name
809 extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
810 extern int correct_password(const struct passwd *pw);
811 /* Returns a ptr to static storage */
812 extern char *pw_encrypt(const char *clear, const char *salt);
813 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
814 extern int index_in_str_array(const char *const string_array[], const char *key);
815 extern int index_in_strings(const char *strings, const char *key);
816 extern int index_in_substr_array(const char *const string_array[], const char *key);
817 extern int index_in_substrings(const char *strings, const char *key);
818 extern void print_login_issue(const char *issue_file, const char *tty);
819 extern void print_login_prompt(void);
821 /* rnd is additional random input. New one is returned.
822 * Useful if you call crypt_make_salt many times in a row:
823 * rnd = crypt_make_salt(buf1, 4, 0);
824 * rnd = crypt_make_salt(buf2, 4, rnd);
825 * rnd = crypt_make_salt(buf3, 4, rnd);
826 * (otherwise we risk having same salt generated)
828 extern int crypt_make_salt(char *p, int cnt, int rnd);
830 /* Returns number of lines changed, or -1 on error */
831 extern int update_passwd(const char *filename, const char *username,
834 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
835 int get_terminal_width_height(int fd, int *width, int *height);
837 int ioctl_or_perror(int fd, int request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
838 void ioctl_or_perror_and_die(int fd, int request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
839 #if ENABLE_IOCTL_HEX2STR_ERROR
840 int bb_ioctl_or_warn(int fd, int request, void *argp, const char *ioctl_name);
841 void bb_xioctl(int fd, int request, void *argp, const char *ioctl_name);
842 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
843 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
845 int bb_ioctl_or_warn(int fd, int request, void *argp);
846 void bb_xioctl(int fd, int request, void *argp);
847 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
848 #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
851 char *is_in_ino_dev_hashtable(const struct stat *statbuf);
852 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
853 void reset_ino_dev_hashtable(void);
855 /* At least glibc has horrendously large inline for this, so wrap it */
856 unsigned long long bb_makedev(unsigned int major, unsigned int minor);
858 #define makedev(a,b) bb_makedev(a,b)
862 #if ENABLE_FEATURE_EDITING
863 /* It's NOT just ENABLEd or disabled. It's a number: */
864 #ifdef CONFIG_FEATURE_EDITING_HISTORY
865 #define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
867 #define MAX_HISTORY 0
869 typedef struct line_input_t {
871 const char *path_lookup;
875 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
876 char *history[MAX_HISTORY + 1];
880 DO_HISTORY = 1 * (MAX_HISTORY > 0),
881 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
882 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
883 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
884 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
885 WITH_PATH_LOOKUP = 0x20,
886 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
888 line_input_t *new_line_input_t(int flags);
889 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
891 int read_line_input(const char* prompt, char* command, int maxsize);
892 #define read_line_input(prompt, command, maxsize, state) \
893 read_line_input(prompt, command, maxsize)
899 enum { COMM_LEN = TASK_COMM_LEN };
901 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
902 enum { COMM_LEN = 16 };
905 typedef struct procps_status_t {
907 uint8_t shift_pages_to_bytes;
908 uint8_t shift_pages_to_kb;
909 /* Fields are set to 0/NULL if failed to determine (or not requested) */
911 USE_SELINUX(char *context;)
912 /* Everything below must contain no ptrs to malloc'ed data:
913 * it is memset(0) for each process in procps_scan() */
914 unsigned long vsz, rss; /* we round it to kbytes */
915 unsigned long stime, utime;
922 unsigned tty_major,tty_minor;
923 #if ENABLE_FEATURE_TOPMEM
924 unsigned long mapped_rw;
925 unsigned long mapped_ro;
926 unsigned long shared_clean;
927 unsigned long shared_dirty;
928 unsigned long private_clean;
929 unsigned long private_dirty;
933 /* basename of executable in exec(2), read from /proc/N/stat
934 * (if executable is symlink or script, it is NOT replaced
935 * by link target or interpreter name) */
937 /* user/group? - use passwd/group parsing functions */
941 PSSCAN_PPID = 1 << 1,
942 PSSCAN_PGID = 1 << 2,
944 PSSCAN_UIDGID = 1 << 4,
945 PSSCAN_COMM = 1 << 5,
946 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
947 PSSCAN_ARGV0 = 1 << 7,
948 /* PSSCAN_EXE = 1 << 8, - not implemented */
949 PSSCAN_STATE = 1 << 9,
950 PSSCAN_VSZ = 1 << 10,
951 PSSCAN_RSS = 1 << 11,
952 PSSCAN_STIME = 1 << 12,
953 PSSCAN_UTIME = 1 << 13,
954 PSSCAN_TTY = 1 << 14,
955 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
956 USE_SELINUX(PSSCAN_CONTEXT = 1 << 16,)
957 /* These are all retrieved from proc/NN/stat in one go: */
958 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
959 | PSSCAN_COMM | PSSCAN_STATE
960 | PSSCAN_VSZ | PSSCAN_RSS
961 | PSSCAN_STIME | PSSCAN_UTIME
964 procps_status_t* alloc_procps_scan(int flags);
965 void free_procps_scan(procps_status_t* sp);
966 procps_status_t* procps_scan(procps_status_t* sp, int flags);
967 /* Format cmdline (up to col chars) into char buf[col+1] */
968 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
969 void read_cmdline(char *buf, int col, unsigned pid, const char *comm);
970 pid_t *find_pid_by_name(const char* procName);
971 pid_t *pidlist_reverse(pid_t *pidList);
974 extern const char bb_uuenc_tbl_base64[];
975 extern const char bb_uuenc_tbl_std[];
976 void bb_uuencode(char *store, const void *s, int length, const char *tbl);
978 typedef struct sha1_ctx_t {
983 void sha1_begin(sha1_ctx_t *ctx);
984 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
985 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
987 typedef struct md5_ctx_t {
996 void md5_begin(md5_ctx_t *ctx);
997 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
998 void *md5_end(void *resbuf, md5_ctx_t *ctx);
1000 uint32_t *crc32_filltable(uint32_t *tbl256, int endian);
1003 enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
1004 FILEUTILS_PRESERVE_STATUS = 1,
1005 FILEUTILS_DEREFERENCE = 2,
1006 FILEUTILS_RECUR = 4,
1007 FILEUTILS_FORCE = 8,
1008 FILEUTILS_INTERACTIVE = 0x10,
1009 FILEUTILS_MAKE_HARDLINK = 0x20,
1010 FILEUTILS_MAKE_SOFTLINK = 0x40,
1012 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x80,
1013 FILEUTILS_SET_SECURITY_CONTEXT = 0x100
1017 #define FILEUTILS_CP_OPTSTR "pdRfils" USE_SELINUX("c")
1018 extern const struct bb_applet *current_applet;
1019 extern const char *applet_name;
1020 /* "BusyBox vN.N.N (timestamp or extra_vestion)" */
1021 extern const char bb_banner[];
1022 extern const char bb_msg_memory_exhausted[];
1023 extern const char bb_msg_invalid_date[];
1024 extern const char bb_msg_read_error[];
1025 extern const char bb_msg_write_error[];
1026 extern const char bb_msg_unknown[];
1027 extern const char bb_msg_can_not_create_raw_socket[];
1028 extern const char bb_msg_perm_denied_are_you_root[];
1029 extern const char bb_msg_requires_arg[];
1030 extern const char bb_msg_invalid_arg[];
1031 extern const char bb_msg_standard_input[];
1032 extern const char bb_msg_standard_output[];
1034 extern const char bb_str_default[];
1035 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1036 extern const char bb_hexdigits_upcase[];
1038 extern const char bb_path_mtab_file[];
1039 extern const char bb_path_passwd_file[];
1040 extern const char bb_path_shadow_file[];
1041 extern const char bb_path_gshadow_file[];
1042 extern const char bb_path_group_file[];
1043 extern const char bb_path_motd_file[];
1044 extern const char bb_path_wtmp_file[];
1045 extern const char bb_dev_null[];
1046 extern const char bb_busybox_exec_path[];
1047 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1048 * but I want to save a few bytes here */
1049 extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1050 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1051 #define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1053 extern const int const_int_0;
1054 extern const int const_int_1;
1060 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1061 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1062 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1063 /* This struct is deliberately not defined. */
1064 /* See docs/keep_data_small.txt */
1066 /* '*const' ptr makes gcc optimize code much better.
1067 * Magic prevents ptr_to_globals from going into rodata.
1068 * If you want to assign a value, use PTR_TO_GLOBALS = xxx */
1069 extern struct globals *const ptr_to_globals;
1070 #define PTR_TO_GLOBALS (*(struct globals**)&ptr_to_globals)
1073 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1074 * use bb_default_login_shell and following defines.
1075 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1076 * don't forget to change increment constant. */
1077 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
1078 extern const char bb_default_login_shell[];
1080 #define DEFAULT_SHELL (bb_default_login_shell+1)
1082 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1085 #if ENABLE_FEATURE_DEVFS
1086 # define CURRENT_VC "/dev/vc/0"
1087 # define VC_1 "/dev/vc/1"
1088 # define VC_2 "/dev/vc/2"
1089 # define VC_3 "/dev/vc/3"
1090 # define VC_4 "/dev/vc/4"
1091 # define VC_5 "/dev/vc/5"
1092 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1093 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1094 respective serial ports .. as such, we can't use the common device paths for
1096 # define SC_0 "/dev/ttsc/0"
1097 # define SC_1 "/dev/ttsc/1"
1098 # define SC_FORMAT "/dev/ttsc/%d"
1100 # define SC_0 "/dev/tts/0"
1101 # define SC_1 "/dev/tts/1"
1102 # define SC_FORMAT "/dev/tts/%d"
1104 # define VC_FORMAT "/dev/vc/%d"
1105 # define LOOP_FORMAT "/dev/loop/%d"
1106 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1107 # define LOOP_NAME "/dev/loop/"
1108 # define FB_0 "/dev/fb/0"
1110 # define CURRENT_VC "/dev/tty0"
1111 # define VC_1 "/dev/tty1"
1112 # define VC_2 "/dev/tty2"
1113 # define VC_3 "/dev/tty3"
1114 # define VC_4 "/dev/tty4"
1115 # define VC_5 "/dev/tty5"
1116 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1117 # define SC_0 "/dev/ttySC0"
1118 # define SC_1 "/dev/ttySC1"
1119 # define SC_FORMAT "/dev/ttySC%d"
1121 # define SC_0 "/dev/ttyS0"
1122 # define SC_1 "/dev/ttyS1"
1123 # define SC_FORMAT "/dev/ttyS%d"
1125 # define VC_FORMAT "/dev/tty%d"
1126 # define LOOP_FORMAT "/dev/loop%d"
1127 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1128 # define LOOP_NAME "/dev/loop"
1129 # define FB_0 "/dev/fb0"
1132 /* The following devices are the same on devfs and non-devfs systems. */
1133 #define CURRENT_TTY "/dev/tty"
1134 #define DEV_CONSOLE "/dev/console"
1137 #ifndef RB_POWER_OFF
1138 /* Stop system and switch power off if possible. */
1139 #define RB_POWER_OFF 0x4321fedc
1142 /* Make sure we call functions instead of macros. */
1156 /* This one is more efficient - we save ~400 bytes */
1158 #define isdigit(a) ((unsigned)((a) - '0') <= 9)
1162 #include <dmalloc.h>
1166 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
1168 #endif /* __LIBBUSYBOX_H__ */