1 /* 2 * Copyright (C) 2016-2018 Netronome Systems, Inc. 3 * 4 * This software is dual licensed under the GNU General License Version 2, 5 * June 1991 as shown in the file COPYING in the top-level directory of this 6 * source tree or the BSD 2-Clause License provided below. You have the 7 * option to license this software under the complete terms of either license. 8 * 9 * The BSD 2-Clause License: 10 * 11 * Redistribution and use in source and binary forms, with or 12 * without modification, are permitted provided that the following 13 * conditions are met: 14 * 15 * 1. Redistributions of source code must retain the above 16 * copyright notice, this list of conditions and the following 17 * disclaimer. 18 * 19 * 2. Redistributions in binary form must reproduce the above 20 * copyright notice, this list of conditions and the following 21 * disclaimer in the documentation and/or other materials 22 * provided with the distribution. 23 * 24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 28 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 29 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 30 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 31 * SOFTWARE. 32 */ 33 34 #ifndef __NFP_BPF_H__ 35 #define __NFP_BPF_H__ 1 36 37 #include <linux/bitfield.h> 38 #include <linux/bpf.h> 39 #include <linux/bpf_verifier.h> 40 #include <linux/kernel.h> 41 #include <linux/list.h> 42 #include <linux/rhashtable.h> 43 #include <linux/skbuff.h> 44 #include <linux/types.h> 45 #include <linux/wait.h> 46 47 #include "../nfp_asm.h" 48 #include "fw.h" 49 50 #define cmsg_warn(bpf, msg...) nn_dp_warn(&(bpf)->app->ctrl->dp, msg) 51 52 /* For relocation logic use up-most byte of branch instruction as scratch 53 * area. Remember to clear this before sending instructions to HW! 54 */ 55 #define OP_RELO_TYPE 0xff00000000000000ULL 56 57 enum nfp_relo_type { 58 RELO_NONE = 0, 59 /* standard internal jumps */ 60 RELO_BR_REL, 61 /* internal jumps to parts of the outro */ 62 RELO_BR_GO_OUT, 63 RELO_BR_GO_ABORT, 64 /* external jumps to fixed addresses */ 65 RELO_BR_NEXT_PKT, 66 RELO_BR_HELPER, 67 /* immediate relocation against load address */ 68 RELO_IMMED_REL, 69 }; 70 71 /* To make absolute relocated branches (branches other than RELO_BR_REL) 72 * distinguishable in user space dumps from normal jumps, add a large offset 73 * to them. 74 */ 75 #define BR_OFF_RELO 15000 76 77 enum static_regs { 78 STATIC_REG_IMMA = 20, /* Bank AB */ 79 STATIC_REG_IMM = 21, /* Bank AB */ 80 STATIC_REG_STACK = 22, /* Bank A */ 81 STATIC_REG_PKT_LEN = 22, /* Bank B */ 82 }; 83 84 enum pkt_vec { 85 PKT_VEC_PKT_LEN = 0, 86 PKT_VEC_PKT_PTR = 2, 87 PKT_VEC_QSEL_SET = 4, 88 PKT_VEC_QSEL_VAL = 6, 89 }; 90 91 #define PKT_VEL_QSEL_SET_BIT 4 92 93 #define pv_len(np) reg_lm(1, PKT_VEC_PKT_LEN) 94 #define pv_ctm_ptr(np) reg_lm(1, PKT_VEC_PKT_PTR) 95 #define pv_qsel_set(np) reg_lm(1, PKT_VEC_QSEL_SET) 96 #define pv_qsel_val(np) reg_lm(1, PKT_VEC_QSEL_VAL) 97 98 #define stack_reg(np) reg_a(STATIC_REG_STACK) 99 #define stack_imm(np) imm_b(np) 100 #define plen_reg(np) reg_b(STATIC_REG_PKT_LEN) 101 #define pptr_reg(np) pv_ctm_ptr(np) 102 #define imm_a(np) reg_a(STATIC_REG_IMM) 103 #define imm_b(np) reg_b(STATIC_REG_IMM) 104 #define imma_a(np) reg_a(STATIC_REG_IMMA) 105 #define imma_b(np) reg_b(STATIC_REG_IMMA) 106 #define imm_both(np) reg_both(STATIC_REG_IMM) 107 108 #define NFP_BPF_ABI_FLAGS reg_imm(0) 109 #define NFP_BPF_ABI_FLAG_MARK 1 110 111 /** 112 * struct nfp_app_bpf - bpf app priv structure 113 * @app: backpointer to the app 114 * 115 * @bpf_dev: BPF offload device handle 116 * 117 * @tag_allocator: bitmap of control message tags in use 118 * @tag_alloc_next: next tag bit to allocate 119 * @tag_alloc_last: next tag bit to be freed 120 * 121 * @cmsg_replies: received cmsg replies waiting to be consumed 122 * @cmsg_wq: work queue for waiting for cmsg replies 123 * 124 * @map_list: list of offloaded maps 125 * @maps_in_use: number of currently offloaded maps 126 * @map_elems_in_use: number of elements allocated to offloaded maps 127 * 128 * @maps_neutral: hash table of offload-neutral maps (on pointer) 129 * 130 * @abi_version: global BPF ABI version 131 * 132 * @adjust_head: adjust head capability 133 * @adjust_head.flags: extra flags for adjust head 134 * @adjust_head.off_min: minimal packet offset within buffer required 135 * @adjust_head.off_max: maximum packet offset within buffer required 136 * @adjust_head.guaranteed_sub: negative adjustment guaranteed possible 137 * @adjust_head.guaranteed_add: positive adjustment guaranteed possible 138 * 139 * @maps: map capability 140 * @maps.types: supported map types 141 * @maps.max_maps: max number of maps supported 142 * @maps.max_elems: max number of entries in each map 143 * @maps.max_key_sz: max size of map key 144 * @maps.max_val_sz: max size of map value 145 * @maps.max_elem_sz: max size of map entry (key + value) 146 * 147 * @helpers: helper addressess for various calls 148 * @helpers.map_lookup: map lookup helper address 149 * @helpers.map_update: map update helper address 150 * @helpers.map_delete: map delete helper address 151 * @helpers.perf_event_output: output perf event to a ring buffer 152 * 153 * @pseudo_random: FW initialized the pseudo-random machinery (CSRs) 154 * @queue_select: BPF can set the RX queue ID in packet vector 155 * @adjust_tail: BPF can simply trunc packet size for adjust tail 156 */ 157 struct nfp_app_bpf { 158 struct nfp_app *app; 159 160 struct bpf_offload_dev *bpf_dev; 161 162 DECLARE_BITMAP(tag_allocator, U16_MAX + 1); 163 u16 tag_alloc_next; 164 u16 tag_alloc_last; 165 166 struct sk_buff_head cmsg_replies; 167 struct wait_queue_head cmsg_wq; 168 169 struct list_head map_list; 170 unsigned int maps_in_use; 171 unsigned int map_elems_in_use; 172 173 struct rhashtable maps_neutral; 174 175 u32 abi_version; 176 177 struct nfp_bpf_cap_adjust_head { 178 u32 flags; 179 int off_min; 180 int off_max; 181 int guaranteed_sub; 182 int guaranteed_add; 183 } adjust_head; 184 185 struct { 186 u32 types; 187 u32 max_maps; 188 u32 max_elems; 189 u32 max_key_sz; 190 u32 max_val_sz; 191 u32 max_elem_sz; 192 } maps; 193 194 struct { 195 u32 map_lookup; 196 u32 map_update; 197 u32 map_delete; 198 u32 perf_event_output; 199 } helpers; 200 201 bool pseudo_random; 202 bool queue_select; 203 bool adjust_tail; 204 }; 205 206 enum nfp_bpf_map_use { 207 NFP_MAP_UNUSED = 0, 208 NFP_MAP_USE_READ, 209 NFP_MAP_USE_WRITE, 210 NFP_MAP_USE_ATOMIC_CNT, 211 }; 212 213 /** 214 * struct nfp_bpf_map - private per-map data attached to BPF maps for offload 215 * @offmap: pointer to the offloaded BPF map 216 * @bpf: back pointer to bpf app private structure 217 * @tid: table id identifying map on datapath 218 * @l: link on the nfp_app_bpf->map_list list 219 * @use_map: map of how the value is used (in 4B chunks) 220 */ 221 struct nfp_bpf_map { 222 struct bpf_offloaded_map *offmap; 223 struct nfp_app_bpf *bpf; 224 u32 tid; 225 struct list_head l; 226 enum nfp_bpf_map_use use_map[]; 227 }; 228 229 struct nfp_bpf_neutral_map { 230 struct rhash_head l; 231 struct bpf_map *ptr; 232 u32 map_id; 233 u32 count; 234 }; 235 236 extern const struct rhashtable_params nfp_bpf_maps_neutral_params; 237 238 struct nfp_prog; 239 struct nfp_insn_meta; 240 typedef int (*instr_cb_t)(struct nfp_prog *, struct nfp_insn_meta *); 241 242 #define nfp_prog_first_meta(nfp_prog) \ 243 list_first_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 244 #define nfp_prog_last_meta(nfp_prog) \ 245 list_last_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 246 #define nfp_meta_next(meta) list_next_entry(meta, l) 247 #define nfp_meta_prev(meta) list_prev_entry(meta, l) 248 249 /** 250 * struct nfp_bpf_reg_state - register state for calls 251 * @reg: BPF register state from latest path 252 * @var_off: for stack arg - changes stack offset on different paths 253 */ 254 struct nfp_bpf_reg_state { 255 struct bpf_reg_state reg; 256 bool var_off; 257 }; 258 259 #define FLAG_INSN_IS_JUMP_DST BIT(0) 260 261 /** 262 * struct nfp_insn_meta - BPF instruction wrapper 263 * @insn: BPF instruction 264 * @ptr: pointer type for memory operations 265 * @ldst_gather_len: memcpy length gathered from load/store sequence 266 * @paired_st: the paired store insn at the head of the sequence 267 * @ptr_not_const: pointer is not always constant 268 * @pkt_cache: packet data cache information 269 * @pkt_cache.range_start: start offset for associated packet data cache 270 * @pkt_cache.range_end: end offset for associated packet data cache 271 * @pkt_cache.do_init: this read needs to initialize packet data cache 272 * @xadd_over_16bit: 16bit immediate is not guaranteed 273 * @xadd_maybe_16bit: 16bit immediate is possible 274 * @jmp_dst: destination info for jump instructions 275 * @jump_neg_op: jump instruction has inverted immediate, use ADD instead of SUB 276 * @func_id: function id for call instructions 277 * @arg1: arg1 for call instructions 278 * @arg2: arg2 for call instructions 279 * @umin_src: copy of core verifier umin_value for src opearnd. 280 * @umax_src: copy of core verifier umax_value for src operand. 281 * @umin_dst: copy of core verifier umin_value for dst opearnd. 282 * @umax_dst: copy of core verifier umax_value for dst operand. 283 * @off: index of first generated machine instruction (in nfp_prog.prog) 284 * @n: eBPF instruction number 285 * @flags: eBPF instruction extra optimization flags 286 * @skip: skip this instruction (optimized out) 287 * @double_cb: callback for second part of the instruction 288 * @l: link on nfp_prog->insns list 289 */ 290 struct nfp_insn_meta { 291 struct bpf_insn insn; 292 union { 293 /* pointer ops (ld/st/xadd) */ 294 struct { 295 struct bpf_reg_state ptr; 296 struct bpf_insn *paired_st; 297 s16 ldst_gather_len; 298 bool ptr_not_const; 299 struct { 300 s16 range_start; 301 s16 range_end; 302 bool do_init; 303 } pkt_cache; 304 bool xadd_over_16bit; 305 bool xadd_maybe_16bit; 306 }; 307 /* jump */ 308 struct { 309 struct nfp_insn_meta *jmp_dst; 310 bool jump_neg_op; 311 }; 312 /* function calls */ 313 struct { 314 u32 func_id; 315 struct bpf_reg_state arg1; 316 struct nfp_bpf_reg_state arg2; 317 }; 318 /* We are interested in range info for operands of ALU 319 * operations. For example, shift amount, multiplicand and 320 * multiplier etc. 321 */ 322 struct { 323 u64 umin_src; 324 u64 umax_src; 325 u64 umin_dst; 326 u64 umax_dst; 327 }; 328 }; 329 unsigned int off; 330 unsigned short n; 331 unsigned short flags; 332 bool skip; 333 instr_cb_t double_cb; 334 335 struct list_head l; 336 }; 337 338 #define BPF_SIZE_MASK 0x18 339 340 static inline u8 mbpf_class(const struct nfp_insn_meta *meta) 341 { 342 return BPF_CLASS(meta->insn.code); 343 } 344 345 static inline u8 mbpf_src(const struct nfp_insn_meta *meta) 346 { 347 return BPF_SRC(meta->insn.code); 348 } 349 350 static inline u8 mbpf_op(const struct nfp_insn_meta *meta) 351 { 352 return BPF_OP(meta->insn.code); 353 } 354 355 static inline u8 mbpf_mode(const struct nfp_insn_meta *meta) 356 { 357 return BPF_MODE(meta->insn.code); 358 } 359 360 static inline bool is_mbpf_alu(const struct nfp_insn_meta *meta) 361 { 362 return mbpf_class(meta) == BPF_ALU64 || mbpf_class(meta) == BPF_ALU; 363 } 364 365 static inline bool is_mbpf_load(const struct nfp_insn_meta *meta) 366 { 367 return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_LDX | BPF_MEM); 368 } 369 370 static inline bool is_mbpf_store(const struct nfp_insn_meta *meta) 371 { 372 return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_STX | BPF_MEM); 373 } 374 375 static inline bool is_mbpf_load_pkt(const struct nfp_insn_meta *meta) 376 { 377 return is_mbpf_load(meta) && meta->ptr.type == PTR_TO_PACKET; 378 } 379 380 static inline bool is_mbpf_store_pkt(const struct nfp_insn_meta *meta) 381 { 382 return is_mbpf_store(meta) && meta->ptr.type == PTR_TO_PACKET; 383 } 384 385 static inline bool is_mbpf_classic_load(const struct nfp_insn_meta *meta) 386 { 387 u8 code = meta->insn.code; 388 389 return BPF_CLASS(code) == BPF_LD && 390 (BPF_MODE(code) == BPF_ABS || BPF_MODE(code) == BPF_IND); 391 } 392 393 static inline bool is_mbpf_classic_store(const struct nfp_insn_meta *meta) 394 { 395 u8 code = meta->insn.code; 396 397 return BPF_CLASS(code) == BPF_ST && BPF_MODE(code) == BPF_MEM; 398 } 399 400 static inline bool is_mbpf_classic_store_pkt(const struct nfp_insn_meta *meta) 401 { 402 return is_mbpf_classic_store(meta) && meta->ptr.type == PTR_TO_PACKET; 403 } 404 405 static inline bool is_mbpf_xadd(const struct nfp_insn_meta *meta) 406 { 407 return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_STX | BPF_XADD); 408 } 409 410 static inline bool is_mbpf_mul(const struct nfp_insn_meta *meta) 411 { 412 return is_mbpf_alu(meta) && mbpf_op(meta) == BPF_MUL; 413 } 414 415 static inline bool is_mbpf_div(const struct nfp_insn_meta *meta) 416 { 417 return is_mbpf_alu(meta) && mbpf_op(meta) == BPF_DIV; 418 } 419 420 /** 421 * struct nfp_prog - nfp BPF program 422 * @bpf: backpointer to the bpf app priv structure 423 * @prog: machine code 424 * @prog_len: number of valid instructions in @prog array 425 * @__prog_alloc_len: alloc size of @prog array 426 * @verifier_meta: temporary storage for verifier's insn meta 427 * @type: BPF program type 428 * @last_bpf_off: address of the last instruction translated from BPF 429 * @tgt_out: jump target for normal exit 430 * @tgt_abort: jump target for abort (e.g. access outside of packet buffer) 431 * @n_translated: number of successfully translated instructions (for errors) 432 * @error: error code if something went wrong 433 * @stack_depth: max stack depth from the verifier 434 * @adjust_head_location: if program has single adjust head call - the insn no. 435 * @map_records_cnt: the number of map pointers recorded for this prog 436 * @map_records: the map record pointers from bpf->maps_neutral 437 * @insns: list of BPF instruction wrappers (struct nfp_insn_meta) 438 */ 439 struct nfp_prog { 440 struct nfp_app_bpf *bpf; 441 442 u64 *prog; 443 unsigned int prog_len; 444 unsigned int __prog_alloc_len; 445 446 struct nfp_insn_meta *verifier_meta; 447 448 enum bpf_prog_type type; 449 450 unsigned int last_bpf_off; 451 unsigned int tgt_out; 452 unsigned int tgt_abort; 453 454 unsigned int n_translated; 455 int error; 456 457 unsigned int stack_depth; 458 unsigned int adjust_head_location; 459 460 unsigned int map_records_cnt; 461 struct nfp_bpf_neutral_map **map_records; 462 463 struct list_head insns; 464 }; 465 466 /** 467 * struct nfp_bpf_vnic - per-vNIC BPF priv structure 468 * @tc_prog: currently loaded cls_bpf program 469 * @start_off: address of the first instruction in the memory 470 * @tgt_done: jump target to get the next packet 471 */ 472 struct nfp_bpf_vnic { 473 struct bpf_prog *tc_prog; 474 unsigned int start_off; 475 unsigned int tgt_done; 476 }; 477 478 void nfp_bpf_jit_prepare(struct nfp_prog *nfp_prog, unsigned int cnt); 479 int nfp_bpf_jit(struct nfp_prog *prog); 480 bool nfp_bpf_supported_opcode(u8 code); 481 482 extern const struct bpf_prog_offload_ops nfp_bpf_analyzer_ops; 483 484 struct netdev_bpf; 485 struct nfp_app; 486 struct nfp_net; 487 488 int nfp_ndo_bpf(struct nfp_app *app, struct nfp_net *nn, 489 struct netdev_bpf *bpf); 490 int nfp_net_bpf_offload(struct nfp_net *nn, struct bpf_prog *prog, 491 bool old_prog, struct netlink_ext_ack *extack); 492 493 struct nfp_insn_meta * 494 nfp_bpf_goto_meta(struct nfp_prog *nfp_prog, struct nfp_insn_meta *meta, 495 unsigned int insn_idx, unsigned int n_insns); 496 497 void *nfp_bpf_relo_for_vnic(struct nfp_prog *nfp_prog, struct nfp_bpf_vnic *bv); 498 499 long long int 500 nfp_bpf_ctrl_alloc_map(struct nfp_app_bpf *bpf, struct bpf_map *map); 501 void 502 nfp_bpf_ctrl_free_map(struct nfp_app_bpf *bpf, struct nfp_bpf_map *nfp_map); 503 int nfp_bpf_ctrl_getfirst_entry(struct bpf_offloaded_map *offmap, 504 void *next_key); 505 int nfp_bpf_ctrl_update_entry(struct bpf_offloaded_map *offmap, 506 void *key, void *value, u64 flags); 507 int nfp_bpf_ctrl_del_entry(struct bpf_offloaded_map *offmap, void *key); 508 int nfp_bpf_ctrl_lookup_entry(struct bpf_offloaded_map *offmap, 509 void *key, void *value); 510 int nfp_bpf_ctrl_getnext_entry(struct bpf_offloaded_map *offmap, 511 void *key, void *next_key); 512 513 int nfp_bpf_event_output(struct nfp_app_bpf *bpf, const void *data, 514 unsigned int len); 515 516 void nfp_bpf_ctrl_msg_rx(struct nfp_app *app, struct sk_buff *skb); 517 void 518 nfp_bpf_ctrl_msg_rx_raw(struct nfp_app *app, const void *data, 519 unsigned int len); 520 #endif 521