src/common/fd-tracker/inode.h

   1 /*
   2  * Copyright (C) 2020 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-only
   5  *
   6  */
   7
   8 #ifndef FD_TRACKER_INODE_H
   9 #define FD_TRACKER_INODE_H
  10
  11 #include <common/compat/directory-handle.h>
  12 #include <stdbool.h>
  13
  14 struct lttng_inode;
  15 struct lttng_inode_registry;
  16 struct lttng_unlinked_file_directory;
  17 struct lttng_directory_handle;
  18
  19 /*
  20  * The unlinked file pool is protected by the fd-tracker's lock.
  21  *
  22  * NOTE: the unlinked file pool can use a single file desriptor when unlinked
  23  * files are present in the pool. This file descriptor is not accounted-for
  24  * by the fd-tracker. Users of the fd-tracker should account for this extra
  25  * file descriptor.
  26  */
  27 LTTNG_HIDDEN
  28 struct lttng_unlinked_file_pool *lttng_unlinked_file_pool_create(
  29                 const char *path);
  30
  31 LTTNG_HIDDEN
  32 void lttng_unlinked_file_pool_destroy(
  33                 struct lttng_unlinked_file_pool *pool);
  34
  35 /* The inode registry is protected by the fd-tracker's lock. */
  36 LTTNG_HIDDEN
  37 struct lttng_inode_registry *lttng_inode_registry_create(void);
  38
  39 LTTNG_HIDDEN
  40 struct lttng_inode *lttng_inode_registry_get_inode(
  41                 struct lttng_inode_registry *registry,
  42                 struct lttng_directory_handle *handle,
  43                 const char *path,
  44                 int fd,
  45                 struct lttng_unlinked_file_pool *pool);
  46
  47 LTTNG_HIDDEN
  48 void lttng_inode_registry_destroy(struct lttng_inode_registry *registry);
  49
  50 LTTNG_HIDDEN
  51 void lttng_inode_borrow_location(struct lttng_inode *inode,
  52                 const struct lttng_directory_handle **out_directory_handle,
  53                 const char **out_path);
  54
  55 /* Returns a new reference to the inode's location directory handle. */
  56 LTTNG_HIDDEN
  57 struct lttng_directory_handle *lttng_inode_get_location_directory_handle(
  58                 struct lttng_inode *inode);
  59
  60 LTTNG_HIDDEN
  61 int lttng_inode_rename(struct lttng_inode *inode,
  62                 struct lttng_directory_handle *old_directory_handle,
  63                 const char *old_path,
  64                 struct lttng_directory_handle *new_directory_handle,
  65                 const char *new_path,
  66                 bool overwrite);
  67
  68 LTTNG_HIDDEN
  69 int lttng_inode_unlink(struct lttng_inode *inode);
  70
  71 LTTNG_HIDDEN
  72 void lttng_inode_put(struct lttng_inode *inode);
  73
  74 #endif /* FD_TRACKER_INODE_H */