perf inject: Lazy build-id mmap2 event insertion

Add -B option that lazily inserts mmap2 events thereby dropping all
mmap events without samples. This is similar to the behavior of -b
where only build_id events are inserted when a dso is accessed in a
sample.

File size savings can be significant in system-wide mode, consider:

  $ perf record -g -a -o perf.data sleep 1
  $ perf inject -B -i perf.data -o perf.new.data
  $ ls -al perf.data perf.new.data
           5147049 perf.data
           2248493 perf.new.data

Give test coverage of the new option in pipe test.

Signed-off-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: Anne Macedo <retpolanne@posteo.net>
Cc: Casey Chen <cachen@purestorage.com>
Cc: Colin Ian King <colin.i.king@gmail.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Kan Liang <kan.liang@linux.intel.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Sun Haiyong <sunhaiyong@loongson.cn>
Link: https://lore.kernel.org/r/20240909203740.143492-4-irogers@google.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>

diff --git a/tools/perf/builtin-inject.c b/tools/perf/builtin-inject.c
index 5a27fa46e93dd06521071717d2ae3d1d2ccba4ca..9eb72ff48d88e8d6ea597b07dcc14fcea42bc341 100644 (file)
--- a/tools/perf/builtin-inject.c
+++ b/tools/perf/builtin-inject.c
@@ -108,6 +108,7 @@ enum build_id_rewrite_style {
        BID_RWS__INJECT_HEADER_LAZY,
        BID_RWS__INJECT_HEADER_ALL,
        BID_RWS__MMAP2_BUILDID_ALL,
+       BID_RWS__MMAP2_BUILDID_LAZY,
 };
 
 struct perf_inject {
@@ -527,7 +528,8 @@ static int perf_event__repipe_common_mmap(const struct perf_tool *tool,
                 * Remember the evsel for lazy build id generation. It is used
                 * for the sample id header type.
                 */
-               if (inject->build_id_style == BID_RWS__INJECT_HEADER_LAZY &&
+               if ((inject->build_id_style == BID_RWS__INJECT_HEADER_LAZY ||
+                    inject->build_id_style == BID_RWS__MMAP2_BUILDID_LAZY) &&
                    !inject->mmap_evsel)
                        inject->mmap_evsel = evlist__event2evsel(inject->session->evlist, event);
 
@@ -560,6 +562,9 @@ static int perf_event__repipe_common_mmap(const struct perf_tool *tool,
                }
        }
        dso__put(dso);
+       if (inject->build_id_style == BID_RWS__MMAP2_BUILDID_LAZY)
+               return 0;
+
        return perf_event__repipe(tool, event, sample, machine);
 }
 
@@ -825,7 +830,8 @@ static int tool__inject_mmap2_build_id(const struct perf_tool *tool,
        return 0;
 }
 
-static int mark_dso_hit(const struct perf_tool *tool,
+static int mark_dso_hit(const struct perf_inject *inject,
+                       const struct perf_tool *tool,
                        struct perf_sample *sample,
                        struct machine *machine,
                        const struct evsel *mmap_evsel,
@@ -854,16 +860,39 @@ static int mark_dso_hit(const struct perf_tool *tool,
                }
        }
        dso = map__dso(map);
-       if (dso && !dso__hit(dso)) {
-               dso__set_hit(dso);
-               tool__inject_build_id(tool, sample, machine,
-                                     mmap_evsel, misc, dso__long_name(dso), dso,
-                                     map__flags(map));
+       if (inject->build_id_style == BID_RWS__INJECT_HEADER_LAZY) {
+               if (dso && !dso__hit(dso)) {
+                       dso__set_hit(dso);
+                       tool__inject_build_id(tool, sample, machine,
+                                            mmap_evsel, misc, dso__long_name(dso), dso,
+                                            map__flags(map));
+               }
+       } else if (inject->build_id_style == BID_RWS__MMAP2_BUILDID_LAZY) {
+               if (!map__hit(map)) {
+                       const struct build_id null_bid = { .size = 0 };
+                       const struct build_id *bid = dso ? dso__bid(dso) : &null_bid;
+                       const char *filename = dso ? dso__long_name(dso) : "";
+
+                       map__set_hit(map);
+                       perf_event__synthesize_mmap2_build_id(tool, sample, machine,
+                                                               perf_event__repipe,
+                                                               mmap_evsel,
+                                                               misc,
+                                                               sample->pid, sample->tid,
+                                                               map__start(map),
+                                                               map__end(map) - map__start(map),
+                                                               map__pgoff(map),
+                                                               bid,
+                                                               map__prot(map),
+                                                               map__flags(map),
+                                                               filename);
+               }
        }
        return 0;
 }
 
 struct mark_dso_hit_args {
+       const struct perf_inject *inject;
        const struct perf_tool *tool;
        struct perf_sample *sample;
        struct machine *machine;
@@ -875,7 +904,7 @@ static int mark_dso_hit_callback(struct callchain_cursor_node *node, void *data)
        struct mark_dso_hit_args *args = data;
        struct map *map = node->ms.map;
 
-       return mark_dso_hit(args->tool, args->sample, args->machine,
+       return mark_dso_hit(args->inject, args->tool, args->sample, args->machine,
                            args->mmap_evsel, map, /*sample_in_dso=*/false);
 }
 
@@ -888,6 +917,7 @@ int perf_event__inject_buildid(const struct perf_tool *tool, union perf_event *e
        struct thread *thread;
        struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
        struct mark_dso_hit_args args = {
+               .inject = inject,
                .tool = tool,
                /*
                 * Use the parsed sample data of the sample event, which will
@@ -907,7 +937,7 @@ int perf_event__inject_buildid(const struct perf_tool *tool, union perf_event *e
        }
 
        if (thread__find_map(thread, sample->cpumode, sample->ip, &al)) {
-               mark_dso_hit(tool, sample, machine, args.mmap_evsel, al.map,
+               mark_dso_hit(inject, tool, sample, machine, args.mmap_evsel, al.map,
                             /*sample_in_dso=*/true);
        }
 
@@ -2155,7 +2185,8 @@ static int __cmd_inject(struct perf_inject *inject)
 #endif
        }
 
-       if (inject->build_id_style == BID_RWS__INJECT_HEADER_LAZY) {
+       if (inject->build_id_style == BID_RWS__INJECT_HEADER_LAZY ||
+           inject->build_id_style == BID_RWS__MMAP2_BUILDID_LAZY) {
                inject->tool.sample = perf_event__inject_buildid;
        } else if (inject->sched_stat) {
                struct evsel *evsel;
@@ -2338,6 +2369,7 @@ int cmd_inject(int argc, const char **argv)
        const char *known_build_ids = NULL;
        bool build_ids;
        bool build_id_all;
+       bool mmap2_build_ids;
        bool mmap2_build_id_all;
 
        struct option options[] = {
@@ -2345,6 +2377,8 @@ int cmd_inject(int argc, const char **argv)
                            "Inject build-ids into the output stream"),
                OPT_BOOLEAN(0, "buildid-all", &build_id_all,
                            "Inject build-ids of all DSOs into the output stream"),
+               OPT_BOOLEAN('B', "mmap2-buildids", &mmap2_build_ids,
+                           "Drop unused mmap events, make others mmap2 with build IDs"),
                OPT_BOOLEAN(0, "mmap2-buildid-all", &mmap2_build_id_all,
                            "Rewrite all mmap events as mmap2 events with build IDs"),
                OPT_STRING(0, "known-build-ids", &known_build_ids,
@@ -2443,6 +2477,8 @@ int cmd_inject(int argc, const char **argv)
                        return -1;
                }
        }
+       if (mmap2_build_ids)
+               inject.build_id_style = BID_RWS__MMAP2_BUILDID_LAZY;
        if (mmap2_build_id_all)
                inject.build_id_style = BID_RWS__MMAP2_BUILDID_ALL;
        if (build_ids)
@@ -2453,7 +2489,8 @@ int cmd_inject(int argc, const char **argv)
        data.path = inject.input_name;
 
        ordered_events = inject.jit_mode || inject.sched_stat ||
-               (inject.build_id_style == BID_RWS__INJECT_HEADER_LAZY);
+               inject.build_id_style == BID_RWS__INJECT_HEADER_LAZY ||
+               inject.build_id_style == BID_RWS__MMAP2_BUILDID_LAZY;
        perf_tool__init(&inject.tool, ordered_events);
        inject.tool.sample              = perf_event__repipe_sample;
        inject.tool.read                = perf_event__repipe_sample;
@@ -2532,7 +2569,8 @@ int cmd_inject(int argc, const char **argv)
                }
        }
 
-       if (inject.build_id_style == BID_RWS__INJECT_HEADER_LAZY) {
+       if (inject.build_id_style == BID_RWS__INJECT_HEADER_LAZY ||
+           inject.build_id_style == BID_RWS__MMAP2_BUILDID_LAZY) {
                /*
                 * to make sure the mmap records are ordered correctly
                 * and so that the correct especially due to jitted code

diff --git a/tools/perf/tests/shell/pipe_test.sh b/tools/perf/tests/shell/pipe_test.sh
index 250574cd68b6136cbcb3201ccb98c2688fc04e11..d4c8005ce9b96bfdef290c671f20ae7451186b0f 100755 (executable)
--- a/tools/perf/tests/shell/pipe_test.sh
+++ b/tools/perf/tests/shell/pipe_test.sh
@@ -116,6 +116,7 @@ test_inject_bids() {
 }
 
 test_record_report
+test_inject_bids -B
 test_inject_bids -b
 test_inject_bids --buildid-all
 test_inject_bids --mmap2-buildid-all

diff --git a/tools/perf/util/map.c b/tools/perf/util/map.c
index e781c8d56a9aeb3449c3d3fa9d69347f7d89099f..d729438b7d65730f2257d563f652724941483e24 100644 (file)
--- a/tools/perf/util/map.c
+++ b/tools/perf/util/map.c
@@ -116,6 +116,7 @@ static void map__init(struct map *map, u64 start, u64 end, u64 pgoff,
        map__set_mapping_type(map, MAPPING_TYPE__DSO);
        assert(map__erange_warned(map) == false);
        assert(map__priv(map) == false);
+       assert(map__hit(map) == false);
 }
 
 struct map *map__new(struct machine *machine, u64 start, u64 len,

diff --git a/tools/perf/util/map.h b/tools/perf/util/map.h
index 6c43f31a9fe06f43743456b5425883afa7baef9b..4262f5a143be26c488949b1dad3288565693ae14 100644 (file)
--- a/tools/perf/util/map.h
+++ b/tools/perf/util/map.h
@@ -35,6 +35,7 @@ DECLARE_RC_STRUCT(map) {
        enum mapping_type       mapping_type:8;
        bool                    erange_warned;
        bool                    priv;
+       bool                    hit;
 };
 
 struct kmap;
@@ -83,6 +84,11 @@ static inline bool map__priv(const struct map *map)
        return RC_CHK_ACCESS(map)->priv;
 }
 
+static inline bool map__hit(const struct map *map)
+{
+       return RC_CHK_ACCESS(map)->hit;
+}
+
 static inline refcount_t *map__refcnt(struct map *map)
 {
        return &RC_CHK_ACCESS(map)->refcnt;
@@ -287,6 +293,11 @@ static inline void map__set_priv(struct map *map)
        RC_CHK_ACCESS(map)->priv = true;
 }
 
+static inline void map__set_hit(struct map *map)
+{
+       RC_CHK_ACCESS(map)->hit = true;
+}
+
 static inline void map__set_erange_warned(struct map *map)
 {
        RC_CHK_ACCESS(map)->erange_warned = true;