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