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_bytes_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, "%lld\n",
354 atomic64_read(&fs_info->discard_ctl.discardable_bytes));
356 BTRFS_ATTR(discard, discardable_bytes, btrfs_discardable_bytes_show);
358 static ssize_t btrfs_discardable_extents_show(struct kobject *kobj,
359 struct kobj_attribute *a,
362 struct btrfs_fs_info *fs_info = discard_to_fs_info(kobj);
364 return snprintf(buf, PAGE_SIZE, "%d\n",
365 atomic_read(&fs_info->discard_ctl.discardable_extents));
367 BTRFS_ATTR(discard, discardable_extents, btrfs_discardable_extents_show);
369 static const struct attribute *discard_debug_attrs[] = {
370 BTRFS_ATTR_PTR(discard, discardable_bytes),
371 BTRFS_ATTR_PTR(discard, discardable_extents),
376 * Runtime debugging exported via sysfs
378 * /sys/fs/btrfs/debug - applies to module or all filesystems
379 * /sys/fs/btrfs/UUID - applies only to the given filesystem
381 static const struct attribute *btrfs_debug_mount_attrs[] = {
385 static struct attribute *btrfs_debug_feature_attrs[] = {
389 static const struct attribute_group btrfs_debug_feature_attr_group = {
391 .attrs = btrfs_debug_feature_attrs,
396 static ssize_t btrfs_show_u64(u64 *value_ptr, spinlock_t *lock, char *buf)
404 return snprintf(buf, PAGE_SIZE, "%llu\n", val);
407 static ssize_t global_rsv_size_show(struct kobject *kobj,
408 struct kobj_attribute *ka, char *buf)
410 struct btrfs_fs_info *fs_info = to_fs_info(kobj->parent);
411 struct btrfs_block_rsv *block_rsv = &fs_info->global_block_rsv;
412 return btrfs_show_u64(&block_rsv->size, &block_rsv->lock, buf);
414 BTRFS_ATTR(allocation, global_rsv_size, global_rsv_size_show);
416 static ssize_t global_rsv_reserved_show(struct kobject *kobj,
417 struct kobj_attribute *a, char *buf)
419 struct btrfs_fs_info *fs_info = to_fs_info(kobj->parent);
420 struct btrfs_block_rsv *block_rsv = &fs_info->global_block_rsv;
421 return btrfs_show_u64(&block_rsv->reserved, &block_rsv->lock, buf);
423 BTRFS_ATTR(allocation, global_rsv_reserved, global_rsv_reserved_show);
425 #define to_space_info(_kobj) container_of(_kobj, struct btrfs_space_info, kobj)
426 #define to_raid_kobj(_kobj) container_of(_kobj, struct raid_kobject, kobj)
428 static ssize_t raid_bytes_show(struct kobject *kobj,
429 struct kobj_attribute *attr, char *buf);
430 BTRFS_ATTR(raid, total_bytes, raid_bytes_show);
431 BTRFS_ATTR(raid, used_bytes, raid_bytes_show);
433 static ssize_t raid_bytes_show(struct kobject *kobj,
434 struct kobj_attribute *attr, char *buf)
437 struct btrfs_space_info *sinfo = to_space_info(kobj->parent);
438 struct btrfs_block_group *block_group;
439 int index = btrfs_bg_flags_to_raid_index(to_raid_kobj(kobj)->flags);
442 down_read(&sinfo->groups_sem);
443 list_for_each_entry(block_group, &sinfo->block_groups[index], list) {
444 if (&attr->attr == BTRFS_ATTR_PTR(raid, total_bytes))
445 val += block_group->length;
447 val += block_group->used;
449 up_read(&sinfo->groups_sem);
450 return snprintf(buf, PAGE_SIZE, "%llu\n", val);
453 static struct attribute *raid_attrs[] = {
454 BTRFS_ATTR_PTR(raid, total_bytes),
455 BTRFS_ATTR_PTR(raid, used_bytes),
458 ATTRIBUTE_GROUPS(raid);
460 static void release_raid_kobj(struct kobject *kobj)
462 kfree(to_raid_kobj(kobj));
465 static struct kobj_type btrfs_raid_ktype = {
466 .sysfs_ops = &kobj_sysfs_ops,
467 .release = release_raid_kobj,
468 .default_groups = raid_groups,
471 #define SPACE_INFO_ATTR(field) \
472 static ssize_t btrfs_space_info_show_##field(struct kobject *kobj, \
473 struct kobj_attribute *a, \
476 struct btrfs_space_info *sinfo = to_space_info(kobj); \
477 return btrfs_show_u64(&sinfo->field, &sinfo->lock, buf); \
479 BTRFS_ATTR(space_info, field, btrfs_space_info_show_##field)
481 static ssize_t btrfs_space_info_show_total_bytes_pinned(struct kobject *kobj,
482 struct kobj_attribute *a,
485 struct btrfs_space_info *sinfo = to_space_info(kobj);
486 s64 val = percpu_counter_sum(&sinfo->total_bytes_pinned);
487 return snprintf(buf, PAGE_SIZE, "%lld\n", val);
490 SPACE_INFO_ATTR(flags);
491 SPACE_INFO_ATTR(total_bytes);
492 SPACE_INFO_ATTR(bytes_used);
493 SPACE_INFO_ATTR(bytes_pinned);
494 SPACE_INFO_ATTR(bytes_reserved);
495 SPACE_INFO_ATTR(bytes_may_use);
496 SPACE_INFO_ATTR(bytes_readonly);
497 SPACE_INFO_ATTR(disk_used);
498 SPACE_INFO_ATTR(disk_total);
499 BTRFS_ATTR(space_info, total_bytes_pinned,
500 btrfs_space_info_show_total_bytes_pinned);
502 static struct attribute *space_info_attrs[] = {
503 BTRFS_ATTR_PTR(space_info, flags),
504 BTRFS_ATTR_PTR(space_info, total_bytes),
505 BTRFS_ATTR_PTR(space_info, bytes_used),
506 BTRFS_ATTR_PTR(space_info, bytes_pinned),
507 BTRFS_ATTR_PTR(space_info, bytes_reserved),
508 BTRFS_ATTR_PTR(space_info, bytes_may_use),
509 BTRFS_ATTR_PTR(space_info, bytes_readonly),
510 BTRFS_ATTR_PTR(space_info, disk_used),
511 BTRFS_ATTR_PTR(space_info, disk_total),
512 BTRFS_ATTR_PTR(space_info, total_bytes_pinned),
515 ATTRIBUTE_GROUPS(space_info);
517 static void space_info_release(struct kobject *kobj)
519 struct btrfs_space_info *sinfo = to_space_info(kobj);
520 percpu_counter_destroy(&sinfo->total_bytes_pinned);
524 static struct kobj_type space_info_ktype = {
525 .sysfs_ops = &kobj_sysfs_ops,
526 .release = space_info_release,
527 .default_groups = space_info_groups,
530 static const struct attribute *allocation_attrs[] = {
531 BTRFS_ATTR_PTR(allocation, global_rsv_reserved),
532 BTRFS_ATTR_PTR(allocation, global_rsv_size),
536 static ssize_t btrfs_label_show(struct kobject *kobj,
537 struct kobj_attribute *a, char *buf)
539 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
540 char *label = fs_info->super_copy->label;
543 spin_lock(&fs_info->super_lock);
544 ret = snprintf(buf, PAGE_SIZE, label[0] ? "%s\n" : "%s", label);
545 spin_unlock(&fs_info->super_lock);
550 static ssize_t btrfs_label_store(struct kobject *kobj,
551 struct kobj_attribute *a,
552 const char *buf, size_t len)
554 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
560 if (sb_rdonly(fs_info->sb))
564 * p_len is the len until the first occurrence of either
567 p_len = strcspn(buf, "\n");
569 if (p_len >= BTRFS_LABEL_SIZE)
572 spin_lock(&fs_info->super_lock);
573 memset(fs_info->super_copy->label, 0, BTRFS_LABEL_SIZE);
574 memcpy(fs_info->super_copy->label, buf, p_len);
575 spin_unlock(&fs_info->super_lock);
578 * We don't want to do full transaction commit from inside sysfs
580 btrfs_set_pending(fs_info, COMMIT);
581 wake_up_process(fs_info->transaction_kthread);
585 BTRFS_ATTR_RW(, label, btrfs_label_show, btrfs_label_store);
587 static ssize_t btrfs_nodesize_show(struct kobject *kobj,
588 struct kobj_attribute *a, char *buf)
590 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
592 return snprintf(buf, PAGE_SIZE, "%u\n", fs_info->super_copy->nodesize);
595 BTRFS_ATTR(, nodesize, btrfs_nodesize_show);
597 static ssize_t btrfs_sectorsize_show(struct kobject *kobj,
598 struct kobj_attribute *a, char *buf)
600 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
602 return snprintf(buf, PAGE_SIZE, "%u\n",
603 fs_info->super_copy->sectorsize);
606 BTRFS_ATTR(, sectorsize, btrfs_sectorsize_show);
608 static ssize_t btrfs_clone_alignment_show(struct kobject *kobj,
609 struct kobj_attribute *a, char *buf)
611 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
613 return snprintf(buf, PAGE_SIZE, "%u\n",
614 fs_info->super_copy->sectorsize);
617 BTRFS_ATTR(, clone_alignment, btrfs_clone_alignment_show);
619 static ssize_t quota_override_show(struct kobject *kobj,
620 struct kobj_attribute *a, char *buf)
622 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
625 quota_override = test_bit(BTRFS_FS_QUOTA_OVERRIDE, &fs_info->flags);
626 return snprintf(buf, PAGE_SIZE, "%d\n", quota_override);
629 static ssize_t quota_override_store(struct kobject *kobj,
630 struct kobj_attribute *a,
631 const char *buf, size_t len)
633 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
640 if (!capable(CAP_SYS_RESOURCE))
643 err = kstrtoul(buf, 10, &knob);
650 set_bit(BTRFS_FS_QUOTA_OVERRIDE, &fs_info->flags);
652 clear_bit(BTRFS_FS_QUOTA_OVERRIDE, &fs_info->flags);
657 BTRFS_ATTR_RW(, quota_override, quota_override_show, quota_override_store);
659 static ssize_t btrfs_metadata_uuid_show(struct kobject *kobj,
660 struct kobj_attribute *a, char *buf)
662 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
664 return snprintf(buf, PAGE_SIZE, "%pU\n",
665 fs_info->fs_devices->metadata_uuid);
668 BTRFS_ATTR(, metadata_uuid, btrfs_metadata_uuid_show);
670 static ssize_t btrfs_checksum_show(struct kobject *kobj,
671 struct kobj_attribute *a, char *buf)
673 struct btrfs_fs_info *fs_info = to_fs_info(kobj);
674 u16 csum_type = btrfs_super_csum_type(fs_info->super_copy);
676 return snprintf(buf, PAGE_SIZE, "%s (%s)\n",
677 btrfs_super_csum_name(csum_type),
678 crypto_shash_driver_name(fs_info->csum_shash));
681 BTRFS_ATTR(, checksum, btrfs_checksum_show);
683 static const struct attribute *btrfs_attrs[] = {
684 BTRFS_ATTR_PTR(, label),
685 BTRFS_ATTR_PTR(, nodesize),
686 BTRFS_ATTR_PTR(, sectorsize),
687 BTRFS_ATTR_PTR(, clone_alignment),
688 BTRFS_ATTR_PTR(, quota_override),
689 BTRFS_ATTR_PTR(, metadata_uuid),
690 BTRFS_ATTR_PTR(, checksum),
694 static void btrfs_release_fsid_kobj(struct kobject *kobj)
696 struct btrfs_fs_devices *fs_devs = to_fs_devs(kobj);
698 memset(&fs_devs->fsid_kobj, 0, sizeof(struct kobject));
699 complete(&fs_devs->kobj_unregister);
702 static struct kobj_type btrfs_ktype = {
703 .sysfs_ops = &kobj_sysfs_ops,
704 .release = btrfs_release_fsid_kobj,
707 static inline struct btrfs_fs_devices *to_fs_devs(struct kobject *kobj)
709 if (kobj->ktype != &btrfs_ktype)
711 return container_of(kobj, struct btrfs_fs_devices, fsid_kobj);
714 static inline struct btrfs_fs_info *to_fs_info(struct kobject *kobj)
716 if (kobj->ktype != &btrfs_ktype)
718 return to_fs_devs(kobj)->fs_info;
721 #define NUM_FEATURE_BITS 64
722 #define BTRFS_FEATURE_NAME_MAX 13
723 static char btrfs_unknown_feature_names[FEAT_MAX][NUM_FEATURE_BITS][BTRFS_FEATURE_NAME_MAX];
724 static struct btrfs_feature_attr btrfs_feature_attrs[FEAT_MAX][NUM_FEATURE_BITS];
726 static const u64 supported_feature_masks[FEAT_MAX] = {
727 [FEAT_COMPAT] = BTRFS_FEATURE_COMPAT_SUPP,
728 [FEAT_COMPAT_RO] = BTRFS_FEATURE_COMPAT_RO_SUPP,
729 [FEAT_INCOMPAT] = BTRFS_FEATURE_INCOMPAT_SUPP,
732 static int addrm_unknown_feature_attrs(struct btrfs_fs_info *fs_info, bool add)
736 for (set = 0; set < FEAT_MAX; set++) {
738 struct attribute *attrs[2];
739 struct attribute_group agroup = {
743 u64 features = get_features(fs_info, set);
744 features &= ~supported_feature_masks[set];
750 for (i = 0; i < NUM_FEATURE_BITS; i++) {
751 struct btrfs_feature_attr *fa;
753 if (!(features & (1ULL << i)))
756 fa = &btrfs_feature_attrs[set][i];
757 attrs[0] = &fa->kobj_attr.attr;
760 ret = sysfs_merge_group(&fs_info->fs_devices->fsid_kobj,
765 sysfs_unmerge_group(&fs_info->fs_devices->fsid_kobj,
773 static void __btrfs_sysfs_remove_fsid(struct btrfs_fs_devices *fs_devs)
775 if (fs_devs->devices_kobj) {
776 kobject_del(fs_devs->devices_kobj);
777 kobject_put(fs_devs->devices_kobj);
778 fs_devs->devices_kobj = NULL;
781 if (fs_devs->fsid_kobj.state_initialized) {
782 kobject_del(&fs_devs->fsid_kobj);
783 kobject_put(&fs_devs->fsid_kobj);
784 wait_for_completion(&fs_devs->kobj_unregister);
788 /* when fs_devs is NULL it will remove all fsid kobject */
789 void btrfs_sysfs_remove_fsid(struct btrfs_fs_devices *fs_devs)
791 struct list_head *fs_uuids = btrfs_get_fs_uuids();
794 __btrfs_sysfs_remove_fsid(fs_devs);
798 list_for_each_entry(fs_devs, fs_uuids, fs_list) {
799 __btrfs_sysfs_remove_fsid(fs_devs);
803 void btrfs_sysfs_remove_mounted(struct btrfs_fs_info *fs_info)
805 btrfs_reset_fs_info_ptr(fs_info);
807 if (fs_info->space_info_kobj) {
808 sysfs_remove_files(fs_info->space_info_kobj, allocation_attrs);
809 kobject_del(fs_info->space_info_kobj);
810 kobject_put(fs_info->space_info_kobj);
812 #ifdef CONFIG_BTRFS_DEBUG
813 if (fs_info->discard_debug_kobj) {
814 sysfs_remove_files(fs_info->discard_debug_kobj,
815 discard_debug_attrs);
816 kobject_del(fs_info->discard_debug_kobj);
817 kobject_put(fs_info->discard_debug_kobj);
819 if (fs_info->debug_kobj) {
820 sysfs_remove_files(fs_info->debug_kobj, btrfs_debug_mount_attrs);
821 kobject_del(fs_info->debug_kobj);
822 kobject_put(fs_info->debug_kobj);
825 addrm_unknown_feature_attrs(fs_info, false);
826 sysfs_remove_group(&fs_info->fs_devices->fsid_kobj, &btrfs_feature_attr_group);
827 sysfs_remove_files(&fs_info->fs_devices->fsid_kobj, btrfs_attrs);
828 btrfs_sysfs_rm_device_link(fs_info->fs_devices, NULL);
831 static const char * const btrfs_feature_set_names[FEAT_MAX] = {
832 [FEAT_COMPAT] = "compat",
833 [FEAT_COMPAT_RO] = "compat_ro",
834 [FEAT_INCOMPAT] = "incompat",
837 const char * const btrfs_feature_set_name(enum btrfs_feature_set set)
839 return btrfs_feature_set_names[set];
842 char *btrfs_printable_features(enum btrfs_feature_set set, u64 flags)
844 size_t bufsize = 4096; /* safe max, 64 names * 64 bytes */
849 str = kmalloc(bufsize, GFP_KERNEL);
853 for (i = 0; i < ARRAY_SIZE(btrfs_feature_attrs[set]); i++) {
856 if (!(flags & (1ULL << i)))
859 name = btrfs_feature_attrs[set][i].kobj_attr.attr.name;
860 len += snprintf(str + len, bufsize - len, "%s%s",
861 len ? "," : "", name);
867 static void init_feature_attrs(void)
869 struct btrfs_feature_attr *fa;
872 BUILD_BUG_ON(ARRAY_SIZE(btrfs_unknown_feature_names) !=
873 ARRAY_SIZE(btrfs_feature_attrs));
874 BUILD_BUG_ON(ARRAY_SIZE(btrfs_unknown_feature_names[0]) !=
875 ARRAY_SIZE(btrfs_feature_attrs[0]));
877 memset(btrfs_feature_attrs, 0, sizeof(btrfs_feature_attrs));
878 memset(btrfs_unknown_feature_names, 0,
879 sizeof(btrfs_unknown_feature_names));
881 for (i = 0; btrfs_supported_feature_attrs[i]; i++) {
882 struct btrfs_feature_attr *sfa;
883 struct attribute *a = btrfs_supported_feature_attrs[i];
885 sfa = attr_to_btrfs_feature_attr(a);
886 bit = ilog2(sfa->feature_bit);
887 fa = &btrfs_feature_attrs[sfa->feature_set][bit];
889 fa->kobj_attr.attr.name = sfa->kobj_attr.attr.name;
892 for (set = 0; set < FEAT_MAX; set++) {
893 for (i = 0; i < ARRAY_SIZE(btrfs_feature_attrs[set]); i++) {
894 char *name = btrfs_unknown_feature_names[set][i];
895 fa = &btrfs_feature_attrs[set][i];
897 if (fa->kobj_attr.attr.name)
900 snprintf(name, BTRFS_FEATURE_NAME_MAX, "%s:%u",
901 btrfs_feature_set_names[set], i);
903 fa->kobj_attr.attr.name = name;
904 fa->kobj_attr.attr.mode = S_IRUGO;
905 fa->feature_set = set;
906 fa->feature_bit = 1ULL << i;
912 * Create a sysfs entry for a given block group type at path
913 * /sys/fs/btrfs/UUID/allocation/data/TYPE
915 void btrfs_sysfs_add_block_group_type(struct btrfs_block_group *cache)
917 struct btrfs_fs_info *fs_info = cache->fs_info;
918 struct btrfs_space_info *space_info = cache->space_info;
919 struct raid_kobject *rkobj;
920 const int index = btrfs_bg_flags_to_raid_index(cache->flags);
921 unsigned int nofs_flag;
925 * Setup a NOFS context because kobject_add(), deep in its call chain,
926 * does GFP_KERNEL allocations, and we are often called in a context
927 * where if reclaim is triggered we can deadlock (we are either holding
928 * a transaction handle or some lock required for a transaction
931 nofs_flag = memalloc_nofs_save();
933 rkobj = kzalloc(sizeof(*rkobj), GFP_NOFS);
935 memalloc_nofs_restore(nofs_flag);
936 btrfs_warn(cache->fs_info,
937 "couldn't alloc memory for raid level kobject");
941 rkobj->flags = cache->flags;
942 kobject_init(&rkobj->kobj, &btrfs_raid_ktype);
943 ret = kobject_add(&rkobj->kobj, &space_info->kobj, "%s",
944 btrfs_bg_type_to_raid_name(rkobj->flags));
945 memalloc_nofs_restore(nofs_flag);
947 kobject_put(&rkobj->kobj);
949 "failed to add kobject for block cache, ignoring");
953 space_info->block_group_kobjs[index] = &rkobj->kobj;
957 * Remove sysfs directories for all block group types of a given space info and
958 * the space info as well
960 void btrfs_sysfs_remove_space_info(struct btrfs_space_info *space_info)
964 for (i = 0; i < BTRFS_NR_RAID_TYPES; i++) {
965 struct kobject *kobj;
967 kobj = space_info->block_group_kobjs[i];
968 space_info->block_group_kobjs[i] = NULL;
974 kobject_del(&space_info->kobj);
975 kobject_put(&space_info->kobj);
978 static const char *alloc_name(u64 flags)
981 case BTRFS_BLOCK_GROUP_METADATA | BTRFS_BLOCK_GROUP_DATA:
983 case BTRFS_BLOCK_GROUP_METADATA:
985 case BTRFS_BLOCK_GROUP_DATA:
987 case BTRFS_BLOCK_GROUP_SYSTEM:
991 return "invalid-combination";
996 * Create a sysfs entry for a space info type at path
997 * /sys/fs/btrfs/UUID/allocation/TYPE
999 int btrfs_sysfs_add_space_info_type(struct btrfs_fs_info *fs_info,
1000 struct btrfs_space_info *space_info)
1004 ret = kobject_init_and_add(&space_info->kobj, &space_info_ktype,
1005 fs_info->space_info_kobj, "%s",
1006 alloc_name(space_info->flags));
1008 kobject_put(&space_info->kobj);
1015 /* when one_device is NULL, it removes all device links */
1017 int btrfs_sysfs_rm_device_link(struct btrfs_fs_devices *fs_devices,
1018 struct btrfs_device *one_device)
1020 struct hd_struct *disk;
1021 struct kobject *disk_kobj;
1023 if (!fs_devices->devices_kobj)
1026 if (one_device && one_device->bdev) {
1027 disk = one_device->bdev->bd_part;
1028 disk_kobj = &part_to_dev(disk)->kobj;
1030 sysfs_remove_link(fs_devices->devices_kobj, disk_kobj->name);
1036 list_for_each_entry(one_device,
1037 &fs_devices->devices, dev_list) {
1038 if (!one_device->bdev)
1040 disk = one_device->bdev->bd_part;
1041 disk_kobj = &part_to_dev(disk)->kobj;
1043 sysfs_remove_link(fs_devices->devices_kobj, disk_kobj->name);
1049 int btrfs_sysfs_add_device_link(struct btrfs_fs_devices *fs_devices,
1050 struct btrfs_device *one_device)
1053 struct btrfs_device *dev;
1055 list_for_each_entry(dev, &fs_devices->devices, dev_list) {
1056 struct hd_struct *disk;
1057 struct kobject *disk_kobj;
1062 if (one_device && one_device != dev)
1065 disk = dev->bdev->bd_part;
1066 disk_kobj = &part_to_dev(disk)->kobj;
1068 error = sysfs_create_link(fs_devices->devices_kobj,
1069 disk_kobj, disk_kobj->name);
1077 void btrfs_kobject_uevent(struct block_device *bdev, enum kobject_action action)
1081 ret = kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, action);
1083 pr_warn("BTRFS: Sending event '%d' to kobject: '%s' (%p): failed\n",
1084 action, kobject_name(&disk_to_dev(bdev->bd_disk)->kobj),
1085 &disk_to_dev(bdev->bd_disk)->kobj);
1088 void btrfs_sysfs_update_sprout_fsid(struct btrfs_fs_devices *fs_devices,
1091 char fsid_buf[BTRFS_UUID_UNPARSED_SIZE];
1094 * Sprouting changes fsid of the mounted filesystem, rename the fsid
1097 snprintf(fsid_buf, BTRFS_UUID_UNPARSED_SIZE, "%pU", fsid);
1098 if (kobject_rename(&fs_devices->fsid_kobj, fsid_buf))
1099 btrfs_warn(fs_devices->fs_info,
1100 "sysfs: failed to create fsid for sprout");
1103 /* /sys/fs/btrfs/ entry */
1104 static struct kset *btrfs_kset;
1108 * /sys/fs/btrfs/UUID
1110 * Can be called by the device discovery thread.
1112 int btrfs_sysfs_add_fsid(struct btrfs_fs_devices *fs_devs)
1116 init_completion(&fs_devs->kobj_unregister);
1117 fs_devs->fsid_kobj.kset = btrfs_kset;
1118 error = kobject_init_and_add(&fs_devs->fsid_kobj, &btrfs_ktype, NULL,
1119 "%pU", fs_devs->fsid);
1121 kobject_put(&fs_devs->fsid_kobj);
1125 fs_devs->devices_kobj = kobject_create_and_add("devices",
1126 &fs_devs->fsid_kobj);
1127 if (!fs_devs->devices_kobj) {
1128 btrfs_err(fs_devs->fs_info,
1129 "failed to init sysfs device interface");
1130 kobject_put(&fs_devs->fsid_kobj);
1137 int btrfs_sysfs_add_mounted(struct btrfs_fs_info *fs_info)
1140 struct btrfs_fs_devices *fs_devs = fs_info->fs_devices;
1141 struct kobject *fsid_kobj = &fs_devs->fsid_kobj;
1143 btrfs_set_fs_info_ptr(fs_info);
1145 error = btrfs_sysfs_add_device_link(fs_devs, NULL);
1149 error = sysfs_create_files(fsid_kobj, btrfs_attrs);
1151 btrfs_sysfs_rm_device_link(fs_devs, NULL);
1155 error = sysfs_create_group(fsid_kobj,
1156 &btrfs_feature_attr_group);
1160 #ifdef CONFIG_BTRFS_DEBUG
1161 fs_info->debug_kobj = kobject_create_and_add("debug", fsid_kobj);
1162 if (!fs_info->debug_kobj) {
1167 error = sysfs_create_files(fs_info->debug_kobj, btrfs_debug_mount_attrs);
1171 /* Discard directory */
1172 fs_info->discard_debug_kobj = kobject_create_and_add("discard",
1173 fs_info->debug_kobj);
1174 if (!fs_info->discard_debug_kobj) {
1179 error = sysfs_create_files(fs_info->discard_debug_kobj,
1180 discard_debug_attrs);
1185 error = addrm_unknown_feature_attrs(fs_info, true);
1189 fs_info->space_info_kobj = kobject_create_and_add("allocation",
1191 if (!fs_info->space_info_kobj) {
1196 error = sysfs_create_files(fs_info->space_info_kobj, allocation_attrs);
1202 btrfs_sysfs_remove_mounted(fs_info);
1208 * Change per-fs features in /sys/fs/btrfs/UUID/features to match current
1209 * values in superblock. Call after any changes to incompat/compat_ro flags
1211 void btrfs_sysfs_feature_update(struct btrfs_fs_info *fs_info,
1212 u64 bit, enum btrfs_feature_set set)
1214 struct btrfs_fs_devices *fs_devs;
1215 struct kobject *fsid_kobj;
1222 features = get_features(fs_info, set);
1223 ASSERT(bit & supported_feature_masks[set]);
1225 fs_devs = fs_info->fs_devices;
1226 fsid_kobj = &fs_devs->fsid_kobj;
1228 if (!fsid_kobj->state_initialized)
1232 * FIXME: this is too heavy to update just one value, ideally we'd like
1233 * to use sysfs_update_group but some refactoring is needed first.
1235 sysfs_remove_group(fsid_kobj, &btrfs_feature_attr_group);
1236 ret = sysfs_create_group(fsid_kobj, &btrfs_feature_attr_group);
1239 int __init btrfs_init_sysfs(void)
1243 btrfs_kset = kset_create_and_add("btrfs", NULL, fs_kobj);
1247 init_feature_attrs();
1248 ret = sysfs_create_group(&btrfs_kset->kobj, &btrfs_feature_attr_group);
1251 ret = sysfs_merge_group(&btrfs_kset->kobj,
1252 &btrfs_static_feature_attr_group);
1254 goto out_remove_group;
1256 #ifdef CONFIG_BTRFS_DEBUG
1257 ret = sysfs_create_group(&btrfs_kset->kobj, &btrfs_debug_feature_attr_group);
1265 sysfs_remove_group(&btrfs_kset->kobj, &btrfs_feature_attr_group);
1267 kset_unregister(btrfs_kset);
1272 void __cold btrfs_exit_sysfs(void)
1274 sysfs_unmerge_group(&btrfs_kset->kobj,
1275 &btrfs_static_feature_attr_group);
1276 sysfs_remove_group(&btrfs_kset->kobj, &btrfs_feature_attr_group);
1277 #ifdef CONFIG_BTRFS_DEBUG
1278 sysfs_remove_group(&btrfs_kset->kobj, &btrfs_debug_feature_attr_group);
1280 kset_unregister(btrfs_kset);