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/vdso.h"
14 #include "util/evlist.h"
15 #include "util/evsel.h"
17 #include "util/session.h"
18 #include "util/tool.h"
19 #include "util/debug.h"
20 #include "util/build-id.h"
21 #include "util/data.h"
22 #include "util/auxtrace.h"
24 #include "util/string2.h"
25 #include "util/symbol.h"
26 #include "util/synthetic-events.h"
27 #include "util/thread.h"
28 #include "util/namespaces.h"
29 #include "util/util.h"
32 #include <internal/lib.h>
34 #include <linux/err.h>
35 #include <subcmd/parse-options.h>
36 #include <uapi/linux/mman.h> /* To get things like MAP_HUGETLB even on older libc headers */
38 #include <linux/list.h>
39 #include <linux/string.h>
40 #include <linux/zalloc.h>
41 #include <linux/hash.h>
48 struct perf_sample sample;
49 union perf_event *event;
54 /* hlist_node must be first, see free_hlist() */
55 struct hlist_node node;
62 /* hlist_node must be first, see free_hlist() */
63 struct hlist_node node;
64 /* Thread ID of QEMU thread */
70 /* Current host CPU */
72 /* Thread ID of QEMU thread */
76 struct guest_session {
81 struct perf_tool tool;
82 struct perf_data data;
83 struct perf_session *session;
86 struct perf_tsc_conversion host_tc;
87 struct perf_tsc_conversion guest_tc;
95 /* Array of guest_vcpu */
96 struct guest_vcpu *vcpu;
98 /* Hash table for guest_id */
99 struct hlist_head heads[PERF_EVLIST__HLIST_SIZE];
100 /* Hash table for guest_tid */
101 struct hlist_head tids[PERF_EVLIST__HLIST_SIZE];
102 /* Place to stash next guest event */
103 struct guest_event ev;
106 enum build_id_rewrite_style {
108 BID_RWS__INJECT_HEADER_LAZY,
109 BID_RWS__INJECT_HEADER_ALL,
110 BID_RWS__MMAP2_BUILDID_ALL,
111 BID_RWS__MMAP2_BUILDID_LAZY,
115 struct perf_tool tool;
116 struct perf_session *session;
117 enum build_id_rewrite_style build_id_style;
122 bool in_place_update;
123 bool in_place_update_dry_run;
125 const char *input_name;
126 struct perf_data output;
129 struct list_head samples;
130 struct itrace_synth_opts itrace_synth_opts;
132 struct perf_file_section secs[HEADER_FEAT_BITS];
133 struct guest_session guest_session;
134 struct strlist *known_build_ids;
135 const struct evsel *mmap_evsel;
139 struct list_head node;
141 union perf_event event[];
144 static int tool__inject_build_id(const struct perf_tool *tool,
145 struct perf_sample *sample,
146 struct machine *machine,
147 const struct evsel *evsel,
149 const char *filename,
150 struct dso *dso, u32 flags);
151 static int tool__inject_mmap2_build_id(const struct perf_tool *tool,
152 struct perf_sample *sample,
153 struct machine *machine,
154 const struct evsel *evsel,
156 __u32 pid, __u32 tid,
157 __u64 start, __u64 len, __u64 pgoff,
159 __u32 prot, __u32 flags,
160 const char *filename);
162 static int output_bytes(struct perf_inject *inject, void *buf, size_t sz)
166 size = perf_data__write(&inject->output, buf, sz);
170 inject->bytes_written += size;
174 static int perf_event__repipe_synth(const struct perf_tool *tool,
175 union perf_event *event)
178 struct perf_inject *inject = container_of(tool, struct perf_inject,
181 return output_bytes(inject, event, event->header.size);
184 static int perf_event__repipe_oe_synth(const struct perf_tool *tool,
185 union perf_event *event,
186 struct ordered_events *oe __maybe_unused)
188 return perf_event__repipe_synth(tool, event);
192 static int perf_event__drop_oe(const struct perf_tool *tool __maybe_unused,
193 union perf_event *event __maybe_unused,
194 struct ordered_events *oe __maybe_unused)
200 static int perf_event__repipe_op2_synth(struct perf_session *session,
201 union perf_event *event)
203 return perf_event__repipe_synth(session->tool, event);
206 static int perf_event__repipe_op4_synth(struct perf_session *session,
207 union perf_event *event,
208 u64 data __maybe_unused,
209 const char *str __maybe_unused)
211 return perf_event__repipe_synth(session->tool, event);
214 static int perf_event__repipe_attr(const struct perf_tool *tool,
215 union perf_event *event,
216 struct evlist **pevlist)
218 struct perf_inject *inject = container_of(tool, struct perf_inject,
222 ret = perf_event__process_attr(tool, event, pevlist);
226 /* If the output isn't a pipe then the attributes will be written as part of the header. */
227 if (!inject->output.is_pipe)
230 return perf_event__repipe_synth(tool, event);
233 static int perf_event__repipe_event_update(const struct perf_tool *tool,
234 union perf_event *event,
235 struct evlist **pevlist __maybe_unused)
237 return perf_event__repipe_synth(tool, event);
240 #ifdef HAVE_AUXTRACE_SUPPORT
242 static int copy_bytes(struct perf_inject *inject, struct perf_data *data, off_t size)
249 ssz = perf_data__read(data, buf, min(size, (off_t)sizeof(buf)));
252 ret = output_bytes(inject, buf, ssz);
261 static s64 perf_event__repipe_auxtrace(struct perf_session *session,
262 union perf_event *event)
264 const struct perf_tool *tool = session->tool;
265 struct perf_inject *inject = container_of(tool, struct perf_inject,
269 inject->have_auxtrace = true;
271 if (!inject->output.is_pipe) {
274 offset = lseek(inject->output.file.fd, 0, SEEK_CUR);
277 ret = auxtrace_index__auxtrace_event(&session->auxtrace_index,
283 if (perf_data__is_pipe(session->data) || !session->one_mmap) {
284 ret = output_bytes(inject, event, event->header.size);
287 ret = copy_bytes(inject, session->data,
288 event->auxtrace.size);
290 ret = output_bytes(inject, event,
291 event->header.size + event->auxtrace.size);
296 return event->auxtrace.size;
302 perf_event__repipe_auxtrace(struct perf_session *session __maybe_unused,
303 union perf_event *event __maybe_unused)
305 pr_err("AUX area tracing not supported\n");
311 static int perf_event__repipe(const struct perf_tool *tool,
312 union perf_event *event,
313 struct perf_sample *sample __maybe_unused,
314 struct machine *machine __maybe_unused)
316 return perf_event__repipe_synth(tool, event);
319 static int perf_event__drop(const struct perf_tool *tool __maybe_unused,
320 union perf_event *event __maybe_unused,
321 struct perf_sample *sample __maybe_unused,
322 struct machine *machine __maybe_unused)
327 static int perf_event__drop_aux(const struct perf_tool *tool,
328 union perf_event *event __maybe_unused,
329 struct perf_sample *sample,
330 struct machine *machine __maybe_unused)
332 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
335 inject->aux_id = sample->id;
340 static union perf_event *
341 perf_inject__cut_auxtrace_sample(struct perf_inject *inject,
342 union perf_event *event,
343 struct perf_sample *sample)
345 size_t sz1 = sample->aux_sample.data - (void *)event;
346 size_t sz2 = event->header.size - sample->aux_sample.size - sz1;
347 union perf_event *ev;
349 if (inject->event_copy == NULL) {
350 inject->event_copy = malloc(PERF_SAMPLE_MAX_SIZE);
351 if (!inject->event_copy)
352 return ERR_PTR(-ENOMEM);
354 ev = (union perf_event *)inject->event_copy;
355 if (sz1 > event->header.size || sz2 > event->header.size ||
356 sz1 + sz2 > event->header.size ||
357 sz1 < sizeof(struct perf_event_header) + sizeof(u64))
360 memcpy(ev, event, sz1);
361 memcpy((void *)ev + sz1, (void *)event + event->header.size - sz2, sz2);
362 ev->header.size = sz1 + sz2;
363 ((u64 *)((void *)ev + sz1))[-1] = 0;
368 typedef int (*inject_handler)(const struct perf_tool *tool,
369 union perf_event *event,
370 struct perf_sample *sample,
372 struct machine *machine);
374 static int perf_event__repipe_sample(const struct perf_tool *tool,
375 union perf_event *event,
376 struct perf_sample *sample,
378 struct machine *machine)
380 struct perf_inject *inject = container_of(tool, struct perf_inject,
383 if (evsel && evsel->handler) {
384 inject_handler f = evsel->handler;
385 return f(tool, event, sample, evsel, machine);
388 build_id__mark_dso_hit(tool, event, sample, evsel, machine);
390 if (inject->itrace_synth_opts.set && sample->aux_sample.size) {
391 event = perf_inject__cut_auxtrace_sample(inject, event, sample);
393 return PTR_ERR(event);
396 return perf_event__repipe_synth(tool, event);
399 static struct dso *findnew_dso(int pid, int tid, const char *filename,
400 const struct dso_id *id, struct machine *machine)
402 struct thread *thread;
403 struct nsinfo *nsi = NULL;
408 thread = machine__findnew_thread(machine, pid, tid);
409 if (thread == NULL) {
410 pr_err("cannot find or create a task %d/%d.\n", tid, pid);
414 vdso = is_vdso_map(filename);
415 nsi = nsinfo__get(thread__nsinfo(thread));
418 /* The vdso maps are always on the host and not the
419 * container. Ensure that we don't use setns to look
422 nnsi = nsinfo__copy(nsi);
425 nsinfo__clear_need_setns(nnsi);
428 dso = machine__findnew_vdso(machine, thread);
430 dso = machine__findnew_dso_id(machine, filename, id);
434 mutex_lock(dso__lock(dso));
435 dso__set_nsinfo(dso, nsi);
436 mutex_unlock(dso__lock(dso));
445 * The evsel used for the sample ID for mmap events. Typically stashed when
446 * processing mmap events. If not stashed, search the evlist for the first mmap
449 static const struct evsel *inject__mmap_evsel(struct perf_inject *inject)
453 if (inject->mmap_evsel)
454 return inject->mmap_evsel;
456 evlist__for_each_entry(inject->session->evlist, pos) {
457 if (pos->core.attr.mmap) {
458 inject->mmap_evsel = pos;
462 pr_err("No mmap events found\n");
466 static int perf_event__repipe_common_mmap(const struct perf_tool *tool,
467 union perf_event *event,
468 struct perf_sample *sample,
469 struct machine *machine,
470 __u32 pid, __u32 tid,
471 __u64 start, __u64 len, __u64 pgoff,
472 __u32 flags, __u32 prot,
473 const char *filename,
474 const struct dso_id *dso_id,
475 int (*perf_event_process)(const struct perf_tool *tool,
476 union perf_event *event,
477 struct perf_sample *sample,
478 struct machine *machine))
480 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
481 struct dso *dso = NULL;
482 bool dso_sought = false;
485 if (inject->jit_mode) {
489 /* If jit marker, then inject jit mmaps and generate ELF images. */
490 ret = jit_process(inject->session, &inject->output, machine,
491 filename, pid, tid, &n);
495 inject->bytes_written += n;
500 if (event->header.misc & PERF_RECORD_MISC_MMAP_BUILD_ID) {
501 dso = findnew_dso(pid, tid, filename, dso_id, machine);
504 /* mark it not to inject build-id */
508 if (inject->build_id_style == BID_RWS__INJECT_HEADER_ALL) {
510 dso = findnew_dso(pid, tid, filename, dso_id, machine);
514 if (dso && !dso__hit(dso)) {
515 struct evsel *evsel = evlist__event2evsel(inject->session->evlist, event);
519 tool__inject_build_id(tool, sample, machine, evsel,
520 /*misc=*/sample->cpumode,
521 filename, dso, flags);
528 * Remember the evsel for lazy build id generation. It is used
529 * for the sample id header type.
531 if ((inject->build_id_style == BID_RWS__INJECT_HEADER_LAZY ||
532 inject->build_id_style == BID_RWS__MMAP2_BUILDID_LAZY) &&
534 inject->mmap_evsel = evlist__event2evsel(inject->session->evlist, event);
536 /* Create the thread, map, etc. Not done for the unordered inject all case. */
537 err = perf_event_process(tool, event, sample, machine);
544 if ((inject->build_id_style == BID_RWS__MMAP2_BUILDID_ALL) &&
545 !(event->header.misc & PERF_RECORD_MISC_MMAP_BUILD_ID)) {
546 struct evsel *evsel = evlist__event2evsel(inject->session->evlist, event);
548 if (evsel && !dso_sought) {
549 dso = findnew_dso(pid, tid, filename, dso_id, machine);
553 !tool__inject_mmap2_build_id(tool, sample, machine, evsel,
554 sample->cpumode | PERF_RECORD_MISC_MMAP_BUILD_ID,
555 pid, tid, start, len, pgoff,
559 /* Injected mmap2 so no need to repipe. */
565 if (inject->build_id_style == BID_RWS__MMAP2_BUILDID_LAZY)
568 return perf_event__repipe(tool, event, sample, machine);
571 static int perf_event__repipe_mmap(const struct perf_tool *tool,
572 union perf_event *event,
573 struct perf_sample *sample,
574 struct machine *machine)
576 return perf_event__repipe_common_mmap(
577 tool, event, sample, machine,
578 event->mmap.pid, event->mmap.tid,
579 event->mmap.start, event->mmap.len, event->mmap.pgoff,
580 /*flags=*/0, PROT_EXEC,
581 event->mmap.filename, /*dso_id=*/NULL,
582 perf_event__process_mmap);
585 static int perf_event__repipe_mmap2(const struct perf_tool *tool,
586 union perf_event *event,
587 struct perf_sample *sample,
588 struct machine *machine)
591 struct dso_id *dso_id = NULL;
593 if (!(event->header.misc & PERF_RECORD_MISC_MMAP_BUILD_ID)) {
594 id.maj = event->mmap2.maj;
595 id.min = event->mmap2.min;
596 id.ino = event->mmap2.ino;
597 id.ino_generation = event->mmap2.ino_generation;
601 return perf_event__repipe_common_mmap(
602 tool, event, sample, machine,
603 event->mmap2.pid, event->mmap2.tid,
604 event->mmap2.start, event->mmap2.len, event->mmap2.pgoff,
605 event->mmap2.flags, event->mmap2.prot,
606 event->mmap2.filename, dso_id,
607 perf_event__process_mmap2);
610 static int perf_event__repipe_fork(const struct perf_tool *tool,
611 union perf_event *event,
612 struct perf_sample *sample,
613 struct machine *machine)
617 err = perf_event__process_fork(tool, event, sample, machine);
618 perf_event__repipe(tool, event, sample, machine);
623 static int perf_event__repipe_comm(const struct perf_tool *tool,
624 union perf_event *event,
625 struct perf_sample *sample,
626 struct machine *machine)
630 err = perf_event__process_comm(tool, event, sample, machine);
631 perf_event__repipe(tool, event, sample, machine);
636 static int perf_event__repipe_namespaces(const struct perf_tool *tool,
637 union perf_event *event,
638 struct perf_sample *sample,
639 struct machine *machine)
641 int err = perf_event__process_namespaces(tool, event, sample, machine);
643 perf_event__repipe(tool, event, sample, machine);
648 static int perf_event__repipe_exit(const struct perf_tool *tool,
649 union perf_event *event,
650 struct perf_sample *sample,
651 struct machine *machine)
655 err = perf_event__process_exit(tool, event, sample, machine);
656 perf_event__repipe(tool, event, sample, machine);
661 #ifdef HAVE_LIBTRACEEVENT
662 static int perf_event__repipe_tracing_data(struct perf_session *session,
663 union perf_event *event)
665 perf_event__repipe_synth(session->tool, event);
667 return perf_event__process_tracing_data(session, event);
671 static int dso__read_build_id(struct dso *dso)
675 if (dso__has_build_id(dso))
678 mutex_lock(dso__lock(dso));
679 nsinfo__mountns_enter(dso__nsinfo(dso), &nsc);
680 if (filename__read_build_id(dso__long_name(dso), dso__bid(dso)) > 0)
681 dso__set_has_build_id(dso);
682 else if (dso__nsinfo(dso)) {
683 char *new_name = dso__filename_with_chroot(dso, dso__long_name(dso));
685 if (new_name && filename__read_build_id(new_name, dso__bid(dso)) > 0)
686 dso__set_has_build_id(dso);
689 nsinfo__mountns_exit(&nsc);
690 mutex_unlock(dso__lock(dso));
692 return dso__has_build_id(dso) ? 0 : -1;
695 static struct strlist *perf_inject__parse_known_build_ids(
696 const char *known_build_ids_string)
698 struct str_node *pos, *tmp;
699 struct strlist *known_build_ids;
702 known_build_ids = strlist__new(known_build_ids_string, NULL);
703 if (known_build_ids == NULL)
705 strlist__for_each_entry_safe(pos, tmp, known_build_ids) {
706 const char *build_id, *dso_name;
708 build_id = skip_spaces(pos->s);
709 dso_name = strchr(build_id, ' ');
710 if (dso_name == NULL) {
711 strlist__remove(known_build_ids, pos);
714 bid_len = dso_name - pos->s;
715 dso_name = skip_spaces(dso_name);
716 if (bid_len % 2 != 0 || bid_len >= SBUILD_ID_SIZE) {
717 strlist__remove(known_build_ids, pos);
720 for (int ix = 0; 2 * ix + 1 < bid_len; ++ix) {
721 if (!isxdigit(build_id[2 * ix]) ||
722 !isxdigit(build_id[2 * ix + 1])) {
723 strlist__remove(known_build_ids, pos);
728 return known_build_ids;
731 static bool perf_inject__lookup_known_build_id(struct perf_inject *inject,
734 struct str_node *pos;
737 strlist__for_each_entry(pos, inject->known_build_ids) {
738 const char *build_id, *dso_name;
740 build_id = skip_spaces(pos->s);
741 dso_name = strchr(build_id, ' ');
742 bid_len = dso_name - pos->s;
743 dso_name = skip_spaces(dso_name);
744 if (strcmp(dso__long_name(dso), dso_name))
746 for (int ix = 0; 2 * ix + 1 < bid_len; ++ix) {
747 dso__bid(dso)->data[ix] = (hex(build_id[2 * ix]) << 4 |
748 hex(build_id[2 * ix + 1]));
750 dso__bid(dso)->size = bid_len / 2;
751 dso__set_has_build_id(dso);
757 static int tool__inject_build_id(const struct perf_tool *tool,
758 struct perf_sample *sample,
759 struct machine *machine,
760 const struct evsel *evsel,
762 const char *filename,
763 struct dso *dso, u32 flags)
765 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
768 if (is_anon_memory(filename) || flags & MAP_HUGETLB)
770 if (is_no_dso_memory(filename))
773 if (inject->known_build_ids != NULL &&
774 perf_inject__lookup_known_build_id(inject, dso))
777 if (dso__read_build_id(dso) < 0) {
778 pr_debug("no build_id found for %s\n", filename);
782 err = perf_event__synthesize_build_id(tool, sample, machine,
784 evsel, misc, dso__bid(dso),
787 pr_err("Can't synthesize build_id event for %s\n", filename);
794 static int tool__inject_mmap2_build_id(const struct perf_tool *tool,
795 struct perf_sample *sample,
796 struct machine *machine,
797 const struct evsel *evsel,
799 __u32 pid, __u32 tid,
800 __u64 start, __u64 len, __u64 pgoff,
802 __u32 prot, __u32 flags,
803 const char *filename)
807 /* Return to repipe anonymous maps. */
808 if (is_anon_memory(filename) || flags & MAP_HUGETLB)
810 if (is_no_dso_memory(filename))
813 if (dso__read_build_id(dso)) {
814 pr_debug("no build_id found for %s\n", filename);
818 err = perf_event__synthesize_mmap2_build_id(tool, sample, machine,
827 pr_err("Can't synthesize build_id event for %s\n", filename);
833 static int mark_dso_hit(const struct perf_inject *inject,
834 const struct perf_tool *tool,
835 struct perf_sample *sample,
836 struct machine *machine,
837 const struct evsel *mmap_evsel,
838 struct map *map, bool sample_in_dso)
841 u16 misc = sample->cpumode;
846 if (!sample_in_dso) {
847 u16 guest_mask = PERF_RECORD_MISC_GUEST_KERNEL |
848 PERF_RECORD_MISC_GUEST_USER;
850 if ((misc & guest_mask) != 0) {
851 misc &= PERF_RECORD_MISC_HYPERVISOR;
852 misc |= __map__is_kernel(map)
853 ? PERF_RECORD_MISC_GUEST_KERNEL
854 : PERF_RECORD_MISC_GUEST_USER;
856 misc &= PERF_RECORD_MISC_HYPERVISOR;
857 misc |= __map__is_kernel(map)
858 ? PERF_RECORD_MISC_KERNEL
859 : PERF_RECORD_MISC_USER;
863 if (inject->build_id_style == BID_RWS__INJECT_HEADER_LAZY) {
864 if (dso && !dso__hit(dso)) {
866 tool__inject_build_id(tool, sample, machine,
867 mmap_evsel, misc, dso__long_name(dso), dso,
870 } else if (inject->build_id_style == BID_RWS__MMAP2_BUILDID_LAZY) {
871 if (!map__hit(map)) {
872 const struct build_id null_bid = { .size = 0 };
873 const struct build_id *bid = dso ? dso__bid(dso) : &null_bid;
874 const char *filename = dso ? dso__long_name(dso) : "";
877 perf_event__synthesize_mmap2_build_id(tool, sample, machine,
881 sample->pid, sample->tid,
883 map__end(map) - map__start(map),
894 struct mark_dso_hit_args {
895 const struct perf_inject *inject;
896 const struct perf_tool *tool;
897 struct perf_sample *sample;
898 struct machine *machine;
899 const struct evsel *mmap_evsel;
902 static int mark_dso_hit_callback(struct callchain_cursor_node *node, void *data)
904 struct mark_dso_hit_args *args = data;
905 struct map *map = node->ms.map;
907 return mark_dso_hit(args->inject, args->tool, args->sample, args->machine,
908 args->mmap_evsel, map, /*sample_in_dso=*/false);
911 int perf_event__inject_buildid(const struct perf_tool *tool, union perf_event *event,
912 struct perf_sample *sample,
913 struct evsel *evsel __maybe_unused,
914 struct machine *machine)
916 struct addr_location al;
917 struct thread *thread;
918 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
919 struct mark_dso_hit_args args = {
923 * Use the parsed sample data of the sample event, which will
924 * have a later timestamp than the mmap event.
928 .mmap_evsel = inject__mmap_evsel(inject),
931 addr_location__init(&al);
932 thread = machine__findnew_thread(machine, sample->pid, sample->tid);
933 if (thread == NULL) {
934 pr_err("problem processing %d event, skipping it.\n",
939 if (thread__find_map(thread, sample->cpumode, sample->ip, &al)) {
940 mark_dso_hit(inject, tool, sample, machine, args.mmap_evsel, al.map,
941 /*sample_in_dso=*/true);
944 sample__for_each_callchain_node(thread, evsel, sample, PERF_MAX_STACK_DEPTH,
945 /*symbols=*/false, mark_dso_hit_callback, &args);
949 perf_event__repipe(tool, event, sample, machine);
950 addr_location__exit(&al);
954 static int perf_inject__sched_process_exit(const struct perf_tool *tool,
955 union perf_event *event __maybe_unused,
956 struct perf_sample *sample,
957 struct evsel *evsel __maybe_unused,
958 struct machine *machine __maybe_unused)
960 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
961 struct event_entry *ent;
963 list_for_each_entry(ent, &inject->samples, node) {
964 if (sample->tid == ent->tid) {
965 list_del_init(&ent->node);
974 static int perf_inject__sched_switch(const struct perf_tool *tool,
975 union perf_event *event,
976 struct perf_sample *sample,
978 struct machine *machine)
980 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
981 struct event_entry *ent;
983 perf_inject__sched_process_exit(tool, event, sample, evsel, machine);
985 ent = malloc(event->header.size + sizeof(struct event_entry));
987 color_fprintf(stderr, PERF_COLOR_RED,
988 "Not enough memory to process sched switch event!");
992 ent->tid = sample->tid;
993 memcpy(&ent->event, event, event->header.size);
994 list_add(&ent->node, &inject->samples);
998 #ifdef HAVE_LIBTRACEEVENT
999 static int perf_inject__sched_stat(const struct perf_tool *tool,
1000 union perf_event *event __maybe_unused,
1001 struct perf_sample *sample,
1002 struct evsel *evsel,
1003 struct machine *machine)
1005 struct event_entry *ent;
1006 union perf_event *event_sw;
1007 struct perf_sample sample_sw;
1008 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
1009 u32 pid = evsel__intval(evsel, sample, "pid");
1011 list_for_each_entry(ent, &inject->samples, node) {
1012 if (pid == ent->tid)
1018 event_sw = &ent->event[0];
1019 evsel__parse_sample(evsel, event_sw, &sample_sw);
1021 sample_sw.period = sample->period;
1022 sample_sw.time = sample->time;
1023 perf_event__synthesize_sample(event_sw, evsel->core.attr.sample_type,
1024 evsel->core.attr.read_format, &sample_sw);
1025 build_id__mark_dso_hit(tool, event_sw, &sample_sw, evsel, machine);
1026 return perf_event__repipe(tool, event_sw, &sample_sw, machine);
1030 static struct guest_vcpu *guest_session__vcpu(struct guest_session *gs, u32 vcpu)
1032 if (realloc_array_as_needed(gs->vcpu, gs->vcpu_cnt, vcpu, NULL))
1034 return &gs->vcpu[vcpu];
1037 static int guest_session__output_bytes(struct guest_session *gs, void *buf, size_t sz)
1039 ssize_t ret = writen(gs->tmp_fd, buf, sz);
1041 return ret < 0 ? ret : 0;
1044 static int guest_session__repipe(const struct perf_tool *tool,
1045 union perf_event *event,
1046 struct perf_sample *sample __maybe_unused,
1047 struct machine *machine __maybe_unused)
1049 struct guest_session *gs = container_of(tool, struct guest_session, tool);
1051 return guest_session__output_bytes(gs, event, event->header.size);
1054 static int guest_session__map_tid(struct guest_session *gs, u32 tid, u32 vcpu)
1056 struct guest_tid *guest_tid = zalloc(sizeof(*guest_tid));
1062 guest_tid->tid = tid;
1063 guest_tid->vcpu = vcpu;
1064 hash = hash_32(guest_tid->tid, PERF_EVLIST__HLIST_BITS);
1065 hlist_add_head(&guest_tid->node, &gs->tids[hash]);
1070 static int host_peek_vm_comms_cb(struct perf_session *session __maybe_unused,
1071 union perf_event *event,
1072 u64 offset __maybe_unused, void *data)
1074 struct guest_session *gs = data;
1076 struct guest_vcpu *guest_vcpu;
1079 if (event->header.type != PERF_RECORD_COMM ||
1080 event->comm.pid != gs->machine_pid)
1084 * QEMU option -name debug-threads=on, causes thread names formatted as
1085 * below, although it is not an ABI. Also libvirt seems to use this by
1086 * default. Here we rely on it to tell us which thread is which VCPU.
1088 ret = sscanf(event->comm.comm, "CPU %u/KVM", &vcpu);
1091 pr_debug("Found VCPU: tid %u comm %s vcpu %u\n",
1092 event->comm.tid, event->comm.comm, vcpu);
1093 if (vcpu > INT_MAX) {
1094 pr_err("Invalid VCPU %u\n", vcpu);
1097 guest_vcpu = guest_session__vcpu(gs, vcpu);
1100 if (guest_vcpu->tid && guest_vcpu->tid != event->comm.tid) {
1101 pr_err("Fatal error: Two threads found with the same VCPU\n");
1104 guest_vcpu->tid = event->comm.tid;
1106 return guest_session__map_tid(gs, event->comm.tid, vcpu);
1109 static int host_peek_vm_comms(struct perf_session *session, struct guest_session *gs)
1111 return perf_session__peek_events(session, session->header.data_offset,
1112 session->header.data_size,
1113 host_peek_vm_comms_cb, gs);
1116 static bool evlist__is_id_used(struct evlist *evlist, u64 id)
1118 return evlist__id2sid(evlist, id);
1121 static u64 guest_session__allocate_new_id(struct guest_session *gs, struct evlist *host_evlist)
1124 gs->highest_id += 1;
1125 } while (!gs->highest_id || evlist__is_id_used(host_evlist, gs->highest_id));
1127 return gs->highest_id;
1130 static int guest_session__map_id(struct guest_session *gs, u64 id, u64 host_id, u32 vcpu)
1132 struct guest_id *guest_id = zalloc(sizeof(*guest_id));
1139 guest_id->host_id = host_id;
1140 guest_id->vcpu = vcpu;
1141 hash = hash_64(guest_id->id, PERF_EVLIST__HLIST_BITS);
1142 hlist_add_head(&guest_id->node, &gs->heads[hash]);
1147 static u64 evlist__find_highest_id(struct evlist *evlist)
1149 struct evsel *evsel;
1152 evlist__for_each_entry(evlist, evsel) {
1155 for (j = 0; j < evsel->core.ids; j++) {
1156 u64 id = evsel->core.id[j];
1158 if (id > highest_id)
1166 static int guest_session__map_ids(struct guest_session *gs, struct evlist *host_evlist)
1168 struct evlist *evlist = gs->session->evlist;
1169 struct evsel *evsel;
1172 evlist__for_each_entry(evlist, evsel) {
1175 for (j = 0; j < evsel->core.ids; j++) {
1176 struct perf_sample_id *sid;
1180 id = evsel->core.id[j];
1181 sid = evlist__id2sid(evlist, id);
1182 if (!sid || sid->cpu.cpu == -1)
1184 host_id = guest_session__allocate_new_id(gs, host_evlist);
1185 ret = guest_session__map_id(gs, id, host_id, sid->cpu.cpu);
1194 static struct guest_id *guest_session__lookup_id(struct guest_session *gs, u64 id)
1196 struct hlist_head *head;
1197 struct guest_id *guest_id;
1200 hash = hash_64(id, PERF_EVLIST__HLIST_BITS);
1201 head = &gs->heads[hash];
1203 hlist_for_each_entry(guest_id, head, node)
1204 if (guest_id->id == id)
1210 static int process_attr(const struct perf_tool *tool, union perf_event *event,
1211 struct perf_sample *sample __maybe_unused,
1212 struct machine *machine __maybe_unused)
1214 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
1216 return perf_event__process_attr(tool, event, &inject->session->evlist);
1219 static int guest_session__add_attr(struct guest_session *gs, struct evsel *evsel)
1221 struct perf_inject *inject = container_of(gs, struct perf_inject, guest_session);
1222 struct perf_event_attr attr = evsel->core.attr;
1228 id_array = calloc(evsel->core.ids, sizeof(*id_array));
1232 vcpu_array = calloc(evsel->core.ids, sizeof(*vcpu_array));
1236 for (i = 0; i < evsel->core.ids; i++) {
1237 u64 id = evsel->core.id[i];
1238 struct guest_id *guest_id = guest_session__lookup_id(gs, id);
1241 pr_err("Failed to find guest id %"PRIu64"\n", id);
1245 id_array[i] = guest_id->host_id;
1246 vcpu_array[i] = guest_id->vcpu;
1249 attr.sample_type |= PERF_SAMPLE_IDENTIFIER;
1250 attr.exclude_host = 1;
1251 attr.exclude_guest = 0;
1253 ret = perf_event__synthesize_attr(&inject->tool, &attr, evsel->core.ids,
1254 id_array, process_attr);
1256 pr_err("Failed to add guest attr.\n");
1258 for (i = 0; i < evsel->core.ids; i++) {
1259 struct perf_sample_id *sid;
1260 u32 vcpu = vcpu_array[i];
1262 sid = evlist__id2sid(inject->session->evlist, id_array[i]);
1263 /* Guest event is per-thread from the host point of view */
1265 sid->tid = gs->vcpu[vcpu].tid;
1266 sid->machine_pid = gs->machine_pid;
1267 sid->vcpu.cpu = vcpu;
1275 static int guest_session__add_attrs(struct guest_session *gs)
1277 struct evlist *evlist = gs->session->evlist;
1278 struct evsel *evsel;
1281 evlist__for_each_entry(evlist, evsel) {
1282 ret = guest_session__add_attr(gs, evsel);
1290 static int synthesize_id_index(struct perf_inject *inject, size_t new_cnt)
1292 struct perf_session *session = inject->session;
1293 struct evlist *evlist = session->evlist;
1294 struct machine *machine = &session->machines.host;
1295 size_t from = evlist->core.nr_entries - new_cnt;
1297 return __perf_event__synthesize_id_index(&inject->tool, perf_event__repipe,
1298 evlist, machine, from);
1301 static struct guest_tid *guest_session__lookup_tid(struct guest_session *gs, u32 tid)
1303 struct hlist_head *head;
1304 struct guest_tid *guest_tid;
1307 hash = hash_32(tid, PERF_EVLIST__HLIST_BITS);
1308 head = &gs->tids[hash];
1310 hlist_for_each_entry(guest_tid, head, node)
1311 if (guest_tid->tid == tid)
1317 static bool dso__is_in_kernel_space(struct dso *dso)
1319 if (dso__is_vdso(dso))
1322 return dso__is_kcore(dso) ||
1324 is_kernel_module(dso__long_name(dso), PERF_RECORD_MISC_CPUMODE_UNKNOWN);
1327 static u64 evlist__first_id(struct evlist *evlist)
1329 struct evsel *evsel;
1331 evlist__for_each_entry(evlist, evsel) {
1332 if (evsel->core.ids)
1333 return evsel->core.id[0];
1338 static int process_build_id(const struct perf_tool *tool,
1339 union perf_event *event,
1340 struct perf_sample *sample __maybe_unused,
1341 struct machine *machine __maybe_unused)
1343 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
1345 return perf_event__process_build_id(inject->session, event);
1348 static int synthesize_build_id(struct perf_inject *inject, struct dso *dso, pid_t machine_pid)
1350 struct machine *machine = perf_session__findnew_machine(inject->session, machine_pid);
1351 struct perf_sample synth_sample = {
1358 .cpumode = dso__is_in_kernel_space(dso)
1359 ? PERF_RECORD_MISC_GUEST_KERNEL
1360 : PERF_RECORD_MISC_GUEST_USER,
1368 return perf_event__synthesize_build_id(&inject->tool, &synth_sample, machine,
1369 process_build_id, inject__mmap_evsel(inject),
1370 /*misc=*/synth_sample.cpumode,
1371 dso__bid(dso), dso__long_name(dso));
1374 static int guest_session__add_build_ids_cb(struct dso *dso, void *data)
1376 struct guest_session *gs = data;
1377 struct perf_inject *inject = container_of(gs, struct perf_inject, guest_session);
1379 if (!dso__has_build_id(dso))
1382 return synthesize_build_id(inject, dso, gs->machine_pid);
1386 static int guest_session__add_build_ids(struct guest_session *gs)
1388 struct perf_inject *inject = container_of(gs, struct perf_inject, guest_session);
1390 /* Build IDs will be put in the Build ID feature section */
1391 perf_header__set_feat(&inject->session->header, HEADER_BUILD_ID);
1393 return dsos__for_each_dso(&gs->session->machines.host.dsos,
1394 guest_session__add_build_ids_cb,
1398 static int guest_session__ksymbol_event(const struct perf_tool *tool,
1399 union perf_event *event,
1400 struct perf_sample *sample __maybe_unused,
1401 struct machine *machine __maybe_unused)
1403 struct guest_session *gs = container_of(tool, struct guest_session, tool);
1405 /* Only support out-of-line i.e. no BPF support */
1406 if (event->ksymbol.ksym_type != PERF_RECORD_KSYMBOL_TYPE_OOL)
1409 return guest_session__output_bytes(gs, event, event->header.size);
1412 static int guest_session__start(struct guest_session *gs, const char *name, bool force)
1414 char tmp_file_name[] = "/tmp/perf-inject-guest_session-XXXXXX";
1415 struct perf_session *session;
1418 /* Only these events will be injected */
1419 gs->tool.mmap = guest_session__repipe;
1420 gs->tool.mmap2 = guest_session__repipe;
1421 gs->tool.comm = guest_session__repipe;
1422 gs->tool.fork = guest_session__repipe;
1423 gs->tool.exit = guest_session__repipe;
1424 gs->tool.lost = guest_session__repipe;
1425 gs->tool.context_switch = guest_session__repipe;
1426 gs->tool.ksymbol = guest_session__ksymbol_event;
1427 gs->tool.text_poke = guest_session__repipe;
1429 * Processing a build ID creates a struct dso with that build ID. Later,
1430 * all guest dsos are iterated and the build IDs processed into the host
1431 * session where they will be output to the Build ID feature section
1432 * when the perf.data file header is written.
1434 gs->tool.build_id = perf_event__process_build_id;
1435 /* Process the id index to know what VCPU an ID belongs to */
1436 gs->tool.id_index = perf_event__process_id_index;
1438 gs->tool.ordered_events = true;
1439 gs->tool.ordering_requires_timestamps = true;
1441 gs->data.path = name;
1442 gs->data.force = force;
1443 gs->data.mode = PERF_DATA_MODE_READ;
1445 session = perf_session__new(&gs->data, &gs->tool);
1446 if (IS_ERR(session))
1447 return PTR_ERR(session);
1448 gs->session = session;
1451 * Initial events have zero'd ID samples. Get default ID sample size
1452 * used for removing them.
1454 gs->dflt_id_hdr_size = session->machines.host.id_hdr_size;
1455 /* And default ID for adding back a host-compatible ID sample */
1456 gs->dflt_id = evlist__first_id(session->evlist);
1458 pr_err("Guest data has no sample IDs");
1462 /* Temporary file for guest events */
1463 gs->tmp_file_name = strdup(tmp_file_name);
1464 if (!gs->tmp_file_name)
1466 gs->tmp_fd = mkstemp(gs->tmp_file_name);
1470 if (zstd_init(&gs->session->zstd_data, 0) < 0)
1471 pr_warning("Guest session decompression initialization failed.\n");
1474 * perf does not support processing 2 sessions simultaneously, so output
1475 * guest events to a temporary file.
1477 ret = perf_session__process_events(gs->session);
1481 if (lseek(gs->tmp_fd, 0, SEEK_SET))
1487 /* Free hlist nodes assuming hlist_node is the first member of hlist entries */
1488 static void free_hlist(struct hlist_head *heads, size_t hlist_sz)
1490 struct hlist_node *pos, *n;
1493 for (i = 0; i < hlist_sz; ++i) {
1494 hlist_for_each_safe(pos, n, &heads[i]) {
1501 static void guest_session__exit(struct guest_session *gs)
1504 perf_session__delete(gs->session);
1505 free_hlist(gs->heads, PERF_EVLIST__HLIST_SIZE);
1506 free_hlist(gs->tids, PERF_EVLIST__HLIST_SIZE);
1508 if (gs->tmp_file_name) {
1509 if (gs->tmp_fd >= 0)
1511 unlink(gs->tmp_file_name);
1512 zfree(&gs->tmp_file_name);
1515 zfree(&gs->perf_data_file);
1518 static void get_tsc_conv(struct perf_tsc_conversion *tc, struct perf_record_time_conv *time_conv)
1520 tc->time_shift = time_conv->time_shift;
1521 tc->time_mult = time_conv->time_mult;
1522 tc->time_zero = time_conv->time_zero;
1523 tc->time_cycles = time_conv->time_cycles;
1524 tc->time_mask = time_conv->time_mask;
1525 tc->cap_user_time_zero = time_conv->cap_user_time_zero;
1526 tc->cap_user_time_short = time_conv->cap_user_time_short;
1529 static void guest_session__get_tc(struct guest_session *gs)
1531 struct perf_inject *inject = container_of(gs, struct perf_inject, guest_session);
1533 get_tsc_conv(&gs->host_tc, &inject->session->time_conv);
1534 get_tsc_conv(&gs->guest_tc, &gs->session->time_conv);
1537 static void guest_session__convert_time(struct guest_session *gs, u64 guest_time, u64 *host_time)
1546 if (gs->guest_tc.cap_user_time_zero)
1547 tsc = perf_time_to_tsc(guest_time, &gs->guest_tc);
1552 * This is the correct order of operations for x86 if the TSC Offset and
1553 * Multiplier values are used.
1555 tsc -= gs->time_offset;
1556 tsc /= gs->time_scale;
1558 if (gs->host_tc.cap_user_time_zero)
1559 *host_time = tsc_to_perf_time(tsc, &gs->host_tc);
1564 static int guest_session__fetch(struct guest_session *gs)
1567 struct perf_event_header *hdr;
1568 size_t hdr_sz = sizeof(*hdr);
1571 buf = gs->ev.event_buf;
1573 buf = malloc(PERF_SAMPLE_MAX_SIZE);
1576 gs->ev.event_buf = buf;
1579 ret = readn(gs->tmp_fd, buf, hdr_sz);
1584 /* Zero size means EOF */
1591 ret = readn(gs->tmp_fd, buf, hdr->size - hdr_sz);
1595 gs->ev.event = (union perf_event *)gs->ev.event_buf;
1596 gs->ev.sample.time = 0;
1598 if (hdr->type >= PERF_RECORD_USER_TYPE_START) {
1599 pr_err("Unexpected type fetching guest event");
1603 ret = evlist__parse_sample(gs->session->evlist, gs->ev.event, &gs->ev.sample);
1605 pr_err("Parse failed fetching guest event");
1610 guest_session__get_tc(gs);
1614 guest_session__convert_time(gs, gs->ev.sample.time, &gs->ev.sample.time);
1619 static int evlist__append_id_sample(struct evlist *evlist, union perf_event *ev,
1620 const struct perf_sample *sample)
1622 struct evsel *evsel;
1626 evsel = evlist__id2evsel(evlist, sample->id);
1630 pr_err("No evsel for id %"PRIu64"\n", sample->id);
1634 array += ev->header.size;
1635 ret = perf_event__synthesize_id_sample(array, evsel->core.attr.sample_type, sample);
1640 pr_err("Bad id sample size %d\n", ret);
1644 ev->header.size += ret;
1649 static int guest_session__inject_events(struct guest_session *gs, u64 timestamp)
1651 struct perf_inject *inject = container_of(gs, struct perf_inject, guest_session);
1658 struct perf_sample *sample;
1659 struct guest_id *guest_id;
1660 union perf_event *ev;
1666 ret = guest_session__fetch(gs);
1673 sample = &gs->ev.sample;
1675 if (!ev->header.size)
1678 if (sample->time > timestamp)
1681 /* Change cpumode to guest */
1682 cpumode = ev->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
1683 if (cpumode & PERF_RECORD_MISC_USER)
1684 cpumode = PERF_RECORD_MISC_GUEST_USER;
1686 cpumode = PERF_RECORD_MISC_GUEST_KERNEL;
1687 ev->header.misc &= ~PERF_RECORD_MISC_CPUMODE_MASK;
1688 ev->header.misc |= cpumode;
1693 id_hdr_size = gs->dflt_id_hdr_size;
1695 struct evsel *evsel = evlist__id2evsel(gs->session->evlist, id);
1697 id_hdr_size = evsel__id_hdr_size(evsel);
1700 if (id_hdr_size & 7) {
1701 pr_err("Bad id_hdr_size %u\n", id_hdr_size);
1705 if (ev->header.size & 7) {
1706 pr_err("Bad event size %u\n", ev->header.size);
1710 /* Remove guest id sample */
1711 ev->header.size -= id_hdr_size;
1713 if (ev->header.size & 7) {
1714 pr_err("Bad raw event size %u\n", ev->header.size);
1718 guest_id = guest_session__lookup_id(gs, id);
1720 pr_err("Guest event with unknown id %llu\n",
1721 (unsigned long long)id);
1725 /* Change to host ID to avoid conflicting ID values */
1726 sample->id = guest_id->host_id;
1727 sample->stream_id = guest_id->host_id;
1729 if (sample->cpu != (u32)-1) {
1730 if (sample->cpu >= gs->vcpu_cnt) {
1731 pr_err("Guest event with unknown VCPU %u\n",
1735 /* Change to host CPU instead of guest VCPU */
1736 sample->cpu = gs->vcpu[sample->cpu].cpu;
1739 /* New id sample with new ID and CPU */
1740 ret = evlist__append_id_sample(inject->session->evlist, ev, sample);
1744 if (ev->header.size & 7) {
1745 pr_err("Bad new event size %u\n", ev->header.size);
1749 gs->fetched = false;
1751 ret = output_bytes(inject, ev, ev->header.size);
1757 static int guest_session__flush_events(struct guest_session *gs)
1759 return guest_session__inject_events(gs, -1);
1762 static int host__repipe(const struct perf_tool *tool,
1763 union perf_event *event,
1764 struct perf_sample *sample,
1765 struct machine *machine)
1767 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
1770 ret = guest_session__inject_events(&inject->guest_session, sample->time);
1774 return perf_event__repipe(tool, event, sample, machine);
1777 static int host__finished_init(struct perf_session *session, union perf_event *event)
1779 struct perf_inject *inject = container_of(session->tool, struct perf_inject, tool);
1780 struct guest_session *gs = &inject->guest_session;
1784 * Peek through host COMM events to find QEMU threads and the VCPU they
1787 ret = host_peek_vm_comms(session, gs);
1791 if (!gs->vcpu_cnt) {
1792 pr_err("No VCPU threads found for pid %u\n", gs->machine_pid);
1797 * Allocate new (unused) host sample IDs and map them to the guest IDs.
1799 gs->highest_id = evlist__find_highest_id(session->evlist);
1800 ret = guest_session__map_ids(gs, session->evlist);
1804 ret = guest_session__add_attrs(gs);
1808 ret = synthesize_id_index(inject, gs->session->evlist->core.nr_entries);
1810 pr_err("Failed to synthesize id_index\n");
1814 ret = guest_session__add_build_ids(gs);
1816 pr_err("Failed to add guest build IDs\n");
1822 ret = guest_session__inject_events(gs, 0);
1826 return perf_event__repipe_op2_synth(session, event);
1830 * Obey finished-round ordering. The FINISHED_ROUND event is first processed
1831 * which flushes host events to file up until the last flush time. Then inject
1832 * guest events up to the same time. Finally write out the FINISHED_ROUND event
1835 static int host__finished_round(const struct perf_tool *tool,
1836 union perf_event *event,
1837 struct ordered_events *oe)
1839 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
1840 int ret = perf_event__process_finished_round(tool, event, oe);
1841 u64 timestamp = ordered_events__last_flush_time(oe);
1846 ret = guest_session__inject_events(&inject->guest_session, timestamp);
1850 return perf_event__repipe_oe_synth(tool, event, oe);
1853 static int host__context_switch(const struct perf_tool *tool,
1854 union perf_event *event,
1855 struct perf_sample *sample,
1856 struct machine *machine)
1858 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
1859 bool out = event->header.misc & PERF_RECORD_MISC_SWITCH_OUT;
1860 struct guest_session *gs = &inject->guest_session;
1861 u32 pid = event->context_switch.next_prev_pid;
1862 u32 tid = event->context_switch.next_prev_tid;
1863 struct guest_tid *guest_tid;
1866 if (out || pid != gs->machine_pid)
1869 guest_tid = guest_session__lookup_tid(gs, tid);
1873 if (sample->cpu == (u32)-1) {
1874 pr_err("Switch event does not have CPU\n");
1878 vcpu = guest_tid->vcpu;
1879 if (vcpu >= gs->vcpu_cnt)
1882 /* Guest is switching in, record which CPU the VCPU is now running on */
1883 gs->vcpu[vcpu].cpu = sample->cpu;
1885 return host__repipe(tool, event, sample, machine);
1888 static void sig_handler(int sig __maybe_unused)
1893 static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg)
1895 struct perf_event_attr *attr = &evsel->core.attr;
1896 const char *name = evsel__name(evsel);
1898 if (!(attr->sample_type & sample_type)) {
1899 pr_err("Samples for %s event do not have %s attribute set.",
1907 static int drop_sample(const struct perf_tool *tool __maybe_unused,
1908 union perf_event *event __maybe_unused,
1909 struct perf_sample *sample __maybe_unused,
1910 struct evsel *evsel __maybe_unused,
1911 struct machine *machine __maybe_unused)
1916 static void strip_init(struct perf_inject *inject)
1918 struct evlist *evlist = inject->session->evlist;
1919 struct evsel *evsel;
1921 inject->tool.context_switch = perf_event__drop;
1923 evlist__for_each_entry(evlist, evsel)
1924 evsel->handler = drop_sample;
1927 static int parse_vm_time_correlation(const struct option *opt, const char *str, int unset)
1929 struct perf_inject *inject = opt->value;
1936 inject->itrace_synth_opts.set = true;
1937 inject->itrace_synth_opts.vm_time_correlation = true;
1938 inject->in_place_update = true;
1943 dry_run = skip_spaces(str);
1944 if (!strncmp(dry_run, "dry-run", strlen("dry-run"))) {
1945 inject->itrace_synth_opts.vm_tm_corr_dry_run = true;
1946 inject->in_place_update_dry_run = true;
1947 args = dry_run + strlen("dry-run");
1952 inject->itrace_synth_opts.vm_tm_corr_args = strdup(args);
1954 return inject->itrace_synth_opts.vm_tm_corr_args ? 0 : -ENOMEM;
1957 static int parse_guest_data(const struct option *opt, const char *str, int unset)
1959 struct perf_inject *inject = opt->value;
1960 struct guest_session *gs = &inject->guest_session;
1974 gs->perf_data_file = strsep(&s, ",");
1975 if (!gs->perf_data_file)
1978 gs->copy_kcore_dir = has_kcore_dir(gs->perf_data_file);
1979 if (gs->copy_kcore_dir)
1980 inject->output.is_dir = true;
1982 tok = strsep(&s, ",");
1985 gs->machine_pid = strtoul(tok, NULL, 0);
1986 if (!inject->guest_session.machine_pid)
1991 tok = strsep(&s, ",");
1994 gs->time_offset = strtoull(tok, NULL, 0);
1996 tok = strsep(&s, ",");
1999 gs->time_scale = strtod(tok, NULL);
2000 if (!gs->time_scale)
2006 pr_err("--guest-data option requires guest perf.data file name, "
2007 "guest machine PID, and optionally guest timestamp offset, "
2008 "and guest timestamp scale factor, separated by commas.\n");
2012 static int save_section_info_cb(struct perf_file_section *section,
2013 struct perf_header *ph __maybe_unused,
2014 int feat, int fd __maybe_unused, void *data)
2016 struct perf_inject *inject = data;
2018 inject->secs[feat] = *section;
2022 static int save_section_info(struct perf_inject *inject)
2024 struct perf_header *header = &inject->session->header;
2025 int fd = perf_data__fd(inject->session->data);
2027 return perf_header__process_sections(header, fd, inject, save_section_info_cb);
2030 static bool keep_feat(int feat)
2033 /* Keep original information that describes the machine or software */
2034 case HEADER_TRACING_DATA:
2035 case HEADER_HOSTNAME:
2036 case HEADER_OSRELEASE:
2037 case HEADER_VERSION:
2040 case HEADER_CPUDESC:
2042 case HEADER_TOTAL_MEM:
2043 case HEADER_CPU_TOPOLOGY:
2044 case HEADER_NUMA_TOPOLOGY:
2045 case HEADER_PMU_MAPPINGS:
2047 case HEADER_MEM_TOPOLOGY:
2048 case HEADER_CLOCKID:
2049 case HEADER_BPF_PROG_INFO:
2050 case HEADER_BPF_BTF:
2051 case HEADER_CPU_PMU_CAPS:
2052 case HEADER_CLOCK_DATA:
2053 case HEADER_HYBRID_TOPOLOGY:
2054 case HEADER_PMU_CAPS:
2056 /* Information that can be updated */
2057 case HEADER_BUILD_ID:
2058 case HEADER_CMDLINE:
2059 case HEADER_EVENT_DESC:
2060 case HEADER_BRANCH_STACK:
2061 case HEADER_GROUP_DESC:
2062 case HEADER_AUXTRACE:
2064 case HEADER_SAMPLE_TIME:
2065 case HEADER_DIR_FORMAT:
2066 case HEADER_COMPRESSED:
2072 static int read_file(int fd, u64 offs, void *buf, size_t sz)
2074 ssize_t ret = preadn(fd, buf, sz, offs);
2078 if ((size_t)ret != sz)
2083 static int feat_copy(struct perf_inject *inject, int feat, struct feat_writer *fw)
2085 int fd = perf_data__fd(inject->session->data);
2086 u64 offs = inject->secs[feat].offset;
2087 size_t sz = inject->secs[feat].size;
2088 void *buf = malloc(sz);
2094 ret = read_file(fd, offs, buf, sz);
2098 ret = fw->write(fw, buf, sz);
2105 struct feat_copier fc;
2106 struct perf_inject *inject;
2109 static int feat_copy_cb(struct feat_copier *fc, int feat, struct feat_writer *fw)
2111 struct inject_fc *inj_fc = container_of(fc, struct inject_fc, fc);
2112 struct perf_inject *inject = inj_fc->inject;
2115 if (!inject->secs[feat].offset ||
2119 ret = feat_copy(inject, feat, fw);
2123 return 1; /* Feature section copied */
2126 static int copy_kcore_dir(struct perf_inject *inject)
2131 ret = asprintf(&cmd, "cp -r -n %s/kcore_dir* %s >/dev/null 2>&1",
2132 inject->input_name, inject->output.path);
2135 pr_debug("%s\n", cmd);
2141 static int guest_session__copy_kcore_dir(struct guest_session *gs)
2143 struct perf_inject *inject = container_of(gs, struct perf_inject, guest_session);
2147 ret = asprintf(&cmd, "cp -r -n %s/kcore_dir %s/kcore_dir__%u >/dev/null 2>&1",
2148 gs->perf_data_file, inject->output.path, gs->machine_pid);
2151 pr_debug("%s\n", cmd);
2157 static int output_fd(struct perf_inject *inject)
2159 return inject->in_place_update ? -1 : perf_data__fd(&inject->output);
2162 static int __cmd_inject(struct perf_inject *inject)
2165 struct guest_session *gs = &inject->guest_session;
2166 struct perf_session *session = inject->session;
2167 int fd = output_fd(inject);
2168 u64 output_data_offset = perf_session__data_offset(session->evlist);
2170 * Pipe input hasn't loaded the attributes and will handle them as
2171 * events. So that the attributes don't overlap the data, write the
2172 * attributes after the data.
2174 bool write_attrs_after_data = !inject->output.is_pipe && inject->session->data->is_pipe;
2176 signal(SIGINT, sig_handler);
2178 if (inject->build_id_style != BID_RWS__NONE || inject->sched_stat ||
2179 inject->itrace_synth_opts.set) {
2180 inject->tool.mmap = perf_event__repipe_mmap;
2181 inject->tool.mmap2 = perf_event__repipe_mmap2;
2182 inject->tool.fork = perf_event__repipe_fork;
2183 #ifdef HAVE_LIBTRACEEVENT
2184 inject->tool.tracing_data = perf_event__repipe_tracing_data;
2188 if (inject->build_id_style == BID_RWS__INJECT_HEADER_LAZY ||
2189 inject->build_id_style == BID_RWS__MMAP2_BUILDID_LAZY) {
2190 inject->tool.sample = perf_event__inject_buildid;
2191 } else if (inject->sched_stat) {
2192 struct evsel *evsel;
2194 evlist__for_each_entry(session->evlist, evsel) {
2195 const char *name = evsel__name(evsel);
2197 if (!strcmp(name, "sched:sched_switch")) {
2198 if (evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID"))
2201 evsel->handler = perf_inject__sched_switch;
2202 } else if (!strcmp(name, "sched:sched_process_exit"))
2203 evsel->handler = perf_inject__sched_process_exit;
2204 #ifdef HAVE_LIBTRACEEVENT
2205 else if (!strncmp(name, "sched:sched_stat_", 17))
2206 evsel->handler = perf_inject__sched_stat;
2209 } else if (inject->itrace_synth_opts.vm_time_correlation) {
2210 session->itrace_synth_opts = &inject->itrace_synth_opts;
2211 memset(&inject->tool, 0, sizeof(inject->tool));
2212 inject->tool.id_index = perf_event__process_id_index;
2213 inject->tool.auxtrace_info = perf_event__process_auxtrace_info;
2214 inject->tool.auxtrace = perf_event__process_auxtrace;
2215 inject->tool.auxtrace_error = perf_event__process_auxtrace_error;
2216 inject->tool.ordered_events = true;
2217 inject->tool.ordering_requires_timestamps = true;
2218 } else if (inject->itrace_synth_opts.set) {
2219 session->itrace_synth_opts = &inject->itrace_synth_opts;
2220 inject->itrace_synth_opts.inject = true;
2221 inject->tool.comm = perf_event__repipe_comm;
2222 inject->tool.namespaces = perf_event__repipe_namespaces;
2223 inject->tool.exit = perf_event__repipe_exit;
2224 inject->tool.id_index = perf_event__process_id_index;
2225 inject->tool.auxtrace_info = perf_event__process_auxtrace_info;
2226 inject->tool.auxtrace = perf_event__process_auxtrace;
2227 inject->tool.aux = perf_event__drop_aux;
2228 inject->tool.itrace_start = perf_event__drop_aux;
2229 inject->tool.aux_output_hw_id = perf_event__drop_aux;
2230 inject->tool.ordered_events = true;
2231 inject->tool.ordering_requires_timestamps = true;
2232 /* Allow space in the header for new attributes */
2233 output_data_offset = roundup(8192 + session->header.data_offset, 4096);
2236 } else if (gs->perf_data_file) {
2237 char *name = gs->perf_data_file;
2240 * Not strictly necessary, but keep these events in order wrt
2243 inject->tool.mmap = host__repipe;
2244 inject->tool.mmap2 = host__repipe;
2245 inject->tool.comm = host__repipe;
2246 inject->tool.fork = host__repipe;
2247 inject->tool.exit = host__repipe;
2248 inject->tool.lost = host__repipe;
2249 inject->tool.context_switch = host__repipe;
2250 inject->tool.ksymbol = host__repipe;
2251 inject->tool.text_poke = host__repipe;
2253 * Once the host session has initialized, set up sample ID
2254 * mapping and feed in guest attrs, build IDs and initial
2257 inject->tool.finished_init = host__finished_init;
2258 /* Obey finished round ordering */
2259 inject->tool.finished_round = host__finished_round;
2260 /* Keep track of which CPU a VCPU is runnng on */
2261 inject->tool.context_switch = host__context_switch;
2263 * Must order events to be able to obey finished round
2266 inject->tool.ordered_events = true;
2267 inject->tool.ordering_requires_timestamps = true;
2268 /* Set up a separate session to process guest perf.data file */
2269 ret = guest_session__start(gs, name, session->data->force);
2271 pr_err("Failed to process %s, error %d\n", name, ret);
2274 /* Allow space in the header for guest attributes */
2275 output_data_offset += gs->session->header.data_offset;
2276 output_data_offset = roundup(output_data_offset, 4096);
2279 if (!inject->itrace_synth_opts.set)
2280 auxtrace_index__free(&session->auxtrace_index);
2282 if (!inject->output.is_pipe && !inject->in_place_update)
2283 lseek(fd, output_data_offset, SEEK_SET);
2285 ret = perf_session__process_events(session);
2291 * Remaining guest events have later timestamps. Flush them
2294 ret = guest_session__flush_events(gs);
2296 pr_err("Failed to flush guest events\n");
2301 if (!inject->output.is_pipe && !inject->in_place_update) {
2302 struct inject_fc inj_fc = {
2303 .fc.copy = feat_copy_cb,
2307 if (inject->build_id_style == BID_RWS__INJECT_HEADER_LAZY ||
2308 inject->build_id_style == BID_RWS__INJECT_HEADER_ALL)
2309 perf_header__set_feat(&session->header, HEADER_BUILD_ID);
2311 * Keep all buildids when there is unprocessed AUX data because
2312 * it is not known which ones the AUX trace hits.
2314 if (perf_header__has_feat(&session->header, HEADER_BUILD_ID) &&
2315 inject->have_auxtrace && !inject->itrace_synth_opts.set)
2316 perf_session__dsos_hit_all(session);
2318 * The AUX areas have been removed and replaced with
2319 * synthesized hardware events, so clear the feature flag.
2321 if (inject->itrace_synth_opts.set) {
2322 perf_header__clear_feat(&session->header,
2324 if (inject->itrace_synth_opts.last_branch ||
2325 inject->itrace_synth_opts.add_last_branch)
2326 perf_header__set_feat(&session->header,
2327 HEADER_BRANCH_STACK);
2329 session->header.data_offset = output_data_offset;
2330 session->header.data_size = inject->bytes_written;
2331 perf_session__inject_header(session, session->evlist, fd, &inj_fc.fc,
2332 write_attrs_after_data);
2334 if (inject->copy_kcore_dir) {
2335 ret = copy_kcore_dir(inject);
2337 pr_err("Failed to copy kcore\n");
2341 if (gs->copy_kcore_dir) {
2342 ret = guest_session__copy_kcore_dir(gs);
2344 pr_err("Failed to copy guest kcore\n");
2353 int cmd_inject(int argc, const char **argv)
2355 struct perf_inject inject = {
2357 .samples = LIST_HEAD_INIT(inject.samples),
2360 .mode = PERF_DATA_MODE_WRITE,
2364 struct perf_data data = {
2365 .mode = PERF_DATA_MODE_READ,
2369 const char *known_build_ids = NULL;
2372 bool mmap2_build_ids;
2373 bool mmap2_build_id_all;
2375 struct option options[] = {
2376 OPT_BOOLEAN('b', "build-ids", &build_ids,
2377 "Inject build-ids into the output stream"),
2378 OPT_BOOLEAN(0, "buildid-all", &build_id_all,
2379 "Inject build-ids of all DSOs into the output stream"),
2380 OPT_BOOLEAN('B', "mmap2-buildids", &mmap2_build_ids,
2381 "Drop unused mmap events, make others mmap2 with build IDs"),
2382 OPT_BOOLEAN(0, "mmap2-buildid-all", &mmap2_build_id_all,
2383 "Rewrite all mmap events as mmap2 events with build IDs"),
2384 OPT_STRING(0, "known-build-ids", &known_build_ids,
2385 "buildid path [,buildid path...]",
2386 "build-ids to use for given paths"),
2387 OPT_STRING('i', "input", &inject.input_name, "file",
2389 OPT_STRING('o', "output", &inject.output.path, "file",
2390 "output file name"),
2391 OPT_BOOLEAN('s', "sched-stat", &inject.sched_stat,
2392 "Merge sched-stat and sched-switch for getting events "
2393 "where and how long tasks slept"),
2395 OPT_BOOLEAN('j', "jit", &inject.jit_mode, "merge jitdump files into perf.data file"),
2397 OPT_INCR('v', "verbose", &verbose,
2398 "be more verbose (show build ids, etc)"),
2399 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
2400 "file", "vmlinux pathname"),
2401 OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux,
2402 "don't load vmlinux even if found"),
2403 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, "file",
2404 "kallsyms pathname"),
2405 OPT_BOOLEAN('f', "force", &data.force, "don't complain, do it"),
2406 OPT_CALLBACK_OPTARG(0, "itrace", &inject.itrace_synth_opts,
2407 NULL, "opts", "Instruction Tracing options\n"
2409 itrace_parse_synth_opts),
2410 OPT_BOOLEAN(0, "strip", &inject.strip,
2411 "strip non-synthesized events (use with --itrace)"),
2412 OPT_CALLBACK_OPTARG(0, "vm-time-correlation", &inject, NULL, "opts",
2413 "correlate time between VM guests and the host",
2414 parse_vm_time_correlation),
2415 OPT_CALLBACK_OPTARG(0, "guest-data", &inject, NULL, "opts",
2416 "inject events from a guest perf.data file",
2418 OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
2419 "guest mount directory under which every guest os"
2420 " instance has a subdir"),
2423 const char * const inject_usage[] = {
2424 "perf inject [<options>]",
2427 bool ordered_events;
2429 if (!inject.itrace_synth_opts.set) {
2430 /* Disable eager loading of kernel symbols that adds overhead to perf inject. */
2431 symbol_conf.lazy_load_kernel_maps = true;
2434 #ifndef HAVE_JITDUMP
2435 set_option_nobuild(options, 'j', "jit", "NO_LIBELF=1", true);
2437 argc = parse_options(argc, argv, options, inject_usage, 0);
2440 * Any (unrecognized) arguments left?
2443 usage_with_options(inject_usage, options);
2445 if (inject.strip && !inject.itrace_synth_opts.set) {
2446 pr_err("--strip option requires --itrace option\n");
2450 if (symbol__validate_sym_arguments())
2453 if (inject.in_place_update) {
2454 if (!strcmp(inject.input_name, "-")) {
2455 pr_err("Input file name required for in-place updating\n");
2458 if (strcmp(inject.output.path, "-")) {
2459 pr_err("Output file name must not be specified for in-place updating\n");
2462 if (!data.force && !inject.in_place_update_dry_run) {
2463 pr_err("The input file would be updated in place, "
2464 "the --force option is required.\n");
2467 if (!inject.in_place_update_dry_run)
2468 data.in_place_update = true;
2470 if (strcmp(inject.output.path, "-") && !inject.strip &&
2471 has_kcore_dir(inject.input_name)) {
2472 inject.output.is_dir = true;
2473 inject.copy_kcore_dir = true;
2475 if (perf_data__open(&inject.output)) {
2476 perror("failed to create output file");
2480 if (mmap2_build_ids)
2481 inject.build_id_style = BID_RWS__MMAP2_BUILDID_LAZY;
2482 if (mmap2_build_id_all)
2483 inject.build_id_style = BID_RWS__MMAP2_BUILDID_ALL;
2485 inject.build_id_style = BID_RWS__INJECT_HEADER_LAZY;
2487 inject.build_id_style = BID_RWS__INJECT_HEADER_ALL;
2489 data.path = inject.input_name;
2491 ordered_events = inject.jit_mode || inject.sched_stat ||
2492 inject.build_id_style == BID_RWS__INJECT_HEADER_LAZY ||
2493 inject.build_id_style == BID_RWS__MMAP2_BUILDID_LAZY;
2494 perf_tool__init(&inject.tool, ordered_events);
2495 inject.tool.sample = perf_event__repipe_sample;
2496 inject.tool.read = perf_event__repipe_sample;
2497 inject.tool.mmap = perf_event__repipe;
2498 inject.tool.mmap2 = perf_event__repipe;
2499 inject.tool.comm = perf_event__repipe;
2500 inject.tool.namespaces = perf_event__repipe;
2501 inject.tool.cgroup = perf_event__repipe;
2502 inject.tool.fork = perf_event__repipe;
2503 inject.tool.exit = perf_event__repipe;
2504 inject.tool.lost = perf_event__repipe;
2505 inject.tool.lost_samples = perf_event__repipe;
2506 inject.tool.aux = perf_event__repipe;
2507 inject.tool.itrace_start = perf_event__repipe;
2508 inject.tool.aux_output_hw_id = perf_event__repipe;
2509 inject.tool.context_switch = perf_event__repipe;
2510 inject.tool.throttle = perf_event__repipe;
2511 inject.tool.unthrottle = perf_event__repipe;
2512 inject.tool.ksymbol = perf_event__repipe;
2513 inject.tool.bpf = perf_event__repipe;
2514 inject.tool.text_poke = perf_event__repipe;
2515 inject.tool.attr = perf_event__repipe_attr;
2516 inject.tool.event_update = perf_event__repipe_event_update;
2517 inject.tool.tracing_data = perf_event__repipe_op2_synth;
2518 inject.tool.finished_round = perf_event__repipe_oe_synth;
2519 inject.tool.build_id = perf_event__repipe_op2_synth;
2520 inject.tool.id_index = perf_event__repipe_op2_synth;
2521 inject.tool.auxtrace_info = perf_event__repipe_op2_synth;
2522 inject.tool.auxtrace_error = perf_event__repipe_op2_synth;
2523 inject.tool.time_conv = perf_event__repipe_op2_synth;
2524 inject.tool.thread_map = perf_event__repipe_op2_synth;
2525 inject.tool.cpu_map = perf_event__repipe_op2_synth;
2526 inject.tool.stat_config = perf_event__repipe_op2_synth;
2527 inject.tool.stat = perf_event__repipe_op2_synth;
2528 inject.tool.stat_round = perf_event__repipe_op2_synth;
2529 inject.tool.feature = perf_event__repipe_op2_synth;
2530 inject.tool.finished_init = perf_event__repipe_op2_synth;
2531 inject.tool.compressed = perf_event__repipe_op4_synth;
2532 inject.tool.auxtrace = perf_event__repipe_auxtrace;
2533 inject.tool.dont_split_sample_group = true;
2534 inject.session = __perf_session__new(&data, &inject.tool,
2535 /*trace_event_repipe=*/inject.output.is_pipe);
2537 if (IS_ERR(inject.session)) {
2538 ret = PTR_ERR(inject.session);
2539 goto out_close_output;
2542 if (zstd_init(&(inject.session->zstd_data), 0) < 0)
2543 pr_warning("Decompression initialization failed.\n");
2545 /* Save original section info before feature bits change */
2546 ret = save_section_info(&inject);
2550 if (inject.output.is_pipe) {
2551 ret = perf_header__write_pipe(perf_data__fd(&inject.output));
2553 pr_err("Couldn't write a new pipe header.\n");
2558 * If the input is already a pipe then the features and
2559 * attributes don't need synthesizing, they will be present in
2562 if (!data.is_pipe) {
2563 ret = perf_event__synthesize_for_pipe(&inject.tool,
2566 perf_event__repipe);
2572 if (inject.build_id_style == BID_RWS__INJECT_HEADER_LAZY ||
2573 inject.build_id_style == BID_RWS__MMAP2_BUILDID_LAZY) {
2575 * to make sure the mmap records are ordered correctly
2576 * and so that the correct especially due to jitted code
2577 * mmaps. We cannot generate the buildid hit list and
2578 * inject the jit mmaps at the same time for now.
2580 inject.tool.ordering_requires_timestamps = true;
2582 if (inject.build_id_style != BID_RWS__NONE && known_build_ids != NULL) {
2583 inject.known_build_ids =
2584 perf_inject__parse_known_build_ids(known_build_ids);
2586 if (inject.known_build_ids == NULL) {
2587 pr_err("Couldn't parse known build ids.\n");
2593 if (inject.jit_mode) {
2594 inject.tool.mmap2 = perf_event__repipe_mmap2;
2595 inject.tool.mmap = perf_event__repipe_mmap;
2596 inject.tool.ordering_requires_timestamps = true;
2598 * JIT MMAP injection injects all MMAP events in one go, so it
2599 * does not obey finished_round semantics.
2601 inject.tool.finished_round = perf_event__drop_oe;
2604 ret = symbol__init(&inject.session->header.env);
2608 ret = __cmd_inject(&inject);
2610 guest_session__exit(&inject.guest_session);
2613 strlist__delete(inject.known_build_ids);
2614 zstd_fini(&(inject.session->zstd_data));
2615 perf_session__delete(inject.session);
2617 if (!inject.in_place_update)
2618 perf_data__close(&inject.output);
2619 free(inject.itrace_synth_opts.vm_tm_corr_args);
2620 free(inject.event_copy);
2621 free(inject.guest_session.ev.event_buf);