src/basic/rm-rf.c

   1 /***
   2   This file is part of systemd.
   3
   4   Copyright 2015 Lennart Poettering
   5
   6   systemd is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU Lesser General Public License as published by
   8   the Free Software Foundation; either version 2.1 of the License, or
   9   (at your option) any later version.
  10
  11   systemd is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   Lesser General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  18 ***/
  19
  20 #include <dirent.h>
  21 #include <errno.h>
  22 #include <fcntl.h>
  23 #include <stdbool.h>
  24 #include <stddef.h>
  25 #include <sys/stat.h>
  26 #include <sys/statfs.h>
  27 #include <unistd.h>
  28
  29 //#include "btrfs-util.h"
  30 #include "fd-util.h"
  31 #include "log.h"
  32 #include "macro.h"
  33 #include "mount-util.h"
  34 #include "path-util.h"
  35 #include "rm-rf.h"
  36 #include "stat-util.h"
  37 #include "string-util.h"
  38
  39 int rm_rf_children(int fd, RemoveFlags flags, struct stat *root_dev) {
  40         _cleanup_closedir_ DIR *d = NULL;
  41         int ret = 0, r;
  42
  43         assert(fd >= 0);
  44
  45         /* This returns the first error we run into, but nevertheless
  46          * tries to go on. This closes the passed fd. */
  47
  48         if (!(flags & REMOVE_PHYSICAL)) {
  49
  50                 r = fd_is_temporary_fs(fd);
  51                 if (r < 0) {
  52                         safe_close(fd);
  53                         return r;
  54                 }
  55
  56                 if (!r) {
  57                         /* We refuse to clean physical file systems
  58                          * with this call, unless explicitly
  59                          * requested. This is extra paranoia just to
  60                          * be sure we never ever remove non-state
  61                          * data */
  62
  63                         log_error("Attempted to remove disk file system, and we can't allow that.");
  64                         safe_close(fd);
  65                         return -EPERM;
  66                 }
  67         }
  68
  69         d = fdopendir(fd);
  70         if (!d) {
  71                 safe_close(fd);
  72                 return errno == ENOENT ? 0 : -errno;
  73         }
  74
  75         for (;;) {
  76                 struct dirent *de;
  77                 bool is_dir;
  78                 struct stat st;
  79
  80                 errno = 0;
  81                 de = readdir(d);
  82                 if (!de) {
  83                         if (errno > 0 && ret == 0)
  84                                 ret = -errno;
  85                         return ret;
  86                 }
  87
  88                 if (streq(de->d_name, ".") || streq(de->d_name, ".."))
  89                         continue;
  90
  91                 if (de->d_type == DT_UNKNOWN ||
  92                     (de->d_type == DT_DIR && (root_dev || (flags & REMOVE_SUBVOLUME)))) {
  93                         if (fstatat(fd, de->d_name, &st, AT_SYMLINK_NOFOLLOW) < 0) {
  94                                 if (ret == 0 && errno != ENOENT)
  95                                         ret = -errno;
  96                                 continue;
  97                         }
  98
  99                         is_dir = S_ISDIR(st.st_mode);
 100                 } else
 101                         is_dir = de->d_type == DT_DIR;
 102
 103                 if (is_dir) {
 104                         int subdir_fd;
 105
 106                         /* if root_dev is set, remove subdirectories only if device is same */
 107                         if (root_dev && st.st_dev != root_dev->st_dev)
 108                                 continue;
 109
 110                         subdir_fd = openat(fd, de->d_name, O_RDONLY|O_NONBLOCK|O_DIRECTORY|O_CLOEXEC|O_NOFOLLOW|O_NOATIME);
 111                         if (subdir_fd < 0) {
 112                                 if (ret == 0 && errno != ENOENT)
 113                                         ret = -errno;
 114                                 continue;
 115                         }
 116
 117                         /* Stop at mount points */
 118                         r = fd_is_mount_point(fd, de->d_name, 0);
 119                         if (r < 0) {
 120                                 if (ret == 0 && r != -ENOENT)
 121                                         ret = r;
 122
 123                                 safe_close(subdir_fd);
 124                                 continue;
 125                         }
 126                         if (r) {
 127                                 safe_close(subdir_fd);
 128                                 continue;
 129                         }
 130
 131 #if 0
 132                         if ((flags & REMOVE_SUBVOLUME) && st.st_ino == 256) {
 133
 134                                 /* This could be a subvolume, try to remove it */
 135
 136                                 r = btrfs_subvol_remove_fd(fd, de->d_name, BTRFS_REMOVE_RECURSIVE|BTRFS_REMOVE_QUOTA);
 137                                 if (r < 0) {
 138                                         if (r != -ENOTTY && r != -EINVAL) {
 139                                                 if (ret == 0)
 140                                                         ret = r;
 141
 142                                                 safe_close(subdir_fd);
 143                                                 continue;
 144                                         }
 145
 146                                         /* ENOTTY, then it wasn't a
 147                                          * btrfs subvolume, continue
 148                                          * below. */
 149                                 } else {
 150                                         /* It was a subvolume, continue. */
 151                                         safe_close(subdir_fd);
 152                                         continue;
 153                                 }
 154                         }
 155 #endif // 0
 156
 157                         /* We pass REMOVE_PHYSICAL here, to avoid
 158                          * doing the fstatfs() to check the file
 159                          * system type again for each directory */
 160                         r = rm_rf_children(subdir_fd, flags | REMOVE_PHYSICAL, root_dev);
 161                         if (r < 0 && ret == 0)
 162                                 ret = r;
 163
 164                         if (unlinkat(fd, de->d_name, AT_REMOVEDIR) < 0) {
 165                                 if (ret == 0 && errno != ENOENT)
 166                                         ret = -errno;
 167                         }
 168
 169                 } else if (!(flags & REMOVE_ONLY_DIRECTORIES)) {
 170
 171                         if (unlinkat(fd, de->d_name, 0) < 0) {
 172                                 if (ret == 0 && errno != ENOENT)
 173                                         ret = -errno;
 174                         }
 175                 }
 176         }
 177 }
 178
 179 int rm_rf(const char *path, RemoveFlags flags) {
 180         int fd, r;
 181         struct statfs s;
 182
 183         assert(path);
 184
 185         /* We refuse to clean the root file system with this
 186          * call. This is extra paranoia to never cause a really
 187          * seriously broken system. */
 188         if (path_equal(path, "/")) {
 189                 log_error("Attempted to remove entire root file system, and we can't allow that.");
 190                 return -EPERM;
 191         }
 192
 193 #if 0
 194         if ((flags & (REMOVE_SUBVOLUME|REMOVE_ROOT|REMOVE_PHYSICAL)) == (REMOVE_SUBVOLUME|REMOVE_ROOT|REMOVE_PHYSICAL)) {
 195                 /* Try to remove as subvolume first */
 196                 r = btrfs_subvol_remove(path, BTRFS_REMOVE_RECURSIVE|BTRFS_REMOVE_QUOTA);
 197                 if (r >= 0)
 198                         return r;
 199
 200                 if (r != -ENOTTY && r != -EINVAL && r != -ENOTDIR)
 201                         return r;
 202
 203                 /* Not btrfs or not a subvolume */
 204         }
 205 #endif // 0
 206
 207         fd = open(path, O_RDONLY|O_NONBLOCK|O_DIRECTORY|O_CLOEXEC|O_NOFOLLOW|O_NOATIME);
 208         if (fd < 0) {
 209
 210                 if (errno != ENOTDIR && errno != ELOOP)
 211                         return -errno;
 212
 213                 if (!(flags & REMOVE_PHYSICAL)) {
 214                         if (statfs(path, &s) < 0)
 215                                 return -errno;
 216
 217                         if (!is_temporary_fs(&s)) {
 218                                 log_error("Attempted to remove disk file system, and we can't allow that.");
 219                                 return -EPERM;
 220                         }
 221                 }
 222
 223                 if ((flags & REMOVE_ROOT) && !(flags & REMOVE_ONLY_DIRECTORIES))
 224                         if (unlink(path) < 0 && errno != ENOENT)
 225                                 return -errno;
 226
 227                 return 0;
 228         }
 229
 230         r = rm_rf_children(fd, flags, NULL);
 231
 232         if (flags & REMOVE_ROOT) {
 233                 if (rmdir(path) < 0) {
 234                         if (r == 0 && errno != ENOENT)
 235                                 r = -errno;
 236                 }
 237         }
 238
 239         return r;
 240 }