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