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>
17 #include "transaction.h"
20 #include "space-info.h"
21 #include "block-group.h"
23 struct btrfs_feature_attr {
24 struct kobj_attribute kobj_attr;
25 enum btrfs_feature_set feature_set;
29 /* For raid type sysfs entries */
35 #define __INIT_KOBJ_ATTR(_name, _mode, _show, _store) \
37 .attr = { .name = __stringify(_name), .mode = _mode }, \
42 #define BTRFS_ATTR_RW(_prefix, _name, _show, _store) \
43 static struct kobj_attribute btrfs_attr_##_prefix##_##_name = \
44 __INIT_KOBJ_ATTR(_name, 0644, _show, _store)
46 #define BTRFS_ATTR(_prefix, _name, _show) \
47 static struct kobj_attribute btrfs_attr_##_prefix##_##_name = \
48 __INIT_KOBJ_ATTR(_name, 0444, _show, NULL)
50 #define BTRFS_ATTR_PTR(_prefix, _name) \
51 (&btrfs_attr_##_prefix##_##_name.attr)
53 #define BTRFS_FEAT_ATTR(_name, _feature_set, _feature_prefix, _feature_bit) \
54 static struct btrfs_feature_attr btrfs_attr_features_##_name = { \
55 .kobj_attr = __INIT_KOBJ_ATTR(_name, S_IRUGO, \
56 btrfs_feature_attr_show, \
57 btrfs_feature_attr_store), \
58 .feature_set = _feature_set, \
59 .feature_bit = _feature_prefix ##_## _feature_bit, \
61 #define BTRFS_FEAT_ATTR_PTR(_name) \
62 (&btrfs_attr_features_##_name.kobj_attr.attr)
64 #define BTRFS_FEAT_ATTR_COMPAT(name, feature) \
65 BTRFS_FEAT_ATTR(name, FEAT_COMPAT, BTRFS_FEATURE_COMPAT, feature)
66 #define BTRFS_FEAT_ATTR_COMPAT_RO(name, feature) \
67 BTRFS_FEAT_ATTR(name, FEAT_COMPAT_RO, BTRFS_FEATURE_COMPAT_RO, feature)
68 #define BTRFS_FEAT_ATTR_INCOMPAT(name, feature) \
69 BTRFS_FEAT_ATTR(name, FEAT_INCOMPAT, BTRFS_FEATURE_INCOMPAT, feature)
71 static inline struct btrfs_fs_info *to_fs_info(struct kobject *kobj);
72 static inline struct btrfs_fs_devices *to_fs_devs(struct kobject *kobj);
74 static struct btrfs_feature_attr *to_btrfs_feature_attr(struct kobj_attribute *a)
76 return container_of(a, struct btrfs_feature_attr, kobj_attr);
79 static struct kobj_attribute *attr_to_btrfs_attr(struct attribute *attr)
81 return container_of(attr, struct kobj_attribute, attr);
84 static struct btrfs_feature_attr *attr_to_btrfs_feature_attr(
85 struct attribute *attr)
87 return to_btrfs_feature_attr(attr_to_btrfs_attr(attr));
90 static u64 get_features(struct btrfs_fs_info *fs_info,
91 enum btrfs_feature_set set)
93 struct btrfs_super_block *disk_super = fs_info->super_copy;
94 if (set == FEAT_COMPAT)
95 return btrfs_super_compat_flags(disk_super);
96 else if (set == FEAT_COMPAT_RO)
97 return btrfs_super_compat_ro_flags(disk_super);
99 return btrfs_super_incompat_flags(disk_super);
102 static void set_features(struct btrfs_fs_info *fs_info,
103 enum btrfs_feature_set set, u64 features)
105 struct btrfs_super_block *disk_super = fs_info->super_copy;
106 if (set == FEAT_COMPAT)
107 btrfs_set_super_compat_flags(disk_super, features);
108 else if (set == FEAT_COMPAT_RO)
109 btrfs_set_super_compat_ro_flags(disk_super, features);
111 btrfs_set_super_incompat_flags(disk_super, features);
114 static int can_modify_feature(struct btrfs_feature_attr *fa)
118 switch (fa->feature_set) {
120 set = BTRFS_FEATURE_COMPAT_SAFE_SET;
121 clear = BTRFS_FEATURE_COMPAT_SAFE_CLEAR;
124 set = BTRFS_FEATURE_COMPAT_RO_SAFE_SET;
125 clear = BTRFS_FEATURE_COMPAT_RO_SAFE_CLEAR;
128 set = BTRFS_FEATURE_INCOMPAT_SAFE_SET;
129 clear = BTRFS_FEATURE_INCOMPAT_SAFE_CLEAR;
132 pr_warn("btrfs: sysfs: unknown feature set %d\n",
137 if (set & fa->feature_bit)
139 if (clear & fa->feature_bit)
145 static ssize_t btrfs_feature_attr_show(struct kobject *kobj,
146 struct kobj_attribute *a, char *buf)
149 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
150 struct btrfs_feature_attr *fa = to_btrfs_feature_attr(a);
152 u64 features = get_features(fs_info, fa->feature_set);
153 if (features & fa->feature_bit)
156 val = can_modify_feature(fa);
158 return snprintf(buf, PAGE_SIZE, "%d\n", val);
161 static ssize_t btrfs_feature_attr_store(struct kobject *kobj,
162 struct kobj_attribute *a,
163 const char *buf, size_t count)
165 struct btrfs_fs_info *fs_info;
166 struct btrfs_feature_attr *fa = to_btrfs_feature_attr(a);
167 u64 features, set, clear;
171 fs_info = to_fs_info(kobj);
175 if (sb_rdonly(fs_info->sb))
178 ret = kstrtoul(skip_spaces(buf), 0, &val);
182 if (fa->feature_set == FEAT_COMPAT) {
183 set = BTRFS_FEATURE_COMPAT_SAFE_SET;
184 clear = BTRFS_FEATURE_COMPAT_SAFE_CLEAR;
185 } else if (fa->feature_set == FEAT_COMPAT_RO) {
186 set = BTRFS_FEATURE_COMPAT_RO_SAFE_SET;
187 clear = BTRFS_FEATURE_COMPAT_RO_SAFE_CLEAR;
189 set = BTRFS_FEATURE_INCOMPAT_SAFE_SET;
190 clear = BTRFS_FEATURE_INCOMPAT_SAFE_CLEAR;
193 features = get_features(fs_info, fa->feature_set);
196 if ((val && (features & fa->feature_bit)) ||
197 (!val && !(features & fa->feature_bit)))
200 if ((val && !(set & fa->feature_bit)) ||
201 (!val && !(clear & fa->feature_bit))) {
203 "%sabling feature %s on mounted fs is not supported.",
204 val ? "En" : "Dis", fa->kobj_attr.attr.name);
208 btrfs_info(fs_info, "%s %s feature flag",
209 val ? "Setting" : "Clearing", fa->kobj_attr.attr.name);
211 spin_lock(&fs_info->super_lock);
212 features = get_features(fs_info, fa->feature_set);
214 features |= fa->feature_bit;
216 features &= ~fa->feature_bit;
217 set_features(fs_info, fa->feature_set, features);
218 spin_unlock(&fs_info->super_lock);
221 * We don't want to do full transaction commit from inside sysfs
223 btrfs_set_pending(fs_info, COMMIT);
224 wake_up_process(fs_info->transaction_kthread);
229 static umode_t btrfs_feature_visible(struct kobject *kobj,
230 struct attribute *attr, int unused)
232 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
233 umode_t mode = attr->mode;
236 struct btrfs_feature_attr *fa;
239 fa = attr_to_btrfs_feature_attr(attr);
240 features = get_features(fs_info, fa->feature_set);
242 if (can_modify_feature(fa))
244 else if (!(features & fa->feature_bit))
251 BTRFS_FEAT_ATTR_INCOMPAT(mixed_backref, MIXED_BACKREF);
252 BTRFS_FEAT_ATTR_INCOMPAT(default_subvol, DEFAULT_SUBVOL);
253 BTRFS_FEAT_ATTR_INCOMPAT(mixed_groups, MIXED_GROUPS);
254 BTRFS_FEAT_ATTR_INCOMPAT(compress_lzo, COMPRESS_LZO);
255 BTRFS_FEAT_ATTR_INCOMPAT(compress_zstd, COMPRESS_ZSTD);
256 BTRFS_FEAT_ATTR_INCOMPAT(big_metadata, BIG_METADATA);
257 BTRFS_FEAT_ATTR_INCOMPAT(extended_iref, EXTENDED_IREF);
258 BTRFS_FEAT_ATTR_INCOMPAT(raid56, RAID56);
259 BTRFS_FEAT_ATTR_INCOMPAT(skinny_metadata, SKINNY_METADATA);
260 BTRFS_FEAT_ATTR_INCOMPAT(no_holes, NO_HOLES);
261 BTRFS_FEAT_ATTR_INCOMPAT(metadata_uuid, METADATA_UUID);
262 BTRFS_FEAT_ATTR_COMPAT_RO(free_space_tree, FREE_SPACE_TREE);
263 BTRFS_FEAT_ATTR_INCOMPAT(raid1c34, RAID1C34);
265 static struct attribute *btrfs_supported_feature_attrs[] = {
266 BTRFS_FEAT_ATTR_PTR(mixed_backref),
267 BTRFS_FEAT_ATTR_PTR(default_subvol),
268 BTRFS_FEAT_ATTR_PTR(mixed_groups),
269 BTRFS_FEAT_ATTR_PTR(compress_lzo),
270 BTRFS_FEAT_ATTR_PTR(compress_zstd),
271 BTRFS_FEAT_ATTR_PTR(big_metadata),
272 BTRFS_FEAT_ATTR_PTR(extended_iref),
273 BTRFS_FEAT_ATTR_PTR(raid56),
274 BTRFS_FEAT_ATTR_PTR(skinny_metadata),
275 BTRFS_FEAT_ATTR_PTR(no_holes),
276 BTRFS_FEAT_ATTR_PTR(metadata_uuid),
277 BTRFS_FEAT_ATTR_PTR(free_space_tree),
278 BTRFS_FEAT_ATTR_PTR(raid1c34),
283 * Features which depend on feature bits and may differ between each fs.
285 * /sys/fs/btrfs/features lists all available features of this kernel while
286 * /sys/fs/btrfs/UUID/features shows features of the fs which are enabled or
287 * can be changed online.
289 static const struct attribute_group btrfs_feature_attr_group = {
291 .is_visible = btrfs_feature_visible,
292 .attrs = btrfs_supported_feature_attrs,
295 static ssize_t rmdir_subvol_show(struct kobject *kobj,
296 struct kobj_attribute *ka, char *buf)
298 return snprintf(buf, PAGE_SIZE, "0\n");
300 BTRFS_ATTR(static_feature, rmdir_subvol, rmdir_subvol_show);
302 static ssize_t supported_checksums_show(struct kobject *kobj,
303 struct kobj_attribute *a, char *buf)
308 for (i = 0; i < btrfs_get_num_csums(); i++) {
310 * This "trick" only works as long as 'enum btrfs_csum_type' has
313 ret += snprintf(buf + ret, PAGE_SIZE - ret, "%s%s",
314 (i == 0 ? "" : " "), btrfs_super_csum_name(i));
318 ret += snprintf(buf + ret, PAGE_SIZE - ret, "\n");
321 BTRFS_ATTR(static_feature, supported_checksums, supported_checksums_show);
323 static struct attribute *btrfs_supported_static_feature_attrs[] = {
324 BTRFS_ATTR_PTR(static_feature, rmdir_subvol),
325 BTRFS_ATTR_PTR(static_feature, supported_checksums),
330 * Features which only depend on kernel version.
332 * These are listed in /sys/fs/btrfs/features along with
333 * btrfs_feature_attr_group
335 static const struct attribute_group btrfs_static_feature_attr_group = {
337 .attrs = btrfs_supported_static_feature_attrs,
340 #ifdef CONFIG_BTRFS_DEBUG
343 * Discard statistics and tunables
345 #define discard_to_fs_info(_kobj) to_fs_info((_kobj)->parent->parent)
347 static ssize_t btrfs_discardable_extents_show(struct kobject *kobj,
348 struct kobj_attribute *a,
351 struct btrfs_fs_info *fs_info = discard_to_fs_info(kobj);
353 return snprintf(buf, PAGE_SIZE, "%d\n",
354 atomic_read(&fs_info->discard_ctl.discardable_extents));
356 BTRFS_ATTR(discard, discardable_extents, btrfs_discardable_extents_show);
358 static const struct attribute *discard_debug_attrs[] = {
359 BTRFS_ATTR_PTR(discard, discardable_extents),
364 * Runtime debugging exported via sysfs
366 * /sys/fs/btrfs/debug - applies to module or all filesystems
367 * /sys/fs/btrfs/UUID - applies only to the given filesystem
369 static const struct attribute *btrfs_debug_mount_attrs[] = {
373 static struct attribute *btrfs_debug_feature_attrs[] = {
377 static const struct attribute_group btrfs_debug_feature_attr_group = {
379 .attrs = btrfs_debug_feature_attrs,
384 static ssize_t btrfs_show_u64(u64 *value_ptr, spinlock_t *lock, char *buf)
392 return snprintf(buf, PAGE_SIZE, "%llu\n", val);
395 static ssize_t global_rsv_size_show(struct kobject *kobj,
396 struct kobj_attribute *ka, char *buf)
398 struct btrfs_fs_info *fs_info = to_fs_info(kobj->parent);
399 struct btrfs_block_rsv *block_rsv = &fs_info->global_block_rsv;
400 return btrfs_show_u64(&block_rsv->size, &block_rsv->lock, buf);
402 BTRFS_ATTR(allocation, global_rsv_size, global_rsv_size_show);
404 static ssize_t global_rsv_reserved_show(struct kobject *kobj,
405 struct kobj_attribute *a, char *buf)
407 struct btrfs_fs_info *fs_info = to_fs_info(kobj->parent);
408 struct btrfs_block_rsv *block_rsv = &fs_info->global_block_rsv;
409 return btrfs_show_u64(&block_rsv->reserved, &block_rsv->lock, buf);
411 BTRFS_ATTR(allocation, global_rsv_reserved, global_rsv_reserved_show);
413 #define to_space_info(_kobj) container_of(_kobj, struct btrfs_space_info, kobj)
414 #define to_raid_kobj(_kobj) container_of(_kobj, struct raid_kobject, kobj)
416 static ssize_t raid_bytes_show(struct kobject *kobj,
417 struct kobj_attribute *attr, char *buf);
418 BTRFS_ATTR(raid, total_bytes, raid_bytes_show);
419 BTRFS_ATTR(raid, used_bytes, raid_bytes_show);
421 static ssize_t raid_bytes_show(struct kobject *kobj,
422 struct kobj_attribute *attr, char *buf)
425 struct btrfs_space_info *sinfo = to_space_info(kobj->parent);
426 struct btrfs_block_group *block_group;
427 int index = btrfs_bg_flags_to_raid_index(to_raid_kobj(kobj)->flags);
430 down_read(&sinfo->groups_sem);
431 list_for_each_entry(block_group, &sinfo->block_groups[index], list) {
432 if (&attr->attr == BTRFS_ATTR_PTR(raid, total_bytes))
433 val += block_group->length;
435 val += block_group->used;
437 up_read(&sinfo->groups_sem);
438 return snprintf(buf, PAGE_SIZE, "%llu\n", val);
441 static struct attribute *raid_attrs[] = {
442 BTRFS_ATTR_PTR(raid, total_bytes),
443 BTRFS_ATTR_PTR(raid, used_bytes),
446 ATTRIBUTE_GROUPS(raid);
448 static void release_raid_kobj(struct kobject *kobj)
450 kfree(to_raid_kobj(kobj));
453 static struct kobj_type btrfs_raid_ktype = {
454 .sysfs_ops = &kobj_sysfs_ops,
455 .release = release_raid_kobj,
456 .default_groups = raid_groups,
459 #define SPACE_INFO_ATTR(field) \
460 static ssize_t btrfs_space_info_show_##field(struct kobject *kobj, \
461 struct kobj_attribute *a, \
464 struct btrfs_space_info *sinfo = to_space_info(kobj); \
465 return btrfs_show_u64(&sinfo->field, &sinfo->lock, buf); \
467 BTRFS_ATTR(space_info, field, btrfs_space_info_show_##field)
469 static ssize_t btrfs_space_info_show_total_bytes_pinned(struct kobject *kobj,
470 struct kobj_attribute *a,
473 struct btrfs_space_info *sinfo = to_space_info(kobj);
474 s64 val = percpu_counter_sum(&sinfo->total_bytes_pinned);
475 return snprintf(buf, PAGE_SIZE, "%lld\n", val);
478 SPACE_INFO_ATTR(flags);
479 SPACE_INFO_ATTR(total_bytes);
480 SPACE_INFO_ATTR(bytes_used);
481 SPACE_INFO_ATTR(bytes_pinned);
482 SPACE_INFO_ATTR(bytes_reserved);
483 SPACE_INFO_ATTR(bytes_may_use);
484 SPACE_INFO_ATTR(bytes_readonly);
485 SPACE_INFO_ATTR(disk_used);
486 SPACE_INFO_ATTR(disk_total);
487 BTRFS_ATTR(space_info, total_bytes_pinned,
488 btrfs_space_info_show_total_bytes_pinned);
490 static struct attribute *space_info_attrs[] = {
491 BTRFS_ATTR_PTR(space_info, flags),
492 BTRFS_ATTR_PTR(space_info, total_bytes),
493 BTRFS_ATTR_PTR(space_info, bytes_used),
494 BTRFS_ATTR_PTR(space_info, bytes_pinned),
495 BTRFS_ATTR_PTR(space_info, bytes_reserved),
496 BTRFS_ATTR_PTR(space_info, bytes_may_use),
497 BTRFS_ATTR_PTR(space_info, bytes_readonly),
498 BTRFS_ATTR_PTR(space_info, disk_used),
499 BTRFS_ATTR_PTR(space_info, disk_total),
500 BTRFS_ATTR_PTR(space_info, total_bytes_pinned),
503 ATTRIBUTE_GROUPS(space_info);
505 static void space_info_release(struct kobject *kobj)
507 struct btrfs_space_info *sinfo = to_space_info(kobj);
508 percpu_counter_destroy(&sinfo->total_bytes_pinned);
512 static struct kobj_type space_info_ktype = {
513 .sysfs_ops = &kobj_sysfs_ops,
514 .release = space_info_release,
515 .default_groups = space_info_groups,
518 static const struct attribute *allocation_attrs[] = {
519 BTRFS_ATTR_PTR(allocation, global_rsv_reserved),
520 BTRFS_ATTR_PTR(allocation, global_rsv_size),
524 static ssize_t btrfs_label_show(struct kobject *kobj,
525 struct kobj_attribute *a, char *buf)
527 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
528 char *label = fs_info->super_copy->label;
531 spin_lock(&fs_info->super_lock);
532 ret = snprintf(buf, PAGE_SIZE, label[0] ? "%s\n" : "%s", label);
533 spin_unlock(&fs_info->super_lock);
538 static ssize_t btrfs_label_store(struct kobject *kobj,
539 struct kobj_attribute *a,
540 const char *buf, size_t len)
542 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
548 if (sb_rdonly(fs_info->sb))
552 * p_len is the len until the first occurrence of either
555 p_len = strcspn(buf, "\n");
557 if (p_len >= BTRFS_LABEL_SIZE)
560 spin_lock(&fs_info->super_lock);
561 memset(fs_info->super_copy->label, 0, BTRFS_LABEL_SIZE);
562 memcpy(fs_info->super_copy->label, buf, p_len);
563 spin_unlock(&fs_info->super_lock);
566 * We don't want to do full transaction commit from inside sysfs
568 btrfs_set_pending(fs_info, COMMIT);
569 wake_up_process(fs_info->transaction_kthread);
573 BTRFS_ATTR_RW(, label, btrfs_label_show, btrfs_label_store);
575 static ssize_t btrfs_nodesize_show(struct kobject *kobj,
576 struct kobj_attribute *a, char *buf)
578 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
580 return snprintf(buf, PAGE_SIZE, "%u\n", fs_info->super_copy->nodesize);
583 BTRFS_ATTR(, nodesize, btrfs_nodesize_show);
585 static ssize_t btrfs_sectorsize_show(struct kobject *kobj,
586 struct kobj_attribute *a, char *buf)
588 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
590 return snprintf(buf, PAGE_SIZE, "%u\n",
591 fs_info->super_copy->sectorsize);
594 BTRFS_ATTR(, sectorsize, btrfs_sectorsize_show);
596 static ssize_t btrfs_clone_alignment_show(struct kobject *kobj,
597 struct kobj_attribute *a, char *buf)
599 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
601 return snprintf(buf, PAGE_SIZE, "%u\n",
602 fs_info->super_copy->sectorsize);
605 BTRFS_ATTR(, clone_alignment, btrfs_clone_alignment_show);
607 static ssize_t quota_override_show(struct kobject *kobj,
608 struct kobj_attribute *a, char *buf)
610 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
613 quota_override = test_bit(BTRFS_FS_QUOTA_OVERRIDE, &fs_info->flags);
614 return snprintf(buf, PAGE_SIZE, "%d\n", quota_override);
617 static ssize_t quota_override_store(struct kobject *kobj,
618 struct kobj_attribute *a,
619 const char *buf, size_t len)
621 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
628 if (!capable(CAP_SYS_RESOURCE))
631 err = kstrtoul(buf, 10, &knob);
638 set_bit(BTRFS_FS_QUOTA_OVERRIDE, &fs_info->flags);
640 clear_bit(BTRFS_FS_QUOTA_OVERRIDE, &fs_info->flags);
645 BTRFS_ATTR_RW(, quota_override, quota_override_show, quota_override_store);
647 static ssize_t btrfs_metadata_uuid_show(struct kobject *kobj,
648 struct kobj_attribute *a, char *buf)
650 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
652 return snprintf(buf, PAGE_SIZE, "%pU\n",
653 fs_info->fs_devices->metadata_uuid);
656 BTRFS_ATTR(, metadata_uuid, btrfs_metadata_uuid_show);
658 static ssize_t btrfs_checksum_show(struct kobject *kobj,
659 struct kobj_attribute *a, char *buf)
661 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
662 u16 csum_type = btrfs_super_csum_type(fs_info->super_copy);
664 return snprintf(buf, PAGE_SIZE, "%s (%s)\n",
665 btrfs_super_csum_name(csum_type),
666 crypto_shash_driver_name(fs_info->csum_shash));
669 BTRFS_ATTR(, checksum, btrfs_checksum_show);
671 static const struct attribute *btrfs_attrs[] = {
672 BTRFS_ATTR_PTR(, label),
673 BTRFS_ATTR_PTR(, nodesize),
674 BTRFS_ATTR_PTR(, sectorsize),
675 BTRFS_ATTR_PTR(, clone_alignment),
676 BTRFS_ATTR_PTR(, quota_override),
677 BTRFS_ATTR_PTR(, metadata_uuid),
678 BTRFS_ATTR_PTR(, checksum),
682 static void btrfs_release_fsid_kobj(struct kobject *kobj)
684 struct btrfs_fs_devices *fs_devs = to_fs_devs(kobj);
686 memset(&fs_devs->fsid_kobj, 0, sizeof(struct kobject));
687 complete(&fs_devs->kobj_unregister);
690 static struct kobj_type btrfs_ktype = {
691 .sysfs_ops = &kobj_sysfs_ops,
692 .release = btrfs_release_fsid_kobj,
695 static inline struct btrfs_fs_devices *to_fs_devs(struct kobject *kobj)
697 if (kobj->ktype != &btrfs_ktype)
699 return container_of(kobj, struct btrfs_fs_devices, fsid_kobj);
702 static inline struct btrfs_fs_info *to_fs_info(struct kobject *kobj)
704 if (kobj->ktype != &btrfs_ktype)
706 return to_fs_devs(kobj)->fs_info;
709 #define NUM_FEATURE_BITS 64
710 #define BTRFS_FEATURE_NAME_MAX 13
711 static char btrfs_unknown_feature_names[FEAT_MAX][NUM_FEATURE_BITS][BTRFS_FEATURE_NAME_MAX];
712 static struct btrfs_feature_attr btrfs_feature_attrs[FEAT_MAX][NUM_FEATURE_BITS];
714 static const u64 supported_feature_masks[FEAT_MAX] = {
715 [FEAT_COMPAT] = BTRFS_FEATURE_COMPAT_SUPP,
716 [FEAT_COMPAT_RO] = BTRFS_FEATURE_COMPAT_RO_SUPP,
717 [FEAT_INCOMPAT] = BTRFS_FEATURE_INCOMPAT_SUPP,
720 static int addrm_unknown_feature_attrs(struct btrfs_fs_info *fs_info, bool add)
724 for (set = 0; set < FEAT_MAX; set++) {
726 struct attribute *attrs[2];
727 struct attribute_group agroup = {
731 u64 features = get_features(fs_info, set);
732 features &= ~supported_feature_masks[set];
738 for (i = 0; i < NUM_FEATURE_BITS; i++) {
739 struct btrfs_feature_attr *fa;
741 if (!(features & (1ULL << i)))
744 fa = &btrfs_feature_attrs[set][i];
745 attrs[0] = &fa->kobj_attr.attr;
748 ret = sysfs_merge_group(&fs_info->fs_devices->fsid_kobj,
753 sysfs_unmerge_group(&fs_info->fs_devices->fsid_kobj,
761 static void __btrfs_sysfs_remove_fsid(struct btrfs_fs_devices *fs_devs)
763 if (fs_devs->devices_kobj) {
764 kobject_del(fs_devs->devices_kobj);
765 kobject_put(fs_devs->devices_kobj);
766 fs_devs->devices_kobj = NULL;
769 if (fs_devs->fsid_kobj.state_initialized) {
770 kobject_del(&fs_devs->fsid_kobj);
771 kobject_put(&fs_devs->fsid_kobj);
772 wait_for_completion(&fs_devs->kobj_unregister);
776 /* when fs_devs is NULL it will remove all fsid kobject */
777 void btrfs_sysfs_remove_fsid(struct btrfs_fs_devices *fs_devs)
779 struct list_head *fs_uuids = btrfs_get_fs_uuids();
782 __btrfs_sysfs_remove_fsid(fs_devs);
786 list_for_each_entry(fs_devs, fs_uuids, fs_list) {
787 __btrfs_sysfs_remove_fsid(fs_devs);
791 void btrfs_sysfs_remove_mounted(struct btrfs_fs_info *fs_info)
793 btrfs_reset_fs_info_ptr(fs_info);
795 if (fs_info->space_info_kobj) {
796 sysfs_remove_files(fs_info->space_info_kobj, allocation_attrs);
797 kobject_del(fs_info->space_info_kobj);
798 kobject_put(fs_info->space_info_kobj);
800 #ifdef CONFIG_BTRFS_DEBUG
801 if (fs_info->discard_debug_kobj) {
802 sysfs_remove_files(fs_info->discard_debug_kobj,
803 discard_debug_attrs);
804 kobject_del(fs_info->discard_debug_kobj);
805 kobject_put(fs_info->discard_debug_kobj);
807 if (fs_info->debug_kobj) {
808 sysfs_remove_files(fs_info->debug_kobj, btrfs_debug_mount_attrs);
809 kobject_del(fs_info->debug_kobj);
810 kobject_put(fs_info->debug_kobj);
813 addrm_unknown_feature_attrs(fs_info, false);
814 sysfs_remove_group(&fs_info->fs_devices->fsid_kobj, &btrfs_feature_attr_group);
815 sysfs_remove_files(&fs_info->fs_devices->fsid_kobj, btrfs_attrs);
816 btrfs_sysfs_rm_device_link(fs_info->fs_devices, NULL);
819 static const char * const btrfs_feature_set_names[FEAT_MAX] = {
820 [FEAT_COMPAT] = "compat",
821 [FEAT_COMPAT_RO] = "compat_ro",
822 [FEAT_INCOMPAT] = "incompat",
825 const char * const btrfs_feature_set_name(enum btrfs_feature_set set)
827 return btrfs_feature_set_names[set];
830 char *btrfs_printable_features(enum btrfs_feature_set set, u64 flags)
832 size_t bufsize = 4096; /* safe max, 64 names * 64 bytes */
837 str = kmalloc(bufsize, GFP_KERNEL);
841 for (i = 0; i < ARRAY_SIZE(btrfs_feature_attrs[set]); i++) {
844 if (!(flags & (1ULL << i)))
847 name = btrfs_feature_attrs[set][i].kobj_attr.attr.name;
848 len += snprintf(str + len, bufsize - len, "%s%s",
849 len ? "," : "", name);
855 static void init_feature_attrs(void)
857 struct btrfs_feature_attr *fa;
860 BUILD_BUG_ON(ARRAY_SIZE(btrfs_unknown_feature_names) !=
861 ARRAY_SIZE(btrfs_feature_attrs));
862 BUILD_BUG_ON(ARRAY_SIZE(btrfs_unknown_feature_names[0]) !=
863 ARRAY_SIZE(btrfs_feature_attrs[0]));
865 memset(btrfs_feature_attrs, 0, sizeof(btrfs_feature_attrs));
866 memset(btrfs_unknown_feature_names, 0,
867 sizeof(btrfs_unknown_feature_names));
869 for (i = 0; btrfs_supported_feature_attrs[i]; i++) {
870 struct btrfs_feature_attr *sfa;
871 struct attribute *a = btrfs_supported_feature_attrs[i];
873 sfa = attr_to_btrfs_feature_attr(a);
874 bit = ilog2(sfa->feature_bit);
875 fa = &btrfs_feature_attrs[sfa->feature_set][bit];
877 fa->kobj_attr.attr.name = sfa->kobj_attr.attr.name;
880 for (set = 0; set < FEAT_MAX; set++) {
881 for (i = 0; i < ARRAY_SIZE(btrfs_feature_attrs[set]); i++) {
882 char *name = btrfs_unknown_feature_names[set][i];
883 fa = &btrfs_feature_attrs[set][i];
885 if (fa->kobj_attr.attr.name)
888 snprintf(name, BTRFS_FEATURE_NAME_MAX, "%s:%u",
889 btrfs_feature_set_names[set], i);
891 fa->kobj_attr.attr.name = name;
892 fa->kobj_attr.attr.mode = S_IRUGO;
893 fa->feature_set = set;
894 fa->feature_bit = 1ULL << i;
900 * Create a sysfs entry for a given block group type at path
901 * /sys/fs/btrfs/UUID/allocation/data/TYPE
903 void btrfs_sysfs_add_block_group_type(struct btrfs_block_group *cache)
905 struct btrfs_fs_info *fs_info = cache->fs_info;
906 struct btrfs_space_info *space_info = cache->space_info;
907 struct raid_kobject *rkobj;
908 const int index = btrfs_bg_flags_to_raid_index(cache->flags);
909 unsigned int nofs_flag;
913 * Setup a NOFS context because kobject_add(), deep in its call chain,
914 * does GFP_KERNEL allocations, and we are often called in a context
915 * where if reclaim is triggered we can deadlock (we are either holding
916 * a transaction handle or some lock required for a transaction
919 nofs_flag = memalloc_nofs_save();
921 rkobj = kzalloc(sizeof(*rkobj), GFP_NOFS);
923 memalloc_nofs_restore(nofs_flag);
924 btrfs_warn(cache->fs_info,
925 "couldn't alloc memory for raid level kobject");
929 rkobj->flags = cache->flags;
930 kobject_init(&rkobj->kobj, &btrfs_raid_ktype);
931 ret = kobject_add(&rkobj->kobj, &space_info->kobj, "%s",
932 btrfs_bg_type_to_raid_name(rkobj->flags));
933 memalloc_nofs_restore(nofs_flag);
935 kobject_put(&rkobj->kobj);
937 "failed to add kobject for block cache, ignoring");
941 space_info->block_group_kobjs[index] = &rkobj->kobj;
945 * Remove sysfs directories for all block group types of a given space info and
946 * the space info as well
948 void btrfs_sysfs_remove_space_info(struct btrfs_space_info *space_info)
952 for (i = 0; i < BTRFS_NR_RAID_TYPES; i++) {
953 struct kobject *kobj;
955 kobj = space_info->block_group_kobjs[i];
956 space_info->block_group_kobjs[i] = NULL;
962 kobject_del(&space_info->kobj);
963 kobject_put(&space_info->kobj);
966 static const char *alloc_name(u64 flags)
969 case BTRFS_BLOCK_GROUP_METADATA | BTRFS_BLOCK_GROUP_DATA:
971 case BTRFS_BLOCK_GROUP_METADATA:
973 case BTRFS_BLOCK_GROUP_DATA:
975 case BTRFS_BLOCK_GROUP_SYSTEM:
979 return "invalid-combination";
984 * Create a sysfs entry for a space info type at path
985 * /sys/fs/btrfs/UUID/allocation/TYPE
987 int btrfs_sysfs_add_space_info_type(struct btrfs_fs_info *fs_info,
988 struct btrfs_space_info *space_info)
992 ret = kobject_init_and_add(&space_info->kobj, &space_info_ktype,
993 fs_info->space_info_kobj, "%s",
994 alloc_name(space_info->flags));
996 kobject_put(&space_info->kobj);
1003 /* when one_device is NULL, it removes all device links */
1005 int btrfs_sysfs_rm_device_link(struct btrfs_fs_devices *fs_devices,
1006 struct btrfs_device *one_device)
1008 struct hd_struct *disk;
1009 struct kobject *disk_kobj;
1011 if (!fs_devices->devices_kobj)
1014 if (one_device && one_device->bdev) {
1015 disk = one_device->bdev->bd_part;
1016 disk_kobj = &part_to_dev(disk)->kobj;
1018 sysfs_remove_link(fs_devices->devices_kobj, disk_kobj->name);
1024 list_for_each_entry(one_device,
1025 &fs_devices->devices, dev_list) {
1026 if (!one_device->bdev)
1028 disk = one_device->bdev->bd_part;
1029 disk_kobj = &part_to_dev(disk)->kobj;
1031 sysfs_remove_link(fs_devices->devices_kobj, disk_kobj->name);
1037 int btrfs_sysfs_add_device_link(struct btrfs_fs_devices *fs_devices,
1038 struct btrfs_device *one_device)
1041 struct btrfs_device *dev;
1043 list_for_each_entry(dev, &fs_devices->devices, dev_list) {
1044 struct hd_struct *disk;
1045 struct kobject *disk_kobj;
1050 if (one_device && one_device != dev)
1053 disk = dev->bdev->bd_part;
1054 disk_kobj = &part_to_dev(disk)->kobj;
1056 error = sysfs_create_link(fs_devices->devices_kobj,
1057 disk_kobj, disk_kobj->name);
1065 void btrfs_kobject_uevent(struct block_device *bdev, enum kobject_action action)
1069 ret = kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, action);
1071 pr_warn("BTRFS: Sending event '%d' to kobject: '%s' (%p): failed\n",
1072 action, kobject_name(&disk_to_dev(bdev->bd_disk)->kobj),
1073 &disk_to_dev(bdev->bd_disk)->kobj);
1076 void btrfs_sysfs_update_sprout_fsid(struct btrfs_fs_devices *fs_devices,
1079 char fsid_buf[BTRFS_UUID_UNPARSED_SIZE];
1082 * Sprouting changes fsid of the mounted filesystem, rename the fsid
1085 snprintf(fsid_buf, BTRFS_UUID_UNPARSED_SIZE, "%pU", fsid);
1086 if (kobject_rename(&fs_devices->fsid_kobj, fsid_buf))
1087 btrfs_warn(fs_devices->fs_info,
1088 "sysfs: failed to create fsid for sprout");
1091 /* /sys/fs/btrfs/ entry */
1092 static struct kset *btrfs_kset;
1096 * /sys/fs/btrfs/UUID
1098 * Can be called by the device discovery thread.
1100 int btrfs_sysfs_add_fsid(struct btrfs_fs_devices *fs_devs)
1104 init_completion(&fs_devs->kobj_unregister);
1105 fs_devs->fsid_kobj.kset = btrfs_kset;
1106 error = kobject_init_and_add(&fs_devs->fsid_kobj, &btrfs_ktype, NULL,
1107 "%pU", fs_devs->fsid);
1109 kobject_put(&fs_devs->fsid_kobj);
1113 fs_devs->devices_kobj = kobject_create_and_add("devices",
1114 &fs_devs->fsid_kobj);
1115 if (!fs_devs->devices_kobj) {
1116 btrfs_err(fs_devs->fs_info,
1117 "failed to init sysfs device interface");
1118 kobject_put(&fs_devs->fsid_kobj);
1125 int btrfs_sysfs_add_mounted(struct btrfs_fs_info *fs_info)
1128 struct btrfs_fs_devices *fs_devs = fs_info->fs_devices;
1129 struct kobject *fsid_kobj = &fs_devs->fsid_kobj;
1131 btrfs_set_fs_info_ptr(fs_info);
1133 error = btrfs_sysfs_add_device_link(fs_devs, NULL);
1137 error = sysfs_create_files(fsid_kobj, btrfs_attrs);
1139 btrfs_sysfs_rm_device_link(fs_devs, NULL);
1143 error = sysfs_create_group(fsid_kobj,
1144 &btrfs_feature_attr_group);
1148 #ifdef CONFIG_BTRFS_DEBUG
1149 fs_info->debug_kobj = kobject_create_and_add("debug", fsid_kobj);
1150 if (!fs_info->debug_kobj) {
1155 error = sysfs_create_files(fs_info->debug_kobj, btrfs_debug_mount_attrs);
1159 /* Discard directory */
1160 fs_info->discard_debug_kobj = kobject_create_and_add("discard",
1161 fs_info->debug_kobj);
1162 if (!fs_info->discard_debug_kobj) {
1167 error = sysfs_create_files(fs_info->discard_debug_kobj,
1168 discard_debug_attrs);
1173 error = addrm_unknown_feature_attrs(fs_info, true);
1177 fs_info->space_info_kobj = kobject_create_and_add("allocation",
1179 if (!fs_info->space_info_kobj) {
1184 error = sysfs_create_files(fs_info->space_info_kobj, allocation_attrs);
1190 btrfs_sysfs_remove_mounted(fs_info);
1196 * Change per-fs features in /sys/fs/btrfs/UUID/features to match current
1197 * values in superblock. Call after any changes to incompat/compat_ro flags
1199 void btrfs_sysfs_feature_update(struct btrfs_fs_info *fs_info,
1200 u64 bit, enum btrfs_feature_set set)
1202 struct btrfs_fs_devices *fs_devs;
1203 struct kobject *fsid_kobj;
1210 features = get_features(fs_info, set);
1211 ASSERT(bit & supported_feature_masks[set]);
1213 fs_devs = fs_info->fs_devices;
1214 fsid_kobj = &fs_devs->fsid_kobj;
1216 if (!fsid_kobj->state_initialized)
1220 * FIXME: this is too heavy to update just one value, ideally we'd like
1221 * to use sysfs_update_group but some refactoring is needed first.
1223 sysfs_remove_group(fsid_kobj, &btrfs_feature_attr_group);
1224 ret = sysfs_create_group(fsid_kobj, &btrfs_feature_attr_group);
1227 int __init btrfs_init_sysfs(void)
1231 btrfs_kset = kset_create_and_add("btrfs", NULL, fs_kobj);
1235 init_feature_attrs();
1236 ret = sysfs_create_group(&btrfs_kset->kobj, &btrfs_feature_attr_group);
1239 ret = sysfs_merge_group(&btrfs_kset->kobj,
1240 &btrfs_static_feature_attr_group);
1242 goto out_remove_group;
1244 #ifdef CONFIG_BTRFS_DEBUG
1245 ret = sysfs_create_group(&btrfs_kset->kobj, &btrfs_debug_feature_attr_group);
1253 sysfs_remove_group(&btrfs_kset->kobj, &btrfs_feature_attr_group);
1255 kset_unregister(btrfs_kset);
1260 void __cold btrfs_exit_sysfs(void)
1262 sysfs_unmerge_group(&btrfs_kset->kobj,
1263 &btrfs_static_feature_attr_group);
1264 sysfs_remove_group(&btrfs_kset->kobj, &btrfs_feature_attr_group);
1265 #ifdef CONFIG_BTRFS_DEBUG
1266 sysfs_remove_group(&btrfs_kset->kobj, &btrfs_debug_feature_attr_group);
1268 kset_unregister(btrfs_kset);