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"
19 #include "util/parse-options.h"
21 #include <linux/list.h>
24 struct perf_tool tool;
27 const char *input_name;
31 struct list_head samples;
35 struct list_head node;
37 union perf_event event[0];
40 static int perf_event__repipe_synth(struct perf_tool *tool,
41 union perf_event *event)
43 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
47 size = event->header.size;
50 int ret = write(inject->output, buf, size);
56 inject->bytes_written += ret;
62 static int perf_event__repipe_op2_synth(struct perf_tool *tool,
63 union perf_event *event,
64 struct perf_session *session
67 return perf_event__repipe_synth(tool, event);
70 static int perf_event__repipe_attr(struct perf_tool *tool,
71 union perf_event *event,
72 struct perf_evlist **pevlist)
76 ret = perf_event__process_attr(tool, event, pevlist);
80 return perf_event__repipe_synth(tool, event);
83 static int perf_event__repipe(struct perf_tool *tool,
84 union perf_event *event,
85 struct perf_sample *sample __maybe_unused,
86 struct machine *machine __maybe_unused)
88 return perf_event__repipe_synth(tool, event);
91 typedef int (*inject_handler)(struct perf_tool *tool,
92 union perf_event *event,
93 struct perf_sample *sample,
94 struct perf_evsel *evsel,
95 struct machine *machine);
97 static int perf_event__repipe_sample(struct perf_tool *tool,
98 union perf_event *event,
99 struct perf_sample *sample,
100 struct perf_evsel *evsel,
101 struct machine *machine)
103 if (evsel->handler.func) {
104 inject_handler f = evsel->handler.func;
105 return f(tool, event, sample, evsel, machine);
108 build_id__mark_dso_hit(tool, event, sample, evsel, machine);
110 return perf_event__repipe_synth(tool, event);
113 static int perf_event__repipe_mmap(struct perf_tool *tool,
114 union perf_event *event,
115 struct perf_sample *sample,
116 struct machine *machine)
120 err = perf_event__process_mmap(tool, event, sample, machine);
121 perf_event__repipe(tool, event, sample, machine);
126 static int perf_event__repipe_mmap2(struct perf_tool *tool,
127 union perf_event *event,
128 struct perf_sample *sample,
129 struct machine *machine)
133 err = perf_event__process_mmap2(tool, event, sample, machine);
134 perf_event__repipe(tool, event, sample, machine);
139 static int perf_event__repipe_fork(struct perf_tool *tool,
140 union perf_event *event,
141 struct perf_sample *sample,
142 struct machine *machine)
146 err = perf_event__process_fork(tool, event, sample, machine);
147 perf_event__repipe(tool, event, sample, machine);
152 static int perf_event__repipe_tracing_data(struct perf_tool *tool,
153 union perf_event *event,
154 struct perf_session *session)
158 perf_event__repipe_synth(tool, event);
159 err = perf_event__process_tracing_data(tool, event, session);
164 static int dso__read_build_id(struct dso *self)
166 if (self->has_build_id)
169 if (filename__read_build_id(self->long_name, self->build_id,
170 sizeof(self->build_id)) > 0) {
171 self->has_build_id = true;
178 static int dso__inject_build_id(struct dso *self, struct perf_tool *tool,
179 struct machine *machine)
181 u16 misc = PERF_RECORD_MISC_USER;
184 if (dso__read_build_id(self) < 0) {
185 pr_debug("no build_id found for %s\n", self->long_name);
190 misc = PERF_RECORD_MISC_KERNEL;
192 err = perf_event__synthesize_build_id(tool, self, misc, perf_event__repipe,
195 pr_err("Can't synthesize build_id event for %s\n", self->long_name);
202 static int perf_event__inject_buildid(struct perf_tool *tool,
203 union perf_event *event,
204 struct perf_sample *sample,
205 struct perf_evsel *evsel __maybe_unused,
206 struct machine *machine)
208 struct addr_location al;
209 struct thread *thread;
212 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
214 thread = machine__findnew_thread(machine, sample->pid, sample->pid);
215 if (thread == NULL) {
216 pr_err("problem processing %d event, skipping it.\n",
221 thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
224 if (al.map != NULL) {
225 if (!al.map->dso->hit) {
226 al.map->dso->hit = 1;
227 if (map__load(al.map, NULL) >= 0) {
228 dso__inject_build_id(al.map->dso, tool, machine);
230 * If this fails, too bad, let the other side
231 * account this as unresolved.
234 #ifdef LIBELF_SUPPORT
235 pr_warning("no symbols found in %s, maybe "
236 "install a debug package?\n",
237 al.map->dso->long_name);
244 perf_event__repipe(tool, event, sample, machine);
248 static int perf_inject__sched_process_exit(struct perf_tool *tool,
249 union perf_event *event __maybe_unused,
250 struct perf_sample *sample,
251 struct perf_evsel *evsel __maybe_unused,
252 struct machine *machine __maybe_unused)
254 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
255 struct event_entry *ent;
257 list_for_each_entry(ent, &inject->samples, node) {
258 if (sample->tid == ent->tid) {
259 list_del_init(&ent->node);
268 static int perf_inject__sched_switch(struct perf_tool *tool,
269 union perf_event *event,
270 struct perf_sample *sample,
271 struct perf_evsel *evsel,
272 struct machine *machine)
274 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
275 struct event_entry *ent;
277 perf_inject__sched_process_exit(tool, event, sample, evsel, machine);
279 ent = malloc(event->header.size + sizeof(struct event_entry));
281 color_fprintf(stderr, PERF_COLOR_RED,
282 "Not enough memory to process sched switch event!");
286 ent->tid = sample->tid;
287 memcpy(&ent->event, event, event->header.size);
288 list_add(&ent->node, &inject->samples);
292 static int perf_inject__sched_stat(struct perf_tool *tool,
293 union perf_event *event __maybe_unused,
294 struct perf_sample *sample,
295 struct perf_evsel *evsel,
296 struct machine *machine)
298 struct event_entry *ent;
299 union perf_event *event_sw;
300 struct perf_sample sample_sw;
301 struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
302 u32 pid = perf_evsel__intval(evsel, sample, "pid");
304 list_for_each_entry(ent, &inject->samples, node) {
311 event_sw = &ent->event[0];
312 perf_evsel__parse_sample(evsel, event_sw, &sample_sw);
314 sample_sw.period = sample->period;
315 sample_sw.time = sample->time;
316 perf_event__synthesize_sample(event_sw, evsel->attr.sample_type,
317 evsel->attr.sample_regs_user,
318 evsel->attr.read_format, &sample_sw,
320 build_id__mark_dso_hit(tool, event_sw, &sample_sw, evsel, machine);
321 return perf_event__repipe(tool, event_sw, &sample_sw, machine);
324 extern volatile int session_done;
326 static void sig_handler(int sig __maybe_unused)
331 static int perf_evsel__check_stype(struct perf_evsel *evsel,
332 u64 sample_type, const char *sample_msg)
334 struct perf_event_attr *attr = &evsel->attr;
335 const char *name = perf_evsel__name(evsel);
337 if (!(attr->sample_type & sample_type)) {
338 pr_err("Samples for %s event do not have %s attribute set.",
346 static int __cmd_inject(struct perf_inject *inject)
348 struct perf_session *session;
351 signal(SIGINT, sig_handler);
353 if (inject->build_ids || inject->sched_stat) {
354 inject->tool.mmap = perf_event__repipe_mmap;
355 inject->tool.mmap2 = perf_event__repipe_mmap2;
356 inject->tool.fork = perf_event__repipe_fork;
357 inject->tool.tracing_data = perf_event__repipe_tracing_data;
360 session = perf_session__new(inject->input_name, O_RDONLY, false, true, &inject->tool);
364 if (inject->build_ids) {
365 inject->tool.sample = perf_event__inject_buildid;
366 } else if (inject->sched_stat) {
367 struct perf_evsel *evsel;
369 inject->tool.ordered_samples = true;
371 list_for_each_entry(evsel, &session->evlist->entries, node) {
372 const char *name = perf_evsel__name(evsel);
374 if (!strcmp(name, "sched:sched_switch")) {
375 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID"))
378 evsel->handler.func = perf_inject__sched_switch;
379 } else if (!strcmp(name, "sched:sched_process_exit"))
380 evsel->handler.func = perf_inject__sched_process_exit;
381 else if (!strncmp(name, "sched:sched_stat_", 17))
382 evsel->handler.func = perf_inject__sched_stat;
386 if (!inject->pipe_output)
387 lseek(inject->output, session->header.data_offset, SEEK_SET);
389 ret = perf_session__process_events(session, &inject->tool);
391 if (!inject->pipe_output) {
392 session->header.data_size = inject->bytes_written;
393 perf_session__write_header(session, session->evlist, inject->output, true);
396 perf_session__delete(session);
401 int cmd_inject(int argc, const char **argv, const char *prefix __maybe_unused)
403 struct perf_inject inject = {
405 .sample = perf_event__repipe_sample,
406 .mmap = perf_event__repipe,
407 .mmap2 = perf_event__repipe,
408 .comm = perf_event__repipe,
409 .fork = perf_event__repipe,
410 .exit = perf_event__repipe,
411 .lost = perf_event__repipe,
412 .read = perf_event__repipe_sample,
413 .throttle = perf_event__repipe,
414 .unthrottle = perf_event__repipe,
415 .attr = perf_event__repipe_attr,
416 .tracing_data = perf_event__repipe_op2_synth,
417 .finished_round = perf_event__repipe_op2_synth,
418 .build_id = perf_event__repipe_op2_synth,
421 .samples = LIST_HEAD_INIT(inject.samples),
423 const char *output_name = "-";
424 const struct option options[] = {
425 OPT_BOOLEAN('b', "build-ids", &inject.build_ids,
426 "Inject build-ids into the output stream"),
427 OPT_STRING('i', "input", &inject.input_name, "file",
429 OPT_STRING('o', "output", &output_name, "file",
431 OPT_BOOLEAN('s', "sched-stat", &inject.sched_stat,
432 "Merge sched-stat and sched-switch for getting events "
433 "where and how long tasks slept"),
434 OPT_INCR('v', "verbose", &verbose,
435 "be more verbose (show build ids, etc)"),
438 const char * const inject_usage[] = {
439 "perf inject [<options>]",
443 argc = parse_options(argc, argv, options, inject_usage, 0);
446 * Any (unrecognized) arguments left?
449 usage_with_options(inject_usage, options);
451 if (!strcmp(output_name, "-")) {
452 inject.pipe_output = 1;
453 inject.output = STDOUT_FILENO;
455 inject.output = open(output_name, O_CREAT | O_WRONLY | O_TRUNC,
457 if (inject.output < 0) {
458 perror("failed to create output file");
463 if (symbol__init() < 0)
466 return __cmd_inject(&inject);