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