Commit 7491e2c4 authored by Tzvetomir Stoyanov (VMware)'s avatar Tzvetomir Stoyanov (VMware) Committed by Steven Rostedt (VMware)
Browse files

tracing: Add a probe that attaches to trace events 

A new dynamic event is introduced: event probe. The event is attached
to an existing tracepoint and uses its fields as arguments. The user
can specify custom format string of the new event, select what tracepoint
arguments will be printed and how to print them.
An event probe is created by writing configuration string in
'dynamic_events' ftrace file:
 e[:[SNAME/]ENAME] SYSTEM/EVENT [FETCHARGS]	- Set an event probe
 -:SNAME/ENAME					- Delete an event probe

Where:
 SNAME	- System name, if omitted 'eprobes' is used.
 ENAME	- Name of the new event in SNAME, if omitted the SYSTEM_EVENT is used.
 SYSTEM	- Name of the system, where the tracepoint is defined, mandatory.
 EVENT	- Name of the tracepoint event in SYSTEM, mandatory.
 FETCHARGS - Arguments:
  <name>=$<field>[:TYPE] - Fetch given filed of the tracepoint and print
			   it as given TYPE with given name. Supported
			   types are:
	                    (u8/u16/u32/u64/s8/s16/s32/s64), basic type
        	            (x8/x16/x32/x64), hexadecimal types
			    "string", "ustring" and bitfield.

Example, attach an event probe on openat system call and print name of the
file that will be opened:
 echo "e:esys/eopen syscalls/sys_enter_openat file=\$filename:string" >> dynamic_events
A new dynamic event is created in events/esys/eopen/ directory. It
can be deleted with:
 echo "-:esys/eopen" >> dynamic_events

Filters, triggers and histograms can be attached to the new event, it can
be matched in synthetic events. There is one limitation - an event probe
can not be attached to kprobe, uprobe or another event probe.

Link: https://lkml.kernel.org/r/20210812145805.2292326-1-tz.stoyanov@gmail.com
Link: https://lkml.kernel.org/r/20210819152825.142428383@goodmis.org



Acked-by: default avatarMasami Hiramatsu <mhiramat@kernel.org>
Co-developed-by: default avatarSteven Rostedt (VMware) <rostedt@goodmis.org>
Signed-off-by: default avatarTzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
Signed-off-by: default avatarSteven Rostedt (VMware) <rostedt@goodmis.org>
parent 8e242060

include/linux/trace_events.h

+4 −0
Original line number Diff line number Diff line
@@ -313,6 +313,7 @@ enum { 
	TRACE_EVENT_FL_DYNAMIC_BIT,

	TRACE_EVENT_FL_KPROBE_BIT,

	TRACE_EVENT_FL_UPROBE_BIT,

	TRACE_EVENT_FL_EPROBE_BIT,

};



/*
@@ -325,6 +326,7 @@ enum { 
 *  DYNAMIC       - Event is a dynamic event (created at run time)

 *  KPROBE        - Event is a kprobe

 *  UPROBE        - Event is a uprobe

 *  EPROBE        - Event is an event probe

 */

enum {

