X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=src%2Fcommon%2Fcompat%2Fdirectory-handle.h;h=26da76bcc7d7a751971adee30a9cd252f2235a84;hb=c70636a7342f34e3be68fcf411cf3e3718b8e73f;hp=cc5c4cdd62cc40ca979b991b3c89f26e2064af5f;hpb=93bed9fe8f48c11b7bb1224db36d82404cea080d;p=lttng-tools.git

diff --git a/src/common/compat/directory-handle.h b/src/common/compat/directory-handle.h
index cc5c4cdd6..26da76bcc 100644
--- 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.
@@ -153,12 +158,19 @@ 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,
@@ -166,17 +178,27 @@ int lttng_directory_handle_open_file_as_user(
 		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,
@@ -184,6 +206,10 @@ int lttng_directory_handle_rename(
 		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,
@@ -192,26 +218,43 @@ int lttng_directory_handle_rename_as_user(
 		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);
+		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);
+		const struct lttng_credentials *creds,
+		int flags);
 
 #endif /* _COMPAT_PATH_HANDLE_H */