Whamcloud - gitweb
LU-12501 utils: fix 'lfs df' printing loop
[fs/lustre-release.git] / libcfs / libcfs / tracefile.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  */
32
33 #ifndef __LIBCFS_TRACEFILE_H__
34 #define __LIBCFS_TRACEFILE_H__
35
36 #include <libcfs/libcfs.h>
37
38 enum cfs_trace_buf_type {
39         CFS_TCD_TYPE_PROC = 0,
40         CFS_TCD_TYPE_SOFTIRQ,
41         CFS_TCD_TYPE_IRQ,
42         CFS_TCD_TYPE_MAX
43 };
44
45 /* trace file lock routines */
46
47 #define TRACEFILE_NAME_SIZE 1024
48 extern char      cfs_tracefile[TRACEFILE_NAME_SIZE];
49 extern long long cfs_tracefile_size;
50
51 /**
52  * The path of debug log dump upcall script.
53  */
54 extern char lnet_debug_log_upcall[1024];
55
56 extern void libcfs_run_debug_log_upcall(char *file);
57
58 int  cfs_tracefile_init_arch(void);
59 void cfs_tracefile_fini_arch(void);
60
61 void cfs_tracefile_read_lock(void);
62 void cfs_tracefile_read_unlock(void);
63 void cfs_tracefile_write_lock(void);
64 void cfs_tracefile_write_unlock(void);
65
66 int cfs_tracefile_dump_all_pages(char *filename);
67 void cfs_trace_debug_print(void);
68 void cfs_trace_flush_pages(void);
69 int cfs_trace_start_thread(void);
70 void cfs_trace_stop_thread(void);
71 int cfs_tracefile_init(int max_pages);
72 void cfs_tracefile_exit(void);
73
74
75
76 int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
77                             const char __user *usr_buffer, int usr_buffer_nob);
78 int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
79                              const char *knl_str, char *append);
80 int cfs_trace_allocate_string_buffer(char **str, int nob);
81 int cfs_trace_dump_debug_buffer_usrstr(void __user *usr_str, int usr_str_nob);
82 int cfs_trace_daemon_command(char *str);
83 int cfs_trace_daemon_command_usrstr(void __user *usr_str, int usr_str_nob);
84 int cfs_trace_set_debug_mb(int mb);
85 int cfs_trace_get_debug_mb(void);
86
87 extern void libcfs_debug_dumplog_internal(void *arg);
88 extern void libcfs_register_panic_notifier(void);
89 extern void libcfs_unregister_panic_notifier(void);
90 extern int  libcfs_panic_in_progress;
91 extern int  cfs_trace_max_debug_mb(void);
92
93 #define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
94 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
95 #define CFS_TRACEFILE_SIZE (500 << 20)
96
97 #ifdef LUSTRE_TRACEFILE_PRIVATE
98
99 /*
100  * Private declare for tracefile
101  */
102 #define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
103 #define TCD_STOCK_PAGES (TCD_MAX_PAGES)
104
105 #define CFS_TRACEFILE_SIZE (500 << 20)
106
107 /* Size of a buffer for sprinting console messages if we can't get a page
108  * from system */
109 #define CFS_TRACE_CONSOLE_BUFFER_SIZE   1024
110
111 union cfs_trace_data_union {
112         struct cfs_trace_cpu_data {
113                 /*
114                  * Even though this structure is meant to be per-CPU, locking
115                  * is needed because in some places the data may be accessed
116                  * from other CPUs. This lock is directly used in trace_get_tcd
117                  * and trace_put_tcd, which are called in libcfs_debug_msg and
118                  * tcd_for_each_type_lock
119                  */
120                 spinlock_t              tcd_lock;
121                 unsigned long           tcd_lock_flags;
122
123                 /*
124                  * pages with trace records not yet processed by tracefiled.
125                  */
126                 struct list_head        tcd_pages;
127                 /* number of pages on ->tcd_pages */
128                 unsigned long           tcd_cur_pages;
129
130                 /*
131                  * pages with trace records already processed by
132                  * tracefiled. These pages are kept in memory, so that some
133                  * portion of log can be written in the event of LBUG. This
134                  * list is maintained in LRU order.
135                  *
136                  * Pages are moved to ->tcd_daemon_pages by tracefiled()
137                  * (put_pages_on_daemon_list()). LRU pages from this list are
138                  * discarded when list grows too large.
139                  */
140                 struct list_head        tcd_daemon_pages;
141                 /* number of pages on ->tcd_daemon_pages */
142                 unsigned long           tcd_cur_daemon_pages;
143
144                 /*
145                  * Maximal number of pages allowed on ->tcd_pages and
146                  * ->tcd_daemon_pages each.
147                  * Always TCD_MAX_PAGES * tcd_pages_factor / 100 in current
148                  * implementation.
149                  */
150                 unsigned long           tcd_max_pages;
151
152                 /*
153                  * preallocated pages to write trace records into. Pages from
154                  * ->tcd_stock_pages are moved to ->tcd_pages by
155                  * portals_debug_msg().
156                  *
157                  * This list is necessary, because on some platforms it's
158                  * impossible to perform efficient atomic page allocation in a
159                  * non-blockable context.
160                  *
161                  * Such platforms fill ->tcd_stock_pages "on occasion", when
162                  * tracing code is entered in blockable context.
163                  *
164                  * trace_get_tage_try() tries to get a page from
165                  * ->tcd_stock_pages first and resorts to atomic page
166                  * allocation only if this queue is empty. ->tcd_stock_pages
167                  * is replenished when tracing code is entered in blocking
168                  * context (darwin-tracefile.c:trace_get_tcd()). We try to
169                  * maintain TCD_STOCK_PAGES (40 by default) pages in this
170                  * queue. Atomic allocation is only required if more than
171                  * TCD_STOCK_PAGES pagesful are consumed by trace records all
172                  * emitted in non-blocking contexts. Which is quite unlikely.
173                  */
174                 struct list_head        tcd_stock_pages;
175                 /* number of pages on ->tcd_stock_pages */
176                 unsigned long           tcd_cur_stock_pages;
177
178                 unsigned short          tcd_shutting_down;
179                 unsigned short          tcd_cpu;
180                 unsigned short          tcd_type;
181                 /* The factors to share debug memory. */
182                 unsigned short          tcd_pages_factor;
183         } tcd;
184         char __pad[L1_CACHE_ALIGN(sizeof(struct cfs_trace_cpu_data))];
185 };
186
187 #define TCD_MAX_TYPES      8
188 extern union cfs_trace_data_union (*cfs_trace_data[TCD_MAX_TYPES])[NR_CPUS];
189
190 #define cfs_tcd_for_each(tcd, i, j)                                       \
191     for (i = 0; cfs_trace_data[i] != NULL; i++)                           \
192         for (j = 0, ((tcd) = &(*cfs_trace_data[i])[j].tcd);               \
193              j < num_possible_cpus();                                     \
194              j++, (tcd) = &(*cfs_trace_data[i])[j].tcd)
195
196 #define cfs_tcd_for_each_type_lock(tcd, i, cpu)                           \
197     for (i = 0; cfs_trace_data[i] &&                                      \
198          (tcd = &(*cfs_trace_data[i])[cpu].tcd) &&                        \
199          cfs_trace_lock_tcd(tcd, 1); cfs_trace_unlock_tcd(tcd, 1), i++)
200
201 /* XXX nikita: this declaration is internal to tracefile.c and should probably
202  * be moved there */
203 struct page_collection {
204         struct list_head        pc_pages;
205         /*
206          * if this flag is set, collect_pages() will spill both
207          * ->tcd_daemon_pages and ->tcd_pages to the ->pc_pages. Otherwise,
208          * only ->tcd_pages are spilled.
209          */
210         int                     pc_want_daemon_pages;
211 };
212
213 /* XXX nikita: this declaration is internal to tracefile.c and should probably
214  * be moved there */
215 struct tracefiled_ctl {
216         struct completion       tctl_start;
217         struct completion       tctl_stop;
218         wait_queue_head_t       tctl_waitq;
219         pid_t                   tctl_pid;
220         atomic_t                tctl_shutdown;
221 };
222
223 /*
224  * small data-structure for each page owned by tracefiled.
225  */
226 /* XXX nikita: this declaration is internal to tracefile.c and should probably
227  * be moved there */
228 struct cfs_trace_page {
229         /*
230          * page itself
231          */
232         struct page             *page;
233         /*
234          * linkage into one of the lists in trace_data_union or
235          * page_collection
236          */
237         struct list_head        linkage;
238         /*
239          * number of bytes used within this page
240          */
241         unsigned int            used;
242         /*
243          * cpu that owns this page
244          */
245         unsigned short          cpu;
246         /*
247          * type(context) of this page
248          */
249         unsigned short          type;
250 };
251
252 extern void cfs_set_ptldebug_header(struct ptldebug_header *header,
253                                     struct libcfs_debug_msg_data *m,
254                                     unsigned long stack);
255 extern void cfs_print_to_console(struct ptldebug_header *hdr, int mask,
256                                  const char *buf, int len, const char *file,
257                                  const char *fn);
258
259 extern int cfs_trace_lock_tcd(struct cfs_trace_cpu_data *tcd, int walking);
260 extern void cfs_trace_unlock_tcd(struct cfs_trace_cpu_data *tcd, int walking);
261
262 extern char *cfs_trace_console_buffers[NR_CPUS][CFS_TCD_TYPE_MAX];
263 extern enum cfs_trace_buf_type cfs_trace_buf_idx_get(void);
264
265 static inline char *cfs_trace_get_console_buffer(void)
266 {
267         unsigned int i = get_cpu();
268         unsigned int j = cfs_trace_buf_idx_get();
269
270         return cfs_trace_console_buffers[i][j];
271 }
272
273 static inline struct cfs_trace_cpu_data *cfs_trace_get_tcd(void)
274 {
275         struct cfs_trace_cpu_data *tcd =
276                 &(*cfs_trace_data[cfs_trace_buf_idx_get()])[get_cpu()].tcd;
277
278         cfs_trace_lock_tcd(tcd, 0);
279
280         return tcd;
281 }
282
283 static inline void cfs_trace_put_tcd(struct cfs_trace_cpu_data *tcd)
284 {
285         cfs_trace_unlock_tcd(tcd, 0);
286         put_cpu();
287 }
288
289 int cfs_trace_refill_stock(struct cfs_trace_cpu_data *tcd, gfp_t gfp,
290                                 struct list_head *stock);
291
292
293 int cfs_tcd_owns_tage(struct cfs_trace_cpu_data *tcd,
294                       struct cfs_trace_page *tage);
295
296 extern void cfs_trace_assertion_failed(const char *str,
297                                        struct libcfs_debug_msg_data *m);
298
299 /* ASSERTION that is safe to use within the debug system */
300 #define __LASSERT(cond)                                                 \
301 do {                                                                    \
302         if (unlikely(!(cond))) {                                        \
303                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL);     \
304                 cfs_trace_assertion_failed("ASSERTION("#cond") failed", \
305                                            &msgdata);                   \
306         }                                                               \
307 } while (0)
308
309 #define __LASSERT_TAGE_INVARIANT(tage)                                  \
310 do {                                                                    \
311         __LASSERT(tage != NULL);                                        \
312         __LASSERT(tage->page != NULL);                                  \
313         __LASSERT(tage->used <= PAGE_SIZE);                             \
314         __LASSERT(page_count(tage->page) > 0);                          \
315 } while (0)
316
317 #endif  /* LUSTRE_TRACEFILE_PRIVATE */
318
319 #endif /* __LIBCFS_TRACEFILE_H__ */