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/perf_regs.h" 10 #include "util/session.h" 11 #include "util/tool.h" 12 #include "util/symbol.h" 13 #include "util/thread.h" 14 #include "util/trace-event.h" 15 #include "util/util.h" 16 #include "util/evlist.h" 17 #include "util/evsel.h" 18 #include "util/sort.h" 19 #include "util/data.h" 20 #include "util/auxtrace.h" 21 #include <linux/bitmap.h> 22 23 static char const *script_name; 24 static char const *generate_script_lang; 25 static bool debug_mode; 26 static u64 last_timestamp; 27 static u64 nr_unordered; 28 static bool no_callchain; 29 static bool latency_format; 30 static bool system_wide; 31 static bool print_flags; 32 static bool nanosecs; 33 static const char *cpu_list; 34 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); 35 36 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH; 37 38 enum perf_output_field { 39 PERF_OUTPUT_COMM = 1U << 0, 40 PERF_OUTPUT_TID = 1U << 1, 41 PERF_OUTPUT_PID = 1U << 2, 42 PERF_OUTPUT_TIME = 1U << 3, 43 PERF_OUTPUT_CPU = 1U << 4, 44 PERF_OUTPUT_EVNAME = 1U << 5, 45 PERF_OUTPUT_TRACE = 1U << 6, 46 PERF_OUTPUT_IP = 1U << 7, 47 PERF_OUTPUT_SYM = 1U << 8, 48 PERF_OUTPUT_DSO = 1U << 9, 49 PERF_OUTPUT_ADDR = 1U << 10, 50 PERF_OUTPUT_SYMOFFSET = 1U << 11, 51 PERF_OUTPUT_SRCLINE = 1U << 12, 52 PERF_OUTPUT_PERIOD = 1U << 13, 53 PERF_OUTPUT_IREGS = 1U << 14, 54 PERF_OUTPUT_BRSTACK = 1U << 15, 55 PERF_OUTPUT_BRSTACKSYM = 1U << 16, 56 }; 57 58 struct output_option { 59 const char *str; 60 enum perf_output_field field; 61 } all_output_options[] = { 62 {.str = "comm", .field = PERF_OUTPUT_COMM}, 63 {.str = "tid", .field = PERF_OUTPUT_TID}, 64 {.str = "pid", .field = PERF_OUTPUT_PID}, 65 {.str = "time", .field = PERF_OUTPUT_TIME}, 66 {.str = "cpu", .field = PERF_OUTPUT_CPU}, 67 {.str = "event", .field = PERF_OUTPUT_EVNAME}, 68 {.str = "trace", .field = PERF_OUTPUT_TRACE}, 69 {.str = "ip", .field = PERF_OUTPUT_IP}, 70 {.str = "sym", .field = PERF_OUTPUT_SYM}, 71 {.str = "dso", .field = PERF_OUTPUT_DSO}, 72 {.str = "addr", .field = PERF_OUTPUT_ADDR}, 73 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET}, 74 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE}, 75 {.str = "period", .field = PERF_OUTPUT_PERIOD}, 76 {.str = "iregs", .field = PERF_OUTPUT_IREGS}, 77 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK}, 78 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM}, 79 }; 80 81 /* default set to maintain compatibility with current format */ 82 static struct { 83 bool user_set; 84 bool wildcard_set; 85 unsigned int print_ip_opts; 86 u64 fields; 87 u64 invalid_fields; 88 } output[PERF_TYPE_MAX] = { 89 90 [PERF_TYPE_HARDWARE] = { 91 .user_set = false, 92 93 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | 94 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | 95 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP | 96 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO | 97 PERF_OUTPUT_PERIOD, 98 99 .invalid_fields = PERF_OUTPUT_TRACE, 100 }, 101 102 [PERF_TYPE_SOFTWARE] = { 103 .user_set = false, 104 105 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | 106 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | 107 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP | 108 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO | 109 PERF_OUTPUT_PERIOD, 110 111 .invalid_fields = PERF_OUTPUT_TRACE, 112 }, 113 114 [PERF_TYPE_TRACEPOINT] = { 115 .user_set = false, 116 117 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | 118 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | 119 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE, 120 }, 121 122 [PERF_TYPE_RAW] = { 123 .user_set = false, 124 125 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | 126 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | 127 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP | 128 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO | 129 PERF_OUTPUT_PERIOD, 130 131 .invalid_fields = PERF_OUTPUT_TRACE, 132 }, 133 }; 134 135 static bool output_set_by_user(void) 136 { 137 int j; 138 for (j = 0; j < PERF_TYPE_MAX; ++j) { 139 if (output[j].user_set) 140 return true; 141 } 142 return false; 143 } 144 145 static const char *output_field2str(enum perf_output_field field) 146 { 147 int i, imax = ARRAY_SIZE(all_output_options); 148 const char *str = ""; 149 150 for (i = 0; i < imax; ++i) { 151 if (all_output_options[i].field == field) { 152 str = all_output_options[i].str; 153 break; 154 } 155 } 156 return str; 157 } 158 159 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x) 160 161 static int perf_evsel__do_check_stype(struct perf_evsel *evsel, 162 u64 sample_type, const char *sample_msg, 163 enum perf_output_field field, 164 bool allow_user_set) 165 { 166 struct perf_event_attr *attr = &evsel->attr; 167 int type = attr->type; 168 const char *evname; 169 170 if (attr->sample_type & sample_type) 171 return 0; 172 173 if (output[type].user_set) { 174 if (allow_user_set) 175 return 0; 176 evname = perf_evsel__name(evsel); 177 pr_err("Samples for '%s' event do not have %s attribute set. " 178 "Cannot print '%s' field.\n", 179 evname, sample_msg, output_field2str(field)); 180 return -1; 181 } 182 183 /* user did not ask for it explicitly so remove from the default list */ 184 output[type].fields &= ~field; 185 evname = perf_evsel__name(evsel); 186 pr_debug("Samples for '%s' event do not have %s attribute set. " 187 "Skipping '%s' field.\n", 188 evname, sample_msg, output_field2str(field)); 189 190 return 0; 191 } 192 193 static int perf_evsel__check_stype(struct perf_evsel *evsel, 194 u64 sample_type, const char *sample_msg, 195 enum perf_output_field field) 196 { 197 return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field, 198 false); 199 } 200 201 static int perf_evsel__check_attr(struct perf_evsel *evsel, 202 struct perf_session *session) 203 { 204 struct perf_event_attr *attr = &evsel->attr; 205 bool allow_user_set; 206 207 allow_user_set = perf_header__has_feat(&session->header, 208 HEADER_AUXTRACE); 209 210 if (PRINT_FIELD(TRACE) && 211 !perf_session__has_traces(session, "record -R")) 212 return -EINVAL; 213 214 if (PRINT_FIELD(IP)) { 215 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", 216 PERF_OUTPUT_IP)) 217 return -EINVAL; 218 } 219 220 if (PRINT_FIELD(ADDR) && 221 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", 222 PERF_OUTPUT_ADDR, allow_user_set)) 223 return -EINVAL; 224 225 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) { 226 pr_err("Display of symbols requested but neither sample IP nor " 227 "sample address\nis selected. Hence, no addresses to convert " 228 "to symbols.\n"); 229 return -EINVAL; 230 } 231 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) { 232 pr_err("Display of offsets requested but symbol is not" 233 "selected.\n"); 234 return -EINVAL; 235 } 236 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) { 237 pr_err("Display of DSO requested but neither sample IP nor " 238 "sample address\nis selected. Hence, no addresses to convert " 239 "to DSO.\n"); 240 return -EINVAL; 241 } 242 if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) { 243 pr_err("Display of source line number requested but sample IP is not\n" 244 "selected. Hence, no address to lookup the source line number.\n"); 245 return -EINVAL; 246 } 247 248 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) && 249 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", 250 PERF_OUTPUT_TID|PERF_OUTPUT_PID)) 251 return -EINVAL; 252 253 if (PRINT_FIELD(TIME) && 254 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", 255 PERF_OUTPUT_TIME)) 256 return -EINVAL; 257 258 if (PRINT_FIELD(CPU) && 259 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", 260 PERF_OUTPUT_CPU, allow_user_set)) 261 return -EINVAL; 262 263 if (PRINT_FIELD(PERIOD) && 264 perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD", 265 PERF_OUTPUT_PERIOD)) 266 return -EINVAL; 267 268 if (PRINT_FIELD(IREGS) && 269 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", 270 PERF_OUTPUT_IREGS)) 271 return -EINVAL; 272 273 return 0; 274 } 275 276 static void set_print_ip_opts(struct perf_event_attr *attr) 277 { 278 unsigned int type = attr->type; 279 280 output[type].print_ip_opts = 0; 281 if (PRINT_FIELD(IP)) 282 output[type].print_ip_opts |= PRINT_IP_OPT_IP; 283 284 if (PRINT_FIELD(SYM)) 285 output[type].print_ip_opts |= PRINT_IP_OPT_SYM; 286 287 if (PRINT_FIELD(DSO)) 288 output[type].print_ip_opts |= PRINT_IP_OPT_DSO; 289 290 if (PRINT_FIELD(SYMOFFSET)) 291 output[type].print_ip_opts |= PRINT_IP_OPT_SYMOFFSET; 292 293 if (PRINT_FIELD(SRCLINE)) 294 output[type].print_ip_opts |= PRINT_IP_OPT_SRCLINE; 295 } 296 297 /* 298 * verify all user requested events exist and the samples 299 * have the expected data 300 */ 301 static int perf_session__check_output_opt(struct perf_session *session) 302 { 303 int j; 304 struct perf_evsel *evsel; 305 306 for (j = 0; j < PERF_TYPE_MAX; ++j) { 307 evsel = perf_session__find_first_evtype(session, j); 308 309 /* 310 * even if fields is set to 0 (ie., show nothing) event must 311 * exist if user explicitly includes it on the command line 312 */ 313 if (!evsel && output[j].user_set && !output[j].wildcard_set) { 314 pr_err("%s events do not exist. " 315 "Remove corresponding -f option to proceed.\n", 316 event_type(j)); 317 return -1; 318 } 319 320 if (evsel && output[j].fields && 321 perf_evsel__check_attr(evsel, session)) 322 return -1; 323 324 if (evsel == NULL) 325 continue; 326 327 set_print_ip_opts(&evsel->attr); 328 } 329 330 if (!no_callchain) { 331 bool use_callchain = false; 332 333 evlist__for_each(session->evlist, evsel) { 334 if (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) { 335 use_callchain = true; 336 break; 337 } 338 } 339 if (!use_callchain) 340 symbol_conf.use_callchain = false; 341 } 342 343 /* 344 * set default for tracepoints to print symbols only 345 * if callchains are present 346 */ 347 if (symbol_conf.use_callchain && 348 !output[PERF_TYPE_TRACEPOINT].user_set) { 349 struct perf_event_attr *attr; 350 351 j = PERF_TYPE_TRACEPOINT; 352 evsel = perf_session__find_first_evtype(session, j); 353 if (evsel == NULL) 354 goto out; 355 356 attr = &evsel->attr; 357 358 if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) { 359 output[j].fields |= PERF_OUTPUT_IP; 360 output[j].fields |= PERF_OUTPUT_SYM; 361 output[j].fields |= PERF_OUTPUT_DSO; 362 set_print_ip_opts(attr); 363 } 364 } 365 366 out: 367 return 0; 368 } 369 370 static void print_sample_iregs(union perf_event *event __maybe_unused, 371 struct perf_sample *sample, 372 struct thread *thread __maybe_unused, 373 struct perf_event_attr *attr) 374 { 375 struct regs_dump *regs = &sample->intr_regs; 376 uint64_t mask = attr->sample_regs_intr; 377 unsigned i = 0, r; 378 379 if (!regs) 380 return; 381 382 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) { 383 u64 val = regs->regs[i++]; 384 printf("%5s:0x%"PRIx64" ", perf_reg_name(r), val); 385 } 386 } 387 388 static void print_sample_start(struct perf_sample *sample, 389 struct thread *thread, 390 struct perf_evsel *evsel) 391 { 392 struct perf_event_attr *attr = &evsel->attr; 393 unsigned long secs; 394 unsigned long usecs; 395 unsigned long long nsecs; 396 397 if (PRINT_FIELD(COMM)) { 398 if (latency_format) 399 printf("%8.8s ", thread__comm_str(thread)); 400 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain) 401 printf("%s ", thread__comm_str(thread)); 402 else 403 printf("%16s ", thread__comm_str(thread)); 404 } 405 406 if (PRINT_FIELD(PID) && PRINT_FIELD(TID)) 407 printf("%5d/%-5d ", sample->pid, sample->tid); 408 else if (PRINT_FIELD(PID)) 409 printf("%5d ", sample->pid); 410 else if (PRINT_FIELD(TID)) 411 printf("%5d ", sample->tid); 412 413 if (PRINT_FIELD(CPU)) { 414 if (latency_format) 415 printf("%3d ", sample->cpu); 416 else 417 printf("[%03d] ", sample->cpu); 418 } 419 420 if (PRINT_FIELD(TIME)) { 421 nsecs = sample->time; 422 secs = nsecs / NSECS_PER_SEC; 423 nsecs -= secs * NSECS_PER_SEC; 424 usecs = nsecs / NSECS_PER_USEC; 425 if (nanosecs) 426 printf("%5lu.%09llu: ", secs, nsecs); 427 else 428 printf("%5lu.%06lu: ", secs, usecs); 429 } 430 } 431 432 static inline char 433 mispred_str(struct branch_entry *br) 434 { 435 if (!(br->flags.mispred || br->flags.predicted)) 436 return '-'; 437 438 return br->flags.predicted ? 'P' : 'M'; 439 } 440 441 static void print_sample_brstack(union perf_event *event __maybe_unused, 442 struct perf_sample *sample, 443 struct thread *thread __maybe_unused, 444 struct perf_event_attr *attr __maybe_unused) 445 { 446 struct branch_stack *br = sample->branch_stack; 447 u64 i; 448 449 if (!(br && br->nr)) 450 return; 451 452 for (i = 0; i < br->nr; i++) { 453 printf(" 0x%"PRIx64"/0x%"PRIx64"/%c/%c/%c/%d ", 454 br->entries[i].from, 455 br->entries[i].to, 456 mispred_str( br->entries + i), 457 br->entries[i].flags.in_tx? 'X' : '-', 458 br->entries[i].flags.abort? 'A' : '-', 459 br->entries[i].flags.cycles); 460 } 461 } 462 463 static void print_sample_brstacksym(union perf_event *event __maybe_unused, 464 struct perf_sample *sample, 465 struct thread *thread __maybe_unused, 466 struct perf_event_attr *attr __maybe_unused) 467 { 468 struct branch_stack *br = sample->branch_stack; 469 struct addr_location alf, alt; 470 u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK; 471 u64 i, from, to; 472 473 if (!(br && br->nr)) 474 return; 475 476 for (i = 0; i < br->nr; i++) { 477 478 memset(&alf, 0, sizeof(alf)); 479 memset(&alt, 0, sizeof(alt)); 480 from = br->entries[i].from; 481 to = br->entries[i].to; 482 483 thread__find_addr_map(thread, cpumode, MAP__FUNCTION, from, &alf); 484 if (alf.map) 485 alf.sym = map__find_symbol(alf.map, alf.addr, NULL); 486 487 thread__find_addr_map(thread, cpumode, MAP__FUNCTION, to, &alt); 488 if (alt.map) 489 alt.sym = map__find_symbol(alt.map, alt.addr, NULL); 490 491 symbol__fprintf_symname_offs(alf.sym, &alf, stdout); 492 putchar('/'); 493 symbol__fprintf_symname_offs(alt.sym, &alt, stdout); 494 printf("/%c/%c/%c/%d ", 495 mispred_str( br->entries + i), 496 br->entries[i].flags.in_tx? 'X' : '-', 497 br->entries[i].flags.abort? 'A' : '-', 498 br->entries[i].flags.cycles); 499 } 500 } 501 502 503 static void print_sample_addr(union perf_event *event, 504 struct perf_sample *sample, 505 struct thread *thread, 506 struct perf_event_attr *attr) 507 { 508 struct addr_location al; 509 510 printf("%16" PRIx64, sample->addr); 511 512 if (!sample_addr_correlates_sym(attr)) 513 return; 514 515 perf_event__preprocess_sample_addr(event, sample, thread, &al); 516 517 if (PRINT_FIELD(SYM)) { 518 printf(" "); 519 if (PRINT_FIELD(SYMOFFSET)) 520 symbol__fprintf_symname_offs(al.sym, &al, stdout); 521 else 522 symbol__fprintf_symname(al.sym, stdout); 523 } 524 525 if (PRINT_FIELD(DSO)) { 526 printf(" ("); 527 map__fprintf_dsoname(al.map, stdout); 528 printf(")"); 529 } 530 } 531 532 static void print_sample_bts(union perf_event *event, 533 struct perf_sample *sample, 534 struct perf_evsel *evsel, 535 struct thread *thread, 536 struct addr_location *al) 537 { 538 struct perf_event_attr *attr = &evsel->attr; 539 bool print_srcline_last = false; 540 541 /* print branch_from information */ 542 if (PRINT_FIELD(IP)) { 543 unsigned int print_opts = output[attr->type].print_ip_opts; 544 545 if (symbol_conf.use_callchain && sample->callchain) { 546 printf("\n"); 547 } else { 548 printf(" "); 549 if (print_opts & PRINT_IP_OPT_SRCLINE) { 550 print_srcline_last = true; 551 print_opts &= ~PRINT_IP_OPT_SRCLINE; 552 } 553 } 554 perf_evsel__print_ip(evsel, sample, al, print_opts, 555 scripting_max_stack); 556 } 557 558 /* print branch_to information */ 559 if (PRINT_FIELD(ADDR) || 560 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) && 561 !output[attr->type].user_set)) { 562 printf(" => "); 563 print_sample_addr(event, sample, thread, attr); 564 } 565 566 if (print_srcline_last) 567 map__fprintf_srcline(al->map, al->addr, "\n ", stdout); 568 569 printf("\n"); 570 } 571 572 static void print_sample_flags(u32 flags) 573 { 574 const char *chars = PERF_IP_FLAG_CHARS; 575 const int n = strlen(PERF_IP_FLAG_CHARS); 576 char str[33]; 577 int i, pos = 0; 578 579 for (i = 0; i < n; i++, flags >>= 1) { 580 if (flags & 1) 581 str[pos++] = chars[i]; 582 } 583 for (; i < 32; i++, flags >>= 1) { 584 if (flags & 1) 585 str[pos++] = '?'; 586 } 587 str[pos] = 0; 588 printf(" %-4s ", str); 589 } 590 591 static void process_event(union perf_event *event, struct perf_sample *sample, 592 struct perf_evsel *evsel, struct addr_location *al) 593 { 594 struct thread *thread = al->thread; 595 struct perf_event_attr *attr = &evsel->attr; 596 597 if (output[attr->type].fields == 0) 598 return; 599 600 print_sample_start(sample, thread, evsel); 601 602 if (PRINT_FIELD(PERIOD)) 603 printf("%10" PRIu64 " ", sample->period); 604 605 if (PRINT_FIELD(EVNAME)) { 606 const char *evname = perf_evsel__name(evsel); 607 printf("%s: ", evname ? evname : "[unknown]"); 608 } 609 610 if (print_flags) 611 print_sample_flags(sample->flags); 612 613 if (is_bts_event(attr)) { 614 print_sample_bts(event, sample, evsel, thread, al); 615 return; 616 } 617 618 if (PRINT_FIELD(TRACE)) 619 event_format__print(evsel->tp_format, sample->cpu, 620 sample->raw_data, sample->raw_size); 621 if (PRINT_FIELD(ADDR)) 622 print_sample_addr(event, sample, thread, attr); 623 624 if (PRINT_FIELD(IP)) { 625 if (!symbol_conf.use_callchain) 626 printf(" "); 627 else 628 printf("\n"); 629 630 perf_evsel__print_ip(evsel, sample, al, 631 output[attr->type].print_ip_opts, 632 scripting_max_stack); 633 } 634 635 if (PRINT_FIELD(IREGS)) 636 print_sample_iregs(event, sample, thread, attr); 637 638 if (PRINT_FIELD(BRSTACK)) 639 print_sample_brstack(event, sample, thread, attr); 640 else if (PRINT_FIELD(BRSTACKSYM)) 641 print_sample_brstacksym(event, sample, thread, attr); 642 643 printf("\n"); 644 } 645 646 static int default_start_script(const char *script __maybe_unused, 647 int argc __maybe_unused, 648 const char **argv __maybe_unused) 649 { 650 return 0; 651 } 652 653 static int default_flush_script(void) 654 { 655 return 0; 656 } 657 658 static int default_stop_script(void) 659 { 660 return 0; 661 } 662 663 static int default_generate_script(struct pevent *pevent __maybe_unused, 664 const char *outfile __maybe_unused) 665 { 666 return 0; 667 } 668 669 static struct scripting_ops default_scripting_ops = { 670 .start_script = default_start_script, 671 .flush_script = default_flush_script, 672 .stop_script = default_stop_script, 673 .process_event = process_event, 674 .generate_script = default_generate_script, 675 }; 676 677 static struct scripting_ops *scripting_ops; 678 679 static void setup_scripting(void) 680 { 681 setup_perl_scripting(); 682 setup_python_scripting(); 683 684 scripting_ops = &default_scripting_ops; 685 } 686 687 static int flush_scripting(void) 688 { 689 return scripting_ops->flush_script(); 690 } 691 692 static int cleanup_scripting(void) 693 { 694 pr_debug("\nperf script stopped\n"); 695 696 return scripting_ops->stop_script(); 697 } 698 699 static int process_sample_event(struct perf_tool *tool __maybe_unused, 700 union perf_event *event, 701 struct perf_sample *sample, 702 struct perf_evsel *evsel, 703 struct machine *machine) 704 { 705 struct addr_location al; 706 707 if (debug_mode) { 708 if (sample->time < last_timestamp) { 709 pr_err("Samples misordered, previous: %" PRIu64 710 " this: %" PRIu64 "\n", last_timestamp, 711 sample->time); 712 nr_unordered++; 713 } 714 last_timestamp = sample->time; 715 return 0; 716 } 717 718 if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) { 719 pr_err("problem processing %d event, skipping it.\n", 720 event->header.type); 721 return -1; 722 } 723 724 if (al.filtered) 725 goto out_put; 726 727 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap)) 728 goto out_put; 729 730 scripting_ops->process_event(event, sample, evsel, &al); 731 out_put: 732 addr_location__put(&al); 733 return 0; 734 } 735 736 struct perf_script { 737 struct perf_tool tool; 738 struct perf_session *session; 739 bool show_task_events; 740 bool show_mmap_events; 741 bool show_switch_events; 742 }; 743 744 static int process_attr(struct perf_tool *tool, union perf_event *event, 745 struct perf_evlist **pevlist) 746 { 747 struct perf_script *scr = container_of(tool, struct perf_script, tool); 748 struct perf_evlist *evlist; 749 struct perf_evsel *evsel, *pos; 750 int err; 751 752 err = perf_event__process_attr(tool, event, pevlist); 753 if (err) 754 return err; 755 756 evlist = *pevlist; 757 evsel = perf_evlist__last(*pevlist); 758 759 if (evsel->attr.type >= PERF_TYPE_MAX) 760 return 0; 761 762 evlist__for_each(evlist, pos) { 763 if (pos->attr.type == evsel->attr.type && pos != evsel) 764 return 0; 765 } 766 767 set_print_ip_opts(&evsel->attr); 768 769 if (evsel->attr.sample_type) 770 err = perf_evsel__check_attr(evsel, scr->session); 771 772 return err; 773 } 774 775 static int process_comm_event(struct perf_tool *tool, 776 union perf_event *event, 777 struct perf_sample *sample, 778 struct machine *machine) 779 { 780 struct thread *thread; 781 struct perf_script *script = container_of(tool, struct perf_script, tool); 782 struct perf_session *session = script->session; 783 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id); 784 int ret = -1; 785 786 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid); 787 if (thread == NULL) { 788 pr_debug("problem processing COMM event, skipping it.\n"); 789 return -1; 790 } 791 792 if (perf_event__process_comm(tool, event, sample, machine) < 0) 793 goto out; 794 795 if (!evsel->attr.sample_id_all) { 796 sample->cpu = 0; 797 sample->time = 0; 798 sample->tid = event->comm.tid; 799 sample->pid = event->comm.pid; 800 } 801 print_sample_start(sample, thread, evsel); 802 perf_event__fprintf(event, stdout); 803 ret = 0; 804 out: 805 thread__put(thread); 806 return ret; 807 } 808 809 static int process_fork_event(struct perf_tool *tool, 810 union perf_event *event, 811 struct perf_sample *sample, 812 struct machine *machine) 813 { 814 struct thread *thread; 815 struct perf_script *script = container_of(tool, struct perf_script, tool); 816 struct perf_session *session = script->session; 817 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id); 818 819 if (perf_event__process_fork(tool, event, sample, machine) < 0) 820 return -1; 821 822 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid); 823 if (thread == NULL) { 824 pr_debug("problem processing FORK event, skipping it.\n"); 825 return -1; 826 } 827 828 if (!evsel->attr.sample_id_all) { 829 sample->cpu = 0; 830 sample->time = event->fork.time; 831 sample->tid = event->fork.tid; 832 sample->pid = event->fork.pid; 833 } 834 print_sample_start(sample, thread, evsel); 835 perf_event__fprintf(event, stdout); 836 thread__put(thread); 837 838 return 0; 839 } 840 static int process_exit_event(struct perf_tool *tool, 841 union perf_event *event, 842 struct perf_sample *sample, 843 struct machine *machine) 844 { 845 int err = 0; 846 struct thread *thread; 847 struct perf_script *script = container_of(tool, struct perf_script, tool); 848 struct perf_session *session = script->session; 849 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id); 850 851 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid); 852 if (thread == NULL) { 853 pr_debug("problem processing EXIT event, skipping it.\n"); 854 return -1; 855 } 856 857 if (!evsel->attr.sample_id_all) { 858 sample->cpu = 0; 859 sample->time = 0; 860 sample->tid = event->fork.tid; 861 sample->pid = event->fork.pid; 862 } 863 print_sample_start(sample, thread, evsel); 864 perf_event__fprintf(event, stdout); 865 866 if (perf_event__process_exit(tool, event, sample, machine) < 0) 867 err = -1; 868 869 thread__put(thread); 870 return err; 871 } 872 873 static int process_mmap_event(struct perf_tool *tool, 874 union perf_event *event, 875 struct perf_sample *sample, 876 struct machine *machine) 877 { 878 struct thread *thread; 879 struct perf_script *script = container_of(tool, struct perf_script, tool); 880 struct perf_session *session = script->session; 881 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id); 882 883 if (perf_event__process_mmap(tool, event, sample, machine) < 0) 884 return -1; 885 886 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid); 887 if (thread == NULL) { 888 pr_debug("problem processing MMAP event, skipping it.\n"); 889 return -1; 890 } 891 892 if (!evsel->attr.sample_id_all) { 893 sample->cpu = 0; 894 sample->time = 0; 895 sample->tid = event->mmap.tid; 896 sample->pid = event->mmap.pid; 897 } 898 print_sample_start(sample, thread, evsel); 899 perf_event__fprintf(event, stdout); 900 thread__put(thread); 901 return 0; 902 } 903 904 static int process_mmap2_event(struct perf_tool *tool, 905 union perf_event *event, 906 struct perf_sample *sample, 907 struct machine *machine) 908 { 909 struct thread *thread; 910 struct perf_script *script = container_of(tool, struct perf_script, tool); 911 struct perf_session *session = script->session; 912 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id); 913 914 if (perf_event__process_mmap2(tool, event, sample, machine) < 0) 915 return -1; 916 917 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid); 918 if (thread == NULL) { 919 pr_debug("problem processing MMAP2 event, skipping it.\n"); 920 return -1; 921 } 922 923 if (!evsel->attr.sample_id_all) { 924 sample->cpu = 0; 925 sample->time = 0; 926 sample->tid = event->mmap2.tid; 927 sample->pid = event->mmap2.pid; 928 } 929 print_sample_start(sample, thread, evsel); 930 perf_event__fprintf(event, stdout); 931 thread__put(thread); 932 return 0; 933 } 934 935 static int process_switch_event(struct perf_tool *tool, 936 union perf_event *event, 937 struct perf_sample *sample, 938 struct machine *machine) 939 { 940 struct thread *thread; 941 struct perf_script *script = container_of(tool, struct perf_script, tool); 942 struct perf_session *session = script->session; 943 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id); 944 945 if (perf_event__process_switch(tool, event, sample, machine) < 0) 946 return -1; 947 948 thread = machine__findnew_thread(machine, sample->pid, 949 sample->tid); 950 if (thread == NULL) { 951 pr_debug("problem processing SWITCH event, skipping it.\n"); 952 return -1; 953 } 954 955 print_sample_start(sample, thread, evsel); 956 perf_event__fprintf(event, stdout); 957 thread__put(thread); 958 return 0; 959 } 960 961 static void sig_handler(int sig __maybe_unused) 962 { 963 session_done = 1; 964 } 965 966 static int __cmd_script(struct perf_script *script) 967 { 968 int ret; 969 970 signal(SIGINT, sig_handler); 971 972 /* override event processing functions */ 973 if (script->show_task_events) { 974 script->tool.comm = process_comm_event; 975 script->tool.fork = process_fork_event; 976 script->tool.exit = process_exit_event; 977 } 978 if (script->show_mmap_events) { 979 script->tool.mmap = process_mmap_event; 980 script->tool.mmap2 = process_mmap2_event; 981 } 982 if (script->show_switch_events) 983 script->tool.context_switch = process_switch_event; 984 985 ret = perf_session__process_events(script->session); 986 987 if (debug_mode) 988 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered); 989 990 return ret; 991 } 992 993 struct script_spec { 994 struct list_head node; 995 struct scripting_ops *ops; 996 char spec[0]; 997 }; 998 999 static LIST_HEAD(script_specs); 1000 1001 static struct script_spec *script_spec__new(const char *spec, 1002 struct scripting_ops *ops) 1003 { 1004 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1); 1005 1006 if (s != NULL) { 1007 strcpy(s->spec, spec); 1008 s->ops = ops; 1009 } 1010 1011 return s; 1012 } 1013 1014 static void script_spec__add(struct script_spec *s) 1015 { 1016 list_add_tail(&s->node, &script_specs); 1017 } 1018 1019 static struct script_spec *script_spec__find(const char *spec) 1020 { 1021 struct script_spec *s; 1022 1023 list_for_each_entry(s, &script_specs, node) 1024 if (strcasecmp(s->spec, spec) == 0) 1025 return s; 1026 return NULL; 1027 } 1028 1029 static struct script_spec *script_spec__findnew(const char *spec, 1030 struct scripting_ops *ops) 1031 { 1032 struct script_spec *s = script_spec__find(spec); 1033 1034 if (s) 1035 return s; 1036 1037 s = script_spec__new(spec, ops); 1038 if (!s) 1039 return NULL; 1040 1041 script_spec__add(s); 1042 1043 return s; 1044 } 1045 1046 int script_spec_register(const char *spec, struct scripting_ops *ops) 1047 { 1048 struct script_spec *s; 1049 1050 s = script_spec__find(spec); 1051 if (s) 1052 return -1; 1053 1054 s = script_spec__findnew(spec, ops); 1055 if (!s) 1056 return -1; 1057 1058 return 0; 1059 } 1060 1061 static struct scripting_ops *script_spec__lookup(const char *spec) 1062 { 1063 struct script_spec *s = script_spec__find(spec); 1064 if (!s) 1065 return NULL; 1066 1067 return s->ops; 1068 } 1069 1070 static void list_available_languages(void) 1071 { 1072 struct script_spec *s; 1073 1074 fprintf(stderr, "\n"); 1075 fprintf(stderr, "Scripting language extensions (used in " 1076 "perf script -s [spec:]script.[spec]):\n\n"); 1077 1078 list_for_each_entry(s, &script_specs, node) 1079 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name); 1080 1081 fprintf(stderr, "\n"); 1082 } 1083 1084 static int parse_scriptname(const struct option *opt __maybe_unused, 1085 const char *str, int unset __maybe_unused) 1086 { 1087 char spec[PATH_MAX]; 1088 const char *script, *ext; 1089 int len; 1090 1091 if (strcmp(str, "lang") == 0) { 1092 list_available_languages(); 1093 exit(0); 1094 } 1095 1096 script = strchr(str, ':'); 1097 if (script) { 1098 len = script - str; 1099 if (len >= PATH_MAX) { 1100 fprintf(stderr, "invalid language specifier"); 1101 return -1; 1102 } 1103 strncpy(spec, str, len); 1104 spec[len] = '\0'; 1105 scripting_ops = script_spec__lookup(spec); 1106 if (!scripting_ops) { 1107 fprintf(stderr, "invalid language specifier"); 1108 return -1; 1109 } 1110 script++; 1111 } else { 1112 script = str; 1113 ext = strrchr(script, '.'); 1114 if (!ext) { 1115 fprintf(stderr, "invalid script extension"); 1116 return -1; 1117 } 1118 scripting_ops = script_spec__lookup(++ext); 1119 if (!scripting_ops) { 1120 fprintf(stderr, "invalid script extension"); 1121 return -1; 1122 } 1123 } 1124 1125 script_name = strdup(script); 1126 1127 return 0; 1128 } 1129 1130 static int parse_output_fields(const struct option *opt __maybe_unused, 1131 const char *arg, int unset __maybe_unused) 1132 { 1133 char *tok; 1134 int i, imax = ARRAY_SIZE(all_output_options); 1135 int j; 1136 int rc = 0; 1137 char *str = strdup(arg); 1138 int type = -1; 1139 1140 if (!str) 1141 return -ENOMEM; 1142 1143 /* first word can state for which event type the user is specifying 1144 * the fields. If no type exists, the specified fields apply to all 1145 * event types found in the file minus the invalid fields for a type. 1146 */ 1147 tok = strchr(str, ':'); 1148 if (tok) { 1149 *tok = '\0'; 1150 tok++; 1151 if (!strcmp(str, "hw")) 1152 type = PERF_TYPE_HARDWARE; 1153 else if (!strcmp(str, "sw")) 1154 type = PERF_TYPE_SOFTWARE; 1155 else if (!strcmp(str, "trace")) 1156 type = PERF_TYPE_TRACEPOINT; 1157 else if (!strcmp(str, "raw")) 1158 type = PERF_TYPE_RAW; 1159 else { 1160 fprintf(stderr, "Invalid event type in field string.\n"); 1161 rc = -EINVAL; 1162 goto out; 1163 } 1164 1165 if (output[type].user_set) 1166 pr_warning("Overriding previous field request for %s events.\n", 1167 event_type(type)); 1168 1169 output[type].fields = 0; 1170 output[type].user_set = true; 1171 output[type].wildcard_set = false; 1172 1173 } else { 1174 tok = str; 1175 if (strlen(str) == 0) { 1176 fprintf(stderr, 1177 "Cannot set fields to 'none' for all event types.\n"); 1178 rc = -EINVAL; 1179 goto out; 1180 } 1181 1182 if (output_set_by_user()) 1183 pr_warning("Overriding previous field request for all events.\n"); 1184 1185 for (j = 0; j < PERF_TYPE_MAX; ++j) { 1186 output[j].fields = 0; 1187 output[j].user_set = true; 1188 output[j].wildcard_set = true; 1189 } 1190 } 1191 1192 for (tok = strtok(tok, ","); tok; tok = strtok(NULL, ",")) { 1193 for (i = 0; i < imax; ++i) { 1194 if (strcmp(tok, all_output_options[i].str) == 0) 1195 break; 1196 } 1197 if (i == imax && strcmp(tok, "flags") == 0) { 1198 print_flags = true; 1199 continue; 1200 } 1201 if (i == imax) { 1202 fprintf(stderr, "Invalid field requested.\n"); 1203 rc = -EINVAL; 1204 goto out; 1205 } 1206 1207 if (type == -1) { 1208 /* add user option to all events types for 1209 * which it is valid 1210 */ 1211 for (j = 0; j < PERF_TYPE_MAX; ++j) { 1212 if (output[j].invalid_fields & all_output_options[i].field) { 1213 pr_warning("\'%s\' not valid for %s events. Ignoring.\n", 1214 all_output_options[i].str, event_type(j)); 1215 } else 1216 output[j].fields |= all_output_options[i].field; 1217 } 1218 } else { 1219 if (output[type].invalid_fields & all_output_options[i].field) { 1220 fprintf(stderr, "\'%s\' not valid for %s events.\n", 1221 all_output_options[i].str, event_type(type)); 1222 1223 rc = -EINVAL; 1224 goto out; 1225 } 1226 output[type].fields |= all_output_options[i].field; 1227 } 1228 } 1229 1230 if (type >= 0) { 1231 if (output[type].fields == 0) { 1232 pr_debug("No fields requested for %s type. " 1233 "Events will not be displayed.\n", event_type(type)); 1234 } 1235 } 1236 1237 out: 1238 free(str); 1239 return rc; 1240 } 1241 1242 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */ 1243 static int is_directory(const char *base_path, const struct dirent *dent) 1244 { 1245 char path[PATH_MAX]; 1246 struct stat st; 1247 1248 sprintf(path, "%s/%s", base_path, dent->d_name); 1249 if (stat(path, &st)) 1250 return 0; 1251 1252 return S_ISDIR(st.st_mode); 1253 } 1254 1255 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\ 1256 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \ 1257 lang_next) \ 1258 if ((lang_dirent.d_type == DT_DIR || \ 1259 (lang_dirent.d_type == DT_UNKNOWN && \ 1260 is_directory(scripts_path, &lang_dirent))) && \ 1261 (strcmp(lang_dirent.d_name, ".")) && \ 1262 (strcmp(lang_dirent.d_name, ".."))) 1263 1264 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\ 1265 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \ 1266 script_next) \ 1267 if (script_dirent.d_type != DT_DIR && \ 1268 (script_dirent.d_type != DT_UNKNOWN || \ 1269 !is_directory(lang_path, &script_dirent))) 1270 1271 1272 #define RECORD_SUFFIX "-record" 1273 #define REPORT_SUFFIX "-report" 1274 1275 struct script_desc { 1276 struct list_head node; 1277 char *name; 1278 char *half_liner; 1279 char *args; 1280 }; 1281 1282 static LIST_HEAD(script_descs); 1283 1284 static struct script_desc *script_desc__new(const char *name) 1285 { 1286 struct script_desc *s = zalloc(sizeof(*s)); 1287 1288 if (s != NULL && name) 1289 s->name = strdup(name); 1290 1291 return s; 1292 } 1293 1294 static void script_desc__delete(struct script_desc *s) 1295 { 1296 zfree(&s->name); 1297 zfree(&s->half_liner); 1298 zfree(&s->args); 1299 free(s); 1300 } 1301 1302 static void script_desc__add(struct script_desc *s) 1303 { 1304 list_add_tail(&s->node, &script_descs); 1305 } 1306 1307 static struct script_desc *script_desc__find(const char *name) 1308 { 1309 struct script_desc *s; 1310 1311 list_for_each_entry(s, &script_descs, node) 1312 if (strcasecmp(s->name, name) == 0) 1313 return s; 1314 return NULL; 1315 } 1316 1317 static struct script_desc *script_desc__findnew(const char *name) 1318 { 1319 struct script_desc *s = script_desc__find(name); 1320 1321 if (s) 1322 return s; 1323 1324 s = script_desc__new(name); 1325 if (!s) 1326 goto out_delete_desc; 1327 1328 script_desc__add(s); 1329 1330 return s; 1331 1332 out_delete_desc: 1333 script_desc__delete(s); 1334 1335 return NULL; 1336 } 1337 1338 static const char *ends_with(const char *str, const char *suffix) 1339 { 1340 size_t suffix_len = strlen(suffix); 1341 const char *p = str; 1342 1343 if (strlen(str) > suffix_len) { 1344 p = str + strlen(str) - suffix_len; 1345 if (!strncmp(p, suffix, suffix_len)) 1346 return p; 1347 } 1348 1349 return NULL; 1350 } 1351 1352 static int read_script_info(struct script_desc *desc, const char *filename) 1353 { 1354 char line[BUFSIZ], *p; 1355 FILE *fp; 1356 1357 fp = fopen(filename, "r"); 1358 if (!fp) 1359 return -1; 1360 1361 while (fgets(line, sizeof(line), fp)) { 1362 p = ltrim(line); 1363 if (strlen(p) == 0) 1364 continue; 1365 if (*p != '#') 1366 continue; 1367 p++; 1368 if (strlen(p) && *p == '!') 1369 continue; 1370 1371 p = ltrim(p); 1372 if (strlen(p) && p[strlen(p) - 1] == '\n') 1373 p[strlen(p) - 1] = '\0'; 1374 1375 if (!strncmp(p, "description:", strlen("description:"))) { 1376 p += strlen("description:"); 1377 desc->half_liner = strdup(ltrim(p)); 1378 continue; 1379 } 1380 1381 if (!strncmp(p, "args:", strlen("args:"))) { 1382 p += strlen("args:"); 1383 desc->args = strdup(ltrim(p)); 1384 continue; 1385 } 1386 } 1387 1388 fclose(fp); 1389 1390 return 0; 1391 } 1392 1393 static char *get_script_root(struct dirent *script_dirent, const char *suffix) 1394 { 1395 char *script_root, *str; 1396 1397 script_root = strdup(script_dirent->d_name); 1398 if (!script_root) 1399 return NULL; 1400 1401 str = (char *)ends_with(script_root, suffix); 1402 if (!str) { 1403 free(script_root); 1404 return NULL; 1405 } 1406 1407 *str = '\0'; 1408 return script_root; 1409 } 1410 1411 static int list_available_scripts(const struct option *opt __maybe_unused, 1412 const char *s __maybe_unused, 1413 int unset __maybe_unused) 1414 { 1415 struct dirent *script_next, *lang_next, script_dirent, lang_dirent; 1416 char scripts_path[MAXPATHLEN]; 1417 DIR *scripts_dir, *lang_dir; 1418 char script_path[MAXPATHLEN]; 1419 char lang_path[MAXPATHLEN]; 1420 struct script_desc *desc; 1421 char first_half[BUFSIZ]; 1422 char *script_root; 1423 1424 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path()); 1425 1426 scripts_dir = opendir(scripts_path); 1427 if (!scripts_dir) 1428 return -1; 1429 1430 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) { 1431 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path, 1432 lang_dirent.d_name); 1433 lang_dir = opendir(lang_path); 1434 if (!lang_dir) 1435 continue; 1436 1437 for_each_script(lang_path, lang_dir, script_dirent, script_next) { 1438 script_root = get_script_root(&script_dirent, REPORT_SUFFIX); 1439 if (script_root) { 1440 desc = script_desc__findnew(script_root); 1441 snprintf(script_path, MAXPATHLEN, "%s/%s", 1442 lang_path, script_dirent.d_name); 1443 read_script_info(desc, script_path); 1444 free(script_root); 1445 } 1446 } 1447 } 1448 1449 fprintf(stdout, "List of available trace scripts:\n"); 1450 list_for_each_entry(desc, &script_descs, node) { 1451 sprintf(first_half, "%s %s", desc->name, 1452 desc->args ? desc->args : ""); 1453 fprintf(stdout, " %-36s %s\n", first_half, 1454 desc->half_liner ? desc->half_liner : ""); 1455 } 1456 1457 exit(0); 1458 } 1459 1460 /* 1461 * Some scripts specify the required events in their "xxx-record" file, 1462 * this function will check if the events in perf.data match those 1463 * mentioned in the "xxx-record". 1464 * 1465 * Fixme: All existing "xxx-record" are all in good formats "-e event ", 1466 * which is covered well now. And new parsing code should be added to 1467 * cover the future complexing formats like event groups etc. 1468 */ 1469 static int check_ev_match(char *dir_name, char *scriptname, 1470 struct perf_session *session) 1471 { 1472 char filename[MAXPATHLEN], evname[128]; 1473 char line[BUFSIZ], *p; 1474 struct perf_evsel *pos; 1475 int match, len; 1476 FILE *fp; 1477 1478 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname); 1479 1480 fp = fopen(filename, "r"); 1481 if (!fp) 1482 return -1; 1483 1484 while (fgets(line, sizeof(line), fp)) { 1485 p = ltrim(line); 1486 if (*p == '#') 1487 continue; 1488 1489 while (strlen(p)) { 1490 p = strstr(p, "-e"); 1491 if (!p) 1492 break; 1493 1494 p += 2; 1495 p = ltrim(p); 1496 len = strcspn(p, " \t"); 1497 if (!len) 1498 break; 1499 1500 snprintf(evname, len + 1, "%s", p); 1501 1502 match = 0; 1503 evlist__for_each(session->evlist, pos) { 1504 if (!strcmp(perf_evsel__name(pos), evname)) { 1505 match = 1; 1506 break; 1507 } 1508 } 1509 1510 if (!match) { 1511 fclose(fp); 1512 return -1; 1513 } 1514 } 1515 } 1516 1517 fclose(fp); 1518 return 0; 1519 } 1520 1521 /* 1522 * Return -1 if none is found, otherwise the actual scripts number. 1523 * 1524 * Currently the only user of this function is the script browser, which 1525 * will list all statically runnable scripts, select one, execute it and 1526 * show the output in a perf browser. 1527 */ 1528 int find_scripts(char **scripts_array, char **scripts_path_array) 1529 { 1530 struct dirent *script_next, *lang_next, script_dirent, lang_dirent; 1531 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN]; 1532 DIR *scripts_dir, *lang_dir; 1533 struct perf_session *session; 1534 struct perf_data_file file = { 1535 .path = input_name, 1536 .mode = PERF_DATA_MODE_READ, 1537 }; 1538 char *temp; 1539 int i = 0; 1540 1541 session = perf_session__new(&file, false, NULL); 1542 if (!session) 1543 return -1; 1544 1545 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path()); 1546 1547 scripts_dir = opendir(scripts_path); 1548 if (!scripts_dir) { 1549 perf_session__delete(session); 1550 return -1; 1551 } 1552 1553 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) { 1554 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path, 1555 lang_dirent.d_name); 1556 #ifdef NO_LIBPERL 1557 if (strstr(lang_path, "perl")) 1558 continue; 1559 #endif 1560 #ifdef NO_LIBPYTHON 1561 if (strstr(lang_path, "python")) 1562 continue; 1563 #endif 1564 1565 lang_dir = opendir(lang_path); 1566 if (!lang_dir) 1567 continue; 1568 1569 for_each_script(lang_path, lang_dir, script_dirent, script_next) { 1570 /* Skip those real time scripts: xxxtop.p[yl] */ 1571 if (strstr(script_dirent.d_name, "top.")) 1572 continue; 1573 sprintf(scripts_path_array[i], "%s/%s", lang_path, 1574 script_dirent.d_name); 1575 temp = strchr(script_dirent.d_name, '.'); 1576 snprintf(scripts_array[i], 1577 (temp - script_dirent.d_name) + 1, 1578 "%s", script_dirent.d_name); 1579 1580 if (check_ev_match(lang_path, 1581 scripts_array[i], session)) 1582 continue; 1583 1584 i++; 1585 } 1586 closedir(lang_dir); 1587 } 1588 1589 closedir(scripts_dir); 1590 perf_session__delete(session); 1591 return i; 1592 } 1593 1594 static char *get_script_path(const char *script_root, const char *suffix) 1595 { 1596 struct dirent *script_next, *lang_next, script_dirent, lang_dirent; 1597 char scripts_path[MAXPATHLEN]; 1598 char script_path[MAXPATHLEN]; 1599 DIR *scripts_dir, *lang_dir; 1600 char lang_path[MAXPATHLEN]; 1601 char *__script_root; 1602 1603 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path()); 1604 1605 scripts_dir = opendir(scripts_path); 1606 if (!scripts_dir) 1607 return NULL; 1608 1609 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) { 1610 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path, 1611 lang_dirent.d_name); 1612 lang_dir = opendir(lang_path); 1613 if (!lang_dir) 1614 continue; 1615 1616 for_each_script(lang_path, lang_dir, script_dirent, script_next) { 1617 __script_root = get_script_root(&script_dirent, suffix); 1618 if (__script_root && !strcmp(script_root, __script_root)) { 1619 free(__script_root); 1620 closedir(lang_dir); 1621 closedir(scripts_dir); 1622 snprintf(script_path, MAXPATHLEN, "%s/%s", 1623 lang_path, script_dirent.d_name); 1624 return strdup(script_path); 1625 } 1626 free(__script_root); 1627 } 1628 closedir(lang_dir); 1629 } 1630 closedir(scripts_dir); 1631 1632 return NULL; 1633 } 1634 1635 static bool is_top_script(const char *script_path) 1636 { 1637 return ends_with(script_path, "top") == NULL ? false : true; 1638 } 1639 1640 static int has_required_arg(char *script_path) 1641 { 1642 struct script_desc *desc; 1643 int n_args = 0; 1644 char *p; 1645 1646 desc = script_desc__new(NULL); 1647 1648 if (read_script_info(desc, script_path)) 1649 goto out; 1650 1651 if (!desc->args) 1652 goto out; 1653 1654 for (p = desc->args; *p; p++) 1655 if (*p == '<') 1656 n_args++; 1657 out: 1658 script_desc__delete(desc); 1659 1660 return n_args; 1661 } 1662 1663 static int have_cmd(int argc, const char **argv) 1664 { 1665 char **__argv = malloc(sizeof(const char *) * argc); 1666 1667 if (!__argv) { 1668 pr_err("malloc failed\n"); 1669 return -1; 1670 } 1671 1672 memcpy(__argv, argv, sizeof(const char *) * argc); 1673 argc = parse_options(argc, (const char **)__argv, record_options, 1674 NULL, PARSE_OPT_STOP_AT_NON_OPTION); 1675 free(__argv); 1676 1677 system_wide = (argc == 0); 1678 1679 return 0; 1680 } 1681 1682 static void script__setup_sample_type(struct perf_script *script) 1683 { 1684 struct perf_session *session = script->session; 1685 u64 sample_type = perf_evlist__combined_sample_type(session->evlist); 1686 1687 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) { 1688 if ((sample_type & PERF_SAMPLE_REGS_USER) && 1689 (sample_type & PERF_SAMPLE_STACK_USER)) 1690 callchain_param.record_mode = CALLCHAIN_DWARF; 1691 else if (sample_type & PERF_SAMPLE_BRANCH_STACK) 1692 callchain_param.record_mode = CALLCHAIN_LBR; 1693 else 1694 callchain_param.record_mode = CALLCHAIN_FP; 1695 } 1696 } 1697 1698 int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused) 1699 { 1700 bool show_full_info = false; 1701 bool header = false; 1702 bool header_only = false; 1703 bool script_started = false; 1704 char *rec_script_path = NULL; 1705 char *rep_script_path = NULL; 1706 struct perf_session *session; 1707 struct itrace_synth_opts itrace_synth_opts = { .set = false, }; 1708 char *script_path = NULL; 1709 const char **__argv; 1710 int i, j, err = 0; 1711 struct perf_script script = { 1712 .tool = { 1713 .sample = process_sample_event, 1714 .mmap = perf_event__process_mmap, 1715 .mmap2 = perf_event__process_mmap2, 1716 .comm = perf_event__process_comm, 1717 .exit = perf_event__process_exit, 1718 .fork = perf_event__process_fork, 1719 .attr = process_attr, 1720 .tracing_data = perf_event__process_tracing_data, 1721 .build_id = perf_event__process_build_id, 1722 .id_index = perf_event__process_id_index, 1723 .auxtrace_info = perf_event__process_auxtrace_info, 1724 .auxtrace = perf_event__process_auxtrace, 1725 .auxtrace_error = perf_event__process_auxtrace_error, 1726 .ordered_events = true, 1727 .ordering_requires_timestamps = true, 1728 }, 1729 }; 1730 struct perf_data_file file = { 1731 .mode = PERF_DATA_MODE_READ, 1732 }; 1733 const struct option options[] = { 1734 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, 1735 "dump raw trace in ASCII"), 1736 OPT_INCR('v', "verbose", &verbose, 1737 "be more verbose (show symbol address, etc)"), 1738 OPT_BOOLEAN('L', "Latency", &latency_format, 1739 "show latency attributes (irqs/preemption disabled, etc)"), 1740 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts", 1741 list_available_scripts), 1742 OPT_CALLBACK('s', "script", NULL, "name", 1743 "script file name (lang:script name, script name, or *)", 1744 parse_scriptname), 1745 OPT_STRING('g', "gen-script", &generate_script_lang, "lang", 1746 "generate perf-script.xx script in specified language"), 1747 OPT_STRING('i', "input", &input_name, "file", "input file name"), 1748 OPT_BOOLEAN('d', "debug-mode", &debug_mode, 1749 "do various checks like samples ordering and lost events"), 1750 OPT_BOOLEAN(0, "header", &header, "Show data header."), 1751 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."), 1752 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, 1753 "file", "vmlinux pathname"), 1754 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, 1755 "file", "kallsyms pathname"), 1756 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain, 1757 "When printing symbols do not display call chain"), 1758 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory", 1759 "Look for files with symbols relative to this directory"), 1760 OPT_CALLBACK('F', "fields", NULL, "str", 1761 "comma separated output fields prepend with 'type:'. " 1762 "Valid types: hw,sw,trace,raw. " 1763 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso," 1764 "addr,symoff,period,iregs,brstack,brstacksym,flags", parse_output_fields), 1765 OPT_BOOLEAN('a', "all-cpus", &system_wide, 1766 "system-wide collection from all CPUs"), 1767 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]", 1768 "only consider these symbols"), 1769 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"), 1770 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]", 1771 "only display events for these comms"), 1772 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]", 1773 "only consider symbols in these pids"), 1774 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]", 1775 "only consider symbols in these tids"), 1776 OPT_BOOLEAN('I', "show-info", &show_full_info, 1777 "display extended information from perf.data file"), 1778 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path, 1779 "Show the path of [kernel.kallsyms]"), 1780 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events, 1781 "Show the fork/comm/exit events"), 1782 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events, 1783 "Show the mmap events"), 1784 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events, 1785 "Show context switch events (if recorded)"), 1786 OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"), 1787 OPT_BOOLEAN(0, "ns", &nanosecs, 1788 "Use 9 decimal places when displaying time"), 1789 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts", 1790 "Instruction Tracing options", 1791 itrace_parse_synth_opts), 1792 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename, 1793 "Show full source file name path for source lines"), 1794 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle, 1795 "Enable symbol demangling"), 1796 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel, 1797 "Enable kernel symbol demangling"), 1798 1799 OPT_END() 1800 }; 1801 const char * const script_subcommands[] = { "record", "report", NULL }; 1802 const char *script_usage[] = { 1803 "perf script [<options>]", 1804 "perf script [<options>] record <script> [<record-options>] <command>", 1805 "perf script [<options>] report <script> [script-args]", 1806 "perf script [<options>] <script> [<record-options>] <command>", 1807 "perf script [<options>] <top-script> [script-args]", 1808 NULL 1809 }; 1810 1811 setup_scripting(); 1812 1813 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage, 1814 PARSE_OPT_STOP_AT_NON_OPTION); 1815 1816 file.path = input_name; 1817 1818 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) { 1819 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX); 1820 if (!rec_script_path) 1821 return cmd_record(argc, argv, NULL); 1822 } 1823 1824 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) { 1825 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX); 1826 if (!rep_script_path) { 1827 fprintf(stderr, 1828 "Please specify a valid report script" 1829 "(see 'perf script -l' for listing)\n"); 1830 return -1; 1831 } 1832 } 1833 1834 if (itrace_synth_opts.callchain && 1835 itrace_synth_opts.callchain_sz > scripting_max_stack) 1836 scripting_max_stack = itrace_synth_opts.callchain_sz; 1837 1838 /* make sure PERF_EXEC_PATH is set for scripts */ 1839 perf_set_argv_exec_path(perf_exec_path()); 1840 1841 if (argc && !script_name && !rec_script_path && !rep_script_path) { 1842 int live_pipe[2]; 1843 int rep_args; 1844 pid_t pid; 1845 1846 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX); 1847 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX); 1848 1849 if (!rec_script_path && !rep_script_path) { 1850 usage_with_options_msg(script_usage, options, 1851 "Couldn't find script `%s'\n\n See perf" 1852 " script -l for available scripts.\n", argv[0]); 1853 } 1854 1855 if (is_top_script(argv[0])) { 1856 rep_args = argc - 1; 1857 } else { 1858 int rec_args; 1859 1860 rep_args = has_required_arg(rep_script_path); 1861 rec_args = (argc - 1) - rep_args; 1862 if (rec_args < 0) { 1863 usage_with_options_msg(script_usage, options, 1864 "`%s' script requires options." 1865 "\n\n See perf script -l for available " 1866 "scripts and options.\n", argv[0]); 1867 } 1868 } 1869 1870 if (pipe(live_pipe) < 0) { 1871 perror("failed to create pipe"); 1872 return -1; 1873 } 1874 1875 pid = fork(); 1876 if (pid < 0) { 1877 perror("failed to fork"); 1878 return -1; 1879 } 1880 1881 if (!pid) { 1882 j = 0; 1883 1884 dup2(live_pipe[1], 1); 1885 close(live_pipe[0]); 1886 1887 if (is_top_script(argv[0])) { 1888 system_wide = true; 1889 } else if (!system_wide) { 1890 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) { 1891 err = -1; 1892 goto out; 1893 } 1894 } 1895 1896 __argv = malloc((argc + 6) * sizeof(const char *)); 1897 if (!__argv) { 1898 pr_err("malloc failed\n"); 1899 err = -ENOMEM; 1900 goto out; 1901 } 1902 1903 __argv[j++] = "/bin/sh"; 1904 __argv[j++] = rec_script_path; 1905 if (system_wide) 1906 __argv[j++] = "-a"; 1907 __argv[j++] = "-q"; 1908 __argv[j++] = "-o"; 1909 __argv[j++] = "-"; 1910 for (i = rep_args + 1; i < argc; i++) 1911 __argv[j++] = argv[i]; 1912 __argv[j++] = NULL; 1913 1914 execvp("/bin/sh", (char **)__argv); 1915 free(__argv); 1916 exit(-1); 1917 } 1918 1919 dup2(live_pipe[0], 0); 1920 close(live_pipe[1]); 1921 1922 __argv = malloc((argc + 4) * sizeof(const char *)); 1923 if (!__argv) { 1924 pr_err("malloc failed\n"); 1925 err = -ENOMEM; 1926 goto out; 1927 } 1928 1929 j = 0; 1930 __argv[j++] = "/bin/sh"; 1931 __argv[j++] = rep_script_path; 1932 for (i = 1; i < rep_args + 1; i++) 1933 __argv[j++] = argv[i]; 1934 __argv[j++] = "-i"; 1935 __argv[j++] = "-"; 1936 __argv[j++] = NULL; 1937 1938 execvp("/bin/sh", (char **)__argv); 1939 free(__argv); 1940 exit(-1); 1941 } 1942 1943 if (rec_script_path) 1944 script_path = rec_script_path; 1945 if (rep_script_path) 1946 script_path = rep_script_path; 1947 1948 if (script_path) { 1949 j = 0; 1950 1951 if (!rec_script_path) 1952 system_wide = false; 1953 else if (!system_wide) { 1954 if (have_cmd(argc - 1, &argv[1]) != 0) { 1955 err = -1; 1956 goto out; 1957 } 1958 } 1959 1960 __argv = malloc((argc + 2) * sizeof(const char *)); 1961 if (!__argv) { 1962 pr_err("malloc failed\n"); 1963 err = -ENOMEM; 1964 goto out; 1965 } 1966 1967 __argv[j++] = "/bin/sh"; 1968 __argv[j++] = script_path; 1969 if (system_wide) 1970 __argv[j++] = "-a"; 1971 for (i = 2; i < argc; i++) 1972 __argv[j++] = argv[i]; 1973 __argv[j++] = NULL; 1974 1975 execvp("/bin/sh", (char **)__argv); 1976 free(__argv); 1977 exit(-1); 1978 } 1979 1980 if (!script_name) 1981 setup_pager(); 1982 1983 session = perf_session__new(&file, false, &script.tool); 1984 if (session == NULL) 1985 return -1; 1986 1987 if (header || header_only) { 1988 perf_session__fprintf_info(session, stdout, show_full_info); 1989 if (header_only) 1990 goto out_delete; 1991 } 1992 1993 if (symbol__init(&session->header.env) < 0) 1994 goto out_delete; 1995 1996 script.session = session; 1997 script__setup_sample_type(&script); 1998 1999 session->itrace_synth_opts = &itrace_synth_opts; 2000 2001 if (cpu_list) { 2002 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap); 2003 if (err < 0) 2004 goto out_delete; 2005 } 2006 2007 if (!no_callchain) 2008 symbol_conf.use_callchain = true; 2009 else 2010 symbol_conf.use_callchain = false; 2011 2012 if (session->tevent.pevent && 2013 pevent_set_function_resolver(session->tevent.pevent, 2014 machine__resolve_kernel_addr, 2015 &session->machines.host) < 0) { 2016 pr_err("%s: failed to set libtraceevent function resolver\n", __func__); 2017 return -1; 2018 } 2019 2020 if (generate_script_lang) { 2021 struct stat perf_stat; 2022 int input; 2023 2024 if (output_set_by_user()) { 2025 fprintf(stderr, 2026 "custom fields not supported for generated scripts"); 2027 err = -EINVAL; 2028 goto out_delete; 2029 } 2030 2031 input = open(file.path, O_RDONLY); /* input_name */ 2032 if (input < 0) { 2033 err = -errno; 2034 perror("failed to open file"); 2035 goto out_delete; 2036 } 2037 2038 err = fstat(input, &perf_stat); 2039 if (err < 0) { 2040 perror("failed to stat file"); 2041 goto out_delete; 2042 } 2043 2044 if (!perf_stat.st_size) { 2045 fprintf(stderr, "zero-sized file, nothing to do!\n"); 2046 goto out_delete; 2047 } 2048 2049 scripting_ops = script_spec__lookup(generate_script_lang); 2050 if (!scripting_ops) { 2051 fprintf(stderr, "invalid language specifier"); 2052 err = -ENOENT; 2053 goto out_delete; 2054 } 2055 2056 err = scripting_ops->generate_script(session->tevent.pevent, 2057 "perf-script"); 2058 goto out_delete; 2059 } 2060 2061 if (script_name) { 2062 err = scripting_ops->start_script(script_name, argc, argv); 2063 if (err) 2064 goto out_delete; 2065 pr_debug("perf script started with script %s\n\n", script_name); 2066 script_started = true; 2067 } 2068 2069 2070 err = perf_session__check_output_opt(session); 2071 if (err < 0) 2072 goto out_delete; 2073 2074 err = __cmd_script(&script); 2075 2076 flush_scripting(); 2077 2078 out_delete: 2079 perf_session__delete(session); 2080 2081 if (script_started) 2082 cleanup_scripting(); 2083 out: 2084 return err; 2085 } 2086