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/
32 #ifndef __LIBCFS_TRACEFILE_H__
33 #define __LIBCFS_TRACEFILE_H__
35 #include <libcfs/libcfs.h>
37 #define TRACEFILE_NAME_SIZE 1024
38 extern char cfs_tracefile[TRACEFILE_NAME_SIZE];
39 extern long long cfs_tracefile_size;
42 * The path of debug log dump upcall script.
44 extern char lnet_debug_log_upcall[1024];
46 int cfs_tracefile_dump_all_pages(char *filename);
47 void cfs_trace_debug_print(void);
48 void cfs_trace_flush_pages(void);
49 int cfs_trace_start_thread(void);
50 void cfs_trace_stop_thread(void);
51 int cfs_tracefile_init(int max_pages);
52 void cfs_tracefile_exit(void);
56 int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
57 const char *knl_str, char *append);
58 int cfs_trace_dump_debug_buffer_usrstr(void __user *usr_str, int usr_str_nob);
59 int cfs_trace_daemon_command(char *str);
60 int cfs_trace_daemon_command_usrstr(void __user *usr_str, int usr_str_nob);
61 int cfs_trace_set_debug_mb(int mb);
62 int cfs_trace_get_debug_mb(void);
64 extern int libcfs_panic_in_progress;
66 #define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
67 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
68 #define CFS_TRACEFILE_SIZE (500 << 20)
70 union cfs_trace_data_union {
71 struct cfs_trace_cpu_data {
73 * Even though this structure is meant to be per-CPU, locking
74 * is needed because in some places the data may be accessed
75 * from other CPUs. This lock is directly used in trace_get_tcd
76 * and trace_put_tcd, which are called in libcfs_debug_msg and
77 * tcd_for_each_type_lock
80 unsigned long tcd_lock_flags;
83 * pages with trace records not yet processed by tracefiled.
85 struct list_head tcd_pages;
86 /* number of pages on ->tcd_pages */
87 unsigned long tcd_cur_pages;
90 * pages with trace records already processed by
91 * tracefiled. These pages are kept in memory, so that some
92 * portion of log can be written in the event of LBUG. This
93 * list is maintained in LRU order.
95 * Pages are moved to ->tcd_daemon_pages by tracefiled()
96 * (put_pages_on_daemon_list()). LRU pages from this list are
97 * discarded when list grows too large.
99 struct list_head tcd_daemon_pages;
100 /* number of pages on ->tcd_daemon_pages */
101 unsigned long tcd_cur_daemon_pages;
104 * Maximal number of pages allowed on ->tcd_pages and
105 * ->tcd_daemon_pages each.
106 * Always TCD_MAX_PAGES * tcd_pages_factor / 100 in current
109 unsigned long tcd_max_pages;
112 * preallocated pages to write trace records into. Pages from
113 * ->tcd_stock_pages are moved to ->tcd_pages by
114 * portals_debug_msg().
116 * This list is necessary, because on some platforms it's
117 * impossible to perform efficient atomic page allocation in a
118 * non-blockable context.
120 * Such platforms fill ->tcd_stock_pages "on occasion", when
121 * tracing code is entered in blockable context.
123 * trace_get_tage_try() tries to get a page from
124 * ->tcd_stock_pages first and resorts to atomic page
125 * allocation only if this queue is empty. ->tcd_stock_pages
126 * is replenished when tracing code is entered in blocking
127 * context (darwin-tracefile.c:trace_get_tcd()). We try to
128 * maintain TCD_STOCK_PAGES (40 by default) pages in this
129 * queue. Atomic allocation is only required if more than
130 * TCD_STOCK_PAGES pagesful are consumed by trace records all
131 * emitted in non-blocking contexts. Which is quite unlikely.
133 struct list_head tcd_stock_pages;
134 /* number of pages on ->tcd_stock_pages */
135 unsigned long tcd_cur_stock_pages;
137 unsigned short tcd_shutting_down;
138 unsigned short tcd_cpu;
139 unsigned short tcd_type;
140 /* The factors to share debug memory. */
141 unsigned short tcd_pages_factor;
143 char __pad[L1_CACHE_ALIGN(sizeof(struct cfs_trace_cpu_data))];
146 /* XXX nikita: this declaration is internal to tracefile.c and should probably
148 struct page_collection {
149 struct list_head pc_pages;
151 * if this flag is set, collect_pages() will spill both
152 * ->tcd_daemon_pages and ->tcd_pages to the ->pc_pages. Otherwise,
153 * only ->tcd_pages are spilled.
155 int pc_want_daemon_pages;
159 * small data-structure for each page owned by tracefiled.
161 /* XXX nikita: this declaration is internal to tracefile.c and should probably
163 struct cfs_trace_page {
169 * linkage into one of the lists in trace_data_union or
172 struct list_head linkage;
174 * number of bytes used within this page
178 * cpu that owns this page
182 * type(context) of this page
187 int cfs_tcd_owns_tage(struct cfs_trace_cpu_data *tcd,
188 struct cfs_trace_page *tage);
190 extern void cfs_trace_assertion_failed(const char *str,
191 struct libcfs_debug_msg_data *m);
193 /* ASSERTION that is safe to use within the debug system */
194 #define __LASSERT(cond) \
196 if (unlikely(!(cond))) { \
197 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL); \
198 cfs_trace_assertion_failed("ASSERTION("#cond") failed", \
203 #define __LASSERT_TAGE_INVARIANT(tage) \
205 __LASSERT(tage != NULL); \
206 __LASSERT(tage->page != NULL); \
207 __LASSERT(tage->used <= PAGE_SIZE); \
208 __LASSERT(page_count(tage->page) > 0); \
211 #endif /* __LIBCFS_TRACEFILE_H__ */