* Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
* Copyright (C) 2013 Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
- * 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 <common/common.hpp>
+#include <common/compat/directory-handle.hpp>
+#include <common/compat/dirent.hpp>
+#include <common/compat/getenv.hpp>
+#include <common/compat/string.hpp>
+#include <common/dynamic-buffer.hpp>
+#include <common/readwrite.hpp>
+#include <common/runas.hpp>
+#include <common/string-utils/format.hpp>
+
+#include <lttng/constant.h>
+
#include <ctype.h>
#include <fcntl.h>
+#include <grp.h>
+#include <inttypes.h>
#include <limits.h>
+#include <pwd.h>
#include <stdlib.h>
+#include <sys/file.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
-#include <inttypes.h>
-#include <grp.h>
-#include <pwd.h>
-#include <sys/file.h>
-#include <unistd.h>
-
-#include <common/common.h>
-#include <common/readwrite.h>
-#include <common/runas.h>
-#include <common/compat/getenv.h>
-#include <common/compat/string.h>
-#include <common/compat/dirent.h>
-#include <common/compat/directory-handle.h>
-#include <common/dynamic-buffer.h>
-#include <common/string-utils/format.h>
-#include <lttng/constant.h>
-
-#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"
#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
/*
{
int ret;
- if (dst == NULL) {
+ if (dst == nullptr) {
return -1;
}
{
int ret, i;
- if (dst == NULL) {
+ if (dst == nullptr) {
return -1;
}
{
int ret, i;
- if (dst == NULL) {
+ if (dst == nullptr) {
return -1;
}
{
int i, ret;
- if (src == NULL) {
+ if (src == nullptr) {
return;
}
*/
char *utils_strdupdelim(const char *begin, const char *end)
{
- char *str;
+ char *str = zmalloc<char>(end - begin + 1);
- str = (char *) zmalloc(end - begin + 1);
- if (str == NULL) {
+ if (str == nullptr) {
PERROR("zmalloc strdupdelim");
goto error;
}
*/
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;
}
/*
.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;
.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;
*
* 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;
*
* @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;
}
/* 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;
*
* @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;
}
/* 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;
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;
"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;
* 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;
}
{
struct passwd pwd;
struct passwd *result;
- char *home_dir = NULL;
- char *buf = NULL;
+ char *home_dir = nullptr;
+ char *buf = nullptr;
long buflen;
int ret;
goto end;
}
retry:
- buf = (char *) zmalloc(buflen);
+ buf = zmalloc<char>(buflen);
if (!buf) {
goto end;
}
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;
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;
* 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;
string_len += long_options[i].has_arg ? 1 : 0;
}
- optstring = (char *) zmalloc(string_len);
+ optstring = zmalloc<char>(string_len);
if (!optstring) {
goto end;
}
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;
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);
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) {
}
/* 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);
/*
* 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;
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.
* 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;
}
* 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);
}
* 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);
}
*/
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);
}
}
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);
buflen = FALLBACK_USER_BUFLEN;
}
- buf = (char *) zmalloc(buflen);
+ buf = zmalloc<char>(buflen);
if (!buf) {
ret_val = LTTNG_ERR_NOMEM;
goto end;
case ERANGE:
buflen *= 2;
free(buf);
- buf = (char *) zmalloc(buflen);
+ buf = zmalloc<char>(buflen);
if (!buf) {
ret_val = LTTNG_ERR_NOMEM;
goto end;
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;
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);
buflen = FALLBACK_GROUP_BUFLEN;
}
- buf = (char *) zmalloc(buflen);
+ buf = zmalloc<char>(buflen);
if (!buf) {
ret_val = LTTNG_ERR_NOMEM;
goto end;
case ERANGE:
buflen *= 2;
free(buf);
- buf = (char *) zmalloc(buflen);
+ buf = zmalloc<char>(buflen);
if (!buf) {
ret_val = LTTNG_ERR_NOMEM;
goto end;
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;
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;
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;
}