libbpf: Add bpf_object__set_name(obj, name) api.
Subsystems (4)
PATCH 1/1 libbpf: Add bpf_object__set_name(obj, name) api.
From: fallentree <[email protected]>
Tracking: libbpf/libbpf#291
--- tools/lib/bpf/libbpf.c | 10 ++++++++++ tools/lib/bpf/libbpf.h | 1 + tools/lib/bpf/libbpf.map | 1 + .../selftests/bpf/prog_tests/reference_tracking.c | 7 +++++++ 4 files changed, 19 insertions(+)
tools/lib/bpf/libbpf.c +10 -0
@@ -7545,6 +7545,16 @@ const char *bpf_object__name(const struct bpf_object *obj)return obj ? obj->name :libbpf_err_ptr (-EINVAL ); } +int bpf_object__set_name (struct bpf_object *obj,const char * name) +{ +if (!name) +return libbpf_err (-EINVAL ); + +strncpy (obj->name, name,sizeof (obj->name) -1 ); + +return 0 ; +} +unsigned int bpf_object__kversion (const struct bpf_object *obj) {return obj ? obj->kern_version :0 ;
tools/lib/bpf/libbpf.h +1 -0
@@ -161,6 +161,7 @@ LIBBPF_API int bpf_object__load_xattr(struct bpf_object_load_attr *attr); LIBBPF_API int bpf_object__unload(struct bpf_object *obj); LIBBPF_API const char *bpf_object__name(const struct bpf_object *obj); +LIBBPF_API int bpf_object__set_name(struct bpf_object *obj, const char* name); LIBBPF_API unsigned int bpf_object__kversion(const struct bpf_object *obj); LIBBPF_API int bpf_object__set_kversion(struct bpf_object *obj, __u32 kern_version);
tools/lib/bpf/libbpf.map +1 -0
@@ -377,4 +377,5 @@ LIBBPF_0.5.0 { bpf_object__gen_loader; btf_dump__dump_type_data; libbpf_set_strict_mode; + bpf_object__set_name; } LIBBPF_0.4.0;
tools/testing/selftests/bpf/prog_tests/reference_tracking.c +7 -0
@@ -5,6 +5,7 @@ void test_reference_tracking(void) {const char *file ="test_sk_lookup_kern.o" ;const char *obj_name ="ref_track" ; +const char *obj_name2 ="ref_track2" ; DECLARE_LIBBPF_OPTS(bpf_object_open_opts, open_opts, .object_name = obj_name, .relaxed_maps = true,
@@ -23,6 +24,12 @@ void test_reference_tracking(void) bpf_object__name(obj), obj_name)) goto cleanup; +bpf_object__set_name (obj, obj_name2); +if (CHECK (strcmp (bpf_object__name (obj), obj_name2),"obj_name" , +"wrong obj name '%s', expected '%s'\n" , +bpf_object__name (obj), obj_name2)) + goto cleanup; +bpf_object__for_each_program (prog, obj) {const char *title;
Signature · 1 line
2.30.2
PATCH v2 1/1 libbpf: Add bpf_object__set_name(obj, name) api.
Tracking: libbpf/libbpf#291
--- tools/lib/bpf/libbpf.c | 10 ++++++++++ tools/lib/bpf/libbpf.h | 1 + tools/lib/bpf/libbpf.map | 1 + .../selftests/bpf/prog_tests/reference_tracking.c | 7 +++++++ 4 files changed, 19 insertions(+)
tools/lib/bpf/libbpf.c +10 -0
@@ -7545,6 +7545,16 @@ const char *bpf_object__name(const struct bpf_object *obj)return obj ? obj->name :libbpf_err_ptr (-EINVAL ); } +int bpf_object__set_name (struct bpf_object *obj,const char * name) +{ +if (!name) +return libbpf_err (-EINVAL ); + +strncpy (obj->name, name,sizeof (obj->name) -1 ); + +return 0 ; +} +unsigned int bpf_object__kversion (const struct bpf_object *obj) {return obj ? obj->kern_version :0 ;
tools/lib/bpf/libbpf.h +1 -0
@@ -161,6 +161,7 @@ LIBBPF_API int bpf_object__load_xattr(struct bpf_object_load_attr *attr); LIBBPF_API int bpf_object__unload(struct bpf_object *obj); LIBBPF_API const char *bpf_object__name(const struct bpf_object *obj); +LIBBPF_API int bpf_object__set_name(struct bpf_object *obj, const char* name); LIBBPF_API unsigned int bpf_object__kversion(const struct bpf_object *obj); LIBBPF_API int bpf_object__set_kversion(struct bpf_object *obj, __u32 kern_version);
tools/lib/bpf/libbpf.map +1 -0
@@ -377,4 +377,5 @@ LIBBPF_0.5.0 { bpf_object__gen_loader; btf_dump__dump_type_data; libbpf_set_strict_mode; + bpf_object__set_name; } LIBBPF_0.4.0;
tools/testing/selftests/bpf/prog_tests/reference_tracking.c +7 -0
@@ -5,6 +5,7 @@ void test_reference_tracking(void) {const char *file ="test_sk_lookup_kern.o" ;const char *obj_name ="ref_track" ; +const char *obj_name2 ="ref_track2" ; DECLARE_LIBBPF_OPTS(bpf_object_open_opts, open_opts, .object_name = obj_name, .relaxed_maps = true,
@@ -23,6 +24,12 @@ void test_reference_tracking(void) bpf_object__name(obj), obj_name)) goto cleanup; +bpf_object__set_name (obj, obj_name2); +if (CHECK (strcmp (bpf_object__name (obj), obj_name2),"obj_name" , +"wrong obj name '%s', expected '%s'\n" , +bpf_object__name (obj), obj_name2)) + goto cleanup; +bpf_object__for_each_program (prog, obj) {const char *title;
Signature · 1 line
2.30.2
PATCH v3 1/1 libbpf: Add bpf_object__set_name(obj, name) api.
Tracking: libbpf/libbpf#291
--
V2 -> V3: fix code style errors
--- tools/lib/bpf/libbpf.c | 10 ++++++++++ tools/lib/bpf/libbpf.h | 1 + tools/lib/bpf/libbpf.map | 1 + .../selftests/bpf/prog_tests/reference_tracking.c | 7 +++++++ 4 files changed, 19 insertions(+)
tools/lib/bpf/libbpf.c +10 -0
@@ -7545,6 +7545,16 @@ const char *bpf_object__name(const struct bpf_object *obj)return obj ? obj->name :libbpf_err_ptr (-EINVAL ); } +int bpf_object__set_name (struct bpf_object *obj,const char * name) +{ +if (!name) +return libbpf_err (-EINVAL ); + +strncpy (obj->name, name,sizeof (obj->name) -1 ); + +return 0 ; +} +unsigned int bpf_object__kversion (const struct bpf_object *obj) {return obj ? obj->kern_version :0 ;
tools/lib/bpf/libbpf.h +1 -0
@@ -161,6 +161,7 @@ LIBBPF_API int bpf_object__load_xattr(struct bpf_object_load_attr *attr); LIBBPF_API int bpf_object__unload(struct bpf_object *obj); LIBBPF_API const char *bpf_object__name(const struct bpf_object *obj); +LIBBPF_API int bpf_object__set_name(struct bpf_object *obj, const char *name); LIBBPF_API unsigned int bpf_object__kversion(const struct bpf_object *obj); LIBBPF_API int bpf_object__set_kversion(struct bpf_object *obj, __u32 kern_version);
tools/lib/bpf/libbpf.map +1 -0
@@ -377,4 +377,5 @@ LIBBPF_0.5.0 { bpf_object__gen_loader; btf_dump__dump_type_data; libbpf_set_strict_mode; + bpf_object__set_name; } LIBBPF_0.4.0;
tools/testing/selftests/bpf/prog_tests/reference_tracking.c +7 -0
@@ -5,6 +5,7 @@ void test_reference_tracking(void) {const char *file ="test_sk_lookup_kern.o" ;const char *obj_name ="ref_track" ; +const char *obj_name2 ="ref_track2" ; DECLARE_LIBBPF_OPTS(bpf_object_open_opts, open_opts, .object_name = obj_name, .relaxed_maps = true,
@@ -23,6 +24,12 @@ void test_reference_tracking(void) bpf_object__name(obj), obj_name)) goto cleanup; +bpf_object__set_name (obj, obj_name2); +if (CHECK (strcmp (bpf_object__name (obj), obj_name2),"obj_name" , +"wrong obj name '%s', expected '%s'\n" , +bpf_object__name (obj), obj_name2)) + goto cleanup; +bpf_object__for_each_program (prog, obj) {const char *title;
Signature · 1 line
2.30.2
PATCH v4 1/1 libbpf: Add bpf_object__set_name(obj, name) api.
Tracking: libbpf/libbpf#291
---
V3 -> V4: handle obj is NULL case.
V2 -> V3: fix code style errors
--- tools/lib/bpf/libbpf.c | 10 ++++++++++ tools/lib/bpf/libbpf.h | 1 + tools/lib/bpf/libbpf.map | 1 + .../selftests/bpf/prog_tests/reference_tracking.c | 7 +++++++ 4 files changed, 19 insertions(+)
tools/lib/bpf/libbpf.c +10 -0
@@ -7545,6 +7545,16 @@ const char *bpf_object__name(const struct bpf_object *obj)return obj ? obj->name :libbpf_err_ptr (-EINVAL ); } +int bpf_object__set_name (struct bpf_object *obj,const char *name) +{ +if (!obj || !name) +return libbpf_err (-EINVAL ); + +strncpy (obj->name, name,sizeof (obj->name) -1 ); + +return 0 ; +} +unsigned int bpf_object__kversion (const struct bpf_object *obj) {return obj ? obj->kern_version :0 ;
tools/lib/bpf/libbpf.h +1 -0
@@ -161,6 +161,7 @@ LIBBPF_API int bpf_object__load_xattr(struct bpf_object_load_attr *attr); LIBBPF_API int bpf_object__unload(struct bpf_object *obj); LIBBPF_API const char *bpf_object__name(const struct bpf_object *obj); +LIBBPF_API int bpf_object__set_name(struct bpf_object *obj, const char *name); LIBBPF_API unsigned int bpf_object__kversion(const struct bpf_object *obj); LIBBPF_API int bpf_object__set_kversion(struct bpf_object *obj, __u32 kern_version);
tools/lib/bpf/libbpf.map +1 -0
@@ -377,4 +377,5 @@ LIBBPF_0.5.0 { bpf_object__gen_loader; btf_dump__dump_type_data; libbpf_set_strict_mode; + bpf_object__set_name; } LIBBPF_0.4.0;
tools/testing/selftests/bpf/prog_tests/reference_tracking.c +7 -0
@@ -5,6 +5,7 @@ void test_reference_tracking(void) {const char *file ="test_sk_lookup_kern.o" ;const char *obj_name ="ref_track" ; +const char *obj_name2 ="ref_track2" ; DECLARE_LIBBPF_OPTS(bpf_object_open_opts, open_opts, .object_name = obj_name, .relaxed_maps = true,
@@ -23,6 +24,12 @@ void test_reference_tracking(void) bpf_object__name(obj), obj_name)) goto cleanup; +bpf_object__set_name (obj, obj_name2); +if (CHECK (strcmp (bpf_object__name (obj), obj_name2),"obj_name" , +"wrong obj name '%s', expected '%s'\n" , +bpf_object__name (obj), obj_name2)) + goto cleanup; +bpf_object__for_each_program (prog, obj) {const char *title;
Signature · 1 line
2.30.2
Quoted 2 lines · Yucong Sun
Tracking: libbpf/libbpf#291
Please provide a bit more elaborate commit summary. Just a link to libbpf Github PR isn't a good commit message. Please explain succinctly what is being added and why.
As for the PR reference itself, please include the full link. You can use this form (which Quentin used pretty consistently already):
Reference: https://github.com/libbpf/libbpf/issues/291
Quoted 19 lines
Signed-off-by Yucong Sun <[email protected]>---
V3 -> V4: handle obj is NULL case.
V2 -> V3: fix code style errors--- tools/lib/bpf/libbpf.c | 10 ++++++++++ tools/lib/bpf/libbpf.h | 1 + tools/lib/bpf/libbpf.map | 1 + .../selftests/bpf/prog_tests/reference_tracking.c | 7 +++++++ 4 files changed, 19 insertions(+)tools/lib/bpf/libbpf.c +0
-0
tools/lib/bpf/libbpf.c const char *bpf_object__name(const struct bpf_object *obj) · line 7551
Quoted 7 lines
tools/lib/bpf/libbpf.c +4
-0@@ -7545,6 +7545,16 @@ const char *bpf_object__name(const struct bpf_object *obj)return obj ? obj->name :libbpf_err_ptr (-EINVAL ); } +int bpf_object__set_name (struct bpf_object *obj,const char *name) +{ +if (!obj || !name) +return libbpf_err (-EINVAL );
I think we shouldn't be checking !obj in every bpf_object's API (even though we have a bunch of APIs like that). If user can't make sure they pass non-NULL proper pointer, it's fine for them to debug SIGSEGV.
tools/lib/bpf/libbpf.c const char *bpf_object__name(const struct bpf_object *obj) · line 7553
Quoted 2 lines
tools/lib/bpf/libbpf.c +2
-0+ +strncpy (obj->name, name,sizeof (obj->name) -1 );
let's do two extra checks:
1. if bpf_object was already loaded, it's too late (maps were named with its name, etc), so error out in that case
2. if provided name is too long, we can still truncate and set it, but let's also return -E2BIG maybe?
BTW, static analyzers like to complain about strncpy not zero terminating, add extra obj->name[sizeof(obj->name) - 1] = '\0'; at the end to make them happier
Also, please add selftest validating that this name is actually taken into account properly. First thing that comes to mind to check this would be .data/.rodata map names check, but look around the source code to see if there is something other that can be used as a check.
Quoted 24 lines
tools/lib/bpf/libbpf.c +4
-0+ +return 0 ; +} +unsigned int bpf_object__kversion (const struct bpf_object *obj) {return obj ? obj->kern_version :0 ;tools/lib/bpf/libbpf.h +1
-0@@ -161,6 +161,7 @@ LIBBPF_API int bpf_object__load_xattr(struct bpf_object_load_attr *attr); LIBBPF_API int bpf_object__unload(struct bpf_object *obj); LIBBPF_API const char *bpf_object__name(const struct bpf_object *obj); +LIBBPF_API int bpf_object__set_name(struct bpf_object *obj, const char *name); LIBBPF_API unsigned int bpf_object__kversion(const struct bpf_object *obj); LIBBPF_API int bpf_object__set_kversion(struct bpf_object *obj, __u32 kern_version);tools/lib/bpf/libbpf.map +0
-0
tools/lib/bpf/libbpf.map LIBBPF_0.5.0 { · line 380
Quoted 4 lines
tools/lib/bpf/libbpf.map +1
-0@@ -377,4 +377,5 @@ LIBBPF_0.5.0 { bpf_object__gen_loader; btf_dump__dump_type_data; libbpf_set_strict_mode; + bpf_object__set_name;
please keep that list alphabetically sorted
Quoted 14 lines
tools/lib/bpf/libbpf.map +0
-0} LIBBPF_0.4.0;tools/testing/selftests/bpf/prog_tests/reference_tracking.c +1
-0@@ -5,6 +5,7 @@ void test_reference_tracking(void) {const char *file ="test_sk_lookup_kern.o" ;const char *obj_name ="ref_track" ; +const char *obj_name2 ="ref_track2" ; DECLARE_LIBBPF_OPTS(bpf_object_open_opts, open_opts, .object_name = obj_name, .relaxed_maps = true,
tools/testing/selftests/bpf/prog_tests/reference_tracking.c void test_reference_tracking(void) · line 32
Quoted 9 lines
tools/testing/selftests/bpf/prog_tests/reference_tracking.c +6
-0@@ -23,6 +24,12 @@ void test_reference_tracking(void) bpf_object__name(obj), obj_name)) goto cleanup; +bpf_object__set_name (obj, obj_name2); +if (CHECK (strcmp (bpf_object__name (obj), obj_name2),"obj_name" , +"wrong obj name '%s', expected '%s'\n" , +bpf_object__name (obj), obj_name2)) + goto cleanup; +
it's a bit too simple and doesn't test much. See how obj->name is used for naming maps (and maybe something else as well), and validate that it gets propagated properly
Quoted 6 lines
tools/testing/selftests/bpf/prog_tests/reference_tracking.c +0
-1bpf_object__for_each_program (prog, obj) {const char *title; --2.30.2