tools: bpftool: support creating outer maps
Subsystems (4)
v3 cover tools: bpftool: support creating outer maps
This series makes bpftool able to create outer maps (maps of types array-of-maps and hash-of-maps). This is done by passing the relevant inner_map_fd, which we do through a new command-line keyword.
The first two patches also clean up the function related to dumping map elements.
v3:
- Add a check on errno being ENOENT before skipping outer map entry in dumps.
v2:
- v1 was wrongly expected to allow bpftool to dump the content of outer maps (already supported). v2 skipped that patch, and instead replaced it with a clean-up for the dump_map_elem() function.
Quentin Monnet (3):
tools: bpftool: clean up function to dump map entry
tools: bpftool: keep errors for map-of-map dumps if distinct from
ENOENT
tools: bpftool: add "inner_map" to "bpftool map create" outer maps
.../bpf/bpftool/Documentation/bpftool-map.rst | 10 +- tools/bpf/bpftool/bash-completion/bpftool | 22 ++- tools/bpf/bpftool/map.c | 149 ++++++++++-------- 3 files changed, 114 insertions(+), 67 deletions(-)
Signature · 1 line
2.25.1
PATCH v3 1/3 tools: bpftool: clean up function to dump map entry
The function used to dump a map entry in bpftool is a bit difficult to follow, as a consequence to earlier refactorings. There is a variable ("num_elems") which does not appear to be necessary, and the error handling would look cleaner if moved to its own function. Let's clean it up. No functional change.
v2:
- v1 was erroneously removing the check on fd maps in an attempt to get support for outer map dumps. This is already working. Instead, v2 focuses on cleaning up the dump_map_elem() function, to avoid similar confusion in the future.
--- tools/bpf/bpftool/map.c | 101 +++++++++++++++++++++------------------- 1 file changed, 52 insertions(+), 49 deletions(-)
tools/bpf/bpftool/map.c +52 -49
@@ -213,8 +213,9 @@ static void print_entry_json(struct bpf_map_info *info, unsigned char *key,jsonw_end_object (json_wtr); } -static void print_entry_error (struct bpf_map_info *info,unsigned char *key, -const char *error_msg) +static void +print_entry_error_msg (struct bpf_map_info *info,unsigned char *key, +const char *error_msg) {int msg_size =strlen (error_msg);bool single_line, break_names;
@@ -232,6 +233,40 @@ static void print_entry_error(struct bpf_map_info *info, unsigned char *key,printf ("\n" ); } +static void +print_entry_error (struct bpf_map_info *map_info,void *key,int lookup_errno) +{ +/* For prog_array maps or arrays of maps, failure to lookup the value +* means there is no entry for that key. Do not print an error message +* in that case. +*/ +if (map_is_map_of_maps (map_info->type) || +map_is_map_of_progs (map_info->type)) +return ; + +if (json_output) { +jsonw_start_object (json_wtr);/* entry */ +jsonw_name (json_wtr,"key" ); +print_hex_data_json (key, map_info->key_size); +jsonw_name (json_wtr,"value" ); +jsonw_start_object (json_wtr);/* error */ +jsonw_string_field (json_wtr,"error" ,strerror (lookup_errno)); +jsonw_end_object (json_wtr);/* error */ +jsonw_end_object (json_wtr);/* entry */ + }else { +const char *msg =NULL ; + +if (lookup_errno ==ENOENT ) + msg ="<no entry>" ; +else if (lookup_errno ==ENOSPC && + map_info->type ==BPF_MAP_TYPE_REUSEPORT_SOCKARRAY ) + msg ="<cannot read>" ; + +print_entry_error_msg (map_info, key, + msg ? :strerror (lookup_errno)); + } +} +static void print_entry_plain (struct bpf_map_info *info,unsigned char *key,unsigned char *value) {
@@ -713,56 +748,23 @@ static int dump_map_elem(int fd, void *key, void *value, struct bpf_map_info *map_info, struct btf *btf, json_writer_t *btf_wtr) { - int num_elems = 0; -int lookup_errno; - -if (!bpf_map_lookup_elem (fd, key, value)) { -if (json_output) { -print_entry_json (map_info, key, value, btf); - }else { -if (btf) { -struct btf_dumper d = { - .btf = btf, - .jw = btf_wtr, - .is_plain_text = true, - }; - -do_dump_btf (&d, map_info, key, value); - }else { -print_entry_plain (map_info, key, value); - } - num_elems++; - } -return num_elems; + if (bpf_map_lookup_elem(fd, key, value)) { +print_entry_error (map_info ,key ,errno ); +return -1 ; } -/* lookup error handling */ - lookup_errno = errno; - -if (map_is_map_of_maps (map_info->type) || -map_is_map_of_progs (map_info->type)) -return 0 ; -if (json_output) { -jsonw_start_object (json_wtr); -jsonw_name (json_wtr,"key" ); -print_hex_data_json (key, map_info->key_size); -jsonw_name (json_wtr,"value" ); -jsonw_start_object (json_wtr); -jsonw_string_field (json_wtr,"error" ,strerror (lookup_errno)); -jsonw_end_object (json_wtr); -jsonw_end_object (json_wtr); - }else { -const char *msg =NULL ; - -if (lookup_errno ==ENOENT ) - msg ="<no entry>" ; -else if (lookup_errno ==ENOSPC && - map_info->type ==BPF_MAP_TYPE_REUSEPORT_SOCKARRAY ) - msg ="<cannot read>" ; +print_entry_json (map_info, key, value, btf); + }else if (btf) { +struct btf_dumper d = { + .btf = btf, + .jw = btf_wtr, + .is_plain_text = true, + }; -print_entry_error (map_info, key, - msg ? :strerror (lookup_errno)); +do_dump_btf (&d, map_info, key, value); + }else { +print_entry_plain (map_info, key, value); }return 0 ;
@@ -873,7 +875,8 @@ map_dump(int fd, struct bpf_map_info *info, json_writer_t *wtr, err =0 ;break ; } - num_elems +=dump_map_elem (fd, key, value, info, btf, wtr); +if (!dump_map_elem (fd, key, value, info, btf, wtr)) + num_elems++; prev_key = key; }
Signature · 1 line
2.25.1
Re: [PATCH bpf-next v3 1/3] tools: bpftool: clean up function to dump map entry
Quoted 37 lines · Quentin Monnet
The function used to dump a map entry in bpftool is a bit difficult to follow, as a consequence to earlier refactorings. There is a variable ("
num_elems") which does not appear to be necessary, and the error handling would look cleaner if moved to its own function. Let's clean it up. No functional change.v2:
- v1 was erroneously removing the check on fd maps in an attempt to get support for outer map dumps. This is already working. Instead, v2 focuses on cleaning up thedump_map_elem()function, to avoid similar confusion in the future.Signed-off-by Quentin Monnet <[email protected]>--- tools/bpf/bpftool/map.c | 101 +++++++++++++++++++++------------------- 1 file changed, 52 insertions(+), 49 deletions(-)tools/bpf/bpftool/map.c +3
-2@@ -213,8 +213,9 @@ static void print_entry_json(struct bpf_map_info *info, unsigned char *key,jsonw_end_object (json_wtr); } -static void print_entry_error (struct bpf_map_info *info,unsigned char *key, -const char *error_msg) +static void +print_entry_error_msg (struct bpf_map_info *info,unsigned char *key, +const char *error_msg) {int msg_size =strlen (error_msg);bool single_line, break_names;@@ -232,6 +233,40 @@ static void print_entry_error(struct bpf_map_info *info, unsigned char *key,printf ("\n" ); }
tools/bpf/bpftool/map.c static void print_entry_error(struct bpf_map_info *info, unsigned char *key, · line 244
Quoted 10 lines
tools/bpf/bpftool/map.c +9
-0+static void +print_entry_error (struct bpf_map_info *map_info,void *key,int lookup_errno) +{ +/* For prog_array maps or arrays of maps, failure to lookup the value +* means there is no entry for that key. Do not print an error message +* in that case. +*/ +if (map_is_map_of_maps (map_info->type) || +map_is_map_of_progs (map_info->type))
&& lookup_errno == ENOENT
?
Quoted 2 lines
tools/bpf/bpftool/map.c +2
-0+return ; +
[...]
Andrii Nakryiko
Acked-byRe: [PATCH bpf-next v3 1/3] tools: bpftool: clean up function to dump map entry
Quoted 52 lines · Andrii Nakryiko
Quoted 37 lines · Quentin Monnet
The function used to dump a map entry in bpftool is a bit difficult to follow, as a consequence to earlier refactorings. There is a variable ("
num_elems") which does not appear to be necessary, and the error handling would look cleaner if moved to its own function. Let's clean it up. No functional change.v2:
- v1 was erroneously removing the check on fd maps in an attempt to get support for outer map dumps. This is already working. Instead, v2 focuses on cleaning up thedump_map_elem()function, to avoid similar confusion in the future.Signed-off-by Quentin Monnet <[email protected]>--- tools/bpf/bpftool/map.c | 101 +++++++++++++++++++++------------------- 1 file changed, 52 insertions(+), 49 deletions(-)tools/bpf/bpftool/map.c +3
-2@@ -213,8 +213,9 @@ static void print_entry_json(struct bpf_map_info *info, unsigned char *key,jsonw_end_object (json_wtr); } -static void print_entry_error (struct bpf_map_info *info,unsigned char *key, -const char *error_msg) +static void +print_entry_error_msg (struct bpf_map_info *info,unsigned char *key, +const char *error_msg) {int msg_size =strlen (error_msg);bool single_line, break_names;@@ -232,6 +233,40 @@ static void print_entry_error(struct bpf_map_info *info, unsigned char *key,printf ("\n" ); }tools/bpf/bpftool/map.c static void print_entry_error(struct bpf_map_info *info, unsigned char *key, · line 244
Quoted 10 lines
tools/bpf/bpftool/map.c +9
-0+static void +print_entry_error (struct bpf_map_info *map_info,void *key,int lookup_errno) +{ +/* For prog_array maps or arrays of maps, failure to lookup the value +* means there is no entry for that key. Do not print an error message +* in that case. +*/ +if (map_is_map_of_maps (map_info->type) || +map_is_map_of_progs (map_info->type))&&
lookup_errno== ENOENT
Quoted 1 line
?
Never mind, you did it in a separate patch.
Quoted 6 lines
Quoted 4 lines
tools/bpf/bpftool/map.c +2
-0+return ; +[...]
PATCH v3 2/3 tools: bpftool: keep errors for map-of-map dumps if distinct from ENOENT
In reply to Quentin MonnetWhen dumping outer maps or prog_array maps, and on lookup failure, bpftool simply skips the entry with no error message. This is because the kernel returns non-zero when no value is found for the provided key, which frequently happen for those maps if they have not been filled.
When such a case occurs, errno is set to ENOENT. It seems unlikely we could receive other error codes at this stage (we successfully retrieved map info just before), but to be on the safe side, let's skip the entry only if errno was ENOENT, and not for the other errors.
v3: New patch
--- tools/bpf/bpftool/map.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
tools/bpf/bpftool/map.c +2 -2
@@ -240,8 +240,8 @@ print_entry_error(struct bpf_map_info *map_info, void *key, int lookup_errno)* means there is no entry for that key. Do not print an error message * in that case. */ -if (map_is_map_of_maps (map_info->type) || -map_is_map_of_progs (map_info->type)) +if ((map_is_map_of_maps (map_info->type) || +map_is_map_of_progs (map_info->type)) && lookup_errno ==ENOENT )return ;if (json_output) {
Signature · 1 line
2.25.1
Re: [PATCH bpf-next v3 2/3] tools: bpftool: keep errors for map-of-map dumps if distinct from ENOENT
Quoted 23 lines · Quentin Monnet
When dumping outer maps or
prog_arraymaps, and on lookup failure, bpftool simply skips the entry with no error message. This is because the kernel returns non-zero when no value is found for the provided key, which frequently happen for those maps if they have not been filled.When such a case occurs, errno is set to ENOENT. It seems unlikely we could receive other error codes at this stage (we successfully retrieved map info just before), but to be on the safe side, let's skip the entry only if errno was ENOENT, and not for the other errors.
v3: New patch
Signed-off-by Quentin Monnet <[email protected]>--- tools/bpf/bpftool/map.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)tools/bpf/bpftool/map.c +0
-0
tools/bpf/bpftool/map.c print_entry_error(struct bpf_map_info *map_info, void *key, int lookup_errno) · line 245
Quoted 8 lines
tools/bpf/bpftool/map.c +2
-2@@ -240,8 +240,8 @@ print_entry_error(struct bpf_map_info *map_info, void *key, int lookup_errno)* means there is no entry for that key. Do not print an error message * in that case. */ -if (map_is_map_of_maps (map_info->type) || -map_is_map_of_progs (map_info->type)) +if ((map_is_map_of_maps (map_info->type) || +map_is_map_of_progs (map_info->type)) && lookup_errno ==ENOENT )return ;
Ah, ok, you decided to split it out into a separate patch. Ok.
Quoted 5 lines
tools/bpf/bpftool/map.c +0
-1if (json_output) { --2.25.1
Re: [PATCH bpf-next v3 2/3] tools: bpftool: keep errors for map-of-map dumps if distinct from ENOENT
Quoted 19 lines · Andrii Nakryiko
Quoted 18 lines · Quentin Monnet
When dumping outer maps or
prog_arraymaps, and on lookup failure, bpftool simply skips the entry with no error message. This is because the kernel returns non-zero when no value is found for the provided key, which frequently happen for those maps if they have not been filled.When such a case occurs, errno is set to ENOENT. It seems unlikely we could receive other error codes at this stage (we successfully retrieved map info just before), but to be on the safe side, let's skip the entry only if errno was ENOENT, and not for the other errors.
v3: New patch
Signed-off-by Quentin Monnet <[email protected]>--- tools/bpf/bpftool/map.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Quoted 16 lines
tools/bpf/bpftool/map.c print_entry_error(struct bpf_map_info *map_info, void *key, int lookup_errno) · line 245
Quoted 13 lines
tools/bpf/bpftool/map.c +2
-2@@ -240,8 +240,8 @@ print_entry_error(struct bpf_map_info *map_info, void *key, int lookup_errno)* means there is no entry for that key. Do not print an error message * in that case. */ -if (map_is_map_of_maps (map_info->type) || -map_is_map_of_progs (map_info->type)) +if ((map_is_map_of_maps (map_info->type) || +map_is_map_of_progs (map_info->type)) && lookup_errno ==ENOENT )return ;Ah, ok, you decided to split it out into a separate patch. Ok.
Yes, I chose to keep the first one with no functional change to keep the logs cleaner.
Quoted 1 line
Acked-by Andrii Nakryiko <[email protected]>
Thanks!
Quentin
PATCH v3 3/3 tools: bpftool: add "inner_map" to "bpftool map create" outer maps
In reply to Quentin MonnetThere is no support for creating maps of types array-of-map or hash-of-map in bpftool. This is because the kernel needs an inner_map_fd to collect metadata on the inner maps to be supported by the new map, but bpftool does not provide a way to pass this file descriptor.
Add a new optional "inner_map" keyword that can be used to pass a reference to a map, retrieve a fd to that map, and pass it as the inner_map_fd.
Add related documentation and bash completion. Note that we can reference the inner map by its name, meaning we can have several times the keyword "name" with different meanings (mandatory outer map name, and possibly a name to use to find the inner_map_fd). The bash completion will offer it just once, and will not suggest "name" on the following command:
# bpftool map create /sys/fs/bpf/my_outer_map type hash_of_maps \
inner_map name my_inner_map [TAB]Fixing that specific case seems too convoluted. Completion will work as expected, however, if the outer map name comes first and the "inner_map name ..." is passed second.
--- .../bpf/bpftool/Documentation/bpftool-map.rst | 10 +++- tools/bpf/bpftool/bash-completion/bpftool | 22 ++++++++- tools/bpf/bpftool/map.c | 48 +++++++++++++------ 3 files changed, 62 insertions(+), 18 deletions(-)
tools/bpf/bpftool/Documentation/bpftool-map.rst +8 -2
@@ -23,7 +23,8 @@ MAP COMMANDS | **bpftool** **map** { **show** | **list** } [*MAP*] | **bpftool** **map create** *FILE* **type** *TYPE* **key** *KEY_SIZE* **value** *VALUE_SIZE* \ -| **entries** *MAX_ENTRIES* **name** *NAME* [**flags** *FLAGS*] [**dev** *NAME*] +| **entries** *MAX_ENTRIES* **name** *NAME* [**flags** *FLAGS*] [**inner_map** *MAP*] \ +| [**dev** *NAME*] | **bpftool** **map dump** *MAP* | **bpftool** **map update** *MAP* [**key** *DATA*] [**value** *VALUE*] [*UPDATE_FLAGS*] | **bpftool** **map lookup** *MAP* [**key** *DATA*]
@@ -67,7 +68,7 @@ DESCRIPTION maps. On such kernels bpftool will automatically emit this information as well. - **bpftool map create** *FILE* **type** *TYPE* **key** *KEY_SIZE* **value** *VALUE_SIZE* **entries** *MAX_ENTRIES* **name** *NAME* [**flags** *FLAGS*] [**dev** *NAME*] + **bpftool map create** *FILE* **type** *TYPE* **key** *KEY_SIZE* **value** *VALUE_SIZE* **entries** *MAX_ENTRIES* **name** *NAME* [**flags** *FLAGS*] [**inner_map** *MAP*] [**dev** *NAME*] Create a new map with given parameters and pin it to *bpffs* as *FILE*.
@@ -75,6 +76,11 @@ DESCRIPTION desired flags, e.g. 1024 for **BPF_F_MMAPABLE** (see bpf.h UAPI header for existing flags). + To create maps of type array-of-maps or hash-of-maps, the + **inner_map** keyword must be used to pass an inner map. The + kernel needs it to collect metadata related to the inner maps + that the new map will work with. + Keyword **dev** expects a network interface name, and is used to request hardware offload for the map.
tools/bpf/bpftool/bash-completion/bpftool +21 -1
@@ -709,9 +709,26 @@ _bpftool() "$cur" ) ) return 0 ;; - key|value|flags|name|entries) + key|value|flags|entries) return 0 ;; + inner_map) + COMPREPLY=( $( compgen -W "$MAP_TYPE" -- "$cur" ) ) + return 0 + ;; + id) + _bpftool_get_map_ids + ;; + name) + case $pprev in + inner_map) + _bpftool_get_map_names + ;; + *) + return 0 + ;; + esac + ;; *) _bpftool_once_attr 'type' _bpftool_once_attr 'key'
@@ -719,6 +736,9 @@ _bpftool() _bpftool_once_attr 'entries' _bpftool_once_attr 'name' _bpftool_once_attr 'flags' + if _bpftool_search_list 'array_of_maps' 'hash_of_maps'; then + _bpftool_once_attr 'inner_map' + fi _bpftool_once_attr 'dev' return 0 ;;
tools/bpf/bpftool/map.c +33 -15
120 lines not on this page · raw message
Signature · 1 line
2.25.1
Alexei Starovoitov
AppliedQuoted 11 lines · Quentin Monnet
This series makes bpftool able to create outer maps (maps of types array-of-maps and hash-of-maps). This is done by passing the relevant
inner_map_fd, which we do through a new command-line keyword.The first two patches also clean up the function related to dumping map elements.
v3:
- Add a check on errno being ENOENT before skipping outer map entry in dumps.
Applied. Thanks