src/common/fd-tracker/utils.h

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