libbpf: Add bpf_map__set_name()
PATCH 1/1 libbpf: Add bpf_map__set_name()
From: Joe Burton <[email protected]>
Add the capability to set a struct bpf_map name.
bpf_map__reuse_fd(struct bpf_map *map, int fd) does the following:
1. get the bpf_map_info of the passed-in fd
2. strdup the name from the bpf_map_info
3. assign that name to the map
4. and some other stuff
While map.name may initially be arbitrarily long, this operation truncates it after 15 characters.
We have some infrastructure that uses bpf_map__reuse_fd() to preserve maps across upgrades. Some of our users have long map names, and are seeing their maps 'disappear' after an upgrade, due to the name truncation.
By invoking bpf_map__set_name() after bpf_map__reuse_fd(), we can trivially work around the issue.
--- tools/lib/bpf/libbpf.c | 22 ++++++++++++++++++++++ tools/lib/bpf/libbpf.h | 3 ++- 2 files changed, 24 insertions(+), 1 deletion(-)
tools/lib/bpf/libbpf.c +22 -0
@@ -9089,6 +9089,28 @@ const char *bpf_map__name(const struct bpf_map *map)return map->name; } +int bpf_map__set_name (struct bpf_map *map,const char *name) +{ +char *new_name; + +if (!map) +return libbpf_err (-EINVAL ); + + new_name =strdup (name); +if (!new_name) +return libbpf_err (-ENOMEM ); + +if (map_uses_real_name (map)) { +free (map->real_name); + map->real_name = new_name; + }else { +free (map->name); + map->name = new_name; + } + +return 0 ; +} +enum bpf_map_type bpf_map__type (const struct bpf_map *map) {return map->def.type;
tools/lib/bpf/libbpf.h +2 -1
@@ -731,8 +731,9 @@ LIBBPF_API bool bpf_map__autocreate(const struct bpf_map *map);*/ LIBBPF_API int bpf_map__fd(const struct bpf_map *map); LIBBPF_API int bpf_map__reuse_fd(struct bpf_map *map, int fd); -/* get map name */ +/* get/set map name */ LIBBPF_API const char *bpf_map__name(const struct bpf_map *map); +LIBBPF_API int bpf_map__set_name(struct bpf_map *map, const char *name);/* get/set map type */ LIBBPF_API enum bpf_map_type bpf_map__type(const struct bpf_map *map); LIBBPF_API int bpf_map__set_type(struct bpf_map *map, enum bpf_map_type type);
Signature · 1 line
2.37.0.144.g8ac04bfd2-goog
Quoted 15 lines · Joe Burton
From: Joe Burton <[email protected]>
Add the capability to set a
struct bpf_mapname.
bpf_map__reuse_fd(struct bpf_map *map, int fd)does the following:1. get the
bpf_map_infoof the passed-in fd
2. strdup the name from thebpf_map_info
3. assign that name to the map
4. and some other stuffWhile
map.namemay initially be arbitrarily long, this operation truncates it after 15 characters.
Quoted 7 lines
We have some infrastructure that uses
bpf_map__reuse_fd()to preserve maps across upgrades. Some of our users have long map names, and are seeing their maps 'disappear' after an upgrade, due to the name truncation.By invoking
bpf_map__set_name()afterbpf_map__reuse_fd(), we can trivially work around the issue.
Asked you internally, but not sure I follow. Can you share more on why the following won't fix it for us:
?
The idea seems to be to get the supplied map name (from the obj) instead of using pin name? So why is it not enough?
Quoted 57 lines
Signed-off-by Joe Burton <[email protected]>--- tools/lib/bpf/libbpf.c | 22 ++++++++++++++++++++++ tools/lib/bpf/libbpf.h | 3 ++- 2 files changed, 24 insertions(+), 1 deletion(-)tools/lib/bpf/libbpf.c +22
-0@@ -9089,6 +9089,28 @@ const char *bpf_map__name(const struct bpf_map *map)return map->name; } +int bpf_map__set_name (struct bpf_map *map,const char *name) +{ +char *new_name; + +if (!map) +return libbpf_err (-EINVAL ); + + new_name =strdup (name); +if (!new_name) +return libbpf_err (-ENOMEM ); + +if (map_uses_real_name (map)) { +free (map->real_name); + map->real_name = new_name; + }else { +free (map->name); + map->name = new_name; + } + +return 0 ; +} +enum bpf_map_type bpf_map__type (const struct bpf_map *map) {return map->def.type;tools/lib/bpf/libbpf.h +2
-2@@ -731,8 +731,9 @@ LIBBPF_API bool bpf_map__autocreate(const struct bpf_map *map);*/ LIBBPF_API int bpf_map__fd(const struct bpf_map *map); LIBBPF_API int bpf_map__reuse_fd(struct bpf_map *map, int fd); -/* get map name */ +/* get/set map name */ LIBBPF_API const char *bpf_map__name(const struct bpf_map *map); +LIBBPF_API int bpf_map__set_name(struct bpf_map *map, const char *name);/* get/set map type */ LIBBPF_API enum bpf_map_type bpf_map__type(const struct bpf_map *map); LIBBPF_API int bpf_map__set_type(struct bpf_map *map, enum bpf_map_type type); --2.37.0.144.g8ac04bfd2-goog
Quoted 9 lines
Asked you internally, but not sure I follow. Can you share more on why the following won't fix it for us:
?
The idea seems to be to get the supplied map name (from the obj) instead of using pin name? So why is it not enough?
You're correct, this approach also resolves the issue. No need for this new API.
Quoted 6 lines · Joe Burton
Quoted 6 lines
Asked you internally, but not sure I follow. Can you share more on why the following won't fix it for us:
Quoted 7 lines
Quoted 4 lines
?
The idea seems to be to get the supplied map name (from the obj) instead of using pin name? So why is it not enough?
You're correct, this approach also resolves the issue. No need for this new API.
SG! New helper might still be useful, but I'm not sure how safe that is, given how much we use the name internally in libbpf (name/pin_path). So it might be safer to use Anquan's approach for now.
Andrii, any concerns with [1] ? Should we pull that in?
Quoted 16 lines · Stanislav Fomichev
Quoted 6 lines · Joe Burton
Quoted 6 lines
Asked you internally, but not sure I follow. Can you share more on why the following won't fix it for us:
Quoted 7 lines
Quoted 4 lines
?
The idea seems to be to get the supplied map name (from the obj) instead of using pin name? So why is it not enough?
You're correct, this approach also resolves the issue. No need for this new API.
Quoted 6 lines
SG! New helper might still be useful, but I'm not sure how safe that is, given how much we use the name internally in libbpf (name/pin_path). So it might be safer to use Anquan's approach for now.
Andrii, any concerns with [1] ? Should we pull that in?
I already applied [1]. I'm uncomfortable with bpf_map__set_name() in general, because map name is tied into BTF and other things, so it needs much more careful thinking how to support sudden map renames. But given the problem was with bpf_map__reuse_fd(), I think [1] solves it already.