/* SPDX-License-Identifier: LGPL-2.1-or-later */

#pragma once

#include "forward.h"

typedef enum RemoveFlags {

        REMOVE_ONLY_DIRECTORIES = 1 << 0, /* Only remove empty directories, no files */

        REMOVE_ROOT             = 1 << 1, /* Remove the specified directory itself too, not just the contents of it */

        REMOVE_PHYSICAL         = 1 << 2, /* If not set, only removes files on tmpfs, never physical file systems */

        REMOVE_SUBVOLUME        = 1 << 3, /* Drop btrfs subvolumes in the tree too */

        REMOVE_MISSING_OK       = 1 << 4, /* If the top-level directory is missing, ignore the ENOENT for it */

        REMOVE_CHMOD            = 1 << 5, /* chmod() for write access if we cannot delete or access something */

        REMOVE_CHMOD_RESTORE    = 1 << 6, /* Restore the old mode before returning */

        REMOVE_SYNCFS           = 1 << 7, /* syncfs() the root of the specified directory after removing everything in it */

} RemoveFlags;

int unlinkat_harder(int dfd, const char *filename, int unlink_flags, RemoveFlags remove_flags);

int fstatat_harder(int dfd,

                const char *filename,

                struct stat *ret,

                int fstatat_flags,

                RemoveFlags remove_flags);

/* Note: directory file descriptors passed to the functions below must be

 * positioned at the beginning. If the fd was already used for reading, rewind it. */

int rm_rf_children(int fd, RemoveFlags flags, const struct stat *root_dev);

int rm_rf_child(int fd, const char *name, RemoveFlags flags);

int rm_rf_at(int dir_fd, const char *path, RemoveFlags flags);

static inline int rm_rf(const char *path, RemoveFlags flags) {

        return rm_rf_at(AT_FDCWD, path, flags);

}

/* Useful for using with _cleanup_(), destroys a directory on a temporary file system. */

const char* rm_rf_safe(const char *p);

DEFINE_TRIVIAL_CLEANUP_FUNC(const char*, rm_rf_safe);

/* Similar as above, but allow to destroy a directory on a physical file system, and also frees the pointer. */

char* rm_rf_physical_and_free(char *p);

DEFINE_TRIVIAL_CLEANUP_FUNC(char*, rm_rf_physical_and_free);

/* Similar as above, but also has magic btrfs subvolume powers. */

char* rm_rf_subvolume_and_free(char *p);

DEFINE_TRIVIAL_CLEANUP_FUNC(char*, rm_rf_subvolume_and_free);