1b2441318SGreg Kroah-Hartman // SPDX-License-Identifier: GPL-2.0
2cd84c2acSFrederic Weisbecker /* For general debugging purposes */
3cd84c2acSFrederic Weisbecker
4fd20e811SArnaldo Carvalho de Melo #include <inttypes.h>
5cd84c2acSFrederic Weisbecker #include <string.h>
6cd84c2acSFrederic Weisbecker #include <stdarg.h>
7cd84c2acSFrederic Weisbecker #include <stdio.h>
8215a0d30SArnaldo Carvalho de Melo #include <stdlib.h>
94208735dSArnaldo Carvalho de Melo #include <sys/wait.h>
10dd629cc0SJiri Olsa #include <api/debug.h>
114cb3c6d5SArnaldo Carvalho de Melo #include <linux/kernel.h>
12bd48c63eSArnaldo Carvalho de Melo #include <linux/time64.h>
13bcbd79d1SJiri Olsa #include <sys/time.h>
148c2b7cacSArnaldo Carvalho de Melo #ifdef HAVE_BACKTRACE_SUPPORT
158c2b7cacSArnaldo Carvalho de Melo #include <execinfo.h>
168c2b7cacSArnaldo Carvalho de Melo #endif
178f28827aSFrederic Weisbecker #include "color.h"
188f28827aSFrederic Weisbecker #include "event.h"
198f28827aSFrederic Weisbecker #include "debug.h"
20fea01392SArnaldo Carvalho de Melo #include "print_binary.h"
2116ad2ffbSNamhyung Kim #include "target.h"
22*316769f7SIan Rogers #include "trace-event.h"
238520a98dSArnaldo Carvalho de Melo #include "ui/helpline.h"
24fa0d9846SArnaldo Carvalho de Melo #include "ui/ui.h"
25a80abe2aSChangbin Du #include "util/parse-sublevel-options.h"
268f28827aSFrederic Weisbecker
273052ba56SArnaldo Carvalho de Melo #include <linux/ctype.h>
283d689ed6SArnaldo Carvalho de Melo
29*316769f7SIan Rogers #ifdef HAVE_LIBTRACEEVENT
30*316769f7SIan Rogers #include <traceevent/event-parse.h>
31*316769f7SIan Rogers #else
32*316769f7SIan Rogers #define LIBTRACEEVENT_VERSION 0
33*316769f7SIan Rogers #endif
34*316769f7SIan Rogers
35b44308f5SArnaldo Carvalho de Melo int verbose;
36ccd26741SRavi Bangoria int debug_peo_args;
37b44308f5SArnaldo Carvalho de Melo bool dump_trace = false, quiet = false;
38cee3ab9cSJiri Olsa int debug_ordered_events;
39f78eaef0SAndi Kleen static int redirect_to_stderr;
40edbe9817SJiri Olsa int debug_data_convert;
418abceacfSJiri Olsa static FILE *debug_file;
42bcbd79d1SJiri Olsa bool debug_display_time;
438abceacfSJiri Olsa
debug_set_file(FILE * file)448abceacfSJiri Olsa void debug_set_file(FILE *file)
458abceacfSJiri Olsa {
468abceacfSJiri Olsa debug_file = file;
478abceacfSJiri Olsa }
48cd84c2acSFrederic Weisbecker
debug_set_display_time(bool set)49bcbd79d1SJiri Olsa void debug_set_display_time(bool set)
50bcbd79d1SJiri Olsa {
51bcbd79d1SJiri Olsa debug_display_time = set;
52bcbd79d1SJiri Olsa }
53bcbd79d1SJiri Olsa
fprintf_time(FILE * file)54bcbd79d1SJiri Olsa static int fprintf_time(FILE *file)
55bcbd79d1SJiri Olsa {
56bcbd79d1SJiri Olsa struct timeval tod;
57bcbd79d1SJiri Olsa struct tm ltime;
58bcbd79d1SJiri Olsa char date[64];
59bcbd79d1SJiri Olsa
60bcbd79d1SJiri Olsa if (!debug_display_time)
61bcbd79d1SJiri Olsa return 0;
62bcbd79d1SJiri Olsa
63bcbd79d1SJiri Olsa if (gettimeofday(&tod, NULL) != 0)
64bcbd79d1SJiri Olsa return 0;
65bcbd79d1SJiri Olsa
66bcbd79d1SJiri Olsa if (localtime_r(&tod.tv_sec, <ime) == NULL)
67bcbd79d1SJiri Olsa return 0;
68bcbd79d1SJiri Olsa
69bcbd79d1SJiri Olsa strftime(date, sizeof(date), "%F %H:%M:%S", <ime);
70bcbd79d1SJiri Olsa return fprintf(file, "[%s.%06lu] ", date, (long)tod.tv_usec);
71bcbd79d1SJiri Olsa }
72bcbd79d1SJiri Olsa
veprintf(int level,int var,const char * fmt,va_list args)73bedbdd42SArnaldo Carvalho de Melo int veprintf(int level, int var, const char *fmt, va_list args)
74cd84c2acSFrederic Weisbecker {
75cd84c2acSFrederic Weisbecker int ret = 0;
76cd84c2acSFrederic Weisbecker
77c95688aaSJiri Olsa if (var >= level) {
78bcbd79d1SJiri Olsa if (use_browser >= 1 && !redirect_to_stderr) {
79b56e5331SNamhyung Kim ui_helpline__vshow(fmt, args);
80bcbd79d1SJiri Olsa } else {
81bcbd79d1SJiri Olsa ret = fprintf_time(debug_file);
82bcbd79d1SJiri Olsa ret += vfprintf(debug_file, fmt, args);
83bcbd79d1SJiri Olsa }
84cd84c2acSFrederic Weisbecker }
85cd84c2acSFrederic Weisbecker
86cd84c2acSFrederic Weisbecker return ret;
87cd84c2acSFrederic Weisbecker }
882cec19d9SFrederic Weisbecker
eprintf(int level,int var,const char * fmt,...)89c95688aaSJiri Olsa int eprintf(int level, int var, const char *fmt, ...)
90f772abc6SJiri Olsa {
91f772abc6SJiri Olsa va_list args;
92f772abc6SJiri Olsa int ret;
93f772abc6SJiri Olsa
94f772abc6SJiri Olsa va_start(args, fmt);
95bedbdd42SArnaldo Carvalho de Melo ret = veprintf(level, var, fmt, args);
96f772abc6SJiri Olsa va_end(args);
97f772abc6SJiri Olsa
98f772abc6SJiri Olsa return ret;
99f772abc6SJiri Olsa }
100f772abc6SJiri Olsa
veprintf_time(u64 t,const char * fmt,va_list args)101bedbdd42SArnaldo Carvalho de Melo static int veprintf_time(u64 t, const char *fmt, va_list args)
102cee3ab9cSJiri Olsa {
103cee3ab9cSJiri Olsa int ret = 0;
104cee3ab9cSJiri Olsa u64 secs, usecs, nsecs = t;
105cee3ab9cSJiri Olsa
106bd48c63eSArnaldo Carvalho de Melo secs = nsecs / NSEC_PER_SEC;
107bd48c63eSArnaldo Carvalho de Melo nsecs -= secs * NSEC_PER_SEC;
108bd48c63eSArnaldo Carvalho de Melo usecs = nsecs / NSEC_PER_USEC;
109cee3ab9cSJiri Olsa
110cee3ab9cSJiri Olsa ret = fprintf(stderr, "[%13" PRIu64 ".%06" PRIu64 "] ",
111cee3ab9cSJiri Olsa secs, usecs);
112cee3ab9cSJiri Olsa ret += vfprintf(stderr, fmt, args);
113cee3ab9cSJiri Olsa return ret;
114cee3ab9cSJiri Olsa }
115cee3ab9cSJiri Olsa
eprintf_time(int level,int var,u64 t,const char * fmt,...)116cee3ab9cSJiri Olsa int eprintf_time(int level, int var, u64 t, const char *fmt, ...)
117cee3ab9cSJiri Olsa {
118cee3ab9cSJiri Olsa int ret = 0;
119cee3ab9cSJiri Olsa va_list args;
120cee3ab9cSJiri Olsa
121cee3ab9cSJiri Olsa if (var >= level) {
122cee3ab9cSJiri Olsa va_start(args, fmt);
123bedbdd42SArnaldo Carvalho de Melo ret = veprintf_time(t, fmt, args);
124cee3ab9cSJiri Olsa va_end(args);
125cee3ab9cSJiri Olsa }
126cee3ab9cSJiri Olsa
127cee3ab9cSJiri Olsa return ret;
128cee3ab9cSJiri Olsa }
129cee3ab9cSJiri Olsa
130f772abc6SJiri Olsa /*
131f772abc6SJiri Olsa * Overloading libtraceevent standard info print
132f772abc6SJiri Olsa * function, display with -v in perf.
133f772abc6SJiri Olsa */
pr_stat(const char * fmt,...)134f772abc6SJiri Olsa void pr_stat(const char *fmt, ...)
135f772abc6SJiri Olsa {
136f772abc6SJiri Olsa va_list args;
137f772abc6SJiri Olsa
138f772abc6SJiri Olsa va_start(args, fmt);
139bedbdd42SArnaldo Carvalho de Melo veprintf(1, verbose, fmt, args);
140f772abc6SJiri Olsa va_end(args);
141c95688aaSJiri Olsa eprintf(1, verbose, "\n");
142f772abc6SJiri Olsa }
143f772abc6SJiri Olsa
dump_printf(const char * fmt,...)1442cec19d9SFrederic Weisbecker int dump_printf(const char *fmt, ...)
1452cec19d9SFrederic Weisbecker {
1462cec19d9SFrederic Weisbecker va_list args;
1472cec19d9SFrederic Weisbecker int ret = 0;
1482cec19d9SFrederic Weisbecker
1492cec19d9SFrederic Weisbecker if (dump_trace) {
1502cec19d9SFrederic Weisbecker va_start(args, fmt);
1512cec19d9SFrederic Weisbecker ret = vprintf(fmt, args);
1522cec19d9SFrederic Weisbecker va_end(args);
1532cec19d9SFrederic Weisbecker }
1542cec19d9SFrederic Weisbecker
1552cec19d9SFrederic Weisbecker return ret;
1562cec19d9SFrederic Weisbecker }
1578f28827aSFrederic Weisbecker
trace_event_printer(enum binary_printer_ops op,unsigned int val,void * extra,FILE * fp)158923d0c9aSArnaldo Carvalho de Melo static int trace_event_printer(enum binary_printer_ops op,
159923d0c9aSArnaldo Carvalho de Melo unsigned int val, void *extra, FILE *fp)
160c339b1a9SWang Nan {
161c339b1a9SWang Nan const char *color = PERF_COLOR_BLUE;
162c339b1a9SWang Nan union perf_event *event = (union perf_event *)extra;
163c339b1a9SWang Nan unsigned char ch = (unsigned char)val;
164923d0c9aSArnaldo Carvalho de Melo int printed = 0;
165c339b1a9SWang Nan
166c339b1a9SWang Nan switch (op) {
167c339b1a9SWang Nan case BINARY_PRINT_DATA_BEGIN:
168923d0c9aSArnaldo Carvalho de Melo printed += fprintf(fp, ".");
169923d0c9aSArnaldo Carvalho de Melo printed += color_fprintf(fp, color, "\n. ... raw event: size %d bytes\n",
170c339b1a9SWang Nan event->header.size);
171c339b1a9SWang Nan break;
172c339b1a9SWang Nan case BINARY_PRINT_LINE_BEGIN:
173923d0c9aSArnaldo Carvalho de Melo printed += fprintf(fp, ".");
174c339b1a9SWang Nan break;
175c339b1a9SWang Nan case BINARY_PRINT_ADDR:
176923d0c9aSArnaldo Carvalho de Melo printed += color_fprintf(fp, color, " %04x: ", val);
177c339b1a9SWang Nan break;
178c339b1a9SWang Nan case BINARY_PRINT_NUM_DATA:
179923d0c9aSArnaldo Carvalho de Melo printed += color_fprintf(fp, color, " %02x", val);
180c339b1a9SWang Nan break;
181c339b1a9SWang Nan case BINARY_PRINT_NUM_PAD:
182923d0c9aSArnaldo Carvalho de Melo printed += color_fprintf(fp, color, " ");
183c339b1a9SWang Nan break;
184c339b1a9SWang Nan case BINARY_PRINT_SEP:
185923d0c9aSArnaldo Carvalho de Melo printed += color_fprintf(fp, color, " ");
186c339b1a9SWang Nan break;
187c339b1a9SWang Nan case BINARY_PRINT_CHAR_DATA:
188923d0c9aSArnaldo Carvalho de Melo printed += color_fprintf(fp, color, "%c",
18962942e9fSAdrian Hunter isprint(ch) && isascii(ch) ? ch : '.');
190c339b1a9SWang Nan break;
191c339b1a9SWang Nan case BINARY_PRINT_CHAR_PAD:
192923d0c9aSArnaldo Carvalho de Melo printed += color_fprintf(fp, color, " ");
193c339b1a9SWang Nan break;
194c339b1a9SWang Nan case BINARY_PRINT_LINE_END:
195923d0c9aSArnaldo Carvalho de Melo printed += color_fprintf(fp, color, "\n");
196c339b1a9SWang Nan break;
197c339b1a9SWang Nan case BINARY_PRINT_DATA_END:
198923d0c9aSArnaldo Carvalho de Melo printed += fprintf(fp, "\n");
199c339b1a9SWang Nan break;
200c339b1a9SWang Nan default:
201c339b1a9SWang Nan break;
202c339b1a9SWang Nan }
203923d0c9aSArnaldo Carvalho de Melo
204923d0c9aSArnaldo Carvalho de Melo return printed;
205c339b1a9SWang Nan }
206c339b1a9SWang Nan
trace_event(union perf_event * event)2078115d60cSArnaldo Carvalho de Melo void trace_event(union perf_event *event)
2088f28827aSFrederic Weisbecker {
2098f28827aSFrederic Weisbecker unsigned char *raw_event = (void *)event;
2108f28827aSFrederic Weisbecker
2118f28827aSFrederic Weisbecker if (!dump_trace)
2128f28827aSFrederic Weisbecker return;
2138f28827aSFrederic Weisbecker
214c339b1a9SWang Nan print_binary(raw_event, event->header.size, 16,
215c339b1a9SWang Nan trace_event_printer, event);
2168f28827aSFrederic Weisbecker }
217bbb2cea7SJiri Olsa
218a80abe2aSChangbin Du static struct sublevel_option debug_opts[] = {
219a80abe2aSChangbin Du { .name = "verbose", .value_ptr = &verbose },
220a80abe2aSChangbin Du { .name = "ordered-events", .value_ptr = &debug_ordered_events},
221a80abe2aSChangbin Du { .name = "stderr", .value_ptr = &redirect_to_stderr},
222a80abe2aSChangbin Du { .name = "data-convert", .value_ptr = &debug_data_convert },
223a80abe2aSChangbin Du { .name = "perf-event-open", .value_ptr = &debug_peo_args },
224bbb2cea7SJiri Olsa { .name = NULL, }
225bbb2cea7SJiri Olsa };
226bbb2cea7SJiri Olsa
perf_debug_option(const char * str)227bbb2cea7SJiri Olsa int perf_debug_option(const char *str)
228bbb2cea7SJiri Olsa {
229a80abe2aSChangbin Du int ret;
230bbb2cea7SJiri Olsa
231a80abe2aSChangbin Du ret = perf_parse_sublevel_options(str, debug_opts);
232a80abe2aSChangbin Du if (ret)
233a80abe2aSChangbin Du return ret;
234bbb2cea7SJiri Olsa
235a80abe2aSChangbin Du /* Allow only verbose value in range (0, 10), otherwise set 0. */
236a80abe2aSChangbin Du verbose = (verbose < 0) || (verbose > 10) ? 0 : verbose;
237bbb2cea7SJiri Olsa
238*316769f7SIan Rogers #if LIBTRACEEVENT_VERSION >= MAKE_LIBTRACEEVENT_VERSION(1, 3, 0)
239*316769f7SIan Rogers if (verbose == 1)
240*316769f7SIan Rogers tep_set_loglevel(TEP_LOG_INFO);
241*316769f7SIan Rogers else if (verbose == 2)
242*316769f7SIan Rogers tep_set_loglevel(TEP_LOG_DEBUG);
243*316769f7SIan Rogers else if (verbose >= 3)
244*316769f7SIan Rogers tep_set_loglevel(TEP_LOG_ALL);
245*316769f7SIan Rogers #endif
246bbb2cea7SJiri Olsa return 0;
247bbb2cea7SJiri Olsa }
248dd629cc0SJiri Olsa
perf_quiet_option(void)24980df1988SNamhyung Kim int perf_quiet_option(void)
25080df1988SNamhyung Kim {
251a80abe2aSChangbin Du struct sublevel_option *opt = &debug_opts[0];
25280df1988SNamhyung Kim
25380df1988SNamhyung Kim /* disable all debug messages */
254a80abe2aSChangbin Du while (opt->name) {
255a80abe2aSChangbin Du *opt->value_ptr = -1;
256a80abe2aSChangbin Du opt++;
25780df1988SNamhyung Kim }
25880df1988SNamhyung Kim
259188ac720SYang Jihong /* For debug variables that are used as bool types, set to 0. */
260188ac720SYang Jihong redirect_to_stderr = 0;
261188ac720SYang Jihong debug_peo_args = 0;
262188ac720SYang Jihong
26380df1988SNamhyung Kim return 0;
26480df1988SNamhyung Kim }
26580df1988SNamhyung Kim
266dd629cc0SJiri Olsa #define DEBUG_WRAPPER(__n, __l) \
267dd629cc0SJiri Olsa static int pr_ ## __n ## _wrapper(const char *fmt, ...) \
268dd629cc0SJiri Olsa { \
269dd629cc0SJiri Olsa va_list args; \
270dd629cc0SJiri Olsa int ret; \
271dd629cc0SJiri Olsa \
272dd629cc0SJiri Olsa va_start(args, fmt); \
273dd629cc0SJiri Olsa ret = veprintf(__l, verbose, fmt, args); \
274dd629cc0SJiri Olsa va_end(args); \
275dd629cc0SJiri Olsa return ret; \
276dd629cc0SJiri Olsa }
277dd629cc0SJiri Olsa
278dd629cc0SJiri Olsa DEBUG_WRAPPER(warning, 0);
279dd629cc0SJiri Olsa DEBUG_WRAPPER(debug, 1);
280dd629cc0SJiri Olsa
perf_debug_setup(void)281dd629cc0SJiri Olsa void perf_debug_setup(void)
282dd629cc0SJiri Olsa {
2838abceacfSJiri Olsa debug_set_file(stderr);
284dd629cc0SJiri Olsa libapi_set_print(pr_warning_wrapper, pr_warning_wrapper, pr_debug_wrapper);
285dd629cc0SJiri Olsa }
2868c2b7cacSArnaldo Carvalho de Melo
2878c2b7cacSArnaldo Carvalho de Melo /* Obtain a backtrace and print it to stdout. */
2888c2b7cacSArnaldo Carvalho de Melo #ifdef HAVE_BACKTRACE_SUPPORT
dump_stack(void)2898c2b7cacSArnaldo Carvalho de Melo void dump_stack(void)
2908c2b7cacSArnaldo Carvalho de Melo {
2918c2b7cacSArnaldo Carvalho de Melo void *array[16];
2928c2b7cacSArnaldo Carvalho de Melo size_t size = backtrace(array, ARRAY_SIZE(array));
2938c2b7cacSArnaldo Carvalho de Melo char **strings = backtrace_symbols(array, size);
2948c2b7cacSArnaldo Carvalho de Melo size_t i;
2958c2b7cacSArnaldo Carvalho de Melo
2968c2b7cacSArnaldo Carvalho de Melo printf("Obtained %zd stack frames.\n", size);
2978c2b7cacSArnaldo Carvalho de Melo
2988c2b7cacSArnaldo Carvalho de Melo for (i = 0; i < size; i++)
2998c2b7cacSArnaldo Carvalho de Melo printf("%s\n", strings[i]);
3008c2b7cacSArnaldo Carvalho de Melo
3018c2b7cacSArnaldo Carvalho de Melo free(strings);
3028c2b7cacSArnaldo Carvalho de Melo }
3038c2b7cacSArnaldo Carvalho de Melo #else
dump_stack(void)3048c2b7cacSArnaldo Carvalho de Melo void dump_stack(void) {}
3058c2b7cacSArnaldo Carvalho de Melo #endif
3068c2b7cacSArnaldo Carvalho de Melo
sighandler_dump_stack(int sig)3078c2b7cacSArnaldo Carvalho de Melo void sighandler_dump_stack(int sig)
3088c2b7cacSArnaldo Carvalho de Melo {
3098c2b7cacSArnaldo Carvalho de Melo psignal(sig, "perf");
3108c2b7cacSArnaldo Carvalho de Melo dump_stack();
3118c2b7cacSArnaldo Carvalho de Melo signal(sig, SIG_DFL);
3128c2b7cacSArnaldo Carvalho de Melo raise(sig);
3138c2b7cacSArnaldo Carvalho de Melo }
314