Fix: rmdir recursive: skip non-empty directories with flag
[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
f75c5439
MD
24enum lttng_directory_handle_rmdir_recursive_flags {
25 LTTNG_DIRECTORY_HANDLE_FAIL_NON_EMPTY_FLAG = (1U << 0),
26 LTTNG_DIRECTORY_HANDLE_SKIP_NON_EMPTY_FLAG = (1U << 1),
27};
28
18710679
JG
29/*
30 * Some platforms, such as Solaris 10, do not support directory file descriptors
31 * and their associated functions (*at(...)), which are defined in POSIX.2008.
32 *
33 * This wrapper provides a handle that is either a copy of a directory's path
34 * or a directory file descriptors, depending on the platform's capabilities.
35 */
36#ifdef COMPAT_DIRFD
37struct lttng_directory_handle {
38 int dirfd;
39};
facc1162
JG
40
41static inline
42int lttng_directory_handle_get_dirfd(
43 const struct lttng_directory_handle *handle)
44{
45 return handle->dirfd;
46}
47
18710679
JG
48#else
49struct lttng_directory_handle {
50 char *base_path;
51};
52#endif
53
54/*
55 * Initialize a directory handle to the provided path. Passing a NULL path
fd774fc6 56 * returns a handle to the current working directory.
18710679
JG
57 *
58 * An initialized directory handle must be finalized using
59 * lttng_directory_handle_fini().
60 */
61LTTNG_HIDDEN
62int lttng_directory_handle_init(struct lttng_directory_handle *handle,
63 const char *path);
64
fd774fc6
JG
65/*
66 * Initialize a new directory handle to a path relative to an existing handle.
67 *
68 * The provided path must already exist. Note that the creation of a
69 * subdirectory and the creation of a handle are kept as separate operations
70 * to highlight the fact that there is an inherent race between the creation of
71 * a directory and the creation of a handle to it.
72 *
73 * Passing a NULL path effectively copies the original handle.
74 *
75 * An initialized directory handle must be finalized using
76 * lttng_directory_handle_fini().
77 */
78LTTNG_HIDDEN
79int lttng_directory_handle_init_from_handle(
80 struct lttng_directory_handle *new_handle,
81 const char *path,
82 const struct lttng_directory_handle *handle);
83
15d59b1d
JG
84/*
85 * Initialize a new directory handle from an existing directory fd.
86 *
87 * The new directory handle assumes the ownership of the directory fd.
88 * Note that this method should only be used in very specific cases, such as
89 * re-creating a directory handle from a dirfd passed over a unix socket.
90 *
91 * An initialized directory handle must be finalized using
92 * lttng_directory_handle_fini().
93 */
18710679
JG
94LTTNG_HIDDEN
95int lttng_directory_handle_init_from_dirfd(
96 struct lttng_directory_handle *handle, int dirfd);
97
578e21bd
JG
98/*
99 * Copy a directory handle.
100 */
101LTTNG_HIDDEN
102int lttng_directory_handle_copy(const struct lttng_directory_handle *handle,
103 struct lttng_directory_handle *new_copy);
104
46307ffe
JG
105/*
106 * Move a directory handle. The original directory handle may no longer be
107 * used after this call. This call cannot fail; directly assign the
108 * return value to the new directory handle.
109 *
110 * It is safe (but unnecessary) to call lttng_directory_handle_fini on the
111 * original handle.
112 */
113LTTNG_HIDDEN
114struct lttng_directory_handle
115lttng_directory_handle_move(struct lttng_directory_handle *original);
116
18710679
JG
117/*
118 * Release the resources of a directory handle.
119 */
120LTTNG_HIDDEN
121void lttng_directory_handle_fini(struct lttng_directory_handle *handle);
122
123/*
124 * Create a subdirectory relative to a directory handle.
125 */
126LTTNG_HIDDEN
127int lttng_directory_handle_create_subdirectory(
128 const struct lttng_directory_handle *handle,
129 const char *subdirectory,
130 mode_t mode);
131
132/*
133 * Create a subdirectory relative to a directory handle
134 * as a given user.
135 */
136LTTNG_HIDDEN
137int lttng_directory_handle_create_subdirectory_as_user(
138 const struct lttng_directory_handle *handle,
139 const char *subdirectory,
69e3a560 140 mode_t mode, const struct lttng_credentials *creds);
18710679
JG
141
142/*
143 * Recursively create a directory relative to a directory handle.
144 */
145LTTNG_HIDDEN
146int lttng_directory_handle_create_subdirectory_recursive(
147 const struct lttng_directory_handle *handle,
148 const char *subdirectory_path,
149 mode_t mode);
150
151/*
152 * Recursively create a directory relative to a directory handle
153 * as a given user.
154 */
155LTTNG_HIDDEN
156int lttng_directory_handle_create_subdirectory_recursive_as_user(
157 const struct lttng_directory_handle *handle,
158 const char *subdirectory_path,
69e3a560 159 mode_t mode, const struct lttng_credentials *creds);
18710679 160
642e96c6
JG
161/*
162 * Open a file descriptor to a path relative to a directory handle.
163 */
2912cead
JG
164LTTNG_HIDDEN
165int lttng_directory_handle_open_file(
166 const struct lttng_directory_handle *handle,
167 const char *filename,
168 int flags, mode_t mode);
169
642e96c6
JG
170/*
171 * Open a file descriptor to a path relative to a directory handle
172 * as a given user.
173 */
2912cead
JG
174LTTNG_HIDDEN
175int lttng_directory_handle_open_file_as_user(
176 const struct lttng_directory_handle *handle,
177 const char *filename,
178 int flags, mode_t mode,
179 const struct lttng_credentials *creds);
180
642e96c6
JG
181/*
182 * Unlink a file to a path relative to a directory handle.
183 */
2912cead
JG
184LTTNG_HIDDEN
185int lttng_directory_handle_unlink_file(
186 const struct lttng_directory_handle *handle,
187 const char *filename);
188
642e96c6
JG
189/*
190 * Unlink a file to a path relative to a directory handle as a given user.
191 */
2912cead
JG
192LTTNG_HIDDEN
193int lttng_directory_handle_unlink_file_as_user(
194 const struct lttng_directory_handle *handle,
195 const char *filename,
196 const struct lttng_credentials *creds);
197
642e96c6
JG
198/*
199 * Rename a file from a path relative to a directory handle to a new
200 * name relative to another directory handle.
201 */
d2956687
JG
202LTTNG_HIDDEN
203int lttng_directory_handle_rename(
93bed9fe
JG
204 const struct lttng_directory_handle *old_handle,
205 const char *old_name,
206 const struct lttng_directory_handle *new_handle,
207 const char *new_name);
d2956687 208
642e96c6
JG
209/*
210 * Rename a file from a path relative to a directory handle to a new
211 * name relative to another directory handle as a given user.
212 */
d2956687
JG
213LTTNG_HIDDEN
214int lttng_directory_handle_rename_as_user(
93bed9fe
JG
215 const struct lttng_directory_handle *old_handle,
216 const char *old_name,
217 const struct lttng_directory_handle *new_handle,
218 const char *new_name,
d2956687
JG
219 const struct lttng_credentials *creds);
220
642e96c6
JG
221/*
222 * Remove a subdirectory relative to a directory handle.
223 */
d2956687 224LTTNG_HIDDEN
93bed9fe 225int lttng_directory_handle_remove_subdirectory(
d2956687
JG
226 const struct lttng_directory_handle *handle,
227 const char *name);
228
642e96c6
JG
229/*
230 * Remove a subdirectory relative to a directory handle as a given user.
231 */
d2956687 232LTTNG_HIDDEN
93bed9fe 233int lttng_directory_handle_remove_subdirectory_as_user(
d2956687
JG
234 const struct lttng_directory_handle *handle,
235 const char *name,
236 const struct lttng_credentials *creds);
237
642e96c6
JG
238/*
239 * Remove a subdirectory and remove its contents if it only
240 * consists in empty directories.
f75c5439 241 * @flags: enum lttng_directory_handle_rmdir_recursive_flags
642e96c6 242 */
d2956687 243LTTNG_HIDDEN
93bed9fe 244int lttng_directory_handle_remove_subdirectory_recursive(
d2956687 245 const struct lttng_directory_handle *handle,
f75c5439 246 const char *name, int flags);
d2956687 247
642e96c6
JG
248/*
249 * Remove a subdirectory and remove its contents if it only
250 * consists in empty directories as a given user.
f75c5439 251 * @flags: enum lttng_directory_handle_rmdir_recursive_flags
642e96c6 252 */
d2956687 253LTTNG_HIDDEN
93bed9fe 254int lttng_directory_handle_remove_subdirectory_recursive_as_user(
d2956687
JG
255 const struct lttng_directory_handle *handle,
256 const char *name,
f75c5439
MD
257 const struct lttng_credentials *creds,
258 int flags);
d2956687 259
18710679 260#endif /* _COMPAT_PATH_HANDLE_H */
This page took 0.051597 seconds and 4 git commands to generate.