tools/perf/builtin-record.c

   1 /*
   2  * builtin-record.c
   3  *
   4  * Builtin record command: Record the profile of a workload
   5  * (or a CPU, or a PID) into the perf.data output file - for
   6  * later analysis via perf report.
   7  */
   8 #include "builtin.h"
   9
  10 #include "perf.h"
  11
  12 #include "util/build-id.h"
  13 #include "util/util.h"
  14 #include "util/parse-options.h"
  15 #include "util/parse-events.h"
  16
  17 #include "util/callchain.h"
  18 #include "util/cgroup.h"
  19 #include "util/header.h"
  20 #include "util/event.h"
  21 #include "util/evlist.h"
  22 #include "util/evsel.h"
  23 #include "util/debug.h"
  24 #include "util/session.h"
  25 #include "util/tool.h"
  26 #include "util/symbol.h"
  27 #include "util/cpumap.h"
  28 #include "util/thread_map.h"
  29 #include "util/data.h"
  30 #include "util/auxtrace.h"
  31 #include "util/parse-branch-options.h"
  32
  33 #include <unistd.h>
  34 #include <sched.h>
  35 #include <sys/mman.h>
  36
  37
  38 struct record {
  39         struct perf_tool        tool;
  40         struct record_opts      opts;
  41         u64                     bytes_written;
  42         struct perf_data_file   file;
  43         struct auxtrace_record  *itr;
  44         struct perf_evlist      *evlist;
  45         struct perf_session     *session;
  46         const char              *progname;
  47         int                     realtime_prio;
  48         bool                    no_buildid;
  49         bool                    no_buildid_cache;
  50         long                    samples;
  51 };
  52
  53 static int record__write(struct record *rec, void *bf, size_t size)
  54 {
  55         if (perf_data_file__write(rec->session->file, bf, size) < 0) {
  56                 pr_err("failed to write perf data, error: %m\n");
  57                 return -1;
  58         }
  59
  60         rec->bytes_written += size;
  61         return 0;
  62 }
  63
  64 static int process_synthesized_event(struct perf_tool *tool,
  65                                      union perf_event *event,
  66                                      struct perf_sample *sample __maybe_unused,
  67                                      struct machine *machine __maybe_unused)
  68 {
  69         struct record *rec = container_of(tool, struct record, tool);
  70         return record__write(rec, event, event->header.size);
  71 }
  72
  73 static int record__mmap_read(struct record *rec, int idx)
  74 {
  75         struct perf_mmap *md = &rec->evlist->mmap[idx];
  76         u64 head = perf_mmap__read_head(md);
  77         u64 old = md->prev;
  78         unsigned char *data = md->base + page_size;
  79         unsigned long size;
  80         void *buf;
  81         int rc = 0;
  82
  83         if (old == head)
  84                 return 0;
  85
  86         rec->samples++;
  87
  88         size = head - old;
  89
  90         if ((old & md->mask) + size != (head & md->mask)) {
  91                 buf = &data[old & md->mask];
  92                 size = md->mask + 1 - (old & md->mask);
  93                 old += size;
  94
  95                 if (record__write(rec, buf, size) < 0) {
  96                         rc = -1;
  97                         goto out;
  98                 }
  99         }
 100
 101         buf = &data[old & md->mask];
 102         size = head - old;
 103         old += size;
 104
 105         if (record__write(rec, buf, size) < 0) {
 106                 rc = -1;
 107                 goto out;
 108         }
 109
 110         md->prev = old;
 111         perf_evlist__mmap_consume(rec->evlist, idx);
 112 out:
 113         return rc;
 114 }
 115
 116 static volatile int done;
 117 static volatile int signr = -1;
 118 static volatile int child_finished;
 119 static volatile int auxtrace_snapshot_enabled;
 120 static volatile int auxtrace_snapshot_err;
 121 static volatile int auxtrace_record__snapshot_started;
 122
 123 static void sig_handler(int sig)
 124 {
 125         if (sig == SIGCHLD)
 126                 child_finished = 1;
 127         else
 128                 signr = sig;
 129
 130         done = 1;
 131 }
 132
 133 static void record__sig_exit(void)
 134 {
 135         if (signr == -1)
 136                 return;
 137
 138         signal(signr, SIG_DFL);
 139         raise(signr);
 140 }
 141
 142 #ifdef HAVE_AUXTRACE_SUPPORT
 143
 144 static int record__process_auxtrace(struct perf_tool *tool,
 145                                     union perf_event *event, void *data1,
 146                                     size_t len1, void *data2, size_t len2)
 147 {
 148         struct record *rec = container_of(tool, struct record, tool);
 149         struct perf_data_file *file = &rec->file;
 150         size_t padding;
 151         u8 pad[8] = {0};
 152
 153         if (!perf_data_file__is_pipe(file)) {
 154                 off_t file_offset;
 155                 int fd = perf_data_file__fd(file);
 156                 int err;
 157
 158                 file_offset = lseek(fd, 0, SEEK_CUR);
 159                 if (file_offset == -1)
 160                         return -1;
 161                 err = auxtrace_index__auxtrace_event(&rec->session->auxtrace_index,
 162                                                      event, file_offset);
 163                 if (err)
 164                         return err;
 165         }
 166
 167         /* event.auxtrace.size includes padding, see __auxtrace_mmap__read() */
 168         padding = (len1 + len2) & 7;
 169         if (padding)
 170                 padding = 8 - padding;
 171
 172         record__write(rec, event, event->header.size);
 173         record__write(rec, data1, len1);
 174         if (len2)
 175                 record__write(rec, data2, len2);
 176         record__write(rec, &pad, padding);
 177
 178         return 0;
 179 }
 180
 181 static int record__auxtrace_mmap_read(struct record *rec,
 182                                       struct auxtrace_mmap *mm)
 183 {
 184         int ret;
 185
 186         ret = auxtrace_mmap__read(mm, rec->itr, &rec->tool,
 187                                   record__process_auxtrace);
 188         if (ret < 0)
 189                 return ret;
 190
 191         if (ret)
 192                 rec->samples++;
 193
 194         return 0;
 195 }
 196
 197 static int record__auxtrace_mmap_read_snapshot(struct record *rec,
 198                                                struct auxtrace_mmap *mm)
 199 {
 200         int ret;
 201
 202         ret = auxtrace_mmap__read_snapshot(mm, rec->itr, &rec->tool,
 203                                            record__process_auxtrace,
 204                                            rec->opts.auxtrace_snapshot_size);
 205         if (ret < 0)
 206                 return ret;
 207
 208         if (ret)
 209                 rec->samples++;
 210
 211         return 0;
 212 }
 213
 214 static int record__auxtrace_read_snapshot_all(struct record *rec)
 215 {
 216         int i;
 217         int rc = 0;
 218
 219         for (i = 0; i < rec->evlist->nr_mmaps; i++) {
 220                 struct auxtrace_mmap *mm =
 221                                 &rec->evlist->mmap[i].auxtrace_mmap;
 222
 223                 if (!mm->base)
 224                         continue;
 225
 226                 if (record__auxtrace_mmap_read_snapshot(rec, mm) != 0) {
 227                         rc = -1;
 228                         goto out;
 229                 }
 230         }
 231 out:
 232         return rc;
 233 }
 234
 235 static void record__read_auxtrace_snapshot(struct record *rec)
 236 {
 237         pr_debug("Recording AUX area tracing snapshot\n");
 238         if (record__auxtrace_read_snapshot_all(rec) < 0) {
 239                 auxtrace_snapshot_err = -1;
 240         } else {
 241                 auxtrace_snapshot_err = auxtrace_record__snapshot_finish(rec->itr);
 242                 if (!auxtrace_snapshot_err)
 243                         auxtrace_snapshot_enabled = 1;
 244         }
 245 }
 246
 247 #else
 248
 249 static inline
 250 int record__auxtrace_mmap_read(struct record *rec __maybe_unused,
 251                                struct auxtrace_mmap *mm __maybe_unused)
 252 {
 253         return 0;
 254 }
 255
 256 static inline
 257 void record__read_auxtrace_snapshot(struct record *rec __maybe_unused)
 258 {
 259 }
 260
 261 static inline
 262 int auxtrace_record__snapshot_start(struct auxtrace_record *itr __maybe_unused)
 263 {
 264         return 0;
 265 }
 266
 267 #endif
 268
 269 static int record__open(struct record *rec)
 270 {
 271         char msg[512];
 272         struct perf_evsel *pos;
 273         struct perf_evlist *evlist = rec->evlist;
 274         struct perf_session *session = rec->session;
 275         struct record_opts *opts = &rec->opts;
 276         int rc = 0;
 277
 278         perf_evlist__config(evlist, opts);
 279
 280         evlist__for_each(evlist, pos) {
 281 try_again:
 282                 if (perf_evsel__open(pos, evlist->cpus, evlist->threads) < 0) {
 283                         if (perf_evsel__fallback(pos, errno, msg, sizeof(msg))) {
 284                                 if (verbose)
 285                                         ui__warning("%s\n", msg);
 286                                 goto try_again;
 287                         }
 288
 289                         rc = -errno;
 290                         perf_evsel__open_strerror(pos, &opts->target,
 291                                                   errno, msg, sizeof(msg));
 292                         ui__error("%s\n", msg);
 293                         goto out;
 294                 }
 295         }
 296
 297         if (perf_evlist__apply_filters(evlist, &pos)) {
 298                 error("failed to set filter \"%s\" on event %s with %d (%s)\n",
 299                         pos->filter, perf_evsel__name(pos), errno,
 300                         strerror_r(errno, msg, sizeof(msg)));
 301                 rc = -1;
 302                 goto out;
 303         }
 304
 305         if (perf_evlist__mmap_ex(evlist, opts->mmap_pages, false,
 306                                  opts->auxtrace_mmap_pages,
 307                                  opts->auxtrace_snapshot_mode) < 0) {
 308                 if (errno == EPERM) {
 309                         pr_err("Permission error mapping pages.\n"
 310                                "Consider increasing "
 311                                "/proc/sys/kernel/perf_event_mlock_kb,\n"
 312                                "or try again with a smaller value of -m/--mmap_pages.\n"
 313                                "(current value: %u,%u)\n",
 314                                opts->mmap_pages, opts->auxtrace_mmap_pages);
 315                         rc = -errno;
 316                 } else {
 317                         pr_err("failed to mmap with %d (%s)\n", errno,
 318                                 strerror_r(errno, msg, sizeof(msg)));
 319                         rc = -errno;
 320                 }
 321                 goto out;
 322         }
 323
 324         session->evlist = evlist;
 325         perf_session__set_id_hdr_size(session);
 326 out:
 327         return rc;
 328 }
 329
 330 static int process_sample_event(struct perf_tool *tool,
 331                                 union perf_event *event,
 332                                 struct perf_sample *sample,
 333                                 struct perf_evsel *evsel,
 334                                 struct machine *machine)
 335 {
 336         struct record *rec = container_of(tool, struct record, tool);
 337
 338         rec->samples++;
 339
 340         return build_id__mark_dso_hit(tool, event, sample, evsel, machine);
 341 }
 342
 343 static int process_buildids(struct record *rec)
 344 {
 345         struct perf_data_file *file  = &rec->file;
 346         struct perf_session *session = rec->session;
 347
 348         if (file->size == 0)
 349                 return 0;
 350
 351         /*
 352          * During this process, it'll load kernel map and replace the
 353          * dso->long_name to a real pathname it found.  In this case
 354          * we prefer the vmlinux path like
 355          *   /lib/modules/3.16.4/build/vmlinux
 356          *
 357          * rather than build-id path (in debug directory).
 358          *   $HOME/.debug/.build-id/f0/6e17aa50adf4d00b88925e03775de107611551
 359          */
 360         symbol_conf.ignore_vmlinux_buildid = true;
 361
 362         return perf_session__process_events(session);
 363 }
 364
 365 static void perf_event__synthesize_guest_os(struct machine *machine, void *data)
 366 {
 367         int err;
 368         struct perf_tool *tool = data;
 369         /*
 370          *As for guest kernel when processing subcommand record&report,
 371          *we arrange module mmap prior to guest kernel mmap and trigger
 372          *a preload dso because default guest module symbols are loaded
 373          *from guest kallsyms instead of /lib/modules/XXX/XXX. This
 374          *method is used to avoid symbol missing when the first addr is
 375          *in module instead of in guest kernel.
 376          */
 377         err = perf_event__synthesize_modules(tool, process_synthesized_event,
 378                                              machine);
 379         if (err < 0)
 380                 pr_err("Couldn't record guest kernel [%d]'s reference"
 381                        " relocation symbol.\n", machine->pid);
 382
 383         /*
 384          * We use _stext for guest kernel because guest kernel's /proc/kallsyms
 385          * have no _text sometimes.
 386          */
 387         err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
 388                                                  machine);
 389         if (err < 0)
 390                 pr_err("Couldn't record guest kernel [%d]'s reference"
 391                        " relocation symbol.\n", machine->pid);
 392 }
 393
 394 static struct perf_event_header finished_round_event = {
 395         .size = sizeof(struct perf_event_header),
 396         .type = PERF_RECORD_FINISHED_ROUND,
 397 };
 398
 399 static int record__mmap_read_all(struct record *rec)
 400 {
 401         u64 bytes_written = rec->bytes_written;
 402         int i;
 403         int rc = 0;
 404
 405         for (i = 0; i < rec->evlist->nr_mmaps; i++) {
 406                 struct auxtrace_mmap *mm = &rec->evlist->mmap[i].auxtrace_mmap;
 407
 408                 if (rec->evlist->mmap[i].base) {
 409                         if (record__mmap_read(rec, i) != 0) {
 410                                 rc = -1;
 411                                 goto out;
 412                         }
 413                 }
 414
 415                 if (mm->base && !rec->opts.auxtrace_snapshot_mode &&
 416                     record__auxtrace_mmap_read(rec, mm) != 0) {
 417                         rc = -1;
 418                         goto out;
 419                 }
 420         }
 421
 422         /*
 423          * Mark the round finished in case we wrote
 424          * at least one event.
 425          */
 426         if (bytes_written != rec->bytes_written)
 427                 rc = record__write(rec, &finished_round_event, sizeof(finished_round_event));
 428
 429 out:
 430         return rc;
 431 }
 432
 433 static void record__init_features(struct record *rec)
 434 {
 435         struct perf_session *session = rec->session;
 436         int feat;
 437
 438         for (feat = HEADER_FIRST_FEATURE; feat < HEADER_LAST_FEATURE; feat++)
 439                 perf_header__set_feat(&session->header, feat);
 440
 441         if (rec->no_buildid)
 442                 perf_header__clear_feat(&session->header, HEADER_BUILD_ID);
 443
 444         if (!have_tracepoints(&rec->evlist->entries))
 445                 perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);
 446
 447         if (!rec->opts.branch_stack)
 448                 perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
 449
 450         if (!rec->opts.full_auxtrace)
 451                 perf_header__clear_feat(&session->header, HEADER_AUXTRACE);
 452 }
 453
 454 static volatile int workload_exec_errno;
 455
 456 /*
 457  * perf_evlist__prepare_workload will send a SIGUSR1
 458  * if the fork fails, since we asked by setting its
 459  * want_signal to true.
 460  */
 461 static void workload_exec_failed_signal(int signo __maybe_unused,
 462                                         siginfo_t *info,
 463                                         void *ucontext __maybe_unused)
 464 {
 465         workload_exec_errno = info->si_value.sival_int;
 466         done = 1;
 467         child_finished = 1;
 468 }
 469
 470 static void snapshot_sig_handler(int sig);
 471
 472 static int __cmd_record(struct record *rec, int argc, const char **argv)
 473 {
 474         int err;
 475         int status = 0;
 476         unsigned long waking = 0;
 477         const bool forks = argc > 0;
 478         struct machine *machine;
 479         struct perf_tool *tool = &rec->tool;
 480         struct record_opts *opts = &rec->opts;
 481         struct perf_data_file *file = &rec->file;
 482         struct perf_session *session;
 483         bool disabled = false, draining = false;
 484         int fd;
 485
 486         rec->progname = argv[0];
 487
 488         atexit(record__sig_exit);
 489         signal(SIGCHLD, sig_handler);
 490         signal(SIGINT, sig_handler);
 491         signal(SIGTERM, sig_handler);
 492         if (rec->opts.auxtrace_snapshot_mode)
 493                 signal(SIGUSR2, snapshot_sig_handler);
 494         else
 495                 signal(SIGUSR2, SIG_IGN);
 496
 497         session = perf_session__new(file, false, tool);
 498         if (session == NULL) {
 499                 pr_err("Perf session creation failed.\n");
 500                 return -1;
 501         }
 502
 503         fd = perf_data_file__fd(file);
 504         rec->session = session;
 505
 506         record__init_features(rec);
 507
 508         if (forks) {
 509                 err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
 510                                                     argv, file->is_pipe,
 511                                                     workload_exec_failed_signal);
 512                 if (err < 0) {
 513                         pr_err("Couldn't run the workload!\n");
 514                         status = err;
 515                         goto out_delete_session;
 516                 }
 517         }
 518
 519         if (record__open(rec) != 0) {
 520                 err = -1;
 521                 goto out_child;
 522         }
 523
 524         /*
 525          * Normally perf_session__new would do this, but it doesn't have the
 526          * evlist.
 527          */
 528         if (rec->tool.ordered_events && !perf_evlist__sample_id_all(rec->evlist)) {
 529                 pr_warning("WARNING: No sample_id_all support, falling back to unordered processing\n");
 530                 rec->tool.ordered_events = false;
 531         }
 532
 533         if (!rec->evlist->nr_groups)
 534                 perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);
 535
 536         if (file->is_pipe) {
 537                 err = perf_header__write_pipe(fd);
 538                 if (err < 0)
 539                         goto out_child;
 540         } else {
 541                 err = perf_session__write_header(session, rec->evlist, fd, false);
 542                 if (err < 0)
 543                         goto out_child;
 544         }
 545
 546         if (!rec->no_buildid
 547             && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
 548                 pr_err("Couldn't generate buildids. "
 549                        "Use --no-buildid to profile anyway.\n");
 550                 err = -1;
 551                 goto out_child;
 552         }
 553
 554         machine = &session->machines.host;
 555
 556         if (file->is_pipe) {
 557                 err = perf_event__synthesize_attrs(tool, session,
 558                                                    process_synthesized_event);
 559                 if (err < 0) {
 560                         pr_err("Couldn't synthesize attrs.\n");
 561                         goto out_child;
 562                 }
 563
 564                 if (have_tracepoints(&rec->evlist->entries)) {
 565                         /*
 566                          * FIXME err <= 0 here actually means that
 567                          * there were no tracepoints so its not really
 568                          * an error, just that we don't need to
 569                          * synthesize anything.  We really have to
 570                          * return this more properly and also
 571                          * propagate errors that now are calling die()
 572                          */
 573                         err = perf_event__synthesize_tracing_data(tool, fd, rec->evlist,
 574                                                                   process_synthesized_event);
 575                         if (err <= 0) {
 576                                 pr_err("Couldn't record tracing data.\n");
 577                                 goto out_child;
 578                         }
 579                         rec->bytes_written += err;
 580                 }
 581         }
 582
 583         if (rec->opts.full_auxtrace) {
 584                 err = perf_event__synthesize_auxtrace_info(rec->itr, tool,
 585                                         session, process_synthesized_event);
 586                 if (err)
 587                         goto out_delete_session;
 588         }
 589
 590         err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
 591                                                  machine);
 592         if (err < 0)
 593                 pr_err("Couldn't record kernel reference relocation symbol\n"
 594                        "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
 595                        "Check /proc/kallsyms permission or run as root.\n");
 596
 597         err = perf_event__synthesize_modules(tool, process_synthesized_event,
 598                                              machine);
 599         if (err < 0)
 600                 pr_err("Couldn't record kernel module information.\n"
 601                        "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
 602                        "Check /proc/modules permission or run as root.\n");
 603
 604         if (perf_guest) {
 605                 machines__process_guests(&session->machines,
 606                                          perf_event__synthesize_guest_os, tool);
 607         }
 608
 609         err = __machine__synthesize_threads(machine, tool, &opts->target, rec->evlist->threads,
 610                                             process_synthesized_event, opts->sample_address,
 611                                             opts->proc_map_timeout);
 612         if (err != 0)
 613                 goto out_child;
 614
 615         if (rec->realtime_prio) {
 616                 struct sched_param param;
 617
 618                 param.sched_priority = rec->realtime_prio;
 619                 if (sched_setscheduler(0, SCHED_FIFO, &param)) {
 620                         pr_err("Could not set realtime priority.\n");
 621                         err = -1;
 622                         goto out_child;
 623                 }
 624         }
 625
 626         /*
 627          * When perf is starting the traced process, all the events
 628          * (apart from group members) have enable_on_exec=1 set,
 629          * so don't spoil it by prematurely enabling them.
 630          */
 631         if (!target__none(&opts->target) && !opts->initial_delay)
 632                 perf_evlist__enable(rec->evlist);
 633
 634         /*
 635          * Let the child rip
 636          */
 637         if (forks)
 638                 perf_evlist__start_workload(rec->evlist);
 639
 640         if (opts->initial_delay) {
 641                 usleep(opts->initial_delay * 1000);
 642                 perf_evlist__enable(rec->evlist);
 643         }
 644
 645         auxtrace_snapshot_enabled = 1;
 646         for (;;) {
 647                 int hits = rec->samples;
 648
 649                 if (record__mmap_read_all(rec) < 0) {
 650                         auxtrace_snapshot_enabled = 0;
 651                         err = -1;
 652                         goto out_child;
 653                 }
 654
 655                 if (auxtrace_record__snapshot_started) {
 656                         auxtrace_record__snapshot_started = 0;
 657                         if (!auxtrace_snapshot_err)
 658                                 record__read_auxtrace_snapshot(rec);
 659                         if (auxtrace_snapshot_err) {
 660                                 pr_err("AUX area tracing snapshot failed\n");
 661                                 err = -1;
 662                                 goto out_child;
 663                         }
 664                 }
 665
 666                 if (hits == rec->samples) {
 667                         if (done || draining)
 668                                 break;
 669                         err = perf_evlist__poll(rec->evlist, -1);
 670                         /*
 671                          * Propagate error, only if there's any. Ignore positive
 672                          * number of returned events and interrupt error.
 673                          */
 674                         if (err > 0 || (err < 0 && errno == EINTR))
 675                                 err = 0;
 676                         waking++;
 677
 678                         if (perf_evlist__filter_pollfd(rec->evlist, POLLERR | POLLHUP) == 0)
 679                                 draining = true;
 680                 }
 681
 682                 /*
 683                  * When perf is starting the traced process, at the end events
 684                  * die with the process and we wait for that. Thus no need to
 685                  * disable events in this case.
 686                  */
 687                 if (done && !disabled && !target__none(&opts->target)) {
 688                         auxtrace_snapshot_enabled = 0;
 689                         perf_evlist__disable(rec->evlist);
 690                         disabled = true;
 691                 }
 692         }
 693         auxtrace_snapshot_enabled = 0;
 694
 695         if (forks && workload_exec_errno) {
 696                 char msg[STRERR_BUFSIZE];
 697                 const char *emsg = strerror_r(workload_exec_errno, msg, sizeof(msg));
 698                 pr_err("Workload failed: %s\n", emsg);
 699                 err = -1;
 700                 goto out_child;
 701         }
 702
 703         if (!quiet)
 704                 fprintf(stderr, "[ perf record: Woken up %ld times to write data ]\n", waking);
 705
 706 out_child:
 707         if (forks) {
 708                 int exit_status;
 709
 710                 if (!child_finished)
 711                         kill(rec->evlist->workload.pid, SIGTERM);
 712
 713                 wait(&exit_status);
 714
 715                 if (err < 0)
 716                         status = err;
 717                 else if (WIFEXITED(exit_status))
 718                         status = WEXITSTATUS(exit_status);
 719                 else if (WIFSIGNALED(exit_status))
 720                         signr = WTERMSIG(exit_status);
 721         } else
 722                 status = err;
 723
 724         /* this will be recalculated during process_buildids() */
 725         rec->samples = 0;
 726
 727         if (!err && !file->is_pipe) {
 728                 rec->session->header.data_size += rec->bytes_written;
 729                 file->size = lseek(perf_data_file__fd(file), 0, SEEK_CUR);
 730
 731                 if (!rec->no_buildid) {
 732                         process_buildids(rec);
 733                         /*
 734                          * We take all buildids when the file contains
 735                          * AUX area tracing data because we do not decode the
 736                          * trace because it would take too long.
 737                          */
 738                         if (rec->opts.full_auxtrace)
 739                                 dsos__hit_all(rec->session);
 740                 }
 741                 perf_session__write_header(rec->session, rec->evlist, fd, true);
 742         }
 743
 744         if (!err && !quiet) {
 745                 char samples[128];
 746
 747                 if (rec->samples && !rec->opts.full_auxtrace)
 748                         scnprintf(samples, sizeof(samples),
 749                                   " (%" PRIu64 " samples)", rec->samples);
 750                 else
 751                         samples[0] = '\0';
 752
 753                 fprintf(stderr, "[ perf record: Captured and wrote %.3f MB %s%s ]\n",
 754                         perf_data_file__size(file) / 1024.0 / 1024.0,
 755                         file->path, samples);
 756         }
 757
 758 out_delete_session:
 759         perf_session__delete(session);
 760         return status;
 761 }
 762
 763 static void callchain_debug(void)
 764 {
 765         static const char *str[CALLCHAIN_MAX] = { "NONE", "FP", "DWARF", "LBR" };
 766
 767         pr_debug("callchain: type %s\n", str[callchain_param.record_mode]);
 768
 769         if (callchain_param.record_mode == CALLCHAIN_DWARF)
 770                 pr_debug("callchain: stack dump size %d\n",
 771                          callchain_param.dump_size);
 772 }
 773
 774 int record_parse_callchain_opt(const struct option *opt __maybe_unused,
 775                                const char *arg,
 776                                int unset)
 777 {
 778         int ret;
 779
 780         callchain_param.enabled = !unset;
 781
 782         /* --no-call-graph */
 783         if (unset) {
 784                 callchain_param.record_mode = CALLCHAIN_NONE;
 785                 pr_debug("callchain: disabled\n");
 786                 return 0;
 787         }
 788
 789         ret = parse_callchain_record_opt(arg);
 790         if (!ret)
 791                 callchain_debug();
 792
 793         return ret;
 794 }
 795
 796 int record_callchain_opt(const struct option *opt __maybe_unused,
 797                          const char *arg __maybe_unused,
 798                          int unset __maybe_unused)
 799 {
 800         callchain_param.enabled = true;
 801
 802         if (callchain_param.record_mode == CALLCHAIN_NONE)
 803                 callchain_param.record_mode = CALLCHAIN_FP;
 804
 805         callchain_debug();
 806         return 0;
 807 }
 808
 809 static int perf_record_config(const char *var, const char *value, void *cb)
 810 {
 811         if (!strcmp(var, "record.call-graph"))
 812                 var = "call-graph.record-mode"; /* fall-through */
 813
 814         return perf_default_config(var, value, cb);
 815 }
 816
 817 struct clockid_map {
 818         const char *name;
 819         int clockid;
 820 };
 821
 822 #define CLOCKID_MAP(n, c)       \
 823         { .name = n, .clockid = (c), }
 824
 825 #define CLOCKID_END     { .name = NULL, }
 826
 827
 828 /*
 829  * Add the missing ones, we need to build on many distros...
 830  */
 831 #ifndef CLOCK_MONOTONIC_RAW
 832 #define CLOCK_MONOTONIC_RAW 4
 833 #endif
 834 #ifndef CLOCK_BOOTTIME
 835 #define CLOCK_BOOTTIME 7
 836 #endif
 837 #ifndef CLOCK_TAI
 838 #define CLOCK_TAI 11
 839 #endif
 840
 841 static const struct clockid_map clockids[] = {
 842         /* available for all events, NMI safe */
 843         CLOCKID_MAP("monotonic", CLOCK_MONOTONIC),
 844         CLOCKID_MAP("monotonic_raw", CLOCK_MONOTONIC_RAW),
 845
 846         /* available for some events */
 847         CLOCKID_MAP("realtime", CLOCK_REALTIME),
 848         CLOCKID_MAP("boottime", CLOCK_BOOTTIME),
 849         CLOCKID_MAP("tai", CLOCK_TAI),
 850
 851         /* available for the lazy */
 852         CLOCKID_MAP("mono", CLOCK_MONOTONIC),
 853         CLOCKID_MAP("raw", CLOCK_MONOTONIC_RAW),
 854         CLOCKID_MAP("real", CLOCK_REALTIME),
 855         CLOCKID_MAP("boot", CLOCK_BOOTTIME),
 856
 857         CLOCKID_END,
 858 };
 859
 860 static int parse_clockid(const struct option *opt, const char *str, int unset)
 861 {
 862         struct record_opts *opts = (struct record_opts *)opt->value;
 863         const struct clockid_map *cm;
 864         const char *ostr = str;
 865
 866         if (unset) {
 867                 opts->use_clockid = 0;
 868                 return 0;
 869         }
 870
 871         /* no arg passed */
 872         if (!str)
 873                 return 0;
 874
 875         /* no setting it twice */
 876         if (opts->use_clockid)
 877                 return -1;
 878
 879         opts->use_clockid = true;
 880
 881         /* if its a number, we're done */
 882         if (sscanf(str, "%d", &opts->clockid) == 1)
 883                 return 0;
 884
 885         /* allow a "CLOCK_" prefix to the name */
 886         if (!strncasecmp(str, "CLOCK_", 6))
 887                 str += 6;
 888
 889         for (cm = clockids; cm->name; cm++) {
 890                 if (!strcasecmp(str, cm->name)) {
 891                         opts->clockid = cm->clockid;
 892                         return 0;
 893                 }
 894         }
 895
 896         opts->use_clockid = false;
 897         ui__warning("unknown clockid %s, check man page\n", ostr);
 898         return -1;
 899 }
 900
 901 static int record__parse_mmap_pages(const struct option *opt,
 902                                     const char *str,
 903                                     int unset __maybe_unused)
 904 {
 905         struct record_opts *opts = opt->value;
 906         char *s, *p;
 907         unsigned int mmap_pages;
 908         int ret;
 909
 910         if (!str)
 911                 return -EINVAL;
 912
 913         s = strdup(str);
 914         if (!s)
 915                 return -ENOMEM;
 916
 917         p = strchr(s, ',');
 918         if (p)
 919                 *p = '\0';
 920
 921         if (*s) {
 922                 ret = __perf_evlist__parse_mmap_pages(&mmap_pages, s);
 923                 if (ret)
 924                         goto out_free;
 925                 opts->mmap_pages = mmap_pages;
 926         }
 927
 928         if (!p) {
 929                 ret = 0;
 930                 goto out_free;
 931         }
 932
 933         ret = __perf_evlist__parse_mmap_pages(&mmap_pages, p + 1);
 934         if (ret)
 935                 goto out_free;
 936
 937         opts->auxtrace_mmap_pages = mmap_pages;
 938
 939 out_free:
 940         free(s);
 941         return ret;
 942 }
 943
 944 static const char * const __record_usage[] = {
 945         "perf record [<options>] [<command>]",
 946         "perf record [<options>] -- <command> [<options>]",
 947         NULL
 948 };
 949 const char * const *record_usage = __record_usage;
 950
 951 /*
 952  * XXX Ideally would be local to cmd_record() and passed to a record__new
 953  * because we need to have access to it in record__exit, that is called
 954  * after cmd_record() exits, but since record_options need to be accessible to
 955  * builtin-script, leave it here.
 956  *
 957  * At least we don't ouch it in all the other functions here directly.
 958  *
 959  * Just say no to tons of global variables, sigh.
 960  */
 961 static struct record record = {
 962         .opts = {
 963                 .sample_time         = true,
 964                 .mmap_pages          = UINT_MAX,
 965                 .user_freq           = UINT_MAX,
 966                 .user_interval       = ULLONG_MAX,
 967                 .freq                = 4000,
 968                 .target              = {
 969                         .uses_mmap   = true,
 970                         .default_per_cpu = true,
 971                 },
 972                 .proc_map_timeout     = 500,
 973         },
 974         .tool = {
 975                 .sample         = process_sample_event,
 976                 .fork           = perf_event__process_fork,
 977                 .exit           = perf_event__process_exit,
 978                 .comm           = perf_event__process_comm,
 979                 .mmap           = perf_event__process_mmap,
 980                 .mmap2          = perf_event__process_mmap2,
 981                 .ordered_events = true,
 982         },
 983 };
 984
 985 #define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace) recording: "
 986
 987 #ifdef HAVE_DWARF_UNWIND_SUPPORT
 988 const char record_callchain_help[] = CALLCHAIN_HELP "fp dwarf lbr";
 989 #else
 990 const char record_callchain_help[] = CALLCHAIN_HELP "fp lbr";
 991 #endif
 992
 993 /*
 994  * XXX Will stay a global variable till we fix builtin-script.c to stop messing
 995  * with it and switch to use the library functions in perf_evlist that came
 996  * from builtin-record.c, i.e. use record_opts,
 997  * perf_evlist__prepare_workload, etc instead of fork+exec'in 'perf record',
 998  * using pipes, etc.
 999  */
