Loading...
1// SPDX-License-Identifier: GPL-2.0
2#include "builtin.h"
3
4#include "util/counts.h"
5#include "util/debug.h"
6#include "util/dso.h"
7#include <subcmd/exec-cmd.h>
8#include "util/header.h"
9#include <subcmd/parse-options.h>
10#include "util/perf_regs.h"
11#include "util/session.h"
12#include "util/tool.h"
13#include "util/map.h"
14#include "util/srcline.h"
15#include "util/symbol.h"
16#include "util/thread.h"
17#include "util/trace-event.h"
18#include "util/env.h"
19#include "util/evlist.h"
20#include "util/evsel.h"
21#include "util/evsel_fprintf.h"
22#include "util/evswitch.h"
23#include "util/sort.h"
24#include "util/data.h"
25#include "util/auxtrace.h"
26#include "util/cpumap.h"
27#include "util/thread_map.h"
28#include "util/stat.h"
29#include "util/color.h"
30#include "util/string2.h"
31#include "util/thread-stack.h"
32#include "util/time-utils.h"
33#include "util/path.h"
34#include "util/event.h"
35#include "ui/ui.h"
36#include "print_binary.h"
37#include "archinsn.h"
38#include <linux/bitmap.h>
39#include <linux/kernel.h>
40#include <linux/stringify.h>
41#include <linux/time64.h>
42#include <linux/zalloc.h>
43#include <sys/utsname.h>
44#include "asm/bug.h"
45#include "util/mem-events.h"
46#include "util/dump-insn.h"
47#include <dirent.h>
48#include <errno.h>
49#include <inttypes.h>
50#include <signal.h>
51#include <sys/param.h>
52#include <sys/types.h>
53#include <sys/stat.h>
54#include <fcntl.h>
55#include <unistd.h>
56#include <subcmd/pager.h>
57#include <perf/evlist.h>
58#include <linux/err.h>
59#include "util/dlfilter.h"
60#include "util/record.h"
61#include "util/util.h"
62#include "perf.h"
63
64#include <linux/ctype.h>
65#ifdef HAVE_LIBTRACEEVENT
66#include <traceevent/event-parse.h>
67#endif
68
69static char const *script_name;
70static char const *generate_script_lang;
71static bool reltime;
72static bool deltatime;
73static u64 initial_time;
74static u64 previous_time;
75static bool debug_mode;
76static u64 last_timestamp;
77static u64 nr_unordered;
78static bool no_callchain;
79static bool latency_format;
80static bool system_wide;
81static bool print_flags;
82static const char *cpu_list;
83static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
84static struct perf_stat_config stat_config;
85static int max_blocks;
86static bool native_arch;
87static struct dlfilter *dlfilter;
88static int dlargc;
89static char **dlargv;
90
91unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
92
93enum perf_output_field {
94 PERF_OUTPUT_COMM = 1ULL << 0,
95 PERF_OUTPUT_TID = 1ULL << 1,
96 PERF_OUTPUT_PID = 1ULL << 2,
97 PERF_OUTPUT_TIME = 1ULL << 3,
98 PERF_OUTPUT_CPU = 1ULL << 4,
99 PERF_OUTPUT_EVNAME = 1ULL << 5,
100 PERF_OUTPUT_TRACE = 1ULL << 6,
101 PERF_OUTPUT_IP = 1ULL << 7,
102 PERF_OUTPUT_SYM = 1ULL << 8,
103 PERF_OUTPUT_DSO = 1ULL << 9,
104 PERF_OUTPUT_ADDR = 1ULL << 10,
105 PERF_OUTPUT_SYMOFFSET = 1ULL << 11,
106 PERF_OUTPUT_SRCLINE = 1ULL << 12,
107 PERF_OUTPUT_PERIOD = 1ULL << 13,
108 PERF_OUTPUT_IREGS = 1ULL << 14,
109 PERF_OUTPUT_BRSTACK = 1ULL << 15,
110 PERF_OUTPUT_BRSTACKSYM = 1ULL << 16,
111 PERF_OUTPUT_DATA_SRC = 1ULL << 17,
112 PERF_OUTPUT_WEIGHT = 1ULL << 18,
113 PERF_OUTPUT_BPF_OUTPUT = 1ULL << 19,
114 PERF_OUTPUT_CALLINDENT = 1ULL << 20,
115 PERF_OUTPUT_INSN = 1ULL << 21,
116 PERF_OUTPUT_INSNLEN = 1ULL << 22,
117 PERF_OUTPUT_BRSTACKINSN = 1ULL << 23,
118 PERF_OUTPUT_BRSTACKOFF = 1ULL << 24,
119 PERF_OUTPUT_SYNTH = 1ULL << 25,
120 PERF_OUTPUT_PHYS_ADDR = 1ULL << 26,
121 PERF_OUTPUT_UREGS = 1ULL << 27,
122 PERF_OUTPUT_METRIC = 1ULL << 28,
123 PERF_OUTPUT_MISC = 1ULL << 29,
124 PERF_OUTPUT_SRCCODE = 1ULL << 30,
125 PERF_OUTPUT_IPC = 1ULL << 31,
126 PERF_OUTPUT_TOD = 1ULL << 32,
127 PERF_OUTPUT_DATA_PAGE_SIZE = 1ULL << 33,
128 PERF_OUTPUT_CODE_PAGE_SIZE = 1ULL << 34,
129 PERF_OUTPUT_INS_LAT = 1ULL << 35,
130 PERF_OUTPUT_BRSTACKINSNLEN = 1ULL << 36,
131 PERF_OUTPUT_MACHINE_PID = 1ULL << 37,
132 PERF_OUTPUT_VCPU = 1ULL << 38,
133};
134
135struct perf_script {
136 struct perf_tool tool;
137 struct perf_session *session;
138 bool show_task_events;
139 bool show_mmap_events;
140 bool show_switch_events;
141 bool show_namespace_events;
142 bool show_lost_events;
143 bool show_round_events;
144 bool show_bpf_events;
145 bool show_cgroup_events;
146 bool show_text_poke_events;
147 bool allocated;
148 bool per_event_dump;
149 bool stitch_lbr;
150 struct evswitch evswitch;
151 struct perf_cpu_map *cpus;
152 struct perf_thread_map *threads;
153 int name_width;
154 const char *time_str;
155 struct perf_time_interval *ptime_range;
156 int range_size;
157 int range_num;
158};
159
160struct output_option {
161 const char *str;
162 enum perf_output_field field;
163} all_output_options[] = {
164 {.str = "comm", .field = PERF_OUTPUT_COMM},
165 {.str = "tid", .field = PERF_OUTPUT_TID},
166 {.str = "pid", .field = PERF_OUTPUT_PID},
167 {.str = "time", .field = PERF_OUTPUT_TIME},
168 {.str = "cpu", .field = PERF_OUTPUT_CPU},
169 {.str = "event", .field = PERF_OUTPUT_EVNAME},
170 {.str = "trace", .field = PERF_OUTPUT_TRACE},
171 {.str = "ip", .field = PERF_OUTPUT_IP},
172 {.str = "sym", .field = PERF_OUTPUT_SYM},
173 {.str = "dso", .field = PERF_OUTPUT_DSO},
174 {.str = "addr", .field = PERF_OUTPUT_ADDR},
175 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
176 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
177 {.str = "period", .field = PERF_OUTPUT_PERIOD},
178 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
179 {.str = "uregs", .field = PERF_OUTPUT_UREGS},
180 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
181 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
182 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
183 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
184 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
185 {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
186 {.str = "insn", .field = PERF_OUTPUT_INSN},
187 {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
188 {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
189 {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
190 {.str = "synth", .field = PERF_OUTPUT_SYNTH},
191 {.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
192 {.str = "metric", .field = PERF_OUTPUT_METRIC},
193 {.str = "misc", .field = PERF_OUTPUT_MISC},
194 {.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
195 {.str = "ipc", .field = PERF_OUTPUT_IPC},
196 {.str = "tod", .field = PERF_OUTPUT_TOD},
197 {.str = "data_page_size", .field = PERF_OUTPUT_DATA_PAGE_SIZE},
198 {.str = "code_page_size", .field = PERF_OUTPUT_CODE_PAGE_SIZE},
199 {.str = "ins_lat", .field = PERF_OUTPUT_INS_LAT},
200 {.str = "brstackinsnlen", .field = PERF_OUTPUT_BRSTACKINSNLEN},
201 {.str = "machine_pid", .field = PERF_OUTPUT_MACHINE_PID},
202 {.str = "vcpu", .field = PERF_OUTPUT_VCPU},
203};
204
205enum {
206 OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
207 OUTPUT_TYPE_OTHER,
208 OUTPUT_TYPE_MAX
209};
210
211/* default set to maintain compatibility with current format */
212static struct {
213 bool user_set;
214 bool wildcard_set;
215 unsigned int print_ip_opts;
216 u64 fields;
217 u64 invalid_fields;
218 u64 user_set_fields;
219 u64 user_unset_fields;
220} output[OUTPUT_TYPE_MAX] = {
221
222 [PERF_TYPE_HARDWARE] = {
223 .user_set = false,
224
225 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
226 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
227 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
228 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
229 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
230
231 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
232 },
233
234 [PERF_TYPE_SOFTWARE] = {
235 .user_set = false,
236
237 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
238 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
239 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
240 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
241 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
242 PERF_OUTPUT_BPF_OUTPUT,
243
244 .invalid_fields = PERF_OUTPUT_TRACE,
245 },
246
247 [PERF_TYPE_TRACEPOINT] = {
248 .user_set = false,
249
250 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
251 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
252 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
253 },
254
255 [PERF_TYPE_HW_CACHE] = {
256 .user_set = false,
257
258 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
259 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
260 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
261 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
262 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
263
264 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
265 },
266
267 [PERF_TYPE_RAW] = {
268 .user_set = false,
269
270 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
271 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
272 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
273 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
274 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
275 PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
276 PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR |
277 PERF_OUTPUT_DATA_PAGE_SIZE | PERF_OUTPUT_CODE_PAGE_SIZE |
278 PERF_OUTPUT_INS_LAT,
279
280 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
281 },
282
283 [PERF_TYPE_BREAKPOINT] = {
284 .user_set = false,
285
286 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
287 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
288 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
289 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
290 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
291
292 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
293 },
294
295 [OUTPUT_TYPE_SYNTH] = {
296 .user_set = false,
297
298 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
299 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
300 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
301 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
302 PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
303
304 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
305 },
306
307 [OUTPUT_TYPE_OTHER] = {
308 .user_set = false,
309
310 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
311 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
312 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
313 PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
314 PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
315
316 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
317 },
318};
319
320struct evsel_script {
321 char *filename;
322 FILE *fp;
323 u64 samples;
324 /* For metric output */
325 u64 val;
326 int gnum;
327};
328
329static inline struct evsel_script *evsel_script(struct evsel *evsel)
330{
331 return (struct evsel_script *)evsel->priv;
332}
333
334static struct evsel_script *evsel_script__new(struct evsel *evsel, struct perf_data *data)
335{
336 struct evsel_script *es = zalloc(sizeof(*es));
337
338 if (es != NULL) {
339 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
340 goto out_free;
341 es->fp = fopen(es->filename, "w");
342 if (es->fp == NULL)
343 goto out_free_filename;
344 }
345
346 return es;
347out_free_filename:
348 zfree(&es->filename);
349out_free:
350 free(es);
351 return NULL;
352}
353
354static void evsel_script__delete(struct evsel_script *es)
355{
356 zfree(&es->filename);
357 fclose(es->fp);
358 es->fp = NULL;
359 free(es);
360}
361
362static int evsel_script__fprintf(struct evsel_script *es, FILE *fp)
363{
364 struct stat st;
365
366 fstat(fileno(es->fp), &st);
367 return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
368 st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
369}
370
371static inline int output_type(unsigned int type)
372{
373 switch (type) {
374 case PERF_TYPE_SYNTH:
375 return OUTPUT_TYPE_SYNTH;
376 default:
377 if (type < PERF_TYPE_MAX)
378 return type;
379 }
380
381 return OUTPUT_TYPE_OTHER;
382}
383
384static bool output_set_by_user(void)
385{
386 int j;
387 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
388 if (output[j].user_set)
389 return true;
390 }
391 return false;
392}
393
394static const char *output_field2str(enum perf_output_field field)
395{
396 int i, imax = ARRAY_SIZE(all_output_options);
397 const char *str = "";
398
399 for (i = 0; i < imax; ++i) {
400 if (all_output_options[i].field == field) {
401 str = all_output_options[i].str;
402 break;
403 }
404 }
405 return str;
406}
407
408#define PRINT_FIELD(x) (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
409
410static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
411 enum perf_output_field field, bool allow_user_set)
412{
413 struct perf_event_attr *attr = &evsel->core.attr;
414 int type = output_type(attr->type);
415 const char *evname;
416
417 if (attr->sample_type & sample_type)
418 return 0;
419
420 if (output[type].user_set_fields & field) {
421 if (allow_user_set)
422 return 0;
423 evname = evsel__name(evsel);
424 pr_err("Samples for '%s' event do not have %s attribute set. "
425 "Cannot print '%s' field.\n",
426 evname, sample_msg, output_field2str(field));
427 return -1;
428 }
429
430 /* user did not ask for it explicitly so remove from the default list */
431 output[type].fields &= ~field;
432 evname = evsel__name(evsel);
433 pr_debug("Samples for '%s' event do not have %s attribute set. "
434 "Skipping '%s' field.\n",
435 evname, sample_msg, output_field2str(field));
436
437 return 0;
438}
439
440static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
441 enum perf_output_field field)
442{
443 return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
444}
445
446static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
447{
448 struct perf_event_attr *attr = &evsel->core.attr;
449 bool allow_user_set;
450
451 if (evsel__is_dummy_event(evsel))
452 return 0;
453
454 if (perf_header__has_feat(&session->header, HEADER_STAT))
455 return 0;
456
457 allow_user_set = perf_header__has_feat(&session->header,
458 HEADER_AUXTRACE);
459
460 if (PRINT_FIELD(TRACE) &&
461 !perf_session__has_traces(session, "record -R"))
462 return -EINVAL;
463
464 if (PRINT_FIELD(IP)) {
465 if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
466 return -EINVAL;
467 }
468
469 if (PRINT_FIELD(ADDR) &&
470 evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
471 return -EINVAL;
472
473 if (PRINT_FIELD(DATA_SRC) &&
474 evsel__do_check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC, allow_user_set))
475 return -EINVAL;
476
477 if (PRINT_FIELD(WEIGHT) &&
478 evsel__do_check_stype(evsel, PERF_SAMPLE_WEIGHT_TYPE, "WEIGHT", PERF_OUTPUT_WEIGHT, allow_user_set))
479 return -EINVAL;
480
481 if (PRINT_FIELD(SYM) &&
482 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
483 pr_err("Display of symbols requested but neither sample IP nor "
484 "sample address\navailable. Hence, no addresses to convert "
485 "to symbols.\n");
486 return -EINVAL;
487 }
488 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
489 pr_err("Display of offsets requested but symbol is not"
490 "selected.\n");
491 return -EINVAL;
492 }
493 if (PRINT_FIELD(DSO) &&
494 !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
495 pr_err("Display of DSO requested but no address to convert.\n");
496 return -EINVAL;
497 }
498 if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
499 pr_err("Display of source line number requested but sample IP is not\n"
500 "selected. Hence, no address to lookup the source line number.\n");
501 return -EINVAL;
502 }
503 if ((PRINT_FIELD(BRSTACKINSN) || PRINT_FIELD(BRSTACKINSNLEN)) && !allow_user_set &&
504 !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) {
505 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
506 "Hint: run 'perf record -b ...'\n");
507 return -EINVAL;
508 }
509 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
510 evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
511 return -EINVAL;
512
513 if (PRINT_FIELD(TIME) &&
514 evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
515 return -EINVAL;
516
517 if (PRINT_FIELD(CPU) &&
518 evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
519 return -EINVAL;
520
521 if (PRINT_FIELD(IREGS) &&
522 evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
523 return -EINVAL;
524
525 if (PRINT_FIELD(UREGS) &&
526 evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
527 return -EINVAL;
528
529 if (PRINT_FIELD(PHYS_ADDR) &&
530 evsel__do_check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR, allow_user_set))
531 return -EINVAL;
532
533 if (PRINT_FIELD(DATA_PAGE_SIZE) &&
534 evsel__check_stype(evsel, PERF_SAMPLE_DATA_PAGE_SIZE, "DATA_PAGE_SIZE", PERF_OUTPUT_DATA_PAGE_SIZE))
535 return -EINVAL;
536
537 if (PRINT_FIELD(CODE_PAGE_SIZE) &&
538 evsel__check_stype(evsel, PERF_SAMPLE_CODE_PAGE_SIZE, "CODE_PAGE_SIZE", PERF_OUTPUT_CODE_PAGE_SIZE))
539 return -EINVAL;
540
541 if (PRINT_FIELD(INS_LAT) &&
542 evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_STRUCT, "WEIGHT_STRUCT", PERF_OUTPUT_INS_LAT))
543 return -EINVAL;
544
545 return 0;
546}
547
548static void set_print_ip_opts(struct perf_event_attr *attr)
549{
550 unsigned int type = output_type(attr->type);
551
552 output[type].print_ip_opts = 0;
553 if (PRINT_FIELD(IP))
554 output[type].print_ip_opts |= EVSEL__PRINT_IP;
555
556 if (PRINT_FIELD(SYM))
557 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
558
559 if (PRINT_FIELD(DSO))
560 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
561
562 if (PRINT_FIELD(SYMOFFSET))
563 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
564
565 if (PRINT_FIELD(SRCLINE))
566 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
567}
568
569static struct evsel *find_first_output_type(struct evlist *evlist,
570 unsigned int type)
571{
572 struct evsel *evsel;
573
574 evlist__for_each_entry(evlist, evsel) {
575 if (evsel__is_dummy_event(evsel))
576 continue;
577 if (output_type(evsel->core.attr.type) == (int)type)
578 return evsel;
579 }
580 return NULL;
581}
582
583/*
584 * verify all user requested events exist and the samples
585 * have the expected data
586 */
587static int perf_session__check_output_opt(struct perf_session *session)
588{
589 bool tod = false;
590 unsigned int j;
591 struct evsel *evsel;
592
593 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
594 evsel = find_first_output_type(session->evlist, j);
595
596 /*
597 * even if fields is set to 0 (ie., show nothing) event must
598 * exist if user explicitly includes it on the command line
599 */
600 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
601 j != OUTPUT_TYPE_SYNTH) {
602 pr_err("%s events do not exist. "
603 "Remove corresponding -F option to proceed.\n",
604 event_type(j));
605 return -1;
606 }
607
608 if (evsel && output[j].fields &&
609 evsel__check_attr(evsel, session))
610 return -1;
611
612 if (evsel == NULL)
613 continue;
614
615 set_print_ip_opts(&evsel->core.attr);
616 tod |= output[j].fields & PERF_OUTPUT_TOD;
617 }
618
619 if (!no_callchain) {
620 bool use_callchain = false;
621 bool not_pipe = false;
622
623 evlist__for_each_entry(session->evlist, evsel) {
624 not_pipe = true;
625 if (evsel__has_callchain(evsel)) {
626 use_callchain = true;
627 break;
628 }
629 }
630 if (not_pipe && !use_callchain)
631 symbol_conf.use_callchain = false;
632 }
633
634 /*
635 * set default for tracepoints to print symbols only
636 * if callchains are present
637 */
638 if (symbol_conf.use_callchain &&
639 !output[PERF_TYPE_TRACEPOINT].user_set) {
640 j = PERF_TYPE_TRACEPOINT;
641
642 evlist__for_each_entry(session->evlist, evsel) {
643 if (evsel->core.attr.type != j)
644 continue;
645
646 if (evsel__has_callchain(evsel)) {
647 output[j].fields |= PERF_OUTPUT_IP;
648 output[j].fields |= PERF_OUTPUT_SYM;
649 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
650 output[j].fields |= PERF_OUTPUT_DSO;
651 set_print_ip_opts(&evsel->core.attr);
652 goto out;
653 }
654 }
655 }
656
657 if (tod && !session->header.env.clock.enabled) {
658 pr_err("Can't provide 'tod' time, missing clock data. "
659 "Please record with -k/--clockid option.\n");
660 return -1;
661 }
662out:
663 return 0;
664}
665
666static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask, const char *arch,
667 FILE *fp)
668{
669 unsigned i = 0, r;
670 int printed = 0;
671
672 if (!regs || !regs->regs)
673 return 0;
674
675 printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
676
677 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
678 u64 val = regs->regs[i++];
679 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r, arch), val);
680 }
681
682 return printed;
683}
684
685#define DEFAULT_TOD_FMT "%F %H:%M:%S"
686
687static char*
688tod_scnprintf(struct perf_script *script, char *buf, int buflen,
689 u64 timestamp)
690{
691 u64 tod_ns, clockid_ns;
692 struct perf_env *env;
693 unsigned long nsec;
694 struct tm ltime;
695 char date[64];
696 time_t sec;
697
698 buf[0] = '\0';
699 if (buflen < 64 || !script)
700 return buf;
701
702 env = &script->session->header.env;
703 if (!env->clock.enabled) {
704 scnprintf(buf, buflen, "disabled");
705 return buf;
706 }
707
708 clockid_ns = env->clock.clockid_ns;
709 tod_ns = env->clock.tod_ns;
710
711 if (timestamp > clockid_ns)
712 tod_ns += timestamp - clockid_ns;
713 else
714 tod_ns -= clockid_ns - timestamp;
715
716 sec = (time_t) (tod_ns / NSEC_PER_SEC);
717 nsec = tod_ns - sec * NSEC_PER_SEC;
718
719 if (localtime_r(&sec, <ime) == NULL) {
720 scnprintf(buf, buflen, "failed");
721 } else {
722 strftime(date, sizeof(date), DEFAULT_TOD_FMT, <ime);
723
724 if (symbol_conf.nanosecs) {
725 snprintf(buf, buflen, "%s.%09lu", date, nsec);
726 } else {
727 snprintf(buf, buflen, "%s.%06lu",
728 date, nsec / NSEC_PER_USEC);
729 }
730 }
731
732 return buf;
733}
734
735static int perf_sample__fprintf_iregs(struct perf_sample *sample,
736 struct perf_event_attr *attr, const char *arch, FILE *fp)
737{
738 return perf_sample__fprintf_regs(&sample->intr_regs,
739 attr->sample_regs_intr, arch, fp);
740}
741
742static int perf_sample__fprintf_uregs(struct perf_sample *sample,
743 struct perf_event_attr *attr, const char *arch, FILE *fp)
744{
745 return perf_sample__fprintf_regs(&sample->user_regs,
746 attr->sample_regs_user, arch, fp);
747}
748
749static int perf_sample__fprintf_start(struct perf_script *script,
750 struct perf_sample *sample,
751 struct thread *thread,
752 struct evsel *evsel,
753 u32 type, FILE *fp)
754{
755 struct perf_event_attr *attr = &evsel->core.attr;
756 unsigned long secs;
757 unsigned long long nsecs;
758 int printed = 0;
759 char tstr[128];
760
761 if (PRINT_FIELD(MACHINE_PID) && sample->machine_pid)
762 printed += fprintf(fp, "VM:%5d ", sample->machine_pid);
763
764 /* Print VCPU only for guest events i.e. with machine_pid */
765 if (PRINT_FIELD(VCPU) && sample->machine_pid)
766 printed += fprintf(fp, "VCPU:%03d ", sample->vcpu);
767
768 if (PRINT_FIELD(COMM)) {
769 const char *comm = thread ? thread__comm_str(thread) : ":-1";
770
771 if (latency_format)
772 printed += fprintf(fp, "%8.8s ", comm);
773 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
774 printed += fprintf(fp, "%s ", comm);
775 else
776 printed += fprintf(fp, "%16s ", comm);
777 }
778
779 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
780 printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
781 else if (PRINT_FIELD(PID))
782 printed += fprintf(fp, "%5d ", sample->pid);
783 else if (PRINT_FIELD(TID))
784 printed += fprintf(fp, "%5d ", sample->tid);
785
786 if (PRINT_FIELD(CPU)) {
787 if (latency_format)
788 printed += fprintf(fp, "%3d ", sample->cpu);
789 else
790 printed += fprintf(fp, "[%03d] ", sample->cpu);
791 }
792
793 if (PRINT_FIELD(MISC)) {
794 int ret = 0;
795
796 #define has(m) \
797 (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
798
799 if (has(KERNEL))
800 ret += fprintf(fp, "K");
801 if (has(USER))
802 ret += fprintf(fp, "U");
803 if (has(HYPERVISOR))
804 ret += fprintf(fp, "H");
805 if (has(GUEST_KERNEL))
806 ret += fprintf(fp, "G");
807 if (has(GUEST_USER))
808 ret += fprintf(fp, "g");
809
810 switch (type) {
811 case PERF_RECORD_MMAP:
812 case PERF_RECORD_MMAP2:
813 if (has(MMAP_DATA))
814 ret += fprintf(fp, "M");
815 break;
816 case PERF_RECORD_COMM:
817 if (has(COMM_EXEC))
818 ret += fprintf(fp, "E");
819 break;
820 case PERF_RECORD_SWITCH:
821 case PERF_RECORD_SWITCH_CPU_WIDE:
822 if (has(SWITCH_OUT)) {
823 ret += fprintf(fp, "S");
824 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
825 ret += fprintf(fp, "p");
826 }
827 default:
828 break;
829 }
830
831 #undef has
832
833 ret += fprintf(fp, "%*s", 6 - ret, " ");
834 printed += ret;
835 }
836
837 if (PRINT_FIELD(TOD)) {
838 tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
839 printed += fprintf(fp, "%s ", tstr);
840 }
841
842 if (PRINT_FIELD(TIME)) {
843 u64 t = sample->time;
844 if (reltime) {
845 if (!initial_time)
846 initial_time = sample->time;
847 t = sample->time - initial_time;
848 } else if (deltatime) {
849 if (previous_time)
850 t = sample->time - previous_time;
851 else {
852 t = 0;
853 }
854 previous_time = sample->time;
855 }
856 nsecs = t;
857 secs = nsecs / NSEC_PER_SEC;
858 nsecs -= secs * NSEC_PER_SEC;
859
860 if (symbol_conf.nanosecs)
861 printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
862 else {
863 char sample_time[32];
864 timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
865 printed += fprintf(fp, "%12s: ", sample_time);
866 }
867 }
868
869 return printed;
870}
871
872static inline char
873mispred_str(struct branch_entry *br)
874{
875 if (!(br->flags.mispred || br->flags.predicted))
876 return '-';
877
878 return br->flags.predicted ? 'P' : 'M';
879}
880
881static int print_bstack_flags(FILE *fp, struct branch_entry *br)
882{
883 return fprintf(fp, "/%c/%c/%c/%d/%s ",
884 mispred_str(br),
885 br->flags.in_tx ? 'X' : '-',
886 br->flags.abort ? 'A' : '-',
887 br->flags.cycles,
888 get_branch_type(br));
889}
890
891static int perf_sample__fprintf_brstack(struct perf_sample *sample,
892 struct thread *thread,
893 struct perf_event_attr *attr, FILE *fp)
894{
895 struct branch_stack *br = sample->branch_stack;
896 struct branch_entry *entries = perf_sample__branch_entries(sample);
897 struct addr_location alf, alt;
898 u64 i, from, to;
899 int printed = 0;
900
901 if (!(br && br->nr))
902 return 0;
903
904 for (i = 0; i < br->nr; i++) {
905 from = entries[i].from;
906 to = entries[i].to;
907
908 if (PRINT_FIELD(DSO)) {
909 memset(&alf, 0, sizeof(alf));
910 memset(&alt, 0, sizeof(alt));
911 thread__find_map_fb(thread, sample->cpumode, from, &alf);
912 thread__find_map_fb(thread, sample->cpumode, to, &alt);
913 }
914
915 printed += fprintf(fp, " 0x%"PRIx64, from);
916 if (PRINT_FIELD(DSO)) {
917 printed += fprintf(fp, "(");
918 printed += map__fprintf_dsoname(alf.map, fp);
919 printed += fprintf(fp, ")");
920 }
921
922 printed += fprintf(fp, "/0x%"PRIx64, to);
923 if (PRINT_FIELD(DSO)) {
924 printed += fprintf(fp, "(");
925 printed += map__fprintf_dsoname(alt.map, fp);
926 printed += fprintf(fp, ")");
927 }
928
929 printed += print_bstack_flags(fp, entries + i);
930 }
931
932 return printed;
933}
934
935static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
936 struct thread *thread,
937 struct perf_event_attr *attr, FILE *fp)
938{
939 struct branch_stack *br = sample->branch_stack;
940 struct branch_entry *entries = perf_sample__branch_entries(sample);
941 struct addr_location alf, alt;
942 u64 i, from, to;
943 int printed = 0;
944
945 if (!(br && br->nr))
946 return 0;
947
948 for (i = 0; i < br->nr; i++) {
949
950 memset(&alf, 0, sizeof(alf));
951 memset(&alt, 0, sizeof(alt));
952 from = entries[i].from;
953 to = entries[i].to;
954
955 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
956 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
957
958 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
959 if (PRINT_FIELD(DSO)) {
960 printed += fprintf(fp, "(");
961 printed += map__fprintf_dsoname(alf.map, fp);
962 printed += fprintf(fp, ")");
963 }
964 printed += fprintf(fp, "%c", '/');
965 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
966 if (PRINT_FIELD(DSO)) {
967 printed += fprintf(fp, "(");
968 printed += map__fprintf_dsoname(alt.map, fp);
969 printed += fprintf(fp, ")");
970 }
971 printed += print_bstack_flags(fp, entries + i);
972 }
973
974 return printed;
975}
976
977static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
978 struct thread *thread,
979 struct perf_event_attr *attr, FILE *fp)
980{
981 struct branch_stack *br = sample->branch_stack;
982 struct branch_entry *entries = perf_sample__branch_entries(sample);
983 struct addr_location alf, alt;
984 u64 i, from, to;
985 int printed = 0;
986
987 if (!(br && br->nr))
988 return 0;
989
990 for (i = 0; i < br->nr; i++) {
991
992 memset(&alf, 0, sizeof(alf));
993 memset(&alt, 0, sizeof(alt));
994 from = entries[i].from;
995 to = entries[i].to;
996
997 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
998 !alf.map->dso->adjust_symbols)
999 from = map__map_ip(alf.map, from);
1000
1001 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
1002 !alt.map->dso->adjust_symbols)
1003 to = map__map_ip(alt.map, to);
1004
1005 printed += fprintf(fp, " 0x%"PRIx64, from);
1006 if (PRINT_FIELD(DSO)) {
1007 printed += fprintf(fp, "(");
1008 printed += map__fprintf_dsoname(alf.map, fp);
1009 printed += fprintf(fp, ")");
1010 }
1011 printed += fprintf(fp, "/0x%"PRIx64, to);
1012 if (PRINT_FIELD(DSO)) {
1013 printed += fprintf(fp, "(");
1014 printed += map__fprintf_dsoname(alt.map, fp);
1015 printed += fprintf(fp, ")");
1016 }
1017 printed += print_bstack_flags(fp, entries + i);
1018 }
1019
1020 return printed;
1021}
1022#define MAXBB 16384UL
1023
1024static int grab_bb(u8 *buffer, u64 start, u64 end,
1025 struct machine *machine, struct thread *thread,
1026 bool *is64bit, u8 *cpumode, bool last)
1027{
1028 long offset, len;
1029 struct addr_location al;
1030 bool kernel;
1031
1032 if (!start || !end)
1033 return 0;
1034
1035 kernel = machine__kernel_ip(machine, start);
1036 if (kernel)
1037 *cpumode = PERF_RECORD_MISC_KERNEL;
1038 else
1039 *cpumode = PERF_RECORD_MISC_USER;
1040
1041 /*
1042 * Block overlaps between kernel and user.
1043 * This can happen due to ring filtering
1044 * On Intel CPUs the entry into the kernel is filtered,
1045 * but the exit is not. Let the caller patch it up.
1046 */
1047 if (kernel != machine__kernel_ip(machine, end)) {
1048 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
1049 return -ENXIO;
1050 }
1051
1052 memset(&al, 0, sizeof(al));
1053 if (end - start > MAXBB - MAXINSN) {
1054 if (last)
1055 pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
1056 else
1057 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
1058 return 0;
1059 }
1060
1061 if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
1062 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1063 return 0;
1064 }
1065 if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
1066 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1067 return 0;
1068 }
1069
1070 /* Load maps to ensure dso->is_64_bit has been updated */
1071 map__load(al.map);
1072
1073 offset = al.map->map_ip(al.map, start);
1074 len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
1075 end - start + MAXINSN);
1076
1077 *is64bit = al.map->dso->is_64_bit;
1078 if (len <= 0)
1079 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1080 start, end);
1081 return len;
1082}
1083
1084static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
1085{
1086 char *srcfile;
1087 int ret = 0;
1088 unsigned line;
1089 int len;
1090 char *srccode;
1091
1092 if (!map || !map->dso)
1093 return 0;
1094 srcfile = get_srcline_split(map->dso,
1095 map__rip_2objdump(map, addr),
1096 &line);
1097 if (!srcfile)
1098 return 0;
1099
1100 /* Avoid redundant printing */
1101 if (state &&
1102 state->srcfile &&
1103 !strcmp(state->srcfile, srcfile) &&
1104 state->line == line) {
1105 free(srcfile);
1106 return 0;
1107 }
1108
1109 srccode = find_sourceline(srcfile, line, &len);
1110 if (!srccode)
1111 goto out_free_line;
1112
1113 ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
1114
1115 if (state) {
1116 state->srcfile = srcfile;
1117 state->line = line;
1118 }
1119 return ret;
1120
1121out_free_line:
1122 free(srcfile);
1123 return ret;
1124}
1125
1126static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
1127{
1128 struct addr_location al;
1129 int ret = 0;
1130
1131 memset(&al, 0, sizeof(al));
1132 thread__find_map(thread, cpumode, addr, &al);
1133 if (!al.map)
1134 return 0;
1135 ret = map__fprintf_srccode(al.map, al.addr, stdout,
1136 &thread->srccode_state);
1137 if (ret)
1138 ret += printf("\n");
1139 return ret;
1140}
1141
1142static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
1143 struct perf_insn *x, u8 *inbuf, int len,
1144 int insn, FILE *fp, int *total_cycles,
1145 struct perf_event_attr *attr)
1146{
1147 int ilen = 0;
1148 int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t", ip,
1149 dump_insn(x, ip, inbuf, len, &ilen));
1150
1151 if (PRINT_FIELD(BRSTACKINSNLEN))
1152 printed += fprintf(fp, "ilen: %d\t", ilen);
1153
1154 printed += fprintf(fp, "#%s%s%s%s",
1155 en->flags.predicted ? " PRED" : "",
1156 en->flags.mispred ? " MISPRED" : "",
1157 en->flags.in_tx ? " INTX" : "",
1158 en->flags.abort ? " ABORT" : "");
1159 if (en->flags.cycles) {
1160 *total_cycles += en->flags.cycles;
1161 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1162 if (insn)
1163 printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1164 }
1165 return printed + fprintf(fp, "\n");
1166}
1167
1168static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1169 u8 cpumode, int cpu, struct symbol **lastsym,
1170 struct perf_event_attr *attr, FILE *fp)
1171{
1172 struct addr_location al;
1173 int off, printed = 0;
1174
1175 memset(&al, 0, sizeof(al));
1176
1177 thread__find_map(thread, cpumode, addr, &al);
1178
1179 if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1180 return 0;
1181
1182 al.cpu = cpu;
1183 al.sym = NULL;
1184 if (al.map)
1185 al.sym = map__find_symbol(al.map, al.addr);
1186
1187 if (!al.sym)
1188 return 0;
1189
1190 if (al.addr < al.sym->end)
1191 off = al.addr - al.sym->start;
1192 else
1193 off = al.addr - al.map->start - al.sym->start;
1194 printed += fprintf(fp, "\t%s", al.sym->name);
1195 if (off)
1196 printed += fprintf(fp, "%+d", off);
1197 printed += fprintf(fp, ":");
1198 if (PRINT_FIELD(SRCLINE))
1199 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1200 printed += fprintf(fp, "\n");
1201 *lastsym = al.sym;
1202
1203 return printed;
1204}
1205
1206static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1207 struct thread *thread,
1208 struct perf_event_attr *attr,
1209 struct machine *machine, FILE *fp)
1210{
1211 struct branch_stack *br = sample->branch_stack;
1212 struct branch_entry *entries = perf_sample__branch_entries(sample);
1213 u64 start, end;
1214 int i, insn, len, nr, ilen, printed = 0;
1215 struct perf_insn x;
1216 u8 buffer[MAXBB];
1217 unsigned off;
1218 struct symbol *lastsym = NULL;
1219 int total_cycles = 0;
1220
1221 if (!(br && br->nr))
1222 return 0;
1223 nr = br->nr;
1224 if (max_blocks && nr > max_blocks + 1)
1225 nr = max_blocks + 1;
1226
1227 x.thread = thread;
1228 x.cpu = sample->cpu;
1229
1230 printed += fprintf(fp, "%c", '\n');
1231
1232 /* Handle first from jump, of which we don't know the entry. */
1233 len = grab_bb(buffer, entries[nr-1].from,
1234 entries[nr-1].from,
1235 machine, thread, &x.is64bit, &x.cpumode, false);
1236 if (len > 0) {
1237 printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1238 x.cpumode, x.cpu, &lastsym, attr, fp);
1239 printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1240 &x, buffer, len, 0, fp, &total_cycles,
1241 attr);
1242 if (PRINT_FIELD(SRCCODE))
1243 printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1244 }
1245
1246 /* Print all blocks */
1247 for (i = nr - 2; i >= 0; i--) {
1248 if (entries[i].from || entries[i].to)
1249 pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1250 entries[i].from,
1251 entries[i].to);
1252 start = entries[i + 1].to;
1253 end = entries[i].from;
1254
1255 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1256 /* Patch up missing kernel transfers due to ring filters */
1257 if (len == -ENXIO && i > 0) {
1258 end = entries[--i].from;
1259 pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1260 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1261 }
1262 if (len <= 0)
1263 continue;
1264
1265 insn = 0;
1266 for (off = 0; off < (unsigned)len; off += ilen) {
1267 uint64_t ip = start + off;
1268
1269 printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1270 if (ip == end) {
1271 printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1272 &total_cycles, attr);
1273 if (PRINT_FIELD(SRCCODE))
1274 printed += print_srccode(thread, x.cpumode, ip);
1275 break;
1276 } else {
1277 ilen = 0;
1278 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", ip,
1279 dump_insn(&x, ip, buffer + off, len - off, &ilen));
1280 if (PRINT_FIELD(BRSTACKINSNLEN))
1281 printed += fprintf(fp, "\tilen: %d", ilen);
1282 printed += fprintf(fp, "\n");
1283 if (ilen == 0)
1284 break;
1285 if (PRINT_FIELD(SRCCODE))
1286 print_srccode(thread, x.cpumode, ip);
1287 insn++;
1288 }
1289 }
1290 if (off != end - start)
1291 printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1292 }
1293
1294 /*
1295 * Hit the branch? In this case we are already done, and the target
1296 * has not been executed yet.
1297 */
1298 if (entries[0].from == sample->ip)
1299 goto out;
1300 if (entries[0].flags.abort)
1301 goto out;
1302
1303 /*
1304 * Print final block upto sample
1305 *
1306 * Due to pipeline delays the LBRs might be missing a branch
1307 * or two, which can result in very large or negative blocks
1308 * between final branch and sample. When this happens just
1309 * continue walking after the last TO until we hit a branch.
1310 */
1311 start = entries[0].to;
1312 end = sample->ip;
1313 if (end < start) {
1314 /* Missing jump. Scan 128 bytes for the next branch */
1315 end = start + 128;
1316 }
1317 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1318 printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1319 if (len <= 0) {
1320 /* Print at least last IP if basic block did not work */
1321 len = grab_bb(buffer, sample->ip, sample->ip,
1322 machine, thread, &x.is64bit, &x.cpumode, false);
1323 if (len <= 0)
1324 goto out;
1325 ilen = 0;
1326 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", sample->ip,
1327 dump_insn(&x, sample->ip, buffer, len, &ilen));
1328 if (PRINT_FIELD(BRSTACKINSNLEN))
1329 printed += fprintf(fp, "\tilen: %d", ilen);
1330 printed += fprintf(fp, "\n");
1331 if (PRINT_FIELD(SRCCODE))
1332 print_srccode(thread, x.cpumode, sample->ip);
1333 goto out;
1334 }
1335 for (off = 0; off <= end - start; off += ilen) {
1336 ilen = 0;
1337 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", start + off,
1338 dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1339 if (PRINT_FIELD(BRSTACKINSNLEN))
1340 printed += fprintf(fp, "\tilen: %d", ilen);
1341 printed += fprintf(fp, "\n");
1342 if (ilen == 0)
1343 break;
1344 if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1345 /*
1346 * Hit a missing branch. Just stop.
1347 */
1348 printed += fprintf(fp, "\t... not reaching sample ...\n");
1349 break;
1350 }
1351 if (PRINT_FIELD(SRCCODE))
1352 print_srccode(thread, x.cpumode, start + off);
1353 }
1354out:
1355 return printed;
1356}
1357
1358static int perf_sample__fprintf_addr(struct perf_sample *sample,
1359 struct thread *thread,
1360 struct perf_event_attr *attr, FILE *fp)
1361{
1362 struct addr_location al;
1363 int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1364
1365 if (!sample_addr_correlates_sym(attr))
1366 goto out;
1367
1368 thread__resolve(thread, &al, sample);
1369
1370 if (PRINT_FIELD(SYM)) {
1371 printed += fprintf(fp, " ");
1372 if (PRINT_FIELD(SYMOFFSET))
1373 printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1374 else
1375 printed += symbol__fprintf_symname(al.sym, fp);
1376 }
1377
1378 if (PRINT_FIELD(DSO)) {
1379 printed += fprintf(fp, " (");
1380 printed += map__fprintf_dsoname(al.map, fp);
1381 printed += fprintf(fp, ")");
1382 }
1383out:
1384 return printed;
1385}
1386
1387static const char *resolve_branch_sym(struct perf_sample *sample,
1388 struct evsel *evsel,
1389 struct thread *thread,
1390 struct addr_location *al,
1391 struct addr_location *addr_al,
1392 u64 *ip)
1393{
1394 struct perf_event_attr *attr = &evsel->core.attr;
1395 const char *name = NULL;
1396
1397 if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1398 if (sample_addr_correlates_sym(attr)) {
1399 if (!addr_al->thread)
1400 thread__resolve(thread, addr_al, sample);
1401 if (addr_al->sym)
1402 name = addr_al->sym->name;
1403 else
1404 *ip = sample->addr;
1405 } else {
1406 *ip = sample->addr;
1407 }
1408 } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1409 if (al->sym)
1410 name = al->sym->name;
1411 else
1412 *ip = sample->ip;
1413 }
1414 return name;
1415}
1416
1417static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1418 struct evsel *evsel,
1419 struct thread *thread,
1420 struct addr_location *al,
1421 struct addr_location *addr_al,
1422 FILE *fp)
1423{
1424 struct perf_event_attr *attr = &evsel->core.attr;
1425 size_t depth = thread_stack__depth(thread, sample->cpu);
1426 const char *name = NULL;
1427 static int spacing;
1428 int len = 0;
1429 int dlen = 0;
1430 u64 ip = 0;
1431
1432 /*
1433 * The 'return' has already been popped off the stack so the depth has
1434 * to be adjusted to match the 'call'.
1435 */
1436 if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
1437 depth += 1;
1438
1439 name = resolve_branch_sym(sample, evsel, thread, al, addr_al, &ip);
1440
1441 if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1442 dlen += fprintf(fp, "(");
1443 dlen += map__fprintf_dsoname(al->map, fp);
1444 dlen += fprintf(fp, ")\t");
1445 }
1446
1447 if (name)
1448 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1449 else if (ip)
1450 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1451
1452 if (len < 0)
1453 return len;
1454
1455 /*
1456 * Try to keep the output length from changing frequently so that the
1457 * output lines up more nicely.
1458 */
1459 if (len > spacing || (len && len < spacing - 52))
1460 spacing = round_up(len + 4, 32);
1461
1462 if (len < spacing)
1463 len += fprintf(fp, "%*s", spacing - len, "");
1464
1465 return len + dlen;
1466}
1467
1468__weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1469 struct thread *thread __maybe_unused,
1470 struct machine *machine __maybe_unused)
1471{
1472}
1473
1474void script_fetch_insn(struct perf_sample *sample, struct thread *thread,
1475 struct machine *machine)
1476{
1477 if (sample->insn_len == 0 && native_arch)
1478 arch_fetch_insn(sample, thread, machine);
1479}
1480
1481static int perf_sample__fprintf_insn(struct perf_sample *sample,
1482 struct perf_event_attr *attr,
1483 struct thread *thread,
1484 struct machine *machine, FILE *fp)
1485{
1486 int printed = 0;
1487
1488 script_fetch_insn(sample, thread, machine);
1489
1490 if (PRINT_FIELD(INSNLEN))
1491 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1492 if (PRINT_FIELD(INSN) && sample->insn_len) {
1493 int i;
1494
1495 printed += fprintf(fp, " insn:");
1496 for (i = 0; i < sample->insn_len; i++)
1497 printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1498 }
1499 if (PRINT_FIELD(BRSTACKINSN) || PRINT_FIELD(BRSTACKINSNLEN))
1500 printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1501
1502 return printed;
1503}
1504
1505static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1506 struct perf_event_attr *attr, FILE *fp)
1507{
1508 unsigned int ipc;
1509
1510 if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1511 return 0;
1512
1513 ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1514
1515 return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1516 ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1517}
1518
1519static int perf_sample__fprintf_bts(struct perf_sample *sample,
1520 struct evsel *evsel,
1521 struct thread *thread,
1522 struct addr_location *al,
1523 struct addr_location *addr_al,
1524 struct machine *machine, FILE *fp)
1525{
1526 struct perf_event_attr *attr = &evsel->core.attr;
1527 unsigned int type = output_type(attr->type);
1528 bool print_srcline_last = false;
1529 int printed = 0;
1530
1531 if (PRINT_FIELD(CALLINDENT))
1532 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, addr_al, fp);
1533
1534 /* print branch_from information */
1535 if (PRINT_FIELD(IP)) {
1536 unsigned int print_opts = output[type].print_ip_opts;
1537 struct callchain_cursor *cursor = NULL;
1538
1539 if (symbol_conf.use_callchain && sample->callchain &&
1540 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1541 sample, NULL, NULL, scripting_max_stack) == 0)
1542 cursor = &callchain_cursor;
1543
1544 if (cursor == NULL) {
1545 printed += fprintf(fp, " ");
1546 if (print_opts & EVSEL__PRINT_SRCLINE) {
1547 print_srcline_last = true;
1548 print_opts &= ~EVSEL__PRINT_SRCLINE;
1549 }
1550 } else
1551 printed += fprintf(fp, "\n");
1552
1553 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1554 symbol_conf.bt_stop_list, fp);
1555 }
1556
1557 /* print branch_to information */
1558 if (PRINT_FIELD(ADDR) ||
1559 ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1560 !output[type].user_set)) {
1561 printed += fprintf(fp, " => ");
1562 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1563 }
1564
1565 printed += perf_sample__fprintf_ipc(sample, attr, fp);
1566
1567 if (print_srcline_last)
1568 printed += map__fprintf_srcline(al->map, al->addr, "\n ", fp);
1569
1570 printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1571 printed += fprintf(fp, "\n");
1572 if (PRINT_FIELD(SRCCODE)) {
1573 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1574 &thread->srccode_state);
1575 if (ret) {
1576 printed += ret;
1577 printed += printf("\n");
1578 }
1579 }
1580 return printed;
1581}
1582
1583static struct {
1584 u32 flags;
1585 const char *name;
1586} sample_flags[] = {
1587 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1588 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1589 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1590 {PERF_IP_FLAG_BRANCH, "jmp"},
1591 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1592 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1593 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1594 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1595 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1596 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1597 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1598 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1599 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1600 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMENTRY, "vmentry"},
1601 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMEXIT, "vmexit"},
1602 {0, NULL}
1603};
1604
1605static const char *sample_flags_to_name(u32 flags)
1606{
1607 int i;
1608
1609 for (i = 0; sample_flags[i].name ; i++) {
1610 if (sample_flags[i].flags == flags)
1611 return sample_flags[i].name;
1612 }
1613
1614 return NULL;
1615}
1616
1617int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz)
1618{
1619 u32 xf = PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_INTR_DISABLE |
1620 PERF_IP_FLAG_INTR_TOGGLE;
1621 const char *chars = PERF_IP_FLAG_CHARS;
1622 const size_t n = strlen(PERF_IP_FLAG_CHARS);
1623 const char *name = NULL;
1624 size_t i, pos = 0;
1625 char xs[16] = {0};
1626
1627 if (flags & xf)
1628 snprintf(xs, sizeof(xs), "(%s%s%s)",
1629 flags & PERF_IP_FLAG_IN_TX ? "x" : "",
1630 flags & PERF_IP_FLAG_INTR_DISABLE ? "D" : "",
1631 flags & PERF_IP_FLAG_INTR_TOGGLE ? "t" : "");
1632
1633 name = sample_flags_to_name(flags & ~xf);
1634 if (name)
1635 return snprintf(str, sz, "%-15s%6s", name, xs);
1636
1637 if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1638 name = sample_flags_to_name(flags & ~(xf | PERF_IP_FLAG_TRACE_BEGIN));
1639 if (name)
1640 return snprintf(str, sz, "tr strt %-7s%6s", name, xs);
1641 }
1642
1643 if (flags & PERF_IP_FLAG_TRACE_END) {
1644 name = sample_flags_to_name(flags & ~(xf | PERF_IP_FLAG_TRACE_END));
1645 if (name)
1646 return snprintf(str, sz, "tr end %-7s%6s", name, xs);
1647 }
1648
1649 for (i = 0; i < n; i++, flags >>= 1) {
1650 if ((flags & 1) && pos < sz)
1651 str[pos++] = chars[i];
1652 }
1653 for (; i < 32; i++, flags >>= 1) {
1654 if ((flags & 1) && pos < sz)
1655 str[pos++] = '?';
1656 }
1657 if (pos < sz)
1658 str[pos] = 0;
1659
1660 return pos;
1661}
1662
1663static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1664{
1665 char str[SAMPLE_FLAGS_BUF_SIZE];
1666
1667 perf_sample__sprintf_flags(flags, str, sizeof(str));
1668 return fprintf(fp, " %-21s ", str);
1669}
1670
1671struct printer_data {
1672 int line_no;
1673 bool hit_nul;
1674 bool is_printable;
1675};
1676
1677static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1678 unsigned int val,
1679 void *extra, FILE *fp)
1680{
1681 unsigned char ch = (unsigned char)val;
1682 struct printer_data *printer_data = extra;
1683 int printed = 0;
1684
1685 switch (op) {
1686 case BINARY_PRINT_DATA_BEGIN:
1687 printed += fprintf(fp, "\n");
1688 break;
1689 case BINARY_PRINT_LINE_BEGIN:
1690 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1691 " ");
1692 break;
1693 case BINARY_PRINT_ADDR:
1694 printed += fprintf(fp, " %04x:", val);
1695 break;
1696 case BINARY_PRINT_NUM_DATA:
1697 printed += fprintf(fp, " %02x", val);
1698 break;
1699 case BINARY_PRINT_NUM_PAD:
1700 printed += fprintf(fp, " ");
1701 break;
1702 case BINARY_PRINT_SEP:
1703 printed += fprintf(fp, " ");
1704 break;
1705 case BINARY_PRINT_CHAR_DATA:
1706 if (printer_data->hit_nul && ch)
1707 printer_data->is_printable = false;
1708
1709 if (!isprint(ch)) {
1710 printed += fprintf(fp, "%c", '.');
1711
1712 if (!printer_data->is_printable)
1713 break;
1714
1715 if (ch == '\0')
1716 printer_data->hit_nul = true;
1717 else
1718 printer_data->is_printable = false;
1719 } else {
1720 printed += fprintf(fp, "%c", ch);
1721 }
1722 break;
1723 case BINARY_PRINT_CHAR_PAD:
1724 printed += fprintf(fp, " ");
1725 break;
1726 case BINARY_PRINT_LINE_END:
1727 printed += fprintf(fp, "\n");
1728 printer_data->line_no++;
1729 break;
1730 case BINARY_PRINT_DATA_END:
1731 default:
1732 break;
1733 }
1734
1735 return printed;
1736}
1737
1738static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1739{
1740 unsigned int nr_bytes = sample->raw_size;
1741 struct printer_data printer_data = {0, false, true};
1742 int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1743 sample__fprintf_bpf_output, &printer_data, fp);
1744
1745 if (printer_data.is_printable && printer_data.hit_nul)
1746 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1747
1748 return printed;
1749}
1750
1751static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1752{
1753 if (len > 0 && len < spacing)
1754 return fprintf(fp, "%*s", spacing - len, "");
1755
1756 return 0;
1757}
1758
1759static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1760{
1761 return perf_sample__fprintf_spacing(len, 34, fp);
1762}
1763
1764/* If a value contains only printable ASCII characters padded with NULLs */
1765static bool ptw_is_prt(u64 val)
1766{
1767 char c;
1768 u32 i;
1769
1770 for (i = 0; i < sizeof(val); i++) {
1771 c = ((char *)&val)[i];
1772 if (!c)
1773 break;
1774 if (!isprint(c) || !isascii(c))
1775 return false;
1776 }
1777 for (; i < sizeof(val); i++) {
1778 c = ((char *)&val)[i];
1779 if (c)
1780 return false;
1781 }
1782 return true;
1783}
1784
1785static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1786{
1787 struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1788 char str[sizeof(u64) + 1] = "";
1789 int len;
1790 u64 val;
1791
1792 if (perf_sample__bad_synth_size(sample, *data))
1793 return 0;
1794
1795 val = le64_to_cpu(data->payload);
1796 if (ptw_is_prt(val)) {
1797 memcpy(str, &val, sizeof(val));
1798 str[sizeof(val)] = 0;
1799 }
1800 len = fprintf(fp, " IP: %u payload: %#" PRIx64 " %s ",
1801 data->ip, val, str);
1802 return len + perf_sample__fprintf_pt_spacing(len, fp);
1803}
1804
1805static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1806{
1807 struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1808 int len;
1809
1810 if (perf_sample__bad_synth_size(sample, *data))
1811 return 0;
1812
1813 len = fprintf(fp, " hints: %#x extensions: %#x ",
1814 data->hints, data->extensions);
1815 return len + perf_sample__fprintf_pt_spacing(len, fp);
1816}
1817
1818static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1819{
1820 struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1821 int len;
1822
1823 if (perf_sample__bad_synth_size(sample, *data))
1824 return 0;
1825
1826 len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1827 data->hw, data->cstate, data->subcstate);
1828 return len + perf_sample__fprintf_pt_spacing(len, fp);
1829}
1830
1831static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1832{
1833 struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1834 int len;
1835
1836 if (perf_sample__bad_synth_size(sample, *data))
1837 return 0;
1838
1839 len = fprintf(fp, " IP: %u ", data->ip);
1840 return len + perf_sample__fprintf_pt_spacing(len, fp);
1841}
1842
1843static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1844{
1845 struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1846 int len;
1847
1848 if (perf_sample__bad_synth_size(sample, *data))
1849 return 0;
1850
1851 len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1852 data->deepest_cstate, data->last_cstate,
1853 data->wake_reason);
1854 return len + perf_sample__fprintf_pt_spacing(len, fp);
1855}
1856
1857static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1858{
1859 struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1860 unsigned int percent, freq;
1861 int len;
1862
1863 if (perf_sample__bad_synth_size(sample, *data))
1864 return 0;
1865
1866 freq = (le32_to_cpu(data->freq) + 500) / 1000;
1867 len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1868 if (data->max_nonturbo) {
1869 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1870 len += fprintf(fp, "(%3u%%) ", percent);
1871 }
1872 return len + perf_sample__fprintf_pt_spacing(len, fp);
1873}
1874
1875static int perf_sample__fprintf_synth_psb(struct perf_sample *sample, FILE *fp)
1876{
1877 struct perf_synth_intel_psb *data = perf_sample__synth_ptr(sample);
1878 int len;
1879
1880 if (perf_sample__bad_synth_size(sample, *data))
1881 return 0;
1882
1883 len = fprintf(fp, " psb offs: %#" PRIx64, data->offset);
1884 return len + perf_sample__fprintf_pt_spacing(len, fp);
1885}
1886
1887/* Intel PT Event Trace */
1888static int perf_sample__fprintf_synth_evt(struct perf_sample *sample, FILE *fp)
1889{
1890 struct perf_synth_intel_evt *data = perf_sample__synth_ptr(sample);
1891 const char *cfe[32] = {NULL, "INTR", "IRET", "SMI", "RSM", "SIPI",
1892 "INIT", "VMENTRY", "VMEXIT", "VMEXIT_INTR",
1893 "SHUTDOWN"};
1894 const char *evd[64] = {"PFA", "VMXQ", "VMXR"};
1895 const char *s;
1896 int len, i;
1897
1898 if (perf_sample__bad_synth_size(sample, *data))
1899 return 0;
1900
1901 s = cfe[data->type];
1902 if (s) {
1903 len = fprintf(fp, " cfe: %s IP: %d vector: %u",
1904 s, data->ip, data->vector);
1905 } else {
1906 len = fprintf(fp, " cfe: %u IP: %d vector: %u",
1907 data->type, data->ip, data->vector);
1908 }
1909 for (i = 0; i < data->evd_cnt; i++) {
1910 unsigned int et = data->evd[i].evd_type & 0x3f;
1911
1912 s = evd[et];
1913 if (s) {
1914 len += fprintf(fp, " %s: %#" PRIx64,
1915 s, data->evd[i].payload);
1916 } else {
1917 len += fprintf(fp, " EVD_%u: %#" PRIx64,
1918 et, data->evd[i].payload);
1919 }
1920 }
1921 return len + perf_sample__fprintf_pt_spacing(len, fp);
1922}
1923
1924static int perf_sample__fprintf_synth_iflag_chg(struct perf_sample *sample, FILE *fp)
1925{
1926 struct perf_synth_intel_iflag_chg *data = perf_sample__synth_ptr(sample);
1927 int len;
1928
1929 if (perf_sample__bad_synth_size(sample, *data))
1930 return 0;
1931
1932 len = fprintf(fp, " IFLAG: %d->%d %s branch", !data->iflag, data->iflag,
1933 data->via_branch ? "via" : "non");
1934 return len + perf_sample__fprintf_pt_spacing(len, fp);
1935}
1936
1937static int perf_sample__fprintf_synth(struct perf_sample *sample,
1938 struct evsel *evsel, FILE *fp)
1939{
1940 switch (evsel->core.attr.config) {
1941 case PERF_SYNTH_INTEL_PTWRITE:
1942 return perf_sample__fprintf_synth_ptwrite(sample, fp);
1943 case PERF_SYNTH_INTEL_MWAIT:
1944 return perf_sample__fprintf_synth_mwait(sample, fp);
1945 case PERF_SYNTH_INTEL_PWRE:
1946 return perf_sample__fprintf_synth_pwre(sample, fp);
1947 case PERF_SYNTH_INTEL_EXSTOP:
1948 return perf_sample__fprintf_synth_exstop(sample, fp);
1949 case PERF_SYNTH_INTEL_PWRX:
1950 return perf_sample__fprintf_synth_pwrx(sample, fp);
1951 case PERF_SYNTH_INTEL_CBR:
1952 return perf_sample__fprintf_synth_cbr(sample, fp);
1953 case PERF_SYNTH_INTEL_PSB:
1954 return perf_sample__fprintf_synth_psb(sample, fp);
1955 case PERF_SYNTH_INTEL_EVT:
1956 return perf_sample__fprintf_synth_evt(sample, fp);
1957 case PERF_SYNTH_INTEL_IFLAG_CHG:
1958 return perf_sample__fprintf_synth_iflag_chg(sample, fp);
1959 default:
1960 break;
1961 }
1962
1963 return 0;
1964}
1965
1966static int evlist__max_name_len(struct evlist *evlist)
1967{
1968 struct evsel *evsel;
1969 int max = 0;
1970
1971 evlist__for_each_entry(evlist, evsel) {
1972 int len = strlen(evsel__name(evsel));
1973
1974 max = MAX(len, max);
1975 }
1976
1977 return max;
1978}
1979
1980static int data_src__fprintf(u64 data_src, FILE *fp)
1981{
1982 struct mem_info mi = { .data_src.val = data_src };
1983 char decode[100];
1984 char out[100];
1985 static int maxlen;
1986 int len;
1987
1988 perf_script__meminfo_scnprintf(decode, 100, &mi);
1989
1990 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
1991 if (maxlen < len)
1992 maxlen = len;
1993
1994 return fprintf(fp, "%-*s", maxlen, out);
1995}
1996
1997struct metric_ctx {
1998 struct perf_sample *sample;
1999 struct thread *thread;
2000 struct evsel *evsel;
2001 FILE *fp;
2002};
2003
2004static void script_print_metric(struct perf_stat_config *config __maybe_unused,
2005 void *ctx, const char *color,
2006 const char *fmt,
2007 const char *unit, double val)
2008{
2009 struct metric_ctx *mctx = ctx;
2010
2011 if (!fmt)
2012 return;
2013 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
2014 PERF_RECORD_SAMPLE, mctx->fp);
2015 fputs("\tmetric: ", mctx->fp);
2016 if (color)
2017 color_fprintf(mctx->fp, color, fmt, val);
2018 else
2019 printf(fmt, val);
2020 fprintf(mctx->fp, " %s\n", unit);
2021}
2022
2023static void script_new_line(struct perf_stat_config *config __maybe_unused,
2024 void *ctx)
2025{
2026 struct metric_ctx *mctx = ctx;
2027
2028 perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
2029 PERF_RECORD_SAMPLE, mctx->fp);
2030 fputs("\tmetric: ", mctx->fp);
2031}
2032
2033static void perf_sample__fprint_metric(struct perf_script *script,
2034 struct thread *thread,
2035 struct evsel *evsel,
2036 struct perf_sample *sample,
2037 FILE *fp)
2038{
2039 struct evsel *leader = evsel__leader(evsel);
2040 struct perf_stat_output_ctx ctx = {
2041 .print_metric = script_print_metric,
2042 .new_line = script_new_line,
2043 .ctx = &(struct metric_ctx) {
2044 .sample = sample,
2045 .thread = thread,
2046 .evsel = evsel,
2047 .fp = fp,
2048 },
2049 .force_header = false,
2050 };
2051 struct evsel *ev2;
2052 u64 val;
2053
2054 if (!evsel->stats)
2055 evlist__alloc_stats(&stat_config, script->session->evlist, /*alloc_raw=*/false);
2056 if (evsel_script(leader)->gnum++ == 0)
2057 perf_stat__reset_shadow_stats();
2058 val = sample->period * evsel->scale;
2059 perf_stat__update_shadow_stats(evsel,
2060 val,
2061 sample->cpu,
2062 &rt_stat);
2063 evsel_script(evsel)->val = val;
2064 if (evsel_script(leader)->gnum == leader->core.nr_members) {
2065 for_each_group_member (ev2, leader) {
2066 perf_stat__print_shadow_stats(&stat_config, ev2,
2067 evsel_script(ev2)->val,
2068 sample->cpu,
2069 &ctx,
2070 NULL,
2071 &rt_stat);
2072 }
2073 evsel_script(leader)->gnum = 0;
2074 }
2075}
2076
2077static bool show_event(struct perf_sample *sample,
2078 struct evsel *evsel,
2079 struct thread *thread,
2080 struct addr_location *al,
2081 struct addr_location *addr_al)
2082{
2083 int depth = thread_stack__depth(thread, sample->cpu);
2084
2085 if (!symbol_conf.graph_function)
2086 return true;
2087
2088 if (thread->filter) {
2089 if (depth <= thread->filter_entry_depth) {
2090 thread->filter = false;
2091 return false;
2092 }
2093 return true;
2094 } else {
2095 const char *s = symbol_conf.graph_function;
2096 u64 ip;
2097 const char *name = resolve_branch_sym(sample, evsel, thread, al, addr_al,
2098 &ip);
2099 unsigned nlen;
2100
2101 if (!name)
2102 return false;
2103 nlen = strlen(name);
2104 while (*s) {
2105 unsigned len = strcspn(s, ",");
2106 if (nlen == len && !strncmp(name, s, len)) {
2107 thread->filter = true;
2108 thread->filter_entry_depth = depth;
2109 return true;
2110 }
2111 s += len;
2112 if (*s == ',')
2113 s++;
2114 }
2115 return false;
2116 }
2117}
2118
2119static void process_event(struct perf_script *script,
2120 struct perf_sample *sample, struct evsel *evsel,
2121 struct addr_location *al,
2122 struct addr_location *addr_al,
2123 struct machine *machine)
2124{
2125 struct thread *thread = al->thread;
2126 struct perf_event_attr *attr = &evsel->core.attr;
2127 unsigned int type = output_type(attr->type);
2128 struct evsel_script *es = evsel->priv;
2129 FILE *fp = es->fp;
2130 char str[PAGE_SIZE_NAME_LEN];
2131 const char *arch = perf_env__arch(machine->env);
2132
2133 if (output[type].fields == 0)
2134 return;
2135
2136 ++es->samples;
2137
2138 perf_sample__fprintf_start(script, sample, thread, evsel,
2139 PERF_RECORD_SAMPLE, fp);
2140
2141 if (PRINT_FIELD(PERIOD))
2142 fprintf(fp, "%10" PRIu64 " ", sample->period);
2143
2144 if (PRINT_FIELD(EVNAME)) {
2145 const char *evname = evsel__name(evsel);
2146
2147 if (!script->name_width)
2148 script->name_width = evlist__max_name_len(script->session->evlist);
2149
2150 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
2151 }
2152
2153 if (print_flags)
2154 perf_sample__fprintf_flags(sample->flags, fp);
2155
2156 if (is_bts_event(attr)) {
2157 perf_sample__fprintf_bts(sample, evsel, thread, al, addr_al, machine, fp);
2158 return;
2159 }
2160#ifdef HAVE_LIBTRACEEVENT
2161 if (PRINT_FIELD(TRACE) && sample->raw_data) {
2162 event_format__fprintf(evsel->tp_format, sample->cpu,
2163 sample->raw_data, sample->raw_size, fp);
2164 }
2165#endif
2166 if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
2167 perf_sample__fprintf_synth(sample, evsel, fp);
2168
2169 if (PRINT_FIELD(ADDR))
2170 perf_sample__fprintf_addr(sample, thread, attr, fp);
2171
2172 if (PRINT_FIELD(DATA_SRC))
2173 data_src__fprintf(sample->data_src, fp);
2174
2175 if (PRINT_FIELD(WEIGHT))
2176 fprintf(fp, "%16" PRIu64, sample->weight);
2177
2178 if (PRINT_FIELD(INS_LAT))
2179 fprintf(fp, "%16" PRIu16, sample->ins_lat);
2180
2181 if (PRINT_FIELD(IP)) {
2182 struct callchain_cursor *cursor = NULL;
2183
2184 if (script->stitch_lbr)
2185 al->thread->lbr_stitch_enable = true;
2186
2187 if (symbol_conf.use_callchain && sample->callchain &&
2188 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
2189 sample, NULL, NULL, scripting_max_stack) == 0)
2190 cursor = &callchain_cursor;
2191
2192 fputc(cursor ? '\n' : ' ', fp);
2193 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
2194 symbol_conf.bt_stop_list, fp);
2195 }
2196
2197 if (PRINT_FIELD(IREGS))
2198 perf_sample__fprintf_iregs(sample, attr, arch, fp);
2199
2200 if (PRINT_FIELD(UREGS))
2201 perf_sample__fprintf_uregs(sample, attr, arch, fp);
2202
2203 if (PRINT_FIELD(BRSTACK))
2204 perf_sample__fprintf_brstack(sample, thread, attr, fp);
2205 else if (PRINT_FIELD(BRSTACKSYM))
2206 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2207 else if (PRINT_FIELD(BRSTACKOFF))
2208 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2209
2210 if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2211 perf_sample__fprintf_bpf_output(sample, fp);
2212 perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2213
2214 if (PRINT_FIELD(PHYS_ADDR))
2215 fprintf(fp, "%16" PRIx64, sample->phys_addr);
2216
2217 if (PRINT_FIELD(DATA_PAGE_SIZE))
2218 fprintf(fp, " %s", get_page_size_name(sample->data_page_size, str));
2219
2220 if (PRINT_FIELD(CODE_PAGE_SIZE))
2221 fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));
2222
2223 perf_sample__fprintf_ipc(sample, attr, fp);
2224
2225 fprintf(fp, "\n");
2226
2227 if (PRINT_FIELD(SRCCODE)) {
2228 if (map__fprintf_srccode(al->map, al->addr, stdout,
2229 &thread->srccode_state))
2230 printf("\n");
2231 }
2232
2233 if (PRINT_FIELD(METRIC))
2234 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2235
2236 if (verbose > 0)
2237 fflush(fp);
2238}
2239
2240static struct scripting_ops *scripting_ops;
2241
2242static void __process_stat(struct evsel *counter, u64 tstamp)
2243{
2244 int nthreads = perf_thread_map__nr(counter->core.threads);
2245 int idx, thread;
2246 struct perf_cpu cpu;
2247 static int header_printed;
2248
2249 if (!header_printed) {
2250 printf("%3s %8s %15s %15s %15s %15s %s\n",
2251 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
2252 header_printed = 1;
2253 }
2254
2255 for (thread = 0; thread < nthreads; thread++) {
2256 perf_cpu_map__for_each_cpu(cpu, idx, evsel__cpus(counter)) {
2257 struct perf_counts_values *counts;
2258
2259 counts = perf_counts(counter->counts, idx, thread);
2260
2261 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2262 cpu.cpu,
2263 perf_thread_map__pid(counter->core.threads, thread),
2264 counts->val,
2265 counts->ena,
2266 counts->run,
2267 tstamp,
2268 evsel__name(counter));
2269 }
2270 }
2271}
2272
2273static void process_stat(struct evsel *counter, u64 tstamp)
2274{
2275 if (scripting_ops && scripting_ops->process_stat)
2276 scripting_ops->process_stat(&stat_config, counter, tstamp);
2277 else
2278 __process_stat(counter, tstamp);
2279}
2280
2281static void process_stat_interval(u64 tstamp)
2282{
2283 if (scripting_ops && scripting_ops->process_stat_interval)
2284 scripting_ops->process_stat_interval(tstamp);
2285}
2286
2287static void setup_scripting(void)
2288{
2289#ifdef HAVE_LIBTRACEEVENT
2290 setup_perl_scripting();
2291 setup_python_scripting();
2292#endif
2293}
2294
2295static int flush_scripting(void)
2296{
2297 return scripting_ops ? scripting_ops->flush_script() : 0;
2298}
2299
2300static int cleanup_scripting(void)
2301{
2302 pr_debug("\nperf script stopped\n");
2303
2304 return scripting_ops ? scripting_ops->stop_script() : 0;
2305}
2306
2307static bool filter_cpu(struct perf_sample *sample)
2308{
2309 if (cpu_list && sample->cpu != (u32)-1)
2310 return !test_bit(sample->cpu, cpu_bitmap);
2311 return false;
2312}
2313
2314static int process_sample_event(struct perf_tool *tool,
2315 union perf_event *event,
2316 struct perf_sample *sample,
2317 struct evsel *evsel,
2318 struct machine *machine)
2319{
2320 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2321 struct addr_location al;
2322 struct addr_location addr_al;
2323 int ret = 0;
2324
2325 /* Set thread to NULL to indicate addr_al and al are not initialized */
2326 addr_al.thread = NULL;
2327 al.thread = NULL;
2328
2329 ret = dlfilter__filter_event_early(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2330 if (ret) {
2331 if (ret > 0)
2332 ret = 0;
2333 goto out_put;
2334 }
2335
2336 if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2337 sample->time)) {
2338 goto out_put;
2339 }
2340
2341 if (debug_mode) {
2342 if (sample->time < last_timestamp) {
2343 pr_err("Samples misordered, previous: %" PRIu64
2344 " this: %" PRIu64 "\n", last_timestamp,
2345 sample->time);
2346 nr_unordered++;
2347 }
2348 last_timestamp = sample->time;
2349 goto out_put;
2350 }
2351
2352 if (filter_cpu(sample))
2353 goto out_put;
2354
2355 if (!al.thread && machine__resolve(machine, &al, sample) < 0) {
2356 pr_err("problem processing %d event, skipping it.\n",
2357 event->header.type);
2358 ret = -1;
2359 goto out_put;
2360 }
2361
2362 if (al.filtered)
2363 goto out_put;
2364
2365 if (!show_event(sample, evsel, al.thread, &al, &addr_al))
2366 goto out_put;
2367
2368 if (evswitch__discard(&scr->evswitch, evsel))
2369 goto out_put;
2370
2371 ret = dlfilter__filter_event(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2372 if (ret) {
2373 if (ret > 0)
2374 ret = 0;
2375 goto out_put;
2376 }
2377
2378 if (scripting_ops) {
2379 struct addr_location *addr_al_ptr = NULL;
2380
2381 if ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
2382 sample_addr_correlates_sym(&evsel->core.attr)) {
2383 if (!addr_al.thread)
2384 thread__resolve(al.thread, &addr_al, sample);
2385 addr_al_ptr = &addr_al;
2386 }
2387 scripting_ops->process_event(event, sample, evsel, &al, addr_al_ptr);
2388 } else {
2389 process_event(scr, sample, evsel, &al, &addr_al, machine);
2390 }
2391
2392out_put:
2393 if (al.thread)
2394 addr_location__put(&al);
2395 return ret;
2396}
2397
2398static int process_attr(struct perf_tool *tool, union perf_event *event,
2399 struct evlist **pevlist)
2400{
2401 struct perf_script *scr = container_of(tool, struct perf_script, tool);
2402 struct evlist *evlist;
2403 struct evsel *evsel, *pos;
2404 u64 sample_type;
2405 int err;
2406 static struct evsel_script *es;
2407
2408 err = perf_event__process_attr(tool, event, pevlist);
2409 if (err)
2410 return err;
2411
2412 evlist = *pevlist;
2413 evsel = evlist__last(*pevlist);
2414
2415 if (!evsel->priv) {
2416 if (scr->per_event_dump) {
2417 evsel->priv = evsel_script__new(evsel, scr->session->data);
2418 } else {
2419 es = zalloc(sizeof(*es));
2420 if (!es)
2421 return -ENOMEM;
2422 es->fp = stdout;
2423 evsel->priv = es;
2424 }
2425 }
2426
2427 if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2428 evsel->core.attr.type != PERF_TYPE_SYNTH)
2429 return 0;
2430
2431 evlist__for_each_entry(evlist, pos) {
2432 if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2433 return 0;
2434 }
2435
2436 if (evsel->core.attr.sample_type) {
2437 err = evsel__check_attr(evsel, scr->session);
2438 if (err)
2439 return err;
2440 }
2441
2442 /*
2443 * Check if we need to enable callchains based
2444 * on events sample_type.
2445 */
2446 sample_type = evlist__combined_sample_type(evlist);
2447 callchain_param_setup(sample_type, perf_env__arch((*pevlist)->env));
2448
2449 /* Enable fields for callchain entries */
2450 if (symbol_conf.use_callchain &&
2451 (sample_type & PERF_SAMPLE_CALLCHAIN ||
2452 sample_type & PERF_SAMPLE_BRANCH_STACK ||
2453 (sample_type & PERF_SAMPLE_REGS_USER &&
2454 sample_type & PERF_SAMPLE_STACK_USER))) {
2455 int type = output_type(evsel->core.attr.type);
2456
2457 if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
2458 output[type].fields |= PERF_OUTPUT_IP;
2459 if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
2460 output[type].fields |= PERF_OUTPUT_SYM;
2461 }
2462 set_print_ip_opts(&evsel->core.attr);
2463 return 0;
2464}
2465
2466static int print_event_with_time(struct perf_tool *tool,
2467 union perf_event *event,
2468 struct perf_sample *sample,
2469 struct machine *machine,
2470 pid_t pid, pid_t tid, u64 timestamp)
2471{
2472 struct perf_script *script = container_of(tool, struct perf_script, tool);
2473 struct perf_session *session = script->session;
2474 struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2475 struct thread *thread = NULL;
2476
2477 if (evsel && !evsel->core.attr.sample_id_all) {
2478 sample->cpu = 0;
2479 sample->time = timestamp;
2480 sample->pid = pid;
2481 sample->tid = tid;
2482 }
2483
2484 if (filter_cpu(sample))
2485 return 0;
2486
2487 if (tid != -1)
2488 thread = machine__findnew_thread(machine, pid, tid);
2489
2490 if (evsel) {
2491 perf_sample__fprintf_start(script, sample, thread, evsel,
2492 event->header.type, stdout);
2493 }
2494
2495 perf_event__fprintf(event, machine, stdout);
2496
2497 thread__put(thread);
2498
2499 return 0;
2500}
2501
2502static int print_event(struct perf_tool *tool, union perf_event *event,
2503 struct perf_sample *sample, struct machine *machine,
2504 pid_t pid, pid_t tid)
2505{
2506 return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2507}
2508
2509static int process_comm_event(struct perf_tool *tool,
2510 union perf_event *event,
2511 struct perf_sample *sample,
2512 struct machine *machine)
2513{
2514 if (perf_event__process_comm(tool, event, sample, machine) < 0)
2515 return -1;
2516
2517 return print_event(tool, event, sample, machine, event->comm.pid,
2518 event->comm.tid);
2519}
2520
2521static int process_namespaces_event(struct perf_tool *tool,
2522 union perf_event *event,
2523 struct perf_sample *sample,
2524 struct machine *machine)
2525{
2526 if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2527 return -1;
2528
2529 return print_event(tool, event, sample, machine, event->namespaces.pid,
2530 event->namespaces.tid);
2531}
2532
2533static int process_cgroup_event(struct perf_tool *tool,
2534 union perf_event *event,
2535 struct perf_sample *sample,
2536 struct machine *machine)
2537{
2538 if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2539 return -1;
2540
2541 return print_event(tool, event, sample, machine, sample->pid,
2542 sample->tid);
2543}
2544
2545static int process_fork_event(struct perf_tool *tool,
2546 union perf_event *event,
2547 struct perf_sample *sample,
2548 struct machine *machine)
2549{
2550 if (perf_event__process_fork(tool, event, sample, machine) < 0)
2551 return -1;
2552
2553 return print_event_with_time(tool, event, sample, machine,
2554 event->fork.pid, event->fork.tid,
2555 event->fork.time);
2556}
2557static int process_exit_event(struct perf_tool *tool,
2558 union perf_event *event,
2559 struct perf_sample *sample,
2560 struct machine *machine)
2561{
2562 /* Print before 'exit' deletes anything */
2563 if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2564 event->fork.tid, event->fork.time))
2565 return -1;
2566
2567 return perf_event__process_exit(tool, event, sample, machine);
2568}
2569
2570static int process_mmap_event(struct perf_tool *tool,
2571 union perf_event *event,
2572 struct perf_sample *sample,
2573 struct machine *machine)
2574{
2575 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2576 return -1;
2577
2578 return print_event(tool, event, sample, machine, event->mmap.pid,
2579 event->mmap.tid);
2580}
2581
2582static int process_mmap2_event(struct perf_tool *tool,
2583 union perf_event *event,
2584 struct perf_sample *sample,
2585 struct machine *machine)
2586{
2587 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2588 return -1;
2589
2590 return print_event(tool, event, sample, machine, event->mmap2.pid,
2591 event->mmap2.tid);
2592}
2593
2594static int process_switch_event(struct perf_tool *tool,
2595 union perf_event *event,
2596 struct perf_sample *sample,
2597 struct machine *machine)
2598{
2599 struct perf_script *script = container_of(tool, struct perf_script, tool);
2600
2601 if (perf_event__process_switch(tool, event, sample, machine) < 0)
2602 return -1;
2603
2604 if (scripting_ops && scripting_ops->process_switch && !filter_cpu(sample))
2605 scripting_ops->process_switch(event, sample, machine);
2606
2607 if (!script->show_switch_events)
2608 return 0;
2609
2610 return print_event(tool, event, sample, machine, sample->pid,
2611 sample->tid);
2612}
2613
2614static int process_auxtrace_error(struct perf_session *session,
2615 union perf_event *event)
2616{
2617 if (scripting_ops && scripting_ops->process_auxtrace_error) {
2618 scripting_ops->process_auxtrace_error(session, event);
2619 return 0;
2620 }
2621
2622 return perf_event__process_auxtrace_error(session, event);
2623}
2624
2625static int
2626process_lost_event(struct perf_tool *tool,
2627 union perf_event *event,
2628 struct perf_sample *sample,
2629 struct machine *machine)
2630{
2631 return print_event(tool, event, sample, machine, sample->pid,
2632 sample->tid);
2633}
2634
2635static int
2636process_throttle_event(struct perf_tool *tool __maybe_unused,
2637 union perf_event *event,
2638 struct perf_sample *sample,
2639 struct machine *machine)
2640{
2641 if (scripting_ops && scripting_ops->process_throttle)
2642 scripting_ops->process_throttle(event, sample, machine);
2643 return 0;
2644}
2645
2646static int
2647process_finished_round_event(struct perf_tool *tool __maybe_unused,
2648 union perf_event *event,
2649 struct ordered_events *oe __maybe_unused)
2650
2651{
2652 perf_event__fprintf(event, NULL, stdout);
2653 return 0;
2654}
2655
2656static int
2657process_bpf_events(struct perf_tool *tool __maybe_unused,
2658 union perf_event *event,
2659 struct perf_sample *sample,
2660 struct machine *machine)
2661{
2662 if (machine__process_ksymbol(machine, event, sample) < 0)
2663 return -1;
2664
2665 return print_event(tool, event, sample, machine, sample->pid,
2666 sample->tid);
2667}
2668
2669static int process_text_poke_events(struct perf_tool *tool,
2670 union perf_event *event,
2671 struct perf_sample *sample,
2672 struct machine *machine)
2673{
2674 if (perf_event__process_text_poke(tool, event, sample, machine) < 0)
2675 return -1;
2676
2677 return print_event(tool, event, sample, machine, sample->pid,
2678 sample->tid);
2679}
2680
2681static void sig_handler(int sig __maybe_unused)
2682{
2683 session_done = 1;
2684}
2685
2686static void perf_script__fclose_per_event_dump(struct perf_script *script)
2687{
2688 struct evlist *evlist = script->session->evlist;
2689 struct evsel *evsel;
2690
2691 evlist__for_each_entry(evlist, evsel) {
2692 if (!evsel->priv)
2693 break;
2694 evsel_script__delete(evsel->priv);
2695 evsel->priv = NULL;
2696 }
2697}
2698
2699static int perf_script__fopen_per_event_dump(struct perf_script *script)
2700{
2701 struct evsel *evsel;
2702
2703 evlist__for_each_entry(script->session->evlist, evsel) {
2704 /*
2705 * Already setup? I.e. we may be called twice in cases like
2706 * Intel PT, one for the intel_pt// and dummy events, then
2707 * for the evsels synthesized from the auxtrace info.
2708 *
2709 * Ses perf_script__process_auxtrace_info.
2710 */
2711 if (evsel->priv != NULL)
2712 continue;
2713
2714 evsel->priv = evsel_script__new(evsel, script->session->data);
2715 if (evsel->priv == NULL)
2716 goto out_err_fclose;
2717 }
2718
2719 return 0;
2720
2721out_err_fclose:
2722 perf_script__fclose_per_event_dump(script);
2723 return -1;
2724}
2725
2726static int perf_script__setup_per_event_dump(struct perf_script *script)
2727{
2728 struct evsel *evsel;
2729 static struct evsel_script es_stdout;
2730
2731 if (script->per_event_dump)
2732 return perf_script__fopen_per_event_dump(script);
2733
2734 es_stdout.fp = stdout;
2735
2736 evlist__for_each_entry(script->session->evlist, evsel)
2737 evsel->priv = &es_stdout;
2738
2739 return 0;
2740}
2741
2742static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2743{
2744 struct evsel *evsel;
2745
2746 evlist__for_each_entry(script->session->evlist, evsel) {
2747 struct evsel_script *es = evsel->priv;
2748
2749 evsel_script__fprintf(es, stdout);
2750 evsel_script__delete(es);
2751 evsel->priv = NULL;
2752 }
2753}
2754
2755static void perf_script__exit(struct perf_script *script)
2756{
2757 perf_thread_map__put(script->threads);
2758 perf_cpu_map__put(script->cpus);
2759}
2760
2761static int __cmd_script(struct perf_script *script)
2762{
2763 int ret;
2764
2765 signal(SIGINT, sig_handler);
2766
2767 perf_stat__init_shadow_stats();
2768
2769 /* override event processing functions */
2770 if (script->show_task_events) {
2771 script->tool.comm = process_comm_event;
2772 script->tool.fork = process_fork_event;
2773 script->tool.exit = process_exit_event;
2774 }
2775 if (script->show_mmap_events) {
2776 script->tool.mmap = process_mmap_event;
2777 script->tool.mmap2 = process_mmap2_event;
2778 }
2779 if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2780 script->tool.context_switch = process_switch_event;
2781 if (scripting_ops && scripting_ops->process_auxtrace_error)
2782 script->tool.auxtrace_error = process_auxtrace_error;
2783 if (script->show_namespace_events)
2784 script->tool.namespaces = process_namespaces_event;
2785 if (script->show_cgroup_events)
2786 script->tool.cgroup = process_cgroup_event;
2787 if (script->show_lost_events)
2788 script->tool.lost = process_lost_event;
2789 if (script->show_round_events) {
2790 script->tool.ordered_events = false;
2791 script->tool.finished_round = process_finished_round_event;
2792 }
2793 if (script->show_bpf_events) {
2794 script->tool.ksymbol = process_bpf_events;
2795 script->tool.bpf = process_bpf_events;
2796 }
2797 if (script->show_text_poke_events) {
2798 script->tool.ksymbol = process_bpf_events;
2799 script->tool.text_poke = process_text_poke_events;
2800 }
2801
2802 if (perf_script__setup_per_event_dump(script)) {
2803 pr_err("Couldn't create the per event dump files\n");
2804 return -1;
2805 }
2806
2807 ret = perf_session__process_events(script->session);
2808
2809 if (script->per_event_dump)
2810 perf_script__exit_per_event_dump_stats(script);
2811
2812 if (debug_mode)
2813 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2814
2815 return ret;
2816}
2817
2818struct script_spec {
2819 struct list_head node;
2820 struct scripting_ops *ops;
2821 char spec[];
2822};
2823
2824static LIST_HEAD(script_specs);
2825
2826static struct script_spec *script_spec__new(const char *spec,
2827 struct scripting_ops *ops)
2828{
2829 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2830
2831 if (s != NULL) {
2832 strcpy(s->spec, spec);
2833 s->ops = ops;
2834 }
2835
2836 return s;
2837}
2838
2839static void script_spec__add(struct script_spec *s)
2840{
2841 list_add_tail(&s->node, &script_specs);
2842}
2843
2844static struct script_spec *script_spec__find(const char *spec)
2845{
2846 struct script_spec *s;
2847
2848 list_for_each_entry(s, &script_specs, node)
2849 if (strcasecmp(s->spec, spec) == 0)
2850 return s;
2851 return NULL;
2852}
2853
2854int script_spec_register(const char *spec, struct scripting_ops *ops)
2855{
2856 struct script_spec *s;
2857
2858 s = script_spec__find(spec);
2859 if (s)
2860 return -1;
2861
2862 s = script_spec__new(spec, ops);
2863 if (!s)
2864 return -1;
2865 else
2866 script_spec__add(s);
2867
2868 return 0;
2869}
2870
2871static struct scripting_ops *script_spec__lookup(const char *spec)
2872{
2873 struct script_spec *s = script_spec__find(spec);
2874 if (!s)
2875 return NULL;
2876
2877 return s->ops;
2878}
2879
2880static void list_available_languages(void)
2881{
2882 struct script_spec *s;
2883
2884 fprintf(stderr, "\n");
2885 fprintf(stderr, "Scripting language extensions (used in "
2886 "perf script -s [spec:]script.[spec]):\n\n");
2887
2888 list_for_each_entry(s, &script_specs, node)
2889 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
2890
2891 fprintf(stderr, "\n");
2892}
2893
2894/* Find script file relative to current directory or exec path */
2895static char *find_script(const char *script)
2896{
2897 char path[PATH_MAX];
2898
2899 if (!scripting_ops) {
2900 const char *ext = strrchr(script, '.');
2901
2902 if (!ext)
2903 return NULL;
2904
2905 scripting_ops = script_spec__lookup(++ext);
2906 if (!scripting_ops)
2907 return NULL;
2908 }
2909
2910 if (access(script, R_OK)) {
2911 char *exec_path = get_argv_exec_path();
2912
2913 if (!exec_path)
2914 return NULL;
2915 snprintf(path, sizeof(path), "%s/scripts/%s/%s",
2916 exec_path, scripting_ops->dirname, script);
2917 free(exec_path);
2918 script = path;
2919 if (access(script, R_OK))
2920 return NULL;
2921 }
2922 return strdup(script);
2923}
2924
2925static int parse_scriptname(const struct option *opt __maybe_unused,
2926 const char *str, int unset __maybe_unused)
2927{
2928 char spec[PATH_MAX];
2929 const char *script, *ext;
2930 int len;
2931
2932 if (strcmp(str, "lang") == 0) {
2933 list_available_languages();
2934 exit(0);
2935 }
2936
2937 script = strchr(str, ':');
2938 if (script) {
2939 len = script - str;
2940 if (len >= PATH_MAX) {
2941 fprintf(stderr, "invalid language specifier");
2942 return -1;
2943 }
2944 strncpy(spec, str, len);
2945 spec[len] = '\0';
2946 scripting_ops = script_spec__lookup(spec);
2947 if (!scripting_ops) {
2948 fprintf(stderr, "invalid language specifier");
2949 return -1;
2950 }
2951 script++;
2952 } else {
2953 script = str;
2954 ext = strrchr(script, '.');
2955 if (!ext) {
2956 fprintf(stderr, "invalid script extension");
2957 return -1;
2958 }
2959 scripting_ops = script_spec__lookup(++ext);
2960 if (!scripting_ops) {
2961 fprintf(stderr, "invalid script extension");
2962 return -1;
2963 }
2964 }
2965
2966 script_name = find_script(script);
2967 if (!script_name)
2968 script_name = strdup(script);
2969
2970 return 0;
2971}
2972
2973static int parse_output_fields(const struct option *opt __maybe_unused,
2974 const char *arg, int unset __maybe_unused)
2975{
2976 char *tok, *strtok_saveptr = NULL;
2977 int i, imax = ARRAY_SIZE(all_output_options);
2978 int j;
2979 int rc = 0;
2980 char *str = strdup(arg);
2981 int type = -1;
2982 enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2983
2984 if (!str)
2985 return -ENOMEM;
2986
2987 /* first word can state for which event type the user is specifying
2988 * the fields. If no type exists, the specified fields apply to all
2989 * event types found in the file minus the invalid fields for a type.
2990 */
2991 tok = strchr(str, ':');
2992 if (tok) {
2993 *tok = '\0';
2994 tok++;
2995 if (!strcmp(str, "hw"))
2996 type = PERF_TYPE_HARDWARE;
2997 else if (!strcmp(str, "sw"))
2998 type = PERF_TYPE_SOFTWARE;
2999 else if (!strcmp(str, "trace"))
3000 type = PERF_TYPE_TRACEPOINT;
3001 else if (!strcmp(str, "raw"))
3002 type = PERF_TYPE_RAW;
3003 else if (!strcmp(str, "break"))
3004 type = PERF_TYPE_BREAKPOINT;
3005 else if (!strcmp(str, "synth"))
3006 type = OUTPUT_TYPE_SYNTH;
3007 else {
3008 fprintf(stderr, "Invalid event type in field string.\n");
3009 rc = -EINVAL;
3010 goto out;
3011 }
3012
3013 if (output[type].user_set)
3014 pr_warning("Overriding previous field request for %s events.\n",
3015 event_type(type));
3016
3017 /* Don't override defaults for +- */
3018 if (strchr(tok, '+') || strchr(tok, '-'))
3019 goto parse;
3020
3021 output[type].fields = 0;
3022 output[type].user_set = true;
3023 output[type].wildcard_set = false;
3024
3025 } else {
3026 tok = str;
3027 if (strlen(str) == 0) {
3028 fprintf(stderr,
3029 "Cannot set fields to 'none' for all event types.\n");
3030 rc = -EINVAL;
3031 goto out;
3032 }
3033
3034 /* Don't override defaults for +- */
3035 if (strchr(str, '+') || strchr(str, '-'))
3036 goto parse;
3037
3038 if (output_set_by_user())
3039 pr_warning("Overriding previous field request for all events.\n");
3040
3041 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
3042 output[j].fields = 0;
3043 output[j].user_set = true;
3044 output[j].wildcard_set = true;
3045 }
3046 }
3047
3048parse:
3049 for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
3050 if (*tok == '+') {
3051 if (change == SET)
3052 goto out_badmix;
3053 change = ADD;
3054 tok++;
3055 } else if (*tok == '-') {
3056 if (change == SET)
3057 goto out_badmix;
3058 change = REMOVE;
3059 tok++;
3060 } else {
3061 if (change != SET && change != DEFAULT)
3062 goto out_badmix;
3063 change = SET;
3064 }
3065
3066 for (i = 0; i < imax; ++i) {
3067 if (strcmp(tok, all_output_options[i].str) == 0)
3068 break;
3069 }
3070 if (i == imax && strcmp(tok, "flags") == 0) {
3071 print_flags = change != REMOVE;
3072 continue;
3073 }
3074 if (i == imax) {
3075 fprintf(stderr, "Invalid field requested.\n");
3076 rc = -EINVAL;
3077 goto out;
3078 }
3079
3080 if (type == -1) {
3081 /* add user option to all events types for
3082 * which it is valid
3083 */
3084 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
3085 if (output[j].invalid_fields & all_output_options[i].field) {
3086 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
3087 all_output_options[i].str, event_type(j));
3088 } else {
3089 if (change == REMOVE) {
3090 output[j].fields &= ~all_output_options[i].field;
3091 output[j].user_set_fields &= ~all_output_options[i].field;
3092 output[j].user_unset_fields |= all_output_options[i].field;
3093 } else {
3094 output[j].fields |= all_output_options[i].field;
3095 output[j].user_set_fields |= all_output_options[i].field;
3096 output[j].user_unset_fields &= ~all_output_options[i].field;
3097 }
3098 output[j].user_set = true;
3099 output[j].wildcard_set = true;
3100 }
3101 }
3102 } else {
3103 if (output[type].invalid_fields & all_output_options[i].field) {
3104 fprintf(stderr, "\'%s\' not valid for %s events.\n",
3105 all_output_options[i].str, event_type(type));
3106
3107 rc = -EINVAL;
3108 goto out;
3109 }
3110 if (change == REMOVE)
3111 output[type].fields &= ~all_output_options[i].field;
3112 else
3113 output[type].fields |= all_output_options[i].field;
3114 output[type].user_set = true;
3115 output[type].wildcard_set = true;
3116 }
3117 }
3118
3119 if (type >= 0) {
3120 if (output[type].fields == 0) {
3121 pr_debug("No fields requested for %s type. "
3122 "Events will not be displayed.\n", event_type(type));
3123 }
3124 }
3125 goto out;
3126
3127out_badmix:
3128 fprintf(stderr, "Cannot mix +-field with overridden fields\n");
3129 rc = -EINVAL;
3130out:
3131 free(str);
3132 return rc;
3133}
3134
3135#define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
3136 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
3137 if ((lang_dirent->d_type == DT_DIR || \
3138 (lang_dirent->d_type == DT_UNKNOWN && \
3139 is_directory(scripts_path, lang_dirent))) && \
3140 (strcmp(lang_dirent->d_name, ".")) && \
3141 (strcmp(lang_dirent->d_name, "..")))
3142
3143#define for_each_script(lang_path, lang_dir, script_dirent) \
3144 while ((script_dirent = readdir(lang_dir)) != NULL) \
3145 if (script_dirent->d_type != DT_DIR && \
3146 (script_dirent->d_type != DT_UNKNOWN || \
3147 !is_directory(lang_path, script_dirent)))
3148
3149
3150#define RECORD_SUFFIX "-record"
3151#define REPORT_SUFFIX "-report"
3152
3153struct script_desc {
3154 struct list_head node;
3155 char *name;
3156 char *half_liner;
3157 char *args;
3158};
3159
3160static LIST_HEAD(script_descs);
3161
3162static struct script_desc *script_desc__new(const char *name)
3163{
3164 struct script_desc *s = zalloc(sizeof(*s));
3165
3166 if (s != NULL && name)
3167 s->name = strdup(name);
3168
3169 return s;
3170}
3171
3172static void script_desc__delete(struct script_desc *s)
3173{
3174 zfree(&s->name);
3175 zfree(&s->half_liner);
3176 zfree(&s->args);
3177 free(s);
3178}
3179
3180static void script_desc__add(struct script_desc *s)
3181{
3182 list_add_tail(&s->node, &script_descs);
3183}
3184
3185static struct script_desc *script_desc__find(const char *name)
3186{
3187 struct script_desc *s;
3188
3189 list_for_each_entry(s, &script_descs, node)
3190 if (strcasecmp(s->name, name) == 0)
3191 return s;
3192 return NULL;
3193}
3194
3195static struct script_desc *script_desc__findnew(const char *name)
3196{
3197 struct script_desc *s = script_desc__find(name);
3198
3199 if (s)
3200 return s;
3201
3202 s = script_desc__new(name);
3203 if (!s)
3204 return NULL;
3205
3206 script_desc__add(s);
3207
3208 return s;
3209}
3210
3211static const char *ends_with(const char *str, const char *suffix)
3212{
3213 size_t suffix_len = strlen(suffix);
3214 const char *p = str;
3215
3216 if (strlen(str) > suffix_len) {
3217 p = str + strlen(str) - suffix_len;
3218 if (!strncmp(p, suffix, suffix_len))
3219 return p;
3220 }
3221
3222 return NULL;
3223}
3224
3225static int read_script_info(struct script_desc *desc, const char *filename)
3226{
3227 char line[BUFSIZ], *p;
3228 FILE *fp;
3229
3230 fp = fopen(filename, "r");
3231 if (!fp)
3232 return -1;
3233
3234 while (fgets(line, sizeof(line), fp)) {
3235 p = skip_spaces(line);
3236 if (strlen(p) == 0)
3237 continue;
3238 if (*p != '#')
3239 continue;
3240 p++;
3241 if (strlen(p) && *p == '!')
3242 continue;
3243
3244 p = skip_spaces(p);
3245 if (strlen(p) && p[strlen(p) - 1] == '\n')
3246 p[strlen(p) - 1] = '\0';
3247
3248 if (!strncmp(p, "description:", strlen("description:"))) {
3249 p += strlen("description:");
3250 desc->half_liner = strdup(skip_spaces(p));
3251 continue;
3252 }
3253
3254 if (!strncmp(p, "args:", strlen("args:"))) {
3255 p += strlen("args:");
3256 desc->args = strdup(skip_spaces(p));
3257 continue;
3258 }
3259 }
3260
3261 fclose(fp);
3262
3263 return 0;
3264}
3265
3266static char *get_script_root(struct dirent *script_dirent, const char *suffix)
3267{
3268 char *script_root, *str;
3269
3270 script_root = strdup(script_dirent->d_name);
3271 if (!script_root)
3272 return NULL;
3273
3274 str = (char *)ends_with(script_root, suffix);
3275 if (!str) {
3276 free(script_root);
3277 return NULL;
3278 }
3279
3280 *str = '\0';
3281 return script_root;
3282}
3283
3284static int list_available_scripts(const struct option *opt __maybe_unused,
3285 const char *s __maybe_unused,
3286 int unset __maybe_unused)
3287{
3288 struct dirent *script_dirent, *lang_dirent;
3289 char scripts_path[MAXPATHLEN];
3290 DIR *scripts_dir, *lang_dir;
3291 char script_path[MAXPATHLEN];
3292 char lang_path[MAXPATHLEN];
3293 struct script_desc *desc;
3294 char first_half[BUFSIZ];
3295 char *script_root;
3296
3297 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3298
3299 scripts_dir = opendir(scripts_path);
3300 if (!scripts_dir) {
3301 fprintf(stdout,
3302 "open(%s) failed.\n"
3303 "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
3304 scripts_path);
3305 exit(-1);
3306 }
3307
3308 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3309 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3310 lang_dirent->d_name);
3311 lang_dir = opendir(lang_path);
3312 if (!lang_dir)
3313 continue;
3314
3315 for_each_script(lang_path, lang_dir, script_dirent) {
3316 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3317 if (script_root) {
3318 desc = script_desc__findnew(script_root);
3319 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3320 lang_path, script_dirent->d_name);
3321 read_script_info(desc, script_path);
3322 free(script_root);
3323 }
3324 }
3325 }
3326
3327 fprintf(stdout, "List of available trace scripts:\n");
3328 list_for_each_entry(desc, &script_descs, node) {
3329 sprintf(first_half, "%s %s", desc->name,
3330 desc->args ? desc->args : "");
3331 fprintf(stdout, " %-36s %s\n", first_half,
3332 desc->half_liner ? desc->half_liner : "");
3333 }
3334
3335 exit(0);
3336}
3337
3338static int add_dlarg(const struct option *opt __maybe_unused,
3339 const char *s, int unset __maybe_unused)
3340{
3341 char *arg = strdup(s);
3342 void *a;
3343
3344 if (!arg)
3345 return -1;
3346
3347 a = realloc(dlargv, sizeof(dlargv[0]) * (dlargc + 1));
3348 if (!a) {
3349 free(arg);
3350 return -1;
3351 }
3352
3353 dlargv = a;
3354 dlargv[dlargc++] = arg;
3355
3356 return 0;
3357}
3358
3359static void free_dlarg(void)
3360{
3361 while (dlargc--)
3362 free(dlargv[dlargc]);
3363 free(dlargv);
3364}
3365
3366/*
3367 * Some scripts specify the required events in their "xxx-record" file,
3368 * this function will check if the events in perf.data match those
3369 * mentioned in the "xxx-record".
3370 *
3371 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
3372 * which is covered well now. And new parsing code should be added to
3373 * cover the future complex formats like event groups etc.
3374 */
3375static int check_ev_match(char *dir_name, char *scriptname,
3376 struct perf_session *session)
3377{
3378 char filename[MAXPATHLEN], evname[128];
3379 char line[BUFSIZ], *p;
3380 struct evsel *pos;
3381 int match, len;
3382 FILE *fp;
3383
3384 scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3385
3386 fp = fopen(filename, "r");
3387 if (!fp)
3388 return -1;
3389
3390 while (fgets(line, sizeof(line), fp)) {
3391 p = skip_spaces(line);
3392 if (*p == '#')
3393 continue;
3394
3395 while (strlen(p)) {
3396 p = strstr(p, "-e");
3397 if (!p)
3398 break;
3399
3400 p += 2;
3401 p = skip_spaces(p);
3402 len = strcspn(p, " \t");
3403 if (!len)
3404 break;
3405
3406 snprintf(evname, len + 1, "%s", p);
3407
3408 match = 0;
3409 evlist__for_each_entry(session->evlist, pos) {
3410 if (!strcmp(evsel__name(pos), evname)) {
3411 match = 1;
3412 break;
3413 }
3414 }
3415
3416 if (!match) {
3417 fclose(fp);
3418 return -1;
3419 }
3420 }
3421 }
3422
3423 fclose(fp);
3424 return 0;
3425}
3426
3427/*
3428 * Return -1 if none is found, otherwise the actual scripts number.
3429 *
3430 * Currently the only user of this function is the script browser, which
3431 * will list all statically runnable scripts, select one, execute it and
3432 * show the output in a perf browser.
3433 */
3434int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3435 int pathlen)
3436{
3437 struct dirent *script_dirent, *lang_dirent;
3438 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3439 DIR *scripts_dir, *lang_dir;
3440 struct perf_session *session;
3441 struct perf_data data = {
3442 .path = input_name,
3443 .mode = PERF_DATA_MODE_READ,
3444 };
3445 char *temp;
3446 int i = 0;
3447
3448 session = perf_session__new(&data, NULL);
3449 if (IS_ERR(session))
3450 return PTR_ERR(session);
3451
3452 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3453
3454 scripts_dir = opendir(scripts_path);
3455 if (!scripts_dir) {
3456 perf_session__delete(session);
3457 return -1;
3458 }
3459
3460 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3461 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3462 lang_dirent->d_name);
3463#ifndef HAVE_LIBPERL_SUPPORT
3464 if (strstr(lang_path, "perl"))
3465 continue;
3466#endif
3467#ifndef HAVE_LIBPYTHON_SUPPORT
3468 if (strstr(lang_path, "python"))
3469 continue;
3470#endif
3471
3472 lang_dir = opendir(lang_path);
3473 if (!lang_dir)
3474 continue;
3475
3476 for_each_script(lang_path, lang_dir, script_dirent) {
3477 /* Skip those real time scripts: xxxtop.p[yl] */
3478 if (strstr(script_dirent->d_name, "top."))
3479 continue;
3480 if (i >= num)
3481 break;
3482 snprintf(scripts_path_array[i], pathlen, "%s/%s",
3483 lang_path,
3484 script_dirent->d_name);
3485 temp = strchr(script_dirent->d_name, '.');
3486 snprintf(scripts_array[i],
3487 (temp - script_dirent->d_name) + 1,
3488 "%s", script_dirent->d_name);
3489
3490 if (check_ev_match(lang_path,
3491 scripts_array[i], session))
3492 continue;
3493
3494 i++;
3495 }
3496 closedir(lang_dir);
3497 }
3498
3499 closedir(scripts_dir);
3500 perf_session__delete(session);
3501 return i;
3502}
3503
3504static char *get_script_path(const char *script_root, const char *suffix)
3505{
3506 struct dirent *script_dirent, *lang_dirent;
3507 char scripts_path[MAXPATHLEN];
3508 char script_path[MAXPATHLEN];
3509 DIR *scripts_dir, *lang_dir;
3510 char lang_path[MAXPATHLEN];
3511 char *__script_root;
3512
3513 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3514
3515 scripts_dir = opendir(scripts_path);
3516 if (!scripts_dir)
3517 return NULL;
3518
3519 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3520 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3521 lang_dirent->d_name);
3522 lang_dir = opendir(lang_path);
3523 if (!lang_dir)
3524 continue;
3525
3526 for_each_script(lang_path, lang_dir, script_dirent) {
3527 __script_root = get_script_root(script_dirent, suffix);
3528 if (__script_root && !strcmp(script_root, __script_root)) {
3529 free(__script_root);
3530 closedir(scripts_dir);
3531 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3532 lang_path, script_dirent->d_name);
3533 closedir(lang_dir);
3534 return strdup(script_path);
3535 }
3536 free(__script_root);
3537 }
3538 closedir(lang_dir);
3539 }
3540 closedir(scripts_dir);
3541
3542 return NULL;
3543}
3544
3545static bool is_top_script(const char *script_path)
3546{
3547 return ends_with(script_path, "top") != NULL;
3548}
3549
3550static int has_required_arg(char *script_path)
3551{
3552 struct script_desc *desc;
3553 int n_args = 0;
3554 char *p;
3555
3556 desc = script_desc__new(NULL);
3557
3558 if (read_script_info(desc, script_path))
3559 goto out;
3560
3561 if (!desc->args)
3562 goto out;
3563
3564 for (p = desc->args; *p; p++)
3565 if (*p == '<')
3566 n_args++;
3567out:
3568 script_desc__delete(desc);
3569
3570 return n_args;
3571}
3572
3573static int have_cmd(int argc, const char **argv)
3574{
3575 char **__argv = malloc(sizeof(const char *) * argc);
3576
3577 if (!__argv) {
3578 pr_err("malloc failed\n");
3579 return -1;
3580 }
3581
3582 memcpy(__argv, argv, sizeof(const char *) * argc);
3583 argc = parse_options(argc, (const char **)__argv, record_options,
3584 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3585 free(__argv);
3586
3587 system_wide = (argc == 0);
3588
3589 return 0;
3590}
3591
3592static void script__setup_sample_type(struct perf_script *script)
3593{
3594 struct perf_session *session = script->session;
3595 u64 sample_type = evlist__combined_sample_type(session->evlist);
3596
3597 callchain_param_setup(sample_type, perf_env__arch(session->machines.host.env));
3598
3599 if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3600 pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3601 "Please apply --call-graph lbr when recording.\n");
3602 script->stitch_lbr = false;
3603 }
3604}
3605
3606static int process_stat_round_event(struct perf_session *session,
3607 union perf_event *event)
3608{
3609 struct perf_record_stat_round *round = &event->stat_round;
3610 struct evsel *counter;
3611
3612 evlist__for_each_entry(session->evlist, counter) {
3613 perf_stat_process_counter(&stat_config, counter);
3614 process_stat(counter, round->time);
3615 }
3616
3617 process_stat_interval(round->time);
3618 return 0;
3619}
3620
3621static int process_stat_config_event(struct perf_session *session __maybe_unused,
3622 union perf_event *event)
3623{
3624 perf_event__read_stat_config(&stat_config, &event->stat_config);
3625 return 0;
3626}
3627
3628static int set_maps(struct perf_script *script)
3629{
3630 struct evlist *evlist = script->session->evlist;
3631
3632 if (!script->cpus || !script->threads)
3633 return 0;
3634
3635 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3636 return -EINVAL;
3637
3638 perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3639
3640 if (evlist__alloc_stats(&stat_config, evlist, /*alloc_raw=*/true))
3641 return -ENOMEM;
3642
3643 script->allocated = true;
3644 return 0;
3645}
3646
3647static
3648int process_thread_map_event(struct perf_session *session,
3649 union perf_event *event)
3650{
3651 struct perf_tool *tool = session->tool;
3652 struct perf_script *script = container_of(tool, struct perf_script, tool);
3653
3654 if (dump_trace)
3655 perf_event__fprintf_thread_map(event, stdout);
3656
3657 if (script->threads) {
3658 pr_warning("Extra thread map event, ignoring.\n");
3659 return 0;
3660 }
3661
3662 script->threads = thread_map__new_event(&event->thread_map);
3663 if (!script->threads)
3664 return -ENOMEM;
3665
3666 return set_maps(script);
3667}
3668
3669static
3670int process_cpu_map_event(struct perf_session *session,
3671 union perf_event *event)
3672{
3673 struct perf_tool *tool = session->tool;
3674 struct perf_script *script = container_of(tool, struct perf_script, tool);
3675
3676 if (dump_trace)
3677 perf_event__fprintf_cpu_map(event, stdout);
3678
3679 if (script->cpus) {
3680 pr_warning("Extra cpu map event, ignoring.\n");
3681 return 0;
3682 }
3683
3684 script->cpus = cpu_map__new_data(&event->cpu_map.data);
3685 if (!script->cpus)
3686 return -ENOMEM;
3687
3688 return set_maps(script);
3689}
3690
3691static int process_feature_event(struct perf_session *session,
3692 union perf_event *event)
3693{
3694 if (event->feat.feat_id < HEADER_LAST_FEATURE)
3695 return perf_event__process_feature(session, event);
3696 return 0;
3697}
3698
3699#ifdef HAVE_AUXTRACE_SUPPORT
3700static int perf_script__process_auxtrace_info(struct perf_session *session,
3701 union perf_event *event)
3702{
3703 struct perf_tool *tool = session->tool;
3704
3705 int ret = perf_event__process_auxtrace_info(session, event);
3706
3707 if (ret == 0) {
3708 struct perf_script *script = container_of(tool, struct perf_script, tool);
3709
3710 ret = perf_script__setup_per_event_dump(script);
3711 }
3712
3713 return ret;
3714}
3715#else
3716#define perf_script__process_auxtrace_info 0
3717#endif
3718
3719static int parse_insn_trace(const struct option *opt __maybe_unused,
3720 const char *str __maybe_unused,
3721 int unset __maybe_unused)
3722{
3723 parse_output_fields(NULL, "+insn,-event,-period", 0);
3724 itrace_parse_synth_opts(opt, "i0ns", 0);
3725 symbol_conf.nanosecs = true;
3726 return 0;
3727}
3728
3729static int parse_xed(const struct option *opt __maybe_unused,
3730 const char *str __maybe_unused,
3731 int unset __maybe_unused)
3732{
3733 if (isatty(1))
3734 force_pager("xed -F insn: -A -64 | less");
3735 else
3736 force_pager("xed -F insn: -A -64");
3737 return 0;
3738}
3739
3740static int parse_call_trace(const struct option *opt __maybe_unused,
3741 const char *str __maybe_unused,
3742 int unset __maybe_unused)
3743{
3744 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3745 itrace_parse_synth_opts(opt, "cewp", 0);
3746 symbol_conf.nanosecs = true;
3747 symbol_conf.pad_output_len_dso = 50;
3748 return 0;
3749}
3750
3751static int parse_callret_trace(const struct option *opt __maybe_unused,
3752 const char *str __maybe_unused,
3753 int unset __maybe_unused)
3754{
3755 parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3756 itrace_parse_synth_opts(opt, "crewp", 0);
3757 symbol_conf.nanosecs = true;
3758 return 0;
3759}
3760
3761int cmd_script(int argc, const char **argv)
3762{
3763 bool show_full_info = false;
3764 bool header = false;
3765 bool header_only = false;
3766 bool script_started = false;
3767 bool unsorted_dump = false;
3768 char *rec_script_path = NULL;
3769 char *rep_script_path = NULL;
3770 struct perf_session *session;
3771 struct itrace_synth_opts itrace_synth_opts = {
3772 .set = false,
3773 .default_no_sample = true,
3774 };
3775 struct utsname uts;
3776 char *script_path = NULL;
3777 const char *dlfilter_file = NULL;
3778 const char **__argv;
3779 int i, j, err = 0;
3780 struct perf_script script = {
3781 .tool = {
3782 .sample = process_sample_event,
3783 .mmap = perf_event__process_mmap,
3784 .mmap2 = perf_event__process_mmap2,
3785 .comm = perf_event__process_comm,
3786 .namespaces = perf_event__process_namespaces,
3787 .cgroup = perf_event__process_cgroup,
3788 .exit = perf_event__process_exit,
3789 .fork = perf_event__process_fork,
3790 .attr = process_attr,
3791 .event_update = perf_event__process_event_update,
3792#ifdef HAVE_LIBTRACEEVENT
3793 .tracing_data = perf_event__process_tracing_data,
3794#endif
3795 .feature = process_feature_event,
3796 .build_id = perf_event__process_build_id,
3797 .id_index = perf_event__process_id_index,
3798 .auxtrace_info = perf_script__process_auxtrace_info,
3799 .auxtrace = perf_event__process_auxtrace,
3800 .auxtrace_error = perf_event__process_auxtrace_error,
3801 .stat = perf_event__process_stat_event,
3802 .stat_round = process_stat_round_event,
3803 .stat_config = process_stat_config_event,
3804 .thread_map = process_thread_map_event,
3805 .cpu_map = process_cpu_map_event,
3806 .throttle = process_throttle_event,
3807 .unthrottle = process_throttle_event,
3808 .ordered_events = true,
3809 .ordering_requires_timestamps = true,
3810 },
3811 };
3812 struct perf_data data = {
3813 .mode = PERF_DATA_MODE_READ,
3814 };
3815 const struct option options[] = {
3816 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3817 "dump raw trace in ASCII"),
3818 OPT_BOOLEAN(0, "dump-unsorted-raw-trace", &unsorted_dump,
3819 "dump unsorted raw trace in ASCII"),
3820 OPT_INCR('v', "verbose", &verbose,
3821 "be more verbose (show symbol address, etc)"),
3822 OPT_BOOLEAN('L', "Latency", &latency_format,
3823 "show latency attributes (irqs/preemption disabled, etc)"),
3824 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3825 list_available_scripts),
3826 OPT_CALLBACK_NOOPT(0, "list-dlfilters", NULL, NULL, "list available dlfilters",
3827 list_available_dlfilters),
3828 OPT_CALLBACK('s', "script", NULL, "name",
3829 "script file name (lang:script name, script name, or *)",
3830 parse_scriptname),
3831 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3832 "generate perf-script.xx script in specified language"),
3833 OPT_STRING(0, "dlfilter", &dlfilter_file, "file", "filter .so file name"),
3834 OPT_CALLBACK(0, "dlarg", NULL, "argument", "filter argument",
3835 add_dlarg),
3836 OPT_STRING('i', "input", &input_name, "file", "input file name"),
3837 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3838 "do various checks like samples ordering and lost events"),
3839 OPT_BOOLEAN(0, "header", &header, "Show data header."),
3840 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3841 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3842 "file", "vmlinux pathname"),
3843 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3844 "file", "kallsyms pathname"),
3845 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3846 "When printing symbols do not display call chain"),
3847 OPT_CALLBACK(0, "symfs", NULL, "directory",
3848 "Look for files with symbols relative to this directory",
3849 symbol__config_symfs),
3850 OPT_CALLBACK('F', "fields", NULL, "str",
3851 "comma separated output fields prepend with 'type:'. "
3852 "+field to add and -field to remove."
3853 "Valid types: hw,sw,trace,raw,synth. "
3854 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3855 "addr,symoff,srcline,period,iregs,uregs,brstack,"
3856 "brstacksym,flags,data_src,weight,bpf-output,brstackinsn,"
3857 "brstackinsnlen,brstackoff,callindent,insn,insnlen,synth,"
3858 "phys_addr,metric,misc,srccode,ipc,tod,data_page_size,"
3859 "code_page_size,ins_lat",
3860 parse_output_fields),
3861 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3862 "system-wide collection from all CPUs"),
3863 OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
3864 "only consider symbols in these DSOs"),
3865 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3866 "only consider these symbols"),
3867 OPT_INTEGER(0, "addr-range", &symbol_conf.addr_range,
3868 "Use with -S to list traced records within address range"),
3869 OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3870 "Decode instructions from itrace", parse_insn_trace),
3871 OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3872 "Run xed disassembler on output", parse_xed),
3873 OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3874 "Decode calls from itrace", parse_call_trace),
3875 OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3876 "Decode calls and returns from itrace", parse_callret_trace),
3877 OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3878 "Only print symbols and callees with --call-trace/--call-ret-trace"),
3879 OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3880 "Stop display of callgraph at these symbols"),
3881 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3882 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3883 "only display events for these comms"),
3884 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3885 "only consider symbols in these pids"),
3886 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3887 "only consider symbols in these tids"),
3888 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3889 "Set the maximum stack depth when parsing the callchain, "
3890 "anything beyond the specified depth will be ignored. "
3891 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3892 OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3893 OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3894 OPT_BOOLEAN('I', "show-info", &show_full_info,
3895 "display extended information from perf.data file"),
3896 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3897 "Show the path of [kernel.kallsyms]"),
3898 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3899 "Show the fork/comm/exit events"),
3900 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3901 "Show the mmap events"),
3902 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3903 "Show context switch events (if recorded)"),
3904 OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3905 "Show namespace events (if recorded)"),
3906 OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
3907 "Show cgroup events (if recorded)"),
3908 OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3909 "Show lost events (if recorded)"),
3910 OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3911 "Show round events (if recorded)"),
3912 OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3913 "Show bpf related events (if recorded)"),
3914 OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
3915 "Show text poke related events (if recorded)"),
3916 OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3917 "Dump trace output to files named by the monitored events"),
3918 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3919 OPT_INTEGER(0, "max-blocks", &max_blocks,
3920 "Maximum number of code blocks to dump with brstackinsn"),
3921 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3922 "Use 9 decimal places when displaying time"),
3923 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3924 "Instruction Tracing options\n" ITRACE_HELP,
3925 itrace_parse_synth_opts),
3926 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3927 "Show full source file name path for source lines"),
3928 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3929 "Enable symbol demangling"),
3930 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3931 "Enable kernel symbol demangling"),
3932 OPT_STRING(0, "time", &script.time_str, "str",
3933 "Time span of interest (start,stop)"),
3934 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3935 "Show inline function"),
3936 OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
3937 "guest mount directory under which every guest os"
3938 " instance has a subdir"),
3939 OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
3940 "file", "file saving guest os vmlinux"),
3941 OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
3942 "file", "file saving guest os /proc/kallsyms"),
3943 OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
3944 "file", "file saving guest os /proc/modules"),
3945 OPT_BOOLEAN(0, "guest-code", &symbol_conf.guest_code,
3946 "Guest code can be found in hypervisor process"),
3947 OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
3948 "Enable LBR callgraph stitching approach"),
3949 OPTS_EVSWITCH(&script.evswitch),
3950 OPT_END()
3951 };
3952 const char * const script_subcommands[] = { "record", "report", NULL };
3953 const char *script_usage[] = {
3954 "perf script [<options>]",
3955 "perf script [<options>] record <script> [<record-options>] <command>",
3956 "perf script [<options>] report <script> [script-args]",
3957 "perf script [<options>] <script> [<record-options>] <command>",
3958 "perf script [<options>] <top-script> [script-args]",
3959 NULL
3960 };
3961
3962 perf_set_singlethreaded();
3963
3964 setup_scripting();
3965
3966 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3967 PARSE_OPT_STOP_AT_NON_OPTION);
3968
3969 if (symbol_conf.guestmount ||
3970 symbol_conf.default_guest_vmlinux_name ||
3971 symbol_conf.default_guest_kallsyms ||
3972 symbol_conf.default_guest_modules ||
3973 symbol_conf.guest_code) {
3974 /*
3975 * Enable guest sample processing.
3976 */
3977 perf_guest = true;
3978 }
3979
3980 data.path = input_name;
3981 data.force = symbol_conf.force;
3982
3983 if (unsorted_dump) {
3984 dump_trace = true;
3985 script.tool.ordered_events = false;
3986 }
3987
3988 if (symbol__validate_sym_arguments())
3989 return -1;
3990
3991 if (argc > 1 && strlen(argv[0]) > 2 && strstarts("record", argv[0])) {
3992 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
3993 if (!rec_script_path)
3994 return cmd_record(argc, argv);
3995 }
3996
3997 if (argc > 1 && strlen(argv[0]) > 2 && strstarts("report", argv[0])) {
3998 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
3999 if (!rep_script_path) {
4000 fprintf(stderr,
4001 "Please specify a valid report script"
4002 "(see 'perf script -l' for listing)\n");
4003 return -1;
4004 }
4005 }
4006
4007 if (reltime && deltatime) {
4008 fprintf(stderr,
4009 "reltime and deltatime - the two don't get along well. "
4010 "Please limit to --reltime or --deltatime.\n");
4011 return -1;
4012 }
4013
4014 if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
4015 itrace_synth_opts.callchain_sz > scripting_max_stack)
4016 scripting_max_stack = itrace_synth_opts.callchain_sz;
4017
4018 /* make sure PERF_EXEC_PATH is set for scripts */
4019 set_argv_exec_path(get_argv_exec_path());
4020
4021 if (argc && !script_name && !rec_script_path && !rep_script_path) {
4022 int live_pipe[2];
4023 int rep_args;
4024 pid_t pid;
4025
4026 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
4027 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
4028
4029 if (!rec_script_path && !rep_script_path) {
4030 script_name = find_script(argv[0]);
4031 if (script_name) {
4032 argc -= 1;
4033 argv += 1;
4034 goto script_found;
4035 }
4036 usage_with_options_msg(script_usage, options,
4037 "Couldn't find script `%s'\n\n See perf"
4038 " script -l for available scripts.\n", argv[0]);
4039 }
4040
4041 if (is_top_script(argv[0])) {
4042 rep_args = argc - 1;
4043 } else {
4044 int rec_args;
4045
4046 rep_args = has_required_arg(rep_script_path);
4047 rec_args = (argc - 1) - rep_args;
4048 if (rec_args < 0) {
4049 usage_with_options_msg(script_usage, options,
4050 "`%s' script requires options."
4051 "\n\n See perf script -l for available "
4052 "scripts and options.\n", argv[0]);
4053 }
4054 }
4055
4056 if (pipe(live_pipe) < 0) {
4057 perror("failed to create pipe");
4058 return -1;
4059 }
4060
4061 pid = fork();
4062 if (pid < 0) {
4063 perror("failed to fork");
4064 return -1;
4065 }
4066
4067 if (!pid) {
4068 j = 0;
4069
4070 dup2(live_pipe[1], 1);
4071 close(live_pipe[0]);
4072
4073 if (is_top_script(argv[0])) {
4074 system_wide = true;
4075 } else if (!system_wide) {
4076 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
4077 err = -1;
4078 goto out;
4079 }
4080 }
4081
4082 __argv = malloc((argc + 6) * sizeof(const char *));
4083 if (!__argv) {
4084 pr_err("malloc failed\n");
4085 err = -ENOMEM;
4086 goto out;
4087 }
4088
4089 __argv[j++] = "/bin/sh";
4090 __argv[j++] = rec_script_path;
4091 if (system_wide)
4092 __argv[j++] = "-a";
4093 __argv[j++] = "-q";
4094 __argv[j++] = "-o";
4095 __argv[j++] = "-";
4096 for (i = rep_args + 1; i < argc; i++)
4097 __argv[j++] = argv[i];
4098 __argv[j++] = NULL;
4099
4100 execvp("/bin/sh", (char **)__argv);
4101 free(__argv);
4102 exit(-1);
4103 }
4104
4105 dup2(live_pipe[0], 0);
4106 close(live_pipe[1]);
4107
4108 __argv = malloc((argc + 4) * sizeof(const char *));
4109 if (!__argv) {
4110 pr_err("malloc failed\n");
4111 err = -ENOMEM;
4112 goto out;
4113 }
4114
4115 j = 0;
4116 __argv[j++] = "/bin/sh";
4117 __argv[j++] = rep_script_path;
4118 for (i = 1; i < rep_args + 1; i++)
4119 __argv[j++] = argv[i];
4120 __argv[j++] = "-i";
4121 __argv[j++] = "-";
4122 __argv[j++] = NULL;
4123
4124 execvp("/bin/sh", (char **)__argv);
4125 free(__argv);
4126 exit(-1);
4127 }
4128script_found:
4129 if (rec_script_path)
4130 script_path = rec_script_path;
4131 if (rep_script_path)
4132 script_path = rep_script_path;
4133
4134 if (script_path) {
4135 j = 0;
4136
4137 if (!rec_script_path)
4138 system_wide = false;
4139 else if (!system_wide) {
4140 if (have_cmd(argc - 1, &argv[1]) != 0) {
4141 err = -1;
4142 goto out;
4143 }
4144 }
4145
4146 __argv = malloc((argc + 2) * sizeof(const char *));
4147 if (!__argv) {
4148 pr_err("malloc failed\n");
4149 err = -ENOMEM;
4150 goto out;
4151 }
4152
4153 __argv[j++] = "/bin/sh";
4154 __argv[j++] = script_path;
4155 if (system_wide)
4156 __argv[j++] = "-a";
4157 for (i = 2; i < argc; i++)
4158 __argv[j++] = argv[i];
4159 __argv[j++] = NULL;
4160
4161 execvp("/bin/sh", (char **)__argv);
4162 free(__argv);
4163 exit(-1);
4164 }
4165
4166 if (dlfilter_file) {
4167 dlfilter = dlfilter__new(dlfilter_file, dlargc, dlargv);
4168 if (!dlfilter)
4169 return -1;
4170 }
4171
4172 if (!script_name) {
4173 setup_pager();
4174 use_browser = 0;
4175 }
4176
4177 session = perf_session__new(&data, &script.tool);
4178 if (IS_ERR(session))
4179 return PTR_ERR(session);
4180
4181 if (header || header_only) {
4182 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
4183 perf_session__fprintf_info(session, stdout, show_full_info);
4184 if (header_only)
4185 goto out_delete;
4186 }
4187 if (show_full_info)
4188 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
4189
4190 if (symbol__init(&session->header.env) < 0)
4191 goto out_delete;
4192
4193 uname(&uts);
4194 if (data.is_pipe) { /* Assume pipe_mode indicates native_arch */
4195 native_arch = true;
4196 } else if (session->header.env.arch) {
4197 if (!strcmp(uts.machine, session->header.env.arch))
4198 native_arch = true;
4199 else if (!strcmp(uts.machine, "x86_64") &&
4200 !strcmp(session->header.env.arch, "i386"))
4201 native_arch = true;
4202 }
4203
4204 script.session = session;
4205 script__setup_sample_type(&script);
4206
4207 if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
4208 symbol_conf.graph_function)
4209 itrace_synth_opts.thread_stack = true;
4210
4211 session->itrace_synth_opts = &itrace_synth_opts;
4212
4213 if (cpu_list) {
4214 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
4215 if (err < 0)
4216 goto out_delete;
4217 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
4218 }
4219
4220 if (!no_callchain)
4221 symbol_conf.use_callchain = true;
4222 else
4223 symbol_conf.use_callchain = false;
4224
4225#ifdef HAVE_LIBTRACEEVENT
4226 if (session->tevent.pevent &&
4227 tep_set_function_resolver(session->tevent.pevent,
4228 machine__resolve_kernel_addr,
4229 &session->machines.host) < 0) {
4230 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
4231 err = -1;
4232 goto out_delete;
4233 }
4234#endif
4235 if (generate_script_lang) {
4236 struct stat perf_stat;
4237 int input;
4238
4239 if (output_set_by_user()) {
4240 fprintf(stderr,
4241 "custom fields not supported for generated scripts");
4242 err = -EINVAL;
4243 goto out_delete;
4244 }
4245
4246 input = open(data.path, O_RDONLY); /* input_name */
4247 if (input < 0) {
4248 err = -errno;
4249 perror("failed to open file");
4250 goto out_delete;
4251 }
4252
4253 err = fstat(input, &perf_stat);
4254 if (err < 0) {
4255 perror("failed to stat file");
4256 goto out_delete;
4257 }
4258
4259 if (!perf_stat.st_size) {
4260 fprintf(stderr, "zero-sized file, nothing to do!\n");
4261 goto out_delete;
4262 }
4263
4264 scripting_ops = script_spec__lookup(generate_script_lang);
4265 if (!scripting_ops) {
4266 fprintf(stderr, "invalid language specifier");
4267 err = -ENOENT;
4268 goto out_delete;
4269 }
4270#ifdef HAVE_LIBTRACEEVENT
4271 err = scripting_ops->generate_script(session->tevent.pevent,
4272 "perf-script");
4273#else
4274 err = scripting_ops->generate_script(NULL, "perf-script");
4275#endif
4276 goto out_delete;
4277 }
4278
4279 err = dlfilter__start(dlfilter, session);
4280 if (err)
4281 goto out_delete;
4282
4283 if (script_name) {
4284 err = scripting_ops->start_script(script_name, argc, argv, session);
4285 if (err)
4286 goto out_delete;
4287 pr_debug("perf script started with script %s\n\n", script_name);
4288 script_started = true;
4289 }
4290
4291
4292 err = perf_session__check_output_opt(session);
4293 if (err < 0)
4294 goto out_delete;
4295
4296 if (script.time_str) {
4297 err = perf_time__parse_for_ranges_reltime(script.time_str, session,
4298 &script.ptime_range,
4299 &script.range_size,
4300 &script.range_num,
4301 reltime);
4302 if (err < 0)
4303 goto out_delete;
4304
4305 itrace_synth_opts__set_time_range(&itrace_synth_opts,
4306 script.ptime_range,
4307 script.range_num);
4308 }
4309
4310 err = evswitch__init(&script.evswitch, session->evlist, stderr);
4311 if (err)
4312 goto out_delete;
4313
4314 if (zstd_init(&(session->zstd_data), 0) < 0)
4315 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
4316
4317 err = __cmd_script(&script);
4318
4319 flush_scripting();
4320
4321out_delete:
4322 if (script.ptime_range) {
4323 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
4324 zfree(&script.ptime_range);
4325 }
4326
4327 zstd_fini(&(session->zstd_data));
4328 evlist__free_stats(session->evlist);
4329 perf_session__delete(session);
4330 perf_script__exit(&script);
4331
4332 if (script_started)
4333 cleanup_scripting();
4334 dlfilter__cleanup(dlfilter);
4335 free_dlarg();
4336out:
4337 return err;
4338}
1#include "builtin.h"
2
3#include "perf.h"
4#include "util/cache.h"
5#include "util/debug.h"
6#include "util/exec_cmd.h"
7#include "util/header.h"
8#include "util/parse-options.h"
9#include "util/session.h"
10#include "util/tool.h"
11#include "util/symbol.h"
12#include "util/thread.h"
13#include "util/trace-event.h"
14#include "util/util.h"
15#include "util/evlist.h"
16#include "util/evsel.h"
17#include "util/sort.h"
18#include "util/data.h"
19#include <linux/bitmap.h>
20
21static char const *script_name;
22static char const *generate_script_lang;
23static bool debug_mode;
24static u64 last_timestamp;
25static u64 nr_unordered;
26extern const struct option record_options[];
27static bool no_callchain;
28static bool latency_format;
29static bool system_wide;
30static const char *cpu_list;
31static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
32
33enum perf_output_field {
34 PERF_OUTPUT_COMM = 1U << 0,
35 PERF_OUTPUT_TID = 1U << 1,
36 PERF_OUTPUT_PID = 1U << 2,
37 PERF_OUTPUT_TIME = 1U << 3,
38 PERF_OUTPUT_CPU = 1U << 4,
39 PERF_OUTPUT_EVNAME = 1U << 5,
40 PERF_OUTPUT_TRACE = 1U << 6,
41 PERF_OUTPUT_IP = 1U << 7,
42 PERF_OUTPUT_SYM = 1U << 8,
43 PERF_OUTPUT_DSO = 1U << 9,
44 PERF_OUTPUT_ADDR = 1U << 10,
45 PERF_OUTPUT_SYMOFFSET = 1U << 11,
46 PERF_OUTPUT_SRCLINE = 1U << 12,
47};
48
49struct output_option {
50 const char *str;
51 enum perf_output_field field;
52} all_output_options[] = {
53 {.str = "comm", .field = PERF_OUTPUT_COMM},
54 {.str = "tid", .field = PERF_OUTPUT_TID},
55 {.str = "pid", .field = PERF_OUTPUT_PID},
56 {.str = "time", .field = PERF_OUTPUT_TIME},
57 {.str = "cpu", .field = PERF_OUTPUT_CPU},
58 {.str = "event", .field = PERF_OUTPUT_EVNAME},
59 {.str = "trace", .field = PERF_OUTPUT_TRACE},
60 {.str = "ip", .field = PERF_OUTPUT_IP},
61 {.str = "sym", .field = PERF_OUTPUT_SYM},
62 {.str = "dso", .field = PERF_OUTPUT_DSO},
63 {.str = "addr", .field = PERF_OUTPUT_ADDR},
64 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
65 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
66};
67
68/* default set to maintain compatibility with current format */
69static struct {
70 bool user_set;
71 bool wildcard_set;
72 unsigned int print_ip_opts;
73 u64 fields;
74 u64 invalid_fields;
75} output[PERF_TYPE_MAX] = {
76
77 [PERF_TYPE_HARDWARE] = {
78 .user_set = false,
79
80 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
81 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
82 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
83 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
84
85 .invalid_fields = PERF_OUTPUT_TRACE,
86 },
87
88 [PERF_TYPE_SOFTWARE] = {
89 .user_set = false,
90
91 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
92 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
93 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
94 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
95
96 .invalid_fields = PERF_OUTPUT_TRACE,
97 },
98
99 [PERF_TYPE_TRACEPOINT] = {
100 .user_set = false,
101
102 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
103 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
104 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE,
105 },
106
107 [PERF_TYPE_RAW] = {
108 .user_set = false,
109
110 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
111 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
112 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
113 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
114
115 .invalid_fields = PERF_OUTPUT_TRACE,
116 },
117};
118
119static bool output_set_by_user(void)
120{
121 int j;
122 for (j = 0; j < PERF_TYPE_MAX; ++j) {
123 if (output[j].user_set)
124 return true;
125 }
126 return false;
127}
128
129static const char *output_field2str(enum perf_output_field field)
130{
131 int i, imax = ARRAY_SIZE(all_output_options);
132 const char *str = "";
133
134 for (i = 0; i < imax; ++i) {
135 if (all_output_options[i].field == field) {
136 str = all_output_options[i].str;
137 break;
138 }
139 }
140 return str;
141}
142
143#define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
144
145static int perf_evsel__check_stype(struct perf_evsel *evsel,
146 u64 sample_type, const char *sample_msg,
147 enum perf_output_field field)
148{
149 struct perf_event_attr *attr = &evsel->attr;
150 int type = attr->type;
151 const char *evname;
152
153 if (attr->sample_type & sample_type)
154 return 0;
155
156 if (output[type].user_set) {
157 evname = perf_evsel__name(evsel);
158 pr_err("Samples for '%s' event do not have %s attribute set. "
159 "Cannot print '%s' field.\n",
160 evname, sample_msg, output_field2str(field));
161 return -1;
162 }
163
164 /* user did not ask for it explicitly so remove from the default list */
165 output[type].fields &= ~field;
166 evname = perf_evsel__name(evsel);
167 pr_debug("Samples for '%s' event do not have %s attribute set. "
168 "Skipping '%s' field.\n",
169 evname, sample_msg, output_field2str(field));
170
171 return 0;
172}
173
174static int perf_evsel__check_attr(struct perf_evsel *evsel,
175 struct perf_session *session)
176{
177 struct perf_event_attr *attr = &evsel->attr;
178
179 if (PRINT_FIELD(TRACE) &&
180 !perf_session__has_traces(session, "record -R"))
181 return -EINVAL;
182
183 if (PRINT_FIELD(IP)) {
184 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
185 PERF_OUTPUT_IP))
186 return -EINVAL;
187
188 if (!no_callchain &&
189 !(attr->sample_type & PERF_SAMPLE_CALLCHAIN))
190 symbol_conf.use_callchain = false;
191 }
192
193 if (PRINT_FIELD(ADDR) &&
194 perf_evsel__check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
195 PERF_OUTPUT_ADDR))
196 return -EINVAL;
197
198 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
199 pr_err("Display of symbols requested but neither sample IP nor "
200 "sample address\nis selected. Hence, no addresses to convert "
201 "to symbols.\n");
202 return -EINVAL;
203 }
204 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
205 pr_err("Display of offsets requested but symbol is not"
206 "selected.\n");
207 return -EINVAL;
208 }
209 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
210 pr_err("Display of DSO requested but neither sample IP nor "
211 "sample address\nis selected. Hence, no addresses to convert "
212 "to DSO.\n");
213 return -EINVAL;
214 }
215 if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
216 pr_err("Display of source line number requested but sample IP is not\n"
217 "selected. Hence, no address to lookup the source line number.\n");
218 return -EINVAL;
219 }
220
221 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
222 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
223 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
224 return -EINVAL;
225
226 if (PRINT_FIELD(TIME) &&
227 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
228 PERF_OUTPUT_TIME))
229 return -EINVAL;
230
231 if (PRINT_FIELD(CPU) &&
232 perf_evsel__check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
233 PERF_OUTPUT_CPU))
234 return -EINVAL;
235
236 return 0;
237}
238
239static void set_print_ip_opts(struct perf_event_attr *attr)
240{
241 unsigned int type = attr->type;
242
243 output[type].print_ip_opts = 0;
244 if (PRINT_FIELD(IP))
245 output[type].print_ip_opts |= PRINT_IP_OPT_IP;
246
247 if (PRINT_FIELD(SYM))
248 output[type].print_ip_opts |= PRINT_IP_OPT_SYM;
249
250 if (PRINT_FIELD(DSO))
251 output[type].print_ip_opts |= PRINT_IP_OPT_DSO;
252
253 if (PRINT_FIELD(SYMOFFSET))
254 output[type].print_ip_opts |= PRINT_IP_OPT_SYMOFFSET;
255
256 if (PRINT_FIELD(SRCLINE))
257 output[type].print_ip_opts |= PRINT_IP_OPT_SRCLINE;
258}
259
260/*
261 * verify all user requested events exist and the samples
262 * have the expected data
263 */
264static int perf_session__check_output_opt(struct perf_session *session)
265{
266 int j;
267 struct perf_evsel *evsel;
268
269 for (j = 0; j < PERF_TYPE_MAX; ++j) {
270 evsel = perf_session__find_first_evtype(session, j);
271
272 /*
273 * even if fields is set to 0 (ie., show nothing) event must
274 * exist if user explicitly includes it on the command line
275 */
276 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
277 pr_err("%s events do not exist. "
278 "Remove corresponding -f option to proceed.\n",
279 event_type(j));
280 return -1;
281 }
282
283 if (evsel && output[j].fields &&
284 perf_evsel__check_attr(evsel, session))
285 return -1;
286
287 if (evsel == NULL)
288 continue;
289
290 set_print_ip_opts(&evsel->attr);
291 }
292
293 /*
294 * set default for tracepoints to print symbols only
295 * if callchains are present
296 */
297 if (symbol_conf.use_callchain &&
298 !output[PERF_TYPE_TRACEPOINT].user_set) {
299 struct perf_event_attr *attr;
300
301 j = PERF_TYPE_TRACEPOINT;
302 evsel = perf_session__find_first_evtype(session, j);
303 if (evsel == NULL)
304 goto out;
305
306 attr = &evsel->attr;
307
308 if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
309 output[j].fields |= PERF_OUTPUT_IP;
310 output[j].fields |= PERF_OUTPUT_SYM;
311 output[j].fields |= PERF_OUTPUT_DSO;
312 set_print_ip_opts(attr);
313 }
314 }
315
316out:
317 return 0;
318}
319
320static void print_sample_start(struct perf_sample *sample,
321 struct thread *thread,
322 struct perf_evsel *evsel)
323{
324 struct perf_event_attr *attr = &evsel->attr;
325 unsigned long secs;
326 unsigned long usecs;
327 unsigned long long nsecs;
328
329 if (PRINT_FIELD(COMM)) {
330 if (latency_format)
331 printf("%8.8s ", thread__comm_str(thread));
332 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
333 printf("%s ", thread__comm_str(thread));
334 else
335 printf("%16s ", thread__comm_str(thread));
336 }
337
338 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
339 printf("%5d/%-5d ", sample->pid, sample->tid);
340 else if (PRINT_FIELD(PID))
341 printf("%5d ", sample->pid);
342 else if (PRINT_FIELD(TID))
343 printf("%5d ", sample->tid);
344
345 if (PRINT_FIELD(CPU)) {
346 if (latency_format)
347 printf("%3d ", sample->cpu);
348 else
349 printf("[%03d] ", sample->cpu);
350 }
351
352 if (PRINT_FIELD(TIME)) {
353 nsecs = sample->time;
354 secs = nsecs / NSECS_PER_SEC;
355 nsecs -= secs * NSECS_PER_SEC;
356 usecs = nsecs / NSECS_PER_USEC;
357 printf("%5lu.%06lu: ", secs, usecs);
358 }
359}
360
361static bool is_bts_event(struct perf_event_attr *attr)
362{
363 return ((attr->type == PERF_TYPE_HARDWARE) &&
364 (attr->config & PERF_COUNT_HW_BRANCH_INSTRUCTIONS) &&
365 (attr->sample_period == 1));
366}
367
368static bool sample_addr_correlates_sym(struct perf_event_attr *attr)
369{
370 if ((attr->type == PERF_TYPE_SOFTWARE) &&
371 ((attr->config == PERF_COUNT_SW_PAGE_FAULTS) ||
372 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MIN) ||
373 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MAJ)))
374 return true;
375
376 if (is_bts_event(attr))
377 return true;
378
379 return false;
380}
381
382static void print_sample_addr(union perf_event *event,
383 struct perf_sample *sample,
384 struct machine *machine,
385 struct thread *thread,
386 struct perf_event_attr *attr)
387{
388 struct addr_location al;
389 u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
390
391 printf("%16" PRIx64, sample->addr);
392
393 if (!sample_addr_correlates_sym(attr))
394 return;
395
396 thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
397 sample->addr, &al);
398 if (!al.map)
399 thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE,
400 sample->addr, &al);
401
402 al.cpu = sample->cpu;
403 al.sym = NULL;
404
405 if (al.map)
406 al.sym = map__find_symbol(al.map, al.addr, NULL);
407
408 if (PRINT_FIELD(SYM)) {
409 printf(" ");
410 if (PRINT_FIELD(SYMOFFSET))
411 symbol__fprintf_symname_offs(al.sym, &al, stdout);
412 else
413 symbol__fprintf_symname(al.sym, stdout);
414 }
415
416 if (PRINT_FIELD(DSO)) {
417 printf(" (");
418 map__fprintf_dsoname(al.map, stdout);
419 printf(")");
420 }
421}
422
423static void print_sample_bts(union perf_event *event,
424 struct perf_sample *sample,
425 struct perf_evsel *evsel,
426 struct thread *thread,
427 struct addr_location *al)
428{
429 struct perf_event_attr *attr = &evsel->attr;
430
431 /* print branch_from information */
432 if (PRINT_FIELD(IP)) {
433 if (!symbol_conf.use_callchain)
434 printf(" ");
435 else
436 printf("\n");
437 perf_evsel__print_ip(evsel, sample, al,
438 output[attr->type].print_ip_opts,
439 PERF_MAX_STACK_DEPTH);
440 }
441
442 printf(" => ");
443
444 /* print branch_to information */
445 if (PRINT_FIELD(ADDR) ||
446 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
447 !output[attr->type].user_set))
448 print_sample_addr(event, sample, al->machine, thread, attr);
449
450 printf("\n");
451}
452
453static void process_event(union perf_event *event, struct perf_sample *sample,
454 struct perf_evsel *evsel, struct thread *thread,
455 struct addr_location *al)
456{
457 struct perf_event_attr *attr = &evsel->attr;
458
459 if (output[attr->type].fields == 0)
460 return;
461
462 print_sample_start(sample, thread, evsel);
463
464 if (PRINT_FIELD(EVNAME)) {
465 const char *evname = perf_evsel__name(evsel);
466 printf("%s: ", evname ? evname : "[unknown]");
467 }
468
469 if (is_bts_event(attr)) {
470 print_sample_bts(event, sample, evsel, thread, al);
471 return;
472 }
473
474 if (PRINT_FIELD(TRACE))
475 event_format__print(evsel->tp_format, sample->cpu,
476 sample->raw_data, sample->raw_size);
477 if (PRINT_FIELD(ADDR))
478 print_sample_addr(event, sample, al->machine, thread, attr);
479
480 if (PRINT_FIELD(IP)) {
481 if (!symbol_conf.use_callchain)
482 printf(" ");
483 else
484 printf("\n");
485
486 perf_evsel__print_ip(evsel, sample, al,
487 output[attr->type].print_ip_opts,
488 PERF_MAX_STACK_DEPTH);
489 }
490
491 printf("\n");
492}
493
494static int default_start_script(const char *script __maybe_unused,
495 int argc __maybe_unused,
496 const char **argv __maybe_unused)
497{
498 return 0;
499}
500
501static int default_stop_script(void)
502{
503 return 0;
504}
505
506static int default_generate_script(struct pevent *pevent __maybe_unused,
507 const char *outfile __maybe_unused)
508{
509 return 0;
510}
511
512static struct scripting_ops default_scripting_ops = {
513 .start_script = default_start_script,
514 .stop_script = default_stop_script,
515 .process_event = process_event,
516 .generate_script = default_generate_script,
517};
518
519static struct scripting_ops *scripting_ops;
520
521static void setup_scripting(void)
522{
523 setup_perl_scripting();
524 setup_python_scripting();
525
526 scripting_ops = &default_scripting_ops;
527}
528
529static int cleanup_scripting(void)
530{
531 pr_debug("\nperf script stopped\n");
532
533 return scripting_ops->stop_script();
534}
535
536static int process_sample_event(struct perf_tool *tool __maybe_unused,
537 union perf_event *event,
538 struct perf_sample *sample,
539 struct perf_evsel *evsel,
540 struct machine *machine)
541{
542 struct addr_location al;
543 struct thread *thread = machine__findnew_thread(machine, sample->pid,
544 sample->tid);
545
546 if (thread == NULL) {
547 pr_debug("problem processing %d event, skipping it.\n",
548 event->header.type);
549 return -1;
550 }
551
552 if (debug_mode) {
553 if (sample->time < last_timestamp) {
554 pr_err("Samples misordered, previous: %" PRIu64
555 " this: %" PRIu64 "\n", last_timestamp,
556 sample->time);
557 nr_unordered++;
558 }
559 last_timestamp = sample->time;
560 return 0;
561 }
562
563 if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
564 pr_err("problem processing %d event, skipping it.\n",
565 event->header.type);
566 return -1;
567 }
568
569 if (al.filtered)
570 return 0;
571
572 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
573 return 0;
574
575 scripting_ops->process_event(event, sample, evsel, thread, &al);
576
577 evsel->hists.stats.total_period += sample->period;
578 return 0;
579}
580
581struct perf_script {
582 struct perf_tool tool;
583 struct perf_session *session;
584 bool show_task_events;
585 bool show_mmap_events;
586};
587
588static int process_attr(struct perf_tool *tool, union perf_event *event,
589 struct perf_evlist **pevlist)
590{
591 struct perf_script *scr = container_of(tool, struct perf_script, tool);
592 struct perf_evlist *evlist;
593 struct perf_evsel *evsel, *pos;
594 int err;
595
596 err = perf_event__process_attr(tool, event, pevlist);
597 if (err)
598 return err;
599
600 evlist = *pevlist;
601 evsel = perf_evlist__last(*pevlist);
602
603 if (evsel->attr.type >= PERF_TYPE_MAX)
604 return 0;
605
606 evlist__for_each(evlist, pos) {
607 if (pos->attr.type == evsel->attr.type && pos != evsel)
608 return 0;
609 }
610
611 set_print_ip_opts(&evsel->attr);
612
613 return perf_evsel__check_attr(evsel, scr->session);
614}
615
616static int process_comm_event(struct perf_tool *tool,
617 union perf_event *event,
618 struct perf_sample *sample,
619 struct machine *machine)
620{
621 struct thread *thread;
622 struct perf_script *script = container_of(tool, struct perf_script, tool);
623 struct perf_session *session = script->session;
624 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
625 int ret = -1;
626
627 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
628 if (thread == NULL) {
629 pr_debug("problem processing COMM event, skipping it.\n");
630 return -1;
631 }
632
633 if (perf_event__process_comm(tool, event, sample, machine) < 0)
634 goto out;
635
636 if (!evsel->attr.sample_id_all) {
637 sample->cpu = 0;
638 sample->time = 0;
639 sample->tid = event->comm.tid;
640 sample->pid = event->comm.pid;
641 }
642 print_sample_start(sample, thread, evsel);
643 perf_event__fprintf(event, stdout);
644 ret = 0;
645
646out:
647 return ret;
648}
649
650static int process_fork_event(struct perf_tool *tool,
651 union perf_event *event,
652 struct perf_sample *sample,
653 struct machine *machine)
654{
655 struct thread *thread;
656 struct perf_script *script = container_of(tool, struct perf_script, tool);
657 struct perf_session *session = script->session;
658 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
659
660 if (perf_event__process_fork(tool, event, sample, machine) < 0)
661 return -1;
662
663 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
664 if (thread == NULL) {
665 pr_debug("problem processing FORK event, skipping it.\n");
666 return -1;
667 }
668
669 if (!evsel->attr.sample_id_all) {
670 sample->cpu = 0;
671 sample->time = event->fork.time;
672 sample->tid = event->fork.tid;
673 sample->pid = event->fork.pid;
674 }
675 print_sample_start(sample, thread, evsel);
676 perf_event__fprintf(event, stdout);
677
678 return 0;
679}
680static int process_exit_event(struct perf_tool *tool,
681 union perf_event *event,
682 struct perf_sample *sample,
683 struct machine *machine)
684{
685 struct thread *thread;
686 struct perf_script *script = container_of(tool, struct perf_script, tool);
687 struct perf_session *session = script->session;
688 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
689
690 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
691 if (thread == NULL) {
692 pr_debug("problem processing EXIT event, skipping it.\n");
693 return -1;
694 }
695
696 if (!evsel->attr.sample_id_all) {
697 sample->cpu = 0;
698 sample->time = 0;
699 sample->tid = event->comm.tid;
700 sample->pid = event->comm.pid;
701 }
702 print_sample_start(sample, thread, evsel);
703 perf_event__fprintf(event, stdout);
704
705 if (perf_event__process_exit(tool, event, sample, machine) < 0)
706 return -1;
707
708 return 0;
709}
710
711static int process_mmap_event(struct perf_tool *tool,
712 union perf_event *event,
713 struct perf_sample *sample,
714 struct machine *machine)
715{
716 struct thread *thread;
717 struct perf_script *script = container_of(tool, struct perf_script, tool);
718 struct perf_session *session = script->session;
719 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
720
721 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
722 return -1;
723
724 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
725 if (thread == NULL) {
726 pr_debug("problem processing MMAP event, skipping it.\n");
727 return -1;
728 }
729
730 if (!evsel->attr.sample_id_all) {
731 sample->cpu = 0;
732 sample->time = 0;
733 sample->tid = event->mmap.tid;
734 sample->pid = event->mmap.pid;
735 }
736 print_sample_start(sample, thread, evsel);
737 perf_event__fprintf(event, stdout);
738
739 return 0;
740}
741
742static int process_mmap2_event(struct perf_tool *tool,
743 union perf_event *event,
744 struct perf_sample *sample,
745 struct machine *machine)
746{
747 struct thread *thread;
748 struct perf_script *script = container_of(tool, struct perf_script, tool);
749 struct perf_session *session = script->session;
750 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
751
752 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
753 return -1;
754
755 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
756 if (thread == NULL) {
757 pr_debug("problem processing MMAP2 event, skipping it.\n");
758 return -1;
759 }
760
761 if (!evsel->attr.sample_id_all) {
762 sample->cpu = 0;
763 sample->time = 0;
764 sample->tid = event->mmap2.tid;
765 sample->pid = event->mmap2.pid;
766 }
767 print_sample_start(sample, thread, evsel);
768 perf_event__fprintf(event, stdout);
769
770 return 0;
771}
772
773static void sig_handler(int sig __maybe_unused)
774{
775 session_done = 1;
776}
777
778static int __cmd_script(struct perf_script *script)
779{
780 int ret;
781
782 signal(SIGINT, sig_handler);
783
784 /* override event processing functions */
785 if (script->show_task_events) {
786 script->tool.comm = process_comm_event;
787 script->tool.fork = process_fork_event;
788 script->tool.exit = process_exit_event;
789 }
790 if (script->show_mmap_events) {
791 script->tool.mmap = process_mmap_event;
792 script->tool.mmap2 = process_mmap2_event;
793 }
794
795 ret = perf_session__process_events(script->session, &script->tool);
796
797 if (debug_mode)
798 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
799
800 return ret;
801}
802
803struct script_spec {
804 struct list_head node;
805 struct scripting_ops *ops;
806 char spec[0];
807};
808
809static LIST_HEAD(script_specs);
810
811static struct script_spec *script_spec__new(const char *spec,
812 struct scripting_ops *ops)
813{
814 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
815
816 if (s != NULL) {
817 strcpy(s->spec, spec);
818 s->ops = ops;
819 }
820
821 return s;
822}
823
824static void script_spec__add(struct script_spec *s)
825{
826 list_add_tail(&s->node, &script_specs);
827}
828
829static struct script_spec *script_spec__find(const char *spec)
830{
831 struct script_spec *s;
832
833 list_for_each_entry(s, &script_specs, node)
834 if (strcasecmp(s->spec, spec) == 0)
835 return s;
836 return NULL;
837}
838
839static struct script_spec *script_spec__findnew(const char *spec,
840 struct scripting_ops *ops)
841{
842 struct script_spec *s = script_spec__find(spec);
843
844 if (s)
845 return s;
846
847 s = script_spec__new(spec, ops);
848 if (!s)
849 return NULL;
850
851 script_spec__add(s);
852
853 return s;
854}
855
856int script_spec_register(const char *spec, struct scripting_ops *ops)
857{
858 struct script_spec *s;
859
860 s = script_spec__find(spec);
861 if (s)
862 return -1;
863
864 s = script_spec__findnew(spec, ops);
865 if (!s)
866 return -1;
867
868 return 0;
869}
870
871static struct scripting_ops *script_spec__lookup(const char *spec)
872{
873 struct script_spec *s = script_spec__find(spec);
874 if (!s)
875 return NULL;
876
877 return s->ops;
878}
879
880static void list_available_languages(void)
881{
882 struct script_spec *s;
883
884 fprintf(stderr, "\n");
885 fprintf(stderr, "Scripting language extensions (used in "
886 "perf script -s [spec:]script.[spec]):\n\n");
887
888 list_for_each_entry(s, &script_specs, node)
889 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
890
891 fprintf(stderr, "\n");
892}
893
894static int parse_scriptname(const struct option *opt __maybe_unused,
895 const char *str, int unset __maybe_unused)
896{
897 char spec[PATH_MAX];
898 const char *script, *ext;
899 int len;
900
901 if (strcmp(str, "lang") == 0) {
902 list_available_languages();
903 exit(0);
904 }
905
906 script = strchr(str, ':');
907 if (script) {
908 len = script - str;
909 if (len >= PATH_MAX) {
910 fprintf(stderr, "invalid language specifier");
911 return -1;
912 }
913 strncpy(spec, str, len);
914 spec[len] = '\0';
915 scripting_ops = script_spec__lookup(spec);
916 if (!scripting_ops) {
917 fprintf(stderr, "invalid language specifier");
918 return -1;
919 }
920 script++;
921 } else {
922 script = str;
923 ext = strrchr(script, '.');
924 if (!ext) {
925 fprintf(stderr, "invalid script extension");
926 return -1;
927 }
928 scripting_ops = script_spec__lookup(++ext);
929 if (!scripting_ops) {
930 fprintf(stderr, "invalid script extension");
931 return -1;
932 }
933 }
934
935 script_name = strdup(script);
936
937 return 0;
938}
939
940static int parse_output_fields(const struct option *opt __maybe_unused,
941 const char *arg, int unset __maybe_unused)
942{
943 char *tok;
944 int i, imax = ARRAY_SIZE(all_output_options);
945 int j;
946 int rc = 0;
947 char *str = strdup(arg);
948 int type = -1;
949
950 if (!str)
951 return -ENOMEM;
952
953 /* first word can state for which event type the user is specifying
954 * the fields. If no type exists, the specified fields apply to all
955 * event types found in the file minus the invalid fields for a type.
956 */
957 tok = strchr(str, ':');
958 if (tok) {
959 *tok = '\0';
960 tok++;
961 if (!strcmp(str, "hw"))
962 type = PERF_TYPE_HARDWARE;
963 else if (!strcmp(str, "sw"))
964 type = PERF_TYPE_SOFTWARE;
965 else if (!strcmp(str, "trace"))
966 type = PERF_TYPE_TRACEPOINT;
967 else if (!strcmp(str, "raw"))
968 type = PERF_TYPE_RAW;
969 else {
970 fprintf(stderr, "Invalid event type in field string.\n");
971 rc = -EINVAL;
972 goto out;
973 }
974
975 if (output[type].user_set)
976 pr_warning("Overriding previous field request for %s events.\n",
977 event_type(type));
978
979 output[type].fields = 0;
980 output[type].user_set = true;
981 output[type].wildcard_set = false;
982
983 } else {
984 tok = str;
985 if (strlen(str) == 0) {
986 fprintf(stderr,
987 "Cannot set fields to 'none' for all event types.\n");
988 rc = -EINVAL;
989 goto out;
990 }
991
992 if (output_set_by_user())
993 pr_warning("Overriding previous field request for all events.\n");
994
995 for (j = 0; j < PERF_TYPE_MAX; ++j) {
996 output[j].fields = 0;
997 output[j].user_set = true;
998 output[j].wildcard_set = true;
999 }
1000 }
1001
1002 tok = strtok(tok, ",");
1003 while (tok) {
1004 for (i = 0; i < imax; ++i) {
1005 if (strcmp(tok, all_output_options[i].str) == 0)
1006 break;
1007 }
1008 if (i == imax) {
1009 fprintf(stderr, "Invalid field requested.\n");
1010 rc = -EINVAL;
1011 goto out;
1012 }
1013
1014 if (type == -1) {
1015 /* add user option to all events types for
1016 * which it is valid
1017 */
1018 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1019 if (output[j].invalid_fields & all_output_options[i].field) {
1020 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
1021 all_output_options[i].str, event_type(j));
1022 } else
1023 output[j].fields |= all_output_options[i].field;
1024 }
1025 } else {
1026 if (output[type].invalid_fields & all_output_options[i].field) {
1027 fprintf(stderr, "\'%s\' not valid for %s events.\n",
1028 all_output_options[i].str, event_type(type));
1029
1030 rc = -EINVAL;
1031 goto out;
1032 }
1033 output[type].fields |= all_output_options[i].field;
1034 }
1035
1036 tok = strtok(NULL, ",");
1037 }
1038
1039 if (type >= 0) {
1040 if (output[type].fields == 0) {
1041 pr_debug("No fields requested for %s type. "
1042 "Events will not be displayed.\n", event_type(type));
1043 }
1044 }
1045
1046out:
1047 free(str);
1048 return rc;
1049}
1050
1051/* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1052static int is_directory(const char *base_path, const struct dirent *dent)
1053{
1054 char path[PATH_MAX];
1055 struct stat st;
1056
1057 sprintf(path, "%s/%s", base_path, dent->d_name);
1058 if (stat(path, &st))
1059 return 0;
1060
1061 return S_ISDIR(st.st_mode);
1062}
1063
1064#define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
1065 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
1066 lang_next) \
1067 if ((lang_dirent.d_type == DT_DIR || \
1068 (lang_dirent.d_type == DT_UNKNOWN && \
1069 is_directory(scripts_path, &lang_dirent))) && \
1070 (strcmp(lang_dirent.d_name, ".")) && \
1071 (strcmp(lang_dirent.d_name, "..")))
1072
1073#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
1074 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
1075 script_next) \
1076 if (script_dirent.d_type != DT_DIR && \
1077 (script_dirent.d_type != DT_UNKNOWN || \
1078 !is_directory(lang_path, &script_dirent)))
1079
1080
1081#define RECORD_SUFFIX "-record"
1082#define REPORT_SUFFIX "-report"
1083
1084struct script_desc {
1085 struct list_head node;
1086 char *name;
1087 char *half_liner;
1088 char *args;
1089};
1090
1091static LIST_HEAD(script_descs);
1092
1093static struct script_desc *script_desc__new(const char *name)
1094{
1095 struct script_desc *s = zalloc(sizeof(*s));
1096
1097 if (s != NULL && name)
1098 s->name = strdup(name);
1099
1100 return s;
1101}
1102
1103static void script_desc__delete(struct script_desc *s)
1104{
1105 zfree(&s->name);
1106 zfree(&s->half_liner);
1107 zfree(&s->args);
1108 free(s);
1109}
1110
1111static void script_desc__add(struct script_desc *s)
1112{
1113 list_add_tail(&s->node, &script_descs);
1114}
1115
1116static struct script_desc *script_desc__find(const char *name)
1117{
1118 struct script_desc *s;
1119
1120 list_for_each_entry(s, &script_descs, node)
1121 if (strcasecmp(s->name, name) == 0)
1122 return s;
1123 return NULL;
1124}
1125
1126static struct script_desc *script_desc__findnew(const char *name)
1127{
1128 struct script_desc *s = script_desc__find(name);
1129
1130 if (s)
1131 return s;
1132
1133 s = script_desc__new(name);
1134 if (!s)
1135 goto out_delete_desc;
1136
1137 script_desc__add(s);
1138
1139 return s;
1140
1141out_delete_desc:
1142 script_desc__delete(s);
1143
1144 return NULL;
1145}
1146
1147static const char *ends_with(const char *str, const char *suffix)
1148{
1149 size_t suffix_len = strlen(suffix);
1150 const char *p = str;
1151
1152 if (strlen(str) > suffix_len) {
1153 p = str + strlen(str) - suffix_len;
1154 if (!strncmp(p, suffix, suffix_len))
1155 return p;
1156 }
1157
1158 return NULL;
1159}
1160
1161static int read_script_info(struct script_desc *desc, const char *filename)
1162{
1163 char line[BUFSIZ], *p;
1164 FILE *fp;
1165
1166 fp = fopen(filename, "r");
1167 if (!fp)
1168 return -1;
1169
1170 while (fgets(line, sizeof(line), fp)) {
1171 p = ltrim(line);
1172 if (strlen(p) == 0)
1173 continue;
1174 if (*p != '#')
1175 continue;
1176 p++;
1177 if (strlen(p) && *p == '!')
1178 continue;
1179
1180 p = ltrim(p);
1181 if (strlen(p) && p[strlen(p) - 1] == '\n')
1182 p[strlen(p) - 1] = '\0';
1183
1184 if (!strncmp(p, "description:", strlen("description:"))) {
1185 p += strlen("description:");
1186 desc->half_liner = strdup(ltrim(p));
1187 continue;
1188 }
1189
1190 if (!strncmp(p, "args:", strlen("args:"))) {
1191 p += strlen("args:");
1192 desc->args = strdup(ltrim(p));
1193 continue;
1194 }
1195 }
1196
1197 fclose(fp);
1198
1199 return 0;
1200}
1201
1202static char *get_script_root(struct dirent *script_dirent, const char *suffix)
1203{
1204 char *script_root, *str;
1205
1206 script_root = strdup(script_dirent->d_name);
1207 if (!script_root)
1208 return NULL;
1209
1210 str = (char *)ends_with(script_root, suffix);
1211 if (!str) {
1212 free(script_root);
1213 return NULL;
1214 }
1215
1216 *str = '\0';
1217 return script_root;
1218}
1219
1220static int list_available_scripts(const struct option *opt __maybe_unused,
1221 const char *s __maybe_unused,
1222 int unset __maybe_unused)
1223{
1224 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1225 char scripts_path[MAXPATHLEN];
1226 DIR *scripts_dir, *lang_dir;
1227 char script_path[MAXPATHLEN];
1228 char lang_path[MAXPATHLEN];
1229 struct script_desc *desc;
1230 char first_half[BUFSIZ];
1231 char *script_root;
1232
1233 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1234
1235 scripts_dir = opendir(scripts_path);
1236 if (!scripts_dir)
1237 return -1;
1238
1239 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1240 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1241 lang_dirent.d_name);
1242 lang_dir = opendir(lang_path);
1243 if (!lang_dir)
1244 continue;
1245
1246 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1247 script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
1248 if (script_root) {
1249 desc = script_desc__findnew(script_root);
1250 snprintf(script_path, MAXPATHLEN, "%s/%s",
1251 lang_path, script_dirent.d_name);
1252 read_script_info(desc, script_path);
1253 free(script_root);
1254 }
1255 }
1256 }
1257
1258 fprintf(stdout, "List of available trace scripts:\n");
1259 list_for_each_entry(desc, &script_descs, node) {
1260 sprintf(first_half, "%s %s", desc->name,
1261 desc->args ? desc->args : "");
1262 fprintf(stdout, " %-36s %s\n", first_half,
1263 desc->half_liner ? desc->half_liner : "");
1264 }
1265
1266 exit(0);
1267}
1268
1269/*
1270 * Some scripts specify the required events in their "xxx-record" file,
1271 * this function will check if the events in perf.data match those
1272 * mentioned in the "xxx-record".
1273 *
1274 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1275 * which is covered well now. And new parsing code should be added to
1276 * cover the future complexing formats like event groups etc.
1277 */
1278static int check_ev_match(char *dir_name, char *scriptname,
1279 struct perf_session *session)
1280{
1281 char filename[MAXPATHLEN], evname[128];
1282 char line[BUFSIZ], *p;
1283 struct perf_evsel *pos;
1284 int match, len;
1285 FILE *fp;
1286
1287 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
1288
1289 fp = fopen(filename, "r");
1290 if (!fp)
1291 return -1;
1292
1293 while (fgets(line, sizeof(line), fp)) {
1294 p = ltrim(line);
1295 if (*p == '#')
1296 continue;
1297
1298 while (strlen(p)) {
1299 p = strstr(p, "-e");
1300 if (!p)
1301 break;
1302
1303 p += 2;
1304 p = ltrim(p);
1305 len = strcspn(p, " \t");
1306 if (!len)
1307 break;
1308
1309 snprintf(evname, len + 1, "%s", p);
1310
1311 match = 0;
1312 evlist__for_each(session->evlist, pos) {
1313 if (!strcmp(perf_evsel__name(pos), evname)) {
1314 match = 1;
1315 break;
1316 }
1317 }
1318
1319 if (!match) {
1320 fclose(fp);
1321 return -1;
1322 }
1323 }
1324 }
1325
1326 fclose(fp);
1327 return 0;
1328}
1329
1330/*
1331 * Return -1 if none is found, otherwise the actual scripts number.
1332 *
1333 * Currently the only user of this function is the script browser, which
1334 * will list all statically runnable scripts, select one, execute it and
1335 * show the output in a perf browser.
1336 */
1337int find_scripts(char **scripts_array, char **scripts_path_array)
1338{
1339 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1340 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1341 DIR *scripts_dir, *lang_dir;
1342 struct perf_session *session;
1343 struct perf_data_file file = {
1344 .path = input_name,
1345 .mode = PERF_DATA_MODE_READ,
1346 };
1347 char *temp;
1348 int i = 0;
1349
1350 session = perf_session__new(&file, false, NULL);
1351 if (!session)
1352 return -1;
1353
1354 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1355
1356 scripts_dir = opendir(scripts_path);
1357 if (!scripts_dir) {
1358 perf_session__delete(session);
1359 return -1;
1360 }
1361
1362 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1363 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1364 lang_dirent.d_name);
1365#ifdef NO_LIBPERL
1366 if (strstr(lang_path, "perl"))
1367 continue;
1368#endif
1369#ifdef NO_LIBPYTHON
1370 if (strstr(lang_path, "python"))
1371 continue;
1372#endif
1373
1374 lang_dir = opendir(lang_path);
1375 if (!lang_dir)
1376 continue;
1377
1378 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1379 /* Skip those real time scripts: xxxtop.p[yl] */
1380 if (strstr(script_dirent.d_name, "top."))
1381 continue;
1382 sprintf(scripts_path_array[i], "%s/%s", lang_path,
1383 script_dirent.d_name);
1384 temp = strchr(script_dirent.d_name, '.');
1385 snprintf(scripts_array[i],
1386 (temp - script_dirent.d_name) + 1,
1387 "%s", script_dirent.d_name);
1388
1389 if (check_ev_match(lang_path,
1390 scripts_array[i], session))
1391 continue;
1392
1393 i++;
1394 }
1395 closedir(lang_dir);
1396 }
1397
1398 closedir(scripts_dir);
1399 perf_session__delete(session);
1400 return i;
1401}
1402
1403static char *get_script_path(const char *script_root, const char *suffix)
1404{
1405 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1406 char scripts_path[MAXPATHLEN];
1407 char script_path[MAXPATHLEN];
1408 DIR *scripts_dir, *lang_dir;
1409 char lang_path[MAXPATHLEN];
1410 char *__script_root;
1411
1412 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1413
1414 scripts_dir = opendir(scripts_path);
1415 if (!scripts_dir)
1416 return NULL;
1417
1418 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1419 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1420 lang_dirent.d_name);
1421 lang_dir = opendir(lang_path);
1422 if (!lang_dir)
1423 continue;
1424
1425 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1426 __script_root = get_script_root(&script_dirent, suffix);
1427 if (__script_root && !strcmp(script_root, __script_root)) {
1428 free(__script_root);
1429 closedir(lang_dir);
1430 closedir(scripts_dir);
1431 snprintf(script_path, MAXPATHLEN, "%s/%s",
1432 lang_path, script_dirent.d_name);
1433 return strdup(script_path);
1434 }
1435 free(__script_root);
1436 }
1437 closedir(lang_dir);
1438 }
1439 closedir(scripts_dir);
1440
1441 return NULL;
1442}
1443
1444static bool is_top_script(const char *script_path)
1445{
1446 return ends_with(script_path, "top") == NULL ? false : true;
1447}
1448
1449static int has_required_arg(char *script_path)
1450{
1451 struct script_desc *desc;
1452 int n_args = 0;
1453 char *p;
1454
1455 desc = script_desc__new(NULL);
1456
1457 if (read_script_info(desc, script_path))
1458 goto out;
1459
1460 if (!desc->args)
1461 goto out;
1462
1463 for (p = desc->args; *p; p++)
1464 if (*p == '<')
1465 n_args++;
1466out:
1467 script_desc__delete(desc);
1468
1469 return n_args;
1470}
1471
1472static int have_cmd(int argc, const char **argv)
1473{
1474 char **__argv = malloc(sizeof(const char *) * argc);
1475
1476 if (!__argv) {
1477 pr_err("malloc failed\n");
1478 return -1;
1479 }
1480
1481 memcpy(__argv, argv, sizeof(const char *) * argc);
1482 argc = parse_options(argc, (const char **)__argv, record_options,
1483 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1484 free(__argv);
1485
1486 system_wide = (argc == 0);
1487
1488 return 0;
1489}
1490
1491int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
1492{
1493 bool show_full_info = false;
1494 bool header = false;
1495 bool header_only = false;
1496 char *rec_script_path = NULL;
1497 char *rep_script_path = NULL;
1498 struct perf_session *session;
1499 char *script_path = NULL;
1500 const char **__argv;
1501 int i, j, err;
1502 struct perf_script script = {
1503 .tool = {
1504 .sample = process_sample_event,
1505 .mmap = perf_event__process_mmap,
1506 .mmap2 = perf_event__process_mmap2,
1507 .comm = perf_event__process_comm,
1508 .exit = perf_event__process_exit,
1509 .fork = perf_event__process_fork,
1510 .attr = process_attr,
1511 .tracing_data = perf_event__process_tracing_data,
1512 .build_id = perf_event__process_build_id,
1513 .ordered_samples = true,
1514 .ordering_requires_timestamps = true,
1515 },
1516 };
1517 const struct option options[] = {
1518 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1519 "dump raw trace in ASCII"),
1520 OPT_INCR('v', "verbose", &verbose,
1521 "be more verbose (show symbol address, etc)"),
1522 OPT_BOOLEAN('L', "Latency", &latency_format,
1523 "show latency attributes (irqs/preemption disabled, etc)"),
1524 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1525 list_available_scripts),
1526 OPT_CALLBACK('s', "script", NULL, "name",
1527 "script file name (lang:script name, script name, or *)",
1528 parse_scriptname),
1529 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
1530 "generate perf-script.xx script in specified language"),
1531 OPT_STRING('i', "input", &input_name, "file", "input file name"),
1532 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1533 "do various checks like samples ordering and lost events"),
1534 OPT_BOOLEAN(0, "header", &header, "Show data header."),
1535 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
1536 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1537 "file", "vmlinux pathname"),
1538 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1539 "file", "kallsyms pathname"),
1540 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1541 "When printing symbols do not display call chain"),
1542 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1543 "Look for files with symbols relative to this directory"),
1544 OPT_CALLBACK('f', "fields", NULL, "str",
1545 "comma separated output fields prepend with 'type:'. "
1546 "Valid types: hw,sw,trace,raw. "
1547 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1548 "addr,symoff", parse_output_fields),
1549 OPT_BOOLEAN('a', "all-cpus", &system_wide,
1550 "system-wide collection from all CPUs"),
1551 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1552 "only consider these symbols"),
1553 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1554 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1555 "only display events for these comms"),
1556 OPT_BOOLEAN('I', "show-info", &show_full_info,
1557 "display extended information from perf.data file"),
1558 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
1559 "Show the path of [kernel.kallsyms]"),
1560 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
1561 "Show the fork/comm/exit events"),
1562 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
1563 "Show the mmap events"),
1564 OPT_END()
1565 };
1566 const char * const script_usage[] = {
1567 "perf script [<options>]",
1568 "perf script [<options>] record <script> [<record-options>] <command>",
1569 "perf script [<options>] report <script> [script-args]",
1570 "perf script [<options>] <script> [<record-options>] <command>",
1571 "perf script [<options>] <top-script> [script-args]",
1572 NULL
1573 };
1574 struct perf_data_file file = {
1575 .mode = PERF_DATA_MODE_READ,
1576 };
1577
1578 setup_scripting();
1579
1580 argc = parse_options(argc, argv, options, script_usage,
1581 PARSE_OPT_STOP_AT_NON_OPTION);
1582
1583 file.path = input_name;
1584
1585 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1586 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1587 if (!rec_script_path)
1588 return cmd_record(argc, argv, NULL);
1589 }
1590
1591 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1592 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1593 if (!rep_script_path) {
1594 fprintf(stderr,
1595 "Please specify a valid report script"
1596 "(see 'perf script -l' for listing)\n");
1597 return -1;
1598 }
1599 }
1600
1601 /* make sure PERF_EXEC_PATH is set for scripts */
1602 perf_set_argv_exec_path(perf_exec_path());
1603
1604 if (argc && !script_name && !rec_script_path && !rep_script_path) {
1605 int live_pipe[2];
1606 int rep_args;
1607 pid_t pid;
1608
1609 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1610 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1611
1612 if (!rec_script_path && !rep_script_path) {
1613 fprintf(stderr, " Couldn't find script %s\n\n See perf"
1614 " script -l for available scripts.\n", argv[0]);
1615 usage_with_options(script_usage, options);
1616 }
1617
1618 if (is_top_script(argv[0])) {
1619 rep_args = argc - 1;
1620 } else {
1621 int rec_args;
1622
1623 rep_args = has_required_arg(rep_script_path);
1624 rec_args = (argc - 1) - rep_args;
1625 if (rec_args < 0) {
1626 fprintf(stderr, " %s script requires options."
1627 "\n\n See perf script -l for available "
1628 "scripts and options.\n", argv[0]);
1629 usage_with_options(script_usage, options);
1630 }
1631 }
1632
1633 if (pipe(live_pipe) < 0) {
1634 perror("failed to create pipe");
1635 return -1;
1636 }
1637
1638 pid = fork();
1639 if (pid < 0) {
1640 perror("failed to fork");
1641 return -1;
1642 }
1643
1644 if (!pid) {
1645 j = 0;
1646
1647 dup2(live_pipe[1], 1);
1648 close(live_pipe[0]);
1649
1650 if (is_top_script(argv[0])) {
1651 system_wide = true;
1652 } else if (!system_wide) {
1653 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
1654 err = -1;
1655 goto out;
1656 }
1657 }
1658
1659 __argv = malloc((argc + 6) * sizeof(const char *));
1660 if (!__argv) {
1661 pr_err("malloc failed\n");
1662 err = -ENOMEM;
1663 goto out;
1664 }
1665
1666 __argv[j++] = "/bin/sh";
1667 __argv[j++] = rec_script_path;
1668 if (system_wide)
1669 __argv[j++] = "-a";
1670 __argv[j++] = "-q";
1671 __argv[j++] = "-o";
1672 __argv[j++] = "-";
1673 for (i = rep_args + 1; i < argc; i++)
1674 __argv[j++] = argv[i];
1675 __argv[j++] = NULL;
1676
1677 execvp("/bin/sh", (char **)__argv);
1678 free(__argv);
1679 exit(-1);
1680 }
1681
1682 dup2(live_pipe[0], 0);
1683 close(live_pipe[1]);
1684
1685 __argv = malloc((argc + 4) * sizeof(const char *));
1686 if (!__argv) {
1687 pr_err("malloc failed\n");
1688 err = -ENOMEM;
1689 goto out;
1690 }
1691
1692 j = 0;
1693 __argv[j++] = "/bin/sh";
1694 __argv[j++] = rep_script_path;
1695 for (i = 1; i < rep_args + 1; i++)
1696 __argv[j++] = argv[i];
1697 __argv[j++] = "-i";
1698 __argv[j++] = "-";
1699 __argv[j++] = NULL;
1700
1701 execvp("/bin/sh", (char **)__argv);
1702 free(__argv);
1703 exit(-1);
1704 }
1705
1706 if (rec_script_path)
1707 script_path = rec_script_path;
1708 if (rep_script_path)
1709 script_path = rep_script_path;
1710
1711 if (script_path) {
1712 j = 0;
1713
1714 if (!rec_script_path)
1715 system_wide = false;
1716 else if (!system_wide) {
1717 if (have_cmd(argc - 1, &argv[1]) != 0) {
1718 err = -1;
1719 goto out;
1720 }
1721 }
1722
1723 __argv = malloc((argc + 2) * sizeof(const char *));
1724 if (!__argv) {
1725 pr_err("malloc failed\n");
1726 err = -ENOMEM;
1727 goto out;
1728 }
1729
1730 __argv[j++] = "/bin/sh";
1731 __argv[j++] = script_path;
1732 if (system_wide)
1733 __argv[j++] = "-a";
1734 for (i = 2; i < argc; i++)
1735 __argv[j++] = argv[i];
1736 __argv[j++] = NULL;
1737
1738 execvp("/bin/sh", (char **)__argv);
1739 free(__argv);
1740 exit(-1);
1741 }
1742
1743 if (symbol__init() < 0)
1744 return -1;
1745 if (!script_name)
1746 setup_pager();
1747
1748 session = perf_session__new(&file, false, &script.tool);
1749 if (session == NULL)
1750 return -ENOMEM;
1751
1752 if (header || header_only) {
1753 perf_session__fprintf_info(session, stdout, show_full_info);
1754 if (header_only)
1755 return 0;
1756 }
1757
1758 script.session = session;
1759
1760 if (cpu_list) {
1761 if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
1762 return -1;
1763 }
1764
1765 if (!no_callchain)
1766 symbol_conf.use_callchain = true;
1767 else
1768 symbol_conf.use_callchain = false;
1769
1770 if (generate_script_lang) {
1771 struct stat perf_stat;
1772 int input;
1773
1774 if (output_set_by_user()) {
1775 fprintf(stderr,
1776 "custom fields not supported for generated scripts");
1777 return -1;
1778 }
1779
1780 input = open(file.path, O_RDONLY); /* input_name */
1781 if (input < 0) {
1782 perror("failed to open file");
1783 return -1;
1784 }
1785
1786 err = fstat(input, &perf_stat);
1787 if (err < 0) {
1788 perror("failed to stat file");
1789 return -1;
1790 }
1791
1792 if (!perf_stat.st_size) {
1793 fprintf(stderr, "zero-sized file, nothing to do!\n");
1794 return 0;
1795 }
1796
1797 scripting_ops = script_spec__lookup(generate_script_lang);
1798 if (!scripting_ops) {
1799 fprintf(stderr, "invalid language specifier");
1800 return -1;
1801 }
1802
1803 err = scripting_ops->generate_script(session->tevent.pevent,
1804 "perf-script");
1805 goto out;
1806 }
1807
1808 if (script_name) {
1809 err = scripting_ops->start_script(script_name, argc, argv);
1810 if (err)
1811 goto out;
1812 pr_debug("perf script started with script %s\n\n", script_name);
1813 }
1814
1815
1816 err = perf_session__check_output_opt(session);
1817 if (err < 0)
1818 goto out;
1819
1820 err = __cmd_script(&script);
1821
1822 perf_session__delete(session);
1823 cleanup_scripting();
1824out:
1825 return err;
1826}