1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 #include <sys/stat.h>
5
6 #include "alloc-util.h"
7 #include "errno-util.h"
8
9 typedef enum RemoveFlags {
10 REMOVE_ONLY_DIRECTORIES = 1 << 0, /* Only remove empty directories, no files */
11 REMOVE_ROOT = 1 << 1, /* Remove the specified directory itself too, not just the contents of it */
12 REMOVE_PHYSICAL = 1 << 2, /* If not set, only removes files on tmpfs, never physical file systems */
13 REMOVE_SUBVOLUME = 1 << 3, /* Drop btrfs subvolumes in the tree too */
14 REMOVE_MISSING_OK = 1 << 4, /* If the top-level directory is missing, ignore the ENOENT for it */
15 REMOVE_CHMOD = 1 << 5, /* chmod() for write access if we cannot delete or access something */
16 REMOVE_CHMOD_RESTORE = 1 << 6, /* Restore the old mode before returning */
17 REMOVE_SYNCFS = 1 << 7, /* syncfs() the root of the specified directory after removing everything in it */
18 } RemoveFlags;
19
20 int unlinkat_harder(int dfd, const char *filename, int unlink_flags, RemoveFlags remove_flags);
21 int fstatat_harder(int dfd,
22 const char *filename,
23 struct stat *ret,
24 int fstatat_flags,
25 RemoveFlags remove_flags);
26
27 int rm_rf_children(int fd, RemoveFlags flags, const struct stat *root_dev);
28 int rm_rf_child(int fd, const char *name, RemoveFlags flags);
29 int rm_rf(const char *path, RemoveFlags flags);
30
31 /* Useful for usage with _cleanup_(), destroys a directory and frees the pointer */
rm_rf_physical_and_free(char * p)32 static inline char *rm_rf_physical_and_free(char *p) {
33 PROTECT_ERRNO;
34
35 if (!p)
36 return NULL;
37
38 (void) rm_rf(p, REMOVE_ROOT|REMOVE_PHYSICAL|REMOVE_MISSING_OK|REMOVE_CHMOD);
39 return mfree(p);
40 }
41 DEFINE_TRIVIAL_CLEANUP_FUNC(char*, rm_rf_physical_and_free);
42
43 /* Similar as above, but also has magic btrfs subvolume powers */
rm_rf_subvolume_and_free(char * p)44 static inline char *rm_rf_subvolume_and_free(char *p) {
45 PROTECT_ERRNO;
46
47 if (!p)
48 return NULL;
49
50 (void) rm_rf(p, REMOVE_ROOT|REMOVE_PHYSICAL|REMOVE_SUBVOLUME|REMOVE_MISSING_OK|REMOVE_CHMOD);
51 return mfree(p);
52 }
53 DEFINE_TRIVIAL_CLEANUP_FUNC(char*, rm_rf_subvolume_and_free);
54