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