1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
btrfs-qgroup(8)
===============
SYNOPSIS
--------
**btrfs qgroup** <subcommand> <args>
DESCRIPTION
-----------
**btrfs qgroup** is used to control quota group (qgroup) of a btrfs filesystem.
.. note::
To use qgroup you need to enable quota first using :command:`btrfs quota enable`
command, see :doc:`btrfs-quota`.
QGROUP
------
Quota groups or qgroup in btrfs make a tree hierarchy, the leaf qgroups are
attached to subvolumes. The size limits are set per qgroup and apply when any
limit is reached in tree that contains a given subvolume.
The limits are separated between *shared* and *exclusive* and reflect the extent
ownership. For example a fresh snapshot shares almost all the blocks with the
original subvolume, new writes to either subvolume will raise towards the
exclusive limit. Extent sharing is also result of *reflink* or *deduplication*.
.. note::
Qgroup limit only works when qgroup is in a consistent state.
If some workload marks qgroup inconsistent (like assigning a qgroup to another
qgroup), the limit will no longer work until the inconsistent flag is cleared
by :command:`btrfs quota rescan`.
The qgroup identifiers conform to *level/id* where level 0 is reserved to the
qgroups associated with subvolumes. Such qgroups are created automatically.
The qgroup hierarchy is built by commands :command:`btrfs qgroup create` and
:command:`btrfs qgroup assign`.
.. note::
If the qgroup of a subvolume is destroyed, quota related to the subvolume
will not be functional until qgroup *0/<subvolume id>* is created again.
SUBCOMMAND
----------
assign [options] <src> <dst> <path>
Assign qgroup *src* as the child qgroup of *dst* in the btrfs filesystem
identified by *path*.
``Options``
--rescan
(default since: 4.19) Automatically schedule quota rescan if the new qgroup
assignment would lead to quota inconsistency. See *QUOTA RESCAN* for more
information.
--no-rescan
Explicitly ask not to do a rescan, even if the assignment will make the quotas
inconsistent. This may be useful for repeated calls where the rescan would add
unnecessary overhead.
create <qgroupid> <path>
Create a subvolume quota group.
For the *0/<subvolume id>* qgroup, a qgroup can be created even before the
subvolume is created.
destroy <qgroupid> <path>
Destroy a qgroup.
If a qgroup is not isolated, meaning it is a parent or child qgroup, then it
can only be destroyed after the relationship is removed.
clear-stale <path>
Clear all stale qgroups whose subvolume does not exist anymore, this is the
level 0 qgroup like *0/subvolid*. Higher level qgroups are not deleted even
if they don't have any child qgroups as they are always created by the
user and their deletion should be verified first.
limit [options] <size>|none [<qgroupid>] <path>
Limit the size of a qgroup to *size* or no limit in the btrfs filesystem
identified by *path*.
If *qgroupid* is not given, qgroup of the subvolume identified by *path*
is used if possible.
``Options``
-c
limit amount of data after compression. This is the default, it is currently not
possible to turn off this option.
-e
limit space exclusively assigned to this qgroup.
remove <src> <dst> <path>
Remove the relationship between child qgroup *src* and parent qgroup *dst* in
the btrfs filesystem identified by *path*.
``Options``
--rescan
(default since: 4.19) Automatically schedule quota rescan if the removed qgroup
relation would lead to quota inconsistency. See *QUOTA RESCAN* for more
information.
--no-rescan
Explicitly ask not to do a rescan, even if the removal will make the quotas
inconsistent. This may be useful for repeated calls where the rescan would add
unnecessary overhead.
show [options] <path>
Show all qgroups in the btrfs filesystem identified by <path>.
``Options``
-p
print parent qgroup id.
-c
print child qgroup id.
-r
print limit of referenced size of qgroup.
-e
print limit of exclusive size of qgroup.
-F
list all qgroups which impact the given path(include ancestral qgroups)
-f
list all qgroups which impact the given path(exclude ancestral qgroups)
--raw
raw numbers in bytes, without the *B* suffix.
--human-readable
print human friendly numbers, base 1024, this is the default
--iec
select the 1024 base for the following options, according to the IEC standard.
--si
select the 1000 base for the following options, according to the SI standard.
--kbytes
show sizes in KiB, or kB with --si.
--mbytes
show sizes in MiB, or MB with --si.
--gbytes
show sizes in GiB, or GB with --si.
--tbytes
show sizes in TiB, or TB with --si.
--sort=[\+/-]<attr>[,[+/-]<attr>]...
list qgroups in order of <attr>.
<attr> can be one or more of qgroupid,rfer,excl,max_rfer,max_excl.
Prefix *+* means ascending order and *-* means descending order of *attr*.
If no prefix is given, use ascending order by default.
If multiple *attr* values are given, use comma to separate.
--sync
To retrieve information after updating the state of qgroups,
force sync of the filesystem identified by *path* before getting information.
SPECIAL PATHS
-------------
For :command:`btrfs qgroup show` command, the :file:`path` column can print
special values:
`<toplevel>`
The toplevel subvolume.
`<under deletion>`
The subvolume has been deleted (its directory removed), but the
subvolume metadata not not yet fully cleaned.
`<squota space holder>`
For *simple quota* mode only.
By its design, a fully deleted subvolume may still have accounting on
it, so even if the subvolume is gone, the numbers are still here for
future accounting.
`<stale>`
The qgroup has no corresponding subvolume anymore, and the qgroup
can be cleaned up under most cases.
The only exception is that, if the qgroup numbers are inconsistent and
the qgroup numbers are not all zeros, some older kernels may refuse to
delete such qgroups until a full rescan.
QUOTA RESCAN
------------
The rescan reads all extent sharing metadata and updates the respective qgroups
accordingly.
The information consists of bytes owned exclusively (*excl*) or shared/referenced
to (*rfer*). There's no explicit information about which extents are shared or
owned exclusively. This means when qgroup relationship changes, extent owners
change and qgroup numbers are no longer consistent unless we do a full rescan.
However there are cases where we can avoid a full rescan, if a subvolume whose
*rfer* number equals its *excl* number, which means all bytes are exclusively
owned, then assigning/removing this subvolume only needs to add/subtract *rfer*
number from its parent qgroup. This can speed up the rescan.
EXAMPLES
--------
Make a parent group that has two quota group children
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Given the following filesystem mounted at :file:`/mnt/my-vault`
.. code-block:: none
Label: none uuid: 60d2ab3b-941a-4f22-8d1a-315f329797b2
Total devices 1 FS bytes used 128.00KiB
devid 1 size 5.00GiB used 536.00MiB path /dev/vdb
Enable quota and create subvolumes. Check subvolume ids.
.. code-block:: bash
$ cd /mnt/my-vault
$ btrfs quota enable .
$ btrfs subvolume create a
$ btrfs subvolume create b
$ btrfs subvolume list .
ID 261 gen 61 top level 5 path a
ID 262 gen 62 top level 5 path b
Create qgroup and set limit to 10MiB.
.. code-block:: bash
$ btrfs qgroup create 1/100 .
$ btrfs qgroup limit 10M 1/100 .
$ btrfs qgroup assign 0/261 1/100 .
$ btrfs qgroup assign 0/262 1/100 .
And check qgroups.
.. code-block:: bash
$ btrfs qgroup show .
qgroupid rfer excl
-------- ---- ----
0/5 16.00KiB 16.00KiB
0/261 16.00KiB 16.00KiB
0/262 16.00KiB 16.00KiB
1/100 32.00KiB 32.00KiB
EXIT STATUS
-----------
**btrfs qgroup** returns a zero exit status if it succeeds. Non zero is
returned in case of failure.
AVAILABILITY
------------
**btrfs** is part of btrfs-progs. Please refer to the documentation at
`https://btrfs.readthedocs.io <https://btrfs.readthedocs.io>`_.
SEE ALSO
--------
:doc:`btrfs-quota`,
:doc:`btrfs-subvolume`,
:doc:`mkfs.btrfs`
|
