1 #include "builtin.h" 2 3 #include "perf.h" 4 #include "util/cache.h" 5 #include "util/debug.h" 6 #include "util/exec_cmd.h" 7 #include "util/header.h" 8 #include "util/parse-options.h" 9 #include "util/session.h" 10 #include "util/tool.h" 11 #include "util/symbol.h" 12 #include "util/thread.h" 13 #include "util/trace-event.h" 14 #include "util/util.h" 15 #include "util/evlist.h" 16 #include "util/evsel.h" 17 #include <linux/bitmap.h> 18 19 static char const *script_name; 20 static char const *generate_script_lang; 21 static bool debug_mode; 22 static u64 last_timestamp; 23 static u64 nr_unordered; 24 extern const struct option record_options[]; 25 static bool no_callchain; 26 static bool show_full_info; 27 static bool system_wide; 28 static const char *cpu_list; 29 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); 30 31 enum perf_output_field { 32 PERF_OUTPUT_COMM = 1U << 0, 33 PERF_OUTPUT_TID = 1U << 1, 34 PERF_OUTPUT_PID = 1U << 2, 35 PERF_OUTPUT_TIME = 1U << 3, 36 PERF_OUTPUT_CPU = 1U << 4, 37 PERF_OUTPUT_EVNAME = 1U << 5, 38 PERF_OUTPUT_TRACE = 1U << 6, 39 PERF_OUTPUT_IP = 1U << 7, 40 PERF_OUTPUT_SYM = 1U << 8, 41 PERF_OUTPUT_DSO = 1U << 9, 42 PERF_OUTPUT_ADDR = 1U << 10, 43 PERF_OUTPUT_SYMOFFSET = 1U << 11, 44 }; 45 46 struct output_option { 47 const char *str; 48 enum perf_output_field field; 49 } all_output_options[] = { 50 {.str = "comm", .field = PERF_OUTPUT_COMM}, 51 {.str = "tid", .field = PERF_OUTPUT_TID}, 52 {.str = "pid", .field = PERF_OUTPUT_PID}, 53 {.str = "time", .field = PERF_OUTPUT_TIME}, 54 {.str = "cpu", .field = PERF_OUTPUT_CPU}, 55 {.str = "event", .field = PERF_OUTPUT_EVNAME}, 56 {.str = "trace", .field = PERF_OUTPUT_TRACE}, 57 {.str = "ip", .field = PERF_OUTPUT_IP}, 58 {.str = "sym", .field = PERF_OUTPUT_SYM}, 59 {.str = "dso", .field = PERF_OUTPUT_DSO}, 60 {.str = "addr", .field = PERF_OUTPUT_ADDR}, 61 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET}, 62 }; 63 64 /* default set to maintain compatibility with current format */ 65 static struct { 66 bool user_set; 67 bool wildcard_set; 68 u64 fields; 69 u64 invalid_fields; 70 } output[PERF_TYPE_MAX] = { 71 72 [PERF_TYPE_HARDWARE] = { 73 .user_set = false, 74 75 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | 76 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | 77 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP | 78 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO, 79 80 .invalid_fields = PERF_OUTPUT_TRACE, 81 }, 82 83 [PERF_TYPE_SOFTWARE] = { 84 .user_set = false, 85 86 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | 87 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | 88 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP | 89 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO, 90 91 .invalid_fields = PERF_OUTPUT_TRACE, 92 }, 93 94 [PERF_TYPE_TRACEPOINT] = { 95 .user_set = false, 96 97 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | 98 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | 99 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE, 100 }, 101 102 [PERF_TYPE_RAW] = { 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 110 .invalid_fields = PERF_OUTPUT_TRACE, 111 }, 112 }; 113 114 static bool output_set_by_user(void) 115 { 116 int j; 117 for (j = 0; j < PERF_TYPE_MAX; ++j) { 118 if (output[j].user_set) 119 return true; 120 } 121 return false; 122 } 123 124 static const char *output_field2str(enum perf_output_field field) 125 { 126 int i, imax = ARRAY_SIZE(all_output_options); 127 const char *str = ""; 128 129 for (i = 0; i < imax; ++i) { 130 if (all_output_options[i].field == field) { 131 str = all_output_options[i].str; 132 break; 133 } 134 } 135 return str; 136 } 137 138 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x) 139 140 static int perf_event_attr__check_stype(struct perf_event_attr *attr, 141 u64 sample_type, const char *sample_msg, 142 enum perf_output_field field) 143 { 144 int type = attr->type; 145 const char *evname; 146 147 if (attr->sample_type & sample_type) 148 return 0; 149 150 if (output[type].user_set) { 151 evname = __event_name(attr->type, attr->config); 152 pr_err("Samples for '%s' event do not have %s attribute set. " 153 "Cannot print '%s' field.\n", 154 evname, sample_msg, output_field2str(field)); 155 return -1; 156 } 157 158 /* user did not ask for it explicitly so remove from the default list */ 159 output[type].fields &= ~field; 160 evname = __event_name(attr->type, attr->config); 161 pr_debug("Samples for '%s' event do not have %s attribute set. " 162 "Skipping '%s' field.\n", 163 evname, sample_msg, output_field2str(field)); 164 165 return 0; 166 } 167 168 static int perf_evsel__check_attr(struct perf_evsel *evsel, 169 struct perf_session *session) 170 { 171 struct perf_event_attr *attr = &evsel->attr; 172 173 if (PRINT_FIELD(TRACE) && 174 !perf_session__has_traces(session, "record -R")) 175 return -EINVAL; 176 177 if (PRINT_FIELD(IP)) { 178 if (perf_event_attr__check_stype(attr, PERF_SAMPLE_IP, "IP", 179 PERF_OUTPUT_IP)) 180 return -EINVAL; 181 182 if (!no_callchain && 183 !(attr->sample_type & PERF_SAMPLE_CALLCHAIN)) 184 symbol_conf.use_callchain = false; 185 } 186 187 if (PRINT_FIELD(ADDR) && 188 perf_event_attr__check_stype(attr, PERF_SAMPLE_ADDR, "ADDR", 189 PERF_OUTPUT_ADDR)) 190 return -EINVAL; 191 192 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) { 193 pr_err("Display of symbols requested but neither sample IP nor " 194 "sample address\nis selected. Hence, no addresses to convert " 195 "to symbols.\n"); 196 return -EINVAL; 197 } 198 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) { 199 pr_err("Display of offsets requested but symbol is not" 200 "selected.\n"); 201 return -EINVAL; 202 } 203 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) { 204 pr_err("Display of DSO requested but neither sample IP nor " 205 "sample address\nis selected. Hence, no addresses to convert " 206 "to DSO.\n"); 207 return -EINVAL; 208 } 209 210 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) && 211 perf_event_attr__check_stype(attr, PERF_SAMPLE_TID, "TID", 212 PERF_OUTPUT_TID|PERF_OUTPUT_PID)) 213 return -EINVAL; 214 215 if (PRINT_FIELD(TIME) && 216 perf_event_attr__check_stype(attr, PERF_SAMPLE_TIME, "TIME", 217 PERF_OUTPUT_TIME)) 218 return -EINVAL; 219 220 if (PRINT_FIELD(CPU) && 221 perf_event_attr__check_stype(attr, PERF_SAMPLE_CPU, "CPU", 222 PERF_OUTPUT_CPU)) 223 return -EINVAL; 224 225 return 0; 226 } 227 228 /* 229 * verify all user requested events exist and the samples 230 * have the expected data 231 */ 232 static int perf_session__check_output_opt(struct perf_session *session) 233 { 234 int j; 235 struct perf_evsel *evsel; 236 237 for (j = 0; j < PERF_TYPE_MAX; ++j) { 238 evsel = perf_session__find_first_evtype(session, j); 239 240 /* 241 * even if fields is set to 0 (ie., show nothing) event must 242 * exist if user explicitly includes it on the command line 243 */ 244 if (!evsel && output[j].user_set && !output[j].wildcard_set) { 245 pr_err("%s events do not exist. " 246 "Remove corresponding -f option to proceed.\n", 247 event_type(j)); 248 return -1; 249 } 250 251 if (evsel && output[j].fields && 252 perf_evsel__check_attr(evsel, session)) 253 return -1; 254 } 255 256 return 0; 257 } 258 259 static void print_sample_start(struct perf_sample *sample, 260 struct thread *thread, 261 struct perf_event_attr *attr) 262 { 263 int type; 264 struct event *event; 265 const char *evname = NULL; 266 unsigned long secs; 267 unsigned long usecs; 268 unsigned long long nsecs; 269 270 if (PRINT_FIELD(COMM)) { 271 if (latency_format) 272 printf("%8.8s ", thread->comm); 273 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain) 274 printf("%s ", thread->comm); 275 else 276 printf("%16s ", thread->comm); 277 } 278 279 if (PRINT_FIELD(PID) && PRINT_FIELD(TID)) 280 printf("%5d/%-5d ", sample->pid, sample->tid); 281 else if (PRINT_FIELD(PID)) 282 printf("%5d ", sample->pid); 283 else if (PRINT_FIELD(TID)) 284 printf("%5d ", sample->tid); 285 286 if (PRINT_FIELD(CPU)) { 287 if (latency_format) 288 printf("%3d ", sample->cpu); 289 else 290 printf("[%03d] ", sample->cpu); 291 } 292 293 if (PRINT_FIELD(TIME)) { 294 nsecs = sample->time; 295 secs = nsecs / NSECS_PER_SEC; 296 nsecs -= secs * NSECS_PER_SEC; 297 usecs = nsecs / NSECS_PER_USEC; 298 printf("%5lu.%06lu: ", secs, usecs); 299 } 300 301 if (PRINT_FIELD(EVNAME)) { 302 if (attr->type == PERF_TYPE_TRACEPOINT) { 303 type = trace_parse_common_type(sample->raw_data); 304 event = trace_find_event(type); 305 if (event) 306 evname = event->name; 307 } else 308 evname = __event_name(attr->type, attr->config); 309 310 printf("%s: ", evname ? evname : "[unknown]"); 311 } 312 } 313 314 static bool is_bts_event(struct perf_event_attr *attr) 315 { 316 return ((attr->type == PERF_TYPE_HARDWARE) && 317 (attr->config & PERF_COUNT_HW_BRANCH_INSTRUCTIONS) && 318 (attr->sample_period == 1)); 319 } 320 321 static bool sample_addr_correlates_sym(struct perf_event_attr *attr) 322 { 323 if ((attr->type == PERF_TYPE_SOFTWARE) && 324 ((attr->config == PERF_COUNT_SW_PAGE_FAULTS) || 325 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MIN) || 326 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MAJ))) 327 return true; 328 329 if (is_bts_event(attr)) 330 return true; 331 332 return false; 333 } 334 335 static void print_sample_addr(union perf_event *event, 336 struct perf_sample *sample, 337 struct machine *machine, 338 struct thread *thread, 339 struct perf_event_attr *attr) 340 { 341 struct addr_location al; 342 u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK; 343 344 printf("%16" PRIx64, sample->addr); 345 346 if (!sample_addr_correlates_sym(attr)) 347 return; 348 349 thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION, 350 sample->addr, &al); 351 if (!al.map) 352 thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE, 353 sample->addr, &al); 354 355 al.cpu = sample->cpu; 356 al.sym = NULL; 357 358 if (al.map) 359 al.sym = map__find_symbol(al.map, al.addr, NULL); 360 361 if (PRINT_FIELD(SYM)) { 362 printf(" "); 363 if (PRINT_FIELD(SYMOFFSET)) 364 symbol__fprintf_symname_offs(al.sym, &al, stdout); 365 else 366 symbol__fprintf_symname(al.sym, stdout); 367 } 368 369 if (PRINT_FIELD(DSO)) { 370 printf(" ("); 371 map__fprintf_dsoname(al.map, stdout); 372 printf(")"); 373 } 374 } 375 376 static void print_sample_bts(union perf_event *event, 377 struct perf_sample *sample, 378 struct perf_evsel *evsel, 379 struct machine *machine, 380 struct thread *thread) 381 { 382 struct perf_event_attr *attr = &evsel->attr; 383 384 /* print branch_from information */ 385 if (PRINT_FIELD(IP)) { 386 if (!symbol_conf.use_callchain) 387 printf(" "); 388 else 389 printf("\n"); 390 perf_event__print_ip(event, sample, machine, evsel, 391 PRINT_FIELD(SYM), PRINT_FIELD(DSO), 392 PRINT_FIELD(SYMOFFSET)); 393 } 394 395 printf(" => "); 396 397 /* print branch_to information */ 398 if (PRINT_FIELD(ADDR)) 399 print_sample_addr(event, sample, machine, thread, attr); 400 401 printf("\n"); 402 } 403 404 static void process_event(union perf_event *event __unused, 405 struct perf_sample *sample, 406 struct perf_evsel *evsel, 407 struct machine *machine, 408 struct thread *thread) 409 { 410 struct perf_event_attr *attr = &evsel->attr; 411 412 if (output[attr->type].fields == 0) 413 return; 414 415 print_sample_start(sample, thread, attr); 416 417 if (is_bts_event(attr)) { 418 print_sample_bts(event, sample, evsel, machine, thread); 419 return; 420 } 421 422 if (PRINT_FIELD(TRACE)) 423 print_trace_event(sample->cpu, sample->raw_data, 424 sample->raw_size); 425 426 if (PRINT_FIELD(ADDR)) 427 print_sample_addr(event, sample, machine, thread, attr); 428 429 if (PRINT_FIELD(IP)) { 430 if (!symbol_conf.use_callchain) 431 printf(" "); 432 else 433 printf("\n"); 434 perf_event__print_ip(event, sample, machine, evsel, 435 PRINT_FIELD(SYM), PRINT_FIELD(DSO), 436 PRINT_FIELD(SYMOFFSET)); 437 } 438 439 printf("\n"); 440 } 441 442 static int default_start_script(const char *script __unused, 443 int argc __unused, 444 const char **argv __unused) 445 { 446 return 0; 447 } 448 449 static int default_stop_script(void) 450 { 451 return 0; 452 } 453 454 static int default_generate_script(const char *outfile __unused) 455 { 456 return 0; 457 } 458 459 static struct scripting_ops default_scripting_ops = { 460 .start_script = default_start_script, 461 .stop_script = default_stop_script, 462 .process_event = process_event, 463 .generate_script = default_generate_script, 464 }; 465 466 static struct scripting_ops *scripting_ops; 467 468 static void setup_scripting(void) 469 { 470 setup_perl_scripting(); 471 setup_python_scripting(); 472 473 scripting_ops = &default_scripting_ops; 474 } 475 476 static int cleanup_scripting(void) 477 { 478 pr_debug("\nperf script stopped\n"); 479 480 return scripting_ops->stop_script(); 481 } 482 483 static const char *input_name; 484 485 static int process_sample_event(struct perf_tool *tool __used, 486 union perf_event *event, 487 struct perf_sample *sample, 488 struct perf_evsel *evsel, 489 struct machine *machine) 490 { 491 struct addr_location al; 492 struct thread *thread = machine__findnew_thread(machine, event->ip.tid); 493 494 if (thread == NULL) { 495 pr_debug("problem processing %d event, skipping it.\n", 496 event->header.type); 497 return -1; 498 } 499 500 if (debug_mode) { 501 if (sample->time < last_timestamp) { 502 pr_err("Samples misordered, previous: %" PRIu64 503 " this: %" PRIu64 "\n", last_timestamp, 504 sample->time); 505 nr_unordered++; 506 } 507 last_timestamp = sample->time; 508 return 0; 509 } 510 511 if (perf_event__preprocess_sample(event, machine, &al, sample, 0) < 0) { 512 pr_err("problem processing %d event, skipping it.\n", 513 event->header.type); 514 return -1; 515 } 516 517 if (al.filtered) 518 return 0; 519 520 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap)) 521 return 0; 522 523 scripting_ops->process_event(event, sample, evsel, machine, thread); 524 525 evsel->hists.stats.total_period += sample->period; 526 return 0; 527 } 528 529 static struct perf_tool perf_script = { 530 .sample = process_sample_event, 531 .mmap = perf_event__process_mmap, 532 .comm = perf_event__process_comm, 533 .exit = perf_event__process_task, 534 .fork = perf_event__process_task, 535 .attr = perf_event__process_attr, 536 .event_type = perf_event__process_event_type, 537 .tracing_data = perf_event__process_tracing_data, 538 .build_id = perf_event__process_build_id, 539 .ordered_samples = true, 540 .ordering_requires_timestamps = true, 541 }; 542 543 extern volatile int session_done; 544 545 static void sig_handler(int sig __unused) 546 { 547 session_done = 1; 548 } 549 550 static int __cmd_script(struct perf_session *session) 551 { 552 int ret; 553 554 signal(SIGINT, sig_handler); 555 556 ret = perf_session__process_events(session, &perf_script); 557 558 if (debug_mode) 559 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered); 560 561 return ret; 562 } 563 564 struct script_spec { 565 struct list_head node; 566 struct scripting_ops *ops; 567 char spec[0]; 568 }; 569 570 static LIST_HEAD(script_specs); 571 572 static struct script_spec *script_spec__new(const char *spec, 573 struct scripting_ops *ops) 574 { 575 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1); 576 577 if (s != NULL) { 578 strcpy(s->spec, spec); 579 s->ops = ops; 580 } 581 582 return s; 583 } 584 585 static void script_spec__add(struct script_spec *s) 586 { 587 list_add_tail(&s->node, &script_specs); 588 } 589 590 static struct script_spec *script_spec__find(const char *spec) 591 { 592 struct script_spec *s; 593 594 list_for_each_entry(s, &script_specs, node) 595 if (strcasecmp(s->spec, spec) == 0) 596 return s; 597 return NULL; 598 } 599 600 static struct script_spec *script_spec__findnew(const char *spec, 601 struct scripting_ops *ops) 602 { 603 struct script_spec *s = script_spec__find(spec); 604 605 if (s) 606 return s; 607 608 s = script_spec__new(spec, ops); 609 if (!s) 610 return NULL; 611 612 script_spec__add(s); 613 614 return s; 615 } 616 617 int script_spec_register(const char *spec, struct scripting_ops *ops) 618 { 619 struct script_spec *s; 620 621 s = script_spec__find(spec); 622 if (s) 623 return -1; 624 625 s = script_spec__findnew(spec, ops); 626 if (!s) 627 return -1; 628 629 return 0; 630 } 631 632 static struct scripting_ops *script_spec__lookup(const char *spec) 633 { 634 struct script_spec *s = script_spec__find(spec); 635 if (!s) 636 return NULL; 637 638 return s->ops; 639 } 640 641 static void list_available_languages(void) 642 { 643 struct script_spec *s; 644 645 fprintf(stderr, "\n"); 646 fprintf(stderr, "Scripting language extensions (used in " 647 "perf script -s [spec:]script.[spec]):\n\n"); 648 649 list_for_each_entry(s, &script_specs, node) 650 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name); 651 652 fprintf(stderr, "\n"); 653 } 654 655 static int parse_scriptname(const struct option *opt __used, 656 const char *str, int unset __used) 657 { 658 char spec[PATH_MAX]; 659 const char *script, *ext; 660 int len; 661 662 if (strcmp(str, "lang") == 0) { 663 list_available_languages(); 664 exit(0); 665 } 666 667 script = strchr(str, ':'); 668 if (script) { 669 len = script - str; 670 if (len >= PATH_MAX) { 671 fprintf(stderr, "invalid language specifier"); 672 return -1; 673 } 674 strncpy(spec, str, len); 675 spec[len] = '\0'; 676 scripting_ops = script_spec__lookup(spec); 677 if (!scripting_ops) { 678 fprintf(stderr, "invalid language specifier"); 679 return -1; 680 } 681 script++; 682 } else { 683 script = str; 684 ext = strrchr(script, '.'); 685 if (!ext) { 686 fprintf(stderr, "invalid script extension"); 687 return -1; 688 } 689 scripting_ops = script_spec__lookup(++ext); 690 if (!scripting_ops) { 691 fprintf(stderr, "invalid script extension"); 692 return -1; 693 } 694 } 695 696 script_name = strdup(script); 697 698 return 0; 699 } 700 701 static int parse_output_fields(const struct option *opt __used, 702 const char *arg, int unset __used) 703 { 704 char *tok; 705 int i, imax = sizeof(all_output_options) / sizeof(struct output_option); 706 int j; 707 int rc = 0; 708 char *str = strdup(arg); 709 int type = -1; 710 711 if (!str) 712 return -ENOMEM; 713 714 /* first word can state for which event type the user is specifying 715 * the fields. If no type exists, the specified fields apply to all 716 * event types found in the file minus the invalid fields for a type. 717 */ 718 tok = strchr(str, ':'); 719 if (tok) { 720 *tok = '\0'; 721 tok++; 722 if (!strcmp(str, "hw")) 723 type = PERF_TYPE_HARDWARE; 724 else if (!strcmp(str, "sw")) 725 type = PERF_TYPE_SOFTWARE; 726 else if (!strcmp(str, "trace")) 727 type = PERF_TYPE_TRACEPOINT; 728 else if (!strcmp(str, "raw")) 729 type = PERF_TYPE_RAW; 730 else { 731 fprintf(stderr, "Invalid event type in field string.\n"); 732 rc = -EINVAL; 733 goto out; 734 } 735 736 if (output[type].user_set) 737 pr_warning("Overriding previous field request for %s events.\n", 738 event_type(type)); 739 740 output[type].fields = 0; 741 output[type].user_set = true; 742 output[type].wildcard_set = false; 743 744 } else { 745 tok = str; 746 if (strlen(str) == 0) { 747 fprintf(stderr, 748 "Cannot set fields to 'none' for all event types.\n"); 749 rc = -EINVAL; 750 goto out; 751 } 752 753 if (output_set_by_user()) 754 pr_warning("Overriding previous field request for all events.\n"); 755 756 for (j = 0; j < PERF_TYPE_MAX; ++j) { 757 output[j].fields = 0; 758 output[j].user_set = true; 759 output[j].wildcard_set = true; 760 } 761 } 762 763 tok = strtok(tok, ","); 764 while (tok) { 765 for (i = 0; i < imax; ++i) { 766 if (strcmp(tok, all_output_options[i].str) == 0) 767 break; 768 } 769 if (i == imax) { 770 fprintf(stderr, "Invalid field requested.\n"); 771 rc = -EINVAL; 772 goto out; 773 } 774 775 if (type == -1) { 776 /* add user option to all events types for 777 * which it is valid 778 */ 779 for (j = 0; j < PERF_TYPE_MAX; ++j) { 780 if (output[j].invalid_fields & all_output_options[i].field) { 781 pr_warning("\'%s\' not valid for %s events. Ignoring.\n", 782 all_output_options[i].str, event_type(j)); 783 } else 784 output[j].fields |= all_output_options[i].field; 785 } 786 } else { 787 if (output[type].invalid_fields & all_output_options[i].field) { 788 fprintf(stderr, "\'%s\' not valid for %s events.\n", 789 all_output_options[i].str, event_type(type)); 790 791 rc = -EINVAL; 792 goto out; 793 } 794 output[type].fields |= all_output_options[i].field; 795 } 796 797 tok = strtok(NULL, ","); 798 } 799 800 if (type >= 0) { 801 if (output[type].fields == 0) { 802 pr_debug("No fields requested for %s type. " 803 "Events will not be displayed.\n", event_type(type)); 804 } 805 } 806 807 out: 808 free(str); 809 return rc; 810 } 811 812 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */ 813 static int is_directory(const char *base_path, const struct dirent *dent) 814 { 815 char path[PATH_MAX]; 816 struct stat st; 817 818 sprintf(path, "%s/%s", base_path, dent->d_name); 819 if (stat(path, &st)) 820 return 0; 821 822 return S_ISDIR(st.st_mode); 823 } 824 825 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\ 826 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \ 827 lang_next) \ 828 if ((lang_dirent.d_type == DT_DIR || \ 829 (lang_dirent.d_type == DT_UNKNOWN && \ 830 is_directory(scripts_path, &lang_dirent))) && \ 831 (strcmp(lang_dirent.d_name, ".")) && \ 832 (strcmp(lang_dirent.d_name, ".."))) 833 834 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\ 835 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \ 836 script_next) \ 837 if (script_dirent.d_type != DT_DIR && \ 838 (script_dirent.d_type != DT_UNKNOWN || \ 839 !is_directory(lang_path, &script_dirent))) 840 841 842 #define RECORD_SUFFIX "-record" 843 #define REPORT_SUFFIX "-report" 844 845 struct script_desc { 846 struct list_head node; 847 char *name; 848 char *half_liner; 849 char *args; 850 }; 851 852 static LIST_HEAD(script_descs); 853 854 static struct script_desc *script_desc__new(const char *name) 855 { 856 struct script_desc *s = zalloc(sizeof(*s)); 857 858 if (s != NULL && name) 859 s->name = strdup(name); 860 861 return s; 862 } 863 864 static void script_desc__delete(struct script_desc *s) 865 { 866 free(s->name); 867 free(s->half_liner); 868 free(s->args); 869 free(s); 870 } 871 872 static void script_desc__add(struct script_desc *s) 873 { 874 list_add_tail(&s->node, &script_descs); 875 } 876 877 static struct script_desc *script_desc__find(const char *name) 878 { 879 struct script_desc *s; 880 881 list_for_each_entry(s, &script_descs, node) 882 if (strcasecmp(s->name, name) == 0) 883 return s; 884 return NULL; 885 } 886 887 static struct script_desc *script_desc__findnew(const char *name) 888 { 889 struct script_desc *s = script_desc__find(name); 890 891 if (s) 892 return s; 893 894 s = script_desc__new(name); 895 if (!s) 896 goto out_delete_desc; 897 898 script_desc__add(s); 899 900 return s; 901 902 out_delete_desc: 903 script_desc__delete(s); 904 905 return NULL; 906 } 907 908 static const char *ends_with(const char *str, const char *suffix) 909 { 910 size_t suffix_len = strlen(suffix); 911 const char *p = str; 912 913 if (strlen(str) > suffix_len) { 914 p = str + strlen(str) - suffix_len; 915 if (!strncmp(p, suffix, suffix_len)) 916 return p; 917 } 918 919 return NULL; 920 } 921 922 static char *ltrim(char *str) 923 { 924 int len = strlen(str); 925 926 while (len && isspace(*str)) { 927 len--; 928 str++; 929 } 930 931 return str; 932 } 933 934 static int read_script_info(struct script_desc *desc, const char *filename) 935 { 936 char line[BUFSIZ], *p; 937 FILE *fp; 938 939 fp = fopen(filename, "r"); 940 if (!fp) 941 return -1; 942 943 while (fgets(line, sizeof(line), fp)) { 944 p = ltrim(line); 945 if (strlen(p) == 0) 946 continue; 947 if (*p != '#') 948 continue; 949 p++; 950 if (strlen(p) && *p == '!') 951 continue; 952 953 p = ltrim(p); 954 if (strlen(p) && p[strlen(p) - 1] == '\n') 955 p[strlen(p) - 1] = '\0'; 956 957 if (!strncmp(p, "description:", strlen("description:"))) { 958 p += strlen("description:"); 959 desc->half_liner = strdup(ltrim(p)); 960 continue; 961 } 962 963 if (!strncmp(p, "args:", strlen("args:"))) { 964 p += strlen("args:"); 965 desc->args = strdup(ltrim(p)); 966 continue; 967 } 968 } 969 970 fclose(fp); 971 972 return 0; 973 } 974 975 static char *get_script_root(struct dirent *script_dirent, const char *suffix) 976 { 977 char *script_root, *str; 978 979 script_root = strdup(script_dirent->d_name); 980 if (!script_root) 981 return NULL; 982 983 str = (char *)ends_with(script_root, suffix); 984 if (!str) { 985 free(script_root); 986 return NULL; 987 } 988 989 *str = '\0'; 990 return script_root; 991 } 992 993 static int list_available_scripts(const struct option *opt __used, 994 const char *s __used, int unset __used) 995 { 996 struct dirent *script_next, *lang_next, script_dirent, lang_dirent; 997 char scripts_path[MAXPATHLEN]; 998 DIR *scripts_dir, *lang_dir; 999 char script_path[MAXPATHLEN]; 1000 char lang_path[MAXPATHLEN]; 1001 struct script_desc *desc; 1002 char first_half[BUFSIZ]; 1003 char *script_root; 1004 1005 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path()); 1006 1007 scripts_dir = opendir(scripts_path); 1008 if (!scripts_dir) 1009 return -1; 1010 1011 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) { 1012 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path, 1013 lang_dirent.d_name); 1014 lang_dir = opendir(lang_path); 1015 if (!lang_dir) 1016 continue; 1017 1018 for_each_script(lang_path, lang_dir, script_dirent, script_next) { 1019 script_root = get_script_root(&script_dirent, REPORT_SUFFIX); 1020 if (script_root) { 1021 desc = script_desc__findnew(script_root); 1022 snprintf(script_path, MAXPATHLEN, "%s/%s", 1023 lang_path, script_dirent.d_name); 1024 read_script_info(desc, script_path); 1025 free(script_root); 1026 } 1027 } 1028 } 1029 1030 fprintf(stdout, "List of available trace scripts:\n"); 1031 list_for_each_entry(desc, &script_descs, node) { 1032 sprintf(first_half, "%s %s", desc->name, 1033 desc->args ? desc->args : ""); 1034 fprintf(stdout, " %-36s %s\n", first_half, 1035 desc->half_liner ? desc->half_liner : ""); 1036 } 1037 1038 exit(0); 1039 } 1040 1041 static char *get_script_path(const char *script_root, const char *suffix) 1042 { 1043 struct dirent *script_next, *lang_next, script_dirent, lang_dirent; 1044 char scripts_path[MAXPATHLEN]; 1045 char script_path[MAXPATHLEN]; 1046 DIR *scripts_dir, *lang_dir; 1047 char lang_path[MAXPATHLEN]; 1048 char *__script_root; 1049 1050 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path()); 1051 1052 scripts_dir = opendir(scripts_path); 1053 if (!scripts_dir) 1054 return NULL; 1055 1056 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) { 1057 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path, 1058 lang_dirent.d_name); 1059 lang_dir = opendir(lang_path); 1060 if (!lang_dir) 1061 continue; 1062 1063 for_each_script(lang_path, lang_dir, script_dirent, script_next) { 1064 __script_root = get_script_root(&script_dirent, suffix); 1065 if (__script_root && !strcmp(script_root, __script_root)) { 1066 free(__script_root); 1067 closedir(lang_dir); 1068 closedir(scripts_dir); 1069 snprintf(script_path, MAXPATHLEN, "%s/%s", 1070 lang_path, script_dirent.d_name); 1071 return strdup(script_path); 1072 } 1073 free(__script_root); 1074 } 1075 closedir(lang_dir); 1076 } 1077 closedir(scripts_dir); 1078 1079 return NULL; 1080 } 1081 1082 static bool is_top_script(const char *script_path) 1083 { 1084 return ends_with(script_path, "top") == NULL ? false : true; 1085 } 1086 1087 static int has_required_arg(char *script_path) 1088 { 1089 struct script_desc *desc; 1090 int n_args = 0; 1091 char *p; 1092 1093 desc = script_desc__new(NULL); 1094 1095 if (read_script_info(desc, script_path)) 1096 goto out; 1097 1098 if (!desc->args) 1099 goto out; 1100 1101 for (p = desc->args; *p; p++) 1102 if (*p == '<') 1103 n_args++; 1104 out: 1105 script_desc__delete(desc); 1106 1107 return n_args; 1108 } 1109 1110 static const char * const script_usage[] = { 1111 "perf script [<options>]", 1112 "perf script [<options>] record <script> [<record-options>] <command>", 1113 "perf script [<options>] report <script> [script-args]", 1114 "perf script [<options>] <script> [<record-options>] <command>", 1115 "perf script [<options>] <top-script> [script-args]", 1116 NULL 1117 }; 1118 1119 static const struct option options[] = { 1120 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, 1121 "dump raw trace in ASCII"), 1122 OPT_INCR('v', "verbose", &verbose, 1123 "be more verbose (show symbol address, etc)"), 1124 OPT_BOOLEAN('L', "Latency", &latency_format, 1125 "show latency attributes (irqs/preemption disabled, etc)"), 1126 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts", 1127 list_available_scripts), 1128 OPT_CALLBACK('s', "script", NULL, "name", 1129 "script file name (lang:script name, script name, or *)", 1130 parse_scriptname), 1131 OPT_STRING('g', "gen-script", &generate_script_lang, "lang", 1132 "generate perf-script.xx script in specified language"), 1133 OPT_STRING('i', "input", &input_name, "file", 1134 "input file name"), 1135 OPT_BOOLEAN('d', "debug-mode", &debug_mode, 1136 "do various checks like samples ordering and lost events"), 1137 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, 1138 "file", "vmlinux pathname"), 1139 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, 1140 "file", "kallsyms pathname"), 1141 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain, 1142 "When printing symbols do not display call chain"), 1143 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory", 1144 "Look for files with symbols relative to this directory"), 1145 OPT_CALLBACK('f', "fields", NULL, "str", 1146 "comma separated output fields prepend with 'type:'. " 1147 "Valid types: hw,sw,trace,raw. " 1148 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso," 1149 "addr,symoff", 1150 parse_output_fields), 1151 OPT_BOOLEAN('a', "all-cpus", &system_wide, 1152 "system-wide collection from all CPUs"), 1153 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"), 1154 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]", 1155 "only display events for these comms"), 1156 OPT_BOOLEAN('I', "show-info", &show_full_info, 1157 "display extended information from perf.data file"), 1158 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path, 1159 "Show the path of [kernel.kallsyms]"), 1160 1161 OPT_END() 1162 }; 1163 1164 static bool have_cmd(int argc, const char **argv) 1165 { 1166 char **__argv = malloc(sizeof(const char *) * argc); 1167 1168 if (!__argv) 1169 die("malloc"); 1170 memcpy(__argv, argv, sizeof(const char *) * argc); 1171 argc = parse_options(argc, (const char **)__argv, record_options, 1172 NULL, PARSE_OPT_STOP_AT_NON_OPTION); 1173 free(__argv); 1174 1175 return argc != 0; 1176 } 1177 1178 int cmd_script(int argc, const char **argv, const char *prefix __used) 1179 { 1180 char *rec_script_path = NULL; 1181 char *rep_script_path = NULL; 1182 struct perf_session *session; 1183 char *script_path = NULL; 1184 const char **__argv; 1185 int i, j, err; 1186 1187 setup_scripting(); 1188 1189 argc = parse_options(argc, argv, options, script_usage, 1190 PARSE_OPT_STOP_AT_NON_OPTION); 1191 1192 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) { 1193 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX); 1194 if (!rec_script_path) 1195 return cmd_record(argc, argv, NULL); 1196 } 1197 1198 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) { 1199 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX); 1200 if (!rep_script_path) { 1201 fprintf(stderr, 1202 "Please specify a valid report script" 1203 "(see 'perf script -l' for listing)\n"); 1204 return -1; 1205 } 1206 } 1207 1208 /* make sure PERF_EXEC_PATH is set for scripts */ 1209 perf_set_argv_exec_path(perf_exec_path()); 1210 1211 if (argc && !script_name && !rec_script_path && !rep_script_path) { 1212 int live_pipe[2]; 1213 int rep_args; 1214 pid_t pid; 1215 1216 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX); 1217 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX); 1218 1219 if (!rec_script_path && !rep_script_path) { 1220 fprintf(stderr, " Couldn't find script %s\n\n See perf" 1221 " script -l for available scripts.\n", argv[0]); 1222 usage_with_options(script_usage, options); 1223 } 1224 1225 if (is_top_script(argv[0])) { 1226 rep_args = argc - 1; 1227 } else { 1228 int rec_args; 1229 1230 rep_args = has_required_arg(rep_script_path); 1231 rec_args = (argc - 1) - rep_args; 1232 if (rec_args < 0) { 1233 fprintf(stderr, " %s script requires options." 1234 "\n\n See perf script -l for available " 1235 "scripts and options.\n", argv[0]); 1236 usage_with_options(script_usage, options); 1237 } 1238 } 1239 1240 if (pipe(live_pipe) < 0) { 1241 perror("failed to create pipe"); 1242 exit(-1); 1243 } 1244 1245 pid = fork(); 1246 if (pid < 0) { 1247 perror("failed to fork"); 1248 exit(-1); 1249 } 1250 1251 if (!pid) { 1252 j = 0; 1253 1254 dup2(live_pipe[1], 1); 1255 close(live_pipe[0]); 1256 1257 if (is_top_script(argv[0])) { 1258 system_wide = true; 1259 } else if (!system_wide) { 1260 system_wide = !have_cmd(argc - rep_args, 1261 &argv[rep_args]); 1262 } 1263 1264 __argv = malloc((argc + 6) * sizeof(const char *)); 1265 if (!__argv) 1266 die("malloc"); 1267 1268 __argv[j++] = "/bin/sh"; 1269 __argv[j++] = rec_script_path; 1270 if (system_wide) 1271 __argv[j++] = "-a"; 1272 __argv[j++] = "-q"; 1273 __argv[j++] = "-o"; 1274 __argv[j++] = "-"; 1275 for (i = rep_args + 1; i < argc; i++) 1276 __argv[j++] = argv[i]; 1277 __argv[j++] = NULL; 1278 1279 execvp("/bin/sh", (char **)__argv); 1280 free(__argv); 1281 exit(-1); 1282 } 1283 1284 dup2(live_pipe[0], 0); 1285 close(live_pipe[1]); 1286 1287 __argv = malloc((argc + 4) * sizeof(const char *)); 1288 if (!__argv) 1289 die("malloc"); 1290 j = 0; 1291 __argv[j++] = "/bin/sh"; 1292 __argv[j++] = rep_script_path; 1293 for (i = 1; i < rep_args + 1; i++) 1294 __argv[j++] = argv[i]; 1295 __argv[j++] = "-i"; 1296 __argv[j++] = "-"; 1297 __argv[j++] = NULL; 1298 1299 execvp("/bin/sh", (char **)__argv); 1300 free(__argv); 1301 exit(-1); 1302 } 1303 1304 if (rec_script_path) 1305 script_path = rec_script_path; 1306 if (rep_script_path) 1307 script_path = rep_script_path; 1308 1309 if (script_path) { 1310 j = 0; 1311 1312 if (!rec_script_path) 1313 system_wide = false; 1314 else if (!system_wide) 1315 system_wide = !have_cmd(argc - 1, &argv[1]); 1316 1317 __argv = malloc((argc + 2) * sizeof(const char *)); 1318 if (!__argv) 1319 die("malloc"); 1320 __argv[j++] = "/bin/sh"; 1321 __argv[j++] = script_path; 1322 if (system_wide) 1323 __argv[j++] = "-a"; 1324 for (i = 2; i < argc; i++) 1325 __argv[j++] = argv[i]; 1326 __argv[j++] = NULL; 1327 1328 execvp("/bin/sh", (char **)__argv); 1329 free(__argv); 1330 exit(-1); 1331 } 1332 1333 if (symbol__init() < 0) 1334 return -1; 1335 if (!script_name) 1336 setup_pager(); 1337 1338 session = perf_session__new(input_name, O_RDONLY, 0, false, &perf_script); 1339 if (session == NULL) 1340 return -ENOMEM; 1341 1342 if (cpu_list) { 1343 if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap)) 1344 return -1; 1345 } 1346 1347 perf_session__fprintf_info(session, stdout, show_full_info); 1348 1349 if (!no_callchain) 1350 symbol_conf.use_callchain = true; 1351 else 1352 symbol_conf.use_callchain = false; 1353 1354 if (generate_script_lang) { 1355 struct stat perf_stat; 1356 int input; 1357 1358 if (output_set_by_user()) { 1359 fprintf(stderr, 1360 "custom fields not supported for generated scripts"); 1361 return -1; 1362 } 1363 1364 input = open(session->filename, O_RDONLY); /* input_name */ 1365 if (input < 0) { 1366 perror("failed to open file"); 1367 exit(-1); 1368 } 1369 1370 err = fstat(input, &perf_stat); 1371 if (err < 0) { 1372 perror("failed to stat file"); 1373 exit(-1); 1374 } 1375 1376 if (!perf_stat.st_size) { 1377 fprintf(stderr, "zero-sized file, nothing to do!\n"); 1378 exit(0); 1379 } 1380 1381 scripting_ops = script_spec__lookup(generate_script_lang); 1382 if (!scripting_ops) { 1383 fprintf(stderr, "invalid language specifier"); 1384 return -1; 1385 } 1386 1387 err = scripting_ops->generate_script("perf-script"); 1388 goto out; 1389 } 1390 1391 if (script_name) { 1392 err = scripting_ops->start_script(script_name, argc, argv); 1393 if (err) 1394 goto out; 1395 pr_debug("perf script started with script %s\n\n", script_name); 1396 } 1397 1398 1399 err = perf_session__check_output_opt(session); 1400 if (err < 0) 1401 goto out; 1402 1403 err = __cmd_script(session); 1404 1405 perf_session__delete(session); 1406 cleanup_scripting(); 1407 out: 1408 return err; 1409 } 1410