xref: /linux-6.15/tools/perf/util/debug.h (revision 90429524)
1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
2cd84c2acSFrederic Weisbecker /* For debugging general purposes */
38b40f521SJohn Kacur #ifndef __PERF_DEBUG_H
48b40f521SJohn Kacur #define __PERF_DEBUG_H
5cd84c2acSFrederic Weisbecker 
6b22bb139SArnaldo Carvalho de Melo #include <stdarg.h>
7c0555642SIan Munsie #include <stdbool.h>
88abceacfSJiri Olsa #include <stdio.h>
9afaed6d3SArnaldo Carvalho de Melo #include <linux/compiler.h>
108f41146aSArnaldo Carvalho de Melo 
11cd84c2acSFrederic Weisbecker extern int verbose;
120bdfbd04SAdrian Hunter extern int debug_kmaps;
13ccd26741SRavi Bangoria extern int debug_peo_args;
14b44308f5SArnaldo Carvalho de Melo extern bool quiet, dump_trace;
15cee3ab9cSJiri Olsa extern int debug_ordered_events;
16edbe9817SJiri Olsa extern int debug_data_convert;
17*90429524SNamhyung Kim extern int debug_type_profile;
18cd84c2acSFrederic Weisbecker 
1984f5d36fSJiri Olsa #ifndef pr_fmt
2084f5d36fSJiri Olsa #define pr_fmt(fmt) fmt
2184f5d36fSJiri Olsa #endif
2284f5d36fSJiri Olsa 
2384f5d36fSJiri Olsa #define pr_err(fmt, ...) \
24c95688aaSJiri Olsa 	eprintf(0, verbose, pr_fmt(fmt), ##__VA_ARGS__)
2584f5d36fSJiri Olsa #define pr_warning(fmt, ...) \
26c95688aaSJiri Olsa 	eprintf(0, verbose, pr_fmt(fmt), ##__VA_ARGS__)
271094795eSJames Clark #define pr_warning_once(fmt, ...) ({		\
281094795eSJames Clark 	static int __warned;			\
291094795eSJames Clark 	if (unlikely(!__warned)) {		\
301094795eSJames Clark 		pr_warning(fmt, ##__VA_ARGS__); \
311094795eSJames Clark 		__warned = 1;			\
321094795eSJames Clark 	}					\
331094795eSJames Clark })
3484f5d36fSJiri Olsa #define pr_info(fmt, ...) \
35c95688aaSJiri Olsa 	eprintf(0, verbose, pr_fmt(fmt), ##__VA_ARGS__)
3684f5d36fSJiri Olsa #define pr_debug(fmt, ...) \
37c95688aaSJiri Olsa 	eprintf(1, verbose, pr_fmt(fmt), ##__VA_ARGS__)
3884f5d36fSJiri Olsa #define pr_debugN(n, fmt, ...) \
39c95688aaSJiri Olsa 	eprintf(n, verbose, pr_fmt(fmt), ##__VA_ARGS__)
4084f5d36fSJiri Olsa #define pr_debug2(fmt, ...) pr_debugN(2, pr_fmt(fmt), ##__VA_ARGS__)
4184f5d36fSJiri Olsa #define pr_debug3(fmt, ...) pr_debugN(3, pr_fmt(fmt), ##__VA_ARGS__)
4284f5d36fSJiri Olsa #define pr_debug4(fmt, ...) pr_debugN(4, pr_fmt(fmt), ##__VA_ARGS__)
4384f5d36fSJiri Olsa 
44ccd26741SRavi Bangoria /* Special macro to print perf_event_open arguments/return value. */
45ccd26741SRavi Bangoria #define pr_debug2_peo(fmt, ...) {				\
46ccd26741SRavi Bangoria 	if (debug_peo_args)						\
47ccd26741SRavi Bangoria 		pr_debugN(0, pr_fmt(fmt), ##__VA_ARGS__);	\
48ccd26741SRavi Bangoria 	else							\
49ccd26741SRavi Bangoria 		pr_debugN(2, pr_fmt(fmt), ##__VA_ARGS__);	\
50ccd26741SRavi Bangoria }
51ccd26741SRavi Bangoria 
52cee3ab9cSJiri Olsa #define pr_time_N(n, var, t, fmt, ...) \
53cee3ab9cSJiri Olsa 	eprintf_time(n, var, t, fmt, ##__VA_ARGS__)
54cee3ab9cSJiri Olsa 
55cee3ab9cSJiri Olsa #define pr_oe_time(t, fmt, ...)  pr_time_N(1, debug_ordered_events, t, pr_fmt(fmt), ##__VA_ARGS__)
56cee3ab9cSJiri Olsa #define pr_oe_time2(t, fmt, ...) pr_time_N(2, debug_ordered_events, t, pr_fmt(fmt), ##__VA_ARGS__)
57cee3ab9cSJiri Olsa 
58c8b5f2c9SArnaldo Carvalho de Melo #define STRERR_BUFSIZE	128	/* For the buffer size of str_error_r */
59b2348e1dSMasami Hiramatsu 
608520a98dSArnaldo Carvalho de Melo union perf_event;
618520a98dSArnaldo Carvalho de Melo 
62afaed6d3SArnaldo Carvalho de Melo int dump_printf(const char *fmt, ...) __printf(1, 2);
638115d60cSArnaldo Carvalho de Melo void trace_event(union perf_event *event);
64567e5479SArnaldo Carvalho de Melo 
65afaed6d3SArnaldo Carvalho de Melo int ui__error(const char *format, ...) __printf(1, 2);
66afaed6d3SArnaldo Carvalho de Melo int ui__warning(const char *format, ...) __printf(1, 2);
671094795eSJames Clark #define ui__warning_once(format, ...) ({		\
681094795eSJames Clark 	static int __warned;				\
691094795eSJames Clark 	if (unlikely(!__warned)) {			\
701094795eSJames Clark 		ui__warning(format, ##__VA_ARGS__);	\
711094795eSJames Clark 		__warned = 1;				\
721094795eSJames Clark 	}						\
731094795eSJames Clark })
74068ffaa8SArnaldo Carvalho de Melo 
75f772abc6SJiri Olsa void pr_stat(const char *fmt, ...);
76f772abc6SJiri Olsa 
77afaed6d3SArnaldo Carvalho de Melo int eprintf(int level, int var, const char *fmt, ...) __printf(3, 4);
78afaed6d3SArnaldo Carvalho de Melo int eprintf_time(int level, int var, u64 t, const char *fmt, ...) __printf(4, 5);
790af0885eSWang Nan int veprintf(int level, int var, const char *fmt, va_list args);
8084f5d36fSJiri Olsa 
81bbb2cea7SJiri Olsa int perf_debug_option(const char *str);
82ec49230cSIan Rogers FILE *debug_file(void);
838abceacfSJiri Olsa void debug_set_file(FILE *file);
84bcbd79d1SJiri Olsa void debug_set_display_time(bool set);
85dd629cc0SJiri Olsa void perf_debug_setup(void);
8680df1988SNamhyung Kim int perf_quiet_option(void);
87bbb2cea7SJiri Olsa 
888c2b7cacSArnaldo Carvalho de Melo void dump_stack(void);
898c2b7cacSArnaldo Carvalho de Melo void sighandler_dump_stack(int sig);
908c2b7cacSArnaldo Carvalho de Melo 
918b40f521SJohn Kacur #endif	/* __PERF_DEBUG_H */
92