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"
21 #include "util/thread.h"
23 #include <subcmd/parse-options.h>
25 #include <linux/list.h>
30 struct perf_tool tool;
31 struct perf_session *session;
37 const char *input_name;
38 struct perf_data_file output;
41 struct list_head samples;
42 struct itrace_synth_opts itrace_synth_opts;
46 struct list_head node;
48 union perf_event event[0];
51 static int output_bytes(struct perf_inject *inject, void *buf, size_t sz)
55 size = perf_data_file__write(&inject->output, buf, sz);
59 inject->bytes_written += size;
63 static int perf_event__repipe_synth(struct perf_tool *tool,
64 union perf_event *event)
66 struct perf_inject *inject = container_of(tool, struct perf_inject,
69 return output_bytes(inject, event, event->header.size);
72 static int perf_event__repipe_oe_synth(struct perf_tool *tool,
73 union perf_event *event,
74 struct ordered_events *oe __maybe_unused)
76 return perf_event__repipe_synth(tool, event);
80 static int perf_event__drop_oe(struct perf_tool *tool __maybe_unused,
81 union perf_event *event __maybe_unused,
82 struct ordered_events *oe __maybe_unused)
88 static int perf_event__repipe_op2_synth(struct perf_tool *tool,
89 union perf_event *event,
90 struct perf_session *session
93 return perf_event__repipe_synth(tool, event);
96 static int perf_event__repipe_attr(struct perf_tool *tool,
97 union perf_event *event,
98 struct perf_evlist **pevlist)
100 struct perf_inject *inject = container_of(tool, struct perf_inject,
104 ret = perf_event__process_attr(tool, event, pevlist);
108 if (!inject->output.is_pipe)
111 return perf_event__repipe_synth(tool, event);
114 #ifdef HAVE_AUXTRACE_SUPPORT
116 static int copy_bytes(struct perf_inject *inject, int fd, off_t size)
123 ssz = read(fd, buf, min(size, (off_t)sizeof(buf)));
126 ret = output_bytes(inject, buf, ssz);
135 static s64 perf_event__repipe_auxtrace(struct perf_tool *tool,
136 union perf_event *event,
137 struct perf_session *session)
139 struct perf_inject *inject = container_of(tool, struct perf_inject,
143 inject->have_auxtrace = true;
145 if (!inject->output.is_pipe) {
148 offset = lseek(inject->output.fd, 0, SEEK_CUR);
151 ret = auxtrace_index__auxtrace_event(&session->auxtrace_index,
157 if (perf_data_file__is_pipe(session->file) || !session->one_mmap) {
158 ret = output_bytes(inject, event, event->header.size);
161 ret = copy_bytes(inject, perf_data_file__fd(session->file),
162 event->auxtrace.size);
164 ret = output_bytes(inject, event,
165 event->header.size + event->auxtrace.size);
170 return event->auxtrace.size;
176 perf_event__repipe_auxtrace(struct perf_tool *tool __maybe_unused,
177 union perf_event *event __maybe_unused,
178 struct perf_session *session __maybe_unused)
180 pr_err("AUX area tracing not supported\n");
186 static int perf_event__repipe(struct perf_tool *tool,
187 union perf_event *event,
188 struct perf_sample *sample __maybe_unused,
189 struct machine *machine __maybe_unused)
191 return perf_event__repipe_synth(tool, event);
194 static int perf_event__drop(struct perf_tool *tool __maybe_unused,
195 union perf_event *event __maybe_unused,
196 struct perf_sample *sample __maybe_unused,
197 struct machine *machine __maybe_unused)
202 static int perf_event__drop_aux(struct perf_tool *tool,
203 union perf_event *event __maybe_unused,
204 struct perf_sample *sample,
205 struct machine *machine __maybe_unused)
207 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
210 inject->aux_id = sample->id;
215 typedef int (*inject_handler)(struct perf_tool *tool,
216 union perf_event *event,
217 struct perf_sample *sample,
218 struct perf_evsel *evsel,
219 struct machine *machine);
221 static int perf_event__repipe_sample(struct perf_tool *tool,
222 union perf_event *event,
223 struct perf_sample *sample,
224 struct perf_evsel *evsel,
225 struct machine *machine)
227 if (evsel->handler) {
228 inject_handler f = evsel->handler;
229 return f(tool, event, sample, evsel, machine);
232 build_id__mark_dso_hit(tool, event, sample, evsel, machine);
234 return perf_event__repipe_synth(tool, event);
237 static int perf_event__repipe_mmap(struct perf_tool *tool,
238 union perf_event *event,
239 struct perf_sample *sample,
240 struct machine *machine)
244 err = perf_event__process_mmap(tool, event, sample, machine);
245 perf_event__repipe(tool, event, sample, machine);
251 static int perf_event__jit_repipe_mmap(struct perf_tool *tool,
252 union perf_event *event,
253 struct perf_sample *sample,
254 struct machine *machine)
256 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
261 * if jit marker, then inject jit mmaps and generate ELF images
263 ret = jit_process(inject->session, &inject->output, machine,
264 event->mmap.filename, sample->pid, &n);
268 inject->bytes_written += n;
271 return perf_event__repipe_mmap(tool, event, sample, machine);
275 static int perf_event__repipe_mmap2(struct perf_tool *tool,
276 union perf_event *event,
277 struct perf_sample *sample,
278 struct machine *machine)
282 err = perf_event__process_mmap2(tool, event, sample, machine);
283 perf_event__repipe(tool, event, sample, machine);
289 static int perf_event__jit_repipe_mmap2(struct perf_tool *tool,
290 union perf_event *event,
291 struct perf_sample *sample,
292 struct machine *machine)
294 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
299 * if jit marker, then inject jit mmaps and generate ELF images
301 ret = jit_process(inject->session, &inject->output, machine,
302 event->mmap2.filename, sample->pid, &n);
306 inject->bytes_written += n;
309 return perf_event__repipe_mmap2(tool, event, sample, machine);
313 static int perf_event__repipe_fork(struct perf_tool *tool,
314 union perf_event *event,
315 struct perf_sample *sample,
316 struct machine *machine)
320 err = perf_event__process_fork(tool, event, sample, machine);
321 perf_event__repipe(tool, event, sample, machine);
326 static int perf_event__repipe_comm(struct perf_tool *tool,
327 union perf_event *event,
328 struct perf_sample *sample,
329 struct machine *machine)
333 err = perf_event__process_comm(tool, event, sample, machine);
334 perf_event__repipe(tool, event, sample, machine);
339 static int perf_event__repipe_namespaces(struct perf_tool *tool,
340 union perf_event *event,
341 struct perf_sample *sample,
342 struct machine *machine)
344 int err = perf_event__process_namespaces(tool, event, sample, machine);
346 perf_event__repipe(tool, event, sample, machine);
351 static int perf_event__repipe_exit(struct perf_tool *tool,
352 union perf_event *event,
353 struct perf_sample *sample,
354 struct machine *machine)
358 err = perf_event__process_exit(tool, event, sample, machine);
359 perf_event__repipe(tool, event, sample, machine);
364 static int perf_event__repipe_tracing_data(struct perf_tool *tool,
365 union perf_event *event,
366 struct perf_session *session)
370 perf_event__repipe_synth(tool, event);
371 err = perf_event__process_tracing_data(tool, event, session);
376 static int perf_event__repipe_id_index(struct perf_tool *tool,
377 union perf_event *event,
378 struct perf_session *session)
382 perf_event__repipe_synth(tool, event);
383 err = perf_event__process_id_index(tool, event, session);
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 perf_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 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, sample->ip, &al);
444 if (al.map != NULL) {
445 if (!al.map->dso->hit) {
446 al.map->dso->hit = 1;
447 if (map__load(al.map) >= 0) {
448 dso__inject_build_id(al.map->dso, tool, machine);
450 * If this fails, too bad, let the other side
451 * account this as unresolved.
454 #ifdef HAVE_LIBELF_SUPPORT
455 pr_warning("no symbols found in %s, maybe "
456 "install a debug package?\n",
457 al.map->dso->long_name);
465 perf_event__repipe(tool, event, sample, machine);
469 static int perf_inject__sched_process_exit(struct perf_tool *tool,
470 union perf_event *event __maybe_unused,
471 struct perf_sample *sample,
472 struct perf_evsel *evsel __maybe_unused,
473 struct machine *machine __maybe_unused)
475 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
476 struct event_entry *ent;
478 list_for_each_entry(ent, &inject->samples, node) {
479 if (sample->tid == ent->tid) {
480 list_del_init(&ent->node);
489 static int perf_inject__sched_switch(struct perf_tool *tool,
490 union perf_event *event,
491 struct perf_sample *sample,
492 struct perf_evsel *evsel,
493 struct machine *machine)
495 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
496 struct event_entry *ent;
498 perf_inject__sched_process_exit(tool, event, sample, evsel, machine);
500 ent = malloc(event->header.size + sizeof(struct event_entry));
502 color_fprintf(stderr, PERF_COLOR_RED,
503 "Not enough memory to process sched switch event!");
507 ent->tid = sample->tid;
508 memcpy(&ent->event, event, event->header.size);
509 list_add(&ent->node, &inject->samples);
513 static int perf_inject__sched_stat(struct perf_tool *tool,
514 union perf_event *event __maybe_unused,
515 struct perf_sample *sample,
516 struct perf_evsel *evsel,
517 struct machine *machine)
519 struct event_entry *ent;
520 union perf_event *event_sw;
521 struct perf_sample sample_sw;
522 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
523 u32 pid = perf_evsel__intval(evsel, sample, "pid");
525 list_for_each_entry(ent, &inject->samples, node) {
532 event_sw = &ent->event[0];
533 perf_evsel__parse_sample(evsel, event_sw, &sample_sw);
535 sample_sw.period = sample->period;
536 sample_sw.time = sample->time;
537 perf_event__synthesize_sample(event_sw, evsel->attr.sample_type,
538 evsel->attr.read_format, &sample_sw,
540 build_id__mark_dso_hit(tool, event_sw, &sample_sw, evsel, machine);
541 return perf_event__repipe(tool, event_sw, &sample_sw, machine);
544 static void sig_handler(int sig __maybe_unused)
549 static int perf_evsel__check_stype(struct perf_evsel *evsel,
550 u64 sample_type, const char *sample_msg)
552 struct perf_event_attr *attr = &evsel->attr;
553 const char *name = perf_evsel__name(evsel);
555 if (!(attr->sample_type & sample_type)) {
556 pr_err("Samples for %s event do not have %s attribute set.",
564 static int drop_sample(struct perf_tool *tool __maybe_unused,
565 union perf_event *event __maybe_unused,
566 struct perf_sample *sample __maybe_unused,
567 struct perf_evsel *evsel __maybe_unused,
568 struct machine *machine __maybe_unused)
573 static void strip_init(struct perf_inject *inject)
575 struct perf_evlist *evlist = inject->session->evlist;
576 struct perf_evsel *evsel;
578 inject->tool.context_switch = perf_event__drop;
580 evlist__for_each_entry(evlist, evsel)
581 evsel->handler = drop_sample;
584 static bool has_tracking(struct perf_evsel *evsel)
586 return evsel->attr.mmap || evsel->attr.mmap2 || evsel->attr.comm ||
590 #define COMPAT_MASK (PERF_SAMPLE_ID | PERF_SAMPLE_TID | PERF_SAMPLE_TIME | \
591 PERF_SAMPLE_ID | PERF_SAMPLE_CPU | PERF_SAMPLE_IDENTIFIER)
594 * In order that the perf.data file is parsable, tracking events like MMAP need
595 * their selected event to exist, except if there is only 1 selected event left
596 * and it has a compatible sample type.
598 static bool ok_to_remove(struct perf_evlist *evlist,
599 struct perf_evsel *evsel_to_remove)
601 struct perf_evsel *evsel;
605 if (!has_tracking(evsel_to_remove))
608 evlist__for_each_entry(evlist, evsel) {
609 if (evsel->handler != drop_sample) {
611 if ((evsel->attr.sample_type & COMPAT_MASK) ==
612 (evsel_to_remove->attr.sample_type & COMPAT_MASK))
617 return ok && cnt == 1;
620 static void strip_fini(struct perf_inject *inject)
622 struct perf_evlist *evlist = inject->session->evlist;
623 struct perf_evsel *evsel, *tmp;
625 /* Remove non-synthesized evsels if possible */
626 evlist__for_each_entry_safe(evlist, tmp, evsel) {
627 if (evsel->handler == drop_sample &&
628 ok_to_remove(evlist, evsel)) {
629 pr_debug("Deleting %s\n", perf_evsel__name(evsel));
630 perf_evlist__remove(evlist, evsel);
631 perf_evsel__delete(evsel);
636 static int __cmd_inject(struct perf_inject *inject)
639 struct perf_session *session = inject->session;
640 struct perf_data_file *file_out = &inject->output;
641 int fd = perf_data_file__fd(file_out);
642 u64 output_data_offset;
644 signal(SIGINT, sig_handler);
646 if (inject->build_ids || inject->sched_stat ||
647 inject->itrace_synth_opts.set) {
648 inject->tool.mmap = perf_event__repipe_mmap;
649 inject->tool.mmap2 = perf_event__repipe_mmap2;
650 inject->tool.fork = perf_event__repipe_fork;
651 inject->tool.tracing_data = perf_event__repipe_tracing_data;
654 output_data_offset = session->header.data_offset;
656 if (inject->build_ids) {
657 inject->tool.sample = perf_event__inject_buildid;
658 } else if (inject->sched_stat) {
659 struct perf_evsel *evsel;
661 evlist__for_each_entry(session->evlist, evsel) {
662 const char *name = perf_evsel__name(evsel);
664 if (!strcmp(name, "sched:sched_switch")) {
665 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID"))
668 evsel->handler = perf_inject__sched_switch;
669 } else if (!strcmp(name, "sched:sched_process_exit"))
670 evsel->handler = perf_inject__sched_process_exit;
671 else if (!strncmp(name, "sched:sched_stat_", 17))
672 evsel->handler = perf_inject__sched_stat;
674 } else if (inject->itrace_synth_opts.set) {
675 session->itrace_synth_opts = &inject->itrace_synth_opts;
676 inject->itrace_synth_opts.inject = true;
677 inject->tool.comm = perf_event__repipe_comm;
678 inject->tool.namespaces = perf_event__repipe_namespaces;
679 inject->tool.exit = perf_event__repipe_exit;
680 inject->tool.id_index = perf_event__repipe_id_index;
681 inject->tool.auxtrace_info = perf_event__process_auxtrace_info;
682 inject->tool.auxtrace = perf_event__process_auxtrace;
683 inject->tool.aux = perf_event__drop_aux;
684 inject->tool.itrace_start = perf_event__drop_aux,
685 inject->tool.ordered_events = true;
686 inject->tool.ordering_requires_timestamps = true;
687 /* Allow space in the header for new attributes */
688 output_data_offset = 4096;
693 if (!inject->itrace_synth_opts.set)
694 auxtrace_index__free(&session->auxtrace_index);
696 if (!file_out->is_pipe)
697 lseek(fd, output_data_offset, SEEK_SET);
699 ret = perf_session__process_events(session);
703 if (!file_out->is_pipe) {
704 if (inject->build_ids)
705 perf_header__set_feat(&session->header,
708 * Keep all buildids when there is unprocessed AUX data because
709 * it is not known which ones the AUX trace hits.
711 if (perf_header__has_feat(&session->header, HEADER_BUILD_ID) &&
712 inject->have_auxtrace && !inject->itrace_synth_opts.set)
713 dsos__hit_all(session);
715 * The AUX areas have been removed and replaced with
716 * synthesized hardware events, so clear the feature flag and
719 if (inject->itrace_synth_opts.set) {
720 struct perf_evsel *evsel;
722 perf_header__clear_feat(&session->header,
724 if (inject->itrace_synth_opts.last_branch)
725 perf_header__set_feat(&session->header,
726 HEADER_BRANCH_STACK);
727 evsel = perf_evlist__id2evsel_strict(session->evlist,
730 pr_debug("Deleting %s\n",
731 perf_evsel__name(evsel));
732 perf_evlist__remove(session->evlist, evsel);
733 perf_evsel__delete(evsel);
738 session->header.data_offset = output_data_offset;
739 session->header.data_size = inject->bytes_written;
740 perf_session__write_header(session, session->evlist, fd, true);
746 int cmd_inject(int argc, const char **argv)
748 struct perf_inject inject = {
750 .sample = perf_event__repipe_sample,
751 .mmap = perf_event__repipe,
752 .mmap2 = perf_event__repipe,
753 .comm = perf_event__repipe,
754 .fork = perf_event__repipe,
755 .exit = perf_event__repipe,
756 .lost = perf_event__repipe,
757 .lost_samples = perf_event__repipe,
758 .aux = perf_event__repipe,
759 .itrace_start = perf_event__repipe,
760 .context_switch = perf_event__repipe,
761 .read = perf_event__repipe_sample,
762 .throttle = perf_event__repipe,
763 .unthrottle = perf_event__repipe,
764 .attr = perf_event__repipe_attr,
765 .tracing_data = perf_event__repipe_op2_synth,
766 .auxtrace_info = perf_event__repipe_op2_synth,
767 .auxtrace = perf_event__repipe_auxtrace,
768 .auxtrace_error = perf_event__repipe_op2_synth,
769 .time_conv = perf_event__repipe_op2_synth,
770 .finished_round = perf_event__repipe_oe_synth,
771 .build_id = perf_event__repipe_op2_synth,
772 .id_index = perf_event__repipe_op2_synth,
773 .feature = perf_event__repipe_op2_synth,
776 .samples = LIST_HEAD_INIT(inject.samples),
779 .mode = PERF_DATA_MODE_WRITE,
782 struct perf_data_file file = {
783 .mode = PERF_DATA_MODE_READ,
787 struct option options[] = {
788 OPT_BOOLEAN('b', "build-ids", &inject.build_ids,
789 "Inject build-ids into the output stream"),
790 OPT_STRING('i', "input", &inject.input_name, "file",
792 OPT_STRING('o', "output", &inject.output.path, "file",
794 OPT_BOOLEAN('s', "sched-stat", &inject.sched_stat,
795 "Merge sched-stat and sched-switch for getting events "
796 "where and how long tasks slept"),
798 OPT_BOOLEAN('j', "jit", &inject.jit_mode, "merge jitdump files into perf.data file"),
800 OPT_INCR('v', "verbose", &verbose,
801 "be more verbose (show build ids, etc)"),
802 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, "file",
803 "kallsyms pathname"),
804 OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
805 OPT_CALLBACK_OPTARG(0, "itrace", &inject.itrace_synth_opts,
806 NULL, "opts", "Instruction Tracing options",
807 itrace_parse_synth_opts),
808 OPT_BOOLEAN(0, "strip", &inject.strip,
809 "strip non-synthesized events (use with --itrace)"),
812 const char * const inject_usage[] = {
813 "perf inject [<options>]",
817 set_option_nobuild(options, 'j', "jit", "NO_LIBELF=1", true);
819 argc = parse_options(argc, argv, options, inject_usage, 0);
822 * Any (unrecognized) arguments left?
825 usage_with_options(inject_usage, options);
827 if (inject.strip && !inject.itrace_synth_opts.set) {
828 pr_err("--strip option requires --itrace option\n");
832 if (perf_data_file__open(&inject.output)) {
833 perror("failed to create output file");
837 inject.tool.ordered_events = inject.sched_stat;
839 file.path = inject.input_name;
840 inject.session = perf_session__new(&file, true, &inject.tool);
841 if (inject.session == NULL)
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 perf_session__delete(inject.session);