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"
26 #include <linux/err.h>
28 #include <subcmd/parse-options.h>
30 #include <linux/list.h>
35 struct perf_tool tool;
36 struct perf_session *session;
42 const char *input_name;
43 struct perf_data output;
46 struct list_head samples;
47 struct itrace_synth_opts itrace_synth_opts;
51 struct list_head node;
53 union perf_event event[0];
56 static int output_bytes(struct perf_inject *inject, void *buf, size_t sz)
60 size = perf_data__write(&inject->output, buf, sz);
64 inject->bytes_written += size;
68 static int perf_event__repipe_synth(struct perf_tool *tool,
69 union perf_event *event)
71 struct perf_inject *inject = container_of(tool, struct perf_inject,
74 return output_bytes(inject, event, event->header.size);
77 static int perf_event__repipe_oe_synth(struct perf_tool *tool,
78 union perf_event *event,
79 struct ordered_events *oe __maybe_unused)
81 return perf_event__repipe_synth(tool, event);
85 static int perf_event__drop_oe(struct perf_tool *tool __maybe_unused,
86 union perf_event *event __maybe_unused,
87 struct ordered_events *oe __maybe_unused)
93 static int perf_event__repipe_op2_synth(struct perf_session *session,
94 union perf_event *event)
96 return perf_event__repipe_synth(session->tool, event);
99 static int perf_event__repipe_attr(struct perf_tool *tool,
100 union perf_event *event,
101 struct evlist **pevlist)
103 struct perf_inject *inject = container_of(tool, struct perf_inject,
107 ret = perf_event__process_attr(tool, event, pevlist);
111 if (!inject->output.is_pipe)
114 return perf_event__repipe_synth(tool, event);
117 #ifdef HAVE_AUXTRACE_SUPPORT
119 static int copy_bytes(struct perf_inject *inject, int fd, off_t size)
126 ssz = read(fd, buf, min(size, (off_t)sizeof(buf)));
129 ret = output_bytes(inject, buf, ssz);
138 static s64 perf_event__repipe_auxtrace(struct perf_session *session,
139 union perf_event *event)
141 struct perf_tool *tool = session->tool;
142 struct perf_inject *inject = container_of(tool, struct perf_inject,
146 inject->have_auxtrace = true;
148 if (!inject->output.is_pipe) {
151 offset = lseek(inject->output.file.fd, 0, SEEK_CUR);
154 ret = auxtrace_index__auxtrace_event(&session->auxtrace_index,
160 if (perf_data__is_pipe(session->data) || !session->one_mmap) {
161 ret = output_bytes(inject, event, event->header.size);
164 ret = copy_bytes(inject, perf_data__fd(session->data),
165 event->auxtrace.size);
167 ret = output_bytes(inject, event,
168 event->header.size + event->auxtrace.size);
173 return event->auxtrace.size;
179 perf_event__repipe_auxtrace(struct perf_session *session __maybe_unused,
180 union perf_event *event __maybe_unused)
182 pr_err("AUX area tracing not supported\n");
188 static int perf_event__repipe(struct perf_tool *tool,
189 union perf_event *event,
190 struct perf_sample *sample __maybe_unused,
191 struct machine *machine __maybe_unused)
193 return perf_event__repipe_synth(tool, event);
196 static int perf_event__drop(struct perf_tool *tool __maybe_unused,
197 union perf_event *event __maybe_unused,
198 struct perf_sample *sample __maybe_unused,
199 struct machine *machine __maybe_unused)
204 static int perf_event__drop_aux(struct perf_tool *tool,
205 union perf_event *event __maybe_unused,
206 struct perf_sample *sample,
207 struct machine *machine __maybe_unused)
209 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
212 inject->aux_id = sample->id;
217 typedef int (*inject_handler)(struct perf_tool *tool,
218 union perf_event *event,
219 struct perf_sample *sample,
221 struct machine *machine);
223 static int perf_event__repipe_sample(struct perf_tool *tool,
224 union perf_event *event,
225 struct perf_sample *sample,
227 struct machine *machine)
229 if (evsel && evsel->handler) {
230 inject_handler f = evsel->handler;
231 return f(tool, event, sample, evsel, machine);
234 build_id__mark_dso_hit(tool, event, sample, evsel, machine);
236 return perf_event__repipe_synth(tool, event);
239 static int perf_event__repipe_mmap(struct perf_tool *tool,
240 union perf_event *event,
241 struct perf_sample *sample,
242 struct machine *machine)
246 err = perf_event__process_mmap(tool, event, sample, machine);
247 perf_event__repipe(tool, event, sample, machine);
253 static int perf_event__jit_repipe_mmap(struct perf_tool *tool,
254 union perf_event *event,
255 struct perf_sample *sample,
256 struct machine *machine)
258 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
263 * if jit marker, then inject jit mmaps and generate ELF images
265 ret = jit_process(inject->session, &inject->output, machine,
266 event->mmap.filename, sample->pid, &n);
270 inject->bytes_written += n;
273 return perf_event__repipe_mmap(tool, event, sample, machine);
277 static int perf_event__repipe_mmap2(struct perf_tool *tool,
278 union perf_event *event,
279 struct perf_sample *sample,
280 struct machine *machine)
284 err = perf_event__process_mmap2(tool, event, sample, machine);
285 perf_event__repipe(tool, event, sample, machine);
291 static int perf_event__jit_repipe_mmap2(struct perf_tool *tool,
292 union perf_event *event,
293 struct perf_sample *sample,
294 struct machine *machine)
296 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
301 * if jit marker, then inject jit mmaps and generate ELF images
303 ret = jit_process(inject->session, &inject->output, machine,
304 event->mmap2.filename, sample->pid, &n);
308 inject->bytes_written += n;
311 return perf_event__repipe_mmap2(tool, event, sample, machine);
315 static int perf_event__repipe_fork(struct perf_tool *tool,
316 union perf_event *event,
317 struct perf_sample *sample,
318 struct machine *machine)
322 err = perf_event__process_fork(tool, event, sample, machine);
323 perf_event__repipe(tool, event, sample, machine);
328 static int perf_event__repipe_comm(struct perf_tool *tool,
329 union perf_event *event,
330 struct perf_sample *sample,
331 struct machine *machine)
335 err = perf_event__process_comm(tool, event, sample, machine);
336 perf_event__repipe(tool, event, sample, machine);
341 static int perf_event__repipe_namespaces(struct perf_tool *tool,
342 union perf_event *event,
343 struct perf_sample *sample,
344 struct machine *machine)
346 int err = perf_event__process_namespaces(tool, event, sample, machine);
348 perf_event__repipe(tool, event, sample, machine);
353 static int perf_event__repipe_exit(struct perf_tool *tool,
354 union perf_event *event,
355 struct perf_sample *sample,
356 struct machine *machine)
360 err = perf_event__process_exit(tool, event, sample, machine);
361 perf_event__repipe(tool, event, sample, machine);
366 static int perf_event__repipe_tracing_data(struct perf_session *session,
367 union perf_event *event)
371 perf_event__repipe_synth(session->tool, event);
372 err = perf_event__process_tracing_data(session, event);
377 static int perf_event__repipe_id_index(struct perf_session *session,
378 union perf_event *event)
382 perf_event__repipe_synth(session->tool, event);
383 err = perf_event__process_id_index(session, event);
388 static int dso__read_build_id(struct dso *dso)
390 if (dso->has_build_id)
393 if (filename__read_build_id(dso->long_name, dso->build_id,
394 sizeof(dso->build_id)) > 0) {
395 dso->has_build_id = true;
402 static int dso__inject_build_id(struct dso *dso, struct perf_tool *tool,
403 struct machine *machine)
405 u16 misc = PERF_RECORD_MISC_USER;
408 if (dso__read_build_id(dso) < 0) {
409 pr_debug("no build_id found for %s\n", dso->long_name);
414 misc = PERF_RECORD_MISC_KERNEL;
416 err = perf_event__synthesize_build_id(tool, dso, misc, perf_event__repipe,
419 pr_err("Can't synthesize build_id event for %s\n", dso->long_name);
426 static int perf_event__inject_buildid(struct perf_tool *tool,
427 union perf_event *event,
428 struct perf_sample *sample,
429 struct evsel *evsel __maybe_unused,
430 struct machine *machine)
432 struct addr_location al;
433 struct thread *thread;
435 thread = machine__findnew_thread(machine, sample->pid, sample->tid);
436 if (thread == NULL) {
437 pr_err("problem processing %d event, skipping it.\n",
442 if (thread__find_map(thread, sample->cpumode, sample->ip, &al)) {
443 if (!al.map->dso->hit) {
444 al.map->dso->hit = 1;
445 if (map__load(al.map) >= 0) {
446 dso__inject_build_id(al.map->dso, tool, machine);
448 * If this fails, too bad, let the other side
449 * account this as unresolved.
452 #ifdef HAVE_LIBELF_SUPPORT
453 pr_warning("no symbols found in %s, maybe "
454 "install a debug package?\n",
455 al.map->dso->long_name);
463 perf_event__repipe(tool, event, sample, machine);
467 static int perf_inject__sched_process_exit(struct perf_tool *tool,
468 union perf_event *event __maybe_unused,
469 struct perf_sample *sample,
470 struct evsel *evsel __maybe_unused,
471 struct machine *machine __maybe_unused)
473 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
474 struct event_entry *ent;
476 list_for_each_entry(ent, &inject->samples, node) {
477 if (sample->tid == ent->tid) {
478 list_del_init(&ent->node);
487 static int perf_inject__sched_switch(struct perf_tool *tool,
488 union perf_event *event,
489 struct perf_sample *sample,
491 struct machine *machine)
493 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
494 struct event_entry *ent;
496 perf_inject__sched_process_exit(tool, event, sample, evsel, machine);
498 ent = malloc(event->header.size + sizeof(struct event_entry));
500 color_fprintf(stderr, PERF_COLOR_RED,
501 "Not enough memory to process sched switch event!");
505 ent->tid = sample->tid;
506 memcpy(&ent->event, event, event->header.size);
507 list_add(&ent->node, &inject->samples);
511 static int perf_inject__sched_stat(struct perf_tool *tool,
512 union perf_event *event __maybe_unused,
513 struct perf_sample *sample,
515 struct machine *machine)
517 struct event_entry *ent;
518 union perf_event *event_sw;
519 struct perf_sample sample_sw;
520 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
521 u32 pid = perf_evsel__intval(evsel, sample, "pid");
523 list_for_each_entry(ent, &inject->samples, node) {
530 event_sw = &ent->event[0];
531 perf_evsel__parse_sample(evsel, event_sw, &sample_sw);
533 sample_sw.period = sample->period;
534 sample_sw.time = sample->time;
535 perf_event__synthesize_sample(event_sw, evsel->core.attr.sample_type,
536 evsel->core.attr.read_format, &sample_sw);
537 build_id__mark_dso_hit(tool, event_sw, &sample_sw, evsel, machine);
538 return perf_event__repipe(tool, event_sw, &sample_sw, machine);
541 static void sig_handler(int sig __maybe_unused)
546 static int perf_evsel__check_stype(struct evsel *evsel,
547 u64 sample_type, const char *sample_msg)
549 struct perf_event_attr *attr = &evsel->core.attr;
550 const char *name = perf_evsel__name(evsel);
552 if (!(attr->sample_type & sample_type)) {
553 pr_err("Samples for %s event do not have %s attribute set.",
561 static int drop_sample(struct perf_tool *tool __maybe_unused,
562 union perf_event *event __maybe_unused,
563 struct perf_sample *sample __maybe_unused,
564 struct evsel *evsel __maybe_unused,
565 struct machine *machine __maybe_unused)
570 static void strip_init(struct perf_inject *inject)
572 struct evlist *evlist = inject->session->evlist;
575 inject->tool.context_switch = perf_event__drop;
577 evlist__for_each_entry(evlist, evsel)
578 evsel->handler = drop_sample;
581 static int __cmd_inject(struct perf_inject *inject)
584 struct perf_session *session = inject->session;
585 struct perf_data *data_out = &inject->output;
586 int fd = perf_data__fd(data_out);
587 u64 output_data_offset;
589 signal(SIGINT, sig_handler);
591 if (inject->build_ids || inject->sched_stat ||
592 inject->itrace_synth_opts.set) {
593 inject->tool.mmap = perf_event__repipe_mmap;
594 inject->tool.mmap2 = perf_event__repipe_mmap2;
595 inject->tool.fork = perf_event__repipe_fork;
596 inject->tool.tracing_data = perf_event__repipe_tracing_data;
599 output_data_offset = session->header.data_offset;
601 if (inject->build_ids) {
602 inject->tool.sample = perf_event__inject_buildid;
603 } else if (inject->sched_stat) {
606 evlist__for_each_entry(session->evlist, evsel) {
607 const char *name = perf_evsel__name(evsel);
609 if (!strcmp(name, "sched:sched_switch")) {
610 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID"))
613 evsel->handler = perf_inject__sched_switch;
614 } else if (!strcmp(name, "sched:sched_process_exit"))
615 evsel->handler = perf_inject__sched_process_exit;
616 else if (!strncmp(name, "sched:sched_stat_", 17))
617 evsel->handler = perf_inject__sched_stat;
619 } else if (inject->itrace_synth_opts.set) {
620 session->itrace_synth_opts = &inject->itrace_synth_opts;
621 inject->itrace_synth_opts.inject = true;
622 inject->tool.comm = perf_event__repipe_comm;
623 inject->tool.namespaces = perf_event__repipe_namespaces;
624 inject->tool.exit = perf_event__repipe_exit;
625 inject->tool.id_index = perf_event__repipe_id_index;
626 inject->tool.auxtrace_info = perf_event__process_auxtrace_info;
627 inject->tool.auxtrace = perf_event__process_auxtrace;
628 inject->tool.aux = perf_event__drop_aux;
629 inject->tool.itrace_start = perf_event__drop_aux,
630 inject->tool.ordered_events = true;
631 inject->tool.ordering_requires_timestamps = true;
632 /* Allow space in the header for new attributes */
633 output_data_offset = 4096;
638 if (!inject->itrace_synth_opts.set)
639 auxtrace_index__free(&session->auxtrace_index);
641 if (!data_out->is_pipe)
642 lseek(fd, output_data_offset, SEEK_SET);
644 ret = perf_session__process_events(session);
648 if (!data_out->is_pipe) {
649 if (inject->build_ids)
650 perf_header__set_feat(&session->header,
653 * Keep all buildids when there is unprocessed AUX data because
654 * it is not known which ones the AUX trace hits.
656 if (perf_header__has_feat(&session->header, HEADER_BUILD_ID) &&
657 inject->have_auxtrace && !inject->itrace_synth_opts.set)
658 dsos__hit_all(session);
660 * The AUX areas have been removed and replaced with
661 * synthesized hardware events, so clear the feature flag and
664 if (inject->itrace_synth_opts.set) {
667 perf_header__clear_feat(&session->header,
669 if (inject->itrace_synth_opts.last_branch)
670 perf_header__set_feat(&session->header,
671 HEADER_BRANCH_STACK);
672 evsel = perf_evlist__id2evsel_strict(session->evlist,
675 pr_debug("Deleting %s\n",
676 perf_evsel__name(evsel));
677 evlist__remove(session->evlist, evsel);
678 evsel__delete(evsel);
681 session->header.data_offset = output_data_offset;
682 session->header.data_size = inject->bytes_written;
683 perf_session__write_header(session, session->evlist, fd, true);
689 int cmd_inject(int argc, const char **argv)
691 struct perf_inject inject = {
693 .sample = perf_event__repipe_sample,
694 .mmap = perf_event__repipe,
695 .mmap2 = perf_event__repipe,
696 .comm = perf_event__repipe,
697 .fork = perf_event__repipe,
698 .exit = perf_event__repipe,
699 .lost = perf_event__repipe,
700 .lost_samples = perf_event__repipe,
701 .aux = perf_event__repipe,
702 .itrace_start = perf_event__repipe,
703 .context_switch = perf_event__repipe,
704 .read = perf_event__repipe_sample,
705 .throttle = perf_event__repipe,
706 .unthrottle = perf_event__repipe,
707 .attr = perf_event__repipe_attr,
708 .tracing_data = perf_event__repipe_op2_synth,
709 .auxtrace_info = perf_event__repipe_op2_synth,
710 .auxtrace = perf_event__repipe_auxtrace,
711 .auxtrace_error = perf_event__repipe_op2_synth,
712 .time_conv = perf_event__repipe_op2_synth,
713 .finished_round = perf_event__repipe_oe_synth,
714 .build_id = perf_event__repipe_op2_synth,
715 .id_index = perf_event__repipe_op2_synth,
716 .feature = perf_event__repipe_op2_synth,
719 .samples = LIST_HEAD_INIT(inject.samples),
722 .mode = PERF_DATA_MODE_WRITE,
725 struct perf_data data = {
726 .mode = PERF_DATA_MODE_READ,
730 struct option options[] = {
731 OPT_BOOLEAN('b', "build-ids", &inject.build_ids,
732 "Inject build-ids into the output stream"),
733 OPT_STRING('i', "input", &inject.input_name, "file",
735 OPT_STRING('o', "output", &inject.output.path, "file",
737 OPT_BOOLEAN('s', "sched-stat", &inject.sched_stat,
738 "Merge sched-stat and sched-switch for getting events "
739 "where and how long tasks slept"),
741 OPT_BOOLEAN('j', "jit", &inject.jit_mode, "merge jitdump files into perf.data file"),
743 OPT_INCR('v', "verbose", &verbose,
744 "be more verbose (show build ids, etc)"),
745 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, "file",
746 "kallsyms pathname"),
747 OPT_BOOLEAN('f', "force", &data.force, "don't complain, do it"),
748 OPT_CALLBACK_OPTARG(0, "itrace", &inject.itrace_synth_opts,
749 NULL, "opts", "Instruction Tracing options\n"
751 itrace_parse_synth_opts),
752 OPT_BOOLEAN(0, "strip", &inject.strip,
753 "strip non-synthesized events (use with --itrace)"),
756 const char * const inject_usage[] = {
757 "perf inject [<options>]",
761 set_option_nobuild(options, 'j', "jit", "NO_LIBELF=1", true);
763 argc = parse_options(argc, argv, options, inject_usage, 0);
766 * Any (unrecognized) arguments left?
769 usage_with_options(inject_usage, options);
771 if (inject.strip && !inject.itrace_synth_opts.set) {
772 pr_err("--strip option requires --itrace option\n");
776 if (perf_data__open(&inject.output)) {
777 perror("failed to create output file");
781 inject.tool.ordered_events = inject.sched_stat;
783 data.path = inject.input_name;
784 inject.session = perf_session__new(&data, true, &inject.tool);
785 if (IS_ERR(inject.session))
786 return PTR_ERR(inject.session);
788 if (zstd_init(&(inject.session->zstd_data), 0) < 0)
789 pr_warning("Decompression initialization failed.\n");
791 if (inject.build_ids) {
793 * to make sure the mmap records are ordered correctly
794 * and so that the correct especially due to jitted code
795 * mmaps. We cannot generate the buildid hit list and
796 * inject the jit mmaps at the same time for now.
798 inject.tool.ordered_events = true;
799 inject.tool.ordering_requires_timestamps = true;
802 if (inject.jit_mode) {
803 inject.tool.mmap2 = perf_event__jit_repipe_mmap2;
804 inject.tool.mmap = perf_event__jit_repipe_mmap;
805 inject.tool.ordered_events = true;
806 inject.tool.ordering_requires_timestamps = true;
808 * JIT MMAP injection injects all MMAP events in one go, so it
809 * does not obey finished_round semantics.
811 inject.tool.finished_round = perf_event__drop_oe;
814 ret = symbol__init(&inject.session->header.env);
818 ret = __cmd_inject(&inject);
821 zstd_fini(&(inject.session->zstd_data));
822 perf_session__delete(inject.session);