/* * Utility routines. * * Licensed under GPLv2, see file COPYING in this tarball for details. */ #ifndef ABRTLIB_H_ #define ABRTLIB_H_ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include /* sockaddr_in, sockaddr_in6 etc */ #include #include #include /* Try to pull in PATH_MAX */ #include #include #ifndef PATH_MAX # define PATH_MAX 256 #endif #include #include /* C++ bits */ #include #include "abrt_types.h" #include "xfuncs.h" /* Some libc's forget to declare these, do it ourself */ extern char **environ; #if defined(__GLIBC__) && __GLIBC__ < 2 int vdprintf(int d, const char *format, va_list ap); #endif #define NORETURN __attribute__ ((noreturn)) #undef ARRAY_SIZE #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0]))) /* Logging */ enum { LOGMODE_NONE = 0, LOGMODE_STDIO = (1 << 0), LOGMODE_SYSLOG = (1 << 1), LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO, LOGMODE_CUSTOM = (1 << 2), }; extern void (*g_custom_logger)(const char*); extern const char *msg_prefix; extern const char *msg_eol; extern int logmode; extern int xfunc_error_retval; void xfunc_die(void) NORETURN; void log_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))); /* It's a macro, not function, since it collides with log() from math.h */ #undef log #define log(...) log_msg(__VA_ARGS__) /* error_msg family will use g_custom_logger. log_msg does not. */ void error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))); void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))); /* Reports error message with libc's errno error description attached. */ void perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))); void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))); void perror_nomsg_and_die(void) NORETURN; void perror_nomsg(void); void verror_msg(const char *s, va_list p, const char *strerr); void die_out_of_memory(void) NORETURN; /* Verbosity level */ extern int g_verbose; /* VERB1 log("what you sometimes want to see, even on a production box") */ #define VERB1 if (g_verbose >= 1) /* VERB2 log("debug message, not going into insanely small details") */ #define VERB2 if (g_verbose >= 2) /* VERB3 log("lots and lots of details") */ #define VERB3 if (g_verbose >= 3) /* there is no level > 3 */ char* skip_whitespace(const char *s); char* skip_non_whitespace(const char *s); unsigned xatou(const char *numstr); int xatoi(const char *numstr); /* Using xatoi() instead of naive atoi() is not always convenient - * in many places people want *non-negative* values, but store them * in signed int. Therefore we need this one: * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */ int xatoi_u(const char *numstr); extern ssize_t safe_read(int fd, void *buf, size_t count); // NB: will return short read on error, not -1, // if some data was read before error occurred extern ssize_t full_read(int fd, void *buf, size_t count); extern void xread(int fd, void *buf, size_t count); extern ssize_t safe_write(int fd, const void *buf, size_t count); // NB: will return short write on error, not -1, // if some data was written before error occurred extern ssize_t full_write(int fd, const void *buf, size_t count); /* copyfd_XX print read/write errors and return -1 if they occur */ off_t copyfd_eof(int src_fd, int dst_fd); off_t copyfd_size(int src_fd, int dst_fd, off_t size); void copyfd_exact_size(int src_fd, int dst_fd, off_t size); off_t copy_file(const char *src_name, const char *dst_name, int mode); enum { EXECFLG_INPUT = 1 << 0, EXECFLG_OUTPUT = 1 << 1, EXECFLG_INPUT_NUL = 1 << 2, EXECFLG_OUTPUT_NUL = 1 << 3, EXECFLG_ERR2OUT = 1 << 4, EXECFLG_ERR_NUL = 1 << 5, EXECFLG_QUIET = 1 << 6, EXECFLG_SETGUID = 1 << 7, EXECFLG_SETSID = 1 << 8, }; /* Returns pid */ pid_t fork_execv_on_steroids(int flags, char **argv, int *pipefds, char **unsetenv_vec, const char *dir, uid_t uid); /* Returns malloc'ed string. NULs are retained, and extra one is appended * after the last byte (this NUL is not accounted for in *size_p) */ char *run_in_shell_and_save_output(int flags, const char *cmd, const char *dir, size_t *size_p); unsigned long long monotonic_ns(void); unsigned long long monotonic_us(void); unsigned monotonic_sec(void); /* networking helpers */ typedef struct len_and_sockaddr { socklen_t len; union { struct sockaddr sa; struct sockaddr_in sin; struct sockaddr_in6 sin6; } u; } len_and_sockaddr; enum { LSA_LEN_SIZE = offsetof(len_and_sockaddr, u), LSA_SIZEOF_SA = sizeof(struct sockaddr) > sizeof(struct sockaddr_in6) ? sizeof(struct sockaddr) : sizeof(struct sockaddr_in6), }; void setsockopt_reuseaddr(int fd); int setsockopt_broadcast(int fd); int setsockopt_bindtodevice(int fd, const char *iface); len_and_sockaddr* get_sock_lsa(int fd); void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen); unsigned lookup_port(const char *port, const char *protocol, unsigned default_port); int get_nport(const struct sockaddr *sa); void set_nport(len_and_sockaddr *lsa, unsigned port); 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); len_and_sockaddr* host2sockaddr(const char *host, int port); len_and_sockaddr* xhost2sockaddr(const char *host, int port); len_and_sockaddr* xdotted2sockaddr(const char *host, int port); int xsocket_type(len_and_sockaddr **lsap, int family, int sock_type); int xsocket_stream(len_and_sockaddr **lsap); int create_and_bind_stream_or_die(const char *bindaddr, int port); int create_and_bind_dgram_or_die(const char *bindaddr, int port); int create_and_connect_stream_or_die(const char *peer, int port); int xconnect_stream(const len_and_sockaddr *lsa); char* xmalloc_sockaddr2host(const struct sockaddr *sa); char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa); char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa); char* xmalloc_sockaddr2dotted(const struct sockaddr *sa); char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa); /* Random utility functions */ /* Returns command line of running program. * Caller is responsible to free() the returned value. * If the pid is not valid or command line can not be obtained, * empty string is returned. */ char* get_cmdline(pid_t pid); /* Returns 1 if abrtd daemon is running, 0 otherwise. */ int daemon_is_ok(); /* Returns malloc'ed block */ char *encode_base64(const void *src, int length); /* C++ style stuff */ double get_dirsize(const char *pPath); double get_dirsize_find_largest_dir( const char *pPath, std::string *worst_dir = NULL, const char *excluded = NULL); std::string unsigned_to_string(unsigned long long x); std::string signed_to_string(long long x); template inline std::string to_string(T x) { if ((T)~(T)0 < (T)0) /* T is a signed type */ return signed_to_string(x); return unsigned_to_string(x); } void parse_args(const char *psArgs, vector_string_t& pArgs, int quote = -1); void parse_release(const char *pRelease, std::string& pProduct, std::string& pVersion); #endif