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