libcfs/libcfs/linux/linux-proc.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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, Whamcloud, Inc.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * libcfs/libcfs/linux/linux-proc.c
  37  *
  38  * Author: Zach Brown <zab@zabbo.net>
  39  * Author: Peter J. Braam <braam@clusterfs.com>
  40  * Author: Phil Schwan <phil@clusterfs.com>
  41  */
  42
  43 #include <linux/module.h>
  44 #include <linux/kernel.h>
  45 #include <linux/mm.h>
  46 #include <linux/string.h>
  47 #include <linux/stat.h>
  48 #include <linux/errno.h>
  49 #include <linux/unistd.h>
  50 #include <net/sock.h>
  51 #include <linux/uio.h>
  52
  53 #include <asm/system.h>
  54 #include <asm/uaccess.h>
  55
  56 #include <linux/fs.h>
  57 #include <linux/file.h>
  58 #include <linux/stat.h>
  59 #include <linux/list.h>
  60 #include <asm/uaccess.h>
  61
  62 #include <linux/proc_fs.h>
  63 #include <linux/sysctl.h>
  64
  65 # define DEBUG_SUBSYSTEM S_LNET
  66
  67 #include <libcfs/libcfs.h>
  68 #include <asm/div64.h>
  69 #include "tracefile.h"
  70
  71 #ifdef CONFIG_SYSCTL
  72 static cfs_sysctl_table_header_t *lnet_table_header = NULL;
  73 #endif
  74 extern char lnet_upcall[1024];
  75 /**
  76  * The path of debug log dump upcall script.
  77  */
  78 extern char lnet_debug_log_upcall[1024];
  79
  80 #ifndef HAVE_SYSCTL_UNNUMBERED
  81 #define CTL_LNET        (0x100)
  82 enum {
  83         PSDEV_DEBUG = 1,          /* control debugging */
  84         PSDEV_SUBSYSTEM_DEBUG,    /* control debugging */
  85         PSDEV_PRINTK,             /* force all messages to console */
  86         PSDEV_CONSOLE_RATELIMIT,  /* ratelimit console messages */
  87         PSDEV_CONSOLE_MAX_DELAY_CS, /* maximum delay over which we skip messages */
  88         PSDEV_CONSOLE_MIN_DELAY_CS, /* initial delay over which we skip messages */
  89         PSDEV_CONSOLE_BACKOFF,    /* delay increase factor */
  90         PSDEV_DEBUG_PATH,         /* crashdump log location */
  91         PSDEV_DEBUG_DUMP_PATH,    /* crashdump tracelog location */
  92         PSDEV_CPT_TABLE,          /* information about cpu partitions */
  93         PSDEV_LNET_UPCALL,        /* User mode upcall script  */
  94         PSDEV_LNET_MEMUSED,       /* bytes currently PORTAL_ALLOCated */
  95         PSDEV_LNET_CATASTROPHE,   /* if we have LBUGged or panic'd */
  96         PSDEV_LNET_PANIC_ON_LBUG, /* flag to panic on LBUG */
  97         PSDEV_LNET_DUMP_KERNEL,   /* snapshot kernel debug buffer to file */
  98         PSDEV_LNET_DAEMON_FILE,   /* spool kernel debug buffer to file */
  99         PSDEV_LNET_DEBUG_MB,      /* size of debug buffer */
 100         PSDEV_LNET_DEBUG_LOG_UPCALL, /* debug log upcall script */
 101         PSDEV_LNET_WATCHDOG_RATELIMIT,  /* ratelimit watchdog messages  */
 102         PSDEV_LNET_FORCE_LBUG,    /* hook to force an LBUG */
 103         PSDEV_LNET_FAIL_LOC,      /* control test failures instrumentation */
 104         PSDEV_LNET_FAIL_VAL,      /* userdata for fail loc */
 105 };
 106 #else
 107 #define CTL_LNET                        CTL_UNNUMBERED
 108 #define PSDEV_DEBUG                     CTL_UNNUMBERED
 109 #define PSDEV_SUBSYSTEM_DEBUG           CTL_UNNUMBERED
 110 #define PSDEV_PRINTK                    CTL_UNNUMBERED
 111 #define PSDEV_CONSOLE_RATELIMIT         CTL_UNNUMBERED
 112 #define PSDEV_CONSOLE_MAX_DELAY_CS      CTL_UNNUMBERED
 113 #define PSDEV_CONSOLE_MIN_DELAY_CS      CTL_UNNUMBERED
 114 #define PSDEV_CONSOLE_BACKOFF           CTL_UNNUMBERED
 115 #define PSDEV_DEBUG_PATH                CTL_UNNUMBERED
 116 #define PSDEV_DEBUG_DUMP_PATH           CTL_UNNUMBERED
 117 #define PSDEV_CPT_TABLE                 CTL_UNNUMBERED
 118 #define PSDEV_LNET_UPCALL               CTL_UNNUMBERED
 119 #define PSDEV_LNET_MEMUSED              CTL_UNNUMBERED
 120 #define PSDEV_LNET_CATASTROPHE          CTL_UNNUMBERED
 121 #define PSDEV_LNET_PANIC_ON_LBUG        CTL_UNNUMBERED
 122 #define PSDEV_LNET_DUMP_KERNEL          CTL_UNNUMBERED
 123 #define PSDEV_LNET_DAEMON_FILE          CTL_UNNUMBERED
 124 #define PSDEV_LNET_DEBUG_MB             CTL_UNNUMBERED
 125 #define PSDEV_LNET_DEBUG_LOG_UPCALL     CTL_UNNUMBERED
 126 #define PSDEV_LNET_WATCHDOG_RATELIMIT   CTL_UNNUMBERED
 127 #define PSDEV_LNET_FORCE_LBUG           CTL_UNNUMBERED
 128 #define PSDEV_LNET_FAIL_LOC             CTL_UNNUMBERED
 129 #define PSDEV_LNET_FAIL_VAL             CTL_UNNUMBERED
 130 #endif
 131
 132 int
 133 proc_call_handler(void *data, int write,
 134                   loff_t *ppos, void *buffer, size_t *lenp,
 135                   int (*handler)(void *data, int write,
 136                                  loff_t pos, void *buffer, int len))
 137 {
 138         int rc = handler(data, write, *ppos, buffer, *lenp);
 139
 140         if (rc < 0)
 141                 return rc;
 142
 143         if (write) {
 144                 *ppos += *lenp;
 145         } else {
 146                 *lenp = rc;
 147                 *ppos += rc;
 148         }
 149         return 0;
 150 }
 151 EXPORT_SYMBOL(proc_call_handler);
 152
 153 static int __proc_dobitmasks(void *data, int write,
 154                              loff_t pos, void *buffer, int nob)
 155 {
 156         const int     tmpstrlen = 512;
 157         char         *tmpstr;
 158         int           rc;
 159         unsigned int *mask = data;
 160         int           is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
 161         int           is_printk = (mask == &libcfs_printk) ? 1 : 0;
 162
 163         rc = cfs_trace_allocate_string_buffer(&tmpstr, tmpstrlen);
 164         if (rc < 0)
 165                 return rc;
 166
 167         if (!write) {
 168                 libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
 169                 rc = strlen(tmpstr);
 170
 171                 if (pos >= rc) {
 172                         rc = 0;
 173                 } else {
 174                         rc = cfs_trace_copyout_string(buffer, nob,
 175                                                       tmpstr + pos, "\n");
 176                 }
 177         } else {
 178                 rc = cfs_trace_copyin_string(tmpstr, tmpstrlen, buffer, nob);
 179                 if (rc < 0)
 180                         return rc;
 181
 182                 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
 183                 /* Always print LBUG/LASSERT to console, so keep this mask */
 184                 if (is_printk)
 185                         *mask |= D_EMERG;
 186         }
 187
 188         cfs_trace_free_string_buffer(tmpstr, tmpstrlen);
 189         return rc;
 190 }
 191
 192 DECLARE_PROC_HANDLER(proc_dobitmasks)
 193
 194 static int min_watchdog_ratelimit = 0;          /* disable ratelimiting */
 195 static int max_watchdog_ratelimit = (24*60*60); /* limit to once per day */
 196
 197 static int __proc_dump_kernel(void *data, int write,
 198                               loff_t pos, void *buffer, int nob)
 199 {
 200         if (!write)
 201                 return 0;
 202
 203         return cfs_trace_dump_debug_buffer_usrstr(buffer, nob);
 204 }
 205
 206 DECLARE_PROC_HANDLER(proc_dump_kernel)
 207
 208 static int __proc_daemon_file(void *data, int write,
 209                               loff_t pos, void *buffer, int nob)
 210 {
 211         if (!write) {
 212                 int len = strlen(cfs_tracefile);
 213
 214                 if (pos >= len)
 215                         return 0;
 216
 217                 return cfs_trace_copyout_string(buffer, nob,
 218                                                 cfs_tracefile + pos, "\n");
 219         }
 220
 221         return cfs_trace_daemon_command_usrstr(buffer, nob);
 222 }
 223
 224 DECLARE_PROC_HANDLER(proc_daemon_file)
 225
 226 static int __proc_debug_mb(void *data, int write,
 227                            loff_t pos, void *buffer, int nob)
 228 {
 229         if (!write) {
 230                 char tmpstr[32];
 231                 int  len = snprintf(tmpstr, sizeof(tmpstr), "%d",
 232                                     cfs_trace_get_debug_mb());
 233
 234                 if (pos >= len)
 235                         return 0;
 236
 237                 return cfs_trace_copyout_string(buffer, nob, tmpstr + pos,
 238                        "\n");
 239         }
 240
 241         return cfs_trace_set_debug_mb_usrstr(buffer, nob);
 242 }
 243
 244 DECLARE_PROC_HANDLER(proc_debug_mb)
 245
 246 int LL_PROC_PROTO(proc_console_max_delay_cs)
 247 {
 248         int rc, max_delay_cs;
 249         cfs_sysctl_table_t dummy = *table;
 250         cfs_duration_t d;
 251
 252         dummy.data = &max_delay_cs;
 253         dummy.proc_handler = &proc_dointvec;
 254
 255         if (!write) { /* read */
 256                 max_delay_cs = cfs_duration_sec(libcfs_console_max_delay * 100);
 257                 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
 258                 return rc;
 259         }
 260
 261         /* write */
 262         max_delay_cs = 0;
 263         rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
 264         if (rc < 0)
 265                 return rc;
 266         if (max_delay_cs <= 0)
 267                 return -EINVAL;
 268
 269         d = cfs_time_seconds(max_delay_cs) / 100;
 270         if (d == 0 || d < libcfs_console_min_delay)
 271                 return -EINVAL;
 272         libcfs_console_max_delay = d;
 273
 274         return rc;
 275 }
 276
 277 int LL_PROC_PROTO(proc_console_min_delay_cs)
 278 {
 279         int rc, min_delay_cs;
 280         cfs_sysctl_table_t dummy = *table;
 281         cfs_duration_t d;
 282
 283         dummy.data = &min_delay_cs;
 284         dummy.proc_handler = &proc_dointvec;
 285
 286         if (!write) { /* read */
 287                 min_delay_cs = cfs_duration_sec(libcfs_console_min_delay * 100);
 288                 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
 289                 return rc;
 290         }
 291
 292         /* write */
 293         min_delay_cs = 0;
 294         rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
 295         if (rc < 0)
 296                 return rc;
 297         if (min_delay_cs <= 0)
 298                 return -EINVAL;
 299
 300         d = cfs_time_seconds(min_delay_cs) / 100;
 301         if (d == 0 || d > libcfs_console_max_delay)
 302                 return -EINVAL;
 303         libcfs_console_min_delay = d;
 304
 305         return rc;
 306 }
 307
 308 int LL_PROC_PROTO(proc_console_backoff)
 309 {
 310         int rc, backoff;
 311         cfs_sysctl_table_t dummy = *table;
 312
 313         dummy.data = &backoff;
 314         dummy.proc_handler = &proc_dointvec;
 315
 316         if (!write) { /* read */
 317                 backoff= libcfs_console_backoff;
 318                 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
 319                 return rc;
 320         }
 321
 322         /* write */
 323         backoff = 0;
 324         rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
 325         if (rc < 0)
 326                 return rc;
 327         if (backoff <= 0)
 328                 return -EINVAL;
 329
 330         libcfs_console_backoff = backoff;
 331
 332         return rc;
 333 }
 334
 335 int LL_PROC_PROTO(libcfs_force_lbug)
 336 {
 337         if (write)
 338                 LBUG();
 339         return 0;
 340 }
 341
 342 int LL_PROC_PROTO(proc_fail_loc)
 343 {
 344         int rc;
 345         long old_fail_loc = cfs_fail_loc;
 346
 347         rc = ll_proc_dolongvec(table, write, filp, buffer, lenp, ppos);
 348         if (old_fail_loc != cfs_fail_loc)
 349                 cfs_waitq_signal(&cfs_race_waitq);
 350         return rc;
 351 }
 352
 353 static int __proc_cpt_table(void *data, int write,
 354                             loff_t pos, void *buffer, int nob)
 355 {
 356         char *buf = NULL;
 357         int   len = 4096;
 358         int   rc  = 0;
 359
 360         if (write)
 361                 return -EPERM;
 362
 363         LASSERT(cfs_cpt_table != NULL);
 364
 365         while (1) {
 366                 LIBCFS_ALLOC(buf, len);
 367                 if (buf == NULL)
 368                         return -ENOMEM;
 369
 370                 rc = cfs_cpt_table_print(cfs_cpt_table, buf, len);
 371                 if (rc >= 0)
 372                         break;
 373
 374                 LIBCFS_FREE(buf, len);
 375                 if (rc == -EFBIG) {
 376                         len <<= 1;
 377                         continue;
 378                 }
 379                 goto out;
 380         }
 381
 382         if (pos >= rc) {
 383                 rc = 0;
 384                 goto out;
 385         }
 386
 387         rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
 388  out:
 389         if (buf != NULL)
 390                 LIBCFS_FREE(buf, len);
 391         return rc;
 392 }
 393 DECLARE_PROC_HANDLER(proc_cpt_table)
 394
 395 static cfs_sysctl_table_t lnet_table[] = {
 396         /*
 397          * NB No .strategy entries have been provided since sysctl(8) prefers
 398          * to go via /proc for portability.
 399          */
 400         {
 401                 INIT_CTL_NAME(PSDEV_DEBUG)
 402                 .procname = "debug",
 403                 .data     = &libcfs_debug,
 404                 .maxlen   = sizeof(int),
 405                 .mode     = 0644,
 406                 .proc_handler = &proc_dobitmasks,
 407         },
 408         {
 409                 INIT_CTL_NAME(PSDEV_SUBSYSTEM_DEBUG)
 410                 .procname = "subsystem_debug",
 411                 .data     = &libcfs_subsystem_debug,
 412                 .maxlen   = sizeof(int),
 413                 .mode     = 0644,
 414                 .proc_handler = &proc_dobitmasks,
 415         },
 416         {
 417                 INIT_CTL_NAME(PSDEV_PRINTK)
 418                 .procname = "printk",
 419                 .data     = &libcfs_printk,
 420                 .maxlen   = sizeof(int),
 421                 .mode     = 0644,
 422                 .proc_handler = &proc_dobitmasks,
 423         },
 424         {
 425                 INIT_CTL_NAME(PSDEV_CONSOLE_RATELIMIT)
 426                 .procname = "console_ratelimit",
 427                 .data     = &libcfs_console_ratelimit,
 428                 .maxlen   = sizeof(int),
 429                 .mode     = 0644,
 430                 .proc_handler = &proc_dointvec
 431         },
 432         {
 433                 INIT_CTL_NAME(PSDEV_CONSOLE_MAX_DELAY_CS)
 434                 .procname = "console_max_delay_centisecs",
 435                 .maxlen   = sizeof(int),
 436                 .mode     = 0644,
 437                 .proc_handler = &proc_console_max_delay_cs
 438         },
 439         {
 440                 INIT_CTL_NAME(PSDEV_CONSOLE_MIN_DELAY_CS)
 441                 .procname = "console_min_delay_centisecs",
 442                 .maxlen   = sizeof(int),
 443                 .mode     = 0644,
 444                 .proc_handler = &proc_console_min_delay_cs
 445         },
 446         {
 447                 INIT_CTL_NAME(PSDEV_CONSOLE_BACKOFF)
 448                 .procname = "console_backoff",
 449                 .maxlen   = sizeof(int),
 450                 .mode     = 0644,
 451                 .proc_handler = &proc_console_backoff
 452         },
 453
 454         {
 455                 INIT_CTL_NAME(PSDEV_DEBUG_PATH)
 456                 .procname = "debug_path",
 457                 .data     = libcfs_debug_file_path_arr,
 458                 .maxlen   = sizeof(libcfs_debug_file_path_arr),
 459                 .mode     = 0644,
 460                 .proc_handler = &proc_dostring,
 461         },
 462
 463         {
 464                 INIT_CTL_NAME(PSDEV_CPT_TABLE)
 465                 .procname = "cpu_partition_table",
 466                 .maxlen   = 128,
 467                 .mode     = 0444,
 468                 .proc_handler = &proc_cpt_table,
 469         },
 470
 471         {
 472                 INIT_CTL_NAME(PSDEV_LNET_UPCALL)
 473                 .procname = "upcall",
 474                 .data     = lnet_upcall,
 475                 .maxlen   = sizeof(lnet_upcall),
 476                 .mode     = 0644,
 477                 .proc_handler = &proc_dostring,
 478         },
 479         {
 480                 INIT_CTL_NAME(PSDEV_LNET_DEBUG_LOG_UPCALL)
 481                 .procname = "debug_log_upcall",
 482                 .data     = lnet_debug_log_upcall,
 483                 .maxlen   = sizeof(lnet_debug_log_upcall),
 484                 .mode     = 0644,
 485                 .proc_handler = &proc_dostring,
 486         },
 487         {
 488                 INIT_CTL_NAME(PSDEV_LNET_MEMUSED)
 489                 .procname = "lnet_memused",
 490                 .data     = (int *)&libcfs_kmemory.counter,
 491                 .maxlen   = sizeof(int),
 492                 .mode     = 0444,
 493                 .proc_handler = &proc_dointvec,
 494                 INIT_STRATEGY(&sysctl_intvec)
 495         },
 496         {
 497                 INIT_CTL_NAME(PSDEV_LNET_CATASTROPHE)
 498                 .procname = "catastrophe",
 499                 .data     = &libcfs_catastrophe,
 500                 .maxlen   = sizeof(int),
 501                 .mode     = 0444,
 502                 .proc_handler = &proc_dointvec,
 503                 INIT_STRATEGY(&sysctl_intvec)
 504         },
 505         {
 506                 INIT_CTL_NAME(PSDEV_LNET_PANIC_ON_LBUG)
 507                 .procname = "panic_on_lbug",
 508                 .data     = &libcfs_panic_on_lbug,
 509                 .maxlen   = sizeof(int),
 510                 .mode     = 0644,
 511                 .proc_handler = &proc_dointvec,
 512                 INIT_STRATEGY(&sysctl_intvec)
 513         },
 514         {
 515                 INIT_CTL_NAME(PSDEV_LNET_DUMP_KERNEL)
 516                 .procname = "dump_kernel",
 517                 .maxlen   = 256,
 518                 .mode     = 0200,
 519                 .proc_handler = &proc_dump_kernel,
 520         },
 521         {
 522                 INIT_CTL_NAME(PSDEV_LNET_DAEMON_FILE)
 523                 .procname = "daemon_file",
 524                 .mode     = 0644,
 525                 .maxlen   = 256,
 526                 .proc_handler = &proc_daemon_file,
 527         },
 528         {
 529                 INIT_CTL_NAME(PSDEV_LNET_DEBUG_MB)
 530                 .procname = "debug_mb",
 531                 .mode     = 0644,
 532                 .proc_handler = &proc_debug_mb,
 533         },
 534         {
 535                 INIT_CTL_NAME(PSDEV_LNET_WATCHDOG_RATELIMIT)
 536                 .procname = "watchdog_ratelimit",
 537                 .data     = &libcfs_watchdog_ratelimit,
 538                 .maxlen   = sizeof(int),
 539                 .mode     = 0644,
 540                 .proc_handler = &proc_dointvec_minmax,
 541                 .extra1   = &min_watchdog_ratelimit,
 542                 .extra2   = &max_watchdog_ratelimit,
 543         },
 544         {       INIT_CTL_NAME(PSDEV_LNET_FORCE_LBUG)
 545                 .procname = "force_lbug",
 546                 .data     = NULL,
 547                 .maxlen   = 0,
 548                 .mode     = 0200,
 549                 .proc_handler = &libcfs_force_lbug
 550         },
 551         {
 552                 INIT_CTL_NAME(PSDEV_LNET_FAIL_LOC)
 553                 .procname = "fail_loc",
 554                 .data     = &cfs_fail_loc,
 555                 .maxlen   = sizeof(cfs_fail_loc),
 556                 .mode     = 0644,
 557                 .proc_handler = &proc_fail_loc
 558         },
 559         {
 560                 INIT_CTL_NAME(PSDEV_LNET_FAIL_VAL)
 561                 .procname = "fail_val",
 562                 .data     = &cfs_fail_val,
 563                 .maxlen   = sizeof(int),
 564                 .mode     = 0644,
 565                 .proc_handler = &proc_dointvec
 566         },
 567         {
 568                 INIT_CTL_NAME(0)
 569         }
 570 };
 571
 572 #ifdef CONFIG_SYSCTL
 573 static cfs_sysctl_table_t top_table[] = {
 574         {
 575                 INIT_CTL_NAME(CTL_LNET)
 576                 .procname = "lnet",
 577                 .mode     = 0555,
 578                 .data     = NULL,
 579                 .maxlen   = 0,
 580                 .child    = lnet_table,
 581         },
 582         {
 583                 INIT_CTL_NAME(0)
 584         }
 585 };
 586
 587 int insert_proc(void)
 588 {
 589         if (lnet_table_header == NULL)
 590                 lnet_table_header = cfs_register_sysctl_table(top_table, 0);
 591 #endif
 592         return 0;
 593 }
 594
 595 void remove_proc(void)
 596 {
 597 #ifdef CONFIG_SYSCTL
 598         if (lnet_table_header != NULL)
 599                 cfs_unregister_sysctl_table(lnet_table_header);
 600
 601         lnet_table_header = NULL;
 602 #endif
 603 }