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 * @adjust_head: adjust head capability 97 * @flags: extra flags for adjust head 98 * @off_min: minimal packet offset within buffer required 99 * @off_max: maximum packet offset within buffer required 100 * @guaranteed_sub: amount of negative adjustment guaranteed possible 101 * @guaranteed_add: amount of positive adjustment guaranteed possible 102 */ 103 struct nfp_app_bpf { 104 struct nfp_app *app; 105 106 struct nfp_bpf_cap_adjust_head { 107 u32 flags; 108 int off_min; 109 int off_max; 110 int guaranteed_sub; 111 int guaranteed_add; 112 } adjust_head; 113 }; 114 115 struct nfp_prog; 116 struct nfp_insn_meta; 117 typedef int (*instr_cb_t)(struct nfp_prog *, struct nfp_insn_meta *); 118 119 #define nfp_prog_first_meta(nfp_prog) \ 120 list_first_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 121 #define nfp_prog_last_meta(nfp_prog) \ 122 list_last_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 123 #define nfp_meta_next(meta) list_next_entry(meta, l) 124 #define nfp_meta_prev(meta) list_prev_entry(meta, l) 125 126 #define FLAG_INSN_IS_JUMP_DST BIT(0) 127 128 /** 129 * struct nfp_insn_meta - BPF instruction wrapper 130 * @insn: BPF instruction 131 * @ptr: pointer type for memory operations 132 * @ldst_gather_len: memcpy length gathered from load/store sequence 133 * @paired_st: the paired store insn at the head of the sequence 134 * @arg2: arg2 for call instructions 135 * @ptr_not_const: pointer is not always constant 136 * @jmp_dst: destination info for jump instructions 137 * @off: index of first generated machine instruction (in nfp_prog.prog) 138 * @n: eBPF instruction number 139 * @flags: eBPF instruction extra optimization flags 140 * @skip: skip this instruction (optimized out) 141 * @double_cb: callback for second part of the instruction 142 * @l: link on nfp_prog->insns list 143 */ 144 struct nfp_insn_meta { 145 struct bpf_insn insn; 146 union { 147 struct { 148 struct bpf_reg_state ptr; 149 struct bpf_insn *paired_st; 150 s16 ldst_gather_len; 151 bool ptr_not_const; 152 }; 153 struct nfp_insn_meta *jmp_dst; 154 struct bpf_reg_state arg2; 155 }; 156 unsigned int off; 157 unsigned short n; 158 unsigned short flags; 159 bool skip; 160 instr_cb_t double_cb; 161 162 struct list_head l; 163 }; 164 165 #define BPF_SIZE_MASK 0x18 166 167 static inline u8 mbpf_class(const struct nfp_insn_meta *meta) 168 { 169 return BPF_CLASS(meta->insn.code); 170 } 171 172 static inline u8 mbpf_src(const struct nfp_insn_meta *meta) 173 { 174 return BPF_SRC(meta->insn.code); 175 } 176 177 static inline u8 mbpf_op(const struct nfp_insn_meta *meta) 178 { 179 return BPF_OP(meta->insn.code); 180 } 181 182 static inline u8 mbpf_mode(const struct nfp_insn_meta *meta) 183 { 184 return BPF_MODE(meta->insn.code); 185 } 186 187 static inline bool is_mbpf_load(const struct nfp_insn_meta *meta) 188 { 189 return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_LDX | BPF_MEM); 190 } 191 192 static inline bool is_mbpf_store(const struct nfp_insn_meta *meta) 193 { 194 return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_STX | BPF_MEM); 195 } 196 197 /** 198 * struct nfp_prog - nfp BPF program 199 * @bpf: backpointer to the bpf app priv structure 200 * @prog: machine code 201 * @prog_len: number of valid instructions in @prog array 202 * @__prog_alloc_len: alloc size of @prog array 203 * @verifier_meta: temporary storage for verifier's insn meta 204 * @type: BPF program type 205 * @last_bpf_off: address of the last instruction translated from BPF 206 * @tgt_out: jump target for normal exit 207 * @tgt_abort: jump target for abort (e.g. access outside of packet buffer) 208 * @n_translated: number of successfully translated instructions (for errors) 209 * @error: error code if something went wrong 210 * @stack_depth: max stack depth from the verifier 211 * @adjust_head_location: if program has single adjust head call - the insn no. 212 * @insns: list of BPF instruction wrappers (struct nfp_insn_meta) 213 */ 214 struct nfp_prog { 215 struct nfp_app_bpf *bpf; 216 217 u64 *prog; 218 unsigned int prog_len; 219 unsigned int __prog_alloc_len; 220 221 struct nfp_insn_meta *verifier_meta; 222 223 enum bpf_prog_type type; 224 225 unsigned int last_bpf_off; 226 unsigned int tgt_out; 227 unsigned int tgt_abort; 228 229 unsigned int n_translated; 230 int error; 231 232 unsigned int stack_depth; 233 unsigned int adjust_head_location; 234 235 struct list_head insns; 236 }; 237 238 /** 239 * struct nfp_bpf_vnic - per-vNIC BPF priv structure 240 * @tc_prog: currently loaded cls_bpf program 241 * @start_off: address of the first instruction in the memory 242 * @tgt_done: jump target to get the next packet 243 */ 244 struct nfp_bpf_vnic { 245 struct bpf_prog *tc_prog; 246 unsigned int start_off; 247 unsigned int tgt_done; 248 }; 249 250 void nfp_bpf_jit_prepare(struct nfp_prog *nfp_prog, unsigned int cnt); 251 int nfp_bpf_jit(struct nfp_prog *prog); 252 253 extern const struct bpf_prog_offload_ops nfp_bpf_analyzer_ops; 254 255 struct netdev_bpf; 256 struct nfp_app; 257 struct nfp_net; 258 259 int nfp_net_bpf_offload(struct nfp_net *nn, struct bpf_prog *prog, 260 bool old_prog); 261 262 int nfp_bpf_verifier_prep(struct nfp_app *app, struct nfp_net *nn, 263 struct netdev_bpf *bpf); 264 int nfp_bpf_translate(struct nfp_app *app, struct nfp_net *nn, 265 struct bpf_prog *prog); 266 int nfp_bpf_destroy(struct nfp_app *app, struct nfp_net *nn, 267 struct bpf_prog *prog); 268 struct nfp_insn_meta * 269 nfp_bpf_goto_meta(struct nfp_prog *nfp_prog, struct nfp_insn_meta *meta, 270 unsigned int insn_idx, unsigned int n_insns); 271 272 void *nfp_bpf_relo_for_vnic(struct nfp_prog *nfp_prog, struct nfp_bpf_vnic *bv); 273 #endif 274