4 * Builtin inject command: Examine the live mode (stdin) event stream
5 * and repipe it to stdout while optionally injecting additional
11 #include "util/color.h"
12 #include "util/evlist.h"
13 #include "util/evsel.h"
14 #include "util/session.h"
15 #include "util/tool.h"
16 #include "util/debug.h"
17 #include "util/build-id.h"
18 #include "util/data.h"
19 #include "util/auxtrace.h"
22 #include <subcmd/parse-options.h>
24 #include <linux/list.h>
27 struct perf_tool tool
;
28 struct perf_session
*session
;
34 const char *input_name
;
35 struct perf_data_file output
;
38 struct list_head samples
;
39 struct itrace_synth_opts itrace_synth_opts
;
43 struct list_head node
;
45 union perf_event event
[0];
48 static int output_bytes(struct perf_inject
*inject
, void *buf
, size_t sz
)
52 size
= perf_data_file__write(&inject
->output
, buf
, sz
);
56 inject
->bytes_written
+= size
;
60 static int perf_event__repipe_synth(struct perf_tool
*tool
,
61 union perf_event
*event
)
63 struct perf_inject
*inject
= container_of(tool
, struct perf_inject
,
66 return output_bytes(inject
, event
, event
->header
.size
);
69 static int perf_event__repipe_oe_synth(struct perf_tool
*tool
,
70 union perf_event
*event
,
71 struct ordered_events
*oe __maybe_unused
)
73 return perf_event__repipe_synth(tool
, event
);
77 static int perf_event__drop_oe(struct perf_tool
*tool __maybe_unused
,
78 union perf_event
*event __maybe_unused
,
79 struct ordered_events
*oe __maybe_unused
)
85 static int perf_event__repipe_op2_synth(struct perf_tool
*tool
,
86 union perf_event
*event
,
87 struct perf_session
*session
90 return perf_event__repipe_synth(tool
, event
);
93 static int perf_event__repipe_attr(struct perf_tool
*tool
,
94 union perf_event
*event
,
95 struct perf_evlist
**pevlist
)
97 struct perf_inject
*inject
= container_of(tool
, struct perf_inject
,
101 ret
= perf_event__process_attr(tool
, event
, pevlist
);
105 if (!inject
->output
.is_pipe
)
108 return perf_event__repipe_synth(tool
, event
);
111 #ifdef HAVE_AUXTRACE_SUPPORT
113 static int copy_bytes(struct perf_inject
*inject
, int fd
, off_t size
)
120 ssz
= read(fd
, buf
, min(size
, (off_t
)sizeof(buf
)));
123 ret
= output_bytes(inject
, buf
, ssz
);
132 static s64
perf_event__repipe_auxtrace(struct perf_tool
*tool
,
133 union perf_event
*event
,
134 struct perf_session
*session
)
136 struct perf_inject
*inject
= container_of(tool
, struct perf_inject
,
140 inject
->have_auxtrace
= true;
142 if (!inject
->output
.is_pipe
) {
145 offset
= lseek(inject
->output
.fd
, 0, SEEK_CUR
);
148 ret
= auxtrace_index__auxtrace_event(&session
->auxtrace_index
,
154 if (perf_data_file__is_pipe(session
->file
) || !session
->one_mmap
) {
155 ret
= output_bytes(inject
, event
, event
->header
.size
);
158 ret
= copy_bytes(inject
, perf_data_file__fd(session
->file
),
159 event
->auxtrace
.size
);
161 ret
= output_bytes(inject
, event
,
162 event
->header
.size
+ event
->auxtrace
.size
);
167 return event
->auxtrace
.size
;
173 perf_event__repipe_auxtrace(struct perf_tool
*tool __maybe_unused
,
174 union perf_event
*event __maybe_unused
,
175 struct perf_session
*session __maybe_unused
)
177 pr_err("AUX area tracing not supported\n");
183 static int perf_event__repipe(struct perf_tool
*tool
,
184 union perf_event
*event
,
185 struct perf_sample
*sample __maybe_unused
,
186 struct machine
*machine __maybe_unused
)
188 return perf_event__repipe_synth(tool
, event
);
191 static int perf_event__drop(struct perf_tool
*tool __maybe_unused
,
192 union perf_event
*event __maybe_unused
,
193 struct perf_sample
*sample __maybe_unused
,
194 struct machine
*machine __maybe_unused
)
199 static int perf_event__drop_aux(struct perf_tool
*tool
,
200 union perf_event
*event __maybe_unused
,
201 struct perf_sample
*sample
,
202 struct machine
*machine __maybe_unused
)
204 struct perf_inject
*inject
= container_of(tool
, struct perf_inject
, tool
);
207 inject
->aux_id
= sample
->id
;
212 typedef int (*inject_handler
)(struct perf_tool
*tool
,
213 union perf_event
*event
,
214 struct perf_sample
*sample
,
215 struct perf_evsel
*evsel
,
216 struct machine
*machine
);
218 static int perf_event__repipe_sample(struct perf_tool
*tool
,
219 union perf_event
*event
,
220 struct perf_sample
*sample
,
221 struct perf_evsel
*evsel
,
222 struct machine
*machine
)
224 if (evsel
->handler
) {
225 inject_handler f
= evsel
->handler
;
226 return f(tool
, event
, sample
, evsel
, machine
);
229 build_id__mark_dso_hit(tool
, event
, sample
, evsel
, machine
);
231 return perf_event__repipe_synth(tool
, event
);
234 static int perf_event__repipe_mmap(struct perf_tool
*tool
,
235 union perf_event
*event
,
236 struct perf_sample
*sample
,
237 struct machine
*machine
)
241 err
= perf_event__process_mmap(tool
, event
, sample
, machine
);
242 perf_event__repipe(tool
, event
, sample
, machine
);
248 static int perf_event__jit_repipe_mmap(struct perf_tool
*tool
,
249 union perf_event
*event
,
250 struct perf_sample
*sample
,
251 struct machine
*machine
)
253 struct perf_inject
*inject
= container_of(tool
, struct perf_inject
, tool
);
258 * if jit marker, then inject jit mmaps and generate ELF images
260 ret
= jit_process(inject
->session
, &inject
->output
, machine
,
261 event
->mmap
.filename
, sample
->pid
, &n
);
265 inject
->bytes_written
+= n
;
268 return perf_event__repipe_mmap(tool
, event
, sample
, machine
);
272 static int perf_event__repipe_mmap2(struct perf_tool
*tool
,
273 union perf_event
*event
,
274 struct perf_sample
*sample
,
275 struct machine
*machine
)
279 err
= perf_event__process_mmap2(tool
, event
, sample
, machine
);
280 perf_event__repipe(tool
, event
, sample
, machine
);
286 static int perf_event__jit_repipe_mmap2(struct perf_tool
*tool
,
287 union perf_event
*event
,
288 struct perf_sample
*sample
,
289 struct machine
*machine
)
291 struct perf_inject
*inject
= container_of(tool
, struct perf_inject
, tool
);
296 * if jit marker, then inject jit mmaps and generate ELF images
298 ret
= jit_process(inject
->session
, &inject
->output
, machine
,
299 event
->mmap2
.filename
, sample
->pid
, &n
);
303 inject
->bytes_written
+= n
;
306 return perf_event__repipe_mmap2(tool
, event
, sample
, machine
);
310 static int perf_event__repipe_fork(struct perf_tool
*tool
,
311 union perf_event
*event
,
312 struct perf_sample
*sample
,
313 struct machine
*machine
)
317 err
= perf_event__process_fork(tool
, event
, sample
, machine
);
318 perf_event__repipe(tool
, event
, sample
, machine
);
323 static int perf_event__repipe_comm(struct perf_tool
*tool
,
324 union perf_event
*event
,
325 struct perf_sample
*sample
,
326 struct machine
*machine
)
330 err
= perf_event__process_comm(tool
, event
, sample
, machine
);
331 perf_event__repipe(tool
, event
, sample
, machine
);
336 static int perf_event__repipe_exit(struct perf_tool
*tool
,
337 union perf_event
*event
,
338 struct perf_sample
*sample
,
339 struct machine
*machine
)
343 err
= perf_event__process_exit(tool
, event
, sample
, machine
);
344 perf_event__repipe(tool
, event
, sample
, machine
);
349 static int perf_event__repipe_tracing_data(struct perf_tool
*tool
,
350 union perf_event
*event
,
351 struct perf_session
*session
)
355 perf_event__repipe_synth(tool
, event
);
356 err
= perf_event__process_tracing_data(tool
, event
, session
);
361 static int perf_event__repipe_id_index(struct perf_tool
*tool
,
362 union perf_event
*event
,
363 struct perf_session
*session
)
367 perf_event__repipe_synth(tool
, event
);
368 err
= perf_event__process_id_index(tool
, event
, session
);
373 static int dso__read_build_id(struct dso
*dso
)
375 if (dso
->has_build_id
)
378 if (filename__read_build_id(dso
->long_name
, dso
->build_id
,
379 sizeof(dso
->build_id
)) > 0) {
380 dso
->has_build_id
= true;
387 static int dso__inject_build_id(struct dso
*dso
, struct perf_tool
*tool
,
388 struct machine
*machine
)
390 u16 misc
= PERF_RECORD_MISC_USER
;
393 if (dso__read_build_id(dso
) < 0) {
394 pr_debug("no build_id found for %s\n", dso
->long_name
);
399 misc
= PERF_RECORD_MISC_KERNEL
;
401 err
= perf_event__synthesize_build_id(tool
, dso
, misc
, perf_event__repipe
,
404 pr_err("Can't synthesize build_id event for %s\n", dso
->long_name
);
411 static int perf_event__inject_buildid(struct perf_tool
*tool
,
412 union perf_event
*event
,
413 struct perf_sample
*sample
,
414 struct perf_evsel
*evsel __maybe_unused
,
415 struct machine
*machine
)
417 struct addr_location al
;
418 struct thread
*thread
;
420 thread
= machine__findnew_thread(machine
, sample
->pid
, sample
->tid
);
421 if (thread
== NULL
) {
422 pr_err("problem processing %d event, skipping it.\n",
427 thread__find_addr_map(thread
, sample
->cpumode
, MAP__FUNCTION
, sample
->ip
, &al
);
429 if (al
.map
!= NULL
) {
430 if (!al
.map
->dso
->hit
) {
431 al
.map
->dso
->hit
= 1;
432 if (map__load(al
.map
, NULL
) >= 0) {
433 dso__inject_build_id(al
.map
->dso
, tool
, machine
);
435 * If this fails, too bad, let the other side
436 * account this as unresolved.
439 #ifdef HAVE_LIBELF_SUPPORT
440 pr_warning("no symbols found in %s, maybe "
441 "install a debug package?\n",
442 al
.map
->dso
->long_name
);
450 perf_event__repipe(tool
, event
, sample
, machine
);
454 static int perf_inject__sched_process_exit(struct perf_tool
*tool
,
455 union perf_event
*event __maybe_unused
,
456 struct perf_sample
*sample
,
457 struct perf_evsel
*evsel __maybe_unused
,
458 struct machine
*machine __maybe_unused
)
460 struct perf_inject
*inject
= container_of(tool
, struct perf_inject
, tool
);
461 struct event_entry
*ent
;
463 list_for_each_entry(ent
, &inject
->samples
, node
) {
464 if (sample
->tid
== ent
->tid
) {
465 list_del_init(&ent
->node
);
474 static int perf_inject__sched_switch(struct perf_tool
*tool
,
475 union perf_event
*event
,
476 struct perf_sample
*sample
,
477 struct perf_evsel
*evsel
,
478 struct machine
*machine
)
480 struct perf_inject
*inject
= container_of(tool
, struct perf_inject
, tool
);
481 struct event_entry
*ent
;
483 perf_inject__sched_process_exit(tool
, event
, sample
, evsel
, machine
);
485 ent
= malloc(event
->header
.size
+ sizeof(struct event_entry
));
487 color_fprintf(stderr
, PERF_COLOR_RED
,
488 "Not enough memory to process sched switch event!");
492 ent
->tid
= sample
->tid
;
493 memcpy(&ent
->event
, event
, event
->header
.size
);
494 list_add(&ent
->node
, &inject
->samples
);
498 static int perf_inject__sched_stat(struct perf_tool
*tool
,
499 union perf_event
*event __maybe_unused
,
500 struct perf_sample
*sample
,
501 struct perf_evsel
*evsel
,
502 struct machine
*machine
)
504 struct event_entry
*ent
;
505 union perf_event
*event_sw
;
506 struct perf_sample sample_sw
;
507 struct perf_inject
*inject
= container_of(tool
, struct perf_inject
, tool
);
508 u32 pid
= perf_evsel__intval(evsel
, sample
, "pid");
510 list_for_each_entry(ent
, &inject
->samples
, node
) {
517 event_sw
= &ent
->event
[0];
518 perf_evsel__parse_sample(evsel
, event_sw
, &sample_sw
);
520 sample_sw
.period
= sample
->period
;
521 sample_sw
.time
= sample
->time
;
522 perf_event__synthesize_sample(event_sw
, evsel
->attr
.sample_type
,
523 evsel
->attr
.read_format
, &sample_sw
,
525 build_id__mark_dso_hit(tool
, event_sw
, &sample_sw
, evsel
, machine
);
526 return perf_event__repipe(tool
, event_sw
, &sample_sw
, machine
);
529 static void sig_handler(int sig __maybe_unused
)
534 static int perf_evsel__check_stype(struct perf_evsel
*evsel
,
535 u64 sample_type
, const char *sample_msg
)
537 struct perf_event_attr
*attr
= &evsel
->attr
;
538 const char *name
= perf_evsel__name(evsel
);
540 if (!(attr
->sample_type
& sample_type
)) {
541 pr_err("Samples for %s event do not have %s attribute set.",
549 static int drop_sample(struct perf_tool
*tool __maybe_unused
,
550 union perf_event
*event __maybe_unused
,
551 struct perf_sample
*sample __maybe_unused
,
552 struct perf_evsel
*evsel __maybe_unused
,
553 struct machine
*machine __maybe_unused
)
558 static void strip_init(struct perf_inject
*inject
)
560 struct perf_evlist
*evlist
= inject
->session
->evlist
;
561 struct perf_evsel
*evsel
;
563 inject
->tool
.context_switch
= perf_event__drop
;
565 evlist__for_each(evlist
, evsel
)
566 evsel
->handler
= drop_sample
;
569 static bool has_tracking(struct perf_evsel
*evsel
)
571 return evsel
->attr
.mmap
|| evsel
->attr
.mmap2
|| evsel
->attr
.comm
||
575 #define COMPAT_MASK (PERF_SAMPLE_ID | PERF_SAMPLE_TID | PERF_SAMPLE_TIME | \
576 PERF_SAMPLE_ID | PERF_SAMPLE_CPU | PERF_SAMPLE_IDENTIFIER)
579 * In order that the perf.data file is parsable, tracking events like MMAP need
580 * their selected event to exist, except if there is only 1 selected event left
581 * and it has a compatible sample type.
583 static bool ok_to_remove(struct perf_evlist
*evlist
,
584 struct perf_evsel
*evsel_to_remove
)
586 struct perf_evsel
*evsel
;
590 if (!has_tracking(evsel_to_remove
))
593 evlist__for_each(evlist
, evsel
) {
594 if (evsel
->handler
!= drop_sample
) {
596 if ((evsel
->attr
.sample_type
& COMPAT_MASK
) ==
597 (evsel_to_remove
->attr
.sample_type
& COMPAT_MASK
))
602 return ok
&& cnt
== 1;
605 static void strip_fini(struct perf_inject
*inject
)
607 struct perf_evlist
*evlist
= inject
->session
->evlist
;
608 struct perf_evsel
*evsel
, *tmp
;
610 /* Remove non-synthesized evsels if possible */
611 evlist__for_each_safe(evlist
, tmp
, evsel
) {
612 if (evsel
->handler
== drop_sample
&&
613 ok_to_remove(evlist
, evsel
)) {
614 pr_debug("Deleting %s\n", perf_evsel__name(evsel
));
615 perf_evlist__remove(evlist
, evsel
);
616 perf_evsel__delete(evsel
);
621 static int __cmd_inject(struct perf_inject
*inject
)
624 struct perf_session
*session
= inject
->session
;
625 struct perf_data_file
*file_out
= &inject
->output
;
626 int fd
= perf_data_file__fd(file_out
);
627 u64 output_data_offset
;
629 signal(SIGINT
, sig_handler
);
631 if (inject
->build_ids
|| inject
->sched_stat
||
632 inject
->itrace_synth_opts
.set
) {
633 inject
->tool
.mmap
= perf_event__repipe_mmap
;
634 inject
->tool
.mmap2
= perf_event__repipe_mmap2
;
635 inject
->tool
.fork
= perf_event__repipe_fork
;
636 inject
->tool
.tracing_data
= perf_event__repipe_tracing_data
;
639 output_data_offset
= session
->header
.data_offset
;
641 if (inject
->build_ids
) {
642 inject
->tool
.sample
= perf_event__inject_buildid
;
643 } else if (inject
->sched_stat
) {
644 struct perf_evsel
*evsel
;
646 evlist__for_each(session
->evlist
, evsel
) {
647 const char *name
= perf_evsel__name(evsel
);
649 if (!strcmp(name
, "sched:sched_switch")) {
650 if (perf_evsel__check_stype(evsel
, PERF_SAMPLE_TID
, "TID"))
653 evsel
->handler
= perf_inject__sched_switch
;
654 } else if (!strcmp(name
, "sched:sched_process_exit"))
655 evsel
->handler
= perf_inject__sched_process_exit
;
656 else if (!strncmp(name
, "sched:sched_stat_", 17))
657 evsel
->handler
= perf_inject__sched_stat
;
659 } else if (inject
->itrace_synth_opts
.set
) {
660 session
->itrace_synth_opts
= &inject
->itrace_synth_opts
;
661 inject
->itrace_synth_opts
.inject
= true;
662 inject
->tool
.comm
= perf_event__repipe_comm
;
663 inject
->tool
.exit
= perf_event__repipe_exit
;
664 inject
->tool
.id_index
= perf_event__repipe_id_index
;
665 inject
->tool
.auxtrace_info
= perf_event__process_auxtrace_info
;
666 inject
->tool
.auxtrace
= perf_event__process_auxtrace
;
667 inject
->tool
.aux
= perf_event__drop_aux
;
668 inject
->tool
.itrace_start
= perf_event__drop_aux
,
669 inject
->tool
.ordered_events
= true;
670 inject
->tool
.ordering_requires_timestamps
= true;
671 /* Allow space in the header for new attributes */
672 output_data_offset
= 4096;
677 if (!inject
->itrace_synth_opts
.set
)
678 auxtrace_index__free(&session
->auxtrace_index
);
680 if (!file_out
->is_pipe
)
681 lseek(fd
, output_data_offset
, SEEK_SET
);
683 ret
= perf_session__process_events(session
);
685 if (!file_out
->is_pipe
) {
686 if (inject
->build_ids
)
687 perf_header__set_feat(&session
->header
,
690 * Keep all buildids when there is unprocessed AUX data because
691 * it is not known which ones the AUX trace hits.
693 if (perf_header__has_feat(&session
->header
, HEADER_BUILD_ID
) &&
694 inject
->have_auxtrace
&& !inject
->itrace_synth_opts
.set
)
695 dsos__hit_all(session
);
697 * The AUX areas have been removed and replaced with
698 * synthesized hardware events, so clear the feature flag and
701 if (inject
->itrace_synth_opts
.set
) {
702 struct perf_evsel
*evsel
;
704 perf_header__clear_feat(&session
->header
,
706 if (inject
->itrace_synth_opts
.last_branch
)
707 perf_header__set_feat(&session
->header
,
708 HEADER_BRANCH_STACK
);
709 evsel
= perf_evlist__id2evsel_strict(session
->evlist
,
712 pr_debug("Deleting %s\n",
713 perf_evsel__name(evsel
));
714 perf_evlist__remove(session
->evlist
, evsel
);
715 perf_evsel__delete(evsel
);
720 session
->header
.data_offset
= output_data_offset
;
721 session
->header
.data_size
= inject
->bytes_written
;
722 perf_session__write_header(session
, session
->evlist
, fd
, true);
728 int cmd_inject(int argc
, const char **argv
, const char *prefix __maybe_unused
)
730 struct perf_inject inject
= {
732 .sample
= perf_event__repipe_sample
,
733 .mmap
= perf_event__repipe
,
734 .mmap2
= perf_event__repipe
,
735 .comm
= perf_event__repipe
,
736 .fork
= perf_event__repipe
,
737 .exit
= perf_event__repipe
,
738 .lost
= perf_event__repipe
,
739 .lost_samples
= perf_event__repipe
,
740 .aux
= perf_event__repipe
,
741 .itrace_start
= perf_event__repipe
,
742 .context_switch
= perf_event__repipe
,
743 .read
= perf_event__repipe_sample
,
744 .throttle
= perf_event__repipe
,
745 .unthrottle
= perf_event__repipe
,
746 .attr
= perf_event__repipe_attr
,
747 .tracing_data
= perf_event__repipe_op2_synth
,
748 .auxtrace_info
= perf_event__repipe_op2_synth
,
749 .auxtrace
= perf_event__repipe_auxtrace
,
750 .auxtrace_error
= perf_event__repipe_op2_synth
,
751 .finished_round
= perf_event__repipe_oe_synth
,
752 .build_id
= perf_event__repipe_op2_synth
,
753 .id_index
= perf_event__repipe_op2_synth
,
756 .samples
= LIST_HEAD_INIT(inject
.samples
),
759 .mode
= PERF_DATA_MODE_WRITE
,
762 struct perf_data_file file
= {
763 .mode
= PERF_DATA_MODE_READ
,
767 struct option options
[] = {
768 OPT_BOOLEAN('b', "build-ids", &inject
.build_ids
,
769 "Inject build-ids into the output stream"),
770 OPT_STRING('i', "input", &inject
.input_name
, "file",
772 OPT_STRING('o', "output", &inject
.output
.path
, "file",
774 OPT_BOOLEAN('s', "sched-stat", &inject
.sched_stat
,
775 "Merge sched-stat and sched-switch for getting events "
776 "where and how long tasks slept"),
778 OPT_BOOLEAN('j', "jit", &inject
.jit_mode
, "merge jitdump files into perf.data file"),
780 OPT_INCR('v', "verbose", &verbose
,
781 "be more verbose (show build ids, etc)"),
782 OPT_STRING(0, "kallsyms", &symbol_conf
.kallsyms_name
, "file",
783 "kallsyms pathname"),
784 OPT_BOOLEAN('f', "force", &file
.force
, "don't complain, do it"),
785 OPT_CALLBACK_OPTARG(0, "itrace", &inject
.itrace_synth_opts
,
786 NULL
, "opts", "Instruction Tracing options",
787 itrace_parse_synth_opts
),
788 OPT_BOOLEAN(0, "strip", &inject
.strip
,
789 "strip non-synthesized events (use with --itrace)"),
792 const char * const inject_usage
[] = {
793 "perf inject [<options>]",
797 set_option_nobuild(options
, 'j', "jit", "NO_LIBELF=1", true);
799 argc
= parse_options(argc
, argv
, options
, inject_usage
, 0);
802 * Any (unrecognized) arguments left?
805 usage_with_options(inject_usage
, options
);
807 if (inject
.strip
&& !inject
.itrace_synth_opts
.set
) {
808 pr_err("--strip option requires --itrace option\n");
812 if (perf_data_file__open(&inject
.output
)) {
813 perror("failed to create output file");
817 inject
.tool
.ordered_events
= inject
.sched_stat
;
819 file
.path
= inject
.input_name
;
820 inject
.session
= perf_session__new(&file
, true, &inject
.tool
);
821 if (inject
.session
== NULL
)
824 if (inject
.build_ids
) {
826 * to make sure the mmap records are ordered correctly
827 * and so that the correct especially due to jitted code
828 * mmaps. We cannot generate the buildid hit list and
829 * inject the jit mmaps at the same time for now.
831 inject
.tool
.ordered_events
= true;
832 inject
.tool
.ordering_requires_timestamps
= true;
835 if (inject
.jit_mode
) {
836 inject
.tool
.mmap2
= perf_event__jit_repipe_mmap2
;
837 inject
.tool
.mmap
= perf_event__jit_repipe_mmap
;
838 inject
.tool
.ordered_events
= true;
839 inject
.tool
.ordering_requires_timestamps
= true;
841 * JIT MMAP injection injects all MMAP events in one go, so it
842 * does not obey finished_round semantics.
844 inject
.tool
.finished_round
= perf_event__drop_oe
;
847 ret
= symbol__init(&inject
.session
->header
.env
);
851 ret
= __cmd_inject(&inject
);
854 perf_session__delete(inject
.session
);