Fix: rmdir recursive: skip non-empty directories with flag

[lttng-tools.git] / src / common / compat / directory-handle.h

diff --git a/src/common/compat/directory-handle.h b/src/common/compat/directory-handle.h
index 12191809471f9f4e183b1dece7196ac9774793b0..26da76bcc7d7a751971adee30a9cd252f2235a84 100644 (file)
--- a/src/common/compat/directory-handle.h
+++ b/src/common/compat/directory-handle.h
@@ -21,6 +21,11 @@
 #include <common/macros.h>
 #include <common/credentials.h>
 
+enum lttng_directory_handle_rmdir_recursive_flags {
+       LTTNG_DIRECTORY_HANDLE_FAIL_NON_EMPTY_FLAG = (1U << 0),
+       LTTNG_DIRECTORY_HANDLE_SKIP_NON_EMPTY_FLAG = (1U << 1),
+};
+
 /*
  * Some platforms, such as Solaris 10, do not support directory file descriptors
  * and their associated functions (*at(...)), which are defined in POSIX.2008.
@@ -32,6 +37,14 @@
 struct lttng_directory_handle {
        int dirfd;
 };
+
+static inline
+int lttng_directory_handle_get_dirfd(
+               const struct lttng_directory_handle *handle)
+{
+       return handle->dirfd;
+}
+
 #else
 struct lttng_directory_handle {
        char *base_path;
@@ -40,9 +53,7 @@ struct lttng_directory_handle {
 
 /*
  * Initialize a directory handle to the provided path. Passing a NULL path
- * returns a handle to the current working directory. The working directory
- * is not sampled; it will be accessed at the time of use of the functions
- * of this API.
+ * returns a handle to the current working directory.
  *
  * An initialized directory handle must be finalized using
  * lttng_directory_handle_fini().
@@ -51,6 +62,25 @@ LTTNG_HIDDEN
 int lttng_directory_handle_init(struct lttng_directory_handle *handle,
                const char *path);
 
+/*
+ * Initialize a new directory handle to a path relative to an existing handle.
+ *
+ * The provided path must already exist. Note that the creation of a
+ * subdirectory and the creation of a handle are kept as separate operations
+ * to highlight the fact that there is an inherent race between the creation of
+ * a directory and the creation of a handle to it.
+ *
+ * Passing a NULL path effectively copies the original handle.
+ *
+ * An initialized directory handle must be finalized using
+ * lttng_directory_handle_fini().
+ */
+LTTNG_HIDDEN
+int lttng_directory_handle_init_from_handle(
+               struct lttng_directory_handle *new_handle,
+               const char *path,
+               const struct lttng_directory_handle *handle);
+
 /*
  * Initialize a new directory handle from an existing directory fd.
  *
@@ -128,4 +158,103 @@ int lttng_directory_handle_create_subdirectory_recursive_as_user(
                const char *subdirectory_path,
                mode_t mode, const struct lttng_credentials *creds);
 
+/*
+ * Open a file descriptor to a path relative to a directory handle.
+ */
+LTTNG_HIDDEN
+int lttng_directory_handle_open_file(
+               const struct lttng_directory_handle *handle,
+               const char *filename,
+               int flags, mode_t mode);
+
+/*
+ * Open a file descriptor to a path relative to a directory handle
+ * as a given user.
+ */
+LTTNG_HIDDEN
+int lttng_directory_handle_open_file_as_user(
+               const struct lttng_directory_handle *handle,
+               const char *filename,
+               int flags, mode_t mode,
+               const struct lttng_credentials *creds);
+
+/*
+ * Unlink a file to a path relative to a directory handle.
+ */
+LTTNG_HIDDEN
+int lttng_directory_handle_unlink_file(
+               const struct lttng_directory_handle *handle,
+               const char *filename);
+
+/*
+ * Unlink a file to a path relative to a directory handle as a given user.
+ */
+LTTNG_HIDDEN
+int lttng_directory_handle_unlink_file_as_user(
+               const struct lttng_directory_handle *handle,
+               const char *filename,
+               const struct lttng_credentials *creds);
+
+/*
+ * Rename a file from a path relative to a directory handle to a new
+ * name relative to another directory handle.
+ */
+LTTNG_HIDDEN
+int lttng_directory_handle_rename(
+               const struct lttng_directory_handle *old_handle,
+               const char *old_name,
+               const struct lttng_directory_handle *new_handle,
+               const char *new_name);
+
+/*
+ * Rename a file from a path relative to a directory handle to a new
+ * name relative to another directory handle as a given user.
+ */
+LTTNG_HIDDEN
+int lttng_directory_handle_rename_as_user(
+               const struct lttng_directory_handle *old_handle,
+               const char *old_name,
+               const struct lttng_directory_handle *new_handle,
+               const char *new_name,
+               const struct lttng_credentials *creds);
+
+/*
+ * Remove a subdirectory relative to a directory handle.
+ */
+LTTNG_HIDDEN
+int lttng_directory_handle_remove_subdirectory(
+               const struct lttng_directory_handle *handle,
+               const char *name);
+
+/*
+ * Remove a subdirectory relative to a directory handle as a given user.
+ */
+LTTNG_HIDDEN
+int lttng_directory_handle_remove_subdirectory_as_user(
+               const struct lttng_directory_handle *handle,
+               const char *name,
+               const struct lttng_credentials *creds);
+
+/*
+ * Remove a subdirectory and remove its contents if it only
+ * consists in empty directories.
+ * @flags: enum lttng_directory_handle_rmdir_recursive_flags
+ */
+LTTNG_HIDDEN
+int lttng_directory_handle_remove_subdirectory_recursive(
+               const struct lttng_directory_handle *handle,
+               const char *name, int flags);
+
+/*
+ * Remove a subdirectory and remove its contents if it only
+ * consists in empty directories as a given user.
+ * @flags: enum lttng_directory_handle_rmdir_recursive_flags
+ */
+LTTNG_HIDDEN
+int lttng_directory_handle_remove_subdirectory_recursive_as_user(
+               const struct lttng_directory_handle *handle,
+               const char *name,
+               const struct lttng_credentials *creds,
+               int flags);
+
 #endif /* _COMPAT_PATH_HANDLE_H */