1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #ifndef __LIBCFS_TRACEFILE_H__
38 #define __LIBCFS_TRACEFILE_H__
40 #include <libcfs/libcfs.h>
42 /* trace file lock routines */
44 #define TRACEFILE_NAME_SIZE 1024
45 extern char tracefile[TRACEFILE_NAME_SIZE];
46 extern long long tracefile_size;
48 extern void libcfs_run_debug_log_upcall(char *file);
50 int tracefile_init_arch(void);
51 void tracefile_fini_arch(void);
53 void tracefile_read_lock(void);
54 void tracefile_read_unlock(void);
55 void tracefile_write_lock(void);
56 void tracefile_write_unlock(void);
58 int tracefile_dump_all_pages(char *filename);
59 void trace_debug_print(void);
60 void trace_flush_pages(void);
61 int trace_start_thread(void);
62 void trace_stop_thread(void);
63 int tracefile_init(int max_pages);
64 void tracefile_exit(void);
68 int trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
69 const char *usr_buffer, int usr_buffer_nob);
70 int trace_copyout_string(char *usr_buffer, int usr_buffer_nob,
71 const char *knl_str, char *append);
72 int trace_allocate_string_buffer(char **str, int nob);
73 void trace_free_string_buffer(char *str, int nob);
74 int trace_dump_debug_buffer_usrstr(void *usr_str, int usr_str_nob);
75 int trace_daemon_command(char *str);
76 int trace_daemon_command_usrstr(void *usr_str, int usr_str_nob);
77 int trace_set_debug_mb(int mb);
78 int trace_set_debug_mb_usrstr(void *usr_str, int usr_str_nob);
79 int trace_get_debug_mb(void);
81 extern void libcfs_debug_dumplog_internal(void *arg);
82 extern void libcfs_register_panic_notifier(void);
83 extern void libcfs_unregister_panic_notifier(void);
84 extern int libcfs_panic_in_progress;
85 extern int trace_max_debug_mb(void);
87 #define TCD_MAX_PAGES (5 << (20 - CFS_PAGE_SHIFT))
88 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
89 #define TRACEFILE_SIZE (500 << 20)
91 #ifdef LUSTRE_TRACEFILE_PRIVATE
94 * Private declare for tracefile
96 #define TCD_MAX_PAGES (5 << (20 - CFS_PAGE_SHIFT))
97 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
99 #define TRACEFILE_SIZE (500 << 20)
101 /* Size of a buffer for sprinting console messages if we can't get a page
103 #define TRACE_CONSOLE_BUFFER_SIZE 1024
105 union trace_data_union {
106 struct trace_cpu_data {
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_vmsg2 and
112 * tcd_for_each_type_lock
115 unsigned long tcd_lock_flags;
118 * pages with trace records not yet processed by tracefiled.
120 struct list_head tcd_pages;
121 /* number of pages on ->tcd_pages */
122 unsigned long tcd_cur_pages;
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.
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.
134 struct list_head tcd_daemon_pages;
135 /* number of pages on ->tcd_daemon_pages */
136 unsigned long tcd_cur_daemon_pages;
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
144 unsigned long tcd_max_pages;
147 * preallocated pages to write trace records into. Pages from
148 * ->tcd_stock_pages are moved to ->tcd_pages by
149 * portals_debug_msg().
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.
155 * Such platforms fill ->tcd_stock_pages "on occasion", when
156 * tracing code is entered in blockable context.
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.
168 struct list_head tcd_stock_pages;
169 /* number of pages on ->tcd_stock_pages */
170 unsigned long tcd_cur_stock_pages;
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;
178 char __pad[L1_CACHE_ALIGN(sizeof(struct trace_cpu_data))];
181 #define TCD_MAX_TYPES 8
182 extern union trace_data_union (*trace_data[TCD_MAX_TYPES])[NR_CPUS];
184 #define tcd_for_each(tcd, i, j) \
185 for (i = 0; trace_data[i] != NULL; i++) \
186 for (j = 0, ((tcd) = &(*trace_data[i])[j].tcd); \
187 j < num_possible_cpus(); j++, (tcd) = &(*trace_data[i])[j].tcd)
189 #define tcd_for_each_type_lock(tcd, i, cpu) \
190 for (i = 0; trace_data[i] && \
191 (tcd = &(*trace_data[i])[cpu].tcd) && \
192 trace_lock_tcd(tcd); trace_unlock_tcd(tcd), i++)
194 /* XXX nikita: this declaration is internal to tracefile.c and should probably
196 struct page_collection {
197 struct list_head pc_pages;
199 * spin-lock protecting ->pc_pages. It is taken by smp_call_function()
200 * call-back functions. XXX nikita: Which is horrible: all processors
201 * receive NMI at the same time only to be serialized by this
202 * lock. Probably ->pc_pages should be replaced with an array of
203 * NR_CPUS elements accessed locklessly.
207 * if this flag is set, collect_pages() will spill both
208 * ->tcd_daemon_pages and ->tcd_pages to the ->pc_pages. Otherwise,
209 * only ->tcd_pages are spilled.
211 int pc_want_daemon_pages;
214 /* XXX nikita: this declaration is internal to tracefile.c and should probably
216 struct tracefiled_ctl {
217 struct completion tctl_start;
218 struct completion tctl_stop;
219 cfs_waitq_t tctl_waitq;
221 atomic_t tctl_shutdown;
225 * small data-structure for each page owned by tracefiled.
227 /* XXX nikita: this declaration is internal to tracefile.c and should probably
235 * linkage into one of the lists in trace_data_union or
238 struct list_head linkage;
240 * number of bytes used within this page
244 * cpu that owns this page
248 * type(context) of this page
253 extern void set_ptldebug_header(struct ptldebug_header *header,
254 int subsys, int mask, const int line,
255 unsigned long stack);
256 extern void print_to_console(struct ptldebug_header *hdr, int mask, const char *buf,
257 int len, const char *file, const char *fn);
259 extern struct trace_cpu_data *trace_get_tcd(void);
260 extern void trace_put_tcd(struct trace_cpu_data *tcd);
261 extern int trace_lock_tcd(struct trace_cpu_data *tcd);
262 extern void trace_unlock_tcd(struct trace_cpu_data *tcd);
263 extern char *trace_get_console_buffer(void);
264 extern void trace_put_console_buffer(char *buffer);
266 int trace_refill_stock(struct trace_cpu_data *tcd, int gfp,
267 struct list_head *stock);
270 int tcd_owns_tage(struct trace_cpu_data *tcd, struct trace_page *tage);
272 extern void trace_assertion_failed(const char *str, const char *fn,
273 const char *file, int line);
275 /* ASSERTION that is safe to use within the debug system */
276 #define __LASSERT(cond) \
278 if (unlikely(!(cond))) { \
279 trace_assertion_failed("ASSERTION("#cond") failed", \
280 __FUNCTION__, __FILE__, __LINE__); \
284 #define __LASSERT_TAGE_INVARIANT(tage) \
286 __LASSERT(tage != NULL); \
287 __LASSERT(tage->page != NULL); \
288 __LASSERT(tage->used <= CFS_PAGE_SIZE); \
289 __LASSERT(cfs_page_count(tage->page) > 0); \
292 #endif /* LUSTRE_TRACEFILE_PRIVATE */
294 #endif /* __LIBCFS_TRACEFILE_H__ */