bpf: add a new bpf argument type ARG_CONST_MAP_PTR_OR_NULL
Subsystems (4)
PATCH 1/1 bpf: add a new bpf argument type ARG_CONST_MAP_PTR_OR_NULL
Add a new bpf argument type ARG_CONST_MAP_PTR_OR_NULL which could be used when we want to allow NULL pointer for map parameter. The bpf helper need to take care and check if the map is NULL when use this type.
--- include/linux/bpf.h | 1 + kernel/bpf/verifier.c | 11 ++++++++--- 2 files changed, 9 insertions(+), 3 deletions(-)
include/linux/bpf.h +1 -0
@@ -253,6 +253,7 @@ enum bpf_arg_type {ARG_PTR_TO_ALLOC_MEM ,/* pointer to dynamically allocated memory */ ARG_PTR_TO_ALLOC_MEM_OR_NULL ,/* pointer to dynamically allocated memory or NULL */ ARG_CONST_ALLOC_SIZE_OR_ZERO ,/* number of allocated bytes requested */ + ARG_CONST_MAP_PTR_OR_NULL, /* const argument used as pointer to bpf_map or NULL */ };/* type of values returned from helper functions */
kernel/bpf/verifier.c +8 -3
@@ -3849,9 +3849,13 @@ static int check_func_arg(struct bpf_verifier_env *env, u32 arg, expected_type =SCALAR_VALUE ;if (type != expected_type) goto err_type; - }else if (arg_type ==ARG_CONST_MAP_PTR ) { + }else if (arg_type ==ARG_CONST_MAP_PTR || + arg_type ==ARG_CONST_MAP_PTR_OR_NULL ) { expected_type =CONST_PTR_TO_MAP ; -if (type != expected_type) +if (register_is_null (reg) && + arg_type ==ARG_CONST_MAP_PTR_OR_NULL ) +/* final test in check_stack_boundary() */ ; +else if (type != expected_type) goto err_type; }else if (arg_type ==ARG_PTR_TO_CTX || arg_type ==ARG_PTR_TO_CTX_OR_NULL ) {
@@ -3957,7 +3961,8 @@ static int check_func_arg(struct bpf_verifier_env *env, u32 arg,return -EFAULT ; } -if (arg_type ==ARG_CONST_MAP_PTR ) { +if (arg_type ==ARG_CONST_MAP_PTR || + (arg_type ==ARG_CONST_MAP_PTR_OR_NULL && !register_is_null (reg))) {/* bpf_map_xxx(map_ptr) call: remember that map_ptr */ meta->map_ptr = reg->map_ptr; }else if (arg_type ==ARG_PTR_TO_MAP_KEY ) {
Signature · 1 line
2.25.4
Daniel Borkmann
maintainerQuoted 5 lines · Hangbin Liu
Add a new bpf argument type
ARG_CONST_MAP_PTR_OR_NULLwhich could be used when we want to allow NULL pointer for map parameter. The bpf helper need to take care and check if the map is NULL when use this type.Signed-off-by Hangbin Liu <[email protected]>
Is this patch to be merged into the set in [0] for passing NULL ex_map as discussed? Seems you sent out two incomplete sets?
[0] https://lore.kernel.org/bpf/[email protected]/T/#m99a8fa8ffe79d5f00d305c0800ad3abe619294f2
Quoted 38 lines
--- include/linux/bpf.h | 1 + kernel/bpf/verifier.c | 11 ++++++++--- 2 files changed, 9 insertions(+), 3 deletions(-)include/linux/bpf.h +1
-0@@ -253,6 +253,7 @@ enum bpf_arg_type {ARG_PTR_TO_ALLOC_MEM ,/* pointer to dynamically allocated memory */ ARG_PTR_TO_ALLOC_MEM_OR_NULL ,/* pointer to dynamically allocated memory or NULL */ ARG_CONST_ALLOC_SIZE_OR_ZERO ,/* number of allocated bytes requested */ + ARG_CONST_MAP_PTR_OR_NULL, /* const argument used as pointer to bpf_map or NULL */ };/* type of values returned from helper functions */ kernel/bpf/verifier.c +6
-2@@ -3849,9 +3849,13 @@ static int check_func_arg(struct bpf_verifier_env *env, u32 arg, expected_type =SCALAR_VALUE ;if (type != expected_type) goto err_type; - }else if (arg_type ==ARG_CONST_MAP_PTR ) { + }else if (arg_type ==ARG_CONST_MAP_PTR || + arg_type ==ARG_CONST_MAP_PTR_OR_NULL ) { expected_type =CONST_PTR_TO_MAP ; -if (type != expected_type) +if (register_is_null (reg) && + arg_type ==ARG_CONST_MAP_PTR_OR_NULL ) +/* final test in check_stack_boundary() */ ; +else if (type != expected_type) goto err_type; }else if (arg_type ==ARG_PTR_TO_CTX || arg_type ==ARG_PTR_TO_CTX_OR_NULL ) {
kernel/bpf/verifier.c static int check_func_arg(struct bpf_verifier_env *env, u32 arg, · line 3967
Quoted 8 lines
kernel/bpf/verifier.c +2
-1@@ -3957,7 +3961,8 @@ static int check_func_arg(struct bpf_verifier_env *env, u32 arg,return -EFAULT ; } -if (arg_type ==ARG_CONST_MAP_PTR ) { +if (arg_type ==ARG_CONST_MAP_PTR || + (arg_type ==ARG_CONST_MAP_PTR_OR_NULL && !register_is_null (reg))) {/* bpf_map_xxx(map_ptr) call: remember that map_ptr */ meta->map_ptr = reg->map_ptr;
I would probably have the semantics a bit different in the sense that I would update meta->map_ptr to the last ARG_CONST_MAP_PTR, meaning:
meta->map_ptr = register_is_null(reg) ? NULL : reg->map_ptr;
kernel/bpf/verifier.c static int check_func_arg(struct bpf_verifier_env *env, u32 arg, · line 3968
Quoted 2 lines
kernel/bpf/verifier.c +0
-0}else if (arg_type ==ARG_PTR_TO_MAP_KEY ) {
In combination with the set, this also needs test_verifier selftests in order to exercise BPF insn snippets for the good & [expected] bad case.
Thanks,
Daniel
Quoted 11 lines · Daniel Borkmann
Quoted 5 lines · Hangbin Liu
Add a new bpf argument type
ARG_CONST_MAP_PTR_OR_NULLwhich could be used when we want to allow NULL pointer for map parameter. The bpf helper need to take care and check if the map is NULL when use this type.Signed-off-by Hangbin Liu <[email protected]>Is this patch to be merged into the set in [0] for passing NULL
ex_mapas discussed? Seems you sent out two incomplete sets?[0] https://lore.kernel.org/bpf/[email protected]/T/#m99a8fa8ffe79d5f00d305c0800ad3abe619294f2
Yes, I did it by intend. I thought these two should be consider as different feature. So I'd prefer post them separately. Once both patches are merged, I will post a followup patch to add the NULL pointer support to xdp multicast helper.
Quoted 49 lines
Quoted 38 lines
--- include/linux/bpf.h | 1 + kernel/bpf/verifier.c | 11 ++++++++--- 2 files changed, 9 insertions(+), 3 deletions(-)include/linux/bpf.h +1
-0@@ -253,6 +253,7 @@ enum bpf_arg_type {ARG_PTR_TO_ALLOC_MEM ,/* pointer to dynamically allocated memory */ ARG_PTR_TO_ALLOC_MEM_OR_NULL ,/* pointer to dynamically allocated memory or NULL */ ARG_CONST_ALLOC_SIZE_OR_ZERO ,/* number of allocated bytes requested */ + ARG_CONST_MAP_PTR_OR_NULL, /* const argument used as pointer to bpf_map or NULL */ };/* type of values returned from helper functions */ kernel/bpf/verifier.c +6
-2@@ -3849,9 +3849,13 @@ static int check_func_arg(struct bpf_verifier_env *env, u32 arg, expected_type =SCALAR_VALUE ;if (type != expected_type) goto err_type; - }else if (arg_type ==ARG_CONST_MAP_PTR ) { + }else if (arg_type ==ARG_CONST_MAP_PTR || + arg_type ==ARG_CONST_MAP_PTR_OR_NULL ) { expected_type =CONST_PTR_TO_MAP ; -if (type != expected_type) +if (register_is_null (reg) && + arg_type ==ARG_CONST_MAP_PTR_OR_NULL ) +/* final test in check_stack_boundary() */ ; +else if (type != expected_type) goto err_type; }else if (arg_type ==ARG_PTR_TO_CTX || arg_type ==ARG_PTR_TO_CTX_OR_NULL ) {kernel/bpf/verifier.c static int check_func_arg(struct bpf_verifier_env *env, u32 arg, · line 3966
Quoted 7 lines
kernel/bpf/verifier.c +2
-1@@ -3957,7 +3961,8 @@ static int check_func_arg(struct bpf_verifier_env *env, u32 arg,return -EFAULT ; } -if (arg_type ==ARG_CONST_MAP_PTR ) { +if (arg_type ==ARG_CONST_MAP_PTR || + (arg_type ==ARG_CONST_MAP_PTR_OR_NULL && !register_is_null (reg))) {/* bpf_map_xxx(map_ptr) call: remember that map_ptr */ meta->map_ptr = reg->map_ptr;I would probably have the semantics a bit different in the sense that I would update
meta->map_ptrto the lastARG_CONST_MAP_PTR, meaning:
Quoted 1 line
meta->map_ptr = register_is_null(reg) ? NULL : reg->map_ptr;
Thanks for the suggestion. I will update it.
Quoted 6 lines
kernel/bpf/verifier.c static int check_func_arg(struct bpf_verifier_env *env, u32 arg, · line 3968
Quoted 3 lines
kernel/bpf/verifier.c +0
-0}else if (arg_type ==ARG_PTR_TO_MAP_KEY ) {In combination with the set, this also needs
test_verifierselftests in order to exercise BPF insn snippets for the good & [expected] bad case.
OK, I will add a test for this.
Thanks
Hangbin
Quoted 4 lines · Daniel Borkmann
Quoted 4 lines
include/linux/bpf.h +0
-0
Quoted 8 lines
include/linux/bpf.h enum bpf_arg_type { · line 257
Quoted 6 lines
include/linux/bpf.h +1
-0@@ -253,6 +253,7 @@ enum bpf_arg_type {ARG_PTR_TO_ALLOC_MEM ,/* pointer to dynamically allocated memory */ ARG_PTR_TO_ALLOC_MEM_OR_NULL ,/* pointer to dynamically allocated memory or NULL */ ARG_CONST_ALLOC_SIZE_OR_ZERO ,/* number of allocated bytes requested */ + ARG_CONST_MAP_PTR_OR_NULL, /* const argument used as pointer to bpf_map or NULL */ };In combination with the set, this also needs
test_verifierselftests in order to exercise BPF insn snippets for the good & [expected] bad case.
Hi Daniel,
I just come up with a question, how should I test it without no bpf helper using it? Should I wait until the XDP multicast patch set merged?
Thanks
Hangbin
Quoted 14 lines · Hangbin Liu
Quoted 4 lines · Daniel Borkmann
Quoted 4 lines
include/linux/bpf.h +0
-0Quoted 8 lines
include/linux/bpf.h enum bpf_arg_type { · line 257
Quoted 6 lines
include/linux/bpf.h +1
-0@@ -253,6 +253,7 @@ enum bpf_arg_type {ARG_PTR_TO_ALLOC_MEM ,/* pointer to dynamically allocated memory */ ARG_PTR_TO_ALLOC_MEM_OR_NULL ,/* pointer to dynamically allocated memory or NULL */ ARG_CONST_ALLOC_SIZE_OR_ZERO ,/* number of allocated bytes requested */ + ARG_CONST_MAP_PTR_OR_NULL, /* const argument used as pointer to bpf_map or NULL */ };In combination with the set, this also needs
test_verifierselftests in order to exercise BPF insn snippets for the good & [expected] bad case.
Quoted 4 lines
Hi Daniel,
I just come up with a question, how should I test it without no bpf helper using it? Should I wait until the XDP multicast patch set merged?
ping?