lustre/obdclass/obd_sysfs.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lustre/obdclass/obd_sysfs.c
  33  *
  34  * Object Devices Class Driver
  35  * These are the only exported functions, they provide some generic
  36  * infrastructure for managing object devices
  37  */
  38
  39 #define DEBUG_SUBSYSTEM S_CLASS
  40
  41 #include <linux/module.h>
  42 #include <linux/errno.h>
  43 #include <linux/kernel.h>
  44 #include <linux/sched.h>
  45 #include <linux/lp.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>
  52 #include <linux/fs.h>
  53 #include <linux/poll.h>
  54 #include <linux/init.h>
  55 #include <linux/list.h>
  56 #include <linux/highmem.h>
  57 #include <asm/io.h>
  58 #include <asm/ioctls.h>
  59 #include <asm/poll.h>
  60 #include <asm/uaccess.h>
  61 #include <linux/miscdevice.h>
  62 #include <linux/seq_file.h>
  63 #include <linux/kobject.h>
  64
  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>
  72
  73 struct static_lustre_uintvalue_attr {
  74         struct {
  75                 struct attribute attr;
  76                 ssize_t (*show)(struct kobject *kobj, struct attribute *attr,
  77                                 char *buf);
  78                 ssize_t (*store)(struct kobject *kobj, struct attribute *attr,
  79                                  const char *buf, size_t len);
  80         } u;
  81         int *value;
  82 };
  83
  84 static ssize_t static_uintvalue_show(struct kobject *kobj,
  85                                      struct attribute *attr,
  86                                      char *buf)
  87 {
  88         struct static_lustre_uintvalue_attr *lattr = (void *)attr;
  89
  90         return sprintf(buf, "%d\n", *lattr->value);
  91 }
  92
  93 static ssize_t static_uintvalue_store(struct kobject *kobj,
  94                                       struct attribute *attr,
  95                                       const char *buffer, size_t count)
  96 {
  97         struct static_lustre_uintvalue_attr *lattr = (void *)attr;
  98         unsigned int val;
  99         int rc;
 100
 101         rc = kstrtouint(buffer, 10, &val);
 102         if (rc)
 103                 return rc;
 104
 105         *lattr->value = val;
 106
 107         return count;
 108 }
 109
 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 }
 114
 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);
 125
 126 #ifdef HAVE_SERVER_SUPPORT
 127 LUSTRE_STATIC_UINT_ATTR(ldlm_timeout, &ldlm_timeout);
 128 LUSTRE_STATIC_UINT_ATTR(bulk_timeout, &bulk_timeout);
 129 #endif
 130
 131 static ssize_t memused_show(struct kobject *kobj, struct attribute *attr,
 132                             char *buf)
 133 {
 134         return sprintf(buf, "%llu\n", obd_memory_sum());
 135 }
 136 LUSTRE_RO_ATTR(memused);
 137
 138 static ssize_t memused_max_show(struct kobject *kobj, struct attribute *attr,
 139                                 char *buf)
 140 {
 141         return sprintf(buf, "%llu\n", obd_memory_max());
 142 }
 143 LUSTRE_RO_ATTR(memused_max);
 144
 145 static ssize_t max_dirty_mb_show(struct kobject *kobj, struct attribute *attr,
 146                                  char *buf)
 147 {
 148         return sprintf(buf, "%lu\n",
 149                        obd_max_dirty_pages / (1 << (20 - PAGE_SHIFT)));
 150 }
 151
 152 static ssize_t max_dirty_mb_store(struct kobject *kobj, struct attribute *attr,
 153                                   const char *buffer, size_t count)
 154 {
 155         unsigned long val;
 156         int rc;
 157
 158         rc = kstrtoul(buffer, 10, &val);
 159         if (rc)
 160                 return rc;
 161
 162         val *= 1 << (20 - PAGE_SHIFT); /* convert to pages */
 163
 164         if (val > ((totalram_pages / 10) * 9)) {
 165                 /* Somebody wants to assign too much memory to dirty pages */
 166                 return -EINVAL;
 167         }
 168
 169         if (val < 4 << (20 - PAGE_SHIFT)) {
 170                 /* Less than 4 Mb for dirty cache is also bad */
 171                 return -EINVAL;
 172         }
 173
 174         obd_max_dirty_pages = val;
 175
 176         return count;
 177 }
 178 LUSTRE_RW_ATTR(max_dirty_mb);
 179
 180 static ssize_t version_show(struct kobject *kobj, struct attribute *attr,
 181                             char *buf)
 182 {
 183         return sprintf(buf, "%s\n", LUSTRE_VERSION_STRING);
 184 }
 185
 186 static ssize_t pinger_show(struct kobject *kobj, struct attribute *attr,
 187                            char *buf)
 188 {
 189 #ifdef ENABLE_PINGER
 190         const char *state = "on";
 191 #else
 192         const char *state = "off";
 193 #endif
 194         return sprintf(buf, "%s\n", state);
 195 }
 196
 197 /**
 198  * Check all obd devices health
 199  *
 200  * \param kobj
 201  * \param buf [in]
 202  *
 203  * \retval number of characters printed if healthy
 204  */
 205 static ssize_t
 206 health_check_show(struct kobject *kobj, struct attribute *attr, char *buf)
 207 {
 208         bool healthy = true;
 209         size_t len = 0;
 210         int i;
 211
 212         if (libcfs_catastrophe) {
 213                 len = sprintf(buf, "LBUG\n");
 214                 healthy = false;
 215         }
 216
 217         read_lock(&obd_dev_lock);
 218         for (i = 0; i < class_devno_max(); i++) {
 219                 struct obd_device *obd;
 220
 221                 obd = class_num2obd(i);
 222                 if (obd == NULL || !obd->obd_attached || !obd->obd_set_up)
 223                         continue;
 224
 225                 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
 226                 if (obd->obd_stopping)
 227                         continue;
 228
 229                 class_incref(obd, __FUNCTION__, current);
 230                 read_unlock(&obd_dev_lock);
 231
 232                 if (obd_health_check(NULL, obd)) {
 233                         len = sprintf(buf, "device %s reported unhealthy\n",
 234                                       obd->obd_name);
 235                         healthy = false;
 236                 }
 237                 class_decref(obd, __FUNCTION__, current);
 238                 read_lock(&obd_dev_lock);
 239         }
 240         read_unlock(&obd_dev_lock);
 241
 242         if (healthy)
 243                 len = sprintf(buf, "healthy\n");
 244         else
 245                 len = sprintf(buf, "NOT HEALTHY\n");
 246
 247         return len;
 248 }
 249
 250 static ssize_t jobid_var_show(struct kobject *kobj, struct attribute *attr,
 251                               char *buf)
 252 {
 253         int rc = 0;
 254
 255         if (strlen(obd_jobid_var))
 256                 rc = snprintf(buf, PAGE_SIZE, "%s\n", obd_jobid_var);
 257         return rc;
 258 }
 259
 260 static ssize_t jobid_var_store(struct kobject *kobj, struct attribute *attr,
 261                                const char *buffer, size_t count)
 262 {
 263         if (!count || count > JOBSTATS_JOBID_VAR_MAX_LEN)
 264                 return -EINVAL;
 265
 266         memset(obd_jobid_var, 0, JOBSTATS_JOBID_VAR_MAX_LEN + 1);
 267
 268         memcpy(obd_jobid_var, buffer, count);
 269
 270         /* Trim the trailing '\n' if any */
 271         if (obd_jobid_var[count - 1] == '\n')
 272                 obd_jobid_var[count - 1] = 0;
 273
 274         return count;
 275 }
 276
 277 static ssize_t jobid_name_show(struct kobject *kobj, struct attribute *attr,
 278                                char *buf)
 279 {
 280         int rc = 0;
 281
 282         if (strlen(obd_jobid_name))
 283                 rc = snprintf(buf, PAGE_SIZE, "%s\n", obd_jobid_name);
 284         return rc;
 285 }
 286
 287 static ssize_t jobid_name_store(struct kobject *kobj, struct attribute *attr,
 288                                 const char *buffer, size_t count)
 289 {
 290         if (!count || count > LUSTRE_JOBID_SIZE)
 291                 return -EINVAL;
 292
 293         if (strcmp(obd_jobid_var, JOBSTATS_NODELOCAL) != 0 &&
 294             !strchr(buffer, '%')) {
 295                 lustre_jobid_clear(buffer);
 296                 return count;
 297         }
 298
 299         /* clear previous value */
 300         memset(obd_jobid_name, 0, LUSTRE_JOBID_SIZE);
 301
 302         memcpy(obd_jobid_name, buffer, count);
 303
 304         /* Trim the trailing '\n' if any */
 305         if (obd_jobid_name[count - 1] == '\n') {
 306                 /* Don't echo just a newline */
 307                 if (count == 1)
 308                         return -EINVAL;
 309                 obd_jobid_name[count - 1] = 0;
 310         }
 311
 312         return count;
 313 }
 314
 315 /* Root for /sys/kernel/debug/lustre */
 316 struct dentry *debugfs_lustre_root;
 317 EXPORT_SYMBOL_GPL(debugfs_lustre_root);
 318
 319 #ifdef CONFIG_PROC_FS
 320 /* Root for /proc/fs/lustre */
 321 struct proc_dir_entry *proc_lustre_root;
 322 EXPORT_SYMBOL(proc_lustre_root);
 323 #else
 324 #define lprocfs_base NULL
 325 #endif /* CONFIG_PROC_FS */
 326
 327 LUSTRE_RO_ATTR(version);
 328 LUSTRE_RO_ATTR(pinger);
 329 LUSTRE_RO_ATTR(health_check);
 330 LUSTRE_RW_ATTR(jobid_var);
 331 LUSTRE_RW_ATTR(jobid_name);
 332
 333 static struct attribute *lustre_attrs[] = {
 334         &lustre_attr_version.attr,
 335         &lustre_attr_pinger.attr,
 336         &lustre_attr_health_check.attr,
 337         &lustre_attr_jobid_name.attr,
 338         &lustre_attr_jobid_var.attr,
 339         &lustre_sattr_timeout.u.attr,
 340         &lustre_attr_max_dirty_mb.attr,
 341         &lustre_sattr_debug_peer_on_timeout.u.attr,
 342         &lustre_sattr_dump_on_timeout.u.attr,
 343         &lustre_sattr_dump_on_eviction.u.attr,
 344         &lustre_sattr_at_min.u.attr,
 345         &lustre_sattr_at_max.u.attr,
 346         &lustre_sattr_at_extra.u.attr,
 347         &lustre_sattr_at_early_margin.u.attr,
 348         &lustre_sattr_at_history.u.attr,
 349         &lustre_attr_memused_max.attr,
 350         &lustre_attr_memused.attr,
 351 #ifdef HAVE_SERVER_SUPPORT
 352         &lustre_sattr_ldlm_timeout.u.attr,
 353         &lustre_sattr_bulk_timeout.u.attr,
 354 #endif
 355         &lustre_sattr_lbug_on_eviction.u.attr,
 356         NULL,
 357 };
 358
 359 static void *obd_device_list_seq_start(struct seq_file *p, loff_t *pos)
 360 {
 361         if (*pos >= class_devno_max())
 362                 return NULL;
 363
 364         return pos;
 365 }
 366
 367 static void obd_device_list_seq_stop(struct seq_file *p, void *v)
 368 {
 369 }
 370
 371 static void *obd_device_list_seq_next(struct seq_file *p, void *v, loff_t *pos)
 372 {
 373         ++*pos;
 374         if (*pos >= class_devno_max())
 375                 return NULL;
 376
 377         return pos;
 378 }
 379
 380 static int obd_device_list_seq_show(struct seq_file *p, void *v)
 381 {
 382         loff_t index = *(loff_t *)v;
 383         struct obd_device *obd = class_num2obd((int)index);
 384         char *status;
 385
 386         if (obd == NULL)
 387                 return 0;
 388
 389         LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
 390         if (obd->obd_stopping)
 391                 status = "ST";
 392         else if (obd->obd_inactive)
 393                 status = "IN";
 394         else if (obd->obd_set_up)
 395                 status = "UP";
 396         else if (obd->obd_attached)
 397                 status = "AT";
 398         else
 399                 status = "--";
 400
 401         seq_printf(p, "%3d %s %s %s %s %d\n",
 402                    (int)index, status, obd->obd_type->typ_name,
 403                    obd->obd_name, obd->obd_uuid.uuid,
 404                    atomic_read(&obd->obd_refcount));
 405         return 0;
 406 }
 407
 408 static const struct seq_operations obd_device_list_sops = {
 409         .start = obd_device_list_seq_start,
 410         .stop = obd_device_list_seq_stop,
 411         .next = obd_device_list_seq_next,
 412         .show = obd_device_list_seq_show,
 413 };
 414
 415 static int obd_device_list_open(struct inode *inode, struct file *file)
 416 {
 417         struct seq_file *seq;
 418         int rc = seq_open(file, &obd_device_list_sops);
 419
 420         if (rc)
 421                 return rc;
 422
 423         seq = file->private_data;
 424         seq->private = inode->i_private;
 425         return 0;
 426 }
 427
 428 static const struct file_operations obd_device_list_fops = {
 429         .owner   = THIS_MODULE,
 430         .open    = obd_device_list_open,
 431         .read    = seq_read,
 432         .llseek  = seq_lseek,
 433         .release = seq_release,
 434 };
 435
 436 struct kset *lustre_kset;
 437 EXPORT_SYMBOL_GPL(lustre_kset);
 438
 439 static struct attribute_group lustre_attr_group = {
 440         .attrs = lustre_attrs,
 441 };
 442
 443 ssize_t class_set_global(const char *param)
 444 {
 445         const char *value = strchr(param, '=') + 1;
 446         size_t off = value - param - 1;
 447         ssize_t count = -ENOENT;
 448         int i;
 449
 450         for (i = 0; lustre_attrs[i]; i++) {
 451                 if (!strncmp(lustre_attrs[i]->name, param, off)) {
 452                         count = lustre_attr_store(&lustre_kset->kobj,
 453                                                   lustre_attrs[i], value,
 454                                                   strlen(value));
 455                         break;
 456                 }
 457         }
 458         return count;
 459 }
 460
 461 int class_procfs_init(void)
 462 {
 463         struct proc_dir_entry *entry;
 464         struct dentry *file;
 465         int rc = -ENOMEM;
 466
 467         ENTRY;
 468
 469         lustre_kset = kset_create_and_add("lustre", NULL, fs_kobj);
 470         if (!lustre_kset)
 471                 goto out;
 472
 473         /* Create the files associated with this kobject */
 474         rc = sysfs_create_group(&lustre_kset->kobj, &lustre_attr_group);
 475         if (rc) {
 476                 kset_unregister(lustre_kset);
 477                 goto out;
 478         }
 479
 480         rc = jobid_cache_init();
 481         if (rc) {
 482                 kset_unregister(lustre_kset);
 483                 goto out;
 484         }
 485
 486         debugfs_lustre_root = debugfs_create_dir("lustre", NULL);
 487         if (IS_ERR_OR_NULL(debugfs_lustre_root)) {
 488                 rc = debugfs_lustre_root ? PTR_ERR(debugfs_lustre_root)
 489                                          : -ENOMEM;
 490                 debugfs_lustre_root = NULL;
 491                 kset_unregister(lustre_kset);
 492                 goto out;
 493         }
 494
 495         file = debugfs_create_file("devices", 0444, debugfs_lustre_root, NULL,
 496                                    &obd_device_list_fops);
 497         if (IS_ERR_OR_NULL(file)) {
 498                 rc = file ? PTR_ERR(file) : -ENOMEM;
 499                 debugfs_remove(debugfs_lustre_root);
 500                 kset_unregister(lustre_kset);
 501                 goto out;
 502         }
 503
 504         entry = lprocfs_register("fs/lustre", NULL, NULL, NULL);
 505         if (IS_ERR(entry)) {
 506                 rc = PTR_ERR(entry);
 507                 CERROR("cannot create '/proc/fs/lustre': rc = %d\n", rc);
 508                 debugfs_remove_recursive(debugfs_lustre_root);
 509                 kset_unregister(lustre_kset);
 510                 goto out;
 511         }
 512
 513         proc_lustre_root = entry;
 514 out:
 515         RETURN(rc);
 516 }
 517
 518 int class_procfs_clean(void)
 519 {
 520         ENTRY;
 521
 522         debugfs_remove_recursive(debugfs_lustre_root);
 523
 524         debugfs_lustre_root = NULL;
 525         jobid_cache_fini();
 526
 527         if (proc_lustre_root)
 528                 lprocfs_remove(&proc_lustre_root);
 529
 530         sysfs_remove_group(&lustre_kset->kobj, &lustre_attr_group);
 531
 532         kset_unregister(lustre_kset);
 533
 534         RETURN(0);
 535 }