4 * Builtin inject command: Examine the live mode (stdin) event stream
5 * and repipe it to stdout while optionally injecting additional
11 #include "util/color.h"
12 #include "util/evlist.h"
13 #include "util/evsel.h"
14 #include "util/session.h"
15 #include "util/tool.h"
16 #include "util/debug.h"
17 #include "util/build-id.h"
18 #include "util/data.h"
19 #include "util/auxtrace.h"
22 #include <subcmd/parse-options.h>
24 #include <linux/list.h>
27 struct perf_tool tool;
28 struct perf_session *session;
34 const char *input_name;
35 struct perf_data_file output;
38 struct list_head samples;
39 struct itrace_synth_opts itrace_synth_opts;
43 struct list_head node;
45 union perf_event event[0];
48 static int output_bytes(struct perf_inject *inject, void *buf, size_t sz)
52 size = perf_data_file__write(&inject->output, buf, sz);
56 inject->bytes_written += size;
60 static int perf_event__repipe_synth(struct perf_tool *tool,
61 union perf_event *event)
63 struct perf_inject *inject = container_of(tool, struct perf_inject,
66 return output_bytes(inject, event, event->header.size);
69 static int perf_event__repipe_oe_synth(struct perf_tool *tool,
70 union perf_event *event,
71 struct ordered_events *oe __maybe_unused)
73 return perf_event__repipe_synth(tool, event);
77 static int perf_event__drop_oe(struct perf_tool *tool __maybe_unused,
78 union perf_event *event __maybe_unused,
79 struct ordered_events *oe __maybe_unused)
85 static int perf_event__repipe_op2_synth(struct perf_tool *tool,
86 union perf_event *event,
87 struct perf_session *session
90 return perf_event__repipe_synth(tool, event);
93 static int perf_event__repipe_attr(struct perf_tool *tool,
94 union perf_event *event,
95 struct perf_evlist **pevlist)
97 struct perf_inject *inject = container_of(tool, struct perf_inject,
101 ret = perf_event__process_attr(tool, event, pevlist);
105 if (!inject->output.is_pipe)
108 return perf_event__repipe_synth(tool, event);
111 #ifdef HAVE_AUXTRACE_SUPPORT
113 static int copy_bytes(struct perf_inject *inject, int fd, off_t size)
120 ssz = read(fd, buf, min(size, (off_t)sizeof(buf)));
123 ret = output_bytes(inject, buf, ssz);
132 static s64 perf_event__repipe_auxtrace(struct perf_tool *tool,
133 union perf_event *event,
134 struct perf_session *session)
136 struct perf_inject *inject = container_of(tool, struct perf_inject,
140 inject->have_auxtrace = true;
142 if (!inject->output.is_pipe) {
145 offset = lseek(inject->output.fd, 0, SEEK_CUR);
148 ret = auxtrace_index__auxtrace_event(&session->auxtrace_index,
154 if (perf_data_file__is_pipe(session->file) || !session->one_mmap) {
155 ret = output_bytes(inject, event, event->header.size);
158 ret = copy_bytes(inject, perf_data_file__fd(session->file),
159 event->auxtrace.size);
161 ret = output_bytes(inject, event,
162 event->header.size + event->auxtrace.size);
167 return event->auxtrace.size;
173 perf_event__repipe_auxtrace(struct perf_tool *tool __maybe_unused,
174 union perf_event *event __maybe_unused,
175 struct perf_session *session __maybe_unused)
177 pr_err("AUX area tracing not supported\n");
183 static int perf_event__repipe(struct perf_tool *tool,
184 union perf_event *event,
185 struct perf_sample *sample __maybe_unused,
186 struct machine *machine __maybe_unused)
188 return perf_event__repipe_synth(tool, event);
191 static int perf_event__drop(struct perf_tool *tool __maybe_unused,
192 union perf_event *event __maybe_unused,
193 struct perf_sample *sample __maybe_unused,
194 struct machine *machine __maybe_unused)
199 static int perf_event__drop_aux(struct perf_tool *tool,
200 union perf_event *event __maybe_unused,
201 struct perf_sample *sample,
202 struct machine *machine __maybe_unused)
204 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
207 inject->aux_id = sample->id;
212 typedef int (*inject_handler)(struct perf_tool *tool,
213 union perf_event *event,
214 struct perf_sample *sample,
215 struct perf_evsel *evsel,
216 struct machine *machine);
218 static int perf_event__repipe_sample(struct perf_tool *tool,
219 union perf_event *event,
220 struct perf_sample *sample,
221 struct perf_evsel *evsel,
222 struct machine *machine)
224 if (evsel->handler) {
225 inject_handler f = evsel->handler;
226 return f(tool, event, sample, evsel, machine);
229 build_id__mark_dso_hit(tool, event, sample, evsel, machine);
231 return perf_event__repipe_synth(tool, event);
234 static int perf_event__repipe_mmap(struct perf_tool *tool,
235 union perf_event *event,
236 struct perf_sample *sample,
237 struct machine *machine)
241 err = perf_event__process_mmap(tool, event, sample, machine);
242 perf_event__repipe(tool, event, sample, machine);
248 static int perf_event__jit_repipe_mmap(struct perf_tool *tool,
249 union perf_event *event,
250 struct perf_sample *sample,
251 struct machine *machine)
253 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
258 * if jit marker, then inject jit mmaps and generate ELF images
260 ret = jit_process(inject->session, &inject->output, machine,
261 event->mmap.filename, sample->pid, &n);
265 inject->bytes_written += n;
268 return perf_event__repipe_mmap(tool, event, sample, machine);
272 static int perf_event__repipe_mmap2(struct perf_tool *tool,
273 union perf_event *event,
274 struct perf_sample *sample,
275 struct machine *machine)
279 err = perf_event__process_mmap2(tool, event, sample, machine);
280 perf_event__repipe(tool, event, sample, machine);
286 static int perf_event__jit_repipe_mmap2(struct perf_tool *tool,
287 union perf_event *event,
288 struct perf_sample *sample,
289 struct machine *machine)
291 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
296 * if jit marker, then inject jit mmaps and generate ELF images
298 ret = jit_process(inject->session, &inject->output, machine,
299 event->mmap2.filename, sample->pid, &n);
303 inject->bytes_written += n;
306 return perf_event__repipe_mmap2(tool, event, sample, machine);
310 static int perf_event__repipe_fork(struct perf_tool *tool,
311 union perf_event *event,
312 struct perf_sample *sample,
313 struct machine *machine)
317 err = perf_event__process_fork(tool, event, sample, machine);
318 perf_event__repipe(tool, event, sample, machine);
323 static int perf_event__repipe_comm(struct perf_tool *tool,
324 union perf_event *event,
325 struct perf_sample *sample,
326 struct machine *machine)
330 err = perf_event__process_comm(tool, event, sample, machine);
331 perf_event__repipe(tool, event, sample, machine);
336 static int perf_event__repipe_namespaces(struct perf_tool *tool,
337 union perf_event *event,
338 struct perf_sample *sample,
339 struct machine *machine)
341 int err = perf_event__process_namespaces(tool, event, sample, machine);
343 perf_event__repipe(tool, event, sample, machine);
348 static int perf_event__repipe_exit(struct perf_tool *tool,
349 union perf_event *event,
350 struct perf_sample *sample,
351 struct machine *machine)
355 err = perf_event__process_exit(tool, event, sample, machine);
356 perf_event__repipe(tool, event, sample, machine);
361 static int perf_event__repipe_tracing_data(struct perf_tool *tool,
362 union perf_event *event,
363 struct perf_session *session)
367 perf_event__repipe_synth(tool, event);
368 err = perf_event__process_tracing_data(tool, event, session);
373 static int perf_event__repipe_id_index(struct perf_tool *tool,
374 union perf_event *event,
375 struct perf_session *session)
379 perf_event__repipe_synth(tool, event);
380 err = perf_event__process_id_index(tool, event, session);
385 static int dso__read_build_id(struct dso *dso)
387 if (dso->has_build_id)
390 if (filename__read_build_id(dso->long_name, dso->build_id,
391 sizeof(dso->build_id)) > 0) {
392 dso->has_build_id = true;
399 static int dso__inject_build_id(struct dso *dso, struct perf_tool *tool,
400 struct machine *machine)
402 u16 misc = PERF_RECORD_MISC_USER;
405 if (dso__read_build_id(dso) < 0) {
406 pr_debug("no build_id found for %s\n", dso->long_name);
411 misc = PERF_RECORD_MISC_KERNEL;
413 err = perf_event__synthesize_build_id(tool, dso, misc, perf_event__repipe,
416 pr_err("Can't synthesize build_id event for %s\n", dso->long_name);
423 static int perf_event__inject_buildid(struct perf_tool *tool,
424 union perf_event *event,
425 struct perf_sample *sample,
426 struct perf_evsel *evsel __maybe_unused,
427 struct machine *machine)
429 struct addr_location al;
430 struct thread *thread;
432 thread = machine__findnew_thread(machine, sample->pid, sample->tid);
433 if (thread == NULL) {
434 pr_err("problem processing %d event, skipping it.\n",
439 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, sample->ip, &al);
441 if (al.map != NULL) {
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 perf_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,
489 struct perf_evsel *evsel,
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,
513 struct perf_evsel *evsel,
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->attr.sample_type,
535 evsel->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 perf_evsel *evsel,
547 u64 sample_type, const char *sample_msg)
549 struct perf_event_attr *attr = &evsel->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 perf_evsel *evsel __maybe_unused,
565 struct machine *machine __maybe_unused)
570 static void strip_init(struct perf_inject *inject)
572 struct perf_evlist *evlist = inject->session->evlist;
573 struct perf_evsel *evsel;
575 inject->tool.context_switch = perf_event__drop;
577 evlist__for_each_entry(evlist, evsel)
578 evsel->handler = drop_sample;
581 static bool has_tracking(struct perf_evsel *evsel)
583 return evsel->attr.mmap || evsel->attr.mmap2 || evsel->attr.comm ||
587 #define COMPAT_MASK (PERF_SAMPLE_ID | PERF_SAMPLE_TID | PERF_SAMPLE_TIME | \
588 PERF_SAMPLE_ID | PERF_SAMPLE_CPU | PERF_SAMPLE_IDENTIFIER)
591 * In order that the perf.data file is parsable, tracking events like MMAP need
592 * their selected event to exist, except if there is only 1 selected event left
593 * and it has a compatible sample type.
595 static bool ok_to_remove(struct perf_evlist *evlist,
596 struct perf_evsel *evsel_to_remove)
598 struct perf_evsel *evsel;
602 if (!has_tracking(evsel_to_remove))
605 evlist__for_each_entry(evlist, evsel) {
606 if (evsel->handler != drop_sample) {
608 if ((evsel->attr.sample_type & COMPAT_MASK) ==
609 (evsel_to_remove->attr.sample_type & COMPAT_MASK))
614 return ok && cnt == 1;
617 static void strip_fini(struct perf_inject *inject)
619 struct perf_evlist *evlist = inject->session->evlist;
620 struct perf_evsel *evsel, *tmp;
622 /* Remove non-synthesized evsels if possible */
623 evlist__for_each_entry_safe(evlist, tmp, evsel) {
624 if (evsel->handler == drop_sample &&
625 ok_to_remove(evlist, evsel)) {
626 pr_debug("Deleting %s\n", perf_evsel__name(evsel));
627 perf_evlist__remove(evlist, evsel);
628 perf_evsel__delete(evsel);
633 static int __cmd_inject(struct perf_inject *inject)
636 struct perf_session *session = inject->session;
637 struct perf_data_file *file_out = &inject->output;
638 int fd = perf_data_file__fd(file_out);
639 u64 output_data_offset;
641 signal(SIGINT, sig_handler);
643 if (inject->build_ids || inject->sched_stat ||
644 inject->itrace_synth_opts.set) {
645 inject->tool.mmap = perf_event__repipe_mmap;
646 inject->tool.mmap2 = perf_event__repipe_mmap2;
647 inject->tool.fork = perf_event__repipe_fork;
648 inject->tool.tracing_data = perf_event__repipe_tracing_data;
651 output_data_offset = session->header.data_offset;
653 if (inject->build_ids) {
654 inject->tool.sample = perf_event__inject_buildid;
655 } else if (inject->sched_stat) {
656 struct perf_evsel *evsel;
658 evlist__for_each_entry(session->evlist, evsel) {
659 const char *name = perf_evsel__name(evsel);
661 if (!strcmp(name, "sched:sched_switch")) {
662 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID"))
665 evsel->handler = perf_inject__sched_switch;
666 } else if (!strcmp(name, "sched:sched_process_exit"))
667 evsel->handler = perf_inject__sched_process_exit;
668 else if (!strncmp(name, "sched:sched_stat_", 17))
669 evsel->handler = perf_inject__sched_stat;
671 } else if (inject->itrace_synth_opts.set) {
672 session->itrace_synth_opts = &inject->itrace_synth_opts;
673 inject->itrace_synth_opts.inject = true;
674 inject->tool.comm = perf_event__repipe_comm;
675 inject->tool.namespaces = perf_event__repipe_namespaces;
676 inject->tool.exit = perf_event__repipe_exit;
677 inject->tool.id_index = perf_event__repipe_id_index;
678 inject->tool.auxtrace_info = perf_event__process_auxtrace_info;
679 inject->tool.auxtrace = perf_event__process_auxtrace;
680 inject->tool.aux = perf_event__drop_aux;
681 inject->tool.itrace_start = perf_event__drop_aux,
682 inject->tool.ordered_events = true;
683 inject->tool.ordering_requires_timestamps = true;
684 /* Allow space in the header for new attributes */
685 output_data_offset = 4096;
690 if (!inject->itrace_synth_opts.set)
691 auxtrace_index__free(&session->auxtrace_index);
693 if (!file_out->is_pipe)
694 lseek(fd, output_data_offset, SEEK_SET);
696 ret = perf_session__process_events(session);
698 if (!file_out->is_pipe) {
699 if (inject->build_ids)
700 perf_header__set_feat(&session->header,
703 * Keep all buildids when there is unprocessed AUX data because
704 * it is not known which ones the AUX trace hits.
706 if (perf_header__has_feat(&session->header, HEADER_BUILD_ID) &&
707 inject->have_auxtrace && !inject->itrace_synth_opts.set)
708 dsos__hit_all(session);
710 * The AUX areas have been removed and replaced with
711 * synthesized hardware events, so clear the feature flag and
714 if (inject->itrace_synth_opts.set) {
715 struct perf_evsel *evsel;
717 perf_header__clear_feat(&session->header,
719 if (inject->itrace_synth_opts.last_branch)
720 perf_header__set_feat(&session->header,
721 HEADER_BRANCH_STACK);
722 evsel = perf_evlist__id2evsel_strict(session->evlist,
725 pr_debug("Deleting %s\n",
726 perf_evsel__name(evsel));
727 perf_evlist__remove(session->evlist, evsel);
728 perf_evsel__delete(evsel);
733 session->header.data_offset = output_data_offset;
734 session->header.data_size = inject->bytes_written;
735 perf_session__write_header(session, session->evlist, fd, true);
741 int cmd_inject(int argc, const char **argv, const char *prefix __maybe_unused)
743 struct perf_inject inject = {
745 .sample = perf_event__repipe_sample,
746 .mmap = perf_event__repipe,
747 .mmap2 = perf_event__repipe,
748 .comm = perf_event__repipe,
749 .fork = perf_event__repipe,
750 .exit = perf_event__repipe,
751 .lost = perf_event__repipe,
752 .lost_samples = perf_event__repipe,
753 .aux = perf_event__repipe,
754 .itrace_start = perf_event__repipe,
755 .context_switch = perf_event__repipe,
756 .read = perf_event__repipe_sample,
757 .throttle = perf_event__repipe,
758 .unthrottle = perf_event__repipe,
759 .attr = perf_event__repipe_attr,
760 .tracing_data = perf_event__repipe_op2_synth,
761 .auxtrace_info = perf_event__repipe_op2_synth,
762 .auxtrace = perf_event__repipe_auxtrace,
763 .auxtrace_error = perf_event__repipe_op2_synth,
764 .time_conv = perf_event__repipe_op2_synth,
765 .finished_round = perf_event__repipe_oe_synth,
766 .build_id = perf_event__repipe_op2_synth,
767 .id_index = perf_event__repipe_op2_synth,
770 .samples = LIST_HEAD_INIT(inject.samples),
773 .mode = PERF_DATA_MODE_WRITE,
776 struct perf_data_file file = {
777 .mode = PERF_DATA_MODE_READ,
781 struct option options[] = {
782 OPT_BOOLEAN('b', "build-ids", &inject.build_ids,
783 "Inject build-ids into the output stream"),
784 OPT_STRING('i', "input", &inject.input_name, "file",
786 OPT_STRING('o', "output", &inject.output.path, "file",
788 OPT_BOOLEAN('s', "sched-stat", &inject.sched_stat,
789 "Merge sched-stat and sched-switch for getting events "
790 "where and how long tasks slept"),
792 OPT_BOOLEAN('j', "jit", &inject.jit_mode, "merge jitdump files into perf.data file"),
794 OPT_INCR('v', "verbose", &verbose,
795 "be more verbose (show build ids, etc)"),
796 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, "file",
797 "kallsyms pathname"),
798 OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
799 OPT_CALLBACK_OPTARG(0, "itrace", &inject.itrace_synth_opts,
800 NULL, "opts", "Instruction Tracing options",
801 itrace_parse_synth_opts),
802 OPT_BOOLEAN(0, "strip", &inject.strip,
803 "strip non-synthesized events (use with --itrace)"),
806 const char * const inject_usage[] = {
807 "perf inject [<options>]",
811 set_option_nobuild(options, 'j', "jit", "NO_LIBELF=1", true);
813 argc = parse_options(argc, argv, options, inject_usage, 0);
816 * Any (unrecognized) arguments left?
819 usage_with_options(inject_usage, options);
821 if (inject.strip && !inject.itrace_synth_opts.set) {
822 pr_err("--strip option requires --itrace option\n");
826 if (perf_data_file__open(&inject.output)) {
827 perror("failed to create output file");
831 inject.tool.ordered_events = inject.sched_stat;
833 file.path = inject.input_name;
834 inject.session = perf_session__new(&file, true, &inject.tool);
835 if (inject.session == NULL)
838 if (inject.build_ids) {
840 * to make sure the mmap records are ordered correctly
841 * and so that the correct especially due to jitted code
842 * mmaps. We cannot generate the buildid hit list and
843 * inject the jit mmaps at the same time for now.
845 inject.tool.ordered_events = true;
846 inject.tool.ordering_requires_timestamps = true;
849 if (inject.jit_mode) {
850 inject.tool.mmap2 = perf_event__jit_repipe_mmap2;
851 inject.tool.mmap = perf_event__jit_repipe_mmap;
852 inject.tool.ordered_events = true;
853 inject.tool.ordering_requires_timestamps = true;
855 * JIT MMAP injection injects all MMAP events in one go, so it
856 * does not obey finished_round semantics.
858 inject.tool.finished_round = perf_event__drop_oe;
861 ret = symbol__init(&inject.session->header.env);
865 ret = __cmd_inject(&inject);
868 perf_session__delete(inject.session);