1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
4 * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
7 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
9 #include <linux/sched.h>
10 #include <linux/cred.h>
11 #include <linux/spinlock.h>
12 #include <linux/completion.h>
13 #include <linux/buffer_head.h>
14 #include <linux/module.h>
15 #include <linux/kobject.h>
16 #include <linux/uaccess.h>
17 #include <linux/gfs2_ondisk.h>
18 #include <linux/blkdev.h>
31 struct attribute attr;
32 ssize_t (*show)(struct gfs2_sbd *, char *);
33 ssize_t (*store)(struct gfs2_sbd *, const char *, size_t);
36 static ssize_t gfs2_attr_show(struct kobject *kobj, struct attribute *attr,
39 struct gfs2_sbd *sdp = container_of(kobj, struct gfs2_sbd, sd_kobj);
40 struct gfs2_attr *a = container_of(attr, struct gfs2_attr, attr);
41 return a->show ? a->show(sdp, buf) : 0;
44 static ssize_t gfs2_attr_store(struct kobject *kobj, struct attribute *attr,
45 const char *buf, size_t len)
47 struct gfs2_sbd *sdp = container_of(kobj, struct gfs2_sbd, sd_kobj);
48 struct gfs2_attr *a = container_of(attr, struct gfs2_attr, attr);
49 return a->store ? a->store(sdp, buf, len) : len;
52 static const struct sysfs_ops gfs2_attr_ops = {
53 .show = gfs2_attr_show,
54 .store = gfs2_attr_store,
58 static struct kset *gfs2_kset;
60 static ssize_t id_show(struct gfs2_sbd *sdp, char *buf)
62 return snprintf(buf, PAGE_SIZE, "%u:%u\n",
63 MAJOR(sdp->sd_vfs->s_dev), MINOR(sdp->sd_vfs->s_dev));
66 static ssize_t status_show(struct gfs2_sbd *sdp, char *buf)
68 unsigned long f = sdp->sd_flags;
71 s = snprintf(buf, PAGE_SIZE,
72 "Journal Checked: %d\n"
83 "Skip DLM Unlock: %d\n"
84 "Force AIL Flush: %d\n"
87 "Withdraw In Prog: %d\n"
88 "Remote Withdraw: %d\n"
89 "Withdraw Recovery: %d\n"
92 "sd_log_flush_lock: %d\n"
93 "sd_log_num_revoke: %u\n"
94 "sd_log_in_flight: %d\n"
95 "sd_log_blks_needed: %d\n"
96 "sd_log_blks_free: %d\n"
97 "sd_log_flush_head: %d\n"
98 "sd_log_flush_tail: %d\n"
99 "sd_log_blks_reserved: %d\n"
100 "sd_log_revokes_available: %d\n",
101 test_bit(SDF_JOURNAL_CHECKED, &f),
102 test_bit(SDF_JOURNAL_LIVE, &f),
103 (sdp->sd_jdesc ? sdp->sd_jdesc->jd_jid : 0),
104 (sdp->sd_args.ar_spectator ? 1 : 0),
105 test_bit(SDF_WITHDRAWN, &f),
106 test_bit(SDF_NOBARRIERS, &f),
107 test_bit(SDF_NORECOVERY, &f),
108 test_bit(SDF_DEMOTE, &f),
109 test_bit(SDF_NOJOURNALID, &f),
110 (sb_rdonly(sdp->sd_vfs) ? 1 : 0),
111 test_bit(SDF_RORECOVERY, &f),
112 test_bit(SDF_SKIP_DLM_UNLOCK, &f),
113 test_bit(SDF_FORCE_AIL_FLUSH, &f),
114 test_bit(SDF_FS_FROZEN, &f),
115 test_bit(SDF_WITHDRAWING, &f),
116 test_bit(SDF_WITHDRAW_IN_PROG, &f),
117 test_bit(SDF_REMOTE_WITHDRAW, &f),
118 test_bit(SDF_WITHDRAW_RECOVERY, &f),
119 test_bit(SDF_DEACTIVATING, &f),
121 rwsem_is_locked(&sdp->sd_log_flush_lock),
122 sdp->sd_log_num_revoke,
123 atomic_read(&sdp->sd_log_in_flight),
124 atomic_read(&sdp->sd_log_blks_needed),
125 atomic_read(&sdp->sd_log_blks_free),
126 sdp->sd_log_flush_head,
127 sdp->sd_log_flush_tail,
128 sdp->sd_log_blks_reserved,
129 atomic_read(&sdp->sd_log_revokes_available));
133 static ssize_t fsname_show(struct gfs2_sbd *sdp, char *buf)
135 return snprintf(buf, PAGE_SIZE, "%s\n", sdp->sd_fsname);
138 static ssize_t uuid_show(struct gfs2_sbd *sdp, char *buf)
140 struct super_block *s = sdp->sd_vfs;
143 if (uuid_is_null(&s->s_uuid))
145 return snprintf(buf, PAGE_SIZE, "%pUB\n", &s->s_uuid);
148 static ssize_t freeze_show(struct gfs2_sbd *sdp, char *buf)
150 struct super_block *sb = sdp->sd_vfs;
151 int frozen = (sb->s_writers.frozen == SB_UNFROZEN) ? 0 : 1;
153 return snprintf(buf, PAGE_SIZE, "%d\n", frozen);
156 static ssize_t freeze_store(struct gfs2_sbd *sdp, const char *buf, size_t len)
160 error = kstrtoint(buf, 0, &n);
164 if (!capable(CAP_SYS_ADMIN))
169 error = thaw_super(sdp->sd_vfs);
172 error = freeze_super(sdp->sd_vfs);
179 fs_warn(sdp, "freeze %d error %d\n", n, error);
186 static ssize_t withdraw_show(struct gfs2_sbd *sdp, char *buf)
188 unsigned int b = gfs2_withdrawn(sdp);
189 return snprintf(buf, PAGE_SIZE, "%u\n", b);
192 static ssize_t withdraw_store(struct gfs2_sbd *sdp, const char *buf, size_t len)
196 if (!capable(CAP_SYS_ADMIN))
199 error = kstrtoint(buf, 0, &val);
206 gfs2_lm(sdp, "withdrawing from cluster at user's request\n");
212 static ssize_t statfs_sync_store(struct gfs2_sbd *sdp, const char *buf,
217 if (!capable(CAP_SYS_ADMIN))
220 error = kstrtoint(buf, 0, &val);
227 gfs2_statfs_sync(sdp->sd_vfs, 0);
231 static ssize_t quota_sync_store(struct gfs2_sbd *sdp, const char *buf,
236 if (!capable(CAP_SYS_ADMIN))
239 error = kstrtoint(buf, 0, &val);
246 gfs2_quota_sync(sdp->sd_vfs, 0);
250 static ssize_t quota_refresh_user_store(struct gfs2_sbd *sdp, const char *buf,
257 if (!capable(CAP_SYS_ADMIN))
260 error = kstrtou32(buf, 0, &id);
264 qid = make_kqid(current_user_ns(), USRQUOTA, id);
268 error = gfs2_quota_refresh(sdp, qid);
269 return error ? error : len;
272 static ssize_t quota_refresh_group_store(struct gfs2_sbd *sdp, const char *buf,
279 if (!capable(CAP_SYS_ADMIN))
282 error = kstrtou32(buf, 0, &id);
286 qid = make_kqid(current_user_ns(), GRPQUOTA, id);
290 error = gfs2_quota_refresh(sdp, qid);
291 return error ? error : len;
294 static ssize_t demote_rq_store(struct gfs2_sbd *sdp, const char *buf, size_t len)
296 struct gfs2_glock *gl;
297 const struct gfs2_glock_operations *glops;
300 unsigned long long glnum;
304 if (!capable(CAP_SYS_ADMIN))
307 rv = sscanf(buf, "%u:%llu %15s", &gltype, &glnum,
312 if (strcmp(mode, "EX") == 0)
313 glmode = LM_ST_UNLOCKED;
314 else if ((strcmp(mode, "CW") == 0) || (strcmp(mode, "DF") == 0))
315 glmode = LM_ST_DEFERRED;
316 else if ((strcmp(mode, "PR") == 0) || (strcmp(mode, "SH") == 0))
317 glmode = LM_ST_SHARED;
321 if (gltype > LM_TYPE_JOURNAL)
323 if (gltype == LM_TYPE_NONDISK && glnum == GFS2_FREEZE_LOCK)
324 glops = &gfs2_freeze_glops;
326 glops = gfs2_glops_list[gltype];
329 if (!test_and_set_bit(SDF_DEMOTE, &sdp->sd_flags))
330 fs_info(sdp, "demote interface used\n");
331 rv = gfs2_glock_get(sdp, glnum, glops, 0, &gl);
334 gfs2_glock_cb(gl, glmode);
340 #define GFS2_ATTR(name, mode, show, store) \
341 static struct gfs2_attr gfs2_attr_##name = __ATTR(name, mode, show, store)
343 GFS2_ATTR(id, 0444, id_show, NULL);
344 GFS2_ATTR(fsname, 0444, fsname_show, NULL);
345 GFS2_ATTR(uuid, 0444, uuid_show, NULL);
346 GFS2_ATTR(freeze, 0644, freeze_show, freeze_store);
347 GFS2_ATTR(withdraw, 0644, withdraw_show, withdraw_store);
348 GFS2_ATTR(statfs_sync, 0200, NULL, statfs_sync_store);
349 GFS2_ATTR(quota_sync, 0200, NULL, quota_sync_store);
350 GFS2_ATTR(quota_refresh_user, 0200, NULL, quota_refresh_user_store);
351 GFS2_ATTR(quota_refresh_group, 0200, NULL, quota_refresh_group_store);
352 GFS2_ATTR(demote_rq, 0200, NULL, demote_rq_store);
353 GFS2_ATTR(status, 0400, status_show, NULL);
355 static struct attribute *gfs2_attrs[] = {
357 &gfs2_attr_fsname.attr,
358 &gfs2_attr_uuid.attr,
359 &gfs2_attr_freeze.attr,
360 &gfs2_attr_withdraw.attr,
361 &gfs2_attr_statfs_sync.attr,
362 &gfs2_attr_quota_sync.attr,
363 &gfs2_attr_quota_refresh_user.attr,
364 &gfs2_attr_quota_refresh_group.attr,
365 &gfs2_attr_demote_rq.attr,
366 &gfs2_attr_status.attr,
369 ATTRIBUTE_GROUPS(gfs2);
371 static void gfs2_sbd_release(struct kobject *kobj)
373 struct gfs2_sbd *sdp = container_of(kobj, struct gfs2_sbd, sd_kobj);
375 complete(&sdp->sd_kobj_unregister);
378 static struct kobj_type gfs2_ktype = {
379 .release = gfs2_sbd_release,
380 .default_groups = gfs2_groups,
381 .sysfs_ops = &gfs2_attr_ops,
386 * lock_module. Originally from lock_dlm
389 static ssize_t proto_name_show(struct gfs2_sbd *sdp, char *buf)
391 const struct lm_lockops *ops = sdp->sd_lockstruct.ls_ops;
392 return sprintf(buf, "%s\n", ops->lm_proto_name);
395 static ssize_t block_show(struct gfs2_sbd *sdp, char *buf)
397 struct lm_lockstruct *ls = &sdp->sd_lockstruct;
401 if (test_bit(DFL_BLOCK_LOCKS, &ls->ls_recover_flags))
403 ret = sprintf(buf, "%d\n", val);
407 static ssize_t block_store(struct gfs2_sbd *sdp, const char *buf, size_t len)
409 struct lm_lockstruct *ls = &sdp->sd_lockstruct;
412 ret = kstrtoint(buf, 0, &val);
417 set_bit(DFL_BLOCK_LOCKS, &ls->ls_recover_flags);
419 clear_bit(DFL_BLOCK_LOCKS, &ls->ls_recover_flags);
420 smp_mb__after_atomic();
421 gfs2_glock_thaw(sdp);
428 static ssize_t wdack_show(struct gfs2_sbd *sdp, char *buf)
430 int val = completion_done(&sdp->sd_wdack) ? 1 : 0;
432 return sprintf(buf, "%d\n", val);
435 static ssize_t wdack_store(struct gfs2_sbd *sdp, const char *buf, size_t len)
439 ret = kstrtoint(buf, 0, &val);
444 !strcmp(sdp->sd_lockstruct.ls_ops->lm_proto_name, "lock_dlm"))
445 complete(&sdp->sd_wdack);
451 static ssize_t lkfirst_show(struct gfs2_sbd *sdp, char *buf)
453 struct lm_lockstruct *ls = &sdp->sd_lockstruct;
454 return sprintf(buf, "%d\n", ls->ls_first);
457 static ssize_t lkfirst_store(struct gfs2_sbd *sdp, const char *buf, size_t len)
462 rv = sscanf(buf, "%u", &first);
463 if (rv != 1 || first > 1)
465 rv = wait_for_completion_killable(&sdp->sd_locking_init);
468 spin_lock(&sdp->sd_jindex_spin);
470 if (test_bit(SDF_NOJOURNALID, &sdp->sd_flags) == 0)
473 if (sdp->sd_args.ar_spectator)
475 if (sdp->sd_lockstruct.ls_ops->lm_mount == NULL)
477 sdp->sd_lockstruct.ls_first = first;
480 spin_unlock(&sdp->sd_jindex_spin);
481 return rv ? rv : len;
484 static ssize_t first_done_show(struct gfs2_sbd *sdp, char *buf)
486 struct lm_lockstruct *ls = &sdp->sd_lockstruct;
487 return sprintf(buf, "%d\n", !!test_bit(DFL_FIRST_MOUNT_DONE, &ls->ls_recover_flags));
490 int gfs2_recover_set(struct gfs2_sbd *sdp, unsigned jid)
492 struct gfs2_jdesc *jd;
495 /* Wait for our primary journal to be initialized */
496 wait_for_completion(&sdp->sd_journal_ready);
498 spin_lock(&sdp->sd_jindex_spin);
501 * If we're a spectator, we use journal0, but it's not really ours.
502 * So we need to wait for its recovery too. If we skip it we'd never
503 * queue work to the recovery workqueue, and so its completion would
504 * never clear the DFL_BLOCK_LOCKS flag, so all our locks would
505 * permanently stop working.
509 if (sdp->sd_jdesc->jd_jid == jid && !sdp->sd_args.ar_spectator)
512 list_for_each_entry(jd, &sdp->sd_jindex_list, jd_list) {
513 if (jd->jd_jid != jid && !sdp->sd_args.ar_spectator)
515 rv = gfs2_recover_journal(jd, false);
519 spin_unlock(&sdp->sd_jindex_spin);
523 static ssize_t recover_store(struct gfs2_sbd *sdp, const char *buf, size_t len)
528 rv = sscanf(buf, "%u", &jid);
532 if (test_bit(SDF_NORECOVERY, &sdp->sd_flags)) {
537 rv = gfs2_recover_set(sdp, jid);
539 return rv ? rv : len;
542 static ssize_t recover_done_show(struct gfs2_sbd *sdp, char *buf)
544 struct lm_lockstruct *ls = &sdp->sd_lockstruct;
545 return sprintf(buf, "%d\n", ls->ls_recover_jid_done);
548 static ssize_t recover_status_show(struct gfs2_sbd *sdp, char *buf)
550 struct lm_lockstruct *ls = &sdp->sd_lockstruct;
551 return sprintf(buf, "%d\n", ls->ls_recover_jid_status);
554 static ssize_t jid_show(struct gfs2_sbd *sdp, char *buf)
556 return sprintf(buf, "%d\n", sdp->sd_lockstruct.ls_jid);
559 static ssize_t jid_store(struct gfs2_sbd *sdp, const char *buf, size_t len)
564 rv = sscanf(buf, "%d", &jid);
567 rv = wait_for_completion_killable(&sdp->sd_locking_init);
570 spin_lock(&sdp->sd_jindex_spin);
572 if (sdp->sd_lockstruct.ls_ops->lm_mount == NULL)
575 if (test_bit(SDF_NOJOURNALID, &sdp->sd_flags) == 0)
578 if (sdp->sd_args.ar_spectator && jid > 0)
580 sdp->sd_lockstruct.ls_jid = jid;
581 clear_bit(SDF_NOJOURNALID, &sdp->sd_flags);
582 smp_mb__after_atomic();
583 wake_up_bit(&sdp->sd_flags, SDF_NOJOURNALID);
585 spin_unlock(&sdp->sd_jindex_spin);
586 return rv ? rv : len;
589 #define GDLM_ATTR(_name,_mode,_show,_store) \
590 static struct gfs2_attr gdlm_attr_##_name = __ATTR(_name,_mode,_show,_store)
592 GDLM_ATTR(proto_name, 0444, proto_name_show, NULL);
593 GDLM_ATTR(block, 0644, block_show, block_store);
594 GDLM_ATTR(withdraw, 0644, wdack_show, wdack_store);
595 GDLM_ATTR(jid, 0644, jid_show, jid_store);
596 GDLM_ATTR(first, 0644, lkfirst_show, lkfirst_store);
597 GDLM_ATTR(first_done, 0444, first_done_show, NULL);
598 GDLM_ATTR(recover, 0600, NULL, recover_store);
599 GDLM_ATTR(recover_done, 0444, recover_done_show, NULL);
600 GDLM_ATTR(recover_status, 0444, recover_status_show, NULL);
602 static struct attribute *lock_module_attrs[] = {
603 &gdlm_attr_proto_name.attr,
604 &gdlm_attr_block.attr,
605 &gdlm_attr_withdraw.attr,
607 &gdlm_attr_first.attr,
608 &gdlm_attr_first_done.attr,
609 &gdlm_attr_recover.attr,
610 &gdlm_attr_recover_done.attr,
611 &gdlm_attr_recover_status.attr,
616 * get and set struct gfs2_tune fields
619 static ssize_t quota_scale_show(struct gfs2_sbd *sdp, char *buf)
621 return snprintf(buf, PAGE_SIZE, "%u %u\n",
622 sdp->sd_tune.gt_quota_scale_num,
623 sdp->sd_tune.gt_quota_scale_den);
626 static ssize_t quota_scale_store(struct gfs2_sbd *sdp, const char *buf,
629 struct gfs2_tune *gt = &sdp->sd_tune;
632 if (!capable(CAP_SYS_ADMIN))
635 if (sscanf(buf, "%u %u", &x, &y) != 2 || !y)
638 spin_lock(>->gt_spin);
639 gt->gt_quota_scale_num = x;
640 gt->gt_quota_scale_den = y;
641 spin_unlock(>->gt_spin);
645 static ssize_t tune_set(struct gfs2_sbd *sdp, unsigned int *field,
646 int check_zero, const char *buf, size_t len)
648 struct gfs2_tune *gt = &sdp->sd_tune;
652 if (!capable(CAP_SYS_ADMIN))
655 error = kstrtouint(buf, 0, &x);
659 if (check_zero && !x)
662 spin_lock(>->gt_spin);
664 spin_unlock(>->gt_spin);
668 #define TUNE_ATTR_3(name, show, store) \
669 static struct gfs2_attr tune_attr_##name = __ATTR(name, 0644, show, store)
671 #define TUNE_ATTR_2(name, store) \
672 static ssize_t name##_show(struct gfs2_sbd *sdp, char *buf) \
674 return snprintf(buf, PAGE_SIZE, "%u\n", sdp->sd_tune.gt_##name); \
676 TUNE_ATTR_3(name, name##_show, store)
678 #define TUNE_ATTR(name, check_zero) \
679 static ssize_t name##_store(struct gfs2_sbd *sdp, const char *buf, size_t len)\
681 return tune_set(sdp, &sdp->sd_tune.gt_##name, check_zero, buf, len); \
683 TUNE_ATTR_2(name, name##_store)
685 TUNE_ATTR(quota_warn_period, 0);
686 TUNE_ATTR(quota_quantum, 0);
687 TUNE_ATTR(max_readahead, 0);
688 TUNE_ATTR(complain_secs, 0);
689 TUNE_ATTR(statfs_slow, 0);
690 TUNE_ATTR(new_files_jdata, 0);
691 TUNE_ATTR(statfs_quantum, 1);
692 TUNE_ATTR_3(quota_scale, quota_scale_show, quota_scale_store);
694 static struct attribute *tune_attrs[] = {
695 &tune_attr_quota_warn_period.attr,
696 &tune_attr_quota_quantum.attr,
697 &tune_attr_max_readahead.attr,
698 &tune_attr_complain_secs.attr,
699 &tune_attr_statfs_slow.attr,
700 &tune_attr_statfs_quantum.attr,
701 &tune_attr_quota_scale.attr,
702 &tune_attr_new_files_jdata.attr,
706 static const struct attribute_group tune_group = {
711 static const struct attribute_group lock_module_group = {
712 .name = "lock_module",
713 .attrs = lock_module_attrs,
716 int gfs2_sys_fs_add(struct gfs2_sbd *sdp)
718 struct super_block *sb = sdp->sd_vfs;
722 char *envp[] = { ro, spectator, NULL };
724 sprintf(ro, "RDONLY=%d", sb_rdonly(sb));
725 sprintf(spectator, "SPECTATOR=%d", sdp->sd_args.ar_spectator ? 1 : 0);
727 init_completion(&sdp->sd_kobj_unregister);
728 sdp->sd_kobj.kset = gfs2_kset;
729 error = kobject_init_and_add(&sdp->sd_kobj, &gfs2_ktype, NULL,
730 "%s", sdp->sd_table_name);
734 error = sysfs_create_group(&sdp->sd_kobj, &tune_group);
738 error = sysfs_create_group(&sdp->sd_kobj, &lock_module_group);
742 error = sysfs_create_link(&sdp->sd_kobj,
743 &disk_to_dev(sb->s_bdev->bd_disk)->kobj,
746 goto fail_lock_module;
748 kobject_uevent_env(&sdp->sd_kobj, KOBJ_ADD, envp);
752 sysfs_remove_group(&sdp->sd_kobj, &lock_module_group);
754 sysfs_remove_group(&sdp->sd_kobj, &tune_group);
756 fs_err(sdp, "error %d adding sysfs files\n", error);
757 kobject_put(&sdp->sd_kobj);
758 wait_for_completion(&sdp->sd_kobj_unregister);
759 sb->s_fs_info = NULL;
763 void gfs2_sys_fs_del(struct gfs2_sbd *sdp)
765 sysfs_remove_link(&sdp->sd_kobj, "device");
766 sysfs_remove_group(&sdp->sd_kobj, &tune_group);
767 sysfs_remove_group(&sdp->sd_kobj, &lock_module_group);
768 kobject_put(&sdp->sd_kobj);
769 wait_for_completion(&sdp->sd_kobj_unregister);
772 static int gfs2_uevent(const struct kobject *kobj, struct kobj_uevent_env *env)
774 const struct gfs2_sbd *sdp = container_of(kobj, struct gfs2_sbd, sd_kobj);
775 const struct super_block *s = sdp->sd_vfs;
777 add_uevent_var(env, "LOCKTABLE=%s", sdp->sd_table_name);
778 add_uevent_var(env, "LOCKPROTO=%s", sdp->sd_proto_name);
779 if (!test_bit(SDF_NOJOURNALID, &sdp->sd_flags))
780 add_uevent_var(env, "JOURNALID=%d", sdp->sd_lockstruct.ls_jid);
781 if (!uuid_is_null(&s->s_uuid))
782 add_uevent_var(env, "UUID=%pUB", &s->s_uuid);
786 static const struct kset_uevent_ops gfs2_uevent_ops = {
787 .uevent = gfs2_uevent,
790 int gfs2_sys_init(void)
792 gfs2_kset = kset_create_and_add("gfs2", &gfs2_uevent_ops, fs_kobj);
798 void gfs2_sys_uninit(void)
800 kset_unregister(gfs2_kset);