src/common/compat/directory-handle.h

   1 /*
   2  * Copyright (C) 2019 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License, version 2 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  11  * more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #ifndef _COMPAT_DIRECTORY_HANDLE_H
  19 #define _COMPAT_DIRECTORY_HANDLE_H
  20
  21 #include <common/macros.h>
  22 #include <common/credentials.h>
  23
  24 /*
  25  * Some platforms, such as Solaris 10, do not support directory file descriptors
  26  * and their associated functions (*at(...)), which are defined in POSIX.2008.
  27  *
  28  * This wrapper provides a handle that is either a copy of a directory's path
  29  * or a directory file descriptors, depending on the platform's capabilities.
  30  */
  31 #ifdef COMPAT_DIRFD
  32 struct lttng_directory_handle {
  33         int dirfd;
  34 };
  35 #else
  36 struct lttng_directory_handle {
  37         char *base_path;
  38 };
  39 #endif
  40
  41 /*
  42  * Initialize a directory handle to the provided path. Passing a NULL path
  43  * returns a handle to the current working directory. The working directory
  44  * is not sampled; it will be accessed at the time of use of the functions
  45  * of this API.
  46  *
  47  * An initialized directory handle must be finalized using
  48  * lttng_directory_handle_fini().
  49  */
  50 LTTNG_HIDDEN
  51 int lttng_directory_handle_init(struct lttng_directory_handle *handle,
  52                 const char *path);
  53
  54 LTTNG_HIDDEN
  55 int lttng_directory_handle_init_from_dirfd(
  56                 struct lttng_directory_handle *handle, int dirfd);
  57
  58 /*
  59  * Copy a directory handle.
  60  */
  61 LTTNG_HIDDEN
  62 int lttng_directory_handle_copy(const struct lttng_directory_handle *handle,
  63                 struct lttng_directory_handle *new_copy);
  64
  65 /*
  66  * Move a directory handle. The original directory handle may no longer be
  67  * used after this call. This call cannot fail; directly assign the
  68  * return value to the new directory handle.
  69  *
  70  * It is safe (but unnecessary) to call lttng_directory_handle_fini on the
  71  * original handle.
  72  */
  73 LTTNG_HIDDEN
  74 struct lttng_directory_handle
  75 lttng_directory_handle_move(struct lttng_directory_handle *original);
  76
  77 /*
  78  * Release the resources of a directory handle.
  79  */
  80 LTTNG_HIDDEN
  81 void lttng_directory_handle_fini(struct lttng_directory_handle *handle);
  82
  83 /*
  84  * Create a subdirectory relative to a directory handle.
  85  */
  86 LTTNG_HIDDEN
  87 int lttng_directory_handle_create_subdirectory(
  88                 const struct lttng_directory_handle *handle,
  89                 const char *subdirectory,
  90                 mode_t mode);
  91
  92 /*
  93  * Create a subdirectory relative to a directory handle
  94  * as a given user.
  95  */
  96 LTTNG_HIDDEN
  97 int lttng_directory_handle_create_subdirectory_as_user(
  98                 const struct lttng_directory_handle *handle,
  99                 const char *subdirectory,
 100                 mode_t mode, const struct lttng_credentials *creds);
 101
 102 /*
 103  * Recursively create a directory relative to a directory handle.
 104  */
 105 LTTNG_HIDDEN
 106 int lttng_directory_handle_create_subdirectory_recursive(
 107                 const struct lttng_directory_handle *handle,
 108                 const char *subdirectory_path,
 109                 mode_t mode);
 110
 111 /*
 112  * Recursively create a directory relative to a directory handle
 113  * as a given user.
 114  */
 115 LTTNG_HIDDEN
 116 int lttng_directory_handle_create_subdirectory_recursive_as_user(
 117                 const struct lttng_directory_handle *handle,
 118                 const char *subdirectory_path,
 119                 mode_t mode, const struct lttng_credentials *creds);
 120
 121 #endif /* _COMPAT_PATH_HANDLE_H */