1 /* vi: set sw=4 ts=4: */
3 * Busybox main internal header file
5 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
6 * Permission has been granted to redistribute this code under the GPL.
8 * Licensed under the GPL version 2, see the file LICENSE in this tarball.
10 #ifndef __LIBBUSYBOX_H__
11 #define __LIBBUSYBOX_H__ 1
29 #include <sys/ioctl.h>
31 #include <sys/socket.h>
33 #include <sys/statfs.h>
35 #include <sys/types.h>
43 #include <selinux/selinux.h>
44 #include <selinux/context.h>
47 #if ENABLE_LOCALE_SUPPORT
50 #define setlocale(x,y) ((void)0)
55 /* ifdef it out, because it may include <shadow.h> */
56 /* and we may not even _have_ <shadow.h>! */
57 #if ENABLE_FEATURE_SHADOWPASSWDS
61 /* Try to pull in PATH_MAX */
63 #include <sys/param.h>
68 /* Tested to work correctly (IIRC :]) */
69 #define MAXINT(T) (T)( \
72 : (T)~((T)1 << (sizeof(T)*8-1)) \
75 #define MININT(T) (T)( \
78 : ((T)1 << (sizeof(T)*8-1)) \
81 /* Large file support */
82 /* Note that CONFIG_LFS forces bbox to be built with all common ops
83 * (stat, lseek etc) mapped to "largefile" variants by libc.
84 * Practically it means that open() automatically has O_LARGEFILE added
85 * and all filesize/file_offset parameters and struct members are "large"
86 * (in today's world - signed 64bit). For full support of large files,
87 * we need a few helper #defines (below) and careful use of off_t
88 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
90 /* CONFIG_LFS is on */
91 # if ULONG_MAX > 0xffffffff
92 /* "long" is long enough on this system */
93 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
94 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
95 # define BB_STRTOOFF bb_strtoul
96 # define STRTOOFF strtoul
97 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
100 /* "long" is too short, need "long long" */
101 # define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
102 # define BB_STRTOOFF bb_strtoull
103 # define STRTOOFF strtoull
104 # define OFF_FMT "ll"
107 /* CONFIG_LFS is off */
108 # if UINT_MAX == 0xffffffff
109 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
110 * gcc will throw warnings on printf("%d", off_t). Crap... */
111 # define XATOOFF(a) xatoi_u(a)
112 # define BB_STRTOOFF bb_strtou
113 # define STRTOOFF strtol
116 # define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
117 # define BB_STRTOOFF bb_strtoul
118 # define STRTOOFF strtol
122 /* scary. better ideas? (but do *test* them first!) */
123 #define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
125 /* This structure defines protocol families and their handlers. */
131 char *(*print) (unsigned char *);
132 const char *(*sprint) (struct sockaddr *, int numeric);
133 int (*input) (/*int type,*/ const char *bufp, struct sockaddr *);
134 void (*herror) (char *text);
135 int (*rprint) (int options);
136 int (*rinput) (int typ, int ext, char **argv);
139 int (*getmask) (char *src, struct sockaddr * mask, char *name);
142 /* This structure defines hardware protocols and their handlers. */
148 char *(*print) (unsigned char *);
149 int (*input) (const char *, struct sockaddr *);
150 int (*activate) (int fd);
151 int suppress_null_addr;
154 /* Some useful definitions */
156 #define FALSE ((int) 0)
158 #define TRUE ((int) 1)
160 #define SKIP ((int) 2)
163 #define MTAB_GETMOUNTPT '1'
164 #define MTAB_GETDEVICE '2'
166 #define BUF_SIZE 8192
167 #define EXPAND_ALLOC 1024
169 /* Macros for min/max. */
171 #define MIN(a,b) (((a)<(b))?(a):(b))
175 #define MAX(a,b) (((a)>(b))?(a):(b))
178 /* buffer allocation schemes */
179 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
180 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
181 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
182 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
184 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
185 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
186 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
187 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
189 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer=xmalloc(len)
190 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
191 #define RELEASE_CONFIG_BUFFER(buffer) free (buffer)
196 #if defined(__GLIBC__) && __GLIBC__ < 2
197 int vdprintf(int d, const char *format, va_list ap);
199 // This is declared here rather than #including <libgen.h> in order to avoid
200 // confusing the two versions of basename. See the dirname/basename man page
202 char *dirname(char *path);
203 /* Include our own copy of struct sysinfo to avoid binary compatibility
204 * problems with Linux 2.4, which changed things. Grumble, grumble. */
206 long uptime; /* Seconds since boot */
207 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
208 unsigned long totalram; /* Total usable main memory size */
209 unsigned long freeram; /* Available memory size */
210 unsigned long sharedram; /* Amount of shared memory */
211 unsigned long bufferram; /* Memory used by buffers */
212 unsigned long totalswap; /* Total swap space size */
213 unsigned long freeswap; /* swap space still available */
214 unsigned short procs; /* Number of current processes */
215 unsigned short pad; /* Padding needed for m68k */
216 unsigned long totalhigh; /* Total high memory size */
217 unsigned long freehigh; /* Available high memory size */
218 unsigned int mem_unit; /* Memory unit size in bytes */
219 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
221 extern int sysinfo(struct sysinfo* info);
224 extern void chomp(char *s);
225 extern void trim(char *s);
226 extern char *skip_whitespace(const char *);
227 extern char *skip_non_whitespace(const char *);
229 //TODO: supply a pointer to char[11] buffer (avoid statics)?
230 extern const char *bb_mode_string(mode_t mode);
231 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
232 extern int remove_file(const char *path, int flags);
233 extern int copy_file(const char *source, const char *dest, int flags);
234 extern int recursive_action(const char *fileName, int recurse,
235 int followLinks, int depthFirst,
236 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
237 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
238 void* userData, int depth);
239 extern int device_open(const char *device, int mode);
240 extern int get_console_fd(void);
241 extern char *find_block_device(const char *path);
242 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
243 extern off_t bb_copyfd_eof(int fd1, int fd2);
244 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
245 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
246 /* "short" copy can be detected by return value < size */
247 /* this helper yells "short read!" if param is not -1 */
248 extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
249 extern char bb_process_escape_sequence(const char **ptr);
250 /* TODO: sometimes modifies its parameter, which
251 * makes it rather inconvenient at times: */
252 extern char *bb_get_last_path_component(char *path);
254 int ndelay_on(int fd);
255 int ndelay_off(int fd);
256 void xmove_fd(int, int);
259 extern DIR *xopendir(const char *path);
260 extern DIR *warn_opendir(const char *path);
262 char *xrealloc_getcwd_or_warn(char *cwd);
263 char *xmalloc_readlink_or_warn(const char *path);
264 char *xmalloc_realpath(const char *path);
265 extern void xstat(const char *filename, struct stat *buf);
266 /* Unlike waitpid, waits ONLY for one process,
267 * It's safe to pass negative 'pids' from failed [v]fork -
268 * wait4pid will return -1 and ECHILD in errno.
269 * IOW: rc = wait4pid(spawn(argv));
270 * if (rc < 0) bb_perror_msg("%s", argv[0]);
271 * if (rc > 0) bb_error_msg("exit code: %d", rc);
273 extern int wait4pid(int pid);
274 extern void xsetgid(gid_t gid);
275 extern void xsetuid(uid_t uid);
276 extern void xchdir(const char *path);
277 extern void xsetenv(const char *key, const char *value);
278 extern int xopen(const char *pathname, int flags);
279 extern int xopen3(const char *pathname, int flags, int mode);
280 extern off_t xlseek(int fd, off_t offset, int whence);
281 extern off_t fdlength(int fd);
284 int xsocket(int domain, int type, int protocol);
285 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
286 void xlisten(int s, int backlog);
287 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
288 int setsockopt_reuseaddr(int fd);
289 int setsockopt_broadcast(int fd);
290 /* NB: returns port in host byte order */
291 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
292 typedef struct len_and_sockaddr {
296 struct sockaddr_in sin;
297 #if ENABLE_FEATURE_IPV6
298 struct sockaddr_in6 sin6;
302 /* Create stream socket, and allocated suitable lsa
303 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6)) */
304 int xsocket_stream(len_and_sockaddr **lsap);
305 /* Create server TCP socket bound to bindaddr:port. bindaddr can be NULL,
306 * numeric IP ("N.N.N.N") or numeric IPv6 address,
307 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
308 * If there is no suffix, port argument is used */
309 int create_and_bind_stream_or_die(const char *bindaddr, int port);
310 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
311 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
312 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
313 * If there is no suffix, port argument is used */
314 int create_and_connect_stream_or_die(const char *peer, int port);
315 /* Connect to peer identified by lsa */
316 int xconnect_stream(const len_and_sockaddr *lsa);
317 /* Return malloc'ed len_and_sockaddr with socket address of host:port
318 * Currently will return IPv4 or IPv6 sockaddrs only
319 * (depending on host), but in theory nothing prevents e.g.
320 * UNIX socket address being returned, IPX sockaddr etc...
321 * On error does bb_error_msg and returns NULL */
322 len_and_sockaddr* host2sockaddr(const char *host, int port);
323 /* Version which dies on error */
324 len_and_sockaddr* xhost2sockaddr(const char *host, int port);
325 len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
326 #if ENABLE_FEATURE_IPV6
327 /* Same, useful if you want to force family (e.g. IPv6) */
328 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
329 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
331 /* [we evaluate af: think about "host_and_af2sockaddr(..., af++)"] */
332 #define host_and_af2sockaddr(host, port, af) ((void)(af), host2sockaddr((host), (port)))
333 #define xhost_and_af2sockaddr(host, port, af) ((void)(af), xhost2sockaddr((host), (port)))
335 /* Assign sin[6]_port member if the socket is of corresponding type,
336 * otherwise no-op. Useful for ftp.
337 * NB: does NOT do htons() internally, just direct assignment. */
338 void set_nport(len_and_sockaddr *lsa, unsigned port);
339 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
340 int get_nport(const len_and_sockaddr *lsa);
341 /* Reverse DNS. Returns NULL on failure. */
342 char* xmalloc_sockaddr2host(const struct sockaddr *sa, socklen_t salen);
343 /* This one doesn't append :PORTNUM */
344 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa, socklen_t salen);
345 /* This one also doesn't fall back to dotted IP (returns NULL) */
346 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa, socklen_t salen);
347 /* inet_[ap]ton on steroids */
348 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa, socklen_t salen);
349 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa, socklen_t salen);
350 // "old" (ipv4 only) API
351 // users: traceroute.c hostname.c
352 struct hostent *xgethostbyname(const char *name);
353 // Also inetd.c and inetd.c are using gethostbyname(),
354 // + inet_common.c has additional IPv4-only stuff
357 extern char *xstrdup(const char *s);
358 extern char *xstrndup(const char *s, int n);
359 extern char *safe_strncpy(char *dst, const char *src, size_t size);
360 extern char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
361 // gcc-4.1.1 still isn't good enough at optimizing it
362 // (+200 bytes compared to macro)
363 //static ATTRIBUTE_ALWAYS_INLINE
364 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
365 //static ATTRIBUTE_ALWAYS_INLINE
366 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
367 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
368 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
369 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
370 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
372 /* dmalloc will redefine these to it's own implementation. It is safe
373 * to have the prototypes here unconditionally. */
374 extern void *xmalloc(size_t size);
375 extern void *xrealloc(void *old, size_t size);
376 extern void *xzalloc(size_t size);
378 extern ssize_t safe_read(int fd, void *buf, size_t count);
379 extern ssize_t full_read(int fd, void *buf, size_t count);
380 extern void xread(int fd, void *buf, size_t count);
381 extern unsigned char xread_char(int fd);
382 extern char *reads(int fd, char *buf, size_t count);
383 extern ssize_t read_close(int fd, void *buf, size_t count);
384 extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
385 extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
387 extern ssize_t safe_write(int fd, const void *buf, size_t count);
388 extern ssize_t full_write(int fd, const void *buf, size_t count);
389 extern void xwrite(int fd, const void *buf, size_t count);
391 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
392 extern void xprint_and_close_file(FILE *file);
393 extern char *xmalloc_fgets(FILE *file);
394 /* Read up to (and including) TERMINATING_STRING: */
395 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
396 /* Chops off '\n' from the end, unlike fgets: */
397 extern char *xmalloc_getline(FILE *file);
398 extern char *bb_get_chunk_from_file(FILE *file, int *end);
399 extern void die_if_ferror(FILE *file, const char *msg);
400 extern void die_if_ferror_stdout(void);
401 extern void xfflush_stdout(void);
402 extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
403 extern int fclose_if_not_stdin(FILE *file);
404 extern FILE *xfopen(const char *filename, const char *mode);
405 /* Prints warning to stderr and returns NULL on failure: */
406 extern FILE *fopen_or_warn(const char *filename, const char *mode);
407 /* "Opens" stdin if filename is special, else just opens file: */
408 extern FILE *fopen_or_warn_stdin(const char *filename);
411 extern char *utoa(unsigned n);
412 extern char *itoa(int n);
413 /* Returns a pointer past the formatted number, does NOT null-terminate */
414 extern char *utoa_to_buf(unsigned n, char *buf, unsigned buflen);
415 extern char *itoa_to_buf(int n, char *buf, unsigned buflen);
416 extern void smart_ulltoa5(unsigned long long ul, char buf[5]);
417 /* Put a string of hex bytes (ala "1b"), return advanced pointer */
418 extern char *bin2hex(char *buf, const char *cp, int count);
426 /* Using xatoi() instead of naive atoi() is not always convenient -
427 * in many places people want *non-negative* values, but store them
428 * in signed int. Therefore we need this one:
429 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
430 int xatoi_u(const char *numstr);
431 /* Useful for reading port numbers */
432 uint16_t xatou16(const char *numstr);
435 /* These parse entries in /etc/passwd and /etc/group. This is desirable
436 * for BusyBox since we want to avoid using the glibc NSS stuff, which
437 * increases target size and is often not needed on embedded systems. */
438 long xuname2uid(const char *name);
439 long xgroup2gid(const char *name);
440 /* wrapper: allows string to contain numeric uid or gid */
441 unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
442 /* from chpst. Does not die, returns 0 on failure */
447 /* always sets uid and gid */
448 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
449 /* chown-like handling of "user[:[group]" */
450 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
452 /*extern char *bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);*/
453 char *bb_getpwuid(char *name, long uid, int bufsize);
454 char *bb_getgrgid(char *group, long gid, int bufsize);
455 /* versions which cache results (useful for ps, ls etc) */
456 const char* get_cached_username(uid_t uid);
457 const char* get_cached_groupname(gid_t gid);
458 void clear_username_cache(void);
459 /* internally usernames are saved in fixed-sized char[] buffers */
460 enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
463 int execable_file(const char *name);
464 char *find_execable(const char *filename);
465 int exists_execable(const char *filename);
467 #if ENABLE_FEATURE_EXEC_PREFER_APPLETS
468 int bb_execvp(const char *file, char *const argv[]);
469 #define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
470 #define BB_EXECLP(prog,cmd,...) \
471 execlp((find_applet_by_name(prog)) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
474 #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
475 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
478 /* NOMMU friendy fork+exec */
479 pid_t spawn(char **argv);
480 pid_t xspawn(char **argv);
481 /* Helpers for daemonization.
483 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
485 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
486 * rexec's itself on NOMMU with argv passed as command line.
487 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
488 * from the start. (It will detect it and not reexec again second time).
489 * You have to audit carefully that you don't do something twice as a result
490 * (opening files/sockets, parsing config files etc...)!
492 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
493 * (will do setsid()).
495 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
496 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
497 * Currently used for openvt. On MMU ignores argv.
499 * Helper for network daemons in foreground mode:
501 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
502 * to /dev/null if they are not.
505 DAEMON_CHDIR_ROOT = 1,
506 DAEMON_DEVNULL_STDIO = /* 2 */ 0, /* no users so far */
507 DAEMON_CLOSE_EXTRA_FDS = 4,
508 DAEMON_ONLY_SANITIZE = 8, /* internal use */
511 void forkexit_or_rexec(void);
512 # define forkexit_or_rexec(argv) forkexit_or_rexec()
513 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
514 # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
516 void forkexit_or_rexec(char **argv);
517 extern smallint re_execed;
518 # define fork() BUG_fork_is_unavailable_on_nommu()
519 # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
520 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
522 void bb_daemonize_or_rexec(int flags, char **argv);
523 void bb_sanitize_stdio(void);
526 enum { BB_GETOPT_ERROR = 0x80000000 };
527 extern const char *opt_complementary;
528 #if ENABLE_GETOPT_LONG
529 extern const struct option *applet_long_options;
531 extern uint32_t option_mask32;
532 extern uint32_t getopt32(int argc, char **argv, const char *applet_opts, ...);
535 typedef struct llist_s {
537 struct llist_s *link;
539 extern void llist_add_to(llist_t **old_head, void *data);
540 extern void llist_add_to_end(llist_t **list_head, void *data);
541 extern void *llist_pop(llist_t **elm);
542 extern void llist_unlink(llist_t **head, llist_t *elm);
543 extern void llist_free(llist_t *elm, void (*freeit)(void *data));
544 extern llist_t* llist_rev(llist_t *list);
546 #if ENABLE_FEATURE_PIDFILE
547 int write_pidfile(const char *path);
548 #define remove_pidfile(f) ((void)unlink(f))
550 #define write_pidfile(f) 1
551 #define remove_pidfile(f) ((void)0)
556 LOGMODE_STDIO = 1<<0,
557 LOGMODE_SYSLOG = 1<<1,
558 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
560 extern const char *msg_eol;
562 extern int die_sleep;
563 extern int xfunc_error_retval;
564 extern void sleep_and_die(void) ATTRIBUTE_NORETURN;
565 extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
566 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
567 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
568 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
569 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
570 extern void bb_vherror_msg(const char *s, va_list p);
571 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
572 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
573 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
574 extern void bb_perror_nomsg(void);
575 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
576 /* These are used internally -- you shouldn't need to use them */
577 extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
578 extern void bb_vperror_msg(const char *s, va_list p);
579 extern void bb_vinfo_msg(const char *s, va_list p);
582 /* applets which are useful from another applets */
583 int bb_cat(char** argv);
584 int bb_echo(char** argv);
585 int bb_test(int argc, char** argv);
587 void bb_displayroutes(int noresolve, int netstatfmt);
589 int chown_main(int argc, char **argv);
591 int gunzip_main(int argc, char **argv);
593 int bbunpack(char **argv,
594 char* (*make_new_name)(char *filename),
595 USE_DESKTOP(long long) int (*unpacker)(void)
600 int create_icmp_socket(void);
601 int create_icmp6_socket(void);
603 extern int interface_opt_a;
604 int display_interfaces(char *ifname);
605 const struct aftype *get_aftype(const char *name);
606 const struct hwtype *get_hwtype(const char *name);
607 const struct hwtype *get_hwntype(int type);
610 #ifndef BUILD_INDIVIDUAL
611 extern struct BB_applet *find_applet_by_name(const char *name);
612 extern void run_applet_by_name(const char *name, int argc, char **argv);
615 extern struct mntent *find_mount_point(const char *name, const char *table);
616 extern void erase_mtab(const char * name);
617 extern unsigned int tty_baud_to_value(speed_t speed);
618 extern speed_t tty_value_to_baud(unsigned int value);
619 extern void bb_warn_ignoring_args(int n);
621 extern int get_linux_version_code(void);
623 extern char *query_loop(const char *device);
624 extern int del_loop(const char *device);
625 extern int set_loop(char **device, const char *file, unsigned long long offset);
628 //TODO: provide pointer to buf (avoid statics)?
629 const char *make_human_readable_str(unsigned long long size,
630 unsigned long block_size, unsigned long display_unit);
632 //TODO: pass buf pointer or return allocated buf (avoid statics)?
633 char *bb_askpass(int timeout, const char * prompt);
634 int bb_ask_confirmation(void);
635 int klogctl(int type, char * b, int len);
637 extern int bb_parse_mode(const char* s, mode_t* theMode);
639 char *concat_path_file(const char *path, const char *filename);
640 char *concat_subpath_file(const char *path, const char *filename);
641 char *last_char_is(const char *s, int c);
644 USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
645 int inflate(int in, int out);
648 int bb_make_directory(char *path, long mode, int flags);
650 int get_signum(const char *name);
651 const char *get_signame(int number);
653 char *bb_simplify_path(const char *path);
656 extern void bb_do_delay(int seconds);
657 extern void change_identity(const struct passwd *pw);
658 extern const char *change_identity_e2str(const struct passwd *pw);
659 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
661 extern void renew_current_security_context(void);
662 extern void set_current_security_context(security_context_t sid);
663 extern context_t set_security_context_component(security_context_t cur_context,
664 char *user, char *role, char *type, char *range);
665 extern void setfscreatecon_or_die(security_context_t scontext);
667 extern void selinux_or_die(void);
668 extern int restricted_shell(const char *shell);
669 extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
670 extern int correct_password(const struct passwd *pw);
671 extern char *pw_encrypt(const char *clear, const char *salt);
672 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
673 extern int index_in_str_array(const char * const string_array[], const char *key);
674 extern int index_in_substr_array(const char * const string_array[], const char *key);
675 extern void print_login_issue(const char *issue_file, const char *tty);
676 extern void print_login_prompt(void);
679 extern int get_terminal_width_height(const int fd, int *width, int *height);
681 char *is_in_ino_dev_hashtable(const struct stat *statbuf);
682 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
683 void reset_ino_dev_hashtable(void);
685 /* At least glibc has horrendously large inline for this, so wrap it */
686 extern unsigned long long bb_makedev(unsigned int major, unsigned int minor);
688 #define makedev(a,b) bb_makedev(a,b)
692 #if ENABLE_FEATURE_EDITING
693 /* It's NOT just ENABLEd or disabled. It's a number: */
694 #ifdef CONFIG_FEATURE_EDITING_HISTORY
695 #define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
697 #define MAX_HISTORY 0
699 struct line_input_t {
701 const char *path_lookup;
705 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
706 char *history[MAX_HISTORY + 1];
710 DO_HISTORY = 1 * (MAX_HISTORY > 0),
711 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
712 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
713 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
714 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
715 WITH_PATH_LOOKUP = 0x20,
716 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
718 typedef struct line_input_t line_input_t;
719 line_input_t *new_line_input_t(int flags);
720 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
722 int read_line_input(const char* prompt, char* command, int maxsize);
723 #define read_line_input(prompt, command, maxsize, state) \
724 read_line_input(prompt, command, maxsize)
730 enum { COMM_LEN = TASK_COMM_LEN };
732 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
733 enum { COMM_LEN = 16 };
738 /* Fields are set to 0/NULL if failed to determine (or not requested) */
741 unsigned long stime, utime;
748 /* basename of executable file in call to exec(2), size from */
749 /* sizeof(task_struct.comm) in /usr/include/linux/sched.h */
752 // user/group? - use passwd/group parsing functions
756 PSSCAN_PPID = 1 << 1,
757 PSSCAN_PGID = 1 << 2,
759 PSSCAN_UIDGID = 1 << 4,
760 PSSCAN_COMM = 1 << 5,
762 PSSCAN_STATE = 1 << 7,
764 PSSCAN_STIME = 1 << 9,
765 PSSCAN_UTIME = 1 << 10,
766 /* These are all retrieved from proc/NN/stat in one go: */
767 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
768 | PSSCAN_COMM | PSSCAN_STATE
769 | PSSCAN_VSZ | PSSCAN_STIME | PSSCAN_UTIME,
771 procps_status_t* alloc_procps_scan(int flags);
772 void free_procps_scan(procps_status_t* sp);
773 procps_status_t* procps_scan(procps_status_t* sp, int flags);
774 pid_t *find_pid_by_name(const char* procName);
775 pid_t *pidlist_reverse(pid_t *pidList);
778 extern const char bb_uuenc_tbl_base64[];
779 extern const char bb_uuenc_tbl_std[];
780 void bb_uuencode(const unsigned char *s, char *store, const int length, const char *tbl);
782 typedef struct sha1_ctx_t {
787 void sha1_begin(sha1_ctx_t *ctx);
788 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
789 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
791 typedef struct md5_ctx_t {
800 void md5_begin(md5_ctx_t *ctx);
801 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
802 void *md5_end(void *resbuf, md5_ctx_t *ctx);
804 uint32_t *crc32_filltable(int endian);
807 enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
808 FILEUTILS_PRESERVE_STATUS = 1,
809 FILEUTILS_DEREFERENCE = 2,
812 FILEUTILS_INTERACTIVE = 0x10,
813 FILEUTILS_MAKE_HARDLINK = 0x20,
814 FILEUTILS_MAKE_SOFTLINK = 0x40,
816 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x80,
817 FILEUTILS_SET_SECURITY_CONTEXT = 0x100
821 #define FILEUTILS_CP_OPTSTR "pdRfils" USE_SELINUX("c")
822 extern const char *applet_name;
823 extern const char BB_BANNER[];
825 extern const char bb_msg_full_version[];
826 extern const char bb_msg_memory_exhausted[];
827 extern const char bb_msg_invalid_date[];
828 extern const char bb_msg_read_error[];
829 extern const char bb_msg_write_error[];
830 extern const char bb_msg_unknown[];
831 extern const char bb_msg_can_not_create_raw_socket[];
832 extern const char bb_msg_perm_denied_are_you_root[];
833 extern const char bb_msg_requires_arg[];
834 extern const char bb_msg_invalid_arg[];
835 extern const char bb_msg_standard_input[];
836 extern const char bb_msg_standard_output[];
838 extern const char bb_str_default[];
839 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
840 extern const char bb_hexdigits_upcase[];
842 extern const char bb_path_mtab_file[];
843 extern const char bb_path_nologin_file[];
844 extern const char bb_path_passwd_file[];
845 extern const char bb_path_shadow_file[];
846 extern const char bb_path_gshadow_file[];
847 extern const char bb_path_group_file[];
848 extern const char bb_path_securetty_file[];
849 extern const char bb_path_motd_file[];
850 extern const char bb_path_wtmp_file[];
851 extern const char bb_dev_null[];
853 extern const int const_int_0;
854 extern const int const_int_1;
859 extern char bb_common_bufsiz1[BUFSIZ+1];
860 /* This struct is deliberately not defined. */
861 /* See docs/keep_data_small.txt */
863 /* Magic prevents this from going into rodata */
864 /* If you want to assign a value, use PTR_TO_GLOBALS = xxx */
865 extern struct globals *const ptr_to_globals;
866 #define PTR_TO_GLOBALS (*(struct globals**)&ptr_to_globals)
868 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
869 * use bb_default_login_shell and following defines.
870 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
871 * don't forget to change increment constant. */
872 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
873 extern const char bb_default_login_shell[];
875 #define DEFAULT_SHELL (bb_default_login_shell+1)
877 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
880 #if ENABLE_FEATURE_DEVFS
881 # define CURRENT_VC "/dev/vc/0"
882 # define VC_1 "/dev/vc/1"
883 # define VC_2 "/dev/vc/2"
884 # define VC_3 "/dev/vc/3"
885 # define VC_4 "/dev/vc/4"
886 # define VC_5 "/dev/vc/5"
887 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
888 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
889 respective serial ports .. as such, we can't use the common device paths for
891 # define SC_0 "/dev/ttsc/0"
892 # define SC_1 "/dev/ttsc/1"
893 # define SC_FORMAT "/dev/ttsc/%d"
895 # define SC_0 "/dev/tts/0"
896 # define SC_1 "/dev/tts/1"
897 # define SC_FORMAT "/dev/tts/%d"
899 # define VC_FORMAT "/dev/vc/%d"
900 # define LOOP_FORMAT "/dev/loop/%d"
901 # define LOOP_NAME "/dev/loop/"
902 # define FB_0 "/dev/fb/0"
904 # define CURRENT_VC "/dev/tty0"
905 # define VC_1 "/dev/tty1"
906 # define VC_2 "/dev/tty2"
907 # define VC_3 "/dev/tty3"
908 # define VC_4 "/dev/tty4"
909 # define VC_5 "/dev/tty5"
910 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
911 # define SC_0 "/dev/ttySC0"
912 # define SC_1 "/dev/ttySC1"
913 # define SC_FORMAT "/dev/ttySC%d"
915 # define SC_0 "/dev/ttyS0"
916 # define SC_1 "/dev/ttyS1"
917 # define SC_FORMAT "/dev/ttyS%d"
919 # define VC_FORMAT "/dev/tty%d"
920 # define LOOP_FORMAT "/dev/loop%d"
921 # define LOOP_NAME "/dev/loop"
922 # define FB_0 "/dev/fb0"
925 /* The following devices are the same on devfs and non-devfs systems. */
926 #define CURRENT_TTY "/dev/tty"
927 #define DEV_CONSOLE "/dev/console"
931 /* Stop system and switch power off if possible. */
932 #define RB_POWER_OFF 0x4321fedc
935 /* Make sure we call functions instead of macros. */
949 /* This one is more efficient - we save ~400 bytes */
951 #define isdigit(a) ((unsigned)((a) - '0') <= 9)
958 #endif /* __LIBBUSYBOX_H__ */