src/basic/btrfs-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2014 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 <stdbool.h>
  24 #include <stdint.h>
  25 #include <sys/types.h>
  26
  27 #include "sd-id128.h"
  28
  29 #include "time-util.h"
  30
  31 typedef struct BtrfsSubvolInfo {
  32         uint64_t subvol_id;
  33         usec_t otime;
  34
  35         sd_id128_t uuid;
  36         sd_id128_t parent_uuid;
  37
  38         bool read_only;
  39 } BtrfsSubvolInfo;
  40
  41 typedef struct BtrfsQuotaInfo {
  42         uint64_t referenced;
  43         uint64_t exclusive;
  44         uint64_t referenced_max;
  45         uint64_t exclusive_max;
  46 } BtrfsQuotaInfo;
  47
  48 typedef enum BtrfsSnapshotFlags {
  49         BTRFS_SNAPSHOT_FALLBACK_COPY = 1,        /* If the source isn't a subvolume, reflink everything */
  50         BTRFS_SNAPSHOT_READ_ONLY = 2,
  51         BTRFS_SNAPSHOT_RECURSIVE = 4,
  52         BTRFS_SNAPSHOT_QUOTA = 8,
  53         BTRFS_SNAPSHOT_FALLBACK_DIRECTORY = 16,  /* If the destination doesn't support subvolumes, reflink/copy instead */
  54         BTRFS_SNAPSHOT_FALLBACK_IMMUTABLE = 32,  /* When we can't create a subvolume, use the FS_IMMUTABLE attribute for indicating read-only */
  55 } BtrfsSnapshotFlags;
  56
  57 typedef enum BtrfsRemoveFlags {
  58         BTRFS_REMOVE_RECURSIVE = 1,
  59         BTRFS_REMOVE_QUOTA = 2,
  60 } BtrfsRemoveFlags;
  61
  62 int btrfs_is_filesystem(int fd);
  63
  64 int btrfs_is_subvol_fd(int fd);
  65 int btrfs_is_subvol(const char *path);
  66
  67 int btrfs_reflink(int infd, int outfd);
  68 int btrfs_clone_range(int infd, uint64_t in_offset, int ofd, uint64_t out_offset, uint64_t sz);
  69
  70 int btrfs_get_block_device_fd(int fd, dev_t *dev);
  71 int btrfs_get_block_device(const char *path, dev_t *dev);
  72
  73 int btrfs_defrag_fd(int fd);
  74 int btrfs_defrag(const char *p);
  75
  76 int btrfs_quota_enable_fd(int fd, bool b);
  77 int btrfs_quota_enable(const char *path, bool b);
  78
  79 int btrfs_quota_scan_start(int fd);
  80 int btrfs_quota_scan_wait(int fd);
  81 int btrfs_quota_scan_ongoing(int fd);
  82
  83 int btrfs_resize_loopback_fd(int fd, uint64_t size, bool grow_only);
  84 int btrfs_resize_loopback(const char *path, uint64_t size, bool grow_only);
  85
  86 int btrfs_subvol_make(const char *path);
  87 int btrfs_subvol_make_label(const char *path);
  88
  89 int btrfs_subvol_snapshot_fd(int old_fd, const char *new_path, BtrfsSnapshotFlags flags);
  90 int btrfs_subvol_snapshot(const char *old_path, const char *new_path, BtrfsSnapshotFlags flags);
  91
  92 int btrfs_subvol_remove(const char *path, BtrfsRemoveFlags flags);
  93 int btrfs_subvol_remove_fd(int fd, const char *subvolume, BtrfsRemoveFlags flags);
  94
  95 int btrfs_subvol_set_read_only_fd(int fd, bool b);
  96 int btrfs_subvol_set_read_only(const char *path, bool b);
  97 int btrfs_subvol_get_read_only_fd(int fd);
  98
  99 int btrfs_subvol_get_id(int fd, const char *subvolume, uint64_t *ret);
 100 int btrfs_subvol_get_id_fd(int fd, uint64_t *ret);
 101 int btrfs_subvol_get_parent(int fd, uint64_t subvol_id, uint64_t *ret);
 102
 103 int btrfs_subvol_get_info_fd(int fd, uint64_t subvol_id, BtrfsSubvolInfo *info);
 104
 105 int btrfs_subvol_find_subtree_qgroup(int fd, uint64_t subvol_id, uint64_t *ret);
 106
 107 int btrfs_subvol_get_subtree_quota(const char *path, uint64_t subvol_id, BtrfsQuotaInfo *quota);
 108 int btrfs_subvol_get_subtree_quota_fd(int fd, uint64_t subvol_id, BtrfsQuotaInfo *quota);
 109
 110 int btrfs_subvol_set_subtree_quota_limit(const char *path, uint64_t subvol_id, uint64_t referenced_max);
 111 int btrfs_subvol_set_subtree_quota_limit_fd(int fd, uint64_t subvol_id, uint64_t referenced_max);
 112
 113 int btrfs_subvol_auto_qgroup_fd(int fd, uint64_t subvol_id, bool new_qgroup);
 114 int btrfs_subvol_auto_qgroup(const char *path, uint64_t subvol_id, bool create_intermediary_qgroup);
 115
 116 int btrfs_qgroupid_make(uint64_t level, uint64_t id, uint64_t *ret);
 117 int btrfs_qgroupid_split(uint64_t qgroupid, uint64_t *level, uint64_t *id);
 118
 119 int btrfs_qgroup_create(int fd, uint64_t qgroupid);
 120 int btrfs_qgroup_destroy(int fd, uint64_t qgroupid);
 121 int btrfs_qgroup_destroy_recursive(int fd, uint64_t qgroupid);
 122
 123 int btrfs_qgroup_set_limit_fd(int fd, uint64_t qgroupid, uint64_t referenced_max);
 124 int btrfs_qgroup_set_limit(const char *path, uint64_t qgroupid, uint64_t referenced_max);
 125
 126 int btrfs_qgroup_copy_limits(int fd, uint64_t old_qgroupid, uint64_t new_qgroupid);
 127
 128 int btrfs_qgroup_assign(int fd, uint64_t child, uint64_t parent);
 129 int btrfs_qgroup_unassign(int fd, uint64_t child, uint64_t parent);
 130
 131 int btrfs_qgroup_find_parents(int fd, uint64_t qgroupid, uint64_t **ret);
 132
 133 int btrfs_qgroup_get_quota_fd(int fd, uint64_t qgroupid, BtrfsQuotaInfo *quota);
 134 int btrfs_qgroup_get_quota(const char *path, uint64_t qgroupid, BtrfsQuotaInfo *quota);