1d9ae7f2bSJakub Kicinski /* 2d9ae7f2bSJakub Kicinski * Copyright (C) 2016 Netronome Systems, Inc. 3d9ae7f2bSJakub Kicinski * 4d9ae7f2bSJakub Kicinski * This software is dual licensed under the GNU General License Version 2, 5d9ae7f2bSJakub Kicinski * June 1991 as shown in the file COPYING in the top-level directory of this 6d9ae7f2bSJakub Kicinski * source tree or the BSD 2-Clause License provided below. You have the 7d9ae7f2bSJakub Kicinski * option to license this software under the complete terms of either license. 8d9ae7f2bSJakub Kicinski * 9d9ae7f2bSJakub Kicinski * The BSD 2-Clause License: 10d9ae7f2bSJakub Kicinski * 11d9ae7f2bSJakub Kicinski * Redistribution and use in source and binary forms, with or 12d9ae7f2bSJakub Kicinski * without modification, are permitted provided that the following 13d9ae7f2bSJakub Kicinski * conditions are met: 14d9ae7f2bSJakub Kicinski * 15d9ae7f2bSJakub Kicinski * 1. Redistributions of source code must retain the above 16d9ae7f2bSJakub Kicinski * copyright notice, this list of conditions and the following 17d9ae7f2bSJakub Kicinski * disclaimer. 18d9ae7f2bSJakub Kicinski * 19d9ae7f2bSJakub Kicinski * 2. Redistributions in binary form must reproduce the above 20d9ae7f2bSJakub Kicinski * copyright notice, this list of conditions and the following 21d9ae7f2bSJakub Kicinski * disclaimer in the documentation and/or other materials 22d9ae7f2bSJakub Kicinski * provided with the distribution. 23d9ae7f2bSJakub Kicinski * 24d9ae7f2bSJakub Kicinski * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 25d9ae7f2bSJakub Kicinski * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 26d9ae7f2bSJakub Kicinski * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 27d9ae7f2bSJakub Kicinski * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 28d9ae7f2bSJakub Kicinski * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 29d9ae7f2bSJakub Kicinski * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 30d9ae7f2bSJakub Kicinski * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 31d9ae7f2bSJakub Kicinski * SOFTWARE. 32d9ae7f2bSJakub Kicinski */ 33d9ae7f2bSJakub Kicinski 34d9ae7f2bSJakub Kicinski #ifndef __NFP_BPF_H__ 35d9ae7f2bSJakub Kicinski #define __NFP_BPF_H__ 1 36d9ae7f2bSJakub Kicinski 37d9ae7f2bSJakub Kicinski #include <linux/bitfield.h> 38d9ae7f2bSJakub Kicinski #include <linux/bpf.h> 39d9ae7f2bSJakub Kicinski #include <linux/list.h> 40d9ae7f2bSJakub Kicinski #include <linux/types.h> 41d9ae7f2bSJakub Kicinski 42c66a9cf4SJakub Kicinski #include "../nfp_net.h" 43c66a9cf4SJakub Kicinski 44d9ae7f2bSJakub Kicinski /* For branch fixup logic use up-most byte of branch instruction as scratch 45d9ae7f2bSJakub Kicinski * area. Remember to clear this before sending instructions to HW! 46d9ae7f2bSJakub Kicinski */ 47d9ae7f2bSJakub Kicinski #define OP_BR_SPECIAL 0xff00000000000000ULL 48d9ae7f2bSJakub Kicinski 49d9ae7f2bSJakub Kicinski enum br_special { 50d9ae7f2bSJakub Kicinski OP_BR_NORMAL = 0, 51d9ae7f2bSJakub Kicinski OP_BR_GO_OUT, 52d9ae7f2bSJakub Kicinski OP_BR_GO_ABORT, 53d9ae7f2bSJakub Kicinski }; 54d9ae7f2bSJakub Kicinski 55d9ae7f2bSJakub Kicinski enum static_regs { 56d9ae7f2bSJakub Kicinski STATIC_REG_PKT = 1, 57d9ae7f2bSJakub Kicinski #define REG_PKT_BANK ALU_DST_A 58d9ae7f2bSJakub Kicinski STATIC_REG_IMM = 2, /* Bank AB */ 59d9ae7f2bSJakub Kicinski }; 60d9ae7f2bSJakub Kicinski 61d9ae7f2bSJakub Kicinski enum nfp_bpf_action_type { 62d9ae7f2bSJakub Kicinski NN_ACT_TC_DROP, 63d9ae7f2bSJakub Kicinski NN_ACT_TC_REDIR, 64d9ae7f2bSJakub Kicinski NN_ACT_DIRECT, 65d9ae7f2bSJakub Kicinski NN_ACT_XDP, 66d9ae7f2bSJakub Kicinski }; 67d9ae7f2bSJakub Kicinski 68d9ae7f2bSJakub Kicinski /* Software register representation, hardware encoding in asm.h */ 69d9ae7f2bSJakub Kicinski #define NN_REG_TYPE GENMASK(31, 24) 70d9ae7f2bSJakub Kicinski #define NN_REG_VAL GENMASK(7, 0) 71d9ae7f2bSJakub Kicinski 72d9ae7f2bSJakub Kicinski enum nfp_bpf_reg_type { 73d9ae7f2bSJakub Kicinski NN_REG_GPR_A = BIT(0), 74d9ae7f2bSJakub Kicinski NN_REG_GPR_B = BIT(1), 75d9ae7f2bSJakub Kicinski NN_REG_NNR = BIT(2), 76d9ae7f2bSJakub Kicinski NN_REG_XFER = BIT(3), 77d9ae7f2bSJakub Kicinski NN_REG_IMM = BIT(4), 78d9ae7f2bSJakub Kicinski NN_REG_NONE = BIT(5), 79d9ae7f2bSJakub Kicinski }; 80d9ae7f2bSJakub Kicinski 81d9ae7f2bSJakub Kicinski #define NN_REG_GPR_BOTH (NN_REG_GPR_A | NN_REG_GPR_B) 82d9ae7f2bSJakub Kicinski 83d9ae7f2bSJakub Kicinski #define reg_both(x) ((x) | FIELD_PREP(NN_REG_TYPE, NN_REG_GPR_BOTH)) 84d9ae7f2bSJakub Kicinski #define reg_a(x) ((x) | FIELD_PREP(NN_REG_TYPE, NN_REG_GPR_A)) 85d9ae7f2bSJakub Kicinski #define reg_b(x) ((x) | FIELD_PREP(NN_REG_TYPE, NN_REG_GPR_B)) 86d9ae7f2bSJakub Kicinski #define reg_nnr(x) ((x) | FIELD_PREP(NN_REG_TYPE, NN_REG_NNR)) 87d9ae7f2bSJakub Kicinski #define reg_xfer(x) ((x) | FIELD_PREP(NN_REG_TYPE, NN_REG_XFER)) 88d9ae7f2bSJakub Kicinski #define reg_imm(x) ((x) | FIELD_PREP(NN_REG_TYPE, NN_REG_IMM)) 89d9ae7f2bSJakub Kicinski #define reg_none() (FIELD_PREP(NN_REG_TYPE, NN_REG_NONE)) 90d9ae7f2bSJakub Kicinski 91d9ae7f2bSJakub Kicinski #define pkt_reg(np) reg_a((np)->regs_per_thread - STATIC_REG_PKT) 92d9ae7f2bSJakub Kicinski #define imm_a(np) reg_a((np)->regs_per_thread - STATIC_REG_IMM) 93d9ae7f2bSJakub Kicinski #define imm_b(np) reg_b((np)->regs_per_thread - STATIC_REG_IMM) 94d9ae7f2bSJakub Kicinski #define imm_both(np) reg_both((np)->regs_per_thread - STATIC_REG_IMM) 95d9ae7f2bSJakub Kicinski 96d9ae7f2bSJakub Kicinski #define NFP_BPF_ABI_FLAGS reg_nnr(0) 97d9ae7f2bSJakub Kicinski #define NFP_BPF_ABI_FLAG_MARK 1 98d9ae7f2bSJakub Kicinski #define NFP_BPF_ABI_MARK reg_nnr(1) 99d9ae7f2bSJakub Kicinski #define NFP_BPF_ABI_PKT reg_nnr(2) 100d9ae7f2bSJakub Kicinski #define NFP_BPF_ABI_LEN reg_nnr(3) 101d9ae7f2bSJakub Kicinski 102d9ae7f2bSJakub Kicinski struct nfp_prog; 103d9ae7f2bSJakub Kicinski struct nfp_insn_meta; 104d9ae7f2bSJakub Kicinski typedef int (*instr_cb_t)(struct nfp_prog *, struct nfp_insn_meta *); 105d9ae7f2bSJakub Kicinski 106d9ae7f2bSJakub Kicinski #define nfp_prog_first_meta(nfp_prog) \ 107d9ae7f2bSJakub Kicinski list_first_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 108d9ae7f2bSJakub Kicinski #define nfp_prog_last_meta(nfp_prog) \ 109d9ae7f2bSJakub Kicinski list_last_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 110d9ae7f2bSJakub Kicinski #define nfp_meta_next(meta) list_next_entry(meta, l) 111d9ae7f2bSJakub Kicinski #define nfp_meta_prev(meta) list_prev_entry(meta, l) 112d9ae7f2bSJakub Kicinski 113d9ae7f2bSJakub Kicinski /** 114d9ae7f2bSJakub Kicinski * struct nfp_insn_meta - BPF instruction wrapper 115d9ae7f2bSJakub Kicinski * @insn: BPF instruction 116d9ae7f2bSJakub Kicinski * @off: index of first generated machine instruction (in nfp_prog.prog) 117d9ae7f2bSJakub Kicinski * @n: eBPF instruction number 118d9ae7f2bSJakub Kicinski * @skip: skip this instruction (optimized out) 119d9ae7f2bSJakub Kicinski * @double_cb: callback for second part of the instruction 120d9ae7f2bSJakub Kicinski * @l: link on nfp_prog->insns list 121d9ae7f2bSJakub Kicinski */ 122d9ae7f2bSJakub Kicinski struct nfp_insn_meta { 123d9ae7f2bSJakub Kicinski struct bpf_insn insn; 124d9ae7f2bSJakub Kicinski unsigned int off; 125d9ae7f2bSJakub Kicinski unsigned short n; 126d9ae7f2bSJakub Kicinski bool skip; 127d9ae7f2bSJakub Kicinski instr_cb_t double_cb; 128d9ae7f2bSJakub Kicinski 129d9ae7f2bSJakub Kicinski struct list_head l; 130d9ae7f2bSJakub Kicinski }; 131d9ae7f2bSJakub Kicinski 132d9ae7f2bSJakub Kicinski #define BPF_SIZE_MASK 0x18 133d9ae7f2bSJakub Kicinski 134d9ae7f2bSJakub Kicinski static inline u8 mbpf_class(const struct nfp_insn_meta *meta) 135d9ae7f2bSJakub Kicinski { 136d9ae7f2bSJakub Kicinski return BPF_CLASS(meta->insn.code); 137d9ae7f2bSJakub Kicinski } 138d9ae7f2bSJakub Kicinski 139d9ae7f2bSJakub Kicinski static inline u8 mbpf_src(const struct nfp_insn_meta *meta) 140d9ae7f2bSJakub Kicinski { 141d9ae7f2bSJakub Kicinski return BPF_SRC(meta->insn.code); 142d9ae7f2bSJakub Kicinski } 143d9ae7f2bSJakub Kicinski 144d9ae7f2bSJakub Kicinski static inline u8 mbpf_op(const struct nfp_insn_meta *meta) 145d9ae7f2bSJakub Kicinski { 146d9ae7f2bSJakub Kicinski return BPF_OP(meta->insn.code); 147d9ae7f2bSJakub Kicinski } 148d9ae7f2bSJakub Kicinski 149d9ae7f2bSJakub Kicinski static inline u8 mbpf_mode(const struct nfp_insn_meta *meta) 150d9ae7f2bSJakub Kicinski { 151d9ae7f2bSJakub Kicinski return BPF_MODE(meta->insn.code); 152d9ae7f2bSJakub Kicinski } 153d9ae7f2bSJakub Kicinski 154d9ae7f2bSJakub Kicinski /** 155d9ae7f2bSJakub Kicinski * struct nfp_prog - nfp BPF program 156d9ae7f2bSJakub Kicinski * @prog: machine code 157d9ae7f2bSJakub Kicinski * @prog_len: number of valid instructions in @prog array 158d9ae7f2bSJakub Kicinski * @__prog_alloc_len: alloc size of @prog array 159d9ae7f2bSJakub Kicinski * @act: BPF program/action type (TC DA, TC with action, XDP etc.) 160d9ae7f2bSJakub Kicinski * @num_regs: number of registers used by this program 161d9ae7f2bSJakub Kicinski * @regs_per_thread: number of basic registers allocated per thread 162d9ae7f2bSJakub Kicinski * @start_off: address of the first instruction in the memory 163d9ae7f2bSJakub Kicinski * @tgt_out: jump target for normal exit 164d9ae7f2bSJakub Kicinski * @tgt_abort: jump target for abort (e.g. access outside of packet buffer) 165d9ae7f2bSJakub Kicinski * @tgt_done: jump target to get the next packet 166d9ae7f2bSJakub Kicinski * @n_translated: number of successfully translated instructions (for errors) 167d9ae7f2bSJakub Kicinski * @error: error code if something went wrong 168d9ae7f2bSJakub Kicinski * @insns: list of BPF instruction wrappers (struct nfp_insn_meta) 169d9ae7f2bSJakub Kicinski */ 170d9ae7f2bSJakub Kicinski struct nfp_prog { 171d9ae7f2bSJakub Kicinski u64 *prog; 172d9ae7f2bSJakub Kicinski unsigned int prog_len; 173d9ae7f2bSJakub Kicinski unsigned int __prog_alloc_len; 174d9ae7f2bSJakub Kicinski 175d9ae7f2bSJakub Kicinski enum nfp_bpf_action_type act; 176d9ae7f2bSJakub Kicinski 177d9ae7f2bSJakub Kicinski unsigned int num_regs; 178d9ae7f2bSJakub Kicinski unsigned int regs_per_thread; 179d9ae7f2bSJakub Kicinski 180d9ae7f2bSJakub Kicinski unsigned int start_off; 181d9ae7f2bSJakub Kicinski unsigned int tgt_out; 182d9ae7f2bSJakub Kicinski unsigned int tgt_abort; 183d9ae7f2bSJakub Kicinski unsigned int tgt_done; 184d9ae7f2bSJakub Kicinski 185d9ae7f2bSJakub Kicinski unsigned int n_translated; 186d9ae7f2bSJakub Kicinski int error; 187d9ae7f2bSJakub Kicinski 188d9ae7f2bSJakub Kicinski struct list_head insns; 189d9ae7f2bSJakub Kicinski }; 190d9ae7f2bSJakub Kicinski 191d9ae7f2bSJakub Kicinski struct nfp_bpf_result { 192d9ae7f2bSJakub Kicinski unsigned int n_instr; 193d9ae7f2bSJakub Kicinski bool dense_mode; 194d9ae7f2bSJakub Kicinski }; 195d9ae7f2bSJakub Kicinski 196d9ae7f2bSJakub Kicinski int 197d9ae7f2bSJakub Kicinski nfp_bpf_jit(struct bpf_prog *filter, void *prog, enum nfp_bpf_action_type act, 198d9ae7f2bSJakub Kicinski unsigned int prog_start, unsigned int prog_done, 199d9ae7f2bSJakub Kicinski unsigned int prog_sz, struct nfp_bpf_result *res); 200d9ae7f2bSJakub Kicinski 201d9ae7f2bSJakub Kicinski int nfp_prog_verify(struct nfp_prog *nfp_prog, struct bpf_prog *prog); 202d9ae7f2bSJakub Kicinski 203bb45e51cSJakub Kicinski struct nfp_net; 204bb45e51cSJakub Kicinski struct tc_cls_bpf_offload; 205bb45e51cSJakub Kicinski 206c66a9cf4SJakub Kicinski /** 207c66a9cf4SJakub Kicinski * struct nfp_net_bpf_priv - per-vNIC BPF private data 208c66a9cf4SJakub Kicinski * @rx_filter: Filter offload statistics - dropped packets/bytes 209c66a9cf4SJakub Kicinski * @rx_filter_prev: Filter offload statistics - values from previous update 210c66a9cf4SJakub Kicinski * @rx_filter_change: Jiffies when statistics last changed 211c66a9cf4SJakub Kicinski * @rx_filter_stats_timer: Timer for polling filter offload statistics 212c66a9cf4SJakub Kicinski * @rx_filter_lock: Lock protecting timer state changes (teardown) 213c66a9cf4SJakub Kicinski */ 214c66a9cf4SJakub Kicinski struct nfp_net_bpf_priv { 215c66a9cf4SJakub Kicinski struct nfp_stat_pair rx_filter, rx_filter_prev; 216c66a9cf4SJakub Kicinski unsigned long rx_filter_change; 217c66a9cf4SJakub Kicinski struct timer_list rx_filter_stats_timer; 218c66a9cf4SJakub Kicinski spinlock_t rx_filter_lock; 219c66a9cf4SJakub Kicinski }; 220c66a9cf4SJakub Kicinski 221bb45e51cSJakub Kicinski int nfp_net_bpf_offload(struct nfp_net *nn, struct tc_cls_bpf_offload *cls_bpf); 222c66a9cf4SJakub Kicinski void nfp_net_filter_stats_timer(unsigned long data); 223bb45e51cSJakub Kicinski 224d9ae7f2bSJakub Kicinski #endif 225