X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Futils.c;h=9fcceab1f3149c2c5e17a3e68d4ee1b60fc4932c;hp=d28e31349df3cd3bf383e8d366c119db52305c57;hb=c14cc49149d98338f8fcd42c360b937f5ddb3990;hpb=3d229795de7f38cce87d6d5ea76ef413dbb71f1d diff --git a/src/common/utils.c b/src/common/utils.c index d28e31349..9fcceab1f 100644 --- a/src/common/utils.c +++ b/src/common/utils.c @@ -1,5 +1,7 @@ /* * Copyright (C) 2012 - David Goulet + * Copyright (C) 2013 - Raphaël Beamonte + * Copyright (C) 2013 - Jérémie Galarneau * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License, version 2 only, as @@ -16,6 +18,7 @@ */ #define _GNU_SOURCE +#define _LGPL_SOURCE #include #include #include @@ -26,11 +29,14 @@ #include #include #include -#include #include +#include +#include +#include #include #include +#include #include "utils.h" #include "defaults.h" @@ -49,7 +55,7 @@ LTTNG_HIDDEN char *utils_partial_realpath(const char *path, char *resolved_path, size_t size) { - char *cut_path, *try_path = NULL, *try_path_prev = NULL; + char *cut_path = NULL, *try_path = NULL, *try_path_prev = NULL; const char *next, *prev, *end; /* Safety net */ @@ -87,6 +93,10 @@ char *utils_partial_realpath(const char *path, char *resolved_path, size_t size) /* Cut the part we will be trying to resolve */ cut_path = strndup(path, next - path); + if (cut_path == NULL) { + PERROR("strndup"); + goto error; + } /* Try to resolve this part */ try_path = realpath((char *)cut_path, NULL); @@ -114,6 +124,7 @@ char *utils_partial_realpath(const char *path, char *resolved_path, size_t size) /* Free the allocated memory */ free(cut_path); + cut_path = NULL; }; /* Allocate memory for the resolved path if necessary */ @@ -140,6 +151,10 @@ char *utils_partial_realpath(const char *path, char *resolved_path, size_t size) * path are pointers for the same memory space */ cut_path = strdup(prev); + if (cut_path == NULL) { + PERROR("strdup"); + goto error; + } /* Concatenate the strings */ snprintf(resolved_path, size, "%s%s", try_path_prev, cut_path); @@ -160,73 +175,7 @@ char *utils_partial_realpath(const char *path, char *resolved_path, size_t size) error: free(resolved_path); - return NULL; -} - -/* - * 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); + free(cut_path); return NULL; } @@ -244,6 +193,8 @@ LTTNG_HIDDEN char *utils_expand_path(const char *path) { char *next, *previous, *slash, *start_path, *absolute_path = NULL; + char *last_token; + int is_dot, is_dotdot; /* Safety net */ if (path == NULL) { @@ -264,7 +215,7 @@ char *utils_expand_path(const char *path) if (*path != '/' && strncmp(path, "./", 2) != 0 && strncmp(path, "../", 3) != 0) { snprintf(absolute_path, PATH_MAX, "./%s", path); - /* Else, we just copy the path */ + /* Else, we just copy the path */ } else { strncpy(absolute_path, path, PATH_MAX); } @@ -278,7 +229,10 @@ char *utils_expand_path(const char *path) /* We prepare the start_path not containing it */ start_path = strndup(absolute_path, next - absolute_path); - + if (!start_path) { + PERROR("strndup"); + goto error; + } /* And we concatenate it with the part after this string */ snprintf(absolute_path, PATH_MAX, "%s%s", start_path, next + 2); @@ -295,6 +249,10 @@ char *utils_expand_path(const char *path) /* Then we prepare the start_path not containing it */ start_path = strndup(absolute_path, previous - absolute_path); + if (!start_path) { + PERROR("strndup"); + goto error; + } /* And we concatenate it with the part after the '/../' */ snprintf(absolute_path, PATH_MAX, "%s%s", start_path, next + 4); @@ -307,6 +265,31 @@ char *utils_expand_path(const char *path) absolute_path, PATH_MAX); } + /* Identify the last token */ + last_token = strrchr(absolute_path, '/'); + + /* Verify that this token is not a relative path */ + is_dotdot = (strcmp(last_token, "/..") == 0); + is_dot = (strcmp(last_token, "/.") == 0); + + /* If it is, take action */ + if (is_dot || is_dotdot) { + /* For both, remove this token */ + *last_token = '\0'; + + /* If it was a reference to parent directory, go back one more time */ + if (is_dotdot) { + last_token = strrchr(absolute_path, '/'); + + /* If there was only one level left, we keep the first '/' */ + if (last_token == absolute_path) { + last_token++; + } + + *last_token = '\0'; + } + } + return absolute_path; error: @@ -498,21 +481,95 @@ int utils_create_pid_file(pid_t pid, const char *filepath) ret = fprintf(fp, "%d\n", pid); if (ret < 0) { PERROR("fprintf pid file"); + goto error; } - fclose(fp); + if (fclose(fp)) { + PERROR("fclose"); + } DBG("Pid %d written in file %s", pid, filepath); + ret = 0; error: return ret; } /* - * Recursively create directory using the given path and mode. + * Create lock file to the given path and filename. + * Returns the associated file descriptor, -1 on error. + */ +LTTNG_HIDDEN +int utils_create_lock_file(const char *filepath) +{ + int ret; + int fd; + + assert(filepath); + + fd = open(filepath, O_CREAT, + O_WRONLY | S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP); + if (fd < 0) { + PERROR("open lock file %s", filepath); + ret = -1; + goto error; + } + + /* + * Attempt to lock the file. If this fails, there is + * already a process using the same lock file running + * and we should exit. + */ + ret = flock(fd, LOCK_EX | LOCK_NB); + if (ret) { + ERR("Could not get lock file %s, another instance is running.", + filepath); + if (close(fd)) { + PERROR("close lock file"); + } + fd = ret; + goto error; + } + +error: + return fd; +} + +/* + * Create directory using the given path and mode. * * On success, return 0 else a negative error code. */ LTTNG_HIDDEN -int utils_mkdir_recursive(const char *path, mode_t mode) +int utils_mkdir(const char *path, mode_t mode, int uid, int gid) +{ + int ret; + + if (uid < 0 || gid < 0) { + ret = mkdir(path, mode); + } else { + ret = run_as_mkdir(path, mode, uid, gid); + } + if (ret < 0) { + if (errno != EEXIST) { + PERROR("mkdir %s, uid %d, gid %d", path ? path : "NULL", + uid, gid); + } else { + ret = 0; + } + } + + return ret; +} + +/* + * Internal version of mkdir_recursive. Runs as the current user. + * Don't call directly; use utils_mkdir_recursive(). + * + * This function is ominously marked as "unsafe" since it should only + * be called by a caller that has transitioned to the uid and gid under which + * the directory creation should occur. + */ +LTTNG_HIDDEN +int _utils_mkdir_recursive_unsafe(const char *path, mode_t mode) { char *p, tmp[PATH_MAX]; size_t len; @@ -557,7 +614,7 @@ int utils_mkdir_recursive(const char *path, mode_t mode) ret = mkdir(tmp, mode); if (ret < 0) { if (errno != EEXIST) { - PERROR("mkdir recursive last piece"); + PERROR("mkdir recursive last element"); ret = -errno; } else { ret = 0; @@ -569,20 +626,44 @@ error: } /* - * Create the stream tracefile on disk. + * Recursively create directory using the given path and mode, under the + * provided uid and gid. * - * Return 0 on success or else a negative value. + * On success, return 0 else a negative error code. */ LTTNG_HIDDEN -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 utils_mkdir_recursive(const char *path, mode_t mode, int uid, int gid) { - int ret, out_fd, flags, mode; - char full_path[PATH_MAX], *path_name_suffix = NULL, *path; - char *extra = NULL; + int ret; + + if (uid < 0 || gid < 0) { + /* Run as current user. */ + ret = _utils_mkdir_recursive_unsafe(path, mode); + } else { + ret = run_as_mkdir_recursive(path, mode, uid, gid); + } + if (ret < 0) { + PERROR("mkdir %s, uid %d, gid %d", path ? path : "NULL", + uid, gid); + } - assert(path_name); - assert(file_name); + return ret; +} + +/* + * path is the output parameter. It needs to be PATH_MAX len. + * + * Return 0 on success or else a negative value. + */ +static int utils_stream_file_name(char *path, + const char *path_name, const char *file_name, + uint64_t size, uint64_t count, + const char *suffix) +{ + int ret; + char full_path[PATH_MAX]; + char *path_name_suffix = NULL; + char *extra = NULL; ret = snprintf(full_path, sizeof(full_path), "%s/%s", path_name, file_name); @@ -605,8 +686,8 @@ int utils_create_stream_file(const char *path_name, char *file_name, uint64_t si } /* - * If we split the trace in multiple files, we have to add the count at the - * end of the tracefile name + * If we split the trace in multiple files, we have to add the count at + * the end of the tracefile name. */ if (extra) { ret = asprintf(&path_name_suffix, "%s%s", full_path, extra); @@ -614,9 +695,37 @@ int utils_create_stream_file(const char *path_name, char *file_name, uint64_t si PERROR("Allocating path name with extra string"); goto error_free_suffix; } - path = path_name_suffix; + strncpy(path, path_name_suffix, PATH_MAX - 1); + path[PATH_MAX - 1] = '\0'; } else { - path = full_path; + strncpy(path, full_path, PATH_MAX - 1); + } + path[PATH_MAX - 1] = '\0'; + ret = 0; + + free(path_name_suffix); +error_free_suffix: + free(extra); +error: + return ret; +} + +/* + * Create the stream file on disk. + * + * Return 0 on success or else a negative value. + */ +LTTNG_HIDDEN +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, flags, mode; + char path[PATH_MAX]; + + ret = utils_stream_file_name(path, path_name, file_name, + size, count, suffix); + if (ret < 0) { + goto error; } flags = O_WRONLY | O_CREAT | O_TRUNC; @@ -624,21 +733,44 @@ int utils_create_stream_file(const char *path_name, char *file_name, uint64_t si mode = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP; if (uid < 0 || gid < 0) { - out_fd = open(path, flags, mode); + ret = open(path, flags, mode); } else { - out_fd = run_as_open(path, flags, mode, uid, gid); + ret = run_as_open(path, flags, mode, uid, gid); } - if (out_fd < 0) { + if (ret < 0) { PERROR("open stream path %s", path); - goto error_open; } - ret = out_fd; +error: + return ret; +} -error_open: - free(path_name_suffix); -error_free_suffix: - free(extra); +/* + * Unlink the stream tracefile from disk. + * + * Return 0 on success or else a negative value. + */ +LTTNG_HIDDEN +int utils_unlink_stream_file(const char *path_name, char *file_name, uint64_t size, + uint64_t count, int uid, int gid, char *suffix) +{ + int ret; + char path[PATH_MAX]; + + ret = utils_stream_file_name(path, path_name, file_name, + size, count, suffix); + if (ret < 0) { + goto error; + } + if (uid < 0 || gid < 0) { + ret = unlink(path); + } else { + ret = run_as_unlink(path, uid, gid); + } + if (ret < 0) { + goto error; + } error: + DBG("utils_unlink_stream_file %s returns %d", path, ret); return ret; } @@ -668,7 +800,25 @@ int utils_rotate_stream_file(char *path_name, char *file_name, uint64_t size, } if (count > 0) { + /* + * In tracefile rotation, for the relay daemon we need + * to unlink the old file if present, because it may + * still be open in reading by the live thread, and we + * need to ensure that we do not overwrite the content + * between get_index and get_packet. Since we have no + * way to verify integrity of the data content compared + * to the associated index, we need to ensure the reader + * has exclusive access to the file content, and that + * the open of the data file is performed in get_index. + * Unlinking the old file rather than overwriting it + * achieves this. + */ *new_count = (*new_count + 1) % count; + ret = utils_unlink_stream_file(path_name, file_name, + size, *new_count, uid, gid, 0); + if (ret < 0 && errno != ENOENT) { + goto error; + } } else { (*new_count)++; } @@ -687,42 +837,10 @@ 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'. + * supports decimal integers suffixed by 'k', 'K', 'M' or 'G'. * * The suffix multiply the integer by: * 'k': 1024 @@ -730,83 +848,90 @@ static void regex_print_error(int errcode, regex_t *regex) * 'G': 1024^3 * * @param str The string to parse. - * @param size Pointer to a size_t that will be filled with the + * @param size Pointer to a uint64_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) +int utils_parse_size_suffix(const char * const str, uint64_t * const size) { - regex_t regex; int ret; - const int nmatch = 3; - regmatch_t suffix_match, matches[nmatch]; - unsigned long long base_size; + uint64_t base_size; long shift = 0; + const char *str_end; + char *num_end; 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); + DBG("utils_parse_size_suffix: received a NULL string."); ret = -1; goto end; } - /* Match regex */ - ret = regexec(®ex, str, nmatch, matches, 0); - if (ret != 0) { + /* strtoull will accept a negative number, but we don't want to. */ + if (strchr(str, '-') != NULL) { + DBG("utils_parse_size_suffix: invalid size string, should not contain '-'."); ret = -1; - goto free; + goto end; } - /* There is a match ! */ + /* str_end will point to the \0 */ + str_end = str + strlen(str); errno = 0; - base_size = strtoull(str, NULL, 0); + base_size = strtoull(str, &num_end, 0); if (errno != 0) { - PERROR("strtoull"); + PERROR("utils_parse_size_suffix strtoull"); ret = -1; - goto free; + goto end; } - /* 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; - } + if (num_end == str) { + /* strtoull parsed nothing, not good. */ + DBG("utils_parse_size_suffix: strtoull had nothing good to parse."); + ret = -1; + goto end; + } + + /* Check if a prefix is present. */ + switch (*num_end) { + case 'G': + shift = GIBI_LOG2; + num_end++; + break; + case 'M': /* */ + shift = MEBI_LOG2; + num_end++; + break; + case 'K': + case 'k': + shift = KIBI_LOG2; + num_end++; + break; + case '\0': + break; + default: + DBG("utils_parse_size_suffix: invalid suffix."); + ret = -1; + goto end; + } + + /* Check for garbage after the valid input. */ + if (num_end != str_end) { + DBG("utils_parse_size_suffix: Garbage after size string."); + ret = -1; + goto end; } *size = base_size << shift; /* Check for overflow */ if ((*size >> shift) != base_size) { - ERR("parse_size_suffix: oops, overflow detected."); + DBG("utils_parse_size_suffix: oops, overflow detected."); ret = -1; - goto free; + goto end; } ret = 0; - -free: - regfree(®ex); end: return ret; } @@ -885,11 +1010,88 @@ LTTNG_HIDDEN char *utils_get_home_dir(void) { char *val = NULL; - val = getenv(DEFAULT_LTTNG_HOME_ENV_VAR); + struct passwd *pwd; + + val = lttng_secure_getenv(DEFAULT_LTTNG_HOME_ENV_VAR); if (val != NULL) { - return val; + goto end; + } + val = lttng_secure_getenv(DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR); + if (val != NULL) { + goto end; + } + + /* Fallback on the password file entry. */ + pwd = getpwuid(getuid()); + if (!pwd) { + goto end; + } + val = pwd->pw_dir; + + DBG3("Home directory is '%s'", val); + +end: + return val; +} + +/** + * Get user's home directory. Dynamically allocated, must be freed + * by the caller. + */ +LTTNG_HIDDEN +char *utils_get_user_home_dir(uid_t uid) +{ + struct passwd pwd; + struct passwd *result; + char *home_dir = NULL; + char *buf = NULL; + long buflen; + int ret; + + buflen = sysconf(_SC_GETPW_R_SIZE_MAX); + if (buflen == -1) { + goto end; + } +retry: + buf = zmalloc(buflen); + if (!buf) { + goto end; + } + + ret = getpwuid_r(uid, &pwd, buf, buflen, &result); + if (ret || !result) { + if (ret == ERANGE) { + free(buf); + buflen *= 2; + goto retry; + } + goto end; } - return getenv(DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR); + + home_dir = strdup(pwd.pw_dir); +end: + free(buf); + return home_dir; +} + +/* + * Obtain the value of LTTNG_KMOD_PROBES environment variable, if exists. + * Otherwise returns NULL. + */ +LTTNG_HIDDEN +char *utils_get_kmod_probes_list(void) +{ + return lttng_secure_getenv(DEFAULT_LTTNG_KMOD_PROBES); +} + +/* + * Obtain the value of LTTNG_EXTRA_KMOD_PROBES environment variable, if + * exists. Otherwise returns NULL. + */ +LTTNG_HIDDEN +char *utils_get_extra_kmod_probes_list(void) +{ + return lttng_secure_getenv(DEFAULT_LTTNG_EXTRA_KMOD_PROBES); } /* @@ -912,7 +1114,7 @@ size_t utils_get_current_time_str(const char *format, char *dst, size_t len) 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, + ERR("Unable to strftime with format %s at dst %p of len %zu", format, dst, len); } @@ -939,3 +1141,111 @@ gid_t utils_get_group_id(const char *name) } return grp->gr_gid; } + +/* + * Return a newly allocated option string. This string is to be used as the + * optstring argument of getopt_long(), see GETOPT(3). opt_count is the number + * of elements in the long_options array. Returns NULL if the string's + * allocation fails. + */ +LTTNG_HIDDEN +char *utils_generate_optstring(const struct option *long_options, + size_t opt_count) +{ + int i; + size_t string_len = opt_count, str_pos = 0; + char *optstring; + + /* + * Compute the necessary string length. One letter per option, two when an + * argument is necessary, and a trailing NULL. + */ + for (i = 0; i < opt_count; i++) { + string_len += long_options[i].has_arg ? 1 : 0; + } + + optstring = zmalloc(string_len); + if (!optstring) { + goto end; + } + + for (i = 0; i < opt_count; i++) { + if (!long_options[i].name) { + /* Got to the trailing NULL element */ + break; + } + + if (long_options[i].val != '\0') { + optstring[str_pos++] = (char) long_options[i].val; + if (long_options[i].has_arg) { + optstring[str_pos++] = ':'; + } + } + } + +end: + return optstring; +} + +/* + * Try to remove a hierarchy of empty directories, recursively. Don't unlink + * any file. Try to rmdir any empty directory within the hierarchy. + */ +LTTNG_HIDDEN +int utils_recursive_rmdir(const char *path) +{ + DIR *dir; + int dir_fd, ret = 0, closeret, is_empty = 1; + struct dirent *entry; + + /* Open directory */ + dir = opendir(path); + if (!dir) { + PERROR("Cannot open '%s' path", path); + return -1; + } + dir_fd = dirfd(dir); + if (dir_fd < 0) { + PERROR("dirfd"); + return -1; + } + + while ((entry = readdir(dir))) { + if (!strcmp(entry->d_name, ".") + || !strcmp(entry->d_name, "..")) + continue; + switch (entry->d_type) { + case DT_DIR: + { + char subpath[PATH_MAX]; + + strncpy(subpath, path, PATH_MAX); + subpath[PATH_MAX - 1] = '\0'; + strncat(subpath, "/", + PATH_MAX - strlen(subpath) - 1); + strncat(subpath, entry->d_name, + PATH_MAX - strlen(subpath) - 1); + if (utils_recursive_rmdir(subpath)) { + is_empty = 0; + } + break; + } + case DT_REG: + is_empty = 0; + break; + default: + ret = -EINVAL; + goto end; + } + } +end: + closeret = closedir(dir); + if (closeret) { + PERROR("closedir"); + } + if (is_empty) { + DBG3("Attempting rmdir %s", path); + ret = rmdir(path); + } + return ret; +}