1 /* 2 * Copyright (C) 2016-2017 Netronome Systems, Inc. 3 * 4 * This software is dual licensed under the GNU General License Version 2, 5 * June 1991 as shown in the file COPYING in the top-level directory of this 6 * source tree or the BSD 2-Clause License provided below. You have the 7 * option to license this software under the complete terms of either license. 8 * 9 * The BSD 2-Clause License: 10 * 11 * Redistribution and use in source and binary forms, with or 12 * without modification, are permitted provided that the following 13 * conditions are met: 14 * 15 * 1. Redistributions of source code must retain the above 16 * copyright notice, this list of conditions and the following 17 * disclaimer. 18 * 19 * 2. Redistributions in binary form must reproduce the above 20 * copyright notice, this list of conditions and the following 21 * disclaimer in the documentation and/or other materials 22 * provided with the distribution. 23 * 24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 28 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 29 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 30 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 31 * SOFTWARE. 32 */ 33 34 #ifndef __NFP_BPF_H__ 35 #define __NFP_BPF_H__ 1 36 37 #include <linux/bitfield.h> 38 #include <linux/bpf.h> 39 #include <linux/bpf_verifier.h> 40 #include <linux/kernel.h> 41 #include <linux/list.h> 42 #include <linux/skbuff.h> 43 #include <linux/types.h> 44 #include <linux/wait.h> 45 46 #include "../nfp_asm.h" 47 #include "fw.h" 48 49 /* For relocation logic use up-most byte of branch instruction as scratch 50 * area. Remember to clear this before sending instructions to HW! 51 */ 52 #define OP_RELO_TYPE 0xff00000000000000ULL 53 54 enum nfp_relo_type { 55 RELO_NONE = 0, 56 /* standard internal jumps */ 57 RELO_BR_REL, 58 /* internal jumps to parts of the outro */ 59 RELO_BR_GO_OUT, 60 RELO_BR_GO_ABORT, 61 /* external jumps to fixed addresses */ 62 RELO_BR_NEXT_PKT, 63 }; 64 65 /* To make absolute relocated branches (branches other than RELO_BR_REL) 66 * distinguishable in user space dumps from normal jumps, add a large offset 67 * to them. 68 */ 69 #define BR_OFF_RELO 15000 70 71 enum static_regs { 72 STATIC_REG_IMM = 21, /* Bank AB */ 73 STATIC_REG_STACK = 22, /* Bank A */ 74 STATIC_REG_PKT_LEN = 22, /* Bank B */ 75 }; 76 77 enum pkt_vec { 78 PKT_VEC_PKT_LEN = 0, 79 PKT_VEC_PKT_PTR = 2, 80 }; 81 82 #define pv_len(np) reg_lm(1, PKT_VEC_PKT_LEN) 83 #define pv_ctm_ptr(np) reg_lm(1, PKT_VEC_PKT_PTR) 84 85 #define stack_reg(np) reg_a(STATIC_REG_STACK) 86 #define stack_imm(np) imm_b(np) 87 #define plen_reg(np) reg_b(STATIC_REG_PKT_LEN) 88 #define pptr_reg(np) pv_ctm_ptr(np) 89 #define imm_a(np) reg_a(STATIC_REG_IMM) 90 #define imm_b(np) reg_b(STATIC_REG_IMM) 91 #define imm_both(np) reg_both(STATIC_REG_IMM) 92 93 #define NFP_BPF_ABI_FLAGS reg_imm(0) 94 #define NFP_BPF_ABI_FLAG_MARK 1 95 96 /** 97 * struct nfp_app_bpf - bpf app priv structure 98 * @app: backpointer to the app 99 * 100 * @tag_allocator: bitmap of control message tags in use 101 * @tag_alloc_next: next tag bit to allocate 102 * @tag_alloc_last: next tag bit to be freed 103 * 104 * @cmsg_replies: received cmsg replies waiting to be consumed 105 * @cmsg_wq: work queue for waiting for cmsg replies 106 * 107 * @map_list: list of offloaded maps 108 * 109 * @adjust_head: adjust head capability 110 * @flags: extra flags for adjust head 111 * @off_min: minimal packet offset within buffer required 112 * @off_max: maximum packet offset within buffer required 113 * @guaranteed_sub: amount of negative adjustment guaranteed possible 114 * @guaranteed_add: amount of positive adjustment guaranteed possible 115 */ 116 struct nfp_app_bpf { 117 struct nfp_app *app; 118 119 DECLARE_BITMAP(tag_allocator, U16_MAX + 1); 120 u16 tag_alloc_next; 121 u16 tag_alloc_last; 122 123 struct sk_buff_head cmsg_replies; 124 struct wait_queue_head cmsg_wq; 125 126 struct list_head map_list; 127 128 struct nfp_bpf_cap_adjust_head { 129 u32 flags; 130 int off_min; 131 int off_max; 132 int guaranteed_sub; 133 int guaranteed_add; 134 } adjust_head; 135 }; 136 137 /** 138 * struct nfp_bpf_map - private per-map data attached to BPF maps for offload 139 * @offmap: pointer to the offloaded BPF map 140 * @bpf: back pointer to bpf app private structure 141 * @tid: table id identifying map on datapath 142 * @l: link on the nfp_app_bpf->map_list list 143 */ 144 struct nfp_bpf_map { 145 struct bpf_offloaded_map *offmap; 146 struct nfp_app_bpf *bpf; 147 u32 tid; 148 struct list_head l; 149 }; 150 151 struct nfp_prog; 152 struct nfp_insn_meta; 153 typedef int (*instr_cb_t)(struct nfp_prog *, struct nfp_insn_meta *); 154 155 #define nfp_prog_first_meta(nfp_prog) \ 156 list_first_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 157 #define nfp_prog_last_meta(nfp_prog) \ 158 list_last_entry(&(nfp_prog)->insns, struct nfp_insn_meta, l) 159 #define nfp_meta_next(meta) list_next_entry(meta, l) 160 #define nfp_meta_prev(meta) list_prev_entry(meta, l) 161 162 #define FLAG_INSN_IS_JUMP_DST BIT(0) 163 164 /** 165 * struct nfp_insn_meta - BPF instruction wrapper 166 * @insn: BPF instruction 167 * @ptr: pointer type for memory operations 168 * @ldst_gather_len: memcpy length gathered from load/store sequence 169 * @paired_st: the paired store insn at the head of the sequence 170 * @arg2: arg2 for call instructions 171 * @ptr_not_const: pointer is not always constant 172 * @jmp_dst: destination info for jump instructions 173 * @off: index of first generated machine instruction (in nfp_prog.prog) 174 * @n: eBPF instruction number 175 * @flags: eBPF instruction extra optimization flags 176 * @skip: skip this instruction (optimized out) 177 * @double_cb: callback for second part of the instruction 178 * @l: link on nfp_prog->insns list 179 */ 180 struct nfp_insn_meta { 181 struct bpf_insn insn; 182 union { 183 struct { 184 struct bpf_reg_state ptr; 185 struct bpf_insn *paired_st; 186 s16 ldst_gather_len; 187 bool ptr_not_const; 188 }; 189 struct nfp_insn_meta *jmp_dst; 190 struct bpf_reg_state arg2; 191 }; 192 unsigned int off; 193 unsigned short n; 194 unsigned short flags; 195 bool skip; 196 instr_cb_t double_cb; 197 198 struct list_head l; 199 }; 200 201 #define BPF_SIZE_MASK 0x18 202 203 static inline u8 mbpf_class(const struct nfp_insn_meta *meta) 204 { 205 return BPF_CLASS(meta->insn.code); 206 } 207 208 static inline u8 mbpf_src(const struct nfp_insn_meta *meta) 209 { 210 return BPF_SRC(meta->insn.code); 211 } 212 213 static inline u8 mbpf_op(const struct nfp_insn_meta *meta) 214 { 215 return BPF_OP(meta->insn.code); 216 } 217 218 static inline u8 mbpf_mode(const struct nfp_insn_meta *meta) 219 { 220 return BPF_MODE(meta->insn.code); 221 } 222 223 static inline bool is_mbpf_load(const struct nfp_insn_meta *meta) 224 { 225 return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_LDX | BPF_MEM); 226 } 227 228 static inline bool is_mbpf_store(const struct nfp_insn_meta *meta) 229 { 230 return (meta->insn.code & ~BPF_SIZE_MASK) == (BPF_STX | BPF_MEM); 231 } 232 233 /** 234 * struct nfp_prog - nfp BPF program 235 * @bpf: backpointer to the bpf app priv structure 236 * @prog: machine code 237 * @prog_len: number of valid instructions in @prog array 238 * @__prog_alloc_len: alloc size of @prog array 239 * @verifier_meta: temporary storage for verifier's insn meta 240 * @type: BPF program type 241 * @last_bpf_off: address of the last instruction translated from BPF 242 * @tgt_out: jump target for normal exit 243 * @tgt_abort: jump target for abort (e.g. access outside of packet buffer) 244 * @n_translated: number of successfully translated instructions (for errors) 245 * @error: error code if something went wrong 246 * @stack_depth: max stack depth from the verifier 247 * @adjust_head_location: if program has single adjust head call - the insn no. 248 * @insns: list of BPF instruction wrappers (struct nfp_insn_meta) 249 */ 250 struct nfp_prog { 251 struct nfp_app_bpf *bpf; 252 253 u64 *prog; 254 unsigned int prog_len; 255 unsigned int __prog_alloc_len; 256 257 struct nfp_insn_meta *verifier_meta; 258 259 enum bpf_prog_type type; 260 261 unsigned int last_bpf_off; 262 unsigned int tgt_out; 263 unsigned int tgt_abort; 264 265 unsigned int n_translated; 266 int error; 267 268 unsigned int stack_depth; 269 unsigned int adjust_head_location; 270 271 struct list_head insns; 272 }; 273 274 /** 275 * struct nfp_bpf_vnic - per-vNIC BPF priv structure 276 * @tc_prog: currently loaded cls_bpf program 277 * @start_off: address of the first instruction in the memory 278 * @tgt_done: jump target to get the next packet 279 */ 280 struct nfp_bpf_vnic { 281 struct bpf_prog *tc_prog; 282 unsigned int start_off; 283 unsigned int tgt_done; 284 }; 285 286 void nfp_bpf_jit_prepare(struct nfp_prog *nfp_prog, unsigned int cnt); 287 int nfp_bpf_jit(struct nfp_prog *prog); 288 289 extern const struct bpf_prog_offload_ops nfp_bpf_analyzer_ops; 290 291 struct netdev_bpf; 292 struct nfp_app; 293 struct nfp_net; 294 295 int nfp_ndo_bpf(struct nfp_app *app, struct nfp_net *nn, 296 struct netdev_bpf *bpf); 297 int nfp_net_bpf_offload(struct nfp_net *nn, struct bpf_prog *prog, 298 bool old_prog); 299 300 struct nfp_insn_meta * 301 nfp_bpf_goto_meta(struct nfp_prog *nfp_prog, struct nfp_insn_meta *meta, 302 unsigned int insn_idx, unsigned int n_insns); 303 304 void *nfp_bpf_relo_for_vnic(struct nfp_prog *nfp_prog, struct nfp_bpf_vnic *bv); 305 306 long long int 307 nfp_bpf_ctrl_alloc_map(struct nfp_app_bpf *bpf, struct bpf_map *map); 308 void 309 nfp_bpf_ctrl_free_map(struct nfp_app_bpf *bpf, struct nfp_bpf_map *nfp_map); 310 int nfp_bpf_ctrl_getfirst_entry(struct bpf_offloaded_map *offmap, 311 void *next_key); 312 int nfp_bpf_ctrl_update_entry(struct bpf_offloaded_map *offmap, 313 void *key, void *value, u64 flags); 314 int nfp_bpf_ctrl_del_entry(struct bpf_offloaded_map *offmap, void *key); 315 int nfp_bpf_ctrl_lookup_entry(struct bpf_offloaded_map *offmap, 316 void *key, void *value); 317 int nfp_bpf_ctrl_getnext_entry(struct bpf_offloaded_map *offmap, 318 void *key, void *next_key); 319 320 void nfp_bpf_ctrl_msg_rx(struct nfp_app *app, struct sk_buff *skb); 321 #endif 322