1d7c4b398SAndrii Nakryiko /* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */ 2d7c4b398SAndrii Nakryiko 3d7c4b398SAndrii Nakryiko /* 4d7c4b398SAndrii Nakryiko * Internal libbpf helpers. 5d7c4b398SAndrii Nakryiko * 6d7c4b398SAndrii Nakryiko * Copyright (c) 2019 Facebook 7d7c4b398SAndrii Nakryiko */ 8d7c4b398SAndrii Nakryiko 9d7c4b398SAndrii Nakryiko #ifndef __LIBBPF_LIBBPF_INTERNAL_H 10d7c4b398SAndrii Nakryiko #define __LIBBPF_LIBBPF_INTERNAL_H 11d7c4b398SAndrii Nakryiko 12029258d7SAndrii Nakryiko #include <stdlib.h> 13dda1ec9fSAndrii Nakryiko #include <limits.h> 14f12b6543SAndrii Nakryiko #include <errno.h> 15f12b6543SAndrii Nakryiko #include <linux/err.h> 16549a6323SKumar Kartikeya Dwivedi #include <fcntl.h> 17549a6323SKumar Kartikeya Dwivedi #include <unistd.h> 18f12b6543SAndrii Nakryiko #include "libbpf_legacy.h" 19301ba4d7SAlexei Starovoitov #include "relo_core.h" 2085367030SAndrii Nakryiko 2185367030SAndrii Nakryiko /* make sure libbpf doesn't use kernel-only integer typedefs */ 2285367030SAndrii Nakryiko #pragma GCC poison u8 u16 u32 u64 s8 s16 s32 s64 2385367030SAndrii Nakryiko 2485367030SAndrii Nakryiko /* prevent accidental re-addition of reallocarray() */ 2585367030SAndrii Nakryiko #pragma GCC poison reallocarray 2685367030SAndrii Nakryiko 271d7a08b3SAndrii Nakryiko #include "libbpf.h" 28aea28a60SAndrii Nakryiko #include "btf.h" 291d7a08b3SAndrii Nakryiko 30faf6ed32SAndrii Nakryiko #ifndef EM_BPF 31faf6ed32SAndrii Nakryiko #define EM_BPF 247 32faf6ed32SAndrii Nakryiko #endif 33faf6ed32SAndrii Nakryiko 34faf6ed32SAndrii Nakryiko #ifndef R_BPF_64_64 35faf6ed32SAndrii Nakryiko #define R_BPF_64_64 1 36faf6ed32SAndrii Nakryiko #endif 379f0c317fSYonghong Song #ifndef R_BPF_64_ABS64 389f0c317fSYonghong Song #define R_BPF_64_ABS64 2 399f0c317fSYonghong Song #endif 409f0c317fSYonghong Song #ifndef R_BPF_64_ABS32 419f0c317fSYonghong Song #define R_BPF_64_ABS32 3 429f0c317fSYonghong Song #endif 43faf6ed32SAndrii Nakryiko #ifndef R_BPF_64_32 44faf6ed32SAndrii Nakryiko #define R_BPF_64_32 10 45faf6ed32SAndrii Nakryiko #endif 46faf6ed32SAndrii Nakryiko 47faf6ed32SAndrii Nakryiko #ifndef SHT_LLVM_ADDRSIG 48faf6ed32SAndrii Nakryiko #define SHT_LLVM_ADDRSIG 0x6FFF4C03 49faf6ed32SAndrii Nakryiko #endif 50faf6ed32SAndrii Nakryiko 51faf6ed32SAndrii Nakryiko /* if libelf is old and doesn't support mmap(), fall back to read() */ 52faf6ed32SAndrii Nakryiko #ifndef ELF_C_READ_MMAP 53faf6ed32SAndrii Nakryiko #define ELF_C_READ_MMAP ELF_C_READ 54faf6ed32SAndrii Nakryiko #endif 55faf6ed32SAndrii Nakryiko 5667e7ec0bSArnaldo Carvalho de Melo /* Older libelf all end up in this expression, for both 32 and 64 bit */ 57ad23b723SAndrii Nakryiko #ifndef ELF64_ST_VISIBILITY 58ad23b723SAndrii Nakryiko #define ELF64_ST_VISIBILITY(o) ((o) & 0x03) 5967e7ec0bSArnaldo Carvalho de Melo #endif 6067e7ec0bSArnaldo Carvalho de Melo 61d7c4b398SAndrii Nakryiko #define BTF_INFO_ENC(kind, kind_flag, vlen) \ 62d7c4b398SAndrii Nakryiko ((!!(kind_flag) << 31) | ((kind) << 24) | ((vlen) & BTF_MAX_VLEN)) 63d7c4b398SAndrii Nakryiko #define BTF_TYPE_ENC(name, info, size_or_type) (name), (info), (size_or_type) 64d7c4b398SAndrii Nakryiko #define BTF_INT_ENC(encoding, bits_offset, nr_bits) \ 65d7c4b398SAndrii Nakryiko ((encoding) << 24 | (bits_offset) << 16 | (nr_bits)) 66d7c4b398SAndrii Nakryiko #define BTF_TYPE_INT_ENC(name, encoding, bits_offset, bits, sz) \ 67d7c4b398SAndrii Nakryiko BTF_TYPE_ENC(name, BTF_INFO_ENC(BTF_KIND_INT, 0, 0), sz), \ 68d7c4b398SAndrii Nakryiko BTF_INT_ENC(encoding, bits_offset, bits) 69d7c4b398SAndrii Nakryiko #define BTF_MEMBER_ENC(name, type, bits_offset) (name), (type), (bits_offset) 70d7c4b398SAndrii Nakryiko #define BTF_PARAM_ENC(name, type) (name), (type) 71d7c4b398SAndrii Nakryiko #define BTF_VAR_SECINFO_ENC(type, offset, size) (type), (offset), (size) 7222541a9eSIlya Leoshkevich #define BTF_TYPE_FLOAT_ENC(name, sz) \ 7322541a9eSIlya Leoshkevich BTF_TYPE_ENC(name, BTF_INFO_ENC(BTF_KIND_FLOAT, 0, 0), sz) 74223f903eSYonghong Song #define BTF_TYPE_DECL_TAG_ENC(value, type, component_idx) \ 75223f903eSYonghong Song BTF_TYPE_ENC(value, BTF_INFO_ENC(BTF_KIND_DECL_TAG, 0, 0), type), (component_idx) 762dc1e488SYonghong Song #define BTF_TYPE_TYPE_TAG_ENC(value, type) \ 772dc1e488SYonghong Song BTF_TYPE_ENC(value, BTF_INFO_ENC(BTF_KIND_TYPE_TAG, 0, 0), type) 78d7c4b398SAndrii Nakryiko 79029258d7SAndrii Nakryiko #ifndef likely 80029258d7SAndrii Nakryiko #define likely(x) __builtin_expect(!!(x), 1) 81029258d7SAndrii Nakryiko #endif 82029258d7SAndrii Nakryiko #ifndef unlikely 83029258d7SAndrii Nakryiko #define unlikely(x) __builtin_expect(!!(x), 0) 84029258d7SAndrii Nakryiko #endif 85d7fe74f9SAndrii Nakryiko #ifndef min 86d7fe74f9SAndrii Nakryiko # define min(x, y) ((x) < (y) ? (x) : (y)) 87d7fe74f9SAndrii Nakryiko #endif 88d7fe74f9SAndrii Nakryiko #ifndef max 89d7fe74f9SAndrii Nakryiko # define max(x, y) ((x) < (y) ? (y) : (x)) 90d7fe74f9SAndrii Nakryiko #endif 914cedc0daSAndrii Nakryiko #ifndef offsetofend 924cedc0daSAndrii Nakryiko # define offsetofend(TYPE, FIELD) \ 934cedc0daSAndrii Nakryiko (offsetof(TYPE, FIELD) + sizeof(((TYPE *)0)->FIELD)) 944cedc0daSAndrii Nakryiko #endif 95d7fe74f9SAndrii Nakryiko 9613d35a0cSAndrii Nakryiko /* Check whether a string `str` has prefix `pfx`, regardless if `pfx` is 9713d35a0cSAndrii Nakryiko * a string literal known at compilation time or char * pointer known only at 9813d35a0cSAndrii Nakryiko * runtime. 9913d35a0cSAndrii Nakryiko */ 10013d35a0cSAndrii Nakryiko #define str_has_pfx(str, pfx) \ 10113d35a0cSAndrii Nakryiko (strncmp(str, pfx, __builtin_constant_p(pfx) ? sizeof(pfx) - 1 : strlen(pfx)) == 0) 10213d35a0cSAndrii Nakryiko 1031bd63524SYonghong Song /* Symbol versioning is different between static and shared library. 1041bd63524SYonghong Song * Properly versioned symbols are needed for shared library, but 1051bd63524SYonghong Song * only the symbol of the new version is needed for static library. 106006a5099SAndrii Nakryiko * Starting with GNU C 10, use symver attribute instead of .symver assembler 107006a5099SAndrii Nakryiko * directive, which works better with GCC LTO builds. 1081bd63524SYonghong Song */ 109006a5099SAndrii Nakryiko #if defined(SHARED) && defined(__GNUC__) && __GNUC__ >= 10 110006a5099SAndrii Nakryiko 111006a5099SAndrii Nakryiko #define DEFAULT_VERSION(internal_name, api_name, version) \ 112006a5099SAndrii Nakryiko __attribute__((symver(#api_name "@@" #version))) 113006a5099SAndrii Nakryiko #define COMPAT_VERSION(internal_name, api_name, version) \ 114006a5099SAndrii Nakryiko __attribute__((symver(#api_name "@" #version))) 115006a5099SAndrii Nakryiko 116006a5099SAndrii Nakryiko #elif defined(SHARED) 117006a5099SAndrii Nakryiko 1181bd63524SYonghong Song #define COMPAT_VERSION(internal_name, api_name, version) \ 1191bd63524SYonghong Song asm(".symver " #internal_name "," #api_name "@" #version); 1201bd63524SYonghong Song #define DEFAULT_VERSION(internal_name, api_name, version) \ 1211bd63524SYonghong Song asm(".symver " #internal_name "," #api_name "@@" #version); 122006a5099SAndrii Nakryiko 123006a5099SAndrii Nakryiko #else /* !SHARED */ 124006a5099SAndrii Nakryiko 1251bd63524SYonghong Song #define COMPAT_VERSION(internal_name, api_name, version) 1261bd63524SYonghong Song #define DEFAULT_VERSION(internal_name, api_name, version) \ 1271bd63524SYonghong Song extern typeof(internal_name) api_name \ 1281bd63524SYonghong Song __attribute__((alias(#internal_name))); 129006a5099SAndrii Nakryiko 1301bd63524SYonghong Song #endif 1311bd63524SYonghong Song 132d72386feSAndrii Nakryiko extern void libbpf_print(enum libbpf_print_level level, 133d72386feSAndrii Nakryiko const char *format, ...) 134d72386feSAndrii Nakryiko __attribute__((format(printf, 2, 3))); 135d72386feSAndrii Nakryiko 136d72386feSAndrii Nakryiko #define __pr(level, fmt, ...) \ 137d72386feSAndrii Nakryiko do { \ 138d72386feSAndrii Nakryiko libbpf_print(level, "libbpf: " fmt, ##__VA_ARGS__); \ 139d72386feSAndrii Nakryiko } while (0) 140d72386feSAndrii Nakryiko 141be18010eSKefeng Wang #define pr_warn(fmt, ...) __pr(LIBBPF_WARN, fmt, ##__VA_ARGS__) 142d72386feSAndrii Nakryiko #define pr_info(fmt, ...) __pr(LIBBPF_INFO, fmt, ##__VA_ARGS__) 143d72386feSAndrii Nakryiko #define pr_debug(fmt, ...) __pr(LIBBPF_DEBUG, fmt, ##__VA_ARGS__) 144d72386feSAndrii Nakryiko 145dda1ec9fSAndrii Nakryiko #ifndef __has_builtin 146dda1ec9fSAndrii Nakryiko #define __has_builtin(x) 0 147dda1ec9fSAndrii Nakryiko #endif 148029258d7SAndrii Nakryiko /* 149029258d7SAndrii Nakryiko * Re-implement glibc's reallocarray() for libbpf internal-only use. 150029258d7SAndrii Nakryiko * reallocarray(), unfortunately, is not available in all versions of glibc, 151029258d7SAndrii Nakryiko * so requires extra feature detection and using reallocarray() stub from 152029258d7SAndrii Nakryiko * <tools/libc_compat.h> and COMPAT_NEED_REALLOCARRAY. All this complicates 153029258d7SAndrii Nakryiko * build of libbpf unnecessarily and is just a maintenance burden. Instead, 154029258d7SAndrii Nakryiko * it's trivial to implement libbpf-specific internal version and use it 155029258d7SAndrii Nakryiko * throughout libbpf. 156029258d7SAndrii Nakryiko */ 157029258d7SAndrii Nakryiko static inline void *libbpf_reallocarray(void *ptr, size_t nmemb, size_t size) 158029258d7SAndrii Nakryiko { 159029258d7SAndrii Nakryiko size_t total; 160029258d7SAndrii Nakryiko 161dda1ec9fSAndrii Nakryiko #if __has_builtin(__builtin_mul_overflow) 162029258d7SAndrii Nakryiko if (unlikely(__builtin_mul_overflow(nmemb, size, &total))) 163029258d7SAndrii Nakryiko return NULL; 164dda1ec9fSAndrii Nakryiko #else 165dda1ec9fSAndrii Nakryiko if (size == 0 || nmemb > ULONG_MAX / size) 166dda1ec9fSAndrii Nakryiko return NULL; 167dda1ec9fSAndrii Nakryiko total = nmemb * size; 168dda1ec9fSAndrii Nakryiko #endif 169029258d7SAndrii Nakryiko return realloc(ptr, total); 170029258d7SAndrii Nakryiko } 171029258d7SAndrii Nakryiko 172*9fc205b4SAndrii Nakryiko /* Copy up to sz - 1 bytes from zero-terminated src string and ensure that dst 173*9fc205b4SAndrii Nakryiko * is zero-terminated string no matter what (unless sz == 0, in which case 174*9fc205b4SAndrii Nakryiko * it's a no-op). It's conceptually close to FreeBSD's strlcpy(), but differs 175*9fc205b4SAndrii Nakryiko * in what is returned. Given this is internal helper, it's trivial to extend 176*9fc205b4SAndrii Nakryiko * this, when necessary. Use this instead of strncpy inside libbpf source code. 177*9fc205b4SAndrii Nakryiko */ 178*9fc205b4SAndrii Nakryiko static inline void libbpf_strlcpy(char *dst, const char *src, size_t sz) 179*9fc205b4SAndrii Nakryiko { 180*9fc205b4SAndrii Nakryiko size_t i; 181*9fc205b4SAndrii Nakryiko 182*9fc205b4SAndrii Nakryiko if (sz == 0) 183*9fc205b4SAndrii Nakryiko return; 184*9fc205b4SAndrii Nakryiko 185*9fc205b4SAndrii Nakryiko sz--; 186*9fc205b4SAndrii Nakryiko for (i = 0; i < sz && src[i]; i++) 187*9fc205b4SAndrii Nakryiko dst[i] = src[i]; 188*9fc205b4SAndrii Nakryiko dst[i] = '\0'; 189*9fc205b4SAndrii Nakryiko } 190*9fc205b4SAndrii Nakryiko 191e14ef4bfSAndrii Nakryiko struct btf; 192e14ef4bfSAndrii Nakryiko struct btf_type; 193e14ef4bfSAndrii Nakryiko 19474753e14SAlexei Starovoitov struct btf_type *btf_type_by_id(const struct btf *btf, __u32 type_id); 19542869d28SAndrii Nakryiko const char *btf_kind_str(const struct btf_type *t); 19642869d28SAndrii Nakryiko const struct btf_type *skip_mods_and_typedefs(const struct btf *btf, __u32 id, __u32 *res_id); 19742869d28SAndrii Nakryiko 19842869d28SAndrii Nakryiko static inline enum btf_func_linkage btf_func_linkage(const struct btf_type *t) 19942869d28SAndrii Nakryiko { 20042869d28SAndrii Nakryiko return (enum btf_func_linkage)(int)btf_vlen(t); 20142869d28SAndrii Nakryiko } 202e14ef4bfSAndrii Nakryiko 203aea28a60SAndrii Nakryiko static inline __u32 btf_type_info(int kind, int vlen, int kflag) 204aea28a60SAndrii Nakryiko { 205aea28a60SAndrii Nakryiko return (kflag << 31) | (kind << 24) | vlen; 206aea28a60SAndrii Nakryiko } 207aea28a60SAndrii Nakryiko 208c7ef5ec9SAndrii Nakryiko enum map_def_parts { 209c7ef5ec9SAndrii Nakryiko MAP_DEF_MAP_TYPE = 0x001, 210c7ef5ec9SAndrii Nakryiko MAP_DEF_KEY_TYPE = 0x002, 211c7ef5ec9SAndrii Nakryiko MAP_DEF_KEY_SIZE = 0x004, 212c7ef5ec9SAndrii Nakryiko MAP_DEF_VALUE_TYPE = 0x008, 213c7ef5ec9SAndrii Nakryiko MAP_DEF_VALUE_SIZE = 0x010, 214c7ef5ec9SAndrii Nakryiko MAP_DEF_MAX_ENTRIES = 0x020, 215c7ef5ec9SAndrii Nakryiko MAP_DEF_MAP_FLAGS = 0x040, 216c7ef5ec9SAndrii Nakryiko MAP_DEF_NUMA_NODE = 0x080, 217c7ef5ec9SAndrii Nakryiko MAP_DEF_PINNING = 0x100, 218c7ef5ec9SAndrii Nakryiko MAP_DEF_INNER_MAP = 0x200, 21947512102SJoanne Koong MAP_DEF_MAP_EXTRA = 0x400, 220c7ef5ec9SAndrii Nakryiko 22147512102SJoanne Koong MAP_DEF_ALL = 0x7ff, /* combination of all above */ 222c7ef5ec9SAndrii Nakryiko }; 223c7ef5ec9SAndrii Nakryiko 224c7ef5ec9SAndrii Nakryiko struct btf_map_def { 225c7ef5ec9SAndrii Nakryiko enum map_def_parts parts; 226c7ef5ec9SAndrii Nakryiko __u32 map_type; 227c7ef5ec9SAndrii Nakryiko __u32 key_type_id; 228c7ef5ec9SAndrii Nakryiko __u32 key_size; 229c7ef5ec9SAndrii Nakryiko __u32 value_type_id; 230c7ef5ec9SAndrii Nakryiko __u32 value_size; 231c7ef5ec9SAndrii Nakryiko __u32 max_entries; 232c7ef5ec9SAndrii Nakryiko __u32 map_flags; 233c7ef5ec9SAndrii Nakryiko __u32 numa_node; 234c7ef5ec9SAndrii Nakryiko __u32 pinning; 23547512102SJoanne Koong __u64 map_extra; 236c7ef5ec9SAndrii Nakryiko }; 237c7ef5ec9SAndrii Nakryiko 238c7ef5ec9SAndrii Nakryiko int parse_btf_map_def(const char *map_name, struct btf *btf, 239c7ef5ec9SAndrii Nakryiko const struct btf_type *def_t, bool strict, 240c7ef5ec9SAndrii Nakryiko struct btf_map_def *map_def, struct btf_map_def *inner_def); 241c7ef5ec9SAndrii Nakryiko 2423b029e06SAndrii Nakryiko void *libbpf_add_mem(void **data, size_t *cap_cnt, size_t elem_sz, 243192f5a1fSAndrii Nakryiko size_t cur_cnt, size_t max_cnt, size_t add_cnt); 2443b029e06SAndrii Nakryiko int libbpf_ensure_mem(void **data, size_t *cap_cnt, size_t elem_sz, size_t need_cnt); 245192f5a1fSAndrii Nakryiko 2463ec84f4bSAndrii Nakryiko static inline bool libbpf_is_mem_zeroed(const char *p, ssize_t len) 2473ec84f4bSAndrii Nakryiko { 2483ec84f4bSAndrii Nakryiko while (len > 0) { 2493ec84f4bSAndrii Nakryiko if (*p) 2503ec84f4bSAndrii Nakryiko return false; 2513ec84f4bSAndrii Nakryiko p++; 2523ec84f4bSAndrii Nakryiko len--; 2533ec84f4bSAndrii Nakryiko } 2543ec84f4bSAndrii Nakryiko return true; 2553ec84f4bSAndrii Nakryiko } 2563ec84f4bSAndrii Nakryiko 2572ce8450eSAndrii Nakryiko static inline bool libbpf_validate_opts(const char *opts, 2582ce8450eSAndrii Nakryiko size_t opts_sz, size_t user_sz, 2592ce8450eSAndrii Nakryiko const char *type_name) 2602ce8450eSAndrii Nakryiko { 2612ce8450eSAndrii Nakryiko if (user_sz < sizeof(size_t)) { 262be18010eSKefeng Wang pr_warn("%s size (%zu) is too small\n", type_name, user_sz); 2632ce8450eSAndrii Nakryiko return false; 2642ce8450eSAndrii Nakryiko } 2653ec84f4bSAndrii Nakryiko if (!libbpf_is_mem_zeroed(opts + opts_sz, (ssize_t)user_sz - opts_sz)) { 2663ec84f4bSAndrii Nakryiko pr_warn("%s has non-zero extra bytes\n", type_name); 2672ce8450eSAndrii Nakryiko return false; 2682ce8450eSAndrii Nakryiko } 2692ce8450eSAndrii Nakryiko return true; 2702ce8450eSAndrii Nakryiko } 2712ce8450eSAndrii Nakryiko 2722ce8450eSAndrii Nakryiko #define OPTS_VALID(opts, type) \ 2732ce8450eSAndrii Nakryiko (!(opts) || libbpf_validate_opts((const char *)opts, \ 2742ce8450eSAndrii Nakryiko offsetofend(struct type, \ 2752ce8450eSAndrii Nakryiko type##__last_field), \ 2762ce8450eSAndrii Nakryiko (opts)->sz, #type)) 2772ce8450eSAndrii Nakryiko #define OPTS_HAS(opts, field) \ 2782ce8450eSAndrii Nakryiko ((opts) && opts->sz >= offsetofend(typeof(*(opts)), field)) 2792ce8450eSAndrii Nakryiko #define OPTS_GET(opts, field, fallback_value) \ 2802ce8450eSAndrii Nakryiko (OPTS_HAS(opts, field) ? (opts)->field : fallback_value) 28188f7fe72SSong Liu #define OPTS_SET(opts, field, value) \ 28288f7fe72SSong Liu do { \ 28388f7fe72SSong Liu if (OPTS_HAS(opts, field)) \ 28488f7fe72SSong Liu (opts)->field = value; \ 28588f7fe72SSong Liu } while (0) 2862ce8450eSAndrii Nakryiko 2873ec84f4bSAndrii Nakryiko #define OPTS_ZEROED(opts, last_nonzero_field) \ 2883ec84f4bSAndrii Nakryiko ({ \ 2893ec84f4bSAndrii Nakryiko ssize_t __off = offsetofend(typeof(*(opts)), last_nonzero_field); \ 2903ec84f4bSAndrii Nakryiko !(opts) || libbpf_is_mem_zeroed((const void *)opts + __off, \ 2913ec84f4bSAndrii Nakryiko (opts)->sz - __off); \ 2923ec84f4bSAndrii Nakryiko }) 2933ec84f4bSAndrii Nakryiko 2943ec84f4bSAndrii Nakryiko 2956803ee25SAndrii Nakryiko int parse_cpu_mask_str(const char *s, bool **mask, int *mask_sz); 2966803ee25SAndrii Nakryiko int parse_cpu_mask_file(const char *fcpu, bool **mask, int *mask_sz); 297cfd49210SMichal Rostecki int libbpf__load_raw_btf(const char *raw_types, size_t types_len, 298d7c4b398SAndrii Nakryiko const char *str_sec, size_t str_len); 2991a190d1eSAndrii Nakryiko int btf_load_into_kernel(struct btf *btf, char *log_buf, size_t log_sz, __u32 log_level); 300d7c4b398SAndrii Nakryiko 301a19f93cfSAndrii Nakryiko struct btf *btf_get_from_fd(int btf_fd, struct btf *base_btf); 30267234743SAlexei Starovoitov void btf_get_kernel_prefix_kind(enum bpf_attach_type attach_type, 30367234743SAlexei Starovoitov const char **prefix, int *kind); 304612d05beSAndrii Nakryiko 3054cedc0daSAndrii Nakryiko struct btf_ext_info { 3064cedc0daSAndrii Nakryiko /* 3074cedc0daSAndrii Nakryiko * info points to the individual info section (e.g. func_info and 3084cedc0daSAndrii Nakryiko * line_info) from the .BTF.ext. It does not include the __u32 rec_size. 3094cedc0daSAndrii Nakryiko */ 3104cedc0daSAndrii Nakryiko void *info; 3114cedc0daSAndrii Nakryiko __u32 rec_size; 3124cedc0daSAndrii Nakryiko __u32 len; 3134cedc0daSAndrii Nakryiko }; 3144cedc0daSAndrii Nakryiko 3154cedc0daSAndrii Nakryiko #define for_each_btf_ext_sec(seg, sec) \ 3164cedc0daSAndrii Nakryiko for (sec = (seg)->info; \ 3174cedc0daSAndrii Nakryiko (void *)sec < (seg)->info + (seg)->len; \ 3184cedc0daSAndrii Nakryiko sec = (void *)sec + sizeof(struct btf_ext_info_sec) + \ 3194cedc0daSAndrii Nakryiko (seg)->rec_size * sec->num_info) 3204cedc0daSAndrii Nakryiko 3214cedc0daSAndrii Nakryiko #define for_each_btf_ext_rec(seg, sec, i, rec) \ 3224cedc0daSAndrii Nakryiko for (i = 0, rec = (void *)&(sec)->data; \ 3234cedc0daSAndrii Nakryiko i < (sec)->num_info; \ 3244cedc0daSAndrii Nakryiko i++, rec = (void *)rec + (seg)->rec_size) 3254cedc0daSAndrii Nakryiko 32628b93c64SAndrii Nakryiko /* 32728b93c64SAndrii Nakryiko * The .BTF.ext ELF section layout defined as 32828b93c64SAndrii Nakryiko * struct btf_ext_header 32928b93c64SAndrii Nakryiko * func_info subsection 33028b93c64SAndrii Nakryiko * 33128b93c64SAndrii Nakryiko * The func_info subsection layout: 33228b93c64SAndrii Nakryiko * record size for struct bpf_func_info in the func_info subsection 33328b93c64SAndrii Nakryiko * struct btf_sec_func_info for section #1 33428b93c64SAndrii Nakryiko * a list of bpf_func_info records for section #1 33528b93c64SAndrii Nakryiko * where struct bpf_func_info mimics one in include/uapi/linux/bpf.h 33628b93c64SAndrii Nakryiko * but may not be identical 33728b93c64SAndrii Nakryiko * struct btf_sec_func_info for section #2 33828b93c64SAndrii Nakryiko * a list of bpf_func_info records for section #2 33928b93c64SAndrii Nakryiko * ...... 34028b93c64SAndrii Nakryiko * 34128b93c64SAndrii Nakryiko * Note that the bpf_func_info record size in .BTF.ext may not 34228b93c64SAndrii Nakryiko * be the same as the one defined in include/uapi/linux/bpf.h. 34328b93c64SAndrii Nakryiko * The loader should ensure that record_size meets minimum 34428b93c64SAndrii Nakryiko * requirement and pass the record as is to the kernel. The 34528b93c64SAndrii Nakryiko * kernel will handle the func_info properly based on its contents. 34628b93c64SAndrii Nakryiko */ 34728b93c64SAndrii Nakryiko struct btf_ext_header { 34828b93c64SAndrii Nakryiko __u16 magic; 34928b93c64SAndrii Nakryiko __u8 version; 35028b93c64SAndrii Nakryiko __u8 flags; 35128b93c64SAndrii Nakryiko __u32 hdr_len; 35228b93c64SAndrii Nakryiko 35328b93c64SAndrii Nakryiko /* All offsets are in bytes relative to the end of this header */ 35428b93c64SAndrii Nakryiko __u32 func_info_off; 35528b93c64SAndrii Nakryiko __u32 func_info_len; 35628b93c64SAndrii Nakryiko __u32 line_info_off; 35728b93c64SAndrii Nakryiko __u32 line_info_len; 35828b93c64SAndrii Nakryiko 35928b93c64SAndrii Nakryiko /* optional part of .BTF.ext header */ 36028b93c64SAndrii Nakryiko __u32 core_relo_off; 36128b93c64SAndrii Nakryiko __u32 core_relo_len; 36228b93c64SAndrii Nakryiko }; 36328b93c64SAndrii Nakryiko 3644cedc0daSAndrii Nakryiko struct btf_ext { 3654cedc0daSAndrii Nakryiko union { 3664cedc0daSAndrii Nakryiko struct btf_ext_header *hdr; 3674cedc0daSAndrii Nakryiko void *data; 3684cedc0daSAndrii Nakryiko }; 3694cedc0daSAndrii Nakryiko struct btf_ext_info func_info; 3704cedc0daSAndrii Nakryiko struct btf_ext_info line_info; 37128b93c64SAndrii Nakryiko struct btf_ext_info core_relo_info; 3724cedc0daSAndrii Nakryiko __u32 data_size; 3734cedc0daSAndrii Nakryiko }; 3744cedc0daSAndrii Nakryiko 3754cedc0daSAndrii Nakryiko struct btf_ext_info_sec { 3764cedc0daSAndrii Nakryiko __u32 sec_name_off; 3774cedc0daSAndrii Nakryiko __u32 num_info; 3784cedc0daSAndrii Nakryiko /* Followed by num_info * record_size number of bytes */ 379385bbf7bSGustavo A. R. Silva __u8 data[]; 3804cedc0daSAndrii Nakryiko }; 3814cedc0daSAndrii Nakryiko 3824cedc0daSAndrii Nakryiko /* The minimum bpf_func_info checked by the loader */ 3834cedc0daSAndrii Nakryiko struct bpf_func_info_min { 3844cedc0daSAndrii Nakryiko __u32 insn_off; 3854cedc0daSAndrii Nakryiko __u32 type_id; 3864cedc0daSAndrii Nakryiko }; 3874cedc0daSAndrii Nakryiko 3884cedc0daSAndrii Nakryiko /* The minimum bpf_line_info checked by the loader */ 3894cedc0daSAndrii Nakryiko struct bpf_line_info_min { 3904cedc0daSAndrii Nakryiko __u32 insn_off; 3914cedc0daSAndrii Nakryiko __u32 file_name_off; 3924cedc0daSAndrii Nakryiko __u32 line_off; 3934cedc0daSAndrii Nakryiko __u32 line_col; 3944cedc0daSAndrii Nakryiko }; 3954cedc0daSAndrii Nakryiko 3964cedc0daSAndrii Nakryiko 397f36e99a4SAndrii Nakryiko typedef int (*type_id_visit_fn)(__u32 *type_id, void *ctx); 398f36e99a4SAndrii Nakryiko typedef int (*str_off_visit_fn)(__u32 *str_off, void *ctx); 399f36e99a4SAndrii Nakryiko int btf_type_visit_type_ids(struct btf_type *t, type_id_visit_fn visit, void *ctx); 400f36e99a4SAndrii Nakryiko int btf_type_visit_str_offs(struct btf_type *t, str_off_visit_fn visit, void *ctx); 401f36e99a4SAndrii Nakryiko int btf_ext_visit_type_ids(struct btf_ext *btf_ext, type_id_visit_fn visit, void *ctx); 402f36e99a4SAndrii Nakryiko int btf_ext_visit_str_offs(struct btf_ext *btf_ext, str_off_visit_fn visit, void *ctx); 4039dbe6015SKumar Kartikeya Dwivedi __s32 btf__find_by_name_kind_own(const struct btf *btf, const char *type_name, 4049dbe6015SKumar Kartikeya Dwivedi __u32 kind); 405f36e99a4SAndrii Nakryiko 406f12b6543SAndrii Nakryiko extern enum libbpf_strict_mode libbpf_mode; 407f12b6543SAndrii Nakryiko 408f12b6543SAndrii Nakryiko /* handle direct returned errors */ 409f12b6543SAndrii Nakryiko static inline int libbpf_err(int ret) 410f12b6543SAndrii Nakryiko { 411f12b6543SAndrii Nakryiko if (ret < 0) 412f12b6543SAndrii Nakryiko errno = -ret; 413f12b6543SAndrii Nakryiko return ret; 414f12b6543SAndrii Nakryiko } 415f12b6543SAndrii Nakryiko 416f12b6543SAndrii Nakryiko /* handle errno-based (e.g., syscall or libc) errors according to libbpf's 417f12b6543SAndrii Nakryiko * strict mode settings 418f12b6543SAndrii Nakryiko */ 419f12b6543SAndrii Nakryiko static inline int libbpf_err_errno(int ret) 420f12b6543SAndrii Nakryiko { 421f12b6543SAndrii Nakryiko if (libbpf_mode & LIBBPF_STRICT_DIRECT_ERRS) 422f12b6543SAndrii Nakryiko /* errno is already assumed to be set on error */ 423f12b6543SAndrii Nakryiko return ret < 0 ? -errno : ret; 424f12b6543SAndrii Nakryiko 425f12b6543SAndrii Nakryiko /* legacy: on error return -1 directly and don't touch errno */ 426f12b6543SAndrii Nakryiko return ret; 427f12b6543SAndrii Nakryiko } 428f12b6543SAndrii Nakryiko 429e9fc3ce9SAndrii Nakryiko /* handle error for pointer-returning APIs, err is assumed to be < 0 always */ 430e9fc3ce9SAndrii Nakryiko static inline void *libbpf_err_ptr(int err) 431e9fc3ce9SAndrii Nakryiko { 432e9fc3ce9SAndrii Nakryiko /* set errno on error, this doesn't break anything */ 433e9fc3ce9SAndrii Nakryiko errno = -err; 434e9fc3ce9SAndrii Nakryiko 435e9fc3ce9SAndrii Nakryiko if (libbpf_mode & LIBBPF_STRICT_CLEAN_PTRS) 436e9fc3ce9SAndrii Nakryiko return NULL; 437e9fc3ce9SAndrii Nakryiko 438e9fc3ce9SAndrii Nakryiko /* legacy: encode err as ptr */ 439e9fc3ce9SAndrii Nakryiko return ERR_PTR(err); 440e9fc3ce9SAndrii Nakryiko } 441e9fc3ce9SAndrii Nakryiko 442e9fc3ce9SAndrii Nakryiko /* handle pointer-returning APIs' error handling */ 443e9fc3ce9SAndrii Nakryiko static inline void *libbpf_ptr(void *ret) 444e9fc3ce9SAndrii Nakryiko { 445e9fc3ce9SAndrii Nakryiko /* set errno on error, this doesn't break anything */ 446e9fc3ce9SAndrii Nakryiko if (IS_ERR(ret)) 447e9fc3ce9SAndrii Nakryiko errno = -PTR_ERR(ret); 448e9fc3ce9SAndrii Nakryiko 449e9fc3ce9SAndrii Nakryiko if (libbpf_mode & LIBBPF_STRICT_CLEAN_PTRS) 450e9fc3ce9SAndrii Nakryiko return IS_ERR(ret) ? NULL : ret; 451e9fc3ce9SAndrii Nakryiko 452e9fc3ce9SAndrii Nakryiko /* legacy: pass-through original pointer */ 453e9fc3ce9SAndrii Nakryiko return ret; 454e9fc3ce9SAndrii Nakryiko } 455e9fc3ce9SAndrii Nakryiko 456b0588390SAlexei Starovoitov static inline bool str_is_empty(const char *s) 457b0588390SAlexei Starovoitov { 458b0588390SAlexei Starovoitov return !s || !s[0]; 459b0588390SAlexei Starovoitov } 460b0588390SAlexei Starovoitov 461b0588390SAlexei Starovoitov static inline bool is_ldimm64_insn(struct bpf_insn *insn) 462b0588390SAlexei Starovoitov { 463b0588390SAlexei Starovoitov return insn->code == (BPF_LD | BPF_IMM | BPF_DW); 464b0588390SAlexei Starovoitov } 465b0588390SAlexei Starovoitov 466549a6323SKumar Kartikeya Dwivedi /* if fd is stdin, stdout, or stderr, dup to a fd greater than 2 467549a6323SKumar Kartikeya Dwivedi * Takes ownership of the fd passed in, and closes it if calling 468549a6323SKumar Kartikeya Dwivedi * fcntl(fd, F_DUPFD_CLOEXEC, 3). 469549a6323SKumar Kartikeya Dwivedi */ 470549a6323SKumar Kartikeya Dwivedi static inline int ensure_good_fd(int fd) 471549a6323SKumar Kartikeya Dwivedi { 472549a6323SKumar Kartikeya Dwivedi int old_fd = fd, saved_errno; 473549a6323SKumar Kartikeya Dwivedi 474549a6323SKumar Kartikeya Dwivedi if (fd < 0) 475549a6323SKumar Kartikeya Dwivedi return fd; 476549a6323SKumar Kartikeya Dwivedi if (fd < 3) { 477549a6323SKumar Kartikeya Dwivedi fd = fcntl(fd, F_DUPFD_CLOEXEC, 3); 478549a6323SKumar Kartikeya Dwivedi saved_errno = errno; 479549a6323SKumar Kartikeya Dwivedi close(old_fd); 480549a6323SKumar Kartikeya Dwivedi if (fd < 0) { 481549a6323SKumar Kartikeya Dwivedi pr_warn("failed to dup FD %d to FD > 2: %d\n", old_fd, -saved_errno); 482549a6323SKumar Kartikeya Dwivedi errno = saved_errno; 483549a6323SKumar Kartikeya Dwivedi } 484549a6323SKumar Kartikeya Dwivedi } 485549a6323SKumar Kartikeya Dwivedi return fd; 486549a6323SKumar Kartikeya Dwivedi } 487549a6323SKumar Kartikeya Dwivedi 488d7c4b398SAndrii Nakryiko #endif /* __LIBBPF_LIBBPF_INTERNAL_H */ 489