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) * NR_CPUS,
  65                                 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 < 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
  98 void cfs_tracefile_fini_arch()
  99 {
 100         int    i;
 101         int    j;
 102
 103         for (i = 0; i < num_possible_cpus(); i++)
 104                 for (j = 0; j < 3; j++)
 105                         if (cfs_trace_console_buffers[i][j] != NULL) {
 106                                 kfree(cfs_trace_console_buffers[i][j]);
 107                                 cfs_trace_console_buffers[i][j] = NULL;
 108                         }
 109
 110         for (i = 0; cfs_trace_data[i] != NULL; i++) {
 111                 kfree(cfs_trace_data[i]);
 112                 cfs_trace_data[i] = NULL;
 113         }
 114
 115         cfs_fini_rwsem(&cfs_tracefile_sem);
 116 }
 117
 118 void cfs_tracefile_read_lock()
 119 {
 120         cfs_down_read(&cfs_tracefile_sem);
 121 }
 122
 123 void cfs_tracefile_read_unlock()
 124 {
 125         cfs_up_read(&cfs_tracefile_sem);
 126 }
 127
 128 void cfs_tracefile_write_lock()
 129 {
 130         cfs_down_write(&cfs_tracefile_sem);
 131 }
 132
 133 void cfs_tracefile_write_unlock()
 134 {
 135         cfs_up_write(&cfs_tracefile_sem);
 136 }
 137
 138 cfs_trace_buf_type_t cfs_trace_buf_idx_get()
 139 {
 140         if (in_irq())
 141                 return CFS_TCD_TYPE_IRQ;
 142         else if (in_softirq())
 143                 return CFS_TCD_TYPE_SOFTIRQ;
 144         else
 145                 return CFS_TCD_TYPE_PROC;
 146 }
 147
 148 /*
 149  * The walking argument indicates the locking comes from all tcd types
 150  * iterator and we must lock it and dissable local irqs to avoid deadlocks
 151  * with other interrupt locks that might be happening. See LU-1311
 152  * for details.
 153  */
 154 int cfs_trace_lock_tcd(struct cfs_trace_cpu_data *tcd, int walking)
 155 {
 156         __LASSERT(tcd->tcd_type < CFS_TCD_TYPE_MAX);
 157         if (tcd->tcd_type == CFS_TCD_TYPE_IRQ)
 158                 cfs_spin_lock_irqsave(&tcd->tcd_lock, tcd->tcd_lock_flags);
 159         else if (tcd->tcd_type == CFS_TCD_TYPE_SOFTIRQ)
 160                 cfs_spin_lock_bh(&tcd->tcd_lock);
 161         else if (unlikely(walking))
 162                 cfs_spin_lock_irq(&tcd->tcd_lock);
 163         else
 164                 cfs_spin_lock(&tcd->tcd_lock);
 165         return 1;
 166 }
 167
 168 void cfs_trace_unlock_tcd(struct cfs_trace_cpu_data *tcd, int walking)
 169 {
 170         __LASSERT(tcd->tcd_type < CFS_TCD_TYPE_MAX);
 171         if (tcd->tcd_type == CFS_TCD_TYPE_IRQ)
 172                 cfs_spin_unlock_irqrestore(&tcd->tcd_lock, tcd->tcd_lock_flags);
 173         else if (tcd->tcd_type == CFS_TCD_TYPE_SOFTIRQ)
 174                 cfs_spin_unlock_bh(&tcd->tcd_lock);
 175         else if (unlikely(walking))
 176                 cfs_spin_unlock_irq(&tcd->tcd_lock);
 177         else
 178                 cfs_spin_unlock(&tcd->tcd_lock);
 179 }
 180
 181 int cfs_tcd_owns_tage(struct cfs_trace_cpu_data *tcd,
 182                       struct cfs_trace_page *tage)
 183 {
 184         /*
 185          * XXX nikita: do NOT call portals_debug_msg() (CDEBUG/ENTRY/EXIT)
 186          * from here: this will lead to infinite recursion.
 187          */
 188         return tcd->tcd_cpu == tage->cpu;
 189 }
 190
 191 void
 192 cfs_set_ptldebug_header(struct ptldebug_header *header,
 193                         struct libcfs_debug_msg_data *msgdata,
 194                         unsigned long stack)
 195 {
 196         struct timeval tv;
 197
 198         do_gettimeofday(&tv);
 199
 200         header->ph_subsys = msgdata->msg_subsys;
 201         header->ph_mask = msgdata->msg_mask;
 202         header->ph_cpu_id = cfs_smp_processor_id();
 203         header->ph_type = cfs_trace_buf_idx_get();
 204         header->ph_sec = (__u32)tv.tv_sec;
 205         header->ph_usec = tv.tv_usec;
 206         header->ph_stack = stack;
 207         header->ph_pid = current->pid;
 208         header->ph_line_num = msgdata->msg_line;
 209         header->ph_extern_pid = 0;
 210         return;
 211 }
 212
 213 static char *
 214 dbghdr_to_err_string(struct ptldebug_header *hdr)
 215 {
 216         switch (hdr->ph_subsys) {
 217
 218                 case S_LND:
 219                 case S_LNET:
 220                         return "LNetError";
 221                 default:
 222                         return "LustreError";
 223         }
 224 }
 225
 226 static char *
 227 dbghdr_to_info_string(struct ptldebug_header *hdr)
 228 {
 229         switch (hdr->ph_subsys) {
 230
 231                 case S_LND:
 232                 case S_LNET:
 233                         return "LNet";
 234                 default:
 235                         return "Lustre";
 236         }
 237 }
 238
 239 void cfs_print_to_console(struct ptldebug_header *hdr, int mask,
 240                           const char *buf, int len, const char *file,
 241                           const char *fn)
 242 {
 243         char *prefix = "Lustre", *ptype = NULL;
 244
 245         if ((mask & D_EMERG) != 0) {
 246                 prefix = dbghdr_to_err_string(hdr);
 247                 ptype = KERN_EMERG;
 248         } else if ((mask & D_ERROR) != 0) {
 249                 prefix = dbghdr_to_err_string(hdr);
 250                 ptype = KERN_ERR;
 251         } else if ((mask & D_WARNING) != 0) {
 252                 prefix = dbghdr_to_info_string(hdr);
 253                 ptype = KERN_WARNING;
 254         } else if ((mask & (D_CONSOLE | libcfs_printk)) != 0) {
 255                 prefix = dbghdr_to_info_string(hdr);
 256                 ptype = KERN_INFO;
 257         }
 258
 259         if ((mask & D_CONSOLE) != 0) {
 260                 printk("%s%s: %.*s", ptype, prefix, len, buf);
 261         } else {
 262                 printk("%s%s: %d:%d:(%s:%d:%s()) %.*s", ptype, prefix,
 263                        hdr->ph_pid, hdr->ph_extern_pid, file, hdr->ph_line_num,
 264                        fn, len, buf);
 265         }
 266         return;
 267 }
 268
 269 int cfs_trace_max_debug_mb(void)
 270 {
 271         int  total_mb = (cfs_num_physpages >> (20 - PAGE_SHIFT));
 272
 273         return MAX(512, (total_mb * 80)/100);
 274 }