1000 struct option __record_options[] = {
1001         OPT_CALLBACK('e', "event", &record.evlist, "event",
1002                      "event selector. use 'perf list' to list available events",
1003                      parse_events_option),
1004         OPT_CALLBACK(0, "filter", &record.evlist, "filter",
1005                      "event filter", parse_filter),
1006         OPT_STRING('p', "pid", &record.opts.target.pid, "pid",
1007                     "record events on existing process id"),
1008         OPT_STRING('t', "tid", &record.opts.target.tid, "tid",
1009                     "record events on existing thread id"),
1010         OPT_INTEGER('r', "realtime", &record.realtime_prio,
1011                     "collect data with this RT SCHED_FIFO priority"),
1012         OPT_BOOLEAN(0, "no-buffering", &record.opts.no_buffering,
1013                     "collect data without buffering"),
1014         OPT_BOOLEAN('R', "raw-samples", &record.opts.raw_samples,
1015                     "collect raw sample records from all opened counters"),
1016         OPT_BOOLEAN('a', "all-cpus", &record.opts.target.system_wide,
1017                             "system-wide collection from all CPUs"),
1018         OPT_STRING('C', "cpu", &record.opts.target.cpu_list, "cpu",
1019                     "list of cpus to monitor"),
1020         OPT_U64('c', "count", &record.opts.user_interval, "event period to sample"),
1021         OPT_STRING('o', "output", &record.file.path, "file",
1022                     "output file name"),
1023         OPT_BOOLEAN_SET('i', "no-inherit", &record.opts.no_inherit,
1024                         &record.opts.no_inherit_set,
1025                         "child tasks do not inherit counters"),
1026         OPT_UINTEGER('F', "freq", &record.opts.user_freq, "profile at this frequency"),
1027         OPT_CALLBACK('m', "mmap-pages", &record.opts, "pages[,pages]",
1028                      "number of mmap data pages and AUX area tracing mmap pages",
1029                      record__parse_mmap_pages),
1030         OPT_BOOLEAN(0, "group", &record.opts.group,
1031                     "put the counters into a counter group"),
1032         OPT_CALLBACK_NOOPT('g', NULL, &record.opts,
1033                            NULL, "enables call-graph recording" ,
1034                            &record_callchain_opt),
1035         OPT_CALLBACK(0, "call-graph", &record.opts,
1036                      "mode[,dump_size]", record_callchain_help,
1037                      &record_parse_callchain_opt),
1038         OPT_INCR('v', "verbose", &verbose,
1039                     "be more verbose (show counter open errors, etc)"),
1040         OPT_BOOLEAN('q', "quiet", &quiet, "don't print any message"),
1041         OPT_BOOLEAN('s', "stat", &record.opts.inherit_stat,
1042                     "per thread counts"),
1043         OPT_BOOLEAN('d', "data", &record.opts.sample_address, "Record the sample addresses"),
1044         OPT_BOOLEAN('T', "timestamp", &record.opts.sample_time, "Record the sample timestamps"),
1045         OPT_BOOLEAN('P', "period", &record.opts.period, "Record the sample period"),
1046         OPT_BOOLEAN('n', "no-samples", &record.opts.no_samples,
1047                     "don't sample"),
1048         OPT_BOOLEAN('N', "no-buildid-cache", &record.no_buildid_cache,
1049                     "do not update the buildid cache"),
1050         OPT_BOOLEAN('B', "no-buildid", &record.no_buildid,
1051                     "do not collect buildids in perf.data"),
1052         OPT_CALLBACK('G', "cgroup", &record.evlist, "name",
1053                      "monitor event in cgroup name only",
1054                      parse_cgroups),
1055         OPT_UINTEGER('D', "delay", &record.opts.initial_delay,
1056                   "ms to wait before starting measurement after program start"),
1057         OPT_STRING('u', "uid", &record.opts.target.uid_str, "user",
1058                    "user to profile"),
1059
1060         OPT_CALLBACK_NOOPT('b', "branch-any", &record.opts.branch_stack,
1061                      "branch any", "sample any taken branches",
1062                      parse_branch_stack),
1063
1064         OPT_CALLBACK('j', "branch-filter", &record.opts.branch_stack,
1065                      "branch filter mask", "branch stack filter modes",
1066                      parse_branch_stack),
1067         OPT_BOOLEAN('W', "weight", &record.opts.sample_weight,
1068                     "sample by weight (on special events only)"),
1069         OPT_BOOLEAN(0, "transaction", &record.opts.sample_transaction,
1070                     "sample transaction flags (special events only)"),
1071         OPT_BOOLEAN(0, "per-thread", &record.opts.target.per_thread,
1072                     "use per-thread mmaps"),
1073         OPT_BOOLEAN('I', "intr-regs", &record.opts.sample_intr_regs,
1074                     "Sample machine registers on interrupt"),
1075         OPT_BOOLEAN(0, "running-time", &record.opts.running_time,
1076                     "Record running/enabled time of read (:S) events"),
1077         OPT_CALLBACK('k', "clockid", &record.opts,
1078         "clockid", "clockid to use for events, see clock_gettime()",
1079         parse_clockid),
1080         OPT_STRING_OPTARG('S', "snapshot", &record.opts.auxtrace_snapshot_opts,
1081                           "opts", "AUX area tracing Snapshot Mode", ""),
1082         OPT_UINTEGER(0, "proc-map-timeout", &record.opts.proc_map_timeout,
1083                         "per thread proc mmap processing timeout in ms"),
1084         OPT_END()
1085 };
1086
1087 struct option *record_options = __record_options;
1088
1089 int cmd_record(int argc, const char **argv, const char *prefix __maybe_unused)
1090 {
1091         int err;
1092         struct record *rec = &record;
1093         char errbuf[BUFSIZ];
1094
1095         rec->evlist = perf_evlist__new();
1096         if (rec->evlist == NULL)
1097                 return -ENOMEM;
1098
1099         perf_config(perf_record_config, rec);
1100
1101         argc = parse_options(argc, argv, record_options, record_usage,
1102                             PARSE_OPT_STOP_AT_NON_OPTION);
1103         if (!argc && target__none(&rec->opts.target))
1104                 usage_with_options(record_usage, record_options);
1105
1106         if (nr_cgroups && !rec->opts.target.system_wide) {
1107                 ui__error("cgroup monitoring only available in"
1108                           " system-wide mode\n");
1109                 usage_with_options(record_usage, record_options);
1110         }
1111
1112         if (!rec->itr) {
1113                 rec->itr = auxtrace_record__init(rec->evlist, &err);
1114                 if (err)
1115                         return err;
1116         }
1117
1118         err = auxtrace_parse_snapshot_options(rec->itr, &rec->opts,
1119                                               rec->opts.auxtrace_snapshot_opts);
1120         if (err)
1121                 return err;
1122
1123         err = -ENOMEM;
1124
1125         symbol__init(NULL);
1126
1127         if (symbol_conf.kptr_restrict)
1128                 pr_warning(
1129 "WARNING: Kernel address maps (/proc/{kallsyms,modules}) are restricted,\n"
1130 "check /proc/sys/kernel/kptr_restrict.\n\n"
1131 "Samples in kernel functions may not be resolved if a suitable vmlinux\n"
1132 "file is not found in the buildid cache or in the vmlinux path.\n\n"
1133 "Samples in kernel modules won't be resolved at all.\n\n"
1134 "If some relocation was applied (e.g. kexec) symbols may be misresolved\n"
1135 "even with a suitable vmlinux or kallsyms file.\n\n");
1136
1137         if (rec->no_buildid_cache || rec->no_buildid)
1138                 disable_buildid_cache();
1139
1140         if (rec->evlist->nr_entries == 0 &&
1141             perf_evlist__add_default(rec->evlist) < 0) {
1142                 pr_err("Not enough memory for event selector list\n");
1143                 goto out_symbol_exit;
1144         }
1145
1146         if (rec->opts.target.tid && !rec->opts.no_inherit_set)
1147                 rec->opts.no_inherit = true;
1148
1149         err = target__validate(&rec->opts.target);
1150         if (err) {
1151                 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1152                 ui__warning("%s", errbuf);
1153         }
1154
1155         err = target__parse_uid(&rec->opts.target);
1156         if (err) {
1157                 int saved_errno = errno;
1158
1159                 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1160                 ui__error("%s", errbuf);
1161
1162                 err = -saved_errno;
1163                 goto out_symbol_exit;
1164         }
1165
1166         err = -ENOMEM;
1167         if (perf_evlist__create_maps(rec->evlist, &rec->opts.target) < 0)
1168                 usage_with_options(record_usage, record_options);
1169
1170         err = auxtrace_record__options(rec->itr, rec->evlist, &rec->opts);
1171         if (err)
1172                 goto out_symbol_exit;
1173
1174         if (record_opts__config(&rec->opts)) {
1175                 err = -EINVAL;
1176                 goto out_symbol_exit;
1177         }
1178
1179         err = __cmd_record(&record, argc, argv);
1180 out_symbol_exit:
1181         perf_evlist__delete(rec->evlist);
1182         symbol__exit();
1183         auxtrace_record__free(rec->itr);
1184         return err;
1185 }
1186
1187 static void snapshot_sig_handler(int sig __maybe_unused)
1188 {
1189         if (!auxtrace_snapshot_enabled)
1190                 return;
1191         auxtrace_snapshot_enabled = 0;
1192         auxtrace_snapshot_err = auxtrace_record__snapshot_start(record.itr);
1193         auxtrace_record__snapshot_started = 1;
1194 }