src/basic/rm-rf.h

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