Linux Audio

Check our new training course

Loading...
v5.4
  1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * builtin-inject.c
  4 *
  5 * Builtin inject command: Examine the live mode (stdin) event stream
  6 * and repipe it to stdout while optionally injecting additional
  7 * events into it.
  8 */
  9#include "builtin.h"
 10
 
 11#include "util/color.h"
 12#include "util/dso.h"
 13#include "util/evlist.h"
 14#include "util/evsel.h"
 15#include "util/map.h"
 16#include "util/session.h"
 17#include "util/tool.h"
 18#include "util/debug.h"
 19#include "util/build-id.h"
 20#include "util/data.h"
 21#include "util/auxtrace.h"
 22#include "util/jit.h"
 23#include "util/symbol.h"
 24#include "util/synthetic-events.h"
 25#include "util/thread.h"
 26#include <linux/err.h>
 27
 28#include <subcmd/parse-options.h>
 29
 30#include <linux/list.h>
 31#include <errno.h>
 32#include <signal.h>
 33
 34struct perf_inject {
 35	struct perf_tool	tool;
 36	struct perf_session	*session;
 37	bool			build_ids;
 38	bool			sched_stat;
 39	bool			have_auxtrace;
 40	bool			strip;
 41	bool			jit_mode;
 42	const char		*input_name;
 43	struct perf_data	output;
 44	u64			bytes_written;
 45	u64			aux_id;
 46	struct list_head	samples;
 47	struct itrace_synth_opts itrace_synth_opts;
 48};
 49
 50struct event_entry {
 51	struct list_head node;
 52	u32		 tid;
 53	union perf_event event[0];
 54};
 55
 56static int output_bytes(struct perf_inject *inject, void *buf, size_t sz)
 
 57{
 
 58	ssize_t size;
 59
 60	size = perf_data__write(&inject->output, buf, sz);
 
 61	if (size < 0)
 62		return -errno;
 63
 64	inject->bytes_written += size;
 65	return 0;
 66}
 67
 68static int perf_event__repipe_synth(struct perf_tool *tool,
 69				    union perf_event *event)
 70{
 71	struct perf_inject *inject = container_of(tool, struct perf_inject,
 72						  tool);
 73
 74	return output_bytes(inject, event, event->header.size);
 75}
 76
 77static int perf_event__repipe_oe_synth(struct perf_tool *tool,
 78				       union perf_event *event,
 79				       struct ordered_events *oe __maybe_unused)
 80{
 81	return perf_event__repipe_synth(tool, event);
 82}
 83
 84#ifdef HAVE_JITDUMP
 85static int perf_event__drop_oe(struct perf_tool *tool __maybe_unused,
 86			       union perf_event *event __maybe_unused,
 87			       struct ordered_events *oe __maybe_unused)
 88{
 89	return 0;
 90}
 91#endif
 92
 93static int perf_event__repipe_op2_synth(struct perf_session *session,
 94					union perf_event *event)
 95{
 96	return perf_event__repipe_synth(session->tool, event);
 97}
 98
 99static int perf_event__repipe_attr(struct perf_tool *tool,
100				   union perf_event *event,
101				   struct evlist **pevlist)
102{
103	struct perf_inject *inject = container_of(tool, struct perf_inject,
104						  tool);
105	int ret;
106
107	ret = perf_event__process_attr(tool, event, pevlist);
108	if (ret)
109		return ret;
110
111	if (!inject->output.is_pipe)
112		return 0;
113
114	return perf_event__repipe_synth(tool, event);
115}
116
117#ifdef HAVE_AUXTRACE_SUPPORT
118
119static int copy_bytes(struct perf_inject *inject, int fd, off_t size)
120{
121	char buf[4096];
122	ssize_t ssz;
123	int ret;
124
125	while (size > 0) {
126		ssz = read(fd, buf, min(size, (off_t)sizeof(buf)));
127		if (ssz < 0)
128			return -errno;
129		ret = output_bytes(inject, buf, ssz);
130		if (ret)
131			return ret;
132		size -= ssz;
133	}
134
135	return 0;
136}
137
138static s64 perf_event__repipe_auxtrace(struct perf_session *session,
139				       union perf_event *event)
140{
141	struct perf_tool *tool = session->tool;
142	struct perf_inject *inject = container_of(tool, struct perf_inject,
143						  tool);
144	int ret;
145
146	inject->have_auxtrace = true;
147
148	if (!inject->output.is_pipe) {
149		off_t offset;
150
151		offset = lseek(inject->output.file.fd, 0, SEEK_CUR);
152		if (offset == -1)
153			return -errno;
154		ret = auxtrace_index__auxtrace_event(&session->auxtrace_index,
155						     event, offset);
156		if (ret < 0)
157			return ret;
158	}
159
160	if (perf_data__is_pipe(session->data) || !session->one_mmap) {
161		ret = output_bytes(inject, event, event->header.size);
162		if (ret < 0)
163			return ret;
164		ret = copy_bytes(inject, perf_data__fd(session->data),
165				 event->auxtrace.size);
166	} else {
167		ret = output_bytes(inject, event,
168				   event->header.size + event->auxtrace.size);
169	}
170	if (ret < 0)
171		return ret;
172
173	return event->auxtrace.size;
174}
175
176#else
177
178static s64
179perf_event__repipe_auxtrace(struct perf_session *session __maybe_unused,
180			    union perf_event *event __maybe_unused)
181{
182	pr_err("AUX area tracing not supported\n");
183	return -EINVAL;
184}
185
186#endif
187
188static int perf_event__repipe(struct perf_tool *tool,
189			      union perf_event *event,
190			      struct perf_sample *sample __maybe_unused,
191			      struct machine *machine __maybe_unused)
192{
193	return perf_event__repipe_synth(tool, event);
194}
195
196static int perf_event__drop(struct perf_tool *tool __maybe_unused,
197			    union perf_event *event __maybe_unused,
198			    struct perf_sample *sample __maybe_unused,
199			    struct machine *machine __maybe_unused)
200{
201	return 0;
202}
203
204static int perf_event__drop_aux(struct perf_tool *tool,
205				union perf_event *event __maybe_unused,
206				struct perf_sample *sample,
207				struct machine *machine __maybe_unused)
208{
209	struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
210
211	if (!inject->aux_id)
212		inject->aux_id = sample->id;
213
214	return 0;
215}
216
217typedef int (*inject_handler)(struct perf_tool *tool,
218			      union perf_event *event,
219			      struct perf_sample *sample,
220			      struct evsel *evsel,
221			      struct machine *machine);
222
223static int perf_event__repipe_sample(struct perf_tool *tool,
224				     union perf_event *event,
225				     struct perf_sample *sample,
226				     struct evsel *evsel,
227				     struct machine *machine)
228{
229	if (evsel && evsel->handler) {
230		inject_handler f = evsel->handler;
231		return f(tool, event, sample, evsel, machine);
232	}
233
234	build_id__mark_dso_hit(tool, event, sample, evsel, machine);
235
236	return perf_event__repipe_synth(tool, event);
237}
238
239static int perf_event__repipe_mmap(struct perf_tool *tool,
240				   union perf_event *event,
241				   struct perf_sample *sample,
242				   struct machine *machine)
243{
244	int err;
245
246	err = perf_event__process_mmap(tool, event, sample, machine);
247	perf_event__repipe(tool, event, sample, machine);
248
249	return err;
250}
251
252#ifdef HAVE_JITDUMP
253static int perf_event__jit_repipe_mmap(struct perf_tool *tool,
254				       union perf_event *event,
255				       struct perf_sample *sample,
256				       struct machine *machine)
257{
258	struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
259	u64 n = 0;
260	int ret;
261
262	/*
263	 * if jit marker, then inject jit mmaps and generate ELF images
264	 */
265	ret = jit_process(inject->session, &inject->output, machine,
266			  event->mmap.filename, sample->pid, &n);
267	if (ret < 0)
268		return ret;
269	if (ret) {
270		inject->bytes_written += n;
271		return 0;
272	}
273	return perf_event__repipe_mmap(tool, event, sample, machine);
274}
275#endif
276
277static int perf_event__repipe_mmap2(struct perf_tool *tool,
278				   union perf_event *event,
279				   struct perf_sample *sample,
280				   struct machine *machine)
281{
282	int err;
283
284	err = perf_event__process_mmap2(tool, event, sample, machine);
285	perf_event__repipe(tool, event, sample, machine);
286
287	return err;
288}
289
290#ifdef HAVE_JITDUMP
291static int perf_event__jit_repipe_mmap2(struct perf_tool *tool,
292					union perf_event *event,
293					struct perf_sample *sample,
294					struct machine *machine)
295{
296	struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
297	u64 n = 0;
298	int ret;
299
300	/*
301	 * if jit marker, then inject jit mmaps and generate ELF images
302	 */
303	ret = jit_process(inject->session, &inject->output, machine,
304			  event->mmap2.filename, sample->pid, &n);
305	if (ret < 0)
306		return ret;
307	if (ret) {
308		inject->bytes_written += n;
309		return 0;
310	}
311	return perf_event__repipe_mmap2(tool, event, sample, machine);
312}
313#endif
314
315static int perf_event__repipe_fork(struct perf_tool *tool,
316				   union perf_event *event,
317				   struct perf_sample *sample,
318				   struct machine *machine)
319{
320	int err;
321
322	err = perf_event__process_fork(tool, event, sample, machine);
323	perf_event__repipe(tool, event, sample, machine);
324
325	return err;
326}
327
328static int perf_event__repipe_comm(struct perf_tool *tool,
329				   union perf_event *event,
330				   struct perf_sample *sample,
331				   struct machine *machine)
332{
333	int err;
334
335	err = perf_event__process_comm(tool, event, sample, machine);
336	perf_event__repipe(tool, event, sample, machine);
337
338	return err;
339}
340
341static int perf_event__repipe_namespaces(struct perf_tool *tool,
342					 union perf_event *event,
343					 struct perf_sample *sample,
344					 struct machine *machine)
345{
346	int err = perf_event__process_namespaces(tool, event, sample, machine);
347
348	perf_event__repipe(tool, event, sample, machine);
349
350	return err;
351}
352
353static int perf_event__repipe_exit(struct perf_tool *tool,
354				   union perf_event *event,
355				   struct perf_sample *sample,
356				   struct machine *machine)
357{
358	int err;
359
360	err = perf_event__process_exit(tool, event, sample, machine);
361	perf_event__repipe(tool, event, sample, machine);
362
363	return err;
364}
365
366static int perf_event__repipe_tracing_data(struct perf_session *session,
367					   union perf_event *event)
368{
369	int err;
370
371	perf_event__repipe_synth(session->tool, event);
372	err = perf_event__process_tracing_data(session, event);
373
374	return err;
375}
376
377static int perf_event__repipe_id_index(struct perf_session *session,
378				       union perf_event *event)
379{
380	int err;
381
382	perf_event__repipe_synth(session->tool, event);
383	err = perf_event__process_id_index(session, event);
384
385	return err;
386}
387
388static int dso__read_build_id(struct dso *dso)
389{
390	if (dso->has_build_id)
391		return 0;
392
393	if (filename__read_build_id(dso->long_name, dso->build_id,
394				    sizeof(dso->build_id)) > 0) {
395		dso->has_build_id = true;
396		return 0;
397	}
398
399	return -1;
400}
401
402static int dso__inject_build_id(struct dso *dso, struct perf_tool *tool,
403				struct machine *machine)
404{
405	u16 misc = PERF_RECORD_MISC_USER;
406	int err;
407
408	if (dso__read_build_id(dso) < 0) {
409		pr_debug("no build_id found for %s\n", dso->long_name);
410		return -1;
411	}
412
413	if (dso->kernel)
414		misc = PERF_RECORD_MISC_KERNEL;
415
416	err = perf_event__synthesize_build_id(tool, dso, misc, perf_event__repipe,
417					      machine);
418	if (err) {
419		pr_err("Can't synthesize build_id event for %s\n", dso->long_name);
420		return -1;
421	}
422
423	return 0;
424}
425
426static int perf_event__inject_buildid(struct perf_tool *tool,
427				      union perf_event *event,
428				      struct perf_sample *sample,
429				      struct evsel *evsel __maybe_unused,
430				      struct machine *machine)
431{
432	struct addr_location al;
433	struct thread *thread;
 
434
435	thread = machine__findnew_thread(machine, sample->pid, sample->tid);
 
 
436	if (thread == NULL) {
437		pr_err("problem processing %d event, skipping it.\n",
438		       event->header.type);
439		goto repipe;
440	}
441
442	if (thread__find_map(thread, sample->cpumode, sample->ip, &al)) {
 
 
 
443		if (!al.map->dso->hit) {
444			al.map->dso->hit = 1;
445			if (map__load(al.map) >= 0) {
446				dso__inject_build_id(al.map->dso, tool, machine);
447				/*
448				 * If this fails, too bad, let the other side
449				 * account this as unresolved.
450				 */
451			} else {
452#ifdef HAVE_LIBELF_SUPPORT
453				pr_warning("no symbols found in %s, maybe "
454					   "install a debug package?\n",
455					   al.map->dso->long_name);
456#endif
457			}
458		}
459	}
460
461	thread__put(thread);
462repipe:
463	perf_event__repipe(tool, event, sample, machine);
464	return 0;
465}
466
467static int perf_inject__sched_process_exit(struct perf_tool *tool,
468					   union perf_event *event __maybe_unused,
469					   struct perf_sample *sample,
470					   struct evsel *evsel __maybe_unused,
471					   struct machine *machine __maybe_unused)
472{
473	struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
474	struct event_entry *ent;
475
476	list_for_each_entry(ent, &inject->samples, node) {
477		if (sample->tid == ent->tid) {
478			list_del_init(&ent->node);
479			free(ent);
480			break;
481		}
482	}
483
484	return 0;
485}
486
487static int perf_inject__sched_switch(struct perf_tool *tool,
488				     union perf_event *event,
489				     struct perf_sample *sample,
490				     struct evsel *evsel,
491				     struct machine *machine)
492{
493	struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
494	struct event_entry *ent;
495
496	perf_inject__sched_process_exit(tool, event, sample, evsel, machine);
497
498	ent = malloc(event->header.size + sizeof(struct event_entry));
499	if (ent == NULL) {
500		color_fprintf(stderr, PERF_COLOR_RED,
501			     "Not enough memory to process sched switch event!");
502		return -1;
503	}
504
505	ent->tid = sample->tid;
506	memcpy(&ent->event, event, event->header.size);
507	list_add(&ent->node, &inject->samples);
508	return 0;
509}
510
511static int perf_inject__sched_stat(struct perf_tool *tool,
512				   union perf_event *event __maybe_unused,
513				   struct perf_sample *sample,
514				   struct evsel *evsel,
515				   struct machine *machine)
516{
517	struct event_entry *ent;
518	union perf_event *event_sw;
519	struct perf_sample sample_sw;
520	struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
521	u32 pid = perf_evsel__intval(evsel, sample, "pid");
522
523	list_for_each_entry(ent, &inject->samples, node) {
524		if (pid == ent->tid)
525			goto found;
526	}
527
528	return 0;
529found:
530	event_sw = &ent->event[0];
531	perf_evsel__parse_sample(evsel, event_sw, &sample_sw);
532
533	sample_sw.period = sample->period;
534	sample_sw.time	 = sample->time;
535	perf_event__synthesize_sample(event_sw, evsel->core.attr.sample_type,
536				      evsel->core.attr.read_format, &sample_sw);
 
537	build_id__mark_dso_hit(tool, event_sw, &sample_sw, evsel, machine);
538	return perf_event__repipe(tool, event_sw, &sample_sw, machine);
539}
540
541static void sig_handler(int sig __maybe_unused)
542{
543	session_done = 1;
544}
545
546static int perf_evsel__check_stype(struct evsel *evsel,
547				   u64 sample_type, const char *sample_msg)
548{
549	struct perf_event_attr *attr = &evsel->core.attr;
550	const char *name = perf_evsel__name(evsel);
551
552	if (!(attr->sample_type & sample_type)) {
553		pr_err("Samples for %s event do not have %s attribute set.",
554			name, sample_msg);
555		return -EINVAL;
556	}
557
558	return 0;
559}
560
561static int drop_sample(struct perf_tool *tool __maybe_unused,
562		       union perf_event *event __maybe_unused,
563		       struct perf_sample *sample __maybe_unused,
564		       struct evsel *evsel __maybe_unused,
565		       struct machine *machine __maybe_unused)
566{
567	return 0;
568}
569
570static void strip_init(struct perf_inject *inject)
571{
572	struct evlist *evlist = inject->session->evlist;
573	struct evsel *evsel;
574
575	inject->tool.context_switch = perf_event__drop;
576
577	evlist__for_each_entry(evlist, evsel)
578		evsel->handler = drop_sample;
579}
580
581static bool has_tracking(struct evsel *evsel)
582{
583	return evsel->core.attr.mmap || evsel->core.attr.mmap2 || evsel->core.attr.comm ||
584	       evsel->core.attr.task;
585}
586
587#define COMPAT_MASK (PERF_SAMPLE_ID | PERF_SAMPLE_TID | PERF_SAMPLE_TIME | \
588		     PERF_SAMPLE_ID | PERF_SAMPLE_CPU | PERF_SAMPLE_IDENTIFIER)
589
590/*
591 * In order that the perf.data file is parsable, tracking events like MMAP need
592 * their selected event to exist, except if there is only 1 selected event left
593 * and it has a compatible sample type.
594 */
595static bool ok_to_remove(struct evlist *evlist,
596			 struct evsel *evsel_to_remove)
597{
598	struct evsel *evsel;
599	int cnt = 0;
600	bool ok = false;
601
602	if (!has_tracking(evsel_to_remove))
603		return true;
604
605	evlist__for_each_entry(evlist, evsel) {
606		if (evsel->handler != drop_sample) {
607			cnt += 1;
608			if ((evsel->core.attr.sample_type & COMPAT_MASK) ==
609			    (evsel_to_remove->core.attr.sample_type & COMPAT_MASK))
610				ok = true;
611		}
612	}
613
614	return ok && cnt == 1;
615}
616
617static void strip_fini(struct perf_inject *inject)
618{
619	struct evlist *evlist = inject->session->evlist;
620	struct evsel *evsel, *tmp;
621
622	/* Remove non-synthesized evsels if possible */
623	evlist__for_each_entry_safe(evlist, tmp, evsel) {
624		if (evsel->handler == drop_sample &&
625		    ok_to_remove(evlist, evsel)) {
626			pr_debug("Deleting %s\n", perf_evsel__name(evsel));
627			evlist__remove(evlist, evsel);
628			evsel__delete(evsel);
629		}
630	}
631}
632
633static int __cmd_inject(struct perf_inject *inject)
634{
 
635	int ret = -EINVAL;
636	struct perf_session *session = inject->session;
637	struct perf_data *data_out = &inject->output;
638	int fd = perf_data__fd(data_out);
639	u64 output_data_offset;
 
640
641	signal(SIGINT, sig_handler);
642
643	if (inject->build_ids || inject->sched_stat ||
644	    inject->itrace_synth_opts.set) {
645		inject->tool.mmap	  = perf_event__repipe_mmap;
646		inject->tool.mmap2	  = perf_event__repipe_mmap2;
647		inject->tool.fork	  = perf_event__repipe_fork;
648		inject->tool.tracing_data = perf_event__repipe_tracing_data;
649	}
650
651	output_data_offset = session->header.data_offset;
 
 
652
653	if (inject->build_ids) {
654		inject->tool.sample = perf_event__inject_buildid;
655	} else if (inject->sched_stat) {
656		struct evsel *evsel;
657
658		evlist__for_each_entry(session->evlist, evsel) {
 
 
659			const char *name = perf_evsel__name(evsel);
660
661			if (!strcmp(name, "sched:sched_switch")) {
662				if (perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID"))
663					return -EINVAL;
664
665				evsel->handler = perf_inject__sched_switch;
666			} else if (!strcmp(name, "sched:sched_process_exit"))
667				evsel->handler = perf_inject__sched_process_exit;
668			else if (!strncmp(name, "sched:sched_stat_", 17))
669				evsel->handler = perf_inject__sched_stat;
670		}
671	} else if (inject->itrace_synth_opts.set) {
672		session->itrace_synth_opts = &inject->itrace_synth_opts;
673		inject->itrace_synth_opts.inject = true;
674		inject->tool.comm	    = perf_event__repipe_comm;
675		inject->tool.namespaces	    = perf_event__repipe_namespaces;
676		inject->tool.exit	    = perf_event__repipe_exit;
677		inject->tool.id_index	    = perf_event__repipe_id_index;
678		inject->tool.auxtrace_info  = perf_event__process_auxtrace_info;
679		inject->tool.auxtrace	    = perf_event__process_auxtrace;
680		inject->tool.aux	    = perf_event__drop_aux;
681		inject->tool.itrace_start   = perf_event__drop_aux,
682		inject->tool.ordered_events = true;
683		inject->tool.ordering_requires_timestamps = true;
684		/* Allow space in the header for new attributes */
685		output_data_offset = 4096;
686		if (inject->strip)
687			strip_init(inject);
688	}
689
690	if (!inject->itrace_synth_opts.set)
691		auxtrace_index__free(&session->auxtrace_index);
692
693	if (!data_out->is_pipe)
694		lseek(fd, output_data_offset, SEEK_SET);
695
696	ret = perf_session__process_events(session);
697	if (ret)
698		return ret;
699
700	if (!data_out->is_pipe) {
701		if (inject->build_ids)
702			perf_header__set_feat(&session->header,
703					      HEADER_BUILD_ID);
704		/*
705		 * Keep all buildids when there is unprocessed AUX data because
706		 * it is not known which ones the AUX trace hits.
707		 */
708		if (perf_header__has_feat(&session->header, HEADER_BUILD_ID) &&
709		    inject->have_auxtrace && !inject->itrace_synth_opts.set)
710			dsos__hit_all(session);
711		/*
712		 * The AUX areas have been removed and replaced with
713		 * synthesized hardware events, so clear the feature flag and
714		 * remove the evsel.
715		 */
716		if (inject->itrace_synth_opts.set) {
717			struct evsel *evsel;
718
719			perf_header__clear_feat(&session->header,
720						HEADER_AUXTRACE);
721			if (inject->itrace_synth_opts.last_branch)
722				perf_header__set_feat(&session->header,
723						      HEADER_BRANCH_STACK);
724			evsel = perf_evlist__id2evsel_strict(session->evlist,
725							     inject->aux_id);
726			if (evsel) {
727				pr_debug("Deleting %s\n",
728					 perf_evsel__name(evsel));
729				evlist__remove(session->evlist, evsel);
730				evsel__delete(evsel);
731			}
732			if (inject->strip)
733				strip_fini(inject);
734		}
735		session->header.data_offset = output_data_offset;
736		session->header.data_size = inject->bytes_written;
737		perf_session__write_header(session, session->evlist, fd, true);
738	}
739
 
 
740	return ret;
741}
742
743int cmd_inject(int argc, const char **argv)
744{
745	struct perf_inject inject = {
746		.tool = {
747			.sample		= perf_event__repipe_sample,
748			.mmap		= perf_event__repipe,
749			.mmap2		= perf_event__repipe,
750			.comm		= perf_event__repipe,
751			.fork		= perf_event__repipe,
752			.exit		= perf_event__repipe,
753			.lost		= perf_event__repipe,
754			.lost_samples	= perf_event__repipe,
755			.aux		= perf_event__repipe,
756			.itrace_start	= perf_event__repipe,
757			.context_switch	= perf_event__repipe,
758			.read		= perf_event__repipe_sample,
759			.throttle	= perf_event__repipe,
760			.unthrottle	= perf_event__repipe,
761			.attr		= perf_event__repipe_attr,
762			.tracing_data	= perf_event__repipe_op2_synth,
763			.auxtrace_info	= perf_event__repipe_op2_synth,
764			.auxtrace	= perf_event__repipe_auxtrace,
765			.auxtrace_error	= perf_event__repipe_op2_synth,
766			.time_conv	= perf_event__repipe_op2_synth,
767			.finished_round	= perf_event__repipe_oe_synth,
768			.build_id	= perf_event__repipe_op2_synth,
769			.id_index	= perf_event__repipe_op2_synth,
770			.feature	= perf_event__repipe_op2_synth,
771		},
772		.input_name  = "-",
773		.samples = LIST_HEAD_INIT(inject.samples),
774		.output = {
775			.path = "-",
776			.mode = PERF_DATA_MODE_WRITE,
777		},
778	};
779	struct perf_data data = {
780		.mode = PERF_DATA_MODE_READ,
781	};
782	int ret;
783
784	struct option options[] = {
785		OPT_BOOLEAN('b', "build-ids", &inject.build_ids,
786			    "Inject build-ids into the output stream"),
787		OPT_STRING('i', "input", &inject.input_name, "file",
788			   "input file name"),
789		OPT_STRING('o', "output", &inject.output.path, "file",
790			   "output file name"),
791		OPT_BOOLEAN('s', "sched-stat", &inject.sched_stat,
792			    "Merge sched-stat and sched-switch for getting events "
793			    "where and how long tasks slept"),
794#ifdef HAVE_JITDUMP
795		OPT_BOOLEAN('j', "jit", &inject.jit_mode, "merge jitdump files into perf.data file"),
796#endif
797		OPT_INCR('v', "verbose", &verbose,
798			 "be more verbose (show build ids, etc)"),
799		OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, "file",
800			   "kallsyms pathname"),
801		OPT_BOOLEAN('f', "force", &data.force, "don't complain, do it"),
802		OPT_CALLBACK_OPTARG(0, "itrace", &inject.itrace_synth_opts,
803				    NULL, "opts", "Instruction Tracing options\n"
804				    ITRACE_HELP,
805				    itrace_parse_synth_opts),
806		OPT_BOOLEAN(0, "strip", &inject.strip,
807			    "strip non-synthesized events (use with --itrace)"),
808		OPT_END()
809	};
810	const char * const inject_usage[] = {
811		"perf inject [<options>]",
812		NULL
813	};
814#ifndef HAVE_JITDUMP
815	set_option_nobuild(options, 'j', "jit", "NO_LIBELF=1", true);
816#endif
817	argc = parse_options(argc, argv, options, inject_usage, 0);
818
819	/*
820	 * Any (unrecognized) arguments left?
821	 */
822	if (argc)
823		usage_with_options(inject_usage, options);
824
825	if (inject.strip && !inject.itrace_synth_opts.set) {
826		pr_err("--strip option requires --itrace option\n");
827		return -1;
828	}
829
830	if (perf_data__open(&inject.output)) {
831		perror("failed to create output file");
832		return -1;
833	}
834
835	inject.tool.ordered_events = inject.sched_stat;
 
836
837	data.path = inject.input_name;
838	inject.session = perf_session__new(&data, true, &inject.tool);
839	if (IS_ERR(inject.session))
840		return PTR_ERR(inject.session);
841
842	if (zstd_init(&(inject.session->zstd_data), 0) < 0)
843		pr_warning("Decompression initialization failed.\n");
844
845	if (inject.build_ids) {
846		/*
847		 * to make sure the mmap records are ordered correctly
848		 * and so that the correct especially due to jitted code
849		 * mmaps. We cannot generate the buildid hit list and
850		 * inject the jit mmaps at the same time for now.
851		 */
852		inject.tool.ordered_events = true;
853		inject.tool.ordering_requires_timestamps = true;
854	}
855#ifdef HAVE_JITDUMP
856	if (inject.jit_mode) {
857		inject.tool.mmap2	   = perf_event__jit_repipe_mmap2;
858		inject.tool.mmap	   = perf_event__jit_repipe_mmap;
859		inject.tool.ordered_events = true;
860		inject.tool.ordering_requires_timestamps = true;
861		/*
862		 * JIT MMAP injection injects all MMAP events in one go, so it
863		 * does not obey finished_round semantics.
864		 */
865		inject.tool.finished_round = perf_event__drop_oe;
866	}
867#endif
868	ret = symbol__init(&inject.session->header.env);
869	if (ret < 0)
870		goto out_delete;
871
872	ret = __cmd_inject(&inject);
873
874out_delete:
875	zstd_fini(&(inject.session->zstd_data));
876	perf_session__delete(inject.session);
877	return ret;
878}
v3.15
 
  1/*
  2 * builtin-inject.c
  3 *
  4 * Builtin inject command: Examine the live mode (stdin) event stream
  5 * and repipe it to stdout while optionally injecting additional
  6 * events into it.
  7 */
  8#include "builtin.h"
  9
 10#include "perf.h"
 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
 20#include "util/parse-options.h"
 21
 22#include <linux/list.h>
 
 
 23
 24struct perf_inject {
 25	struct perf_tool	tool;
 
 26	bool			build_ids;
 27	bool			sched_stat;
 
 
 
 28	const char		*input_name;
 29	struct perf_data_file	output;
 30	u64			bytes_written;
 
 31	struct list_head	samples;
 
 32};
 33
 34struct event_entry {
 35	struct list_head node;
 36	u32		 tid;
 37	union perf_event event[0];
 38};
 39
 40static int perf_event__repipe_synth(struct perf_tool *tool,
 41				    union perf_event *event)
 42{
 43	struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
 44	ssize_t size;
 45
 46	size = perf_data_file__write(&inject->output, event,
 47				     event->header.size);
 48	if (size < 0)
 49		return -errno;
 50
 51	inject->bytes_written += size;
 52	return 0;
 53}
 54
 55static int perf_event__repipe_op2_synth(struct perf_tool *tool,
 56					union perf_event *event,
 57					struct perf_session *session
 58					__maybe_unused)
 
 
 
 
 
 
 
 
 59{
 60	return perf_event__repipe_synth(tool, event);
 61}
 62
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 63static int perf_event__repipe_attr(struct perf_tool *tool,
 64				   union perf_event *event,
 65				   struct perf_evlist **pevlist)
 66{
 67	struct perf_inject *inject = container_of(tool, struct perf_inject,
 68						  tool);
 69	int ret;
 70
 71	ret = perf_event__process_attr(tool, event, pevlist);
 72	if (ret)
 73		return ret;
 74
 75	if (&inject->output.is_pipe)
 76		return 0;
 77
 78	return perf_event__repipe_synth(tool, event);
 79}
 80
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 81static int perf_event__repipe(struct perf_tool *tool,
 82			      union perf_event *event,
 83			      struct perf_sample *sample __maybe_unused,
 84			      struct machine *machine __maybe_unused)
 85{
 86	return perf_event__repipe_synth(tool, event);
 87}
 88
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 89typedef int (*inject_handler)(struct perf_tool *tool,
 90			      union perf_event *event,
 91			      struct perf_sample *sample,
 92			      struct perf_evsel *evsel,
 93			      struct machine *machine);
 94
 95static int perf_event__repipe_sample(struct perf_tool *tool,
 96				     union perf_event *event,
 97				     struct perf_sample *sample,
 98				     struct perf_evsel *evsel,
 99				     struct machine *machine)
