mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-10-01 06:33:07 +00:00
93b8952d22
Enact deprecation of legacy BPF map definition in SEC("maps") ([0]). For
the definitions themselves introduce LIBBPF_STRICT_MAP_DEFINITIONS flag
for libbpf strict mode. If it is set, error out on any struct
bpf_map_def-based map definition. If not set, libbpf will print out
a warning for each legacy BPF map to raise awareness that it goes away.
For any use of BPF_ANNOTATE_KV_PAIR() macro providing a legacy way to
associate BTF key/value type information with legacy BPF map definition,
warn through libbpf's pr_warn() error message (but don't fail BPF object
open).
BPF-side struct bpf_map_def is marked as deprecated. User-space struct
bpf_map_def has to be used internally in libbpf, so it is left
untouched. It should be enough for bpf_map__def() to be marked
deprecated to raise awareness that it goes away.
bpftool is an interesting case that utilizes libbpf to open BPF ELF
object to generate skeleton. As such, even though bpftool itself uses
full on strict libbpf mode (LIBBPF_STRICT_ALL), it has to relax it a bit
for BPF map definition handling to minimize unnecessary disruptions. So
opt-out of LIBBPF_STRICT_MAP_DEFINITIONS for bpftool. User's code that
will later use generated skeleton will make its own decision whether to
enforce LIBBPF_STRICT_MAP_DEFINITIONS or not.
There are few tests in selftests/bpf that are consciously using legacy
BPF map definitions to test libbpf functionality. For those, temporary
opt out of LIBBPF_STRICT_MAP_DEFINITIONS mode for the duration of those
tests.
[0] Closes: https://github.com/libbpf/libbpf/issues/272
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/r/20220120060529.1890907-4-andrii@kernel.org
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
93 lines
2.9 KiB
C
93 lines
2.9 KiB
C
/* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */
|
|
|
|
/*
|
|
* Libbpf legacy APIs (either discouraged or deprecated, as mentioned in [0])
|
|
*
|
|
* [0] https://docs.google.com/document/d/1UyjTZuPFWiPFyKk1tV5an11_iaRuec6U-ZESZ54nNTY
|
|
*
|
|
* Copyright (C) 2021 Facebook
|
|
*/
|
|
#ifndef __LIBBPF_LEGACY_BPF_H
|
|
#define __LIBBPF_LEGACY_BPF_H
|
|
|
|
#include <linux/bpf.h>
|
|
#include <stdbool.h>
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
#include "libbpf_common.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
enum libbpf_strict_mode {
|
|
/* Turn on all supported strict features of libbpf to simulate libbpf
|
|
* v1.0 behavior.
|
|
* This will be the default behavior in libbpf v1.0.
|
|
*/
|
|
LIBBPF_STRICT_ALL = 0xffffffff,
|
|
|
|
/*
|
|
* Disable any libbpf 1.0 behaviors. This is the default before libbpf
|
|
* v1.0. It won't be supported anymore in v1.0, please update your
|
|
* code so that it handles LIBBPF_STRICT_ALL mode before libbpf v1.0.
|
|
*/
|
|
LIBBPF_STRICT_NONE = 0x00,
|
|
/*
|
|
* Return NULL pointers on error, not ERR_PTR(err).
|
|
* Additionally, libbpf also always sets errno to corresponding Exx
|
|
* (positive) error code.
|
|
*/
|
|
LIBBPF_STRICT_CLEAN_PTRS = 0x01,
|
|
/*
|
|
* Return actual error codes from low-level APIs directly, not just -1.
|
|
* Additionally, libbpf also always sets errno to corresponding Exx
|
|
* (positive) error code.
|
|
*/
|
|
LIBBPF_STRICT_DIRECT_ERRS = 0x02,
|
|
/*
|
|
* Enforce strict BPF program section (SEC()) names.
|
|
* E.g., while prefiously SEC("xdp_whatever") or SEC("perf_event_blah") were
|
|
* allowed, with LIBBPF_STRICT_SEC_PREFIX this will become
|
|
* unrecognized by libbpf and would have to be just SEC("xdp") and
|
|
* SEC("xdp") and SEC("perf_event").
|
|
*
|
|
* Note, in this mode the program pin path will be based on the
|
|
* function name instead of section name.
|
|
*/
|
|
LIBBPF_STRICT_SEC_NAME = 0x04,
|
|
/*
|
|
* Disable the global 'bpf_objects_list'. Maintaining this list adds
|
|
* a race condition to bpf_object__open() and bpf_object__close().
|
|
* Clients can maintain it on their own if it is valuable for them.
|
|
*/
|
|
LIBBPF_STRICT_NO_OBJECT_LIST = 0x08,
|
|
/*
|
|
* Automatically bump RLIMIT_MEMLOCK using setrlimit() before the
|
|
* first BPF program or map creation operation. This is done only if
|
|
* kernel is too old to support memcg-based memory accounting for BPF
|
|
* subsystem. By default, RLIMIT_MEMLOCK limit is set to RLIM_INFINITY,
|
|
* but it can be overriden with libbpf_set_memlock_rlim_max() API.
|
|
* Note that libbpf_set_memlock_rlim_max() needs to be called before
|
|
* the very first bpf_prog_load(), bpf_map_create() or bpf_object__load()
|
|
* operation.
|
|
*/
|
|
LIBBPF_STRICT_AUTO_RLIMIT_MEMLOCK = 0x10,
|
|
/*
|
|
* Error out on any SEC("maps") map definition, which are deprecated
|
|
* in favor of BTF-defined map definitions in SEC(".maps").
|
|
*/
|
|
LIBBPF_STRICT_MAP_DEFINITIONS = 0x20,
|
|
|
|
__LIBBPF_STRICT_LAST,
|
|
};
|
|
|
|
LIBBPF_API int libbpf_set_strict_mode(enum libbpf_strict_mode mode);
|
|
|
|
#define DECLARE_LIBBPF_OPTS LIBBPF_OPTS
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /* __LIBBPF_LEGACY_BPF_H */
|