Loading...
1// SPDX-License-Identifier: GPL-2.0
2/* For general debugging purposes */
3
4#include <inttypes.h>
5#include <string.h>
6#include <stdarg.h>
7#include <stdio.h>
8#include <stdlib.h>
9#include <sys/wait.h>
10#include <api/debug.h>
11#include <linux/kernel.h>
12#include <linux/time64.h>
13#ifdef HAVE_BACKTRACE_SUPPORT
14#include <execinfo.h>
15#endif
16#include "color.h"
17#include "event.h"
18#include "debug.h"
19#include "print_binary.h"
20#include "target.h"
21#include "ui/helpline.h"
22#include "ui/ui.h"
23#include "util/parse-sublevel-options.h"
24
25#include <linux/ctype.h>
26
27int verbose;
28int debug_peo_args;
29bool dump_trace = false, quiet = false;
30int debug_ordered_events;
31static int redirect_to_stderr;
32int debug_data_convert;
33
34int veprintf(int level, int var, const char *fmt, va_list args)
35{
36 int ret = 0;
37
38 if (var >= level) {
39 if (use_browser >= 1 && !redirect_to_stderr)
40 ui_helpline__vshow(fmt, args);
41 else
42 ret = vfprintf(stderr, fmt, args);
43 }
44
45 return ret;
46}
47
48int eprintf(int level, int var, const char *fmt, ...)
49{
50 va_list args;
51 int ret;
52
53 va_start(args, fmt);
54 ret = veprintf(level, var, fmt, args);
55 va_end(args);
56
57 return ret;
58}
59
60static int veprintf_time(u64 t, const char *fmt, va_list args)
61{
62 int ret = 0;
63 u64 secs, usecs, nsecs = t;
64
65 secs = nsecs / NSEC_PER_SEC;
66 nsecs -= secs * NSEC_PER_SEC;
67 usecs = nsecs / NSEC_PER_USEC;
68
69 ret = fprintf(stderr, "[%13" PRIu64 ".%06" PRIu64 "] ",
70 secs, usecs);
71 ret += vfprintf(stderr, fmt, args);
72 return ret;
73}
74
75int eprintf_time(int level, int var, u64 t, const char *fmt, ...)
76{
77 int ret = 0;
78 va_list args;
79
80 if (var >= level) {
81 va_start(args, fmt);
82 ret = veprintf_time(t, fmt, args);
83 va_end(args);
84 }
85
86 return ret;
87}
88
89/*
90 * Overloading libtraceevent standard info print
91 * function, display with -v in perf.
92 */
93void pr_stat(const char *fmt, ...)
94{
95 va_list args;
96
97 va_start(args, fmt);
98 veprintf(1, verbose, fmt, args);
99 va_end(args);
100 eprintf(1, verbose, "\n");
101}
102
103int dump_printf(const char *fmt, ...)
104{
105 va_list args;
106 int ret = 0;
107
108 if (dump_trace) {
109 va_start(args, fmt);
110 ret = vprintf(fmt, args);
111 va_end(args);
112 }
113
114 return ret;
115}
116
117static int trace_event_printer(enum binary_printer_ops op,
118 unsigned int val, void *extra, FILE *fp)
119{
120 const char *color = PERF_COLOR_BLUE;
121 union perf_event *event = (union perf_event *)extra;
122 unsigned char ch = (unsigned char)val;
123 int printed = 0;
124
125 switch (op) {
126 case BINARY_PRINT_DATA_BEGIN:
127 printed += fprintf(fp, ".");
128 printed += color_fprintf(fp, color, "\n. ... raw event: size %d bytes\n",
129 event->header.size);
130 break;
131 case BINARY_PRINT_LINE_BEGIN:
132 printed += fprintf(fp, ".");
133 break;
134 case BINARY_PRINT_ADDR:
135 printed += color_fprintf(fp, color, " %04x: ", val);
136 break;
137 case BINARY_PRINT_NUM_DATA:
138 printed += color_fprintf(fp, color, " %02x", val);
139 break;
140 case BINARY_PRINT_NUM_PAD:
141 printed += color_fprintf(fp, color, " ");
142 break;
143 case BINARY_PRINT_SEP:
144 printed += color_fprintf(fp, color, " ");
145 break;
146 case BINARY_PRINT_CHAR_DATA:
147 printed += color_fprintf(fp, color, "%c",
148 isprint(ch) ? ch : '.');
149 break;
150 case BINARY_PRINT_CHAR_PAD:
151 printed += color_fprintf(fp, color, " ");
152 break;
153 case BINARY_PRINT_LINE_END:
154 printed += color_fprintf(fp, color, "\n");
155 break;
156 case BINARY_PRINT_DATA_END:
157 printed += fprintf(fp, "\n");
158 break;
159 default:
160 break;
161 }
162
163 return printed;
164}
165
166void trace_event(union perf_event *event)
167{
168 unsigned char *raw_event = (void *)event;
169
170 if (!dump_trace)
171 return;
172
173 print_binary(raw_event, event->header.size, 16,
174 trace_event_printer, event);
175}
176
177static struct sublevel_option debug_opts[] = {
178 { .name = "verbose", .value_ptr = &verbose },
179 { .name = "ordered-events", .value_ptr = &debug_ordered_events},
180 { .name = "stderr", .value_ptr = &redirect_to_stderr},
181 { .name = "data-convert", .value_ptr = &debug_data_convert },
182 { .name = "perf-event-open", .value_ptr = &debug_peo_args },
183 { .name = NULL, }
184};
185
186int perf_debug_option(const char *str)
187{
188 int ret;
189
190 ret = perf_parse_sublevel_options(str, debug_opts);
191 if (ret)
192 return ret;
193
194 /* Allow only verbose value in range (0, 10), otherwise set 0. */
195 verbose = (verbose < 0) || (verbose > 10) ? 0 : verbose;
196
197 return 0;
198}
199
200int perf_quiet_option(void)
201{
202 struct sublevel_option *opt = &debug_opts[0];
203
204 /* disable all debug messages */
205 while (opt->name) {
206 *opt->value_ptr = -1;
207 opt++;
208 }
209
210 return 0;
211}
212
213#define DEBUG_WRAPPER(__n, __l) \
214static int pr_ ## __n ## _wrapper(const char *fmt, ...) \
215{ \
216 va_list args; \
217 int ret; \
218 \
219 va_start(args, fmt); \
220 ret = veprintf(__l, verbose, fmt, args); \
221 va_end(args); \
222 return ret; \
223}
224
225DEBUG_WRAPPER(warning, 0);
226DEBUG_WRAPPER(debug, 1);
227
228void perf_debug_setup(void)
229{
230 libapi_set_print(pr_warning_wrapper, pr_warning_wrapper, pr_debug_wrapper);
231}
232
233/* Obtain a backtrace and print it to stdout. */
234#ifdef HAVE_BACKTRACE_SUPPORT
235void dump_stack(void)
236{
237 void *array[16];
238 size_t size = backtrace(array, ARRAY_SIZE(array));
239 char **strings = backtrace_symbols(array, size);
240 size_t i;
241
242 printf("Obtained %zd stack frames.\n", size);
243
244 for (i = 0; i < size; i++)
245 printf("%s\n", strings[i]);
246
247 free(strings);
248}
249#else
250void dump_stack(void) {}
251#endif
252
253void sighandler_dump_stack(int sig)
254{
255 psignal(sig, "perf");
256 dump_stack();
257 signal(sig, SIG_DFL);
258 raise(sig);
259}
1/* For general debugging purposes */
2
3#include "../perf.h"
4
5#include <string.h>
6#include <stdarg.h>
7#include <stdio.h>
8#include <api/debug.h>
9#include <linux/time64.h>
10
11#include "cache.h"
12#include "color.h"
13#include "event.h"
14#include "debug.h"
15#include "util.h"
16#include "target.h"
17
18int verbose;
19bool dump_trace = false, quiet = false;
20int debug_ordered_events;
21static int redirect_to_stderr;
22int debug_data_convert;
23
24int veprintf(int level, int var, const char *fmt, va_list args)
25{
26 int ret = 0;
27
28 if (var >= level) {
29 if (use_browser >= 1 && !redirect_to_stderr)
30 ui_helpline__vshow(fmt, args);
31 else
32 ret = vfprintf(stderr, fmt, args);
33 }
34
35 return ret;
36}
37
38int eprintf(int level, int var, const char *fmt, ...)
39{
40 va_list args;
41 int ret;
42
43 va_start(args, fmt);
44 ret = veprintf(level, var, fmt, args);
45 va_end(args);
46
47 return ret;
48}
49
50static int veprintf_time(u64 t, const char *fmt, va_list args)
51{
52 int ret = 0;
53 u64 secs, usecs, nsecs = t;
54
55 secs = nsecs / NSEC_PER_SEC;
56 nsecs -= secs * NSEC_PER_SEC;
57 usecs = nsecs / NSEC_PER_USEC;
58
59 ret = fprintf(stderr, "[%13" PRIu64 ".%06" PRIu64 "] ",
60 secs, usecs);
61 ret += vfprintf(stderr, fmt, args);
62 return ret;
63}
64
65int eprintf_time(int level, int var, u64 t, const char *fmt, ...)
66{
67 int ret = 0;
68 va_list args;
69
70 if (var >= level) {
71 va_start(args, fmt);
72 ret = veprintf_time(t, fmt, args);
73 va_end(args);
74 }
75
76 return ret;
77}
78
79/*
80 * Overloading libtraceevent standard info print
81 * function, display with -v in perf.
82 */
83void pr_stat(const char *fmt, ...)
84{
85 va_list args;
86
87 va_start(args, fmt);
88 veprintf(1, verbose, fmt, args);
89 va_end(args);
90 eprintf(1, verbose, "\n");
91}
92
93int dump_printf(const char *fmt, ...)
94{
95 va_list args;
96 int ret = 0;
97
98 if (dump_trace) {
99 va_start(args, fmt);
100 ret = vprintf(fmt, args);
101 va_end(args);
102 }
103
104 return ret;
105}
106
107static void trace_event_printer(enum binary_printer_ops op,
108 unsigned int val, void *extra)
109{
110 const char *color = PERF_COLOR_BLUE;
111 union perf_event *event = (union perf_event *)extra;
112 unsigned char ch = (unsigned char)val;
113
114 switch (op) {
115 case BINARY_PRINT_DATA_BEGIN:
116 printf(".");
117 color_fprintf(stdout, color, "\n. ... raw event: size %d bytes\n",
118 event->header.size);
119 break;
120 case BINARY_PRINT_LINE_BEGIN:
121 printf(".");
122 break;
123 case BINARY_PRINT_ADDR:
124 color_fprintf(stdout, color, " %04x: ", val);
125 break;
126 case BINARY_PRINT_NUM_DATA:
127 color_fprintf(stdout, color, " %02x", val);
128 break;
129 case BINARY_PRINT_NUM_PAD:
130 color_fprintf(stdout, color, " ");
131 break;
132 case BINARY_PRINT_SEP:
133 color_fprintf(stdout, color, " ");
134 break;
135 case BINARY_PRINT_CHAR_DATA:
136 color_fprintf(stdout, color, "%c",
137 isprint(ch) ? ch : '.');
138 break;
139 case BINARY_PRINT_CHAR_PAD:
140 color_fprintf(stdout, color, " ");
141 break;
142 case BINARY_PRINT_LINE_END:
143 color_fprintf(stdout, color, "\n");
144 break;
145 case BINARY_PRINT_DATA_END:
146 printf("\n");
147 break;
148 default:
149 break;
150 }
151}
152
153void trace_event(union perf_event *event)
154{
155 unsigned char *raw_event = (void *)event;
156
157 if (!dump_trace)
158 return;
159
160 print_binary(raw_event, event->header.size, 16,
161 trace_event_printer, event);
162}
163
164static struct debug_variable {
165 const char *name;
166 int *ptr;
167} debug_variables[] = {
168 { .name = "verbose", .ptr = &verbose },
169 { .name = "ordered-events", .ptr = &debug_ordered_events},
170 { .name = "stderr", .ptr = &redirect_to_stderr},
171 { .name = "data-convert", .ptr = &debug_data_convert },
172 { .name = NULL, }
173};
174
175int perf_debug_option(const char *str)
176{
177 struct debug_variable *var = &debug_variables[0];
178 char *vstr, *s = strdup(str);
179 int v = 1;
180
181 vstr = strchr(s, '=');
182 if (vstr)
183 *vstr++ = 0;
184
185 while (var->name) {
186 if (!strcmp(s, var->name))
187 break;
188 var++;
189 }
190
191 if (!var->name) {
192 pr_err("Unknown debug variable name '%s'\n", s);
193 free(s);
194 return -1;
195 }
196
197 if (vstr) {
198 v = atoi(vstr);
199 /*
200 * Allow only values in range (0, 10),
201 * otherwise set 0.
202 */
203 v = (v < 0) || (v > 10) ? 0 : v;
204 }
205
206 *var->ptr = v;
207 free(s);
208 return 0;
209}
210
211#define DEBUG_WRAPPER(__n, __l) \
212static int pr_ ## __n ## _wrapper(const char *fmt, ...) \
213{ \
214 va_list args; \
215 int ret; \
216 \
217 va_start(args, fmt); \
218 ret = veprintf(__l, verbose, fmt, args); \
219 va_end(args); \
220 return ret; \
221}
222
223DEBUG_WRAPPER(warning, 0);
224DEBUG_WRAPPER(debug, 1);
225
226void perf_debug_setup(void)
227{
228 libapi_set_print(pr_warning_wrapper, pr_warning_wrapper, pr_debug_wrapper);
229}