src/shared/rm-rf.h

   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 } RemoveFlags;
  18
  19 int unlinkat_harder(int dfd, const char *filename, int unlink_flags, RemoveFlags remove_flags);
  20 int fstatat_harder(int dfd,
  21                 const char *filename,
  22                 struct stat *ret,
  23                 int fstatat_flags,
  24                 RemoveFlags remove_flags);
  25
  26 int rm_rf_children(int fd, RemoveFlags flags, struct stat *root_dev);
  27 int rm_rf(const char *path, RemoveFlags flags);
  28
  29 /* Useful for usage with _cleanup_(), destroys a directory and frees the pointer */
  30 static inline char *rm_rf_physical_and_free(char *p) {
  31         PROTECT_ERRNO;
  32
  33         if (!p)
  34                 return NULL;
  35
  36         (void) rm_rf(p, REMOVE_ROOT|REMOVE_PHYSICAL|REMOVE_MISSING_OK|REMOVE_CHMOD);
  37         return mfree(p);
  38 }
  39 DEFINE_TRIVIAL_CLEANUP_FUNC(char*, rm_rf_physical_and_free);
  40
  41 /* Similar as above, but also has magic btrfs subvolume powers */
  42 static inline char *rm_rf_subvolume_and_free(char *p) {
  43         PROTECT_ERRNO;
  44
  45         if (!p)
  46                 return NULL;
  47
  48         (void) rm_rf(p, REMOVE_ROOT|REMOVE_PHYSICAL|REMOVE_SUBVOLUME|REMOVE_MISSING_OK|REMOVE_CHMOD);
  49         return mfree(p);
  50 }
  51 DEFINE_TRIVIAL_CLEANUP_FUNC(char*, rm_rf_subvolume_and_free);