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;
48 char event_copy[PERF_SAMPLE_MAX_SIZE];
52 struct list_head node;
54 union perf_event event[];
57 static int output_bytes(struct perf_inject *inject, void *buf, size_t sz)
61 size = perf_data__write(&inject->output, buf, sz);
65 inject->bytes_written += size;
69 static int perf_event__repipe_synth(struct perf_tool *tool,
70 union perf_event *event)
72 struct perf_inject *inject = container_of(tool, struct perf_inject,
75 return output_bytes(inject, event, event->header.size);
78 static int perf_event__repipe_oe_synth(struct perf_tool *tool,
79 union perf_event *event,
80 struct ordered_events *oe __maybe_unused)
82 return perf_event__repipe_synth(tool, event);
86 static int perf_event__drop_oe(struct perf_tool *tool __maybe_unused,
87 union perf_event *event __maybe_unused,
88 struct ordered_events *oe __maybe_unused)
94 static int perf_event__repipe_op2_synth(struct perf_session *session,
95 union perf_event *event)
97 return perf_event__repipe_synth(session->tool, event);
100 static int perf_event__repipe_attr(struct perf_tool *tool,
101 union perf_event *event,
102 struct evlist **pevlist)
104 struct perf_inject *inject = container_of(tool, struct perf_inject,
108 ret = perf_event__process_attr(tool, event, pevlist);
112 if (!inject->output.is_pipe)
115 return perf_event__repipe_synth(tool, event);
118 #ifdef HAVE_AUXTRACE_SUPPORT
120 static int copy_bytes(struct perf_inject *inject, int fd, off_t size)
127 ssz = read(fd, buf, min(size, (off_t)sizeof(buf)));
130 ret = output_bytes(inject, buf, ssz);
139 static s64 perf_event__repipe_auxtrace(struct perf_session *session,
140 union perf_event *event)
142 struct perf_tool *tool = session->tool;
143 struct perf_inject *inject = container_of(tool, struct perf_inject,
147 inject->have_auxtrace = true;
149 if (!inject->output.is_pipe) {
152 offset = lseek(inject->output.file.fd, 0, SEEK_CUR);
155 ret = auxtrace_index__auxtrace_event(&session->auxtrace_index,
161 if (perf_data__is_pipe(session->data) || !session->one_mmap) {
162 ret = output_bytes(inject, event, event->header.size);
165 ret = copy_bytes(inject, perf_data__fd(session->data),
166 event->auxtrace.size);
168 ret = output_bytes(inject, event,
169 event->header.size + event->auxtrace.size);
174 return event->auxtrace.size;
180 perf_event__repipe_auxtrace(struct perf_session *session __maybe_unused,
181 union perf_event *event __maybe_unused)
183 pr_err("AUX area tracing not supported\n");
189 static int perf_event__repipe(struct perf_tool *tool,
190 union perf_event *event,
191 struct perf_sample *sample __maybe_unused,
192 struct machine *machine __maybe_unused)
194 return perf_event__repipe_synth(tool, event);
197 static int perf_event__drop(struct perf_tool *tool __maybe_unused,
198 union perf_event *event __maybe_unused,
199 struct perf_sample *sample __maybe_unused,
200 struct machine *machine __maybe_unused)
205 static int perf_event__drop_aux(struct perf_tool *tool,
206 union perf_event *event __maybe_unused,
207 struct perf_sample *sample,
208 struct machine *machine __maybe_unused)
210 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
213 inject->aux_id = sample->id;
218 static union perf_event *
219 perf_inject__cut_auxtrace_sample(struct perf_inject *inject,
220 union perf_event *event,
221 struct perf_sample *sample)
223 size_t sz1 = sample->aux_sample.data - (void *)event;
224 size_t sz2 = event->header.size - sample->aux_sample.size - sz1;
225 union perf_event *ev = (union perf_event *)inject->event_copy;
227 if (sz1 > event->header.size || sz2 > event->header.size ||
228 sz1 + sz2 > event->header.size ||
229 sz1 < sizeof(struct perf_event_header) + sizeof(u64))
232 memcpy(ev, event, sz1);
233 memcpy((void *)ev + sz1, (void *)event + event->header.size - sz2, sz2);
234 ev->header.size = sz1 + sz2;
235 ((u64 *)((void *)ev + sz1))[-1] = 0;
240 typedef int (*inject_handler)(struct perf_tool *tool,
241 union perf_event *event,
242 struct perf_sample *sample,
244 struct machine *machine);
246 static int perf_event__repipe_sample(struct perf_tool *tool,
247 union perf_event *event,
248 struct perf_sample *sample,
250 struct machine *machine)
252 struct perf_inject *inject = container_of(tool, struct perf_inject,
255 if (evsel && evsel->handler) {
256 inject_handler f = evsel->handler;
257 return f(tool, event, sample, evsel, machine);
260 build_id__mark_dso_hit(tool, event, sample, evsel, machine);
262 if (inject->itrace_synth_opts.set && sample->aux_sample.size)
263 event = perf_inject__cut_auxtrace_sample(inject, event, sample);
265 return perf_event__repipe_synth(tool, event);
268 static int perf_event__repipe_mmap(struct perf_tool *tool,
269 union perf_event *event,
270 struct perf_sample *sample,
271 struct machine *machine)
275 err = perf_event__process_mmap(tool, event, sample, machine);
276 perf_event__repipe(tool, event, sample, machine);
282 static int perf_event__jit_repipe_mmap(struct perf_tool *tool,
283 union perf_event *event,
284 struct perf_sample *sample,
285 struct machine *machine)
287 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
292 * if jit marker, then inject jit mmaps and generate ELF images
294 ret = jit_process(inject->session, &inject->output, machine,
295 event->mmap.filename, event->mmap.pid, &n);
299 inject->bytes_written += n;
302 return perf_event__repipe_mmap(tool, event, sample, machine);
306 static int perf_event__repipe_mmap2(struct perf_tool *tool,
307 union perf_event *event,
308 struct perf_sample *sample,
309 struct machine *machine)
313 err = perf_event__process_mmap2(tool, event, sample, machine);
314 perf_event__repipe(tool, event, sample, machine);
320 static int perf_event__jit_repipe_mmap2(struct perf_tool *tool,
321 union perf_event *event,
322 struct perf_sample *sample,
323 struct machine *machine)
325 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
330 * if jit marker, then inject jit mmaps and generate ELF images
332 ret = jit_process(inject->session, &inject->output, machine,
333 event->mmap2.filename, event->mmap2.pid, &n);
337 inject->bytes_written += n;
340 return perf_event__repipe_mmap2(tool, event, sample, machine);
344 static int perf_event__repipe_fork(struct perf_tool *tool,
345 union perf_event *event,
346 struct perf_sample *sample,
347 struct machine *machine)
351 err = perf_event__process_fork(tool, event, sample, machine);
352 perf_event__repipe(tool, event, sample, machine);
357 static int perf_event__repipe_comm(struct perf_tool *tool,
358 union perf_event *event,
359 struct perf_sample *sample,
360 struct machine *machine)
364 err = perf_event__process_comm(tool, event, sample, machine);
365 perf_event__repipe(tool, event, sample, machine);
370 static int perf_event__repipe_namespaces(struct perf_tool *tool,
371 union perf_event *event,
372 struct perf_sample *sample,
373 struct machine *machine)
375 int err = perf_event__process_namespaces(tool, event, sample, machine);
377 perf_event__repipe(tool, event, sample, machine);
382 static int perf_event__repipe_exit(struct perf_tool *tool,
383 union perf_event *event,
384 struct perf_sample *sample,
385 struct machine *machine)
389 err = perf_event__process_exit(tool, event, sample, machine);
390 perf_event__repipe(tool, event, sample, machine);
395 static int perf_event__repipe_tracing_data(struct perf_session *session,
396 union perf_event *event)
400 perf_event__repipe_synth(session->tool, event);
401 err = perf_event__process_tracing_data(session, event);
406 static int dso__read_build_id(struct dso *dso)
408 if (dso->has_build_id)
411 if (filename__read_build_id(dso->long_name, dso->build_id,
412 sizeof(dso->build_id)) > 0) {
413 dso->has_build_id = true;
420 static int dso__inject_build_id(struct dso *dso, struct perf_tool *tool,
421 struct machine *machine)
423 u16 misc = PERF_RECORD_MISC_USER;
426 if (dso__read_build_id(dso) < 0) {
427 pr_debug("no build_id found for %s\n", dso->long_name);
432 misc = PERF_RECORD_MISC_KERNEL;
434 err = perf_event__synthesize_build_id(tool, dso, misc, perf_event__repipe,
437 pr_err("Can't synthesize build_id event for %s\n", dso->long_name);
444 static int perf_event__inject_buildid(struct perf_tool *tool,
445 union perf_event *event,
446 struct perf_sample *sample,
447 struct evsel *evsel __maybe_unused,
448 struct machine *machine)
450 struct addr_location al;
451 struct thread *thread;
453 thread = machine__findnew_thread(machine, sample->pid, sample->tid);
454 if (thread == NULL) {
455 pr_err("problem processing %d event, skipping it.\n",
460 if (thread__find_map(thread, sample->cpumode, sample->ip, &al)) {
461 if (!al.map->dso->hit) {
462 al.map->dso->hit = 1;
463 if (map__load(al.map) >= 0) {
464 dso__inject_build_id(al.map->dso, tool, machine);
466 * If this fails, too bad, let the other side
467 * account this as unresolved.
470 #ifdef HAVE_LIBELF_SUPPORT
471 pr_warning("no symbols found in %s, maybe "
472 "install a debug package?\n",
473 al.map->dso->long_name);
481 perf_event__repipe(tool, event, sample, machine);
485 static int perf_inject__sched_process_exit(struct perf_tool *tool,
486 union perf_event *event __maybe_unused,
487 struct perf_sample *sample,
488 struct evsel *evsel __maybe_unused,
489 struct machine *machine __maybe_unused)
491 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
492 struct event_entry *ent;
494 list_for_each_entry(ent, &inject->samples, node) {
495 if (sample->tid == ent->tid) {
496 list_del_init(&ent->node);
505 static int perf_inject__sched_switch(struct perf_tool *tool,
506 union perf_event *event,
507 struct perf_sample *sample,
509 struct machine *machine)
511 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
512 struct event_entry *ent;
514 perf_inject__sched_process_exit(tool, event, sample, evsel, machine);
516 ent = malloc(event->header.size + sizeof(struct event_entry));
518 color_fprintf(stderr, PERF_COLOR_RED,
519 "Not enough memory to process sched switch event!");
523 ent->tid = sample->tid;
524 memcpy(&ent->event, event, event->header.size);
525 list_add(&ent->node, &inject->samples);
529 static int perf_inject__sched_stat(struct perf_tool *tool,
530 union perf_event *event __maybe_unused,
531 struct perf_sample *sample,
533 struct machine *machine)
535 struct event_entry *ent;
536 union perf_event *event_sw;
537 struct perf_sample sample_sw;
538 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
539 u32 pid = evsel__intval(evsel, sample, "pid");
541 list_for_each_entry(ent, &inject->samples, node) {
548 event_sw = &ent->event[0];
549 evsel__parse_sample(evsel, event_sw, &sample_sw);
551 sample_sw.period = sample->period;
552 sample_sw.time = sample->time;
553 perf_event__synthesize_sample(event_sw, evsel->core.attr.sample_type,
554 evsel->core.attr.read_format, &sample_sw);
555 build_id__mark_dso_hit(tool, event_sw, &sample_sw, evsel, machine);
556 return perf_event__repipe(tool, event_sw, &sample_sw, machine);
559 static void sig_handler(int sig __maybe_unused)
564 static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg)
566 struct perf_event_attr *attr = &evsel->core.attr;
567 const char *name = evsel__name(evsel);
569 if (!(attr->sample_type & sample_type)) {
570 pr_err("Samples for %s event do not have %s attribute set.",
578 static int drop_sample(struct perf_tool *tool __maybe_unused,
579 union perf_event *event __maybe_unused,
580 struct perf_sample *sample __maybe_unused,
581 struct evsel *evsel __maybe_unused,
582 struct machine *machine __maybe_unused)
587 static void strip_init(struct perf_inject *inject)
589 struct evlist *evlist = inject->session->evlist;
592 inject->tool.context_switch = perf_event__drop;
594 evlist__for_each_entry(evlist, evsel)
595 evsel->handler = drop_sample;
598 static int __cmd_inject(struct perf_inject *inject)
601 struct perf_session *session = inject->session;
602 struct perf_data *data_out = &inject->output;
603 int fd = perf_data__fd(data_out);
604 u64 output_data_offset;
606 signal(SIGINT, sig_handler);
608 if (inject->build_ids || inject->sched_stat ||
609 inject->itrace_synth_opts.set) {
610 inject->tool.mmap = perf_event__repipe_mmap;
611 inject->tool.mmap2 = perf_event__repipe_mmap2;
612 inject->tool.fork = perf_event__repipe_fork;
613 inject->tool.tracing_data = perf_event__repipe_tracing_data;
616 output_data_offset = session->header.data_offset;
618 if (inject->build_ids) {
619 inject->tool.sample = perf_event__inject_buildid;
620 } else if (inject->sched_stat) {
623 evlist__for_each_entry(session->evlist, evsel) {
624 const char *name = evsel__name(evsel);
626 if (!strcmp(name, "sched:sched_switch")) {
627 if (evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID"))
630 evsel->handler = perf_inject__sched_switch;
631 } else if (!strcmp(name, "sched:sched_process_exit"))
632 evsel->handler = perf_inject__sched_process_exit;
633 else if (!strncmp(name, "sched:sched_stat_", 17))
634 evsel->handler = perf_inject__sched_stat;
636 } else if (inject->itrace_synth_opts.set) {
637 session->itrace_synth_opts = &inject->itrace_synth_opts;
638 inject->itrace_synth_opts.inject = true;
639 inject->tool.comm = perf_event__repipe_comm;
640 inject->tool.namespaces = perf_event__repipe_namespaces;
641 inject->tool.exit = perf_event__repipe_exit;
642 inject->tool.id_index = perf_event__process_id_index;
643 inject->tool.auxtrace_info = perf_event__process_auxtrace_info;
644 inject->tool.auxtrace = perf_event__process_auxtrace;
645 inject->tool.aux = perf_event__drop_aux;
646 inject->tool.itrace_start = perf_event__drop_aux,
647 inject->tool.ordered_events = true;
648 inject->tool.ordering_requires_timestamps = true;
649 /* Allow space in the header for new attributes */
650 output_data_offset = 4096;
655 if (!inject->itrace_synth_opts.set)
656 auxtrace_index__free(&session->auxtrace_index);
658 if (!data_out->is_pipe)
659 lseek(fd, output_data_offset, SEEK_SET);
661 ret = perf_session__process_events(session);
665 if (!data_out->is_pipe) {
666 if (inject->build_ids)
667 perf_header__set_feat(&session->header,
670 * Keep all buildids when there is unprocessed AUX data because
671 * it is not known which ones the AUX trace hits.
673 if (perf_header__has_feat(&session->header, HEADER_BUILD_ID) &&
674 inject->have_auxtrace && !inject->itrace_synth_opts.set)
675 dsos__hit_all(session);
677 * The AUX areas have been removed and replaced with
678 * synthesized hardware events, so clear the feature flag and
681 if (inject->itrace_synth_opts.set) {
684 perf_header__clear_feat(&session->header,
686 if (inject->itrace_synth_opts.last_branch ||
687 inject->itrace_synth_opts.add_last_branch)
688 perf_header__set_feat(&session->header,
689 HEADER_BRANCH_STACK);
690 evsel = perf_evlist__id2evsel_strict(session->evlist,
693 pr_debug("Deleting %s\n", evsel__name(evsel));
694 evlist__remove(session->evlist, evsel);
695 evsel__delete(evsel);
698 session->header.data_offset = output_data_offset;
699 session->header.data_size = inject->bytes_written;
700 perf_session__write_header(session, session->evlist, fd, true);
706 int cmd_inject(int argc, const char **argv)
708 struct perf_inject inject = {
710 .sample = perf_event__repipe_sample,
711 .mmap = perf_event__repipe,
712 .mmap2 = perf_event__repipe,
713 .comm = perf_event__repipe,
714 .fork = perf_event__repipe,
715 .exit = perf_event__repipe,
716 .lost = perf_event__repipe,
717 .lost_samples = perf_event__repipe,
718 .aux = perf_event__repipe,
719 .itrace_start = perf_event__repipe,
720 .context_switch = perf_event__repipe,
721 .read = perf_event__repipe_sample,
722 .throttle = perf_event__repipe,
723 .unthrottle = perf_event__repipe,
724 .attr = perf_event__repipe_attr,
725 .tracing_data = perf_event__repipe_op2_synth,
726 .auxtrace_info = perf_event__repipe_op2_synth,
727 .auxtrace = perf_event__repipe_auxtrace,
728 .auxtrace_error = perf_event__repipe_op2_synth,
729 .time_conv = perf_event__repipe_op2_synth,
730 .finished_round = perf_event__repipe_oe_synth,
731 .build_id = perf_event__repipe_op2_synth,
732 .id_index = perf_event__repipe_op2_synth,
733 .feature = perf_event__repipe_op2_synth,
736 .samples = LIST_HEAD_INIT(inject.samples),
739 .mode = PERF_DATA_MODE_WRITE,
742 struct perf_data data = {
743 .mode = PERF_DATA_MODE_READ,
747 struct option options[] = {
748 OPT_BOOLEAN('b', "build-ids", &inject.build_ids,
749 "Inject build-ids into the output stream"),
750 OPT_STRING('i', "input", &inject.input_name, "file",
752 OPT_STRING('o', "output", &inject.output.path, "file",
754 OPT_BOOLEAN('s', "sched-stat", &inject.sched_stat,
755 "Merge sched-stat and sched-switch for getting events "
756 "where and how long tasks slept"),
758 OPT_BOOLEAN('j', "jit", &inject.jit_mode, "merge jitdump files into perf.data file"),
760 OPT_INCR('v', "verbose", &verbose,
761 "be more verbose (show build ids, etc)"),
762 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, "file",
763 "kallsyms pathname"),
764 OPT_BOOLEAN('f', "force", &data.force, "don't complain, do it"),
765 OPT_CALLBACK_OPTARG(0, "itrace", &inject.itrace_synth_opts,
766 NULL, "opts", "Instruction Tracing options\n"
768 itrace_parse_synth_opts),
769 OPT_BOOLEAN(0, "strip", &inject.strip,
770 "strip non-synthesized events (use with --itrace)"),
773 const char * const inject_usage[] = {
774 "perf inject [<options>]",
778 set_option_nobuild(options, 'j', "jit", "NO_LIBELF=1", true);
780 argc = parse_options(argc, argv, options, inject_usage, 0);
783 * Any (unrecognized) arguments left?
786 usage_with_options(inject_usage, options);
788 if (inject.strip && !inject.itrace_synth_opts.set) {
789 pr_err("--strip option requires --itrace option\n");
793 if (perf_data__open(&inject.output)) {
794 perror("failed to create output file");
798 inject.tool.ordered_events = inject.sched_stat;
800 data.path = inject.input_name;
801 inject.session = perf_session__new(&data, true, &inject.tool);
802 if (IS_ERR(inject.session))
803 return PTR_ERR(inject.session);
805 if (zstd_init(&(inject.session->zstd_data), 0) < 0)
806 pr_warning("Decompression initialization failed.\n");
808 if (inject.build_ids) {
810 * to make sure the mmap records are ordered correctly
811 * and so that the correct especially due to jitted code
812 * mmaps. We cannot generate the buildid hit list and
813 * inject the jit mmaps at the same time for now.
815 inject.tool.ordered_events = true;
816 inject.tool.ordering_requires_timestamps = true;
819 if (inject.jit_mode) {
820 inject.tool.mmap2 = perf_event__jit_repipe_mmap2;
821 inject.tool.mmap = perf_event__jit_repipe_mmap;
822 inject.tool.ordered_events = true;
823 inject.tool.ordering_requires_timestamps = true;
825 * JIT MMAP injection injects all MMAP events in one go, so it
826 * does not obey finished_round semantics.
828 inject.tool.finished_round = perf_event__drop_oe;
831 ret = symbol__init(&inject.session->header.env);
835 ret = __cmd_inject(&inject);
838 zstd_fini(&(inject.session->zstd_data));
839 perf_session__delete(inject.session);