X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=src%2Fcommon%2Futils.c;h=4ccf36a6c781bc09bbcb6a1108af8354d275e9b6;hb=a2e78ff0442a6a4c290577ff2ecf3c4307c3e9f5;hp=1c2b95d3e7d5d3e427bc4c20f59ba4483062dea9;hpb=be96a7d15e24cd8742c404cf3a76d14c75b00f06;p=lttng-tools.git diff --git a/src/common/utils.c b/src/common/utils.c index 1c2b95d3e..4ccf36a6c 100644 --- a/src/common/utils.c +++ b/src/common/utils.c @@ -22,15 +22,86 @@ #include #include #include -#include #include +#include #include #include +#include +#include #include #include #include "utils.h" +#include "defaults.h" + +/* + * Resolve the './' and '../' strings in the middle of a path using + * our very own way to do it, so that it works even if the directory + * does not exist + */ +LTTNG_HIDDEN +char *utils_resolve_relative(const char *path) +{ + char *next, *previous, *slash, *start_path, *absolute_path = NULL; + + /* Safety net */ + if (path == NULL) { + goto error; + } + + /* Allocate memory for the absolute path */ + absolute_path = zmalloc(PATH_MAX); + if (absolute_path == NULL) { + PERROR("zmalloc expand path"); + goto error; + } + + /* Copy the path in the absolute path */ + strncpy(absolute_path, path, PATH_MAX); + + /* As long as we find '/./' in the path string */ + while ((next = strstr(absolute_path, "/./"))) { + + /* We prepare the start_path not containing it */ + start_path = strndup(absolute_path, next - absolute_path); + + /* And we concatenate it with the part after this string */ + snprintf(absolute_path, PATH_MAX, "%s%s", start_path, next + 2); + + free(start_path); + } + + /* As long as we find '/../' in the path string */ + while ((next = strstr(absolute_path, "/../"))) { + /* If the path starts with '/../', there's a problem */ + if (next == absolute_path) { + ERR("%s: Path cannot be resolved", path); + goto error; + } + + /* We find the last level of directory */ + previous = absolute_path; + while ((slash = strpbrk(previous + 1, "/")) && slash != next) { + previous = slash; + } + + /* Then we prepare the start_path not containing it */ + start_path = strndup(absolute_path, previous - absolute_path); + + /* And we concatenate it with the part after the '/../' */ + snprintf(absolute_path, PATH_MAX, "%s%s", start_path, next + 3); + + free(start_path); + } + + return absolute_path; + +error: + free(absolute_path); + return NULL; +} + /* * Return the realpath(3) of the path even if the last directory token does not @@ -140,6 +211,48 @@ error: return ret; } +/* + * Create pipe and set fd flags to FD_CLOEXEC and O_NONBLOCK. + * + * Make sure the pipe opened by this function are closed at some point. Use + * utils_close_pipe(). Using pipe() and fcntl rather than pipe2() to + * support OSes other than Linux 2.6.23+. + */ +LTTNG_HIDDEN +int utils_create_pipe_cloexec_nonblock(int *dst) +{ + int ret, i; + + if (dst == NULL) { + return -1; + } + + ret = utils_create_pipe(dst); + if (ret < 0) { + goto error; + } + + for (i = 0; i < 2; i++) { + ret = fcntl(dst[i], F_SETFD, FD_CLOEXEC); + if (ret < 0) { + PERROR("fcntl pipe cloexec"); + goto error; + } + /* + * Note: we override any flag that could have been + * previously set on the fd. + */ + ret = fcntl(dst[i], F_SETFL, O_NONBLOCK); + if (ret < 0) { + PERROR("fcntl pipe nonblock"); + goto error; + } + } + +error: + return ret; +} + /* * Close both read and write side of the pipe. */ @@ -247,7 +360,6 @@ LTTNG_HIDDEN int utils_mkdir_recursive(const char *path, mode_t mode) { char *p, tmp[PATH_MAX]; - struct stat statbuf; size_t len; int ret; @@ -275,15 +387,12 @@ int utils_mkdir_recursive(const char *path, mode_t mode) ret = -1; goto error; } - ret = stat(tmp, &statbuf); + ret = mkdir(tmp, mode); if (ret < 0) { - ret = mkdir(tmp, mode); - if (ret < 0) { - if (errno != EEXIST) { - PERROR("mkdir recursive"); - ret = -errno; - goto error; - } + if (errno != EEXIST) { + PERROR("mkdir recursive"); + ret = -errno; + goto error; } } *p = '/'; @@ -310,11 +419,12 @@ error: * Return 0 on success or else a negative value. */ LTTNG_HIDDEN -int utils_create_stream_file(char *path_name, char *file_name, uint64_t size, - uint64_t count, int uid, int gid) +int utils_create_stream_file(const char *path_name, char *file_name, uint64_t size, + uint64_t count, int uid, int gid, char *suffix) { int ret, out_fd, flags, mode; - char full_path[PATH_MAX], *path_name_id = NULL, *path; + char full_path[PATH_MAX], *path_name_suffix = NULL, *path; + char *extra = NULL; assert(path_name); assert(file_name); @@ -326,17 +436,30 @@ int utils_create_stream_file(char *path_name, char *file_name, uint64_t size, goto error; } + /* Setup extra string if suffix or/and a count is needed. */ + if (size > 0 && suffix) { + ret = asprintf(&extra, "_%" PRIu64 "%s", count, suffix); + } else if (size > 0) { + ret = asprintf(&extra, "_%" PRIu64, count); + } else if (suffix) { + ret = asprintf(&extra, "%s", suffix); + } + if (ret < 0) { + PERROR("Allocating extra string to name"); + goto error; + } + /* * If we split the trace in multiple files, we have to add the count at the * end of the tracefile name */ - if (size > 0) { - ret = asprintf(&path_name_id, "%s_%" PRIu64, full_path, count); + if (extra) { + ret = asprintf(&path_name_suffix, "%s%s", full_path, extra); if (ret < 0) { - PERROR("Allocating path name ID"); - goto error; + PERROR("Allocating path name with extra string"); + goto error_free_suffix; } - path = path_name_id; + path = path_name_suffix; } else { path = full_path; } @@ -357,7 +480,9 @@ int utils_create_stream_file(char *path_name, char *file_name, uint64_t size, ret = out_fd; error_open: - free(path_name_id); + free(path_name_suffix); +error_free_suffix: + free(extra); error: return ret; } @@ -373,10 +498,14 @@ error: */ LTTNG_HIDDEN int utils_rotate_stream_file(char *path_name, char *file_name, uint64_t size, - uint64_t count, int uid, int gid, int out_fd, uint64_t *new_count) + uint64_t count, int uid, int gid, int out_fd, uint64_t *new_count, + int *stream_fd) { int ret; + assert(new_count); + assert(stream_fd); + ret = close(out_fd); if (ret < 0) { PERROR("Closing tracefile"); @@ -389,8 +518,269 @@ int utils_rotate_stream_file(char *path_name, char *file_name, uint64_t size, (*new_count)++; } - return utils_create_stream_file(path_name, file_name, size, *new_count, - uid, gid); + ret = utils_create_stream_file(path_name, file_name, size, *new_count, + uid, gid, 0); + if (ret < 0) { + goto error; + } + *stream_fd = ret; + + /* Success. */ + ret = 0; + error: return ret; } + +/** + * Prints the error message corresponding to a regex error code. + * + * @param errcode The error code. + * @param regex The regex object that produced the error code. + */ +static void regex_print_error(int errcode, regex_t *regex) +{ + /* Get length of error message and allocate accordingly */ + size_t length; + char *buffer; + + assert(regex != NULL); + + length = regerror(errcode, regex, NULL, 0); + if (length == 0) { + ERR("regerror returned a length of 0"); + return; + } + + buffer = zmalloc(length); + if (!buffer) { + ERR("regex_print_error: zmalloc failed"); + return; + } + + /* Get and print error message */ + regerror(errcode, regex, buffer, length); + ERR("regex error: %s\n", buffer); + free(buffer); + +} + +/** + * Parse a string that represents a size in human readable format. It + * supports decimal integers suffixed by 'k', 'M' or 'G'. + * + * The suffix multiply the integer by: + * 'k': 1024 + * 'M': 1024^2 + * 'G': 1024^3 + * + * @param str The string to parse. + * @param size Pointer to a size_t that will be filled with the + * resulting size. + * + * @return 0 on success, -1 on failure. + */ +LTTNG_HIDDEN +int utils_parse_size_suffix(char *str, uint64_t *size) +{ + regex_t regex; + int ret; + const int nmatch = 3; + regmatch_t suffix_match, matches[nmatch]; + unsigned long long base_size; + long shift = 0; + + if (!str) { + return 0; + } + + /* Compile regex */ + ret = regcomp(®ex, "^\\(0x\\)\\{0,1\\}[0-9][0-9]*\\([kKMG]\\{0,1\\}\\)$", 0); + if (ret != 0) { + regex_print_error(ret, ®ex); + ret = -1; + goto end; + } + + /* Match regex */ + ret = regexec(®ex, str, nmatch, matches, 0); + if (ret != 0) { + ret = -1; + goto free; + } + + /* There is a match ! */ + errno = 0; + base_size = strtoull(str, NULL, 0); + if (errno != 0) { + PERROR("strtoull"); + ret = -1; + goto free; + } + + /* Check if there is a suffix */ + suffix_match = matches[2]; + if (suffix_match.rm_eo - suffix_match.rm_so == 1) { + switch (*(str + suffix_match.rm_so)) { + case 'K': + case 'k': + shift = KIBI_LOG2; + break; + case 'M': + shift = MEBI_LOG2; + break; + case 'G': + shift = GIBI_LOG2; + break; + default: + ERR("parse_human_size: invalid suffix"); + ret = -1; + goto free; + } + } + + *size = base_size << shift; + + /* Check for overflow */ + if ((*size >> shift) != base_size) { + ERR("parse_size_suffix: oops, overflow detected."); + ret = -1; + goto free; + } + + ret = 0; + +free: + regfree(®ex); +end: + return ret; +} + +/* + * fls: returns the position of the most significant bit. + * Returns 0 if no bit is set, else returns the position of the most + * significant bit (from 1 to 32 on 32-bit, from 1 to 64 on 64-bit). + */ +#if defined(__i386) || defined(__x86_64) +static inline unsigned int fls_u32(uint32_t x) +{ + int r; + + asm("bsrl %1,%0\n\t" + "jnz 1f\n\t" + "movl $-1,%0\n\t" + "1:\n\t" + : "=r" (r) : "rm" (x)); + return r + 1; +} +#define HAS_FLS_U32 +#endif + +#ifndef HAS_FLS_U32 +static __attribute__((unused)) unsigned int fls_u32(uint32_t x) +{ + unsigned int r = 32; + + if (!x) { + return 0; + } + if (!(x & 0xFFFF0000U)) { + x <<= 16; + r -= 16; + } + if (!(x & 0xFF000000U)) { + x <<= 8; + r -= 8; + } + if (!(x & 0xF0000000U)) { + x <<= 4; + r -= 4; + } + if (!(x & 0xC0000000U)) { + x <<= 2; + r -= 2; + } + if (!(x & 0x80000000U)) { + x <<= 1; + r -= 1; + } + return r; +} +#endif + +/* + * Return the minimum order for which x <= (1UL << order). + * Return -1 if x is 0. + */ +LTTNG_HIDDEN +int utils_get_count_order_u32(uint32_t x) +{ + if (!x) { + return -1; + } + + return fls_u32(x - 1); +} + +/** + * Obtain the value of LTTNG_HOME environment variable, if exists. + * Otherwise returns the value of HOME. + */ +LTTNG_HIDDEN +char *utils_get_home_dir(void) +{ + char *val = NULL; + val = getenv(DEFAULT_LTTNG_HOME_ENV_VAR); + if (val != NULL) { + return val; + } + return getenv(DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR); +} + +/* + * With the given format, fill dst with the time of len maximum siz. + * + * Return amount of bytes set in the buffer or else 0 on error. + */ +LTTNG_HIDDEN +size_t utils_get_current_time_str(const char *format, char *dst, size_t len) +{ + size_t ret; + time_t rawtime; + struct tm *timeinfo; + + assert(format); + assert(dst); + + /* Get date and time for session path */ + time(&rawtime); + timeinfo = localtime(&rawtime); + ret = strftime(dst, len, format, timeinfo); + if (ret == 0) { + ERR("Unable to strftime with format %s at dst %p of len %lu", format, + dst, len); + } + + return ret; +} + +/* + * Return the group ID matching name, else 0 if it cannot be found. + */ +LTTNG_HIDDEN +gid_t utils_get_group_id(const char *name) +{ + struct group *grp; + + grp = getgrnam(name); + if (!grp) { + static volatile int warn_once; + + if (!warn_once) { + WARN("No tracing group detected"); + warn_once = 1; + } + return 0; + } + return grp->gr_gid; +}