1 /* 2 * Copyright (C) 2016 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/list.h> 40 #include <linux/types.h> 41 42 /* For branch fixup logic use up-most byte of branch instruction as scratch 43 * area. Remember to clear this before sending instructions to HW! 44 */ 45 #define OP_BR_SPECIAL 0xff00000000000000ULL 46 47 enum br_special { 48 OP_BR_NORMAL = 0, 49 OP_BR_GO_OUT, 50 OP_BR_GO_ABORT, 51 }; 52 53 enum static_regs { 54 STATIC_REG_PKT = 1, 55 #define REG_PKT_BANK ALU_DST_A 56 STATIC_REG_IMM = 2, /* Bank AB */ 57 }; 58 59 enum nfp_bpf_action_type { 60 NN_ACT_TC_DROP, 61 NN_ACT_TC_REDIR, 62 NN_ACT_DIRECT, 63 NN_ACT_XDP, 64 }; 65 66 /* Software register representation, hardware encoding in asm.h */ 67 #define NN_REG_TYPE GENMASK(31, 24) 68 #define NN_REG_VAL GENMASK(7, 0) 69 70 enum nfp_bpf_reg_type { 71 NN_REG_GPR_A = BIT(0), 72 NN_REG_GPR_B = BIT(1), 73 NN_REG_NNR = BIT(2), 74 NN_REG_XFER = BIT(3), 75 NN_REG_IMM = BIT(4), 76 NN_REG_NONE = BIT(5), 77 }; 78 79 #define NN_REG_GPR_BOTH (NN_REG_GPR_A | NN_REG_GPR_B) 80 81 #define reg_both(x) ((x) | FIELD_PREP(NN_REG_TYPE, NN_REG_GPR_BOTH)) 82 #define reg_a(x) ((x) | FIELD_PREP(NN_REG_TYPE, NN_REG_GPR_A)) 83 #define reg_b(x) ((x) | FIELD_PREP(NN_REG_TYPE, NN_REG_GPR_B)) 84 #define reg_nnr(x) ((x) | FIELD_PREP(NN_REG_TYPE, NN_REG_NNR)) 85 #define reg_xfer(x) ((x) | FIELD_PREP(NN_REG_TYPE, NN_REG_XFER)) 86 #define reg_imm(x) ((x) | FIELD_PREP(NN_REG_TYPE, NN_REG_IMM)) 87 #define reg_none() (FIELD_PREP(NN_REG_TYPE, NN_REG_NONE)) 88 89 #define pkt_reg(np) reg_a((np)->regs_per_thread - STATIC_REG_PKT) 90 #define imm_a(np) reg_a((np)->regs_per_thread - STATIC_REG_IMM) 91 #define imm_b(np) reg_b((np)->regs_per_thread - STATIC_REG_IMM) 92 #define imm_both(np) reg_both((np)->regs_per_thread - STATIC_REG_IMM) 93 94 #define NFP_BPF_ABI_FLAGS reg_nnr(0) 95 #define NFP_BPF_ABI_FLAG_MARK 1 96 #define NFP_BPF_ABI_MARK reg_nnr(1) 97 #define NFP_BPF_ABI_PKT reg_nnr(2) 98 #define NFP_BPF_ABI_LEN reg_nnr(3) 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 /** 112 * struct nfp_insn_meta - BPF instruction wrapper 113 * @insn: BPF instruction 114 * @off: index of first generated machine instruction (in nfp_prog.prog) 115 * @n: eBPF instruction number 116 * @skip: skip this instruction (optimized out) 117 * @double_cb: callback for second part of the instruction 118 * @l: link on nfp_prog->insns list 119 */ 120 struct nfp_insn_meta { 121 struct bpf_insn insn; 122 unsigned int off; 123 unsigned short n; 124 bool skip; 125 instr_cb_t double_cb; 126 127 struct list_head l; 128 }; 129 130 #define BPF_SIZE_MASK 0x18 131 132 static inline u8 mbpf_class(const struct nfp_insn_meta *meta) 133 { 134 return BPF_CLASS(meta->insn.code); 135 } 136 137 static inline u8 mbpf_src(const struct nfp_insn_meta *meta) 138 { 139 return BPF_SRC(meta->insn.code); 140 } 141 142 static inline u8 mbpf_op(const struct nfp_insn_meta *meta) 143 { 144 return BPF_OP(meta->insn.code); 145 } 146 147 static inline u8 mbpf_mode(const struct nfp_insn_meta *meta) 148 { 149 return BPF_MODE(meta->insn.code); 150 } 151 152 /** 153 * struct nfp_prog - nfp BPF program 154 * @prog: machine code 155 * @prog_len: number of valid instructions in @prog array 156 * @__prog_alloc_len: alloc size of @prog array 157 * @act: BPF program/action type (TC DA, TC with action, XDP etc.) 158 * @num_regs: number of registers used by this program 159 * @regs_per_thread: number of basic registers allocated per thread 160 * @start_off: address of the first instruction in the memory 161 * @tgt_out: jump target for normal exit 162 * @tgt_abort: jump target for abort (e.g. access outside of packet buffer) 163 * @tgt_done: jump target to get the next packet 164 * @n_translated: number of successfully translated instructions (for errors) 165 * @error: error code if something went wrong 166 * @insns: list of BPF instruction wrappers (struct nfp_insn_meta) 167 */ 168 struct nfp_prog { 169 u64 *prog; 170 unsigned int prog_len; 171 unsigned int __prog_alloc_len; 172 173 enum nfp_bpf_action_type act; 174 175 unsigned int num_regs; 176 unsigned int regs_per_thread; 177 178 unsigned int start_off; 179 unsigned int tgt_out; 180 unsigned int tgt_abort; 181 unsigned int tgt_done; 182 183 unsigned int n_translated; 184 int error; 185 186 struct list_head insns; 187 }; 188 189 struct nfp_bpf_result { 190 unsigned int n_instr; 191 bool dense_mode; 192 }; 193 194 int 195 nfp_bpf_jit(struct bpf_prog *filter, void *prog, enum nfp_bpf_action_type act, 196 unsigned int prog_start, unsigned int prog_done, 197 unsigned int prog_sz, struct nfp_bpf_result *res); 198 199 int nfp_prog_verify(struct nfp_prog *nfp_prog, struct bpf_prog *prog); 200 201 #endif 202