lnet/libcfs/tracefile.h

   1 #ifndef __LIBCFS_TRACEFILE_H__
   2 #define __LIBCFS_TRACEFILE_H__
   3
   4 #include <libcfs/libcfs.h>
   5
   6 /* trace file lock routines */
   7
   8 #define TRACEFILE_NAME_SIZE 1024
   9 extern char      tracefile[TRACEFILE_NAME_SIZE];
  10 extern long long tracefile_size;
  11
  12 int  tracefile_init_arch(void);
  13 void tracefile_fini_arch(void);
  14
  15 void tracefile_read_lock(void);
  16 void tracefile_read_unlock(void);
  17 void tracefile_write_lock(void);
  18 void tracefile_write_unlock(void);
  19
  20 int tracefile_dump_all_pages(char *filename);
  21 void trace_debug_print(void);
  22 void trace_flush_pages(void);
  23 int trace_start_thread(void);
  24 void trace_stop_thread(void);
  25 int tracefile_init(void);
  26 void tracefile_exit(void);
  27
  28
  29
  30 int trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
  31                         const char *usr_buffer, int usr_buffer_nob);
  32 int trace_copyout_string(char *usr_buffer, int usr_buffer_nob,
  33                          const char *knl_str, char *append);
  34 int trace_allocate_string_buffer(char **str, int nob);
  35 void trace_free_string_buffer(char *str, int nob);
  36 int trace_dump_debug_buffer_usrstr(void *usr_str, int usr_str_nob);
  37 int trace_daemon_command(char *str);
  38 int trace_daemon_command_usrstr(void *usr_str, int usr_str_nob);
  39 int trace_set_debug_mb(int mb);
  40 int trace_set_debug_mb_usrstr(void *usr_str, int usr_str_nob);
  41 int trace_get_debug_mb(void);
  42
  43 extern void libcfs_debug_dumplog_internal(void *arg);
  44 extern void libcfs_register_panic_notifier(void);
  45 extern void libcfs_unregister_panic_notifier(void);
  46 extern int  libcfs_panic_in_progress;
  47
  48 #ifdef LUSTRE_TRACEFILE_PRIVATE
  49
  50 /*
  51  * Private declare for tracefile
  52  */
  53 #define TCD_MAX_PAGES (5 << (20 - CFS_PAGE_SHIFT))
  54 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
  55
  56 #define TRACEFILE_SIZE (500 << 20)
  57
  58 /* Size of a buffer for sprinting console messages to in IRQ context (no
  59  * logging in IRQ context) */
  60 #define TRACE_CONSOLE_BUFFER_SIZE   1024
  61
  62 union trace_data_union {
  63         struct trace_cpu_data {
  64                 /*
  65                  * pages with trace records not yet processed by tracefiled.
  66                  */
  67                 struct list_head        tcd_pages;
  68                 /* number of pages on ->tcd_pages */
  69                 unsigned long           tcd_cur_pages;
  70
  71                 /*
  72                  * pages with trace records already processed by
  73                  * tracefiled. These pages are kept in memory, so that some
  74                  * portion of log can be written in the event of LBUG. This
  75                  * list is maintained in LRU order.
  76                  *
  77                  * Pages are moved to ->tcd_daemon_pages by tracefiled()
  78                  * (put_pages_on_daemon_list()). LRU pages from this list are
  79                  * discarded when list grows too large.
  80                  */
  81                 struct list_head        tcd_daemon_pages;
  82                 /* number of pages on ->tcd_daemon_pages */
  83                 unsigned long           tcd_cur_daemon_pages;
  84
  85                 /*
  86                  * Maximal number of pages allowed on ->tcd_pages and
  87                  * ->tcd_daemon_pages each. Always TCD_MAX_PAGES in current
  88                  * implementation.
  89                  */
  90                 unsigned long           tcd_max_pages;
  91
  92                 /*
  93                  * preallocated pages to write trace records into. Pages from
  94                  * ->tcd_stock_pages are moved to ->tcd_pages by
  95                  * portals_debug_msg().
  96                  *
  97                  * This list is necessary, because on some platforms it's
  98                  * impossible to perform efficient atomic page allocation in a
  99                  * non-blockable context.
 100                  *
 101                  * Such platforms fill ->tcd_stock_pages "on occasion", when
 102                  * tracing code is entered in blockable context.
 103                  *
 104                  * trace_get_tage_try() tries to get a page from
 105                  * ->tcd_stock_pages first and resorts to atomic page
 106                  * allocation only if this queue is empty. ->tcd_stock_pages
 107                  * is replenished when tracing code is entered in blocking
 108                  * context (darwin-tracefile.c:trace_get_tcd()). We try to
 109                  * maintain TCD_STOCK_PAGES (40 by default) pages in this
 110                  * queue. Atomic allocation is only required if more than
 111                  * TCD_STOCK_PAGES pagesful are consumed by trace records all
 112                  * emitted in non-blocking contexts. Which is quite unlikely.
 113                  */
 114                 struct list_head        tcd_stock_pages;
 115                 /* number of pages on ->tcd_stock_pages */
 116                 unsigned long           tcd_cur_stock_pages;
 117
 118                 int                     tcd_shutting_down;
 119                 int                     tcd_cpu;
 120         } tcd;
 121         char __pad[SMP_CACHE_BYTES];
 122 };
 123
 124 /* XXX nikita: this declaration is internal to tracefile.c and should probably
 125  * be moved there */
 126 struct page_collection {
 127         struct list_head        pc_pages;
 128         /*
 129          * spin-lock protecting ->pc_pages. It is taken by smp_call_function()
 130          * call-back functions. XXX nikita: Which is horrible: all processors
 131          * receive NMI at the same time only to be serialized by this
 132          * lock. Probably ->pc_pages should be replaced with an array of
 133          * NR_CPUS elements accessed locklessly.
 134          */
 135         spinlock_t              pc_lock;
 136         /*
 137          * if this flag is set, collect_pages() will spill both
 138          * ->tcd_daemon_pages and ->tcd_pages to the ->pc_pages. Otherwise,
 139          * only ->tcd_pages are spilled.
 140          */
 141         int                     pc_want_daemon_pages;
 142 };
 143
 144 /* XXX nikita: this declaration is internal to tracefile.c and should probably
 145  * be moved there */
 146 struct tracefiled_ctl {
 147         struct completion       tctl_start;
 148         struct completion       tctl_stop;
 149         cfs_waitq_t             tctl_waitq;
 150         pid_t                   tctl_pid;
 151         atomic_t                tctl_shutdown;
 152 };
 153
 154 /*
 155  * small data-structure for each page owned by tracefiled.
 156  */
 157 /* XXX nikita: this declaration is internal to tracefile.c and should probably
 158  * be moved there */
 159 struct trace_page {
 160         /*
 161          * page itself
 162          */
 163         cfs_page_t      *page;
 164         /*
 165          * linkage into one of the lists in trace_data_union or
 166          * page_collection
 167          */
 168         struct list_head linkage;
 169         /*
 170          * number of bytes used within this page
 171          */
 172         unsigned int     used;
 173         /*
 174          * cpu that owns this page
 175          */
 176         int              cpu;
 177 };
 178
 179 extern void set_ptldebug_header(struct ptldebug_header *header,
 180                            int subsys, int mask, const int line,
 181                            unsigned long stack);
 182 extern void print_to_console(struct ptldebug_header *hdr, int mask, const char *buf,
 183                              int len, const char *file, const char *fn);
 184
 185 extern struct trace_cpu_data *trace_get_tcd(void);
 186 extern void trace_put_tcd(struct trace_cpu_data *tcd);
 187 extern char *trace_get_console_buffer(void);
 188 extern void trace_put_console_buffer(char *buffer);
 189
 190 extern void trace_call_on_all_cpus(void (*fn)(void *arg), void *arg);
 191
 192 extern int  trace_max_debug_mb(void);
 193
 194 int trace_refill_stock(struct trace_cpu_data *tcd, int gfp,
 195                        struct list_head *stock);
 196
 197
 198 int tcd_owns_tage(struct trace_cpu_data *tcd, struct trace_page *tage);
 199
 200 extern void trace_assertion_failed(const char *str, const char *fn,
 201                                    const char *file, int line);
 202
 203 /* ASSERTION that is safe to use within the debug system */
 204 #define __LASSERT(cond)                                                         \
 205 ({                                                                              \
 206         if (unlikely(!(cond))) {                                                \
 207                 trace_assertion_failed("ASSERTION("#cond") failed",             \
 208                                        __FUNCTION__, __FILE__, __LINE__);       \
 209         }                                                                       \
 210 })
 211
 212 #define __LASSERT_TAGE_INVARIANT(tage)                  \
 213 ({                                                      \
 214         __LASSERT(tage != NULL);                        \
 215         __LASSERT(tage->page != NULL);                  \
 216         __LASSERT(tage->used <= CFS_PAGE_SIZE);         \
 217         __LASSERT(cfs_page_count(tage->page) > 0);      \
 218 })
 219
 220 #endif  /* LUSTRE_TRACEFILE_PRIVATE */
 221
 222 #endif /* __LIBCFS_TRACEFILE_H__ */