libcfs/libcfs/linux/linux-tracefile.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
  37 #define DEBUG_SUBSYSTEM S_LNET
  38 #define LUSTRE_TRACEFILE_PRIVATE
  39
  40 #include <libcfs/libcfs.h>
  41 #include "tracefile.h"
  42
  43 /* percents to share the total debug memory for each type */
  44 static unsigned int pages_factor[CFS_TCD_TYPE_MAX] = {
  45         80,  /* 80% pages for CFS_TCD_TYPE_PROC */
  46         10,  /* 10% pages for CFS_TCD_TYPE_SOFTIRQ */
  47         10   /* 10% pages for CFS_TCD_TYPE_IRQ */
  48 };
  49
  50 char *cfs_trace_console_buffers[NR_CPUS][CFS_TCD_TYPE_MAX];
  51
  52 cfs_rw_semaphore_t cfs_tracefile_sem;
  53
  54 int cfs_tracefile_init_arch()
  55 {
  56         int    i;
  57         int    j;
  58         struct cfs_trace_cpu_data *tcd;
  59
  60         cfs_init_rwsem(&cfs_tracefile_sem);
  61
  62         /* initialize trace_data */
  63         memset(cfs_trace_data, 0, sizeof(cfs_trace_data));
  64         for (i = 0; i < CFS_TCD_TYPE_MAX; i++) {
  65                 cfs_trace_data[i] =
  66                         kmalloc(sizeof(union cfs_trace_data_union) * NR_CPUS,
  67                                 GFP_KERNEL);
  68                 if (cfs_trace_data[i] == NULL)
  69                         goto out;
  70
  71         }
  72
  73         /* arch related info initialized */
  74         cfs_tcd_for_each(tcd, i, j) {
  75                 cfs_spin_lock_init(&tcd->tcd_lock);
  76                 tcd->tcd_pages_factor = pages_factor[i];
  77                 tcd->tcd_type = i;
  78                 tcd->tcd_cpu = j;
  79         }
  80
  81         for (i = 0; i < num_possible_cpus(); i++)
  82                 for (j = 0; j < 3; j++) {
  83                         cfs_trace_console_buffers[i][j] =
  84                                 kmalloc(CFS_TRACE_CONSOLE_BUFFER_SIZE,
  85                                         GFP_KERNEL);
  86
  87                         if (cfs_trace_console_buffers[i][j] == NULL)
  88                                 goto out;
  89                 }
  90
  91         return 0;
  92
  93 out:
  94         cfs_tracefile_fini_arch();
  95         printk(KERN_ERR "lnet: Not enough memory\n");
  96         return -ENOMEM;
  97
  98 }
  99
 100 void cfs_tracefile_fini_arch()
 101 {
 102         int    i;
 103         int    j;
 104
 105         for (i = 0; i < num_possible_cpus(); i++)
 106                 for (j = 0; j < 3; j++)
 107                         if (cfs_trace_console_buffers[i][j] != NULL) {
 108                                 kfree(cfs_trace_console_buffers[i][j]);
 109                                 cfs_trace_console_buffers[i][j] = NULL;
 110                         }
 111
 112         for (i = 0; cfs_trace_data[i] != NULL; i++) {
 113                 kfree(cfs_trace_data[i]);
 114                 cfs_trace_data[i] = NULL;
 115         }
 116
 117         cfs_fini_rwsem(&cfs_tracefile_sem);
 118 }
 119
 120 void cfs_tracefile_read_lock()
 121 {
 122         cfs_down_read(&cfs_tracefile_sem);
 123 }
 124
 125 void cfs_tracefile_read_unlock()
 126 {
 127         cfs_up_read(&cfs_tracefile_sem);
 128 }
 129
 130 void cfs_tracefile_write_lock()
 131 {
 132         cfs_down_write(&cfs_tracefile_sem);
 133 }
 134
 135 void cfs_tracefile_write_unlock()
 136 {
 137         cfs_up_write(&cfs_tracefile_sem);
 138 }
 139
 140 cfs_trace_buf_type_t cfs_trace_buf_idx_get()
 141 {
 142         if (in_irq())
 143                 return CFS_TCD_TYPE_IRQ;
 144         else if (in_softirq())
 145                 return CFS_TCD_TYPE_SOFTIRQ;
 146         else
 147                 return CFS_TCD_TYPE_PROC;
 148 }
 149
 150 /*
 151  * The walking argument indicates the locking comes from all tcd types
 152  * iterator and we must lock it and dissable local irqs to avoid deadlocks
 153  * with other interrupt locks that might be happening. See LU-1311
 154  * for details.
 155  */
 156 int cfs_trace_lock_tcd(struct cfs_trace_cpu_data *tcd, int walking)
 157 {
 158         __LASSERT(tcd->tcd_type < CFS_TCD_TYPE_MAX);
 159         if (tcd->tcd_type == CFS_TCD_TYPE_IRQ)
 160                 cfs_spin_lock_irqsave(&tcd->tcd_lock, tcd->tcd_lock_flags);
 161         else if (tcd->tcd_type == CFS_TCD_TYPE_SOFTIRQ)
 162                 cfs_spin_lock_bh(&tcd->tcd_lock);
 163         else if (unlikely(walking))
 164                 cfs_spin_lock_irq(&tcd->tcd_lock);
 165         else
 166                 cfs_spin_lock(&tcd->tcd_lock);
 167         return 1;
 168 }
 169
 170 void cfs_trace_unlock_tcd(struct cfs_trace_cpu_data *tcd, int walking)
 171 {
 172         __LASSERT(tcd->tcd_type < CFS_TCD_TYPE_MAX);
 173         if (tcd->tcd_type == CFS_TCD_TYPE_IRQ)
 174                 cfs_spin_unlock_irqrestore(&tcd->tcd_lock, tcd->tcd_lock_flags);
 175         else if (tcd->tcd_type == CFS_TCD_TYPE_SOFTIRQ)
 176                 cfs_spin_unlock_bh(&tcd->tcd_lock);
 177         else if (unlikely(walking))
 178                 cfs_spin_unlock_irq(&tcd->tcd_lock);
 179         else
 180                 cfs_spin_unlock(&tcd->tcd_lock);
 181 }
 182
 183 int cfs_tcd_owns_tage(struct cfs_trace_cpu_data *tcd,
 184                       struct cfs_trace_page *tage)
 185 {
 186         /*
 187          * XXX nikita: do NOT call portals_debug_msg() (CDEBUG/ENTRY/EXIT)
 188          * from here: this will lead to infinite recursion.
 189          */
 190         return tcd->tcd_cpu == tage->cpu;
 191 }
 192
 193 void
 194 cfs_set_ptldebug_header(struct ptldebug_header *header,
 195                         struct libcfs_debug_msg_data *msgdata,
 196                         unsigned long stack)
 197 {
 198         struct timeval tv;
 199
 200         do_gettimeofday(&tv);
 201
 202         header->ph_subsys = msgdata->msg_subsys;
 203         header->ph_mask = msgdata->msg_mask;
 204         header->ph_cpu_id = cfs_smp_processor_id();
 205         header->ph_type = cfs_trace_buf_idx_get();
 206         header->ph_sec = (__u32)tv.tv_sec;
 207         header->ph_usec = tv.tv_usec;
 208         header->ph_stack = stack;
 209         header->ph_pid = current->pid;
 210         header->ph_line_num = msgdata->msg_line;
 211         header->ph_extern_pid = 0;
 212         return;
 213 }
 214
 215 static char *
 216 dbghdr_to_err_string(struct ptldebug_header *hdr)
 217 {
 218         switch (hdr->ph_subsys) {
 219
 220                 case S_LND:
 221                 case S_LNET:
 222                         return "LNetError";
 223                 default:
 224                         return "LustreError";
 225         }
 226 }
 227
 228 static char *
 229 dbghdr_to_info_string(struct ptldebug_header *hdr)
 230 {
 231         switch (hdr->ph_subsys) {
 232
 233                 case S_LND:
 234                 case S_LNET:
 235                         return "LNet";
 236                 default:
 237                         return "Lustre";
 238         }
 239 }
 240
 241 void cfs_print_to_console(struct ptldebug_header *hdr, int mask,
 242                           const char *buf, int len, const char *file,
 243                           const char *fn)
 244 {
 245         char *prefix = "Lustre", *ptype = NULL;
 246
 247         if ((mask & D_EMERG) != 0) {
 248                 prefix = dbghdr_to_err_string(hdr);
 249                 ptype = KERN_EMERG;
 250         } else if ((mask & D_ERROR) != 0) {
 251                 prefix = dbghdr_to_err_string(hdr);
 252                 ptype = KERN_ERR;
 253         } else if ((mask & D_WARNING) != 0) {
 254                 prefix = dbghdr_to_info_string(hdr);
 255                 ptype = KERN_WARNING;
 256         } else if ((mask & (D_CONSOLE | libcfs_printk)) != 0) {
 257                 prefix = dbghdr_to_info_string(hdr);
 258                 ptype = KERN_INFO;
 259         }
 260
 261         if ((mask & D_CONSOLE) != 0) {
 262                 printk("%s%s: %.*s", ptype, prefix, len, buf);
 263         } else {
 264                 printk("%s%s: %d:%d:(%s:%d:%s()) %.*s", ptype, prefix,
 265                        hdr->ph_pid, hdr->ph_extern_pid, file, hdr->ph_line_num,
 266                        fn, len, buf);
 267         }
 268         return;
 269 }
 270
 271 int cfs_trace_max_debug_mb(void)
 272 {
 273         int  total_mb = (cfs_num_physpages >> (20 - PAGE_SHIFT));
 274
 275         return MAX(512, (total_mb * 80)/100);
 276 }