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