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