xref: /openbmc/linux/fs/gfs2/sys.c (revision e190bfe5)
1 /*
2  * Copyright (C) Sistina Software, Inc.  1997-2003 All rights reserved.
3  * Copyright (C) 2004-2006 Red Hat, Inc.  All rights reserved.
4  *
5  * This copyrighted material is made available to anyone wishing to use,
6  * modify, copy, or redistribute it subject to the terms and conditions
7  * of the GNU General Public License version 2.
8  */
9 
10 #include <linux/sched.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 <asm/uaccess.h>
17 #include <linux/gfs2_ondisk.h>
18 #include <linux/genhd.h>
19 
20 #include "gfs2.h"
21 #include "incore.h"
22 #include "sys.h"
23 #include "super.h"
24 #include "glock.h"
25 #include "quota.h"
26 #include "util.h"
27 #include "glops.h"
28 
29 struct gfs2_attr {
30 	struct attribute attr;
31 	ssize_t (*show)(struct gfs2_sbd *, char *);
32 	ssize_t (*store)(struct gfs2_sbd *, const char *, size_t);
33 };
34 
35 static ssize_t gfs2_attr_show(struct kobject *kobj, struct attribute *attr,
36 			      char *buf)
37 {
38 	struct gfs2_sbd *sdp = container_of(kobj, struct gfs2_sbd, sd_kobj);
39 	struct gfs2_attr *a = container_of(attr, struct gfs2_attr, attr);
40 	return a->show ? a->show(sdp, buf) : 0;
41 }
42 
43 static ssize_t gfs2_attr_store(struct kobject *kobj, struct attribute *attr,
44 			       const char *buf, size_t len)
45 {
46 	struct gfs2_sbd *sdp = container_of(kobj, struct gfs2_sbd, sd_kobj);
47 	struct gfs2_attr *a = container_of(attr, struct gfs2_attr, attr);
48 	return a->store ? a->store(sdp, buf, len) : len;
49 }
50 
51 static const struct sysfs_ops gfs2_attr_ops = {
52 	.show  = gfs2_attr_show,
53 	.store = gfs2_attr_store,
54 };
55 
56 
57 static struct kset *gfs2_kset;
58 
59 static ssize_t id_show(struct gfs2_sbd *sdp, char *buf)
60 {
61 	return snprintf(buf, PAGE_SIZE, "%u:%u\n",
62 			MAJOR(sdp->sd_vfs->s_dev), MINOR(sdp->sd_vfs->s_dev));
63 }
64 
65 static ssize_t fsname_show(struct gfs2_sbd *sdp, char *buf)
66 {
67 	return snprintf(buf, PAGE_SIZE, "%s\n", sdp->sd_fsname);
68 }
69 
70 static int gfs2_uuid_valid(const u8 *uuid)
71 {
72 	int i;
73 
74 	for (i = 0; i < 16; i++) {
75 		if (uuid[i])
76 			return 1;
77 	}
78 	return 0;
79 }
80 
81 static ssize_t uuid_show(struct gfs2_sbd *sdp, char *buf)
82 {
83 	const u8 *uuid = sdp->sd_sb.sb_uuid;
84 	buf[0] = '\0';
85 	if (!gfs2_uuid_valid(uuid))
86 		return 0;
87 	return snprintf(buf, PAGE_SIZE, "%pUB\n", uuid);
88 }
89 
90 static ssize_t freeze_show(struct gfs2_sbd *sdp, char *buf)
91 {
92 	unsigned int count;
93 
94 	mutex_lock(&sdp->sd_freeze_lock);
95 	count = sdp->sd_freeze_count;
96 	mutex_unlock(&sdp->sd_freeze_lock);
97 
98 	return snprintf(buf, PAGE_SIZE, "%u\n", count);
99 }
100 
101 static ssize_t freeze_store(struct gfs2_sbd *sdp, const char *buf, size_t len)
102 {
103 	ssize_t ret = len;
104 	int error = 0;
105 	int n = simple_strtol(buf, NULL, 0);
106 
107 	if (!capable(CAP_SYS_ADMIN))
108 		return -EACCES;
109 
110 	switch (n) {
111 	case 0:
112 		gfs2_unfreeze_fs(sdp);
113 		break;
114 	case 1:
115 		error = gfs2_freeze_fs(sdp);
116 		break;
117 	default:
118 		ret = -EINVAL;
119 	}
120 
121 	if (error)
122 		fs_warn(sdp, "freeze %d error %d", n, error);
123 
124 	return ret;
125 }
126 
127 static ssize_t withdraw_show(struct gfs2_sbd *sdp, char *buf)
128 {
129 	unsigned int b = test_bit(SDF_SHUTDOWN, &sdp->sd_flags);
130 	return snprintf(buf, PAGE_SIZE, "%u\n", b);
131 }
132 
133 static ssize_t withdraw_store(struct gfs2_sbd *sdp, const char *buf, size_t len)
134 {
135 	if (!capable(CAP_SYS_ADMIN))
136 		return -EACCES;
137 
138 	if (simple_strtol(buf, NULL, 0) != 1)
139 		return -EINVAL;
140 
141 	gfs2_lm_withdraw(sdp,
142 		"GFS2: fsid=%s: withdrawing from cluster at user's request\n",
143 		sdp->sd_fsname);
144 	return len;
145 }
146 
147 static ssize_t statfs_sync_store(struct gfs2_sbd *sdp, const char *buf,
148 				 size_t len)
149 {
150 	if (!capable(CAP_SYS_ADMIN))
151 		return -EACCES;
152 
153 	if (simple_strtol(buf, NULL, 0) != 1)
154 		return -EINVAL;
155 
156 	gfs2_statfs_sync(sdp->sd_vfs, 0);
157 	return len;
158 }
159 
160 static ssize_t quota_sync_store(struct gfs2_sbd *sdp, const char *buf,
161 				size_t len)
162 {
163 	if (!capable(CAP_SYS_ADMIN))
164 		return -EACCES;
165 
166 	if (simple_strtol(buf, NULL, 0) != 1)
167 		return -EINVAL;
168 
169 	gfs2_quota_sync(sdp->sd_vfs, 0, 1);
170 	return len;
171 }
172 
173 static ssize_t quota_refresh_user_store(struct gfs2_sbd *sdp, const char *buf,
174 					size_t len)
175 {
176 	int error;
177 	u32 id;
178 
179 	if (!capable(CAP_SYS_ADMIN))
180 		return -EACCES;
181 
182 	id = simple_strtoul(buf, NULL, 0);
183 
184 	error = gfs2_quota_refresh(sdp, 1, id);
185 	return error ? error : len;
186 }
187 
188 static ssize_t quota_refresh_group_store(struct gfs2_sbd *sdp, const char *buf,
189 					 size_t len)
190 {
191 	int error;
192 	u32 id;
193 
194 	if (!capable(CAP_SYS_ADMIN))
195 		return -EACCES;
196 
197 	id = simple_strtoul(buf, NULL, 0);
198 
199 	error = gfs2_quota_refresh(sdp, 0, id);
200 	return error ? error : len;
201 }
202 
203 static ssize_t demote_rq_store(struct gfs2_sbd *sdp, const char *buf, size_t len)
204 {
205 	struct gfs2_glock *gl;
206 	const struct gfs2_glock_operations *glops;
207 	unsigned int glmode;
208 	unsigned int gltype;
209 	unsigned long long glnum;
210 	char mode[16];
211 	int rv;
212 
213 	if (!capable(CAP_SYS_ADMIN))
214 		return -EACCES;
215 
216 	rv = sscanf(buf, "%u:%llu %15s", &gltype, &glnum,
217 		    mode);
218 	if (rv != 3)
219 		return -EINVAL;
220 
221 	if (strcmp(mode, "EX") == 0)
222 		glmode = LM_ST_UNLOCKED;
223 	else if ((strcmp(mode, "CW") == 0) || (strcmp(mode, "DF") == 0))
224 		glmode = LM_ST_DEFERRED;
225 	else if ((strcmp(mode, "PR") == 0) || (strcmp(mode, "SH") == 0))
226 		glmode = LM_ST_SHARED;
227 	else
228 		return -EINVAL;
229 
230 	if (gltype > LM_TYPE_JOURNAL)
231 		return -EINVAL;
232 	glops = gfs2_glops_list[gltype];
233 	if (glops == NULL)
234 		return -EINVAL;
235 	if (!test_and_set_bit(SDF_DEMOTE, &sdp->sd_flags))
236 		fs_info(sdp, "demote interface used\n");
237 	rv = gfs2_glock_get(sdp, glnum, glops, 0, &gl);
238 	if (rv)
239 		return rv;
240 	gfs2_glock_cb(gl, glmode);
241 	gfs2_glock_put(gl);
242 	return len;
243 }
244 
245 
246 #define GFS2_ATTR(name, mode, show, store) \
247 static struct gfs2_attr gfs2_attr_##name = __ATTR(name, mode, show, store)
248 
249 GFS2_ATTR(id,                  0444, id_show,       NULL);
250 GFS2_ATTR(fsname,              0444, fsname_show,   NULL);
251 GFS2_ATTR(uuid,                0444, uuid_show,     NULL);
252 GFS2_ATTR(freeze,              0644, freeze_show,   freeze_store);
253 GFS2_ATTR(withdraw,            0644, withdraw_show, withdraw_store);
254 GFS2_ATTR(statfs_sync,         0200, NULL,          statfs_sync_store);
255 GFS2_ATTR(quota_sync,          0200, NULL,          quota_sync_store);
256 GFS2_ATTR(quota_refresh_user,  0200, NULL,          quota_refresh_user_store);
257 GFS2_ATTR(quota_refresh_group, 0200, NULL,          quota_refresh_group_store);
258 GFS2_ATTR(demote_rq,           0200, NULL,	    demote_rq_store);
259 
260 static struct attribute *gfs2_attrs[] = {
261 	&gfs2_attr_id.attr,
262 	&gfs2_attr_fsname.attr,
263 	&gfs2_attr_uuid.attr,
264 	&gfs2_attr_freeze.attr,
265 	&gfs2_attr_withdraw.attr,
266 	&gfs2_attr_statfs_sync.attr,
267 	&gfs2_attr_quota_sync.attr,
268 	&gfs2_attr_quota_refresh_user.attr,
269 	&gfs2_attr_quota_refresh_group.attr,
270 	&gfs2_attr_demote_rq.attr,
271 	NULL,
272 };
273 
274 static struct kobj_type gfs2_ktype = {
275 	.default_attrs = gfs2_attrs,
276 	.sysfs_ops     = &gfs2_attr_ops,
277 };
278 
279 
280 /*
281  * lock_module. Originally from lock_dlm
282  */
283 
284 static ssize_t proto_name_show(struct gfs2_sbd *sdp, char *buf)
285 {
286 	const struct lm_lockops *ops = sdp->sd_lockstruct.ls_ops;
287 	return sprintf(buf, "%s\n", ops->lm_proto_name);
288 }
289 
290 static ssize_t block_show(struct gfs2_sbd *sdp, char *buf)
291 {
292 	struct lm_lockstruct *ls = &sdp->sd_lockstruct;
293 	ssize_t ret;
294 	int val = 0;
295 
296 	if (test_bit(DFL_BLOCK_LOCKS, &ls->ls_flags))
297 		val = 1;
298 	ret = sprintf(buf, "%d\n", val);
299 	return ret;
300 }
301 
302 static ssize_t block_store(struct gfs2_sbd *sdp, const char *buf, size_t len)
303 {
304 	struct lm_lockstruct *ls = &sdp->sd_lockstruct;
305 	ssize_t ret = len;
306 	int val;
307 
308 	val = simple_strtol(buf, NULL, 0);
309 
310 	if (val == 1)
311 		set_bit(DFL_BLOCK_LOCKS, &ls->ls_flags);
312 	else if (val == 0) {
313 		clear_bit(DFL_BLOCK_LOCKS, &ls->ls_flags);
314 		smp_mb__after_clear_bit();
315 		gfs2_glock_thaw(sdp);
316 	} else {
317 		ret = -EINVAL;
318 	}
319 	return ret;
320 }
321 
322 static ssize_t lkfirst_show(struct gfs2_sbd *sdp, char *buf)
323 {
324 	struct lm_lockstruct *ls = &sdp->sd_lockstruct;
325 	return sprintf(buf, "%d\n", ls->ls_first);
326 }
327 
328 static ssize_t first_done_show(struct gfs2_sbd *sdp, char *buf)
329 {
330 	struct lm_lockstruct *ls = &sdp->sd_lockstruct;
331 	return sprintf(buf, "%d\n", ls->ls_first_done);
332 }
333 
334 static ssize_t recover_store(struct gfs2_sbd *sdp, const char *buf, size_t len)
335 {
336 	unsigned jid;
337 	struct gfs2_jdesc *jd;
338 	int rv;
339 
340 	rv = sscanf(buf, "%u", &jid);
341 	if (rv != 1)
342 		return -EINVAL;
343 
344 	rv = -ESHUTDOWN;
345 	spin_lock(&sdp->sd_jindex_spin);
346 	if (test_bit(SDF_NORECOVERY, &sdp->sd_flags))
347 		goto out;
348 	rv = -EBUSY;
349 	if (sdp->sd_jdesc->jd_jid == jid)
350 		goto out;
351 	rv = -ENOENT;
352 	list_for_each_entry(jd, &sdp->sd_jindex_list, jd_list) {
353 		if (jd->jd_jid != jid)
354 			continue;
355 		rv = slow_work_enqueue(&jd->jd_work);
356 		break;
357 	}
358 out:
359 	spin_unlock(&sdp->sd_jindex_spin);
360 	return rv ? rv : len;
361 }
362 
363 static ssize_t recover_done_show(struct gfs2_sbd *sdp, char *buf)
364 {
365 	struct lm_lockstruct *ls = &sdp->sd_lockstruct;
366 	return sprintf(buf, "%d\n", ls->ls_recover_jid_done);
367 }
368 
369 static ssize_t recover_status_show(struct gfs2_sbd *sdp, char *buf)
370 {
371 	struct lm_lockstruct *ls = &sdp->sd_lockstruct;
372 	return sprintf(buf, "%d\n", ls->ls_recover_jid_status);
373 }
374 
375 static ssize_t jid_show(struct gfs2_sbd *sdp, char *buf)
376 {
377 	return sprintf(buf, "%u\n", sdp->sd_lockstruct.ls_jid);
378 }
379 
380 #define GDLM_ATTR(_name,_mode,_show,_store) \
381 static struct gfs2_attr gdlm_attr_##_name = __ATTR(_name,_mode,_show,_store)
382 
383 GDLM_ATTR(proto_name,		0444, proto_name_show,		NULL);
384 GDLM_ATTR(block,		0644, block_show,		block_store);
385 GDLM_ATTR(withdraw,		0644, withdraw_show,		withdraw_store);
386 GDLM_ATTR(jid,			0444, jid_show,			NULL);
387 GDLM_ATTR(first,		0444, lkfirst_show,		NULL);
388 GDLM_ATTR(first_done,		0444, first_done_show,		NULL);
389 GDLM_ATTR(recover,		0600, NULL,			recover_store);
390 GDLM_ATTR(recover_done,		0444, recover_done_show,	NULL);
391 GDLM_ATTR(recover_status,	0444, recover_status_show,	NULL);
392 
393 static struct attribute *lock_module_attrs[] = {
394 	&gdlm_attr_proto_name.attr,
395 	&gdlm_attr_block.attr,
396 	&gdlm_attr_withdraw.attr,
397 	&gdlm_attr_jid.attr,
398 	&gdlm_attr_first.attr,
399 	&gdlm_attr_first_done.attr,
400 	&gdlm_attr_recover.attr,
401 	&gdlm_attr_recover_done.attr,
402 	&gdlm_attr_recover_status.attr,
403 	NULL,
404 };
405 
406 /*
407  * get and set struct gfs2_tune fields
408  */
409 
410 static ssize_t quota_scale_show(struct gfs2_sbd *sdp, char *buf)
411 {
412 	return snprintf(buf, PAGE_SIZE, "%u %u\n",
413 			sdp->sd_tune.gt_quota_scale_num,
414 			sdp->sd_tune.gt_quota_scale_den);
415 }
416 
417 static ssize_t quota_scale_store(struct gfs2_sbd *sdp, const char *buf,
418 				 size_t len)
419 {
420 	struct gfs2_tune *gt = &sdp->sd_tune;
421 	unsigned int x, y;
422 
423 	if (!capable(CAP_SYS_ADMIN))
424 		return -EACCES;
425 
426 	if (sscanf(buf, "%u %u", &x, &y) != 2 || !y)
427 		return -EINVAL;
428 
429 	spin_lock(&gt->gt_spin);
430 	gt->gt_quota_scale_num = x;
431 	gt->gt_quota_scale_den = y;
432 	spin_unlock(&gt->gt_spin);
433 	return len;
434 }
435 
436 static ssize_t tune_set(struct gfs2_sbd *sdp, unsigned int *field,
437 			int check_zero, const char *buf, size_t len)
438 {
439 	struct gfs2_tune *gt = &sdp->sd_tune;
440 	unsigned int x;
441 
442 	if (!capable(CAP_SYS_ADMIN))
443 		return -EACCES;
444 
445 	x = simple_strtoul(buf, NULL, 0);
446 
447 	if (check_zero && !x)
448 		return -EINVAL;
449 
450 	spin_lock(&gt->gt_spin);
451 	*field = x;
452 	spin_unlock(&gt->gt_spin);
453 	return len;
454 }
455 
456 #define TUNE_ATTR_3(name, show, store)                                        \
457 static struct gfs2_attr tune_attr_##name = __ATTR(name, 0644, show, store)
458 
459 #define TUNE_ATTR_2(name, store)                                              \
460 static ssize_t name##_show(struct gfs2_sbd *sdp, char *buf)                   \
461 {                                                                             \
462 	return snprintf(buf, PAGE_SIZE, "%u\n", sdp->sd_tune.gt_##name);      \
463 }                                                                             \
464 TUNE_ATTR_3(name, name##_show, store)
465 
466 #define TUNE_ATTR(name, check_zero)                                           \
467 static ssize_t name##_store(struct gfs2_sbd *sdp, const char *buf, size_t len)\
468 {                                                                             \
469 	return tune_set(sdp, &sdp->sd_tune.gt_##name, check_zero, buf, len);  \
470 }                                                                             \
471 TUNE_ATTR_2(name, name##_store)
472 
473 TUNE_ATTR(quota_warn_period, 0);
474 TUNE_ATTR(quota_quantum, 0);
475 TUNE_ATTR(max_readahead, 0);
476 TUNE_ATTR(complain_secs, 0);
477 TUNE_ATTR(statfs_slow, 0);
478 TUNE_ATTR(new_files_jdata, 0);
479 TUNE_ATTR(quota_simul_sync, 1);
480 TUNE_ATTR(statfs_quantum, 1);
481 TUNE_ATTR_3(quota_scale, quota_scale_show, quota_scale_store);
482 
483 static struct attribute *tune_attrs[] = {
484 	&tune_attr_quota_warn_period.attr,
485 	&tune_attr_quota_quantum.attr,
486 	&tune_attr_max_readahead.attr,
487 	&tune_attr_complain_secs.attr,
488 	&tune_attr_statfs_slow.attr,
489 	&tune_attr_quota_simul_sync.attr,
490 	&tune_attr_statfs_quantum.attr,
491 	&tune_attr_quota_scale.attr,
492 	&tune_attr_new_files_jdata.attr,
493 	NULL,
494 };
495 
496 static struct attribute_group tune_group = {
497 	.name = "tune",
498 	.attrs = tune_attrs,
499 };
500 
501 static struct attribute_group lock_module_group = {
502 	.name = "lock_module",
503 	.attrs = lock_module_attrs,
504 };
505 
506 int gfs2_sys_fs_add(struct gfs2_sbd *sdp)
507 {
508 	struct super_block *sb = sdp->sd_vfs;
509 	int error;
510 	char ro[20];
511 	char spectator[20];
512 	char *envp[] = { ro, spectator, NULL };
513 
514 	sprintf(ro, "RDONLY=%d", (sb->s_flags & MS_RDONLY) ? 1 : 0);
515 	sprintf(spectator, "SPECTATOR=%d", sdp->sd_args.ar_spectator ? 1 : 0);
516 
517 	sdp->sd_kobj.kset = gfs2_kset;
518 	error = kobject_init_and_add(&sdp->sd_kobj, &gfs2_ktype, NULL,
519 				     "%s", sdp->sd_table_name);
520 	if (error)
521 		goto fail;
522 
523 	error = sysfs_create_group(&sdp->sd_kobj, &tune_group);
524 	if (error)
525 		goto fail_reg;
526 
527 	error = sysfs_create_group(&sdp->sd_kobj, &lock_module_group);
528 	if (error)
529 		goto fail_tune;
530 
531 	error = sysfs_create_link(&sdp->sd_kobj,
532 				  &disk_to_dev(sb->s_bdev->bd_disk)->kobj,
533 				  "device");
534 	if (error)
535 		goto fail_lock_module;
536 
537 	kobject_uevent_env(&sdp->sd_kobj, KOBJ_ADD, envp);
538 	return 0;
539 
540 fail_lock_module:
541 	sysfs_remove_group(&sdp->sd_kobj, &lock_module_group);
542 fail_tune:
543 	sysfs_remove_group(&sdp->sd_kobj, &tune_group);
544 fail_reg:
545 	kobject_put(&sdp->sd_kobj);
546 fail:
547 	fs_err(sdp, "error %d adding sysfs files", error);
548 	return error;
549 }
550 
551 void gfs2_sys_fs_del(struct gfs2_sbd *sdp)
552 {
553 	sysfs_remove_link(&sdp->sd_kobj, "device");
554 	sysfs_remove_group(&sdp->sd_kobj, &tune_group);
555 	sysfs_remove_group(&sdp->sd_kobj, &lock_module_group);
556 	kobject_put(&sdp->sd_kobj);
557 }
558 
559 static int gfs2_uevent(struct kset *kset, struct kobject *kobj,
560 		       struct kobj_uevent_env *env)
561 {
562 	struct gfs2_sbd *sdp = container_of(kobj, struct gfs2_sbd, sd_kobj);
563 	const u8 *uuid = sdp->sd_sb.sb_uuid;
564 
565 	add_uevent_var(env, "LOCKTABLE=%s", sdp->sd_table_name);
566 	add_uevent_var(env, "LOCKPROTO=%s", sdp->sd_proto_name);
567 	if (!sdp->sd_args.ar_spectator)
568 		add_uevent_var(env, "JOURNALID=%u", sdp->sd_lockstruct.ls_jid);
569 	if (gfs2_uuid_valid(uuid))
570 		add_uevent_var(env, "UUID=%pUB", uuid);
571 	return 0;
572 }
573 
574 static const struct kset_uevent_ops gfs2_uevent_ops = {
575 	.uevent = gfs2_uevent,
576 };
577 
578 int gfs2_sys_init(void)
579 {
580 	gfs2_kset = kset_create_and_add("gfs2", &gfs2_uevent_ops, fs_kobj);
581 	if (!gfs2_kset)
582 		return -ENOMEM;
583 	return 0;
584 }
585 
586 void gfs2_sys_uninit(void)
587 {
588 	kset_unregister(gfs2_kset);
589 }
590 
591