Add rmdirat and renameat to run-as commands
[lttng-tools.git] / src / common / compat / directory-handle.h
CommitLineData
18710679
JG
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
32struct lttng_directory_handle {
33 int dirfd;
34};
facc1162
JG
35
36static inline
37int lttng_directory_handle_get_dirfd(
38 const struct lttng_directory_handle *handle)
39{
40 return handle->dirfd;
41}
42
18710679
JG
43#else
44struct lttng_directory_handle {
45 char *base_path;
46};
47#endif
48
49/*
50 * Initialize a directory handle to the provided path. Passing a NULL path
fd774fc6 51 * returns a handle to the current working directory.
18710679
JG
52 *
53 * An initialized directory handle must be finalized using
54 * lttng_directory_handle_fini().
55 */
56LTTNG_HIDDEN
57int lttng_directory_handle_init(struct lttng_directory_handle *handle,
58 const char *path);
59
fd774fc6
JG
60/*
61 * Initialize a new directory handle to a path relative to an existing handle.
62 *
63 * The provided path must already exist. Note that the creation of a
64 * subdirectory and the creation of a handle are kept as separate operations
65 * to highlight the fact that there is an inherent race between the creation of
66 * a directory and the creation of a handle to it.
67 *
68 * Passing a NULL path effectively copies the original handle.
69 *
70 * An initialized directory handle must be finalized using
71 * lttng_directory_handle_fini().
72 */
73LTTNG_HIDDEN
74int lttng_directory_handle_init_from_handle(
75 struct lttng_directory_handle *new_handle,
76 const char *path,
77 const struct lttng_directory_handle *handle);
78
15d59b1d
JG
79/*
80 * Initialize a new directory handle from an existing directory fd.
81 *
82 * The new directory handle assumes the ownership of the directory fd.
83 * Note that this method should only be used in very specific cases, such as
84 * re-creating a directory handle from a dirfd passed over a unix socket.
85 *
86 * An initialized directory handle must be finalized using
87 * lttng_directory_handle_fini().
88 */
18710679
JG
89LTTNG_HIDDEN
90int lttng_directory_handle_init_from_dirfd(
91 struct lttng_directory_handle *handle, int dirfd);
92
578e21bd
JG
93/*
94 * Copy a directory handle.
95 */
96LTTNG_HIDDEN
97int lttng_directory_handle_copy(const struct lttng_directory_handle *handle,
98 struct lttng_directory_handle *new_copy);
99
46307ffe
JG
100/*
101 * Move a directory handle. The original directory handle may no longer be
102 * used after this call. This call cannot fail; directly assign the
103 * return value to the new directory handle.
104 *
105 * It is safe (but unnecessary) to call lttng_directory_handle_fini on the
106 * original handle.
107 */
108LTTNG_HIDDEN
109struct lttng_directory_handle
110lttng_directory_handle_move(struct lttng_directory_handle *original);
111
18710679
JG
112/*
113 * Release the resources of a directory handle.
114 */
115LTTNG_HIDDEN
116void lttng_directory_handle_fini(struct lttng_directory_handle *handle);
117
118/*
119 * Create a subdirectory relative to a directory handle.
120 */
121LTTNG_HIDDEN
122int lttng_directory_handle_create_subdirectory(
123 const struct lttng_directory_handle *handle,
124 const char *subdirectory,
125 mode_t mode);
126
127/*
128 * Create a subdirectory relative to a directory handle
129 * as a given user.
130 */
131LTTNG_HIDDEN
132int lttng_directory_handle_create_subdirectory_as_user(
133 const struct lttng_directory_handle *handle,
134 const char *subdirectory,
69e3a560 135 mode_t mode, const struct lttng_credentials *creds);
18710679
JG
136
137/*
138 * Recursively create a directory relative to a directory handle.
139 */
140LTTNG_HIDDEN
141int lttng_directory_handle_create_subdirectory_recursive(
142 const struct lttng_directory_handle *handle,
143 const char *subdirectory_path,
144 mode_t mode);
145
146/*
147 * Recursively create a directory relative to a directory handle
148 * as a given user.
149 */
150LTTNG_HIDDEN
151int lttng_directory_handle_create_subdirectory_recursive_as_user(
152 const struct lttng_directory_handle *handle,
153 const char *subdirectory_path,
69e3a560 154 mode_t mode, const struct lttng_credentials *creds);
18710679 155
2912cead
JG
156LTTNG_HIDDEN
157int lttng_directory_handle_open_file(
158 const struct lttng_directory_handle *handle,
159 const char *filename,
160 int flags, mode_t mode);
161
162LTTNG_HIDDEN
163int lttng_directory_handle_open_file_as_user(
164 const struct lttng_directory_handle *handle,
165 const char *filename,
166 int flags, mode_t mode,
167 const struct lttng_credentials *creds);
168
169LTTNG_HIDDEN
170int lttng_directory_handle_unlink_file(
171 const struct lttng_directory_handle *handle,
172 const char *filename);
173
174LTTNG_HIDDEN
175int lttng_directory_handle_unlink_file_as_user(
176 const struct lttng_directory_handle *handle,
177 const char *filename,
178 const struct lttng_credentials *creds);
179
d2956687
JG
180LTTNG_HIDDEN
181int lttng_directory_handle_rename(
93bed9fe
JG
182 const struct lttng_directory_handle *old_handle,
183 const char *old_name,
184 const struct lttng_directory_handle *new_handle,
185 const char *new_name);
d2956687
JG
186
187LTTNG_HIDDEN
188int lttng_directory_handle_rename_as_user(
93bed9fe
JG
189 const struct lttng_directory_handle *old_handle,
190 const char *old_name,
191 const struct lttng_directory_handle *new_handle,
192 const char *new_name,
d2956687
JG
193 const struct lttng_credentials *creds);
194
195LTTNG_HIDDEN
93bed9fe 196int lttng_directory_handle_remove_subdirectory(
d2956687
JG
197 const struct lttng_directory_handle *handle,
198 const char *name);
199
200LTTNG_HIDDEN
93bed9fe 201int lttng_directory_handle_remove_subdirectory_as_user(
d2956687
JG
202 const struct lttng_directory_handle *handle,
203 const char *name,
204 const struct lttng_credentials *creds);
205
206LTTNG_HIDDEN
93bed9fe 207int lttng_directory_handle_remove_subdirectory_recursive(
d2956687
JG
208 const struct lttng_directory_handle *handle,
209 const char *name);
210
211LTTNG_HIDDEN
93bed9fe 212int lttng_directory_handle_remove_subdirectory_recursive_as_user(
d2956687
JG
213 const struct lttng_directory_handle *handle,
214 const char *name,
215 const struct lttng_credentials *creds);
216
18710679 217#endif /* _COMPAT_PATH_HANDLE_H */
This page took 0.042527 seconds and 4 git commands to generate.