bpftool: Add auto_attach for bpf prog load|loadall
Subsystems (4)
PATCH v5 1/3 bpftool: Add auto_attach for bpf prog load|loadall
Add auto_attach optional to support one-step load-attach-pin_link.
For example,
$ bpftool prog loadall test.o /sys/fs/bpf/test auto_attach
$ 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 auto_attach optional can support tracepoints, k(ret)probes, u(ret)probes.
---
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]/
tools/bpf/bpftool/prog.c | 77 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 75 insertions(+), 2 deletions(-)
tools/bpf/bpftool/prog.c +75 -2
@@ -1453,6 +1453,68 @@ 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); + err =libbpf_get_error (link); +if (err) +return err; + + err =bpf_link__pin (link, path); +if (err) { +bpf_link__destroy (link); +return err; + } +return 0 ; +} + +static int pathname_concat (const char *path,const char *name,char *buf) +{ +int len; + + len =snprintf (buf,PATH_MAX ,"%s/%s" , path, name); +if (len <0 ) +return -EINVAL ; +if (len >=PATH_MAX ) +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 (path,bpf_program__name (prog), buf); +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 (path,bpf_program__name (prog), buf)) +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 +1526,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 +1646,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,"auto_attach" )) { + auto_attach = true; +NEXT_ARG (); }else {p_err ("expected no more arguments, 'type', 'map' or 'dev', got: '%s'?" , *argv);
@@ -1692,14 +1758,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 +2410,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" +" [auto_attach]\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 v5 2/3 bpftool: Update doc (add auto_attach to prog load)
Add auto_attach optional to prog load|loadall for supporting one-step load-attach-pin_link.
--- tools/bpf/bpftool/Documentation/bpftool-prog.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-)
tools/bpf/bpftool/Documentation/bpftool-prog.rst +11 -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*] [**auto_attach**] | **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*] [**auto_attach**] 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,15 @@ DESCRIPTION Optional **pinmaps** argument can be provided to pin all maps under *MAP_DIR* directory. + If **auto_attach** 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 objectfile, in particular, it's not supported for all + program types. + 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 v5 3/3 bpftool: Update the bash completion(add auto_attach to prog load)
In reply to Wang YufenAdd auto_attach 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 'auto_attach' return 0 ;; esac
Signature · 1 line
1.8.3.1
Quoted 47 lines · Wang Yufen
Add
auto_attachoptional to support one-step load-attach-pin_link.For example,
$ bpftool prog loadall test.o /sys/fs/bpf/test auto_attach$ 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 57The
auto_attachoptional can support tracepoints, k(ret)probes, u(ret)probes.Signed-off-by Wei Yongjun <[email protected]>Signed-off-by Wang Yufen <[email protected]>Reviewed-by Quentin Monnet <[email protected]>---
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]/tools/bpf/bpftool/prog.c | 77 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 75 insertions(+), 2 deletions(-)tools/bpf/bpftool/prog.c +0
-0@@ -1453,6 +1453,68 @@ static int do_run(int argc, char **argv)return ret;
tools/bpf/bpftool/prog.c static int do_run(int argc, char **argv) · line 1463
Quoted 10 lines
tools/bpf/bpftool/prog.c +8
-0} +static int +auto_attach_program (struct bpf_program *prog,const char *path) +{ +struct bpf_link *link; +int err; + + link =bpf_program__attach (prog); + err =libbpf_get_error (link);
nit: bpftool uses libbpf 1.0, so no need to use libbpf_get_error() anymore, you can just check link for NULL and then look at errno
but I wanted to check on desired behavior here. BPF skeleton will skip programs that can't be auto-attached because they are of the type that can't be declaratively specified to be auto-attachable. For such programs bpf_program__attach() will return -EOPNOTSUPP and libbpf's skeleton_attach API will silently skip them. Should bpftool be stricter about such programs here or should it follow BPF skeleton approach?
tools/bpf/bpftool/prog.c static int do_run(int argc, char **argv) · line 1475
Quoted 12 lines
tools/bpf/bpftool/prog.c +12
-0+if (err) +return err; + + err =bpf_link__pin (link, path); +if (err) { +bpf_link__destroy (link); +return err; + } +return 0 ; +} + +static int pathname_concat (const char *path,const char *name,char *buf)
you added buffer size in libbpf version of this function, maybe match the same signature (I also moved buf and buf_sz to be first two args).
Quoted 19 lines
tools/bpf/bpftool/prog.c +19
-0+{ +int len; + + len =snprintf (buf,PATH_MAX ,"%s/%s" , path, name); +if (len <0 ) +return -EINVAL ; +if (len >=PATH_MAX ) +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; +
tools/bpf/bpftool/prog.c static int do_run(int argc, char **argv) · line 1504
Quoted 10 lines
tools/bpf/bpftool/prog.c +10
-0+bpf_object__for_each_program (prog, obj) { + err =pathname_concat (path,bpf_program__name (prog), buf); +if (err) + goto err_unpin_programs; + + err =auto_attach_program (prog, buf); +if (err) + goto err_unpin_programs; + } +
would it be safer to first make sure that all programs are auto-attached and then pin links?
also note that not all bpf_links returned by libbpf are actual links in kernel (e.g., kprobe/tp bpf_link on older kernels).
Quoted 58 lines
tools/bpf/bpftool/prog.c +25
-2+return 0 ; + +err_unpin_programs: +while ((prog =bpf_object__prev_program (obj, prog))) { +if (pathname_concat (path,bpf_program__name (prog), buf)) +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 +1526,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 +1646,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,"auto_attach" )) { + auto_attach = true; +NEXT_ARG (); }else {p_err ("expected no more arguments, 'type', 'map' or 'dev', got: '%s'?" , *argv);@@ -1692,14 +1758,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;
tools/bpf/bpftool/prog.c static int do_help(int argc, char **argv) · line 2413
Quoted 4 lines
tools/bpf/bpftool/prog.c +1
-0@@ -2338,6 +2410,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" +" [auto_attach]\n"
looking at "pinmaps" seems like "autoattach" would be more consistent naming? Or just "attach"?
Quoted 6 lines
tools/bpf/bpftool/prog.c +0
-1" %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" --1.8.3.1
Quoted 49 lines · Andrii Nakryiko
Quoted 48 lines · Wang Yufen
Add
auto_attachoptional to support one-step load-attach-pin_link.For example,
$ bpftool prog loadall test.o /sys/fs/bpf/test auto_attach$ 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 57The
auto_attachoptional can support tracepoints, k(ret)probes, u(ret)probes.Signed-off-by Wei Yongjun <[email protected]>Signed-off-by Wang Yufen <[email protected]>Reviewed-by Quentin Monnet <[email protected]>---
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]/tools/bpf/bpftool/prog.c | 77 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 75 insertions(+), 2 deletions(-)tools/bpf/bpftool/prog.c +0
-0@@ -1453,6 +1453,68 @@ static int do_run(int argc, char **argv)return ret; }
Quoted 10 lines
tools/bpf/bpftool/prog.c static int do_run(int argc, char **argv) · line 1463
Quoted 8 lines
tools/bpf/bpftool/prog.c +8
-0+static int +auto_attach_program (struct bpf_program *prog,const char *path) +{ +struct bpf_link *link; +int err; + + link =bpf_program__attach (prog); + err =libbpf_get_error (link);nit: bpftool uses libbpf 1.0, so no need to use
libbpf_get_error()anymore, you can just check link for NULL and then look at errno
Thanks, will change in v6
Quoted 8 lines
but I wanted to check on desired behavior here. BPF skeleton will skip programs that can't be auto-attached because they are of the type that can't be declaratively specified to be auto-attachable. For such programs
bpf_program__attach()will return-EOPNOTSUPPand libbpf'sskeleton_attachAPI will silently skip them. Should bpftool be stricter about such programs here or should it follow BPF skeleton approach?
will change auto_attach_programs() to follow BPF skeleton approach in v6
Quoted 47 lines
tools/bpf/bpftool/prog.c static int do_run(int argc, char **argv) · line 1475
Quoted 12 lines
tools/bpf/bpftool/prog.c +12
-0+if (err) +return err; + + err =bpf_link__pin (link, path); +if (err) { +bpf_link__destroy (link); +return err; + } +return 0 ; +} + +static int pathname_concat (const char *path,const char *name,char *buf)you added buffer size in libbpf version of this function, maybe match the same signature (I also moved buf and
buf_szto be first two args).Quoted 19 lines
tools/bpf/bpftool/prog.c +19
-0+{ +int len; + + len =snprintf (buf,PATH_MAX ,"%s/%s" , path, name); +if (len <0 ) +return -EINVAL ; +if (len >=PATH_MAX ) +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; +tools/bpf/bpftool/prog.c static int do_run(int argc, char **argv) · line 1504
Quoted 10 lines
tools/bpf/bpftool/prog.c +10
-0+bpf_object__for_each_program (prog, obj) { + err =pathname_concat (path,bpf_program__name (prog), buf); +if (err) + goto err_unpin_programs; + + err =auto_attach_program (prog, buf); +if (err) + goto err_unpin_programs; + } +would it be safer to first make sure that all programs are auto-attached and then pin links?
Quoted 2 lines
also note that not all
bpf_linksreturned by libbpf are actual links in kernel (e.g., kprobe/tpbpf_linkon older kernels).
will silently skip the unsupport programs as BPF skeleton
approach
Quoted 57 lines
Quoted 57 lines
tools/bpf/bpftool/prog.c +25
-2+return 0 ; + +err_unpin_programs: +while ((prog =bpf_object__prev_program (obj, prog))) { +if (pathname_concat (path,bpf_program__name (prog), buf)) +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 +1526,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 +1646,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,"auto_attach" )) { + auto_attach = true; +NEXT_ARG (); }else {p_err ("expected no more arguments, 'type', 'map' or 'dev', got: '%s'?" , *argv);@@ -1692,14 +1758,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" );
Quoted 8 lines
tools/bpf/bpftool/prog.c static int do_help(int argc, char **argv) · line 2413
Quoted 6 lines
tools/bpf/bpftool/prog.c +1
-0goto err_close_obj;@@ -2338,6 +2410,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" +" [auto_attach]\n" looking at "pinmaps" seems like "autoattach" would be more consistent naming? Or just "attach"?
will change to "autoattach" in v6
Quoted 7 lines
Quoted 7 lines
tools/bpf/bpftool/prog.c +0
-1" %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" --1.8.3.1