Port: Explicitly allocate realpath() resolved buffer
[lttng-tools.git] / src / common / utils.c
index db2ed8e7d11dee928a6f96be4167a94669f015c6..2417a7d255ffb1445e12ec9e24ba2b5a29900e1d 100644 (file)
  * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-#define _GNU_SOURCE
 #define _LGPL_SOURCE
 #include <assert.h>
 #include <ctype.h>
 #include <fcntl.h>
 #include <limits.h>
 #include <stdlib.h>
-#include <string.h>
 #include <sys/stat.h>
 #include <sys/types.h>
 #include <unistd.h>
 #include <grp.h>
 #include <pwd.h>
 #include <sys/file.h>
-#include <dirent.h>
 
 #include <common/common.h>
 #include <common/runas.h>
 #include <common/compat/getenv.h>
+#include <common/compat/string.h>
+#include <common/compat/dirent.h>
+#include <lttng/constant.h>
 
 #include "utils.h"
 #include "defaults.h"
@@ -55,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 */
@@ -82,6 +82,8 @@ char *utils_partial_realpath(const char *path, char *resolved_path, size_t size)
 
        /* 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
@@ -92,15 +94,22 @@ 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);
+               cut_path = lttng_strndup(path, next - path);
                if (cut_path == NULL) {
-                       PERROR("strndup");
+                       PERROR("lttng_strndup");
+                       goto error;
+               }
+
+               try_path_buf = zmalloc(LTTNG_PATH_MAX);
+               if (!try_path_buf) {
+                       PERROR("zmalloc");
                        goto error;
                }
 
                /* Try to resolve this part */
-               try_path = realpath((char *)cut_path, NULL);
+               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
@@ -117,6 +126,7 @@ char *utils_partial_realpath(const char *path, char *resolved_path, size_t size)
                        }
                } 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;
@@ -124,7 +134,8 @@ 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 */
        if (resolved_path == NULL) {
@@ -161,6 +172,8 @@ char *utils_partial_realpath(const char *path, char *resolved_path, size_t size)
                /* 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
@@ -174,6 +187,7 @@ char *utils_partial_realpath(const char *path, char *resolved_path, size_t size)
 
 error:
        free(resolved_path);
+       free(cut_path);
        return NULL;
 }
 
@@ -226,9 +240,9 @@ char *utils_expand_path(const char *path)
        while ((next = strstr(absolute_path, "/./"))) {
 
                /* We prepare the start_path not containing it */
-               start_path = strndup(absolute_path, next - absolute_path);
+               start_path = lttng_strndup(absolute_path, next - absolute_path);
                if (!start_path) {
-                       PERROR("strndup");
+                       PERROR("lttng_strndup");
                        goto error;
                }
                /* And we concatenate it with the part after this string */
@@ -246,9 +260,9 @@ char *utils_expand_path(const char *path)
                }
 
                /* Then we prepare the start_path not containing it */
-               start_path = strndup(absolute_path, previous - absolute_path);
+               start_path = lttng_strndup(absolute_path, previous - absolute_path);
                if (!start_path) {
-                       PERROR("strndup");
+                       PERROR("lttng_strndup");
                        goto error;
                }
 
@@ -476,7 +490,7 @@ int utils_create_pid_file(pid_t pid, const char *filepath)
                goto error;
        }
 
-       ret = fprintf(fp, "%d\n", pid);
+       ret = fprintf(fp, "%d\n", (int) pid);
        if (ret < 0) {
                PERROR("fprintf pid file");
                goto error;
@@ -485,7 +499,7 @@ int utils_create_pid_file(pid_t pid, const char *filepath)
        if (fclose(fp)) {
                PERROR("fclose");
        }
-       DBG("Pid %d written in file %s", pid, filepath);
+       DBG("Pid %d written in file %s", (int) pid, filepath);
        ret = 0;
 error:
        return ret;
@@ -500,11 +514,13 @@ int utils_create_lock_file(const char *filepath)
 {
        int ret;
        int fd;
+       struct flock lock;
 
        assert(filepath);
 
-       fd = open(filepath, O_CREAT,
-               O_WRONLY | S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
+       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);
                ret = -1;
@@ -516,8 +532,12 @@ int utils_create_lock_file(const char *filepath)
         * already a process using the same lock file running
         * and we should exit.
         */
-       ret = flock(fd, LOCK_EX | LOCK_NB);
-       if (ret) {
+       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)) {
@@ -649,22 +669,20 @@ int utils_mkdir_recursive(const char *path, mode_t mode, int uid, int gid)
 }
 
 /*
- * Create the stream tracefile on disk.
  * path is the output parameter. It needs to be PATH_MAX len.
  *
  * 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)
+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, out_fd, flags, mode;
-       char full_path[PATH_MAX], *path_name_suffix = NULL, *path;
+       int ret;
+       char full_path[PATH_MAX];
+       char *path_name_suffix = NULL;
        char *extra = NULL;
 
-       assert(path_name);
-       assert(file_name);
-
        ret = snprintf(full_path, sizeof(full_path), "%s/%s",
                        path_name, file_name);
        if (ret < 0) {
@@ -686,8 +704,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);
@@ -695,9 +713,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;
@@ -705,21 +751,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;
 }
 
@@ -749,7 +818,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)++;
        }
@@ -1126,6 +1213,7 @@ LTTNG_HIDDEN
 int utils_recursive_rmdir(const char *path)
 {
        DIR *dir;
+       size_t path_len;
        int dir_fd, ret = 0, closeret, is_empty = 1;
        struct dirent *entry;
 
@@ -1135,19 +1223,40 @@ int utils_recursive_rmdir(const char *path)
                PERROR("Cannot open '%s' path", path);
                return -1;
        }
-       dir_fd = dirfd(dir);
+       dir_fd = lttng_dirfd(dir);
        if (dir_fd < 0) {
-               PERROR("dirfd");
+               PERROR("lttng_dirfd");
                return -1;
        }
 
+       path_len = strlen(path);
        while ((entry = readdir(dir))) {
                if (!strcmp(entry->d_name, ".")
                                || !strcmp(entry->d_name, ".."))
                        continue;
-               switch (entry->d_type) {
-               case DT_DIR:
-               {
+
+               struct stat st;
+               size_t name_len;
+               char filename[PATH_MAX];
+
+               name_len = strlen(entry->d_name);
+               if (path_len + name_len + 2 > sizeof(filename)) {
+                       ERR("Failed to remove file: path name too long (%s/%s)",
+                               path, entry->d_name);
+                       continue;
+               }
+               if (snprintf(filename, sizeof(filename), "%s/%s",
+                               path, entry->d_name) < 0) {
+                       ERR("Failed to format path.");
+                       continue;
+               }
+
+               if (stat(filename, &st)) {
+                       PERROR("stat");
+                       continue;
+               }
+
+               if (S_ISDIR(st.st_mode)) {
                        char subpath[PATH_MAX];
 
                        strncpy(subpath, path, PATH_MAX);
@@ -1159,12 +1268,9 @@ int utils_recursive_rmdir(const char *path)
                        if (utils_recursive_rmdir(subpath)) {
                                is_empty = 0;
                        }
-                       break;
-               }
-               case DT_REG:
+               } else if (S_ISREG(st.st_mode)) {
                        is_empty = 0;
-                       break;
-               default:
+               } else {
                        ret = -EINVAL;
                        goto end;
                }
This page took 0.028778 seconds and 4 git commands to generate.