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> 40d48ae231SJakub Kicinski #include <linux/kernel.h> 41d9ae7f2bSJakub Kicinski #include <linux/list.h> 42d48ae231SJakub Kicinski #include <linux/skbuff.h> 43d9ae7f2bSJakub Kicinski #include <linux/types.h> 44d48ae231SJakub Kicinski #include <linux/wait.h> 45d9ae7f2bSJakub Kicinski 46b3f868dfSJakub Kicinski #include "../nfp_asm.h" 47d48ae231SJakub Kicinski #include "fw.h" 48c66a9cf4SJakub Kicinski 492314fe9eSJakub Kicinski /* For relocation logic use up-most byte of branch instruction as scratch 50d9ae7f2bSJakub Kicinski * area. Remember to clear this before sending instructions to HW! 51d9ae7f2bSJakub Kicinski */ 522314fe9eSJakub Kicinski #define OP_RELO_TYPE 0xff00000000000000ULL 53d9ae7f2bSJakub Kicinski 542314fe9eSJakub Kicinski enum nfp_relo_type { 552314fe9eSJakub Kicinski RELO_NONE = 0, 562314fe9eSJakub Kicinski /* standard internal jumps */ 572314fe9eSJakub Kicinski RELO_BR_REL, 582314fe9eSJakub Kicinski /* internal jumps to parts of the outro */ 592314fe9eSJakub Kicinski RELO_BR_GO_OUT, 602314fe9eSJakub Kicinski RELO_BR_GO_ABORT, 612314fe9eSJakub Kicinski /* external jumps to fixed addresses */ 622314fe9eSJakub Kicinski RELO_BR_NEXT_PKT, 63d9ae7f2bSJakub Kicinski }; 64d9ae7f2bSJakub Kicinski 65e84797feSJakub Kicinski /* To make absolute relocated branches (branches other than RELO_BR_REL) 66e84797feSJakub Kicinski * distinguishable in user space dumps from normal jumps, add a large offset 67e84797feSJakub Kicinski * to them. 68e84797feSJakub Kicinski */ 69e84797feSJakub Kicinski #define BR_OFF_RELO 15000 70e84797feSJakub Kicinski 71d9ae7f2bSJakub Kicinski enum static_regs { 7218e53b6cSJakub Kicinski STATIC_REG_IMM = 21, /* Bank AB */ 73d3488480SJakub Kicinski STATIC_REG_STACK = 22, /* Bank A */ 7418e53b6cSJakub Kicinski STATIC_REG_PKT_LEN = 22, /* Bank B */ 7518e53b6cSJakub Kicinski }; 7618e53b6cSJakub Kicinski 7718e53b6cSJakub Kicinski enum pkt_vec { 7818e53b6cSJakub Kicinski PKT_VEC_PKT_LEN = 0, 7918e53b6cSJakub Kicinski PKT_VEC_PKT_PTR = 2, 80d9ae7f2bSJakub Kicinski }; 81d9ae7f2bSJakub Kicinski 8218e53b6cSJakub Kicinski #define pv_len(np) reg_lm(1, PKT_VEC_PKT_LEN) 8318e53b6cSJakub Kicinski #define pv_ctm_ptr(np) reg_lm(1, PKT_VEC_PKT_PTR) 8418e53b6cSJakub Kicinski 85d3488480SJakub Kicinski #define stack_reg(np) reg_a(STATIC_REG_STACK) 86d3488480SJakub Kicinski #define stack_imm(np) imm_b(np) 8718e53b6cSJakub Kicinski #define plen_reg(np) reg_b(STATIC_REG_PKT_LEN) 8818e53b6cSJakub Kicinski #define pptr_reg(np) pv_ctm_ptr(np) 8918e53b6cSJakub Kicinski #define imm_a(np) reg_a(STATIC_REG_IMM) 9018e53b6cSJakub Kicinski #define imm_b(np) reg_b(STATIC_REG_IMM) 9118e53b6cSJakub Kicinski #define imm_both(np) reg_both(STATIC_REG_IMM) 92d9ae7f2bSJakub Kicinski 93509144e2SJakub Kicinski #define NFP_BPF_ABI_FLAGS reg_imm(0) 94d9ae7f2bSJakub Kicinski #define NFP_BPF_ABI_FLAG_MARK 1 95d9ae7f2bSJakub Kicinski 9677a844eeSJakub Kicinski /** 9777a844eeSJakub Kicinski * struct nfp_app_bpf - bpf app priv structure 9877a844eeSJakub Kicinski * @app: backpointer to the app 990d49eaf4SJakub Kicinski * 100d48ae231SJakub Kicinski * @tag_allocator: bitmap of control message tags in use 101d48ae231SJakub Kicinski * @tag_alloc_next: next tag bit to allocate 102d48ae231SJakub Kicinski * @tag_alloc_last: next tag bit to be freed 103d48ae231SJakub Kicinski * 104d48ae231SJakub Kicinski * @cmsg_replies: received cmsg replies waiting to be consumed 105d48ae231SJakub Kicinski * @cmsg_wq: work queue for waiting for cmsg replies 106d48ae231SJakub Kicinski * 1074da98eeaSJakub Kicinski * @map_list: list of offloaded maps 1084da98eeaSJakub Kicinski * 1090d49eaf4SJakub Kicinski * @adjust_head: adjust head capability 1100d49eaf4SJakub Kicinski * @flags: extra flags for adjust head 1110d49eaf4SJakub Kicinski * @off_min: minimal packet offset within buffer required 1120d49eaf4SJakub Kicinski * @off_max: maximum packet offset within buffer required 1138231f844SJakub Kicinski * @guaranteed_sub: amount of negative adjustment guaranteed possible 1148231f844SJakub Kicinski * @guaranteed_add: amount of positive adjustment guaranteed possible 11577a844eeSJakub Kicinski */ 11677a844eeSJakub Kicinski struct nfp_app_bpf { 11777a844eeSJakub Kicinski struct nfp_app *app; 1180d49eaf4SJakub Kicinski 119d48ae231SJakub Kicinski DECLARE_BITMAP(tag_allocator, U16_MAX + 1); 120d48ae231SJakub Kicinski u16 tag_alloc_next; 121d48ae231SJakub Kicinski u16 tag_alloc_last; 122d48ae231SJakub Kicinski 123d48ae231SJakub Kicinski struct sk_buff_head cmsg_replies; 124d48ae231SJakub Kicinski struct wait_queue_head cmsg_wq; 125d48ae231SJakub Kicinski 1264da98eeaSJakub Kicinski struct list_head map_list; 1274da98eeaSJakub Kicinski 1280d49eaf4SJakub Kicinski struct nfp_bpf_cap_adjust_head { 1290d49eaf4SJakub Kicinski u32 flags; 1300d49eaf4SJakub Kicinski int off_min; 1310d49eaf4SJakub Kicinski int off_max; 1328231f844SJakub Kicinski int guaranteed_sub; 1338231f844SJakub Kicinski int guaranteed_add; 1340d49eaf4SJakub Kicinski } adjust_head; 13577a844eeSJakub Kicinski }; 13677a844eeSJakub Kicinski 1374da98eeaSJakub Kicinski /** 1384da98eeaSJakub Kicinski * struct nfp_bpf_map - private per-map data attached to BPF maps for offload 1394da98eeaSJakub Kicinski * @offmap: pointer to the offloaded BPF map 1404da98eeaSJakub Kicinski * @bpf: back pointer to bpf app private structure 1414da98eeaSJakub Kicinski * @tid: table id identifying map on datapath 1424da98eeaSJakub Kicinski * @l: link on the nfp_app_bpf->map_list list 1434da98eeaSJakub Kicinski */ 1444da98eeaSJakub Kicinski struct nfp_bpf_map { 1454da98eeaSJakub Kicinski struct bpf_offloaded_map *offmap; 1464da98eeaSJakub Kicinski struct nfp_app_bpf *bpf; 1474da98eeaSJakub Kicinski u32 tid; 1484da98eeaSJakub Kicinski struct list_head l; 1494da98eeaSJakub Kicinski }; 1504da98eeaSJakub Kicinski 151d9ae7f2bSJakub Kicinski struct nfp_prog; 152d9ae7f2bSJakub Kicinski struct nfp_insn_meta; 153d9ae7f2bSJakub Kicinski typedef int (*instr_cb_t)(struct nfp_prog *, struct nfp_insn_meta *); 154d9ae7f2bSJakub Kicinski 155d9ae7f2bSJakub Kicinski #define nfp_prog_first_meta(nfp_prog) \ 156d9ae7f2bSJakub Kicinski list_first_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 157d9ae7f2bSJakub Kicinski #define nfp_prog_last_meta(nfp_prog) \ 158d9ae7f2bSJakub Kicinski list_last_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 159d9ae7f2bSJakub Kicinski #define nfp_meta_next(meta) list_next_entry(meta, l) 160d9ae7f2bSJakub Kicinski #define nfp_meta_prev(meta) list_prev_entry(meta, l) 161d9ae7f2bSJakub Kicinski 162a09d5c52SJiong Wang #define FLAG_INSN_IS_JUMP_DST BIT(0) 163a09d5c52SJiong Wang 164d9ae7f2bSJakub Kicinski /** 165d9ae7f2bSJakub Kicinski * struct nfp_insn_meta - BPF instruction wrapper 166d9ae7f2bSJakub Kicinski * @insn: BPF instruction 1672ca71441SJakub Kicinski * @ptr: pointer type for memory operations 1689879a381SJiong Wang * @ldst_gather_len: memcpy length gathered from load/store sequence 1699879a381SJiong Wang * @paired_st: the paired store insn at the head of the sequence 1708231f844SJakub Kicinski * @arg2: arg2 for call instructions 171b14157eeSJakub Kicinski * @ptr_not_const: pointer is not always constant 1725b674140SJiong Wang * @jmp_dst: destination info for jump instructions 173d9ae7f2bSJakub Kicinski * @off: index of first generated machine instruction (in nfp_prog.prog) 174d9ae7f2bSJakub Kicinski * @n: eBPF instruction number 175a09d5c52SJiong Wang * @flags: eBPF instruction extra optimization flags 176d9ae7f2bSJakub Kicinski * @skip: skip this instruction (optimized out) 177d9ae7f2bSJakub Kicinski * @double_cb: callback for second part of the instruction 178d9ae7f2bSJakub Kicinski * @l: link on nfp_prog->insns list 179d9ae7f2bSJakub Kicinski */ 180d9ae7f2bSJakub Kicinski struct nfp_insn_meta { 181d9ae7f2bSJakub Kicinski struct bpf_insn insn; 1825b674140SJiong Wang union { 1835b674140SJiong Wang struct { 1842ca71441SJakub Kicinski struct bpf_reg_state ptr; 1859879a381SJiong Wang struct bpf_insn *paired_st; 1869879a381SJiong Wang s16 ldst_gather_len; 187b14157eeSJakub Kicinski bool ptr_not_const; 1885b674140SJiong Wang }; 1895b674140SJiong Wang struct nfp_insn_meta *jmp_dst; 1908231f844SJakub Kicinski struct bpf_reg_state arg2; 1915b674140SJiong Wang }; 192d9ae7f2bSJakub Kicinski unsigned int off; 193d9ae7f2bSJakub Kicinski unsigned short n; 194a09d5c52SJiong Wang unsigned short flags; 195d9ae7f2bSJakub Kicinski bool skip; 196d9ae7f2bSJakub Kicinski instr_cb_t double_cb; 197d9ae7f2bSJakub Kicinski 198d9ae7f2bSJakub Kicinski struct list_head l; 199d9ae7f2bSJakub Kicinski }; 200d9ae7f2bSJakub Kicinski 201d9ae7f2bSJakub Kicinski #define BPF_SIZE_MASK 0x18 202d9ae7f2bSJakub Kicinski 203d9ae7f2bSJakub Kicinski static inline u8 mbpf_class(const struct nfp_insn_meta *meta) 204d9ae7f2bSJakub Kicinski { 205d9ae7f2bSJakub Kicinski return BPF_CLASS(meta->insn.code); 206d9ae7f2bSJakub Kicinski } 207d9ae7f2bSJakub Kicinski 208d9ae7f2bSJakub Kicinski static inline u8 mbpf_src(const struct nfp_insn_meta *meta) 209d9ae7f2bSJakub Kicinski { 210d9ae7f2bSJakub Kicinski return BPF_SRC(meta->insn.code); 211d9ae7f2bSJakub Kicinski } 212d9ae7f2bSJakub Kicinski 213d9ae7f2bSJakub Kicinski static inline u8 mbpf_op(const struct nfp_insn_meta *meta) 214d9ae7f2bSJakub Kicinski { 215d9ae7f2bSJakub Kicinski return BPF_OP(meta->insn.code); 216d9ae7f2bSJakub Kicinski } 217d9ae7f2bSJakub Kicinski 218d9ae7f2bSJakub Kicinski static inline u8 mbpf_mode(const struct nfp_insn_meta *meta) 219d9ae7f2bSJakub Kicinski { 220d9ae7f2bSJakub Kicinski return BPF_MODE(meta->insn.code); 221d9ae7f2bSJakub Kicinski } 222d9ae7f2bSJakub Kicinski 2235e4d6d20SJiong Wang static inline bool is_mbpf_load(const struct nfp_insn_meta *meta) 2245e4d6d20SJiong Wang { 2255e4d6d20SJiong Wang return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_LDX | BPF_MEM); 2265e4d6d20SJiong Wang } 2275e4d6d20SJiong Wang 2285e4d6d20SJiong Wang static inline bool is_mbpf_store(const struct nfp_insn_meta *meta) 2295e4d6d20SJiong Wang { 2305e4d6d20SJiong Wang return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_STX | BPF_MEM); 2315e4d6d20SJiong Wang } 2325e4d6d20SJiong Wang 233d9ae7f2bSJakub Kicinski /** 234d9ae7f2bSJakub Kicinski * struct nfp_prog - nfp BPF program 23577a844eeSJakub Kicinski * @bpf: backpointer to the bpf app priv structure 236d9ae7f2bSJakub Kicinski * @prog: machine code 237d9ae7f2bSJakub Kicinski * @prog_len: number of valid instructions in @prog array 238d9ae7f2bSJakub Kicinski * @__prog_alloc_len: alloc size of @prog array 239c6c580d7SJakub Kicinski * @verifier_meta: temporary storage for verifier's insn meta 240012bb8a8SJakub Kicinski * @type: BPF program type 241854dc87dSJiong Wang * @last_bpf_off: address of the last instruction translated from BPF 242d9ae7f2bSJakub Kicinski * @tgt_out: jump target for normal exit 243d9ae7f2bSJakub Kicinski * @tgt_abort: jump target for abort (e.g. access outside of packet buffer) 244d9ae7f2bSJakub Kicinski * @n_translated: number of successfully translated instructions (for errors) 245d9ae7f2bSJakub Kicinski * @error: error code if something went wrong 246ee9133a8SJakub Kicinski * @stack_depth: max stack depth from the verifier 2478231f844SJakub Kicinski * @adjust_head_location: if program has single adjust head call - the insn no. 248d9ae7f2bSJakub Kicinski * @insns: list of BPF instruction wrappers (struct nfp_insn_meta) 249d9ae7f2bSJakub Kicinski */ 250d9ae7f2bSJakub Kicinski struct nfp_prog { 25177a844eeSJakub Kicinski struct nfp_app_bpf *bpf; 25277a844eeSJakub Kicinski 253d9ae7f2bSJakub Kicinski u64 *prog; 254d9ae7f2bSJakub Kicinski unsigned int prog_len; 255d9ae7f2bSJakub Kicinski unsigned int __prog_alloc_len; 256d9ae7f2bSJakub Kicinski 257c6c580d7SJakub Kicinski struct nfp_insn_meta *verifier_meta; 258c6c580d7SJakub Kicinski 259012bb8a8SJakub Kicinski enum bpf_prog_type type; 260d9ae7f2bSJakub Kicinski 261854dc87dSJiong Wang unsigned int last_bpf_off; 262d9ae7f2bSJakub Kicinski unsigned int tgt_out; 263d9ae7f2bSJakub Kicinski unsigned int tgt_abort; 264d9ae7f2bSJakub Kicinski 265d9ae7f2bSJakub Kicinski unsigned int n_translated; 266d9ae7f2bSJakub Kicinski int error; 267d9ae7f2bSJakub Kicinski 268ee9133a8SJakub Kicinski unsigned int stack_depth; 2698231f844SJakub Kicinski unsigned int adjust_head_location; 270ee9133a8SJakub Kicinski 271d9ae7f2bSJakub Kicinski struct list_head insns; 272d9ae7f2bSJakub Kicinski }; 273d9ae7f2bSJakub Kicinski 274d3f89b98SJakub Kicinski /** 275d3f89b98SJakub Kicinski * struct nfp_bpf_vnic - per-vNIC BPF priv structure 276d3f89b98SJakub Kicinski * @tc_prog: currently loaded cls_bpf program 2772314fe9eSJakub Kicinski * @start_off: address of the first instruction in the memory 2782314fe9eSJakub Kicinski * @tgt_done: jump target to get the next packet 279d3f89b98SJakub Kicinski */ 280d3f89b98SJakub Kicinski struct nfp_bpf_vnic { 281d3f89b98SJakub Kicinski struct bpf_prog *tc_prog; 2822314fe9eSJakub Kicinski unsigned int start_off; 2832314fe9eSJakub Kicinski unsigned int tgt_done; 284d3f89b98SJakub Kicinski }; 285d3f89b98SJakub Kicinski 2861549921dSJakub Kicinski void nfp_bpf_jit_prepare(struct nfp_prog *nfp_prog, unsigned int cnt); 287c6c580d7SJakub Kicinski int nfp_bpf_jit(struct nfp_prog *prog); 288d9ae7f2bSJakub Kicinski 289cae1927cSJakub Kicinski extern const struct bpf_prog_offload_ops nfp_bpf_analyzer_ops; 290d9ae7f2bSJakub Kicinski 291c6c580d7SJakub Kicinski struct netdev_bpf; 292c6c580d7SJakub Kicinski struct nfp_app; 293bb45e51cSJakub Kicinski struct nfp_net; 294bb45e51cSJakub Kicinski 295af93d15aSJakub Kicinski int nfp_ndo_bpf(struct nfp_app *app, struct nfp_net *nn, 296af93d15aSJakub Kicinski struct netdev_bpf *bpf); 2979ce7a956SJakub Kicinski int nfp_net_bpf_offload(struct nfp_net *nn, struct bpf_prog *prog, 298e4a91cd5SJakub Kicinski bool old_prog); 299bb45e51cSJakub Kicinski 3005b674140SJiong Wang struct nfp_insn_meta * 3015b674140SJiong Wang nfp_bpf_goto_meta(struct nfp_prog *nfp_prog, struct nfp_insn_meta *meta, 3025b674140SJiong Wang unsigned int insn_idx, unsigned int n_insns); 3032314fe9eSJakub Kicinski 3042314fe9eSJakub Kicinski void *nfp_bpf_relo_for_vnic(struct nfp_prog *nfp_prog, struct nfp_bpf_vnic *bv); 305d48ae231SJakub Kicinski 306ff3d43f7SJakub Kicinski long long int 307ff3d43f7SJakub Kicinski nfp_bpf_ctrl_alloc_map(struct nfp_app_bpf *bpf, struct bpf_map *map); 308ff3d43f7SJakub Kicinski void 309ff3d43f7SJakub Kicinski nfp_bpf_ctrl_free_map(struct nfp_app_bpf *bpf, struct nfp_bpf_map *nfp_map); 310ff3d43f7SJakub Kicinski int nfp_bpf_ctrl_getfirst_entry(struct bpf_offloaded_map *offmap, 311ff3d43f7SJakub Kicinski void *next_key); 312ff3d43f7SJakub Kicinski int nfp_bpf_ctrl_update_entry(struct bpf_offloaded_map *offmap, 313ff3d43f7SJakub Kicinski void *key, void *value, u64 flags); 314ff3d43f7SJakub Kicinski int nfp_bpf_ctrl_del_entry(struct bpf_offloaded_map *offmap, void *key); 315ff3d43f7SJakub Kicinski int nfp_bpf_ctrl_lookup_entry(struct bpf_offloaded_map *offmap, 316ff3d43f7SJakub Kicinski void *key, void *value); 317ff3d43f7SJakub Kicinski int nfp_bpf_ctrl_getnext_entry(struct bpf_offloaded_map *offmap, 318ff3d43f7SJakub Kicinski void *key, void *next_key); 319ff3d43f7SJakub Kicinski 320d48ae231SJakub Kicinski void nfp_bpf_ctrl_msg_rx(struct nfp_app *app, struct sk_buff *skb); 321d9ae7f2bSJakub Kicinski #endif 322