X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fcommon%2Ffd-tracker%2Ffd-tracker.h;h=348ac59638bc17ecec703b763129db6daaa8e336;hb=10615eee4887bd869ac85885afcffd030da350be;hp=b8082c9a7697f51eb9b2c7d30e3ef94610f6d450;hpb=9d16fc7fa401926b800c18124756d75b11b5b806;p=lttng-tools.git

diff --git a/src/common/fd-tracker/fd-tracker.h b/src/common/fd-tracker/fd-tracker.h
index b8082c9a7..348ac5963 100644
--- a/src/common/fd-tracker/fd-tracker.h
+++ b/src/common/fd-tracker/fd-tracker.h
@@ -1,23 +1,15 @@
 /*
- * Copyright (C) 2018 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2018 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License, version 2 only, as
- * published by the Free Software Foundation.
+ * SPDX-License-Identifier: GPL-2.0-only
  *
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
- * more details.
- *
- * You should have received a copy of the GNU General Public License along with
- * this program; if not, write to the Free Software Foundation, Inc., 51
- * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #ifndef FD_TRACKER_H
 #define FD_TRACKER_H
 
+#include <common/compat/directory-handle.h>
+#include <common/macros.h>
 #include <stdint.h>
 #include <sys/types.h>
 
@@ -52,10 +44,17 @@ typedef int (*fd_close_cb)(void *, int *in_fds);
  * Set the maximal number of fds that the process should be allowed to open at
  * any given time. This function must be called before any other of this
  * interface.
+ *
+ * The unlinked_file_path is an absolute path (which does not need to exist)
+ * under which unlinked files will be stored for as long as a reference to them
+ * is held.
  */
-struct fd_tracker *fd_tracker_create(unsigned int capacity);
+LTTNG_HIDDEN
+struct fd_tracker *fd_tracker_create(const char *unlinked_file_path,
+		unsigned int capacity);
 
 /* Returns an error if file descriptors are leaked. */
+LTTNG_HIDDEN
 int fd_tracker_destroy(struct fd_tracker *tracker);
 
 /*
@@ -80,8 +79,12 @@ int fd_tracker_destroy(struct fd_tracker *tracker);
  * (e.g. truncation) may react differently than if the file descriptor was kept
  * open.
  */
+LTTNG_HIDDEN
 struct fs_handle *fd_tracker_open_fs_handle(struct fd_tracker *tracker,
-		const char *path, int flags, mode_t *mode);
+		struct lttng_directory_handle *directory,
+		const char *path,
+		int flags,
+		mode_t *mode);
 
 /*
  * Open a tracked unsuspendable file descriptor.
@@ -103,11 +106,15 @@ struct fs_handle *fd_tracker_open_fs_handle(struct fd_tracker *tracker,
  * negative tracker-specific codes may be returned:
  *   - ENOMEM: allocation of a new entry failed,
  *   - EMFILE: too many unsuspendable fds are opened and the tracker can't
- *             accomodate the request for a new unsuspendable entry.
+ *             accommodates the request for a new unsuspendable entry.
  */
+LTTNG_HIDDEN
 int fd_tracker_open_unsuspendable_fd(struct fd_tracker *tracker,
-		int *out_fds, const char **names, unsigned int fd_count,
-		fd_open_cb open, void *data);
+		int *out_fds,
+		const char **names,
+		unsigned int fd_count,
+		fd_open_cb open,
+		void *data);
 
 /*
  * Close a tracked unsuspendable file descriptor.
@@ -124,13 +131,17 @@ int fd_tracker_open_unsuspendable_fd(struct fd_tracker *tracker,
  * Closed fds are set to -1 in the fds array which, in the event of an error,
  * allows the user to know which file descriptors are no longer being tracked.
  */
+LTTNG_HIDDEN
 int fd_tracker_close_unsuspendable_fd(struct fd_tracker *tracker,
-		int *fds, unsigned int fd_count, fd_close_cb close,
+		int *fds,
+		unsigned int fd_count,
+		fd_close_cb close,
 		void *data);
 
 /*
  * Log the contents of the fd_tracker.
  */
+LTTNG_HIDDEN
 void fd_tracker_log(struct fd_tracker *tracker);
 
 /*
@@ -148,12 +159,14 @@ void fd_tracker_log(struct fd_tracker *tracker);
  * Returns the fd on success, otherwise a negative value may be returned
  * if the restoration of the fd failed.
  */
+LTTNG_HIDDEN
 int fs_handle_get_fd(struct fs_handle *handle);
 
 /*
  * Used by the application to signify that it is no longer using the
  * underlying fd and that it may be suspended.
  */
+LTTNG_HIDDEN
 void fs_handle_put_fd(struct fs_handle *handle);
 
 /*
@@ -168,11 +181,13 @@ void fs_handle_put_fd(struct fs_handle *handle);
  * Returns 0 on success, otherwise a negative value will be returned
  * if the operation failed.
  */
+LTTNG_HIDDEN
 int fs_handle_unlink(struct fs_handle *handle);
 
 /*
  * Frees the handle and discards the underlying fd.
  */
+LTTNG_HIDDEN
 int fs_handle_close(struct fs_handle *handle);
 
 #endif /* FD_TRACKER_H */