perf record: Add --buildid-mmap option to enable PERF_RECORD_MMAP2's build id
authorJiri Olsa <jolsa@kernel.org>
Mon, 14 Dec 2020 10:54:57 +0000 (11:54 +0100)
committerArnaldo Carvalho de Melo <acme@redhat.com>
Mon, 28 Dec 2020 14:35:57 +0000 (11:35 -0300)
Add --buildid-mmap option to enable build id in PERF_RECORD_MMAP2 events.

It will only work if there's kernel support for that and it disables
build id cache (implies --no-buildid).

It's also possible to enable it permanently via config option in
~/.perfconfig file:

  [record]
  build-id=mmap

Also added build_id bit in the verbose output for perf_event_attr:

  # perf record --buildid-mmap -vv
  ...
  perf_event_attr:
    type                             1
    size                             120
    ...
    build_id                         1

Adding also missing text_poke bit.

Committer testing:

  $ perf record -h build

   Usage: perf record [<options>] [<command>]
      or: perf record [<options>] -- <command> [<options>]

      -B, --no-buildid      do not collect buildids in perf.data
      -N, --no-buildid-cache
                            do not update the buildid cache
          --buildid-all     Record build-id of all DSOs regardless of hits
          --buildid-mmap    Record build-id in map events

  $

  $ perf record --buildid-mmap sleep 1
  Failed: no support to record build id in mmap events, update your kernel.
  $

After adding the needed kernel bits in a test kernel:

  $ perf record -vv --buildid-mmap sleep 1 |& grep -m1 build
  Enabling build id in mmap2 events.
  $ perf evlist -v
  cycles:u: size: 120, { sample_period, sample_freq }: 4000, sample_type: IP|TID|TIME|PERIOD, read_format: ID, disabled: 1, inherit: 1, exclude_kernel: 1, mmap: 1, comm: 1, freq: 1, enable_on_exec: 1, task: 1, sample_id_all: 1, exclude_guest: 1, mmap2: 1, comm_exec: 1, ksymbol: 1, bpf_event: 1, build_id: 1
  $

Signed-off-by: Jiri Olsa <jolsa@kernel.org>
Tested-by: Arnaldo Carvalho de Melo <acme@redhat.com>
Acked-by: Ian Rogers <irogers@google.com>
Acked-by: Namhyung Kim <namhyung@kernel.org>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Alexei Budankov <abudankov@huawei.com>
Cc: Andi Kleen <ak@linux.intel.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Michael Petlan <mpetlan@redhat.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Song Liu <songliubraving@fb.com>
Cc: Stephane Eranian <eranian@google.com>
Link: http://lore.kernel.org/lkml/20201214105457.543111-16-jolsa@kernel.org
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
tools/perf/Documentation/perf-config.txt
tools/perf/Documentation/perf-record.txt
tools/perf/builtin-record.c
tools/perf/util/evsel.c
tools/perf/util/perf_api_probe.c
tools/perf/util/perf_api_probe.h
tools/perf/util/perf_event_attr_fprintf.c
tools/perf/util/record.h

index 5c379ad..1a0e134 100644 (file)
@@ -552,11 +552,12 @@ kmem.*::
 
 record.*::
        record.build-id::
-               This option can be 'cache', 'no-cache' or 'skip'.
+               This option can be 'cache', 'no-cache', 'skip' or 'mmap'.
                'cache' is to post-process data and save/update the binaries into
                the build-id cache (in ~/.debug). This is the default.
                But if this option is 'no-cache', it will not update the build-id cache.
                'skip' skips post-processing and does not update the cache.
+               'mmap' skips post-processing and reads build-ids from MMAP events.
 
        record.call-graph::
                This is identical to 'call-graph.record-mode', except it is
index 34cf651..0042ff7 100644 (file)
@@ -485,6 +485,9 @@ Specify vmlinux path which has debuginfo.
 --buildid-all::
 Record build-id of all DSOs regardless whether it's actually hit or not.
 
+--buildid-mmap::
+Record build ids in mmap2 events, disables build id cache (implies --no-buildid).
+
 --aio[=n]::
 Use <n> control blocks in asynchronous (Posix AIO) trace writing mode (default: 1, max: 4).
 Asynchronous mode is supported only when linking Perf tool with libc library
