1*d75fe9cbSLuca Boccassi /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */ 28d930450SJakub Kicinski /* eBPF instruction mini library */ 38d930450SJakub Kicinski #ifndef __BPF_INSN_H 48d930450SJakub Kicinski #define __BPF_INSN_H 58d930450SJakub Kicinski 68d930450SJakub Kicinski struct bpf_insn; 78d930450SJakub Kicinski 88d930450SJakub Kicinski /* ALU ops on registers, bpf_add|sub|...: dst_reg += src_reg */ 98d930450SJakub Kicinski 108d930450SJakub Kicinski #define BPF_ALU64_REG(OP, DST, SRC) \ 118d930450SJakub Kicinski ((struct bpf_insn) { \ 128d930450SJakub Kicinski .code = BPF_ALU64 | BPF_OP(OP) | BPF_X, \ 138d930450SJakub Kicinski .dst_reg = DST, \ 148d930450SJakub Kicinski .src_reg = SRC, \ 158d930450SJakub Kicinski .off = 0, \ 168d930450SJakub Kicinski .imm = 0 }) 178d930450SJakub Kicinski 188d930450SJakub Kicinski #define BPF_ALU32_REG(OP, DST, SRC) \ 198d930450SJakub Kicinski ((struct bpf_insn) { \ 208d930450SJakub Kicinski .code = BPF_ALU | BPF_OP(OP) | BPF_X, \ 218d930450SJakub Kicinski .dst_reg = DST, \ 228d930450SJakub Kicinski .src_reg = SRC, \ 238d930450SJakub Kicinski .off = 0, \ 248d930450SJakub Kicinski .imm = 0 }) 258d930450SJakub Kicinski 268d930450SJakub Kicinski /* ALU ops on immediates, bpf_add|sub|...: dst_reg += imm32 */ 278d930450SJakub Kicinski 288d930450SJakub Kicinski #define BPF_ALU64_IMM(OP, DST, IMM) \ 298d930450SJakub Kicinski ((struct bpf_insn) { \ 308d930450SJakub Kicinski .code = BPF_ALU64 | BPF_OP(OP) | BPF_K, \ 318d930450SJakub Kicinski .dst_reg = DST, \ 328d930450SJakub Kicinski .src_reg = 0, \ 338d930450SJakub Kicinski .off = 0, \ 348d930450SJakub Kicinski .imm = IMM }) 358d930450SJakub Kicinski 368d930450SJakub Kicinski #define BPF_ALU32_IMM(OP, DST, IMM) \ 378d930450SJakub Kicinski ((struct bpf_insn) { \ 388d930450SJakub Kicinski .code = BPF_ALU | BPF_OP(OP) | BPF_K, \ 398d930450SJakub Kicinski .dst_reg = DST, \ 408d930450SJakub Kicinski .src_reg = 0, \ 418d930450SJakub Kicinski .off = 0, \ 428d930450SJakub Kicinski .imm = IMM }) 438d930450SJakub Kicinski 448d930450SJakub Kicinski /* Short form of mov, dst_reg = src_reg */ 458d930450SJakub Kicinski 468d930450SJakub Kicinski #define BPF_MOV64_REG(DST, SRC) \ 478d930450SJakub Kicinski ((struct bpf_insn) { \ 488d930450SJakub Kicinski .code = BPF_ALU64 | BPF_MOV | BPF_X, \ 498d930450SJakub Kicinski .dst_reg = DST, \ 508d930450SJakub Kicinski .src_reg = SRC, \ 518d930450SJakub Kicinski .off = 0, \ 528d930450SJakub Kicinski .imm = 0 }) 538d930450SJakub Kicinski 548d930450SJakub Kicinski #define BPF_MOV32_REG(DST, SRC) \ 558d930450SJakub Kicinski ((struct bpf_insn) { \ 568d930450SJakub Kicinski .code = BPF_ALU | BPF_MOV | BPF_X, \ 578d930450SJakub Kicinski .dst_reg = DST, \ 588d930450SJakub Kicinski .src_reg = SRC, \ 598d930450SJakub Kicinski .off = 0, \ 608d930450SJakub Kicinski .imm = 0 }) 618d930450SJakub Kicinski 628d930450SJakub Kicinski /* Short form of mov, dst_reg = imm32 */ 638d930450SJakub Kicinski 648d930450SJakub Kicinski #define BPF_MOV64_IMM(DST, IMM) \ 658d930450SJakub Kicinski ((struct bpf_insn) { \ 668d930450SJakub Kicinski .code = BPF_ALU64 | BPF_MOV | BPF_K, \ 678d930450SJakub Kicinski .dst_reg = DST, \ 688d930450SJakub Kicinski .src_reg = 0, \ 698d930450SJakub Kicinski .off = 0, \ 708d930450SJakub Kicinski .imm = IMM }) 718d930450SJakub Kicinski 728d930450SJakub Kicinski #define BPF_MOV32_IMM(DST, IMM) \ 738d930450SJakub Kicinski ((struct bpf_insn) { \ 748d930450SJakub Kicinski .code = BPF_ALU | BPF_MOV | BPF_K, \ 758d930450SJakub Kicinski .dst_reg = DST, \ 768d930450SJakub Kicinski .src_reg = 0, \ 778d930450SJakub Kicinski .off = 0, \ 788d930450SJakub Kicinski .imm = IMM }) 798d930450SJakub Kicinski 808d930450SJakub Kicinski /* BPF_LD_IMM64 macro encodes single 'load 64-bit immediate' insn */ 818d930450SJakub Kicinski #define BPF_LD_IMM64(DST, IMM) \ 828d930450SJakub Kicinski BPF_LD_IMM64_RAW(DST, 0, IMM) 838d930450SJakub Kicinski 848d930450SJakub Kicinski #define BPF_LD_IMM64_RAW(DST, SRC, IMM) \ 858d930450SJakub Kicinski ((struct bpf_insn) { \ 868d930450SJakub Kicinski .code = BPF_LD | BPF_DW | BPF_IMM, \ 878d930450SJakub Kicinski .dst_reg = DST, \ 888d930450SJakub Kicinski .src_reg = SRC, \ 898d930450SJakub Kicinski .off = 0, \ 908d930450SJakub Kicinski .imm = (__u32) (IMM) }), \ 918d930450SJakub Kicinski ((struct bpf_insn) { \ 928d930450SJakub Kicinski .code = 0, /* zero is reserved opcode */ \ 938d930450SJakub Kicinski .dst_reg = 0, \ 948d930450SJakub Kicinski .src_reg = 0, \ 958d930450SJakub Kicinski .off = 0, \ 968d930450SJakub Kicinski .imm = ((__u64) (IMM)) >> 32 }) 978d930450SJakub Kicinski 988d930450SJakub Kicinski #ifndef BPF_PSEUDO_MAP_FD 998d930450SJakub Kicinski # define BPF_PSEUDO_MAP_FD 1 1008d930450SJakub Kicinski #endif 1018d930450SJakub Kicinski 1028d930450SJakub Kicinski /* pseudo BPF_LD_IMM64 insn used to refer to process-local map_fd */ 1038d930450SJakub Kicinski #define BPF_LD_MAP_FD(DST, MAP_FD) \ 1048d930450SJakub Kicinski BPF_LD_IMM64_RAW(DST, BPF_PSEUDO_MAP_FD, MAP_FD) 1058d930450SJakub Kicinski 1068d930450SJakub Kicinski 1078d930450SJakub Kicinski /* Direct packet access, R0 = *(uint *) (skb->data + imm32) */ 1088d930450SJakub Kicinski 1098d930450SJakub Kicinski #define BPF_LD_ABS(SIZE, IMM) \ 1108d930450SJakub Kicinski ((struct bpf_insn) { \ 1118d930450SJakub Kicinski .code = BPF_LD | BPF_SIZE(SIZE) | BPF_ABS, \ 1128d930450SJakub Kicinski .dst_reg = 0, \ 1138d930450SJakub Kicinski .src_reg = 0, \ 1148d930450SJakub Kicinski .off = 0, \ 1158d930450SJakub Kicinski .imm = IMM }) 1168d930450SJakub Kicinski 1178d930450SJakub Kicinski /* Memory load, dst_reg = *(uint *) (src_reg + off16) */ 1188d930450SJakub Kicinski 1198d930450SJakub Kicinski #define BPF_LDX_MEM(SIZE, DST, SRC, OFF) \ 1208d930450SJakub Kicinski ((struct bpf_insn) { \ 1218d930450SJakub Kicinski .code = BPF_LDX | BPF_SIZE(SIZE) | BPF_MEM, \ 1228d930450SJakub Kicinski .dst_reg = DST, \ 1238d930450SJakub Kicinski .src_reg = SRC, \ 1248d930450SJakub Kicinski .off = OFF, \ 1258d930450SJakub Kicinski .imm = 0 }) 1268d930450SJakub Kicinski 1278d930450SJakub Kicinski /* Memory store, *(uint *) (dst_reg + off16) = src_reg */ 1288d930450SJakub Kicinski 1298d930450SJakub Kicinski #define BPF_STX_MEM(SIZE, DST, SRC, OFF) \ 1308d930450SJakub Kicinski ((struct bpf_insn) { \ 1318d930450SJakub Kicinski .code = BPF_STX | BPF_SIZE(SIZE) | BPF_MEM, \ 1328d930450SJakub Kicinski .dst_reg = DST, \ 1338d930450SJakub Kicinski .src_reg = SRC, \ 1348d930450SJakub Kicinski .off = OFF, \ 1358d930450SJakub Kicinski .imm = 0 }) 1368d930450SJakub Kicinski 137da9d35e2SBjörn Töpel /* 138da9d35e2SBjörn Töpel * Atomic operations: 139da9d35e2SBjörn Töpel * 140da9d35e2SBjörn Töpel * BPF_ADD *(uint *) (dst_reg + off16) += src_reg 141da9d35e2SBjörn Töpel * BPF_AND *(uint *) (dst_reg + off16) &= src_reg 142da9d35e2SBjörn Töpel * BPF_OR *(uint *) (dst_reg + off16) |= src_reg 143da9d35e2SBjörn Töpel * BPF_XOR *(uint *) (dst_reg + off16) ^= src_reg 144da9d35e2SBjörn Töpel * BPF_ADD | BPF_FETCH src_reg = atomic_fetch_add(dst_reg + off16, src_reg); 145da9d35e2SBjörn Töpel * BPF_AND | BPF_FETCH src_reg = atomic_fetch_and(dst_reg + off16, src_reg); 146da9d35e2SBjörn Töpel * BPF_OR | BPF_FETCH src_reg = atomic_fetch_or(dst_reg + off16, src_reg); 147da9d35e2SBjörn Töpel * BPF_XOR | BPF_FETCH src_reg = atomic_fetch_xor(dst_reg + off16, src_reg); 148da9d35e2SBjörn Töpel * BPF_XCHG src_reg = atomic_xchg(dst_reg + off16, src_reg) 149da9d35e2SBjörn Töpel * BPF_CMPXCHG r0 = atomic_cmpxchg(dst_reg + off16, r0, src_reg) 150da9d35e2SBjörn Töpel */ 1518d930450SJakub Kicinski 152da9d35e2SBjörn Töpel #define BPF_ATOMIC_OP(SIZE, OP, DST, SRC, OFF) \ 1538d930450SJakub Kicinski ((struct bpf_insn) { \ 15491c960b0SBrendan Jackman .code = BPF_STX | BPF_SIZE(SIZE) | BPF_ATOMIC, \ 1558d930450SJakub Kicinski .dst_reg = DST, \ 1568d930450SJakub Kicinski .src_reg = SRC, \ 1578d930450SJakub Kicinski .off = OFF, \ 158da9d35e2SBjörn Töpel .imm = OP }) 159da9d35e2SBjörn Töpel 160da9d35e2SBjörn Töpel /* Legacy alias */ 161da9d35e2SBjörn Töpel #define BPF_STX_XADD(SIZE, DST, SRC, OFF) BPF_ATOMIC_OP(SIZE, BPF_ADD, DST, SRC, OFF) 1628d930450SJakub Kicinski 1638d930450SJakub Kicinski /* Memory store, *(uint *) (dst_reg + off16) = imm32 */ 1648d930450SJakub Kicinski 1658d930450SJakub Kicinski #define BPF_ST_MEM(SIZE, DST, OFF, IMM) \ 1668d930450SJakub Kicinski ((struct bpf_insn) { \ 1678d930450SJakub Kicinski .code = BPF_ST | BPF_SIZE(SIZE) | BPF_MEM, \ 1688d930450SJakub Kicinski .dst_reg = DST, \ 1698d930450SJakub Kicinski .src_reg = 0, \ 1708d930450SJakub Kicinski .off = OFF, \ 1718d930450SJakub Kicinski .imm = IMM }) 1728d930450SJakub Kicinski 1738d930450SJakub Kicinski /* Conditional jumps against registers, if (dst_reg 'op' src_reg) goto pc + off16 */ 1748d930450SJakub Kicinski 1758d930450SJakub Kicinski #define BPF_JMP_REG(OP, DST, SRC, OFF) \ 1768d930450SJakub Kicinski ((struct bpf_insn) { \ 1778d930450SJakub Kicinski .code = BPF_JMP | BPF_OP(OP) | BPF_X, \ 1788d930450SJakub Kicinski .dst_reg = DST, \ 1798d930450SJakub Kicinski .src_reg = SRC, \ 1808d930450SJakub Kicinski .off = OFF, \ 1818d930450SJakub Kicinski .imm = 0 }) 1828d930450SJakub Kicinski 1836ea848b5SJiong Wang /* Like BPF_JMP_REG, but with 32-bit wide operands for comparison. */ 1846ea848b5SJiong Wang 1856ea848b5SJiong Wang #define BPF_JMP32_REG(OP, DST, SRC, OFF) \ 1866ea848b5SJiong Wang ((struct bpf_insn) { \ 1876ea848b5SJiong Wang .code = BPF_JMP32 | BPF_OP(OP) | BPF_X, \ 1886ea848b5SJiong Wang .dst_reg = DST, \ 1896ea848b5SJiong Wang .src_reg = SRC, \ 1906ea848b5SJiong Wang .off = OFF, \ 1916ea848b5SJiong Wang .imm = 0 }) 1926ea848b5SJiong Wang 1938d930450SJakub Kicinski /* Conditional jumps against immediates, if (dst_reg 'op' imm32) goto pc + off16 */ 1948d930450SJakub Kicinski 1958d930450SJakub Kicinski #define BPF_JMP_IMM(OP, DST, IMM, OFF) \ 1968d930450SJakub Kicinski ((struct bpf_insn) { \ 1978d930450SJakub Kicinski .code = BPF_JMP | BPF_OP(OP) | BPF_K, \ 1988d930450SJakub Kicinski .dst_reg = DST, \ 1998d930450SJakub Kicinski .src_reg = 0, \ 2008d930450SJakub Kicinski .off = OFF, \ 2018d930450SJakub Kicinski .imm = IMM }) 2028d930450SJakub Kicinski 2036ea848b5SJiong Wang /* Like BPF_JMP_IMM, but with 32-bit wide operands for comparison. */ 2046ea848b5SJiong Wang 2056ea848b5SJiong Wang #define BPF_JMP32_IMM(OP, DST, IMM, OFF) \ 2066ea848b5SJiong Wang ((struct bpf_insn) { \ 2076ea848b5SJiong Wang .code = BPF_JMP32 | BPF_OP(OP) | BPF_K, \ 2086ea848b5SJiong Wang .dst_reg = DST, \ 2096ea848b5SJiong Wang .src_reg = 0, \ 2106ea848b5SJiong Wang .off = OFF, \ 2116ea848b5SJiong Wang .imm = IMM }) 2126ea848b5SJiong Wang 2138d930450SJakub Kicinski /* Raw code statement block */ 2148d930450SJakub Kicinski 2158d930450SJakub Kicinski #define BPF_RAW_INSN(CODE, DST, SRC, OFF, IMM) \ 2168d930450SJakub Kicinski ((struct bpf_insn) { \ 2178d930450SJakub Kicinski .code = CODE, \ 2188d930450SJakub Kicinski .dst_reg = DST, \ 2198d930450SJakub Kicinski .src_reg = SRC, \ 2208d930450SJakub Kicinski .off = OFF, \ 2218d930450SJakub Kicinski .imm = IMM }) 2228d930450SJakub Kicinski 2238d930450SJakub Kicinski /* Program exit */ 2248d930450SJakub Kicinski 2258d930450SJakub Kicinski #define BPF_EXIT_INSN() \ 2268d930450SJakub Kicinski ((struct bpf_insn) { \ 2278d930450SJakub Kicinski .code = BPF_JMP | BPF_EXIT, \ 2288d930450SJakub Kicinski .dst_reg = 0, \ 2298d930450SJakub Kicinski .src_reg = 0, \ 2308d930450SJakub Kicinski .off = 0, \ 2318d930450SJakub Kicinski .imm = 0 }) 2328d930450SJakub Kicinski 2338d930450SJakub Kicinski #endif 234