xref: /linux/kernel/bpf/btf.c (revision 5a8cd539ac19f7a68e68e1d25ef9ca2ff55b8500)
1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (c) 2018 Facebook */
3 
4 #include <uapi/linux/btf.h>
5 #include <uapi/linux/bpf.h>
6 #include <uapi/linux/bpf_perf_event.h>
7 #include <uapi/linux/types.h>
8 #include <linux/seq_file.h>
9 #include <linux/compiler.h>
10 #include <linux/ctype.h>
11 #include <linux/errno.h>
12 #include <linux/slab.h>
13 #include <linux/anon_inodes.h>
14 #include <linux/file.h>
15 #include <linux/uaccess.h>
16 #include <linux/kernel.h>
17 #include <linux/idr.h>
18 #include <linux/sort.h>
19 #include <linux/bpf_verifier.h>
20 #include <linux/btf.h>
21 #include <linux/btf_ids.h>
22 #include <linux/bpf.h>
23 #include <linux/bpf_lsm.h>
24 #include <linux/skmsg.h>
25 #include <linux/perf_event.h>
26 #include <linux/bsearch.h>
27 #include <linux/kobject.h>
28 #include <linux/string.h>
29 #include <linux/sysfs.h>
30 #include <linux/overflow.h>
31 #include <linux/bitops.h>
32 
33 #include <net/netfilter/nf_bpf_link.h>
34 
35 #include <net/sock.h>
36 #include <net/xdp.h>
37 #include "../tools/lib/bpf/relo_core.h"
38 
39 /* BTF (BPF Type Format) is the meta data format which describes
40  * the data types of BPF program/map.  Hence, it basically focus
41  * on the C programming language which the modern BPF is primary
42  * using.
43  *
44  * ELF Section:
45  * ~~~~~~~~~~~
46  * The BTF data is stored under the ".BTF" ELF section
47  *
48  * struct btf_type:
49  * ~~~~~~~~~~~~~~~
50  * Each 'struct btf_type' object describes a C data type.
51  * Depending on the type it is describing, a 'struct btf_type'
52  * object may be followed by more data.  F.e.
53  * To describe an array, 'struct btf_type' is followed by
54  * 'struct btf_array'.
55  *
56  * 'struct btf_type' and any extra data following it are
57  * 4 bytes aligned.
58  *
59  * Type section:
60  * ~~~~~~~~~~~~~
61  * The BTF type section contains a list of 'struct btf_type' objects.
62  * Each one describes a C type.  Recall from the above section
63  * that a 'struct btf_type' object could be immediately followed by extra
64  * data in order to describe some particular C types.
65  *
66  * type_id:
67  * ~~~~~~~
68  * Each btf_type object is identified by a type_id.  The type_id
69  * is implicitly implied by the location of the btf_type object in
70  * the BTF type section.  The first one has type_id 1.  The second
71  * one has type_id 2...etc.  Hence, an earlier btf_type has
72  * a smaller type_id.
73  *
74  * A btf_type object may refer to another btf_type object by using
75  * type_id (i.e. the "type" in the "struct btf_type").
76  *
77  * NOTE that we cannot assume any reference-order.
78  * A btf_type object can refer to an earlier btf_type object
79  * but it can also refer to a later btf_type object.
80  *
81  * For example, to describe "const void *".  A btf_type
82  * object describing "const" may refer to another btf_type
83  * object describing "void *".  This type-reference is done
84  * by specifying type_id:
85  *
86  * [1] CONST (anon) type_id=2
87  * [2] PTR (anon) type_id=0
88  *
89  * The above is the btf_verifier debug log:
90  *   - Each line started with "[?]" is a btf_type object
91  *   - [?] is the type_id of the btf_type object.
92  *   - CONST/PTR is the BTF_KIND_XXX
93  *   - "(anon)" is the name of the type.  It just
94  *     happens that CONST and PTR has no name.
95  *   - type_id=XXX is the 'u32 type' in btf_type
96  *
97  * NOTE: "void" has type_id 0
98  *
99  * String section:
100  * ~~~~~~~~~~~~~~
101  * The BTF string section contains the names used by the type section.
102  * Each string is referred by an "offset" from the beginning of the
103  * string section.
104  *
105  * Each string is '\0' terminated.
106  *
107  * The first character in the string section must be '\0'
108  * which is used to mean 'anonymous'. Some btf_type may not
109  * have a name.
110  */
111 
112 /* BTF verification:
113  *
114  * To verify BTF data, two passes are needed.
115  *
116  * Pass #1
117  * ~~~~~~~
118  * The first pass is to collect all btf_type objects to
119  * an array: "btf->types".
120  *
121  * Depending on the C type that a btf_type is describing,
122  * a btf_type may be followed by extra data.  We don't know
123  * how many btf_type is there, and more importantly we don't
124  * know where each btf_type is located in the type section.
125  *
126  * Without knowing the location of each type_id, most verifications
127  * cannot be done.  e.g. an earlier btf_type may refer to a later
128  * btf_type (recall the "const void *" above), so we cannot
129  * check this type-reference in the first pass.
130  *
131  * In the first pass, it still does some verifications (e.g.
132  * checking the name is a valid offset to the string section).
133  *
134  * Pass #2
135  * ~~~~~~~
136  * The main focus is to resolve a btf_type that is referring
137  * to another type.
138  *
139  * We have to ensure the referring type:
140  * 1) does exist in the BTF (i.e. in btf->types[])
141  * 2) does not cause a loop:
142  *	struct A {
143  *		struct B b;
144  *	};
145  *
146  *	struct B {
147  *		struct A a;
148  *	};
149  *
150  * btf_type_needs_resolve() decides if a btf_type needs
151  * to be resolved.
152  *
153  * The needs_resolve type implements the "resolve()" ops which
154  * essentially does a DFS and detects backedge.
155  *
156  * During resolve (or DFS), different C types have different
157  * "RESOLVED" conditions.
158  *
159  * When resolving a BTF_KIND_STRUCT, we need to resolve all its
160  * members because a member is always referring to another
161  * type.  A struct's member can be treated as "RESOLVED" if
162  * it is referring to a BTF_KIND_PTR.  Otherwise, the
163  * following valid C struct would be rejected:
164  *
165  *	struct A {
166  *		int m;
167  *		struct A *a;
168  *	};
169  *
170  * When resolving a BTF_KIND_PTR, it needs to keep resolving if
171  * it is referring to another BTF_KIND_PTR.  Otherwise, we cannot
172  * detect a pointer loop, e.g.:
173  * BTF_KIND_CONST -> BTF_KIND_PTR -> BTF_KIND_CONST -> BTF_KIND_PTR +
174  *                        ^                                         |
175  *                        +-----------------------------------------+
176  *
177  */
178 
179 #define BITS_PER_U128 (sizeof(u64) * BITS_PER_BYTE * 2)
180 #define BITS_PER_BYTE_MASK (BITS_PER_BYTE - 1)
181 #define BITS_PER_BYTE_MASKED(bits) ((bits) & BITS_PER_BYTE_MASK)
182 #define BITS_ROUNDDOWN_BYTES(bits) ((bits) >> 3)
183 #define BITS_ROUNDUP_BYTES(bits) \
184 	(BITS_ROUNDDOWN_BYTES(bits) + !!BITS_PER_BYTE_MASKED(bits))
185 
186 #define BTF_INT_MASK 0x0fffffff
187 #define BTF_TYPE_ID_VALID(type_id) ((type_id) <= BTF_MAX_TYPE)
188 #define BTF_STR_OFFSET_VALID(name_off) ((name_off) <= BTF_MAX_NAME_OFFSET)
189 
190 /* 16MB for 64k structs and each has 16 members and
191  * a few MB spaces for the string section.
192  * The hard limit is S32_MAX.
193  */
194 #define BTF_MAX_SIZE (16 * 1024 * 1024)
195 
196 #define for_each_member_from(i, from, struct_type, member)		\
197 	for (i = from, member = btf_type_member(struct_type) + from;	\
198 	     i < btf_type_vlen(struct_type);				\
199 	     i++, member++)
200 
201 #define for_each_vsi_from(i, from, struct_type, member)				\
202 	for (i = from, member = btf_type_var_secinfo(struct_type) + from;	\
203 	     i < btf_type_vlen(struct_type);					\
204 	     i++, member++)
205 
206 DEFINE_IDR(btf_idr);
207 DEFINE_SPINLOCK(btf_idr_lock);
208 
209 enum btf_kfunc_hook {
210 	BTF_KFUNC_HOOK_COMMON,
211 	BTF_KFUNC_HOOK_XDP,
212 	BTF_KFUNC_HOOK_TC,
213 	BTF_KFUNC_HOOK_STRUCT_OPS,
214 	BTF_KFUNC_HOOK_TRACING,
215 	BTF_KFUNC_HOOK_SYSCALL,
216 	BTF_KFUNC_HOOK_FMODRET,
217 	BTF_KFUNC_HOOK_CGROUP,
218 	BTF_KFUNC_HOOK_SCHED_ACT,
219 	BTF_KFUNC_HOOK_SK_SKB,
220 	BTF_KFUNC_HOOK_SOCKET_FILTER,
221 	BTF_KFUNC_HOOK_LWT,
222 	BTF_KFUNC_HOOK_NETFILTER,
223 	BTF_KFUNC_HOOK_KPROBE,
224 	BTF_KFUNC_HOOK_MAX,
225 };
226 
227 enum {
228 	BTF_KFUNC_SET_MAX_CNT = 256,
229 	BTF_DTOR_KFUNC_MAX_CNT = 256,
230 	BTF_KFUNC_FILTER_MAX_CNT = 16,
231 };
232 
233 struct btf_kfunc_hook_filter {
234 	btf_kfunc_filter_t filters[BTF_KFUNC_FILTER_MAX_CNT];
235 	u32 nr_filters;
236 };
237 
238 struct btf_kfunc_set_tab {
239 	struct btf_id_set8 *sets[BTF_KFUNC_HOOK_MAX];
240 	struct btf_kfunc_hook_filter hook_filters[BTF_KFUNC_HOOK_MAX];
241 };
242 
243 struct btf_id_dtor_kfunc_tab {
244 	u32 cnt;
245 	struct btf_id_dtor_kfunc dtors[];
246 };
247 
248 struct btf_struct_ops_tab {
249 	u32 cnt;
250 	u32 capacity;
251 	struct bpf_struct_ops_desc ops[];
252 };
253 
254 struct btf {
255 	void *data;
256 	struct btf_type **types;
257 	u32 *resolved_ids;
258 	u32 *resolved_sizes;
259 	const char *strings;
260 	void *nohdr_data;
261 	struct btf_header hdr;
262 	u32 nr_types; /* includes VOID for base BTF */
263 	u32 named_start_id;
264 	u32 types_size;
265 	u32 data_size;
266 	refcount_t refcnt;
267 	u32 id;
268 	struct rcu_head rcu;
269 	struct btf_kfunc_set_tab *kfunc_set_tab;
270 	struct btf_id_dtor_kfunc_tab *dtor_kfunc_tab;
271 	struct btf_struct_metas *struct_meta_tab;
272 	struct btf_struct_ops_tab *struct_ops_tab;
273 	struct btf_layout *layout;
274 
275 	/* split BTF support */
276 	struct btf *base_btf;
277 	u32 start_id; /* first type ID in this BTF (0 for base BTF) */
278 	u32 start_str_off; /* first string offset (0 for base BTF) */
279 	char name[MODULE_NAME_LEN];
280 	bool kernel_btf;
281 	__u32 *base_id_map; /* map from distilled base BTF -> vmlinux BTF ids */
282 };
283 
284 enum verifier_phase {
285 	CHECK_META,
286 	CHECK_TYPE,
287 };
288 
289 struct resolve_vertex {
290 	const struct btf_type *t;
291 	u32 type_id;
292 	u32 next_member;
293 };
294 
295 enum visit_state {
296 	NOT_VISITED,
297 	VISITED,
298 	RESOLVED,
299 };
300 
301 enum resolve_mode {
302 	RESOLVE_TBD,	/* To Be Determined */
303 	RESOLVE_PTR,	/* Resolving for Pointer */
304 	RESOLVE_STRUCT_OR_ARRAY,	/* Resolving for struct/union
305 					 * or array
306 					 */
307 };
308 
309 #define MAX_RESOLVE_DEPTH 32
310 
311 struct btf_sec_info {
312 	u32 off;
313 	u32 len;
314 };
315 
316 struct btf_verifier_env {
317 	struct btf *btf;
318 	u8 *visit_states;
319 	struct resolve_vertex stack[MAX_RESOLVE_DEPTH];
320 	struct bpf_verifier_log log;
321 	u32 log_type_id;
322 	u32 top_stack;
323 	enum verifier_phase phase;
324 	enum resolve_mode resolve_mode;
325 };
326 
327 static const char * const btf_kind_str[NR_BTF_KINDS] = {
328 	[BTF_KIND_UNKN]		= "UNKNOWN",
329 	[BTF_KIND_INT]		= "INT",
330 	[BTF_KIND_PTR]		= "PTR",
331 	[BTF_KIND_ARRAY]	= "ARRAY",
332 	[BTF_KIND_STRUCT]	= "STRUCT",
333 	[BTF_KIND_UNION]	= "UNION",
334 	[BTF_KIND_ENUM]		= "ENUM",
335 	[BTF_KIND_FWD]		= "FWD",
336 	[BTF_KIND_TYPEDEF]	= "TYPEDEF",
337 	[BTF_KIND_VOLATILE]	= "VOLATILE",
338 	[BTF_KIND_CONST]	= "CONST",
339 	[BTF_KIND_RESTRICT]	= "RESTRICT",
340 	[BTF_KIND_FUNC]		= "FUNC",
341 	[BTF_KIND_FUNC_PROTO]	= "FUNC_PROTO",
342 	[BTF_KIND_VAR]		= "VAR",
343 	[BTF_KIND_DATASEC]	= "DATASEC",
344 	[BTF_KIND_FLOAT]	= "FLOAT",
345 	[BTF_KIND_DECL_TAG]	= "DECL_TAG",
346 	[BTF_KIND_TYPE_TAG]	= "TYPE_TAG",
347 	[BTF_KIND_ENUM64]	= "ENUM64",
348 };
349 
btf_type_str(const struct btf_type * t)350 const char *btf_type_str(const struct btf_type *t)
351 {
352 	return btf_kind_str[BTF_INFO_KIND(t->info)];
353 }
354 
355 /* Chunk size we use in safe copy of data to be shown. */
356 #define BTF_SHOW_OBJ_SAFE_SIZE		32
357 
358 /*
359  * This is the maximum size of a base type value (equivalent to a
360  * 128-bit int); if we are at the end of our safe buffer and have
361  * less than 16 bytes space we can't be assured of being able
362  * to copy the next type safely, so in such cases we will initiate
363  * a new copy.
364  */
365 #define BTF_SHOW_OBJ_BASE_TYPE_SIZE	16
366 
367 /* Type name size */
368 #define BTF_SHOW_NAME_SIZE		80
369 
370 /*
371  * The suffix of a type that indicates it cannot alias another type when
372  * comparing BTF IDs for kfunc invocations.
373  */
374 #define NOCAST_ALIAS_SUFFIX		"___init"
375 
376 /*
377  * Common data to all BTF show operations. Private show functions can add
378  * their own data to a structure containing a struct btf_show and consult it
379  * in the show callback.  See btf_type_show() below.
380  *
381  * One challenge with showing nested data is we want to skip 0-valued
382  * data, but in order to figure out whether a nested object is all zeros
383  * we need to walk through it.  As a result, we need to make two passes
384  * when handling structs, unions and arrays; the first path simply looks
385  * for nonzero data, while the second actually does the display.  The first
386  * pass is signalled by show->state.depth_check being set, and if we
387  * encounter a non-zero value we set show->state.depth_to_show to
388  * the depth at which we encountered it.  When we have completed the
389  * first pass, we will know if anything needs to be displayed if
390  * depth_to_show > depth.  See btf_[struct,array]_show() for the
391  * implementation of this.
392  *
393  * Another problem is we want to ensure the data for display is safe to
394  * access.  To support this, the anonymous "struct {} obj" tracks the data
395  * object and our safe copy of it.  We copy portions of the data needed
396  * to the object "copy" buffer, but because its size is limited to
397  * BTF_SHOW_OBJ_COPY_LEN bytes, multiple copies may be required as we
398  * traverse larger objects for display.
399  *
400  * The various data type show functions all start with a call to
401  * btf_show_start_type() which returns a pointer to the safe copy
402  * of the data needed (or if BTF_SHOW_UNSAFE is specified, to the
403  * raw data itself).  btf_show_obj_safe() is responsible for
404  * using copy_from_kernel_nofault() to update the safe data if necessary
405  * as we traverse the object's data.  skbuff-like semantics are
406  * used:
407  *
408  * - obj.head points to the start of the toplevel object for display
409  * - obj.size is the size of the toplevel object
410  * - obj.data points to the current point in the original data at
411  *   which our safe data starts.  obj.data will advance as we copy
412  *   portions of the data.
413  *
414  * In most cases a single copy will suffice, but larger data structures
415  * such as "struct task_struct" will require many copies.  The logic in
416  * btf_show_obj_safe() handles the logic that determines if a new
417  * copy_from_kernel_nofault() is needed.
418  */
419 struct btf_show {
420 	u64 flags;
421 	void *target;	/* target of show operation (seq file, buffer) */
422 	__printf(2, 0) void (*showfn)(struct btf_show *show, const char *fmt, va_list args);
423 	const struct btf *btf;
424 	/* below are used during iteration */
425 	struct {
426 		u8 depth;
427 		u8 depth_to_show;
428 		u8 depth_check;
429 		u8 array_member:1,
430 		   array_terminated:1;
431 		u16 array_encoding;
432 		u32 type_id;
433 		int status;			/* non-zero for error */
434 		const struct btf_type *type;
435 		const struct btf_member *member;
436 		char name[BTF_SHOW_NAME_SIZE];	/* space for member name/type */
437 	} state;
438 	struct {
439 		u32 size;
440 		void *head;
441 		void *data;
442 		u8 safe[BTF_SHOW_OBJ_SAFE_SIZE];
443 	} obj;
444 };
445 
446 struct btf_kind_operations {
447 	s32 (*check_meta)(struct btf_verifier_env *env,
448 			  const struct btf_type *t,
449 			  u32 meta_left);
450 	int (*resolve)(struct btf_verifier_env *env,
451 		       const struct resolve_vertex *v);
452 	int (*check_member)(struct btf_verifier_env *env,
453 			    const struct btf_type *struct_type,
454 			    const struct btf_member *member,
455 			    const struct btf_type *member_type);
456 	int (*check_kflag_member)(struct btf_verifier_env *env,
457 				  const struct btf_type *struct_type,
458 				  const struct btf_member *member,
459 				  const struct btf_type *member_type);
460 	void (*log_details)(struct btf_verifier_env *env,
461 			    const struct btf_type *t);
462 	void (*show)(const struct btf *btf, const struct btf_type *t,
463 			 u32 type_id, void *data, u8 bits_offsets,
464 			 struct btf_show *show);
465 };
466 
467 static const struct btf_kind_operations * const kind_ops[NR_BTF_KINDS];
468 static struct btf_type btf_void;
469 
470 static int btf_resolve(struct btf_verifier_env *env,
471 		       const struct btf_type *t, u32 type_id);
472 
473 static int btf_func_check(struct btf_verifier_env *env,
474 			  const struct btf_type *t);
475 
btf_type_is_modifier(const struct btf_type * t)476 static bool btf_type_is_modifier(const struct btf_type *t)
477 {
478 	/* Some of them is not strictly a C modifier
479 	 * but they are grouped into the same bucket
480 	 * for BTF concern:
481 	 *   A type (t) that refers to another
482 	 *   type through t->type AND its size cannot
483 	 *   be determined without following the t->type.
484 	 *
485 	 * ptr does not fall into this bucket
486 	 * because its size is always sizeof(void *).
487 	 */
488 	switch (BTF_INFO_KIND(t->info)) {
489 	case BTF_KIND_TYPEDEF:
490 	case BTF_KIND_VOLATILE:
491 	case BTF_KIND_CONST:
492 	case BTF_KIND_RESTRICT:
493 	case BTF_KIND_TYPE_TAG:
494 		return true;
495 	}
496 
497 	return false;
498 }
499 
btf_start_id(const struct btf * btf)500 static int btf_start_id(const struct btf *btf)
501 {
502 	return btf->start_id + (btf->base_btf ? 0 : 1);
503 }
504 
btf_type_is_void(const struct btf_type * t)505 bool btf_type_is_void(const struct btf_type *t)
506 {
507 	return t == &btf_void;
508 }
509 
btf_type_is_datasec(const struct btf_type * t)510 static bool btf_type_is_datasec(const struct btf_type *t)
511 {
512 	return BTF_INFO_KIND(t->info) == BTF_KIND_DATASEC;
513 }
514 
btf_type_is_decl_tag(const struct btf_type * t)515 static bool btf_type_is_decl_tag(const struct btf_type *t)
516 {
517 	return BTF_INFO_KIND(t->info) == BTF_KIND_DECL_TAG;
518 }
519 
btf_type_nosize(const struct btf_type * t)520 static bool btf_type_nosize(const struct btf_type *t)
521 {
522 	return btf_type_is_void(t) || btf_type_is_fwd(t) ||
523 	       btf_type_is_func(t) || btf_type_is_func_proto(t) ||
524 	       btf_type_is_decl_tag(t);
525 }
526 
btf_type_nosize_or_null(const struct btf_type * t)527 static bool btf_type_nosize_or_null(const struct btf_type *t)
528 {
529 	return !t || btf_type_nosize(t);
530 }
531 
btf_type_is_decl_tag_target(const struct btf_type * t)532 static bool btf_type_is_decl_tag_target(const struct btf_type *t)
533 {
534 	return btf_type_is_func(t) || btf_type_is_struct(t) ||
535 	       btf_type_is_var(t) || btf_type_is_typedef(t);
536 }
537 
btf_is_vmlinux(const struct btf * btf)538 bool btf_is_vmlinux(const struct btf *btf)
539 {
540 	return btf->kernel_btf && !btf->base_btf;
541 }
542 
btf_nr_types(const struct btf * btf)543 u32 btf_nr_types(const struct btf *btf)
544 {
545 	u32 total = 0;
546 
547 	while (btf) {
548 		total += btf->nr_types;
549 		btf = btf->base_btf;
550 	}
551 
552 	return total;
553 }
554 
555 /*
556  * Note that vmlinux and kernel module BTFs are always sorted
557  * during the building phase.
558  */
btf_check_sorted(struct btf * btf)559 static void btf_check_sorted(struct btf *btf)
560 {
561 	u32 i, n, named_start_id = 0;
562 
563 	n = btf_nr_types(btf);
564 	if (btf_is_vmlinux(btf)) {
565 		for (i = btf_start_id(btf); i < n; i++) {
566 			const struct btf_type *t = btf_type_by_id(btf, i);
567 			const char *n = btf_name_by_offset(btf, t->name_off);
568 
569 			if (n[0] != '\0') {
570 				btf->named_start_id = i;
571 				return;
572 			}
573 		}
574 		return;
575 	}
576 
577 	for (i = btf_start_id(btf) + 1; i < n; i++) {
578 		const struct btf_type *ta = btf_type_by_id(btf, i - 1);
579 		const struct btf_type *tb = btf_type_by_id(btf, i);
580 		const char *na = btf_name_by_offset(btf, ta->name_off);
581 		const char *nb = btf_name_by_offset(btf, tb->name_off);
582 
583 		if (strcmp(na, nb) > 0)
584 			return;
585 
586 		if (named_start_id == 0 && na[0] != '\0')
587 			named_start_id = i - 1;
588 		if (named_start_id == 0 && nb[0] != '\0')
589 			named_start_id = i;
590 	}
591 
592 	if (named_start_id)
593 		btf->named_start_id = named_start_id;
594 }
595 
596 /*
597  * btf_named_start_id - Get the named starting ID for the BTF
598  * @btf: Pointer to the target BTF object
599  * @own: Flag indicating whether to query only the current BTF (true = current BTF only,
600  *       false = recursively traverse the base BTF chain)
601  *
602  * Return value rules:
603  * 1. For a sorted btf, return its named_start_id
604  * 2. Else for a split BTF, return its start_id
605  * 3. Else for a base BTF, return 1
606  */
btf_named_start_id(const struct btf * btf,bool own)607 u32 btf_named_start_id(const struct btf *btf, bool own)
608 {
609 	const struct btf *base_btf = btf;
610 
611 	while (!own && base_btf->base_btf)
612 		base_btf = base_btf->base_btf;
613 
614 	return base_btf->named_start_id ?: (base_btf->start_id ?: 1);
615 }
616 
btf_find_by_name_kind_bsearch(const struct btf * btf,const char * name)617 static s32 btf_find_by_name_kind_bsearch(const struct btf *btf, const char *name)
618 {
619 	const struct btf_type *t;
620 	const char *tname;
621 	s32 l, r, m;
622 
623 	l = btf_named_start_id(btf, true);
624 	r = btf_nr_types(btf) - 1;
625 	while (l <= r) {
626 		m = l + (r - l) / 2;
627 		t = btf_type_by_id(btf, m);
628 		tname = btf_name_by_offset(btf, t->name_off);
629 		if (strcmp(tname, name) >= 0) {
630 			if (l == r)
631 				return r;
632 			r = m;
633 		} else {
634 			l = m + 1;
635 		}
636 	}
637 
638 	return btf_nr_types(btf);
639 }
640 
btf_find_by_name_kind(const struct btf * btf,const char * name,u8 kind)641 s32 btf_find_by_name_kind(const struct btf *btf, const char *name, u8 kind)
642 {
643 	const struct btf *base_btf = btf_base_btf(btf);
644 	const struct btf_type *t;
645 	const char *tname;
646 	s32 id, total;
647 
648 	if (base_btf) {
649 		id = btf_find_by_name_kind(base_btf, name, kind);
650 		if (id > 0)
651 			return id;
652 	}
653 
654 	total = btf_nr_types(btf);
655 	if (btf->named_start_id > 0 && name[0]) {
656 		id = btf_find_by_name_kind_bsearch(btf, name);
657 		for (; id < total; id++) {
658 			t = btf_type_by_id(btf, id);
659 			tname = btf_name_by_offset(btf, t->name_off);
660 			if (strcmp(tname, name) != 0)
661 				return -ENOENT;
662 			if (BTF_INFO_KIND(t->info) == kind)
663 				return id;
664 		}
665 	} else {
666 		for (id = btf_start_id(btf); id < total; id++) {
667 			t = btf_type_by_id(btf, id);
668 			if (BTF_INFO_KIND(t->info) != kind)
669 				continue;
670 			tname = btf_name_by_offset(btf, t->name_off);
671 			if (strcmp(tname, name) == 0)
672 				return id;
673 		}
674 	}
675 
676 	return -ENOENT;
677 }
678 
bpf_find_btf_id(const char * name,u32 kind,struct btf ** btf_p)679 s32 bpf_find_btf_id(const char *name, u32 kind, struct btf **btf_p)
680 {
681 	struct btf *btf;
682 	s32 ret;
683 	int id;
684 
685 	btf = bpf_get_btf_vmlinux();
686 	if (IS_ERR(btf))
687 		return PTR_ERR(btf);
688 	if (!btf)
689 		return -EINVAL;
690 
691 	ret = btf_find_by_name_kind(btf, name, kind);
692 	/* ret is never zero, since btf_find_by_name_kind returns
693 	 * positive btf_id or negative error.
694 	 */
695 	if (ret > 0) {
696 		btf_get(btf);
697 		*btf_p = btf;
698 		return ret;
699 	}
700 
701 	/* If name is not found in vmlinux's BTF then search in module's BTFs */
702 	spin_lock_bh(&btf_idr_lock);
703 	idr_for_each_entry(&btf_idr, btf, id) {
704 		if (!btf_is_module(btf))
705 			continue;
706 		/* linear search could be slow hence unlock/lock
707 		 * the IDR to avoiding holding it for too long
708 		 */
709 		btf_get(btf);
710 		spin_unlock_bh(&btf_idr_lock);
711 		ret = btf_find_by_name_kind(btf, name, kind);
712 		if (ret > 0) {
713 			*btf_p = btf;
714 			return ret;
715 		}
716 		btf_put(btf);
717 		spin_lock_bh(&btf_idr_lock);
718 	}
719 	spin_unlock_bh(&btf_idr_lock);
720 	return ret;
721 }
722 EXPORT_SYMBOL_GPL(bpf_find_btf_id);
723 
btf_type_skip_modifiers(const struct btf * btf,u32 id,u32 * res_id)724 const struct btf_type *btf_type_skip_modifiers(const struct btf *btf,
725 					       u32 id, u32 *res_id)
726 {
727 	const struct btf_type *t = btf_type_by_id(btf, id);
728 
729 	while (btf_type_is_modifier(t)) {
730 		id = t->type;
731 		t = btf_type_by_id(btf, t->type);
732 	}
733 
734 	if (res_id)
735 		*res_id = id;
736 
737 	return t;
738 }
739 
btf_type_resolve_ptr(const struct btf * btf,u32 id,u32 * res_id)740 const struct btf_type *btf_type_resolve_ptr(const struct btf *btf,
741 					    u32 id, u32 *res_id)
742 {
743 	const struct btf_type *t;
744 
745 	t = btf_type_skip_modifiers(btf, id, NULL);
746 	if (!btf_type_is_ptr(t))
747 		return NULL;
748 
749 	return btf_type_skip_modifiers(btf, t->type, res_id);
750 }
751 
btf_type_resolve_func_ptr(const struct btf * btf,u32 id,u32 * res_id)752 const struct btf_type *btf_type_resolve_func_ptr(const struct btf *btf,
753 						 u32 id, u32 *res_id)
754 {
755 	const struct btf_type *ptype;
756 
757 	ptype = btf_type_resolve_ptr(btf, id, res_id);
758 	if (ptype && btf_type_is_func_proto(ptype))
759 		return ptype;
760 
761 	return NULL;
762 }
763 
764 /* Types that act only as a source, not sink or intermediate
765  * type when resolving.
766  */
btf_type_is_resolve_source_only(const struct btf_type * t)767 static bool btf_type_is_resolve_source_only(const struct btf_type *t)
768 {
769 	return btf_type_is_var(t) ||
770 	       btf_type_is_decl_tag(t) ||
771 	       btf_type_is_datasec(t);
772 }
773 
774 /* What types need to be resolved?
775  *
776  * btf_type_is_modifier() is an obvious one.
777  *
778  * btf_type_is_struct() because its member refers to
779  * another type (through member->type).
780  *
781  * btf_type_is_var() because the variable refers to
782  * another type. btf_type_is_datasec() holds multiple
783  * btf_type_is_var() types that need resolving.
784  *
785  * btf_type_is_array() because its element (array->type)
786  * refers to another type.  Array can be thought of a
787  * special case of struct while array just has the same
788  * member-type repeated by array->nelems of times.
789  */
btf_type_needs_resolve(const struct btf_type * t)790 static bool btf_type_needs_resolve(const struct btf_type *t)
791 {
792 	return btf_type_is_modifier(t) ||
793 	       btf_type_is_ptr(t) ||
794 	       btf_type_is_struct(t) ||
795 	       btf_type_is_array(t) ||
796 	       btf_type_is_var(t) ||
797 	       btf_type_is_func(t) ||
798 	       btf_type_is_decl_tag(t) ||
799 	       btf_type_is_datasec(t);
800 }
801 
802 /* t->size can be used */
btf_type_has_size(const struct btf_type * t)803 static bool btf_type_has_size(const struct btf_type *t)
804 {
805 	switch (BTF_INFO_KIND(t->info)) {
806 	case BTF_KIND_INT:
807 	case BTF_KIND_STRUCT:
808 	case BTF_KIND_UNION:
809 	case BTF_KIND_ENUM:
810 	case BTF_KIND_DATASEC:
811 	case BTF_KIND_FLOAT:
812 	case BTF_KIND_ENUM64:
813 		return true;
814 	}
815 
816 	return false;
817 }
818 
btf_int_encoding_str(u8 encoding)819 static const char *btf_int_encoding_str(u8 encoding)
820 {
821 	if (encoding == 0)
822 		return "(none)";
823 	else if (encoding == BTF_INT_SIGNED)
824 		return "SIGNED";
825 	else if (encoding == BTF_INT_CHAR)
826 		return "CHAR";
827 	else if (encoding == BTF_INT_BOOL)
828 		return "BOOL";
829 	else
830 		return "UNKN";
831 }
832 
btf_type_int(const struct btf_type * t)833 static u32 btf_type_int(const struct btf_type *t)
834 {
835 	return *(u32 *)(t + 1);
836 }
837 
btf_type_array(const struct btf_type * t)838 static const struct btf_array *btf_type_array(const struct btf_type *t)
839 {
840 	return (const struct btf_array *)(t + 1);
841 }
842 
btf_type_enum(const struct btf_type * t)843 static const struct btf_enum *btf_type_enum(const struct btf_type *t)
844 {
845 	return (const struct btf_enum *)(t + 1);
846 }
847 
btf_type_var(const struct btf_type * t)848 static const struct btf_var *btf_type_var(const struct btf_type *t)
849 {
850 	return (const struct btf_var *)(t + 1);
851 }
852 
btf_type_decl_tag(const struct btf_type * t)853 static const struct btf_decl_tag *btf_type_decl_tag(const struct btf_type *t)
854 {
855 	return (const struct btf_decl_tag *)(t + 1);
856 }
857 
btf_type_enum64(const struct btf_type * t)858 static const struct btf_enum64 *btf_type_enum64(const struct btf_type *t)
859 {
860 	return (const struct btf_enum64 *)(t + 1);
861 }
862 
btf_type_ops(const struct btf_type * t)863 static const struct btf_kind_operations *btf_type_ops(const struct btf_type *t)
864 {
865 	return kind_ops[BTF_INFO_KIND(t->info)];
866 }
867 
btf_name_offset_valid(const struct btf * btf,u32 offset)868 static bool btf_name_offset_valid(const struct btf *btf, u32 offset)
869 {
870 	if (!BTF_STR_OFFSET_VALID(offset))
871 		return false;
872 
873 	while (offset < btf->start_str_off)
874 		btf = btf->base_btf;
875 
876 	offset -= btf->start_str_off;
877 	return offset < btf->hdr.str_len;
878 }
879 
__btf_name_char_ok(char c,bool first)880 static bool __btf_name_char_ok(char c, bool first)
881 {
882 	if ((first ? !isalpha(c) :
883 		     !isalnum(c)) &&
884 	    c != '_' &&
885 	    c != '.')
886 		return false;
887 	return true;
888 }
889 
btf_str_by_offset(const struct btf * btf,u32 offset)890 const char *btf_str_by_offset(const struct btf *btf, u32 offset)
891 {
892 	while (offset < btf->start_str_off)
893 		btf = btf->base_btf;
894 
895 	offset -= btf->start_str_off;
896 	if (offset < btf->hdr.str_len)
897 		return &btf->strings[offset];
898 
899 	return NULL;
900 }
901 
btf_name_valid_identifier(const struct btf * btf,u32 offset)902 static bool btf_name_valid_identifier(const struct btf *btf, u32 offset)
903 {
904 	/* offset must be valid */
905 	const char *src = btf_str_by_offset(btf, offset);
906 	const char *src_limit;
907 
908 	if (!__btf_name_char_ok(*src, true))
909 		return false;
910 
911 	/* set a limit on identifier length */
912 	src_limit = src + KSYM_NAME_LEN;
913 	src++;
914 	while (*src && src < src_limit) {
915 		if (!__btf_name_char_ok(*src, false))
916 			return false;
917 		src++;
918 	}
919 
920 	return !*src;
921 }
922 
923 /* Allow any printable character in DATASEC names */
btf_name_valid_section(const struct btf * btf,u32 offset)924 static bool btf_name_valid_section(const struct btf *btf, u32 offset)
925 {
926 	/* offset must be valid */
927 	const char *src = btf_str_by_offset(btf, offset);
928 	const char *src_limit;
929 
930 	if (!*src)
931 		return false;
932 
933 	/* set a limit on identifier length */
934 	src_limit = src + KSYM_NAME_LEN;
935 	while (*src && src < src_limit) {
936 		if (!isprint(*src))
937 			return false;
938 		src++;
939 	}
940 
941 	return !*src;
942 }
943 
__btf_name_by_offset(const struct btf * btf,u32 offset)944 static const char *__btf_name_by_offset(const struct btf *btf, u32 offset)
945 {
946 	const char *name;
947 
948 	if (!offset)
949 		return "(anon)";
950 
951 	name = btf_str_by_offset(btf, offset);
952 	return name ?: "(invalid-name-offset)";
953 }
954 
btf_name_by_offset(const struct btf * btf,u32 offset)955 const char *btf_name_by_offset(const struct btf *btf, u32 offset)
956 {
957 	return btf_str_by_offset(btf, offset);
958 }
959 
btf_type_by_id(const struct btf * btf,u32 type_id)960 const struct btf_type *btf_type_by_id(const struct btf *btf, u32 type_id)
961 {
962 	while (type_id < btf->start_id)
963 		btf = btf->base_btf;
964 
965 	type_id -= btf->start_id;
966 	if (type_id >= btf->nr_types)
967 		return NULL;
968 	return btf->types[type_id];
969 }
970 EXPORT_SYMBOL_GPL(btf_type_by_id);
971 
972 /*
973  * Check that the type @t is a regular int. This means that @t is not
974  * a bit field and it has the same size as either of u8/u16/u32/u64
975  * or __int128. If @expected_size is not zero, then size of @t should
976  * be the same. A caller should already have checked that the type @t
977  * is an integer.
978  */
__btf_type_int_is_regular(const struct btf_type * t,size_t expected_size)979 static bool __btf_type_int_is_regular(const struct btf_type *t, size_t expected_size)
980 {
981 	u32 int_data = btf_type_int(t);
982 	u8 nr_bits = BTF_INT_BITS(int_data);
983 	u8 nr_bytes = BITS_ROUNDUP_BYTES(nr_bits);
984 
985 	return BITS_PER_BYTE_MASKED(nr_bits) == 0 &&
986 	       BTF_INT_OFFSET(int_data) == 0 &&
987 	       (nr_bytes <= 16 && is_power_of_2(nr_bytes)) &&
988 	       (expected_size == 0 || nr_bytes == expected_size);
989 }
990 
btf_type_int_is_regular(const struct btf_type * t)991 static bool btf_type_int_is_regular(const struct btf_type *t)
992 {
993 	return __btf_type_int_is_regular(t, 0);
994 }
995 
btf_type_is_i32(const struct btf_type * t)996 bool btf_type_is_i32(const struct btf_type *t)
997 {
998 	return btf_type_is_int(t) && __btf_type_int_is_regular(t, 4);
999 }
1000 
btf_type_is_i64(const struct btf_type * t)1001 bool btf_type_is_i64(const struct btf_type *t)
1002 {
1003 	return btf_type_is_int(t) && __btf_type_int_is_regular(t, 8);
1004 }
1005 
btf_type_is_primitive(const struct btf_type * t)1006 bool btf_type_is_primitive(const struct btf_type *t)
1007 {
1008 	return (btf_type_is_int(t) && btf_type_int_is_regular(t)) ||
1009 	       btf_is_any_enum(t);
1010 }
1011 
1012 /*
1013  * Check that given struct member is a regular int with expected
1014  * offset and size.
1015  */
btf_member_is_reg_int(const struct btf * btf,const struct btf_type * s,const struct btf_member * m,u32 expected_offset,u32 expected_size)1016 bool btf_member_is_reg_int(const struct btf *btf, const struct btf_type *s,
1017 			   const struct btf_member *m,
1018 			   u32 expected_offset, u32 expected_size)
1019 {
1020 	const struct btf_type *t;
1021 	u32 id, int_data;
1022 	u8 nr_bits;
1023 
1024 	id = m->type;
1025 	t = btf_type_id_size(btf, &id, NULL);
1026 	if (!t || !btf_type_is_int(t))
1027 		return false;
1028 
1029 	int_data = btf_type_int(t);
1030 	nr_bits = BTF_INT_BITS(int_data);
1031 	if (btf_type_kflag(s)) {
1032 		u32 bitfield_size = BTF_MEMBER_BITFIELD_SIZE(m->offset);
1033 		u32 bit_offset = BTF_MEMBER_BIT_OFFSET(m->offset);
1034 
1035 		/* if kflag set, int should be a regular int and
1036 		 * bit offset should be at byte boundary.
1037 		 */
1038 		return !bitfield_size &&
1039 		       BITS_ROUNDUP_BYTES(bit_offset) == expected_offset &&
1040 		       BITS_ROUNDUP_BYTES(nr_bits) == expected_size;
1041 	}
1042 
1043 	if (BTF_INT_OFFSET(int_data) ||
1044 	    BITS_PER_BYTE_MASKED(m->offset) ||
1045 	    BITS_ROUNDUP_BYTES(m->offset) != expected_offset ||
1046 	    BITS_PER_BYTE_MASKED(nr_bits) ||
1047 	    BITS_ROUNDUP_BYTES(nr_bits) != expected_size)
1048 		return false;
1049 
1050 	return true;
1051 }
1052 
1053 /* Similar to btf_type_skip_modifiers() but does not skip typedefs. */
btf_type_skip_qualifiers(const struct btf * btf,u32 id)1054 static const struct btf_type *btf_type_skip_qualifiers(const struct btf *btf,
1055 						       u32 id)
1056 {
1057 	const struct btf_type *t = btf_type_by_id(btf, id);
1058 
1059 	while (btf_type_is_modifier(t) &&
1060 	       BTF_INFO_KIND(t->info) != BTF_KIND_TYPEDEF) {
1061 		t = btf_type_by_id(btf, t->type);
1062 	}
1063 
1064 	return t;
1065 }
1066 
1067 #define BTF_SHOW_MAX_ITER	10
1068 
1069 #define BTF_KIND_BIT(kind)	(1ULL << kind)
1070 
1071 /*
1072  * Populate show->state.name with type name information.
1073  * Format of type name is
1074  *
1075  * [.member_name = ] (type_name)
1076  */
btf_show_name(struct btf_show * show)1077 static const char *btf_show_name(struct btf_show *show)
1078 {
1079 	/* BTF_MAX_ITER array suffixes "[]" */
1080 	const char *array_suffixes = "[][][][][][][][][][]";
1081 	const char *array_suffix = &array_suffixes[strlen(array_suffixes)];
1082 	/* BTF_MAX_ITER pointer suffixes "*" */
1083 	const char *ptr_suffixes = "**********";
1084 	const char *ptr_suffix = &ptr_suffixes[strlen(ptr_suffixes)];
1085 	const char *name = NULL, *prefix = "", *parens = "";
1086 	const struct btf_member *m = show->state.member;
1087 	const struct btf_type *t;
1088 	const struct btf_array *array;
1089 	u32 id = show->state.type_id;
1090 	const char *member = NULL;
1091 	bool show_member = false;
1092 	u64 kinds = 0;
1093 	int i;
1094 
1095 	show->state.name[0] = '\0';
1096 
1097 	/*
1098 	 * Don't show type name if we're showing an array member;
1099 	 * in that case we show the array type so don't need to repeat
1100 	 * ourselves for each member.
1101 	 */
1102 	if (show->state.array_member)
1103 		return "";
1104 
1105 	/* Retrieve member name, if any. */
1106 	if (m) {
1107 		member = btf_name_by_offset(show->btf, m->name_off);
1108 		show_member = strlen(member) > 0;
1109 		id = m->type;
1110 	}
1111 
1112 	/*
1113 	 * Start with type_id, as we have resolved the struct btf_type *
1114 	 * via btf_modifier_show() past the parent typedef to the child
1115 	 * struct, int etc it is defined as.  In such cases, the type_id
1116 	 * still represents the starting type while the struct btf_type *
1117 	 * in our show->state points at the resolved type of the typedef.
1118 	 */
1119 	t = btf_type_by_id(show->btf, id);
1120 	if (!t)
1121 		return "";
1122 
1123 	/*
1124 	 * The goal here is to build up the right number of pointer and
1125 	 * array suffixes while ensuring the type name for a typedef
1126 	 * is represented.  Along the way we accumulate a list of
1127 	 * BTF kinds we have encountered, since these will inform later
1128 	 * display; for example, pointer types will not require an
1129 	 * opening "{" for struct, we will just display the pointer value.
1130 	 *
1131 	 * We also want to accumulate the right number of pointer or array
1132 	 * indices in the format string while iterating until we get to
1133 	 * the typedef/pointee/array member target type.
1134 	 *
1135 	 * We start by pointing at the end of pointer and array suffix
1136 	 * strings; as we accumulate pointers and arrays we move the pointer
1137 	 * or array string backwards so it will show the expected number of
1138 	 * '*' or '[]' for the type.  BTF_SHOW_MAX_ITER of nesting of pointers
1139 	 * and/or arrays and typedefs are supported as a precaution.
1140 	 *
1141 	 * We also want to get typedef name while proceeding to resolve
1142 	 * type it points to so that we can add parentheses if it is a
1143 	 * "typedef struct" etc.
1144 	 */
1145 	for (i = 0; i < BTF_SHOW_MAX_ITER; i++) {
1146 
1147 		switch (BTF_INFO_KIND(t->info)) {
1148 		case BTF_KIND_TYPEDEF:
1149 			if (!name)
1150 				name = btf_name_by_offset(show->btf,
1151 							       t->name_off);
1152 			kinds |= BTF_KIND_BIT(BTF_KIND_TYPEDEF);
1153 			id = t->type;
1154 			break;
1155 		case BTF_KIND_ARRAY:
1156 			kinds |= BTF_KIND_BIT(BTF_KIND_ARRAY);
1157 			parens = "[";
1158 			if (!t)
1159 				return "";
1160 			array = btf_type_array(t);
1161 			if (array_suffix > array_suffixes)
1162 				array_suffix -= 2;
1163 			id = array->type;
1164 			break;
1165 		case BTF_KIND_PTR:
1166 			kinds |= BTF_KIND_BIT(BTF_KIND_PTR);
1167 			if (ptr_suffix > ptr_suffixes)
1168 				ptr_suffix -= 1;
1169 			id = t->type;
1170 			break;
1171 		default:
1172 			goto resolved;
1173 		}
1174 		t = btf_type_skip_qualifiers(show->btf, id);
1175 		if (!id)
1176 			break;
1177 	}
1178 	/* We may not be able to represent this type; bail to be safe */
1179 	if (i == BTF_SHOW_MAX_ITER)
1180 		return "";
1181 
1182 resolved:
1183 	if (!name)
1184 		name = btf_type_is_void(t) ? "void" : btf_name_by_offset(show->btf, t->name_off);
1185 
1186 	switch (BTF_INFO_KIND(t->info)) {
1187 	case BTF_KIND_STRUCT:
1188 	case BTF_KIND_UNION:
1189 		prefix = BTF_INFO_KIND(t->info) == BTF_KIND_STRUCT ?
1190 			 "struct" : "union";
1191 		/* if it's an array of struct/union, parens is already set */
1192 		if (!(kinds & (BTF_KIND_BIT(BTF_KIND_ARRAY))))
1193 			parens = "{";
1194 		break;
1195 	case BTF_KIND_ENUM:
1196 	case BTF_KIND_ENUM64:
1197 		prefix = "enum";
1198 		break;
1199 	default:
1200 		break;
1201 	}
1202 
1203 	/* pointer does not require parens */
1204 	if (kinds & BTF_KIND_BIT(BTF_KIND_PTR))
1205 		parens = "";
1206 	/* typedef does not require struct/union/enum prefix */
1207 	if (kinds & BTF_KIND_BIT(BTF_KIND_TYPEDEF))
1208 		prefix = "";
1209 
1210 	if (!name)
1211 		name = "";
1212 
1213 	/* Even if we don't want type name info, we want parentheses etc */
1214 	if (show->flags & BTF_SHOW_NONAME)
1215 		snprintf(show->state.name, sizeof(show->state.name), "%s",
1216 			 parens);
1217 	else
1218 		snprintf(show->state.name, sizeof(show->state.name),
1219 			 "%s%s%s(%s%s%s%s%s%s)%s",
1220 			 /* first 3 strings comprise ".member = " */
1221 			 show_member ? "." : "",
1222 			 show_member ? member : "",
1223 			 show_member ? " = " : "",
1224 			 /* ...next is our prefix (struct, enum, etc) */
1225 			 prefix,
1226 			 strlen(prefix) > 0 && strlen(name) > 0 ? " " : "",
1227 			 /* ...this is the type name itself */
1228 			 name,
1229 			 /* ...suffixed by the appropriate '*', '[]' suffixes */
1230 			 strlen(ptr_suffix) > 0 ? " " : "", ptr_suffix,
1231 			 array_suffix, parens);
1232 
1233 	return show->state.name;
1234 }
1235 
__btf_show_indent(struct btf_show * show)1236 static const char *__btf_show_indent(struct btf_show *show)
1237 {
1238 	const char *indents = "                                ";
1239 	const char *indent = &indents[strlen(indents)];
1240 
1241 	if ((indent - show->state.depth) >= indents)
1242 		return indent - show->state.depth;
1243 	return indents;
1244 }
1245 
btf_show_indent(struct btf_show * show)1246 static const char *btf_show_indent(struct btf_show *show)
1247 {
1248 	return show->flags & BTF_SHOW_COMPACT ? "" : __btf_show_indent(show);
1249 }
1250 
btf_show_newline(struct btf_show * show)1251 static const char *btf_show_newline(struct btf_show *show)
1252 {
1253 	return show->flags & BTF_SHOW_COMPACT ? "" : "\n";
1254 }
1255 
btf_show_delim(struct btf_show * show)1256 static const char *btf_show_delim(struct btf_show *show)
1257 {
1258 	if (show->state.depth == 0)
1259 		return "";
1260 
1261 	if ((show->flags & BTF_SHOW_COMPACT) && show->state.type &&
1262 		BTF_INFO_KIND(show->state.type->info) == BTF_KIND_UNION)
1263 		return "|";
1264 
1265 	return ",";
1266 }
1267 
btf_show(struct btf_show * show,const char * fmt,...)1268 __printf(2, 3) static void btf_show(struct btf_show *show, const char *fmt, ...)
1269 {
1270 	va_list args;
1271 
1272 	if (!show->state.depth_check) {
1273 		va_start(args, fmt);
1274 		show->showfn(show, fmt, args);
1275 		va_end(args);
1276 	}
1277 }
1278 
1279 /* Macros are used here as btf_show_type_value[s]() prepends and appends
1280  * format specifiers to the format specifier passed in; these do the work of
1281  * adding indentation, delimiters etc while the caller simply has to specify
1282  * the type value(s) in the format specifier + value(s).
1283  */
1284 #define btf_show_type_value(show, fmt, value)				       \
1285 	do {								       \
1286 		if ((value) != (__typeof__(value))0 ||			       \
1287 		    (show->flags & BTF_SHOW_ZERO) ||			       \
1288 		    show->state.depth == 0) {				       \
1289 			btf_show(show, "%s%s" fmt "%s%s",		       \
1290 				 btf_show_indent(show),			       \
1291 				 btf_show_name(show),			       \
1292 				 value, btf_show_delim(show),		       \
1293 				 btf_show_newline(show));		       \
1294 			if (show->state.depth > show->state.depth_to_show)     \
1295 				show->state.depth_to_show = show->state.depth; \
1296 		}							       \
1297 	} while (0)
1298 
1299 #define btf_show_type_values(show, fmt, ...)				       \
1300 	do {								       \
1301 		btf_show(show, "%s%s" fmt "%s%s", btf_show_indent(show),       \
1302 			 btf_show_name(show),				       \
1303 			 __VA_ARGS__, btf_show_delim(show),		       \
1304 			 btf_show_newline(show));			       \
1305 		if (show->state.depth > show->state.depth_to_show)	       \
1306 			show->state.depth_to_show = show->state.depth;	       \
1307 	} while (0)
1308 
1309 /* How much is left to copy to safe buffer after @data? */
btf_show_obj_size_left(struct btf_show * show,void * data)1310 static int btf_show_obj_size_left(struct btf_show *show, void *data)
1311 {
1312 	return show->obj.head + show->obj.size - data;
1313 }
1314 
1315 /* Is object pointed to by @data of @size already copied to our safe buffer? */
btf_show_obj_is_safe(struct btf_show * show,void * data,int size)1316 static bool btf_show_obj_is_safe(struct btf_show *show, void *data, int size)
1317 {
1318 	return data >= show->obj.data &&
1319 	       (data + size) < (show->obj.data + BTF_SHOW_OBJ_SAFE_SIZE);
1320 }
1321 
1322 /*
1323  * If object pointed to by @data of @size falls within our safe buffer, return
1324  * the equivalent pointer to the same safe data.  Assumes
1325  * copy_from_kernel_nofault() has already happened and our safe buffer is
1326  * populated.
1327  */
__btf_show_obj_safe(struct btf_show * show,void * data,int size)1328 static void *__btf_show_obj_safe(struct btf_show *show, void *data, int size)
1329 {
1330 	if (btf_show_obj_is_safe(show, data, size))
1331 		return show->obj.safe + (data - show->obj.data);
1332 	return NULL;
1333 }
1334 
1335 /*
1336  * Return a safe-to-access version of data pointed to by @data.
1337  * We do this by copying the relevant amount of information
1338  * to the struct btf_show obj.safe buffer using copy_from_kernel_nofault().
1339  *
1340  * If BTF_SHOW_UNSAFE is specified, just return data as-is; no
1341  * safe copy is needed.
1342  *
1343  * Otherwise we need to determine if we have the required amount
1344  * of data (determined by the @data pointer and the size of the
1345  * largest base type we can encounter (represented by
1346  * BTF_SHOW_OBJ_BASE_TYPE_SIZE). Having that much data ensures
1347  * that we will be able to print some of the current object,
1348  * and if more is needed a copy will be triggered.
1349  * Some objects such as structs will not fit into the buffer;
1350  * in such cases additional copies when we iterate over their
1351  * members may be needed.
1352  *
1353  * btf_show_obj_safe() is used to return a safe buffer for
1354  * btf_show_start_type(); this ensures that as we recurse into
1355  * nested types we always have safe data for the given type.
1356  * This approach is somewhat wasteful; it's possible for example
1357  * that when iterating over a large union we'll end up copying the
1358  * same data repeatedly, but the goal is safety not performance.
1359  * We use stack data as opposed to per-CPU buffers because the
1360  * iteration over a type can take some time, and preemption handling
1361  * would greatly complicate use of the safe buffer.
1362  */
btf_show_obj_safe(struct btf_show * show,const struct btf_type * t,void * data)1363 static void *btf_show_obj_safe(struct btf_show *show,
1364 			       const struct btf_type *t,
1365 			       void *data)
1366 {
1367 	const struct btf_type *rt;
1368 	int size_left, size;
1369 	void *safe = NULL;
1370 
1371 	if (show->flags & BTF_SHOW_UNSAFE)
1372 		return data;
1373 
1374 	rt = btf_resolve_size(show->btf, t, &size);
1375 	if (IS_ERR(rt)) {
1376 		show->state.status = PTR_ERR(rt);
1377 		return NULL;
1378 	}
1379 
1380 	/*
1381 	 * Is this toplevel object? If so, set total object size and
1382 	 * initialize pointers.  Otherwise check if we still fall within
1383 	 * our safe object data.
1384 	 */
1385 	if (show->state.depth == 0) {
1386 		show->obj.size = size;
1387 		show->obj.head = data;
1388 	} else {
1389 		/*
1390 		 * If the size of the current object is > our remaining
1391 		 * safe buffer we _may_ need to do a new copy.  However
1392 		 * consider the case of a nested struct; it's size pushes
1393 		 * us over the safe buffer limit, but showing any individual
1394 		 * struct members does not.  In such cases, we don't need
1395 		 * to initiate a fresh copy yet; however we definitely need
1396 		 * at least BTF_SHOW_OBJ_BASE_TYPE_SIZE bytes left
1397 		 * in our buffer, regardless of the current object size.
1398 		 * The logic here is that as we resolve types we will
1399 		 * hit a base type at some point, and we need to be sure
1400 		 * the next chunk of data is safely available to display
1401 		 * that type info safely.  We cannot rely on the size of
1402 		 * the current object here because it may be much larger
1403 		 * than our current buffer (e.g. task_struct is 8k).
1404 		 * All we want to do here is ensure that we can print the
1405 		 * next basic type, which we can if either
1406 		 * - the current type size is within the safe buffer; or
1407 		 * - at least BTF_SHOW_OBJ_BASE_TYPE_SIZE bytes are left in
1408 		 *   the safe buffer.
1409 		 */
1410 		safe = __btf_show_obj_safe(show, data,
1411 					   min(size,
1412 					       BTF_SHOW_OBJ_BASE_TYPE_SIZE));
1413 	}
1414 
1415 	/*
1416 	 * We need a new copy to our safe object, either because we haven't
1417 	 * yet copied and are initializing safe data, or because the data
1418 	 * we want falls outside the boundaries of the safe object.
1419 	 */
1420 	if (!safe) {
1421 		size_left = btf_show_obj_size_left(show, data);
1422 		if (size_left > BTF_SHOW_OBJ_SAFE_SIZE)
1423 			size_left = BTF_SHOW_OBJ_SAFE_SIZE;
1424 		show->state.status = copy_from_kernel_nofault(show->obj.safe,
1425 							      data, size_left);
1426 		if (!show->state.status) {
1427 			show->obj.data = data;
1428 			safe = show->obj.safe;
1429 		}
1430 	}
1431 
1432 	return safe;
1433 }
1434 
1435 /*
1436  * Set the type we are starting to show and return a safe data pointer
1437  * to be used for showing the associated data.
1438  */
btf_show_start_type(struct btf_show * show,const struct btf_type * t,u32 type_id,void * data)1439 static void *btf_show_start_type(struct btf_show *show,
1440 				 const struct btf_type *t,
1441 				 u32 type_id, void *data)
1442 {
1443 	show->state.type = t;
1444 	show->state.type_id = type_id;
1445 	show->state.name[0] = '\0';
1446 
1447 	return btf_show_obj_safe(show, t, data);
1448 }
1449 
btf_show_end_type(struct btf_show * show)1450 static void btf_show_end_type(struct btf_show *show)
1451 {
1452 	show->state.type = NULL;
1453 	show->state.type_id = 0;
1454 	show->state.name[0] = '\0';
1455 }
1456 
btf_show_start_aggr_type(struct btf_show * show,const struct btf_type * t,u32 type_id,void * data)1457 static void *btf_show_start_aggr_type(struct btf_show *show,
1458 				      const struct btf_type *t,
1459 				      u32 type_id, void *data)
1460 {
1461 	void *safe_data = btf_show_start_type(show, t, type_id, data);
1462 
1463 	if (!safe_data)
1464 		return safe_data;
1465 
1466 	btf_show(show, "%s%s%s", btf_show_indent(show),
1467 		 btf_show_name(show),
1468 		 btf_show_newline(show));
1469 	show->state.depth++;
1470 	return safe_data;
1471 }
1472 
btf_show_end_aggr_type(struct btf_show * show,const char * suffix)1473 static void btf_show_end_aggr_type(struct btf_show *show,
1474 				   const char *suffix)
1475 {
1476 	show->state.depth--;
1477 	btf_show(show, "%s%s%s%s", btf_show_indent(show), suffix,
1478 		 btf_show_delim(show), btf_show_newline(show));
1479 	btf_show_end_type(show);
1480 }
1481 
btf_show_start_member(struct btf_show * show,const struct btf_member * m)1482 static void btf_show_start_member(struct btf_show *show,
1483 				  const struct btf_member *m)
1484 {
1485 	show->state.member = m;
1486 }
1487 
btf_show_start_array_member(struct btf_show * show)1488 static void btf_show_start_array_member(struct btf_show *show)
1489 {
1490 	show->state.array_member = 1;
1491 	btf_show_start_member(show, NULL);
1492 }
1493 
btf_show_end_member(struct btf_show * show)1494 static void btf_show_end_member(struct btf_show *show)
1495 {
1496 	show->state.member = NULL;
1497 }
1498 
btf_show_end_array_member(struct btf_show * show)1499 static void btf_show_end_array_member(struct btf_show *show)
1500 {
1501 	show->state.array_member = 0;
1502 	btf_show_end_member(show);
1503 }
1504 
btf_show_start_array_type(struct btf_show * show,const struct btf_type * t,u32 type_id,u16 array_encoding,void * data)1505 static void *btf_show_start_array_type(struct btf_show *show,
1506 				       const struct btf_type *t,
1507 				       u32 type_id,
1508 				       u16 array_encoding,
1509 				       void *data)
1510 {
1511 	show->state.array_encoding = array_encoding;
1512 	show->state.array_terminated = 0;
1513 	return btf_show_start_aggr_type(show, t, type_id, data);
1514 }
1515 
btf_show_end_array_type(struct btf_show * show)1516 static void btf_show_end_array_type(struct btf_show *show)
1517 {
1518 	show->state.array_encoding = 0;
1519 	show->state.array_terminated = 0;
1520 	btf_show_end_aggr_type(show, "]");
1521 }
1522 
btf_show_start_struct_type(struct btf_show * show,const struct btf_type * t,u32 type_id,void * data)1523 static void *btf_show_start_struct_type(struct btf_show *show,
1524 					const struct btf_type *t,
1525 					u32 type_id,
1526 					void *data)
1527 {
1528 	return btf_show_start_aggr_type(show, t, type_id, data);
1529 }
1530 
btf_show_end_struct_type(struct btf_show * show)1531 static void btf_show_end_struct_type(struct btf_show *show)
1532 {
1533 	btf_show_end_aggr_type(show, "}");
1534 }
1535 
__btf_verifier_log(struct bpf_verifier_log * log,const char * fmt,...)1536 __printf(2, 3) static void __btf_verifier_log(struct bpf_verifier_log *log,
1537 					      const char *fmt, ...)
1538 {
1539 	va_list args;
1540 
1541 	va_start(args, fmt);
1542 	bpf_verifier_vlog(log, fmt, args);
1543 	va_end(args);
1544 }
1545 
btf_verifier_log(struct btf_verifier_env * env,const char * fmt,...)1546 __printf(2, 3) static void btf_verifier_log(struct btf_verifier_env *env,
1547 					    const char *fmt, ...)
1548 {
1549 	struct bpf_verifier_log *log = &env->log;
1550 	va_list args;
1551 
1552 	if (!bpf_verifier_log_needed(log))
1553 		return;
1554 
1555 	va_start(args, fmt);
1556 	bpf_verifier_vlog(log, fmt, args);
1557 	va_end(args);
1558 }
1559 
__btf_verifier_log_type(struct btf_verifier_env * env,const struct btf_type * t,bool log_details,const char * fmt,...)1560 __printf(4, 5) static void __btf_verifier_log_type(struct btf_verifier_env *env,
1561 						   const struct btf_type *t,
1562 						   bool log_details,
1563 						   const char *fmt, ...)
1564 {
1565 	struct bpf_verifier_log *log = &env->log;
1566 	struct btf *btf = env->btf;
1567 	va_list args;
1568 
1569 	if (!bpf_verifier_log_needed(log))
1570 		return;
1571 
1572 	if (log->level == BPF_LOG_KERNEL) {
1573 		/* btf verifier prints all types it is processing via
1574 		 * btf_verifier_log_type(..., fmt = NULL).
1575 		 * Skip those prints for in-kernel BTF verification.
1576 		 */
1577 		if (!fmt)
1578 			return;
1579 
1580 		/* Skip logging when loading module BTF with mismatches permitted */
1581 		if (env->btf->base_btf && IS_ENABLED(CONFIG_MODULE_ALLOW_BTF_MISMATCH))
1582 			return;
1583 	}
1584 
1585 	__btf_verifier_log(log, "[%u] %s %s%s",
1586 			   env->log_type_id,
1587 			   btf_type_str(t),
1588 			   __btf_name_by_offset(btf, t->name_off),
1589 			   log_details ? " " : "");
1590 
1591 	if (log_details)
1592 		btf_type_ops(t)->log_details(env, t);
1593 
1594 	if (fmt && *fmt) {
1595 		__btf_verifier_log(log, " ");
1596 		va_start(args, fmt);
1597 		bpf_verifier_vlog(log, fmt, args);
1598 		va_end(args);
1599 	}
1600 
1601 	__btf_verifier_log(log, "\n");
1602 }
1603 
1604 #define btf_verifier_log_type(env, t, ...) \
1605 	__btf_verifier_log_type((env), (t), true, __VA_ARGS__)
1606 #define btf_verifier_log_basic(env, t, ...) \
1607 	__btf_verifier_log_type((env), (t), false, __VA_ARGS__)
1608 
1609 __printf(4, 5)
btf_verifier_log_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const char * fmt,...)1610 static void btf_verifier_log_member(struct btf_verifier_env *env,
1611 				    const struct btf_type *struct_type,
1612 				    const struct btf_member *member,
1613 				    const char *fmt, ...)
1614 {
1615 	struct bpf_verifier_log *log = &env->log;
1616 	struct btf *btf = env->btf;
1617 	va_list args;
1618 
1619 	if (!bpf_verifier_log_needed(log))
1620 		return;
1621 
1622 	if (log->level == BPF_LOG_KERNEL) {
1623 		if (!fmt)
1624 			return;
1625 
1626 		/* Skip logging when loading module BTF with mismatches permitted */
1627 		if (env->btf->base_btf && IS_ENABLED(CONFIG_MODULE_ALLOW_BTF_MISMATCH))
1628 			return;
1629 	}
1630 
1631 	/* The CHECK_META phase already did a btf dump.
1632 	 *
1633 	 * If member is logged again, it must hit an error in
1634 	 * parsing this member.  It is useful to print out which
1635 	 * struct this member belongs to.
1636 	 */
1637 	if (env->phase != CHECK_META)
1638 		btf_verifier_log_type(env, struct_type, NULL);
1639 
1640 	if (btf_type_kflag(struct_type))
1641 		__btf_verifier_log(log,
1642 				   "\t%s type_id=%u bitfield_size=%u bits_offset=%u",
1643 				   __btf_name_by_offset(btf, member->name_off),
1644 				   member->type,
1645 				   BTF_MEMBER_BITFIELD_SIZE(member->offset),
1646 				   BTF_MEMBER_BIT_OFFSET(member->offset));
1647 	else
1648 		__btf_verifier_log(log, "\t%s type_id=%u bits_offset=%u",
1649 				   __btf_name_by_offset(btf, member->name_off),
1650 				   member->type, member->offset);
1651 
1652 	if (fmt && *fmt) {
1653 		__btf_verifier_log(log, " ");
1654 		va_start(args, fmt);
1655 		bpf_verifier_vlog(log, fmt, args);
1656 		va_end(args);
1657 	}
1658 
1659 	__btf_verifier_log(log, "\n");
1660 }
1661 
1662 __printf(4, 5)
btf_verifier_log_vsi(struct btf_verifier_env * env,const struct btf_type * datasec_type,const struct btf_var_secinfo * vsi,const char * fmt,...)1663 static void btf_verifier_log_vsi(struct btf_verifier_env *env,
1664 				 const struct btf_type *datasec_type,
1665 				 const struct btf_var_secinfo *vsi,
1666 				 const char *fmt, ...)
1667 {
1668 	struct bpf_verifier_log *log = &env->log;
1669 	va_list args;
1670 
1671 	if (!bpf_verifier_log_needed(log))
1672 		return;
1673 	if (log->level == BPF_LOG_KERNEL && !fmt)
1674 		return;
1675 	if (env->phase != CHECK_META)
1676 		btf_verifier_log_type(env, datasec_type, NULL);
1677 
1678 	__btf_verifier_log(log, "\t type_id=%u offset=%u size=%u",
1679 			   vsi->type, vsi->offset, vsi->size);
1680 	if (fmt && *fmt) {
1681 		__btf_verifier_log(log, " ");
1682 		va_start(args, fmt);
1683 		bpf_verifier_vlog(log, fmt, args);
1684 		va_end(args);
1685 	}
1686 
1687 	__btf_verifier_log(log, "\n");
1688 }
1689 
btf_verifier_log_hdr(struct btf_verifier_env * env,u32 btf_data_size)1690 static void btf_verifier_log_hdr(struct btf_verifier_env *env,
1691 				 u32 btf_data_size)
1692 {
1693 	struct bpf_verifier_log *log = &env->log;
1694 	const struct btf *btf = env->btf;
1695 	const struct btf_header *hdr;
1696 
1697 	if (!bpf_verifier_log_needed(log))
1698 		return;
1699 
1700 	if (log->level == BPF_LOG_KERNEL)
1701 		return;
1702 	hdr = &btf->hdr;
1703 	__btf_verifier_log(log, "magic: 0x%x\n", hdr->magic);
1704 	__btf_verifier_log(log, "version: %u\n", hdr->version);
1705 	__btf_verifier_log(log, "flags: 0x%x\n", hdr->flags);
1706 	__btf_verifier_log(log, "hdr_len: %u\n", hdr->hdr_len);
1707 	__btf_verifier_log(log, "type_off: %u\n", hdr->type_off);
1708 	__btf_verifier_log(log, "type_len: %u\n", hdr->type_len);
1709 	__btf_verifier_log(log, "str_off: %u\n", hdr->str_off);
1710 	__btf_verifier_log(log, "str_len: %u\n", hdr->str_len);
1711 	if (hdr->hdr_len >= sizeof(struct btf_header) &&
1712 	    btf_data_size >= hdr->hdr_len) {
1713 		__btf_verifier_log(log, "layout_off: %u\n", hdr->layout_off);
1714 		__btf_verifier_log(log, "layout_len: %u\n", hdr->layout_len);
1715 	}
1716 	__btf_verifier_log(log, "btf_total_size: %u\n", btf_data_size);
1717 }
1718 
btf_add_type(struct btf_verifier_env * env,struct btf_type * t)1719 static int btf_add_type(struct btf_verifier_env *env, struct btf_type *t)
1720 {
1721 	struct btf *btf = env->btf;
1722 
1723 	if (btf->types_size == btf->nr_types) {
1724 		/* Expand 'types' array */
1725 
1726 		struct btf_type **new_types;
1727 		u32 expand_by, new_size;
1728 
1729 		if (btf->start_id + btf->types_size == BTF_MAX_TYPE) {
1730 			btf_verifier_log(env, "Exceeded max num of types");
1731 			return -E2BIG;
1732 		}
1733 
1734 		expand_by = max_t(u32, btf->types_size >> 2, 16);
1735 		new_size = min_t(u32, BTF_MAX_TYPE,
1736 				 btf->types_size + expand_by);
1737 
1738 		new_types = kvzalloc_objs(*new_types, new_size,
1739 					  GFP_KERNEL | __GFP_NOWARN);
1740 		if (!new_types)
1741 			return -ENOMEM;
1742 
1743 		if (btf->nr_types == 0) {
1744 			if (!btf->base_btf) {
1745 				/* lazily init VOID type */
1746 				new_types[0] = &btf_void;
1747 				btf->nr_types++;
1748 			}
1749 		} else {
1750 			memcpy(new_types, btf->types,
1751 			       sizeof(*btf->types) * btf->nr_types);
1752 		}
1753 
1754 		kvfree(btf->types);
1755 		btf->types = new_types;
1756 		btf->types_size = new_size;
1757 	}
1758 
1759 	btf->types[btf->nr_types++] = t;
1760 
1761 	return 0;
1762 }
1763 
btf_alloc_id(struct btf * btf)1764 static int btf_alloc_id(struct btf *btf)
1765 {
1766 	int id;
1767 
1768 	idr_preload(GFP_KERNEL);
1769 	spin_lock_bh(&btf_idr_lock);
1770 	id = idr_alloc_cyclic(&btf_idr, btf, 1, INT_MAX, GFP_ATOMIC);
1771 	if (id > 0)
1772 		btf->id = id;
1773 	spin_unlock_bh(&btf_idr_lock);
1774 	idr_preload_end();
1775 
1776 	if (WARN_ON_ONCE(!id))
1777 		return -ENOSPC;
1778 
1779 	return id > 0 ? 0 : id;
1780 }
1781 
btf_free_id(struct btf * btf)1782 static void btf_free_id(struct btf *btf)
1783 {
1784 	unsigned long flags;
1785 
1786 	/*
1787 	 * In map-in-map, calling map_delete_elem() on outer
1788 	 * map will call bpf_map_put on the inner map.
1789 	 * It will then eventually call btf_free_id()
1790 	 * on the inner map.  Some of the map_delete_elem()
1791 	 * implementation may have irq disabled, so
1792 	 * we need to use the _irqsave() version instead
1793 	 * of the _bh() version.
1794 	 */
1795 	spin_lock_irqsave(&btf_idr_lock, flags);
1796 	if (btf->id) {
1797 		idr_remove(&btf_idr, btf->id);
1798 		/*
1799 		 * Clear the id here to make this function idempotent, since it will get
1800 		 * called a couple of times for module BTFs: on module unload, and then
1801 		 * the final btf_put(). btf_alloc_id() starts IDs with 1, so we can use
1802 		 * 0 as sentinel value.
1803 		 */
1804 		WRITE_ONCE(btf->id, 0);
1805 	}
1806 	spin_unlock_irqrestore(&btf_idr_lock, flags);
1807 }
1808 
btf_free_kfunc_set_tab(struct btf * btf)1809 static void btf_free_kfunc_set_tab(struct btf *btf)
1810 {
1811 	struct btf_kfunc_set_tab *tab = btf->kfunc_set_tab;
1812 	int hook;
1813 
1814 	if (!tab)
1815 		return;
1816 	for (hook = 0; hook < ARRAY_SIZE(tab->sets); hook++)
1817 		kfree(tab->sets[hook]);
1818 	kfree(tab);
1819 	btf->kfunc_set_tab = NULL;
1820 }
1821 
btf_free_dtor_kfunc_tab(struct btf * btf)1822 static void btf_free_dtor_kfunc_tab(struct btf *btf)
1823 {
1824 	struct btf_id_dtor_kfunc_tab *tab = btf->dtor_kfunc_tab;
1825 
1826 	if (!tab)
1827 		return;
1828 	kfree(tab);
1829 	btf->dtor_kfunc_tab = NULL;
1830 }
1831 
btf_struct_metas_free(struct btf_struct_metas * tab)1832 static void btf_struct_metas_free(struct btf_struct_metas *tab)
1833 {
1834 	int i;
1835 
1836 	if (!tab)
1837 		return;
1838 	for (i = 0; i < tab->cnt; i++)
1839 		btf_record_free(tab->types[i].record);
1840 	kfree(tab);
1841 }
1842 
btf_free_struct_meta_tab(struct btf * btf)1843 static void btf_free_struct_meta_tab(struct btf *btf)
1844 {
1845 	struct btf_struct_metas *tab = btf->struct_meta_tab;
1846 
1847 	btf_struct_metas_free(tab);
1848 	btf->struct_meta_tab = NULL;
1849 }
1850 
btf_free_struct_ops_tab(struct btf * btf)1851 static void btf_free_struct_ops_tab(struct btf *btf)
1852 {
1853 	struct btf_struct_ops_tab *tab = btf->struct_ops_tab;
1854 	u32 i;
1855 
1856 	if (!tab)
1857 		return;
1858 
1859 	for (i = 0; i < tab->cnt; i++)
1860 		bpf_struct_ops_desc_release(&tab->ops[i]);
1861 
1862 	kfree(tab);
1863 	btf->struct_ops_tab = NULL;
1864 }
1865 
btf_free(struct btf * btf)1866 static void btf_free(struct btf *btf)
1867 {
1868 	btf_free_struct_meta_tab(btf);
1869 	btf_free_dtor_kfunc_tab(btf);
1870 	btf_free_kfunc_set_tab(btf);
1871 	btf_free_struct_ops_tab(btf);
1872 	kvfree(btf->types);
1873 	kvfree(btf->resolved_sizes);
1874 	kvfree(btf->resolved_ids);
1875 	/* vmlinux does not allocate btf->data, it simply points it at
1876 	 * __start_BTF.
1877 	 */
1878 	if (!btf_is_vmlinux(btf))
1879 		kvfree(btf->data);
1880 	kvfree(btf->base_id_map);
1881 	kfree(btf);
1882 }
1883 
btf_free_rcu(struct rcu_head * rcu)1884 static void btf_free_rcu(struct rcu_head *rcu)
1885 {
1886 	struct btf *btf = container_of(rcu, struct btf, rcu);
1887 
1888 	btf_free(btf);
1889 }
1890 
btf_get_name(const struct btf * btf)1891 const char *btf_get_name(const struct btf *btf)
1892 {
1893 	return btf->name;
1894 }
1895 
btf_get(struct btf * btf)1896 void btf_get(struct btf *btf)
1897 {
1898 	refcount_inc(&btf->refcnt);
1899 }
1900 
btf_put(struct btf * btf)1901 void btf_put(struct btf *btf)
1902 {
1903 	if (btf && refcount_dec_and_test(&btf->refcnt)) {
1904 		btf_free_id(btf);
1905 		call_rcu(&btf->rcu, btf_free_rcu);
1906 	}
1907 }
1908 
btf_base_btf(const struct btf * btf)1909 struct btf *btf_base_btf(const struct btf *btf)
1910 {
1911 	return btf->base_btf;
1912 }
1913 
btf_header(const struct btf * btf)1914 const struct btf_header *btf_header(const struct btf *btf)
1915 {
1916 	return &btf->hdr;
1917 }
1918 
btf_set_base_btf(struct btf * btf,const struct btf * base_btf)1919 void btf_set_base_btf(struct btf *btf, const struct btf *base_btf)
1920 {
1921 	btf->base_btf = (struct btf *)base_btf;
1922 	btf->start_id = btf_nr_types(base_btf);
1923 	btf->start_str_off = base_btf->hdr.str_len;
1924 }
1925 
env_resolve_init(struct btf_verifier_env * env)1926 static int env_resolve_init(struct btf_verifier_env *env)
1927 {
1928 	struct btf *btf = env->btf;
1929 	u32 nr_types = btf->nr_types;
1930 	u32 *resolved_sizes = NULL;
1931 	u32 *resolved_ids = NULL;
1932 	u8 *visit_states = NULL;
1933 
1934 	resolved_sizes = kvcalloc(nr_types, sizeof(*resolved_sizes),
1935 				  GFP_KERNEL | __GFP_NOWARN);
1936 	if (!resolved_sizes)
1937 		goto nomem;
1938 
1939 	resolved_ids = kvcalloc(nr_types, sizeof(*resolved_ids),
1940 				GFP_KERNEL | __GFP_NOWARN);
1941 	if (!resolved_ids)
1942 		goto nomem;
1943 
1944 	visit_states = kvcalloc(nr_types, sizeof(*visit_states),
1945 				GFP_KERNEL | __GFP_NOWARN);
1946 	if (!visit_states)
1947 		goto nomem;
1948 
1949 	btf->resolved_sizes = resolved_sizes;
1950 	btf->resolved_ids = resolved_ids;
1951 	env->visit_states = visit_states;
1952 
1953 	return 0;
1954 
1955 nomem:
1956 	kvfree(resolved_sizes);
1957 	kvfree(resolved_ids);
1958 	kvfree(visit_states);
1959 	return -ENOMEM;
1960 }
1961 
btf_verifier_env_free(struct btf_verifier_env * env)1962 static void btf_verifier_env_free(struct btf_verifier_env *env)
1963 {
1964 	kvfree(env->visit_states);
1965 	kfree(env);
1966 }
1967 
env_type_is_resolve_sink(const struct btf_verifier_env * env,const struct btf_type * next_type)1968 static bool env_type_is_resolve_sink(const struct btf_verifier_env *env,
1969 				     const struct btf_type *next_type)
1970 {
1971 	switch (env->resolve_mode) {
1972 	case RESOLVE_TBD:
1973 		/* int, enum or void is a sink */
1974 		return !btf_type_needs_resolve(next_type);
1975 	case RESOLVE_PTR:
1976 		/* int, enum, void, struct, array, func or func_proto is a sink
1977 		 * for ptr
1978 		 */
1979 		return !btf_type_is_modifier(next_type) &&
1980 			!btf_type_is_ptr(next_type);
1981 	case RESOLVE_STRUCT_OR_ARRAY:
1982 		/* int, enum, void, ptr, func or func_proto is a sink
1983 		 * for struct and array
1984 		 */
1985 		return !btf_type_is_modifier(next_type) &&
1986 			!btf_type_is_array(next_type) &&
1987 			!btf_type_is_struct(next_type);
1988 	default:
1989 		BUG();
1990 	}
1991 }
1992 
env_type_is_resolved(const struct btf_verifier_env * env,u32 type_id)1993 static bool env_type_is_resolved(const struct btf_verifier_env *env,
1994 				 u32 type_id)
1995 {
1996 	/* base BTF types should be resolved by now */
1997 	if (type_id < env->btf->start_id)
1998 		return true;
1999 
2000 	return env->visit_states[type_id - env->btf->start_id] == RESOLVED;
2001 }
2002 
env_stack_push(struct btf_verifier_env * env,const struct btf_type * t,u32 type_id)2003 static int env_stack_push(struct btf_verifier_env *env,
2004 			  const struct btf_type *t, u32 type_id)
2005 {
2006 	const struct btf *btf = env->btf;
2007 	struct resolve_vertex *v;
2008 
2009 	if (env->top_stack == MAX_RESOLVE_DEPTH)
2010 		return -E2BIG;
2011 
2012 	if (type_id < btf->start_id
2013 	    || env->visit_states[type_id - btf->start_id] != NOT_VISITED)
2014 		return -EEXIST;
2015 
2016 	env->visit_states[type_id - btf->start_id] = VISITED;
2017 
2018 	v = &env->stack[env->top_stack++];
2019 	v->t = t;
2020 	v->type_id = type_id;
2021 	v->next_member = 0;
2022 
2023 	if (env->resolve_mode == RESOLVE_TBD) {
2024 		if (btf_type_is_ptr(t))
2025 			env->resolve_mode = RESOLVE_PTR;
2026 		else if (btf_type_is_struct(t) || btf_type_is_array(t))
2027 			env->resolve_mode = RESOLVE_STRUCT_OR_ARRAY;
2028 	}
2029 
2030 	return 0;
2031 }
2032 
env_stack_set_next_member(struct btf_verifier_env * env,u32 next_member)2033 static void env_stack_set_next_member(struct btf_verifier_env *env,
2034 				      u32 next_member)
2035 {
2036 	env->stack[env->top_stack - 1].next_member = next_member;
2037 }
2038 
env_stack_pop_resolved(struct btf_verifier_env * env,u32 resolved_type_id,u32 resolved_size)2039 static void env_stack_pop_resolved(struct btf_verifier_env *env,
2040 				   u32 resolved_type_id,
2041 				   u32 resolved_size)
2042 {
2043 	u32 type_id = env->stack[--(env->top_stack)].type_id;
2044 	struct btf *btf = env->btf;
2045 
2046 	type_id -= btf->start_id; /* adjust to local type id */
2047 	btf->resolved_sizes[type_id] = resolved_size;
2048 	btf->resolved_ids[type_id] = resolved_type_id;
2049 	env->visit_states[type_id] = RESOLVED;
2050 }
2051 
env_stack_peak(struct btf_verifier_env * env)2052 static const struct resolve_vertex *env_stack_peak(struct btf_verifier_env *env)
2053 {
2054 	return env->top_stack ? &env->stack[env->top_stack - 1] : NULL;
2055 }
2056 
2057 /* Resolve the size of a passed-in "type"
2058  *
2059  * type: is an array (e.g. u32 array[x][y])
2060  * return type: type "u32[x][y]", i.e. BTF_KIND_ARRAY,
2061  * *type_size: (x * y * sizeof(u32)).  Hence, *type_size always
2062  *             corresponds to the return type.
2063  * *elem_type: u32
2064  * *elem_id: id of u32
2065  * *total_nelems: (x * y).  Hence, individual elem size is
2066  *                (*type_size / *total_nelems)
2067  * *type_id: id of type if it's changed within the function, 0 if not
2068  *
2069  * type: is not an array (e.g. const struct X)
2070  * return type: type "struct X"
2071  * *type_size: sizeof(struct X)
2072  * *elem_type: same as return type ("struct X")
2073  * *elem_id: 0
2074  * *total_nelems: 1
2075  * *type_id: id of type if it's changed within the function, 0 if not
2076  */
2077 static const struct btf_type *
__btf_resolve_size(const struct btf * btf,const struct btf_type * type,u32 * type_size,const struct btf_type ** elem_type,u32 * elem_id,u32 * total_nelems,u32 * type_id)2078 __btf_resolve_size(const struct btf *btf, const struct btf_type *type,
2079 		   u32 *type_size, const struct btf_type **elem_type,
2080 		   u32 *elem_id, u32 *total_nelems, u32 *type_id)
2081 {
2082 	const struct btf_type *array_type = NULL;
2083 	const struct btf_array *array = NULL;
2084 	u32 i, size, nelems = 1, id = 0;
2085 
2086 	for (i = 0; i < MAX_RESOLVE_DEPTH; i++) {
2087 		switch (BTF_INFO_KIND(type->info)) {
2088 		/* type->size can be used */
2089 		case BTF_KIND_INT:
2090 		case BTF_KIND_STRUCT:
2091 		case BTF_KIND_UNION:
2092 		case BTF_KIND_ENUM:
2093 		case BTF_KIND_FLOAT:
2094 		case BTF_KIND_ENUM64:
2095 			size = type->size;
2096 			goto resolved;
2097 
2098 		case BTF_KIND_PTR:
2099 			size = sizeof(void *);
2100 			goto resolved;
2101 
2102 		/* Modifiers */
2103 		case BTF_KIND_TYPEDEF:
2104 		case BTF_KIND_VOLATILE:
2105 		case BTF_KIND_CONST:
2106 		case BTF_KIND_RESTRICT:
2107 		case BTF_KIND_TYPE_TAG:
2108 			id = type->type;
2109 			type = btf_type_by_id(btf, type->type);
2110 			break;
2111 
2112 		case BTF_KIND_ARRAY:
2113 			if (!array_type)
2114 				array_type = type;
2115 			array = btf_type_array(type);
2116 			if (nelems && array->nelems > U32_MAX / nelems)
2117 				return ERR_PTR(-EINVAL);
2118 			nelems *= array->nelems;
2119 			type = btf_type_by_id(btf, array->type);
2120 			break;
2121 
2122 		/* type without size */
2123 		default:
2124 			return ERR_PTR(-EINVAL);
2125 		}
2126 	}
2127 
2128 	return ERR_PTR(-EINVAL);
2129 
2130 resolved:
2131 	if (nelems && size > U32_MAX / nelems)
2132 		return ERR_PTR(-EINVAL);
2133 
2134 	*type_size = nelems * size;
2135 	if (total_nelems)
2136 		*total_nelems = nelems;
2137 	if (elem_type)
2138 		*elem_type = type;
2139 	if (elem_id)
2140 		*elem_id = array ? array->type : 0;
2141 	if (type_id && id)
2142 		*type_id = id;
2143 
2144 	return array_type ? : type;
2145 }
2146 
2147 const struct btf_type *
btf_resolve_size(const struct btf * btf,const struct btf_type * type,u32 * type_size)2148 btf_resolve_size(const struct btf *btf, const struct btf_type *type,
2149 		 u32 *type_size)
2150 {
2151 	return __btf_resolve_size(btf, type, type_size, NULL, NULL, NULL, NULL);
2152 }
2153 
btf_resolved_type_id(const struct btf * btf,u32 type_id)2154 static u32 btf_resolved_type_id(const struct btf *btf, u32 type_id)
2155 {
2156 	while (type_id < btf->start_id)
2157 		btf = btf->base_btf;
2158 
2159 	return btf->resolved_ids[type_id - btf->start_id];
2160 }
2161 
2162 /* The input param "type_id" must point to a needs_resolve type */
btf_type_id_resolve(const struct btf * btf,u32 * type_id)2163 static const struct btf_type *btf_type_id_resolve(const struct btf *btf,
2164 						  u32 *type_id)
2165 {
2166 	*type_id = btf_resolved_type_id(btf, *type_id);
2167 	return btf_type_by_id(btf, *type_id);
2168 }
2169 
btf_resolved_type_size(const struct btf * btf,u32 type_id)2170 static u32 btf_resolved_type_size(const struct btf *btf, u32 type_id)
2171 {
2172 	while (type_id < btf->start_id)
2173 		btf = btf->base_btf;
2174 
2175 	return btf->resolved_sizes[type_id - btf->start_id];
2176 }
2177 
btf_type_id_size(const struct btf * btf,u32 * type_id,u32 * ret_size)2178 const struct btf_type *btf_type_id_size(const struct btf *btf,
2179 					u32 *type_id, u32 *ret_size)
2180 {
2181 	const struct btf_type *size_type;
2182 	u32 size_type_id = *type_id;
2183 	u32 size = 0;
2184 
2185 	size_type = btf_type_by_id(btf, size_type_id);
2186 	if (btf_type_nosize_or_null(size_type))
2187 		return NULL;
2188 
2189 	if (btf_type_has_size(size_type)) {
2190 		size = size_type->size;
2191 	} else if (btf_type_is_array(size_type)) {
2192 		size = btf_resolved_type_size(btf, size_type_id);
2193 	} else if (btf_type_is_ptr(size_type)) {
2194 		size = sizeof(void *);
2195 	} else {
2196 		if (WARN_ON_ONCE(!btf_type_is_modifier(size_type) &&
2197 				 !btf_type_is_var(size_type)))
2198 			return NULL;
2199 
2200 		size_type_id = btf_resolved_type_id(btf, size_type_id);
2201 		size_type = btf_type_by_id(btf, size_type_id);
2202 		if (btf_type_nosize_or_null(size_type))
2203 			return NULL;
2204 		else if (btf_type_has_size(size_type))
2205 			size = size_type->size;
2206 		else if (btf_type_is_array(size_type))
2207 			size = btf_resolved_type_size(btf, size_type_id);
2208 		else if (btf_type_is_ptr(size_type))
2209 			size = sizeof(void *);
2210 		else
2211 			return NULL;
2212 	}
2213 
2214 	*type_id = size_type_id;
2215 	if (ret_size)
2216 		*ret_size = size;
2217 
2218 	return size_type;
2219 }
2220 
btf_df_check_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const struct btf_type * member_type)2221 static int btf_df_check_member(struct btf_verifier_env *env,
2222 			       const struct btf_type *struct_type,
2223 			       const struct btf_member *member,
2224 			       const struct btf_type *member_type)
2225 {
2226 	btf_verifier_log_basic(env, struct_type,
2227 			       "Unsupported check_member");
2228 	return -EINVAL;
2229 }
2230 
btf_df_check_kflag_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const struct btf_type * member_type)2231 static int btf_df_check_kflag_member(struct btf_verifier_env *env,
2232 				     const struct btf_type *struct_type,
2233 				     const struct btf_member *member,
2234 				     const struct btf_type *member_type)
2235 {
2236 	btf_verifier_log_basic(env, struct_type,
2237 			       "Unsupported check_kflag_member");
2238 	return -EINVAL;
2239 }
2240 
2241 /* Used for ptr, array struct/union and float type members.
2242  * int, enum and modifier types have their specific callback functions.
2243  */
btf_generic_check_kflag_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const struct btf_type * member_type)2244 static int btf_generic_check_kflag_member(struct btf_verifier_env *env,
2245 					  const struct btf_type *struct_type,
2246 					  const struct btf_member *member,
2247 					  const struct btf_type *member_type)
2248 {
2249 	if (BTF_MEMBER_BITFIELD_SIZE(member->offset)) {
2250 		btf_verifier_log_member(env, struct_type, member,
2251 					"Invalid member bitfield_size");
2252 		return -EINVAL;
2253 	}
2254 
2255 	/* bitfield size is 0, so member->offset represents bit offset only.
2256 	 * It is safe to call non kflag check_member variants.
2257 	 */
2258 	return btf_type_ops(member_type)->check_member(env, struct_type,
2259 						       member,
2260 						       member_type);
2261 }
2262 
btf_df_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)2263 static int btf_df_resolve(struct btf_verifier_env *env,
2264 			  const struct resolve_vertex *v)
2265 {
2266 	btf_verifier_log_basic(env, v->t, "Unsupported resolve");
2267 	return -EINVAL;
2268 }
2269 
btf_df_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offsets,struct btf_show * show)2270 static void btf_df_show(const struct btf *btf, const struct btf_type *t,
2271 			u32 type_id, void *data, u8 bits_offsets,
2272 			struct btf_show *show)
2273 {
2274 	btf_show(show, "<unsupported kind:%u>", BTF_INFO_KIND(t->info));
2275 }
2276 
btf_int_check_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const struct btf_type * member_type)2277 static int btf_int_check_member(struct btf_verifier_env *env,
2278 				const struct btf_type *struct_type,
2279 				const struct btf_member *member,
2280 				const struct btf_type *member_type)
2281 {
2282 	u32 int_data = btf_type_int(member_type);
2283 	u32 struct_bits_off = member->offset;
2284 	u32 struct_size = struct_type->size;
2285 	u32 nr_copy_bits;
2286 	u32 bytes_offset;
2287 
2288 	if (U32_MAX - struct_bits_off < BTF_INT_OFFSET(int_data)) {
2289 		btf_verifier_log_member(env, struct_type, member,
2290 					"bits_offset exceeds U32_MAX");
2291 		return -EINVAL;
2292 	}
2293 
2294 	struct_bits_off += BTF_INT_OFFSET(int_data);
2295 	bytes_offset = BITS_ROUNDDOWN_BYTES(struct_bits_off);
2296 	nr_copy_bits = BTF_INT_BITS(int_data) +
2297 		BITS_PER_BYTE_MASKED(struct_bits_off);
2298 
2299 	if (nr_copy_bits > BITS_PER_U128) {
2300 		btf_verifier_log_member(env, struct_type, member,
2301 					"nr_copy_bits exceeds 128");
2302 		return -EINVAL;
2303 	}
2304 
2305 	if (struct_size < bytes_offset ||
2306 	    struct_size - bytes_offset < BITS_ROUNDUP_BYTES(nr_copy_bits)) {
2307 		btf_verifier_log_member(env, struct_type, member,
2308 					"Member exceeds struct_size");
2309 		return -EINVAL;
2310 	}
2311 
2312 	return 0;
2313 }
2314 
btf_int_check_kflag_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const struct btf_type * member_type)2315 static int btf_int_check_kflag_member(struct btf_verifier_env *env,
2316 				      const struct btf_type *struct_type,
2317 				      const struct btf_member *member,
2318 				      const struct btf_type *member_type)
2319 {
2320 	u32 struct_bits_off, nr_bits, nr_int_data_bits, bytes_offset;
2321 	u32 int_data = btf_type_int(member_type);
2322 	u32 struct_size = struct_type->size;
2323 	u32 nr_copy_bits;
2324 
2325 	/* a regular int type is required for the kflag int member */
2326 	if (!btf_type_int_is_regular(member_type)) {
2327 		btf_verifier_log_member(env, struct_type, member,
2328 					"Invalid member base type");
2329 		return -EINVAL;
2330 	}
2331 
2332 	/* check sanity of bitfield size */
2333 	nr_bits = BTF_MEMBER_BITFIELD_SIZE(member->offset);
2334 	struct_bits_off = BTF_MEMBER_BIT_OFFSET(member->offset);
2335 	nr_int_data_bits = BTF_INT_BITS(int_data);
2336 	if (!nr_bits) {
2337 		/* Not a bitfield member, member offset must be at byte
2338 		 * boundary.
2339 		 */
2340 		if (BITS_PER_BYTE_MASKED(struct_bits_off)) {
2341 			btf_verifier_log_member(env, struct_type, member,
2342 						"Invalid member offset");
2343 			return -EINVAL;
2344 		}
2345 
2346 		nr_bits = nr_int_data_bits;
2347 	} else if (nr_bits > nr_int_data_bits) {
2348 		btf_verifier_log_member(env, struct_type, member,
2349 					"Invalid member bitfield_size");
2350 		return -EINVAL;
2351 	}
2352 
2353 	bytes_offset = BITS_ROUNDDOWN_BYTES(struct_bits_off);
2354 	nr_copy_bits = nr_bits + BITS_PER_BYTE_MASKED(struct_bits_off);
2355 	if (nr_copy_bits > BITS_PER_U128) {
2356 		btf_verifier_log_member(env, struct_type, member,
2357 					"nr_copy_bits exceeds 128");
2358 		return -EINVAL;
2359 	}
2360 
2361 	if (struct_size < bytes_offset ||
2362 	    struct_size - bytes_offset < BITS_ROUNDUP_BYTES(nr_copy_bits)) {
2363 		btf_verifier_log_member(env, struct_type, member,
2364 					"Member exceeds struct_size");
2365 		return -EINVAL;
2366 	}
2367 
2368 	return 0;
2369 }
2370 
btf_int_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)2371 static s32 btf_int_check_meta(struct btf_verifier_env *env,
2372 			      const struct btf_type *t,
2373 			      u32 meta_left)
2374 {
2375 	u32 int_data, nr_bits, meta_needed = sizeof(int_data);
2376 	u16 encoding;
2377 
2378 	if (meta_left < meta_needed) {
2379 		btf_verifier_log_basic(env, t,
2380 				       "meta_left:%u meta_needed:%u",
2381 				       meta_left, meta_needed);
2382 		return -EINVAL;
2383 	}
2384 
2385 	if (btf_type_vlen(t)) {
2386 		btf_verifier_log_type(env, t, "vlen != 0");
2387 		return -EINVAL;
2388 	}
2389 
2390 	if (btf_type_kflag(t)) {
2391 		btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
2392 		return -EINVAL;
2393 	}
2394 
2395 	int_data = btf_type_int(t);
2396 	if (int_data & ~BTF_INT_MASK) {
2397 		btf_verifier_log_basic(env, t, "Invalid int_data:%x",
2398 				       int_data);
2399 		return -EINVAL;
2400 	}
2401 
2402 	nr_bits = BTF_INT_BITS(int_data) + BTF_INT_OFFSET(int_data);
2403 
2404 	if (nr_bits > BITS_PER_U128) {
2405 		btf_verifier_log_type(env, t, "nr_bits exceeds %zu",
2406 				      BITS_PER_U128);
2407 		return -EINVAL;
2408 	}
2409 
2410 	if (BITS_ROUNDUP_BYTES(nr_bits) > t->size) {
2411 		btf_verifier_log_type(env, t, "nr_bits exceeds type_size");
2412 		return -EINVAL;
2413 	}
2414 
2415 	/*
2416 	 * Only one of the encoding bits is allowed and it
2417 	 * should be sufficient for the pretty print purpose (i.e. decoding).
2418 	 * Multiple bits can be allowed later if it is found
2419 	 * to be insufficient.
2420 	 */
2421 	encoding = BTF_INT_ENCODING(int_data);
2422 	if (encoding &&
2423 	    encoding != BTF_INT_SIGNED &&
2424 	    encoding != BTF_INT_CHAR &&
2425 	    encoding != BTF_INT_BOOL) {
2426 		btf_verifier_log_type(env, t, "Unsupported encoding");
2427 		return -ENOTSUPP;
2428 	}
2429 
2430 	btf_verifier_log_type(env, t, NULL);
2431 
2432 	return meta_needed;
2433 }
2434 
btf_int_log(struct btf_verifier_env * env,const struct btf_type * t)2435 static void btf_int_log(struct btf_verifier_env *env,
2436 			const struct btf_type *t)
2437 {
2438 	int int_data = btf_type_int(t);
2439 
2440 	btf_verifier_log(env,
2441 			 "size=%u bits_offset=%u nr_bits=%u encoding=%s",
2442 			 t->size, BTF_INT_OFFSET(int_data),
2443 			 BTF_INT_BITS(int_data),
2444 			 btf_int_encoding_str(BTF_INT_ENCODING(int_data)));
2445 }
2446 
btf_int128_print(struct btf_show * show,void * data)2447 static void btf_int128_print(struct btf_show *show, void *data)
2448 {
2449 	/* data points to a __int128 number.
2450 	 * Suppose
2451 	 *     int128_num = *(__int128 *)data;
2452 	 * The below formulas shows what upper_num and lower_num represents:
2453 	 *     upper_num = int128_num >> 64;
2454 	 *     lower_num = int128_num & 0xffffffffFFFFFFFFULL;
2455 	 */
2456 	u64 upper_num, lower_num;
2457 
2458 #ifdef __BIG_ENDIAN_BITFIELD
2459 	upper_num = *(u64 *)data;
2460 	lower_num = *(u64 *)(data + 8);
2461 #else
2462 	upper_num = *(u64 *)(data + 8);
2463 	lower_num = *(u64 *)data;
2464 #endif
2465 	if (upper_num == 0)
2466 		btf_show_type_value(show, "0x%llx", lower_num);
2467 	else
2468 		btf_show_type_values(show, "0x%llx%016llx", upper_num,
2469 				     lower_num);
2470 }
2471 
btf_int128_shift(u64 * print_num,u16 left_shift_bits,u16 right_shift_bits)2472 static void btf_int128_shift(u64 *print_num, u16 left_shift_bits,
2473 			     u16 right_shift_bits)
2474 {
2475 	u64 upper_num, lower_num;
2476 
2477 #ifdef __BIG_ENDIAN_BITFIELD
2478 	upper_num = print_num[0];
2479 	lower_num = print_num[1];
2480 #else
2481 	upper_num = print_num[1];
2482 	lower_num = print_num[0];
2483 #endif
2484 
2485 	/* shake out un-needed bits by shift/or operations */
2486 	if (left_shift_bits >= 64) {
2487 		upper_num = lower_num << (left_shift_bits - 64);
2488 		lower_num = 0;
2489 	} else {
2490 		upper_num = (upper_num << left_shift_bits) |
2491 			    (lower_num >> (64 - left_shift_bits));
2492 		lower_num = lower_num << left_shift_bits;
2493 	}
2494 
2495 	if (right_shift_bits >= 64) {
2496 		lower_num = upper_num >> (right_shift_bits - 64);
2497 		upper_num = 0;
2498 	} else {
2499 		lower_num = (lower_num >> right_shift_bits) |
2500 			    (upper_num << (64 - right_shift_bits));
2501 		upper_num = upper_num >> right_shift_bits;
2502 	}
2503 
2504 #ifdef __BIG_ENDIAN_BITFIELD
2505 	print_num[0] = upper_num;
2506 	print_num[1] = lower_num;
2507 #else
2508 	print_num[0] = lower_num;
2509 	print_num[1] = upper_num;
2510 #endif
2511 }
2512 
btf_bitfield_show(void * data,u8 bits_offset,u8 nr_bits,struct btf_show * show)2513 static void btf_bitfield_show(void *data, u8 bits_offset,
2514 			      u8 nr_bits, struct btf_show *show)
2515 {
2516 	u16 left_shift_bits, right_shift_bits;
2517 	u8 nr_copy_bytes;
2518 	u8 nr_copy_bits;
2519 	u64 print_num[2] = {};
2520 
2521 	nr_copy_bits = nr_bits + bits_offset;
2522 	nr_copy_bytes = BITS_ROUNDUP_BYTES(nr_copy_bits);
2523 
2524 	memcpy(print_num, data, nr_copy_bytes);
2525 
2526 #ifdef __BIG_ENDIAN_BITFIELD
2527 	left_shift_bits = bits_offset;
2528 #else
2529 	left_shift_bits = BITS_PER_U128 - nr_copy_bits;
2530 #endif
2531 	right_shift_bits = BITS_PER_U128 - nr_bits;
2532 
2533 	btf_int128_shift(print_num, left_shift_bits, right_shift_bits);
2534 	btf_int128_print(show, print_num);
2535 }
2536 
btf_int_bits_show(const struct btf * btf,const struct btf_type * t,void * data,u8 bits_offset,struct btf_show * show)2537 static void btf_int_bits_show(const struct btf *btf,
2538 			      const struct btf_type *t,
2539 			      void *data, u8 bits_offset,
2540 			      struct btf_show *show)
2541 {
2542 	u32 int_data = btf_type_int(t);
2543 	u8 nr_bits = BTF_INT_BITS(int_data);
2544 	u8 total_bits_offset;
2545 
2546 	/*
2547 	 * bits_offset is at most 7.
2548 	 * BTF_INT_OFFSET() cannot exceed 128 bits.
2549 	 */
2550 	total_bits_offset = bits_offset + BTF_INT_OFFSET(int_data);
2551 	data += BITS_ROUNDDOWN_BYTES(total_bits_offset);
2552 	bits_offset = BITS_PER_BYTE_MASKED(total_bits_offset);
2553 	btf_bitfield_show(data, bits_offset, nr_bits, show);
2554 }
2555 
btf_int_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)2556 static void btf_int_show(const struct btf *btf, const struct btf_type *t,
2557 			 u32 type_id, void *data, u8 bits_offset,
2558 			 struct btf_show *show)
2559 {
2560 	u32 int_data = btf_type_int(t);
2561 	u8 encoding = BTF_INT_ENCODING(int_data);
2562 	bool sign = encoding & BTF_INT_SIGNED;
2563 	u8 nr_bits = BTF_INT_BITS(int_data);
2564 	void *safe_data;
2565 
2566 	safe_data = btf_show_start_type(show, t, type_id, data);
2567 	if (!safe_data)
2568 		return;
2569 
2570 	if (bits_offset || BTF_INT_OFFSET(int_data) ||
2571 	    BITS_PER_BYTE_MASKED(nr_bits)) {
2572 		btf_int_bits_show(btf, t, safe_data, bits_offset, show);
2573 		goto out;
2574 	}
2575 
2576 	switch (nr_bits) {
2577 	case 128:
2578 		btf_int128_print(show, safe_data);
2579 		break;
2580 	case 64:
2581 		if (sign)
2582 			btf_show_type_value(show, "%lld", *(s64 *)safe_data);
2583 		else
2584 			btf_show_type_value(show, "%llu", *(u64 *)safe_data);
2585 		break;
2586 	case 32:
2587 		if (sign)
2588 			btf_show_type_value(show, "%d", *(s32 *)safe_data);
2589 		else
2590 			btf_show_type_value(show, "%u", *(u32 *)safe_data);
2591 		break;
2592 	case 16:
2593 		if (sign)
2594 			btf_show_type_value(show, "%d", *(s16 *)safe_data);
2595 		else
2596 			btf_show_type_value(show, "%u", *(u16 *)safe_data);
2597 		break;
2598 	case 8:
2599 		if (show->state.array_encoding == BTF_INT_CHAR) {
2600 			/* check for null terminator */
2601 			if (show->state.array_terminated)
2602 				break;
2603 			if (*(char *)data == '\0') {
2604 				show->state.array_terminated = 1;
2605 				break;
2606 			}
2607 			if (isprint(*(char *)data)) {
2608 				btf_show_type_value(show, "'%c'",
2609 						    *(char *)safe_data);
2610 				break;
2611 			}
2612 		}
2613 		if (sign)
2614 			btf_show_type_value(show, "%d", *(s8 *)safe_data);
2615 		else
2616 			btf_show_type_value(show, "%u", *(u8 *)safe_data);
2617 		break;
2618 	default:
2619 		btf_int_bits_show(btf, t, safe_data, bits_offset, show);
2620 		break;
2621 	}
2622 out:
2623 	btf_show_end_type(show);
2624 }
2625 
2626 static const struct btf_kind_operations int_ops = {
2627 	.check_meta = btf_int_check_meta,
2628 	.resolve = btf_df_resolve,
2629 	.check_member = btf_int_check_member,
2630 	.check_kflag_member = btf_int_check_kflag_member,
2631 	.log_details = btf_int_log,
2632 	.show = btf_int_show,
2633 };
2634 
btf_modifier_check_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const struct btf_type * member_type)2635 static int btf_modifier_check_member(struct btf_verifier_env *env,
2636 				     const struct btf_type *struct_type,
2637 				     const struct btf_member *member,
2638 				     const struct btf_type *member_type)
2639 {
2640 	const struct btf_type *resolved_type;
2641 	u32 resolved_type_id = member->type;
2642 	struct btf_member resolved_member;
2643 	struct btf *btf = env->btf;
2644 
2645 	resolved_type = btf_type_id_size(btf, &resolved_type_id, NULL);
2646 	if (!resolved_type) {
2647 		btf_verifier_log_member(env, struct_type, member,
2648 					"Invalid member");
2649 		return -EINVAL;
2650 	}
2651 
2652 	resolved_member = *member;
2653 	resolved_member.type = resolved_type_id;
2654 
2655 	return btf_type_ops(resolved_type)->check_member(env, struct_type,
2656 							 &resolved_member,
2657 							 resolved_type);
2658 }
2659 
btf_modifier_check_kflag_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const struct btf_type * member_type)2660 static int btf_modifier_check_kflag_member(struct btf_verifier_env *env,
2661 					   const struct btf_type *struct_type,
2662 					   const struct btf_member *member,
2663 					   const struct btf_type *member_type)
2664 {
2665 	const struct btf_type *resolved_type;
2666 	u32 resolved_type_id = member->type;
2667 	struct btf_member resolved_member;
2668 	struct btf *btf = env->btf;
2669 
2670 	resolved_type = btf_type_id_size(btf, &resolved_type_id, NULL);
2671 	if (!resolved_type) {
2672 		btf_verifier_log_member(env, struct_type, member,
2673 					"Invalid member");
2674 		return -EINVAL;
2675 	}
2676 
2677 	resolved_member = *member;
2678 	resolved_member.type = resolved_type_id;
2679 
2680 	return btf_type_ops(resolved_type)->check_kflag_member(env, struct_type,
2681 							       &resolved_member,
2682 							       resolved_type);
2683 }
2684 
btf_ptr_check_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const struct btf_type * member_type)2685 static int btf_ptr_check_member(struct btf_verifier_env *env,
2686 				const struct btf_type *struct_type,
2687 				const struct btf_member *member,
2688 				const struct btf_type *member_type)
2689 {
2690 	u32 struct_size, struct_bits_off, bytes_offset;
2691 
2692 	struct_size = struct_type->size;
2693 	struct_bits_off = member->offset;
2694 	bytes_offset = BITS_ROUNDDOWN_BYTES(struct_bits_off);
2695 
2696 	if (BITS_PER_BYTE_MASKED(struct_bits_off)) {
2697 		btf_verifier_log_member(env, struct_type, member,
2698 					"Member is not byte aligned");
2699 		return -EINVAL;
2700 	}
2701 
2702 	if (struct_size - bytes_offset < sizeof(void *)) {
2703 		btf_verifier_log_member(env, struct_type, member,
2704 					"Member exceeds struct_size");
2705 		return -EINVAL;
2706 	}
2707 
2708 	return 0;
2709 }
2710 
btf_ref_type_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)2711 static int btf_ref_type_check_meta(struct btf_verifier_env *env,
2712 				   const struct btf_type *t,
2713 				   u32 meta_left)
2714 {
2715 	const char *value;
2716 
2717 	if (btf_type_vlen(t)) {
2718 		btf_verifier_log_type(env, t, "vlen != 0");
2719 		return -EINVAL;
2720 	}
2721 
2722 	if (btf_type_kflag(t) && !btf_type_is_type_tag(t)) {
2723 		btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
2724 		return -EINVAL;
2725 	}
2726 
2727 	if (!BTF_TYPE_ID_VALID(t->type)) {
2728 		btf_verifier_log_type(env, t, "Invalid type_id");
2729 		return -EINVAL;
2730 	}
2731 
2732 	/* typedef/type_tag type must have a valid name, and other ref types,
2733 	 * volatile, const, restrict, should have a null name.
2734 	 */
2735 	if (BTF_INFO_KIND(t->info) == BTF_KIND_TYPEDEF) {
2736 		if (!t->name_off ||
2737 		    !btf_name_valid_identifier(env->btf, t->name_off)) {
2738 			btf_verifier_log_type(env, t, "Invalid name");
2739 			return -EINVAL;
2740 		}
2741 	} else if (BTF_INFO_KIND(t->info) == BTF_KIND_TYPE_TAG) {
2742 		value = btf_name_by_offset(env->btf, t->name_off);
2743 		if (!value || !value[0]) {
2744 			btf_verifier_log_type(env, t, "Invalid name");
2745 			return -EINVAL;
2746 		}
2747 	} else {
2748 		if (t->name_off) {
2749 			btf_verifier_log_type(env, t, "Invalid name");
2750 			return -EINVAL;
2751 		}
2752 	}
2753 
2754 	btf_verifier_log_type(env, t, NULL);
2755 
2756 	return 0;
2757 }
2758 
btf_modifier_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)2759 static int btf_modifier_resolve(struct btf_verifier_env *env,
2760 				const struct resolve_vertex *v)
2761 {
2762 	const struct btf_type *t = v->t;
2763 	const struct btf_type *next_type;
2764 	u32 next_type_id = t->type;
2765 	struct btf *btf = env->btf;
2766 
2767 	next_type = btf_type_by_id(btf, next_type_id);
2768 	if (!next_type || btf_type_is_resolve_source_only(next_type)) {
2769 		btf_verifier_log_type(env, v->t, "Invalid type_id");
2770 		return -EINVAL;
2771 	}
2772 
2773 	if (!env_type_is_resolve_sink(env, next_type) &&
2774 	    !env_type_is_resolved(env, next_type_id))
2775 		return env_stack_push(env, next_type, next_type_id);
2776 
2777 	/* Figure out the resolved next_type_id with size.
2778 	 * They will be stored in the current modifier's
2779 	 * resolved_ids and resolved_sizes such that it can
2780 	 * save us a few type-following when we use it later (e.g. in
2781 	 * pretty print).
2782 	 */
2783 	if (!btf_type_id_size(btf, &next_type_id, NULL)) {
2784 		if (env_type_is_resolved(env, next_type_id))
2785 			next_type = btf_type_id_resolve(btf, &next_type_id);
2786 
2787 		/* "typedef void new_void", "const void"...etc */
2788 		if (!btf_type_is_void(next_type) &&
2789 		    !btf_type_is_fwd(next_type) &&
2790 		    !btf_type_is_func_proto(next_type)) {
2791 			btf_verifier_log_type(env, v->t, "Invalid type_id");
2792 			return -EINVAL;
2793 		}
2794 	}
2795 
2796 	env_stack_pop_resolved(env, next_type_id, 0);
2797 
2798 	return 0;
2799 }
2800 
btf_var_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)2801 static int btf_var_resolve(struct btf_verifier_env *env,
2802 			   const struct resolve_vertex *v)
2803 {
2804 	const struct btf_type *next_type;
2805 	const struct btf_type *t = v->t;
2806 	u32 next_type_id = t->type;
2807 	struct btf *btf = env->btf;
2808 
2809 	next_type = btf_type_by_id(btf, next_type_id);
2810 	if (!next_type || btf_type_is_resolve_source_only(next_type)) {
2811 		btf_verifier_log_type(env, v->t, "Invalid type_id");
2812 		return -EINVAL;
2813 	}
2814 
2815 	if (!env_type_is_resolve_sink(env, next_type) &&
2816 	    !env_type_is_resolved(env, next_type_id))
2817 		return env_stack_push(env, next_type, next_type_id);
2818 
2819 	if (btf_type_is_modifier(next_type)) {
2820 		const struct btf_type *resolved_type;
2821 		u32 resolved_type_id;
2822 
2823 		resolved_type_id = next_type_id;
2824 		resolved_type = btf_type_id_resolve(btf, &resolved_type_id);
2825 
2826 		if (btf_type_is_ptr(resolved_type) &&
2827 		    !env_type_is_resolve_sink(env, resolved_type) &&
2828 		    !env_type_is_resolved(env, resolved_type_id))
2829 			return env_stack_push(env, resolved_type,
2830 					      resolved_type_id);
2831 	}
2832 
2833 	/* We must resolve to something concrete at this point, no
2834 	 * forward types or similar that would resolve to size of
2835 	 * zero is allowed.
2836 	 */
2837 	if (!btf_type_id_size(btf, &next_type_id, NULL)) {
2838 		btf_verifier_log_type(env, v->t, "Invalid type_id");
2839 		return -EINVAL;
2840 	}
2841 
2842 	env_stack_pop_resolved(env, next_type_id, 0);
2843 
2844 	return 0;
2845 }
2846 
btf_ptr_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)2847 static int btf_ptr_resolve(struct btf_verifier_env *env,
2848 			   const struct resolve_vertex *v)
2849 {
2850 	const struct btf_type *next_type;
2851 	const struct btf_type *t = v->t;
2852 	u32 next_type_id = t->type;
2853 	struct btf *btf = env->btf;
2854 
2855 	next_type = btf_type_by_id(btf, next_type_id);
2856 	if (!next_type || btf_type_is_resolve_source_only(next_type)) {
2857 		btf_verifier_log_type(env, v->t, "Invalid type_id");
2858 		return -EINVAL;
2859 	}
2860 
2861 	if (!env_type_is_resolve_sink(env, next_type) &&
2862 	    !env_type_is_resolved(env, next_type_id))
2863 		return env_stack_push(env, next_type, next_type_id);
2864 
2865 	/* If the modifier was RESOLVED during RESOLVE_STRUCT_OR_ARRAY,
2866 	 * the modifier may have stopped resolving when it was resolved
2867 	 * to a ptr (last-resolved-ptr).
2868 	 *
2869 	 * We now need to continue from the last-resolved-ptr to
2870 	 * ensure the last-resolved-ptr will not referring back to
2871 	 * the current ptr (t).
2872 	 */
2873 	if (btf_type_is_modifier(next_type)) {
2874 		const struct btf_type *resolved_type;
2875 		u32 resolved_type_id;
2876 
2877 		resolved_type_id = next_type_id;
2878 		resolved_type = btf_type_id_resolve(btf, &resolved_type_id);
2879 
2880 		if (btf_type_is_ptr(resolved_type) &&
2881 		    !env_type_is_resolve_sink(env, resolved_type) &&
2882 		    !env_type_is_resolved(env, resolved_type_id))
2883 			return env_stack_push(env, resolved_type,
2884 					      resolved_type_id);
2885 	}
2886 
2887 	if (!btf_type_id_size(btf, &next_type_id, NULL)) {
2888 		if (env_type_is_resolved(env, next_type_id))
2889 			next_type = btf_type_id_resolve(btf, &next_type_id);
2890 
2891 		if (!btf_type_is_void(next_type) &&
2892 		    !btf_type_is_fwd(next_type) &&
2893 		    !btf_type_is_func_proto(next_type)) {
2894 			btf_verifier_log_type(env, v->t, "Invalid type_id");
2895 			return -EINVAL;
2896 		}
2897 	}
2898 
2899 	env_stack_pop_resolved(env, next_type_id, 0);
2900 
2901 	return 0;
2902 }
2903 
btf_modifier_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)2904 static void btf_modifier_show(const struct btf *btf,
2905 			      const struct btf_type *t,
2906 			      u32 type_id, void *data,
2907 			      u8 bits_offset, struct btf_show *show)
2908 {
2909 	if (btf->resolved_ids)
2910 		t = btf_type_id_resolve(btf, &type_id);
2911 	else
2912 		t = btf_type_skip_modifiers(btf, type_id, NULL);
2913 
2914 	btf_type_ops(t)->show(btf, t, type_id, data, bits_offset, show);
2915 }
2916 
btf_var_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)2917 static void btf_var_show(const struct btf *btf, const struct btf_type *t,
2918 			 u32 type_id, void *data, u8 bits_offset,
2919 			 struct btf_show *show)
2920 {
2921 	t = btf_type_id_resolve(btf, &type_id);
2922 
2923 	btf_type_ops(t)->show(btf, t, type_id, data, bits_offset, show);
2924 }
2925 
btf_ptr_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)2926 static void btf_ptr_show(const struct btf *btf, const struct btf_type *t,
2927 			 u32 type_id, void *data, u8 bits_offset,
2928 			 struct btf_show *show)
2929 {
2930 	void *safe_data;
2931 
2932 	safe_data = btf_show_start_type(show, t, type_id, data);
2933 	if (!safe_data)
2934 		return;
2935 
2936 	/* It is a hashed value unless BTF_SHOW_PTR_RAW is specified */
2937 	if (show->flags & BTF_SHOW_PTR_RAW)
2938 		btf_show_type_value(show, "0x%px", *(void **)safe_data);
2939 	else
2940 		btf_show_type_value(show, "0x%p", *(void **)safe_data);
2941 	btf_show_end_type(show);
2942 }
2943 
btf_ref_type_log(struct btf_verifier_env * env,const struct btf_type * t)2944 static void btf_ref_type_log(struct btf_verifier_env *env,
2945 			     const struct btf_type *t)
2946 {
2947 	btf_verifier_log(env, "type_id=%u", t->type);
2948 }
2949 
2950 static const struct btf_kind_operations modifier_ops = {
2951 	.check_meta = btf_ref_type_check_meta,
2952 	.resolve = btf_modifier_resolve,
2953 	.check_member = btf_modifier_check_member,
2954 	.check_kflag_member = btf_modifier_check_kflag_member,
2955 	.log_details = btf_ref_type_log,
2956 	.show = btf_modifier_show,
2957 };
2958 
2959 static const struct btf_kind_operations ptr_ops = {
2960 	.check_meta = btf_ref_type_check_meta,
2961 	.resolve = btf_ptr_resolve,
2962 	.check_member = btf_ptr_check_member,
2963 	.check_kflag_member = btf_generic_check_kflag_member,
2964 	.log_details = btf_ref_type_log,
2965 	.show = btf_ptr_show,
2966 };
2967 
btf_fwd_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)2968 static s32 btf_fwd_check_meta(struct btf_verifier_env *env,
2969 			      const struct btf_type *t,
2970 			      u32 meta_left)
2971 {
2972 	if (btf_type_vlen(t)) {
2973 		btf_verifier_log_type(env, t, "vlen != 0");
2974 		return -EINVAL;
2975 	}
2976 
2977 	if (t->type) {
2978 		btf_verifier_log_type(env, t, "type != 0");
2979 		return -EINVAL;
2980 	}
2981 
2982 	/* fwd type must have a valid name */
2983 	if (!t->name_off ||
2984 	    !btf_name_valid_identifier(env->btf, t->name_off)) {
2985 		btf_verifier_log_type(env, t, "Invalid name");
2986 		return -EINVAL;
2987 	}
2988 
2989 	btf_verifier_log_type(env, t, NULL);
2990 
2991 	return 0;
2992 }
2993 
btf_fwd_type_log(struct btf_verifier_env * env,const struct btf_type * t)2994 static void btf_fwd_type_log(struct btf_verifier_env *env,
2995 			     const struct btf_type *t)
2996 {
2997 	btf_verifier_log(env, "%s", btf_type_kflag(t) ? "union" : "struct");
2998 }
2999 
3000 static const struct btf_kind_operations fwd_ops = {
3001 	.check_meta = btf_fwd_check_meta,
3002 	.resolve = btf_df_resolve,
3003 	.check_member = btf_df_check_member,
3004 	.check_kflag_member = btf_df_check_kflag_member,
3005 	.log_details = btf_fwd_type_log,
3006 	.show = btf_df_show,
3007 };
3008 
btf_array_check_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const struct btf_type * member_type)3009 static int btf_array_check_member(struct btf_verifier_env *env,
3010 				  const struct btf_type *struct_type,
3011 				  const struct btf_member *member,
3012 				  const struct btf_type *member_type)
3013 {
3014 	u32 struct_bits_off = member->offset;
3015 	u32 struct_size, bytes_offset;
3016 	u32 array_type_id, array_size;
3017 	struct btf *btf = env->btf;
3018 
3019 	if (BITS_PER_BYTE_MASKED(struct_bits_off)) {
3020 		btf_verifier_log_member(env, struct_type, member,
3021 					"Member is not byte aligned");
3022 		return -EINVAL;
3023 	}
3024 
3025 	array_type_id = member->type;
3026 	btf_type_id_size(btf, &array_type_id, &array_size);
3027 	struct_size = struct_type->size;
3028 	bytes_offset = BITS_ROUNDDOWN_BYTES(struct_bits_off);
3029 	if (struct_size - bytes_offset < array_size) {
3030 		btf_verifier_log_member(env, struct_type, member,
3031 					"Member exceeds struct_size");
3032 		return -EINVAL;
3033 	}
3034 
3035 	return 0;
3036 }
3037 
btf_array_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)3038 static s32 btf_array_check_meta(struct btf_verifier_env *env,
3039 				const struct btf_type *t,
3040 				u32 meta_left)
3041 {
3042 	const struct btf_array *array = btf_type_array(t);
3043 	u32 meta_needed = sizeof(*array);
3044 
3045 	if (meta_left < meta_needed) {
3046 		btf_verifier_log_basic(env, t,
3047 				       "meta_left:%u meta_needed:%u",
3048 				       meta_left, meta_needed);
3049 		return -EINVAL;
3050 	}
3051 
3052 	/* array type should not have a name */
3053 	if (t->name_off) {
3054 		btf_verifier_log_type(env, t, "Invalid name");
3055 		return -EINVAL;
3056 	}
3057 
3058 	if (btf_type_vlen(t)) {
3059 		btf_verifier_log_type(env, t, "vlen != 0");
3060 		return -EINVAL;
3061 	}
3062 
3063 	if (btf_type_kflag(t)) {
3064 		btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
3065 		return -EINVAL;
3066 	}
3067 
3068 	if (t->size) {
3069 		btf_verifier_log_type(env, t, "size != 0");
3070 		return -EINVAL;
3071 	}
3072 
3073 	/* Array elem type and index type cannot be in type void,
3074 	 * so !array->type and !array->index_type are not allowed.
3075 	 */
3076 	if (!array->type || !BTF_TYPE_ID_VALID(array->type)) {
3077 		btf_verifier_log_type(env, t, "Invalid elem");
3078 		return -EINVAL;
3079 	}
3080 
3081 	if (!array->index_type || !BTF_TYPE_ID_VALID(array->index_type)) {
3082 		btf_verifier_log_type(env, t, "Invalid index");
3083 		return -EINVAL;
3084 	}
3085 
3086 	btf_verifier_log_type(env, t, NULL);
3087 
3088 	return meta_needed;
3089 }
3090 
btf_array_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)3091 static int btf_array_resolve(struct btf_verifier_env *env,
3092 			     const struct resolve_vertex *v)
3093 {
3094 	const struct btf_array *array = btf_type_array(v->t);
3095 	const struct btf_type *elem_type, *index_type;
3096 	u32 elem_type_id, index_type_id;
3097 	struct btf *btf = env->btf;
3098 	u32 elem_size;
3099 
3100 	/* Check array->index_type */
3101 	index_type_id = array->index_type;
3102 	index_type = btf_type_by_id(btf, index_type_id);
3103 	if (btf_type_nosize_or_null(index_type) ||
3104 	    btf_type_is_resolve_source_only(index_type)) {
3105 		btf_verifier_log_type(env, v->t, "Invalid index");
3106 		return -EINVAL;
3107 	}
3108 
3109 	if (!env_type_is_resolve_sink(env, index_type) &&
3110 	    !env_type_is_resolved(env, index_type_id))
3111 		return env_stack_push(env, index_type, index_type_id);
3112 
3113 	index_type = btf_type_id_size(btf, &index_type_id, NULL);
3114 	if (!index_type || !btf_type_is_int(index_type) ||
3115 	    !btf_type_int_is_regular(index_type)) {
3116 		btf_verifier_log_type(env, v->t, "Invalid index");
3117 		return -EINVAL;
3118 	}
3119 
3120 	/* Check array->type */
3121 	elem_type_id = array->type;
3122 	elem_type = btf_type_by_id(btf, elem_type_id);
3123 	if (btf_type_nosize_or_null(elem_type) ||
3124 	    btf_type_is_resolve_source_only(elem_type)) {
3125 		btf_verifier_log_type(env, v->t,
3126 				      "Invalid elem");
3127 		return -EINVAL;
3128 	}
3129 
3130 	if (!env_type_is_resolve_sink(env, elem_type) &&
3131 	    !env_type_is_resolved(env, elem_type_id))
3132 		return env_stack_push(env, elem_type, elem_type_id);
3133 
3134 	elem_type = btf_type_id_size(btf, &elem_type_id, &elem_size);
3135 	if (!elem_type) {
3136 		btf_verifier_log_type(env, v->t, "Invalid elem");
3137 		return -EINVAL;
3138 	}
3139 
3140 	if (btf_type_is_int(elem_type) && !btf_type_int_is_regular(elem_type)) {
3141 		btf_verifier_log_type(env, v->t, "Invalid array of int");
3142 		return -EINVAL;
3143 	}
3144 
3145 	if (array->nelems && elem_size > U32_MAX / array->nelems) {
3146 		btf_verifier_log_type(env, v->t,
3147 				      "Array size overflows U32_MAX");
3148 		return -EINVAL;
3149 	}
3150 
3151 	env_stack_pop_resolved(env, elem_type_id, elem_size * array->nelems);
3152 
3153 	return 0;
3154 }
3155 
btf_array_log(struct btf_verifier_env * env,const struct btf_type * t)3156 static void btf_array_log(struct btf_verifier_env *env,
3157 			  const struct btf_type *t)
3158 {
3159 	const struct btf_array *array = btf_type_array(t);
3160 
3161 	btf_verifier_log(env, "type_id=%u index_type_id=%u nr_elems=%u",
3162 			 array->type, array->index_type, array->nelems);
3163 }
3164 
__btf_array_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)3165 static void __btf_array_show(const struct btf *btf, const struct btf_type *t,
3166 			     u32 type_id, void *data, u8 bits_offset,
3167 			     struct btf_show *show)
3168 {
3169 	const struct btf_array *array = btf_type_array(t);
3170 	const struct btf_kind_operations *elem_ops;
3171 	const struct btf_type *elem_type;
3172 	u32 i, elem_size = 0, elem_type_id;
3173 	u16 encoding = 0;
3174 
3175 	elem_type_id = array->type;
3176 	elem_type = btf_type_skip_modifiers(btf, elem_type_id, NULL);
3177 	if (elem_type && btf_type_has_size(elem_type))
3178 		elem_size = elem_type->size;
3179 
3180 	if (elem_type && btf_type_is_int(elem_type)) {
3181 		u32 int_type = btf_type_int(elem_type);
3182 
3183 		encoding = BTF_INT_ENCODING(int_type);
3184 
3185 		/*
3186 		 * BTF_INT_CHAR encoding never seems to be set for
3187 		 * char arrays, so if size is 1 and element is
3188 		 * printable as a char, we'll do that.
3189 		 */
3190 		if (elem_size == 1)
3191 			encoding = BTF_INT_CHAR;
3192 	}
3193 
3194 	if (!btf_show_start_array_type(show, t, type_id, encoding, data))
3195 		return;
3196 
3197 	if (!elem_type)
3198 		goto out;
3199 	elem_ops = btf_type_ops(elem_type);
3200 
3201 	for (i = 0; i < array->nelems; i++) {
3202 
3203 		btf_show_start_array_member(show);
3204 
3205 		elem_ops->show(btf, elem_type, elem_type_id, data,
3206 			       bits_offset, show);
3207 		data += elem_size;
3208 
3209 		btf_show_end_array_member(show);
3210 
3211 		if (show->state.array_terminated)
3212 			break;
3213 	}
3214 out:
3215 	btf_show_end_array_type(show);
3216 }
3217 
btf_array_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)3218 static void btf_array_show(const struct btf *btf, const struct btf_type *t,
3219 			   u32 type_id, void *data, u8 bits_offset,
3220 			   struct btf_show *show)
3221 {
3222 	const struct btf_member *m = show->state.member;
3223 
3224 	/*
3225 	 * First check if any members would be shown (are non-zero).
3226 	 * See comments above "struct btf_show" definition for more
3227 	 * details on how this works at a high-level.
3228 	 */
3229 	if (show->state.depth > 0 && !(show->flags & BTF_SHOW_ZERO)) {
3230 		if (!show->state.depth_check) {
3231 			show->state.depth_check = show->state.depth + 1;
3232 			show->state.depth_to_show = 0;
3233 		}
3234 		__btf_array_show(btf, t, type_id, data, bits_offset, show);
3235 		show->state.member = m;
3236 
3237 		if (show->state.depth_check != show->state.depth + 1)
3238 			return;
3239 		show->state.depth_check = 0;
3240 
3241 		if (show->state.depth_to_show <= show->state.depth)
3242 			return;
3243 		/*
3244 		 * Reaching here indicates we have recursed and found
3245 		 * non-zero array member(s).
3246 		 */
3247 	}
3248 	__btf_array_show(btf, t, type_id, data, bits_offset, show);
3249 }
3250 
3251 static const struct btf_kind_operations array_ops = {
3252 	.check_meta = btf_array_check_meta,
3253 	.resolve = btf_array_resolve,
3254 	.check_member = btf_array_check_member,
3255 	.check_kflag_member = btf_generic_check_kflag_member,
3256 	.log_details = btf_array_log,
3257 	.show = btf_array_show,
3258 };
3259 
btf_struct_check_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const struct btf_type * member_type)3260 static int btf_struct_check_member(struct btf_verifier_env *env,
3261 				   const struct btf_type *struct_type,
3262 				   const struct btf_member *member,
3263 				   const struct btf_type *member_type)
3264 {
3265 	u32 struct_bits_off = member->offset;
3266 	u32 struct_size, bytes_offset;
3267 
3268 	if (BITS_PER_BYTE_MASKED(struct_bits_off)) {
3269 		btf_verifier_log_member(env, struct_type, member,
3270 					"Member is not byte aligned");
3271 		return -EINVAL;
3272 	}
3273 
3274 	struct_size = struct_type->size;
3275 	bytes_offset = BITS_ROUNDDOWN_BYTES(struct_bits_off);
3276 	if (struct_size - bytes_offset < member_type->size) {
3277 		btf_verifier_log_member(env, struct_type, member,
3278 					"Member exceeds struct_size");
3279 		return -EINVAL;
3280 	}
3281 
3282 	return 0;
3283 }
3284 
btf_struct_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)3285 static s32 btf_struct_check_meta(struct btf_verifier_env *env,
3286 				 const struct btf_type *t,
3287 				 u32 meta_left)
3288 {
3289 	bool is_union = BTF_INFO_KIND(t->info) == BTF_KIND_UNION;
3290 	const struct btf_member *member;
3291 	u32 meta_needed, last_offset;
3292 	struct btf *btf = env->btf;
3293 	u32 struct_size = t->size;
3294 	u32 offset;
3295 	u32 i;
3296 
3297 	meta_needed = btf_type_vlen(t) * sizeof(*member);
3298 	if (meta_left < meta_needed) {
3299 		btf_verifier_log_basic(env, t,
3300 				       "meta_left:%u meta_needed:%u",
3301 				       meta_left, meta_needed);
3302 		return -EINVAL;
3303 	}
3304 
3305 	/* struct type either no name or a valid one */
3306 	if (t->name_off &&
3307 	    !btf_name_valid_identifier(env->btf, t->name_off)) {
3308 		btf_verifier_log_type(env, t, "Invalid name");
3309 		return -EINVAL;
3310 	}
3311 
3312 	btf_verifier_log_type(env, t, NULL);
3313 
3314 	last_offset = 0;
3315 	for_each_member(i, t, member) {
3316 		if (!btf_name_offset_valid(btf, member->name_off)) {
3317 			btf_verifier_log_member(env, t, member,
3318 						"Invalid member name_offset:%u",
3319 						member->name_off);
3320 			return -EINVAL;
3321 		}
3322 
3323 		/* struct member either no name or a valid one */
3324 		if (member->name_off &&
3325 		    !btf_name_valid_identifier(btf, member->name_off)) {
3326 			btf_verifier_log_member(env, t, member, "Invalid name");
3327 			return -EINVAL;
3328 		}
3329 		/* A member cannot be in type void */
3330 		if (!member->type || !BTF_TYPE_ID_VALID(member->type)) {
3331 			btf_verifier_log_member(env, t, member,
3332 						"Invalid type_id");
3333 			return -EINVAL;
3334 		}
3335 
3336 		offset = __btf_member_bit_offset(t, member);
3337 		if (is_union && offset) {
3338 			btf_verifier_log_member(env, t, member,
3339 						"Invalid member bits_offset");
3340 			return -EINVAL;
3341 		}
3342 
3343 		/*
3344 		 * ">" instead of ">=" because the last member could be
3345 		 * "char a[0];"
3346 		 */
3347 		if (last_offset > offset) {
3348 			btf_verifier_log_member(env, t, member,
3349 						"Invalid member bits_offset");
3350 			return -EINVAL;
3351 		}
3352 
3353 		if (BITS_ROUNDUP_BYTES(offset) > struct_size) {
3354 			btf_verifier_log_member(env, t, member,
3355 						"Member bits_offset exceeds its struct size");
3356 			return -EINVAL;
3357 		}
3358 
3359 		btf_verifier_log_member(env, t, member, NULL);
3360 		last_offset = offset;
3361 	}
3362 
3363 	return meta_needed;
3364 }
3365 
btf_struct_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)3366 static int btf_struct_resolve(struct btf_verifier_env *env,
3367 			      const struct resolve_vertex *v)
3368 {
3369 	const struct btf_member *member;
3370 	int err;
3371 	u32 i;
3372 
3373 	/* Before continue resolving the next_member,
3374 	 * ensure the last member is indeed resolved to a
3375 	 * type with size info.
3376 	 */
3377 	if (v->next_member) {
3378 		const struct btf_type *last_member_type;
3379 		const struct btf_member *last_member;
3380 		u32 last_member_type_id;
3381 
3382 		last_member = btf_type_member(v->t) + v->next_member - 1;
3383 		last_member_type_id = last_member->type;
3384 		if (WARN_ON_ONCE(!env_type_is_resolved(env,
3385 						       last_member_type_id)))
3386 			return -EINVAL;
3387 
3388 		last_member_type = btf_type_by_id(env->btf,
3389 						  last_member_type_id);
3390 		if (btf_type_kflag(v->t))
3391 			err = btf_type_ops(last_member_type)->check_kflag_member(env, v->t,
3392 								last_member,
3393 								last_member_type);
3394 		else
3395 			err = btf_type_ops(last_member_type)->check_member(env, v->t,
3396 								last_member,
3397 								last_member_type);
3398 		if (err)
3399 			return err;
3400 	}
3401 
3402 	for_each_member_from(i, v->next_member, v->t, member) {
3403 		u32 member_type_id = member->type;
3404 		const struct btf_type *member_type = btf_type_by_id(env->btf,
3405 								member_type_id);
3406 
3407 		if (btf_type_nosize_or_null(member_type) ||
3408 		    btf_type_is_resolve_source_only(member_type)) {
3409 			btf_verifier_log_member(env, v->t, member,
3410 						"Invalid member");
3411 			return -EINVAL;
3412 		}
3413 
3414 		if (!env_type_is_resolve_sink(env, member_type) &&
3415 		    !env_type_is_resolved(env, member_type_id)) {
3416 			env_stack_set_next_member(env, i + 1);
3417 			return env_stack_push(env, member_type, member_type_id);
3418 		}
3419 
3420 		if (btf_type_kflag(v->t))
3421 			err = btf_type_ops(member_type)->check_kflag_member(env, v->t,
3422 									    member,
3423 									    member_type);
3424 		else
3425 			err = btf_type_ops(member_type)->check_member(env, v->t,
3426 								      member,
3427 								      member_type);
3428 		if (err)
3429 			return err;
3430 	}
3431 
3432 	env_stack_pop_resolved(env, 0, 0);
3433 
3434 	return 0;
3435 }
3436 
btf_struct_log(struct btf_verifier_env * env,const struct btf_type * t)3437 static void btf_struct_log(struct btf_verifier_env *env,
3438 			   const struct btf_type *t)
3439 {
3440 	btf_verifier_log(env, "size=%u vlen=%u", t->size, btf_type_vlen(t));
3441 }
3442 
3443 enum {
3444 	BTF_FIELD_IGNORE = 0,
3445 	BTF_FIELD_FOUND  = 1,
3446 };
3447 
3448 struct btf_field_info {
3449 	enum btf_field_type type;
3450 	u32 off;
3451 	union {
3452 		struct {
3453 			u32 type_id;
3454 		} kptr;
3455 		struct {
3456 			const char *node_name;
3457 			u32 value_btf_id;
3458 		} graph_root;
3459 	};
3460 };
3461 
btf_find_struct(const struct btf * btf,const struct btf_type * t,u32 off,int sz,enum btf_field_type field_type,struct btf_field_info * info)3462 static int btf_find_struct(const struct btf *btf, const struct btf_type *t,
3463 			   u32 off, int sz, enum btf_field_type field_type,
3464 			   struct btf_field_info *info)
3465 {
3466 	if (!__btf_type_is_struct(t))
3467 		return BTF_FIELD_IGNORE;
3468 	if (t->size != sz)
3469 		return BTF_FIELD_IGNORE;
3470 	info->type = field_type;
3471 	info->off = off;
3472 	return BTF_FIELD_FOUND;
3473 }
3474 
3475 struct btf_type_tag_match {
3476 	const char *name;
3477 	u32 flag;
3478 };
3479 
3480 struct btf_type_tag_walk_ctx {
3481 	const struct btf_type *t;	/* Input/Output */
3482 	u32 id;				/* Output */
3483 	u32 res;			/* Output */
3484 };
3485 
btf_type_tag_walk(const struct btf * btf,struct btf_type_tag_walk_ctx * ctx,const struct btf_type_tag_match * matches,u32 match_cnt)3486 static int btf_type_tag_walk(const struct btf *btf,
3487 			     struct btf_type_tag_walk_ctx *ctx,
3488 			     const struct btf_type_tag_match *matches,
3489 			     u32 match_cnt)
3490 {
3491 	const struct btf_type *t = ctx->t;
3492 	u32 res = 0;
3493 	const char *tag;
3494 	u32 id, i;
3495 
3496 	do {
3497 		id = t->type;
3498 		t = btf_type_by_id(btf, id);
3499 
3500 		if (!btf_type_is_modifier(t))
3501 			break;
3502 
3503 		if (!btf_type_is_type_tag(t) || btf_type_kflag(t))
3504 			continue;
3505 
3506 		tag = __btf_name_by_offset(btf, t->name_off);
3507 		for (i = 0; i < match_cnt; i++) {
3508 			if (strcmp(tag, matches[i].name))
3509 				continue;
3510 			res |= matches[i].flag;
3511 			break;
3512 		}
3513 	} while (true);
3514 
3515 	/* We only support a single tag. */
3516 	if (hweight32(res) > 1)
3517 		return -EINVAL;
3518 
3519 	ctx->t = t;
3520 	ctx->id = id;
3521 	ctx->res = res;
3522 
3523 	return 0;
3524 }
3525 
btf_find_kptr(const struct btf * btf,const struct btf_type * t,u32 off,int sz,struct btf_field_info * info,u32 field_mask)3526 static int btf_find_kptr(const struct btf *btf, const struct btf_type *t,
3527 			 u32 off, int sz, struct btf_field_info *info, u32 field_mask)
3528 {
3529 	static const struct btf_type_tag_match kptr_type_tags[] = {
3530 		{ "kptr_untrusted", BPF_KPTR_UNREF },
3531 		{ "kptr", BPF_KPTR_REF },
3532 		{ "percpu_kptr", BPF_KPTR_PERCPU },
3533 		{ "uptr", BPF_UPTR },
3534 	};
3535 	struct btf_type_tag_walk_ctx ctx;
3536 	enum btf_field_type type = 0;
3537 	int err;
3538 	u32 res_id;
3539 
3540 	/* Permit modifiers on the pointer itself */
3541 	if (btf_type_is_volatile(t))
3542 		t = btf_type_by_id(btf, t->type);
3543 	/* For PTR, sz is always == 8 */
3544 	if (!btf_type_is_ptr(t))
3545 		return BTF_FIELD_IGNORE;
3546 
3547 	ctx.t = t;
3548 	err = btf_type_tag_walk(btf, &ctx, kptr_type_tags,
3549 				ARRAY_SIZE(kptr_type_tags));
3550 	if (err)
3551 		return err;
3552 
3553 	t = ctx.t;
3554 	res_id = ctx.id;
3555 	type = ctx.res;
3556 
3557 	if (!(type & field_mask))
3558 		return BTF_FIELD_IGNORE;
3559 
3560 	/* Only pointer to struct is allowed */
3561 	if (!__btf_type_is_struct(t))
3562 		return -EINVAL;
3563 
3564 	info->type = type;
3565 	info->off = off;
3566 	info->kptr.type_id = res_id;
3567 	return BTF_FIELD_FOUND;
3568 }
3569 
btf_find_next_decl_tag(const struct btf * btf,const struct btf_type * pt,int comp_idx,const char * tag_key,int last_id)3570 int btf_find_next_decl_tag(const struct btf *btf, const struct btf_type *pt,
3571 			   int comp_idx, const char *tag_key, int last_id)
3572 {
3573 	int len = strlen(tag_key);
3574 	int i, n;
3575 
3576 	for (i = last_id + 1, n = btf_nr_types(btf); i < n; i++) {
3577 		const struct btf_type *t = btf_type_by_id(btf, i);
3578 
3579 		if (!btf_type_is_decl_tag(t))
3580 			continue;
3581 		if (pt != btf_type_by_id(btf, t->type))
3582 			continue;
3583 		if (btf_type_decl_tag(t)->component_idx != comp_idx)
3584 			continue;
3585 		if (strncmp(__btf_name_by_offset(btf, t->name_off), tag_key, len))
3586 			continue;
3587 		return i;
3588 	}
3589 	return -ENOENT;
3590 }
3591 
btf_find_decl_tag_value(const struct btf * btf,const struct btf_type * pt,int comp_idx,const char * tag_key)3592 const char *btf_find_decl_tag_value(const struct btf *btf, const struct btf_type *pt,
3593 				    int comp_idx, const char *tag_key)
3594 {
3595 	const char *value = NULL;
3596 	const struct btf_type *t;
3597 	int len, id;
3598 
3599 	id = btf_find_next_decl_tag(btf, pt, comp_idx, tag_key,
3600 				    btf_named_start_id(btf, false) - 1);
3601 	if (id < 0)
3602 		return ERR_PTR(id);
3603 
3604 	t = btf_type_by_id(btf, id);
3605 	len = strlen(tag_key);
3606 	value = __btf_name_by_offset(btf, t->name_off) + len;
3607 
3608 	/* Prevent duplicate entries for same type */
3609 	id = btf_find_next_decl_tag(btf, pt, comp_idx, tag_key, id);
3610 	if (id >= 0)
3611 		return ERR_PTR(-EEXIST);
3612 
3613 	return value;
3614 }
3615 
3616 static int
btf_find_graph_root(const struct btf * btf,const struct btf_type * pt,const struct btf_type * t,int comp_idx,u32 off,int sz,struct btf_field_info * info,enum btf_field_type head_type)3617 btf_find_graph_root(const struct btf *btf, const struct btf_type *pt,
3618 		    const struct btf_type *t, int comp_idx, u32 off,
3619 		    int sz, struct btf_field_info *info,
3620 		    enum btf_field_type head_type)
3621 {
3622 	const char *node_field_name;
3623 	const char *value_type;
3624 	s32 id;
3625 
3626 	if (!__btf_type_is_struct(t))
3627 		return BTF_FIELD_IGNORE;
3628 	if (t->size != sz)
3629 		return BTF_FIELD_IGNORE;
3630 	value_type = btf_find_decl_tag_value(btf, pt, comp_idx, "contains:");
3631 	if (IS_ERR(value_type))
3632 		return -EINVAL;
3633 	node_field_name = strstr(value_type, ":");
3634 	if (!node_field_name)
3635 		return -EINVAL;
3636 	value_type = kstrndup(value_type, node_field_name - value_type,
3637 			      GFP_KERNEL_ACCOUNT | __GFP_NOWARN);
3638 	if (!value_type)
3639 		return -ENOMEM;
3640 	id = btf_find_by_name_kind(btf, value_type, BTF_KIND_STRUCT);
3641 	kfree(value_type);
3642 	if (id < 0)
3643 		return id;
3644 	node_field_name++;
3645 	if (str_is_empty(node_field_name))
3646 		return -EINVAL;
3647 	info->type = head_type;
3648 	info->off = off;
3649 	info->graph_root.value_btf_id = id;
3650 	info->graph_root.node_name = node_field_name;
3651 	return BTF_FIELD_FOUND;
3652 }
3653 
btf_get_field_type(const struct btf * btf,const struct btf_type * var_type,u32 field_mask,u32 * seen_mask,int * align,int * sz)3654 static int btf_get_field_type(const struct btf *btf, const struct btf_type *var_type,
3655 			      u32 field_mask, u32 *seen_mask, int *align, int *sz)
3656 {
3657 	const struct {
3658 		enum btf_field_type type;
3659 		const char *const name;
3660 		const bool is_unique;
3661 	} field_types[] = {
3662 		{ BPF_SPIN_LOCK, "bpf_spin_lock", true },
3663 		{ BPF_RES_SPIN_LOCK, "bpf_res_spin_lock", true },
3664 		{ BPF_TIMER, "bpf_timer", true },
3665 		{ BPF_WORKQUEUE, "bpf_wq", true },
3666 		{ BPF_TASK_WORK, "bpf_task_work", true },
3667 		{ BPF_LIST_HEAD, "bpf_list_head", false },
3668 		{ BPF_LIST_NODE, "bpf_list_node", false },
3669 		{ BPF_RB_ROOT, "bpf_rb_root", false },
3670 		{ BPF_RB_NODE, "bpf_rb_node", false },
3671 		{ BPF_REFCOUNT, "bpf_refcount", true },
3672 	};
3673 	int type = 0, i;
3674 	const char *name = __btf_name_by_offset(btf, var_type->name_off);
3675 	const char *field_type_name;
3676 	enum btf_field_type field_type;
3677 	bool is_unique;
3678 
3679 	for (i = 0; i < ARRAY_SIZE(field_types); ++i) {
3680 		field_type = field_types[i].type;
3681 		field_type_name = field_types[i].name;
3682 		is_unique = field_types[i].is_unique;
3683 		if (!(field_mask & field_type) || strcmp(name, field_type_name))
3684 			continue;
3685 		if (is_unique) {
3686 			if (*seen_mask & field_type)
3687 				return -E2BIG;
3688 			*seen_mask |= field_type;
3689 		}
3690 		type = field_type;
3691 		goto end;
3692 	}
3693 
3694 	/* Only return BPF_KPTR when all other types with matchable names fail */
3695 	if (field_mask & (BPF_KPTR | BPF_UPTR) && !__btf_type_is_struct(var_type)) {
3696 		type = BPF_KPTR_REF;
3697 		goto end;
3698 	}
3699 	return 0;
3700 end:
3701 	*sz = btf_field_type_size(type);
3702 	*align = btf_field_type_align(type);
3703 	return type;
3704 }
3705 
3706 /* Repeat a number of fields for a specified number of times.
3707  *
3708  * Copy the fields starting from the first field and repeat them for
3709  * repeat_cnt times. The fields are repeated by adding the offset of each
3710  * field with
3711  *   (i + 1) * elem_size
3712  * where i is the repeat index and elem_size is the size of an element.
3713  */
btf_repeat_fields(struct btf_field_info * info,int info_cnt,u32 field_cnt,u32 repeat_cnt,u32 elem_size)3714 static int btf_repeat_fields(struct btf_field_info *info, int info_cnt,
3715 			     u32 field_cnt, u32 repeat_cnt, u32 elem_size)
3716 {
3717 	u32 i, j, total_cnt, total_repeats;
3718 	u32 cur;
3719 
3720 	/* Ensure not repeating fields that should not be repeated. */
3721 	for (i = 0; i < field_cnt; i++) {
3722 		switch (info[i].type) {
3723 		case BPF_KPTR_UNREF:
3724 		case BPF_KPTR_REF:
3725 		case BPF_KPTR_PERCPU:
3726 		case BPF_UPTR:
3727 		case BPF_LIST_HEAD:
3728 		case BPF_RB_ROOT:
3729 			break;
3730 		default:
3731 			return -EINVAL;
3732 		}
3733 	}
3734 
3735 	if (check_add_overflow(repeat_cnt, 1, &total_repeats) ||
3736 	    check_mul_overflow(field_cnt, total_repeats, &total_cnt) ||
3737 	    total_cnt > (u32)info_cnt)
3738 		return -E2BIG;
3739 
3740 	cur = field_cnt;
3741 	for (i = 0; i < repeat_cnt; i++) {
3742 		memcpy(&info[cur], &info[0], field_cnt * sizeof(info[0]));
3743 		for (j = 0; j < field_cnt; j++)
3744 			info[cur++].off += (i + 1) * elem_size;
3745 	}
3746 
3747 	return 0;
3748 }
3749 
3750 static int btf_find_struct_field(const struct btf *btf,
3751 				 const struct btf_type *t, u32 field_mask,
3752 				 struct btf_field_info *info, int info_cnt,
3753 				 u32 level, u32 *seen_mask);
3754 
3755 /* Find special fields in the struct type of a field.
3756  *
3757  * This function is used to find fields of special types that is not a
3758  * global variable or a direct field of a struct type. It also handles the
3759  * repetition if it is the element type of an array.
3760  */
btf_find_nested_struct(const struct btf * btf,const struct btf_type * t,u32 off,u32 nelems,u32 field_mask,struct btf_field_info * info,int info_cnt,u32 level,u32 * seen_mask)3761 static int btf_find_nested_struct(const struct btf *btf, const struct btf_type *t,
3762 				  u32 off, u32 nelems,
3763 				  u32 field_mask, struct btf_field_info *info,
3764 				  int info_cnt, u32 level, u32 *seen_mask)
3765 {
3766 	int ret, err, i;
3767 
3768 	level++;
3769 	if (level >= MAX_RESOLVE_DEPTH)
3770 		return -E2BIG;
3771 
3772 	ret = btf_find_struct_field(btf, t, field_mask, info, info_cnt, level, seen_mask);
3773 
3774 	if (ret <= 0)
3775 		return ret;
3776 
3777 	/* Shift the offsets of the nested struct fields to the offsets
3778 	 * related to the container.
3779 	 */
3780 	for (i = 0; i < ret; i++)
3781 		info[i].off += off;
3782 
3783 	if (nelems > 1) {
3784 		err = btf_repeat_fields(info, info_cnt, ret, nelems - 1, t->size);
3785 		if (err == 0)
3786 			ret *= nelems;
3787 		else
3788 			ret = err;
3789 	}
3790 
3791 	return ret;
3792 }
3793 
btf_find_field_one(const struct btf * btf,const struct btf_type * var,const struct btf_type * var_type,int var_idx,u32 off,u32 expected_size,u32 field_mask,u32 * seen_mask,struct btf_field_info * info,int info_cnt,u32 level)3794 static int btf_find_field_one(const struct btf *btf,
3795 			      const struct btf_type *var,
3796 			      const struct btf_type *var_type,
3797 			      int var_idx,
3798 			      u32 off, u32 expected_size,
3799 			      u32 field_mask, u32 *seen_mask,
3800 			      struct btf_field_info *info, int info_cnt,
3801 			      u32 level)
3802 {
3803 	int ret, align, sz, field_type;
3804 	struct btf_field_info tmp;
3805 	const struct btf_array *array;
3806 	u32 i, nelems = 1;
3807 
3808 	/* Walk into array types to find the element type and the number of
3809 	 * elements in the (flattened) array.
3810 	 */
3811 	for (i = 0; i < MAX_RESOLVE_DEPTH && btf_type_is_array(var_type); i++) {
3812 		array = btf_array(var_type);
3813 		nelems *= array->nelems;
3814 		var_type = btf_type_by_id(btf, array->type);
3815 	}
3816 	if (i == MAX_RESOLVE_DEPTH)
3817 		return -E2BIG;
3818 	if (nelems == 0)
3819 		return 0;
3820 
3821 	field_type = btf_get_field_type(btf, var_type,
3822 					field_mask, seen_mask, &align, &sz);
3823 	/* Look into variables of struct types */
3824 	if (!field_type && __btf_type_is_struct(var_type)) {
3825 		sz = var_type->size;
3826 		if (expected_size && expected_size != sz * nelems)
3827 			return 0;
3828 		ret = btf_find_nested_struct(btf, var_type, off, nelems, field_mask,
3829 					     &info[0], info_cnt, level, seen_mask);
3830 		return ret;
3831 	}
3832 
3833 	if (field_type == 0)
3834 		return 0;
3835 	if (field_type < 0)
3836 		return field_type;
3837 
3838 	if (expected_size && expected_size != sz * nelems)
3839 		return 0;
3840 	if (off % align)
3841 		return 0;
3842 
3843 	switch (field_type) {
3844 	case BPF_SPIN_LOCK:
3845 	case BPF_RES_SPIN_LOCK:
3846 	case BPF_TIMER:
3847 	case BPF_WORKQUEUE:
3848 	case BPF_LIST_NODE:
3849 	case BPF_RB_NODE:
3850 	case BPF_REFCOUNT:
3851 	case BPF_TASK_WORK:
3852 		ret = btf_find_struct(btf, var_type, off, sz, field_type,
3853 				      info_cnt ? &info[0] : &tmp);
3854 		if (ret < 0)
3855 			return ret;
3856 		break;
3857 	case BPF_KPTR_UNREF:
3858 	case BPF_KPTR_REF:
3859 	case BPF_KPTR_PERCPU:
3860 	case BPF_UPTR:
3861 		ret = btf_find_kptr(btf, var_type, off, sz,
3862 				    info_cnt ? &info[0] : &tmp, field_mask);
3863 		if (ret < 0)
3864 			return ret;
3865 		break;
3866 	case BPF_LIST_HEAD:
3867 	case BPF_RB_ROOT:
3868 		ret = btf_find_graph_root(btf, var, var_type,
3869 					  var_idx, off, sz,
3870 					  info_cnt ? &info[0] : &tmp,
3871 					  field_type);
3872 		if (ret < 0)
3873 			return ret;
3874 		break;
3875 	default:
3876 		return -EFAULT;
3877 	}
3878 
3879 	if (ret == BTF_FIELD_IGNORE)
3880 		return 0;
3881 	if (!info_cnt)
3882 		return -E2BIG;
3883 	if (nelems > 1) {
3884 		ret = btf_repeat_fields(info, info_cnt, 1, nelems - 1, sz);
3885 		if (ret < 0)
3886 			return ret;
3887 	}
3888 	return nelems;
3889 }
3890 
btf_find_struct_field(const struct btf * btf,const struct btf_type * t,u32 field_mask,struct btf_field_info * info,int info_cnt,u32 level,u32 * seen_mask)3891 static int btf_find_struct_field(const struct btf *btf,
3892 				 const struct btf_type *t, u32 field_mask,
3893 				 struct btf_field_info *info, int info_cnt,
3894 				 u32 level, u32 *seen_mask)
3895 {
3896 	int ret, idx = 0;
3897 	const struct btf_member *member;
3898 	u32 i, off;
3899 
3900 	for_each_member(i, t, member) {
3901 		const struct btf_type *member_type = btf_type_by_id(btf,
3902 								    member->type);
3903 
3904 		off = __btf_member_bit_offset(t, member);
3905 		if (off % 8)
3906 			/* valid C code cannot generate such BTF */
3907 			return -EINVAL;
3908 		off /= 8;
3909 
3910 		ret = btf_find_field_one(btf, t, member_type, i,
3911 					 off, 0,
3912 					 field_mask, seen_mask,
3913 					 &info[idx], info_cnt - idx, level);
3914 		if (ret < 0)
3915 			return ret;
3916 		idx += ret;
3917 	}
3918 	return idx;
3919 }
3920 
btf_find_datasec_var(const struct btf * btf,const struct btf_type * t,u32 field_mask,struct btf_field_info * info,int info_cnt,u32 level,u32 * seen_mask)3921 static int btf_find_datasec_var(const struct btf *btf, const struct btf_type *t,
3922 				u32 field_mask, struct btf_field_info *info,
3923 				int info_cnt, u32 level, u32 *seen_mask)
3924 {
3925 	int ret, idx = 0;
3926 	const struct btf_var_secinfo *vsi;
3927 	u32 i, off;
3928 
3929 	for_each_vsi(i, t, vsi) {
3930 		const struct btf_type *var = btf_type_by_id(btf, vsi->type);
3931 		const struct btf_type *var_type = btf_type_by_id(btf, var->type);
3932 
3933 		off = vsi->offset;
3934 		ret = btf_find_field_one(btf, var, var_type, -1, off, vsi->size,
3935 					 field_mask, seen_mask,
3936 					 &info[idx], info_cnt - idx,
3937 					 level);
3938 		if (ret < 0)
3939 			return ret;
3940 		idx += ret;
3941 	}
3942 	return idx;
3943 }
3944 
btf_find_field(const struct btf * btf,const struct btf_type * t,u32 field_mask,struct btf_field_info * info,int info_cnt)3945 static int btf_find_field(const struct btf *btf, const struct btf_type *t,
3946 			  u32 field_mask, struct btf_field_info *info,
3947 			  int info_cnt)
3948 {
3949 	u32 seen_mask = 0;
3950 
3951 	if (__btf_type_is_struct(t))
3952 		return btf_find_struct_field(btf, t, field_mask, info, info_cnt, 0, &seen_mask);
3953 	else if (btf_type_is_datasec(t))
3954 		return btf_find_datasec_var(btf, t, field_mask, info, info_cnt, 0, &seen_mask);
3955 	return -EINVAL;
3956 }
3957 
3958 /* Callers have to ensure the life cycle of btf if it is program BTF */
btf_parse_kptr(const struct btf * btf,struct btf_field * field,struct btf_field_info * info)3959 static int btf_parse_kptr(const struct btf *btf, struct btf_field *field,
3960 			  struct btf_field_info *info)
3961 {
3962 	struct module *mod = NULL;
3963 	const struct btf_type *t;
3964 	/* If a matching btf type is found in kernel or module BTFs, kptr_ref
3965 	 * is that BTF, otherwise it's program BTF
3966 	 */
3967 	struct btf *kptr_btf;
3968 	int ret;
3969 	s32 id;
3970 
3971 	/* Find type in map BTF, and use it to look up the matching type
3972 	 * in vmlinux or module BTFs, by name and kind.
3973 	 */
3974 	t = btf_type_by_id(btf, info->kptr.type_id);
3975 	id = bpf_find_btf_id(__btf_name_by_offset(btf, t->name_off), BTF_INFO_KIND(t->info),
3976 			     &kptr_btf);
3977 	if (id == -ENOENT) {
3978 		/* btf_parse_kptr should only be called w/ btf = program BTF */
3979 		WARN_ON_ONCE(btf_is_kernel(btf));
3980 
3981 		/* Type exists only in program BTF. Assume that it's a MEM_ALLOC
3982 		 * kptr allocated via bpf_obj_new
3983 		 */
3984 		field->kptr.dtor = NULL;
3985 		id = info->kptr.type_id;
3986 		kptr_btf = (struct btf *)btf;
3987 		goto found_dtor;
3988 	}
3989 	if (id < 0)
3990 		return id;
3991 
3992 	/* Find and stash the function pointer for the destruction function that
3993 	 * needs to be eventually invoked from the map free path.
3994 	 */
3995 	if (info->type == BPF_KPTR_REF) {
3996 		const struct btf_type *dtor_func;
3997 		const char *dtor_func_name;
3998 		unsigned long addr;
3999 		s32 dtor_btf_id;
4000 
4001 		/* This call also serves as a whitelist of allowed objects that
4002 		 * can be used as a referenced pointer and be stored in a map at
4003 		 * the same time.
4004 		 */
4005 		dtor_btf_id = btf_find_dtor_kfunc(kptr_btf, id);
4006 		if (dtor_btf_id < 0) {
4007 			ret = dtor_btf_id;
4008 			goto end_btf;
4009 		}
4010 
4011 		dtor_func = btf_type_by_id(kptr_btf, dtor_btf_id);
4012 		if (!dtor_func) {
4013 			ret = -ENOENT;
4014 			goto end_btf;
4015 		}
4016 
4017 		if (btf_is_module(kptr_btf)) {
4018 			mod = btf_try_get_module(kptr_btf);
4019 			if (!mod) {
4020 				ret = -ENXIO;
4021 				goto end_btf;
4022 			}
4023 		}
4024 
4025 		/* We already verified dtor_func to be btf_type_is_func
4026 		 * in register_btf_id_dtor_kfuncs.
4027 		 */
4028 		dtor_func_name = __btf_name_by_offset(kptr_btf, dtor_func->name_off);
4029 		addr = kallsyms_lookup_name(dtor_func_name);
4030 		if (!addr) {
4031 			ret = -EINVAL;
4032 			goto end_mod;
4033 		}
4034 		field->kptr.dtor = (void *)addr;
4035 	}
4036 
4037 found_dtor:
4038 	field->kptr.btf_id = id;
4039 	field->kptr.btf = kptr_btf;
4040 	field->kptr.module = mod;
4041 	return 0;
4042 end_mod:
4043 	module_put(mod);
4044 end_btf:
4045 	btf_put(kptr_btf);
4046 	return ret;
4047 }
4048 
btf_parse_graph_root(const struct btf * btf,struct btf_field * field,struct btf_field_info * info,const char * node_type_name,size_t node_type_align)4049 static int btf_parse_graph_root(const struct btf *btf,
4050 				struct btf_field *field,
4051 				struct btf_field_info *info,
4052 				const char *node_type_name,
4053 				size_t node_type_align)
4054 {
4055 	const struct btf_type *t, *n = NULL;
4056 	const struct btf_member *member;
4057 	u32 offset;
4058 	int i;
4059 
4060 	t = btf_type_by_id(btf, info->graph_root.value_btf_id);
4061 	/* We've already checked that value_btf_id is a struct type. We
4062 	 * just need to figure out the offset of the list_node, and
4063 	 * verify its type.
4064 	 */
4065 	for_each_member(i, t, member) {
4066 		if (strcmp(info->graph_root.node_name,
4067 			   __btf_name_by_offset(btf, member->name_off)))
4068 			continue;
4069 		/* Invalid BTF, two members with same name */
4070 		if (n)
4071 			return -EINVAL;
4072 		n = btf_type_by_id(btf, member->type);
4073 		if (!__btf_type_is_struct(n))
4074 			return -EINVAL;
4075 		if (strcmp(node_type_name, __btf_name_by_offset(btf, n->name_off)))
4076 			return -EINVAL;
4077 		offset = __btf_member_bit_offset(n, member);
4078 		if (offset % 8)
4079 			return -EINVAL;
4080 		offset /= 8;
4081 		if (offset % node_type_align)
4082 			return -EINVAL;
4083 
4084 		field->graph_root.btf = (struct btf *)btf;
4085 		field->graph_root.value_btf_id = info->graph_root.value_btf_id;
4086 		field->graph_root.node_offset = offset;
4087 	}
4088 	if (!n)
4089 		return -ENOENT;
4090 	return 0;
4091 }
4092 
btf_parse_list_head(const struct btf * btf,struct btf_field * field,struct btf_field_info * info)4093 static int btf_parse_list_head(const struct btf *btf, struct btf_field *field,
4094 			       struct btf_field_info *info)
4095 {
4096 	return btf_parse_graph_root(btf, field, info, "bpf_list_node",
4097 					    __alignof__(struct bpf_list_node));
4098 }
4099 
btf_parse_rb_root(const struct btf * btf,struct btf_field * field,struct btf_field_info * info)4100 static int btf_parse_rb_root(const struct btf *btf, struct btf_field *field,
4101 			     struct btf_field_info *info)
4102 {
4103 	return btf_parse_graph_root(btf, field, info, "bpf_rb_node",
4104 					    __alignof__(struct bpf_rb_node));
4105 }
4106 
btf_field_cmp(const void * _a,const void * _b,const void * priv)4107 static int btf_field_cmp(const void *_a, const void *_b, const void *priv)
4108 {
4109 	const struct btf_field *a = (const struct btf_field *)_a;
4110 	const struct btf_field *b = (const struct btf_field *)_b;
4111 
4112 	if (a->offset < b->offset)
4113 		return -1;
4114 	else if (a->offset > b->offset)
4115 		return 1;
4116 	return 0;
4117 }
4118 
btf_parse_fields(const struct btf * btf,const struct btf_type * t,u32 field_mask,u32 value_size)4119 struct btf_record *btf_parse_fields(const struct btf *btf, const struct btf_type *t,
4120 				    u32 field_mask, u32 value_size)
4121 {
4122 	struct btf_field_info info_arr[BTF_FIELDS_MAX];
4123 	u32 next_off = 0, field_type_size;
4124 	struct btf_record *rec;
4125 	int ret, i, cnt;
4126 
4127 	ret = btf_find_field(btf, t, field_mask, info_arr, ARRAY_SIZE(info_arr));
4128 	if (ret < 0)
4129 		return ERR_PTR(ret);
4130 	if (!ret)
4131 		return NULL;
4132 
4133 	cnt = ret;
4134 	/* This needs to be kzalloc to zero out padding and unused fields, see
4135 	 * comment in btf_record_equal.
4136 	 */
4137 	rec = kzalloc_flex(*rec, fields, cnt, GFP_KERNEL_ACCOUNT | __GFP_NOWARN);
4138 	if (!rec)
4139 		return ERR_PTR(-ENOMEM);
4140 
4141 	rec->spin_lock_off = -EINVAL;
4142 	rec->res_spin_lock_off = -EINVAL;
4143 	rec->timer_off = -EINVAL;
4144 	rec->wq_off = -EINVAL;
4145 	rec->refcount_off = -EINVAL;
4146 	rec->task_work_off = -EINVAL;
4147 	for (i = 0; i < cnt; i++) {
4148 		field_type_size = btf_field_type_size(info_arr[i].type);
4149 		if (info_arr[i].off + field_type_size > value_size) {
4150 			WARN_ONCE(1, "verifier bug off %d size %d", info_arr[i].off, value_size);
4151 			ret = -EFAULT;
4152 			goto end;
4153 		}
4154 		if (info_arr[i].off < next_off) {
4155 			ret = -EEXIST;
4156 			goto end;
4157 		}
4158 		next_off = info_arr[i].off + field_type_size;
4159 
4160 		rec->field_mask |= info_arr[i].type;
4161 		rec->fields[i].offset = info_arr[i].off;
4162 		rec->fields[i].type = info_arr[i].type;
4163 		rec->fields[i].size = field_type_size;
4164 
4165 		switch (info_arr[i].type) {
4166 		case BPF_SPIN_LOCK:
4167 			WARN_ON_ONCE(rec->spin_lock_off >= 0);
4168 			/* Cache offset for faster lookup at runtime */
4169 			rec->spin_lock_off = rec->fields[i].offset;
4170 			break;
4171 		case BPF_RES_SPIN_LOCK:
4172 			WARN_ON_ONCE(rec->res_spin_lock_off >= 0);
4173 			/* Cache offset for faster lookup at runtime */
4174 			rec->res_spin_lock_off = rec->fields[i].offset;
4175 			break;
4176 		case BPF_TIMER:
4177 			WARN_ON_ONCE(rec->timer_off >= 0);
4178 			/* Cache offset for faster lookup at runtime */
4179 			rec->timer_off = rec->fields[i].offset;
4180 			break;
4181 		case BPF_WORKQUEUE:
4182 			WARN_ON_ONCE(rec->wq_off >= 0);
4183 			/* Cache offset for faster lookup at runtime */
4184 			rec->wq_off = rec->fields[i].offset;
4185 			break;
4186 		case BPF_TASK_WORK:
4187 			WARN_ON_ONCE(rec->task_work_off >= 0);
4188 			rec->task_work_off = rec->fields[i].offset;
4189 			break;
4190 		case BPF_REFCOUNT:
4191 			WARN_ON_ONCE(rec->refcount_off >= 0);
4192 			/* Cache offset for faster lookup at runtime */
4193 			rec->refcount_off = rec->fields[i].offset;
4194 			break;
4195 		case BPF_KPTR_UNREF:
4196 		case BPF_KPTR_REF:
4197 		case BPF_KPTR_PERCPU:
4198 		case BPF_UPTR:
4199 			ret = btf_parse_kptr(btf, &rec->fields[i], &info_arr[i]);
4200 			if (ret < 0)
4201 				goto end;
4202 			break;
4203 		case BPF_LIST_HEAD:
4204 			ret = btf_parse_list_head(btf, &rec->fields[i], &info_arr[i]);
4205 			if (ret < 0)
4206 				goto end;
4207 			break;
4208 		case BPF_RB_ROOT:
4209 			ret = btf_parse_rb_root(btf, &rec->fields[i], &info_arr[i]);
4210 			if (ret < 0)
4211 				goto end;
4212 			break;
4213 		case BPF_LIST_NODE:
4214 		case BPF_RB_NODE:
4215 			break;
4216 		default:
4217 			ret = -EFAULT;
4218 			goto end;
4219 		}
4220 		rec->cnt++;
4221 	}
4222 
4223 	if (rec->spin_lock_off >= 0 && rec->res_spin_lock_off >= 0) {
4224 		ret = -EINVAL;
4225 		goto end;
4226 	}
4227 
4228 	/* bpf_{list_head, rb_node} require bpf_spin_lock */
4229 	if ((btf_record_has_field(rec, BPF_LIST_HEAD) ||
4230 	     btf_record_has_field(rec, BPF_RB_ROOT)) &&
4231 		 (rec->spin_lock_off < 0 && rec->res_spin_lock_off < 0)) {
4232 		ret = -EINVAL;
4233 		goto end;
4234 	}
4235 
4236 	if (rec->refcount_off < 0 &&
4237 	    btf_record_has_field(rec, BPF_LIST_NODE) &&
4238 	    btf_record_has_field(rec, BPF_RB_NODE)) {
4239 		ret = -EINVAL;
4240 		goto end;
4241 	}
4242 
4243 	sort_r(rec->fields, rec->cnt, sizeof(struct btf_field), btf_field_cmp,
4244 	       NULL, rec);
4245 
4246 	return rec;
4247 end:
4248 	btf_record_free(rec);
4249 	return ERR_PTR(ret);
4250 }
4251 
btf_check_and_fixup_fields(const struct btf * btf,struct btf_record * rec)4252 int btf_check_and_fixup_fields(const struct btf *btf, struct btf_record *rec)
4253 {
4254 	int i;
4255 
4256 	/* There are three types that signify ownership of some other type:
4257 	 *  kptr_ref, bpf_list_head, bpf_rb_root.
4258 	 * kptr_ref only supports storing kernel types, which can't store
4259 	 * references to program allocated local types.
4260 	 *
4261 	 * Hence we only need to ensure that bpf_{list_head,rb_root} ownership
4262 	 * does not form cycles.
4263 	 */
4264 	if (IS_ERR_OR_NULL(rec) || !(rec->field_mask & (BPF_GRAPH_ROOT | BPF_UPTR)))
4265 		return 0;
4266 	for (i = 0; i < rec->cnt; i++) {
4267 		struct btf_struct_meta *meta;
4268 		const struct btf_type *t;
4269 		u32 btf_id;
4270 
4271 		if (rec->fields[i].type == BPF_UPTR) {
4272 			/* The uptr only supports pinning one page and cannot
4273 			 * point to a kernel struct
4274 			 */
4275 			if (btf_is_kernel(rec->fields[i].kptr.btf))
4276 				return -EINVAL;
4277 			t = btf_type_by_id(rec->fields[i].kptr.btf,
4278 					   rec->fields[i].kptr.btf_id);
4279 			if (!t->size)
4280 				return -EINVAL;
4281 			if (t->size > PAGE_SIZE)
4282 				return -E2BIG;
4283 			continue;
4284 		}
4285 
4286 		if (!(rec->fields[i].type & BPF_GRAPH_ROOT))
4287 			continue;
4288 		btf_id = rec->fields[i].graph_root.value_btf_id;
4289 		meta = btf_find_struct_meta(btf, btf_id);
4290 		if (!meta)
4291 			return -EFAULT;
4292 		rec->fields[i].graph_root.value_rec = meta->record;
4293 
4294 		/* We need to set value_rec for all root types, but no need
4295 		 * to check ownership cycle for a type unless it's also a
4296 		 * node type.
4297 		 */
4298 		if (!(rec->field_mask & BPF_GRAPH_NODE))
4299 			continue;
4300 
4301 		/* We need to ensure ownership acyclicity among all types. The
4302 		 * proper way to do it would be to topologically sort all BTF
4303 		 * IDs based on the ownership edges, since there can be multiple
4304 		 * bpf_{list_head,rb_node} in a type. Instead, we use the
4305 		 * following resaoning:
4306 		 *
4307 		 * - A type can only be owned by another type in user BTF if it
4308 		 *   has a bpf_{list,rb}_node. Let's call these node types.
4309 		 * - A type can only _own_ another type in user BTF if it has a
4310 		 *   bpf_{list_head,rb_root}. Let's call these root types.
4311 		 *
4312 		 * We ensure that if a type is both a root and node, its
4313 		 * element types cannot be root types.
4314 		 *
4315 		 * To ensure acyclicity:
4316 		 *
4317 		 * When A is an root type but not a node, its ownership
4318 		 * chain can be:
4319 		 *	A -> B -> C
4320 		 * Where:
4321 		 * - A is an root, e.g. has bpf_rb_root.
4322 		 * - B is both a root and node, e.g. has bpf_rb_node and
4323 		 *   bpf_list_head.
4324 		 * - C is only an root, e.g. has bpf_list_node
4325 		 *
4326 		 * When A is both a root and node, some other type already
4327 		 * owns it in the BTF domain, hence it can not own
4328 		 * another root type through any of the ownership edges.
4329 		 *	A -> B
4330 		 * Where:
4331 		 * - A is both an root and node.
4332 		 * - B is only an node.
4333 		 */
4334 		if (meta->record->field_mask & BPF_GRAPH_ROOT)
4335 			return -ELOOP;
4336 	}
4337 	return 0;
4338 }
4339 
__btf_struct_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)4340 static void __btf_struct_show(const struct btf *btf, const struct btf_type *t,
4341 			      u32 type_id, void *data, u8 bits_offset,
4342 			      struct btf_show *show)
4343 {
4344 	const struct btf_member *member;
4345 	void *safe_data;
4346 	u32 i;
4347 
4348 	safe_data = btf_show_start_struct_type(show, t, type_id, data);
4349 	if (!safe_data)
4350 		return;
4351 
4352 	for_each_member(i, t, member) {
4353 		const struct btf_type *member_type = btf_type_by_id(btf,
4354 								member->type);
4355 		const struct btf_kind_operations *ops;
4356 		u32 member_offset, bitfield_size;
4357 		u32 bytes_offset;
4358 		u8 bits8_offset;
4359 
4360 		btf_show_start_member(show, member);
4361 
4362 		member_offset = __btf_member_bit_offset(t, member);
4363 		bitfield_size = __btf_member_bitfield_size(t, member);
4364 		bytes_offset = BITS_ROUNDDOWN_BYTES(member_offset);
4365 		bits8_offset = BITS_PER_BYTE_MASKED(member_offset);
4366 		if (bitfield_size) {
4367 			safe_data = btf_show_start_type(show, member_type,
4368 							member->type,
4369 							data + bytes_offset);
4370 			if (safe_data)
4371 				btf_bitfield_show(safe_data,
4372 						  bits8_offset,
4373 						  bitfield_size, show);
4374 			btf_show_end_type(show);
4375 		} else {
4376 			ops = btf_type_ops(member_type);
4377 			ops->show(btf, member_type, member->type,
4378 				  data + bytes_offset, bits8_offset, show);
4379 		}
4380 
4381 		btf_show_end_member(show);
4382 	}
4383 
4384 	btf_show_end_struct_type(show);
4385 }
4386 
btf_struct_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)4387 static void btf_struct_show(const struct btf *btf, const struct btf_type *t,
4388 			    u32 type_id, void *data, u8 bits_offset,
4389 			    struct btf_show *show)
4390 {
4391 	const struct btf_member *m = show->state.member;
4392 
4393 	/*
4394 	 * First check if any members would be shown (are non-zero).
4395 	 * See comments above "struct btf_show" definition for more
4396 	 * details on how this works at a high-level.
4397 	 */
4398 	if (show->state.depth > 0 && !(show->flags & BTF_SHOW_ZERO)) {
4399 		if (!show->state.depth_check) {
4400 			show->state.depth_check = show->state.depth + 1;
4401 			show->state.depth_to_show = 0;
4402 		}
4403 		__btf_struct_show(btf, t, type_id, data, bits_offset, show);
4404 		/* Restore saved member data here */
4405 		show->state.member = m;
4406 		if (show->state.depth_check != show->state.depth + 1)
4407 			return;
4408 		show->state.depth_check = 0;
4409 
4410 		if (show->state.depth_to_show <= show->state.depth)
4411 			return;
4412 		/*
4413 		 * Reaching here indicates we have recursed and found
4414 		 * non-zero child values.
4415 		 */
4416 	}
4417 
4418 	__btf_struct_show(btf, t, type_id, data, bits_offset, show);
4419 }
4420 
4421 static const struct btf_kind_operations struct_ops = {
4422 	.check_meta = btf_struct_check_meta,
4423 	.resolve = btf_struct_resolve,
4424 	.check_member = btf_struct_check_member,
4425 	.check_kflag_member = btf_generic_check_kflag_member,
4426 	.log_details = btf_struct_log,
4427 	.show = btf_struct_show,
4428 };
4429 
btf_enum_check_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const struct btf_type * member_type)4430 static int btf_enum_check_member(struct btf_verifier_env *env,
4431 				 const struct btf_type *struct_type,
4432 				 const struct btf_member *member,
4433 				 const struct btf_type *member_type)
4434 {
4435 	u32 struct_bits_off = member->offset;
4436 	u32 struct_size, bytes_offset;
4437 
4438 	if (BITS_PER_BYTE_MASKED(struct_bits_off)) {
4439 		btf_verifier_log_member(env, struct_type, member,
4440 					"Member is not byte aligned");
4441 		return -EINVAL;
4442 	}
4443 
4444 	struct_size = struct_type->size;
4445 	bytes_offset = BITS_ROUNDDOWN_BYTES(struct_bits_off);
4446 	if (struct_size - bytes_offset < member_type->size) {
4447 		btf_verifier_log_member(env, struct_type, member,
4448 					"Member exceeds struct_size");
4449 		return -EINVAL;
4450 	}
4451 
4452 	return 0;
4453 }
4454 
btf_enum_check_kflag_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const struct btf_type * member_type)4455 static int btf_enum_check_kflag_member(struct btf_verifier_env *env,
4456 				       const struct btf_type *struct_type,
4457 				       const struct btf_member *member,
4458 				       const struct btf_type *member_type)
4459 {
4460 	u32 struct_bits_off, nr_bits, bytes_end, struct_size;
4461 	u32 int_bitsize = sizeof(int) * BITS_PER_BYTE;
4462 
4463 	struct_bits_off = BTF_MEMBER_BIT_OFFSET(member->offset);
4464 	nr_bits = BTF_MEMBER_BITFIELD_SIZE(member->offset);
4465 	if (!nr_bits) {
4466 		if (BITS_PER_BYTE_MASKED(struct_bits_off)) {
4467 			btf_verifier_log_member(env, struct_type, member,
4468 						"Member is not byte aligned");
4469 			return -EINVAL;
4470 		}
4471 
4472 		nr_bits = int_bitsize;
4473 	} else if (nr_bits > int_bitsize) {
4474 		btf_verifier_log_member(env, struct_type, member,
4475 					"Invalid member bitfield_size");
4476 		return -EINVAL;
4477 	}
4478 
4479 	struct_size = struct_type->size;
4480 	bytes_end = BITS_ROUNDUP_BYTES(struct_bits_off + nr_bits);
4481 	if (struct_size < bytes_end) {
4482 		btf_verifier_log_member(env, struct_type, member,
4483 					"Member exceeds struct_size");
4484 		return -EINVAL;
4485 	}
4486 
4487 	return 0;
4488 }
4489 
btf_enum_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)4490 static s32 btf_enum_check_meta(struct btf_verifier_env *env,
4491 			       const struct btf_type *t,
4492 			       u32 meta_left)
4493 {
4494 	const struct btf_enum *enums = btf_type_enum(t);
4495 	struct btf *btf = env->btf;
4496 	const char *fmt_str;
4497 	u32 i, nr_enums;
4498 	u32 meta_needed;
4499 
4500 	nr_enums = btf_type_vlen(t);
4501 	meta_needed = nr_enums * sizeof(*enums);
4502 
4503 	if (meta_left < meta_needed) {
4504 		btf_verifier_log_basic(env, t,
4505 				       "meta_left:%u meta_needed:%u",
4506 				       meta_left, meta_needed);
4507 		return -EINVAL;
4508 	}
4509 
4510 	if (t->size > 8 || !is_power_of_2(t->size)) {
4511 		btf_verifier_log_type(env, t, "Unexpected size");
4512 		return -EINVAL;
4513 	}
4514 
4515 	/* enum type either no name or a valid one */
4516 	if (t->name_off &&
4517 	    !btf_name_valid_identifier(env->btf, t->name_off)) {
4518 		btf_verifier_log_type(env, t, "Invalid name");
4519 		return -EINVAL;
4520 	}
4521 
4522 	btf_verifier_log_type(env, t, NULL);
4523 
4524 	for (i = 0; i < nr_enums; i++) {
4525 		if (!btf_name_offset_valid(btf, enums[i].name_off)) {
4526 			btf_verifier_log(env, "\tInvalid name_offset:%u",
4527 					 enums[i].name_off);
4528 			return -EINVAL;
4529 		}
4530 
4531 		/* enum member must have a valid name */
4532 		if (!enums[i].name_off ||
4533 		    !btf_name_valid_identifier(btf, enums[i].name_off)) {
4534 			btf_verifier_log_type(env, t, "Invalid name");
4535 			return -EINVAL;
4536 		}
4537 
4538 		if (env->log.level == BPF_LOG_KERNEL)
4539 			continue;
4540 		fmt_str = btf_type_kflag(t) ? "\t%s val=%d\n" : "\t%s val=%u\n";
4541 		btf_verifier_log(env, fmt_str,
4542 				 __btf_name_by_offset(btf, enums[i].name_off),
4543 				 enums[i].val);
4544 	}
4545 
4546 	return meta_needed;
4547 }
4548 
btf_enum_log(struct btf_verifier_env * env,const struct btf_type * t)4549 static void btf_enum_log(struct btf_verifier_env *env,
4550 			 const struct btf_type *t)
4551 {
4552 	btf_verifier_log(env, "size=%u vlen=%u", t->size, btf_type_vlen(t));
4553 }
4554 
btf_enum_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)4555 static void btf_enum_show(const struct btf *btf, const struct btf_type *t,
4556 			  u32 type_id, void *data, u8 bits_offset,
4557 			  struct btf_show *show)
4558 {
4559 	const struct btf_enum *enums = btf_type_enum(t);
4560 	u32 i, nr_enums = btf_type_vlen(t);
4561 	void *safe_data;
4562 	int v;
4563 
4564 	safe_data = btf_show_start_type(show, t, type_id, data);
4565 	if (!safe_data)
4566 		return;
4567 
4568 	v = *(int *)safe_data;
4569 
4570 	for (i = 0; i < nr_enums; i++) {
4571 		if (v != enums[i].val)
4572 			continue;
4573 
4574 		btf_show_type_value(show, "%s",
4575 				    __btf_name_by_offset(btf,
4576 							 enums[i].name_off));
4577 
4578 		btf_show_end_type(show);
4579 		return;
4580 	}
4581 
4582 	if (btf_type_kflag(t))
4583 		btf_show_type_value(show, "%d", v);
4584 	else
4585 		btf_show_type_value(show, "%u", v);
4586 	btf_show_end_type(show);
4587 }
4588 
4589 static const struct btf_kind_operations enum_ops = {
4590 	.check_meta = btf_enum_check_meta,
4591 	.resolve = btf_df_resolve,
4592 	.check_member = btf_enum_check_member,
4593 	.check_kflag_member = btf_enum_check_kflag_member,
4594 	.log_details = btf_enum_log,
4595 	.show = btf_enum_show,
4596 };
4597 
btf_enum64_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)4598 static s32 btf_enum64_check_meta(struct btf_verifier_env *env,
4599 				 const struct btf_type *t,
4600 				 u32 meta_left)
4601 {
4602 	const struct btf_enum64 *enums = btf_type_enum64(t);
4603 	struct btf *btf = env->btf;
4604 	const char *fmt_str;
4605 	u32 i, nr_enums;
4606 	u32 meta_needed;
4607 
4608 	nr_enums = btf_type_vlen(t);
4609 	meta_needed = nr_enums * sizeof(*enums);
4610 
4611 	if (meta_left < meta_needed) {
4612 		btf_verifier_log_basic(env, t,
4613 				       "meta_left:%u meta_needed:%u",
4614 				       meta_left, meta_needed);
4615 		return -EINVAL;
4616 	}
4617 
4618 	if (t->size > 8 || !is_power_of_2(t->size)) {
4619 		btf_verifier_log_type(env, t, "Unexpected size");
4620 		return -EINVAL;
4621 	}
4622 
4623 	/* enum type either no name or a valid one */
4624 	if (t->name_off &&
4625 	    !btf_name_valid_identifier(env->btf, t->name_off)) {
4626 		btf_verifier_log_type(env, t, "Invalid name");
4627 		return -EINVAL;
4628 	}
4629 
4630 	btf_verifier_log_type(env, t, NULL);
4631 
4632 	for (i = 0; i < nr_enums; i++) {
4633 		if (!btf_name_offset_valid(btf, enums[i].name_off)) {
4634 			btf_verifier_log(env, "\tInvalid name_offset:%u",
4635 					 enums[i].name_off);
4636 			return -EINVAL;
4637 		}
4638 
4639 		/* enum member must have a valid name */
4640 		if (!enums[i].name_off ||
4641 		    !btf_name_valid_identifier(btf, enums[i].name_off)) {
4642 			btf_verifier_log_type(env, t, "Invalid name");
4643 			return -EINVAL;
4644 		}
4645 
4646 		if (env->log.level == BPF_LOG_KERNEL)
4647 			continue;
4648 
4649 		fmt_str = btf_type_kflag(t) ? "\t%s val=%lld\n" : "\t%s val=%llu\n";
4650 		btf_verifier_log(env, fmt_str,
4651 				 __btf_name_by_offset(btf, enums[i].name_off),
4652 				 btf_enum64_value(enums + i));
4653 	}
4654 
4655 	return meta_needed;
4656 }
4657 
btf_enum64_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)4658 static void btf_enum64_show(const struct btf *btf, const struct btf_type *t,
4659 			    u32 type_id, void *data, u8 bits_offset,
4660 			    struct btf_show *show)
4661 {
4662 	const struct btf_enum64 *enums = btf_type_enum64(t);
4663 	u32 i, nr_enums = btf_type_vlen(t);
4664 	void *safe_data;
4665 	s64 v;
4666 
4667 	safe_data = btf_show_start_type(show, t, type_id, data);
4668 	if (!safe_data)
4669 		return;
4670 
4671 	v = *(u64 *)safe_data;
4672 
4673 	for (i = 0; i < nr_enums; i++) {
4674 		if (v != btf_enum64_value(enums + i))
4675 			continue;
4676 
4677 		btf_show_type_value(show, "%s",
4678 				    __btf_name_by_offset(btf,
4679 							 enums[i].name_off));
4680 
4681 		btf_show_end_type(show);
4682 		return;
4683 	}
4684 
4685 	if (btf_type_kflag(t))
4686 		btf_show_type_value(show, "%lld", v);
4687 	else
4688 		btf_show_type_value(show, "%llu", v);
4689 	btf_show_end_type(show);
4690 }
4691 
4692 static const struct btf_kind_operations enum64_ops = {
4693 	.check_meta = btf_enum64_check_meta,
4694 	.resolve = btf_df_resolve,
4695 	.check_member = btf_enum_check_member,
4696 	.check_kflag_member = btf_enum_check_kflag_member,
4697 	.log_details = btf_enum_log,
4698 	.show = btf_enum64_show,
4699 };
4700 
btf_func_proto_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)4701 static s32 btf_func_proto_check_meta(struct btf_verifier_env *env,
4702 				     const struct btf_type *t,
4703 				     u32 meta_left)
4704 {
4705 	u32 meta_needed = btf_type_vlen(t) * sizeof(struct btf_param);
4706 
4707 	if (meta_left < meta_needed) {
4708 		btf_verifier_log_basic(env, t,
4709 				       "meta_left:%u meta_needed:%u",
4710 				       meta_left, meta_needed);
4711 		return -EINVAL;
4712 	}
4713 
4714 	if (t->name_off) {
4715 		btf_verifier_log_type(env, t, "Invalid name");
4716 		return -EINVAL;
4717 	}
4718 
4719 	if (btf_type_kflag(t)) {
4720 		btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
4721 		return -EINVAL;
4722 	}
4723 
4724 	btf_verifier_log_type(env, t, NULL);
4725 
4726 	return meta_needed;
4727 }
4728 
btf_func_proto_log(struct btf_verifier_env * env,const struct btf_type * t)4729 static void btf_func_proto_log(struct btf_verifier_env *env,
4730 			       const struct btf_type *t)
4731 {
4732 	const struct btf_param *args = (const struct btf_param *)(t + 1);
4733 	u32 nr_args = btf_type_vlen(t), i;
4734 
4735 	btf_verifier_log(env, "return=%u args=(", t->type);
4736 	if (!nr_args) {
4737 		btf_verifier_log(env, "void");
4738 		goto done;
4739 	}
4740 
4741 	if (nr_args == 1 && !args[0].type) {
4742 		/* Only one vararg */
4743 		btf_verifier_log(env, "vararg");
4744 		goto done;
4745 	}
4746 
4747 	btf_verifier_log(env, "%u %s", args[0].type,
4748 			 __btf_name_by_offset(env->btf,
4749 					      args[0].name_off));
4750 	for (i = 1; i < nr_args - 1; i++)
4751 		btf_verifier_log(env, ", %u %s", args[i].type,
4752 				 __btf_name_by_offset(env->btf,
4753 						      args[i].name_off));
4754 
4755 	if (nr_args > 1) {
4756 		const struct btf_param *last_arg = &args[nr_args - 1];
4757 
4758 		if (last_arg->type)
4759 			btf_verifier_log(env, ", %u %s", last_arg->type,
4760 					 __btf_name_by_offset(env->btf,
4761 							      last_arg->name_off));
4762 		else
4763 			btf_verifier_log(env, ", vararg");
4764 	}
4765 
4766 done:
4767 	btf_verifier_log(env, ")");
4768 }
4769 
4770 static const struct btf_kind_operations func_proto_ops = {
4771 	.check_meta = btf_func_proto_check_meta,
4772 	.resolve = btf_df_resolve,
4773 	/*
4774 	 * BTF_KIND_FUNC_PROTO cannot be directly referred by
4775 	 * a struct's member.
4776 	 *
4777 	 * It should be a function pointer instead.
4778 	 * (i.e. struct's member -> BTF_KIND_PTR -> BTF_KIND_FUNC_PROTO)
4779 	 *
4780 	 * Hence, there is no btf_func_check_member().
4781 	 */
4782 	.check_member = btf_df_check_member,
4783 	.check_kflag_member = btf_df_check_kflag_member,
4784 	.log_details = btf_func_proto_log,
4785 	.show = btf_df_show,
4786 };
4787 
btf_func_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)4788 static s32 btf_func_check_meta(struct btf_verifier_env *env,
4789 			       const struct btf_type *t,
4790 			       u32 meta_left)
4791 {
4792 	if (!t->name_off ||
4793 	    !btf_name_valid_identifier(env->btf, t->name_off)) {
4794 		btf_verifier_log_type(env, t, "Invalid name");
4795 		return -EINVAL;
4796 	}
4797 
4798 	if (btf_type_vlen(t) > BTF_FUNC_GLOBAL) {
4799 		btf_verifier_log_type(env, t, "Invalid func linkage");
4800 		return -EINVAL;
4801 	}
4802 
4803 	if (btf_type_kflag(t)) {
4804 		btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
4805 		return -EINVAL;
4806 	}
4807 
4808 	btf_verifier_log_type(env, t, NULL);
4809 
4810 	return 0;
4811 }
4812 
btf_func_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)4813 static int btf_func_resolve(struct btf_verifier_env *env,
4814 			    const struct resolve_vertex *v)
4815 {
4816 	const struct btf_type *t = v->t;
4817 	u32 next_type_id = t->type;
4818 	int err;
4819 
4820 	err = btf_func_check(env, t);
4821 	if (err)
4822 		return err;
4823 
4824 	env_stack_pop_resolved(env, next_type_id, 0);
4825 	return 0;
4826 }
4827 
4828 static const struct btf_kind_operations func_ops = {
4829 	.check_meta = btf_func_check_meta,
4830 	.resolve = btf_func_resolve,
4831 	.check_member = btf_df_check_member,
4832 	.check_kflag_member = btf_df_check_kflag_member,
4833 	.log_details = btf_ref_type_log,
4834 	.show = btf_df_show,
4835 };
4836 
btf_var_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)4837 static s32 btf_var_check_meta(struct btf_verifier_env *env,
4838 			      const struct btf_type *t,
4839 			      u32 meta_left)
4840 {
4841 	const struct btf_var *var;
4842 	u32 meta_needed = sizeof(*var);
4843 
4844 	if (meta_left < meta_needed) {
4845 		btf_verifier_log_basic(env, t,
4846 				       "meta_left:%u meta_needed:%u",
4847 				       meta_left, meta_needed);
4848 		return -EINVAL;
4849 	}
4850 
4851 	if (btf_type_vlen(t)) {
4852 		btf_verifier_log_type(env, t, "vlen != 0");
4853 		return -EINVAL;
4854 	}
4855 
4856 	if (btf_type_kflag(t)) {
4857 		btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
4858 		return -EINVAL;
4859 	}
4860 
4861 	if (!t->name_off ||
4862 	    !btf_name_valid_identifier(env->btf, t->name_off)) {
4863 		btf_verifier_log_type(env, t, "Invalid name");
4864 		return -EINVAL;
4865 	}
4866 
4867 	/* A var cannot be in type void */
4868 	if (!t->type || !BTF_TYPE_ID_VALID(t->type)) {
4869 		btf_verifier_log_type(env, t, "Invalid type_id");
4870 		return -EINVAL;
4871 	}
4872 
4873 	var = btf_type_var(t);
4874 	if (var->linkage != BTF_VAR_STATIC &&
4875 	    var->linkage != BTF_VAR_GLOBAL_ALLOCATED) {
4876 		btf_verifier_log_type(env, t, "Linkage not supported");
4877 		return -EINVAL;
4878 	}
4879 
4880 	btf_verifier_log_type(env, t, NULL);
4881 
4882 	return meta_needed;
4883 }
4884 
btf_var_log(struct btf_verifier_env * env,const struct btf_type * t)4885 static void btf_var_log(struct btf_verifier_env *env, const struct btf_type *t)
4886 {
4887 	const struct btf_var *var = btf_type_var(t);
4888 
4889 	btf_verifier_log(env, "type_id=%u linkage=%u", t->type, var->linkage);
4890 }
4891 
4892 static const struct btf_kind_operations var_ops = {
4893 	.check_meta		= btf_var_check_meta,
4894 	.resolve		= btf_var_resolve,
4895 	.check_member		= btf_df_check_member,
4896 	.check_kflag_member	= btf_df_check_kflag_member,
4897 	.log_details		= btf_var_log,
4898 	.show			= btf_var_show,
4899 };
4900 
btf_datasec_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)4901 static s32 btf_datasec_check_meta(struct btf_verifier_env *env,
4902 				  const struct btf_type *t,
4903 				  u32 meta_left)
4904 {
4905 	const struct btf_var_secinfo *vsi;
4906 	u64 last_vsi_end_off = 0, sum = 0;
4907 	u32 i, meta_needed;
4908 
4909 	meta_needed = btf_type_vlen(t) * sizeof(*vsi);
4910 	if (meta_left < meta_needed) {
4911 		btf_verifier_log_basic(env, t,
4912 				       "meta_left:%u meta_needed:%u",
4913 				       meta_left, meta_needed);
4914 		return -EINVAL;
4915 	}
4916 
4917 	if (!t->size) {
4918 		btf_verifier_log_type(env, t, "size == 0");
4919 		return -EINVAL;
4920 	}
4921 
4922 	if (btf_type_kflag(t)) {
4923 		btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
4924 		return -EINVAL;
4925 	}
4926 
4927 	if (!t->name_off ||
4928 	    !btf_name_valid_section(env->btf, t->name_off)) {
4929 		btf_verifier_log_type(env, t, "Invalid name");
4930 		return -EINVAL;
4931 	}
4932 
4933 	btf_verifier_log_type(env, t, NULL);
4934 
4935 	for_each_vsi(i, t, vsi) {
4936 		/* A var cannot be in type void */
4937 		if (!vsi->type || !BTF_TYPE_ID_VALID(vsi->type)) {
4938 			btf_verifier_log_vsi(env, t, vsi,
4939 					     "Invalid type_id");
4940 			return -EINVAL;
4941 		}
4942 
4943 		if (vsi->offset < last_vsi_end_off || vsi->offset >= t->size) {
4944 			btf_verifier_log_vsi(env, t, vsi,
4945 					     "Invalid offset");
4946 			return -EINVAL;
4947 		}
4948 
4949 		if (!vsi->size || vsi->size > t->size) {
4950 			btf_verifier_log_vsi(env, t, vsi,
4951 					     "Invalid size");
4952 			return -EINVAL;
4953 		}
4954 
4955 		last_vsi_end_off = vsi->offset + vsi->size;
4956 		if (last_vsi_end_off > t->size) {
4957 			btf_verifier_log_vsi(env, t, vsi,
4958 					     "Invalid offset+size");
4959 			return -EINVAL;
4960 		}
4961 
4962 		btf_verifier_log_vsi(env, t, vsi, NULL);
4963 		sum += vsi->size;
4964 	}
4965 
4966 	if (t->size < sum) {
4967 		btf_verifier_log_type(env, t, "Invalid btf_info size");
4968 		return -EINVAL;
4969 	}
4970 
4971 	return meta_needed;
4972 }
4973 
btf_datasec_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)4974 static int btf_datasec_resolve(struct btf_verifier_env *env,
4975 			       const struct resolve_vertex *v)
4976 {
4977 	const struct btf_var_secinfo *vsi;
4978 	struct btf *btf = env->btf;
4979 	u32 i;
4980 
4981 	env->resolve_mode = RESOLVE_TBD;
4982 	for_each_vsi_from(i, v->next_member, v->t, vsi) {
4983 		u32 var_type_id = vsi->type, type_id, type_size = 0;
4984 		const struct btf_type *var_type = btf_type_by_id(env->btf,
4985 								 var_type_id);
4986 		if (!var_type || !btf_type_is_var(var_type)) {
4987 			btf_verifier_log_vsi(env, v->t, vsi,
4988 					     "Not a VAR kind member");
4989 			return -EINVAL;
4990 		}
4991 
4992 		if (!env_type_is_resolve_sink(env, var_type) &&
4993 		    !env_type_is_resolved(env, var_type_id)) {
4994 			env_stack_set_next_member(env, i + 1);
4995 			return env_stack_push(env, var_type, var_type_id);
4996 		}
4997 
4998 		type_id = var_type->type;
4999 		if (!btf_type_id_size(btf, &type_id, &type_size)) {
5000 			btf_verifier_log_vsi(env, v->t, vsi, "Invalid type");
5001 			return -EINVAL;
5002 		}
5003 
5004 		if (vsi->size < type_size) {
5005 			btf_verifier_log_vsi(env, v->t, vsi, "Invalid size");
5006 			return -EINVAL;
5007 		}
5008 	}
5009 
5010 	env_stack_pop_resolved(env, 0, 0);
5011 	return 0;
5012 }
5013 
btf_datasec_log(struct btf_verifier_env * env,const struct btf_type * t)5014 static void btf_datasec_log(struct btf_verifier_env *env,
5015 			    const struct btf_type *t)
5016 {
5017 	btf_verifier_log(env, "size=%u vlen=%u", t->size, btf_type_vlen(t));
5018 }
5019 
btf_datasec_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)5020 static void btf_datasec_show(const struct btf *btf,
5021 			     const struct btf_type *t, u32 type_id,
5022 			     void *data, u8 bits_offset,
5023 			     struct btf_show *show)
5024 {
5025 	const struct btf_var_secinfo *vsi;
5026 	const struct btf_type *var;
5027 	u32 i;
5028 
5029 	if (!btf_show_start_type(show, t, type_id, data))
5030 		return;
5031 
5032 	btf_show_type_value(show, "section (\"%s\") = {",
5033 			    __btf_name_by_offset(btf, t->name_off));
5034 	for_each_vsi(i, t, vsi) {
5035 		var = btf_type_by_id(btf, vsi->type);
5036 		if (i)
5037 			btf_show(show, ",");
5038 		btf_type_ops(var)->show(btf, var, vsi->type,
5039 					data + vsi->offset, bits_offset, show);
5040 	}
5041 	btf_show_end_type(show);
5042 }
5043 
5044 static const struct btf_kind_operations datasec_ops = {
5045 	.check_meta		= btf_datasec_check_meta,
5046 	.resolve		= btf_datasec_resolve,
5047 	.check_member		= btf_df_check_member,
5048 	.check_kflag_member	= btf_df_check_kflag_member,
5049 	.log_details		= btf_datasec_log,
5050 	.show			= btf_datasec_show,
5051 };
5052 
btf_float_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)5053 static s32 btf_float_check_meta(struct btf_verifier_env *env,
5054 				const struct btf_type *t,
5055 				u32 meta_left)
5056 {
5057 	if (btf_type_vlen(t)) {
5058 		btf_verifier_log_type(env, t, "vlen != 0");
5059 		return -EINVAL;
5060 	}
5061 
5062 	if (btf_type_kflag(t)) {
5063 		btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
5064 		return -EINVAL;
5065 	}
5066 
5067 	if (t->size != 2 && t->size != 4 && t->size != 8 && t->size != 12 &&
5068 	    t->size != 16) {
5069 		btf_verifier_log_type(env, t, "Invalid type_size");
5070 		return -EINVAL;
5071 	}
5072 
5073 	btf_verifier_log_type(env, t, NULL);
5074 
5075 	return 0;
5076 }
5077 
btf_float_check_member(struct btf_verifier_env * env,const struct btf_type * struct_type,const struct btf_member * member,const struct btf_type * member_type)5078 static int btf_float_check_member(struct btf_verifier_env *env,
5079 				  const struct btf_type *struct_type,
5080 				  const struct btf_member *member,
5081 				  const struct btf_type *member_type)
5082 {
5083 	u64 start_offset_bytes;
5084 	u64 end_offset_bytes;
5085 	u64 misalign_bits;
5086 	u64 align_bytes;
5087 	u64 align_bits;
5088 
5089 	/* Different architectures have different alignment requirements, so
5090 	 * here we check only for the reasonable minimum. This way we ensure
5091 	 * that types after CO-RE can pass the kernel BTF verifier.
5092 	 */
5093 	align_bytes = min_t(u64, sizeof(void *), member_type->size);
5094 	align_bits = align_bytes * BITS_PER_BYTE;
5095 	div64_u64_rem(member->offset, align_bits, &misalign_bits);
5096 	if (misalign_bits) {
5097 		btf_verifier_log_member(env, struct_type, member,
5098 					"Member is not properly aligned");
5099 		return -EINVAL;
5100 	}
5101 
5102 	start_offset_bytes = member->offset / BITS_PER_BYTE;
5103 	end_offset_bytes = start_offset_bytes + member_type->size;
5104 	if (end_offset_bytes > struct_type->size) {
5105 		btf_verifier_log_member(env, struct_type, member,
5106 					"Member exceeds struct_size");
5107 		return -EINVAL;
5108 	}
5109 
5110 	return 0;
5111 }
5112 
btf_float_log(struct btf_verifier_env * env,const struct btf_type * t)5113 static void btf_float_log(struct btf_verifier_env *env,
5114 			  const struct btf_type *t)
5115 {
5116 	btf_verifier_log(env, "size=%u", t->size);
5117 }
5118 
5119 static const struct btf_kind_operations float_ops = {
5120 	.check_meta = btf_float_check_meta,
5121 	.resolve = btf_df_resolve,
5122 	.check_member = btf_float_check_member,
5123 	.check_kflag_member = btf_generic_check_kflag_member,
5124 	.log_details = btf_float_log,
5125 	.show = btf_df_show,
5126 };
5127 
btf_decl_tag_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)5128 static s32 btf_decl_tag_check_meta(struct btf_verifier_env *env,
5129 			      const struct btf_type *t,
5130 			      u32 meta_left)
5131 {
5132 	const struct btf_decl_tag *tag;
5133 	u32 meta_needed = sizeof(*tag);
5134 	s32 component_idx;
5135 	const char *value;
5136 
5137 	if (meta_left < meta_needed) {
5138 		btf_verifier_log_basic(env, t,
5139 				       "meta_left:%u meta_needed:%u",
5140 				       meta_left, meta_needed);
5141 		return -EINVAL;
5142 	}
5143 
5144 	value = btf_name_by_offset(env->btf, t->name_off);
5145 	if (!value || !value[0]) {
5146 		btf_verifier_log_type(env, t, "Invalid value");
5147 		return -EINVAL;
5148 	}
5149 
5150 	if (btf_type_vlen(t)) {
5151 		btf_verifier_log_type(env, t, "vlen != 0");
5152 		return -EINVAL;
5153 	}
5154 
5155 	component_idx = btf_type_decl_tag(t)->component_idx;
5156 	if (component_idx < -1) {
5157 		btf_verifier_log_type(env, t, "Invalid component_idx");
5158 		return -EINVAL;
5159 	}
5160 
5161 	btf_verifier_log_type(env, t, NULL);
5162 
5163 	return meta_needed;
5164 }
5165 
btf_decl_tag_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)5166 static int btf_decl_tag_resolve(struct btf_verifier_env *env,
5167 			   const struct resolve_vertex *v)
5168 {
5169 	const struct btf_type *next_type;
5170 	const struct btf_type *t = v->t;
5171 	u32 next_type_id = t->type;
5172 	struct btf *btf = env->btf;
5173 	s32 component_idx;
5174 	u32 vlen;
5175 
5176 	next_type = btf_type_by_id(btf, next_type_id);
5177 	if (!next_type || !btf_type_is_decl_tag_target(next_type)) {
5178 		btf_verifier_log_type(env, v->t, "Invalid type_id");
5179 		return -EINVAL;
5180 	}
5181 
5182 	if (!env_type_is_resolve_sink(env, next_type) &&
5183 	    !env_type_is_resolved(env, next_type_id))
5184 		return env_stack_push(env, next_type, next_type_id);
5185 
5186 	component_idx = btf_type_decl_tag(t)->component_idx;
5187 	if (component_idx != -1) {
5188 		if (btf_type_is_var(next_type) || btf_type_is_typedef(next_type)) {
5189 			btf_verifier_log_type(env, v->t, "Invalid component_idx");
5190 			return -EINVAL;
5191 		}
5192 
5193 		if (btf_type_is_struct(next_type)) {
5194 			vlen = btf_type_vlen(next_type);
5195 		} else {
5196 			/* next_type should be a function */
5197 			next_type = btf_type_by_id(btf, next_type->type);
5198 			vlen = btf_type_vlen(next_type);
5199 		}
5200 
5201 		if ((u32)component_idx >= vlen) {
5202 			btf_verifier_log_type(env, v->t, "Invalid component_idx");
5203 			return -EINVAL;
5204 		}
5205 	}
5206 
5207 	env_stack_pop_resolved(env, next_type_id, 0);
5208 
5209 	return 0;
5210 }
5211 
btf_decl_tag_log(struct btf_verifier_env * env,const struct btf_type * t)5212 static void btf_decl_tag_log(struct btf_verifier_env *env, const struct btf_type *t)
5213 {
5214 	btf_verifier_log(env, "type=%u component_idx=%d", t->type,
5215 			 btf_type_decl_tag(t)->component_idx);
5216 }
5217 
5218 static const struct btf_kind_operations decl_tag_ops = {
5219 	.check_meta = btf_decl_tag_check_meta,
5220 	.resolve = btf_decl_tag_resolve,
5221 	.check_member = btf_df_check_member,
5222 	.check_kflag_member = btf_df_check_kflag_member,
5223 	.log_details = btf_decl_tag_log,
5224 	.show = btf_df_show,
5225 };
5226 
btf_func_proto_check(struct btf_verifier_env * env,const struct btf_type * t)5227 static int btf_func_proto_check(struct btf_verifier_env *env,
5228 				const struct btf_type *t)
5229 {
5230 	const struct btf_type *ret_type;
5231 	const struct btf_param *args;
5232 	const struct btf *btf;
5233 	u32 nr_args, i;
5234 	int err;
5235 
5236 	btf = env->btf;
5237 	args = (const struct btf_param *)(t + 1);
5238 	nr_args = btf_type_vlen(t);
5239 
5240 	/* Check func return type which could be "void" (t->type == 0) */
5241 	if (t->type) {
5242 		u32 ret_type_id = t->type;
5243 
5244 		ret_type = btf_type_by_id(btf, ret_type_id);
5245 		if (!ret_type) {
5246 			btf_verifier_log_type(env, t, "Invalid return type");
5247 			return -EINVAL;
5248 		}
5249 
5250 		if (btf_type_is_resolve_source_only(ret_type)) {
5251 			btf_verifier_log_type(env, t, "Invalid return type");
5252 			return -EINVAL;
5253 		}
5254 
5255 		if (btf_type_needs_resolve(ret_type) &&
5256 		    !env_type_is_resolved(env, ret_type_id)) {
5257 			err = btf_resolve(env, ret_type, ret_type_id);
5258 			if (err)
5259 				return err;
5260 		}
5261 
5262 		/* Ensure the return type is a type that has a size */
5263 		if (!btf_type_id_size(btf, &ret_type_id, NULL)) {
5264 			btf_verifier_log_type(env, t, "Invalid return type");
5265 			return -EINVAL;
5266 		}
5267 	}
5268 
5269 	if (!nr_args)
5270 		return 0;
5271 
5272 	/* Last func arg type_id could be 0 if it is a vararg */
5273 	if (!args[nr_args - 1].type) {
5274 		if (args[nr_args - 1].name_off) {
5275 			btf_verifier_log_type(env, t, "Invalid arg#%u",
5276 					      nr_args);
5277 			return -EINVAL;
5278 		}
5279 		nr_args--;
5280 	}
5281 
5282 	for (i = 0; i < nr_args; i++) {
5283 		const struct btf_type *arg_type;
5284 		u32 arg_type_id;
5285 
5286 		arg_type_id = args[i].type;
5287 		arg_type = btf_type_by_id(btf, arg_type_id);
5288 		if (!arg_type) {
5289 			btf_verifier_log_type(env, t, "Invalid arg#%u", i + 1);
5290 			return -EINVAL;
5291 		}
5292 
5293 		if (btf_type_is_resolve_source_only(arg_type)) {
5294 			btf_verifier_log_type(env, t, "Invalid arg#%u", i + 1);
5295 			return -EINVAL;
5296 		}
5297 
5298 		if (args[i].name_off &&
5299 		    (!btf_name_offset_valid(btf, args[i].name_off) ||
5300 		     !btf_name_valid_identifier(btf, args[i].name_off))) {
5301 			btf_verifier_log_type(env, t,
5302 					      "Invalid arg#%u", i + 1);
5303 			return -EINVAL;
5304 		}
5305 
5306 		if (btf_type_needs_resolve(arg_type) &&
5307 		    !env_type_is_resolved(env, arg_type_id)) {
5308 			err = btf_resolve(env, arg_type, arg_type_id);
5309 			if (err)
5310 				return err;
5311 		}
5312 
5313 		if (!btf_type_id_size(btf, &arg_type_id, NULL)) {
5314 			btf_verifier_log_type(env, t, "Invalid arg#%u", i + 1);
5315 			return -EINVAL;
5316 		}
5317 	}
5318 
5319 	return 0;
5320 }
5321 
btf_func_check(struct btf_verifier_env * env,const struct btf_type * t)5322 static int btf_func_check(struct btf_verifier_env *env,
5323 			  const struct btf_type *t)
5324 {
5325 	const struct btf_type *proto_type;
5326 	const struct btf_param *args;
5327 	const struct btf *btf;
5328 	u32 nr_args, i;
5329 
5330 	btf = env->btf;
5331 	proto_type = btf_type_by_id(btf, t->type);
5332 
5333 	if (!proto_type || !btf_type_is_func_proto(proto_type)) {
5334 		btf_verifier_log_type(env, t, "Invalid type_id");
5335 		return -EINVAL;
5336 	}
5337 
5338 	args = (const struct btf_param *)(proto_type + 1);
5339 	nr_args = btf_type_vlen(proto_type);
5340 	for (i = 0; i < nr_args; i++) {
5341 		if (!args[i].name_off && args[i].type) {
5342 			btf_verifier_log_type(env, t, "Invalid arg#%u", i + 1);
5343 			return -EINVAL;
5344 		}
5345 	}
5346 
5347 	return 0;
5348 }
5349 
5350 static const struct btf_kind_operations * const kind_ops[NR_BTF_KINDS] = {
5351 	[BTF_KIND_INT] = &int_ops,
5352 	[BTF_KIND_PTR] = &ptr_ops,
5353 	[BTF_KIND_ARRAY] = &array_ops,
5354 	[BTF_KIND_STRUCT] = &struct_ops,
5355 	[BTF_KIND_UNION] = &struct_ops,
5356 	[BTF_KIND_ENUM] = &enum_ops,
5357 	[BTF_KIND_FWD] = &fwd_ops,
5358 	[BTF_KIND_TYPEDEF] = &modifier_ops,
5359 	[BTF_KIND_VOLATILE] = &modifier_ops,
5360 	[BTF_KIND_CONST] = &modifier_ops,
5361 	[BTF_KIND_RESTRICT] = &modifier_ops,
5362 	[BTF_KIND_FUNC] = &func_ops,
5363 	[BTF_KIND_FUNC_PROTO] = &func_proto_ops,
5364 	[BTF_KIND_VAR] = &var_ops,
5365 	[BTF_KIND_DATASEC] = &datasec_ops,
5366 	[BTF_KIND_FLOAT] = &float_ops,
5367 	[BTF_KIND_DECL_TAG] = &decl_tag_ops,
5368 	[BTF_KIND_TYPE_TAG] = &modifier_ops,
5369 	[BTF_KIND_ENUM64] = &enum64_ops,
5370 };
5371 
btf_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)5372 static s32 btf_check_meta(struct btf_verifier_env *env,
5373 			  const struct btf_type *t,
5374 			  u32 meta_left)
5375 {
5376 	u32 saved_meta_left = meta_left;
5377 	s32 var_meta_size;
5378 
5379 	if (meta_left < sizeof(*t)) {
5380 		btf_verifier_log(env, "[%u] meta_left:%u meta_needed:%zu",
5381 				 env->log_type_id, meta_left, sizeof(*t));
5382 		return -EINVAL;
5383 	}
5384 	meta_left -= sizeof(*t);
5385 
5386 	if (BTF_INFO_KIND(t->info) > BTF_KIND_MAX ||
5387 	    BTF_INFO_KIND(t->info) == BTF_KIND_UNKN) {
5388 		btf_verifier_log(env, "[%u] Invalid kind:%u",
5389 				 env->log_type_id, BTF_INFO_KIND(t->info));
5390 		return -EINVAL;
5391 	}
5392 
5393 	if (!btf_name_offset_valid(env->btf, t->name_off)) {
5394 		btf_verifier_log(env, "[%u] Invalid name_offset:%u",
5395 				 env->log_type_id, t->name_off);
5396 		return -EINVAL;
5397 	}
5398 
5399 	var_meta_size = btf_type_ops(t)->check_meta(env, t, meta_left);
5400 	if (var_meta_size < 0)
5401 		return var_meta_size;
5402 
5403 	meta_left -= var_meta_size;
5404 
5405 	return saved_meta_left - meta_left;
5406 }
5407 
btf_check_all_metas(struct btf_verifier_env * env)5408 static int btf_check_all_metas(struct btf_verifier_env *env)
5409 {
5410 	struct btf *btf = env->btf;
5411 	struct btf_header *hdr;
5412 	void *cur, *end;
5413 
5414 	hdr = &btf->hdr;
5415 	cur = btf->nohdr_data + hdr->type_off;
5416 	end = cur + hdr->type_len;
5417 
5418 	env->log_type_id = btf->base_btf ? btf->start_id : 1;
5419 	while (cur < end) {
5420 		struct btf_type *t = cur;
5421 		s32 meta_size;
5422 
5423 		meta_size = btf_check_meta(env, t, end - cur);
5424 		if (meta_size < 0)
5425 			return meta_size;
5426 
5427 		btf_add_type(env, t);
5428 		cur += meta_size;
5429 		env->log_type_id++;
5430 	}
5431 
5432 	return 0;
5433 }
5434 
btf_resolve_valid(struct btf_verifier_env * env,const struct btf_type * t,u32 type_id)5435 static bool btf_resolve_valid(struct btf_verifier_env *env,
5436 			      const struct btf_type *t,
5437 			      u32 type_id)
5438 {
5439 	struct btf *btf = env->btf;
5440 
5441 	if (!env_type_is_resolved(env, type_id))
5442 		return false;
5443 
5444 	if (btf_type_is_struct(t) || btf_type_is_datasec(t))
5445 		return !btf_resolved_type_id(btf, type_id) &&
5446 		       !btf_resolved_type_size(btf, type_id);
5447 
5448 	if (btf_type_is_decl_tag(t) || btf_type_is_func(t))
5449 		return btf_resolved_type_id(btf, type_id) &&
5450 		       !btf_resolved_type_size(btf, type_id);
5451 
5452 	if (btf_type_is_modifier(t) || btf_type_is_ptr(t) ||
5453 	    btf_type_is_var(t)) {
5454 		t = btf_type_id_resolve(btf, &type_id);
5455 		return t &&
5456 		       !btf_type_is_modifier(t) &&
5457 		       !btf_type_is_var(t) &&
5458 		       !btf_type_is_datasec(t);
5459 	}
5460 
5461 	if (btf_type_is_array(t)) {
5462 		const struct btf_array *array = btf_type_array(t);
5463 		const struct btf_type *elem_type;
5464 		u32 elem_type_id = array->type;
5465 		u32 elem_size;
5466 
5467 		elem_type = btf_type_id_size(btf, &elem_type_id, &elem_size);
5468 		return elem_type && !btf_type_is_modifier(elem_type) &&
5469 			(array->nelems * elem_size ==
5470 			 btf_resolved_type_size(btf, type_id));
5471 	}
5472 
5473 	return false;
5474 }
5475 
btf_resolve(struct btf_verifier_env * env,const struct btf_type * t,u32 type_id)5476 static int btf_resolve(struct btf_verifier_env *env,
5477 		       const struct btf_type *t, u32 type_id)
5478 {
5479 	u32 save_log_type_id = env->log_type_id;
5480 	const struct resolve_vertex *v;
5481 	int err = 0;
5482 
5483 	env->resolve_mode = RESOLVE_TBD;
5484 	env_stack_push(env, t, type_id);
5485 	while (!err && (v = env_stack_peak(env))) {
5486 		env->log_type_id = v->type_id;
5487 		err = btf_type_ops(v->t)->resolve(env, v);
5488 	}
5489 
5490 	env->log_type_id = type_id;
5491 	if (err == -E2BIG) {
5492 		btf_verifier_log_type(env, t,
5493 				      "Exceeded max resolving depth:%u",
5494 				      MAX_RESOLVE_DEPTH);
5495 	} else if (err == -EEXIST) {
5496 		btf_verifier_log_type(env, t, "Loop detected");
5497 	}
5498 
5499 	/* Final sanity check */
5500 	if (!err && !btf_resolve_valid(env, t, type_id)) {
5501 		btf_verifier_log_type(env, t, "Invalid resolve state");
5502 		err = -EINVAL;
5503 	}
5504 
5505 	env->log_type_id = save_log_type_id;
5506 	return err;
5507 }
5508 
btf_check_all_types(struct btf_verifier_env * env)5509 static int btf_check_all_types(struct btf_verifier_env *env)
5510 {
5511 	struct btf *btf = env->btf;
5512 	const struct btf_type *t;
5513 	u32 type_id, i;
5514 	int err;
5515 
5516 	err = env_resolve_init(env);
5517 	if (err)
5518 		return err;
5519 
5520 	env->phase++;
5521 	for (i = btf->base_btf ? 0 : 1; i < btf->nr_types; i++) {
5522 		type_id = btf->start_id + i;
5523 		t = btf_type_by_id(btf, type_id);
5524 
5525 		env->log_type_id = type_id;
5526 		if (btf_type_needs_resolve(t) &&
5527 		    !env_type_is_resolved(env, type_id)) {
5528 			err = btf_resolve(env, t, type_id);
5529 			if (err)
5530 				return err;
5531 		}
5532 
5533 		if (btf_type_is_func_proto(t)) {
5534 			err = btf_func_proto_check(env, t);
5535 			if (err)
5536 				return err;
5537 		}
5538 	}
5539 
5540 	return 0;
5541 }
5542 
btf_parse_type_sec(struct btf_verifier_env * env)5543 static int btf_parse_type_sec(struct btf_verifier_env *env)
5544 {
5545 	const struct btf_header *hdr = &env->btf->hdr;
5546 	int err;
5547 
5548 	/* Type section must align to 4 bytes */
5549 	if (hdr->type_off & (sizeof(u32) - 1)) {
5550 		btf_verifier_log(env, "Unaligned type_off");
5551 		return -EINVAL;
5552 	}
5553 
5554 	if (!env->btf->base_btf && !hdr->type_len) {
5555 		btf_verifier_log(env, "No type found");
5556 		return -EINVAL;
5557 	}
5558 
5559 	err = btf_check_all_metas(env);
5560 	if (err)
5561 		return err;
5562 
5563 	return btf_check_all_types(env);
5564 }
5565 
btf_parse_str_sec(struct btf_verifier_env * env)5566 static int btf_parse_str_sec(struct btf_verifier_env *env)
5567 {
5568 	const struct btf_header *hdr;
5569 	struct btf *btf = env->btf;
5570 	const char *start, *end;
5571 
5572 	hdr = &btf->hdr;
5573 	start = btf->nohdr_data + hdr->str_off;
5574 	end = start + hdr->str_len;
5575 
5576 	if (hdr->hdr_len < sizeof(struct btf_header) &&
5577 	    end != btf->data + btf->data_size) {
5578 		btf_verifier_log(env, "String section is not at the end");
5579 		return -EINVAL;
5580 	}
5581 
5582 	btf->strings = start;
5583 
5584 	if (btf->base_btf && !hdr->str_len)
5585 		return 0;
5586 	if (!hdr->str_len || hdr->str_len - 1 > BTF_MAX_NAME_OFFSET || end[-1]) {
5587 		btf_verifier_log(env, "Invalid string section");
5588 		return -EINVAL;
5589 	}
5590 	if (!btf->base_btf && start[0]) {
5591 		btf_verifier_log(env, "Invalid string section");
5592 		return -EINVAL;
5593 	}
5594 
5595 	return 0;
5596 }
5597 
btf_parse_layout_sec(struct btf_verifier_env * env)5598 static int btf_parse_layout_sec(struct btf_verifier_env *env)
5599 {
5600 	const struct btf_header *hdr = &env->btf->hdr;
5601 	struct btf *btf = env->btf;
5602 	void *start, *end;
5603 
5604 	if (hdr->hdr_len < sizeof(struct btf_header) ||
5605 	    hdr->layout_len == 0)
5606 		return 0;
5607 
5608 	/* Layout section must align to 4 bytes */
5609 	if (hdr->layout_off & (sizeof(u32) - 1)) {
5610 		btf_verifier_log(env, "Unaligned layout_off");
5611 		return -EINVAL;
5612 	}
5613 	start = btf->nohdr_data + hdr->layout_off;
5614 	end = start + hdr->layout_len;
5615 
5616 	if (hdr->layout_len < sizeof(struct btf_layout)) {
5617 		btf_verifier_log(env, "Layout section is too small");
5618 		return -EINVAL;
5619 	}
5620 	if (hdr->layout_len % sizeof(struct btf_layout) != 0) {
5621 		btf_verifier_log(env, "layout_len is not multiple of %zu",
5622 				 sizeof(struct btf_layout));
5623 		return -EINVAL;
5624 	}
5625 	if (end > btf->data + btf->data_size) {
5626 		btf_verifier_log(env, "Layout section is too big");
5627 		return -EINVAL;
5628 	}
5629 	btf->layout = start;
5630 
5631 	return 0;
5632 }
5633 
5634 static const size_t btf_sec_info_offset[] = {
5635 	offsetof(struct btf_header, type_off),
5636 	offsetof(struct btf_header, str_off),
5637 	offsetof(struct btf_header, layout_off)
5638 };
5639 
btf_sec_info_cmp(const void * a,const void * b)5640 static int btf_sec_info_cmp(const void *a, const void *b)
5641 {
5642 	const struct btf_sec_info *x = a;
5643 	const struct btf_sec_info *y = b;
5644 
5645 	return (int)(x->off - y->off) ? : (int)(x->len - y->len);
5646 }
5647 
btf_check_sec_info(struct btf_verifier_env * env,u32 btf_data_size)5648 static int btf_check_sec_info(struct btf_verifier_env *env,
5649 			      u32 btf_data_size)
5650 {
5651 	struct btf_sec_info secs[ARRAY_SIZE(btf_sec_info_offset)];
5652 	u32 total, expected_total, i;
5653 	u32 nr_secs = ARRAY_SIZE(btf_sec_info_offset);
5654 	const struct btf_header *hdr;
5655 	const struct btf *btf;
5656 
5657 	btf = env->btf;
5658 	hdr = &btf->hdr;
5659 
5660 	if (hdr->hdr_len < sizeof(struct btf_header) || hdr->layout_len == 0)
5661 		nr_secs--;
5662 
5663 	/* Populate the secs from hdr */
5664 	for (i = 0; i < nr_secs; i++)
5665 		secs[i] = *(struct btf_sec_info *)((void *)hdr +
5666 						   btf_sec_info_offset[i]);
5667 
5668 	sort(secs, nr_secs,
5669 	     sizeof(struct btf_sec_info), btf_sec_info_cmp, NULL);
5670 
5671 	/* Check for gaps and overlap among sections */
5672 	total = 0;
5673 	expected_total = btf_data_size - hdr->hdr_len;
5674 	for (i = 0; i < nr_secs; i++) {
5675 		if (expected_total < secs[i].off) {
5676 			btf_verifier_log(env, "Invalid section offset");
5677 			return -EINVAL;
5678 		}
5679 		if (total < secs[i].off) {
5680 			/* gap */
5681 			btf_verifier_log(env, "Unsupported section found");
5682 			return -EINVAL;
5683 		}
5684 		if (total > secs[i].off) {
5685 			btf_verifier_log(env, "Section overlap found");
5686 			return -EINVAL;
5687 		}
5688 		if (expected_total - total < secs[i].len) {
5689 			btf_verifier_log(env,
5690 					 "Total section length too long");
5691 			return -EINVAL;
5692 		}
5693 		total += secs[i].len;
5694 	}
5695 
5696 	/* There is data other than hdr and known sections */
5697 	if (expected_total != total) {
5698 		btf_verifier_log(env, "Unsupported section found");
5699 		return -EINVAL;
5700 	}
5701 
5702 	return 0;
5703 }
5704 
btf_parse_hdr(struct btf_verifier_env * env)5705 static int btf_parse_hdr(struct btf_verifier_env *env)
5706 {
5707 	u32 hdr_len, hdr_copy, btf_data_size;
5708 	const struct btf_header *hdr;
5709 	struct btf *btf;
5710 
5711 	btf = env->btf;
5712 	btf_data_size = btf->data_size;
5713 
5714 	if (btf_data_size < offsetofend(struct btf_header, hdr_len)) {
5715 		btf_verifier_log(env, "hdr_len not found");
5716 		return -EINVAL;
5717 	}
5718 
5719 	hdr = btf->data;
5720 	hdr_len = hdr->hdr_len;
5721 	if (btf_data_size < hdr_len) {
5722 		btf_verifier_log(env, "btf_header not found");
5723 		return -EINVAL;
5724 	}
5725 
5726 	/* Ensure the unsupported header fields are zero */
5727 	if (hdr_len > sizeof(btf->hdr)) {
5728 		u8 *expected_zero = btf->data + sizeof(btf->hdr);
5729 		u8 *end = btf->data + hdr_len;
5730 
5731 		for (; expected_zero < end; expected_zero++) {
5732 			if (*expected_zero) {
5733 				btf_verifier_log(env, "Unsupported btf_header");
5734 				return -E2BIG;
5735 			}
5736 		}
5737 	}
5738 
5739 	hdr_copy = min_t(u32, hdr_len, sizeof(btf->hdr));
5740 	memcpy(&btf->hdr, btf->data, hdr_copy);
5741 
5742 	hdr = &btf->hdr;
5743 
5744 	btf_verifier_log_hdr(env, btf_data_size);
5745 
5746 	if (hdr->magic != BTF_MAGIC) {
5747 		btf_verifier_log(env, "Invalid magic");
5748 		return -EINVAL;
5749 	}
5750 
5751 	if (hdr->version != BTF_VERSION) {
5752 		btf_verifier_log(env, "Unsupported version");
5753 		return -ENOTSUPP;
5754 	}
5755 
5756 	if (hdr->flags) {
5757 		btf_verifier_log(env, "Unsupported flags");
5758 		return -ENOTSUPP;
5759 	}
5760 
5761 	if (!btf->base_btf && btf_data_size == hdr->hdr_len) {
5762 		btf_verifier_log(env, "No data");
5763 		return -EINVAL;
5764 	}
5765 
5766 	return btf_check_sec_info(env, btf_data_size);
5767 }
5768 
5769 static const char *alloc_obj_fields[] = {
5770 	"bpf_spin_lock",
5771 	"bpf_list_head",
5772 	"bpf_list_node",
5773 	"bpf_rb_root",
5774 	"bpf_rb_node",
5775 	"bpf_refcount",
5776 };
5777 
5778 static struct btf_struct_metas *
btf_parse_struct_metas(struct bpf_verifier_log * log,struct btf * btf)5779 btf_parse_struct_metas(struct bpf_verifier_log *log, struct btf *btf)
5780 {
5781 	struct btf_struct_metas *tab = NULL;
5782 	struct btf_id_set *aof;
5783 	int i, n, id, ret;
5784 
5785 	BUILD_BUG_ON(offsetof(struct btf_id_set, cnt) != 0);
5786 	BUILD_BUG_ON(sizeof(struct btf_id_set) != sizeof(u32));
5787 
5788 	aof = kmalloc_obj(*aof, GFP_KERNEL | __GFP_NOWARN);
5789 	if (!aof)
5790 		return ERR_PTR(-ENOMEM);
5791 	aof->cnt = 0;
5792 
5793 	for (i = 0; i < ARRAY_SIZE(alloc_obj_fields); i++) {
5794 		/* Try to find whether this special type exists in user BTF, and
5795 		 * if so remember its ID so we can easily find it among members
5796 		 * of structs that we iterate in the next loop.
5797 		 */
5798 		struct btf_id_set *new_aof;
5799 
5800 		id = btf_find_by_name_kind(btf, alloc_obj_fields[i], BTF_KIND_STRUCT);
5801 		if (id < 0)
5802 			continue;
5803 
5804 		new_aof = krealloc(aof, struct_size(new_aof, ids, aof->cnt + 1),
5805 				   GFP_KERNEL | __GFP_NOWARN);
5806 		if (!new_aof) {
5807 			ret = -ENOMEM;
5808 			goto free_aof;
5809 		}
5810 		aof = new_aof;
5811 		aof->ids[aof->cnt++] = id;
5812 	}
5813 
5814 	n = btf_nr_types(btf);
5815 	for (i = 1; i < n; i++) {
5816 		/* Try to find if there are kptrs in user BTF and remember their ID */
5817 		struct btf_id_set *new_aof;
5818 		struct btf_field_info tmp;
5819 		const struct btf_type *t;
5820 
5821 		t = btf_type_by_id(btf, i);
5822 		if (!t) {
5823 			ret = -EINVAL;
5824 			goto free_aof;
5825 		}
5826 
5827 		ret = btf_find_kptr(btf, t, 0, 0, &tmp, BPF_KPTR);
5828 		if (ret != BTF_FIELD_FOUND)
5829 			continue;
5830 
5831 		new_aof = krealloc(aof, struct_size(new_aof, ids, aof->cnt + 1),
5832 				   GFP_KERNEL | __GFP_NOWARN);
5833 		if (!new_aof) {
5834 			ret = -ENOMEM;
5835 			goto free_aof;
5836 		}
5837 		aof = new_aof;
5838 		aof->ids[aof->cnt++] = i;
5839 	}
5840 
5841 	if (!aof->cnt) {
5842 		kfree(aof);
5843 		return NULL;
5844 	}
5845 	sort(&aof->ids, aof->cnt, sizeof(aof->ids[0]), btf_id_cmp_func, NULL);
5846 
5847 	for (i = 1; i < n; i++) {
5848 		struct btf_struct_metas *new_tab;
5849 		const struct btf_member *member;
5850 		struct btf_struct_meta *type;
5851 		struct btf_record *record;
5852 		const struct btf_type *t;
5853 		int j, tab_cnt;
5854 
5855 		t = btf_type_by_id(btf, i);
5856 		if (!__btf_type_is_struct(t))
5857 			continue;
5858 
5859 		cond_resched();
5860 
5861 		for_each_member(j, t, member) {
5862 			if (btf_id_set_contains(aof, member->type))
5863 				goto parse;
5864 		}
5865 		continue;
5866 	parse:
5867 		tab_cnt = tab ? tab->cnt : 0;
5868 		new_tab = krealloc(tab, struct_size(new_tab, types, tab_cnt + 1),
5869 				   GFP_KERNEL | __GFP_NOWARN);
5870 		if (!new_tab) {
5871 			ret = -ENOMEM;
5872 			goto free;
5873 		}
5874 		if (!tab)
5875 			new_tab->cnt = 0;
5876 		tab = new_tab;
5877 
5878 		type = &tab->types[tab->cnt];
5879 		type->btf_id = i;
5880 		record = btf_parse_fields(btf, t, BPF_SPIN_LOCK | BPF_RES_SPIN_LOCK | BPF_LIST_HEAD | BPF_LIST_NODE |
5881 						  BPF_RB_ROOT | BPF_RB_NODE | BPF_REFCOUNT |
5882 						  BPF_KPTR, t->size);
5883 		/* The record cannot be unset, treat it as an error if so */
5884 		if (IS_ERR_OR_NULL(record)) {
5885 			ret = PTR_ERR_OR_ZERO(record) ?: -EFAULT;
5886 			goto free;
5887 		}
5888 		type->record = record;
5889 		tab->cnt++;
5890 	}
5891 	kfree(aof);
5892 	return tab;
5893 free:
5894 	btf_struct_metas_free(tab);
5895 free_aof:
5896 	kfree(aof);
5897 	return ERR_PTR(ret);
5898 }
5899 
btf_find_struct_meta(const struct btf * btf,u32 btf_id)5900 struct btf_struct_meta *btf_find_struct_meta(const struct btf *btf, u32 btf_id)
5901 {
5902 	struct btf_struct_metas *tab;
5903 
5904 	BUILD_BUG_ON(offsetof(struct btf_struct_meta, btf_id) != 0);
5905 	tab = btf->struct_meta_tab;
5906 	if (!tab)
5907 		return NULL;
5908 	return bsearch(&btf_id, tab->types, tab->cnt, sizeof(tab->types[0]), btf_id_cmp_func);
5909 }
5910 
btf_check_modifier_chain_length(struct btf_verifier_env * env,struct btf * btf,int start_id)5911 static int btf_check_modifier_chain_length(struct btf_verifier_env *env,
5912 					   struct btf *btf, int start_id)
5913 {
5914 	int i, n, good_id = start_id - 1;
5915 
5916 	n = btf_nr_types(btf);
5917 	for (i = start_id; i < n; i++) {
5918 		const struct btf_type *t;
5919 		int chain_limit = 32;
5920 		u32 cur_id = i;
5921 
5922 		t = btf_type_by_id(btf, i);
5923 		if (!t)
5924 			return -EINVAL;
5925 		if (!btf_type_is_modifier(t))
5926 			continue;
5927 
5928 		cond_resched();
5929 
5930 		while (btf_type_is_modifier(t)) {
5931 			if (!chain_limit--) {
5932 				btf_verifier_log(env, "Max chain length or cycle detected");
5933 				return -ELOOP;
5934 			}
5935 
5936 			if (cur_id <= good_id)
5937 				break;
5938 			/* Move to next type */
5939 			cur_id = t->type;
5940 			t = btf_type_by_id(btf, cur_id);
5941 			if (!t)
5942 				return -EINVAL;
5943 		}
5944 		good_id = i;
5945 	}
5946 	return 0;
5947 }
5948 
btf_parse(const union bpf_attr * attr,bpfptr_t uattr,struct bpf_log_attr * attr_log)5949 static struct btf *btf_parse(const union bpf_attr *attr, bpfptr_t uattr,
5950 			     struct bpf_log_attr *attr_log)
5951 {
5952 	bpfptr_t btf_data = make_bpfptr(attr->btf, uattr.is_kernel);
5953 	struct btf_struct_metas *struct_meta_tab;
5954 	struct btf_verifier_env *env = NULL;
5955 	struct btf *btf = NULL;
5956 	u8 *data;
5957 	int err, ret;
5958 
5959 	if (attr->btf_size > BTF_MAX_SIZE)
5960 		return ERR_PTR(-E2BIG);
5961 
5962 	env = kzalloc_obj(*env, GFP_KERNEL | __GFP_NOWARN);
5963 	if (!env)
5964 		return ERR_PTR(-ENOMEM);
5965 
5966 	/* user could have requested verbose verifier output
5967 	 * and supplied buffer to store the verification trace
5968 	 */
5969 	err = bpf_vlog_init(&env->log, attr_log->level, attr_log->ubuf, attr_log->size);
5970 	if (err)
5971 		goto errout_free;
5972 
5973 	btf = kzalloc_obj(*btf, GFP_KERNEL | __GFP_NOWARN);
5974 	if (!btf) {
5975 		err = -ENOMEM;
5976 		goto errout;
5977 	}
5978 	env->btf = btf;
5979 	btf->named_start_id = 0;
5980 
5981 	data = kvmalloc(attr->btf_size, GFP_KERNEL | __GFP_NOWARN);
5982 	if (!data) {
5983 		err = -ENOMEM;
5984 		goto errout;
5985 	}
5986 
5987 	btf->data = data;
5988 	btf->data_size = attr->btf_size;
5989 
5990 	if (copy_from_bpfptr(data, btf_data, attr->btf_size)) {
5991 		err = -EFAULT;
5992 		goto errout;
5993 	}
5994 
5995 	err = btf_parse_hdr(env);
5996 	if (err)
5997 		goto errout;
5998 
5999 	btf->nohdr_data = btf->data + btf->hdr.hdr_len;
6000 
6001 	err = btf_parse_str_sec(env);
6002 	if (err)
6003 		goto errout;
6004 
6005 	err = btf_parse_layout_sec(env);
6006 	if (err)
6007 		goto errout;
6008 
6009 	err = btf_parse_type_sec(env);
6010 	if (err)
6011 		goto errout;
6012 
6013 	err = btf_check_modifier_chain_length(env, btf, 1);
6014 	if (err)
6015 		goto errout;
6016 
6017 	struct_meta_tab = btf_parse_struct_metas(&env->log, btf);
6018 	if (IS_ERR(struct_meta_tab)) {
6019 		err = PTR_ERR(struct_meta_tab);
6020 		goto errout;
6021 	}
6022 	btf->struct_meta_tab = struct_meta_tab;
6023 
6024 	if (struct_meta_tab) {
6025 		int i;
6026 
6027 		for (i = 0; i < struct_meta_tab->cnt; i++) {
6028 			err = btf_check_and_fixup_fields(btf, struct_meta_tab->types[i].record);
6029 			if (err < 0)
6030 				goto errout_meta;
6031 		}
6032 	}
6033 
6034 	err = bpf_log_attr_finalize(attr_log, &env->log);
6035 	if (err)
6036 		goto errout_free;
6037 
6038 	btf_verifier_env_free(env);
6039 	refcount_set(&btf->refcnt, 1);
6040 	return btf;
6041 
6042 errout_meta:
6043 	btf_free_struct_meta_tab(btf);
6044 errout:
6045 	/* overwrite err with -ENOSPC or -EFAULT */
6046 	ret = bpf_log_attr_finalize(attr_log, &env->log);
6047 	if (ret)
6048 		err = ret;
6049 errout_free:
6050 	btf_verifier_env_free(env);
6051 	if (btf)
6052 		btf_free(btf);
6053 	return ERR_PTR(err);
6054 }
6055 
6056 extern char __start_BTF[];
6057 extern char __stop_BTF[];
6058 extern struct btf *btf_vmlinux;
6059 
6060 #define BPF_MAP_TYPE(_id, _ops)
6061 #define BPF_LINK_TYPE(_id, _name)
6062 static union {
6063 	struct bpf_ctx_convert {
6064 #define BPF_PROG_TYPE(_id, _name, prog_ctx_type, kern_ctx_type) \
6065 	prog_ctx_type _id##_prog; \
6066 	kern_ctx_type _id##_kern;
6067 #include <linux/bpf_types.h>
6068 #undef BPF_PROG_TYPE
6069 	} *__t;
6070 	/* 't' is written once under lock. Read many times. */
6071 	const struct btf_type *t;
6072 } bpf_ctx_convert;
6073 enum {
6074 #define BPF_PROG_TYPE(_id, _name, prog_ctx_type, kern_ctx_type) \
6075 	__ctx_convert##_id,
6076 #include <linux/bpf_types.h>
6077 #undef BPF_PROG_TYPE
6078 	__ctx_convert_unused, /* to avoid empty enum in extreme .config */
6079 };
6080 static u8 bpf_ctx_convert_map[] = {
6081 #define BPF_PROG_TYPE(_id, _name, prog_ctx_type, kern_ctx_type) \
6082 	[_id] = __ctx_convert##_id,
6083 #include <linux/bpf_types.h>
6084 #undef BPF_PROG_TYPE
6085 	0, /* avoid empty array */
6086 };
6087 #undef BPF_MAP_TYPE
6088 #undef BPF_LINK_TYPE
6089 
find_canonical_prog_ctx_type(enum bpf_prog_type prog_type)6090 static const struct btf_type *find_canonical_prog_ctx_type(enum bpf_prog_type prog_type)
6091 {
6092 	const struct btf_type *conv_struct;
6093 	const struct btf_member *ctx_type;
6094 
6095 	conv_struct = bpf_ctx_convert.t;
6096 	if (!conv_struct)
6097 		return NULL;
6098 	/* prog_type is valid bpf program type. No need for bounds check. */
6099 	ctx_type = btf_type_member(conv_struct) + bpf_ctx_convert_map[prog_type] * 2;
6100 	/* ctx_type is a pointer to prog_ctx_type in vmlinux.
6101 	 * Like 'struct __sk_buff'
6102 	 */
6103 	return btf_type_by_id(btf_vmlinux, ctx_type->type);
6104 }
6105 
find_kern_ctx_type_id(enum bpf_prog_type prog_type)6106 static int find_kern_ctx_type_id(enum bpf_prog_type prog_type)
6107 {
6108 	const struct btf_type *conv_struct;
6109 	const struct btf_member *ctx_type;
6110 
6111 	conv_struct = bpf_ctx_convert.t;
6112 	if (!conv_struct)
6113 		return -EFAULT;
6114 	/* prog_type is valid bpf program type. No need for bounds check. */
6115 	ctx_type = btf_type_member(conv_struct) + bpf_ctx_convert_map[prog_type] * 2 + 1;
6116 	/* ctx_type is a pointer to prog_ctx_type in vmlinux.
6117 	 * Like 'struct sk_buff'
6118 	 */
6119 	return ctx_type->type;
6120 }
6121 
btf_is_projection_of(const char * pname,const char * tname)6122 bool btf_is_projection_of(const char *pname, const char *tname)
6123 {
6124 	if (strcmp(pname, "__sk_buff") == 0 && strcmp(tname, "sk_buff") == 0)
6125 		return true;
6126 	if (strcmp(pname, "xdp_md") == 0 && strcmp(tname, "xdp_buff") == 0)
6127 		return true;
6128 	return false;
6129 }
6130 
btf_is_prog_ctx_type(struct bpf_verifier_log * log,const struct btf * btf,const struct btf_type * t,enum bpf_prog_type prog_type,int arg)6131 bool btf_is_prog_ctx_type(struct bpf_verifier_log *log, const struct btf *btf,
6132 			  const struct btf_type *t, enum bpf_prog_type prog_type,
6133 			  int arg)
6134 {
6135 	const struct btf_type *ctx_type;
6136 	const char *tname, *ctx_tname;
6137 
6138 	t = btf_type_by_id(btf, t->type);
6139 
6140 	/* KPROBE programs allow bpf_user_pt_regs_t typedef, which we need to
6141 	 * check before we skip all the typedef below.
6142 	 */
6143 	if (prog_type == BPF_PROG_TYPE_KPROBE) {
6144 		while (btf_type_is_modifier(t) && !btf_type_is_typedef(t))
6145 			t = btf_type_by_id(btf, t->type);
6146 
6147 		if (btf_type_is_typedef(t)) {
6148 			tname = btf_name_by_offset(btf, t->name_off);
6149 			if (tname && strcmp(tname, "bpf_user_pt_regs_t") == 0)
6150 				return true;
6151 		}
6152 	}
6153 
6154 	while (btf_type_is_modifier(t))
6155 		t = btf_type_by_id(btf, t->type);
6156 	if (!btf_type_is_struct(t)) {
6157 		/* Only pointer to struct is supported for now.
6158 		 * That means that BPF_PROG_TYPE_TRACEPOINT with BTF
6159 		 * is not supported yet.
6160 		 * BPF_PROG_TYPE_RAW_TRACEPOINT is fine.
6161 		 */
6162 		return false;
6163 	}
6164 	tname = btf_name_by_offset(btf, t->name_off);
6165 	if (!tname) {
6166 		bpf_log(log, "arg#%d struct doesn't have a name\n", arg);
6167 		return false;
6168 	}
6169 
6170 	ctx_type = find_canonical_prog_ctx_type(prog_type);
6171 	if (!ctx_type) {
6172 		bpf_log(log, "btf_vmlinux is malformed\n");
6173 		/* should not happen */
6174 		return false;
6175 	}
6176 again:
6177 	ctx_tname = btf_name_by_offset(btf_vmlinux, ctx_type->name_off);
6178 	if (!ctx_tname) {
6179 		/* should not happen */
6180 		bpf_log(log, "Please fix kernel include/linux/bpf_types.h\n");
6181 		return false;
6182 	}
6183 	/* program types without named context types work only with arg:ctx tag */
6184 	if (ctx_tname[0] == '\0')
6185 		return false;
6186 	/* only compare that prog's ctx type name is the same as
6187 	 * kernel expects. No need to compare field by field.
6188 	 * It's ok for bpf prog to do:
6189 	 * struct __sk_buff {};
6190 	 * int socket_filter_bpf_prog(struct __sk_buff *skb)
6191 	 * { // no fields of skb are ever used }
6192 	 */
6193 	if (btf_is_projection_of(ctx_tname, tname))
6194 		return true;
6195 	if (strcmp(ctx_tname, tname)) {
6196 		/* bpf_user_pt_regs_t is a typedef, so resolve it to
6197 		 * underlying struct and check name again
6198 		 */
6199 		if (!btf_type_is_modifier(ctx_type))
6200 			return false;
6201 		while (btf_type_is_modifier(ctx_type))
6202 			ctx_type = btf_type_by_id(btf_vmlinux, ctx_type->type);
6203 		goto again;
6204 	}
6205 	return true;
6206 }
6207 
6208 /* forward declarations for arch-specific underlying types of
6209  * bpf_user_pt_regs_t; this avoids the need for arch-specific #ifdef
6210  * compilation guards below for BPF_PROG_TYPE_PERF_EVENT checks, but still
6211  * works correctly with __builtin_types_compatible_p() on respective
6212  * architectures
6213  */
6214 struct user_regs_struct;
6215 struct user_pt_regs;
6216 
btf_validate_prog_ctx_type(struct bpf_verifier_log * log,const struct btf * btf,const struct btf_type * t,int arg,enum bpf_prog_type prog_type,enum bpf_attach_type attach_type)6217 static int btf_validate_prog_ctx_type(struct bpf_verifier_log *log, const struct btf *btf,
6218 				      const struct btf_type *t, int arg,
6219 				      enum bpf_prog_type prog_type,
6220 				      enum bpf_attach_type attach_type)
6221 {
6222 	const struct btf_type *ctx_type;
6223 	const char *tname, *ctx_tname;
6224 
6225 	if (!btf_is_ptr(t)) {
6226 		bpf_log(log, "arg#%d type isn't a pointer\n", arg);
6227 		return -EINVAL;
6228 	}
6229 	t = btf_type_by_id(btf, t->type);
6230 
6231 	/* KPROBE and PERF_EVENT programs allow bpf_user_pt_regs_t typedef */
6232 	if (prog_type == BPF_PROG_TYPE_KPROBE || prog_type == BPF_PROG_TYPE_PERF_EVENT) {
6233 		while (btf_type_is_modifier(t) && !btf_type_is_typedef(t))
6234 			t = btf_type_by_id(btf, t->type);
6235 
6236 		if (btf_type_is_typedef(t)) {
6237 			tname = btf_name_by_offset(btf, t->name_off);
6238 			if (tname && strcmp(tname, "bpf_user_pt_regs_t") == 0)
6239 				return 0;
6240 		}
6241 	}
6242 
6243 	/* all other program types don't use typedefs for context type */
6244 	while (btf_type_is_modifier(t))
6245 		t = btf_type_by_id(btf, t->type);
6246 
6247 	/* `void *ctx __arg_ctx` is always valid */
6248 	if (btf_type_is_void(t))
6249 		return 0;
6250 
6251 	tname = btf_name_by_offset(btf, t->name_off);
6252 	if (str_is_empty(tname)) {
6253 		bpf_log(log, "arg#%d type doesn't have a name\n", arg);
6254 		return -EINVAL;
6255 	}
6256 
6257 	/* special cases */
6258 	switch (prog_type) {
6259 	case BPF_PROG_TYPE_KPROBE:
6260 		if (__btf_type_is_struct(t) && strcmp(tname, "pt_regs") == 0)
6261 			return 0;
6262 		break;
6263 	case BPF_PROG_TYPE_PERF_EVENT:
6264 		if (__builtin_types_compatible_p(bpf_user_pt_regs_t, struct pt_regs) &&
6265 		    __btf_type_is_struct(t) && strcmp(tname, "pt_regs") == 0)
6266 			return 0;
6267 		if (__builtin_types_compatible_p(bpf_user_pt_regs_t, struct user_pt_regs) &&
6268 		    __btf_type_is_struct(t) && strcmp(tname, "user_pt_regs") == 0)
6269 			return 0;
6270 		if (__builtin_types_compatible_p(bpf_user_pt_regs_t, struct user_regs_struct) &&
6271 		    __btf_type_is_struct(t) && strcmp(tname, "user_regs_struct") == 0)
6272 			return 0;
6273 		break;
6274 	case BPF_PROG_TYPE_RAW_TRACEPOINT:
6275 	case BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE:
6276 		/* allow u64* as ctx */
6277 		if (btf_is_int(t) && t->size == 8)
6278 			return 0;
6279 		break;
6280 	case BPF_PROG_TYPE_TRACING:
6281 		switch (attach_type) {
6282 		case BPF_TRACE_RAW_TP:
6283 			/* tp_btf program is TRACING, so need special case here */
6284 			if (__btf_type_is_struct(t) &&
6285 			    strcmp(tname, "bpf_raw_tracepoint_args") == 0)
6286 				return 0;
6287 			/* allow u64* as ctx */
6288 			if (btf_is_int(t) && t->size == 8)
6289 				return 0;
6290 			break;
6291 		case BPF_TRACE_ITER:
6292 			/* allow struct bpf_iter__xxx types only */
6293 			if (__btf_type_is_struct(t) &&
6294 			    strncmp(tname, "bpf_iter__", sizeof("bpf_iter__") - 1) == 0)
6295 				return 0;
6296 			break;
6297 		case BPF_TRACE_FENTRY:
6298 		case BPF_TRACE_FEXIT:
6299 		case BPF_MODIFY_RETURN:
6300 		case BPF_TRACE_FSESSION:
6301 			/* allow u64* as ctx */
6302 			if (btf_is_int(t) && t->size == 8)
6303 				return 0;
6304 			break;
6305 		default:
6306 			break;
6307 		}
6308 		break;
6309 	case BPF_PROG_TYPE_LSM:
6310 	case BPF_PROG_TYPE_STRUCT_OPS:
6311 		/* allow u64* as ctx */
6312 		if (btf_is_int(t) && t->size == 8)
6313 			return 0;
6314 		break;
6315 	case BPF_PROG_TYPE_TRACEPOINT:
6316 	case BPF_PROG_TYPE_SYSCALL:
6317 	case BPF_PROG_TYPE_EXT:
6318 		return 0; /* anything goes */
6319 	default:
6320 		break;
6321 	}
6322 
6323 	ctx_type = find_canonical_prog_ctx_type(prog_type);
6324 	if (!ctx_type) {
6325 		/* should not happen */
6326 		bpf_log(log, "btf_vmlinux is malformed\n");
6327 		return -EINVAL;
6328 	}
6329 
6330 	/* resolve typedefs and check that underlying structs are matching as well */
6331 	while (btf_type_is_modifier(ctx_type))
6332 		ctx_type = btf_type_by_id(btf_vmlinux, ctx_type->type);
6333 
6334 	/* if program type doesn't have distinctly named struct type for
6335 	 * context, then __arg_ctx argument can only be `void *`, which we
6336 	 * already checked above
6337 	 */
6338 	if (!__btf_type_is_struct(ctx_type)) {
6339 		bpf_log(log, "arg#%d should be void pointer\n", arg);
6340 		return -EINVAL;
6341 	}
6342 
6343 	ctx_tname = btf_name_by_offset(btf_vmlinux, ctx_type->name_off);
6344 	if (!__btf_type_is_struct(t) || strcmp(ctx_tname, tname) != 0) {
6345 		bpf_log(log, "arg#%d should be `struct %s *`\n", arg, ctx_tname);
6346 		return -EINVAL;
6347 	}
6348 
6349 	return 0;
6350 }
6351 
btf_translate_to_vmlinux(struct bpf_verifier_log * log,struct btf * btf,const struct btf_type * t,enum bpf_prog_type prog_type,int arg)6352 static int btf_translate_to_vmlinux(struct bpf_verifier_log *log,
6353 				     struct btf *btf,
6354 				     const struct btf_type *t,
6355 				     enum bpf_prog_type prog_type,
6356 				     int arg)
6357 {
6358 	if (!btf_is_prog_ctx_type(log, btf, t, prog_type, arg))
6359 		return -ENOENT;
6360 	return find_kern_ctx_type_id(prog_type);
6361 }
6362 
get_kern_ctx_btf_id(struct bpf_verifier_log * log,enum bpf_prog_type prog_type)6363 int get_kern_ctx_btf_id(struct bpf_verifier_log *log, enum bpf_prog_type prog_type)
6364 {
6365 	const struct btf_member *kctx_member;
6366 	const struct btf_type *conv_struct;
6367 	const struct btf_type *kctx_type;
6368 	u32 kctx_type_id;
6369 
6370 	conv_struct = bpf_ctx_convert.t;
6371 	/* get member for kernel ctx type */
6372 	kctx_member = btf_type_member(conv_struct) + bpf_ctx_convert_map[prog_type] * 2 + 1;
6373 	kctx_type_id = kctx_member->type;
6374 	kctx_type = btf_type_by_id(btf_vmlinux, kctx_type_id);
6375 	if (!btf_type_is_struct(kctx_type)) {
6376 		bpf_log(log, "kern ctx type id %u is not a struct\n", kctx_type_id);
6377 		return -EINVAL;
6378 	}
6379 
6380 	return kctx_type_id;
6381 }
6382 
BTF_ID_LIST_SINGLE(bpf_ctx_convert_btf_id,struct,bpf_ctx_convert)6383 BTF_ID_LIST_SINGLE(bpf_ctx_convert_btf_id, struct, bpf_ctx_convert)
6384 
6385 static struct btf *btf_parse_base(struct btf_verifier_env *env, const char *name,
6386 				  void *data, unsigned int data_size)
6387 {
6388 	struct btf *btf = NULL;
6389 	int err;
6390 
6391 	if (!IS_ENABLED(CONFIG_DEBUG_INFO_BTF))
6392 		return ERR_PTR(-ENOENT);
6393 
6394 	btf = kzalloc_obj(*btf, GFP_KERNEL | __GFP_NOWARN);
6395 	if (!btf) {
6396 		err = -ENOMEM;
6397 		goto errout;
6398 	}
6399 	env->btf = btf;
6400 
6401 	btf->data = data;
6402 	btf->data_size = data_size;
6403 	btf->kernel_btf = true;
6404 	btf->named_start_id = 0;
6405 	strscpy(btf->name, name);
6406 
6407 	err = btf_parse_hdr(env);
6408 	if (err)
6409 		goto errout;
6410 
6411 	btf->nohdr_data = btf->data + btf->hdr.hdr_len;
6412 
6413 	err = btf_parse_str_sec(env);
6414 	if (err)
6415 		goto errout;
6416 
6417 	err = btf_check_all_metas(env);
6418 	if (err)
6419 		goto errout;
6420 
6421 	err = btf_check_modifier_chain_length(env, btf, 1);
6422 	if (err)
6423 		goto errout;
6424 
6425 	btf_check_sorted(btf);
6426 	refcount_set(&btf->refcnt, 1);
6427 
6428 	return btf;
6429 
6430 errout:
6431 	if (btf) {
6432 		kvfree(btf->types);
6433 		kfree(btf);
6434 	}
6435 	return ERR_PTR(err);
6436 }
6437 
btf_parse_vmlinux(void)6438 struct btf *btf_parse_vmlinux(void)
6439 {
6440 	struct btf_verifier_env *env = NULL;
6441 	struct bpf_verifier_log *log;
6442 	struct btf *btf;
6443 	int err;
6444 
6445 	env = kzalloc_obj(*env, GFP_KERNEL | __GFP_NOWARN);
6446 	if (!env)
6447 		return ERR_PTR(-ENOMEM);
6448 
6449 	log = &env->log;
6450 	log->level = BPF_LOG_KERNEL;
6451 	btf = btf_parse_base(env, "vmlinux", __start_BTF, __stop_BTF - __start_BTF);
6452 	if (IS_ERR(btf))
6453 		goto err_out;
6454 
6455 	/* btf_parse_vmlinux() runs under btf_vmlinux_lock */
6456 	bpf_ctx_convert.t = btf_type_by_id(btf, bpf_ctx_convert_btf_id[0]);
6457 	err = btf_alloc_id(btf);
6458 	if (err) {
6459 		btf_free(btf);
6460 		btf = ERR_PTR(err);
6461 	}
6462 err_out:
6463 	btf_verifier_env_free(env);
6464 	return btf;
6465 }
6466 
6467 /* If .BTF_ids section was created with distilled base BTF, both base and
6468  * split BTF ids will need to be mapped to actual base/split ids for
6469  * BTF now that it has been relocated.
6470  */
btf_relocate_id(const struct btf * btf,__u32 id)6471 __u32 btf_relocate_id(const struct btf *btf, __u32 id)
6472 {
6473 	if (!btf->base_btf || !btf->base_id_map)
6474 		return id;
6475 	return btf->base_id_map[id];
6476 }
6477 
6478 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
6479 
btf_parse_module(const char * module_name,const void * data,unsigned int data_size,void * base_data,unsigned int base_data_size)6480 static struct btf *btf_parse_module(const char *module_name, const void *data,
6481 				    unsigned int data_size, void *base_data,
6482 				    unsigned int base_data_size)
6483 {
6484 	struct btf *btf = NULL, *vmlinux_btf, *base_btf = NULL;
6485 	struct btf_verifier_env *env = NULL;
6486 	struct bpf_verifier_log *log;
6487 	int err = 0;
6488 
6489 	vmlinux_btf = bpf_get_btf_vmlinux();
6490 	if (IS_ERR(vmlinux_btf))
6491 		return vmlinux_btf;
6492 	if (!vmlinux_btf)
6493 		return ERR_PTR(-EINVAL);
6494 
6495 	env = kzalloc_obj(*env, GFP_KERNEL | __GFP_NOWARN);
6496 	if (!env)
6497 		return ERR_PTR(-ENOMEM);
6498 
6499 	log = &env->log;
6500 	log->level = BPF_LOG_KERNEL;
6501 
6502 	if (base_data) {
6503 		base_btf = btf_parse_base(env, ".BTF.base", base_data, base_data_size);
6504 		if (IS_ERR(base_btf)) {
6505 			err = PTR_ERR(base_btf);
6506 			goto errout;
6507 		}
6508 	} else {
6509 		base_btf = vmlinux_btf;
6510 	}
6511 
6512 	btf = kzalloc_obj(*btf, GFP_KERNEL | __GFP_NOWARN);
6513 	if (!btf) {
6514 		err = -ENOMEM;
6515 		goto errout;
6516 	}
6517 	env->btf = btf;
6518 
6519 	btf->base_btf = base_btf;
6520 	btf->start_id = base_btf->nr_types;
6521 	btf->start_str_off = base_btf->hdr.str_len;
6522 	btf->kernel_btf = true;
6523 	btf->named_start_id = 0;
6524 	strscpy(btf->name, module_name);
6525 
6526 	btf->data = kvmemdup(data, data_size, GFP_KERNEL | __GFP_NOWARN);
6527 	if (!btf->data) {
6528 		err = -ENOMEM;
6529 		goto errout;
6530 	}
6531 	btf->data_size = data_size;
6532 
6533 	err = btf_parse_hdr(env);
6534 	if (err)
6535 		goto errout;
6536 
6537 	btf->nohdr_data = btf->data + btf->hdr.hdr_len;
6538 
6539 	err = btf_parse_str_sec(env);
6540 	if (err)
6541 		goto errout;
6542 
6543 	err = btf_check_all_metas(env);
6544 	if (err)
6545 		goto errout;
6546 
6547 	err = btf_check_modifier_chain_length(env, btf, btf_nr_types(base_btf));
6548 	if (err)
6549 		goto errout;
6550 
6551 	if (base_btf != vmlinux_btf) {
6552 		err = btf_relocate(btf, vmlinux_btf, &btf->base_id_map);
6553 		if (err)
6554 			goto errout;
6555 		btf_free(base_btf);
6556 		base_btf = vmlinux_btf;
6557 	}
6558 
6559 	btf_verifier_env_free(env);
6560 	btf_check_sorted(btf);
6561 	refcount_set(&btf->refcnt, 1);
6562 	return btf;
6563 
6564 errout:
6565 	btf_verifier_env_free(env);
6566 	if (!IS_ERR(base_btf) && base_btf != vmlinux_btf)
6567 		btf_free(base_btf);
6568 	if (btf) {
6569 		kvfree(btf->data);
6570 		kvfree(btf->types);
6571 		kfree(btf);
6572 	}
6573 	return ERR_PTR(err);
6574 }
6575 
6576 #endif /* CONFIG_DEBUG_INFO_BTF_MODULES */
6577 
bpf_prog_get_target_btf(const struct bpf_prog * prog)6578 struct btf *bpf_prog_get_target_btf(const struct bpf_prog *prog)
6579 {
6580 	struct bpf_prog *tgt_prog = prog->aux->dst_prog;
6581 
6582 	if (tgt_prog)
6583 		return tgt_prog->aux->btf;
6584 	else
6585 		return prog->aux->attach_btf;
6586 }
6587 
btf_ctx_arg_idx(struct btf * btf,const struct btf_type * func_proto,int off)6588 u32 btf_ctx_arg_idx(struct btf *btf, const struct btf_type *func_proto,
6589 		    int off)
6590 {
6591 	const struct btf_param *args;
6592 	const struct btf_type *t;
6593 	u32 offset = 0, nr_args;
6594 	int i;
6595 
6596 	if (!func_proto)
6597 		return off / 8;
6598 
6599 	nr_args = btf_type_vlen(func_proto);
6600 	args = (const struct btf_param *)(func_proto + 1);
6601 	for (i = 0; i < nr_args; i++) {
6602 		t = btf_type_skip_modifiers(btf, args[i].type, NULL);
6603 		offset += btf_type_is_ptr(t) ? 8 : roundup(t->size, 8);
6604 		if (off < offset)
6605 			return i;
6606 	}
6607 
6608 	t = btf_type_skip_modifiers(btf, func_proto->type, NULL);
6609 	offset += btf_type_is_ptr(t) ? 8 : roundup(t->size, 8);
6610 	if (off < offset)
6611 		return nr_args;
6612 
6613 	return nr_args + 1;
6614 }
6615 
prog_args_trusted(const struct bpf_prog * prog)6616 static bool prog_args_trusted(const struct bpf_prog *prog)
6617 {
6618 	enum bpf_attach_type atype = prog->expected_attach_type;
6619 
6620 	switch (prog->type) {
6621 	case BPF_PROG_TYPE_TRACING:
6622 		return atype == BPF_TRACE_RAW_TP || atype == BPF_TRACE_ITER;
6623 	case BPF_PROG_TYPE_LSM:
6624 		return bpf_lsm_is_trusted(prog);
6625 	case BPF_PROG_TYPE_STRUCT_OPS:
6626 		return true;
6627 	default:
6628 		return false;
6629 	}
6630 }
6631 
btf_ctx_arg_offset(const struct btf * btf,const struct btf_type * func_proto,u32 arg_no)6632 int btf_ctx_arg_offset(const struct btf *btf, const struct btf_type *func_proto,
6633 		       u32 arg_no)
6634 {
6635 	const struct btf_param *args;
6636 	const struct btf_type *t;
6637 	int off = 0, i;
6638 	u32 sz;
6639 
6640 	args = btf_params(func_proto);
6641 	for (i = 0; i < arg_no; i++) {
6642 		t = btf_type_by_id(btf, args[i].type);
6643 		t = btf_resolve_size(btf, t, &sz);
6644 		if (IS_ERR(t))
6645 			return PTR_ERR(t);
6646 		off += roundup(sz, 8);
6647 	}
6648 
6649 	return off;
6650 }
6651 
6652 struct bpf_raw_tp_null_args {
6653 	const char *func;
6654 	u64 mask;
6655 };
6656 
6657 static const struct bpf_raw_tp_null_args raw_tp_null_args[] = {
6658 	/* sched */
6659 	{ "sched_pi_setprio", 0x10 },
6660 	/* ... from sched_numa_pair_template event class */
6661 	{ "sched_stick_numa", 0x100 },
6662 	{ "sched_swap_numa", 0x100 },
6663 	/* afs */
6664 	{ "afs_make_fs_call", 0x10 },
6665 	{ "afs_make_fs_calli", 0x10 },
6666 	{ "afs_make_fs_call1", 0x10 },
6667 	{ "afs_make_fs_call2", 0x10 },
6668 	{ "afs_protocol_error", 0x1 },
6669 	{ "afs_flock_ev", 0x10 },
6670 	/* cachefiles */
6671 	{ "cachefiles_lookup", 0x1 | 0x200 },
6672 	{ "cachefiles_unlink", 0x1 },
6673 	{ "cachefiles_rename", 0x1 },
6674 	{ "cachefiles_prep_read", 0x1 },
6675 	{ "cachefiles_mark_active", 0x1 },
6676 	{ "cachefiles_mark_failed", 0x1 },
6677 	{ "cachefiles_mark_inactive", 0x1 },
6678 	{ "cachefiles_vfs_error", 0x1 },
6679 	{ "cachefiles_io_error", 0x1 },
6680 	/* ext4, from ext4__mballoc event class */
6681 	{ "ext4_mballoc_discard", 0x10 },
6682 	{ "ext4_mballoc_free", 0x10 },
6683 	/* fib */
6684 	{ "fib_table_lookup", 0x100 },
6685 	/* filelock */
6686 	/* ... from filelock_lock event class */
6687 	{ "posix_lock_inode", 0x10 },
6688 	{ "fcntl_setlk", 0x10 },
6689 	{ "locks_remove_posix", 0x10 },
6690 	{ "flock_lock_inode", 0x10 },
6691 	/* ... from filelock_lease event class */
6692 	{ "break_lease_noblock", 0x10 },
6693 	{ "break_lease_block", 0x10 },
6694 	{ "break_lease_unblock", 0x10 },
6695 	{ "generic_delete_lease", 0x10 },
6696 	{ "time_out_leases", 0x10 },
6697 	/* host1x */
6698 	{ "host1x_cdma_push_gather", 0x10000 },
6699 	/* huge_memory */
6700 	{ "mm_khugepaged_scan_pmd", 0x10 },
6701 	{ "mm_collapse_huge_page_isolate", 0x1 },
6702 	{ "mm_khugepaged_scan_file", 0x10 },
6703 	{ "mm_khugepaged_collapse_file", 0x10 },
6704 	/* kmem */
6705 	{ "mm_page_alloc", 0x1 },
6706 	{ "mm_page_pcpu_drain", 0x1 },
6707 	/* .. from mm_page event class */
6708 	{ "mm_page_alloc_zone_locked", 0x1 },
6709 	/* netfs */
6710 	{ "netfs_failure", 0x10 },
6711 	/* power */
6712 	{ "device_pm_callback_start", 0x10 },
6713 	/* qdisc */
6714 	{ "qdisc_dequeue", 0x1000 },
6715 	/* rxrpc */
6716 	{ "rxrpc_recvdata", 0x1 },
6717 	{ "rxrpc_resend", 0x10 },
6718 	{ "rxrpc_tq", 0x10 },
6719 	{ "rxrpc_client", 0x1 },
6720 	/* skb */
6721 	{"kfree_skb", 0x1000},
6722 	/* sunrpc */
6723 	{ "xs_stream_read_data", 0x1 },
6724 	/* ... from xprt_cong_event event class */
6725 	{ "xprt_reserve_cong", 0x10 },
6726 	{ "xprt_release_cong", 0x10 },
6727 	{ "xprt_get_cong", 0x10 },
6728 	{ "xprt_put_cong", 0x10 },
6729 	/* tcp */
6730 	{ "tcp_send_reset", 0x11 },
6731 	{ "tcp_sendmsg_locked", 0x100 },
6732 	/* tegra_apb_dma */
6733 	{ "tegra_dma_tx_status", 0x100 },
6734 	/* timer_migration */
6735 	{ "tmigr_update_events", 0x1 },
6736 	/* writeback, from writeback_folio_template event class */
6737 	{ "writeback_dirty_folio", 0x10 },
6738 	{ "folio_wait_writeback", 0x10 },
6739 	/* rdma */
6740 	{ "mr_integ_alloc", 0x2000 },
6741 	/* bpf_testmod */
6742 	{ "bpf_testmod_test_read", 0x0 },
6743 	/* amdgpu */
6744 	{ "amdgpu_vm_bo_map", 0x1 },
6745 	{ "amdgpu_vm_bo_unmap", 0x1 },
6746 	/* netfs */
6747 	{ "netfs_folioq", 0x1 },
6748 	/* xfs from xfs_defer_pending_class */
6749 	{ "xfs_defer_create_intent", 0x1 },
6750 	{ "xfs_defer_cancel_list", 0x1 },
6751 	{ "xfs_defer_pending_finish", 0x1 },
6752 	{ "xfs_defer_pending_abort", 0x1 },
6753 	{ "xfs_defer_relog_intent", 0x1 },
6754 	{ "xfs_defer_isolate_paused", 0x1 },
6755 	{ "xfs_defer_item_pause", 0x1 },
6756 	{ "xfs_defer_item_unpause", 0x1 },
6757 	/* xfs from xfs_defer_pending_item_class */
6758 	{ "xfs_defer_add_item", 0x1 },
6759 	{ "xfs_defer_cancel_item", 0x1 },
6760 	{ "xfs_defer_finish_item", 0x1 },
6761 	/* xfs from xfs_icwalk_class */
6762 	{ "xfs_ioc_free_eofblocks", 0x10 },
6763 	{ "xfs_blockgc_free_space", 0x10 },
6764 	/* xfs from xfs_btree_cur_class */
6765 	{ "xfs_btree_updkeys", 0x100 },
6766 	{ "xfs_btree_overlapped_query_range", 0x100 },
6767 	/* xfs from xfs_imap_class*/
6768 	{ "xfs_map_blocks_found", 0x10000 },
6769 	{ "xfs_map_blocks_alloc", 0x10000 },
6770 	{ "xfs_iomap_alloc", 0x1000 },
6771 	{ "xfs_iomap_found", 0x1000 },
6772 	/* xfs from xfs_fs_class */
6773 	{ "xfs_inodegc_flush", 0x1 },
6774 	{ "xfs_inodegc_push", 0x1 },
6775 	{ "xfs_inodegc_start", 0x1 },
6776 	{ "xfs_inodegc_stop", 0x1 },
6777 	{ "xfs_inodegc_queue", 0x1 },
6778 	{ "xfs_inodegc_throttle", 0x1 },
6779 	{ "xfs_fs_sync_fs", 0x1 },
6780 	{ "xfs_blockgc_start", 0x1 },
6781 	{ "xfs_blockgc_stop", 0x1 },
6782 	{ "xfs_blockgc_worker", 0x1 },
6783 	{ "xfs_blockgc_flush_all", 0x1 },
6784 	/* xfs_scrub */
6785 	{ "xchk_nlinks_live_update", 0x10 },
6786 	/* xfs_scrub from xchk_metapath_class */
6787 	{ "xchk_metapath_lookup", 0x100 },
6788 	/* nfsd */
6789 	{ "nfsd_dirent", 0x1 },
6790 	{ "nfsd_file_acquire", 0x1001 },
6791 	{ "nfsd_file_insert_err", 0x1 },
6792 	{ "nfsd_file_cons_err", 0x1 },
6793 	/* nfs4 */
6794 	{ "nfs4_setup_sequence", 0x1 },
6795 	{ "pnfs_update_layout", 0x10000 },
6796 	{ "nfs4_inode_callback_event", 0x200 },
6797 	{ "nfs4_inode_stateid_callback_event", 0x200 },
6798 	/* nfs from pnfs_layout_event */
6799 	{ "pnfs_mds_fallback_pg_init_read", 0x10000 },
6800 	{ "pnfs_mds_fallback_pg_init_write", 0x10000 },
6801 	{ "pnfs_mds_fallback_pg_get_mirror_count", 0x10000 },
6802 	{ "pnfs_mds_fallback_read_done", 0x10000 },
6803 	{ "pnfs_mds_fallback_write_done", 0x10000 },
6804 	{ "pnfs_mds_fallback_read_pagelist", 0x10000 },
6805 	{ "pnfs_mds_fallback_write_pagelist", 0x10000 },
6806 	/* coda */
6807 	{ "coda_dec_pic_run", 0x10 },
6808 	{ "coda_dec_pic_done", 0x10 },
6809 	/* cfg80211 */
6810 	{ "cfg80211_scan_done", 0x11 },
6811 	{ "rdev_set_coalesce", 0x10 },
6812 	{ "cfg80211_report_wowlan_wakeup", 0x100 },
6813 	{ "cfg80211_inform_bss_frame", 0x100 },
6814 	{ "cfg80211_michael_mic_failure", 0x10000 },
6815 	/* cfg80211 from wiphy_work_event */
6816 	{ "wiphy_work_queue", 0x10 },
6817 	{ "wiphy_work_run", 0x10 },
6818 	{ "wiphy_work_cancel", 0x10 },
6819 	{ "wiphy_work_flush", 0x10 },
6820 	/* hugetlbfs */
6821 	{ "hugetlbfs_alloc_inode", 0x10 },
6822 	/* spufs */
6823 	{ "spufs_context", 0x10 },
6824 	/* kvm_hv */
6825 	{ "kvm_page_fault_enter", 0x100 },
6826 	/* dpu */
6827 	{ "dpu_crtc_setup_mixer", 0x100 },
6828 	/* binder */
6829 	{ "binder_transaction", 0x100 },
6830 	/* bcachefs */
6831 	{ "btree_path_free", 0x100 },
6832 	/* hfi1_tx */
6833 	{ "hfi1_sdma_progress", 0x1000 },
6834 	/* iptfs */
6835 	{ "iptfs_ingress_postq_event", 0x1000 },
6836 	/* neigh */
6837 	{ "neigh_update", 0x10 },
6838 	/* snd_firewire_lib */
6839 	{ "amdtp_packet", 0x100 },
6840 };
6841 
btf_ctx_access(int off,int size,enum bpf_access_type type,const struct bpf_prog * prog,struct bpf_insn_access_aux * info)6842 bool btf_ctx_access(int off, int size, enum bpf_access_type type,
6843 		    const struct bpf_prog *prog,
6844 		    struct bpf_insn_access_aux *info)
6845 {
6846 	static const struct btf_type_tag_match ctx_type_tags[] = {
6847 		{ "user", MEM_USER },
6848 		{ "percpu", MEM_PERCPU },
6849 	};
6850 	const struct btf_type *t = prog->aux->attach_func_proto;
6851 	struct bpf_prog *tgt_prog = prog->aux->dst_prog;
6852 	struct btf *btf = bpf_prog_get_target_btf(prog);
6853 	const char *tname = prog->aux->attach_func_name;
6854 	struct bpf_verifier_log *log = info->log;
6855 	struct btf_type_tag_walk_ctx ctx;
6856 	const struct btf_param *args;
6857 	bool ptr_err_raw_tp = false;
6858 	u32 nr_args, arg;
6859 	int i, ret;
6860 
6861 	if (off % 8) {
6862 		bpf_log(log, "func '%s' offset %d is not multiple of 8\n",
6863 			tname, off);
6864 		return false;
6865 	}
6866 	arg = btf_ctx_arg_idx(btf, t, off);
6867 	args = (const struct btf_param *)(t + 1);
6868 	/* if (t == NULL) Fall back to default BPF prog with
6869 	 * MAX_BPF_FUNC_REG_ARGS u64 arguments.
6870 	 */
6871 	nr_args = t ? btf_type_vlen(t) : MAX_BPF_FUNC_REG_ARGS;
6872 	if (prog->aux->attach_btf_trace) {
6873 		/* skip first 'void *__data' argument in btf_trace_##name typedef */
6874 		args++;
6875 		nr_args--;
6876 	}
6877 
6878 	if (arg > nr_args) {
6879 		bpf_log(log, "func '%s' doesn't have %d-th argument\n",
6880 			tname, arg + 1);
6881 		return false;
6882 	}
6883 
6884 	if (arg == nr_args) {
6885 		switch (prog->expected_attach_type) {
6886 		case BPF_LSM_MAC:
6887 			/* mark we are accessing the return value */
6888 			info->is_retval = true;
6889 			fallthrough;
6890 		case BPF_LSM_CGROUP:
6891 		case BPF_TRACE_FEXIT:
6892 		case BPF_TRACE_FSESSION:
6893 			/* When LSM programs are attached to void LSM hooks
6894 			 * they use FEXIT trampolines and when attached to
6895 			 * int LSM hooks, they use MODIFY_RETURN trampolines.
6896 			 *
6897 			 * While the LSM programs are BPF_MODIFY_RETURN-like
6898 			 * the check:
6899 			 *
6900 			 *	if (ret_type != 'int')
6901 			 *		return -EINVAL;
6902 			 *
6903 			 * is _not_ done here. This is still safe as LSM hooks
6904 			 * have only void and int return types.
6905 			 */
6906 			if (!t)
6907 				return true;
6908 			t = btf_type_by_id(btf, t->type);
6909 			break;
6910 		case BPF_MODIFY_RETURN:
6911 			/* For now the BPF_MODIFY_RETURN can only be attached to
6912 			 * functions that return an int.
6913 			 */
6914 			if (!t)
6915 				return false;
6916 
6917 			t = btf_type_skip_modifiers(btf, t->type, NULL);
6918 			if (!btf_type_is_small_int(t)) {
6919 				bpf_log(log,
6920 					"ret type %s not allowed for fmod_ret\n",
6921 					btf_type_str(t));
6922 				return false;
6923 			}
6924 			break;
6925 		default:
6926 			bpf_log(log, "func '%s' doesn't have %d-th argument\n",
6927 				tname, arg + 1);
6928 			return false;
6929 		}
6930 	} else {
6931 		if (!t)
6932 			/* Default prog with MAX_BPF_FUNC_REG_ARGS args */
6933 			return true;
6934 		t = btf_type_by_id(btf, args[arg].type);
6935 	}
6936 
6937 	/* skip modifiers */
6938 	while (btf_type_is_modifier(t))
6939 		t = btf_type_by_id(btf, t->type);
6940 	if (btf_type_is_small_int(t) || btf_is_any_enum(t) || btf_type_is_struct(t))
6941 		/* accessing a scalar */
6942 		return true;
6943 	if (!btf_type_is_ptr(t)) {
6944 		bpf_log(log,
6945 			"func '%s' arg%d '%s' has type %s. Only pointer access is allowed\n",
6946 			tname, arg,
6947 			__btf_name_by_offset(btf, t->name_off),
6948 			btf_type_str(t));
6949 		return false;
6950 	}
6951 
6952 	if (size != sizeof(u64)) {
6953 		bpf_log(log, "func '%s' size %d must be 8\n",
6954 			tname, size);
6955 		return false;
6956 	}
6957 
6958 	/*
6959 	 * Check for PTR_TO_RDONLY_BUF_OR_NULL, PTR_TO_RDWR_BUF_OR_NULL or
6960 	 * PTR_TO_ARENA (both nullable and non-nullable cases).
6961 	 */
6962 	for (i = 0; i < prog->aux->ctx_arg_info_size; i++) {
6963 		const struct bpf_ctx_arg_aux *ctx_arg_info = &prog->aux->ctx_arg_info[i];
6964 		u32 type, flag;
6965 
6966 		type = base_type(ctx_arg_info->reg_type);
6967 		flag = type_flag(ctx_arg_info->reg_type);
6968 		if (ctx_arg_info->offset == off &&
6969 		    (type == PTR_TO_ARENA ||
6970 		     (type == PTR_TO_BUF && (flag & PTR_MAYBE_NULL)))) {
6971 			info->reg_type = ctx_arg_info->reg_type;
6972 			return true;
6973 		}
6974 	}
6975 
6976 	/*
6977 	 * If it's a single or multilevel pointer, except a pointer
6978 	 * to a structure, it's the same as scalar from the verifier
6979 	 * safety POV. Multilevel pointers to structures are treated as
6980 	 * scalars. The verifier lacks the context to infer the size of
6981 	 * their target memory regions. Either way, no further pointer
6982 	 * walking is allowed.
6983 	 */
6984 	if (!btf_type_is_struct_ptr(btf, t))
6985 		return true;
6986 
6987 	/* this is a pointer to another type */
6988 	for (i = 0; i < prog->aux->ctx_arg_info_size; i++) {
6989 		const struct bpf_ctx_arg_aux *ctx_arg_info = &prog->aux->ctx_arg_info[i];
6990 
6991 		if (ctx_arg_info->offset == off) {
6992 			if (!ctx_arg_info->btf_id) {
6993 				bpf_log(log,"invalid btf_id for context argument offset %u\n", off);
6994 				return false;
6995 			}
6996 
6997 			info->reg_type = ctx_arg_info->reg_type;
6998 			info->btf = ctx_arg_info->btf ? : btf_vmlinux;
6999 			info->btf_id = ctx_arg_info->btf_id;
7000 			info->ref_id = ctx_arg_info->ref_id;
7001 			return true;
7002 		}
7003 	}
7004 
7005 	info->reg_type = PTR_TO_BTF_ID;
7006 	if (prog_args_trusted(prog))
7007 		info->reg_type |= PTR_TRUSTED;
7008 
7009 	if (btf_param_match_suffix(btf, &args[arg], "__nullable"))
7010 		info->reg_type |= PTR_MAYBE_NULL;
7011 
7012 	if (prog->expected_attach_type == BPF_TRACE_RAW_TP) {
7013 		struct btf *btf = prog->aux->attach_btf;
7014 		const struct btf_type *t;
7015 		const char *tname;
7016 
7017 		/* BTF lookups cannot fail, return false on error */
7018 		t = btf_type_by_id(btf, prog->aux->attach_btf_id);
7019 		if (!t)
7020 			return false;
7021 		tname = btf_name_by_offset(btf, t->name_off);
7022 		if (!tname)
7023 			return false;
7024 		/* Checked by bpf_check_attach_target */
7025 		tname += sizeof("btf_trace_") - 1;
7026 		for (i = 0; i < ARRAY_SIZE(raw_tp_null_args); i++) {
7027 			/* Is this a func with potential NULL args? */
7028 			if (strcmp(tname, raw_tp_null_args[i].func))
7029 				continue;
7030 			if (raw_tp_null_args[i].mask & (0x1ULL << (arg * 4)))
7031 				info->reg_type |= PTR_MAYBE_NULL;
7032 			/* Is the current arg IS_ERR? */
7033 			if (raw_tp_null_args[i].mask & (0x2ULL << (arg * 4)))
7034 				ptr_err_raw_tp = true;
7035 			break;
7036 		}
7037 		/* If we don't know NULL-ness specification and the tracepoint
7038 		 * is coming from a loadable module, be conservative and mark
7039 		 * argument as PTR_MAYBE_NULL.
7040 		 */
7041 		if (i == ARRAY_SIZE(raw_tp_null_args) && btf_is_module(btf))
7042 			info->reg_type |= PTR_MAYBE_NULL;
7043 	}
7044 
7045 	if (tgt_prog) {
7046 		enum bpf_prog_type tgt_type;
7047 
7048 		if (tgt_prog->type == BPF_PROG_TYPE_EXT)
7049 			tgt_type = tgt_prog->aux->saved_dst_prog_type;
7050 		else
7051 			tgt_type = tgt_prog->type;
7052 
7053 		ret = btf_translate_to_vmlinux(log, btf, t, tgt_type, arg);
7054 		if (ret > 0) {
7055 			info->btf = btf_vmlinux;
7056 			info->btf_id = ret;
7057 			return true;
7058 		} else {
7059 			return false;
7060 		}
7061 	}
7062 
7063 	info->btf = btf;
7064 	ctx.t = t;
7065 	ret = btf_type_tag_walk(btf, &ctx, ctx_type_tags,
7066 				ARRAY_SIZE(ctx_type_tags));
7067 	if (ret) {
7068 		bpf_log(log, "func '%s' arg%d type %s has multiple type tags\n",
7069 			tname, arg, btf_type_str(t));
7070 		return false;
7071 	}
7072 	info->reg_type |= ctx.res;
7073 	info->btf_id = ctx.id;
7074 	t = ctx.t;
7075 
7076 	if (!btf_type_is_struct(t)) {
7077 		bpf_log(log,
7078 			"func '%s' arg%d type %s is not a struct\n",
7079 			tname, arg, btf_type_str(t));
7080 		return false;
7081 	}
7082 	bpf_log(log, "func '%s' arg%d has btf_id %d type %s '%s'\n",
7083 		tname, arg, info->btf_id, btf_type_str(t),
7084 		__btf_name_by_offset(btf, t->name_off));
7085 
7086 	/* Perform all checks on the validity of type for this argument, but if
7087 	 * we know it can be IS_ERR at runtime, scrub pointer type and mark as
7088 	 * scalar.
7089 	 */
7090 	if (ptr_err_raw_tp) {
7091 		bpf_log(log, "marking pointer arg%d as scalar as it may encode error", arg);
7092 		info->reg_type = SCALAR_VALUE;
7093 	}
7094 	return true;
7095 }
7096 EXPORT_SYMBOL_GPL(btf_ctx_access);
7097 
7098 enum bpf_struct_walk_result {
7099 	/* < 0 error */
7100 	WALK_SCALAR = 0,
7101 	WALK_PTR,
7102 	WALK_PTR_UNTRUSTED,
7103 	WALK_STRUCT,
7104 };
7105 
btf_struct_walk(struct bpf_verifier_log * log,const struct btf * btf,const struct btf_type * t,int off,int size,u32 * next_btf_id,enum bpf_type_flag * flag,const char ** field_name,bool walk_flex_arrays)7106 static int btf_struct_walk(struct bpf_verifier_log *log, const struct btf *btf,
7107 			   const struct btf_type *t, int off, int size,
7108 			   u32 *next_btf_id, enum bpf_type_flag *flag,
7109 			   const char **field_name, bool walk_flex_arrays)
7110 {
7111 	u32 i, moff, mtrue_end, msize = 0, total_nelems = 0;
7112 	const struct btf_type *mtype, *elem_type = NULL;
7113 	const struct btf_member *member;
7114 	const char *tname, *mname;
7115 	u32 vlen, elem_id, mid;
7116 
7117 again:
7118 	if (btf_type_is_modifier(t))
7119 		t = btf_type_skip_modifiers(btf, t->type, NULL);
7120 	tname = __btf_name_by_offset(btf, t->name_off);
7121 	if (!btf_type_is_struct(t)) {
7122 		bpf_log(log, "Type '%s' is not a struct\n", tname);
7123 		return -EINVAL;
7124 	}
7125 
7126 	vlen = btf_type_vlen(t);
7127 	if (BTF_INFO_KIND(t->info) == BTF_KIND_UNION && vlen != 1 && !(*flag & PTR_UNTRUSTED))
7128 		/*
7129 		 * walking unions yields untrusted pointers
7130 		 * with exception of __bpf_md_ptr and other
7131 		 * unions with a single member
7132 		 */
7133 		*flag |= PTR_UNTRUSTED;
7134 
7135 	if (off + size > t->size) {
7136 		struct btf_array *array_elem;
7137 
7138 		if (!walk_flex_arrays)
7139 			goto error;
7140 
7141 		/* If the last element is a variable size array, we may
7142 		 * need to relax the rule.
7143 		 */
7144 		if (vlen == 0)
7145 			goto error;
7146 
7147 		member = btf_type_member(t) + vlen - 1;
7148 		mtype = btf_type_skip_modifiers(btf, member->type,
7149 						NULL);
7150 		if (!btf_type_is_array(mtype))
7151 			goto error;
7152 
7153 		array_elem = (struct btf_array *)(mtype + 1);
7154 		if (array_elem->nelems != 0)
7155 			goto error;
7156 
7157 		moff = __btf_member_bit_offset(t, member) / 8;
7158 		if (off < moff)
7159 			goto error;
7160 
7161 		/* allow structure and integer */
7162 		t = btf_type_skip_modifiers(btf, array_elem->type,
7163 					    NULL);
7164 
7165 		if (btf_type_is_int(t))
7166 			return WALK_SCALAR;
7167 
7168 		if (!btf_type_is_struct(t))
7169 			goto error;
7170 
7171 		off = (off - moff) % t->size;
7172 		goto again;
7173 
7174 error:
7175 		bpf_log(log, "access beyond struct %s at off %u size %u\n",
7176 			tname, off, size);
7177 		return -EACCES;
7178 	}
7179 
7180 	for_each_member(i, t, member) {
7181 		/* offset of the field in bytes */
7182 		moff = __btf_member_bit_offset(t, member) / 8;
7183 		if (off + size <= moff)
7184 			/* won't find anything, field is already too far */
7185 			break;
7186 
7187 		if (__btf_member_bitfield_size(t, member)) {
7188 			u32 end_bit = __btf_member_bit_offset(t, member) +
7189 				__btf_member_bitfield_size(t, member);
7190 
7191 			/* off <= moff instead of off == moff because clang
7192 			 * does not generate a BTF member for anonymous
7193 			 * bitfield like the ":16" here:
7194 			 * struct {
7195 			 *	int :16;
7196 			 *	int x:8;
7197 			 * };
7198 			 */
7199 			if (off <= moff &&
7200 			    BITS_ROUNDUP_BYTES(end_bit) <= off + size)
7201 				return WALK_SCALAR;
7202 
7203 			/* off may be accessing a following member
7204 			 *
7205 			 * or
7206 			 *
7207 			 * Doing partial access at either end of this
7208 			 * bitfield.  Continue on this case also to
7209 			 * treat it as not accessing this bitfield
7210 			 * and eventually error out as field not
7211 			 * found to keep it simple.
7212 			 * It could be relaxed if there was a legit
7213 			 * partial access case later.
7214 			 */
7215 			continue;
7216 		}
7217 
7218 		/* In case of "off" is pointing to holes of a struct */
7219 		if (off < moff)
7220 			break;
7221 
7222 		/* type of the field */
7223 		mid = member->type;
7224 		mtype = btf_type_by_id(btf, member->type);
7225 		mname = __btf_name_by_offset(btf, member->name_off);
7226 
7227 		mtype = __btf_resolve_size(btf, mtype, &msize,
7228 					   &elem_type, &elem_id, &total_nelems,
7229 					   &mid);
7230 		if (IS_ERR(mtype)) {
7231 			bpf_log(log, "field %s doesn't have size\n", mname);
7232 			return -EFAULT;
7233 		}
7234 
7235 		mtrue_end = moff + msize;
7236 		if (off >= mtrue_end)
7237 			/* no overlap with member, keep iterating */
7238 			continue;
7239 
7240 		if (btf_type_is_array(mtype)) {
7241 			u32 elem_idx;
7242 
7243 			/* __btf_resolve_size() above helps to
7244 			 * linearize a multi-dimensional array.
7245 			 *
7246 			 * The logic here is treating an array
7247 			 * in a struct as the following way:
7248 			 *
7249 			 * struct outer {
7250 			 *	struct inner array[2][2];
7251 			 * };
7252 			 *
7253 			 * looks like:
7254 			 *
7255 			 * struct outer {
7256 			 *	struct inner array_elem0;
7257 			 *	struct inner array_elem1;
7258 			 *	struct inner array_elem2;
7259 			 *	struct inner array_elem3;
7260 			 * };
7261 			 *
7262 			 * When accessing outer->array[1][0], it moves
7263 			 * moff to "array_elem2", set mtype to
7264 			 * "struct inner", and msize also becomes
7265 			 * sizeof(struct inner).  Then most of the
7266 			 * remaining logic will fall through without
7267 			 * caring the current member is an array or
7268 			 * not.
7269 			 *
7270 			 * Unlike mtype/msize/moff, mtrue_end does not
7271 			 * change.  The naming difference ("_true") tells
7272 			 * that it is not always corresponding to
7273 			 * the current mtype/msize/moff.
7274 			 * It is the true end of the current
7275 			 * member (i.e. array in this case).  That
7276 			 * will allow an int array to be accessed like
7277 			 * a scratch space,
7278 			 * i.e. allow access beyond the size of
7279 			 *      the array's element as long as it is
7280 			 *      within the mtrue_end boundary.
7281 			 */
7282 
7283 			/* skip empty array */
7284 			if (moff == mtrue_end)
7285 				continue;
7286 
7287 			msize /= total_nelems;
7288 			elem_idx = (off - moff) / msize;
7289 			moff += elem_idx * msize;
7290 			mtype = elem_type;
7291 			mid = elem_id;
7292 		}
7293 
7294 		/* the 'off' we're looking for is either equal to start
7295 		 * of this field or inside of this struct
7296 		 */
7297 		if (btf_type_is_struct(mtype)) {
7298 			/* our field must be inside that union or struct */
7299 			t = mtype;
7300 
7301 			/* return if the offset matches the member offset */
7302 			if (off == moff) {
7303 				*next_btf_id = mid;
7304 				return WALK_STRUCT;
7305 			}
7306 
7307 			/* adjust offset we're looking for */
7308 			off -= moff;
7309 			goto again;
7310 		}
7311 
7312 		if (btf_type_is_ptr(mtype)) {
7313 			static const struct btf_type_tag_match walk_type_tags[] = {
7314 				{ "user", MEM_USER },
7315 				{ "percpu", MEM_PERCPU },
7316 				{ "rcu", MEM_RCU },
7317 			};
7318 			enum bpf_type_flag tmp_flag = 0;
7319 			struct btf_type_tag_walk_ctx ctx = { .t = mtype };
7320 			const struct btf_type *stype;
7321 			int err;
7322 			u32 id;
7323 
7324 			if (msize != size || off != moff) {
7325 				bpf_log(log,
7326 					"cannot access ptr member %s with moff %u in struct %s with off %u size %u\n",
7327 					mname, moff, tname, off, size);
7328 				return -EACCES;
7329 			}
7330 
7331 			err = btf_type_tag_walk(btf, &ctx, walk_type_tags,
7332 						ARRAY_SIZE(walk_type_tags));
7333 			if (err) {
7334 				bpf_log(log, "type '%s' has multiple type tags\n",
7335 					btf_type_str(mtype));
7336 				return err;
7337 			}
7338 			tmp_flag = ctx.res;
7339 			id = ctx.id;
7340 			stype = ctx.t;
7341 
7342 			if (btf_type_is_struct(stype)) {
7343 				*next_btf_id = id;
7344 				*flag |= tmp_flag;
7345 				if (field_name)
7346 					*field_name = mname;
7347 				return WALK_PTR;
7348 			}
7349 
7350 			return WALK_PTR_UNTRUSTED;
7351 		}
7352 
7353 		/* Allow more flexible access within an int as long as
7354 		 * it is within mtrue_end.
7355 		 * Since mtrue_end could be the end of an array,
7356 		 * that also allows using an array of int as a scratch
7357 		 * space. e.g. skb->cb[].
7358 		 */
7359 		if (off + size > mtrue_end && !(*flag & PTR_UNTRUSTED)) {
7360 			bpf_log(log,
7361 				"access beyond the end of member %s (mend:%u) in struct %s with off %u size %u\n",
7362 				mname, mtrue_end, tname, off, size);
7363 			return -EACCES;
7364 		}
7365 
7366 		return WALK_SCALAR;
7367 	}
7368 	bpf_log(log, "struct %s doesn't have field at offset %d\n", tname, off);
7369 	return -EINVAL;
7370 }
7371 
btf_struct_access(struct bpf_verifier_log * log,const struct bpf_reg_state * reg,int off,int size,enum bpf_access_type atype __maybe_unused,u32 * next_btf_id,enum bpf_type_flag * flag,const char ** field_name)7372 int btf_struct_access(struct bpf_verifier_log *log,
7373 		      const struct bpf_reg_state *reg,
7374 		      int off, int size, enum bpf_access_type atype __maybe_unused,
7375 		      u32 *next_btf_id, enum bpf_type_flag *flag,
7376 		      const char **field_name)
7377 {
7378 	const struct btf *btf = reg->btf;
7379 	enum bpf_type_flag tmp_flag = 0;
7380 	const struct btf_type *t;
7381 	u32 id = reg->btf_id;
7382 	int err;
7383 
7384 	while (type_is_alloc(reg->type)) {
7385 		struct btf_struct_meta *meta;
7386 		struct btf_record *rec;
7387 		int i;
7388 
7389 		meta = btf_find_struct_meta(btf, id);
7390 		if (!meta)
7391 			break;
7392 		rec = meta->record;
7393 		for (i = 0; i < rec->cnt; i++) {
7394 			struct btf_field *field = &rec->fields[i];
7395 			u32 offset = field->offset;
7396 			if (off < offset + field->size && offset < off + size) {
7397 				bpf_log(log,
7398 					"direct access to %s is disallowed\n",
7399 					btf_field_type_name(field->type));
7400 				return -EACCES;
7401 			}
7402 		}
7403 		break;
7404 	}
7405 
7406 	t = btf_type_by_id(btf, id);
7407 	do {
7408 		err = btf_struct_walk(log, btf, t, off, size, &id, &tmp_flag,
7409 				      field_name, !type_is_alloc(reg->type));
7410 
7411 		switch (err) {
7412 		case WALK_PTR:
7413 			/* For local types, the destination register cannot
7414 			 * become a pointer again.
7415 			 */
7416 			if (type_is_alloc(reg->type))
7417 				return SCALAR_VALUE;
7418 			/* If we found the pointer or scalar on t+off,
7419 			 * we're done.
7420 			 */
7421 			*next_btf_id = id;
7422 			*flag = tmp_flag;
7423 			return PTR_TO_BTF_ID;
7424 		case WALK_PTR_UNTRUSTED:
7425 			*flag = MEM_RDONLY | PTR_UNTRUSTED;
7426 			return PTR_TO_MEM;
7427 		case WALK_SCALAR:
7428 			return SCALAR_VALUE;
7429 		case WALK_STRUCT:
7430 			/* We found nested struct, so continue the search
7431 			 * by diving in it. At this point the offset is
7432 			 * aligned with the new type, so set it to 0.
7433 			 */
7434 			t = btf_type_by_id(btf, id);
7435 			off = 0;
7436 			break;
7437 		default:
7438 			/* It's either error or unknown return value..
7439 			 * scream and leave.
7440 			 */
7441 			if (WARN_ONCE(err > 0, "unknown btf_struct_walk return value"))
7442 				return -EINVAL;
7443 			return err;
7444 		}
7445 	} while (t);
7446 
7447 	return -EINVAL;
7448 }
7449 
7450 /* Check that two BTF types, each specified as an BTF object + id, are exactly
7451  * the same. Trivial ID check is not enough due to module BTFs, because we can
7452  * end up with two different module BTFs, but IDs point to the common type in
7453  * vmlinux BTF.
7454  */
btf_types_are_same(const struct btf * btf1,u32 id1,const struct btf * btf2,u32 id2)7455 bool btf_types_are_same(const struct btf *btf1, u32 id1,
7456 			const struct btf *btf2, u32 id2)
7457 {
7458 	if (id1 != id2)
7459 		return false;
7460 	if (btf1 == btf2)
7461 		return true;
7462 	return btf_type_by_id(btf1, id1) == btf_type_by_id(btf2, id2);
7463 }
7464 
btf_struct_ids_match(struct bpf_verifier_log * log,const struct btf * btf,u32 id,int off,const struct btf * need_btf,u32 need_type_id,bool strict,bool walk_flex_arrays)7465 bool btf_struct_ids_match(struct bpf_verifier_log *log,
7466 			  const struct btf *btf, u32 id, int off,
7467 			  const struct btf *need_btf, u32 need_type_id,
7468 			  bool strict, bool walk_flex_arrays)
7469 {
7470 	const struct btf_type *type;
7471 	enum bpf_type_flag flag = 0;
7472 	int err;
7473 
7474 	/* Are we already done? */
7475 	if (off == 0 && btf_types_are_same(btf, id, need_btf, need_type_id))
7476 		return true;
7477 	/* In case of strict type match, we do not walk struct, the top level
7478 	 * type match must succeed. When strict is true, off should have already
7479 	 * been 0.
7480 	 */
7481 	if (strict)
7482 		return false;
7483 again:
7484 	type = btf_type_by_id(btf, id);
7485 	if (!type)
7486 		return false;
7487 	err = btf_struct_walk(log, btf, type, off, 1, &id, &flag, NULL,
7488 			      walk_flex_arrays);
7489 	if (err != WALK_STRUCT)
7490 		return false;
7491 
7492 	/* We found nested struct object. If it matches
7493 	 * the requested ID, we're done. Otherwise let's
7494 	 * continue the search with offset 0 in the new
7495 	 * type.
7496 	 */
7497 	if (!btf_types_are_same(btf, id, need_btf, need_type_id)) {
7498 		off = 0;
7499 		goto again;
7500 	}
7501 
7502 	return true;
7503 }
7504 
__get_type_size(struct btf * btf,u32 btf_id,const struct btf_type ** ret_type)7505 static int __get_type_size(struct btf *btf, u32 btf_id,
7506 			   const struct btf_type **ret_type)
7507 {
7508 	const struct btf_type *t;
7509 
7510 	*ret_type = btf_type_by_id(btf, 0);
7511 	if (!btf_id)
7512 		/* void */
7513 		return 0;
7514 	t = btf_type_by_id(btf, btf_id);
7515 	while (t && btf_type_is_modifier(t))
7516 		t = btf_type_by_id(btf, t->type);
7517 	if (!t)
7518 		return -EINVAL;
7519 	*ret_type = t;
7520 	if (btf_type_is_ptr(t))
7521 		/* kernel size of pointer. Not BPF's size of pointer*/
7522 		return sizeof(void *);
7523 	if (btf_type_is_int(t) || btf_is_any_enum(t) || btf_type_is_struct(t))
7524 		return t->size;
7525 	return -EINVAL;
7526 }
7527 
__get_type_fmodel_flags(const struct btf_type * t)7528 static u8 __get_type_fmodel_flags(const struct btf_type *t)
7529 {
7530 	u8 flags = 0;
7531 
7532 	if (btf_type_is_signed_int(t))
7533 		flags |= BTF_FMODEL_SIGNED_ARG;
7534 
7535 	return flags;
7536 }
7537 
__get_arg_fmodel_flags(const struct btf * btf,const struct btf_param * arg,const struct btf_type * t)7538 static u8 __get_arg_fmodel_flags(const struct btf *btf,
7539 				 const struct btf_param *arg,
7540 				 const struct btf_type *t)
7541 {
7542 	u8 flags = __get_type_fmodel_flags(t);
7543 
7544 	if (btf_param_match_suffix(btf, arg, "__arena__nullable"))
7545 		flags |= BTF_FMODEL_ARENA_ARG | BTF_FMODEL_NULLABLE_ARG;
7546 	else if (btf_param_match_suffix(btf, arg, "__arena"))
7547 		flags |= BTF_FMODEL_ARENA_ARG;
7548 	else if (btf_param_match_suffix(btf, arg, "__nullable"))
7549 		flags |= BTF_FMODEL_NULLABLE_ARG;
7550 
7551 	return flags;
7552 }
7553 
btf_distill_func_proto(struct bpf_verifier_log * log,struct btf * btf,const struct btf_type * func,const char * tname,struct btf_func_model * m)7554 int btf_distill_func_proto(struct bpf_verifier_log *log,
7555 			   struct btf *btf,
7556 			   const struct btf_type *func,
7557 			   const char *tname,
7558 			   struct btf_func_model *m)
7559 {
7560 	const struct btf_param *args;
7561 	const struct btf_type *t;
7562 	u32 i, nargs;
7563 	int ret;
7564 
7565 	if (!func) {
7566 		/* BTF function prototype doesn't match the verifier types.
7567 		 * Fall back to MAX_BPF_FUNC_REG_ARGS u64 args.
7568 		 */
7569 		for (i = 0; i < MAX_BPF_FUNC_REG_ARGS; i++) {
7570 			m->arg_size[i] = 8;
7571 			m->arg_flags[i] = 0;
7572 		}
7573 		m->ret_size = 8;
7574 		m->ret_flags = 0;
7575 		m->nr_args = MAX_BPF_FUNC_REG_ARGS;
7576 		return 0;
7577 	}
7578 	args = (const struct btf_param *)(func + 1);
7579 	nargs = btf_type_vlen(func);
7580 	if (nargs > MAX_BPF_FUNC_ARGS) {
7581 		bpf_log(log,
7582 			"The function %s has %d arguments. Too many.\n",
7583 			tname, nargs);
7584 		return -EINVAL;
7585 	}
7586 	ret = __get_type_size(btf, func->type, &t);
7587 	if (ret < 0 || btf_type_is_struct(t)) {
7588 		bpf_log(log,
7589 			"The function %s return type %s is unsupported.\n",
7590 			tname, btf_type_str(t));
7591 		return -EINVAL;
7592 	}
7593 	m->ret_size = ret;
7594 	m->ret_flags = __get_type_fmodel_flags(t);
7595 
7596 	for (i = 0; i < nargs; i++) {
7597 		if (i == nargs - 1 && args[i].type == 0) {
7598 			bpf_log(log,
7599 				"The function %s with variable args is unsupported.\n",
7600 				tname);
7601 			return -EINVAL;
7602 		}
7603 		ret = __get_type_size(btf, args[i].type, &t);
7604 
7605 		/* No support of struct argument size greater than 16 bytes */
7606 		if (ret < 0 || ret > 16) {
7607 			bpf_log(log,
7608 				"The function %s arg%d type %s is unsupported.\n",
7609 				tname, i, btf_type_str(t));
7610 			return -EINVAL;
7611 		}
7612 		if (ret == 0) {
7613 			bpf_log(log,
7614 				"The function %s has malformed void argument.\n",
7615 				tname);
7616 			return -EINVAL;
7617 		}
7618 		m->arg_size[i] = ret;
7619 		m->arg_flags[i] = __get_arg_fmodel_flags(btf, &args[i], t);
7620 	}
7621 	m->nr_args = nargs;
7622 	return 0;
7623 }
7624 
7625 /* Compare BTFs of two functions assuming only scalars and pointers to context.
7626  * t1 points to BTF_KIND_FUNC in btf1
7627  * t2 points to BTF_KIND_FUNC in btf2
7628  * Returns:
7629  * EINVAL - function prototype mismatch
7630  * EFAULT - verifier bug
7631  * 0 - 99% match. The last 1% is validated by the verifier.
7632  */
btf_check_func_type_match(struct bpf_verifier_log * log,struct btf * btf1,const struct btf_type * t1,struct btf * btf2,const struct btf_type * t2)7633 static int btf_check_func_type_match(struct bpf_verifier_log *log,
7634 				     struct btf *btf1, const struct btf_type *t1,
7635 				     struct btf *btf2, const struct btf_type *t2)
7636 {
7637 	const struct btf_param *args1, *args2;
7638 	const char *fn1, *fn2, *s1, *s2;
7639 	u32 nargs1, nargs2, i;
7640 
7641 	fn1 = btf_name_by_offset(btf1, t1->name_off);
7642 	fn2 = btf_name_by_offset(btf2, t2->name_off);
7643 
7644 	if (btf_func_linkage(t1) != BTF_FUNC_GLOBAL) {
7645 		bpf_log(log, "%s() is not a global function\n", fn1);
7646 		return -EINVAL;
7647 	}
7648 	if (btf_func_linkage(t2) != BTF_FUNC_GLOBAL) {
7649 		bpf_log(log, "%s() is not a global function\n", fn2);
7650 		return -EINVAL;
7651 	}
7652 
7653 	t1 = btf_type_by_id(btf1, t1->type);
7654 	if (!t1 || !btf_type_is_func_proto(t1))
7655 		return -EFAULT;
7656 	t2 = btf_type_by_id(btf2, t2->type);
7657 	if (!t2 || !btf_type_is_func_proto(t2))
7658 		return -EFAULT;
7659 
7660 	args1 = (const struct btf_param *)(t1 + 1);
7661 	nargs1 = btf_type_vlen(t1);
7662 	args2 = (const struct btf_param *)(t2 + 1);
7663 	nargs2 = btf_type_vlen(t2);
7664 
7665 	if (nargs1 != nargs2) {
7666 		bpf_log(log, "%s() has %d args while %s() has %d args\n",
7667 			fn1, nargs1, fn2, nargs2);
7668 		return -EINVAL;
7669 	}
7670 
7671 	t1 = btf_type_skip_modifiers(btf1, t1->type, NULL);
7672 	t2 = btf_type_skip_modifiers(btf2, t2->type, NULL);
7673 	if (t1->info != t2->info) {
7674 		bpf_log(log,
7675 			"Return type %s of %s() doesn't match type %s of %s()\n",
7676 			btf_type_str(t1), fn1,
7677 			btf_type_str(t2), fn2);
7678 		return -EINVAL;
7679 	}
7680 
7681 	for (i = 0; i < nargs1; i++) {
7682 		t1 = btf_type_skip_modifiers(btf1, args1[i].type, NULL);
7683 		t2 = btf_type_skip_modifiers(btf2, args2[i].type, NULL);
7684 
7685 		if (t1->info != t2->info) {
7686 			bpf_log(log, "arg%d in %s() is %s while %s() has %s\n",
7687 				i, fn1, btf_type_str(t1),
7688 				fn2, btf_type_str(t2));
7689 			return -EINVAL;
7690 		}
7691 		if (btf_type_has_size(t1) && t1->size != t2->size) {
7692 			bpf_log(log,
7693 				"arg%d in %s() has size %d while %s() has %d\n",
7694 				i, fn1, t1->size,
7695 				fn2, t2->size);
7696 			return -EINVAL;
7697 		}
7698 
7699 		/* global functions are validated with scalars and pointers
7700 		 * to context only. And only global functions can be replaced.
7701 		 * Hence type check only those types.
7702 		 */
7703 		if (btf_type_is_int(t1) || btf_is_any_enum(t1))
7704 			continue;
7705 		if (!btf_type_is_ptr(t1)) {
7706 			bpf_log(log,
7707 				"arg%d in %s() has unrecognized type\n",
7708 				i, fn1);
7709 			return -EINVAL;
7710 		}
7711 		t1 = btf_type_skip_modifiers(btf1, t1->type, NULL);
7712 		t2 = btf_type_skip_modifiers(btf2, t2->type, NULL);
7713 		if (!btf_type_is_struct(t1)) {
7714 			bpf_log(log,
7715 				"arg%d in %s() is not a pointer to context\n",
7716 				i, fn1);
7717 			return -EINVAL;
7718 		}
7719 		if (!btf_type_is_struct(t2)) {
7720 			bpf_log(log,
7721 				"arg%d in %s() is not a pointer to context\n",
7722 				i, fn2);
7723 			return -EINVAL;
7724 		}
7725 		/* This is an optional check to make program writing easier.
7726 		 * Compare names of structs and report an error to the user.
7727 		 * btf_prepare_func_args() already checked that t2 struct
7728 		 * is a context type. btf_prepare_func_args() will check
7729 		 * later that t1 struct is a context type as well.
7730 		 */
7731 		s1 = btf_name_by_offset(btf1, t1->name_off);
7732 		s2 = btf_name_by_offset(btf2, t2->name_off);
7733 		if (strcmp(s1, s2)) {
7734 			bpf_log(log,
7735 				"arg%d %s(struct %s *) doesn't match %s(struct %s *)\n",
7736 				i, fn1, s1, fn2, s2);
7737 			return -EINVAL;
7738 		}
7739 	}
7740 	return 0;
7741 }
7742 
7743 /* Compare BTFs of given program with BTF of target program */
btf_check_type_match(struct bpf_verifier_log * log,const struct bpf_prog * prog,struct btf * btf2,const struct btf_type * t2)7744 int btf_check_type_match(struct bpf_verifier_log *log, const struct bpf_prog *prog,
7745 			 struct btf *btf2, const struct btf_type *t2)
7746 {
7747 	struct btf *btf1 = prog->aux->btf;
7748 	const struct btf_type *t1;
7749 	u32 btf_id = 0;
7750 
7751 	if (!prog->aux->func_info) {
7752 		bpf_log(log, "Program extension requires BTF\n");
7753 		return -EINVAL;
7754 	}
7755 
7756 	btf_id = prog->aux->func_info[0].type_id;
7757 	if (!btf_id)
7758 		return -EFAULT;
7759 
7760 	t1 = btf_type_by_id(btf1, btf_id);
7761 	if (!t1 || !btf_type_is_func(t1))
7762 		return -EFAULT;
7763 
7764 	return btf_check_func_type_match(log, btf1, t1, btf2, t2);
7765 }
7766 
btf_is_dynptr_ptr(const struct btf * btf,const struct btf_type * t)7767 static bool btf_is_dynptr_ptr(const struct btf *btf, const struct btf_type *t)
7768 {
7769 	const char *name;
7770 
7771 	t = btf_type_by_id(btf, t->type); /* skip PTR */
7772 
7773 	while (btf_type_is_modifier(t))
7774 		t = btf_type_by_id(btf, t->type);
7775 
7776 	/* allow either struct or struct forward declaration */
7777 	if (btf_type_is_struct(t) ||
7778 	    (btf_type_is_fwd(t) && btf_type_kflag(t) == 0)) {
7779 		name = btf_str_by_offset(btf, t->name_off);
7780 		return name && strcmp(name, "bpf_dynptr") == 0;
7781 	}
7782 
7783 	return false;
7784 }
7785 
7786 struct bpf_cand_cache {
7787 	const char *name;
7788 	u32 name_len;
7789 	u16 kind;
7790 	u16 cnt;
7791 	struct {
7792 		const struct btf *btf;
7793 		u32 id;
7794 	} cands[];
7795 };
7796 
7797 static DEFINE_MUTEX(cand_cache_mutex);
7798 
7799 static struct bpf_cand_cache *
7800 bpf_core_find_cands(struct bpf_core_ctx *ctx, u32 local_type_id);
7801 
btf_get_ptr_to_btf_id(struct bpf_verifier_log * log,int arg_idx,const struct btf * btf,const struct btf_type * t)7802 static int btf_get_ptr_to_btf_id(struct bpf_verifier_log *log, int arg_idx,
7803 				 const struct btf *btf, const struct btf_type *t)
7804 {
7805 	struct bpf_cand_cache *cc;
7806 	struct bpf_core_ctx ctx = {
7807 		.btf = btf,
7808 		.log = log,
7809 	};
7810 	u32 kern_type_id, type_id;
7811 	int err = 0;
7812 
7813 	/* skip PTR and modifiers */
7814 	type_id = t->type;
7815 	t = btf_type_by_id(btf, t->type);
7816 	while (btf_type_is_modifier(t)) {
7817 		type_id = t->type;
7818 		t = btf_type_by_id(btf, t->type);
7819 	}
7820 
7821 	mutex_lock(&cand_cache_mutex);
7822 	cc = bpf_core_find_cands(&ctx, type_id);
7823 	if (IS_ERR(cc)) {
7824 		err = PTR_ERR(cc);
7825 		bpf_log(log, "arg#%d reference type('%s %s') candidate matching error: %d\n",
7826 			arg_idx, btf_type_str(t), __btf_name_by_offset(btf, t->name_off),
7827 			err);
7828 		goto cand_cache_unlock;
7829 	}
7830 	if (cc->cnt != 1) {
7831 		bpf_log(log, "arg#%d reference type('%s %s') %s\n",
7832 			arg_idx, btf_type_str(t), __btf_name_by_offset(btf, t->name_off),
7833 			cc->cnt == 0 ? "has no matches" : "is ambiguous");
7834 		err = cc->cnt == 0 ? -ENOENT : -ESRCH;
7835 		goto cand_cache_unlock;
7836 	}
7837 	if (btf_is_module(cc->cands[0].btf)) {
7838 		bpf_log(log, "arg#%d reference type('%s %s') points to kernel module type (unsupported)\n",
7839 			arg_idx, btf_type_str(t), __btf_name_by_offset(btf, t->name_off));
7840 		err = -EOPNOTSUPP;
7841 		goto cand_cache_unlock;
7842 	}
7843 	kern_type_id = cc->cands[0].id;
7844 
7845 cand_cache_unlock:
7846 	mutex_unlock(&cand_cache_mutex);
7847 	if (err)
7848 		return err;
7849 
7850 	return kern_type_id;
7851 }
7852 
7853 enum btf_arg_tag {
7854 	ARG_TAG_CTX	  = BIT_ULL(0),
7855 	ARG_TAG_NONNULL   = BIT_ULL(1),
7856 	ARG_TAG_TRUSTED   = BIT_ULL(2),
7857 	ARG_TAG_UNTRUSTED = BIT_ULL(3),
7858 	ARG_TAG_NULLABLE  = BIT_ULL(4),
7859 	ARG_TAG_ARENA	  = BIT_ULL(5),
7860 };
7861 
btf_scan_decl_tags(struct bpf_verifier_env * env,const struct btf * btf,const struct btf_type * fn_t,u32 arg_idx,bool is_global,u32 * tags)7862 static int btf_scan_decl_tags(struct bpf_verifier_env *env,
7863 			      const struct btf *btf,
7864 			      const struct btf_type *fn_t,
7865 			      u32 arg_idx, bool is_global, u32 *tags)
7866 {
7867 	int id = btf_named_start_id(btf, false) - 1;
7868 	const char tag_key[] = "arg:";
7869 	static const struct {
7870 		const char *tag_value;
7871 		enum btf_arg_tag arg_tag;
7872 	} tag_values[] = {
7873 		{ "ctx", ARG_TAG_CTX },
7874 		{ "trusted", ARG_TAG_TRUSTED },
7875 		{ "untrusted", ARG_TAG_UNTRUSTED },
7876 		{ "nonnull", ARG_TAG_NONNULL },
7877 		{ "nullable", ARG_TAG_NULLABLE },
7878 		{ "arena", ARG_TAG_ARENA },
7879 	};
7880 
7881 	/*
7882 	 * The 'arg:<tag>' decl_tag takes precedence over the derivation
7883 	 * of the register type from the BTF type itself.
7884 	 */
7885 	while ((id = btf_find_next_decl_tag(btf, fn_t, arg_idx, tag_key, id)) > 0) {
7886 		const struct btf_type *tag_t;
7887 		const char *tag;
7888 		int i;
7889 		bool found;
7890 
7891 		/* disallow arg tags in static subprogs */
7892 		if (!is_global) {
7893 			bpf_log(&env->log,
7894 				"arg#%d type tag is not supported in static functions\n",
7895 				arg_idx);
7896 			return -EOPNOTSUPP;
7897 		}
7898 
7899 		tag_t = btf_type_by_id(btf, id);
7900 		tag = __btf_name_by_offset(btf, tag_t->name_off) + (sizeof(tag_key) - 1);
7901 
7902 		found = false;
7903 		for (i = 0; i < ARRAY_SIZE(tag_values); ++i) {
7904 			if (!strcmp(tag, tag_values[i].tag_value)) {
7905 				*tags |= tag_values[i].arg_tag;
7906 				found = true;
7907 				break;
7908 			}
7909 		}
7910 
7911 		if (!found) {
7912 			bpf_log(&env->log, "arg#%d has unsupported set of tags\n", arg_idx);
7913 			return -EOPNOTSUPP;
7914 		}
7915 	}
7916 	if (id != -ENOENT) {
7917 		bpf_log(&env->log, "arg#%d type tag fetching failure: %d\n", arg_idx, id);
7918 		return id;
7919 	}
7920 
7921 	return 0;
7922 }
7923 
btf_scan_type_tags(struct bpf_verifier_env * env,const struct btf * btf,u32 type_id,u32 * tags)7924 static int btf_scan_type_tags(struct bpf_verifier_env *env,
7925 			      const struct btf *btf, u32 type_id,
7926 			      u32 *tags)
7927 {
7928 	static const struct btf_type_tag_match func_type_tags[] = {
7929 		{ "arena", ARG_TAG_ARENA },
7930 	};
7931 	struct btf_type_tag_walk_ctx ctx;
7932 	const struct btf_type *t;
7933 	int err;
7934 
7935 	/* Find the first pointer type in the chain. */
7936 	t = btf_type_skip_modifiers(btf, type_id, NULL);
7937 
7938 	/*
7939 	 * We currently reject type tags on non-pointer types,
7940 	 * which neither LLVM nor GCC support anyway.
7941 	 */
7942 	if (!t || !btf_type_is_ptr(t))
7943 		return 0;
7944 
7945 	ctx.t = t;
7946 	err = btf_type_tag_walk(btf, &ctx, func_type_tags,
7947 				ARRAY_SIZE(func_type_tags));
7948 	if (err) {
7949 		bpf_log(&env->log,
7950 			"function signature member has multiple type tags\n");
7951 		return err;
7952 	}
7953 	*tags |= ctx.res;
7954 
7955 	return 0;
7956 }
7957 
7958 /* Check whether the type is a valid return type. */
btf_validate_return_type(struct bpf_verifier_env * env,struct btf * btf,const struct btf_type * t,int subprog)7959 static int btf_validate_return_type(struct bpf_verifier_env *env, struct btf *btf,
7960 		const struct btf_type *t, int subprog)
7961 {
7962 	u32 tags = 0;
7963 	int err;
7964 
7965 	err = btf_scan_type_tags(env, btf, t->type, &tags);
7966 	if (err)
7967 		return err;
7968 
7969 	t = btf_type_skip_modifiers(btf, t->type, NULL);
7970 
7971 	/*
7972 	 * We allow all subprogs except for the main one to return any kind of arena pointer.
7973 	 * General arena variables are not allowed, since it makes no sense to return by value
7974 	 * a variable that's on the heap in the first place.
7975 	 */
7976 	if (subprog && (tags & ARG_TAG_ARENA) && btf_type_is_ptr(t))
7977 		return 0;
7978 
7979 	/* We always accept void or scalars. */
7980 	if (btf_type_is_void(t) || btf_type_is_int(t) || btf_is_any_enum(t))
7981 		return 0;
7982 
7983 	return -EOPNOTSUPP;
7984 }
7985 
7986 /* Process BTF of a function to produce high-level expectation of function
7987  * arguments (like ARG_PTR_TO_CTX, or ARG_PTR_TO_MEM, etc). This information
7988  * is cached in subprog info for reuse.
7989  * Returns:
7990  * EFAULT - there is a verifier bug. Abort verification.
7991  * EINVAL - cannot convert BTF.
7992  * 0 - Successfully processed BTF and constructed argument expectations.
7993  */
btf_prepare_func_args(struct bpf_verifier_env * env,int subprog)7994 int btf_prepare_func_args(struct bpf_verifier_env *env, int subprog)
7995 {
7996 	bool is_global = subprog_aux(env, subprog)->linkage == BTF_FUNC_GLOBAL;
7997 	struct bpf_subprog_info *sub = subprog_info(env, subprog);
7998 	struct bpf_verifier_log *log = &env->log;
7999 	struct bpf_prog *prog = env->prog;
8000 	enum bpf_prog_type prog_type = prog->type;
8001 	struct btf *btf = prog->aux->btf;
8002 	const struct btf_param *args;
8003 	const struct btf_type *t, *ref_t, *fn_t;
8004 	int err;
8005 	u32 i, nargs, btf_id;
8006 	const char *tname;
8007 
8008 	if (sub->args_cached)
8009 		return 0;
8010 
8011 	if (!prog->aux->func_info) {
8012 		verifier_bug(env, "func_info undefined");
8013 		return -EFAULT;
8014 	}
8015 
8016 	btf_id = prog->aux->func_info[subprog].type_id;
8017 	if (!btf_id) {
8018 		if (!is_global) /* not fatal for static funcs */
8019 			return -EINVAL;
8020 		bpf_log(log, "Global functions need valid BTF\n");
8021 		return -EFAULT;
8022 	}
8023 
8024 	fn_t = btf_type_by_id(btf, btf_id);
8025 	if (!fn_t || !btf_type_is_func(fn_t)) {
8026 		/* These checks were already done by the verifier while loading
8027 		 * struct bpf_func_info
8028 		 */
8029 		bpf_log(log, "BTF of func#%d doesn't point to KIND_FUNC\n",
8030 			subprog);
8031 		return -EFAULT;
8032 	}
8033 	tname = btf_name_by_offset(btf, fn_t->name_off);
8034 
8035 	if (prog->aux->func_info_aux[subprog].unreliable) {
8036 		verifier_bug(env, "unreliable BTF for function %s()", tname);
8037 		return -EFAULT;
8038 	}
8039 	if (prog_type == BPF_PROG_TYPE_EXT)
8040 		prog_type = prog->aux->dst_prog->type;
8041 
8042 	t = btf_type_by_id(btf, fn_t->type);
8043 	if (!t || !btf_type_is_func_proto(t)) {
8044 		bpf_log(log, "Invalid type of function %s()\n", tname);
8045 		return -EFAULT;
8046 	}
8047 	args = (const struct btf_param *)(t + 1);
8048 	nargs = btf_type_vlen(t);
8049 	sub->arg_cnt = nargs;
8050 	if (nargs > MAX_BPF_FUNC_ARGS) {
8051 		bpf_log(log, "kernel supports at most %d parameters, function %s has %d\n",
8052 			MAX_BPF_FUNC_ARGS, tname, nargs);
8053 		return -EFAULT;
8054 	}
8055 	if (nargs > MAX_BPF_FUNC_REG_ARGS) {
8056 		if (!bpf_jit_supports_stack_args()) {
8057 			bpf_log(log, "JIT does not support function %s() with %d args\n",
8058 				tname, nargs);
8059 			return -EFAULT;
8060 		}
8061 		sub->stack_arg_cnt = nargs - MAX_BPF_FUNC_REG_ARGS;
8062 	}
8063 
8064 	if (is_global && nargs > MAX_BPF_FUNC_REG_ARGS) {
8065 		bpf_log(log, "global function %s has %d > %d args, stack args not supported\n",
8066 			tname, nargs, MAX_BPF_FUNC_REG_ARGS);
8067 		return -EINVAL;
8068 	}
8069 
8070 	err = btf_validate_return_type(env, btf, t, subprog);
8071 	if (err) {
8072 		if (is_global) {
8073 			bpf_log(log,
8074 				"Global function %s() return value not void or scalar. "
8075 				"Only those are supported.\n",
8076 				tname);
8077 		}
8078 		return err;
8079 	}
8080 
8081 	/* Convert BTF function arguments into verifier types.
8082 	 * Only PTR_TO_CTX and SCALAR are supported atm.
8083 	 */
8084 	for (i = 0; i < nargs; i++) {
8085 		u32 tags = 0;
8086 		err = btf_scan_decl_tags(env, btf, fn_t, i, is_global, &tags);
8087 		if (err)
8088 			return err;
8089 
8090 		err = btf_scan_type_tags(env, btf, args[i].type, &tags);
8091 		if (err)
8092 			return err;
8093 
8094 		t = btf_type_by_id(btf, args[i].type);
8095 		while (btf_type_is_modifier(t))
8096 			t = btf_type_by_id(btf, t->type);
8097 		if (!btf_type_is_ptr(t))
8098 			goto skip_pointer;
8099 
8100 		if ((tags & ARG_TAG_CTX) || btf_is_prog_ctx_type(log, btf, t, prog_type, i)) {
8101 			if (tags & ~ARG_TAG_CTX) {
8102 				bpf_log(log, "arg#%d has invalid combination of tags\n", i);
8103 				return -EINVAL;
8104 			}
8105 			if ((tags & ARG_TAG_CTX) &&
8106 			    btf_validate_prog_ctx_type(log, btf, t, i, prog_type,
8107 						       prog->expected_attach_type))
8108 				return -EINVAL;
8109 			sub->args[i].arg_type = ARG_PTR_TO_CTX;
8110 			continue;
8111 		}
8112 		if (btf_is_dynptr_ptr(btf, t)) {
8113 			if (tags) {
8114 				bpf_log(log, "arg#%d has invalid combination of tags\n", i);
8115 				return -EINVAL;
8116 			}
8117 			sub->args[i].arg_type = ARG_PTR_TO_DYNPTR;
8118 			continue;
8119 		}
8120 		if (tags & ARG_TAG_TRUSTED) {
8121 			int kern_type_id;
8122 
8123 			if (tags & ARG_TAG_NONNULL) {
8124 				bpf_log(log, "arg#%d has invalid combination of tags\n", i);
8125 				return -EINVAL;
8126 			}
8127 
8128 			kern_type_id = btf_get_ptr_to_btf_id(log, i, btf, t);
8129 			if (kern_type_id < 0)
8130 				return kern_type_id;
8131 
8132 			sub->args[i].arg_type = ARG_PTR_TO_BTF_ID | PTR_TRUSTED;
8133 			if (tags & ARG_TAG_NULLABLE)
8134 				sub->args[i].arg_type |= PTR_MAYBE_NULL;
8135 			sub->args[i].btf_id = kern_type_id;
8136 			continue;
8137 		}
8138 		if (tags & ARG_TAG_UNTRUSTED) {
8139 			struct btf *vmlinux_btf;
8140 			int kern_type_id;
8141 
8142 			if (tags & ~ARG_TAG_UNTRUSTED) {
8143 				bpf_log(log, "arg#%d untrusted cannot be combined with any other tags\n", i);
8144 				return -EINVAL;
8145 			}
8146 
8147 			ref_t = btf_type_skip_modifiers(btf, t->type, NULL);
8148 			if (btf_type_is_void(ref_t) || btf_type_is_primitive(ref_t)) {
8149 				sub->args[i].arg_type = ARG_PTR_TO_MEM | MEM_RDONLY | PTR_UNTRUSTED;
8150 				sub->args[i].mem_size = 0;
8151 				continue;
8152 			}
8153 
8154 			kern_type_id = btf_get_ptr_to_btf_id(log, i, btf, t);
8155 			if (kern_type_id < 0)
8156 				return kern_type_id;
8157 
8158 			vmlinux_btf = bpf_get_btf_vmlinux();
8159 			ref_t = btf_type_by_id(vmlinux_btf, kern_type_id);
8160 			if (!btf_type_is_struct(ref_t)) {
8161 				tname = __btf_name_by_offset(vmlinux_btf, t->name_off);
8162 				bpf_log(log, "arg#%d has type %s '%s', but only struct or primitive types are allowed\n",
8163 					i, btf_type_str(ref_t), tname);
8164 				return -EINVAL;
8165 			}
8166 			sub->args[i].arg_type = ARG_PTR_TO_BTF_ID | PTR_UNTRUSTED;
8167 			sub->args[i].btf_id = kern_type_id;
8168 			continue;
8169 		}
8170 		if (tags & ARG_TAG_ARENA) {
8171 			if (tags & ~ARG_TAG_ARENA) {
8172 				bpf_log(log, "arg#%d arena cannot be combined with any other tags\n", i);
8173 				return -EINVAL;
8174 			}
8175 			sub->args[i].arg_type = ARG_PTR_TO_ARENA;
8176 			continue;
8177 		}
8178 		if (is_global) { /* generic user data pointer */
8179 			u32 mem_size;
8180 
8181 			if (tags & ARG_TAG_NULLABLE) {
8182 				bpf_log(log, "arg#%d has invalid combination of tags\n", i);
8183 				return -EINVAL;
8184 			}
8185 
8186 			t = btf_type_skip_modifiers(btf, t->type, NULL);
8187 			ref_t = btf_resolve_size(btf, t, &mem_size);
8188 			if (IS_ERR(ref_t)) {
8189 				bpf_log(log, "arg#%d reference type('%s %s') size cannot be determined: %ld\n",
8190 					i, btf_type_str(t), btf_name_by_offset(btf, t->name_off),
8191 					PTR_ERR(ref_t));
8192 				return -EINVAL;
8193 			}
8194 
8195 			sub->args[i].arg_type = ARG_PTR_TO_MEM | PTR_MAYBE_NULL;
8196 			if (tags & ARG_TAG_NONNULL)
8197 				sub->args[i].arg_type &= ~PTR_MAYBE_NULL;
8198 			sub->args[i].mem_size = mem_size;
8199 			continue;
8200 		}
8201 
8202 skip_pointer:
8203 		if (tags) {
8204 			bpf_log(log, "arg#%d has pointer tag, but is not a pointer type\n", i);
8205 			return -EINVAL;
8206 		}
8207 		if (btf_type_is_int(t) || btf_is_any_enum(t)) {
8208 			sub->args[i].arg_type = ARG_ANYTHING;
8209 			continue;
8210 		}
8211 		if (!is_global)
8212 			return -EINVAL;
8213 		bpf_log(log, "Arg#%d type %s in %s() is not supported yet.\n",
8214 			i, btf_type_str(t), tname);
8215 		return -EINVAL;
8216 	}
8217 
8218 	sub->args_cached = true;
8219 
8220 	return 0;
8221 }
8222 
btf_type_show(const struct btf * btf,u32 type_id,void * obj,struct btf_show * show)8223 static void btf_type_show(const struct btf *btf, u32 type_id, void *obj,
8224 			  struct btf_show *show)
8225 {
8226 	const struct btf_type *t = btf_type_by_id(btf, type_id);
8227 
8228 	show->btf = btf;
8229 	memset(&show->state, 0, sizeof(show->state));
8230 	memset(&show->obj, 0, sizeof(show->obj));
8231 
8232 	btf_type_ops(t)->show(btf, t, type_id, obj, 0, show);
8233 }
8234 
btf_seq_show(struct btf_show * show,const char * fmt,va_list args)8235 __printf(2, 0) static void btf_seq_show(struct btf_show *show, const char *fmt,
8236 					va_list args)
8237 {
8238 	seq_vprintf((struct seq_file *)show->target, fmt, args);
8239 }
8240 
btf_type_seq_show_flags(const struct btf * btf,u32 type_id,void * obj,struct seq_file * m,u64 flags)8241 int btf_type_seq_show_flags(const struct btf *btf, u32 type_id,
8242 			    void *obj, struct seq_file *m, u64 flags)
8243 {
8244 	struct btf_show sseq;
8245 
8246 	sseq.target = m;
8247 	sseq.showfn = btf_seq_show;
8248 	sseq.flags = flags;
8249 
8250 	btf_type_show(btf, type_id, obj, &sseq);
8251 
8252 	return sseq.state.status;
8253 }
8254 
btf_type_seq_show(const struct btf * btf,u32 type_id,void * obj,struct seq_file * m)8255 void btf_type_seq_show(const struct btf *btf, u32 type_id, void *obj,
8256 		       struct seq_file *m)
8257 {
8258 	(void) btf_type_seq_show_flags(btf, type_id, obj, m,
8259 				       BTF_SHOW_NONAME | BTF_SHOW_COMPACT |
8260 				       BTF_SHOW_ZERO | BTF_SHOW_UNSAFE);
8261 }
8262 
8263 struct btf_show_snprintf {
8264 	struct btf_show show;
8265 	int len_left;		/* space left in string */
8266 	int len;		/* length we would have written */
8267 };
8268 
btf_snprintf_show(struct btf_show * show,const char * fmt,va_list args)8269 __printf(2, 0) static void btf_snprintf_show(struct btf_show *show, const char *fmt,
8270 					     va_list args)
8271 {
8272 	struct btf_show_snprintf *ssnprintf = (struct btf_show_snprintf *)show;
8273 	int len;
8274 
8275 	len = vsnprintf(show->target, ssnprintf->len_left, fmt, args);
8276 
8277 	if (len < 0) {
8278 		ssnprintf->len_left = 0;
8279 		ssnprintf->len = len;
8280 	} else if (len >= ssnprintf->len_left) {
8281 		/* no space, drive on to get length we would have written */
8282 		ssnprintf->len_left = 0;
8283 		ssnprintf->len += len;
8284 	} else {
8285 		ssnprintf->len_left -= len;
8286 		ssnprintf->len += len;
8287 		show->target += len;
8288 	}
8289 }
8290 
btf_type_snprintf_show(const struct btf * btf,u32 type_id,void * obj,char * buf,int len,u64 flags)8291 int btf_type_snprintf_show(const struct btf *btf, u32 type_id, void *obj,
8292 			   char *buf, int len, u64 flags)
8293 {
8294 	struct btf_show_snprintf ssnprintf;
8295 
8296 	ssnprintf.show.target = buf;
8297 	ssnprintf.show.flags = flags;
8298 	ssnprintf.show.showfn = btf_snprintf_show;
8299 	ssnprintf.len_left = len;
8300 	ssnprintf.len = 0;
8301 
8302 	btf_type_show(btf, type_id, obj, (struct btf_show *)&ssnprintf);
8303 
8304 	/* If we encountered an error, return it. */
8305 	if (ssnprintf.show.state.status)
8306 		return ssnprintf.show.state.status;
8307 
8308 	/* Otherwise return length we would have written */
8309 	return ssnprintf.len;
8310 }
8311 
btf_type_name_to_buf(const struct btf * btf,u32 type_id,char * buf,int len)8312 int btf_type_name_to_buf(const struct btf *btf, u32 type_id, char *buf, int len)
8313 {
8314 	struct btf_show show = {
8315 		.btf = btf,
8316 		.state.type_id = type_id,
8317 	};
8318 
8319 	return snprintf(buf, len, "%s", btf_show_name(&show));
8320 }
8321 
8322 #ifdef CONFIG_PROC_FS
bpf_btf_show_fdinfo(struct seq_file * m,struct file * filp)8323 static void bpf_btf_show_fdinfo(struct seq_file *m, struct file *filp)
8324 {
8325 	const struct btf *btf = filp->private_data;
8326 
8327 	seq_printf(m, "btf_id:\t%u\n", READ_ONCE(btf->id));
8328 }
8329 #endif
8330 
btf_release(struct inode * inode,struct file * filp)8331 static int btf_release(struct inode *inode, struct file *filp)
8332 {
8333 	btf_put(filp->private_data);
8334 	return 0;
8335 }
8336 
8337 const struct file_operations btf_fops = {
8338 #ifdef CONFIG_PROC_FS
8339 	.show_fdinfo	= bpf_btf_show_fdinfo,
8340 #endif
8341 	.release	= btf_release,
8342 };
8343 
__btf_new_fd(struct btf * btf)8344 static int __btf_new_fd(struct btf *btf)
8345 {
8346 	return anon_inode_getfd("btf", &btf_fops, btf, O_RDONLY | O_CLOEXEC);
8347 }
8348 
btf_new_fd(const union bpf_attr * attr,bpfptr_t uattr,struct bpf_log_attr * attr_log)8349 int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr, struct bpf_log_attr *attr_log)
8350 {
8351 	struct btf *btf;
8352 	int ret;
8353 
8354 	btf = btf_parse(attr, uattr, attr_log);
8355 	if (IS_ERR(btf))
8356 		return PTR_ERR(btf);
8357 
8358 	ret = btf_alloc_id(btf);
8359 	if (ret) {
8360 		btf_free(btf);
8361 		return ret;
8362 	}
8363 
8364 	/*
8365 	 * The BTF ID is published to the userspace.
8366 	 * All BTF free must go through call_rcu() from
8367 	 * now on (i.e. free by calling btf_put()).
8368 	 */
8369 
8370 	ret = __btf_new_fd(btf);
8371 	if (ret < 0)
8372 		btf_put(btf);
8373 
8374 	return ret;
8375 }
8376 
btf_get_by_fd(int fd)8377 struct btf *btf_get_by_fd(int fd)
8378 {
8379 	struct btf *btf;
8380 	CLASS(fd, f)(fd);
8381 
8382 	btf = __btf_get_by_fd(f);
8383 	if (!IS_ERR(btf))
8384 		refcount_inc(&btf->refcnt);
8385 
8386 	return btf;
8387 }
8388 
btf_get_info_by_fd(const struct btf * btf,const union bpf_attr * attr,union bpf_attr __user * uattr)8389 int btf_get_info_by_fd(const struct btf *btf,
8390 		       const union bpf_attr *attr,
8391 		       union bpf_attr __user *uattr)
8392 {
8393 	struct bpf_btf_info __user *uinfo;
8394 	struct bpf_btf_info info;
8395 	u32 info_copy, btf_copy;
8396 	void __user *ubtf;
8397 	char __user *uname;
8398 	u32 uinfo_len, uname_len, name_len;
8399 	int ret = 0;
8400 
8401 	uinfo = u64_to_user_ptr(attr->info.info);
8402 	uinfo_len = attr->info.info_len;
8403 
8404 	info_copy = min_t(u32, uinfo_len, sizeof(info));
8405 	memset(&info, 0, sizeof(info));
8406 	if (copy_from_user(&info, uinfo, info_copy))
8407 		return -EFAULT;
8408 
8409 	info.id = READ_ONCE(btf->id);
8410 	ubtf = u64_to_user_ptr(info.btf);
8411 	btf_copy = min_t(u32, btf->data_size, info.btf_size);
8412 	if (copy_to_user(ubtf, btf->data, btf_copy))
8413 		return -EFAULT;
8414 	info.btf_size = btf->data_size;
8415 
8416 	info.kernel_btf = btf->kernel_btf;
8417 
8418 	uname = u64_to_user_ptr(info.name);
8419 	uname_len = info.name_len;
8420 	if (!uname ^ !uname_len)
8421 		return -EINVAL;
8422 
8423 	name_len = strlen(btf->name);
8424 	info.name_len = name_len;
8425 
8426 	if (uname) {
8427 		if (uname_len >= name_len + 1) {
8428 			if (copy_to_user(uname, btf->name, name_len + 1))
8429 				return -EFAULT;
8430 		} else {
8431 			char zero = '\0';
8432 
8433 			if (copy_to_user(uname, btf->name, uname_len - 1))
8434 				return -EFAULT;
8435 			if (put_user(zero, uname + uname_len - 1))
8436 				return -EFAULT;
8437 			/* let user-space know about too short buffer */
8438 			ret = -ENOSPC;
8439 		}
8440 	}
8441 
8442 	if (copy_to_user(uinfo, &info, info_copy) ||
8443 	    put_user(info_copy, &uattr->info.info_len))
8444 		return -EFAULT;
8445 
8446 	return ret;
8447 }
8448 
btf_get_fd_by_id(u32 id)8449 int btf_get_fd_by_id(u32 id)
8450 {
8451 	struct btf *btf;
8452 	int fd;
8453 
8454 	rcu_read_lock();
8455 	btf = idr_find(&btf_idr, id);
8456 	if (!btf || !refcount_inc_not_zero(&btf->refcnt))
8457 		btf = ERR_PTR(-ENOENT);
8458 	rcu_read_unlock();
8459 
8460 	if (IS_ERR(btf))
8461 		return PTR_ERR(btf);
8462 
8463 	fd = __btf_new_fd(btf);
8464 	if (fd < 0)
8465 		btf_put(btf);
8466 
8467 	return fd;
8468 }
8469 
btf_obj_id(const struct btf * btf)8470 u32 btf_obj_id(const struct btf *btf)
8471 {
8472 	return READ_ONCE(btf->id);
8473 }
8474 
btf_is_kernel(const struct btf * btf)8475 bool btf_is_kernel(const struct btf *btf)
8476 {
8477 	return btf->kernel_btf;
8478 }
8479 
btf_is_module(const struct btf * btf)8480 bool btf_is_module(const struct btf *btf)
8481 {
8482 	return btf->kernel_btf && strcmp(btf->name, "vmlinux") != 0;
8483 }
8484 
8485 enum {
8486 	BTF_MODULE_F_LIVE = (1 << 0),
8487 };
8488 
8489 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
8490 struct btf_module {
8491 	struct list_head list;
8492 	struct module *module;
8493 	struct btf *btf;
8494 	struct bin_attribute *sysfs_attr;
8495 	int flags;
8496 };
8497 
8498 static LIST_HEAD(btf_modules);
8499 static DEFINE_MUTEX(btf_module_mutex);
8500 
8501 static void purge_cand_cache(struct btf *btf);
8502 
btf_module_notify(struct notifier_block * nb,unsigned long op,void * module)8503 static int btf_module_notify(struct notifier_block *nb, unsigned long op,
8504 			     void *module)
8505 {
8506 	struct btf_module *btf_mod, *tmp;
8507 	struct module *mod = module;
8508 	struct btf *btf;
8509 	int err = 0;
8510 
8511 	if (mod->btf_data_size == 0 ||
8512 	    (op != MODULE_STATE_COMING && op != MODULE_STATE_LIVE &&
8513 	     op != MODULE_STATE_GOING))
8514 		goto out;
8515 
8516 	switch (op) {
8517 	case MODULE_STATE_COMING:
8518 		btf_mod = kzalloc_obj(*btf_mod);
8519 		if (!btf_mod) {
8520 			err = -ENOMEM;
8521 			goto out;
8522 		}
8523 		btf = btf_parse_module(mod->name, mod->btf_data, mod->btf_data_size,
8524 				       mod->btf_base_data, mod->btf_base_data_size);
8525 		if (IS_ERR(btf)) {
8526 			kfree(btf_mod);
8527 			if (!IS_ENABLED(CONFIG_MODULE_ALLOW_BTF_MISMATCH)) {
8528 				pr_warn("failed to validate module [%s] BTF: %ld\n",
8529 					mod->name, PTR_ERR(btf));
8530 				err = PTR_ERR(btf);
8531 			} else {
8532 				pr_warn_once("Kernel module BTF mismatch detected, BTF debug info may be unavailable for some modules\n");
8533 			}
8534 			goto out;
8535 		}
8536 		err = btf_alloc_id(btf);
8537 		if (err) {
8538 			btf_free(btf);
8539 			kfree(btf_mod);
8540 			goto out;
8541 		}
8542 
8543 		purge_cand_cache(NULL);
8544 		mutex_lock(&btf_module_mutex);
8545 		btf_mod->module = module;
8546 		btf_mod->btf = btf;
8547 		list_add(&btf_mod->list, &btf_modules);
8548 		mutex_unlock(&btf_module_mutex);
8549 
8550 		if (IS_ENABLED(CONFIG_SYSFS)) {
8551 			struct bin_attribute *attr;
8552 
8553 			attr = kzalloc_obj(*attr);
8554 			if (!attr)
8555 				goto out;
8556 
8557 			sysfs_bin_attr_init(attr);
8558 			attr->attr.name = btf->name;
8559 			attr->attr.mode = 0444;
8560 			attr->size = btf->data_size;
8561 			attr->private = btf->data;
8562 			attr->read = sysfs_bin_attr_simple_read;
8563 
8564 			err = sysfs_create_bin_file(btf_kobj, attr);
8565 			if (err) {
8566 				pr_warn("failed to register module [%s] BTF in sysfs: %d\n",
8567 					mod->name, err);
8568 				kfree(attr);
8569 				err = 0;
8570 				goto out;
8571 			}
8572 
8573 			btf_mod->sysfs_attr = attr;
8574 		}
8575 
8576 		break;
8577 	case MODULE_STATE_LIVE:
8578 		mutex_lock(&btf_module_mutex);
8579 		list_for_each_entry_safe(btf_mod, tmp, &btf_modules, list) {
8580 			if (btf_mod->module != module)
8581 				continue;
8582 
8583 			btf_mod->flags |= BTF_MODULE_F_LIVE;
8584 			break;
8585 		}
8586 		mutex_unlock(&btf_module_mutex);
8587 		break;
8588 	case MODULE_STATE_GOING:
8589 		mutex_lock(&btf_module_mutex);
8590 		list_for_each_entry_safe(btf_mod, tmp, &btf_modules, list) {
8591 			if (btf_mod->module != module)
8592 				continue;
8593 
8594 			/*
8595 			 * For modules, we do the freeing of BTF IDR as soon as
8596 			 * module goes away to disable BTF discovery, since the
8597 			 * btf_try_get_module() on such BTFs will fail. This may
8598 			 * be called again on btf_put(), but it's ok to do so.
8599 			 */
8600 			btf_free_id(btf_mod->btf);
8601 			list_del(&btf_mod->list);
8602 			if (btf_mod->sysfs_attr)
8603 				sysfs_remove_bin_file(btf_kobj, btf_mod->sysfs_attr);
8604 			purge_cand_cache(btf_mod->btf);
8605 			btf_put(btf_mod->btf);
8606 			kfree(btf_mod->sysfs_attr);
8607 			kfree(btf_mod);
8608 			break;
8609 		}
8610 		mutex_unlock(&btf_module_mutex);
8611 		break;
8612 	}
8613 out:
8614 	return notifier_from_errno(err);
8615 }
8616 
8617 static struct notifier_block btf_module_nb = {
8618 	.notifier_call = btf_module_notify,
8619 };
8620 
btf_module_init(void)8621 static int __init btf_module_init(void)
8622 {
8623 	register_module_notifier(&btf_module_nb);
8624 	return 0;
8625 }
8626 
8627 fs_initcall(btf_module_init);
8628 #endif /* CONFIG_DEBUG_INFO_BTF_MODULES */
8629 
btf_try_get_module(const struct btf * btf)8630 struct module *btf_try_get_module(const struct btf *btf)
8631 {
8632 	struct module *res = NULL;
8633 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
8634 	struct btf_module *btf_mod, *tmp;
8635 
8636 	mutex_lock(&btf_module_mutex);
8637 	list_for_each_entry_safe(btf_mod, tmp, &btf_modules, list) {
8638 		if (btf_mod->btf != btf)
8639 			continue;
8640 
8641 		/* We must only consider module whose __init routine has
8642 		 * finished, hence we must check for BTF_MODULE_F_LIVE flag,
8643 		 * which is set from the notifier callback for
8644 		 * MODULE_STATE_LIVE.
8645 		 */
8646 		if ((btf_mod->flags & BTF_MODULE_F_LIVE) && try_module_get(btf_mod->module))
8647 			res = btf_mod->module;
8648 
8649 		break;
8650 	}
8651 	mutex_unlock(&btf_module_mutex);
8652 #endif
8653 
8654 	return res;
8655 }
8656 
8657 /* Returns struct btf corresponding to the struct module.
8658  * This function can return NULL or ERR_PTR.
8659  */
btf_get_module_btf(const struct module * module)8660 struct btf *btf_get_module_btf(const struct module *module)
8661 {
8662 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
8663 	struct btf_module *btf_mod, *tmp;
8664 #endif
8665 	struct btf *btf = NULL;
8666 
8667 	if (!module) {
8668 		btf = bpf_get_btf_vmlinux();
8669 		if (!IS_ERR_OR_NULL(btf))
8670 			btf_get(btf);
8671 		return btf;
8672 	}
8673 
8674 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
8675 	mutex_lock(&btf_module_mutex);
8676 	list_for_each_entry_safe(btf_mod, tmp, &btf_modules, list) {
8677 		if (btf_mod->module != module)
8678 			continue;
8679 
8680 		btf_get(btf_mod->btf);
8681 		btf = btf_mod->btf;
8682 		break;
8683 	}
8684 	mutex_unlock(&btf_module_mutex);
8685 #endif
8686 
8687 	return btf;
8688 }
8689 
check_btf_kconfigs(const struct module * module,const char * feature)8690 static int check_btf_kconfigs(const struct module *module, const char *feature)
8691 {
8692 	if (!module && IS_ENABLED(CONFIG_DEBUG_INFO_BTF)) {
8693 		pr_err("missing vmlinux BTF, cannot register %s\n", feature);
8694 		return -ENOENT;
8695 	}
8696 	if (module && IS_ENABLED(CONFIG_DEBUG_INFO_BTF_MODULES))
8697 		pr_warn("missing module BTF, cannot register %s\n", feature);
8698 	return 0;
8699 }
8700 
BPF_CALL_4(bpf_btf_find_by_name_kind,char *,name,int,name_sz,u32,kind,int,flags)8701 BPF_CALL_4(bpf_btf_find_by_name_kind, char *, name, int, name_sz, u32, kind, int, flags)
8702 {
8703 	struct btf *btf = NULL;
8704 	int btf_obj_fd = 0;
8705 	long ret;
8706 
8707 	if (flags)
8708 		return -EINVAL;
8709 
8710 	if (name_sz <= 1 || name[name_sz - 1])
8711 		return -EINVAL;
8712 
8713 	ret = bpf_find_btf_id(name, kind, &btf);
8714 	if (ret > 0 && btf_is_module(btf)) {
8715 		btf_obj_fd = __btf_new_fd(btf);
8716 		if (btf_obj_fd < 0) {
8717 			btf_put(btf);
8718 			return btf_obj_fd;
8719 		}
8720 		return ret | (((u64)btf_obj_fd) << 32);
8721 	}
8722 	if (ret > 0)
8723 		btf_put(btf);
8724 	return ret;
8725 }
8726 
8727 const struct bpf_func_proto bpf_btf_find_by_name_kind_proto = {
8728 	.func		= bpf_btf_find_by_name_kind,
8729 	.gpl_only	= false,
8730 	.ret_type	= RET_INTEGER,
8731 	.arg1_type	= ARG_PTR_TO_MEM | MEM_RDONLY,
8732 	.arg2_type	= ARG_MEM_SIZE,
8733 	.arg3_type	= ARG_ANYTHING,
8734 	.arg4_type	= ARG_ANYTHING,
8735 };
8736 
BTF_ID_LIST_GLOBAL(btf_tracing_ids,MAX_BTF_TRACING_TYPE)8737 BTF_ID_LIST_GLOBAL(btf_tracing_ids, MAX_BTF_TRACING_TYPE)
8738 #define BTF_TRACING_TYPE(name, type) BTF_ID(struct, type)
8739 BTF_TRACING_TYPE_xxx
8740 #undef BTF_TRACING_TYPE
8741 
8742 /* Validate well-formedness of iter argument type.
8743  * On success, return positive BTF ID of iter state's STRUCT type.
8744  * On error, negative error is returned.
8745  */
8746 int btf_check_iter_arg(struct btf *btf, const struct btf_type *func, int arg_idx)
8747 {
8748 	const struct btf_param *arg;
8749 	const struct btf_type *t;
8750 	const char *name;
8751 	int btf_id;
8752 
8753 	if (btf_type_vlen(func) <= arg_idx)
8754 		return -EINVAL;
8755 
8756 	arg = &btf_params(func)[arg_idx];
8757 	t = btf_type_skip_modifiers(btf, arg->type, NULL);
8758 	if (!t || !btf_type_is_ptr(t))
8759 		return -EINVAL;
8760 	t = btf_type_skip_modifiers(btf, t->type, &btf_id);
8761 	if (!t || !__btf_type_is_struct(t))
8762 		return -EINVAL;
8763 
8764 	name = btf_name_by_offset(btf, t->name_off);
8765 	if (!name || strncmp(name, ITER_PREFIX, sizeof(ITER_PREFIX) - 1))
8766 		return -EINVAL;
8767 
8768 	return btf_id;
8769 }
8770 
btf_check_iter_kfuncs(struct btf * btf,const char * func_name,const struct btf_type * func,u32 func_flags)8771 static int btf_check_iter_kfuncs(struct btf *btf, const char *func_name,
8772 				 const struct btf_type *func, u32 func_flags)
8773 {
8774 	u32 flags = func_flags & (KF_ITER_NEW | KF_ITER_NEXT | KF_ITER_DESTROY);
8775 	const char *sfx, *iter_name;
8776 	const struct btf_type *t;
8777 	char exp_name[128];
8778 	u32 nr_args;
8779 	int btf_id;
8780 
8781 	/* exactly one of KF_ITER_{NEW,NEXT,DESTROY} can be set */
8782 	if (!flags || (flags & (flags - 1)))
8783 		return -EINVAL;
8784 
8785 	/* any BPF iter kfunc should have `struct bpf_iter_<type> *` first arg */
8786 	nr_args = btf_type_vlen(func);
8787 	if (nr_args < 1)
8788 		return -EINVAL;
8789 
8790 	btf_id = btf_check_iter_arg(btf, func, 0);
8791 	if (btf_id < 0)
8792 		return btf_id;
8793 
8794 	/* sizeof(struct bpf_iter_<type>) should be a multiple of 8 to
8795 	 * fit nicely in stack slots
8796 	 */
8797 	t = btf_type_by_id(btf, btf_id);
8798 	if (t->size == 0 || (t->size % 8))
8799 		return -EINVAL;
8800 
8801 	/* validate bpf_iter_<type>_{new,next,destroy}(struct bpf_iter_<type> *)
8802 	 * naming pattern
8803 	 */
8804 	iter_name = btf_name_by_offset(btf, t->name_off) + sizeof(ITER_PREFIX) - 1;
8805 	if (flags & KF_ITER_NEW)
8806 		sfx = "new";
8807 	else if (flags & KF_ITER_NEXT)
8808 		sfx = "next";
8809 	else /* (flags & KF_ITER_DESTROY) */
8810 		sfx = "destroy";
8811 
8812 	snprintf(exp_name, sizeof(exp_name), "bpf_iter_%s_%s", iter_name, sfx);
8813 	if (strcmp(func_name, exp_name))
8814 		return -EINVAL;
8815 
8816 	/* only iter constructor should have extra arguments */
8817 	if (!(flags & KF_ITER_NEW) && nr_args != 1)
8818 		return -EINVAL;
8819 
8820 	if (flags & KF_ITER_NEXT) {
8821 		/* bpf_iter_<type>_next() should return pointer */
8822 		t = btf_type_skip_modifiers(btf, func->type, NULL);
8823 		if (!t || !btf_type_is_ptr(t))
8824 			return -EINVAL;
8825 	}
8826 
8827 	if (flags & KF_ITER_DESTROY) {
8828 		/* bpf_iter_<type>_destroy() should return void */
8829 		t = btf_type_by_id(btf, func->type);
8830 		if (!t || !btf_type_is_void(t))
8831 			return -EINVAL;
8832 	}
8833 
8834 	return 0;
8835 }
8836 
btf_check_kfunc_name(struct btf * btf,const char * func_name,u32 kind)8837 static int btf_check_kfunc_name(struct btf *btf, const char *func_name, u32 kind)
8838 {
8839 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
8840 	struct btf_module *btf_mod, *tmp;
8841 #endif
8842 	s32 id;
8843 
8844 	if (!btf_is_module(btf))
8845 		return 0;
8846 
8847 	id = btf_find_by_name_kind(bpf_get_btf_vmlinux(), func_name, kind);
8848 	if (id >= 0) {
8849 		pr_err("kfunc %s (id: %d) is already present in vmlinux.\n",
8850 		       func_name, id);
8851 		return -EINVAL;
8852 	}
8853 
8854 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
8855 	guard(mutex)(&btf_module_mutex);
8856 	list_for_each_entry_safe(btf_mod, tmp, &btf_modules, list) {
8857 		if (btf_mod->btf == btf)
8858 			continue;
8859 		id = btf_find_by_name_kind(btf_mod->btf, func_name, kind);
8860 		if (id >= 0) {
8861 			pr_err("kfunc %s (id: %d) is already present in module %s.\n",
8862 			       func_name, id, btf_mod->module->name);
8863 			return -EINVAL;
8864 		}
8865 	}
8866 #endif
8867 	return 0;
8868 }
8869 
btf_check_kfunc_protos(struct btf * btf,u32 func_id,u32 func_flags)8870 static int btf_check_kfunc_protos(struct btf *btf, u32 func_id, u32 func_flags)
8871 {
8872 	const struct btf_type *func;
8873 	const char *func_name;
8874 	int err;
8875 
8876 	/* any kfunc should be FUNC -> FUNC_PROTO */
8877 	func = btf_type_by_id(btf, func_id);
8878 	if (!func || !btf_type_is_func(func))
8879 		return -EINVAL;
8880 
8881 	/* sanity check kfunc name */
8882 	func_name = btf_name_by_offset(btf, func->name_off);
8883 	if (!func_name || !func_name[0] ||
8884 	    btf_check_kfunc_name(btf, func_name, BTF_INFO_KIND(func->info)))
8885 		return -EINVAL;
8886 
8887 	func = btf_type_by_id(btf, func->type);
8888 	if (!func || !btf_type_is_func_proto(func))
8889 		return -EINVAL;
8890 
8891 	if (func_flags & (KF_ITER_NEW | KF_ITER_NEXT | KF_ITER_DESTROY)) {
8892 		err = btf_check_iter_kfuncs(btf, func_name, func, func_flags);
8893 		if (err)
8894 			return err;
8895 	}
8896 
8897 	return 0;
8898 }
8899 
8900 /* Kernel Function (kfunc) BTF ID set registration API */
8901 
btf_populate_kfunc_set(struct btf * btf,enum btf_kfunc_hook hook,const struct btf_kfunc_id_set * kset)8902 static int btf_populate_kfunc_set(struct btf *btf, enum btf_kfunc_hook hook,
8903 				  const struct btf_kfunc_id_set *kset)
8904 {
8905 	struct btf_kfunc_hook_filter *hook_filter;
8906 	struct btf_id_set8 *add_set = kset->set;
8907 	bool vmlinux_set = !btf_is_module(btf);
8908 	bool add_filter = !!kset->filter;
8909 	struct btf_kfunc_set_tab *tab;
8910 	struct btf_id_set8 *set;
8911 	u32 set_cnt, i;
8912 	int ret;
8913 
8914 	if (hook >= BTF_KFUNC_HOOK_MAX) {
8915 		ret = -EINVAL;
8916 		goto end;
8917 	}
8918 
8919 	if (!add_set->cnt)
8920 		return 0;
8921 
8922 	tab = btf->kfunc_set_tab;
8923 
8924 	if (tab && add_filter) {
8925 		u32 i;
8926 
8927 		hook_filter = &tab->hook_filters[hook];
8928 		for (i = 0; i < hook_filter->nr_filters; i++) {
8929 			if (hook_filter->filters[i] == kset->filter) {
8930 				add_filter = false;
8931 				break;
8932 			}
8933 		}
8934 
8935 		if (add_filter && hook_filter->nr_filters == BTF_KFUNC_FILTER_MAX_CNT) {
8936 			ret = -E2BIG;
8937 			goto end;
8938 		}
8939 	}
8940 
8941 	if (!tab) {
8942 		tab = kzalloc_obj(*tab, GFP_KERNEL | __GFP_NOWARN);
8943 		if (!tab)
8944 			return -ENOMEM;
8945 		btf->kfunc_set_tab = tab;
8946 	}
8947 
8948 	set = tab->sets[hook];
8949 	/* Warn when register_btf_kfunc_id_set is called twice for the same hook
8950 	 * for module sets.
8951 	 */
8952 	if (WARN_ON_ONCE(set && !vmlinux_set)) {
8953 		ret = -EINVAL;
8954 		goto end;
8955 	}
8956 
8957 	/* In case of vmlinux sets, there may be more than one set being
8958 	 * registered per hook. To create a unified set, we allocate a new set
8959 	 * and concatenate all individual sets being registered. While each set
8960 	 * is individually sorted, they may become unsorted when concatenated,
8961 	 * hence re-sorting the final set again is required to make binary
8962 	 * searching the set using btf_id_set8_contains function work.
8963 	 *
8964 	 * For module sets, we need to allocate as we may need to relocate
8965 	 * BTF ids.
8966 	 */
8967 	set_cnt = set ? set->cnt : 0;
8968 
8969 	if (set_cnt > U32_MAX - add_set->cnt) {
8970 		ret = -EOVERFLOW;
8971 		goto end;
8972 	}
8973 
8974 	if (set_cnt + add_set->cnt > BTF_KFUNC_SET_MAX_CNT) {
8975 		ret = -E2BIG;
8976 		goto end;
8977 	}
8978 
8979 	/* Grow set */
8980 	set = krealloc(tab->sets[hook],
8981 		       struct_size(set, pairs, set_cnt + add_set->cnt),
8982 		       GFP_KERNEL | __GFP_NOWARN);
8983 	if (!set) {
8984 		ret = -ENOMEM;
8985 		goto end;
8986 	}
8987 
8988 	/* For newly allocated set, initialize set->cnt to 0 */
8989 	if (!tab->sets[hook])
8990 		set->cnt = 0;
8991 	tab->sets[hook] = set;
8992 
8993 	/* Concatenate the two sets */
8994 	memcpy(set->pairs + set->cnt, add_set->pairs, add_set->cnt * sizeof(set->pairs[0]));
8995 	/* Now that the set is copied, update with relocated BTF ids */
8996 	for (i = set->cnt; i < set->cnt + add_set->cnt; i++)
8997 		set->pairs[i].id = btf_relocate_id(btf, set->pairs[i].id);
8998 
8999 	set->cnt += add_set->cnt;
9000 
9001 	sort(set->pairs, set->cnt, sizeof(set->pairs[0]), btf_id_cmp_func, NULL);
9002 
9003 	if (add_filter) {
9004 		hook_filter = &tab->hook_filters[hook];
9005 		hook_filter->filters[hook_filter->nr_filters++] = kset->filter;
9006 	}
9007 	return 0;
9008 end:
9009 	btf_free_kfunc_set_tab(btf);
9010 	return ret;
9011 }
9012 
btf_kfunc_id_set_contains(const struct btf * btf,enum btf_kfunc_hook hook,u32 kfunc_btf_id)9013 static u32 *btf_kfunc_id_set_contains(const struct btf *btf,
9014 				      enum btf_kfunc_hook hook,
9015 				      u32 kfunc_btf_id)
9016 {
9017 	struct btf_id_set8 *set;
9018 	u32 *id;
9019 
9020 	if (hook >= BTF_KFUNC_HOOK_MAX)
9021 		return NULL;
9022 	if (!btf->kfunc_set_tab)
9023 		return NULL;
9024 	set = btf->kfunc_set_tab->sets[hook];
9025 	if (!set)
9026 		return NULL;
9027 	id = btf_id_set8_contains(set, kfunc_btf_id);
9028 	if (!id)
9029 		return NULL;
9030 	/* The flags for BTF ID are located next to it */
9031 	return id + 1;
9032 }
9033 
__btf_kfunc_is_allowed(const struct btf * btf,enum btf_kfunc_hook hook,u32 kfunc_btf_id,const struct bpf_prog * prog)9034 static bool __btf_kfunc_is_allowed(const struct btf *btf,
9035 				   enum btf_kfunc_hook hook,
9036 				   u32 kfunc_btf_id,
9037 				   const struct bpf_prog *prog)
9038 {
9039 	struct btf_kfunc_hook_filter *hook_filter;
9040 	int i;
9041 
9042 	if (hook >= BTF_KFUNC_HOOK_MAX)
9043 		return false;
9044 	if (!btf->kfunc_set_tab)
9045 		return false;
9046 
9047 	hook_filter = &btf->kfunc_set_tab->hook_filters[hook];
9048 	for (i = 0; i < hook_filter->nr_filters; i++) {
9049 		if (hook_filter->filters[i](prog, kfunc_btf_id))
9050 			return false;
9051 	}
9052 
9053 	return true;
9054 }
9055 
bpf_prog_type_to_kfunc_hook(enum bpf_prog_type prog_type)9056 static int bpf_prog_type_to_kfunc_hook(enum bpf_prog_type prog_type)
9057 {
9058 	switch (prog_type) {
9059 	case BPF_PROG_TYPE_UNSPEC:
9060 		return BTF_KFUNC_HOOK_COMMON;
9061 	case BPF_PROG_TYPE_XDP:
9062 		return BTF_KFUNC_HOOK_XDP;
9063 	case BPF_PROG_TYPE_SCHED_CLS:
9064 		return BTF_KFUNC_HOOK_TC;
9065 	case BPF_PROG_TYPE_STRUCT_OPS:
9066 		return BTF_KFUNC_HOOK_STRUCT_OPS;
9067 	case BPF_PROG_TYPE_TRACING:
9068 	case BPF_PROG_TYPE_TRACEPOINT:
9069 	case BPF_PROG_TYPE_RAW_TRACEPOINT:
9070 	case BPF_PROG_TYPE_PERF_EVENT:
9071 	case BPF_PROG_TYPE_LSM:
9072 		return BTF_KFUNC_HOOK_TRACING;
9073 	case BPF_PROG_TYPE_SYSCALL:
9074 		return BTF_KFUNC_HOOK_SYSCALL;
9075 	case BPF_PROG_TYPE_CGROUP_SKB:
9076 	case BPF_PROG_TYPE_CGROUP_SOCK:
9077 	case BPF_PROG_TYPE_CGROUP_DEVICE:
9078 	case BPF_PROG_TYPE_CGROUP_SOCK_ADDR:
9079 	case BPF_PROG_TYPE_CGROUP_SOCKOPT:
9080 	case BPF_PROG_TYPE_CGROUP_SYSCTL:
9081 	case BPF_PROG_TYPE_SOCK_OPS:
9082 		return BTF_KFUNC_HOOK_CGROUP;
9083 	case BPF_PROG_TYPE_SCHED_ACT:
9084 		return BTF_KFUNC_HOOK_SCHED_ACT;
9085 	case BPF_PROG_TYPE_SK_SKB:
9086 		return BTF_KFUNC_HOOK_SK_SKB;
9087 	case BPF_PROG_TYPE_SOCKET_FILTER:
9088 		return BTF_KFUNC_HOOK_SOCKET_FILTER;
9089 	case BPF_PROG_TYPE_LWT_OUT:
9090 	case BPF_PROG_TYPE_LWT_IN:
9091 	case BPF_PROG_TYPE_LWT_XMIT:
9092 	case BPF_PROG_TYPE_LWT_SEG6LOCAL:
9093 		return BTF_KFUNC_HOOK_LWT;
9094 	case BPF_PROG_TYPE_NETFILTER:
9095 		return BTF_KFUNC_HOOK_NETFILTER;
9096 	case BPF_PROG_TYPE_KPROBE:
9097 		return BTF_KFUNC_HOOK_KPROBE;
9098 	default:
9099 		return BTF_KFUNC_HOOK_MAX;
9100 	}
9101 }
9102 
btf_kfunc_is_allowed(const struct btf * btf,u32 kfunc_btf_id,const struct bpf_prog * prog)9103 bool btf_kfunc_is_allowed(const struct btf *btf,
9104 			  u32 kfunc_btf_id,
9105 			  const struct bpf_prog *prog)
9106 {
9107 	enum bpf_prog_type prog_type = resolve_prog_type(prog);
9108 	enum btf_kfunc_hook hook;
9109 	u32 *kfunc_flags;
9110 
9111 	kfunc_flags = btf_kfunc_id_set_contains(btf, BTF_KFUNC_HOOK_COMMON, kfunc_btf_id);
9112 	if (kfunc_flags && __btf_kfunc_is_allowed(btf, BTF_KFUNC_HOOK_COMMON, kfunc_btf_id, prog))
9113 		return true;
9114 
9115 	hook = bpf_prog_type_to_kfunc_hook(prog_type);
9116 	kfunc_flags = btf_kfunc_id_set_contains(btf, hook, kfunc_btf_id);
9117 	if (kfunc_flags && __btf_kfunc_is_allowed(btf, hook, kfunc_btf_id, prog))
9118 		return true;
9119 
9120 	return false;
9121 }
9122 
9123 /* Caution:
9124  * Reference to the module (obtained using btf_try_get_module) corresponding to
9125  * the struct btf *MUST* be held when calling this function from verifier
9126  * context. This is usually true as we stash references in prog's kfunc_btf_tab;
9127  * keeping the reference for the duration of the call provides the necessary
9128  * protection for looking up a well-formed btf->kfunc_set_tab.
9129  */
btf_kfunc_flags(const struct btf * btf,u32 kfunc_btf_id,const struct bpf_prog * prog)9130 u32 *btf_kfunc_flags(const struct btf *btf, u32 kfunc_btf_id, const struct bpf_prog *prog)
9131 {
9132 	enum bpf_prog_type prog_type = resolve_prog_type(prog);
9133 	enum btf_kfunc_hook hook;
9134 	u32 *kfunc_flags;
9135 
9136 	kfunc_flags = btf_kfunc_id_set_contains(btf, BTF_KFUNC_HOOK_COMMON, kfunc_btf_id);
9137 	if (kfunc_flags)
9138 		return kfunc_flags;
9139 
9140 	hook = bpf_prog_type_to_kfunc_hook(prog_type);
9141 	return btf_kfunc_id_set_contains(btf, hook, kfunc_btf_id);
9142 }
9143 
9144 /*
9145  * Check a single KF_* @flag on a kfunc across all of its hook sets.
9146  * Returns:
9147  *   * 1 if @flag is set
9148  *   * 0 if @flag is not set
9149  *   * -EINVAL if @flag is set inconsistently across the sets
9150  *   * -ENOENT if kfunc_btf_id is not a registered kfunc
9151  */
btf_kfunc_check_flag(const struct btf * btf,u32 kfunc_btf_id,u32 flag)9152 int btf_kfunc_check_flag(const struct btf *btf, u32 kfunc_btf_id, u32 flag)
9153 {
9154 	enum btf_kfunc_hook hook;
9155 	int res = -ENOENT;
9156 	bool is_set;
9157 	u32 *flags;
9158 
9159 	for (hook = 0; hook < BTF_KFUNC_HOOK_MAX; hook++) {
9160 		flags = btf_kfunc_id_set_contains(btf, hook, kfunc_btf_id);
9161 		if (!flags)
9162 			continue;
9163 		is_set = *flags & flag;
9164 		if (res < 0)
9165 			res = is_set;
9166 		else if (res != is_set)
9167 			return -EINVAL;
9168 	}
9169 
9170 	return res;
9171 }
9172 
btf_kfunc_is_modify_return(const struct btf * btf,u32 kfunc_btf_id,const struct bpf_prog * prog)9173 u32 *btf_kfunc_is_modify_return(const struct btf *btf, u32 kfunc_btf_id,
9174 				const struct bpf_prog *prog)
9175 {
9176 	if (!__btf_kfunc_is_allowed(btf, BTF_KFUNC_HOOK_FMODRET, kfunc_btf_id, prog))
9177 		return NULL;
9178 
9179 	return btf_kfunc_id_set_contains(btf, BTF_KFUNC_HOOK_FMODRET, kfunc_btf_id);
9180 }
9181 
__register_btf_kfunc_id_set(enum btf_kfunc_hook hook,const struct btf_kfunc_id_set * kset)9182 static int __register_btf_kfunc_id_set(enum btf_kfunc_hook hook,
9183 				       const struct btf_kfunc_id_set *kset)
9184 {
9185 	struct btf *btf;
9186 	int ret, i;
9187 
9188 	btf = btf_get_module_btf(kset->owner);
9189 	if (!btf)
9190 		return check_btf_kconfigs(kset->owner, "kfunc");
9191 	if (IS_ERR(btf))
9192 		return PTR_ERR(btf);
9193 
9194 	for (i = 0; i < kset->set->cnt; i++) {
9195 		ret = btf_check_kfunc_protos(btf, btf_relocate_id(btf, kset->set->pairs[i].id),
9196 					     kset->set->pairs[i].flags);
9197 		if (ret)
9198 			goto err_out;
9199 	}
9200 
9201 	ret = btf_populate_kfunc_set(btf, hook, kset);
9202 
9203 err_out:
9204 	btf_put(btf);
9205 	return ret;
9206 }
9207 
9208 /* This function must be invoked only from initcalls/module init functions */
register_btf_kfunc_id_set(enum bpf_prog_type prog_type,const struct btf_kfunc_id_set * kset)9209 int register_btf_kfunc_id_set(enum bpf_prog_type prog_type,
9210 			      const struct btf_kfunc_id_set *kset)
9211 {
9212 	enum btf_kfunc_hook hook;
9213 
9214 	/* All kfuncs need to be tagged as such in BTF.
9215 	 * WARN() for initcall registrations that do not check errors.
9216 	 */
9217 	if (!(kset->set->flags & BTF_SET8_KFUNCS)) {
9218 		WARN_ON(!kset->owner);
9219 		return -EINVAL;
9220 	}
9221 
9222 	hook = bpf_prog_type_to_kfunc_hook(prog_type);
9223 	return __register_btf_kfunc_id_set(hook, kset);
9224 }
9225 EXPORT_SYMBOL_GPL(register_btf_kfunc_id_set);
9226 
9227 /* This function must be invoked only from initcalls/module init functions */
register_btf_fmodret_id_set(const struct btf_kfunc_id_set * kset)9228 int register_btf_fmodret_id_set(const struct btf_kfunc_id_set *kset)
9229 {
9230 	return __register_btf_kfunc_id_set(BTF_KFUNC_HOOK_FMODRET, kset);
9231 }
9232 EXPORT_SYMBOL_GPL(register_btf_fmodret_id_set);
9233 
btf_find_dtor_kfunc(struct btf * btf,u32 btf_id)9234 s32 btf_find_dtor_kfunc(struct btf *btf, u32 btf_id)
9235 {
9236 	struct btf_id_dtor_kfunc_tab *tab = btf->dtor_kfunc_tab;
9237 	struct btf_id_dtor_kfunc *dtor;
9238 
9239 	if (!tab)
9240 		return -ENOENT;
9241 	/* Even though the size of tab->dtors[0] is > sizeof(u32), we only need
9242 	 * to compare the first u32 with btf_id, so we can reuse btf_id_cmp_func.
9243 	 */
9244 	BUILD_BUG_ON(offsetof(struct btf_id_dtor_kfunc, btf_id) != 0);
9245 	dtor = bsearch(&btf_id, tab->dtors, tab->cnt, sizeof(tab->dtors[0]), btf_id_cmp_func);
9246 	if (!dtor)
9247 		return -ENOENT;
9248 	return dtor->kfunc_btf_id;
9249 }
9250 
btf_check_dtor_kfuncs(struct btf * btf,const struct btf_id_dtor_kfunc * dtors,u32 cnt)9251 static int btf_check_dtor_kfuncs(struct btf *btf, const struct btf_id_dtor_kfunc *dtors, u32 cnt)
9252 {
9253 	const struct btf_type *dtor_func, *dtor_func_proto, *t;
9254 	const struct btf_param *args;
9255 	s32 dtor_btf_id;
9256 	u32 nr_args, i;
9257 
9258 	for (i = 0; i < cnt; i++) {
9259 		dtor_btf_id = btf_relocate_id(btf, dtors[i].kfunc_btf_id);
9260 
9261 		dtor_func = btf_type_by_id(btf, dtor_btf_id);
9262 		if (!dtor_func || !btf_type_is_func(dtor_func))
9263 			return -EINVAL;
9264 
9265 		dtor_func_proto = btf_type_by_id(btf, dtor_func->type);
9266 		if (!dtor_func_proto || !btf_type_is_func_proto(dtor_func_proto))
9267 			return -EINVAL;
9268 
9269 		/* Make sure the prototype of the destructor kfunc is 'void func(type *)' */
9270 		t = btf_type_by_id(btf, dtor_func_proto->type);
9271 		if (!t || !btf_type_is_void(t))
9272 			return -EINVAL;
9273 
9274 		nr_args = btf_type_vlen(dtor_func_proto);
9275 		if (nr_args != 1)
9276 			return -EINVAL;
9277 		args = btf_params(dtor_func_proto);
9278 		t = btf_type_by_id(btf, args[0].type);
9279 		/* Allow any pointer type, as width on targets Linux supports
9280 		 * will be same for all pointer types (i.e. sizeof(void *))
9281 		 */
9282 		if (!t || !btf_type_is_ptr(t))
9283 			return -EINVAL;
9284 
9285 		if (IS_ENABLED(CONFIG_CFI)) {
9286 			/* Ensure the destructor kfunc type matches btf_dtor_kfunc_t */
9287 			t = btf_type_by_id(btf, t->type);
9288 			if (!btf_type_is_void(t))
9289 				return -EINVAL;
9290 		}
9291 	}
9292 	return 0;
9293 }
9294 
9295 /* This function must be invoked only from initcalls/module init functions */
register_btf_id_dtor_kfuncs(const struct btf_id_dtor_kfunc * dtors,u32 add_cnt,struct module * owner)9296 int register_btf_id_dtor_kfuncs(const struct btf_id_dtor_kfunc *dtors, u32 add_cnt,
9297 				struct module *owner)
9298 {
9299 	struct btf_id_dtor_kfunc_tab *tab;
9300 	struct btf *btf;
9301 	u32 tab_cnt, i;
9302 	int ret;
9303 
9304 	btf = btf_get_module_btf(owner);
9305 	if (!btf)
9306 		return check_btf_kconfigs(owner, "dtor kfuncs");
9307 	if (IS_ERR(btf))
9308 		return PTR_ERR(btf);
9309 
9310 	if (add_cnt >= BTF_DTOR_KFUNC_MAX_CNT) {
9311 		pr_err("cannot register more than %d kfunc destructors\n", BTF_DTOR_KFUNC_MAX_CNT);
9312 		ret = -E2BIG;
9313 		goto end;
9314 	}
9315 
9316 	/* Ensure that the prototype of dtor kfuncs being registered is sane */
9317 	ret = btf_check_dtor_kfuncs(btf, dtors, add_cnt);
9318 	if (ret < 0)
9319 		goto end;
9320 
9321 	tab = btf->dtor_kfunc_tab;
9322 	/* Only one call allowed for modules */
9323 	if (WARN_ON_ONCE(tab && btf_is_module(btf))) {
9324 		ret = -EINVAL;
9325 		goto end;
9326 	}
9327 
9328 	tab_cnt = tab ? tab->cnt : 0;
9329 	if (tab_cnt > U32_MAX - add_cnt) {
9330 		ret = -EOVERFLOW;
9331 		goto end;
9332 	}
9333 	if (tab_cnt + add_cnt >= BTF_DTOR_KFUNC_MAX_CNT) {
9334 		pr_err("cannot register more than %d kfunc destructors\n", BTF_DTOR_KFUNC_MAX_CNT);
9335 		ret = -E2BIG;
9336 		goto end;
9337 	}
9338 
9339 	tab = krealloc(btf->dtor_kfunc_tab,
9340 		       struct_size(tab, dtors, tab_cnt + add_cnt),
9341 		       GFP_KERNEL | __GFP_NOWARN);
9342 	if (!tab) {
9343 		ret = -ENOMEM;
9344 		goto end;
9345 	}
9346 
9347 	if (!btf->dtor_kfunc_tab)
9348 		tab->cnt = 0;
9349 	btf->dtor_kfunc_tab = tab;
9350 
9351 	memcpy(tab->dtors + tab->cnt, dtors, add_cnt * sizeof(tab->dtors[0]));
9352 
9353 	/* remap BTF ids based on BTF relocation (if any) */
9354 	for (i = tab_cnt; i < tab_cnt + add_cnt; i++) {
9355 		tab->dtors[i].btf_id = btf_relocate_id(btf, tab->dtors[i].btf_id);
9356 		tab->dtors[i].kfunc_btf_id = btf_relocate_id(btf, tab->dtors[i].kfunc_btf_id);
9357 	}
9358 
9359 	tab->cnt += add_cnt;
9360 
9361 	sort(tab->dtors, tab->cnt, sizeof(tab->dtors[0]), btf_id_cmp_func, NULL);
9362 
9363 end:
9364 	if (ret)
9365 		btf_free_dtor_kfunc_tab(btf);
9366 	btf_put(btf);
9367 	return ret;
9368 }
9369 EXPORT_SYMBOL_GPL(register_btf_id_dtor_kfuncs);
9370 
9371 #define MAX_TYPES_ARE_COMPAT_DEPTH 2
9372 
9373 /* Check local and target types for compatibility. This check is used for
9374  * type-based CO-RE relocations and follow slightly different rules than
9375  * field-based relocations. This function assumes that root types were already
9376  * checked for name match. Beyond that initial root-level name check, names
9377  * are completely ignored. Compatibility rules are as follows:
9378  *   - any two STRUCTs/UNIONs/FWDs/ENUMs/INTs/ENUM64s are considered compatible, but
9379  *     kind should match for local and target types (i.e., STRUCT is not
9380  *     compatible with UNION);
9381  *   - for ENUMs/ENUM64s, the size is ignored;
9382  *   - for INT, size and signedness are ignored;
9383  *   - for ARRAY, dimensionality is ignored, element types are checked for
9384  *     compatibility recursively;
9385  *   - CONST/VOLATILE/RESTRICT modifiers are ignored;
9386  *   - TYPEDEFs/PTRs are compatible if types they pointing to are compatible;
9387  *   - FUNC_PROTOs are compatible if they have compatible signature: same
9388  *     number of input args and compatible return and argument types.
9389  * These rules are not set in stone and probably will be adjusted as we get
9390  * more experience with using BPF CO-RE relocations.
9391  */
bpf_core_types_are_compat(const struct btf * local_btf,__u32 local_id,const struct btf * targ_btf,__u32 targ_id)9392 int bpf_core_types_are_compat(const struct btf *local_btf, __u32 local_id,
9393 			      const struct btf *targ_btf, __u32 targ_id)
9394 {
9395 	return __bpf_core_types_are_compat(local_btf, local_id, targ_btf, targ_id,
9396 					   MAX_TYPES_ARE_COMPAT_DEPTH);
9397 }
9398 
9399 #define MAX_TYPES_MATCH_DEPTH 2
9400 
bpf_core_types_match(const struct btf * local_btf,u32 local_id,const struct btf * targ_btf,u32 targ_id)9401 int bpf_core_types_match(const struct btf *local_btf, u32 local_id,
9402 			 const struct btf *targ_btf, u32 targ_id)
9403 {
9404 	return __bpf_core_types_match(local_btf, local_id, targ_btf, targ_id, false,
9405 				      MAX_TYPES_MATCH_DEPTH);
9406 }
9407 
bpf_core_is_flavor_sep(const char * s)9408 static bool bpf_core_is_flavor_sep(const char *s)
9409 {
9410 	/* check X___Y name pattern, where X and Y are not underscores */
9411 	return s[0] != '_' &&				      /* X */
9412 	       s[1] == '_' && s[2] == '_' && s[3] == '_' &&   /* ___ */
9413 	       s[4] != '_';				      /* Y */
9414 }
9415 
bpf_core_essential_name_len(const char * name)9416 size_t bpf_core_essential_name_len(const char *name)
9417 {
9418 	size_t n = strlen(name);
9419 	int i;
9420 
9421 	for (i = n - 5; i >= 0; i--) {
9422 		if (bpf_core_is_flavor_sep(name + i))
9423 			return i + 1;
9424 	}
9425 	return n;
9426 }
9427 
bpf_free_cands(struct bpf_cand_cache * cands)9428 static void bpf_free_cands(struct bpf_cand_cache *cands)
9429 {
9430 	if (!cands->cnt)
9431 		/* empty candidate array was allocated on stack */
9432 		return;
9433 	kfree(cands);
9434 }
9435 
bpf_free_cands_from_cache(struct bpf_cand_cache * cands)9436 static void bpf_free_cands_from_cache(struct bpf_cand_cache *cands)
9437 {
9438 	kfree(cands->name);
9439 	kfree(cands);
9440 }
9441 
9442 #define VMLINUX_CAND_CACHE_SIZE 31
9443 static struct bpf_cand_cache *vmlinux_cand_cache[VMLINUX_CAND_CACHE_SIZE];
9444 
9445 #define MODULE_CAND_CACHE_SIZE 31
9446 static struct bpf_cand_cache *module_cand_cache[MODULE_CAND_CACHE_SIZE];
9447 
__print_cand_cache(struct bpf_verifier_log * log,struct bpf_cand_cache ** cache,int cache_size)9448 static void __print_cand_cache(struct bpf_verifier_log *log,
9449 			       struct bpf_cand_cache **cache,
9450 			       int cache_size)
9451 {
9452 	struct bpf_cand_cache *cc;
9453 	int i, j;
9454 
9455 	for (i = 0; i < cache_size; i++) {
9456 		cc = cache[i];
9457 		if (!cc)
9458 			continue;
9459 		bpf_log(log, "[%d]%s(", i, cc->name);
9460 		for (j = 0; j < cc->cnt; j++) {
9461 			bpf_log(log, "%d", cc->cands[j].id);
9462 			if (j < cc->cnt - 1)
9463 				bpf_log(log, " ");
9464 		}
9465 		bpf_log(log, "), ");
9466 	}
9467 }
9468 
print_cand_cache(struct bpf_verifier_log * log)9469 static void print_cand_cache(struct bpf_verifier_log *log)
9470 {
9471 	mutex_lock(&cand_cache_mutex);
9472 	bpf_log(log, "vmlinux_cand_cache:");
9473 	__print_cand_cache(log, vmlinux_cand_cache, VMLINUX_CAND_CACHE_SIZE);
9474 	bpf_log(log, "\nmodule_cand_cache:");
9475 	__print_cand_cache(log, module_cand_cache, MODULE_CAND_CACHE_SIZE);
9476 	bpf_log(log, "\n");
9477 	mutex_unlock(&cand_cache_mutex);
9478 }
9479 
hash_cands(struct bpf_cand_cache * cands)9480 static u32 hash_cands(struct bpf_cand_cache *cands)
9481 {
9482 	return jhash(cands->name, cands->name_len, 0);
9483 }
9484 
check_cand_cache(struct bpf_cand_cache * cands,struct bpf_cand_cache ** cache,int cache_size)9485 static struct bpf_cand_cache *check_cand_cache(struct bpf_cand_cache *cands,
9486 					       struct bpf_cand_cache **cache,
9487 					       int cache_size)
9488 {
9489 	struct bpf_cand_cache *cc = cache[hash_cands(cands) % cache_size];
9490 
9491 	if (cc && cc->name_len == cands->name_len &&
9492 	    !strncmp(cc->name, cands->name, cands->name_len))
9493 		return cc;
9494 	return NULL;
9495 }
9496 
sizeof_cands(int cnt)9497 static size_t sizeof_cands(int cnt)
9498 {
9499 	return offsetof(struct bpf_cand_cache, cands[cnt]);
9500 }
9501 
populate_cand_cache(struct bpf_cand_cache * cands,struct bpf_cand_cache ** cache,int cache_size)9502 static struct bpf_cand_cache *populate_cand_cache(struct bpf_cand_cache *cands,
9503 						  struct bpf_cand_cache **cache,
9504 						  int cache_size)
9505 {
9506 	struct bpf_cand_cache **cc = &cache[hash_cands(cands) % cache_size], *new_cands;
9507 
9508 	if (*cc) {
9509 		bpf_free_cands_from_cache(*cc);
9510 		*cc = NULL;
9511 	}
9512 	new_cands = kmemdup(cands, sizeof_cands(cands->cnt), GFP_KERNEL_ACCOUNT);
9513 	if (!new_cands) {
9514 		bpf_free_cands(cands);
9515 		return ERR_PTR(-ENOMEM);
9516 	}
9517 	/* strdup the name, since it will stay in cache.
9518 	 * the cands->name points to strings in prog's BTF and the prog can be unloaded.
9519 	 */
9520 	new_cands->name = kmemdup_nul(cands->name, cands->name_len, GFP_KERNEL_ACCOUNT);
9521 	bpf_free_cands(cands);
9522 	if (!new_cands->name) {
9523 		kfree(new_cands);
9524 		return ERR_PTR(-ENOMEM);
9525 	}
9526 	*cc = new_cands;
9527 	return new_cands;
9528 }
9529 
9530 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
__purge_cand_cache(struct btf * btf,struct bpf_cand_cache ** cache,int cache_size)9531 static void __purge_cand_cache(struct btf *btf, struct bpf_cand_cache **cache,
9532 			       int cache_size)
9533 {
9534 	struct bpf_cand_cache *cc;
9535 	int i, j;
9536 
9537 	for (i = 0; i < cache_size; i++) {
9538 		cc = cache[i];
9539 		if (!cc)
9540 			continue;
9541 		if (!btf) {
9542 			/* when new module is loaded purge all of module_cand_cache,
9543 			 * since new module might have candidates with the name
9544 			 * that matches cached cands.
9545 			 */
9546 			bpf_free_cands_from_cache(cc);
9547 			cache[i] = NULL;
9548 			continue;
9549 		}
9550 		/* when module is unloaded purge cache entries
9551 		 * that match module's btf
9552 		 */
9553 		for (j = 0; j < cc->cnt; j++)
9554 			if (cc->cands[j].btf == btf) {
9555 				bpf_free_cands_from_cache(cc);
9556 				cache[i] = NULL;
9557 				break;
9558 			}
9559 	}
9560 
9561 }
9562 
purge_cand_cache(struct btf * btf)9563 static void purge_cand_cache(struct btf *btf)
9564 {
9565 	mutex_lock(&cand_cache_mutex);
9566 	__purge_cand_cache(btf, module_cand_cache, MODULE_CAND_CACHE_SIZE);
9567 	mutex_unlock(&cand_cache_mutex);
9568 }
9569 #endif
9570 
9571 static struct bpf_cand_cache *
bpf_core_add_cands(struct bpf_cand_cache * cands,const struct btf * targ_btf,int targ_start_id)9572 bpf_core_add_cands(struct bpf_cand_cache *cands, const struct btf *targ_btf,
9573 		   int targ_start_id)
9574 {
9575 	struct bpf_cand_cache *new_cands;
9576 	const struct btf_type *t;
9577 	const char *targ_name;
9578 	size_t targ_essent_len;
9579 	int n, i;
9580 
9581 	n = btf_nr_types(targ_btf);
9582 	for (i = targ_start_id; i < n; i++) {
9583 		t = btf_type_by_id(targ_btf, i);
9584 		if (btf_kind(t) != cands->kind)
9585 			continue;
9586 
9587 		targ_name = btf_name_by_offset(targ_btf, t->name_off);
9588 		if (!targ_name)
9589 			continue;
9590 
9591 		/* the resched point is before strncmp to make sure that search
9592 		 * for non-existing name will have a chance to schedule().
9593 		 */
9594 		cond_resched();
9595 
9596 		if (strncmp(cands->name, targ_name, cands->name_len) != 0)
9597 			continue;
9598 
9599 		targ_essent_len = bpf_core_essential_name_len(targ_name);
9600 		if (targ_essent_len != cands->name_len)
9601 			continue;
9602 
9603 		/* most of the time there is only one candidate for a given kind+name pair */
9604 		new_cands = kmalloc(sizeof_cands(cands->cnt + 1), GFP_KERNEL_ACCOUNT);
9605 		if (!new_cands) {
9606 			bpf_free_cands(cands);
9607 			return ERR_PTR(-ENOMEM);
9608 		}
9609 
9610 		memcpy(new_cands, cands, sizeof_cands(cands->cnt));
9611 		bpf_free_cands(cands);
9612 		cands = new_cands;
9613 		cands->cands[cands->cnt].btf = targ_btf;
9614 		cands->cands[cands->cnt].id = i;
9615 		cands->cnt++;
9616 	}
9617 	return cands;
9618 }
9619 
9620 static struct bpf_cand_cache *
bpf_core_find_cands(struct bpf_core_ctx * ctx,u32 local_type_id)9621 bpf_core_find_cands(struct bpf_core_ctx *ctx, u32 local_type_id)
9622 {
9623 	struct bpf_cand_cache *cands, *cc, local_cand = {};
9624 	const struct btf *local_btf = ctx->btf;
9625 	const struct btf_type *local_type;
9626 	const struct btf *main_btf;
9627 	size_t local_essent_len;
9628 	struct btf *mod_btf;
9629 	const char *name;
9630 	int id;
9631 
9632 	main_btf = bpf_get_btf_vmlinux();
9633 	if (IS_ERR(main_btf))
9634 		return ERR_CAST(main_btf);
9635 	if (!main_btf)
9636 		return ERR_PTR(-EINVAL);
9637 
9638 	local_type = btf_type_by_id(local_btf, local_type_id);
9639 	if (!local_type)
9640 		return ERR_PTR(-EINVAL);
9641 
9642 	name = btf_name_by_offset(local_btf, local_type->name_off);
9643 	if (str_is_empty(name))
9644 		return ERR_PTR(-EINVAL);
9645 	local_essent_len = bpf_core_essential_name_len(name);
9646 
9647 	cands = &local_cand;
9648 	cands->name = name;
9649 	cands->kind = btf_kind(local_type);
9650 	cands->name_len = local_essent_len;
9651 
9652 	cc = check_cand_cache(cands, vmlinux_cand_cache, VMLINUX_CAND_CACHE_SIZE);
9653 	/* cands is a pointer to stack here */
9654 	if (cc) {
9655 		if (cc->cnt)
9656 			return cc;
9657 		goto check_modules;
9658 	}
9659 
9660 	/* Attempt to find target candidates in vmlinux BTF first */
9661 	cands = bpf_core_add_cands(cands, main_btf, btf_named_start_id(main_btf, true));
9662 	if (IS_ERR(cands))
9663 		return ERR_CAST(cands);
9664 
9665 	/* cands is a pointer to kmalloced memory here if cands->cnt > 0 */
9666 
9667 	/* populate cache even when cands->cnt == 0 */
9668 	cc = populate_cand_cache(cands, vmlinux_cand_cache, VMLINUX_CAND_CACHE_SIZE);
9669 	if (IS_ERR(cc))
9670 		return ERR_CAST(cc);
9671 
9672 	/* if vmlinux BTF has any candidate, don't go for module BTFs */
9673 	if (cc->cnt)
9674 		return cc;
9675 
9676 check_modules:
9677 	/* cands is a pointer to stack here and cands->cnt == 0 */
9678 	cc = check_cand_cache(cands, module_cand_cache, MODULE_CAND_CACHE_SIZE);
9679 	if (cc)
9680 		/* if cache has it return it even if cc->cnt == 0 */
9681 		return cc;
9682 
9683 	/* If candidate is not found in vmlinux's BTF then search in module's BTFs */
9684 	spin_lock_bh(&btf_idr_lock);
9685 	idr_for_each_entry(&btf_idr, mod_btf, id) {
9686 		if (!btf_is_module(mod_btf))
9687 			continue;
9688 		/* linear search could be slow hence unlock/lock
9689 		 * the IDR to avoiding holding it for too long
9690 		 */
9691 		btf_get(mod_btf);
9692 		spin_unlock_bh(&btf_idr_lock);
9693 		cands = bpf_core_add_cands(cands, mod_btf, btf_named_start_id(mod_btf, true));
9694 		btf_put(mod_btf);
9695 		if (IS_ERR(cands))
9696 			return ERR_CAST(cands);
9697 		spin_lock_bh(&btf_idr_lock);
9698 	}
9699 	spin_unlock_bh(&btf_idr_lock);
9700 	/* cands is a pointer to kmalloced memory here if cands->cnt > 0
9701 	 * or pointer to stack if cands->cnd == 0.
9702 	 * Copy it into the cache even when cands->cnt == 0 and
9703 	 * return the result.
9704 	 */
9705 	return populate_cand_cache(cands, module_cand_cache, MODULE_CAND_CACHE_SIZE);
9706 }
9707 
bpf_core_apply(struct bpf_core_ctx * ctx,const struct bpf_core_relo * relo,int relo_idx,void * insn)9708 int bpf_core_apply(struct bpf_core_ctx *ctx, const struct bpf_core_relo *relo,
9709 		   int relo_idx, void *insn)
9710 {
9711 	bool need_cands = relo->kind != BPF_CORE_TYPE_ID_LOCAL;
9712 	struct bpf_core_cand_list cands = {};
9713 	struct bpf_core_relo_res targ_res;
9714 	struct bpf_core_spec *specs;
9715 	const struct btf_type *type;
9716 	int err;
9717 
9718 	/* ~4k of temp memory necessary to convert LLVM spec like "0:1:0:5"
9719 	 * into arrays of btf_ids of struct fields and array indices.
9720 	 */
9721 	specs = kzalloc_objs(*specs, 3, GFP_KERNEL_ACCOUNT);
9722 	if (!specs)
9723 		return -ENOMEM;
9724 
9725 	type = btf_type_by_id(ctx->btf, relo->type_id);
9726 	if (!type) {
9727 		bpf_log(ctx->log, "relo #%u: bad type id %u\n",
9728 			relo_idx, relo->type_id);
9729 		kfree(specs);
9730 		return -EINVAL;
9731 	}
9732 
9733 	if (need_cands) {
9734 		struct bpf_cand_cache *cc;
9735 		int i;
9736 
9737 		mutex_lock(&cand_cache_mutex);
9738 		cc = bpf_core_find_cands(ctx, relo->type_id);
9739 		if (IS_ERR(cc)) {
9740 			bpf_log(ctx->log, "target candidate search failed for %d\n",
9741 				relo->type_id);
9742 			err = PTR_ERR(cc);
9743 			goto out;
9744 		}
9745 		if (cc->cnt) {
9746 			cands.cands = kzalloc_objs(*cands.cands, cc->cnt,
9747 						   GFP_KERNEL_ACCOUNT);
9748 			if (!cands.cands) {
9749 				err = -ENOMEM;
9750 				goto out;
9751 			}
9752 		}
9753 		for (i = 0; i < cc->cnt; i++) {
9754 			bpf_log(ctx->log,
9755 				"CO-RE relocating %s %s: found target candidate [%d]\n",
9756 				btf_kind_str[cc->kind], cc->name, cc->cands[i].id);
9757 			cands.cands[i].btf = cc->cands[i].btf;
9758 			cands.cands[i].id = cc->cands[i].id;
9759 		}
9760 		cands.len = cc->cnt;
9761 		/* cand_cache_mutex needs to span the cache lookup and
9762 		 * copy of btf pointer into bpf_core_cand_list,
9763 		 * since module can be unloaded while bpf_core_calc_relo_insn
9764 		 * is working with module's btf.
9765 		 */
9766 	}
9767 
9768 	err = bpf_core_calc_relo_insn((void *)ctx->log, relo, relo_idx, ctx->btf, &cands, specs,
9769 				      &targ_res);
9770 	if (err)
9771 		goto out;
9772 
9773 	err = bpf_core_patch_insn((void *)ctx->log, insn, relo->insn_off / 8, relo, relo_idx,
9774 				  &targ_res);
9775 
9776 out:
9777 	kfree(specs);
9778 	if (need_cands) {
9779 		kfree(cands.cands);
9780 		mutex_unlock(&cand_cache_mutex);
9781 		if (ctx->log->level & BPF_LOG_LEVEL2)
9782 			print_cand_cache(ctx->log);
9783 	}
9784 	return err;
9785 }
9786 
btf_nested_type_is_trusted(struct bpf_verifier_log * log,const struct bpf_reg_state * reg,const char * field_name,u32 btf_id,const char * suffix)9787 bool btf_nested_type_is_trusted(struct bpf_verifier_log *log,
9788 				const struct bpf_reg_state *reg,
9789 				const char *field_name, u32 btf_id, const char *suffix)
9790 {
9791 	struct btf *btf = reg->btf;
9792 	const struct btf_type *walk_type, *safe_type;
9793 	const char *tname;
9794 	char safe_tname[64];
9795 	long ret, safe_id;
9796 	const struct btf_member *member;
9797 	u32 i;
9798 
9799 	walk_type = btf_type_by_id(btf, reg->btf_id);
9800 	if (!walk_type)
9801 		return false;
9802 
9803 	tname = btf_name_by_offset(btf, walk_type->name_off);
9804 
9805 	ret = snprintf(safe_tname, sizeof(safe_tname), "%s%s", tname, suffix);
9806 	if (ret >= sizeof(safe_tname))
9807 		return false;
9808 
9809 	safe_id = btf_find_by_name_kind(btf, safe_tname, BTF_INFO_KIND(walk_type->info));
9810 	if (safe_id < 0)
9811 		return false;
9812 
9813 	safe_type = btf_type_by_id(btf, safe_id);
9814 	if (!safe_type)
9815 		return false;
9816 
9817 	for_each_member(i, safe_type, member) {
9818 		const char *m_name = __btf_name_by_offset(btf, member->name_off);
9819 		const struct btf_type *mtype = btf_type_by_id(btf, member->type);
9820 		u32 id;
9821 
9822 		if (!btf_type_is_ptr(mtype))
9823 			continue;
9824 
9825 		btf_type_skip_modifiers(btf, mtype->type, &id);
9826 		/* If we match on both type and name, the field is considered trusted. */
9827 		if (btf_id == id && !strcmp(field_name, m_name))
9828 			return true;
9829 	}
9830 
9831 	return false;
9832 }
9833 
btf_type_ids_nocast_alias(struct bpf_verifier_log * log,const struct btf * reg_btf,u32 reg_id,const struct btf * arg_btf,u32 arg_id)9834 bool btf_type_ids_nocast_alias(struct bpf_verifier_log *log,
9835 			       const struct btf *reg_btf, u32 reg_id,
9836 			       const struct btf *arg_btf, u32 arg_id)
9837 {
9838 	const char *reg_name, *arg_name, *search_needle;
9839 	const struct btf_type *reg_type, *arg_type;
9840 	int reg_len, arg_len, cmp_len;
9841 	size_t pattern_len = sizeof(NOCAST_ALIAS_SUFFIX) - sizeof(char);
9842 
9843 	reg_type = btf_type_by_id(reg_btf, reg_id);
9844 	if (!reg_type)
9845 		return false;
9846 
9847 	arg_type = btf_type_by_id(arg_btf, arg_id);
9848 	if (!arg_type)
9849 		return false;
9850 
9851 	reg_name = btf_name_by_offset(reg_btf, reg_type->name_off);
9852 	arg_name = btf_name_by_offset(arg_btf, arg_type->name_off);
9853 
9854 	reg_len = strlen(reg_name);
9855 	arg_len = strlen(arg_name);
9856 
9857 	/* Exactly one of the two type names may be suffixed with ___init, so
9858 	 * if the strings are the same size, they can't possibly be no-cast
9859 	 * aliases of one another. If you have two of the same type names, e.g.
9860 	 * they're both nf_conn___init, it would be improper to return true
9861 	 * because they are _not_ no-cast aliases, they are the same type.
9862 	 */
9863 	if (reg_len == arg_len)
9864 		return false;
9865 
9866 	/* Either of the two names must be the other name, suffixed with ___init. */
9867 	if ((reg_len != arg_len + pattern_len) &&
9868 	    (arg_len != reg_len + pattern_len))
9869 		return false;
9870 
9871 	if (reg_len < arg_len) {
9872 		search_needle = strstr(arg_name, NOCAST_ALIAS_SUFFIX);
9873 		cmp_len = reg_len;
9874 	} else {
9875 		search_needle = strstr(reg_name, NOCAST_ALIAS_SUFFIX);
9876 		cmp_len = arg_len;
9877 	}
9878 
9879 	if (!search_needle)
9880 		return false;
9881 
9882 	/* ___init suffix must come at the end of the name */
9883 	if (*(search_needle + pattern_len) != '\0')
9884 		return false;
9885 
9886 	return !strncmp(reg_name, arg_name, cmp_len);
9887 }
9888 
9889 #ifdef CONFIG_BPF_JIT
9890 static int
btf_add_struct_ops(struct btf * btf,struct bpf_struct_ops * st_ops,struct bpf_verifier_log * log)9891 btf_add_struct_ops(struct btf *btf, struct bpf_struct_ops *st_ops,
9892 		   struct bpf_verifier_log *log)
9893 {
9894 	struct btf_struct_ops_tab *tab, *new_tab;
9895 	int i, err;
9896 
9897 	tab = btf->struct_ops_tab;
9898 	if (!tab) {
9899 		tab = kzalloc_flex(*tab, ops, 4);
9900 		if (!tab)
9901 			return -ENOMEM;
9902 		tab->capacity = 4;
9903 		btf->struct_ops_tab = tab;
9904 	}
9905 
9906 	for (i = 0; i < tab->cnt; i++)
9907 		if (tab->ops[i].st_ops == st_ops)
9908 			return -EEXIST;
9909 
9910 	if (tab->cnt == tab->capacity) {
9911 		new_tab = krealloc(tab,
9912 				   struct_size(tab, ops, tab->capacity * 2),
9913 				   GFP_KERNEL);
9914 		if (!new_tab)
9915 			return -ENOMEM;
9916 		tab = new_tab;
9917 		tab->capacity *= 2;
9918 		btf->struct_ops_tab = tab;
9919 	}
9920 
9921 	tab->ops[btf->struct_ops_tab->cnt].st_ops = st_ops;
9922 
9923 	err = bpf_struct_ops_desc_init(&tab->ops[btf->struct_ops_tab->cnt], btf, log);
9924 	if (err)
9925 		return err;
9926 
9927 	btf->struct_ops_tab->cnt++;
9928 
9929 	return 0;
9930 }
9931 
9932 const struct bpf_struct_ops_desc *
bpf_struct_ops_find_value(struct btf * btf,u32 value_id)9933 bpf_struct_ops_find_value(struct btf *btf, u32 value_id)
9934 {
9935 	const struct bpf_struct_ops_desc *st_ops_list;
9936 	unsigned int i;
9937 	u32 cnt;
9938 
9939 	if (!value_id)
9940 		return NULL;
9941 	if (!btf->struct_ops_tab)
9942 		return NULL;
9943 
9944 	cnt = btf->struct_ops_tab->cnt;
9945 	st_ops_list = btf->struct_ops_tab->ops;
9946 	for (i = 0; i < cnt; i++) {
9947 		if (st_ops_list[i].value_id == value_id)
9948 			return &st_ops_list[i];
9949 	}
9950 
9951 	return NULL;
9952 }
9953 
9954 const struct bpf_struct_ops_desc *
bpf_struct_ops_find(struct btf * btf,u32 type_id)9955 bpf_struct_ops_find(struct btf *btf, u32 type_id)
9956 {
9957 	const struct bpf_struct_ops_desc *st_ops_list;
9958 	unsigned int i;
9959 	u32 cnt;
9960 
9961 	if (!type_id)
9962 		return NULL;
9963 	if (!btf->struct_ops_tab)
9964 		return NULL;
9965 
9966 	cnt = btf->struct_ops_tab->cnt;
9967 	st_ops_list = btf->struct_ops_tab->ops;
9968 	for (i = 0; i < cnt; i++) {
9969 		if (st_ops_list[i].type_id == type_id)
9970 			return &st_ops_list[i];
9971 	}
9972 
9973 	return NULL;
9974 }
9975 
__register_bpf_struct_ops(struct bpf_struct_ops * st_ops)9976 int __register_bpf_struct_ops(struct bpf_struct_ops *st_ops)
9977 {
9978 	struct bpf_verifier_log *log;
9979 	struct btf *btf;
9980 	int err = 0;
9981 
9982 	btf = btf_get_module_btf(st_ops->owner);
9983 	if (!btf)
9984 		return check_btf_kconfigs(st_ops->owner, "struct_ops");
9985 	if (IS_ERR(btf))
9986 		return PTR_ERR(btf);
9987 
9988 	log = kzalloc_obj(*log, GFP_KERNEL | __GFP_NOWARN);
9989 	if (!log) {
9990 		err = -ENOMEM;
9991 		goto errout;
9992 	}
9993 
9994 	log->level = BPF_LOG_KERNEL;
9995 
9996 	err = btf_add_struct_ops(btf, st_ops, log);
9997 
9998 errout:
9999 	kfree(log);
10000 	btf_put(btf);
10001 
10002 	return err;
10003 }
10004 EXPORT_SYMBOL_GPL(__register_bpf_struct_ops);
10005 #endif
10006 
btf_param_match_suffix(const struct btf * btf,const struct btf_param * arg,const char * suffix)10007 bool btf_param_match_suffix(const struct btf *btf,
10008 			    const struct btf_param *arg,
10009 			    const char *suffix)
10010 {
10011 	int suffix_len = strlen(suffix), len;
10012 	const char *param_name;
10013 
10014 	/* In the future, this can be ported to use BTF tagging */
10015 	param_name = btf_name_by_offset(btf, arg->name_off);
10016 	if (str_is_empty(param_name))
10017 		return false;
10018 	len = strlen(param_name);
10019 	if (len <= suffix_len)
10020 		return false;
10021 	param_name += len - suffix_len;
10022 	return !strncmp(param_name, suffix, suffix_len);
10023 }
10024