index fd39116..7bb10e9 100644 (file)
@@ -102,6 +102,7 @@ struct record {
        bool                    no_buildid_cache;
        bool                    no_buildid_cache_set;
        bool                    buildid_all;
+       bool                    buildid_mmap;
        bool                    timestamp_filename;
        bool                    timestamp_boundary;
        struct switch_output    switch_output;
@@ -2135,6 +2136,8 @@ static int perf_record_config(const char *var, const char *value, void *cb)
                        rec->no_buildid_cache = true;
                else if (!strcmp(value, "skip"))
                        rec->no_buildid = true;
+               else if (!strcmp(value, "mmap"))
+                       rec->buildid_mmap = true;
                else
                        return -1;
                return 0;
@@ -2552,6 +2555,8 @@ static struct option __record_options[] = {
                   "file", "vmlinux pathname"),
        OPT_BOOLEAN(0, "buildid-all", &record.buildid_all,
                    "Record build-id of all DSOs regardless of hits"),
+       OPT_BOOLEAN(0, "buildid-mmap", &record.buildid_mmap,
+                   "Record build-id in map events"),
        OPT_BOOLEAN(0, "timestamp-filename", &record.timestamp_filename,
                    "append timestamp to output filename"),
        OPT_BOOLEAN(0, "timestamp-boundary", &record.timestamp_boundary,
@@ -2655,6 +2660,21 @@ int cmd_record(int argc, const char **argv)
 
        }
 
+       if (rec->buildid_mmap) {
+               if (!perf_can_record_build_id()) {
+                       pr_err("Failed: no support to record build id in mmap events, update your kernel.\n");
+                       err = -EINVAL;
+                       goto out_opts;
+               }
+               pr_debug("Enabling build id in mmap2 events.\n");
+               /* Enable mmap build id synthesizing. */
+               symbol_conf.buildid_mmap2 = true;
+               /* Enable perf_event_attr::build_id bit. */
+               rec->opts.build_id = true;
+               /* Disable build id cache. */
+               rec->no_buildid = true;
+       }
+
        if (rec->opts.kcore)
                rec->data.is_dir = true;
 
index c26ea82..dc0cfa5 100644 (file)
@@ -1168,10 +1168,12 @@ void evsel__config(struct evsel *evsel, struct record_opts *opts,
        if (opts->sample_weight)
                evsel__set_sample_bit(evsel, WEIGHT);
 
-       attr->task  = track;
-       attr->mmap  = track;
-       attr->mmap2 = track && !perf_missing_features.mmap2;
-       attr->comm  = track;
+       attr->task     = track;
+       attr->mmap     = track;
+       attr->mmap2    = track && !perf_missing_features.mmap2;
+       attr->comm     = track;
+       attr->build_id = track && opts->build_id;
+
        /*
         * ksymbol is tracked separately with text poke because it needs to be
         * system wide and enabled immediately.
index 3840d02..829af17 100644 (file)
@@ -98,6 +98,11 @@ static void perf_probe_text_poke(struct evsel *evsel)
        evsel->core.attr.text_poke = 1;
 }
 
+static void perf_probe_build_id(struct evsel *evsel)
+{
+       evsel->core.attr.build_id = 1;
+}
+
 bool perf_can_sample_identifier(void)
 {
        return perf_probe_api(perf_probe_sample_identifier);
@@ -172,3 +177,8 @@ bool perf_can_aux_sample(void)
 
        return true;
 }
+
+bool perf_can_record_build_id(void)
+{
+       return perf_probe_api(perf_probe_build_id);
+}
index d5506a9..f12ca55 100644 (file)
@@ -11,5 +11,6 @@ bool perf_can_record_cpu_wide(void);
 bool perf_can_record_switch_events(void);
 bool perf_can_record_text_poke_events(void);
 bool perf_can_sample_identifier(void);
+bool perf_can_record_build_id(void);
 
 #endif // __PERF_API_PROBE_H
index fb0bb66..22b417f 100644 (file)
@@ -134,6 +134,8 @@ int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
        PRINT_ATTRf(bpf_event, p_unsigned);
        PRINT_ATTRf(aux_output, p_unsigned);
        PRINT_ATTRf(cgroup, p_unsigned);
+       PRINT_ATTRf(text_poke, p_unsigned);
+       PRINT_ATTRf(build_id, p_unsigned);
 
        PRINT_ATTRn("{ wakeup_events, wakeup_watermark }", wakeup_events, p_unsigned);
        PRINT_ATTRf(bp_type, p_unsigned);
index 694b351..b996ce6 100644 (file)
@@ -50,6 +50,7 @@ struct record_opts {
        bool          no_bpf_event;
        bool          kcore;
        bool          text_poke;
+       bool          build_id;
        unsigned int  freq;
        unsigned int  mmap_pages;
        unsigned int  auxtrace_mmap_pages;