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>
28 struct perf_tool tool;
29 struct perf_session *session;
35 const char *input_name;
36 struct perf_data_file output;
39 struct list_head samples;
40 struct itrace_synth_opts itrace_synth_opts;
44 struct list_head node;
46 union perf_event event[0];
49 static int output_bytes(struct perf_inject *inject, void *buf, size_t sz)
53 size = perf_data_file__write(&inject->output, buf, sz);
57 inject->bytes_written += size;
61 static int perf_event__repipe_synth(struct perf_tool *tool,
62 union perf_event *event)
64 struct perf_inject *inject = container_of(tool, struct perf_inject,
67 return output_bytes(inject, event, event->header.size);
70 static int perf_event__repipe_oe_synth(struct perf_tool *tool,
71 union perf_event *event,
72 struct ordered_events *oe __maybe_unused)
74 return perf_event__repipe_synth(tool, event);
78 static int perf_event__drop_oe(struct perf_tool *tool __maybe_unused,
79 union perf_event *event __maybe_unused,
80 struct ordered_events *oe __maybe_unused)
86 static int perf_event__repipe_op2_synth(struct perf_tool *tool,
87 union perf_event *event,
88 struct perf_session *session
91 return perf_event__repipe_synth(tool, event);
94 static int perf_event__repipe_attr(struct perf_tool *tool,
95 union perf_event *event,
96 struct perf_evlist **pevlist)
98 struct perf_inject *inject = container_of(tool, struct perf_inject,
102 ret = perf_event__process_attr(tool, event, pevlist);
106 if (!inject->output.is_pipe)
109 return perf_event__repipe_synth(tool, event);
112 #ifdef HAVE_AUXTRACE_SUPPORT
114 static int copy_bytes(struct perf_inject *inject, int fd, off_t size)
121 ssz = read(fd, buf, min(size, (off_t)sizeof(buf)));
124 ret = output_bytes(inject, buf, ssz);
133 static s64 perf_event__repipe_auxtrace(struct perf_tool *tool,
134 union perf_event *event,
135 struct perf_session *session)
137 struct perf_inject *inject = container_of(tool, struct perf_inject,
141 inject->have_auxtrace = true;
143 if (!inject->output.is_pipe) {
146 offset = lseek(inject->output.fd, 0, SEEK_CUR);
149 ret = auxtrace_index__auxtrace_event(&session->auxtrace_index,
155 if (perf_data_file__is_pipe(session->file) || !session->one_mmap) {
156 ret = output_bytes(inject, event, event->header.size);
159 ret = copy_bytes(inject, perf_data_file__fd(session->file),
160 event->auxtrace.size);
162 ret = output_bytes(inject, event,
163 event->header.size + event->auxtrace.size);
168 return event->auxtrace.size;
174 perf_event__repipe_auxtrace(struct perf_tool *tool __maybe_unused,
175 union perf_event *event __maybe_unused,
176 struct perf_session *session __maybe_unused)
178 pr_err("AUX area tracing not supported\n");
184 static int perf_event__repipe(struct perf_tool *tool,
185 union perf_event *event,
186 struct perf_sample *sample __maybe_unused,
187 struct machine *machine __maybe_unused)
189 return perf_event__repipe_synth(tool, event);
192 static int perf_event__drop(struct perf_tool *tool __maybe_unused,
193 union perf_event *event __maybe_unused,
194 struct perf_sample *sample __maybe_unused,
195 struct machine *machine __maybe_unused)
200 static int perf_event__drop_aux(struct perf_tool *tool,
201 union perf_event *event __maybe_unused,
202 struct perf_sample *sample,
203 struct machine *machine __maybe_unused)
205 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
208 inject->aux_id = sample->id;
213 typedef int (*inject_handler)(struct perf_tool *tool,
214 union perf_event *event,
215 struct perf_sample *sample,
216 struct perf_evsel *evsel,
217 struct machine *machine);
219 static int perf_event__repipe_sample(struct perf_tool *tool,
220 union perf_event *event,
221 struct perf_sample *sample,
222 struct perf_evsel *evsel,
223 struct machine *machine)
225 if (evsel->handler) {
226 inject_handler f = evsel->handler;
227 return f(tool, event, sample, evsel, machine);
230 build_id__mark_dso_hit(tool, event, sample, evsel, machine);
232 return perf_event__repipe_synth(tool, event);
235 static int perf_event__repipe_mmap(struct perf_tool *tool,
236 union perf_event *event,
237 struct perf_sample *sample,
238 struct machine *machine)
242 err = perf_event__process_mmap(tool, event, sample, machine);
243 perf_event__repipe(tool, event, sample, machine);
249 static int perf_event__jit_repipe_mmap(struct perf_tool *tool,
250 union perf_event *event,
251 struct perf_sample *sample,
252 struct machine *machine)
254 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
259 * if jit marker, then inject jit mmaps and generate ELF images
261 ret = jit_process(inject->session, &inject->output, machine,
262 event->mmap.filename, sample->pid, &n);
266 inject->bytes_written += n;
269 return perf_event__repipe_mmap(tool, event, sample, machine);
273 static int perf_event__repipe_mmap2(struct perf_tool *tool,
274 union perf_event *event,
275 struct perf_sample *sample,
276 struct machine *machine)
280 err = perf_event__process_mmap2(tool, event, sample, machine);
281 perf_event__repipe(tool, event, sample, machine);
287 static int perf_event__jit_repipe_mmap2(struct perf_tool *tool,
288 union perf_event *event,
289 struct perf_sample *sample,
290 struct machine *machine)
292 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
297 * if jit marker, then inject jit mmaps and generate ELF images
299 ret = jit_process(inject->session, &inject->output, machine,
300 event->mmap2.filename, sample->pid, &n);
304 inject->bytes_written += n;
307 return perf_event__repipe_mmap2(tool, event, sample, machine);
311 static int perf_event__repipe_fork(struct perf_tool *tool,
312 union perf_event *event,
313 struct perf_sample *sample,
314 struct machine *machine)
318 err = perf_event__process_fork(tool, event, sample, machine);
319 perf_event__repipe(tool, event, sample, machine);
324 static int perf_event__repipe_comm(struct perf_tool *tool,
325 union perf_event *event,
326 struct perf_sample *sample,
327 struct machine *machine)
331 err = perf_event__process_comm(tool, event, sample, machine);
332 perf_event__repipe(tool, event, sample, machine);
337 static int perf_event__repipe_namespaces(struct perf_tool *tool,
338 union perf_event *event,
339 struct perf_sample *sample,
340 struct machine *machine)
342 int err = perf_event__process_namespaces(tool, event, sample, machine);
344 perf_event__repipe(tool, event, sample, machine);
349 static int perf_event__repipe_exit(struct perf_tool *tool,
350 union perf_event *event,
351 struct perf_sample *sample,
352 struct machine *machine)
356 err = perf_event__process_exit(tool, event, sample, machine);
357 perf_event__repipe(tool, event, sample, machine);
362 static int perf_event__repipe_tracing_data(struct perf_tool *tool,
363 union perf_event *event,
364 struct perf_session *session)
368 perf_event__repipe_synth(tool, event);
369 err = perf_event__process_tracing_data(tool, event, session);
374 static int perf_event__repipe_id_index(struct perf_tool *tool,
375 union perf_event *event,
376 struct perf_session *session)
380 perf_event__repipe_synth(tool, event);
381 err = perf_event__process_id_index(tool, event, session);
386 static int dso__read_build_id(struct dso *dso)
388 if (dso->has_build_id)
391 if (filename__read_build_id(dso->long_name, dso->build_id,
392 sizeof(dso->build_id)) > 0) {
393 dso->has_build_id = true;
400 static int dso__inject_build_id(struct dso *dso, struct perf_tool *tool,
401 struct machine *machine)
403 u16 misc = PERF_RECORD_MISC_USER;
406 if (dso__read_build_id(dso) < 0) {
407 pr_debug("no build_id found for %s\n", dso->long_name);
412 misc = PERF_RECORD_MISC_KERNEL;
414 err = perf_event__synthesize_build_id(tool, dso, misc, perf_event__repipe,
417 pr_err("Can't synthesize build_id event for %s\n", dso->long_name);
424 static int perf_event__inject_buildid(struct perf_tool *tool,
425 union perf_event *event,
426 struct perf_sample *sample,
427 struct perf_evsel *evsel __maybe_unused,
428 struct machine *machine)
430 struct addr_location al;
431 struct thread *thread;
433 thread = machine__findnew_thread(machine, sample->pid, sample->tid);
434 if (thread == NULL) {
435 pr_err("problem processing %d event, skipping it.\n",
440 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, sample->ip, &al);
442 if (al.map != NULL) {
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 perf_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,
490 struct perf_evsel *evsel,
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,
514 struct perf_evsel *evsel,
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->attr.sample_type,
536 evsel->attr.read_format, &sample_sw,
538 build_id__mark_dso_hit(tool, event_sw, &sample_sw, evsel, machine);
539 return perf_event__repipe(tool, event_sw, &sample_sw, machine);
542 static void sig_handler(int sig __maybe_unused)
547 static int perf_evsel__check_stype(struct perf_evsel *evsel,
548 u64 sample_type, const char *sample_msg)
550 struct perf_event_attr *attr = &evsel->attr;
551 const char *name = perf_evsel__name(evsel);
553 if (!(attr->sample_type & sample_type)) {
554 pr_err("Samples for %s event do not have %s attribute set.",
562 static int drop_sample(struct perf_tool *tool __maybe_unused,
563 union perf_event *event __maybe_unused,
564 struct perf_sample *sample __maybe_unused,
565 struct perf_evsel *evsel __maybe_unused,
566 struct machine *machine __maybe_unused)
571 static void strip_init(struct perf_inject *inject)
573 struct perf_evlist *evlist = inject->session->evlist;
574 struct perf_evsel *evsel;
576 inject->tool.context_switch = perf_event__drop;
578 evlist__for_each_entry(evlist, evsel)
579 evsel->handler = drop_sample;
582 static bool has_tracking(struct perf_evsel *evsel)
584 return evsel->attr.mmap || evsel->attr.mmap2 || evsel->attr.comm ||
588 #define COMPAT_MASK (PERF_SAMPLE_ID | PERF_SAMPLE_TID | PERF_SAMPLE_TIME | \
589 PERF_SAMPLE_ID | PERF_SAMPLE_CPU | PERF_SAMPLE_IDENTIFIER)
592 * In order that the perf.data file is parsable, tracking events like MMAP need
593 * their selected event to exist, except if there is only 1 selected event left
594 * and it has a compatible sample type.
596 static bool ok_to_remove(struct perf_evlist *evlist,
597 struct perf_evsel *evsel_to_remove)
599 struct perf_evsel *evsel;
603 if (!has_tracking(evsel_to_remove))
606 evlist__for_each_entry(evlist, evsel) {
607 if (evsel->handler != drop_sample) {
609 if ((evsel->attr.sample_type & COMPAT_MASK) ==
610 (evsel_to_remove->attr.sample_type & COMPAT_MASK))
615 return ok && cnt == 1;
618 static void strip_fini(struct perf_inject *inject)
620 struct perf_evlist *evlist = inject->session->evlist;
621 struct perf_evsel *evsel, *tmp;
623 /* Remove non-synthesized evsels if possible */
624 evlist__for_each_entry_safe(evlist, tmp, evsel) {
625 if (evsel->handler == drop_sample &&
626 ok_to_remove(evlist, evsel)) {
627 pr_debug("Deleting %s\n", perf_evsel__name(evsel));
628 perf_evlist__remove(evlist, evsel);
629 perf_evsel__delete(evsel);
634 static int __cmd_inject(struct perf_inject *inject)
637 struct perf_session *session = inject->session;
638 struct perf_data_file *file_out = &inject->output;
639 int fd = perf_data_file__fd(file_out);
640 u64 output_data_offset;
642 signal(SIGINT, sig_handler);
644 if (inject->build_ids || inject->sched_stat ||
645 inject->itrace_synth_opts.set) {
646 inject->tool.mmap = perf_event__repipe_mmap;
647 inject->tool.mmap2 = perf_event__repipe_mmap2;
648 inject->tool.fork = perf_event__repipe_fork;
649 inject->tool.tracing_data = perf_event__repipe_tracing_data;
652 output_data_offset = session->header.data_offset;
654 if (inject->build_ids) {
655 inject->tool.sample = perf_event__inject_buildid;
656 } else if (inject->sched_stat) {
657 struct perf_evsel *evsel;
659 evlist__for_each_entry(session->evlist, evsel) {
660 const char *name = perf_evsel__name(evsel);
662 if (!strcmp(name, "sched:sched_switch")) {
663 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID"))
666 evsel->handler = perf_inject__sched_switch;
667 } else if (!strcmp(name, "sched:sched_process_exit"))
668 evsel->handler = perf_inject__sched_process_exit;
669 else if (!strncmp(name, "sched:sched_stat_", 17))
670 evsel->handler = perf_inject__sched_stat;
672 } else if (inject->itrace_synth_opts.set) {
673 session->itrace_synth_opts = &inject->itrace_synth_opts;
674 inject->itrace_synth_opts.inject = true;
675 inject->tool.comm = perf_event__repipe_comm;
676 inject->tool.namespaces = perf_event__repipe_namespaces;
677 inject->tool.exit = perf_event__repipe_exit;
678 inject->tool.id_index = perf_event__repipe_id_index;
679 inject->tool.auxtrace_info = perf_event__process_auxtrace_info;
680 inject->tool.auxtrace = perf_event__process_auxtrace;
681 inject->tool.aux = perf_event__drop_aux;
682 inject->tool.itrace_start = perf_event__drop_aux,
683 inject->tool.ordered_events = true;
684 inject->tool.ordering_requires_timestamps = true;
685 /* Allow space in the header for new attributes */
686 output_data_offset = 4096;
691 if (!inject->itrace_synth_opts.set)
692 auxtrace_index__free(&session->auxtrace_index);
694 if (!file_out->is_pipe)
695 lseek(fd, output_data_offset, SEEK_SET);
697 ret = perf_session__process_events(session);
701 if (!file_out->is_pipe) {
702 if (inject->build_ids)
703 perf_header__set_feat(&session->header,
706 * Keep all buildids when there is unprocessed AUX data because
707 * it is not known which ones the AUX trace hits.
709 if (perf_header__has_feat(&session->header, HEADER_BUILD_ID) &&
710 inject->have_auxtrace && !inject->itrace_synth_opts.set)
711 dsos__hit_all(session);
713 * The AUX areas have been removed and replaced with
714 * synthesized hardware events, so clear the feature flag and
717 if (inject->itrace_synth_opts.set) {
718 struct perf_evsel *evsel;
720 perf_header__clear_feat(&session->header,
722 if (inject->itrace_synth_opts.last_branch)
723 perf_header__set_feat(&session->header,
724 HEADER_BRANCH_STACK);
725 evsel = perf_evlist__id2evsel_strict(session->evlist,
728 pr_debug("Deleting %s\n",
729 perf_evsel__name(evsel));
730 perf_evlist__remove(session->evlist, evsel);
731 perf_evsel__delete(evsel);
736 session->header.data_offset = output_data_offset;
737 session->header.data_size = inject->bytes_written;
738 perf_session__write_header(session, session->evlist, fd, true);
744 int cmd_inject(int argc, const char **argv)
746 struct perf_inject inject = {
748 .sample = perf_event__repipe_sample,
749 .mmap = perf_event__repipe,
750 .mmap2 = perf_event__repipe,
751 .comm = perf_event__repipe,
752 .fork = perf_event__repipe,
753 .exit = perf_event__repipe,
754 .lost = perf_event__repipe,
755 .lost_samples = perf_event__repipe,
756 .aux = perf_event__repipe,
757 .itrace_start = perf_event__repipe,
758 .context_switch = perf_event__repipe,
759 .read = perf_event__repipe_sample,
760 .throttle = perf_event__repipe,
761 .unthrottle = perf_event__repipe,
762 .attr = perf_event__repipe_attr,
763 .tracing_data = perf_event__repipe_op2_synth,
764 .auxtrace_info = perf_event__repipe_op2_synth,
765 .auxtrace = perf_event__repipe_auxtrace,
766 .auxtrace_error = perf_event__repipe_op2_synth,
767 .time_conv = perf_event__repipe_op2_synth,
768 .finished_round = perf_event__repipe_oe_synth,
769 .build_id = perf_event__repipe_op2_synth,
770 .id_index = perf_event__repipe_op2_synth,
773 .samples = LIST_HEAD_INIT(inject.samples),
776 .mode = PERF_DATA_MODE_WRITE,
779 struct perf_data_file file = {
780 .mode = PERF_DATA_MODE_READ,
784 struct option options[] = {
785 OPT_BOOLEAN('b', "build-ids", &inject.build_ids,
786 "Inject build-ids into the output stream"),
787 OPT_STRING('i', "input", &inject.input_name, "file",
789 OPT_STRING('o', "output", &inject.output.path, "file",
791 OPT_BOOLEAN('s', "sched-stat", &inject.sched_stat,
792 "Merge sched-stat and sched-switch for getting events "
793 "where and how long tasks slept"),
795 OPT_BOOLEAN('j', "jit", &inject.jit_mode, "merge jitdump files into perf.data file"),
797 OPT_INCR('v', "verbose", &verbose,
798 "be more verbose (show build ids, etc)"),
799 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, "file",
800 "kallsyms pathname"),
801 OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
802 OPT_CALLBACK_OPTARG(0, "itrace", &inject.itrace_synth_opts,
803 NULL, "opts", "Instruction Tracing options",
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_file__open(&inject.output)) {
830 perror("failed to create output file");
834 inject.tool.ordered_events = inject.sched_stat;
836 file.path = inject.input_name;
837 inject.session = perf_session__new(&file, true, &inject.tool);
838 if (inject.session == NULL)
841 if (inject.build_ids) {
843 * to make sure the mmap records are ordered correctly
844 * and so that the correct especially due to jitted code
845 * mmaps. We cannot generate the buildid hit list and
846 * inject the jit mmaps at the same time for now.
848 inject.tool.ordered_events = true;
849 inject.tool.ordering_requires_timestamps = true;
852 if (inject.jit_mode) {
853 inject.tool.mmap2 = perf_event__jit_repipe_mmap2;
854 inject.tool.mmap = perf_event__jit_repipe_mmap;
855 inject.tool.ordered_events = true;
856 inject.tool.ordering_requires_timestamps = true;
858 * JIT MMAP injection injects all MMAP events in one go, so it
859 * does not obey finished_round semantics.
861 inject.tool.finished_round = perf_event__drop_oe;
864 ret = symbol__init(&inject.session->header.env);
868 ret = __cmd_inject(&inject);
871 perf_session__delete(inject.session);