X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Futils.cpp;h=b4b7f749f1ef1a6e5286225437f639d01f2966d2;hp=93014627fe5162bf8d49c4813074debe3edf1ca7;hb=HEAD;hpb=411b31544f22b773b4aad6cdb81faa81dc05e641 diff --git a/src/common/utils.cpp b/src/common/utils.cpp index 93014627f..62c9c22d5 100644 --- a/src/common/utils.cpp +++ b/src/common/utils.cpp @@ -1,48 +1,46 @@ /* * Copyright (C) 2012 David Goulet - * Copyright (C) 2013 Raphaël Beamonte * Copyright (C) 2013 Jérémie Galarneau * - * SPDX-License-Identifier: GPL-2.0-only + * SPDX-License-Identifier: LGPL-2.1-only * */ -#include "common/macros.h" #define _LGPL_SOURCE +#include "defaults.hpp" +#include "time.hpp" +#include "utils.hpp" + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + #include #include +#include +#include #include +#include #include +#include #include #include #include -#include -#include -#include -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include "utils.h" -#include "defaults.h" -#include "time.h" -#define PROC_MEMINFO_PATH "/proc/meminfo" -#define PROC_MEMINFO_MEMAVAILABLE_LINE "MemAvailable:" -#define PROC_MEMINFO_MEMTOTAL_LINE "MemTotal:" +#define PROC_MEMINFO_PATH "/proc/meminfo" +#define PROC_MEMINFO_MEMAVAILABLE_LINE "MemAvailable:" +#define PROC_MEMINFO_MEMTOTAL_LINE "MemTotal:" -/* The length of the longest field of `/proc/meminfo`. */ -#define PROC_MEMINFO_FIELD_MAX_NAME_LEN 20 +/* The lnullptrh of the longest field of `/proc/meminfo`. */ +#define PROC_MEMINFO_FIELD_MAX_NAME_LEN 20 #if (PROC_MEMINFO_FIELD_MAX_NAME_LEN == 20) #define MAX_NAME_LEN_SCANF_IS_A_BROKEN_API "19" @@ -50,378 +48,9 @@ #error MAX_NAME_LEN_SCANF_IS_A_BROKEN_API must be updated to match (PROC_MEMINFO_FIELD_MAX_NAME_LEN - 1) #endif -#define FALLBACK_USER_BUFLEN 16384 +#define FALLBACK_USER_BUFLEN 16384 #define FALLBACK_GROUP_BUFLEN 16384 -/* - * Return a partial realpath(3) of the path even if the full path does not - * exist. For instance, with /tmp/test1/test2/test3, if test2/ does not exist - * but the /tmp/test1 does, the real path for /tmp/test1 is concatened with - * /test2/test3 then returned. In normal time, realpath(3) fails if the end - * point directory does not exist. - * - * Return a newly-allocated string. - */ -static -char *utils_partial_realpath(const char *path) -{ - char *cut_path = NULL, *try_path = NULL, *try_path_prev = NULL; - const char *next, *prev, *end; - char *resolved_path = NULL; - - /* Safety net */ - if (path == NULL) { - goto error; - } - - /* - * Identify the end of the path, we don't want to treat the - * last char if it is a '/', we will just keep it on the side - * to be added at the end, and return a value coherent with - * the path given as argument - */ - end = path + strlen(path); - if (*(end-1) == '/') { - end--; - } - - /* Initiate the values of the pointers before looping */ - next = path; - prev = next; - /* Only to ensure try_path is not NULL to enter the while */ - try_path = (char *)next; - - /* Resolve the canonical path of the first part of the path */ - while (try_path != NULL && next != end) { - char *try_path_buf = NULL; - - /* - * If there is not any '/' left, we want to try with - * the full path - */ - next = strpbrk(next + 1, "/"); - if (next == NULL) { - next = end; - } - - /* Cut the part we will be trying to resolve */ - cut_path = lttng_strndup(path, next - path); - if (cut_path == NULL) { - PERROR("lttng_strndup"); - goto error; - } - - try_path_buf = (char *) zmalloc(LTTNG_PATH_MAX); - if (!try_path_buf) { - PERROR("zmalloc"); - goto error; - } - - /* Try to resolve this part */ - try_path = realpath((char *) cut_path, try_path_buf); - if (try_path == NULL) { - free(try_path_buf); - /* - * There was an error, we just want to be assured it - * is linked to an unexistent directory, if it's another - * reason, we spawn an error - */ - switch (errno) { - case ENOENT: - /* Ignore the error */ - break; - default: - PERROR("realpath (partial_realpath)"); - goto error; - break; - } - } else { - /* Save the place we are before trying the next step */ - try_path_buf = NULL; - free(try_path_prev); - try_path_prev = try_path; - prev = next; - } - - /* Free the allocated memory */ - free(cut_path); - cut_path = NULL; - } - - /* Allocate memory for the resolved path. */ - resolved_path = (char *) zmalloc(LTTNG_PATH_MAX); - if (resolved_path == NULL) { - PERROR("zmalloc resolved path"); - goto error; - } - - /* - * If we were able to solve at least partially the path, we can concatenate - * what worked and what didn't work - */ - if (try_path_prev != NULL) { - /* If we risk to concatenate two '/', we remove one of them */ - if (try_path_prev[strlen(try_path_prev) - 1] == '/' && prev[0] == '/') { - try_path_prev[strlen(try_path_prev) - 1] = '\0'; - } - - /* - * Duplicate the memory used by prev in case resolved_path and - * 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, LTTNG_PATH_MAX, "%s%s", - try_path_prev, cut_path); - - /* Free the allocated memory */ - free(cut_path); - free(try_path_prev); - cut_path = NULL; - try_path_prev = NULL; - /* - * Else, we just copy the path in our resolved_path to - * return it as is - */ - } else { - strncpy(resolved_path, path, LTTNG_PATH_MAX); - } - - /* Then we return the 'partially' resolved path */ - return resolved_path; - -error: - free(resolved_path); - free(cut_path); - free(try_path); - if (try_path_prev != try_path) { - free(try_path_prev); - } - return NULL; -} - -static -int expand_double_slashes_dot_and_dotdot(char *path) -{ - size_t expanded_path_len, path_len; - const char *curr_char, *path_last_char, *next_slash, *prev_slash; - - path_len = strlen(path); - path_last_char = &path[path_len]; - - if (path_len == 0) { - goto error; - } - - expanded_path_len = 0; - - /* We iterate over the provided path to expand the "//", "../" and "./" */ - for (curr_char = path; curr_char <= path_last_char; curr_char = next_slash + 1) { - /* Find the next forward slash. */ - size_t curr_token_len; - - if (curr_char == path_last_char) { - expanded_path_len++; - break; - } - - next_slash = (const char *) memchr(curr_char, '/', path_last_char - curr_char); - if (next_slash == NULL) { - /* Reached the end of the provided path. */ - next_slash = path_last_char; - } - - /* Compute how long is the previous token. */ - curr_token_len = next_slash - curr_char; - switch(curr_token_len) { - case 0: - /* - * The pointer has not move meaning that curr_char is - * pointing to a slash. It that case there is no token - * to copy, so continue the iteration to find the next - * token - */ - continue; - case 1: - /* - * The pointer moved 1 character. Check if that - * character is a dot ('.'), if it is: omit it, else - * copy the token to the normalized path. - */ - if (curr_char[0] == '.') { - continue; - } - break; - case 2: - /* - * The pointer moved 2 characters. Check if these - * characters are double dots ('..'). If that is the - * case, we need to remove the last token of the - * normalized path. - */ - if (curr_char[0] == '.' && curr_char[1] == '.') { - /* - * Find the previous path component by - * using the memrchr function to find the - * previous forward slash and substract that - * len to the resulting path. - */ - prev_slash = (const char *) lttng_memrchr(path, '/', expanded_path_len); - /* - * If prev_slash is NULL, we reached the - * beginning of the path. We can't go back any - * further. - */ - if (prev_slash != NULL) { - expanded_path_len = prev_slash - path; - } - continue; - } - break; - default: - break; - } - - /* - * Copy the current token which is neither a '.' nor a '..'. - */ - path[expanded_path_len++] = '/'; - memmove(&path[expanded_path_len], curr_char, curr_token_len); - expanded_path_len += curr_token_len; - } - - if (expanded_path_len == 0) { - path[expanded_path_len++] = '/'; - } - - path[expanded_path_len] = '\0'; - return 0; -error: - return -1; -} - -/* - * Make a full resolution of the given path even if it doesn't exist. - * This function uses the utils_partial_realpath function to resolve - * symlinks and relatives paths at the start of the string, and - * implements functionnalities to resolve the './' and '../' strings - * in the middle of a path. This function is only necessary because - * realpath(3) does not accept to resolve unexistent paths. - * The returned string was allocated in the function, it is thus of - * the responsibility of the caller to free this memory. - */ -static -char *_utils_expand_path(const char *path, bool keep_symlink) -{ - int ret; - char *absolute_path = NULL; - char *last_token; - bool is_dot, is_dotdot; - - /* Safety net */ - if (path == NULL) { - goto error; - } - - /* Allocate memory for the absolute_path */ - absolute_path = (char *) zmalloc(LTTNG_PATH_MAX); - if (absolute_path == NULL) { - PERROR("zmalloc expand path"); - goto error; - } - - if (path[0] == '/') { - ret = lttng_strncpy(absolute_path, path, LTTNG_PATH_MAX); - if (ret) { - ERR("Path exceeds maximal size of %i bytes", LTTNG_PATH_MAX); - goto error; - } - } else { - /* - * This is a relative path. We need to get the present working - * directory and start the path walk from there. - */ - char current_working_dir[LTTNG_PATH_MAX]; - char *cwd_ret; - - cwd_ret = getcwd(current_working_dir, sizeof(current_working_dir)); - if (!cwd_ret) { - goto error; - } - /* - * Get the number of character in the CWD and allocate an array - * to can hold it and the path provided by the caller. - */ - ret = snprintf(absolute_path, LTTNG_PATH_MAX, "%s/%s", - current_working_dir, path); - if (ret >= LTTNG_PATH_MAX) { - ERR("Concatenating current working directory %s and path %s exceeds maximal size of %i bytes", - current_working_dir, path, LTTNG_PATH_MAX); - goto error; - } - } - - if (keep_symlink) { - /* Resolve partially our path */ - char *new_absolute_path = utils_partial_realpath(absolute_path); - if (!new_absolute_path) { - goto error; - } - - free(absolute_path); - absolute_path = new_absolute_path; - } - - ret = expand_double_slashes_dot_and_dotdot(absolute_path); - if (ret) { - goto error; - } - - /* 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: - free(absolute_path); - return NULL; -} -char *utils_expand_path(const char *path) -{ - return _utils_expand_path(path, true); -} - -char *utils_expand_path_keep_symlink(const char *path) -{ - return _utils_expand_path(path, false); -} /* * Create a pipe in dst. */ @@ -429,7 +58,7 @@ int utils_create_pipe(int *dst) { int ret; - if (dst == NULL) { + if (dst == nullptr) { return -1; } @@ -451,7 +80,7 @@ int utils_create_pipe_cloexec(int *dst) { int ret, i; - if (dst == NULL) { + if (dst == nullptr) { return -1; } @@ -483,7 +112,7 @@ int utils_create_pipe_cloexec_nonblock(int *dst) { int ret, i; - if (dst == NULL) { + if (dst == nullptr) { return -1; } @@ -520,7 +149,7 @@ void utils_close_pipe(int *src) { int i, ret; - if (src == NULL) { + if (src == nullptr) { return; } @@ -543,10 +172,9 @@ void utils_close_pipe(int *src) */ char *utils_strdupdelim(const char *begin, const char *end) { - char *str; + char *str = zmalloc(end - begin + 1); - str = (char *) zmalloc(end - begin + 1); - if (str == NULL) { + if (str == nullptr) { PERROR("zmalloc strdupdelim"); goto error; } @@ -585,76 +213,45 @@ end: */ int utils_create_pid_file(pid_t pid, const char *filepath) { - int ret; - FILE *fp; + int ret, fd = -1; + FILE *fp = nullptr; LTTNG_ASSERT(filepath); - fp = fopen(filepath, "w"); - if (fp == NULL) { - PERROR("open pid file %s", filepath); + fd = open(filepath, O_CREAT | O_WRONLY, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH); + if (fd < 0) { + PERROR("open file %s", filepath); ret = -1; goto error; } - ret = fprintf(fp, "%d\n", (int) pid); - if (ret < 0) { - PERROR("fprintf pid file"); - goto error; - } - - if (fclose(fp)) { - PERROR("fclose"); - } - DBG("Pid %d written in file %s", (int) pid, filepath); - ret = 0; -error: - return ret; -} - -/* - * Create lock file to the given path and filename. - * Returns the associated file descriptor, -1 on error. - */ -int utils_create_lock_file(const char *filepath) -{ - int ret; - int fd; - struct flock lock; - - LTTNG_ASSERT(filepath); + fp = fdopen(fd, "w"); + if (fp == nullptr) { + PERROR("fdopen file %s", filepath); + ret = -1; + if (close(fd)) { + PERROR("Failed to close `%s` file descriptor while handling fdopen error", + filepath); + } - memset(&lock, 0, sizeof(lock)); - fd = open(filepath, O_CREAT | O_WRONLY, S_IRUSR | S_IWUSR | - S_IRGRP | S_IWGRP); - if (fd < 0) { - PERROR("open lock file %s", filepath); - fd = -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. - */ - lock.l_whence = SEEK_SET; - lock.l_type = F_WRLCK; - - ret = fcntl(fd, F_SETLK, &lock); - if (ret == -1) { - PERROR("fcntl lock file"); - ERR("Could not get lock file %s, another instance is running.", - filepath); - if (close(fd)) { - PERROR("close lock file"); - } - fd = ret; + ret = fprintf(fp, "%d\n", (int) pid); + if (ret < 0) { + PERROR("fprintf file %s", filepath); + ret = -1; goto error; } + DBG("'%d' written in file %s", (int) pid, filepath); + ret = 0; + error: - return fd; + if (fp && fclose(fp)) { + PERROR("fclose file %s", filepath); + } + return ret; } /* @@ -671,14 +268,13 @@ int utils_mkdir(const char *path, mode_t mode, int uid, int gid) .gid = LTTNG_OPTIONAL_INIT_VALUE((gid_t) gid), }; - handle = lttng_directory_handle_create(NULL); + handle = lttng_directory_handle_create(nullptr); if (!handle) { ret = -1; goto end; } ret = lttng_directory_handle_create_subdirectory_as_user( - handle, path, mode, - (uid >= 0 || gid >= 0) ? &creds : NULL); + handle, path, mode, (uid >= 0 || gid >= 0) ? &creds : nullptr); end: lttng_directory_handle_put(handle); return ret; @@ -699,14 +295,13 @@ int utils_mkdir_recursive(const char *path, mode_t mode, int uid, int gid) .gid = LTTNG_OPTIONAL_INIT_VALUE((gid_t) gid), }; - handle = lttng_directory_handle_create(NULL); + handle = lttng_directory_handle_create(nullptr); if (!handle) { ret = -1; goto end; } ret = lttng_directory_handle_create_subdirectory_recursive_as_user( - handle, path, mode, - (uid >= 0 || gid >= 0) ? &creds : NULL); + handle, path, mode, (uid >= 0 || gid >= 0) ? &creds : nullptr); end: lttng_directory_handle_put(handle); return ret; @@ -717,32 +312,39 @@ end: * * Return 0 on success or else a negative value. */ -int utils_stream_file_path(const char *path_name, const char *file_name, - uint64_t size, uint64_t count, const char *suffix, - char *out_stream_path, size_t stream_path_len) +int utils_stream_file_path(const char *path_name, + const char *file_name, + uint64_t size, + uint64_t count, + const char *suffix, + char *out_stream_path, + size_t stream_path_len) { int ret; char count_str[MAX_INT_DEC_LEN(count) + 1] = {}; const char *path_separator; - if (path_name && (path_name[0] == '\0' || - path_name[strlen(path_name) - 1] == '/')) { + if (path_name && (path_name[0] == '\0' || path_name[strlen(path_name) - 1] == '/')) { path_separator = ""; } else { path_separator = "/"; } - path_name = path_name ? : ""; - suffix = suffix ? : ""; + path_name = path_name ?: ""; + suffix = suffix ?: ""; if (size > 0) { - ret = snprintf(count_str, sizeof(count_str), "_%" PRIu64, - count); + ret = snprintf(count_str, sizeof(count_str), "_%" PRIu64, count); LTTNG_ASSERT(ret > 0 && ret < sizeof(count_str)); } - ret = snprintf(out_stream_path, stream_path_len, "%s%s%s%s%s", - path_name, path_separator, file_name, count_str, - suffix); + ret = snprintf(out_stream_path, + stream_path_len, + "%s%s%s%s%s", + path_name, + path_separator, + file_name, + count_str, + suffix); if (ret < 0 || ret >= stream_path_len) { ERR("Truncation occurred while formatting stream path"); ret = -1; @@ -767,7 +369,7 @@ int utils_stream_file_path(const char *path_name, const char *file_name, * * @return 0 on success, -1 on failure. */ -int utils_parse_size_suffix(const char * const str, uint64_t * const size) +int utils_parse_size_suffix(const char *const str, uint64_t *const size) { int ret; uint64_t base_size; @@ -782,7 +384,7 @@ int utils_parse_size_suffix(const char * const str, uint64_t * const size) } /* strtoull will accept a negative number, but we don't want to. */ - if (strchr(str, '-') != NULL) { + if (strchr(str, '-') != nullptr) { DBG("utils_parse_size_suffix: invalid size string, should not contain '-'."); ret = -1; goto end; @@ -873,7 +475,7 @@ end: * * @return 0 on success, -1 on failure. */ -int utils_parse_time_suffix(char const * const str, uint64_t * const time_us) +int utils_parse_time_suffix(char const *const str, uint64_t *const time_us) { int ret; uint64_t base_time; @@ -888,7 +490,7 @@ int utils_parse_time_suffix(char const * const str, uint64_t * const time_us) } /* strtoull will accept a negative number, but we don't want to. */ - if (strchr(str, '-') != NULL) { + if (strchr(str, '-') != nullptr) { DBG("utils_parse_time_suffix: invalid time string, should not contain '-'."); ret = -1; goto end; @@ -987,18 +589,18 @@ 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)); + "jnz 1f\n\t" + "movl $-1,%0\n\t" + "1:\n\t" + : "=r"(r) + : "rm"(x)); return r + 1; } #define HAS_FLS_U32 #endif #if defined(__x86_64) && defined(__LP64__) -static inline -unsigned int fls_u64(uint64_t x) +static inline unsigned int fls_u64(uint64_t x) { long r; @@ -1006,15 +608,15 @@ unsigned int fls_u64(uint64_t x) "jnz 1f\n\t" "movq $-1,%0\n\t" "1:\n\t" - : "=r" (r) : "rm" (x)); + : "=r"(r) + : "rm"(x)); return r + 1; } #define HAS_FLS_U64 #endif #ifndef HAS_FLS_U64 -static __attribute__((unused)) -unsigned int fls_u64(uint64_t x) +static __attribute__((unused)) unsigned int fls_u64(uint64_t x) { unsigned int r = 64; @@ -1111,17 +713,17 @@ int utils_get_count_order_u64(uint64_t x) * Obtain the value of LTTNG_HOME environment variable, if exists. * Otherwise returns the value of HOME. */ -const char *utils_get_home_dir(void) +const char *utils_get_home_dir() { - char *val = NULL; + char *val = nullptr; struct passwd *pwd; val = lttng_secure_getenv(DEFAULT_LTTNG_HOME_ENV_VAR); - if (val != NULL) { + if (val != nullptr) { goto end; } val = lttng_secure_getenv(DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR); - if (val != NULL) { + if (val != nullptr) { goto end; } @@ -1146,8 +748,8 @@ char *utils_get_user_home_dir(uid_t uid) { struct passwd pwd; struct passwd *result; - char *home_dir = NULL; - char *buf = NULL; + char *home_dir = nullptr; + char *buf = nullptr; long buflen; int ret; @@ -1156,7 +758,7 @@ char *utils_get_user_home_dir(uid_t uid) goto end; } retry: - buf = (char *) zmalloc(buflen); + buf = zmalloc(buflen); if (!buf) { goto end; } @@ -1199,8 +801,7 @@ size_t utils_get_current_time_str(const char *format, char *dst, size_t len) ret = strftime(dst, len, format, timeinfo); DIAGNOSTIC_POP if (ret == 0) { - ERR("Unable to strftime with format %s at dst %p of len %zu", format, - dst, len); + ERR("Unable to strftime with format %s at dst %p of len %zu", format, dst, len); } return ret; @@ -1248,19 +849,16 @@ int utils_get_group_id(const char *name, bool warn, gid_t *gid) ret = lttng_dynamic_buffer_set_size(&buffer, new_len); if (ret) { - ERR("Failed to grow group info buffer to %zu bytes", - new_len); + ERR("Failed to grow group info buffer to %zu bytes", new_len); ret = -1; goto error; } } if (ret) { if (ret == ESRCH) { - DBG("Could not find group file entry for group name '%s'", - name); + DBG("Could not find group file entry for group name '%s'", name); } else { - PERROR("Failed to get group file entry for group name '%s'", - name); + PERROR("Failed to get group file entry for group name '%s'", name); } ret = -1; @@ -1291,8 +889,7 @@ error: * of elements in the long_options array. Returns NULL if the string's * allocation fails. */ -char *utils_generate_optstring(const struct option *long_options, - size_t opt_count) +char *utils_generate_optstring(const struct option *long_options, size_t opt_count) { int i; size_t string_len = opt_count, str_pos = 0; @@ -1306,7 +903,7 @@ char *utils_generate_optstring(const struct option *long_options, string_len += long_options[i].has_arg ? 1 : 0; } - optstring = (char *) zmalloc(string_len); + optstring = zmalloc(string_len); if (!optstring) { goto end; } @@ -1338,7 +935,7 @@ int utils_recursive_rmdir(const char *path) int ret; struct lttng_directory_handle *handle; - handle = lttng_directory_handle_create(NULL); + handle = lttng_directory_handle_create(nullptr); if (!handle) { ret = -1; goto end; @@ -1369,7 +966,7 @@ end: return ret; } -static const char *get_man_bin_path(void) +static const char *get_man_bin_path() { char *env_man_path = lttng_secure_getenv(DEFAULT_MAN_BIN_PATH_ENV); @@ -1380,11 +977,23 @@ static const char *get_man_bin_path(void) return DEFAULT_MAN_BIN_PATH; } -int utils_show_help(int section, const char *page_name, - const char *help_msg) +static const char *get_manpath() +{ + char *manpath = lttng_secure_getenv(DEFAULT_MANPATH); + + if (manpath) { + return manpath; + } + + /* As defined during configuration. */ + return MANPATH; +} + +int utils_show_help(int section, const char *page_name, const char *help_msg) { char section_string[8]; const char *man_bin_path = get_man_bin_path(); + const char *manpath = get_manpath(); int ret = 0; if (help_msg) { @@ -1393,7 +1002,7 @@ int utils_show_help(int section, const char *page_name, } /* Section integer -> section string */ - ret = sprintf(section_string, "%d", section); + ret = snprintf(section_string, sizeof(section_string), "%d", section); LTTNG_ASSERT(ret > 0 && ret < 8); /* @@ -1403,15 +1012,13 @@ int utils_show_help(int section, const char *page_name, * be installed outside /usr, in which case its man pages are * not located in the default /usr/share/man directory. */ - ret = execlp(man_bin_path, "man", "-M", MANPATH, - section_string, page_name, NULL); + ret = execlp(man_bin_path, "man", "-M", manpath, section_string, page_name, NULL); end: return ret; } -static -int read_proc_meminfo_field(const char *field, size_t *value) +static int read_proc_meminfo_field(const char *field, uint64_t *value) { int ret; FILE *proc_meminfo; @@ -1422,18 +1029,19 @@ int read_proc_meminfo_field(const char *field, size_t *value) PERROR("Failed to fopen() " PROC_MEMINFO_PATH); ret = -1; goto fopen_error; - } + } /* * Read the contents of /proc/meminfo line by line to find the right * field. */ while (!feof(proc_meminfo)) { - unsigned long value_kb; + uint64_t value_kb; ret = fscanf(proc_meminfo, - "%" MAX_NAME_LEN_SCANF_IS_A_BROKEN_API "s %lu kB\n", - name, &value_kb); + "%" MAX_NAME_LEN_SCANF_IS_A_BROKEN_API "s %" SCNu64 " kB\n", + name, + &value_kb); if (ret == EOF) { /* * fscanf() returning EOF can indicate EOF or an error. @@ -1449,7 +1057,12 @@ int read_proc_meminfo_field(const char *field, size_t *value) * This number is displayed in kilo-bytes. Return the * number of bytes. */ - *value = ((size_t) value_kb) * 1024; + if (value_kb > UINT64_MAX / 1024) { + ERR("Overflow on kb to bytes conversion"); + break; + } + + *value = value_kb * 1024; ret = 0; goto found; } @@ -1468,7 +1081,7 @@ fopen_error: * the information in `/proc/meminfo`. The number returned by this function is * a best guess. */ -int utils_get_memory_available(size_t *value) +int utils_get_memory_available(uint64_t *value) { return read_proc_meminfo_field(PROC_MEMINFO_MEMAVAILABLE_LINE, value); } @@ -1477,7 +1090,7 @@ int utils_get_memory_available(size_t *value) * Returns the total size of the memory on the system in bytes based on the * the information in `/proc/meminfo`. */ -int utils_get_memory_total(size_t *value) +int utils_get_memory_total(uint64_t *value) { return read_proc_meminfo_field(PROC_MEMINFO_MEMTOTAL_LINE, value); } @@ -1504,8 +1117,7 @@ int utils_change_working_directory(const char *path) */ DBG("Working directory \"%s\" is not writable", path); } else { - PERROR("Failed to check if working directory \"%s\" is writable", - path); + PERROR("Failed to check if working directory \"%s\" is writable", path); } } @@ -1518,7 +1130,7 @@ enum lttng_error_code utils_user_id_from_name(const char *user_name, uid_t *uid) struct passwd p, *pres; int ret; enum lttng_error_code ret_val = LTTNG_OK; - char *buf = NULL; + char *buf = nullptr; ssize_t buflen; buflen = sysconf(_SC_GETPW_R_SIZE_MAX); @@ -1526,7 +1138,7 @@ enum lttng_error_code utils_user_id_from_name(const char *user_name, uid_t *uid) buflen = FALLBACK_USER_BUFLEN; } - buf = (char *) zmalloc(buflen); + buf = zmalloc(buflen); if (!buf) { ret_val = LTTNG_ERR_NOMEM; goto end; @@ -1540,7 +1152,7 @@ enum lttng_error_code utils_user_id_from_name(const char *user_name, uid_t *uid) case ERANGE: buflen *= 2; free(buf); - buf = (char *) zmalloc(buflen); + buf = zmalloc(buflen); if (!buf) { ret_val = LTTNG_ERR_NOMEM; goto end; @@ -1554,12 +1166,13 @@ end_loop: switch (ret) { case 0: - if (pres == NULL) { + if (pres == nullptr) { ret_val = LTTNG_ERR_USER_NOT_FOUND; } else { *uid = p.pw_uid; DBG("Lookup of tracker UID/VUID: name '%s' maps to uid %" PRId64, - user_name, (int64_t) *uid); + user_name, + (int64_t) *uid); ret_val = LTTNG_OK; } break; @@ -1577,13 +1190,12 @@ end: return ret_val; } -enum lttng_error_code utils_group_id_from_name( - const char *group_name, gid_t *gid) +enum lttng_error_code utils_group_id_from_name(const char *group_name, gid_t *gid) { struct group g, *gres; int ret; enum lttng_error_code ret_val = LTTNG_OK; - char *buf = NULL; + char *buf = nullptr; ssize_t buflen; buflen = sysconf(_SC_GETGR_R_SIZE_MAX); @@ -1591,7 +1203,7 @@ enum lttng_error_code utils_group_id_from_name( buflen = FALLBACK_GROUP_BUFLEN; } - buf = (char *) zmalloc(buflen); + buf = zmalloc(buflen); if (!buf) { ret_val = LTTNG_ERR_NOMEM; goto end; @@ -1605,7 +1217,7 @@ enum lttng_error_code utils_group_id_from_name( case ERANGE: buflen *= 2; free(buf); - buf = (char *) zmalloc(buflen); + buf = zmalloc(buflen); if (!buf) { ret_val = LTTNG_ERR_NOMEM; goto end; @@ -1619,12 +1231,13 @@ end_loop: switch (ret) { case 0: - if (gres == NULL) { + if (gres == nullptr) { ret_val = LTTNG_ERR_GROUP_NOT_FOUND; } else { *gid = g.gr_gid; DBG("Lookup of tracker GID/GUID: name '%s' maps to gid %" PRId64, - group_name, (int64_t) *gid); + group_name, + (int64_t) *gid); ret_val = LTTNG_OK; } break; @@ -1642,8 +1255,7 @@ end: return ret_val; } -int utils_parse_unsigned_long_long(const char *str, - unsigned long long *value) +int utils_parse_unsigned_long_long(const char *str, unsigned long long *value) { int ret; char *endptr; @@ -1658,15 +1270,15 @@ int utils_parse_unsigned_long_long(const char *str, if (errno != 0) { /* Don't print an error; allow the caller to log a better error. */ DBG("Failed to parse string as unsigned long long number: string = '%s', errno = %d", - str, errno); + str, + errno); ret = -1; goto end; } /* Not the end of the string or empty string. */ if (*endptr || endptr == str) { - DBG("Failed to parse string as unsigned long long number: string = '%s'", - str); + DBG("Failed to parse string as unsigned long long number: string = '%s'", str); ret = -1; goto end; }