100{
101	if (evsel->handler) {
102		inject_handler f = evsel->handler;
103		return f(tool, event, sample, evsel, machine);
104	}
105
106	build_id__mark_dso_hit(tool, event, sample, evsel, machine);
107
108	return perf_event__repipe_synth(tool, event);
109}
110
111static int perf_event__repipe_mmap(struct perf_tool *tool,
112				   union perf_event *event,
113				   struct perf_sample *sample,
114				   struct machine *machine)
115{
116	int err;
117
118	err = perf_event__process_mmap(tool, event, sample, machine);
119	perf_event__repipe(tool, event, sample, machine);
120
121	return err;
122}
123
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
124static int perf_event__repipe_mmap2(struct perf_tool *tool,
125				   union perf_event *event,
126				   struct perf_sample *sample,
127				   struct machine *machine)
128{
129	int err;
130
131	err = perf_event__process_mmap2(tool, event, sample, machine);
132	perf_event__repipe(tool, event, sample, machine);
133
134	return err;
135}
136
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
137static int perf_event__repipe_fork(struct perf_tool *tool,
138				   union perf_event *event,
139				   struct perf_sample *sample,
140				   struct machine *machine)
141{
142	int err;
143
144	err = perf_event__process_fork(tool, event, sample, machine);
145	perf_event__repipe(tool, event, sample, machine);
146
147	return err;
148}
149
150static int perf_event__repipe_tracing_data(struct perf_tool *tool,
151					   union perf_event *event,
152					   struct perf_session *session)
 
