1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2007 Oracle. All rights reserved.
6 #include <linux/sched.h>
7 #include <linux/sched/mm.h>
8 #include <linux/slab.h>
9 #include <linux/spinlock.h>
10 #include <linux/completion.h>
11 #include <linux/bug.h>
12 #include <crypto/hash.h>
18 #include "transaction.h"
21 #include "space-info.h"
22 #include "block-group.h"
27 * --------------------------------------------------------------------------
28 * btrfs_supported_static_feature_attrs /sys/fs/btrfs/features
29 * btrfs_supported_feature_attrs /sys/fs/btrfs/features and
30 * /sys/fs/btrfs/<uuid>/features
31 * btrfs_attrs /sys/fs/btrfs/<uuid>
32 * devid_attrs /sys/fs/btrfs/<uuid>/devinfo/<devid>
33 * allocation_attrs /sys/fs/btrfs/<uuid>/allocation
34 * qgroup_attrs /sys/fs/btrfs/<uuid>/qgroups/<level>_<qgroupid>
35 * space_info_attrs /sys/fs/btrfs/<uuid>/allocation/<bg-type>
36 * raid_attrs /sys/fs/btrfs/<uuid>/allocation/<bg-type>/<bg-profile>
38 * When built with BTRFS_CONFIG_DEBUG:
40 * btrfs_debug_feature_attrs /sys/fs/btrfs/debug
41 * btrfs_debug_mount_attrs /sys/fs/btrfs/<uuid>/debug
42 * discard_debug_attrs /sys/fs/btrfs/<uuid>/debug/discard
45 struct btrfs_feature_attr {
46 struct kobj_attribute kobj_attr;
47 enum btrfs_feature_set feature_set;
51 /* For raid type sysfs entries */
57 #define __INIT_KOBJ_ATTR(_name, _mode, _show, _store) \
59 .attr = { .name = __stringify(_name), .mode = _mode }, \
64 #define BTRFS_ATTR_RW(_prefix, _name, _show, _store) \
65 static struct kobj_attribute btrfs_attr_##_prefix##_##_name = \
66 __INIT_KOBJ_ATTR(_name, 0644, _show, _store)
68 #define BTRFS_ATTR(_prefix, _name, _show) \
69 static struct kobj_attribute btrfs_attr_##_prefix##_##_name = \
70 __INIT_KOBJ_ATTR(_name, 0444, _show, NULL)
72 #define BTRFS_ATTR_PTR(_prefix, _name) \
73 (&btrfs_attr_##_prefix##_##_name.attr)
75 #define BTRFS_FEAT_ATTR(_name, _feature_set, _feature_prefix, _feature_bit) \
76 static struct btrfs_feature_attr btrfs_attr_features_##_name = { \
77 .kobj_attr = __INIT_KOBJ_ATTR(_name, S_IRUGO, \
78 btrfs_feature_attr_show, \
79 btrfs_feature_attr_store), \
80 .feature_set = _feature_set, \
81 .feature_bit = _feature_prefix ##_## _feature_bit, \
83 #define BTRFS_FEAT_ATTR_PTR(_name) \
84 (&btrfs_attr_features_##_name.kobj_attr.attr)
86 #define BTRFS_FEAT_ATTR_COMPAT(name, feature) \
87 BTRFS_FEAT_ATTR(name, FEAT_COMPAT, BTRFS_FEATURE_COMPAT, feature)
88 #define BTRFS_FEAT_ATTR_COMPAT_RO(name, feature) \
89 BTRFS_FEAT_ATTR(name, FEAT_COMPAT_RO, BTRFS_FEATURE_COMPAT_RO, feature)
90 #define BTRFS_FEAT_ATTR_INCOMPAT(name, feature) \
91 BTRFS_FEAT_ATTR(name, FEAT_INCOMPAT, BTRFS_FEATURE_INCOMPAT, feature)
93 static inline struct btrfs_fs_info *to_fs_info(struct kobject *kobj);
94 static inline struct btrfs_fs_devices *to_fs_devs(struct kobject *kobj);
96 static struct btrfs_feature_attr *to_btrfs_feature_attr(struct kobj_attribute *a)
98 return container_of(a, struct btrfs_feature_attr, kobj_attr);
101 static struct kobj_attribute *attr_to_btrfs_attr(struct attribute *attr)
103 return container_of(attr, struct kobj_attribute, attr);
106 static struct btrfs_feature_attr *attr_to_btrfs_feature_attr(
107 struct attribute *attr)
109 return to_btrfs_feature_attr(attr_to_btrfs_attr(attr));
112 static u64 get_features(struct btrfs_fs_info *fs_info,
113 enum btrfs_feature_set set)
115 struct btrfs_super_block *disk_super = fs_info->super_copy;
116 if (set == FEAT_COMPAT)
117 return btrfs_super_compat_flags(disk_super);
118 else if (set == FEAT_COMPAT_RO)
119 return btrfs_super_compat_ro_flags(disk_super);
121 return btrfs_super_incompat_flags(disk_super);
124 static void set_features(struct btrfs_fs_info *fs_info,
125 enum btrfs_feature_set set, u64 features)
127 struct btrfs_super_block *disk_super = fs_info->super_copy;
128 if (set == FEAT_COMPAT)
129 btrfs_set_super_compat_flags(disk_super, features);
130 else if (set == FEAT_COMPAT_RO)
131 btrfs_set_super_compat_ro_flags(disk_super, features);
133 btrfs_set_super_incompat_flags(disk_super, features);
136 static int can_modify_feature(struct btrfs_feature_attr *fa)
140 switch (fa->feature_set) {
142 set = BTRFS_FEATURE_COMPAT_SAFE_SET;
143 clear = BTRFS_FEATURE_COMPAT_SAFE_CLEAR;
146 set = BTRFS_FEATURE_COMPAT_RO_SAFE_SET;
147 clear = BTRFS_FEATURE_COMPAT_RO_SAFE_CLEAR;
150 set = BTRFS_FEATURE_INCOMPAT_SAFE_SET;
151 clear = BTRFS_FEATURE_INCOMPAT_SAFE_CLEAR;
154 pr_warn("btrfs: sysfs: unknown feature set %d\n",
159 if (set & fa->feature_bit)
161 if (clear & fa->feature_bit)
167 static ssize_t btrfs_feature_attr_show(struct kobject *kobj,
168 struct kobj_attribute *a, char *buf)
171 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
172 struct btrfs_feature_attr *fa = to_btrfs_feature_attr(a);
174 u64 features = get_features(fs_info, fa->feature_set);
175 if (features & fa->feature_bit)
178 val = can_modify_feature(fa);
180 return sysfs_emit(buf, "%d\n", val);
183 static ssize_t btrfs_feature_attr_store(struct kobject *kobj,
184 struct kobj_attribute *a,
185 const char *buf, size_t count)
187 struct btrfs_fs_info *fs_info;
188 struct btrfs_feature_attr *fa = to_btrfs_feature_attr(a);
189 u64 features, set, clear;
193 fs_info = to_fs_info(kobj);
197 if (sb_rdonly(fs_info->sb))
200 ret = kstrtoul(skip_spaces(buf), 0, &val);
204 if (fa->feature_set == FEAT_COMPAT) {
205 set = BTRFS_FEATURE_COMPAT_SAFE_SET;
206 clear = BTRFS_FEATURE_COMPAT_SAFE_CLEAR;
207 } else if (fa->feature_set == FEAT_COMPAT_RO) {
208 set = BTRFS_FEATURE_COMPAT_RO_SAFE_SET;
209 clear = BTRFS_FEATURE_COMPAT_RO_SAFE_CLEAR;
211 set = BTRFS_FEATURE_INCOMPAT_SAFE_SET;
212 clear = BTRFS_FEATURE_INCOMPAT_SAFE_CLEAR;
215 features = get_features(fs_info, fa->feature_set);
218 if ((val && (features & fa->feature_bit)) ||
219 (!val && !(features & fa->feature_bit)))
222 if ((val && !(set & fa->feature_bit)) ||
223 (!val && !(clear & fa->feature_bit))) {
225 "%sabling feature %s on mounted fs is not supported.",
226 val ? "En" : "Dis", fa->kobj_attr.attr.name);
230 btrfs_info(fs_info, "%s %s feature flag",
231 val ? "Setting" : "Clearing", fa->kobj_attr.attr.name);
233 spin_lock(&fs_info->super_lock);
234 features = get_features(fs_info, fa->feature_set);
236 features |= fa->feature_bit;
238 features &= ~fa->feature_bit;
239 set_features(fs_info, fa->feature_set, features);
240 spin_unlock(&fs_info->super_lock);
243 * We don't want to do full transaction commit from inside sysfs
245 btrfs_set_pending(fs_info, COMMIT);
246 wake_up_process(fs_info->transaction_kthread);
251 static umode_t btrfs_feature_visible(struct kobject *kobj,
252 struct attribute *attr, int unused)
254 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
255 umode_t mode = attr->mode;
258 struct btrfs_feature_attr *fa;
261 fa = attr_to_btrfs_feature_attr(attr);
262 features = get_features(fs_info, fa->feature_set);
264 if (can_modify_feature(fa))
266 else if (!(features & fa->feature_bit))
273 BTRFS_FEAT_ATTR_INCOMPAT(mixed_backref, MIXED_BACKREF);
274 BTRFS_FEAT_ATTR_INCOMPAT(default_subvol, DEFAULT_SUBVOL);
275 BTRFS_FEAT_ATTR_INCOMPAT(mixed_groups, MIXED_GROUPS);
276 BTRFS_FEAT_ATTR_INCOMPAT(compress_lzo, COMPRESS_LZO);
277 BTRFS_FEAT_ATTR_INCOMPAT(compress_zstd, COMPRESS_ZSTD);
278 BTRFS_FEAT_ATTR_INCOMPAT(big_metadata, BIG_METADATA);
279 BTRFS_FEAT_ATTR_INCOMPAT(extended_iref, EXTENDED_IREF);
280 BTRFS_FEAT_ATTR_INCOMPAT(raid56, RAID56);
281 BTRFS_FEAT_ATTR_INCOMPAT(skinny_metadata, SKINNY_METADATA);
282 BTRFS_FEAT_ATTR_INCOMPAT(no_holes, NO_HOLES);
283 BTRFS_FEAT_ATTR_INCOMPAT(metadata_uuid, METADATA_UUID);
284 BTRFS_FEAT_ATTR_COMPAT_RO(free_space_tree, FREE_SPACE_TREE);
285 BTRFS_FEAT_ATTR_INCOMPAT(raid1c34, RAID1C34);
286 #ifdef CONFIG_BTRFS_DEBUG
287 /* Remove once support for zoned allocation is feature complete */
288 BTRFS_FEAT_ATTR_INCOMPAT(zoned, ZONED);
289 /* Remove once support for extent tree v2 is feature complete */
290 BTRFS_FEAT_ATTR_INCOMPAT(extent_tree_v2, EXTENT_TREE_V2);
292 #ifdef CONFIG_FS_VERITY
293 BTRFS_FEAT_ATTR_COMPAT_RO(verity, VERITY);
297 * Features which depend on feature bits and may differ between each fs.
299 * /sys/fs/btrfs/features - all available features implemeted by this version
300 * /sys/fs/btrfs/UUID/features - features of the fs which are enabled or
301 * can be changed on a mounted filesystem.
303 static struct attribute *btrfs_supported_feature_attrs[] = {
304 BTRFS_FEAT_ATTR_PTR(mixed_backref),
305 BTRFS_FEAT_ATTR_PTR(default_subvol),
306 BTRFS_FEAT_ATTR_PTR(mixed_groups),
307 BTRFS_FEAT_ATTR_PTR(compress_lzo),
308 BTRFS_FEAT_ATTR_PTR(compress_zstd),
309 BTRFS_FEAT_ATTR_PTR(big_metadata),
310 BTRFS_FEAT_ATTR_PTR(extended_iref),
311 BTRFS_FEAT_ATTR_PTR(raid56),
312 BTRFS_FEAT_ATTR_PTR(skinny_metadata),
313 BTRFS_FEAT_ATTR_PTR(no_holes),
314 BTRFS_FEAT_ATTR_PTR(metadata_uuid),
315 BTRFS_FEAT_ATTR_PTR(free_space_tree),
316 BTRFS_FEAT_ATTR_PTR(raid1c34),
317 #ifdef CONFIG_BTRFS_DEBUG
318 BTRFS_FEAT_ATTR_PTR(zoned),
319 BTRFS_FEAT_ATTR_PTR(extent_tree_v2),
321 #ifdef CONFIG_FS_VERITY
322 BTRFS_FEAT_ATTR_PTR(verity),
327 static const struct attribute_group btrfs_feature_attr_group = {
329 .is_visible = btrfs_feature_visible,
330 .attrs = btrfs_supported_feature_attrs,
333 static ssize_t rmdir_subvol_show(struct kobject *kobj,
334 struct kobj_attribute *ka, char *buf)
336 return sysfs_emit(buf, "0\n");
338 BTRFS_ATTR(static_feature, rmdir_subvol, rmdir_subvol_show);
340 static ssize_t supported_checksums_show(struct kobject *kobj,
341 struct kobj_attribute *a, char *buf)
346 for (i = 0; i < btrfs_get_num_csums(); i++) {
348 * This "trick" only works as long as 'enum btrfs_csum_type' has
351 ret += sysfs_emit_at(buf, ret, "%s%s", (i == 0 ? "" : " "),
352 btrfs_super_csum_name(i));
356 ret += sysfs_emit_at(buf, ret, "\n");
359 BTRFS_ATTR(static_feature, supported_checksums, supported_checksums_show);
361 static ssize_t send_stream_version_show(struct kobject *kobj,
362 struct kobj_attribute *ka, char *buf)
364 return sysfs_emit(buf, "%d\n", BTRFS_SEND_STREAM_VERSION);
366 BTRFS_ATTR(static_feature, send_stream_version, send_stream_version_show);
368 static const char *rescue_opts[] = {
376 static ssize_t supported_rescue_options_show(struct kobject *kobj,
377 struct kobj_attribute *a,
383 for (i = 0; i < ARRAY_SIZE(rescue_opts); i++)
384 ret += sysfs_emit_at(buf, ret, "%s%s", (i ? " " : ""), rescue_opts[i]);
385 ret += sysfs_emit_at(buf, ret, "\n");
388 BTRFS_ATTR(static_feature, supported_rescue_options,
389 supported_rescue_options_show);
391 static ssize_t supported_sectorsizes_show(struct kobject *kobj,
392 struct kobj_attribute *a,
397 /* An artificial limit to only support 4K and PAGE_SIZE */
398 if (PAGE_SIZE > SZ_4K)
399 ret += sysfs_emit_at(buf, ret, "%u ", SZ_4K);
400 ret += sysfs_emit_at(buf, ret, "%lu\n", PAGE_SIZE);
404 BTRFS_ATTR(static_feature, supported_sectorsizes,
405 supported_sectorsizes_show);
408 * Features which only depend on kernel version.
410 * These are listed in /sys/fs/btrfs/features along with
411 * btrfs_supported_feature_attrs.
413 static struct attribute *btrfs_supported_static_feature_attrs[] = {
414 BTRFS_ATTR_PTR(static_feature, rmdir_subvol),
415 BTRFS_ATTR_PTR(static_feature, supported_checksums),
416 BTRFS_ATTR_PTR(static_feature, send_stream_version),
417 BTRFS_ATTR_PTR(static_feature, supported_rescue_options),
418 BTRFS_ATTR_PTR(static_feature, supported_sectorsizes),
422 static const struct attribute_group btrfs_static_feature_attr_group = {
424 .attrs = btrfs_supported_static_feature_attrs,
427 #ifdef CONFIG_BTRFS_DEBUG
430 * Discard statistics and tunables
432 #define discard_to_fs_info(_kobj) to_fs_info((_kobj)->parent->parent)
434 static ssize_t btrfs_discardable_bytes_show(struct kobject *kobj,
435 struct kobj_attribute *a,
438 struct btrfs_fs_info *fs_info = discard_to_fs_info(kobj);
440 return sysfs_emit(buf, "%lld\n",
441 atomic64_read(&fs_info->discard_ctl.discardable_bytes));
443 BTRFS_ATTR(discard, discardable_bytes, btrfs_discardable_bytes_show);
445 static ssize_t btrfs_discardable_extents_show(struct kobject *kobj,
446 struct kobj_attribute *a,
449 struct btrfs_fs_info *fs_info = discard_to_fs_info(kobj);
451 return sysfs_emit(buf, "%d\n",
452 atomic_read(&fs_info->discard_ctl.discardable_extents));
454 BTRFS_ATTR(discard, discardable_extents, btrfs_discardable_extents_show);
456 static ssize_t btrfs_discard_bitmap_bytes_show(struct kobject *kobj,
457 struct kobj_attribute *a,
460 struct btrfs_fs_info *fs_info = discard_to_fs_info(kobj);
462 return sysfs_emit(buf, "%llu\n",
463 fs_info->discard_ctl.discard_bitmap_bytes);
465 BTRFS_ATTR(discard, discard_bitmap_bytes, btrfs_discard_bitmap_bytes_show);
467 static ssize_t btrfs_discard_bytes_saved_show(struct kobject *kobj,
468 struct kobj_attribute *a,
471 struct btrfs_fs_info *fs_info = discard_to_fs_info(kobj);
473 return sysfs_emit(buf, "%lld\n",
474 atomic64_read(&fs_info->discard_ctl.discard_bytes_saved));
476 BTRFS_ATTR(discard, discard_bytes_saved, btrfs_discard_bytes_saved_show);
478 static ssize_t btrfs_discard_extent_bytes_show(struct kobject *kobj,
479 struct kobj_attribute *a,
482 struct btrfs_fs_info *fs_info = discard_to_fs_info(kobj);
484 return sysfs_emit(buf, "%llu\n",
485 fs_info->discard_ctl.discard_extent_bytes);
487 BTRFS_ATTR(discard, discard_extent_bytes, btrfs_discard_extent_bytes_show);
489 static ssize_t btrfs_discard_iops_limit_show(struct kobject *kobj,
490 struct kobj_attribute *a,
493 struct btrfs_fs_info *fs_info = discard_to_fs_info(kobj);
495 return sysfs_emit(buf, "%u\n",
496 READ_ONCE(fs_info->discard_ctl.iops_limit));
499 static ssize_t btrfs_discard_iops_limit_store(struct kobject *kobj,
500 struct kobj_attribute *a,
501 const char *buf, size_t len)
503 struct btrfs_fs_info *fs_info = discard_to_fs_info(kobj);
504 struct btrfs_discard_ctl *discard_ctl = &fs_info->discard_ctl;
508 ret = kstrtou32(buf, 10, &iops_limit);
512 WRITE_ONCE(discard_ctl->iops_limit, iops_limit);
513 btrfs_discard_calc_delay(discard_ctl);
514 btrfs_discard_schedule_work(discard_ctl, true);
517 BTRFS_ATTR_RW(discard, iops_limit, btrfs_discard_iops_limit_show,
518 btrfs_discard_iops_limit_store);
520 static ssize_t btrfs_discard_kbps_limit_show(struct kobject *kobj,
521 struct kobj_attribute *a,
524 struct btrfs_fs_info *fs_info = discard_to_fs_info(kobj);
526 return sysfs_emit(buf, "%u\n",
527 READ_ONCE(fs_info->discard_ctl.kbps_limit));
530 static ssize_t btrfs_discard_kbps_limit_store(struct kobject *kobj,
531 struct kobj_attribute *a,
532 const char *buf, size_t len)
534 struct btrfs_fs_info *fs_info = discard_to_fs_info(kobj);
535 struct btrfs_discard_ctl *discard_ctl = &fs_info->discard_ctl;
539 ret = kstrtou32(buf, 10, &kbps_limit);
543 WRITE_ONCE(discard_ctl->kbps_limit, kbps_limit);
544 btrfs_discard_schedule_work(discard_ctl, true);
547 BTRFS_ATTR_RW(discard, kbps_limit, btrfs_discard_kbps_limit_show,
548 btrfs_discard_kbps_limit_store);
550 static ssize_t btrfs_discard_max_discard_size_show(struct kobject *kobj,
551 struct kobj_attribute *a,
554 struct btrfs_fs_info *fs_info = discard_to_fs_info(kobj);
556 return sysfs_emit(buf, "%llu\n",
557 READ_ONCE(fs_info->discard_ctl.max_discard_size));
560 static ssize_t btrfs_discard_max_discard_size_store(struct kobject *kobj,
561 struct kobj_attribute *a,
562 const char *buf, size_t len)
564 struct btrfs_fs_info *fs_info = discard_to_fs_info(kobj);
565 struct btrfs_discard_ctl *discard_ctl = &fs_info->discard_ctl;
566 u64 max_discard_size;
569 ret = kstrtou64(buf, 10, &max_discard_size);
573 WRITE_ONCE(discard_ctl->max_discard_size, max_discard_size);
577 BTRFS_ATTR_RW(discard, max_discard_size, btrfs_discard_max_discard_size_show,
578 btrfs_discard_max_discard_size_store);
581 * Per-filesystem debugging of discard (when mounted with discard=async).
583 * Path: /sys/fs/btrfs/<uuid>/debug/discard/
585 static const struct attribute *discard_debug_attrs[] = {
586 BTRFS_ATTR_PTR(discard, discardable_bytes),
587 BTRFS_ATTR_PTR(discard, discardable_extents),
588 BTRFS_ATTR_PTR(discard, discard_bitmap_bytes),
589 BTRFS_ATTR_PTR(discard, discard_bytes_saved),
590 BTRFS_ATTR_PTR(discard, discard_extent_bytes),
591 BTRFS_ATTR_PTR(discard, iops_limit),
592 BTRFS_ATTR_PTR(discard, kbps_limit),
593 BTRFS_ATTR_PTR(discard, max_discard_size),
598 * Per-filesystem runtime debugging exported via sysfs.
600 * Path: /sys/fs/btrfs/UUID/debug/
602 static const struct attribute *btrfs_debug_mount_attrs[] = {
607 * Runtime debugging exported via sysfs, applies to all mounted filesystems.
609 * Path: /sys/fs/btrfs/debug
611 static struct attribute *btrfs_debug_feature_attrs[] = {
615 static const struct attribute_group btrfs_debug_feature_attr_group = {
617 .attrs = btrfs_debug_feature_attrs,
622 static ssize_t btrfs_show_u64(u64 *value_ptr, spinlock_t *lock, char *buf)
630 return sysfs_emit(buf, "%llu\n", val);
633 static ssize_t global_rsv_size_show(struct kobject *kobj,
634 struct kobj_attribute *ka, char *buf)
636 struct btrfs_fs_info *fs_info = to_fs_info(kobj->parent);
637 struct btrfs_block_rsv *block_rsv = &fs_info->global_block_rsv;
638 return btrfs_show_u64(&block_rsv->size, &block_rsv->lock, buf);
640 BTRFS_ATTR(allocation, global_rsv_size, global_rsv_size_show);
642 static ssize_t global_rsv_reserved_show(struct kobject *kobj,
643 struct kobj_attribute *a, char *buf)
645 struct btrfs_fs_info *fs_info = to_fs_info(kobj->parent);
646 struct btrfs_block_rsv *block_rsv = &fs_info->global_block_rsv;
647 return btrfs_show_u64(&block_rsv->reserved, &block_rsv->lock, buf);
649 BTRFS_ATTR(allocation, global_rsv_reserved, global_rsv_reserved_show);
651 #define to_space_info(_kobj) container_of(_kobj, struct btrfs_space_info, kobj)
652 #define to_raid_kobj(_kobj) container_of(_kobj, struct raid_kobject, kobj)
654 static ssize_t raid_bytes_show(struct kobject *kobj,
655 struct kobj_attribute *attr, char *buf);
656 BTRFS_ATTR(raid, total_bytes, raid_bytes_show);
657 BTRFS_ATTR(raid, used_bytes, raid_bytes_show);
659 static ssize_t raid_bytes_show(struct kobject *kobj,
660 struct kobj_attribute *attr, char *buf)
663 struct btrfs_space_info *sinfo = to_space_info(kobj->parent);
664 struct btrfs_block_group *block_group;
665 int index = btrfs_bg_flags_to_raid_index(to_raid_kobj(kobj)->flags);
668 down_read(&sinfo->groups_sem);
669 list_for_each_entry(block_group, &sinfo->block_groups[index], list) {
670 if (&attr->attr == BTRFS_ATTR_PTR(raid, total_bytes))
671 val += block_group->length;
673 val += block_group->used;
675 up_read(&sinfo->groups_sem);
676 return sysfs_emit(buf, "%llu\n", val);
680 * Allocation information about block group profiles.
682 * Path: /sys/fs/btrfs/<uuid>/allocation/<bg-type>/<bg-profile>/
684 static struct attribute *raid_attrs[] = {
685 BTRFS_ATTR_PTR(raid, total_bytes),
686 BTRFS_ATTR_PTR(raid, used_bytes),
689 ATTRIBUTE_GROUPS(raid);
691 static void release_raid_kobj(struct kobject *kobj)
693 kfree(to_raid_kobj(kobj));
696 static struct kobj_type btrfs_raid_ktype = {
697 .sysfs_ops = &kobj_sysfs_ops,
698 .release = release_raid_kobj,
699 .default_groups = raid_groups,
702 #define SPACE_INFO_ATTR(field) \
703 static ssize_t btrfs_space_info_show_##field(struct kobject *kobj, \
704 struct kobj_attribute *a, \
707 struct btrfs_space_info *sinfo = to_space_info(kobj); \
708 return btrfs_show_u64(&sinfo->field, &sinfo->lock, buf); \
710 BTRFS_ATTR(space_info, field, btrfs_space_info_show_##field)
712 SPACE_INFO_ATTR(flags);
713 SPACE_INFO_ATTR(total_bytes);
714 SPACE_INFO_ATTR(bytes_used);
715 SPACE_INFO_ATTR(bytes_pinned);
716 SPACE_INFO_ATTR(bytes_reserved);
717 SPACE_INFO_ATTR(bytes_may_use);
718 SPACE_INFO_ATTR(bytes_readonly);
719 SPACE_INFO_ATTR(bytes_zone_unusable);
720 SPACE_INFO_ATTR(disk_used);
721 SPACE_INFO_ATTR(disk_total);
723 static ssize_t btrfs_sinfo_bg_reclaim_threshold_show(struct kobject *kobj,
724 struct kobj_attribute *a,
727 struct btrfs_space_info *space_info = to_space_info(kobj);
730 ret = sysfs_emit(buf, "%d\n", READ_ONCE(space_info->bg_reclaim_threshold));
735 static ssize_t btrfs_sinfo_bg_reclaim_threshold_store(struct kobject *kobj,
736 struct kobj_attribute *a,
737 const char *buf, size_t len)
739 struct btrfs_space_info *space_info = to_space_info(kobj);
743 ret = kstrtoint(buf, 10, &thresh);
747 if (thresh < 0 || thresh > 100)
750 WRITE_ONCE(space_info->bg_reclaim_threshold, thresh);
755 BTRFS_ATTR_RW(space_info, bg_reclaim_threshold,
756 btrfs_sinfo_bg_reclaim_threshold_show,
757 btrfs_sinfo_bg_reclaim_threshold_store);
760 * Allocation information about block group types.
762 * Path: /sys/fs/btrfs/<uuid>/allocation/<bg-type>/
764 static struct attribute *space_info_attrs[] = {
765 BTRFS_ATTR_PTR(space_info, flags),
766 BTRFS_ATTR_PTR(space_info, total_bytes),
767 BTRFS_ATTR_PTR(space_info, bytes_used),
768 BTRFS_ATTR_PTR(space_info, bytes_pinned),
769 BTRFS_ATTR_PTR(space_info, bytes_reserved),
770 BTRFS_ATTR_PTR(space_info, bytes_may_use),
771 BTRFS_ATTR_PTR(space_info, bytes_readonly),
772 BTRFS_ATTR_PTR(space_info, bytes_zone_unusable),
773 BTRFS_ATTR_PTR(space_info, disk_used),
774 BTRFS_ATTR_PTR(space_info, disk_total),
775 BTRFS_ATTR_PTR(space_info, bg_reclaim_threshold),
778 ATTRIBUTE_GROUPS(space_info);
780 static void space_info_release(struct kobject *kobj)
782 struct btrfs_space_info *sinfo = to_space_info(kobj);
786 static struct kobj_type space_info_ktype = {
787 .sysfs_ops = &kobj_sysfs_ops,
788 .release = space_info_release,
789 .default_groups = space_info_groups,
793 * Allocation information about block groups.
795 * Path: /sys/fs/btrfs/<uuid>/allocation/
797 static const struct attribute *allocation_attrs[] = {
798 BTRFS_ATTR_PTR(allocation, global_rsv_reserved),
799 BTRFS_ATTR_PTR(allocation, global_rsv_size),
803 static ssize_t btrfs_label_show(struct kobject *kobj,
804 struct kobj_attribute *a, char *buf)
806 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
807 char *label = fs_info->super_copy->label;
810 spin_lock(&fs_info->super_lock);
811 ret = sysfs_emit(buf, label[0] ? "%s\n" : "%s", label);
812 spin_unlock(&fs_info->super_lock);
817 static ssize_t btrfs_label_store(struct kobject *kobj,
818 struct kobj_attribute *a,
819 const char *buf, size_t len)
821 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
827 if (sb_rdonly(fs_info->sb))
831 * p_len is the len until the first occurrence of either
834 p_len = strcspn(buf, "\n");
836 if (p_len >= BTRFS_LABEL_SIZE)
839 spin_lock(&fs_info->super_lock);
840 memset(fs_info->super_copy->label, 0, BTRFS_LABEL_SIZE);
841 memcpy(fs_info->super_copy->label, buf, p_len);
842 spin_unlock(&fs_info->super_lock);
845 * We don't want to do full transaction commit from inside sysfs
847 btrfs_set_pending(fs_info, COMMIT);
848 wake_up_process(fs_info->transaction_kthread);
852 BTRFS_ATTR_RW(, label, btrfs_label_show, btrfs_label_store);
854 static ssize_t btrfs_nodesize_show(struct kobject *kobj,
855 struct kobj_attribute *a, char *buf)
857 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
859 return sysfs_emit(buf, "%u\n", fs_info->super_copy->nodesize);
862 BTRFS_ATTR(, nodesize, btrfs_nodesize_show);
864 static ssize_t btrfs_sectorsize_show(struct kobject *kobj,
865 struct kobj_attribute *a, char *buf)
867 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
869 return sysfs_emit(buf, "%u\n", fs_info->super_copy->sectorsize);
872 BTRFS_ATTR(, sectorsize, btrfs_sectorsize_show);
874 static ssize_t btrfs_clone_alignment_show(struct kobject *kobj,
875 struct kobj_attribute *a, char *buf)
877 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
879 return sysfs_emit(buf, "%u\n", fs_info->super_copy->sectorsize);
882 BTRFS_ATTR(, clone_alignment, btrfs_clone_alignment_show);
884 static ssize_t quota_override_show(struct kobject *kobj,
885 struct kobj_attribute *a, char *buf)
887 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
890 quota_override = test_bit(BTRFS_FS_QUOTA_OVERRIDE, &fs_info->flags);
891 return sysfs_emit(buf, "%d\n", quota_override);
894 static ssize_t quota_override_store(struct kobject *kobj,
895 struct kobj_attribute *a,
896 const char *buf, size_t len)
898 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
905 if (!capable(CAP_SYS_RESOURCE))
908 err = kstrtoul(buf, 10, &knob);
915 set_bit(BTRFS_FS_QUOTA_OVERRIDE, &fs_info->flags);
917 clear_bit(BTRFS_FS_QUOTA_OVERRIDE, &fs_info->flags);
922 BTRFS_ATTR_RW(, quota_override, quota_override_show, quota_override_store);
924 static ssize_t btrfs_metadata_uuid_show(struct kobject *kobj,
925 struct kobj_attribute *a, char *buf)
927 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
929 return sysfs_emit(buf, "%pU\n", fs_info->fs_devices->metadata_uuid);
932 BTRFS_ATTR(, metadata_uuid, btrfs_metadata_uuid_show);
934 static ssize_t btrfs_checksum_show(struct kobject *kobj,
935 struct kobj_attribute *a, char *buf)
937 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
938 u16 csum_type = btrfs_super_csum_type(fs_info->super_copy);
940 return sysfs_emit(buf, "%s (%s)\n",
941 btrfs_super_csum_name(csum_type),
942 crypto_shash_driver_name(fs_info->csum_shash));
945 BTRFS_ATTR(, checksum, btrfs_checksum_show);
947 static ssize_t btrfs_exclusive_operation_show(struct kobject *kobj,
948 struct kobj_attribute *a, char *buf)
950 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
953 switch (READ_ONCE(fs_info->exclusive_operation)) {
954 case BTRFS_EXCLOP_NONE:
957 case BTRFS_EXCLOP_BALANCE:
960 case BTRFS_EXCLOP_BALANCE_PAUSED:
961 str = "balance paused\n";
963 case BTRFS_EXCLOP_DEV_ADD:
964 str = "device add\n";
966 case BTRFS_EXCLOP_DEV_REMOVE:
967 str = "device remove\n";
969 case BTRFS_EXCLOP_DEV_REPLACE:
970 str = "device replace\n";
972 case BTRFS_EXCLOP_RESIZE:
975 case BTRFS_EXCLOP_SWAP_ACTIVATE:
976 str = "swap activate\n";
982 return sysfs_emit(buf, "%s", str);
984 BTRFS_ATTR(, exclusive_operation, btrfs_exclusive_operation_show);
986 static ssize_t btrfs_generation_show(struct kobject *kobj,
987 struct kobj_attribute *a, char *buf)
989 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
991 return sysfs_emit(buf, "%llu\n", fs_info->generation);
993 BTRFS_ATTR(, generation, btrfs_generation_show);
996 * Look for an exact string @string in @buffer with possible leading or
997 * trailing whitespace
999 static bool strmatch(const char *buffer, const char *string)
1001 const size_t len = strlen(string);
1003 /* Skip leading whitespace */
1004 buffer = skip_spaces(buffer);
1006 /* Match entire string, check if the rest is whitespace or empty */
1007 if (strncmp(string, buffer, len) == 0 &&
1008 strlen(skip_spaces(buffer + len)) == 0)
1014 static const char * const btrfs_read_policy_name[] = { "pid" };
1016 static ssize_t btrfs_read_policy_show(struct kobject *kobj,
1017 struct kobj_attribute *a, char *buf)
1019 struct btrfs_fs_devices *fs_devices = to_fs_devs(kobj);
1023 for (i = 0; i < BTRFS_NR_READ_POLICY; i++) {
1024 if (fs_devices->read_policy == i)
1025 ret += scnprintf(buf + ret, PAGE_SIZE - ret, "%s[%s]",
1026 (ret == 0 ? "" : " "),
1027 btrfs_read_policy_name[i]);
1029 ret += scnprintf(buf + ret, PAGE_SIZE - ret, "%s%s",
1030 (ret == 0 ? "" : " "),
1031 btrfs_read_policy_name[i]);
1034 ret += scnprintf(buf + ret, PAGE_SIZE - ret, "\n");
1039 static ssize_t btrfs_read_policy_store(struct kobject *kobj,
1040 struct kobj_attribute *a,
1041 const char *buf, size_t len)
1043 struct btrfs_fs_devices *fs_devices = to_fs_devs(kobj);
1046 for (i = 0; i < BTRFS_NR_READ_POLICY; i++) {
1047 if (strmatch(buf, btrfs_read_policy_name[i])) {
1048 if (i != fs_devices->read_policy) {
1049 fs_devices->read_policy = i;
1050 btrfs_info(fs_devices->fs_info,
1051 "read policy set to '%s'",
1052 btrfs_read_policy_name[i]);
1060 BTRFS_ATTR_RW(, read_policy, btrfs_read_policy_show, btrfs_read_policy_store);
1062 static ssize_t btrfs_bg_reclaim_threshold_show(struct kobject *kobj,
1063 struct kobj_attribute *a,
1066 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
1069 ret = sysfs_emit(buf, "%d\n", READ_ONCE(fs_info->bg_reclaim_threshold));
1074 static ssize_t btrfs_bg_reclaim_threshold_store(struct kobject *kobj,
1075 struct kobj_attribute *a,
1076 const char *buf, size_t len)
1078 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
1082 ret = kstrtoint(buf, 10, &thresh);
1086 if (thresh != 0 && (thresh <= 50 || thresh > 100))
1089 WRITE_ONCE(fs_info->bg_reclaim_threshold, thresh);
1093 BTRFS_ATTR_RW(, bg_reclaim_threshold, btrfs_bg_reclaim_threshold_show,
1094 btrfs_bg_reclaim_threshold_store);
1097 * Per-filesystem information and stats.
1099 * Path: /sys/fs/btrfs/<uuid>/
1101 static const struct attribute *btrfs_attrs[] = {
1102 BTRFS_ATTR_PTR(, label),
1103 BTRFS_ATTR_PTR(, nodesize),
1104 BTRFS_ATTR_PTR(, sectorsize),
1105 BTRFS_ATTR_PTR(, clone_alignment),
1106 BTRFS_ATTR_PTR(, quota_override),
1107 BTRFS_ATTR_PTR(, metadata_uuid),
1108 BTRFS_ATTR_PTR(, checksum),
1109 BTRFS_ATTR_PTR(, exclusive_operation),
1110 BTRFS_ATTR_PTR(, generation),
1111 BTRFS_ATTR_PTR(, read_policy),
1112 BTRFS_ATTR_PTR(, bg_reclaim_threshold),
1116 static void btrfs_release_fsid_kobj(struct kobject *kobj)
1118 struct btrfs_fs_devices *fs_devs = to_fs_devs(kobj);
1120 memset(&fs_devs->fsid_kobj, 0, sizeof(struct kobject));
1121 complete(&fs_devs->kobj_unregister);
1124 static struct kobj_type btrfs_ktype = {
1125 .sysfs_ops = &kobj_sysfs_ops,
1126 .release = btrfs_release_fsid_kobj,
1129 static inline struct btrfs_fs_devices *to_fs_devs(struct kobject *kobj)
1131 if (kobj->ktype != &btrfs_ktype)
1133 return container_of(kobj, struct btrfs_fs_devices, fsid_kobj);
1136 static inline struct btrfs_fs_info *to_fs_info(struct kobject *kobj)
1138 if (kobj->ktype != &btrfs_ktype)
1140 return to_fs_devs(kobj)->fs_info;
1143 #define NUM_FEATURE_BITS 64
1144 #define BTRFS_FEATURE_NAME_MAX 13
1145 static char btrfs_unknown_feature_names[FEAT_MAX][NUM_FEATURE_BITS][BTRFS_FEATURE_NAME_MAX];
1146 static struct btrfs_feature_attr btrfs_feature_attrs[FEAT_MAX][NUM_FEATURE_BITS];
1148 static_assert(ARRAY_SIZE(btrfs_unknown_feature_names) ==
1149 ARRAY_SIZE(btrfs_feature_attrs));
1150 static_assert(ARRAY_SIZE(btrfs_unknown_feature_names[0]) ==
1151 ARRAY_SIZE(btrfs_feature_attrs[0]));
1153 static const u64 supported_feature_masks[FEAT_MAX] = {
1154 [FEAT_COMPAT] = BTRFS_FEATURE_COMPAT_SUPP,
1155 [FEAT_COMPAT_RO] = BTRFS_FEATURE_COMPAT_RO_SUPP,
1156 [FEAT_INCOMPAT] = BTRFS_FEATURE_INCOMPAT_SUPP,
1159 static int addrm_unknown_feature_attrs(struct btrfs_fs_info *fs_info, bool add)
1163 for (set = 0; set < FEAT_MAX; set++) {
1165 struct attribute *attrs[2];
1166 struct attribute_group agroup = {
1170 u64 features = get_features(fs_info, set);
1171 features &= ~supported_feature_masks[set];
1177 for (i = 0; i < NUM_FEATURE_BITS; i++) {
1178 struct btrfs_feature_attr *fa;
1180 if (!(features & (1ULL << i)))
1183 fa = &btrfs_feature_attrs[set][i];
1184 attrs[0] = &fa->kobj_attr.attr;
1187 ret = sysfs_merge_group(&fs_info->fs_devices->fsid_kobj,
1192 sysfs_unmerge_group(&fs_info->fs_devices->fsid_kobj,
1200 static void __btrfs_sysfs_remove_fsid(struct btrfs_fs_devices *fs_devs)
1202 if (fs_devs->devinfo_kobj) {
1203 kobject_del(fs_devs->devinfo_kobj);
1204 kobject_put(fs_devs->devinfo_kobj);
1205 fs_devs->devinfo_kobj = NULL;
1208 if (fs_devs->devices_kobj) {
1209 kobject_del(fs_devs->devices_kobj);
1210 kobject_put(fs_devs->devices_kobj);
1211 fs_devs->devices_kobj = NULL;
1214 if (fs_devs->fsid_kobj.state_initialized) {
1215 kobject_del(&fs_devs->fsid_kobj);
1216 kobject_put(&fs_devs->fsid_kobj);
1217 wait_for_completion(&fs_devs->kobj_unregister);
1221 /* when fs_devs is NULL it will remove all fsid kobject */
1222 void btrfs_sysfs_remove_fsid(struct btrfs_fs_devices *fs_devs)
1224 struct list_head *fs_uuids = btrfs_get_fs_uuids();
1227 __btrfs_sysfs_remove_fsid(fs_devs);
1231 list_for_each_entry(fs_devs, fs_uuids, fs_list) {
1232 __btrfs_sysfs_remove_fsid(fs_devs);
1236 static void btrfs_sysfs_remove_fs_devices(struct btrfs_fs_devices *fs_devices)
1238 struct btrfs_device *device;
1239 struct btrfs_fs_devices *seed;
1241 list_for_each_entry(device, &fs_devices->devices, dev_list)
1242 btrfs_sysfs_remove_device(device);
1244 list_for_each_entry(seed, &fs_devices->seed_list, seed_list) {
1245 list_for_each_entry(device, &seed->devices, dev_list)
1246 btrfs_sysfs_remove_device(device);
1250 void btrfs_sysfs_remove_mounted(struct btrfs_fs_info *fs_info)
1252 struct kobject *fsid_kobj = &fs_info->fs_devices->fsid_kobj;
1254 sysfs_remove_link(fsid_kobj, "bdi");
1256 if (fs_info->space_info_kobj) {
1257 sysfs_remove_files(fs_info->space_info_kobj, allocation_attrs);
1258 kobject_del(fs_info->space_info_kobj);
1259 kobject_put(fs_info->space_info_kobj);
1261 #ifdef CONFIG_BTRFS_DEBUG
1262 if (fs_info->discard_debug_kobj) {
1263 sysfs_remove_files(fs_info->discard_debug_kobj,
1264 discard_debug_attrs);
1265 kobject_del(fs_info->discard_debug_kobj);
1266 kobject_put(fs_info->discard_debug_kobj);
1268 if (fs_info->debug_kobj) {
1269 sysfs_remove_files(fs_info->debug_kobj, btrfs_debug_mount_attrs);
1270 kobject_del(fs_info->debug_kobj);
1271 kobject_put(fs_info->debug_kobj);
1274 addrm_unknown_feature_attrs(fs_info, false);
1275 sysfs_remove_group(fsid_kobj, &btrfs_feature_attr_group);
1276 sysfs_remove_files(fsid_kobj, btrfs_attrs);
1277 btrfs_sysfs_remove_fs_devices(fs_info->fs_devices);
1280 static const char * const btrfs_feature_set_names[FEAT_MAX] = {
1281 [FEAT_COMPAT] = "compat",
1282 [FEAT_COMPAT_RO] = "compat_ro",
1283 [FEAT_INCOMPAT] = "incompat",
1286 const char *btrfs_feature_set_name(enum btrfs_feature_set set)
1288 return btrfs_feature_set_names[set];
1291 char *btrfs_printable_features(enum btrfs_feature_set set, u64 flags)
1293 size_t bufsize = 4096; /* safe max, 64 names * 64 bytes */
1298 str = kmalloc(bufsize, GFP_KERNEL);
1302 for (i = 0; i < ARRAY_SIZE(btrfs_feature_attrs[set]); i++) {
1305 if (!(flags & (1ULL << i)))
1308 name = btrfs_feature_attrs[set][i].kobj_attr.attr.name;
1309 len += scnprintf(str + len, bufsize - len, "%s%s",
1310 len ? "," : "", name);
1316 static void init_feature_attrs(void)
1318 struct btrfs_feature_attr *fa;
1321 memset(btrfs_feature_attrs, 0, sizeof(btrfs_feature_attrs));
1322 memset(btrfs_unknown_feature_names, 0,
1323 sizeof(btrfs_unknown_feature_names));
1325 for (i = 0; btrfs_supported_feature_attrs[i]; i++) {
1326 struct btrfs_feature_attr *sfa;
1327 struct attribute *a = btrfs_supported_feature_attrs[i];
1329 sfa = attr_to_btrfs_feature_attr(a);
1330 bit = ilog2(sfa->feature_bit);
1331 fa = &btrfs_feature_attrs[sfa->feature_set][bit];
1333 fa->kobj_attr.attr.name = sfa->kobj_attr.attr.name;
1336 for (set = 0; set < FEAT_MAX; set++) {
1337 for (i = 0; i < ARRAY_SIZE(btrfs_feature_attrs[set]); i++) {
1338 char *name = btrfs_unknown_feature_names[set][i];
1339 fa = &btrfs_feature_attrs[set][i];
1341 if (fa->kobj_attr.attr.name)
1344 snprintf(name, BTRFS_FEATURE_NAME_MAX, "%s:%u",
1345 btrfs_feature_set_names[set], i);
1347 fa->kobj_attr.attr.name = name;
1348 fa->kobj_attr.attr.mode = S_IRUGO;
1349 fa->feature_set = set;
1350 fa->feature_bit = 1ULL << i;
1356 * Create a sysfs entry for a given block group type at path
1357 * /sys/fs/btrfs/UUID/allocation/data/TYPE
1359 void btrfs_sysfs_add_block_group_type(struct btrfs_block_group *cache)
1361 struct btrfs_fs_info *fs_info = cache->fs_info;
1362 struct btrfs_space_info *space_info = cache->space_info;
1363 struct raid_kobject *rkobj;
1364 const int index = btrfs_bg_flags_to_raid_index(cache->flags);
1365 unsigned int nofs_flag;
1369 * Setup a NOFS context because kobject_add(), deep in its call chain,
1370 * does GFP_KERNEL allocations, and we are often called in a context
1371 * where if reclaim is triggered we can deadlock (we are either holding
1372 * a transaction handle or some lock required for a transaction
1375 nofs_flag = memalloc_nofs_save();
1377 rkobj = kzalloc(sizeof(*rkobj), GFP_NOFS);
1379 memalloc_nofs_restore(nofs_flag);
1380 btrfs_warn(cache->fs_info,
1381 "couldn't alloc memory for raid level kobject");
1385 rkobj->flags = cache->flags;
1386 kobject_init(&rkobj->kobj, &btrfs_raid_ktype);
1389 * We call this either on mount, or if we've created a block group for a
1390 * new index type while running (i.e. when restriping). The running
1391 * case is tricky because we could race with other threads, so we need
1392 * to have this check to make sure we didn't already init the kobject.
1394 * We don't have to protect on the free side because it only happens on
1397 spin_lock(&space_info->lock);
1398 if (space_info->block_group_kobjs[index]) {
1399 spin_unlock(&space_info->lock);
1400 kobject_put(&rkobj->kobj);
1403 space_info->block_group_kobjs[index] = &rkobj->kobj;
1405 spin_unlock(&space_info->lock);
1407 ret = kobject_add(&rkobj->kobj, &space_info->kobj, "%s",
1408 btrfs_bg_type_to_raid_name(rkobj->flags));
1409 memalloc_nofs_restore(nofs_flag);
1411 spin_lock(&space_info->lock);
1412 space_info->block_group_kobjs[index] = NULL;
1413 spin_unlock(&space_info->lock);
1414 kobject_put(&rkobj->kobj);
1416 "failed to add kobject for block cache, ignoring");
1422 * Remove sysfs directories for all block group types of a given space info and
1423 * the space info as well
1425 void btrfs_sysfs_remove_space_info(struct btrfs_space_info *space_info)
1429 for (i = 0; i < BTRFS_NR_RAID_TYPES; i++) {
1430 struct kobject *kobj;
1432 kobj = space_info->block_group_kobjs[i];
1433 space_info->block_group_kobjs[i] = NULL;
1439 kobject_del(&space_info->kobj);
1440 kobject_put(&space_info->kobj);
1443 static const char *alloc_name(u64 flags)
1446 case BTRFS_BLOCK_GROUP_METADATA | BTRFS_BLOCK_GROUP_DATA:
1448 case BTRFS_BLOCK_GROUP_METADATA:
1450 case BTRFS_BLOCK_GROUP_DATA:
1452 case BTRFS_BLOCK_GROUP_SYSTEM:
1456 return "invalid-combination";
1461 * Create a sysfs entry for a space info type at path
1462 * /sys/fs/btrfs/UUID/allocation/TYPE
1464 int btrfs_sysfs_add_space_info_type(struct btrfs_fs_info *fs_info,
1465 struct btrfs_space_info *space_info)
1469 ret = kobject_init_and_add(&space_info->kobj, &space_info_ktype,
1470 fs_info->space_info_kobj, "%s",
1471 alloc_name(space_info->flags));
1473 kobject_put(&space_info->kobj);
1480 void btrfs_sysfs_remove_device(struct btrfs_device *device)
1482 struct kobject *devices_kobj;
1485 * Seed fs_devices devices_kobj aren't used, fetch kobject from the
1486 * fs_info::fs_devices.
1488 devices_kobj = device->fs_info->fs_devices->devices_kobj;
1489 ASSERT(devices_kobj);
1492 sysfs_remove_link(devices_kobj, bdev_kobj(device->bdev)->name);
1494 if (device->devid_kobj.state_initialized) {
1495 kobject_del(&device->devid_kobj);
1496 kobject_put(&device->devid_kobj);
1497 wait_for_completion(&device->kobj_unregister);
1501 static ssize_t btrfs_devinfo_in_fs_metadata_show(struct kobject *kobj,
1502 struct kobj_attribute *a,
1506 struct btrfs_device *device = container_of(kobj, struct btrfs_device,
1509 val = !!test_bit(BTRFS_DEV_STATE_IN_FS_METADATA, &device->dev_state);
1511 return sysfs_emit(buf, "%d\n", val);
1513 BTRFS_ATTR(devid, in_fs_metadata, btrfs_devinfo_in_fs_metadata_show);
1515 static ssize_t btrfs_devinfo_missing_show(struct kobject *kobj,
1516 struct kobj_attribute *a, char *buf)
1519 struct btrfs_device *device = container_of(kobj, struct btrfs_device,
1522 val = !!test_bit(BTRFS_DEV_STATE_MISSING, &device->dev_state);
1524 return sysfs_emit(buf, "%d\n", val);
1526 BTRFS_ATTR(devid, missing, btrfs_devinfo_missing_show);
1528 static ssize_t btrfs_devinfo_replace_target_show(struct kobject *kobj,
1529 struct kobj_attribute *a,
1533 struct btrfs_device *device = container_of(kobj, struct btrfs_device,
1536 val = !!test_bit(BTRFS_DEV_STATE_REPLACE_TGT, &device->dev_state);
1538 return sysfs_emit(buf, "%d\n", val);
1540 BTRFS_ATTR(devid, replace_target, btrfs_devinfo_replace_target_show);
1542 static ssize_t btrfs_devinfo_scrub_speed_max_show(struct kobject *kobj,
1543 struct kobj_attribute *a,
1546 struct btrfs_device *device = container_of(kobj, struct btrfs_device,
1549 return sysfs_emit(buf, "%llu\n", READ_ONCE(device->scrub_speed_max));
1552 static ssize_t btrfs_devinfo_scrub_speed_max_store(struct kobject *kobj,
1553 struct kobj_attribute *a,
1554 const char *buf, size_t len)
1556 struct btrfs_device *device = container_of(kobj, struct btrfs_device,
1559 unsigned long long limit;
1561 limit = memparse(buf, &endptr);
1562 WRITE_ONCE(device->scrub_speed_max, limit);
1565 BTRFS_ATTR_RW(devid, scrub_speed_max, btrfs_devinfo_scrub_speed_max_show,
1566 btrfs_devinfo_scrub_speed_max_store);
1568 static ssize_t btrfs_devinfo_writeable_show(struct kobject *kobj,
1569 struct kobj_attribute *a, char *buf)
1572 struct btrfs_device *device = container_of(kobj, struct btrfs_device,
1575 val = !!test_bit(BTRFS_DEV_STATE_WRITEABLE, &device->dev_state);
1577 return sysfs_emit(buf, "%d\n", val);
1579 BTRFS_ATTR(devid, writeable, btrfs_devinfo_writeable_show);
1581 static ssize_t btrfs_devinfo_fsid_show(struct kobject *kobj,
1582 struct kobj_attribute *a, char *buf)
1584 struct btrfs_device *device = container_of(kobj, struct btrfs_device,
1587 return sysfs_emit(buf, "%pU\n", device->fs_devices->fsid);
1589 BTRFS_ATTR(devid, fsid, btrfs_devinfo_fsid_show);
1591 static ssize_t btrfs_devinfo_error_stats_show(struct kobject *kobj,
1592 struct kobj_attribute *a, char *buf)
1594 struct btrfs_device *device = container_of(kobj, struct btrfs_device,
1597 if (!device->dev_stats_valid)
1598 return sysfs_emit(buf, "invalid\n");
1601 * Print all at once so we get a snapshot of all values from the same
1602 * time. Keep them in sync and in order of definition of
1603 * btrfs_dev_stat_values.
1605 return sysfs_emit(buf,
1609 "corruption_errs %d\n"
1610 "generation_errs %d\n",
1611 btrfs_dev_stat_read(device, BTRFS_DEV_STAT_WRITE_ERRS),
1612 btrfs_dev_stat_read(device, BTRFS_DEV_STAT_READ_ERRS),
1613 btrfs_dev_stat_read(device, BTRFS_DEV_STAT_FLUSH_ERRS),
1614 btrfs_dev_stat_read(device, BTRFS_DEV_STAT_CORRUPTION_ERRS),
1615 btrfs_dev_stat_read(device, BTRFS_DEV_STAT_GENERATION_ERRS));
1617 BTRFS_ATTR(devid, error_stats, btrfs_devinfo_error_stats_show);
1620 * Information about one device.
1622 * Path: /sys/fs/btrfs/<uuid>/devinfo/<devid>/
1624 static struct attribute *devid_attrs[] = {
1625 BTRFS_ATTR_PTR(devid, error_stats),
1626 BTRFS_ATTR_PTR(devid, fsid),
1627 BTRFS_ATTR_PTR(devid, in_fs_metadata),
1628 BTRFS_ATTR_PTR(devid, missing),
1629 BTRFS_ATTR_PTR(devid, replace_target),
1630 BTRFS_ATTR_PTR(devid, scrub_speed_max),
1631 BTRFS_ATTR_PTR(devid, writeable),
1634 ATTRIBUTE_GROUPS(devid);
1636 static void btrfs_release_devid_kobj(struct kobject *kobj)
1638 struct btrfs_device *device = container_of(kobj, struct btrfs_device,
1641 memset(&device->devid_kobj, 0, sizeof(struct kobject));
1642 complete(&device->kobj_unregister);
1645 static struct kobj_type devid_ktype = {
1646 .sysfs_ops = &kobj_sysfs_ops,
1647 .default_groups = devid_groups,
1648 .release = btrfs_release_devid_kobj,
1651 int btrfs_sysfs_add_device(struct btrfs_device *device)
1654 unsigned int nofs_flag;
1655 struct kobject *devices_kobj;
1656 struct kobject *devinfo_kobj;
1659 * Make sure we use the fs_info::fs_devices to fetch the kobjects even
1660 * for the seed fs_devices
1662 devices_kobj = device->fs_info->fs_devices->devices_kobj;
1663 devinfo_kobj = device->fs_info->fs_devices->devinfo_kobj;
1664 ASSERT(devices_kobj);
1665 ASSERT(devinfo_kobj);
1667 nofs_flag = memalloc_nofs_save();
1670 struct kobject *disk_kobj = bdev_kobj(device->bdev);
1672 ret = sysfs_create_link(devices_kobj, disk_kobj, disk_kobj->name);
1674 btrfs_warn(device->fs_info,
1675 "creating sysfs device link for devid %llu failed: %d",
1676 device->devid, ret);
1681 init_completion(&device->kobj_unregister);
1682 ret = kobject_init_and_add(&device->devid_kobj, &devid_ktype,
1683 devinfo_kobj, "%llu", device->devid);
1685 kobject_put(&device->devid_kobj);
1686 btrfs_warn(device->fs_info,
1687 "devinfo init for devid %llu failed: %d",
1688 device->devid, ret);
1692 memalloc_nofs_restore(nofs_flag);
1696 static int btrfs_sysfs_add_fs_devices(struct btrfs_fs_devices *fs_devices)
1699 struct btrfs_device *device;
1700 struct btrfs_fs_devices *seed;
1702 list_for_each_entry(device, &fs_devices->devices, dev_list) {
1703 ret = btrfs_sysfs_add_device(device);
1708 list_for_each_entry(seed, &fs_devices->seed_list, seed_list) {
1709 list_for_each_entry(device, &seed->devices, dev_list) {
1710 ret = btrfs_sysfs_add_device(device);
1719 btrfs_sysfs_remove_fs_devices(fs_devices);
1723 void btrfs_kobject_uevent(struct block_device *bdev, enum kobject_action action)
1727 ret = kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, action);
1729 pr_warn("BTRFS: Sending event '%d' to kobject: '%s' (%p): failed\n",
1730 action, kobject_name(&disk_to_dev(bdev->bd_disk)->kobj),
1731 &disk_to_dev(bdev->bd_disk)->kobj);
1734 void btrfs_sysfs_update_sprout_fsid(struct btrfs_fs_devices *fs_devices)
1737 char fsid_buf[BTRFS_UUID_UNPARSED_SIZE];
1740 * Sprouting changes fsid of the mounted filesystem, rename the fsid
1743 snprintf(fsid_buf, BTRFS_UUID_UNPARSED_SIZE, "%pU", fs_devices->fsid);
1744 if (kobject_rename(&fs_devices->fsid_kobj, fsid_buf))
1745 btrfs_warn(fs_devices->fs_info,
1746 "sysfs: failed to create fsid for sprout");
1749 void btrfs_sysfs_update_devid(struct btrfs_device *device)
1753 snprintf(tmp, sizeof(tmp), "%llu", device->devid);
1755 if (kobject_rename(&device->devid_kobj, tmp))
1756 btrfs_warn(device->fs_devices->fs_info,
1757 "sysfs: failed to update devid for %llu",
1761 /* /sys/fs/btrfs/ entry */
1762 static struct kset *btrfs_kset;
1766 * /sys/fs/btrfs/UUID
1768 * Can be called by the device discovery thread.
1770 int btrfs_sysfs_add_fsid(struct btrfs_fs_devices *fs_devs)
1774 init_completion(&fs_devs->kobj_unregister);
1775 fs_devs->fsid_kobj.kset = btrfs_kset;
1776 error = kobject_init_and_add(&fs_devs->fsid_kobj, &btrfs_ktype, NULL,
1777 "%pU", fs_devs->fsid);
1779 kobject_put(&fs_devs->fsid_kobj);
1783 fs_devs->devices_kobj = kobject_create_and_add("devices",
1784 &fs_devs->fsid_kobj);
1785 if (!fs_devs->devices_kobj) {
1786 btrfs_err(fs_devs->fs_info,
1787 "failed to init sysfs device interface");
1788 btrfs_sysfs_remove_fsid(fs_devs);
1792 fs_devs->devinfo_kobj = kobject_create_and_add("devinfo",
1793 &fs_devs->fsid_kobj);
1794 if (!fs_devs->devinfo_kobj) {
1795 btrfs_err(fs_devs->fs_info,
1796 "failed to init sysfs devinfo kobject");
1797 btrfs_sysfs_remove_fsid(fs_devs);
1804 int btrfs_sysfs_add_mounted(struct btrfs_fs_info *fs_info)
1807 struct btrfs_fs_devices *fs_devs = fs_info->fs_devices;
1808 struct kobject *fsid_kobj = &fs_devs->fsid_kobj;
1810 error = btrfs_sysfs_add_fs_devices(fs_devs);
1814 error = sysfs_create_files(fsid_kobj, btrfs_attrs);
1816 btrfs_sysfs_remove_fs_devices(fs_devs);
1820 error = sysfs_create_group(fsid_kobj,
1821 &btrfs_feature_attr_group);
1825 #ifdef CONFIG_BTRFS_DEBUG
1826 fs_info->debug_kobj = kobject_create_and_add("debug", fsid_kobj);
1827 if (!fs_info->debug_kobj) {
1832 error = sysfs_create_files(fs_info->debug_kobj, btrfs_debug_mount_attrs);
1836 /* Discard directory */
1837 fs_info->discard_debug_kobj = kobject_create_and_add("discard",
1838 fs_info->debug_kobj);
1839 if (!fs_info->discard_debug_kobj) {
1844 error = sysfs_create_files(fs_info->discard_debug_kobj,
1845 discard_debug_attrs);
1850 error = addrm_unknown_feature_attrs(fs_info, true);
1854 error = sysfs_create_link(fsid_kobj, &fs_info->sb->s_bdi->dev->kobj, "bdi");
1858 fs_info->space_info_kobj = kobject_create_and_add("allocation",
1860 if (!fs_info->space_info_kobj) {
1865 error = sysfs_create_files(fs_info->space_info_kobj, allocation_attrs);
1871 btrfs_sysfs_remove_mounted(fs_info);
1875 static inline struct btrfs_fs_info *qgroup_kobj_to_fs_info(struct kobject *kobj)
1877 return to_fs_info(kobj->parent->parent);
1880 #define QGROUP_ATTR(_member, _show_name) \
1881 static ssize_t btrfs_qgroup_show_##_member(struct kobject *qgroup_kobj, \
1882 struct kobj_attribute *a, \
1885 struct btrfs_fs_info *fs_info = qgroup_kobj_to_fs_info(qgroup_kobj); \
1886 struct btrfs_qgroup *qgroup = container_of(qgroup_kobj, \
1887 struct btrfs_qgroup, kobj); \
1888 return btrfs_show_u64(&qgroup->_member, &fs_info->qgroup_lock, buf); \
1890 BTRFS_ATTR(qgroup, _show_name, btrfs_qgroup_show_##_member)
1892 #define QGROUP_RSV_ATTR(_name, _type) \
1893 static ssize_t btrfs_qgroup_rsv_show_##_name(struct kobject *qgroup_kobj, \
1894 struct kobj_attribute *a, \
1897 struct btrfs_fs_info *fs_info = qgroup_kobj_to_fs_info(qgroup_kobj); \
1898 struct btrfs_qgroup *qgroup = container_of(qgroup_kobj, \
1899 struct btrfs_qgroup, kobj); \
1900 return btrfs_show_u64(&qgroup->rsv.values[_type], \
1901 &fs_info->qgroup_lock, buf); \
1903 BTRFS_ATTR(qgroup, rsv_##_name, btrfs_qgroup_rsv_show_##_name)
1905 QGROUP_ATTR(rfer, referenced);
1906 QGROUP_ATTR(excl, exclusive);
1907 QGROUP_ATTR(max_rfer, max_referenced);
1908 QGROUP_ATTR(max_excl, max_exclusive);
1909 QGROUP_ATTR(lim_flags, limit_flags);
1910 QGROUP_RSV_ATTR(data, BTRFS_QGROUP_RSV_DATA);
1911 QGROUP_RSV_ATTR(meta_pertrans, BTRFS_QGROUP_RSV_META_PERTRANS);
1912 QGROUP_RSV_ATTR(meta_prealloc, BTRFS_QGROUP_RSV_META_PREALLOC);
1915 * Qgroup information.
1917 * Path: /sys/fs/btrfs/<uuid>/qgroups/<level>_<qgroupid>/
1919 static struct attribute *qgroup_attrs[] = {
1920 BTRFS_ATTR_PTR(qgroup, referenced),
1921 BTRFS_ATTR_PTR(qgroup, exclusive),
1922 BTRFS_ATTR_PTR(qgroup, max_referenced),
1923 BTRFS_ATTR_PTR(qgroup, max_exclusive),
1924 BTRFS_ATTR_PTR(qgroup, limit_flags),
1925 BTRFS_ATTR_PTR(qgroup, rsv_data),
1926 BTRFS_ATTR_PTR(qgroup, rsv_meta_pertrans),
1927 BTRFS_ATTR_PTR(qgroup, rsv_meta_prealloc),
1930 ATTRIBUTE_GROUPS(qgroup);
1932 static void qgroup_release(struct kobject *kobj)
1934 struct btrfs_qgroup *qgroup = container_of(kobj, struct btrfs_qgroup, kobj);
1936 memset(&qgroup->kobj, 0, sizeof(*kobj));
1939 static struct kobj_type qgroup_ktype = {
1940 .sysfs_ops = &kobj_sysfs_ops,
1941 .release = qgroup_release,
1942 .default_groups = qgroup_groups,
1945 int btrfs_sysfs_add_one_qgroup(struct btrfs_fs_info *fs_info,
1946 struct btrfs_qgroup *qgroup)
1948 struct kobject *qgroups_kobj = fs_info->qgroups_kobj;
1951 if (test_bit(BTRFS_FS_STATE_DUMMY_FS_INFO, &fs_info->fs_state))
1953 if (qgroup->kobj.state_initialized)
1958 ret = kobject_init_and_add(&qgroup->kobj, &qgroup_ktype, qgroups_kobj,
1959 "%hu_%llu", btrfs_qgroup_level(qgroup->qgroupid),
1960 btrfs_qgroup_subvolid(qgroup->qgroupid));
1962 kobject_put(&qgroup->kobj);
1967 void btrfs_sysfs_del_qgroups(struct btrfs_fs_info *fs_info)
1969 struct btrfs_qgroup *qgroup;
1970 struct btrfs_qgroup *next;
1972 if (test_bit(BTRFS_FS_STATE_DUMMY_FS_INFO, &fs_info->fs_state))
1975 rbtree_postorder_for_each_entry_safe(qgroup, next,
1976 &fs_info->qgroup_tree, node)
1977 btrfs_sysfs_del_one_qgroup(fs_info, qgroup);
1978 if (fs_info->qgroups_kobj) {
1979 kobject_del(fs_info->qgroups_kobj);
1980 kobject_put(fs_info->qgroups_kobj);
1981 fs_info->qgroups_kobj = NULL;
1985 /* Called when qgroups get initialized, thus there is no need for locking */
1986 int btrfs_sysfs_add_qgroups(struct btrfs_fs_info *fs_info)
1988 struct kobject *fsid_kobj = &fs_info->fs_devices->fsid_kobj;
1989 struct btrfs_qgroup *qgroup;
1990 struct btrfs_qgroup *next;
1993 if (test_bit(BTRFS_FS_STATE_DUMMY_FS_INFO, &fs_info->fs_state))
1997 if (fs_info->qgroups_kobj)
2000 fs_info->qgroups_kobj = kobject_create_and_add("qgroups", fsid_kobj);
2001 if (!fs_info->qgroups_kobj) {
2005 rbtree_postorder_for_each_entry_safe(qgroup, next,
2006 &fs_info->qgroup_tree, node) {
2007 ret = btrfs_sysfs_add_one_qgroup(fs_info, qgroup);
2014 btrfs_sysfs_del_qgroups(fs_info);
2018 void btrfs_sysfs_del_one_qgroup(struct btrfs_fs_info *fs_info,
2019 struct btrfs_qgroup *qgroup)
2021 if (test_bit(BTRFS_FS_STATE_DUMMY_FS_INFO, &fs_info->fs_state))
2024 if (qgroup->kobj.state_initialized) {
2025 kobject_del(&qgroup->kobj);
2026 kobject_put(&qgroup->kobj);
2031 * Change per-fs features in /sys/fs/btrfs/UUID/features to match current
2032 * values in superblock. Call after any changes to incompat/compat_ro flags
2034 void btrfs_sysfs_feature_update(struct btrfs_fs_info *fs_info,
2035 u64 bit, enum btrfs_feature_set set)
2037 struct btrfs_fs_devices *fs_devs;
2038 struct kobject *fsid_kobj;
2039 u64 __maybe_unused features;
2040 int __maybe_unused ret;
2046 * See 14e46e04958df74 and e410e34fad913dd, feature bit updates are not
2047 * safe when called from some contexts (eg. balance)
2049 features = get_features(fs_info, set);
2050 ASSERT(bit & supported_feature_masks[set]);
2052 fs_devs = fs_info->fs_devices;
2053 fsid_kobj = &fs_devs->fsid_kobj;
2055 if (!fsid_kobj->state_initialized)
2059 * FIXME: this is too heavy to update just one value, ideally we'd like
2060 * to use sysfs_update_group but some refactoring is needed first.
2062 sysfs_remove_group(fsid_kobj, &btrfs_feature_attr_group);
2063 ret = sysfs_create_group(fsid_kobj, &btrfs_feature_attr_group);
2066 int __init btrfs_init_sysfs(void)
2070 btrfs_kset = kset_create_and_add("btrfs", NULL, fs_kobj);
2074 init_feature_attrs();
2075 ret = sysfs_create_group(&btrfs_kset->kobj, &btrfs_feature_attr_group);
2078 ret = sysfs_merge_group(&btrfs_kset->kobj,
2079 &btrfs_static_feature_attr_group);
2081 goto out_remove_group;
2083 #ifdef CONFIG_BTRFS_DEBUG
2084 ret = sysfs_create_group(&btrfs_kset->kobj, &btrfs_debug_feature_attr_group);
2092 sysfs_remove_group(&btrfs_kset->kobj, &btrfs_feature_attr_group);
2094 kset_unregister(btrfs_kset);
2099 void __cold btrfs_exit_sysfs(void)
2101 sysfs_unmerge_group(&btrfs_kset->kobj,
2102 &btrfs_static_feature_attr_group);
2103 sysfs_remove_group(&btrfs_kset->kobj, &btrfs_feature_attr_group);
2104 #ifdef CONFIG_BTRFS_DEBUG
2105 sysfs_remove_group(&btrfs_kset->kobj, &btrfs_debug_feature_attr_group);
2107 kset_unregister(btrfs_kset);