Stop using bpf_object__find_program_by_title API
Subsystems (6)
v3 cover Stop using bpf_object__find_program_by_title API
bpf_object__find_program_by_title is going to be deprecated since v0.7. Replace all use cases with bpf_object__find_program_by_name if possible, or use bpf_object__for_each_program to iterate over programs, matching section names.
V3 fixes a broken test case, fexit_bpf2bpf, in selftests/bpf, using bpf_obj__for_each_program API instead.
[v2] https://lore.kernel.org/bpf/[email protected]/
[v1] https://lore.kernel.org/bpf/[email protected]/T/
Kui-Feng Lee (4):
selftests/bpf: Stop using bpf_object__find_program_by_title API. samples/bpf: Stop using bpf_object__find_program_by_title API. tools/perf: Stop using bpf_object__find_program_by_title API.
libbpf: Mark bpf_object__find_program_by_title API deprecated.
samples/bpf/hbm.c | 11 ++- samples/bpf/xdp_fwd_user.c | 12 ++- tools/lib/bpf/libbpf.h | 1 + tools/perf/builtin-trace.c | 13 ++- .../selftests/bpf/prog_tests/bpf_obj_id.c | 4 +- .../bpf/prog_tests/connect_force_port.c | 18 ++--- .../selftests/bpf/prog_tests/core_reloc.c | 79 +++++++++++++------ .../selftests/bpf/prog_tests/fexit_bpf2bpf.c | 17 +++- .../bpf/prog_tests/get_stack_raw_tp.c | 4 +- .../bpf/prog_tests/sockopt_inherit.c | 15 ++-- .../selftests/bpf/prog_tests/stacktrace_map.c | 4 +- .../bpf/prog_tests/stacktrace_map_raw_tp.c | 4 +- .../selftests/bpf/prog_tests/test_overhead.c | 20 ++--- .../bpf/prog_tests/trampoline_count.c | 6 +- 14 files changed, 137 insertions(+), 71 deletions(-)
Signature · 1 line
2.30.2
PATCH v3 1/4 selftests/bpf: Stop using bpf_object__find_program_by_title API.
bpf_object__find_program_by_title is going to be deprecated. Replace all use cases in tools/testing/selftests/bpf with bpf_object__find_program_by_name or bpf_object__for_each_program.
--- .../selftests/bpf/prog_tests/bpf_obj_id.c | 4 +- .../bpf/prog_tests/connect_force_port.c | 18 ++--- .../selftests/bpf/prog_tests/core_reloc.c | 79 +++++++++++++------ .../selftests/bpf/prog_tests/fexit_bpf2bpf.c | 17 +++- .../bpf/prog_tests/get_stack_raw_tp.c | 4 +- .../bpf/prog_tests/sockopt_inherit.c | 15 ++-- .../selftests/bpf/prog_tests/stacktrace_map.c | 4 +- .../bpf/prog_tests/stacktrace_map_raw_tp.c | 4 +- .../selftests/bpf/prog_tests/test_overhead.c | 20 ++--- .../bpf/prog_tests/trampoline_count.c | 6 +- 10 files changed, 104 insertions(+), 67 deletions(-)
tools/testing/selftests/bpf/prog_tests/bpf_obj_id.c +2 -2
@@ -65,8 +65,8 @@ void serial_test_bpf_obj_id(void)if (CHECK_FAIL (err)) goto done; - prog =bpf_object__find_program_by_title (objs[i], -"raw_tp/sys_enter" ); + prog =bpf_object__find_program_by_name (objs[i], +"test_obj_id" );if (CHECK_FAIL (!prog)) goto done; links[i] =bpf_program__attach (prog);
tools/testing/selftests/bpf/prog_tests/connect_force_port.c +9 -9
@@ -67,9 +67,9 @@ static int run_test(int cgroup_fd, int server_fd, int family, int type) goto close_bpf_object; } - prog =bpf_object__find_program_by_title (obj, v4 ? -"cgroup/connect4" : -"cgroup/connect6" ); + prog =bpf_object__find_program_by_name (obj, v4 ? +"connect4" : +"connect6" );if (CHECK (!prog,"find_prog" ,"connect prog not found\n" )) { err = -EIO ; goto close_bpf_object;
@@ -83,9 +83,9 @@ static int run_test(int cgroup_fd, int server_fd, int family, int type) goto close_bpf_object; } - prog =bpf_object__find_program_by_title (obj, v4 ? -"cgroup/getpeername4" : -"cgroup/getpeername6" ); + prog =bpf_object__find_program_by_name (obj, v4 ? +"getpeername4" : +"getpeername6" );if (CHECK (!prog,"find_prog" ,"getpeername prog not found\n" )) { err = -EIO ; goto close_bpf_object;
@@ -99,9 +99,9 @@ static int run_test(int cgroup_fd, int server_fd, int family, int type) goto close_bpf_object; } - prog =bpf_object__find_program_by_title (obj, v4 ? -"cgroup/getsockname4" : -"cgroup/getsockname6" ); + prog =bpf_object__find_program_by_name (obj, v4 ? +"getsockname4" : +"getsockname6" );if (CHECK (!prog,"find_prog" ,"getsockname prog not found\n" )) { err = -EIO ; goto close_bpf_object;
tools/testing/selftests/bpf/prog_tests/core_reloc.c +53 -26
211 lines not on this page · raw message
tools/testing/selftests/bpf/prog_tests/fexit_bpf2bpf.c +13 -4
@@ -101,6 +101,8 @@ static void test_fexit_bpf2bpf_common(const char *obj_file,for (i =0 ; i < prog_cnt; i++) {struct bpf_link_info link_info; +struct bpf_program *pos; +const char *pos_sec_name;char *tgt_name;__s32 btf_id;
@@ -109,7 +111,14 @@ static void test_fexit_bpf2bpf_common(const char *obj_file, goto close_prog; btf_id =btf__find_by_name_kind (btf, tgt_name +1 ,BTF_KIND_FUNC ); - prog[i] =bpf_object__find_program_by_title (obj, prog_name[i]); + prog[i] =NULL ; +bpf_object__for_each_program (pos, obj) { + pos_sec_name =bpf_program__section_name (pos); +if ( pos_sec_name && !strcmp (pos_sec_name, prog_name[i])) { + prog[i] = pos; +break ; + } + }if (!ASSERT_OK_PTR (prog[i], prog_name[i])) goto close_prog;
@@ -211,8 +220,8 @@ static void test_func_replace_verify(void)static int test_second_attach (struct bpf_object *obj) { -const char *prog_name ="freplace/get_constant" ; -const char *tgt_name = prog_name +9 ;/* cut off freplace/ */ +const char *prog_name ="security_new_get_constant" ; +const char *tgt_name ="get_constant" ;const char *tgt_obj_file ="./test_pkt_access.o" ;struct bpf_program *prog =NULL ;struct bpf_object *tgt_obj;
@@ -220,7 +229,7 @@ static int test_second_attach(struct bpf_object *obj)struct bpf_link *link;int err =0 , tgt_fd; - prog =bpf_object__find_program_by_title (obj, prog_name); + prog =bpf_object__find_program_by_name (obj, prog_name);if (CHECK (!prog,"find_prog" ,"prog %s not found\n" , prog_name))return -ENOENT ;
tools/testing/selftests/bpf/prog_tests/get_stack_raw_tp.c +2 -2
@@ -89,7 +89,7 @@ void test_get_stack_raw_tp(void) {const char *file ="./test_get_stack_rawtp.o" ;const char *file_err ="./test_get_stack_rawtp_err.o" ; -const char *prog_name ="raw_tracepoint/sys_enter" ; +const char *prog_name ="bpf_prog1" ;int i, err, prog_fd, exp_cnt =MAX_CNT_RAWTP ;struct perf_buffer *pb =NULL ;struct bpf_link *link =NULL ;
@@ -107,7 +107,7 @@ void test_get_stack_raw_tp(void)if (CHECK (err,"prog_load raw tp" ,"err %d errno %d\n" , err, errno))return ; - prog =bpf_object__find_program_by_title (obj, prog_name); + prog =bpf_object__find_program_by_name (obj, prog_name);if (CHECK (!prog,"find_probe" ,"prog '%s' not found\n" , prog_name)) goto close_prog;
tools/testing/selftests/bpf/prog_tests/sockopt_inherit.c +8 -7
@@ -136,7 +136,8 @@ static int start_server(void)return fd; } -static int prog_attach (struct bpf_object *obj,int cgroup_fd,const char *title) +static int prog_attach (struct bpf_object *obj,int cgroup_fd,const char *title, +const char *prog_name) {enum bpf_attach_type attach_type;enum bpf_prog_type prog_type;
@@ -145,20 +146,20 @@ static int prog_attach(struct bpf_object *obj, int cgroup_fd, const char *title) err =libbpf_prog_type_by_name (title, &prog_type, &attach_type);if (err) { -log_err ("Failed to deduct types for %s BPF program" , title); +log_err ("Failed to deduct types for %s BPF program" , prog_name);return -1 ; } - prog =bpf_object__find_program_by_title (obj, title); + prog =bpf_object__find_program_by_name (obj, prog_name);if (!prog) { -log_err ("Failed to find %s BPF program" , title); +log_err ("Failed to find %s BPF program" , prog_name);return -1 ; } err =bpf_prog_attach (bpf_program__fd (prog), cgroup_fd, attach_type,0 );if (err) { -log_err ("Failed to attach %s BPF program" , title); +log_err ("Failed to attach %s BPF program" , prog_name);return -1 ; }
@@ -181,11 +182,11 @@ static void run_test(int cgroup_fd)if (!ASSERT_OK (err,"obj_load" )) goto close_bpf_object; - err =prog_attach (obj, cgroup_fd,"cgroup/getsockopt" ); + err =prog_attach (obj, cgroup_fd,"cgroup/getsockopt" ,"_getsockopt" );if (CHECK_FAIL (err)) goto close_bpf_object; - err =prog_attach (obj, cgroup_fd,"cgroup/setsockopt" ); + err =prog_attach (obj, cgroup_fd,"cgroup/setsockopt" ,"_setsockopt" );if (CHECK_FAIL (err)) goto close_bpf_object;
tools/testing/selftests/bpf/prog_tests/stacktrace_map.c +2 -2
@@ -4,7 +4,7 @@void test_stacktrace_map (void ) {int control_map_fd, stackid_hmap_fd, stackmap_fd, stack_amap_fd; -const char *prog_name ="tracepoint/sched/sched_switch" ; +const char *prog_name ="oncpu" ;int err, prog_fd, stack_trace_len;const char *file ="./test_stacktrace_map.o" ;__u32 key, val, duration =0 ;
@@ -16,7 +16,7 @@ void test_stacktrace_map(void)if (CHECK (err,"prog_load" ,"err %d errno %d\n" , err, errno))return ; - prog =bpf_object__find_program_by_title (obj, prog_name); + prog =bpf_object__find_program_by_name (obj, prog_name);if (CHECK (!prog,"find_prog" ,"prog '%s' not found\n" , prog_name)) goto close_prog;
tools/testing/selftests/bpf/prog_tests/stacktrace_map_raw_tp.c +2 -2
@@ -3,7 +3,7 @@void test_stacktrace_map_raw_tp (void ) { -const char *prog_name ="tracepoint/sched/sched_switch" ; +const char *prog_name ="oncpu" ;int control_map_fd, stackid_hmap_fd, stackmap_fd;const char *file ="./test_stacktrace_map.o" ;__u32 key, val, duration =0 ;
@@ -16,7 +16,7 @@ void test_stacktrace_map_raw_tp(void)if (CHECK (err,"prog_load raw tp" ,"err %d errno %d\n" , err, errno))return ; - prog =bpf_object__find_program_by_title (obj, prog_name); + prog =bpf_object__find_program_by_name (obj, prog_name);if (CHECK (!prog,"find_prog" ,"prog '%s' not found\n" , prog_name)) goto close_prog;
tools/testing/selftests/bpf/prog_tests/test_overhead.c +10 -10
@@ -56,11 +56,11 @@ static void setaffinity(void)void test_test_overhead (void ) { -const char *kprobe_name ="kprobe/__set_task_comm" ; -const char *kretprobe_name ="kretprobe/__set_task_comm" ; -const char *raw_tp_name ="raw_tp/task_rename" ; -const char *fentry_name ="fentry/__set_task_comm" ; -const char *fexit_name ="fexit/__set_task_comm" ; +const char *kprobe_name ="prog1" ; +const char *kretprobe_name ="prog2" ; +const char *raw_tp_name ="prog3" ; +const char *fentry_name ="prog4" ; +const char *fexit_name ="prog5" ;const char *kprobe_func ="__set_task_comm" ;struct bpf_program *kprobe_prog, *kretprobe_prog, *raw_tp_prog;struct bpf_program *fentry_prog, *fexit_prog;
@@ -76,23 +76,23 @@ void test_test_overhead(void)if (!ASSERT_OK_PTR (obj,"obj_open_file" ))return ; - kprobe_prog =bpf_object__find_program_by_title (obj, kprobe_name); + kprobe_prog =bpf_object__find_program_by_name (obj, kprobe_name);if (CHECK (!kprobe_prog,"find_probe" ,"prog '%s' not found\n" , kprobe_name)) goto cleanup; - kretprobe_prog =bpf_object__find_program_by_title (obj, kretprobe_name); + kretprobe_prog =bpf_object__find_program_by_name (obj, kretprobe_name);if (CHECK (!kretprobe_prog,"find_probe" ,"prog '%s' not found\n" , kretprobe_name)) goto cleanup; - raw_tp_prog =bpf_object__find_program_by_title (obj, raw_tp_name); + raw_tp_prog =bpf_object__find_program_by_name (obj, raw_tp_name);if (CHECK (!raw_tp_prog,"find_probe" ,"prog '%s' not found\n" , raw_tp_name)) goto cleanup; - fentry_prog =bpf_object__find_program_by_title (obj, fentry_name); + fentry_prog =bpf_object__find_program_by_name (obj, fentry_name);if (CHECK (!fentry_prog,"find_probe" ,"prog '%s' not found\n" , fentry_name)) goto cleanup; - fexit_prog =bpf_object__find_program_by_title (obj, fexit_name); + fexit_prog =bpf_object__find_program_by_name (obj, fexit_name);if (CHECK (!fexit_prog,"find_probe" ,"prog '%s' not found\n" , fexit_name)) goto cleanup;
tools/testing/selftests/bpf/prog_tests/trampoline_count.c +3 -3
@@ -35,7 +35,7 @@ static struct bpf_link *load(struct bpf_object *obj, const char *name)struct bpf_program *prog;int duration =0 ; - prog =bpf_object__find_program_by_title (obj, name); + prog =bpf_object__find_program_by_name (obj, name);if (CHECK (!prog,"find_probe" ,"prog '%s' not found\n" , name))return ERR_PTR (-EINVAL );return bpf_program__attach_trace (prog);
@@ -44,8 +44,8 @@ static struct bpf_link *load(struct bpf_object *obj, const char *name)/* TODO: use different target function to run in concurrent mode */ void serial_test_trampoline_count (void ) { -const char *fentry_name ="fentry/__set_task_comm" ; -const char *fexit_name ="fexit/__set_task_comm" ; +const char *fentry_name ="prog1" ; +const char *fexit_name ="prog2" ;const char *object ="test_trampoline_count.o" ;struct inst inst[MAX_TRAMP_PROGS ] = {};int err, i =0 , duration =0 ;
Signature · 1 line
2.30.2
PATCH v3 2/4 samples/bpf: Stop using bpf_object__find_program_by_title API.
In reply to Kui-Feng Leebpf_object__find_program_by_title is going to be deprecated. Replace use cases of bpf_object__find_program_by_title in samples/bpf/ with bpf_object__for_each_program.
--- samples/bpf/hbm.c | 11 ++++++++++- samples/bpf/xdp_fwd_user.c | 12 ++++++++++-- 2 files changed, 20 insertions(+), 3 deletions(-)
samples/bpf/hbm.c +10 -1
@@ -120,6 +120,9 @@ static void do_error(char *msg, bool errno_flag)static int prog_load (char *prog) { +struct bpf_program *pos; +const char *sec_name; + obj =bpf_object__open_file (prog,NULL );if (libbpf_get_error (obj)) {printf ("ERROR: opening BPF object file failed\n" );
@@ -132,7 +135,13 @@ static int prog_load(char *prog) goto err; } - bpf_prog =bpf_object__find_program_by_title (obj,"cgroup_skb/egress" ); +bpf_object__for_each_program (pos, obj) { + sec_name =bpf_program__section_name (pos); +if (sec_name && !strcmp (sec_name,"cgroup_skb/egress" )) { + bpf_prog = pos; +break ; + } + }if (!bpf_prog) {printf ("ERROR: finding a prog in obj file failed\n" ); goto err;
samples/bpf/xdp_fwd_user.c +10 -2
@@ -79,7 +79,9 @@ int main(int argc, char **argv) .prog_type = BPF_PROG_TYPE_XDP, };const char *prog_name ="xdp_fwd" ; -struct bpf_program *prog; +struct bpf_program *prog =NULL ; +struct bpf_program *pos; +const char *sec_name;int prog_fd, map_fd =-1 ;char filename[PATH_MAX ];struct bpf_object *obj;
@@ -134,7 +136,13 @@ int main(int argc, char **argv)return 1 ; } - prog =bpf_object__find_program_by_title (obj, prog_name); +bpf_object__for_each_program (pos, obj) { + sec_name =bpf_program__section_name (pos); +if (sec_name && !strcmp (sec_name, prog_name)) { + prog = pos; +break ; + } + } prog_fd =bpf_program__fd (prog);if (prog_fd <0 ) {printf ("program not found: %s\n" ,strerror (prog_fd));
Signature · 1 line
2.30.2
PATCH v3 3/4 tools/perf: Stop using bpf_object__find_program_by_title API.
In reply to Kui-Feng Leebpf_obj__find_program_by_title() in libbpf is going to be deprecated. Call bpf_object_for_each_program to find a program in the section with a given name instead.
--- tools/perf/builtin-trace.c | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-)
tools/perf/builtin-trace.c +12 -1
@@ -3253,10 +3253,21 @@ static void trace__set_bpf_map_syscalls(struct trace *trace)static struct bpf_program *trace__find_bpf_program_by_title (struct trace *trace,const char *name) { +struct bpf_program *pos, *prog =NULL ; +const char *sec_name; +if (trace->bpf_obj ==NULL )return NULL ; -return bpf_object__find_program_by_title (trace->bpf_obj, name); +bpf_object__for_each_program (pos, trace->bpf_obj) { + sec_name =bpf_program__section_name (pos); +if (sec_name && !strcmp (sec_name, name)) { + prog = pos; +break ; + } + } + +return prog; } static struct bpf_program *trace__find_syscall_bpf_prog(struct trace *trace, struct syscall *sc,
Signature · 1 line
2.30.2
PATCH v3 4/4 libbpf: Mark bpf_object__find_program_by_title API deprecated.
In reply to Kui-Feng LeeDeprecate this API since v0.7. All callers should move to bpf_object__find_program_by_name if possible, otherwise use bpf_object__for_each_program to find a program out from a given section.
[0] Closes: https://github.com/libbpf/libbpf/issues/292
--- tools/lib/bpf/libbpf.h | 1 + 1 file changed, 1 insertion(+)
tools/lib/bpf/libbpf.h +1 -0
@@ -187,6 +187,7 @@ struct btf; LIBBPF_API struct btf *bpf_object__btf(const struct bpf_object *obj); LIBBPF_API int bpf_object__btf_fd(const struct bpf_object *obj); +LIBBPF_DEPRECATED_SINCE(0, 7, "use bpf_object__find_program_by_name() instead") LIBBPF_API struct bpf_program *bpf_object__find_program_by_title (const struct bpf_object *obj,const char *title);
Signature · 1 line
2.30.2