xref: /linux/tools/perf/util/debug.h (revision c79c3c34f75d72a066e292b10aa50fc758c97c89)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* For debugging general purposes */
3 #ifndef __PERF_DEBUG_H
4 #define __PERF_DEBUG_H
5 
6 #include <stdarg.h>
7 #include <stdbool.h>
8 #include <stdio.h>
9 #include <linux/compiler.h>
10 
11 extern int verbose;
12 extern int debug_peo_args;
13 extern bool quiet, dump_trace;
14 extern int debug_ordered_events;
15 extern int debug_data_convert;
16 
17 #ifndef pr_fmt
18 #define pr_fmt(fmt) fmt
19 #endif
20 
21 #define pr_err(fmt, ...) \
22 	eprintf(0, verbose, pr_fmt(fmt), ##__VA_ARGS__)
23 #define pr_warning(fmt, ...) \
24 	eprintf(0, verbose, pr_fmt(fmt), ##__VA_ARGS__)
25 #define pr_info(fmt, ...) \
26 	eprintf(0, verbose, pr_fmt(fmt), ##__VA_ARGS__)
27 #define pr_debug(fmt, ...) \
28 	eprintf(1, verbose, pr_fmt(fmt), ##__VA_ARGS__)
29 #define pr_debugN(n, fmt, ...) \
30 	eprintf(n, verbose, pr_fmt(fmt), ##__VA_ARGS__)
31 #define pr_debug2(fmt, ...) pr_debugN(2, pr_fmt(fmt), ##__VA_ARGS__)
32 #define pr_debug3(fmt, ...) pr_debugN(3, pr_fmt(fmt), ##__VA_ARGS__)
33 #define pr_debug4(fmt, ...) pr_debugN(4, pr_fmt(fmt), ##__VA_ARGS__)
34 
35 /* Special macro to print perf_event_open arguments/return value. */
36 #define pr_debug2_peo(fmt, ...) {				\
37 	if (debug_peo_args)						\
38 		pr_debugN(0, pr_fmt(fmt), ##__VA_ARGS__);	\
39 	else							\
40 		pr_debugN(2, pr_fmt(fmt), ##__VA_ARGS__);	\
41 }
42 
43 #define pr_time_N(n, var, t, fmt, ...) \
44 	eprintf_time(n, var, t, fmt, ##__VA_ARGS__)
45 
46 #define pr_oe_time(t, fmt, ...)  pr_time_N(1, debug_ordered_events, t, pr_fmt(fmt), ##__VA_ARGS__)
47 #define pr_oe_time2(t, fmt, ...) pr_time_N(2, debug_ordered_events, t, pr_fmt(fmt), ##__VA_ARGS__)
48 
49 #define STRERR_BUFSIZE	128	/* For the buffer size of str_error_r */
50 
51 union perf_event;
52 
53 int dump_printf(const char *fmt, ...) __printf(1, 2);
54 void trace_event(union perf_event *event);
55 
56 int ui__error(const char *format, ...) __printf(1, 2);
57 int ui__warning(const char *format, ...) __printf(1, 2);
58 
59 void pr_stat(const char *fmt, ...);
60 
61 int eprintf(int level, int var, const char *fmt, ...) __printf(3, 4);
62 int eprintf_time(int level, int var, u64 t, const char *fmt, ...) __printf(4, 5);
63 int veprintf(int level, int var, const char *fmt, va_list args);
64 
65 int perf_debug_option(const char *str);
66 void debug_set_file(FILE *file);
67 void debug_set_display_time(bool set);
68 void perf_debug_setup(void);
69 int perf_quiet_option(void);
70 
71 void dump_stack(void);
72 void sighandler_dump_stack(int sig);
73 
74 #endif	/* __PERF_DEBUG_H */
75