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> 185c742725SJiri Olsa #include <libelf.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 24d6f7ff9dSJesus Sanchez-Palencia /* prevent accidental re-addition of reallocarray() */ 25d6f7ff9dSJesus Sanchez-Palencia #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 9520eccf29SAndrii Nakryiko #ifndef __alias 9620eccf29SAndrii Nakryiko #define __alias(symbol) __attribute__((alias(#symbol))) 9720eccf29SAndrii Nakryiko #endif 98d7fe74f9SAndrii Nakryiko 9913d35a0cSAndrii Nakryiko /* Check whether a string `str` has prefix `pfx`, regardless if `pfx` is 10013d35a0cSAndrii Nakryiko * a string literal known at compilation time or char * pointer known only at 10113d35a0cSAndrii Nakryiko * runtime. 10213d35a0cSAndrii Nakryiko */ 10313d35a0cSAndrii Nakryiko #define str_has_pfx(str, pfx) \ 10413d35a0cSAndrii Nakryiko (strncmp(str, pfx, __builtin_constant_p(pfx) ? sizeof(pfx) - 1 : strlen(pfx)) == 0) 10513d35a0cSAndrii Nakryiko 106a1c9d61bSAlan Maguire /* suffix check */ 107a1c9d61bSAlan Maguire static inline bool str_has_sfx(const char *str, const char *sfx) 108a1c9d61bSAlan Maguire { 109a1c9d61bSAlan Maguire size_t str_len = strlen(str); 110a1c9d61bSAlan Maguire size_t sfx_len = strlen(sfx); 111a1c9d61bSAlan Maguire 11214229b81SDan Carpenter if (sfx_len > str_len) 113a1c9d61bSAlan Maguire return false; 11414229b81SDan Carpenter return strcmp(str + str_len - sfx_len, sfx) == 0; 115a1c9d61bSAlan Maguire } 116a1c9d61bSAlan Maguire 1171bd63524SYonghong Song /* Symbol versioning is different between static and shared library. 1181bd63524SYonghong Song * Properly versioned symbols are needed for shared library, but 1191bd63524SYonghong Song * only the symbol of the new version is needed for static library. 120006a5099SAndrii Nakryiko * Starting with GNU C 10, use symver attribute instead of .symver assembler 121006a5099SAndrii Nakryiko * directive, which works better with GCC LTO builds. 1221bd63524SYonghong Song */ 123006a5099SAndrii Nakryiko #if defined(SHARED) && defined(__GNUC__) && __GNUC__ >= 10 124006a5099SAndrii Nakryiko 125006a5099SAndrii Nakryiko #define DEFAULT_VERSION(internal_name, api_name, version) \ 126006a5099SAndrii Nakryiko __attribute__((symver(#api_name "@@" #version))) 127006a5099SAndrii Nakryiko #define COMPAT_VERSION(internal_name, api_name, version) \ 128006a5099SAndrii Nakryiko __attribute__((symver(#api_name "@" #version))) 129006a5099SAndrii Nakryiko 130006a5099SAndrii Nakryiko #elif defined(SHARED) 131006a5099SAndrii Nakryiko 1321bd63524SYonghong Song #define COMPAT_VERSION(internal_name, api_name, version) \ 1331bd63524SYonghong Song asm(".symver " #internal_name "," #api_name "@" #version); 1341bd63524SYonghong Song #define DEFAULT_VERSION(internal_name, api_name, version) \ 1351bd63524SYonghong Song asm(".symver " #internal_name "," #api_name "@@" #version); 136006a5099SAndrii Nakryiko 137006a5099SAndrii Nakryiko #else /* !SHARED */ 138006a5099SAndrii Nakryiko 1391bd63524SYonghong Song #define COMPAT_VERSION(internal_name, api_name, version) 1401bd63524SYonghong Song #define DEFAULT_VERSION(internal_name, api_name, version) \ 1411bd63524SYonghong Song extern typeof(internal_name) api_name \ 1421bd63524SYonghong Song __attribute__((alias(#internal_name))); 143006a5099SAndrii Nakryiko 1441bd63524SYonghong Song #endif 1451bd63524SYonghong Song 146d72386feSAndrii Nakryiko extern void libbpf_print(enum libbpf_print_level level, 147d72386feSAndrii Nakryiko const char *format, ...) 148d72386feSAndrii Nakryiko __attribute__((format(printf, 2, 3))); 149d72386feSAndrii Nakryiko 150d72386feSAndrii Nakryiko #define __pr(level, fmt, ...) \ 151d72386feSAndrii Nakryiko do { \ 152d72386feSAndrii Nakryiko libbpf_print(level, "libbpf: " fmt, ##__VA_ARGS__); \ 153d72386feSAndrii Nakryiko } while (0) 154d72386feSAndrii Nakryiko 155be18010eSKefeng Wang #define pr_warn(fmt, ...) __pr(LIBBPF_WARN, fmt, ##__VA_ARGS__) 156d72386feSAndrii Nakryiko #define pr_info(fmt, ...) __pr(LIBBPF_INFO, fmt, ##__VA_ARGS__) 157d72386feSAndrii Nakryiko #define pr_debug(fmt, ...) __pr(LIBBPF_DEBUG, fmt, ##__VA_ARGS__) 158d72386feSAndrii Nakryiko 159dda1ec9fSAndrii Nakryiko #ifndef __has_builtin 160dda1ec9fSAndrii Nakryiko #define __has_builtin(x) 0 161dda1ec9fSAndrii Nakryiko #endif 1622e4913e0SAndrii Nakryiko 1632e4913e0SAndrii Nakryiko struct bpf_link { 1642e4913e0SAndrii Nakryiko int (*detach)(struct bpf_link *link); 1652e4913e0SAndrii Nakryiko void (*dealloc)(struct bpf_link *link); 1662e4913e0SAndrii Nakryiko char *pin_path; /* NULL, if not pinned */ 1672e4913e0SAndrii Nakryiko int fd; /* hook FD, -1 if not applicable */ 1682e4913e0SAndrii Nakryiko bool disconnected; 1692e4913e0SAndrii Nakryiko }; 1702e4913e0SAndrii Nakryiko 171029258d7SAndrii Nakryiko /* 172029258d7SAndrii Nakryiko * Re-implement glibc's reallocarray() for libbpf internal-only use. 173029258d7SAndrii Nakryiko * reallocarray(), unfortunately, is not available in all versions of glibc, 174029258d7SAndrii Nakryiko * so requires extra feature detection and using reallocarray() stub from 175029258d7SAndrii Nakryiko * <tools/libc_compat.h> and COMPAT_NEED_REALLOCARRAY. All this complicates 176029258d7SAndrii Nakryiko * build of libbpf unnecessarily and is just a maintenance burden. Instead, 177029258d7SAndrii Nakryiko * it's trivial to implement libbpf-specific internal version and use it 178029258d7SAndrii Nakryiko * throughout libbpf. 179029258d7SAndrii Nakryiko */ 180029258d7SAndrii Nakryiko static inline void *libbpf_reallocarray(void *ptr, size_t nmemb, size_t size) 181029258d7SAndrii Nakryiko { 182029258d7SAndrii Nakryiko size_t total; 183029258d7SAndrii Nakryiko 184dda1ec9fSAndrii Nakryiko #if __has_builtin(__builtin_mul_overflow) 185029258d7SAndrii Nakryiko if (unlikely(__builtin_mul_overflow(nmemb, size, &total))) 186029258d7SAndrii Nakryiko return NULL; 187dda1ec9fSAndrii Nakryiko #else 188dda1ec9fSAndrii Nakryiko if (size == 0 || nmemb > ULONG_MAX / size) 189dda1ec9fSAndrii Nakryiko return NULL; 190dda1ec9fSAndrii Nakryiko total = nmemb * size; 191dda1ec9fSAndrii Nakryiko #endif 192029258d7SAndrii Nakryiko return realloc(ptr, total); 193029258d7SAndrii Nakryiko } 194029258d7SAndrii Nakryiko 1959fc205b4SAndrii Nakryiko /* Copy up to sz - 1 bytes from zero-terminated src string and ensure that dst 1969fc205b4SAndrii Nakryiko * is zero-terminated string no matter what (unless sz == 0, in which case 1979fc205b4SAndrii Nakryiko * it's a no-op). It's conceptually close to FreeBSD's strlcpy(), but differs 1989fc205b4SAndrii Nakryiko * in what is returned. Given this is internal helper, it's trivial to extend 1999fc205b4SAndrii Nakryiko * this, when necessary. Use this instead of strncpy inside libbpf source code. 2009fc205b4SAndrii Nakryiko */ 2019fc205b4SAndrii Nakryiko static inline void libbpf_strlcpy(char *dst, const char *src, size_t sz) 2029fc205b4SAndrii Nakryiko { 2039fc205b4SAndrii Nakryiko size_t i; 2049fc205b4SAndrii Nakryiko 2059fc205b4SAndrii Nakryiko if (sz == 0) 2069fc205b4SAndrii Nakryiko return; 2079fc205b4SAndrii Nakryiko 2089fc205b4SAndrii Nakryiko sz--; 2099fc205b4SAndrii Nakryiko for (i = 0; i < sz && src[i]; i++) 2109fc205b4SAndrii Nakryiko dst[i] = src[i]; 2119fc205b4SAndrii Nakryiko dst[i] = '\0'; 2129fc205b4SAndrii Nakryiko } 2139fc205b4SAndrii Nakryiko 2145b3d7298SAndrii Nakryiko __u32 get_kernel_version(void); 2155b3d7298SAndrii Nakryiko 216e14ef4bfSAndrii Nakryiko struct btf; 217e14ef4bfSAndrii Nakryiko struct btf_type; 218e14ef4bfSAndrii Nakryiko 21974753e14SAlexei Starovoitov struct btf_type *btf_type_by_id(const struct btf *btf, __u32 type_id); 22042869d28SAndrii Nakryiko const char *btf_kind_str(const struct btf_type *t); 22142869d28SAndrii Nakryiko const struct btf_type *skip_mods_and_typedefs(const struct btf *btf, __u32 id, __u32 *res_id); 22242869d28SAndrii Nakryiko 22342869d28SAndrii Nakryiko static inline enum btf_func_linkage btf_func_linkage(const struct btf_type *t) 22442869d28SAndrii Nakryiko { 22542869d28SAndrii Nakryiko return (enum btf_func_linkage)(int)btf_vlen(t); 22642869d28SAndrii Nakryiko } 227e14ef4bfSAndrii Nakryiko 228aea28a60SAndrii Nakryiko static inline __u32 btf_type_info(int kind, int vlen, int kflag) 229aea28a60SAndrii Nakryiko { 230aea28a60SAndrii Nakryiko return (kflag << 31) | (kind << 24) | vlen; 231aea28a60SAndrii Nakryiko } 232aea28a60SAndrii Nakryiko 233c7ef5ec9SAndrii Nakryiko enum map_def_parts { 234c7ef5ec9SAndrii Nakryiko MAP_DEF_MAP_TYPE = 0x001, 235c7ef5ec9SAndrii Nakryiko MAP_DEF_KEY_TYPE = 0x002, 236c7ef5ec9SAndrii Nakryiko MAP_DEF_KEY_SIZE = 0x004, 237c7ef5ec9SAndrii Nakryiko MAP_DEF_VALUE_TYPE = 0x008, 238c7ef5ec9SAndrii Nakryiko MAP_DEF_VALUE_SIZE = 0x010, 239c7ef5ec9SAndrii Nakryiko MAP_DEF_MAX_ENTRIES = 0x020, 240c7ef5ec9SAndrii Nakryiko MAP_DEF_MAP_FLAGS = 0x040, 241c7ef5ec9SAndrii Nakryiko MAP_DEF_NUMA_NODE = 0x080, 242c7ef5ec9SAndrii Nakryiko MAP_DEF_PINNING = 0x100, 243c7ef5ec9SAndrii Nakryiko MAP_DEF_INNER_MAP = 0x200, 24447512102SJoanne Koong MAP_DEF_MAP_EXTRA = 0x400, 245c7ef5ec9SAndrii Nakryiko 24647512102SJoanne Koong MAP_DEF_ALL = 0x7ff, /* combination of all above */ 247c7ef5ec9SAndrii Nakryiko }; 248c7ef5ec9SAndrii Nakryiko 249c7ef5ec9SAndrii Nakryiko struct btf_map_def { 250c7ef5ec9SAndrii Nakryiko enum map_def_parts parts; 251c7ef5ec9SAndrii Nakryiko __u32 map_type; 252c7ef5ec9SAndrii Nakryiko __u32 key_type_id; 253c7ef5ec9SAndrii Nakryiko __u32 key_size; 254c7ef5ec9SAndrii Nakryiko __u32 value_type_id; 255c7ef5ec9SAndrii Nakryiko __u32 value_size; 256c7ef5ec9SAndrii Nakryiko __u32 max_entries; 257c7ef5ec9SAndrii Nakryiko __u32 map_flags; 258c7ef5ec9SAndrii Nakryiko __u32 numa_node; 259c7ef5ec9SAndrii Nakryiko __u32 pinning; 26047512102SJoanne Koong __u64 map_extra; 261c7ef5ec9SAndrii Nakryiko }; 262c7ef5ec9SAndrii Nakryiko 263c7ef5ec9SAndrii Nakryiko int parse_btf_map_def(const char *map_name, struct btf *btf, 264c7ef5ec9SAndrii Nakryiko const struct btf_type *def_t, bool strict, 265c7ef5ec9SAndrii Nakryiko struct btf_map_def *map_def, struct btf_map_def *inner_def); 266c7ef5ec9SAndrii Nakryiko 2673b029e06SAndrii Nakryiko void *libbpf_add_mem(void **data, size_t *cap_cnt, size_t elem_sz, 268192f5a1fSAndrii Nakryiko size_t cur_cnt, size_t max_cnt, size_t add_cnt); 2693b029e06SAndrii Nakryiko int libbpf_ensure_mem(void **data, size_t *cap_cnt, size_t elem_sz, size_t need_cnt); 270192f5a1fSAndrii Nakryiko 2713ec84f4bSAndrii Nakryiko static inline bool libbpf_is_mem_zeroed(const char *p, ssize_t len) 2723ec84f4bSAndrii Nakryiko { 2733ec84f4bSAndrii Nakryiko while (len > 0) { 2743ec84f4bSAndrii Nakryiko if (*p) 2753ec84f4bSAndrii Nakryiko return false; 2763ec84f4bSAndrii Nakryiko p++; 2773ec84f4bSAndrii Nakryiko len--; 2783ec84f4bSAndrii Nakryiko } 2793ec84f4bSAndrii Nakryiko return true; 2803ec84f4bSAndrii Nakryiko } 2813ec84f4bSAndrii Nakryiko 2822ce8450eSAndrii Nakryiko static inline bool libbpf_validate_opts(const char *opts, 2832ce8450eSAndrii Nakryiko size_t opts_sz, size_t user_sz, 2842ce8450eSAndrii Nakryiko const char *type_name) 2852ce8450eSAndrii Nakryiko { 2862ce8450eSAndrii Nakryiko if (user_sz < sizeof(size_t)) { 287be18010eSKefeng Wang pr_warn("%s size (%zu) is too small\n", type_name, user_sz); 2882ce8450eSAndrii Nakryiko return false; 2892ce8450eSAndrii Nakryiko } 2903ec84f4bSAndrii Nakryiko if (!libbpf_is_mem_zeroed(opts + opts_sz, (ssize_t)user_sz - opts_sz)) { 2913ec84f4bSAndrii Nakryiko pr_warn("%s has non-zero extra bytes\n", type_name); 2922ce8450eSAndrii Nakryiko return false; 2932ce8450eSAndrii Nakryiko } 2942ce8450eSAndrii Nakryiko return true; 2952ce8450eSAndrii Nakryiko } 2962ce8450eSAndrii Nakryiko 2972ce8450eSAndrii Nakryiko #define OPTS_VALID(opts, type) \ 2982ce8450eSAndrii Nakryiko (!(opts) || libbpf_validate_opts((const char *)opts, \ 2992ce8450eSAndrii Nakryiko offsetofend(struct type, \ 3002ce8450eSAndrii Nakryiko type##__last_field), \ 3012ce8450eSAndrii Nakryiko (opts)->sz, #type)) 3022ce8450eSAndrii Nakryiko #define OPTS_HAS(opts, field) \ 3032ce8450eSAndrii Nakryiko ((opts) && opts->sz >= offsetofend(typeof(*(opts)), field)) 3042ce8450eSAndrii Nakryiko #define OPTS_GET(opts, field, fallback_value) \ 3052ce8450eSAndrii Nakryiko (OPTS_HAS(opts, field) ? (opts)->field : fallback_value) 30688f7fe72SSong Liu #define OPTS_SET(opts, field, value) \ 30788f7fe72SSong Liu do { \ 30888f7fe72SSong Liu if (OPTS_HAS(opts, field)) \ 30988f7fe72SSong Liu (opts)->field = value; \ 31088f7fe72SSong Liu } while (0) 3112ce8450eSAndrii Nakryiko 3123ec84f4bSAndrii Nakryiko #define OPTS_ZEROED(opts, last_nonzero_field) \ 3133ec84f4bSAndrii Nakryiko ({ \ 3143ec84f4bSAndrii Nakryiko ssize_t __off = offsetofend(typeof(*(opts)), last_nonzero_field); \ 3153ec84f4bSAndrii Nakryiko !(opts) || libbpf_is_mem_zeroed((const void *)opts + __off, \ 3163ec84f4bSAndrii Nakryiko (opts)->sz - __off); \ 3173ec84f4bSAndrii Nakryiko }) 3183ec84f4bSAndrii Nakryiko 319e542f2c4SAndrii Nakryiko enum kern_feature_id { 320e542f2c4SAndrii Nakryiko /* v4.14: kernel support for program & map names. */ 321e542f2c4SAndrii Nakryiko FEAT_PROG_NAME, 322e542f2c4SAndrii Nakryiko /* v5.2: kernel support for global data sections. */ 323e542f2c4SAndrii Nakryiko FEAT_GLOBAL_DATA, 324e542f2c4SAndrii Nakryiko /* BTF support */ 325e542f2c4SAndrii Nakryiko FEAT_BTF, 326e542f2c4SAndrii Nakryiko /* BTF_KIND_FUNC and BTF_KIND_FUNC_PROTO support */ 327e542f2c4SAndrii Nakryiko FEAT_BTF_FUNC, 328e542f2c4SAndrii Nakryiko /* BTF_KIND_VAR and BTF_KIND_DATASEC support */ 329e542f2c4SAndrii Nakryiko FEAT_BTF_DATASEC, 330e542f2c4SAndrii Nakryiko /* BTF_FUNC_GLOBAL is supported */ 331e542f2c4SAndrii Nakryiko FEAT_BTF_GLOBAL_FUNC, 332e542f2c4SAndrii Nakryiko /* BPF_F_MMAPABLE is supported for arrays */ 333e542f2c4SAndrii Nakryiko FEAT_ARRAY_MMAP, 334e542f2c4SAndrii Nakryiko /* kernel support for expected_attach_type in BPF_PROG_LOAD */ 335e542f2c4SAndrii Nakryiko FEAT_EXP_ATTACH_TYPE, 336e542f2c4SAndrii Nakryiko /* bpf_probe_read_{kernel,user}[_str] helpers */ 337e542f2c4SAndrii Nakryiko FEAT_PROBE_READ_KERN, 338e542f2c4SAndrii Nakryiko /* BPF_PROG_BIND_MAP is supported */ 339e542f2c4SAndrii Nakryiko FEAT_PROG_BIND_MAP, 340e542f2c4SAndrii Nakryiko /* Kernel support for module BTFs */ 341e542f2c4SAndrii Nakryiko FEAT_MODULE_BTF, 342e542f2c4SAndrii Nakryiko /* BTF_KIND_FLOAT support */ 343e542f2c4SAndrii Nakryiko FEAT_BTF_FLOAT, 344e542f2c4SAndrii Nakryiko /* BPF perf link support */ 345e542f2c4SAndrii Nakryiko FEAT_PERF_LINK, 346e542f2c4SAndrii Nakryiko /* BTF_KIND_DECL_TAG support */ 347e542f2c4SAndrii Nakryiko FEAT_BTF_DECL_TAG, 348e542f2c4SAndrii Nakryiko /* BTF_KIND_TYPE_TAG support */ 349e542f2c4SAndrii Nakryiko FEAT_BTF_TYPE_TAG, 350e542f2c4SAndrii Nakryiko /* memcg-based accounting for BPF maps and progs */ 351e542f2c4SAndrii Nakryiko FEAT_MEMCG_ACCOUNT, 3522e4913e0SAndrii Nakryiko /* BPF cookie (bpf_get_attach_cookie() BPF helper) support */ 3532e4913e0SAndrii Nakryiko FEAT_BPF_COOKIE, 354f2a62588SYonghong Song /* BTF_KIND_ENUM64 support and BTF_KIND_ENUM kflag support */ 355f2a62588SYonghong Song FEAT_BTF_ENUM64, 356708ac5beSAndrii Nakryiko /* Kernel uses syscall wrapper (CONFIG_ARCH_HAS_SYSCALL_WRAPPER) */ 357708ac5beSAndrii Nakryiko FEAT_SYSCALL_WRAPPER, 358e542f2c4SAndrii Nakryiko __FEAT_CNT, 359e542f2c4SAndrii Nakryiko }; 360e542f2c4SAndrii Nakryiko 361e542f2c4SAndrii Nakryiko int probe_memcg_account(void); 362e542f2c4SAndrii Nakryiko bool kernel_supports(const struct bpf_object *obj, enum kern_feature_id feat_id); 363e542f2c4SAndrii Nakryiko int bump_rlimit_memlock(void); 3643ec84f4bSAndrii Nakryiko 3656803ee25SAndrii Nakryiko int parse_cpu_mask_str(const char *s, bool **mask, int *mask_sz); 3666803ee25SAndrii Nakryiko int parse_cpu_mask_file(const char *fcpu, bool **mask, int *mask_sz); 367cfd49210SMichal Rostecki int libbpf__load_raw_btf(const char *raw_types, size_t types_len, 368d7c4b398SAndrii Nakryiko const char *str_sec, size_t str_len); 3691a190d1eSAndrii Nakryiko int btf_load_into_kernel(struct btf *btf, char *log_buf, size_t log_sz, __u32 log_level); 370d7c4b398SAndrii Nakryiko 371a19f93cfSAndrii Nakryiko struct btf *btf_get_from_fd(int btf_fd, struct btf *base_btf); 37267234743SAlexei Starovoitov void btf_get_kernel_prefix_kind(enum bpf_attach_type attach_type, 37367234743SAlexei Starovoitov const char **prefix, int *kind); 374612d05beSAndrii Nakryiko 3754cedc0daSAndrii Nakryiko struct btf_ext_info { 3764cedc0daSAndrii Nakryiko /* 3774cedc0daSAndrii Nakryiko * info points to the individual info section (e.g. func_info and 3784cedc0daSAndrii Nakryiko * line_info) from the .BTF.ext. It does not include the __u32 rec_size. 3794cedc0daSAndrii Nakryiko */ 3804cedc0daSAndrii Nakryiko void *info; 3814cedc0daSAndrii Nakryiko __u32 rec_size; 3824cedc0daSAndrii Nakryiko __u32 len; 38311d5daa8SAndrii Nakryiko /* optional (maintained internally by libbpf) mapping between .BTF.ext 38411d5daa8SAndrii Nakryiko * section and corresponding ELF section. This is used to join 38511d5daa8SAndrii Nakryiko * information like CO-RE relocation records with corresponding BPF 38611d5daa8SAndrii Nakryiko * programs defined in ELF sections 38711d5daa8SAndrii Nakryiko */ 38811d5daa8SAndrii Nakryiko __u32 *sec_idxs; 38911d5daa8SAndrii Nakryiko int sec_cnt; 3904cedc0daSAndrii Nakryiko }; 3914cedc0daSAndrii Nakryiko 3924cedc0daSAndrii Nakryiko #define for_each_btf_ext_sec(seg, sec) \ 3934cedc0daSAndrii Nakryiko for (sec = (seg)->info; \ 3944cedc0daSAndrii Nakryiko (void *)sec < (seg)->info + (seg)->len; \ 3954cedc0daSAndrii Nakryiko sec = (void *)sec + sizeof(struct btf_ext_info_sec) + \ 3964cedc0daSAndrii Nakryiko (seg)->rec_size * sec->num_info) 3974cedc0daSAndrii Nakryiko 3984cedc0daSAndrii Nakryiko #define for_each_btf_ext_rec(seg, sec, i, rec) \ 3994cedc0daSAndrii Nakryiko for (i = 0, rec = (void *)&(sec)->data; \ 4004cedc0daSAndrii Nakryiko i < (sec)->num_info; \ 4014cedc0daSAndrii Nakryiko i++, rec = (void *)rec + (seg)->rec_size) 4024cedc0daSAndrii Nakryiko 40328b93c64SAndrii Nakryiko /* 40428b93c64SAndrii Nakryiko * The .BTF.ext ELF section layout defined as 40528b93c64SAndrii Nakryiko * struct btf_ext_header 40628b93c64SAndrii Nakryiko * func_info subsection 40728b93c64SAndrii Nakryiko * 40828b93c64SAndrii Nakryiko * The func_info subsection layout: 40928b93c64SAndrii Nakryiko * record size for struct bpf_func_info in the func_info subsection 41028b93c64SAndrii Nakryiko * struct btf_sec_func_info for section #1 41128b93c64SAndrii Nakryiko * a list of bpf_func_info records for section #1 41228b93c64SAndrii Nakryiko * where struct bpf_func_info mimics one in include/uapi/linux/bpf.h 41328b93c64SAndrii Nakryiko * but may not be identical 41428b93c64SAndrii Nakryiko * struct btf_sec_func_info for section #2 41528b93c64SAndrii Nakryiko * a list of bpf_func_info records for section #2 41628b93c64SAndrii Nakryiko * ...... 41728b93c64SAndrii Nakryiko * 41828b93c64SAndrii Nakryiko * Note that the bpf_func_info record size in .BTF.ext may not 41928b93c64SAndrii Nakryiko * be the same as the one defined in include/uapi/linux/bpf.h. 42028b93c64SAndrii Nakryiko * The loader should ensure that record_size meets minimum 42128b93c64SAndrii Nakryiko * requirement and pass the record as is to the kernel. The 42228b93c64SAndrii Nakryiko * kernel will handle the func_info properly based on its contents. 42328b93c64SAndrii Nakryiko */ 42428b93c64SAndrii Nakryiko struct btf_ext_header { 42528b93c64SAndrii Nakryiko __u16 magic; 42628b93c64SAndrii Nakryiko __u8 version; 42728b93c64SAndrii Nakryiko __u8 flags; 42828b93c64SAndrii Nakryiko __u32 hdr_len; 42928b93c64SAndrii Nakryiko 43028b93c64SAndrii Nakryiko /* All offsets are in bytes relative to the end of this header */ 43128b93c64SAndrii Nakryiko __u32 func_info_off; 43228b93c64SAndrii Nakryiko __u32 func_info_len; 43328b93c64SAndrii Nakryiko __u32 line_info_off; 43428b93c64SAndrii Nakryiko __u32 line_info_len; 43528b93c64SAndrii Nakryiko 43628b93c64SAndrii Nakryiko /* optional part of .BTF.ext header */ 43728b93c64SAndrii Nakryiko __u32 core_relo_off; 43828b93c64SAndrii Nakryiko __u32 core_relo_len; 43928b93c64SAndrii Nakryiko }; 44028b93c64SAndrii Nakryiko 4414cedc0daSAndrii Nakryiko struct btf_ext { 4424cedc0daSAndrii Nakryiko union { 4434cedc0daSAndrii Nakryiko struct btf_ext_header *hdr; 4444cedc0daSAndrii Nakryiko void *data; 4454cedc0daSAndrii Nakryiko }; 4464cedc0daSAndrii Nakryiko struct btf_ext_info func_info; 4474cedc0daSAndrii Nakryiko struct btf_ext_info line_info; 44828b93c64SAndrii Nakryiko struct btf_ext_info core_relo_info; 4494cedc0daSAndrii Nakryiko __u32 data_size; 4504cedc0daSAndrii Nakryiko }; 4514cedc0daSAndrii Nakryiko 4524cedc0daSAndrii Nakryiko struct btf_ext_info_sec { 4534cedc0daSAndrii Nakryiko __u32 sec_name_off; 4544cedc0daSAndrii Nakryiko __u32 num_info; 4554cedc0daSAndrii Nakryiko /* Followed by num_info * record_size number of bytes */ 456385bbf7bSGustavo A. R. Silva __u8 data[]; 4574cedc0daSAndrii Nakryiko }; 4584cedc0daSAndrii Nakryiko 4594cedc0daSAndrii Nakryiko /* The minimum bpf_func_info checked by the loader */ 4604cedc0daSAndrii Nakryiko struct bpf_func_info_min { 4614cedc0daSAndrii Nakryiko __u32 insn_off; 4624cedc0daSAndrii Nakryiko __u32 type_id; 4634cedc0daSAndrii Nakryiko }; 4644cedc0daSAndrii Nakryiko 4654cedc0daSAndrii Nakryiko /* The minimum bpf_line_info checked by the loader */ 4664cedc0daSAndrii Nakryiko struct bpf_line_info_min { 4674cedc0daSAndrii Nakryiko __u32 insn_off; 4684cedc0daSAndrii Nakryiko __u32 file_name_off; 4694cedc0daSAndrii Nakryiko __u32 line_off; 4704cedc0daSAndrii Nakryiko __u32 line_col; 4714cedc0daSAndrii Nakryiko }; 4724cedc0daSAndrii Nakryiko 4734cedc0daSAndrii Nakryiko 474f36e99a4SAndrii Nakryiko typedef int (*type_id_visit_fn)(__u32 *type_id, void *ctx); 475f36e99a4SAndrii Nakryiko typedef int (*str_off_visit_fn)(__u32 *str_off, void *ctx); 476f36e99a4SAndrii Nakryiko int btf_type_visit_type_ids(struct btf_type *t, type_id_visit_fn visit, void *ctx); 477f36e99a4SAndrii Nakryiko int btf_type_visit_str_offs(struct btf_type *t, str_off_visit_fn visit, void *ctx); 478f36e99a4SAndrii Nakryiko int btf_ext_visit_type_ids(struct btf_ext *btf_ext, type_id_visit_fn visit, void *ctx); 479f36e99a4SAndrii Nakryiko int btf_ext_visit_str_offs(struct btf_ext *btf_ext, str_off_visit_fn visit, void *ctx); 4809dbe6015SKumar Kartikeya Dwivedi __s32 btf__find_by_name_kind_own(const struct btf *btf, const char *type_name, 4819dbe6015SKumar Kartikeya Dwivedi __u32 kind); 482f36e99a4SAndrii Nakryiko 48385153ac0SJiri Olsa typedef int (*kallsyms_cb_t)(unsigned long long sym_addr, char sym_type, 48485153ac0SJiri Olsa const char *sym_name, void *ctx); 48585153ac0SJiri Olsa 48685153ac0SJiri Olsa int libbpf_kallsyms_parse(kallsyms_cb_t cb, void *arg); 48785153ac0SJiri Olsa 488f12b6543SAndrii Nakryiko /* handle direct returned errors */ 489f12b6543SAndrii Nakryiko static inline int libbpf_err(int ret) 490f12b6543SAndrii Nakryiko { 491f12b6543SAndrii Nakryiko if (ret < 0) 492f12b6543SAndrii Nakryiko errno = -ret; 493f12b6543SAndrii Nakryiko return ret; 494f12b6543SAndrii Nakryiko } 495f12b6543SAndrii Nakryiko 496f12b6543SAndrii Nakryiko /* handle errno-based (e.g., syscall or libc) errors according to libbpf's 497f12b6543SAndrii Nakryiko * strict mode settings 498f12b6543SAndrii Nakryiko */ 499f12b6543SAndrii Nakryiko static inline int libbpf_err_errno(int ret) 500f12b6543SAndrii Nakryiko { 501f12b6543SAndrii Nakryiko /* errno is already assumed to be set on error */ 502f12b6543SAndrii Nakryiko return ret < 0 ? -errno : ret; 503f12b6543SAndrii Nakryiko } 504f12b6543SAndrii Nakryiko 505e9fc3ce9SAndrii Nakryiko /* handle error for pointer-returning APIs, err is assumed to be < 0 always */ 506e9fc3ce9SAndrii Nakryiko static inline void *libbpf_err_ptr(int err) 507e9fc3ce9SAndrii Nakryiko { 508e9fc3ce9SAndrii Nakryiko /* set errno on error, this doesn't break anything */ 509e9fc3ce9SAndrii Nakryiko errno = -err; 510e9fc3ce9SAndrii Nakryiko return NULL; 511e9fc3ce9SAndrii Nakryiko } 512e9fc3ce9SAndrii Nakryiko 513e9fc3ce9SAndrii Nakryiko /* handle pointer-returning APIs' error handling */ 514e9fc3ce9SAndrii Nakryiko static inline void *libbpf_ptr(void *ret) 515e9fc3ce9SAndrii Nakryiko { 516e9fc3ce9SAndrii Nakryiko /* set errno on error, this doesn't break anything */ 517e9fc3ce9SAndrii Nakryiko if (IS_ERR(ret)) 518e9fc3ce9SAndrii Nakryiko errno = -PTR_ERR(ret); 519e9fc3ce9SAndrii Nakryiko 520e9fc3ce9SAndrii Nakryiko return IS_ERR(ret) ? NULL : ret; 521e9fc3ce9SAndrii Nakryiko } 522e9fc3ce9SAndrii Nakryiko 523b0588390SAlexei Starovoitov static inline bool str_is_empty(const char *s) 524b0588390SAlexei Starovoitov { 525b0588390SAlexei Starovoitov return !s || !s[0]; 526b0588390SAlexei Starovoitov } 527b0588390SAlexei Starovoitov 528b0588390SAlexei Starovoitov static inline bool is_ldimm64_insn(struct bpf_insn *insn) 529b0588390SAlexei Starovoitov { 530b0588390SAlexei Starovoitov return insn->code == (BPF_LD | BPF_IMM | BPF_DW); 531b0588390SAlexei Starovoitov } 532b0588390SAlexei Starovoitov 533549a6323SKumar Kartikeya Dwivedi /* if fd is stdin, stdout, or stderr, dup to a fd greater than 2 534549a6323SKumar Kartikeya Dwivedi * Takes ownership of the fd passed in, and closes it if calling 535549a6323SKumar Kartikeya Dwivedi * fcntl(fd, F_DUPFD_CLOEXEC, 3). 536549a6323SKumar Kartikeya Dwivedi */ 537549a6323SKumar Kartikeya Dwivedi static inline int ensure_good_fd(int fd) 538549a6323SKumar Kartikeya Dwivedi { 539549a6323SKumar Kartikeya Dwivedi int old_fd = fd, saved_errno; 540549a6323SKumar Kartikeya Dwivedi 541549a6323SKumar Kartikeya Dwivedi if (fd < 0) 542549a6323SKumar Kartikeya Dwivedi return fd; 543549a6323SKumar Kartikeya Dwivedi if (fd < 3) { 544549a6323SKumar Kartikeya Dwivedi fd = fcntl(fd, F_DUPFD_CLOEXEC, 3); 545549a6323SKumar Kartikeya Dwivedi saved_errno = errno; 546549a6323SKumar Kartikeya Dwivedi close(old_fd); 547549a6323SKumar Kartikeya Dwivedi errno = saved_errno; 548bb5747cfSAlexei Starovoitov if (fd < 0) { 54907453245SXin Liu pr_warn("failed to dup FD %d to FD > 2: %d\n", old_fd, -saved_errno); 550bb5747cfSAlexei Starovoitov errno = saved_errno; 551bb5747cfSAlexei Starovoitov } 552549a6323SKumar Kartikeya Dwivedi } 553549a6323SKumar Kartikeya Dwivedi return fd; 554549a6323SKumar Kartikeya Dwivedi } 555549a6323SKumar Kartikeya Dwivedi 5568de6cae4SMauricio Vásquez /* The following two functions are exposed to bpftool */ 5578de6cae4SMauricio Vásquez int bpf_core_add_cands(struct bpf_core_cand *local_cand, 5588de6cae4SMauricio Vásquez size_t local_essent_len, 5598de6cae4SMauricio Vásquez const struct btf *targ_btf, 5608de6cae4SMauricio Vásquez const char *targ_btf_name, 5618de6cae4SMauricio Vásquez int targ_start_id, 5628de6cae4SMauricio Vásquez struct bpf_core_cand_list *cands); 5638de6cae4SMauricio Vásquez void bpf_core_free_cands(struct bpf_core_cand_list *cands); 5648de6cae4SMauricio Vásquez 5652e4913e0SAndrii Nakryiko struct usdt_manager *usdt_manager_new(struct bpf_object *obj); 5662e4913e0SAndrii Nakryiko void usdt_manager_free(struct usdt_manager *man); 5672e4913e0SAndrii Nakryiko struct bpf_link * usdt_manager_attach_usdt(struct usdt_manager *man, 5682e4913e0SAndrii Nakryiko const struct bpf_program *prog, 5692e4913e0SAndrii Nakryiko pid_t pid, const char *path, 5702e4913e0SAndrii Nakryiko const char *usdt_provider, const char *usdt_name, 5715af25a41SPu Lehui __u64 usdt_cookie); 5722e4913e0SAndrii Nakryiko 573611edf1bSYuze Chi static inline bool is_pow_of_2(size_t x) 574611edf1bSYuze Chi { 575611edf1bSYuze Chi return x && (x & (x - 1)) == 0; 576611edf1bSYuze Chi } 577611edf1bSYuze Chi 5781f235777SHangbin Liu #define PROG_LOAD_ATTEMPTS 5 5791f235777SHangbin Liu int sys_bpf_prog_load(union bpf_attr *attr, unsigned int size, int attempts); 5801f235777SHangbin Liu 581*e613d1d0SJiri Olsa bool glob_match(const char *str, const char *pat); 582*e613d1d0SJiri Olsa 5835c742725SJiri Olsa long elf_find_func_offset(Elf *elf, const char *binary_path, const char *name); 5845c742725SJiri Olsa long elf_find_func_offset_from_file(const char *binary_path, const char *name); 5855c742725SJiri Olsa 586f90eb70dSJiri Olsa struct elf_fd { 587f90eb70dSJiri Olsa Elf *elf; 588f90eb70dSJiri Olsa int fd; 589f90eb70dSJiri Olsa }; 590f90eb70dSJiri Olsa 591f90eb70dSJiri Olsa int elf_open(const char *binary_path, struct elf_fd *elf_fd); 592f90eb70dSJiri Olsa void elf_close(struct elf_fd *elf_fd); 593f90eb70dSJiri Olsa 5947ace84c6SJiri Olsa int elf_resolve_syms_offsets(const char *binary_path, int cnt, 5957ace84c6SJiri Olsa const char **syms, unsigned long **poffsets); 596*e613d1d0SJiri Olsa int elf_resolve_pattern_offsets(const char *binary_path, const char *pattern, 597*e613d1d0SJiri Olsa unsigned long **poffsets, size_t *pcnt); 598*e613d1d0SJiri Olsa 599d7c4b398SAndrii Nakryiko #endif /* __LIBBPF_LIBBPF_INTERNAL_H */ 600