src/common/fd-tracker/utils.hpp

   1 /*
   2  * Copyright (C) 2018 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-only
   5  *
   6  */
   7
   8 #ifndef FD_TRACKER_UTILS_H
   9 #define FD_TRACKER_UTILS_H
  10
  11 #include <common/compat/directory-handle.hpp>
  12 #include <common/fd-tracker/fd-tracker.hpp>
  13 #include <common/macros.hpp>
  14
  15 struct lttng_poll_event;
  16
  17 /*
  18  * Utility implementing a close_fd callback which receives one file descriptor
  19  * and closes it, returning close()'s return value.
  20  */
  21 int fd_tracker_util_close_fd(void *, int *fd);
  22
  23 /*
  24  * Create a pipe and track its underlying fds.
  25  */
  26 int fd_tracker_util_pipe_open_cloexec(
  27                 struct fd_tracker *tracker, const char *name, int *pipe);
  28 int fd_tracker_util_pipe_close(struct fd_tracker *tracker, int *pipe);
  29
  30 /*
  31  * Create a poll event and track its underlying fd, if applicable.
  32  */
  33 int fd_tracker_util_poll_create(struct fd_tracker *tracker,
  34                 const char *name,
  35                 struct lttng_poll_event *events,
  36                 int size,
  37                 int flags);
  38 int fd_tracker_util_poll_clean(
  39                 struct fd_tracker *tracker, struct lttng_poll_event *events);
  40
  41 struct lttng_directory_handle *fd_tracker_create_directory_handle(
  42                 struct fd_tracker *tracker, const char *path);
  43
  44 struct lttng_directory_handle *fd_tracker_create_directory_handle_from_handle(
  45                 struct fd_tracker *tracker,
  46                 struct lttng_directory_handle *handle,
  47                 const char *path);
  48
  49 #endif /* FD_TRACKER_UTILS_H */