X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Fcompat%2Fdirectory-handle.h;h=0ad5c851072ab68de75788aeeb42c657dbd19e8c;hp=12191809471f9f4e183b1dece7196ac9774793b0;hb=0e98551307eb5a7a59cc74982b386dc95f4c4f89;hpb=15d59b1d535b95f021671f441534097b4cd72031

diff --git a/src/common/compat/directory-handle.h b/src/common/compat/directory-handle.h
index 121918094..0ad5c8510 100644
--- a/src/common/compat/directory-handle.h
+++ b/src/common/compat/directory-handle.h
@@ -20,6 +20,12 @@
 
 #include <common/macros.h>
 #include <common/credentials.h>
+#include <urcu/ref.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
@@ -30,65 +36,89 @@
  */
 #ifdef COMPAT_DIRFD
 struct lttng_directory_handle {
+	struct urcu_ref ref;
+	ino_t directory_inode;
 	int dirfd;
 };
+
+static inline
+int lttng_directory_handle_get_dirfd(
+		const struct lttng_directory_handle *handle)
+{
+	return handle->dirfd;
+}
+
 #else
 struct lttng_directory_handle {
+	struct urcu_ref ref;
 	char *base_path;
 };
 #endif
 
 /*
- * 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.
+ * Create a directory handle to the provided path. Passing a NULL path
+ * returns a handle to the current working directory.
  *
- * An initialized directory handle must be finalized using
- * lttng_directory_handle_fini().
+ * The reference to the directory handle must be released using
+ * lttng_directory_handle_put().
  */
 LTTNG_HIDDEN
-int lttng_directory_handle_init(struct lttng_directory_handle *handle,
+struct lttng_directory_handle *lttng_directory_handle_create(
 		const char *path);
 
 /*
- * Initialize a new directory handle from an existing directory fd.
+ * Create 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.
+ *
+ * The reference to the directory handle must be released using
+ * lttng_directory_handle_put().
+ */
+LTTNG_HIDDEN
+struct lttng_directory_handle *lttng_directory_handle_create_from_handle(
+		const char *path,
+		const struct lttng_directory_handle *ref_handle);
+
+/*
+ * Create a new directory handle from an existing directory fd.
  *
  * The new directory handle assumes the ownership of the directory fd.
  * Note that this method should only be used in very specific cases, such as
  * re-creating a directory handle from a dirfd passed over a unix socket.
  *
- * An initialized directory handle must be finalized using
- * lttng_directory_handle_fini().
+ * The reference to the directory handle must be released using
+ * lttng_directory_handle_put().
  */
 LTTNG_HIDDEN
-int lttng_directory_handle_init_from_dirfd(
-		struct lttng_directory_handle *handle, int dirfd);
+struct lttng_directory_handle *lttng_directory_handle_create_from_dirfd(
+		int dirfd);
 
 /*
  * Copy a directory handle.
+ *
+ * The reference to the directory handle must be released using
+ * lttng_directory_handle_put().
  */
 LTTNG_HIDDEN
-int lttng_directory_handle_copy(const struct lttng_directory_handle *handle,
-		struct lttng_directory_handle *new_copy);
+struct lttng_directory_handle *lttng_directory_handle_copy(
+		const struct lttng_directory_handle *handle);
 
 /*
- * Move a directory handle. The original directory handle may no longer be
- * used after this call. This call cannot fail; directly assign the
- * return value to the new directory handle.
- *
- * It is safe (but unnecessary) to call lttng_directory_handle_fini on the
- * original handle.
+ * Acquire a reference to a directory handle.
  */
 LTTNG_HIDDEN
-struct lttng_directory_handle
-lttng_directory_handle_move(struct lttng_directory_handle *original);
+bool lttng_directory_handle_get(struct lttng_directory_handle *handle);
 
 /*
- * Release the resources of a directory handle.
+ * Release a reference to a directory handle.
  */
 LTTNG_HIDDEN
-void lttng_directory_handle_fini(struct lttng_directory_handle *handle);
+void lttng_directory_handle_put(struct lttng_directory_handle *handle);
 
 /*
  * Create a subdirectory relative to a directory handle.
@@ -128,4 +158,112 @@ 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);
+
+/*
+ * Compare two directory handles.
+ *
+ * Returns true if the two directory handles are equal, false otherwise.
+ */
+LTTNG_HIDDEN
+bool lttng_directory_handle_equals(const struct lttng_directory_handle *lhs,
+		const struct lttng_directory_handle *rhs);
+
 #endif /* _COMPAT_PATH_HANDLE_H */