libbpf: Deprecate bpf_object__unload() API since v0.7
PATCH v2 1/1 libbpf: Deprecate bpf_object__unload() API since v0.7
BPF objects are not re-loadable after unload. User are expected to use bpf_object__close() to unload and free up resources in one operation. No need to expose bpf_object__unload() as a public API, deprecate it.[0] Add bpf_object_unload() as an alias to bpf_object__unload() and replace all bpf_object__unload() to avoid compilation errors.
[0] Closes: https://github.com/libbpf/libbpf/issues/290
--- tools/lib/bpf/libbpf.c | 7 +++++-- tools/lib/bpf/libbpf.h | 1 + 2 files changed, 6 insertions(+), 2 deletions(-)
tools/lib/bpf/libbpf.c +5 -2
@@ -6679,6 +6679,9 @@ int bpf_object__unload(struct bpf_object *obj)return 0 ; } +__attribute__((alias ("bpf_object__unload" ))) +static int bpf_object_unload (struct bpf_object *obj); +static int bpf_object__sanitize_maps (struct bpf_object *obj) {struct bpf_map *m;
@@ -7055,7 +7058,7 @@ int bpf_object__load_xattr(struct bpf_object_load_attr *attr)if (obj->maps[i].pinned && !obj->maps[i].reused)bpf_map__unpin (&obj->maps[i],NULL ); -bpf_object__unload (obj); +bpf_object_unload (obj);pr_warn ("failed to load object '%s'\n" , obj->path);return libbpf_err (err); }
@@ -7664,7 +7667,7 @@ void bpf_object__close(struct bpf_object *obj)bpf_gen__free (obj->gen_loader);bpf_object__elf_finish (obj); -bpf_object__unload (obj); +bpf_object_unload (obj);btf__free (obj->btf);btf_ext__free (obj->btf_ext);
tools/lib/bpf/libbpf.h +1 -0
@@ -150,6 +150,7 @@ struct bpf_object_load_attr {/* Load/unload object into/from kernel */ LIBBPF_API int bpf_object__load(struct bpf_object *obj); LIBBPF_API int bpf_object__load_xattr(struct bpf_object_load_attr *attr); +LIBBPF_DEPRECATED_SINCE(0, 7, "bpf_object__unload() is deprecated, use bpf_object__close() instead") LIBBPF_API int bpf_object__unload(struct bpf_object *obj); LIBBPF_API const char *bpf_object__name(const struct bpf_object *obj);
--
2.25.1
Quoted 10 lines · Hengqi Chen
BPF objects are not re-loadable after unload. User are expected to use
bpf_object__close()to unload and free up resources in one operation. No need to exposebpf_object__unload()as a public API, deprecate it.[0] Addbpf_object_unload()as an alias tobpf_object__unload()and replace allbpf_object__unload()to avoid compilation errors.[0] Closes: https://github.com/libbpf/libbpf/issues/290
Signed-off-by Hengqi Chen <[email protected]>
Andrii Nakryiko
AppliedQuoted 9 lines · Song Liu
Quoted 7 lines · Hengqi Chen
BPF objects are not re-loadable after unload. User are expected to use
bpf_object__close()to unload and free up resources in one operation. No need to exposebpf_object__unload()as a public API, deprecate it.[0] Addbpf_object_unload()as an alias tobpf_object__unload()and replace allbpf_object__unload()to avoid compilation errors.
Quoted 5 lines
Quoted 3 lines
[0] Closes: https://github.com/libbpf/libbpf/issues/290
Signed-off-by Hengqi Chen <[email protected]>Acked-by Song Liu <[email protected]>
Applied to bpf-next, thanks. I've done few changes, though:
1. started deprecation from the current development version (0.6), there is no point in delaying this as the recommended replacement API (bpf_object__close()) has been available forever.
2. it didn't make sense to me to have bpf_object_unload as an alias to bpf_object__unload, I switched it around, bpf_object__unload is an alias of internal bpf_object_unload. It will also make further deletion of bpf_object__unload() simpler in the future.
Please let me know if you have any reservations about this.