1d9ae7f2bSJakub Kicinski /* 2854dc87dSJiong Wang * Copyright (C) 2016-2017 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 45d9ae7f2bSJakub Kicinski /* For branch fixup logic use up-most byte of branch instruction as scratch 46d9ae7f2bSJakub Kicinski * area. Remember to clear this before sending instructions to HW! 47d9ae7f2bSJakub Kicinski */ 48d9ae7f2bSJakub Kicinski #define OP_BR_SPECIAL 0xff00000000000000ULL 49d9ae7f2bSJakub Kicinski 50d9ae7f2bSJakub Kicinski enum br_special { 51d9ae7f2bSJakub Kicinski OP_BR_NORMAL = 0, 52d9ae7f2bSJakub Kicinski OP_BR_GO_OUT, 53d9ae7f2bSJakub Kicinski OP_BR_GO_ABORT, 54d9ae7f2bSJakub Kicinski }; 55d9ae7f2bSJakub Kicinski 56d9ae7f2bSJakub Kicinski enum static_regs { 5718e53b6cSJakub Kicinski STATIC_REG_IMM = 21, /* Bank AB */ 58d3488480SJakub Kicinski STATIC_REG_STACK = 22, /* Bank A */ 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 6718e53b6cSJakub Kicinski #define pv_len(np) reg_lm(1, PKT_VEC_PKT_LEN) 6818e53b6cSJakub Kicinski #define pv_ctm_ptr(np) reg_lm(1, PKT_VEC_PKT_PTR) 6918e53b6cSJakub Kicinski 70d3488480SJakub Kicinski #define stack_reg(np) reg_a(STATIC_REG_STACK) 71d3488480SJakub Kicinski #define stack_imm(np) imm_b(np) 7218e53b6cSJakub Kicinski #define plen_reg(np) reg_b(STATIC_REG_PKT_LEN) 7318e53b6cSJakub Kicinski #define pptr_reg(np) pv_ctm_ptr(np) 7418e53b6cSJakub Kicinski #define imm_a(np) reg_a(STATIC_REG_IMM) 7518e53b6cSJakub Kicinski #define imm_b(np) reg_b(STATIC_REG_IMM) 7618e53b6cSJakub Kicinski #define imm_both(np) reg_both(STATIC_REG_IMM) 77d9ae7f2bSJakub Kicinski 78509144e2SJakub Kicinski #define NFP_BPF_ABI_FLAGS reg_imm(0) 79d9ae7f2bSJakub Kicinski #define NFP_BPF_ABI_FLAG_MARK 1 80d9ae7f2bSJakub Kicinski 8177a844eeSJakub Kicinski /** 8277a844eeSJakub Kicinski * struct nfp_app_bpf - bpf app priv structure 8377a844eeSJakub Kicinski * @app: backpointer to the app 8477a844eeSJakub Kicinski */ 8577a844eeSJakub Kicinski struct nfp_app_bpf { 8677a844eeSJakub Kicinski struct nfp_app *app; 8777a844eeSJakub Kicinski }; 8877a844eeSJakub Kicinski 89d9ae7f2bSJakub Kicinski struct nfp_prog; 90d9ae7f2bSJakub Kicinski struct nfp_insn_meta; 91d9ae7f2bSJakub Kicinski typedef int (*instr_cb_t)(struct nfp_prog *, struct nfp_insn_meta *); 92d9ae7f2bSJakub Kicinski 93d9ae7f2bSJakub Kicinski #define nfp_prog_first_meta(nfp_prog) \ 94d9ae7f2bSJakub Kicinski list_first_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 95d9ae7f2bSJakub Kicinski #define nfp_prog_last_meta(nfp_prog) \ 96d9ae7f2bSJakub Kicinski list_last_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 97d9ae7f2bSJakub Kicinski #define nfp_meta_next(meta) list_next_entry(meta, l) 98d9ae7f2bSJakub Kicinski #define nfp_meta_prev(meta) list_prev_entry(meta, l) 99d9ae7f2bSJakub Kicinski 100a09d5c52SJiong Wang #define FLAG_INSN_IS_JUMP_DST BIT(0) 101a09d5c52SJiong Wang 102d9ae7f2bSJakub Kicinski /** 103d9ae7f2bSJakub Kicinski * struct nfp_insn_meta - BPF instruction wrapper 104d9ae7f2bSJakub Kicinski * @insn: BPF instruction 1052ca71441SJakub Kicinski * @ptr: pointer type for memory operations 1069879a381SJiong Wang * @ldst_gather_len: memcpy length gathered from load/store sequence 1079879a381SJiong Wang * @paired_st: the paired store insn at the head of the sequence 108b14157eeSJakub Kicinski * @ptr_not_const: pointer is not always constant 1095b674140SJiong Wang * @jmp_dst: destination info for jump instructions 110d9ae7f2bSJakub Kicinski * @off: index of first generated machine instruction (in nfp_prog.prog) 111d9ae7f2bSJakub Kicinski * @n: eBPF instruction number 112a09d5c52SJiong Wang * @flags: eBPF instruction extra optimization flags 113d9ae7f2bSJakub Kicinski * @skip: skip this instruction (optimized out) 114d9ae7f2bSJakub Kicinski * @double_cb: callback for second part of the instruction 115d9ae7f2bSJakub Kicinski * @l: link on nfp_prog->insns list 116d9ae7f2bSJakub Kicinski */ 117d9ae7f2bSJakub Kicinski struct nfp_insn_meta { 118d9ae7f2bSJakub Kicinski struct bpf_insn insn; 1195b674140SJiong Wang union { 1205b674140SJiong Wang struct { 1212ca71441SJakub Kicinski struct bpf_reg_state ptr; 1229879a381SJiong Wang struct bpf_insn *paired_st; 1239879a381SJiong Wang s16 ldst_gather_len; 124b14157eeSJakub Kicinski bool ptr_not_const; 1255b674140SJiong Wang }; 1265b674140SJiong Wang struct nfp_insn_meta *jmp_dst; 1275b674140SJiong Wang }; 128d9ae7f2bSJakub Kicinski unsigned int off; 129d9ae7f2bSJakub Kicinski unsigned short n; 130a09d5c52SJiong Wang unsigned short flags; 131d9ae7f2bSJakub Kicinski bool skip; 132d9ae7f2bSJakub Kicinski instr_cb_t double_cb; 133d9ae7f2bSJakub Kicinski 134d9ae7f2bSJakub Kicinski struct list_head l; 135d9ae7f2bSJakub Kicinski }; 136d9ae7f2bSJakub Kicinski 137d9ae7f2bSJakub Kicinski #define BPF_SIZE_MASK 0x18 138d9ae7f2bSJakub Kicinski 139d9ae7f2bSJakub Kicinski static inline u8 mbpf_class(const struct nfp_insn_meta *meta) 140d9ae7f2bSJakub Kicinski { 141d9ae7f2bSJakub Kicinski return BPF_CLASS(meta->insn.code); 142d9ae7f2bSJakub Kicinski } 143d9ae7f2bSJakub Kicinski 144d9ae7f2bSJakub Kicinski static inline u8 mbpf_src(const struct nfp_insn_meta *meta) 145d9ae7f2bSJakub Kicinski { 146d9ae7f2bSJakub Kicinski return BPF_SRC(meta->insn.code); 147d9ae7f2bSJakub Kicinski } 148d9ae7f2bSJakub Kicinski 149d9ae7f2bSJakub Kicinski static inline u8 mbpf_op(const struct nfp_insn_meta *meta) 150d9ae7f2bSJakub Kicinski { 151d9ae7f2bSJakub Kicinski return BPF_OP(meta->insn.code); 152d9ae7f2bSJakub Kicinski } 153d9ae7f2bSJakub Kicinski 154d9ae7f2bSJakub Kicinski static inline u8 mbpf_mode(const struct nfp_insn_meta *meta) 155d9ae7f2bSJakub Kicinski { 156d9ae7f2bSJakub Kicinski return BPF_MODE(meta->insn.code); 157d9ae7f2bSJakub Kicinski } 158d9ae7f2bSJakub Kicinski 1595e4d6d20SJiong Wang static inline bool is_mbpf_load(const struct nfp_insn_meta *meta) 1605e4d6d20SJiong Wang { 1615e4d6d20SJiong Wang return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_LDX | BPF_MEM); 1625e4d6d20SJiong Wang } 1635e4d6d20SJiong Wang 1645e4d6d20SJiong Wang static inline bool is_mbpf_store(const struct nfp_insn_meta *meta) 1655e4d6d20SJiong Wang { 1665e4d6d20SJiong Wang return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_STX | BPF_MEM); 1675e4d6d20SJiong Wang } 1685e4d6d20SJiong Wang 169d9ae7f2bSJakub Kicinski /** 170d9ae7f2bSJakub Kicinski * struct nfp_prog - nfp BPF program 17177a844eeSJakub Kicinski * @bpf: backpointer to the bpf app priv structure 172d9ae7f2bSJakub Kicinski * @prog: machine code 173d9ae7f2bSJakub Kicinski * @prog_len: number of valid instructions in @prog array 174d9ae7f2bSJakub Kicinski * @__prog_alloc_len: alloc size of @prog array 175c6c580d7SJakub Kicinski * @verifier_meta: temporary storage for verifier's insn meta 176012bb8a8SJakub Kicinski * @type: BPF program type 177d9ae7f2bSJakub Kicinski * @start_off: address of the first instruction in the memory 178854dc87dSJiong Wang * @last_bpf_off: address of the last instruction translated from BPF 179d9ae7f2bSJakub Kicinski * @tgt_out: jump target for normal exit 180d9ae7f2bSJakub Kicinski * @tgt_abort: jump target for abort (e.g. access outside of packet buffer) 181d9ae7f2bSJakub Kicinski * @tgt_done: jump target to get the next packet 182d9ae7f2bSJakub Kicinski * @n_translated: number of successfully translated instructions (for errors) 183d9ae7f2bSJakub Kicinski * @error: error code if something went wrong 184ee9133a8SJakub Kicinski * @stack_depth: max stack depth from the verifier 185d9ae7f2bSJakub Kicinski * @insns: list of BPF instruction wrappers (struct nfp_insn_meta) 186d9ae7f2bSJakub Kicinski */ 187d9ae7f2bSJakub Kicinski struct nfp_prog { 18877a844eeSJakub Kicinski struct nfp_app_bpf *bpf; 18977a844eeSJakub Kicinski 190d9ae7f2bSJakub Kicinski u64 *prog; 191d9ae7f2bSJakub Kicinski unsigned int prog_len; 192d9ae7f2bSJakub Kicinski unsigned int __prog_alloc_len; 193d9ae7f2bSJakub Kicinski 194c6c580d7SJakub Kicinski struct nfp_insn_meta *verifier_meta; 195c6c580d7SJakub Kicinski 196012bb8a8SJakub Kicinski enum bpf_prog_type type; 197d9ae7f2bSJakub Kicinski 198d9ae7f2bSJakub Kicinski unsigned int start_off; 199854dc87dSJiong Wang unsigned int last_bpf_off; 200d9ae7f2bSJakub Kicinski unsigned int tgt_out; 201d9ae7f2bSJakub Kicinski unsigned int tgt_abort; 202d9ae7f2bSJakub Kicinski unsigned int tgt_done; 203d9ae7f2bSJakub Kicinski 204d9ae7f2bSJakub Kicinski unsigned int n_translated; 205d9ae7f2bSJakub Kicinski int error; 206d9ae7f2bSJakub Kicinski 207ee9133a8SJakub Kicinski unsigned int stack_depth; 208ee9133a8SJakub Kicinski 209d9ae7f2bSJakub Kicinski struct list_head insns; 210d9ae7f2bSJakub Kicinski }; 211d9ae7f2bSJakub Kicinski 212c6c580d7SJakub Kicinski int nfp_bpf_jit(struct nfp_prog *prog); 213d9ae7f2bSJakub Kicinski 214c6c580d7SJakub Kicinski extern const struct bpf_ext_analyzer_ops nfp_bpf_analyzer_ops; 215d9ae7f2bSJakub Kicinski 216c6c580d7SJakub Kicinski struct netdev_bpf; 217c6c580d7SJakub Kicinski struct nfp_app; 218bb45e51cSJakub Kicinski struct nfp_net; 219bb45e51cSJakub Kicinski 2209ce7a956SJakub Kicinski int nfp_net_bpf_offload(struct nfp_net *nn, struct bpf_prog *prog, 221e4a91cd5SJakub Kicinski bool old_prog); 222bb45e51cSJakub Kicinski 223c6c580d7SJakub Kicinski int nfp_bpf_verifier_prep(struct nfp_app *app, struct nfp_net *nn, 224c6c580d7SJakub Kicinski struct netdev_bpf *bpf); 225c6c580d7SJakub Kicinski int nfp_bpf_translate(struct nfp_app *app, struct nfp_net *nn, 226c6c580d7SJakub Kicinski struct bpf_prog *prog); 227c6c580d7SJakub Kicinski int nfp_bpf_destroy(struct nfp_app *app, struct nfp_net *nn, 228c6c580d7SJakub Kicinski struct bpf_prog *prog); 2295b674140SJiong Wang struct nfp_insn_meta * 2305b674140SJiong Wang nfp_bpf_goto_meta(struct nfp_prog *nfp_prog, struct nfp_insn_meta *meta, 2315b674140SJiong Wang unsigned int insn_idx, unsigned int n_insns); 232d9ae7f2bSJakub Kicinski #endif 233