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);
204 extern void chomp(char *s);
205 extern void trim(char *s);
206 extern char *skip_whitespace(const char *);
207 extern char *skip_non_whitespace(const char *);
209 //TODO: supply a pointer to char[11] buffer (avoid statics)?
210 extern const char *bb_mode_string(mode_t mode);
211 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
212 extern int remove_file(const char *path, int flags);
213 extern int copy_file(const char *source, const char *dest, int flags);
215 ACTION_RECURSE = (1 << 0),
216 ACTION_FOLLOWLINKS = (1 << 1),
217 ACTION_DEPTHFIRST = (1 << 2),
218 /*ACTION_REVERSE = (1 << 3), - unused */
220 extern int recursive_action(const char *fileName, unsigned flags,
221 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
222 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
223 void* userData, const unsigned depth);
224 extern int device_open(const char *device, int mode);
225 extern int get_console_fd(void);
226 extern char *find_block_device(const char *path);
227 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
228 extern off_t bb_copyfd_eof(int fd1, int fd2);
229 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
230 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
231 /* "short" copy can be detected by return value < size */
232 /* this helper yells "short read!" if param is not -1 */
233 extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
234 extern char bb_process_escape_sequence(const char **ptr);
235 /* TODO: sometimes modifies its parameter, which
236 * makes it rather inconvenient at times: */
237 extern char *bb_get_last_path_component(char *path);
239 int ndelay_on(int fd);
240 int ndelay_off(int fd);
241 void xmove_fd(int, int);
244 DIR *xopendir(const char *path);
245 DIR *warn_opendir(const char *path);
247 char *xrealloc_getcwd_or_warn(char *cwd);
248 char *xmalloc_readlink_or_warn(const char *path);
249 char *xmalloc_realpath(const char *path);
252 //TODO: signal(sid, f) is the same? then why?
253 extern void sig_catch(int,void (*)(int));
254 //#define sig_ignore(s) (sig_catch((s), SIG_IGN))
255 //#define sig_uncatch(s) (sig_catch((s), SIG_DFL))
256 extern void sig_block(int);
257 extern void sig_unblock(int);
258 /* UNUSED: extern void sig_blocknone(void); */
259 extern void sig_pause(void);
262 void xsetgid(gid_t gid);
263 void xsetuid(uid_t uid);
264 void xchdir(const char *path);
265 void xsetenv(const char *key, const char *value);
266 void xunlink(const char *pathname);
267 void xstat(const char *pathname, struct stat *buf);
268 int xopen(const char *pathname, int flags);
269 int xopen3(const char *pathname, int flags, int mode);
270 int open_or_warn(const char *pathname, int flags);
271 int open3_or_warn(const char *pathname, int flags, int mode);
272 void xpipe(int filedes[2]);
273 off_t xlseek(int fd, off_t offset, int whence);
274 off_t fdlength(int fd);
276 int xsocket(int domain, int type, int protocol);
277 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
278 void xlisten(int s, int backlog);
279 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
280 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
282 int setsockopt_reuseaddr(int fd);
283 int setsockopt_broadcast(int fd);
284 /* NB: returns port in host byte order */
285 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
286 typedef struct len_and_sockaddr {
290 struct sockaddr_in sin;
291 #if ENABLE_FEATURE_IPV6
292 struct sockaddr_in6 sin6;
297 LSA_SIZEOF_SA = sizeof(
300 struct sockaddr_in sin;
301 #if ENABLE_FEATURE_IPV6
302 struct sockaddr_in6 sin6;
307 /* Create stream socket, and allocate suitable lsa.
308 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
309 * af == AF_UNSPEC will result in trying to create IPv6, and
310 * if kernel doesn't support it, IPv4.
312 int xsocket_type(len_and_sockaddr **lsap, USE_FEATURE_IPV6(int af,) int sock_type);
313 int xsocket_stream(len_and_sockaddr **lsap);
314 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
315 * numeric IP ("N.N.N.N") or numeric IPv6 address,
316 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
317 * Only if there is no suffix, port argument is used */
318 int create_and_bind_stream_or_die(const char *bindaddr, int port);
319 int create_and_bind_dgram_or_die(const char *bindaddr, int port);
320 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
321 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
322 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
323 * If there is no suffix, port argument is used */
324 int create_and_connect_stream_or_die(const char *peer, int port);
325 /* Connect to peer identified by lsa */
326 int xconnect_stream(const len_and_sockaddr *lsa);
327 /* Return malloc'ed len_and_sockaddr with socket address of host:port
328 * Currently will return IPv4 or IPv6 sockaddrs only
329 * (depending on host), but in theory nothing prevents e.g.
330 * UNIX socket address being returned, IPX sockaddr etc...
331 * On error does bb_error_msg and returns NULL */
332 len_and_sockaddr* host2sockaddr(const char *host, int port);
333 /* Version which dies on error */
334 len_and_sockaddr* xhost2sockaddr(const char *host, int port);
335 len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
336 #if ENABLE_FEATURE_IPV6
337 /* Same, useful if you want to force family (e.g. IPv6) */
338 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
339 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
341 /* [we evaluate af: think about "host_and_af2sockaddr(..., af++)"] */
342 #define host_and_af2sockaddr(host, port, af) ((void)(af), host2sockaddr((host), (port)))
343 #define xhost_and_af2sockaddr(host, port, af) ((void)(af), xhost2sockaddr((host), (port)))
345 /* Assign sin[6]_port member if the socket is of corresponding type,
346 * otherwise no-op. Useful for ftp.
347 * NB: does NOT do htons() internally, just direct assignment. */
348 void set_nport(len_and_sockaddr *lsa, unsigned port);
349 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
350 int get_nport(const struct sockaddr *sa);
351 /* Reverse DNS. Returns NULL on failure. */
352 char* xmalloc_sockaddr2host(const struct sockaddr *sa, socklen_t salen);
353 /* This one doesn't append :PORTNUM */
354 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa, socklen_t salen);
355 /* This one also doesn't fall back to dotted IP (returns NULL) */
356 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa, socklen_t salen);
357 /* inet_[ap]ton on steroids */
358 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa, socklen_t salen);
359 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa, socklen_t salen);
360 // "old" (ipv4 only) API
361 // users: traceroute.c hostname.c - use _list_ of all IPs
362 struct hostent *xgethostbyname(const char *name);
363 // Also mount.c and inetd.c are using gethostbyname(),
364 // + inet_common.c has additional IPv4-only stuff
367 void socket_want_pktinfo(int fd);
368 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
369 const struct sockaddr *from, const struct sockaddr *to,
371 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
372 struct sockaddr *from, struct sockaddr *to,
376 extern char *xstrdup(const char *s);
377 extern char *xstrndup(const char *s, int n);
378 extern char *safe_strncpy(char *dst, const char *src, size_t size);
379 extern char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
380 // gcc-4.1.1 still isn't good enough at optimizing it
381 // (+200 bytes compared to macro)
382 //static ATTRIBUTE_ALWAYS_INLINE
383 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
384 //static ATTRIBUTE_ALWAYS_INLINE
385 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
386 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
387 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
388 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
389 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
390 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
392 /* dmalloc will redefine these to it's own implementation. It is safe
393 * to have the prototypes here unconditionally. */
394 extern void *malloc_or_warn(size_t size);
395 extern void *xmalloc(size_t size);
396 extern void *xzalloc(size_t size);
397 extern void *xrealloc(void *old, size_t size);
399 extern ssize_t safe_read(int fd, void *buf, size_t count);
400 extern ssize_t full_read(int fd, void *buf, size_t count);
401 extern void xread(int fd, void *buf, size_t count);
402 extern unsigned char xread_char(int fd);
403 extern char *reads(int fd, char *buf, size_t count);
404 extern ssize_t read_close(int fd, void *buf, size_t count);
405 extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
406 extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
408 extern ssize_t safe_write(int fd, const void *buf, size_t count);
409 extern ssize_t full_write(int fd, const void *buf, size_t count);
410 extern void xwrite(int fd, const void *buf, size_t count);
412 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
413 extern void xprint_and_close_file(FILE *file);
414 extern char *xmalloc_fgets(FILE *file);
415 /* Read up to (and including) TERMINATING_STRING: */
416 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
417 /* Chops off '\n' from the end, unlike fgets: */
418 extern char *xmalloc_getline(FILE *file);
419 extern char *bb_get_chunk_from_file(FILE *file, int *end);
420 extern void die_if_ferror(FILE *file, const char *msg);
421 extern void die_if_ferror_stdout(void);
422 extern void xfflush_stdout(void);
423 extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
424 extern int fclose_if_not_stdin(FILE *file);
425 extern FILE *xfopen(const char *filename, const char *mode);
426 /* Prints warning to stderr and returns NULL on failure: */
427 extern FILE *fopen_or_warn(const char *filename, const char *mode);
428 /* "Opens" stdin if filename is special, else just opens file: */
429 extern FILE *fopen_or_warn_stdin(const char *filename);
431 /* Convert each alpha char in str to lower-case */
432 extern char* str_tolower(char *str);
434 char *utoa(unsigned n);
436 /* Returns a pointer past the formatted number, does NOT null-terminate */
437 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen);
438 char *itoa_to_buf(int n, char *buf, unsigned buflen);
439 void smart_ulltoa5(unsigned long long ul, char buf[5]);
440 //TODO: provide pointer to buf (avoid statics)?
441 const char *make_human_readable_str(unsigned long long size,
442 unsigned long block_size, unsigned long display_unit);
443 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
444 char *bin2hex(char *buf, const char *cp, int count);
452 /* Using xatoi() instead of naive atoi() is not always convenient -
453 * in many places people want *non-negative* values, but store them
454 * in signed int. Therefore we need this one:
455 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
456 int xatoi_u(const char *numstr);
457 /* Useful for reading port numbers */
458 uint16_t xatou16(const char *numstr);
461 /* These parse entries in /etc/passwd and /etc/group. This is desirable
462 * for BusyBox since we want to avoid using the glibc NSS stuff, which
463 * increases target size and is often not needed on embedded systems. */
464 long xuname2uid(const char *name);
465 long xgroup2gid(const char *name);
466 /* wrapper: allows string to contain numeric uid or gid */
467 unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
468 /* from chpst. Does not die, returns 0 on failure */
473 /* always sets uid and gid */
474 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
475 /* chown-like handling of "user[:[group]" */
476 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
478 /*extern char *bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);*/
479 char *bb_getpwuid(char *name, long uid, int bufsize);
480 char *bb_getgrgid(char *group, long gid, int bufsize);
481 /* versions which cache results (useful for ps, ls etc) */
482 const char* get_cached_username(uid_t uid);
483 const char* get_cached_groupname(gid_t gid);
484 void clear_username_cache(void);
485 /* internally usernames are saved in fixed-sized char[] buffers */
486 enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
490 int execable_file(const char *name);
491 char *find_execable(const char *filename);
492 int exists_execable(const char *filename);
494 #if ENABLE_FEATURE_PREFER_APPLETS
495 int bb_execvp(const char *file, char *const argv[]);
496 #define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
497 #define BB_EXECLP(prog,cmd,...) \
498 execlp((find_applet_by_name(prog)) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
501 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
502 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
505 /* NOMMU friendy fork+exec */
506 pid_t spawn(char **argv);
507 pid_t xspawn(char **argv);
509 /* Unlike waitpid, waits ONLY for one process,
510 * It's safe to pass negative 'pids' from failed [v]fork -
511 * wait4pid will return -1 (and will not clobber [v]fork's errno).
512 * IOW: rc = wait4pid(spawn(argv));
513 * if (rc < 0) bb_perror_msg("%s", argv[0]);
514 * if (rc > 0) bb_error_msg("exit code: %d", rc);
516 int wait4pid(int pid);
517 int wait_pid(int *wstat, int pid);
518 int wait_nohang(int *wstat);
519 #define wait_crashed(w) ((w) & 127)
520 #define wait_exitcode(w) ((w) >> 8)
521 #define wait_stopsig(w) ((w) >> 8)
522 #define wait_stopped(w) (((w) & 127) == 127)
523 /* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
524 int spawn_and_wait(char **argv);
525 struct nofork_save_area {
527 const struct bb_applet *current_applet;
528 int xfunc_error_retval;
529 uint32_t option_mask32;
533 void save_nofork_data(struct nofork_save_area *save);
534 void restore_nofork_data(struct nofork_save_area *save);
535 /* Does NOT check that applet is NOFORK, just blindly runs it */
536 int run_nofork_applet(const struct bb_applet *a, char **argv);
537 int run_nofork_applet_prime(struct nofork_save_area *old, const struct bb_applet *a, char **argv);
539 /* Helpers for daemonization.
541 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
543 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
544 * rexec's itself on NOMMU with argv passed as command line.
545 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
546 * from the start. (It will detect it and not reexec again second time).
547 * You have to audit carefully that you don't do something twice as a result
548 * (opening files/sockets, parsing config files etc...)!
550 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
551 * (will do setsid()).
553 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
554 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
555 * Currently used for openvt. On MMU ignores argv.
557 * Helper for network daemons in foreground mode:
559 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
560 * to /dev/null if they are not.
563 DAEMON_CHDIR_ROOT = 1,
564 DAEMON_DEVNULL_STDIO = /* 2 */ 0, /* no users so far */
565 DAEMON_CLOSE_EXTRA_FDS = 4,
566 DAEMON_ONLY_SANITIZE = 8, /* internal use */
569 void forkexit_or_rexec(void);
570 # define forkexit_or_rexec(argv) forkexit_or_rexec()
571 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
572 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
574 void forkexit_or_rexec(char **argv);
575 extern bool re_execed;
576 # define fork() BUG_fork_is_unavailable_on_nommu()
577 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
578 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
580 void bb_daemonize_or_rexec(int flags, char **argv);
581 void bb_sanitize_stdio(void);
584 // TODO: always error out?
585 enum { BB_GETOPT_ERROR = 0x80000000 };
586 extern const char *opt_complementary;
587 #if ENABLE_GETOPT_LONG
588 extern const struct option *applet_long_options;
590 extern uint32_t option_mask32;
591 extern uint32_t getopt32(int argc, char **argv, const char *applet_opts, ...);
594 typedef struct llist_t {
596 struct llist_t *link;
598 void llist_add_to(llist_t **old_head, void *data);
599 void llist_add_to_end(llist_t **list_head, void *data);
600 void *llist_pop(llist_t **elm);
601 void llist_unlink(llist_t **head, llist_t *elm);
602 void llist_free(llist_t *elm, void (*freeit)(void *data));
603 llist_t *llist_rev(llist_t *list);
604 /* BTW, surprisingly, changing API to
605 * llist_t *llist_add_to(llist_t *old_head, void *data)
606 * etc does not result in smaller code... */
609 #if ENABLE_FEATURE_PIDFILE
610 int write_pidfile(const char *path);
611 #define remove_pidfile(f) ((void)unlink(f))
613 /* Why? #defining it to 1 gives "warning: statement with no effect"... */
614 static ATTRIBUTE_ALWAYS_INLINE int write_pidfile(const char *path) { return 1; }
615 #define remove_pidfile(f) ((void)0)
620 LOGMODE_STDIO = 1<<0,
621 LOGMODE_SYSLOG = 1<<1,
622 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
624 extern const char *msg_eol;
625 extern smallint logmode;
626 extern int die_sleep;
627 extern int xfunc_error_retval;
628 extern jmp_buf die_jmp;
629 extern void xfunc_die(void) ATTRIBUTE_NORETURN;
630 extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
631 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
632 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
633 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
634 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
635 extern void bb_vherror_msg(const char *s, va_list p);
636 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
637 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
638 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
639 extern void bb_perror_nomsg(void);
640 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
641 /* These are used internally -- you shouldn't need to use them */
642 extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
643 extern void bb_vperror_msg(const char *s, va_list p);
644 extern void bb_vinfo_msg(const char *s, va_list p);
647 /* applets which are useful from another applets */
648 int bb_cat(char** argv);
649 int bb_echo(char** argv);
650 int bb_test(int argc, char** argv);
651 int kill_main(int argc, char **argv);
653 void bb_displayroutes(int noresolve, int netstatfmt);
655 int chown_main(int argc, char **argv);
657 int gunzip_main(int argc, char **argv);
659 int bbunpack(char **argv,
660 char* (*make_new_name)(char *filename),
661 USE_DESKTOP(long long) int (*unpacker)(void)
666 int create_icmp_socket(void);
667 int create_icmp6_socket(void);
669 /* This structure defines protocol families and their handlers. */
675 char *(*print) (unsigned char *);
676 const char *(*sprint) (struct sockaddr *, int numeric);
677 int (*input) (/*int type,*/ const char *bufp, struct sockaddr *);
678 void (*herror) (char *text);
679 int (*rprint) (int options);
680 int (*rinput) (int typ, int ext, char **argv);
683 int (*getmask) (char *src, struct sockaddr * mask, char *name);
685 /* This structure defines hardware protocols and their handlers. */
691 char *(*print) (unsigned char *);
692 int (*input) (const char *, struct sockaddr *);
693 int (*activate) (int fd);
694 int suppress_null_addr;
696 extern int interface_opt_a;
697 int display_interfaces(char *ifname);
698 const struct aftype *get_aftype(const char *name);
699 const struct hwtype *get_hwtype(const char *name);
700 const struct hwtype *get_hwntype(int type);
703 #ifndef BUILD_INDIVIDUAL
704 extern const struct bb_applet *find_applet_by_name(const char *name);
705 /* Returns only if applet is not found. */
706 extern void run_applet_and_exit(const char *name, char **argv);
707 extern void run_current_applet_and_exit(char **argv) ATTRIBUTE_NORETURN;
710 extern int match_fstype(const struct mntent *mt, const char *fstypes);
711 extern struct mntent *find_mount_point(const char *name, const char *table);
712 extern void erase_mtab(const char * name);
713 extern unsigned int tty_baud_to_value(speed_t speed);
714 extern speed_t tty_value_to_baud(unsigned int value);
715 extern void bb_warn_ignoring_args(int n);
717 extern int get_linux_version_code(void);
719 extern char *query_loop(const char *device);
720 extern int del_loop(const char *device);
721 extern int set_loop(char **device, const char *file, unsigned long long offset);
724 //TODO: pass buf pointer or return allocated buf (avoid statics)?
725 char *bb_askpass(int timeout, const char * prompt);
726 int bb_ask_confirmation(void);
727 int klogctl(int type, char * b, int len);
729 extern int bb_parse_mode(const char* s, mode_t* theMode);
731 char *concat_path_file(const char *path, const char *filename);
732 char *concat_subpath_file(const char *path, const char *filename);
733 /* NB: can violate const-ness (similarly to strchr) */
734 char *last_char_is(const char *s, int c);
737 USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
738 int inflate(int in, int out);
741 int bb_make_directory(char *path, long mode, int flags);
743 int get_signum(const char *name);
744 const char *get_signame(int number);
746 char *bb_simplify_path(const char *path);
749 extern void bb_do_delay(int seconds);
750 extern void change_identity(const struct passwd *pw);
751 extern const char *change_identity_e2str(const struct passwd *pw);
752 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
754 extern void renew_current_security_context(void);
755 extern void set_current_security_context(security_context_t sid);
756 extern context_t set_security_context_component(security_context_t cur_context,
757 char *user, char *role, char *type, char *range);
758 extern void setfscreatecon_or_die(security_context_t scontext);
760 extern void selinux_or_die(void);
761 extern int restricted_shell(const char *shell);
762 extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
763 extern int correct_password(const struct passwd *pw);
764 extern char *pw_encrypt(const char *clear, const char *salt);
765 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
766 extern int index_in_str_array(const char * const string_array[], const char *key);
767 extern int index_in_substr_array(const char * const string_array[], const char *key);
768 extern void print_login_issue(const char *issue_file, const char *tty);
769 extern void print_login_prompt(void);
771 extern void crypt_make_salt(char *p, int cnt);
773 int get_terminal_width_height(const int fd, int *width, int *height);
775 char *is_in_ino_dev_hashtable(const struct stat *statbuf);
776 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
777 void reset_ino_dev_hashtable(void);
779 /* At least glibc has horrendously large inline for this, so wrap it */
780 unsigned long long bb_makedev(unsigned int major, unsigned int minor);
782 #define makedev(a,b) bb_makedev(a,b)
786 #if ENABLE_FEATURE_EDITING
787 /* It's NOT just ENABLEd or disabled. It's a number: */
788 #ifdef CONFIG_FEATURE_EDITING_HISTORY
789 #define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
791 #define MAX_HISTORY 0
793 typedef struct line_input_t {
795 const char *path_lookup;
799 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
800 char *history[MAX_HISTORY + 1];
804 DO_HISTORY = 1 * (MAX_HISTORY > 0),
805 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
806 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
807 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
808 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
809 WITH_PATH_LOOKUP = 0x20,
810 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
812 line_input_t *new_line_input_t(int flags);
813 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
815 int read_line_input(const char* prompt, char* command, int maxsize);
816 #define read_line_input(prompt, command, maxsize, state) \
817 read_line_input(prompt, command, maxsize)
823 enum { COMM_LEN = TASK_COMM_LEN };
825 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
826 enum { COMM_LEN = 16 };
831 /* Fields are set to 0/NULL if failed to determine (or not requested) */
833 USE_SELINUX(char *context;)
834 /* Everything below must contain no ptrs to malloc'ed data:
835 * it is memset(0) for each process in procps_scan() */
836 unsigned vsz, rss; /* we round it to kbytes */
837 unsigned long stime, utime;
845 char tty_str[8]; /* "maj,min" or "?" */
846 /* basename of executable in exec(2), read from /proc/N/stat, */
847 /* size from sizeof(task_struct.comm) in /usr/include/linux/sched.h */
849 /* user/group? - use passwd/group parsing functions */
853 PSSCAN_PPID = 1 << 1,
854 PSSCAN_PGID = 1 << 2,
856 PSSCAN_UIDGID = 1 << 4,
857 PSSCAN_COMM = 1 << 5,
859 PSSCAN_STATE = 1 << 7,
862 PSSCAN_STIME = 1 << 10,
863 PSSCAN_UTIME = 1 << 11,
864 PSSCAN_TTY = 1 << 12,
865 USE_SELINUX(PSSCAN_CONTEXT = 1 << 13,)
866 /* These are all retrieved from proc/NN/stat in one go: */
867 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
868 | PSSCAN_COMM | PSSCAN_STATE
869 | PSSCAN_VSZ | PSSCAN_RSS
870 | PSSCAN_STIME | PSSCAN_UTIME
873 procps_status_t* alloc_procps_scan(int flags);
874 void free_procps_scan(procps_status_t* sp);
875 procps_status_t* procps_scan(procps_status_t* sp, int flags);
876 pid_t *find_pid_by_name(const char* procName);
877 pid_t *pidlist_reverse(pid_t *pidList);
880 extern const char bb_uuenc_tbl_base64[];
881 extern const char bb_uuenc_tbl_std[];
882 void bb_uuencode(const unsigned char *s, char *store, const int length, const char *tbl);
884 typedef struct sha1_ctx_t {
889 void sha1_begin(sha1_ctx_t *ctx);
890 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
891 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
893 typedef struct md5_ctx_t {
902 void md5_begin(md5_ctx_t *ctx);
903 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
904 void *md5_end(void *resbuf, md5_ctx_t *ctx);
906 uint32_t *crc32_filltable(uint32_t *tbl256, int endian);
909 enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
910 FILEUTILS_PRESERVE_STATUS = 1,
911 FILEUTILS_DEREFERENCE = 2,
914 FILEUTILS_INTERACTIVE = 0x10,
915 FILEUTILS_MAKE_HARDLINK = 0x20,
916 FILEUTILS_MAKE_SOFTLINK = 0x40,
918 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x80,
919 FILEUTILS_SET_SECURITY_CONTEXT = 0x100
923 #define FILEUTILS_CP_OPTSTR "pdRfils" USE_SELINUX("c")
924 extern const struct bb_applet *current_applet;
925 extern const char *applet_name;
926 extern const char BB_BANNER[];
928 extern const char bb_msg_full_version[];
929 extern const char bb_msg_memory_exhausted[];
930 extern const char bb_msg_invalid_date[];
931 extern const char bb_msg_read_error[];
932 extern const char bb_msg_write_error[];
933 extern const char bb_msg_unknown[];
934 extern const char bb_msg_can_not_create_raw_socket[];
935 extern const char bb_msg_perm_denied_are_you_root[];
936 extern const char bb_msg_requires_arg[];
937 extern const char bb_msg_invalid_arg[];
938 extern const char bb_msg_standard_input[];
939 extern const char bb_msg_standard_output[];
941 extern const char bb_str_default[];
942 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
943 extern const char bb_hexdigits_upcase[];
945 extern const char bb_path_mtab_file[];
946 extern const char bb_path_nologin_file[];
947 extern const char bb_path_passwd_file[];
948 extern const char bb_path_shadow_file[];
949 extern const char bb_path_gshadow_file[];
950 extern const char bb_path_group_file[];
951 extern const char bb_path_securetty_file[];
952 extern const char bb_path_motd_file[];
953 extern const char bb_path_wtmp_file[];
954 extern const char bb_dev_null[];
955 extern const char bb_busybox_exec_path[];
956 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
957 * but I want to save a few bytes here */
958 extern const char bb_default_root_login_path[]; /* "/sbin:/usr/sbin:/bin:/usr/bin" */
959 #define bb_default_login_path (bb_default_root_login_path + sizeof("/sbin:/usr/sbin"))
961 extern const int const_int_0;
962 extern const int const_int_1;
968 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
969 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
970 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
971 /* This struct is deliberately not defined. */
972 /* See docs/keep_data_small.txt */
974 /* '*const' ptr makes gcc optimize code much better.
975 * Magic prevents ptr_to_globals from going into rodata
976 * If you want to assign a value, use PTR_TO_GLOBALS = xxx */
977 extern struct globals *const ptr_to_globals;
978 #define PTR_TO_GLOBALS (*(struct globals**)&ptr_to_globals)
981 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
982 * use bb_default_login_shell and following defines.
983 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
984 * don't forget to change increment constant. */
985 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
986 extern const char bb_default_login_shell[];
988 #define DEFAULT_SHELL (bb_default_login_shell+1)
990 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
993 #if ENABLE_FEATURE_DEVFS
994 # define CURRENT_VC "/dev/vc/0"
995 # define VC_1 "/dev/vc/1"
996 # define VC_2 "/dev/vc/2"
997 # define VC_3 "/dev/vc/3"
998 # define VC_4 "/dev/vc/4"
999 # define VC_5 "/dev/vc/5"
1000 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1001 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1002 respective serial ports .. as such, we can't use the common device paths for
1004 # define SC_0 "/dev/ttsc/0"
1005 # define SC_1 "/dev/ttsc/1"
1006 # define SC_FORMAT "/dev/ttsc/%d"
1008 # define SC_0 "/dev/tts/0"
1009 # define SC_1 "/dev/tts/1"
1010 # define SC_FORMAT "/dev/tts/%d"
1012 # define VC_FORMAT "/dev/vc/%d"
1013 # define LOOP_FORMAT "/dev/loop/%d"
1014 # define LOOP_NAME "/dev/loop/"
1015 # define FB_0 "/dev/fb/0"
1017 # define CURRENT_VC "/dev/tty0"
1018 # define VC_1 "/dev/tty1"
1019 # define VC_2 "/dev/tty2"
1020 # define VC_3 "/dev/tty3"
1021 # define VC_4 "/dev/tty4"
1022 # define VC_5 "/dev/tty5"
1023 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1024 # define SC_0 "/dev/ttySC0"
1025 # define SC_1 "/dev/ttySC1"
1026 # define SC_FORMAT "/dev/ttySC%d"
1028 # define SC_0 "/dev/ttyS0"
1029 # define SC_1 "/dev/ttyS1"
1030 # define SC_FORMAT "/dev/ttyS%d"
1032 # define VC_FORMAT "/dev/tty%d"
1033 # define LOOP_FORMAT "/dev/loop%d"
1034 # define LOOP_NAME "/dev/loop"
1035 # define FB_0 "/dev/fb0"
1038 /* The following devices are the same on devfs and non-devfs systems. */
1039 #define CURRENT_TTY "/dev/tty"
1040 #define DEV_CONSOLE "/dev/console"
1043 #ifndef RB_POWER_OFF
1044 /* Stop system and switch power off if possible. */
1045 #define RB_POWER_OFF 0x4321fedc
1048 /* Make sure we call functions instead of macros. */
1062 /* This one is more efficient - we save ~400 bytes */
1064 #define isdigit(a) ((unsigned)((a) - '0') <= 9)
1068 #include <dmalloc.h>
1071 #endif /* __LIBBUSYBOX_H__ */