1 // SPDX-License-Identifier: GPL-2.0-only 2 /* Copyright (c) 2019 Facebook */ 3 4 #include <linux/bpf.h> 5 #include <linux/bpf_verifier.h> 6 #include <linux/btf.h> 7 #include <linux/filter.h> 8 #include <linux/slab.h> 9 #include <linux/numa.h> 10 #include <linux/seq_file.h> 11 #include <linux/refcount.h> 12 #include <linux/mutex.h> 13 #include <linux/btf_ids.h> 14 #include <linux/rcupdate_wait.h> 15 #include <linux/poll.h> 16 17 struct bpf_struct_ops_value { 18 struct bpf_struct_ops_common_value common; 19 char data[] ____cacheline_aligned_in_smp; 20 }; 21 22 #define MAX_TRAMP_IMAGE_PAGES 8 23 24 struct bpf_struct_ops_map { 25 struct bpf_map map; 26 const struct bpf_struct_ops_desc *st_ops_desc; 27 /* protect map_update */ 28 struct mutex lock; 29 /* link has all the bpf_links that is populated 30 * to the func ptr of the kernel's struct 31 * (in kvalue.data). 32 */ 33 struct bpf_link **links; 34 /* ksyms for bpf trampolines */ 35 struct bpf_ksym **ksyms; 36 u32 funcs_cnt; 37 u32 image_pages_cnt; 38 /* image_pages is an array of pages that has all the trampolines 39 * that stores the func args before calling the bpf_prog. 40 */ 41 void *image_pages[MAX_TRAMP_IMAGE_PAGES]; 42 /* The owner moduler's btf. */ 43 struct btf *btf; 44 /* uvalue->data stores the kernel struct 45 * (e.g. tcp_congestion_ops) that is more useful 46 * to userspace than the kvalue. For example, 47 * the bpf_prog's id is stored instead of the kernel 48 * address of a func ptr. 49 */ 50 struct bpf_struct_ops_value *uvalue; 51 /* kvalue.data stores the actual kernel's struct 52 * (e.g. tcp_congestion_ops) that will be 53 * registered to the kernel subsystem. 54 */ 55 struct bpf_struct_ops_value kvalue; 56 }; 57 58 struct bpf_struct_ops_link { 59 struct bpf_link link; 60 struct bpf_map __rcu *map; 61 wait_queue_head_t wait_hup; 62 }; 63 64 static DEFINE_MUTEX(update_mutex); 65 66 #define VALUE_PREFIX "bpf_struct_ops_" 67 #define VALUE_PREFIX_LEN (sizeof(VALUE_PREFIX) - 1) 68 69 const struct bpf_verifier_ops bpf_struct_ops_verifier_ops = { 70 }; 71 72 const struct bpf_prog_ops bpf_struct_ops_prog_ops = { 73 #ifdef CONFIG_NET 74 .test_run = bpf_struct_ops_test_run, 75 #endif 76 }; 77 78 BTF_ID_LIST(st_ops_ids) 79 BTF_ID(struct, module) 80 BTF_ID(struct, bpf_struct_ops_common_value) 81 82 enum { 83 IDX_MODULE_ID, 84 IDX_ST_OPS_COMMON_VALUE_ID, 85 }; 86 87 extern struct btf *btf_vmlinux; 88 89 static bool is_valid_value_type(struct btf *btf, s32 value_id, 90 const struct btf_type *type, 91 const char *value_name) 92 { 93 const struct btf_type *common_value_type; 94 const struct btf_member *member; 95 const struct btf_type *vt, *mt; 96 97 vt = btf_type_by_id(btf, value_id); 98 if (btf_vlen(vt) != 2) { 99 pr_warn("The number of %s's members should be 2, but we get %d\n", 100 value_name, btf_vlen(vt)); 101 return false; 102 } 103 member = btf_type_member(vt); 104 mt = btf_type_by_id(btf, member->type); 105 common_value_type = btf_type_by_id(btf_vmlinux, 106 st_ops_ids[IDX_ST_OPS_COMMON_VALUE_ID]); 107 if (mt != common_value_type) { 108 pr_warn("The first member of %s should be bpf_struct_ops_common_value\n", 109 value_name); 110 return false; 111 } 112 member++; 113 mt = btf_type_by_id(btf, member->type); 114 if (mt != type) { 115 pr_warn("The second member of %s should be %s\n", 116 value_name, btf_name_by_offset(btf, type->name_off)); 117 return false; 118 } 119 120 return true; 121 } 122 123 static void *bpf_struct_ops_image_alloc(void) 124 { 125 void *image; 126 int err; 127 128 err = bpf_jit_charge_modmem(PAGE_SIZE); 129 if (err) 130 return ERR_PTR(err); 131 image = arch_alloc_bpf_trampoline(PAGE_SIZE); 132 if (!image) { 133 bpf_jit_uncharge_modmem(PAGE_SIZE); 134 return ERR_PTR(-ENOMEM); 135 } 136 137 return image; 138 } 139 140 void bpf_struct_ops_image_free(void *image) 141 { 142 if (image) { 143 arch_free_bpf_trampoline(image, PAGE_SIZE); 144 bpf_jit_uncharge_modmem(PAGE_SIZE); 145 } 146 } 147 148 #define MAYBE_NULL_SUFFIX "__nullable" 149 #define REFCOUNTED_SUFFIX "__ref" 150 151 /* Prepare argument info for every nullable argument of a member of a 152 * struct_ops type. 153 * 154 * Initialize a struct bpf_struct_ops_arg_info according to type info of 155 * the arguments of a stub function. (Check kCFI for more information about 156 * stub functions.) 157 * 158 * Each member in the struct_ops type has a struct bpf_struct_ops_arg_info 159 * to provide an array of struct bpf_ctx_arg_aux, which in turn provides 160 * the information that used by the verifier to check the arguments of the 161 * BPF struct_ops program assigned to the member. Here, we only care about 162 * the arguments that are marked as __nullable. 163 * 164 * The array of struct bpf_ctx_arg_aux is eventually assigned to 165 * prog->aux->ctx_arg_info of BPF struct_ops programs and passed to the 166 * verifier. (See check_struct_ops_btf_id()) 167 * 168 * arg_info->info will be the list of struct bpf_ctx_arg_aux if success. If 169 * fails, it will be kept untouched. 170 */ 171 static int prepare_arg_info(struct btf *btf, 172 const char *st_ops_name, 173 const char *member_name, 174 const struct btf_type *func_proto, void *stub_func_addr, 175 struct bpf_struct_ops_arg_info *arg_info) 176 { 177 const struct btf_type *stub_func_proto, *pointed_type; 178 bool is_nullable = false, is_refcounted = false; 179 const struct btf_param *stub_args, *args; 180 struct bpf_ctx_arg_aux *info, *info_buf; 181 u32 nargs, arg_no, info_cnt = 0; 182 char ksym[KSYM_SYMBOL_LEN]; 183 const char *stub_fname; 184 const char *suffix; 185 s32 stub_func_id; 186 u32 arg_btf_id; 187 int offset; 188 189 stub_fname = kallsyms_lookup((unsigned long)stub_func_addr, NULL, NULL, NULL, ksym); 190 if (!stub_fname) { 191 pr_warn("Cannot find the stub function name for the %s in struct %s\n", 192 member_name, st_ops_name); 193 return -ENOENT; 194 } 195 196 stub_func_id = btf_find_by_name_kind(btf, stub_fname, BTF_KIND_FUNC); 197 if (stub_func_id < 0) { 198 pr_warn("Cannot find the stub function %s in btf\n", stub_fname); 199 return -ENOENT; 200 } 201 202 stub_func_proto = btf_type_by_id(btf, stub_func_id); 203 stub_func_proto = btf_type_by_id(btf, stub_func_proto->type); 204 205 /* Check if the number of arguments of the stub function is the same 206 * as the number of arguments of the function pointer. 207 */ 208 nargs = btf_type_vlen(func_proto); 209 if (nargs != btf_type_vlen(stub_func_proto)) { 210 pr_warn("the number of arguments of the stub function %s does not match the number of arguments of the member %s of struct %s\n", 211 stub_fname, member_name, st_ops_name); 212 return -EINVAL; 213 } 214 215 if (!nargs) 216 return 0; 217 218 args = btf_params(func_proto); 219 stub_args = btf_params(stub_func_proto); 220 221 info_buf = kzalloc_objs(*info_buf, nargs); 222 if (!info_buf) 223 return -ENOMEM; 224 225 /* Prepare info for every nullable argument */ 226 info = info_buf; 227 for (arg_no = 0; arg_no < nargs; arg_no++) { 228 /* Skip arguments that is not suffixed with 229 * "__nullable or __ref". 230 */ 231 is_nullable = btf_param_match_suffix(btf, &stub_args[arg_no], 232 MAYBE_NULL_SUFFIX); 233 is_refcounted = btf_param_match_suffix(btf, &stub_args[arg_no], 234 REFCOUNTED_SUFFIX); 235 236 if (is_nullable) 237 suffix = MAYBE_NULL_SUFFIX; 238 else if (is_refcounted) 239 suffix = REFCOUNTED_SUFFIX; 240 else 241 continue; 242 243 /* Should be a pointer to struct */ 244 pointed_type = btf_type_resolve_ptr(btf, 245 args[arg_no].type, 246 &arg_btf_id); 247 if (!pointed_type || 248 !btf_type_is_struct(pointed_type)) { 249 pr_warn("stub function %s has %s tagging to an unsupported type\n", 250 stub_fname, suffix); 251 goto err_out; 252 } 253 254 offset = btf_ctx_arg_offset(btf, func_proto, arg_no); 255 if (offset < 0) { 256 pr_warn("stub function %s has an invalid trampoline ctx offset for arg#%u\n", 257 stub_fname, arg_no); 258 goto err_out; 259 } 260 261 if (args[arg_no].type != stub_args[arg_no].type) { 262 pr_warn("arg#%u type in stub function %s does not match with its original func_proto\n", 263 arg_no, stub_fname); 264 goto err_out; 265 } 266 267 /* Fill the information of the new argument */ 268 info->btf_id = arg_btf_id; 269 info->btf = btf; 270 info->offset = offset; 271 if (is_nullable) { 272 info->reg_type = PTR_TRUSTED | PTR_TO_BTF_ID | PTR_MAYBE_NULL; 273 } else if (is_refcounted) { 274 info->reg_type = PTR_TRUSTED | PTR_TO_BTF_ID; 275 info->refcounted = true; 276 } 277 278 info++; 279 info_cnt++; 280 } 281 282 if (info_cnt) { 283 arg_info->info = info_buf; 284 arg_info->cnt = info_cnt; 285 } else { 286 kfree(info_buf); 287 } 288 289 return 0; 290 291 err_out: 292 kfree(info_buf); 293 294 return -EINVAL; 295 } 296 297 /* Clean up the arg_info in a struct bpf_struct_ops_desc. */ 298 void bpf_struct_ops_desc_release(struct bpf_struct_ops_desc *st_ops_desc) 299 { 300 struct bpf_struct_ops_arg_info *arg_info; 301 int i; 302 303 arg_info = st_ops_desc->arg_info; 304 for (i = 0; i < btf_type_vlen(st_ops_desc->type); i++) 305 kfree(arg_info[i].info); 306 307 kfree(arg_info); 308 } 309 310 static bool is_module_member(const struct btf *btf, u32 id) 311 { 312 const struct btf_type *t; 313 314 t = btf_type_resolve_ptr(btf, id, NULL); 315 if (!t) 316 return false; 317 318 if (!__btf_type_is_struct(t) && !btf_type_is_fwd(t)) 319 return false; 320 321 return !strcmp(btf_name_by_offset(btf, t->name_off), "module"); 322 } 323 324 int bpf_struct_ops_supported(const struct bpf_struct_ops *st_ops, u32 moff) 325 { 326 void *func_ptr = *(void **)(st_ops->cfi_stubs + moff); 327 328 return func_ptr ? 0 : -ENOTSUPP; 329 } 330 331 int bpf_struct_ops_desc_init(struct bpf_struct_ops_desc *st_ops_desc, 332 struct btf *btf, 333 struct bpf_verifier_log *log) 334 { 335 struct bpf_struct_ops *st_ops = st_ops_desc->st_ops; 336 struct bpf_struct_ops_arg_info *arg_info; 337 const struct btf_member *member; 338 const struct btf_type *t; 339 s32 type_id, value_id; 340 char value_name[128]; 341 const char *mname; 342 int i, err; 343 344 if (strlen(st_ops->name) + VALUE_PREFIX_LEN >= 345 sizeof(value_name)) { 346 pr_warn("struct_ops name %s is too long\n", 347 st_ops->name); 348 return -EINVAL; 349 } 350 sprintf(value_name, "%s%s", VALUE_PREFIX, st_ops->name); 351 352 if (!st_ops->cfi_stubs) { 353 pr_warn("struct_ops for %s has no cfi_stubs\n", st_ops->name); 354 return -EINVAL; 355 } 356 357 type_id = btf_find_by_name_kind(btf, st_ops->name, 358 BTF_KIND_STRUCT); 359 if (type_id < 0) { 360 pr_warn("Cannot find struct %s in %s\n", 361 st_ops->name, btf_get_name(btf)); 362 return -EINVAL; 363 } 364 t = btf_type_by_id(btf, type_id); 365 if (btf_type_vlen(t) > BPF_STRUCT_OPS_MAX_NR_MEMBERS) { 366 pr_warn("Cannot support #%u members in struct %s\n", 367 btf_type_vlen(t), st_ops->name); 368 return -EINVAL; 369 } 370 371 value_id = btf_find_by_name_kind(btf, value_name, 372 BTF_KIND_STRUCT); 373 if (value_id < 0) { 374 pr_warn("Cannot find struct %s in %s\n", 375 value_name, btf_get_name(btf)); 376 return -EINVAL; 377 } 378 if (!is_valid_value_type(btf, value_id, t, value_name)) 379 return -EINVAL; 380 381 arg_info = kzalloc_objs(*arg_info, btf_type_vlen(t)); 382 if (!arg_info) 383 return -ENOMEM; 384 385 st_ops_desc->arg_info = arg_info; 386 st_ops_desc->type = t; 387 st_ops_desc->type_id = type_id; 388 st_ops_desc->value_id = value_id; 389 st_ops_desc->value_type = btf_type_by_id(btf, value_id); 390 391 for_each_member(i, t, member) { 392 const struct btf_type *func_proto, *ret_type; 393 void **stub_func_addr; 394 u32 moff; 395 396 moff = __btf_member_bit_offset(t, member) / 8; 397 mname = btf_name_by_offset(btf, member->name_off); 398 if (!*mname) { 399 pr_warn("anon member in struct %s is not supported\n", 400 st_ops->name); 401 err = -EOPNOTSUPP; 402 goto errout; 403 } 404 405 if (__btf_member_bitfield_size(t, member)) { 406 pr_warn("bit field member %s in struct %s is not supported\n", 407 mname, st_ops->name); 408 err = -EOPNOTSUPP; 409 goto errout; 410 } 411 412 if (!st_ops_ids[IDX_MODULE_ID] && is_module_member(btf, member->type)) { 413 pr_warn("'struct module' btf id not found. Is CONFIG_MODULES enabled? bpf_struct_ops '%s' needs module support.\n", 414 st_ops->name); 415 err = -EOPNOTSUPP; 416 goto errout; 417 } 418 419 func_proto = btf_type_resolve_func_ptr(btf, 420 member->type, 421 NULL); 422 423 /* The member is not a function pointer or 424 * the function pointer is not supported. 425 */ 426 if (!func_proto || bpf_struct_ops_supported(st_ops, moff)) 427 continue; 428 429 if (func_proto->type) { 430 ret_type = btf_type_resolve_ptr(btf, func_proto->type, NULL); 431 if (ret_type && !__btf_type_is_struct(ret_type)) { 432 pr_warn("func ptr %s in struct %s returns non-struct pointer, which is not supported\n", 433 mname, st_ops->name); 434 err = -EOPNOTSUPP; 435 goto errout; 436 } 437 } 438 439 if (btf_distill_func_proto(log, btf, 440 func_proto, mname, 441 &st_ops->func_models[i])) { 442 pr_warn("Error in parsing func ptr %s in struct %s\n", 443 mname, st_ops->name); 444 err = -EINVAL; 445 goto errout; 446 } 447 448 stub_func_addr = *(void **)(st_ops->cfi_stubs + moff); 449 err = prepare_arg_info(btf, st_ops->name, mname, 450 func_proto, stub_func_addr, 451 arg_info + i); 452 if (err) 453 goto errout; 454 } 455 456 if (st_ops->init(btf)) { 457 pr_warn("Error in init bpf_struct_ops %s\n", 458 st_ops->name); 459 err = -EINVAL; 460 goto errout; 461 } 462 463 return 0; 464 465 errout: 466 bpf_struct_ops_desc_release(st_ops_desc); 467 468 return err; 469 } 470 471 static int bpf_struct_ops_map_get_next_key(struct bpf_map *map, void *key, 472 void *next_key) 473 { 474 if (key && *(u32 *)key == 0) 475 return -ENOENT; 476 477 *(u32 *)next_key = 0; 478 return 0; 479 } 480 481 int bpf_struct_ops_map_sys_lookup_elem(struct bpf_map *map, void *key, 482 void *value) 483 { 484 struct bpf_struct_ops_map *st_map = (struct bpf_struct_ops_map *)map; 485 struct bpf_struct_ops_value *uvalue, *kvalue; 486 enum bpf_struct_ops_state state; 487 s64 refcnt; 488 489 if (unlikely(*(u32 *)key != 0)) 490 return -ENOENT; 491 492 kvalue = &st_map->kvalue; 493 /* Pair with smp_store_release() during map_update */ 494 state = smp_load_acquire(&kvalue->common.state); 495 if (state == BPF_STRUCT_OPS_STATE_INIT) { 496 memset(value, 0, map->value_size); 497 return 0; 498 } 499 500 /* No lock is needed. state and refcnt do not need 501 * to be updated together under atomic context. 502 */ 503 uvalue = value; 504 memcpy(uvalue, st_map->uvalue, map->value_size); 505 uvalue->common.state = state; 506 507 /* This value offers the user space a general estimate of how 508 * many sockets are still utilizing this struct_ops for TCP 509 * congestion control. The number might not be exact, but it 510 * should sufficiently meet our present goals. 511 */ 512 refcnt = atomic64_read(&map->refcnt) - atomic64_read(&map->usercnt); 513 refcount_set(&uvalue->common.refcnt, max_t(s64, refcnt, 0)); 514 515 return 0; 516 } 517 518 static void *bpf_struct_ops_map_lookup_elem(struct bpf_map *map, void *key) 519 { 520 return ERR_PTR(-EINVAL); 521 } 522 523 static void bpf_struct_ops_map_put_progs(struct bpf_struct_ops_map *st_map) 524 { 525 u32 i; 526 527 for (i = 0; i < st_map->funcs_cnt; i++) { 528 if (!st_map->links[i]) 529 break; 530 bpf_link_put(st_map->links[i]); 531 st_map->links[i] = NULL; 532 } 533 } 534 535 static void bpf_struct_ops_map_dissoc_progs(struct bpf_struct_ops_map *st_map) 536 { 537 u32 i; 538 539 for (i = 0; i < st_map->funcs_cnt; i++) { 540 if (!st_map->links[i]) 541 break; 542 bpf_prog_disassoc_struct_ops(st_map->links[i]->prog); 543 } 544 } 545 546 static void bpf_struct_ops_map_free_image(struct bpf_struct_ops_map *st_map) 547 { 548 int i; 549 550 for (i = 0; i < st_map->image_pages_cnt; i++) 551 bpf_struct_ops_image_free(st_map->image_pages[i]); 552 st_map->image_pages_cnt = 0; 553 } 554 555 static int check_zero_holes(const struct btf *btf, const struct btf_type *t, void *data) 556 { 557 const struct btf_member *member; 558 u32 i, moff, msize, prev_mend = 0; 559 const struct btf_type *mtype; 560 561 for_each_member(i, t, member) { 562 moff = __btf_member_bit_offset(t, member) / 8; 563 if (moff > prev_mend && 564 memchr_inv(data + prev_mend, 0, moff - prev_mend)) 565 return -EINVAL; 566 567 mtype = btf_type_by_id(btf, member->type); 568 mtype = btf_resolve_size(btf, mtype, &msize); 569 if (IS_ERR(mtype)) 570 return PTR_ERR(mtype); 571 prev_mend = moff + msize; 572 } 573 574 if (t->size > prev_mend && 575 memchr_inv(data + prev_mend, 0, t->size - prev_mend)) 576 return -EINVAL; 577 578 return 0; 579 } 580 581 static void bpf_struct_ops_link_release(struct bpf_link *link) 582 { 583 } 584 585 static void bpf_struct_ops_link_dealloc(struct bpf_link *link) 586 { 587 struct bpf_tramp_link *tlink = container_of(link, struct bpf_tramp_link, link); 588 589 kfree(tlink); 590 } 591 592 const struct bpf_link_ops bpf_struct_ops_link_lops = { 593 .release = bpf_struct_ops_link_release, 594 .dealloc = bpf_struct_ops_link_dealloc, 595 }; 596 597 int bpf_struct_ops_prepare_trampoline(struct bpf_tramp_nodes *tnodes, 598 struct bpf_tramp_node *node, 599 const struct btf_func_model *model, 600 void *stub_func, 601 void **_image, u32 *_image_off, 602 bool allow_alloc) 603 { 604 u32 image_off = *_image_off, flags = BPF_TRAMP_F_INDIRECT; 605 void *image = *_image; 606 int size; 607 608 tnodes[BPF_TRAMP_FENTRY].nodes[0] = node; 609 tnodes[BPF_TRAMP_FENTRY].nr_nodes = 1; 610 611 if (model->ret_size > 0) 612 flags |= BPF_TRAMP_F_RET_FENTRY_RET; 613 614 size = arch_bpf_trampoline_size(model, flags, tnodes, stub_func); 615 if (size <= 0) 616 return size ? : -EFAULT; 617 618 /* Allocate image buffer if necessary */ 619 if (!image || size > PAGE_SIZE - image_off) { 620 if (!allow_alloc) 621 return -E2BIG; 622 623 image = bpf_struct_ops_image_alloc(); 624 if (IS_ERR(image)) 625 return PTR_ERR(image); 626 image_off = 0; 627 } 628 629 size = arch_prepare_bpf_trampoline(NULL, image + image_off, 630 image + image_off + size, 631 model, flags, tnodes, stub_func); 632 if (size <= 0) { 633 if (image != *_image) 634 bpf_struct_ops_image_free(image); 635 return size ? : -EFAULT; 636 } 637 638 *_image = image; 639 *_image_off = image_off + size; 640 return 0; 641 } 642 643 static void bpf_struct_ops_ksym_init(const char *tname, const char *mname, 644 void *image, unsigned int size, 645 struct bpf_ksym *ksym) 646 { 647 snprintf(ksym->name, KSYM_NAME_LEN, "bpf__%s_%s", tname, mname); 648 INIT_LIST_HEAD_RCU(&ksym->lnode); 649 bpf_image_ksym_init(image, size, ksym); 650 } 651 652 static void bpf_struct_ops_map_add_ksyms(struct bpf_struct_ops_map *st_map) 653 { 654 u32 i; 655 656 for (i = 0; i < st_map->funcs_cnt; i++) { 657 if (!st_map->ksyms[i]) 658 break; 659 bpf_image_ksym_add(st_map->ksyms[i]); 660 } 661 } 662 663 static void bpf_struct_ops_map_del_ksyms(struct bpf_struct_ops_map *st_map) 664 { 665 u32 i; 666 667 for (i = 0; i < st_map->funcs_cnt; i++) { 668 if (!st_map->ksyms[i]) 669 break; 670 bpf_image_ksym_del(st_map->ksyms[i]); 671 } 672 } 673 674 static void bpf_struct_ops_map_free_ksyms(struct bpf_struct_ops_map *st_map) 675 { 676 u32 i; 677 678 for (i = 0; i < st_map->funcs_cnt; i++) { 679 if (!st_map->ksyms[i]) 680 break; 681 kfree(st_map->ksyms[i]); 682 st_map->ksyms[i] = NULL; 683 } 684 } 685 686 static long bpf_struct_ops_map_update_elem(struct bpf_map *map, void *key, 687 void *value, u64 flags) 688 { 689 struct bpf_struct_ops_map *st_map = (struct bpf_struct_ops_map *)map; 690 const struct bpf_struct_ops_desc *st_ops_desc = st_map->st_ops_desc; 691 const struct bpf_struct_ops *st_ops = st_ops_desc->st_ops; 692 struct bpf_struct_ops_value *uvalue, *kvalue; 693 const struct btf_type *module_type; 694 const struct btf_member *member; 695 const struct btf_type *t = st_ops_desc->type; 696 struct bpf_tramp_nodes *tnodes; 697 void *udata, *kdata; 698 int prog_fd, err; 699 u32 i, trampoline_start, image_off = 0; 700 void *cur_image = NULL, *image = NULL; 701 struct bpf_link **plink; 702 struct bpf_ksym **pksym; 703 const char *tname, *mname; 704 705 if (flags) 706 return -EINVAL; 707 708 if (*(u32 *)key != 0) 709 return -E2BIG; 710 711 err = check_zero_holes(st_map->btf, st_ops_desc->value_type, value); 712 if (err) 713 return err; 714 715 uvalue = value; 716 err = check_zero_holes(st_map->btf, t, uvalue->data); 717 if (err) 718 return err; 719 720 if (uvalue->common.state || refcount_read(&uvalue->common.refcnt)) 721 return -EINVAL; 722 723 tnodes = kzalloc_objs(*tnodes, BPF_TRAMP_MAX); 724 if (!tnodes) 725 return -ENOMEM; 726 727 uvalue = (struct bpf_struct_ops_value *)st_map->uvalue; 728 kvalue = (struct bpf_struct_ops_value *)&st_map->kvalue; 729 730 mutex_lock(&st_map->lock); 731 732 if (kvalue->common.state != BPF_STRUCT_OPS_STATE_INIT) { 733 err = -EBUSY; 734 goto unlock; 735 } 736 737 memcpy(uvalue, value, map->value_size); 738 739 udata = &uvalue->data; 740 kdata = &kvalue->data; 741 742 plink = st_map->links; 743 pksym = st_map->ksyms; 744 tname = btf_name_by_offset(st_map->btf, t->name_off); 745 module_type = btf_type_by_id(btf_vmlinux, st_ops_ids[IDX_MODULE_ID]); 746 for_each_member(i, t, member) { 747 const struct btf_type *mtype, *ptype; 748 struct bpf_prog *prog; 749 struct bpf_tramp_link *link; 750 struct bpf_ksym *ksym; 751 u32 moff; 752 753 moff = __btf_member_bit_offset(t, member) / 8; 754 mname = btf_name_by_offset(st_map->btf, member->name_off); 755 ptype = btf_type_resolve_ptr(st_map->btf, member->type, NULL); 756 if (ptype == module_type) { 757 if (*(void **)(udata + moff)) 758 goto reset_unlock; 759 *(void **)(kdata + moff) = BPF_MODULE_OWNER; 760 continue; 761 } 762 763 err = st_ops->init_member(t, member, kdata, udata); 764 if (err < 0) 765 goto reset_unlock; 766 767 /* The ->init_member() has handled this member */ 768 if (err > 0) 769 continue; 770 771 /* If st_ops->init_member does not handle it, 772 * we will only handle func ptrs and zero-ed members 773 * here. Reject everything else. 774 */ 775 776 /* All non func ptr member must be 0 */ 777 if (!ptype || !btf_type_is_func_proto(ptype)) { 778 u32 msize; 779 780 mtype = btf_type_by_id(st_map->btf, member->type); 781 mtype = btf_resolve_size(st_map->btf, mtype, &msize); 782 if (IS_ERR(mtype)) { 783 err = PTR_ERR(mtype); 784 goto reset_unlock; 785 } 786 787 if (memchr_inv(udata + moff, 0, msize)) { 788 err = -EINVAL; 789 goto reset_unlock; 790 } 791 792 continue; 793 } 794 795 prog_fd = (int)(*(unsigned long *)(udata + moff)); 796 /* Similar check as the attr->attach_prog_fd */ 797 if (!prog_fd) 798 continue; 799 800 prog = bpf_prog_get(prog_fd); 801 if (IS_ERR(prog)) { 802 err = PTR_ERR(prog); 803 goto reset_unlock; 804 } 805 806 if (prog->type != BPF_PROG_TYPE_STRUCT_OPS || 807 prog->aux->attach_btf_id != st_ops_desc->type_id || 808 prog->expected_attach_type != i) { 809 bpf_prog_put(prog); 810 err = -EINVAL; 811 goto reset_unlock; 812 } 813 814 link = kzalloc_obj(*link, GFP_USER); 815 if (!link) { 816 bpf_prog_put(prog); 817 err = -ENOMEM; 818 goto reset_unlock; 819 } 820 bpf_tramp_link_init(link, BPF_LINK_TYPE_STRUCT_OPS, 821 &bpf_struct_ops_link_lops, prog, prog->expected_attach_type, 0); 822 823 *plink++ = &link->link; 824 825 /* Poison pointer on error instead of return for backward compatibility */ 826 bpf_prog_assoc_struct_ops(prog, &st_map->map); 827 828 ksym = kzalloc_obj(*ksym, GFP_USER); 829 if (!ksym) { 830 err = -ENOMEM; 831 goto reset_unlock; 832 } 833 *pksym++ = ksym; 834 835 trampoline_start = image_off; 836 err = bpf_struct_ops_prepare_trampoline(tnodes, &link->node, 837 &st_ops->func_models[i], 838 *(void **)(st_ops->cfi_stubs + moff), 839 &image, &image_off, 840 st_map->image_pages_cnt < MAX_TRAMP_IMAGE_PAGES); 841 if (err) 842 goto reset_unlock; 843 844 if (cur_image != image) { 845 st_map->image_pages[st_map->image_pages_cnt++] = image; 846 cur_image = image; 847 trampoline_start = 0; 848 } 849 850 *(void **)(kdata + moff) = image + trampoline_start + cfi_get_offset(); 851 852 /* put prog_id to udata */ 853 *(unsigned long *)(udata + moff) = prog->aux->id; 854 855 /* init ksym for this trampoline */ 856 bpf_struct_ops_ksym_init(tname, mname, 857 image + trampoline_start, 858 image_off - trampoline_start, 859 ksym); 860 } 861 862 if (st_ops->validate) { 863 err = st_ops->validate(kdata); 864 if (err) 865 goto reset_unlock; 866 } 867 for (i = 0; i < st_map->image_pages_cnt; i++) { 868 err = arch_protect_bpf_trampoline(st_map->image_pages[i], 869 PAGE_SIZE); 870 if (err) 871 goto reset_unlock; 872 } 873 874 if (st_map->map.map_flags & BPF_F_LINK) { 875 err = 0; 876 /* Let bpf_link handle registration & unregistration. 877 * 878 * Pair with smp_load_acquire() during lookup_elem(). 879 */ 880 smp_store_release(&kvalue->common.state, BPF_STRUCT_OPS_STATE_READY); 881 goto unlock; 882 } 883 884 err = st_ops->reg(kdata, NULL); 885 if (likely(!err)) { 886 /* This refcnt increment on the map here after 887 * 'st_ops->reg()' is secure since the state of the 888 * map must be set to INIT at this moment, and thus 889 * bpf_struct_ops_map_delete_elem() can't unregister 890 * or transition it to TOBEFREE concurrently. 891 */ 892 bpf_map_inc(map); 893 /* Pair with smp_load_acquire() during lookup_elem(). 894 * It ensures the above udata updates (e.g. prog->aux->id) 895 * can be seen once BPF_STRUCT_OPS_STATE_INUSE is set. 896 */ 897 smp_store_release(&kvalue->common.state, BPF_STRUCT_OPS_STATE_INUSE); 898 goto unlock; 899 } 900 901 /* Error during st_ops->reg(). Can happen if this struct_ops needs to be 902 * verified as a whole, after all init_member() calls. Can also happen if 903 * there was a race in registering the struct_ops (under the same name) to 904 * a sub-system through different struct_ops's maps. 905 */ 906 907 reset_unlock: 908 bpf_struct_ops_map_free_ksyms(st_map); 909 bpf_struct_ops_map_free_image(st_map); 910 bpf_struct_ops_map_dissoc_progs(st_map); 911 bpf_struct_ops_map_put_progs(st_map); 912 memset(uvalue, 0, map->value_size); 913 memset(kvalue, 0, map->value_size); 914 unlock: 915 kfree(tnodes); 916 mutex_unlock(&st_map->lock); 917 if (!err) 918 bpf_struct_ops_map_add_ksyms(st_map); 919 return err; 920 } 921 922 static long bpf_struct_ops_map_delete_elem(struct bpf_map *map, void *key) 923 { 924 enum bpf_struct_ops_state prev_state; 925 struct bpf_struct_ops_map *st_map; 926 927 st_map = (struct bpf_struct_ops_map *)map; 928 if (st_map->map.map_flags & BPF_F_LINK) 929 return -EOPNOTSUPP; 930 931 prev_state = cmpxchg(&st_map->kvalue.common.state, 932 BPF_STRUCT_OPS_STATE_INUSE, 933 BPF_STRUCT_OPS_STATE_TOBEFREE); 934 switch (prev_state) { 935 case BPF_STRUCT_OPS_STATE_INUSE: 936 st_map->st_ops_desc->st_ops->unreg(&st_map->kvalue.data, NULL); 937 bpf_map_put(map); 938 return 0; 939 case BPF_STRUCT_OPS_STATE_TOBEFREE: 940 return -EINPROGRESS; 941 case BPF_STRUCT_OPS_STATE_INIT: 942 return -ENOENT; 943 default: 944 WARN_ON_ONCE(1); 945 /* Should never happen. Treat it as not found. */ 946 return -ENOENT; 947 } 948 } 949 950 static void bpf_struct_ops_map_seq_show_elem(struct bpf_map *map, void *key, 951 struct seq_file *m) 952 { 953 struct bpf_struct_ops_map *st_map = (struct bpf_struct_ops_map *)map; 954 void *value; 955 int err; 956 957 value = kmalloc(map->value_size, GFP_USER | __GFP_NOWARN); 958 if (!value) 959 return; 960 961 err = bpf_struct_ops_map_sys_lookup_elem(map, key, value); 962 if (!err) { 963 btf_type_seq_show(st_map->btf, 964 map->btf_vmlinux_value_type_id, 965 value, m); 966 seq_putc(m, '\n'); 967 } 968 969 kfree(value); 970 } 971 972 static void __bpf_struct_ops_map_free(struct bpf_map *map) 973 { 974 struct bpf_struct_ops_map *st_map = (struct bpf_struct_ops_map *)map; 975 976 if (st_map->links) 977 bpf_struct_ops_map_put_progs(st_map); 978 if (st_map->ksyms) 979 bpf_struct_ops_map_free_ksyms(st_map); 980 bpf_map_area_free(st_map->links); 981 bpf_map_area_free(st_map->ksyms); 982 bpf_struct_ops_map_free_image(st_map); 983 bpf_map_area_free(st_map->uvalue); 984 bpf_map_area_free(st_map); 985 } 986 987 static void bpf_struct_ops_map_free(struct bpf_map *map) 988 { 989 struct bpf_struct_ops_map *st_map = (struct bpf_struct_ops_map *)map; 990 991 /* st_ops->owner was acquired during map_alloc to implicitly holds 992 * the btf's refcnt. The acquire was only done when btf_is_module() 993 * st_map->btf cannot be NULL here. 994 */ 995 if (btf_is_module(st_map->btf)) 996 module_put(st_map->st_ops_desc->st_ops->owner); 997 998 bpf_struct_ops_map_dissoc_progs(st_map); 999 1000 bpf_struct_ops_map_del_ksyms(st_map); 1001 1002 /* The struct_ops's function may switch to another struct_ops. 1003 * 1004 * For example, bpf_tcp_cc_x->init() may switch to 1005 * another tcp_cc_y by calling 1006 * setsockopt(TCP_CONGESTION, "tcp_cc_y"). 1007 * During the switch, bpf_struct_ops_put(tcp_cc_x) is called 1008 * and its refcount may reach 0 which then free its 1009 * trampoline image while tcp_cc_x is still running. 1010 * 1011 * A vanilla rcu gp is to wait for all bpf-tcp-cc prog 1012 * to finish. bpf-tcp-cc prog is non sleepable. 1013 * A rcu_tasks gp is to wait for the last few insn 1014 * in the tramopline image to finish before releasing 1015 * the trampoline image. 1016 */ 1017 synchronize_rcu_mult(call_rcu, call_rcu_tasks); 1018 1019 __bpf_struct_ops_map_free(map); 1020 } 1021 1022 static int bpf_struct_ops_map_alloc_check(union bpf_attr *attr) 1023 { 1024 if (attr->key_size != sizeof(unsigned int) || attr->max_entries != 1 || 1025 (attr->map_flags & ~(BPF_F_LINK | BPF_F_VTYPE_BTF_OBJ_FD)) || 1026 !attr->btf_vmlinux_value_type_id) 1027 return -EINVAL; 1028 return 0; 1029 } 1030 1031 static u32 count_func_ptrs(const struct btf *btf, const struct btf_type *t) 1032 { 1033 int i; 1034 u32 count; 1035 const struct btf_member *member; 1036 1037 count = 0; 1038 for_each_member(i, t, member) 1039 if (btf_type_resolve_func_ptr(btf, member->type, NULL)) 1040 count++; 1041 return count; 1042 } 1043 1044 static struct bpf_map *bpf_struct_ops_map_alloc(union bpf_attr *attr) 1045 { 1046 const struct bpf_struct_ops_desc *st_ops_desc; 1047 size_t st_map_size; 1048 struct bpf_struct_ops_map *st_map; 1049 const struct btf_type *t, *vt; 1050 struct module *mod = NULL; 1051 struct bpf_map *map; 1052 struct btf *btf; 1053 int ret; 1054 1055 if (attr->map_flags & BPF_F_VTYPE_BTF_OBJ_FD) { 1056 /* The map holds btf for its whole life time. */ 1057 btf = btf_get_by_fd(attr->value_type_btf_obj_fd); 1058 if (IS_ERR(btf)) 1059 return ERR_CAST(btf); 1060 if (!btf_is_module(btf)) { 1061 btf_put(btf); 1062 return ERR_PTR(-EINVAL); 1063 } 1064 1065 mod = btf_try_get_module(btf); 1066 /* mod holds a refcnt to btf. We don't need an extra refcnt 1067 * here. 1068 */ 1069 btf_put(btf); 1070 if (!mod) 1071 return ERR_PTR(-EINVAL); 1072 } else { 1073 btf = bpf_get_btf_vmlinux(); 1074 if (IS_ERR(btf)) 1075 return ERR_CAST(btf); 1076 if (!btf) 1077 return ERR_PTR(-ENOTSUPP); 1078 } 1079 1080 st_ops_desc = bpf_struct_ops_find_value(btf, attr->btf_vmlinux_value_type_id); 1081 if (!st_ops_desc) { 1082 ret = -ENOTSUPP; 1083 goto errout; 1084 } 1085 1086 vt = st_ops_desc->value_type; 1087 if (attr->value_size != vt->size) { 1088 ret = -EINVAL; 1089 goto errout; 1090 } 1091 1092 t = st_ops_desc->type; 1093 1094 st_map_size = sizeof(*st_map) + 1095 /* kvalue stores the 1096 * struct bpf_struct_ops_tcp_congestions_ops 1097 */ 1098 (vt->size - sizeof(struct bpf_struct_ops_value)); 1099 1100 st_map = bpf_map_area_alloc(st_map_size, NUMA_NO_NODE); 1101 if (!st_map) { 1102 ret = -ENOMEM; 1103 goto errout; 1104 } 1105 1106 st_map->st_ops_desc = st_ops_desc; 1107 map = &st_map->map; 1108 1109 st_map->uvalue = bpf_map_area_alloc(vt->size, NUMA_NO_NODE); 1110 st_map->funcs_cnt = count_func_ptrs(btf, t); 1111 st_map->links = 1112 bpf_map_area_alloc(st_map->funcs_cnt * sizeof(struct bpf_link *), 1113 NUMA_NO_NODE); 1114 1115 st_map->ksyms = 1116 bpf_map_area_alloc(st_map->funcs_cnt * sizeof(struct bpf_ksym *), 1117 NUMA_NO_NODE); 1118 if (!st_map->uvalue || !st_map->links || !st_map->ksyms) { 1119 ret = -ENOMEM; 1120 goto errout_free; 1121 } 1122 st_map->btf = btf; 1123 1124 mutex_init(&st_map->lock); 1125 bpf_map_init_from_attr(map, attr); 1126 1127 return map; 1128 1129 errout_free: 1130 __bpf_struct_ops_map_free(map); 1131 errout: 1132 module_put(mod); 1133 1134 return ERR_PTR(ret); 1135 } 1136 1137 static u64 bpf_struct_ops_map_mem_usage(const struct bpf_map *map) 1138 { 1139 struct bpf_struct_ops_map *st_map = (struct bpf_struct_ops_map *)map; 1140 const struct bpf_struct_ops_desc *st_ops_desc = st_map->st_ops_desc; 1141 const struct btf_type *vt = st_ops_desc->value_type; 1142 u64 usage; 1143 1144 usage = sizeof(*st_map) + 1145 vt->size - sizeof(struct bpf_struct_ops_value); 1146 usage += vt->size; 1147 usage += st_map->funcs_cnt * sizeof(struct bpf_link *); 1148 usage += st_map->funcs_cnt * sizeof(struct bpf_ksym *); 1149 usage += PAGE_SIZE; 1150 return usage; 1151 } 1152 1153 BTF_ID_LIST_SINGLE(bpf_struct_ops_map_btf_ids, struct, bpf_struct_ops_map) 1154 const struct bpf_map_ops bpf_struct_ops_map_ops = { 1155 .map_alloc_check = bpf_struct_ops_map_alloc_check, 1156 .map_alloc = bpf_struct_ops_map_alloc, 1157 .map_free = bpf_struct_ops_map_free, 1158 .map_get_next_key = bpf_struct_ops_map_get_next_key, 1159 .map_lookup_elem = bpf_struct_ops_map_lookup_elem, 1160 .map_delete_elem = bpf_struct_ops_map_delete_elem, 1161 .map_update_elem = bpf_struct_ops_map_update_elem, 1162 .map_seq_show_elem = bpf_struct_ops_map_seq_show_elem, 1163 .map_mem_usage = bpf_struct_ops_map_mem_usage, 1164 .map_btf_id = &bpf_struct_ops_map_btf_ids[0], 1165 }; 1166 1167 /* "const void *" because some subsystem is 1168 * passing a const (e.g. const struct tcp_congestion_ops *) 1169 */ 1170 bool bpf_struct_ops_get(const void *kdata) 1171 { 1172 struct bpf_struct_ops_value *kvalue; 1173 struct bpf_struct_ops_map *st_map; 1174 struct bpf_map *map; 1175 1176 kvalue = container_of(kdata, struct bpf_struct_ops_value, data); 1177 st_map = container_of(kvalue, struct bpf_struct_ops_map, kvalue); 1178 1179 map = __bpf_map_inc_not_zero(&st_map->map, false); 1180 return !IS_ERR(map); 1181 } 1182 EXPORT_SYMBOL_GPL(bpf_struct_ops_get); 1183 1184 void bpf_struct_ops_put(const void *kdata) 1185 { 1186 struct bpf_struct_ops_value *kvalue; 1187 struct bpf_struct_ops_map *st_map; 1188 1189 kvalue = container_of(kdata, struct bpf_struct_ops_value, data); 1190 st_map = container_of(kvalue, struct bpf_struct_ops_map, kvalue); 1191 1192 bpf_map_put(&st_map->map); 1193 } 1194 EXPORT_SYMBOL_GPL(bpf_struct_ops_put); 1195 1196 u32 bpf_struct_ops_id(const void *kdata) 1197 { 1198 struct bpf_struct_ops_value *kvalue; 1199 struct bpf_struct_ops_map *st_map; 1200 1201 kvalue = container_of(kdata, struct bpf_struct_ops_value, data); 1202 st_map = container_of(kvalue, struct bpf_struct_ops_map, kvalue); 1203 1204 return st_map->map.id; 1205 } 1206 EXPORT_SYMBOL_GPL(bpf_struct_ops_id); 1207 1208 /** 1209 * bpf_struct_ops_for_each_prog - Invoke @cb for each member prog 1210 * @kdata: kernel-side struct_ops vmtable (the @kdata arg to ->reg/->update/->unreg) 1211 * @cb: callback invoked once per member prog; non-zero return stops iteration 1212 * @data: opaque argument passed to @cb 1213 * 1214 * Walks the struct_ops member progs registered on the map containing @kdata. 1215 * Intended for use from struct_ops ->reg() callbacks (and similar) that need to 1216 * inspect the loaded BPF programs (for example to discover maps they reference 1217 * via @prog->aux->used_maps). 1218 * 1219 * Return 0 if iteration completed, otherwise the first non-zero @cb return. 1220 */ 1221 int bpf_struct_ops_for_each_prog(const void *kdata, 1222 int (*cb)(struct bpf_prog *prog, void *data), 1223 void *data) 1224 { 1225 struct bpf_struct_ops_value *kvalue; 1226 struct bpf_struct_ops_map *st_map; 1227 u32 i; 1228 int ret; 1229 1230 kvalue = container_of(kdata, struct bpf_struct_ops_value, data); 1231 st_map = container_of(kvalue, struct bpf_struct_ops_map, kvalue); 1232 1233 for (i = 0; i < st_map->funcs_cnt; i++) { 1234 if (!st_map->links[i]) 1235 continue; 1236 ret = cb(st_map->links[i]->prog, data); 1237 if (ret) 1238 return ret; 1239 } 1240 return 0; 1241 } 1242 EXPORT_SYMBOL_GPL(bpf_struct_ops_for_each_prog); 1243 1244 static bool bpf_struct_ops_valid_to_reg(struct bpf_map *map) 1245 { 1246 struct bpf_struct_ops_map *st_map = (struct bpf_struct_ops_map *)map; 1247 1248 return map->map_type == BPF_MAP_TYPE_STRUCT_OPS && 1249 map->map_flags & BPF_F_LINK && 1250 /* Pair with smp_store_release() during map_update */ 1251 smp_load_acquire(&st_map->kvalue.common.state) == BPF_STRUCT_OPS_STATE_READY; 1252 } 1253 1254 static void bpf_struct_ops_map_link_dealloc(struct bpf_link *link) 1255 { 1256 struct bpf_struct_ops_link *st_link; 1257 struct bpf_struct_ops_map *st_map; 1258 1259 st_link = container_of(link, struct bpf_struct_ops_link, link); 1260 st_map = (struct bpf_struct_ops_map *) 1261 rcu_dereference_protected(st_link->map, true); 1262 if (st_map) { 1263 st_map->st_ops_desc->st_ops->unreg(&st_map->kvalue.data, link); 1264 bpf_map_put(&st_map->map); 1265 } 1266 kfree(st_link); 1267 } 1268 1269 static void bpf_struct_ops_map_link_show_fdinfo(const struct bpf_link *link, 1270 struct seq_file *seq) 1271 { 1272 struct bpf_struct_ops_link *st_link; 1273 struct bpf_map *map; 1274 1275 st_link = container_of(link, struct bpf_struct_ops_link, link); 1276 rcu_read_lock(); 1277 map = rcu_dereference(st_link->map); 1278 if (map) 1279 seq_printf(seq, "map_id:\t%d\n", map->id); 1280 rcu_read_unlock(); 1281 } 1282 1283 static int bpf_struct_ops_map_link_fill_link_info(const struct bpf_link *link, 1284 struct bpf_link_info *info) 1285 { 1286 struct bpf_struct_ops_link *st_link; 1287 struct bpf_map *map; 1288 1289 st_link = container_of(link, struct bpf_struct_ops_link, link); 1290 rcu_read_lock(); 1291 map = rcu_dereference(st_link->map); 1292 if (map) 1293 info->struct_ops.map_id = map->id; 1294 rcu_read_unlock(); 1295 return 0; 1296 } 1297 1298 static int bpf_struct_ops_map_link_update(struct bpf_link *link, struct bpf_map *new_map, 1299 struct bpf_map *expected_old_map) 1300 { 1301 struct bpf_struct_ops_map *st_map, *old_st_map; 1302 struct bpf_map *old_map; 1303 struct bpf_struct_ops_link *st_link; 1304 int err; 1305 1306 st_link = container_of(link, struct bpf_struct_ops_link, link); 1307 st_map = container_of(new_map, struct bpf_struct_ops_map, map); 1308 1309 if (!bpf_struct_ops_valid_to_reg(new_map)) 1310 return -EINVAL; 1311 1312 if (!st_map->st_ops_desc->st_ops->update) 1313 return -EOPNOTSUPP; 1314 1315 mutex_lock(&update_mutex); 1316 1317 old_map = rcu_dereference_protected(st_link->map, lockdep_is_held(&update_mutex)); 1318 if (!old_map) { 1319 err = -ENOLINK; 1320 goto err_out; 1321 } 1322 if (expected_old_map && old_map != expected_old_map) { 1323 err = -EPERM; 1324 goto err_out; 1325 } 1326 1327 old_st_map = container_of(old_map, struct bpf_struct_ops_map, map); 1328 /* The new and old struct_ops must be the same type. */ 1329 if (st_map->st_ops_desc != old_st_map->st_ops_desc) { 1330 err = -EINVAL; 1331 goto err_out; 1332 } 1333 1334 err = st_map->st_ops_desc->st_ops->update(st_map->kvalue.data, old_st_map->kvalue.data, link); 1335 if (err) 1336 goto err_out; 1337 1338 bpf_map_inc(new_map); 1339 rcu_assign_pointer(st_link->map, new_map); 1340 bpf_map_put(old_map); 1341 1342 err_out: 1343 mutex_unlock(&update_mutex); 1344 1345 return err; 1346 } 1347 1348 static int bpf_struct_ops_map_link_detach(struct bpf_link *link) 1349 { 1350 struct bpf_struct_ops_link *st_link = container_of(link, struct bpf_struct_ops_link, link); 1351 struct bpf_struct_ops_map *st_map; 1352 struct bpf_map *map; 1353 1354 mutex_lock(&update_mutex); 1355 1356 map = rcu_dereference_protected(st_link->map, lockdep_is_held(&update_mutex)); 1357 if (!map) { 1358 mutex_unlock(&update_mutex); 1359 return 0; 1360 } 1361 st_map = container_of(map, struct bpf_struct_ops_map, map); 1362 1363 st_map->st_ops_desc->st_ops->unreg(&st_map->kvalue.data, link); 1364 1365 RCU_INIT_POINTER(st_link->map, NULL); 1366 /* Pair with bpf_map_get() in bpf_struct_ops_link_create() or 1367 * bpf_map_inc() in bpf_struct_ops_map_link_update(). 1368 */ 1369 bpf_map_put(&st_map->map); 1370 1371 mutex_unlock(&update_mutex); 1372 1373 wake_up_interruptible_poll(&st_link->wait_hup, EPOLLHUP); 1374 1375 return 0; 1376 } 1377 1378 static __poll_t bpf_struct_ops_map_link_poll(struct file *file, 1379 struct poll_table_struct *pts) 1380 { 1381 struct bpf_struct_ops_link *st_link = file->private_data; 1382 1383 poll_wait(file, &st_link->wait_hup, pts); 1384 1385 return rcu_access_pointer(st_link->map) ? 0 : EPOLLHUP; 1386 } 1387 1388 static const struct bpf_link_ops bpf_struct_ops_map_lops = { 1389 .dealloc = bpf_struct_ops_map_link_dealloc, 1390 .detach = bpf_struct_ops_map_link_detach, 1391 .show_fdinfo = bpf_struct_ops_map_link_show_fdinfo, 1392 .fill_link_info = bpf_struct_ops_map_link_fill_link_info, 1393 .update_map = bpf_struct_ops_map_link_update, 1394 .poll = bpf_struct_ops_map_link_poll, 1395 }; 1396 1397 int bpf_struct_ops_link_create(union bpf_attr *attr) 1398 { 1399 struct bpf_struct_ops_link *link = NULL; 1400 struct bpf_link_primer link_primer; 1401 struct bpf_struct_ops_map *st_map; 1402 struct bpf_map *map; 1403 int err; 1404 1405 map = bpf_map_get(attr->link_create.map_fd); 1406 if (IS_ERR(map)) 1407 return PTR_ERR(map); 1408 1409 st_map = (struct bpf_struct_ops_map *)map; 1410 1411 if (!bpf_struct_ops_valid_to_reg(map)) { 1412 err = -EINVAL; 1413 goto err_out; 1414 } 1415 1416 link = kzalloc_obj(*link, GFP_USER); 1417 if (!link) { 1418 err = -ENOMEM; 1419 goto err_out; 1420 } 1421 bpf_link_init(&link->link, BPF_LINK_TYPE_STRUCT_OPS, &bpf_struct_ops_map_lops, NULL, 1422 attr->link_create.attach_type); 1423 1424 err = bpf_link_prime(&link->link, &link_primer); 1425 if (err) 1426 goto err_out; 1427 1428 init_waitqueue_head(&link->wait_hup); 1429 1430 /* Hold the update_mutex such that the subsystem cannot 1431 * do link->ops->detach() before the link is fully initialized. 1432 */ 1433 mutex_lock(&update_mutex); 1434 err = st_map->st_ops_desc->st_ops->reg(st_map->kvalue.data, &link->link); 1435 if (err) { 1436 mutex_unlock(&update_mutex); 1437 bpf_link_cleanup(&link_primer); 1438 link = NULL; 1439 goto err_out; 1440 } 1441 RCU_INIT_POINTER(link->map, map); 1442 mutex_unlock(&update_mutex); 1443 1444 return bpf_link_settle(&link_primer); 1445 1446 err_out: 1447 bpf_map_put(map); 1448 kfree(link); 1449 return err; 1450 } 1451 1452 int bpf_prog_assoc_struct_ops(struct bpf_prog *prog, struct bpf_map *map) 1453 { 1454 struct bpf_map *st_ops_assoc; 1455 1456 guard(mutex)(&prog->aux->st_ops_assoc_mutex); 1457 1458 st_ops_assoc = rcu_dereference_protected(prog->aux->st_ops_assoc, 1459 lockdep_is_held(&prog->aux->st_ops_assoc_mutex)); 1460 if (st_ops_assoc && st_ops_assoc == map) 1461 return 0; 1462 1463 if (st_ops_assoc) { 1464 if (prog->type != BPF_PROG_TYPE_STRUCT_OPS) 1465 return -EBUSY; 1466 1467 rcu_assign_pointer(prog->aux->st_ops_assoc, BPF_PTR_POISON); 1468 } else { 1469 /* 1470 * struct_ops map does not track associated non-struct_ops programs. 1471 * Bump the refcount to make sure st_ops_assoc is always valid. 1472 */ 1473 if (prog->type != BPF_PROG_TYPE_STRUCT_OPS) 1474 bpf_map_inc(map); 1475 1476 rcu_assign_pointer(prog->aux->st_ops_assoc, map); 1477 } 1478 1479 return 0; 1480 } 1481 1482 void bpf_prog_disassoc_struct_ops(struct bpf_prog *prog) 1483 { 1484 struct bpf_map *st_ops_assoc; 1485 1486 guard(mutex)(&prog->aux->st_ops_assoc_mutex); 1487 1488 st_ops_assoc = rcu_dereference_protected(prog->aux->st_ops_assoc, 1489 lockdep_is_held(&prog->aux->st_ops_assoc_mutex)); 1490 if (!st_ops_assoc || st_ops_assoc == BPF_PTR_POISON) 1491 return; 1492 1493 if (prog->type != BPF_PROG_TYPE_STRUCT_OPS) 1494 bpf_map_put(st_ops_assoc); 1495 1496 RCU_INIT_POINTER(prog->aux->st_ops_assoc, NULL); 1497 } 1498 1499 /* 1500 * Get a reference to the struct_ops struct (i.e., kdata) associated with a 1501 * program. Should only be called in BPF program context (e.g., in a kfunc). 1502 * 1503 * If the returned pointer is not NULL, it must points to a valid struct_ops. 1504 * The struct_ops map is not guaranteed to be initialized nor attached. 1505 * Kernel struct_ops implementers are responsible for tracking and checking 1506 * the state of the struct_ops if the use case requires an initialized or 1507 * attached struct_ops. 1508 */ 1509 void *bpf_prog_get_assoc_struct_ops(const struct bpf_prog_aux *aux) 1510 { 1511 struct bpf_struct_ops_map *st_map; 1512 struct bpf_map *st_ops_assoc; 1513 1514 st_ops_assoc = rcu_dereference_check(aux->st_ops_assoc, bpf_rcu_lock_held()); 1515 if (!st_ops_assoc || st_ops_assoc == BPF_PTR_POISON) 1516 return NULL; 1517 1518 st_map = (struct bpf_struct_ops_map *)st_ops_assoc; 1519 1520 return &st_map->kvalue.data; 1521 } 1522 EXPORT_SYMBOL_GPL(bpf_prog_get_assoc_struct_ops); 1523 1524 void bpf_map_struct_ops_info_fill(struct bpf_map_info *info, struct bpf_map *map) 1525 { 1526 struct bpf_struct_ops_map *st_map = (struct bpf_struct_ops_map *)map; 1527 1528 info->btf_vmlinux_id = btf_obj_id(st_map->btf); 1529 } 1530