tools/perf/builtin-script.c

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