libcfs/libcfs/debug.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 [sun.com URL with a
  20  * copy of GPLv2].
  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  2008 Sun Microsystems, Inc. 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/debug.c
  37  *
  38  * Author: Phil Schwan <phil@clusterfs.com>
  39  */
  40
  41 #ifndef EXPORT_SYMTAB
  42 # define EXPORT_SYMTAB
  43 #endif
  44
  45 # define DEBUG_SUBSYSTEM S_LNET
  46
  47 #include <stdarg.h>
  48 #include <libcfs/libcfs.h>
  49 #include "tracefile.h"
  50
  51 static char debug_file_name[1024];
  52
  53 #ifdef __KERNEL__
  54 unsigned int libcfs_subsystem_debug = ~0;
  55 CFS_MODULE_PARM(libcfs_subsystem_debug, "i", int, 0644,
  56                 "Lustre kernel debug subsystem mask");
  57 EXPORT_SYMBOL(libcfs_subsystem_debug);
  58
  59 unsigned int libcfs_debug = (D_EMERG | D_ERROR | D_WARNING | D_CONSOLE |
  60                              D_NETERROR | D_HA | D_CONFIG | D_IOCTL);
  61 CFS_MODULE_PARM(libcfs_debug, "i", int, 0644,
  62                 "Lustre kernel debug mask");
  63 EXPORT_SYMBOL(libcfs_debug);
  64
  65 int libcfs_debug_mb = -1;
  66 CFS_MODULE_PARM(libcfs_debug_mb, "i", int, 0644,
  67                 "Total debug buffer size.");
  68 EXPORT_SYMBOL(libcfs_debug_mb);
  69
  70 unsigned int libcfs_printk = D_CANTMASK;
  71 CFS_MODULE_PARM(libcfs_printk, "i", uint, 0644,
  72                 "Lustre kernel debug console mask");
  73 EXPORT_SYMBOL(libcfs_printk);
  74
  75 unsigned int libcfs_console_ratelimit = 1;
  76 CFS_MODULE_PARM(libcfs_console_ratelimit, "i", uint, 0644,
  77                 "Lustre kernel debug console ratelimit (0 to disable)");
  78 EXPORT_SYMBOL(libcfs_console_ratelimit);
  79
  80 cfs_duration_t libcfs_console_max_delay;
  81 CFS_MODULE_PARM(libcfs_console_max_delay, "l", ulong, 0644,
  82                 "Lustre kernel debug console max delay (jiffies)");
  83 EXPORT_SYMBOL(libcfs_console_max_delay);
  84
  85 cfs_duration_t libcfs_console_min_delay;
  86 CFS_MODULE_PARM(libcfs_console_min_delay, "l", ulong, 0644,
  87                 "Lustre kernel debug console min delay (jiffies)");
  88 EXPORT_SYMBOL(libcfs_console_min_delay);
  89
  90 unsigned int libcfs_console_backoff = CDEBUG_DEFAULT_BACKOFF;
  91 CFS_MODULE_PARM(libcfs_console_backoff, "i", uint, 0644,
  92                 "Lustre kernel debug console backoff factor");
  93 EXPORT_SYMBOL(libcfs_console_backoff);
  94
  95 unsigned int libcfs_debug_binary = 1;
  96 EXPORT_SYMBOL(libcfs_debug_binary);
  97
  98 unsigned int libcfs_stack;
  99 EXPORT_SYMBOL(libcfs_stack);
 100
 101 unsigned int portal_enter_debugger;
 102 EXPORT_SYMBOL(portal_enter_debugger);
 103
 104 unsigned int libcfs_catastrophe;
 105 EXPORT_SYMBOL(libcfs_catastrophe);
 106
 107 unsigned int libcfs_panic_on_lbug = 0;
 108 CFS_MODULE_PARM(libcfs_panic_on_lbug, "i", uint, 0644,
 109                 "Lustre kernel panic on LBUG");
 110 EXPORT_SYMBOL(libcfs_panic_on_lbug);
 111
 112 atomic_t libcfs_kmemory = ATOMIC_INIT(0);
 113 EXPORT_SYMBOL(libcfs_kmemory);
 114
 115 static cfs_waitq_t debug_ctlwq;
 116
 117 #ifdef __arch_um__
 118 char debug_file_path[1024] = "/r/tmp/lustre-log";
 119 #else
 120 char debug_file_path[1024] = "/tmp/lustre-log";
 121 #endif
 122 char *debug_file_path_p = &debug_file_path[0];
 123
 124 CFS_MODULE_PARM(debug_file_path_p, "s", charp, 0644,
 125                 "Path for dumping debug logs, "
 126                 "set 'NONE' to prevent log dumping");
 127
 128 int libcfs_panic_in_progress;
 129
 130 /* libcfs_debug_token2mask() expects the returned
 131  * string in lower-case */
 132 const char *
 133 libcfs_debug_subsys2str(int subsys)
 134 {
 135         switch (subsys) {
 136         default:
 137                 return NULL;
 138         case S_UNDEFINED:
 139                 return "undefined";
 140         case S_MDC:
 141                 return "mdc";
 142         case S_MDS:
 143                 return "mds";
 144         case S_OSC:
 145                 return "osc";
 146         case S_OST:
 147                 return "ost";
 148         case S_CLASS:
 149                 return "class";
 150         case S_LOG:
 151                 return "log";
 152         case S_LLITE:
 153                 return "llite";
 154         case S_RPC:
 155                 return "rpc";
 156         case S_LNET:
 157                 return "lnet";
 158         case S_LND:
 159                 return "lnd";
 160         case S_PINGER:
 161                 return "pinger";
 162         case S_FILTER:
 163                 return "filter";
 164         case S_ECHO:
 165                 return "echo";
 166         case S_LDLM:
 167                 return "ldlm";
 168         case S_LOV:
 169                 return "lov";
 170         case S_LMV:
 171                 return "lmv";
 172         case S_SEC:
 173                 return "sec";
 174         case S_GSS:
 175                 return "gss";
 176         case S_MGC:
 177                 return "mgc";
 178         case S_MGS:
 179                 return "mgs";
 180         case S_FID:
 181                 return "fid";
 182         case S_FLD:
 183                 return "fld";
 184         }
 185 }
 186
 187 /* libcfs_debug_token2mask() expects the returned
 188  * string in lower-case */
 189 const char *
 190 libcfs_debug_dbg2str(int debug)
 191 {
 192         switch (debug) {
 193         default:
 194                 return NULL;
 195         case D_TRACE:
 196                 return "trace";
 197         case D_INODE:
 198                 return "inode";
 199         case D_SUPER:
 200                 return "super";
 201         case D_EXT2:
 202                 return "ext2";
 203         case D_MALLOC:
 204                 return "malloc";
 205         case D_CACHE:
 206                 return "cache";
 207         case D_INFO:
 208                 return "info";
 209         case D_IOCTL:
 210                 return "ioctl";
 211         case D_NETERROR:
 212                 return "neterror";
 213         case D_NET:
 214                 return "net";
 215         case D_WARNING:
 216                 return "warning";
 217         case D_BUFFS:
 218                 return "buffs";
 219         case D_OTHER:
 220                 return "other";
 221         case D_DENTRY:
 222                 return "dentry";
 223         case D_NETTRACE:
 224                 return "nettrace";
 225         case D_PAGE:
 226                 return "page";
 227         case D_DLMTRACE:
 228                 return "dlmtrace";
 229         case D_ERROR:
 230                 return "error";
 231         case D_EMERG:
 232                 return "emerg";
 233         case D_HA:
 234                 return "ha";
 235         case D_RPCTRACE:
 236                 return "rpctrace";
 237         case D_VFSTRACE:
 238                 return "vfstrace";
 239         case D_READA:
 240                 return "reada";
 241         case D_MMAP:
 242                 return "mmap";
 243         case D_CONFIG:
 244                 return "config";
 245         case D_CONSOLE:
 246                 return "console";
 247         case D_QUOTA:
 248                 return "quota";
 249         case D_SEC:
 250                 return "sec";
 251         }
 252 }
 253
 254 int
 255 libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys)
 256 {
 257         const char *(*fn)(int bit) = is_subsys ? libcfs_debug_subsys2str :
 258                                                  libcfs_debug_dbg2str;
 259         int           len = 0;
 260         const char   *token;
 261         int           bit;
 262         int           i;
 263
 264         if (mask == 0) {                        /* "0" */
 265                 if (size > 0)
 266                         str[0] = '0';
 267                 len = 1;
 268         } else {                                /* space-separated tokens */
 269                 for (i = 0; i < 32; i++) {
 270                         bit = 1 << i;
 271
 272                         if ((mask & bit) == 0)
 273                                 continue;
 274
 275                         token = fn(bit);
 276                         if (token == NULL)              /* unused bit */
 277                                 continue;
 278
 279                         if (len > 0) {                  /* separator? */
 280                                 if (len < size)
 281                                         str[len] = ' ';
 282                                 len++;
 283                         }
 284
 285                         while (*token != 0) {
 286                                 if (len < size)
 287                                         str[len] = *token;
 288                                 token++;
 289                                 len++;
 290                         }
 291                 }
 292         }
 293
 294         /* terminate 'str' */
 295         if (len < size)
 296                 str[len] = 0;
 297         else
 298                 str[size - 1] = 0;
 299
 300         return len;
 301 }
 302
 303 int
 304 libcfs_debug_token2mask(int *mask, const char *str, int len, int is_subsys)
 305 {
 306         const char *(*fn)(int bit) = is_subsys ? libcfs_debug_subsys2str :
 307                                                  libcfs_debug_dbg2str;
 308         int           i;
 309         int           j;
 310         int           bit;
 311         const char   *token;
 312
 313         /* match against known tokens */
 314         for (i = 0; i < 32; i++) {
 315                 bit = 1 << i;
 316
 317                 token = fn(bit);
 318                 if (token == NULL)              /* unused? */
 319                         continue;
 320
 321                 /* strcasecmp */
 322                 for (j = 0; ; j++) {
 323                         if (j == len) {         /* end of token */
 324                                 if (token[j] == 0) {
 325                                         *mask = bit;
 326                                         return 0;
 327                                 }
 328                                 break;
 329                         }
 330
 331                         if (token[j] == 0)
 332                                 break;
 333
 334                         if (str[j] == token[j])
 335                                 continue;
 336
 337                         if (str[j] < 'A' || 'Z' < str[j])
 338                                 break;
 339
 340                         if (str[j] - 'A' + 'a' != token[j])
 341                                 break;
 342                 }
 343         }
 344
 345         return -EINVAL;                         /* no match */
 346 }
 347
 348 int
 349 libcfs_debug_str2mask(int *mask, const char *str, int is_subsys)
 350 {
 351         int         m = 0;
 352         char        op = 0;
 353         int         matched;
 354         int         n;
 355         int         t;
 356
 357         /* Allow a number for backwards compatibility */
 358
 359         for (n = strlen(str); n > 0; n--)
 360                 if (!isspace(str[n-1]))
 361                         break;
 362         matched = n;
 363
 364         if ((t = sscanf(str, "%i%n", &m, &matched)) >= 1 &&
 365             matched == n) {
 366                 *mask = m;
 367                 return 0;
 368         }
 369
 370         /* <str> must be a list of debug tokens or numbers separated by
 371          * whitespace and optionally an operator ('+' or '-').  If an operator
 372          * appears first in <str>, '*mask' is used as the starting point
 373          * (relative), otherwise 0 is used (absolute).  An operator applies to
 374          * all following tokens up to the next operator. */
 375
 376         matched = 0;
 377         while (*str != 0) {
 378                 while (isspace(*str)) /* skip whitespace */
 379                         str++;
 380
 381                 if (*str == 0)
 382                         break;
 383
 384                 if (*str == '+' || *str == '-') {
 385                         op = *str++;
 386
 387                         /* op on first token == relative */
 388                         if (!matched)
 389                                 m = *mask;
 390
 391                         while (isspace(*str)) /* skip whitespace */
 392                                 str++;
 393
 394                         if (*str == 0)          /* trailing op */
 395                                 return -EINVAL;
 396                 }
 397
 398                 /* find token length */
 399                 for (n = 0; str[n] != 0 && !isspace(str[n]); n++);
 400
 401                 /* match token */
 402                 if (libcfs_debug_token2mask(&t, str, n, is_subsys) != 0)
 403                         return -EINVAL;
 404
 405                 matched = 1;
 406                 if (op == '-')
 407                         m &= ~t;
 408                 else
 409                         m |= t;
 410
 411                 str += n;
 412         }
 413
 414         if (!matched)
 415                 return -EINVAL;
 416
 417         *mask = m;
 418         return 0;
 419 }
 420
 421 void libcfs_debug_dumplog_internal(void *arg)
 422 {
 423         CFS_DECL_JOURNAL_DATA;
 424
 425         CFS_PUSH_JOURNAL;
 426
 427         if (strncmp(debug_file_path, "NONE", 4) != 0) {
 428                 snprintf(debug_file_name, sizeof(debug_file_name) - 1,
 429                          "%s.%ld.%ld", debug_file_path, cfs_time_current_sec(),
 430                          (long)arg);
 431                 printk(KERN_ALERT "LustreError: dumping log to %s\n",
 432                        debug_file_name);
 433                 tracefile_dump_all_pages(debug_file_name);
 434         }
 435         CFS_POP_JOURNAL;
 436 }
 437
 438 int libcfs_debug_dumplog_thread(void *arg)
 439 {
 440         cfs_daemonize("");
 441         libcfs_debug_dumplog_internal(arg);
 442         cfs_waitq_signal(&debug_ctlwq);
 443         return 0;
 444 }
 445
 446 void libcfs_debug_dumplog(void)
 447 {
 448         int            rc;
 449         cfs_waitlink_t wait;
 450         ENTRY;
 451
 452         /* we're being careful to ensure that the kernel thread is
 453          * able to set our state to running as it exits before we
 454          * get to schedule() */
 455         cfs_waitlink_init(&wait);
 456         set_current_state(TASK_INTERRUPTIBLE);
 457         cfs_waitq_add(&debug_ctlwq, &wait);
 458
 459         rc = cfs_kernel_thread(libcfs_debug_dumplog_thread,
 460                                (void *)(long)cfs_curproc_pid(),
 461                                CLONE_VM | CLONE_FS | CLONE_FILES);
 462         if (rc < 0)
 463                 printk(KERN_ERR "LustreError: cannot start log dump thread: "
 464                        "%d\n", rc);
 465         else
 466                 cfs_waitq_wait(&wait, CFS_TASK_INTERRUPTIBLE);
 467
 468         /* be sure to teardown if kernel_thread() failed */
 469         cfs_waitq_del(&debug_ctlwq, &wait);
 470         set_current_state(TASK_RUNNING);
 471 }
 472
 473 int libcfs_debug_init(unsigned long bufsize)
 474 {
 475         int    rc = 0;
 476         int    max = libcfs_debug_mb;
 477
 478         cfs_waitq_init(&debug_ctlwq);
 479         libcfs_console_max_delay = CDEBUG_DEFAULT_MAX_DELAY;
 480         libcfs_console_min_delay = CDEBUG_DEFAULT_MIN_DELAY;
 481         /* If libcfs_debug_mb is set to an invalid value or uninitialized
 482          * then just make the total buffers smp_num_cpus * TCD_MAX_PAGES */
 483         if (max > trace_max_debug_mb() || max < num_possible_cpus()) {
 484                 max = TCD_MAX_PAGES;
 485         } else {
 486                 max = (max / num_possible_cpus());
 487                 max = (max << (20 - CFS_PAGE_SHIFT));
 488         }
 489         rc = tracefile_init(max);
 490
 491         if (rc == 0)
 492                 libcfs_register_panic_notifier();
 493
 494         return rc;
 495 }
 496
 497 int libcfs_debug_cleanup(void)
 498 {
 499         libcfs_unregister_panic_notifier();
 500         tracefile_exit();
 501         return 0;
 502 }
 503
 504 int libcfs_debug_clear_buffer(void)
 505 {
 506         trace_flush_pages();
 507         return 0;
 508 }
 509
 510 /* Debug markers, although printed by S_LNET
 511  * should not be be marked as such. */
 512 #undef DEBUG_SUBSYSTEM
 513 #define DEBUG_SUBSYSTEM S_UNDEFINED
 514 int libcfs_debug_mark_buffer(char *text)
 515 {
 516         CDEBUG(D_TRACE,"***************************************************\n");
 517         CDEBUG(D_WARNING, "DEBUG MARKER: %s\n", text);
 518         CDEBUG(D_TRACE,"***************************************************\n");
 519
 520         return 0;
 521 }
 522 #undef DEBUG_SUBSYSTEM
 523 #define DEBUG_SUBSYSTEM S_LNET
 524
 525 void libcfs_debug_set_level(unsigned int debug_level)
 526 {
 527         printk(KERN_WARNING "Lustre: Setting portals debug level to %08x\n",
 528                debug_level);
 529         libcfs_debug = debug_level;
 530 }
 531
 532 EXPORT_SYMBOL(libcfs_debug_dumplog);
 533 EXPORT_SYMBOL(libcfs_debug_set_level);
 534
 535
 536 #else /* !__KERNEL__ */
 537
 538 #include <libcfs/libcfs.h>
 539
 540 #ifdef HAVE_CATAMOUNT_DATA_H
 541 #include <catamount/data.h>
 542 #include <catamount/lputs.h>
 543
 544 static char source_nid[16];
 545 /* 0 indicates no messages to console, 1 is errors, > 1 is all debug messages */
 546 static int toconsole = 1;
 547 unsigned int libcfs_console_ratelimit = 1;
 548 cfs_duration_t libcfs_console_max_delay;
 549 cfs_duration_t libcfs_console_min_delay;
 550 unsigned int libcfs_console_backoff = CDEBUG_DEFAULT_BACKOFF;
 551 #else /* !HAVE_CATAMOUNT_DATA_H */
 552 #ifdef HAVE_NETDB_H
 553 #include <sys/utsname.h>
 554 #endif /* HAVE_NETDB_H */
 555 struct utsname *tmp_utsname;
 556 static char source_nid[sizeof(tmp_utsname->nodename)];
 557 #endif /* HAVE_CATAMOUNT_DATA_H */
 558
 559 static int source_pid;
 560 int smp_processor_id = 1;
 561 char debug_file_path[1024];
 562 FILE *debug_file_fd;
 563
 564 int portals_do_debug_dumplog(void *arg)
 565 {
 566         printf("Look in %s\n", debug_file_name);
 567         return 0;
 568 }
 569
 570
 571 void portals_debug_print(void)
 572 {
 573         return;
 574 }
 575
 576
 577 void libcfs_debug_dumplog(void)
 578 {
 579         printf("Look in %s\n", debug_file_name);
 580         return;
 581 }
 582
 583 int libcfs_debug_init(unsigned long bufsize)
 584 {
 585         char *debug_mask = NULL;
 586         char *debug_subsys = NULL;
 587         char *debug_filename;
 588
 589 #ifdef HAVE_CATAMOUNT_DATA_H
 590         char *debug_console = NULL;
 591         char *debug_ratelimit = NULL;
 592         char *debug_max_delay = NULL;
 593         char *debug_min_delay = NULL;
 594         char *debug_backoff = NULL;
 595
 596         libcfs_console_max_delay = CDEBUG_DEFAULT_MAX_DELAY;
 597         libcfs_console_min_delay = CDEBUG_DEFAULT_MIN_DELAY;
 598
 599         snprintf(source_nid, sizeof(source_nid) - 1, "%u", _my_pnid);
 600         source_pid = _my_pid;
 601
 602         debug_console = getenv("LIBLUSTRE_DEBUG_CONSOLE");
 603         if (debug_console != NULL) {
 604                 toconsole = strtoul(debug_console, NULL, 0);
 605                 CDEBUG(D_INFO, "set liblustre toconsole to %u\n", toconsole);
 606         }
 607         debug_ratelimit = getenv("LIBLUSTRE_DEBUG_CONSOLE_RATELIMIT");
 608         if (debug_ratelimit != NULL) {
 609                 libcfs_console_ratelimit = strtoul(debug_ratelimit, NULL, 0);
 610                 CDEBUG(D_INFO, "set liblustre console ratelimit to %u\n",
 611                                 libcfs_console_ratelimit);
 612         }
 613         debug_max_delay = getenv("LIBLUSTRE_DEBUG_CONSOLE_MAX_DELAY");
 614         if (debug_max_delay != NULL)
 615                 libcfs_console_max_delay =
 616                             cfs_time_seconds(strtoul(debug_max_delay, NULL, 0));
 617         debug_min_delay = getenv("LIBLUSTRE_DEBUG_CONSOLE_MIN_DELAY");
 618         if (debug_min_delay != NULL)
 619                 libcfs_console_min_delay =
 620                             cfs_time_seconds(strtoul(debug_min_delay, NULL, 0));
 621         if (debug_min_delay || debug_max_delay) {
 622                 if (!libcfs_console_max_delay || !libcfs_console_min_delay ||
 623                     libcfs_console_max_delay < libcfs_console_min_delay) {
 624                         libcfs_console_max_delay = CDEBUG_DEFAULT_MAX_DELAY;
 625                         libcfs_console_min_delay = CDEBUG_DEFAULT_MIN_DELAY;
 626                         CDEBUG(D_INFO, "LIBLUSTRE_DEBUG_CONSOLE_MAX_DELAY "
 627                                        "should be greater than "
 628                                        "LIBLUSTRE_DEBUG_CONSOLE_MIN_DELAY "
 629                                        "and both parameters should be non-null"
 630                                        ": restore default values\n");
 631                 } else {
 632                         CDEBUG(D_INFO, "set liblustre console max delay to %lus"
 633                                        " and min delay to %lus\n",
 634                                (cfs_duration_t)
 635                                      cfs_duration_sec(libcfs_console_max_delay),
 636                                (cfs_duration_t)
 637                                     cfs_duration_sec(libcfs_console_min_delay));
 638                 }
 639         }
 640         debug_backoff = getenv("LIBLUSTRE_DEBUG_CONSOLE_BACKOFF");
 641         if (debug_backoff != NULL) {
 642                 libcfs_console_backoff = strtoul(debug_backoff, NULL, 0);
 643                 if (libcfs_console_backoff <= 0) {
 644                         libcfs_console_backoff = CDEBUG_DEFAULT_BACKOFF;
 645                         CDEBUG(D_INFO, "LIBLUSTRE_DEBUG_CONSOLE_BACKOFF <= 0: "
 646                                        "restore default value\n");
 647                 } else {
 648                         CDEBUG(D_INFO, "set liblustre console backoff to %u\n",
 649                                libcfs_console_backoff);
 650                 }
 651         }
 652 #else
 653         struct utsname myname;
 654
 655         if (uname(&myname) == 0)
 656                 strcpy(source_nid, myname.nodename);
 657         source_pid = getpid();
 658 #endif
 659         /* debug masks */
 660         debug_mask = getenv("LIBLUSTRE_DEBUG_MASK");
 661         if (debug_mask)
 662                 libcfs_debug = (unsigned int) strtol(debug_mask, NULL, 0);
 663
 664         debug_subsys = getenv("LIBLUSTRE_DEBUG_SUBSYS");
 665         if (debug_subsys)
 666                 libcfs_subsystem_debug =
 667                                 (unsigned int) strtol(debug_subsys, NULL, 0);
 668
 669         debug_filename = getenv("LIBLUSTRE_DEBUG_BASE");
 670         if (debug_filename)
 671                 strncpy(debug_file_path,debug_filename,sizeof(debug_file_path));
 672
 673         debug_filename = getenv("LIBLUSTRE_DEBUG_FILE");
 674         if (debug_filename)
 675                 strncpy(debug_file_name,debug_filename,sizeof(debug_file_name));
 676
 677         if (debug_file_name[0] == '\0' && debug_file_path[0] != '\0')
 678                 snprintf(debug_file_name, sizeof(debug_file_name) - 1,
 679                          "%s-%s-"CFS_TIME_T".log", debug_file_path, source_nid, time(0));
 680
 681         if (strcmp(debug_file_name, "stdout") == 0 ||
 682             strcmp(debug_file_name, "-") == 0) {
 683                 debug_file_fd = stdout;
 684         } else if (strcmp(debug_file_name, "stderr") == 0) {
 685                 debug_file_fd = stderr;
 686         } else if (debug_file_name[0] != '\0') {
 687                 debug_file_fd = fopen(debug_file_name, "w");
 688                 if (debug_file_fd == NULL)
 689                         fprintf(stderr, "%s: unable to open '%s': %s\n",
 690                                 source_nid, debug_file_name, strerror(errno));
 691         }
 692
 693         if (debug_file_fd == NULL)
 694                 debug_file_fd = stdout;
 695
 696         return 0;
 697 }
 698
 699 int libcfs_debug_cleanup(void)
 700 {
 701         if (debug_file_fd != stdout && debug_file_fd != stderr)
 702                 fclose(debug_file_fd);
 703         return 0;
 704 }
 705
 706 int libcfs_debug_clear_buffer(void)
 707 {
 708         return 0;
 709 }
 710
 711 int libcfs_debug_mark_buffer(char *text)
 712 {
 713
 714         fprintf(debug_file_fd, "*******************************************************************************\n");
 715         fprintf(debug_file_fd, "DEBUG MARKER: %s\n", text);
 716         fprintf(debug_file_fd, "*******************************************************************************\n");
 717
 718         return 0;
 719 }
 720
 721 #ifdef HAVE_CATAMOUNT_DATA_H
 722 #define CATAMOUNT_MAXLINE (256-4)
 723 void catamount_printline(char *buf, size_t size)
 724 {
 725     char *pos = buf;
 726     int prsize = size;
 727
 728     while (prsize > 0){
 729         lputs(pos);
 730         pos += CATAMOUNT_MAXLINE;
 731         prsize -= CATAMOUNT_MAXLINE;
 732     }
 733 }
 734 #endif
 735
 736 int
 737 libcfs_debug_vmsg2(cfs_debug_limit_state_t *cdls,
 738                    int subsys, int mask,
 739                    const char *file, const char *fn, const int line,
 740                    const char *format1, va_list args,
 741                    const char *format2, ...)
 742 {
 743         struct timeval tv;
 744         int            nob;
 745         int            remain;
 746         va_list        ap;
 747         char           buf[CFS_PAGE_SIZE]; /* size 4096 used for compatimble
 748                                             * with linux, where message can`t
 749                                             * be exceed PAGE_SIZE */
 750         int            console = 0;
 751         char *prefix = "Lustre";
 752
 753 #ifdef HAVE_CATAMOUNT_DATA_H
 754         /* toconsole == 0 - all messages to debug_file_fd
 755          * toconsole == 1 - warnings to console, all to debug_file_fd
 756          * toconsole >  1 - all debug to console */
 757         if (((mask & libcfs_printk) && toconsole == 1) || toconsole > 1)
 758                 console = 1;
 759 #endif
 760
 761         if ((!console) && (!debug_file_fd)) {
 762                 return 0;
 763         }
 764
 765         if (mask & (D_EMERG | D_ERROR))
 766                prefix = "LustreError";
 767
 768         nob = snprintf(buf, sizeof(buf), "%s: %u-%s:(%s:%d:%s()): ", prefix,
 769                        source_pid, source_nid, file, line, fn);
 770
 771         remain = sizeof(buf) - nob;
 772         if (format1) {
 773                 nob += vsnprintf(&buf[nob], remain, format1, args);
 774         }
 775
 776         remain = sizeof(buf) - nob;
 777         if ((format2) && (remain > 0)) {
 778                 va_start(ap, format2);
 779                 nob += vsnprintf(&buf[nob], remain, format2, ap);
 780                 va_end(ap);
 781         }
 782
 783 #ifdef HAVE_CATAMOUNT_DATA_H
 784         if (console) {
 785                 /* check rate limit for console */
 786                 if (cdls != NULL) {
 787                         if (libcfs_console_ratelimit &&
 788                                 cdls->cdls_next != 0 &&     /* not first time ever */
 789                                 !cfs_time_after(cfs_time_current(), cdls->cdls_next)) {
 790
 791                                 /* skipping a console message */
 792                                 cdls->cdls_count++;
 793                                 goto out_file;
 794                         }
 795
 796                         if (cfs_time_after(cfs_time_current(), cdls->cdls_next +
 797                                            libcfs_console_max_delay +
 798                                            cfs_time_seconds(10))) {
 799                                 /* last timeout was a long time ago */
 800                                 cdls->cdls_delay /= libcfs_console_backoff * 4;
 801                         } else {
 802                                 cdls->cdls_delay *= libcfs_console_backoff;
 803
 804                                 if (cdls->cdls_delay <
 805                                                 libcfs_console_min_delay)
 806                                         cdls->cdls_delay =
 807                                                 libcfs_console_min_delay;
 808                                 else if (cdls->cdls_delay >
 809                                                 libcfs_console_max_delay)
 810                                         cdls->cdls_delay =
 811                                                 libcfs_console_max_delay;
 812                         }
 813
 814                         /* ensure cdls_next is never zero after it's been seen */
 815                         cdls->cdls_next = (cfs_time_current() + cdls->cdls_delay) | 1;
 816                 }
 817
 818                 if (cdls != NULL && cdls->cdls_count != 0) {
 819                         char buf2[100];
 820
 821                         nob = snprintf(buf2, sizeof(buf2),
 822                                        "Skipped %d previous similar message%s\n",
 823                                        cdls->cdls_count, (cdls->cdls_count > 1) ? "s" : "");
 824
 825                         catamount_printline(buf2, nob);
 826                         cdls->cdls_count = 0;
 827                         goto out_file;
 828                 }
 829                 catamount_printline(buf, nob);
 830        }
 831 out_file:
 832         /* return on toconsole > 1, as we don't want the user getting
 833         * spammed by the debug data */
 834         if (toconsole > 1)
 835                 return 0;
 836 #endif
 837         if (debug_file_fd == NULL)
 838                 return 0;
 839
 840         gettimeofday(&tv, NULL);
 841
 842         fprintf(debug_file_fd, CFS_TIME_T".%06lu:%u:%s:(%s:%d:%s()): %s",
 843                 tv.tv_sec, tv.tv_usec, source_pid, source_nid,
 844                 file, line, fn, buf);
 845
 846         return 0;
 847 }
 848
 849 void
 850 libcfs_assertion_failed(const char *expr, const char *file, const char *func,
 851                         const int line)
 852 {
 853         libcfs_debug_msg(NULL, 0, D_EMERG, file, func, line,
 854                          "ASSERTION(%s) failed\n", expr);
 855         abort();
 856 }
 857
 858 #endif /* __KERNEL__ */