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