1 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com 2 * 3 * This program is free software; you can redistribute it and/or 4 * modify it under the terms of version 2 of the GNU General Public 5 * License as published by the Free Software Foundation. 6 */ 7 #ifndef _LINUX_BPF_H 8 #define _LINUX_BPF_H 1 9 10 #include <uapi/linux/bpf.h> 11 12 #include <linux/workqueue.h> 13 #include <linux/file.h> 14 #include <linux/percpu.h> 15 #include <linux/err.h> 16 #include <linux/rbtree_latch.h> 17 #include <linux/numa.h> 18 #include <linux/wait.h> 19 #include <linux/u64_stats_sync.h> 20 21 struct bpf_verifier_env; 22 struct perf_event; 23 struct bpf_prog; 24 struct bpf_map; 25 struct sock; 26 struct seq_file; 27 struct btf; 28 struct btf_type; 29 30 /* map is generic key/value storage optionally accesible by eBPF programs */ 31 struct bpf_map_ops { 32 /* funcs callable from userspace (via syscall) */ 33 int (*map_alloc_check)(union bpf_attr *attr); 34 struct bpf_map *(*map_alloc)(union bpf_attr *attr); 35 void (*map_release)(struct bpf_map *map, struct file *map_file); 36 void (*map_free)(struct bpf_map *map); 37 int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key); 38 void (*map_release_uref)(struct bpf_map *map); 39 40 /* funcs callable from userspace and from eBPF programs */ 41 void *(*map_lookup_elem)(struct bpf_map *map, void *key); 42 int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags); 43 int (*map_delete_elem)(struct bpf_map *map, void *key); 44 int (*map_push_elem)(struct bpf_map *map, void *value, u64 flags); 45 int (*map_pop_elem)(struct bpf_map *map, void *value); 46 int (*map_peek_elem)(struct bpf_map *map, void *value); 47 48 /* funcs called by prog_array and perf_event_array map */ 49 void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file, 50 int fd); 51 void (*map_fd_put_ptr)(void *ptr); 52 u32 (*map_gen_lookup)(struct bpf_map *map, struct bpf_insn *insn_buf); 53 u32 (*map_fd_sys_lookup_elem)(void *ptr); 54 void (*map_seq_show_elem)(struct bpf_map *map, void *key, 55 struct seq_file *m); 56 int (*map_check_btf)(const struct bpf_map *map, 57 const struct btf *btf, 58 const struct btf_type *key_type, 59 const struct btf_type *value_type); 60 61 /* Direct value access helpers. */ 62 int (*map_direct_value_addr)(const struct bpf_map *map, 63 u64 *imm, u32 off); 64 int (*map_direct_value_meta)(const struct bpf_map *map, 65 u64 imm, u32 *off); 66 }; 67 68 struct bpf_map { 69 /* The first two cachelines with read-mostly members of which some 70 * are also accessed in fast-path (e.g. ops, max_entries). 71 */ 72 const struct bpf_map_ops *ops ____cacheline_aligned; 73 struct bpf_map *inner_map_meta; 74 #ifdef CONFIG_SECURITY 75 void *security; 76 #endif 77 enum bpf_map_type map_type; 78 u32 key_size; 79 u32 value_size; 80 u32 max_entries; 81 u32 map_flags; 82 int spin_lock_off; /* >=0 valid offset, <0 error */ 83 u32 id; 84 int numa_node; 85 u32 btf_key_type_id; 86 u32 btf_value_type_id; 87 struct btf *btf; 88 u32 pages; 89 bool unpriv_array; 90 bool frozen; /* write-once */ 91 /* 48 bytes hole */ 92 93 /* The 3rd and 4th cacheline with misc members to avoid false sharing 94 * particularly with refcounting. 95 */ 96 struct user_struct *user ____cacheline_aligned; 97 atomic_t refcnt; 98 atomic_t usercnt; 99 struct work_struct work; 100 char name[BPF_OBJ_NAME_LEN]; 101 }; 102 103 static inline bool map_value_has_spin_lock(const struct bpf_map *map) 104 { 105 return map->spin_lock_off >= 0; 106 } 107 108 static inline void check_and_init_map_lock(struct bpf_map *map, void *dst) 109 { 110 if (likely(!map_value_has_spin_lock(map))) 111 return; 112 *(struct bpf_spin_lock *)(dst + map->spin_lock_off) = 113 (struct bpf_spin_lock){}; 114 } 115 116 /* copy everything but bpf_spin_lock */ 117 static inline void copy_map_value(struct bpf_map *map, void *dst, void *src) 118 { 119 if (unlikely(map_value_has_spin_lock(map))) { 120 u32 off = map->spin_lock_off; 121 122 memcpy(dst, src, off); 123 memcpy(dst + off + sizeof(struct bpf_spin_lock), 124 src + off + sizeof(struct bpf_spin_lock), 125 map->value_size - off - sizeof(struct bpf_spin_lock)); 126 } else { 127 memcpy(dst, src, map->value_size); 128 } 129 } 130 void copy_map_value_locked(struct bpf_map *map, void *dst, void *src, 131 bool lock_src); 132 133 struct bpf_offload_dev; 134 struct bpf_offloaded_map; 135 136 struct bpf_map_dev_ops { 137 int (*map_get_next_key)(struct bpf_offloaded_map *map, 138 void *key, void *next_key); 139 int (*map_lookup_elem)(struct bpf_offloaded_map *map, 140 void *key, void *value); 141 int (*map_update_elem)(struct bpf_offloaded_map *map, 142 void *key, void *value, u64 flags); 143 int (*map_delete_elem)(struct bpf_offloaded_map *map, void *key); 144 }; 145 146 struct bpf_offloaded_map { 147 struct bpf_map map; 148 struct net_device *netdev; 149 const struct bpf_map_dev_ops *dev_ops; 150 void *dev_priv; 151 struct list_head offloads; 152 }; 153 154 static inline struct bpf_offloaded_map *map_to_offmap(struct bpf_map *map) 155 { 156 return container_of(map, struct bpf_offloaded_map, map); 157 } 158 159 static inline bool bpf_map_offload_neutral(const struct bpf_map *map) 160 { 161 return map->map_type == BPF_MAP_TYPE_PERF_EVENT_ARRAY; 162 } 163 164 static inline bool bpf_map_support_seq_show(const struct bpf_map *map) 165 { 166 return map->btf && map->ops->map_seq_show_elem; 167 } 168 169 int map_check_no_btf(const struct bpf_map *map, 170 const struct btf *btf, 171 const struct btf_type *key_type, 172 const struct btf_type *value_type); 173 174 extern const struct bpf_map_ops bpf_map_offload_ops; 175 176 /* function argument constraints */ 177 enum bpf_arg_type { 178 ARG_DONTCARE = 0, /* unused argument in helper function */ 179 180 /* the following constraints used to prototype 181 * bpf_map_lookup/update/delete_elem() functions 182 */ 183 ARG_CONST_MAP_PTR, /* const argument used as pointer to bpf_map */ 184 ARG_PTR_TO_MAP_KEY, /* pointer to stack used as map key */ 185 ARG_PTR_TO_MAP_VALUE, /* pointer to stack used as map value */ 186 ARG_PTR_TO_UNINIT_MAP_VALUE, /* pointer to valid memory used to store a map value */ 187 188 /* the following constraints used to prototype bpf_memcmp() and other 189 * functions that access data on eBPF program stack 190 */ 191 ARG_PTR_TO_MEM, /* pointer to valid memory (stack, packet, map value) */ 192 ARG_PTR_TO_MEM_OR_NULL, /* pointer to valid memory or NULL */ 193 ARG_PTR_TO_UNINIT_MEM, /* pointer to memory does not need to be initialized, 194 * helper function must fill all bytes or clear 195 * them in error case. 196 */ 197 198 ARG_CONST_SIZE, /* number of bytes accessed from memory */ 199 ARG_CONST_SIZE_OR_ZERO, /* number of bytes accessed from memory or 0 */ 200 201 ARG_PTR_TO_CTX, /* pointer to context */ 202 ARG_ANYTHING, /* any (initialized) argument is ok */ 203 ARG_PTR_TO_SPIN_LOCK, /* pointer to bpf_spin_lock */ 204 ARG_PTR_TO_SOCK_COMMON, /* pointer to sock_common */ 205 }; 206 207 /* type of values returned from helper functions */ 208 enum bpf_return_type { 209 RET_INTEGER, /* function returns integer */ 210 RET_VOID, /* function doesn't return anything */ 211 RET_PTR_TO_MAP_VALUE, /* returns a pointer to map elem value */ 212 RET_PTR_TO_MAP_VALUE_OR_NULL, /* returns a pointer to map elem value or NULL */ 213 RET_PTR_TO_SOCKET_OR_NULL, /* returns a pointer to a socket or NULL */ 214 RET_PTR_TO_TCP_SOCK_OR_NULL, /* returns a pointer to a tcp_sock or NULL */ 215 RET_PTR_TO_SOCK_COMMON_OR_NULL, /* returns a pointer to a sock_common or NULL */ 216 }; 217 218 /* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs 219 * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL 220 * instructions after verifying 221 */ 222 struct bpf_func_proto { 223 u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5); 224 bool gpl_only; 225 bool pkt_access; 226 enum bpf_return_type ret_type; 227 enum bpf_arg_type arg1_type; 228 enum bpf_arg_type arg2_type; 229 enum bpf_arg_type arg3_type; 230 enum bpf_arg_type arg4_type; 231 enum bpf_arg_type arg5_type; 232 }; 233 234 /* bpf_context is intentionally undefined structure. Pointer to bpf_context is 235 * the first argument to eBPF programs. 236 * For socket filters: 'struct bpf_context *' == 'struct sk_buff *' 237 */ 238 struct bpf_context; 239 240 enum bpf_access_type { 241 BPF_READ = 1, 242 BPF_WRITE = 2 243 }; 244 245 /* types of values stored in eBPF registers */ 246 /* Pointer types represent: 247 * pointer 248 * pointer + imm 249 * pointer + (u16) var 250 * pointer + (u16) var + imm 251 * if (range > 0) then [ptr, ptr + range - off) is safe to access 252 * if (id > 0) means that some 'var' was added 253 * if (off > 0) means that 'imm' was added 254 */ 255 enum bpf_reg_type { 256 NOT_INIT = 0, /* nothing was written into register */ 257 SCALAR_VALUE, /* reg doesn't contain a valid pointer */ 258 PTR_TO_CTX, /* reg points to bpf_context */ 259 CONST_PTR_TO_MAP, /* reg points to struct bpf_map */ 260 PTR_TO_MAP_VALUE, /* reg points to map element value */ 261 PTR_TO_MAP_VALUE_OR_NULL,/* points to map elem value or NULL */ 262 PTR_TO_STACK, /* reg == frame_pointer + offset */ 263 PTR_TO_PACKET_META, /* skb->data - meta_len */ 264 PTR_TO_PACKET, /* reg points to skb->data */ 265 PTR_TO_PACKET_END, /* skb->data + headlen */ 266 PTR_TO_FLOW_KEYS, /* reg points to bpf_flow_keys */ 267 PTR_TO_SOCKET, /* reg points to struct bpf_sock */ 268 PTR_TO_SOCKET_OR_NULL, /* reg points to struct bpf_sock or NULL */ 269 PTR_TO_SOCK_COMMON, /* reg points to sock_common */ 270 PTR_TO_SOCK_COMMON_OR_NULL, /* reg points to sock_common or NULL */ 271 PTR_TO_TCP_SOCK, /* reg points to struct tcp_sock */ 272 PTR_TO_TCP_SOCK_OR_NULL, /* reg points to struct tcp_sock or NULL */ 273 }; 274 275 /* The information passed from prog-specific *_is_valid_access 276 * back to the verifier. 277 */ 278 struct bpf_insn_access_aux { 279 enum bpf_reg_type reg_type; 280 int ctx_field_size; 281 }; 282 283 static inline void 284 bpf_ctx_record_field_size(struct bpf_insn_access_aux *aux, u32 size) 285 { 286 aux->ctx_field_size = size; 287 } 288 289 struct bpf_prog_ops { 290 int (*test_run)(struct bpf_prog *prog, const union bpf_attr *kattr, 291 union bpf_attr __user *uattr); 292 }; 293 294 struct bpf_verifier_ops { 295 /* return eBPF function prototype for verification */ 296 const struct bpf_func_proto * 297 (*get_func_proto)(enum bpf_func_id func_id, 298 const struct bpf_prog *prog); 299 300 /* return true if 'size' wide access at offset 'off' within bpf_context 301 * with 'type' (read or write) is allowed 302 */ 303 bool (*is_valid_access)(int off, int size, enum bpf_access_type type, 304 const struct bpf_prog *prog, 305 struct bpf_insn_access_aux *info); 306 int (*gen_prologue)(struct bpf_insn *insn, bool direct_write, 307 const struct bpf_prog *prog); 308 int (*gen_ld_abs)(const struct bpf_insn *orig, 309 struct bpf_insn *insn_buf); 310 u32 (*convert_ctx_access)(enum bpf_access_type type, 311 const struct bpf_insn *src, 312 struct bpf_insn *dst, 313 struct bpf_prog *prog, u32 *target_size); 314 }; 315 316 struct bpf_prog_offload_ops { 317 /* verifier basic callbacks */ 318 int (*insn_hook)(struct bpf_verifier_env *env, 319 int insn_idx, int prev_insn_idx); 320 int (*finalize)(struct bpf_verifier_env *env); 321 /* verifier optimization callbacks (called after .finalize) */ 322 int (*replace_insn)(struct bpf_verifier_env *env, u32 off, 323 struct bpf_insn *insn); 324 int (*remove_insns)(struct bpf_verifier_env *env, u32 off, u32 cnt); 325 /* program management callbacks */ 326 int (*prepare)(struct bpf_prog *prog); 327 int (*translate)(struct bpf_prog *prog); 328 void (*destroy)(struct bpf_prog *prog); 329 }; 330 331 struct bpf_prog_offload { 332 struct bpf_prog *prog; 333 struct net_device *netdev; 334 struct bpf_offload_dev *offdev; 335 void *dev_priv; 336 struct list_head offloads; 337 bool dev_state; 338 bool opt_failed; 339 void *jited_image; 340 u32 jited_len; 341 }; 342 343 enum bpf_cgroup_storage_type { 344 BPF_CGROUP_STORAGE_SHARED, 345 BPF_CGROUP_STORAGE_PERCPU, 346 __BPF_CGROUP_STORAGE_MAX 347 }; 348 349 #define MAX_BPF_CGROUP_STORAGE_TYPE __BPF_CGROUP_STORAGE_MAX 350 351 struct bpf_prog_stats { 352 u64 cnt; 353 u64 nsecs; 354 struct u64_stats_sync syncp; 355 }; 356 357 struct bpf_prog_aux { 358 atomic_t refcnt; 359 u32 used_map_cnt; 360 u32 max_ctx_offset; 361 u32 max_pkt_offset; 362 u32 stack_depth; 363 u32 id; 364 u32 func_cnt; /* used by non-func prog as the number of func progs */ 365 u32 func_idx; /* 0 for non-func prog, the index in func array for func prog */ 366 bool offload_requested; 367 struct bpf_prog **func; 368 void *jit_data; /* JIT specific data. arch dependent */ 369 struct latch_tree_node ksym_tnode; 370 struct list_head ksym_lnode; 371 const struct bpf_prog_ops *ops; 372 struct bpf_map **used_maps; 373 struct bpf_prog *prog; 374 struct user_struct *user; 375 u64 load_time; /* ns since boottime */ 376 struct bpf_map *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE]; 377 char name[BPF_OBJ_NAME_LEN]; 378 #ifdef CONFIG_SECURITY 379 void *security; 380 #endif 381 struct bpf_prog_offload *offload; 382 struct btf *btf; 383 struct bpf_func_info *func_info; 384 /* bpf_line_info loaded from userspace. linfo->insn_off 385 * has the xlated insn offset. 386 * Both the main and sub prog share the same linfo. 387 * The subprog can access its first linfo by 388 * using the linfo_idx. 389 */ 390 struct bpf_line_info *linfo; 391 /* jited_linfo is the jited addr of the linfo. It has a 392 * one to one mapping to linfo: 393 * jited_linfo[i] is the jited addr for the linfo[i]->insn_off. 394 * Both the main and sub prog share the same jited_linfo. 395 * The subprog can access its first jited_linfo by 396 * using the linfo_idx. 397 */ 398 void **jited_linfo; 399 u32 func_info_cnt; 400 u32 nr_linfo; 401 /* subprog can use linfo_idx to access its first linfo and 402 * jited_linfo. 403 * main prog always has linfo_idx == 0 404 */ 405 u32 linfo_idx; 406 struct bpf_prog_stats __percpu *stats; 407 union { 408 struct work_struct work; 409 struct rcu_head rcu; 410 }; 411 }; 412 413 struct bpf_array { 414 struct bpf_map map; 415 u32 elem_size; 416 u32 index_mask; 417 /* 'ownership' of prog_array is claimed by the first program that 418 * is going to use this map or by the first program which FD is stored 419 * in the map to make sure that all callers and callees have the same 420 * prog_type and JITed flag 421 */ 422 enum bpf_prog_type owner_prog_type; 423 bool owner_jited; 424 union { 425 char value[0] __aligned(8); 426 void *ptrs[0] __aligned(8); 427 void __percpu *pptrs[0] __aligned(8); 428 }; 429 }; 430 431 #define BPF_COMPLEXITY_LIMIT_INSNS 1000000 /* yes. 1M insns */ 432 #define MAX_TAIL_CALL_CNT 32 433 434 #define BPF_F_ACCESS_MASK (BPF_F_RDONLY | \ 435 BPF_F_RDONLY_PROG | \ 436 BPF_F_WRONLY | \ 437 BPF_F_WRONLY_PROG) 438 439 #define BPF_MAP_CAN_READ BIT(0) 440 #define BPF_MAP_CAN_WRITE BIT(1) 441 442 static inline u32 bpf_map_flags_to_cap(struct bpf_map *map) 443 { 444 u32 access_flags = map->map_flags & (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG); 445 446 /* Combination of BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG is 447 * not possible. 448 */ 449 if (access_flags & BPF_F_RDONLY_PROG) 450 return BPF_MAP_CAN_READ; 451 else if (access_flags & BPF_F_WRONLY_PROG) 452 return BPF_MAP_CAN_WRITE; 453 else 454 return BPF_MAP_CAN_READ | BPF_MAP_CAN_WRITE; 455 } 456 457 static inline bool bpf_map_flags_access_ok(u32 access_flags) 458 { 459 return (access_flags & (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG)) != 460 (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG); 461 } 462 463 struct bpf_event_entry { 464 struct perf_event *event; 465 struct file *perf_file; 466 struct file *map_file; 467 struct rcu_head rcu; 468 }; 469 470 bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp); 471 int bpf_prog_calc_tag(struct bpf_prog *fp); 472 473 const struct bpf_func_proto *bpf_get_trace_printk_proto(void); 474 475 typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src, 476 unsigned long off, unsigned long len); 477 typedef u32 (*bpf_convert_ctx_access_t)(enum bpf_access_type type, 478 const struct bpf_insn *src, 479 struct bpf_insn *dst, 480 struct bpf_prog *prog, 481 u32 *target_size); 482 483 u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size, 484 void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy); 485 486 /* an array of programs to be executed under rcu_lock. 487 * 488 * Typical usage: 489 * ret = BPF_PROG_RUN_ARRAY(&bpf_prog_array, ctx, BPF_PROG_RUN); 490 * 491 * the structure returned by bpf_prog_array_alloc() should be populated 492 * with program pointers and the last pointer must be NULL. 493 * The user has to keep refcnt on the program and make sure the program 494 * is removed from the array before bpf_prog_put(). 495 * The 'struct bpf_prog_array *' should only be replaced with xchg() 496 * since other cpus are walking the array of pointers in parallel. 497 */ 498 struct bpf_prog_array_item { 499 struct bpf_prog *prog; 500 struct bpf_cgroup_storage *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE]; 501 }; 502 503 struct bpf_prog_array { 504 struct rcu_head rcu; 505 struct bpf_prog_array_item items[0]; 506 }; 507 508 struct bpf_prog_array *bpf_prog_array_alloc(u32 prog_cnt, gfp_t flags); 509 void bpf_prog_array_free(struct bpf_prog_array __rcu *progs); 510 int bpf_prog_array_length(struct bpf_prog_array __rcu *progs); 511 int bpf_prog_array_copy_to_user(struct bpf_prog_array __rcu *progs, 512 __u32 __user *prog_ids, u32 cnt); 513 514 void bpf_prog_array_delete_safe(struct bpf_prog_array __rcu *progs, 515 struct bpf_prog *old_prog); 516 int bpf_prog_array_copy_info(struct bpf_prog_array __rcu *array, 517 u32 *prog_ids, u32 request_cnt, 518 u32 *prog_cnt); 519 int bpf_prog_array_copy(struct bpf_prog_array __rcu *old_array, 520 struct bpf_prog *exclude_prog, 521 struct bpf_prog *include_prog, 522 struct bpf_prog_array **new_array); 523 524 #define __BPF_PROG_RUN_ARRAY(array, ctx, func, check_non_null) \ 525 ({ \ 526 struct bpf_prog_array_item *_item; \ 527 struct bpf_prog *_prog; \ 528 struct bpf_prog_array *_array; \ 529 u32 _ret = 1; \ 530 preempt_disable(); \ 531 rcu_read_lock(); \ 532 _array = rcu_dereference(array); \ 533 if (unlikely(check_non_null && !_array))\ 534 goto _out; \ 535 _item = &_array->items[0]; \ 536 while ((_prog = READ_ONCE(_item->prog))) { \ 537 bpf_cgroup_storage_set(_item->cgroup_storage); \ 538 _ret &= func(_prog, ctx); \ 539 _item++; \ 540 } \ 541 _out: \ 542 rcu_read_unlock(); \ 543 preempt_enable_no_resched(); \ 544 _ret; \ 545 }) 546 547 #define BPF_PROG_RUN_ARRAY(array, ctx, func) \ 548 __BPF_PROG_RUN_ARRAY(array, ctx, func, false) 549 550 #define BPF_PROG_RUN_ARRAY_CHECK(array, ctx, func) \ 551 __BPF_PROG_RUN_ARRAY(array, ctx, func, true) 552 553 #ifdef CONFIG_BPF_SYSCALL 554 DECLARE_PER_CPU(int, bpf_prog_active); 555 556 extern const struct file_operations bpf_map_fops; 557 extern const struct file_operations bpf_prog_fops; 558 559 #define BPF_PROG_TYPE(_id, _name) \ 560 extern const struct bpf_prog_ops _name ## _prog_ops; \ 561 extern const struct bpf_verifier_ops _name ## _verifier_ops; 562 #define BPF_MAP_TYPE(_id, _ops) \ 563 extern const struct bpf_map_ops _ops; 564 #include <linux/bpf_types.h> 565 #undef BPF_PROG_TYPE 566 #undef BPF_MAP_TYPE 567 568 extern const struct bpf_prog_ops bpf_offload_prog_ops; 569 extern const struct bpf_verifier_ops tc_cls_act_analyzer_ops; 570 extern const struct bpf_verifier_ops xdp_analyzer_ops; 571 572 struct bpf_prog *bpf_prog_get(u32 ufd); 573 struct bpf_prog *bpf_prog_get_type_dev(u32 ufd, enum bpf_prog_type type, 574 bool attach_drv); 575 struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog, int i); 576 void bpf_prog_sub(struct bpf_prog *prog, int i); 577 struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog); 578 struct bpf_prog * __must_check bpf_prog_inc_not_zero(struct bpf_prog *prog); 579 void bpf_prog_put(struct bpf_prog *prog); 580 int __bpf_prog_charge(struct user_struct *user, u32 pages); 581 void __bpf_prog_uncharge(struct user_struct *user, u32 pages); 582 583 void bpf_prog_free_id(struct bpf_prog *prog, bool do_idr_lock); 584 void bpf_map_free_id(struct bpf_map *map, bool do_idr_lock); 585 586 struct bpf_map *bpf_map_get_with_uref(u32 ufd); 587 struct bpf_map *__bpf_map_get(struct fd f); 588 struct bpf_map * __must_check bpf_map_inc(struct bpf_map *map, bool uref); 589 void bpf_map_put_with_uref(struct bpf_map *map); 590 void bpf_map_put(struct bpf_map *map); 591 int bpf_map_precharge_memlock(u32 pages); 592 int bpf_map_charge_memlock(struct bpf_map *map, u32 pages); 593 void bpf_map_uncharge_memlock(struct bpf_map *map, u32 pages); 594 void *bpf_map_area_alloc(size_t size, int numa_node); 595 void bpf_map_area_free(void *base); 596 void bpf_map_init_from_attr(struct bpf_map *map, union bpf_attr *attr); 597 598 extern int sysctl_unprivileged_bpf_disabled; 599 extern int sysctl_bpf_stats_enabled; 600 601 int bpf_map_new_fd(struct bpf_map *map, int flags); 602 int bpf_prog_new_fd(struct bpf_prog *prog); 603 604 int bpf_obj_pin_user(u32 ufd, const char __user *pathname); 605 int bpf_obj_get_user(const char __user *pathname, int flags); 606 607 int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value); 608 int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value); 609 int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value, 610 u64 flags); 611 int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value, 612 u64 flags); 613 614 int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value); 615 616 int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file, 617 void *key, void *value, u64 map_flags); 618 int bpf_fd_array_map_lookup_elem(struct bpf_map *map, void *key, u32 *value); 619 int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file, 620 void *key, void *value, u64 map_flags); 621 int bpf_fd_htab_map_lookup_elem(struct bpf_map *map, void *key, u32 *value); 622 623 int bpf_get_file_flag(int flags); 624 int bpf_check_uarg_tail_zero(void __user *uaddr, size_t expected_size, 625 size_t actual_size); 626 627 /* memcpy that is used with 8-byte aligned pointers, power-of-8 size and 628 * forced to use 'long' read/writes to try to atomically copy long counters. 629 * Best-effort only. No barriers here, since it _will_ race with concurrent 630 * updates from BPF programs. Called from bpf syscall and mostly used with 631 * size 8 or 16 bytes, so ask compiler to inline it. 632 */ 633 static inline void bpf_long_memcpy(void *dst, const void *src, u32 size) 634 { 635 const long *lsrc = src; 636 long *ldst = dst; 637 638 size /= sizeof(long); 639 while (size--) 640 *ldst++ = *lsrc++; 641 } 642 643 /* verify correctness of eBPF program */ 644 int bpf_check(struct bpf_prog **fp, union bpf_attr *attr, 645 union bpf_attr __user *uattr); 646 void bpf_patch_call_args(struct bpf_insn *insn, u32 stack_depth); 647 648 /* Map specifics */ 649 struct xdp_buff; 650 struct sk_buff; 651 652 struct bpf_dtab_netdev *__dev_map_lookup_elem(struct bpf_map *map, u32 key); 653 void __dev_map_insert_ctx(struct bpf_map *map, u32 index); 654 void __dev_map_flush(struct bpf_map *map); 655 int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_buff *xdp, 656 struct net_device *dev_rx); 657 int dev_map_generic_redirect(struct bpf_dtab_netdev *dst, struct sk_buff *skb, 658 struct bpf_prog *xdp_prog); 659 660 struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key); 661 void __cpu_map_insert_ctx(struct bpf_map *map, u32 index); 662 void __cpu_map_flush(struct bpf_map *map); 663 int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu, struct xdp_buff *xdp, 664 struct net_device *dev_rx); 665 666 /* Return map's numa specified by userspace */ 667 static inline int bpf_map_attr_numa_node(const union bpf_attr *attr) 668 { 669 return (attr->map_flags & BPF_F_NUMA_NODE) ? 670 attr->numa_node : NUMA_NO_NODE; 671 } 672 673 struct bpf_prog *bpf_prog_get_type_path(const char *name, enum bpf_prog_type type); 674 int array_map_alloc_check(union bpf_attr *attr); 675 676 int bpf_prog_test_run_xdp(struct bpf_prog *prog, const union bpf_attr *kattr, 677 union bpf_attr __user *uattr); 678 int bpf_prog_test_run_skb(struct bpf_prog *prog, const union bpf_attr *kattr, 679 union bpf_attr __user *uattr); 680 int bpf_prog_test_run_flow_dissector(struct bpf_prog *prog, 681 const union bpf_attr *kattr, 682 union bpf_attr __user *uattr); 683 #else /* !CONFIG_BPF_SYSCALL */ 684 static inline struct bpf_prog *bpf_prog_get(u32 ufd) 685 { 686 return ERR_PTR(-EOPNOTSUPP); 687 } 688 689 static inline struct bpf_prog *bpf_prog_get_type_dev(u32 ufd, 690 enum bpf_prog_type type, 691 bool attach_drv) 692 { 693 return ERR_PTR(-EOPNOTSUPP); 694 } 695 696 static inline struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog, 697 int i) 698 { 699 return ERR_PTR(-EOPNOTSUPP); 700 } 701 702 static inline void bpf_prog_sub(struct bpf_prog *prog, int i) 703 { 704 } 705 706 static inline void bpf_prog_put(struct bpf_prog *prog) 707 { 708 } 709 710 static inline struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog) 711 { 712 return ERR_PTR(-EOPNOTSUPP); 713 } 714 715 static inline struct bpf_prog *__must_check 716 bpf_prog_inc_not_zero(struct bpf_prog *prog) 717 { 718 return ERR_PTR(-EOPNOTSUPP); 719 } 720 721 static inline int __bpf_prog_charge(struct user_struct *user, u32 pages) 722 { 723 return 0; 724 } 725 726 static inline void __bpf_prog_uncharge(struct user_struct *user, u32 pages) 727 { 728 } 729 730 static inline int bpf_obj_get_user(const char __user *pathname, int flags) 731 { 732 return -EOPNOTSUPP; 733 } 734 735 static inline struct net_device *__dev_map_lookup_elem(struct bpf_map *map, 736 u32 key) 737 { 738 return NULL; 739 } 740 741 static inline void __dev_map_insert_ctx(struct bpf_map *map, u32 index) 742 { 743 } 744 745 static inline void __dev_map_flush(struct bpf_map *map) 746 { 747 } 748 749 struct xdp_buff; 750 struct bpf_dtab_netdev; 751 752 static inline 753 int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_buff *xdp, 754 struct net_device *dev_rx) 755 { 756 return 0; 757 } 758 759 struct sk_buff; 760 761 static inline int dev_map_generic_redirect(struct bpf_dtab_netdev *dst, 762 struct sk_buff *skb, 763 struct bpf_prog *xdp_prog) 764 { 765 return 0; 766 } 767 768 static inline 769 struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key) 770 { 771 return NULL; 772 } 773 774 static inline void __cpu_map_insert_ctx(struct bpf_map *map, u32 index) 775 { 776 } 777 778 static inline void __cpu_map_flush(struct bpf_map *map) 779 { 780 } 781 782 static inline int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu, 783 struct xdp_buff *xdp, 784 struct net_device *dev_rx) 785 { 786 return 0; 787 } 788 789 static inline struct bpf_prog *bpf_prog_get_type_path(const char *name, 790 enum bpf_prog_type type) 791 { 792 return ERR_PTR(-EOPNOTSUPP); 793 } 794 795 static inline int bpf_prog_test_run_xdp(struct bpf_prog *prog, 796 const union bpf_attr *kattr, 797 union bpf_attr __user *uattr) 798 { 799 return -ENOTSUPP; 800 } 801 802 static inline int bpf_prog_test_run_skb(struct bpf_prog *prog, 803 const union bpf_attr *kattr, 804 union bpf_attr __user *uattr) 805 { 806 return -ENOTSUPP; 807 } 808 809 static inline int bpf_prog_test_run_flow_dissector(struct bpf_prog *prog, 810 const union bpf_attr *kattr, 811 union bpf_attr __user *uattr) 812 { 813 return -ENOTSUPP; 814 } 815 #endif /* CONFIG_BPF_SYSCALL */ 816 817 static inline struct bpf_prog *bpf_prog_get_type(u32 ufd, 818 enum bpf_prog_type type) 819 { 820 return bpf_prog_get_type_dev(ufd, type, false); 821 } 822 823 bool bpf_prog_get_ok(struct bpf_prog *, enum bpf_prog_type *, bool); 824 825 int bpf_prog_offload_compile(struct bpf_prog *prog); 826 void bpf_prog_offload_destroy(struct bpf_prog *prog); 827 int bpf_prog_offload_info_fill(struct bpf_prog_info *info, 828 struct bpf_prog *prog); 829 830 int bpf_map_offload_info_fill(struct bpf_map_info *info, struct bpf_map *map); 831 832 int bpf_map_offload_lookup_elem(struct bpf_map *map, void *key, void *value); 833 int bpf_map_offload_update_elem(struct bpf_map *map, 834 void *key, void *value, u64 flags); 835 int bpf_map_offload_delete_elem(struct bpf_map *map, void *key); 836 int bpf_map_offload_get_next_key(struct bpf_map *map, 837 void *key, void *next_key); 838 839 bool bpf_offload_prog_map_match(struct bpf_prog *prog, struct bpf_map *map); 840 841 struct bpf_offload_dev * 842 bpf_offload_dev_create(const struct bpf_prog_offload_ops *ops, void *priv); 843 void bpf_offload_dev_destroy(struct bpf_offload_dev *offdev); 844 void *bpf_offload_dev_priv(struct bpf_offload_dev *offdev); 845 int bpf_offload_dev_netdev_register(struct bpf_offload_dev *offdev, 846 struct net_device *netdev); 847 void bpf_offload_dev_netdev_unregister(struct bpf_offload_dev *offdev, 848 struct net_device *netdev); 849 bool bpf_offload_dev_match(struct bpf_prog *prog, struct net_device *netdev); 850 851 #if defined(CONFIG_NET) && defined(CONFIG_BPF_SYSCALL) 852 int bpf_prog_offload_init(struct bpf_prog *prog, union bpf_attr *attr); 853 854 static inline bool bpf_prog_is_dev_bound(const struct bpf_prog_aux *aux) 855 { 856 return aux->offload_requested; 857 } 858 859 static inline bool bpf_map_is_dev_bound(struct bpf_map *map) 860 { 861 return unlikely(map->ops == &bpf_map_offload_ops); 862 } 863 864 struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr); 865 void bpf_map_offload_map_free(struct bpf_map *map); 866 #else 867 static inline int bpf_prog_offload_init(struct bpf_prog *prog, 868 union bpf_attr *attr) 869 { 870 return -EOPNOTSUPP; 871 } 872 873 static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux) 874 { 875 return false; 876 } 877 878 static inline bool bpf_map_is_dev_bound(struct bpf_map *map) 879 { 880 return false; 881 } 882 883 static inline struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr) 884 { 885 return ERR_PTR(-EOPNOTSUPP); 886 } 887 888 static inline void bpf_map_offload_map_free(struct bpf_map *map) 889 { 890 } 891 #endif /* CONFIG_NET && CONFIG_BPF_SYSCALL */ 892 893 #if defined(CONFIG_BPF_STREAM_PARSER) 894 int sock_map_prog_update(struct bpf_map *map, struct bpf_prog *prog, u32 which); 895 int sock_map_get_from_fd(const union bpf_attr *attr, struct bpf_prog *prog); 896 #else 897 static inline int sock_map_prog_update(struct bpf_map *map, 898 struct bpf_prog *prog, u32 which) 899 { 900 return -EOPNOTSUPP; 901 } 902 903 static inline int sock_map_get_from_fd(const union bpf_attr *attr, 904 struct bpf_prog *prog) 905 { 906 return -EINVAL; 907 } 908 #endif 909 910 #if defined(CONFIG_XDP_SOCKETS) 911 struct xdp_sock; 912 struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map, u32 key); 913 int __xsk_map_redirect(struct bpf_map *map, struct xdp_buff *xdp, 914 struct xdp_sock *xs); 915 void __xsk_map_flush(struct bpf_map *map); 916 #else 917 struct xdp_sock; 918 static inline struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map, 919 u32 key) 920 { 921 return NULL; 922 } 923 924 static inline int __xsk_map_redirect(struct bpf_map *map, struct xdp_buff *xdp, 925 struct xdp_sock *xs) 926 { 927 return -EOPNOTSUPP; 928 } 929 930 static inline void __xsk_map_flush(struct bpf_map *map) 931 { 932 } 933 #endif 934 935 #if defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL) 936 void bpf_sk_reuseport_detach(struct sock *sk); 937 int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map, void *key, 938 void *value); 939 int bpf_fd_reuseport_array_update_elem(struct bpf_map *map, void *key, 940 void *value, u64 map_flags); 941 #else 942 static inline void bpf_sk_reuseport_detach(struct sock *sk) 943 { 944 } 945 946 #ifdef CONFIG_BPF_SYSCALL 947 static inline int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map, 948 void *key, void *value) 949 { 950 return -EOPNOTSUPP; 951 } 952 953 static inline int bpf_fd_reuseport_array_update_elem(struct bpf_map *map, 954 void *key, void *value, 955 u64 map_flags) 956 { 957 return -EOPNOTSUPP; 958 } 959 #endif /* CONFIG_BPF_SYSCALL */ 960 #endif /* defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL) */ 961 962 /* verifier prototypes for helper functions called from eBPF programs */ 963 extern const struct bpf_func_proto bpf_map_lookup_elem_proto; 964 extern const struct bpf_func_proto bpf_map_update_elem_proto; 965 extern const struct bpf_func_proto bpf_map_delete_elem_proto; 966 extern const struct bpf_func_proto bpf_map_push_elem_proto; 967 extern const struct bpf_func_proto bpf_map_pop_elem_proto; 968 extern const struct bpf_func_proto bpf_map_peek_elem_proto; 969 970 extern const struct bpf_func_proto bpf_get_prandom_u32_proto; 971 extern const struct bpf_func_proto bpf_get_smp_processor_id_proto; 972 extern const struct bpf_func_proto bpf_get_numa_node_id_proto; 973 extern const struct bpf_func_proto bpf_tail_call_proto; 974 extern const struct bpf_func_proto bpf_ktime_get_ns_proto; 975 extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto; 976 extern const struct bpf_func_proto bpf_get_current_uid_gid_proto; 977 extern const struct bpf_func_proto bpf_get_current_comm_proto; 978 extern const struct bpf_func_proto bpf_get_stackid_proto; 979 extern const struct bpf_func_proto bpf_get_stack_proto; 980 extern const struct bpf_func_proto bpf_sock_map_update_proto; 981 extern const struct bpf_func_proto bpf_sock_hash_update_proto; 982 extern const struct bpf_func_proto bpf_get_current_cgroup_id_proto; 983 extern const struct bpf_func_proto bpf_msg_redirect_hash_proto; 984 extern const struct bpf_func_proto bpf_msg_redirect_map_proto; 985 extern const struct bpf_func_proto bpf_sk_redirect_hash_proto; 986 extern const struct bpf_func_proto bpf_sk_redirect_map_proto; 987 extern const struct bpf_func_proto bpf_spin_lock_proto; 988 extern const struct bpf_func_proto bpf_spin_unlock_proto; 989 extern const struct bpf_func_proto bpf_get_local_storage_proto; 990 991 /* Shared helpers among cBPF and eBPF. */ 992 void bpf_user_rnd_init_once(void); 993 u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5); 994 995 #if defined(CONFIG_NET) 996 bool bpf_sock_common_is_valid_access(int off, int size, 997 enum bpf_access_type type, 998 struct bpf_insn_access_aux *info); 999 bool bpf_sock_is_valid_access(int off, int size, enum bpf_access_type type, 1000 struct bpf_insn_access_aux *info); 1001 u32 bpf_sock_convert_ctx_access(enum bpf_access_type type, 1002 const struct bpf_insn *si, 1003 struct bpf_insn *insn_buf, 1004 struct bpf_prog *prog, 1005 u32 *target_size); 1006 #else 1007 static inline bool bpf_sock_common_is_valid_access(int off, int size, 1008 enum bpf_access_type type, 1009 struct bpf_insn_access_aux *info) 1010 { 1011 return false; 1012 } 1013 static inline bool bpf_sock_is_valid_access(int off, int size, 1014 enum bpf_access_type type, 1015 struct bpf_insn_access_aux *info) 1016 { 1017 return false; 1018 } 1019 static inline u32 bpf_sock_convert_ctx_access(enum bpf_access_type type, 1020 const struct bpf_insn *si, 1021 struct bpf_insn *insn_buf, 1022 struct bpf_prog *prog, 1023 u32 *target_size) 1024 { 1025 return 0; 1026 } 1027 #endif 1028 1029 #ifdef CONFIG_INET 1030 bool bpf_tcp_sock_is_valid_access(int off, int size, enum bpf_access_type type, 1031 struct bpf_insn_access_aux *info); 1032 1033 u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type, 1034 const struct bpf_insn *si, 1035 struct bpf_insn *insn_buf, 1036 struct bpf_prog *prog, 1037 u32 *target_size); 1038 #else 1039 static inline bool bpf_tcp_sock_is_valid_access(int off, int size, 1040 enum bpf_access_type type, 1041 struct bpf_insn_access_aux *info) 1042 { 1043 return false; 1044 } 1045 1046 static inline u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type, 1047 const struct bpf_insn *si, 1048 struct bpf_insn *insn_buf, 1049 struct bpf_prog *prog, 1050 u32 *target_size) 1051 { 1052 return 0; 1053 } 1054 #endif /* CONFIG_INET */ 1055 1056 #endif /* _LINUX_BPF_H */ 1057