153{
154	int err;
155
156	perf_event__repipe_synth(tool, event);
157	err = perf_event__process_tracing_data(tool, event, session);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
158
159	return err;
160}
161
162static int dso__read_build_id(struct dso *dso)
163{
164	if (dso->has_build_id)
165		return 0;
166
167	if (filename__read_build_id(dso->long_name, dso->build_id,
168				    sizeof(dso->build_id)) > 0) {
169		dso->has_build_id = true;
170		return 0;
171	}
172
173	return -1;
174}
175
176static int dso__inject_build_id(struct dso *dso, struct perf_tool *tool,
177				struct machine *machine)
178{
179	u16 misc = PERF_RECORD_MISC_USER;
180	int err;
181
182	if (dso__read_build_id(dso) < 0) {
183		pr_debug("no build_id found for %s\n", dso->long_name);
184		return -1;
185	}
186
187	if (dso->kernel)
188		misc = PERF_RECORD_MISC_KERNEL;
189
190	err = perf_event__synthesize_build_id(tool, dso, misc, perf_event__repipe,
191					      machine);
192	if (err) {
193		pr_err("Can't synthesize build_id event for %s\n", dso->long_name);
194		return -1;
195	}
196
197	return 0;
198}
199
200static int perf_event__inject_buildid(struct perf_tool *tool,
201				      union perf_event *event,
202				      struct perf_sample *sample,
203				      struct perf_evsel *evsel __maybe_unused,
204				      struct machine *machine)
205{
206	struct addr_location al;
207	struct thread *thread;
208	u8 cpumode;
209
210	cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
211
212	thread = machine__findnew_thread(machine, sample->pid, sample->pid);
213	if (thread == NULL) {
214		pr_err("problem processing %d event, skipping it.\n",
215		       event->header.type);
216		goto repipe;
217	}
218
219	thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
220			      sample->ip, &al);
221
222	if (al.map != NULL) {
223		if (!al.map->dso->hit) {
224			al.map->dso->hit = 1;
225			if (map__load(al.map, NULL) >= 0) {
226				dso__inject_build_id(al.map->dso, tool, machine);
227				/*
228				 * If this fails, too bad, let the other side
229				 * account this as unresolved.
230				 */
231			} else {
232#ifdef HAVE_LIBELF_SUPPORT
233				pr_warning("no symbols found in %s, maybe "
234					   "install a debug package?\n",
235					   al.map->dso->long_name);
236#endif
237			}
238		}
239	}
240
 
