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