xref: /openbmc/linux/tools/lib/bpf/btf.c (revision 2dc1e488)
11bc38b8fSAlexei Starovoitov // SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
28a138aedSMartin KaFai Lau /* Copyright (c) 2018 Facebook */
38a138aedSMartin KaFai Lau 
43289959bSAndrii Nakryiko #include <byteswap.h>
5cdb2f920SArnaldo Carvalho de Melo #include <endian.h>
696408c43SYonghong Song #include <stdio.h>
78a138aedSMartin KaFai Lau #include <stdlib.h>
88a138aedSMartin KaFai Lau #include <string.h>
9e6c64855SAndrii Nakryiko #include <fcntl.h>
108a138aedSMartin KaFai Lau #include <unistd.h>
118a138aedSMartin KaFai Lau #include <errno.h>
12fb2426adSMartin KaFai Lau #include <sys/utsname.h>
13fb2426adSMartin KaFai Lau #include <sys/param.h>
14fb2426adSMartin KaFai Lau #include <sys/stat.h>
15fb2426adSMartin KaFai Lau #include <linux/kernel.h>
168a138aedSMartin KaFai Lau #include <linux/err.h>
178a138aedSMartin KaFai Lau #include <linux/btf.h>
18e6c64855SAndrii Nakryiko #include <gelf.h>
198a138aedSMartin KaFai Lau #include "btf.h"
208a138aedSMartin KaFai Lau #include "bpf.h"
218461ef8bSYonghong Song #include "libbpf.h"
22d72386feSAndrii Nakryiko #include "libbpf_internal.h"
232fc3fc0bSAndrii Nakryiko #include "hashmap.h"
2490d76d3eSAndrii Nakryiko #include "strset.h"
258a138aedSMartin KaFai Lau 
26fb2426adSMartin KaFai Lau #define BTF_MAX_NR_TYPES 0x7fffffffU
27fb2426adSMartin KaFai Lau #define BTF_MAX_STR_OFFSET 0x7fffffffU
288a138aedSMartin KaFai Lau 
298a138aedSMartin KaFai Lau static struct btf_type btf_void;
308a138aedSMartin KaFai Lau 
318a138aedSMartin KaFai Lau struct btf {
323289959bSAndrii Nakryiko 	/* raw BTF data in native endianness */
33b8604247SAndrii Nakryiko 	void *raw_data;
343289959bSAndrii Nakryiko 	/* raw BTF data in non-native endianness */
353289959bSAndrii Nakryiko 	void *raw_data_swapped;
36b8604247SAndrii Nakryiko 	__u32 raw_size;
373289959bSAndrii Nakryiko 	/* whether target endianness differs from the native one */
383289959bSAndrii Nakryiko 	bool swapped_endian;
39b8604247SAndrii Nakryiko 
40b8604247SAndrii Nakryiko 	/*
419141f75aSAndrii Nakryiko 	 * When BTF is loaded from an ELF or raw memory it is stored
429141f75aSAndrii Nakryiko 	 * in a contiguous memory block. The hdr, type_data, and, strs_data
439141f75aSAndrii Nakryiko 	 * point inside that memory region to their respective parts of BTF
449141f75aSAndrii Nakryiko 	 * representation:
45b8604247SAndrii Nakryiko 	 *
46b8604247SAndrii Nakryiko 	 * +--------------------------------+
47b8604247SAndrii Nakryiko 	 * |  Header  |  Types  |  Strings  |
48b8604247SAndrii Nakryiko 	 * +--------------------------------+
49b8604247SAndrii Nakryiko 	 * ^          ^         ^
50b8604247SAndrii Nakryiko 	 * |          |         |
51b8604247SAndrii Nakryiko 	 * hdr        |         |
52b8604247SAndrii Nakryiko 	 * types_data-+         |
53b8604247SAndrii Nakryiko 	 * strs_data------------+
54919d2b1dSAndrii Nakryiko 	 *
55919d2b1dSAndrii Nakryiko 	 * If BTF data is later modified, e.g., due to types added or
56919d2b1dSAndrii Nakryiko 	 * removed, BTF deduplication performed, etc, this contiguous
57919d2b1dSAndrii Nakryiko 	 * representation is broken up into three independently allocated
58919d2b1dSAndrii Nakryiko 	 * memory regions to be able to modify them independently.
59919d2b1dSAndrii Nakryiko 	 * raw_data is nulled out at that point, but can be later allocated
606a886de0SHengqi Chen 	 * and cached again if user calls btf__raw_data(), at which point
61919d2b1dSAndrii Nakryiko 	 * raw_data will contain a contiguous copy of header, types, and
62919d2b1dSAndrii Nakryiko 	 * strings:
63919d2b1dSAndrii Nakryiko 	 *
64919d2b1dSAndrii Nakryiko 	 * +----------+  +---------+  +-----------+
65919d2b1dSAndrii Nakryiko 	 * |  Header  |  |  Types  |  |  Strings  |
66919d2b1dSAndrii Nakryiko 	 * +----------+  +---------+  +-----------+
67919d2b1dSAndrii Nakryiko 	 * ^             ^            ^
68919d2b1dSAndrii Nakryiko 	 * |             |            |
69919d2b1dSAndrii Nakryiko 	 * hdr           |            |
70919d2b1dSAndrii Nakryiko 	 * types_data----+            |
7190d76d3eSAndrii Nakryiko 	 * strset__data(strs_set)-----+
72919d2b1dSAndrii Nakryiko 	 *
73919d2b1dSAndrii Nakryiko 	 *               +----------+---------+-----------+
74919d2b1dSAndrii Nakryiko 	 *               |  Header  |  Types  |  Strings  |
75919d2b1dSAndrii Nakryiko 	 * raw_data----->+----------+---------+-----------+
76b8604247SAndrii Nakryiko 	 */
778a138aedSMartin KaFai Lau 	struct btf_header *hdr;
78919d2b1dSAndrii Nakryiko 
79b8604247SAndrii Nakryiko 	void *types_data;
80919d2b1dSAndrii Nakryiko 	size_t types_data_cap; /* used size stored in hdr->type_len */
81b8604247SAndrii Nakryiko 
82ba451366SAndrii Nakryiko 	/* type ID to `struct btf_type *` lookup index
83ba451366SAndrii Nakryiko 	 * type_offs[0] corresponds to the first non-VOID type:
84ba451366SAndrii Nakryiko 	 *   - for base BTF it's type [1];
85ba451366SAndrii Nakryiko 	 *   - for split BTF it's the first non-base BTF type.
86ba451366SAndrii Nakryiko 	 */
87740e69c3SAndrii Nakryiko 	__u32 *type_offs;
88192f5a1fSAndrii Nakryiko 	size_t type_offs_cap;
89ba451366SAndrii Nakryiko 	/* number of types in this BTF instance:
90ba451366SAndrii Nakryiko 	 *   - doesn't include special [0] void type;
91ba451366SAndrii Nakryiko 	 *   - for split BTF counts number of types added on top of base BTF.
92ba451366SAndrii Nakryiko 	 */
935b891af7SMartin KaFai Lau 	__u32 nr_types;
94ba451366SAndrii Nakryiko 	/* if not NULL, points to the base BTF on top of which the current
95ba451366SAndrii Nakryiko 	 * split BTF is based
96ba451366SAndrii Nakryiko 	 */
97ba451366SAndrii Nakryiko 	struct btf *base_btf;
98ba451366SAndrii Nakryiko 	/* BTF type ID of the first type in this BTF instance:
99ba451366SAndrii Nakryiko 	 *   - for base BTF it's equal to 1;
100ba451366SAndrii Nakryiko 	 *   - for split BTF it's equal to biggest type ID of base BTF plus 1.
101ba451366SAndrii Nakryiko 	 */
102ba451366SAndrii Nakryiko 	int start_id;
103ba451366SAndrii Nakryiko 	/* logical string offset of this BTF instance:
104ba451366SAndrii Nakryiko 	 *   - for base BTF it's equal to 0;
105ba451366SAndrii Nakryiko 	 *   - for split BTF it's equal to total size of base BTF's string section size.
106ba451366SAndrii Nakryiko 	 */
107ba451366SAndrii Nakryiko 	int start_str_off;
108b8604247SAndrii Nakryiko 
10990d76d3eSAndrii Nakryiko 	/* only one of strs_data or strs_set can be non-NULL, depending on
11090d76d3eSAndrii Nakryiko 	 * whether BTF is in a modifiable state (strs_set is used) or not
11190d76d3eSAndrii Nakryiko 	 * (strs_data points inside raw_data)
11290d76d3eSAndrii Nakryiko 	 */
113919d2b1dSAndrii Nakryiko 	void *strs_data;
11490d76d3eSAndrii Nakryiko 	/* a set of unique strings */
11590d76d3eSAndrii Nakryiko 	struct strset *strs_set;
116919d2b1dSAndrii Nakryiko 	/* whether strings are already deduplicated */
117919d2b1dSAndrii Nakryiko 	bool strs_deduped;
11888a82c2aSAndrii Nakryiko 
119b8604247SAndrii Nakryiko 	/* BTF object FD, if loaded into kernel */
1208a138aedSMartin KaFai Lau 	int fd;
121b8604247SAndrii Nakryiko 
122b8604247SAndrii Nakryiko 	/* Pointer size (in bytes) for a target architecture of this BTF */
12344ad23dfSAndrii Nakryiko 	int ptr_sz;
1248a138aedSMartin KaFai Lau };
1258a138aedSMartin KaFai Lau 
126d7f5b5e0SYonghong Song static inline __u64 ptr_to_u64(const void *ptr)
127d7f5b5e0SYonghong Song {
128d7f5b5e0SYonghong Song 	return (__u64) (unsigned long) ptr;
129d7f5b5e0SYonghong Song }
130d7f5b5e0SYonghong Song 
131192f5a1fSAndrii Nakryiko /* Ensure given dynamically allocated memory region pointed to by *data* with
132192f5a1fSAndrii Nakryiko  * capacity of *cap_cnt* elements each taking *elem_sz* bytes has enough
133192f5a1fSAndrii Nakryiko  * memory to accomodate *add_cnt* new elements, assuming *cur_cnt* elements
134192f5a1fSAndrii Nakryiko  * are already used. At most *max_cnt* elements can be ever allocated.
135192f5a1fSAndrii Nakryiko  * If necessary, memory is reallocated and all existing data is copied over,
136192f5a1fSAndrii Nakryiko  * new pointer to the memory region is stored at *data, new memory region
137192f5a1fSAndrii Nakryiko  * capacity (in number of elements) is stored in *cap.
138192f5a1fSAndrii Nakryiko  * On success, memory pointer to the beginning of unused memory is returned.
139192f5a1fSAndrii Nakryiko  * On error, NULL is returned.
140192f5a1fSAndrii Nakryiko  */
1413b029e06SAndrii Nakryiko void *libbpf_add_mem(void **data, size_t *cap_cnt, size_t elem_sz,
142192f5a1fSAndrii Nakryiko 		     size_t cur_cnt, size_t max_cnt, size_t add_cnt)
1438a138aedSMartin KaFai Lau {
144192f5a1fSAndrii Nakryiko 	size_t new_cnt;
145192f5a1fSAndrii Nakryiko 	void *new_data;
1468a138aedSMartin KaFai Lau 
147192f5a1fSAndrii Nakryiko 	if (cur_cnt + add_cnt <= *cap_cnt)
148192f5a1fSAndrii Nakryiko 		return *data + cur_cnt * elem_sz;
1498a138aedSMartin KaFai Lau 
150192f5a1fSAndrii Nakryiko 	/* requested more than the set limit */
151192f5a1fSAndrii Nakryiko 	if (cur_cnt + add_cnt > max_cnt)
152192f5a1fSAndrii Nakryiko 		return NULL;
1538a138aedSMartin KaFai Lau 
154192f5a1fSAndrii Nakryiko 	new_cnt = *cap_cnt;
155192f5a1fSAndrii Nakryiko 	new_cnt += new_cnt / 4;		  /* expand by 25% */
156192f5a1fSAndrii Nakryiko 	if (new_cnt < 16)		  /* but at least 16 elements */
157192f5a1fSAndrii Nakryiko 		new_cnt = 16;
158192f5a1fSAndrii Nakryiko 	if (new_cnt > max_cnt)		  /* but not exceeding a set limit */
159192f5a1fSAndrii Nakryiko 		new_cnt = max_cnt;
160192f5a1fSAndrii Nakryiko 	if (new_cnt < cur_cnt + add_cnt)  /* also ensure we have enough memory */
161192f5a1fSAndrii Nakryiko 		new_cnt = cur_cnt + add_cnt;
1628a138aedSMartin KaFai Lau 
163192f5a1fSAndrii Nakryiko 	new_data = libbpf_reallocarray(*data, new_cnt, elem_sz);
164192f5a1fSAndrii Nakryiko 	if (!new_data)
165192f5a1fSAndrii Nakryiko 		return NULL;
1668a138aedSMartin KaFai Lau 
167192f5a1fSAndrii Nakryiko 	/* zero out newly allocated portion of memory */
168192f5a1fSAndrii Nakryiko 	memset(new_data + (*cap_cnt) * elem_sz, 0, (new_cnt - *cap_cnt) * elem_sz);
169192f5a1fSAndrii Nakryiko 
170192f5a1fSAndrii Nakryiko 	*data = new_data;
171192f5a1fSAndrii Nakryiko 	*cap_cnt = new_cnt;
172192f5a1fSAndrii Nakryiko 	return new_data + cur_cnt * elem_sz;
1738a138aedSMartin KaFai Lau }
1748a138aedSMartin KaFai Lau 
1759c6c5c48SAndrii Nakryiko /* Ensure given dynamically allocated memory region has enough allocated space
1769c6c5c48SAndrii Nakryiko  * to accommodate *need_cnt* elements of size *elem_sz* bytes each
1779c6c5c48SAndrii Nakryiko  */
1783b029e06SAndrii Nakryiko int libbpf_ensure_mem(void **data, size_t *cap_cnt, size_t elem_sz, size_t need_cnt)
1799c6c5c48SAndrii Nakryiko {
1809c6c5c48SAndrii Nakryiko 	void *p;
1819c6c5c48SAndrii Nakryiko 
1829c6c5c48SAndrii Nakryiko 	if (need_cnt <= *cap_cnt)
1839c6c5c48SAndrii Nakryiko 		return 0;
1849c6c5c48SAndrii Nakryiko 
1853b029e06SAndrii Nakryiko 	p = libbpf_add_mem(data, cap_cnt, elem_sz, *cap_cnt, SIZE_MAX, need_cnt - *cap_cnt);
1869c6c5c48SAndrii Nakryiko 	if (!p)
1879c6c5c48SAndrii Nakryiko 		return -ENOMEM;
1889c6c5c48SAndrii Nakryiko 
1899c6c5c48SAndrii Nakryiko 	return 0;
1909c6c5c48SAndrii Nakryiko }
1919c6c5c48SAndrii Nakryiko 
1927ca61121SAndrii Nakryiko static void *btf_add_type_offs_mem(struct btf *btf, size_t add_cnt)
1937ca61121SAndrii Nakryiko {
1947ca61121SAndrii Nakryiko 	return libbpf_add_mem((void **)&btf->type_offs, &btf->type_offs_cap, sizeof(__u32),
1957ca61121SAndrii Nakryiko 			      btf->nr_types, BTF_MAX_NR_TYPES, add_cnt);
1967ca61121SAndrii Nakryiko }
1977ca61121SAndrii Nakryiko 
198192f5a1fSAndrii Nakryiko static int btf_add_type_idx_entry(struct btf *btf, __u32 type_off)
199192f5a1fSAndrii Nakryiko {
200192f5a1fSAndrii Nakryiko 	__u32 *p;
2018a138aedSMartin KaFai Lau 
2027ca61121SAndrii Nakryiko 	p = btf_add_type_offs_mem(btf, 1);
203192f5a1fSAndrii Nakryiko 	if (!p)
204192f5a1fSAndrii Nakryiko 		return -ENOMEM;
205192f5a1fSAndrii Nakryiko 
206192f5a1fSAndrii Nakryiko 	*p = type_off;
2078a138aedSMartin KaFai Lau 	return 0;
2088a138aedSMartin KaFai Lau }
2098a138aedSMartin KaFai Lau 
2103289959bSAndrii Nakryiko static void btf_bswap_hdr(struct btf_header *h)
2113289959bSAndrii Nakryiko {
2123289959bSAndrii Nakryiko 	h->magic = bswap_16(h->magic);
2133289959bSAndrii Nakryiko 	h->hdr_len = bswap_32(h->hdr_len);
2143289959bSAndrii Nakryiko 	h->type_off = bswap_32(h->type_off);
2153289959bSAndrii Nakryiko 	h->type_len = bswap_32(h->type_len);
2163289959bSAndrii Nakryiko 	h->str_off = bswap_32(h->str_off);
2173289959bSAndrii Nakryiko 	h->str_len = bswap_32(h->str_len);
2183289959bSAndrii Nakryiko }
2193289959bSAndrii Nakryiko 
2208461ef8bSYonghong Song static int btf_parse_hdr(struct btf *btf)
2218a138aedSMartin KaFai Lau {
2223289959bSAndrii Nakryiko 	struct btf_header *hdr = btf->hdr;
2235b891af7SMartin KaFai Lau 	__u32 meta_left;
2248a138aedSMartin KaFai Lau 
225b8604247SAndrii Nakryiko 	if (btf->raw_size < sizeof(struct btf_header)) {
2268461ef8bSYonghong Song 		pr_debug("BTF header not found\n");
2278a138aedSMartin KaFai Lau 		return -EINVAL;
2288a138aedSMartin KaFai Lau 	}
2298a138aedSMartin KaFai Lau 
2303289959bSAndrii Nakryiko 	if (hdr->magic == bswap_16(BTF_MAGIC)) {
2313289959bSAndrii Nakryiko 		btf->swapped_endian = true;
2323289959bSAndrii Nakryiko 		if (bswap_32(hdr->hdr_len) != sizeof(struct btf_header)) {
2333289959bSAndrii Nakryiko 			pr_warn("Can't load BTF with non-native endianness due to unsupported header length %u\n",
2343289959bSAndrii Nakryiko 				bswap_32(hdr->hdr_len));
2353289959bSAndrii Nakryiko 			return -ENOTSUP;
2363289959bSAndrii Nakryiko 		}
2373289959bSAndrii Nakryiko 		btf_bswap_hdr(hdr);
2383289959bSAndrii Nakryiko 	} else if (hdr->magic != BTF_MAGIC) {
2398461ef8bSYonghong Song 		pr_debug("Invalid BTF magic: %x\n", hdr->magic);
2408a138aedSMartin KaFai Lau 		return -EINVAL;
2418a138aedSMartin KaFai Lau 	}
2428a138aedSMartin KaFai Lau 
243c825f5feSAndrii Nakryiko 	if (btf->raw_size < hdr->hdr_len) {
244c825f5feSAndrii Nakryiko 		pr_debug("BTF header len %u larger than data size %u\n",
245c825f5feSAndrii Nakryiko 			 hdr->hdr_len, btf->raw_size);
246c825f5feSAndrii Nakryiko 		return -EINVAL;
247c825f5feSAndrii Nakryiko 	}
248c825f5feSAndrii Nakryiko 
249c825f5feSAndrii Nakryiko 	meta_left = btf->raw_size - hdr->hdr_len;
2505245dafeSAndrii Nakryiko 	if (meta_left < (long long)hdr->str_off + hdr->str_len) {
251d8123624SAndrii Nakryiko 		pr_debug("Invalid BTF total size: %u\n", btf->raw_size);
2528a138aedSMartin KaFai Lau 		return -EINVAL;
2538a138aedSMartin KaFai Lau 	}
2548a138aedSMartin KaFai Lau 
2555245dafeSAndrii Nakryiko 	if ((long long)hdr->type_off + hdr->type_len > hdr->str_off) {
256d8123624SAndrii Nakryiko 		pr_debug("Invalid BTF data sections layout: type data at %u + %u, strings data at %u + %u\n",
257d8123624SAndrii Nakryiko 			 hdr->type_off, hdr->type_len, hdr->str_off, hdr->str_len);
2588a138aedSMartin KaFai Lau 		return -EINVAL;
2598a138aedSMartin KaFai Lau 	}
2608a138aedSMartin KaFai Lau 
261d8123624SAndrii Nakryiko 	if (hdr->type_off % 4) {
2628461ef8bSYonghong Song 		pr_debug("BTF type section is not aligned to 4 bytes\n");
2638a138aedSMartin KaFai Lau 		return -EINVAL;
2648a138aedSMartin KaFai Lau 	}
2658a138aedSMartin KaFai Lau 
2668a138aedSMartin KaFai Lau 	return 0;
2678a138aedSMartin KaFai Lau }
2688a138aedSMartin KaFai Lau 
2698461ef8bSYonghong Song static int btf_parse_str_sec(struct btf *btf)
2708a138aedSMartin KaFai Lau {
2718a138aedSMartin KaFai Lau 	const struct btf_header *hdr = btf->hdr;
272b8604247SAndrii Nakryiko 	const char *start = btf->strs_data;
2738a138aedSMartin KaFai Lau 	const char *end = start + btf->hdr->str_len;
2748a138aedSMartin KaFai Lau 
275ba451366SAndrii Nakryiko 	if (btf->base_btf && hdr->str_len == 0)
276ba451366SAndrii Nakryiko 		return 0;
277ba451366SAndrii Nakryiko 	if (!hdr->str_len || hdr->str_len - 1 > BTF_MAX_STR_OFFSET || end[-1]) {
2788461ef8bSYonghong Song 		pr_debug("Invalid BTF string section\n");
2798a138aedSMartin KaFai Lau 		return -EINVAL;
2808a138aedSMartin KaFai Lau 	}
281ba451366SAndrii Nakryiko 	if (!btf->base_btf && start[0]) {
282ba451366SAndrii Nakryiko 		pr_debug("Invalid BTF string section\n");
283ba451366SAndrii Nakryiko 		return -EINVAL;
284ba451366SAndrii Nakryiko 	}
2858a138aedSMartin KaFai Lau 	return 0;
2868a138aedSMartin KaFai Lau }
2878a138aedSMartin KaFai Lau 
288740e69c3SAndrii Nakryiko static int btf_type_size(const struct btf_type *t)
28969eaab04SAndrii Nakryiko {
2903289959bSAndrii Nakryiko 	const int base_size = sizeof(struct btf_type);
291b03bc685SAndrii Nakryiko 	__u16 vlen = btf_vlen(t);
29269eaab04SAndrii Nakryiko 
293b03bc685SAndrii Nakryiko 	switch (btf_kind(t)) {
29469eaab04SAndrii Nakryiko 	case BTF_KIND_FWD:
29569eaab04SAndrii Nakryiko 	case BTF_KIND_CONST:
29669eaab04SAndrii Nakryiko 	case BTF_KIND_VOLATILE:
29769eaab04SAndrii Nakryiko 	case BTF_KIND_RESTRICT:
29869eaab04SAndrii Nakryiko 	case BTF_KIND_PTR:
29969eaab04SAndrii Nakryiko 	case BTF_KIND_TYPEDEF:
30069eaab04SAndrii Nakryiko 	case BTF_KIND_FUNC:
30122541a9eSIlya Leoshkevich 	case BTF_KIND_FLOAT:
302*2dc1e488SYonghong Song 	case BTF_KIND_TYPE_TAG:
30369eaab04SAndrii Nakryiko 		return base_size;
30469eaab04SAndrii Nakryiko 	case BTF_KIND_INT:
30569eaab04SAndrii Nakryiko 		return base_size + sizeof(__u32);
30669eaab04SAndrii Nakryiko 	case BTF_KIND_ENUM:
30769eaab04SAndrii Nakryiko 		return base_size + vlen * sizeof(struct btf_enum);
30869eaab04SAndrii Nakryiko 	case BTF_KIND_ARRAY:
30969eaab04SAndrii Nakryiko 		return base_size + sizeof(struct btf_array);
31069eaab04SAndrii Nakryiko 	case BTF_KIND_STRUCT:
31169eaab04SAndrii Nakryiko 	case BTF_KIND_UNION:
31269eaab04SAndrii Nakryiko 		return base_size + vlen * sizeof(struct btf_member);
31369eaab04SAndrii Nakryiko 	case BTF_KIND_FUNC_PROTO:
31469eaab04SAndrii Nakryiko 		return base_size + vlen * sizeof(struct btf_param);
3151713d68bSDaniel Borkmann 	case BTF_KIND_VAR:
3161713d68bSDaniel Borkmann 		return base_size + sizeof(struct btf_var);
3171713d68bSDaniel Borkmann 	case BTF_KIND_DATASEC:
3181713d68bSDaniel Borkmann 		return base_size + vlen * sizeof(struct btf_var_secinfo);
319223f903eSYonghong Song 	case BTF_KIND_DECL_TAG:
320223f903eSYonghong Song 		return base_size + sizeof(struct btf_decl_tag);
32169eaab04SAndrii Nakryiko 	default:
322b03bc685SAndrii Nakryiko 		pr_debug("Unsupported BTF_KIND:%u\n", btf_kind(t));
32369eaab04SAndrii Nakryiko 		return -EINVAL;
32469eaab04SAndrii Nakryiko 	}
32569eaab04SAndrii Nakryiko }
32669eaab04SAndrii Nakryiko 
3273289959bSAndrii Nakryiko static void btf_bswap_type_base(struct btf_type *t)
3283289959bSAndrii Nakryiko {
3293289959bSAndrii Nakryiko 	t->name_off = bswap_32(t->name_off);
3303289959bSAndrii Nakryiko 	t->info = bswap_32(t->info);
3313289959bSAndrii Nakryiko 	t->type = bswap_32(t->type);
3323289959bSAndrii Nakryiko }
3333289959bSAndrii Nakryiko 
3343289959bSAndrii Nakryiko static int btf_bswap_type_rest(struct btf_type *t)
3353289959bSAndrii Nakryiko {
3363289959bSAndrii Nakryiko 	struct btf_var_secinfo *v;
3373289959bSAndrii Nakryiko 	struct btf_member *m;
3383289959bSAndrii Nakryiko 	struct btf_array *a;
3393289959bSAndrii Nakryiko 	struct btf_param *p;
3403289959bSAndrii Nakryiko 	struct btf_enum *e;
3413289959bSAndrii Nakryiko 	__u16 vlen = btf_vlen(t);
3423289959bSAndrii Nakryiko 	int i;
3433289959bSAndrii Nakryiko 
3443289959bSAndrii Nakryiko 	switch (btf_kind(t)) {
3453289959bSAndrii Nakryiko 	case BTF_KIND_FWD:
3463289959bSAndrii Nakryiko 	case BTF_KIND_CONST:
3473289959bSAndrii Nakryiko 	case BTF_KIND_VOLATILE:
3483289959bSAndrii Nakryiko 	case BTF_KIND_RESTRICT:
3493289959bSAndrii Nakryiko 	case BTF_KIND_PTR:
3503289959bSAndrii Nakryiko 	case BTF_KIND_TYPEDEF:
3513289959bSAndrii Nakryiko 	case BTF_KIND_FUNC:
35222541a9eSIlya Leoshkevich 	case BTF_KIND_FLOAT:
353*2dc1e488SYonghong Song 	case BTF_KIND_TYPE_TAG:
3543289959bSAndrii Nakryiko 		return 0;
3553289959bSAndrii Nakryiko 	case BTF_KIND_INT:
3563289959bSAndrii Nakryiko 		*(__u32 *)(t + 1) = bswap_32(*(__u32 *)(t + 1));
3573289959bSAndrii Nakryiko 		return 0;
3583289959bSAndrii Nakryiko 	case BTF_KIND_ENUM:
3593289959bSAndrii Nakryiko 		for (i = 0, e = btf_enum(t); i < vlen; i++, e++) {
3603289959bSAndrii Nakryiko 			e->name_off = bswap_32(e->name_off);
3613289959bSAndrii Nakryiko 			e->val = bswap_32(e->val);
3623289959bSAndrii Nakryiko 		}
3633289959bSAndrii Nakryiko 		return 0;
3643289959bSAndrii Nakryiko 	case BTF_KIND_ARRAY:
3653289959bSAndrii Nakryiko 		a = btf_array(t);
3663289959bSAndrii Nakryiko 		a->type = bswap_32(a->type);
3673289959bSAndrii Nakryiko 		a->index_type = bswap_32(a->index_type);
3683289959bSAndrii Nakryiko 		a->nelems = bswap_32(a->nelems);
3693289959bSAndrii Nakryiko 		return 0;
3703289959bSAndrii Nakryiko 	case BTF_KIND_STRUCT:
3713289959bSAndrii Nakryiko 	case BTF_KIND_UNION:
3723289959bSAndrii Nakryiko 		for (i = 0, m = btf_members(t); i < vlen; i++, m++) {
3733289959bSAndrii Nakryiko 			m->name_off = bswap_32(m->name_off);
3743289959bSAndrii Nakryiko 			m->type = bswap_32(m->type);
3753289959bSAndrii Nakryiko 			m->offset = bswap_32(m->offset);
3763289959bSAndrii Nakryiko 		}
3773289959bSAndrii Nakryiko 		return 0;
3783289959bSAndrii Nakryiko 	case BTF_KIND_FUNC_PROTO:
3793289959bSAndrii Nakryiko 		for (i = 0, p = btf_params(t); i < vlen; i++, p++) {
3803289959bSAndrii Nakryiko 			p->name_off = bswap_32(p->name_off);
3813289959bSAndrii Nakryiko 			p->type = bswap_32(p->type);
3823289959bSAndrii Nakryiko 		}
3833289959bSAndrii Nakryiko 		return 0;
3843289959bSAndrii Nakryiko 	case BTF_KIND_VAR:
3853289959bSAndrii Nakryiko 		btf_var(t)->linkage = bswap_32(btf_var(t)->linkage);
3863289959bSAndrii Nakryiko 		return 0;
3873289959bSAndrii Nakryiko 	case BTF_KIND_DATASEC:
3883289959bSAndrii Nakryiko 		for (i = 0, v = btf_var_secinfos(t); i < vlen; i++, v++) {
3893289959bSAndrii Nakryiko 			v->type = bswap_32(v->type);
3903289959bSAndrii Nakryiko 			v->offset = bswap_32(v->offset);
3913289959bSAndrii Nakryiko 			v->size = bswap_32(v->size);
3923289959bSAndrii Nakryiko 		}
3933289959bSAndrii Nakryiko 		return 0;
394223f903eSYonghong Song 	case BTF_KIND_DECL_TAG:
395223f903eSYonghong Song 		btf_decl_tag(t)->component_idx = bswap_32(btf_decl_tag(t)->component_idx);
3965b84bd10SYonghong Song 		return 0;
3973289959bSAndrii Nakryiko 	default:
3983289959bSAndrii Nakryiko 		pr_debug("Unsupported BTF_KIND:%u\n", btf_kind(t));
3993289959bSAndrii Nakryiko 		return -EINVAL;
4003289959bSAndrii Nakryiko 	}
4013289959bSAndrii Nakryiko }
4023289959bSAndrii Nakryiko 
4038461ef8bSYonghong Song static int btf_parse_type_sec(struct btf *btf)
4048a138aedSMartin KaFai Lau {
4058a138aedSMartin KaFai Lau 	struct btf_header *hdr = btf->hdr;
406b8604247SAndrii Nakryiko 	void *next_type = btf->types_data;
407740e69c3SAndrii Nakryiko 	void *end_type = next_type + hdr->type_len;
408ba451366SAndrii Nakryiko 	int err, type_size;
409740e69c3SAndrii Nakryiko 
4103289959bSAndrii Nakryiko 	while (next_type + sizeof(struct btf_type) <= end_type) {
4113289959bSAndrii Nakryiko 		if (btf->swapped_endian)
4123289959bSAndrii Nakryiko 			btf_bswap_type_base(next_type);
413740e69c3SAndrii Nakryiko 
414740e69c3SAndrii Nakryiko 		type_size = btf_type_size(next_type);
415740e69c3SAndrii Nakryiko 		if (type_size < 0)
416740e69c3SAndrii Nakryiko 			return type_size;
4173289959bSAndrii Nakryiko 		if (next_type + type_size > end_type) {
418ba451366SAndrii Nakryiko 			pr_warn("BTF type [%d] is malformed\n", btf->start_id + btf->nr_types);
4193289959bSAndrii Nakryiko 			return -EINVAL;
4203289959bSAndrii Nakryiko 		}
4213289959bSAndrii Nakryiko 
4223289959bSAndrii Nakryiko 		if (btf->swapped_endian && btf_bswap_type_rest(next_type))
4233289959bSAndrii Nakryiko 			return -EINVAL;
4243289959bSAndrii Nakryiko 
4253289959bSAndrii Nakryiko 		err = btf_add_type_idx_entry(btf, next_type - btf->types_data);
4263289959bSAndrii Nakryiko 		if (err)
4273289959bSAndrii Nakryiko 			return err;
428740e69c3SAndrii Nakryiko 
429740e69c3SAndrii Nakryiko 		next_type += type_size;
430740e69c3SAndrii Nakryiko 		btf->nr_types++;
4318a138aedSMartin KaFai Lau 	}
4328a138aedSMartin KaFai Lau 
4333289959bSAndrii Nakryiko 	if (next_type != end_type) {
4343289959bSAndrii Nakryiko 		pr_warn("BTF types data is malformed\n");
4353289959bSAndrii Nakryiko 		return -EINVAL;
4363289959bSAndrii Nakryiko 	}
4373289959bSAndrii Nakryiko 
4388a138aedSMartin KaFai Lau 	return 0;
4398a138aedSMartin KaFai Lau }
4408a138aedSMartin KaFai Lau 
4419c651127SAndrii Nakryiko __u32 btf__get_nr_types(const struct btf *btf)
4429c651127SAndrii Nakryiko {
443ba451366SAndrii Nakryiko 	return btf->start_id + btf->nr_types - 1;
4449c651127SAndrii Nakryiko }
4459c651127SAndrii Nakryiko 
4466a886de0SHengqi Chen __u32 btf__type_cnt(const struct btf *btf)
4476a886de0SHengqi Chen {
4486a886de0SHengqi Chen 	return btf->start_id + btf->nr_types;
4496a886de0SHengqi Chen }
4506a886de0SHengqi Chen 
4510cfdcd63SAndrii Nakryiko const struct btf *btf__base_btf(const struct btf *btf)
4520cfdcd63SAndrii Nakryiko {
4530cfdcd63SAndrii Nakryiko 	return btf->base_btf;
4540cfdcd63SAndrii Nakryiko }
4550cfdcd63SAndrii Nakryiko 
456740e69c3SAndrii Nakryiko /* internal helper returning non-const pointer to a type */
457e14ef4bfSAndrii Nakryiko struct btf_type *btf_type_by_id(struct btf *btf, __u32 type_id)
458740e69c3SAndrii Nakryiko {
459740e69c3SAndrii Nakryiko 	if (type_id == 0)
460740e69c3SAndrii Nakryiko 		return &btf_void;
461ba451366SAndrii Nakryiko 	if (type_id < btf->start_id)
462ba451366SAndrii Nakryiko 		return btf_type_by_id(btf->base_btf, type_id);
463ba451366SAndrii Nakryiko 	return btf->types_data + btf->type_offs[type_id - btf->start_id];
464740e69c3SAndrii Nakryiko }
465740e69c3SAndrii Nakryiko 
46638d5d3b3SMartin KaFai Lau const struct btf_type *btf__type_by_id(const struct btf *btf, __u32 type_id)
4678a138aedSMartin KaFai Lau {
468ba451366SAndrii Nakryiko 	if (type_id >= btf->start_id + btf->nr_types)
469e9fc3ce9SAndrii Nakryiko 		return errno = EINVAL, NULL;
470740e69c3SAndrii Nakryiko 	return btf_type_by_id((struct btf *)btf, type_id);
4718a138aedSMartin KaFai Lau }
4728a138aedSMartin KaFai Lau 
47344ad23dfSAndrii Nakryiko static int determine_ptr_size(const struct btf *btf)
47444ad23dfSAndrii Nakryiko {
47544ad23dfSAndrii Nakryiko 	const struct btf_type *t;
47644ad23dfSAndrii Nakryiko 	const char *name;
477ba451366SAndrii Nakryiko 	int i, n;
47844ad23dfSAndrii Nakryiko 
479ba451366SAndrii Nakryiko 	if (btf->base_btf && btf->base_btf->ptr_sz > 0)
480ba451366SAndrii Nakryiko 		return btf->base_btf->ptr_sz;
481ba451366SAndrii Nakryiko 
4826a886de0SHengqi Chen 	n = btf__type_cnt(btf);
4836a886de0SHengqi Chen 	for (i = 1; i < n; i++) {
48444ad23dfSAndrii Nakryiko 		t = btf__type_by_id(btf, i);
48544ad23dfSAndrii Nakryiko 		if (!btf_is_int(t))
48644ad23dfSAndrii Nakryiko 			continue;
48744ad23dfSAndrii Nakryiko 
48844ad23dfSAndrii Nakryiko 		name = btf__name_by_offset(btf, t->name_off);
48944ad23dfSAndrii Nakryiko 		if (!name)
49044ad23dfSAndrii Nakryiko 			continue;
49144ad23dfSAndrii Nakryiko 
49244ad23dfSAndrii Nakryiko 		if (strcmp(name, "long int") == 0 ||
49344ad23dfSAndrii Nakryiko 		    strcmp(name, "long unsigned int") == 0) {
49444ad23dfSAndrii Nakryiko 			if (t->size != 4 && t->size != 8)
49544ad23dfSAndrii Nakryiko 				continue;
49644ad23dfSAndrii Nakryiko 			return t->size;
49744ad23dfSAndrii Nakryiko 		}
49844ad23dfSAndrii Nakryiko 	}
49944ad23dfSAndrii Nakryiko 
50044ad23dfSAndrii Nakryiko 	return -1;
50144ad23dfSAndrii Nakryiko }
50244ad23dfSAndrii Nakryiko 
50344ad23dfSAndrii Nakryiko static size_t btf_ptr_sz(const struct btf *btf)
50444ad23dfSAndrii Nakryiko {
50544ad23dfSAndrii Nakryiko 	if (!btf->ptr_sz)
50644ad23dfSAndrii Nakryiko 		((struct btf *)btf)->ptr_sz = determine_ptr_size(btf);
50744ad23dfSAndrii Nakryiko 	return btf->ptr_sz < 0 ? sizeof(void *) : btf->ptr_sz;
50844ad23dfSAndrii Nakryiko }
50944ad23dfSAndrii Nakryiko 
51044ad23dfSAndrii Nakryiko /* Return pointer size this BTF instance assumes. The size is heuristically
51144ad23dfSAndrii Nakryiko  * determined by looking for 'long' or 'unsigned long' integer type and
51244ad23dfSAndrii Nakryiko  * recording its size in bytes. If BTF type information doesn't have any such
51344ad23dfSAndrii Nakryiko  * type, this function returns 0. In the latter case, native architecture's
51444ad23dfSAndrii Nakryiko  * pointer size is assumed, so will be either 4 or 8, depending on
51544ad23dfSAndrii Nakryiko  * architecture that libbpf was compiled for. It's possible to override
51644ad23dfSAndrii Nakryiko  * guessed value by using btf__set_pointer_size() API.
51744ad23dfSAndrii Nakryiko  */
51844ad23dfSAndrii Nakryiko size_t btf__pointer_size(const struct btf *btf)
51944ad23dfSAndrii Nakryiko {
52044ad23dfSAndrii Nakryiko 	if (!btf->ptr_sz)
52144ad23dfSAndrii Nakryiko 		((struct btf *)btf)->ptr_sz = determine_ptr_size(btf);
52244ad23dfSAndrii Nakryiko 
52344ad23dfSAndrii Nakryiko 	if (btf->ptr_sz < 0)
52444ad23dfSAndrii Nakryiko 		/* not enough BTF type info to guess */
52544ad23dfSAndrii Nakryiko 		return 0;
52644ad23dfSAndrii Nakryiko 
52744ad23dfSAndrii Nakryiko 	return btf->ptr_sz;
52844ad23dfSAndrii Nakryiko }
52944ad23dfSAndrii Nakryiko 
53044ad23dfSAndrii Nakryiko /* Override or set pointer size in bytes. Only values of 4 and 8 are
53144ad23dfSAndrii Nakryiko  * supported.
53244ad23dfSAndrii Nakryiko  */
53344ad23dfSAndrii Nakryiko int btf__set_pointer_size(struct btf *btf, size_t ptr_sz)
53444ad23dfSAndrii Nakryiko {
53544ad23dfSAndrii Nakryiko 	if (ptr_sz != 4 && ptr_sz != 8)
536e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
53744ad23dfSAndrii Nakryiko 	btf->ptr_sz = ptr_sz;
53844ad23dfSAndrii Nakryiko 	return 0;
53944ad23dfSAndrii Nakryiko }
54044ad23dfSAndrii Nakryiko 
5413289959bSAndrii Nakryiko static bool is_host_big_endian(void)
5423289959bSAndrii Nakryiko {
5433930198dSIlya Leoshkevich #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
5443289959bSAndrii Nakryiko 	return false;
5453930198dSIlya Leoshkevich #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
5463289959bSAndrii Nakryiko 	return true;
5473289959bSAndrii Nakryiko #else
5483289959bSAndrii Nakryiko # error "Unrecognized __BYTE_ORDER__"
5493289959bSAndrii Nakryiko #endif
5503289959bSAndrii Nakryiko }
5513289959bSAndrii Nakryiko 
5523289959bSAndrii Nakryiko enum btf_endianness btf__endianness(const struct btf *btf)
5533289959bSAndrii Nakryiko {
5543289959bSAndrii Nakryiko 	if (is_host_big_endian())
5553289959bSAndrii Nakryiko 		return btf->swapped_endian ? BTF_LITTLE_ENDIAN : BTF_BIG_ENDIAN;
5563289959bSAndrii Nakryiko 	else
5573289959bSAndrii Nakryiko 		return btf->swapped_endian ? BTF_BIG_ENDIAN : BTF_LITTLE_ENDIAN;
5583289959bSAndrii Nakryiko }
5593289959bSAndrii Nakryiko 
5603289959bSAndrii Nakryiko int btf__set_endianness(struct btf *btf, enum btf_endianness endian)
5613289959bSAndrii Nakryiko {
5623289959bSAndrii Nakryiko 	if (endian != BTF_LITTLE_ENDIAN && endian != BTF_BIG_ENDIAN)
563e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
5643289959bSAndrii Nakryiko 
5653289959bSAndrii Nakryiko 	btf->swapped_endian = is_host_big_endian() != (endian == BTF_BIG_ENDIAN);
5663289959bSAndrii Nakryiko 	if (!btf->swapped_endian) {
5673289959bSAndrii Nakryiko 		free(btf->raw_data_swapped);
5683289959bSAndrii Nakryiko 		btf->raw_data_swapped = NULL;
5693289959bSAndrii Nakryiko 	}
5703289959bSAndrii Nakryiko 	return 0;
5713289959bSAndrii Nakryiko }
5723289959bSAndrii Nakryiko 
5738a138aedSMartin KaFai Lau static bool btf_type_is_void(const struct btf_type *t)
5748a138aedSMartin KaFai Lau {
575b03bc685SAndrii Nakryiko 	return t == &btf_void || btf_is_fwd(t);
5768a138aedSMartin KaFai Lau }
5778a138aedSMartin KaFai Lau 
5788a138aedSMartin KaFai Lau static bool btf_type_is_void_or_null(const struct btf_type *t)
5798a138aedSMartin KaFai Lau {
5808a138aedSMartin KaFai Lau 	return !t || btf_type_is_void(t);
5818a138aedSMartin KaFai Lau }
5828a138aedSMartin KaFai Lau 
5838a138aedSMartin KaFai Lau #define MAX_RESOLVE_DEPTH 32
5848a138aedSMartin KaFai Lau 
5855b891af7SMartin KaFai Lau __s64 btf__resolve_size(const struct btf *btf, __u32 type_id)
5868a138aedSMartin KaFai Lau {
5878a138aedSMartin KaFai Lau 	const struct btf_array *array;
5888a138aedSMartin KaFai Lau 	const struct btf_type *t;
5895b891af7SMartin KaFai Lau 	__u32 nelems = 1;
5905b891af7SMartin KaFai Lau 	__s64 size = -1;
5918a138aedSMartin KaFai Lau 	int i;
5928a138aedSMartin KaFai Lau 
59392b57121SOkash Khawaja 	t = btf__type_by_id(btf, type_id);
594e9fc3ce9SAndrii Nakryiko 	for (i = 0; i < MAX_RESOLVE_DEPTH && !btf_type_is_void_or_null(t); i++) {
595b03bc685SAndrii Nakryiko 		switch (btf_kind(t)) {
59669eaab04SAndrii Nakryiko 		case BTF_KIND_INT:
59769eaab04SAndrii Nakryiko 		case BTF_KIND_STRUCT:
59869eaab04SAndrii Nakryiko 		case BTF_KIND_UNION:
59969eaab04SAndrii Nakryiko 		case BTF_KIND_ENUM:
6001713d68bSDaniel Borkmann 		case BTF_KIND_DATASEC:
60122541a9eSIlya Leoshkevich 		case BTF_KIND_FLOAT:
60269eaab04SAndrii Nakryiko 			size = t->size;
60369eaab04SAndrii Nakryiko 			goto done;
60469eaab04SAndrii Nakryiko 		case BTF_KIND_PTR:
60544ad23dfSAndrii Nakryiko 			size = btf_ptr_sz(btf);
60669eaab04SAndrii Nakryiko 			goto done;
6078a138aedSMartin KaFai Lau 		case BTF_KIND_TYPEDEF:
6088a138aedSMartin KaFai Lau 		case BTF_KIND_VOLATILE:
6098a138aedSMartin KaFai Lau 		case BTF_KIND_CONST:
6108a138aedSMartin KaFai Lau 		case BTF_KIND_RESTRICT:
6111713d68bSDaniel Borkmann 		case BTF_KIND_VAR:
612223f903eSYonghong Song 		case BTF_KIND_DECL_TAG:
6138a138aedSMartin KaFai Lau 			type_id = t->type;
6148a138aedSMartin KaFai Lau 			break;
6158a138aedSMartin KaFai Lau 		case BTF_KIND_ARRAY:
616b03bc685SAndrii Nakryiko 			array = btf_array(t);
6178a138aedSMartin KaFai Lau 			if (nelems && array->nelems > UINT32_MAX / nelems)
618e9fc3ce9SAndrii Nakryiko 				return libbpf_err(-E2BIG);
6198a138aedSMartin KaFai Lau 			nelems *= array->nelems;
6208a138aedSMartin KaFai Lau 			type_id = array->type;
6218a138aedSMartin KaFai Lau 			break;
6228a138aedSMartin KaFai Lau 		default:
623e9fc3ce9SAndrii Nakryiko 			return libbpf_err(-EINVAL);
6248a138aedSMartin KaFai Lau 		}
6258a138aedSMartin KaFai Lau 
62692b57121SOkash Khawaja 		t = btf__type_by_id(btf, type_id);
6278a138aedSMartin KaFai Lau 	}
6288a138aedSMartin KaFai Lau 
629994021a7SAndrii Nakryiko done:
6308a138aedSMartin KaFai Lau 	if (size < 0)
631e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
6328a138aedSMartin KaFai Lau 	if (nelems && size > UINT32_MAX / nelems)
633e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-E2BIG);
6348a138aedSMartin KaFai Lau 
6358a138aedSMartin KaFai Lau 	return nelems * size;
6368a138aedSMartin KaFai Lau }
6378a138aedSMartin KaFai Lau 
6383d208f4cSAndrii Nakryiko int btf__align_of(const struct btf *btf, __u32 id)
6393d208f4cSAndrii Nakryiko {
6403d208f4cSAndrii Nakryiko 	const struct btf_type *t = btf__type_by_id(btf, id);
6413d208f4cSAndrii Nakryiko 	__u16 kind = btf_kind(t);
6423d208f4cSAndrii Nakryiko 
6433d208f4cSAndrii Nakryiko 	switch (kind) {
6443d208f4cSAndrii Nakryiko 	case BTF_KIND_INT:
6453d208f4cSAndrii Nakryiko 	case BTF_KIND_ENUM:
64622541a9eSIlya Leoshkevich 	case BTF_KIND_FLOAT:
64744ad23dfSAndrii Nakryiko 		return min(btf_ptr_sz(btf), (size_t)t->size);
6483d208f4cSAndrii Nakryiko 	case BTF_KIND_PTR:
64944ad23dfSAndrii Nakryiko 		return btf_ptr_sz(btf);
6503d208f4cSAndrii Nakryiko 	case BTF_KIND_TYPEDEF:
6513d208f4cSAndrii Nakryiko 	case BTF_KIND_VOLATILE:
6523d208f4cSAndrii Nakryiko 	case BTF_KIND_CONST:
6533d208f4cSAndrii Nakryiko 	case BTF_KIND_RESTRICT:
654*2dc1e488SYonghong Song 	case BTF_KIND_TYPE_TAG:
6553d208f4cSAndrii Nakryiko 		return btf__align_of(btf, t->type);
6563d208f4cSAndrii Nakryiko 	case BTF_KIND_ARRAY:
6573d208f4cSAndrii Nakryiko 		return btf__align_of(btf, btf_array(t)->type);
6583d208f4cSAndrii Nakryiko 	case BTF_KIND_STRUCT:
6593d208f4cSAndrii Nakryiko 	case BTF_KIND_UNION: {
6603d208f4cSAndrii Nakryiko 		const struct btf_member *m = btf_members(t);
6613d208f4cSAndrii Nakryiko 		__u16 vlen = btf_vlen(t);
662a79ac2d1SPrashant Bhole 		int i, max_align = 1, align;
6633d208f4cSAndrii Nakryiko 
6643d208f4cSAndrii Nakryiko 		for (i = 0; i < vlen; i++, m++) {
665a79ac2d1SPrashant Bhole 			align = btf__align_of(btf, m->type);
666a79ac2d1SPrashant Bhole 			if (align <= 0)
667e9fc3ce9SAndrii Nakryiko 				return libbpf_err(align);
668a79ac2d1SPrashant Bhole 			max_align = max(max_align, align);
6693d208f4cSAndrii Nakryiko 		}
6703d208f4cSAndrii Nakryiko 
671a79ac2d1SPrashant Bhole 		return max_align;
6723d208f4cSAndrii Nakryiko 	}
6733d208f4cSAndrii Nakryiko 	default:
6743d208f4cSAndrii Nakryiko 		pr_warn("unsupported BTF_KIND:%u\n", btf_kind(t));
675e9fc3ce9SAndrii Nakryiko 		return errno = EINVAL, 0;
6763d208f4cSAndrii Nakryiko 	}
6773d208f4cSAndrii Nakryiko }
6783d208f4cSAndrii Nakryiko 
67992b57121SOkash Khawaja int btf__resolve_type(const struct btf *btf, __u32 type_id)
68092b57121SOkash Khawaja {
68192b57121SOkash Khawaja 	const struct btf_type *t;
68292b57121SOkash Khawaja 	int depth = 0;
68392b57121SOkash Khawaja 
68492b57121SOkash Khawaja 	t = btf__type_by_id(btf, type_id);
68592b57121SOkash Khawaja 	while (depth < MAX_RESOLVE_DEPTH &&
68692b57121SOkash Khawaja 	       !btf_type_is_void_or_null(t) &&
687b03bc685SAndrii Nakryiko 	       (btf_is_mod(t) || btf_is_typedef(t) || btf_is_var(t))) {
68892b57121SOkash Khawaja 		type_id = t->type;
68992b57121SOkash Khawaja 		t = btf__type_by_id(btf, type_id);
69092b57121SOkash Khawaja 		depth++;
69192b57121SOkash Khawaja 	}
69292b57121SOkash Khawaja 
69392b57121SOkash Khawaja 	if (depth == MAX_RESOLVE_DEPTH || btf_type_is_void_or_null(t))
694e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
69592b57121SOkash Khawaja 
69692b57121SOkash Khawaja 	return type_id;
69792b57121SOkash Khawaja }
69892b57121SOkash Khawaja 
6995b891af7SMartin KaFai Lau __s32 btf__find_by_name(const struct btf *btf, const char *type_name)
7008a138aedSMartin KaFai Lau {
7016a886de0SHengqi Chen 	__u32 i, nr_types = btf__type_cnt(btf);
7028a138aedSMartin KaFai Lau 
7038a138aedSMartin KaFai Lau 	if (!strcmp(type_name, "void"))
7048a138aedSMartin KaFai Lau 		return 0;
7058a138aedSMartin KaFai Lau 
7066a886de0SHengqi Chen 	for (i = 1; i < nr_types; i++) {
707740e69c3SAndrii Nakryiko 		const struct btf_type *t = btf__type_by_id(btf, i);
70892b57121SOkash Khawaja 		const char *name = btf__name_by_offset(btf, t->name_off);
7098a138aedSMartin KaFai Lau 
7108a138aedSMartin KaFai Lau 		if (name && !strcmp(type_name, name))
7118a138aedSMartin KaFai Lau 			return i;
7128a138aedSMartin KaFai Lau 	}
7138a138aedSMartin KaFai Lau 
714e9fc3ce9SAndrii Nakryiko 	return libbpf_err(-ENOENT);
7158a138aedSMartin KaFai Lau }
7168a138aedSMartin KaFai Lau 
7179dbe6015SKumar Kartikeya Dwivedi static __s32 btf_find_by_name_kind(const struct btf *btf, int start_id,
7189dbe6015SKumar Kartikeya Dwivedi 				   const char *type_name, __u32 kind)
7191442e287SAlexei Starovoitov {
7206a886de0SHengqi Chen 	__u32 i, nr_types = btf__type_cnt(btf);
7211442e287SAlexei Starovoitov 
7221442e287SAlexei Starovoitov 	if (kind == BTF_KIND_UNKN || !strcmp(type_name, "void"))
7231442e287SAlexei Starovoitov 		return 0;
7241442e287SAlexei Starovoitov 
7256a886de0SHengqi Chen 	for (i = start_id; i < nr_types; i++) {
726740e69c3SAndrii Nakryiko 		const struct btf_type *t = btf__type_by_id(btf, i);
7271442e287SAlexei Starovoitov 		const char *name;
7281442e287SAlexei Starovoitov 
7291442e287SAlexei Starovoitov 		if (btf_kind(t) != kind)
7301442e287SAlexei Starovoitov 			continue;
7311442e287SAlexei Starovoitov 		name = btf__name_by_offset(btf, t->name_off);
7321442e287SAlexei Starovoitov 		if (name && !strcmp(type_name, name))
7331442e287SAlexei Starovoitov 			return i;
7341442e287SAlexei Starovoitov 	}
7351442e287SAlexei Starovoitov 
736e9fc3ce9SAndrii Nakryiko 	return libbpf_err(-ENOENT);
7371442e287SAlexei Starovoitov }
7381442e287SAlexei Starovoitov 
7399dbe6015SKumar Kartikeya Dwivedi __s32 btf__find_by_name_kind_own(const struct btf *btf, const char *type_name,
7409dbe6015SKumar Kartikeya Dwivedi 				 __u32 kind)
7419dbe6015SKumar Kartikeya Dwivedi {
7429dbe6015SKumar Kartikeya Dwivedi 	return btf_find_by_name_kind(btf, btf->start_id, type_name, kind);
7439dbe6015SKumar Kartikeya Dwivedi }
7449dbe6015SKumar Kartikeya Dwivedi 
7459dbe6015SKumar Kartikeya Dwivedi __s32 btf__find_by_name_kind(const struct btf *btf, const char *type_name,
7469dbe6015SKumar Kartikeya Dwivedi 			     __u32 kind)
7479dbe6015SKumar Kartikeya Dwivedi {
7489dbe6015SKumar Kartikeya Dwivedi 	return btf_find_by_name_kind(btf, 1, type_name, kind);
7499dbe6015SKumar Kartikeya Dwivedi }
7509dbe6015SKumar Kartikeya Dwivedi 
751919d2b1dSAndrii Nakryiko static bool btf_is_modifiable(const struct btf *btf)
752919d2b1dSAndrii Nakryiko {
753919d2b1dSAndrii Nakryiko 	return (void *)btf->hdr != btf->raw_data;
754919d2b1dSAndrii Nakryiko }
755919d2b1dSAndrii Nakryiko 
7568a138aedSMartin KaFai Lau void btf__free(struct btf *btf)
7578a138aedSMartin KaFai Lau {
75850450fc7SAndrii Nakryiko 	if (IS_ERR_OR_NULL(btf))
7598a138aedSMartin KaFai Lau 		return;
7608a138aedSMartin KaFai Lau 
76181372e12SAndrii Nakryiko 	if (btf->fd >= 0)
7628a138aedSMartin KaFai Lau 		close(btf->fd);
7638a138aedSMartin KaFai Lau 
764919d2b1dSAndrii Nakryiko 	if (btf_is_modifiable(btf)) {
765919d2b1dSAndrii Nakryiko 		/* if BTF was modified after loading, it will have a split
766919d2b1dSAndrii Nakryiko 		 * in-memory representation for header, types, and strings
767919d2b1dSAndrii Nakryiko 		 * sections, so we need to free all of them individually. It
768919d2b1dSAndrii Nakryiko 		 * might still have a cached contiguous raw data present,
769919d2b1dSAndrii Nakryiko 		 * which will be unconditionally freed below.
770919d2b1dSAndrii Nakryiko 		 */
771919d2b1dSAndrii Nakryiko 		free(btf->hdr);
772919d2b1dSAndrii Nakryiko 		free(btf->types_data);
77390d76d3eSAndrii Nakryiko 		strset__free(btf->strs_set);
774919d2b1dSAndrii Nakryiko 	}
775b8604247SAndrii Nakryiko 	free(btf->raw_data);
7763289959bSAndrii Nakryiko 	free(btf->raw_data_swapped);
777740e69c3SAndrii Nakryiko 	free(btf->type_offs);
7788a138aedSMartin KaFai Lau 	free(btf);
7798a138aedSMartin KaFai Lau }
7808a138aedSMartin KaFai Lau 
781ba451366SAndrii Nakryiko static struct btf *btf_new_empty(struct btf *base_btf)
782a871b043SAndrii Nakryiko {
783a871b043SAndrii Nakryiko 	struct btf *btf;
784a871b043SAndrii Nakryiko 
785a871b043SAndrii Nakryiko 	btf = calloc(1, sizeof(*btf));
786a871b043SAndrii Nakryiko 	if (!btf)
787a871b043SAndrii Nakryiko 		return ERR_PTR(-ENOMEM);
7883289959bSAndrii Nakryiko 
789ba451366SAndrii Nakryiko 	btf->nr_types = 0;
790ba451366SAndrii Nakryiko 	btf->start_id = 1;
791ba451366SAndrii Nakryiko 	btf->start_str_off = 0;
792a871b043SAndrii Nakryiko 	btf->fd = -1;
793a871b043SAndrii Nakryiko 	btf->ptr_sz = sizeof(void *);
7943289959bSAndrii Nakryiko 	btf->swapped_endian = false;
795a871b043SAndrii Nakryiko 
796ba451366SAndrii Nakryiko 	if (base_btf) {
797ba451366SAndrii Nakryiko 		btf->base_btf = base_btf;
7986a886de0SHengqi Chen 		btf->start_id = btf__type_cnt(base_btf);
799ba451366SAndrii Nakryiko 		btf->start_str_off = base_btf->hdr->str_len;
800ba451366SAndrii Nakryiko 	}
801ba451366SAndrii Nakryiko 
802a871b043SAndrii Nakryiko 	/* +1 for empty string at offset 0 */
803ba451366SAndrii Nakryiko 	btf->raw_size = sizeof(struct btf_header) + (base_btf ? 0 : 1);
804a871b043SAndrii Nakryiko 	btf->raw_data = calloc(1, btf->raw_size);
805a871b043SAndrii Nakryiko 	if (!btf->raw_data) {
806a871b043SAndrii Nakryiko 		free(btf);
807a871b043SAndrii Nakryiko 		return ERR_PTR(-ENOMEM);
808a871b043SAndrii Nakryiko 	}
809a871b043SAndrii Nakryiko 
810a871b043SAndrii Nakryiko 	btf->hdr = btf->raw_data;
811a871b043SAndrii Nakryiko 	btf->hdr->hdr_len = sizeof(struct btf_header);
812a871b043SAndrii Nakryiko 	btf->hdr->magic = BTF_MAGIC;
813a871b043SAndrii Nakryiko 	btf->hdr->version = BTF_VERSION;
814a871b043SAndrii Nakryiko 
815a871b043SAndrii Nakryiko 	btf->types_data = btf->raw_data + btf->hdr->hdr_len;
816a871b043SAndrii Nakryiko 	btf->strs_data = btf->raw_data + btf->hdr->hdr_len;
817ba451366SAndrii Nakryiko 	btf->hdr->str_len = base_btf ? 0 : 1; /* empty string at offset 0 */
818a871b043SAndrii Nakryiko 
819a871b043SAndrii Nakryiko 	return btf;
820a871b043SAndrii Nakryiko }
821a871b043SAndrii Nakryiko 
822ba451366SAndrii Nakryiko struct btf *btf__new_empty(void)
823ba451366SAndrii Nakryiko {
824e9fc3ce9SAndrii Nakryiko 	return libbpf_ptr(btf_new_empty(NULL));
825ba451366SAndrii Nakryiko }
826ba451366SAndrii Nakryiko 
827ba451366SAndrii Nakryiko struct btf *btf__new_empty_split(struct btf *base_btf)
828ba451366SAndrii Nakryiko {
829e9fc3ce9SAndrii Nakryiko 	return libbpf_ptr(btf_new_empty(base_btf));
830ba451366SAndrii Nakryiko }
831ba451366SAndrii Nakryiko 
832ba451366SAndrii Nakryiko static struct btf *btf_new(const void *data, __u32 size, struct btf *base_btf)
8338a138aedSMartin KaFai Lau {
8348a138aedSMartin KaFai Lau 	struct btf *btf;
8358a138aedSMartin KaFai Lau 	int err;
8368a138aedSMartin KaFai Lau 
8378a138aedSMartin KaFai Lau 	btf = calloc(1, sizeof(struct btf));
8388a138aedSMartin KaFai Lau 	if (!btf)
8398a138aedSMartin KaFai Lau 		return ERR_PTR(-ENOMEM);
8408a138aedSMartin KaFai Lau 
841ba451366SAndrii Nakryiko 	btf->nr_types = 0;
842ba451366SAndrii Nakryiko 	btf->start_id = 1;
843ba451366SAndrii Nakryiko 	btf->start_str_off = 0;
844c34c338aSDaniel Xu 	btf->fd = -1;
845ba451366SAndrii Nakryiko 
846ba451366SAndrii Nakryiko 	if (base_btf) {
847ba451366SAndrii Nakryiko 		btf->base_btf = base_btf;
8486a886de0SHengqi Chen 		btf->start_id = btf__type_cnt(base_btf);
849ba451366SAndrii Nakryiko 		btf->start_str_off = base_btf->hdr->str_len;
850ba451366SAndrii Nakryiko 	}
851ba451366SAndrii Nakryiko 
852b8604247SAndrii Nakryiko 	btf->raw_data = malloc(size);
853b8604247SAndrii Nakryiko 	if (!btf->raw_data) {
8548a138aedSMartin KaFai Lau 		err = -ENOMEM;
8558a138aedSMartin KaFai Lau 		goto done;
8568a138aedSMartin KaFai Lau 	}
857b8604247SAndrii Nakryiko 	memcpy(btf->raw_data, data, size);
858b8604247SAndrii Nakryiko 	btf->raw_size = size;
8598a138aedSMartin KaFai Lau 
860b8604247SAndrii Nakryiko 	btf->hdr = btf->raw_data;
8618461ef8bSYonghong Song 	err = btf_parse_hdr(btf);
8628a138aedSMartin KaFai Lau 	if (err)
8638a138aedSMartin KaFai Lau 		goto done;
8648a138aedSMartin KaFai Lau 
865b8604247SAndrii Nakryiko 	btf->strs_data = btf->raw_data + btf->hdr->hdr_len + btf->hdr->str_off;
866b8604247SAndrii Nakryiko 	btf->types_data = btf->raw_data + btf->hdr->hdr_len + btf->hdr->type_off;
8678a138aedSMartin KaFai Lau 
868b8604247SAndrii Nakryiko 	err = btf_parse_str_sec(btf);
869b8604247SAndrii Nakryiko 	err = err ?: btf_parse_type_sec(btf);
8703289959bSAndrii Nakryiko 	if (err)
8713289959bSAndrii Nakryiko 		goto done;
8723289959bSAndrii Nakryiko 
8738a138aedSMartin KaFai Lau done:
8748a138aedSMartin KaFai Lau 	if (err) {
8758a138aedSMartin KaFai Lau 		btf__free(btf);
8768a138aedSMartin KaFai Lau 		return ERR_PTR(err);
8778a138aedSMartin KaFai Lau 	}
8788a138aedSMartin KaFai Lau 
8798a138aedSMartin KaFai Lau 	return btf;
8808a138aedSMartin KaFai Lau }
8818a138aedSMartin KaFai Lau 
882ba451366SAndrii Nakryiko struct btf *btf__new(const void *data, __u32 size)
883ba451366SAndrii Nakryiko {
884e9fc3ce9SAndrii Nakryiko 	return libbpf_ptr(btf_new(data, size, NULL));
885ba451366SAndrii Nakryiko }
886ba451366SAndrii Nakryiko 
887ba451366SAndrii Nakryiko static struct btf *btf_parse_elf(const char *path, struct btf *base_btf,
888ba451366SAndrii Nakryiko 				 struct btf_ext **btf_ext)
889e6c64855SAndrii Nakryiko {
890e6c64855SAndrii Nakryiko 	Elf_Data *btf_data = NULL, *btf_ext_data = NULL;
891e6c64855SAndrii Nakryiko 	int err = 0, fd = -1, idx = 0;
892e6c64855SAndrii Nakryiko 	struct btf *btf = NULL;
893e6c64855SAndrii Nakryiko 	Elf_Scn *scn = NULL;
894e6c64855SAndrii Nakryiko 	Elf *elf = NULL;
895e6c64855SAndrii Nakryiko 	GElf_Ehdr ehdr;
8966095d5a2SJiri Olsa 	size_t shstrndx;
897e6c64855SAndrii Nakryiko 
898e6c64855SAndrii Nakryiko 	if (elf_version(EV_CURRENT) == EV_NONE) {
899be18010eSKefeng Wang 		pr_warn("failed to init libelf for %s\n", path);
900e6c64855SAndrii Nakryiko 		return ERR_PTR(-LIBBPF_ERRNO__LIBELF);
901e6c64855SAndrii Nakryiko 	}
902e6c64855SAndrii Nakryiko 
90392274e24SKumar Kartikeya Dwivedi 	fd = open(path, O_RDONLY | O_CLOEXEC);
904e6c64855SAndrii Nakryiko 	if (fd < 0) {
905e6c64855SAndrii Nakryiko 		err = -errno;
906be18010eSKefeng Wang 		pr_warn("failed to open %s: %s\n", path, strerror(errno));
907e6c64855SAndrii Nakryiko 		return ERR_PTR(err);
908e6c64855SAndrii Nakryiko 	}
909e6c64855SAndrii Nakryiko 
910e6c64855SAndrii Nakryiko 	err = -LIBBPF_ERRNO__FORMAT;
911e6c64855SAndrii Nakryiko 
912e6c64855SAndrii Nakryiko 	elf = elf_begin(fd, ELF_C_READ, NULL);
913e6c64855SAndrii Nakryiko 	if (!elf) {
914be18010eSKefeng Wang 		pr_warn("failed to open %s as ELF file\n", path);
915e6c64855SAndrii Nakryiko 		goto done;
916e6c64855SAndrii Nakryiko 	}
917e6c64855SAndrii Nakryiko 	if (!gelf_getehdr(elf, &ehdr)) {
918be18010eSKefeng Wang 		pr_warn("failed to get EHDR from %s\n", path);
919e6c64855SAndrii Nakryiko 		goto done;
920e6c64855SAndrii Nakryiko 	}
9216095d5a2SJiri Olsa 
9226095d5a2SJiri Olsa 	if (elf_getshdrstrndx(elf, &shstrndx)) {
9236095d5a2SJiri Olsa 		pr_warn("failed to get section names section index for %s\n",
9246095d5a2SJiri Olsa 			path);
9256095d5a2SJiri Olsa 		goto done;
9266095d5a2SJiri Olsa 	}
9276095d5a2SJiri Olsa 
9286095d5a2SJiri Olsa 	if (!elf_rawdata(elf_getscn(elf, shstrndx), NULL)) {
929be18010eSKefeng Wang 		pr_warn("failed to get e_shstrndx from %s\n", path);
930e6c64855SAndrii Nakryiko 		goto done;
931e6c64855SAndrii Nakryiko 	}
932e6c64855SAndrii Nakryiko 
933e6c64855SAndrii Nakryiko 	while ((scn = elf_nextscn(elf, scn)) != NULL) {
934e6c64855SAndrii Nakryiko 		GElf_Shdr sh;
935e6c64855SAndrii Nakryiko 		char *name;
936e6c64855SAndrii Nakryiko 
937e6c64855SAndrii Nakryiko 		idx++;
938e6c64855SAndrii Nakryiko 		if (gelf_getshdr(scn, &sh) != &sh) {
939be18010eSKefeng Wang 			pr_warn("failed to get section(%d) header from %s\n",
940e6c64855SAndrii Nakryiko 				idx, path);
941e6c64855SAndrii Nakryiko 			goto done;
942e6c64855SAndrii Nakryiko 		}
9436095d5a2SJiri Olsa 		name = elf_strptr(elf, shstrndx, sh.sh_name);
944e6c64855SAndrii Nakryiko 		if (!name) {
945be18010eSKefeng Wang 			pr_warn("failed to get section(%d) name from %s\n",
946e6c64855SAndrii Nakryiko 				idx, path);
947e6c64855SAndrii Nakryiko 			goto done;
948e6c64855SAndrii Nakryiko 		}
949e6c64855SAndrii Nakryiko 		if (strcmp(name, BTF_ELF_SEC) == 0) {
950e6c64855SAndrii Nakryiko 			btf_data = elf_getdata(scn, 0);
951e6c64855SAndrii Nakryiko 			if (!btf_data) {
952be18010eSKefeng Wang 				pr_warn("failed to get section(%d, %s) data from %s\n",
953e6c64855SAndrii Nakryiko 					idx, name, path);
954e6c64855SAndrii Nakryiko 				goto done;
955e6c64855SAndrii Nakryiko 			}
956e6c64855SAndrii Nakryiko 			continue;
957e6c64855SAndrii Nakryiko 		} else if (btf_ext && strcmp(name, BTF_EXT_ELF_SEC) == 0) {
958e6c64855SAndrii Nakryiko 			btf_ext_data = elf_getdata(scn, 0);
959e6c64855SAndrii Nakryiko 			if (!btf_ext_data) {
960be18010eSKefeng Wang 				pr_warn("failed to get section(%d, %s) data from %s\n",
961e6c64855SAndrii Nakryiko 					idx, name, path);
962e6c64855SAndrii Nakryiko 				goto done;
963e6c64855SAndrii Nakryiko 			}
964e6c64855SAndrii Nakryiko 			continue;
965e6c64855SAndrii Nakryiko 		}
966e6c64855SAndrii Nakryiko 	}
967e6c64855SAndrii Nakryiko 
968e6c64855SAndrii Nakryiko 	err = 0;
969e6c64855SAndrii Nakryiko 
970e6c64855SAndrii Nakryiko 	if (!btf_data) {
971e6c64855SAndrii Nakryiko 		err = -ENOENT;
972e6c64855SAndrii Nakryiko 		goto done;
973e6c64855SAndrii Nakryiko 	}
974ba451366SAndrii Nakryiko 	btf = btf_new(btf_data->d_buf, btf_data->d_size, base_btf);
975e9fc3ce9SAndrii Nakryiko 	err = libbpf_get_error(btf);
976e9fc3ce9SAndrii Nakryiko 	if (err)
977e6c64855SAndrii Nakryiko 		goto done;
978e6c64855SAndrii Nakryiko 
97944ad23dfSAndrii Nakryiko 	switch (gelf_getclass(elf)) {
98044ad23dfSAndrii Nakryiko 	case ELFCLASS32:
98144ad23dfSAndrii Nakryiko 		btf__set_pointer_size(btf, 4);
98244ad23dfSAndrii Nakryiko 		break;
98344ad23dfSAndrii Nakryiko 	case ELFCLASS64:
98444ad23dfSAndrii Nakryiko 		btf__set_pointer_size(btf, 8);
98544ad23dfSAndrii Nakryiko 		break;
98644ad23dfSAndrii Nakryiko 	default:
98744ad23dfSAndrii Nakryiko 		pr_warn("failed to get ELF class (bitness) for %s\n", path);
98844ad23dfSAndrii Nakryiko 		break;
98944ad23dfSAndrii Nakryiko 	}
99044ad23dfSAndrii Nakryiko 
991e6c64855SAndrii Nakryiko 	if (btf_ext && btf_ext_data) {
992e9fc3ce9SAndrii Nakryiko 		*btf_ext = btf_ext__new(btf_ext_data->d_buf, btf_ext_data->d_size);
993e9fc3ce9SAndrii Nakryiko 		err = libbpf_get_error(*btf_ext);
994e9fc3ce9SAndrii Nakryiko 		if (err)
995e6c64855SAndrii Nakryiko 			goto done;
996e6c64855SAndrii Nakryiko 	} else if (btf_ext) {
997e6c64855SAndrii Nakryiko 		*btf_ext = NULL;
998e6c64855SAndrii Nakryiko 	}
999e6c64855SAndrii Nakryiko done:
1000e6c64855SAndrii Nakryiko 	if (elf)
1001e6c64855SAndrii Nakryiko 		elf_end(elf);
1002e6c64855SAndrii Nakryiko 	close(fd);
1003e6c64855SAndrii Nakryiko 
1004e9fc3ce9SAndrii Nakryiko 	if (!err)
1005e6c64855SAndrii Nakryiko 		return btf;
1006e9fc3ce9SAndrii Nakryiko 
1007e9fc3ce9SAndrii Nakryiko 	if (btf_ext)
1008e9fc3ce9SAndrii Nakryiko 		btf_ext__free(*btf_ext);
1009e6c64855SAndrii Nakryiko 	btf__free(btf);
1010e9fc3ce9SAndrii Nakryiko 
1011e6c64855SAndrii Nakryiko 	return ERR_PTR(err);
1012e6c64855SAndrii Nakryiko }
1013e6c64855SAndrii Nakryiko 
1014ba451366SAndrii Nakryiko struct btf *btf__parse_elf(const char *path, struct btf_ext **btf_ext)
1015ba451366SAndrii Nakryiko {
1016e9fc3ce9SAndrii Nakryiko 	return libbpf_ptr(btf_parse_elf(path, NULL, btf_ext));
1017ba451366SAndrii Nakryiko }
1018ba451366SAndrii Nakryiko 
1019ba451366SAndrii Nakryiko struct btf *btf__parse_elf_split(const char *path, struct btf *base_btf)
1020ba451366SAndrii Nakryiko {
1021e9fc3ce9SAndrii Nakryiko 	return libbpf_ptr(btf_parse_elf(path, base_btf, NULL));
1022ba451366SAndrii Nakryiko }
1023ba451366SAndrii Nakryiko 
1024ba451366SAndrii Nakryiko static struct btf *btf_parse_raw(const char *path, struct btf *base_btf)
102594a1feddSAndrii Nakryiko {
1026932ac54aSDaniel T. Lee 	struct btf *btf = NULL;
102794a1feddSAndrii Nakryiko 	void *data = NULL;
102894a1feddSAndrii Nakryiko 	FILE *f = NULL;
102994a1feddSAndrii Nakryiko 	__u16 magic;
103094a1feddSAndrii Nakryiko 	int err = 0;
103194a1feddSAndrii Nakryiko 	long sz;
103294a1feddSAndrii Nakryiko 
103394a1feddSAndrii Nakryiko 	f = fopen(path, "rb");
103494a1feddSAndrii Nakryiko 	if (!f) {
103594a1feddSAndrii Nakryiko 		err = -errno;
103694a1feddSAndrii Nakryiko 		goto err_out;
103794a1feddSAndrii Nakryiko 	}
103894a1feddSAndrii Nakryiko 
103994a1feddSAndrii Nakryiko 	/* check BTF magic */
104094a1feddSAndrii Nakryiko 	if (fread(&magic, 1, sizeof(magic), f) < sizeof(magic)) {
104194a1feddSAndrii Nakryiko 		err = -EIO;
104294a1feddSAndrii Nakryiko 		goto err_out;
104394a1feddSAndrii Nakryiko 	}
10443289959bSAndrii Nakryiko 	if (magic != BTF_MAGIC && magic != bswap_16(BTF_MAGIC)) {
104594a1feddSAndrii Nakryiko 		/* definitely not a raw BTF */
104694a1feddSAndrii Nakryiko 		err = -EPROTO;
104794a1feddSAndrii Nakryiko 		goto err_out;
104894a1feddSAndrii Nakryiko 	}
104994a1feddSAndrii Nakryiko 
105094a1feddSAndrii Nakryiko 	/* get file size */
105194a1feddSAndrii Nakryiko 	if (fseek(f, 0, SEEK_END)) {
105294a1feddSAndrii Nakryiko 		err = -errno;
105394a1feddSAndrii Nakryiko 		goto err_out;
105494a1feddSAndrii Nakryiko 	}
105594a1feddSAndrii Nakryiko 	sz = ftell(f);
105694a1feddSAndrii Nakryiko 	if (sz < 0) {
105794a1feddSAndrii Nakryiko 		err = -errno;
105894a1feddSAndrii Nakryiko 		goto err_out;
105994a1feddSAndrii Nakryiko 	}
106094a1feddSAndrii Nakryiko 	/* rewind to the start */
106194a1feddSAndrii Nakryiko 	if (fseek(f, 0, SEEK_SET)) {
106294a1feddSAndrii Nakryiko 		err = -errno;
106394a1feddSAndrii Nakryiko 		goto err_out;
106494a1feddSAndrii Nakryiko 	}
106594a1feddSAndrii Nakryiko 
106694a1feddSAndrii Nakryiko 	/* pre-alloc memory and read all of BTF data */
106794a1feddSAndrii Nakryiko 	data = malloc(sz);
106894a1feddSAndrii Nakryiko 	if (!data) {
106994a1feddSAndrii Nakryiko 		err = -ENOMEM;
107094a1feddSAndrii Nakryiko 		goto err_out;
107194a1feddSAndrii Nakryiko 	}
107294a1feddSAndrii Nakryiko 	if (fread(data, 1, sz, f) < sz) {
107394a1feddSAndrii Nakryiko 		err = -EIO;
107494a1feddSAndrii Nakryiko 		goto err_out;
107594a1feddSAndrii Nakryiko 	}
107694a1feddSAndrii Nakryiko 
107794a1feddSAndrii Nakryiko 	/* finally parse BTF data */
1078ba451366SAndrii Nakryiko 	btf = btf_new(data, sz, base_btf);
107994a1feddSAndrii Nakryiko 
108094a1feddSAndrii Nakryiko err_out:
108194a1feddSAndrii Nakryiko 	free(data);
108294a1feddSAndrii Nakryiko 	if (f)
108394a1feddSAndrii Nakryiko 		fclose(f);
108494a1feddSAndrii Nakryiko 	return err ? ERR_PTR(err) : btf;
108594a1feddSAndrii Nakryiko }
108694a1feddSAndrii Nakryiko 
1087ba451366SAndrii Nakryiko struct btf *btf__parse_raw(const char *path)
1088ba451366SAndrii Nakryiko {
1089e9fc3ce9SAndrii Nakryiko 	return libbpf_ptr(btf_parse_raw(path, NULL));
1090ba451366SAndrii Nakryiko }
1091ba451366SAndrii Nakryiko 
1092ba451366SAndrii Nakryiko struct btf *btf__parse_raw_split(const char *path, struct btf *base_btf)
1093ba451366SAndrii Nakryiko {
1094e9fc3ce9SAndrii Nakryiko 	return libbpf_ptr(btf_parse_raw(path, base_btf));
1095ba451366SAndrii Nakryiko }
1096ba451366SAndrii Nakryiko 
1097ba451366SAndrii Nakryiko static struct btf *btf_parse(const char *path, struct btf *base_btf, struct btf_ext **btf_ext)
109894a1feddSAndrii Nakryiko {
109994a1feddSAndrii Nakryiko 	struct btf *btf;
1100e9fc3ce9SAndrii Nakryiko 	int err;
110194a1feddSAndrii Nakryiko 
110294a1feddSAndrii Nakryiko 	if (btf_ext)
110394a1feddSAndrii Nakryiko 		*btf_ext = NULL;
110494a1feddSAndrii Nakryiko 
1105ba451366SAndrii Nakryiko 	btf = btf_parse_raw(path, base_btf);
1106e9fc3ce9SAndrii Nakryiko 	err = libbpf_get_error(btf);
1107e9fc3ce9SAndrii Nakryiko 	if (!err)
110894a1feddSAndrii Nakryiko 		return btf;
1109e9fc3ce9SAndrii Nakryiko 	if (err != -EPROTO)
1110e9fc3ce9SAndrii Nakryiko 		return ERR_PTR(err);
1111ba451366SAndrii Nakryiko 	return btf_parse_elf(path, base_btf, btf_ext);
1112ba451366SAndrii Nakryiko }
1113ba451366SAndrii Nakryiko 
1114ba451366SAndrii Nakryiko struct btf *btf__parse(const char *path, struct btf_ext **btf_ext)
1115ba451366SAndrii Nakryiko {
1116e9fc3ce9SAndrii Nakryiko 	return libbpf_ptr(btf_parse(path, NULL, btf_ext));
1117ba451366SAndrii Nakryiko }
1118ba451366SAndrii Nakryiko 
1119ba451366SAndrii Nakryiko struct btf *btf__parse_split(const char *path, struct btf *base_btf)
1120ba451366SAndrii Nakryiko {
1121e9fc3ce9SAndrii Nakryiko 	return libbpf_ptr(btf_parse(path, base_btf, NULL));
112294a1feddSAndrii Nakryiko }
112394a1feddSAndrii Nakryiko 
11243289959bSAndrii Nakryiko static void *btf_get_raw_data(const struct btf *btf, __u32 *size, bool swap_endian);
11253289959bSAndrii Nakryiko 
11263c7e5859SQuentin Monnet int btf__load_into_kernel(struct btf *btf)
1127d29d87f7SAndrii Nakryiko {
1128b8604247SAndrii Nakryiko 	__u32 log_buf_size = 0, raw_size;
1129d29d87f7SAndrii Nakryiko 	char *log_buf = NULL;
11303289959bSAndrii Nakryiko 	void *raw_data;
1131d29d87f7SAndrii Nakryiko 	int err = 0;
1132d29d87f7SAndrii Nakryiko 
1133d29d87f7SAndrii Nakryiko 	if (btf->fd >= 0)
1134e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EEXIST);
1135d29d87f7SAndrii Nakryiko 
11368395f320SStanislav Fomichev retry_load:
11378395f320SStanislav Fomichev 	if (log_buf_size) {
1138d29d87f7SAndrii Nakryiko 		log_buf = malloc(log_buf_size);
1139d29d87f7SAndrii Nakryiko 		if (!log_buf)
1140e9fc3ce9SAndrii Nakryiko 			return libbpf_err(-ENOMEM);
1141d29d87f7SAndrii Nakryiko 
1142d29d87f7SAndrii Nakryiko 		*log_buf = 0;
11438395f320SStanislav Fomichev 	}
1144d29d87f7SAndrii Nakryiko 
11453289959bSAndrii Nakryiko 	raw_data = btf_get_raw_data(btf, &raw_size, false);
1146b8604247SAndrii Nakryiko 	if (!raw_data) {
1147b8604247SAndrii Nakryiko 		err = -ENOMEM;
1148b8604247SAndrii Nakryiko 		goto done;
1149b8604247SAndrii Nakryiko 	}
11503289959bSAndrii Nakryiko 	/* cache native raw data representation */
11513289959bSAndrii Nakryiko 	btf->raw_size = raw_size;
11523289959bSAndrii Nakryiko 	btf->raw_data = raw_data;
1153b8604247SAndrii Nakryiko 
1154b8604247SAndrii Nakryiko 	btf->fd = bpf_load_btf(raw_data, raw_size, log_buf, log_buf_size, false);
1155d29d87f7SAndrii Nakryiko 	if (btf->fd < 0) {
11568395f320SStanislav Fomichev 		if (!log_buf || errno == ENOSPC) {
11578395f320SStanislav Fomichev 			log_buf_size = max((__u32)BPF_LOG_BUF_SIZE,
11588395f320SStanislav Fomichev 					   log_buf_size << 1);
11598395f320SStanislav Fomichev 			free(log_buf);
11608395f320SStanislav Fomichev 			goto retry_load;
11618395f320SStanislav Fomichev 		}
11628395f320SStanislav Fomichev 
1163d29d87f7SAndrii Nakryiko 		err = -errno;
1164be18010eSKefeng Wang 		pr_warn("Error loading BTF: %s(%d)\n", strerror(errno), errno);
1165d29d87f7SAndrii Nakryiko 		if (*log_buf)
1166be18010eSKefeng Wang 			pr_warn("%s\n", log_buf);
1167d29d87f7SAndrii Nakryiko 		goto done;
1168d29d87f7SAndrii Nakryiko 	}
1169d29d87f7SAndrii Nakryiko 
1170d29d87f7SAndrii Nakryiko done:
1171d29d87f7SAndrii Nakryiko 	free(log_buf);
1172e9fc3ce9SAndrii Nakryiko 	return libbpf_err(err);
1173d29d87f7SAndrii Nakryiko }
11743c7e5859SQuentin Monnet int btf__load(struct btf *) __attribute__((alias("btf__load_into_kernel")));
1175d29d87f7SAndrii Nakryiko 
11768a138aedSMartin KaFai Lau int btf__fd(const struct btf *btf)
11778a138aedSMartin KaFai Lau {
11788a138aedSMartin KaFai Lau 	return btf->fd;
11798a138aedSMartin KaFai Lau }
118092b57121SOkash Khawaja 
118181372e12SAndrii Nakryiko void btf__set_fd(struct btf *btf, int fd)
118281372e12SAndrii Nakryiko {
118381372e12SAndrii Nakryiko 	btf->fd = fd;
118481372e12SAndrii Nakryiko }
118581372e12SAndrii Nakryiko 
118690d76d3eSAndrii Nakryiko static const void *btf_strs_data(const struct btf *btf)
118790d76d3eSAndrii Nakryiko {
118890d76d3eSAndrii Nakryiko 	return btf->strs_data ? btf->strs_data : strset__data(btf->strs_set);
118990d76d3eSAndrii Nakryiko }
119090d76d3eSAndrii Nakryiko 
11913289959bSAndrii Nakryiko static void *btf_get_raw_data(const struct btf *btf, __u32 *size, bool swap_endian)
11923289959bSAndrii Nakryiko {
11933289959bSAndrii Nakryiko 	struct btf_header *hdr = btf->hdr;
11943289959bSAndrii Nakryiko 	struct btf_type *t;
11953289959bSAndrii Nakryiko 	void *data, *p;
11963289959bSAndrii Nakryiko 	__u32 data_sz;
11973289959bSAndrii Nakryiko 	int i;
11983289959bSAndrii Nakryiko 
11993289959bSAndrii Nakryiko 	data = swap_endian ? btf->raw_data_swapped : btf->raw_data;
12003289959bSAndrii Nakryiko 	if (data) {
12013289959bSAndrii Nakryiko 		*size = btf->raw_size;
12023289959bSAndrii Nakryiko 		return data;
12033289959bSAndrii Nakryiko 	}
12043289959bSAndrii Nakryiko 
12053289959bSAndrii Nakryiko 	data_sz = hdr->hdr_len + hdr->type_len + hdr->str_len;
12063289959bSAndrii Nakryiko 	data = calloc(1, data_sz);
12073289959bSAndrii Nakryiko 	if (!data)
12083289959bSAndrii Nakryiko 		return NULL;
12093289959bSAndrii Nakryiko 	p = data;
12103289959bSAndrii Nakryiko 
12113289959bSAndrii Nakryiko 	memcpy(p, hdr, hdr->hdr_len);
12123289959bSAndrii Nakryiko 	if (swap_endian)
12133289959bSAndrii Nakryiko 		btf_bswap_hdr(p);
12143289959bSAndrii Nakryiko 	p += hdr->hdr_len;
12153289959bSAndrii Nakryiko 
12163289959bSAndrii Nakryiko 	memcpy(p, btf->types_data, hdr->type_len);
12173289959bSAndrii Nakryiko 	if (swap_endian) {
1218ba451366SAndrii Nakryiko 		for (i = 0; i < btf->nr_types; i++) {
12193289959bSAndrii Nakryiko 			t = p + btf->type_offs[i];
12203289959bSAndrii Nakryiko 			/* btf_bswap_type_rest() relies on native t->info, so
12213289959bSAndrii Nakryiko 			 * we swap base type info after we swapped all the
12223289959bSAndrii Nakryiko 			 * additional information
12233289959bSAndrii Nakryiko 			 */
12243289959bSAndrii Nakryiko 			if (btf_bswap_type_rest(t))
12253289959bSAndrii Nakryiko 				goto err_out;
12263289959bSAndrii Nakryiko 			btf_bswap_type_base(t);
12273289959bSAndrii Nakryiko 		}
12283289959bSAndrii Nakryiko 	}
12293289959bSAndrii Nakryiko 	p += hdr->type_len;
12303289959bSAndrii Nakryiko 
123190d76d3eSAndrii Nakryiko 	memcpy(p, btf_strs_data(btf), hdr->str_len);
12323289959bSAndrii Nakryiko 	p += hdr->str_len;
12333289959bSAndrii Nakryiko 
12343289959bSAndrii Nakryiko 	*size = data_sz;
12353289959bSAndrii Nakryiko 	return data;
12363289959bSAndrii Nakryiko err_out:
12373289959bSAndrii Nakryiko 	free(data);
12383289959bSAndrii Nakryiko 	return NULL;
12393289959bSAndrii Nakryiko }
12403289959bSAndrii Nakryiko 
12416a886de0SHengqi Chen const void *btf__raw_data(const struct btf *btf_ro, __u32 *size)
124202c87446SAndrii Nakryiko {
1243919d2b1dSAndrii Nakryiko 	struct btf *btf = (struct btf *)btf_ro;
12443289959bSAndrii Nakryiko 	__u32 data_sz;
1245919d2b1dSAndrii Nakryiko 	void *data;
1246919d2b1dSAndrii Nakryiko 
12473289959bSAndrii Nakryiko 	data = btf_get_raw_data(btf, &data_sz, btf->swapped_endian);
12483289959bSAndrii Nakryiko 	if (!data)
12496a886de0SHengqi Chen 		return errno = ENOMEM, NULL;
1250919d2b1dSAndrii Nakryiko 
12513289959bSAndrii Nakryiko 	btf->raw_size = data_sz;
12523289959bSAndrii Nakryiko 	if (btf->swapped_endian)
12533289959bSAndrii Nakryiko 		btf->raw_data_swapped = data;
12543289959bSAndrii Nakryiko 	else
12553289959bSAndrii Nakryiko 		btf->raw_data = data;
12563289959bSAndrii Nakryiko 	*size = data_sz;
12573289959bSAndrii Nakryiko 	return data;
125802c87446SAndrii Nakryiko }
125902c87446SAndrii Nakryiko 
12606a886de0SHengqi Chen __attribute__((alias("btf__raw_data")))
12616a886de0SHengqi Chen const void *btf__get_raw_data(const struct btf *btf, __u32 *size);
12626a886de0SHengqi Chen 
1263f86ed050SAndrii Nakryiko const char *btf__str_by_offset(const struct btf *btf, __u32 offset)
126492b57121SOkash Khawaja {
1265ba451366SAndrii Nakryiko 	if (offset < btf->start_str_off)
1266ba451366SAndrii Nakryiko 		return btf__str_by_offset(btf->base_btf, offset);
1267ba451366SAndrii Nakryiko 	else if (offset - btf->start_str_off < btf->hdr->str_len)
126890d76d3eSAndrii Nakryiko 		return btf_strs_data(btf) + (offset - btf->start_str_off);
126992b57121SOkash Khawaja 	else
1270e9fc3ce9SAndrii Nakryiko 		return errno = EINVAL, NULL;
127192b57121SOkash Khawaja }
12722993e051SYonghong Song 
1273f86ed050SAndrii Nakryiko const char *btf__name_by_offset(const struct btf *btf, __u32 offset)
1274f86ed050SAndrii Nakryiko {
1275f86ed050SAndrii Nakryiko 	return btf__str_by_offset(btf, offset);
1276f86ed050SAndrii Nakryiko }
1277f86ed050SAndrii Nakryiko 
1278a19f93cfSAndrii Nakryiko struct btf *btf_get_from_fd(int btf_fd, struct btf *base_btf)
1279d7f5b5e0SYonghong Song {
1280a19f93cfSAndrii Nakryiko 	struct bpf_btf_info btf_info;
1281d7f5b5e0SYonghong Song 	__u32 len = sizeof(btf_info);
1282d7f5b5e0SYonghong Song 	__u32 last_size;
1283a19f93cfSAndrii Nakryiko 	struct btf *btf;
1284d7f5b5e0SYonghong Song 	void *ptr;
1285d7f5b5e0SYonghong Song 	int err;
1286d7f5b5e0SYonghong Song 
1287d7f5b5e0SYonghong Song 	/* we won't know btf_size until we call bpf_obj_get_info_by_fd(). so
1288d7f5b5e0SYonghong Song 	 * let's start with a sane default - 4KiB here - and resize it only if
1289d7f5b5e0SYonghong Song 	 * bpf_obj_get_info_by_fd() needs a bigger buffer.
1290d7f5b5e0SYonghong Song 	 */
1291a19f93cfSAndrii Nakryiko 	last_size = 4096;
1292d7f5b5e0SYonghong Song 	ptr = malloc(last_size);
1293a19f93cfSAndrii Nakryiko 	if (!ptr)
1294a19f93cfSAndrii Nakryiko 		return ERR_PTR(-ENOMEM);
1295d7f5b5e0SYonghong Song 
1296a19f93cfSAndrii Nakryiko 	memset(&btf_info, 0, sizeof(btf_info));
1297d7f5b5e0SYonghong Song 	btf_info.btf = ptr_to_u64(ptr);
1298a19f93cfSAndrii Nakryiko 	btf_info.btf_size = last_size;
1299d7f5b5e0SYonghong Song 	err = bpf_obj_get_info_by_fd(btf_fd, &btf_info, &len);
1300d7f5b5e0SYonghong Song 
1301d7f5b5e0SYonghong Song 	if (!err && btf_info.btf_size > last_size) {
1302d7f5b5e0SYonghong Song 		void *temp_ptr;
1303d7f5b5e0SYonghong Song 
1304d7f5b5e0SYonghong Song 		last_size = btf_info.btf_size;
1305d7f5b5e0SYonghong Song 		temp_ptr = realloc(ptr, last_size);
1306d7f5b5e0SYonghong Song 		if (!temp_ptr) {
1307a19f93cfSAndrii Nakryiko 			btf = ERR_PTR(-ENOMEM);
1308d7f5b5e0SYonghong Song 			goto exit_free;
1309d7f5b5e0SYonghong Song 		}
1310d7f5b5e0SYonghong Song 		ptr = temp_ptr;
1311a19f93cfSAndrii Nakryiko 
1312a19f93cfSAndrii Nakryiko 		len = sizeof(btf_info);
1313a19f93cfSAndrii Nakryiko 		memset(&btf_info, 0, sizeof(btf_info));
1314d7f5b5e0SYonghong Song 		btf_info.btf = ptr_to_u64(ptr);
1315a19f93cfSAndrii Nakryiko 		btf_info.btf_size = last_size;
1316a19f93cfSAndrii Nakryiko 
1317d7f5b5e0SYonghong Song 		err = bpf_obj_get_info_by_fd(btf_fd, &btf_info, &len);
1318d7f5b5e0SYonghong Song 	}
1319d7f5b5e0SYonghong Song 
1320d7f5b5e0SYonghong Song 	if (err || btf_info.btf_size > last_size) {
1321a19f93cfSAndrii Nakryiko 		btf = err ? ERR_PTR(-errno) : ERR_PTR(-E2BIG);
1322d7f5b5e0SYonghong Song 		goto exit_free;
1323d7f5b5e0SYonghong Song 	}
1324d7f5b5e0SYonghong Song 
1325a19f93cfSAndrii Nakryiko 	btf = btf_new(ptr, btf_info.btf_size, base_btf);
1326d7f5b5e0SYonghong Song 
1327d7f5b5e0SYonghong Song exit_free:
1328d7f5b5e0SYonghong Song 	free(ptr);
1329a19f93cfSAndrii Nakryiko 	return btf;
1330a19f93cfSAndrii Nakryiko }
1331d7f5b5e0SYonghong Song 
133261fc51b1SQuentin Monnet struct btf *btf__load_from_kernel_by_id_split(__u32 id, struct btf *base_btf)
13336cc93e2fSQuentin Monnet {
13346cc93e2fSQuentin Monnet 	struct btf *btf;
13356cc93e2fSQuentin Monnet 	int btf_fd;
13366cc93e2fSQuentin Monnet 
13376cc93e2fSQuentin Monnet 	btf_fd = bpf_btf_get_fd_by_id(id);
13386cc93e2fSQuentin Monnet 	if (btf_fd < 0)
13396cc93e2fSQuentin Monnet 		return libbpf_err_ptr(-errno);
13406cc93e2fSQuentin Monnet 
134161fc51b1SQuentin Monnet 	btf = btf_get_from_fd(btf_fd, base_btf);
13426cc93e2fSQuentin Monnet 	close(btf_fd);
13436cc93e2fSQuentin Monnet 
13446cc93e2fSQuentin Monnet 	return libbpf_ptr(btf);
13456cc93e2fSQuentin Monnet }
13466cc93e2fSQuentin Monnet 
134761fc51b1SQuentin Monnet struct btf *btf__load_from_kernel_by_id(__u32 id)
134861fc51b1SQuentin Monnet {
134961fc51b1SQuentin Monnet 	return btf__load_from_kernel_by_id_split(id, NULL);
135061fc51b1SQuentin Monnet }
135161fc51b1SQuentin Monnet 
1352a19f93cfSAndrii Nakryiko int btf__get_from_id(__u32 id, struct btf **btf)
1353a19f93cfSAndrii Nakryiko {
1354a19f93cfSAndrii Nakryiko 	struct btf *res;
13556cc93e2fSQuentin Monnet 	int err;
1356a19f93cfSAndrii Nakryiko 
1357a19f93cfSAndrii Nakryiko 	*btf = NULL;
13586cc93e2fSQuentin Monnet 	res = btf__load_from_kernel_by_id(id);
1359e9fc3ce9SAndrii Nakryiko 	err = libbpf_get_error(res);
1360e9fc3ce9SAndrii Nakryiko 
1361e9fc3ce9SAndrii Nakryiko 	if (err)
1362e9fc3ce9SAndrii Nakryiko 		return libbpf_err(err);
1363a19f93cfSAndrii Nakryiko 
1364a19f93cfSAndrii Nakryiko 	*btf = res;
1365a19f93cfSAndrii Nakryiko 	return 0;
1366d7f5b5e0SYonghong Song }
1367d7f5b5e0SYonghong Song 
1368a6c109a6SYonghong Song int btf__get_map_kv_tids(const struct btf *btf, const char *map_name,
136996408c43SYonghong Song 			 __u32 expected_key_size, __u32 expected_value_size,
137096408c43SYonghong Song 			 __u32 *key_type_id, __u32 *value_type_id)
137196408c43SYonghong Song {
137296408c43SYonghong Song 	const struct btf_type *container_type;
137396408c43SYonghong Song 	const struct btf_member *key, *value;
137496408c43SYonghong Song 	const size_t max_name = 256;
137596408c43SYonghong Song 	char container_name[max_name];
137696408c43SYonghong Song 	__s64 key_size, value_size;
137796408c43SYonghong Song 	__s32 container_id;
137896408c43SYonghong Song 
1379e9fc3ce9SAndrii Nakryiko 	if (snprintf(container_name, max_name, "____btf_map_%s", map_name) == max_name) {
1380be18010eSKefeng Wang 		pr_warn("map:%s length of '____btf_map_%s' is too long\n",
138196408c43SYonghong Song 			map_name, map_name);
1382e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
138396408c43SYonghong Song 	}
138496408c43SYonghong Song 
138596408c43SYonghong Song 	container_id = btf__find_by_name(btf, container_name);
138696408c43SYonghong Song 	if (container_id < 0) {
1387f7748e29SYonghong Song 		pr_debug("map:%s container_name:%s cannot be found in BTF. Missing BPF_ANNOTATE_KV_PAIR?\n",
138896408c43SYonghong Song 			 map_name, container_name);
1389e9fc3ce9SAndrii Nakryiko 		return libbpf_err(container_id);
139096408c43SYonghong Song 	}
139196408c43SYonghong Song 
139296408c43SYonghong Song 	container_type = btf__type_by_id(btf, container_id);
139396408c43SYonghong Song 	if (!container_type) {
1394be18010eSKefeng Wang 		pr_warn("map:%s cannot find BTF type for container_id:%u\n",
139596408c43SYonghong Song 			map_name, container_id);
1396e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
139796408c43SYonghong Song 	}
139896408c43SYonghong Song 
1399b03bc685SAndrii Nakryiko 	if (!btf_is_struct(container_type) || btf_vlen(container_type) < 2) {
1400be18010eSKefeng Wang 		pr_warn("map:%s container_name:%s is an invalid container struct\n",
140196408c43SYonghong Song 			map_name, container_name);
1402e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
140396408c43SYonghong Song 	}
140496408c43SYonghong Song 
1405b03bc685SAndrii Nakryiko 	key = btf_members(container_type);
140696408c43SYonghong Song 	value = key + 1;
140796408c43SYonghong Song 
140896408c43SYonghong Song 	key_size = btf__resolve_size(btf, key->type);
140996408c43SYonghong Song 	if (key_size < 0) {
1410be18010eSKefeng Wang 		pr_warn("map:%s invalid BTF key_type_size\n", map_name);
1411e9fc3ce9SAndrii Nakryiko 		return libbpf_err(key_size);
141296408c43SYonghong Song 	}
141396408c43SYonghong Song 
141496408c43SYonghong Song 	if (expected_key_size != key_size) {
1415be18010eSKefeng Wang 		pr_warn("map:%s btf_key_type_size:%u != map_def_key_size:%u\n",
141696408c43SYonghong Song 			map_name, (__u32)key_size, expected_key_size);
1417e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
141896408c43SYonghong Song 	}
141996408c43SYonghong Song 
142096408c43SYonghong Song 	value_size = btf__resolve_size(btf, value->type);
142196408c43SYonghong Song 	if (value_size < 0) {
1422be18010eSKefeng Wang 		pr_warn("map:%s invalid BTF value_type_size\n", map_name);
1423e9fc3ce9SAndrii Nakryiko 		return libbpf_err(value_size);
142496408c43SYonghong Song 	}
142596408c43SYonghong Song 
142696408c43SYonghong Song 	if (expected_value_size != value_size) {
1427be18010eSKefeng Wang 		pr_warn("map:%s btf_value_type_size:%u != map_def_value_size:%u\n",
142896408c43SYonghong Song 			map_name, (__u32)value_size, expected_value_size);
1429e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
143096408c43SYonghong Song 	}
143196408c43SYonghong Song 
143296408c43SYonghong Song 	*key_type_id = key->type;
143396408c43SYonghong Song 	*value_type_id = value->type;
143496408c43SYonghong Song 
143596408c43SYonghong Song 	return 0;
143696408c43SYonghong Song }
143796408c43SYonghong Song 
14383289959bSAndrii Nakryiko static void btf_invalidate_raw_data(struct btf *btf)
14393289959bSAndrii Nakryiko {
14403289959bSAndrii Nakryiko 	if (btf->raw_data) {
14413289959bSAndrii Nakryiko 		free(btf->raw_data);
14423289959bSAndrii Nakryiko 		btf->raw_data = NULL;
14433289959bSAndrii Nakryiko 	}
14443289959bSAndrii Nakryiko 	if (btf->raw_data_swapped) {
14453289959bSAndrii Nakryiko 		free(btf->raw_data_swapped);
14463289959bSAndrii Nakryiko 		btf->raw_data_swapped = NULL;
14473289959bSAndrii Nakryiko 	}
14483289959bSAndrii Nakryiko }
14493289959bSAndrii Nakryiko 
1450919d2b1dSAndrii Nakryiko /* Ensure BTF is ready to be modified (by splitting into a three memory
1451919d2b1dSAndrii Nakryiko  * regions for header, types, and strings). Also invalidate cached
1452919d2b1dSAndrii Nakryiko  * raw_data, if any.
1453919d2b1dSAndrii Nakryiko  */
1454919d2b1dSAndrii Nakryiko static int btf_ensure_modifiable(struct btf *btf)
1455919d2b1dSAndrii Nakryiko {
145690d76d3eSAndrii Nakryiko 	void *hdr, *types;
145790d76d3eSAndrii Nakryiko 	struct strset *set = NULL;
145890d76d3eSAndrii Nakryiko 	int err = -ENOMEM;
1459919d2b1dSAndrii Nakryiko 
1460919d2b1dSAndrii Nakryiko 	if (btf_is_modifiable(btf)) {
1461919d2b1dSAndrii Nakryiko 		/* any BTF modification invalidates raw_data */
14623289959bSAndrii Nakryiko 		btf_invalidate_raw_data(btf);
1463919d2b1dSAndrii Nakryiko 		return 0;
1464919d2b1dSAndrii Nakryiko 	}
1465919d2b1dSAndrii Nakryiko 
1466919d2b1dSAndrii Nakryiko 	/* split raw data into three memory regions */
1467919d2b1dSAndrii Nakryiko 	hdr = malloc(btf->hdr->hdr_len);
1468919d2b1dSAndrii Nakryiko 	types = malloc(btf->hdr->type_len);
146990d76d3eSAndrii Nakryiko 	if (!hdr || !types)
1470919d2b1dSAndrii Nakryiko 		goto err_out;
1471919d2b1dSAndrii Nakryiko 
1472919d2b1dSAndrii Nakryiko 	memcpy(hdr, btf->hdr, btf->hdr->hdr_len);
1473919d2b1dSAndrii Nakryiko 	memcpy(types, btf->types_data, btf->hdr->type_len);
147488a82c2aSAndrii Nakryiko 
1475919d2b1dSAndrii Nakryiko 	/* build lookup index for all strings */
147690d76d3eSAndrii Nakryiko 	set = strset__new(BTF_MAX_STR_OFFSET, btf->strs_data, btf->hdr->str_len);
147790d76d3eSAndrii Nakryiko 	if (IS_ERR(set)) {
147890d76d3eSAndrii Nakryiko 		err = PTR_ERR(set);
1479919d2b1dSAndrii Nakryiko 		goto err_out;
1480919d2b1dSAndrii Nakryiko 	}
1481919d2b1dSAndrii Nakryiko 
1482919d2b1dSAndrii Nakryiko 	/* only when everything was successful, update internal state */
1483919d2b1dSAndrii Nakryiko 	btf->hdr = hdr;
1484919d2b1dSAndrii Nakryiko 	btf->types_data = types;
1485919d2b1dSAndrii Nakryiko 	btf->types_data_cap = btf->hdr->type_len;
148690d76d3eSAndrii Nakryiko 	btf->strs_data = NULL;
148790d76d3eSAndrii Nakryiko 	btf->strs_set = set;
1488919d2b1dSAndrii Nakryiko 	/* if BTF was created from scratch, all strings are guaranteed to be
1489919d2b1dSAndrii Nakryiko 	 * unique and deduplicated
1490919d2b1dSAndrii Nakryiko 	 */
1491ba451366SAndrii Nakryiko 	if (btf->hdr->str_len == 0)
1492ba451366SAndrii Nakryiko 		btf->strs_deduped = true;
1493ba451366SAndrii Nakryiko 	if (!btf->base_btf && btf->hdr->str_len == 1)
1494ba451366SAndrii Nakryiko 		btf->strs_deduped = true;
1495919d2b1dSAndrii Nakryiko 
1496919d2b1dSAndrii Nakryiko 	/* invalidate raw_data representation */
14973289959bSAndrii Nakryiko 	btf_invalidate_raw_data(btf);
1498919d2b1dSAndrii Nakryiko 
1499919d2b1dSAndrii Nakryiko 	return 0;
1500919d2b1dSAndrii Nakryiko 
1501919d2b1dSAndrii Nakryiko err_out:
150290d76d3eSAndrii Nakryiko 	strset__free(set);
1503919d2b1dSAndrii Nakryiko 	free(hdr);
1504919d2b1dSAndrii Nakryiko 	free(types);
150590d76d3eSAndrii Nakryiko 	return err;
1506919d2b1dSAndrii Nakryiko }
1507919d2b1dSAndrii Nakryiko 
1508919d2b1dSAndrii Nakryiko /* Find an offset in BTF string section that corresponds to a given string *s*.
1509919d2b1dSAndrii Nakryiko  * Returns:
1510919d2b1dSAndrii Nakryiko  *   - >0 offset into string section, if string is found;
1511919d2b1dSAndrii Nakryiko  *   - -ENOENT, if string is not in the string section;
1512919d2b1dSAndrii Nakryiko  *   - <0, on any other error.
1513919d2b1dSAndrii Nakryiko  */
1514919d2b1dSAndrii Nakryiko int btf__find_str(struct btf *btf, const char *s)
1515919d2b1dSAndrii Nakryiko {
151690d76d3eSAndrii Nakryiko 	int off;
1517919d2b1dSAndrii Nakryiko 
1518ba451366SAndrii Nakryiko 	if (btf->base_btf) {
151990d76d3eSAndrii Nakryiko 		off = btf__find_str(btf->base_btf, s);
152090d76d3eSAndrii Nakryiko 		if (off != -ENOENT)
152190d76d3eSAndrii Nakryiko 			return off;
1522ba451366SAndrii Nakryiko 	}
1523ba451366SAndrii Nakryiko 
1524919d2b1dSAndrii Nakryiko 	/* BTF needs to be in a modifiable state to build string lookup index */
1525919d2b1dSAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
1526e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
1527919d2b1dSAndrii Nakryiko 
152890d76d3eSAndrii Nakryiko 	off = strset__find_str(btf->strs_set, s);
152990d76d3eSAndrii Nakryiko 	if (off < 0)
1530e9fc3ce9SAndrii Nakryiko 		return libbpf_err(off);
1531919d2b1dSAndrii Nakryiko 
153290d76d3eSAndrii Nakryiko 	return btf->start_str_off + off;
1533919d2b1dSAndrii Nakryiko }
1534919d2b1dSAndrii Nakryiko 
1535919d2b1dSAndrii Nakryiko /* Add a string s to the BTF string section.
1536919d2b1dSAndrii Nakryiko  * Returns:
1537919d2b1dSAndrii Nakryiko  *   - > 0 offset into string section, on success;
1538919d2b1dSAndrii Nakryiko  *   - < 0, on error.
1539919d2b1dSAndrii Nakryiko  */
1540919d2b1dSAndrii Nakryiko int btf__add_str(struct btf *btf, const char *s)
1541919d2b1dSAndrii Nakryiko {
154290d76d3eSAndrii Nakryiko 	int off;
1543919d2b1dSAndrii Nakryiko 
1544ba451366SAndrii Nakryiko 	if (btf->base_btf) {
154590d76d3eSAndrii Nakryiko 		off = btf__find_str(btf->base_btf, s);
154690d76d3eSAndrii Nakryiko 		if (off != -ENOENT)
154790d76d3eSAndrii Nakryiko 			return off;
1548ba451366SAndrii Nakryiko 	}
1549ba451366SAndrii Nakryiko 
1550919d2b1dSAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
1551e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
1552919d2b1dSAndrii Nakryiko 
155390d76d3eSAndrii Nakryiko 	off = strset__add_str(btf->strs_set, s);
155490d76d3eSAndrii Nakryiko 	if (off < 0)
1555e9fc3ce9SAndrii Nakryiko 		return libbpf_err(off);
1556919d2b1dSAndrii Nakryiko 
155790d76d3eSAndrii Nakryiko 	btf->hdr->str_len = strset__data_size(btf->strs_set);
1558919d2b1dSAndrii Nakryiko 
155990d76d3eSAndrii Nakryiko 	return btf->start_str_off + off;
1560919d2b1dSAndrii Nakryiko }
1561919d2b1dSAndrii Nakryiko 
15624a3b33f8SAndrii Nakryiko static void *btf_add_type_mem(struct btf *btf, size_t add_sz)
15634a3b33f8SAndrii Nakryiko {
15643b029e06SAndrii Nakryiko 	return libbpf_add_mem(&btf->types_data, &btf->types_data_cap, 1,
15654a3b33f8SAndrii Nakryiko 			      btf->hdr->type_len, UINT_MAX, add_sz);
15664a3b33f8SAndrii Nakryiko }
15674a3b33f8SAndrii Nakryiko 
15684a3b33f8SAndrii Nakryiko static void btf_type_inc_vlen(struct btf_type *t)
15694a3b33f8SAndrii Nakryiko {
15704a3b33f8SAndrii Nakryiko 	t->info = btf_type_info(btf_kind(t), btf_vlen(t) + 1, btf_kflag(t));
15714a3b33f8SAndrii Nakryiko }
15724a3b33f8SAndrii Nakryiko 
1573c81ed6d8SAndrii Nakryiko static int btf_commit_type(struct btf *btf, int data_sz)
1574c81ed6d8SAndrii Nakryiko {
1575c81ed6d8SAndrii Nakryiko 	int err;
1576c81ed6d8SAndrii Nakryiko 
1577c81ed6d8SAndrii Nakryiko 	err = btf_add_type_idx_entry(btf, btf->hdr->type_len);
1578c81ed6d8SAndrii Nakryiko 	if (err)
1579e9fc3ce9SAndrii Nakryiko 		return libbpf_err(err);
1580c81ed6d8SAndrii Nakryiko 
1581c81ed6d8SAndrii Nakryiko 	btf->hdr->type_len += data_sz;
1582c81ed6d8SAndrii Nakryiko 	btf->hdr->str_off += data_sz;
1583c81ed6d8SAndrii Nakryiko 	btf->nr_types++;
1584ba451366SAndrii Nakryiko 	return btf->start_id + btf->nr_types - 1;
1585c81ed6d8SAndrii Nakryiko }
1586c81ed6d8SAndrii Nakryiko 
15879af44bc5SAndrii Nakryiko struct btf_pipe {
15889af44bc5SAndrii Nakryiko 	const struct btf *src;
15899af44bc5SAndrii Nakryiko 	struct btf *dst;
15909af44bc5SAndrii Nakryiko };
15919af44bc5SAndrii Nakryiko 
15929af44bc5SAndrii Nakryiko static int btf_rewrite_str(__u32 *str_off, void *ctx)
15939af44bc5SAndrii Nakryiko {
15949af44bc5SAndrii Nakryiko 	struct btf_pipe *p = ctx;
15959af44bc5SAndrii Nakryiko 	int off;
15969af44bc5SAndrii Nakryiko 
15979af44bc5SAndrii Nakryiko 	if (!*str_off) /* nothing to do for empty strings */
15989af44bc5SAndrii Nakryiko 		return 0;
15999af44bc5SAndrii Nakryiko 
16009af44bc5SAndrii Nakryiko 	off = btf__add_str(p->dst, btf__str_by_offset(p->src, *str_off));
16019af44bc5SAndrii Nakryiko 	if (off < 0)
16029af44bc5SAndrii Nakryiko 		return off;
16039af44bc5SAndrii Nakryiko 
16049af44bc5SAndrii Nakryiko 	*str_off = off;
16059af44bc5SAndrii Nakryiko 	return 0;
16069af44bc5SAndrii Nakryiko }
16079af44bc5SAndrii Nakryiko 
16089af44bc5SAndrii Nakryiko int btf__add_type(struct btf *btf, const struct btf *src_btf, const struct btf_type *src_type)
16099af44bc5SAndrii Nakryiko {
16109af44bc5SAndrii Nakryiko 	struct btf_pipe p = { .src = src_btf, .dst = btf };
16119af44bc5SAndrii Nakryiko 	struct btf_type *t;
16129af44bc5SAndrii Nakryiko 	int sz, err;
16139af44bc5SAndrii Nakryiko 
16149af44bc5SAndrii Nakryiko 	sz = btf_type_size(src_type);
16159af44bc5SAndrii Nakryiko 	if (sz < 0)
1616e9fc3ce9SAndrii Nakryiko 		return libbpf_err(sz);
16179af44bc5SAndrii Nakryiko 
16189af44bc5SAndrii Nakryiko 	/* deconstruct BTF, if necessary, and invalidate raw_data */
16199af44bc5SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
1620e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
16219af44bc5SAndrii Nakryiko 
16229af44bc5SAndrii Nakryiko 	t = btf_add_type_mem(btf, sz);
16239af44bc5SAndrii Nakryiko 	if (!t)
1624e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
16259af44bc5SAndrii Nakryiko 
16269af44bc5SAndrii Nakryiko 	memcpy(t, src_type, sz);
16279af44bc5SAndrii Nakryiko 
16289af44bc5SAndrii Nakryiko 	err = btf_type_visit_str_offs(t, btf_rewrite_str, &p);
16299af44bc5SAndrii Nakryiko 	if (err)
1630e9fc3ce9SAndrii Nakryiko 		return libbpf_err(err);
16319af44bc5SAndrii Nakryiko 
16329af44bc5SAndrii Nakryiko 	return btf_commit_type(btf, sz);
16339af44bc5SAndrii Nakryiko }
16349af44bc5SAndrii Nakryiko 
16357ca61121SAndrii Nakryiko static int btf_rewrite_type_ids(__u32 *type_id, void *ctx)
16367ca61121SAndrii Nakryiko {
16377ca61121SAndrii Nakryiko 	struct btf *btf = ctx;
16387ca61121SAndrii Nakryiko 
16397ca61121SAndrii Nakryiko 	if (!*type_id) /* nothing to do for VOID references */
16407ca61121SAndrii Nakryiko 		return 0;
16417ca61121SAndrii Nakryiko 
16427ca61121SAndrii Nakryiko 	/* we haven't updated btf's type count yet, so
16437ca61121SAndrii Nakryiko 	 * btf->start_id + btf->nr_types - 1 is the type ID offset we should
16447ca61121SAndrii Nakryiko 	 * add to all newly added BTF types
16457ca61121SAndrii Nakryiko 	 */
16467ca61121SAndrii Nakryiko 	*type_id += btf->start_id + btf->nr_types - 1;
16477ca61121SAndrii Nakryiko 	return 0;
16487ca61121SAndrii Nakryiko }
16497ca61121SAndrii Nakryiko 
16507ca61121SAndrii Nakryiko int btf__add_btf(struct btf *btf, const struct btf *src_btf)
16517ca61121SAndrii Nakryiko {
16527ca61121SAndrii Nakryiko 	struct btf_pipe p = { .src = src_btf, .dst = btf };
16537ca61121SAndrii Nakryiko 	int data_sz, sz, cnt, i, err, old_strs_len;
16547ca61121SAndrii Nakryiko 	__u32 *off;
16557ca61121SAndrii Nakryiko 	void *t;
16567ca61121SAndrii Nakryiko 
16577ca61121SAndrii Nakryiko 	/* appending split BTF isn't supported yet */
16587ca61121SAndrii Nakryiko 	if (src_btf->base_btf)
16597ca61121SAndrii Nakryiko 		return libbpf_err(-ENOTSUP);
16607ca61121SAndrii Nakryiko 
16617ca61121SAndrii Nakryiko 	/* deconstruct BTF, if necessary, and invalidate raw_data */
16627ca61121SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
16637ca61121SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
16647ca61121SAndrii Nakryiko 
16657ca61121SAndrii Nakryiko 	/* remember original strings section size if we have to roll back
16667ca61121SAndrii Nakryiko 	 * partial strings section changes
16677ca61121SAndrii Nakryiko 	 */
16687ca61121SAndrii Nakryiko 	old_strs_len = btf->hdr->str_len;
16697ca61121SAndrii Nakryiko 
16707ca61121SAndrii Nakryiko 	data_sz = src_btf->hdr->type_len;
16716a886de0SHengqi Chen 	cnt = btf__type_cnt(src_btf) - 1;
16727ca61121SAndrii Nakryiko 
16737ca61121SAndrii Nakryiko 	/* pre-allocate enough memory for new types */
16747ca61121SAndrii Nakryiko 	t = btf_add_type_mem(btf, data_sz);
16757ca61121SAndrii Nakryiko 	if (!t)
16767ca61121SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
16777ca61121SAndrii Nakryiko 
16787ca61121SAndrii Nakryiko 	/* pre-allocate enough memory for type offset index for new types */
16797ca61121SAndrii Nakryiko 	off = btf_add_type_offs_mem(btf, cnt);
16807ca61121SAndrii Nakryiko 	if (!off)
16817ca61121SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
16827ca61121SAndrii Nakryiko 
16837ca61121SAndrii Nakryiko 	/* bulk copy types data for all types from src_btf */
16847ca61121SAndrii Nakryiko 	memcpy(t, src_btf->types_data, data_sz);
16857ca61121SAndrii Nakryiko 
16867ca61121SAndrii Nakryiko 	for (i = 0; i < cnt; i++) {
16877ca61121SAndrii Nakryiko 		sz = btf_type_size(t);
16887ca61121SAndrii Nakryiko 		if (sz < 0) {
16897ca61121SAndrii Nakryiko 			/* unlikely, has to be corrupted src_btf */
16907ca61121SAndrii Nakryiko 			err = sz;
16917ca61121SAndrii Nakryiko 			goto err_out;
16927ca61121SAndrii Nakryiko 		}
16937ca61121SAndrii Nakryiko 
16947ca61121SAndrii Nakryiko 		/* fill out type ID to type offset mapping for lookups by type ID */
16957ca61121SAndrii Nakryiko 		*off = t - btf->types_data;
16967ca61121SAndrii Nakryiko 
16977ca61121SAndrii Nakryiko 		/* add, dedup, and remap strings referenced by this BTF type */
16987ca61121SAndrii Nakryiko 		err = btf_type_visit_str_offs(t, btf_rewrite_str, &p);
16997ca61121SAndrii Nakryiko 		if (err)
17007ca61121SAndrii Nakryiko 			goto err_out;
17017ca61121SAndrii Nakryiko 
17027ca61121SAndrii Nakryiko 		/* remap all type IDs referenced from this BTF type */
17037ca61121SAndrii Nakryiko 		err = btf_type_visit_type_ids(t, btf_rewrite_type_ids, btf);
17047ca61121SAndrii Nakryiko 		if (err)
17057ca61121SAndrii Nakryiko 			goto err_out;
17067ca61121SAndrii Nakryiko 
17077ca61121SAndrii Nakryiko 		/* go to next type data and type offset index entry */
17087ca61121SAndrii Nakryiko 		t += sz;
17097ca61121SAndrii Nakryiko 		off++;
17107ca61121SAndrii Nakryiko 	}
17117ca61121SAndrii Nakryiko 
17127ca61121SAndrii Nakryiko 	/* Up until now any of the copied type data was effectively invisible,
17137ca61121SAndrii Nakryiko 	 * so if we exited early before this point due to error, BTF would be
17147ca61121SAndrii Nakryiko 	 * effectively unmodified. There would be extra internal memory
17157ca61121SAndrii Nakryiko 	 * pre-allocated, but it would not be available for querying.  But now
17167ca61121SAndrii Nakryiko 	 * that we've copied and rewritten all the data successfully, we can
17177ca61121SAndrii Nakryiko 	 * update type count and various internal offsets and sizes to
17187ca61121SAndrii Nakryiko 	 * "commit" the changes and made them visible to the outside world.
17197ca61121SAndrii Nakryiko 	 */
17207ca61121SAndrii Nakryiko 	btf->hdr->type_len += data_sz;
17217ca61121SAndrii Nakryiko 	btf->hdr->str_off += data_sz;
17227ca61121SAndrii Nakryiko 	btf->nr_types += cnt;
17237ca61121SAndrii Nakryiko 
17247ca61121SAndrii Nakryiko 	/* return type ID of the first added BTF type */
17257ca61121SAndrii Nakryiko 	return btf->start_id + btf->nr_types - cnt;
17267ca61121SAndrii Nakryiko err_out:
17277ca61121SAndrii Nakryiko 	/* zero out preallocated memory as if it was just allocated with
17287ca61121SAndrii Nakryiko 	 * libbpf_add_mem()
17297ca61121SAndrii Nakryiko 	 */
17307ca61121SAndrii Nakryiko 	memset(btf->types_data + btf->hdr->type_len, 0, data_sz);
17317ca61121SAndrii Nakryiko 	memset(btf->strs_data + old_strs_len, 0, btf->hdr->str_len - old_strs_len);
17327ca61121SAndrii Nakryiko 
17337ca61121SAndrii Nakryiko 	/* and now restore original strings section size; types data size
17347ca61121SAndrii Nakryiko 	 * wasn't modified, so doesn't need restoring, see big comment above */
17357ca61121SAndrii Nakryiko 	btf->hdr->str_len = old_strs_len;
17367ca61121SAndrii Nakryiko 
17377ca61121SAndrii Nakryiko 	return libbpf_err(err);
17387ca61121SAndrii Nakryiko }
17397ca61121SAndrii Nakryiko 
17404a3b33f8SAndrii Nakryiko /*
17414a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_INT type with:
17424a3b33f8SAndrii Nakryiko  *   - *name* - non-empty, non-NULL type name;
17434a3b33f8SAndrii Nakryiko  *   - *sz* - power-of-2 (1, 2, 4, ..) size of the type, in bytes;
17444a3b33f8SAndrii Nakryiko  *   - encoding is a combination of BTF_INT_SIGNED, BTF_INT_CHAR, BTF_INT_BOOL.
17454a3b33f8SAndrii Nakryiko  * Returns:
17464a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
17474a3b33f8SAndrii Nakryiko  *   - <0, on error.
17484a3b33f8SAndrii Nakryiko  */
17494a3b33f8SAndrii Nakryiko int btf__add_int(struct btf *btf, const char *name, size_t byte_sz, int encoding)
17504a3b33f8SAndrii Nakryiko {
17514a3b33f8SAndrii Nakryiko 	struct btf_type *t;
1752c81ed6d8SAndrii Nakryiko 	int sz, name_off;
17534a3b33f8SAndrii Nakryiko 
17544a3b33f8SAndrii Nakryiko 	/* non-empty name */
17554a3b33f8SAndrii Nakryiko 	if (!name || !name[0])
1756e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
17574a3b33f8SAndrii Nakryiko 	/* byte_sz must be power of 2 */
17584a3b33f8SAndrii Nakryiko 	if (!byte_sz || (byte_sz & (byte_sz - 1)) || byte_sz > 16)
1759e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
17604a3b33f8SAndrii Nakryiko 	if (encoding & ~(BTF_INT_SIGNED | BTF_INT_CHAR | BTF_INT_BOOL))
1761e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
17624a3b33f8SAndrii Nakryiko 
17634a3b33f8SAndrii Nakryiko 	/* deconstruct BTF, if necessary, and invalidate raw_data */
17644a3b33f8SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
1765e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
17664a3b33f8SAndrii Nakryiko 
17674a3b33f8SAndrii Nakryiko 	sz = sizeof(struct btf_type) + sizeof(int);
17684a3b33f8SAndrii Nakryiko 	t = btf_add_type_mem(btf, sz);
17694a3b33f8SAndrii Nakryiko 	if (!t)
1770e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
17714a3b33f8SAndrii Nakryiko 
17724a3b33f8SAndrii Nakryiko 	/* if something goes wrong later, we might end up with an extra string,
17734a3b33f8SAndrii Nakryiko 	 * but that shouldn't be a problem, because BTF can't be constructed
17744a3b33f8SAndrii Nakryiko 	 * completely anyway and will most probably be just discarded
17754a3b33f8SAndrii Nakryiko 	 */
17764a3b33f8SAndrii Nakryiko 	name_off = btf__add_str(btf, name);
17774a3b33f8SAndrii Nakryiko 	if (name_off < 0)
17784a3b33f8SAndrii Nakryiko 		return name_off;
17794a3b33f8SAndrii Nakryiko 
17804a3b33f8SAndrii Nakryiko 	t->name_off = name_off;
17814a3b33f8SAndrii Nakryiko 	t->info = btf_type_info(BTF_KIND_INT, 0, 0);
17824a3b33f8SAndrii Nakryiko 	t->size = byte_sz;
17834a3b33f8SAndrii Nakryiko 	/* set INT info, we don't allow setting legacy bit offset/size */
17844a3b33f8SAndrii Nakryiko 	*(__u32 *)(t + 1) = (encoding << 24) | (byte_sz * 8);
17854a3b33f8SAndrii Nakryiko 
1786c81ed6d8SAndrii Nakryiko 	return btf_commit_type(btf, sz);
17874a3b33f8SAndrii Nakryiko }
17884a3b33f8SAndrii Nakryiko 
178922541a9eSIlya Leoshkevich /*
179022541a9eSIlya Leoshkevich  * Append new BTF_KIND_FLOAT type with:
179122541a9eSIlya Leoshkevich  *   - *name* - non-empty, non-NULL type name;
179222541a9eSIlya Leoshkevich  *   - *sz* - size of the type, in bytes;
179322541a9eSIlya Leoshkevich  * Returns:
179422541a9eSIlya Leoshkevich  *   - >0, type ID of newly added BTF type;
179522541a9eSIlya Leoshkevich  *   - <0, on error.
179622541a9eSIlya Leoshkevich  */
179722541a9eSIlya Leoshkevich int btf__add_float(struct btf *btf, const char *name, size_t byte_sz)
179822541a9eSIlya Leoshkevich {
179922541a9eSIlya Leoshkevich 	struct btf_type *t;
180022541a9eSIlya Leoshkevich 	int sz, name_off;
180122541a9eSIlya Leoshkevich 
180222541a9eSIlya Leoshkevich 	/* non-empty name */
180322541a9eSIlya Leoshkevich 	if (!name || !name[0])
1804e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
180522541a9eSIlya Leoshkevich 
180622541a9eSIlya Leoshkevich 	/* byte_sz must be one of the explicitly allowed values */
180722541a9eSIlya Leoshkevich 	if (byte_sz != 2 && byte_sz != 4 && byte_sz != 8 && byte_sz != 12 &&
180822541a9eSIlya Leoshkevich 	    byte_sz != 16)
1809e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
181022541a9eSIlya Leoshkevich 
181122541a9eSIlya Leoshkevich 	if (btf_ensure_modifiable(btf))
1812e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
181322541a9eSIlya Leoshkevich 
181422541a9eSIlya Leoshkevich 	sz = sizeof(struct btf_type);
181522541a9eSIlya Leoshkevich 	t = btf_add_type_mem(btf, sz);
181622541a9eSIlya Leoshkevich 	if (!t)
1817e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
181822541a9eSIlya Leoshkevich 
181922541a9eSIlya Leoshkevich 	name_off = btf__add_str(btf, name);
182022541a9eSIlya Leoshkevich 	if (name_off < 0)
182122541a9eSIlya Leoshkevich 		return name_off;
182222541a9eSIlya Leoshkevich 
182322541a9eSIlya Leoshkevich 	t->name_off = name_off;
182422541a9eSIlya Leoshkevich 	t->info = btf_type_info(BTF_KIND_FLOAT, 0, 0);
182522541a9eSIlya Leoshkevich 	t->size = byte_sz;
182622541a9eSIlya Leoshkevich 
182722541a9eSIlya Leoshkevich 	return btf_commit_type(btf, sz);
182822541a9eSIlya Leoshkevich }
182922541a9eSIlya Leoshkevich 
18304a3b33f8SAndrii Nakryiko /* it's completely legal to append BTF types with type IDs pointing forward to
18314a3b33f8SAndrii Nakryiko  * types that haven't been appended yet, so we only make sure that id looks
18324a3b33f8SAndrii Nakryiko  * sane, we can't guarantee that ID will always be valid
18334a3b33f8SAndrii Nakryiko  */
18344a3b33f8SAndrii Nakryiko static int validate_type_id(int id)
18354a3b33f8SAndrii Nakryiko {
18364a3b33f8SAndrii Nakryiko 	if (id < 0 || id > BTF_MAX_NR_TYPES)
18374a3b33f8SAndrii Nakryiko 		return -EINVAL;
18384a3b33f8SAndrii Nakryiko 	return 0;
18394a3b33f8SAndrii Nakryiko }
18404a3b33f8SAndrii Nakryiko 
18414a3b33f8SAndrii Nakryiko /* generic append function for PTR, TYPEDEF, CONST/VOLATILE/RESTRICT */
18424a3b33f8SAndrii Nakryiko static int btf_add_ref_kind(struct btf *btf, int kind, const char *name, int ref_type_id)
18434a3b33f8SAndrii Nakryiko {
18444a3b33f8SAndrii Nakryiko 	struct btf_type *t;
1845c81ed6d8SAndrii Nakryiko 	int sz, name_off = 0;
18464a3b33f8SAndrii Nakryiko 
18474a3b33f8SAndrii Nakryiko 	if (validate_type_id(ref_type_id))
1848e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
18494a3b33f8SAndrii Nakryiko 
18504a3b33f8SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
1851e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
18524a3b33f8SAndrii Nakryiko 
18534a3b33f8SAndrii Nakryiko 	sz = sizeof(struct btf_type);
18544a3b33f8SAndrii Nakryiko 	t = btf_add_type_mem(btf, sz);
18554a3b33f8SAndrii Nakryiko 	if (!t)
1856e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
18574a3b33f8SAndrii Nakryiko 
18584a3b33f8SAndrii Nakryiko 	if (name && name[0]) {
18594a3b33f8SAndrii Nakryiko 		name_off = btf__add_str(btf, name);
18604a3b33f8SAndrii Nakryiko 		if (name_off < 0)
18614a3b33f8SAndrii Nakryiko 			return name_off;
18624a3b33f8SAndrii Nakryiko 	}
18634a3b33f8SAndrii Nakryiko 
18644a3b33f8SAndrii Nakryiko 	t->name_off = name_off;
18654a3b33f8SAndrii Nakryiko 	t->info = btf_type_info(kind, 0, 0);
18664a3b33f8SAndrii Nakryiko 	t->type = ref_type_id;
18674a3b33f8SAndrii Nakryiko 
1868c81ed6d8SAndrii Nakryiko 	return btf_commit_type(btf, sz);
18694a3b33f8SAndrii Nakryiko }
18704a3b33f8SAndrii Nakryiko 
18714a3b33f8SAndrii Nakryiko /*
18724a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_PTR type with:
18734a3b33f8SAndrii Nakryiko  *   - *ref_type_id* - referenced type ID, it might not exist yet;
18744a3b33f8SAndrii Nakryiko  * Returns:
18754a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
18764a3b33f8SAndrii Nakryiko  *   - <0, on error.
18774a3b33f8SAndrii Nakryiko  */
18784a3b33f8SAndrii Nakryiko int btf__add_ptr(struct btf *btf, int ref_type_id)
18794a3b33f8SAndrii Nakryiko {
18804a3b33f8SAndrii Nakryiko 	return btf_add_ref_kind(btf, BTF_KIND_PTR, NULL, ref_type_id);
18814a3b33f8SAndrii Nakryiko }
18824a3b33f8SAndrii Nakryiko 
18834a3b33f8SAndrii Nakryiko /*
18844a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_ARRAY type with:
18854a3b33f8SAndrii Nakryiko  *   - *index_type_id* - type ID of the type describing array index;
18864a3b33f8SAndrii Nakryiko  *   - *elem_type_id* - type ID of the type describing array element;
18874a3b33f8SAndrii Nakryiko  *   - *nr_elems* - the size of the array;
18884a3b33f8SAndrii Nakryiko  * Returns:
18894a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
18904a3b33f8SAndrii Nakryiko  *   - <0, on error.
18914a3b33f8SAndrii Nakryiko  */
18924a3b33f8SAndrii Nakryiko int btf__add_array(struct btf *btf, int index_type_id, int elem_type_id, __u32 nr_elems)
18934a3b33f8SAndrii Nakryiko {
18944a3b33f8SAndrii Nakryiko 	struct btf_type *t;
18954a3b33f8SAndrii Nakryiko 	struct btf_array *a;
1896c81ed6d8SAndrii Nakryiko 	int sz;
18974a3b33f8SAndrii Nakryiko 
18984a3b33f8SAndrii Nakryiko 	if (validate_type_id(index_type_id) || validate_type_id(elem_type_id))
1899e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
19004a3b33f8SAndrii Nakryiko 
19014a3b33f8SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
1902e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
19034a3b33f8SAndrii Nakryiko 
19044a3b33f8SAndrii Nakryiko 	sz = sizeof(struct btf_type) + sizeof(struct btf_array);
19054a3b33f8SAndrii Nakryiko 	t = btf_add_type_mem(btf, sz);
19064a3b33f8SAndrii Nakryiko 	if (!t)
1907e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
19084a3b33f8SAndrii Nakryiko 
19094a3b33f8SAndrii Nakryiko 	t->name_off = 0;
19104a3b33f8SAndrii Nakryiko 	t->info = btf_type_info(BTF_KIND_ARRAY, 0, 0);
19114a3b33f8SAndrii Nakryiko 	t->size = 0;
19124a3b33f8SAndrii Nakryiko 
19134a3b33f8SAndrii Nakryiko 	a = btf_array(t);
19144a3b33f8SAndrii Nakryiko 	a->type = elem_type_id;
19154a3b33f8SAndrii Nakryiko 	a->index_type = index_type_id;
19164a3b33f8SAndrii Nakryiko 	a->nelems = nr_elems;
19174a3b33f8SAndrii Nakryiko 
1918c81ed6d8SAndrii Nakryiko 	return btf_commit_type(btf, sz);
19194a3b33f8SAndrii Nakryiko }
19204a3b33f8SAndrii Nakryiko 
19214a3b33f8SAndrii Nakryiko /* generic STRUCT/UNION append function */
19224a3b33f8SAndrii Nakryiko static int btf_add_composite(struct btf *btf, int kind, const char *name, __u32 bytes_sz)
19234a3b33f8SAndrii Nakryiko {
19244a3b33f8SAndrii Nakryiko 	struct btf_type *t;
1925c81ed6d8SAndrii Nakryiko 	int sz, name_off = 0;
19264a3b33f8SAndrii Nakryiko 
19274a3b33f8SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
1928e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
19294a3b33f8SAndrii Nakryiko 
19304a3b33f8SAndrii Nakryiko 	sz = sizeof(struct btf_type);
19314a3b33f8SAndrii Nakryiko 	t = btf_add_type_mem(btf, sz);
19324a3b33f8SAndrii Nakryiko 	if (!t)
1933e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
19344a3b33f8SAndrii Nakryiko 
19354a3b33f8SAndrii Nakryiko 	if (name && name[0]) {
19364a3b33f8SAndrii Nakryiko 		name_off = btf__add_str(btf, name);
19374a3b33f8SAndrii Nakryiko 		if (name_off < 0)
19384a3b33f8SAndrii Nakryiko 			return name_off;
19394a3b33f8SAndrii Nakryiko 	}
19404a3b33f8SAndrii Nakryiko 
19414a3b33f8SAndrii Nakryiko 	/* start out with vlen=0 and no kflag; this will be adjusted when
19424a3b33f8SAndrii Nakryiko 	 * adding each member
19434a3b33f8SAndrii Nakryiko 	 */
19444a3b33f8SAndrii Nakryiko 	t->name_off = name_off;
19454a3b33f8SAndrii Nakryiko 	t->info = btf_type_info(kind, 0, 0);
19464a3b33f8SAndrii Nakryiko 	t->size = bytes_sz;
19474a3b33f8SAndrii Nakryiko 
1948c81ed6d8SAndrii Nakryiko 	return btf_commit_type(btf, sz);
19494a3b33f8SAndrii Nakryiko }
19504a3b33f8SAndrii Nakryiko 
19514a3b33f8SAndrii Nakryiko /*
19524a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_STRUCT type with:
19534a3b33f8SAndrii Nakryiko  *   - *name* - name of the struct, can be NULL or empty for anonymous structs;
19544a3b33f8SAndrii Nakryiko  *   - *byte_sz* - size of the struct, in bytes;
19554a3b33f8SAndrii Nakryiko  *
19564a3b33f8SAndrii Nakryiko  * Struct initially has no fields in it. Fields can be added by
19574a3b33f8SAndrii Nakryiko  * btf__add_field() right after btf__add_struct() succeeds.
19584a3b33f8SAndrii Nakryiko  *
19594a3b33f8SAndrii Nakryiko  * Returns:
19604a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
19614a3b33f8SAndrii Nakryiko  *   - <0, on error.
19624a3b33f8SAndrii Nakryiko  */
19634a3b33f8SAndrii Nakryiko int btf__add_struct(struct btf *btf, const char *name, __u32 byte_sz)
19644a3b33f8SAndrii Nakryiko {
19654a3b33f8SAndrii Nakryiko 	return btf_add_composite(btf, BTF_KIND_STRUCT, name, byte_sz);
19664a3b33f8SAndrii Nakryiko }
19674a3b33f8SAndrii Nakryiko 
19684a3b33f8SAndrii Nakryiko /*
19694a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_UNION type with:
19704a3b33f8SAndrii Nakryiko  *   - *name* - name of the union, can be NULL or empty for anonymous union;
19714a3b33f8SAndrii Nakryiko  *   - *byte_sz* - size of the union, in bytes;
19724a3b33f8SAndrii Nakryiko  *
19734a3b33f8SAndrii Nakryiko  * Union initially has no fields in it. Fields can be added by
19744a3b33f8SAndrii Nakryiko  * btf__add_field() right after btf__add_union() succeeds. All fields
19754a3b33f8SAndrii Nakryiko  * should have *bit_offset* of 0.
19764a3b33f8SAndrii Nakryiko  *
19774a3b33f8SAndrii Nakryiko  * Returns:
19784a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
19794a3b33f8SAndrii Nakryiko  *   - <0, on error.
19804a3b33f8SAndrii Nakryiko  */
19814a3b33f8SAndrii Nakryiko int btf__add_union(struct btf *btf, const char *name, __u32 byte_sz)
19824a3b33f8SAndrii Nakryiko {
19834a3b33f8SAndrii Nakryiko 	return btf_add_composite(btf, BTF_KIND_UNION, name, byte_sz);
19844a3b33f8SAndrii Nakryiko }
19854a3b33f8SAndrii Nakryiko 
1986c81ed6d8SAndrii Nakryiko static struct btf_type *btf_last_type(struct btf *btf)
1987c81ed6d8SAndrii Nakryiko {
19886a886de0SHengqi Chen 	return btf_type_by_id(btf, btf__type_cnt(btf) - 1);
1989c81ed6d8SAndrii Nakryiko }
1990c81ed6d8SAndrii Nakryiko 
19914a3b33f8SAndrii Nakryiko /*
19924a3b33f8SAndrii Nakryiko  * Append new field for the current STRUCT/UNION type with:
19934a3b33f8SAndrii Nakryiko  *   - *name* - name of the field, can be NULL or empty for anonymous field;
19944a3b33f8SAndrii Nakryiko  *   - *type_id* - type ID for the type describing field type;
19954a3b33f8SAndrii Nakryiko  *   - *bit_offset* - bit offset of the start of the field within struct/union;
19964a3b33f8SAndrii Nakryiko  *   - *bit_size* - bit size of a bitfield, 0 for non-bitfield fields;
19974a3b33f8SAndrii Nakryiko  * Returns:
19984a3b33f8SAndrii Nakryiko  *   -  0, on success;
19994a3b33f8SAndrii Nakryiko  *   - <0, on error.
20004a3b33f8SAndrii Nakryiko  */
20014a3b33f8SAndrii Nakryiko int btf__add_field(struct btf *btf, const char *name, int type_id,
20024a3b33f8SAndrii Nakryiko 		   __u32 bit_offset, __u32 bit_size)
20034a3b33f8SAndrii Nakryiko {
20044a3b33f8SAndrii Nakryiko 	struct btf_type *t;
20054a3b33f8SAndrii Nakryiko 	struct btf_member *m;
20064a3b33f8SAndrii Nakryiko 	bool is_bitfield;
20074a3b33f8SAndrii Nakryiko 	int sz, name_off = 0;
20084a3b33f8SAndrii Nakryiko 
20094a3b33f8SAndrii Nakryiko 	/* last type should be union/struct */
20104a3b33f8SAndrii Nakryiko 	if (btf->nr_types == 0)
2011e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
2012c81ed6d8SAndrii Nakryiko 	t = btf_last_type(btf);
20134a3b33f8SAndrii Nakryiko 	if (!btf_is_composite(t))
2014e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
20154a3b33f8SAndrii Nakryiko 
20164a3b33f8SAndrii Nakryiko 	if (validate_type_id(type_id))
2017e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
20184a3b33f8SAndrii Nakryiko 	/* best-effort bit field offset/size enforcement */
20194a3b33f8SAndrii Nakryiko 	is_bitfield = bit_size || (bit_offset % 8 != 0);
20204a3b33f8SAndrii Nakryiko 	if (is_bitfield && (bit_size == 0 || bit_size > 255 || bit_offset > 0xffffff))
2021e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
20224a3b33f8SAndrii Nakryiko 
20234a3b33f8SAndrii Nakryiko 	/* only offset 0 is allowed for unions */
20244a3b33f8SAndrii Nakryiko 	if (btf_is_union(t) && bit_offset)
2025e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
20264a3b33f8SAndrii Nakryiko 
20274a3b33f8SAndrii Nakryiko 	/* decompose and invalidate raw data */
20284a3b33f8SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
2029e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
20304a3b33f8SAndrii Nakryiko 
20314a3b33f8SAndrii Nakryiko 	sz = sizeof(struct btf_member);
20324a3b33f8SAndrii Nakryiko 	m = btf_add_type_mem(btf, sz);
20334a3b33f8SAndrii Nakryiko 	if (!m)
2034e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
20354a3b33f8SAndrii Nakryiko 
20364a3b33f8SAndrii Nakryiko 	if (name && name[0]) {
20374a3b33f8SAndrii Nakryiko 		name_off = btf__add_str(btf, name);
20384a3b33f8SAndrii Nakryiko 		if (name_off < 0)
20394a3b33f8SAndrii Nakryiko 			return name_off;
20404a3b33f8SAndrii Nakryiko 	}
20414a3b33f8SAndrii Nakryiko 
20424a3b33f8SAndrii Nakryiko 	m->name_off = name_off;
20434a3b33f8SAndrii Nakryiko 	m->type = type_id;
20444a3b33f8SAndrii Nakryiko 	m->offset = bit_offset | (bit_size << 24);
20454a3b33f8SAndrii Nakryiko 
20464a3b33f8SAndrii Nakryiko 	/* btf_add_type_mem can invalidate t pointer */
2047c81ed6d8SAndrii Nakryiko 	t = btf_last_type(btf);
20484a3b33f8SAndrii Nakryiko 	/* update parent type's vlen and kflag */
20494a3b33f8SAndrii Nakryiko 	t->info = btf_type_info(btf_kind(t), btf_vlen(t) + 1, is_bitfield || btf_kflag(t));
20504a3b33f8SAndrii Nakryiko 
20514a3b33f8SAndrii Nakryiko 	btf->hdr->type_len += sz;
20524a3b33f8SAndrii Nakryiko 	btf->hdr->str_off += sz;
20534a3b33f8SAndrii Nakryiko 	return 0;
20544a3b33f8SAndrii Nakryiko }
20554a3b33f8SAndrii Nakryiko 
20564a3b33f8SAndrii Nakryiko /*
20574a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_ENUM type with:
20584a3b33f8SAndrii Nakryiko  *   - *name* - name of the enum, can be NULL or empty for anonymous enums;
20594a3b33f8SAndrii Nakryiko  *   - *byte_sz* - size of the enum, in bytes.
20604a3b33f8SAndrii Nakryiko  *
20614a3b33f8SAndrii Nakryiko  * Enum initially has no enum values in it (and corresponds to enum forward
20624a3b33f8SAndrii Nakryiko  * declaration). Enumerator values can be added by btf__add_enum_value()
20634a3b33f8SAndrii Nakryiko  * immediately after btf__add_enum() succeeds.
20644a3b33f8SAndrii Nakryiko  *
20654a3b33f8SAndrii Nakryiko  * Returns:
20664a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
20674a3b33f8SAndrii Nakryiko  *   - <0, on error.
20684a3b33f8SAndrii Nakryiko  */
20694a3b33f8SAndrii Nakryiko int btf__add_enum(struct btf *btf, const char *name, __u32 byte_sz)
20704a3b33f8SAndrii Nakryiko {
20714a3b33f8SAndrii Nakryiko 	struct btf_type *t;
2072c81ed6d8SAndrii Nakryiko 	int sz, name_off = 0;
20734a3b33f8SAndrii Nakryiko 
20744a3b33f8SAndrii Nakryiko 	/* byte_sz must be power of 2 */
20754a3b33f8SAndrii Nakryiko 	if (!byte_sz || (byte_sz & (byte_sz - 1)) || byte_sz > 8)
2076e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
20774a3b33f8SAndrii Nakryiko 
20784a3b33f8SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
2079e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
20804a3b33f8SAndrii Nakryiko 
20814a3b33f8SAndrii Nakryiko 	sz = sizeof(struct btf_type);
20824a3b33f8SAndrii Nakryiko 	t = btf_add_type_mem(btf, sz);
20834a3b33f8SAndrii Nakryiko 	if (!t)
2084e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
20854a3b33f8SAndrii Nakryiko 
20864a3b33f8SAndrii Nakryiko 	if (name && name[0]) {
20874a3b33f8SAndrii Nakryiko 		name_off = btf__add_str(btf, name);
20884a3b33f8SAndrii Nakryiko 		if (name_off < 0)
20894a3b33f8SAndrii Nakryiko 			return name_off;
20904a3b33f8SAndrii Nakryiko 	}
20914a3b33f8SAndrii Nakryiko 
20924a3b33f8SAndrii Nakryiko 	/* start out with vlen=0; it will be adjusted when adding enum values */
20934a3b33f8SAndrii Nakryiko 	t->name_off = name_off;
20944a3b33f8SAndrii Nakryiko 	t->info = btf_type_info(BTF_KIND_ENUM, 0, 0);
20954a3b33f8SAndrii Nakryiko 	t->size = byte_sz;
20964a3b33f8SAndrii Nakryiko 
2097c81ed6d8SAndrii Nakryiko 	return btf_commit_type(btf, sz);
20984a3b33f8SAndrii Nakryiko }
20994a3b33f8SAndrii Nakryiko 
21004a3b33f8SAndrii Nakryiko /*
21014a3b33f8SAndrii Nakryiko  * Append new enum value for the current ENUM type with:
21024a3b33f8SAndrii Nakryiko  *   - *name* - name of the enumerator value, can't be NULL or empty;
21034a3b33f8SAndrii Nakryiko  *   - *value* - integer value corresponding to enum value *name*;
21044a3b33f8SAndrii Nakryiko  * Returns:
21054a3b33f8SAndrii Nakryiko  *   -  0, on success;
21064a3b33f8SAndrii Nakryiko  *   - <0, on error.
21074a3b33f8SAndrii Nakryiko  */
21084a3b33f8SAndrii Nakryiko int btf__add_enum_value(struct btf *btf, const char *name, __s64 value)
21094a3b33f8SAndrii Nakryiko {
21104a3b33f8SAndrii Nakryiko 	struct btf_type *t;
21114a3b33f8SAndrii Nakryiko 	struct btf_enum *v;
21124a3b33f8SAndrii Nakryiko 	int sz, name_off;
21134a3b33f8SAndrii Nakryiko 
21144a3b33f8SAndrii Nakryiko 	/* last type should be BTF_KIND_ENUM */
21154a3b33f8SAndrii Nakryiko 	if (btf->nr_types == 0)
2116e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
2117c81ed6d8SAndrii Nakryiko 	t = btf_last_type(btf);
21184a3b33f8SAndrii Nakryiko 	if (!btf_is_enum(t))
2119e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
21204a3b33f8SAndrii Nakryiko 
21214a3b33f8SAndrii Nakryiko 	/* non-empty name */
21224a3b33f8SAndrii Nakryiko 	if (!name || !name[0])
2123e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
21244a3b33f8SAndrii Nakryiko 	if (value < INT_MIN || value > UINT_MAX)
2125e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-E2BIG);
21264a3b33f8SAndrii Nakryiko 
21274a3b33f8SAndrii Nakryiko 	/* decompose and invalidate raw data */
21284a3b33f8SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
2129e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
21304a3b33f8SAndrii Nakryiko 
21314a3b33f8SAndrii Nakryiko 	sz = sizeof(struct btf_enum);
21324a3b33f8SAndrii Nakryiko 	v = btf_add_type_mem(btf, sz);
21334a3b33f8SAndrii Nakryiko 	if (!v)
2134e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
21354a3b33f8SAndrii Nakryiko 
21364a3b33f8SAndrii Nakryiko 	name_off = btf__add_str(btf, name);
21374a3b33f8SAndrii Nakryiko 	if (name_off < 0)
21384a3b33f8SAndrii Nakryiko 		return name_off;
21394a3b33f8SAndrii Nakryiko 
21404a3b33f8SAndrii Nakryiko 	v->name_off = name_off;
21414a3b33f8SAndrii Nakryiko 	v->val = value;
21424a3b33f8SAndrii Nakryiko 
21434a3b33f8SAndrii Nakryiko 	/* update parent type's vlen */
2144c81ed6d8SAndrii Nakryiko 	t = btf_last_type(btf);
21454a3b33f8SAndrii Nakryiko 	btf_type_inc_vlen(t);
21464a3b33f8SAndrii Nakryiko 
21474a3b33f8SAndrii Nakryiko 	btf->hdr->type_len += sz;
21484a3b33f8SAndrii Nakryiko 	btf->hdr->str_off += sz;
21494a3b33f8SAndrii Nakryiko 	return 0;
21504a3b33f8SAndrii Nakryiko }
21514a3b33f8SAndrii Nakryiko 
21524a3b33f8SAndrii Nakryiko /*
21534a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_FWD type with:
21544a3b33f8SAndrii Nakryiko  *   - *name*, non-empty/non-NULL name;
21554a3b33f8SAndrii Nakryiko  *   - *fwd_kind*, kind of forward declaration, one of BTF_FWD_STRUCT,
21564a3b33f8SAndrii Nakryiko  *     BTF_FWD_UNION, or BTF_FWD_ENUM;
21574a3b33f8SAndrii Nakryiko  * Returns:
21584a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
21594a3b33f8SAndrii Nakryiko  *   - <0, on error.
21604a3b33f8SAndrii Nakryiko  */
21614a3b33f8SAndrii Nakryiko int btf__add_fwd(struct btf *btf, const char *name, enum btf_fwd_kind fwd_kind)
21624a3b33f8SAndrii Nakryiko {
21634a3b33f8SAndrii Nakryiko 	if (!name || !name[0])
2164e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
21654a3b33f8SAndrii Nakryiko 
21664a3b33f8SAndrii Nakryiko 	switch (fwd_kind) {
21674a3b33f8SAndrii Nakryiko 	case BTF_FWD_STRUCT:
21684a3b33f8SAndrii Nakryiko 	case BTF_FWD_UNION: {
21694a3b33f8SAndrii Nakryiko 		struct btf_type *t;
21704a3b33f8SAndrii Nakryiko 		int id;
21714a3b33f8SAndrii Nakryiko 
21724a3b33f8SAndrii Nakryiko 		id = btf_add_ref_kind(btf, BTF_KIND_FWD, name, 0);
21734a3b33f8SAndrii Nakryiko 		if (id <= 0)
21744a3b33f8SAndrii Nakryiko 			return id;
21754a3b33f8SAndrii Nakryiko 		t = btf_type_by_id(btf, id);
21764a3b33f8SAndrii Nakryiko 		t->info = btf_type_info(BTF_KIND_FWD, 0, fwd_kind == BTF_FWD_UNION);
21774a3b33f8SAndrii Nakryiko 		return id;
21784a3b33f8SAndrii Nakryiko 	}
21794a3b33f8SAndrii Nakryiko 	case BTF_FWD_ENUM:
21804a3b33f8SAndrii Nakryiko 		/* enum forward in BTF currently is just an enum with no enum
21814a3b33f8SAndrii Nakryiko 		 * values; we also assume a standard 4-byte size for it
21824a3b33f8SAndrii Nakryiko 		 */
21834a3b33f8SAndrii Nakryiko 		return btf__add_enum(btf, name, sizeof(int));
21844a3b33f8SAndrii Nakryiko 	default:
2185e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
21864a3b33f8SAndrii Nakryiko 	}
21874a3b33f8SAndrii Nakryiko }
21884a3b33f8SAndrii Nakryiko 
21894a3b33f8SAndrii Nakryiko /*
21904a3b33f8SAndrii Nakryiko  * Append new BTF_KING_TYPEDEF type with:
21914a3b33f8SAndrii Nakryiko  *   - *name*, non-empty/non-NULL name;
21924a3b33f8SAndrii Nakryiko  *   - *ref_type_id* - referenced type ID, it might not exist yet;
21934a3b33f8SAndrii Nakryiko  * Returns:
21944a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
21954a3b33f8SAndrii Nakryiko  *   - <0, on error.
21964a3b33f8SAndrii Nakryiko  */
21974a3b33f8SAndrii Nakryiko int btf__add_typedef(struct btf *btf, const char *name, int ref_type_id)
21984a3b33f8SAndrii Nakryiko {
21994a3b33f8SAndrii Nakryiko 	if (!name || !name[0])
2200e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
22014a3b33f8SAndrii Nakryiko 
22024a3b33f8SAndrii Nakryiko 	return btf_add_ref_kind(btf, BTF_KIND_TYPEDEF, name, ref_type_id);
22034a3b33f8SAndrii Nakryiko }
22044a3b33f8SAndrii Nakryiko 
22054a3b33f8SAndrii Nakryiko /*
22064a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_VOLATILE type with:
22074a3b33f8SAndrii Nakryiko  *   - *ref_type_id* - referenced type ID, it might not exist yet;
22084a3b33f8SAndrii Nakryiko  * Returns:
22094a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
22104a3b33f8SAndrii Nakryiko  *   - <0, on error.
22114a3b33f8SAndrii Nakryiko  */
22124a3b33f8SAndrii Nakryiko int btf__add_volatile(struct btf *btf, int ref_type_id)
22134a3b33f8SAndrii Nakryiko {
22144a3b33f8SAndrii Nakryiko 	return btf_add_ref_kind(btf, BTF_KIND_VOLATILE, NULL, ref_type_id);
22154a3b33f8SAndrii Nakryiko }
22164a3b33f8SAndrii Nakryiko 
22174a3b33f8SAndrii Nakryiko /*
22184a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_CONST type with:
22194a3b33f8SAndrii Nakryiko  *   - *ref_type_id* - referenced type ID, it might not exist yet;
22204a3b33f8SAndrii Nakryiko  * Returns:
22214a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
22224a3b33f8SAndrii Nakryiko  *   - <0, on error.
22234a3b33f8SAndrii Nakryiko  */
22244a3b33f8SAndrii Nakryiko int btf__add_const(struct btf *btf, int ref_type_id)
22254a3b33f8SAndrii Nakryiko {
22264a3b33f8SAndrii Nakryiko 	return btf_add_ref_kind(btf, BTF_KIND_CONST, NULL, ref_type_id);
22274a3b33f8SAndrii Nakryiko }
22284a3b33f8SAndrii Nakryiko 
22294a3b33f8SAndrii Nakryiko /*
22304a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_RESTRICT type with:
22314a3b33f8SAndrii Nakryiko  *   - *ref_type_id* - referenced type ID, it might not exist yet;
22324a3b33f8SAndrii Nakryiko  * Returns:
22334a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
22344a3b33f8SAndrii Nakryiko  *   - <0, on error.
22354a3b33f8SAndrii Nakryiko  */
22364a3b33f8SAndrii Nakryiko int btf__add_restrict(struct btf *btf, int ref_type_id)
22374a3b33f8SAndrii Nakryiko {
22384a3b33f8SAndrii Nakryiko 	return btf_add_ref_kind(btf, BTF_KIND_RESTRICT, NULL, ref_type_id);
22394a3b33f8SAndrii Nakryiko }
22404a3b33f8SAndrii Nakryiko 
22414a3b33f8SAndrii Nakryiko /*
2242*2dc1e488SYonghong Song  * Append new BTF_KIND_TYPE_TAG type with:
2243*2dc1e488SYonghong Song  *   - *value*, non-empty/non-NULL tag value;
2244*2dc1e488SYonghong Song  *   - *ref_type_id* - referenced type ID, it might not exist yet;
2245*2dc1e488SYonghong Song  * Returns:
2246*2dc1e488SYonghong Song  *   - >0, type ID of newly added BTF type;
2247*2dc1e488SYonghong Song  *   - <0, on error.
2248*2dc1e488SYonghong Song  */
2249*2dc1e488SYonghong Song int btf__add_type_tag(struct btf *btf, const char *value, int ref_type_id)
2250*2dc1e488SYonghong Song {
2251*2dc1e488SYonghong Song 	if (!value|| !value[0])
2252*2dc1e488SYonghong Song 		return libbpf_err(-EINVAL);
2253*2dc1e488SYonghong Song 
2254*2dc1e488SYonghong Song 	return btf_add_ref_kind(btf, BTF_KIND_TYPE_TAG, value, ref_type_id);
2255*2dc1e488SYonghong Song }
2256*2dc1e488SYonghong Song 
2257*2dc1e488SYonghong Song /*
22584a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_FUNC type with:
22594a3b33f8SAndrii Nakryiko  *   - *name*, non-empty/non-NULL name;
22604a3b33f8SAndrii Nakryiko  *   - *proto_type_id* - FUNC_PROTO's type ID, it might not exist yet;
22614a3b33f8SAndrii Nakryiko  * Returns:
22624a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
22634a3b33f8SAndrii Nakryiko  *   - <0, on error.
22644a3b33f8SAndrii Nakryiko  */
22654a3b33f8SAndrii Nakryiko int btf__add_func(struct btf *btf, const char *name,
22664a3b33f8SAndrii Nakryiko 		  enum btf_func_linkage linkage, int proto_type_id)
22674a3b33f8SAndrii Nakryiko {
22684a3b33f8SAndrii Nakryiko 	int id;
22694a3b33f8SAndrii Nakryiko 
22704a3b33f8SAndrii Nakryiko 	if (!name || !name[0])
2271e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
22724a3b33f8SAndrii Nakryiko 	if (linkage != BTF_FUNC_STATIC && linkage != BTF_FUNC_GLOBAL &&
22734a3b33f8SAndrii Nakryiko 	    linkage != BTF_FUNC_EXTERN)
2274e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
22754a3b33f8SAndrii Nakryiko 
22764a3b33f8SAndrii Nakryiko 	id = btf_add_ref_kind(btf, BTF_KIND_FUNC, name, proto_type_id);
22774a3b33f8SAndrii Nakryiko 	if (id > 0) {
22784a3b33f8SAndrii Nakryiko 		struct btf_type *t = btf_type_by_id(btf, id);
22794a3b33f8SAndrii Nakryiko 
22804a3b33f8SAndrii Nakryiko 		t->info = btf_type_info(BTF_KIND_FUNC, linkage, 0);
22814a3b33f8SAndrii Nakryiko 	}
2282e9fc3ce9SAndrii Nakryiko 	return libbpf_err(id);
22834a3b33f8SAndrii Nakryiko }
22844a3b33f8SAndrii Nakryiko 
22854a3b33f8SAndrii Nakryiko /*
22864a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_FUNC_PROTO with:
22874a3b33f8SAndrii Nakryiko  *   - *ret_type_id* - type ID for return result of a function.
22884a3b33f8SAndrii Nakryiko  *
22894a3b33f8SAndrii Nakryiko  * Function prototype initially has no arguments, but they can be added by
22904a3b33f8SAndrii Nakryiko  * btf__add_func_param() one by one, immediately after
22914a3b33f8SAndrii Nakryiko  * btf__add_func_proto() succeeded.
22924a3b33f8SAndrii Nakryiko  *
22934a3b33f8SAndrii Nakryiko  * Returns:
22944a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
22954a3b33f8SAndrii Nakryiko  *   - <0, on error.
22964a3b33f8SAndrii Nakryiko  */
22974a3b33f8SAndrii Nakryiko int btf__add_func_proto(struct btf *btf, int ret_type_id)
22984a3b33f8SAndrii Nakryiko {
22994a3b33f8SAndrii Nakryiko 	struct btf_type *t;
2300c81ed6d8SAndrii Nakryiko 	int sz;
23014a3b33f8SAndrii Nakryiko 
23024a3b33f8SAndrii Nakryiko 	if (validate_type_id(ret_type_id))
2303e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
23044a3b33f8SAndrii Nakryiko 
23054a3b33f8SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
2306e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
23074a3b33f8SAndrii Nakryiko 
23084a3b33f8SAndrii Nakryiko 	sz = sizeof(struct btf_type);
23094a3b33f8SAndrii Nakryiko 	t = btf_add_type_mem(btf, sz);
23104a3b33f8SAndrii Nakryiko 	if (!t)
2311e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
23124a3b33f8SAndrii Nakryiko 
23134a3b33f8SAndrii Nakryiko 	/* start out with vlen=0; this will be adjusted when adding enum
23144a3b33f8SAndrii Nakryiko 	 * values, if necessary
23154a3b33f8SAndrii Nakryiko 	 */
23164a3b33f8SAndrii Nakryiko 	t->name_off = 0;
23174a3b33f8SAndrii Nakryiko 	t->info = btf_type_info(BTF_KIND_FUNC_PROTO, 0, 0);
23184a3b33f8SAndrii Nakryiko 	t->type = ret_type_id;
23194a3b33f8SAndrii Nakryiko 
2320c81ed6d8SAndrii Nakryiko 	return btf_commit_type(btf, sz);
23214a3b33f8SAndrii Nakryiko }
23224a3b33f8SAndrii Nakryiko 
23234a3b33f8SAndrii Nakryiko /*
23244a3b33f8SAndrii Nakryiko  * Append new function parameter for current FUNC_PROTO type with:
23254a3b33f8SAndrii Nakryiko  *   - *name* - parameter name, can be NULL or empty;
23264a3b33f8SAndrii Nakryiko  *   - *type_id* - type ID describing the type of the parameter.
23274a3b33f8SAndrii Nakryiko  * Returns:
23284a3b33f8SAndrii Nakryiko  *   -  0, on success;
23294a3b33f8SAndrii Nakryiko  *   - <0, on error.
23304a3b33f8SAndrii Nakryiko  */
23314a3b33f8SAndrii Nakryiko int btf__add_func_param(struct btf *btf, const char *name, int type_id)
23324a3b33f8SAndrii Nakryiko {
23334a3b33f8SAndrii Nakryiko 	struct btf_type *t;
23344a3b33f8SAndrii Nakryiko 	struct btf_param *p;
23354a3b33f8SAndrii Nakryiko 	int sz, name_off = 0;
23364a3b33f8SAndrii Nakryiko 
23374a3b33f8SAndrii Nakryiko 	if (validate_type_id(type_id))
2338e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
23394a3b33f8SAndrii Nakryiko 
23404a3b33f8SAndrii Nakryiko 	/* last type should be BTF_KIND_FUNC_PROTO */
23414a3b33f8SAndrii Nakryiko 	if (btf->nr_types == 0)
2342e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
2343c81ed6d8SAndrii Nakryiko 	t = btf_last_type(btf);
23444a3b33f8SAndrii Nakryiko 	if (!btf_is_func_proto(t))
2345e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
23464a3b33f8SAndrii Nakryiko 
23474a3b33f8SAndrii Nakryiko 	/* decompose and invalidate raw data */
23484a3b33f8SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
2349e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
23504a3b33f8SAndrii Nakryiko 
23514a3b33f8SAndrii Nakryiko 	sz = sizeof(struct btf_param);
23524a3b33f8SAndrii Nakryiko 	p = btf_add_type_mem(btf, sz);
23534a3b33f8SAndrii Nakryiko 	if (!p)
2354e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
23554a3b33f8SAndrii Nakryiko 
23564a3b33f8SAndrii Nakryiko 	if (name && name[0]) {
23574a3b33f8SAndrii Nakryiko 		name_off = btf__add_str(btf, name);
23584a3b33f8SAndrii Nakryiko 		if (name_off < 0)
23594a3b33f8SAndrii Nakryiko 			return name_off;
23604a3b33f8SAndrii Nakryiko 	}
23614a3b33f8SAndrii Nakryiko 
23624a3b33f8SAndrii Nakryiko 	p->name_off = name_off;
23634a3b33f8SAndrii Nakryiko 	p->type = type_id;
23644a3b33f8SAndrii Nakryiko 
23654a3b33f8SAndrii Nakryiko 	/* update parent type's vlen */
2366c81ed6d8SAndrii Nakryiko 	t = btf_last_type(btf);
23674a3b33f8SAndrii Nakryiko 	btf_type_inc_vlen(t);
23684a3b33f8SAndrii Nakryiko 
23694a3b33f8SAndrii Nakryiko 	btf->hdr->type_len += sz;
23704a3b33f8SAndrii Nakryiko 	btf->hdr->str_off += sz;
23714a3b33f8SAndrii Nakryiko 	return 0;
23724a3b33f8SAndrii Nakryiko }
23734a3b33f8SAndrii Nakryiko 
23744a3b33f8SAndrii Nakryiko /*
23754a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_VAR type with:
23764a3b33f8SAndrii Nakryiko  *   - *name* - non-empty/non-NULL name;
23774a3b33f8SAndrii Nakryiko  *   - *linkage* - variable linkage, one of BTF_VAR_STATIC,
23784a3b33f8SAndrii Nakryiko  *     BTF_VAR_GLOBAL_ALLOCATED, or BTF_VAR_GLOBAL_EXTERN;
23794a3b33f8SAndrii Nakryiko  *   - *type_id* - type ID of the type describing the type of the variable.
23804a3b33f8SAndrii Nakryiko  * Returns:
23814a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
23824a3b33f8SAndrii Nakryiko  *   - <0, on error.
23834a3b33f8SAndrii Nakryiko  */
23844a3b33f8SAndrii Nakryiko int btf__add_var(struct btf *btf, const char *name, int linkage, int type_id)
23854a3b33f8SAndrii Nakryiko {
23864a3b33f8SAndrii Nakryiko 	struct btf_type *t;
23874a3b33f8SAndrii Nakryiko 	struct btf_var *v;
2388c81ed6d8SAndrii Nakryiko 	int sz, name_off;
23894a3b33f8SAndrii Nakryiko 
23904a3b33f8SAndrii Nakryiko 	/* non-empty name */
23914a3b33f8SAndrii Nakryiko 	if (!name || !name[0])
2392e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
23934a3b33f8SAndrii Nakryiko 	if (linkage != BTF_VAR_STATIC && linkage != BTF_VAR_GLOBAL_ALLOCATED &&
23944a3b33f8SAndrii Nakryiko 	    linkage != BTF_VAR_GLOBAL_EXTERN)
2395e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
23964a3b33f8SAndrii Nakryiko 	if (validate_type_id(type_id))
2397e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
23984a3b33f8SAndrii Nakryiko 
23994a3b33f8SAndrii Nakryiko 	/* deconstruct BTF, if necessary, and invalidate raw_data */
24004a3b33f8SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
2401e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
24024a3b33f8SAndrii Nakryiko 
24034a3b33f8SAndrii Nakryiko 	sz = sizeof(struct btf_type) + sizeof(struct btf_var);
24044a3b33f8SAndrii Nakryiko 	t = btf_add_type_mem(btf, sz);
24054a3b33f8SAndrii Nakryiko 	if (!t)
2406e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
24074a3b33f8SAndrii Nakryiko 
24084a3b33f8SAndrii Nakryiko 	name_off = btf__add_str(btf, name);
24094a3b33f8SAndrii Nakryiko 	if (name_off < 0)
24104a3b33f8SAndrii Nakryiko 		return name_off;
24114a3b33f8SAndrii Nakryiko 
24124a3b33f8SAndrii Nakryiko 	t->name_off = name_off;
24134a3b33f8SAndrii Nakryiko 	t->info = btf_type_info(BTF_KIND_VAR, 0, 0);
24144a3b33f8SAndrii Nakryiko 	t->type = type_id;
24154a3b33f8SAndrii Nakryiko 
24164a3b33f8SAndrii Nakryiko 	v = btf_var(t);
24174a3b33f8SAndrii Nakryiko 	v->linkage = linkage;
24184a3b33f8SAndrii Nakryiko 
2419c81ed6d8SAndrii Nakryiko 	return btf_commit_type(btf, sz);
24204a3b33f8SAndrii Nakryiko }
24214a3b33f8SAndrii Nakryiko 
24224a3b33f8SAndrii Nakryiko /*
24234a3b33f8SAndrii Nakryiko  * Append new BTF_KIND_DATASEC type with:
24244a3b33f8SAndrii Nakryiko  *   - *name* - non-empty/non-NULL name;
24254a3b33f8SAndrii Nakryiko  *   - *byte_sz* - data section size, in bytes.
24264a3b33f8SAndrii Nakryiko  *
24274a3b33f8SAndrii Nakryiko  * Data section is initially empty. Variables info can be added with
24284a3b33f8SAndrii Nakryiko  * btf__add_datasec_var_info() calls, after btf__add_datasec() succeeds.
24294a3b33f8SAndrii Nakryiko  *
24304a3b33f8SAndrii Nakryiko  * Returns:
24314a3b33f8SAndrii Nakryiko  *   - >0, type ID of newly added BTF type;
24324a3b33f8SAndrii Nakryiko  *   - <0, on error.
24334a3b33f8SAndrii Nakryiko  */
24344a3b33f8SAndrii Nakryiko int btf__add_datasec(struct btf *btf, const char *name, __u32 byte_sz)
24354a3b33f8SAndrii Nakryiko {
24364a3b33f8SAndrii Nakryiko 	struct btf_type *t;
2437c81ed6d8SAndrii Nakryiko 	int sz, name_off;
24384a3b33f8SAndrii Nakryiko 
24394a3b33f8SAndrii Nakryiko 	/* non-empty name */
24404a3b33f8SAndrii Nakryiko 	if (!name || !name[0])
2441e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
24424a3b33f8SAndrii Nakryiko 
24434a3b33f8SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
2444e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
24454a3b33f8SAndrii Nakryiko 
24464a3b33f8SAndrii Nakryiko 	sz = sizeof(struct btf_type);
24474a3b33f8SAndrii Nakryiko 	t = btf_add_type_mem(btf, sz);
24484a3b33f8SAndrii Nakryiko 	if (!t)
2449e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
24504a3b33f8SAndrii Nakryiko 
24514a3b33f8SAndrii Nakryiko 	name_off = btf__add_str(btf, name);
24524a3b33f8SAndrii Nakryiko 	if (name_off < 0)
24534a3b33f8SAndrii Nakryiko 		return name_off;
24544a3b33f8SAndrii Nakryiko 
24554a3b33f8SAndrii Nakryiko 	/* start with vlen=0, which will be update as var_secinfos are added */
24564a3b33f8SAndrii Nakryiko 	t->name_off = name_off;
24574a3b33f8SAndrii Nakryiko 	t->info = btf_type_info(BTF_KIND_DATASEC, 0, 0);
24584a3b33f8SAndrii Nakryiko 	t->size = byte_sz;
24594a3b33f8SAndrii Nakryiko 
2460c81ed6d8SAndrii Nakryiko 	return btf_commit_type(btf, sz);
24614a3b33f8SAndrii Nakryiko }
24624a3b33f8SAndrii Nakryiko 
24634a3b33f8SAndrii Nakryiko /*
24644a3b33f8SAndrii Nakryiko  * Append new data section variable information entry for current DATASEC type:
24654a3b33f8SAndrii Nakryiko  *   - *var_type_id* - type ID, describing type of the variable;
24664a3b33f8SAndrii Nakryiko  *   - *offset* - variable offset within data section, in bytes;
24674a3b33f8SAndrii Nakryiko  *   - *byte_sz* - variable size, in bytes.
24684a3b33f8SAndrii Nakryiko  *
24694a3b33f8SAndrii Nakryiko  * Returns:
24704a3b33f8SAndrii Nakryiko  *   -  0, on success;
24714a3b33f8SAndrii Nakryiko  *   - <0, on error.
24724a3b33f8SAndrii Nakryiko  */
24734a3b33f8SAndrii Nakryiko int btf__add_datasec_var_info(struct btf *btf, int var_type_id, __u32 offset, __u32 byte_sz)
24744a3b33f8SAndrii Nakryiko {
24754a3b33f8SAndrii Nakryiko 	struct btf_type *t;
24764a3b33f8SAndrii Nakryiko 	struct btf_var_secinfo *v;
24774a3b33f8SAndrii Nakryiko 	int sz;
24784a3b33f8SAndrii Nakryiko 
24794a3b33f8SAndrii Nakryiko 	/* last type should be BTF_KIND_DATASEC */
24804a3b33f8SAndrii Nakryiko 	if (btf->nr_types == 0)
2481e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
2482c81ed6d8SAndrii Nakryiko 	t = btf_last_type(btf);
24834a3b33f8SAndrii Nakryiko 	if (!btf_is_datasec(t))
2484e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
24854a3b33f8SAndrii Nakryiko 
24864a3b33f8SAndrii Nakryiko 	if (validate_type_id(var_type_id))
2487e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
24884a3b33f8SAndrii Nakryiko 
24894a3b33f8SAndrii Nakryiko 	/* decompose and invalidate raw data */
24904a3b33f8SAndrii Nakryiko 	if (btf_ensure_modifiable(btf))
2491e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
24924a3b33f8SAndrii Nakryiko 
24934a3b33f8SAndrii Nakryiko 	sz = sizeof(struct btf_var_secinfo);
24944a3b33f8SAndrii Nakryiko 	v = btf_add_type_mem(btf, sz);
24954a3b33f8SAndrii Nakryiko 	if (!v)
2496e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-ENOMEM);
24974a3b33f8SAndrii Nakryiko 
24984a3b33f8SAndrii Nakryiko 	v->type = var_type_id;
24994a3b33f8SAndrii Nakryiko 	v->offset = offset;
25004a3b33f8SAndrii Nakryiko 	v->size = byte_sz;
25014a3b33f8SAndrii Nakryiko 
25024a3b33f8SAndrii Nakryiko 	/* update parent type's vlen */
2503c81ed6d8SAndrii Nakryiko 	t = btf_last_type(btf);
25044a3b33f8SAndrii Nakryiko 	btf_type_inc_vlen(t);
25054a3b33f8SAndrii Nakryiko 
25064a3b33f8SAndrii Nakryiko 	btf->hdr->type_len += sz;
25074a3b33f8SAndrii Nakryiko 	btf->hdr->str_off += sz;
25084a3b33f8SAndrii Nakryiko 	return 0;
25094a3b33f8SAndrii Nakryiko }
25104a3b33f8SAndrii Nakryiko 
25115b84bd10SYonghong Song /*
2512223f903eSYonghong Song  * Append new BTF_KIND_DECL_TAG type with:
25135b84bd10SYonghong Song  *   - *value* - non-empty/non-NULL string;
25145b84bd10SYonghong Song  *   - *ref_type_id* - referenced type ID, it might not exist yet;
25155b84bd10SYonghong Song  *   - *component_idx* - -1 for tagging reference type, otherwise struct/union
25165b84bd10SYonghong Song  *     member or function argument index;
25175b84bd10SYonghong Song  * Returns:
25185b84bd10SYonghong Song  *   - >0, type ID of newly added BTF type;
25195b84bd10SYonghong Song  *   - <0, on error.
25205b84bd10SYonghong Song  */
2521223f903eSYonghong Song int btf__add_decl_tag(struct btf *btf, const char *value, int ref_type_id,
25225b84bd10SYonghong Song 		 int component_idx)
25235b84bd10SYonghong Song {
25245b84bd10SYonghong Song 	struct btf_type *t;
25255b84bd10SYonghong Song 	int sz, value_off;
25265b84bd10SYonghong Song 
25275b84bd10SYonghong Song 	if (!value || !value[0] || component_idx < -1)
25285b84bd10SYonghong Song 		return libbpf_err(-EINVAL);
25295b84bd10SYonghong Song 
25305b84bd10SYonghong Song 	if (validate_type_id(ref_type_id))
25315b84bd10SYonghong Song 		return libbpf_err(-EINVAL);
25325b84bd10SYonghong Song 
25335b84bd10SYonghong Song 	if (btf_ensure_modifiable(btf))
25345b84bd10SYonghong Song 		return libbpf_err(-ENOMEM);
25355b84bd10SYonghong Song 
2536223f903eSYonghong Song 	sz = sizeof(struct btf_type) + sizeof(struct btf_decl_tag);
25375b84bd10SYonghong Song 	t = btf_add_type_mem(btf, sz);
25385b84bd10SYonghong Song 	if (!t)
25395b84bd10SYonghong Song 		return libbpf_err(-ENOMEM);
25405b84bd10SYonghong Song 
25415b84bd10SYonghong Song 	value_off = btf__add_str(btf, value);
25425b84bd10SYonghong Song 	if (value_off < 0)
25435b84bd10SYonghong Song 		return value_off;
25445b84bd10SYonghong Song 
25455b84bd10SYonghong Song 	t->name_off = value_off;
2546223f903eSYonghong Song 	t->info = btf_type_info(BTF_KIND_DECL_TAG, 0, false);
25475b84bd10SYonghong Song 	t->type = ref_type_id;
2548223f903eSYonghong Song 	btf_decl_tag(t)->component_idx = component_idx;
25495b84bd10SYonghong Song 
25505b84bd10SYonghong Song 	return btf_commit_type(btf, sz);
25515b84bd10SYonghong Song }
25525b84bd10SYonghong Song 
2553ae4ab4b4SAndrii Nakryiko struct btf_ext_sec_setup_param {
25543d650141SMartin KaFai Lau 	__u32 off;
25553d650141SMartin KaFai Lau 	__u32 len;
25563d650141SMartin KaFai Lau 	__u32 min_rec_size;
25573d650141SMartin KaFai Lau 	struct btf_ext_info *ext_info;
25583d650141SMartin KaFai Lau 	const char *desc;
25593d650141SMartin KaFai Lau };
25603d650141SMartin KaFai Lau 
2561ae4ab4b4SAndrii Nakryiko static int btf_ext_setup_info(struct btf_ext *btf_ext,
2562ae4ab4b4SAndrii Nakryiko 			      struct btf_ext_sec_setup_param *ext_sec)
25632993e051SYonghong Song {
25643d650141SMartin KaFai Lau 	const struct btf_ext_info_sec *sinfo;
25653d650141SMartin KaFai Lau 	struct btf_ext_info *ext_info;
2566f0187f0bSMartin KaFai Lau 	__u32 info_left, record_size;
2567f0187f0bSMartin KaFai Lau 	/* The start of the info sec (including the __u32 record_size). */
2568ae4ab4b4SAndrii Nakryiko 	void *info;
2569f0187f0bSMartin KaFai Lau 
25704cedc0daSAndrii Nakryiko 	if (ext_sec->len == 0)
25714cedc0daSAndrii Nakryiko 		return 0;
25724cedc0daSAndrii Nakryiko 
25733d650141SMartin KaFai Lau 	if (ext_sec->off & 0x03) {
25748461ef8bSYonghong Song 		pr_debug(".BTF.ext %s section is not aligned to 4 bytes\n",
25753d650141SMartin KaFai Lau 		     ext_sec->desc);
2576f0187f0bSMartin KaFai Lau 		return -EINVAL;
2577f0187f0bSMartin KaFai Lau 	}
2578f0187f0bSMartin KaFai Lau 
2579ae4ab4b4SAndrii Nakryiko 	info = btf_ext->data + btf_ext->hdr->hdr_len + ext_sec->off;
2580ae4ab4b4SAndrii Nakryiko 	info_left = ext_sec->len;
2581ae4ab4b4SAndrii Nakryiko 
2582ae4ab4b4SAndrii Nakryiko 	if (btf_ext->data + btf_ext->data_size < info + ext_sec->len) {
25838461ef8bSYonghong Song 		pr_debug("%s section (off:%u len:%u) is beyond the end of the ELF section .BTF.ext\n",
25843d650141SMartin KaFai Lau 			 ext_sec->desc, ext_sec->off, ext_sec->len);
2585f0187f0bSMartin KaFai Lau 		return -EINVAL;
2586f0187f0bSMartin KaFai Lau 	}
2587f0187f0bSMartin KaFai Lau 
25883d650141SMartin KaFai Lau 	/* At least a record size */
2589f0187f0bSMartin KaFai Lau 	if (info_left < sizeof(__u32)) {
25908461ef8bSYonghong Song 		pr_debug(".BTF.ext %s record size not found\n", ext_sec->desc);
25912993e051SYonghong Song 		return -EINVAL;
25922993e051SYonghong Song 	}
25932993e051SYonghong Song 
2594f0187f0bSMartin KaFai Lau 	/* The record size needs to meet the minimum standard */
2595f0187f0bSMartin KaFai Lau 	record_size = *(__u32 *)info;
25963d650141SMartin KaFai Lau 	if (record_size < ext_sec->min_rec_size ||
2597f0187f0bSMartin KaFai Lau 	    record_size & 0x03) {
25988461ef8bSYonghong Song 		pr_debug("%s section in .BTF.ext has invalid record size %u\n",
25993d650141SMartin KaFai Lau 			 ext_sec->desc, record_size);
26002993e051SYonghong Song 		return -EINVAL;
26012993e051SYonghong Song 	}
26022993e051SYonghong Song 
2603f0187f0bSMartin KaFai Lau 	sinfo = info + sizeof(__u32);
2604f0187f0bSMartin KaFai Lau 	info_left -= sizeof(__u32);
26052993e051SYonghong Song 
26063d650141SMartin KaFai Lau 	/* If no records, return failure now so .BTF.ext won't be used. */
2607f0187f0bSMartin KaFai Lau 	if (!info_left) {
26088461ef8bSYonghong Song 		pr_debug("%s section in .BTF.ext has no records", ext_sec->desc);
26092993e051SYonghong Song 		return -EINVAL;
26102993e051SYonghong Song 	}
26112993e051SYonghong Song 
2612f0187f0bSMartin KaFai Lau 	while (info_left) {
26133d650141SMartin KaFai Lau 		unsigned int sec_hdrlen = sizeof(struct btf_ext_info_sec);
2614f0187f0bSMartin KaFai Lau 		__u64 total_record_size;
2615f0187f0bSMartin KaFai Lau 		__u32 num_records;
2616f0187f0bSMartin KaFai Lau 
2617f0187f0bSMartin KaFai Lau 		if (info_left < sec_hdrlen) {
26188461ef8bSYonghong Song 			pr_debug("%s section header is not found in .BTF.ext\n",
26193d650141SMartin KaFai Lau 			     ext_sec->desc);
26202993e051SYonghong Song 			return -EINVAL;
26212993e051SYonghong Song 		}
26222993e051SYonghong Song 
26233d650141SMartin KaFai Lau 		num_records = sinfo->num_info;
26242993e051SYonghong Song 		if (num_records == 0) {
26258461ef8bSYonghong Song 			pr_debug("%s section has incorrect num_records in .BTF.ext\n",
26263d650141SMartin KaFai Lau 			     ext_sec->desc);
26272993e051SYonghong Song 			return -EINVAL;
26282993e051SYonghong Song 		}
26292993e051SYonghong Song 
26302993e051SYonghong Song 		total_record_size = sec_hdrlen +
26312993e051SYonghong Song 				    (__u64)num_records * record_size;
2632f0187f0bSMartin KaFai Lau 		if (info_left < total_record_size) {
26338461ef8bSYonghong Song 			pr_debug("%s section has incorrect num_records in .BTF.ext\n",
26343d650141SMartin KaFai Lau 			     ext_sec->desc);
26352993e051SYonghong Song 			return -EINVAL;
26362993e051SYonghong Song 		}
26372993e051SYonghong Song 
2638f0187f0bSMartin KaFai Lau 		info_left -= total_record_size;
26392993e051SYonghong Song 		sinfo = (void *)sinfo + total_record_size;
26402993e051SYonghong Song 	}
26412993e051SYonghong Song 
26423d650141SMartin KaFai Lau 	ext_info = ext_sec->ext_info;
26433d650141SMartin KaFai Lau 	ext_info->len = ext_sec->len - sizeof(__u32);
26443d650141SMartin KaFai Lau 	ext_info->rec_size = record_size;
2645ae4ab4b4SAndrii Nakryiko 	ext_info->info = info + sizeof(__u32);
2646f0187f0bSMartin KaFai Lau 
26472993e051SYonghong Song 	return 0;
26482993e051SYonghong Song }
26492993e051SYonghong Song 
2650ae4ab4b4SAndrii Nakryiko static int btf_ext_setup_func_info(struct btf_ext *btf_ext)
26513d650141SMartin KaFai Lau {
2652ae4ab4b4SAndrii Nakryiko 	struct btf_ext_sec_setup_param param = {
2653ae4ab4b4SAndrii Nakryiko 		.off = btf_ext->hdr->func_info_off,
2654ae4ab4b4SAndrii Nakryiko 		.len = btf_ext->hdr->func_info_len,
26553d650141SMartin KaFai Lau 		.min_rec_size = sizeof(struct bpf_func_info_min),
26563d650141SMartin KaFai Lau 		.ext_info = &btf_ext->func_info,
26573d650141SMartin KaFai Lau 		.desc = "func_info"
26583d650141SMartin KaFai Lau 	};
26593d650141SMartin KaFai Lau 
2660ae4ab4b4SAndrii Nakryiko 	return btf_ext_setup_info(btf_ext, &param);
26613d650141SMartin KaFai Lau }
26623d650141SMartin KaFai Lau 
2663ae4ab4b4SAndrii Nakryiko static int btf_ext_setup_line_info(struct btf_ext *btf_ext)
26643d650141SMartin KaFai Lau {
2665ae4ab4b4SAndrii Nakryiko 	struct btf_ext_sec_setup_param param = {
2666ae4ab4b4SAndrii Nakryiko 		.off = btf_ext->hdr->line_info_off,
2667ae4ab4b4SAndrii Nakryiko 		.len = btf_ext->hdr->line_info_len,
26683d650141SMartin KaFai Lau 		.min_rec_size = sizeof(struct bpf_line_info_min),
26693d650141SMartin KaFai Lau 		.ext_info = &btf_ext->line_info,
26703d650141SMartin KaFai Lau 		.desc = "line_info",
26713d650141SMartin KaFai Lau 	};
26723d650141SMartin KaFai Lau 
2673ae4ab4b4SAndrii Nakryiko 	return btf_ext_setup_info(btf_ext, &param);
26743d650141SMartin KaFai Lau }
26753d650141SMartin KaFai Lau 
267628b93c64SAndrii Nakryiko static int btf_ext_setup_core_relos(struct btf_ext *btf_ext)
26774cedc0daSAndrii Nakryiko {
26784cedc0daSAndrii Nakryiko 	struct btf_ext_sec_setup_param param = {
267928b93c64SAndrii Nakryiko 		.off = btf_ext->hdr->core_relo_off,
268028b93c64SAndrii Nakryiko 		.len = btf_ext->hdr->core_relo_len,
268128b93c64SAndrii Nakryiko 		.min_rec_size = sizeof(struct bpf_core_relo),
268228b93c64SAndrii Nakryiko 		.ext_info = &btf_ext->core_relo_info,
268328b93c64SAndrii Nakryiko 		.desc = "core_relo",
26844cedc0daSAndrii Nakryiko 	};
26854cedc0daSAndrii Nakryiko 
26864cedc0daSAndrii Nakryiko 	return btf_ext_setup_info(btf_ext, &param);
26874cedc0daSAndrii Nakryiko }
26884cedc0daSAndrii Nakryiko 
26898461ef8bSYonghong Song static int btf_ext_parse_hdr(__u8 *data, __u32 data_size)
26902993e051SYonghong Song {
26912993e051SYonghong Song 	const struct btf_ext_header *hdr = (struct btf_ext_header *)data;
26922993e051SYonghong Song 
26934cedc0daSAndrii Nakryiko 	if (data_size < offsetofend(struct btf_ext_header, hdr_len) ||
26942993e051SYonghong Song 	    data_size < hdr->hdr_len) {
26958461ef8bSYonghong Song 		pr_debug("BTF.ext header not found");
26962993e051SYonghong Song 		return -EINVAL;
26972993e051SYonghong Song 	}
26982993e051SYonghong Song 
26993289959bSAndrii Nakryiko 	if (hdr->magic == bswap_16(BTF_MAGIC)) {
27003289959bSAndrii Nakryiko 		pr_warn("BTF.ext in non-native endianness is not supported\n");
27013289959bSAndrii Nakryiko 		return -ENOTSUP;
27023289959bSAndrii Nakryiko 	} else if (hdr->magic != BTF_MAGIC) {
27038461ef8bSYonghong Song 		pr_debug("Invalid BTF.ext magic:%x\n", hdr->magic);
27042993e051SYonghong Song 		return -EINVAL;
27052993e051SYonghong Song 	}
27062993e051SYonghong Song 
27072993e051SYonghong Song 	if (hdr->version != BTF_VERSION) {
27088461ef8bSYonghong Song 		pr_debug("Unsupported BTF.ext version:%u\n", hdr->version);
27092993e051SYonghong Song 		return -ENOTSUP;
27102993e051SYonghong Song 	}
27112993e051SYonghong Song 
27122993e051SYonghong Song 	if (hdr->flags) {
27138461ef8bSYonghong Song 		pr_debug("Unsupported BTF.ext flags:%x\n", hdr->flags);
27142993e051SYonghong Song 		return -ENOTSUP;
27152993e051SYonghong Song 	}
27162993e051SYonghong Song 
2717f0187f0bSMartin KaFai Lau 	if (data_size == hdr->hdr_len) {
27188461ef8bSYonghong Song 		pr_debug("BTF.ext has no data\n");
27192993e051SYonghong Song 		return -EINVAL;
27202993e051SYonghong Song 	}
27212993e051SYonghong Song 
2722f0187f0bSMartin KaFai Lau 	return 0;
27232993e051SYonghong Song }
27242993e051SYonghong Song 
27252993e051SYonghong Song void btf_ext__free(struct btf_ext *btf_ext)
27262993e051SYonghong Song {
272750450fc7SAndrii Nakryiko 	if (IS_ERR_OR_NULL(btf_ext))
27282993e051SYonghong Song 		return;
2729ae4ab4b4SAndrii Nakryiko 	free(btf_ext->data);
27302993e051SYonghong Song 	free(btf_ext);
27312993e051SYonghong Song }
27322993e051SYonghong Song 
27338461ef8bSYonghong Song struct btf_ext *btf_ext__new(__u8 *data, __u32 size)
27342993e051SYonghong Song {
27352993e051SYonghong Song 	struct btf_ext *btf_ext;
27362993e051SYonghong Song 	int err;
27372993e051SYonghong Song 
27388461ef8bSYonghong Song 	err = btf_ext_parse_hdr(data, size);
27392993e051SYonghong Song 	if (err)
2740e9fc3ce9SAndrii Nakryiko 		return libbpf_err_ptr(err);
27412993e051SYonghong Song 
27422993e051SYonghong Song 	btf_ext = calloc(1, sizeof(struct btf_ext));
27432993e051SYonghong Song 	if (!btf_ext)
2744e9fc3ce9SAndrii Nakryiko 		return libbpf_err_ptr(-ENOMEM);
27452993e051SYonghong Song 
2746ae4ab4b4SAndrii Nakryiko 	btf_ext->data_size = size;
2747ae4ab4b4SAndrii Nakryiko 	btf_ext->data = malloc(size);
2748ae4ab4b4SAndrii Nakryiko 	if (!btf_ext->data) {
2749ae4ab4b4SAndrii Nakryiko 		err = -ENOMEM;
2750ae4ab4b4SAndrii Nakryiko 		goto done;
27512993e051SYonghong Song 	}
2752ae4ab4b4SAndrii Nakryiko 	memcpy(btf_ext->data, data, size);
27532993e051SYonghong Song 
2754e9fc3ce9SAndrii Nakryiko 	if (btf_ext->hdr->hdr_len < offsetofend(struct btf_ext_header, line_info_len)) {
2755e9fc3ce9SAndrii Nakryiko 		err = -EINVAL;
27564cedc0daSAndrii Nakryiko 		goto done;
2757e9fc3ce9SAndrii Nakryiko 	}
2758e9fc3ce9SAndrii Nakryiko 
2759ae4ab4b4SAndrii Nakryiko 	err = btf_ext_setup_func_info(btf_ext);
2760ae4ab4b4SAndrii Nakryiko 	if (err)
2761ae4ab4b4SAndrii Nakryiko 		goto done;
2762ae4ab4b4SAndrii Nakryiko 
2763ae4ab4b4SAndrii Nakryiko 	err = btf_ext_setup_line_info(btf_ext);
2764ae4ab4b4SAndrii Nakryiko 	if (err)
2765ae4ab4b4SAndrii Nakryiko 		goto done;
2766ae4ab4b4SAndrii Nakryiko 
2767e9fc3ce9SAndrii Nakryiko 	if (btf_ext->hdr->hdr_len < offsetofend(struct btf_ext_header, core_relo_len)) {
2768e9fc3ce9SAndrii Nakryiko 		err = -EINVAL;
27694cedc0daSAndrii Nakryiko 		goto done;
2770e9fc3ce9SAndrii Nakryiko 	}
2771e9fc3ce9SAndrii Nakryiko 
277228b93c64SAndrii Nakryiko 	err = btf_ext_setup_core_relos(btf_ext);
27734cedc0daSAndrii Nakryiko 	if (err)
27744cedc0daSAndrii Nakryiko 		goto done;
27754cedc0daSAndrii Nakryiko 
2776ae4ab4b4SAndrii Nakryiko done:
27773d650141SMartin KaFai Lau 	if (err) {
27783d650141SMartin KaFai Lau 		btf_ext__free(btf_ext);
2779e9fc3ce9SAndrii Nakryiko 		return libbpf_err_ptr(err);
27803d650141SMartin KaFai Lau 	}
27813d650141SMartin KaFai Lau 
27822993e051SYonghong Song 	return btf_ext;
27832993e051SYonghong Song }
27842993e051SYonghong Song 
2785ae4ab4b4SAndrii Nakryiko const void *btf_ext__get_raw_data(const struct btf_ext *btf_ext, __u32 *size)
2786ae4ab4b4SAndrii Nakryiko {
2787ae4ab4b4SAndrii Nakryiko 	*size = btf_ext->data_size;
2788ae4ab4b4SAndrii Nakryiko 	return btf_ext->data;
2789ae4ab4b4SAndrii Nakryiko }
2790ae4ab4b4SAndrii Nakryiko 
27913d650141SMartin KaFai Lau static int btf_ext_reloc_info(const struct btf *btf,
27923d650141SMartin KaFai Lau 			      const struct btf_ext_info *ext_info,
27932993e051SYonghong Song 			      const char *sec_name, __u32 insns_cnt,
27943d650141SMartin KaFai Lau 			      void **info, __u32 *cnt)
27952993e051SYonghong Song {
27963d650141SMartin KaFai Lau 	__u32 sec_hdrlen = sizeof(struct btf_ext_info_sec);
27973d650141SMartin KaFai Lau 	__u32 i, record_size, existing_len, records_len;
27983d650141SMartin KaFai Lau 	struct btf_ext_info_sec *sinfo;
27992993e051SYonghong Song 	const char *info_sec_name;
28002993e051SYonghong Song 	__u64 remain_len;
28012993e051SYonghong Song 	void *data;
28022993e051SYonghong Song 
28033d650141SMartin KaFai Lau 	record_size = ext_info->rec_size;
28043d650141SMartin KaFai Lau 	sinfo = ext_info->info;
28053d650141SMartin KaFai Lau 	remain_len = ext_info->len;
28062993e051SYonghong Song 	while (remain_len > 0) {
28073d650141SMartin KaFai Lau 		records_len = sinfo->num_info * record_size;
28082993e051SYonghong Song 		info_sec_name = btf__name_by_offset(btf, sinfo->sec_name_off);
28092993e051SYonghong Song 		if (strcmp(info_sec_name, sec_name)) {
28102993e051SYonghong Song 			remain_len -= sec_hdrlen + records_len;
28112993e051SYonghong Song 			sinfo = (void *)sinfo + sec_hdrlen + records_len;
28122993e051SYonghong Song 			continue;
28132993e051SYonghong Song 		}
28142993e051SYonghong Song 
28153d650141SMartin KaFai Lau 		existing_len = (*cnt) * record_size;
28163d650141SMartin KaFai Lau 		data = realloc(*info, existing_len + records_len);
28172993e051SYonghong Song 		if (!data)
2818e9fc3ce9SAndrii Nakryiko 			return libbpf_err(-ENOMEM);
28192993e051SYonghong Song 
28203d650141SMartin KaFai Lau 		memcpy(data + existing_len, sinfo->data, records_len);
282184ecc1f9SMartin KaFai Lau 		/* adjust insn_off only, the rest data will be passed
28222993e051SYonghong Song 		 * to the kernel.
28232993e051SYonghong Song 		 */
28243d650141SMartin KaFai Lau 		for (i = 0; i < sinfo->num_info; i++) {
28253d650141SMartin KaFai Lau 			__u32 *insn_off;
28262993e051SYonghong Song 
28273d650141SMartin KaFai Lau 			insn_off = data + existing_len + (i * record_size);
2828e9fc3ce9SAndrii Nakryiko 			*insn_off = *insn_off / sizeof(struct bpf_insn) + insns_cnt;
28292993e051SYonghong Song 		}
28303d650141SMartin KaFai Lau 		*info = data;
28313d650141SMartin KaFai Lau 		*cnt += sinfo->num_info;
28322993e051SYonghong Song 		return 0;
28332993e051SYonghong Song 	}
28342993e051SYonghong Song 
2835e9fc3ce9SAndrii Nakryiko 	return libbpf_err(-ENOENT);
2836f0187f0bSMartin KaFai Lau }
2837f0187f0bSMartin KaFai Lau 
2838ae4ab4b4SAndrii Nakryiko int btf_ext__reloc_func_info(const struct btf *btf,
2839ae4ab4b4SAndrii Nakryiko 			     const struct btf_ext *btf_ext,
28403d650141SMartin KaFai Lau 			     const char *sec_name, __u32 insns_cnt,
28413d650141SMartin KaFai Lau 			     void **func_info, __u32 *cnt)
28423d650141SMartin KaFai Lau {
28433d650141SMartin KaFai Lau 	return btf_ext_reloc_info(btf, &btf_ext->func_info, sec_name,
28443d650141SMartin KaFai Lau 				  insns_cnt, func_info, cnt);
28453d650141SMartin KaFai Lau }
28463d650141SMartin KaFai Lau 
2847ae4ab4b4SAndrii Nakryiko int btf_ext__reloc_line_info(const struct btf *btf,
2848ae4ab4b4SAndrii Nakryiko 			     const struct btf_ext *btf_ext,
28493d650141SMartin KaFai Lau 			     const char *sec_name, __u32 insns_cnt,
28503d650141SMartin KaFai Lau 			     void **line_info, __u32 *cnt)
28513d650141SMartin KaFai Lau {
28523d650141SMartin KaFai Lau 	return btf_ext_reloc_info(btf, &btf_ext->line_info, sec_name,
28533d650141SMartin KaFai Lau 				  insns_cnt, line_info, cnt);
28543d650141SMartin KaFai Lau }
28553d650141SMartin KaFai Lau 
2856f0187f0bSMartin KaFai Lau __u32 btf_ext__func_info_rec_size(const struct btf_ext *btf_ext)
2857f0187f0bSMartin KaFai Lau {
28583d650141SMartin KaFai Lau 	return btf_ext->func_info.rec_size;
28593d650141SMartin KaFai Lau }
28603d650141SMartin KaFai Lau 
28613d650141SMartin KaFai Lau __u32 btf_ext__line_info_rec_size(const struct btf_ext *btf_ext)
28623d650141SMartin KaFai Lau {
28633d650141SMartin KaFai Lau 	return btf_ext->line_info.rec_size;
28642993e051SYonghong Song }
2865d5caef5bSAndrii Nakryiko 
2866d5caef5bSAndrii Nakryiko struct btf_dedup;
2867d5caef5bSAndrii Nakryiko 
2868957d350aSAndrii Nakryiko static struct btf_dedup *btf_dedup_new(struct btf *btf, const struct btf_dedup_opts *opts);
2869d5caef5bSAndrii Nakryiko static void btf_dedup_free(struct btf_dedup *d);
2870f86524efSAndrii Nakryiko static int btf_dedup_prep(struct btf_dedup *d);
2871d5caef5bSAndrii Nakryiko static int btf_dedup_strings(struct btf_dedup *d);
2872d5caef5bSAndrii Nakryiko static int btf_dedup_prim_types(struct btf_dedup *d);
2873d5caef5bSAndrii Nakryiko static int btf_dedup_struct_types(struct btf_dedup *d);
2874d5caef5bSAndrii Nakryiko static int btf_dedup_ref_types(struct btf_dedup *d);
2875d5caef5bSAndrii Nakryiko static int btf_dedup_compact_types(struct btf_dedup *d);
2876d5caef5bSAndrii Nakryiko static int btf_dedup_remap_types(struct btf_dedup *d);
2877d5caef5bSAndrii Nakryiko 
2878d5caef5bSAndrii Nakryiko /*
2879d5caef5bSAndrii Nakryiko  * Deduplicate BTF types and strings.
2880d5caef5bSAndrii Nakryiko  *
2881d5caef5bSAndrii Nakryiko  * BTF dedup algorithm takes as an input `struct btf` representing `.BTF` ELF
2882d5caef5bSAndrii Nakryiko  * section with all BTF type descriptors and string data. It overwrites that
2883d5caef5bSAndrii Nakryiko  * memory in-place with deduplicated types and strings without any loss of
2884d5caef5bSAndrii Nakryiko  * information. If optional `struct btf_ext` representing '.BTF.ext' ELF section
2885d5caef5bSAndrii Nakryiko  * is provided, all the strings referenced from .BTF.ext section are honored
2886d5caef5bSAndrii Nakryiko  * and updated to point to the right offsets after deduplication.
2887d5caef5bSAndrii Nakryiko  *
2888d5caef5bSAndrii Nakryiko  * If function returns with error, type/string data might be garbled and should
2889d5caef5bSAndrii Nakryiko  * be discarded.
2890d5caef5bSAndrii Nakryiko  *
2891d5caef5bSAndrii Nakryiko  * More verbose and detailed description of both problem btf_dedup is solving,
2892d5caef5bSAndrii Nakryiko  * as well as solution could be found at:
2893d5caef5bSAndrii Nakryiko  * https://facebookmicrosites.github.io/bpf/blog/2018/11/14/btf-enhancement.html
2894d5caef5bSAndrii Nakryiko  *
2895d5caef5bSAndrii Nakryiko  * Problem description and justification
2896d5caef5bSAndrii Nakryiko  * =====================================
2897d5caef5bSAndrii Nakryiko  *
2898d5caef5bSAndrii Nakryiko  * BTF type information is typically emitted either as a result of conversion
2899d5caef5bSAndrii Nakryiko  * from DWARF to BTF or directly by compiler. In both cases, each compilation
2900d5caef5bSAndrii Nakryiko  * unit contains information about a subset of all the types that are used
2901d5caef5bSAndrii Nakryiko  * in an application. These subsets are frequently overlapping and contain a lot
2902d5caef5bSAndrii Nakryiko  * of duplicated information when later concatenated together into a single
2903d5caef5bSAndrii Nakryiko  * binary. This algorithm ensures that each unique type is represented by single
2904d5caef5bSAndrii Nakryiko  * BTF type descriptor, greatly reducing resulting size of BTF data.
2905d5caef5bSAndrii Nakryiko  *
2906d5caef5bSAndrii Nakryiko  * Compilation unit isolation and subsequent duplication of data is not the only
2907d5caef5bSAndrii Nakryiko  * problem. The same type hierarchy (e.g., struct and all the type that struct
2908d5caef5bSAndrii Nakryiko  * references) in different compilation units can be represented in BTF to
2909d5caef5bSAndrii Nakryiko  * various degrees of completeness (or, rather, incompleteness) due to
2910d5caef5bSAndrii Nakryiko  * struct/union forward declarations.
2911d5caef5bSAndrii Nakryiko  *
2912d5caef5bSAndrii Nakryiko  * Let's take a look at an example, that we'll use to better understand the
2913d5caef5bSAndrii Nakryiko  * problem (and solution). Suppose we have two compilation units, each using
2914d5caef5bSAndrii Nakryiko  * same `struct S`, but each of them having incomplete type information about
2915d5caef5bSAndrii Nakryiko  * struct's fields:
2916d5caef5bSAndrii Nakryiko  *
2917d5caef5bSAndrii Nakryiko  * // CU #1:
2918d5caef5bSAndrii Nakryiko  * struct S;
2919d5caef5bSAndrii Nakryiko  * struct A {
2920d5caef5bSAndrii Nakryiko  *	int a;
2921d5caef5bSAndrii Nakryiko  *	struct A* self;
2922d5caef5bSAndrii Nakryiko  *	struct S* parent;
2923d5caef5bSAndrii Nakryiko  * };
2924d5caef5bSAndrii Nakryiko  * struct B;
2925d5caef5bSAndrii Nakryiko  * struct S {
2926d5caef5bSAndrii Nakryiko  *	struct A* a_ptr;
2927d5caef5bSAndrii Nakryiko  *	struct B* b_ptr;
2928d5caef5bSAndrii Nakryiko  * };
2929d5caef5bSAndrii Nakryiko  *
2930d5caef5bSAndrii Nakryiko  * // CU #2:
2931d5caef5bSAndrii Nakryiko  * struct S;
2932d5caef5bSAndrii Nakryiko  * struct A;
2933d5caef5bSAndrii Nakryiko  * struct B {
2934d5caef5bSAndrii Nakryiko  *	int b;
2935d5caef5bSAndrii Nakryiko  *	struct B* self;
2936d5caef5bSAndrii Nakryiko  *	struct S* parent;
2937d5caef5bSAndrii Nakryiko  * };
2938d5caef5bSAndrii Nakryiko  * struct S {
2939d5caef5bSAndrii Nakryiko  *	struct A* a_ptr;
2940d5caef5bSAndrii Nakryiko  *	struct B* b_ptr;
2941d5caef5bSAndrii Nakryiko  * };
2942d5caef5bSAndrii Nakryiko  *
2943d5caef5bSAndrii Nakryiko  * In case of CU #1, BTF data will know only that `struct B` exist (but no
2944d5caef5bSAndrii Nakryiko  * more), but will know the complete type information about `struct A`. While
2945d5caef5bSAndrii Nakryiko  * for CU #2, it will know full type information about `struct B`, but will
2946d5caef5bSAndrii Nakryiko  * only know about forward declaration of `struct A` (in BTF terms, it will
2947d5caef5bSAndrii Nakryiko  * have `BTF_KIND_FWD` type descriptor with name `B`).
2948d5caef5bSAndrii Nakryiko  *
2949d5caef5bSAndrii Nakryiko  * This compilation unit isolation means that it's possible that there is no
2950d5caef5bSAndrii Nakryiko  * single CU with complete type information describing structs `S`, `A`, and
2951d5caef5bSAndrii Nakryiko  * `B`. Also, we might get tons of duplicated and redundant type information.
2952d5caef5bSAndrii Nakryiko  *
2953d5caef5bSAndrii Nakryiko  * Additional complication we need to keep in mind comes from the fact that
2954d5caef5bSAndrii Nakryiko  * types, in general, can form graphs containing cycles, not just DAGs.
2955d5caef5bSAndrii Nakryiko  *
2956d5caef5bSAndrii Nakryiko  * While algorithm does deduplication, it also merges and resolves type
2957d5caef5bSAndrii Nakryiko  * information (unless disabled throught `struct btf_opts`), whenever possible.
2958d5caef5bSAndrii Nakryiko  * E.g., in the example above with two compilation units having partial type
2959d5caef5bSAndrii Nakryiko  * information for structs `A` and `B`, the output of algorithm will emit
2960d5caef5bSAndrii Nakryiko  * a single copy of each BTF type that describes structs `A`, `B`, and `S`
2961d5caef5bSAndrii Nakryiko  * (as well as type information for `int` and pointers), as if they were defined
2962d5caef5bSAndrii Nakryiko  * in a single compilation unit as:
2963d5caef5bSAndrii Nakryiko  *
2964d5caef5bSAndrii Nakryiko  * struct A {
2965d5caef5bSAndrii Nakryiko  *	int a;
2966d5caef5bSAndrii Nakryiko  *	struct A* self;
2967d5caef5bSAndrii Nakryiko  *	struct S* parent;
2968d5caef5bSAndrii Nakryiko  * };
2969d5caef5bSAndrii Nakryiko  * struct B {
2970d5caef5bSAndrii Nakryiko  *	int b;
2971d5caef5bSAndrii Nakryiko  *	struct B* self;
2972d5caef5bSAndrii Nakryiko  *	struct S* parent;
2973d5caef5bSAndrii Nakryiko  * };
2974d5caef5bSAndrii Nakryiko  * struct S {
2975d5caef5bSAndrii Nakryiko  *	struct A* a_ptr;
2976d5caef5bSAndrii Nakryiko  *	struct B* b_ptr;
2977d5caef5bSAndrii Nakryiko  * };
2978d5caef5bSAndrii Nakryiko  *
2979d5caef5bSAndrii Nakryiko  * Algorithm summary
2980d5caef5bSAndrii Nakryiko  * =================
2981d5caef5bSAndrii Nakryiko  *
2982d5caef5bSAndrii Nakryiko  * Algorithm completes its work in 6 separate passes:
2983d5caef5bSAndrii Nakryiko  *
2984d5caef5bSAndrii Nakryiko  * 1. Strings deduplication.
2985d5caef5bSAndrii Nakryiko  * 2. Primitive types deduplication (int, enum, fwd).
2986d5caef5bSAndrii Nakryiko  * 3. Struct/union types deduplication.
2987d5caef5bSAndrii Nakryiko  * 4. Reference types deduplication (pointers, typedefs, arrays, funcs, func
2988d5caef5bSAndrii Nakryiko  *    protos, and const/volatile/restrict modifiers).
2989d5caef5bSAndrii Nakryiko  * 5. Types compaction.
2990d5caef5bSAndrii Nakryiko  * 6. Types remapping.
2991d5caef5bSAndrii Nakryiko  *
2992d5caef5bSAndrii Nakryiko  * Algorithm determines canonical type descriptor, which is a single
2993d5caef5bSAndrii Nakryiko  * representative type for each truly unique type. This canonical type is the
2994d5caef5bSAndrii Nakryiko  * one that will go into final deduplicated BTF type information. For
2995d5caef5bSAndrii Nakryiko  * struct/unions, it is also the type that algorithm will merge additional type
2996d5caef5bSAndrii Nakryiko  * information into (while resolving FWDs), as it discovers it from data in
2997d5caef5bSAndrii Nakryiko  * other CUs. Each input BTF type eventually gets either mapped to itself, if
2998d5caef5bSAndrii Nakryiko  * that type is canonical, or to some other type, if that type is equivalent
2999d5caef5bSAndrii Nakryiko  * and was chosen as canonical representative. This mapping is stored in
3000d5caef5bSAndrii Nakryiko  * `btf_dedup->map` array. This map is also used to record STRUCT/UNION that
3001d5caef5bSAndrii Nakryiko  * FWD type got resolved to.
3002d5caef5bSAndrii Nakryiko  *
3003d5caef5bSAndrii Nakryiko  * To facilitate fast discovery of canonical types, we also maintain canonical
3004d5caef5bSAndrii Nakryiko  * index (`btf_dedup->dedup_table`), which maps type descriptor's signature hash
3005d5caef5bSAndrii Nakryiko  * (i.e., hashed kind, name, size, fields, etc) into a list of canonical types
3006d5caef5bSAndrii Nakryiko  * that match that signature. With sufficiently good choice of type signature
3007d5caef5bSAndrii Nakryiko  * hashing function, we can limit number of canonical types for each unique type
3008d5caef5bSAndrii Nakryiko  * signature to a very small number, allowing to find canonical type for any
3009d5caef5bSAndrii Nakryiko  * duplicated type very quickly.
3010d5caef5bSAndrii Nakryiko  *
3011d5caef5bSAndrii Nakryiko  * Struct/union deduplication is the most critical part and algorithm for
3012d5caef5bSAndrii Nakryiko  * deduplicating structs/unions is described in greater details in comments for
3013d5caef5bSAndrii Nakryiko  * `btf_dedup_is_equiv` function.
3014d5caef5bSAndrii Nakryiko  */
3015957d350aSAndrii Nakryiko 
3016957d350aSAndrii Nakryiko DEFAULT_VERSION(btf__dedup_v0_6_0, btf__dedup, LIBBPF_0.6.0)
3017957d350aSAndrii Nakryiko int btf__dedup_v0_6_0(struct btf *btf, const struct btf_dedup_opts *opts)
3018d5caef5bSAndrii Nakryiko {
3019957d350aSAndrii Nakryiko 	struct btf_dedup *d;
3020d5caef5bSAndrii Nakryiko 	int err;
3021d5caef5bSAndrii Nakryiko 
3022957d350aSAndrii Nakryiko 	if (!OPTS_VALID(opts, btf_dedup_opts))
3023957d350aSAndrii Nakryiko 		return libbpf_err(-EINVAL);
3024957d350aSAndrii Nakryiko 
3025957d350aSAndrii Nakryiko 	d = btf_dedup_new(btf, opts);
3026d5caef5bSAndrii Nakryiko 	if (IS_ERR(d)) {
3027d5caef5bSAndrii Nakryiko 		pr_debug("btf_dedup_new failed: %ld", PTR_ERR(d));
3028e9fc3ce9SAndrii Nakryiko 		return libbpf_err(-EINVAL);
3029d5caef5bSAndrii Nakryiko 	}
3030d5caef5bSAndrii Nakryiko 
30311000298cSMauricio Vásquez 	if (btf_ensure_modifiable(btf)) {
30321000298cSMauricio Vásquez 		err = -ENOMEM;
30331000298cSMauricio Vásquez 		goto done;
30341000298cSMauricio Vásquez 	}
3035919d2b1dSAndrii Nakryiko 
3036f86524efSAndrii Nakryiko 	err = btf_dedup_prep(d);
3037f86524efSAndrii Nakryiko 	if (err) {
3038f86524efSAndrii Nakryiko 		pr_debug("btf_dedup_prep failed:%d\n", err);
3039f86524efSAndrii Nakryiko 		goto done;
3040f86524efSAndrii Nakryiko 	}
3041d5caef5bSAndrii Nakryiko 	err = btf_dedup_strings(d);
3042d5caef5bSAndrii Nakryiko 	if (err < 0) {
3043d5caef5bSAndrii Nakryiko 		pr_debug("btf_dedup_strings failed:%d\n", err);
3044d5caef5bSAndrii Nakryiko 		goto done;
3045d5caef5bSAndrii Nakryiko 	}
3046d5caef5bSAndrii Nakryiko 	err = btf_dedup_prim_types(d);
3047d5caef5bSAndrii Nakryiko 	if (err < 0) {
3048d5caef5bSAndrii Nakryiko 		pr_debug("btf_dedup_prim_types failed:%d\n", err);
3049d5caef5bSAndrii Nakryiko 		goto done;
3050d5caef5bSAndrii Nakryiko 	}
3051d5caef5bSAndrii Nakryiko 	err = btf_dedup_struct_types(d);
3052d5caef5bSAndrii Nakryiko 	if (err < 0) {
3053d5caef5bSAndrii Nakryiko 		pr_debug("btf_dedup_struct_types failed:%d\n", err);
3054d5caef5bSAndrii Nakryiko 		goto done;
3055d5caef5bSAndrii Nakryiko 	}
3056d5caef5bSAndrii Nakryiko 	err = btf_dedup_ref_types(d);
3057d5caef5bSAndrii Nakryiko 	if (err < 0) {
3058d5caef5bSAndrii Nakryiko 		pr_debug("btf_dedup_ref_types failed:%d\n", err);
3059d5caef5bSAndrii Nakryiko 		goto done;
3060d5caef5bSAndrii Nakryiko 	}
3061d5caef5bSAndrii Nakryiko 	err = btf_dedup_compact_types(d);
3062d5caef5bSAndrii Nakryiko 	if (err < 0) {
3063d5caef5bSAndrii Nakryiko 		pr_debug("btf_dedup_compact_types failed:%d\n", err);
3064d5caef5bSAndrii Nakryiko 		goto done;
3065d5caef5bSAndrii Nakryiko 	}
3066d5caef5bSAndrii Nakryiko 	err = btf_dedup_remap_types(d);
3067d5caef5bSAndrii Nakryiko 	if (err < 0) {
3068d5caef5bSAndrii Nakryiko 		pr_debug("btf_dedup_remap_types failed:%d\n", err);
3069d5caef5bSAndrii Nakryiko 		goto done;
3070d5caef5bSAndrii Nakryiko 	}
3071d5caef5bSAndrii Nakryiko 
3072d5caef5bSAndrii Nakryiko done:
3073d5caef5bSAndrii Nakryiko 	btf_dedup_free(d);
3074e9fc3ce9SAndrii Nakryiko 	return libbpf_err(err);
3075d5caef5bSAndrii Nakryiko }
3076d5caef5bSAndrii Nakryiko 
3077957d350aSAndrii Nakryiko COMPAT_VERSION(bpf__dedup_deprecated, btf__dedup, LIBBPF_0.0.2)
3078957d350aSAndrii Nakryiko int btf__dedup_deprecated(struct btf *btf, struct btf_ext *btf_ext, const void *unused_opts)
3079957d350aSAndrii Nakryiko {
3080957d350aSAndrii Nakryiko 	LIBBPF_OPTS(btf_dedup_opts, opts, .btf_ext = btf_ext);
3081957d350aSAndrii Nakryiko 
3082957d350aSAndrii Nakryiko 	if (unused_opts) {
3083957d350aSAndrii Nakryiko 		pr_warn("please use new version of btf__dedup() that supports options\n");
3084957d350aSAndrii Nakryiko 		return libbpf_err(-ENOTSUP);
3085957d350aSAndrii Nakryiko 	}
3086957d350aSAndrii Nakryiko 
3087957d350aSAndrii Nakryiko 	return btf__dedup(btf, &opts);
3088957d350aSAndrii Nakryiko }
3089957d350aSAndrii Nakryiko 
3090d5caef5bSAndrii Nakryiko #define BTF_UNPROCESSED_ID ((__u32)-1)
3091d5caef5bSAndrii Nakryiko #define BTF_IN_PROGRESS_ID ((__u32)-2)
3092d5caef5bSAndrii Nakryiko 
3093d5caef5bSAndrii Nakryiko struct btf_dedup {
3094d5caef5bSAndrii Nakryiko 	/* .BTF section to be deduped in-place */
3095d5caef5bSAndrii Nakryiko 	struct btf *btf;
3096d5caef5bSAndrii Nakryiko 	/*
3097d5caef5bSAndrii Nakryiko 	 * Optional .BTF.ext section. When provided, any strings referenced
3098d5caef5bSAndrii Nakryiko 	 * from it will be taken into account when deduping strings
3099d5caef5bSAndrii Nakryiko 	 */
3100d5caef5bSAndrii Nakryiko 	struct btf_ext *btf_ext;
3101d5caef5bSAndrii Nakryiko 	/*
3102d5caef5bSAndrii Nakryiko 	 * This is a map from any type's signature hash to a list of possible
3103d5caef5bSAndrii Nakryiko 	 * canonical representative type candidates. Hash collisions are
3104d5caef5bSAndrii Nakryiko 	 * ignored, so even types of various kinds can share same list of
3105d5caef5bSAndrii Nakryiko 	 * candidates, which is fine because we rely on subsequent
3106d5caef5bSAndrii Nakryiko 	 * btf_xxx_equal() checks to authoritatively verify type equality.
3107d5caef5bSAndrii Nakryiko 	 */
31082fc3fc0bSAndrii Nakryiko 	struct hashmap *dedup_table;
3109d5caef5bSAndrii Nakryiko 	/* Canonical types map */
3110d5caef5bSAndrii Nakryiko 	__u32 *map;
3111d5caef5bSAndrii Nakryiko 	/* Hypothetical mapping, used during type graph equivalence checks */
3112d5caef5bSAndrii Nakryiko 	__u32 *hypot_map;
3113d5caef5bSAndrii Nakryiko 	__u32 *hypot_list;
3114d5caef5bSAndrii Nakryiko 	size_t hypot_cnt;
3115d5caef5bSAndrii Nakryiko 	size_t hypot_cap;
3116f86524efSAndrii Nakryiko 	/* Whether hypothetical mapping, if successful, would need to adjust
3117f86524efSAndrii Nakryiko 	 * already canonicalized types (due to a new forward declaration to
3118f86524efSAndrii Nakryiko 	 * concrete type resolution). In such case, during split BTF dedup
3119f86524efSAndrii Nakryiko 	 * candidate type would still be considered as different, because base
3120f86524efSAndrii Nakryiko 	 * BTF is considered to be immutable.
3121f86524efSAndrii Nakryiko 	 */
3122f86524efSAndrii Nakryiko 	bool hypot_adjust_canon;
3123d5caef5bSAndrii Nakryiko 	/* Various option modifying behavior of algorithm */
3124d5caef5bSAndrii Nakryiko 	struct btf_dedup_opts opts;
312588a82c2aSAndrii Nakryiko 	/* temporary strings deduplication state */
312690d76d3eSAndrii Nakryiko 	struct strset *strs_set;
3127d5caef5bSAndrii Nakryiko };
3128d5caef5bSAndrii Nakryiko 
31292fc3fc0bSAndrii Nakryiko static long hash_combine(long h, long value)
3130d5caef5bSAndrii Nakryiko {
31312fc3fc0bSAndrii Nakryiko 	return h * 31 + value;
3132d5caef5bSAndrii Nakryiko }
3133d5caef5bSAndrii Nakryiko 
31342fc3fc0bSAndrii Nakryiko #define for_each_dedup_cand(d, node, hash) \
31352fc3fc0bSAndrii Nakryiko 	hashmap__for_each_key_entry(d->dedup_table, node, (void *)hash)
3136d5caef5bSAndrii Nakryiko 
31372fc3fc0bSAndrii Nakryiko static int btf_dedup_table_add(struct btf_dedup *d, long hash, __u32 type_id)
3138d5caef5bSAndrii Nakryiko {
31392fc3fc0bSAndrii Nakryiko 	return hashmap__append(d->dedup_table,
31402fc3fc0bSAndrii Nakryiko 			       (void *)hash, (void *)(long)type_id);
3141d5caef5bSAndrii Nakryiko }
3142d5caef5bSAndrii Nakryiko 
3143d5caef5bSAndrii Nakryiko static int btf_dedup_hypot_map_add(struct btf_dedup *d,
3144d5caef5bSAndrii Nakryiko 				   __u32 from_id, __u32 to_id)
3145d5caef5bSAndrii Nakryiko {
3146d5caef5bSAndrii Nakryiko 	if (d->hypot_cnt == d->hypot_cap) {
3147d5caef5bSAndrii Nakryiko 		__u32 *new_list;
3148d5caef5bSAndrii Nakryiko 
3149fb2426adSMartin KaFai Lau 		d->hypot_cap += max((size_t)16, d->hypot_cap / 2);
3150029258d7SAndrii Nakryiko 		new_list = libbpf_reallocarray(d->hypot_list, d->hypot_cap, sizeof(__u32));
3151d5caef5bSAndrii Nakryiko 		if (!new_list)
3152d5caef5bSAndrii Nakryiko 			return -ENOMEM;
3153d5caef5bSAndrii Nakryiko 		d->hypot_list = new_list;
3154d5caef5bSAndrii Nakryiko 	}
3155d5caef5bSAndrii Nakryiko 	d->hypot_list[d->hypot_cnt++] = from_id;
3156d5caef5bSAndrii Nakryiko 	d->hypot_map[from_id] = to_id;
3157d5caef5bSAndrii Nakryiko 	return 0;
3158d5caef5bSAndrii Nakryiko }
3159d5caef5bSAndrii Nakryiko 
3160d5caef5bSAndrii Nakryiko static void btf_dedup_clear_hypot_map(struct btf_dedup *d)
3161d5caef5bSAndrii Nakryiko {
3162d5caef5bSAndrii Nakryiko 	int i;
3163d5caef5bSAndrii Nakryiko 
3164d5caef5bSAndrii Nakryiko 	for (i = 0; i < d->hypot_cnt; i++)
3165d5caef5bSAndrii Nakryiko 		d->hypot_map[d->hypot_list[i]] = BTF_UNPROCESSED_ID;
3166d5caef5bSAndrii Nakryiko 	d->hypot_cnt = 0;
3167f86524efSAndrii Nakryiko 	d->hypot_adjust_canon = false;
3168d5caef5bSAndrii Nakryiko }
3169d5caef5bSAndrii Nakryiko 
3170d5caef5bSAndrii Nakryiko static void btf_dedup_free(struct btf_dedup *d)
3171d5caef5bSAndrii Nakryiko {
31722fc3fc0bSAndrii Nakryiko 	hashmap__free(d->dedup_table);
31732fc3fc0bSAndrii Nakryiko 	d->dedup_table = NULL;
3174d5caef5bSAndrii Nakryiko 
3175d5caef5bSAndrii Nakryiko 	free(d->map);
3176d5caef5bSAndrii Nakryiko 	d->map = NULL;
3177d5caef5bSAndrii Nakryiko 
3178d5caef5bSAndrii Nakryiko 	free(d->hypot_map);
3179d5caef5bSAndrii Nakryiko 	d->hypot_map = NULL;
3180d5caef5bSAndrii Nakryiko 
3181d5caef5bSAndrii Nakryiko 	free(d->hypot_list);
3182d5caef5bSAndrii Nakryiko 	d->hypot_list = NULL;
3183d5caef5bSAndrii Nakryiko 
3184d5caef5bSAndrii Nakryiko 	free(d);
3185d5caef5bSAndrii Nakryiko }
3186d5caef5bSAndrii Nakryiko 
31872fc3fc0bSAndrii Nakryiko static size_t btf_dedup_identity_hash_fn(const void *key, void *ctx)
318851edf5f6SAndrii Nakryiko {
31892fc3fc0bSAndrii Nakryiko 	return (size_t)key;
319051edf5f6SAndrii Nakryiko }
319151edf5f6SAndrii Nakryiko 
31922fc3fc0bSAndrii Nakryiko static size_t btf_dedup_collision_hash_fn(const void *key, void *ctx)
31932fc3fc0bSAndrii Nakryiko {
31942fc3fc0bSAndrii Nakryiko 	return 0;
31952fc3fc0bSAndrii Nakryiko }
31962fc3fc0bSAndrii Nakryiko 
31972fc3fc0bSAndrii Nakryiko static bool btf_dedup_equal_fn(const void *k1, const void *k2, void *ctx)
31982fc3fc0bSAndrii Nakryiko {
31992fc3fc0bSAndrii Nakryiko 	return k1 == k2;
32002fc3fc0bSAndrii Nakryiko }
320151edf5f6SAndrii Nakryiko 
3202957d350aSAndrii Nakryiko static struct btf_dedup *btf_dedup_new(struct btf *btf, const struct btf_dedup_opts *opts)
3203d5caef5bSAndrii Nakryiko {
3204d5caef5bSAndrii Nakryiko 	struct btf_dedup *d = calloc(1, sizeof(struct btf_dedup));
32052fc3fc0bSAndrii Nakryiko 	hashmap_hash_fn hash_fn = btf_dedup_identity_hash_fn;
3206f86524efSAndrii Nakryiko 	int i, err = 0, type_cnt;
3207d5caef5bSAndrii Nakryiko 
3208d5caef5bSAndrii Nakryiko 	if (!d)
3209d5caef5bSAndrii Nakryiko 		return ERR_PTR(-ENOMEM);
3210d5caef5bSAndrii Nakryiko 
3211957d350aSAndrii Nakryiko 	if (OPTS_GET(opts, force_collisions, false))
32122fc3fc0bSAndrii Nakryiko 		hash_fn = btf_dedup_collision_hash_fn;
321351edf5f6SAndrii Nakryiko 
3214d5caef5bSAndrii Nakryiko 	d->btf = btf;
3215957d350aSAndrii Nakryiko 	d->btf_ext = OPTS_GET(opts, btf_ext, NULL);
3216d5caef5bSAndrii Nakryiko 
32172fc3fc0bSAndrii Nakryiko 	d->dedup_table = hashmap__new(hash_fn, btf_dedup_equal_fn, NULL);
32182fc3fc0bSAndrii Nakryiko 	if (IS_ERR(d->dedup_table)) {
32192fc3fc0bSAndrii Nakryiko 		err = PTR_ERR(d->dedup_table);
32202fc3fc0bSAndrii Nakryiko 		d->dedup_table = NULL;
3221d5caef5bSAndrii Nakryiko 		goto done;
3222d5caef5bSAndrii Nakryiko 	}
3223d5caef5bSAndrii Nakryiko 
32246a886de0SHengqi Chen 	type_cnt = btf__type_cnt(btf);
3225f86524efSAndrii Nakryiko 	d->map = malloc(sizeof(__u32) * type_cnt);
3226d5caef5bSAndrii Nakryiko 	if (!d->map) {
3227d5caef5bSAndrii Nakryiko 		err = -ENOMEM;
3228d5caef5bSAndrii Nakryiko 		goto done;
3229d5caef5bSAndrii Nakryiko 	}
3230d5caef5bSAndrii Nakryiko 	/* special BTF "void" type is made canonical immediately */
3231d5caef5bSAndrii Nakryiko 	d->map[0] = 0;
3232f86524efSAndrii Nakryiko 	for (i = 1; i < type_cnt; i++) {
3233740e69c3SAndrii Nakryiko 		struct btf_type *t = btf_type_by_id(d->btf, i);
3234189cf5a4SAndrii Nakryiko 
3235189cf5a4SAndrii Nakryiko 		/* VAR and DATASEC are never deduped and are self-canonical */
3236b03bc685SAndrii Nakryiko 		if (btf_is_var(t) || btf_is_datasec(t))
3237189cf5a4SAndrii Nakryiko 			d->map[i] = i;
3238189cf5a4SAndrii Nakryiko 		else
3239d5caef5bSAndrii Nakryiko 			d->map[i] = BTF_UNPROCESSED_ID;
3240189cf5a4SAndrii Nakryiko 	}
3241d5caef5bSAndrii Nakryiko 
3242f86524efSAndrii Nakryiko 	d->hypot_map = malloc(sizeof(__u32) * type_cnt);
3243d5caef5bSAndrii Nakryiko 	if (!d->hypot_map) {
3244d5caef5bSAndrii Nakryiko 		err = -ENOMEM;
3245d5caef5bSAndrii Nakryiko 		goto done;
3246d5caef5bSAndrii Nakryiko 	}
3247f86524efSAndrii Nakryiko 	for (i = 0; i < type_cnt; i++)
3248d5caef5bSAndrii Nakryiko 		d->hypot_map[i] = BTF_UNPROCESSED_ID;
3249d5caef5bSAndrii Nakryiko 
3250d5caef5bSAndrii Nakryiko done:
3251d5caef5bSAndrii Nakryiko 	if (err) {
3252d5caef5bSAndrii Nakryiko 		btf_dedup_free(d);
3253d5caef5bSAndrii Nakryiko 		return ERR_PTR(err);
3254d5caef5bSAndrii Nakryiko 	}
3255d5caef5bSAndrii Nakryiko 
3256d5caef5bSAndrii Nakryiko 	return d;
3257d5caef5bSAndrii Nakryiko }
3258d5caef5bSAndrii Nakryiko 
3259d5caef5bSAndrii Nakryiko /*
3260d5caef5bSAndrii Nakryiko  * Iterate over all possible places in .BTF and .BTF.ext that can reference
3261d5caef5bSAndrii Nakryiko  * string and pass pointer to it to a provided callback `fn`.
3262d5caef5bSAndrii Nakryiko  */
3263f36e99a4SAndrii Nakryiko static int btf_for_each_str_off(struct btf_dedup *d, str_off_visit_fn fn, void *ctx)
3264d5caef5bSAndrii Nakryiko {
3265f36e99a4SAndrii Nakryiko 	int i, r;
3266d5caef5bSAndrii Nakryiko 
3267f86524efSAndrii Nakryiko 	for (i = 0; i < d->btf->nr_types; i++) {
3268f36e99a4SAndrii Nakryiko 		struct btf_type *t = btf_type_by_id(d->btf, d->btf->start_id + i);
3269f36e99a4SAndrii Nakryiko 
3270f36e99a4SAndrii Nakryiko 		r = btf_type_visit_str_offs(t, fn, ctx);
3271d5caef5bSAndrii Nakryiko 		if (r)
3272d5caef5bSAndrii Nakryiko 			return r;
3273d5caef5bSAndrii Nakryiko 	}
3274d5caef5bSAndrii Nakryiko 
3275d5caef5bSAndrii Nakryiko 	if (!d->btf_ext)
3276d5caef5bSAndrii Nakryiko 		return 0;
3277d5caef5bSAndrii Nakryiko 
3278f36e99a4SAndrii Nakryiko 	r = btf_ext_visit_str_offs(d->btf_ext, fn, ctx);
3279d5caef5bSAndrii Nakryiko 	if (r)
3280d5caef5bSAndrii Nakryiko 		return r;
3281d5caef5bSAndrii Nakryiko 
3282d5caef5bSAndrii Nakryiko 	return 0;
3283d5caef5bSAndrii Nakryiko }
3284d5caef5bSAndrii Nakryiko 
328588a82c2aSAndrii Nakryiko static int strs_dedup_remap_str_off(__u32 *str_off_ptr, void *ctx)
3286d5caef5bSAndrii Nakryiko {
328788a82c2aSAndrii Nakryiko 	struct btf_dedup *d = ctx;
3288f86524efSAndrii Nakryiko 	__u32 str_off = *str_off_ptr;
328988a82c2aSAndrii Nakryiko 	const char *s;
329090d76d3eSAndrii Nakryiko 	int off, err;
3291d5caef5bSAndrii Nakryiko 
3292f86524efSAndrii Nakryiko 	/* don't touch empty string or string in main BTF */
3293f86524efSAndrii Nakryiko 	if (str_off == 0 || str_off < d->btf->start_str_off)
3294d5caef5bSAndrii Nakryiko 		return 0;
3295d5caef5bSAndrii Nakryiko 
3296f86524efSAndrii Nakryiko 	s = btf__str_by_offset(d->btf, str_off);
3297f86524efSAndrii Nakryiko 	if (d->btf->base_btf) {
3298f86524efSAndrii Nakryiko 		err = btf__find_str(d->btf->base_btf, s);
3299f86524efSAndrii Nakryiko 		if (err >= 0) {
3300f86524efSAndrii Nakryiko 			*str_off_ptr = err;
3301f86524efSAndrii Nakryiko 			return 0;
3302f86524efSAndrii Nakryiko 		}
3303f86524efSAndrii Nakryiko 		if (err != -ENOENT)
3304f86524efSAndrii Nakryiko 			return err;
3305f86524efSAndrii Nakryiko 	}
3306f86524efSAndrii Nakryiko 
330790d76d3eSAndrii Nakryiko 	off = strset__add_str(d->strs_set, s);
330890d76d3eSAndrii Nakryiko 	if (off < 0)
330990d76d3eSAndrii Nakryiko 		return off;
331088a82c2aSAndrii Nakryiko 
331190d76d3eSAndrii Nakryiko 	*str_off_ptr = d->btf->start_str_off + off;
3312d5caef5bSAndrii Nakryiko 	return 0;
3313d5caef5bSAndrii Nakryiko }
3314d5caef5bSAndrii Nakryiko 
3315d5caef5bSAndrii Nakryiko /*
3316d5caef5bSAndrii Nakryiko  * Dedup string and filter out those that are not referenced from either .BTF
3317d5caef5bSAndrii Nakryiko  * or .BTF.ext (if provided) sections.
3318d5caef5bSAndrii Nakryiko  *
3319d5caef5bSAndrii Nakryiko  * This is done by building index of all strings in BTF's string section,
3320d5caef5bSAndrii Nakryiko  * then iterating over all entities that can reference strings (e.g., type
3321d5caef5bSAndrii Nakryiko  * names, struct field names, .BTF.ext line info, etc) and marking corresponding
3322d5caef5bSAndrii Nakryiko  * strings as used. After that all used strings are deduped and compacted into
3323d5caef5bSAndrii Nakryiko  * sequential blob of memory and new offsets are calculated. Then all the string
3324d5caef5bSAndrii Nakryiko  * references are iterated again and rewritten using new offsets.
3325d5caef5bSAndrii Nakryiko  */
3326d5caef5bSAndrii Nakryiko static int btf_dedup_strings(struct btf_dedup *d)
3327d5caef5bSAndrii Nakryiko {
332888a82c2aSAndrii Nakryiko 	int err;
3329d5caef5bSAndrii Nakryiko 
3330919d2b1dSAndrii Nakryiko 	if (d->btf->strs_deduped)
3331919d2b1dSAndrii Nakryiko 		return 0;
3332919d2b1dSAndrii Nakryiko 
333390d76d3eSAndrii Nakryiko 	d->strs_set = strset__new(BTF_MAX_STR_OFFSET, NULL, 0);
333490d76d3eSAndrii Nakryiko 	if (IS_ERR(d->strs_set)) {
333590d76d3eSAndrii Nakryiko 		err = PTR_ERR(d->strs_set);
333688a82c2aSAndrii Nakryiko 		goto err_out;
3337d5caef5bSAndrii Nakryiko 	}
3338d5caef5bSAndrii Nakryiko 
3339f86524efSAndrii Nakryiko 	if (!d->btf->base_btf) {
334088a82c2aSAndrii Nakryiko 		/* insert empty string; we won't be looking it up during strings
334188a82c2aSAndrii Nakryiko 		 * dedup, but it's good to have it for generic BTF string lookups
334288a82c2aSAndrii Nakryiko 		 */
334390d76d3eSAndrii Nakryiko 		err = strset__add_str(d->strs_set, "");
334490d76d3eSAndrii Nakryiko 		if (err < 0)
334588a82c2aSAndrii Nakryiko 			goto err_out;
3346f86524efSAndrii Nakryiko 	}
3347d5caef5bSAndrii Nakryiko 
3348d5caef5bSAndrii Nakryiko 	/* remap string offsets */
334988a82c2aSAndrii Nakryiko 	err = btf_for_each_str_off(d, strs_dedup_remap_str_off, d);
3350d5caef5bSAndrii Nakryiko 	if (err)
335188a82c2aSAndrii Nakryiko 		goto err_out;
3352d5caef5bSAndrii Nakryiko 
335388a82c2aSAndrii Nakryiko 	/* replace BTF string data and hash with deduped ones */
335490d76d3eSAndrii Nakryiko 	strset__free(d->btf->strs_set);
335590d76d3eSAndrii Nakryiko 	d->btf->hdr->str_len = strset__data_size(d->strs_set);
335690d76d3eSAndrii Nakryiko 	d->btf->strs_set = d->strs_set;
335790d76d3eSAndrii Nakryiko 	d->strs_set = NULL;
3358919d2b1dSAndrii Nakryiko 	d->btf->strs_deduped = true;
335988a82c2aSAndrii Nakryiko 	return 0;
3360d5caef5bSAndrii Nakryiko 
336188a82c2aSAndrii Nakryiko err_out:
336290d76d3eSAndrii Nakryiko 	strset__free(d->strs_set);
336390d76d3eSAndrii Nakryiko 	d->strs_set = NULL;
336488a82c2aSAndrii Nakryiko 
3365d5caef5bSAndrii Nakryiko 	return err;
3366d5caef5bSAndrii Nakryiko }
3367d5caef5bSAndrii Nakryiko 
33682fc3fc0bSAndrii Nakryiko static long btf_hash_common(struct btf_type *t)
3369d5caef5bSAndrii Nakryiko {
33702fc3fc0bSAndrii Nakryiko 	long h;
3371d5caef5bSAndrii Nakryiko 
3372d5caef5bSAndrii Nakryiko 	h = hash_combine(0, t->name_off);
3373d5caef5bSAndrii Nakryiko 	h = hash_combine(h, t->info);
3374d5caef5bSAndrii Nakryiko 	h = hash_combine(h, t->size);
3375d5caef5bSAndrii Nakryiko 	return h;
3376d5caef5bSAndrii Nakryiko }
3377d5caef5bSAndrii Nakryiko 
3378d5caef5bSAndrii Nakryiko static bool btf_equal_common(struct btf_type *t1, struct btf_type *t2)
3379d5caef5bSAndrii Nakryiko {
3380d5caef5bSAndrii Nakryiko 	return t1->name_off == t2->name_off &&
3381d5caef5bSAndrii Nakryiko 	       t1->info == t2->info &&
3382d5caef5bSAndrii Nakryiko 	       t1->size == t2->size;
3383d5caef5bSAndrii Nakryiko }
3384d5caef5bSAndrii Nakryiko 
338530025e8bSYonghong Song /* Calculate type signature hash of INT or TAG. */
3386223f903eSYonghong Song static long btf_hash_int_decl_tag(struct btf_type *t)
3387d5caef5bSAndrii Nakryiko {
3388d5caef5bSAndrii Nakryiko 	__u32 info = *(__u32 *)(t + 1);
33892fc3fc0bSAndrii Nakryiko 	long h;
3390d5caef5bSAndrii Nakryiko 
3391d5caef5bSAndrii Nakryiko 	h = btf_hash_common(t);
3392d5caef5bSAndrii Nakryiko 	h = hash_combine(h, info);
3393d5caef5bSAndrii Nakryiko 	return h;
3394d5caef5bSAndrii Nakryiko }
3395d5caef5bSAndrii Nakryiko 
339630025e8bSYonghong Song /* Check structural equality of two INTs or TAGs. */
339730025e8bSYonghong Song static bool btf_equal_int_tag(struct btf_type *t1, struct btf_type *t2)
3398d5caef5bSAndrii Nakryiko {
3399d5caef5bSAndrii Nakryiko 	__u32 info1, info2;
3400d5caef5bSAndrii Nakryiko 
3401d5caef5bSAndrii Nakryiko 	if (!btf_equal_common(t1, t2))
3402d5caef5bSAndrii Nakryiko 		return false;
3403d5caef5bSAndrii Nakryiko 	info1 = *(__u32 *)(t1 + 1);
3404d5caef5bSAndrii Nakryiko 	info2 = *(__u32 *)(t2 + 1);
3405d5caef5bSAndrii Nakryiko 	return info1 == info2;
3406d5caef5bSAndrii Nakryiko }
3407d5caef5bSAndrii Nakryiko 
3408d5caef5bSAndrii Nakryiko /* Calculate type signature hash of ENUM. */
34092fc3fc0bSAndrii Nakryiko static long btf_hash_enum(struct btf_type *t)
3410d5caef5bSAndrii Nakryiko {
34112fc3fc0bSAndrii Nakryiko 	long h;
3412d5caef5bSAndrii Nakryiko 
34139768095bSAndrii Nakryiko 	/* don't hash vlen and enum members to support enum fwd resolving */
34149768095bSAndrii Nakryiko 	h = hash_combine(0, t->name_off);
34159768095bSAndrii Nakryiko 	h = hash_combine(h, t->info & ~0xffff);
34169768095bSAndrii Nakryiko 	h = hash_combine(h, t->size);
3417d5caef5bSAndrii Nakryiko 	return h;
3418d5caef5bSAndrii Nakryiko }
3419d5caef5bSAndrii Nakryiko 
3420d5caef5bSAndrii Nakryiko /* Check structural equality of two ENUMs. */
3421d5caef5bSAndrii Nakryiko static bool btf_equal_enum(struct btf_type *t1, struct btf_type *t2)
3422d5caef5bSAndrii Nakryiko {
3423b03bc685SAndrii Nakryiko 	const struct btf_enum *m1, *m2;
3424d5caef5bSAndrii Nakryiko 	__u16 vlen;
3425d5caef5bSAndrii Nakryiko 	int i;
3426d5caef5bSAndrii Nakryiko 
3427d5caef5bSAndrii Nakryiko 	if (!btf_equal_common(t1, t2))
3428d5caef5bSAndrii Nakryiko 		return false;
3429d5caef5bSAndrii Nakryiko 
3430b03bc685SAndrii Nakryiko 	vlen = btf_vlen(t1);
3431b03bc685SAndrii Nakryiko 	m1 = btf_enum(t1);
3432b03bc685SAndrii Nakryiko 	m2 = btf_enum(t2);
3433d5caef5bSAndrii Nakryiko 	for (i = 0; i < vlen; i++) {
3434d5caef5bSAndrii Nakryiko 		if (m1->name_off != m2->name_off || m1->val != m2->val)
3435d5caef5bSAndrii Nakryiko 			return false;
3436d5caef5bSAndrii Nakryiko 		m1++;
3437d5caef5bSAndrii Nakryiko 		m2++;
3438d5caef5bSAndrii Nakryiko 	}
3439d5caef5bSAndrii Nakryiko 	return true;
3440d5caef5bSAndrii Nakryiko }
3441d5caef5bSAndrii Nakryiko 
34429768095bSAndrii Nakryiko static inline bool btf_is_enum_fwd(struct btf_type *t)
34439768095bSAndrii Nakryiko {
3444b03bc685SAndrii Nakryiko 	return btf_is_enum(t) && btf_vlen(t) == 0;
34459768095bSAndrii Nakryiko }
34469768095bSAndrii Nakryiko 
34479768095bSAndrii Nakryiko static bool btf_compat_enum(struct btf_type *t1, struct btf_type *t2)
34489768095bSAndrii Nakryiko {
34499768095bSAndrii Nakryiko 	if (!btf_is_enum_fwd(t1) && !btf_is_enum_fwd(t2))
34509768095bSAndrii Nakryiko 		return btf_equal_enum(t1, t2);
34519768095bSAndrii Nakryiko 	/* ignore vlen when comparing */
34529768095bSAndrii Nakryiko 	return t1->name_off == t2->name_off &&
34539768095bSAndrii Nakryiko 	       (t1->info & ~0xffff) == (t2->info & ~0xffff) &&
34549768095bSAndrii Nakryiko 	       t1->size == t2->size;
34559768095bSAndrii Nakryiko }
34569768095bSAndrii Nakryiko 
3457d5caef5bSAndrii Nakryiko /*
3458d5caef5bSAndrii Nakryiko  * Calculate type signature hash of STRUCT/UNION, ignoring referenced type IDs,
3459d5caef5bSAndrii Nakryiko  * as referenced type IDs equivalence is established separately during type
3460d5caef5bSAndrii Nakryiko  * graph equivalence check algorithm.
3461d5caef5bSAndrii Nakryiko  */
34622fc3fc0bSAndrii Nakryiko static long btf_hash_struct(struct btf_type *t)
3463d5caef5bSAndrii Nakryiko {
3464b03bc685SAndrii Nakryiko 	const struct btf_member *member = btf_members(t);
3465b03bc685SAndrii Nakryiko 	__u32 vlen = btf_vlen(t);
34662fc3fc0bSAndrii Nakryiko 	long h = btf_hash_common(t);
3467d5caef5bSAndrii Nakryiko 	int i;
3468d5caef5bSAndrii Nakryiko 
3469d5caef5bSAndrii Nakryiko 	for (i = 0; i < vlen; i++) {
3470d5caef5bSAndrii Nakryiko 		h = hash_combine(h, member->name_off);
3471d5caef5bSAndrii Nakryiko 		h = hash_combine(h, member->offset);
3472d5caef5bSAndrii Nakryiko 		/* no hashing of referenced type ID, it can be unresolved yet */
3473d5caef5bSAndrii Nakryiko 		member++;
3474d5caef5bSAndrii Nakryiko 	}
3475d5caef5bSAndrii Nakryiko 	return h;
3476d5caef5bSAndrii Nakryiko }
3477d5caef5bSAndrii Nakryiko 
3478d5caef5bSAndrii Nakryiko /*
3479d5caef5bSAndrii Nakryiko  * Check structural compatibility of two FUNC_PROTOs, ignoring referenced type
3480d5caef5bSAndrii Nakryiko  * IDs. This check is performed during type graph equivalence check and
3481d5caef5bSAndrii Nakryiko  * referenced types equivalence is checked separately.
3482d5caef5bSAndrii Nakryiko  */
348391097fbeSAndrii Nakryiko static bool btf_shallow_equal_struct(struct btf_type *t1, struct btf_type *t2)
3484d5caef5bSAndrii Nakryiko {
3485b03bc685SAndrii Nakryiko 	const struct btf_member *m1, *m2;
3486d5caef5bSAndrii Nakryiko 	__u16 vlen;
3487d5caef5bSAndrii Nakryiko 	int i;
3488d5caef5bSAndrii Nakryiko 
3489d5caef5bSAndrii Nakryiko 	if (!btf_equal_common(t1, t2))
3490d5caef5bSAndrii Nakryiko 		return false;
3491d5caef5bSAndrii Nakryiko 
3492b03bc685SAndrii Nakryiko 	vlen = btf_vlen(t1);
3493b03bc685SAndrii Nakryiko 	m1 = btf_members(t1);
3494b03bc685SAndrii Nakryiko 	m2 = btf_members(t2);
3495d5caef5bSAndrii Nakryiko 	for (i = 0; i < vlen; i++) {
3496d5caef5bSAndrii Nakryiko 		if (m1->name_off != m2->name_off || m1->offset != m2->offset)
3497d5caef5bSAndrii Nakryiko 			return false;
3498d5caef5bSAndrii Nakryiko 		m1++;
3499d5caef5bSAndrii Nakryiko 		m2++;
3500d5caef5bSAndrii Nakryiko 	}
3501d5caef5bSAndrii Nakryiko 	return true;
3502d5caef5bSAndrii Nakryiko }
3503d5caef5bSAndrii Nakryiko 
3504d5caef5bSAndrii Nakryiko /*
3505d5caef5bSAndrii Nakryiko  * Calculate type signature hash of ARRAY, including referenced type IDs,
3506d5caef5bSAndrii Nakryiko  * under assumption that they were already resolved to canonical type IDs and
3507d5caef5bSAndrii Nakryiko  * are not going to change.
3508d5caef5bSAndrii Nakryiko  */
35092fc3fc0bSAndrii Nakryiko static long btf_hash_array(struct btf_type *t)
3510d5caef5bSAndrii Nakryiko {
3511b03bc685SAndrii Nakryiko 	const struct btf_array *info = btf_array(t);
35122fc3fc0bSAndrii Nakryiko 	long h = btf_hash_common(t);
3513d5caef5bSAndrii Nakryiko 
3514d5caef5bSAndrii Nakryiko 	h = hash_combine(h, info->type);
3515d5caef5bSAndrii Nakryiko 	h = hash_combine(h, info->index_type);
3516d5caef5bSAndrii Nakryiko 	h = hash_combine(h, info->nelems);
3517d5caef5bSAndrii Nakryiko 	return h;
3518d5caef5bSAndrii Nakryiko }
3519d5caef5bSAndrii Nakryiko 
3520d5caef5bSAndrii Nakryiko /*
3521d5caef5bSAndrii Nakryiko  * Check exact equality of two ARRAYs, taking into account referenced
3522d5caef5bSAndrii Nakryiko  * type IDs, under assumption that they were already resolved to canonical
3523d5caef5bSAndrii Nakryiko  * type IDs and are not going to change.
3524d5caef5bSAndrii Nakryiko  * This function is called during reference types deduplication to compare
3525d5caef5bSAndrii Nakryiko  * ARRAY to potential canonical representative.
3526d5caef5bSAndrii Nakryiko  */
3527d5caef5bSAndrii Nakryiko static bool btf_equal_array(struct btf_type *t1, struct btf_type *t2)
3528d5caef5bSAndrii Nakryiko {
3529b03bc685SAndrii Nakryiko 	const struct btf_array *info1, *info2;
3530d5caef5bSAndrii Nakryiko 
3531d5caef5bSAndrii Nakryiko 	if (!btf_equal_common(t1, t2))
3532d5caef5bSAndrii Nakryiko 		return false;
3533d5caef5bSAndrii Nakryiko 
3534b03bc685SAndrii Nakryiko 	info1 = btf_array(t1);
3535b03bc685SAndrii Nakryiko 	info2 = btf_array(t2);
3536d5caef5bSAndrii Nakryiko 	return info1->type == info2->type &&
3537d5caef5bSAndrii Nakryiko 	       info1->index_type == info2->index_type &&
3538d5caef5bSAndrii Nakryiko 	       info1->nelems == info2->nelems;
3539d5caef5bSAndrii Nakryiko }
3540d5caef5bSAndrii Nakryiko 
3541d5caef5bSAndrii Nakryiko /*
3542d5caef5bSAndrii Nakryiko  * Check structural compatibility of two ARRAYs, ignoring referenced type
3543d5caef5bSAndrii Nakryiko  * IDs. This check is performed during type graph equivalence check and
3544d5caef5bSAndrii Nakryiko  * referenced types equivalence is checked separately.
3545d5caef5bSAndrii Nakryiko  */
3546d5caef5bSAndrii Nakryiko static bool btf_compat_array(struct btf_type *t1, struct btf_type *t2)
3547d5caef5bSAndrii Nakryiko {
3548d5caef5bSAndrii Nakryiko 	if (!btf_equal_common(t1, t2))
3549d5caef5bSAndrii Nakryiko 		return false;
3550d5caef5bSAndrii Nakryiko 
3551b03bc685SAndrii Nakryiko 	return btf_array(t1)->nelems == btf_array(t2)->nelems;
3552d5caef5bSAndrii Nakryiko }
3553d5caef5bSAndrii Nakryiko 
3554d5caef5bSAndrii Nakryiko /*
3555d5caef5bSAndrii Nakryiko  * Calculate type signature hash of FUNC_PROTO, including referenced type IDs,
3556d5caef5bSAndrii Nakryiko  * under assumption that they were already resolved to canonical type IDs and
3557d5caef5bSAndrii Nakryiko  * are not going to change.
3558d5caef5bSAndrii Nakryiko  */
35592fc3fc0bSAndrii Nakryiko static long btf_hash_fnproto(struct btf_type *t)
3560d5caef5bSAndrii Nakryiko {
3561b03bc685SAndrii Nakryiko 	const struct btf_param *member = btf_params(t);
3562b03bc685SAndrii Nakryiko 	__u16 vlen = btf_vlen(t);
35632fc3fc0bSAndrii Nakryiko 	long h = btf_hash_common(t);
3564d5caef5bSAndrii Nakryiko 	int i;
3565d5caef5bSAndrii Nakryiko 
3566d5caef5bSAndrii Nakryiko 	for (i = 0; i < vlen; i++) {
3567d5caef5bSAndrii Nakryiko 		h = hash_combine(h, member->name_off);
3568d5caef5bSAndrii Nakryiko 		h = hash_combine(h, member->type);
3569d5caef5bSAndrii Nakryiko 		member++;
3570d5caef5bSAndrii Nakryiko 	}
3571d5caef5bSAndrii Nakryiko 	return h;
3572d5caef5bSAndrii Nakryiko }
3573d5caef5bSAndrii Nakryiko 
3574d5caef5bSAndrii Nakryiko /*
3575d5caef5bSAndrii Nakryiko  * Check exact equality of two FUNC_PROTOs, taking into account referenced
3576d5caef5bSAndrii Nakryiko  * type IDs, under assumption that they were already resolved to canonical
3577d5caef5bSAndrii Nakryiko  * type IDs and are not going to change.
3578d5caef5bSAndrii Nakryiko  * This function is called during reference types deduplication to compare
3579d5caef5bSAndrii Nakryiko  * FUNC_PROTO to potential canonical representative.
3580d5caef5bSAndrii Nakryiko  */
35812fc3fc0bSAndrii Nakryiko static bool btf_equal_fnproto(struct btf_type *t1, struct btf_type *t2)
3582d5caef5bSAndrii Nakryiko {
3583b03bc685SAndrii Nakryiko 	const struct btf_param *m1, *m2;
3584d5caef5bSAndrii Nakryiko 	__u16 vlen;
3585d5caef5bSAndrii Nakryiko 	int i;
3586d5caef5bSAndrii Nakryiko 
3587d5caef5bSAndrii Nakryiko 	if (!btf_equal_common(t1, t2))
3588d5caef5bSAndrii Nakryiko 		return false;
3589d5caef5bSAndrii Nakryiko 
3590b03bc685SAndrii Nakryiko 	vlen = btf_vlen(t1);
3591b03bc685SAndrii Nakryiko 	m1 = btf_params(t1);
3592b03bc685SAndrii Nakryiko 	m2 = btf_params(t2);
3593d5caef5bSAndrii Nakryiko 	for (i = 0; i < vlen; i++) {
3594d5caef5bSAndrii Nakryiko 		if (m1->name_off != m2->name_off || m1->type != m2->type)
3595d5caef5bSAndrii Nakryiko 			return false;
3596d5caef5bSAndrii Nakryiko 		m1++;
3597d5caef5bSAndrii Nakryiko 		m2++;
3598d5caef5bSAndrii Nakryiko 	}
3599d5caef5bSAndrii Nakryiko 	return true;
3600d5caef5bSAndrii Nakryiko }
3601d5caef5bSAndrii Nakryiko 
3602d5caef5bSAndrii Nakryiko /*
3603d5caef5bSAndrii Nakryiko  * Check structural compatibility of two FUNC_PROTOs, ignoring referenced type
3604d5caef5bSAndrii Nakryiko  * IDs. This check is performed during type graph equivalence check and
3605d5caef5bSAndrii Nakryiko  * referenced types equivalence is checked separately.
3606d5caef5bSAndrii Nakryiko  */
36072fc3fc0bSAndrii Nakryiko static bool btf_compat_fnproto(struct btf_type *t1, struct btf_type *t2)
3608d5caef5bSAndrii Nakryiko {
3609b03bc685SAndrii Nakryiko 	const struct btf_param *m1, *m2;
3610d5caef5bSAndrii Nakryiko 	__u16 vlen;
3611d5caef5bSAndrii Nakryiko 	int i;
3612d5caef5bSAndrii Nakryiko 
3613d5caef5bSAndrii Nakryiko 	/* skip return type ID */
3614d5caef5bSAndrii Nakryiko 	if (t1->name_off != t2->name_off || t1->info != t2->info)
3615d5caef5bSAndrii Nakryiko 		return false;
3616d5caef5bSAndrii Nakryiko 
3617b03bc685SAndrii Nakryiko 	vlen = btf_vlen(t1);
3618b03bc685SAndrii Nakryiko 	m1 = btf_params(t1);
3619b03bc685SAndrii Nakryiko 	m2 = btf_params(t2);
3620d5caef5bSAndrii Nakryiko 	for (i = 0; i < vlen; i++) {
3621d5caef5bSAndrii Nakryiko 		if (m1->name_off != m2->name_off)
3622d5caef5bSAndrii Nakryiko 			return false;
3623d5caef5bSAndrii Nakryiko 		m1++;
3624d5caef5bSAndrii Nakryiko 		m2++;
3625d5caef5bSAndrii Nakryiko 	}
3626d5caef5bSAndrii Nakryiko 	return true;
3627d5caef5bSAndrii Nakryiko }
3628d5caef5bSAndrii Nakryiko 
3629f86524efSAndrii Nakryiko /* Prepare split BTF for deduplication by calculating hashes of base BTF's
3630f86524efSAndrii Nakryiko  * types and initializing the rest of the state (canonical type mapping) for
3631f86524efSAndrii Nakryiko  * the fixed base BTF part.
3632f86524efSAndrii Nakryiko  */
3633f86524efSAndrii Nakryiko static int btf_dedup_prep(struct btf_dedup *d)
3634f86524efSAndrii Nakryiko {
3635f86524efSAndrii Nakryiko 	struct btf_type *t;
3636f86524efSAndrii Nakryiko 	int type_id;
3637f86524efSAndrii Nakryiko 	long h;
3638f86524efSAndrii Nakryiko 
3639f86524efSAndrii Nakryiko 	if (!d->btf->base_btf)
3640f86524efSAndrii Nakryiko 		return 0;
3641f86524efSAndrii Nakryiko 
3642f86524efSAndrii Nakryiko 	for (type_id = 1; type_id < d->btf->start_id; type_id++) {
3643f86524efSAndrii Nakryiko 		t = btf_type_by_id(d->btf, type_id);
3644f86524efSAndrii Nakryiko 
3645f86524efSAndrii Nakryiko 		/* all base BTF types are self-canonical by definition */
3646f86524efSAndrii Nakryiko 		d->map[type_id] = type_id;
3647f86524efSAndrii Nakryiko 
3648f86524efSAndrii Nakryiko 		switch (btf_kind(t)) {
3649f86524efSAndrii Nakryiko 		case BTF_KIND_VAR:
3650f86524efSAndrii Nakryiko 		case BTF_KIND_DATASEC:
3651f86524efSAndrii Nakryiko 			/* VAR and DATASEC are never hash/deduplicated */
3652f86524efSAndrii Nakryiko 			continue;
3653f86524efSAndrii Nakryiko 		case BTF_KIND_CONST:
3654f86524efSAndrii Nakryiko 		case BTF_KIND_VOLATILE:
3655f86524efSAndrii Nakryiko 		case BTF_KIND_RESTRICT:
3656f86524efSAndrii Nakryiko 		case BTF_KIND_PTR:
3657f86524efSAndrii Nakryiko 		case BTF_KIND_FWD:
3658f86524efSAndrii Nakryiko 		case BTF_KIND_TYPEDEF:
3659f86524efSAndrii Nakryiko 		case BTF_KIND_FUNC:
366022541a9eSIlya Leoshkevich 		case BTF_KIND_FLOAT:
3661*2dc1e488SYonghong Song 		case BTF_KIND_TYPE_TAG:
3662f86524efSAndrii Nakryiko 			h = btf_hash_common(t);
3663f86524efSAndrii Nakryiko 			break;
3664f86524efSAndrii Nakryiko 		case BTF_KIND_INT:
3665223f903eSYonghong Song 		case BTF_KIND_DECL_TAG:
3666223f903eSYonghong Song 			h = btf_hash_int_decl_tag(t);
3667f86524efSAndrii Nakryiko 			break;
3668f86524efSAndrii Nakryiko 		case BTF_KIND_ENUM:
3669f86524efSAndrii Nakryiko 			h = btf_hash_enum(t);
3670f86524efSAndrii Nakryiko 			break;
3671f86524efSAndrii Nakryiko 		case BTF_KIND_STRUCT:
3672f86524efSAndrii Nakryiko 		case BTF_KIND_UNION:
3673f86524efSAndrii Nakryiko 			h = btf_hash_struct(t);
3674f86524efSAndrii Nakryiko 			break;
3675f86524efSAndrii Nakryiko 		case BTF_KIND_ARRAY:
3676f86524efSAndrii Nakryiko 			h = btf_hash_array(t);
3677f86524efSAndrii Nakryiko 			break;
3678f86524efSAndrii Nakryiko 		case BTF_KIND_FUNC_PROTO:
3679f86524efSAndrii Nakryiko 			h = btf_hash_fnproto(t);
3680f86524efSAndrii Nakryiko 			break;
3681f86524efSAndrii Nakryiko 		default:
3682f86524efSAndrii Nakryiko 			pr_debug("unknown kind %d for type [%d]\n", btf_kind(t), type_id);
3683f86524efSAndrii Nakryiko 			return -EINVAL;
3684f86524efSAndrii Nakryiko 		}
3685f86524efSAndrii Nakryiko 		if (btf_dedup_table_add(d, h, type_id))
3686f86524efSAndrii Nakryiko 			return -ENOMEM;
3687f86524efSAndrii Nakryiko 	}
3688f86524efSAndrii Nakryiko 
3689f86524efSAndrii Nakryiko 	return 0;
3690f86524efSAndrii Nakryiko }
3691f86524efSAndrii Nakryiko 
3692d5caef5bSAndrii Nakryiko /*
3693d5caef5bSAndrii Nakryiko  * Deduplicate primitive types, that can't reference other types, by calculating
3694d5caef5bSAndrii Nakryiko  * their type signature hash and comparing them with any possible canonical
3695d5caef5bSAndrii Nakryiko  * candidate. If no canonical candidate matches, type itself is marked as
3696d5caef5bSAndrii Nakryiko  * canonical and is added into `btf_dedup->dedup_table` as another candidate.
3697d5caef5bSAndrii Nakryiko  */
3698d5caef5bSAndrii Nakryiko static int btf_dedup_prim_type(struct btf_dedup *d, __u32 type_id)
3699d5caef5bSAndrii Nakryiko {
3700740e69c3SAndrii Nakryiko 	struct btf_type *t = btf_type_by_id(d->btf, type_id);
37012fc3fc0bSAndrii Nakryiko 	struct hashmap_entry *hash_entry;
3702d5caef5bSAndrii Nakryiko 	struct btf_type *cand;
3703d5caef5bSAndrii Nakryiko 	/* if we don't find equivalent type, then we are canonical */
3704d5caef5bSAndrii Nakryiko 	__u32 new_id = type_id;
37052fc3fc0bSAndrii Nakryiko 	__u32 cand_id;
37062fc3fc0bSAndrii Nakryiko 	long h;
3707d5caef5bSAndrii Nakryiko 
3708b03bc685SAndrii Nakryiko 	switch (btf_kind(t)) {
3709d5caef5bSAndrii Nakryiko 	case BTF_KIND_CONST:
3710d5caef5bSAndrii Nakryiko 	case BTF_KIND_VOLATILE:
3711d5caef5bSAndrii Nakryiko 	case BTF_KIND_RESTRICT:
3712d5caef5bSAndrii Nakryiko 	case BTF_KIND_PTR:
3713d5caef5bSAndrii Nakryiko 	case BTF_KIND_TYPEDEF:
3714d5caef5bSAndrii Nakryiko 	case BTF_KIND_ARRAY:
3715d5caef5bSAndrii Nakryiko 	case BTF_KIND_STRUCT:
3716d5caef5bSAndrii Nakryiko 	case BTF_KIND_UNION:
3717d5caef5bSAndrii Nakryiko 	case BTF_KIND_FUNC:
3718d5caef5bSAndrii Nakryiko 	case BTF_KIND_FUNC_PROTO:
3719189cf5a4SAndrii Nakryiko 	case BTF_KIND_VAR:
3720189cf5a4SAndrii Nakryiko 	case BTF_KIND_DATASEC:
3721223f903eSYonghong Song 	case BTF_KIND_DECL_TAG:
3722*2dc1e488SYonghong Song 	case BTF_KIND_TYPE_TAG:
3723d5caef5bSAndrii Nakryiko 		return 0;
3724d5caef5bSAndrii Nakryiko 
3725d5caef5bSAndrii Nakryiko 	case BTF_KIND_INT:
3726223f903eSYonghong Song 		h = btf_hash_int_decl_tag(t);
37272fc3fc0bSAndrii Nakryiko 		for_each_dedup_cand(d, hash_entry, h) {
37282fc3fc0bSAndrii Nakryiko 			cand_id = (__u32)(long)hash_entry->value;
3729740e69c3SAndrii Nakryiko 			cand = btf_type_by_id(d->btf, cand_id);
373030025e8bSYonghong Song 			if (btf_equal_int_tag(t, cand)) {
37312fc3fc0bSAndrii Nakryiko 				new_id = cand_id;
3732d5caef5bSAndrii Nakryiko 				break;
3733d5caef5bSAndrii Nakryiko 			}
3734d5caef5bSAndrii Nakryiko 		}
3735d5caef5bSAndrii Nakryiko 		break;
3736d5caef5bSAndrii Nakryiko 
3737d5caef5bSAndrii Nakryiko 	case BTF_KIND_ENUM:
3738d5caef5bSAndrii Nakryiko 		h = btf_hash_enum(t);
37392fc3fc0bSAndrii Nakryiko 		for_each_dedup_cand(d, hash_entry, h) {
37402fc3fc0bSAndrii Nakryiko 			cand_id = (__u32)(long)hash_entry->value;
3741740e69c3SAndrii Nakryiko 			cand = btf_type_by_id(d->btf, cand_id);
3742d5caef5bSAndrii Nakryiko 			if (btf_equal_enum(t, cand)) {
37432fc3fc0bSAndrii Nakryiko 				new_id = cand_id;
3744d5caef5bSAndrii Nakryiko 				break;
3745d5caef5bSAndrii Nakryiko 			}
37469768095bSAndrii Nakryiko 			if (btf_compat_enum(t, cand)) {
37479768095bSAndrii Nakryiko 				if (btf_is_enum_fwd(t)) {
37489768095bSAndrii Nakryiko 					/* resolve fwd to full enum */
37492fc3fc0bSAndrii Nakryiko 					new_id = cand_id;
37509768095bSAndrii Nakryiko 					break;
37519768095bSAndrii Nakryiko 				}
37529768095bSAndrii Nakryiko 				/* resolve canonical enum fwd to full enum */
37532fc3fc0bSAndrii Nakryiko 				d->map[cand_id] = type_id;
37549768095bSAndrii Nakryiko 			}
3755d5caef5bSAndrii Nakryiko 		}
3756d5caef5bSAndrii Nakryiko 		break;
3757d5caef5bSAndrii Nakryiko 
3758d5caef5bSAndrii Nakryiko 	case BTF_KIND_FWD:
375922541a9eSIlya Leoshkevich 	case BTF_KIND_FLOAT:
3760d5caef5bSAndrii Nakryiko 		h = btf_hash_common(t);
37612fc3fc0bSAndrii Nakryiko 		for_each_dedup_cand(d, hash_entry, h) {
37622fc3fc0bSAndrii Nakryiko 			cand_id = (__u32)(long)hash_entry->value;
3763740e69c3SAndrii Nakryiko 			cand = btf_type_by_id(d->btf, cand_id);
3764d5caef5bSAndrii Nakryiko 			if (btf_equal_common(t, cand)) {
37652fc3fc0bSAndrii Nakryiko 				new_id = cand_id;
3766d5caef5bSAndrii Nakryiko 				break;
3767d5caef5bSAndrii Nakryiko 			}
3768d5caef5bSAndrii Nakryiko 		}
3769d5caef5bSAndrii Nakryiko 		break;
3770d5caef5bSAndrii Nakryiko 
3771d5caef5bSAndrii Nakryiko 	default:
3772d5caef5bSAndrii Nakryiko 		return -EINVAL;
3773d5caef5bSAndrii Nakryiko 	}
3774d5caef5bSAndrii Nakryiko 
3775d5caef5bSAndrii Nakryiko 	d->map[type_id] = new_id;
3776d5caef5bSAndrii Nakryiko 	if (type_id == new_id && btf_dedup_table_add(d, h, type_id))
3777d5caef5bSAndrii Nakryiko 		return -ENOMEM;
3778d5caef5bSAndrii Nakryiko 
3779d5caef5bSAndrii Nakryiko 	return 0;
3780d5caef5bSAndrii Nakryiko }
3781d5caef5bSAndrii Nakryiko 
3782d5caef5bSAndrii Nakryiko static int btf_dedup_prim_types(struct btf_dedup *d)
3783d5caef5bSAndrii Nakryiko {
3784d5caef5bSAndrii Nakryiko 	int i, err;
3785d5caef5bSAndrii Nakryiko 
3786f86524efSAndrii Nakryiko 	for (i = 0; i < d->btf->nr_types; i++) {
3787f86524efSAndrii Nakryiko 		err = btf_dedup_prim_type(d, d->btf->start_id + i);
3788d5caef5bSAndrii Nakryiko 		if (err)
3789d5caef5bSAndrii Nakryiko 			return err;
3790d5caef5bSAndrii Nakryiko 	}
3791d5caef5bSAndrii Nakryiko 	return 0;
3792d5caef5bSAndrii Nakryiko }
3793d5caef5bSAndrii Nakryiko 
3794d5caef5bSAndrii Nakryiko /*
3795d5caef5bSAndrii Nakryiko  * Check whether type is already mapped into canonical one (could be to itself).
3796d5caef5bSAndrii Nakryiko  */
3797d5caef5bSAndrii Nakryiko static inline bool is_type_mapped(struct btf_dedup *d, uint32_t type_id)
3798d5caef5bSAndrii Nakryiko {
37995aab392cSAndrii Nakryiko 	return d->map[type_id] <= BTF_MAX_NR_TYPES;
3800d5caef5bSAndrii Nakryiko }
3801d5caef5bSAndrii Nakryiko 
3802d5caef5bSAndrii Nakryiko /*
3803d5caef5bSAndrii Nakryiko  * Resolve type ID into its canonical type ID, if any; otherwise return original
3804d5caef5bSAndrii Nakryiko  * type ID. If type is FWD and is resolved into STRUCT/UNION already, follow
3805d5caef5bSAndrii Nakryiko  * STRUCT/UNION link and resolve it into canonical type ID as well.
3806d5caef5bSAndrii Nakryiko  */
3807d5caef5bSAndrii Nakryiko static inline __u32 resolve_type_id(struct btf_dedup *d, __u32 type_id)
3808d5caef5bSAndrii Nakryiko {
3809d5caef5bSAndrii Nakryiko 	while (is_type_mapped(d, type_id) && d->map[type_id] != type_id)
3810d5caef5bSAndrii Nakryiko 		type_id = d->map[type_id];
3811d5caef5bSAndrii Nakryiko 	return type_id;
3812d5caef5bSAndrii Nakryiko }
3813d5caef5bSAndrii Nakryiko 
3814d5caef5bSAndrii Nakryiko /*
3815d5caef5bSAndrii Nakryiko  * Resolve FWD to underlying STRUCT/UNION, if any; otherwise return original
3816d5caef5bSAndrii Nakryiko  * type ID.
3817d5caef5bSAndrii Nakryiko  */
3818d5caef5bSAndrii Nakryiko static uint32_t resolve_fwd_id(struct btf_dedup *d, uint32_t type_id)
3819d5caef5bSAndrii Nakryiko {
3820d5caef5bSAndrii Nakryiko 	__u32 orig_type_id = type_id;
3821d5caef5bSAndrii Nakryiko 
3822740e69c3SAndrii Nakryiko 	if (!btf_is_fwd(btf__type_by_id(d->btf, type_id)))
3823d5caef5bSAndrii Nakryiko 		return type_id;
3824d5caef5bSAndrii Nakryiko 
3825d5caef5bSAndrii Nakryiko 	while (is_type_mapped(d, type_id) && d->map[type_id] != type_id)
3826d5caef5bSAndrii Nakryiko 		type_id = d->map[type_id];
3827d5caef5bSAndrii Nakryiko 
3828740e69c3SAndrii Nakryiko 	if (!btf_is_fwd(btf__type_by_id(d->btf, type_id)))
3829d5caef5bSAndrii Nakryiko 		return type_id;
3830d5caef5bSAndrii Nakryiko 
3831d5caef5bSAndrii Nakryiko 	return orig_type_id;
3832d5caef5bSAndrii Nakryiko }
3833d5caef5bSAndrii Nakryiko 
3834d5caef5bSAndrii Nakryiko 
3835d5caef5bSAndrii Nakryiko static inline __u16 btf_fwd_kind(struct btf_type *t)
3836d5caef5bSAndrii Nakryiko {
3837b03bc685SAndrii Nakryiko 	return btf_kflag(t) ? BTF_KIND_UNION : BTF_KIND_STRUCT;
3838d5caef5bSAndrii Nakryiko }
3839d5caef5bSAndrii Nakryiko 
38406b6e6b1dSAndrii Nakryiko /* Check if given two types are identical ARRAY definitions */
38416b6e6b1dSAndrii Nakryiko static int btf_dedup_identical_arrays(struct btf_dedup *d, __u32 id1, __u32 id2)
38426b6e6b1dSAndrii Nakryiko {
38436b6e6b1dSAndrii Nakryiko 	struct btf_type *t1, *t2;
38446b6e6b1dSAndrii Nakryiko 
38456b6e6b1dSAndrii Nakryiko 	t1 = btf_type_by_id(d->btf, id1);
38466b6e6b1dSAndrii Nakryiko 	t2 = btf_type_by_id(d->btf, id2);
38476b6e6b1dSAndrii Nakryiko 	if (!btf_is_array(t1) || !btf_is_array(t2))
38486b6e6b1dSAndrii Nakryiko 		return 0;
38496b6e6b1dSAndrii Nakryiko 
38506b6e6b1dSAndrii Nakryiko 	return btf_equal_array(t1, t2);
38516b6e6b1dSAndrii Nakryiko }
38526b6e6b1dSAndrii Nakryiko 
3853d5caef5bSAndrii Nakryiko /*
3854d5caef5bSAndrii Nakryiko  * Check equivalence of BTF type graph formed by candidate struct/union (we'll
3855d5caef5bSAndrii Nakryiko  * call it "candidate graph" in this description for brevity) to a type graph
3856d5caef5bSAndrii Nakryiko  * formed by (potential) canonical struct/union ("canonical graph" for brevity
3857d5caef5bSAndrii Nakryiko  * here, though keep in mind that not all types in canonical graph are
3858d5caef5bSAndrii Nakryiko  * necessarily canonical representatives themselves, some of them might be
3859d5caef5bSAndrii Nakryiko  * duplicates or its uniqueness might not have been established yet).
3860d5caef5bSAndrii Nakryiko  * Returns:
3861d5caef5bSAndrii Nakryiko  *  - >0, if type graphs are equivalent;
3862d5caef5bSAndrii Nakryiko  *  -  0, if not equivalent;
3863d5caef5bSAndrii Nakryiko  *  - <0, on error.
3864d5caef5bSAndrii Nakryiko  *
3865d5caef5bSAndrii Nakryiko  * Algorithm performs side-by-side DFS traversal of both type graphs and checks
3866d5caef5bSAndrii Nakryiko  * equivalence of BTF types at each step. If at any point BTF types in candidate
3867d5caef5bSAndrii Nakryiko  * and canonical graphs are not compatible structurally, whole graphs are
3868d5caef5bSAndrii Nakryiko  * incompatible. If types are structurally equivalent (i.e., all information
3869d5caef5bSAndrii Nakryiko  * except referenced type IDs is exactly the same), a mapping from `canon_id` to
3870d5caef5bSAndrii Nakryiko  * a `cand_id` is recored in hypothetical mapping (`btf_dedup->hypot_map`).
3871d5caef5bSAndrii Nakryiko  * If a type references other types, then those referenced types are checked
3872d5caef5bSAndrii Nakryiko  * for equivalence recursively.
3873d5caef5bSAndrii Nakryiko  *
3874d5caef5bSAndrii Nakryiko  * During DFS traversal, if we find that for current `canon_id` type we
3875d5caef5bSAndrii Nakryiko  * already have some mapping in hypothetical map, we check for two possible
3876d5caef5bSAndrii Nakryiko  * situations:
3877d5caef5bSAndrii Nakryiko  *   - `canon_id` is mapped to exactly the same type as `cand_id`. This will
3878d5caef5bSAndrii Nakryiko  *     happen when type graphs have cycles. In this case we assume those two
3879d5caef5bSAndrii Nakryiko  *     types are equivalent.
3880d5caef5bSAndrii Nakryiko  *   - `canon_id` is mapped to different type. This is contradiction in our
3881d5caef5bSAndrii Nakryiko  *     hypothetical mapping, because same graph in canonical graph corresponds
3882d5caef5bSAndrii Nakryiko  *     to two different types in candidate graph, which for equivalent type
3883d5caef5bSAndrii Nakryiko  *     graphs shouldn't happen. This condition terminates equivalence check
3884d5caef5bSAndrii Nakryiko  *     with negative result.
3885d5caef5bSAndrii Nakryiko  *
3886d5caef5bSAndrii Nakryiko  * If type graphs traversal exhausts types to check and find no contradiction,
3887d5caef5bSAndrii Nakryiko  * then type graphs are equivalent.
3888d5caef5bSAndrii Nakryiko  *
3889d5caef5bSAndrii Nakryiko  * When checking types for equivalence, there is one special case: FWD types.
3890d5caef5bSAndrii Nakryiko  * If FWD type resolution is allowed and one of the types (either from canonical
3891d5caef5bSAndrii Nakryiko  * or candidate graph) is FWD and other is STRUCT/UNION (depending on FWD's kind
3892d5caef5bSAndrii Nakryiko  * flag) and their names match, hypothetical mapping is updated to point from
3893d5caef5bSAndrii Nakryiko  * FWD to STRUCT/UNION. If graphs will be determined as equivalent successfully,
3894d5caef5bSAndrii Nakryiko  * this mapping will be used to record FWD -> STRUCT/UNION mapping permanently.
3895d5caef5bSAndrii Nakryiko  *
3896d5caef5bSAndrii Nakryiko  * Technically, this could lead to incorrect FWD to STRUCT/UNION resolution,
3897d5caef5bSAndrii Nakryiko  * if there are two exactly named (or anonymous) structs/unions that are
3898d5caef5bSAndrii Nakryiko  * compatible structurally, one of which has FWD field, while other is concrete
3899d5caef5bSAndrii Nakryiko  * STRUCT/UNION, but according to C sources they are different structs/unions
3900d5caef5bSAndrii Nakryiko  * that are referencing different types with the same name. This is extremely
3901d5caef5bSAndrii Nakryiko  * unlikely to happen, but btf_dedup API allows to disable FWD resolution if
3902d5caef5bSAndrii Nakryiko  * this logic is causing problems.
3903d5caef5bSAndrii Nakryiko  *
3904d5caef5bSAndrii Nakryiko  * Doing FWD resolution means that both candidate and/or canonical graphs can
3905d5caef5bSAndrii Nakryiko  * consists of portions of the graph that come from multiple compilation units.
3906d5caef5bSAndrii Nakryiko  * This is due to the fact that types within single compilation unit are always
3907d5caef5bSAndrii Nakryiko  * deduplicated and FWDs are already resolved, if referenced struct/union
3908d5caef5bSAndrii Nakryiko  * definiton is available. So, if we had unresolved FWD and found corresponding
3909d5caef5bSAndrii Nakryiko  * STRUCT/UNION, they will be from different compilation units. This
3910d5caef5bSAndrii Nakryiko  * consequently means that when we "link" FWD to corresponding STRUCT/UNION,
3911d5caef5bSAndrii Nakryiko  * type graph will likely have at least two different BTF types that describe
3912d5caef5bSAndrii Nakryiko  * same type (e.g., most probably there will be two different BTF types for the
3913d5caef5bSAndrii Nakryiko  * same 'int' primitive type) and could even have "overlapping" parts of type
3914d5caef5bSAndrii Nakryiko  * graph that describe same subset of types.
3915d5caef5bSAndrii Nakryiko  *
3916d5caef5bSAndrii Nakryiko  * This in turn means that our assumption that each type in canonical graph
3917d5caef5bSAndrii Nakryiko  * must correspond to exactly one type in candidate graph might not hold
3918d5caef5bSAndrii Nakryiko  * anymore and will make it harder to detect contradictions using hypothetical
3919d5caef5bSAndrii Nakryiko  * map. To handle this problem, we allow to follow FWD -> STRUCT/UNION
3920d5caef5bSAndrii Nakryiko  * resolution only in canonical graph. FWDs in candidate graphs are never
3921d5caef5bSAndrii Nakryiko  * resolved. To see why it's OK, let's check all possible situations w.r.t. FWDs
3922d5caef5bSAndrii Nakryiko  * that can occur:
3923d5caef5bSAndrii Nakryiko  *   - Both types in canonical and candidate graphs are FWDs. If they are
3924d5caef5bSAndrii Nakryiko  *     structurally equivalent, then they can either be both resolved to the
3925d5caef5bSAndrii Nakryiko  *     same STRUCT/UNION or not resolved at all. In both cases they are
3926d5caef5bSAndrii Nakryiko  *     equivalent and there is no need to resolve FWD on candidate side.
3927d5caef5bSAndrii Nakryiko  *   - Both types in canonical and candidate graphs are concrete STRUCT/UNION,
3928d5caef5bSAndrii Nakryiko  *     so nothing to resolve as well, algorithm will check equivalence anyway.
3929d5caef5bSAndrii Nakryiko  *   - Type in canonical graph is FWD, while type in candidate is concrete
3930d5caef5bSAndrii Nakryiko  *     STRUCT/UNION. In this case candidate graph comes from single compilation
3931d5caef5bSAndrii Nakryiko  *     unit, so there is exactly one BTF type for each unique C type. After
3932d5caef5bSAndrii Nakryiko  *     resolving FWD into STRUCT/UNION, there might be more than one BTF type
3933d5caef5bSAndrii Nakryiko  *     in canonical graph mapping to single BTF type in candidate graph, but
3934d5caef5bSAndrii Nakryiko  *     because hypothetical mapping maps from canonical to candidate types, it's
3935d5caef5bSAndrii Nakryiko  *     alright, and we still maintain the property of having single `canon_id`
3936d5caef5bSAndrii Nakryiko  *     mapping to single `cand_id` (there could be two different `canon_id`
3937d5caef5bSAndrii Nakryiko  *     mapped to the same `cand_id`, but it's not contradictory).
3938d5caef5bSAndrii Nakryiko  *   - Type in canonical graph is concrete STRUCT/UNION, while type in candidate
3939d5caef5bSAndrii Nakryiko  *     graph is FWD. In this case we are just going to check compatibility of
3940d5caef5bSAndrii Nakryiko  *     STRUCT/UNION and corresponding FWD, and if they are compatible, we'll
3941d5caef5bSAndrii Nakryiko  *     assume that whatever STRUCT/UNION FWD resolves to must be equivalent to
3942d5caef5bSAndrii Nakryiko  *     a concrete STRUCT/UNION from canonical graph. If the rest of type graphs
3943d5caef5bSAndrii Nakryiko  *     turn out equivalent, we'll re-resolve FWD to concrete STRUCT/UNION from
3944d5caef5bSAndrii Nakryiko  *     canonical graph.
3945d5caef5bSAndrii Nakryiko  */
3946d5caef5bSAndrii Nakryiko static int btf_dedup_is_equiv(struct btf_dedup *d, __u32 cand_id,
3947d5caef5bSAndrii Nakryiko 			      __u32 canon_id)
3948d5caef5bSAndrii Nakryiko {
3949d5caef5bSAndrii Nakryiko 	struct btf_type *cand_type;
3950d5caef5bSAndrii Nakryiko 	struct btf_type *canon_type;
3951d5caef5bSAndrii Nakryiko 	__u32 hypot_type_id;
3952d5caef5bSAndrii Nakryiko 	__u16 cand_kind;
3953d5caef5bSAndrii Nakryiko 	__u16 canon_kind;
3954d5caef5bSAndrii Nakryiko 	int i, eq;
3955d5caef5bSAndrii Nakryiko 
3956d5caef5bSAndrii Nakryiko 	/* if both resolve to the same canonical, they must be equivalent */
3957d5caef5bSAndrii Nakryiko 	if (resolve_type_id(d, cand_id) == resolve_type_id(d, canon_id))
3958d5caef5bSAndrii Nakryiko 		return 1;
3959d5caef5bSAndrii Nakryiko 
3960d5caef5bSAndrii Nakryiko 	canon_id = resolve_fwd_id(d, canon_id);
3961d5caef5bSAndrii Nakryiko 
3962d5caef5bSAndrii Nakryiko 	hypot_type_id = d->hypot_map[canon_id];
39636b6e6b1dSAndrii Nakryiko 	if (hypot_type_id <= BTF_MAX_NR_TYPES) {
39646b6e6b1dSAndrii Nakryiko 		/* In some cases compiler will generate different DWARF types
39656b6e6b1dSAndrii Nakryiko 		 * for *identical* array type definitions and use them for
39666b6e6b1dSAndrii Nakryiko 		 * different fields within the *same* struct. This breaks type
39676b6e6b1dSAndrii Nakryiko 		 * equivalence check, which makes an assumption that candidate
39686b6e6b1dSAndrii Nakryiko 		 * types sub-graph has a consistent and deduped-by-compiler
39696b6e6b1dSAndrii Nakryiko 		 * types within a single CU. So work around that by explicitly
39706b6e6b1dSAndrii Nakryiko 		 * allowing identical array types here.
39716b6e6b1dSAndrii Nakryiko 		 */
39726b6e6b1dSAndrii Nakryiko 		return hypot_type_id == cand_id ||
39736b6e6b1dSAndrii Nakryiko 		       btf_dedup_identical_arrays(d, hypot_type_id, cand_id);
39746b6e6b1dSAndrii Nakryiko 	}
3975d5caef5bSAndrii Nakryiko 
3976d5caef5bSAndrii Nakryiko 	if (btf_dedup_hypot_map_add(d, canon_id, cand_id))
3977d5caef5bSAndrii Nakryiko 		return -ENOMEM;
3978d5caef5bSAndrii Nakryiko 
3979740e69c3SAndrii Nakryiko 	cand_type = btf_type_by_id(d->btf, cand_id);
3980740e69c3SAndrii Nakryiko 	canon_type = btf_type_by_id(d->btf, canon_id);
3981b03bc685SAndrii Nakryiko 	cand_kind = btf_kind(cand_type);
3982b03bc685SAndrii Nakryiko 	canon_kind = btf_kind(canon_type);
3983d5caef5bSAndrii Nakryiko 
3984d5caef5bSAndrii Nakryiko 	if (cand_type->name_off != canon_type->name_off)
3985d5caef5bSAndrii Nakryiko 		return 0;
3986d5caef5bSAndrii Nakryiko 
3987d5caef5bSAndrii Nakryiko 	/* FWD <--> STRUCT/UNION equivalence check, if enabled */
3988957d350aSAndrii Nakryiko 	if ((cand_kind == BTF_KIND_FWD || canon_kind == BTF_KIND_FWD)
3989d5caef5bSAndrii Nakryiko 	    && cand_kind != canon_kind) {
3990d5caef5bSAndrii Nakryiko 		__u16 real_kind;
3991d5caef5bSAndrii Nakryiko 		__u16 fwd_kind;
3992d5caef5bSAndrii Nakryiko 
3993d5caef5bSAndrii Nakryiko 		if (cand_kind == BTF_KIND_FWD) {
3994d5caef5bSAndrii Nakryiko 			real_kind = canon_kind;
3995d5caef5bSAndrii Nakryiko 			fwd_kind = btf_fwd_kind(cand_type);
3996d5caef5bSAndrii Nakryiko 		} else {
3997d5caef5bSAndrii Nakryiko 			real_kind = cand_kind;
3998d5caef5bSAndrii Nakryiko 			fwd_kind = btf_fwd_kind(canon_type);
3999f86524efSAndrii Nakryiko 			/* we'd need to resolve base FWD to STRUCT/UNION */
4000f86524efSAndrii Nakryiko 			if (fwd_kind == real_kind && canon_id < d->btf->start_id)
4001f86524efSAndrii Nakryiko 				d->hypot_adjust_canon = true;
4002d5caef5bSAndrii Nakryiko 		}
4003d5caef5bSAndrii Nakryiko 		return fwd_kind == real_kind;
4004d5caef5bSAndrii Nakryiko 	}
4005d5caef5bSAndrii Nakryiko 
40069ec71c1cSAndrii Nakryiko 	if (cand_kind != canon_kind)
40079ec71c1cSAndrii Nakryiko 		return 0;
40089ec71c1cSAndrii Nakryiko 
4009d5caef5bSAndrii Nakryiko 	switch (cand_kind) {
4010d5caef5bSAndrii Nakryiko 	case BTF_KIND_INT:
401130025e8bSYonghong Song 		return btf_equal_int_tag(cand_type, canon_type);
4012d5caef5bSAndrii Nakryiko 
4013d5caef5bSAndrii Nakryiko 	case BTF_KIND_ENUM:
40149768095bSAndrii Nakryiko 		return btf_compat_enum(cand_type, canon_type);
4015d5caef5bSAndrii Nakryiko 
4016d5caef5bSAndrii Nakryiko 	case BTF_KIND_FWD:
401722541a9eSIlya Leoshkevich 	case BTF_KIND_FLOAT:
4018d5caef5bSAndrii Nakryiko 		return btf_equal_common(cand_type, canon_type);
4019d5caef5bSAndrii Nakryiko 
4020d5caef5bSAndrii Nakryiko 	case BTF_KIND_CONST:
4021d5caef5bSAndrii Nakryiko 	case BTF_KIND_VOLATILE:
4022d5caef5bSAndrii Nakryiko 	case BTF_KIND_RESTRICT:
4023d5caef5bSAndrii Nakryiko 	case BTF_KIND_PTR:
4024d5caef5bSAndrii Nakryiko 	case BTF_KIND_TYPEDEF:
4025d5caef5bSAndrii Nakryiko 	case BTF_KIND_FUNC:
40269768095bSAndrii Nakryiko 		if (cand_type->info != canon_type->info)
40279768095bSAndrii Nakryiko 			return 0;
4028d5caef5bSAndrii Nakryiko 		return btf_dedup_is_equiv(d, cand_type->type, canon_type->type);
4029d5caef5bSAndrii Nakryiko 
4030d5caef5bSAndrii Nakryiko 	case BTF_KIND_ARRAY: {
4031b03bc685SAndrii Nakryiko 		const struct btf_array *cand_arr, *canon_arr;
4032d5caef5bSAndrii Nakryiko 
4033d5caef5bSAndrii Nakryiko 		if (!btf_compat_array(cand_type, canon_type))
4034d5caef5bSAndrii Nakryiko 			return 0;
4035b03bc685SAndrii Nakryiko 		cand_arr = btf_array(cand_type);
4036b03bc685SAndrii Nakryiko 		canon_arr = btf_array(canon_type);
4037f86524efSAndrii Nakryiko 		eq = btf_dedup_is_equiv(d, cand_arr->index_type, canon_arr->index_type);
4038d5caef5bSAndrii Nakryiko 		if (eq <= 0)
4039d5caef5bSAndrii Nakryiko 			return eq;
4040d5caef5bSAndrii Nakryiko 		return btf_dedup_is_equiv(d, cand_arr->type, canon_arr->type);
4041d5caef5bSAndrii Nakryiko 	}
4042d5caef5bSAndrii Nakryiko 
4043d5caef5bSAndrii Nakryiko 	case BTF_KIND_STRUCT:
4044d5caef5bSAndrii Nakryiko 	case BTF_KIND_UNION: {
4045b03bc685SAndrii Nakryiko 		const struct btf_member *cand_m, *canon_m;
4046d5caef5bSAndrii Nakryiko 		__u16 vlen;
4047d5caef5bSAndrii Nakryiko 
404891097fbeSAndrii Nakryiko 		if (!btf_shallow_equal_struct(cand_type, canon_type))
4049d5caef5bSAndrii Nakryiko 			return 0;
4050b03bc685SAndrii Nakryiko 		vlen = btf_vlen(cand_type);
4051b03bc685SAndrii Nakryiko 		cand_m = btf_members(cand_type);
4052b03bc685SAndrii Nakryiko 		canon_m = btf_members(canon_type);
4053d5caef5bSAndrii Nakryiko 		for (i = 0; i < vlen; i++) {
4054d5caef5bSAndrii Nakryiko 			eq = btf_dedup_is_equiv(d, cand_m->type, canon_m->type);
4055d5caef5bSAndrii Nakryiko 			if (eq <= 0)
4056d5caef5bSAndrii Nakryiko 				return eq;
4057d5caef5bSAndrii Nakryiko 			cand_m++;
4058d5caef5bSAndrii Nakryiko 			canon_m++;
4059d5caef5bSAndrii Nakryiko 		}
4060d5caef5bSAndrii Nakryiko 
4061d5caef5bSAndrii Nakryiko 		return 1;
4062d5caef5bSAndrii Nakryiko 	}
4063d5caef5bSAndrii Nakryiko 
4064d5caef5bSAndrii Nakryiko 	case BTF_KIND_FUNC_PROTO: {
4065b03bc685SAndrii Nakryiko 		const struct btf_param *cand_p, *canon_p;
4066d5caef5bSAndrii Nakryiko 		__u16 vlen;
4067d5caef5bSAndrii Nakryiko 
4068d5caef5bSAndrii Nakryiko 		if (!btf_compat_fnproto(cand_type, canon_type))
4069d5caef5bSAndrii Nakryiko 			return 0;
4070d5caef5bSAndrii Nakryiko 		eq = btf_dedup_is_equiv(d, cand_type->type, canon_type->type);
4071d5caef5bSAndrii Nakryiko 		if (eq <= 0)
4072d5caef5bSAndrii Nakryiko 			return eq;
4073b03bc685SAndrii Nakryiko 		vlen = btf_vlen(cand_type);
4074b03bc685SAndrii Nakryiko 		cand_p = btf_params(cand_type);
4075b03bc685SAndrii Nakryiko 		canon_p = btf_params(canon_type);
4076d5caef5bSAndrii Nakryiko 		for (i = 0; i < vlen; i++) {
4077d5caef5bSAndrii Nakryiko 			eq = btf_dedup_is_equiv(d, cand_p->type, canon_p->type);
4078d5caef5bSAndrii Nakryiko 			if (eq <= 0)
4079d5caef5bSAndrii Nakryiko 				return eq;
4080d5caef5bSAndrii Nakryiko 			cand_p++;
4081d5caef5bSAndrii Nakryiko 			canon_p++;
4082d5caef5bSAndrii Nakryiko 		}
4083d5caef5bSAndrii Nakryiko 		return 1;
4084d5caef5bSAndrii Nakryiko 	}
4085d5caef5bSAndrii Nakryiko 
4086d5caef5bSAndrii Nakryiko 	default:
4087d5caef5bSAndrii Nakryiko 		return -EINVAL;
4088d5caef5bSAndrii Nakryiko 	}
4089d5caef5bSAndrii Nakryiko 	return 0;
4090d5caef5bSAndrii Nakryiko }
4091d5caef5bSAndrii Nakryiko 
4092d5caef5bSAndrii Nakryiko /*
4093d5caef5bSAndrii Nakryiko  * Use hypothetical mapping, produced by successful type graph equivalence
4094d5caef5bSAndrii Nakryiko  * check, to augment existing struct/union canonical mapping, where possible.
4095d5caef5bSAndrii Nakryiko  *
4096d5caef5bSAndrii Nakryiko  * If BTF_KIND_FWD resolution is allowed, this mapping is also used to record
4097d5caef5bSAndrii Nakryiko  * FWD -> STRUCT/UNION correspondence as well. FWD resolution is bidirectional:
4098d5caef5bSAndrii Nakryiko  * it doesn't matter if FWD type was part of canonical graph or candidate one,
4099d5caef5bSAndrii Nakryiko  * we are recording the mapping anyway. As opposed to carefulness required
4100d5caef5bSAndrii Nakryiko  * for struct/union correspondence mapping (described below), for FWD resolution
4101d5caef5bSAndrii Nakryiko  * it's not important, as by the time that FWD type (reference type) will be
4102d5caef5bSAndrii Nakryiko  * deduplicated all structs/unions will be deduped already anyway.
4103d5caef5bSAndrii Nakryiko  *
4104d5caef5bSAndrii Nakryiko  * Recording STRUCT/UNION mapping is purely a performance optimization and is
4105d5caef5bSAndrii Nakryiko  * not required for correctness. It needs to be done carefully to ensure that
4106d5caef5bSAndrii Nakryiko  * struct/union from candidate's type graph is not mapped into corresponding
4107d5caef5bSAndrii Nakryiko  * struct/union from canonical type graph that itself hasn't been resolved into
4108d5caef5bSAndrii Nakryiko  * canonical representative. The only guarantee we have is that canonical
4109d5caef5bSAndrii Nakryiko  * struct/union was determined as canonical and that won't change. But any
4110d5caef5bSAndrii Nakryiko  * types referenced through that struct/union fields could have been not yet
4111d5caef5bSAndrii Nakryiko  * resolved, so in case like that it's too early to establish any kind of
4112d5caef5bSAndrii Nakryiko  * correspondence between structs/unions.
4113d5caef5bSAndrii Nakryiko  *
4114d5caef5bSAndrii Nakryiko  * No canonical correspondence is derived for primitive types (they are already
4115d5caef5bSAndrii Nakryiko  * deduplicated completely already anyway) or reference types (they rely on
4116d5caef5bSAndrii Nakryiko  * stability of struct/union canonical relationship for equivalence checks).
4117d5caef5bSAndrii Nakryiko  */
4118d5caef5bSAndrii Nakryiko static void btf_dedup_merge_hypot_map(struct btf_dedup *d)
4119d5caef5bSAndrii Nakryiko {
4120f86524efSAndrii Nakryiko 	__u32 canon_type_id, targ_type_id;
4121d5caef5bSAndrii Nakryiko 	__u16 t_kind, c_kind;
4122d5caef5bSAndrii Nakryiko 	__u32 t_id, c_id;
4123d5caef5bSAndrii Nakryiko 	int i;
4124d5caef5bSAndrii Nakryiko 
4125d5caef5bSAndrii Nakryiko 	for (i = 0; i < d->hypot_cnt; i++) {
4126f86524efSAndrii Nakryiko 		canon_type_id = d->hypot_list[i];
4127f86524efSAndrii Nakryiko 		targ_type_id = d->hypot_map[canon_type_id];
4128d5caef5bSAndrii Nakryiko 		t_id = resolve_type_id(d, targ_type_id);
4129f86524efSAndrii Nakryiko 		c_id = resolve_type_id(d, canon_type_id);
4130740e69c3SAndrii Nakryiko 		t_kind = btf_kind(btf__type_by_id(d->btf, t_id));
4131740e69c3SAndrii Nakryiko 		c_kind = btf_kind(btf__type_by_id(d->btf, c_id));
4132d5caef5bSAndrii Nakryiko 		/*
4133d5caef5bSAndrii Nakryiko 		 * Resolve FWD into STRUCT/UNION.
4134d5caef5bSAndrii Nakryiko 		 * It's ok to resolve FWD into STRUCT/UNION that's not yet
4135d5caef5bSAndrii Nakryiko 		 * mapped to canonical representative (as opposed to
4136d5caef5bSAndrii Nakryiko 		 * STRUCT/UNION <--> STRUCT/UNION mapping logic below), because
4137d5caef5bSAndrii Nakryiko 		 * eventually that struct is going to be mapped and all resolved
4138d5caef5bSAndrii Nakryiko 		 * FWDs will automatically resolve to correct canonical
4139d5caef5bSAndrii Nakryiko 		 * representative. This will happen before ref type deduping,
4140d5caef5bSAndrii Nakryiko 		 * which critically depends on stability of these mapping. This
4141d5caef5bSAndrii Nakryiko 		 * stability is not a requirement for STRUCT/UNION equivalence
4142d5caef5bSAndrii Nakryiko 		 * checks, though.
4143d5caef5bSAndrii Nakryiko 		 */
4144f86524efSAndrii Nakryiko 
4145f86524efSAndrii Nakryiko 		/* if it's the split BTF case, we still need to point base FWD
4146f86524efSAndrii Nakryiko 		 * to STRUCT/UNION in a split BTF, because FWDs from split BTF
4147f86524efSAndrii Nakryiko 		 * will be resolved against base FWD. If we don't point base
4148f86524efSAndrii Nakryiko 		 * canonical FWD to the resolved STRUCT/UNION, then all the
4149f86524efSAndrii Nakryiko 		 * FWDs in split BTF won't be correctly resolved to a proper
4150f86524efSAndrii Nakryiko 		 * STRUCT/UNION.
4151f86524efSAndrii Nakryiko 		 */
4152d5caef5bSAndrii Nakryiko 		if (t_kind != BTF_KIND_FWD && c_kind == BTF_KIND_FWD)
4153d5caef5bSAndrii Nakryiko 			d->map[c_id] = t_id;
4154f86524efSAndrii Nakryiko 
4155f86524efSAndrii Nakryiko 		/* if graph equivalence determined that we'd need to adjust
4156f86524efSAndrii Nakryiko 		 * base canonical types, then we need to only point base FWDs
4157f86524efSAndrii Nakryiko 		 * to STRUCTs/UNIONs and do no more modifications. For all
4158f86524efSAndrii Nakryiko 		 * other purposes the type graphs were not equivalent.
4159f86524efSAndrii Nakryiko 		 */
4160f86524efSAndrii Nakryiko 		if (d->hypot_adjust_canon)
4161f86524efSAndrii Nakryiko 			continue;
4162f86524efSAndrii Nakryiko 
4163f86524efSAndrii Nakryiko 		if (t_kind == BTF_KIND_FWD && c_kind != BTF_KIND_FWD)
4164d5caef5bSAndrii Nakryiko 			d->map[t_id] = c_id;
4165d5caef5bSAndrii Nakryiko 
4166d5caef5bSAndrii Nakryiko 		if ((t_kind == BTF_KIND_STRUCT || t_kind == BTF_KIND_UNION) &&
4167d5caef5bSAndrii Nakryiko 		    c_kind != BTF_KIND_FWD &&
4168d5caef5bSAndrii Nakryiko 		    is_type_mapped(d, c_id) &&
4169d5caef5bSAndrii Nakryiko 		    !is_type_mapped(d, t_id)) {
4170d5caef5bSAndrii Nakryiko 			/*
4171d5caef5bSAndrii Nakryiko 			 * as a perf optimization, we can map struct/union
4172d5caef5bSAndrii Nakryiko 			 * that's part of type graph we just verified for
4173d5caef5bSAndrii Nakryiko 			 * equivalence. We can do that for struct/union that has
4174d5caef5bSAndrii Nakryiko 			 * canonical representative only, though.
4175d5caef5bSAndrii Nakryiko 			 */
4176d5caef5bSAndrii Nakryiko 			d->map[t_id] = c_id;
4177d5caef5bSAndrii Nakryiko 		}
4178d5caef5bSAndrii Nakryiko 	}
4179d5caef5bSAndrii Nakryiko }
4180d5caef5bSAndrii Nakryiko 
4181d5caef5bSAndrii Nakryiko /*
4182d5caef5bSAndrii Nakryiko  * Deduplicate struct/union types.
4183d5caef5bSAndrii Nakryiko  *
4184d5caef5bSAndrii Nakryiko  * For each struct/union type its type signature hash is calculated, taking
4185d5caef5bSAndrii Nakryiko  * into account type's name, size, number, order and names of fields, but
4186d5caef5bSAndrii Nakryiko  * ignoring type ID's referenced from fields, because they might not be deduped
4187d5caef5bSAndrii Nakryiko  * completely until after reference types deduplication phase. This type hash
4188d5caef5bSAndrii Nakryiko  * is used to iterate over all potential canonical types, sharing same hash.
4189d5caef5bSAndrii Nakryiko  * For each canonical candidate we check whether type graphs that they form
4190d5caef5bSAndrii Nakryiko  * (through referenced types in fields and so on) are equivalent using algorithm
4191d5caef5bSAndrii Nakryiko  * implemented in `btf_dedup_is_equiv`. If such equivalence is found and
4192d5caef5bSAndrii Nakryiko  * BTF_KIND_FWD resolution is allowed, then hypothetical mapping
4193d5caef5bSAndrii Nakryiko  * (btf_dedup->hypot_map) produced by aforementioned type graph equivalence
4194d5caef5bSAndrii Nakryiko  * algorithm is used to record FWD -> STRUCT/UNION mapping. It's also used to
4195d5caef5bSAndrii Nakryiko  * potentially map other structs/unions to their canonical representatives,
4196d5caef5bSAndrii Nakryiko  * if such relationship hasn't yet been established. This speeds up algorithm
4197d5caef5bSAndrii Nakryiko  * by eliminating some of the duplicate work.
4198d5caef5bSAndrii Nakryiko  *
4199d5caef5bSAndrii Nakryiko  * If no matching canonical representative was found, struct/union is marked
4200d5caef5bSAndrii Nakryiko  * as canonical for itself and is added into btf_dedup->dedup_table hash map
4201d5caef5bSAndrii Nakryiko  * for further look ups.
4202d5caef5bSAndrii Nakryiko  */
4203d5caef5bSAndrii Nakryiko static int btf_dedup_struct_type(struct btf_dedup *d, __u32 type_id)
4204d5caef5bSAndrii Nakryiko {
420591097fbeSAndrii Nakryiko 	struct btf_type *cand_type, *t;
42062fc3fc0bSAndrii Nakryiko 	struct hashmap_entry *hash_entry;
4207d5caef5bSAndrii Nakryiko 	/* if we don't find equivalent type, then we are canonical */
4208d5caef5bSAndrii Nakryiko 	__u32 new_id = type_id;
4209d5caef5bSAndrii Nakryiko 	__u16 kind;
42102fc3fc0bSAndrii Nakryiko 	long h;
4211d5caef5bSAndrii Nakryiko 
4212d5caef5bSAndrii Nakryiko 	/* already deduped or is in process of deduping (loop detected) */
42135aab392cSAndrii Nakryiko 	if (d->map[type_id] <= BTF_MAX_NR_TYPES)
4214d5caef5bSAndrii Nakryiko 		return 0;
4215d5caef5bSAndrii Nakryiko 
4216740e69c3SAndrii Nakryiko 	t = btf_type_by_id(d->btf, type_id);
4217b03bc685SAndrii Nakryiko 	kind = btf_kind(t);
4218d5caef5bSAndrii Nakryiko 
4219d5caef5bSAndrii Nakryiko 	if (kind != BTF_KIND_STRUCT && kind != BTF_KIND_UNION)
4220d5caef5bSAndrii Nakryiko 		return 0;
4221d5caef5bSAndrii Nakryiko 
4222d5caef5bSAndrii Nakryiko 	h = btf_hash_struct(t);
42232fc3fc0bSAndrii Nakryiko 	for_each_dedup_cand(d, hash_entry, h) {
42242fc3fc0bSAndrii Nakryiko 		__u32 cand_id = (__u32)(long)hash_entry->value;
4225d5caef5bSAndrii Nakryiko 		int eq;
4226d5caef5bSAndrii Nakryiko 
422791097fbeSAndrii Nakryiko 		/*
422891097fbeSAndrii Nakryiko 		 * Even though btf_dedup_is_equiv() checks for
422991097fbeSAndrii Nakryiko 		 * btf_shallow_equal_struct() internally when checking two
423091097fbeSAndrii Nakryiko 		 * structs (unions) for equivalence, we need to guard here
423191097fbeSAndrii Nakryiko 		 * from picking matching FWD type as a dedup candidate.
423291097fbeSAndrii Nakryiko 		 * This can happen due to hash collision. In such case just
423391097fbeSAndrii Nakryiko 		 * relying on btf_dedup_is_equiv() would lead to potentially
423491097fbeSAndrii Nakryiko 		 * creating a loop (FWD -> STRUCT and STRUCT -> FWD), because
423591097fbeSAndrii Nakryiko 		 * FWD and compatible STRUCT/UNION are considered equivalent.
423691097fbeSAndrii Nakryiko 		 */
4237740e69c3SAndrii Nakryiko 		cand_type = btf_type_by_id(d->btf, cand_id);
423891097fbeSAndrii Nakryiko 		if (!btf_shallow_equal_struct(t, cand_type))
423991097fbeSAndrii Nakryiko 			continue;
424091097fbeSAndrii Nakryiko 
4241d5caef5bSAndrii Nakryiko 		btf_dedup_clear_hypot_map(d);
42422fc3fc0bSAndrii Nakryiko 		eq = btf_dedup_is_equiv(d, type_id, cand_id);
4243d5caef5bSAndrii Nakryiko 		if (eq < 0)
4244d5caef5bSAndrii Nakryiko 			return eq;
4245d5caef5bSAndrii Nakryiko 		if (!eq)
4246d5caef5bSAndrii Nakryiko 			continue;
4247d5caef5bSAndrii Nakryiko 		btf_dedup_merge_hypot_map(d);
4248f86524efSAndrii Nakryiko 		if (d->hypot_adjust_canon) /* not really equivalent */
4249f86524efSAndrii Nakryiko 			continue;
4250f86524efSAndrii Nakryiko 		new_id = cand_id;
4251d5caef5bSAndrii Nakryiko 		break;
4252d5caef5bSAndrii Nakryiko 	}
4253d5caef5bSAndrii Nakryiko 
4254d5caef5bSAndrii Nakryiko 	d->map[type_id] = new_id;
4255d5caef5bSAndrii Nakryiko 	if (type_id == new_id && btf_dedup_table_add(d, h, type_id))
4256d5caef5bSAndrii Nakryiko 		return -ENOMEM;
4257d5caef5bSAndrii Nakryiko 
4258d5caef5bSAndrii Nakryiko 	return 0;
4259d5caef5bSAndrii Nakryiko }
4260d5caef5bSAndrii Nakryiko 
4261d5caef5bSAndrii Nakryiko static int btf_dedup_struct_types(struct btf_dedup *d)
4262d5caef5bSAndrii Nakryiko {
4263d5caef5bSAndrii Nakryiko 	int i, err;
4264d5caef5bSAndrii Nakryiko 
4265f86524efSAndrii Nakryiko 	for (i = 0; i < d->btf->nr_types; i++) {
4266f86524efSAndrii Nakryiko 		err = btf_dedup_struct_type(d, d->btf->start_id + i);
4267d5caef5bSAndrii Nakryiko 		if (err)
4268d5caef5bSAndrii Nakryiko 			return err;
4269d5caef5bSAndrii Nakryiko 	}
4270d5caef5bSAndrii Nakryiko 	return 0;
4271d5caef5bSAndrii Nakryiko }
4272d5caef5bSAndrii Nakryiko 
4273d5caef5bSAndrii Nakryiko /*
4274d5caef5bSAndrii Nakryiko  * Deduplicate reference type.
4275d5caef5bSAndrii Nakryiko  *
4276d5caef5bSAndrii Nakryiko  * Once all primitive and struct/union types got deduplicated, we can easily
4277d5caef5bSAndrii Nakryiko  * deduplicate all other (reference) BTF types. This is done in two steps:
4278d5caef5bSAndrii Nakryiko  *
4279d5caef5bSAndrii Nakryiko  * 1. Resolve all referenced type IDs into their canonical type IDs. This
4280d5caef5bSAndrii Nakryiko  * resolution can be done either immediately for primitive or struct/union types
4281d5caef5bSAndrii Nakryiko  * (because they were deduped in previous two phases) or recursively for
4282d5caef5bSAndrii Nakryiko  * reference types. Recursion will always terminate at either primitive or
4283d5caef5bSAndrii Nakryiko  * struct/union type, at which point we can "unwind" chain of reference types
4284d5caef5bSAndrii Nakryiko  * one by one. There is no danger of encountering cycles because in C type
4285d5caef5bSAndrii Nakryiko  * system the only way to form type cycle is through struct/union, so any chain
4286d5caef5bSAndrii Nakryiko  * of reference types, even those taking part in a type cycle, will inevitably
4287d5caef5bSAndrii Nakryiko  * reach struct/union at some point.
4288d5caef5bSAndrii Nakryiko  *
4289d5caef5bSAndrii Nakryiko  * 2. Once all referenced type IDs are resolved into canonical ones, BTF type
4290d5caef5bSAndrii Nakryiko  * becomes "stable", in the sense that no further deduplication will cause
4291d5caef5bSAndrii Nakryiko  * any changes to it. With that, it's now possible to calculate type's signature
4292d5caef5bSAndrii Nakryiko  * hash (this time taking into account referenced type IDs) and loop over all
4293d5caef5bSAndrii Nakryiko  * potential canonical representatives. If no match was found, current type
4294d5caef5bSAndrii Nakryiko  * will become canonical representative of itself and will be added into
4295d5caef5bSAndrii Nakryiko  * btf_dedup->dedup_table as another possible canonical representative.
4296d5caef5bSAndrii Nakryiko  */
4297d5caef5bSAndrii Nakryiko static int btf_dedup_ref_type(struct btf_dedup *d, __u32 type_id)
4298d5caef5bSAndrii Nakryiko {
42992fc3fc0bSAndrii Nakryiko 	struct hashmap_entry *hash_entry;
43002fc3fc0bSAndrii Nakryiko 	__u32 new_id = type_id, cand_id;
4301d5caef5bSAndrii Nakryiko 	struct btf_type *t, *cand;
4302d5caef5bSAndrii Nakryiko 	/* if we don't find equivalent type, then we are representative type */
43033d8669e6SDan Carpenter 	int ref_type_id;
43042fc3fc0bSAndrii Nakryiko 	long h;
4305d5caef5bSAndrii Nakryiko 
4306d5caef5bSAndrii Nakryiko 	if (d->map[type_id] == BTF_IN_PROGRESS_ID)
4307d5caef5bSAndrii Nakryiko 		return -ELOOP;
43085aab392cSAndrii Nakryiko 	if (d->map[type_id] <= BTF_MAX_NR_TYPES)
4309d5caef5bSAndrii Nakryiko 		return resolve_type_id(d, type_id);
4310d5caef5bSAndrii Nakryiko 
4311740e69c3SAndrii Nakryiko 	t = btf_type_by_id(d->btf, type_id);
4312d5caef5bSAndrii Nakryiko 	d->map[type_id] = BTF_IN_PROGRESS_ID;
4313d5caef5bSAndrii Nakryiko 
4314b03bc685SAndrii Nakryiko 	switch (btf_kind(t)) {
4315d5caef5bSAndrii Nakryiko 	case BTF_KIND_CONST:
4316d5caef5bSAndrii Nakryiko 	case BTF_KIND_VOLATILE:
4317d5caef5bSAndrii Nakryiko 	case BTF_KIND_RESTRICT:
4318d5caef5bSAndrii Nakryiko 	case BTF_KIND_PTR:
4319d5caef5bSAndrii Nakryiko 	case BTF_KIND_TYPEDEF:
4320d5caef5bSAndrii Nakryiko 	case BTF_KIND_FUNC:
4321*2dc1e488SYonghong Song 	case BTF_KIND_TYPE_TAG:
4322d5caef5bSAndrii Nakryiko 		ref_type_id = btf_dedup_ref_type(d, t->type);
4323d5caef5bSAndrii Nakryiko 		if (ref_type_id < 0)
4324d5caef5bSAndrii Nakryiko 			return ref_type_id;
4325d5caef5bSAndrii Nakryiko 		t->type = ref_type_id;
4326d5caef5bSAndrii Nakryiko 
4327d5caef5bSAndrii Nakryiko 		h = btf_hash_common(t);
43282fc3fc0bSAndrii Nakryiko 		for_each_dedup_cand(d, hash_entry, h) {
43292fc3fc0bSAndrii Nakryiko 			cand_id = (__u32)(long)hash_entry->value;
4330740e69c3SAndrii Nakryiko 			cand = btf_type_by_id(d->btf, cand_id);
4331d5caef5bSAndrii Nakryiko 			if (btf_equal_common(t, cand)) {
43322fc3fc0bSAndrii Nakryiko 				new_id = cand_id;
4333d5caef5bSAndrii Nakryiko 				break;
4334d5caef5bSAndrii Nakryiko 			}
4335d5caef5bSAndrii Nakryiko 		}
4336d5caef5bSAndrii Nakryiko 		break;
4337d5caef5bSAndrii Nakryiko 
4338223f903eSYonghong Song 	case BTF_KIND_DECL_TAG:
43395b84bd10SYonghong Song 		ref_type_id = btf_dedup_ref_type(d, t->type);
43405b84bd10SYonghong Song 		if (ref_type_id < 0)
43415b84bd10SYonghong Song 			return ref_type_id;
43425b84bd10SYonghong Song 		t->type = ref_type_id;
43435b84bd10SYonghong Song 
4344223f903eSYonghong Song 		h = btf_hash_int_decl_tag(t);
43455b84bd10SYonghong Song 		for_each_dedup_cand(d, hash_entry, h) {
43465b84bd10SYonghong Song 			cand_id = (__u32)(long)hash_entry->value;
43475b84bd10SYonghong Song 			cand = btf_type_by_id(d->btf, cand_id);
43485b84bd10SYonghong Song 			if (btf_equal_int_tag(t, cand)) {
43495b84bd10SYonghong Song 				new_id = cand_id;
43505b84bd10SYonghong Song 				break;
43515b84bd10SYonghong Song 			}
43525b84bd10SYonghong Song 		}
43535b84bd10SYonghong Song 		break;
43545b84bd10SYonghong Song 
4355d5caef5bSAndrii Nakryiko 	case BTF_KIND_ARRAY: {
4356b03bc685SAndrii Nakryiko 		struct btf_array *info = btf_array(t);
4357d5caef5bSAndrii Nakryiko 
4358d5caef5bSAndrii Nakryiko 		ref_type_id = btf_dedup_ref_type(d, info->type);
4359d5caef5bSAndrii Nakryiko 		if (ref_type_id < 0)
4360d5caef5bSAndrii Nakryiko 			return ref_type_id;
4361d5caef5bSAndrii Nakryiko 		info->type = ref_type_id;
4362d5caef5bSAndrii Nakryiko 
4363d5caef5bSAndrii Nakryiko 		ref_type_id = btf_dedup_ref_type(d, info->index_type);
4364d5caef5bSAndrii Nakryiko 		if (ref_type_id < 0)
4365d5caef5bSAndrii Nakryiko 			return ref_type_id;
4366d5caef5bSAndrii Nakryiko 		info->index_type = ref_type_id;
4367d5caef5bSAndrii Nakryiko 
4368d5caef5bSAndrii Nakryiko 		h = btf_hash_array(t);
43692fc3fc0bSAndrii Nakryiko 		for_each_dedup_cand(d, hash_entry, h) {
43702fc3fc0bSAndrii Nakryiko 			cand_id = (__u32)(long)hash_entry->value;
4371740e69c3SAndrii Nakryiko 			cand = btf_type_by_id(d->btf, cand_id);
4372d5caef5bSAndrii Nakryiko 			if (btf_equal_array(t, cand)) {
43732fc3fc0bSAndrii Nakryiko 				new_id = cand_id;
4374d5caef5bSAndrii Nakryiko 				break;
4375d5caef5bSAndrii Nakryiko 			}
4376d5caef5bSAndrii Nakryiko 		}
4377d5caef5bSAndrii Nakryiko 		break;
4378d5caef5bSAndrii Nakryiko 	}
4379d5caef5bSAndrii Nakryiko 
4380d5caef5bSAndrii Nakryiko 	case BTF_KIND_FUNC_PROTO: {
4381d5caef5bSAndrii Nakryiko 		struct btf_param *param;
4382d5caef5bSAndrii Nakryiko 		__u16 vlen;
4383d5caef5bSAndrii Nakryiko 		int i;
4384d5caef5bSAndrii Nakryiko 
4385d5caef5bSAndrii Nakryiko 		ref_type_id = btf_dedup_ref_type(d, t->type);
4386d5caef5bSAndrii Nakryiko 		if (ref_type_id < 0)
4387d5caef5bSAndrii Nakryiko 			return ref_type_id;
4388d5caef5bSAndrii Nakryiko 		t->type = ref_type_id;
4389d5caef5bSAndrii Nakryiko 
4390b03bc685SAndrii Nakryiko 		vlen = btf_vlen(t);
4391b03bc685SAndrii Nakryiko 		param = btf_params(t);
4392d5caef5bSAndrii Nakryiko 		for (i = 0; i < vlen; i++) {
4393d5caef5bSAndrii Nakryiko 			ref_type_id = btf_dedup_ref_type(d, param->type);
4394d5caef5bSAndrii Nakryiko 			if (ref_type_id < 0)
4395d5caef5bSAndrii Nakryiko 				return ref_type_id;
4396d5caef5bSAndrii Nakryiko 			param->type = ref_type_id;
4397d5caef5bSAndrii Nakryiko 			param++;
4398d5caef5bSAndrii Nakryiko 		}
4399d5caef5bSAndrii Nakryiko 
4400d5caef5bSAndrii Nakryiko 		h = btf_hash_fnproto(t);
44012fc3fc0bSAndrii Nakryiko 		for_each_dedup_cand(d, hash_entry, h) {
44022fc3fc0bSAndrii Nakryiko 			cand_id = (__u32)(long)hash_entry->value;
4403740e69c3SAndrii Nakryiko 			cand = btf_type_by_id(d->btf, cand_id);
4404d5caef5bSAndrii Nakryiko 			if (btf_equal_fnproto(t, cand)) {
44052fc3fc0bSAndrii Nakryiko 				new_id = cand_id;
4406d5caef5bSAndrii Nakryiko 				break;
4407d5caef5bSAndrii Nakryiko 			}
4408d5caef5bSAndrii Nakryiko 		}
4409d5caef5bSAndrii Nakryiko 		break;
4410d5caef5bSAndrii Nakryiko 	}
4411d5caef5bSAndrii Nakryiko 
4412d5caef5bSAndrii Nakryiko 	default:
4413d5caef5bSAndrii Nakryiko 		return -EINVAL;
4414d5caef5bSAndrii Nakryiko 	}
4415d5caef5bSAndrii Nakryiko 
4416d5caef5bSAndrii Nakryiko 	d->map[type_id] = new_id;
4417d5caef5bSAndrii Nakryiko 	if (type_id == new_id && btf_dedup_table_add(d, h, type_id))
4418d5caef5bSAndrii Nakryiko 		return -ENOMEM;
4419d5caef5bSAndrii Nakryiko 
4420d5caef5bSAndrii Nakryiko 	return new_id;
4421d5caef5bSAndrii Nakryiko }
4422d5caef5bSAndrii Nakryiko 
4423d5caef5bSAndrii Nakryiko static int btf_dedup_ref_types(struct btf_dedup *d)
4424d5caef5bSAndrii Nakryiko {
4425d5caef5bSAndrii Nakryiko 	int i, err;
4426d5caef5bSAndrii Nakryiko 
4427f86524efSAndrii Nakryiko 	for (i = 0; i < d->btf->nr_types; i++) {
4428f86524efSAndrii Nakryiko 		err = btf_dedup_ref_type(d, d->btf->start_id + i);
4429d5caef5bSAndrii Nakryiko 		if (err < 0)
4430d5caef5bSAndrii Nakryiko 			return err;
4431d5caef5bSAndrii Nakryiko 	}
44322fc3fc0bSAndrii Nakryiko 	/* we won't need d->dedup_table anymore */
44332fc3fc0bSAndrii Nakryiko 	hashmap__free(d->dedup_table);
44342fc3fc0bSAndrii Nakryiko 	d->dedup_table = NULL;
4435d5caef5bSAndrii Nakryiko 	return 0;
4436d5caef5bSAndrii Nakryiko }
4437d5caef5bSAndrii Nakryiko 
4438d5caef5bSAndrii Nakryiko /*
4439d5caef5bSAndrii Nakryiko  * Compact types.
4440d5caef5bSAndrii Nakryiko  *
4441d5caef5bSAndrii Nakryiko  * After we established for each type its corresponding canonical representative
4442d5caef5bSAndrii Nakryiko  * type, we now can eliminate types that are not canonical and leave only
4443d5caef5bSAndrii Nakryiko  * canonical ones layed out sequentially in memory by copying them over
4444d5caef5bSAndrii Nakryiko  * duplicates. During compaction btf_dedup->hypot_map array is reused to store
4445d5caef5bSAndrii Nakryiko  * a map from original type ID to a new compacted type ID, which will be used
4446d5caef5bSAndrii Nakryiko  * during next phase to "fix up" type IDs, referenced from struct/union and
4447d5caef5bSAndrii Nakryiko  * reference types.
4448d5caef5bSAndrii Nakryiko  */
4449d5caef5bSAndrii Nakryiko static int btf_dedup_compact_types(struct btf_dedup *d)
4450d5caef5bSAndrii Nakryiko {
4451740e69c3SAndrii Nakryiko 	__u32 *new_offs;
4452f86524efSAndrii Nakryiko 	__u32 next_type_id = d->btf->start_id;
4453f86524efSAndrii Nakryiko 	const struct btf_type *t;
4454740e69c3SAndrii Nakryiko 	void *p;
4455f86524efSAndrii Nakryiko 	int i, id, len;
4456d5caef5bSAndrii Nakryiko 
4457d5caef5bSAndrii Nakryiko 	/* we are going to reuse hypot_map to store compaction remapping */
4458d5caef5bSAndrii Nakryiko 	d->hypot_map[0] = 0;
4459f86524efSAndrii Nakryiko 	/* base BTF types are not renumbered */
4460f86524efSAndrii Nakryiko 	for (id = 1; id < d->btf->start_id; id++)
4461f86524efSAndrii Nakryiko 		d->hypot_map[id] = id;
4462f86524efSAndrii Nakryiko 	for (i = 0, id = d->btf->start_id; i < d->btf->nr_types; i++, id++)
4463f86524efSAndrii Nakryiko 		d->hypot_map[id] = BTF_UNPROCESSED_ID;
4464d5caef5bSAndrii Nakryiko 
4465740e69c3SAndrii Nakryiko 	p = d->btf->types_data;
4466d5caef5bSAndrii Nakryiko 
4467f86524efSAndrii Nakryiko 	for (i = 0, id = d->btf->start_id; i < d->btf->nr_types; i++, id++) {
4468f86524efSAndrii Nakryiko 		if (d->map[id] != id)
4469d5caef5bSAndrii Nakryiko 			continue;
4470d5caef5bSAndrii Nakryiko 
4471f86524efSAndrii Nakryiko 		t = btf__type_by_id(d->btf, id);
4472f86524efSAndrii Nakryiko 		len = btf_type_size(t);
4473d5caef5bSAndrii Nakryiko 		if (len < 0)
4474d5caef5bSAndrii Nakryiko 			return len;
4475d5caef5bSAndrii Nakryiko 
4476f86524efSAndrii Nakryiko 		memmove(p, t, len);
4477f86524efSAndrii Nakryiko 		d->hypot_map[id] = next_type_id;
4478f86524efSAndrii Nakryiko 		d->btf->type_offs[next_type_id - d->btf->start_id] = p - d->btf->types_data;
4479d5caef5bSAndrii Nakryiko 		p += len;
4480d5caef5bSAndrii Nakryiko 		next_type_id++;
4481d5caef5bSAndrii Nakryiko 	}
4482d5caef5bSAndrii Nakryiko 
4483d5caef5bSAndrii Nakryiko 	/* shrink struct btf's internal types index and update btf_header */
4484f86524efSAndrii Nakryiko 	d->btf->nr_types = next_type_id - d->btf->start_id;
4485ba451366SAndrii Nakryiko 	d->btf->type_offs_cap = d->btf->nr_types;
4486740e69c3SAndrii Nakryiko 	d->btf->hdr->type_len = p - d->btf->types_data;
4487740e69c3SAndrii Nakryiko 	new_offs = libbpf_reallocarray(d->btf->type_offs, d->btf->type_offs_cap,
4488740e69c3SAndrii Nakryiko 				       sizeof(*new_offs));
4489f86524efSAndrii Nakryiko 	if (d->btf->type_offs_cap && !new_offs)
4490d5caef5bSAndrii Nakryiko 		return -ENOMEM;
4491740e69c3SAndrii Nakryiko 	d->btf->type_offs = new_offs;
4492919d2b1dSAndrii Nakryiko 	d->btf->hdr->str_off = d->btf->hdr->type_len;
4493b8604247SAndrii Nakryiko 	d->btf->raw_size = d->btf->hdr->hdr_len + d->btf->hdr->type_len + d->btf->hdr->str_len;
4494d5caef5bSAndrii Nakryiko 	return 0;
4495d5caef5bSAndrii Nakryiko }
4496d5caef5bSAndrii Nakryiko 
4497d5caef5bSAndrii Nakryiko /*
4498d5caef5bSAndrii Nakryiko  * Figure out final (deduplicated and compacted) type ID for provided original
4499d5caef5bSAndrii Nakryiko  * `type_id` by first resolving it into corresponding canonical type ID and
4500d5caef5bSAndrii Nakryiko  * then mapping it to a deduplicated type ID, stored in btf_dedup->hypot_map,
4501d5caef5bSAndrii Nakryiko  * which is populated during compaction phase.
4502d5caef5bSAndrii Nakryiko  */
4503f36e99a4SAndrii Nakryiko static int btf_dedup_remap_type_id(__u32 *type_id, void *ctx)
4504d5caef5bSAndrii Nakryiko {
4505f36e99a4SAndrii Nakryiko 	struct btf_dedup *d = ctx;
4506d5caef5bSAndrii Nakryiko 	__u32 resolved_type_id, new_type_id;
4507d5caef5bSAndrii Nakryiko 
4508f36e99a4SAndrii Nakryiko 	resolved_type_id = resolve_type_id(d, *type_id);
4509d5caef5bSAndrii Nakryiko 	new_type_id = d->hypot_map[resolved_type_id];
45105aab392cSAndrii Nakryiko 	if (new_type_id > BTF_MAX_NR_TYPES)
4511d5caef5bSAndrii Nakryiko 		return -EINVAL;
4512f36e99a4SAndrii Nakryiko 
4513f36e99a4SAndrii Nakryiko 	*type_id = new_type_id;
4514f36e99a4SAndrii Nakryiko 	return 0;
4515d5caef5bSAndrii Nakryiko }
4516d5caef5bSAndrii Nakryiko 
4517d5caef5bSAndrii Nakryiko /*
4518d5caef5bSAndrii Nakryiko  * Remap referenced type IDs into deduped type IDs.
4519d5caef5bSAndrii Nakryiko  *
4520d5caef5bSAndrii Nakryiko  * After BTF types are deduplicated and compacted, their final type IDs may
4521d5caef5bSAndrii Nakryiko  * differ from original ones. The map from original to a corresponding
4522d5caef5bSAndrii Nakryiko  * deduped type ID is stored in btf_dedup->hypot_map and is populated during
4523d5caef5bSAndrii Nakryiko  * compaction phase. During remapping phase we are rewriting all type IDs
4524d5caef5bSAndrii Nakryiko  * referenced from any BTF type (e.g., struct fields, func proto args, etc) to
4525d5caef5bSAndrii Nakryiko  * their final deduped type IDs.
4526d5caef5bSAndrii Nakryiko  */
4527d5caef5bSAndrii Nakryiko static int btf_dedup_remap_types(struct btf_dedup *d)
4528d5caef5bSAndrii Nakryiko {
4529d5caef5bSAndrii Nakryiko 	int i, r;
4530d5caef5bSAndrii Nakryiko 
4531f86524efSAndrii Nakryiko 	for (i = 0; i < d->btf->nr_types; i++) {
4532f36e99a4SAndrii Nakryiko 		struct btf_type *t = btf_type_by_id(d->btf, d->btf->start_id + i);
4533f36e99a4SAndrii Nakryiko 
4534f36e99a4SAndrii Nakryiko 		r = btf_type_visit_type_ids(t, btf_dedup_remap_type_id, d);
4535f36e99a4SAndrii Nakryiko 		if (r)
4536d5caef5bSAndrii Nakryiko 			return r;
4537d5caef5bSAndrii Nakryiko 	}
4538f36e99a4SAndrii Nakryiko 
4539f36e99a4SAndrii Nakryiko 	if (!d->btf_ext)
4540f36e99a4SAndrii Nakryiko 		return 0;
4541f36e99a4SAndrii Nakryiko 
4542f36e99a4SAndrii Nakryiko 	r = btf_ext_visit_type_ids(d->btf_ext, btf_dedup_remap_type_id, d);
4543f36e99a4SAndrii Nakryiko 	if (r)
4544f36e99a4SAndrii Nakryiko 		return r;
4545f36e99a4SAndrii Nakryiko 
4546d5caef5bSAndrii Nakryiko 	return 0;
4547d5caef5bSAndrii Nakryiko }
4548fb2426adSMartin KaFai Lau 
4549fb2426adSMartin KaFai Lau /*
4550fb2426adSMartin KaFai Lau  * Probe few well-known locations for vmlinux kernel image and try to load BTF
4551fb2426adSMartin KaFai Lau  * data out of it to use for target BTF.
4552fb2426adSMartin KaFai Lau  */
4553a710eed3SHengqi Chen struct btf *btf__load_vmlinux_btf(void)
4554fb2426adSMartin KaFai Lau {
4555fb2426adSMartin KaFai Lau 	struct {
4556fb2426adSMartin KaFai Lau 		const char *path_fmt;
4557fb2426adSMartin KaFai Lau 		bool raw_btf;
4558fb2426adSMartin KaFai Lau 	} locations[] = {
4559fb2426adSMartin KaFai Lau 		/* try canonical vmlinux BTF through sysfs first */
4560fb2426adSMartin KaFai Lau 		{ "/sys/kernel/btf/vmlinux", true /* raw BTF */ },
4561fb2426adSMartin KaFai Lau 		/* fall back to trying to find vmlinux ELF on disk otherwise */
4562fb2426adSMartin KaFai Lau 		{ "/boot/vmlinux-%1$s" },
4563fb2426adSMartin KaFai Lau 		{ "/lib/modules/%1$s/vmlinux-%1$s" },
4564fb2426adSMartin KaFai Lau 		{ "/lib/modules/%1$s/build/vmlinux" },
4565fb2426adSMartin KaFai Lau 		{ "/usr/lib/modules/%1$s/kernel/vmlinux" },
4566fb2426adSMartin KaFai Lau 		{ "/usr/lib/debug/boot/vmlinux-%1$s" },
4567fb2426adSMartin KaFai Lau 		{ "/usr/lib/debug/boot/vmlinux-%1$s.debug" },
4568fb2426adSMartin KaFai Lau 		{ "/usr/lib/debug/lib/modules/%1$s/vmlinux" },
4569fb2426adSMartin KaFai Lau 	};
4570fb2426adSMartin KaFai Lau 	char path[PATH_MAX + 1];
4571fb2426adSMartin KaFai Lau 	struct utsname buf;
4572fb2426adSMartin KaFai Lau 	struct btf *btf;
4573e9fc3ce9SAndrii Nakryiko 	int i, err;
4574fb2426adSMartin KaFai Lau 
4575fb2426adSMartin KaFai Lau 	uname(&buf);
4576fb2426adSMartin KaFai Lau 
4577fb2426adSMartin KaFai Lau 	for (i = 0; i < ARRAY_SIZE(locations); i++) {
4578fb2426adSMartin KaFai Lau 		snprintf(path, PATH_MAX, locations[i].path_fmt, buf.release);
4579fb2426adSMartin KaFai Lau 
4580fb2426adSMartin KaFai Lau 		if (access(path, R_OK))
4581fb2426adSMartin KaFai Lau 			continue;
4582fb2426adSMartin KaFai Lau 
4583fb2426adSMartin KaFai Lau 		if (locations[i].raw_btf)
458494a1feddSAndrii Nakryiko 			btf = btf__parse_raw(path);
4585fb2426adSMartin KaFai Lau 		else
4586fb2426adSMartin KaFai Lau 			btf = btf__parse_elf(path, NULL);
4587e9fc3ce9SAndrii Nakryiko 		err = libbpf_get_error(btf);
4588e9fc3ce9SAndrii Nakryiko 		pr_debug("loading kernel BTF '%s': %d\n", path, err);
4589e9fc3ce9SAndrii Nakryiko 		if (err)
4590fb2426adSMartin KaFai Lau 			continue;
4591fb2426adSMartin KaFai Lau 
4592fb2426adSMartin KaFai Lau 		return btf;
4593fb2426adSMartin KaFai Lau 	}
4594fb2426adSMartin KaFai Lau 
4595fb2426adSMartin KaFai Lau 	pr_warn("failed to find valid kernel BTF\n");
4596e9fc3ce9SAndrii Nakryiko 	return libbpf_err_ptr(-ESRCH);
4597fb2426adSMartin KaFai Lau }
4598f36e99a4SAndrii Nakryiko 
4599a710eed3SHengqi Chen struct btf *libbpf_find_kernel_btf(void) __attribute__((alias("btf__load_vmlinux_btf")));
4600a710eed3SHengqi Chen 
4601a710eed3SHengqi Chen struct btf *btf__load_module_btf(const char *module_name, struct btf *vmlinux_btf)
4602a710eed3SHengqi Chen {
4603a710eed3SHengqi Chen 	char path[80];
4604a710eed3SHengqi Chen 
4605a710eed3SHengqi Chen 	snprintf(path, sizeof(path), "/sys/kernel/btf/%s", module_name);
4606a710eed3SHengqi Chen 	return btf__parse_split(path, vmlinux_btf);
4607a710eed3SHengqi Chen }
4608a710eed3SHengqi Chen 
4609f36e99a4SAndrii Nakryiko int btf_type_visit_type_ids(struct btf_type *t, type_id_visit_fn visit, void *ctx)
4610f36e99a4SAndrii Nakryiko {
4611f36e99a4SAndrii Nakryiko 	int i, n, err;
4612f36e99a4SAndrii Nakryiko 
4613f36e99a4SAndrii Nakryiko 	switch (btf_kind(t)) {
4614f36e99a4SAndrii Nakryiko 	case BTF_KIND_INT:
4615f36e99a4SAndrii Nakryiko 	case BTF_KIND_FLOAT:
4616f36e99a4SAndrii Nakryiko 	case BTF_KIND_ENUM:
4617f36e99a4SAndrii Nakryiko 		return 0;
4618f36e99a4SAndrii Nakryiko 
4619f36e99a4SAndrii Nakryiko 	case BTF_KIND_FWD:
4620f36e99a4SAndrii Nakryiko 	case BTF_KIND_CONST:
4621f36e99a4SAndrii Nakryiko 	case BTF_KIND_VOLATILE:
4622f36e99a4SAndrii Nakryiko 	case BTF_KIND_RESTRICT:
4623f36e99a4SAndrii Nakryiko 	case BTF_KIND_PTR:
4624f36e99a4SAndrii Nakryiko 	case BTF_KIND_TYPEDEF:
4625f36e99a4SAndrii Nakryiko 	case BTF_KIND_FUNC:
4626f36e99a4SAndrii Nakryiko 	case BTF_KIND_VAR:
4627223f903eSYonghong Song 	case BTF_KIND_DECL_TAG:
4628*2dc1e488SYonghong Song 	case BTF_KIND_TYPE_TAG:
4629f36e99a4SAndrii Nakryiko 		return visit(&t->type, ctx);
4630f36e99a4SAndrii Nakryiko 
4631f36e99a4SAndrii Nakryiko 	case BTF_KIND_ARRAY: {
4632f36e99a4SAndrii Nakryiko 		struct btf_array *a = btf_array(t);
4633f36e99a4SAndrii Nakryiko 
4634f36e99a4SAndrii Nakryiko 		err = visit(&a->type, ctx);
4635f36e99a4SAndrii Nakryiko 		err = err ?: visit(&a->index_type, ctx);
4636f36e99a4SAndrii Nakryiko 		return err;
4637f36e99a4SAndrii Nakryiko 	}
4638f36e99a4SAndrii Nakryiko 
4639f36e99a4SAndrii Nakryiko 	case BTF_KIND_STRUCT:
4640f36e99a4SAndrii Nakryiko 	case BTF_KIND_UNION: {
4641f36e99a4SAndrii Nakryiko 		struct btf_member *m = btf_members(t);
4642f36e99a4SAndrii Nakryiko 
4643f36e99a4SAndrii Nakryiko 		for (i = 0, n = btf_vlen(t); i < n; i++, m++) {
4644f36e99a4SAndrii Nakryiko 			err = visit(&m->type, ctx);
4645f36e99a4SAndrii Nakryiko 			if (err)
4646f36e99a4SAndrii Nakryiko 				return err;
4647f36e99a4SAndrii Nakryiko 		}
4648f36e99a4SAndrii Nakryiko 		return 0;
4649f36e99a4SAndrii Nakryiko 	}
4650f36e99a4SAndrii Nakryiko 
4651f36e99a4SAndrii Nakryiko 	case BTF_KIND_FUNC_PROTO: {
4652f36e99a4SAndrii Nakryiko 		struct btf_param *m = btf_params(t);
4653f36e99a4SAndrii Nakryiko 
4654f36e99a4SAndrii Nakryiko 		err = visit(&t->type, ctx);
4655f36e99a4SAndrii Nakryiko 		if (err)
4656f36e99a4SAndrii Nakryiko 			return err;
4657f36e99a4SAndrii Nakryiko 		for (i = 0, n = btf_vlen(t); i < n; i++, m++) {
4658f36e99a4SAndrii Nakryiko 			err = visit(&m->type, ctx);
4659f36e99a4SAndrii Nakryiko 			if (err)
4660f36e99a4SAndrii Nakryiko 				return err;
4661f36e99a4SAndrii Nakryiko 		}
4662f36e99a4SAndrii Nakryiko 		return 0;
4663f36e99a4SAndrii Nakryiko 	}
4664f36e99a4SAndrii Nakryiko 
4665f36e99a4SAndrii Nakryiko 	case BTF_KIND_DATASEC: {
4666f36e99a4SAndrii Nakryiko 		struct btf_var_secinfo *m = btf_var_secinfos(t);
4667f36e99a4SAndrii Nakryiko 
4668f36e99a4SAndrii Nakryiko 		for (i = 0, n = btf_vlen(t); i < n; i++, m++) {
4669f36e99a4SAndrii Nakryiko 			err = visit(&m->type, ctx);
4670f36e99a4SAndrii Nakryiko 			if (err)
4671f36e99a4SAndrii Nakryiko 				return err;
4672f36e99a4SAndrii Nakryiko 		}
4673f36e99a4SAndrii Nakryiko 		return 0;
4674f36e99a4SAndrii Nakryiko 	}
4675f36e99a4SAndrii Nakryiko 
4676f36e99a4SAndrii Nakryiko 	default:
4677f36e99a4SAndrii Nakryiko 		return -EINVAL;
4678f36e99a4SAndrii Nakryiko 	}
4679f36e99a4SAndrii Nakryiko }
4680f36e99a4SAndrii Nakryiko 
4681f36e99a4SAndrii Nakryiko int btf_type_visit_str_offs(struct btf_type *t, str_off_visit_fn visit, void *ctx)
4682f36e99a4SAndrii Nakryiko {
4683f36e99a4SAndrii Nakryiko 	int i, n, err;
4684f36e99a4SAndrii Nakryiko 
4685f36e99a4SAndrii Nakryiko 	err = visit(&t->name_off, ctx);
4686f36e99a4SAndrii Nakryiko 	if (err)
4687f36e99a4SAndrii Nakryiko 		return err;
4688f36e99a4SAndrii Nakryiko 
4689f36e99a4SAndrii Nakryiko 	switch (btf_kind(t)) {
4690f36e99a4SAndrii Nakryiko 	case BTF_KIND_STRUCT:
4691f36e99a4SAndrii Nakryiko 	case BTF_KIND_UNION: {
4692f36e99a4SAndrii Nakryiko 		struct btf_member *m = btf_members(t);
4693f36e99a4SAndrii Nakryiko 
4694f36e99a4SAndrii Nakryiko 		for (i = 0, n = btf_vlen(t); i < n; i++, m++) {
4695f36e99a4SAndrii Nakryiko 			err = visit(&m->name_off, ctx);
4696f36e99a4SAndrii Nakryiko 			if (err)
4697f36e99a4SAndrii Nakryiko 				return err;
4698f36e99a4SAndrii Nakryiko 		}
4699f36e99a4SAndrii Nakryiko 		break;
4700f36e99a4SAndrii Nakryiko 	}
4701f36e99a4SAndrii Nakryiko 	case BTF_KIND_ENUM: {
4702f36e99a4SAndrii Nakryiko 		struct btf_enum *m = btf_enum(t);
4703f36e99a4SAndrii Nakryiko 
4704f36e99a4SAndrii Nakryiko 		for (i = 0, n = btf_vlen(t); i < n; i++, m++) {
4705f36e99a4SAndrii Nakryiko 			err = visit(&m->name_off, ctx);
4706f36e99a4SAndrii Nakryiko 			if (err)
4707f36e99a4SAndrii Nakryiko 				return err;
4708f36e99a4SAndrii Nakryiko 		}
4709f36e99a4SAndrii Nakryiko 		break;
4710f36e99a4SAndrii Nakryiko 	}
4711f36e99a4SAndrii Nakryiko 	case BTF_KIND_FUNC_PROTO: {
4712f36e99a4SAndrii Nakryiko 		struct btf_param *m = btf_params(t);
4713f36e99a4SAndrii Nakryiko 
4714f36e99a4SAndrii Nakryiko 		for (i = 0, n = btf_vlen(t); i < n; i++, m++) {
4715f36e99a4SAndrii Nakryiko 			err = visit(&m->name_off, ctx);
4716f36e99a4SAndrii Nakryiko 			if (err)
4717f36e99a4SAndrii Nakryiko 				return err;
4718f36e99a4SAndrii Nakryiko 		}
4719f36e99a4SAndrii Nakryiko 		break;
4720f36e99a4SAndrii Nakryiko 	}
4721f36e99a4SAndrii Nakryiko 	default:
4722f36e99a4SAndrii Nakryiko 		break;
4723f36e99a4SAndrii Nakryiko 	}
4724f36e99a4SAndrii Nakryiko 
4725f36e99a4SAndrii Nakryiko 	return 0;
4726f36e99a4SAndrii Nakryiko }
4727f36e99a4SAndrii Nakryiko 
4728f36e99a4SAndrii Nakryiko int btf_ext_visit_type_ids(struct btf_ext *btf_ext, type_id_visit_fn visit, void *ctx)
4729f36e99a4SAndrii Nakryiko {
4730f36e99a4SAndrii Nakryiko 	const struct btf_ext_info *seg;
4731f36e99a4SAndrii Nakryiko 	struct btf_ext_info_sec *sec;
4732f36e99a4SAndrii Nakryiko 	int i, err;
4733f36e99a4SAndrii Nakryiko 
4734f36e99a4SAndrii Nakryiko 	seg = &btf_ext->func_info;
4735f36e99a4SAndrii Nakryiko 	for_each_btf_ext_sec(seg, sec) {
4736f36e99a4SAndrii Nakryiko 		struct bpf_func_info_min *rec;
4737f36e99a4SAndrii Nakryiko 
4738f36e99a4SAndrii Nakryiko 		for_each_btf_ext_rec(seg, sec, i, rec) {
4739f36e99a4SAndrii Nakryiko 			err = visit(&rec->type_id, ctx);
4740f36e99a4SAndrii Nakryiko 			if (err < 0)
4741f36e99a4SAndrii Nakryiko 				return err;
4742f36e99a4SAndrii Nakryiko 		}
4743f36e99a4SAndrii Nakryiko 	}
4744f36e99a4SAndrii Nakryiko 
4745f36e99a4SAndrii Nakryiko 	seg = &btf_ext->core_relo_info;
4746f36e99a4SAndrii Nakryiko 	for_each_btf_ext_sec(seg, sec) {
4747f36e99a4SAndrii Nakryiko 		struct bpf_core_relo *rec;
4748f36e99a4SAndrii Nakryiko 
4749f36e99a4SAndrii Nakryiko 		for_each_btf_ext_rec(seg, sec, i, rec) {
4750f36e99a4SAndrii Nakryiko 			err = visit(&rec->type_id, ctx);
4751f36e99a4SAndrii Nakryiko 			if (err < 0)
4752f36e99a4SAndrii Nakryiko 				return err;
4753f36e99a4SAndrii Nakryiko 		}
4754f36e99a4SAndrii Nakryiko 	}
4755f36e99a4SAndrii Nakryiko 
4756f36e99a4SAndrii Nakryiko 	return 0;
4757f36e99a4SAndrii Nakryiko }
4758f36e99a4SAndrii Nakryiko 
4759f36e99a4SAndrii Nakryiko int btf_ext_visit_str_offs(struct btf_ext *btf_ext, str_off_visit_fn visit, void *ctx)
4760f36e99a4SAndrii Nakryiko {
4761f36e99a4SAndrii Nakryiko 	const struct btf_ext_info *seg;
4762f36e99a4SAndrii Nakryiko 	struct btf_ext_info_sec *sec;
4763f36e99a4SAndrii Nakryiko 	int i, err;
4764f36e99a4SAndrii Nakryiko 
4765f36e99a4SAndrii Nakryiko 	seg = &btf_ext->func_info;
4766f36e99a4SAndrii Nakryiko 	for_each_btf_ext_sec(seg, sec) {
4767f36e99a4SAndrii Nakryiko 		err = visit(&sec->sec_name_off, ctx);
4768f36e99a4SAndrii Nakryiko 		if (err)
4769f36e99a4SAndrii Nakryiko 			return err;
4770f36e99a4SAndrii Nakryiko 	}
4771f36e99a4SAndrii Nakryiko 
4772f36e99a4SAndrii Nakryiko 	seg = &btf_ext->line_info;
4773f36e99a4SAndrii Nakryiko 	for_each_btf_ext_sec(seg, sec) {
4774f36e99a4SAndrii Nakryiko 		struct bpf_line_info_min *rec;
4775f36e99a4SAndrii Nakryiko 
4776f36e99a4SAndrii Nakryiko 		err = visit(&sec->sec_name_off, ctx);
4777f36e99a4SAndrii Nakryiko 		if (err)
4778f36e99a4SAndrii Nakryiko 			return err;
4779f36e99a4SAndrii Nakryiko 
4780f36e99a4SAndrii Nakryiko 		for_each_btf_ext_rec(seg, sec, i, rec) {
4781f36e99a4SAndrii Nakryiko 			err = visit(&rec->file_name_off, ctx);
4782f36e99a4SAndrii Nakryiko 			if (err)
4783f36e99a4SAndrii Nakryiko 				return err;
4784f36e99a4SAndrii Nakryiko 			err = visit(&rec->line_off, ctx);
4785f36e99a4SAndrii Nakryiko 			if (err)
4786f36e99a4SAndrii Nakryiko 				return err;
4787f36e99a4SAndrii Nakryiko 		}
4788f36e99a4SAndrii Nakryiko 	}
4789f36e99a4SAndrii Nakryiko 
4790f36e99a4SAndrii Nakryiko 	seg = &btf_ext->core_relo_info;
4791f36e99a4SAndrii Nakryiko 	for_each_btf_ext_sec(seg, sec) {
4792f36e99a4SAndrii Nakryiko 		struct bpf_core_relo *rec;
4793f36e99a4SAndrii Nakryiko 
4794f36e99a4SAndrii Nakryiko 		err = visit(&sec->sec_name_off, ctx);
4795f36e99a4SAndrii Nakryiko 		if (err)
4796f36e99a4SAndrii Nakryiko 			return err;
4797f36e99a4SAndrii Nakryiko 
4798f36e99a4SAndrii Nakryiko 		for_each_btf_ext_rec(seg, sec, i, rec) {
4799f36e99a4SAndrii Nakryiko 			err = visit(&rec->access_str_off, ctx);
4800f36e99a4SAndrii Nakryiko 			if (err)
4801f36e99a4SAndrii Nakryiko 				return err;
4802f36e99a4SAndrii Nakryiko 		}
4803f36e99a4SAndrii Nakryiko 	}
4804f36e99a4SAndrii Nakryiko 
4805f36e99a4SAndrii Nakryiko 	return 0;
4806f36e99a4SAndrii Nakryiko }
4807