src/basic/rm-rf.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2015 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <sys/stat.h>
  24
  25 typedef enum RemoveFlags {
  26         REMOVE_ONLY_DIRECTORIES = 1,
  27         REMOVE_ROOT = 2,
  28         REMOVE_PHYSICAL = 4, /* if not set, only removes files on tmpfs, never physical file systems */
  29         REMOVE_SUBVOLUME = 8,
  30 } RemoveFlags;
  31
  32 int rm_rf_children(int fd, RemoveFlags flags, struct stat *root_dev);
  33 int rm_rf(const char *path, RemoveFlags flags);
  34
  35 /* Useful for usage with _cleanup_(), destroys a directory and frees the pointer */
  36 static inline void rm_rf_physical_and_free(char *p) {
  37         (void) rm_rf(p, REMOVE_ROOT|REMOVE_PHYSICAL);
  38         free(p);
  39 }
  40 DEFINE_TRIVIAL_CLEANUP_FUNC(char*, rm_rf_physical_and_free);