Add error returns to two API functions
PATCH v4 1/3 Add error returns to two API functions
From: Grant Seltzer <[email protected]>
This adds an error return to the following API functions:
- bpf_program__set_expected_attach_type()
- bpf_program__set_type()
In both cases, the error occurs when the BPF object has already been loaded when the function is called. In this case -EBUSY is returned.
--- tools/lib/bpf/libbpf.c | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-)
tools/lib/bpf/libbpf.c +10 -2
@@ -8551,9 +8551,13 @@ enum bpf_prog_type bpf_program__type(const struct bpf_program *prog)return prog->type; } -void bpf_program__set_type (struct bpf_program *prog,enum bpf_prog_type type) +int bpf_program__set_type (struct bpf_program *prog,enum bpf_prog_type type) { +if (prog->obj->loaded) +return libbpf_err (-EBUSY ); + prog->type = type; +return 0 ; } static bool bpf_program__is_type(const struct bpf_program *prog,
@@ -8598,10 +8602,14 @@ enum bpf_attach_type bpf_program__expected_attach_type(const struct bpf_programreturn prog->expected_attach_type; } -void bpf_program__set_expected_attach_type (struct bpf_program *prog, +int bpf_program__set_expected_attach_type (struct bpf_program *prog,enum bpf_attach_type type) { +if (prog->obj->loaded) +return libbpf_err (-EBUSY ); + prog->expected_attach_type = type; +return 0 ; }__u32 bpf_program__flags (const struct bpf_program *prog)
Signature · 1 line
2.34.1
PATCH v4 2/3 Update API functions usage to check error
From: Grant Seltzer <[email protected]>
This updates usage of the following API functions within libbpf so their newly added error return is checked:
- bpf_program__set_expected_attach_type()
- bpf_program__set_type()
--- tools/lib/bpf/libbpf.c | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-)
tools/lib/bpf/libbpf.c +5 -7
@@ -7005,8 +7005,8 @@ static int bpf_object_init_progs(struct bpf_object *obj, const struct bpf_objectcontinue ; } -bpf_program__set_type (prog, prog->sec_def->prog_type); -bpf_program__set_expected_attach_type (prog, prog->sec_def->expected_attach_type); + prog->type = prog->sec_def->prog_type; + prog->expected_attach_type = prog->sec_def->expected_attach_type;#pragma GCC diagnostic push#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
@@ -8571,8 +8571,7 @@ int bpf_program__set_##NAME(struct bpf_program *prog) \ { \if (!prog) \return libbpf_err (-EINVAL ); \ -bpf_program__set_type (prog,TYPE ); \ -return 0 ; \ +return bpf_program__set_type (prog,TYPE ); \ } \ \ bool bpf_program__is_##NAME(const struct bpf_program *prog) \
@@ -9679,9 +9678,8 @@ static int bpf_prog_load_xattr2(const struct bpf_prog_load_attr *attr,* bpf_object__open guessed */ if (attr->prog_type !=BPF_PROG_TYPE_UNSPEC ) { -bpf_program__set_type (prog, attr->prog_type); -bpf_program__set_expected_attach_type (prog, - attach_type); + prog->type = attr->prog_type; + prog->expected_attach_type = attach_type; }if (bpf_program__type (prog) ==BPF_PROG_TYPE_UNSPEC ) {/*
Signature · 1 line
2.34.1
PATCH v4 3/3 Add documentation to API functions
In reply to grantseltzerFrom: Grant Seltzer <[email protected]>
This adds documentation for the following API functions:
- bpf_program__set_expected_attach_type()
- bpf_program__set_type()
- bpf_program__set_attach_target()
- bpf_program__attach()
- bpf_program__pin()
- bpf_program__unpin()
--- tools/lib/bpf/libbpf.h | 77 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 75 insertions(+), 2 deletions(-)
tools/lib/bpf/libbpf.h +75 -2
@@ -378,7 +378,31 @@ struct bpf_link; LIBBPF_API struct bpf_link *bpf_link__open(const char *path); LIBBPF_API int bpf_link__fd(const struct bpf_link *link); LIBBPF_API const char *bpf_link__pin_path(const struct bpf_link *link); +/** +* @brief **bpf_link__pin()** pins the BPF link to a file +* in the BPF FS specified by a path. This increments the links +* reference count, allowing it to stay loaded after the process +* which loaded it has exited. +* +* @param link BPF link to pin, must already be loaded +* @param path file path in a BPF file system +* @return 0, on success; negative error code, otherwise +*/ + LIBBPF_API int bpf_link__pin(struct bpf_link *link, const char *path); + +/** +* @brief **bpf_link__unpin()** unpins the BPF link from a file +* in the BPFFS specified by a path. This decrements the links +* reference count. +* +* The file pinning the BPF link can also be unlinked by a different +* process in which case this function will return an error. +* +* @param prog BPF program to unpin +* @param path file path to the pin in a BPF file system +* @return 0, on success; negative error code, otherwise +*/ LIBBPF_API int bpf_link__unpin(struct bpf_link *link); LIBBPF_API int bpf_link__update_program(struct bpf_link *link,struct bpf_program *prog);
@@ -386,6 +410,22 @@ LIBBPF_API void bpf_link__disconnect(struct bpf_link *link); LIBBPF_API int bpf_link__detach(struct bpf_link *link); LIBBPF_API int bpf_link__destroy(struct bpf_link *link); +/** +* @brief **bpf_program__attach()** is a generic function for attaching +* a BPF program based on auto-detection of program type, attach type, +* and extra paremeters, where applicable. +* +* @param prog BPF program to attach +* @return Reference to the newly created BPF link; or NULL is returned on error, +* error code is stored in errno +* +* This is supported for: +* - kprobe/kretprobe (depends on SEC() definition) +* - uprobe/uretprobe (depends on SEC() definition) +* - tracepoint +* - raw tracepoint +* - tracing programs (typed raw TP/fentry/fexit/fmod_ret) +*/ LIBBPF_API struct bpf_link *bpf_program__attach (const struct bpf_program *prog);
@@ -686,12 +726,37 @@ LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead") LIBBPF_API int bpf_program__set_sk_lookup(struct bpf_program *prog); LIBBPF_API enum bpf_prog_type bpf_program__type(const struct bpf_program *prog); -LIBBPF_API void bpf_program__set_type(struct bpf_program *prog, + +/** +* @brief **bpf_program__set_type()** sets the program +* type of the passed BPF program. +* @param prog BPF program to set the program type for +* @param type program type to set the BPF map to have +* @return error code; or 0 if no error. An error occurs +* if the object is already loaded. +* +* This must be called before the BPF object is loaded, +* otherwise it has no effect and an error is returned. +*/ +LIBBPF_API int bpf_program__set_type(struct bpf_program *prog,enum bpf_prog_type type); LIBBPF_API enum bpf_attach_typebpf_program__expected_attach_type (const struct bpf_program *prog); -LIBBPF_API void + +/** +* @brief **bpf_program__set_expected_attach_type()** sets the +* attach type of the passed BPF program. This is used for +* auto-detection of attachment when programs are loaded. +* @param prog BPF program to set the attach type for +* @param type attach type to set the BPF map to have +* @return error code; or 0 if no error. An error occurs +* if the object is already loaded. +* +* This must be called before the BPF object is loaded, +* otherwise it has no effect and an error is returned. +*/ +LIBBPF_API intbpf_program__set_expected_attach_type (struct bpf_program *prog,enum bpf_attach_type type);
@@ -707,6 +772,14 @@ LIBBPF_API int bpf_program__set_log_level(struct bpf_program *prog, __u32 log_le LIBBPF_API const char *bpf_program__log_buf(const struct bpf_program *prog, size_t *log_size); LIBBPF_API int bpf_program__set_log_buf(struct bpf_program *prog, char *log_buf, size_t log_size); +/** +* @brief **bpf_program__set_attach_target()** sets BTF-based attach target +* for supported BPF program types: +* BTF-aware raw tracepoints, fentry/fexit/fmod_ret, lsm, freplace +* @param prog BPF program to set the attach type for +* @param type attach type to set the BPF map to have +* @return error code; or 0 if no error occurred. +*/ LIBBPF_API intbpf_program__set_attach_target (struct bpf_program *prog,int attach_prog_fd,const char *attach_func_name);
Signature · 1 line
2.34.1
Re: [PATCH bpf-next v4 3/3] Add documentation to API functions
Quoted 16 lines · grantseltzer
From: Grant Seltzer <[email protected]>
This adds documentation for the following API functions:
-bpf_program__set_expected_attach_type()
-bpf_program__set_type()
-bpf_program__set_attach_target()
-bpf_program__attach()
-bpf_program__pin()
-bpf_program__unpin()Signed-off-by Grant Seltzer <[email protected]>--- tools/lib/bpf/libbpf.h | 77 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 75 insertions(+), 2 deletions(-)
[...]
Quoted 8 lines
LIBBPF_APIenumbpf_attach_typebpf_program__expected_attach_type(const struct bpf_program *prog);tools/lib/bpf/libbpf.h +4
-1-LIBBPF_API void + +/** +* @brief **bpf_program__set_expected_attach_type()** sets the +* attach type of the passed BPF program. This is used for
tools/lib/bpf/libbpf.h LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead") · line 759
Quoted 10 lines
tools/lib/bpf/libbpf.h +10
-0+* auto-detection of attachment when programs are loaded. +* @param prog BPF program to set the attach type for +* @param type attach type to set the BPF map to have +* @return error code; or 0 if no error. An error occurs +* if the object is already loaded. +* +* This must be called before the BPF object is loaded, +* otherwise it has no effect and an error is returned. +*/ +LIBBPF_API int
you forgot to do this void -> int replacement in libbpf.h. I've fixed it up while applying, so all the type changes happen in patch #1.
tools/lib/bpf/libbpf.h LIBBPF_API int bpf_program__set_log_level(struct bpf_program *prog, __u32 log_le · line 778
Quoted 11 lines
bpf_program__set_expected_attach_type(struct
bpf_program*prog,enum bpf_attach_type type);tools/lib/bpf/libbpf.h +4
-0@@ -707,6 +772,14 @@ LIBBPF_API int bpf_program__set_log_level(struct bpf_program *prog, __u32 log_le LIBBPF_API const char *bpf_program__log_buf(const struct bpf_program *prog, size_t *log_size); LIBBPF_API int bpf_program__set_log_buf(struct bpf_program *prog, char *log_buf, size_t log_size); +/** +* @brief **bpf_program__set_attach_target()** sets BTF-based attach target +* for supported BPF program types: +* BTF-aware raw tracepoints, fentry/fexit/fmod_ret, lsm, freplace
also turned this into a proper list
Quoted 10 lines
tools/lib/bpf/libbpf.h +4
-1+* @param prog BPF program to set the attach type for +* @param type attach type to set the BPF map to have +* @return error code; or 0 if no error occurred. +*/ LIBBPF_API intbpf_program__set_attach_target (struct bpf_program *prog,int attach_prog_fd,const char *attach_func_name); --2.34.1
This series was applied to bpf/bpf-next.git (master) by Andrii Nakryiko <[email protected]>:
Hello:
This series was applied to bpf/bpf-next.git (master) by Andrii Nakryiko <[email protected]>:
Quoted 8 lines · On Wed, 20 Apr 2022 12:12:24 -0400 you wrote:
From: Grant Seltzer <[email protected]>
This adds an error return to the following API functions:
-
bpf_program__set_expected_attach_type()
-bpf_program__set_type()[...]
Here is the summary with links:
- [bpf-next,v4,1/3] Add error returns to two API functions
https://git.kernel.org/bpf/bpf-next/c/d9a51c964771 - [bpf-next,v4,2/3] Update API functions usage to check error https://git.kernel.org/bpf/bpf-next/c/042b971bd9a3 - [bpf-next,v4,3/3] Add documentation to API functions https://git.kernel.org/bpf/bpf-next/c/e1a34e19ea96
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html