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 /*
2915 * A modifier can resolve to void, which has no show op; print a
2916 * placeholder rather than dereferencing NULL.
2917 */
2918 if (!btf_type_ops(t))
2919 btf_df_show(btf, t, type_id, data, bits_offset, show);
2920 else
2921 btf_type_ops(t)->show(btf, t, type_id, data, bits_offset, show);
2922 }
2923
btf_var_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)2924 static void btf_var_show(const struct btf *btf, const struct btf_type *t,
2925 u32 type_id, void *data, u8 bits_offset,
2926 struct btf_show *show)
2927 {
2928 /*
2929 * btf_type_id_resolve() dereferences btf->resolved_ids, which is NULL
2930 * for a base BTF (e.g. the vmlinux BTF that bpf_snprintf_btf() uses).
2931 * Resolve the var's type directly in that case.
2932 */
2933 if (btf->resolved_ids)
2934 t = btf_type_id_resolve(btf, &type_id);
2935 else
2936 t = btf_type_skip_modifiers(btf, t->type, &type_id);
2937
2938 btf_type_ops(t)->show(btf, t, type_id, data, bits_offset, show);
2939 }
2940
btf_ptr_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)2941 static void btf_ptr_show(const struct btf *btf, const struct btf_type *t,
2942 u32 type_id, void *data, u8 bits_offset,
2943 struct btf_show *show)
2944 {
2945 void *safe_data;
2946
2947 safe_data = btf_show_start_type(show, t, type_id, data);
2948 if (!safe_data)
2949 return;
2950
2951 /* It is a hashed value unless BTF_SHOW_PTR_RAW is specified */
2952 if (show->flags & BTF_SHOW_PTR_RAW)
2953 btf_show_type_value(show, "0x%px", *(void **)safe_data);
2954 else
2955 btf_show_type_value(show, "0x%p", *(void **)safe_data);
2956 btf_show_end_type(show);
2957 }
2958
btf_ref_type_log(struct btf_verifier_env * env,const struct btf_type * t)2959 static void btf_ref_type_log(struct btf_verifier_env *env,
2960 const struct btf_type *t)
2961 {
2962 btf_verifier_log(env, "type_id=%u", t->type);
2963 }
2964
2965 static const struct btf_kind_operations modifier_ops = {
2966 .check_meta = btf_ref_type_check_meta,
2967 .resolve = btf_modifier_resolve,
2968 .check_member = btf_modifier_check_member,
2969 .check_kflag_member = btf_modifier_check_kflag_member,
2970 .log_details = btf_ref_type_log,
2971 .show = btf_modifier_show,
2972 };
2973
2974 static const struct btf_kind_operations ptr_ops = {
2975 .check_meta = btf_ref_type_check_meta,
2976 .resolve = btf_ptr_resolve,
2977 .check_member = btf_ptr_check_member,
2978 .check_kflag_member = btf_generic_check_kflag_member,
2979 .log_details = btf_ref_type_log,
2980 .show = btf_ptr_show,
2981 };
2982
btf_fwd_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)2983 static s32 btf_fwd_check_meta(struct btf_verifier_env *env,
2984 const struct btf_type *t,
2985 u32 meta_left)
2986 {
2987 if (btf_type_vlen(t)) {
2988 btf_verifier_log_type(env, t, "vlen != 0");
2989 return -EINVAL;
2990 }
2991
2992 if (t->type) {
2993 btf_verifier_log_type(env, t, "type != 0");
2994 return -EINVAL;
2995 }
2996
2997 /* fwd type must have a valid name */
2998 if (!t->name_off ||
2999 !btf_name_valid_identifier(env->btf, t->name_off)) {
3000 btf_verifier_log_type(env, t, "Invalid name");
3001 return -EINVAL;
3002 }
3003
3004 btf_verifier_log_type(env, t, NULL);
3005
3006 return 0;
3007 }
3008
btf_fwd_type_log(struct btf_verifier_env * env,const struct btf_type * t)3009 static void btf_fwd_type_log(struct btf_verifier_env *env,
3010 const struct btf_type *t)
3011 {
3012 btf_verifier_log(env, "%s", btf_type_kflag(t) ? "union" : "struct");
3013 }
3014
3015 static const struct btf_kind_operations fwd_ops = {
3016 .check_meta = btf_fwd_check_meta,
3017 .resolve = btf_df_resolve,
3018 .check_member = btf_df_check_member,
3019 .check_kflag_member = btf_df_check_kflag_member,
3020 .log_details = btf_fwd_type_log,
3021 .show = btf_df_show,
3022 };
3023
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)3024 static int btf_array_check_member(struct btf_verifier_env *env,
3025 const struct btf_type *struct_type,
3026 const struct btf_member *member,
3027 const struct btf_type *member_type)
3028 {
3029 u32 struct_bits_off = member->offset;
3030 u32 struct_size, bytes_offset;
3031 u32 array_type_id, array_size;
3032 struct btf *btf = env->btf;
3033
3034 if (BITS_PER_BYTE_MASKED(struct_bits_off)) {
3035 btf_verifier_log_member(env, struct_type, member,
3036 "Member is not byte aligned");
3037 return -EINVAL;
3038 }
3039
3040 array_type_id = member->type;
3041 btf_type_id_size(btf, &array_type_id, &array_size);
3042 struct_size = struct_type->size;
3043 bytes_offset = BITS_ROUNDDOWN_BYTES(struct_bits_off);
3044 if (struct_size - bytes_offset < array_size) {
3045 btf_verifier_log_member(env, struct_type, member,
3046 "Member exceeds struct_size");
3047 return -EINVAL;
3048 }
3049
3050 return 0;
3051 }
3052
btf_array_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)3053 static s32 btf_array_check_meta(struct btf_verifier_env *env,
3054 const struct btf_type *t,
3055 u32 meta_left)
3056 {
3057 const struct btf_array *array = btf_type_array(t);
3058 u32 meta_needed = sizeof(*array);
3059
3060 if (meta_left < meta_needed) {
3061 btf_verifier_log_basic(env, t,
3062 "meta_left:%u meta_needed:%u",
3063 meta_left, meta_needed);
3064 return -EINVAL;
3065 }
3066
3067 /* array type should not have a name */
3068 if (t->name_off) {
3069 btf_verifier_log_type(env, t, "Invalid name");
3070 return -EINVAL;
3071 }
3072
3073 if (btf_type_vlen(t)) {
3074 btf_verifier_log_type(env, t, "vlen != 0");
3075 return -EINVAL;
3076 }
3077
3078 if (btf_type_kflag(t)) {
3079 btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
3080 return -EINVAL;
3081 }
3082
3083 if (t->size) {
3084 btf_verifier_log_type(env, t, "size != 0");
3085 return -EINVAL;
3086 }
3087
3088 /* Array elem type and index type cannot be in type void,
3089 * so !array->type and !array->index_type are not allowed.
3090 */
3091 if (!array->type || !BTF_TYPE_ID_VALID(array->type)) {
3092 btf_verifier_log_type(env, t, "Invalid elem");
3093 return -EINVAL;
3094 }
3095
3096 if (!array->index_type || !BTF_TYPE_ID_VALID(array->index_type)) {
3097 btf_verifier_log_type(env, t, "Invalid index");
3098 return -EINVAL;
3099 }
3100
3101 btf_verifier_log_type(env, t, NULL);
3102
3103 return meta_needed;
3104 }
3105
btf_array_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)3106 static int btf_array_resolve(struct btf_verifier_env *env,
3107 const struct resolve_vertex *v)
3108 {
3109 const struct btf_array *array = btf_type_array(v->t);
3110 const struct btf_type *elem_type, *index_type;
3111 u32 elem_type_id, index_type_id;
3112 struct btf *btf = env->btf;
3113 u32 elem_size;
3114
3115 /* Check array->index_type */
3116 index_type_id = array->index_type;
3117 index_type = btf_type_by_id(btf, index_type_id);
3118 if (btf_type_nosize_or_null(index_type) ||
3119 btf_type_is_resolve_source_only(index_type)) {
3120 btf_verifier_log_type(env, v->t, "Invalid index");
3121 return -EINVAL;
3122 }
3123
3124 if (!env_type_is_resolve_sink(env, index_type) &&
3125 !env_type_is_resolved(env, index_type_id))
3126 return env_stack_push(env, index_type, index_type_id);
3127
3128 index_type = btf_type_id_size(btf, &index_type_id, NULL);
3129 if (!index_type || !btf_type_is_int(index_type) ||
3130 !btf_type_int_is_regular(index_type)) {
3131 btf_verifier_log_type(env, v->t, "Invalid index");
3132 return -EINVAL;
3133 }
3134
3135 /* Check array->type */
3136 elem_type_id = array->type;
3137 elem_type = btf_type_by_id(btf, elem_type_id);
3138 if (btf_type_nosize_or_null(elem_type) ||
3139 btf_type_is_resolve_source_only(elem_type)) {
3140 btf_verifier_log_type(env, v->t,
3141 "Invalid elem");
3142 return -EINVAL;
3143 }
3144
3145 if (!env_type_is_resolve_sink(env, elem_type) &&
3146 !env_type_is_resolved(env, elem_type_id))
3147 return env_stack_push(env, elem_type, elem_type_id);
3148
3149 elem_type = btf_type_id_size(btf, &elem_type_id, &elem_size);
3150 if (!elem_type) {
3151 btf_verifier_log_type(env, v->t, "Invalid elem");
3152 return -EINVAL;
3153 }
3154
3155 if (btf_type_is_int(elem_type) && !btf_type_int_is_regular(elem_type)) {
3156 btf_verifier_log_type(env, v->t, "Invalid array of int");
3157 return -EINVAL;
3158 }
3159
3160 if (array->nelems && elem_size > U32_MAX / array->nelems) {
3161 btf_verifier_log_type(env, v->t,
3162 "Array size overflows U32_MAX");
3163 return -EINVAL;
3164 }
3165
3166 env_stack_pop_resolved(env, elem_type_id, elem_size * array->nelems);
3167
3168 return 0;
3169 }
3170
btf_array_log(struct btf_verifier_env * env,const struct btf_type * t)3171 static void btf_array_log(struct btf_verifier_env *env,
3172 const struct btf_type *t)
3173 {
3174 const struct btf_array *array = btf_type_array(t);
3175
3176 btf_verifier_log(env, "type_id=%u index_type_id=%u nr_elems=%u",
3177 array->type, array->index_type, array->nelems);
3178 }
3179
__btf_array_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)3180 static void __btf_array_show(const struct btf *btf, const struct btf_type *t,
3181 u32 type_id, void *data, u8 bits_offset,
3182 struct btf_show *show)
3183 {
3184 const struct btf_array *array = btf_type_array(t);
3185 const struct btf_kind_operations *elem_ops;
3186 const struct btf_type *elem_type;
3187 u32 i, elem_size = 0, elem_type_id;
3188 u16 encoding = 0;
3189
3190 elem_type_id = array->type;
3191 elem_type = btf_type_skip_modifiers(btf, elem_type_id, NULL);
3192 if (elem_type && btf_type_has_size(elem_type))
3193 elem_size = elem_type->size;
3194
3195 if (elem_type && btf_type_is_int(elem_type)) {
3196 u32 int_type = btf_type_int(elem_type);
3197
3198 encoding = BTF_INT_ENCODING(int_type);
3199
3200 /*
3201 * BTF_INT_CHAR encoding never seems to be set for
3202 * char arrays, so if size is 1 and element is
3203 * printable as a char, we'll do that.
3204 */
3205 if (elem_size == 1)
3206 encoding = BTF_INT_CHAR;
3207 }
3208
3209 if (!btf_show_start_array_type(show, t, type_id, encoding, data))
3210 return;
3211
3212 if (!elem_type)
3213 goto out;
3214 elem_ops = btf_type_ops(elem_type);
3215
3216 for (i = 0; i < array->nelems; i++) {
3217
3218 btf_show_start_array_member(show);
3219
3220 elem_ops->show(btf, elem_type, elem_type_id, data,
3221 bits_offset, show);
3222 data += elem_size;
3223
3224 btf_show_end_array_member(show);
3225
3226 if (show->state.array_terminated)
3227 break;
3228 }
3229 out:
3230 btf_show_end_array_type(show);
3231 }
3232
btf_array_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)3233 static void btf_array_show(const struct btf *btf, const struct btf_type *t,
3234 u32 type_id, void *data, u8 bits_offset,
3235 struct btf_show *show)
3236 {
3237 const struct btf_member *m = show->state.member;
3238
3239 /*
3240 * First check if any members would be shown (are non-zero).
3241 * See comments above "struct btf_show" definition for more
3242 * details on how this works at a high-level.
3243 */
3244 if (show->state.depth > 0 && !(show->flags & BTF_SHOW_ZERO)) {
3245 if (!show->state.depth_check) {
3246 show->state.depth_check = show->state.depth + 1;
3247 show->state.depth_to_show = 0;
3248 }
3249 __btf_array_show(btf, t, type_id, data, bits_offset, show);
3250 show->state.member = m;
3251
3252 if (show->state.depth_check != show->state.depth + 1)
3253 return;
3254 show->state.depth_check = 0;
3255
3256 if (show->state.depth_to_show <= show->state.depth)
3257 return;
3258 /*
3259 * Reaching here indicates we have recursed and found
3260 * non-zero array member(s).
3261 */
3262 }
3263 __btf_array_show(btf, t, type_id, data, bits_offset, show);
3264 }
3265
3266 static const struct btf_kind_operations array_ops = {
3267 .check_meta = btf_array_check_meta,
3268 .resolve = btf_array_resolve,
3269 .check_member = btf_array_check_member,
3270 .check_kflag_member = btf_generic_check_kflag_member,
3271 .log_details = btf_array_log,
3272 .show = btf_array_show,
3273 };
3274
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)3275 static int btf_struct_check_member(struct btf_verifier_env *env,
3276 const struct btf_type *struct_type,
3277 const struct btf_member *member,
3278 const struct btf_type *member_type)
3279 {
3280 u32 struct_bits_off = member->offset;
3281 u32 struct_size, bytes_offset;
3282
3283 if (BITS_PER_BYTE_MASKED(struct_bits_off)) {
3284 btf_verifier_log_member(env, struct_type, member,
3285 "Member is not byte aligned");
3286 return -EINVAL;
3287 }
3288
3289 struct_size = struct_type->size;
3290 bytes_offset = BITS_ROUNDDOWN_BYTES(struct_bits_off);
3291 if (struct_size - bytes_offset < member_type->size) {
3292 btf_verifier_log_member(env, struct_type, member,
3293 "Member exceeds struct_size");
3294 return -EINVAL;
3295 }
3296
3297 return 0;
3298 }
3299
btf_struct_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)3300 static s32 btf_struct_check_meta(struct btf_verifier_env *env,
3301 const struct btf_type *t,
3302 u32 meta_left)
3303 {
3304 bool is_union = BTF_INFO_KIND(t->info) == BTF_KIND_UNION;
3305 const struct btf_member *member;
3306 u32 meta_needed, last_offset;
3307 struct btf *btf = env->btf;
3308 u32 struct_size = t->size;
3309 u32 offset;
3310 u32 i;
3311
3312 meta_needed = btf_type_vlen(t) * sizeof(*member);
3313 if (meta_left < meta_needed) {
3314 btf_verifier_log_basic(env, t,
3315 "meta_left:%u meta_needed:%u",
3316 meta_left, meta_needed);
3317 return -EINVAL;
3318 }
3319
3320 /* struct type either no name or a valid one */
3321 if (t->name_off &&
3322 !btf_name_valid_identifier(env->btf, t->name_off)) {
3323 btf_verifier_log_type(env, t, "Invalid name");
3324 return -EINVAL;
3325 }
3326
3327 btf_verifier_log_type(env, t, NULL);
3328
3329 last_offset = 0;
3330 for_each_member(i, t, member) {
3331 if (!btf_name_offset_valid(btf, member->name_off)) {
3332 btf_verifier_log_member(env, t, member,
3333 "Invalid member name_offset:%u",
3334 member->name_off);
3335 return -EINVAL;
3336 }
3337
3338 /* struct member either no name or a valid one */
3339 if (member->name_off &&
3340 !btf_name_valid_identifier(btf, member->name_off)) {
3341 btf_verifier_log_member(env, t, member, "Invalid name");
3342 return -EINVAL;
3343 }
3344 /* A member cannot be in type void */
3345 if (!member->type || !BTF_TYPE_ID_VALID(member->type)) {
3346 btf_verifier_log_member(env, t, member,
3347 "Invalid type_id");
3348 return -EINVAL;
3349 }
3350
3351 offset = __btf_member_bit_offset(t, member);
3352 if (is_union && offset) {
3353 btf_verifier_log_member(env, t, member,
3354 "Invalid member bits_offset");
3355 return -EINVAL;
3356 }
3357
3358 /*
3359 * ">" instead of ">=" because the last member could be
3360 * "char a[0];"
3361 */
3362 if (last_offset > offset) {
3363 btf_verifier_log_member(env, t, member,
3364 "Invalid member bits_offset");
3365 return -EINVAL;
3366 }
3367
3368 if (BITS_ROUNDUP_BYTES(offset) > struct_size) {
3369 btf_verifier_log_member(env, t, member,
3370 "Member bits_offset exceeds its struct size");
3371 return -EINVAL;
3372 }
3373
3374 btf_verifier_log_member(env, t, member, NULL);
3375 last_offset = offset;
3376 }
3377
3378 return meta_needed;
3379 }
3380
btf_struct_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)3381 static int btf_struct_resolve(struct btf_verifier_env *env,
3382 const struct resolve_vertex *v)
3383 {
3384 const struct btf_member *member;
3385 int err;
3386 u32 i;
3387
3388 /* Before continue resolving the next_member,
3389 * ensure the last member is indeed resolved to a
3390 * type with size info.
3391 */
3392 if (v->next_member) {
3393 const struct btf_type *last_member_type;
3394 const struct btf_member *last_member;
3395 u32 last_member_type_id;
3396
3397 last_member = btf_type_member(v->t) + v->next_member - 1;
3398 last_member_type_id = last_member->type;
3399 if (WARN_ON_ONCE(!env_type_is_resolved(env,
3400 last_member_type_id)))
3401 return -EINVAL;
3402
3403 last_member_type = btf_type_by_id(env->btf,
3404 last_member_type_id);
3405 if (btf_type_kflag(v->t))
3406 err = btf_type_ops(last_member_type)->check_kflag_member(env, v->t,
3407 last_member,
3408 last_member_type);
3409 else
3410 err = btf_type_ops(last_member_type)->check_member(env, v->t,
3411 last_member,
3412 last_member_type);
3413 if (err)
3414 return err;
3415 }
3416
3417 for_each_member_from(i, v->next_member, v->t, member) {
3418 u32 member_type_id = member->type;
3419 const struct btf_type *member_type = btf_type_by_id(env->btf,
3420 member_type_id);
3421
3422 if (btf_type_nosize_or_null(member_type) ||
3423 btf_type_is_resolve_source_only(member_type)) {
3424 btf_verifier_log_member(env, v->t, member,
3425 "Invalid member");
3426 return -EINVAL;
3427 }
3428
3429 if (!env_type_is_resolve_sink(env, member_type) &&
3430 !env_type_is_resolved(env, member_type_id)) {
3431 env_stack_set_next_member(env, i + 1);
3432 return env_stack_push(env, member_type, member_type_id);
3433 }
3434
3435 if (btf_type_kflag(v->t))
3436 err = btf_type_ops(member_type)->check_kflag_member(env, v->t,
3437 member,
3438 member_type);
3439 else
3440 err = btf_type_ops(member_type)->check_member(env, v->t,
3441 member,
3442 member_type);
3443 if (err)
3444 return err;
3445 }
3446
3447 env_stack_pop_resolved(env, 0, 0);
3448
3449 return 0;
3450 }
3451
btf_struct_log(struct btf_verifier_env * env,const struct btf_type * t)3452 static void btf_struct_log(struct btf_verifier_env *env,
3453 const struct btf_type *t)
3454 {
3455 btf_verifier_log(env, "size=%u vlen=%u", t->size, btf_type_vlen(t));
3456 }
3457
3458 enum {
3459 BTF_FIELD_IGNORE = 0,
3460 BTF_FIELD_FOUND = 1,
3461 };
3462
3463 struct btf_field_info {
3464 enum btf_field_type type;
3465 u32 off;
3466 union {
3467 struct {
3468 u32 type_id;
3469 } kptr;
3470 struct {
3471 const char *node_name;
3472 u32 value_btf_id;
3473 } graph_root;
3474 };
3475 };
3476
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)3477 static int btf_find_struct(const struct btf *btf, const struct btf_type *t,
3478 u32 off, int sz, enum btf_field_type field_type,
3479 struct btf_field_info *info)
3480 {
3481 if (!__btf_type_is_struct(t))
3482 return BTF_FIELD_IGNORE;
3483 if (t->size != sz)
3484 return BTF_FIELD_IGNORE;
3485 info->type = field_type;
3486 info->off = off;
3487 return BTF_FIELD_FOUND;
3488 }
3489
3490 struct btf_type_tag_match {
3491 const char *name;
3492 u32 flag;
3493 };
3494
3495 struct btf_type_tag_walk_ctx {
3496 const struct btf_type *t; /* Input/Output */
3497 u32 id; /* Output */
3498 u32 res; /* Output */
3499 };
3500
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)3501 static int btf_type_tag_walk(const struct btf *btf,
3502 struct btf_type_tag_walk_ctx *ctx,
3503 const struct btf_type_tag_match *matches,
3504 u32 match_cnt)
3505 {
3506 const struct btf_type *t = ctx->t;
3507 u32 res = 0;
3508 const char *tag;
3509 u32 id, i;
3510
3511 do {
3512 id = t->type;
3513 t = btf_type_by_id(btf, id);
3514
3515 if (!btf_type_is_modifier(t))
3516 break;
3517
3518 if (!btf_type_is_type_tag(t) || btf_type_kflag(t))
3519 continue;
3520
3521 tag = __btf_name_by_offset(btf, t->name_off);
3522 for (i = 0; i < match_cnt; i++) {
3523 if (strcmp(tag, matches[i].name))
3524 continue;
3525 res |= matches[i].flag;
3526 break;
3527 }
3528 } while (true);
3529
3530 /* We only support a single tag. */
3531 if (hweight32(res) > 1)
3532 return -EINVAL;
3533
3534 ctx->t = t;
3535 ctx->id = id;
3536 ctx->res = res;
3537
3538 return 0;
3539 }
3540
btf_find_kptr(const struct btf * btf,const struct btf_type * t,u32 off,int sz,struct btf_field_info * info,u32 field_mask)3541 static int btf_find_kptr(const struct btf *btf, const struct btf_type *t,
3542 u32 off, int sz, struct btf_field_info *info, u32 field_mask)
3543 {
3544 static const struct btf_type_tag_match kptr_type_tags[] = {
3545 { "kptr_untrusted", BPF_KPTR_UNREF },
3546 { "kptr", BPF_KPTR_REF },
3547 { "percpu_kptr", BPF_KPTR_PERCPU },
3548 { "uptr", BPF_UPTR },
3549 };
3550 struct btf_type_tag_walk_ctx ctx;
3551 enum btf_field_type type = 0;
3552 int err;
3553 u32 res_id;
3554
3555 /* Permit modifiers on the pointer itself */
3556 if (btf_type_is_volatile(t))
3557 t = btf_type_by_id(btf, t->type);
3558 /* For PTR, sz is always == 8 */
3559 if (!btf_type_is_ptr(t))
3560 return BTF_FIELD_IGNORE;
3561
3562 ctx.t = t;
3563 err = btf_type_tag_walk(btf, &ctx, kptr_type_tags,
3564 ARRAY_SIZE(kptr_type_tags));
3565 if (err)
3566 return err;
3567
3568 t = ctx.t;
3569 res_id = ctx.id;
3570 type = ctx.res;
3571
3572 if (!(type & field_mask))
3573 return BTF_FIELD_IGNORE;
3574
3575 /* Only pointer to struct is allowed */
3576 if (!__btf_type_is_struct(t))
3577 return -EINVAL;
3578
3579 info->type = type;
3580 info->off = off;
3581 info->kptr.type_id = res_id;
3582 return BTF_FIELD_FOUND;
3583 }
3584
btf_find_next_decl_tag(const struct btf * btf,const struct btf_type * pt,int comp_idx,const char * tag_key,int last_id)3585 int btf_find_next_decl_tag(const struct btf *btf, const struct btf_type *pt,
3586 int comp_idx, const char *tag_key, int last_id)
3587 {
3588 int len = strlen(tag_key);
3589 int i, n;
3590
3591 for (i = last_id + 1, n = btf_nr_types(btf); i < n; i++) {
3592 const struct btf_type *t = btf_type_by_id(btf, i);
3593
3594 if (!btf_type_is_decl_tag(t))
3595 continue;
3596 if (pt != btf_type_by_id(btf, t->type))
3597 continue;
3598 if (btf_type_decl_tag(t)->component_idx != comp_idx)
3599 continue;
3600 if (strncmp(__btf_name_by_offset(btf, t->name_off), tag_key, len))
3601 continue;
3602 return i;
3603 }
3604 return -ENOENT;
3605 }
3606
btf_find_decl_tag_value(const struct btf * btf,const struct btf_type * pt,int comp_idx,const char * tag_key)3607 const char *btf_find_decl_tag_value(const struct btf *btf, const struct btf_type *pt,
3608 int comp_idx, const char *tag_key)
3609 {
3610 const char *value = NULL;
3611 const struct btf_type *t;
3612 int len, id;
3613
3614 id = btf_find_next_decl_tag(btf, pt, comp_idx, tag_key,
3615 btf_named_start_id(btf, false) - 1);
3616 if (id < 0)
3617 return ERR_PTR(id);
3618
3619 t = btf_type_by_id(btf, id);
3620 len = strlen(tag_key);
3621 value = __btf_name_by_offset(btf, t->name_off) + len;
3622
3623 /* Prevent duplicate entries for same type */
3624 id = btf_find_next_decl_tag(btf, pt, comp_idx, tag_key, id);
3625 if (id >= 0)
3626 return ERR_PTR(-EEXIST);
3627
3628 return value;
3629 }
3630
3631 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)3632 btf_find_graph_root(const struct btf *btf, const struct btf_type *pt,
3633 const struct btf_type *t, int comp_idx, u32 off,
3634 int sz, struct btf_field_info *info,
3635 enum btf_field_type head_type)
3636 {
3637 const char *node_field_name;
3638 const char *value_type;
3639 s32 id;
3640
3641 if (!__btf_type_is_struct(t))
3642 return BTF_FIELD_IGNORE;
3643 if (t->size != sz)
3644 return BTF_FIELD_IGNORE;
3645 value_type = btf_find_decl_tag_value(btf, pt, comp_idx, "contains:");
3646 if (IS_ERR(value_type))
3647 return -EINVAL;
3648 node_field_name = strstr(value_type, ":");
3649 if (!node_field_name)
3650 return -EINVAL;
3651 value_type = kstrndup(value_type, node_field_name - value_type,
3652 GFP_KERNEL_ACCOUNT | __GFP_NOWARN);
3653 if (!value_type)
3654 return -ENOMEM;
3655 id = btf_find_by_name_kind(btf, value_type, BTF_KIND_STRUCT);
3656 kfree(value_type);
3657 if (id < 0)
3658 return id;
3659 node_field_name++;
3660 if (str_is_empty(node_field_name))
3661 return -EINVAL;
3662 info->type = head_type;
3663 info->off = off;
3664 info->graph_root.value_btf_id = id;
3665 info->graph_root.node_name = node_field_name;
3666 return BTF_FIELD_FOUND;
3667 }
3668
btf_get_field_type(const struct btf * btf,const struct btf_type * var_type,u32 field_mask,u32 * seen_mask,int * align,int * sz)3669 static int btf_get_field_type(const struct btf *btf, const struct btf_type *var_type,
3670 u32 field_mask, u32 *seen_mask, int *align, int *sz)
3671 {
3672 const struct {
3673 enum btf_field_type type;
3674 const char *const name;
3675 const bool is_unique;
3676 } field_types[] = {
3677 { BPF_SPIN_LOCK, "bpf_spin_lock", true },
3678 { BPF_RES_SPIN_LOCK, "bpf_res_spin_lock", true },
3679 { BPF_TIMER, "bpf_timer", true },
3680 { BPF_WORKQUEUE, "bpf_wq", true },
3681 { BPF_TASK_WORK, "bpf_task_work", true },
3682 { BPF_LIST_HEAD, "bpf_list_head", false },
3683 { BPF_LIST_NODE, "bpf_list_node", false },
3684 { BPF_RB_ROOT, "bpf_rb_root", false },
3685 { BPF_RB_NODE, "bpf_rb_node", false },
3686 { BPF_REFCOUNT, "bpf_refcount", true },
3687 };
3688 int type = 0, i;
3689 const char *name = __btf_name_by_offset(btf, var_type->name_off);
3690 const char *field_type_name;
3691 enum btf_field_type field_type;
3692 bool is_unique;
3693
3694 for (i = 0; i < ARRAY_SIZE(field_types); ++i) {
3695 field_type = field_types[i].type;
3696 field_type_name = field_types[i].name;
3697 is_unique = field_types[i].is_unique;
3698 if (!(field_mask & field_type) || strcmp(name, field_type_name))
3699 continue;
3700 if (is_unique) {
3701 if (*seen_mask & field_type)
3702 return -E2BIG;
3703 *seen_mask |= field_type;
3704 }
3705 type = field_type;
3706 goto end;
3707 }
3708
3709 /* Only return BPF_KPTR when all other types with matchable names fail */
3710 if (field_mask & (BPF_KPTR | BPF_UPTR) && !__btf_type_is_struct(var_type)) {
3711 type = BPF_KPTR_REF;
3712 goto end;
3713 }
3714 return 0;
3715 end:
3716 *sz = btf_field_type_size(type);
3717 *align = btf_field_type_align(type);
3718 return type;
3719 }
3720
3721 /* Repeat a number of fields for a specified number of times.
3722 *
3723 * Copy the fields starting from the first field and repeat them for
3724 * repeat_cnt times. The fields are repeated by adding the offset of each
3725 * field with
3726 * (i + 1) * elem_size
3727 * where i is the repeat index and elem_size is the size of an element.
3728 */
btf_repeat_fields(struct btf_field_info * info,int info_cnt,u32 field_cnt,u32 repeat_cnt,u32 elem_size)3729 static int btf_repeat_fields(struct btf_field_info *info, int info_cnt,
3730 u32 field_cnt, u32 repeat_cnt, u32 elem_size)
3731 {
3732 u32 i, j, total_cnt, total_repeats;
3733 u32 cur;
3734
3735 /* Ensure not repeating fields that should not be repeated. */
3736 for (i = 0; i < field_cnt; i++) {
3737 switch (info[i].type) {
3738 case BPF_KPTR_UNREF:
3739 case BPF_KPTR_REF:
3740 case BPF_KPTR_PERCPU:
3741 case BPF_UPTR:
3742 case BPF_LIST_HEAD:
3743 case BPF_RB_ROOT:
3744 break;
3745 default:
3746 return -EINVAL;
3747 }
3748 }
3749
3750 if (check_add_overflow(repeat_cnt, 1, &total_repeats) ||
3751 check_mul_overflow(field_cnt, total_repeats, &total_cnt) ||
3752 total_cnt > (u32)info_cnt)
3753 return -E2BIG;
3754
3755 cur = field_cnt;
3756 for (i = 0; i < repeat_cnt; i++) {
3757 memcpy(&info[cur], &info[0], field_cnt * sizeof(info[0]));
3758 for (j = 0; j < field_cnt; j++)
3759 info[cur++].off += (i + 1) * elem_size;
3760 }
3761
3762 return 0;
3763 }
3764
3765 static int btf_find_struct_field(const struct btf *btf,
3766 const struct btf_type *t, u32 field_mask,
3767 struct btf_field_info *info, int info_cnt,
3768 u32 level, u32 *seen_mask);
3769
3770 /* Find special fields in the struct type of a field.
3771 *
3772 * This function is used to find fields of special types that is not a
3773 * global variable or a direct field of a struct type. It also handles the
3774 * repetition if it is the element type of an array.
3775 */
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)3776 static int btf_find_nested_struct(const struct btf *btf, const struct btf_type *t,
3777 u32 off, u32 nelems,
3778 u32 field_mask, struct btf_field_info *info,
3779 int info_cnt, u32 level, u32 *seen_mask)
3780 {
3781 int ret, err, i;
3782
3783 level++;
3784 if (level >= MAX_RESOLVE_DEPTH)
3785 return -E2BIG;
3786
3787 ret = btf_find_struct_field(btf, t, field_mask, info, info_cnt, level, seen_mask);
3788
3789 if (ret <= 0)
3790 return ret;
3791
3792 /* Shift the offsets of the nested struct fields to the offsets
3793 * related to the container.
3794 */
3795 for (i = 0; i < ret; i++)
3796 info[i].off += off;
3797
3798 if (nelems > 1) {
3799 err = btf_repeat_fields(info, info_cnt, ret, nelems - 1, t->size);
3800 if (err == 0)
3801 ret *= nelems;
3802 else
3803 ret = err;
3804 }
3805
3806 return ret;
3807 }
3808
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)3809 static int btf_find_field_one(const struct btf *btf,
3810 const struct btf_type *var,
3811 const struct btf_type *var_type,
3812 int var_idx,
3813 u32 off, u32 expected_size,
3814 u32 field_mask, u32 *seen_mask,
3815 struct btf_field_info *info, int info_cnt,
3816 u32 level)
3817 {
3818 int ret, align, sz, field_type;
3819 struct btf_field_info tmp;
3820 const struct btf_array *array;
3821 u32 i, nelems = 1;
3822
3823 /* Walk into array types to find the element type and the number of
3824 * elements in the (flattened) array.
3825 */
3826 for (i = 0; i < MAX_RESOLVE_DEPTH && btf_type_is_array(var_type); i++) {
3827 array = btf_array(var_type);
3828 nelems *= array->nelems;
3829 var_type = btf_type_by_id(btf, array->type);
3830 }
3831 if (i == MAX_RESOLVE_DEPTH)
3832 return -E2BIG;
3833 if (nelems == 0)
3834 return 0;
3835
3836 field_type = btf_get_field_type(btf, var_type,
3837 field_mask, seen_mask, &align, &sz);
3838 /* Look into variables of struct types */
3839 if (!field_type && __btf_type_is_struct(var_type)) {
3840 sz = var_type->size;
3841 if (expected_size && expected_size != sz * nelems)
3842 return 0;
3843 ret = btf_find_nested_struct(btf, var_type, off, nelems, field_mask,
3844 &info[0], info_cnt, level, seen_mask);
3845 return ret;
3846 }
3847
3848 if (field_type == 0)
3849 return 0;
3850 if (field_type < 0)
3851 return field_type;
3852
3853 if (expected_size && expected_size != sz * nelems)
3854 return 0;
3855 if (off % align)
3856 return 0;
3857
3858 switch (field_type) {
3859 case BPF_SPIN_LOCK:
3860 case BPF_RES_SPIN_LOCK:
3861 case BPF_TIMER:
3862 case BPF_WORKQUEUE:
3863 case BPF_LIST_NODE:
3864 case BPF_RB_NODE:
3865 case BPF_REFCOUNT:
3866 case BPF_TASK_WORK:
3867 ret = btf_find_struct(btf, var_type, off, sz, field_type,
3868 info_cnt ? &info[0] : &tmp);
3869 if (ret < 0)
3870 return ret;
3871 break;
3872 case BPF_KPTR_UNREF:
3873 case BPF_KPTR_REF:
3874 case BPF_KPTR_PERCPU:
3875 case BPF_UPTR:
3876 ret = btf_find_kptr(btf, var_type, off, sz,
3877 info_cnt ? &info[0] : &tmp, field_mask);
3878 if (ret < 0)
3879 return ret;
3880 break;
3881 case BPF_LIST_HEAD:
3882 case BPF_RB_ROOT:
3883 ret = btf_find_graph_root(btf, var, var_type,
3884 var_idx, off, sz,
3885 info_cnt ? &info[0] : &tmp,
3886 field_type);
3887 if (ret < 0)
3888 return ret;
3889 break;
3890 default:
3891 return -EFAULT;
3892 }
3893
3894 if (ret == BTF_FIELD_IGNORE)
3895 return 0;
3896 if (!info_cnt)
3897 return -E2BIG;
3898 if (nelems > 1) {
3899 ret = btf_repeat_fields(info, info_cnt, 1, nelems - 1, sz);
3900 if (ret < 0)
3901 return ret;
3902 }
3903 return nelems;
3904 }
3905
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)3906 static int btf_find_struct_field(const struct btf *btf,
3907 const struct btf_type *t, u32 field_mask,
3908 struct btf_field_info *info, int info_cnt,
3909 u32 level, u32 *seen_mask)
3910 {
3911 int ret, idx = 0;
3912 const struct btf_member *member;
3913 u32 i, off;
3914
3915 for_each_member(i, t, member) {
3916 const struct btf_type *member_type = btf_type_by_id(btf,
3917 member->type);
3918
3919 off = __btf_member_bit_offset(t, member);
3920 if (off % 8)
3921 /* valid C code cannot generate such BTF */
3922 return -EINVAL;
3923 off /= 8;
3924
3925 ret = btf_find_field_one(btf, t, member_type, i,
3926 off, 0,
3927 field_mask, seen_mask,
3928 &info[idx], info_cnt - idx, level);
3929 if (ret < 0)
3930 return ret;
3931 idx += ret;
3932 }
3933 return idx;
3934 }
3935
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)3936 static int btf_find_datasec_var(const struct btf *btf, const struct btf_type *t,
3937 u32 field_mask, struct btf_field_info *info,
3938 int info_cnt, u32 level, u32 *seen_mask)
3939 {
3940 int ret, idx = 0;
3941 const struct btf_var_secinfo *vsi;
3942 u32 i, off;
3943
3944 for_each_vsi(i, t, vsi) {
3945 const struct btf_type *var = btf_type_by_id(btf, vsi->type);
3946 const struct btf_type *var_type = btf_type_by_id(btf, var->type);
3947
3948 off = vsi->offset;
3949 ret = btf_find_field_one(btf, var, var_type, -1, off, vsi->size,
3950 field_mask, seen_mask,
3951 &info[idx], info_cnt - idx,
3952 level);
3953 if (ret < 0)
3954 return ret;
3955 idx += ret;
3956 }
3957 return idx;
3958 }
3959
btf_find_field(const struct btf * btf,const struct btf_type * t,u32 field_mask,struct btf_field_info * info,int info_cnt)3960 static int btf_find_field(const struct btf *btf, const struct btf_type *t,
3961 u32 field_mask, struct btf_field_info *info,
3962 int info_cnt)
3963 {
3964 u32 seen_mask = 0;
3965
3966 if (__btf_type_is_struct(t))
3967 return btf_find_struct_field(btf, t, field_mask, info, info_cnt, 0, &seen_mask);
3968 else if (btf_type_is_datasec(t))
3969 return btf_find_datasec_var(btf, t, field_mask, info, info_cnt, 0, &seen_mask);
3970 return -EINVAL;
3971 }
3972
3973 /* 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)3974 static int btf_parse_kptr(const struct btf *btf, struct btf_field *field,
3975 struct btf_field_info *info)
3976 {
3977 struct module *mod = NULL;
3978 const struct btf_type *t;
3979 /* If a matching btf type is found in kernel or module BTFs, kptr_ref
3980 * is that BTF, otherwise it's program BTF
3981 */
3982 struct btf *kptr_btf;
3983 int ret;
3984 s32 id;
3985
3986 /* Find type in map BTF, and use it to look up the matching type
3987 * in vmlinux or module BTFs, by name and kind.
3988 */
3989 t = btf_type_by_id(btf, info->kptr.type_id);
3990 id = bpf_find_btf_id(__btf_name_by_offset(btf, t->name_off), BTF_INFO_KIND(t->info),
3991 &kptr_btf);
3992 if (id == -ENOENT) {
3993 /* btf_parse_kptr should only be called w/ btf = program BTF */
3994 WARN_ON_ONCE(btf_is_kernel(btf));
3995
3996 /* Type exists only in program BTF. Assume that it's a MEM_ALLOC
3997 * kptr allocated via bpf_obj_new
3998 */
3999 field->kptr.dtor = NULL;
4000 id = info->kptr.type_id;
4001 kptr_btf = (struct btf *)btf;
4002 goto found_dtor;
4003 }
4004 if (id < 0)
4005 return id;
4006
4007 /* Find and stash the function pointer for the destruction function that
4008 * needs to be eventually invoked from the map free path.
4009 */
4010 if (info->type == BPF_KPTR_REF) {
4011 const struct btf_type *dtor_func;
4012 const char *dtor_func_name;
4013 unsigned long addr;
4014 s32 dtor_btf_id;
4015
4016 /* This call also serves as a whitelist of allowed objects that
4017 * can be used as a referenced pointer and be stored in a map at
4018 * the same time.
4019 */
4020 dtor_btf_id = btf_find_dtor_kfunc(kptr_btf, id);
4021 if (dtor_btf_id < 0) {
4022 ret = dtor_btf_id;
4023 goto end_btf;
4024 }
4025
4026 dtor_func = btf_type_by_id(kptr_btf, dtor_btf_id);
4027 if (!dtor_func) {
4028 ret = -ENOENT;
4029 goto end_btf;
4030 }
4031
4032 if (btf_is_module(kptr_btf)) {
4033 mod = btf_try_get_module(kptr_btf);
4034 if (!mod) {
4035 ret = -ENXIO;
4036 goto end_btf;
4037 }
4038 }
4039
4040 /* We already verified dtor_func to be btf_type_is_func
4041 * in register_btf_id_dtor_kfuncs.
4042 */
4043 dtor_func_name = __btf_name_by_offset(kptr_btf, dtor_func->name_off);
4044 addr = kallsyms_lookup_name(dtor_func_name);
4045 if (!addr) {
4046 ret = -EINVAL;
4047 goto end_mod;
4048 }
4049 field->kptr.dtor = (void *)addr;
4050 }
4051
4052 found_dtor:
4053 field->kptr.btf_id = id;
4054 field->kptr.btf = kptr_btf;
4055 field->kptr.module = mod;
4056 return 0;
4057 end_mod:
4058 module_put(mod);
4059 end_btf:
4060 btf_put(kptr_btf);
4061 return ret;
4062 }
4063
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)4064 static int btf_parse_graph_root(const struct btf *btf,
4065 struct btf_field *field,
4066 struct btf_field_info *info,
4067 const char *node_type_name,
4068 size_t node_type_align)
4069 {
4070 const struct btf_type *t, *n = NULL;
4071 const struct btf_member *member;
4072 u32 offset;
4073 int i;
4074
4075 t = btf_type_by_id(btf, info->graph_root.value_btf_id);
4076 /* We've already checked that value_btf_id is a struct type. We
4077 * just need to figure out the offset of the list_node, and
4078 * verify its type.
4079 */
4080 for_each_member(i, t, member) {
4081 if (strcmp(info->graph_root.node_name,
4082 __btf_name_by_offset(btf, member->name_off)))
4083 continue;
4084 /* Invalid BTF, two members with same name */
4085 if (n)
4086 return -EINVAL;
4087 n = btf_type_by_id(btf, member->type);
4088 if (!__btf_type_is_struct(n))
4089 return -EINVAL;
4090 if (strcmp(node_type_name, __btf_name_by_offset(btf, n->name_off)))
4091 return -EINVAL;
4092 offset = __btf_member_bit_offset(n, member);
4093 if (offset % 8)
4094 return -EINVAL;
4095 offset /= 8;
4096 if (offset % node_type_align)
4097 return -EINVAL;
4098
4099 field->graph_root.btf = (struct btf *)btf;
4100 field->graph_root.value_btf_id = info->graph_root.value_btf_id;
4101 field->graph_root.node_offset = offset;
4102 }
4103 if (!n)
4104 return -ENOENT;
4105 return 0;
4106 }
4107
btf_parse_list_head(const struct btf * btf,struct btf_field * field,struct btf_field_info * info)4108 static int btf_parse_list_head(const struct btf *btf, struct btf_field *field,
4109 struct btf_field_info *info)
4110 {
4111 return btf_parse_graph_root(btf, field, info, "bpf_list_node",
4112 __alignof__(struct bpf_list_node));
4113 }
4114
btf_parse_rb_root(const struct btf * btf,struct btf_field * field,struct btf_field_info * info)4115 static int btf_parse_rb_root(const struct btf *btf, struct btf_field *field,
4116 struct btf_field_info *info)
4117 {
4118 return btf_parse_graph_root(btf, field, info, "bpf_rb_node",
4119 __alignof__(struct bpf_rb_node));
4120 }
4121
btf_field_cmp(const void * _a,const void * _b,const void * priv)4122 static int btf_field_cmp(const void *_a, const void *_b, const void *priv)
4123 {
4124 const struct btf_field *a = (const struct btf_field *)_a;
4125 const struct btf_field *b = (const struct btf_field *)_b;
4126
4127 if (a->offset < b->offset)
4128 return -1;
4129 else if (a->offset > b->offset)
4130 return 1;
4131 return 0;
4132 }
4133
btf_parse_fields(const struct btf * btf,const struct btf_type * t,u32 field_mask,u32 value_size)4134 struct btf_record *btf_parse_fields(const struct btf *btf, const struct btf_type *t,
4135 u32 field_mask, u32 value_size)
4136 {
4137 struct btf_field_info info_arr[BTF_FIELDS_MAX];
4138 u32 next_off = 0, field_type_size;
4139 struct btf_record *rec;
4140 int ret, i, cnt;
4141
4142 ret = btf_find_field(btf, t, field_mask, info_arr, ARRAY_SIZE(info_arr));
4143 if (ret < 0)
4144 return ERR_PTR(ret);
4145 if (!ret)
4146 return NULL;
4147
4148 cnt = ret;
4149 /* This needs to be kzalloc to zero out padding and unused fields, see
4150 * comment in btf_record_equal.
4151 */
4152 rec = kzalloc_flex(*rec, fields, cnt, GFP_KERNEL_ACCOUNT | __GFP_NOWARN);
4153 if (!rec)
4154 return ERR_PTR(-ENOMEM);
4155
4156 rec->spin_lock_off = -EINVAL;
4157 rec->res_spin_lock_off = -EINVAL;
4158 rec->timer_off = -EINVAL;
4159 rec->wq_off = -EINVAL;
4160 rec->refcount_off = -EINVAL;
4161 rec->task_work_off = -EINVAL;
4162 for (i = 0; i < cnt; i++) {
4163 field_type_size = btf_field_type_size(info_arr[i].type);
4164 if (info_arr[i].off + field_type_size > value_size) {
4165 WARN_ONCE(1, "verifier bug off %d size %d", info_arr[i].off, value_size);
4166 ret = -EFAULT;
4167 goto end;
4168 }
4169 if (info_arr[i].off < next_off) {
4170 ret = -EEXIST;
4171 goto end;
4172 }
4173 next_off = info_arr[i].off + field_type_size;
4174
4175 rec->field_mask |= info_arr[i].type;
4176 rec->fields[i].offset = info_arr[i].off;
4177 rec->fields[i].type = info_arr[i].type;
4178 rec->fields[i].size = field_type_size;
4179
4180 switch (info_arr[i].type) {
4181 case BPF_SPIN_LOCK:
4182 WARN_ON_ONCE(rec->spin_lock_off >= 0);
4183 /* Cache offset for faster lookup at runtime */
4184 rec->spin_lock_off = rec->fields[i].offset;
4185 break;
4186 case BPF_RES_SPIN_LOCK:
4187 WARN_ON_ONCE(rec->res_spin_lock_off >= 0);
4188 /* Cache offset for faster lookup at runtime */
4189 rec->res_spin_lock_off = rec->fields[i].offset;
4190 break;
4191 case BPF_TIMER:
4192 WARN_ON_ONCE(rec->timer_off >= 0);
4193 /* Cache offset for faster lookup at runtime */
4194 rec->timer_off = rec->fields[i].offset;
4195 break;
4196 case BPF_WORKQUEUE:
4197 WARN_ON_ONCE(rec->wq_off >= 0);
4198 /* Cache offset for faster lookup at runtime */
4199 rec->wq_off = rec->fields[i].offset;
4200 break;
4201 case BPF_TASK_WORK:
4202 WARN_ON_ONCE(rec->task_work_off >= 0);
4203 rec->task_work_off = rec->fields[i].offset;
4204 break;
4205 case BPF_REFCOUNT:
4206 WARN_ON_ONCE(rec->refcount_off >= 0);
4207 /* Cache offset for faster lookup at runtime */
4208 rec->refcount_off = rec->fields[i].offset;
4209 break;
4210 case BPF_KPTR_UNREF:
4211 case BPF_KPTR_REF:
4212 case BPF_KPTR_PERCPU:
4213 case BPF_UPTR:
4214 ret = btf_parse_kptr(btf, &rec->fields[i], &info_arr[i]);
4215 if (ret < 0)
4216 goto end;
4217 break;
4218 case BPF_LIST_HEAD:
4219 ret = btf_parse_list_head(btf, &rec->fields[i], &info_arr[i]);
4220 if (ret < 0)
4221 goto end;
4222 break;
4223 case BPF_RB_ROOT:
4224 ret = btf_parse_rb_root(btf, &rec->fields[i], &info_arr[i]);
4225 if (ret < 0)
4226 goto end;
4227 break;
4228 case BPF_LIST_NODE:
4229 case BPF_RB_NODE:
4230 break;
4231 default:
4232 ret = -EFAULT;
4233 goto end;
4234 }
4235 rec->cnt++;
4236 }
4237
4238 if (rec->spin_lock_off >= 0 && rec->res_spin_lock_off >= 0) {
4239 ret = -EINVAL;
4240 goto end;
4241 }
4242
4243 /* bpf_{list_head, rb_node} require bpf_spin_lock */
4244 if ((btf_record_has_field(rec, BPF_LIST_HEAD) ||
4245 btf_record_has_field(rec, BPF_RB_ROOT)) &&
4246 (rec->spin_lock_off < 0 && rec->res_spin_lock_off < 0)) {
4247 ret = -EINVAL;
4248 goto end;
4249 }
4250
4251 if (rec->refcount_off < 0 &&
4252 btf_record_has_field(rec, BPF_LIST_NODE) &&
4253 btf_record_has_field(rec, BPF_RB_NODE)) {
4254 ret = -EINVAL;
4255 goto end;
4256 }
4257
4258 sort_r(rec->fields, rec->cnt, sizeof(struct btf_field), btf_field_cmp,
4259 NULL, rec);
4260
4261 return rec;
4262 end:
4263 btf_record_free(rec);
4264 return ERR_PTR(ret);
4265 }
4266
btf_check_and_fixup_fields(const struct btf * btf,struct btf_record * rec)4267 int btf_check_and_fixup_fields(const struct btf *btf, struct btf_record *rec)
4268 {
4269 int i;
4270
4271 /* There are three types that signify ownership of some other type:
4272 * kptr_ref, bpf_list_head, bpf_rb_root.
4273 * kptr_ref only supports storing kernel types, which can't store
4274 * references to program allocated local types.
4275 *
4276 * Hence we only need to ensure that bpf_{list_head,rb_root} ownership
4277 * does not form cycles.
4278 */
4279 if (IS_ERR_OR_NULL(rec) || !(rec->field_mask & (BPF_GRAPH_ROOT | BPF_UPTR)))
4280 return 0;
4281 for (i = 0; i < rec->cnt; i++) {
4282 struct btf_struct_meta *meta;
4283 const struct btf_type *t;
4284 u32 btf_id;
4285
4286 if (rec->fields[i].type == BPF_UPTR) {
4287 /* The uptr only supports pinning one page and cannot
4288 * point to a kernel struct
4289 */
4290 if (btf_is_kernel(rec->fields[i].kptr.btf))
4291 return -EINVAL;
4292 t = btf_type_by_id(rec->fields[i].kptr.btf,
4293 rec->fields[i].kptr.btf_id);
4294 if (!t->size)
4295 return -EINVAL;
4296 if (t->size > PAGE_SIZE)
4297 return -E2BIG;
4298 continue;
4299 }
4300
4301 if (!(rec->fields[i].type & BPF_GRAPH_ROOT))
4302 continue;
4303 btf_id = rec->fields[i].graph_root.value_btf_id;
4304 meta = btf_find_struct_meta(btf, btf_id);
4305 if (!meta)
4306 return -EFAULT;
4307 rec->fields[i].graph_root.value_rec = meta->record;
4308
4309 /* We need to set value_rec for all root types, but no need
4310 * to check ownership cycle for a type unless it's also a
4311 * node type.
4312 */
4313 if (!(rec->field_mask & BPF_GRAPH_NODE))
4314 continue;
4315
4316 /* We need to ensure ownership acyclicity among all types. The
4317 * proper way to do it would be to topologically sort all BTF
4318 * IDs based on the ownership edges, since there can be multiple
4319 * bpf_{list_head,rb_node} in a type. Instead, we use the
4320 * following resaoning:
4321 *
4322 * - A type can only be owned by another type in user BTF if it
4323 * has a bpf_{list,rb}_node. Let's call these node types.
4324 * - A type can only _own_ another type in user BTF if it has a
4325 * bpf_{list_head,rb_root}. Let's call these root types.
4326 *
4327 * We ensure that if a type is both a root and node, its
4328 * element types cannot be root types.
4329 *
4330 * To ensure acyclicity:
4331 *
4332 * When A is an root type but not a node, its ownership
4333 * chain can be:
4334 * A -> B -> C
4335 * Where:
4336 * - A is an root, e.g. has bpf_rb_root.
4337 * - B is both a root and node, e.g. has bpf_rb_node and
4338 * bpf_list_head.
4339 * - C is only an root, e.g. has bpf_list_node
4340 *
4341 * When A is both a root and node, some other type already
4342 * owns it in the BTF domain, hence it can not own
4343 * another root type through any of the ownership edges.
4344 * A -> B
4345 * Where:
4346 * - A is both an root and node.
4347 * - B is only an node.
4348 */
4349 if (meta->record->field_mask & BPF_GRAPH_ROOT)
4350 return -ELOOP;
4351 }
4352 return 0;
4353 }
4354
__btf_struct_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)4355 static void __btf_struct_show(const struct btf *btf, const struct btf_type *t,
4356 u32 type_id, void *data, u8 bits_offset,
4357 struct btf_show *show)
4358 {
4359 const struct btf_member *member;
4360 void *safe_data;
4361 u32 i;
4362
4363 safe_data = btf_show_start_struct_type(show, t, type_id, data);
4364 if (!safe_data)
4365 return;
4366
4367 for_each_member(i, t, member) {
4368 const struct btf_type *member_type = btf_type_by_id(btf,
4369 member->type);
4370 const struct btf_kind_operations *ops;
4371 u32 member_offset, bitfield_size;
4372 u32 bytes_offset;
4373 u8 bits8_offset;
4374
4375 btf_show_start_member(show, member);
4376
4377 member_offset = __btf_member_bit_offset(t, member);
4378 bitfield_size = __btf_member_bitfield_size(t, member);
4379 bytes_offset = BITS_ROUNDDOWN_BYTES(member_offset);
4380 bits8_offset = BITS_PER_BYTE_MASKED(member_offset);
4381 if (bitfield_size) {
4382 safe_data = btf_show_start_type(show, member_type,
4383 member->type,
4384 data + bytes_offset);
4385 if (safe_data)
4386 btf_bitfield_show(safe_data,
4387 bits8_offset,
4388 bitfield_size, show);
4389 btf_show_end_type(show);
4390 } else {
4391 ops = btf_type_ops(member_type);
4392 ops->show(btf, member_type, member->type,
4393 data + bytes_offset, bits8_offset, show);
4394 }
4395
4396 btf_show_end_member(show);
4397 }
4398
4399 btf_show_end_struct_type(show);
4400 }
4401
btf_struct_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)4402 static void btf_struct_show(const struct btf *btf, const struct btf_type *t,
4403 u32 type_id, void *data, u8 bits_offset,
4404 struct btf_show *show)
4405 {
4406 const struct btf_member *m = show->state.member;
4407
4408 /*
4409 * First check if any members would be shown (are non-zero).
4410 * See comments above "struct btf_show" definition for more
4411 * details on how this works at a high-level.
4412 */
4413 if (show->state.depth > 0 && !(show->flags & BTF_SHOW_ZERO)) {
4414 if (!show->state.depth_check) {
4415 show->state.depth_check = show->state.depth + 1;
4416 show->state.depth_to_show = 0;
4417 }
4418 __btf_struct_show(btf, t, type_id, data, bits_offset, show);
4419 /* Restore saved member data here */
4420 show->state.member = m;
4421 if (show->state.depth_check != show->state.depth + 1)
4422 return;
4423 show->state.depth_check = 0;
4424
4425 if (show->state.depth_to_show <= show->state.depth)
4426 return;
4427 /*
4428 * Reaching here indicates we have recursed and found
4429 * non-zero child values.
4430 */
4431 }
4432
4433 __btf_struct_show(btf, t, type_id, data, bits_offset, show);
4434 }
4435
4436 static const struct btf_kind_operations struct_ops = {
4437 .check_meta = btf_struct_check_meta,
4438 .resolve = btf_struct_resolve,
4439 .check_member = btf_struct_check_member,
4440 .check_kflag_member = btf_generic_check_kflag_member,
4441 .log_details = btf_struct_log,
4442 .show = btf_struct_show,
4443 };
4444
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)4445 static int btf_enum_check_member(struct btf_verifier_env *env,
4446 const struct btf_type *struct_type,
4447 const struct btf_member *member,
4448 const struct btf_type *member_type)
4449 {
4450 u32 struct_bits_off = member->offset;
4451 u32 struct_size, bytes_offset;
4452
4453 if (BITS_PER_BYTE_MASKED(struct_bits_off)) {
4454 btf_verifier_log_member(env, struct_type, member,
4455 "Member is not byte aligned");
4456 return -EINVAL;
4457 }
4458
4459 struct_size = struct_type->size;
4460 bytes_offset = BITS_ROUNDDOWN_BYTES(struct_bits_off);
4461 if (struct_size - bytes_offset < member_type->size) {
4462 btf_verifier_log_member(env, struct_type, member,
4463 "Member exceeds struct_size");
4464 return -EINVAL;
4465 }
4466
4467 return 0;
4468 }
4469
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)4470 static int btf_enum_check_kflag_member(struct btf_verifier_env *env,
4471 const struct btf_type *struct_type,
4472 const struct btf_member *member,
4473 const struct btf_type *member_type)
4474 {
4475 u32 struct_bits_off, nr_bits, bytes_end, struct_size;
4476 u32 int_bitsize = sizeof(int) * BITS_PER_BYTE;
4477
4478 struct_bits_off = BTF_MEMBER_BIT_OFFSET(member->offset);
4479 nr_bits = BTF_MEMBER_BITFIELD_SIZE(member->offset);
4480 if (!nr_bits) {
4481 if (BITS_PER_BYTE_MASKED(struct_bits_off)) {
4482 btf_verifier_log_member(env, struct_type, member,
4483 "Member is not byte aligned");
4484 return -EINVAL;
4485 }
4486
4487 nr_bits = int_bitsize;
4488 } else if (nr_bits > int_bitsize) {
4489 btf_verifier_log_member(env, struct_type, member,
4490 "Invalid member bitfield_size");
4491 return -EINVAL;
4492 }
4493
4494 struct_size = struct_type->size;
4495 bytes_end = BITS_ROUNDUP_BYTES(struct_bits_off + nr_bits);
4496 if (struct_size < bytes_end) {
4497 btf_verifier_log_member(env, struct_type, member,
4498 "Member exceeds struct_size");
4499 return -EINVAL;
4500 }
4501
4502 return 0;
4503 }
4504
btf_enum_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)4505 static s32 btf_enum_check_meta(struct btf_verifier_env *env,
4506 const struct btf_type *t,
4507 u32 meta_left)
4508 {
4509 const struct btf_enum *enums = btf_type_enum(t);
4510 struct btf *btf = env->btf;
4511 const char *fmt_str;
4512 u32 i, nr_enums;
4513 u32 meta_needed;
4514
4515 nr_enums = btf_type_vlen(t);
4516 meta_needed = nr_enums * sizeof(*enums);
4517
4518 if (meta_left < meta_needed) {
4519 btf_verifier_log_basic(env, t,
4520 "meta_left:%u meta_needed:%u",
4521 meta_left, meta_needed);
4522 return -EINVAL;
4523 }
4524
4525 if (t->size > 8 || !is_power_of_2(t->size)) {
4526 btf_verifier_log_type(env, t, "Unexpected size");
4527 return -EINVAL;
4528 }
4529
4530 /* enum type either no name or a valid one */
4531 if (t->name_off &&
4532 !btf_name_valid_identifier(env->btf, t->name_off)) {
4533 btf_verifier_log_type(env, t, "Invalid name");
4534 return -EINVAL;
4535 }
4536
4537 btf_verifier_log_type(env, t, NULL);
4538
4539 for (i = 0; i < nr_enums; i++) {
4540 if (!btf_name_offset_valid(btf, enums[i].name_off)) {
4541 btf_verifier_log(env, "\tInvalid name_offset:%u",
4542 enums[i].name_off);
4543 return -EINVAL;
4544 }
4545
4546 /* enum member must have a valid name */
4547 if (!enums[i].name_off ||
4548 !btf_name_valid_identifier(btf, enums[i].name_off)) {
4549 btf_verifier_log_type(env, t, "Invalid name");
4550 return -EINVAL;
4551 }
4552
4553 if (env->log.level == BPF_LOG_KERNEL)
4554 continue;
4555 fmt_str = btf_type_kflag(t) ? "\t%s val=%d\n" : "\t%s val=%u\n";
4556 btf_verifier_log(env, fmt_str,
4557 __btf_name_by_offset(btf, enums[i].name_off),
4558 enums[i].val);
4559 }
4560
4561 return meta_needed;
4562 }
4563
btf_enum_log(struct btf_verifier_env * env,const struct btf_type * t)4564 static void btf_enum_log(struct btf_verifier_env *env,
4565 const struct btf_type *t)
4566 {
4567 btf_verifier_log(env, "size=%u vlen=%u", t->size, btf_type_vlen(t));
4568 }
4569
btf_enum_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)4570 static void btf_enum_show(const struct btf *btf, const struct btf_type *t,
4571 u32 type_id, void *data, u8 bits_offset,
4572 struct btf_show *show)
4573 {
4574 const struct btf_enum *enums = btf_type_enum(t);
4575 u32 i, nr_enums = btf_type_vlen(t);
4576 void *safe_data;
4577 int v;
4578
4579 safe_data = btf_show_start_type(show, t, type_id, data);
4580 if (!safe_data)
4581 return;
4582
4583 v = *(int *)safe_data;
4584
4585 for (i = 0; i < nr_enums; i++) {
4586 if (v != enums[i].val)
4587 continue;
4588
4589 btf_show_type_value(show, "%s",
4590 __btf_name_by_offset(btf,
4591 enums[i].name_off));
4592
4593 btf_show_end_type(show);
4594 return;
4595 }
4596
4597 if (btf_type_kflag(t))
4598 btf_show_type_value(show, "%d", v);
4599 else
4600 btf_show_type_value(show, "%u", v);
4601 btf_show_end_type(show);
4602 }
4603
4604 static const struct btf_kind_operations enum_ops = {
4605 .check_meta = btf_enum_check_meta,
4606 .resolve = btf_df_resolve,
4607 .check_member = btf_enum_check_member,
4608 .check_kflag_member = btf_enum_check_kflag_member,
4609 .log_details = btf_enum_log,
4610 .show = btf_enum_show,
4611 };
4612
btf_enum64_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)4613 static s32 btf_enum64_check_meta(struct btf_verifier_env *env,
4614 const struct btf_type *t,
4615 u32 meta_left)
4616 {
4617 const struct btf_enum64 *enums = btf_type_enum64(t);
4618 struct btf *btf = env->btf;
4619 const char *fmt_str;
4620 u32 i, nr_enums;
4621 u32 meta_needed;
4622
4623 nr_enums = btf_type_vlen(t);
4624 meta_needed = nr_enums * sizeof(*enums);
4625
4626 if (meta_left < meta_needed) {
4627 btf_verifier_log_basic(env, t,
4628 "meta_left:%u meta_needed:%u",
4629 meta_left, meta_needed);
4630 return -EINVAL;
4631 }
4632
4633 if (t->size > 8 || !is_power_of_2(t->size)) {
4634 btf_verifier_log_type(env, t, "Unexpected size");
4635 return -EINVAL;
4636 }
4637
4638 /* enum type either no name or a valid one */
4639 if (t->name_off &&
4640 !btf_name_valid_identifier(env->btf, t->name_off)) {
4641 btf_verifier_log_type(env, t, "Invalid name");
4642 return -EINVAL;
4643 }
4644
4645 btf_verifier_log_type(env, t, NULL);
4646
4647 for (i = 0; i < nr_enums; i++) {
4648 if (!btf_name_offset_valid(btf, enums[i].name_off)) {
4649 btf_verifier_log(env, "\tInvalid name_offset:%u",
4650 enums[i].name_off);
4651 return -EINVAL;
4652 }
4653
4654 /* enum member must have a valid name */
4655 if (!enums[i].name_off ||
4656 !btf_name_valid_identifier(btf, enums[i].name_off)) {
4657 btf_verifier_log_type(env, t, "Invalid name");
4658 return -EINVAL;
4659 }
4660
4661 if (env->log.level == BPF_LOG_KERNEL)
4662 continue;
4663
4664 fmt_str = btf_type_kflag(t) ? "\t%s val=%lld\n" : "\t%s val=%llu\n";
4665 btf_verifier_log(env, fmt_str,
4666 __btf_name_by_offset(btf, enums[i].name_off),
4667 btf_enum64_value(enums + i));
4668 }
4669
4670 return meta_needed;
4671 }
4672
btf_enum64_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)4673 static void btf_enum64_show(const struct btf *btf, const struct btf_type *t,
4674 u32 type_id, void *data, u8 bits_offset,
4675 struct btf_show *show)
4676 {
4677 const struct btf_enum64 *enums = btf_type_enum64(t);
4678 u32 i, nr_enums = btf_type_vlen(t);
4679 void *safe_data;
4680 s64 v;
4681
4682 safe_data = btf_show_start_type(show, t, type_id, data);
4683 if (!safe_data)
4684 return;
4685
4686 v = *(u64 *)safe_data;
4687
4688 for (i = 0; i < nr_enums; i++) {
4689 if (v != btf_enum64_value(enums + i))
4690 continue;
4691
4692 btf_show_type_value(show, "%s",
4693 __btf_name_by_offset(btf,
4694 enums[i].name_off));
4695
4696 btf_show_end_type(show);
4697 return;
4698 }
4699
4700 if (btf_type_kflag(t))
4701 btf_show_type_value(show, "%lld", v);
4702 else
4703 btf_show_type_value(show, "%llu", v);
4704 btf_show_end_type(show);
4705 }
4706
4707 static const struct btf_kind_operations enum64_ops = {
4708 .check_meta = btf_enum64_check_meta,
4709 .resolve = btf_df_resolve,
4710 .check_member = btf_enum_check_member,
4711 .check_kflag_member = btf_enum_check_kflag_member,
4712 .log_details = btf_enum_log,
4713 .show = btf_enum64_show,
4714 };
4715
btf_func_proto_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)4716 static s32 btf_func_proto_check_meta(struct btf_verifier_env *env,
4717 const struct btf_type *t,
4718 u32 meta_left)
4719 {
4720 u32 meta_needed = btf_type_vlen(t) * sizeof(struct btf_param);
4721
4722 if (meta_left < meta_needed) {
4723 btf_verifier_log_basic(env, t,
4724 "meta_left:%u meta_needed:%u",
4725 meta_left, meta_needed);
4726 return -EINVAL;
4727 }
4728
4729 if (t->name_off) {
4730 btf_verifier_log_type(env, t, "Invalid name");
4731 return -EINVAL;
4732 }
4733
4734 if (btf_type_kflag(t)) {
4735 btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
4736 return -EINVAL;
4737 }
4738
4739 btf_verifier_log_type(env, t, NULL);
4740
4741 return meta_needed;
4742 }
4743
btf_func_proto_log(struct btf_verifier_env * env,const struct btf_type * t)4744 static void btf_func_proto_log(struct btf_verifier_env *env,
4745 const struct btf_type *t)
4746 {
4747 const struct btf_param *args = (const struct btf_param *)(t + 1);
4748 u32 nr_args = btf_type_vlen(t), i;
4749
4750 btf_verifier_log(env, "return=%u args=(", t->type);
4751 if (!nr_args) {
4752 btf_verifier_log(env, "void");
4753 goto done;
4754 }
4755
4756 if (nr_args == 1 && !args[0].type) {
4757 /* Only one vararg */
4758 btf_verifier_log(env, "vararg");
4759 goto done;
4760 }
4761
4762 btf_verifier_log(env, "%u %s", args[0].type,
4763 __btf_name_by_offset(env->btf,
4764 args[0].name_off));
4765 for (i = 1; i < nr_args - 1; i++)
4766 btf_verifier_log(env, ", %u %s", args[i].type,
4767 __btf_name_by_offset(env->btf,
4768 args[i].name_off));
4769
4770 if (nr_args > 1) {
4771 const struct btf_param *last_arg = &args[nr_args - 1];
4772
4773 if (last_arg->type)
4774 btf_verifier_log(env, ", %u %s", last_arg->type,
4775 __btf_name_by_offset(env->btf,
4776 last_arg->name_off));
4777 else
4778 btf_verifier_log(env, ", vararg");
4779 }
4780
4781 done:
4782 btf_verifier_log(env, ")");
4783 }
4784
4785 static const struct btf_kind_operations func_proto_ops = {
4786 .check_meta = btf_func_proto_check_meta,
4787 .resolve = btf_df_resolve,
4788 /*
4789 * BTF_KIND_FUNC_PROTO cannot be directly referred by
4790 * a struct's member.
4791 *
4792 * It should be a function pointer instead.
4793 * (i.e. struct's member -> BTF_KIND_PTR -> BTF_KIND_FUNC_PROTO)
4794 *
4795 * Hence, there is no btf_func_check_member().
4796 */
4797 .check_member = btf_df_check_member,
4798 .check_kflag_member = btf_df_check_kflag_member,
4799 .log_details = btf_func_proto_log,
4800 .show = btf_df_show,
4801 };
4802
btf_func_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)4803 static s32 btf_func_check_meta(struct btf_verifier_env *env,
4804 const struct btf_type *t,
4805 u32 meta_left)
4806 {
4807 if (!t->name_off ||
4808 !btf_name_valid_identifier(env->btf, t->name_off)) {
4809 btf_verifier_log_type(env, t, "Invalid name");
4810 return -EINVAL;
4811 }
4812
4813 if (btf_type_vlen(t) > BTF_FUNC_GLOBAL) {
4814 btf_verifier_log_type(env, t, "Invalid func linkage");
4815 return -EINVAL;
4816 }
4817
4818 if (btf_type_kflag(t)) {
4819 btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
4820 return -EINVAL;
4821 }
4822
4823 btf_verifier_log_type(env, t, NULL);
4824
4825 return 0;
4826 }
4827
btf_func_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)4828 static int btf_func_resolve(struct btf_verifier_env *env,
4829 const struct resolve_vertex *v)
4830 {
4831 const struct btf_type *t = v->t;
4832 u32 next_type_id = t->type;
4833 int err;
4834
4835 err = btf_func_check(env, t);
4836 if (err)
4837 return err;
4838
4839 env_stack_pop_resolved(env, next_type_id, 0);
4840 return 0;
4841 }
4842
4843 static const struct btf_kind_operations func_ops = {
4844 .check_meta = btf_func_check_meta,
4845 .resolve = btf_func_resolve,
4846 .check_member = btf_df_check_member,
4847 .check_kflag_member = btf_df_check_kflag_member,
4848 .log_details = btf_ref_type_log,
4849 .show = btf_df_show,
4850 };
4851
btf_var_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)4852 static s32 btf_var_check_meta(struct btf_verifier_env *env,
4853 const struct btf_type *t,
4854 u32 meta_left)
4855 {
4856 const struct btf_var *var;
4857 u32 meta_needed = sizeof(*var);
4858
4859 if (meta_left < meta_needed) {
4860 btf_verifier_log_basic(env, t,
4861 "meta_left:%u meta_needed:%u",
4862 meta_left, meta_needed);
4863 return -EINVAL;
4864 }
4865
4866 if (btf_type_vlen(t)) {
4867 btf_verifier_log_type(env, t, "vlen != 0");
4868 return -EINVAL;
4869 }
4870
4871 if (btf_type_kflag(t)) {
4872 btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
4873 return -EINVAL;
4874 }
4875
4876 if (!t->name_off ||
4877 !btf_name_valid_identifier(env->btf, t->name_off)) {
4878 btf_verifier_log_type(env, t, "Invalid name");
4879 return -EINVAL;
4880 }
4881
4882 /* A var cannot be in type void */
4883 if (!t->type || !BTF_TYPE_ID_VALID(t->type)) {
4884 btf_verifier_log_type(env, t, "Invalid type_id");
4885 return -EINVAL;
4886 }
4887
4888 var = btf_type_var(t);
4889 if (var->linkage != BTF_VAR_STATIC &&
4890 var->linkage != BTF_VAR_GLOBAL_ALLOCATED) {
4891 btf_verifier_log_type(env, t, "Linkage not supported");
4892 return -EINVAL;
4893 }
4894
4895 btf_verifier_log_type(env, t, NULL);
4896
4897 return meta_needed;
4898 }
4899
btf_var_log(struct btf_verifier_env * env,const struct btf_type * t)4900 static void btf_var_log(struct btf_verifier_env *env, const struct btf_type *t)
4901 {
4902 const struct btf_var *var = btf_type_var(t);
4903
4904 btf_verifier_log(env, "type_id=%u linkage=%u", t->type, var->linkage);
4905 }
4906
4907 static const struct btf_kind_operations var_ops = {
4908 .check_meta = btf_var_check_meta,
4909 .resolve = btf_var_resolve,
4910 .check_member = btf_df_check_member,
4911 .check_kflag_member = btf_df_check_kflag_member,
4912 .log_details = btf_var_log,
4913 .show = btf_var_show,
4914 };
4915
btf_datasec_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)4916 static s32 btf_datasec_check_meta(struct btf_verifier_env *env,
4917 const struct btf_type *t,
4918 u32 meta_left)
4919 {
4920 const struct btf_var_secinfo *vsi;
4921 u64 last_vsi_end_off = 0, sum = 0;
4922 u32 i, meta_needed;
4923
4924 meta_needed = btf_type_vlen(t) * sizeof(*vsi);
4925 if (meta_left < meta_needed) {
4926 btf_verifier_log_basic(env, t,
4927 "meta_left:%u meta_needed:%u",
4928 meta_left, meta_needed);
4929 return -EINVAL;
4930 }
4931
4932 if (!t->size) {
4933 btf_verifier_log_type(env, t, "size == 0");
4934 return -EINVAL;
4935 }
4936
4937 if (btf_type_kflag(t)) {
4938 btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
4939 return -EINVAL;
4940 }
4941
4942 if (!t->name_off ||
4943 !btf_name_valid_section(env->btf, t->name_off)) {
4944 btf_verifier_log_type(env, t, "Invalid name");
4945 return -EINVAL;
4946 }
4947
4948 btf_verifier_log_type(env, t, NULL);
4949
4950 for_each_vsi(i, t, vsi) {
4951 /* A var cannot be in type void */
4952 if (!vsi->type || !BTF_TYPE_ID_VALID(vsi->type)) {
4953 btf_verifier_log_vsi(env, t, vsi,
4954 "Invalid type_id");
4955 return -EINVAL;
4956 }
4957
4958 if (vsi->offset < last_vsi_end_off || vsi->offset >= t->size) {
4959 btf_verifier_log_vsi(env, t, vsi,
4960 "Invalid offset");
4961 return -EINVAL;
4962 }
4963
4964 if (!vsi->size || vsi->size > t->size) {
4965 btf_verifier_log_vsi(env, t, vsi,
4966 "Invalid size");
4967 return -EINVAL;
4968 }
4969
4970 last_vsi_end_off = vsi->offset + vsi->size;
4971 if (last_vsi_end_off > t->size) {
4972 btf_verifier_log_vsi(env, t, vsi,
4973 "Invalid offset+size");
4974 return -EINVAL;
4975 }
4976
4977 btf_verifier_log_vsi(env, t, vsi, NULL);
4978 sum += vsi->size;
4979 }
4980
4981 if (t->size < sum) {
4982 btf_verifier_log_type(env, t, "Invalid btf_info size");
4983 return -EINVAL;
4984 }
4985
4986 return meta_needed;
4987 }
4988
btf_datasec_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)4989 static int btf_datasec_resolve(struct btf_verifier_env *env,
4990 const struct resolve_vertex *v)
4991 {
4992 const struct btf_var_secinfo *vsi;
4993 struct btf *btf = env->btf;
4994 u32 i;
4995
4996 env->resolve_mode = RESOLVE_TBD;
4997 for_each_vsi_from(i, v->next_member, v->t, vsi) {
4998 u32 var_type_id = vsi->type, type_id, type_size = 0;
4999 const struct btf_type *var_type = btf_type_by_id(env->btf,
5000 var_type_id);
5001 if (!var_type || !btf_type_is_var(var_type)) {
5002 btf_verifier_log_vsi(env, v->t, vsi,
5003 "Not a VAR kind member");
5004 return -EINVAL;
5005 }
5006
5007 if (!env_type_is_resolve_sink(env, var_type) &&
5008 !env_type_is_resolved(env, var_type_id)) {
5009 env_stack_set_next_member(env, i + 1);
5010 return env_stack_push(env, var_type, var_type_id);
5011 }
5012
5013 type_id = var_type->type;
5014 if (!btf_type_id_size(btf, &type_id, &type_size)) {
5015 btf_verifier_log_vsi(env, v->t, vsi, "Invalid type");
5016 return -EINVAL;
5017 }
5018
5019 if (vsi->size < type_size) {
5020 btf_verifier_log_vsi(env, v->t, vsi, "Invalid size");
5021 return -EINVAL;
5022 }
5023 }
5024
5025 env_stack_pop_resolved(env, 0, 0);
5026 return 0;
5027 }
5028
btf_datasec_log(struct btf_verifier_env * env,const struct btf_type * t)5029 static void btf_datasec_log(struct btf_verifier_env *env,
5030 const struct btf_type *t)
5031 {
5032 btf_verifier_log(env, "size=%u vlen=%u", t->size, btf_type_vlen(t));
5033 }
5034
btf_datasec_show(const struct btf * btf,const struct btf_type * t,u32 type_id,void * data,u8 bits_offset,struct btf_show * show)5035 static void btf_datasec_show(const struct btf *btf,
5036 const struct btf_type *t, u32 type_id,
5037 void *data, u8 bits_offset,
5038 struct btf_show *show)
5039 {
5040 const struct btf_var_secinfo *vsi;
5041 const struct btf_type *var;
5042 u32 i;
5043
5044 if (!btf_show_start_type(show, t, type_id, data))
5045 return;
5046
5047 btf_show_type_value(show, "section (\"%s\") = {",
5048 __btf_name_by_offset(btf, t->name_off));
5049 for_each_vsi(i, t, vsi) {
5050 var = btf_type_by_id(btf, vsi->type);
5051 if (i)
5052 btf_show(show, ",");
5053 btf_type_ops(var)->show(btf, var, vsi->type,
5054 data + vsi->offset, bits_offset, show);
5055 }
5056 btf_show_end_type(show);
5057 }
5058
5059 static const struct btf_kind_operations datasec_ops = {
5060 .check_meta = btf_datasec_check_meta,
5061 .resolve = btf_datasec_resolve,
5062 .check_member = btf_df_check_member,
5063 .check_kflag_member = btf_df_check_kflag_member,
5064 .log_details = btf_datasec_log,
5065 .show = btf_datasec_show,
5066 };
5067
btf_float_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)5068 static s32 btf_float_check_meta(struct btf_verifier_env *env,
5069 const struct btf_type *t,
5070 u32 meta_left)
5071 {
5072 if (btf_type_vlen(t)) {
5073 btf_verifier_log_type(env, t, "vlen != 0");
5074 return -EINVAL;
5075 }
5076
5077 if (btf_type_kflag(t)) {
5078 btf_verifier_log_type(env, t, "Invalid btf_info kind_flag");
5079 return -EINVAL;
5080 }
5081
5082 if (t->size != 2 && t->size != 4 && t->size != 8 && t->size != 12 &&
5083 t->size != 16) {
5084 btf_verifier_log_type(env, t, "Invalid type_size");
5085 return -EINVAL;
5086 }
5087
5088 btf_verifier_log_type(env, t, NULL);
5089
5090 return 0;
5091 }
5092
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)5093 static int btf_float_check_member(struct btf_verifier_env *env,
5094 const struct btf_type *struct_type,
5095 const struct btf_member *member,
5096 const struct btf_type *member_type)
5097 {
5098 u64 start_offset_bytes;
5099 u64 end_offset_bytes;
5100 u64 misalign_bits;
5101 u64 align_bytes;
5102 u64 align_bits;
5103
5104 /* Different architectures have different alignment requirements, so
5105 * here we check only for the reasonable minimum. This way we ensure
5106 * that types after CO-RE can pass the kernel BTF verifier.
5107 */
5108 align_bytes = min_t(u64, sizeof(void *), member_type->size);
5109 align_bits = align_bytes * BITS_PER_BYTE;
5110 div64_u64_rem(member->offset, align_bits, &misalign_bits);
5111 if (misalign_bits) {
5112 btf_verifier_log_member(env, struct_type, member,
5113 "Member is not properly aligned");
5114 return -EINVAL;
5115 }
5116
5117 start_offset_bytes = member->offset / BITS_PER_BYTE;
5118 end_offset_bytes = start_offset_bytes + member_type->size;
5119 if (end_offset_bytes > struct_type->size) {
5120 btf_verifier_log_member(env, struct_type, member,
5121 "Member exceeds struct_size");
5122 return -EINVAL;
5123 }
5124
5125 return 0;
5126 }
5127
btf_float_log(struct btf_verifier_env * env,const struct btf_type * t)5128 static void btf_float_log(struct btf_verifier_env *env,
5129 const struct btf_type *t)
5130 {
5131 btf_verifier_log(env, "size=%u", t->size);
5132 }
5133
5134 static const struct btf_kind_operations float_ops = {
5135 .check_meta = btf_float_check_meta,
5136 .resolve = btf_df_resolve,
5137 .check_member = btf_float_check_member,
5138 .check_kflag_member = btf_generic_check_kflag_member,
5139 .log_details = btf_float_log,
5140 .show = btf_df_show,
5141 };
5142
btf_decl_tag_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)5143 static s32 btf_decl_tag_check_meta(struct btf_verifier_env *env,
5144 const struct btf_type *t,
5145 u32 meta_left)
5146 {
5147 const struct btf_decl_tag *tag;
5148 u32 meta_needed = sizeof(*tag);
5149 s32 component_idx;
5150 const char *value;
5151
5152 if (meta_left < meta_needed) {
5153 btf_verifier_log_basic(env, t,
5154 "meta_left:%u meta_needed:%u",
5155 meta_left, meta_needed);
5156 return -EINVAL;
5157 }
5158
5159 value = btf_name_by_offset(env->btf, t->name_off);
5160 if (!value || !value[0]) {
5161 btf_verifier_log_type(env, t, "Invalid value");
5162 return -EINVAL;
5163 }
5164
5165 if (btf_type_vlen(t)) {
5166 btf_verifier_log_type(env, t, "vlen != 0");
5167 return -EINVAL;
5168 }
5169
5170 component_idx = btf_type_decl_tag(t)->component_idx;
5171 if (component_idx < -1) {
5172 btf_verifier_log_type(env, t, "Invalid component_idx");
5173 return -EINVAL;
5174 }
5175
5176 btf_verifier_log_type(env, t, NULL);
5177
5178 return meta_needed;
5179 }
5180
btf_decl_tag_resolve(struct btf_verifier_env * env,const struct resolve_vertex * v)5181 static int btf_decl_tag_resolve(struct btf_verifier_env *env,
5182 const struct resolve_vertex *v)
5183 {
5184 const struct btf_type *next_type;
5185 const struct btf_type *t = v->t;
5186 u32 next_type_id = t->type;
5187 struct btf *btf = env->btf;
5188 s32 component_idx;
5189 u32 vlen;
5190
5191 next_type = btf_type_by_id(btf, next_type_id);
5192 if (!next_type || !btf_type_is_decl_tag_target(next_type)) {
5193 btf_verifier_log_type(env, v->t, "Invalid type_id");
5194 return -EINVAL;
5195 }
5196
5197 if (!env_type_is_resolve_sink(env, next_type) &&
5198 !env_type_is_resolved(env, next_type_id))
5199 return env_stack_push(env, next_type, next_type_id);
5200
5201 component_idx = btf_type_decl_tag(t)->component_idx;
5202 if (component_idx != -1) {
5203 if (btf_type_is_var(next_type) || btf_type_is_typedef(next_type)) {
5204 btf_verifier_log_type(env, v->t, "Invalid component_idx");
5205 return -EINVAL;
5206 }
5207
5208 if (btf_type_is_struct(next_type)) {
5209 vlen = btf_type_vlen(next_type);
5210 } else {
5211 /* next_type should be a function */
5212 next_type = btf_type_by_id(btf, next_type->type);
5213 vlen = btf_type_vlen(next_type);
5214 }
5215
5216 if ((u32)component_idx >= vlen) {
5217 btf_verifier_log_type(env, v->t, "Invalid component_idx");
5218 return -EINVAL;
5219 }
5220 }
5221
5222 env_stack_pop_resolved(env, next_type_id, 0);
5223
5224 return 0;
5225 }
5226
btf_decl_tag_log(struct btf_verifier_env * env,const struct btf_type * t)5227 static void btf_decl_tag_log(struct btf_verifier_env *env, const struct btf_type *t)
5228 {
5229 btf_verifier_log(env, "type=%u component_idx=%d", t->type,
5230 btf_type_decl_tag(t)->component_idx);
5231 }
5232
5233 static const struct btf_kind_operations decl_tag_ops = {
5234 .check_meta = btf_decl_tag_check_meta,
5235 .resolve = btf_decl_tag_resolve,
5236 .check_member = btf_df_check_member,
5237 .check_kflag_member = btf_df_check_kflag_member,
5238 .log_details = btf_decl_tag_log,
5239 .show = btf_df_show,
5240 };
5241
btf_func_proto_check(struct btf_verifier_env * env,const struct btf_type * t)5242 static int btf_func_proto_check(struct btf_verifier_env *env,
5243 const struct btf_type *t)
5244 {
5245 const struct btf_type *ret_type;
5246 const struct btf_param *args;
5247 const struct btf *btf;
5248 u32 nr_args, i;
5249 int err;
5250
5251 btf = env->btf;
5252 args = (const struct btf_param *)(t + 1);
5253 nr_args = btf_type_vlen(t);
5254
5255 /* Check func return type which could be "void" (t->type == 0) */
5256 if (t->type) {
5257 u32 ret_type_id = t->type;
5258
5259 ret_type = btf_type_by_id(btf, ret_type_id);
5260 if (!ret_type) {
5261 btf_verifier_log_type(env, t, "Invalid return type");
5262 return -EINVAL;
5263 }
5264
5265 if (btf_type_is_resolve_source_only(ret_type)) {
5266 btf_verifier_log_type(env, t, "Invalid return type");
5267 return -EINVAL;
5268 }
5269
5270 if (btf_type_needs_resolve(ret_type) &&
5271 !env_type_is_resolved(env, ret_type_id)) {
5272 err = btf_resolve(env, ret_type, ret_type_id);
5273 if (err)
5274 return err;
5275 }
5276
5277 /* Ensure the return type is a type that has a size */
5278 if (!btf_type_id_size(btf, &ret_type_id, NULL)) {
5279 btf_verifier_log_type(env, t, "Invalid return type");
5280 return -EINVAL;
5281 }
5282 }
5283
5284 if (!nr_args)
5285 return 0;
5286
5287 /* Last func arg type_id could be 0 if it is a vararg */
5288 if (!args[nr_args - 1].type) {
5289 if (args[nr_args - 1].name_off) {
5290 btf_verifier_log_type(env, t, "Invalid arg#%u",
5291 nr_args);
5292 return -EINVAL;
5293 }
5294 nr_args--;
5295 }
5296
5297 for (i = 0; i < nr_args; i++) {
5298 const struct btf_type *arg_type;
5299 u32 arg_type_id;
5300
5301 arg_type_id = args[i].type;
5302 arg_type = btf_type_by_id(btf, arg_type_id);
5303 if (!arg_type) {
5304 btf_verifier_log_type(env, t, "Invalid arg#%u", i + 1);
5305 return -EINVAL;
5306 }
5307
5308 if (btf_type_is_resolve_source_only(arg_type)) {
5309 btf_verifier_log_type(env, t, "Invalid arg#%u", i + 1);
5310 return -EINVAL;
5311 }
5312
5313 if (args[i].name_off &&
5314 (!btf_name_offset_valid(btf, args[i].name_off) ||
5315 !btf_name_valid_identifier(btf, args[i].name_off))) {
5316 btf_verifier_log_type(env, t,
5317 "Invalid arg#%u", i + 1);
5318 return -EINVAL;
5319 }
5320
5321 if (btf_type_needs_resolve(arg_type) &&
5322 !env_type_is_resolved(env, arg_type_id)) {
5323 err = btf_resolve(env, arg_type, arg_type_id);
5324 if (err)
5325 return err;
5326 }
5327
5328 if (!btf_type_id_size(btf, &arg_type_id, NULL)) {
5329 btf_verifier_log_type(env, t, "Invalid arg#%u", i + 1);
5330 return -EINVAL;
5331 }
5332 }
5333
5334 return 0;
5335 }
5336
btf_func_check(struct btf_verifier_env * env,const struct btf_type * t)5337 static int btf_func_check(struct btf_verifier_env *env,
5338 const struct btf_type *t)
5339 {
5340 const struct btf_type *proto_type;
5341 const struct btf_param *args;
5342 const struct btf *btf;
5343 u32 nr_args, i;
5344
5345 btf = env->btf;
5346 proto_type = btf_type_by_id(btf, t->type);
5347
5348 if (!proto_type || !btf_type_is_func_proto(proto_type)) {
5349 btf_verifier_log_type(env, t, "Invalid type_id");
5350 return -EINVAL;
5351 }
5352
5353 args = (const struct btf_param *)(proto_type + 1);
5354 nr_args = btf_type_vlen(proto_type);
5355 for (i = 0; i < nr_args; i++) {
5356 if (!args[i].name_off && args[i].type) {
5357 btf_verifier_log_type(env, t, "Invalid arg#%u", i + 1);
5358 return -EINVAL;
5359 }
5360 }
5361
5362 return 0;
5363 }
5364
5365 static const struct btf_kind_operations * const kind_ops[NR_BTF_KINDS] = {
5366 [BTF_KIND_INT] = &int_ops,
5367 [BTF_KIND_PTR] = &ptr_ops,
5368 [BTF_KIND_ARRAY] = &array_ops,
5369 [BTF_KIND_STRUCT] = &struct_ops,
5370 [BTF_KIND_UNION] = &struct_ops,
5371 [BTF_KIND_ENUM] = &enum_ops,
5372 [BTF_KIND_FWD] = &fwd_ops,
5373 [BTF_KIND_TYPEDEF] = &modifier_ops,
5374 [BTF_KIND_VOLATILE] = &modifier_ops,
5375 [BTF_KIND_CONST] = &modifier_ops,
5376 [BTF_KIND_RESTRICT] = &modifier_ops,
5377 [BTF_KIND_FUNC] = &func_ops,
5378 [BTF_KIND_FUNC_PROTO] = &func_proto_ops,
5379 [BTF_KIND_VAR] = &var_ops,
5380 [BTF_KIND_DATASEC] = &datasec_ops,
5381 [BTF_KIND_FLOAT] = &float_ops,
5382 [BTF_KIND_DECL_TAG] = &decl_tag_ops,
5383 [BTF_KIND_TYPE_TAG] = &modifier_ops,
5384 [BTF_KIND_ENUM64] = &enum64_ops,
5385 };
5386
btf_check_meta(struct btf_verifier_env * env,const struct btf_type * t,u32 meta_left)5387 static s32 btf_check_meta(struct btf_verifier_env *env,
5388 const struct btf_type *t,
5389 u32 meta_left)
5390 {
5391 u32 saved_meta_left = meta_left;
5392 s32 var_meta_size;
5393
5394 if (meta_left < sizeof(*t)) {
5395 btf_verifier_log(env, "[%u] meta_left:%u meta_needed:%zu",
5396 env->log_type_id, meta_left, sizeof(*t));
5397 return -EINVAL;
5398 }
5399 meta_left -= sizeof(*t);
5400
5401 if (BTF_INFO_KIND(t->info) > BTF_KIND_MAX ||
5402 BTF_INFO_KIND(t->info) == BTF_KIND_UNKN) {
5403 btf_verifier_log(env, "[%u] Invalid kind:%u",
5404 env->log_type_id, BTF_INFO_KIND(t->info));
5405 return -EINVAL;
5406 }
5407
5408 if (!btf_name_offset_valid(env->btf, t->name_off)) {
5409 btf_verifier_log(env, "[%u] Invalid name_offset:%u",
5410 env->log_type_id, t->name_off);
5411 return -EINVAL;
5412 }
5413
5414 var_meta_size = btf_type_ops(t)->check_meta(env, t, meta_left);
5415 if (var_meta_size < 0)
5416 return var_meta_size;
5417
5418 meta_left -= var_meta_size;
5419
5420 return saved_meta_left - meta_left;
5421 }
5422
btf_check_all_metas(struct btf_verifier_env * env)5423 static int btf_check_all_metas(struct btf_verifier_env *env)
5424 {
5425 struct btf *btf = env->btf;
5426 struct btf_header *hdr;
5427 void *cur, *end;
5428
5429 hdr = &btf->hdr;
5430 cur = btf->nohdr_data + hdr->type_off;
5431 end = cur + hdr->type_len;
5432
5433 env->log_type_id = btf->base_btf ? btf->start_id : 1;
5434 while (cur < end) {
5435 struct btf_type *t = cur;
5436 s32 meta_size;
5437
5438 meta_size = btf_check_meta(env, t, end - cur);
5439 if (meta_size < 0)
5440 return meta_size;
5441
5442 btf_add_type(env, t);
5443 cur += meta_size;
5444 env->log_type_id++;
5445 }
5446
5447 return 0;
5448 }
5449
btf_resolve_valid(struct btf_verifier_env * env,const struct btf_type * t,u32 type_id)5450 static bool btf_resolve_valid(struct btf_verifier_env *env,
5451 const struct btf_type *t,
5452 u32 type_id)
5453 {
5454 struct btf *btf = env->btf;
5455
5456 if (!env_type_is_resolved(env, type_id))
5457 return false;
5458
5459 if (btf_type_is_struct(t) || btf_type_is_datasec(t))
5460 return !btf_resolved_type_id(btf, type_id) &&
5461 !btf_resolved_type_size(btf, type_id);
5462
5463 if (btf_type_is_decl_tag(t) || btf_type_is_func(t))
5464 return btf_resolved_type_id(btf, type_id) &&
5465 !btf_resolved_type_size(btf, type_id);
5466
5467 if (btf_type_is_modifier(t) || btf_type_is_ptr(t) ||
5468 btf_type_is_var(t)) {
5469 t = btf_type_id_resolve(btf, &type_id);
5470 return t &&
5471 !btf_type_is_modifier(t) &&
5472 !btf_type_is_var(t) &&
5473 !btf_type_is_datasec(t);
5474 }
5475
5476 if (btf_type_is_array(t)) {
5477 const struct btf_array *array = btf_type_array(t);
5478 const struct btf_type *elem_type;
5479 u32 elem_type_id = array->type;
5480 u32 elem_size;
5481
5482 elem_type = btf_type_id_size(btf, &elem_type_id, &elem_size);
5483 return elem_type && !btf_type_is_modifier(elem_type) &&
5484 (array->nelems * elem_size ==
5485 btf_resolved_type_size(btf, type_id));
5486 }
5487
5488 return false;
5489 }
5490
btf_resolve(struct btf_verifier_env * env,const struct btf_type * t,u32 type_id)5491 static int btf_resolve(struct btf_verifier_env *env,
5492 const struct btf_type *t, u32 type_id)
5493 {
5494 u32 save_log_type_id = env->log_type_id;
5495 const struct resolve_vertex *v;
5496 int err = 0;
5497
5498 env->resolve_mode = RESOLVE_TBD;
5499 env_stack_push(env, t, type_id);
5500 while (!err && (v = env_stack_peak(env))) {
5501 env->log_type_id = v->type_id;
5502 err = btf_type_ops(v->t)->resolve(env, v);
5503 }
5504
5505 env->log_type_id = type_id;
5506 if (err == -E2BIG) {
5507 btf_verifier_log_type(env, t,
5508 "Exceeded max resolving depth:%u",
5509 MAX_RESOLVE_DEPTH);
5510 } else if (err == -EEXIST) {
5511 btf_verifier_log_type(env, t, "Loop detected");
5512 }
5513
5514 /* Final sanity check */
5515 if (!err && !btf_resolve_valid(env, t, type_id)) {
5516 btf_verifier_log_type(env, t, "Invalid resolve state");
5517 err = -EINVAL;
5518 }
5519
5520 env->log_type_id = save_log_type_id;
5521 return err;
5522 }
5523
btf_check_all_types(struct btf_verifier_env * env)5524 static int btf_check_all_types(struct btf_verifier_env *env)
5525 {
5526 struct btf *btf = env->btf;
5527 const struct btf_type *t;
5528 u32 type_id, i;
5529 int err;
5530
5531 err = env_resolve_init(env);
5532 if (err)
5533 return err;
5534
5535 env->phase++;
5536 for (i = btf->base_btf ? 0 : 1; i < btf->nr_types; i++) {
5537 type_id = btf->start_id + i;
5538 t = btf_type_by_id(btf, type_id);
5539
5540 env->log_type_id = type_id;
5541 if (btf_type_needs_resolve(t) &&
5542 !env_type_is_resolved(env, type_id)) {
5543 err = btf_resolve(env, t, type_id);
5544 if (err)
5545 return err;
5546 }
5547
5548 if (btf_type_is_func_proto(t)) {
5549 err = btf_func_proto_check(env, t);
5550 if (err)
5551 return err;
5552 }
5553 }
5554
5555 return 0;
5556 }
5557
btf_parse_type_sec(struct btf_verifier_env * env)5558 static int btf_parse_type_sec(struct btf_verifier_env *env)
5559 {
5560 const struct btf_header *hdr = &env->btf->hdr;
5561 int err;
5562
5563 /* Type section must align to 4 bytes */
5564 if (hdr->type_off & (sizeof(u32) - 1)) {
5565 btf_verifier_log(env, "Unaligned type_off");
5566 return -EINVAL;
5567 }
5568
5569 if (!env->btf->base_btf && !hdr->type_len) {
5570 btf_verifier_log(env, "No type found");
5571 return -EINVAL;
5572 }
5573
5574 err = btf_check_all_metas(env);
5575 if (err)
5576 return err;
5577
5578 return btf_check_all_types(env);
5579 }
5580
btf_parse_str_sec(struct btf_verifier_env * env)5581 static int btf_parse_str_sec(struct btf_verifier_env *env)
5582 {
5583 const struct btf_header *hdr;
5584 struct btf *btf = env->btf;
5585 const char *start, *end;
5586
5587 hdr = &btf->hdr;
5588 start = btf->nohdr_data + hdr->str_off;
5589 end = start + hdr->str_len;
5590
5591 if (hdr->hdr_len < sizeof(struct btf_header) &&
5592 end != btf->data + btf->data_size) {
5593 btf_verifier_log(env, "String section is not at the end");
5594 return -EINVAL;
5595 }
5596
5597 btf->strings = start;
5598
5599 if (btf->base_btf && !hdr->str_len)
5600 return 0;
5601 if (!hdr->str_len || hdr->str_len - 1 > BTF_MAX_NAME_OFFSET || end[-1]) {
5602 btf_verifier_log(env, "Invalid string section");
5603 return -EINVAL;
5604 }
5605 if (!btf->base_btf && start[0]) {
5606 btf_verifier_log(env, "Invalid string section");
5607 return -EINVAL;
5608 }
5609
5610 return 0;
5611 }
5612
btf_parse_layout_sec(struct btf_verifier_env * env)5613 static int btf_parse_layout_sec(struct btf_verifier_env *env)
5614 {
5615 const struct btf_header *hdr = &env->btf->hdr;
5616 struct btf *btf = env->btf;
5617 void *start, *end;
5618
5619 if (hdr->hdr_len < sizeof(struct btf_header) ||
5620 hdr->layout_len == 0)
5621 return 0;
5622
5623 /* Layout section must align to 4 bytes */
5624 if (hdr->layout_off & (sizeof(u32) - 1)) {
5625 btf_verifier_log(env, "Unaligned layout_off");
5626 return -EINVAL;
5627 }
5628 start = btf->nohdr_data + hdr->layout_off;
5629 end = start + hdr->layout_len;
5630
5631 if (hdr->layout_len < sizeof(struct btf_layout)) {
5632 btf_verifier_log(env, "Layout section is too small");
5633 return -EINVAL;
5634 }
5635 if (hdr->layout_len % sizeof(struct btf_layout) != 0) {
5636 btf_verifier_log(env, "layout_len is not multiple of %zu",
5637 sizeof(struct btf_layout));
5638 return -EINVAL;
5639 }
5640 if (end > btf->data + btf->data_size) {
5641 btf_verifier_log(env, "Layout section is too big");
5642 return -EINVAL;
5643 }
5644 btf->layout = start;
5645
5646 return 0;
5647 }
5648
5649 static const size_t btf_sec_info_offset[] = {
5650 offsetof(struct btf_header, type_off),
5651 offsetof(struct btf_header, str_off),
5652 offsetof(struct btf_header, layout_off)
5653 };
5654
btf_sec_info_cmp(const void * a,const void * b)5655 static int btf_sec_info_cmp(const void *a, const void *b)
5656 {
5657 const struct btf_sec_info *x = a;
5658 const struct btf_sec_info *y = b;
5659
5660 return (int)(x->off - y->off) ? : (int)(x->len - y->len);
5661 }
5662
btf_check_sec_info(struct btf_verifier_env * env,u32 btf_data_size)5663 static int btf_check_sec_info(struct btf_verifier_env *env,
5664 u32 btf_data_size)
5665 {
5666 struct btf_sec_info secs[ARRAY_SIZE(btf_sec_info_offset)];
5667 u32 total, expected_total, i;
5668 u32 nr_secs = ARRAY_SIZE(btf_sec_info_offset);
5669 const struct btf_header *hdr;
5670 const struct btf *btf;
5671
5672 btf = env->btf;
5673 hdr = &btf->hdr;
5674
5675 if (hdr->hdr_len < sizeof(struct btf_header) || hdr->layout_len == 0)
5676 nr_secs--;
5677
5678 /* Populate the secs from hdr */
5679 for (i = 0; i < nr_secs; i++)
5680 secs[i] = *(struct btf_sec_info *)((void *)hdr +
5681 btf_sec_info_offset[i]);
5682
5683 sort(secs, nr_secs,
5684 sizeof(struct btf_sec_info), btf_sec_info_cmp, NULL);
5685
5686 /* Check for gaps and overlap among sections */
5687 total = 0;
5688 expected_total = btf_data_size - hdr->hdr_len;
5689 for (i = 0; i < nr_secs; i++) {
5690 if (expected_total < secs[i].off) {
5691 btf_verifier_log(env, "Invalid section offset");
5692 return -EINVAL;
5693 }
5694 if (total < secs[i].off) {
5695 /* gap */
5696 btf_verifier_log(env, "Unsupported section found");
5697 return -EINVAL;
5698 }
5699 if (total > secs[i].off) {
5700 btf_verifier_log(env, "Section overlap found");
5701 return -EINVAL;
5702 }
5703 if (expected_total - total < secs[i].len) {
5704 btf_verifier_log(env,
5705 "Total section length too long");
5706 return -EINVAL;
5707 }
5708 total += secs[i].len;
5709 }
5710
5711 /* There is data other than hdr and known sections */
5712 if (expected_total != total) {
5713 btf_verifier_log(env, "Unsupported section found");
5714 return -EINVAL;
5715 }
5716
5717 return 0;
5718 }
5719
btf_parse_hdr(struct btf_verifier_env * env)5720 static int btf_parse_hdr(struct btf_verifier_env *env)
5721 {
5722 u32 hdr_len, hdr_copy, btf_data_size;
5723 const struct btf_header *hdr;
5724 struct btf *btf;
5725
5726 btf = env->btf;
5727 btf_data_size = btf->data_size;
5728
5729 if (btf_data_size < offsetofend(struct btf_header, hdr_len)) {
5730 btf_verifier_log(env, "hdr_len not found");
5731 return -EINVAL;
5732 }
5733
5734 hdr = btf->data;
5735 hdr_len = hdr->hdr_len;
5736 if (btf_data_size < hdr_len) {
5737 btf_verifier_log(env, "btf_header not found");
5738 return -EINVAL;
5739 }
5740
5741 /* Ensure the unsupported header fields are zero */
5742 if (hdr_len > sizeof(btf->hdr)) {
5743 u8 *expected_zero = btf->data + sizeof(btf->hdr);
5744 u8 *end = btf->data + hdr_len;
5745
5746 for (; expected_zero < end; expected_zero++) {
5747 if (*expected_zero) {
5748 btf_verifier_log(env, "Unsupported btf_header");
5749 return -E2BIG;
5750 }
5751 }
5752 }
5753
5754 hdr_copy = min_t(u32, hdr_len, sizeof(btf->hdr));
5755 memcpy(&btf->hdr, btf->data, hdr_copy);
5756
5757 hdr = &btf->hdr;
5758
5759 btf_verifier_log_hdr(env, btf_data_size);
5760
5761 if (hdr->magic != BTF_MAGIC) {
5762 btf_verifier_log(env, "Invalid magic");
5763 return -EINVAL;
5764 }
5765
5766 if (hdr->version != BTF_VERSION) {
5767 btf_verifier_log(env, "Unsupported version");
5768 return -ENOTSUPP;
5769 }
5770
5771 if (hdr->flags) {
5772 btf_verifier_log(env, "Unsupported flags");
5773 return -ENOTSUPP;
5774 }
5775
5776 if (!btf->base_btf && btf_data_size == hdr->hdr_len) {
5777 btf_verifier_log(env, "No data");
5778 return -EINVAL;
5779 }
5780
5781 return btf_check_sec_info(env, btf_data_size);
5782 }
5783
5784 static const char *alloc_obj_fields[] = {
5785 "bpf_spin_lock",
5786 "bpf_list_head",
5787 "bpf_list_node",
5788 "bpf_rb_root",
5789 "bpf_rb_node",
5790 "bpf_refcount",
5791 };
5792
5793 static struct btf_struct_metas *
btf_parse_struct_metas(struct bpf_verifier_log * log,struct btf * btf)5794 btf_parse_struct_metas(struct bpf_verifier_log *log, struct btf *btf)
5795 {
5796 struct btf_struct_metas *tab = NULL;
5797 struct btf_id_set *aof;
5798 int i, n, id, ret;
5799
5800 BUILD_BUG_ON(offsetof(struct btf_id_set, cnt) != 0);
5801 BUILD_BUG_ON(sizeof(struct btf_id_set) != sizeof(u32));
5802
5803 aof = kmalloc_obj(*aof, GFP_KERNEL | __GFP_NOWARN);
5804 if (!aof)
5805 return ERR_PTR(-ENOMEM);
5806 aof->cnt = 0;
5807
5808 for (i = 0; i < ARRAY_SIZE(alloc_obj_fields); i++) {
5809 /* Try to find whether this special type exists in user BTF, and
5810 * if so remember its ID so we can easily find it among members
5811 * of structs that we iterate in the next loop.
5812 */
5813 struct btf_id_set *new_aof;
5814
5815 id = btf_find_by_name_kind(btf, alloc_obj_fields[i], BTF_KIND_STRUCT);
5816 if (id < 0)
5817 continue;
5818
5819 new_aof = krealloc(aof, struct_size(new_aof, ids, aof->cnt + 1),
5820 GFP_KERNEL | __GFP_NOWARN);
5821 if (!new_aof) {
5822 ret = -ENOMEM;
5823 goto free_aof;
5824 }
5825 aof = new_aof;
5826 aof->ids[aof->cnt++] = id;
5827 }
5828
5829 n = btf_nr_types(btf);
5830 for (i = 1; i < n; i++) {
5831 /* Try to find if there are kptrs in user BTF and remember their ID */
5832 struct btf_id_set *new_aof;
5833 struct btf_field_info tmp;
5834 const struct btf_type *t;
5835
5836 t = btf_type_by_id(btf, i);
5837 if (!t) {
5838 ret = -EINVAL;
5839 goto free_aof;
5840 }
5841
5842 ret = btf_find_kptr(btf, t, 0, 0, &tmp, BPF_KPTR);
5843 if (ret != BTF_FIELD_FOUND)
5844 continue;
5845
5846 new_aof = krealloc(aof, struct_size(new_aof, ids, aof->cnt + 1),
5847 GFP_KERNEL | __GFP_NOWARN);
5848 if (!new_aof) {
5849 ret = -ENOMEM;
5850 goto free_aof;
5851 }
5852 aof = new_aof;
5853 aof->ids[aof->cnt++] = i;
5854 }
5855
5856 if (!aof->cnt) {
5857 kfree(aof);
5858 return NULL;
5859 }
5860 sort(&aof->ids, aof->cnt, sizeof(aof->ids[0]), btf_id_cmp_func, NULL);
5861
5862 for (i = 1; i < n; i++) {
5863 struct btf_struct_metas *new_tab;
5864 const struct btf_member *member;
5865 struct btf_struct_meta *type;
5866 struct btf_record *record;
5867 const struct btf_type *t;
5868 int j, tab_cnt;
5869
5870 t = btf_type_by_id(btf, i);
5871 if (!__btf_type_is_struct(t))
5872 continue;
5873
5874 cond_resched();
5875
5876 for_each_member(j, t, member) {
5877 if (btf_id_set_contains(aof, member->type))
5878 goto parse;
5879 }
5880 continue;
5881 parse:
5882 tab_cnt = tab ? tab->cnt : 0;
5883 new_tab = krealloc(tab, struct_size(new_tab, types, tab_cnt + 1),
5884 GFP_KERNEL | __GFP_NOWARN);
5885 if (!new_tab) {
5886 ret = -ENOMEM;
5887 goto free;
5888 }
5889 if (!tab)
5890 new_tab->cnt = 0;
5891 tab = new_tab;
5892
5893 type = &tab->types[tab->cnt];
5894 type->btf_id = i;
5895 record = btf_parse_fields(btf, t, BPF_SPIN_LOCK | BPF_RES_SPIN_LOCK | BPF_LIST_HEAD | BPF_LIST_NODE |
5896 BPF_RB_ROOT | BPF_RB_NODE | BPF_REFCOUNT |
5897 BPF_KPTR, t->size);
5898 /* The record cannot be unset, treat it as an error if so */
5899 if (IS_ERR_OR_NULL(record)) {
5900 ret = PTR_ERR_OR_ZERO(record) ?: -EFAULT;
5901 goto free;
5902 }
5903 type->record = record;
5904 tab->cnt++;
5905 }
5906 kfree(aof);
5907 return tab;
5908 free:
5909 btf_struct_metas_free(tab);
5910 free_aof:
5911 kfree(aof);
5912 return ERR_PTR(ret);
5913 }
5914
btf_find_struct_meta(const struct btf * btf,u32 btf_id)5915 struct btf_struct_meta *btf_find_struct_meta(const struct btf *btf, u32 btf_id)
5916 {
5917 struct btf_struct_metas *tab;
5918
5919 BUILD_BUG_ON(offsetof(struct btf_struct_meta, btf_id) != 0);
5920 tab = btf->struct_meta_tab;
5921 if (!tab)
5922 return NULL;
5923 return bsearch(&btf_id, tab->types, tab->cnt, sizeof(tab->types[0]), btf_id_cmp_func);
5924 }
5925
btf_check_modifier_chain_length(struct btf_verifier_env * env,struct btf * btf,int start_id)5926 static int btf_check_modifier_chain_length(struct btf_verifier_env *env,
5927 struct btf *btf, int start_id)
5928 {
5929 int i, n, good_id = start_id - 1;
5930
5931 n = btf_nr_types(btf);
5932 for (i = start_id; i < n; i++) {
5933 const struct btf_type *t;
5934 int chain_limit = 32;
5935 u32 cur_id = i;
5936
5937 t = btf_type_by_id(btf, i);
5938 if (!t)
5939 return -EINVAL;
5940 if (!btf_type_is_modifier(t))
5941 continue;
5942
5943 cond_resched();
5944
5945 while (btf_type_is_modifier(t)) {
5946 if (!chain_limit--) {
5947 btf_verifier_log(env, "Max chain length or cycle detected");
5948 return -ELOOP;
5949 }
5950
5951 if (cur_id <= good_id)
5952 break;
5953 /* Move to next type */
5954 cur_id = t->type;
5955 t = btf_type_by_id(btf, cur_id);
5956 if (!t)
5957 return -EINVAL;
5958 }
5959 good_id = i;
5960 }
5961 return 0;
5962 }
5963
btf_parse(const union bpf_attr * attr,bpfptr_t uattr,struct bpf_log_attr * attr_log)5964 static struct btf *btf_parse(const union bpf_attr *attr, bpfptr_t uattr,
5965 struct bpf_log_attr *attr_log)
5966 {
5967 bpfptr_t btf_data = make_bpfptr(attr->btf, uattr.is_kernel);
5968 struct btf_struct_metas *struct_meta_tab;
5969 struct btf_verifier_env *env = NULL;
5970 struct btf *btf = NULL;
5971 u8 *data;
5972 int err, ret;
5973
5974 if (attr->btf_size > BTF_MAX_SIZE)
5975 return ERR_PTR(-E2BIG);
5976
5977 env = kzalloc_obj(*env, GFP_KERNEL | __GFP_NOWARN);
5978 if (!env)
5979 return ERR_PTR(-ENOMEM);
5980
5981 /* user could have requested verbose verifier output
5982 * and supplied buffer to store the verification trace
5983 */
5984 err = bpf_vlog_init(&env->log, attr_log->level, attr_log->ubuf, attr_log->size);
5985 if (err)
5986 goto errout_free;
5987
5988 btf = kzalloc_obj(*btf, GFP_KERNEL | __GFP_NOWARN);
5989 if (!btf) {
5990 err = -ENOMEM;
5991 goto errout;
5992 }
5993 env->btf = btf;
5994 btf->named_start_id = 0;
5995
5996 data = kvmalloc(attr->btf_size, GFP_KERNEL | __GFP_NOWARN);
5997 if (!data) {
5998 err = -ENOMEM;
5999 goto errout;
6000 }
6001
6002 btf->data = data;
6003 btf->data_size = attr->btf_size;
6004
6005 if (copy_from_bpfptr(data, btf_data, attr->btf_size)) {
6006 err = -EFAULT;
6007 goto errout;
6008 }
6009
6010 err = btf_parse_hdr(env);
6011 if (err)
6012 goto errout;
6013
6014 btf->nohdr_data = btf->data + btf->hdr.hdr_len;
6015
6016 err = btf_parse_str_sec(env);
6017 if (err)
6018 goto errout;
6019
6020 err = btf_parse_layout_sec(env);
6021 if (err)
6022 goto errout;
6023
6024 err = btf_parse_type_sec(env);
6025 if (err)
6026 goto errout;
6027
6028 err = btf_check_modifier_chain_length(env, btf, 1);
6029 if (err)
6030 goto errout;
6031
6032 struct_meta_tab = btf_parse_struct_metas(&env->log, btf);
6033 if (IS_ERR(struct_meta_tab)) {
6034 err = PTR_ERR(struct_meta_tab);
6035 goto errout;
6036 }
6037 btf->struct_meta_tab = struct_meta_tab;
6038
6039 if (struct_meta_tab) {
6040 int i;
6041
6042 for (i = 0; i < struct_meta_tab->cnt; i++) {
6043 err = btf_check_and_fixup_fields(btf, struct_meta_tab->types[i].record);
6044 if (err < 0)
6045 goto errout_meta;
6046 }
6047 }
6048
6049 err = bpf_log_attr_finalize(attr_log, &env->log);
6050 if (err)
6051 goto errout_free;
6052
6053 btf_verifier_env_free(env);
6054 refcount_set(&btf->refcnt, 1);
6055 return btf;
6056
6057 errout_meta:
6058 btf_free_struct_meta_tab(btf);
6059 errout:
6060 /* overwrite err with -ENOSPC or -EFAULT */
6061 ret = bpf_log_attr_finalize(attr_log, &env->log);
6062 if (ret)
6063 err = ret;
6064 errout_free:
6065 btf_verifier_env_free(env);
6066 if (btf)
6067 btf_free(btf);
6068 return ERR_PTR(err);
6069 }
6070
6071 extern char __start_BTF[];
6072 extern char __stop_BTF[];
6073 extern struct btf *btf_vmlinux;
6074
6075 #define BPF_MAP_TYPE(_id, _ops)
6076 #define BPF_LINK_TYPE(_id, _name)
6077 static union {
6078 struct bpf_ctx_convert {
6079 #define BPF_PROG_TYPE(_id, _name, prog_ctx_type, kern_ctx_type) \
6080 prog_ctx_type _id##_prog; \
6081 kern_ctx_type _id##_kern;
6082 #include <linux/bpf_types.h>
6083 #undef BPF_PROG_TYPE
6084 } *__t;
6085 /* 't' is written once under lock. Read many times. */
6086 const struct btf_type *t;
6087 } bpf_ctx_convert;
6088 enum {
6089 #define BPF_PROG_TYPE(_id, _name, prog_ctx_type, kern_ctx_type) \
6090 __ctx_convert##_id,
6091 #include <linux/bpf_types.h>
6092 #undef BPF_PROG_TYPE
6093 __ctx_convert_unused, /* to avoid empty enum in extreme .config */
6094 };
6095 static u8 bpf_ctx_convert_map[] = {
6096 #define BPF_PROG_TYPE(_id, _name, prog_ctx_type, kern_ctx_type) \
6097 [_id] = __ctx_convert##_id,
6098 #include <linux/bpf_types.h>
6099 #undef BPF_PROG_TYPE
6100 0, /* avoid empty array */
6101 };
6102 #undef BPF_MAP_TYPE
6103 #undef BPF_LINK_TYPE
6104
find_canonical_prog_ctx_type(enum bpf_prog_type prog_type)6105 static const struct btf_type *find_canonical_prog_ctx_type(enum bpf_prog_type prog_type)
6106 {
6107 const struct btf_type *conv_struct;
6108 const struct btf_member *ctx_type;
6109
6110 conv_struct = bpf_ctx_convert.t;
6111 if (!conv_struct)
6112 return NULL;
6113 /* prog_type is valid bpf program type. No need for bounds check. */
6114 ctx_type = btf_type_member(conv_struct) + bpf_ctx_convert_map[prog_type] * 2;
6115 /* ctx_type is a pointer to prog_ctx_type in vmlinux.
6116 * Like 'struct __sk_buff'
6117 */
6118 return btf_type_by_id(btf_vmlinux, ctx_type->type);
6119 }
6120
find_kern_ctx_type_id(enum bpf_prog_type prog_type)6121 static int find_kern_ctx_type_id(enum bpf_prog_type prog_type)
6122 {
6123 const struct btf_type *conv_struct;
6124 const struct btf_member *ctx_type;
6125
6126 conv_struct = bpf_ctx_convert.t;
6127 if (!conv_struct)
6128 return -EFAULT;
6129 /* prog_type is valid bpf program type. No need for bounds check. */
6130 ctx_type = btf_type_member(conv_struct) + bpf_ctx_convert_map[prog_type] * 2 + 1;
6131 /* ctx_type is a pointer to prog_ctx_type in vmlinux.
6132 * Like 'struct sk_buff'
6133 */
6134 return ctx_type->type;
6135 }
6136
btf_is_projection_of(const char * pname,const char * tname)6137 bool btf_is_projection_of(const char *pname, const char *tname)
6138 {
6139 if (strcmp(pname, "__sk_buff") == 0 && strcmp(tname, "sk_buff") == 0)
6140 return true;
6141 if (strcmp(pname, "xdp_md") == 0 && strcmp(tname, "xdp_buff") == 0)
6142 return true;
6143 return false;
6144 }
6145
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)6146 bool btf_is_prog_ctx_type(struct bpf_verifier_log *log, const struct btf *btf,
6147 const struct btf_type *t, enum bpf_prog_type prog_type,
6148 int arg)
6149 {
6150 const struct btf_type *ctx_type;
6151 const char *tname, *ctx_tname;
6152
6153 t = btf_type_by_id(btf, t->type);
6154
6155 /* KPROBE programs allow bpf_user_pt_regs_t typedef, which we need to
6156 * check before we skip all the typedef below.
6157 */
6158 if (prog_type == BPF_PROG_TYPE_KPROBE) {
6159 while (btf_type_is_modifier(t) && !btf_type_is_typedef(t))
6160 t = btf_type_by_id(btf, t->type);
6161
6162 if (btf_type_is_typedef(t)) {
6163 tname = btf_name_by_offset(btf, t->name_off);
6164 if (tname && strcmp(tname, "bpf_user_pt_regs_t") == 0)
6165 return true;
6166 }
6167 }
6168
6169 while (btf_type_is_modifier(t))
6170 t = btf_type_by_id(btf, t->type);
6171 if (!btf_type_is_struct(t)) {
6172 /* Only pointer to struct is supported for now.
6173 * That means that BPF_PROG_TYPE_TRACEPOINT with BTF
6174 * is not supported yet.
6175 * BPF_PROG_TYPE_RAW_TRACEPOINT is fine.
6176 */
6177 return false;
6178 }
6179 tname = btf_name_by_offset(btf, t->name_off);
6180 if (!tname) {
6181 bpf_log(log, "arg#%d struct doesn't have a name\n", arg);
6182 return false;
6183 }
6184
6185 ctx_type = find_canonical_prog_ctx_type(prog_type);
6186 if (!ctx_type) {
6187 bpf_log(log, "btf_vmlinux is malformed\n");
6188 /* should not happen */
6189 return false;
6190 }
6191 again:
6192 ctx_tname = btf_name_by_offset(btf_vmlinux, ctx_type->name_off);
6193 if (!ctx_tname) {
6194 /* should not happen */
6195 bpf_log(log, "Please fix kernel include/linux/bpf_types.h\n");
6196 return false;
6197 }
6198 /* program types without named context types work only with arg:ctx tag */
6199 if (ctx_tname[0] == '\0')
6200 return false;
6201 /* only compare that prog's ctx type name is the same as
6202 * kernel expects. No need to compare field by field.
6203 * It's ok for bpf prog to do:
6204 * struct __sk_buff {};
6205 * int socket_filter_bpf_prog(struct __sk_buff *skb)
6206 * { // no fields of skb are ever used }
6207 */
6208 if (btf_is_projection_of(ctx_tname, tname))
6209 return true;
6210 if (strcmp(ctx_tname, tname)) {
6211 /* bpf_user_pt_regs_t is a typedef, so resolve it to
6212 * underlying struct and check name again
6213 */
6214 if (!btf_type_is_modifier(ctx_type))
6215 return false;
6216 while (btf_type_is_modifier(ctx_type))
6217 ctx_type = btf_type_by_id(btf_vmlinux, ctx_type->type);
6218 goto again;
6219 }
6220 return true;
6221 }
6222
6223 /* forward declarations for arch-specific underlying types of
6224 * bpf_user_pt_regs_t; this avoids the need for arch-specific #ifdef
6225 * compilation guards below for BPF_PROG_TYPE_PERF_EVENT checks, but still
6226 * works correctly with __builtin_types_compatible_p() on respective
6227 * architectures
6228 */
6229 struct user_regs_struct;
6230 struct user_pt_regs;
6231
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)6232 static int btf_validate_prog_ctx_type(struct bpf_verifier_log *log, const struct btf *btf,
6233 const struct btf_type *t, int arg,
6234 enum bpf_prog_type prog_type,
6235 enum bpf_attach_type attach_type)
6236 {
6237 const struct btf_type *ctx_type;
6238 const char *tname, *ctx_tname;
6239
6240 if (!btf_is_ptr(t)) {
6241 bpf_log(log, "arg#%d type isn't a pointer\n", arg);
6242 return -EINVAL;
6243 }
6244 t = btf_type_by_id(btf, t->type);
6245
6246 /* KPROBE and PERF_EVENT programs allow bpf_user_pt_regs_t typedef */
6247 if (prog_type == BPF_PROG_TYPE_KPROBE || prog_type == BPF_PROG_TYPE_PERF_EVENT) {
6248 while (btf_type_is_modifier(t) && !btf_type_is_typedef(t))
6249 t = btf_type_by_id(btf, t->type);
6250
6251 if (btf_type_is_typedef(t)) {
6252 tname = btf_name_by_offset(btf, t->name_off);
6253 if (tname && strcmp(tname, "bpf_user_pt_regs_t") == 0)
6254 return 0;
6255 }
6256 }
6257
6258 /* all other program types don't use typedefs for context type */
6259 while (btf_type_is_modifier(t))
6260 t = btf_type_by_id(btf, t->type);
6261
6262 /* `void *ctx __arg_ctx` is always valid */
6263 if (btf_type_is_void(t))
6264 return 0;
6265
6266 tname = btf_name_by_offset(btf, t->name_off);
6267 if (str_is_empty(tname)) {
6268 bpf_log(log, "arg#%d type doesn't have a name\n", arg);
6269 return -EINVAL;
6270 }
6271
6272 /* special cases */
6273 switch (prog_type) {
6274 case BPF_PROG_TYPE_KPROBE:
6275 if (__btf_type_is_struct(t) && strcmp(tname, "pt_regs") == 0)
6276 return 0;
6277 break;
6278 case BPF_PROG_TYPE_PERF_EVENT:
6279 if (__builtin_types_compatible_p(bpf_user_pt_regs_t, struct pt_regs) &&
6280 __btf_type_is_struct(t) && strcmp(tname, "pt_regs") == 0)
6281 return 0;
6282 if (__builtin_types_compatible_p(bpf_user_pt_regs_t, struct user_pt_regs) &&
6283 __btf_type_is_struct(t) && strcmp(tname, "user_pt_regs") == 0)
6284 return 0;
6285 if (__builtin_types_compatible_p(bpf_user_pt_regs_t, struct user_regs_struct) &&
6286 __btf_type_is_struct(t) && strcmp(tname, "user_regs_struct") == 0)
6287 return 0;
6288 break;
6289 case BPF_PROG_TYPE_RAW_TRACEPOINT:
6290 case BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE:
6291 /* allow u64* as ctx */
6292 if (btf_is_int(t) && t->size == 8)
6293 return 0;
6294 break;
6295 case BPF_PROG_TYPE_TRACING:
6296 switch (attach_type) {
6297 case BPF_TRACE_RAW_TP:
6298 /* tp_btf program is TRACING, so need special case here */
6299 if (__btf_type_is_struct(t) &&
6300 strcmp(tname, "bpf_raw_tracepoint_args") == 0)
6301 return 0;
6302 /* allow u64* as ctx */
6303 if (btf_is_int(t) && t->size == 8)
6304 return 0;
6305 break;
6306 case BPF_TRACE_ITER:
6307 /* allow struct bpf_iter__xxx types only */
6308 if (__btf_type_is_struct(t) &&
6309 strncmp(tname, "bpf_iter__", sizeof("bpf_iter__") - 1) == 0)
6310 return 0;
6311 break;
6312 case BPF_TRACE_FENTRY:
6313 case BPF_TRACE_FEXIT:
6314 case BPF_MODIFY_RETURN:
6315 case BPF_TRACE_FSESSION:
6316 /* allow u64* as ctx */
6317 if (btf_is_int(t) && t->size == 8)
6318 return 0;
6319 break;
6320 default:
6321 break;
6322 }
6323 break;
6324 case BPF_PROG_TYPE_LSM:
6325 case BPF_PROG_TYPE_STRUCT_OPS:
6326 /* allow u64* as ctx */
6327 if (btf_is_int(t) && t->size == 8)
6328 return 0;
6329 break;
6330 case BPF_PROG_TYPE_TRACEPOINT:
6331 case BPF_PROG_TYPE_SYSCALL:
6332 case BPF_PROG_TYPE_EXT:
6333 return 0; /* anything goes */
6334 default:
6335 break;
6336 }
6337
6338 ctx_type = find_canonical_prog_ctx_type(prog_type);
6339 if (!ctx_type) {
6340 /* should not happen */
6341 bpf_log(log, "btf_vmlinux is malformed\n");
6342 return -EINVAL;
6343 }
6344
6345 /* resolve typedefs and check that underlying structs are matching as well */
6346 while (btf_type_is_modifier(ctx_type))
6347 ctx_type = btf_type_by_id(btf_vmlinux, ctx_type->type);
6348
6349 /* if program type doesn't have distinctly named struct type for
6350 * context, then __arg_ctx argument can only be `void *`, which we
6351 * already checked above
6352 */
6353 if (!__btf_type_is_struct(ctx_type)) {
6354 bpf_log(log, "arg#%d should be void pointer\n", arg);
6355 return -EINVAL;
6356 }
6357
6358 ctx_tname = btf_name_by_offset(btf_vmlinux, ctx_type->name_off);
6359 if (!__btf_type_is_struct(t) || strcmp(ctx_tname, tname) != 0) {
6360 bpf_log(log, "arg#%d should be `struct %s *`\n", arg, ctx_tname);
6361 return -EINVAL;
6362 }
6363
6364 return 0;
6365 }
6366
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)6367 static int btf_translate_to_vmlinux(struct bpf_verifier_log *log,
6368 struct btf *btf,
6369 const struct btf_type *t,
6370 enum bpf_prog_type prog_type,
6371 int arg)
6372 {
6373 if (!btf_is_prog_ctx_type(log, btf, t, prog_type, arg))
6374 return -ENOENT;
6375 return find_kern_ctx_type_id(prog_type);
6376 }
6377
get_kern_ctx_btf_id(struct bpf_verifier_log * log,enum bpf_prog_type prog_type)6378 int get_kern_ctx_btf_id(struct bpf_verifier_log *log, enum bpf_prog_type prog_type)
6379 {
6380 const struct btf_member *kctx_member;
6381 const struct btf_type *conv_struct;
6382 const struct btf_type *kctx_type;
6383 u32 kctx_type_id;
6384
6385 conv_struct = bpf_ctx_convert.t;
6386 /* get member for kernel ctx type */
6387 kctx_member = btf_type_member(conv_struct) + bpf_ctx_convert_map[prog_type] * 2 + 1;
6388 kctx_type_id = kctx_member->type;
6389 kctx_type = btf_type_by_id(btf_vmlinux, kctx_type_id);
6390 if (!btf_type_is_struct(kctx_type)) {
6391 bpf_log(log, "kern ctx type id %u is not a struct\n", kctx_type_id);
6392 return -EINVAL;
6393 }
6394
6395 return kctx_type_id;
6396 }
6397
BTF_ID_LIST_SINGLE(bpf_ctx_convert_btf_id,struct,bpf_ctx_convert)6398 BTF_ID_LIST_SINGLE(bpf_ctx_convert_btf_id, struct, bpf_ctx_convert)
6399
6400 static struct btf *btf_parse_base(struct btf_verifier_env *env, const char *name,
6401 void *data, unsigned int data_size)
6402 {
6403 struct btf *btf = NULL;
6404 int err;
6405
6406 if (!IS_ENABLED(CONFIG_DEBUG_INFO_BTF))
6407 return ERR_PTR(-ENOENT);
6408
6409 btf = kzalloc_obj(*btf, GFP_KERNEL | __GFP_NOWARN);
6410 if (!btf) {
6411 err = -ENOMEM;
6412 goto errout;
6413 }
6414 env->btf = btf;
6415
6416 btf->data = data;
6417 btf->data_size = data_size;
6418 btf->kernel_btf = true;
6419 btf->named_start_id = 0;
6420 strscpy(btf->name, name);
6421
6422 err = btf_parse_hdr(env);
6423 if (err)
6424 goto errout;
6425
6426 btf->nohdr_data = btf->data + btf->hdr.hdr_len;
6427
6428 err = btf_parse_str_sec(env);
6429 if (err)
6430 goto errout;
6431
6432 err = btf_check_all_metas(env);
6433 if (err)
6434 goto errout;
6435
6436 err = btf_check_modifier_chain_length(env, btf, 1);
6437 if (err)
6438 goto errout;
6439
6440 btf_check_sorted(btf);
6441 refcount_set(&btf->refcnt, 1);
6442
6443 return btf;
6444
6445 errout:
6446 if (btf) {
6447 kvfree(btf->types);
6448 kfree(btf);
6449 }
6450 return ERR_PTR(err);
6451 }
6452
btf_parse_vmlinux(void)6453 struct btf *btf_parse_vmlinux(void)
6454 {
6455 struct btf_verifier_env *env = NULL;
6456 struct bpf_verifier_log *log;
6457 struct btf *btf;
6458 int err;
6459
6460 env = kzalloc_obj(*env, GFP_KERNEL | __GFP_NOWARN);
6461 if (!env)
6462 return ERR_PTR(-ENOMEM);
6463
6464 log = &env->log;
6465 log->level = BPF_LOG_KERNEL;
6466 btf = btf_parse_base(env, "vmlinux", __start_BTF, __stop_BTF - __start_BTF);
6467 if (IS_ERR(btf))
6468 goto err_out;
6469
6470 /* btf_parse_vmlinux() runs under btf_vmlinux_lock */
6471 bpf_ctx_convert.t = btf_type_by_id(btf, bpf_ctx_convert_btf_id[0]);
6472 err = btf_alloc_id(btf);
6473 if (err) {
6474 btf_free(btf);
6475 btf = ERR_PTR(err);
6476 }
6477 err_out:
6478 btf_verifier_env_free(env);
6479 return btf;
6480 }
6481
6482 /* If .BTF_ids section was created with distilled base BTF, both base and
6483 * split BTF ids will need to be mapped to actual base/split ids for
6484 * BTF now that it has been relocated.
6485 */
btf_relocate_id(const struct btf * btf,__u32 id)6486 __u32 btf_relocate_id(const struct btf *btf, __u32 id)
6487 {
6488 if (!btf->base_btf || !btf->base_id_map)
6489 return id;
6490 return btf->base_id_map[id];
6491 }
6492
6493 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
6494
btf_parse_module(const char * module_name,const void * data,unsigned int data_size,void * base_data,unsigned int base_data_size)6495 static struct btf *btf_parse_module(const char *module_name, const void *data,
6496 unsigned int data_size, void *base_data,
6497 unsigned int base_data_size)
6498 {
6499 struct btf *btf = NULL, *vmlinux_btf, *base_btf = NULL;
6500 struct btf_verifier_env *env = NULL;
6501 struct bpf_verifier_log *log;
6502 int err = 0;
6503
6504 vmlinux_btf = bpf_get_btf_vmlinux();
6505 if (IS_ERR(vmlinux_btf))
6506 return vmlinux_btf;
6507 if (!vmlinux_btf)
6508 return ERR_PTR(-EINVAL);
6509
6510 env = kzalloc_obj(*env, GFP_KERNEL | __GFP_NOWARN);
6511 if (!env)
6512 return ERR_PTR(-ENOMEM);
6513
6514 log = &env->log;
6515 log->level = BPF_LOG_KERNEL;
6516
6517 if (base_data) {
6518 base_btf = btf_parse_base(env, ".BTF.base", base_data, base_data_size);
6519 if (IS_ERR(base_btf)) {
6520 err = PTR_ERR(base_btf);
6521 goto errout;
6522 }
6523 } else {
6524 base_btf = vmlinux_btf;
6525 }
6526
6527 btf = kzalloc_obj(*btf, GFP_KERNEL | __GFP_NOWARN);
6528 if (!btf) {
6529 err = -ENOMEM;
6530 goto errout;
6531 }
6532 env->btf = btf;
6533
6534 btf->base_btf = base_btf;
6535 btf->start_id = base_btf->nr_types;
6536 btf->start_str_off = base_btf->hdr.str_len;
6537 btf->kernel_btf = true;
6538 btf->named_start_id = 0;
6539 strscpy(btf->name, module_name);
6540
6541 btf->data = kvmemdup(data, data_size, GFP_KERNEL | __GFP_NOWARN);
6542 if (!btf->data) {
6543 err = -ENOMEM;
6544 goto errout;
6545 }
6546 btf->data_size = data_size;
6547
6548 err = btf_parse_hdr(env);
6549 if (err)
6550 goto errout;
6551
6552 btf->nohdr_data = btf->data + btf->hdr.hdr_len;
6553
6554 err = btf_parse_str_sec(env);
6555 if (err)
6556 goto errout;
6557
6558 err = btf_check_all_metas(env);
6559 if (err)
6560 goto errout;
6561
6562 err = btf_check_modifier_chain_length(env, btf, btf_nr_types(base_btf));
6563 if (err)
6564 goto errout;
6565
6566 if (base_btf != vmlinux_btf) {
6567 err = btf_relocate(btf, vmlinux_btf, &btf->base_id_map);
6568 if (err)
6569 goto errout;
6570 btf_free(base_btf);
6571 base_btf = vmlinux_btf;
6572 }
6573
6574 btf_verifier_env_free(env);
6575 btf_check_sorted(btf);
6576 refcount_set(&btf->refcnt, 1);
6577 return btf;
6578
6579 errout:
6580 btf_verifier_env_free(env);
6581 if (!IS_ERR(base_btf) && base_btf != vmlinux_btf)
6582 btf_free(base_btf);
6583 if (btf) {
6584 kvfree(btf->data);
6585 kvfree(btf->types);
6586 kfree(btf);
6587 }
6588 return ERR_PTR(err);
6589 }
6590
6591 #endif /* CONFIG_DEBUG_INFO_BTF_MODULES */
6592
bpf_prog_get_target_btf(const struct bpf_prog * prog)6593 struct btf *bpf_prog_get_target_btf(const struct bpf_prog *prog)
6594 {
6595 struct bpf_prog *tgt_prog = prog->aux->dst_prog;
6596
6597 if (tgt_prog)
6598 return tgt_prog->aux->btf;
6599 else
6600 return prog->aux->attach_btf;
6601 }
6602
btf_ctx_arg_idx(struct btf * btf,const struct btf_type * func_proto,int off)6603 u32 btf_ctx_arg_idx(struct btf *btf, const struct btf_type *func_proto,
6604 int off)
6605 {
6606 const struct btf_param *args;
6607 const struct btf_type *t;
6608 u32 offset = 0, nr_args;
6609 int i;
6610
6611 if (!func_proto)
6612 return off / 8;
6613
6614 nr_args = btf_type_vlen(func_proto);
6615 args = (const struct btf_param *)(func_proto + 1);
6616 for (i = 0; i < nr_args; i++) {
6617 t = btf_type_skip_modifiers(btf, args[i].type, NULL);
6618 offset += btf_type_is_ptr(t) ? 8 : roundup(t->size, 8);
6619 if (off < offset)
6620 return i;
6621 }
6622
6623 t = btf_type_skip_modifiers(btf, func_proto->type, NULL);
6624 offset += btf_type_is_ptr(t) ? 8 : roundup(t->size, 8);
6625 if (off < offset)
6626 return nr_args;
6627
6628 return nr_args + 1;
6629 }
6630
prog_args_trusted(const struct bpf_prog * prog)6631 static bool prog_args_trusted(const struct bpf_prog *prog)
6632 {
6633 enum bpf_attach_type atype = prog->expected_attach_type;
6634
6635 switch (prog->type) {
6636 case BPF_PROG_TYPE_TRACING:
6637 return atype == BPF_TRACE_RAW_TP || atype == BPF_TRACE_ITER;
6638 case BPF_PROG_TYPE_LSM:
6639 return bpf_lsm_is_trusted(prog);
6640 case BPF_PROG_TYPE_STRUCT_OPS:
6641 return true;
6642 default:
6643 return false;
6644 }
6645 }
6646
btf_ctx_arg_offset(const struct btf * btf,const struct btf_type * func_proto,u32 arg_no)6647 int btf_ctx_arg_offset(const struct btf *btf, const struct btf_type *func_proto,
6648 u32 arg_no)
6649 {
6650 const struct btf_param *args;
6651 const struct btf_type *t;
6652 int off = 0, i;
6653 u32 sz;
6654
6655 args = btf_params(func_proto);
6656 for (i = 0; i < arg_no; i++) {
6657 t = btf_type_by_id(btf, args[i].type);
6658 t = btf_resolve_size(btf, t, &sz);
6659 if (IS_ERR(t))
6660 return PTR_ERR(t);
6661 off += roundup(sz, 8);
6662 }
6663
6664 return off;
6665 }
6666
6667 struct bpf_raw_tp_null_args {
6668 const char *func;
6669 u64 mask;
6670 };
6671
6672 static const struct bpf_raw_tp_null_args raw_tp_null_args[] = {
6673 /* sched */
6674 { "sched_pi_setprio", 0x10 },
6675 /*
6676 * do_wait() passes NULL for wait4(-1) and waitid(P_ALL).
6677 */
6678 { "sched_process_wait", 0x1 },
6679 /* ... from sched_numa_pair_template event class */
6680 { "sched_stick_numa", 0x100 },
6681 { "sched_swap_numa", 0x100 },
6682 /* afs */
6683 { "afs_make_fs_call", 0x10 },
6684 { "afs_make_fs_calli", 0x10 },
6685 { "afs_make_fs_call1", 0x10 },
6686 { "afs_make_fs_call2", 0x10 },
6687 { "afs_protocol_error", 0x1 },
6688 { "afs_flock_ev", 0x10 },
6689 /* cachefiles */
6690 { "cachefiles_lookup", 0x1 | 0x200 },
6691 { "cachefiles_unlink", 0x1 },
6692 { "cachefiles_rename", 0x1 },
6693 { "cachefiles_prep_read", 0x1 },
6694 { "cachefiles_mark_active", 0x1 },
6695 { "cachefiles_mark_failed", 0x1 },
6696 { "cachefiles_mark_inactive", 0x1 },
6697 { "cachefiles_vfs_error", 0x1 },
6698 { "cachefiles_io_error", 0x1 },
6699 /* ext4, from ext4__mballoc event class */
6700 { "ext4_mballoc_discard", 0x10 },
6701 { "ext4_mballoc_free", 0x10 },
6702 /* fib */
6703 { "fib_table_lookup", 0x100 },
6704 /* filelock */
6705 /* ... from filelock_lock event class */
6706 { "posix_lock_inode", 0x10 },
6707 { "fcntl_setlk", 0x10 },
6708 { "locks_remove_posix", 0x10 },
6709 { "flock_lock_inode", 0x10 },
6710 /* ... from filelock_lease event class */
6711 { "break_lease_noblock", 0x10 },
6712 { "break_lease_block", 0x10 },
6713 { "break_lease_unblock", 0x10 },
6714 { "generic_delete_lease", 0x10 },
6715 { "time_out_leases", 0x10 },
6716 /* host1x */
6717 { "host1x_cdma_push_gather", 0x10000 },
6718 /* huge_memory */
6719 { "mm_khugepaged_scan_pmd", 0x10 },
6720 { "mm_collapse_huge_page_isolate", 0x1 },
6721 { "mm_khugepaged_scan_file", 0x10 },
6722 { "mm_khugepaged_collapse_file", 0x10 },
6723 /* kmem */
6724 { "mm_page_alloc", 0x1 },
6725 { "mm_page_pcpu_drain", 0x1 },
6726 /* .. from mm_page event class */
6727 { "mm_page_alloc_zone_locked", 0x1 },
6728 /* netfs */
6729 { "netfs_failure", 0x10 },
6730 /* power */
6731 { "device_pm_callback_start", 0x10 },
6732 /* qdisc */
6733 { "qdisc_dequeue", 0x1000 },
6734 /* rxrpc */
6735 { "rxrpc_recvdata", 0x1 },
6736 { "rxrpc_resend", 0x10 },
6737 { "rxrpc_tq", 0x10 },
6738 { "rxrpc_client", 0x1 },
6739 /* signal */
6740 { "signal_generate", 0x20 },
6741 { "signal_deliver", 0x20 },
6742 /* skb */
6743 {"kfree_skb", 0x1000},
6744 /* sunrpc */
6745 { "xs_stream_read_data", 0x1 },
6746 /* ... from xprt_cong_event event class */
6747 { "xprt_reserve_cong", 0x10 },
6748 { "xprt_release_cong", 0x10 },
6749 { "xprt_get_cong", 0x10 },
6750 { "xprt_put_cong", 0x10 },
6751 /* tcp */
6752 { "tcp_send_reset", 0x11 },
6753 { "tcp_sendmsg_locked", 0x100 },
6754 /* tegra_apb_dma */
6755 { "tegra_dma_tx_status", 0x100 },
6756 /* timer_migration */
6757 { "tmigr_update_events", 0x1 },
6758 /* writeback, from writeback_folio_template event class */
6759 { "writeback_dirty_folio", 0x10 },
6760 { "folio_wait_writeback", 0x10 },
6761 /* rdma */
6762 { "mr_integ_alloc", 0x2000 },
6763 /* bpf_testmod */
6764 { "bpf_testmod_test_read", 0x0 },
6765 /* amdgpu */
6766 { "amdgpu_vm_bo_map", 0x1 },
6767 { "amdgpu_vm_bo_unmap", 0x1 },
6768 /* netfs */
6769 { "netfs_folioq", 0x1 },
6770 /* xfs from xfs_defer_pending_class */
6771 { "xfs_defer_create_intent", 0x1 },
6772 { "xfs_defer_cancel_list", 0x1 },
6773 { "xfs_defer_pending_finish", 0x1 },
6774 { "xfs_defer_pending_abort", 0x1 },
6775 { "xfs_defer_relog_intent", 0x1 },
6776 { "xfs_defer_isolate_paused", 0x1 },
6777 { "xfs_defer_item_pause", 0x1 },
6778 { "xfs_defer_item_unpause", 0x1 },
6779 /* xfs from xfs_defer_pending_item_class */
6780 { "xfs_defer_add_item", 0x1 },
6781 { "xfs_defer_cancel_item", 0x1 },
6782 { "xfs_defer_finish_item", 0x1 },
6783 /* xfs from xfs_icwalk_class */
6784 { "xfs_ioc_free_eofblocks", 0x10 },
6785 { "xfs_blockgc_free_space", 0x10 },
6786 /* xfs from xfs_btree_cur_class */
6787 { "xfs_btree_updkeys", 0x100 },
6788 { "xfs_btree_overlapped_query_range", 0x100 },
6789 /* xfs from xfs_imap_class*/
6790 { "xfs_map_blocks_found", 0x10000 },
6791 { "xfs_map_blocks_alloc", 0x10000 },
6792 { "xfs_iomap_alloc", 0x1000 },
6793 { "xfs_iomap_found", 0x1000 },
6794 /* xfs from xfs_fs_class */
6795 { "xfs_inodegc_flush", 0x1 },
6796 { "xfs_inodegc_push", 0x1 },
6797 { "xfs_inodegc_start", 0x1 },
6798 { "xfs_inodegc_stop", 0x1 },
6799 { "xfs_inodegc_queue", 0x1 },
6800 { "xfs_inodegc_throttle", 0x1 },
6801 { "xfs_fs_sync_fs", 0x1 },
6802 { "xfs_blockgc_start", 0x1 },
6803 { "xfs_blockgc_stop", 0x1 },
6804 { "xfs_blockgc_worker", 0x1 },
6805 { "xfs_blockgc_flush_all", 0x1 },
6806 /* xfs_scrub */
6807 { "xchk_nlinks_live_update", 0x10 },
6808 /* xfs_scrub from xchk_metapath_class */
6809 { "xchk_metapath_lookup", 0x100 },
6810 /* nfsd */
6811 { "nfsd_dirent", 0x1 },
6812 { "nfsd_file_acquire", 0x1001 },
6813 { "nfsd_file_insert_err", 0x1 },
6814 { "nfsd_file_cons_err", 0x1 },
6815 /* nfs4 */
6816 { "nfs4_setup_sequence", 0x1 },
6817 { "pnfs_update_layout", 0x10000 },
6818 { "nfs4_inode_callback_event", 0x200 },
6819 { "nfs4_inode_stateid_callback_event", 0x200 },
6820 /* nfs from pnfs_layout_event */
6821 { "pnfs_mds_fallback_pg_init_read", 0x10000 },
6822 { "pnfs_mds_fallback_pg_init_write", 0x10000 },
6823 { "pnfs_mds_fallback_pg_get_mirror_count", 0x10000 },
6824 { "pnfs_mds_fallback_read_done", 0x10000 },
6825 { "pnfs_mds_fallback_write_done", 0x10000 },
6826 { "pnfs_mds_fallback_read_pagelist", 0x10000 },
6827 { "pnfs_mds_fallback_write_pagelist", 0x10000 },
6828 /* coda */
6829 { "coda_dec_pic_run", 0x10 },
6830 { "coda_dec_pic_done", 0x10 },
6831 /* cfg80211 */
6832 { "cfg80211_scan_done", 0x11 },
6833 { "rdev_set_coalesce", 0x10 },
6834 { "cfg80211_report_wowlan_wakeup", 0x100 },
6835 { "cfg80211_inform_bss_frame", 0x100 },
6836 { "cfg80211_michael_mic_failure", 0x10000 },
6837 /* cfg80211 from wiphy_work_event */
6838 { "wiphy_work_queue", 0x10 },
6839 { "wiphy_work_run", 0x10 },
6840 { "wiphy_work_cancel", 0x10 },
6841 { "wiphy_work_flush", 0x10 },
6842 /* hugetlbfs */
6843 { "hugetlbfs_alloc_inode", 0x10 },
6844 /* spufs */
6845 { "spufs_context", 0x10 },
6846 /* kvm_hv */
6847 { "kvm_page_fault_enter", 0x100 },
6848 /* dpu */
6849 { "dpu_crtc_setup_mixer", 0x100 },
6850 /* binder */
6851 { "binder_transaction", 0x100 },
6852 /* bcachefs */
6853 { "btree_path_free", 0x100 },
6854 /* hfi1_tx */
6855 { "hfi1_sdma_progress", 0x1000 },
6856 /* iptfs */
6857 { "iptfs_ingress_postq_event", 0x1000 },
6858 /* neigh */
6859 { "neigh_update", 0x10 },
6860 /* snd_firewire_lib */
6861 { "amdtp_packet", 0x100 },
6862 };
6863
btf_ctx_access(int off,int size,enum bpf_access_type type,const struct bpf_prog * prog,struct bpf_insn_access_aux * info)6864 bool btf_ctx_access(int off, int size, enum bpf_access_type type,
6865 const struct bpf_prog *prog,
6866 struct bpf_insn_access_aux *info)
6867 {
6868 static const struct btf_type_tag_match ctx_type_tags[] = {
6869 { "user", MEM_USER },
6870 { "percpu", MEM_PERCPU },
6871 };
6872 const struct btf_type *t = prog->aux->attach_func_proto;
6873 struct bpf_prog *tgt_prog = prog->aux->dst_prog;
6874 struct btf *btf = bpf_prog_get_target_btf(prog);
6875 const char *tname = prog->aux->attach_func_name;
6876 struct bpf_verifier_log *log = info->log;
6877 struct btf_type_tag_walk_ctx ctx;
6878 const struct btf_param *args;
6879 bool ptr_err_raw_tp = false;
6880 u32 nr_args, arg;
6881 int i, ret;
6882
6883 if (off % 8) {
6884 bpf_log(log, "func '%s' offset %d is not multiple of 8\n",
6885 tname, off);
6886 return false;
6887 }
6888 arg = btf_ctx_arg_idx(btf, t, off);
6889 args = (const struct btf_param *)(t + 1);
6890 /* if (t == NULL) Fall back to default BPF prog with
6891 * MAX_BPF_FUNC_REG_ARGS u64 arguments.
6892 */
6893 nr_args = t ? btf_type_vlen(t) : MAX_BPF_FUNC_REG_ARGS;
6894 if (prog->aux->attach_btf_trace) {
6895 /* skip first 'void *__data' argument in btf_trace_##name typedef */
6896 args++;
6897 nr_args--;
6898 }
6899
6900 if (arg > nr_args) {
6901 bpf_log(log, "func '%s' doesn't have %d-th argument\n",
6902 tname, arg + 1);
6903 return false;
6904 }
6905
6906 if (arg == nr_args) {
6907 switch (prog->expected_attach_type) {
6908 case BPF_LSM_MAC:
6909 /* mark we are accessing the return value */
6910 info->is_retval = true;
6911 fallthrough;
6912 case BPF_LSM_CGROUP:
6913 case BPF_TRACE_FEXIT:
6914 case BPF_TRACE_FSESSION:
6915 /* When LSM programs are attached to void LSM hooks
6916 * they use FEXIT trampolines and when attached to
6917 * int LSM hooks, they use MODIFY_RETURN trampolines.
6918 *
6919 * While the LSM programs are BPF_MODIFY_RETURN-like
6920 * the check:
6921 *
6922 * if (ret_type != 'int')
6923 * return -EINVAL;
6924 *
6925 * is _not_ done here. This is still safe as LSM hooks
6926 * have only void and int return types.
6927 */
6928 if (!t)
6929 return true;
6930 t = btf_type_by_id(btf, t->type);
6931 break;
6932 case BPF_MODIFY_RETURN:
6933 /* For now the BPF_MODIFY_RETURN can only be attached to
6934 * functions that return an int.
6935 */
6936 if (!t)
6937 return false;
6938
6939 t = btf_type_skip_modifiers(btf, t->type, NULL);
6940 if (!btf_type_is_small_int(t)) {
6941 bpf_log(log,
6942 "ret type %s not allowed for fmod_ret\n",
6943 btf_type_str(t));
6944 return false;
6945 }
6946 break;
6947 default:
6948 bpf_log(log, "func '%s' doesn't have %d-th argument\n",
6949 tname, arg + 1);
6950 return false;
6951 }
6952 } else {
6953 if (!t)
6954 /* Default prog with MAX_BPF_FUNC_REG_ARGS args */
6955 return true;
6956 t = btf_type_by_id(btf, args[arg].type);
6957 }
6958
6959 /* skip modifiers */
6960 while (btf_type_is_modifier(t))
6961 t = btf_type_by_id(btf, t->type);
6962 if (btf_type_is_small_int(t) || btf_is_any_enum(t) || btf_type_is_struct(t))
6963 /* accessing a scalar */
6964 return true;
6965 if (!btf_type_is_ptr(t)) {
6966 bpf_log(log,
6967 "func '%s' arg%d '%s' has type %s. Only pointer access is allowed\n",
6968 tname, arg,
6969 __btf_name_by_offset(btf, t->name_off),
6970 btf_type_str(t));
6971 return false;
6972 }
6973
6974 if (size != sizeof(u64)) {
6975 bpf_log(log, "func '%s' size %d must be 8\n",
6976 tname, size);
6977 return false;
6978 }
6979
6980 /*
6981 * Check for PTR_TO_RDONLY_BUF_OR_NULL, PTR_TO_RDWR_BUF_OR_NULL or
6982 * PTR_TO_ARENA (both nullable and non-nullable cases).
6983 */
6984 for (i = 0; i < prog->aux->ctx_arg_info_size; i++) {
6985 const struct bpf_ctx_arg_aux *ctx_arg_info = &prog->aux->ctx_arg_info[i];
6986 u32 type, flag;
6987
6988 type = base_type(ctx_arg_info->reg_type);
6989 flag = type_flag(ctx_arg_info->reg_type);
6990 if (ctx_arg_info->offset == off &&
6991 (type == PTR_TO_ARENA ||
6992 (type == PTR_TO_BUF && (flag & PTR_MAYBE_NULL)))) {
6993 info->reg_type = ctx_arg_info->reg_type;
6994 return true;
6995 }
6996 }
6997
6998 /*
6999 * If it's a single or multilevel pointer, except a pointer
7000 * to a structure, it's the same as scalar from the verifier
7001 * safety POV. Multilevel pointers to structures are treated as
7002 * scalars. The verifier lacks the context to infer the size of
7003 * their target memory regions. Either way, no further pointer
7004 * walking is allowed.
7005 */
7006 if (!btf_type_is_struct_ptr(btf, t))
7007 return true;
7008
7009 /* this is a pointer to another type */
7010 for (i = 0; i < prog->aux->ctx_arg_info_size; i++) {
7011 const struct bpf_ctx_arg_aux *ctx_arg_info = &prog->aux->ctx_arg_info[i];
7012
7013 if (ctx_arg_info->offset == off) {
7014 if (!ctx_arg_info->btf_id) {
7015 bpf_log(log,"invalid btf_id for context argument offset %u\n", off);
7016 return false;
7017 }
7018
7019 info->reg_type = ctx_arg_info->reg_type;
7020 info->btf = ctx_arg_info->btf ? : btf_vmlinux;
7021 info->btf_id = ctx_arg_info->btf_id;
7022 info->ref_id = ctx_arg_info->ref_id;
7023 return true;
7024 }
7025 }
7026
7027 info->reg_type = PTR_TO_BTF_ID;
7028 if (prog_args_trusted(prog))
7029 info->reg_type |= PTR_TRUSTED;
7030
7031 if (btf_param_match_suffix(btf, &args[arg], "__nullable"))
7032 info->reg_type |= PTR_MAYBE_NULL;
7033
7034 if (prog->expected_attach_type == BPF_TRACE_RAW_TP) {
7035 struct btf *btf = prog->aux->attach_btf;
7036 const struct btf_type *t;
7037 const char *tname;
7038
7039 /* BTF lookups cannot fail, return false on error */
7040 t = btf_type_by_id(btf, prog->aux->attach_btf_id);
7041 if (!t)
7042 return false;
7043 tname = btf_name_by_offset(btf, t->name_off);
7044 if (!tname)
7045 return false;
7046 /* Checked by bpf_check_attach_target */
7047 tname += sizeof("btf_trace_") - 1;
7048 for (i = 0; i < ARRAY_SIZE(raw_tp_null_args); i++) {
7049 /* Is this a func with potential NULL args? */
7050 if (strcmp(tname, raw_tp_null_args[i].func))
7051 continue;
7052 if (raw_tp_null_args[i].mask & (0x1ULL << (arg * 4)))
7053 info->reg_type |= PTR_MAYBE_NULL;
7054 /* Is the current arg IS_ERR? */
7055 if (raw_tp_null_args[i].mask & (0x2ULL << (arg * 4)))
7056 ptr_err_raw_tp = true;
7057 break;
7058 }
7059 /* If we don't know NULL-ness specification and the tracepoint
7060 * is coming from a loadable module, be conservative and mark
7061 * argument as PTR_MAYBE_NULL.
7062 */
7063 if (i == ARRAY_SIZE(raw_tp_null_args) && btf_is_module(btf))
7064 info->reg_type |= PTR_MAYBE_NULL;
7065 }
7066
7067 if (tgt_prog) {
7068 enum bpf_prog_type tgt_type;
7069
7070 if (tgt_prog->type == BPF_PROG_TYPE_EXT)
7071 tgt_type = tgt_prog->aux->saved_dst_prog_type;
7072 else
7073 tgt_type = tgt_prog->type;
7074
7075 ret = btf_translate_to_vmlinux(log, btf, t, tgt_type, arg);
7076 if (ret > 0) {
7077 info->btf = btf_vmlinux;
7078 info->btf_id = ret;
7079 return true;
7080 } else {
7081 return false;
7082 }
7083 }
7084
7085 info->btf = btf;
7086 ctx.t = t;
7087 ret = btf_type_tag_walk(btf, &ctx, ctx_type_tags,
7088 ARRAY_SIZE(ctx_type_tags));
7089 if (ret) {
7090 bpf_log(log, "func '%s' arg%d type %s has multiple type tags\n",
7091 tname, arg, btf_type_str(t));
7092 return false;
7093 }
7094 info->reg_type |= ctx.res;
7095 info->btf_id = ctx.id;
7096 t = ctx.t;
7097
7098 if (!btf_type_is_struct(t)) {
7099 bpf_log(log,
7100 "func '%s' arg%d type %s is not a struct\n",
7101 tname, arg, btf_type_str(t));
7102 return false;
7103 }
7104 bpf_log(log, "func '%s' arg%d has btf_id %d type %s '%s'\n",
7105 tname, arg, info->btf_id, btf_type_str(t),
7106 __btf_name_by_offset(btf, t->name_off));
7107
7108 /* Perform all checks on the validity of type for this argument, but if
7109 * we know it can be IS_ERR at runtime, scrub pointer type and mark as
7110 * scalar.
7111 */
7112 if (ptr_err_raw_tp) {
7113 bpf_log(log, "marking pointer arg%d as scalar as it may encode error", arg);
7114 info->reg_type = SCALAR_VALUE;
7115 }
7116 return true;
7117 }
7118 EXPORT_SYMBOL_GPL(btf_ctx_access);
7119
7120 enum bpf_struct_walk_result {
7121 /* < 0 error */
7122 WALK_SCALAR = 0,
7123 WALK_PTR,
7124 WALK_PTR_UNTRUSTED,
7125 WALK_STRUCT,
7126 };
7127
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)7128 static int btf_struct_walk(struct bpf_verifier_log *log, const struct btf *btf,
7129 const struct btf_type *t, int off, int size,
7130 u32 *next_btf_id, enum bpf_type_flag *flag,
7131 const char **field_name, bool walk_flex_arrays)
7132 {
7133 u32 i, moff, mtrue_end, msize = 0, total_nelems = 0;
7134 const struct btf_type *mtype, *elem_type = NULL;
7135 const struct btf_member *member;
7136 const char *tname, *mname;
7137 u32 vlen, elem_id, mid;
7138
7139 again:
7140 if (btf_type_is_modifier(t))
7141 t = btf_type_skip_modifiers(btf, t->type, NULL);
7142 tname = __btf_name_by_offset(btf, t->name_off);
7143 if (!btf_type_is_struct(t)) {
7144 bpf_log(log, "Type '%s' is not a struct\n", tname);
7145 return -EINVAL;
7146 }
7147
7148 vlen = btf_type_vlen(t);
7149 if (BTF_INFO_KIND(t->info) == BTF_KIND_UNION && vlen != 1 && !(*flag & PTR_UNTRUSTED))
7150 /*
7151 * walking unions yields untrusted pointers
7152 * with exception of __bpf_md_ptr and other
7153 * unions with a single member
7154 */
7155 *flag |= PTR_UNTRUSTED;
7156
7157 if (off + size > t->size) {
7158 struct btf_array *array_elem;
7159
7160 if (!walk_flex_arrays)
7161 goto error;
7162
7163 /* If the last element is a variable size array, we may
7164 * need to relax the rule.
7165 */
7166 if (vlen == 0)
7167 goto error;
7168
7169 member = btf_type_member(t) + vlen - 1;
7170 mtype = btf_type_skip_modifiers(btf, member->type,
7171 NULL);
7172 if (!btf_type_is_array(mtype))
7173 goto error;
7174
7175 array_elem = (struct btf_array *)(mtype + 1);
7176 if (array_elem->nelems != 0)
7177 goto error;
7178
7179 moff = __btf_member_bit_offset(t, member) / 8;
7180 if (off < moff)
7181 goto error;
7182
7183 /* allow structure and integer */
7184 t = btf_type_skip_modifiers(btf, array_elem->type,
7185 NULL);
7186
7187 if (btf_type_is_int(t))
7188 return WALK_SCALAR;
7189
7190 if (!btf_type_is_struct(t))
7191 goto error;
7192
7193 off = (off - moff) % t->size;
7194 goto again;
7195
7196 error:
7197 bpf_log(log, "access beyond struct %s at off %u size %u\n",
7198 tname, off, size);
7199 return -EACCES;
7200 }
7201
7202 for_each_member(i, t, member) {
7203 /* offset of the field in bytes */
7204 moff = __btf_member_bit_offset(t, member) / 8;
7205 if (off + size <= moff)
7206 /* won't find anything, field is already too far */
7207 break;
7208
7209 if (__btf_member_bitfield_size(t, member)) {
7210 u32 end_bit = __btf_member_bit_offset(t, member) +
7211 __btf_member_bitfield_size(t, member);
7212
7213 /* off <= moff instead of off == moff because clang
7214 * does not generate a BTF member for anonymous
7215 * bitfield like the ":16" here:
7216 * struct {
7217 * int :16;
7218 * int x:8;
7219 * };
7220 */
7221 if (off <= moff &&
7222 BITS_ROUNDUP_BYTES(end_bit) <= off + size)
7223 return WALK_SCALAR;
7224
7225 /* off may be accessing a following member
7226 *
7227 * or
7228 *
7229 * Doing partial access at either end of this
7230 * bitfield. Continue on this case also to
7231 * treat it as not accessing this bitfield
7232 * and eventually error out as field not
7233 * found to keep it simple.
7234 * It could be relaxed if there was a legit
7235 * partial access case later.
7236 */
7237 continue;
7238 }
7239
7240 /* In case of "off" is pointing to holes of a struct */
7241 if (off < moff)
7242 break;
7243
7244 /* type of the field */
7245 mid = member->type;
7246 mtype = btf_type_by_id(btf, member->type);
7247 mname = __btf_name_by_offset(btf, member->name_off);
7248
7249 mtype = __btf_resolve_size(btf, mtype, &msize,
7250 &elem_type, &elem_id, &total_nelems,
7251 &mid);
7252 if (IS_ERR(mtype)) {
7253 bpf_log(log, "field %s doesn't have size\n", mname);
7254 return -EFAULT;
7255 }
7256
7257 mtrue_end = moff + msize;
7258 if (off >= mtrue_end)
7259 /* no overlap with member, keep iterating */
7260 continue;
7261
7262 if (btf_type_is_array(mtype)) {
7263 u32 elem_idx;
7264
7265 /* __btf_resolve_size() above helps to
7266 * linearize a multi-dimensional array.
7267 *
7268 * The logic here is treating an array
7269 * in a struct as the following way:
7270 *
7271 * struct outer {
7272 * struct inner array[2][2];
7273 * };
7274 *
7275 * looks like:
7276 *
7277 * struct outer {
7278 * struct inner array_elem0;
7279 * struct inner array_elem1;
7280 * struct inner array_elem2;
7281 * struct inner array_elem3;
7282 * };
7283 *
7284 * When accessing outer->array[1][0], it moves
7285 * moff to "array_elem2", set mtype to
7286 * "struct inner", and msize also becomes
7287 * sizeof(struct inner). Then most of the
7288 * remaining logic will fall through without
7289 * caring the current member is an array or
7290 * not.
7291 *
7292 * Unlike mtype/msize/moff, mtrue_end does not
7293 * change. The naming difference ("_true") tells
7294 * that it is not always corresponding to
7295 * the current mtype/msize/moff.
7296 * It is the true end of the current
7297 * member (i.e. array in this case). That
7298 * will allow an int array to be accessed like
7299 * a scratch space,
7300 * i.e. allow access beyond the size of
7301 * the array's element as long as it is
7302 * within the mtrue_end boundary.
7303 */
7304
7305 /* skip empty array */
7306 if (moff == mtrue_end)
7307 continue;
7308
7309 msize /= total_nelems;
7310 elem_idx = (off - moff) / msize;
7311 moff += elem_idx * msize;
7312 mtype = elem_type;
7313 mid = elem_id;
7314 }
7315
7316 /* the 'off' we're looking for is either equal to start
7317 * of this field or inside of this struct
7318 */
7319 if (btf_type_is_struct(mtype)) {
7320 /* our field must be inside that union or struct */
7321 t = mtype;
7322
7323 /* return if the offset matches the member offset */
7324 if (off == moff) {
7325 *next_btf_id = mid;
7326 return WALK_STRUCT;
7327 }
7328
7329 /* adjust offset we're looking for */
7330 off -= moff;
7331 goto again;
7332 }
7333
7334 if (btf_type_is_ptr(mtype)) {
7335 static const struct btf_type_tag_match walk_type_tags[] = {
7336 { "user", MEM_USER },
7337 { "percpu", MEM_PERCPU },
7338 { "rcu", MEM_RCU },
7339 };
7340 enum bpf_type_flag tmp_flag = 0;
7341 struct btf_type_tag_walk_ctx ctx = { .t = mtype };
7342 const struct btf_type *stype;
7343 int err;
7344 u32 id;
7345
7346 if (msize != size || off != moff) {
7347 bpf_log(log,
7348 "cannot access ptr member %s with moff %u in struct %s with off %u size %u\n",
7349 mname, moff, tname, off, size);
7350 return -EACCES;
7351 }
7352
7353 err = btf_type_tag_walk(btf, &ctx, walk_type_tags,
7354 ARRAY_SIZE(walk_type_tags));
7355 if (err) {
7356 bpf_log(log, "type '%s' has multiple type tags\n",
7357 btf_type_str(mtype));
7358 return err;
7359 }
7360 tmp_flag = ctx.res;
7361 id = ctx.id;
7362 stype = ctx.t;
7363
7364 if (btf_type_is_struct(stype)) {
7365 *next_btf_id = id;
7366 *flag |= tmp_flag;
7367 if (field_name)
7368 *field_name = mname;
7369 return WALK_PTR;
7370 }
7371
7372 return WALK_PTR_UNTRUSTED;
7373 }
7374
7375 /* Allow more flexible access within an int as long as
7376 * it is within mtrue_end.
7377 * Since mtrue_end could be the end of an array,
7378 * that also allows using an array of int as a scratch
7379 * space. e.g. skb->cb[].
7380 */
7381 if (off + size > mtrue_end && !(*flag & PTR_UNTRUSTED)) {
7382 bpf_log(log,
7383 "access beyond the end of member %s (mend:%u) in struct %s with off %u size %u\n",
7384 mname, mtrue_end, tname, off, size);
7385 return -EACCES;
7386 }
7387
7388 return WALK_SCALAR;
7389 }
7390 bpf_log(log, "struct %s doesn't have field at offset %d\n", tname, off);
7391 return -EINVAL;
7392 }
7393
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)7394 int btf_struct_access(struct bpf_verifier_log *log,
7395 const struct bpf_reg_state *reg,
7396 int off, int size, enum bpf_access_type atype __maybe_unused,
7397 u32 *next_btf_id, enum bpf_type_flag *flag,
7398 const char **field_name)
7399 {
7400 const struct btf *btf = reg->btf;
7401 enum bpf_type_flag tmp_flag = 0;
7402 const struct btf_type *t;
7403 u32 id = reg->btf_id;
7404 int err;
7405
7406 while (type_is_alloc(reg->type)) {
7407 struct btf_struct_meta *meta;
7408 struct btf_record *rec;
7409 int i;
7410
7411 meta = btf_find_struct_meta(btf, id);
7412 if (!meta)
7413 break;
7414 rec = meta->record;
7415 for (i = 0; i < rec->cnt; i++) {
7416 struct btf_field *field = &rec->fields[i];
7417 u32 offset = field->offset;
7418 if (off < offset + field->size && offset < off + size) {
7419 bpf_log(log,
7420 "direct access to %s is disallowed\n",
7421 btf_field_type_name(field->type));
7422 return -EACCES;
7423 }
7424 }
7425 break;
7426 }
7427
7428 t = btf_type_by_id(btf, id);
7429 do {
7430 err = btf_struct_walk(log, btf, t, off, size, &id, &tmp_flag,
7431 field_name, !type_is_alloc(reg->type));
7432
7433 switch (err) {
7434 case WALK_PTR:
7435 /* For local types, the destination register cannot
7436 * become a pointer again.
7437 */
7438 if (type_is_alloc(reg->type))
7439 return SCALAR_VALUE;
7440 /* If we found the pointer or scalar on t+off,
7441 * we're done.
7442 */
7443 *next_btf_id = id;
7444 *flag = tmp_flag;
7445 return PTR_TO_BTF_ID;
7446 case WALK_PTR_UNTRUSTED:
7447 *flag = MEM_RDONLY | PTR_UNTRUSTED;
7448 return PTR_TO_MEM;
7449 case WALK_SCALAR:
7450 return SCALAR_VALUE;
7451 case WALK_STRUCT:
7452 /* We found nested struct, so continue the search
7453 * by diving in it. At this point the offset is
7454 * aligned with the new type, so set it to 0.
7455 */
7456 t = btf_type_by_id(btf, id);
7457 off = 0;
7458 break;
7459 default:
7460 /* It's either error or unknown return value..
7461 * scream and leave.
7462 */
7463 if (WARN_ONCE(err > 0, "unknown btf_struct_walk return value"))
7464 return -EINVAL;
7465 return err;
7466 }
7467 } while (t);
7468
7469 return -EINVAL;
7470 }
7471
7472 /* Check that two BTF types, each specified as an BTF object + id, are exactly
7473 * the same. Trivial ID check is not enough due to module BTFs, because we can
7474 * end up with two different module BTFs, but IDs point to the common type in
7475 * vmlinux BTF.
7476 */
btf_types_are_same(const struct btf * btf1,u32 id1,const struct btf * btf2,u32 id2)7477 bool btf_types_are_same(const struct btf *btf1, u32 id1,
7478 const struct btf *btf2, u32 id2)
7479 {
7480 if (id1 != id2)
7481 return false;
7482 if (btf1 == btf2)
7483 return true;
7484 return btf_type_by_id(btf1, id1) == btf_type_by_id(btf2, id2);
7485 }
7486
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)7487 bool btf_struct_ids_match(struct bpf_verifier_log *log,
7488 const struct btf *btf, u32 id, int off,
7489 const struct btf *need_btf, u32 need_type_id,
7490 bool strict, bool walk_flex_arrays)
7491 {
7492 const struct btf_type *type;
7493 enum bpf_type_flag flag = 0;
7494 int err;
7495
7496 /* Are we already done? */
7497 if (off == 0 && btf_types_are_same(btf, id, need_btf, need_type_id))
7498 return true;
7499 /* In case of strict type match, we do not walk struct, the top level
7500 * type match must succeed. When strict is true, off should have already
7501 * been 0.
7502 */
7503 if (strict)
7504 return false;
7505 again:
7506 type = btf_type_by_id(btf, id);
7507 if (!type)
7508 return false;
7509 err = btf_struct_walk(log, btf, type, off, 1, &id, &flag, NULL,
7510 walk_flex_arrays);
7511 if (err != WALK_STRUCT)
7512 return false;
7513
7514 /* We found nested struct object. If it matches
7515 * the requested ID, we're done. Otherwise let's
7516 * continue the search with offset 0 in the new
7517 * type.
7518 */
7519 if (!btf_types_are_same(btf, id, need_btf, need_type_id)) {
7520 off = 0;
7521 goto again;
7522 }
7523
7524 return true;
7525 }
7526
__get_type_size(struct btf * btf,u32 btf_id,const struct btf_type ** ret_type)7527 static int __get_type_size(struct btf *btf, u32 btf_id,
7528 const struct btf_type **ret_type)
7529 {
7530 const struct btf_type *t;
7531
7532 *ret_type = btf_type_by_id(btf, 0);
7533 if (!btf_id)
7534 /* void */
7535 return 0;
7536 t = btf_type_by_id(btf, btf_id);
7537 while (t && btf_type_is_modifier(t))
7538 t = btf_type_by_id(btf, t->type);
7539 if (!t)
7540 return -EINVAL;
7541 *ret_type = t;
7542 if (btf_type_is_ptr(t))
7543 /* kernel size of pointer. Not BPF's size of pointer*/
7544 return sizeof(void *);
7545 if (btf_type_is_int(t) || btf_is_any_enum(t) || btf_type_is_struct(t))
7546 return t->size;
7547 return -EINVAL;
7548 }
7549
__get_type_fmodel_flags(const struct btf_type * t)7550 static u8 __get_type_fmodel_flags(const struct btf_type *t)
7551 {
7552 u8 flags = 0;
7553
7554 if (btf_type_is_signed_int(t))
7555 flags |= BTF_FMODEL_SIGNED_ARG;
7556
7557 return flags;
7558 }
7559
__get_arg_fmodel_flags(const struct btf * btf,const struct btf_param * arg,const struct btf_type * t)7560 static u8 __get_arg_fmodel_flags(const struct btf *btf,
7561 const struct btf_param *arg,
7562 const struct btf_type *t)
7563 {
7564 u8 flags = __get_type_fmodel_flags(t);
7565
7566 if (btf_param_match_suffix(btf, arg, "__arena__nullable"))
7567 flags |= BTF_FMODEL_ARENA_ARG | BTF_FMODEL_NULLABLE_ARG;
7568 else if (btf_param_match_suffix(btf, arg, "__arena"))
7569 flags |= BTF_FMODEL_ARENA_ARG;
7570 else if (btf_param_match_suffix(btf, arg, "__nullable"))
7571 flags |= BTF_FMODEL_NULLABLE_ARG;
7572
7573 return flags;
7574 }
7575
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)7576 int btf_distill_func_proto(struct bpf_verifier_log *log,
7577 struct btf *btf,
7578 const struct btf_type *func,
7579 const char *tname,
7580 struct btf_func_model *m)
7581 {
7582 const struct btf_param *args;
7583 const struct btf_type *t;
7584 u32 i, nargs;
7585 int ret;
7586
7587 if (!func) {
7588 /* BTF function prototype doesn't match the verifier types.
7589 * Fall back to MAX_BPF_FUNC_REG_ARGS u64 args.
7590 */
7591 for (i = 0; i < MAX_BPF_FUNC_REG_ARGS; i++) {
7592 m->arg_size[i] = 8;
7593 m->arg_flags[i] = 0;
7594 }
7595 m->ret_size = 8;
7596 m->ret_flags = 0;
7597 m->nr_args = MAX_BPF_FUNC_REG_ARGS;
7598 return 0;
7599 }
7600 args = (const struct btf_param *)(func + 1);
7601 nargs = btf_type_vlen(func);
7602 if (nargs > MAX_BPF_FUNC_ARGS) {
7603 bpf_log(log,
7604 "The function %s has %d arguments. Too many.\n",
7605 tname, nargs);
7606 return -EINVAL;
7607 }
7608 ret = __get_type_size(btf, func->type, &t);
7609 if (ret < 0 || btf_type_is_struct(t)) {
7610 bpf_log(log,
7611 "The function %s return type %s is unsupported.\n",
7612 tname, btf_type_str(t));
7613 return -EINVAL;
7614 }
7615 m->ret_size = ret;
7616 m->ret_flags = __get_type_fmodel_flags(t);
7617
7618 for (i = 0; i < nargs; i++) {
7619 if (i == nargs - 1 && args[i].type == 0) {
7620 bpf_log(log,
7621 "The function %s with variable args is unsupported.\n",
7622 tname);
7623 return -EINVAL;
7624 }
7625 ret = __get_type_size(btf, args[i].type, &t);
7626
7627 /* No support of struct argument size greater than 16 bytes */
7628 if (ret < 0 || ret > 16) {
7629 bpf_log(log,
7630 "The function %s arg%d type %s is unsupported.\n",
7631 tname, i, btf_type_str(t));
7632 return -EINVAL;
7633 }
7634 if (ret == 0) {
7635 bpf_log(log,
7636 "The function %s has malformed void argument.\n",
7637 tname);
7638 return -EINVAL;
7639 }
7640 m->arg_size[i] = ret;
7641 m->arg_flags[i] = __get_arg_fmodel_flags(btf, &args[i], t);
7642 }
7643 m->nr_args = nargs;
7644 return 0;
7645 }
7646
7647 /* Compare BTFs of two functions assuming only scalars and pointers to context.
7648 * t1 points to BTF_KIND_FUNC in btf1
7649 * t2 points to BTF_KIND_FUNC in btf2
7650 * Returns:
7651 * EINVAL - function prototype mismatch
7652 * EFAULT - verifier bug
7653 * 0 - 99% match. The last 1% is validated by the verifier.
7654 */
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)7655 static int btf_check_func_type_match(struct bpf_verifier_log *log,
7656 struct btf *btf1, const struct btf_type *t1,
7657 struct btf *btf2, const struct btf_type *t2)
7658 {
7659 const struct btf_param *args1, *args2;
7660 const char *fn1, *fn2, *s1, *s2;
7661 u32 nargs1, nargs2, i;
7662
7663 fn1 = btf_name_by_offset(btf1, t1->name_off);
7664 fn2 = btf_name_by_offset(btf2, t2->name_off);
7665
7666 if (btf_func_linkage(t1) != BTF_FUNC_GLOBAL) {
7667 bpf_log(log, "%s() is not a global function\n", fn1);
7668 return -EINVAL;
7669 }
7670 if (btf_func_linkage(t2) != BTF_FUNC_GLOBAL) {
7671 bpf_log(log, "%s() is not a global function\n", fn2);
7672 return -EINVAL;
7673 }
7674
7675 t1 = btf_type_by_id(btf1, t1->type);
7676 if (!t1 || !btf_type_is_func_proto(t1))
7677 return -EFAULT;
7678 t2 = btf_type_by_id(btf2, t2->type);
7679 if (!t2 || !btf_type_is_func_proto(t2))
7680 return -EFAULT;
7681
7682 args1 = (const struct btf_param *)(t1 + 1);
7683 nargs1 = btf_type_vlen(t1);
7684 args2 = (const struct btf_param *)(t2 + 1);
7685 nargs2 = btf_type_vlen(t2);
7686
7687 if (nargs1 != nargs2) {
7688 bpf_log(log, "%s() has %d args while %s() has %d args\n",
7689 fn1, nargs1, fn2, nargs2);
7690 return -EINVAL;
7691 }
7692
7693 t1 = btf_type_skip_modifiers(btf1, t1->type, NULL);
7694 t2 = btf_type_skip_modifiers(btf2, t2->type, NULL);
7695 if (t1->info != t2->info) {
7696 bpf_log(log,
7697 "Return type %s of %s() doesn't match type %s of %s()\n",
7698 btf_type_str(t1), fn1,
7699 btf_type_str(t2), fn2);
7700 return -EINVAL;
7701 }
7702
7703 for (i = 0; i < nargs1; i++) {
7704 t1 = btf_type_skip_modifiers(btf1, args1[i].type, NULL);
7705 t2 = btf_type_skip_modifiers(btf2, args2[i].type, NULL);
7706
7707 if (t1->info != t2->info) {
7708 bpf_log(log, "arg%d in %s() is %s while %s() has %s\n",
7709 i, fn1, btf_type_str(t1),
7710 fn2, btf_type_str(t2));
7711 return -EINVAL;
7712 }
7713 if (btf_type_has_size(t1) && t1->size != t2->size) {
7714 bpf_log(log,
7715 "arg%d in %s() has size %d while %s() has %d\n",
7716 i, fn1, t1->size,
7717 fn2, t2->size);
7718 return -EINVAL;
7719 }
7720
7721 /* global functions are validated with scalars and pointers
7722 * to context only. And only global functions can be replaced.
7723 * Hence type check only those types.
7724 */
7725 if (btf_type_is_int(t1) || btf_is_any_enum(t1))
7726 continue;
7727 if (!btf_type_is_ptr(t1)) {
7728 bpf_log(log,
7729 "arg%d in %s() has unrecognized type\n",
7730 i, fn1);
7731 return -EINVAL;
7732 }
7733 t1 = btf_type_skip_modifiers(btf1, t1->type, NULL);
7734 t2 = btf_type_skip_modifiers(btf2, t2->type, NULL);
7735 if (!btf_type_is_struct(t1)) {
7736 bpf_log(log,
7737 "arg%d in %s() is not a pointer to context\n",
7738 i, fn1);
7739 return -EINVAL;
7740 }
7741 if (!btf_type_is_struct(t2)) {
7742 bpf_log(log,
7743 "arg%d in %s() is not a pointer to context\n",
7744 i, fn2);
7745 return -EINVAL;
7746 }
7747 /* This is an optional check to make program writing easier.
7748 * Compare names of structs and report an error to the user.
7749 * btf_prepare_func_args() already checked that t2 struct
7750 * is a context type. btf_prepare_func_args() will check
7751 * later that t1 struct is a context type as well.
7752 */
7753 s1 = btf_name_by_offset(btf1, t1->name_off);
7754 s2 = btf_name_by_offset(btf2, t2->name_off);
7755 if (strcmp(s1, s2)) {
7756 bpf_log(log,
7757 "arg%d %s(struct %s *) doesn't match %s(struct %s *)\n",
7758 i, fn1, s1, fn2, s2);
7759 return -EINVAL;
7760 }
7761 }
7762 return 0;
7763 }
7764
7765 /* 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)7766 int btf_check_type_match(struct bpf_verifier_log *log, const struct bpf_prog *prog,
7767 struct btf *btf2, const struct btf_type *t2)
7768 {
7769 struct btf *btf1 = prog->aux->btf;
7770 const struct btf_type *t1;
7771 u32 btf_id = 0;
7772
7773 if (!prog->aux->func_info) {
7774 bpf_log(log, "Program extension requires BTF\n");
7775 return -EINVAL;
7776 }
7777
7778 btf_id = prog->aux->func_info[0].type_id;
7779 if (!btf_id)
7780 return -EFAULT;
7781
7782 t1 = btf_type_by_id(btf1, btf_id);
7783 if (!t1 || !btf_type_is_func(t1))
7784 return -EFAULT;
7785
7786 return btf_check_func_type_match(log, btf1, t1, btf2, t2);
7787 }
7788
btf_is_dynptr_ptr(const struct btf * btf,const struct btf_type * t)7789 static bool btf_is_dynptr_ptr(const struct btf *btf, const struct btf_type *t)
7790 {
7791 const char *name;
7792
7793 t = btf_type_by_id(btf, t->type); /* skip PTR */
7794
7795 while (btf_type_is_modifier(t))
7796 t = btf_type_by_id(btf, t->type);
7797
7798 /* allow either struct or struct forward declaration */
7799 if (btf_type_is_struct(t) ||
7800 (btf_type_is_fwd(t) && btf_type_kflag(t) == 0)) {
7801 name = btf_str_by_offset(btf, t->name_off);
7802 return name && strcmp(name, "bpf_dynptr") == 0;
7803 }
7804
7805 return false;
7806 }
7807
7808 struct bpf_cand_cache {
7809 const char *name;
7810 u32 name_len;
7811 u16 kind;
7812 u16 cnt;
7813 struct {
7814 const struct btf *btf;
7815 u32 id;
7816 } cands[];
7817 };
7818
7819 static DEFINE_MUTEX(cand_cache_mutex);
7820
7821 static struct bpf_cand_cache *
7822 bpf_core_find_cands(struct bpf_core_ctx *ctx, u32 local_type_id);
7823
btf_get_ptr_to_btf_id(struct bpf_verifier_log * log,int arg_idx,const struct btf * btf,const struct btf_type * t)7824 static int btf_get_ptr_to_btf_id(struct bpf_verifier_log *log, int arg_idx,
7825 const struct btf *btf, const struct btf_type *t)
7826 {
7827 struct bpf_cand_cache *cc;
7828 struct bpf_core_ctx ctx = {
7829 .btf = btf,
7830 .log = log,
7831 };
7832 u32 kern_type_id, type_id;
7833 int err = 0;
7834
7835 /* skip PTR and modifiers */
7836 type_id = t->type;
7837 t = btf_type_by_id(btf, t->type);
7838 while (btf_type_is_modifier(t)) {
7839 type_id = t->type;
7840 t = btf_type_by_id(btf, t->type);
7841 }
7842
7843 mutex_lock(&cand_cache_mutex);
7844 cc = bpf_core_find_cands(&ctx, type_id);
7845 if (IS_ERR(cc)) {
7846 err = PTR_ERR(cc);
7847 bpf_log(log, "arg#%d reference type('%s %s') candidate matching error: %d\n",
7848 arg_idx, btf_type_str(t), __btf_name_by_offset(btf, t->name_off),
7849 err);
7850 goto cand_cache_unlock;
7851 }
7852 if (cc->cnt != 1) {
7853 bpf_log(log, "arg#%d reference type('%s %s') %s\n",
7854 arg_idx, btf_type_str(t), __btf_name_by_offset(btf, t->name_off),
7855 cc->cnt == 0 ? "has no matches" : "is ambiguous");
7856 err = cc->cnt == 0 ? -ENOENT : -ESRCH;
7857 goto cand_cache_unlock;
7858 }
7859 if (btf_is_module(cc->cands[0].btf)) {
7860 bpf_log(log, "arg#%d reference type('%s %s') points to kernel module type (unsupported)\n",
7861 arg_idx, btf_type_str(t), __btf_name_by_offset(btf, t->name_off));
7862 err = -EOPNOTSUPP;
7863 goto cand_cache_unlock;
7864 }
7865 kern_type_id = cc->cands[0].id;
7866
7867 cand_cache_unlock:
7868 mutex_unlock(&cand_cache_mutex);
7869 if (err)
7870 return err;
7871
7872 return kern_type_id;
7873 }
7874
7875 enum btf_arg_tag {
7876 ARG_TAG_CTX = BIT_ULL(0),
7877 ARG_TAG_NONNULL = BIT_ULL(1),
7878 ARG_TAG_TRUSTED = BIT_ULL(2),
7879 ARG_TAG_UNTRUSTED = BIT_ULL(3),
7880 ARG_TAG_NULLABLE = BIT_ULL(4),
7881 ARG_TAG_ARENA = BIT_ULL(5),
7882 };
7883
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)7884 static int btf_scan_decl_tags(struct bpf_verifier_env *env,
7885 const struct btf *btf,
7886 const struct btf_type *fn_t,
7887 u32 arg_idx, bool is_global, u32 *tags)
7888 {
7889 int id = btf_named_start_id(btf, false) - 1;
7890 const char tag_key[] = "arg:";
7891 static const struct {
7892 const char *tag_value;
7893 enum btf_arg_tag arg_tag;
7894 } tag_values[] = {
7895 { "ctx", ARG_TAG_CTX },
7896 { "trusted", ARG_TAG_TRUSTED },
7897 { "untrusted", ARG_TAG_UNTRUSTED },
7898 { "nonnull", ARG_TAG_NONNULL },
7899 { "nullable", ARG_TAG_NULLABLE },
7900 { "arena", ARG_TAG_ARENA },
7901 };
7902
7903 /*
7904 * The 'arg:<tag>' decl_tag takes precedence over the derivation
7905 * of the register type from the BTF type itself.
7906 */
7907 while ((id = btf_find_next_decl_tag(btf, fn_t, arg_idx, tag_key, id)) > 0) {
7908 const struct btf_type *tag_t;
7909 const char *tag;
7910 int i;
7911 bool found;
7912
7913 /* disallow arg tags in static subprogs */
7914 if (!is_global) {
7915 bpf_log(&env->log,
7916 "arg#%d type tag is not supported in static functions\n",
7917 arg_idx);
7918 return -EOPNOTSUPP;
7919 }
7920
7921 tag_t = btf_type_by_id(btf, id);
7922 tag = __btf_name_by_offset(btf, tag_t->name_off) + (sizeof(tag_key) - 1);
7923
7924 found = false;
7925 for (i = 0; i < ARRAY_SIZE(tag_values); ++i) {
7926 if (!strcmp(tag, tag_values[i].tag_value)) {
7927 *tags |= tag_values[i].arg_tag;
7928 found = true;
7929 break;
7930 }
7931 }
7932
7933 if (!found) {
7934 bpf_log(&env->log, "arg#%d has unsupported set of tags\n", arg_idx);
7935 return -EOPNOTSUPP;
7936 }
7937 }
7938 if (id != -ENOENT) {
7939 bpf_log(&env->log, "arg#%d type tag fetching failure: %d\n", arg_idx, id);
7940 return id;
7941 }
7942
7943 return 0;
7944 }
7945
btf_scan_type_tags(struct bpf_verifier_env * env,const struct btf * btf,u32 type_id,u32 * tags)7946 static int btf_scan_type_tags(struct bpf_verifier_env *env,
7947 const struct btf *btf, u32 type_id,
7948 u32 *tags)
7949 {
7950 static const struct btf_type_tag_match func_type_tags[] = {
7951 { "arena", ARG_TAG_ARENA },
7952 };
7953 struct btf_type_tag_walk_ctx ctx;
7954 const struct btf_type *t;
7955 int err;
7956
7957 /* Find the first pointer type in the chain. */
7958 t = btf_type_skip_modifiers(btf, type_id, NULL);
7959
7960 /*
7961 * We currently reject type tags on non-pointer types,
7962 * which neither LLVM nor GCC support anyway.
7963 */
7964 if (!t || !btf_type_is_ptr(t))
7965 return 0;
7966
7967 ctx.t = t;
7968 err = btf_type_tag_walk(btf, &ctx, func_type_tags,
7969 ARRAY_SIZE(func_type_tags));
7970 if (err) {
7971 bpf_log(&env->log,
7972 "function signature member has multiple type tags\n");
7973 return err;
7974 }
7975 *tags |= ctx.res;
7976
7977 return 0;
7978 }
7979
7980 /* 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)7981 static int btf_validate_return_type(struct bpf_verifier_env *env, struct btf *btf,
7982 const struct btf_type *t, int subprog)
7983 {
7984 u32 tags = 0;
7985 int err;
7986
7987 err = btf_scan_type_tags(env, btf, t->type, &tags);
7988 if (err)
7989 return err;
7990
7991 t = btf_type_skip_modifiers(btf, t->type, NULL);
7992
7993 /*
7994 * We allow all subprogs except for the main one to return any kind of arena pointer.
7995 * General arena variables are not allowed, since it makes no sense to return by value
7996 * a variable that's on the heap in the first place.
7997 */
7998 if (subprog && (tags & ARG_TAG_ARENA) && btf_type_is_ptr(t))
7999 return 0;
8000
8001 /* We always accept void or scalars. */
8002 if (btf_type_is_void(t) || btf_type_is_int(t) || btf_is_any_enum(t))
8003 return 0;
8004
8005 return -EOPNOTSUPP;
8006 }
8007
8008 /* Process BTF of a function to produce high-level expectation of function
8009 * arguments (like ARG_PTR_TO_CTX, or ARG_PTR_TO_MEM, etc). This information
8010 * is cached in subprog info for reuse.
8011 * Returns:
8012 * EFAULT - there is a verifier bug. Abort verification.
8013 * EINVAL - cannot convert BTF.
8014 * 0 - Successfully processed BTF and constructed argument expectations.
8015 */
btf_prepare_func_args(struct bpf_verifier_env * env,int subprog)8016 int btf_prepare_func_args(struct bpf_verifier_env *env, int subprog)
8017 {
8018 bool is_global = subprog_aux(env, subprog)->linkage == BTF_FUNC_GLOBAL;
8019 struct bpf_subprog_info *sub = subprog_info(env, subprog);
8020 struct bpf_verifier_log *log = &env->log;
8021 struct bpf_prog *prog = env->prog;
8022 enum bpf_prog_type prog_type = prog->type;
8023 struct btf *btf = prog->aux->btf;
8024 const struct btf_param *args;
8025 const struct btf_type *t, *ref_t, *fn_t;
8026 int err;
8027 u32 i, nargs, btf_id;
8028 const char *tname;
8029
8030 if (sub->args_cached)
8031 return 0;
8032
8033 if (!prog->aux->func_info) {
8034 verifier_bug(env, "func_info undefined");
8035 return -EFAULT;
8036 }
8037
8038 btf_id = prog->aux->func_info[subprog].type_id;
8039 if (!btf_id) {
8040 if (!is_global) /* not fatal for static funcs */
8041 return -EINVAL;
8042 bpf_log(log, "Global functions need valid BTF\n");
8043 return -EFAULT;
8044 }
8045
8046 fn_t = btf_type_by_id(btf, btf_id);
8047 if (!fn_t || !btf_type_is_func(fn_t)) {
8048 /* These checks were already done by the verifier while loading
8049 * struct bpf_func_info
8050 */
8051 bpf_log(log, "BTF of func#%d doesn't point to KIND_FUNC\n",
8052 subprog);
8053 return -EFAULT;
8054 }
8055 tname = btf_name_by_offset(btf, fn_t->name_off);
8056
8057 if (prog->aux->func_info_aux[subprog].unreliable) {
8058 verifier_bug(env, "unreliable BTF for function %s()", tname);
8059 return -EFAULT;
8060 }
8061 if (prog_type == BPF_PROG_TYPE_EXT)
8062 prog_type = prog->aux->dst_prog->type;
8063
8064 t = btf_type_by_id(btf, fn_t->type);
8065 if (!t || !btf_type_is_func_proto(t)) {
8066 bpf_log(log, "Invalid type of function %s()\n", tname);
8067 return -EFAULT;
8068 }
8069 args = (const struct btf_param *)(t + 1);
8070 nargs = btf_type_vlen(t);
8071 sub->arg_cnt = nargs;
8072 if (nargs > MAX_BPF_FUNC_ARGS) {
8073 bpf_log(log, "kernel supports at most %d parameters, function %s has %d\n",
8074 MAX_BPF_FUNC_ARGS, tname, nargs);
8075 return -EFAULT;
8076 }
8077 if (nargs > MAX_BPF_FUNC_REG_ARGS) {
8078 if (!bpf_jit_supports_stack_args()) {
8079 bpf_log(log, "JIT does not support function %s() with %d args\n",
8080 tname, nargs);
8081 return -EFAULT;
8082 }
8083 sub->stack_arg_cnt = nargs - MAX_BPF_FUNC_REG_ARGS;
8084 }
8085
8086 if (is_global && nargs > MAX_BPF_FUNC_REG_ARGS) {
8087 bpf_log(log, "global function %s has %d > %d args, stack args not supported\n",
8088 tname, nargs, MAX_BPF_FUNC_REG_ARGS);
8089 return -EINVAL;
8090 }
8091
8092 err = btf_validate_return_type(env, btf, t, subprog);
8093 if (err) {
8094 if (is_global) {
8095 bpf_log(log,
8096 "Global function %s() return value not void or scalar. "
8097 "Only those are supported.\n",
8098 tname);
8099 }
8100 return err;
8101 }
8102
8103 /* Convert BTF function arguments into verifier types.
8104 * Only PTR_TO_CTX and SCALAR are supported atm.
8105 */
8106 for (i = 0; i < nargs; i++) {
8107 u32 tags = 0;
8108 err = btf_scan_decl_tags(env, btf, fn_t, i, is_global, &tags);
8109 if (err)
8110 return err;
8111
8112 err = btf_scan_type_tags(env, btf, args[i].type, &tags);
8113 if (err)
8114 return err;
8115
8116 t = btf_type_by_id(btf, args[i].type);
8117 while (btf_type_is_modifier(t))
8118 t = btf_type_by_id(btf, t->type);
8119 if (!btf_type_is_ptr(t))
8120 goto skip_pointer;
8121
8122 if ((tags & ARG_TAG_CTX) || btf_is_prog_ctx_type(log, btf, t, prog_type, i)) {
8123 if (tags & ~ARG_TAG_CTX) {
8124 bpf_log(log, "arg#%d has invalid combination of tags\n", i);
8125 return -EINVAL;
8126 }
8127 if ((tags & ARG_TAG_CTX) &&
8128 btf_validate_prog_ctx_type(log, btf, t, i, prog_type,
8129 prog->expected_attach_type))
8130 return -EINVAL;
8131 sub->args[i].arg_type = ARG_PTR_TO_CTX;
8132 continue;
8133 }
8134 if (btf_is_dynptr_ptr(btf, t)) {
8135 if (tags) {
8136 bpf_log(log, "arg#%d has invalid combination of tags\n", i);
8137 return -EINVAL;
8138 }
8139 sub->args[i].arg_type = ARG_PTR_TO_DYNPTR;
8140 continue;
8141 }
8142 if (tags & ARG_TAG_TRUSTED) {
8143 int kern_type_id;
8144
8145 if (tags & ARG_TAG_NONNULL) {
8146 bpf_log(log, "arg#%d has invalid combination of tags\n", i);
8147 return -EINVAL;
8148 }
8149
8150 kern_type_id = btf_get_ptr_to_btf_id(log, i, btf, t);
8151 if (kern_type_id < 0)
8152 return kern_type_id;
8153
8154 sub->args[i].arg_type = ARG_PTR_TO_BTF_ID | PTR_TRUSTED;
8155 if (tags & ARG_TAG_NULLABLE)
8156 sub->args[i].arg_type |= PTR_MAYBE_NULL;
8157 sub->args[i].btf_id = kern_type_id;
8158 continue;
8159 }
8160 if (tags & ARG_TAG_UNTRUSTED) {
8161 struct btf *vmlinux_btf;
8162 int kern_type_id;
8163
8164 if (tags & ~ARG_TAG_UNTRUSTED) {
8165 bpf_log(log, "arg#%d untrusted cannot be combined with any other tags\n", i);
8166 return -EINVAL;
8167 }
8168
8169 ref_t = btf_type_skip_modifiers(btf, t->type, NULL);
8170 if (btf_type_is_void(ref_t) || btf_type_is_primitive(ref_t)) {
8171 sub->args[i].arg_type = ARG_PTR_TO_MEM | MEM_RDONLY | PTR_UNTRUSTED;
8172 sub->args[i].mem_size = 0;
8173 continue;
8174 }
8175
8176 kern_type_id = btf_get_ptr_to_btf_id(log, i, btf, t);
8177 if (kern_type_id < 0)
8178 return kern_type_id;
8179
8180 vmlinux_btf = bpf_get_btf_vmlinux();
8181 ref_t = btf_type_by_id(vmlinux_btf, kern_type_id);
8182 if (!btf_type_is_struct(ref_t)) {
8183 tname = __btf_name_by_offset(vmlinux_btf, t->name_off);
8184 bpf_log(log, "arg#%d has type %s '%s', but only struct or primitive types are allowed\n",
8185 i, btf_type_str(ref_t), tname);
8186 return -EINVAL;
8187 }
8188 sub->args[i].arg_type = ARG_PTR_TO_BTF_ID | PTR_UNTRUSTED;
8189 sub->args[i].btf_id = kern_type_id;
8190 continue;
8191 }
8192 if (tags & ARG_TAG_ARENA) {
8193 if (tags & ~ARG_TAG_ARENA) {
8194 bpf_log(log, "arg#%d arena cannot be combined with any other tags\n", i);
8195 return -EINVAL;
8196 }
8197 sub->args[i].arg_type = ARG_PTR_TO_ARENA;
8198 continue;
8199 }
8200 if (is_global) { /* generic user data pointer */
8201 u32 mem_size;
8202
8203 if (tags & ARG_TAG_NULLABLE) {
8204 bpf_log(log, "arg#%d has invalid combination of tags\n", i);
8205 return -EINVAL;
8206 }
8207
8208 t = btf_type_skip_modifiers(btf, t->type, NULL);
8209 ref_t = btf_resolve_size(btf, t, &mem_size);
8210 if (IS_ERR(ref_t)) {
8211 bpf_log(log, "arg#%d reference type('%s %s') size cannot be determined: %ld\n",
8212 i, btf_type_str(t), btf_name_by_offset(btf, t->name_off),
8213 PTR_ERR(ref_t));
8214 return -EINVAL;
8215 }
8216
8217 sub->args[i].arg_type = ARG_PTR_TO_MEM | PTR_MAYBE_NULL;
8218 if (tags & ARG_TAG_NONNULL)
8219 sub->args[i].arg_type &= ~PTR_MAYBE_NULL;
8220 sub->args[i].mem_size = mem_size;
8221 continue;
8222 }
8223
8224 skip_pointer:
8225 if (tags) {
8226 bpf_log(log, "arg#%d has pointer tag, but is not a pointer type\n", i);
8227 return -EINVAL;
8228 }
8229 if (btf_type_is_int(t) || btf_is_any_enum(t)) {
8230 sub->args[i].arg_type = ARG_ANYTHING;
8231 continue;
8232 }
8233 if (!is_global)
8234 return -EINVAL;
8235 bpf_log(log, "Arg#%d type %s in %s() is not supported yet.\n",
8236 i, btf_type_str(t), tname);
8237 return -EINVAL;
8238 }
8239
8240 sub->args_cached = true;
8241
8242 return 0;
8243 }
8244
btf_type_show(const struct btf * btf,u32 type_id,void * obj,struct btf_show * show)8245 static void btf_type_show(const struct btf *btf, u32 type_id, void *obj,
8246 struct btf_show *show)
8247 {
8248 const struct btf_type *t = btf_type_by_id(btf, type_id);
8249
8250 show->btf = btf;
8251 memset(&show->state, 0, sizeof(show->state));
8252 memset(&show->obj, 0, sizeof(show->obj));
8253
8254 btf_type_ops(t)->show(btf, t, type_id, obj, 0, show);
8255 }
8256
btf_seq_show(struct btf_show * show,const char * fmt,va_list args)8257 __printf(2, 0) static void btf_seq_show(struct btf_show *show, const char *fmt,
8258 va_list args)
8259 {
8260 seq_vprintf((struct seq_file *)show->target, fmt, args);
8261 }
8262
btf_type_seq_show_flags(const struct btf * btf,u32 type_id,void * obj,struct seq_file * m,u64 flags)8263 int btf_type_seq_show_flags(const struct btf *btf, u32 type_id,
8264 void *obj, struct seq_file *m, u64 flags)
8265 {
8266 struct btf_show sseq;
8267
8268 sseq.target = m;
8269 sseq.showfn = btf_seq_show;
8270 sseq.flags = flags;
8271
8272 btf_type_show(btf, type_id, obj, &sseq);
8273
8274 return sseq.state.status;
8275 }
8276
btf_type_seq_show(const struct btf * btf,u32 type_id,void * obj,struct seq_file * m)8277 void btf_type_seq_show(const struct btf *btf, u32 type_id, void *obj,
8278 struct seq_file *m)
8279 {
8280 (void) btf_type_seq_show_flags(btf, type_id, obj, m,
8281 BTF_SHOW_NONAME | BTF_SHOW_COMPACT |
8282 BTF_SHOW_ZERO | BTF_SHOW_UNSAFE);
8283 }
8284
8285 struct btf_show_snprintf {
8286 struct btf_show show;
8287 int len_left; /* space left in string */
8288 int len; /* length we would have written */
8289 };
8290
btf_snprintf_show(struct btf_show * show,const char * fmt,va_list args)8291 __printf(2, 0) static void btf_snprintf_show(struct btf_show *show, const char *fmt,
8292 va_list args)
8293 {
8294 struct btf_show_snprintf *ssnprintf = (struct btf_show_snprintf *)show;
8295 int len;
8296
8297 len = vsnprintf(show->target, ssnprintf->len_left, fmt, args);
8298
8299 if (len < 0) {
8300 ssnprintf->len_left = 0;
8301 ssnprintf->len = len;
8302 } else if (len >= ssnprintf->len_left) {
8303 /* no space, drive on to get length we would have written */
8304 ssnprintf->len_left = 0;
8305 ssnprintf->len += len;
8306 } else {
8307 ssnprintf->len_left -= len;
8308 ssnprintf->len += len;
8309 show->target += len;
8310 }
8311 }
8312
btf_type_snprintf_show(const struct btf * btf,u32 type_id,void * obj,char * buf,int len,u64 flags)8313 int btf_type_snprintf_show(const struct btf *btf, u32 type_id, void *obj,
8314 char *buf, int len, u64 flags)
8315 {
8316 struct btf_show_snprintf ssnprintf;
8317
8318 ssnprintf.show.target = buf;
8319 ssnprintf.show.flags = flags;
8320 ssnprintf.show.showfn = btf_snprintf_show;
8321 ssnprintf.len_left = len;
8322 ssnprintf.len = 0;
8323
8324 btf_type_show(btf, type_id, obj, (struct btf_show *)&ssnprintf);
8325
8326 /* If we encountered an error, return it. */
8327 if (ssnprintf.show.state.status)
8328 return ssnprintf.show.state.status;
8329
8330 /* Otherwise return length we would have written */
8331 return ssnprintf.len;
8332 }
8333
btf_type_name_to_buf(const struct btf * btf,u32 type_id,char * buf,int len)8334 int btf_type_name_to_buf(const struct btf *btf, u32 type_id, char *buf, int len)
8335 {
8336 struct btf_show show = {
8337 .btf = btf,
8338 .state.type_id = type_id,
8339 };
8340
8341 return snprintf(buf, len, "%s", btf_show_name(&show));
8342 }
8343
8344 #ifdef CONFIG_PROC_FS
bpf_btf_show_fdinfo(struct seq_file * m,struct file * filp)8345 static void bpf_btf_show_fdinfo(struct seq_file *m, struct file *filp)
8346 {
8347 const struct btf *btf = filp->private_data;
8348
8349 seq_printf(m, "btf_id:\t%u\n", READ_ONCE(btf->id));
8350 }
8351 #endif
8352
btf_release(struct inode * inode,struct file * filp)8353 static int btf_release(struct inode *inode, struct file *filp)
8354 {
8355 btf_put(filp->private_data);
8356 return 0;
8357 }
8358
8359 const struct file_operations btf_fops = {
8360 #ifdef CONFIG_PROC_FS
8361 .show_fdinfo = bpf_btf_show_fdinfo,
8362 #endif
8363 .release = btf_release,
8364 };
8365
__btf_new_fd(struct btf * btf)8366 static int __btf_new_fd(struct btf *btf)
8367 {
8368 return anon_inode_getfd("btf", &btf_fops, btf, O_RDONLY | O_CLOEXEC);
8369 }
8370
btf_new_fd(const union bpf_attr * attr,bpfptr_t uattr,struct bpf_log_attr * attr_log)8371 int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr, struct bpf_log_attr *attr_log)
8372 {
8373 struct btf *btf;
8374 int ret;
8375
8376 btf = btf_parse(attr, uattr, attr_log);
8377 if (IS_ERR(btf))
8378 return PTR_ERR(btf);
8379
8380 ret = btf_alloc_id(btf);
8381 if (ret) {
8382 btf_free(btf);
8383 return ret;
8384 }
8385
8386 /*
8387 * The BTF ID is published to the userspace.
8388 * All BTF free must go through call_rcu() from
8389 * now on (i.e. free by calling btf_put()).
8390 */
8391
8392 ret = __btf_new_fd(btf);
8393 if (ret < 0)
8394 btf_put(btf);
8395
8396 return ret;
8397 }
8398
btf_get_by_fd(int fd)8399 struct btf *btf_get_by_fd(int fd)
8400 {
8401 struct btf *btf;
8402 CLASS(fd, f)(fd);
8403
8404 btf = __btf_get_by_fd(f);
8405 if (!IS_ERR(btf))
8406 refcount_inc(&btf->refcnt);
8407
8408 return btf;
8409 }
8410
btf_get_info_by_fd(const struct btf * btf,const union bpf_attr * attr,union bpf_attr __user * uattr)8411 int btf_get_info_by_fd(const struct btf *btf,
8412 const union bpf_attr *attr,
8413 union bpf_attr __user *uattr)
8414 {
8415 struct bpf_btf_info __user *uinfo;
8416 struct bpf_btf_info info;
8417 u32 info_copy, btf_copy;
8418 void __user *ubtf;
8419 char __user *uname;
8420 u32 uinfo_len, uname_len, name_len;
8421 int ret = 0;
8422
8423 uinfo = u64_to_user_ptr(attr->info.info);
8424 uinfo_len = attr->info.info_len;
8425
8426 info_copy = min_t(u32, uinfo_len, sizeof(info));
8427 memset(&info, 0, sizeof(info));
8428 if (copy_from_user(&info, uinfo, info_copy))
8429 return -EFAULT;
8430
8431 info.id = READ_ONCE(btf->id);
8432 ubtf = u64_to_user_ptr(info.btf);
8433 btf_copy = min_t(u32, btf->data_size, info.btf_size);
8434 if (copy_to_user(ubtf, btf->data, btf_copy))
8435 return -EFAULT;
8436 info.btf_size = btf->data_size;
8437
8438 info.kernel_btf = btf->kernel_btf;
8439
8440 uname = u64_to_user_ptr(info.name);
8441 uname_len = info.name_len;
8442 if (!uname ^ !uname_len)
8443 return -EINVAL;
8444
8445 name_len = strlen(btf->name);
8446 info.name_len = name_len;
8447
8448 if (uname) {
8449 if (uname_len >= name_len + 1) {
8450 if (copy_to_user(uname, btf->name, name_len + 1))
8451 return -EFAULT;
8452 } else {
8453 char zero = '\0';
8454
8455 if (copy_to_user(uname, btf->name, uname_len - 1))
8456 return -EFAULT;
8457 if (put_user(zero, uname + uname_len - 1))
8458 return -EFAULT;
8459 /* let user-space know about too short buffer */
8460 ret = -ENOSPC;
8461 }
8462 }
8463
8464 if (copy_to_user(uinfo, &info, info_copy) ||
8465 put_user(info_copy, &uattr->info.info_len))
8466 return -EFAULT;
8467
8468 return ret;
8469 }
8470
btf_get_fd_by_id(u32 id)8471 int btf_get_fd_by_id(u32 id)
8472 {
8473 struct btf *btf;
8474 int fd;
8475
8476 rcu_read_lock();
8477 btf = idr_find(&btf_idr, id);
8478 if (!btf || !refcount_inc_not_zero(&btf->refcnt))
8479 btf = ERR_PTR(-ENOENT);
8480 rcu_read_unlock();
8481
8482 if (IS_ERR(btf))
8483 return PTR_ERR(btf);
8484
8485 fd = __btf_new_fd(btf);
8486 if (fd < 0)
8487 btf_put(btf);
8488
8489 return fd;
8490 }
8491
btf_obj_id(const struct btf * btf)8492 u32 btf_obj_id(const struct btf *btf)
8493 {
8494 return READ_ONCE(btf->id);
8495 }
8496
btf_is_kernel(const struct btf * btf)8497 bool btf_is_kernel(const struct btf *btf)
8498 {
8499 return btf->kernel_btf;
8500 }
8501
btf_is_module(const struct btf * btf)8502 bool btf_is_module(const struct btf *btf)
8503 {
8504 return btf->kernel_btf && strcmp(btf->name, "vmlinux") != 0;
8505 }
8506
8507 enum {
8508 BTF_MODULE_F_LIVE = (1 << 0),
8509 };
8510
8511 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
8512 struct btf_module {
8513 struct list_head list;
8514 struct module *module;
8515 struct btf *btf;
8516 struct bin_attribute *sysfs_attr;
8517 int flags;
8518 };
8519
8520 static LIST_HEAD(btf_modules);
8521 static DEFINE_MUTEX(btf_module_mutex);
8522
8523 static void purge_cand_cache(struct btf *btf);
8524
btf_module_notify(struct notifier_block * nb,unsigned long op,void * module)8525 static int btf_module_notify(struct notifier_block *nb, unsigned long op,
8526 void *module)
8527 {
8528 struct btf_module *btf_mod, *tmp;
8529 struct module *mod = module;
8530 struct btf *btf;
8531 int err = 0;
8532
8533 if (mod->btf_data_size == 0 ||
8534 (op != MODULE_STATE_COMING && op != MODULE_STATE_LIVE &&
8535 op != MODULE_STATE_GOING))
8536 goto out;
8537
8538 switch (op) {
8539 case MODULE_STATE_COMING:
8540 btf_mod = kzalloc_obj(*btf_mod);
8541 if (!btf_mod) {
8542 err = -ENOMEM;
8543 goto out;
8544 }
8545 btf = btf_parse_module(mod->name, mod->btf_data, mod->btf_data_size,
8546 mod->btf_base_data, mod->btf_base_data_size);
8547 if (IS_ERR(btf)) {
8548 kfree(btf_mod);
8549 if (!IS_ENABLED(CONFIG_MODULE_ALLOW_BTF_MISMATCH)) {
8550 pr_warn("failed to validate module [%s] BTF: %ld\n",
8551 mod->name, PTR_ERR(btf));
8552 err = PTR_ERR(btf);
8553 } else {
8554 pr_warn_once("Kernel module BTF mismatch detected, BTF debug info may be unavailable for some modules\n");
8555 }
8556 goto out;
8557 }
8558 err = btf_alloc_id(btf);
8559 if (err) {
8560 btf_free(btf);
8561 kfree(btf_mod);
8562 goto out;
8563 }
8564
8565 purge_cand_cache(NULL);
8566 mutex_lock(&btf_module_mutex);
8567 btf_mod->module = module;
8568 btf_mod->btf = btf;
8569 list_add(&btf_mod->list, &btf_modules);
8570 mutex_unlock(&btf_module_mutex);
8571
8572 if (IS_ENABLED(CONFIG_SYSFS)) {
8573 struct bin_attribute *attr;
8574
8575 attr = kzalloc_obj(*attr);
8576 if (!attr)
8577 goto out;
8578
8579 sysfs_bin_attr_init(attr);
8580 attr->attr.name = btf->name;
8581 attr->attr.mode = 0444;
8582 attr->size = btf->data_size;
8583 attr->private = btf->data;
8584 attr->read = sysfs_bin_attr_simple_read;
8585
8586 err = sysfs_create_bin_file(btf_kobj, attr);
8587 if (err) {
8588 pr_warn("failed to register module [%s] BTF in sysfs: %d\n",
8589 mod->name, err);
8590 kfree(attr);
8591 err = 0;
8592 goto out;
8593 }
8594
8595 btf_mod->sysfs_attr = attr;
8596 }
8597
8598 break;
8599 case MODULE_STATE_LIVE:
8600 mutex_lock(&btf_module_mutex);
8601 list_for_each_entry_safe(btf_mod, tmp, &btf_modules, list) {
8602 if (btf_mod->module != module)
8603 continue;
8604
8605 btf_mod->flags |= BTF_MODULE_F_LIVE;
8606 break;
8607 }
8608 mutex_unlock(&btf_module_mutex);
8609 break;
8610 case MODULE_STATE_GOING:
8611 mutex_lock(&btf_module_mutex);
8612 list_for_each_entry_safe(btf_mod, tmp, &btf_modules, list) {
8613 if (btf_mod->module != module)
8614 continue;
8615
8616 /*
8617 * For modules, we do the freeing of BTF IDR as soon as
8618 * module goes away to disable BTF discovery, since the
8619 * btf_try_get_module() on such BTFs will fail. This may
8620 * be called again on btf_put(), but it's ok to do so.
8621 */
8622 btf_free_id(btf_mod->btf);
8623 list_del(&btf_mod->list);
8624 if (btf_mod->sysfs_attr)
8625 sysfs_remove_bin_file(btf_kobj, btf_mod->sysfs_attr);
8626 purge_cand_cache(btf_mod->btf);
8627 btf_put(btf_mod->btf);
8628 kfree(btf_mod->sysfs_attr);
8629 kfree(btf_mod);
8630 break;
8631 }
8632 mutex_unlock(&btf_module_mutex);
8633 break;
8634 }
8635 out:
8636 return notifier_from_errno(err);
8637 }
8638
8639 static struct notifier_block btf_module_nb = {
8640 .notifier_call = btf_module_notify,
8641 };
8642
btf_module_init(void)8643 static int __init btf_module_init(void)
8644 {
8645 register_module_notifier(&btf_module_nb);
8646 return 0;
8647 }
8648
8649 fs_initcall(btf_module_init);
8650 #endif /* CONFIG_DEBUG_INFO_BTF_MODULES */
8651
btf_try_get_module(const struct btf * btf)8652 struct module *btf_try_get_module(const struct btf *btf)
8653 {
8654 struct module *res = NULL;
8655 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
8656 struct btf_module *btf_mod, *tmp;
8657
8658 mutex_lock(&btf_module_mutex);
8659 list_for_each_entry_safe(btf_mod, tmp, &btf_modules, list) {
8660 if (btf_mod->btf != btf)
8661 continue;
8662
8663 /* We must only consider module whose __init routine has
8664 * finished, hence we must check for BTF_MODULE_F_LIVE flag,
8665 * which is set from the notifier callback for
8666 * MODULE_STATE_LIVE.
8667 */
8668 if ((btf_mod->flags & BTF_MODULE_F_LIVE) && try_module_get(btf_mod->module))
8669 res = btf_mod->module;
8670
8671 break;
8672 }
8673 mutex_unlock(&btf_module_mutex);
8674 #endif
8675
8676 return res;
8677 }
8678
8679 /* Returns struct btf corresponding to the struct module.
8680 * This function can return NULL or ERR_PTR.
8681 */
btf_get_module_btf(const struct module * module)8682 struct btf *btf_get_module_btf(const struct module *module)
8683 {
8684 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
8685 struct btf_module *btf_mod, *tmp;
8686 #endif
8687 struct btf *btf = NULL;
8688
8689 if (!module) {
8690 btf = bpf_get_btf_vmlinux();
8691 if (!IS_ERR_OR_NULL(btf))
8692 btf_get(btf);
8693 return btf;
8694 }
8695
8696 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
8697 mutex_lock(&btf_module_mutex);
8698 list_for_each_entry_safe(btf_mod, tmp, &btf_modules, list) {
8699 if (btf_mod->module != module)
8700 continue;
8701
8702 btf_get(btf_mod->btf);
8703 btf = btf_mod->btf;
8704 break;
8705 }
8706 mutex_unlock(&btf_module_mutex);
8707 #endif
8708
8709 return btf;
8710 }
8711
check_btf_kconfigs(const struct module * module,const char * feature)8712 static int check_btf_kconfigs(const struct module *module, const char *feature)
8713 {
8714 if (!module && IS_ENABLED(CONFIG_DEBUG_INFO_BTF)) {
8715 pr_err("missing vmlinux BTF, cannot register %s\n", feature);
8716 return -ENOENT;
8717 }
8718 if (module && IS_ENABLED(CONFIG_DEBUG_INFO_BTF_MODULES))
8719 pr_warn("missing module BTF, cannot register %s\n", feature);
8720 return 0;
8721 }
8722
BPF_CALL_4(bpf_btf_find_by_name_kind,char *,name,int,name_sz,u32,kind,int,flags)8723 BPF_CALL_4(bpf_btf_find_by_name_kind, char *, name, int, name_sz, u32, kind, int, flags)
8724 {
8725 struct btf *btf = NULL;
8726 int btf_obj_fd = 0;
8727 long ret;
8728
8729 if (flags)
8730 return -EINVAL;
8731
8732 if (name_sz <= 1 || name[name_sz - 1])
8733 return -EINVAL;
8734
8735 ret = bpf_find_btf_id(name, kind, &btf);
8736 if (ret > 0 && btf_is_module(btf)) {
8737 btf_obj_fd = __btf_new_fd(btf);
8738 if (btf_obj_fd < 0) {
8739 btf_put(btf);
8740 return btf_obj_fd;
8741 }
8742 return ret | (((u64)btf_obj_fd) << 32);
8743 }
8744 if (ret > 0)
8745 btf_put(btf);
8746 return ret;
8747 }
8748
8749 const struct bpf_func_proto bpf_btf_find_by_name_kind_proto = {
8750 .func = bpf_btf_find_by_name_kind,
8751 .gpl_only = false,
8752 .might_sleep = true,
8753 .ret_type = RET_INTEGER,
8754 .arg1_type = ARG_PTR_TO_MEM | MEM_RDONLY,
8755 .arg2_type = ARG_MEM_SIZE,
8756 .arg3_type = ARG_ANYTHING,
8757 .arg4_type = ARG_ANYTHING,
8758 };
8759
BTF_ID_LIST_GLOBAL(btf_tracing_ids,MAX_BTF_TRACING_TYPE)8760 BTF_ID_LIST_GLOBAL(btf_tracing_ids, MAX_BTF_TRACING_TYPE)
8761 #define BTF_TRACING_TYPE(name, type) BTF_ID(struct, type)
8762 BTF_TRACING_TYPE_xxx
8763 #undef BTF_TRACING_TYPE
8764
8765 /* Validate well-formedness of iter argument type.
8766 * On success, return positive BTF ID of iter state's STRUCT type.
8767 * On error, negative error is returned.
8768 */
8769 int btf_check_iter_arg(struct btf *btf, const struct btf_type *func, int arg_idx)
8770 {
8771 const struct btf_param *arg;
8772 const struct btf_type *t;
8773 const char *name;
8774 int btf_id;
8775
8776 if (btf_type_vlen(func) <= arg_idx)
8777 return -EINVAL;
8778
8779 arg = &btf_params(func)[arg_idx];
8780 t = btf_type_skip_modifiers(btf, arg->type, NULL);
8781 if (!t || !btf_type_is_ptr(t))
8782 return -EINVAL;
8783 t = btf_type_skip_modifiers(btf, t->type, &btf_id);
8784 if (!t || !__btf_type_is_struct(t))
8785 return -EINVAL;
8786
8787 name = btf_name_by_offset(btf, t->name_off);
8788 if (!name || strncmp(name, ITER_PREFIX, sizeof(ITER_PREFIX) - 1))
8789 return -EINVAL;
8790
8791 return btf_id;
8792 }
8793
btf_check_iter_kfuncs(struct btf * btf,const char * func_name,const struct btf_type * func,u32 func_flags)8794 static int btf_check_iter_kfuncs(struct btf *btf, const char *func_name,
8795 const struct btf_type *func, u32 func_flags)
8796 {
8797 u32 flags = func_flags & (KF_ITER_NEW | KF_ITER_NEXT | KF_ITER_DESTROY);
8798 const char *sfx, *iter_name;
8799 const struct btf_type *t;
8800 char exp_name[128];
8801 u32 nr_args;
8802 int btf_id;
8803
8804 /* exactly one of KF_ITER_{NEW,NEXT,DESTROY} can be set */
8805 if (!flags || (flags & (flags - 1)))
8806 return -EINVAL;
8807
8808 /* any BPF iter kfunc should have `struct bpf_iter_<type> *` first arg */
8809 nr_args = btf_type_vlen(func);
8810 if (nr_args < 1)
8811 return -EINVAL;
8812
8813 btf_id = btf_check_iter_arg(btf, func, 0);
8814 if (btf_id < 0)
8815 return btf_id;
8816
8817 /* sizeof(struct bpf_iter_<type>) should be a multiple of 8 to
8818 * fit nicely in stack slots
8819 */
8820 t = btf_type_by_id(btf, btf_id);
8821 if (t->size == 0 || (t->size % 8))
8822 return -EINVAL;
8823
8824 /* validate bpf_iter_<type>_{new,next,destroy}(struct bpf_iter_<type> *)
8825 * naming pattern
8826 */
8827 iter_name = btf_name_by_offset(btf, t->name_off) + sizeof(ITER_PREFIX) - 1;
8828 if (flags & KF_ITER_NEW)
8829 sfx = "new";
8830 else if (flags & KF_ITER_NEXT)
8831 sfx = "next";
8832 else /* (flags & KF_ITER_DESTROY) */
8833 sfx = "destroy";
8834
8835 snprintf(exp_name, sizeof(exp_name), "bpf_iter_%s_%s", iter_name, sfx);
8836 if (strcmp(func_name, exp_name))
8837 return -EINVAL;
8838
8839 /* only iter constructor should have extra arguments */
8840 if (!(flags & KF_ITER_NEW) && nr_args != 1)
8841 return -EINVAL;
8842
8843 if (flags & KF_ITER_NEXT) {
8844 /* bpf_iter_<type>_next() should return pointer */
8845 t = btf_type_skip_modifiers(btf, func->type, NULL);
8846 if (!t || !btf_type_is_ptr(t))
8847 return -EINVAL;
8848 }
8849
8850 if (flags & KF_ITER_DESTROY) {
8851 /* bpf_iter_<type>_destroy() should return void */
8852 t = btf_type_by_id(btf, func->type);
8853 if (!t || !btf_type_is_void(t))
8854 return -EINVAL;
8855 }
8856
8857 return 0;
8858 }
8859
btf_check_kfunc_name(struct btf * btf,const char * func_name,u32 kind)8860 static int btf_check_kfunc_name(struct btf *btf, const char *func_name, u32 kind)
8861 {
8862 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
8863 struct btf_module *btf_mod, *tmp;
8864 #endif
8865 s32 id;
8866
8867 if (!btf_is_module(btf))
8868 return 0;
8869
8870 id = btf_find_by_name_kind(bpf_get_btf_vmlinux(), func_name, kind);
8871 if (id >= 0) {
8872 pr_err("kfunc %s (id: %d) is already present in vmlinux.\n",
8873 func_name, id);
8874 return -EINVAL;
8875 }
8876
8877 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
8878 guard(mutex)(&btf_module_mutex);
8879 list_for_each_entry_safe(btf_mod, tmp, &btf_modules, list) {
8880 if (btf_mod->btf == btf)
8881 continue;
8882 id = btf_find_by_name_kind(btf_mod->btf, func_name, kind);
8883 if (id >= 0) {
8884 pr_err("kfunc %s (id: %d) is already present in module %s.\n",
8885 func_name, id, btf_mod->module->name);
8886 return -EINVAL;
8887 }
8888 }
8889 #endif
8890 return 0;
8891 }
8892
btf_check_kfunc_protos(struct btf * btf,u32 func_id,u32 func_flags)8893 static int btf_check_kfunc_protos(struct btf *btf, u32 func_id, u32 func_flags)
8894 {
8895 const struct btf_type *func;
8896 const char *func_name;
8897 int err;
8898
8899 /* any kfunc should be FUNC -> FUNC_PROTO */
8900 func = btf_type_by_id(btf, func_id);
8901 if (!func || !btf_type_is_func(func))
8902 return -EINVAL;
8903
8904 /* sanity check kfunc name */
8905 func_name = btf_name_by_offset(btf, func->name_off);
8906 if (!func_name || !func_name[0] ||
8907 btf_check_kfunc_name(btf, func_name, BTF_INFO_KIND(func->info)))
8908 return -EINVAL;
8909
8910 func = btf_type_by_id(btf, func->type);
8911 if (!func || !btf_type_is_func_proto(func))
8912 return -EINVAL;
8913
8914 if (func_flags & (KF_ITER_NEW | KF_ITER_NEXT | KF_ITER_DESTROY)) {
8915 err = btf_check_iter_kfuncs(btf, func_name, func, func_flags);
8916 if (err)
8917 return err;
8918 }
8919
8920 return 0;
8921 }
8922
8923 /* Kernel Function (kfunc) BTF ID set registration API */
8924
btf_populate_kfunc_set(struct btf * btf,enum btf_kfunc_hook hook,const struct btf_kfunc_id_set * kset)8925 static int btf_populate_kfunc_set(struct btf *btf, enum btf_kfunc_hook hook,
8926 const struct btf_kfunc_id_set *kset)
8927 {
8928 struct btf_kfunc_hook_filter *hook_filter;
8929 struct btf_id_set8 *add_set = kset->set;
8930 bool vmlinux_set = !btf_is_module(btf);
8931 bool add_filter = !!kset->filter;
8932 struct btf_kfunc_set_tab *tab;
8933 struct btf_id_set8 *set;
8934 u32 set_cnt, i;
8935 int ret;
8936
8937 if (hook >= BTF_KFUNC_HOOK_MAX) {
8938 ret = -EINVAL;
8939 goto end;
8940 }
8941
8942 if (!add_set->cnt)
8943 return 0;
8944
8945 tab = btf->kfunc_set_tab;
8946
8947 if (tab && add_filter) {
8948 u32 i;
8949
8950 hook_filter = &tab->hook_filters[hook];
8951 for (i = 0; i < hook_filter->nr_filters; i++) {
8952 if (hook_filter->filters[i] == kset->filter) {
8953 add_filter = false;
8954 break;
8955 }
8956 }
8957
8958 if (add_filter && hook_filter->nr_filters == BTF_KFUNC_FILTER_MAX_CNT) {
8959 ret = -E2BIG;
8960 goto end;
8961 }
8962 }
8963
8964 if (!tab) {
8965 tab = kzalloc_obj(*tab, GFP_KERNEL | __GFP_NOWARN);
8966 if (!tab)
8967 return -ENOMEM;
8968 btf->kfunc_set_tab = tab;
8969 }
8970
8971 set = tab->sets[hook];
8972 /* Warn when register_btf_kfunc_id_set is called twice for the same hook
8973 * for module sets.
8974 */
8975 if (WARN_ON_ONCE(set && !vmlinux_set)) {
8976 ret = -EINVAL;
8977 goto end;
8978 }
8979
8980 /* In case of vmlinux sets, there may be more than one set being
8981 * registered per hook. To create a unified set, we allocate a new set
8982 * and concatenate all individual sets being registered. While each set
8983 * is individually sorted, they may become unsorted when concatenated,
8984 * hence re-sorting the final set again is required to make binary
8985 * searching the set using btf_id_set8_contains function work.
8986 *
8987 * For module sets, we need to allocate as we may need to relocate
8988 * BTF ids.
8989 */
8990 set_cnt = set ? set->cnt : 0;
8991
8992 if (set_cnt > U32_MAX - add_set->cnt) {
8993 ret = -EOVERFLOW;
8994 goto end;
8995 }
8996
8997 if (set_cnt + add_set->cnt > BTF_KFUNC_SET_MAX_CNT) {
8998 ret = -E2BIG;
8999 goto end;
9000 }
9001
9002 /* Grow set */
9003 set = krealloc(tab->sets[hook],
9004 struct_size(set, pairs, set_cnt + add_set->cnt),
9005 GFP_KERNEL | __GFP_NOWARN);
9006 if (!set) {
9007 ret = -ENOMEM;
9008 goto end;
9009 }
9010
9011 /* For newly allocated set, initialize set->cnt to 0 */
9012 if (!tab->sets[hook])
9013 set->cnt = 0;
9014 tab->sets[hook] = set;
9015
9016 /* Concatenate the two sets */
9017 memcpy(set->pairs + set->cnt, add_set->pairs, add_set->cnt * sizeof(set->pairs[0]));
9018 /* Now that the set is copied, update with relocated BTF ids */
9019 for (i = set->cnt; i < set->cnt + add_set->cnt; i++)
9020 set->pairs[i].id = btf_relocate_id(btf, set->pairs[i].id);
9021
9022 set->cnt += add_set->cnt;
9023
9024 sort(set->pairs, set->cnt, sizeof(set->pairs[0]), btf_id_cmp_func, NULL);
9025
9026 if (add_filter) {
9027 hook_filter = &tab->hook_filters[hook];
9028 hook_filter->filters[hook_filter->nr_filters++] = kset->filter;
9029 }
9030 return 0;
9031 end:
9032 btf_free_kfunc_set_tab(btf);
9033 return ret;
9034 }
9035
btf_kfunc_id_set_contains(const struct btf * btf,enum btf_kfunc_hook hook,u32 kfunc_btf_id)9036 static u32 *btf_kfunc_id_set_contains(const struct btf *btf,
9037 enum btf_kfunc_hook hook,
9038 u32 kfunc_btf_id)
9039 {
9040 struct btf_id_set8 *set;
9041 u32 *id;
9042
9043 if (hook >= BTF_KFUNC_HOOK_MAX)
9044 return NULL;
9045 if (!btf->kfunc_set_tab)
9046 return NULL;
9047 set = btf->kfunc_set_tab->sets[hook];
9048 if (!set)
9049 return NULL;
9050 id = btf_id_set8_contains(set, kfunc_btf_id);
9051 if (!id)
9052 return NULL;
9053 /* The flags for BTF ID are located next to it */
9054 return id + 1;
9055 }
9056
__btf_kfunc_is_allowed(const struct btf * btf,enum btf_kfunc_hook hook,u32 kfunc_btf_id,const struct bpf_prog * prog)9057 static bool __btf_kfunc_is_allowed(const struct btf *btf,
9058 enum btf_kfunc_hook hook,
9059 u32 kfunc_btf_id,
9060 const struct bpf_prog *prog)
9061 {
9062 struct btf_kfunc_hook_filter *hook_filter;
9063 int i;
9064
9065 if (hook >= BTF_KFUNC_HOOK_MAX)
9066 return false;
9067 if (!btf->kfunc_set_tab)
9068 return false;
9069
9070 hook_filter = &btf->kfunc_set_tab->hook_filters[hook];
9071 for (i = 0; i < hook_filter->nr_filters; i++) {
9072 if (hook_filter->filters[i](prog, kfunc_btf_id))
9073 return false;
9074 }
9075
9076 return true;
9077 }
9078
bpf_prog_type_to_kfunc_hook(enum bpf_prog_type prog_type)9079 static int bpf_prog_type_to_kfunc_hook(enum bpf_prog_type prog_type)
9080 {
9081 switch (prog_type) {
9082 case BPF_PROG_TYPE_UNSPEC:
9083 return BTF_KFUNC_HOOK_COMMON;
9084 case BPF_PROG_TYPE_XDP:
9085 return BTF_KFUNC_HOOK_XDP;
9086 case BPF_PROG_TYPE_SCHED_CLS:
9087 return BTF_KFUNC_HOOK_TC;
9088 case BPF_PROG_TYPE_STRUCT_OPS:
9089 return BTF_KFUNC_HOOK_STRUCT_OPS;
9090 case BPF_PROG_TYPE_TRACING:
9091 case BPF_PROG_TYPE_TRACEPOINT:
9092 case BPF_PROG_TYPE_RAW_TRACEPOINT:
9093 case BPF_PROG_TYPE_PERF_EVENT:
9094 case BPF_PROG_TYPE_LSM:
9095 return BTF_KFUNC_HOOK_TRACING;
9096 case BPF_PROG_TYPE_SYSCALL:
9097 return BTF_KFUNC_HOOK_SYSCALL;
9098 case BPF_PROG_TYPE_CGROUP_SKB:
9099 case BPF_PROG_TYPE_CGROUP_SOCK:
9100 case BPF_PROG_TYPE_CGROUP_DEVICE:
9101 case BPF_PROG_TYPE_CGROUP_SOCK_ADDR:
9102 case BPF_PROG_TYPE_CGROUP_SOCKOPT:
9103 case BPF_PROG_TYPE_CGROUP_SYSCTL:
9104 case BPF_PROG_TYPE_SOCK_OPS:
9105 return BTF_KFUNC_HOOK_CGROUP;
9106 case BPF_PROG_TYPE_SCHED_ACT:
9107 return BTF_KFUNC_HOOK_SCHED_ACT;
9108 case BPF_PROG_TYPE_SK_SKB:
9109 return BTF_KFUNC_HOOK_SK_SKB;
9110 case BPF_PROG_TYPE_SOCKET_FILTER:
9111 return BTF_KFUNC_HOOK_SOCKET_FILTER;
9112 case BPF_PROG_TYPE_LWT_OUT:
9113 case BPF_PROG_TYPE_LWT_IN:
9114 case BPF_PROG_TYPE_LWT_XMIT:
9115 case BPF_PROG_TYPE_LWT_SEG6LOCAL:
9116 return BTF_KFUNC_HOOK_LWT;
9117 case BPF_PROG_TYPE_NETFILTER:
9118 return BTF_KFUNC_HOOK_NETFILTER;
9119 case BPF_PROG_TYPE_KPROBE:
9120 return BTF_KFUNC_HOOK_KPROBE;
9121 default:
9122 return BTF_KFUNC_HOOK_MAX;
9123 }
9124 }
9125
btf_kfunc_is_allowed(const struct btf * btf,u32 kfunc_btf_id,const struct bpf_prog * prog)9126 bool btf_kfunc_is_allowed(const struct btf *btf,
9127 u32 kfunc_btf_id,
9128 const struct bpf_prog *prog)
9129 {
9130 enum bpf_prog_type prog_type = resolve_prog_type(prog);
9131 enum btf_kfunc_hook hook;
9132 u32 *kfunc_flags;
9133
9134 kfunc_flags = btf_kfunc_id_set_contains(btf, BTF_KFUNC_HOOK_COMMON, kfunc_btf_id);
9135 if (kfunc_flags && __btf_kfunc_is_allowed(btf, BTF_KFUNC_HOOK_COMMON, kfunc_btf_id, prog))
9136 return true;
9137
9138 hook = bpf_prog_type_to_kfunc_hook(prog_type);
9139 kfunc_flags = btf_kfunc_id_set_contains(btf, hook, kfunc_btf_id);
9140 if (kfunc_flags && __btf_kfunc_is_allowed(btf, hook, kfunc_btf_id, prog))
9141 return true;
9142
9143 return false;
9144 }
9145
9146 /* Caution:
9147 * Reference to the module (obtained using btf_try_get_module) corresponding to
9148 * the struct btf *MUST* be held when calling this function from verifier
9149 * context. This is usually true as we stash references in prog's kfunc_btf_tab;
9150 * keeping the reference for the duration of the call provides the necessary
9151 * protection for looking up a well-formed btf->kfunc_set_tab.
9152 */
btf_kfunc_flags(const struct btf * btf,u32 kfunc_btf_id,const struct bpf_prog * prog)9153 u32 *btf_kfunc_flags(const struct btf *btf, u32 kfunc_btf_id, const struct bpf_prog *prog)
9154 {
9155 enum bpf_prog_type prog_type = resolve_prog_type(prog);
9156 enum btf_kfunc_hook hook;
9157 u32 *kfunc_flags;
9158
9159 kfunc_flags = btf_kfunc_id_set_contains(btf, BTF_KFUNC_HOOK_COMMON, kfunc_btf_id);
9160 if (kfunc_flags)
9161 return kfunc_flags;
9162
9163 hook = bpf_prog_type_to_kfunc_hook(prog_type);
9164 return btf_kfunc_id_set_contains(btf, hook, kfunc_btf_id);
9165 }
9166
9167 /*
9168 * Check a single KF_* @flag on a kfunc across all of its hook sets.
9169 * Returns:
9170 * * 1 if @flag is set
9171 * * 0 if @flag is not set
9172 * * -EINVAL if @flag is set inconsistently across the sets
9173 * * -ENOENT if kfunc_btf_id is not a registered kfunc
9174 */
btf_kfunc_check_flag(const struct btf * btf,u32 kfunc_btf_id,u32 flag)9175 int btf_kfunc_check_flag(const struct btf *btf, u32 kfunc_btf_id, u32 flag)
9176 {
9177 enum btf_kfunc_hook hook;
9178 int res = -ENOENT;
9179 bool is_set;
9180 u32 *flags;
9181
9182 for (hook = 0; hook < BTF_KFUNC_HOOK_MAX; hook++) {
9183 flags = btf_kfunc_id_set_contains(btf, hook, kfunc_btf_id);
9184 if (!flags)
9185 continue;
9186 is_set = *flags & flag;
9187 if (res < 0)
9188 res = is_set;
9189 else if (res != is_set)
9190 return -EINVAL;
9191 }
9192
9193 return res;
9194 }
9195
btf_kfunc_is_modify_return(const struct btf * btf,u32 kfunc_btf_id,const struct bpf_prog * prog)9196 u32 *btf_kfunc_is_modify_return(const struct btf *btf, u32 kfunc_btf_id,
9197 const struct bpf_prog *prog)
9198 {
9199 if (!__btf_kfunc_is_allowed(btf, BTF_KFUNC_HOOK_FMODRET, kfunc_btf_id, prog))
9200 return NULL;
9201
9202 return btf_kfunc_id_set_contains(btf, BTF_KFUNC_HOOK_FMODRET, kfunc_btf_id);
9203 }
9204
__register_btf_kfunc_id_set(enum btf_kfunc_hook hook,const struct btf_kfunc_id_set * kset)9205 static int __register_btf_kfunc_id_set(enum btf_kfunc_hook hook,
9206 const struct btf_kfunc_id_set *kset)
9207 {
9208 struct btf *btf;
9209 int ret, i;
9210
9211 btf = btf_get_module_btf(kset->owner);
9212 if (!btf)
9213 return check_btf_kconfigs(kset->owner, "kfunc");
9214 if (IS_ERR(btf))
9215 return PTR_ERR(btf);
9216
9217 for (i = 0; i < kset->set->cnt; i++) {
9218 ret = btf_check_kfunc_protos(btf, btf_relocate_id(btf, kset->set->pairs[i].id),
9219 kset->set->pairs[i].flags);
9220 if (ret)
9221 goto err_out;
9222 }
9223
9224 ret = btf_populate_kfunc_set(btf, hook, kset);
9225
9226 err_out:
9227 btf_put(btf);
9228 return ret;
9229 }
9230
9231 /* 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)9232 int register_btf_kfunc_id_set(enum bpf_prog_type prog_type,
9233 const struct btf_kfunc_id_set *kset)
9234 {
9235 enum btf_kfunc_hook hook;
9236
9237 /* All kfuncs need to be tagged as such in BTF.
9238 * WARN() for initcall registrations that do not check errors.
9239 */
9240 if (!(kset->set->flags & BTF_SET8_KFUNCS)) {
9241 WARN_ON(!kset->owner);
9242 return -EINVAL;
9243 }
9244
9245 hook = bpf_prog_type_to_kfunc_hook(prog_type);
9246 return __register_btf_kfunc_id_set(hook, kset);
9247 }
9248 EXPORT_SYMBOL_GPL(register_btf_kfunc_id_set);
9249
9250 /* This function must be invoked only from initcalls/module init functions */
register_btf_fmodret_id_set(const struct btf_kfunc_id_set * kset)9251 int register_btf_fmodret_id_set(const struct btf_kfunc_id_set *kset)
9252 {
9253 return __register_btf_kfunc_id_set(BTF_KFUNC_HOOK_FMODRET, kset);
9254 }
9255 EXPORT_SYMBOL_GPL(register_btf_fmodret_id_set);
9256
btf_find_dtor_kfunc(struct btf * btf,u32 btf_id)9257 s32 btf_find_dtor_kfunc(struct btf *btf, u32 btf_id)
9258 {
9259 struct btf_id_dtor_kfunc_tab *tab = btf->dtor_kfunc_tab;
9260 struct btf_id_dtor_kfunc *dtor;
9261
9262 if (!tab)
9263 return -ENOENT;
9264 /* Even though the size of tab->dtors[0] is > sizeof(u32), we only need
9265 * to compare the first u32 with btf_id, so we can reuse btf_id_cmp_func.
9266 */
9267 BUILD_BUG_ON(offsetof(struct btf_id_dtor_kfunc, btf_id) != 0);
9268 dtor = bsearch(&btf_id, tab->dtors, tab->cnt, sizeof(tab->dtors[0]), btf_id_cmp_func);
9269 if (!dtor)
9270 return -ENOENT;
9271 return dtor->kfunc_btf_id;
9272 }
9273
btf_check_dtor_kfuncs(struct btf * btf,const struct btf_id_dtor_kfunc * dtors,u32 cnt)9274 static int btf_check_dtor_kfuncs(struct btf *btf, const struct btf_id_dtor_kfunc *dtors, u32 cnt)
9275 {
9276 const struct btf_type *dtor_func, *dtor_func_proto, *t;
9277 const struct btf_param *args;
9278 s32 dtor_btf_id;
9279 u32 nr_args, i;
9280
9281 for (i = 0; i < cnt; i++) {
9282 dtor_btf_id = btf_relocate_id(btf, dtors[i].kfunc_btf_id);
9283
9284 dtor_func = btf_type_by_id(btf, dtor_btf_id);
9285 if (!dtor_func || !btf_type_is_func(dtor_func))
9286 return -EINVAL;
9287
9288 dtor_func_proto = btf_type_by_id(btf, dtor_func->type);
9289 if (!dtor_func_proto || !btf_type_is_func_proto(dtor_func_proto))
9290 return -EINVAL;
9291
9292 /* Make sure the prototype of the destructor kfunc is 'void func(type *)' */
9293 t = btf_type_by_id(btf, dtor_func_proto->type);
9294 if (!t || !btf_type_is_void(t))
9295 return -EINVAL;
9296
9297 nr_args = btf_type_vlen(dtor_func_proto);
9298 if (nr_args != 1)
9299 return -EINVAL;
9300 args = btf_params(dtor_func_proto);
9301 t = btf_type_by_id(btf, args[0].type);
9302 /* Allow any pointer type, as width on targets Linux supports
9303 * will be same for all pointer types (i.e. sizeof(void *))
9304 */
9305 if (!t || !btf_type_is_ptr(t))
9306 return -EINVAL;
9307
9308 if (IS_ENABLED(CONFIG_CFI)) {
9309 /* Ensure the destructor kfunc type matches btf_dtor_kfunc_t */
9310 t = btf_type_by_id(btf, t->type);
9311 if (!btf_type_is_void(t))
9312 return -EINVAL;
9313 }
9314 }
9315 return 0;
9316 }
9317
9318 /* 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)9319 int register_btf_id_dtor_kfuncs(const struct btf_id_dtor_kfunc *dtors, u32 add_cnt,
9320 struct module *owner)
9321 {
9322 struct btf_id_dtor_kfunc_tab *tab;
9323 struct btf *btf;
9324 u32 tab_cnt, i;
9325 int ret;
9326
9327 btf = btf_get_module_btf(owner);
9328 if (!btf)
9329 return check_btf_kconfigs(owner, "dtor kfuncs");
9330 if (IS_ERR(btf))
9331 return PTR_ERR(btf);
9332
9333 if (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 /* Ensure that the prototype of dtor kfuncs being registered is sane */
9340 ret = btf_check_dtor_kfuncs(btf, dtors, add_cnt);
9341 if (ret < 0)
9342 goto end;
9343
9344 tab = btf->dtor_kfunc_tab;
9345 /* Only one call allowed for modules */
9346 if (WARN_ON_ONCE(tab && btf_is_module(btf))) {
9347 ret = -EINVAL;
9348 goto end;
9349 }
9350
9351 tab_cnt = tab ? tab->cnt : 0;
9352 if (tab_cnt > U32_MAX - add_cnt) {
9353 ret = -EOVERFLOW;
9354 goto end;
9355 }
9356 if (tab_cnt + add_cnt >= BTF_DTOR_KFUNC_MAX_CNT) {
9357 pr_err("cannot register more than %d kfunc destructors\n", BTF_DTOR_KFUNC_MAX_CNT);
9358 ret = -E2BIG;
9359 goto end;
9360 }
9361
9362 tab = krealloc(btf->dtor_kfunc_tab,
9363 struct_size(tab, dtors, tab_cnt + add_cnt),
9364 GFP_KERNEL | __GFP_NOWARN);
9365 if (!tab) {
9366 ret = -ENOMEM;
9367 goto end;
9368 }
9369
9370 if (!btf->dtor_kfunc_tab)
9371 tab->cnt = 0;
9372 btf->dtor_kfunc_tab = tab;
9373
9374 memcpy(tab->dtors + tab->cnt, dtors, add_cnt * sizeof(tab->dtors[0]));
9375
9376 /* remap BTF ids based on BTF relocation (if any) */
9377 for (i = tab_cnt; i < tab_cnt + add_cnt; i++) {
9378 tab->dtors[i].btf_id = btf_relocate_id(btf, tab->dtors[i].btf_id);
9379 tab->dtors[i].kfunc_btf_id = btf_relocate_id(btf, tab->dtors[i].kfunc_btf_id);
9380 }
9381
9382 tab->cnt += add_cnt;
9383
9384 sort(tab->dtors, tab->cnt, sizeof(tab->dtors[0]), btf_id_cmp_func, NULL);
9385
9386 end:
9387 if (ret)
9388 btf_free_dtor_kfunc_tab(btf);
9389 btf_put(btf);
9390 return ret;
9391 }
9392 EXPORT_SYMBOL_GPL(register_btf_id_dtor_kfuncs);
9393
9394 #define MAX_TYPES_ARE_COMPAT_DEPTH 2
9395
9396 /* Check local and target types for compatibility. This check is used for
9397 * type-based CO-RE relocations and follow slightly different rules than
9398 * field-based relocations. This function assumes that root types were already
9399 * checked for name match. Beyond that initial root-level name check, names
9400 * are completely ignored. Compatibility rules are as follows:
9401 * - any two STRUCTs/UNIONs/FWDs/ENUMs/INTs/ENUM64s are considered compatible, but
9402 * kind should match for local and target types (i.e., STRUCT is not
9403 * compatible with UNION);
9404 * - for ENUMs/ENUM64s, the size is ignored;
9405 * - for INT, size and signedness are ignored;
9406 * - for ARRAY, dimensionality is ignored, element types are checked for
9407 * compatibility recursively;
9408 * - CONST/VOLATILE/RESTRICT modifiers are ignored;
9409 * - TYPEDEFs/PTRs are compatible if types they pointing to are compatible;
9410 * - FUNC_PROTOs are compatible if they have compatible signature: same
9411 * number of input args and compatible return and argument types.
9412 * These rules are not set in stone and probably will be adjusted as we get
9413 * more experience with using BPF CO-RE relocations.
9414 */
bpf_core_types_are_compat(const struct btf * local_btf,__u32 local_id,const struct btf * targ_btf,__u32 targ_id)9415 int bpf_core_types_are_compat(const struct btf *local_btf, __u32 local_id,
9416 const struct btf *targ_btf, __u32 targ_id)
9417 {
9418 return __bpf_core_types_are_compat(local_btf, local_id, targ_btf, targ_id,
9419 MAX_TYPES_ARE_COMPAT_DEPTH);
9420 }
9421
9422 #define MAX_TYPES_MATCH_DEPTH 2
9423
bpf_core_types_match(const struct btf * local_btf,u32 local_id,const struct btf * targ_btf,u32 targ_id)9424 int bpf_core_types_match(const struct btf *local_btf, u32 local_id,
9425 const struct btf *targ_btf, u32 targ_id)
9426 {
9427 return __bpf_core_types_match(local_btf, local_id, targ_btf, targ_id, false,
9428 MAX_TYPES_MATCH_DEPTH);
9429 }
9430
bpf_core_is_flavor_sep(const char * s)9431 static bool bpf_core_is_flavor_sep(const char *s)
9432 {
9433 /* check X___Y name pattern, where X and Y are not underscores */
9434 return s[0] != '_' && /* X */
9435 s[1] == '_' && s[2] == '_' && s[3] == '_' && /* ___ */
9436 s[4] != '_'; /* Y */
9437 }
9438
bpf_core_essential_name_len(const char * name)9439 size_t bpf_core_essential_name_len(const char *name)
9440 {
9441 size_t n = strlen(name);
9442 int i;
9443
9444 for (i = n - 5; i >= 0; i--) {
9445 if (bpf_core_is_flavor_sep(name + i))
9446 return i + 1;
9447 }
9448 return n;
9449 }
9450
bpf_free_cands(struct bpf_cand_cache * cands)9451 static void bpf_free_cands(struct bpf_cand_cache *cands)
9452 {
9453 if (!cands->cnt)
9454 /* empty candidate array was allocated on stack */
9455 return;
9456 kfree(cands);
9457 }
9458
bpf_free_cands_from_cache(struct bpf_cand_cache * cands)9459 static void bpf_free_cands_from_cache(struct bpf_cand_cache *cands)
9460 {
9461 kfree(cands->name);
9462 kfree(cands);
9463 }
9464
9465 #define VMLINUX_CAND_CACHE_SIZE 31
9466 static struct bpf_cand_cache *vmlinux_cand_cache[VMLINUX_CAND_CACHE_SIZE];
9467
9468 #define MODULE_CAND_CACHE_SIZE 31
9469 static struct bpf_cand_cache *module_cand_cache[MODULE_CAND_CACHE_SIZE];
9470
__print_cand_cache(struct bpf_verifier_log * log,struct bpf_cand_cache ** cache,int cache_size)9471 static void __print_cand_cache(struct bpf_verifier_log *log,
9472 struct bpf_cand_cache **cache,
9473 int cache_size)
9474 {
9475 struct bpf_cand_cache *cc;
9476 int i, j;
9477
9478 for (i = 0; i < cache_size; i++) {
9479 cc = cache[i];
9480 if (!cc)
9481 continue;
9482 bpf_log(log, "[%d]%s(", i, cc->name);
9483 for (j = 0; j < cc->cnt; j++) {
9484 bpf_log(log, "%d", cc->cands[j].id);
9485 if (j < cc->cnt - 1)
9486 bpf_log(log, " ");
9487 }
9488 bpf_log(log, "), ");
9489 }
9490 }
9491
print_cand_cache(struct bpf_verifier_log * log)9492 static void print_cand_cache(struct bpf_verifier_log *log)
9493 {
9494 mutex_lock(&cand_cache_mutex);
9495 bpf_log(log, "vmlinux_cand_cache:");
9496 __print_cand_cache(log, vmlinux_cand_cache, VMLINUX_CAND_CACHE_SIZE);
9497 bpf_log(log, "\nmodule_cand_cache:");
9498 __print_cand_cache(log, module_cand_cache, MODULE_CAND_CACHE_SIZE);
9499 bpf_log(log, "\n");
9500 mutex_unlock(&cand_cache_mutex);
9501 }
9502
hash_cands(struct bpf_cand_cache * cands)9503 static u32 hash_cands(struct bpf_cand_cache *cands)
9504 {
9505 return jhash(cands->name, cands->name_len, 0);
9506 }
9507
check_cand_cache(struct bpf_cand_cache * cands,struct bpf_cand_cache ** cache,int cache_size)9508 static struct bpf_cand_cache *check_cand_cache(struct bpf_cand_cache *cands,
9509 struct bpf_cand_cache **cache,
9510 int cache_size)
9511 {
9512 struct bpf_cand_cache *cc = cache[hash_cands(cands) % cache_size];
9513
9514 if (cc && cc->name_len == cands->name_len &&
9515 !strncmp(cc->name, cands->name, cands->name_len))
9516 return cc;
9517 return NULL;
9518 }
9519
sizeof_cands(int cnt)9520 static size_t sizeof_cands(int cnt)
9521 {
9522 return offsetof(struct bpf_cand_cache, cands[cnt]);
9523 }
9524
populate_cand_cache(struct bpf_cand_cache * cands,struct bpf_cand_cache ** cache,int cache_size)9525 static struct bpf_cand_cache *populate_cand_cache(struct bpf_cand_cache *cands,
9526 struct bpf_cand_cache **cache,
9527 int cache_size)
9528 {
9529 struct bpf_cand_cache **cc = &cache[hash_cands(cands) % cache_size], *new_cands;
9530
9531 if (*cc) {
9532 bpf_free_cands_from_cache(*cc);
9533 *cc = NULL;
9534 }
9535 new_cands = kmemdup(cands, sizeof_cands(cands->cnt), GFP_KERNEL_ACCOUNT);
9536 if (!new_cands) {
9537 bpf_free_cands(cands);
9538 return ERR_PTR(-ENOMEM);
9539 }
9540 /* strdup the name, since it will stay in cache.
9541 * the cands->name points to strings in prog's BTF and the prog can be unloaded.
9542 */
9543 new_cands->name = kmemdup_nul(cands->name, cands->name_len, GFP_KERNEL_ACCOUNT);
9544 bpf_free_cands(cands);
9545 if (!new_cands->name) {
9546 kfree(new_cands);
9547 return ERR_PTR(-ENOMEM);
9548 }
9549 *cc = new_cands;
9550 return new_cands;
9551 }
9552
9553 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
__purge_cand_cache(struct btf * btf,struct bpf_cand_cache ** cache,int cache_size)9554 static void __purge_cand_cache(struct btf *btf, struct bpf_cand_cache **cache,
9555 int cache_size)
9556 {
9557 struct bpf_cand_cache *cc;
9558 int i, j;
9559
9560 for (i = 0; i < cache_size; i++) {
9561 cc = cache[i];
9562 if (!cc)
9563 continue;
9564 if (!btf) {
9565 /* when new module is loaded purge all of module_cand_cache,
9566 * since new module might have candidates with the name
9567 * that matches cached cands.
9568 */
9569 bpf_free_cands_from_cache(cc);
9570 cache[i] = NULL;
9571 continue;
9572 }
9573 /* when module is unloaded purge cache entries
9574 * that match module's btf
9575 */
9576 for (j = 0; j < cc->cnt; j++)
9577 if (cc->cands[j].btf == btf) {
9578 bpf_free_cands_from_cache(cc);
9579 cache[i] = NULL;
9580 break;
9581 }
9582 }
9583
9584 }
9585
purge_cand_cache(struct btf * btf)9586 static void purge_cand_cache(struct btf *btf)
9587 {
9588 mutex_lock(&cand_cache_mutex);
9589 __purge_cand_cache(btf, module_cand_cache, MODULE_CAND_CACHE_SIZE);
9590 mutex_unlock(&cand_cache_mutex);
9591 }
9592 #endif
9593
9594 static struct bpf_cand_cache *
bpf_core_add_cands(struct bpf_cand_cache * cands,const struct btf * targ_btf,int targ_start_id)9595 bpf_core_add_cands(struct bpf_cand_cache *cands, const struct btf *targ_btf,
9596 int targ_start_id)
9597 {
9598 struct bpf_cand_cache *new_cands;
9599 const struct btf_type *t;
9600 const char *targ_name;
9601 size_t targ_essent_len;
9602 int n, i;
9603
9604 n = btf_nr_types(targ_btf);
9605 for (i = targ_start_id; i < n; i++) {
9606 t = btf_type_by_id(targ_btf, i);
9607 if (btf_kind(t) != cands->kind)
9608 continue;
9609
9610 targ_name = btf_name_by_offset(targ_btf, t->name_off);
9611 if (!targ_name)
9612 continue;
9613
9614 /* the resched point is before strncmp to make sure that search
9615 * for non-existing name will have a chance to schedule().
9616 */
9617 cond_resched();
9618
9619 if (strncmp(cands->name, targ_name, cands->name_len) != 0)
9620 continue;
9621
9622 targ_essent_len = bpf_core_essential_name_len(targ_name);
9623 if (targ_essent_len != cands->name_len)
9624 continue;
9625
9626 /* most of the time there is only one candidate for a given kind+name pair */
9627 new_cands = kmalloc(sizeof_cands(cands->cnt + 1), GFP_KERNEL_ACCOUNT);
9628 if (!new_cands) {
9629 bpf_free_cands(cands);
9630 return ERR_PTR(-ENOMEM);
9631 }
9632
9633 memcpy(new_cands, cands, sizeof_cands(cands->cnt));
9634 bpf_free_cands(cands);
9635 cands = new_cands;
9636 cands->cands[cands->cnt].btf = targ_btf;
9637 cands->cands[cands->cnt].id = i;
9638 cands->cnt++;
9639 }
9640 return cands;
9641 }
9642
9643 static struct bpf_cand_cache *
bpf_core_find_cands(struct bpf_core_ctx * ctx,u32 local_type_id)9644 bpf_core_find_cands(struct bpf_core_ctx *ctx, u32 local_type_id)
9645 {
9646 struct bpf_cand_cache *cands, *cc, local_cand = {};
9647 const struct btf *local_btf = ctx->btf;
9648 const struct btf_type *local_type;
9649 const struct btf *main_btf;
9650 size_t local_essent_len;
9651 struct btf *mod_btf;
9652 const char *name;
9653 int id;
9654
9655 main_btf = bpf_get_btf_vmlinux();
9656 if (IS_ERR(main_btf))
9657 return ERR_CAST(main_btf);
9658 if (!main_btf)
9659 return ERR_PTR(-EINVAL);
9660
9661 local_type = btf_type_by_id(local_btf, local_type_id);
9662 if (!local_type)
9663 return ERR_PTR(-EINVAL);
9664
9665 name = btf_name_by_offset(local_btf, local_type->name_off);
9666 if (str_is_empty(name))
9667 return ERR_PTR(-EINVAL);
9668 local_essent_len = bpf_core_essential_name_len(name);
9669
9670 cands = &local_cand;
9671 cands->name = name;
9672 cands->kind = btf_kind(local_type);
9673 cands->name_len = local_essent_len;
9674
9675 cc = check_cand_cache(cands, vmlinux_cand_cache, VMLINUX_CAND_CACHE_SIZE);
9676 /* cands is a pointer to stack here */
9677 if (cc) {
9678 if (cc->cnt)
9679 return cc;
9680 goto check_modules;
9681 }
9682
9683 /* Attempt to find target candidates in vmlinux BTF first */
9684 cands = bpf_core_add_cands(cands, main_btf, btf_named_start_id(main_btf, true));
9685 if (IS_ERR(cands))
9686 return ERR_CAST(cands);
9687
9688 /* cands is a pointer to kmalloced memory here if cands->cnt > 0 */
9689
9690 /* populate cache even when cands->cnt == 0 */
9691 cc = populate_cand_cache(cands, vmlinux_cand_cache, VMLINUX_CAND_CACHE_SIZE);
9692 if (IS_ERR(cc))
9693 return ERR_CAST(cc);
9694
9695 /* if vmlinux BTF has any candidate, don't go for module BTFs */
9696 if (cc->cnt)
9697 return cc;
9698
9699 check_modules:
9700 /* cands is a pointer to stack here and cands->cnt == 0 */
9701 cc = check_cand_cache(cands, module_cand_cache, MODULE_CAND_CACHE_SIZE);
9702 if (cc)
9703 /* if cache has it return it even if cc->cnt == 0 */
9704 return cc;
9705
9706 /* If candidate is not found in vmlinux's BTF then search in module's BTFs */
9707 spin_lock_bh(&btf_idr_lock);
9708 idr_for_each_entry(&btf_idr, mod_btf, id) {
9709 if (!btf_is_module(mod_btf))
9710 continue;
9711 /* linear search could be slow hence unlock/lock
9712 * the IDR to avoiding holding it for too long
9713 */
9714 btf_get(mod_btf);
9715 spin_unlock_bh(&btf_idr_lock);
9716 cands = bpf_core_add_cands(cands, mod_btf, btf_named_start_id(mod_btf, true));
9717 btf_put(mod_btf);
9718 if (IS_ERR(cands))
9719 return ERR_CAST(cands);
9720 spin_lock_bh(&btf_idr_lock);
9721 }
9722 spin_unlock_bh(&btf_idr_lock);
9723 /* cands is a pointer to kmalloced memory here if cands->cnt > 0
9724 * or pointer to stack if cands->cnd == 0.
9725 * Copy it into the cache even when cands->cnt == 0 and
9726 * return the result.
9727 */
9728 return populate_cand_cache(cands, module_cand_cache, MODULE_CAND_CACHE_SIZE);
9729 }
9730
bpf_core_apply(struct bpf_core_ctx * ctx,const struct bpf_core_relo * relo,int relo_idx,void * insn)9731 int bpf_core_apply(struct bpf_core_ctx *ctx, const struct bpf_core_relo *relo,
9732 int relo_idx, void *insn)
9733 {
9734 bool need_cands = relo->kind != BPF_CORE_TYPE_ID_LOCAL;
9735 struct bpf_core_cand_list cands = {};
9736 struct bpf_core_relo_res targ_res;
9737 struct bpf_core_spec *specs;
9738 const struct btf_type *type;
9739 int err;
9740
9741 /* ~4k of temp memory necessary to convert LLVM spec like "0:1:0:5"
9742 * into arrays of btf_ids of struct fields and array indices.
9743 */
9744 specs = kzalloc_objs(*specs, 3, GFP_KERNEL_ACCOUNT);
9745 if (!specs)
9746 return -ENOMEM;
9747
9748 type = btf_type_by_id(ctx->btf, relo->type_id);
9749 if (!type) {
9750 bpf_log(ctx->log, "relo #%u: bad type id %u\n",
9751 relo_idx, relo->type_id);
9752 kfree(specs);
9753 return -EINVAL;
9754 }
9755
9756 if (need_cands) {
9757 struct bpf_cand_cache *cc;
9758 int i;
9759
9760 mutex_lock(&cand_cache_mutex);
9761 cc = bpf_core_find_cands(ctx, relo->type_id);
9762 if (IS_ERR(cc)) {
9763 bpf_log(ctx->log, "target candidate search failed for %d\n",
9764 relo->type_id);
9765 err = PTR_ERR(cc);
9766 goto out;
9767 }
9768 if (cc->cnt) {
9769 cands.cands = kzalloc_objs(*cands.cands, cc->cnt,
9770 GFP_KERNEL_ACCOUNT);
9771 if (!cands.cands) {
9772 err = -ENOMEM;
9773 goto out;
9774 }
9775 }
9776 for (i = 0; i < cc->cnt; i++) {
9777 bpf_log(ctx->log,
9778 "CO-RE relocating %s %s: found target candidate [%d]\n",
9779 btf_kind_str[cc->kind], cc->name, cc->cands[i].id);
9780 cands.cands[i].btf = cc->cands[i].btf;
9781 cands.cands[i].id = cc->cands[i].id;
9782 }
9783 cands.len = cc->cnt;
9784 /* cand_cache_mutex needs to span the cache lookup and
9785 * copy of btf pointer into bpf_core_cand_list,
9786 * since module can be unloaded while bpf_core_calc_relo_insn
9787 * is working with module's btf.
9788 */
9789 }
9790
9791 err = bpf_core_calc_relo_insn((void *)ctx->log, relo, relo_idx, ctx->btf, &cands, specs,
9792 &targ_res);
9793 if (err)
9794 goto out;
9795
9796 err = bpf_core_patch_insn((void *)ctx->log, insn, relo->insn_off / 8, relo, relo_idx,
9797 &targ_res);
9798
9799 out:
9800 kfree(specs);
9801 if (need_cands) {
9802 kfree(cands.cands);
9803 mutex_unlock(&cand_cache_mutex);
9804 if (ctx->log->level & BPF_LOG_LEVEL2)
9805 print_cand_cache(ctx->log);
9806 }
9807 return err;
9808 }
9809
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)9810 bool btf_nested_type_is_trusted(struct bpf_verifier_log *log,
9811 const struct bpf_reg_state *reg,
9812 const char *field_name, u32 btf_id, const char *suffix)
9813 {
9814 struct btf *btf = reg->btf;
9815 const struct btf_type *walk_type, *safe_type;
9816 const char *tname;
9817 char safe_tname[64];
9818 long ret, safe_id;
9819 const struct btf_member *member;
9820 u32 i;
9821
9822 walk_type = btf_type_by_id(btf, reg->btf_id);
9823 if (!walk_type)
9824 return false;
9825
9826 tname = btf_name_by_offset(btf, walk_type->name_off);
9827
9828 ret = snprintf(safe_tname, sizeof(safe_tname), "%s%s", tname, suffix);
9829 if (ret >= sizeof(safe_tname))
9830 return false;
9831
9832 safe_id = btf_find_by_name_kind(btf, safe_tname, BTF_INFO_KIND(walk_type->info));
9833 if (safe_id < 0)
9834 return false;
9835
9836 safe_type = btf_type_by_id(btf, safe_id);
9837 if (!safe_type)
9838 return false;
9839
9840 for_each_member(i, safe_type, member) {
9841 const char *m_name = __btf_name_by_offset(btf, member->name_off);
9842 const struct btf_type *mtype = btf_type_by_id(btf, member->type);
9843 u32 id;
9844
9845 if (!btf_type_is_ptr(mtype))
9846 continue;
9847
9848 btf_type_skip_modifiers(btf, mtype->type, &id);
9849 /* If we match on both type and name, the field is considered trusted. */
9850 if (btf_id == id && !strcmp(field_name, m_name))
9851 return true;
9852 }
9853
9854 return false;
9855 }
9856
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)9857 bool btf_type_ids_nocast_alias(struct bpf_verifier_log *log,
9858 const struct btf *reg_btf, u32 reg_id,
9859 const struct btf *arg_btf, u32 arg_id)
9860 {
9861 const char *reg_name, *arg_name, *search_needle;
9862 const struct btf_type *reg_type, *arg_type;
9863 int reg_len, arg_len, cmp_len;
9864 size_t pattern_len = sizeof(NOCAST_ALIAS_SUFFIX) - sizeof(char);
9865
9866 reg_type = btf_type_by_id(reg_btf, reg_id);
9867 if (!reg_type)
9868 return false;
9869
9870 arg_type = btf_type_by_id(arg_btf, arg_id);
9871 if (!arg_type)
9872 return false;
9873
9874 reg_name = btf_name_by_offset(reg_btf, reg_type->name_off);
9875 arg_name = btf_name_by_offset(arg_btf, arg_type->name_off);
9876
9877 reg_len = strlen(reg_name);
9878 arg_len = strlen(arg_name);
9879
9880 /* Exactly one of the two type names may be suffixed with ___init, so
9881 * if the strings are the same size, they can't possibly be no-cast
9882 * aliases of one another. If you have two of the same type names, e.g.
9883 * they're both nf_conn___init, it would be improper to return true
9884 * because they are _not_ no-cast aliases, they are the same type.
9885 */
9886 if (reg_len == arg_len)
9887 return false;
9888
9889 /* Either of the two names must be the other name, suffixed with ___init. */
9890 if ((reg_len != arg_len + pattern_len) &&
9891 (arg_len != reg_len + pattern_len))
9892 return false;
9893
9894 if (reg_len < arg_len) {
9895 search_needle = strstr(arg_name, NOCAST_ALIAS_SUFFIX);
9896 cmp_len = reg_len;
9897 } else {
9898 search_needle = strstr(reg_name, NOCAST_ALIAS_SUFFIX);
9899 cmp_len = arg_len;
9900 }
9901
9902 if (!search_needle)
9903 return false;
9904
9905 /* ___init suffix must come at the end of the name */
9906 if (*(search_needle + pattern_len) != '\0')
9907 return false;
9908
9909 return !strncmp(reg_name, arg_name, cmp_len);
9910 }
9911
9912 #ifdef CONFIG_BPF_JIT
9913 static int
btf_add_struct_ops(struct btf * btf,struct bpf_struct_ops * st_ops,struct bpf_verifier_log * log)9914 btf_add_struct_ops(struct btf *btf, struct bpf_struct_ops *st_ops,
9915 struct bpf_verifier_log *log)
9916 {
9917 struct btf_struct_ops_tab *tab, *new_tab;
9918 int i, err;
9919
9920 tab = btf->struct_ops_tab;
9921 if (!tab) {
9922 tab = kzalloc_flex(*tab, ops, 4);
9923 if (!tab)
9924 return -ENOMEM;
9925 tab->capacity = 4;
9926 btf->struct_ops_tab = tab;
9927 }
9928
9929 for (i = 0; i < tab->cnt; i++)
9930 if (tab->ops[i].st_ops == st_ops)
9931 return -EEXIST;
9932
9933 if (tab->cnt == tab->capacity) {
9934 new_tab = krealloc(tab,
9935 struct_size(tab, ops, tab->capacity * 2),
9936 GFP_KERNEL);
9937 if (!new_tab)
9938 return -ENOMEM;
9939 tab = new_tab;
9940 tab->capacity *= 2;
9941 btf->struct_ops_tab = tab;
9942 }
9943
9944 tab->ops[btf->struct_ops_tab->cnt].st_ops = st_ops;
9945
9946 err = bpf_struct_ops_desc_init(&tab->ops[btf->struct_ops_tab->cnt], btf, log);
9947 if (err)
9948 return err;
9949
9950 btf->struct_ops_tab->cnt++;
9951
9952 return 0;
9953 }
9954
9955 const struct bpf_struct_ops_desc *
bpf_struct_ops_find_value(struct btf * btf,u32 value_id)9956 bpf_struct_ops_find_value(struct btf *btf, u32 value_id)
9957 {
9958 const struct bpf_struct_ops_desc *st_ops_list;
9959 unsigned int i;
9960 u32 cnt;
9961
9962 if (!value_id)
9963 return NULL;
9964 if (!btf->struct_ops_tab)
9965 return NULL;
9966
9967 cnt = btf->struct_ops_tab->cnt;
9968 st_ops_list = btf->struct_ops_tab->ops;
9969 for (i = 0; i < cnt; i++) {
9970 if (st_ops_list[i].value_id == value_id)
9971 return &st_ops_list[i];
9972 }
9973
9974 return NULL;
9975 }
9976
9977 const struct bpf_struct_ops_desc *
bpf_struct_ops_find(struct btf * btf,u32 type_id)9978 bpf_struct_ops_find(struct btf *btf, u32 type_id)
9979 {
9980 const struct bpf_struct_ops_desc *st_ops_list;
9981 unsigned int i;
9982 u32 cnt;
9983
9984 if (!type_id)
9985 return NULL;
9986 if (!btf->struct_ops_tab)
9987 return NULL;
9988
9989 cnt = btf->struct_ops_tab->cnt;
9990 st_ops_list = btf->struct_ops_tab->ops;
9991 for (i = 0; i < cnt; i++) {
9992 if (st_ops_list[i].type_id == type_id)
9993 return &st_ops_list[i];
9994 }
9995
9996 return NULL;
9997 }
9998
__register_bpf_struct_ops(struct bpf_struct_ops * st_ops)9999 int __register_bpf_struct_ops(struct bpf_struct_ops *st_ops)
10000 {
10001 struct bpf_verifier_log *log;
10002 struct btf *btf;
10003 int err = 0;
10004
10005 btf = btf_get_module_btf(st_ops->owner);
10006 if (!btf)
10007 return check_btf_kconfigs(st_ops->owner, "struct_ops");
10008 if (IS_ERR(btf))
10009 return PTR_ERR(btf);
10010
10011 log = kzalloc_obj(*log, GFP_KERNEL | __GFP_NOWARN);
10012 if (!log) {
10013 err = -ENOMEM;
10014 goto errout;
10015 }
10016
10017 log->level = BPF_LOG_KERNEL;
10018
10019 err = btf_add_struct_ops(btf, st_ops, log);
10020
10021 errout:
10022 kfree(log);
10023 btf_put(btf);
10024
10025 return err;
10026 }
10027 EXPORT_SYMBOL_GPL(__register_bpf_struct_ops);
10028 #endif
10029
btf_param_match_suffix(const struct btf * btf,const struct btf_param * arg,const char * suffix)10030 bool btf_param_match_suffix(const struct btf *btf,
10031 const struct btf_param *arg,
10032 const char *suffix)
10033 {
10034 int suffix_len = strlen(suffix), len;
10035 const char *param_name;
10036
10037 /* In the future, this can be ported to use BTF tagging */
10038 param_name = btf_name_by_offset(btf, arg->name_off);
10039 if (str_is_empty(param_name))
10040 return false;
10041 len = strlen(param_name);
10042 if (len <= suffix_len)
10043 return false;
10044 param_name += len - suffix_len;
10045 return !strncmp(param_name, suffix, suffix_len);
10046 }
10047