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  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
  37 #define DEBUG_SUBSYSTEM S_LNET
  38 #define LUSTRE_TRACEFILE_PRIVATE
  39
  40 #include <libcfs/libcfs.h>
  41 #include "tracefile.h"
  42
  43 /* three types of trace_data in linux */
  44 enum {
  45         TCD_TYPE_PROC = 0,
  46         TCD_TYPE_SOFTIRQ,
  47         TCD_TYPE_IRQ,
  48         TCD_TYPE_MAX
  49 };
  50
  51 /* percents to share the total debug memory for each type */
  52 static unsigned int pages_factor[TCD_TYPE_MAX] = {
  53         80,  /* 80% pages for TCD_TYPE_PROC */
  54         10,  /* 10% pages for TCD_TYPE_SOFTIRQ */
  55         10   /* 10% pages for TCD_TYPE_IRQ */
  56 };
  57
  58 char *trace_console_buffers[NR_CPUS][3];
  59
  60 struct rw_semaphore tracefile_sem;
  61
  62 int tracefile_init_arch()
  63 {
  64         int    i;
  65         int    j;
  66         struct trace_cpu_data *tcd;
  67
  68         init_rwsem(&tracefile_sem);
  69
  70         /* initialize trace_data */
  71         memset(trace_data, 0, sizeof(trace_data));
  72         for (i = 0; i < TCD_TYPE_MAX; i++) {
  73                 trace_data[i]=kmalloc(sizeof(union trace_data_union)*NR_CPUS,
  74                                                           GFP_KERNEL);
  75                 if (trace_data[i] == NULL)
  76                         goto out;
  77
  78         }
  79
  80         /* arch related info initialized */
  81         tcd_for_each(tcd, i, j) {
  82                 spin_lock_init(&tcd->tcd_lock);
  83                 tcd->tcd_pages_factor = pages_factor[i];
  84                 tcd->tcd_type = i;
  85                 tcd->tcd_cpu = j;
  86         }
  87
  88         for (i = 0; i < num_possible_cpus(); i++)
  89                 for (j = 0; j < 3; j++) {
  90                         trace_console_buffers[i][j] =
  91                                 kmalloc(TRACE_CONSOLE_BUFFER_SIZE,
  92                                         GFP_KERNEL);
  93
  94                         if (trace_console_buffers[i][j] == NULL)
  95                                 goto out;
  96                 }
  97
  98         return 0;
  99
 100 out:
 101         tracefile_fini_arch();
 102         printk(KERN_ERR "lnet: No enough memory\n");
 103         return -ENOMEM;
 104
 105 }
 106
 107 void tracefile_fini_arch()
 108 {
 109         int    i;
 110         int    j;
 111
 112         for (i = 0; i < num_possible_cpus(); i++)
 113                 for (j = 0; j < 3; j++)
 114                         if (trace_console_buffers[i][j] != NULL) {
 115                                 kfree(trace_console_buffers[i][j]);
 116                                 trace_console_buffers[i][j] = NULL;
 117                         }
 118
 119         for (i = 0; trace_data[i] != NULL; i++) {
 120                 kfree(trace_data[i]);
 121                 trace_data[i] = NULL;
 122         }
 123
 124         fini_rwsem(&tracefile_sem);
 125 }
 126
 127 void tracefile_read_lock()
 128 {
 129         down_read(&tracefile_sem);
 130 }
 131
 132 void tracefile_read_unlock()
 133 {
 134         up_read(&tracefile_sem);
 135 }
 136
 137 void tracefile_write_lock()
 138 {
 139         down_write(&tracefile_sem);
 140 }
 141
 142 void tracefile_write_unlock()
 143 {
 144         up_write(&tracefile_sem);
 145 }
 146
 147 char *
 148 trace_get_console_buffer(void)
 149 {
 150         int  cpu = cfs_get_cpu();
 151         int  idx;
 152
 153         if (in_irq()) {
 154                 idx = 0;
 155         } else if (in_softirq()) {
 156                 idx = 1;
 157         } else {
 158                 idx = 2;
 159         }
 160
 161         return trace_console_buffers[cpu][idx];
 162 }
 163
 164 void
 165 trace_put_console_buffer(char *buffer)
 166 {
 167         cfs_put_cpu();
 168 }
 169
 170 struct trace_cpu_data *
 171 trace_get_tcd(void)
 172 {
 173         struct trace_cpu_data *tcd;
 174         int cpu;
 175
 176         cpu = cfs_get_cpu();
 177         if (in_irq())
 178                 tcd = &(*trace_data[TCD_TYPE_IRQ])[cpu].tcd;
 179         else if (in_softirq())
 180                 tcd = &(*trace_data[TCD_TYPE_SOFTIRQ])[cpu].tcd;
 181         else
 182                 tcd = &(*trace_data[TCD_TYPE_PROC])[cpu].tcd;
 183
 184         trace_lock_tcd(tcd);
 185
 186         return tcd;
 187 }
 188
 189 void
 190 trace_put_tcd (struct trace_cpu_data *tcd)
 191 {
 192         trace_unlock_tcd(tcd);
 193
 194         cfs_put_cpu();
 195 }
 196
 197 int trace_lock_tcd(struct trace_cpu_data *tcd)
 198 {
 199         __LASSERT(tcd->tcd_type < TCD_TYPE_MAX);
 200
 201         spin_lock_irqsave(&tcd->tcd_lock, tcd->tcd_lock_flags);
 202
 203         return 1;
 204 }
 205
 206 void trace_unlock_tcd(struct trace_cpu_data *tcd)
 207 {
 208         __LASSERT(tcd->tcd_type < TCD_TYPE_MAX);
 209
 210         spin_unlock_irqrestore(&tcd->tcd_lock, tcd->tcd_lock_flags);
 211 }
 212
 213 int tcd_owns_tage(struct trace_cpu_data *tcd, struct trace_page *tage)
 214 {
 215         /*
 216          * XXX nikita: do NOT call portals_debug_msg() (CDEBUG/ENTRY/EXIT)
 217          * from here: this will lead to infinite recursion.
 218          */
 219         return tcd->tcd_cpu == tage->cpu;
 220 }
 221
 222 void
 223 set_ptldebug_header(struct ptldebug_header *header, int subsys, int mask,
 224                     const int line, unsigned long stack)
 225 {
 226         struct timeval tv;
 227
 228         do_gettimeofday(&tv);
 229
 230         header->ph_subsys = subsys;
 231         header->ph_mask = mask;
 232         header->ph_cpu_id = smp_processor_id();
 233         header->ph_sec = (__u32)tv.tv_sec;
 234         header->ph_usec = tv.tv_usec;
 235         header->ph_stack = stack;
 236         header->ph_pid = current->pid;
 237         header->ph_line_num = line;
 238 #if defined(__arch_um__) && (LINUX_VERSION_CODE < KERNEL_VERSION(2,4,20))
 239         header->ph_extern_pid = current->thread.extern_pid;
 240 #elif defined(__arch_um__) && (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 241         header->ph_extern_pid = current->thread.mode.tt.extern_pid;
 242 #else
 243         header->ph_extern_pid = 0;
 244 #endif
 245         return;
 246 }
 247
 248 void print_to_console(struct ptldebug_header *hdr, int mask, const char *buf,
 249                              int len, const char *file, const char *fn)
 250 {
 251         char *prefix = "Lustre", *ptype = NULL;
 252
 253         if ((mask & D_EMERG) != 0) {
 254                 prefix = "LustreError";
 255                 ptype = KERN_EMERG;
 256         } else if ((mask & D_ERROR) != 0) {
 257                 prefix = "LustreError";
 258                 ptype = KERN_ERR;
 259         } else if ((mask & D_WARNING) != 0) {
 260                 prefix = "Lustre";
 261                 ptype = KERN_WARNING;
 262         } else if ((mask & (D_CONSOLE | libcfs_printk)) != 0) {
 263                 prefix = "Lustre";
 264                 ptype = KERN_INFO;
 265         }
 266
 267         if ((mask & D_CONSOLE) != 0) {
 268                 printk("%s%s: %.*s", ptype, prefix, len, buf);
 269         } else {
 270                 printk("%s%s: %d:%d:(%s:%d:%s()) %.*s", ptype, prefix, hdr->ph_pid,
 271                        hdr->ph_extern_pid, file, hdr->ph_line_num, fn, len, buf);
 272         }
 273         return;
 274 }
 275
 276 int trace_max_debug_mb(void)
 277 {
 278         int  total_mb = (num_physpages >> (20 - CFS_PAGE_SHIFT));
 279
 280         return MAX(512, (total_mb * 80)/100);
 281 }