bpftool: Add autoattach for bpf prog load|loadall
Subsystems (4)
v9 cover bpftool: Add autoattach for bpf prog load|loadall
This patchset add "autoattach" optional for "bpftool prog load(_all)" to support one-step load-attach-pin_link.
v8 -> v9: fix link leak, and change pathname_concat(specify not just buffer
pointer, but also it's size)
v7 -> v8: for the programs not supporting autoattach, fall back to reguler pinning
instead of skipping
v6 -> v7: add info msg print and update doc for the skip program
v5 -> v6: skip the programs not supporting auto-attach,
and change optional name from "auto_attach" to "autoattach"
v4 -> v5: some formatting nits of doc
v3 -> v4: rename functions, update doc, bash and do_help()
v2 -> v3: switch to extend prog load command instead of extend perf
v2: https://patchwork.kernel.org/project/netdevbpf/patch/[email protected]/
v1: https://patchwork.kernel.org/project/netdevbpf/patch/[email protected]/
Wang Yufen (3):
bpftool: Add autoattach for bpf prog load|loadall
bpftool: Update doc (add autoattach to prog load)
bpftool: Update the bash completion(add autoattach to prog load)
tools/bpf/bpftool/Documentation/bpftool-prog.rst | 15 ++++- tools/bpf/bpftool/bash-completion/bpftool | 1 + tools/bpf/bpftool/prog.c | 76 +++++++++++++++++++++++- 3 files changed, 88 insertions(+), 4 deletions(-)
Signature · 1 line
1.8.3.1
PATCH v9 1/3 bpftool: Add autoattach for bpf prog load|loadall
Add autoattach optional to support one-step load-attach-pin_link.
For example,
$ bpftool prog loadall test.o /sys/fs/bpf/test autoattach
$ bpftool link 26: tracing name test1 tag f0da7d0058c00236 gpl loaded_at 2022-09-09T21:39:49+0800 uid 0 xlated 88B jited 55B memlock 4096B map_ids 3 btf_id 55 28: kprobe name test3 tag 002ef1bef0723833 gpl loaded_at 2022-09-09T21:39:49+0800 uid 0 xlated 88B jited 56B memlock 4096B map_ids 3 btf_id 55 57: tracepoint name oncpu tag 7aa55dfbdcb78941 gpl loaded_at 2022-09-09T21:41:32+0800 uid 0 xlated 456B jited 265B memlock 4096B map_ids 17,13,14,15 btf_id 82
$ bpftool link 1: tracing prog 26 prog_type tracing attach_type trace_fentry 3: perf_event prog 28 10: perf_event prog 57
The autoattach optional can support tracepoints, k(ret)probes, u(ret)probes.
--- tools/bpf/bpftool/prog.c | 76 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 74 insertions(+), 2 deletions(-)
tools/bpf/bpftool/prog.c +74 -2
@@ -1453,6 +1453,67 @@ static int do_run(int argc, char **argv)return ret; } +static int +auto_attach_program (struct bpf_program *prog,const char *path) +{ +struct bpf_link *link; +int err; + + link =bpf_program__attach (prog); +if (!link) { +p_info ("Program %s does not support autoattach, falling back to pinning" , +bpf_program__name (prog)); +return bpf_obj_pin (bpf_program__fd (prog), path); + } + + err =bpf_link__pin (link, path); +bpf_link__destroy (link); +return err; +} + +static int pathname_concat (char *buf,size_t buf_sz,const char *path,const char *name) +{ +int len; + + len =snprintf (buf, buf_sz,"%s/%s" , path, name); +if (len <0 ) +return -EINVAL ; +if ((size_t )len >= buf_sz) +return -ENAMETOOLONG ; + +return 0 ; +} + +static int +auto_attach_programs (struct bpf_object *obj,const char *path) +{ +struct bpf_program *prog; +char buf[PATH_MAX ]; +int err; + +bpf_object__for_each_program (prog, obj) { + err =pathname_concat (buf,sizeof (buf), path,bpf_program__name (prog)); +if (err) + goto err_unpin_programs; + + err =auto_attach_program (prog, buf); +if (err) + goto err_unpin_programs; + } + +return 0 ; + +err_unpin_programs: +while ((prog =bpf_object__prev_program (obj, prog))) { +if (pathname_concat (buf,sizeof (buf), path,bpf_program__name (prog))) +continue ; + +bpf_program__unpin (prog, buf); + } + +return err; +} +static int load_with_options (int argc,char **argv,bool first_prog_only) {enum bpf_prog_type common_prog_type =BPF_PROG_TYPE_UNSPEC ;
@@ -1464,6 +1525,7 @@ static int load_with_options(int argc, char **argv, bool first_prog_only)struct bpf_program *prog =NULL , *pos;unsigned int old_map_fds =0 ;const char *pinmaps =NULL ; +bool auto_attach = false;struct bpf_object *obj;struct bpf_map *map;const char *pinfile;
@@ -1583,6 +1645,9 @@ static int load_with_options(int argc, char **argv, bool first_prog_only) goto err_free_reuse_maps; pinmaps =GET_ARG (); + }else if (is_prefix (*argv,"autoattach" )) { + auto_attach = true; +NEXT_ARG (); }else {p_err ("expected no more arguments, 'type', 'map' or 'dev', got: '%s'?" , *argv);
@@ -1692,14 +1757,20 @@ static int load_with_options(int argc, char **argv, bool first_prog_only) goto err_close_obj; } - err =bpf_obj_pin (bpf_program__fd (prog), pinfile); +if (auto_attach) + err =auto_attach_program (prog, pinfile); +else + err =bpf_obj_pin (bpf_program__fd (prog), pinfile);if (err) {p_err ("failed to pin program %s" ,bpf_program__section_name (prog)); goto err_close_obj; } }else { - err =bpf_object__pin_programs (obj, pinfile); +if (auto_attach) + err =auto_attach_programs (obj, pinfile); +else + err =bpf_object__pin_programs (obj, pinfile);if (err) {p_err ("failed to pin all programs" ); goto err_close_obj;
@@ -2338,6 +2409,7 @@ static int do_help(int argc, char **argv)" [type TYPE] [dev NAME] \\\n" " [map { idx IDX | name NAME } MAP]\\\n" " [pinmaps MAP_DIR]\n" +" [autoattach]\n" " %1$s %2$s attach PROG ATTACH_TYPE [MAP]\n" " %1$s %2$s detach PROG ATTACH_TYPE [MAP]\n" " %1$s %2$s run PROG \\\n"
Signature · 1 line
1.8.3.1
PATCH v9 2/3 bpftool: Update doc (add autoattach to prog load)
In reply to Wang YufenAdd autoattach optional to prog load|loadall for supporting one-step load-attach-pin_link.
--- tools/bpf/bpftool/Documentation/bpftool-prog.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-)
tools/bpf/bpftool/Documentation/bpftool-prog.rst +13 -2
@@ -31,7 +31,7 @@ PROG COMMANDS | **bpftool** **prog dump xlated** *PROG* [{**file** *FILE* | **opcodes** | **visual** | **linum**}] | **bpftool** **prog dump jited** *PROG* [{**file** *FILE* | **opcodes** | **linum**}] | **bpftool** **prog pin** *PROG* *FILE* -| **bpftool** **prog** { **load** | **loadall** } *OBJ* *PATH* [**type** *TYPE*] [**map** {**idx** *IDX* | **name** *NAME*} *MAP*] [**dev** *NAME*] [**pinmaps** *MAP_DIR*] +| **bpftool** **prog** { **load** | **loadall** } *OBJ* *PATH* [**type** *TYPE*] [**map** {**idx** *IDX* | **name** *NAME*} *MAP*] [**dev** *NAME*] [**pinmaps** *MAP_DIR*] [**autoattach**] | **bpftool** **prog attach** *PROG* *ATTACH_TYPE* [*MAP*] | **bpftool** **prog detach** *PROG* *ATTACH_TYPE* [*MAP*] | **bpftool** **prog tracelog**
@@ -131,7 +131,7 @@ DESCRIPTION contain a dot character ('.'), which is reserved for future extensions of *bpffs*. - **bpftool prog { load | loadall }** *OBJ* *PATH* [**type** *TYPE*] [**map** {**idx** *IDX* | **name** *NAME*} *MAP*] [**dev** *NAME*] [**pinmaps** *MAP_DIR*] + **bpftool prog { load | loadall }** *OBJ* *PATH* [**type** *TYPE*] [**map** {**idx** *IDX* | **name** *NAME*} *MAP*] [**dev** *NAME*] [**pinmaps** *MAP_DIR*] [**autoattach**] Load bpf program(s) from binary *OBJ* and pin as *PATH*. **bpftool prog load** pins only the first program from the *OBJ* as *PATH*. **bpftool prog loadall** pins all programs
@@ -150,6 +150,17 @@ DESCRIPTION Optional **pinmaps** argument can be provided to pin all maps under *MAP_DIR* directory. + If **autoattach** is specified program will be attached + before pin. In that case, only the link (representing the + program attached to its hook) is pinned, not the program as + such, so the path won't show in **bpftool prog show -f**, + only show in **bpftool link show -f**. Also, this only works + when bpftool (libbpf) is able to infer all necessary + information from the object file, in particular, it's not + supported for all program types. If a program does not + support autoattach, bpftool falls back to regular pinning + for that program instead. + Note: *PATH* must be located in *bpffs* mount. It must not contain a dot character ('.'), which is reserved for future extensions of *bpffs*.
Signature · 1 line
1.8.3.1
PATCH v9 3/3 bpftool: Update the bash completion(add autoattach to prog load)
In reply to Wang YufenAdd autoattach optional to prog load|loadall for supporting one-step load-attach-pin_link.
--- tools/bpf/bpftool/bash-completion/bpftool | 1 + 1 file changed, 1 insertion(+)
tools/bpf/bpftool/bash-completion/bpftool +1 -0
@@ -505,6 +505,7 @@ _bpftool() _bpftool_once_attr 'type' _bpftool_once_attr 'dev' _bpftool_once_attr 'pinmaps' + _bpftool_once_attr 'autoattach' return 0 ;; esac
Signature · 1 line
1.8.3.1
This series was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:
Hello:
This series was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:
Quoted 16 lines · On Fri, 14 Oct 2022 16:31:12 +0800 you wrote:
This patchset add "autoattach" optional for "bpftool prog
load(_all)" to support one-step load-attach-pin_link.v8 -> v9: fix link leak, and change pathname_concat(specify not just buffer
pointer, but also it's size)
v7 -> v8: for the programs not supporting autoattach, fall back to reguler pinning
instead of skipping
v6 -> v7: add info msg print and update doc for the skip program
v5 -> v6: skip the programs not supporting auto-attach,
and change optional name from "auto_attach" to "autoattach"
v4 -> v5: some formatting nits of doc
v3 -> v4: rename functions, update doc, bash anddo_help()
v2 -> v3: switch to extend prog load command instead of extend perf
v2: https://patchwork.kernel.org/project/netdevbpf/patch/[email protected]/
v1: https://patchwork.kernel.org/project/netdevbpf/patch/[email protected]/
Quoted 1 line
[...]
Here is the summary with links:
- [bpf-next,v9,1/3] bpftool: Add autoattach for bpf prog load|loadall
https://git.kernel.org/bpf/bpf-next/c/19526e701ea0 - [bpf-next,v9,2/3] bpftool: Update doc (add autoattach to prog load) https://git.kernel.org/bpf/bpf-next/c/ff0e9a579ec9 - [bpf-next,v9,3/3] bpftool: Update the bash completion(add autoattach to prog load) https://git.kernel.org/bpf/bpf-next/c/b81a67740075
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html