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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 #ifndef __LIBCFS_TRACEFILE_H__
34 #define __LIBCFS_TRACEFILE_H__
36 #include <libcfs/libcfs.h>
38 enum cfs_trace_buf_type {
39 CFS_TCD_TYPE_PROC = 0,
45 #define TRACEFILE_NAME_SIZE 1024
46 extern char cfs_tracefile[TRACEFILE_NAME_SIZE];
47 extern long long cfs_tracefile_size;
50 * The path of debug log dump upcall script.
52 extern char lnet_debug_log_upcall[1024];
54 extern void libcfs_run_debug_log_upcall(char *file);
56 int cfs_tracefile_init_arch(void);
57 void cfs_tracefile_fini_arch(void);
59 int cfs_tracefile_dump_all_pages(char *filename);
60 void cfs_trace_debug_print(void);
61 void cfs_trace_flush_pages(void);
62 int cfs_trace_start_thread(void);
63 void cfs_trace_stop_thread(void);
64 int cfs_tracefile_init(int max_pages);
65 void cfs_tracefile_exit(void);
69 int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
70 const char __user *usr_buffer, int usr_buffer_nob);
71 int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
72 const char *knl_str, char *append);
73 int cfs_trace_allocate_string_buffer(char **str, int nob);
74 int cfs_trace_dump_debug_buffer_usrstr(void __user *usr_str, int usr_str_nob);
75 int cfs_trace_daemon_command(char *str);
76 int cfs_trace_daemon_command_usrstr(void __user *usr_str, int usr_str_nob);
77 int cfs_trace_set_debug_mb(int mb);
78 int cfs_trace_get_debug_mb(void);
80 extern void libcfs_debug_dumplog_internal(void *arg);
81 extern void libcfs_register_panic_notifier(void);
82 extern void libcfs_unregister_panic_notifier(void);
83 extern int libcfs_panic_in_progress;
85 #define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
86 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
87 #define CFS_TRACEFILE_SIZE (500 << 20)
89 #ifdef LUSTRE_TRACEFILE_PRIVATE
92 * Private declare for tracefile
94 #define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
95 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
97 #define CFS_TRACEFILE_SIZE (500 << 20)
99 /* Size of a buffer for sprinting console messages if we can't get a page
101 #define CFS_TRACE_CONSOLE_BUFFER_SIZE 1024
103 union cfs_trace_data_union {
104 struct cfs_trace_cpu_data {
106 * Even though this structure is meant to be per-CPU, locking
107 * is needed because in some places the data may be accessed
108 * from other CPUs. This lock is directly used in trace_get_tcd
109 * and trace_put_tcd, which are called in libcfs_debug_msg and
110 * tcd_for_each_type_lock
113 unsigned long tcd_lock_flags;
116 * pages with trace records not yet processed by tracefiled.
118 struct list_head tcd_pages;
119 /* number of pages on ->tcd_pages */
120 unsigned long tcd_cur_pages;
123 * pages with trace records already processed by
124 * tracefiled. These pages are kept in memory, so that some
125 * portion of log can be written in the event of LBUG. This
126 * list is maintained in LRU order.
128 * Pages are moved to ->tcd_daemon_pages by tracefiled()
129 * (put_pages_on_daemon_list()). LRU pages from this list are
130 * discarded when list grows too large.
132 struct list_head tcd_daemon_pages;
133 /* number of pages on ->tcd_daemon_pages */
134 unsigned long tcd_cur_daemon_pages;
137 * Maximal number of pages allowed on ->tcd_pages and
138 * ->tcd_daemon_pages each.
139 * Always TCD_MAX_PAGES * tcd_pages_factor / 100 in current
142 unsigned long tcd_max_pages;
145 * preallocated pages to write trace records into. Pages from
146 * ->tcd_stock_pages are moved to ->tcd_pages by
147 * portals_debug_msg().
149 * This list is necessary, because on some platforms it's
150 * impossible to perform efficient atomic page allocation in a
151 * non-blockable context.
153 * Such platforms fill ->tcd_stock_pages "on occasion", when
154 * tracing code is entered in blockable context.
156 * trace_get_tage_try() tries to get a page from
157 * ->tcd_stock_pages first and resorts to atomic page
158 * allocation only if this queue is empty. ->tcd_stock_pages
159 * is replenished when tracing code is entered in blocking
160 * context (darwin-tracefile.c:trace_get_tcd()). We try to
161 * maintain TCD_STOCK_PAGES (40 by default) pages in this
162 * queue. Atomic allocation is only required if more than
163 * TCD_STOCK_PAGES pagesful are consumed by trace records all
164 * emitted in non-blocking contexts. Which is quite unlikely.
166 struct list_head tcd_stock_pages;
167 /* number of pages on ->tcd_stock_pages */
168 unsigned long tcd_cur_stock_pages;
170 unsigned short tcd_shutting_down;
171 unsigned short tcd_cpu;
172 unsigned short tcd_type;
173 /* The factors to share debug memory. */
174 unsigned short tcd_pages_factor;
176 char __pad[L1_CACHE_ALIGN(sizeof(struct cfs_trace_cpu_data))];
179 #define TCD_MAX_TYPES 8
180 extern union cfs_trace_data_union (*cfs_trace_data[TCD_MAX_TYPES])[NR_CPUS];
182 #define cfs_tcd_for_each(tcd, i, j) \
183 for (i = 0; cfs_trace_data[i] != NULL; i++) \
184 for (j = 0, ((tcd) = &(*cfs_trace_data[i])[j].tcd); \
185 j < num_possible_cpus(); \
186 j++, (tcd) = &(*cfs_trace_data[i])[j].tcd)
188 /* XXX nikita: this declaration is internal to tracefile.c and should probably
190 struct page_collection {
191 struct list_head pc_pages;
193 * if this flag is set, collect_pages() will spill both
194 * ->tcd_daemon_pages and ->tcd_pages to the ->pc_pages. Otherwise,
195 * only ->tcd_pages are spilled.
197 int pc_want_daemon_pages;
200 /* XXX nikita: this declaration is internal to tracefile.c and should probably
202 struct tracefiled_ctl {
203 struct completion tctl_start;
204 struct completion tctl_stop;
205 wait_queue_head_t tctl_waitq;
207 atomic_t tctl_shutdown;
211 * small data-structure for each page owned by tracefiled.
213 /* XXX nikita: this declaration is internal to tracefile.c and should probably
215 struct cfs_trace_page {
221 * linkage into one of the lists in trace_data_union or
224 struct list_head linkage;
226 * number of bytes used within this page
230 * cpu that owns this page
234 * type(context) of this page
239 extern void cfs_set_ptldebug_header(struct ptldebug_header *header,
240 struct libcfs_debug_msg_data *m,
241 unsigned long stack);
242 extern void cfs_print_to_console(struct ptldebug_header *hdr, int mask,
243 const char *buf, int len, const char *file,
246 extern char *cfs_trace_console_buffers[NR_CPUS][CFS_TCD_TYPE_MAX];
247 extern enum cfs_trace_buf_type cfs_trace_buf_idx_get(void);
249 static inline char *cfs_trace_get_console_buffer(void)
251 unsigned int i = get_cpu();
252 unsigned int j = cfs_trace_buf_idx_get();
254 return cfs_trace_console_buffers[i][j];
257 int cfs_trace_refill_stock(struct cfs_trace_cpu_data *tcd, gfp_t gfp,
258 struct list_head *stock);
261 int cfs_tcd_owns_tage(struct cfs_trace_cpu_data *tcd,
262 struct cfs_trace_page *tage);
264 extern void cfs_trace_assertion_failed(const char *str,
265 struct libcfs_debug_msg_data *m);
267 /* ASSERTION that is safe to use within the debug system */
268 #define __LASSERT(cond) \
270 if (unlikely(!(cond))) { \
271 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL); \
272 cfs_trace_assertion_failed("ASSERTION("#cond") failed", \
277 #define __LASSERT_TAGE_INVARIANT(tage) \
279 __LASSERT(tage != NULL); \
280 __LASSERT(tage->page != NULL); \
281 __LASSERT(tage->used <= PAGE_SIZE); \
282 __LASSERT(page_count(tage->page) > 0); \
285 #endif /* LUSTRE_TRACEFILE_PRIVATE */
287 #endif /* __LIBCFS_TRACEFILE_H__ */