Document lttng_directory_handle_init_from_dirfd

[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 a24bbd8db9ffaff76eba111a81b9fd2cc5be2098..12191809471f9f4e183b1dece7196ac9774793b0 100644 (file)
--- a/src/common/compat/directory-handle.h
+++ b/src/common/compat/directory-handle.h
@@ -51,10 +51,39 @@ LTTNG_HIDDEN
 int lttng_directory_handle_init(struct lttng_directory_handle *handle,
                const char *path);
 
+/*
+ * Initialize 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().
+ */
 LTTNG_HIDDEN
 int lttng_directory_handle_init_from_dirfd(
                struct lttng_directory_handle *handle, int dirfd);
 
+/*
+ * Copy a directory handle.
+ */
+LTTNG_HIDDEN
+int lttng_directory_handle_copy(const struct lttng_directory_handle *handle,
+               struct lttng_directory_handle *new_copy);
+
+/*
+ * 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.
+ */
+LTTNG_HIDDEN
+struct lttng_directory_handle
+lttng_directory_handle_move(struct lttng_directory_handle *original);
+
 /*
  * Release the resources of a directory handle.
  */
@@ -78,7 +107,7 @@ LTTNG_HIDDEN
 int lttng_directory_handle_create_subdirectory_as_user(
                const struct lttng_directory_handle *handle,
                const char *subdirectory,
-               mode_t mode, struct lttng_credentials *creds);
+               mode_t mode, const struct lttng_credentials *creds);
 
 /*
  * Recursively create a directory relative to a directory handle.
@@ -97,6 +126,6 @@ LTTNG_HIDDEN
 int lttng_directory_handle_create_subdirectory_recursive_as_user(
                const struct lttng_directory_handle *handle,
                const char *subdirectory_path,
-               mode_t mode, struct lttng_credentials *creds);
+               mode_t mode, const struct lttng_credentials *creds);
 
 #endif /* _COMPAT_PATH_HANDLE_H */