241repipe:
242	perf_event__repipe(tool, event, sample, machine);
243	return 0;
244}
245
246static int perf_inject__sched_process_exit(struct perf_tool *tool,
247					   union perf_event *event __maybe_unused,
248					   struct perf_sample *sample,
249					   struct perf_evsel *evsel __maybe_unused,
250					   struct machine *machine __maybe_unused)
251{
252	struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
253	struct event_entry *ent;
254
255	list_for_each_entry(ent, &inject->samples, node) {
256		if (sample->tid == ent->tid) {
257			list_del_init(&ent->node);
258			free(ent);
259			break;
260		}
261	}
262
263	return 0;
264}
265
266static int perf_inject__sched_switch(struct perf_tool *tool,
267				     union perf_event *event,
268				     struct perf_sample *sample,
269				     struct perf_evsel *evsel,
270				     struct machine *machine)
271{
272	struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
273	struct event_entry *ent;
274
275	perf_inject__sched_process_exit(tool, event, sample, evsel, machine);
276
277	ent = malloc(event->header.size + sizeof(struct event_entry));
278	if (ent == NULL) {
279		color_fprintf(stderr, PERF_COLOR_RED,
280			     "Not enough memory to process sched switch event!");
281		return -1;
282	}
283
284	ent->tid = sample->tid;
285	memcpy(&ent->event, event, event->header.size);
286	list_add(&ent->node, &inject->samples);
287	return 0;
288}
289
290static int perf_inject__sched_stat(struct perf_tool *tool,
291				   union perf_event *event __maybe_unused,
292				   struct perf_sample *sample,
293				   struct perf_evsel *evsel,
294				   struct machine *machine)
295{
296	struct event_entry *ent;
297	union perf_event *event_sw;
298	struct perf_sample sample_sw;
299	struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
300	u32 pid = perf_evsel__intval(evsel, sample, "pid");
301
302	list_for_each_entry(ent, &inject->samples, node) {
303		if (pid == ent->tid)
304			goto found;
305	}
306
307	return 0;
308found:
309	event_sw = &ent->event[0];
310	perf_evsel__parse_sample(evsel, event_sw, &sample_sw);
311
312	sample_sw.period = sample->period;
313	sample_sw.time	 = sample->time;
314	perf_event__synthesize_sample(event_sw, evsel->attr.sample_type,
315				      evsel->attr.read_format, &sample_sw,
316				      false);
317	build_id__mark_dso_hit(tool, event_sw, &sample_sw, evsel, machine);
318	return perf_event__repipe(tool, event_sw, &sample_sw, machine);
319}
320
321static void sig_handler(int sig __maybe_unused)
322{
323	session_done = 1;
324}
325
326static int perf_evsel__check_stype(struct perf_evsel *evsel,
327				   u64 sample_type, const char *sample_msg)
328{
329	struct perf_event_attr *attr = &evsel->attr;
330	const char *name = perf_evsel__name(evsel);
331
332	if (!(attr->sample_type & sample_type)) {
333		pr_err("Samples for %s event do not have %s attribute set.",
334			name, sample_msg);
335		return -EINVAL;
336	}
337
338	return 0;
339}
340
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
341static int __cmd_inject(struct perf_inject *inject)
342{
343	struct perf_session *session;
344	int ret = -EINVAL;
345	struct perf_data_file file = {
346		.path = inject->input_name,
347		.mode = PERF_DATA_MODE_READ,
348	};
349	struct perf_data_file *file_out = &inject->output;
350
351	signal(SIGINT, sig_handler);
352
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;
358	}
359
360	session = perf_session__new(&file, true, &inject->tool);
361	if (session == NULL)
362		return -ENOMEM;
363
364	if (inject->build_ids) {
365		inject->tool.sample = perf_event__inject_buildid;
366	} else if (inject->sched_stat) {
367		struct perf_evsel *evsel;
368
369		inject->tool.ordered_samples = true;
370
371		evlist__for_each(session->evlist, evsel) {
372			const char *name = perf_evsel__name(evsel);
373
374			if (!strcmp(name, "sched:sched_switch")) {
375				if (perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID"))
376					return -EINVAL;
377
378				evsel->handler = perf_inject__sched_switch;
379			} else if (!strcmp(name, "sched:sched_process_exit"))
380				evsel->handler = perf_inject__sched_process_exit;
381			else if (!strncmp(name, "sched:sched_stat_", 17))
382				evsel->handler = perf_inject__sched_stat;
383		}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
384	}
385
386	if (!file_out->is_pipe)
387		lseek(file_out->fd, session->header.data_offset, SEEK_SET);
 
 
 
388
389	ret = perf_session__process_events(session, &inject->tool);
 
 
390
391	if (!file_out->is_pipe) {
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
392		session->header.data_size = inject->bytes_written;
393		perf_session__write_header(session, session->evlist, file_out->fd, true);
394	}
395
396	perf_session__delete(session);
397
398	return ret;
399}
400
401int cmd_inject(int argc, const char **argv, const char *prefix __maybe_unused)
402{
403	struct perf_inject inject = {
404		.tool = {
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,
 
 
419		},
420		.input_name  = "-",
421		.samples = LIST_HEAD_INIT(inject.samples),
422		.output = {
423			.path = "-",
424			.mode = PERF_DATA_MODE_WRITE,
425		},
426	};
427	const struct option options[] = {
 
 
 
 
 
428		OPT_BOOLEAN('b', "build-ids", &inject.build_ids,
429			    "Inject build-ids into the output stream"),
430		OPT_STRING('i', "input", &inject.input_name, "file",
431			   "input file name"),
432		OPT_STRING('o', "output", &inject.output.path, "file",
433			   "output file name"),
434		OPT_BOOLEAN('s', "sched-stat", &inject.sched_stat,
435			    "Merge sched-stat and sched-switch for getting events "
436			    "where and how long tasks slept"),
 
 
 
437		OPT_INCR('v', "verbose", &verbose,
438			 "be more verbose (show build ids, etc)"),
 
 
 
 
 
 
 
 
 
439		OPT_END()
440	};
441	const char * const inject_usage[] = {
442		"perf inject [<options>]",
443		NULL
444	};
445
 
 
446	argc = parse_options(argc, argv, options, inject_usage, 0);
447
448	/*
449	 * Any (unrecognized) arguments left?
450	 */
451	if (argc)
452		usage_with_options(inject_usage, options);
453
454	if (perf_data_file__open(&inject.output)) {
 
 
 
 
 
455		perror("failed to create output file");
456		return -1;
457	}
458
459	if (symbol__init() < 0)
460		return -1;
461
462	return __cmd_inject(&inject);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
463}