src/shared/btrfs-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include <stdbool.h>
   5 #include <stdint.h>
   6 #include <sys/types.h>
   7
   8 #include "sd-id128.h"
   9
  10 #include "btrfs.h"
  11 #include "copy.h"
  12 #include "time-util.h"
  13
  14 typedef struct BtrfsSubvolInfo {
  15         uint64_t subvol_id;
  16         usec_t otime;
  17
  18         sd_id128_t uuid;
  19         sd_id128_t parent_uuid;
  20
  21         bool read_only;
  22 } BtrfsSubvolInfo;
  23
  24 typedef struct BtrfsQuotaInfo {
  25         uint64_t referenced;
  26         uint64_t exclusive;
  27         uint64_t referenced_max;
  28         uint64_t exclusive_max;
  29 } BtrfsQuotaInfo;
  30
  31 typedef enum BtrfsSnapshotFlags {
  32         BTRFS_SNAPSHOT_FALLBACK_COPY      = 1 << 0, /* If the source isn't a subvolume, reflink everything */
  33         BTRFS_SNAPSHOT_READ_ONLY          = 1 << 1,
  34         BTRFS_SNAPSHOT_RECURSIVE          = 1 << 2,
  35         BTRFS_SNAPSHOT_QUOTA              = 1 << 3,
  36         BTRFS_SNAPSHOT_FALLBACK_DIRECTORY = 1 << 4, /* If the destination doesn't support subvolumes, reflink/copy instead */
  37         BTRFS_SNAPSHOT_FALLBACK_IMMUTABLE = 1 << 5, /* When we can't create a subvolume, use the FS_IMMUTABLE attribute for indicating read-only */
  38         BTRFS_SNAPSHOT_SIGINT             = 1 << 6, /* Check for SIGINT regularly, and return EINTR if seen */
  39         BTRFS_SNAPSHOT_SIGTERM            = 1 << 7, /* Ditto, but for SIGTERM */
  40         BTRFS_SNAPSHOT_LOCK_BSD           = 1 << 8, /* Return a BSD exclusively locked file descriptor referring to snapshot subvolume/directory. */
  41 } BtrfsSnapshotFlags;
  42
  43 typedef enum BtrfsRemoveFlags {
  44         BTRFS_REMOVE_RECURSIVE = 1 << 0,
  45         BTRFS_REMOVE_QUOTA     = 1 << 1,
  46 } BtrfsRemoveFlags;
  47
  48 int btrfs_is_subvol_at(int dir_fd, const char *path);
  49 static inline int btrfs_is_subvol_fd(int fd) {
  50         return btrfs_is_subvol_at(fd, NULL);
  51 }
  52 static inline int btrfs_is_subvol(const char *path) {
  53         return btrfs_is_subvol_at(AT_FDCWD, path);
  54 }
  55
  56 int btrfs_get_block_device_at(int dir_fd, const char *path, dev_t *ret);
  57 static inline int btrfs_get_block_device(const char *path, dev_t *ret) {
  58         return btrfs_get_block_device_at(AT_FDCWD, path, ret);
  59 }
  60 static inline int btrfs_get_block_device_fd(int fd, dev_t *ret) {
  61         return btrfs_get_block_device_at(fd, "", ret);
  62 }
  63
  64 int btrfs_defrag_fd(int fd);
  65 int btrfs_defrag(const char *p);
  66
  67 int btrfs_quota_enable_fd(int fd, bool b);
  68 int btrfs_quota_enable(const char *path, bool b);
  69
  70 int btrfs_quota_scan_start(int fd);
  71 int btrfs_quota_scan_wait(int fd);
  72 int btrfs_quota_scan_ongoing(int fd);
  73
  74 int btrfs_subvol_snapshot_at_full(int dir_fdf, const char *from, int dir_fdt, const char *to, BtrfsSnapshotFlags flags, copy_progress_path_t progress_path, copy_progress_bytes_t progress_bytes, void *userdata);
  75 static inline int btrfs_subvol_snapshot_at(int dir_fdf, const char *from, int dir_fdt, const char *to, BtrfsSnapshotFlags flags) {
  76         return btrfs_subvol_snapshot_at_full(dir_fdf, from, dir_fdt, to, flags, NULL, NULL, NULL);
  77 }
  78
  79 int btrfs_subvol_remove_at(int dir_fd, const char *path, BtrfsRemoveFlags flags);
  80 static inline int btrfs_subvol_remove(const char *path, BtrfsRemoveFlags flags) {
  81         return btrfs_subvol_remove_at(AT_FDCWD, path, flags);
  82 }
  83
  84 int btrfs_subvol_set_read_only_at(int dir_fd, const char *path, bool b);
  85 static inline int btrfs_subvol_set_read_only_fd(int fd, bool b) {
  86         return btrfs_subvol_set_read_only_at(fd, NULL, b);
  87 }
  88 static inline int btrfs_subvol_set_read_only(const char *path, bool b) {
  89         return btrfs_subvol_set_read_only_at(AT_FDCWD, path, b);
  90 }
  91
  92 int btrfs_subvol_get_read_only_fd(int fd);
  93
  94 int btrfs_subvol_get_id(int fd, const char *subvolume, uint64_t *ret);
  95 int btrfs_subvol_get_id_fd(int fd, uint64_t *ret);
  96 int btrfs_subvol_get_parent(int fd, uint64_t subvol_id, uint64_t *ret);
  97
  98 int btrfs_subvol_get_info_fd(int fd, uint64_t subvol_id, BtrfsSubvolInfo *info);
  99
 100 int btrfs_subvol_find_subtree_qgroup(int fd, uint64_t subvol_id, uint64_t *ret);
 101
 102 int btrfs_subvol_get_subtree_quota(const char *path, uint64_t subvol_id, BtrfsQuotaInfo *quota);
 103 int btrfs_subvol_get_subtree_quota_fd(int fd, uint64_t subvol_id, BtrfsQuotaInfo *quota);
 104
 105 int btrfs_subvol_set_subtree_quota_limit(const char *path, uint64_t subvol_id, uint64_t referenced_max);
 106 int btrfs_subvol_set_subtree_quota_limit_fd(int fd, uint64_t subvol_id, uint64_t referenced_max);
 107
 108 int btrfs_subvol_auto_qgroup_fd(int fd, uint64_t subvol_id, bool new_qgroup);
 109 int btrfs_subvol_auto_qgroup(const char *path, uint64_t subvol_id, bool create_intermediary_qgroup);
 110
 111 int btrfs_subvol_make_default(const char *path);
 112
 113 int btrfs_qgroupid_make(uint64_t level, uint64_t id, uint64_t *ret);
 114 int btrfs_qgroupid_split(uint64_t qgroupid, uint64_t *level, uint64_t *id);
 115
 116 int btrfs_qgroup_create(int fd, uint64_t qgroupid);
 117 int btrfs_qgroup_destroy(int fd, uint64_t qgroupid);
 118 int btrfs_qgroup_destroy_recursive(int fd, uint64_t qgroupid);
 119
 120 int btrfs_qgroup_set_limit_fd(int fd, uint64_t qgroupid, uint64_t referenced_max);
 121 int btrfs_qgroup_set_limit(const char *path, uint64_t qgroupid, uint64_t referenced_max);
 122
 123 int btrfs_qgroup_copy_limits(int fd, uint64_t old_qgroupid, uint64_t new_qgroupid);
 124
 125 int btrfs_qgroup_assign(int fd, uint64_t child, uint64_t parent);
 126 int btrfs_qgroup_unassign(int fd, uint64_t child, uint64_t parent);
 127
 128 int btrfs_qgroup_find_parents(int fd, uint64_t qgroupid, uint64_t **ret);
 129
 130 int btrfs_qgroup_get_quota_fd(int fd, uint64_t qgroupid, BtrfsQuotaInfo *quota);
 131 int btrfs_qgroup_get_quota(const char *path, uint64_t qgroupid, BtrfsQuotaInfo *quota);
 132
 133 static inline int btrfs_log_dev_root(int level, int ret, const char *p) {
 134         return log_full_errno(level, ret,
 135                               "File system behind %s is reported by btrfs to be backed by pseudo-device /dev/root, which is not a valid userspace accessible device node. "
 136                               "Cannot determine correct backing block device.", p);
 137 }
 138
 139 static inline bool btrfs_might_be_subvol(const struct stat *st) {
 140         if (!st)
 141                 return false;
 142
 143         /* Returns true if this 'struct stat' looks like it could refer to a btrfs subvolume. To make a final
 144          * decision, needs to be combined with an fstatfs() check to see if this is actually btrfs. */
 145
 146         return S_ISDIR(st->st_mode) && st->st_ino == 256;
 147 }
 148
 149 int btrfs_forget_device(const char *path);
 150
 151 int btrfs_get_file_physical_offset_fd(int fd, uint64_t *ret);