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 /* This structure defines protocol families and their handlers. */
132 char *(*print) (unsigned char *);
133 const char *(*sprint) (struct sockaddr *, int numeric);
134 int (*input) (/*int type,*/ const char *bufp, struct sockaddr *);
135 void (*herror) (char *text);
136 int (*rprint) (int options);
137 int (*rinput) (int typ, int ext, char **argv);
140 int (*getmask) (char *src, struct sockaddr * mask, char *name);
143 /* This structure defines hardware protocols and their handlers. */
149 char *(*print) (unsigned char *);
150 int (*input) (const char *, struct sockaddr *);
151 int (*activate) (int fd);
152 int suppress_null_addr;
155 /* Some useful definitions */
157 #define FALSE ((int) 0)
159 #define TRUE ((int) 1)
161 #define SKIP ((int) 2)
164 #define MTAB_GETMOUNTPT '1'
165 #define MTAB_GETDEVICE '2'
167 #define BUF_SIZE 8192
168 #define EXPAND_ALLOC 1024
170 /* Macros for min/max. */
172 #define MIN(a,b) (((a)<(b))?(a):(b))
176 #define MAX(a,b) (((a)>(b))?(a):(b))
179 /* buffer allocation schemes */
180 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
181 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
182 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
183 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
185 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
186 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
187 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
188 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
190 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
191 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
192 #define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
197 #if defined(__GLIBC__) && __GLIBC__ < 2
198 int vdprintf(int d, const char *format, va_list ap);
200 // This is declared here rather than #including <libgen.h> in order to avoid
201 // confusing the two versions of basename. See the dirname/basename man page
203 char *dirname(char *path);
204 /* Include our own copy of struct sysinfo to avoid binary compatibility
205 * problems with Linux 2.4, which changed things. Grumble, grumble. */
207 long uptime; /* Seconds since boot */
208 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
209 unsigned long totalram; /* Total usable main memory size */
210 unsigned long freeram; /* Available memory size */
211 unsigned long sharedram; /* Amount of shared memory */
212 unsigned long bufferram; /* Memory used by buffers */
213 unsigned long totalswap; /* Total swap space size */
214 unsigned long freeswap; /* swap space still available */
215 unsigned short procs; /* Number of current processes */
216 unsigned short pad; /* Padding needed for m68k */
217 unsigned long totalhigh; /* Total high memory size */
218 unsigned long freehigh; /* Available high memory size */
219 unsigned int mem_unit; /* Memory unit size in bytes */
220 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
222 int sysinfo(struct sysinfo* info);
225 extern void chomp(char *s);
226 extern void trim(char *s);
227 extern char *skip_whitespace(const char *);
228 extern char *skip_non_whitespace(const char *);
230 //TODO: supply a pointer to char[11] buffer (avoid statics)?
231 extern const char *bb_mode_string(mode_t mode);
232 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
233 extern int remove_file(const char *path, int flags);
234 extern int copy_file(const char *source, const char *dest, int flags);
236 ACTION_RECURSE = (1 << 0),
237 ACTION_FOLLOWLINKS = (1 << 1),
238 ACTION_DEPTHFIRST = (1 << 2),
239 /*ACTION_REVERSE = (1 << 3), - unused */
241 extern int recursive_action(const char *fileName, unsigned flags,
242 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
243 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
244 void* userData, const unsigned depth);
245 extern int device_open(const char *device, int mode);
246 extern int get_console_fd(void);
247 extern char *find_block_device(const char *path);
248 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
249 extern off_t bb_copyfd_eof(int fd1, int fd2);
250 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
251 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
252 /* "short" copy can be detected by return value < size */
253 /* this helper yells "short read!" if param is not -1 */
254 extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
255 extern char bb_process_escape_sequence(const char **ptr);
256 /* TODO: sometimes modifies its parameter, which
257 * makes it rather inconvenient at times: */
258 extern char *bb_get_last_path_component(char *path);
260 int ndelay_on(int fd);
261 int ndelay_off(int fd);
262 void xmove_fd(int, int);
265 DIR *xopendir(const char *path);
266 DIR *warn_opendir(const char *path);
268 char *xrealloc_getcwd_or_warn(char *cwd);
269 char *xmalloc_readlink_or_warn(const char *path);
270 char *xmalloc_realpath(const char *path);
273 //TODO: signal(sid, f) is the same? then why?
274 extern void sig_catch(int,void (*)(int));
275 //#define sig_ignore(s) (sig_catch((s), SIG_IGN))
276 //#define sig_uncatch(s) (sig_catch((s), SIG_DFL))
277 extern void sig_block(int);
278 extern void sig_unblock(int);
279 /* UNUSED: extern void sig_blocknone(void); */
280 extern void sig_pause(void);
283 void xsetgid(gid_t gid);
284 void xsetuid(uid_t uid);
285 void xchdir(const char *path);
286 void xsetenv(const char *key, const char *value);
287 void xunlink(const char *pathname);
288 void xstat(const char *pathname, struct stat *buf);
289 int xopen(const char *pathname, int flags);
290 int xopen3(const char *pathname, int flags, int mode);
291 off_t xlseek(int fd, off_t offset, int whence);
292 off_t fdlength(int fd);
295 int xsocket(int domain, int type, int protocol);
296 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
297 void xlisten(int s, int backlog);
298 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
299 int setsockopt_reuseaddr(int fd);
300 int setsockopt_broadcast(int fd);
301 /* NB: returns port in host byte order */
302 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
303 typedef struct len_and_sockaddr {
307 struct sockaddr_in sin;
308 #if ENABLE_FEATURE_IPV6
309 struct sockaddr_in6 sin6;
314 LSA_SIZEOF_SA = sizeof(
317 struct sockaddr_in sin;
318 #if ENABLE_FEATURE_IPV6
319 struct sockaddr_in6 sin6;
324 /* Create stream socket, and allocated suitable lsa
325 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6)) */
326 int xsocket_type(len_and_sockaddr **lsap, int sock_type);
327 int xsocket_stream(len_and_sockaddr **lsap);
328 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
329 * numeric IP ("N.N.N.N") or numeric IPv6 address,
330 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
331 * Only if there is no suffix, port argument is used */
332 int create_and_bind_stream_or_die(const char *bindaddr, int port);
333 int create_and_bind_dgram_or_die(const char *bindaddr, int port);
334 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
335 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
336 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
337 * If there is no suffix, port argument is used */
338 int create_and_connect_stream_or_die(const char *peer, int port);
339 /* Connect to peer identified by lsa */
340 int xconnect_stream(const len_and_sockaddr *lsa);
341 /* Return malloc'ed len_and_sockaddr with socket address of host:port
342 * Currently will return IPv4 or IPv6 sockaddrs only
343 * (depending on host), but in theory nothing prevents e.g.
344 * UNIX socket address being returned, IPX sockaddr etc...
345 * On error does bb_error_msg and returns NULL */
346 len_and_sockaddr* host2sockaddr(const char *host, int port);
347 /* Version which dies on error */
348 len_and_sockaddr* xhost2sockaddr(const char *host, int port);
349 len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
350 #if ENABLE_FEATURE_IPV6
351 /* Same, useful if you want to force family (e.g. IPv6) */
352 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
353 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
355 /* [we evaluate af: think about "host_and_af2sockaddr(..., af++)"] */
356 #define host_and_af2sockaddr(host, port, af) ((void)(af), host2sockaddr((host), (port)))
357 #define xhost_and_af2sockaddr(host, port, af) ((void)(af), xhost2sockaddr((host), (port)))
359 /* Assign sin[6]_port member if the socket is of corresponding type,
360 * otherwise no-op. Useful for ftp.
361 * NB: does NOT do htons() internally, just direct assignment. */
362 void set_nport(len_and_sockaddr *lsa, unsigned port);
363 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
364 int get_nport(const struct sockaddr *sa);
365 /* Reverse DNS. Returns NULL on failure. */
366 char* xmalloc_sockaddr2host(const struct sockaddr *sa, socklen_t salen);
367 /* This one doesn't append :PORTNUM */
368 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa, socklen_t salen);
369 /* This one also doesn't fall back to dotted IP (returns NULL) */
370 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa, socklen_t salen);
371 /* inet_[ap]ton on steroids */
372 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa, socklen_t salen);
373 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa, socklen_t salen);
374 // "old" (ipv4 only) API
375 // users: traceroute.c hostname.c - use _list_ of all IPs
376 struct hostent *xgethostbyname(const char *name);
377 // Also mount.c and inetd.c are using gethostbyname(),
378 // + inet_common.c has additional IPv4-only stuff
381 void socket_want_pktinfo(int fd);
382 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
383 const struct sockaddr *from, const struct sockaddr *to,
385 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
386 struct sockaddr *from, struct sockaddr *to,
390 extern char *xstrdup(const char *s);
391 extern char *xstrndup(const char *s, int n);
392 extern char *safe_strncpy(char *dst, const char *src, size_t size);
393 extern char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
394 // gcc-4.1.1 still isn't good enough at optimizing it
395 // (+200 bytes compared to macro)
396 //static ATTRIBUTE_ALWAYS_INLINE
397 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
398 //static ATTRIBUTE_ALWAYS_INLINE
399 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
400 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
401 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
402 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
403 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
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 extern char *reads(int fd, char *buf, size_t count);
417 extern ssize_t read_close(int fd, void *buf, size_t count);
418 extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
419 extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
421 extern ssize_t safe_write(int fd, const void *buf, size_t count);
422 extern ssize_t full_write(int fd, const void *buf, size_t count);
423 extern void xwrite(int fd, const void *buf, size_t count);
425 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
426 extern void xprint_and_close_file(FILE *file);
427 extern char *xmalloc_fgets(FILE *file);
428 /* Read up to (and including) TERMINATING_STRING: */
429 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
430 /* Chops off '\n' from the end, unlike fgets: */
431 extern char *xmalloc_getline(FILE *file);
432 extern char *bb_get_chunk_from_file(FILE *file, int *end);
433 extern void die_if_ferror(FILE *file, const char *msg);
434 extern void die_if_ferror_stdout(void);
435 extern void xfflush_stdout(void);
436 extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
437 extern int fclose_if_not_stdin(FILE *file);
438 extern FILE *xfopen(const char *filename, const char *mode);
439 /* Prints warning to stderr and returns NULL on failure: */
440 extern FILE *fopen_or_warn(const char *filename, const char *mode);
441 /* "Opens" stdin if filename is special, else just opens file: */
442 extern FILE *fopen_or_warn_stdin(const char *filename);
444 /* Convert each alpha char in str to lower-case */
445 extern char* str_tolower(char *str);
447 char *utoa(unsigned n);
449 /* Returns a pointer past the formatted number, does NOT null-terminate */
450 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen);
451 char *itoa_to_buf(int n, char *buf, unsigned buflen);
452 void smart_ulltoa5(unsigned long long ul, char buf[5]);
453 //TODO: provide pointer to buf (avoid statics)?
454 const char *make_human_readable_str(unsigned long long size,
455 unsigned long block_size, unsigned long display_unit);
456 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
457 char *bin2hex(char *buf, const char *cp, int count);
465 /* Using xatoi() instead of naive atoi() is not always convenient -
466 * in many places people want *non-negative* values, but store them
467 * in signed int. Therefore we need this one:
468 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
469 int xatoi_u(const char *numstr);
470 /* Useful for reading port numbers */
471 uint16_t xatou16(const char *numstr);
474 /* These parse entries in /etc/passwd and /etc/group. This is desirable
475 * for BusyBox since we want to avoid using the glibc NSS stuff, which
476 * increases target size and is often not needed on embedded systems. */
477 long xuname2uid(const char *name);
478 long xgroup2gid(const char *name);
479 /* wrapper: allows string to contain numeric uid or gid */
480 unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
481 /* from chpst. Does not die, returns 0 on failure */
486 /* always sets uid and gid */
487 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
488 /* chown-like handling of "user[:[group]" */
489 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
491 /*extern char *bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);*/
492 char *bb_getpwuid(char *name, long uid, int bufsize);
493 char *bb_getgrgid(char *group, long gid, int bufsize);
494 /* versions which cache results (useful for ps, ls etc) */
495 const char* get_cached_username(uid_t uid);
496 const char* get_cached_groupname(gid_t gid);
497 void clear_username_cache(void);
498 /* internally usernames are saved in fixed-sized char[] buffers */
499 enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
502 int execable_file(const char *name);
503 char *find_execable(const char *filename);
504 int exists_execable(const char *filename);
506 #if ENABLE_FEATURE_PREFER_APPLETS
507 int bb_execvp(const char *file, char *const argv[]);
508 #define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
509 #define BB_EXECLP(prog,cmd,...) \
510 execlp((find_applet_by_name(prog)) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
513 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
514 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
517 /* NOMMU friendy fork+exec */
518 pid_t spawn(char **argv);
519 pid_t xspawn(char **argv);
521 /* Unlike waitpid, waits ONLY for one process,
522 * It's safe to pass negative 'pids' from failed [v]fork -
523 * wait4pid will return -1 (and will not clobber [v]fork's errno).
524 * IOW: rc = wait4pid(spawn(argv));
525 * if (rc < 0) bb_perror_msg("%s", argv[0]);
526 * if (rc > 0) bb_error_msg("exit code: %d", rc);
528 int wait4pid(int pid);
529 int wait_pid(int *wstat, int pid);
530 int wait_nohang(int *wstat);
531 #define wait_crashed(w) ((w) & 127)
532 #define wait_exitcode(w) ((w) >> 8)
533 #define wait_stopsig(w) ((w) >> 8)
534 #define wait_stopped(w) (((w) & 127) == 127)
535 /* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
536 int spawn_and_wait(char **argv);
538 /* Helpers for daemonization.
540 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
542 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
543 * rexec's itself on NOMMU with argv passed as command line.
544 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
545 * from the start. (It will detect it and not reexec again second time).
546 * You have to audit carefully that you don't do something twice as a result
547 * (opening files/sockets, parsing config files etc...)!
549 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
550 * (will do setsid()).
552 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
553 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
554 * Currently used for openvt. On MMU ignores argv.
556 * Helper for network daemons in foreground mode:
558 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
559 * to /dev/null if they are not.
562 DAEMON_CHDIR_ROOT = 1,
563 DAEMON_DEVNULL_STDIO = /* 2 */ 0, /* no users so far */
564 DAEMON_CLOSE_EXTRA_FDS = 4,
565 DAEMON_ONLY_SANITIZE = 8, /* internal use */
568 void forkexit_or_rexec(void);
569 # define forkexit_or_rexec(argv) forkexit_or_rexec()
570 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
571 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
573 void forkexit_or_rexec(char **argv);
574 extern bool re_execed;
575 # define fork() BUG_fork_is_unavailable_on_nommu()
576 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
577 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
579 void bb_daemonize_or_rexec(int flags, char **argv);
580 void bb_sanitize_stdio(void);
583 // TODO: always error out?
584 enum { BB_GETOPT_ERROR = 0x80000000 };
585 extern const char *opt_complementary;
586 #if ENABLE_GETOPT_LONG
587 extern const struct option *applet_long_options;
589 extern uint32_t option_mask32;
590 extern uint32_t getopt32(int argc, char **argv, const char *applet_opts, ...);
593 typedef struct llist_t {
595 struct llist_t *link;
597 void llist_add_to(llist_t **old_head, void *data);
598 void llist_add_to_end(llist_t **list_head, void *data);
599 void *llist_pop(llist_t **elm);
600 void llist_unlink(llist_t **head, llist_t *elm);
601 void llist_free(llist_t *elm, void (*freeit)(void *data));
602 llist_t *llist_rev(llist_t *list);
603 /* BTW, surprisingly, changing API to
604 * llist_t *llist_add_to(llist_t *old_head, void *data)
605 * etc does not result in smaller code... */
608 #if ENABLE_FEATURE_PIDFILE
609 int write_pidfile(const char *path);
610 #define remove_pidfile(f) ((void)unlink(f))
612 /* Why? #defining it to 1 gives "warning: statement with no effect"... */
613 static ATTRIBUTE_ALWAYS_INLINE int write_pidfile(const char *path) { return 1; }
614 #define remove_pidfile(f) ((void)0)
619 LOGMODE_STDIO = 1<<0,
620 LOGMODE_SYSLOG = 1<<1,
621 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
623 extern const char *msg_eol;
624 extern smallint logmode;
625 extern int die_sleep;
626 extern int xfunc_error_retval;
627 extern jmp_buf die_jmp;
628 extern void xfunc_die(void) ATTRIBUTE_NORETURN;
629 extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
630 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
631 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
632 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
633 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
634 extern void bb_vherror_msg(const char *s, va_list p);
635 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
636 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
637 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
638 extern void bb_perror_nomsg(void);
639 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
640 /* These are used internally -- you shouldn't need to use them */
641 extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
642 extern void bb_vperror_msg(const char *s, va_list p);
643 extern void bb_vinfo_msg(const char *s, va_list p);
646 /* applets which are useful from another applets */
647 int bb_cat(char** argv);
648 int bb_echo(char** argv);
649 int bb_test(int argc, char** argv);
651 void bb_displayroutes(int noresolve, int netstatfmt);
653 int chown_main(int argc, char **argv);
655 int gunzip_main(int argc, char **argv);
657 int bbunpack(char **argv,
658 char* (*make_new_name)(char *filename),
659 USE_DESKTOP(long long) int (*unpacker)(void)
664 int create_icmp_socket(void);
665 int create_icmp6_socket(void);
667 extern int interface_opt_a;
668 int display_interfaces(char *ifname);
669 const struct aftype *get_aftype(const char *name);
670 const struct hwtype *get_hwtype(const char *name);
671 const struct hwtype *get_hwntype(int type);
674 #ifndef BUILD_INDIVIDUAL
676 extern const struct bb_applet *find_applet_by_name(const char *name);
677 /* Returns only if applet is not found. */
678 extern void run_applet_and_exit(const char *name, int argc, char **argv);
679 extern void run_current_applet_and_exit(int argc, char **argv) ATTRIBUTE_NORETURN;
682 extern int match_fstype(const struct mntent *mt, const char *fstypes);
683 extern struct mntent *find_mount_point(const char *name, const char *table);
684 extern void erase_mtab(const char * name);
685 extern unsigned int tty_baud_to_value(speed_t speed);
686 extern speed_t tty_value_to_baud(unsigned int value);
687 extern void bb_warn_ignoring_args(int n);
689 extern int get_linux_version_code(void);
691 extern char *query_loop(const char *device);
692 extern int del_loop(const char *device);
693 extern int set_loop(char **device, const char *file, unsigned long long offset);
696 //TODO: pass buf pointer or return allocated buf (avoid statics)?
697 char *bb_askpass(int timeout, const char * prompt);
698 int bb_ask_confirmation(void);
699 int klogctl(int type, char * b, int len);
701 extern int bb_parse_mode(const char* s, mode_t* theMode);
703 char *concat_path_file(const char *path, const char *filename);
704 char *concat_subpath_file(const char *path, const char *filename);
705 char *last_char_is(const char *s, int c);
708 USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
709 int inflate(int in, int out);
712 int bb_make_directory(char *path, long mode, int flags);
714 int get_signum(const char *name);
715 const char *get_signame(int number);
717 char *bb_simplify_path(const char *path);
720 extern void bb_do_delay(int seconds);
721 extern void change_identity(const struct passwd *pw);
722 extern const char *change_identity_e2str(const struct passwd *pw);
723 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
725 extern void renew_current_security_context(void);
726 extern void set_current_security_context(security_context_t sid);
727 extern context_t set_security_context_component(security_context_t cur_context,
728 char *user, char *role, char *type, char *range);
729 extern void setfscreatecon_or_die(security_context_t scontext);
731 extern void selinux_or_die(void);
732 extern int restricted_shell(const char *shell);
733 extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
734 extern int correct_password(const struct passwd *pw);
735 extern char *pw_encrypt(const char *clear, const char *salt);
736 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
737 extern int index_in_str_array(const char * const string_array[], const char *key);
738 extern int index_in_substr_array(const char * const string_array[], const char *key);
739 extern void print_login_issue(const char *issue_file, const char *tty);
740 extern void print_login_prompt(void);
743 int get_terminal_width_height(const int fd, int *width, int *height);
745 char *is_in_ino_dev_hashtable(const struct stat *statbuf);
746 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
747 void reset_ino_dev_hashtable(void);
749 /* At least glibc has horrendously large inline for this, so wrap it */
750 unsigned long long bb_makedev(unsigned int major, unsigned int minor);
752 #define makedev(a,b) bb_makedev(a,b)
756 #if ENABLE_FEATURE_EDITING
757 /* It's NOT just ENABLEd or disabled. It's a number: */
758 #ifdef CONFIG_FEATURE_EDITING_HISTORY
759 #define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
761 #define MAX_HISTORY 0
763 typedef struct line_input_t {
765 const char *path_lookup;
769 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
770 char *history[MAX_HISTORY + 1];
774 DO_HISTORY = 1 * (MAX_HISTORY > 0),
775 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
776 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
777 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
778 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
779 WITH_PATH_LOOKUP = 0x20,
780 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
782 line_input_t *new_line_input_t(int flags);
783 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
785 int read_line_input(const char* prompt, char* command, int maxsize);
786 #define read_line_input(prompt, command, maxsize, state) \
787 read_line_input(prompt, command, maxsize)
793 enum { COMM_LEN = TASK_COMM_LEN };
795 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
796 enum { COMM_LEN = 16 };
801 /* Fields are set to 0/NULL if failed to determine (or not requested) */
804 unsigned long stime, utime;
811 /* basename of executable file in call to exec(2), size from */
812 /* sizeof(task_struct.comm) in /usr/include/linux/sched.h */
815 /* user/group? - use passwd/group parsing functions */
819 PSSCAN_PPID = 1 << 1,
820 PSSCAN_PGID = 1 << 2,
822 PSSCAN_UIDGID = 1 << 4,
823 PSSCAN_COMM = 1 << 5,
825 PSSCAN_STATE = 1 << 7,
827 PSSCAN_STIME = 1 << 9,
828 PSSCAN_UTIME = 1 << 10,
829 /* These are all retrieved from proc/NN/stat in one go: */
830 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
831 | PSSCAN_COMM | PSSCAN_STATE
832 | PSSCAN_VSZ | PSSCAN_STIME | PSSCAN_UTIME,
834 procps_status_t* alloc_procps_scan(int flags);
835 void free_procps_scan(procps_status_t* sp);
836 procps_status_t* procps_scan(procps_status_t* sp, int flags);
837 pid_t *find_pid_by_name(const char* procName);
838 pid_t *pidlist_reverse(pid_t *pidList);
841 extern const char bb_uuenc_tbl_base64[];
842 extern const char bb_uuenc_tbl_std[];
843 void bb_uuencode(const unsigned char *s, char *store, const int length, const char *tbl);
845 typedef struct sha1_ctx_t {
850 void sha1_begin(sha1_ctx_t *ctx);
851 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
852 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
854 typedef struct md5_ctx_t {
863 void md5_begin(md5_ctx_t *ctx);
864 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
865 void *md5_end(void *resbuf, md5_ctx_t *ctx);
867 uint32_t *crc32_filltable(uint32_t *tbl256, int endian);
870 enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
871 FILEUTILS_PRESERVE_STATUS = 1,
872 FILEUTILS_DEREFERENCE = 2,
875 FILEUTILS_INTERACTIVE = 0x10,
876 FILEUTILS_MAKE_HARDLINK = 0x20,
877 FILEUTILS_MAKE_SOFTLINK = 0x40,
879 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x80,
880 FILEUTILS_SET_SECURITY_CONTEXT = 0x100
884 #define FILEUTILS_CP_OPTSTR "pdRfils" USE_SELINUX("c")
885 extern const struct bb_applet *current_applet;
886 extern const char *applet_name;
887 extern const char BB_BANNER[];
889 extern const char bb_msg_full_version[];
890 extern const char bb_msg_memory_exhausted[];
891 extern const char bb_msg_invalid_date[];
892 extern const char bb_msg_read_error[];
893 extern const char bb_msg_write_error[];
894 extern const char bb_msg_unknown[];
895 extern const char bb_msg_can_not_create_raw_socket[];
896 extern const char bb_msg_perm_denied_are_you_root[];
897 extern const char bb_msg_requires_arg[];
898 extern const char bb_msg_invalid_arg[];
899 extern const char bb_msg_standard_input[];
900 extern const char bb_msg_standard_output[];
902 extern const char bb_str_default[];
903 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
904 extern const char bb_hexdigits_upcase[];
906 extern const char bb_path_mtab_file[];
907 extern const char bb_path_nologin_file[];
908 extern const char bb_path_passwd_file[];
909 extern const char bb_path_shadow_file[];
910 extern const char bb_path_gshadow_file[];
911 extern const char bb_path_group_file[];
912 extern const char bb_path_securetty_file[];
913 extern const char bb_path_motd_file[];
914 extern const char bb_path_wtmp_file[];
915 extern const char bb_dev_null[];
917 extern const int const_int_0;
918 extern const int const_int_1;
924 // TODO: provide hard guarantees on minimum size of bb_common_bufsiz1
925 extern char bb_common_bufsiz1[BUFSIZ+1];
926 /* This struct is deliberately not defined. */
927 /* See docs/keep_data_small.txt */
929 /* '*const' ptr makes gcc optimize code much better.
930 * Magic prevents ptr_to_globals from going into rodata
931 * If you want to assign a value, use PTR_TO_GLOBALS = xxx */
932 extern struct globals *const ptr_to_globals;
933 #define PTR_TO_GLOBALS (*(struct globals**)&ptr_to_globals)
936 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
937 * use bb_default_login_shell and following defines.
938 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
939 * don't forget to change increment constant. */
940 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
941 extern const char bb_default_login_shell[];
943 #define DEFAULT_SHELL (bb_default_login_shell+1)
945 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
948 #if ENABLE_FEATURE_DEVFS
949 # define CURRENT_VC "/dev/vc/0"
950 # define VC_1 "/dev/vc/1"
951 # define VC_2 "/dev/vc/2"
952 # define VC_3 "/dev/vc/3"
953 # define VC_4 "/dev/vc/4"
954 # define VC_5 "/dev/vc/5"
955 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
956 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
957 respective serial ports .. as such, we can't use the common device paths for
959 # define SC_0 "/dev/ttsc/0"
960 # define SC_1 "/dev/ttsc/1"
961 # define SC_FORMAT "/dev/ttsc/%d"
963 # define SC_0 "/dev/tts/0"
964 # define SC_1 "/dev/tts/1"
965 # define SC_FORMAT "/dev/tts/%d"
967 # define VC_FORMAT "/dev/vc/%d"
968 # define LOOP_FORMAT "/dev/loop/%d"
969 # define LOOP_NAME "/dev/loop/"
970 # define FB_0 "/dev/fb/0"
972 # define CURRENT_VC "/dev/tty0"
973 # define VC_1 "/dev/tty1"
974 # define VC_2 "/dev/tty2"
975 # define VC_3 "/dev/tty3"
976 # define VC_4 "/dev/tty4"
977 # define VC_5 "/dev/tty5"
978 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
979 # define SC_0 "/dev/ttySC0"
980 # define SC_1 "/dev/ttySC1"
981 # define SC_FORMAT "/dev/ttySC%d"
983 # define SC_0 "/dev/ttyS0"
984 # define SC_1 "/dev/ttyS1"
985 # define SC_FORMAT "/dev/ttyS%d"
987 # define VC_FORMAT "/dev/tty%d"
988 # define LOOP_FORMAT "/dev/loop%d"
989 # define LOOP_NAME "/dev/loop"
990 # define FB_0 "/dev/fb0"
993 /* The following devices are the same on devfs and non-devfs systems. */
994 #define CURRENT_TTY "/dev/tty"
995 #define DEV_CONSOLE "/dev/console"
999 /* Stop system and switch power off if possible. */
1000 #define RB_POWER_OFF 0x4321fedc
1003 /* Make sure we call functions instead of macros. */
1017 /* This one is more efficient - we save ~400 bytes */
1019 #define isdigit(a) ((unsigned)((a) - '0') <= 9)
1023 #include <dmalloc.h>
1026 #endif /* __LIBBUSYBOX_H__ */