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/symbol.h" 11 #include "util/thread.h" 12 #include "util/trace-event.h" 13 #include "util/parse-options.h" 14 #include "util/util.h" 15 #include "util/evlist.h" 16 #include "util/evsel.h" 17 18 static char const *script_name; 19 static char const *generate_script_lang; 20 static bool debug_mode; 21 static u64 last_timestamp; 22 static u64 nr_unordered; 23 extern const struct option record_options[]; 24 static bool no_callchain; 25 26 enum perf_output_field { 27 PERF_OUTPUT_COMM = 1U << 0, 28 PERF_OUTPUT_TID = 1U << 1, 29 PERF_OUTPUT_PID = 1U << 2, 30 PERF_OUTPUT_TIME = 1U << 3, 31 PERF_OUTPUT_CPU = 1U << 4, 32 PERF_OUTPUT_EVNAME = 1U << 5, 33 PERF_OUTPUT_TRACE = 1U << 6, 34 PERF_OUTPUT_SYM = 1U << 7, 35 }; 36 37 struct output_option { 38 const char *str; 39 enum perf_output_field field; 40 } all_output_options[] = { 41 {.str = "comm", .field = PERF_OUTPUT_COMM}, 42 {.str = "tid", .field = PERF_OUTPUT_TID}, 43 {.str = "pid", .field = PERF_OUTPUT_PID}, 44 {.str = "time", .field = PERF_OUTPUT_TIME}, 45 {.str = "cpu", .field = PERF_OUTPUT_CPU}, 46 {.str = "event", .field = PERF_OUTPUT_EVNAME}, 47 {.str = "trace", .field = PERF_OUTPUT_TRACE}, 48 {.str = "sym", .field = PERF_OUTPUT_SYM}, 49 }; 50 51 /* default set to maintain compatibility with current format */ 52 static u64 output_fields[PERF_TYPE_MAX] = { 53 [PERF_TYPE_HARDWARE] = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | \ 54 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | \ 55 PERF_OUTPUT_EVNAME | PERF_OUTPUT_SYM, 56 57 [PERF_TYPE_SOFTWARE] = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | \ 58 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | \ 59 PERF_OUTPUT_EVNAME | PERF_OUTPUT_SYM, 60 61 [PERF_TYPE_TRACEPOINT] = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | \ 62 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | \ 63 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE, 64 }; 65 66 static bool output_set_by_user; 67 68 #define PRINT_FIELD(x) (output_fields[attr->type] & PERF_OUTPUT_##x) 69 70 static int perf_session__check_attr(struct perf_session *session, 71 struct perf_event_attr *attr) 72 { 73 if (PRINT_FIELD(TRACE) && 74 !perf_session__has_traces(session, "record -R")) 75 return -EINVAL; 76 77 if (PRINT_FIELD(SYM)) { 78 if (!(session->sample_type & PERF_SAMPLE_IP)) { 79 pr_err("Samples do not contain IP data.\n"); 80 return -EINVAL; 81 } 82 if (!no_callchain && 83 !(session->sample_type & PERF_SAMPLE_CALLCHAIN)) 84 symbol_conf.use_callchain = false; 85 } 86 87 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) && 88 !(session->sample_type & PERF_SAMPLE_TID)) { 89 pr_err("Samples do not contain TID/PID data.\n"); 90 return -EINVAL; 91 } 92 93 if (PRINT_FIELD(TIME) && 94 !(session->sample_type & PERF_SAMPLE_TIME)) { 95 pr_err("Samples do not contain timestamps.\n"); 96 return -EINVAL; 97 } 98 99 if (PRINT_FIELD(CPU) && 100 !(session->sample_type & PERF_SAMPLE_CPU)) { 101 pr_err("Samples do not contain cpu.\n"); 102 return -EINVAL; 103 } 104 105 return 0; 106 } 107 108 static void print_sample_start(struct perf_sample *sample, 109 struct thread *thread, 110 struct perf_event_attr *attr) 111 { 112 int type; 113 struct event *event; 114 const char *evname = NULL; 115 unsigned long secs; 116 unsigned long usecs; 117 unsigned long long nsecs; 118 119 if (PRINT_FIELD(COMM)) { 120 if (latency_format) 121 printf("%8.8s ", thread->comm); 122 else if (PRINT_FIELD(SYM) && symbol_conf.use_callchain) 123 printf("%s ", thread->comm); 124 else 125 printf("%16s ", thread->comm); 126 } 127 128 if (PRINT_FIELD(PID) && PRINT_FIELD(TID)) 129 printf("%5d/%-5d ", sample->pid, sample->tid); 130 else if (PRINT_FIELD(PID)) 131 printf("%5d ", sample->pid); 132 else if (PRINT_FIELD(TID)) 133 printf("%5d ", sample->tid); 134 135 if (PRINT_FIELD(CPU)) { 136 if (latency_format) 137 printf("%3d ", sample->cpu); 138 else 139 printf("[%03d] ", sample->cpu); 140 } 141 142 if (PRINT_FIELD(TIME)) { 143 nsecs = sample->time; 144 secs = nsecs / NSECS_PER_SEC; 145 nsecs -= secs * NSECS_PER_SEC; 146 usecs = nsecs / NSECS_PER_USEC; 147 printf("%5lu.%06lu: ", secs, usecs); 148 } 149 150 if (PRINT_FIELD(EVNAME)) { 151 if (attr->type == PERF_TYPE_TRACEPOINT) { 152 type = trace_parse_common_type(sample->raw_data); 153 event = trace_find_event(type); 154 if (event) 155 evname = event->name; 156 } else 157 evname = __event_name(attr->type, attr->config); 158 159 printf("%s: ", evname ? evname : "(unknown)"); 160 } 161 } 162 163 static void process_event(union perf_event *event __unused, 164 struct perf_sample *sample, 165 struct perf_session *session, 166 struct thread *thread) 167 { 168 struct perf_event_attr *attr; 169 struct perf_evsel *evsel; 170 171 evsel = perf_evlist__id2evsel(session->evlist, sample->id); 172 if (evsel == NULL) { 173 pr_err("Invalid data. Contains samples with id not in " 174 "its header!\n"); 175 return; 176 } 177 attr = &evsel->attr; 178 179 if (output_fields[attr->type] == 0) 180 return; 181 182 if (perf_session__check_attr(session, attr) < 0) 183 return; 184 185 print_sample_start(sample, thread, attr); 186 187 if (PRINT_FIELD(TRACE)) 188 print_trace_event(sample->cpu, sample->raw_data, 189 sample->raw_size); 190 191 if (PRINT_FIELD(SYM)) { 192 if (!symbol_conf.use_callchain) 193 printf(" "); 194 else 195 printf("\n"); 196 perf_session__print_symbols(event, sample, session); 197 } 198 199 printf("\n"); 200 } 201 202 static int default_start_script(const char *script __unused, 203 int argc __unused, 204 const char **argv __unused) 205 { 206 return 0; 207 } 208 209 static int default_stop_script(void) 210 { 211 return 0; 212 } 213 214 static int default_generate_script(const char *outfile __unused) 215 { 216 return 0; 217 } 218 219 static struct scripting_ops default_scripting_ops = { 220 .start_script = default_start_script, 221 .stop_script = default_stop_script, 222 .process_event = process_event, 223 .generate_script = default_generate_script, 224 }; 225 226 static struct scripting_ops *scripting_ops; 227 228 static void setup_scripting(void) 229 { 230 setup_perl_scripting(); 231 setup_python_scripting(); 232 233 scripting_ops = &default_scripting_ops; 234 } 235 236 static int cleanup_scripting(void) 237 { 238 pr_debug("\nperf script stopped\n"); 239 240 return scripting_ops->stop_script(); 241 } 242 243 static char const *input_name = "perf.data"; 244 245 static int process_sample_event(union perf_event *event, 246 struct perf_sample *sample, 247 struct perf_session *session) 248 { 249 struct thread *thread = perf_session__findnew(session, event->ip.pid); 250 251 if (thread == NULL) { 252 pr_debug("problem processing %d event, skipping it.\n", 253 event->header.type); 254 return -1; 255 } 256 257 if (debug_mode) { 258 if (sample->time < last_timestamp) { 259 pr_err("Samples misordered, previous: %" PRIu64 260 " this: %" PRIu64 "\n", last_timestamp, 261 sample->time); 262 nr_unordered++; 263 } 264 last_timestamp = sample->time; 265 return 0; 266 } 267 scripting_ops->process_event(event, sample, session, thread); 268 269 session->hists.stats.total_period += sample->period; 270 return 0; 271 } 272 273 static struct perf_event_ops event_ops = { 274 .sample = process_sample_event, 275 .mmap = perf_event__process_mmap, 276 .comm = perf_event__process_comm, 277 .exit = perf_event__process_task, 278 .fork = perf_event__process_task, 279 .attr = perf_event__process_attr, 280 .event_type = perf_event__process_event_type, 281 .tracing_data = perf_event__process_tracing_data, 282 .build_id = perf_event__process_build_id, 283 .ordered_samples = true, 284 .ordering_requires_timestamps = true, 285 }; 286 287 extern volatile int session_done; 288 289 static void sig_handler(int sig __unused) 290 { 291 session_done = 1; 292 } 293 294 static int __cmd_script(struct perf_session *session) 295 { 296 int ret; 297 298 signal(SIGINT, sig_handler); 299 300 ret = perf_session__process_events(session, &event_ops); 301 302 if (debug_mode) 303 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered); 304 305 return ret; 306 } 307 308 struct script_spec { 309 struct list_head node; 310 struct scripting_ops *ops; 311 char spec[0]; 312 }; 313 314 static LIST_HEAD(script_specs); 315 316 static struct script_spec *script_spec__new(const char *spec, 317 struct scripting_ops *ops) 318 { 319 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1); 320 321 if (s != NULL) { 322 strcpy(s->spec, spec); 323 s->ops = ops; 324 } 325 326 return s; 327 } 328 329 static void script_spec__delete(struct script_spec *s) 330 { 331 free(s->spec); 332 free(s); 333 } 334 335 static void script_spec__add(struct script_spec *s) 336 { 337 list_add_tail(&s->node, &script_specs); 338 } 339 340 static struct script_spec *script_spec__find(const char *spec) 341 { 342 struct script_spec *s; 343 344 list_for_each_entry(s, &script_specs, node) 345 if (strcasecmp(s->spec, spec) == 0) 346 return s; 347 return NULL; 348 } 349 350 static struct script_spec *script_spec__findnew(const char *spec, 351 struct scripting_ops *ops) 352 { 353 struct script_spec *s = script_spec__find(spec); 354 355 if (s) 356 return s; 357 358 s = script_spec__new(spec, ops); 359 if (!s) 360 goto out_delete_spec; 361 362 script_spec__add(s); 363 364 return s; 365 366 out_delete_spec: 367 script_spec__delete(s); 368 369 return NULL; 370 } 371 372 int script_spec_register(const char *spec, struct scripting_ops *ops) 373 { 374 struct script_spec *s; 375 376 s = script_spec__find(spec); 377 if (s) 378 return -1; 379 380 s = script_spec__findnew(spec, ops); 381 if (!s) 382 return -1; 383 384 return 0; 385 } 386 387 static struct scripting_ops *script_spec__lookup(const char *spec) 388 { 389 struct script_spec *s = script_spec__find(spec); 390 if (!s) 391 return NULL; 392 393 return s->ops; 394 } 395 396 static void list_available_languages(void) 397 { 398 struct script_spec *s; 399 400 fprintf(stderr, "\n"); 401 fprintf(stderr, "Scripting language extensions (used in " 402 "perf script -s [spec:]script.[spec]):\n\n"); 403 404 list_for_each_entry(s, &script_specs, node) 405 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name); 406 407 fprintf(stderr, "\n"); 408 } 409 410 static int parse_scriptname(const struct option *opt __used, 411 const char *str, int unset __used) 412 { 413 char spec[PATH_MAX]; 414 const char *script, *ext; 415 int len; 416 417 if (strcmp(str, "lang") == 0) { 418 list_available_languages(); 419 exit(0); 420 } 421 422 script = strchr(str, ':'); 423 if (script) { 424 len = script - str; 425 if (len >= PATH_MAX) { 426 fprintf(stderr, "invalid language specifier"); 427 return -1; 428 } 429 strncpy(spec, str, len); 430 spec[len] = '\0'; 431 scripting_ops = script_spec__lookup(spec); 432 if (!scripting_ops) { 433 fprintf(stderr, "invalid language specifier"); 434 return -1; 435 } 436 script++; 437 } else { 438 script = str; 439 ext = strrchr(script, '.'); 440 if (!ext) { 441 fprintf(stderr, "invalid script extension"); 442 return -1; 443 } 444 scripting_ops = script_spec__lookup(++ext); 445 if (!scripting_ops) { 446 fprintf(stderr, "invalid script extension"); 447 return -1; 448 } 449 } 450 451 script_name = strdup(script); 452 453 return 0; 454 } 455 456 static int parse_output_fields(const struct option *opt __used, 457 const char *arg, int unset __used) 458 { 459 char *tok; 460 int i, imax = sizeof(all_output_options) / sizeof(struct output_option); 461 int rc = 0; 462 char *str = strdup(arg); 463 int type = -1; 464 465 if (!str) 466 return -ENOMEM; 467 468 tok = strtok(str, ":"); 469 if (!tok) { 470 fprintf(stderr, 471 "Invalid field string - not prepended with type."); 472 return -EINVAL; 473 } 474 475 /* first word should state which event type user 476 * is specifying the fields 477 */ 478 if (!strcmp(tok, "hw")) 479 type = PERF_TYPE_HARDWARE; 480 else if (!strcmp(tok, "sw")) 481 type = PERF_TYPE_SOFTWARE; 482 else if (!strcmp(tok, "trace")) 483 type = PERF_TYPE_TRACEPOINT; 484 else { 485 fprintf(stderr, "Invalid event type in field string."); 486 return -EINVAL; 487 } 488 489 output_fields[type] = 0; 490 while (1) { 491 tok = strtok(NULL, ","); 492 if (!tok) 493 break; 494 for (i = 0; i < imax; ++i) { 495 if (strcmp(tok, all_output_options[i].str) == 0) { 496 output_fields[type] |= all_output_options[i].field; 497 break; 498 } 499 } 500 if (i == imax) { 501 fprintf(stderr, "Invalid field requested."); 502 rc = -EINVAL; 503 break; 504 } 505 } 506 507 if (output_fields[type] == 0) { 508 pr_debug("No fields requested for %s type. " 509 "Events will not be displayed\n", event_type(type)); 510 } 511 512 output_set_by_user = true; 513 514 free(str); 515 return rc; 516 } 517 518 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */ 519 static int is_directory(const char *base_path, const struct dirent *dent) 520 { 521 char path[PATH_MAX]; 522 struct stat st; 523 524 sprintf(path, "%s/%s", base_path, dent->d_name); 525 if (stat(path, &st)) 526 return 0; 527 528 return S_ISDIR(st.st_mode); 529 } 530 531 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\ 532 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \ 533 lang_next) \ 534 if ((lang_dirent.d_type == DT_DIR || \ 535 (lang_dirent.d_type == DT_UNKNOWN && \ 536 is_directory(scripts_path, &lang_dirent))) && \ 537 (strcmp(lang_dirent.d_name, ".")) && \ 538 (strcmp(lang_dirent.d_name, ".."))) 539 540 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\ 541 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \ 542 script_next) \ 543 if (script_dirent.d_type != DT_DIR && \ 544 (script_dirent.d_type != DT_UNKNOWN || \ 545 !is_directory(lang_path, &script_dirent))) 546 547 548 #define RECORD_SUFFIX "-record" 549 #define REPORT_SUFFIX "-report" 550 551 struct script_desc { 552 struct list_head node; 553 char *name; 554 char *half_liner; 555 char *args; 556 }; 557 558 static LIST_HEAD(script_descs); 559 560 static struct script_desc *script_desc__new(const char *name) 561 { 562 struct script_desc *s = zalloc(sizeof(*s)); 563 564 if (s != NULL && name) 565 s->name = strdup(name); 566 567 return s; 568 } 569 570 static void script_desc__delete(struct script_desc *s) 571 { 572 free(s->name); 573 free(s->half_liner); 574 free(s->args); 575 free(s); 576 } 577 578 static void script_desc__add(struct script_desc *s) 579 { 580 list_add_tail(&s->node, &script_descs); 581 } 582 583 static struct script_desc *script_desc__find(const char *name) 584 { 585 struct script_desc *s; 586 587 list_for_each_entry(s, &script_descs, node) 588 if (strcasecmp(s->name, name) == 0) 589 return s; 590 return NULL; 591 } 592 593 static struct script_desc *script_desc__findnew(const char *name) 594 { 595 struct script_desc *s = script_desc__find(name); 596 597 if (s) 598 return s; 599 600 s = script_desc__new(name); 601 if (!s) 602 goto out_delete_desc; 603 604 script_desc__add(s); 605 606 return s; 607 608 out_delete_desc: 609 script_desc__delete(s); 610 611 return NULL; 612 } 613 614 static const char *ends_with(const char *str, const char *suffix) 615 { 616 size_t suffix_len = strlen(suffix); 617 const char *p = str; 618 619 if (strlen(str) > suffix_len) { 620 p = str + strlen(str) - suffix_len; 621 if (!strncmp(p, suffix, suffix_len)) 622 return p; 623 } 624 625 return NULL; 626 } 627 628 static char *ltrim(char *str) 629 { 630 int len = strlen(str); 631 632 while (len && isspace(*str)) { 633 len--; 634 str++; 635 } 636 637 return str; 638 } 639 640 static int read_script_info(struct script_desc *desc, const char *filename) 641 { 642 char line[BUFSIZ], *p; 643 FILE *fp; 644 645 fp = fopen(filename, "r"); 646 if (!fp) 647 return -1; 648 649 while (fgets(line, sizeof(line), fp)) { 650 p = ltrim(line); 651 if (strlen(p) == 0) 652 continue; 653 if (*p != '#') 654 continue; 655 p++; 656 if (strlen(p) && *p == '!') 657 continue; 658 659 p = ltrim(p); 660 if (strlen(p) && p[strlen(p) - 1] == '\n') 661 p[strlen(p) - 1] = '\0'; 662 663 if (!strncmp(p, "description:", strlen("description:"))) { 664 p += strlen("description:"); 665 desc->half_liner = strdup(ltrim(p)); 666 continue; 667 } 668 669 if (!strncmp(p, "args:", strlen("args:"))) { 670 p += strlen("args:"); 671 desc->args = strdup(ltrim(p)); 672 continue; 673 } 674 } 675 676 fclose(fp); 677 678 return 0; 679 } 680 681 static int list_available_scripts(const struct option *opt __used, 682 const char *s __used, int unset __used) 683 { 684 struct dirent *script_next, *lang_next, script_dirent, lang_dirent; 685 char scripts_path[MAXPATHLEN]; 686 DIR *scripts_dir, *lang_dir; 687 char script_path[MAXPATHLEN]; 688 char lang_path[MAXPATHLEN]; 689 struct script_desc *desc; 690 char first_half[BUFSIZ]; 691 char *script_root; 692 char *str; 693 694 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path()); 695 696 scripts_dir = opendir(scripts_path); 697 if (!scripts_dir) 698 return -1; 699 700 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) { 701 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path, 702 lang_dirent.d_name); 703 lang_dir = opendir(lang_path); 704 if (!lang_dir) 705 continue; 706 707 for_each_script(lang_path, lang_dir, script_dirent, script_next) { 708 script_root = strdup(script_dirent.d_name); 709 str = (char *)ends_with(script_root, REPORT_SUFFIX); 710 if (str) { 711 *str = '\0'; 712 desc = script_desc__findnew(script_root); 713 snprintf(script_path, MAXPATHLEN, "%s/%s", 714 lang_path, script_dirent.d_name); 715 read_script_info(desc, script_path); 716 } 717 free(script_root); 718 } 719 } 720 721 fprintf(stdout, "List of available trace scripts:\n"); 722 list_for_each_entry(desc, &script_descs, node) { 723 sprintf(first_half, "%s %s", desc->name, 724 desc->args ? desc->args : ""); 725 fprintf(stdout, " %-36s %s\n", first_half, 726 desc->half_liner ? desc->half_liner : ""); 727 } 728 729 exit(0); 730 } 731 732 static char *get_script_path(const char *script_root, const char *suffix) 733 { 734 struct dirent *script_next, *lang_next, script_dirent, lang_dirent; 735 char scripts_path[MAXPATHLEN]; 736 char script_path[MAXPATHLEN]; 737 DIR *scripts_dir, *lang_dir; 738 char lang_path[MAXPATHLEN]; 739 char *str, *__script_root; 740 char *path = NULL; 741 742 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path()); 743 744 scripts_dir = opendir(scripts_path); 745 if (!scripts_dir) 746 return NULL; 747 748 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) { 749 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path, 750 lang_dirent.d_name); 751 lang_dir = opendir(lang_path); 752 if (!lang_dir) 753 continue; 754 755 for_each_script(lang_path, lang_dir, script_dirent, script_next) { 756 __script_root = strdup(script_dirent.d_name); 757 str = (char *)ends_with(__script_root, suffix); 758 if (str) { 759 *str = '\0'; 760 if (strcmp(__script_root, script_root)) 761 continue; 762 snprintf(script_path, MAXPATHLEN, "%s/%s", 763 lang_path, script_dirent.d_name); 764 path = strdup(script_path); 765 free(__script_root); 766 break; 767 } 768 free(__script_root); 769 } 770 } 771 772 return path; 773 } 774 775 static bool is_top_script(const char *script_path) 776 { 777 return ends_with(script_path, "top") == NULL ? false : true; 778 } 779 780 static int has_required_arg(char *script_path) 781 { 782 struct script_desc *desc; 783 int n_args = 0; 784 char *p; 785 786 desc = script_desc__new(NULL); 787 788 if (read_script_info(desc, script_path)) 789 goto out; 790 791 if (!desc->args) 792 goto out; 793 794 for (p = desc->args; *p; p++) 795 if (*p == '<') 796 n_args++; 797 out: 798 script_desc__delete(desc); 799 800 return n_args; 801 } 802 803 static const char * const script_usage[] = { 804 "perf script [<options>]", 805 "perf script [<options>] record <script> [<record-options>] <command>", 806 "perf script [<options>] report <script> [script-args]", 807 "perf script [<options>] <script> [<record-options>] <command>", 808 "perf script [<options>] <top-script> [script-args]", 809 NULL 810 }; 811 812 static const struct option options[] = { 813 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, 814 "dump raw trace in ASCII"), 815 OPT_INCR('v', "verbose", &verbose, 816 "be more verbose (show symbol address, etc)"), 817 OPT_BOOLEAN('L', "Latency", &latency_format, 818 "show latency attributes (irqs/preemption disabled, etc)"), 819 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts", 820 list_available_scripts), 821 OPT_CALLBACK('s', "script", NULL, "name", 822 "script file name (lang:script name, script name, or *)", 823 parse_scriptname), 824 OPT_STRING('g', "gen-script", &generate_script_lang, "lang", 825 "generate perf-script.xx script in specified language"), 826 OPT_STRING('i', "input", &input_name, "file", 827 "input file name"), 828 OPT_BOOLEAN('d', "debug-mode", &debug_mode, 829 "do various checks like samples ordering and lost events"), 830 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, 831 "file", "vmlinux pathname"), 832 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, 833 "file", "kallsyms pathname"), 834 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain, 835 "When printing symbols do not display call chain"), 836 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory", 837 "Look for files with symbols relative to this directory"), 838 OPT_CALLBACK('f', "fields", NULL, "str", 839 "comma separated output fields prepend with 'type:'. Valid types: hw,sw,trace. Fields: comm,tid,pid,time,cpu,event,trace,sym", 840 parse_output_fields), 841 842 OPT_END() 843 }; 844 845 static bool have_cmd(int argc, const char **argv) 846 { 847 char **__argv = malloc(sizeof(const char *) * argc); 848 849 if (!__argv) 850 die("malloc"); 851 memcpy(__argv, argv, sizeof(const char *) * argc); 852 argc = parse_options(argc, (const char **)__argv, record_options, 853 NULL, PARSE_OPT_STOP_AT_NON_OPTION); 854 free(__argv); 855 856 return argc != 0; 857 } 858 859 int cmd_script(int argc, const char **argv, const char *prefix __used) 860 { 861 char *rec_script_path = NULL; 862 char *rep_script_path = NULL; 863 struct perf_session *session; 864 char *script_path = NULL; 865 const char **__argv; 866 bool system_wide; 867 int i, j, err; 868 869 setup_scripting(); 870 871 argc = parse_options(argc, argv, options, script_usage, 872 PARSE_OPT_STOP_AT_NON_OPTION); 873 874 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) { 875 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX); 876 if (!rec_script_path) 877 return cmd_record(argc, argv, NULL); 878 } 879 880 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) { 881 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX); 882 if (!rep_script_path) { 883 fprintf(stderr, 884 "Please specify a valid report script" 885 "(see 'perf script -l' for listing)\n"); 886 return -1; 887 } 888 } 889 890 /* make sure PERF_EXEC_PATH is set for scripts */ 891 perf_set_argv_exec_path(perf_exec_path()); 892 893 if (argc && !script_name && !rec_script_path && !rep_script_path) { 894 int live_pipe[2]; 895 int rep_args; 896 pid_t pid; 897 898 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX); 899 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX); 900 901 if (!rec_script_path && !rep_script_path) { 902 fprintf(stderr, " Couldn't find script %s\n\n See perf" 903 " script -l for available scripts.\n", argv[0]); 904 usage_with_options(script_usage, options); 905 } 906 907 if (is_top_script(argv[0])) { 908 rep_args = argc - 1; 909 } else { 910 int rec_args; 911 912 rep_args = has_required_arg(rep_script_path); 913 rec_args = (argc - 1) - rep_args; 914 if (rec_args < 0) { 915 fprintf(stderr, " %s script requires options." 916 "\n\n See perf script -l for available " 917 "scripts and options.\n", argv[0]); 918 usage_with_options(script_usage, options); 919 } 920 } 921 922 if (pipe(live_pipe) < 0) { 923 perror("failed to create pipe"); 924 exit(-1); 925 } 926 927 pid = fork(); 928 if (pid < 0) { 929 perror("failed to fork"); 930 exit(-1); 931 } 932 933 if (!pid) { 934 system_wide = true; 935 j = 0; 936 937 dup2(live_pipe[1], 1); 938 close(live_pipe[0]); 939 940 if (!is_top_script(argv[0])) 941 system_wide = !have_cmd(argc - rep_args, 942 &argv[rep_args]); 943 944 __argv = malloc((argc + 6) * sizeof(const char *)); 945 if (!__argv) 946 die("malloc"); 947 948 __argv[j++] = "/bin/sh"; 949 __argv[j++] = rec_script_path; 950 if (system_wide) 951 __argv[j++] = "-a"; 952 __argv[j++] = "-q"; 953 __argv[j++] = "-o"; 954 __argv[j++] = "-"; 955 for (i = rep_args + 1; i < argc; i++) 956 __argv[j++] = argv[i]; 957 __argv[j++] = NULL; 958 959 execvp("/bin/sh", (char **)__argv); 960 free(__argv); 961 exit(-1); 962 } 963 964 dup2(live_pipe[0], 0); 965 close(live_pipe[1]); 966 967 __argv = malloc((argc + 4) * sizeof(const char *)); 968 if (!__argv) 969 die("malloc"); 970 j = 0; 971 __argv[j++] = "/bin/sh"; 972 __argv[j++] = rep_script_path; 973 for (i = 1; i < rep_args + 1; i++) 974 __argv[j++] = argv[i]; 975 __argv[j++] = "-i"; 976 __argv[j++] = "-"; 977 __argv[j++] = NULL; 978 979 execvp("/bin/sh", (char **)__argv); 980 free(__argv); 981 exit(-1); 982 } 983 984 if (rec_script_path) 985 script_path = rec_script_path; 986 if (rep_script_path) 987 script_path = rep_script_path; 988 989 if (script_path) { 990 system_wide = false; 991 j = 0; 992 993 if (rec_script_path) 994 system_wide = !have_cmd(argc - 1, &argv[1]); 995 996 __argv = malloc((argc + 2) * sizeof(const char *)); 997 if (!__argv) 998 die("malloc"); 999 __argv[j++] = "/bin/sh"; 1000 __argv[j++] = script_path; 1001 if (system_wide) 1002 __argv[j++] = "-a"; 1003 for (i = 2; i < argc; i++) 1004 __argv[j++] = argv[i]; 1005 __argv[j++] = NULL; 1006 1007 execvp("/bin/sh", (char **)__argv); 1008 free(__argv); 1009 exit(-1); 1010 } 1011 1012 if (symbol__init() < 0) 1013 return -1; 1014 if (!script_name) 1015 setup_pager(); 1016 1017 session = perf_session__new(input_name, O_RDONLY, 0, false, &event_ops); 1018 if (session == NULL) 1019 return -ENOMEM; 1020 1021 if (!no_callchain) 1022 symbol_conf.use_callchain = true; 1023 else 1024 symbol_conf.use_callchain = false; 1025 1026 if (generate_script_lang) { 1027 struct stat perf_stat; 1028 int input; 1029 1030 if (output_set_by_user) { 1031 fprintf(stderr, 1032 "custom fields not supported for generated scripts"); 1033 return -1; 1034 } 1035 1036 input = open(input_name, O_RDONLY); 1037 if (input < 0) { 1038 perror("failed to open file"); 1039 exit(-1); 1040 } 1041 1042 err = fstat(input, &perf_stat); 1043 if (err < 0) { 1044 perror("failed to stat file"); 1045 exit(-1); 1046 } 1047 1048 if (!perf_stat.st_size) { 1049 fprintf(stderr, "zero-sized file, nothing to do!\n"); 1050 exit(0); 1051 } 1052 1053 scripting_ops = script_spec__lookup(generate_script_lang); 1054 if (!scripting_ops) { 1055 fprintf(stderr, "invalid language specifier"); 1056 return -1; 1057 } 1058 1059 err = scripting_ops->generate_script("perf-script"); 1060 goto out; 1061 } 1062 1063 if (script_name) { 1064 err = scripting_ops->start_script(script_name, argc, argv); 1065 if (err) 1066 goto out; 1067 pr_debug("perf script started with script %s\n\n", script_name); 1068 } 1069 1070 err = __cmd_script(session); 1071 1072 perf_session__delete(session); 1073 cleanup_scripting(); 1074 out: 1075 return err; 1076 } 1077