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 branch fixup 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_BR_SPECIAL 0xff00000000000000ULL 49 50 enum br_special { 51 OP_BR_NORMAL = 0, 52 OP_BR_GO_OUT, 53 OP_BR_GO_ABORT, 54 }; 55 56 enum static_regs { 57 STATIC_REG_IMM = 21, /* Bank AB */ 58 STATIC_REG_STACK = 22, /* Bank A */ 59 STATIC_REG_PKT_LEN = 22, /* Bank B */ 60 }; 61 62 enum pkt_vec { 63 PKT_VEC_PKT_LEN = 0, 64 PKT_VEC_PKT_PTR = 2, 65 }; 66 67 #define pv_len(np) reg_lm(1, PKT_VEC_PKT_LEN) 68 #define pv_ctm_ptr(np) reg_lm(1, PKT_VEC_PKT_PTR) 69 70 #define stack_reg(np) reg_a(STATIC_REG_STACK) 71 #define stack_imm(np) imm_b(np) 72 #define plen_reg(np) reg_b(STATIC_REG_PKT_LEN) 73 #define pptr_reg(np) pv_ctm_ptr(np) 74 #define imm_a(np) reg_a(STATIC_REG_IMM) 75 #define imm_b(np) reg_b(STATIC_REG_IMM) 76 #define imm_both(np) reg_both(STATIC_REG_IMM) 77 78 #define NFP_BPF_ABI_FLAGS reg_imm(0) 79 #define NFP_BPF_ABI_FLAG_MARK 1 80 81 /** 82 * struct nfp_app_bpf - bpf app priv structure 83 * @app: backpointer to the app 84 * 85 * @adjust_head: adjust head capability 86 * @flags: extra flags for adjust head 87 * @off_min: minimal packet offset within buffer required 88 * @off_max: maximum packet offset within buffer required 89 * @guaranteed_sub: amount of negative adjustment guaranteed possible 90 * @guaranteed_add: amount of positive adjustment guaranteed possible 91 */ 92 struct nfp_app_bpf { 93 struct nfp_app *app; 94 95 struct nfp_bpf_cap_adjust_head { 96 u32 flags; 97 int off_min; 98 int off_max; 99 int guaranteed_sub; 100 int guaranteed_add; 101 } adjust_head; 102 }; 103 104 struct nfp_prog; 105 struct nfp_insn_meta; 106 typedef int (*instr_cb_t)(struct nfp_prog *, struct nfp_insn_meta *); 107 108 #define nfp_prog_first_meta(nfp_prog) \ 109 list_first_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 110 #define nfp_prog_last_meta(nfp_prog) \ 111 list_last_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 112 #define nfp_meta_next(meta) list_next_entry(meta, l) 113 #define nfp_meta_prev(meta) list_prev_entry(meta, l) 114 115 #define FLAG_INSN_IS_JUMP_DST BIT(0) 116 117 /** 118 * struct nfp_insn_meta - BPF instruction wrapper 119 * @insn: BPF instruction 120 * @ptr: pointer type for memory operations 121 * @ldst_gather_len: memcpy length gathered from load/store sequence 122 * @paired_st: the paired store insn at the head of the sequence 123 * @arg2: arg2 for call instructions 124 * @ptr_not_const: pointer is not always constant 125 * @jmp_dst: destination info for jump instructions 126 * @off: index of first generated machine instruction (in nfp_prog.prog) 127 * @n: eBPF instruction number 128 * @flags: eBPF instruction extra optimization flags 129 * @skip: skip this instruction (optimized out) 130 * @double_cb: callback for second part of the instruction 131 * @l: link on nfp_prog->insns list 132 */ 133 struct nfp_insn_meta { 134 struct bpf_insn insn; 135 union { 136 struct { 137 struct bpf_reg_state ptr; 138 struct bpf_insn *paired_st; 139 s16 ldst_gather_len; 140 bool ptr_not_const; 141 }; 142 struct nfp_insn_meta *jmp_dst; 143 struct bpf_reg_state arg2; 144 }; 145 unsigned int off; 146 unsigned short n; 147 unsigned short flags; 148 bool skip; 149 instr_cb_t double_cb; 150 151 struct list_head l; 152 }; 153 154 #define BPF_SIZE_MASK 0x18 155 156 static inline u8 mbpf_class(const struct nfp_insn_meta *meta) 157 { 158 return BPF_CLASS(meta->insn.code); 159 } 160 161 static inline u8 mbpf_src(const struct nfp_insn_meta *meta) 162 { 163 return BPF_SRC(meta->insn.code); 164 } 165 166 static inline u8 mbpf_op(const struct nfp_insn_meta *meta) 167 { 168 return BPF_OP(meta->insn.code); 169 } 170 171 static inline u8 mbpf_mode(const struct nfp_insn_meta *meta) 172 { 173 return BPF_MODE(meta->insn.code); 174 } 175 176 static inline bool is_mbpf_load(const struct nfp_insn_meta *meta) 177 { 178 return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_LDX | BPF_MEM); 179 } 180 181 static inline bool is_mbpf_store(const struct nfp_insn_meta *meta) 182 { 183 return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_STX | BPF_MEM); 184 } 185 186 /** 187 * struct nfp_prog - nfp BPF program 188 * @bpf: backpointer to the bpf app priv structure 189 * @prog: machine code 190 * @prog_len: number of valid instructions in @prog array 191 * @__prog_alloc_len: alloc size of @prog array 192 * @verifier_meta: temporary storage for verifier's insn meta 193 * @type: BPF program type 194 * @start_off: address of the first instruction in the memory 195 * @last_bpf_off: address of the last instruction translated from BPF 196 * @tgt_out: jump target for normal exit 197 * @tgt_abort: jump target for abort (e.g. access outside of packet buffer) 198 * @tgt_done: jump target to get the next packet 199 * @n_translated: number of successfully translated instructions (for errors) 200 * @error: error code if something went wrong 201 * @stack_depth: max stack depth from the verifier 202 * @adjust_head_location: if program has single adjust head call - the insn no. 203 * @insns: list of BPF instruction wrappers (struct nfp_insn_meta) 204 */ 205 struct nfp_prog { 206 struct nfp_app_bpf *bpf; 207 208 u64 *prog; 209 unsigned int prog_len; 210 unsigned int __prog_alloc_len; 211 212 struct nfp_insn_meta *verifier_meta; 213 214 enum bpf_prog_type type; 215 216 unsigned int start_off; 217 unsigned int last_bpf_off; 218 unsigned int tgt_out; 219 unsigned int tgt_abort; 220 unsigned int tgt_done; 221 222 unsigned int n_translated; 223 int error; 224 225 unsigned int stack_depth; 226 unsigned int adjust_head_location; 227 228 struct list_head insns; 229 }; 230 231 int nfp_bpf_jit(struct nfp_prog *prog); 232 233 extern const struct bpf_ext_analyzer_ops nfp_bpf_analyzer_ops; 234 235 struct netdev_bpf; 236 struct nfp_app; 237 struct nfp_net; 238 239 int nfp_net_bpf_offload(struct nfp_net *nn, struct bpf_prog *prog, 240 bool old_prog); 241 242 int nfp_bpf_verifier_prep(struct nfp_app *app, struct nfp_net *nn, 243 struct netdev_bpf *bpf); 244 int nfp_bpf_translate(struct nfp_app *app, struct nfp_net *nn, 245 struct bpf_prog *prog); 246 int nfp_bpf_destroy(struct nfp_app *app, struct nfp_net *nn, 247 struct bpf_prog *prog); 248 struct nfp_insn_meta * 249 nfp_bpf_goto_meta(struct nfp_prog *nfp_prog, struct nfp_insn_meta *meta, 250 unsigned int insn_idx, unsigned int n_insns); 251 #endif 252