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_dump_all_pages(char *filename);
57 void cfs_trace_debug_print(void);
58 void cfs_trace_flush_pages(void);
59 int cfs_trace_start_thread(void);
60 void cfs_trace_stop_thread(void);
61 int cfs_tracefile_init(int max_pages);
62 void cfs_tracefile_exit(void);
66 int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
67 const char __user *usr_buffer, int usr_buffer_nob);
68 int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
69 const char *knl_str, char *append);
70 int cfs_trace_allocate_string_buffer(char **str, int nob);
71 int cfs_trace_dump_debug_buffer_usrstr(void __user *usr_str, int usr_str_nob);
72 int cfs_trace_daemon_command(char *str);
73 int cfs_trace_daemon_command_usrstr(void __user *usr_str, int usr_str_nob);
74 int cfs_trace_set_debug_mb(int mb);
75 int cfs_trace_get_debug_mb(void);
77 extern void libcfs_debug_dumplog_internal(void *arg);
78 extern int libcfs_panic_in_progress;
80 #define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
81 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
82 #define CFS_TRACEFILE_SIZE (500 << 20)
84 #ifdef LUSTRE_TRACEFILE_PRIVATE
87 * Private declare for tracefile
89 #define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
90 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
92 #define CFS_TRACEFILE_SIZE (500 << 20)
94 /* Size of a buffer for sprinting console messages if we can't get a page
96 #define CFS_TRACE_CONSOLE_BUFFER_SIZE 1024
98 union cfs_trace_data_union {
99 struct cfs_trace_cpu_data {
101 * Even though this structure is meant to be per-CPU, locking
102 * is needed because in some places the data may be accessed
103 * from other CPUs. This lock is directly used in trace_get_tcd
104 * and trace_put_tcd, which are called in libcfs_debug_msg and
105 * tcd_for_each_type_lock
108 unsigned long tcd_lock_flags;
111 * pages with trace records not yet processed by tracefiled.
113 struct list_head tcd_pages;
114 /* number of pages on ->tcd_pages */
115 unsigned long tcd_cur_pages;
118 * pages with trace records already processed by
119 * tracefiled. These pages are kept in memory, so that some
120 * portion of log can be written in the event of LBUG. This
121 * list is maintained in LRU order.
123 * Pages are moved to ->tcd_daemon_pages by tracefiled()
124 * (put_pages_on_daemon_list()). LRU pages from this list are
125 * discarded when list grows too large.
127 struct list_head tcd_daemon_pages;
128 /* number of pages on ->tcd_daemon_pages */
129 unsigned long tcd_cur_daemon_pages;
132 * Maximal number of pages allowed on ->tcd_pages and
133 * ->tcd_daemon_pages each.
134 * Always TCD_MAX_PAGES * tcd_pages_factor / 100 in current
137 unsigned long tcd_max_pages;
140 * preallocated pages to write trace records into. Pages from
141 * ->tcd_stock_pages are moved to ->tcd_pages by
142 * portals_debug_msg().
144 * This list is necessary, because on some platforms it's
145 * impossible to perform efficient atomic page allocation in a
146 * non-blockable context.
148 * Such platforms fill ->tcd_stock_pages "on occasion", when
149 * tracing code is entered in blockable context.
151 * trace_get_tage_try() tries to get a page from
152 * ->tcd_stock_pages first and resorts to atomic page
153 * allocation only if this queue is empty. ->tcd_stock_pages
154 * is replenished when tracing code is entered in blocking
155 * context (darwin-tracefile.c:trace_get_tcd()). We try to
156 * maintain TCD_STOCK_PAGES (40 by default) pages in this
157 * queue. Atomic allocation is only required if more than
158 * TCD_STOCK_PAGES pagesful are consumed by trace records all
159 * emitted in non-blocking contexts. Which is quite unlikely.
161 struct list_head tcd_stock_pages;
162 /* number of pages on ->tcd_stock_pages */
163 unsigned long tcd_cur_stock_pages;
165 unsigned short tcd_shutting_down;
166 unsigned short tcd_cpu;
167 unsigned short tcd_type;
168 /* The factors to share debug memory. */
169 unsigned short tcd_pages_factor;
171 char __pad[L1_CACHE_ALIGN(sizeof(struct cfs_trace_cpu_data))];
174 /* XXX nikita: this declaration is internal to tracefile.c and should probably
176 struct page_collection {
177 struct list_head pc_pages;
179 * if this flag is set, collect_pages() will spill both
180 * ->tcd_daemon_pages and ->tcd_pages to the ->pc_pages. Otherwise,
181 * only ->tcd_pages are spilled.
183 int pc_want_daemon_pages;
186 /* XXX nikita: this declaration is internal to tracefile.c and should probably
188 struct tracefiled_ctl {
189 struct completion tctl_start;
190 struct completion tctl_stop;
191 wait_queue_head_t tctl_waitq;
193 atomic_t tctl_shutdown;
197 * small data-structure for each page owned by tracefiled.
199 /* XXX nikita: this declaration is internal to tracefile.c and should probably
201 struct cfs_trace_page {
207 * linkage into one of the lists in trace_data_union or
210 struct list_head linkage;
212 * number of bytes used within this page
216 * cpu that owns this page
220 * type(context) of this page
225 extern char *cfs_trace_console_buffers[NR_CPUS][CFS_TCD_TYPE_MAX];
226 extern enum cfs_trace_buf_type cfs_trace_buf_idx_get(void);
228 static inline char *cfs_trace_get_console_buffer(void)
230 unsigned int i = get_cpu();
231 unsigned int j = cfs_trace_buf_idx_get();
233 return cfs_trace_console_buffers[i][j];
236 int cfs_tcd_owns_tage(struct cfs_trace_cpu_data *tcd,
237 struct cfs_trace_page *tage);
239 extern void cfs_trace_assertion_failed(const char *str,
240 struct libcfs_debug_msg_data *m);
242 /* ASSERTION that is safe to use within the debug system */
243 #define __LASSERT(cond) \
245 if (unlikely(!(cond))) { \
246 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL); \
247 cfs_trace_assertion_failed("ASSERTION("#cond") failed", \
252 #define __LASSERT_TAGE_INVARIANT(tage) \
254 __LASSERT(tage != NULL); \
255 __LASSERT(tage->page != NULL); \
256 __LASSERT(tage->used <= PAGE_SIZE); \
257 __LASSERT(page_count(tage->page) > 0); \
260 #endif /* LUSTRE_TRACEFILE_PRIVATE */
262 #endif /* __LIBCFS_TRACEFILE_H__ */