1 /* 2 * Copyright (C) 2016-2017 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/list.h> 41 #include <linux/types.h> 42 43 #include "../nfp_asm.h" 44 45 /* For relocation logic use up-most byte of branch instruction as scratch 46 * area. Remember to clear this before sending instructions to HW! 47 */ 48 #define OP_RELO_TYPE 0xff00000000000000ULL 49 50 enum nfp_relo_type { 51 RELO_NONE = 0, 52 /* standard internal jumps */ 53 RELO_BR_REL, 54 /* internal jumps to parts of the outro */ 55 RELO_BR_GO_OUT, 56 RELO_BR_GO_ABORT, 57 /* external jumps to fixed addresses */ 58 RELO_BR_NEXT_PKT, 59 }; 60 61 /* To make absolute relocated branches (branches other than RELO_BR_REL) 62 * distinguishable in user space dumps from normal jumps, add a large offset 63 * to them. 64 */ 65 #define BR_OFF_RELO 15000 66 67 enum static_regs { 68 STATIC_REG_IMM = 21, /* Bank AB */ 69 STATIC_REG_STACK = 22, /* Bank A */ 70 STATIC_REG_PKT_LEN = 22, /* Bank B */ 71 }; 72 73 enum pkt_vec { 74 PKT_VEC_PKT_LEN = 0, 75 PKT_VEC_PKT_PTR = 2, 76 }; 77 78 #define pv_len(np) reg_lm(1, PKT_VEC_PKT_LEN) 79 #define pv_ctm_ptr(np) reg_lm(1, PKT_VEC_PKT_PTR) 80 81 #define stack_reg(np) reg_a(STATIC_REG_STACK) 82 #define stack_imm(np) imm_b(np) 83 #define plen_reg(np) reg_b(STATIC_REG_PKT_LEN) 84 #define pptr_reg(np) pv_ctm_ptr(np) 85 #define imm_a(np) reg_a(STATIC_REG_IMM) 86 #define imm_b(np) reg_b(STATIC_REG_IMM) 87 #define imm_both(np) reg_both(STATIC_REG_IMM) 88 89 #define NFP_BPF_ABI_FLAGS reg_imm(0) 90 #define NFP_BPF_ABI_FLAG_MARK 1 91 92 /** 93 * struct nfp_app_bpf - bpf app priv structure 94 * @app: backpointer to the app 95 * 96 * @map_list: list of offloaded maps 97 * 98 * @adjust_head: adjust head capability 99 * @flags: extra flags for adjust head 100 * @off_min: minimal packet offset within buffer required 101 * @off_max: maximum packet offset within buffer required 102 * @guaranteed_sub: amount of negative adjustment guaranteed possible 103 * @guaranteed_add: amount of positive adjustment guaranteed possible 104 */ 105 struct nfp_app_bpf { 106 struct nfp_app *app; 107 108 struct list_head map_list; 109 110 struct nfp_bpf_cap_adjust_head { 111 u32 flags; 112 int off_min; 113 int off_max; 114 int guaranteed_sub; 115 int guaranteed_add; 116 } adjust_head; 117 }; 118 119 /** 120 * struct nfp_bpf_map - private per-map data attached to BPF maps for offload 121 * @offmap: pointer to the offloaded BPF map 122 * @bpf: back pointer to bpf app private structure 123 * @tid: table id identifying map on datapath 124 * @l: link on the nfp_app_bpf->map_list list 125 */ 126 struct nfp_bpf_map { 127 struct bpf_offloaded_map *offmap; 128 struct nfp_app_bpf *bpf; 129 u32 tid; 130 struct list_head l; 131 }; 132 133 struct nfp_prog; 134 struct nfp_insn_meta; 135 typedef int (*instr_cb_t)(struct nfp_prog *, struct nfp_insn_meta *); 136 137 #define nfp_prog_first_meta(nfp_prog) \ 138 list_first_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 139 #define nfp_prog_last_meta(nfp_prog) \ 140 list_last_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 141 #define nfp_meta_next(meta) list_next_entry(meta, l) 142 #define nfp_meta_prev(meta) list_prev_entry(meta, l) 143 144 #define FLAG_INSN_IS_JUMP_DST BIT(0) 145 146 /** 147 * struct nfp_insn_meta - BPF instruction wrapper 148 * @insn: BPF instruction 149 * @ptr: pointer type for memory operations 150 * @ldst_gather_len: memcpy length gathered from load/store sequence 151 * @paired_st: the paired store insn at the head of the sequence 152 * @arg2: arg2 for call instructions 153 * @ptr_not_const: pointer is not always constant 154 * @jmp_dst: destination info for jump instructions 155 * @off: index of first generated machine instruction (in nfp_prog.prog) 156 * @n: eBPF instruction number 157 * @flags: eBPF instruction extra optimization flags 158 * @skip: skip this instruction (optimized out) 159 * @double_cb: callback for second part of the instruction 160 * @l: link on nfp_prog->insns list 161 */ 162 struct nfp_insn_meta { 163 struct bpf_insn insn; 164 union { 165 struct { 166 struct bpf_reg_state ptr; 167 struct bpf_insn *paired_st; 168 s16 ldst_gather_len; 169 bool ptr_not_const; 170 }; 171 struct nfp_insn_meta *jmp_dst; 172 struct bpf_reg_state arg2; 173 }; 174 unsigned int off; 175 unsigned short n; 176 unsigned short flags; 177 bool skip; 178 instr_cb_t double_cb; 179 180 struct list_head l; 181 }; 182 183 #define BPF_SIZE_MASK 0x18 184 185 static inline u8 mbpf_class(const struct nfp_insn_meta *meta) 186 { 187 return BPF_CLASS(meta->insn.code); 188 } 189 190 static inline u8 mbpf_src(const struct nfp_insn_meta *meta) 191 { 192 return BPF_SRC(meta->insn.code); 193 } 194 195 static inline u8 mbpf_op(const struct nfp_insn_meta *meta) 196 { 197 return BPF_OP(meta->insn.code); 198 } 199 200 static inline u8 mbpf_mode(const struct nfp_insn_meta *meta) 201 { 202 return BPF_MODE(meta->insn.code); 203 } 204 205 static inline bool is_mbpf_load(const struct nfp_insn_meta *meta) 206 { 207 return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_LDX | BPF_MEM); 208 } 209 210 static inline bool is_mbpf_store(const struct nfp_insn_meta *meta) 211 { 212 return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_STX | BPF_MEM); 213 } 214 215 /** 216 * struct nfp_prog - nfp BPF program 217 * @bpf: backpointer to the bpf app priv structure 218 * @prog: machine code 219 * @prog_len: number of valid instructions in @prog array 220 * @__prog_alloc_len: alloc size of @prog array 221 * @verifier_meta: temporary storage for verifier's insn meta 222 * @type: BPF program type 223 * @last_bpf_off: address of the last instruction translated from BPF 224 * @tgt_out: jump target for normal exit 225 * @tgt_abort: jump target for abort (e.g. access outside of packet buffer) 226 * @n_translated: number of successfully translated instructions (for errors) 227 * @error: error code if something went wrong 228 * @stack_depth: max stack depth from the verifier 229 * @adjust_head_location: if program has single adjust head call - the insn no. 230 * @insns: list of BPF instruction wrappers (struct nfp_insn_meta) 231 */ 232 struct nfp_prog { 233 struct nfp_app_bpf *bpf; 234 235 u64 *prog; 236 unsigned int prog_len; 237 unsigned int __prog_alloc_len; 238 239 struct nfp_insn_meta *verifier_meta; 240 241 enum bpf_prog_type type; 242 243 unsigned int last_bpf_off; 244 unsigned int tgt_out; 245 unsigned int tgt_abort; 246 247 unsigned int n_translated; 248 int error; 249 250 unsigned int stack_depth; 251 unsigned int adjust_head_location; 252 253 struct list_head insns; 254 }; 255 256 /** 257 * struct nfp_bpf_vnic - per-vNIC BPF priv structure 258 * @tc_prog: currently loaded cls_bpf program 259 * @start_off: address of the first instruction in the memory 260 * @tgt_done: jump target to get the next packet 261 */ 262 struct nfp_bpf_vnic { 263 struct bpf_prog *tc_prog; 264 unsigned int start_off; 265 unsigned int tgt_done; 266 }; 267 268 void nfp_bpf_jit_prepare(struct nfp_prog *nfp_prog, unsigned int cnt); 269 int nfp_bpf_jit(struct nfp_prog *prog); 270 271 extern const struct bpf_prog_offload_ops nfp_bpf_analyzer_ops; 272 273 struct netdev_bpf; 274 struct nfp_app; 275 struct nfp_net; 276 277 int nfp_ndo_bpf(struct nfp_app *app, struct nfp_net *nn, 278 struct netdev_bpf *bpf); 279 int nfp_net_bpf_offload(struct nfp_net *nn, struct bpf_prog *prog, 280 bool old_prog); 281 282 struct nfp_insn_meta * 283 nfp_bpf_goto_meta(struct nfp_prog *nfp_prog, struct nfp_insn_meta *meta, 284 unsigned int insn_idx, unsigned int n_insns); 285 286 void *nfp_bpf_relo_for_vnic(struct nfp_prog *nfp_prog, struct nfp_bpf_vnic *bv); 287 #endif 288