xref: /openbmc/linux/tools/lib/bpf/libbpf_legacy.h (revision a77f879b)
15981881dSAndrii Nakryiko /* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */
25981881dSAndrii Nakryiko 
35981881dSAndrii Nakryiko /*
45981881dSAndrii Nakryiko  * Libbpf legacy APIs (either discouraged or deprecated, as mentioned in [0])
55981881dSAndrii Nakryiko  *
65981881dSAndrii Nakryiko  *   [0] https://docs.google.com/document/d/1UyjTZuPFWiPFyKk1tV5an11_iaRuec6U-ZESZ54nNTY
75981881dSAndrii Nakryiko  *
85981881dSAndrii Nakryiko  * Copyright (C) 2021 Facebook
95981881dSAndrii Nakryiko  */
105981881dSAndrii Nakryiko #ifndef __LIBBPF_LEGACY_BPF_H
115981881dSAndrii Nakryiko #define __LIBBPF_LEGACY_BPF_H
125981881dSAndrii Nakryiko 
135981881dSAndrii Nakryiko #include <linux/bpf.h>
145981881dSAndrii Nakryiko #include <stdbool.h>
155981881dSAndrii Nakryiko #include <stddef.h>
165981881dSAndrii Nakryiko #include <stdint.h>
175981881dSAndrii Nakryiko #include "libbpf_common.h"
185981881dSAndrii Nakryiko 
195981881dSAndrii Nakryiko #ifdef __cplusplus
205981881dSAndrii Nakryiko extern "C" {
215981881dSAndrii Nakryiko #endif
225981881dSAndrii Nakryiko 
235981881dSAndrii Nakryiko enum libbpf_strict_mode {
245981881dSAndrii Nakryiko 	/* Turn on all supported strict features of libbpf to simulate libbpf
255981881dSAndrii Nakryiko 	 * v1.0 behavior.
265981881dSAndrii Nakryiko 	 * This will be the default behavior in libbpf v1.0.
275981881dSAndrii Nakryiko 	 */
285981881dSAndrii Nakryiko 	LIBBPF_STRICT_ALL = 0xffffffff,
295981881dSAndrii Nakryiko 
305981881dSAndrii Nakryiko 	/*
315981881dSAndrii Nakryiko 	 * Disable any libbpf 1.0 behaviors. This is the default before libbpf
325981881dSAndrii Nakryiko 	 * v1.0. It won't be supported anymore in v1.0, please update your
335981881dSAndrii Nakryiko 	 * code so that it handles LIBBPF_STRICT_ALL mode before libbpf v1.0.
345981881dSAndrii Nakryiko 	 */
355981881dSAndrii Nakryiko 	LIBBPF_STRICT_NONE = 0x00,
36f12b6543SAndrii Nakryiko 	/*
37f12b6543SAndrii Nakryiko 	 * Return NULL pointers on error, not ERR_PTR(err).
38f12b6543SAndrii Nakryiko 	 * Additionally, libbpf also always sets errno to corresponding Exx
39f12b6543SAndrii Nakryiko 	 * (positive) error code.
40f12b6543SAndrii Nakryiko 	 */
41f12b6543SAndrii Nakryiko 	LIBBPF_STRICT_CLEAN_PTRS = 0x01,
42f12b6543SAndrii Nakryiko 	/*
43f12b6543SAndrii Nakryiko 	 * Return actual error codes from low-level APIs directly, not just -1.
44f12b6543SAndrii Nakryiko 	 * Additionally, libbpf also always sets errno to corresponding Exx
45f12b6543SAndrii Nakryiko 	 * (positive) error code.
46f12b6543SAndrii Nakryiko 	 */
47f12b6543SAndrii Nakryiko 	LIBBPF_STRICT_DIRECT_ERRS = 0x02,
485981881dSAndrii Nakryiko 
49dd94d45cSAndrii Nakryiko 	/*
50dd94d45cSAndrii Nakryiko 	 * Enforce strict BPF program section (SEC()) names.
51dd94d45cSAndrii Nakryiko 	 * E.g., while prefiously SEC("xdp_whatever") or SEC("perf_event_blah") were
52dd94d45cSAndrii Nakryiko 	 * allowed, with LIBBPF_STRICT_SEC_PREFIX this will become
53dd94d45cSAndrii Nakryiko 	 * unrecognized by libbpf and would have to be just SEC("xdp") and
54dd94d45cSAndrii Nakryiko 	 * SEC("xdp") and SEC("perf_event").
55*a77f879bSStanislav Fomichev 	 *
56*a77f879bSStanislav Fomichev 	 * Note, in this mode the program pin path will be based on the
57*a77f879bSStanislav Fomichev 	 * function name instead of section name.
58dd94d45cSAndrii Nakryiko 	 */
59dd94d45cSAndrii Nakryiko 	LIBBPF_STRICT_SEC_NAME = 0x04,
60dd94d45cSAndrii Nakryiko 
615981881dSAndrii Nakryiko 	__LIBBPF_STRICT_LAST,
625981881dSAndrii Nakryiko };
635981881dSAndrii Nakryiko 
645981881dSAndrii Nakryiko LIBBPF_API int libbpf_set_strict_mode(enum libbpf_strict_mode mode);
655981881dSAndrii Nakryiko 
665981881dSAndrii Nakryiko 
675981881dSAndrii Nakryiko #ifdef __cplusplus
685981881dSAndrii Nakryiko } /* extern "C" */
695981881dSAndrii Nakryiko #endif
705981881dSAndrii Nakryiko 
715981881dSAndrii Nakryiko #endif /* __LIBBPF_LEGACY_BPF_H */
72