	TRACE_EVENT_FL_FILTERED		= (1 << TRACE_EVENT_FL_FILTERED_BIT),
@@ -335,6 +337,7 @@ enum { 
	TRACE_EVENT_FL_DYNAMIC		= (1 << TRACE_EVENT_FL_DYNAMIC_BIT),

	TRACE_EVENT_FL_KPROBE		= (1 << TRACE_EVENT_FL_KPROBE_BIT),

	TRACE_EVENT_FL_UPROBE		= (1 << TRACE_EVENT_FL_UPROBE_BIT),

	TRACE_EVENT_FL_EPROBE		= (1 << TRACE_EVENT_FL_EPROBE_BIT),

};



#define TRACE_EVENT_FL_UKPROBE (TRACE_EVENT_FL_KPROBE | TRACE_EVENT_FL_UPROBE)
@@ -680,6 +683,7 @@ enum event_trigger_type { 
	ETT_EVENT_ENABLE	= (1 << 3),

	ETT_EVENT_HIST		= (1 << 4),

	ETT_HIST_ENABLE		= (1 << 5),

	ETT_EVENT_EPROBE	= (1 << 6),

};



extern int filter_match_preds(struct event_filter *filter, void *rec);

kernel/trace/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -77,6 +77,7 @@ obj-$(CONFIG_EVENT_TRACING) += trace_event_perf.o 
endif

obj-$(CONFIG_EVENT_TRACING) += trace_events_filter.o

obj-$(CONFIG_EVENT_TRACING) += trace_events_trigger.o

obj-$(CONFIG_PROBE_EVENTS) += trace_eprobe.o

obj-$(CONFIG_TRACE_EVENT_INJECT) += trace_events_inject.o

obj-$(CONFIG_SYNTH_EVENTS) += trace_events_synth.o

obj-$(CONFIG_HIST_TRIGGERS) += trace_events_hist.o

kernel/trace/trace.c

+4 −1
Original line number Diff line number Diff line
@@ -5543,6 +5543,7 @@ static const char readme_msg[] = 
#ifdef CONFIG_HIST_TRIGGERS

	"\t           s:[synthetic/]<event> <field> [<field>]\n"

#endif

	"\t           e[:[<group>/]<event>] <attached-group>.<attached-event> [<args>]\n"

	"\t           -:[<group>/]<event>\n"

#ifdef CONFIG_KPROBE_EVENTS

	"\t    place: [<module>:]<symbol>[+<offset>]|<memaddr>\n"
@@ -5552,7 +5553,7 @@ static const char readme_msg[] = 
  "   place (uprobe): <path>:<offset>[%return][(ref_ctr_offset)]\n"

#endif

	"\t     args: <name>=fetcharg[:type]\n"

	"\t fetcharg: %<register>, @<address>, @<symbol>[+|-<offset>],\n"

	"\t fetcharg: (%<register>|$<efield>), @<address>, @<symbol>[+|-<offset>],\n"

#ifdef CONFIG_HAVE_FUNCTION_ARG_ACCESS_API

	"\t           $stack<index>, $stack, $retval, $comm, $arg<N>,\n"

#else
@@ -5567,6 +5568,8 @@ static const char readme_msg[] = 
	"\t    stype: u8/u16/u32/u64, s8/s16/s32/s64, pid_t,\n"

	"\t           [unsigned] char/int/long\n"

#endif

	"\t    efield: For event probes ('e' types), the field is on of the fields\n"

	"\t            of the <attached-group>/<attached-event>.\n"

#endif

	"  events/\t\t- Directory containing all trace event subsystems:\n"

	"      enable\t\t- Write 0/1 to enable/disable tracing of all events\n"

kernel/trace/trace.h

+18 −0
Original line number Diff line number Diff line
@@ -126,6 +126,11 @@ struct kprobe_trace_entry_head { 
	unsigned long		ip;

};



struct eprobe_trace_entry_head {

	struct trace_entry	ent;

	unsigned int		type;

};



struct kretprobe_trace_entry_head {

	struct trace_entry	ent;

	unsigned long		func;
@@ -1508,9 +1513,14 @@ static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; } 
extern int register_trigger_cmds(void);

extern void clear_event_triggers(struct trace_array *tr);



enum {

	EVENT_TRIGGER_FL_PROBE		= BIT(0),

};



struct event_trigger_data {

	unsigned long			count;

	int				ref;

	int				flags;

	struct event_trigger_ops	*ops;

	struct event_command		*cmd_ops;

	struct event_filter __rcu	*filter;
@@ -1918,6 +1928,14 @@ static inline bool is_good_name(const char *name) 
	return true;

}



/* Convert certain expected symbols into '_' when generating event names */

static inline void sanitize_event_name(char *name)

{

	while (*name++ != '\0')

		if (*name == ':' || *name == '.')

			*name = '_';

}



/*

 * This is a generic way to read and write a u64 value from a file in tracefs.

 *

kernel/trace/trace_eprobe.c

0 → 100644
+903 −0

File added.

Preview size limit exceeded, changes collapsed.