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