libbpf: fail early when loading programs with unspecified type
cover libbpf: fail early when loading programs with unspecified type
This patch should help people who misunderstand the importance of using proper prefixes to their ELF sections in bpf object files. The patch assumes that programs with type BPF_PROG_TYPE_UNSPEC are always invalid, as indicated by man 2 bpf. Please let me know if that is not accurate.
Andrei Matei (1):
libbpf: fail early when loading programs with unspecified type
tools/lib/bpf/libbpf.c | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-)
Signature · 1 line
2.27.0
PATCH 1/1 libbpf: fail early when loading programs with unspecified type
Before this patch, a program with unspecified type (BPF_PROG_TYPE_UNSPEC) would be passed to the BPF syscall, only to have the kernel reject it with an opaque invalid argument error. This patch makes libbpf reject such programs with a nicer error message - in particular libbpf now tries to diagnose bad ELF section names at both open time and load time.
--- tools/lib/bpf/libbpf.c | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-)
tools/lib/bpf/libbpf.c +15 -1
@@ -6629,6 +6629,18 @@ load_program(struct bpf_program *prog, struct bpf_insn *insns, int insns_cnt,char *log_buf =NULL ;int btf_fd, ret; +if (prog->type ==BPF_PROG_TYPE_UNSPEC ) { +if (!prog->sec_def) { +// We couldn't find a proper section definition at load time; that's probably why +// the program type is missing. +pr_warn ("prog '%s': missing BPF prog type'; check ELF section name '%s'\n" , + prog->name, prog->sec_name); + }else { +pr_warn ("prog '%s': missing BPF prog type\n" , prog->name); + } +return -EINVAL ; + } +if (!insns || !insns_cnt)return -EINVAL ;
@@ -6920,9 +6932,11 @@ __bpf_object__open(const char *path, const void *obj_buf, size_t obj_buf_sz,bpf_object__for_each_program (prog, obj) { prog->sec_def =find_sec_def (prog->sec_name); -if (!prog->sec_def) +if (!prog->sec_def) {/* couldn't guess, but user might manually specify */ +pr_debug ("prog '%s': unrecognized ELF section name '%s'\n" , prog->name, prog->sec_name);continue ; + }if (prog->sec_def->is_sleepable) prog->prog_flags |=BPF_F_SLEEPABLE ;
Signature · 1 line
2.27.0
Quoted 10 lines · Andrei Matei
Before this patch, a program with unspecified type (
BPF_PROG_TYPE_UNSPEC) would be passed to the BPF syscall, only to have the kernel reject it with an opaque invalid argument error. This patch makes libbpf reject such programs with a nicer error message - in particular libbpf now tries to diagnose bad ELF section names at both open time and load time.Signed-off-by Andrei Matei <[email protected]>---
This is useful, thanks. See below for a few comments, though.
Quoted 8 lines
tools/lib/bpf/libbpf.c | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-)tools/lib/bpf/libbpf.c +0
-0
tools/lib/bpf/libbpf.c load_program(struct bpf_program *prog, struct bpf_insn *insns, int insns_cnt, · line 6635
Quoted 7 lines
tools/lib/bpf/libbpf.c +4
-0@@ -6629,6 +6629,18 @@ load_program(struct bpf_program *prog, struct bpf_insn *insns, int insns_cnt,char *log_buf =NULL ;int btf_fd, ret; +if (prog->type ==BPF_PROG_TYPE_UNSPEC ) { +if (!prog->sec_def) { +// We couldn't find a proper section definition at load time; that's probably why +// the program type is missing.
no C++-style comments, please
tools/lib/bpf/libbpf.c load_program(struct bpf_program *prog, struct bpf_insn *insns, int insns_cnt, · line 6636
Quoted 1 line
tools/lib/bpf/libbpf.c +1
-0+ pr_warn("prog '%s': missing BPF prog type'; check ELF section name '%s'\n",
extra ' after "prog type"? also ';' -> ',' ?
tools/lib/bpf/libbpf.c load_program(struct bpf_program *prog, struct bpf_insn *insns, int insns_cnt, · line 6639
Quoted 3 lines
tools/lib/bpf/libbpf.c +3
-0+ prog->name, prog->sec_name); + }else { +pr_warn ("prog '%s': missing BPF prog type\n" , prog->name);
while, technically, user can manually set program type to UNSPEC even with good section name, that's probably extreme case which we shouldn't worry about. So I'd just always emit the section name.
Quoted 23 lines
tools/lib/bpf/libbpf.c +7
-2+ } +return -EINVAL ; + } +if (!insns || !insns_cnt)return -EINVAL ;@@ -6920,9 +6932,11 @@ __bpf_object__open(const char *path, const void *obj_buf, size_t obj_buf_sz,bpf_object__for_each_program (prog, obj) { prog->sec_def =find_sec_def (prog->sec_name); -if (!prog->sec_def) +if (!prog->sec_def) {/* couldn't guess, but user might manually specify */ +pr_debug ("prog '%s': unrecognized ELF section name '%s'\n" , prog->name, prog->sec_name);continue ; + }if (prog->sec_def->is_sleepable) prog->prog_flags |=BPF_F_SLEEPABLE ; --2.27.0
Quoted 6 lines · Andrei Matei
This patch should help people who misunderstand the importance of using proper prefixes to their ELF sections in bpf object files. The patch assumes that programs with type
BPF_PROG_TYPE_UNSPECare always invalid, as indicated byman 2 bpf. Please let me know if that is not accurate.
FYI, you don't need to send a cover letter with a single patch.
Quoted 9 lines
Andrei Matei (1):
libbpf: fail early when loading programs with unspecified typetools/lib/bpf/libbpf.c | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-)--
2.27.0