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 #define TRACEFILE_NAME_SIZE 1024
39 extern char cfs_tracefile[TRACEFILE_NAME_SIZE];
40 extern long long cfs_tracefile_size;
43 * The path of debug log dump upcall script.
45 extern char lnet_debug_log_upcall[1024];
47 int cfs_tracefile_dump_all_pages(char *filename);
48 void cfs_trace_debug_print(void);
49 void cfs_trace_flush_pages(void);
50 int cfs_trace_start_thread(void);
51 void cfs_trace_stop_thread(void);
52 int cfs_tracefile_init(int max_pages);
53 void cfs_tracefile_exit(void);
57 int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
58 const char __user *usr_buffer, int usr_buffer_nob);
59 int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
60 const char *knl_str, char *append);
61 int cfs_trace_allocate_string_buffer(char **str, int nob);
62 int cfs_trace_dump_debug_buffer_usrstr(void __user *usr_str, int usr_str_nob);
63 int cfs_trace_daemon_command(char *str);
64 int cfs_trace_daemon_command_usrstr(void __user *usr_str, int usr_str_nob);
65 int cfs_trace_set_debug_mb(int mb);
66 int cfs_trace_get_debug_mb(void);
68 extern int libcfs_panic_in_progress;
70 #define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
71 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
72 #define CFS_TRACEFILE_SIZE (500 << 20)
74 union cfs_trace_data_union {
75 struct cfs_trace_cpu_data {
77 * Even though this structure is meant to be per-CPU, locking
78 * is needed because in some places the data may be accessed
79 * from other CPUs. This lock is directly used in trace_get_tcd
80 * and trace_put_tcd, which are called in libcfs_debug_msg and
81 * tcd_for_each_type_lock
84 unsigned long tcd_lock_flags;
87 * pages with trace records not yet processed by tracefiled.
89 struct list_head tcd_pages;
90 /* number of pages on ->tcd_pages */
91 unsigned long tcd_cur_pages;
94 * pages with trace records already processed by
95 * tracefiled. These pages are kept in memory, so that some
96 * portion of log can be written in the event of LBUG. This
97 * list is maintained in LRU order.
99 * Pages are moved to ->tcd_daemon_pages by tracefiled()
100 * (put_pages_on_daemon_list()). LRU pages from this list are
101 * discarded when list grows too large.
103 struct list_head tcd_daemon_pages;
104 /* number of pages on ->tcd_daemon_pages */
105 unsigned long tcd_cur_daemon_pages;
108 * Maximal number of pages allowed on ->tcd_pages and
109 * ->tcd_daemon_pages each.
110 * Always TCD_MAX_PAGES * tcd_pages_factor / 100 in current
113 unsigned long tcd_max_pages;
116 * preallocated pages to write trace records into. Pages from
117 * ->tcd_stock_pages are moved to ->tcd_pages by
118 * portals_debug_msg().
120 * This list is necessary, because on some platforms it's
121 * impossible to perform efficient atomic page allocation in a
122 * non-blockable context.
124 * Such platforms fill ->tcd_stock_pages "on occasion", when
125 * tracing code is entered in blockable context.
127 * trace_get_tage_try() tries to get a page from
128 * ->tcd_stock_pages first and resorts to atomic page
129 * allocation only if this queue is empty. ->tcd_stock_pages
130 * is replenished when tracing code is entered in blocking
131 * context (darwin-tracefile.c:trace_get_tcd()). We try to
132 * maintain TCD_STOCK_PAGES (40 by default) pages in this
133 * queue. Atomic allocation is only required if more than
134 * TCD_STOCK_PAGES pagesful are consumed by trace records all
135 * emitted in non-blocking contexts. Which is quite unlikely.
137 struct list_head tcd_stock_pages;
138 /* number of pages on ->tcd_stock_pages */
139 unsigned long tcd_cur_stock_pages;
141 unsigned short tcd_shutting_down;
142 unsigned short tcd_cpu;
143 unsigned short tcd_type;
144 /* The factors to share debug memory. */
145 unsigned short tcd_pages_factor;
147 char __pad[L1_CACHE_ALIGN(sizeof(struct cfs_trace_cpu_data))];
150 /* XXX nikita: this declaration is internal to tracefile.c and should probably
152 struct page_collection {
153 struct list_head pc_pages;
155 * if this flag is set, collect_pages() will spill both
156 * ->tcd_daemon_pages and ->tcd_pages to the ->pc_pages. Otherwise,
157 * only ->tcd_pages are spilled.
159 int pc_want_daemon_pages;
162 /* XXX nikita: this declaration is internal to tracefile.c and should probably
164 struct tracefiled_ctl {
165 struct completion tctl_start;
166 struct completion tctl_stop;
167 wait_queue_head_t tctl_waitq;
169 atomic_t tctl_shutdown;
173 * small data-structure for each page owned by tracefiled.
175 /* XXX nikita: this declaration is internal to tracefile.c and should probably
177 struct cfs_trace_page {
183 * linkage into one of the lists in trace_data_union or
186 struct list_head linkage;
188 * number of bytes used within this page
192 * cpu that owns this page
196 * type(context) of this page
201 int cfs_tcd_owns_tage(struct cfs_trace_cpu_data *tcd,
202 struct cfs_trace_page *tage);
204 extern void cfs_trace_assertion_failed(const char *str,
205 struct libcfs_debug_msg_data *m);
207 /* ASSERTION that is safe to use within the debug system */
208 #define __LASSERT(cond) \
210 if (unlikely(!(cond))) { \
211 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL); \
212 cfs_trace_assertion_failed("ASSERTION("#cond") failed", \
217 #define __LASSERT_TAGE_INVARIANT(tage) \
219 __LASSERT(tage != NULL); \
220 __LASSERT(tage->page != NULL); \
221 __LASSERT(tage->used <= PAGE_SIZE); \
222 __LASSERT(page_count(tage->page) > 0); \
225 #endif /* __LIBCFS_TRACEFILE_H__ */