liblttng-ctl: use export list to define exported symbols
[lttng-tools.git] / src / common / compat / directory-handle.c
index 9548da216298ff23980e5e84dcf8cc24975c5608..9b98e04827bf2a91dd669df5bee7a929a87c8bcb 100644 (file)
@@ -1,18 +1,8 @@
 /*
- * Copyright (C) 2019 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2019 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * 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 published by the Free Software Foundation.
+ * SPDX-License-Identifier: GPL-2.0-only
  *
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
- * more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #include <common/compat/directory-handle.h>
@@ -23,7 +13,6 @@
 #include <lttng/constant.h>
 #include <common/dynamic-array.h>
 
-#include <assert.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <fcntl.h>
@@ -88,7 +77,7 @@ void lttng_directory_handle_invalidate(struct lttng_directory_handle *handle);
 static
 void lttng_directory_handle_release(struct urcu_ref *ref);
 
-#ifdef COMPAT_DIRFD
+#ifdef HAVE_DIRFD
 
 /*
  * Special inode number reserved to represent the "current working directory".
@@ -110,7 +99,6 @@ void lttng_directory_handle_release(struct urcu_ref *ref);
                (ino_t) reserved_val;              \
        })
 
-LTTNG_HIDDEN
 struct lttng_directory_handle *lttng_directory_handle_create(const char *path)
 {
        const struct lttng_directory_handle cwd_handle = {
@@ -121,7 +109,6 @@ struct lttng_directory_handle *lttng_directory_handle_create(const char *path)
        return lttng_directory_handle_create_from_handle(path, &cwd_handle);
 }
 
-LTTNG_HIDDEN
 struct lttng_directory_handle *lttng_directory_handle_create_from_handle(
                const char *path,
                const struct lttng_directory_handle *ref_handle)
@@ -157,7 +144,6 @@ error_close:
        return NULL;
 }
 
-LTTNG_HIDDEN
 struct lttng_directory_handle *lttng_directory_handle_create_from_dirfd(
                int dirfd)
 {
@@ -174,6 +160,8 @@ struct lttng_directory_handle *lttng_directory_handle_create_from_dirfd(
                if (ret) {
                        PERROR("Failed to fstat directory file descriptor %i", dirfd);
                        lttng_directory_handle_release(&handle->ref);
+                       handle = NULL;
+                       goto end;
                }
        } else {
                handle->directory_inode = RESERVED_AT_FDCWD_INO;
@@ -191,6 +179,10 @@ void lttng_directory_handle_release(struct urcu_ref *ref)
        struct lttng_directory_handle *handle =
                        container_of(ref, struct lttng_directory_handle, ref);
 
+       if (handle->destroy_cb) {
+               handle->destroy_cb(handle, handle->destroy_cb_data);
+       }
+
        if (handle->dirfd == AT_FDCWD || handle->dirfd == -1) {
                goto end;
        }
@@ -203,7 +195,6 @@ end:
        free(handle);
 }
 
-LTTNG_HIDDEN
 struct lttng_directory_handle *lttng_directory_handle_copy(
                const struct lttng_directory_handle *handle)
 {
@@ -228,7 +219,6 @@ end:
        return new_handle;
 }
 
-LTTNG_HIDDEN
 bool lttng_directory_handle_equals(const struct lttng_directory_handle *lhs,
                const struct lttng_directory_handle *rhs)
 {
@@ -241,13 +231,18 @@ void lttng_directory_handle_invalidate(struct lttng_directory_handle *handle)
        handle->dirfd = -1;
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_stat(const struct lttng_directory_handle *handle,
                const char *path, struct stat *st)
 {
        return fstatat(handle->dirfd, path, st, 0);
 }
 
+bool lttng_directory_handle_uses_fd(
+               const struct lttng_directory_handle *handle)
+{
+       return handle->dirfd != AT_FDCWD;
+}
+
 static
 int lttng_directory_handle_mkdir(
                const struct lttng_directory_handle *handle,
@@ -352,7 +347,12 @@ static
 int lttng_directory_handle_rmdir(
                const struct lttng_directory_handle *handle, const char *name)
 {
-       return unlinkat(handle->dirfd, name, AT_REMOVEDIR);
+       int ret = unlinkat(handle->dirfd, name, AT_REMOVEDIR);
+       if (ret) {
+               PERROR("Failed to remove directory `%s`", name);
+       }
+
+       return ret;
 }
 
 static
@@ -370,7 +370,7 @@ int _run_as_rmdir_recursive(
        return run_as_rmdirat_recursive(handle->dirfd, name, uid, gid, flags);
 }
 
-#else /* COMPAT_DIRFD */
+#else /* HAVE_DIRFD */
 
 static
 int get_full_path(const struct lttng_directory_handle *handle,
@@ -417,7 +417,6 @@ end:
        return handle;
 }
 
