perf session: Fix accounting of ordered samples queue
[deliverable/linux.git] / tools / perf / builtin-script.c
CommitLineData
5f9c39dc
FW
1#include "builtin.h"
2
b7eead86 3#include "perf.h"
5f9c39dc 4#include "util/cache.h"
b7eead86
AG
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"
45694aa7 10#include "util/tool.h"
5f9c39dc
FW
11#include "util/symbol.h"
12#include "util/thread.h"
cf72344d 13#include "util/trace-event.h"
b7eead86 14#include "util/util.h"
1424dc96
DA
15#include "util/evlist.h"
16#include "util/evsel.h"
36385be5 17#include "util/sort.h"
f5fc1412 18#include "util/data.h"
5d67be97 19#include <linux/bitmap.h>
5f9c39dc 20
956ffd02
TZ
21static char const *script_name;
22static char const *generate_script_lang;
ffabd99e 23static bool debug_mode;
e1889d75 24static u64 last_timestamp;
6fcf7ddb 25static u64 nr_unordered;
34c86ea9 26extern const struct option record_options[];
c0230b2b 27static bool no_callchain;
47390ae2 28static bool latency_format;
317df650 29static bool system_wide;
5d67be97
AB
30static const char *cpu_list;
31static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
956ffd02 32
745f43e3
DA
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,
787bef17
DA
41 PERF_OUTPUT_IP = 1U << 7,
42 PERF_OUTPUT_SYM = 1U << 8,
610723f2 43 PERF_OUTPUT_DSO = 1U << 9,
7cec0922 44 PERF_OUTPUT_ADDR = 1U << 10,
a978f2ab 45 PERF_OUTPUT_SYMOFFSET = 1U << 11,
cc8fae1d 46 PERF_OUTPUT_SRCLINE = 1U << 12,
745f43e3
DA
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},
787bef17 60 {.str = "ip", .field = PERF_OUTPUT_IP},
c0230b2b 61 {.str = "sym", .field = PERF_OUTPUT_SYM},
610723f2 62 {.str = "dso", .field = PERF_OUTPUT_DSO},
7cec0922 63 {.str = "addr", .field = PERF_OUTPUT_ADDR},
a978f2ab 64 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
cc8fae1d 65 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
745f43e3
DA
66};
67
68/* default set to maintain compatibility with current format */
2c9e45f7
DA
69static struct {
70 bool user_set;
9cbdb702 71 bool wildcard_set;
a6ffaf91 72 unsigned int print_ip_opts;
2c9e45f7
DA
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 |
787bef17 82 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
610723f2 83 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
2c9e45f7
DA
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 |
787bef17 93 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
610723f2 94 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
2c9e45f7
DA
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 },
0817a6a3
AS
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 |
787bef17 112 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
610723f2 113 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
0817a6a3
AS
114
115 .invalid_fields = PERF_OUTPUT_TRACE,
116 },
1424dc96 117};
745f43e3 118
2c9e45f7
DA
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}
745f43e3 128
9cbdb702
DA
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
2c9e45f7 143#define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
1424dc96 144
5bff01f6
ACM
145static int perf_evsel__check_stype(struct perf_evsel *evsel,
146 u64 sample_type, const char *sample_msg,
147 enum perf_output_field field)
1424dc96 148{
5bff01f6 149 struct perf_event_attr *attr = &evsel->attr;
9cbdb702
DA
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) {
5bff01f6 157 evname = perf_evsel__name(evsel);
9cbdb702
DA
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;
5bff01f6 166 evname = perf_evsel__name(evsel);
9cbdb702
DA
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
1424dc96
DA
179 if (PRINT_FIELD(TRACE) &&
180 !perf_session__has_traces(session, "record -R"))
181 return -EINVAL;
182
787bef17 183 if (PRINT_FIELD(IP)) {
5bff01f6
ACM
184 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
185 PERF_OUTPUT_IP))
1424dc96 186 return -EINVAL;
9cbdb702 187
1424dc96 188 if (!no_callchain &&
9cbdb702 189 !(attr->sample_type & PERF_SAMPLE_CALLCHAIN))
1424dc96
DA
190 symbol_conf.use_callchain = false;
191 }
7cec0922
DA
192
193 if (PRINT_FIELD(ADDR) &&
5bff01f6
ACM
194 perf_evsel__check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
195 PERF_OUTPUT_ADDR))
7cec0922
DA
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");
787bef17
DA
202 return -EINVAL;
203 }
a978f2ab
AN
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 }
7cec0922
DA
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");
610723f2
DA
213 return -EINVAL;
214 }
cc8fae1d
AH
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 }
1424dc96
DA
220
221 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
5bff01f6
ACM
222 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
223 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
1424dc96 224 return -EINVAL;
1424dc96
DA
225
226 if (PRINT_FIELD(TIME) &&
5bff01f6
ACM
227 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
228 PERF_OUTPUT_TIME))
1424dc96 229 return -EINVAL;
1424dc96
DA
230
231 if (PRINT_FIELD(CPU) &&
5bff01f6
ACM
232 perf_evsel__check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
233 PERF_OUTPUT_CPU))
1424dc96 234 return -EINVAL;
9cbdb702
DA
235
236 return 0;
237}
238
7ea95727
AH
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;
cc8fae1d
AH
255
256 if (PRINT_FIELD(SRCLINE))
257 output[type].print_ip_opts |= PRINT_IP_OPT_SRCLINE;
7ea95727
AH
258}
259
9cbdb702
DA
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;
a6ffaf91
DA
286
287 if (evsel == NULL)
288 continue;
289
7ea95727 290 set_print_ip_opts(&evsel->attr);
1424dc96
DA
291 }
292
80b8b496
DA
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:
1424dc96
DA
317 return 0;
318}
745f43e3 319
fcf65bf1 320static void print_sample_start(struct perf_sample *sample,
1424dc96 321 struct thread *thread,
5bff01f6 322 struct perf_evsel *evsel)
c70c94b4 323{
5bff01f6 324 struct perf_event_attr *attr = &evsel->attr;
c70c94b4
DA
325 unsigned long secs;
326 unsigned long usecs;
745f43e3
DA
327 unsigned long long nsecs;
328
329 if (PRINT_FIELD(COMM)) {
330 if (latency_format)
b9c5143a 331 printf("%8.8s ", thread__comm_str(thread));
787bef17 332 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
b9c5143a 333 printf("%s ", thread__comm_str(thread));
745f43e3 334 else
b9c5143a 335 printf("%16s ", thread__comm_str(thread));
745f43e3 336 }
c70c94b4 337
745f43e3
DA
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 }
c70c94b4 351
745f43e3
DA
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 }
c70c94b4
DA
359}
360
95582596
AN
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
7cec0922
DA
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
95582596
AN
376 if (is_bts_event(attr))
377 return true;
378
7cec0922
DA
379 return false;
380}
381
382static void print_sample_addr(union perf_event *event,
383 struct perf_sample *sample,
743eb868 384 struct machine *machine,
7cec0922
DA
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;
7cec0922
DA
390
391 printf("%16" PRIx64, sample->addr);
392
393 if (!sample_addr_correlates_sym(attr))
394 return;
395
743eb868 396 thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
326f59bf 397 sample->addr, &al);
7cec0922 398 if (!al.map)
743eb868 399 thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE,
326f59bf 400 sample->addr, &al);
7cec0922
DA
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)) {
547a92e0 409 printf(" ");
a978f2ab
AN
410 if (PRINT_FIELD(SYMOFFSET))
411 symbol__fprintf_symname_offs(al.sym, &al, stdout);
412 else
413 symbol__fprintf_symname(al.sym, stdout);
7cec0922
DA
414 }
415
416 if (PRINT_FIELD(DSO)) {
547a92e0
AN
417 printf(" (");
418 map__fprintf_dsoname(al.map, stdout);
419 printf(")");
7cec0922
DA
420 }
421}
422
95582596
AN
423static void print_sample_bts(union perf_event *event,
424 struct perf_sample *sample,
425 struct perf_evsel *evsel,
a2cb3cf2
AH
426 struct thread *thread,
427 struct addr_location *al)
95582596
AN
428{
429 struct perf_event_attr *attr = &evsel->attr;
8066be5f 430 bool print_srcline_last = false;
95582596
AN
431
432 /* print branch_from information */
433 if (PRINT_FIELD(IP)) {
8066be5f
AH
434 unsigned int print_opts = output[attr->type].print_ip_opts;
435
436 if (symbol_conf.use_callchain && sample->callchain) {
95582596 437 printf("\n");
8066be5f
AH
438 } else {
439 printf(" ");
440 if (print_opts & PRINT_IP_OPT_SRCLINE) {
441 print_srcline_last = true;
442 print_opts &= ~PRINT_IP_OPT_SRCLINE;
443 }
444 }
445 perf_evsel__print_ip(evsel, sample, al, print_opts,
307cbb92 446 PERF_MAX_STACK_DEPTH);
95582596
AN
447 }
448
95582596 449 /* print branch_to information */
243be3dd
AH
450 if (PRINT_FIELD(ADDR) ||
451 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
578bea40
AH
452 !output[attr->type].user_set)) {
453 printf(" => ");
cc22e575 454 print_sample_addr(event, sample, al->machine, thread, attr);
578bea40 455 }
95582596 456
8066be5f
AH
457 if (print_srcline_last)
458 map__fprintf_srcline(al->map, al->addr, "\n ", stdout);
459
95582596
AN
460 printf("\n");
461}
462
97822433 463static void process_event(union perf_event *event, struct perf_sample *sample,
cc22e575 464 struct perf_evsel *evsel, struct thread *thread,
a2cb3cf2 465 struct addr_location *al)
be6d842a 466{
9e69c210 467 struct perf_event_attr *attr = &evsel->attr;
1424dc96 468
2c9e45f7 469 if (output[attr->type].fields == 0)
1424dc96
DA
470 return;
471
fcf65bf1 472 print_sample_start(sample, thread, evsel);
745f43e3 473
e944d3d7
NK
474 if (PRINT_FIELD(EVNAME)) {
475 const char *evname = perf_evsel__name(evsel);
476 printf("%s: ", evname ? evname : "[unknown]");
477 }
478
95582596 479 if (is_bts_event(attr)) {
cc22e575 480 print_sample_bts(event, sample, evsel, thread, al);
95582596
AN
481 return;
482 }
483
745f43e3 484 if (PRINT_FIELD(TRACE))
fcf65bf1
ACM
485 event_format__print(evsel->tp_format, sample->cpu,
486 sample->raw_data, sample->raw_size);
7cec0922 487 if (PRINT_FIELD(ADDR))
cc22e575 488 print_sample_addr(event, sample, al->machine, thread, attr);
7cec0922 489
787bef17 490 if (PRINT_FIELD(IP)) {
c0230b2b
DA
491 if (!symbol_conf.use_callchain)
492 printf(" ");
493 else
494 printf("\n");
a6ffaf91 495
cc22e575 496 perf_evsel__print_ip(evsel, sample, al,
307cbb92
DA
497 output[attr->type].print_ip_opts,
498 PERF_MAX_STACK_DEPTH);
c0230b2b
DA
499 }
500
c70c94b4 501 printf("\n");
be6d842a
DA
502}
503
1d037ca1
IT
504static int default_start_script(const char *script __maybe_unused,
505 int argc __maybe_unused,
506 const char **argv __maybe_unused)
956ffd02
TZ
507{
508 return 0;
509}
510
511static int default_stop_script(void)
512{
513 return 0;
514}
515
1d037ca1
IT
516static int default_generate_script(struct pevent *pevent __maybe_unused,
517 const char *outfile __maybe_unused)
956ffd02
TZ
518{
519 return 0;
520}
521
522static struct scripting_ops default_scripting_ops = {
523 .start_script = default_start_script,
524 .stop_script = default_stop_script,
be6d842a 525 .process_event = process_event,
956ffd02
TZ
526 .generate_script = default_generate_script,
527};
528
529static struct scripting_ops *scripting_ops;
530
531static void setup_scripting(void)
532{
16c632de 533 setup_perl_scripting();
7e4b21b8 534 setup_python_scripting();
16c632de 535
956ffd02
TZ
536 scripting_ops = &default_scripting_ops;
537}
538
539static int cleanup_scripting(void)
540{
133dc4c3 541 pr_debug("\nperf script stopped\n");
3824a4e8 542
956ffd02
TZ
543 return scripting_ops->stop_script();
544}
545
1d037ca1 546static int process_sample_event(struct perf_tool *tool __maybe_unused,
d20deb64 547 union perf_event *event,
8115d60c 548 struct perf_sample *sample,
9e69c210 549 struct perf_evsel *evsel,
743eb868 550 struct machine *machine)
5f9c39dc 551{
e7984b7b 552 struct addr_location al;
ef89325f
AH
553 struct thread *thread = machine__findnew_thread(machine, sample->pid,
554 sample->tid);
6ddf259d 555
5f9c39dc 556 if (thread == NULL) {
6beba7ad
ACM
557 pr_debug("problem processing %d event, skipping it.\n",
558 event->header.type);
5f9c39dc
FW
559 return -1;
560 }
561
1424dc96
DA
562 if (debug_mode) {
563 if (sample->time < last_timestamp) {
564 pr_err("Samples misordered, previous: %" PRIu64
565 " this: %" PRIu64 "\n", last_timestamp,
566 sample->time);
567 nr_unordered++;
e1889d75 568 }
1424dc96
DA
569 last_timestamp = sample->time;
570 return 0;
5f9c39dc 571 }
5d67be97 572
e44baa3e 573 if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
e7984b7b
DA
574 pr_err("problem processing %d event, skipping it.\n",
575 event->header.type);
576 return -1;
577 }
578
579 if (al.filtered)
580 return 0;
581
5d67be97
AB
582 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
583 return 0;
584
cc22e575 585 scripting_ops->process_event(event, sample, evsel, thread, &al);
5f9c39dc 586
743eb868 587 evsel->hists.stats.total_period += sample->period;
5f9c39dc
FW
588 return 0;
589}
590
6f3e5eda
AH
591struct perf_script {
592 struct perf_tool tool;
593 struct perf_session *session;
ad7ebb9a 594 bool show_task_events;
ba1ddf42 595 bool show_mmap_events;
016e92fb
FW
596};
597
7ea95727
AH
598static int process_attr(struct perf_tool *tool, union perf_event *event,
599 struct perf_evlist **pevlist)
600{
601 struct perf_script *scr = container_of(tool, struct perf_script, tool);
602 struct perf_evlist *evlist;
603 struct perf_evsel *evsel, *pos;
604 int err;
605
606 err = perf_event__process_attr(tool, event, pevlist);
607 if (err)
608 return err;
609
610 evlist = *pevlist;
611 evsel = perf_evlist__last(*pevlist);
612
613 if (evsel->attr.type >= PERF_TYPE_MAX)
614 return 0;
615
0050f7aa 616 evlist__for_each(evlist, pos) {
7ea95727
AH
617 if (pos->attr.type == evsel->attr.type && pos != evsel)
618 return 0;
619 }
620
621 set_print_ip_opts(&evsel->attr);
622
623 return perf_evsel__check_attr(evsel, scr->session);
624}
625
ad7ebb9a
NK
626static int process_comm_event(struct perf_tool *tool,
627 union perf_event *event,
628 struct perf_sample *sample,
629 struct machine *machine)
630{
631 struct thread *thread;
632 struct perf_script *script = container_of(tool, struct perf_script, tool);
633 struct perf_session *session = script->session;
634 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
635 int ret = -1;
636
637 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
638 if (thread == NULL) {
639 pr_debug("problem processing COMM event, skipping it.\n");
640 return -1;
641 }
642
643 if (perf_event__process_comm(tool, event, sample, machine) < 0)
644 goto out;
645
646 if (!evsel->attr.sample_id_all) {
647 sample->cpu = 0;
648 sample->time = 0;
649 sample->tid = event->comm.tid;
650 sample->pid = event->comm.pid;
651 }
652 print_sample_start(sample, thread, evsel);
653 perf_event__fprintf(event, stdout);
654 ret = 0;
655
656out:
657 return ret;
658}
659
660static int process_fork_event(struct perf_tool *tool,
661 union perf_event *event,
662 struct perf_sample *sample,
663 struct machine *machine)
664{
665 struct thread *thread;
666 struct perf_script *script = container_of(tool, struct perf_script, tool);
667 struct perf_session *session = script->session;
668 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
669
670 if (perf_event__process_fork(tool, event, sample, machine) < 0)
671 return -1;
672
673 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
674 if (thread == NULL) {
675 pr_debug("problem processing FORK event, skipping it.\n");
676 return -1;
677 }
678
679 if (!evsel->attr.sample_id_all) {
680 sample->cpu = 0;
681 sample->time = event->fork.time;
682 sample->tid = event->fork.tid;
683 sample->pid = event->fork.pid;
684 }
685 print_sample_start(sample, thread, evsel);
686 perf_event__fprintf(event, stdout);
687
688 return 0;
689}
690static int process_exit_event(struct perf_tool *tool,
691 union perf_event *event,
692 struct perf_sample *sample,
693 struct machine *machine)
694{
695 struct thread *thread;
696 struct perf_script *script = container_of(tool, struct perf_script, tool);
697 struct perf_session *session = script->session;
698 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
699
700 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
701 if (thread == NULL) {
702 pr_debug("problem processing EXIT event, skipping it.\n");
703 return -1;
704 }
705
706 if (!evsel->attr.sample_id_all) {
707 sample->cpu = 0;
708 sample->time = 0;
709 sample->tid = event->comm.tid;
710 sample->pid = event->comm.pid;
711 }
712 print_sample_start(sample, thread, evsel);
713 perf_event__fprintf(event, stdout);
714
715 if (perf_event__process_exit(tool, event, sample, machine) < 0)
716 return -1;
717
718 return 0;
719}
720
ba1ddf42
NK
721static int process_mmap_event(struct perf_tool *tool,
722 union perf_event *event,
723 struct perf_sample *sample,
724 struct machine *machine)
725{
726 struct thread *thread;
727 struct perf_script *script = container_of(tool, struct perf_script, tool);
728 struct perf_session *session = script->session;
729 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
730
731 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
732 return -1;
733
734 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
735 if (thread == NULL) {
736 pr_debug("problem processing MMAP event, skipping it.\n");
737 return -1;
738 }
739
740 if (!evsel->attr.sample_id_all) {
741 sample->cpu = 0;
742 sample->time = 0;
743 sample->tid = event->mmap.tid;
744 sample->pid = event->mmap.pid;
745 }
746 print_sample_start(sample, thread, evsel);
747 perf_event__fprintf(event, stdout);
748
749 return 0;
750}
751
752static int process_mmap2_event(struct perf_tool *tool,
753 union perf_event *event,
754 struct perf_sample *sample,
755 struct machine *machine)
756{
757 struct thread *thread;
758 struct perf_script *script = container_of(tool, struct perf_script, tool);
759 struct perf_session *session = script->session;
760 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
761
762 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
763 return -1;
764
765 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
766 if (thread == NULL) {
767 pr_debug("problem processing MMAP2 event, skipping it.\n");
768 return -1;
769 }
770
771 if (!evsel->attr.sample_id_all) {
772 sample->cpu = 0;
773 sample->time = 0;
774 sample->tid = event->mmap2.tid;
775 sample->pid = event->mmap2.pid;
776 }
777 print_sample_start(sample, thread, evsel);
778 perf_event__fprintf(event, stdout);
779
780 return 0;
781}
782
1d037ca1 783static void sig_handler(int sig __maybe_unused)
c239da3b
TZ
784{
785 session_done = 1;
786}
787
6f3e5eda 788static int __cmd_script(struct perf_script *script)
5f9c39dc 789{
6fcf7ddb
FW
790 int ret;
791
c239da3b
TZ
792 signal(SIGINT, sig_handler);
793
ad7ebb9a
NK
794 /* override event processing functions */
795 if (script->show_task_events) {
796 script->tool.comm = process_comm_event;
797 script->tool.fork = process_fork_event;
798 script->tool.exit = process_exit_event;
799 }
ba1ddf42
NK
800 if (script->show_mmap_events) {
801 script->tool.mmap = process_mmap_event;
802 script->tool.mmap2 = process_mmap2_event;
803 }
ad7ebb9a 804
6f3e5eda 805 ret = perf_session__process_events(script->session, &script->tool);
6fcf7ddb 806
6d8afb56 807 if (debug_mode)
9486aa38 808 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
6fcf7ddb
FW
809
810 return ret;
5f9c39dc
FW
811}
812
956ffd02
TZ
813struct script_spec {
814 struct list_head node;
815 struct scripting_ops *ops;
816 char spec[0];
817};
818
eccdfe2d 819static LIST_HEAD(script_specs);
956ffd02
TZ
820
821static struct script_spec *script_spec__new(const char *spec,
822 struct scripting_ops *ops)
823{
824 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
825
826 if (s != NULL) {
827 strcpy(s->spec, spec);
828 s->ops = ops;
829 }
830
831 return s;
832}
833
956ffd02
TZ
834static void script_spec__add(struct script_spec *s)
835{
836 list_add_tail(&s->node, &script_specs);
837}
838
839static struct script_spec *script_spec__find(const char *spec)
840{
841 struct script_spec *s;
842
843 list_for_each_entry(s, &script_specs, node)
844 if (strcasecmp(s->spec, spec) == 0)
845 return s;
846 return NULL;
847}
848
849static struct script_spec *script_spec__findnew(const char *spec,
850 struct scripting_ops *ops)
851{
852 struct script_spec *s = script_spec__find(spec);
853
854 if (s)
855 return s;
856
857 s = script_spec__new(spec, ops);
858 if (!s)
466e2876 859 return NULL;
956ffd02
TZ
860
861 script_spec__add(s);
862
863 return s;
956ffd02
TZ
864}
865
866int script_spec_register(const char *spec, struct scripting_ops *ops)
867{
868 struct script_spec *s;
869
870 s = script_spec__find(spec);
871 if (s)
872 return -1;
873
874 s = script_spec__findnew(spec, ops);
875 if (!s)
876 return -1;
877
878 return 0;
879}
880
881static struct scripting_ops *script_spec__lookup(const char *spec)
882{
883 struct script_spec *s = script_spec__find(spec);
884 if (!s)
885 return NULL;
886
887 return s->ops;
888}
889
890static void list_available_languages(void)
891{
892 struct script_spec *s;
893
894 fprintf(stderr, "\n");
895 fprintf(stderr, "Scripting language extensions (used in "
133dc4c3 896 "perf script -s [spec:]script.[spec]):\n\n");
956ffd02
TZ
897
898 list_for_each_entry(s, &script_specs, node)
899 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
900
901 fprintf(stderr, "\n");
902}
903
1d037ca1
IT
904static int parse_scriptname(const struct option *opt __maybe_unused,
905 const char *str, int unset __maybe_unused)
956ffd02
TZ
906{
907 char spec[PATH_MAX];
908 const char *script, *ext;
909 int len;
910
f526d68b 911 if (strcmp(str, "lang") == 0) {
956ffd02 912 list_available_languages();
f526d68b 913 exit(0);
956ffd02
TZ
914 }
915
916 script = strchr(str, ':');
917 if (script) {
918 len = script - str;
919 if (len >= PATH_MAX) {
920 fprintf(stderr, "invalid language specifier");
921 return -1;
922 }
923 strncpy(spec, str, len);
924 spec[len] = '\0';
925 scripting_ops = script_spec__lookup(spec);
926 if (!scripting_ops) {
927 fprintf(stderr, "invalid language specifier");
928 return -1;
929 }
930 script++;
931 } else {
932 script = str;
d1e95bb5 933 ext = strrchr(script, '.');
956ffd02
TZ
934 if (!ext) {
935 fprintf(stderr, "invalid script extension");
936 return -1;
937 }
938 scripting_ops = script_spec__lookup(++ext);
939 if (!scripting_ops) {
940 fprintf(stderr, "invalid script extension");
941 return -1;
942 }
943 }
944
945 script_name = strdup(script);
946
947 return 0;
948}
949
1d037ca1
IT
950static int parse_output_fields(const struct option *opt __maybe_unused,
951 const char *arg, int unset __maybe_unused)
745f43e3
DA
952{
953 char *tok;
50ca19ae 954 int i, imax = ARRAY_SIZE(all_output_options);
2c9e45f7 955 int j;
745f43e3
DA
956 int rc = 0;
957 char *str = strdup(arg);
1424dc96 958 int type = -1;
745f43e3
DA
959
960 if (!str)
961 return -ENOMEM;
962
2c9e45f7
DA
963 /* first word can state for which event type the user is specifying
964 * the fields. If no type exists, the specified fields apply to all
965 * event types found in the file minus the invalid fields for a type.
1424dc96 966 */
2c9e45f7
DA
967 tok = strchr(str, ':');
968 if (tok) {
969 *tok = '\0';
970 tok++;
971 if (!strcmp(str, "hw"))
972 type = PERF_TYPE_HARDWARE;
973 else if (!strcmp(str, "sw"))
974 type = PERF_TYPE_SOFTWARE;
975 else if (!strcmp(str, "trace"))
976 type = PERF_TYPE_TRACEPOINT;
0817a6a3
AS
977 else if (!strcmp(str, "raw"))
978 type = PERF_TYPE_RAW;
2c9e45f7
DA
979 else {
980 fprintf(stderr, "Invalid event type in field string.\n");
38efb539
RR
981 rc = -EINVAL;
982 goto out;
2c9e45f7
DA
983 }
984
985 if (output[type].user_set)
986 pr_warning("Overriding previous field request for %s events.\n",
987 event_type(type));
988
989 output[type].fields = 0;
990 output[type].user_set = true;
9cbdb702 991 output[type].wildcard_set = false;
2c9e45f7
DA
992
993 } else {
994 tok = str;
995 if (strlen(str) == 0) {
996 fprintf(stderr,
997 "Cannot set fields to 'none' for all event types.\n");
998 rc = -EINVAL;
999 goto out;
1000 }
1001
1002 if (output_set_by_user())
1003 pr_warning("Overriding previous field request for all events.\n");
1004
1005 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1006 output[j].fields = 0;
1007 output[j].user_set = true;
9cbdb702 1008 output[j].wildcard_set = true;
2c9e45f7 1009 }
745f43e3
DA
1010 }
1011
2c9e45f7
DA
1012 tok = strtok(tok, ",");
1013 while (tok) {
745f43e3 1014 for (i = 0; i < imax; ++i) {
2c9e45f7 1015 if (strcmp(tok, all_output_options[i].str) == 0)
745f43e3 1016 break;
745f43e3
DA
1017 }
1018 if (i == imax) {
2c9e45f7 1019 fprintf(stderr, "Invalid field requested.\n");
745f43e3 1020 rc = -EINVAL;
2c9e45f7 1021 goto out;
745f43e3
DA
1022 }
1023
2c9e45f7
DA
1024 if (type == -1) {
1025 /* add user option to all events types for
1026 * which it is valid
1027 */
1028 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1029 if (output[j].invalid_fields & all_output_options[i].field) {
1030 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
1031 all_output_options[i].str, event_type(j));
1032 } else
1033 output[j].fields |= all_output_options[i].field;
1034 }
1035 } else {
1036 if (output[type].invalid_fields & all_output_options[i].field) {
1037 fprintf(stderr, "\'%s\' not valid for %s events.\n",
1038 all_output_options[i].str, event_type(type));
1039
1040 rc = -EINVAL;
1041 goto out;
1042 }
1043 output[type].fields |= all_output_options[i].field;
1044 }
1045
1046 tok = strtok(NULL, ",");
745f43e3
DA
1047 }
1048
2c9e45f7
DA
1049 if (type >= 0) {
1050 if (output[type].fields == 0) {
1051 pr_debug("No fields requested for %s type. "
1052 "Events will not be displayed.\n", event_type(type));
1053 }
1054 }
745f43e3 1055
2c9e45f7 1056out:
745f43e3
DA
1057 free(str);
1058 return rc;
1059}
1060
008f29d3
SB
1061/* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1062static int is_directory(const char *base_path, const struct dirent *dent)
1063{
1064 char path[PATH_MAX];
1065 struct stat st;
1066
1067 sprintf(path, "%s/%s", base_path, dent->d_name);
1068 if (stat(path, &st))
1069 return 0;
1070
1071 return S_ISDIR(st.st_mode);
1072}
1073
1074#define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
4b9c0c59
TZ
1075 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
1076 lang_next) \
008f29d3
SB
1077 if ((lang_dirent.d_type == DT_DIR || \
1078 (lang_dirent.d_type == DT_UNKNOWN && \
1079 is_directory(scripts_path, &lang_dirent))) && \
4b9c0c59
TZ
1080 (strcmp(lang_dirent.d_name, ".")) && \
1081 (strcmp(lang_dirent.d_name, "..")))
1082
008f29d3 1083#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
4b9c0c59
TZ
1084 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
1085 script_next) \
008f29d3
SB
1086 if (script_dirent.d_type != DT_DIR && \
1087 (script_dirent.d_type != DT_UNKNOWN || \
1088 !is_directory(lang_path, &script_dirent)))
4b9c0c59
TZ
1089
1090
1091#define RECORD_SUFFIX "-record"
1092#define REPORT_SUFFIX "-report"
1093
1094struct script_desc {
1095 struct list_head node;
1096 char *name;
1097 char *half_liner;
1098 char *args;
1099};
1100
eccdfe2d 1101static LIST_HEAD(script_descs);
4b9c0c59
TZ
1102
1103static struct script_desc *script_desc__new(const char *name)
1104{
1105 struct script_desc *s = zalloc(sizeof(*s));
1106
b5b87312 1107 if (s != NULL && name)
4b9c0c59
TZ
1108 s->name = strdup(name);
1109
1110 return s;
1111}
1112
1113static void script_desc__delete(struct script_desc *s)
1114{
74cf249d
ACM
1115 zfree(&s->name);
1116 zfree(&s->half_liner);
1117 zfree(&s->args);
4b9c0c59
TZ
1118 free(s);
1119}
1120
1121static void script_desc__add(struct script_desc *s)
1122{
1123 list_add_tail(&s->node, &script_descs);
1124}
1125
1126static struct script_desc *script_desc__find(const char *name)
1127{
1128 struct script_desc *s;
1129
1130 list_for_each_entry(s, &script_descs, node)
1131 if (strcasecmp(s->name, name) == 0)
1132 return s;
1133 return NULL;
1134}
1135
1136static struct script_desc *script_desc__findnew(const char *name)
1137{
1138 struct script_desc *s = script_desc__find(name);
1139
1140 if (s)
1141 return s;
1142
1143 s = script_desc__new(name);
1144 if (!s)
1145 goto out_delete_desc;
1146
1147 script_desc__add(s);
1148
1149 return s;
1150
1151out_delete_desc:
1152 script_desc__delete(s);
1153
1154 return NULL;
1155}
1156
965bb6be 1157static const char *ends_with(const char *str, const char *suffix)
4b9c0c59
TZ
1158{
1159 size_t suffix_len = strlen(suffix);
965bb6be 1160 const char *p = str;
4b9c0c59
TZ
1161
1162 if (strlen(str) > suffix_len) {
1163 p = str + strlen(str) - suffix_len;
1164 if (!strncmp(p, suffix, suffix_len))
1165 return p;
1166 }
1167
1168 return NULL;
1169}
1170
4b9c0c59
TZ
1171static int read_script_info(struct script_desc *desc, const char *filename)
1172{
1173 char line[BUFSIZ], *p;
1174 FILE *fp;
1175
1176 fp = fopen(filename, "r");
1177 if (!fp)
1178 return -1;
1179
1180 while (fgets(line, sizeof(line), fp)) {
1181 p = ltrim(line);
1182 if (strlen(p) == 0)
1183 continue;
1184 if (*p != '#')
1185 continue;
1186 p++;
1187 if (strlen(p) && *p == '!')
1188 continue;
1189
1190 p = ltrim(p);
1191 if (strlen(p) && p[strlen(p) - 1] == '\n')
1192 p[strlen(p) - 1] = '\0';
1193
1194 if (!strncmp(p, "description:", strlen("description:"))) {
1195 p += strlen("description:");
1196 desc->half_liner = strdup(ltrim(p));
1197 continue;
1198 }
1199
1200 if (!strncmp(p, "args:", strlen("args:"))) {
1201 p += strlen("args:");
1202 desc->args = strdup(ltrim(p));
1203 continue;
1204 }
1205 }
1206
1207 fclose(fp);
1208
1209 return 0;
1210}
1211
38efb539
RR
1212static char *get_script_root(struct dirent *script_dirent, const char *suffix)
1213{
1214 char *script_root, *str;
1215
1216 script_root = strdup(script_dirent->d_name);
1217 if (!script_root)
1218 return NULL;
1219
1220 str = (char *)ends_with(script_root, suffix);
1221 if (!str) {
1222 free(script_root);
1223 return NULL;
1224 }
1225
1226 *str = '\0';
1227 return script_root;
1228}
1229
1d037ca1
IT
1230static int list_available_scripts(const struct option *opt __maybe_unused,
1231 const char *s __maybe_unused,
1232 int unset __maybe_unused)
4b9c0c59
TZ
1233{
1234 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1235 char scripts_path[MAXPATHLEN];
1236 DIR *scripts_dir, *lang_dir;
1237 char script_path[MAXPATHLEN];
1238 char lang_path[MAXPATHLEN];
1239 struct script_desc *desc;
1240 char first_half[BUFSIZ];
1241 char *script_root;
4b9c0c59
TZ
1242
1243 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1244
1245 scripts_dir = opendir(scripts_path);
1246 if (!scripts_dir)
1247 return -1;
1248
008f29d3 1249 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
4b9c0c59
TZ
1250 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1251 lang_dirent.d_name);
1252 lang_dir = opendir(lang_path);
1253 if (!lang_dir)
1254 continue;
1255
008f29d3 1256 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
38efb539
RR
1257 script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
1258 if (script_root) {
4b9c0c59
TZ
1259 desc = script_desc__findnew(script_root);
1260 snprintf(script_path, MAXPATHLEN, "%s/%s",
1261 lang_path, script_dirent.d_name);
1262 read_script_info(desc, script_path);
38efb539 1263 free(script_root);
4b9c0c59 1264 }
4b9c0c59
TZ
1265 }
1266 }
1267
1268 fprintf(stdout, "List of available trace scripts:\n");
1269 list_for_each_entry(desc, &script_descs, node) {
1270 sprintf(first_half, "%s %s", desc->name,
1271 desc->args ? desc->args : "");
1272 fprintf(stdout, " %-36s %s\n", first_half,
1273 desc->half_liner ? desc->half_liner : "");
1274 }
1275
1276 exit(0);
1277}
1278
49e639e2
FT
1279/*
1280 * Some scripts specify the required events in their "xxx-record" file,
1281 * this function will check if the events in perf.data match those
1282 * mentioned in the "xxx-record".
1283 *
1284 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1285 * which is covered well now. And new parsing code should be added to
1286 * cover the future complexing formats like event groups etc.
1287 */
1288static int check_ev_match(char *dir_name, char *scriptname,
1289 struct perf_session *session)
1290{
1291 char filename[MAXPATHLEN], evname[128];
1292 char line[BUFSIZ], *p;
1293 struct perf_evsel *pos;
1294 int match, len;
1295 FILE *fp;
1296
1297 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
1298
1299 fp = fopen(filename, "r");
1300 if (!fp)
1301 return -1;
1302
1303 while (fgets(line, sizeof(line), fp)) {
1304 p = ltrim(line);
1305 if (*p == '#')
1306 continue;
1307
1308 while (strlen(p)) {
1309 p = strstr(p, "-e");
1310 if (!p)
1311 break;
1312
1313 p += 2;
1314 p = ltrim(p);
1315 len = strcspn(p, " \t");
1316 if (!len)
1317 break;
1318
1319 snprintf(evname, len + 1, "%s", p);
1320
1321 match = 0;
0050f7aa 1322 evlist__for_each(session->evlist, pos) {
49e639e2
FT
1323 if (!strcmp(perf_evsel__name(pos), evname)) {
1324 match = 1;
1325 break;
1326 }
1327 }
1328
1329 if (!match) {
1330 fclose(fp);
1331 return -1;
1332 }
1333 }
1334 }
1335
1336 fclose(fp);
1337 return 0;
1338}
1339
e5f3705e
FT
1340/*
1341 * Return -1 if none is found, otherwise the actual scripts number.
1342 *
1343 * Currently the only user of this function is the script browser, which
1344 * will list all statically runnable scripts, select one, execute it and
1345 * show the output in a perf browser.
1346 */
1347int find_scripts(char **scripts_array, char **scripts_path_array)
1348{
1349 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
49e639e2 1350 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
e5f3705e 1351 DIR *scripts_dir, *lang_dir;
49e639e2 1352 struct perf_session *session;
f5fc1412
JO
1353 struct perf_data_file file = {
1354 .path = input_name,
1355 .mode = PERF_DATA_MODE_READ,
1356 };
e5f3705e
FT
1357 char *temp;
1358 int i = 0;
1359
f5fc1412 1360 session = perf_session__new(&file, false, NULL);
49e639e2
FT
1361 if (!session)
1362 return -1;
1363
e5f3705e
FT
1364 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1365
1366 scripts_dir = opendir(scripts_path);
49e639e2
FT
1367 if (!scripts_dir) {
1368 perf_session__delete(session);
e5f3705e 1369 return -1;
49e639e2 1370 }
e5f3705e
FT
1371
1372 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1373 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1374 lang_dirent.d_name);
1375#ifdef NO_LIBPERL
1376 if (strstr(lang_path, "perl"))
1377 continue;
1378#endif
1379#ifdef NO_LIBPYTHON
1380 if (strstr(lang_path, "python"))
1381 continue;
1382#endif
1383
1384 lang_dir = opendir(lang_path);
1385 if (!lang_dir)
1386 continue;
1387
1388 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1389 /* Skip those real time scripts: xxxtop.p[yl] */
1390 if (strstr(script_dirent.d_name, "top."))
1391 continue;
1392 sprintf(scripts_path_array[i], "%s/%s", lang_path,
1393 script_dirent.d_name);
1394 temp = strchr(script_dirent.d_name, '.');
1395 snprintf(scripts_array[i],
1396 (temp - script_dirent.d_name) + 1,
1397 "%s", script_dirent.d_name);
49e639e2
FT
1398
1399 if (check_ev_match(lang_path,
1400 scripts_array[i], session))
1401 continue;
1402
e5f3705e
FT
1403 i++;
1404 }
49e639e2 1405 closedir(lang_dir);
e5f3705e
FT
1406 }
1407
49e639e2
FT
1408 closedir(scripts_dir);
1409 perf_session__delete(session);
e5f3705e
FT
1410 return i;
1411}
1412
3875294f
TZ
1413static char *get_script_path(const char *script_root, const char *suffix)
1414{
1415 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1416 char scripts_path[MAXPATHLEN];
1417 char script_path[MAXPATHLEN];
1418 DIR *scripts_dir, *lang_dir;
1419 char lang_path[MAXPATHLEN];
38efb539 1420 char *__script_root;
3875294f
TZ
1421
1422 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1423
1424 scripts_dir = opendir(scripts_path);
1425 if (!scripts_dir)
1426 return NULL;
1427
008f29d3 1428 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
3875294f
TZ
1429 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1430 lang_dirent.d_name);
1431 lang_dir = opendir(lang_path);
1432 if (!lang_dir)
1433 continue;
1434
008f29d3 1435 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
38efb539
RR
1436 __script_root = get_script_root(&script_dirent, suffix);
1437 if (__script_root && !strcmp(script_root, __script_root)) {
1438 free(__script_root);
946ef2a2
NK
1439 closedir(lang_dir);
1440 closedir(scripts_dir);
3875294f
TZ
1441 snprintf(script_path, MAXPATHLEN, "%s/%s",
1442 lang_path, script_dirent.d_name);
38efb539 1443 return strdup(script_path);
3875294f
TZ
1444 }
1445 free(__script_root);
1446 }
946ef2a2 1447 closedir(lang_dir);
3875294f 1448 }
946ef2a2 1449 closedir(scripts_dir);
3875294f 1450
38efb539 1451 return NULL;
3875294f
TZ
1452}
1453
b5b87312
TZ
1454static bool is_top_script(const char *script_path)
1455{
965bb6be 1456 return ends_with(script_path, "top") == NULL ? false : true;
b5b87312
TZ
1457}
1458
1459static int has_required_arg(char *script_path)
1460{
1461 struct script_desc *desc;
1462 int n_args = 0;
1463 char *p;
1464
1465 desc = script_desc__new(NULL);
1466
1467 if (read_script_info(desc, script_path))
1468 goto out;
1469
1470 if (!desc->args)
1471 goto out;
1472
1473 for (p = desc->args; *p; p++)
1474 if (*p == '<')
1475 n_args++;
1476out:
1477 script_desc__delete(desc);
1478
1479 return n_args;
1480}
1481
69b6470e
ACM
1482static int have_cmd(int argc, const char **argv)
1483{
1484 char **__argv = malloc(sizeof(const char *) * argc);
1485
1486 if (!__argv) {
1487 pr_err("malloc failed\n");
1488 return -1;
1489 }
1490
1491 memcpy(__argv, argv, sizeof(const char *) * argc);
1492 argc = parse_options(argc, (const char **)__argv, record_options,
1493 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1494 free(__argv);
5f9c39dc 1495
69b6470e
ACM
1496 system_wide = (argc == 0);
1497
1498 return 0;
1499}
1500
1501int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
1502{
1503 bool show_full_info = false;
e90debdd
JO
1504 bool header = false;
1505 bool header_only = false;
69b6470e
ACM
1506 char *rec_script_path = NULL;
1507 char *rep_script_path = NULL;
1508 struct perf_session *session;
1509 char *script_path = NULL;
1510 const char **__argv;
1511 int i, j, err;
6f3e5eda
AH
1512 struct perf_script script = {
1513 .tool = {
1514 .sample = process_sample_event,
1515 .mmap = perf_event__process_mmap,
1516 .mmap2 = perf_event__process_mmap2,
1517 .comm = perf_event__process_comm,
1518 .exit = perf_event__process_exit,
1519 .fork = perf_event__process_fork,
7ea95727 1520 .attr = process_attr,
6f3e5eda
AH
1521 .tracing_data = perf_event__process_tracing_data,
1522 .build_id = perf_event__process_build_id,
1523 .ordered_samples = true,
1524 .ordering_requires_timestamps = true,
1525 },
1526 };
69b6470e 1527 const struct option options[] = {
5f9c39dc
FW
1528 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1529 "dump raw trace in ASCII"),
c0555642 1530 OPT_INCR('v', "verbose", &verbose,
69b6470e 1531 "be more verbose (show symbol address, etc)"),
4b9c0c59 1532 OPT_BOOLEAN('L', "Latency", &latency_format,
cda48461 1533 "show latency attributes (irqs/preemption disabled, etc)"),
4b9c0c59
TZ
1534 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1535 list_available_scripts),
956ffd02
TZ
1536 OPT_CALLBACK('s', "script", NULL, "name",
1537 "script file name (lang:script name, script name, or *)",
1538 parse_scriptname),
1539 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
133dc4c3 1540 "generate perf-script.xx script in specified language"),
69b6470e 1541 OPT_STRING('i', "input", &input_name, "file", "input file name"),
ffabd99e
FW
1542 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1543 "do various checks like samples ordering and lost events"),
e90debdd
JO
1544 OPT_BOOLEAN(0, "header", &header, "Show data header."),
1545 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
c0230b2b
DA
1546 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1547 "file", "vmlinux pathname"),
1548 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1549 "file", "kallsyms pathname"),
1550 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1551 "When printing symbols do not display call chain"),
1552 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1553 "Look for files with symbols relative to this directory"),
745f43e3 1554 OPT_CALLBACK('f', "fields", NULL, "str",
a978f2ab
AN
1555 "comma separated output fields prepend with 'type:'. "
1556 "Valid types: hw,sw,trace,raw. "
1557 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
69b6470e 1558 "addr,symoff", parse_output_fields),
317df650 1559 OPT_BOOLEAN('a', "all-cpus", &system_wide,
69b6470e 1560 "system-wide collection from all CPUs"),
36385be5
FT
1561 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1562 "only consider these symbols"),
c8e66720 1563 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
e7984b7b
DA
1564 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1565 "only display events for these comms"),
fbe96f29
SE
1566 OPT_BOOLEAN('I', "show-info", &show_full_info,
1567 "display extended information from perf.data file"),
0bc8d205
AN
1568 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
1569 "Show the path of [kernel.kallsyms]"),
ad7ebb9a
NK
1570 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
1571 "Show the fork/comm/exit events"),
ba1ddf42
NK
1572 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
1573 "Show the mmap events"),
1909629f 1574 OPT_END()
69b6470e
ACM
1575 };
1576 const char * const script_usage[] = {
1577 "perf script [<options>]",
1578 "perf script [<options>] record <script> [<record-options>] <command>",
1579 "perf script [<options>] report <script> [script-args]",
1580 "perf script [<options>] <script> [<record-options>] <command>",
1581 "perf script [<options>] <top-script> [script-args]",
1582 NULL
1583 };
f5fc1412
JO
1584 struct perf_data_file file = {
1585 .mode = PERF_DATA_MODE_READ,
1586 };
3875294f 1587
b5b87312
TZ
1588 setup_scripting();
1589
133dc4c3 1590 argc = parse_options(argc, argv, options, script_usage,
b5b87312
TZ
1591 PARSE_OPT_STOP_AT_NON_OPTION);
1592
f5fc1412
JO
1593 file.path = input_name;
1594
b5b87312
TZ
1595 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1596 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1597 if (!rec_script_path)
1598 return cmd_record(argc, argv, NULL);
3875294f
TZ
1599 }
1600
b5b87312
TZ
1601 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1602 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1603 if (!rep_script_path) {
3875294f 1604 fprintf(stderr,
b5b87312 1605 "Please specify a valid report script"
133dc4c3 1606 "(see 'perf script -l' for listing)\n");
3875294f
TZ
1607 return -1;
1608 }
3875294f
TZ
1609 }
1610
44e668c6
BH
1611 /* make sure PERF_EXEC_PATH is set for scripts */
1612 perf_set_argv_exec_path(perf_exec_path());
1613
b5b87312 1614 if (argc && !script_name && !rec_script_path && !rep_script_path) {
a0cccc2e 1615 int live_pipe[2];
b5b87312 1616 int rep_args;
a0cccc2e
TZ
1617 pid_t pid;
1618
b5b87312
TZ
1619 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1620 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1621
1622 if (!rec_script_path && !rep_script_path) {
1623 fprintf(stderr, " Couldn't find script %s\n\n See perf"
133dc4c3
IM
1624 " script -l for available scripts.\n", argv[0]);
1625 usage_with_options(script_usage, options);
a0cccc2e
TZ
1626 }
1627
b5b87312
TZ
1628 if (is_top_script(argv[0])) {
1629 rep_args = argc - 1;
1630 } else {
1631 int rec_args;
1632
1633 rep_args = has_required_arg(rep_script_path);
1634 rec_args = (argc - 1) - rep_args;
1635 if (rec_args < 0) {
1636 fprintf(stderr, " %s script requires options."
133dc4c3 1637 "\n\n See perf script -l for available "
b5b87312 1638 "scripts and options.\n", argv[0]);
133dc4c3 1639 usage_with_options(script_usage, options);
b5b87312 1640 }
a0cccc2e
TZ
1641 }
1642
1643 if (pipe(live_pipe) < 0) {
1644 perror("failed to create pipe");
d54b1a9e 1645 return -1;
a0cccc2e
TZ
1646 }
1647
1648 pid = fork();
1649 if (pid < 0) {
1650 perror("failed to fork");
d54b1a9e 1651 return -1;
a0cccc2e
TZ
1652 }
1653
1654 if (!pid) {
b5b87312
TZ
1655 j = 0;
1656
a0cccc2e
TZ
1657 dup2(live_pipe[1], 1);
1658 close(live_pipe[0]);
1659
317df650
RR
1660 if (is_top_script(argv[0])) {
1661 system_wide = true;
1662 } else if (!system_wide) {
d54b1a9e
DA
1663 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
1664 err = -1;
1665 goto out;
1666 }
317df650 1667 }
b5b87312
TZ
1668
1669 __argv = malloc((argc + 6) * sizeof(const char *));
d54b1a9e
DA
1670 if (!__argv) {
1671 pr_err("malloc failed\n");
1672 err = -ENOMEM;
1673 goto out;
1674 }
e8719adf 1675
b5b87312
TZ
1676 __argv[j++] = "/bin/sh";
1677 __argv[j++] = rec_script_path;
1678 if (system_wide)
1679 __argv[j++] = "-a";
1680 __argv[j++] = "-q";
1681 __argv[j++] = "-o";
1682 __argv[j++] = "-";
1683 for (i = rep_args + 1; i < argc; i++)
1684 __argv[j++] = argv[i];
1685 __argv[j++] = NULL;
a0cccc2e
TZ
1686
1687 execvp("/bin/sh", (char **)__argv);
e8719adf 1688 free(__argv);
a0cccc2e
TZ
1689 exit(-1);
1690 }
1691
1692 dup2(live_pipe[0], 0);
1693 close(live_pipe[1]);
1694
b5b87312 1695 __argv = malloc((argc + 4) * sizeof(const char *));
d54b1a9e
DA
1696 if (!__argv) {
1697 pr_err("malloc failed\n");
1698 err = -ENOMEM;
1699 goto out;
1700 }
1701
b5b87312
TZ
1702 j = 0;
1703 __argv[j++] = "/bin/sh";
1704 __argv[j++] = rep_script_path;
1705 for (i = 1; i < rep_args + 1; i++)
1706 __argv[j++] = argv[i];
1707 __argv[j++] = "-i";
1708 __argv[j++] = "-";
1709 __argv[j++] = NULL;
a0cccc2e
TZ
1710
1711 execvp("/bin/sh", (char **)__argv);
e8719adf 1712 free(__argv);
a0cccc2e
TZ
1713 exit(-1);
1714 }
1715
b5b87312
TZ
1716 if (rec_script_path)
1717 script_path = rec_script_path;
1718 if (rep_script_path)
1719 script_path = rep_script_path;
34c86ea9 1720
b5b87312 1721 if (script_path) {
b5b87312 1722 j = 0;
3875294f 1723
317df650
RR
1724 if (!rec_script_path)
1725 system_wide = false;
d54b1a9e
DA
1726 else if (!system_wide) {
1727 if (have_cmd(argc - 1, &argv[1]) != 0) {
1728 err = -1;
1729 goto out;
1730 }
1731 }
34c86ea9 1732
b5b87312 1733 __argv = malloc((argc + 2) * sizeof(const char *));
d54b1a9e
DA
1734 if (!__argv) {
1735 pr_err("malloc failed\n");
1736 err = -ENOMEM;
1737 goto out;
1738 }
1739
34c86ea9
TZ
1740 __argv[j++] = "/bin/sh";
1741 __argv[j++] = script_path;
1742 if (system_wide)
1743 __argv[j++] = "-a";
b5b87312 1744 for (i = 2; i < argc; i++)
34c86ea9
TZ
1745 __argv[j++] = argv[i];
1746 __argv[j++] = NULL;
3875294f
TZ
1747
1748 execvp("/bin/sh", (char **)__argv);
e8719adf 1749 free(__argv);
3875294f
TZ
1750 exit(-1);
1751 }
956ffd02 1752
655000e7
ACM
1753 if (symbol__init() < 0)
1754 return -1;
cf4fee50
TZ
1755 if (!script_name)
1756 setup_pager();
5f9c39dc 1757
6f3e5eda 1758 session = perf_session__new(&file, false, &script.tool);
d8f66248
ACM
1759 if (session == NULL)
1760 return -ENOMEM;
1761
e90debdd
JO
1762 if (header || header_only) {
1763 perf_session__fprintf_info(session, stdout, show_full_info);
1764 if (header_only)
1765 return 0;
1766 }
1767
6f3e5eda
AH
1768 script.session = session;
1769
5d67be97
AB
1770 if (cpu_list) {
1771 if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
1772 return -1;
1773 }
1774
1424dc96 1775 if (!no_callchain)
c0230b2b
DA
1776 symbol_conf.use_callchain = true;
1777 else
1778 symbol_conf.use_callchain = false;
1779
956ffd02
TZ
1780 if (generate_script_lang) {
1781 struct stat perf_stat;
745f43e3
DA
1782 int input;
1783
2c9e45f7 1784 if (output_set_by_user()) {
745f43e3
DA
1785 fprintf(stderr,
1786 "custom fields not supported for generated scripts");
1787 return -1;
1788 }
956ffd02 1789
cc9784bd 1790 input = open(file.path, O_RDONLY); /* input_name */
956ffd02
TZ
1791 if (input < 0) {
1792 perror("failed to open file");
d54b1a9e 1793 return -1;
956ffd02
TZ
1794 }
1795
1796 err = fstat(input, &perf_stat);
1797 if (err < 0) {
1798 perror("failed to stat file");
d54b1a9e 1799 return -1;
956ffd02
TZ
1800 }
1801
1802 if (!perf_stat.st_size) {
1803 fprintf(stderr, "zero-sized file, nothing to do!\n");
d54b1a9e 1804 return 0;
956ffd02
TZ
1805 }
1806
1807 scripting_ops = script_spec__lookup(generate_script_lang);
1808 if (!scripting_ops) {
1809 fprintf(stderr, "invalid language specifier");
1810 return -1;
1811 }
1812
29f5ffd3 1813 err = scripting_ops->generate_script(session->tevent.pevent,
da378962 1814 "perf-script");
956ffd02
TZ
1815 goto out;
1816 }
1817
1818 if (script_name) {
586bc5cc 1819 err = scripting_ops->start_script(script_name, argc, argv);
956ffd02
TZ
1820 if (err)
1821 goto out;
133dc4c3 1822 pr_debug("perf script started with script %s\n\n", script_name);
956ffd02
TZ
1823 }
1824
9cbdb702
DA
1825
1826 err = perf_session__check_output_opt(session);
1827 if (err < 0)
1828 goto out;
1829
6f3e5eda 1830 err = __cmd_script(&script);
956ffd02 1831
d8f66248 1832 perf_session__delete(session);
956ffd02
TZ
1833 cleanup_scripting();
1834out:
1835 return err;
5f9c39dc 1836}
This page took 0.305589 seconds and 5 git commands to generate.