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 #include "../nfp_asm.h" 43 #include "../nfp_net.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_PKT = 1, 58 #define REG_PKT_BANK ALU_DST_A 59 STATIC_REG_IMM = 2, /* Bank AB */ 60 }; 61 62 enum nfp_bpf_action_type { 63 NN_ACT_TC_DROP, 64 NN_ACT_TC_REDIR, 65 NN_ACT_DIRECT, 66 NN_ACT_XDP, 67 }; 68 69 #define pkt_reg(np) reg_a((np)->regs_per_thread - STATIC_REG_PKT) 70 #define imm_a(np) reg_a((np)->regs_per_thread - STATIC_REG_IMM) 71 #define imm_b(np) reg_b((np)->regs_per_thread - STATIC_REG_IMM) 72 #define imm_both(np) reg_both((np)->regs_per_thread - STATIC_REG_IMM) 73 74 #define NFP_BPF_ABI_FLAGS reg_nnr(0) 75 #define NFP_BPF_ABI_FLAG_MARK 1 76 #define NFP_BPF_ABI_MARK reg_nnr(1) 77 #define NFP_BPF_ABI_PKT reg_nnr(2) 78 #define NFP_BPF_ABI_LEN reg_nnr(3) 79 80 struct nfp_prog; 81 struct nfp_insn_meta; 82 typedef int (*instr_cb_t)(struct nfp_prog *, struct nfp_insn_meta *); 83 84 #define nfp_prog_first_meta(nfp_prog) \ 85 list_first_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 86 #define nfp_prog_last_meta(nfp_prog) \ 87 list_last_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 88 #define nfp_meta_next(meta) list_next_entry(meta, l) 89 #define nfp_meta_prev(meta) list_prev_entry(meta, l) 90 91 /** 92 * struct nfp_insn_meta - BPF instruction wrapper 93 * @insn: BPF instruction 94 * @off: index of first generated machine instruction (in nfp_prog.prog) 95 * @n: eBPF instruction number 96 * @skip: skip this instruction (optimized out) 97 * @double_cb: callback for second part of the instruction 98 * @l: link on nfp_prog->insns list 99 */ 100 struct nfp_insn_meta { 101 struct bpf_insn insn; 102 unsigned int off; 103 unsigned short n; 104 bool skip; 105 instr_cb_t double_cb; 106 107 struct list_head l; 108 }; 109 110 #define BPF_SIZE_MASK 0x18 111 112 static inline u8 mbpf_class(const struct nfp_insn_meta *meta) 113 { 114 return BPF_CLASS(meta->insn.code); 115 } 116 117 static inline u8 mbpf_src(const struct nfp_insn_meta *meta) 118 { 119 return BPF_SRC(meta->insn.code); 120 } 121 122 static inline u8 mbpf_op(const struct nfp_insn_meta *meta) 123 { 124 return BPF_OP(meta->insn.code); 125 } 126 127 static inline u8 mbpf_mode(const struct nfp_insn_meta *meta) 128 { 129 return BPF_MODE(meta->insn.code); 130 } 131 132 /** 133 * struct nfp_prog - nfp BPF program 134 * @prog: machine code 135 * @prog_len: number of valid instructions in @prog array 136 * @__prog_alloc_len: alloc size of @prog array 137 * @act: BPF program/action type (TC DA, TC with action, XDP etc.) 138 * @num_regs: number of registers used by this program 139 * @regs_per_thread: number of basic registers allocated per thread 140 * @start_off: address of the first instruction in the memory 141 * @tgt_out: jump target for normal exit 142 * @tgt_abort: jump target for abort (e.g. access outside of packet buffer) 143 * @tgt_done: jump target to get the next packet 144 * @n_translated: number of successfully translated instructions (for errors) 145 * @error: error code if something went wrong 146 * @insns: list of BPF instruction wrappers (struct nfp_insn_meta) 147 */ 148 struct nfp_prog { 149 u64 *prog; 150 unsigned int prog_len; 151 unsigned int __prog_alloc_len; 152 153 enum nfp_bpf_action_type act; 154 155 unsigned int num_regs; 156 unsigned int regs_per_thread; 157 158 unsigned int start_off; 159 unsigned int tgt_out; 160 unsigned int tgt_abort; 161 unsigned int tgt_done; 162 163 unsigned int n_translated; 164 int error; 165 166 struct list_head insns; 167 }; 168 169 struct nfp_bpf_result { 170 unsigned int n_instr; 171 bool dense_mode; 172 }; 173 174 int 175 nfp_bpf_jit(struct bpf_prog *filter, void *prog, enum nfp_bpf_action_type act, 176 unsigned int prog_start, unsigned int prog_done, 177 unsigned int prog_sz, struct nfp_bpf_result *res); 178 179 int nfp_prog_verify(struct nfp_prog *nfp_prog, struct bpf_prog *prog); 180 181 struct nfp_net; 182 struct tc_cls_bpf_offload; 183 184 /** 185 * struct nfp_net_bpf_priv - per-vNIC BPF private data 186 * @rx_filter: Filter offload statistics - dropped packets/bytes 187 * @rx_filter_prev: Filter offload statistics - values from previous update 188 * @rx_filter_change: Jiffies when statistics last changed 189 * @rx_filter_stats_timer: Timer for polling filter offload statistics 190 * @rx_filter_lock: Lock protecting timer state changes (teardown) 191 */ 192 struct nfp_net_bpf_priv { 193 struct nfp_stat_pair rx_filter, rx_filter_prev; 194 unsigned long rx_filter_change; 195 struct timer_list rx_filter_stats_timer; 196 spinlock_t rx_filter_lock; 197 }; 198 199 int nfp_net_bpf_offload(struct nfp_net *nn, struct tc_cls_bpf_offload *cls_bpf); 200 void nfp_net_filter_stats_timer(unsigned long data); 201 202 #endif 203