gzip: bbunzip integration fixes
[oweals/busybox.git] / include / libbb.h
index 62d5fcee4c2bf1b611cf98ffc29338961d73e2b5..759eb8d15602cdf9a76a146b6a8c931c3b1e75f7 100644 (file)
@@ -4,7 +4,7 @@
  *
  * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
  * Permission has been granted to redistribute this code under the GPL.
- * 
+ *
  * Licensed under the GPL version 2, see the file LICENSE in this tarball.
  */
 #ifndef        __LIBBUSYBOX_H__
@@ -41,6 +41,7 @@
 
 #if ENABLE_SELINUX
 #include <selinux/selinux.h>
+#include <selinux/context.h>
 #endif
 
 #if ENABLE_LOCALE_SUPPORT
 
 /* This structure defines protocol families and their handlers. */
 struct aftype {
-       char *name;
-       char *title;
+       const char *name;
+       const char *title;
        int af;
        int alen;
        char *(*print) (unsigned char *);
@@ -143,8 +144,8 @@ struct aftype {
 
 /* This structure defines hardware protocols and their handlers. */
 struct hwtype {
-       char *name;
-       char *title;
+       const char *name;
+       const char *title;
        int type;
        int alen;
        char *(*print) (unsigned char *);
@@ -223,24 +224,12 @@ struct sysinfo {
 extern int sysinfo(struct sysinfo* info);
 
 
-/* Size-saving "small" ints (arch-dependent) */
-#if defined(i386) || defined (__mips__)
-/* add other arches which benefit from this... */
-typedef signed char smallint;
-typedef unsigned char smalluint;
-#else
-/* for arches where byte accesses generate larger code: */
-typedef int smallint;
-typedef unsigned smalluint;
-#endif
-
-
 extern void chomp(char *s);
 extern void trim(char *s);
 extern char *skip_whitespace(const char *);
 extern char *skip_non_whitespace(const char *);
 
-extern const char *bb_mode_string(int mode);
+extern const char *bb_mode_string(mode_t mode);
 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
 extern int remove_file(const char *path, int flags);
 extern int copy_file(const char *source, const char *dest, int flags);
@@ -251,7 +240,7 @@ extern int recursive_action(const char *fileName, int recurse,
        void* userData, int depth);
 extern int device_open(const char *device, int mode);
 extern int get_console_fd(void);
-extern char *find_block_device(char *path);
+extern char *find_block_device(const char *path);
 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
 extern off_t bb_copyfd_eof(int fd1, int fd2);
 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
@@ -260,6 +249,8 @@ extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
 /* this helper yells "short read!" if param is not -1 */
 extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
 extern char bb_process_escape_sequence(const char **ptr);
+/* TODO: sometimes modifies its parameter, which
+ * makes it rather inconvenient at times: */
 extern char *bb_get_last_path_component(char *path);
 extern int ndelay_on(int fd);
 extern int ndelay_off(int fd);
@@ -268,16 +259,21 @@ extern int ndelay_off(int fd);
 extern DIR *xopendir(const char *path);
 extern DIR *warn_opendir(const char *path);
 
-char *xgetcwd(char *cwd);
-char *xreadlink(const char *path);
+char *xrealloc_getcwd_or_warn(char *cwd);
+char *xmalloc_readlink_or_warn(const char *path);
 char *xmalloc_realpath(const char *path);
-extern void xstat(char *filename, struct stat *buf);
+extern void xstat(const char *filename, struct stat *buf);
 extern pid_t spawn(char **argv);
 extern pid_t xspawn(char **argv);
 extern int wait4pid(int pid);
 extern void xsetgid(gid_t gid);
 extern void xsetuid(uid_t uid);
 extern void xdaemon(int nochdir, int noclose);
+/* More clever/thorough xdaemon */
+extern void bb_sanitize_stdio_maybe_daemonize(int daemonize);
+extern void bb_sanitize_stdio(void);
+/* NB: be careful: dont open syslog/network sockets before bb_daemonize */
+extern void bb_daemonize(void);
 extern void xchdir(const char *path);
 extern void xsetenv(const char *key, const char *value);
 extern int xopen(const char *pathname, int flags);
@@ -286,28 +282,16 @@ extern off_t xlseek(int fd, off_t offset, int whence);
 extern off_t fdlength(int fd);
 
 
-extern int xsocket(int domain, int type, int protocol);
-extern void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
-extern void xlisten(int s, int backlog);
-extern void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
-extern int xconnect_tcp_v4(struct sockaddr_in *s_addr);
-extern struct hostent *xgethostbyname(const char *name);
-extern struct hostent *xgethostbyname2(const char *name, int af);
-
-extern int setsockopt_reuseaddr(int fd);
-extern int setsockopt_broadcast(int fd);
-/* Create server TCP socket bound to bindaddr:port. bindaddr can be NULL,
- * numeric IP ("N.N.N.N") or numeric IPv6 address,
- * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
- * If there is no suffix, port argument is used */
-extern int create_and_bind_stream_or_die(const char *bindaddr, int port);
-/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
- * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
- * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
- * If there is no suffix, port argument is used */
-extern int create_and_connect_stream_or_die(const char *peer, int port);
+int xsocket(int domain, int type, int protocol);
+void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
+void xlisten(int s, int backlog);
+void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
+int setsockopt_reuseaddr(int fd);
+int setsockopt_broadcast(int fd);
+/* NB: returns port in host byte order */
+unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
 typedef struct len_and_sockaddr {
-       int len;
+       socklen_t len;
        union {
                struct sockaddr sa;
                struct sockaddr_in sin;
@@ -316,11 +300,59 @@ typedef struct len_and_sockaddr {
 #endif
        };
 } len_and_sockaddr;
+/* Create stream socket, and allocated suitable lsa
+ * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6)) */
+int xsocket_stream(len_and_sockaddr **lsap);
+/* Create server TCP socket bound to bindaddr:port. bindaddr can be NULL,
+ * numeric IP ("N.N.N.N") or numeric IPv6 address,
+ * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
+ * If there is no suffix, port argument is used */
+int create_and_bind_stream_or_die(const char *bindaddr, int port);
+/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
+ * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
+ * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
+ * If there is no suffix, port argument is used */
+int create_and_connect_stream_or_die(const char *peer, int port);
+/* Connect to peer identified by lsa */
+int xconnect_stream(const len_and_sockaddr *lsa);
 /* Return malloc'ed len_and_sockaddr with socket address of host:port
  * Currently will return IPv4 or IPv6 sockaddrs only
  * (depending on host), but in theory nothing prevents e.g.
- * UNIX socket address being returned, IPX sockaddr etc... */
-extern len_and_sockaddr* host2sockaddr(const char *host, int port);
+ * UNIX socket address being returned, IPX sockaddr etc...
+ * On error does bb_error_msg and returns NULL */
+len_and_sockaddr* host2sockaddr(const char *host, int port);
+/* Version which dies on error */
+len_and_sockaddr* xhost2sockaddr(const char *host, int port);
+len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
+#if ENABLE_FEATURE_IPV6
+/* Same, useful if you want to force family (e.g. IPv6) */
+len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
+len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
+#else
+/* [we evaluate af: think about "host_and_af2sockaddr(..., af++)"] */
+#define host_and_af2sockaddr(host, port, af) ((void)(af), host2sockaddr((host), (port)))
+#define xhost_and_af2sockaddr(host, port, af) ((void)(af), xhost2sockaddr((host), (port)))
+#endif
+/* Assign sin[6]_port member if the socket is of corresponding type,
+ * otherwise no-op. Useful for ftp.
+ * NB: does NOT do htons() internally, just direct assignment. */
+void set_nport(len_and_sockaddr *lsa, unsigned port);
+/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
+int get_nport(const len_and_sockaddr *lsa);
+/* Reverse DNS. Returns NULL on failure. */
+char* xmalloc_sockaddr2host(const struct sockaddr *sa, socklen_t salen);
+/* This one doesn't append :PORTNUM */
+char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa, socklen_t salen);
+/* This one also doesn't fall back to dotted IP (returns NULL) */
+char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa, socklen_t salen);
+/* inet_[ap]ton on steroids */
+char* xmalloc_sockaddr2dotted(const struct sockaddr *sa, socklen_t salen);
+char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa, socklen_t salen);
+// "old" (ipv4 only) API
+// users: traceroute.c hostname.c
+struct hostent *xgethostbyname(const char *name);
+// Also inetd.c and inetd.c are using gethostbyname(),
+// + inet_common.c has additional IPv4-only stuff
 
 
 extern char *xstrdup(const char *s);
@@ -377,11 +409,13 @@ extern FILE *fopen_or_warn(const char *filename, const char *mode);
 extern FILE *fopen_or_warn_stdin(const char *filename);
 
 
-extern void smart_ulltoa5(unsigned long long ul, char buf[5]);
 extern void utoa_to_buf(unsigned n, char *buf, unsigned buflen);
 extern char *utoa(unsigned n);
 extern void itoa_to_buf(int n, char *buf, unsigned buflen);
 extern char *itoa(int n);
+extern void smart_ulltoa5(unsigned long long ul, char buf[5]);
+/* Put a string of hex bytes (ala "1b"), return advanced pointer */
+extern char *bin2hex(char *buf, const char *cp, int count);
 
 struct suffix_mult {
        const char *suffix;
@@ -401,20 +435,29 @@ uint16_t xatou16(const char *numstr);
 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
  * for BusyBox since we want to avoid using the glibc NSS stuff, which
  * increases target size and is often not needed on embedded systems.  */
-extern long xuname2uid(const char *name);
-extern long xgroup2gid(const char *name);
+long xuname2uid(const char *name);
+long xgroup2gid(const char *name);
 /* wrapper: allows string to contain numeric uid or gid */
-extern unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
+unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
 /* from chpst. Does not die, returns 0 on failure */
 struct bb_uidgid_t {
-        uid_t uid;
-        gid_t gid;
+       uid_t uid;
+       gid_t gid;
 };
-extern int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
+/* always sets uid and gid */
+int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
+/* chown-like handling of "user[:[group]" */
+void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
 /* what is this? */
 /*extern char *bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);*/
-extern char *bb_getpwuid(char *name, long uid, int bufsize);
-extern char *bb_getgrgid(char *group, long gid, int bufsize);
+char *bb_getpwuid(char *name, long uid, int bufsize);
+char *bb_getgrgid(char *group, long gid, int bufsize);
+/* versions which cache results (useful for ps, ls etc) */
+const char* get_cached_username(uid_t uid);
+const char* get_cached_groupname(gid_t gid);
+void clear_username_cache(void);
+/* internally usernames are saved in fixed-sized char[] buffers */
+enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
 
 
 enum { BB_GETOPT_ERROR = 0x80000000 };
@@ -433,8 +476,9 @@ typedef struct llist_s {
 extern void llist_add_to(llist_t **old_head, void *data);
 extern void llist_add_to_end(llist_t **list_head, void *data);
 extern void *llist_pop(llist_t **elm);
+extern void llist_unlink(llist_t **head, llist_t *elm);
 extern void llist_free(llist_t *elm, void (*freeit)(void *data));
-extern llist_t* rev_llist(llist_t *list);
+extern llist_t* llist_rev(llist_t *list);
 
 enum {
        LOGMODE_NONE = 0,
@@ -465,9 +509,20 @@ extern void bb_vinfo_msg(const char *s, va_list p);
 
 
 /* applets which are useful from another applets */
-extern int bb_cat(char** argv);
-extern int bb_echo(char** argv);
-extern int bb_test(int argc, char** argv);
+int bb_cat(char** argv);
+int bb_echo(char** argv);
+int bb_test(int argc, char** argv);
+#if ENABLE_ROUTE
+void bb_displayroutes(int noresolve, int netstatfmt);
+#endif
+int chown_main(int argc, char **argv);
+#if ENABLE_GUNZIP
+int gunzip_main(int argc, char **argv);
+#endif
+int bbunpack(char **argv,
+        char* (*make_new_name)(char *filename),
+        USE_DESKTOP(long long) int (*unpacker)(void)
+);
 
 
 /* Networking */
@@ -518,13 +573,21 @@ int execable_file(const char *name);
 char *find_execable(const char *filename);
 int exists_execable(const char *filename);
 
+#if ENABLE_FEATURE_EXEC_PREFER_APPLETS
+int bb_execvp(const char *file, char *const argv[]);
+#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
+#define BB_EXECLP(prog,cmd,...) \
+       execlp((find_applet_by_name(prog)) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
+               cmd, __VA_ARGS__)
+#else
+#define BB_EXECVP(prog,cmd)     execvp(prog,cmd)
+#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
+#endif
+
 USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
 int inflate(int in, int out);
 
 
-unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
-void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
-
 int bb_make_directory(char *path, long mode, int flags);
 
 int get_signum(const char *name);
@@ -540,7 +603,11 @@ extern void run_shell(const char *shell, int loginshell, const char *command, co
 #if ENABLE_SELINUX
 extern void renew_current_security_context(void);
 extern void set_current_security_context(security_context_t sid);
+extern context_t set_security_context_component(security_context_t cur_context,
+                                               char *user, char *role, char *type, char *range);
+extern void setfscreatecon_or_die(security_context_t scontext);
 #endif
+extern void selinux_or_die(void);
 extern int restricted_shell(const char *shell);
 extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
 extern int correct_password(const struct passwd *pw);
@@ -555,7 +622,7 @@ extern void vfork_daemon(int nochdir, int noclose);
 extern void vfork_daemon_rexec(int nochdir, int noclose,
                int argc, char **argv, char *foreground_opt);
 #endif
-extern int get_terminal_width_height(int fd, int *width, int *height);
+extern int get_terminal_width_height(const int fd, int *width, int *height);
 
 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
@@ -568,6 +635,42 @@ extern unsigned long long bb_makedev(unsigned int major, unsigned int minor);
 #endif
 
 
+#if ENABLE_FEATURE_EDITING
+/* It's NOT just ENABLEd or disabled. It's a number: */
+#ifdef CONFIG_FEATURE_EDITING_HISTORY
+#define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
+#else
+#define MAX_HISTORY 0
+#endif
+struct line_input_t {
+       int flags;
+       const char *path_lookup;
+#if MAX_HISTORY
+       int cnt_history;
+       int cur_history;
+       USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
+       char *history[MAX_HISTORY + 1];
+#endif
+};
+enum {
+       DO_HISTORY = 1 * (MAX_HISTORY > 0),
+       SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
+       TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
+       USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
+       VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
+       WITH_PATH_LOOKUP = 0x20,
+       FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
+};
+typedef struct line_input_t line_input_t;
+line_input_t *new_line_input_t(int flags);
+int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
+#else
+int read_line_input(const char* prompt, char* command, int maxsize);
+#define read_line_input(prompt, command, maxsize, state) \
+       read_line_input(prompt, command, maxsize)
+#endif
+
+
 #ifndef COMM_LEN
 #ifdef TASK_COMM_LEN
 enum { COMM_LEN = TASK_COMM_LEN };
@@ -580,7 +683,7 @@ typedef struct {
        DIR *dir;
 /* Fields are set to 0/NULL if failed to determine (or not requested) */
        char *cmd;
-       unsigned long rss;
+       unsigned long vsz;
        unsigned long stime, utime;
        unsigned pid;
        unsigned ppid;
@@ -603,22 +706,19 @@ enum {
        PSSCAN_COMM     = 1 << 5,
        PSSCAN_CMD      = 1 << 6,
        PSSCAN_STATE    = 1 << 7,
-       PSSCAN_RSS      = 1 << 8,
+       PSSCAN_VSZ      = 1 << 8,
        PSSCAN_STIME    = 1 << 9,
        PSSCAN_UTIME    = 1 << 10,
        /* These are all retrieved from proc/NN/stat in one go: */
        PSSCAN_STAT     = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
                        | PSSCAN_COMM | PSSCAN_STATE
-                       | PSSCAN_RSS | PSSCAN_STIME | PSSCAN_UTIME,
+                       | PSSCAN_VSZ | PSSCAN_STIME | PSSCAN_UTIME,
 };
 procps_status_t* alloc_procps_scan(int flags);
 void free_procps_scan(procps_status_t* sp);
 procps_status_t* procps_scan(procps_status_t* sp, int flags);
 pid_t *find_pid_by_name(const char* procName);
 pid_t *pidlist_reverse(pid_t *pidList);
-void clear_username_cache(void);
-const char* get_cached_username(uid_t uid);
-const char* get_cached_groupname(gid_t gid);
 
 
 extern const char bb_uuenc_tbl_base64[];
@@ -650,7 +750,7 @@ void *md5_end(void *resbuf, md5_ctx_t *ctx);
 uint32_t *crc32_filltable(int endian);
 
 
-enum { /* DO NOT CHANGE THESE VALUES!  cp.c depends on them. */
+enum { /* DO NOT CHANGE THESE VALUES!  cp.c, mv.c, install.c depend on them. */
        FILEUTILS_PRESERVE_STATUS = 1,
        FILEUTILS_DEREFERENCE = 2,
        FILEUTILS_RECUR = 4,
@@ -658,9 +758,13 @@ enum {     /* DO NOT CHANGE THESE VALUES!  cp.c depends on them. */
        FILEUTILS_INTERACTIVE = 0x10,
        FILEUTILS_MAKE_HARDLINK = 0x20,
        FILEUTILS_MAKE_SOFTLINK = 0x40,
+#if ENABLE_SELINUX
+       FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x80,
+       FILEUTILS_SET_SECURITY_CONTEXT = 0x100
+#endif
 };
-#define FILEUTILS_CP_OPTSTR "pdRfils"
 
+#define FILEUTILS_CP_OPTSTR "pdRfils" USE_SELINUX("c")
 extern const char *applet_name;
 extern const char BB_BANNER[];
 
@@ -678,6 +782,8 @@ extern const char bb_msg_standard_input[];
 extern const char bb_msg_standard_output[];
 
 extern const char bb_str_default[];
+/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
+extern const char bb_hexdigits_upcase[];
 
 extern const char bb_path_mtab_file[];
 extern const char bb_path_nologin_file[];
@@ -690,6 +796,9 @@ extern const char bb_path_motd_file[];
 extern const char bb_path_wtmp_file[];
 extern const char bb_dev_null[];
 
+extern const int const_int_0;
+extern const int const_int_1;
+
 #ifndef BUFSIZ
 #define BUFSIZ 4096
 #endif
@@ -754,7 +863,7 @@ extern const char bb_default_login_shell[];
 
 /* The following devices are the same on devfs and non-devfs systems.  */
 #define CURRENT_TTY "/dev/tty"
-#define CONSOLE_DEV "/dev/console"
+#define DEV_CONSOLE "/dev/console"
 
 
 #ifndef RB_POWER_OFF