2 * Copyright (C) 2018 Facebook
4 * This file is part of libbtrfsutil.
6 * libbtrfsutil is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * libbtrfsutil is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with libbtrfsutil. If not, see <http://www.gnu.org/licenses/>.
26 #define BTRFS_UTIL_VERSION_MAJOR 1
27 #define BTRFS_UTIL_VERSION_MINOR 0
28 #define BTRFS_UTIL_VERSION_PATCH 0
35 * enum btrfs_util_error - libbtrfsutil error codes.
37 * All functions in libbtrfsutil that can return an error return this type and
40 enum btrfs_util_error {
42 BTRFS_UTIL_ERROR_STOP_ITERATION,
43 BTRFS_UTIL_ERROR_NO_MEMORY,
44 BTRFS_UTIL_ERROR_INVALID_ARGUMENT,
45 BTRFS_UTIL_ERROR_NOT_BTRFS,
46 BTRFS_UTIL_ERROR_NOT_SUBVOLUME,
47 BTRFS_UTIL_ERROR_SUBVOLUME_NOT_FOUND,
48 BTRFS_UTIL_ERROR_OPEN_FAILED,
49 BTRFS_UTIL_ERROR_RMDIR_FAILED,
50 BTRFS_UTIL_ERROR_UNLINK_FAILED,
51 BTRFS_UTIL_ERROR_STAT_FAILED,
52 BTRFS_UTIL_ERROR_STATFS_FAILED,
53 BTRFS_UTIL_ERROR_SEARCH_FAILED,
54 BTRFS_UTIL_ERROR_INO_LOOKUP_FAILED,
55 BTRFS_UTIL_ERROR_SUBVOL_GETFLAGS_FAILED,
56 BTRFS_UTIL_ERROR_SUBVOL_SETFLAGS_FAILED,
57 BTRFS_UTIL_ERROR_SUBVOL_CREATE_FAILED,
58 BTRFS_UTIL_ERROR_SNAP_CREATE_FAILED,
59 BTRFS_UTIL_ERROR_SNAP_DESTROY_FAILED,
60 BTRFS_UTIL_ERROR_DEFAULT_SUBVOL_FAILED,
61 BTRFS_UTIL_ERROR_SYNC_FAILED,
62 BTRFS_UTIL_ERROR_START_SYNC_FAILED,
63 BTRFS_UTIL_ERROR_WAIT_SYNC_FAILED,
67 * btrfs_util_strerror() - Convert a libtrfsutil error code to a string
69 * @err: The error to convert.
71 * Return: Error description.
73 const char *btrfs_util_strerror(enum btrfs_util_error err);
76 * btrfs_util_is_subvolume() - Return whether a given path is a Btrfs subvolume.
77 * @path: Path to check.
79 * Return: %BTRFS_UTIL_OK if @path is a Btrfs subvolume,
80 * %BTRFS_UTIL_ERROR_NOT_BTRFS if @path is not on a Btrfs filesystem,
81 * %BTRFS_UTIL_ERROR_NOT_SUBVOLUME if @path is not a subvolume, non-zero error
82 * code on any other failure.
84 enum btrfs_util_error btrfs_util_is_subvolume(const char *path);
87 * btrfs_util_is_subvolume_fd() - See btrfs_util_is_subvolume().
89 enum btrfs_util_error btrfs_util_is_subvolume_fd(int fd);
92 * btrfs_util_subvolume_id() - Get the ID of the subvolume containing a path.
93 * @path: Path on a Btrfs filesystem.
94 * @id_ret: Returned subvolume ID.
96 * Return: %BTRFS_UTIL_OK on success, non-zero error code on failure.
98 enum btrfs_util_error btrfs_util_subvolume_id(const char *path,
102 * btrfs_util_subvolume_id_fd() - See btrfs_util_subvolume_id().
104 enum btrfs_util_error btrfs_util_subvolume_id_fd(int fd, uint64_t *id_ret);
106 struct btrfs_util_qgroup_inherit;
109 * btrfs_util_create_qgroup_inherit() - Create a qgroup inheritance specifier
110 * for btrfs_util_create_subvolume() or btrfs_util_create_snapshot().
111 * @flags: Must be zero.
112 * @ret: Returned qgroup inheritance specifier.
114 * The returned structure must be freed with
115 * btrfs_util_destroy_qgroup_inherit().
117 * Return: %BTRFS_UTIL_OK on success, non-zero error code on failure.
119 enum btrfs_util_error btrfs_util_create_qgroup_inherit(int flags,
120 struct btrfs_util_qgroup_inherit **ret);
123 * btrfs_util_destroy_qgroup_inherit() - Destroy a qgroup inheritance specifier
124 * previously created with btrfs_util_create_qgroup_inherit().
125 * @inherit: Specifier to destroy.
127 void btrfs_util_destroy_qgroup_inherit(struct btrfs_util_qgroup_inherit *inherit);
130 * btrfs_util_qgroup_inherit_add_group() - Add inheritance from a qgroup to a
131 * qgroup inheritance specifier.
132 * @inherit: Specifier to modify. May be reallocated.
133 * @qgroupid: ID of qgroup to inherit from.
135 * Return: %BTRFS_UTIL_OK on success, non-zero error code on failure.
137 enum btrfs_util_error btrfs_util_qgroup_inherit_add_group(struct btrfs_util_qgroup_inherit **inherit,
141 * btrfs_util_qgroup_inherit_get_groups() - Get the qgroups a qgroup inheritance
142 * specifier contains.
143 * @inherit: Qgroup inheritance specifier.
144 * @groups: Returned array of qgroup IDs.
145 * @n: Returned number of entries in the @groups array.
147 void btrfs_util_qgroup_inherit_get_groups(const struct btrfs_util_qgroup_inherit *inherit,
148 const uint64_t **groups, size_t *n);
154 #endif /* BTRFS_UTIL_H */