uprobe: Add session support
Subsystems (9)
Jiri Olsa
reviewerv8 cover uprobe: Add session support
hi,
this patchset is adding support for session uprobe attachment and using it through bpf link for bpf programs.
The session means that the uprobe consumer is executed on entry and return of probed function with additional control:
- entry callback can control execution of the return callback
- entry and return callbacks can share data/cookie
On more details please see patch #2.
The patchset is based on Peter's perf/core [1].
v8 changes:
- split and sepatate only the perf/core patches
- rebased and reposted to proper ppl/lists
thanks,
jirka
[1] git://git.kernel.org/pub/scm/linux/kernel/git/peterz/queue.git perf/core
---
Jiri Olsa (2):
uprobe: Add data pointer to consumer handlers
uprobe: Add support for session consumer
include/linux/uprobes.h | 25 +++++++++++++++-- kernel/events/uprobes.c | 148 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++------------------- kernel/trace/bpf_trace.c | 6 ++-- kernel/trace/trace_uprobe.c | 12 +++++--- tools/testing/selftests/bpf/bpf_testmod/bpf_testmod.c | 2 +- 5 files changed, 154 insertions(+), 39 deletions(-)
Jiri Olsa
reviewerPATCH v8 1/2 uprobe: Add data pointer to consumer handlers
Adding data pointer to both entry and exit consumer handlers and all its users. The functionality itself is coming in following change.
--- include/linux/uprobes.h | 4 ++-- kernel/events/uprobes.c | 4 ++-- kernel/trace/bpf_trace.c | 6 ++++-- kernel/trace/trace_uprobe.c | 12 ++++++++---- .../testing/selftests/bpf/bpf_testmod/bpf_testmod.c | 2 +- 5 files changed, 17 insertions(+), 11 deletions(-)
include/linux/uprobes.h +2 -2
@@ -37,10 +37,10 @@ struct uprobe_consumer {* for the current process. If filter() is omitted or returns true, * UPROBE_HANDLER_REMOVE is effectively ignored. */ -int (*handler)(struct uprobe_consumer *self,struct pt_regs *regs); +int (*handler)(struct uprobe_consumer *self,struct pt_regs *regs,__u64 *data);int (*ret_handler)(struct uprobe_consumer *self,unsigned long func, -struct pt_regs *regs); +struct pt_regs *regs,__u64 *data);bool (*filter)(struct uprobe_consumer *self,struct mm_struct *mm);struct list_head cons_node;
kernel/events/uprobes.c +2 -2
@@ -2090,7 +2090,7 @@ static void handler_chain(struct uprobe *uprobe, struct pt_regs *regs)int rc =0 ;if (uc->handler) { - rc = uc->handler (uc, regs); + rc = uc->handler (uc, regs,NULL );WARN (rc & ~UPROBE_HANDLER_MASK ,"bad rc=0x%x from %ps()\n" , rc, uc->handler); }
@@ -2128,7 +2128,7 @@ handle_uretprobe_chain(struct return_instance *ri, struct pt_regs *regs)rcu_read_lock_trace ();list_for_each_entry_rcu (uc, &uprobe->consumers, cons_node,rcu_read_lock_trace_held ()) {if (uc->ret_handler) - uc->ret_handler (uc, ri->func, regs); + uc->ret_handler (uc, ri->func, regs,NULL ); }rcu_read_unlock_trace (); }
kernel/trace/bpf_trace.c +4 -2
@@ -3244,7 +3244,8 @@ uprobe_multi_link_filter(struct uprobe_consumer *con, struct mm_struct *mm) }static int -uprobe_multi_link_handler (struct uprobe_consumer *con,struct pt_regs *regs) +uprobe_multi_link_handler (struct uprobe_consumer *con,struct pt_regs *regs, +__u64 *data) {struct bpf_uprobe *uprobe;
@@ -3253,7 +3254,8 @@ uprobe_multi_link_handler(struct uprobe_consumer *con, struct pt_regs *regs) }static int -uprobe_multi_link_ret_handler (struct uprobe_consumer *con,unsigned long func,struct pt_regs *regs) +uprobe_multi_link_ret_handler (struct uprobe_consumer *con,unsigned long func,struct pt_regs *regs, +__u64 *data) {struct bpf_uprobe *uprobe;
kernel/trace/trace_uprobe.c +8 -4
@@ -89,9 +89,11 @@ static struct trace_uprobe *to_trace_uprobe(struct dyn_event *ev)static int register_uprobe_event (struct trace_uprobe *tu);static int unregister_uprobe_event (struct trace_uprobe *tu); -static int uprobe_dispatcher (struct uprobe_consumer *con,struct pt_regs *regs); +static int uprobe_dispatcher (struct uprobe_consumer *con,struct pt_regs *regs, +__u64 *data);static int uretprobe_dispatcher (struct uprobe_consumer *con, -unsigned long func,struct pt_regs *regs); +unsigned long func,struct pt_regs *regs, +__u64 *data);#ifdef CONFIG_STACK_GROWSUP static unsigned long adjust_stack_addr (unsigned long addr,unsigned int n)
@@ -1517,7 +1519,8 @@ trace_uprobe_register(struct trace_event_call *event, enum trace_reg type, } } -static int uprobe_dispatcher (struct uprobe_consumer *con,struct pt_regs *regs) +static int uprobe_dispatcher (struct uprobe_consumer *con,struct pt_regs *regs, +__u64 *data) {struct trace_uprobe *tu;struct uprobe_dispatch_data udd;
@@ -1548,7 +1551,8 @@ static int uprobe_dispatcher(struct uprobe_consumer *con, struct pt_regs *regs) }static int uretprobe_dispatcher (struct uprobe_consumer *con, -unsigned long func,struct pt_regs *regs) +unsigned long func,struct pt_regs *regs, +__u64 *data) {struct trace_uprobe *tu;struct uprobe_dispatch_data udd;
tools/testing/selftests/bpf/bpf_testmod/bpf_testmod.c +1 -1
@@ -461,7 +461,7 @@ static struct bin_attribute bin_attr_bpf_testmod_file __ro_after_init = {static int uprobe_ret_handler (struct uprobe_consumer *self,unsigned long func, -struct pt_regs *regs) +struct pt_regs *regs,__u64 *data) { regs->ax =0x12345678deadbeef ;
Signature · 1 line
2.46.2
[tip: perf/core] uprobe: Add data pointer to consumer handlers
The following commit has been merged into the perf/core branch of tip:
The following commit has been merged into the perf/core branch of tip:
Commit-ID: da09a9e0c3eab164af950be44ee6bdea8527c3e5 Gitweb: https://git.kernel.org/tip/da09a9e0c3eab164af950be44ee6bdea8527c3e5 Author: Jiri Olsa <[email protected]> AuthorDate: Fri, 18 Oct 2024 22:22:51 +02:00 Committer: Peter Zijlstra <[email protected]> CommitterDate: Wed, 23 Oct 2024 20:52:27 +02:00
uprobe: Add data pointer to consumer handlers
Adding data pointer to both entry and exit consumer handlers and all its users. The functionality itself is coming in following change.
--- include/linux/uprobes.h | 4 +-- kernel/events/uprobes.c | 4 +-- kernel/trace/bpf_trace.c | 6 +++-- kernel/trace/trace_uprobe.c | 12 ++++++---- tools/testing/selftests/bpf/bpf_testmod/bpf_testmod.c | 2 +- 5 files changed, 17 insertions(+), 11 deletions(-)
include/linux/uprobes.h +2 -2
@@ -37,10 +37,10 @@ struct uprobe_consumer {* for the current process. If filter() is omitted or returns true, * UPROBE_HANDLER_REMOVE is effectively ignored. */ -int (*handler)(struct uprobe_consumer *self,struct pt_regs *regs); +int (*handler)(struct uprobe_consumer *self,struct pt_regs *regs,__u64 *data);int (*ret_handler)(struct uprobe_consumer *self,unsigned long func, -struct pt_regs *regs); +struct pt_regs *regs,__u64 *data);bool (*filter)(struct uprobe_consumer *self,struct mm_struct *mm);struct list_head cons_node;
kernel/events/uprobes.c +2 -2
@@ -2090,7 +2090,7 @@ static void handler_chain(struct uprobe *uprobe, struct pt_regs *regs)int rc =0 ;if (uc->handler) { - rc = uc->handler (uc, regs); + rc = uc->handler (uc, regs,NULL );WARN (rc & ~UPROBE_HANDLER_MASK ,"bad rc=0x%x from %ps()\n" , rc, uc->handler); }
@@ -2128,7 +2128,7 @@ handle_uretprobe_chain(struct return_instance *ri, struct pt_regs *regs)rcu_read_lock_trace ();list_for_each_entry_rcu (uc, &uprobe->consumers, cons_node,rcu_read_lock_trace_held ()) {if (uc->ret_handler) - uc->ret_handler (uc, ri->func, regs); + uc->ret_handler (uc, ri->func, regs,NULL ); }rcu_read_unlock_trace (); }
kernel/trace/bpf_trace.c +4 -2
@@ -3244,7 +3244,8 @@ uprobe_multi_link_filter(struct uprobe_consumer *con, struct mm_struct *mm) }static int -uprobe_multi_link_handler (struct uprobe_consumer *con,struct pt_regs *regs) +uprobe_multi_link_handler (struct uprobe_consumer *con,struct pt_regs *regs, +__u64 *data) {struct bpf_uprobe *uprobe;
@@ -3253,7 +3254,8 @@ uprobe_multi_link_handler(struct uprobe_consumer *con, struct pt_regs *regs) }static int -uprobe_multi_link_ret_handler (struct uprobe_consumer *con,unsigned long func,struct pt_regs *regs) +uprobe_multi_link_ret_handler (struct uprobe_consumer *con,unsigned long func,struct pt_regs *regs, +__u64 *data) {struct bpf_uprobe *uprobe;
kernel/trace/trace_uprobe.c +8 -4
@@ -89,9 +89,11 @@ static struct trace_uprobe *to_trace_uprobe(struct dyn_event *ev)static int register_uprobe_event (struct trace_uprobe *tu);static int unregister_uprobe_event (struct trace_uprobe *tu); -static int uprobe_dispatcher (struct uprobe_consumer *con,struct pt_regs *regs); +static int uprobe_dispatcher (struct uprobe_consumer *con,struct pt_regs *regs, +__u64 *data);static int uretprobe_dispatcher (struct uprobe_consumer *con, -unsigned long func,struct pt_regs *regs); +unsigned long func,struct pt_regs *regs, +__u64 *data);#ifdef CONFIG_STACK_GROWSUP static unsigned long adjust_stack_addr (unsigned long addr,unsigned int n)
@@ -1517,7 +1519,8 @@ trace_uprobe_register(struct trace_event_call *event, enum trace_reg type, } } -static int uprobe_dispatcher (struct uprobe_consumer *con,struct pt_regs *regs) +static int uprobe_dispatcher (struct uprobe_consumer *con,struct pt_regs *regs, +__u64 *data) {struct trace_uprobe *tu;struct uprobe_dispatch_data udd;
@@ -1548,7 +1551,8 @@ static int uprobe_dispatcher(struct uprobe_consumer *con, struct pt_regs *regs) }static int uretprobe_dispatcher (struct uprobe_consumer *con, -unsigned long func,struct pt_regs *regs) +unsigned long func,struct pt_regs *regs, +__u64 *data) {struct trace_uprobe *tu;struct uprobe_dispatch_data udd;
tools/testing/selftests/bpf/bpf_testmod/bpf_testmod.c +1 -1
@@ -461,7 +461,7 @@ static struct bin_attribute bin_attr_bpf_testmod_file __ro_after_init = {static int uprobe_ret_handler (struct uprobe_consumer *self,unsigned long func, -struct pt_regs *regs) +struct pt_regs *regs,__u64 *data) { regs->ax =0x12345678deadbeef ;
Jiri Olsa
reviewerPATCH v8 2/2 uprobe: Add support for session consumer
In reply to Jiri OlsaThis change allows the uprobe consumer to behave as session which means that 'handler' and 'ret_handler' callbacks are connected in a way that allows to:
- control execution of 'ret_handler' from 'handler' callback
- share data between 'handler' and 'ret_handler' callbacks
The session concept fits to our common use case where we do filtering on entry uprobe and based on the result we decide to run the return uprobe (or not).
It's also convenient to share the data between session callbacks.
To achive this we are adding new return value the uprobe consumer can return from 'handler' callback:
UPROBE_HANDLER_IGNORE
- Ignore 'ret_handler' callback for this consumer.
And store cookie and pass it to 'ret_handler' when consumer has both 'handler' and 'ret_handler' callbacks defined.
We store shared data in the return_consumer object array as part of the return_instance object. This way the handle_uretprobe_chain can find related return_consumer and its shared data.
We also store entry handler return value, for cases when there are multiple consumers on single uprobe and some of them are ignored and some of them not, in which case the return probe gets installed and we need to have a way to find out which consumer needs to be ignored.
The tricky part is when consumer is registered 'after' the uprobe entry handler is hit. In such case this consumer's 'ret_handler' gets executed as well, but it won't have the proper data pointer set, so we can filter it out.
--- include/linux/uprobes.h | 21 +++++- kernel/events/uprobes.c | 148 ++++++++++++++++++++++++++++++++-------- 2 files changed, 139 insertions(+), 30 deletions(-)
include/linux/uprobes.h +20 -1
@@ -23,8 +23,17 @@ struct inode;struct notifier_block ;struct page ; +/* +* Allowed return values from uprobe consumer's handler callback +* with following meaning: +* +* UPROBE_HANDLER_REMOVE +* - Remove the uprobe breakpoint from current->mm. +* UPROBE_HANDLER_IGNORE +* - Ignore ret_handler callback for this consumer. +*/ #define UPROBE_HANDLER_REMOVE 1 -#define UPROBE_HANDLER_MASK 1 +#define UPROBE_HANDLER_IGNORE 2#define MAX_URETPROBE_DEPTH 64
@@ -44,6 +53,8 @@ struct uprobe_consumer {bool (*filter)(struct uprobe_consumer *self,struct mm_struct *mm);struct list_head cons_node; + +__u64 id;/* set when uprobe_consumer is registered */ };#ifdef CONFIG_UPROBES
@@ -83,14 +94,22 @@ struct uprobe_task {unsigned int depth; }; +struct return_consumer { +__u64 cookie; +__u64 id; +}; +struct return_instance {struct uprobe *uprobe;unsigned long func;unsigned long stack;/* stack pointer */ unsigned long orig_ret_vaddr;/* original return address */ bool chained;/* true, if instance is nested */ +int consumers_cnt;struct return_instance *next;/* keep as stack */ + + struct return_consumer consumers[] __counted_by(consumers_cnt); };enum rp_check {
kernel/events/uprobes.c +119 -29
248 lines not on this page · raw message
Signature · 1 line
2.46.2
[tip: perf/core] uprobe: Add support for session consumer
The following commit has been merged into the perf/core branch of tip:
The following commit has been merged into the perf/core branch of tip:
Commit-ID: 4d756095d3994cb41393817dc696b458938a6bd0 Gitweb: https://git.kernel.org/tip/4d756095d3994cb41393817dc696b458938a6bd0 Author: Jiri Olsa <[email protected]> AuthorDate: Fri, 18 Oct 2024 22:22:52 +02:00 Committer: Peter Zijlstra <[email protected]> CommitterDate: Wed, 23 Oct 2024 20:52:27 +02:00
uprobe: Add support for session consumer
This change allows the uprobe consumer to behave as session which means that 'handler' and 'ret_handler' callbacks are connected in a way that allows to:
- control execution of 'ret_handler' from 'handler' callback
- share data between 'handler' and 'ret_handler' callbacks
The session concept fits to our common use case where we do filtering on entry uprobe and based on the result we decide to run the return uprobe (or not).
It's also convenient to share the data between session callbacks.
To achive this we are adding new return value the uprobe consumer can return from 'handler' callback:
UPROBE_HANDLER_IGNORE
- Ignore 'ret_handler' callback for this consumer.
And store cookie and pass it to 'ret_handler' when consumer has both 'handler' and 'ret_handler' callbacks defined.
We store shared data in the return_consumer object array as part of the return_instance object. This way the handle_uretprobe_chain can find related return_consumer and its shared data.
We also store entry handler return value, for cases when there are multiple consumers on single uprobe and some of them are ignored and some of them not, in which case the return probe gets installed and we need to have a way to find out which consumer needs to be ignored.
The tricky part is when consumer is registered 'after' the uprobe entry handler is hit. In such case this consumer's 'ret_handler' gets executed as well, but it won't have the proper data pointer set, so we can filter it out.
--- include/linux/uprobes.h | 21 +++++- kernel/events/uprobes.c | 148 +++++++++++++++++++++++++++++++-------- 2 files changed, 139 insertions(+), 30 deletions(-)
include/linux/uprobes.h +20 -1
@@ -23,8 +23,17 @@ struct inode;struct notifier_block ;struct page ; +/* +* Allowed return values from uprobe consumer's handler callback +* with following meaning: +* +* UPROBE_HANDLER_REMOVE +* - Remove the uprobe breakpoint from current->mm. +* UPROBE_HANDLER_IGNORE +* - Ignore ret_handler callback for this consumer. +*/ #define UPROBE_HANDLER_REMOVE 1 -#define UPROBE_HANDLER_MASK 1 +#define UPROBE_HANDLER_IGNORE 2#define MAX_URETPROBE_DEPTH 64
@@ -44,6 +53,8 @@ struct uprobe_consumer {bool (*filter)(struct uprobe_consumer *self,struct mm_struct *mm);struct list_head cons_node; + +__u64 id;/* set when uprobe_consumer is registered */ };#ifdef CONFIG_UPROBES
@@ -83,14 +94,22 @@ struct uprobe_task {unsigned int depth; }; +struct return_consumer { +__u64 cookie; +__u64 id; +}; +struct return_instance {struct uprobe *uprobe;unsigned long func;unsigned long stack;/* stack pointer */ unsigned long orig_ret_vaddr;/* original return address */ bool chained;/* true, if instance is nested */ +int consumers_cnt;struct return_instance *next;/* keep as stack */ + + struct return_consumer consumers[] __counted_by(consumers_cnt); };enum rp_check {
kernel/events/uprobes.c +119 -29
248 lines not on this page · raw message