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 "copy.h"
  11 #include "time-util.h"
  12
  13 typedef struct BtrfsSubvolInfo {
  14         uint64_t subvol_id;
  15         usec_t otime;
  16
  17         sd_id128_t uuid;
  18         sd_id128_t parent_uuid;
  19
  20         bool read_only;
  21 } BtrfsSubvolInfo;
  22
  23 typedef struct BtrfsQuotaInfo {
  24         uint64_t referenced;
  25         uint64_t exclusive;
  26         uint64_t referenced_max;
  27         uint64_t exclusive_max;
  28 } BtrfsQuotaInfo;
  29
  30 typedef enum BtrfsSnapshotFlags {
  31         BTRFS_SNAPSHOT_FALLBACK_COPY      = 1 << 0, /* If the source isn't a subvolume, reflink everything */
  32         BTRFS_SNAPSHOT_READ_ONLY          = 1 << 1,
  33         BTRFS_SNAPSHOT_RECURSIVE          = 1 << 2,
  34         BTRFS_SNAPSHOT_QUOTA              = 1 << 3,
  35         BTRFS_SNAPSHOT_FALLBACK_DIRECTORY = 1 << 4, /* If the destination doesn't support subvolumes, reflink/copy instead */
  36         BTRFS_SNAPSHOT_FALLBACK_IMMUTABLE = 1 << 5, /* When we can't create a subvolume, use the FS_IMMUTABLE attribute for indicating read-only */
  37         BTRFS_SNAPSHOT_SIGINT             = 1 << 6, /* Check for SIGINT regularly, and return EINTR if seen */
  38         BTRFS_SNAPSHOT_SIGTERM            = 1 << 7, /* Ditto, but for SIGTERM */
  39 } BtrfsSnapshotFlags;
  40
  41 typedef enum BtrfsRemoveFlags {
  42         BTRFS_REMOVE_RECURSIVE = 1 << 0,
  43         BTRFS_REMOVE_QUOTA     = 1 << 1,
  44 } BtrfsRemoveFlags;
  45
  46 int btrfs_is_subvol_fd(int fd);
  47 int btrfs_is_subvol(const char *path);
  48
  49 int btrfs_reflink(int infd, int outfd);
  50 int btrfs_clone_range(int infd, uint64_t in_offset, int ofd, uint64_t out_offset, uint64_t sz);
  51
  52 int btrfs_get_block_device_fd(int fd, dev_t *dev);
  53 int btrfs_get_block_device(const char *path, dev_t *dev);
  54
  55 int btrfs_defrag_fd(int fd);
  56 int btrfs_defrag(const char *p);
  57
  58 int btrfs_quota_enable_fd(int fd, bool b);
  59 int btrfs_quota_enable(const char *path, bool b);
  60
  61 int btrfs_quota_scan_start(int fd);
  62 int btrfs_quota_scan_wait(int fd);
  63 int btrfs_quota_scan_ongoing(int fd);
  64
  65 int btrfs_subvol_make(const char *path);
  66 int btrfs_subvol_make_fd(int fd, const char *subvolume);
  67
  68 int btrfs_subvol_make_fallback(const char *path, mode_t);
  69
  70 int btrfs_subvol_snapshot_fd_full(int old_fd, const char *new_path, BtrfsSnapshotFlags flags, copy_progress_path_t progress_path, copy_progress_bytes_t progress_bytes, void *userdata);
  71 static inline int btrfs_subvol_snapshot_fd(int old_fd, const char *new_path, BtrfsSnapshotFlags flags) {
  72         return btrfs_subvol_snapshot_fd_full(old_fd, new_path, flags, NULL, NULL, NULL);
  73 }
  74
  75 int btrfs_subvol_snapshot_full(const char *old_path, const char *new_path, BtrfsSnapshotFlags flags, copy_progress_path_t progress_path, copy_progress_bytes_t progress_bytes, void *userdata);
  76 static inline int btrfs_subvol_snapshot(const char *old_path, const char *new_path, BtrfsSnapshotFlags flags) {
  77         return btrfs_subvol_snapshot_full(old_path, new_path, flags, NULL, NULL, NULL);
  78 }
  79
  80 int btrfs_subvol_remove(const char *path, BtrfsRemoveFlags flags);
  81 int btrfs_subvol_remove_fd(int fd, const char *subvolume, BtrfsRemoveFlags flags);
  82
  83 int btrfs_subvol_set_read_only_fd(int fd, bool b);
  84 int btrfs_subvol_set_read_only(const char *path, bool b);
  85 int btrfs_subvol_get_read_only_fd(int fd);
  86
  87 int btrfs_subvol_get_id(int fd, const char *subvolume, uint64_t *ret);
  88 int btrfs_subvol_get_id_fd(int fd, uint64_t *ret);
  89 int btrfs_subvol_get_parent(int fd, uint64_t subvol_id, uint64_t *ret);
  90
  91 int btrfs_subvol_get_info_fd(int fd, uint64_t subvol_id, BtrfsSubvolInfo *info);
  92
  93 int btrfs_subvol_find_subtree_qgroup(int fd, uint64_t subvol_id, uint64_t *ret);
  94
  95 int btrfs_subvol_get_subtree_quota(const char *path, uint64_t subvol_id, BtrfsQuotaInfo *quota);
  96 int btrfs_subvol_get_subtree_quota_fd(int fd, uint64_t subvol_id, BtrfsQuotaInfo *quota);
  97
  98 int btrfs_subvol_set_subtree_quota_limit(const char *path, uint64_t subvol_id, uint64_t referenced_max);
  99 int btrfs_subvol_set_subtree_quota_limit_fd(int fd, uint64_t subvol_id, uint64_t referenced_max);
 100
 101 int btrfs_subvol_auto_qgroup_fd(int fd, uint64_t subvol_id, bool new_qgroup);
 102 int btrfs_subvol_auto_qgroup(const char *path, uint64_t subvol_id, bool create_intermediary_qgroup);
 103
 104 int btrfs_qgroupid_make(uint64_t level, uint64_t id, uint64_t *ret);
 105 int btrfs_qgroupid_split(uint64_t qgroupid, uint64_t *level, uint64_t *id);
 106
 107 int btrfs_qgroup_create(int fd, uint64_t qgroupid);
 108 int btrfs_qgroup_destroy(int fd, uint64_t qgroupid);
 109 int btrfs_qgroup_destroy_recursive(int fd, uint64_t qgroupid);
 110
 111 int btrfs_qgroup_set_limit_fd(int fd, uint64_t qgroupid, uint64_t referenced_max);
 112 int btrfs_qgroup_set_limit(const char *path, uint64_t qgroupid, uint64_t referenced_max);
 113
 114 int btrfs_qgroup_copy_limits(int fd, uint64_t old_qgroupid, uint64_t new_qgroupid);
 115
 116 int btrfs_qgroup_assign(int fd, uint64_t child, uint64_t parent);
 117 int btrfs_qgroup_unassign(int fd, uint64_t child, uint64_t parent);
 118
 119 int btrfs_qgroup_find_parents(int fd, uint64_t qgroupid, uint64_t **ret);
 120
 121 int btrfs_qgroup_get_quota_fd(int fd, uint64_t qgroupid, BtrfsQuotaInfo *quota);
 122 int btrfs_qgroup_get_quota(const char *path, uint64_t qgroupid, BtrfsQuotaInfo *quota);
 123
 124 static inline int btrfs_log_dev_root(int level, int ret, const char *p) {
 125         return log_full_errno(level, ret,
 126                               "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. "
 127                               "Cannot determine correct backing block device.", p);
 128 }
 129
 130 static inline bool btrfs_might_be_subvol(const struct stat *st) {
 131         if (!st)
 132                 return false;
 133
 134         /* Returns true if this 'struct stat' looks like it could refer to a btrfs subvolume. To make a final
 135          * decision, needs to be combined with an fstatfs() check to see if this is actually btrfs. */
 136
 137         return S_ISDIR(st->st_mode) && st->st_ino == 256;
 138 }