libcfs/libcfs/module.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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 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 #include <linux/miscdevice.h>
  33 #include <linux/module.h>
  34 #include <linux/kernel.h>
  35 #include <linux/mm.h>
  36 #include <linux/string.h>
  37 #include <linux/stat.h>
  38 #include <linux/errno.h>
  39 #include <linux/unistd.h>
  40 #include <net/sock.h>
  41 #include <linux/uio.h>
  42 #include <linux/uaccess.h>
  43
  44 #include <linux/fs.h>
  45 #include <linux/file.h>
  46 #include <linux/list.h>
  47
  48 #include <linux/sysctl.h>
  49 #include <linux/debugfs.h>
  50 #include <asm/div64.h>
  51
  52 #define DEBUG_SUBSYSTEM S_LNET
  53
  54 #include <libcfs/libcfs.h>
  55 #include <libcfs/libcfs_crypto.h>
  56 #include <lnet/lib-lnet.h>
  57 #include <libcfs/crypto/llcrypt.h>
  58 #include "tracefile.h"
  59
  60 static struct dentry *lnet_debugfs_root;
  61
  62 BLOCKING_NOTIFIER_HEAD(libcfs_ioctl_list);
  63 EXPORT_SYMBOL(libcfs_ioctl_list);
  64
  65 static inline size_t libcfs_ioctl_packlen(struct libcfs_ioctl_data *data)
  66 {
  67         size_t len = sizeof(*data);
  68
  69         len += (data->ioc_inllen1 + 7) & ~7;
  70         len += (data->ioc_inllen2 + 7) & ~7;
  71         return len;
  72 }
  73
  74 static bool libcfs_ioctl_is_invalid(struct libcfs_ioctl_data *data)
  75 {
  76         const int maxlen = 1 << 30;
  77         if (data->ioc_hdr.ioc_len > maxlen)
  78                 return true;
  79
  80         if (data->ioc_inllen1 > maxlen)
  81                 return true;
  82
  83         if (data->ioc_inllen2 > maxlen)
  84                 return true;
  85
  86         if (data->ioc_inlbuf1 && !data->ioc_inllen1)
  87                 return true;
  88
  89         if (data->ioc_inlbuf2 && !data->ioc_inllen2)
  90                 return true;
  91
  92         if (data->ioc_pbuf1 && !data->ioc_plen1)
  93                 return true;
  94
  95         if (data->ioc_pbuf2 && !data->ioc_plen2)
  96                 return true;
  97
  98         if (data->ioc_plen1 && !data->ioc_pbuf1)
  99                 return true;
 100
 101         if (data->ioc_plen2 && !data->ioc_pbuf2)
 102                 return true;
 103
 104         if (libcfs_ioctl_packlen(data) != data->ioc_hdr.ioc_len)
 105                 return true;
 106
 107         if (data->ioc_inllen1 &&
 108                 data->ioc_bulk[((data->ioc_inllen1 + 7) & ~7) +
 109                                data->ioc_inllen2 - 1] != '\0')
 110                 return true;
 111
 112         return false;
 113 }
 114
 115 int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data)
 116 {
 117         ENTRY;
 118
 119         if (libcfs_ioctl_is_invalid(data)) {
 120                 CERROR("libcfs ioctl: parameter not correctly formatted\n");
 121                 RETURN(-EINVAL);
 122         }
 123
 124         if (data->ioc_inllen1 != 0)
 125                 data->ioc_inlbuf1 = &data->ioc_bulk[0];
 126
 127         if (data->ioc_inllen2 != 0)
 128                 data->ioc_inlbuf2 = &data->ioc_bulk[0] +
 129                                     cfs_size_round(data->ioc_inllen1);
 130
 131         RETURN(0);
 132 }
 133
 134 int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
 135                          struct libcfs_ioctl_hdr __user *uhdr)
 136 {
 137         struct libcfs_ioctl_hdr hdr;
 138         int err;
 139
 140         ENTRY;
 141         if (copy_from_user(&hdr, uhdr, sizeof(hdr)))
 142                 RETURN(-EFAULT);
 143
 144         if (hdr.ioc_version != LIBCFS_IOCTL_VERSION &&
 145             hdr.ioc_version != LIBCFS_IOCTL_VERSION2) {
 146                 CERROR("libcfs ioctl: version mismatch expected %#x, got %#x\n",
 147                        LIBCFS_IOCTL_VERSION, hdr.ioc_version);
 148                 RETURN(-EINVAL);
 149         }
 150
 151         if (hdr.ioc_len < sizeof(struct libcfs_ioctl_hdr)) {
 152                 CERROR("libcfs ioctl: user buffer too small for ioctl\n");
 153                 RETURN(-EINVAL);
 154         }
 155
 156         if (hdr.ioc_len > LIBCFS_IOC_DATA_MAX) {
 157                 CERROR("libcfs ioctl: user buffer is too large %d/%d\n",
 158                        hdr.ioc_len, LIBCFS_IOC_DATA_MAX);
 159                 RETURN(-EINVAL);
 160         }
 161
 162         LIBCFS_ALLOC(*hdr_pp, hdr.ioc_len);
 163         if (*hdr_pp == NULL)
 164                 RETURN(-ENOMEM);
 165
 166         if (copy_from_user(*hdr_pp, uhdr, hdr.ioc_len))
 167                 GOTO(free, err = -EFAULT);
 168
 169         if ((*hdr_pp)->ioc_version != hdr.ioc_version ||
 170                 (*hdr_pp)->ioc_len != hdr.ioc_len) {
 171                 GOTO(free, err = -EINVAL);
 172         }
 173
 174         RETURN(0);
 175
 176 free:
 177         LIBCFS_FREE(*hdr_pp, hdr.ioc_len);
 178         RETURN(err);
 179 }
 180
 181 static int libcfs_ioctl(unsigned long cmd, void __user *uparam)
 182 {
 183         struct libcfs_ioctl_data *data = NULL;
 184         struct libcfs_ioctl_hdr  *hdr;
 185         int                       err;
 186         ENTRY;
 187
 188         /* 'cmd' and permissions get checked in our arch-specific caller */
 189         err = libcfs_ioctl_getdata(&hdr, uparam);
 190         if (err != 0) {
 191                 CDEBUG_LIMIT(D_ERROR,
 192                              "libcfs ioctl: data header error %d\n", err);
 193                 RETURN(err);
 194         }
 195
 196         if (hdr->ioc_version == LIBCFS_IOCTL_VERSION) {
 197                 /* The libcfs_ioctl_data_adjust() function performs adjustment
 198                  * operations on the libcfs_ioctl_data structure to make
 199                  * it usable by the code.  This doesn't need to be called
 200                  * for new data structures added. */
 201                 data = container_of(hdr, struct libcfs_ioctl_data, ioc_hdr);
 202                 err = libcfs_ioctl_data_adjust(data);
 203                 if (err != 0)
 204                         GOTO(out, err);
 205         }
 206
 207         CDEBUG(D_IOCTL, "libcfs ioctl cmd %lu\n", cmd);
 208         switch (cmd) {
 209         case IOC_LIBCFS_CLEAR_DEBUG:
 210                 libcfs_debug_clear_buffer();
 211                 break;
 212         case IOC_LIBCFS_MARK_DEBUG:
 213                 if (data == NULL ||
 214                     data->ioc_inlbuf1 == NULL ||
 215                     data->ioc_inlbuf1[data->ioc_inllen1 - 1] != '\0')
 216                         GOTO(out, err = -EINVAL);
 217
 218                 libcfs_debug_mark_buffer(data->ioc_inlbuf1);
 219                 break;
 220
 221         default:
 222                 err = blocking_notifier_call_chain(&libcfs_ioctl_list,
 223                                                    cmd, hdr);
 224                 if (!(err & NOTIFY_STOP_MASK))
 225                         /* No-one claimed the ioctl */
 226                         err = -EINVAL;
 227                 else
 228                         err = notifier_to_errno(err);
 229                 if (copy_to_user(uparam, hdr, hdr->ioc_len) && !err)
 230                         err = -EFAULT;
 231                 break;
 232         }
 233 out:
 234         LIBCFS_FREE(hdr, hdr->ioc_len);
 235         RETURN(err);
 236 }
 237
 238 static long
 239 libcfs_psdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 240 {
 241         if (!capable(CAP_SYS_ADMIN))
 242                 return -EACCES;
 243
 244         if (_IOC_TYPE(cmd) != IOC_LIBCFS_TYPE ||
 245             _IOC_NR(cmd) < IOC_LIBCFS_MIN_NR  ||
 246             _IOC_NR(cmd) > IOC_LIBCFS_MAX_NR) {
 247                 CDEBUG(D_IOCTL, "invalid ioctl ( type %d, nr %d, size %d )\n",
 248                        _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd));
 249                 return -EINVAL;
 250         }
 251
 252         return libcfs_ioctl(cmd, (void __user *)arg);
 253 }
 254
 255 static const struct file_operations libcfs_fops = {
 256         .owner                  = THIS_MODULE,
 257         .unlocked_ioctl         = libcfs_psdev_ioctl,
 258 };
 259
 260 static struct miscdevice libcfs_dev = {
 261         .minor                  = MISC_DYNAMIC_MINOR,
 262         .name                   = "lnet",
 263         .fops                   = &libcfs_fops,
 264 };
 265
 266 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
 267                          void __user *buffer, size_t *lenp,
 268                          int (*handler)(void *data, int write, loff_t pos,
 269                                         void __user *buffer, int len))
 270 {
 271         int rc = handler(data, write, *ppos, buffer, *lenp);
 272
 273         if (rc < 0)
 274                 return rc;
 275
 276         if (write) {
 277                 *ppos += *lenp;
 278         } else {
 279                 *lenp = rc;
 280                 *ppos += rc;
 281         }
 282         return 0;
 283 }
 284 EXPORT_SYMBOL(lprocfs_call_handler);
 285
 286 static int __proc_dobitmasks(void *data, int write,
 287                              loff_t pos, void __user *buffer, int nob)
 288 {
 289         const int     tmpstrlen = 512;
 290         char         *tmpstr;
 291         int           rc;
 292         unsigned int *mask = data;
 293         int           is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
 294         int           is_printk = (mask == &libcfs_printk) ? 1 : 0;
 295
 296         rc = cfs_trace_allocate_string_buffer(&tmpstr, tmpstrlen);
 297         if (rc < 0)
 298                 return rc;
 299
 300         if (!write) {
 301                 libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
 302                 rc = strlen(tmpstr);
 303
 304                 if (pos >= rc) {
 305                         rc = 0;
 306                 } else {
 307                         rc = cfs_trace_copyout_string(buffer, nob,
 308                                                       tmpstr + pos, "\n");
 309                 }
 310         } else {
 311                 rc = cfs_trace_copyin_string(tmpstr, tmpstrlen, buffer, nob);
 312                 if (rc < 0) {
 313                         kfree(tmpstr);
 314                         return rc;
 315                 }
 316
 317                 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
 318                 /* Always print LBUG/LASSERT to console, so keep this mask */
 319                 if (is_printk)
 320                         *mask |= D_EMERG;
 321         }
 322
 323         kfree(tmpstr);
 324         return rc;
 325 }
 326
 327 static int proc_dobitmasks(struct ctl_table *table, int write,
 328                            void __user *buffer, size_t *lenp, loff_t *ppos)
 329 {
 330         return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
 331                                     __proc_dobitmasks);
 332 }
 333
 334 static int min_watchdog_ratelimit;              /* disable ratelimiting */
 335 static int max_watchdog_ratelimit = (24*60*60); /* limit to once per day */
 336
 337 static int __proc_dump_kernel(void *data, int write,
 338                               loff_t pos, void __user *buffer, int nob)
 339 {
 340         if (!write)
 341                 return 0;
 342
 343         return cfs_trace_dump_debug_buffer_usrstr(buffer, nob);
 344 }
 345
 346 static int proc_dump_kernel(struct ctl_table *table, int write,
 347                             void __user *buffer, size_t *lenp, loff_t *ppos)
 348 {
 349         return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
 350                                     __proc_dump_kernel);
 351 }
 352
 353 static int __proc_daemon_file(void *data, int write,
 354                               loff_t pos, void __user *buffer, int nob)
 355 {
 356         if (!write) {
 357                 int len = strlen(cfs_tracefile);
 358
 359                 if (pos >= len)
 360                         return 0;
 361
 362                 return cfs_trace_copyout_string(buffer, nob,
 363                                                 cfs_tracefile + pos, "\n");
 364         }
 365
 366         return cfs_trace_daemon_command_usrstr(buffer, nob);
 367 }
 368
 369 static int proc_daemon_file(struct ctl_table *table, int write,
 370                             void __user *buffer, size_t *lenp, loff_t *ppos)
 371 {
 372         return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
 373                                     __proc_daemon_file);
 374 }
 375
 376 static int libcfs_force_lbug(struct ctl_table *table, int write,
 377                              void __user *buffer,
 378                              size_t *lenp, loff_t *ppos)
 379 {
 380         if (write)
 381                 LBUG();
 382         return 0;
 383 }
 384
 385 static int proc_fail_loc(struct ctl_table *table, int write,
 386                          void __user *buffer, size_t *lenp, loff_t *ppos)
 387 {
 388         int rc;
 389         long old_fail_loc = cfs_fail_loc;
 390
 391         if (!*lenp || *ppos) {
 392                 *lenp = 0;
 393                 return 0;
 394         }
 395
 396         if (write) {
 397                 char *kbuf = memdup_user_nul(buffer, *lenp);
 398
 399                 if (IS_ERR(kbuf))
 400                         return PTR_ERR(kbuf);
 401                 rc = kstrtoul(kbuf, 0, &cfs_fail_loc);
 402                 kfree(kbuf);
 403                 *ppos += *lenp;
 404         } else {
 405                 char kbuf[64/3+3];
 406
 407                 rc = scnprintf(kbuf, sizeof(kbuf), "%lu\n", cfs_fail_loc);
 408                 if (copy_to_user(buffer, kbuf, rc))
 409                         rc = -EFAULT;
 410                 else {
 411                         *lenp = rc;
 412                         *ppos += rc;
 413                 }
 414         }
 415
 416         if (old_fail_loc != cfs_fail_loc) {
 417                 cfs_race_state = 1;
 418                 wake_up(&cfs_race_waitq);
 419         }
 420         return rc;
 421 }
 422
 423 int debugfs_doint(struct ctl_table *table, int write,
 424                   void __user *buffer, size_t *lenp, loff_t *ppos)
 425 {
 426         int rc;
 427
 428         if (!*lenp || *ppos) {
 429                 *lenp = 0;
 430                 return 0;
 431         }
 432
 433         if (write) {
 434                 char *kbuf = memdup_user_nul(buffer, *lenp);
 435                 int val;
 436
 437                 if (IS_ERR(kbuf))
 438                         return PTR_ERR(kbuf);
 439
 440                 rc = kstrtoint(kbuf, 0, &val);
 441                 kfree(kbuf);
 442                 if (!rc) {
 443                         if (table->extra1 && val < *(int *)table->extra1)
 444                                 val = *(int *)table->extra1;
 445                         if (table->extra2 && val > *(int *)table->extra2)
 446                                 val = *(int *)table->extra2;
 447                         *(int *)table->data = val;
 448                 }
 449                 *ppos += *lenp;
 450         } else {
 451                 char kbuf[64/3+3];
 452
 453                 rc = scnprintf(kbuf, sizeof(kbuf), "%u\n", *(int *)table->data);
 454                 if (copy_to_user(buffer, kbuf, rc))
 455                         rc = -EFAULT;
 456                 else {
 457                         *lenp = rc;
 458                         *ppos += rc;
 459                 }
 460         }
 461
 462         return rc;
 463 }
 464 EXPORT_SYMBOL(debugfs_doint);
 465
 466 static int debugfs_dou64(struct ctl_table *table, int write,
 467                          void __user *buffer, size_t *lenp, loff_t *ppos)
 468 {
 469         int rc;
 470
 471         if (!*lenp || *ppos) {
 472                 *lenp = 0;
 473                 return 0;
 474         }
 475
 476         if (write) {
 477                 char *kbuf = memdup_user_nul(buffer, *lenp);
 478                 unsigned long long val;
 479
 480                 if (IS_ERR(kbuf))
 481                         return PTR_ERR(kbuf);
 482
 483                 rc = kstrtoull(kbuf, 0, &val);
 484                 kfree(kbuf);
 485                 if (!rc)
 486                         *(u64 *)table->data = val;
 487                 *ppos += *lenp;
 488         } else {
 489                 char kbuf[64/3+3];
 490
 491                 rc = scnprintf(kbuf, sizeof(kbuf), "%llu\n",
 492                                (unsigned long long)*(u64 *)table->data);
 493                 if (copy_to_user(buffer, kbuf, rc))
 494                         rc = -EFAULT;
 495                 else {
 496                         *lenp = rc;
 497                         *ppos += rc;
 498                 }
 499         }
 500
 501         return rc;
 502 }
 503
 504 static int debugfs_dostring(struct ctl_table *table, int write,
 505                             void __user *buffer, size_t *lenp, loff_t *ppos)
 506 {
 507         int len = *lenp;
 508         char *kbuf = table->data;
 509
 510         if (!len || *ppos) {
 511                 *lenp = 0;
 512                 return 0;
 513         }
 514         if (len > table->maxlen)
 515                 len = table->maxlen;
 516         if (write) {
 517                 if (copy_from_user(kbuf, buffer, len))
 518                         return -EFAULT;
 519                 memset(kbuf+len, 0, table->maxlen - len);
 520                 *ppos = *lenp;
 521         } else {
 522                 len = strnlen(kbuf, len);
 523                 if (copy_to_user(buffer, kbuf, len))
 524                         return -EFAULT;
 525                 if (len < *lenp) {
 526                         if (copy_to_user(buffer+len, "\n", 1))
 527                                 return -EFAULT;
 528                         len += 1;
 529                 }
 530                 *ppos += len;
 531                 *lenp -= len;
 532         }
 533         return len;
 534 }
 535
 536 static int __proc_cpt_table(void *data, int write,
 537                             loff_t pos, void __user *buffer, int nob)
 538 {
 539         char *buf = NULL;
 540         int   len = 4096;
 541         int   rc  = 0;
 542
 543         if (write)
 544                 return -EPERM;
 545
 546         while (1) {
 547                 LIBCFS_ALLOC(buf, len);
 548                 if (buf == NULL)
 549                         return -ENOMEM;
 550
 551                 rc = cfs_cpt_table_print(cfs_cpt_tab, buf, len);
 552                 if (rc >= 0)
 553                         break;
 554
 555                 if (rc == -EFBIG) {
 556                         LIBCFS_FREE(buf, len);
 557                         len <<= 1;
 558                         continue;
 559                 }
 560                 goto out;
 561         }
 562
 563         if (pos >= rc) {
 564                 rc = 0;
 565                 goto out;
 566         }
 567
 568         rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
 569 out:
 570         if (buf != NULL)
 571                 LIBCFS_FREE(buf, len);
 572         return rc;
 573 }
 574
 575 static int proc_cpt_table(struct ctl_table *table, int write,
 576                           void __user *buffer, size_t *lenp, loff_t *ppos)
 577 {
 578         return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
 579                                     __proc_cpt_table);
 580 }
 581
 582 static int __proc_cpt_distance(void *data, int write,
 583                                loff_t pos, void __user *buffer, int nob)
 584 {
 585         char *buf = NULL;
 586         int   len = 4096;
 587         int   rc  = 0;
 588
 589         if (write)
 590                 return -EPERM;
 591
 592         while (1) {
 593                 LIBCFS_ALLOC(buf, len);
 594                 if (buf == NULL)
 595                         return -ENOMEM;
 596
 597                 rc = cfs_cpt_distance_print(cfs_cpt_tab, buf, len);
 598                 if (rc >= 0)
 599                         break;
 600
 601                 if (rc == -EFBIG) {
 602                         LIBCFS_FREE(buf, len);
 603                         len <<= 1;
 604                         continue;
 605                 }
 606                 goto out;
 607         }
 608
 609         if (pos >= rc) {
 610                 rc = 0;
 611                 goto out;
 612         }
 613
 614         rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
 615  out:
 616         if (buf != NULL)
 617                 LIBCFS_FREE(buf, len);
 618         return rc;
 619 }
 620
 621 static int proc_cpt_distance(struct ctl_table *table, int write,
 622                              void __user *buffer, size_t *lenp, loff_t *ppos)
 623 {
 624         return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
 625                                      __proc_cpt_distance);
 626 }
 627
 628 static struct ctl_table lnet_table[] = {
 629         {
 630                 .procname       = "debug",
 631                 .data           = &libcfs_debug,
 632                 .maxlen         = sizeof(int),
 633                 .mode           = 0644,
 634                 .proc_handler   = &proc_dobitmasks,
 635         },
 636         {
 637                 .procname       = "subsystem_debug",
 638                 .data           = &libcfs_subsystem_debug,
 639                 .maxlen         = sizeof(int),
 640                 .mode           = 0644,
 641                 .proc_handler   = &proc_dobitmasks,
 642         },
 643         {
 644                 .procname       = "printk",
 645                 .data           = &libcfs_printk,
 646                 .maxlen         = sizeof(int),
 647                 .mode           = 0644,
 648                 .proc_handler   = &proc_dobitmasks,
 649         },
 650         {
 651                 .procname       = "cpu_partition_table",
 652                 .maxlen         = 128,
 653                 .mode           = 0444,
 654                 .proc_handler   = &proc_cpt_table,
 655         },
 656         {
 657                 .procname       = "cpu_partition_distance",
 658                 .maxlen         = 128,
 659                 .mode           = 0444,
 660                 .proc_handler   = &proc_cpt_distance,
 661         },
 662         {
 663                 .procname       = "debug_log_upcall",
 664                 .data           = lnet_debug_log_upcall,
 665                 .maxlen         = sizeof(lnet_debug_log_upcall),
 666                 .mode           = 0644,
 667                 .proc_handler   = &debugfs_dostring,
 668         },
 669         {
 670                 .procname       = "lnet_memused",
 671                 .data           = (u64 *)&libcfs_kmem.counter,
 672                 .maxlen         = sizeof(u64),
 673                 .mode           = 0444,
 674                 .proc_handler   = &debugfs_dou64,
 675         },
 676         {
 677                 .procname       = "catastrophe",
 678                 .data           = &libcfs_catastrophe,
 679                 .maxlen         = sizeof(int),
 680                 .mode           = 0444,
 681                 .proc_handler   = &debugfs_doint,
 682         },
 683         {
 684                 .procname       = "dump_kernel",
 685                 .maxlen         = 256,
 686                 .mode           = 0200,
 687                 .proc_handler   = &proc_dump_kernel,
 688         },
 689         {
 690                 .procname       = "daemon_file",
 691                 .mode           = 0644,
 692                 .maxlen         = 256,
 693                 .proc_handler   = &proc_daemon_file,
 694         },
 695         {
 696                 .procname       = "watchdog_ratelimit",
 697                 .data           = &libcfs_watchdog_ratelimit,
 698                 .maxlen         = sizeof(int),
 699                 .mode           = 0644,
 700                 .proc_handler   = &debugfs_doint,
 701                 .extra1         = &min_watchdog_ratelimit,
 702                 .extra2         = &max_watchdog_ratelimit,
 703         },
 704         {
 705                 .procname       = "force_lbug",
 706                 .data           = NULL,
 707                 .maxlen         = 0,
 708                 .mode           = 0200,
 709                 .proc_handler   = &libcfs_force_lbug
 710         },
 711         {
 712                 .procname       = "fail_loc",
 713                 .data           = &cfs_fail_loc,
 714                 .maxlen         = sizeof(cfs_fail_loc),
 715                 .mode           = 0644,
 716                 .proc_handler   = &proc_fail_loc
 717         },
 718         {
 719                 .procname       = "fail_val",
 720                 .data           = &cfs_fail_val,
 721                 .maxlen         = sizeof(int),
 722                 .mode           = 0644,
 723                 .proc_handler   = &debugfs_doint
 724         },
 725         {
 726                 .procname       = "fail_err",
 727                 .data           = &cfs_fail_err,
 728                 .maxlen         = sizeof(cfs_fail_err),
 729                 .mode           = 0644,
 730                 .proc_handler   = &debugfs_doint,
 731         },
 732         {
 733         }
 734 };
 735
 736 static const struct lnet_debugfs_symlink_def lnet_debugfs_symlinks[] = {
 737         { .name         = "console_ratelimit",
 738           .target       = "../../../module/libcfs/parameters/libcfs_console_ratelimit" },
 739         { .name         = "debug_path",
 740           .target       = "../../../module/libcfs/parameters/libcfs_debug_file_path" },
 741         { .name         = "panic_on_lbug",
 742           .target       = "../../../module/libcfs/parameters/libcfs_panic_on_lbug" },
 743         { .name         = "console_backoff",
 744           .target       = "../../../module/libcfs/parameters/libcfs_console_backoff" },
 745         { .name         = "debug_mb",
 746           .target       = "../../../module/libcfs/parameters/libcfs_debug_mb" },
 747         { .name         = "console_min_delay_centisecs",
 748           .target       = "../../../module/libcfs/parameters/libcfs_console_min_delay" },
 749         { .name         = "console_max_delay_centisecs",
 750           .target       = "../../../module/libcfs/parameters/libcfs_console_max_delay" },
 751         { .name         = NULL },
 752 };
 753
 754 static ssize_t lnet_debugfs_read(struct file *filp, char __user *buf,
 755                                  size_t count, loff_t *ppos)
 756 {
 757         struct ctl_table *table = filp->private_data;
 758         ssize_t rc = -EINVAL;
 759
 760         if (table) {
 761                 rc = table->proc_handler(table, 0, buf, &count, ppos);
 762                 if (!rc)
 763                         rc = count;
 764         }
 765
 766         return rc;
 767 }
 768
 769 static ssize_t lnet_debugfs_write(struct file *filp, const char __user *buf,
 770                                   size_t count, loff_t *ppos)
 771 {
 772         struct ctl_table *table = filp->private_data;
 773         ssize_t rc = -EINVAL;
 774
 775         if (table) {
 776                 rc = table->proc_handler(table, 1, (void __user *)buf, &count,
 777                                          ppos);
 778                 if (!rc)
 779                         rc = count;
 780         }
 781
 782         return rc;
 783 }
 784
 785 static const struct file_operations lnet_debugfs_file_operations_rw = {
 786         .open           = simple_open,
 787         .read           = lnet_debugfs_read,
 788         .write          = lnet_debugfs_write,
 789         .llseek         = default_llseek,
 790 };
 791
 792 static const struct file_operations lnet_debugfs_file_operations_ro = {
 793         .open           = simple_open,
 794         .read           = lnet_debugfs_read,
 795         .llseek         = default_llseek,
 796 };
 797
 798 static const struct file_operations lnet_debugfs_file_operations_wo = {
 799         .open           = simple_open,
 800         .write          = lnet_debugfs_write,
 801         .llseek         = default_llseek,
 802 };
 803
 804 static const struct file_operations *lnet_debugfs_fops_select(umode_t mode)
 805 {
 806         if (!(mode & S_IWUGO))
 807                 return &lnet_debugfs_file_operations_ro;
 808
 809         if (!(mode & S_IRUGO))
 810                 return &lnet_debugfs_file_operations_wo;
 811
 812         return &lnet_debugfs_file_operations_rw;
 813 }
 814
 815 void lnet_insert_debugfs(struct ctl_table *table)
 816 {
 817         if (!lnet_debugfs_root)
 818                 lnet_debugfs_root = debugfs_create_dir("lnet", NULL);
 819
 820         /* Even if we cannot create, just ignore it altogether) */
 821         if (IS_ERR_OR_NULL(lnet_debugfs_root))
 822                 return;
 823
 824         /* We don't save the dentry returned in next two calls, because
 825          * we don't call debugfs_remove() but rather remove_recursive()
 826          */
 827         for (; table && table->procname; table++)
 828                 debugfs_create_file(table->procname, table->mode,
 829                                     lnet_debugfs_root, table,
 830                                     lnet_debugfs_fops_select(table->mode));
 831 }
 832 EXPORT_SYMBOL_GPL(lnet_insert_debugfs);
 833
 834 static void lnet_insert_debugfs_links(
 835                 const struct lnet_debugfs_symlink_def *symlinks)
 836 {
 837         for (; symlinks && symlinks->name; symlinks++)
 838                 debugfs_create_symlink(symlinks->name, lnet_debugfs_root,
 839                                        symlinks->target);
 840 }
 841
 842 void lnet_remove_debugfs(struct ctl_table *table)
 843 {
 844         for (; table && table->procname; table++) {
 845                 struct qstr dname = QSTR_INIT(table->procname,
 846                                               strlen(table->procname));
 847                 struct dentry *dentry;
 848
 849                 dentry = d_hash_and_lookup(lnet_debugfs_root, &dname);
 850                 debugfs_remove(dentry);
 851         }
 852 }
 853 EXPORT_SYMBOL_GPL(lnet_remove_debugfs);
 854
 855 static int __init libcfs_init(void)
 856 {
 857         int rc;
 858
 859         cfs_arch_init();
 860
 861         init_libcfs_vfree_atomic();
 862
 863         rc = libcfs_debug_init(5 * 1024 * 1024);
 864         if (rc < 0) {
 865                 pr_err("LustreError: libcfs_debug_init: rc = %d\n", rc);
 866                 return (rc);
 867         }
 868
 869         cfs_debug_init();
 870
 871         rc = cfs_cpu_init();
 872         if (rc != 0)
 873                 goto cleanup_debug;
 874
 875         rc = misc_register(&libcfs_dev);
 876         if (rc) {
 877                 CERROR("misc_register: error %d\n", rc);
 878                 goto cleanup_cpu;
 879         }
 880
 881         rc = cfs_wi_startup();
 882         if (rc) {
 883                 CERROR("initialize workitem: error %d\n", rc);
 884                 goto cleanup_deregister;
 885         }
 886
 887         cfs_rehash_wq = alloc_workqueue("cfs_rh", WQ_SYSFS, 4);
 888         if (!cfs_rehash_wq) {
 889                 rc = -ENOMEM;
 890                 CERROR("libcfs: failed to start rehash workqueue: rc = %d\n",
 891                        rc);
 892                 goto cleanup_deregister;
 893         }
 894
 895         rc = cfs_crypto_register();
 896         if (rc) {
 897                 CERROR("cfs_crypto_regster: error %d\n", rc);
 898                 goto cleanup_wi;
 899         }
 900
 901         lnet_insert_debugfs(lnet_table);
 902         if (!IS_ERR_OR_NULL(lnet_debugfs_root))
 903                 lnet_insert_debugfs_links(lnet_debugfs_symlinks);
 904
 905         rc = llcrypt_init();
 906         if (rc) {
 907                 CERROR("llcrypt_init: error %d\n", rc);
 908                 goto cleanup_wi;
 909         }
 910
 911         CDEBUG (D_OTHER, "portals setup OK\n");
 912         return 0;
 913 cleanup_wi:
 914         cfs_wi_shutdown();
 915 cleanup_deregister:
 916         misc_deregister(&libcfs_dev);
 917 cleanup_cpu:
 918         cfs_cpu_fini();
 919 cleanup_debug:
 920         libcfs_debug_cleanup();
 921         return rc;
 922 }
 923
 924 static void __exit libcfs_exit(void)
 925 {
 926         int rc;
 927
 928         /* Remove everthing */
 929         debugfs_remove_recursive(lnet_debugfs_root);
 930         lnet_debugfs_root = NULL;
 931
 932         CDEBUG(D_MALLOC, "before Portals cleanup: kmem %lld\n",
 933                libcfs_kmem_read());
 934
 935         llcrypt_exit();
 936
 937         if (cfs_rehash_wq) {
 938                 destroy_workqueue(cfs_rehash_wq);
 939                 cfs_rehash_wq = NULL;
 940         }
 941
 942         cfs_crypto_unregister();
 943         cfs_wi_shutdown();
 944
 945         misc_deregister(&libcfs_dev);
 946
 947         cfs_cpu_fini();
 948
 949         /* the below message is checked in test-framework.sh check_mem_leak() */
 950         if (libcfs_kmem_read() != 0)
 951                 CERROR("Portals memory leaked: %lld bytes\n",
 952                        libcfs_kmem_read());
 953
 954         rc = libcfs_debug_cleanup();
 955         if (rc)
 956                 pr_err("LustreError: libcfs_debug_cleanup: rc = %d\n", rc);
 957
 958         exit_libcfs_vfree_atomic();
 959 }
 960
 961 MODULE_AUTHOR("OpenSFS, Inc. <http://www.lustre.org/>");
 962 MODULE_DESCRIPTION("Lustre helper library");
 963 MODULE_VERSION(LIBCFS_VERSION);
 964 MODULE_LICENSE("GPL");
 965
 966 module_init(libcfs_init);
 967 module_exit(libcfs_exit);