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 452314fe9eSJakub Kicinski /* For relocation logic use up-most byte of branch instruction as scratch 46d9ae7f2bSJakub Kicinski * area. Remember to clear this before sending instructions to HW! 47d9ae7f2bSJakub Kicinski */ 482314fe9eSJakub Kicinski #define OP_RELO_TYPE 0xff00000000000000ULL 49d9ae7f2bSJakub Kicinski 502314fe9eSJakub Kicinski enum nfp_relo_type { 512314fe9eSJakub Kicinski RELO_NONE = 0, 522314fe9eSJakub Kicinski /* standard internal jumps */ 532314fe9eSJakub Kicinski RELO_BR_REL, 542314fe9eSJakub Kicinski /* internal jumps to parts of the outro */ 552314fe9eSJakub Kicinski RELO_BR_GO_OUT, 562314fe9eSJakub Kicinski RELO_BR_GO_ABORT, 572314fe9eSJakub Kicinski /* external jumps to fixed addresses */ 582314fe9eSJakub Kicinski RELO_BR_NEXT_PKT, 59d9ae7f2bSJakub Kicinski }; 60d9ae7f2bSJakub Kicinski 61e84797feSJakub Kicinski /* To make absolute relocated branches (branches other than RELO_BR_REL) 62e84797feSJakub Kicinski * distinguishable in user space dumps from normal jumps, add a large offset 63e84797feSJakub Kicinski * to them. 64e84797feSJakub Kicinski */ 65e84797feSJakub Kicinski #define BR_OFF_RELO 15000 66e84797feSJakub Kicinski 67d9ae7f2bSJakub Kicinski enum static_regs { 6818e53b6cSJakub Kicinski STATIC_REG_IMM = 21, /* Bank AB */ 69d3488480SJakub Kicinski STATIC_REG_STACK = 22, /* Bank A */ 7018e53b6cSJakub Kicinski STATIC_REG_PKT_LEN = 22, /* Bank B */ 7118e53b6cSJakub Kicinski }; 7218e53b6cSJakub Kicinski 7318e53b6cSJakub Kicinski enum pkt_vec { 7418e53b6cSJakub Kicinski PKT_VEC_PKT_LEN = 0, 7518e53b6cSJakub Kicinski PKT_VEC_PKT_PTR = 2, 76d9ae7f2bSJakub Kicinski }; 77d9ae7f2bSJakub Kicinski 7818e53b6cSJakub Kicinski #define pv_len(np) reg_lm(1, PKT_VEC_PKT_LEN) 7918e53b6cSJakub Kicinski #define pv_ctm_ptr(np) reg_lm(1, PKT_VEC_PKT_PTR) 8018e53b6cSJakub Kicinski 81d3488480SJakub Kicinski #define stack_reg(np) reg_a(STATIC_REG_STACK) 82d3488480SJakub Kicinski #define stack_imm(np) imm_b(np) 8318e53b6cSJakub Kicinski #define plen_reg(np) reg_b(STATIC_REG_PKT_LEN) 8418e53b6cSJakub Kicinski #define pptr_reg(np) pv_ctm_ptr(np) 8518e53b6cSJakub Kicinski #define imm_a(np) reg_a(STATIC_REG_IMM) 8618e53b6cSJakub Kicinski #define imm_b(np) reg_b(STATIC_REG_IMM) 8718e53b6cSJakub Kicinski #define imm_both(np) reg_both(STATIC_REG_IMM) 88d9ae7f2bSJakub Kicinski 89509144e2SJakub Kicinski #define NFP_BPF_ABI_FLAGS reg_imm(0) 90d9ae7f2bSJakub Kicinski #define NFP_BPF_ABI_FLAG_MARK 1 91d9ae7f2bSJakub Kicinski 9277a844eeSJakub Kicinski /** 9377a844eeSJakub Kicinski * struct nfp_app_bpf - bpf app priv structure 9477a844eeSJakub Kicinski * @app: backpointer to the app 950d49eaf4SJakub Kicinski * 960d49eaf4SJakub Kicinski * @adjust_head: adjust head capability 970d49eaf4SJakub Kicinski * @flags: extra flags for adjust head 980d49eaf4SJakub Kicinski * @off_min: minimal packet offset within buffer required 990d49eaf4SJakub Kicinski * @off_max: maximum packet offset within buffer required 1008231f844SJakub Kicinski * @guaranteed_sub: amount of negative adjustment guaranteed possible 1018231f844SJakub Kicinski * @guaranteed_add: amount of positive adjustment guaranteed possible 10277a844eeSJakub Kicinski */ 10377a844eeSJakub Kicinski struct nfp_app_bpf { 10477a844eeSJakub Kicinski struct nfp_app *app; 1050d49eaf4SJakub Kicinski 1060d49eaf4SJakub Kicinski struct nfp_bpf_cap_adjust_head { 1070d49eaf4SJakub Kicinski u32 flags; 1080d49eaf4SJakub Kicinski int off_min; 1090d49eaf4SJakub Kicinski int off_max; 1108231f844SJakub Kicinski int guaranteed_sub; 1118231f844SJakub Kicinski int guaranteed_add; 1120d49eaf4SJakub Kicinski } adjust_head; 11377a844eeSJakub Kicinski }; 11477a844eeSJakub Kicinski 115d9ae7f2bSJakub Kicinski struct nfp_prog; 116d9ae7f2bSJakub Kicinski struct nfp_insn_meta; 117d9ae7f2bSJakub Kicinski typedef int (*instr_cb_t)(struct nfp_prog *, struct nfp_insn_meta *); 118d9ae7f2bSJakub Kicinski 119d9ae7f2bSJakub Kicinski #define nfp_prog_first_meta(nfp_prog) \ 120d9ae7f2bSJakub Kicinski list_first_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 121d9ae7f2bSJakub Kicinski #define nfp_prog_last_meta(nfp_prog) \ 122d9ae7f2bSJakub Kicinski list_last_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 123d9ae7f2bSJakub Kicinski #define nfp_meta_next(meta) list_next_entry(meta, l) 124d9ae7f2bSJakub Kicinski #define nfp_meta_prev(meta) list_prev_entry(meta, l) 125d9ae7f2bSJakub Kicinski 126a09d5c52SJiong Wang #define FLAG_INSN_IS_JUMP_DST BIT(0) 127a09d5c52SJiong Wang 128d9ae7f2bSJakub Kicinski /** 129d9ae7f2bSJakub Kicinski * struct nfp_insn_meta - BPF instruction wrapper 130d9ae7f2bSJakub Kicinski * @insn: BPF instruction 1312ca71441SJakub Kicinski * @ptr: pointer type for memory operations 1329879a381SJiong Wang * @ldst_gather_len: memcpy length gathered from load/store sequence 1339879a381SJiong Wang * @paired_st: the paired store insn at the head of the sequence 1348231f844SJakub Kicinski * @arg2: arg2 for call instructions 135b14157eeSJakub Kicinski * @ptr_not_const: pointer is not always constant 1365b674140SJiong Wang * @jmp_dst: destination info for jump instructions 137d9ae7f2bSJakub Kicinski * @off: index of first generated machine instruction (in nfp_prog.prog) 138d9ae7f2bSJakub Kicinski * @n: eBPF instruction number 139a09d5c52SJiong Wang * @flags: eBPF instruction extra optimization flags 140d9ae7f2bSJakub Kicinski * @skip: skip this instruction (optimized out) 141d9ae7f2bSJakub Kicinski * @double_cb: callback for second part of the instruction 142d9ae7f2bSJakub Kicinski * @l: link on nfp_prog->insns list 143d9ae7f2bSJakub Kicinski */ 144d9ae7f2bSJakub Kicinski struct nfp_insn_meta { 145d9ae7f2bSJakub Kicinski struct bpf_insn insn; 1465b674140SJiong Wang union { 1475b674140SJiong Wang struct { 1482ca71441SJakub Kicinski struct bpf_reg_state ptr; 1499879a381SJiong Wang struct bpf_insn *paired_st; 1509879a381SJiong Wang s16 ldst_gather_len; 151b14157eeSJakub Kicinski bool ptr_not_const; 1525b674140SJiong Wang }; 1535b674140SJiong Wang struct nfp_insn_meta *jmp_dst; 1548231f844SJakub Kicinski struct bpf_reg_state arg2; 1555b674140SJiong Wang }; 156d9ae7f2bSJakub Kicinski unsigned int off; 157d9ae7f2bSJakub Kicinski unsigned short n; 158a09d5c52SJiong Wang unsigned short flags; 159d9ae7f2bSJakub Kicinski bool skip; 160d9ae7f2bSJakub Kicinski instr_cb_t double_cb; 161d9ae7f2bSJakub Kicinski 162d9ae7f2bSJakub Kicinski struct list_head l; 163d9ae7f2bSJakub Kicinski }; 164d9ae7f2bSJakub Kicinski 165d9ae7f2bSJakub Kicinski #define BPF_SIZE_MASK 0x18 166d9ae7f2bSJakub Kicinski 167d9ae7f2bSJakub Kicinski static inline u8 mbpf_class(const struct nfp_insn_meta *meta) 168d9ae7f2bSJakub Kicinski { 169d9ae7f2bSJakub Kicinski return BPF_CLASS(meta->insn.code); 170d9ae7f2bSJakub Kicinski } 171d9ae7f2bSJakub Kicinski 172d9ae7f2bSJakub Kicinski static inline u8 mbpf_src(const struct nfp_insn_meta *meta) 173d9ae7f2bSJakub Kicinski { 174d9ae7f2bSJakub Kicinski return BPF_SRC(meta->insn.code); 175d9ae7f2bSJakub Kicinski } 176d9ae7f2bSJakub Kicinski 177d9ae7f2bSJakub Kicinski static inline u8 mbpf_op(const struct nfp_insn_meta *meta) 178d9ae7f2bSJakub Kicinski { 179d9ae7f2bSJakub Kicinski return BPF_OP(meta->insn.code); 180d9ae7f2bSJakub Kicinski } 181d9ae7f2bSJakub Kicinski 182d9ae7f2bSJakub Kicinski static inline u8 mbpf_mode(const struct nfp_insn_meta *meta) 183d9ae7f2bSJakub Kicinski { 184d9ae7f2bSJakub Kicinski return BPF_MODE(meta->insn.code); 185d9ae7f2bSJakub Kicinski } 186d9ae7f2bSJakub Kicinski 1875e4d6d20SJiong Wang static inline bool is_mbpf_load(const struct nfp_insn_meta *meta) 1885e4d6d20SJiong Wang { 1895e4d6d20SJiong Wang return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_LDX | BPF_MEM); 1905e4d6d20SJiong Wang } 1915e4d6d20SJiong Wang 1925e4d6d20SJiong Wang static inline bool is_mbpf_store(const struct nfp_insn_meta *meta) 1935e4d6d20SJiong Wang { 1945e4d6d20SJiong Wang return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_STX | BPF_MEM); 1955e4d6d20SJiong Wang } 1965e4d6d20SJiong Wang 197d9ae7f2bSJakub Kicinski /** 198d9ae7f2bSJakub Kicinski * struct nfp_prog - nfp BPF program 19977a844eeSJakub Kicinski * @bpf: backpointer to the bpf app priv structure 200d9ae7f2bSJakub Kicinski * @prog: machine code 201d9ae7f2bSJakub Kicinski * @prog_len: number of valid instructions in @prog array 202d9ae7f2bSJakub Kicinski * @__prog_alloc_len: alloc size of @prog array 203c6c580d7SJakub Kicinski * @verifier_meta: temporary storage for verifier's insn meta 204012bb8a8SJakub Kicinski * @type: BPF program type 205854dc87dSJiong Wang * @last_bpf_off: address of the last instruction translated from BPF 206d9ae7f2bSJakub Kicinski * @tgt_out: jump target for normal exit 207d9ae7f2bSJakub Kicinski * @tgt_abort: jump target for abort (e.g. access outside of packet buffer) 208d9ae7f2bSJakub Kicinski * @n_translated: number of successfully translated instructions (for errors) 209d9ae7f2bSJakub Kicinski * @error: error code if something went wrong 210ee9133a8SJakub Kicinski * @stack_depth: max stack depth from the verifier 2118231f844SJakub Kicinski * @adjust_head_location: if program has single adjust head call - the insn no. 212d9ae7f2bSJakub Kicinski * @insns: list of BPF instruction wrappers (struct nfp_insn_meta) 213d9ae7f2bSJakub Kicinski */ 214d9ae7f2bSJakub Kicinski struct nfp_prog { 21577a844eeSJakub Kicinski struct nfp_app_bpf *bpf; 21677a844eeSJakub Kicinski 217d9ae7f2bSJakub Kicinski u64 *prog; 218d9ae7f2bSJakub Kicinski unsigned int prog_len; 219d9ae7f2bSJakub Kicinski unsigned int __prog_alloc_len; 220d9ae7f2bSJakub Kicinski 221c6c580d7SJakub Kicinski struct nfp_insn_meta *verifier_meta; 222c6c580d7SJakub Kicinski 223012bb8a8SJakub Kicinski enum bpf_prog_type type; 224d9ae7f2bSJakub Kicinski 225854dc87dSJiong Wang unsigned int last_bpf_off; 226d9ae7f2bSJakub Kicinski unsigned int tgt_out; 227d9ae7f2bSJakub Kicinski unsigned int tgt_abort; 228d9ae7f2bSJakub Kicinski 229d9ae7f2bSJakub Kicinski unsigned int n_translated; 230d9ae7f2bSJakub Kicinski int error; 231d9ae7f2bSJakub Kicinski 232ee9133a8SJakub Kicinski unsigned int stack_depth; 2338231f844SJakub Kicinski unsigned int adjust_head_location; 234ee9133a8SJakub Kicinski 235d9ae7f2bSJakub Kicinski struct list_head insns; 236d9ae7f2bSJakub Kicinski }; 237d9ae7f2bSJakub Kicinski 238d3f89b98SJakub Kicinski /** 239d3f89b98SJakub Kicinski * struct nfp_bpf_vnic - per-vNIC BPF priv structure 240d3f89b98SJakub Kicinski * @tc_prog: currently loaded cls_bpf program 2412314fe9eSJakub Kicinski * @start_off: address of the first instruction in the memory 2422314fe9eSJakub Kicinski * @tgt_done: jump target to get the next packet 243d3f89b98SJakub Kicinski */ 244d3f89b98SJakub Kicinski struct nfp_bpf_vnic { 245d3f89b98SJakub Kicinski struct bpf_prog *tc_prog; 2462314fe9eSJakub Kicinski unsigned int start_off; 2472314fe9eSJakub Kicinski unsigned int tgt_done; 248d3f89b98SJakub Kicinski }; 249d3f89b98SJakub Kicinski 2501549921dSJakub Kicinski void nfp_bpf_jit_prepare(struct nfp_prog *nfp_prog, unsigned int cnt); 251c6c580d7SJakub Kicinski int nfp_bpf_jit(struct nfp_prog *prog); 252d9ae7f2bSJakub Kicinski 253cae1927cSJakub Kicinski extern const struct bpf_prog_offload_ops nfp_bpf_analyzer_ops; 254d9ae7f2bSJakub Kicinski 255c6c580d7SJakub Kicinski struct netdev_bpf; 256c6c580d7SJakub Kicinski struct nfp_app; 257bb45e51cSJakub Kicinski struct nfp_net; 258bb45e51cSJakub Kicinski 2599ce7a956SJakub Kicinski int nfp_net_bpf_offload(struct nfp_net *nn, struct bpf_prog *prog, 260e4a91cd5SJakub Kicinski bool old_prog); 261bb45e51cSJakub Kicinski 262c6c580d7SJakub Kicinski int nfp_bpf_verifier_prep(struct nfp_app *app, struct nfp_net *nn, 263c6c580d7SJakub Kicinski struct netdev_bpf *bpf); 264c6c580d7SJakub Kicinski int nfp_bpf_translate(struct nfp_app *app, struct nfp_net *nn, 265c6c580d7SJakub Kicinski struct bpf_prog *prog); 266c6c580d7SJakub Kicinski int nfp_bpf_destroy(struct nfp_app *app, struct nfp_net *nn, 267c6c580d7SJakub Kicinski struct bpf_prog *prog); 2685b674140SJiong Wang struct nfp_insn_meta * 2695b674140SJiong Wang nfp_bpf_goto_meta(struct nfp_prog *nfp_prog, struct nfp_insn_meta *meta, 2705b674140SJiong Wang unsigned int insn_idx, unsigned int n_insns); 2712314fe9eSJakub Kicinski 2722314fe9eSJakub Kicinski void *nfp_bpf_relo_for_vnic(struct nfp_prog *nfp_prog, struct nfp_bpf_vnic *bv); 273d9ae7f2bSJakub Kicinski #endif 274