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