Fix: syscall event rule: emission sites not compared in is_equal
[lttng-tools.git] / src / common / utils.cpp
index 6c0fd261c7b8a4033d5eb35cc7247af509ddfca3..62c9c22d52686e442edad15ce3a4a17a8edb0a75 100644 (file)
@@ -7,17 +7,9 @@
  */
 
 #define _LGPL_SOURCE
-#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 "defaults.hpp"
+#include "time.hpp"
+#include "utils.hpp"
 
 #include <common/common.hpp>
 #include <common/compat/directory-handle.hpp>
 #include <common/readwrite.hpp>
 #include <common/runas.hpp>
 #include <common/string-utils/format.hpp>
+
 #include <lttng/constant.h>
 
-#include "defaults.hpp"
-#include "time.hpp"
-#include "utils.hpp"
+#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>
 
-#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"
@@ -47,7 +48,7 @@
 #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
 
 /*
@@ -57,7 +58,7 @@ int utils_create_pipe(int *dst)
 {
        int ret;
 
-       if (dst == NULL) {
+       if (dst == nullptr) {
                return -1;
        }
 
@@ -79,7 +80,7 @@ int utils_create_pipe_cloexec(int *dst)
 {
        int ret, i;
 
-       if (dst == NULL) {
+       if (dst == nullptr) {
                return -1;
        }
 
@@ -111,7 +112,7 @@ int utils_create_pipe_cloexec_nonblock(int *dst)
 {
        int ret, i;
 
-       if (dst == NULL) {
+       if (dst == nullptr) {
                return -1;
        }
 
@@ -148,7 +149,7 @@ void utils_close_pipe(int *src)
 {
        int i, ret;
 
-       if (src == NULL) {
+       if (src == nullptr) {
                return;
        }
 
@@ -173,7 +174,7 @@ char *utils_strdupdelim(const char *begin, const char *end)
 {
        char *str = zmalloc<char>(end - begin + 1);
 
-       if (str == NULL) {
+       if (str == nullptr) {
                PERROR("zmalloc strdupdelim");
                goto error;
        }
@@ -213,11 +214,11 @@ end:
 int utils_create_pid_file(pid_t pid, const char *filepath)
 {
        int ret, fd = -1;
-       FILE *fp = NULL;
+       FILE *fp = nullptr;
 
        LTTNG_ASSERT(filepath);
 
-       fd = open(filepath, O_CREAT | O_WRONLY, S_IRUSR |S_IWUSR | S_IRGRP | S_IROTH);
+       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;
@@ -225,10 +226,14 @@ int utils_create_pid_file(pid_t pid, const char *filepath)
        }
 
        fp = fdopen(fd, "w");
-       if (fp == NULL) {
+       if (fp == nullptr) {
                PERROR("fdopen file %s", filepath);
                ret = -1;
-               close(fd);
+               if (close(fd)) {
+                       PERROR("Failed to close `%s` file descriptor while handling fdopen error",
+                              filepath);
+               }
+
                goto error;
        }
 
@@ -249,51 +254,6 @@ 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);
-
-       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;
-               goto error;
-       }
-
-error:
-       return fd;
-}
-
 /*
  * Create directory using the given path and mode.
  *
@@ -308,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;
@@ -336,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;
@@ -354,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;
@@ -404,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;
@@ -419,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;
@@ -510,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;
@@ -525,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;
@@ -624,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;
 
@@ -643,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;
 
@@ -748,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;
        }
 
@@ -783,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;
 
@@ -836,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;
@@ -885,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;
@@ -928,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;
@@ -975,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;
@@ -1006,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);
 
@@ -1017,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) {
@@ -1030,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);
 
        /*
@@ -1040,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, uint64_t *value)
+static int read_proc_meminfo_field(const char *field, uint64_t *value)
 {
        int ret;
        FILE *proc_meminfo;
@@ -1059,7 +1029,7 @@ int read_proc_meminfo_field(const char *field, uint64_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
@@ -1069,8 +1039,9 @@ int read_proc_meminfo_field(const char *field, uint64_t *value)
                uint64_t value_kb;
 
                ret = fscanf(proc_meminfo,
-                               "%" MAX_NAME_LEN_SCANF_IS_A_BROKEN_API "s %" SCNu64 " 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.
@@ -1146,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);
                }
        }
 
@@ -1160,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);
@@ -1196,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;
@@ -1219,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);
@@ -1261,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;
@@ -1284,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;
@@ -1300,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;
        }
This page took 0.031115 seconds and 4 git commands to generate.