1 // SPDX-License-Identifier: GPL-2.0
5 * Builtin inject command: Examine the live mode (stdin) event stream
6 * and repipe it to stdout while optionally injecting additional
11 #include "util/color.h"
13 #include "util/evlist.h"
14 #include "util/evsel.h"
16 #include "util/session.h"
17 #include "util/tool.h"
18 #include "util/debug.h"
19 #include "util/build-id.h"
20 #include "util/data.h"
21 #include "util/auxtrace.h"
23 #include "util/symbol.h"
24 #include "util/synthetic-events.h"
25 #include "util/thread.h"
27 #include <subcmd/parse-options.h>
29 #include <linux/list.h>
34 struct perf_tool tool;
35 struct perf_session *session;
41 const char *input_name;
42 struct perf_data output;
45 struct list_head samples;
46 struct itrace_synth_opts itrace_synth_opts;
50 struct list_head node;
52 union perf_event event[0];
55 static int output_bytes(struct perf_inject *inject, void *buf, size_t sz)
59 size = perf_data__write(&inject->output, buf, sz);
63 inject->bytes_written += size;
67 static int perf_event__repipe_synth(struct perf_tool *tool,
68 union perf_event *event)
70 struct perf_inject *inject = container_of(tool, struct perf_inject,
73 return output_bytes(inject, event, event->header.size);
76 static int perf_event__repipe_oe_synth(struct perf_tool *tool,
77 union perf_event *event,
78 struct ordered_events *oe __maybe_unused)
80 return perf_event__repipe_synth(tool, event);
84 static int perf_event__drop_oe(struct perf_tool *tool __maybe_unused,
85 union perf_event *event __maybe_unused,
86 struct ordered_events *oe __maybe_unused)
92 static int perf_event__repipe_op2_synth(struct perf_session *session,
93 union perf_event *event)
95 return perf_event__repipe_synth(session->tool, event);
98 static int perf_event__repipe_attr(struct perf_tool *tool,
99 union perf_event *event,
100 struct evlist **pevlist)
102 struct perf_inject *inject = container_of(tool, struct perf_inject,
106 ret = perf_event__process_attr(tool, event, pevlist);
110 if (!inject->output.is_pipe)
113 return perf_event__repipe_synth(tool, event);
116 #ifdef HAVE_AUXTRACE_SUPPORT
118 static int copy_bytes(struct perf_inject *inject, int fd, off_t size)
125 ssz = read(fd, buf, min(size, (off_t)sizeof(buf)));
128 ret = output_bytes(inject, buf, ssz);
137 static s64 perf_event__repipe_auxtrace(struct perf_session *session,
138 union perf_event *event)
140 struct perf_tool *tool = session->tool;
141 struct perf_inject *inject = container_of(tool, struct perf_inject,
145 inject->have_auxtrace = true;
147 if (!inject->output.is_pipe) {
150 offset = lseek(inject->output.file.fd, 0, SEEK_CUR);
153 ret = auxtrace_index__auxtrace_event(&session->auxtrace_index,
159 if (perf_data__is_pipe(session->data) || !session->one_mmap) {
160 ret = output_bytes(inject, event, event->header.size);
163 ret = copy_bytes(inject, perf_data__fd(session->data),
164 event->auxtrace.size);
166 ret = output_bytes(inject, event,
167 event->header.size + event->auxtrace.size);
172 return event->auxtrace.size;
178 perf_event__repipe_auxtrace(struct perf_session *session __maybe_unused,
179 union perf_event *event __maybe_unused)
181 pr_err("AUX area tracing not supported\n");
187 static int perf_event__repipe(struct perf_tool *tool,
188 union perf_event *event,
189 struct perf_sample *sample __maybe_unused,
190 struct machine *machine __maybe_unused)
192 return perf_event__repipe_synth(tool, event);
195 static int perf_event__drop(struct perf_tool *tool __maybe_unused,
196 union perf_event *event __maybe_unused,
197 struct perf_sample *sample __maybe_unused,
198 struct machine *machine __maybe_unused)
203 static int perf_event__drop_aux(struct perf_tool *tool,
204 union perf_event *event __maybe_unused,
205 struct perf_sample *sample,
206 struct machine *machine __maybe_unused)
208 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
211 inject->aux_id = sample->id;
216 typedef int (*inject_handler)(struct perf_tool *tool,
217 union perf_event *event,
218 struct perf_sample *sample,
220 struct machine *machine);
222 static int perf_event__repipe_sample(struct perf_tool *tool,
223 union perf_event *event,
224 struct perf_sample *sample,
226 struct machine *machine)
228 if (evsel && evsel->handler) {
229 inject_handler f = evsel->handler;
230 return f(tool, event, sample, evsel, machine);
233 build_id__mark_dso_hit(tool, event, sample, evsel, machine);
235 return perf_event__repipe_synth(tool, event);
238 static int perf_event__repipe_mmap(struct perf_tool *tool,
239 union perf_event *event,
240 struct perf_sample *sample,
241 struct machine *machine)
245 err = perf_event__process_mmap(tool, event, sample, machine);
246 perf_event__repipe(tool, event, sample, machine);
252 static int perf_event__jit_repipe_mmap(struct perf_tool *tool,
253 union perf_event *event,
254 struct perf_sample *sample,
255 struct machine *machine)
257 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
262 * if jit marker, then inject jit mmaps and generate ELF images
264 ret = jit_process(inject->session, &inject->output, machine,
265 event->mmap.filename, sample->pid, &n);
269 inject->bytes_written += n;
272 return perf_event__repipe_mmap(tool, event, sample, machine);
276 static int perf_event__repipe_mmap2(struct perf_tool *tool,
277 union perf_event *event,
278 struct perf_sample *sample,
279 struct machine *machine)
283 err = perf_event__process_mmap2(tool, event, sample, machine);
284 perf_event__repipe(tool, event, sample, machine);
290 static int perf_event__jit_repipe_mmap2(struct perf_tool *tool,
291 union perf_event *event,
292 struct perf_sample *sample,
293 struct machine *machine)
295 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
300 * if jit marker, then inject jit mmaps and generate ELF images
302 ret = jit_process(inject->session, &inject->output, machine,
303 event->mmap2.filename, sample->pid, &n);
307 inject->bytes_written += n;
310 return perf_event__repipe_mmap2(tool, event, sample, machine);
314 static int perf_event__repipe_fork(struct perf_tool *tool,
315 union perf_event *event,
316 struct perf_sample *sample,
317 struct machine *machine)
321 err = perf_event__process_fork(tool, event, sample, machine);
322 perf_event__repipe(tool, event, sample, machine);
327 static int perf_event__repipe_comm(struct perf_tool *tool,
328 union perf_event *event,
329 struct perf_sample *sample,
330 struct machine *machine)
334 err = perf_event__process_comm(tool, event, sample, machine);
335 perf_event__repipe(tool, event, sample, machine);
340 static int perf_event__repipe_namespaces(struct perf_tool *tool,
341 union perf_event *event,
342 struct perf_sample *sample,
343 struct machine *machine)
345 int err = perf_event__process_namespaces(tool, event, sample, machine);
347 perf_event__repipe(tool, event, sample, machine);
352 static int perf_event__repipe_exit(struct perf_tool *tool,
353 union perf_event *event,
354 struct perf_sample *sample,
355 struct machine *machine)
359 err = perf_event__process_exit(tool, event, sample, machine);
360 perf_event__repipe(tool, event, sample, machine);
365 static int perf_event__repipe_tracing_data(struct perf_session *session,
366 union perf_event *event)
370 perf_event__repipe_synth(session->tool, event);
371 err = perf_event__process_tracing_data(session, event);
376 static int perf_event__repipe_id_index(struct perf_session *session,
377 union perf_event *event)
381 perf_event__repipe_synth(session->tool, event);
382 err = perf_event__process_id_index(session, event);
387 static int dso__read_build_id(struct dso *dso)
389 if (dso->has_build_id)
392 if (filename__read_build_id(dso->long_name, dso->build_id,
393 sizeof(dso->build_id)) > 0) {
394 dso->has_build_id = true;
401 static int dso__inject_build_id(struct dso *dso, struct perf_tool *tool,
402 struct machine *machine)
404 u16 misc = PERF_RECORD_MISC_USER;
407 if (dso__read_build_id(dso) < 0) {
408 pr_debug("no build_id found for %s\n", dso->long_name);
413 misc = PERF_RECORD_MISC_KERNEL;
415 err = perf_event__synthesize_build_id(tool, dso, misc, perf_event__repipe,
418 pr_err("Can't synthesize build_id event for %s\n", dso->long_name);
425 static int perf_event__inject_buildid(struct perf_tool *tool,
426 union perf_event *event,
427 struct perf_sample *sample,
428 struct evsel *evsel __maybe_unused,
429 struct machine *machine)
431 struct addr_location al;
432 struct thread *thread;
434 thread = machine__findnew_thread(machine, sample->pid, sample->tid);
435 if (thread == NULL) {
436 pr_err("problem processing %d event, skipping it.\n",
441 if (thread__find_map(thread, sample->cpumode, sample->ip, &al)) {
442 if (!al.map->dso->hit) {
443 al.map->dso->hit = 1;
444 if (map__load(al.map) >= 0) {
445 dso__inject_build_id(al.map->dso, tool, machine);
447 * If this fails, too bad, let the other side
448 * account this as unresolved.
451 #ifdef HAVE_LIBELF_SUPPORT
452 pr_warning("no symbols found in %s, maybe "
453 "install a debug package?\n",
454 al.map->dso->long_name);
462 perf_event__repipe(tool, event, sample, machine);
466 static int perf_inject__sched_process_exit(struct perf_tool *tool,
467 union perf_event *event __maybe_unused,
468 struct perf_sample *sample,
469 struct evsel *evsel __maybe_unused,
470 struct machine *machine __maybe_unused)
472 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
473 struct event_entry *ent;
475 list_for_each_entry(ent, &inject->samples, node) {
476 if (sample->tid == ent->tid) {
477 list_del_init(&ent->node);
486 static int perf_inject__sched_switch(struct perf_tool *tool,
487 union perf_event *event,
488 struct perf_sample *sample,
490 struct machine *machine)
492 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
493 struct event_entry *ent;
495 perf_inject__sched_process_exit(tool, event, sample, evsel, machine);
497 ent = malloc(event->header.size + sizeof(struct event_entry));
499 color_fprintf(stderr, PERF_COLOR_RED,
500 "Not enough memory to process sched switch event!");
504 ent->tid = sample->tid;
505 memcpy(&ent->event, event, event->header.size);
506 list_add(&ent->node, &inject->samples);
510 static int perf_inject__sched_stat(struct perf_tool *tool,
511 union perf_event *event __maybe_unused,
512 struct perf_sample *sample,
514 struct machine *machine)
516 struct event_entry *ent;
517 union perf_event *event_sw;
518 struct perf_sample sample_sw;
519 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
520 u32 pid = perf_evsel__intval(evsel, sample, "pid");
522 list_for_each_entry(ent, &inject->samples, node) {
529 event_sw = &ent->event[0];
530 perf_evsel__parse_sample(evsel, event_sw, &sample_sw);
532 sample_sw.period = sample->period;
533 sample_sw.time = sample->time;
534 perf_event__synthesize_sample(event_sw, evsel->core.attr.sample_type,
535 evsel->core.attr.read_format, &sample_sw);
536 build_id__mark_dso_hit(tool, event_sw, &sample_sw, evsel, machine);
537 return perf_event__repipe(tool, event_sw, &sample_sw, machine);
540 static void sig_handler(int sig __maybe_unused)
545 static int perf_evsel__check_stype(struct evsel *evsel,
546 u64 sample_type, const char *sample_msg)
548 struct perf_event_attr *attr = &evsel->core.attr;
549 const char *name = perf_evsel__name(evsel);
551 if (!(attr->sample_type & sample_type)) {
552 pr_err("Samples for %s event do not have %s attribute set.",
560 static int drop_sample(struct perf_tool *tool __maybe_unused,
561 union perf_event *event __maybe_unused,
562 struct perf_sample *sample __maybe_unused,
563 struct evsel *evsel __maybe_unused,
564 struct machine *machine __maybe_unused)
569 static void strip_init(struct perf_inject *inject)
571 struct evlist *evlist = inject->session->evlist;
574 inject->tool.context_switch = perf_event__drop;
576 evlist__for_each_entry(evlist, evsel)
577 evsel->handler = drop_sample;
580 static bool has_tracking(struct evsel *evsel)
582 return evsel->core.attr.mmap || evsel->core.attr.mmap2 || evsel->core.attr.comm ||
583 evsel->core.attr.task;
586 #define COMPAT_MASK (PERF_SAMPLE_ID | PERF_SAMPLE_TID | PERF_SAMPLE_TIME | \
587 PERF_SAMPLE_ID | PERF_SAMPLE_CPU | PERF_SAMPLE_IDENTIFIER)
590 * In order that the perf.data file is parsable, tracking events like MMAP need
591 * their selected event to exist, except if there is only 1 selected event left
592 * and it has a compatible sample type.
594 static bool ok_to_remove(struct evlist *evlist,
595 struct evsel *evsel_to_remove)
601 if (!has_tracking(evsel_to_remove))
604 evlist__for_each_entry(evlist, evsel) {
605 if (evsel->handler != drop_sample) {
607 if ((evsel->core.attr.sample_type & COMPAT_MASK) ==
608 (evsel_to_remove->core.attr.sample_type & COMPAT_MASK))
613 return ok && cnt == 1;
616 static void strip_fini(struct perf_inject *inject)
618 struct evlist *evlist = inject->session->evlist;
619 struct evsel *evsel, *tmp;
621 /* Remove non-synthesized evsels if possible */
622 evlist__for_each_entry_safe(evlist, tmp, evsel) {
623 if (evsel->handler == drop_sample &&
624 ok_to_remove(evlist, evsel)) {
625 pr_debug("Deleting %s\n", perf_evsel__name(evsel));
626 evlist__remove(evlist, evsel);
627 evsel__delete(evsel);
632 static int __cmd_inject(struct perf_inject *inject)
635 struct perf_session *session = inject->session;
636 struct perf_data *data_out = &inject->output;
637 int fd = perf_data__fd(data_out);
638 u64 output_data_offset;
640 signal(SIGINT, sig_handler);
642 if (inject->build_ids || inject->sched_stat ||
643 inject->itrace_synth_opts.set) {
644 inject->tool.mmap = perf_event__repipe_mmap;
645 inject->tool.mmap2 = perf_event__repipe_mmap2;
646 inject->tool.fork = perf_event__repipe_fork;
647 inject->tool.tracing_data = perf_event__repipe_tracing_data;
650 output_data_offset = session->header.data_offset;
652 if (inject->build_ids) {
653 inject->tool.sample = perf_event__inject_buildid;
654 } else if (inject->sched_stat) {
657 evlist__for_each_entry(session->evlist, evsel) {
658 const char *name = perf_evsel__name(evsel);
660 if (!strcmp(name, "sched:sched_switch")) {
661 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID"))
664 evsel->handler = perf_inject__sched_switch;
665 } else if (!strcmp(name, "sched:sched_process_exit"))
666 evsel->handler = perf_inject__sched_process_exit;
667 else if (!strncmp(name, "sched:sched_stat_", 17))
668 evsel->handler = perf_inject__sched_stat;
670 } else if (inject->itrace_synth_opts.set) {
671 session->itrace_synth_opts = &inject->itrace_synth_opts;
672 inject->itrace_synth_opts.inject = true;
673 inject->tool.comm = perf_event__repipe_comm;
674 inject->tool.namespaces = perf_event__repipe_namespaces;
675 inject->tool.exit = perf_event__repipe_exit;
676 inject->tool.id_index = perf_event__repipe_id_index;
677 inject->tool.auxtrace_info = perf_event__process_auxtrace_info;
678 inject->tool.auxtrace = perf_event__process_auxtrace;
679 inject->tool.aux = perf_event__drop_aux;
680 inject->tool.itrace_start = perf_event__drop_aux,
681 inject->tool.ordered_events = true;
682 inject->tool.ordering_requires_timestamps = true;
683 /* Allow space in the header for new attributes */
684 output_data_offset = 4096;
689 if (!inject->itrace_synth_opts.set)
690 auxtrace_index__free(&session->auxtrace_index);
692 if (!data_out->is_pipe)
693 lseek(fd, output_data_offset, SEEK_SET);
695 ret = perf_session__process_events(session);
699 if (!data_out->is_pipe) {
700 if (inject->build_ids)
701 perf_header__set_feat(&session->header,
704 * Keep all buildids when there is unprocessed AUX data because
705 * it is not known which ones the AUX trace hits.
707 if (perf_header__has_feat(&session->header, HEADER_BUILD_ID) &&
708 inject->have_auxtrace && !inject->itrace_synth_opts.set)
709 dsos__hit_all(session);
711 * The AUX areas have been removed and replaced with
712 * synthesized hardware events, so clear the feature flag and
715 if (inject->itrace_synth_opts.set) {
718 perf_header__clear_feat(&session->header,
720 if (inject->itrace_synth_opts.last_branch)
721 perf_header__set_feat(&session->header,
722 HEADER_BRANCH_STACK);
723 evsel = perf_evlist__id2evsel_strict(session->evlist,
726 pr_debug("Deleting %s\n",
727 perf_evsel__name(evsel));
728 evlist__remove(session->evlist, evsel);
729 evsel__delete(evsel);
734 session->header.data_offset = output_data_offset;
735 session->header.data_size = inject->bytes_written;
736 perf_session__write_header(session, session->evlist, fd, true);
742 int cmd_inject(int argc, const char **argv)
744 struct perf_inject inject = {
746 .sample = perf_event__repipe_sample,
747 .mmap = perf_event__repipe,
748 .mmap2 = perf_event__repipe,
749 .comm = perf_event__repipe,
750 .fork = perf_event__repipe,
751 .exit = perf_event__repipe,
752 .lost = perf_event__repipe,
753 .lost_samples = perf_event__repipe,
754 .aux = perf_event__repipe,
755 .itrace_start = perf_event__repipe,
756 .context_switch = perf_event__repipe,
757 .read = perf_event__repipe_sample,
758 .throttle = perf_event__repipe,
759 .unthrottle = perf_event__repipe,
760 .attr = perf_event__repipe_attr,
761 .tracing_data = perf_event__repipe_op2_synth,
762 .auxtrace_info = perf_event__repipe_op2_synth,
763 .auxtrace = perf_event__repipe_auxtrace,
764 .auxtrace_error = perf_event__repipe_op2_synth,
765 .time_conv = perf_event__repipe_op2_synth,
766 .finished_round = perf_event__repipe_oe_synth,
767 .build_id = perf_event__repipe_op2_synth,
768 .id_index = perf_event__repipe_op2_synth,
769 .feature = perf_event__repipe_op2_synth,
772 .samples = LIST_HEAD_INIT(inject.samples),
775 .mode = PERF_DATA_MODE_WRITE,
778 struct perf_data data = {
779 .mode = PERF_DATA_MODE_READ,
783 struct option options[] = {
784 OPT_BOOLEAN('b', "build-ids", &inject.build_ids,
785 "Inject build-ids into the output stream"),
786 OPT_STRING('i', "input", &inject.input_name, "file",
788 OPT_STRING('o', "output", &inject.output.path, "file",
790 OPT_BOOLEAN('s', "sched-stat", &inject.sched_stat,
791 "Merge sched-stat and sched-switch for getting events "
792 "where and how long tasks slept"),
794 OPT_BOOLEAN('j', "jit", &inject.jit_mode, "merge jitdump files into perf.data file"),
796 OPT_INCR('v', "verbose", &verbose,
797 "be more verbose (show build ids, etc)"),
798 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, "file",
799 "kallsyms pathname"),
800 OPT_BOOLEAN('f', "force", &data.force, "don't complain, do it"),
801 OPT_CALLBACK_OPTARG(0, "itrace", &inject.itrace_synth_opts,
802 NULL, "opts", "Instruction Tracing options\n"
804 itrace_parse_synth_opts),
805 OPT_BOOLEAN(0, "strip", &inject.strip,
806 "strip non-synthesized events (use with --itrace)"),
809 const char * const inject_usage[] = {
810 "perf inject [<options>]",
814 set_option_nobuild(options, 'j', "jit", "NO_LIBELF=1", true);
816 argc = parse_options(argc, argv, options, inject_usage, 0);
819 * Any (unrecognized) arguments left?
822 usage_with_options(inject_usage, options);
824 if (inject.strip && !inject.itrace_synth_opts.set) {
825 pr_err("--strip option requires --itrace option\n");
829 if (perf_data__open(&inject.output)) {
830 perror("failed to create output file");
834 inject.tool.ordered_events = inject.sched_stat;
836 data.path = inject.input_name;
837 inject.session = perf_session__new(&data, true, &inject.tool);
838 if (inject.session == NULL)
841 if (zstd_init(&(inject.session->zstd_data), 0) < 0)
842 pr_warning("Decompression initialization failed.\n");
844 if (inject.build_ids) {
846 * to make sure the mmap records are ordered correctly
847 * and so that the correct especially due to jitted code
848 * mmaps. We cannot generate the buildid hit list and
849 * inject the jit mmaps at the same time for now.
851 inject.tool.ordered_events = true;
852 inject.tool.ordering_requires_timestamps = true;
855 if (inject.jit_mode) {
856 inject.tool.mmap2 = perf_event__jit_repipe_mmap2;
857 inject.tool.mmap = perf_event__jit_repipe_mmap;
858 inject.tool.ordered_events = true;
859 inject.tool.ordering_requires_timestamps = true;
861 * JIT MMAP injection injects all MMAP events in one go, so it
862 * does not obey finished_round semantics.
864 inject.tool.finished_round = perf_event__drop_oe;
867 ret = symbol__init(&inject.session->header.env);
871 ret = __cmd_inject(&inject);
874 zstd_fini(&(inject.session->zstd_data));
875 perf_session__delete(inject.session);