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