libcfs/libcfs/linux/linux-proc.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  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 #ifndef EXPORT_SYMTAB
  44 # define EXPORT_SYMTAB
  45 #endif
  46
  47 #ifndef AUTOCONF_INCLUDED
  48 #include <linux/config.h>
  49 #endif
  50 #include <linux/module.h>
  51 #include <linux/kernel.h>
  52 #include <linux/mm.h>
  53 #include <linux/string.h>
  54 #include <linux/stat.h>
  55 #include <linux/errno.h>
  56 #include <linux/smp_lock.h>
  57 #include <linux/unistd.h>
  58 #include <net/sock.h>
  59 #include <linux/uio.h>
  60
  61 #include <asm/system.h>
  62 #include <asm/uaccess.h>
  63
  64 #include <linux/fs.h>
  65 #include <linux/file.h>
  66 #include <linux/stat.h>
  67 #include <linux/list.h>
  68 #include <asm/uaccess.h>
  69
  70 #include <linux/proc_fs.h>
  71 #include <linux/sysctl.h>
  72
  73 # define DEBUG_SUBSYSTEM S_LNET
  74
  75 #include <libcfs/libcfs.h>
  76 #include <asm/div64.h>
  77 #include "tracefile.h"
  78
  79 #ifdef CONFIG_SYSCTL
  80 static cfs_sysctl_table_header_t *lnet_table_header = NULL;
  81 #endif
  82 extern char lnet_upcall[1024];
  83 /**
  84  * The path of debug log dump upcall script.
  85  */
  86 extern char lnet_debug_log_upcall[1024];
  87
  88 #ifndef HAVE_SYSCTL_UNNUMBERED
  89 #define CTL_LNET        (0x100)
  90 enum {
  91         PSDEV_DEBUG = 1,          /* control debugging */
  92         PSDEV_SUBSYSTEM_DEBUG,    /* control debugging */
  93         PSDEV_PRINTK,             /* force all messages to console */
  94         PSDEV_CONSOLE_RATELIMIT,  /* ratelimit console messages */
  95         PSDEV_CONSOLE_MAX_DELAY_CS, /* maximum delay over which we skip messages */
  96         PSDEV_CONSOLE_MIN_DELAY_CS, /* initial delay over which we skip messages */
  97         PSDEV_CONSOLE_BACKOFF,    /* delay increase factor */
  98         PSDEV_DEBUG_PATH,         /* crashdump log location */
  99         PSDEV_DEBUG_DUMP_PATH,    /* crashdump tracelog location */
 100         PSDEV_LNET_UPCALL,        /* User mode upcall script  */
 101         PSDEV_LNET_MEMUSED,       /* bytes currently PORTAL_ALLOCated */
 102         PSDEV_LNET_CATASTROPHE,   /* if we have LBUGged or panic'd */
 103         PSDEV_LNET_PANIC_ON_LBUG, /* flag to panic on LBUG */
 104         PSDEV_LNET_DUMP_KERNEL,   /* snapshot kernel debug buffer to file */
 105         PSDEV_LNET_DAEMON_FILE,   /* spool kernel debug buffer to file */
 106         PSDEV_LNET_DEBUG_MB,      /* size of debug buffer */
 107         PSDEV_LNET_DEBUG_LOG_UPCALL, /* debug log upcall script */
 108         PSDEV_LNET_WATCHDOG_RATELIMIT,  /* ratelimit watchdog messages  */
 109         PSDEV_LNET_FORCE_LBUG,    /* hook to force an LBUG */
 110 };
 111 #else
 112 #define CTL_LNET                        CTL_UNNUMBERED
 113 #define PSDEV_DEBUG                     CTL_UNNUMBERED
 114 #define PSDEV_SUBSYSTEM_DEBUG           CTL_UNNUMBERED
 115 #define PSDEV_PRINTK                    CTL_UNNUMBERED
 116 #define PSDEV_CONSOLE_RATELIMIT         CTL_UNNUMBERED
 117 #define PSDEV_CONSOLE_MAX_DELAY_CS      CTL_UNNUMBERED
 118 #define PSDEV_CONSOLE_MIN_DELAY_CS      CTL_UNNUMBERED
 119 #define PSDEV_CONSOLE_BACKOFF           CTL_UNNUMBERED
 120 #define PSDEV_DEBUG_PATH                CTL_UNNUMBERED
 121 #define PSDEV_DEBUG_DUMP_PATH           CTL_UNNUMBERED
 122 #define PSDEV_LNET_UPCALL               CTL_UNNUMBERED
 123 #define PSDEV_LNET_MEMUSED              CTL_UNNUMBERED
 124 #define PSDEV_LNET_CATASTROPHE          CTL_UNNUMBERED
 125 #define PSDEV_LNET_PANIC_ON_LBUG        CTL_UNNUMBERED
 126 #define PSDEV_LNET_DUMP_KERNEL          CTL_UNNUMBERED
 127 #define PSDEV_LNET_DAEMON_FILE          CTL_UNNUMBERED
 128 #define PSDEV_LNET_DEBUG_MB             CTL_UNNUMBERED
 129 #define PSDEV_LNET_DEBUG_LOG_UPCALL     CTL_UNNUMBERED
 130 #define PSDEV_LNET_WATCHDOG_RATELIMIT   CTL_UNNUMBERED
 131 #define PSDEV_LNET_FORCE_LBUG           CTL_UNNUMBERED
 132 #endif
 133
 134
 135 int
 136 proc_call_handler(void *data, int write,
 137                   loff_t *ppos, void *buffer, size_t *lenp,
 138                   int (*handler)(void *data, int write,
 139                                  loff_t pos, void *buffer, int len))
 140 {
 141         int rc = handler(data, write, *ppos, buffer, *lenp);
 142
 143         if (rc < 0)
 144                 return rc;
 145
 146         if (write) {
 147                 *ppos += *lenp;
 148         } else {
 149                 *lenp = rc;
 150                 *ppos += rc;
 151         }
 152         return 0;
 153 }
 154 EXPORT_SYMBOL(proc_call_handler);
 155
 156 static int __proc_dobitmasks(void *data, int write,
 157                              loff_t pos, void *buffer, int nob)
 158 {
 159         const int     tmpstrlen = 512;
 160         char         *tmpstr;
 161         int           rc;
 162         unsigned int *mask = data;
 163         int           is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
 164         int           is_printk = (mask == &libcfs_printk) ? 1 : 0;
 165
 166         rc = cfs_trace_allocate_string_buffer(&tmpstr, tmpstrlen);
 167         if (rc < 0)
 168                 return rc;
 169
 170         if (!write) {
 171                 libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
 172                 rc = strlen(tmpstr);
 173
 174                 if (pos >= rc) {
 175                         rc = 0;
 176                 } else {
 177                         rc = cfs_trace_copyout_string(buffer, nob,
 178                                                       tmpstr + pos, "\n");
 179                 }
 180         } else {
 181                 rc = cfs_trace_copyin_string(tmpstr, tmpstrlen, buffer, nob);
 182                 if (rc < 0)
 183                         return rc;
 184
 185                 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
 186                 /* Always print LBUG/LASSERT to console, so keep this mask */
 187                 if (is_printk)
 188                         *mask |= D_EMERG;
 189         }
 190
 191         cfs_trace_free_string_buffer(tmpstr, tmpstrlen);
 192         return rc;
 193 }
 194
 195 DECLARE_PROC_HANDLER(proc_dobitmasks)
 196
 197 static int min_watchdog_ratelimit = 0;          /* disable ratelimiting */
 198 static int max_watchdog_ratelimit = (24*60*60); /* limit to once per day */
 199
 200 static int __proc_dump_kernel(void *data, int write,
 201                               loff_t pos, void *buffer, int nob)
 202 {
 203         if (!write)
 204                 return 0;
 205
 206         return cfs_trace_dump_debug_buffer_usrstr(buffer, nob);
 207 }
 208
 209 DECLARE_PROC_HANDLER(proc_dump_kernel)
 210
 211 static int __proc_daemon_file(void *data, int write,
 212                               loff_t pos, void *buffer, int nob)
 213 {
 214         if (!write) {
 215                 int len = strlen(cfs_tracefile);
 216
 217                 if (pos >= len)
 218                         return 0;
 219
 220                 return cfs_trace_copyout_string(buffer, nob,
 221                                                 cfs_tracefile + pos, "\n");
 222         }
 223
 224         return cfs_trace_daemon_command_usrstr(buffer, nob);
 225 }
 226
 227 DECLARE_PROC_HANDLER(proc_daemon_file)
 228
 229 static int __proc_debug_mb(void *data, int write,
 230                            loff_t pos, void *buffer, int nob)
 231 {
 232         if (!write) {
 233                 char tmpstr[32];
 234                 int  len = snprintf(tmpstr, sizeof(tmpstr), "%d",
 235                                     cfs_trace_get_debug_mb());
 236
 237                 if (pos >= len)
 238                         return 0;
 239
 240                 return cfs_trace_copyout_string(buffer, nob, tmpstr + pos,
 241                        "\n");
 242         }
 243
 244         return cfs_trace_set_debug_mb_usrstr(buffer, nob);
 245 }
 246
 247 DECLARE_PROC_HANDLER(proc_debug_mb)
 248
 249 int LL_PROC_PROTO(proc_console_max_delay_cs)
 250 {
 251         int rc, max_delay_cs;
 252         cfs_sysctl_table_t dummy = *table;
 253         cfs_duration_t d;
 254
 255         dummy.data = &max_delay_cs;
 256         dummy.proc_handler = &proc_dointvec;
 257
 258         if (!write) { /* read */
 259                 max_delay_cs = cfs_duration_sec(libcfs_console_max_delay * 100);
 260                 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
 261                 return rc;
 262         }
 263
 264         /* write */
 265         max_delay_cs = 0;
 266         rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
 267         if (rc < 0)
 268                 return rc;
 269         if (max_delay_cs <= 0)
 270                 return -EINVAL;
 271
 272         d = cfs_time_seconds(max_delay_cs) / 100;
 273         if (d == 0 || d < libcfs_console_min_delay)
 274                 return -EINVAL;
 275         libcfs_console_max_delay = d;
 276
 277         return rc;
 278 }
 279
 280 int LL_PROC_PROTO(proc_console_min_delay_cs)
 281 {
 282         int rc, min_delay_cs;
 283         cfs_sysctl_table_t dummy = *table;
 284         cfs_duration_t d;
 285
 286         dummy.data = &min_delay_cs;
 287         dummy.proc_handler = &proc_dointvec;
 288
 289         if (!write) { /* read */
 290                 min_delay_cs = cfs_duration_sec(libcfs_console_min_delay * 100);
 291                 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
 292                 return rc;
 293         }
 294
 295         /* write */
 296         min_delay_cs = 0;
 297         rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
 298         if (rc < 0)
 299                 return rc;
 300         if (min_delay_cs <= 0)
 301                 return -EINVAL;
 302
 303         d = cfs_time_seconds(min_delay_cs) / 100;
 304         if (d == 0 || d > libcfs_console_max_delay)
 305                 return -EINVAL;
 306         libcfs_console_min_delay = d;
 307
 308         return rc;
 309 }
 310
 311 int LL_PROC_PROTO(proc_console_backoff)
 312 {
 313         int rc, backoff;
 314         cfs_sysctl_table_t dummy = *table;
 315
 316         dummy.data = &backoff;
 317         dummy.proc_handler = &proc_dointvec;
 318
 319         if (!write) { /* read */
 320                 backoff= libcfs_console_backoff;
 321                 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
 322                 return rc;
 323         }
 324
 325         /* write */
 326         backoff = 0;
 327         rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
 328         if (rc < 0)
 329                 return rc;
 330         if (backoff <= 0)
 331                 return -EINVAL;
 332
 333         libcfs_console_backoff = backoff;
 334
 335         return rc;
 336 }
 337
 338 int LL_PROC_PROTO(libcfs_force_lbug)
 339 {
 340         if (write)
 341                 LBUG();
 342         return 0;
 343 }
 344
 345 static cfs_sysctl_table_t lnet_table[] = {
 346         /*
 347          * NB No .strategy entries have been provided since sysctl(8) prefers
 348          * to go via /proc for portability.
 349          */
 350         {
 351                 .ctl_name = PSDEV_DEBUG,
 352                 .procname = "debug",
 353                 .data     = &libcfs_debug,
 354                 .maxlen   = sizeof(int),
 355                 .mode     = 0644,
 356                 .proc_handler = &proc_dobitmasks,
 357         },
 358         {
 359                 .ctl_name = PSDEV_SUBSYSTEM_DEBUG,
 360                 .procname = "subsystem_debug",
 361                 .data     = &libcfs_subsystem_debug,
 362                 .maxlen   = sizeof(int),
 363                 .mode     = 0644,
 364                 .proc_handler = &proc_dobitmasks,
 365         },
 366         {
 367                 .ctl_name = PSDEV_PRINTK,
 368                 .procname = "printk",
 369                 .data     = &libcfs_printk,
 370                 .maxlen   = sizeof(int),
 371                 .mode     = 0644,
 372                 .proc_handler = &proc_dobitmasks,
 373         },
 374         {
 375                 .ctl_name = PSDEV_CONSOLE_RATELIMIT,
 376                 .procname = "console_ratelimit",
 377                 .data     = &libcfs_console_ratelimit,
 378                 .maxlen   = sizeof(int),
 379                 .mode     = 0644,
 380                 .proc_handler = &proc_dointvec
 381         },
 382         {
 383                 .ctl_name = PSDEV_CONSOLE_MAX_DELAY_CS,
 384                 .procname = "console_max_delay_centisecs",
 385                 .maxlen   = sizeof(int),
 386                 .mode     = 0644,
 387                 .proc_handler = &proc_console_max_delay_cs
 388         },
 389         {
 390                 .ctl_name = PSDEV_CONSOLE_MIN_DELAY_CS,
 391                 .procname = "console_min_delay_centisecs",
 392                 .maxlen   = sizeof(int),
 393                 .mode     = 0644,
 394                 .proc_handler = &proc_console_min_delay_cs
 395         },
 396         {
 397                 .ctl_name = PSDEV_CONSOLE_BACKOFF,
 398                 .procname = "console_backoff",
 399                 .maxlen   = sizeof(int),
 400                 .mode     = 0644,
 401                 .proc_handler = &proc_console_backoff
 402         },
 403
 404         {
 405                 .ctl_name = PSDEV_DEBUG_PATH,
 406                 .procname = "debug_path",
 407                 .data     = libcfs_debug_file_path_arr,
 408                 .maxlen   = sizeof(libcfs_debug_file_path_arr),
 409                 .mode     = 0644,
 410                 .proc_handler = &proc_dostring,
 411         },
 412
 413         {
 414                 .ctl_name = PSDEV_LNET_UPCALL,
 415                 .procname = "upcall",
 416                 .data     = lnet_upcall,
 417                 .maxlen   = sizeof(lnet_upcall),
 418                 .mode     = 0644,
 419                 .proc_handler = &proc_dostring,
 420         },
 421         {
 422                 .ctl_name = PSDEV_LNET_DEBUG_LOG_UPCALL,
 423                 .procname = "debug_log_upcall",
 424                 .data     = lnet_debug_log_upcall,
 425                 .maxlen   = sizeof(lnet_debug_log_upcall),
 426                 .mode     = 0644,
 427                 .proc_handler = &proc_dostring,
 428         },
 429         {
 430                 .ctl_name = PSDEV_LNET_MEMUSED,
 431                 .procname = "lnet_memused",
 432                 .data     = (int *)&libcfs_kmemory.counter,
 433                 .maxlen   = sizeof(int),
 434                 .mode     = 0444,
 435                 .proc_handler = &proc_dointvec,
 436                 .strategy = &sysctl_intvec,
 437         },
 438         {
 439                 .ctl_name = PSDEV_LNET_CATASTROPHE,
 440                 .procname = "catastrophe",
 441                 .data     = &libcfs_catastrophe,
 442                 .maxlen   = sizeof(int),
 443                 .mode     = 0444,
 444                 .proc_handler = &proc_dointvec,
 445                 .strategy = &sysctl_intvec,
 446         },
 447         {
 448                 .ctl_name = PSDEV_LNET_PANIC_ON_LBUG,
 449                 .procname = "panic_on_lbug",
 450                 .data     = &libcfs_panic_on_lbug,
 451                 .maxlen   = sizeof(int),
 452                 .mode     = 0644,
 453                 .proc_handler = &proc_dointvec,
 454                 .strategy = &sysctl_intvec,
 455         },
 456         {
 457                 .ctl_name = PSDEV_LNET_DUMP_KERNEL,
 458                 .procname = "dump_kernel",
 459                 .maxlen   = 256,
 460                 .mode     = 0200,
 461                 .proc_handler = &proc_dump_kernel,
 462         },
 463         {
 464                 .ctl_name = PSDEV_LNET_DAEMON_FILE,
 465                 .procname = "daemon_file",
 466                 .mode     = 0644,
 467                 .maxlen   = 256,
 468                 .proc_handler = &proc_daemon_file,
 469         },
 470         {
 471                 .ctl_name = PSDEV_LNET_DEBUG_MB,
 472                 .procname = "debug_mb",
 473                 .mode     = 0644,
 474                 .proc_handler = &proc_debug_mb,
 475         },
 476         {
 477                 .ctl_name = PSDEV_LNET_WATCHDOG_RATELIMIT,
 478                 .procname = "watchdog_ratelimit",
 479                 .data     = &libcfs_watchdog_ratelimit,
 480                 .maxlen   = sizeof(int),
 481                 .mode     = 0644,
 482                 .proc_handler = &proc_dointvec_minmax,
 483                 .extra1   = &min_watchdog_ratelimit,
 484                 .extra2   = &max_watchdog_ratelimit,
 485         },
 486         {       .ctl_name = PSDEV_LNET_FORCE_LBUG,
 487                 .procname = "force_lbug",
 488                 .data     = NULL,
 489                 .maxlen   = 0,
 490                 .mode     = 0200,
 491                 .proc_handler = &libcfs_force_lbug
 492         },
 493         {0}
 494 };
 495
 496 #ifdef CONFIG_SYSCTL
 497 static cfs_sysctl_table_t top_table[] = {
 498         {
 499                 .ctl_name = CTL_LNET,
 500                 .procname = "lnet",
 501                 .mode     = 0555,
 502                 .data     = NULL,
 503                 .maxlen   = 0,
 504                 .child    = lnet_table,
 505         },
 506         {
 507                 .ctl_name = 0
 508         }
 509 };
 510
 511 int insert_proc(void)
 512 {
 513         if (lnet_table_header == NULL)
 514                 lnet_table_header = cfs_register_sysctl_table(top_table, 0);
 515 #endif
 516         return 0;
 517 }
 518
 519 void remove_proc(void)
 520 {
 521 #ifdef CONFIG_SYSCTL
 522         if (lnet_table_header != NULL)
 523                 cfs_unregister_sysctl_table(lnet_table_header);
 524
 525         lnet_table_header = NULL;
 526 #endif
 527 }