4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, 2014, Intel Corporation.
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 enum cfs_trace_buf_type {
43 CFS_TCD_TYPE_PROC = 0,
49 /* trace file lock routines */
51 #define TRACEFILE_NAME_SIZE 1024
52 extern char cfs_tracefile[TRACEFILE_NAME_SIZE];
53 extern long long cfs_tracefile_size;
55 extern char lnet_upcall[1024];
57 * The path of debug log dump upcall script.
59 extern char lnet_debug_log_upcall[1024];
61 extern void libcfs_run_debug_log_upcall(char *file);
63 int cfs_tracefile_init_arch(void);
64 void cfs_tracefile_fini_arch(void);
66 void cfs_tracefile_read_lock(void);
67 void cfs_tracefile_read_unlock(void);
68 void cfs_tracefile_write_lock(void);
69 void cfs_tracefile_write_unlock(void);
71 int cfs_tracefile_dump_all_pages(char *filename);
72 void cfs_trace_debug_print(void);
73 void cfs_trace_flush_pages(void);
74 int cfs_trace_start_thread(void);
75 void cfs_trace_stop_thread(void);
76 int cfs_tracefile_init(int max_pages);
77 void cfs_tracefile_exit(void);
81 int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
82 const char __user *usr_buffer, int usr_buffer_nob);
83 int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
84 const char *knl_str, char *append);
85 int cfs_trace_allocate_string_buffer(char **str, int nob);
86 int cfs_trace_dump_debug_buffer_usrstr(void __user *usr_str, int usr_str_nob);
87 int cfs_trace_daemon_command(char *str);
88 int cfs_trace_daemon_command_usrstr(void __user *usr_str, int usr_str_nob);
89 int cfs_trace_set_debug_mb(int mb);
90 int cfs_trace_set_debug_mb_usrstr(void __user *usr_str, int usr_str_nob);
91 int cfs_trace_get_debug_mb(void);
93 extern void libcfs_debug_dumplog_internal(void *arg);
94 extern void libcfs_register_panic_notifier(void);
95 extern void libcfs_unregister_panic_notifier(void);
96 extern int libcfs_panic_in_progress;
97 extern int cfs_trace_max_debug_mb(void);
99 #define TCD_MAX_PAGES (5 << (20 - PAGE_CACHE_SHIFT))
100 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
101 #define CFS_TRACEFILE_SIZE (500 << 20)
103 #ifdef LUSTRE_TRACEFILE_PRIVATE
106 * Private declare for tracefile
108 #define TCD_MAX_PAGES (5 << (20 - PAGE_CACHE_SHIFT))
109 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
111 #define CFS_TRACEFILE_SIZE (500 << 20)
113 /* Size of a buffer for sprinting console messages if we can't get a page
115 #define CFS_TRACE_CONSOLE_BUFFER_SIZE 1024
117 union cfs_trace_data_union {
118 struct cfs_trace_cpu_data {
120 * Even though this structure is meant to be per-CPU, locking
121 * is needed because in some places the data may be accessed
122 * from other CPUs. This lock is directly used in trace_get_tcd
123 * and trace_put_tcd, which are called in libcfs_debug_vmsg2 and
124 * tcd_for_each_type_lock
127 unsigned long tcd_lock_flags;
130 * pages with trace records not yet processed by tracefiled.
132 struct list_head tcd_pages;
133 /* number of pages on ->tcd_pages */
134 unsigned long tcd_cur_pages;
137 * pages with trace records already processed by
138 * tracefiled. These pages are kept in memory, so that some
139 * portion of log can be written in the event of LBUG. This
140 * list is maintained in LRU order.
142 * Pages are moved to ->tcd_daemon_pages by tracefiled()
143 * (put_pages_on_daemon_list()). LRU pages from this list are
144 * discarded when list grows too large.
146 struct list_head tcd_daemon_pages;
147 /* number of pages on ->tcd_daemon_pages */
148 unsigned long tcd_cur_daemon_pages;
151 * Maximal number of pages allowed on ->tcd_pages and
152 * ->tcd_daemon_pages each.
153 * Always TCD_MAX_PAGES * tcd_pages_factor / 100 in current
156 unsigned long tcd_max_pages;
159 * preallocated pages to write trace records into. Pages from
160 * ->tcd_stock_pages are moved to ->tcd_pages by
161 * portals_debug_msg().
163 * This list is necessary, because on some platforms it's
164 * impossible to perform efficient atomic page allocation in a
165 * non-blockable context.
167 * Such platforms fill ->tcd_stock_pages "on occasion", when
168 * tracing code is entered in blockable context.
170 * trace_get_tage_try() tries to get a page from
171 * ->tcd_stock_pages first and resorts to atomic page
172 * allocation only if this queue is empty. ->tcd_stock_pages
173 * is replenished when tracing code is entered in blocking
174 * context (darwin-tracefile.c:trace_get_tcd()). We try to
175 * maintain TCD_STOCK_PAGES (40 by default) pages in this
176 * queue. Atomic allocation is only required if more than
177 * TCD_STOCK_PAGES pagesful are consumed by trace records all
178 * emitted in non-blocking contexts. Which is quite unlikely.
180 struct list_head tcd_stock_pages;
181 /* number of pages on ->tcd_stock_pages */
182 unsigned long tcd_cur_stock_pages;
184 unsigned short tcd_shutting_down;
185 unsigned short tcd_cpu;
186 unsigned short tcd_type;
187 /* The factors to share debug memory. */
188 unsigned short tcd_pages_factor;
190 char __pad[L1_CACHE_ALIGN(sizeof(struct cfs_trace_cpu_data))];
193 #define TCD_MAX_TYPES 8
194 extern union cfs_trace_data_union (*cfs_trace_data[TCD_MAX_TYPES])[NR_CPUS];
196 #define cfs_tcd_for_each(tcd, i, j) \
197 for (i = 0; cfs_trace_data[i] != NULL; i++) \
198 for (j = 0, ((tcd) = &(*cfs_trace_data[i])[j].tcd); \
199 j < num_possible_cpus(); \
200 j++, (tcd) = &(*cfs_trace_data[i])[j].tcd)
202 #define cfs_tcd_for_each_type_lock(tcd, i, cpu) \
203 for (i = 0; cfs_trace_data[i] && \
204 (tcd = &(*cfs_trace_data[i])[cpu].tcd) && \
205 cfs_trace_lock_tcd(tcd, 1); cfs_trace_unlock_tcd(tcd, 1), i++)
207 /* XXX nikita: this declaration is internal to tracefile.c and should probably
209 struct page_collection {
210 struct list_head pc_pages;
212 * if this flag is set, collect_pages() will spill both
213 * ->tcd_daemon_pages and ->tcd_pages to the ->pc_pages. Otherwise,
214 * only ->tcd_pages are spilled.
216 int pc_want_daemon_pages;
219 /* XXX nikita: this declaration is internal to tracefile.c and should probably
221 struct tracefiled_ctl {
222 struct completion tctl_start;
223 struct completion tctl_stop;
224 wait_queue_head_t tctl_waitq;
226 atomic_t tctl_shutdown;
230 * small data-structure for each page owned by tracefiled.
232 /* XXX nikita: this declaration is internal to tracefile.c and should probably
234 struct cfs_trace_page {
240 * linkage into one of the lists in trace_data_union or
243 struct list_head linkage;
245 * number of bytes used within this page
249 * cpu that owns this page
253 * type(context) of this page
258 extern void cfs_set_ptldebug_header(struct ptldebug_header *header,
259 struct libcfs_debug_msg_data *m,
260 unsigned long stack);
261 extern void cfs_print_to_console(struct ptldebug_header *hdr, int mask,
262 const char *buf, int len, const char *file,
265 extern int cfs_trace_lock_tcd(struct cfs_trace_cpu_data *tcd, int walking);
266 extern void cfs_trace_unlock_tcd(struct cfs_trace_cpu_data *tcd, int walking);
268 extern char *cfs_trace_console_buffers[NR_CPUS][CFS_TCD_TYPE_MAX];
269 extern enum cfs_trace_buf_type cfs_trace_buf_idx_get(void);
271 static inline char *cfs_trace_get_console_buffer(void)
273 unsigned int i = get_cpu();
274 unsigned int j = cfs_trace_buf_idx_get();
276 return cfs_trace_console_buffers[i][j];
279 static inline struct cfs_trace_cpu_data *cfs_trace_get_tcd(void)
281 struct cfs_trace_cpu_data *tcd =
282 &(*cfs_trace_data[cfs_trace_buf_idx_get()])[get_cpu()].tcd;
284 cfs_trace_lock_tcd(tcd, 0);
289 static inline void cfs_trace_put_tcd(struct cfs_trace_cpu_data *tcd)
291 cfs_trace_unlock_tcd(tcd, 0);
295 int cfs_trace_refill_stock(struct cfs_trace_cpu_data *tcd, gfp_t gfp,
296 struct list_head *stock);
299 int cfs_tcd_owns_tage(struct cfs_trace_cpu_data *tcd,
300 struct cfs_trace_page *tage);
302 extern void cfs_trace_assertion_failed(const char *str,
303 struct libcfs_debug_msg_data *m);
305 /* ASSERTION that is safe to use within the debug system */
306 #define __LASSERT(cond) \
308 if (unlikely(!(cond))) { \
309 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL); \
310 cfs_trace_assertion_failed("ASSERTION("#cond") failed", \
315 #define __LASSERT_TAGE_INVARIANT(tage) \
317 __LASSERT(tage != NULL); \
318 __LASSERT(tage->page != NULL); \
319 __LASSERT(tage->used <= PAGE_CACHE_SIZE); \
320 __LASSERT(page_count(tage->page) > 0); \
323 #endif /* LUSTRE_TRACEFILE_PRIVATE */
325 #endif /* __LIBCFS_TRACEFILE_H__ */