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>
43 CFS_TCD_TYPE_PROC = 0,
47 } cfs_trace_buf_type_t;
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 void cfs_trace_free_string_buffer(char *str, int nob);
87 int cfs_trace_dump_debug_buffer_usrstr(void __user *usr_str, int usr_str_nob);
88 int cfs_trace_daemon_command(char *str);
89 int cfs_trace_daemon_command_usrstr(void __user *usr_str, int usr_str_nob);
90 int cfs_trace_set_debug_mb(int mb);
91 int cfs_trace_set_debug_mb_usrstr(void __user *usr_str, int usr_str_nob);
92 int cfs_trace_get_debug_mb(void);
94 extern void libcfs_debug_dumplog_internal(void *arg);
95 extern void libcfs_register_panic_notifier(void);
96 extern void libcfs_unregister_panic_notifier(void);
97 extern int libcfs_panic_in_progress;
98 extern int cfs_trace_max_debug_mb(void);
100 extern struct mutex cfs_trace_thread_mutex;
101 extern struct rw_semaphore cfs_tracefile_sem;
103 #define TCD_MAX_PAGES (5 << (20 - PAGE_CACHE_SHIFT))
104 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
105 #define CFS_TRACEFILE_SIZE (500 << 20)
107 #ifdef LUSTRE_TRACEFILE_PRIVATE
110 * Private declare for tracefile
112 #define TCD_MAX_PAGES (5 << (20 - PAGE_CACHE_SHIFT))
113 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
115 #define CFS_TRACEFILE_SIZE (500 << 20)
117 /* Size of a buffer for sprinting console messages if we can't get a page
119 #define CFS_TRACE_CONSOLE_BUFFER_SIZE 1024
121 union cfs_trace_data_union {
122 struct cfs_trace_cpu_data {
124 * Even though this structure is meant to be per-CPU, locking
125 * is needed because in some places the data may be accessed
126 * from other CPUs. This lock is directly used in trace_get_tcd
127 * and trace_put_tcd, which are called in libcfs_debug_vmsg2 and
128 * tcd_for_each_type_lock
131 unsigned long tcd_lock_flags;
134 * pages with trace records not yet processed by tracefiled.
136 struct list_head tcd_pages;
137 /* number of pages on ->tcd_pages */
138 unsigned long tcd_cur_pages;
141 * pages with trace records already processed by
142 * tracefiled. These pages are kept in memory, so that some
143 * portion of log can be written in the event of LBUG. This
144 * list is maintained in LRU order.
146 * Pages are moved to ->tcd_daemon_pages by tracefiled()
147 * (put_pages_on_daemon_list()). LRU pages from this list are
148 * discarded when list grows too large.
150 struct list_head tcd_daemon_pages;
151 /* number of pages on ->tcd_daemon_pages */
152 unsigned long tcd_cur_daemon_pages;
155 * Maximal number of pages allowed on ->tcd_pages and
156 * ->tcd_daemon_pages each.
157 * Always TCD_MAX_PAGES * tcd_pages_factor / 100 in current
160 unsigned long tcd_max_pages;
163 * preallocated pages to write trace records into. Pages from
164 * ->tcd_stock_pages are moved to ->tcd_pages by
165 * portals_debug_msg().
167 * This list is necessary, because on some platforms it's
168 * impossible to perform efficient atomic page allocation in a
169 * non-blockable context.
171 * Such platforms fill ->tcd_stock_pages "on occasion", when
172 * tracing code is entered in blockable context.
174 * trace_get_tage_try() tries to get a page from
175 * ->tcd_stock_pages first and resorts to atomic page
176 * allocation only if this queue is empty. ->tcd_stock_pages
177 * is replenished when tracing code is entered in blocking
178 * context (darwin-tracefile.c:trace_get_tcd()). We try to
179 * maintain TCD_STOCK_PAGES (40 by default) pages in this
180 * queue. Atomic allocation is only required if more than
181 * TCD_STOCK_PAGES pagesful are consumed by trace records all
182 * emitted in non-blocking contexts. Which is quite unlikely.
184 struct list_head tcd_stock_pages;
185 /* number of pages on ->tcd_stock_pages */
186 unsigned long tcd_cur_stock_pages;
188 unsigned short tcd_shutting_down;
189 unsigned short tcd_cpu;
190 unsigned short tcd_type;
191 /* The factors to share debug memory. */
192 unsigned short tcd_pages_factor;
194 char __pad[L1_CACHE_ALIGN(sizeof(struct cfs_trace_cpu_data))];
197 #define TCD_MAX_TYPES 8
198 extern union cfs_trace_data_union (*cfs_trace_data[TCD_MAX_TYPES])[NR_CPUS];
200 #define cfs_tcd_for_each(tcd, i, j) \
201 for (i = 0; cfs_trace_data[i] != NULL; i++) \
202 for (j = 0, ((tcd) = &(*cfs_trace_data[i])[j].tcd); \
203 j < num_possible_cpus(); \
204 j++, (tcd) = &(*cfs_trace_data[i])[j].tcd)
206 #define cfs_tcd_for_each_type_lock(tcd, i, cpu) \
207 for (i = 0; cfs_trace_data[i] && \
208 (tcd = &(*cfs_trace_data[i])[cpu].tcd) && \
209 cfs_trace_lock_tcd(tcd, 1); cfs_trace_unlock_tcd(tcd, 1), i++)
211 /* XXX nikita: this declaration is internal to tracefile.c and should probably
213 struct page_collection {
214 struct list_head pc_pages;
216 * if this flag is set, collect_pages() will spill both
217 * ->tcd_daemon_pages and ->tcd_pages to the ->pc_pages. Otherwise,
218 * only ->tcd_pages are spilled.
220 int pc_want_daemon_pages;
223 /* XXX nikita: this declaration is internal to tracefile.c and should probably
225 struct tracefiled_ctl {
226 struct completion tctl_start;
227 struct completion tctl_stop;
228 wait_queue_head_t tctl_waitq;
230 atomic_t tctl_shutdown;
234 * small data-structure for each page owned by tracefiled.
236 /* XXX nikita: this declaration is internal to tracefile.c and should probably
238 struct cfs_trace_page {
244 * linkage into one of the lists in trace_data_union or
247 struct list_head linkage;
249 * number of bytes used within this page
253 * cpu that owns this page
257 * type(context) of this page
262 extern void cfs_set_ptldebug_header(struct ptldebug_header *header,
263 struct libcfs_debug_msg_data *m,
264 unsigned long stack);
265 extern void cfs_print_to_console(struct ptldebug_header *hdr, int mask,
266 const char *buf, int len, const char *file,
269 extern int cfs_trace_lock_tcd(struct cfs_trace_cpu_data *tcd, int walking);
270 extern void cfs_trace_unlock_tcd(struct cfs_trace_cpu_data *tcd, int walking);
272 extern char *cfs_trace_console_buffers[NR_CPUS][CFS_TCD_TYPE_MAX];
273 extern cfs_trace_buf_type_t cfs_trace_buf_idx_get(void);
275 static inline char *cfs_trace_get_console_buffer(void)
277 unsigned int i = get_cpu();
278 unsigned int j = cfs_trace_buf_idx_get();
280 return cfs_trace_console_buffers[i][j];
284 cfs_trace_put_console_buffer(char *buffer)
289 static inline struct cfs_trace_cpu_data *cfs_trace_get_tcd(void)
291 struct cfs_trace_cpu_data *tcd =
292 &(*cfs_trace_data[cfs_trace_buf_idx_get()])[get_cpu()].tcd;
294 cfs_trace_lock_tcd(tcd, 0);
299 static inline void cfs_trace_put_tcd(struct cfs_trace_cpu_data *tcd)
301 cfs_trace_unlock_tcd(tcd, 0);
305 int cfs_trace_refill_stock(struct cfs_trace_cpu_data *tcd, gfp_t gfp,
306 struct list_head *stock);
309 int cfs_tcd_owns_tage(struct cfs_trace_cpu_data *tcd,
310 struct cfs_trace_page *tage);
312 extern void cfs_trace_assertion_failed(const char *str,
313 struct libcfs_debug_msg_data *m);
315 /* ASSERTION that is safe to use within the debug system */
316 #define __LASSERT(cond) \
318 if (unlikely(!(cond))) { \
319 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL); \
320 cfs_trace_assertion_failed("ASSERTION("#cond") failed", \
325 #define __LASSERT_TAGE_INVARIANT(tage) \
327 __LASSERT(tage != NULL); \
328 __LASSERT(tage->page != NULL); \
329 __LASSERT(tage->used <= PAGE_CACHE_SIZE); \
330 __LASSERT(page_count(tage->page) > 0); \
333 #endif /* LUSTRE_TRACEFILE_PRIVATE */
335 #endif /* __LIBCFS_TRACEFILE_H__ */