]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - tools/perf/builtin-script.c
perf tools: Ditch unused PATH_SEP, STRIP_EXTENSION
[mirror_ubuntu-hirsute-kernel.git] / tools / perf / builtin-script.c
CommitLineData
5f9c39dc
FW
1#include "builtin.h"
2
b7eead86 3#include "perf.h"
5f9c39dc 4#include "util/cache.h"
b7eead86 5#include "util/debug.h"
4b6ab94e 6#include <subcmd/exec-cmd.h>
b7eead86 7#include "util/header.h"
4b6ab94e 8#include <subcmd/parse-options.h>
fc36f948 9#include "util/perf_regs.h"
b7eead86 10#include "util/session.h"
45694aa7 11#include "util/tool.h"
5f9c39dc
FW
12#include "util/symbol.h"
13#include "util/thread.h"
cf72344d 14#include "util/trace-event.h"
b7eead86 15#include "util/util.h"
1424dc96
DA
16#include "util/evlist.h"
17#include "util/evsel.h"
36385be5 18#include "util/sort.h"
f5fc1412 19#include "util/data.h"
7a680eb9 20#include "util/auxtrace.h"
cfc8874a
JO
21#include "util/cpumap.h"
22#include "util/thread_map.h"
23#include "util/stat.h"
e216708d 24#include "util/thread-stack.h"
a91f4c47 25#include "util/time-utils.h"
5d67be97 26#include <linux/bitmap.h>
877a7a11 27#include <linux/kernel.h>
6125cc8d 28#include <linux/stringify.h>
bd48c63e 29#include <linux/time64.h>
cfc8874a 30#include "asm/bug.h"
c19ac912 31#include "util/mem-events.h"
48d02a1d 32#include "util/dump-insn.h"
fd20e811 33#include <inttypes.h>
5f9c39dc 34
956ffd02
TZ
35static char const *script_name;
36static char const *generate_script_lang;
ffabd99e 37static bool debug_mode;
e1889d75 38static u64 last_timestamp;
6fcf7ddb 39static u64 nr_unordered;
c0230b2b 40static bool no_callchain;
47390ae2 41static bool latency_format;
317df650 42static bool system_wide;
400ea6d3 43static bool print_flags;
83e19860 44static bool nanosecs;
5d67be97
AB
45static const char *cpu_list;
46static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
91a2c3d5 47static struct perf_stat_config stat_config;
48d02a1d 48static int max_blocks;
956ffd02 49
44cbe729 50unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
03cd1fed 51
745f43e3
DA
52enum perf_output_field {
53 PERF_OUTPUT_COMM = 1U << 0,
54 PERF_OUTPUT_TID = 1U << 1,
55 PERF_OUTPUT_PID = 1U << 2,
56 PERF_OUTPUT_TIME = 1U << 3,
57 PERF_OUTPUT_CPU = 1U << 4,
58 PERF_OUTPUT_EVNAME = 1U << 5,
59 PERF_OUTPUT_TRACE = 1U << 6,
787bef17
DA
60 PERF_OUTPUT_IP = 1U << 7,
61 PERF_OUTPUT_SYM = 1U << 8,
610723f2 62 PERF_OUTPUT_DSO = 1U << 9,
7cec0922 63 PERF_OUTPUT_ADDR = 1U << 10,
a978f2ab 64 PERF_OUTPUT_SYMOFFSET = 1U << 11,
cc8fae1d 65 PERF_OUTPUT_SRCLINE = 1U << 12,
535aeaae 66 PERF_OUTPUT_PERIOD = 1U << 13,
fc36f948 67 PERF_OUTPUT_IREGS = 1U << 14,
dc323ce8
SE
68 PERF_OUTPUT_BRSTACK = 1U << 15,
69 PERF_OUTPUT_BRSTACKSYM = 1U << 16,
94ddddfa
JO
70 PERF_OUTPUT_DATA_SRC = 1U << 17,
71 PERF_OUTPUT_WEIGHT = 1U << 18,
30372f04 72 PERF_OUTPUT_BPF_OUTPUT = 1U << 19,
e216708d 73 PERF_OUTPUT_CALLINDENT = 1U << 20,
224e2c97
AK
74 PERF_OUTPUT_INSN = 1U << 21,
75 PERF_OUTPUT_INSNLEN = 1U << 22,
48d02a1d 76 PERF_OUTPUT_BRSTACKINSN = 1U << 23,
745f43e3
DA
77};
78
79struct output_option {
80 const char *str;
81 enum perf_output_field field;
82} all_output_options[] = {
83 {.str = "comm", .field = PERF_OUTPUT_COMM},
84 {.str = "tid", .field = PERF_OUTPUT_TID},
85 {.str = "pid", .field = PERF_OUTPUT_PID},
86 {.str = "time", .field = PERF_OUTPUT_TIME},
87 {.str = "cpu", .field = PERF_OUTPUT_CPU},
88 {.str = "event", .field = PERF_OUTPUT_EVNAME},
89 {.str = "trace", .field = PERF_OUTPUT_TRACE},
787bef17 90 {.str = "ip", .field = PERF_OUTPUT_IP},
c0230b2b 91 {.str = "sym", .field = PERF_OUTPUT_SYM},
610723f2 92 {.str = "dso", .field = PERF_OUTPUT_DSO},
7cec0922 93 {.str = "addr", .field = PERF_OUTPUT_ADDR},
a978f2ab 94 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
cc8fae1d 95 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
535aeaae 96 {.str = "period", .field = PERF_OUTPUT_PERIOD},
fc36f948 97 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
dc323ce8
SE
98 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
99 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
94ddddfa
JO
100 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
101 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
30372f04 102 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
e216708d 103 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
224e2c97
AK
104 {.str = "insn", .field = PERF_OUTPUT_INSN},
105 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
48d02a1d 106 {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
745f43e3
DA
107};
108
109/* default set to maintain compatibility with current format */
2c9e45f7
DA
110static struct {
111 bool user_set;
9cbdb702 112 bool wildcard_set;
a6ffaf91 113 unsigned int print_ip_opts;
2c9e45f7
DA
114 u64 fields;
115 u64 invalid_fields;
116} output[PERF_TYPE_MAX] = {
117
118 [PERF_TYPE_HARDWARE] = {
119 .user_set = false,
120
121 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
122 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
787bef17 123 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
e8564b71
JO
124 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
125 PERF_OUTPUT_PERIOD,
2c9e45f7 126
30372f04 127 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
2c9e45f7
DA
128 },
129
130 [PERF_TYPE_SOFTWARE] = {
131 .user_set = false,
132
133 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
134 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
787bef17 135 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
e8564b71 136 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
30372f04 137 PERF_OUTPUT_PERIOD | PERF_OUTPUT_BPF_OUTPUT,
2c9e45f7
DA
138
139 .invalid_fields = PERF_OUTPUT_TRACE,
140 },
141
142 [PERF_TYPE_TRACEPOINT] = {
143 .user_set = false,
144
145 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
146 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
30372f04 147 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
2c9e45f7 148 },
0817a6a3
AS
149
150 [PERF_TYPE_RAW] = {
151 .user_set = false,
152
153 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
154 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
787bef17 155 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
e8564b71 156 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
ff7b1915
JO
157 PERF_OUTPUT_PERIOD | PERF_OUTPUT_ADDR |
158 PERF_OUTPUT_DATA_SRC | PERF_OUTPUT_WEIGHT,
0817a6a3 159
30372f04 160 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
0817a6a3 161 },
27cfef00
WN
162
163 [PERF_TYPE_BREAKPOINT] = {
164 .user_set = false,
165
166 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
167 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
168 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
169 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
170 PERF_OUTPUT_PERIOD,
171
30372f04 172 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
27cfef00 173 },
1424dc96 174};
745f43e3 175
2c9e45f7
DA
176static bool output_set_by_user(void)
177{
178 int j;
179 for (j = 0; j < PERF_TYPE_MAX; ++j) {
180 if (output[j].user_set)
181 return true;
182 }
183 return false;
184}
745f43e3 185
9cbdb702
DA
186static const char *output_field2str(enum perf_output_field field)
187{
188 int i, imax = ARRAY_SIZE(all_output_options);
189 const char *str = "";
190
191 for (i = 0; i < imax; ++i) {
192 if (all_output_options[i].field == field) {
193 str = all_output_options[i].str;
194 break;
195 }
196 }
197 return str;
198}
199
2c9e45f7 200#define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
1424dc96 201
6d5cdd64
AH
202static int perf_evsel__do_check_stype(struct perf_evsel *evsel,
203 u64 sample_type, const char *sample_msg,
204 enum perf_output_field field,
205 bool allow_user_set)
1424dc96 206{
5bff01f6 207 struct perf_event_attr *attr = &evsel->attr;
9cbdb702
DA
208 int type = attr->type;
209 const char *evname;
210
211 if (attr->sample_type & sample_type)
212 return 0;
213
214 if (output[type].user_set) {
6d5cdd64
AH
215 if (allow_user_set)
216 return 0;
5bff01f6 217 evname = perf_evsel__name(evsel);
9cbdb702
DA
218 pr_err("Samples for '%s' event do not have %s attribute set. "
219 "Cannot print '%s' field.\n",
220 evname, sample_msg, output_field2str(field));
221 return -1;
222 }
223
224 /* user did not ask for it explicitly so remove from the default list */
225 output[type].fields &= ~field;
5bff01f6 226 evname = perf_evsel__name(evsel);
9cbdb702
DA
227 pr_debug("Samples for '%s' event do not have %s attribute set. "
228 "Skipping '%s' field.\n",
229 evname, sample_msg, output_field2str(field));
230
231 return 0;
232}
233
6d5cdd64
AH
234static int perf_evsel__check_stype(struct perf_evsel *evsel,
235 u64 sample_type, const char *sample_msg,
236 enum perf_output_field field)
237{
238 return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field,
239 false);
240}
241
9cbdb702
DA
242static int perf_evsel__check_attr(struct perf_evsel *evsel,
243 struct perf_session *session)
244{
245 struct perf_event_attr *attr = &evsel->attr;
6d5cdd64
AH
246 bool allow_user_set;
247
e099eba8
JO
248 if (perf_header__has_feat(&session->header, HEADER_STAT))
249 return 0;
250
6d5cdd64
AH
251 allow_user_set = perf_header__has_feat(&session->header,
252 HEADER_AUXTRACE);
9cbdb702 253
1424dc96
DA
254 if (PRINT_FIELD(TRACE) &&
255 !perf_session__has_traces(session, "record -R"))
256 return -EINVAL;
257
787bef17 258 if (PRINT_FIELD(IP)) {
5bff01f6
ACM
259 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
260 PERF_OUTPUT_IP))
1424dc96 261 return -EINVAL;
1424dc96 262 }
7cec0922
DA
263
264 if (PRINT_FIELD(ADDR) &&
6d5cdd64
AH
265 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
266 PERF_OUTPUT_ADDR, allow_user_set))
7cec0922
DA
267 return -EINVAL;
268
94ddddfa
JO
269 if (PRINT_FIELD(DATA_SRC) &&
270 perf_evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC",
271 PERF_OUTPUT_DATA_SRC))
272 return -EINVAL;
273
274 if (PRINT_FIELD(WEIGHT) &&
275 perf_evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT",
276 PERF_OUTPUT_WEIGHT))
277 return -EINVAL;
278
7cec0922
DA
279 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
280 pr_err("Display of symbols requested but neither sample IP nor "
281 "sample address\nis selected. Hence, no addresses to convert "
282 "to symbols.\n");
787bef17
DA
283 return -EINVAL;
284 }
a978f2ab
AN
285 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
286 pr_err("Display of offsets requested but symbol is not"
287 "selected.\n");
288 return -EINVAL;
289 }
7cec0922
DA
290 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
291 pr_err("Display of DSO requested but neither sample IP nor "
292 "sample address\nis selected. Hence, no addresses to convert "
293 "to DSO.\n");
610723f2
DA
294 return -EINVAL;
295 }
cc8fae1d
AH
296 if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
297 pr_err("Display of source line number requested but sample IP is not\n"
298 "selected. Hence, no address to lookup the source line number.\n");
299 return -EINVAL;
300 }
48d02a1d
AK
301 if (PRINT_FIELD(BRSTACKINSN) &&
302 !(perf_evlist__combined_branch_type(session->evlist) &
303 PERF_SAMPLE_BRANCH_ANY)) {
304 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
305 "Hint: run 'perf record -b ...'\n");
306 return -EINVAL;
307 }
1424dc96 308 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
5bff01f6
ACM
309 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
310 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
1424dc96 311 return -EINVAL;
1424dc96
DA
312
313 if (PRINT_FIELD(TIME) &&
5bff01f6
ACM
314 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
315 PERF_OUTPUT_TIME))
1424dc96 316 return -EINVAL;
1424dc96
DA
317
318 if (PRINT_FIELD(CPU) &&
6d5cdd64
AH
319 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
320 PERF_OUTPUT_CPU, allow_user_set))
1424dc96 321 return -EINVAL;
9cbdb702 322
535aeaae
JO
323 if (PRINT_FIELD(PERIOD) &&
324 perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD",
325 PERF_OUTPUT_PERIOD))
326 return -EINVAL;
327
fc36f948
SE
328 if (PRINT_FIELD(IREGS) &&
329 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
330 PERF_OUTPUT_IREGS))
331 return -EINVAL;
332
9cbdb702
DA
333 return 0;
334}
335
7ea95727
AH
336static void set_print_ip_opts(struct perf_event_attr *attr)
337{
338 unsigned int type = attr->type;
339
340 output[type].print_ip_opts = 0;
341 if (PRINT_FIELD(IP))
e20ab86e 342 output[type].print_ip_opts |= EVSEL__PRINT_IP;
7ea95727
AH
343
344 if (PRINT_FIELD(SYM))
e20ab86e 345 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
7ea95727
AH
346
347 if (PRINT_FIELD(DSO))
e20ab86e 348 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
7ea95727
AH
349
350 if (PRINT_FIELD(SYMOFFSET))
e20ab86e 351 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
cc8fae1d
AH
352
353 if (PRINT_FIELD(SRCLINE))
e20ab86e 354 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
7ea95727
AH
355}
356
9cbdb702
DA
357/*
358 * verify all user requested events exist and the samples
359 * have the expected data
360 */
361static int perf_session__check_output_opt(struct perf_session *session)
362{
40f20e50 363 unsigned int j;
9cbdb702
DA
364 struct perf_evsel *evsel;
365
366 for (j = 0; j < PERF_TYPE_MAX; ++j) {
367 evsel = perf_session__find_first_evtype(session, j);
368
369 /*
370 * even if fields is set to 0 (ie., show nothing) event must
371 * exist if user explicitly includes it on the command line
372 */
373 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
374 pr_err("%s events do not exist. "
375 "Remove corresponding -f option to proceed.\n",
376 event_type(j));
377 return -1;
378 }
379
380 if (evsel && output[j].fields &&
381 perf_evsel__check_attr(evsel, session))
382 return -1;
a6ffaf91
DA
383
384 if (evsel == NULL)
385 continue;
386
7ea95727 387 set_print_ip_opts(&evsel->attr);
1424dc96
DA
388 }
389
98526ee7
AH
390 if (!no_callchain) {
391 bool use_callchain = false;
71ac899b 392 bool not_pipe = false;
98526ee7 393
e5cadb93 394 evlist__for_each_entry(session->evlist, evsel) {
71ac899b 395 not_pipe = true;
98526ee7
AH
396 if (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) {
397 use_callchain = true;
398 break;
399 }
400 }
71ac899b 401 if (not_pipe && !use_callchain)
98526ee7
AH
402 symbol_conf.use_callchain = false;
403 }
404
80b8b496
DA
405 /*
406 * set default for tracepoints to print symbols only
407 * if callchains are present
408 */
409 if (symbol_conf.use_callchain &&
410 !output[PERF_TYPE_TRACEPOINT].user_set) {
411 struct perf_event_attr *attr;
412
413 j = PERF_TYPE_TRACEPOINT;
80b8b496 414
e5cadb93 415 evlist__for_each_entry(session->evlist, evsel) {
40f20e50
HK
416 if (evsel->attr.type != j)
417 continue;
418
419 attr = &evsel->attr;
80b8b496 420
40f20e50
HK
421 if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
422 output[j].fields |= PERF_OUTPUT_IP;
423 output[j].fields |= PERF_OUTPUT_SYM;
424 output[j].fields |= PERF_OUTPUT_DSO;
425 set_print_ip_opts(attr);
426 goto out;
427 }
80b8b496
DA
428 }
429 }
430
431out:
1424dc96
DA
432 return 0;
433}
745f43e3 434
a3dff304 435static void print_sample_iregs(struct perf_sample *sample,
fc36f948
SE
436 struct perf_event_attr *attr)
437{
438 struct regs_dump *regs = &sample->intr_regs;
439 uint64_t mask = attr->sample_regs_intr;
440 unsigned i = 0, r;
441
442 if (!regs)
443 return;
444
445 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
446 u64 val = regs->regs[i++];
447 printf("%5s:0x%"PRIx64" ", perf_reg_name(r), val);
448 }
449}
450
fcf65bf1 451static void print_sample_start(struct perf_sample *sample,
1424dc96 452 struct thread *thread,
5bff01f6 453 struct perf_evsel *evsel)
c70c94b4 454{
5bff01f6 455 struct perf_event_attr *attr = &evsel->attr;
c70c94b4 456 unsigned long secs;
745f43e3
DA
457 unsigned long long nsecs;
458
459 if (PRINT_FIELD(COMM)) {
460 if (latency_format)
b9c5143a 461 printf("%8.8s ", thread__comm_str(thread));
787bef17 462 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
b9c5143a 463 printf("%s ", thread__comm_str(thread));
745f43e3 464 else
b9c5143a 465 printf("%16s ", thread__comm_str(thread));
745f43e3 466 }
c70c94b4 467
745f43e3
DA
468 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
469 printf("%5d/%-5d ", sample->pid, sample->tid);
470 else if (PRINT_FIELD(PID))
471 printf("%5d ", sample->pid);
472 else if (PRINT_FIELD(TID))
473 printf("%5d ", sample->tid);
474
475 if (PRINT_FIELD(CPU)) {
476 if (latency_format)
477 printf("%3d ", sample->cpu);
478 else
479 printf("[%03d] ", sample->cpu);
480 }
c70c94b4 481
745f43e3
DA
482 if (PRINT_FIELD(TIME)) {
483 nsecs = sample->time;
bd48c63e
ACM
484 secs = nsecs / NSEC_PER_SEC;
485 nsecs -= secs * NSEC_PER_SEC;
99620a5d 486
83e19860
AH
487 if (nanosecs)
488 printf("%5lu.%09llu: ", secs, nsecs);
99620a5d
NK
489 else {
490 char sample_time[32];
491 timestamp__scnprintf_usec(sample->time, sample_time, sizeof(sample_time));
492 printf("%12s: ", sample_time);
493 }
745f43e3 494 }
c70c94b4
DA
495}
496
dc323ce8
SE
497static inline char
498mispred_str(struct branch_entry *br)
499{
500 if (!(br->flags.mispred || br->flags.predicted))
501 return '-';
502
503 return br->flags.predicted ? 'P' : 'M';
504}
505
a3dff304 506static void print_sample_brstack(struct perf_sample *sample)
dc323ce8
SE
507{
508 struct branch_stack *br = sample->branch_stack;
509 u64 i;
510
511 if (!(br && br->nr))
512 return;
513
514 for (i = 0; i < br->nr; i++) {
515 printf(" 0x%"PRIx64"/0x%"PRIx64"/%c/%c/%c/%d ",
516 br->entries[i].from,
517 br->entries[i].to,
518 mispred_str( br->entries + i),
519 br->entries[i].flags.in_tx? 'X' : '-',
520 br->entries[i].flags.abort? 'A' : '-',
521 br->entries[i].flags.cycles);
522 }
523}
524
a3dff304
ACM
525static void print_sample_brstacksym(struct perf_sample *sample,
526 struct thread *thread)
dc323ce8
SE
527{
528 struct branch_stack *br = sample->branch_stack;
529 struct addr_location alf, alt;
dc323ce8
SE
530 u64 i, from, to;
531
532 if (!(br && br->nr))
533 return;
534
535 for (i = 0; i < br->nr; i++) {
536
537 memset(&alf, 0, sizeof(alf));
538 memset(&alt, 0, sizeof(alt));
539 from = br->entries[i].from;
540 to = br->entries[i].to;
541
473398a2 542 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, from, &alf);
dc323ce8 543 if (alf.map)
be39db9f 544 alf.sym = map__find_symbol(alf.map, alf.addr);
dc323ce8 545
473398a2 546 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, to, &alt);
dc323ce8 547 if (alt.map)
be39db9f 548 alt.sym = map__find_symbol(alt.map, alt.addr);
dc323ce8
SE
549
550 symbol__fprintf_symname_offs(alf.sym, &alf, stdout);
551 putchar('/');
552 symbol__fprintf_symname_offs(alt.sym, &alt, stdout);
553 printf("/%c/%c/%c/%d ",
554 mispred_str( br->entries + i),
555 br->entries[i].flags.in_tx? 'X' : '-',
556 br->entries[i].flags.abort? 'A' : '-',
557 br->entries[i].flags.cycles);
558 }
559}
560
48d02a1d
AK
561#define MAXBB 16384UL
562
563static int grab_bb(u8 *buffer, u64 start, u64 end,
564 struct machine *machine, struct thread *thread,
565 bool *is64bit, u8 *cpumode, bool last)
566{
567 long offset, len;
568 struct addr_location al;
569 bool kernel;
570
571 if (!start || !end)
572 return 0;
573
574 kernel = machine__kernel_ip(machine, start);
575 if (kernel)
576 *cpumode = PERF_RECORD_MISC_KERNEL;
577 else
578 *cpumode = PERF_RECORD_MISC_USER;
579
580 /*
581 * Block overlaps between kernel and user.
582 * This can happen due to ring filtering
583 * On Intel CPUs the entry into the kernel is filtered,
584 * but the exit is not. Let the caller patch it up.
585 */
586 if (kernel != machine__kernel_ip(machine, end)) {
587 printf("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n",
588 start, end);
589 return -ENXIO;
590 }
591
592 memset(&al, 0, sizeof(al));
593 if (end - start > MAXBB - MAXINSN) {
594 if (last)
595 printf("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
596 else
597 printf("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
598 return 0;
599 }
600
601 thread__find_addr_map(thread, *cpumode, MAP__FUNCTION, start, &al);
602 if (!al.map || !al.map->dso) {
603 printf("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
604 return 0;
605 }
606 if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
607 printf("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
608 return 0;
609 }
610
611 /* Load maps to ensure dso->is_64_bit has been updated */
612 map__load(al.map);
613
614 offset = al.map->map_ip(al.map, start);
615 len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
616 end - start + MAXINSN);
617
618 *is64bit = al.map->dso->is_64_bit;
619 if (len <= 0)
620 printf("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
621 start, end);
622 return len;
623}
624
625static void print_jump(uint64_t ip, struct branch_entry *en,
626 struct perf_insn *x, u8 *inbuf, int len,
627 int insn)
628{
629 printf("\t%016" PRIx64 "\t%-30s\t#%s%s%s%s",
630 ip,
631 dump_insn(x, ip, inbuf, len, NULL),
632 en->flags.predicted ? " PRED" : "",
633 en->flags.mispred ? " MISPRED" : "",
634 en->flags.in_tx ? " INTX" : "",
635 en->flags.abort ? " ABORT" : "");
636 if (en->flags.cycles) {
637 printf(" %d cycles", en->flags.cycles);
638 if (insn)
639 printf(" %.2f IPC", (float)insn / en->flags.cycles);
640 }
641 putchar('\n');
642}
643
644static void print_ip_sym(struct thread *thread, u8 cpumode, int cpu,
645 uint64_t addr, struct symbol **lastsym,
646 struct perf_event_attr *attr)
647{
648 struct addr_location al;
649 int off;
650
651 memset(&al, 0, sizeof(al));
652
653 thread__find_addr_map(thread, cpumode, MAP__FUNCTION, addr, &al);
654 if (!al.map)
655 thread__find_addr_map(thread, cpumode, MAP__VARIABLE,
656 addr, &al);
657 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
658 return;
659
660 al.cpu = cpu;
661 al.sym = NULL;
662 if (al.map)
663 al.sym = map__find_symbol(al.map, al.addr);
664
665 if (!al.sym)
666 return;
667
668 if (al.addr < al.sym->end)
669 off = al.addr - al.sym->start;
670 else
671 off = al.addr - al.map->start - al.sym->start;
672 printf("\t%s", al.sym->name);
673 if (off)
674 printf("%+d", off);
675 putchar(':');
676 if (PRINT_FIELD(SRCLINE))
677 map__fprintf_srcline(al.map, al.addr, "\t", stdout);
678 putchar('\n');
679 *lastsym = al.sym;
680}
681
682static void print_sample_brstackinsn(struct perf_sample *sample,
683 struct thread *thread,
684 struct perf_event_attr *attr,
685 struct machine *machine)
686{
687 struct branch_stack *br = sample->branch_stack;
688 u64 start, end;
689 int i, insn, len, nr, ilen;
690 struct perf_insn x;
691 u8 buffer[MAXBB];
692 unsigned off;
693 struct symbol *lastsym = NULL;
694
695 if (!(br && br->nr))
696 return;
697 nr = br->nr;
698 if (max_blocks && nr > max_blocks + 1)
699 nr = max_blocks + 1;
700
701 x.thread = thread;
702 x.cpu = sample->cpu;
703
704 putchar('\n');
705
706 /* Handle first from jump, of which we don't know the entry. */
707 len = grab_bb(buffer, br->entries[nr-1].from,
708 br->entries[nr-1].from,
709 machine, thread, &x.is64bit, &x.cpumode, false);
710 if (len > 0) {
711 print_ip_sym(thread, x.cpumode, x.cpu,
712 br->entries[nr - 1].from, &lastsym, attr);
713 print_jump(br->entries[nr - 1].from, &br->entries[nr - 1],
714 &x, buffer, len, 0);
715 }
716
717 /* Print all blocks */
718 for (i = nr - 2; i >= 0; i--) {
719 if (br->entries[i].from || br->entries[i].to)
720 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
721 br->entries[i].from,
722 br->entries[i].to);
723 start = br->entries[i + 1].to;
724 end = br->entries[i].from;
725
726 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
727 /* Patch up missing kernel transfers due to ring filters */
728 if (len == -ENXIO && i > 0) {
729 end = br->entries[--i].from;
730 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
731 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
732 }
733 if (len <= 0)
734 continue;
735
736 insn = 0;
737 for (off = 0;; off += ilen) {
738 uint64_t ip = start + off;
739
740 print_ip_sym(thread, x.cpumode, x.cpu, ip, &lastsym, attr);
741 if (ip == end) {
742 print_jump(ip, &br->entries[i], &x, buffer + off, len - off, insn);
743 break;
744 } else {
745 printf("\t%016" PRIx64 "\t%s\n", ip,
746 dump_insn(&x, ip, buffer + off, len - off, &ilen));
747 if (ilen == 0)
748 break;
749 insn++;
750 }
751 }
752 }
753
754 /*
755 * Hit the branch? In this case we are already done, and the target
756 * has not been executed yet.
757 */
758 if (br->entries[0].from == sample->ip)
759 return;
760 if (br->entries[0].flags.abort)
761 return;
762
763 /*
764 * Print final block upto sample
765 */
766 start = br->entries[0].to;
767 end = sample->ip;
768 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
769 print_ip_sym(thread, x.cpumode, x.cpu, start, &lastsym, attr);
770 if (len <= 0) {
771 /* Print at least last IP if basic block did not work */
772 len = grab_bb(buffer, sample->ip, sample->ip,
773 machine, thread, &x.is64bit, &x.cpumode, false);
774 if (len <= 0)
775 return;
776
777 printf("\t%016" PRIx64 "\t%s\n", sample->ip,
778 dump_insn(&x, sample->ip, buffer, len, NULL));
779 return;
780 }
781 for (off = 0; off <= end - start; off += ilen) {
782 printf("\t%016" PRIx64 "\t%s\n", start + off,
783 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
784 if (ilen == 0)
785 break;
786 }
787}
dc323ce8 788
a3dff304 789static void print_sample_addr(struct perf_sample *sample,
7cec0922
DA
790 struct thread *thread,
791 struct perf_event_attr *attr)
792{
793 struct addr_location al;
7cec0922
DA
794
795 printf("%16" PRIx64, sample->addr);
796
797 if (!sample_addr_correlates_sym(attr))
798 return;
799
c2740a87 800 thread__resolve(thread, &al, sample);
7cec0922
DA
801
802 if (PRINT_FIELD(SYM)) {
547a92e0 803 printf(" ");
a978f2ab
AN
804 if (PRINT_FIELD(SYMOFFSET))
805 symbol__fprintf_symname_offs(al.sym, &al, stdout);
806 else
807 symbol__fprintf_symname(al.sym, stdout);
7cec0922
DA
808 }
809
810 if (PRINT_FIELD(DSO)) {
547a92e0
AN
811 printf(" (");
812 map__fprintf_dsoname(al.map, stdout);
813 printf(")");
7cec0922
DA
814 }
815}
816
e216708d
AH
817static void print_sample_callindent(struct perf_sample *sample,
818 struct perf_evsel *evsel,
819 struct thread *thread,
820 struct addr_location *al)
821{
822 struct perf_event_attr *attr = &evsel->attr;
823 size_t depth = thread_stack__depth(thread);
824 struct addr_location addr_al;
825 const char *name = NULL;
826 static int spacing;
827 int len = 0;
828 u64 ip = 0;
829
830 /*
831 * The 'return' has already been popped off the stack so the depth has
832 * to be adjusted to match the 'call'.
833 */
834 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
835 depth += 1;
836
837 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
838 if (sample_addr_correlates_sym(attr)) {
839 thread__resolve(thread, &addr_al, sample);
840 if (addr_al.sym)
841 name = addr_al.sym->name;
842 else
843 ip = sample->addr;
844 } else {
845 ip = sample->addr;
846 }
847 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
848 if (al->sym)
849 name = al->sym->name;
850 else
851 ip = sample->ip;
852 }
853
854 if (name)
855 len = printf("%*s%s", (int)depth * 4, "", name);
856 else if (ip)
857 len = printf("%*s%16" PRIx64, (int)depth * 4, "", ip);
858
859 if (len < 0)
860 return;
861
862 /*
863 * Try to keep the output length from changing frequently so that the
864 * output lines up more nicely.
865 */
866 if (len > spacing || (len && len < spacing - 52))
867 spacing = round_up(len + 4, 32);
868
869 if (len < spacing)
870 printf("%*s", spacing - len, "");
871}
872
224e2c97 873static void print_insn(struct perf_sample *sample,
48d02a1d
AK
874 struct perf_event_attr *attr,
875 struct thread *thread,
876 struct machine *machine)
224e2c97
AK
877{
878 if (PRINT_FIELD(INSNLEN))
879 printf(" ilen: %d", sample->insn_len);
880 if (PRINT_FIELD(INSN)) {
881 int i;
882
883 printf(" insn:");
884 for (i = 0; i < sample->insn_len; i++)
885 printf(" %02x", (unsigned char)sample->insn[i]);
886 }
48d02a1d
AK
887 if (PRINT_FIELD(BRSTACKINSN))
888 print_sample_brstackinsn(sample, thread, attr, machine);
224e2c97
AK
889}
890
a3dff304 891static void print_sample_bts(struct perf_sample *sample,
95582596 892 struct perf_evsel *evsel,
a2cb3cf2 893 struct thread *thread,
48d02a1d
AK
894 struct addr_location *al,
895 struct machine *machine)
95582596
AN
896{
897 struct perf_event_attr *attr = &evsel->attr;
8066be5f 898 bool print_srcline_last = false;
95582596 899
e216708d
AH
900 if (PRINT_FIELD(CALLINDENT))
901 print_sample_callindent(sample, evsel, thread, al);
902
95582596
AN
903 /* print branch_from information */
904 if (PRINT_FIELD(IP)) {
8066be5f 905 unsigned int print_opts = output[attr->type].print_ip_opts;
e557b674 906 struct callchain_cursor *cursor = NULL;
8066be5f 907
6f736735 908 if (symbol_conf.use_callchain && sample->callchain &&
e557b674 909 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
6f736735 910 sample, NULL, NULL, scripting_max_stack) == 0)
e557b674 911 cursor = &callchain_cursor;
6f736735
ACM
912
913 if (cursor == NULL) {
914 putchar(' ');
e20ab86e 915 if (print_opts & EVSEL__PRINT_SRCLINE) {
8066be5f 916 print_srcline_last = true;
e20ab86e 917 print_opts &= ~EVSEL__PRINT_SRCLINE;
8066be5f 918 }
6f736735
ACM
919 } else
920 putchar('\n');
921
922 sample__fprintf_sym(sample, al, 0, print_opts, cursor, stdout);
95582596
AN
923 }
924
95582596 925 /* print branch_to information */
243be3dd
AH
926 if (PRINT_FIELD(ADDR) ||
927 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
578bea40
AH
928 !output[attr->type].user_set)) {
929 printf(" => ");
a3dff304 930 print_sample_addr(sample, thread, attr);
578bea40 931 }
95582596 932
8066be5f
AH
933 if (print_srcline_last)
934 map__fprintf_srcline(al->map, al->addr, "\n ", stdout);
935
48d02a1d 936 print_insn(sample, attr, thread, machine);
224e2c97 937
95582596
AN
938 printf("\n");
939}
940
055cd33d
AH
941static struct {
942 u32 flags;
943 const char *name;
944} sample_flags[] = {
945 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
946 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
947 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
948 {PERF_IP_FLAG_BRANCH, "jmp"},
949 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
950 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
951 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
952 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
953 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
954 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
955 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
956 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
957 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
958 {0, NULL}
959};
960
400ea6d3
AH
961static void print_sample_flags(u32 flags)
962{
963 const char *chars = PERF_IP_FLAG_CHARS;
964 const int n = strlen(PERF_IP_FLAG_CHARS);
055cd33d
AH
965 bool in_tx = flags & PERF_IP_FLAG_IN_TX;
966 const char *name = NULL;
400ea6d3
AH
967 char str[33];
968 int i, pos = 0;
969
055cd33d
AH
970 for (i = 0; sample_flags[i].name ; i++) {
971 if (sample_flags[i].flags == (flags & ~PERF_IP_FLAG_IN_TX)) {
972 name = sample_flags[i].name;
973 break;
974 }
975 }
976
400ea6d3
AH
977 for (i = 0; i < n; i++, flags >>= 1) {
978 if (flags & 1)
979 str[pos++] = chars[i];
980 }
981 for (; i < 32; i++, flags >>= 1) {
982 if (flags & 1)
983 str[pos++] = '?';
984 }
985 str[pos] = 0;
055cd33d
AH
986
987 if (name)
988 printf(" %-7s%4s ", name, in_tx ? "(x)" : "");
989 else
990 printf(" %-11s ", str);
400ea6d3
AH
991}
992
30372f04
WN
993struct printer_data {
994 int line_no;
995 bool hit_nul;
996 bool is_printable;
997};
998
999static void
1000print_sample_bpf_output_printer(enum binary_printer_ops op,
1001 unsigned int val,
1002 void *extra)
1003{
1004 unsigned char ch = (unsigned char)val;
1005 struct printer_data *printer_data = extra;
1006
1007 switch (op) {
1008 case BINARY_PRINT_DATA_BEGIN:
1009 printf("\n");
1010 break;
1011 case BINARY_PRINT_LINE_BEGIN:
1012 printf("%17s", !printer_data->line_no ? "BPF output:" :
1013 " ");
1014 break;
1015 case BINARY_PRINT_ADDR:
1016 printf(" %04x:", val);
1017 break;
1018 case BINARY_PRINT_NUM_DATA:
1019 printf(" %02x", val);
1020 break;
1021 case BINARY_PRINT_NUM_PAD:
1022 printf(" ");
1023 break;
1024 case BINARY_PRINT_SEP:
1025 printf(" ");
1026 break;
1027 case BINARY_PRINT_CHAR_DATA:
1028 if (printer_data->hit_nul && ch)
1029 printer_data->is_printable = false;
1030
1031 if (!isprint(ch)) {
1032 printf("%c", '.');
1033
1034 if (!printer_data->is_printable)
1035 break;
1036
1037 if (ch == '\0')
1038 printer_data->hit_nul = true;
1039 else
1040 printer_data->is_printable = false;
1041 } else {
1042 printf("%c", ch);
1043 }
1044 break;
1045 case BINARY_PRINT_CHAR_PAD:
1046 printf(" ");
1047 break;
1048 case BINARY_PRINT_LINE_END:
1049 printf("\n");
1050 printer_data->line_no++;
1051 break;
1052 case BINARY_PRINT_DATA_END:
1053 default:
1054 break;
1055 }
1056}
1057
1058static void print_sample_bpf_output(struct perf_sample *sample)
1059{
1060 unsigned int nr_bytes = sample->raw_size;
1061 struct printer_data printer_data = {0, false, true};
1062
1063 print_binary(sample->raw_data, nr_bytes, 8,
1064 print_sample_bpf_output_printer, &printer_data);
1065
1066 if (printer_data.is_printable && printer_data.hit_nul)
1067 printf("%17s \"%s\"\n", "BPF string:",
1068 (char *)(sample->raw_data));
1069}
1070
809e9423
JO
1071struct perf_script {
1072 struct perf_tool tool;
1073 struct perf_session *session;
1074 bool show_task_events;
1075 bool show_mmap_events;
1076 bool show_switch_events;
96a44bbc 1077 bool show_namespace_events;
cfc8874a
JO
1078 bool allocated;
1079 struct cpu_map *cpus;
1080 struct thread_map *threads;
9cdbc409 1081 int name_width;
a91f4c47
DA
1082 const char *time_str;
1083 struct perf_time_interval ptime;
809e9423
JO
1084};
1085
9cdbc409
JO
1086static int perf_evlist__max_name_len(struct perf_evlist *evlist)
1087{
1088 struct perf_evsel *evsel;
1089 int max = 0;
1090
e5cadb93 1091 evlist__for_each_entry(evlist, evsel) {
9cdbc409
JO
1092 int len = strlen(perf_evsel__name(evsel));
1093
1094 max = MAX(len, max);
1095 }
1096
1097 return max;
1098}
1099
c19ac912
JO
1100static size_t data_src__printf(u64 data_src)
1101{
1102 struct mem_info mi = { .data_src.val = data_src };
1103 char decode[100];
1104 char out[100];
1105 static int maxlen;
1106 int len;
1107
1108 perf_script__meminfo_scnprintf(decode, 100, &mi);
1109
1110 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
1111 if (maxlen < len)
1112 maxlen = len;
1113
1114 return printf("%-*s", maxlen, out);
1115}
1116
a3dff304 1117static void process_event(struct perf_script *script,
809e9423 1118 struct perf_sample *sample, struct perf_evsel *evsel,
48d02a1d
AK
1119 struct addr_location *al,
1120 struct machine *machine)
be6d842a 1121{
f9d5d549 1122 struct thread *thread = al->thread;
9e69c210 1123 struct perf_event_attr *attr = &evsel->attr;
1424dc96 1124
2c9e45f7 1125 if (output[attr->type].fields == 0)
1424dc96
DA
1126 return;
1127
fcf65bf1 1128 print_sample_start(sample, thread, evsel);
745f43e3 1129
535aeaae
JO
1130 if (PRINT_FIELD(PERIOD))
1131 printf("%10" PRIu64 " ", sample->period);
1132
e944d3d7
NK
1133 if (PRINT_FIELD(EVNAME)) {
1134 const char *evname = perf_evsel__name(evsel);
9cdbc409
JO
1135
1136 if (!script->name_width)
1137 script->name_width = perf_evlist__max_name_len(script->session->evlist);
1138
1139 printf("%*s: ", script->name_width,
1140 evname ? evname : "[unknown]");
e944d3d7
NK
1141 }
1142
400ea6d3
AH
1143 if (print_flags)
1144 print_sample_flags(sample->flags);
1145
95582596 1146 if (is_bts_event(attr)) {
48d02a1d 1147 print_sample_bts(sample, evsel, thread, al, machine);
95582596
AN
1148 return;
1149 }
1150
745f43e3 1151 if (PRINT_FIELD(TRACE))
fcf65bf1
ACM
1152 event_format__print(evsel->tp_format, sample->cpu,
1153 sample->raw_data, sample->raw_size);
7cec0922 1154 if (PRINT_FIELD(ADDR))
a3dff304 1155 print_sample_addr(sample, thread, attr);
7cec0922 1156
94ddddfa 1157 if (PRINT_FIELD(DATA_SRC))
c19ac912 1158 data_src__printf(sample->data_src);
94ddddfa
JO
1159
1160 if (PRINT_FIELD(WEIGHT))
1161 printf("%16" PRIu64, sample->weight);
1162
787bef17 1163 if (PRINT_FIELD(IP)) {
e557b674 1164 struct callchain_cursor *cursor = NULL;
6f736735 1165
92231521 1166 if (symbol_conf.use_callchain && sample->callchain &&
e557b674 1167 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
6f736735 1168 sample, NULL, NULL, scripting_max_stack) == 0)
e557b674 1169 cursor = &callchain_cursor;
a6ffaf91 1170
6f736735
ACM
1171 putchar(cursor ? '\n' : ' ');
1172 sample__fprintf_sym(sample, al, 0, output[attr->type].print_ip_opts, cursor, stdout);
c0230b2b
DA
1173 }
1174
fc36f948 1175 if (PRINT_FIELD(IREGS))
a3dff304 1176 print_sample_iregs(sample, attr);
fc36f948 1177
dc323ce8 1178 if (PRINT_FIELD(BRSTACK))
a3dff304 1179 print_sample_brstack(sample);
dc323ce8 1180 else if (PRINT_FIELD(BRSTACKSYM))
a3dff304 1181 print_sample_brstacksym(sample, thread);
dc323ce8 1182
30372f04
WN
1183 if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
1184 print_sample_bpf_output(sample);
48d02a1d 1185 print_insn(sample, attr, thread, machine);
c70c94b4 1186 printf("\n");
be6d842a
DA
1187}
1188
956ffd02
TZ
1189static struct scripting_ops *scripting_ops;
1190
36e33c53
JO
1191static void __process_stat(struct perf_evsel *counter, u64 tstamp)
1192{
1193 int nthreads = thread_map__nr(counter->threads);
1194 int ncpus = perf_evsel__nr_cpus(counter);
1195 int cpu, thread;
1196 static int header_printed;
1197
1198 if (counter->system_wide)
1199 nthreads = 1;
1200
1201 if (!header_printed) {
1202 printf("%3s %8s %15s %15s %15s %15s %s\n",
1203 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
1204 header_printed = 1;
1205 }
1206
1207 for (thread = 0; thread < nthreads; thread++) {
1208 for (cpu = 0; cpu < ncpus; cpu++) {
1209 struct perf_counts_values *counts;
1210
1211 counts = perf_counts(counter->counts, cpu, thread);
1212
1213 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
1214 counter->cpus->map[cpu],
1215 thread_map__pid(counter->threads, thread),
1216 counts->val,
1217 counts->ena,
1218 counts->run,
1219 tstamp,
1220 perf_evsel__name(counter));
1221 }
1222 }
1223}
1224
e099eba8
JO
1225static void process_stat(struct perf_evsel *counter, u64 tstamp)
1226{
1227 if (scripting_ops && scripting_ops->process_stat)
1228 scripting_ops->process_stat(&stat_config, counter, tstamp);
36e33c53
JO
1229 else
1230 __process_stat(counter, tstamp);
e099eba8
JO
1231}
1232
1233static void process_stat_interval(u64 tstamp)
1234{
1235 if (scripting_ops && scripting_ops->process_stat_interval)
1236 scripting_ops->process_stat_interval(tstamp);
1237}
1238
956ffd02
TZ
1239static void setup_scripting(void)
1240{
16c632de 1241 setup_perl_scripting();
7e4b21b8 1242 setup_python_scripting();
956ffd02
TZ
1243}
1244
d445dd2a
AH
1245static int flush_scripting(void)
1246{
2aaecfc5 1247 return scripting_ops ? scripting_ops->flush_script() : 0;
d445dd2a
AH
1248}
1249
956ffd02
TZ
1250static int cleanup_scripting(void)
1251{
133dc4c3 1252 pr_debug("\nperf script stopped\n");
3824a4e8 1253
2aaecfc5 1254 return scripting_ops ? scripting_ops->stop_script() : 0;
956ffd02
TZ
1255}
1256
809e9423 1257static int process_sample_event(struct perf_tool *tool,
d20deb64 1258 union perf_event *event,
8115d60c 1259 struct perf_sample *sample,
9e69c210 1260 struct perf_evsel *evsel,
743eb868 1261 struct machine *machine)
5f9c39dc 1262{
809e9423 1263 struct perf_script *scr = container_of(tool, struct perf_script, tool);
e7984b7b 1264 struct addr_location al;
5f9c39dc 1265
a91f4c47
DA
1266 if (perf_time__skip_sample(&scr->ptime, sample->time))
1267 return 0;
1268
1424dc96
DA
1269 if (debug_mode) {
1270 if (sample->time < last_timestamp) {
1271 pr_err("Samples misordered, previous: %" PRIu64
1272 " this: %" PRIu64 "\n", last_timestamp,
1273 sample->time);
1274 nr_unordered++;
e1889d75 1275 }
1424dc96
DA
1276 last_timestamp = sample->time;
1277 return 0;
5f9c39dc 1278 }
5d67be97 1279
bb3eb566 1280 if (machine__resolve(machine, &al, sample) < 0) {
e7984b7b
DA
1281 pr_err("problem processing %d event, skipping it.\n",
1282 event->header.type);
1283 return -1;
1284 }
1285
1286 if (al.filtered)
b91fc39f 1287 goto out_put;
e7984b7b 1288
5d67be97 1289 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
b91fc39f 1290 goto out_put;
5d67be97 1291
2aaecfc5
JO
1292 if (scripting_ops)
1293 scripting_ops->process_event(event, sample, evsel, &al);
1294 else
48d02a1d 1295 process_event(scr, sample, evsel, &al, machine);
2aaecfc5 1296
b91fc39f
ACM
1297out_put:
1298 addr_location__put(&al);
5f9c39dc
FW
1299 return 0;
1300}
1301
7ea95727
AH
1302static int process_attr(struct perf_tool *tool, union perf_event *event,
1303 struct perf_evlist **pevlist)
1304{
1305 struct perf_script *scr = container_of(tool, struct perf_script, tool);
1306 struct perf_evlist *evlist;
1307 struct perf_evsel *evsel, *pos;
1308 int err;
1309
1310 err = perf_event__process_attr(tool, event, pevlist);
1311 if (err)
1312 return err;
1313
1314 evlist = *pevlist;
1315 evsel = perf_evlist__last(*pevlist);
1316
1317 if (evsel->attr.type >= PERF_TYPE_MAX)
1318 return 0;
1319
e5cadb93 1320 evlist__for_each_entry(evlist, pos) {
7ea95727
AH
1321 if (pos->attr.type == evsel->attr.type && pos != evsel)
1322 return 0;
1323 }
1324
1325 set_print_ip_opts(&evsel->attr);
1326
d2b5a315
JO
1327 if (evsel->attr.sample_type)
1328 err = perf_evsel__check_attr(evsel, scr->session);
1329
1330 return err;
7ea95727
AH
1331}
1332
ad7ebb9a
NK
1333static int process_comm_event(struct perf_tool *tool,
1334 union perf_event *event,
1335 struct perf_sample *sample,
1336 struct machine *machine)
1337{
1338 struct thread *thread;
1339 struct perf_script *script = container_of(tool, struct perf_script, tool);
1340 struct perf_session *session = script->session;
06b234ec 1341 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
ad7ebb9a
NK
1342 int ret = -1;
1343
1344 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
1345 if (thread == NULL) {
1346 pr_debug("problem processing COMM event, skipping it.\n");
1347 return -1;
1348 }
1349
1350 if (perf_event__process_comm(tool, event, sample, machine) < 0)
1351 goto out;
1352
1353 if (!evsel->attr.sample_id_all) {
1354 sample->cpu = 0;
1355 sample->time = 0;
1356 sample->tid = event->comm.tid;
1357 sample->pid = event->comm.pid;
1358 }
1359 print_sample_start(sample, thread, evsel);
1360 perf_event__fprintf(event, stdout);
1361 ret = 0;
ad7ebb9a 1362out:
b91fc39f 1363 thread__put(thread);
ad7ebb9a
NK
1364 return ret;
1365}
1366
96a44bbc
HB
1367static int process_namespaces_event(struct perf_tool *tool,
1368 union perf_event *event,
1369 struct perf_sample *sample,
1370 struct machine *machine)
1371{
1372 struct thread *thread;
1373 struct perf_script *script = container_of(tool, struct perf_script, tool);
1374 struct perf_session *session = script->session;
1375 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1376 int ret = -1;
1377
1378 thread = machine__findnew_thread(machine, event->namespaces.pid,
1379 event->namespaces.tid);
1380 if (thread == NULL) {
1381 pr_debug("problem processing NAMESPACES event, skipping it.\n");
1382 return -1;
1383 }
1384
1385 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
1386 goto out;
1387
1388 if (!evsel->attr.sample_id_all) {
1389 sample->cpu = 0;
1390 sample->time = 0;
1391 sample->tid = event->namespaces.tid;
1392 sample->pid = event->namespaces.pid;
1393 }
1394 print_sample_start(sample, thread, evsel);
1395 perf_event__fprintf(event, stdout);
1396 ret = 0;
1397out:
1398 thread__put(thread);
1399 return ret;
1400}
1401
ad7ebb9a
NK
1402static int process_fork_event(struct perf_tool *tool,
1403 union perf_event *event,
1404 struct perf_sample *sample,
1405 struct machine *machine)
1406{
1407 struct thread *thread;
1408 struct perf_script *script = container_of(tool, struct perf_script, tool);
1409 struct perf_session *session = script->session;
06b234ec 1410 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
ad7ebb9a
NK
1411
1412 if (perf_event__process_fork(tool, event, sample, machine) < 0)
1413 return -1;
1414
1415 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
1416 if (thread == NULL) {
1417 pr_debug("problem processing FORK event, skipping it.\n");
1418 return -1;
1419 }
1420
1421 if (!evsel->attr.sample_id_all) {
1422 sample->cpu = 0;
1423 sample->time = event->fork.time;
1424 sample->tid = event->fork.tid;
1425 sample->pid = event->fork.pid;
1426 }
1427 print_sample_start(sample, thread, evsel);
1428 perf_event__fprintf(event, stdout);
b91fc39f 1429 thread__put(thread);
ad7ebb9a
NK
1430
1431 return 0;
1432}
1433static int process_exit_event(struct perf_tool *tool,
1434 union perf_event *event,
1435 struct perf_sample *sample,
1436 struct machine *machine)
1437{
b91fc39f 1438 int err = 0;
ad7ebb9a
NK
1439 struct thread *thread;
1440 struct perf_script *script = container_of(tool, struct perf_script, tool);
1441 struct perf_session *session = script->session;
06b234ec 1442 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
ad7ebb9a
NK
1443
1444 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
1445 if (thread == NULL) {
1446 pr_debug("problem processing EXIT event, skipping it.\n");
1447 return -1;
1448 }
1449
1450 if (!evsel->attr.sample_id_all) {
1451 sample->cpu = 0;
1452 sample->time = 0;
53ff6bc3
AH
1453 sample->tid = event->fork.tid;
1454 sample->pid = event->fork.pid;
ad7ebb9a
NK
1455 }
1456 print_sample_start(sample, thread, evsel);
1457 perf_event__fprintf(event, stdout);
1458
1459 if (perf_event__process_exit(tool, event, sample, machine) < 0)
b91fc39f 1460 err = -1;
ad7ebb9a 1461
b91fc39f
ACM
1462 thread__put(thread);
1463 return err;
ad7ebb9a
NK
1464}
1465
ba1ddf42
NK
1466static int process_mmap_event(struct perf_tool *tool,
1467 union perf_event *event,
1468 struct perf_sample *sample,
1469 struct machine *machine)
1470{
1471 struct thread *thread;
1472 struct perf_script *script = container_of(tool, struct perf_script, tool);
1473 struct perf_session *session = script->session;
06b234ec 1474 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
ba1ddf42
NK
1475
1476 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
1477 return -1;
1478
1479 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
1480 if (thread == NULL) {
1481 pr_debug("problem processing MMAP event, skipping it.\n");
1482 return -1;
1483 }
1484
1485 if (!evsel->attr.sample_id_all) {
1486 sample->cpu = 0;
1487 sample->time = 0;
1488 sample->tid = event->mmap.tid;
1489 sample->pid = event->mmap.pid;
1490 }
1491 print_sample_start(sample, thread, evsel);
1492 perf_event__fprintf(event, stdout);
b91fc39f 1493 thread__put(thread);
ba1ddf42
NK
1494 return 0;
1495}
1496
1497static int process_mmap2_event(struct perf_tool *tool,
1498 union perf_event *event,
1499 struct perf_sample *sample,
1500 struct machine *machine)
1501{
1502 struct thread *thread;
1503 struct perf_script *script = container_of(tool, struct perf_script, tool);
1504 struct perf_session *session = script->session;
06b234ec 1505 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
ba1ddf42
NK
1506
1507 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
1508 return -1;
1509
1510 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
1511 if (thread == NULL) {
1512 pr_debug("problem processing MMAP2 event, skipping it.\n");
1513 return -1;
1514 }
1515
1516 if (!evsel->attr.sample_id_all) {
1517 sample->cpu = 0;
1518 sample->time = 0;
1519 sample->tid = event->mmap2.tid;
1520 sample->pid = event->mmap2.pid;
1521 }
1522 print_sample_start(sample, thread, evsel);
1523 perf_event__fprintf(event, stdout);
b91fc39f 1524 thread__put(thread);
ba1ddf42
NK
1525 return 0;
1526}
1527
7c14898b
AH
1528static int process_switch_event(struct perf_tool *tool,
1529 union perf_event *event,
1530 struct perf_sample *sample,
1531 struct machine *machine)
1532{
1533 struct thread *thread;
1534 struct perf_script *script = container_of(tool, struct perf_script, tool);
1535 struct perf_session *session = script->session;
1536 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1537
1538 if (perf_event__process_switch(tool, event, sample, machine) < 0)
1539 return -1;
1540
1541 thread = machine__findnew_thread(machine, sample->pid,
1542 sample->tid);
1543 if (thread == NULL) {
1544 pr_debug("problem processing SWITCH event, skipping it.\n");
1545 return -1;
1546 }
1547
1548 print_sample_start(sample, thread, evsel);
1549 perf_event__fprintf(event, stdout);
1550 thread__put(thread);
1551 return 0;
1552}
1553
1d037ca1 1554static void sig_handler(int sig __maybe_unused)
c239da3b
TZ
1555{
1556 session_done = 1;
1557}
1558
6f3e5eda 1559static int __cmd_script(struct perf_script *script)
5f9c39dc 1560{
6fcf7ddb
FW
1561 int ret;
1562
c239da3b
TZ
1563 signal(SIGINT, sig_handler);
1564
ad7ebb9a
NK
1565 /* override event processing functions */
1566 if (script->show_task_events) {
1567 script->tool.comm = process_comm_event;
1568 script->tool.fork = process_fork_event;
1569 script->tool.exit = process_exit_event;
1570 }
ba1ddf42
NK
1571 if (script->show_mmap_events) {
1572 script->tool.mmap = process_mmap_event;
1573 script->tool.mmap2 = process_mmap2_event;
1574 }
7c14898b
AH
1575 if (script->show_switch_events)
1576 script->tool.context_switch = process_switch_event;
96a44bbc
HB
1577 if (script->show_namespace_events)
1578 script->tool.namespaces = process_namespaces_event;
ad7ebb9a 1579
b7b61cbe 1580 ret = perf_session__process_events(script->session);
6fcf7ddb 1581
6d8afb56 1582 if (debug_mode)
9486aa38 1583 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
6fcf7ddb
FW
1584
1585 return ret;
5f9c39dc
FW
1586}
1587
956ffd02
TZ
1588struct script_spec {
1589 struct list_head node;
1590 struct scripting_ops *ops;
1591 char spec[0];
1592};
1593
eccdfe2d 1594static LIST_HEAD(script_specs);
956ffd02
TZ
1595
1596static struct script_spec *script_spec__new(const char *spec,
1597 struct scripting_ops *ops)
1598{
1599 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
1600
1601 if (s != NULL) {
1602 strcpy(s->spec, spec);
1603 s->ops = ops;
1604 }
1605
1606 return s;
1607}
1608
956ffd02
TZ
1609static void script_spec__add(struct script_spec *s)
1610{
1611 list_add_tail(&s->node, &script_specs);
1612}
1613
1614static struct script_spec *script_spec__find(const char *spec)
1615{
1616 struct script_spec *s;
1617
1618 list_for_each_entry(s, &script_specs, node)
1619 if (strcasecmp(s->spec, spec) == 0)
1620 return s;
1621 return NULL;
1622}
1623
956ffd02
TZ
1624int script_spec_register(const char *spec, struct scripting_ops *ops)
1625{
1626 struct script_spec *s;
1627
1628 s = script_spec__find(spec);
1629 if (s)
1630 return -1;
1631
8560bae0 1632 s = script_spec__new(spec, ops);
956ffd02
TZ
1633 if (!s)
1634 return -1;
8560bae0
TS
1635 else
1636 script_spec__add(s);
956ffd02
TZ
1637
1638 return 0;
1639}
1640
1641static struct scripting_ops *script_spec__lookup(const char *spec)
1642{
1643 struct script_spec *s = script_spec__find(spec);
1644 if (!s)
1645 return NULL;
1646
1647 return s->ops;
1648}
1649
1650static void list_available_languages(void)
1651{
1652 struct script_spec *s;
1653
1654 fprintf(stderr, "\n");
1655 fprintf(stderr, "Scripting language extensions (used in "
133dc4c3 1656 "perf script -s [spec:]script.[spec]):\n\n");
956ffd02
TZ
1657
1658 list_for_each_entry(s, &script_specs, node)
1659 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
1660
1661 fprintf(stderr, "\n");
1662}
1663
1d037ca1
IT
1664static int parse_scriptname(const struct option *opt __maybe_unused,
1665 const char *str, int unset __maybe_unused)
956ffd02
TZ
1666{
1667 char spec[PATH_MAX];
1668 const char *script, *ext;
1669 int len;
1670
f526d68b 1671 if (strcmp(str, "lang") == 0) {
956ffd02 1672 list_available_languages();
f526d68b 1673 exit(0);
956ffd02
TZ
1674 }
1675
1676 script = strchr(str, ':');
1677 if (script) {
1678 len = script - str;
1679 if (len >= PATH_MAX) {
1680 fprintf(stderr, "invalid language specifier");
1681 return -1;
1682 }
1683 strncpy(spec, str, len);
1684 spec[len] = '\0';
1685 scripting_ops = script_spec__lookup(spec);
1686 if (!scripting_ops) {
1687 fprintf(stderr, "invalid language specifier");
1688 return -1;
1689 }
1690 script++;
1691 } else {
1692 script = str;
d1e95bb5 1693 ext = strrchr(script, '.');
956ffd02
TZ
1694 if (!ext) {
1695 fprintf(stderr, "invalid script extension");
1696 return -1;
1697 }
1698 scripting_ops = script_spec__lookup(++ext);
1699 if (!scripting_ops) {
1700 fprintf(stderr, "invalid script extension");
1701 return -1;
1702 }
1703 }
1704
1705 script_name = strdup(script);
1706
1707 return 0;
1708}
1709
1d037ca1
IT
1710static int parse_output_fields(const struct option *opt __maybe_unused,
1711 const char *arg, int unset __maybe_unused)
745f43e3 1712{
49346e85 1713 char *tok, *strtok_saveptr = NULL;
50ca19ae 1714 int i, imax = ARRAY_SIZE(all_output_options);
2c9e45f7 1715 int j;
745f43e3
DA
1716 int rc = 0;
1717 char *str = strdup(arg);
1424dc96 1718 int type = -1;
745f43e3
DA
1719
1720 if (!str)
1721 return -ENOMEM;
1722
2c9e45f7
DA
1723 /* first word can state for which event type the user is specifying
1724 * the fields. If no type exists, the specified fields apply to all
1725 * event types found in the file minus the invalid fields for a type.
1424dc96 1726 */
2c9e45f7
DA
1727 tok = strchr(str, ':');
1728 if (tok) {
1729 *tok = '\0';
1730 tok++;
1731 if (!strcmp(str, "hw"))
1732 type = PERF_TYPE_HARDWARE;
1733 else if (!strcmp(str, "sw"))
1734 type = PERF_TYPE_SOFTWARE;
1735 else if (!strcmp(str, "trace"))
1736 type = PERF_TYPE_TRACEPOINT;
0817a6a3
AS
1737 else if (!strcmp(str, "raw"))
1738 type = PERF_TYPE_RAW;
27cfef00
WN
1739 else if (!strcmp(str, "break"))
1740 type = PERF_TYPE_BREAKPOINT;
2c9e45f7
DA
1741 else {
1742 fprintf(stderr, "Invalid event type in field string.\n");
38efb539
RR
1743 rc = -EINVAL;
1744 goto out;
2c9e45f7
DA
1745 }
1746
1747 if (output[type].user_set)
1748 pr_warning("Overriding previous field request for %s events.\n",
1749 event_type(type));
1750
1751 output[type].fields = 0;
1752 output[type].user_set = true;
9cbdb702 1753 output[type].wildcard_set = false;
2c9e45f7
DA
1754
1755 } else {
1756 tok = str;
1757 if (strlen(str) == 0) {
1758 fprintf(stderr,
1759 "Cannot set fields to 'none' for all event types.\n");
1760 rc = -EINVAL;
1761 goto out;
1762 }
1763
1764 if (output_set_by_user())
1765 pr_warning("Overriding previous field request for all events.\n");
1766
1767 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1768 output[j].fields = 0;
1769 output[j].user_set = true;
9cbdb702 1770 output[j].wildcard_set = true;
2c9e45f7 1771 }
745f43e3
DA
1772 }
1773
49346e85 1774 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
745f43e3 1775 for (i = 0; i < imax; ++i) {
2c9e45f7 1776 if (strcmp(tok, all_output_options[i].str) == 0)
745f43e3 1777 break;
745f43e3 1778 }
400ea6d3
AH
1779 if (i == imax && strcmp(tok, "flags") == 0) {
1780 print_flags = true;
1781 continue;
1782 }
745f43e3 1783 if (i == imax) {
2c9e45f7 1784 fprintf(stderr, "Invalid field requested.\n");
745f43e3 1785 rc = -EINVAL;
2c9e45f7 1786 goto out;
745f43e3
DA
1787 }
1788
2c9e45f7
DA
1789 if (type == -1) {
1790 /* add user option to all events types for
1791 * which it is valid
1792 */
1793 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1794 if (output[j].invalid_fields & all_output_options[i].field) {
1795 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
1796 all_output_options[i].str, event_type(j));
1797 } else
1798 output[j].fields |= all_output_options[i].field;
1799 }
1800 } else {
1801 if (output[type].invalid_fields & all_output_options[i].field) {
1802 fprintf(stderr, "\'%s\' not valid for %s events.\n",
1803 all_output_options[i].str, event_type(type));
1804
1805 rc = -EINVAL;
1806 goto out;
1807 }
1808 output[type].fields |= all_output_options[i].field;
1809 }
745f43e3
DA
1810 }
1811
2c9e45f7
DA
1812 if (type >= 0) {
1813 if (output[type].fields == 0) {
1814 pr_debug("No fields requested for %s type. "
1815 "Events will not be displayed.\n", event_type(type));
1816 }
1817 }
745f43e3 1818
2c9e45f7 1819out:
745f43e3
DA
1820 free(str);
1821 return rc;
1822}
1823
008f29d3
SB
1824/* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1825static int is_directory(const char *base_path, const struct dirent *dent)
1826{
1827 char path[PATH_MAX];
1828 struct stat st;
1829
1830 sprintf(path, "%s/%s", base_path, dent->d_name);
1831 if (stat(path, &st))
1832 return 0;
1833
1834 return S_ISDIR(st.st_mode);
1835}
1836
a5e8e825
ACM
1837#define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
1838 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
1839 if ((lang_dirent->d_type == DT_DIR || \
1840 (lang_dirent->d_type == DT_UNKNOWN && \
1841 is_directory(scripts_path, lang_dirent))) && \
1842 (strcmp(lang_dirent->d_name, ".")) && \
1843 (strcmp(lang_dirent->d_name, "..")))
1844
1845#define for_each_script(lang_path, lang_dir, script_dirent) \
1846 while ((script_dirent = readdir(lang_dir)) != NULL) \
1847 if (script_dirent->d_type != DT_DIR && \
1848 (script_dirent->d_type != DT_UNKNOWN || \
1849 !is_directory(lang_path, script_dirent)))
4b9c0c59
TZ
1850
1851
1852#define RECORD_SUFFIX "-record"
1853#define REPORT_SUFFIX "-report"
1854
1855struct script_desc {
1856 struct list_head node;
1857 char *name;
1858 char *half_liner;
1859 char *args;
1860};
1861
eccdfe2d 1862static LIST_HEAD(script_descs);
4b9c0c59
TZ
1863
1864static struct script_desc *script_desc__new(const char *name)
1865{
1866 struct script_desc *s = zalloc(sizeof(*s));
1867
b5b87312 1868 if (s != NULL && name)
4b9c0c59
TZ
1869 s->name = strdup(name);
1870
1871 return s;
1872}
1873
1874static void script_desc__delete(struct script_desc *s)
1875{
74cf249d
ACM
1876 zfree(&s->name);
1877 zfree(&s->half_liner);
1878 zfree(&s->args);
4b9c0c59
TZ
1879 free(s);
1880}
1881
1882static void script_desc__add(struct script_desc *s)
1883{
1884 list_add_tail(&s->node, &script_descs);
1885}
1886
1887static struct script_desc *script_desc__find(const char *name)
1888{
1889 struct script_desc *s;
1890
1891 list_for_each_entry(s, &script_descs, node)
1892 if (strcasecmp(s->name, name) == 0)
1893 return s;
1894 return NULL;
1895}
1896
1897static struct script_desc *script_desc__findnew(const char *name)
1898{
1899 struct script_desc *s = script_desc__find(name);
1900
1901 if (s)
1902 return s;
1903
1904 s = script_desc__new(name);
1905 if (!s)
1906 goto out_delete_desc;
1907
1908 script_desc__add(s);
1909
1910 return s;
1911
1912out_delete_desc:
1913 script_desc__delete(s);
1914
1915 return NULL;
1916}
1917
965bb6be 1918static const char *ends_with(const char *str, const char *suffix)
4b9c0c59
TZ
1919{
1920 size_t suffix_len = strlen(suffix);
965bb6be 1921 const char *p = str;
4b9c0c59
TZ
1922
1923 if (strlen(str) > suffix_len) {
1924 p = str + strlen(str) - suffix_len;
1925 if (!strncmp(p, suffix, suffix_len))
1926 return p;
1927 }
1928
1929 return NULL;
1930}
1931
4b9c0c59
TZ
1932static int read_script_info(struct script_desc *desc, const char *filename)
1933{
1934 char line[BUFSIZ], *p;
1935 FILE *fp;
1936
1937 fp = fopen(filename, "r");
1938 if (!fp)
1939 return -1;
1940
1941 while (fgets(line, sizeof(line), fp)) {
1942 p = ltrim(line);
1943 if (strlen(p) == 0)
1944 continue;
1945 if (*p != '#')
1946 continue;
1947 p++;
1948 if (strlen(p) && *p == '!')
1949 continue;
1950
1951 p = ltrim(p);
1952 if (strlen(p) && p[strlen(p) - 1] == '\n')
1953 p[strlen(p) - 1] = '\0';
1954
1955 if (!strncmp(p, "description:", strlen("description:"))) {
1956 p += strlen("description:");
1957 desc->half_liner = strdup(ltrim(p));
1958 continue;
1959 }
1960
1961 if (!strncmp(p, "args:", strlen("args:"))) {
1962 p += strlen("args:");
1963 desc->args = strdup(ltrim(p));
1964 continue;
1965 }
1966 }
1967
1968 fclose(fp);
1969
1970 return 0;
1971}
1972
38efb539
RR
1973static char *get_script_root(struct dirent *script_dirent, const char *suffix)
1974{
1975 char *script_root, *str;
1976
1977 script_root = strdup(script_dirent->d_name);
1978 if (!script_root)
1979 return NULL;
1980
1981 str = (char *)ends_with(script_root, suffix);
1982 if (!str) {
1983 free(script_root);
1984 return NULL;
1985 }
1986
1987 *str = '\0';
1988 return script_root;
1989}
1990
1d037ca1
IT
1991static int list_available_scripts(const struct option *opt __maybe_unused,
1992 const char *s __maybe_unused,
1993 int unset __maybe_unused)
4b9c0c59 1994{
a5e8e825 1995 struct dirent *script_dirent, *lang_dirent;
4b9c0c59
TZ
1996 char scripts_path[MAXPATHLEN];
1997 DIR *scripts_dir, *lang_dir;
1998 char script_path[MAXPATHLEN];
1999 char lang_path[MAXPATHLEN];
2000 struct script_desc *desc;
2001 char first_half[BUFSIZ];
2002 char *script_root;
4b9c0c59 2003
46113a54 2004 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
4b9c0c59
TZ
2005
2006 scripts_dir = opendir(scripts_path);
88ded4d8
HK
2007 if (!scripts_dir) {
2008 fprintf(stdout,
2009 "open(%s) failed.\n"
2010 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
2011 scripts_path);
2012 exit(-1);
2013 }
4b9c0c59 2014
a5e8e825 2015 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
4b9c0c59 2016 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
a5e8e825 2017 lang_dirent->d_name);
4b9c0c59
TZ
2018 lang_dir = opendir(lang_path);
2019 if (!lang_dir)
2020 continue;
2021
a5e8e825
ACM
2022 for_each_script(lang_path, lang_dir, script_dirent) {
2023 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
38efb539 2024 if (script_root) {
4b9c0c59
TZ
2025 desc = script_desc__findnew(script_root);
2026 snprintf(script_path, MAXPATHLEN, "%s/%s",
a5e8e825 2027 lang_path, script_dirent->d_name);
4b9c0c59 2028 read_script_info(desc, script_path);
38efb539 2029 free(script_root);
4b9c0c59 2030 }
4b9c0c59
TZ
2031 }
2032 }
2033
2034 fprintf(stdout, "List of available trace scripts:\n");
2035 list_for_each_entry(desc, &script_descs, node) {
2036 sprintf(first_half, "%s %s", desc->name,
2037 desc->args ? desc->args : "");
2038 fprintf(stdout, " %-36s %s\n", first_half,
2039 desc->half_liner ? desc->half_liner : "");
2040 }
2041
2042 exit(0);
2043}
2044
49e639e2
FT
2045/*
2046 * Some scripts specify the required events in their "xxx-record" file,
2047 * this function will check if the events in perf.data match those
2048 * mentioned in the "xxx-record".
2049 *
2050 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
2051 * which is covered well now. And new parsing code should be added to
2052 * cover the future complexing formats like event groups etc.
2053 */
2054static int check_ev_match(char *dir_name, char *scriptname,
2055 struct perf_session *session)
2056{
2057 char filename[MAXPATHLEN], evname[128];
2058 char line[BUFSIZ], *p;
2059 struct perf_evsel *pos;
2060 int match, len;
2061 FILE *fp;
2062
2063 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
2064
2065 fp = fopen(filename, "r");
2066 if (!fp)
2067 return -1;
2068
2069 while (fgets(line, sizeof(line), fp)) {
2070 p = ltrim(line);
2071 if (*p == '#')
2072 continue;
2073
2074 while (strlen(p)) {
2075 p = strstr(p, "-e");
2076 if (!p)
2077 break;
2078
2079 p += 2;
2080 p = ltrim(p);
2081 len = strcspn(p, " \t");
2082 if (!len)
2083 break;
2084
2085 snprintf(evname, len + 1, "%s", p);
2086
2087 match = 0;
e5cadb93 2088 evlist__for_each_entry(session->evlist, pos) {
49e639e2
FT
2089 if (!strcmp(perf_evsel__name(pos), evname)) {
2090 match = 1;
2091 break;
2092 }
2093 }
2094
2095 if (!match) {
2096 fclose(fp);
2097 return -1;
2098 }
2099 }
2100 }
2101
2102 fclose(fp);
2103 return 0;
2104}
2105
e5f3705e
FT
2106/*
2107 * Return -1 if none is found, otherwise the actual scripts number.
2108 *
2109 * Currently the only user of this function is the script browser, which
2110 * will list all statically runnable scripts, select one, execute it and
2111 * show the output in a perf browser.
2112 */
2113int find_scripts(char **scripts_array, char **scripts_path_array)
2114{
a5e8e825 2115 struct dirent *script_dirent, *lang_dirent;
49e639e2 2116 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
e5f3705e 2117 DIR *scripts_dir, *lang_dir;
49e639e2 2118 struct perf_session *session;
f5fc1412
JO
2119 struct perf_data_file file = {
2120 .path = input_name,
2121 .mode = PERF_DATA_MODE_READ,
2122 };
e5f3705e
FT
2123 char *temp;
2124 int i = 0;
2125
f5fc1412 2126 session = perf_session__new(&file, false, NULL);
49e639e2
FT
2127 if (!session)
2128 return -1;
2129
46113a54 2130 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
e5f3705e
FT
2131
2132 scripts_dir = opendir(scripts_path);
49e639e2
FT
2133 if (!scripts_dir) {
2134 perf_session__delete(session);
e5f3705e 2135 return -1;
49e639e2 2136 }
e5f3705e 2137
a5e8e825 2138 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
e5f3705e 2139 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
a5e8e825 2140 lang_dirent->d_name);
e5f3705e
FT
2141#ifdef NO_LIBPERL
2142 if (strstr(lang_path, "perl"))
2143 continue;
2144#endif
2145#ifdef NO_LIBPYTHON
2146 if (strstr(lang_path, "python"))
2147 continue;
2148#endif
2149
2150 lang_dir = opendir(lang_path);
2151 if (!lang_dir)
2152 continue;
2153
a5e8e825 2154 for_each_script(lang_path, lang_dir, script_dirent) {
e5f3705e 2155 /* Skip those real time scripts: xxxtop.p[yl] */
a5e8e825 2156 if (strstr(script_dirent->d_name, "top."))
e5f3705e
FT
2157 continue;
2158 sprintf(scripts_path_array[i], "%s/%s", lang_path,
a5e8e825
ACM
2159 script_dirent->d_name);
2160 temp = strchr(script_dirent->d_name, '.');
e5f3705e 2161 snprintf(scripts_array[i],
a5e8e825
ACM
2162 (temp - script_dirent->d_name) + 1,
2163 "%s", script_dirent->d_name);
49e639e2
FT
2164
2165 if (check_ev_match(lang_path,
2166 scripts_array[i], session))
2167 continue;
2168
e5f3705e
FT
2169 i++;
2170 }
49e639e2 2171 closedir(lang_dir);
e5f3705e
FT
2172 }
2173
49e639e2
FT
2174 closedir(scripts_dir);
2175 perf_session__delete(session);
e5f3705e
FT
2176 return i;
2177}
2178
3875294f
TZ
2179static char *get_script_path(const char *script_root, const char *suffix)
2180{
a5e8e825 2181 struct dirent *script_dirent, *lang_dirent;
3875294f
TZ
2182 char scripts_path[MAXPATHLEN];
2183 char script_path[MAXPATHLEN];
2184 DIR *scripts_dir, *lang_dir;
2185 char lang_path[MAXPATHLEN];
38efb539 2186 char *__script_root;
3875294f 2187
46113a54 2188 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3875294f
TZ
2189
2190 scripts_dir = opendir(scripts_path);
2191 if (!scripts_dir)
2192 return NULL;
2193
a5e8e825 2194 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3875294f 2195 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
a5e8e825 2196 lang_dirent->d_name);
3875294f
TZ
2197 lang_dir = opendir(lang_path);
2198 if (!lang_dir)
2199 continue;
2200
a5e8e825
ACM
2201 for_each_script(lang_path, lang_dir, script_dirent) {
2202 __script_root = get_script_root(script_dirent, suffix);
38efb539
RR
2203 if (__script_root && !strcmp(script_root, __script_root)) {
2204 free(__script_root);
946ef2a2
NK
2205 closedir(lang_dir);
2206 closedir(scripts_dir);
3875294f 2207 snprintf(script_path, MAXPATHLEN, "%s/%s",
a5e8e825 2208 lang_path, script_dirent->d_name);
38efb539 2209 return strdup(script_path);
3875294f
TZ
2210 }
2211 free(__script_root);
2212 }
946ef2a2 2213 closedir(lang_dir);
3875294f 2214 }
946ef2a2 2215 closedir(scripts_dir);
3875294f 2216
38efb539 2217 return NULL;
3875294f
TZ
2218}
2219
b5b87312
TZ
2220static bool is_top_script(const char *script_path)
2221{
965bb6be 2222 return ends_with(script_path, "top") == NULL ? false : true;
b5b87312
TZ
2223}
2224
2225static int has_required_arg(char *script_path)
2226{
2227 struct script_desc *desc;
2228 int n_args = 0;
2229 char *p;
2230
2231 desc = script_desc__new(NULL);
2232
2233 if (read_script_info(desc, script_path))
2234 goto out;
2235
2236 if (!desc->args)
2237 goto out;
2238
2239 for (p = desc->args; *p; p++)
2240 if (*p == '<')
2241 n_args++;
2242out:
2243 script_desc__delete(desc);
2244
2245 return n_args;
2246}
2247
69b6470e
ACM
2248static int have_cmd(int argc, const char **argv)
2249{
2250 char **__argv = malloc(sizeof(const char *) * argc);
2251
2252 if (!__argv) {
2253 pr_err("malloc failed\n");
2254 return -1;
2255 }
2256
2257 memcpy(__argv, argv, sizeof(const char *) * argc);
2258 argc = parse_options(argc, (const char **)__argv, record_options,
2259 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
2260 free(__argv);
5f9c39dc 2261
69b6470e
ACM
2262 system_wide = (argc == 0);
2263
2264 return 0;
2265}
2266
7322d6c9
JO
2267static void script__setup_sample_type(struct perf_script *script)
2268{
2269 struct perf_session *session = script->session;
2270 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
2271
2272 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
2273 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
2274 (sample_type & PERF_SAMPLE_STACK_USER))
2275 callchain_param.record_mode = CALLCHAIN_DWARF;
2276 else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
2277 callchain_param.record_mode = CALLCHAIN_LBR;
2278 else
2279 callchain_param.record_mode = CALLCHAIN_FP;
2280 }
2281}
2282
e099eba8
JO
2283static int process_stat_round_event(struct perf_tool *tool __maybe_unused,
2284 union perf_event *event,
2285 struct perf_session *session)
2286{
2287 struct stat_round_event *round = &event->stat_round;
2288 struct perf_evsel *counter;
2289
e5cadb93 2290 evlist__for_each_entry(session->evlist, counter) {
e099eba8
JO
2291 perf_stat_process_counter(&stat_config, counter);
2292 process_stat(counter, round->time);
2293 }
2294
2295 process_stat_interval(round->time);
2296 return 0;
2297}
2298
91a2c3d5
JO
2299static int process_stat_config_event(struct perf_tool *tool __maybe_unused,
2300 union perf_event *event,
2301 struct perf_session *session __maybe_unused)
2302{
2303 perf_event__read_stat_config(&stat_config, &event->stat_config);
2304 return 0;
2305}
2306
cfc8874a
JO
2307static int set_maps(struct perf_script *script)
2308{
2309 struct perf_evlist *evlist = script->session->evlist;
2310
2311 if (!script->cpus || !script->threads)
2312 return 0;
2313
2314 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
2315 return -EINVAL;
2316
2317 perf_evlist__set_maps(evlist, script->cpus, script->threads);
2318
2319 if (perf_evlist__alloc_stats(evlist, true))
2320 return -ENOMEM;
2321
2322 script->allocated = true;
2323 return 0;
2324}
2325
2326static
2327int process_thread_map_event(struct perf_tool *tool,
2328 union perf_event *event,
2329 struct perf_session *session __maybe_unused)
2330{
2331 struct perf_script *script = container_of(tool, struct perf_script, tool);
2332
2333 if (script->threads) {
2334 pr_warning("Extra thread map event, ignoring.\n");
2335 return 0;
2336 }
2337
2338 script->threads = thread_map__new_event(&event->thread_map);
2339 if (!script->threads)
2340 return -ENOMEM;
2341
2342 return set_maps(script);
2343}
2344
2345static
2346int process_cpu_map_event(struct perf_tool *tool __maybe_unused,
2347 union perf_event *event,
2348 struct perf_session *session __maybe_unused)
2349{
2350 struct perf_script *script = container_of(tool, struct perf_script, tool);
2351
2352 if (script->cpus) {
2353 pr_warning("Extra cpu map event, ignoring.\n");
2354 return 0;
2355 }
2356
2357 script->cpus = cpu_map__new_data(&event->cpu_map.data);
2358 if (!script->cpus)
2359 return -ENOMEM;
2360
2361 return set_maps(script);
2362}
2363
b0ad8ea6 2364int cmd_script(int argc, const char **argv)
69b6470e
ACM
2365{
2366 bool show_full_info = false;
e90debdd
JO
2367 bool header = false;
2368 bool header_only = false;
6cc870f0 2369 bool script_started = false;
69b6470e
ACM
2370 char *rec_script_path = NULL;
2371 char *rep_script_path = NULL;
2372 struct perf_session *session;
7a680eb9 2373 struct itrace_synth_opts itrace_synth_opts = { .set = false, };
69b6470e
ACM
2374 char *script_path = NULL;
2375 const char **__argv;
6cc870f0 2376 int i, j, err = 0;
6f3e5eda
AH
2377 struct perf_script script = {
2378 .tool = {
2379 .sample = process_sample_event,
2380 .mmap = perf_event__process_mmap,
2381 .mmap2 = perf_event__process_mmap2,
2382 .comm = perf_event__process_comm,
f3b3614a 2383 .namespaces = perf_event__process_namespaces,
6f3e5eda
AH
2384 .exit = perf_event__process_exit,
2385 .fork = perf_event__process_fork,
7ea95727 2386 .attr = process_attr,
91daee30 2387 .event_update = perf_event__process_event_update,
6f3e5eda
AH
2388 .tracing_data = perf_event__process_tracing_data,
2389 .build_id = perf_event__process_build_id,
7a680eb9
AH
2390 .id_index = perf_event__process_id_index,
2391 .auxtrace_info = perf_event__process_auxtrace_info,
2392 .auxtrace = perf_event__process_auxtrace,
2393 .auxtrace_error = perf_event__process_auxtrace_error,
e099eba8
JO
2394 .stat = perf_event__process_stat_event,
2395 .stat_round = process_stat_round_event,
91a2c3d5 2396 .stat_config = process_stat_config_event,
cfc8874a
JO
2397 .thread_map = process_thread_map_event,
2398 .cpu_map = process_cpu_map_event,
0a8cb85c 2399 .ordered_events = true,
6f3e5eda
AH
2400 .ordering_requires_timestamps = true,
2401 },
2402 };
06af0f2c
YS
2403 struct perf_data_file file = {
2404 .mode = PERF_DATA_MODE_READ,
2405 };
69b6470e 2406 const struct option options[] = {
5f9c39dc
FW
2407 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
2408 "dump raw trace in ASCII"),
c0555642 2409 OPT_INCR('v', "verbose", &verbose,
69b6470e 2410 "be more verbose (show symbol address, etc)"),
4b9c0c59 2411 OPT_BOOLEAN('L', "Latency", &latency_format,
cda48461 2412 "show latency attributes (irqs/preemption disabled, etc)"),
4b9c0c59
TZ
2413 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
2414 list_available_scripts),
956ffd02
TZ
2415 OPT_CALLBACK('s', "script", NULL, "name",
2416 "script file name (lang:script name, script name, or *)",
2417 parse_scriptname),
2418 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
133dc4c3 2419 "generate perf-script.xx script in specified language"),
69b6470e 2420 OPT_STRING('i', "input", &input_name, "file", "input file name"),
ffabd99e
FW
2421 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
2422 "do various checks like samples ordering and lost events"),
e90debdd
JO
2423 OPT_BOOLEAN(0, "header", &header, "Show data header."),
2424 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
c0230b2b
DA
2425 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
2426 "file", "vmlinux pathname"),
2427 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
2428 "file", "kallsyms pathname"),
2429 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
2430 "When printing symbols do not display call chain"),
a7066709
HK
2431 OPT_CALLBACK(0, "symfs", NULL, "directory",
2432 "Look for files with symbols relative to this directory",
2433 symbol__config_symfs),
06af0f2c 2434 OPT_CALLBACK('F', "fields", NULL, "str",
a978f2ab
AN
2435 "comma separated output fields prepend with 'type:'. "
2436 "Valid types: hw,sw,trace,raw. "
2437 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
e216708d 2438 "addr,symoff,period,iregs,brstack,brstacksym,flags,"
48d02a1d
AK
2439 "bpf-output,callindent,insn,insnlen,brstackinsn",
2440 parse_output_fields),
317df650 2441 OPT_BOOLEAN('a', "all-cpus", &system_wide,
69b6470e 2442 "system-wide collection from all CPUs"),
36385be5
FT
2443 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
2444 "only consider these symbols"),
64eff7d9
DA
2445 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
2446 "Stop display of callgraph at these symbols"),
c8e66720 2447 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
e7984b7b
DA
2448 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
2449 "only display events for these comms"),
e03eaa40
DA
2450 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
2451 "only consider symbols in these pids"),
2452 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
2453 "only consider symbols in these tids"),
6125cc8d
ACM
2454 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
2455 "Set the maximum stack depth when parsing the callchain, "
2456 "anything beyond the specified depth will be ignored. "
4cb93446 2457 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
fbe96f29
SE
2458 OPT_BOOLEAN('I', "show-info", &show_full_info,
2459 "display extended information from perf.data file"),
0bc8d205
AN
2460 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
2461 "Show the path of [kernel.kallsyms]"),
ad7ebb9a
NK
2462 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
2463 "Show the fork/comm/exit events"),
ba1ddf42
NK
2464 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
2465 "Show the mmap events"),
7c14898b
AH
2466 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
2467 "Show context switch events (if recorded)"),
96a44bbc
HB
2468 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
2469 "Show namespace events (if recorded)"),
be3d466c 2470 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
48d02a1d
AK
2471 OPT_INTEGER(0, "max-blocks", &max_blocks,
2472 "Maximum number of code blocks to dump with brstackinsn"),
83e19860
AH
2473 OPT_BOOLEAN(0, "ns", &nanosecs,
2474 "Use 9 decimal places when displaying time"),
7a680eb9
AH
2475 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
2476 "Instruction Tracing options",
2477 itrace_parse_synth_opts),
a9710ba0
AK
2478 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
2479 "Show full source file name path for source lines"),
77e0070d
MD
2480 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
2481 "Enable symbol demangling"),
2482 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
2483 "Enable kernel symbol demangling"),
a91f4c47
DA
2484 OPT_STRING(0, "time", &script.time_str, "str",
2485 "Time span of interest (start,stop)"),
1909629f 2486 OPT_END()
69b6470e 2487 };
40cae2b7
YS
2488 const char * const script_subcommands[] = { "record", "report", NULL };
2489 const char *script_usage[] = {
69b6470e
ACM
2490 "perf script [<options>]",
2491 "perf script [<options>] record <script> [<record-options>] <command>",
2492 "perf script [<options>] report <script> [script-args]",
2493 "perf script [<options>] <script> [<record-options>] <command>",
2494 "perf script [<options>] <top-script> [script-args]",
2495 NULL
2496 };
3875294f 2497
b5b87312
TZ
2498 setup_scripting();
2499
40cae2b7 2500 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
b5b87312
TZ
2501 PARSE_OPT_STOP_AT_NON_OPTION);
2502
f5fc1412 2503 file.path = input_name;
be3d466c 2504 file.force = symbol_conf.force;
f5fc1412 2505
b5b87312
TZ
2506 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
2507 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
2508 if (!rec_script_path)
b0ad8ea6 2509 return cmd_record(argc, argv);
3875294f
TZ
2510 }
2511
b5b87312
TZ
2512 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
2513 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
2514 if (!rep_script_path) {
3875294f 2515 fprintf(stderr,
b5b87312 2516 "Please specify a valid report script"
133dc4c3 2517 "(see 'perf script -l' for listing)\n");
3875294f
TZ
2518 return -1;
2519 }
3875294f
TZ
2520 }
2521
3c5b645f
AH
2522 if (itrace_synth_opts.callchain &&
2523 itrace_synth_opts.callchain_sz > scripting_max_stack)
2524 scripting_max_stack = itrace_synth_opts.callchain_sz;
2525
44e668c6 2526 /* make sure PERF_EXEC_PATH is set for scripts */
46113a54 2527 set_argv_exec_path(get_argv_exec_path());
44e668c6 2528
b5b87312 2529 if (argc && !script_name && !rec_script_path && !rep_script_path) {
a0cccc2e 2530 int live_pipe[2];
b5b87312 2531 int rep_args;
a0cccc2e
TZ
2532 pid_t pid;
2533
b5b87312
TZ
2534 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
2535 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
2536
2537 if (!rec_script_path && !rep_script_path) {
c7118369
NK
2538 usage_with_options_msg(script_usage, options,
2539 "Couldn't find script `%s'\n\n See perf"
133dc4c3 2540 " script -l for available scripts.\n", argv[0]);
a0cccc2e
TZ
2541 }
2542
b5b87312
TZ
2543 if (is_top_script(argv[0])) {
2544 rep_args = argc - 1;
2545 } else {
2546 int rec_args;
2547
2548 rep_args = has_required_arg(rep_script_path);
2549 rec_args = (argc - 1) - rep_args;
2550 if (rec_args < 0) {
c7118369
NK
2551 usage_with_options_msg(script_usage, options,
2552 "`%s' script requires options."
133dc4c3 2553 "\n\n See perf script -l for available "
b5b87312 2554 "scripts and options.\n", argv[0]);
b5b87312 2555 }
a0cccc2e
TZ
2556 }
2557
2558 if (pipe(live_pipe) < 0) {
2559 perror("failed to create pipe");
d54b1a9e 2560 return -1;
a0cccc2e
TZ
2561 }
2562
2563 pid = fork();
2564 if (pid < 0) {
2565 perror("failed to fork");
d54b1a9e 2566 return -1;
a0cccc2e
TZ
2567 }
2568
2569 if (!pid) {
b5b87312
TZ
2570 j = 0;
2571
a0cccc2e
TZ
2572 dup2(live_pipe[1], 1);
2573 close(live_pipe[0]);
2574
317df650
RR
2575 if (is_top_script(argv[0])) {
2576 system_wide = true;
2577 } else if (!system_wide) {
d54b1a9e
DA
2578 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
2579 err = -1;
2580 goto out;
2581 }
317df650 2582 }
b5b87312
TZ
2583
2584 __argv = malloc((argc + 6) * sizeof(const char *));
d54b1a9e
DA
2585 if (!__argv) {
2586 pr_err("malloc failed\n");
2587 err = -ENOMEM;
2588 goto out;
2589 }
e8719adf 2590
b5b87312
TZ
2591 __argv[j++] = "/bin/sh";
2592 __argv[j++] = rec_script_path;
2593 if (system_wide)
2594 __argv[j++] = "-a";
2595 __argv[j++] = "-q";
2596 __argv[j++] = "-o";
2597 __argv[j++] = "-";
2598 for (i = rep_args + 1; i < argc; i++)
2599 __argv[j++] = argv[i];
2600 __argv[j++] = NULL;
a0cccc2e
TZ
2601
2602 execvp("/bin/sh", (char **)__argv);
e8719adf 2603 free(__argv);
a0cccc2e
TZ
2604 exit(-1);
2605 }
2606
2607 dup2(live_pipe[0], 0);
2608 close(live_pipe[1]);
2609
b5b87312 2610 __argv = malloc((argc + 4) * sizeof(const char *));
d54b1a9e
DA
2611 if (!__argv) {
2612 pr_err("malloc failed\n");
2613 err = -ENOMEM;
2614 goto out;
2615 }
2616
b5b87312
TZ
2617 j = 0;
2618 __argv[j++] = "/bin/sh";
2619 __argv[j++] = rep_script_path;
2620 for (i = 1; i < rep_args + 1; i++)
2621 __argv[j++] = argv[i];
2622 __argv[j++] = "-i";
2623 __argv[j++] = "-";
2624 __argv[j++] = NULL;
a0cccc2e
TZ
2625
2626 execvp("/bin/sh", (char **)__argv);
e8719adf 2627 free(__argv);
a0cccc2e
TZ
2628 exit(-1);
2629 }
2630
b5b87312
TZ
2631 if (rec_script_path)
2632 script_path = rec_script_path;
2633 if (rep_script_path)
2634 script_path = rep_script_path;
34c86ea9 2635
b5b87312 2636 if (script_path) {
b5b87312 2637 j = 0;
3875294f 2638
317df650
RR
2639 if (!rec_script_path)
2640 system_wide = false;
d54b1a9e
DA
2641 else if (!system_wide) {
2642 if (have_cmd(argc - 1, &argv[1]) != 0) {
2643 err = -1;
2644 goto out;
2645 }
2646 }
34c86ea9 2647
b5b87312 2648 __argv = malloc((argc + 2) * sizeof(const char *));
d54b1a9e
DA
2649 if (!__argv) {
2650 pr_err("malloc failed\n");
2651 err = -ENOMEM;
2652 goto out;
2653 }
2654
34c86ea9
TZ
2655 __argv[j++] = "/bin/sh";
2656 __argv[j++] = script_path;
2657 if (system_wide)
2658 __argv[j++] = "-a";
b5b87312 2659 for (i = 2; i < argc; i++)
34c86ea9
TZ
2660 __argv[j++] = argv[i];
2661 __argv[j++] = NULL;
3875294f
TZ
2662
2663 execvp("/bin/sh", (char **)__argv);
e8719adf 2664 free(__argv);
3875294f
TZ
2665 exit(-1);
2666 }
956ffd02 2667
cf4fee50
TZ
2668 if (!script_name)
2669 setup_pager();
5f9c39dc 2670
6f3e5eda 2671 session = perf_session__new(&file, false, &script.tool);
d8f66248 2672 if (session == NULL)
52e02834 2673 return -1;
d8f66248 2674
e90debdd
JO
2675 if (header || header_only) {
2676 perf_session__fprintf_info(session, stdout, show_full_info);
2677 if (header_only)
6cc870f0 2678 goto out_delete;
e90debdd
JO
2679 }
2680
0a7e6d1b 2681 if (symbol__init(&session->header.env) < 0)
38520dc3
NK
2682 goto out_delete;
2683
6f3e5eda 2684 script.session = session;
7322d6c9 2685 script__setup_sample_type(&script);
6f3e5eda 2686
e216708d
AH
2687 if (output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT)
2688 itrace_synth_opts.thread_stack = true;
2689
7a680eb9
AH
2690 session->itrace_synth_opts = &itrace_synth_opts;
2691
5d67be97 2692 if (cpu_list) {
6cc870f0
NK
2693 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
2694 if (err < 0)
2695 goto out_delete;
5d67be97
AB
2696 }
2697
1424dc96 2698 if (!no_callchain)
c0230b2b
DA
2699 symbol_conf.use_callchain = true;
2700 else
2701 symbol_conf.use_callchain = false;
2702
9ee67421
ACM
2703 if (session->tevent.pevent &&
2704 pevent_set_function_resolver(session->tevent.pevent,
ccb3a829
ACM
2705 machine__resolve_kernel_addr,
2706 &session->machines.host) < 0) {
2707 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
2708 return -1;
2709 }
2710
956ffd02
TZ
2711 if (generate_script_lang) {
2712 struct stat perf_stat;
745f43e3
DA
2713 int input;
2714
2c9e45f7 2715 if (output_set_by_user()) {
745f43e3
DA
2716 fprintf(stderr,
2717 "custom fields not supported for generated scripts");
6cc870f0
NK
2718 err = -EINVAL;
2719 goto out_delete;
745f43e3 2720 }
956ffd02 2721
cc9784bd 2722 input = open(file.path, O_RDONLY); /* input_name */
956ffd02 2723 if (input < 0) {
6cc870f0 2724 err = -errno;
956ffd02 2725 perror("failed to open file");
6cc870f0 2726 goto out_delete;
956ffd02
TZ
2727 }
2728
2729 err = fstat(input, &perf_stat);
2730 if (err < 0) {
2731 perror("failed to stat file");
6cc870f0 2732 goto out_delete;
956ffd02
TZ
2733 }
2734
2735 if (!perf_stat.st_size) {
2736 fprintf(stderr, "zero-sized file, nothing to do!\n");
6cc870f0 2737 goto out_delete;
956ffd02
TZ
2738 }
2739
2740 scripting_ops = script_spec__lookup(generate_script_lang);
2741 if (!scripting_ops) {
2742 fprintf(stderr, "invalid language specifier");
6cc870f0
NK
2743 err = -ENOENT;
2744 goto out_delete;
956ffd02
TZ
2745 }
2746
29f5ffd3 2747 err = scripting_ops->generate_script(session->tevent.pevent,
da378962 2748 "perf-script");
6cc870f0 2749 goto out_delete;
956ffd02
TZ
2750 }
2751
2752 if (script_name) {
586bc5cc 2753 err = scripting_ops->start_script(script_name, argc, argv);
956ffd02 2754 if (err)
6cc870f0 2755 goto out_delete;
133dc4c3 2756 pr_debug("perf script started with script %s\n\n", script_name);
6cc870f0 2757 script_started = true;
956ffd02
TZ
2758 }
2759
9cbdb702
DA
2760
2761 err = perf_session__check_output_opt(session);
2762 if (err < 0)
6cc870f0 2763 goto out_delete;
9cbdb702 2764
a91f4c47
DA
2765 /* needs to be parsed after looking up reference time */
2766 if (perf_time__parse_str(&script.ptime, script.time_str) != 0) {
2767 pr_err("Invalid time string\n");
2768 return -EINVAL;
2769 }
2770
6f3e5eda 2771 err = __cmd_script(&script);
956ffd02 2772
d445dd2a
AH
2773 flush_scripting();
2774
6cc870f0 2775out_delete:
cfc8874a 2776 perf_evlist__free_stats(session->evlist);
d8f66248 2777 perf_session__delete(session);
6cc870f0
NK
2778
2779 if (script_started)
2780 cleanup_scripting();
956ffd02
TZ
2781out:
2782 return err;
5f9c39dc 2783}