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