libcfs/libcfs/tracefile.h

   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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #ifndef __LIBCFS_TRACEFILE_H__
  34 #define __LIBCFS_TRACEFILE_H__
  35
  36 #include <libcfs/libcfs.h>
  37
  38 enum cfs_trace_buf_type {
  39         CFS_TCD_TYPE_PROC = 0,
  40         CFS_TCD_TYPE_SOFTIRQ,
  41         CFS_TCD_TYPE_IRQ,
  42         CFS_TCD_TYPE_MAX
  43 };
  44
  45 #define TRACEFILE_NAME_SIZE 1024
  46 extern char      cfs_tracefile[TRACEFILE_NAME_SIZE];
  47 extern long long cfs_tracefile_size;
  48
  49 /**
  50  * The path of debug log dump upcall script.
  51  */
  52 extern char lnet_debug_log_upcall[1024];
  53
  54 extern void libcfs_run_debug_log_upcall(char *file);
  55
  56 int  cfs_tracefile_init_arch(void);
  57 void cfs_tracefile_fini_arch(void);
  58
  59 int cfs_tracefile_dump_all_pages(char *filename);
  60 void cfs_trace_debug_print(void);
  61 void cfs_trace_flush_pages(void);
  62 int cfs_trace_start_thread(void);
  63 void cfs_trace_stop_thread(void);
  64 int cfs_tracefile_init(int max_pages);
  65 void cfs_tracefile_exit(void);
  66
  67
  68
  69 int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
  70                             const char __user *usr_buffer, int usr_buffer_nob);
  71 int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
  72                              const char *knl_str, char *append);
  73 int cfs_trace_allocate_string_buffer(char **str, int nob);
  74 int cfs_trace_dump_debug_buffer_usrstr(void __user *usr_str, int usr_str_nob);
  75 int cfs_trace_daemon_command(char *str);
  76 int cfs_trace_daemon_command_usrstr(void __user *usr_str, int usr_str_nob);
  77 int cfs_trace_set_debug_mb(int mb);
  78 int cfs_trace_get_debug_mb(void);
  79
  80 extern void libcfs_debug_dumplog_internal(void *arg);
  81 extern int  libcfs_panic_in_progress;
  82
  83 #define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
  84 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
  85 #define CFS_TRACEFILE_SIZE (500 << 20)
  86
  87 #ifdef LUSTRE_TRACEFILE_PRIVATE
  88
  89 /*
  90  * Private declare for tracefile
  91  */
  92 #define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
  93 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
  94
  95 #define CFS_TRACEFILE_SIZE (500 << 20)
  96
  97 /* Size of a buffer for sprinting console messages if we can't get a page
  98  * from system */
  99 #define CFS_TRACE_CONSOLE_BUFFER_SIZE   1024
 100
 101 union cfs_trace_data_union {
 102         struct cfs_trace_cpu_data {
 103                 /*
 104                  * Even though this structure is meant to be per-CPU, locking
 105                  * is needed because in some places the data may be accessed
 106                  * from other CPUs. This lock is directly used in trace_get_tcd
 107                  * and trace_put_tcd, which are called in libcfs_debug_msg and
 108                  * tcd_for_each_type_lock
 109                  */
 110                 spinlock_t              tcd_lock;
 111                 unsigned long           tcd_lock_flags;
 112
 113                 /*
 114                  * pages with trace records not yet processed by tracefiled.
 115                  */
 116                 struct list_head        tcd_pages;
 117                 /* number of pages on ->tcd_pages */
 118                 unsigned long           tcd_cur_pages;
 119
 120                 /*
 121                  * pages with trace records already processed by
 122                  * tracefiled. These pages are kept in memory, so that some
 123                  * portion of log can be written in the event of LBUG. This
 124                  * list is maintained in LRU order.
 125                  *
 126                  * Pages are moved to ->tcd_daemon_pages by tracefiled()
 127                  * (put_pages_on_daemon_list()). LRU pages from this list are
 128                  * discarded when list grows too large.
 129                  */
 130                 struct list_head        tcd_daemon_pages;
 131                 /* number of pages on ->tcd_daemon_pages */
 132                 unsigned long           tcd_cur_daemon_pages;
 133
 134                 /*
 135                  * Maximal number of pages allowed on ->tcd_pages and
 136                  * ->tcd_daemon_pages each.
 137                  * Always TCD_MAX_PAGES * tcd_pages_factor / 100 in current
 138                  * implementation.
 139                  */
 140                 unsigned long           tcd_max_pages;
 141
 142                 /*
 143                  * preallocated pages to write trace records into. Pages from
 144                  * ->tcd_stock_pages are moved to ->tcd_pages by
 145                  * portals_debug_msg().
 146                  *
 147                  * This list is necessary, because on some platforms it's
 148                  * impossible to perform efficient atomic page allocation in a
 149                  * non-blockable context.
 150                  *
 151                  * Such platforms fill ->tcd_stock_pages "on occasion", when
 152                  * tracing code is entered in blockable context.
 153                  *
 154                  * trace_get_tage_try() tries to get a page from
 155                  * ->tcd_stock_pages first and resorts to atomic page
 156                  * allocation only if this queue is empty. ->tcd_stock_pages
 157                  * is replenished when tracing code is entered in blocking
 158                  * context (darwin-tracefile.c:trace_get_tcd()). We try to
 159                  * maintain TCD_STOCK_PAGES (40 by default) pages in this
 160                  * queue. Atomic allocation is only required if more than
 161                  * TCD_STOCK_PAGES pagesful are consumed by trace records all
 162                  * emitted in non-blocking contexts. Which is quite unlikely.
 163                  */
 164                 struct list_head        tcd_stock_pages;
 165                 /* number of pages on ->tcd_stock_pages */
 166                 unsigned long           tcd_cur_stock_pages;
 167
 168                 unsigned short          tcd_shutting_down;
 169                 unsigned short          tcd_cpu;
 170                 unsigned short          tcd_type;
 171                 /* The factors to share debug memory. */
 172                 unsigned short          tcd_pages_factor;
 173         } tcd;
 174         char __pad[L1_CACHE_ALIGN(sizeof(struct cfs_trace_cpu_data))];
 175 };
 176
 177 #define TCD_MAX_TYPES      8
 178 extern union cfs_trace_data_union (*cfs_trace_data[TCD_MAX_TYPES])[NR_CPUS];
 179
 180 #define cfs_tcd_for_each(tcd, i, j)                                       \
 181     for (i = 0; cfs_trace_data[i] != NULL; i++)                           \
 182         for (j = 0, ((tcd) = &(*cfs_trace_data[i])[j].tcd);               \
 183              j < num_possible_cpus();                                     \
 184              j++, (tcd) = &(*cfs_trace_data[i])[j].tcd)
 185
 186 /* XXX nikita: this declaration is internal to tracefile.c and should probably
 187  * be moved there */
 188 struct page_collection {
 189         struct list_head        pc_pages;
 190         /*
 191          * if this flag is set, collect_pages() will spill both
 192          * ->tcd_daemon_pages and ->tcd_pages to the ->pc_pages. Otherwise,
 193          * only ->tcd_pages are spilled.
 194          */
 195         int                     pc_want_daemon_pages;
 196 };
 197
 198 /* XXX nikita: this declaration is internal to tracefile.c and should probably
 199  * be moved there */
 200 struct tracefiled_ctl {
 201         struct completion       tctl_start;
 202         struct completion       tctl_stop;
 203         wait_queue_head_t       tctl_waitq;
 204         pid_t                   tctl_pid;
 205         atomic_t                tctl_shutdown;
 206 };
 207
 208 /*
 209  * small data-structure for each page owned by tracefiled.
 210  */
 211 /* XXX nikita: this declaration is internal to tracefile.c and should probably
 212  * be moved there */
 213 struct cfs_trace_page {
 214         /*
 215          * page itself
 216          */
 217         struct page             *page;
 218         /*
 219          * linkage into one of the lists in trace_data_union or
 220          * page_collection
 221          */
 222         struct list_head        linkage;
 223         /*
 224          * number of bytes used within this page
 225          */
 226         unsigned int            used;
 227         /*
 228          * cpu that owns this page
 229          */
 230         unsigned short          cpu;
 231         /*
 232          * type(context) of this page
 233          */
 234         unsigned short          type;
 235 };
 236
 237 extern void cfs_set_ptldebug_header(struct ptldebug_header *header,
 238                                     struct libcfs_debug_msg_data *m,
 239                                     unsigned long stack);
 240 extern void cfs_print_to_console(struct ptldebug_header *hdr, int mask,
 241                                  const char *buf, int len, const char *file,
 242                                  const char *fn);
 243
 244 extern char *cfs_trace_console_buffers[NR_CPUS][CFS_TCD_TYPE_MAX];
 245 extern enum cfs_trace_buf_type cfs_trace_buf_idx_get(void);
 246
 247 static inline char *cfs_trace_get_console_buffer(void)
 248 {
 249         unsigned int i = get_cpu();
 250         unsigned int j = cfs_trace_buf_idx_get();
 251
 252         return cfs_trace_console_buffers[i][j];
 253 }
 254
 255 int cfs_trace_refill_stock(struct cfs_trace_cpu_data *tcd, gfp_t gfp,
 256                                 struct list_head *stock);
 257
 258
 259 int cfs_tcd_owns_tage(struct cfs_trace_cpu_data *tcd,
 260                       struct cfs_trace_page *tage);
 261
 262 extern void cfs_trace_assertion_failed(const char *str,
 263                                        struct libcfs_debug_msg_data *m);
 264
 265 /* ASSERTION that is safe to use within the debug system */
 266 #define __LASSERT(cond)                                                 \
 267 do {                                                                    \
 268         if (unlikely(!(cond))) {                                        \
 269                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL);     \
 270                 cfs_trace_assertion_failed("ASSERTION("#cond") failed", \
 271                                            &msgdata);                   \
 272         }                                                               \
 273 } while (0)
 274
 275 #define __LASSERT_TAGE_INVARIANT(tage)                                  \
 276 do {                                                                    \
 277         __LASSERT(tage != NULL);                                        \
 278         __LASSERT(tage->page != NULL);                                  \
 279         __LASSERT(tage->used <= PAGE_SIZE);                             \
 280         __LASSERT(page_count(tage->page) > 0);                          \
 281 } while (0)
 282
 283 #endif  /* LUSTRE_TRACEFILE_PRIVATE */
 284
 285 #endif /* __LIBCFS_TRACEFILE_H__ */