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