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> 392ca71441SJakub Kicinski #include <linux/bpf_verifier.h> 40d9ae7f2bSJakub Kicinski #include <linux/list.h> 41d9ae7f2bSJakub Kicinski #include <linux/types.h> 42d9ae7f2bSJakub Kicinski 43b3f868dfSJakub Kicinski #include "../nfp_asm.h" 44c66a9cf4SJakub Kicinski #include "../nfp_net.h" 45c66a9cf4SJakub Kicinski 46d9ae7f2bSJakub Kicinski /* For branch fixup logic use up-most byte of branch instruction as scratch 47d9ae7f2bSJakub Kicinski * area. Remember to clear this before sending instructions to HW! 48d9ae7f2bSJakub Kicinski */ 49d9ae7f2bSJakub Kicinski #define OP_BR_SPECIAL 0xff00000000000000ULL 50d9ae7f2bSJakub Kicinski 51d9ae7f2bSJakub Kicinski enum br_special { 52d9ae7f2bSJakub Kicinski OP_BR_NORMAL = 0, 53d9ae7f2bSJakub Kicinski OP_BR_GO_OUT, 54d9ae7f2bSJakub Kicinski OP_BR_GO_ABORT, 55d9ae7f2bSJakub Kicinski }; 56d9ae7f2bSJakub Kicinski 57d9ae7f2bSJakub Kicinski enum static_regs { 5818e53b6cSJakub Kicinski STATIC_REG_IMM = 21, /* Bank AB */ 5918e53b6cSJakub Kicinski STATIC_REG_PKT_LEN = 22, /* Bank B */ 6018e53b6cSJakub Kicinski }; 6118e53b6cSJakub Kicinski 6218e53b6cSJakub Kicinski enum pkt_vec { 6318e53b6cSJakub Kicinski PKT_VEC_PKT_LEN = 0, 6418e53b6cSJakub Kicinski PKT_VEC_PKT_PTR = 2, 65d9ae7f2bSJakub Kicinski }; 66d9ae7f2bSJakub Kicinski 67d9ae7f2bSJakub Kicinski enum nfp_bpf_action_type { 68d9ae7f2bSJakub Kicinski NN_ACT_TC_DROP, 69d9ae7f2bSJakub Kicinski NN_ACT_TC_REDIR, 70d9ae7f2bSJakub Kicinski NN_ACT_DIRECT, 71d9ae7f2bSJakub Kicinski NN_ACT_XDP, 72d9ae7f2bSJakub Kicinski }; 73d9ae7f2bSJakub Kicinski 7418e53b6cSJakub Kicinski #define pv_len(np) reg_lm(1, PKT_VEC_PKT_LEN) 7518e53b6cSJakub Kicinski #define pv_ctm_ptr(np) reg_lm(1, PKT_VEC_PKT_PTR) 7618e53b6cSJakub Kicinski 7718e53b6cSJakub Kicinski #define plen_reg(np) reg_b(STATIC_REG_PKT_LEN) 7818e53b6cSJakub Kicinski #define pptr_reg(np) pv_ctm_ptr(np) 7918e53b6cSJakub Kicinski #define imm_a(np) reg_a(STATIC_REG_IMM) 8018e53b6cSJakub Kicinski #define imm_b(np) reg_b(STATIC_REG_IMM) 8118e53b6cSJakub Kicinski #define imm_both(np) reg_both(STATIC_REG_IMM) 82d9ae7f2bSJakub Kicinski 83509144e2SJakub Kicinski #define NFP_BPF_ABI_FLAGS reg_imm(0) 84d9ae7f2bSJakub Kicinski #define NFP_BPF_ABI_FLAG_MARK 1 85d9ae7f2bSJakub Kicinski 86d9ae7f2bSJakub Kicinski struct nfp_prog; 87d9ae7f2bSJakub Kicinski struct nfp_insn_meta; 88d9ae7f2bSJakub Kicinski typedef int (*instr_cb_t)(struct nfp_prog *, struct nfp_insn_meta *); 89d9ae7f2bSJakub Kicinski 90d9ae7f2bSJakub Kicinski #define nfp_prog_first_meta(nfp_prog) \ 91d9ae7f2bSJakub Kicinski list_first_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 92d9ae7f2bSJakub Kicinski #define nfp_prog_last_meta(nfp_prog) \ 93d9ae7f2bSJakub Kicinski list_last_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 94d9ae7f2bSJakub Kicinski #define nfp_meta_next(meta) list_next_entry(meta, l) 95d9ae7f2bSJakub Kicinski #define nfp_meta_prev(meta) list_prev_entry(meta, l) 96d9ae7f2bSJakub Kicinski 97d9ae7f2bSJakub Kicinski /** 98d9ae7f2bSJakub Kicinski * struct nfp_insn_meta - BPF instruction wrapper 99d9ae7f2bSJakub Kicinski * @insn: BPF instruction 1002ca71441SJakub Kicinski * @ptr: pointer type for memory operations 101d9ae7f2bSJakub Kicinski * @off: index of first generated machine instruction (in nfp_prog.prog) 102d9ae7f2bSJakub Kicinski * @n: eBPF instruction number 103d9ae7f2bSJakub Kicinski * @skip: skip this instruction (optimized out) 104d9ae7f2bSJakub Kicinski * @double_cb: callback for second part of the instruction 105d9ae7f2bSJakub Kicinski * @l: link on nfp_prog->insns list 106d9ae7f2bSJakub Kicinski */ 107d9ae7f2bSJakub Kicinski struct nfp_insn_meta { 108d9ae7f2bSJakub Kicinski struct bpf_insn insn; 1092ca71441SJakub Kicinski struct bpf_reg_state ptr; 110d9ae7f2bSJakub Kicinski unsigned int off; 111d9ae7f2bSJakub Kicinski unsigned short n; 112d9ae7f2bSJakub Kicinski bool skip; 113d9ae7f2bSJakub Kicinski instr_cb_t double_cb; 114d9ae7f2bSJakub Kicinski 115d9ae7f2bSJakub Kicinski struct list_head l; 116d9ae7f2bSJakub Kicinski }; 117d9ae7f2bSJakub Kicinski 118d9ae7f2bSJakub Kicinski #define BPF_SIZE_MASK 0x18 119d9ae7f2bSJakub Kicinski 120d9ae7f2bSJakub Kicinski static inline u8 mbpf_class(const struct nfp_insn_meta *meta) 121d9ae7f2bSJakub Kicinski { 122d9ae7f2bSJakub Kicinski return BPF_CLASS(meta->insn.code); 123d9ae7f2bSJakub Kicinski } 124d9ae7f2bSJakub Kicinski 125d9ae7f2bSJakub Kicinski static inline u8 mbpf_src(const struct nfp_insn_meta *meta) 126d9ae7f2bSJakub Kicinski { 127d9ae7f2bSJakub Kicinski return BPF_SRC(meta->insn.code); 128d9ae7f2bSJakub Kicinski } 129d9ae7f2bSJakub Kicinski 130d9ae7f2bSJakub Kicinski static inline u8 mbpf_op(const struct nfp_insn_meta *meta) 131d9ae7f2bSJakub Kicinski { 132d9ae7f2bSJakub Kicinski return BPF_OP(meta->insn.code); 133d9ae7f2bSJakub Kicinski } 134d9ae7f2bSJakub Kicinski 135d9ae7f2bSJakub Kicinski static inline u8 mbpf_mode(const struct nfp_insn_meta *meta) 136d9ae7f2bSJakub Kicinski { 137d9ae7f2bSJakub Kicinski return BPF_MODE(meta->insn.code); 138d9ae7f2bSJakub Kicinski } 139d9ae7f2bSJakub Kicinski 140d9ae7f2bSJakub Kicinski /** 141d9ae7f2bSJakub Kicinski * struct nfp_prog - nfp BPF program 142d9ae7f2bSJakub Kicinski * @prog: machine code 143d9ae7f2bSJakub Kicinski * @prog_len: number of valid instructions in @prog array 144d9ae7f2bSJakub Kicinski * @__prog_alloc_len: alloc size of @prog array 145d9ae7f2bSJakub Kicinski * @act: BPF program/action type (TC DA, TC with action, XDP etc.) 146d9ae7f2bSJakub Kicinski * @num_regs: number of registers used by this program 147d9ae7f2bSJakub Kicinski * @regs_per_thread: number of basic registers allocated per thread 148d9ae7f2bSJakub Kicinski * @start_off: address of the first instruction in the memory 149d9ae7f2bSJakub Kicinski * @tgt_out: jump target for normal exit 150d9ae7f2bSJakub Kicinski * @tgt_abort: jump target for abort (e.g. access outside of packet buffer) 151d9ae7f2bSJakub Kicinski * @tgt_done: jump target to get the next packet 152d9ae7f2bSJakub Kicinski * @n_translated: number of successfully translated instructions (for errors) 153d9ae7f2bSJakub Kicinski * @error: error code if something went wrong 154d9ae7f2bSJakub Kicinski * @insns: list of BPF instruction wrappers (struct nfp_insn_meta) 155d9ae7f2bSJakub Kicinski */ 156d9ae7f2bSJakub Kicinski struct nfp_prog { 157d9ae7f2bSJakub Kicinski u64 *prog; 158d9ae7f2bSJakub Kicinski unsigned int prog_len; 159d9ae7f2bSJakub Kicinski unsigned int __prog_alloc_len; 160d9ae7f2bSJakub Kicinski 161d9ae7f2bSJakub Kicinski enum nfp_bpf_action_type act; 162d9ae7f2bSJakub Kicinski 163d9ae7f2bSJakub Kicinski unsigned int num_regs; 164d9ae7f2bSJakub Kicinski unsigned int regs_per_thread; 165d9ae7f2bSJakub Kicinski 166d9ae7f2bSJakub Kicinski unsigned int start_off; 167d9ae7f2bSJakub Kicinski unsigned int tgt_out; 168d9ae7f2bSJakub Kicinski unsigned int tgt_abort; 169d9ae7f2bSJakub Kicinski unsigned int tgt_done; 170d9ae7f2bSJakub Kicinski 171d9ae7f2bSJakub Kicinski unsigned int n_translated; 172d9ae7f2bSJakub Kicinski int error; 173d9ae7f2bSJakub Kicinski 174d9ae7f2bSJakub Kicinski struct list_head insns; 175d9ae7f2bSJakub Kicinski }; 176d9ae7f2bSJakub Kicinski 177d9ae7f2bSJakub Kicinski struct nfp_bpf_result { 178d9ae7f2bSJakub Kicinski unsigned int n_instr; 179d9ae7f2bSJakub Kicinski bool dense_mode; 180d9ae7f2bSJakub Kicinski }; 181d9ae7f2bSJakub Kicinski 182d9ae7f2bSJakub Kicinski int 183d9ae7f2bSJakub Kicinski nfp_bpf_jit(struct bpf_prog *filter, void *prog, enum nfp_bpf_action_type act, 184d9ae7f2bSJakub Kicinski unsigned int prog_start, unsigned int prog_done, 185d9ae7f2bSJakub Kicinski unsigned int prog_sz, struct nfp_bpf_result *res); 186d9ae7f2bSJakub Kicinski 187d9ae7f2bSJakub Kicinski int nfp_prog_verify(struct nfp_prog *nfp_prog, struct bpf_prog *prog); 188d9ae7f2bSJakub Kicinski 189bb45e51cSJakub Kicinski struct nfp_net; 190bb45e51cSJakub Kicinski struct tc_cls_bpf_offload; 191bb45e51cSJakub Kicinski 192c66a9cf4SJakub Kicinski /** 193c66a9cf4SJakub Kicinski * struct nfp_net_bpf_priv - per-vNIC BPF private data 194c66a9cf4SJakub Kicinski * @rx_filter: Filter offload statistics - dropped packets/bytes 195c66a9cf4SJakub Kicinski * @rx_filter_prev: Filter offload statistics - values from previous update 196c66a9cf4SJakub Kicinski * @rx_filter_change: Jiffies when statistics last changed 197c66a9cf4SJakub Kicinski * @rx_filter_stats_timer: Timer for polling filter offload statistics 198c66a9cf4SJakub Kicinski * @rx_filter_lock: Lock protecting timer state changes (teardown) 199c66a9cf4SJakub Kicinski */ 200c66a9cf4SJakub Kicinski struct nfp_net_bpf_priv { 201c66a9cf4SJakub Kicinski struct nfp_stat_pair rx_filter, rx_filter_prev; 202c66a9cf4SJakub Kicinski unsigned long rx_filter_change; 203c66a9cf4SJakub Kicinski struct timer_list rx_filter_stats_timer; 204c66a9cf4SJakub Kicinski spinlock_t rx_filter_lock; 205c66a9cf4SJakub Kicinski }; 206c66a9cf4SJakub Kicinski 207bb45e51cSJakub Kicinski int nfp_net_bpf_offload(struct nfp_net *nn, struct tc_cls_bpf_offload *cls_bpf); 208c66a9cf4SJakub Kicinski void nfp_net_filter_stats_timer(unsigned long data); 209bb45e51cSJakub Kicinski 210d9ae7f2bSJakub Kicinski #endif 211