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 > ((cfs_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 #ifdef HAVE_SERVER_SUPPORT
 181 static ssize_t no_transno_store(struct kobject *kobj,
 182                                 struct attribute *attr,
 183                                 const char *buffer, size_t count)
 184 {
 185         struct obd_device *obd;
 186         unsigned int idx;
 187         int rc;
 188
 189         rc = kstrtouint(buffer, 10, &idx);
 190         if (rc)
 191                 return rc;
 192
 193         obd = class_num2obd(idx);
 194         if (!obd || !obd->obd_attached) {
 195                 if (obd)
 196                         CERROR("%s: not attached\n", obd->obd_name);
 197                 return -ENODEV;
 198         }
 199
 200         spin_lock(&obd->obd_dev_lock);
 201         obd->obd_no_transno = 1;
 202         spin_unlock(&obd->obd_dev_lock);
 203         return count;
 204 }
 205 LUSTRE_WO_ATTR(no_transno);
 206 #endif /* HAVE_SERVER_SUPPORT */
 207
 208 static ssize_t version_show(struct kobject *kobj, struct attribute *attr,
 209                             char *buf)
 210 {
 211         return sprintf(buf, "%s\n", LUSTRE_VERSION_STRING);
 212 }
 213
 214 static ssize_t pinger_show(struct kobject *kobj, struct attribute *attr,
 215                            char *buf)
 216 {
 217 #ifdef CONFIG_LUSTRE_FS_PINGER
 218         const char *state = "on";
 219 #else
 220         const char *state = "off";
 221 #endif
 222         return sprintf(buf, "%s\n", state);
 223 }
 224
 225 /**
 226  * Check all obd devices health
 227  *
 228  * \param kobj
 229  * \param buf [in]
 230  *
 231  * \retval number of characters printed if healthy
 232  */
 233 static ssize_t
 234 health_check_show(struct kobject *kobj, struct attribute *attr, char *buf)
 235 {
 236         bool healthy = true;
 237         size_t len = 0;
 238         int i;
 239
 240         if (libcfs_catastrophe)
 241                 return sprintf(buf, "LBUG\n");
 242
 243         read_lock(&obd_dev_lock);
 244         for (i = 0; i < class_devno_max(); i++) {
 245                 struct obd_device *obd;
 246
 247                 obd = class_num2obd(i);
 248                 if (obd == NULL || !obd->obd_attached || !obd->obd_set_up)
 249                         continue;
 250
 251                 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
 252                 if (obd->obd_stopping)
 253                         continue;
 254
 255                 class_incref(obd, __func__, current);
 256                 read_unlock(&obd_dev_lock);
 257
 258                 if (obd_health_check(NULL, obd))
 259                         healthy = false;
 260
 261                 class_decref(obd, __func__, current);
 262                 read_lock(&obd_dev_lock);
 263
 264                 if (!healthy)
 265                         break;
 266         }
 267         read_unlock(&obd_dev_lock);
 268
 269         if (healthy)
 270                 len = sprintf(buf, "healthy\n");
 271         else
 272                 len = sprintf(buf, "NOT HEALTHY\n");
 273
 274         return len;
 275 }
 276
 277 static ssize_t jobid_var_show(struct kobject *kobj, struct attribute *attr,
 278                               char *buf)
 279 {
 280         int rc = 0;
 281
 282         if (strlen(obd_jobid_var))
 283                 rc = scnprintf(buf, PAGE_SIZE, "%s\n", obd_jobid_var);
 284         return rc;
 285 }
 286
 287 static ssize_t jobid_var_store(struct kobject *kobj, struct attribute *attr,
 288                                const char *buffer, size_t count)
 289 {
 290         if (!count || count > JOBSTATS_JOBID_VAR_MAX_LEN)
 291                 return -EINVAL;
 292
 293         memset(obd_jobid_var, 0, JOBSTATS_JOBID_VAR_MAX_LEN + 1);
 294
 295         memcpy(obd_jobid_var, buffer, count);
 296
 297         /* Trim the trailing '\n' if any */
 298         if (obd_jobid_var[count - 1] == '\n')
 299                 obd_jobid_var[count - 1] = 0;
 300
 301         return count;
 302 }
 303
 304 static ssize_t jobid_name_show(struct kobject *kobj, struct attribute *attr,
 305                                char *buf)
 306 {
 307         int rc = 0;
 308
 309         if (strlen(obd_jobid_name))
 310                 rc = scnprintf(buf, PAGE_SIZE, "%s\n", obd_jobid_name);
 311         return rc;
 312 }
 313
 314 static ssize_t jobid_name_store(struct kobject *kobj, struct attribute *attr,
 315                                 const char *buffer, size_t count)
 316 {
 317         if (!count || count > LUSTRE_JOBID_SIZE)
 318                 return -EINVAL;
 319
 320         if (strcmp(obd_jobid_var, JOBSTATS_NODELOCAL) != 0 &&
 321             !strchr(buffer, '%')) {
 322                 lustre_jobid_clear(buffer);
 323                 return count;
 324         }
 325
 326         /* clear previous value */
 327         memset(obd_jobid_name, 0, LUSTRE_JOBID_SIZE);
 328
 329         memcpy(obd_jobid_name, buffer, count);
 330
 331         /* Trim the trailing '\n' if any */
 332         if (obd_jobid_name[count - 1] == '\n') {
 333                 /* Don't echo just a newline */
 334                 if (count == 1)
 335                         return -EINVAL;
 336                 obd_jobid_name[count - 1] = 0;
 337         }
 338
 339         return count;
 340 }
 341
 342 static ssize_t jobid_this_session_show(struct kobject *kobj,
 343                                        struct attribute *attr,
 344                                        char *buf)
 345 {
 346         char *jid;
 347         int ret = -ENOENT;
 348
 349         rcu_read_lock();
 350         jid = jobid_current();
 351         if (jid)
 352                 ret = scnprintf(buf, PAGE_SIZE, "%s\n", jid);
 353         rcu_read_unlock();
 354         return ret;
 355 }
 356
 357 static ssize_t jobid_this_session_store(struct kobject *kobj,
 358                                         struct attribute *attr,
 359                                         const char *buffer,
 360                                         size_t count)
 361 {
 362         char *jobid;
 363         int len;
 364         int ret;
 365
 366         if (!count || count > LUSTRE_JOBID_SIZE)
 367                 return -EINVAL;
 368
 369         jobid = kstrndup(buffer, count, GFP_KERNEL);
 370         if (!jobid)
 371                 return -ENOMEM;
 372         len = strcspn(jobid, "\n ");
 373         jobid[len] = '\0';
 374         ret = jobid_set_current(jobid);
 375         kfree(jobid);
 376
 377         return ret ?: count;
 378 }
 379
 380 /* Root for /sys/kernel/debug/lustre */
 381 struct dentry *debugfs_lustre_root;
 382 EXPORT_SYMBOL_GPL(debugfs_lustre_root);
 383
 384 #ifdef CONFIG_PROC_FS
 385 /* Root for /proc/fs/lustre */
 386 struct proc_dir_entry *proc_lustre_root;
 387 EXPORT_SYMBOL(proc_lustre_root);
 388 #else
 389 #define lprocfs_base NULL
 390 #endif /* CONFIG_PROC_FS */
 391
 392 LUSTRE_RO_ATTR(version);
 393 LUSTRE_RO_ATTR(pinger);
 394 LUSTRE_RO_ATTR(health_check);
 395 LUSTRE_RW_ATTR(jobid_var);
 396 LUSTRE_RW_ATTR(jobid_name);
 397 LUSTRE_RW_ATTR(jobid_this_session);
 398
 399 static struct attribute *lustre_attrs[] = {
 400         &lustre_attr_version.attr,
 401         &lustre_attr_pinger.attr,
 402         &lustre_attr_health_check.attr,
 403         &lustre_attr_jobid_name.attr,
 404         &lustre_attr_jobid_var.attr,
 405         &lustre_attr_jobid_this_session.attr,
 406         &lustre_sattr_timeout.u.attr,
 407         &lustre_attr_max_dirty_mb.attr,
 408         &lustre_sattr_debug_peer_on_timeout.u.attr,
 409         &lustre_sattr_dump_on_timeout.u.attr,
 410         &lustre_sattr_dump_on_eviction.u.attr,
 411         &lustre_sattr_at_min.u.attr,
 412         &lustre_sattr_at_max.u.attr,
 413         &lustre_sattr_at_extra.u.attr,
 414         &lustre_sattr_at_early_margin.u.attr,
 415         &lustre_sattr_at_history.u.attr,
 416         &lustre_attr_memused_max.attr,
 417         &lustre_attr_memused.attr,
 418 #ifdef HAVE_SERVER_SUPPORT
 419         &lustre_sattr_ldlm_timeout.u.attr,
 420         &lustre_sattr_bulk_timeout.u.attr,
 421         &lustre_attr_no_transno.attr,
 422 #endif
 423         &lustre_sattr_lbug_on_eviction.u.attr,
 424         NULL,
 425 };
 426
 427 static void *obd_device_list_seq_start(struct seq_file *p, loff_t *pos)
 428 {
 429         if (*pos >= class_devno_max())
 430                 return NULL;
 431
 432         return pos;
 433 }
 434
 435 static void obd_device_list_seq_stop(struct seq_file *p, void *v)
 436 {
 437 }
 438
 439 static void *obd_device_list_seq_next(struct seq_file *p, void *v, loff_t *pos)
 440 {
 441         ++*pos;
 442         if (*pos >= class_devno_max())
 443                 return NULL;
 444
 445         return pos;
 446 }
 447
 448 static int obd_device_list_seq_show(struct seq_file *p, void *v)
 449 {
 450         loff_t index = *(loff_t *)v;
 451         struct obd_device *obd = class_num2obd((int)index);
 452         char *status;
 453
 454         if (obd == NULL)
 455                 return 0;
 456
 457         LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
 458         if (obd->obd_stopping)
 459                 status = "ST";
 460         else if (obd->obd_inactive)
 461                 status = "IN";
 462         else if (obd->obd_set_up)
 463                 status = "UP";
 464         else if (obd->obd_attached)
 465                 status = "AT";
 466         else
 467                 status = "--";
 468
 469         seq_printf(p, "%3d %s %s %s %s %d\n",
 470                    (int)index, status, obd->obd_type->typ_name,
 471                    obd->obd_name, obd->obd_uuid.uuid,
 472                    atomic_read(&obd->obd_refcount));
 473         return 0;
 474 }
 475
 476 static const struct seq_operations obd_device_list_sops = {
 477         .start = obd_device_list_seq_start,
 478         .stop = obd_device_list_seq_stop,
 479         .next = obd_device_list_seq_next,
 480         .show = obd_device_list_seq_show,
 481 };
 482
 483 static int obd_device_list_open(struct inode *inode, struct file *file)
 484 {
 485         struct seq_file *seq;
 486         int rc = seq_open(file, &obd_device_list_sops);
 487
 488         if (rc)
 489                 return rc;
 490
 491         seq = file->private_data;
 492         seq->private = inode->i_private;
 493         return 0;
 494 }
 495
 496 static const struct file_operations obd_device_list_fops = {
 497         .owner   = THIS_MODULE,
 498         .open    = obd_device_list_open,
 499         .read    = seq_read,
 500         .llseek  = seq_lseek,
 501         .release = seq_release,
 502 };
 503
 504 static int
 505 health_check_seq_show(struct seq_file *m, void *unused)
 506 {
 507         int i;
 508
 509         read_lock(&obd_dev_lock);
 510         for (i = 0; i < class_devno_max(); i++) {
 511                 struct obd_device *obd;
 512
 513                 obd = class_num2obd(i);
 514                 if (obd == NULL || !obd->obd_attached || !obd->obd_set_up)
 515                         continue;
 516
 517                 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
 518                 if (obd->obd_stopping)
 519                         continue;
 520
 521                 class_incref(obd, __func__, current);
 522                 read_unlock(&obd_dev_lock);
 523
 524                 if (obd_health_check(NULL, obd)) {
 525                         seq_printf(m, "device %s reported unhealthy\n",
 526                                    obd->obd_name);
 527                 }
 528                 class_decref(obd, __func__, current);
 529                 read_lock(&obd_dev_lock);
 530         }
 531         read_unlock(&obd_dev_lock);
 532
 533         return 0;
 534 }
 535
 536 LDEBUGFS_SEQ_FOPS_RO(health_check);
 537
 538 struct kset *lustre_kset;
 539 EXPORT_SYMBOL_GPL(lustre_kset);
 540
 541 static struct attribute_group lustre_attr_group = {
 542         .attrs = lustre_attrs,
 543 };
 544
 545 ssize_t class_set_global(const char *param)
 546 {
 547         const char *value = strchr(param, '=') + 1;
 548         size_t off = value - param - 1;
 549         ssize_t count = -ENOENT;
 550         int i;
 551
 552         for (i = 0; lustre_attrs[i]; i++) {
 553                 if (!strncmp(lustre_attrs[i]->name, param, off)) {
 554                         count = lustre_attr_store(&lustre_kset->kobj,
 555                                                   lustre_attrs[i], value,
 556                                                   strlen(value));
 557                         break;
 558                 }
 559         }
 560         return count;
 561 }
 562
 563 int class_procfs_init(void)
 564 {
 565         struct proc_dir_entry *entry;
 566         struct dentry *file;
 567         int rc = -ENOMEM;
 568
 569         ENTRY;
 570
 571         lustre_kset = kset_create_and_add("lustre", NULL, fs_kobj);
 572         if (!lustre_kset)
 573                 goto out;
 574
 575         /* Create the files associated with this kobject */
 576         rc = sysfs_create_group(&lustre_kset->kobj, &lustre_attr_group);
 577         if (rc) {
 578                 kset_unregister(lustre_kset);
 579                 goto out;
 580         }
 581
 582         rc = jobid_cache_init();
 583         if (rc) {
 584                 kset_unregister(lustre_kset);
 585                 goto out;
 586         }
 587
 588         debugfs_lustre_root = debugfs_create_dir("lustre", NULL);
 589
 590         file = debugfs_create_file("devices", 0444, debugfs_lustre_root, NULL,
 591                                    &obd_device_list_fops);
 592
 593         file = debugfs_create_file("health_check", 0444, debugfs_lustre_root,
 594                                    NULL, &health_check_fops);
 595
 596         entry = lprocfs_register("fs/lustre", NULL, NULL, NULL);
 597         if (IS_ERR(entry)) {
 598                 rc = PTR_ERR(entry);
 599                 CERROR("cannot create '/proc/fs/lustre': rc = %d\n", rc);
 600                 debugfs_remove_recursive(debugfs_lustre_root);
 601                 kset_unregister(lustre_kset);
 602                 goto out;
 603         }
 604
 605         proc_lustre_root = entry;
 606 out:
 607         RETURN(rc);
 608 }
 609
 610 int class_procfs_clean(void)
 611 {
 612         ENTRY;
 613
 614         debugfs_remove_recursive(debugfs_lustre_root);
 615
 616         debugfs_lustre_root = NULL;
 617         jobid_cache_fini();
 618
 619         if (proc_lustre_root)
 620                 lprocfs_remove(&proc_lustre_root);
 621
 622         sysfs_remove_group(&lustre_kset->kobj, &lustre_attr_group);
 623
 624         kset_unregister(lustre_kset);
 625
 626         RETURN(0);
 627 }