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