2019-12-14 09:43:29 +08:00
|
|
|
/* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Common user-facing libbpf helpers.
|
|
|
|
|
*
|
|
|
|
|
* Copyright (c) 2019 Facebook
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef __LIBBPF_LIBBPF_COMMON_H
|
|
|
|
|
#define __LIBBPF_LIBBPF_COMMON_H
|
|
|
|
|
|
2019-12-17 19:28:10 +08:00
|
|
|
#include <string.h>
|
libbpf: Add LIBBPF_DEPRECATED_SINCE macro for scheduling API deprecations
Introduce a macro LIBBPF_DEPRECATED_SINCE(major, minor, message) to prepare
the deprecation of two API functions. This macro marks functions as deprecated
when libbpf's version reaches the values passed as an argument.
As part of this change libbpf_version.h header is added with recorded major
(LIBBPF_MAJOR_VERSION) and minor (LIBBPF_MINOR_VERSION) libbpf version macros.
They are now part of libbpf public API and can be relied upon by user code.
libbpf_version.h is installed system-wide along other libbpf public headers.
Due to this new build-time auto-generated header, in-kernel applications
relying on libbpf (resolve_btfids, bpftool, bpf_preload) are updated to
include libbpf's output directory as part of a list of include search paths.
Better fix would be to use libbpf's make_install target to install public API
headers, but that clean up is left out as a future improvement. The build
changes were tested by building kernel (with KBUILD_OUTPUT and O= specified
explicitly), bpftool, libbpf, selftests/bpf, and resolve_btfids builds. No
problems were detected.
Note that because of the constraints of the C preprocessor we have to write
a few lines of macro magic for each version used to prepare deprecation (0.6
for now).
Also, use LIBBPF_DEPRECATED_SINCE() to schedule deprecation of
btf__get_from_id() and btf__load(), which are replaced by
btf__load_from_kernel_by_id() and btf__load_into_kernel(), respectively,
starting from future libbpf v0.6. This is part of libbpf 1.0 effort ([0]).
[0] Closes: https://github.com/libbpf/libbpf/issues/278
Co-developed-by: Quentin Monnet <quentin@isovalent.com>
Co-developed-by: Andrii Nakryiko <andrii@kernel.org>
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20210908213226.1871016-1-andrii@kernel.org
2021-09-09 05:32:26 +08:00
|
|
|
#include "libbpf_version.h"
|
2019-12-17 19:28:10 +08:00
|
|
|
|
2019-12-14 09:43:29 +08:00
|
|
|
#ifndef LIBBPF_API
|
|
|
|
|
#define LIBBPF_API __attribute__((visibility("default")))
|
|
|
|
|
#endif
|
|
|
|
|
|
2020-09-04 04:35:33 +08:00
|
|
|
#define LIBBPF_DEPRECATED(msg) __attribute__((deprecated(msg)))
|
|
|
|
|
|
libbpf: Add LIBBPF_DEPRECATED_SINCE macro for scheduling API deprecations
Introduce a macro LIBBPF_DEPRECATED_SINCE(major, minor, message) to prepare
the deprecation of two API functions. This macro marks functions as deprecated
when libbpf's version reaches the values passed as an argument.
As part of this change libbpf_version.h header is added with recorded major
(LIBBPF_MAJOR_VERSION) and minor (LIBBPF_MINOR_VERSION) libbpf version macros.
They are now part of libbpf public API and can be relied upon by user code.
libbpf_version.h is installed system-wide along other libbpf public headers.
Due to this new build-time auto-generated header, in-kernel applications
relying on libbpf (resolve_btfids, bpftool, bpf_preload) are updated to
include libbpf's output directory as part of a list of include search paths.
Better fix would be to use libbpf's make_install target to install public API
headers, but that clean up is left out as a future improvement. The build
changes were tested by building kernel (with KBUILD_OUTPUT and O= specified
explicitly), bpftool, libbpf, selftests/bpf, and resolve_btfids builds. No
problems were detected.
Note that because of the constraints of the C preprocessor we have to write
a few lines of macro magic for each version used to prepare deprecation (0.6
for now).
Also, use LIBBPF_DEPRECATED_SINCE() to schedule deprecation of
btf__get_from_id() and btf__load(), which are replaced by
btf__load_from_kernel_by_id() and btf__load_into_kernel(), respectively,
starting from future libbpf v0.6. This is part of libbpf 1.0 effort ([0]).
[0] Closes: https://github.com/libbpf/libbpf/issues/278
Co-developed-by: Quentin Monnet <quentin@isovalent.com>
Co-developed-by: Andrii Nakryiko <andrii@kernel.org>
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20210908213226.1871016-1-andrii@kernel.org
2021-09-09 05:32:26 +08:00
|
|
|
/* Mark a symbol as deprecated when libbpf version is >= {major}.{minor} */
|
|
|
|
|
#define LIBBPF_DEPRECATED_SINCE(major, minor, msg) \
|
|
|
|
|
__LIBBPF_MARK_DEPRECATED_ ## major ## _ ## minor \
|
|
|
|
|
(LIBBPF_DEPRECATED("libbpf v" # major "." # minor "+: " msg))
|
|
|
|
|
|
|
|
|
|
#define __LIBBPF_CURRENT_VERSION_GEQ(major, minor) \
|
|
|
|
|
(LIBBPF_MAJOR_VERSION > (major) || \
|
|
|
|
|
(LIBBPF_MAJOR_VERSION == (major) && LIBBPF_MINOR_VERSION >= (minor)))
|
|
|
|
|
|
|
|
|
|
/* Add checks for other versions below when planning deprecation of API symbols
|
|
|
|
|
* with the LIBBPF_DEPRECATED_SINCE macro.
|
|
|
|
|
*/
|
2022-06-28 05:15:22 +08:00
|
|
|
#if __LIBBPF_CURRENT_VERSION_GEQ(1, 0)
|
|
|
|
|
#define __LIBBPF_MARK_DEPRECATED_1_0(X) X
|
libbpf: Add LIBBPF_DEPRECATED_SINCE macro for scheduling API deprecations
Introduce a macro LIBBPF_DEPRECATED_SINCE(major, minor, message) to prepare
the deprecation of two API functions. This macro marks functions as deprecated
when libbpf's version reaches the values passed as an argument.
As part of this change libbpf_version.h header is added with recorded major
(LIBBPF_MAJOR_VERSION) and minor (LIBBPF_MINOR_VERSION) libbpf version macros.
They are now part of libbpf public API and can be relied upon by user code.
libbpf_version.h is installed system-wide along other libbpf public headers.
Due to this new build-time auto-generated header, in-kernel applications
relying on libbpf (resolve_btfids, bpftool, bpf_preload) are updated to
include libbpf's output directory as part of a list of include search paths.
Better fix would be to use libbpf's make_install target to install public API
headers, but that clean up is left out as a future improvement. The build
changes were tested by building kernel (with KBUILD_OUTPUT and O= specified
explicitly), bpftool, libbpf, selftests/bpf, and resolve_btfids builds. No
problems were detected.
Note that because of the constraints of the C preprocessor we have to write
a few lines of macro magic for each version used to prepare deprecation (0.6
for now).
Also, use LIBBPF_DEPRECATED_SINCE() to schedule deprecation of
btf__get_from_id() and btf__load(), which are replaced by
btf__load_from_kernel_by_id() and btf__load_into_kernel(), respectively,
starting from future libbpf v0.6. This is part of libbpf 1.0 effort ([0]).
[0] Closes: https://github.com/libbpf/libbpf/issues/278
Co-developed-by: Quentin Monnet <quentin@isovalent.com>
Co-developed-by: Andrii Nakryiko <andrii@kernel.org>
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20210908213226.1871016-1-andrii@kernel.org
2021-09-09 05:32:26 +08:00
|
|
|
#else
|
2022-06-28 05:15:22 +08:00
|
|
|
#define __LIBBPF_MARK_DEPRECATED_1_0(X)
|
2021-12-02 07:28:24 +08:00
|
|
|
#endif
|
libbpf: Add LIBBPF_DEPRECATED_SINCE macro for scheduling API deprecations
Introduce a macro LIBBPF_DEPRECATED_SINCE(major, minor, message) to prepare
the deprecation of two API functions. This macro marks functions as deprecated
when libbpf's version reaches the values passed as an argument.
As part of this change libbpf_version.h header is added with recorded major
(LIBBPF_MAJOR_VERSION) and minor (LIBBPF_MINOR_VERSION) libbpf version macros.
They are now part of libbpf public API and can be relied upon by user code.
libbpf_version.h is installed system-wide along other libbpf public headers.
Due to this new build-time auto-generated header, in-kernel applications
relying on libbpf (resolve_btfids, bpftool, bpf_preload) are updated to
include libbpf's output directory as part of a list of include search paths.
Better fix would be to use libbpf's make_install target to install public API
headers, but that clean up is left out as a future improvement. The build
changes were tested by building kernel (with KBUILD_OUTPUT and O= specified
explicitly), bpftool, libbpf, selftests/bpf, and resolve_btfids builds. No
problems were detected.
Note that because of the constraints of the C preprocessor we have to write
a few lines of macro magic for each version used to prepare deprecation (0.6
for now).
Also, use LIBBPF_DEPRECATED_SINCE() to schedule deprecation of
btf__get_from_id() and btf__load(), which are replaced by
btf__load_from_kernel_by_id() and btf__load_into_kernel(), respectively,
starting from future libbpf v0.6. This is part of libbpf 1.0 effort ([0]).
[0] Closes: https://github.com/libbpf/libbpf/issues/278
Co-developed-by: Quentin Monnet <quentin@isovalent.com>
Co-developed-by: Andrii Nakryiko <andrii@kernel.org>
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20210908213226.1871016-1-andrii@kernel.org
2021-09-09 05:32:26 +08:00
|
|
|
|
libbpf: Unify low-level BPF_PROG_LOAD APIs into bpf_prog_load()
Add a new unified OPTS-based low-level API for program loading,
bpf_prog_load() ([0]). bpf_prog_load() accepts few "mandatory"
parameters as input arguments (program type, name, license,
instructions) and all the other optional (as in not required to specify
for all types of BPF programs) fields into struct bpf_prog_load_opts.
This makes all the other non-extensible APIs variant for BPF_PROG_LOAD
obsolete and they are slated for deprecation in libbpf v0.7:
- bpf_load_program();
- bpf_load_program_xattr();
- bpf_verify_program().
Implementation-wise, internal helper libbpf__bpf_prog_load is refactored
to become a public bpf_prog_load() API. struct bpf_prog_load_params used
internally is replaced by public struct bpf_prog_load_opts.
Unfortunately, while conceptually all this is pretty straightforward,
the biggest complication comes from the already existing bpf_prog_load()
*high-level* API, which has nothing to do with BPF_PROG_LOAD command.
We try really hard to have a new API named bpf_prog_load(), though,
because it maps naturally to BPF_PROG_LOAD command.
For that, we rename old bpf_prog_load() into bpf_prog_load_deprecated()
and mark it as COMPAT_VERSION() for shared library users compiled
against old version of libbpf. Statically linked users and shared lib
users compiled against new version of libbpf headers will get "rerouted"
to bpf_prog_deprecated() through a macro helper that decides whether to
use new or old bpf_prog_load() based on number of input arguments (see
___libbpf_overload in libbpf_common.h).
To test that existing
bpf_prog_load()-using code compiles and works as expected, I've compiled
and ran selftests as is. I had to remove (locally) selftest/bpf/Makefile
-Dbpf_prog_load=bpf_prog_test_load hack because it was conflicting with
the macro-based overload approach. I don't expect anyone else to do
something like this in practice, though. This is testing-specific way to
replace bpf_prog_load() calls with special testing variant of it, which
adds extra prog_flags value. After testing I kept this selftests hack,
but ensured that we use a new bpf_prog_load_deprecated name for this.
This patch also marks bpf_prog_load() and bpf_prog_load_xattr() as deprecated.
bpf_object interface has to be used for working with struct bpf_program.
Libbpf doesn't support loading just a bpf_program.
The silver lining is that when we get to libbpf 1.0 all these
complication will be gone and we'll have one clean bpf_prog_load()
low-level API with no backwards compatibility hackery surrounding it.
[0] Closes: https://github.com/libbpf/libbpf/issues/284
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
Link: https://lore.kernel.org/bpf/20211103220845.2676888-4-andrii@kernel.org
2021-11-04 06:08:36 +08:00
|
|
|
/* This set of internal macros allows to do "function overloading" based on
|
|
|
|
|
* number of arguments provided by used in backwards-compatible way during the
|
|
|
|
|
* transition to libbpf 1.0
|
|
|
|
|
* It's ugly but necessary evil that will be cleaned up when we get to 1.0.
|
|
|
|
|
* See bpf_prog_load() overload for example.
|
|
|
|
|
*/
|
|
|
|
|
#define ___libbpf_cat(A, B) A ## B
|
|
|
|
|
#define ___libbpf_select(NAME, NUM) ___libbpf_cat(NAME, NUM)
|
|
|
|
|
#define ___libbpf_nth(_1, _2, _3, _4, _5, _6, N, ...) N
|
|
|
|
|
#define ___libbpf_cnt(...) ___libbpf_nth(__VA_ARGS__, 6, 5, 4, 3, 2, 1)
|
|
|
|
|
#define ___libbpf_overload(NAME, ...) ___libbpf_select(NAME, ___libbpf_cnt(__VA_ARGS__))(__VA_ARGS__)
|
|
|
|
|
|
2019-12-14 09:43:29 +08:00
|
|
|
/* Helper macro to declare and initialize libbpf options struct
|
|
|
|
|
*
|
|
|
|
|
* This dance with uninitialized declaration, followed by memset to zero,
|
|
|
|
|
* followed by assignment using compound literal syntax is done to preserve
|
|
|
|
|
* ability to use a nice struct field initialization syntax and **hopefully**
|
|
|
|
|
* have all the padding bytes initialized to zero. It's not guaranteed though,
|
|
|
|
|
* when copying literal, that compiler won't copy garbage in literal's padding
|
|
|
|
|
* bytes, but that's the best way I've found and it seems to work in practice.
|
|
|
|
|
*
|
|
|
|
|
* Macro declares opts struct of given type and name, zero-initializes,
|
|
|
|
|
* including any extra padding, it with memset() and then assigns initial
|
|
|
|
|
* values provided by users in struct initializer-syntax as varargs.
|
|
|
|
|
*/
|
2021-11-04 06:08:34 +08:00
|
|
|
#define LIBBPF_OPTS(TYPE, NAME, ...) \
|
2019-12-14 09:43:29 +08:00
|
|
|
struct TYPE NAME = ({ \
|
|
|
|
|
memset(&NAME, 0, sizeof(struct TYPE)); \
|
|
|
|
|
(struct TYPE) { \
|
|
|
|
|
.sz = sizeof(struct TYPE), \
|
|
|
|
|
__VA_ARGS__ \
|
|
|
|
|
}; \
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
#endif /* __LIBBPF_LIBBPF_COMMON_H */
|