X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=include%2Flibbb.h;h=c5b685985e91dd504a60a2159631cca0bfe22d57;hb=73032ca04be49c096f745f0873d67d9c831642bd;hp=6c6b4863c8985b5f847e4530054884897cca918d;hpb=fc1e9951c6393f9b0e42d9a7fa2899b8618b21f8;p=oweals%2Fbusybox.git diff --git a/include/libbb.h b/include/libbb.h index 6c6b4863c..c5b685985 100644 --- a/include/libbb.h +++ b/include/libbb.h @@ -26,7 +26,6 @@ #include #include #include -/* #include - said to be obsolete */ #include #include #include @@ -40,10 +39,18 @@ #include #include #include +/* Try to pull in PATH_MAX */ +#include +#include +#ifndef PATH_MAX +#define PATH_MAX 256 +#endif #if ENABLE_SELINUX #include #include +#include +#include #endif #if ENABLE_LOCALE_SUPPORT @@ -60,14 +67,40 @@ #include "shadow_.h" #endif -/* Try to pull in PATH_MAX */ -#include -#include -#ifndef PATH_MAX -#define PATH_MAX 256 +/* Some libc's don't declare it, help them */ +extern char **environ; + +#if defined(__GLIBC__) && __GLIBC__ < 2 +int vdprintf(int d, const char *format, va_list ap); #endif +/* klogctl is in libc's klog.h, but we cheat and not #include that */ +int klogctl(int type, char *b, int len); +/* This is declared here rather than #including in order to avoid + * confusing the two versions of basename. See the dirname/basename man page + * for details. */ +char *dirname(char *path); +/* Include our own copy of struct sysinfo to avoid binary compatibility + * problems with Linux 2.4, which changed things. Grumble, grumble. */ +struct sysinfo { + long uptime; /* Seconds since boot */ + unsigned long loads[3]; /* 1, 5, and 15 minute load averages */ + unsigned long totalram; /* Total usable main memory size */ + unsigned long freeram; /* Available memory size */ + unsigned long sharedram; /* Amount of shared memory */ + unsigned long bufferram; /* Memory used by buffers */ + unsigned long totalswap; /* Total swap space size */ + unsigned long freeswap; /* swap space still available */ + unsigned short procs; /* Number of current processes */ + unsigned short pad; /* Padding needed for m68k */ + unsigned long totalhigh; /* Total high memory size */ + unsigned long freehigh; /* Available high memory size */ + unsigned int mem_unit; /* Memory unit size in bytes */ + char _f[20 - 2*sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */ +}; +int sysinfo(struct sysinfo* info); + -/* Tested to work correctly (IIRC :]) */ +/* Tested to work correctly with all int types (IIRC :]) */ #define MAXINT(T) (T)( \ ((T)-1) > 0 \ ? (T)-1 \ @@ -81,7 +114,7 @@ ) /* Large file support */ -/* Note that CONFIG_LFS forces bbox to be built with all common ops +/* Note that CONFIG_LFS=y forces bbox to be built with all common ops * (stat, lseek etc) mapped to "largefile" variants by libc. * Practically it means that open() automatically has O_LARGEFILE added * and all filesize/file_offset parameters and struct members are "large" @@ -165,7 +198,6 @@ #endif #endif - #if defined(__GLIBC__) /* glibc uses __errno_location() to get a ptr to errno */ /* We can just memorize it once - no multithreading in busybox :) */ @@ -174,33 +206,6 @@ extern int *const bb_errno; #define errno (*bb_errno) #endif -#if defined(__GLIBC__) && __GLIBC__ < 2 -int vdprintf(int d, const char *format, va_list ap); -#endif -// This is declared here rather than #including in order to avoid -// confusing the two versions of basename. See the dirname/basename man page -// for details. -char *dirname(char *path); -/* Include our own copy of struct sysinfo to avoid binary compatibility - * problems with Linux 2.4, which changed things. Grumble, grumble. */ -struct sysinfo { - long uptime; /* Seconds since boot */ - unsigned long loads[3]; /* 1, 5, and 15 minute load averages */ - unsigned long totalram; /* Total usable main memory size */ - unsigned long freeram; /* Available memory size */ - unsigned long sharedram; /* Amount of shared memory */ - unsigned long bufferram; /* Memory used by buffers */ - unsigned long totalswap; /* Total swap space size */ - unsigned long freeswap; /* swap space still available */ - unsigned short procs; /* Number of current processes */ - unsigned short pad; /* Padding needed for m68k */ - unsigned long totalhigh; /* Total high memory size */ - unsigned long freehigh; /* Available high memory size */ - unsigned int mem_unit; /* Memory unit size in bytes */ - char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */ -}; -int sysinfo(struct sysinfo* info); - unsigned long long monotonic_us(void); unsigned monotonic_sec(void); @@ -236,12 +241,19 @@ 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); +/* xxxx_strip version can modify its parameter: + * "/" -> "/" + * "abc" -> "abc" + * "abc/def" -> "def" + * "abc/def/" -> "def" !! + */ +extern char *bb_get_last_path_component_strip(char *path); +/* "abc/def/" -> "" and it never modifies 'path' */ +extern char *bb_get_last_path_component_nostrip(const char *path); int ndelay_on(int fd); int ndelay_off(int fd); +int close_on_exec_on(int fd); void xdup2(int, int); void xmove_fd(int, int); @@ -249,10 +261,12 @@ void xmove_fd(int, int); DIR *xopendir(const char *path); DIR *warn_opendir(const char *path); -char *xrealloc_getcwd_or_warn(char *cwd); +/* UNUSED: char *xmalloc_realpath(const char *path); */ +char *xmalloc_readlink(const char *path); char *xmalloc_readlink_or_warn(const char *path); -char *xmalloc_realpath(const char *path); +char *xrealloc_getcwd_or_warn(char *cwd); +char *xmalloc_follow_symlinks(const char *path); //TODO: signal(sid, f) is the same? then why? extern void sig_catch(int,void (*)(int)); @@ -278,6 +292,30 @@ void xpipe(int filedes[2]); off_t xlseek(int fd, off_t offset, int whence); off_t fdlength(int fd); +/* Useful for having small structure members/global variables */ +typedef int8_t socktype_t; +typedef int8_t family_t; +struct BUG_too_small { + char BUG_socktype_t_too_small[(0 + | SOCK_STREAM + | SOCK_DGRAM + | SOCK_RDM + | SOCK_SEQPACKET + | SOCK_RAW + ) <= 127 ? 1 : -1]; + char BUG_family_t_too_small[(0 + | AF_UNSPEC + | AF_INET + | AF_INET6 + | AF_UNIX + | AF_PACKET + | AF_NETLINK + /* | AF_DECnet */ + /* | AF_IPX */ + ) <= 127 ? 1 : -1]; +}; + + 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); @@ -317,8 +355,8 @@ enum { }; /* Create stream socket, and allocate suitable lsa. * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6)) - * af == AF_UNSPEC will result in trying to create IPv6, and - * if kernel doesn't support it, IPv4. + * af == AF_UNSPEC will result in trying to create IPv6 socket, + * and if kernel doesn't support it, IPv4. */ int xsocket_type(len_and_sockaddr **lsap, USE_FEATURE_IPV6(int af,) int sock_type); int xsocket_stream(len_and_sockaddr **lsap); @@ -384,11 +422,18 @@ ssize_t recv_from_to(int fd, void *buf, size_t len, int flags, struct sockaddr *from, struct sockaddr *to, socklen_t sa_size); - -extern char *xstrdup(const char *s); -extern char *xstrndup(const char *s, int n); -extern char *safe_strncpy(char *dst, const char *src, size_t size); -extern char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2))); +char *xstrdup(const char *s); +char *xstrndup(const char *s, int n); +char *safe_strncpy(char *dst, const char *src, size_t size); +/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc. + * But potentially slow, don't use in one-billion-times loops */ +int bb_putchar(int ch); +char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2))); +/* Prints unprintable chars ch as ^C or M-c to file + * (M-c is used only if ch is ORed with PRINTABLE_META), + * else it is printed as-is (except for ch = 0x9b) */ +enum { PRINTABLE_META = 0x100 }; +void fputc_printable(int ch, FILE *file); // gcc-4.1.1 still isn't good enough at optimizing it // (+200 bytes compared to macro) //static ALWAYS_INLINE @@ -427,9 +472,12 @@ extern void xwrite(int fd, const void *buf, size_t count); /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */ extern void xprint_and_close_file(FILE *file); -extern char *xmalloc_fgets(FILE *file); -/* Read up to (and including) TERMINATING_STRING: */ +/* Reads up to (and including) TERMINATING_STRING: */ extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string); +/* Chops off TERMINATING_STRING: from the end: */ +extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string); +/* Reads up to (and including) "\n" or NUL byte */ +extern char *xmalloc_fgets(FILE *file); /* Chops off '\n' from the end, unlike fgets: */ extern char *xmalloc_getline(FILE *file); extern char *bb_get_chunk_from_file(FILE *file, int *end); @@ -444,15 +492,23 @@ extern FILE *fopen_or_warn(const char *filename, const char *mode); /* "Opens" stdin if filename is special, else just opens file: */ extern FILE *fopen_or_warn_stdin(const char *filename); +/* Wrapper which restarts poll on EINTR or ENOMEM. + * On other errors complains [perror("poll")] and returns. + * Warning! May take (much) longer than timeout_ms to return! + * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */ +int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms); + /* Convert each alpha char in str to lower-case */ -extern char* str_tolower(char *str); +char* str_tolower(char *str); char *utoa(unsigned n); char *itoa(int n); /* Returns a pointer past the formatted number, does NOT null-terminate */ char *utoa_to_buf(unsigned n, char *buf, unsigned buflen); char *itoa_to_buf(int n, char *buf, unsigned buflen); -void smart_ulltoa5(unsigned long long ul, char buf[5]); +/* Intelligent formatters of bignums */ +void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale); +void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale); //TODO: provide pointer to buf (avoid statics)? const char *make_human_readable_str(unsigned long long size, unsigned long block_size, unsigned long display_unit); @@ -507,16 +563,18 @@ void clear_username_cache(void); enum { USERNAME_MAX_SIZE = 16 - sizeof(int) }; -struct bb_applet; int execable_file(const char *name); char *find_execable(const char *filename); int exists_execable(const char *filename); +/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff), + * but it may exec busybox and call applet instead of searching PATH. + */ #if ENABLE_FEATURE_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, \ + execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \ cmd, __VA_ARGS__) #else #define BB_EXECVP(prog,cmd) execvp(prog,cmd) @@ -534,9 +592,9 @@ pid_t xspawn(char **argv); * if (rc < 0) bb_perror_msg("%s", argv[0]); * if (rc > 0) bb_error_msg("exit code: %d", rc); */ +int safe_waitpid(int pid, int *wstat, int options); int wait4pid(int pid); -int wait_pid(int *wstat, int pid); -int wait_nohang(int *wstat); +int wait_any_nohang(int *wstat); #define wait_crashed(w) ((w) & 127) #define wait_exitcode(w) ((w) >> 8) #define wait_stopsig(w) ((w) >> 8) @@ -545,7 +603,7 @@ int wait_nohang(int *wstat); int spawn_and_wait(char **argv); struct nofork_save_area { jmp_buf die_jmp; - const struct bb_applet *current_applet; + const char *applet_name; int xfunc_error_retval; uint32_t option_mask32; int die_sleep; @@ -554,8 +612,8 @@ struct nofork_save_area { void save_nofork_data(struct nofork_save_area *save); void restore_nofork_data(struct nofork_save_area *save); /* Does NOT check that applet is NOFORK, just blindly runs it */ -int run_nofork_applet(const struct bb_applet *a, char **argv); -int run_nofork_applet_prime(struct nofork_save_area *old, const struct bb_applet *a, char **argv); +int run_nofork_applet(int applet_no, char **argv); +int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv); /* Helpers for daemonization. * @@ -602,6 +660,8 @@ enum { #endif void bb_daemonize_or_rexec(int flags, char **argv); void bb_sanitize_stdio(void); +/* Clear dangerous stuff, set PATH */ +void sanitize_env_for_suid(void); extern const char *opt_complementary; @@ -654,11 +714,13 @@ extern int die_sleep; extern int xfunc_error_retval; extern jmp_buf die_jmp; extern void xfunc_die(void) ATTRIBUTE_NORETURN; -extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE; +extern void bb_show_usage(void) ATTRIBUTE_NORETURN; extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))); extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))); extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))); +extern void bb_simple_perror_msg(const char *s); extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))); +extern void bb_simple_perror_msg_and_die(const char *s) __attribute__ ((noreturn)); extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))); extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))); extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN; @@ -666,18 +728,30 @@ extern void bb_perror_nomsg(void); extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))); extern void bb_verror_msg(const char *s, va_list p, const char *strerr); +/* We need to export XXX_main from libbusybox + * only if we build "individual" binaries + */ +#if ENABLE_FEATURE_INDIVIDUAL +#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE +#else +#define MAIN_EXTERNALLY_VISIBLE +#endif + /* applets which are useful from another applets */ int bb_cat(char** argv); -int bb_echo(char** argv); -int test_main(int argc, char** argv); -int kill_main(int argc, char **argv); +int echo_main(int argc, char** argv) MAIN_EXTERNALLY_VISIBLE; +int test_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; +int kill_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; #if ENABLE_ROUTE void bb_displayroutes(int noresolve, int netstatfmt); #endif -int chown_main(int argc, char **argv); +int chown_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; #if ENABLE_GUNZIP -int gunzip_main(int argc, char **argv); +int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; +#endif +#if ENABLE_BUNZIP2 +int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; #endif int bbunpack(char **argv, char* (*make_new_name)(char *filename), @@ -724,10 +798,10 @@ const struct hwtype *get_hwntype(int type); #ifndef BUILD_INDIVIDUAL -extern const struct bb_applet *find_applet_by_name(const char *name); +extern int find_applet_by_name(const char *name); /* Returns only if applet is not found. */ extern void run_applet_and_exit(const char *name, char **argv); -extern void run_current_applet_and_exit(char **argv) ATTRIBUTE_NORETURN; +extern void run_applet_no_and_exit(int a, char **argv) ATTRIBUTE_NORETURN; #endif extern int match_fstype(const struct mntent *mt, const char *fstypes); @@ -750,7 +824,6 @@ extern int set_loop(char **devname, const char *file, unsigned long long offset) //TODO: pass buf pointer or return allocated buf (avoid statics)? char *bb_askpass(int timeout, const char * prompt); int bb_ask_confirmation(void); -int klogctl(int type, char * b, int len); extern int bb_parse_mode(const char* s, mode_t* theMode); @@ -769,6 +842,7 @@ int bb_make_directory(char *path, long mode, int flags); int get_signum(const char *name); const char *get_signame(int number); +void print_signames(void); char *bb_simplify_path(const char *path); @@ -776,6 +850,7 @@ char *bb_simplify_path(const char *path); extern void bb_do_delay(int seconds); extern void change_identity(const struct passwd *pw); extern const char *change_identity_e2str(const struct passwd *pw); +extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) ATTRIBUTE_NORETURN; extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args); #if ENABLE_SELINUX extern void renew_current_security_context(void); @@ -783,18 +858,39 @@ 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); +extern void selinux_preserve_fcontext(int fdesc); +#else +#define selinux_preserve_fcontext(fdesc) ((void)0) #endif extern void selinux_or_die(void); extern int restricted_shell(const char *shell); + +/* setup_environment: + * if loginshell = 1: cd(pw->pw_dir), clear environment, then set + * TERM=(old value) + * USER=pw->pw_name, LOGNAME=pw->pw_name + * PATH=bb_default_[root_]path + * HOME=pw->pw_dir + * SHELL=shell + * else if changeenv = 1: + * if not root (if pw->pw_uid != 0): + * USER=pw->pw_name, LOGNAME=pw->pw_name + * HOME=pw->pw_dir + * SHELL=shell + * else does nothing + */ extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw); extern int correct_password(const struct passwd *pw); /* Returns a ptr to static storage */ extern char *pw_encrypt(const char *clear, const char *salt); extern int obscure(const char *old, const char *newval, const struct passwd *pwdp); -extern int index_in_str_array(const char *const string_array[], const char *key); -extern int index_in_strings(const char *strings, const char *key); -extern int index_in_substr_array(const char *const string_array[], const char *key); -extern int index_in_substrings(const char *strings, const char *key); + +int index_in_str_array(const char *const string_array[], const char *key); +int index_in_strings(const char *strings, const char *key); +int index_in_substr_array(const char *const string_array[], const char *key); +int index_in_substrings(const char *strings, const char *key); +const char *nth_string(const char *strings, int n); + extern void print_login_issue(const char *issue_file, const char *tty); extern void print_login_prompt(void); @@ -866,6 +962,12 @@ enum { FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION, }; line_input_t *new_line_input_t(int flags); +/* Returns: + * -1 on read errors or EOF, or on bare Ctrl-D. + * 0 on ctrl-C, + * >0 length of input string, including terminating '\n' + * [is this true? stores "" in 'command' if return value is 0 or -1] + */ 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); @@ -893,6 +995,7 @@ typedef struct procps_status_t { * it is memset(0) for each process in procps_scan() */ unsigned long vsz, rss; /* we round it to kbytes */ unsigned long stime, utime; + unsigned long start_time; unsigned pid; unsigned ppid; unsigned pgid; @@ -900,6 +1003,15 @@ typedef struct procps_status_t { unsigned uid; unsigned gid; unsigned tty_major,tty_minor; +#if ENABLE_FEATURE_TOPMEM + unsigned long mapped_rw; + unsigned long mapped_ro; + unsigned long shared_clean; + unsigned long shared_dirty; + unsigned long private_clean; + unsigned long private_dirty; + unsigned long stack; +#endif char state[4]; /* basename of executable in exec(2), read from /proc/N/stat * (if executable is symlink or script, it is NOT replaced @@ -923,12 +1035,15 @@ enum { PSSCAN_STIME = 1 << 12, PSSCAN_UTIME = 1 << 13, PSSCAN_TTY = 1 << 14, - USE_SELINUX(PSSCAN_CONTEXT = 1 << 15,) + PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM, + PSSCAN_ARGVN = (1 << 16) * (ENABLE_PGREP | ENABLE_PKILL), + USE_SELINUX(PSSCAN_CONTEXT = 1 << 17,) + PSSCAN_START_TIME = 1 << 18, /* These are all retrieved from proc/NN/stat in one go: */ PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID | PSSCAN_COMM | PSSCAN_STATE | PSSCAN_VSZ | PSSCAN_RSS - | PSSCAN_STIME | PSSCAN_UTIME + | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME | PSSCAN_TTY, }; procps_status_t* alloc_procps_scan(int flags); @@ -985,9 +1100,8 @@ enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */ }; #define FILEUTILS_CP_OPTSTR "pdRfils" USE_SELINUX("c") -extern const struct bb_applet *current_applet; extern const char *applet_name; -/* "BusyBox vN.N.N (timestamp or extra_vestion)" */ +/* "BusyBox vN.N.N (timestamp or extra_version)" */ extern const char bb_banner[]; extern const char bb_msg_memory_exhausted[]; extern const char bb_msg_invalid_date[]; @@ -1132,7 +1246,6 @@ extern const char bb_default_login_shell[]; #include #endif - #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) #endif /* __LIBBUSYBOX_H__ */