-LTTNG_HIDDEN
 struct lttng_directory_handle *lttng_directory_handle_create(
                const char *path)
 {
@@ -465,7 +464,6 @@ end:
        return new_handle;
 }
 
-LTTNG_HIDDEN
 struct lttng_directory_handle *lttng_directory_handle_create_from_handle(
                const char *path,
                const struct lttng_directory_handle *ref_handle)
@@ -477,7 +475,7 @@ struct lttng_directory_handle *lttng_directory_handle_create_from_handle(
        struct lttng_directory_handle *new_handle = NULL;
        char *new_path = NULL;
 
-       assert(ref_handle && ref_handle->base_path);
+       LTTNG_ASSERT(ref_handle && ref_handle->base_path);
 
        ret = lttng_directory_handle_stat(ref_handle, path, &stat_buf);
        if (ret == -1) {
@@ -549,11 +547,10 @@ end:
        return new_handle;
 }
 
-LTTNG_HIDDEN
 struct lttng_directory_handle *lttng_directory_handle_create_from_dirfd(
                int dirfd)
 {
-       assert(dirfd == AT_FDCWD);
+       LTTNG_ASSERT(dirfd == AT_FDCWD);
        return lttng_directory_handle_create(NULL);
 }
 
@@ -568,7 +565,6 @@ void lttng_directory_handle_release(struct urcu_ref *ref)
        free(handle);
 }
 
-LTTNG_HIDDEN
 struct lttng_directory_handle *lttng_directory_handle_copy(
                const struct lttng_directory_handle *handle)
 {
@@ -586,11 +582,10 @@ end:
        return new_handle;
 }
 
-LTTNG_HIDDEN
 bool lttng_directory_handle_equals(const struct lttng_directory_handle *lhs,
                const struct lttng_directory_handle *rhs)
 {
-       return strcmp(lhs->path, rhs->path) == 0;
+       return strcmp(lhs->base_path, rhs->base_path) == 0;
 }
 
 static
@@ -599,7 +594,6 @@ void lttng_directory_handle_invalidate(struct lttng_directory_handle *handle)
        handle->base_path = NULL;
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_stat(const struct lttng_directory_handle *handle,
                const char *subdirectory, struct stat *st)
 {
@@ -617,6 +611,12 @@ end:
        return ret;
 }
 
+bool lttng_directory_handle_uses_fd(
+               const struct lttng_directory_handle *handle)
+{
+       return false;
+}
+
 static
 int lttng_directory_handle_mkdir(const struct lttng_directory_handle *handle,
                const char *subdirectory, mode_t mode)
@@ -876,7 +876,7 @@ end:
        return ret;
 }
 
-#endif /* COMPAT_DIRFD */
+#endif /* HAVE_DIRFD */
 
 /* Common implementation. */
 
