libbpf: support "module:function" syntax for tracing programs
Subsystems (4)
cover libbpf: support "module:function" syntax for tracing programs
In some situations, it is useful to explicitly specify a kernel module to search for a tracing program target (e.g. when a function of the same name exists in multiple modules or in vmlinux).
This change enables that by allowing the "module:function" syntax for the find_kernel_btf_id function. Thanks to this, the syntax can be used both from a SEC macro (i.e. SEC(fentry/module:function)) and via the bpf_program__set_attach_target API call.
Viktor Malik (2):
libbpf: support "module:function" syntax for tracing programs selftests/bpf: add tests for the "module:function" syntax
tools/lib/bpf/libbpf.c | 33 ++++++++++++++----- .../selftests/bpf/prog_tests/module_attach.c | 6 ++++ .../selftests/bpf/progs/test_module_attach.c | 23 +++++++++++++ 3 files changed, 53 insertions(+), 9 deletions(-)
Signature · 1 line
2.44.0
PATCH 1/2 libbpf: support "module:function" syntax for tracing programs
In some situations, it is useful to explicitly specify a kernel module to search for a tracing program target (e.g. when a function of the same name exists in multiple modules or in vmlinux).
This patch enables that by allowing the "module:function" syntax for the find_kernel_btf_id function. Thanks to this, the syntax can be used both from a SEC macro (i.e. SEC(fentry/module:function)) and via the bpf_program__set_attach_target API call.
--- tools/lib/bpf/libbpf.c | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-)
tools/lib/bpf/libbpf.c +24 -9
@@ -9858,16 +9858,28 @@ static int find_kernel_btf_id(struct bpf_object *obj, const char *attach_name,enum bpf_attach_type attach_type, int *btf_obj_fd, int *btf_type_id) { - int ret, i; + int ret, i, mod_len; +const char *fun_name, *mod_name =NULL ; - ret =find_attach_btf_id (obj->btf_vmlinux, attach_name, attach_type); -if (ret >0 ) { - *btf_obj_fd =0 ;/* vmlinux BTF */ - *btf_type_id = ret; -return 0 ; + fun_name =strchr (attach_name,':' ); +if (fun_name) { + mod_name = attach_name; + mod_len = fun_name - mod_name; + fun_name++; + } + +if (!mod_name ||strncmp (mod_name,"vmlinux" , mod_len) ==0 ) { + ret =find_attach_btf_id (obj->btf_vmlinux, + mod_name ? fun_name : attach_name, + attach_type); +if (ret >0 ) { + *btf_obj_fd =0 ;/* vmlinux BTF */ + *btf_type_id = ret; +return 0 ; + } +if (ret != -ENOENT ) +return ret; } -if (ret != -ENOENT ) -return ret; ret =load_module_btfs (obj);if (ret)
@@ -9876,7 +9888,10 @@ static int find_kernel_btf_id(struct bpf_object *obj, const char *attach_name,for (i =0 ; i < obj->btf_module_cnt; i++) {const struct module_btf *mod = &obj->btf_modules[i]; - ret =find_attach_btf_id (mod->btf, attach_name, attach_type); +if (mod_name &&strncmp (mod->name, mod_name, mod_len)) +continue ; + + ret =find_attach_btf_id (mod->btf, mod_name ? fun_name : attach_name, attach_type);if (ret >0 ) { *btf_obj_fd = mod->fd; *btf_type_id = ret;
Signature · 1 line
2.44.0
Quoted 10 lines · Viktor Malik
In some situations, it is useful to explicitly specify a kernel module to search for a tracing program target (e.g. when a function of the same name exists in multiple modules or in vmlinux).
This patch enables that by allowing the "module:function" syntax for the
find_kernel_btf_idfunction. Thanks to this, the syntax can be used both from a SEC macro (i.e.SEC(fentry/module:function)) and via thebpf_program__set_attach_targetAPI call.
Quoted 5 lines
Signed-off-by Viktor Malik <[email protected]>--- tools/lib/bpf/libbpf.c | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-)
Looks good, just stylistic nits below.
tools/lib/bpf/libbpf.c static int find_kernel_btf_id(struct bpf_object *obj, const char *attach_name, · line 9862
Quoted 11 lines
tools/lib/bpf/libbpf.c +2
-1@@ -9858,16 +9858,28 @@ static int find_kernel_btf_id(struct bpf_object *obj, const char *attach_name,enum bpf_attach_type attach_type, int *btf_obj_fd, int *btf_type_id) { - int ret, i; + int ret, i, mod_len; +const char *fun_name, *mod_name =NULL ;
bikeshedding nit, but let's call it fn_name ("fun" doesn't associate with "function" in my head at all)
Quoted 31 lines
tools/lib/bpf/libbpf.c +18
-7- ret =find_attach_btf_id (obj->btf_vmlinux, attach_name, attach_type); -if (ret >0 ) { - *btf_obj_fd =0 ;/* vmlinux BTF */ - *btf_type_id = ret; -return 0 ; + fun_name =strchr (attach_name,':' ); +if (fun_name) { + mod_name = attach_name; + mod_len = fun_name - mod_name; + fun_name++; + } + +if (!mod_name ||strncmp (mod_name,"vmlinux" , mod_len) ==0 ) { + ret =find_attach_btf_id (obj->btf_vmlinux, + mod_name ? fun_name : attach_name, + attach_type); +if (ret >0 ) { + *btf_obj_fd =0 ;/* vmlinux BTF */ + *btf_type_id = ret; +return 0 ; + } +if (ret != -ENOENT ) +return ret; } -if (ret != -ENOENT ) -return ret; ret =load_module_btfs (obj);if (ret)
tools/lib/bpf/libbpf.c static int find_kernel_btf_id(struct bpf_object *obj, const char *attach_name, · line 9891
Quoted 5 lines
tools/lib/bpf/libbpf.c +1
-1@@ -9876,7 +9888,10 @@ static int find_kernel_btf_id(struct bpf_object *obj, const char *attach_name,for (i =0 ; i < obj->btf_module_cnt; i++) {const struct module_btf *mod = &obj->btf_modules[i]; - ret =find_attach_btf_id (mod->btf, attach_name, attach_type); +if (mod_name &&strncmp (mod->name, mod_name, mod_len))
please add explicit == 0 after strncmp(), like you did above for vmlinux
Quoted 9 lines
tools/lib/bpf/libbpf.c +3
-1+continue ; + + ret =find_attach_btf_id (mod->btf, mod_name ? fun_name : attach_name, attach_type);if (ret >0 ) { *btf_obj_fd = mod->fd; *btf_type_id = ret; --2.44.0
PATCH 2/2 selftests/bpf: add tests for the "module:function" syntax
In reply to Viktor MalikThe previous patch added support for the "module:function" syntax for tracing programs. This adds tests for explicitly specifying the module name via the SEC macro and via the bpf_program__set_attach_target call.
--- .../selftests/bpf/prog_tests/module_attach.c | 6 +++++ .../selftests/bpf/progs/test_module_attach.c | 23 +++++++++++++++++++ 2 files changed, 29 insertions(+)
tools/testing/selftests/bpf/prog_tests/module_attach.c +6 -0
@@ -51,6 +51,10 @@ void test_module_attach(void) 0, "bpf_testmod_test_read");ASSERT_OK (err,"set_attach_target" ); + err =bpf_program__set_attach_target (skel->progs.handle_fentry_explicit_manual, +0 ,"bpf_testmod:bpf_testmod_test_read" ); +ASSERT_OK (err,"set_attach_target_explicit" ); + err =test_module_attach__load (skel);if (CHECK (err,"skel_load" ,"failed to load skeleton\n" ))return ;
@@ -70,6 +74,8 @@ void test_module_attach(void)ASSERT_EQ (bss->tp_btf_read_sz,READ_SZ ,"tp_btf" );ASSERT_EQ (bss->fentry_read_sz,READ_SZ ,"fentry" );ASSERT_EQ (bss->fentry_manual_read_sz,READ_SZ ,"fentry_manual" ); +ASSERT_EQ (bss->fentry_explicit_read_sz,READ_SZ ,"fentry_explicit" ); +ASSERT_EQ (bss->fentry_explicit_manual_read_sz,READ_SZ ,"fentry_explicit_manual" );ASSERT_EQ (bss->fexit_read_sz,READ_SZ ,"fexit" );ASSERT_EQ (bss->fexit_ret, -EIO ,"fexit_tet" );ASSERT_EQ (bss->fmod_ret_read_sz,READ_SZ ,"fmod_ret" );
tools/testing/selftests/bpf/progs/test_module_attach.c +23 -0
@@ -73,6 +73,29 @@ int BPF_PROG(handle_fentry_manual,return 0 ; } +__u32 fentry_explicit_read_sz =0 ; + +SEC("fentry/bpf_testmod:bpf_testmod_test_read") +int BPF_PROG (handle_fentry_explicit , +struct file *file,struct kobject *kobj, +struct bin_attribute *bin_attr,char *buf,loff_t off,size_t len) +{ + fentry_explicit_read_sz = len; +return 0 ; +} + + +__u32 fentry_explicit_manual_read_sz =0 ; + +SEC("fentry") +int BPF_PROG (handle_fentry_explicit_manual , +struct file *file,struct kobject *kobj, +struct bin_attribute *bin_attr,char *buf,loff_t off,size_t len) +{ + fentry_explicit_manual_read_sz = len; +return 0 ; +} +__u32 fexit_read_sz =0 ;int fexit_ret =0 ;
Signature · 1 line
2.44.0
Re: [PATCH bpf-next 2/2] selftests/bpf: add tests for the "module:function" syntax
Quoted 11 lines · Viktor Malik
The previous patch added support for the "module:function" syntax for tracing programs. This adds tests for explicitly specifying the module name via the SEC macro and via the
bpf_program__set_attach_targetcall.Signed-off-by Viktor Malik <[email protected]>--- .../selftests/bpf/prog_tests/module_attach.c | 6 +++++ .../selftests/bpf/progs/test_module_attach.c | 23 +++++++++++++++++++ 2 files changed, 29 insertions(+)
LGTM
[...]
Quoted 10 lines · Viktor Malik
In some situations, it is useful to explicitly specify a kernel module to search for a tracing program target (e.g. when a function of the same name exists in multiple modules or in vmlinux).
This change enables that by allowing the "module:function" syntax for the
find_kernel_btf_idfunction. Thanks to this, the syntax can be used both from a SEC macro (i.e.SEC(fentry/module:function)) and via thebpf_program__set_attach_targetAPI call.
how about function[module] syntax. This follows how modules are reported in kallsyms and a bunch of other kernel-generated files. I've been using this syntax in retsnoop for a while, and it feels very natural. It's also distinctive enough to be recognizable and parseable without any possible confusions.
Can you please also check if we can/should support this for kprobes as well?
Quoted 12 lines
Viktor Malik (2):
libbpf: support "module:function" syntax for tracing programs selftests/bpf: add tests for the "module:function" syntaxtools/lib/bpf/libbpf.c | 33 ++++++++++++++----- .../selftests/bpf/prog_tests/module_attach.c | 6 ++++ .../selftests/bpf/progs/test_module_attach.c | 23 +++++++++++++ 3 files changed, 53 insertions(+), 9 deletions(-)--
2.44.0
Quoted 12 lines · Andrii Nakryiko
Quoted 10 lines · Viktor Malik
In some situations, it is useful to explicitly specify a kernel module to search for a tracing program target (e.g. when a function of the same name exists in multiple modules or in vmlinux).
This change enables that by allowing the "module:function" syntax for the
find_kernel_btf_idfunction. Thanks to this, the syntax can be used both from a SEC macro (i.e.SEC(fentry/module:function)) and via thebpf_program__set_attach_targetAPI call.
Quoted 7 lines
how about function[module] syntax. This follows how modules are reported in kallsyms and a bunch of other kernel-generated files. I've been using this syntax in retsnoop for a while, and it feels very natural. It's also distinctive enough to be recognizable and parseable without any possible confusions.
Can you please also check if we can/should support this for kprobes as well?
For kprobes, it's a bit more complicated. The legacy kprobe attachment (via tracefs) supports the "module:function" syntax [1] (which is the reason I chose that syntax in the first place). On the other hand, kprobe attachment via the perf_event_open syscall eventually calls kallsyms_lookup_name for the passed function name which doesn't support specifying the module at all.
So, to properly support this for kprobes, we'd have to extend kallsyms_lookup_name to handle the "function[module]" or "module:function" syntax (here, the former makes more sense).
Since kallsyms_lookup_name is used in many places, I would prefer adding the kprobe support separately. In any case, the "function[module]" syntax feels more natural for non-legacy kprobes, so I'm ok with using it. libbpf will just have to do the transformation to "module:function" for legacy kprobe attachment.
Let me know if that makes sense and I'll post v2.
Thanks!
Viktor
[1] https://www.kernel.org/doc/Documentation/trace/kprobetrace.rst
Quoted 14 lines
Quoted 13 lines
Viktor Malik (2):
libbpf: support "module:function" syntax for tracing programs selftests/bpf: add tests for the "module:function" syntaxtools/lib/bpf/libbpf.c | 33 ++++++++++++++----- .../selftests/bpf/prog_tests/module_attach.c | 6 ++++ .../selftests/bpf/progs/test_module_attach.c | 23 +++++++++++++ 3 files changed, 53 insertions(+), 9 deletions(-)--
2.44.0
Quoted 33 lines · Viktor Malik
Quoted 12 lines · Andrii Nakryiko
Quoted 10 lines · Viktor Malik
In some situations, it is useful to explicitly specify a kernel module to search for a tracing program target (e.g. when a function of the same name exists in multiple modules or in vmlinux).
This change enables that by allowing the "module:function" syntax for the
find_kernel_btf_idfunction. Thanks to this, the syntax can be used both from a SEC macro (i.e.SEC(fentry/module:function)) and via thebpf_program__set_attach_targetAPI call.Quoted 7 lines
how about function[module] syntax. This follows how modules are reported in kallsyms and a bunch of other kernel-generated files. I've been using this syntax in retsnoop for a while, and it feels very natural. It's also distinctive enough to be recognizable and parseable without any possible confusions.
Can you please also check if we can/should support this for kprobes as well?
For kprobes, it's a bit more complicated. The legacy kprobe attachment (via tracefs) supports the "module:function" syntax [1] (which is the reason I chose that syntax in the first place). On the other hand, kprobe attachment via the
perf_event_opensyscall eventually callskallsyms_lookup_namefor the passed function name which doesn't support specifying the module at all.So, to properly support this for kprobes, we'd have to extend
kallsyms_lookup_nameto handle the "function[module]" or "module:function" syntax (here, the former makes more sense).
Quoted 7 lines
Since
kallsyms_lookup_nameis used in many places, I would prefer adding the kprobe support separately. In any case, the "function[module]" syntax feels more natural for non-legacy kprobes, so I'm ok with using it. libbpf will just have to do the transformation to "module:function" for legacy kprobe attachment.Let me know if that makes sense and I'll post v2.
Thinking some more, I think we should stick to "<module>:<function>" for a) simplicity (it's slightly easier to parse) and b) consistency with uprobe, where we have "<path>:<function>", where path is pointing to ELF binary. Let me take a look at patches again.
But yes, I think it would be useful to add support to kprobes/multi-kprobes as well for completeness, but it of course would be a separate work thread.
Quoted 21 lines
Thanks!
Viktor[1] https://www.kernel.org/doc/Documentation/trace/kprobetrace.rst
Quoted 14 lines
Quoted 13 lines
Viktor Malik (2):
libbpf: support "module:function" syntax for tracing programs selftests/bpf: add tests for the "module:function" syntaxtools/lib/bpf/libbpf.c | 33 ++++++++++++++----- .../selftests/bpf/prog_tests/module_attach.c | 6 ++++ .../selftests/bpf/progs/test_module_attach.c | 23 +++++++++++++ 3 files changed, 53 insertions(+), 9 deletions(-)--
2.44.0