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

diff --git a/src/common/compat/directory-handle.h b/src/common/compat/directory-handle.h
index ceebc941e..121918094 100644
--- a/src/common/compat/directory-handle.h
+++ b/src/common/compat/directory-handle.h
@@ -51,6 +51,16 @@ 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);
@@ -62,6 +72,18 @@ 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.
  */