@@ -928,7 +928,7 @@ int create_directory_recursive(const struct lttng_directory_handle *handle,
        size_t len;
        int ret;
 
-       assert(path);
+       LTTNG_ASSERT(path);
 
        ret = lttng_strncpy(tmp, path, sizeof(tmp));
        if (ret) {
@@ -975,23 +975,20 @@ error:
        return ret;
 }
 
-LTTNG_HIDDEN
 bool lttng_directory_handle_get(struct lttng_directory_handle *handle)
 {
        return urcu_ref_get_unless_zero(&handle->ref);
 }
 
-LTTNG_HIDDEN
 void lttng_directory_handle_put(struct lttng_directory_handle *handle)
 {
        if (!handle) {
                return;
        }
-       assert(handle->ref.refcount);
+       LTTNG_ASSERT(handle->ref.refcount);
        urcu_ref_put(&handle->ref, lttng_directory_handle_release);
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_create_subdirectory_as_user(
                const struct lttng_directory_handle *handle,
                const char *subdirectory,
@@ -1004,14 +1001,14 @@ int lttng_directory_handle_create_subdirectory_as_user(
                ret = create_directory_check_exists(handle,
                                subdirectory, mode);
        } else {
-               ret = _run_as_mkdir(handle, subdirectory,
-                               mode, creds->uid, creds->gid);
+               ret = _run_as_mkdir(handle, subdirectory, mode,
+                               lttng_credentials_get_uid(creds),
+                               lttng_credentials_get_gid(creds));
        }
 
        return ret;
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_create_subdirectory_recursive_as_user(
                const struct lttng_directory_handle *handle,
                const char *subdirectory_path,
@@ -1025,13 +1022,12 @@ int lttng_directory_handle_create_subdirectory_recursive_as_user(
                                subdirectory_path, mode);
        } else {
                ret = _run_as_mkdir_recursive(handle, subdirectory_path,
-                               mode, creds->uid, creds->gid);
+                               mode, lttng_credentials_get_uid(creds), lttng_credentials_get_gid(creds));
        }
 
        return ret;
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_create_subdirectory(
                const struct lttng_directory_handle *handle,
                const char *subdirectory,
@@ -1041,7 +1037,6 @@ int lttng_directory_handle_create_subdirectory(
                        handle, subdirectory, mode, NULL);
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_create_subdirectory_recursive(
                const struct lttng_directory_handle *handle,
                const char *subdirectory_path,
@@ -1051,7 +1046,6 @@ int lttng_directory_handle_create_subdirectory_recursive(
                        handle, subdirectory_path, mode, NULL);
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_open_file_as_user(
                const struct lttng_directory_handle *handle,
                const char *filename,
@@ -1066,12 +1060,11 @@ int lttng_directory_handle_open_file_as_user(
                                mode);
        } else {
                ret = _run_as_open(handle, filename, flags, mode,
-                               creds->uid, creds->gid);
+                               lttng_credentials_get_uid(creds), lttng_credentials_get_gid(creds));
        }
        return ret;
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_open_file(
                const struct lttng_directory_handle *handle,
                const char *filename,
@@ -1081,7 +1074,6 @@ int lttng_directory_handle_open_file(
                        mode, NULL);
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_unlink_file_as_user(
                const struct lttng_directory_handle *handle,
                const char *filename,
@@ -1093,12 +1085,11 @@ int lttng_directory_handle_unlink_file_as_user(
                /* Run as current user. */
                ret = lttng_directory_handle_unlink(handle, filename);
        } else {
-               ret = _run_as_unlink(handle, filename, creds->uid, creds->gid);
+               ret = _run_as_unlink(handle, filename, lttng_credentials_get_uid(creds), lttng_credentials_get_gid(creds));
        }
        return ret;
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_unlink_file(
                const struct lttng_directory_handle *handle,
                const char *filename)
@@ -1107,7 +1098,6 @@ int lttng_directory_handle_unlink_file(
                        filename, NULL);
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_rename(
                const struct lttng_directory_handle *old_handle,
                const char *old_name,
@@ -1118,7 +1108,6 @@ int lttng_directory_handle_rename(
                        new_handle, new_name, NULL);
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_rename_as_user(
                const struct lttng_directory_handle *old_handle,
                const char *old_name,
@@ -1134,12 +1123,11 @@ int lttng_directory_handle_rename_as_user(
                                old_name, new_handle, new_name);
        } else {
                ret = _run_as_rename(old_handle, old_name, new_handle,
-                               new_name, creds->uid, creds->gid);
+                               new_name, lttng_credentials_get_uid(creds), lttng_credentials_get_gid(creds));
        }
        return ret;
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_remove_subdirectory(
                const struct lttng_directory_handle *handle,
                const char *name)
@@ -1148,7 +1136,6 @@ int lttng_directory_handle_remove_subdirectory(
                        NULL);
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_remove_subdirectory_as_user(
                const struct lttng_directory_handle *handle,
                const char *name,
@@ -1160,7 +1147,7 @@ int lttng_directory_handle_remove_subdirectory_as_user(
                /* Run as current user. */
                ret = lttng_directory_handle_rmdir(handle, name);
        } else {
-               ret = _run_as_rmdir(handle, name, creds->uid, creds->gid);
+               ret = _run_as_rmdir(handle, name, lttng_credentials_get_uid(creds), lttng_credentials_get_gid(creds));
        }
        return ret;
 }
@@ -1246,10 +1233,10 @@ int remove_directory_recursive(const struct lttng_directory_handle *handle,
                                lttng_dynamic_array_get_element(
                                                &frames, current_frame_idx);
 
-               assert(current_frame->dir);
+               LTTNG_ASSERT(current_frame->dir);
                ret = lttng_dynamic_buffer_set_size(
                                &current_path, current_frame->path_size);
-               assert(!ret);
+               LTTNG_ASSERT(!ret);
                current_path.data[current_path.size - 1] = '\0';
 
                while ((entry = readdir(current_frame->dir))) {
@@ -1263,7 +1250,7 @@ int remove_directory_recursive(const struct lttng_directory_handle *handle,
                        /* Set current_path to the entry's path. */
                        ret = lttng_dynamic_buffer_set_size(
                                        &current_path, current_path.size - 1);
-                       assert(!ret);
+                       LTTNG_ASSERT(!ret);
                        ret = lttng_dynamic_buffer_append(&current_path,
                                        &separator, sizeof(separator));
                        if (ret) {
@@ -1354,7 +1341,7 @@ int remove_directory_recursive(const struct lttng_directory_handle *handle,
 
                        parent_frame = lttng_dynamic_array_get_element(&frames,
                                        current_frame->parent_frame_idx);
-                       assert(parent_frame);
+                       LTTNG_ASSERT(parent_frame);
                        parent_frame->empty = false;
                }
                ret = lttng_dynamic_array_remove_element(
@@ -1371,7 +1358,6 @@ end:
        return ret;
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_remove_subdirectory_recursive(
                const struct lttng_directory_handle *handle,
                const char *name,
@@ -1381,7 +1367,6 @@ int lttng_directory_handle_remove_subdirectory_recursive(
                        handle, name, NULL, flags);
 }
 
-LTTNG_HIDDEN
 int lttng_directory_handle_remove_subdirectory_recursive_as_user(
                const struct lttng_directory_handle *handle,
                const char *name,
@@ -1394,8 +1379,8 @@ int lttng_directory_handle_remove_subdirectory_recursive_as_user(
                /* Run as current user. */
                ret = remove_directory_recursive(handle, name, flags);
        } else {
-               ret = _run_as_rmdir_recursive(handle, name, creds->uid,
-                               creds->gid, flags);
+               ret = _run_as_rmdir_recursive(handle, name, lttng_credentials_get_uid(creds),
+                               lttng_credentials_get_gid(creds), flags);
        }
        return ret;
 }
This page took 0.03 seconds and 4 git commands to generate.