4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/obdclass/obd_sysfs.c
34 * Object Devices Class Driver
35 * These are the only exported functions, they provide some generic
36 * infrastructure for managing object devices
39 #define DEBUG_SUBSYSTEM S_CLASS
41 #include <linux/module.h>
42 #include <linux/errno.h>
43 #include <linux/kernel.h>
44 #include <linux/sched.h>
46 #include <linux/slab.h>
47 #include <linux/ioport.h>
48 #include <linux/fcntl.h>
49 #include <linux/delay.h>
50 #include <linux/skbuff.h>
51 #include <linux/proc_fs.h>
53 #include <linux/poll.h>
54 #include <linux/init.h>
55 #include <linux/list.h>
56 #include <linux/highmem.h>
58 #include <asm/ioctls.h>
60 #include <asm/uaccess.h>
61 #include <linux/miscdevice.h>
62 #include <linux/seq_file.h>
63 #include <linux/kobject.h>
65 #include <libcfs/libcfs.h>
66 #include <obd_support.h>
67 #include <obd_class.h>
68 #include <lprocfs_status.h>
69 #include <uapi/linux/lnet/lnetctl.h>
70 #include <uapi/linux/lustre/lustre_ioctl.h>
71 #include <uapi/linux/lustre/lustre_ver.h>
73 struct static_lustre_uintvalue_attr {
75 struct attribute attr;
76 ssize_t (*show)(struct kobject *kobj, struct attribute *attr,
78 ssize_t (*store)(struct kobject *kobj, struct attribute *attr,
79 const char *buf, size_t len);
84 static ssize_t static_uintvalue_show(struct kobject *kobj,
85 struct attribute *attr,
88 struct static_lustre_uintvalue_attr *lattr = (void *)attr;
90 return sprintf(buf, "%d\n", *lattr->value);
93 static ssize_t static_uintvalue_store(struct kobject *kobj,
94 struct attribute *attr,
95 const char *buffer, size_t count)
97 struct static_lustre_uintvalue_attr *lattr = (void *)attr;
101 rc = kstrtouint(buffer, 10, &val);
110 #define LUSTRE_STATIC_UINT_ATTR(name, value) \
111 static struct static_lustre_uintvalue_attr lustre_sattr_##name = \
112 { __ATTR(name, 0644, static_uintvalue_show, \
113 static_uintvalue_store), value }
115 LUSTRE_STATIC_UINT_ATTR(timeout, &obd_timeout);
116 LUSTRE_STATIC_UINT_ATTR(debug_peer_on_timeout, &obd_debug_peer_on_timeout);
117 LUSTRE_STATIC_UINT_ATTR(dump_on_timeout, &obd_dump_on_timeout);
118 LUSTRE_STATIC_UINT_ATTR(dump_on_eviction, &obd_dump_on_eviction);
119 LUSTRE_STATIC_UINT_ATTR(at_min, &at_min);
120 LUSTRE_STATIC_UINT_ATTR(at_max, &at_max);
121 LUSTRE_STATIC_UINT_ATTR(at_extra, &at_extra);
122 LUSTRE_STATIC_UINT_ATTR(at_early_margin, &at_early_margin);
123 LUSTRE_STATIC_UINT_ATTR(at_history, &at_history);
124 LUSTRE_STATIC_UINT_ATTR(lbug_on_eviction, &obd_lbug_on_eviction);
126 #ifdef HAVE_SERVER_SUPPORT
127 LUSTRE_STATIC_UINT_ATTR(ldlm_timeout, &ldlm_timeout);
128 LUSTRE_STATIC_UINT_ATTR(bulk_timeout, &bulk_timeout);
131 static ssize_t memused_show(struct kobject *kobj, struct attribute *attr,
134 return sprintf(buf, "%llu\n", obd_memory_sum());
136 LUSTRE_RO_ATTR(memused);
138 static ssize_t memused_max_show(struct kobject *kobj, struct attribute *attr,
141 return sprintf(buf, "%llu\n", obd_memory_max());
143 LUSTRE_RO_ATTR(memused_max);
145 static ssize_t max_dirty_mb_show(struct kobject *kobj, struct attribute *attr,
148 return sprintf(buf, "%lu\n",
149 obd_max_dirty_pages / (1 << (20 - PAGE_SHIFT)));
152 static ssize_t max_dirty_mb_store(struct kobject *kobj, struct attribute *attr,
153 const char *buffer, size_t count)
158 rc = kstrtoul(buffer, 10, &val);
162 val *= 1 << (20 - PAGE_SHIFT); /* convert to pages */
164 if (val > ((cfs_totalram_pages() / 10) * 9)) {
165 /* Somebody wants to assign too much memory to dirty pages */
169 if (val < 4 << (20 - PAGE_SHIFT)) {
170 /* Less than 4 Mb for dirty cache is also bad */
174 obd_max_dirty_pages = val;
178 LUSTRE_RW_ATTR(max_dirty_mb);
180 static ssize_t version_show(struct kobject *kobj, struct attribute *attr,
183 return sprintf(buf, "%s\n", LUSTRE_VERSION_STRING);
186 static ssize_t pinger_show(struct kobject *kobj, struct attribute *attr,
190 const char *state = "on";
192 const char *state = "off";
194 return sprintf(buf, "%s\n", state);
198 * Check all obd devices health
203 * \retval number of characters printed if healthy
206 health_check_show(struct kobject *kobj, struct attribute *attr, char *buf)
212 if (libcfs_catastrophe)
213 return sprintf(buf, "LBUG\n");
215 read_lock(&obd_dev_lock);
216 for (i = 0; i < class_devno_max(); i++) {
217 struct obd_device *obd;
219 obd = class_num2obd(i);
220 if (obd == NULL || !obd->obd_attached || !obd->obd_set_up)
223 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
224 if (obd->obd_stopping)
227 class_incref(obd, __func__, current);
228 read_unlock(&obd_dev_lock);
230 if (obd_health_check(NULL, obd))
233 class_decref(obd, __func__, current);
234 read_lock(&obd_dev_lock);
239 read_unlock(&obd_dev_lock);
242 len = sprintf(buf, "healthy\n");
244 len = sprintf(buf, "NOT HEALTHY\n");
249 static ssize_t jobid_var_show(struct kobject *kobj, struct attribute *attr,
254 if (strlen(obd_jobid_var))
255 rc = snprintf(buf, PAGE_SIZE, "%s\n", obd_jobid_var);
259 static ssize_t jobid_var_store(struct kobject *kobj, struct attribute *attr,
260 const char *buffer, size_t count)
262 if (!count || count > JOBSTATS_JOBID_VAR_MAX_LEN)
265 memset(obd_jobid_var, 0, JOBSTATS_JOBID_VAR_MAX_LEN + 1);
267 memcpy(obd_jobid_var, buffer, count);
269 /* Trim the trailing '\n' if any */
270 if (obd_jobid_var[count - 1] == '\n')
271 obd_jobid_var[count - 1] = 0;
276 static ssize_t jobid_name_show(struct kobject *kobj, struct attribute *attr,
281 if (strlen(obd_jobid_name))
282 rc = snprintf(buf, PAGE_SIZE, "%s\n", obd_jobid_name);
286 static ssize_t jobid_name_store(struct kobject *kobj, struct attribute *attr,
287 const char *buffer, size_t count)
289 if (!count || count > LUSTRE_JOBID_SIZE)
292 if (strcmp(obd_jobid_var, JOBSTATS_NODELOCAL) != 0 &&
293 !strchr(buffer, '%')) {
294 lustre_jobid_clear(buffer);
298 /* clear previous value */
299 memset(obd_jobid_name, 0, LUSTRE_JOBID_SIZE);
301 memcpy(obd_jobid_name, buffer, count);
303 /* Trim the trailing '\n' if any */
304 if (obd_jobid_name[count - 1] == '\n') {
305 /* Don't echo just a newline */
308 obd_jobid_name[count - 1] = 0;
314 static ssize_t jobid_this_session_show(struct kobject *kobj,
315 struct attribute *attr,
322 jid = jobid_current();
324 ret = snprintf(buf, PAGE_SIZE, "%s\n", jid);
329 static ssize_t jobid_this_session_store(struct kobject *kobj,
330 struct attribute *attr,
338 if (!count || count > LUSTRE_JOBID_SIZE)
341 jobid = kstrndup(buffer, count, GFP_KERNEL);
344 len = strcspn(jobid, "\n ");
346 ret = jobid_set_current(jobid);
352 /* Root for /sys/kernel/debug/lustre */
353 struct dentry *debugfs_lustre_root;
354 EXPORT_SYMBOL_GPL(debugfs_lustre_root);
356 #ifdef CONFIG_PROC_FS
357 /* Root for /proc/fs/lustre */
358 struct proc_dir_entry *proc_lustre_root;
359 EXPORT_SYMBOL(proc_lustre_root);
361 #define lprocfs_base NULL
362 #endif /* CONFIG_PROC_FS */
364 LUSTRE_RO_ATTR(version);
365 LUSTRE_RO_ATTR(pinger);
366 LUSTRE_RO_ATTR(health_check);
367 LUSTRE_RW_ATTR(jobid_var);
368 LUSTRE_RW_ATTR(jobid_name);
369 LUSTRE_RW_ATTR(jobid_this_session);
371 static struct attribute *lustre_attrs[] = {
372 &lustre_attr_version.attr,
373 &lustre_attr_pinger.attr,
374 &lustre_attr_health_check.attr,
375 &lustre_attr_jobid_name.attr,
376 &lustre_attr_jobid_var.attr,
377 &lustre_attr_jobid_this_session.attr,
378 &lustre_sattr_timeout.u.attr,
379 &lustre_attr_max_dirty_mb.attr,
380 &lustre_sattr_debug_peer_on_timeout.u.attr,
381 &lustre_sattr_dump_on_timeout.u.attr,
382 &lustre_sattr_dump_on_eviction.u.attr,
383 &lustre_sattr_at_min.u.attr,
384 &lustre_sattr_at_max.u.attr,
385 &lustre_sattr_at_extra.u.attr,
386 &lustre_sattr_at_early_margin.u.attr,
387 &lustre_sattr_at_history.u.attr,
388 &lustre_attr_memused_max.attr,
389 &lustre_attr_memused.attr,
390 #ifdef HAVE_SERVER_SUPPORT
391 &lustre_sattr_ldlm_timeout.u.attr,
392 &lustre_sattr_bulk_timeout.u.attr,
394 &lustre_sattr_lbug_on_eviction.u.attr,
398 static void *obd_device_list_seq_start(struct seq_file *p, loff_t *pos)
400 if (*pos >= class_devno_max())
406 static void obd_device_list_seq_stop(struct seq_file *p, void *v)
410 static void *obd_device_list_seq_next(struct seq_file *p, void *v, loff_t *pos)
413 if (*pos >= class_devno_max())
419 static int obd_device_list_seq_show(struct seq_file *p, void *v)
421 loff_t index = *(loff_t *)v;
422 struct obd_device *obd = class_num2obd((int)index);
428 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
429 if (obd->obd_stopping)
431 else if (obd->obd_inactive)
433 else if (obd->obd_set_up)
435 else if (obd->obd_attached)
440 seq_printf(p, "%3d %s %s %s %s %d\n",
441 (int)index, status, obd->obd_type->typ_name,
442 obd->obd_name, obd->obd_uuid.uuid,
443 atomic_read(&obd->obd_refcount));
447 static const struct seq_operations obd_device_list_sops = {
448 .start = obd_device_list_seq_start,
449 .stop = obd_device_list_seq_stop,
450 .next = obd_device_list_seq_next,
451 .show = obd_device_list_seq_show,
454 static int obd_device_list_open(struct inode *inode, struct file *file)
456 struct seq_file *seq;
457 int rc = seq_open(file, &obd_device_list_sops);
462 seq = file->private_data;
463 seq->private = inode->i_private;
467 static const struct file_operations obd_device_list_fops = {
468 .owner = THIS_MODULE,
469 .open = obd_device_list_open,
472 .release = seq_release,
476 health_check_seq_show(struct seq_file *m, void *unused)
480 read_lock(&obd_dev_lock);
481 for (i = 0; i < class_devno_max(); i++) {
482 struct obd_device *obd;
484 obd = class_num2obd(i);
485 if (obd == NULL || !obd->obd_attached || !obd->obd_set_up)
488 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
489 if (obd->obd_stopping)
492 class_incref(obd, __func__, current);
493 read_unlock(&obd_dev_lock);
495 if (obd_health_check(NULL, obd)) {
496 seq_printf(m, "device %s reported unhealthy\n",
499 class_decref(obd, __func__, current);
500 read_lock(&obd_dev_lock);
502 read_unlock(&obd_dev_lock);
507 LDEBUGFS_SEQ_FOPS_RO(health_check);
509 struct kset *lustre_kset;
510 EXPORT_SYMBOL_GPL(lustre_kset);
512 static struct attribute_group lustre_attr_group = {
513 .attrs = lustre_attrs,
516 ssize_t class_set_global(const char *param)
518 const char *value = strchr(param, '=') + 1;
519 size_t off = value - param - 1;
520 ssize_t count = -ENOENT;
523 for (i = 0; lustre_attrs[i]; i++) {
524 if (!strncmp(lustre_attrs[i]->name, param, off)) {
525 count = lustre_attr_store(&lustre_kset->kobj,
526 lustre_attrs[i], value,
534 int class_procfs_init(void)
536 struct proc_dir_entry *entry;
542 lustre_kset = kset_create_and_add("lustre", NULL, fs_kobj);
546 /* Create the files associated with this kobject */
547 rc = sysfs_create_group(&lustre_kset->kobj, &lustre_attr_group);
549 kset_unregister(lustre_kset);
553 rc = jobid_cache_init();
555 kset_unregister(lustre_kset);
559 debugfs_lustre_root = debugfs_create_dir("lustre", NULL);
560 if (IS_ERR_OR_NULL(debugfs_lustre_root)) {
561 rc = debugfs_lustre_root ? PTR_ERR(debugfs_lustre_root)
563 debugfs_lustre_root = NULL;
564 kset_unregister(lustre_kset);
568 file = debugfs_create_file("devices", 0444, debugfs_lustre_root, NULL,
569 &obd_device_list_fops);
570 if (IS_ERR_OR_NULL(file)) {
571 rc = file ? PTR_ERR(file) : -ENOMEM;
572 debugfs_remove(debugfs_lustre_root);
573 kset_unregister(lustre_kset);
577 file = debugfs_create_file("health_check", 0444, debugfs_lustre_root,
578 NULL, &health_check_fops);
579 if (IS_ERR_OR_NULL(file)) {
580 rc = file ? PTR_ERR(file) : -ENOMEM;
581 debugfs_remove_recursive(debugfs_lustre_root);
582 kset_unregister(lustre_kset);
586 entry = lprocfs_register("fs/lustre", NULL, NULL, NULL);
589 CERROR("cannot create '/proc/fs/lustre': rc = %d\n", rc);
590 debugfs_remove_recursive(debugfs_lustre_root);
591 kset_unregister(lustre_kset);
595 proc_lustre_root = entry;
600 int class_procfs_clean(void)
604 debugfs_remove_recursive(debugfs_lustre_root);
606 debugfs_lustre_root = NULL;
609 if (proc_lustre_root)
610 lprocfs_remove(&proc_lustre_root);
612 sysfs_remove_group(&lustre_kset->kobj, &lustre_attr_group);
614 kset_unregister(lustre_kset);