2 * Linux Socket Filter - Kernel level socket filtering
4 * Based on the design of the Berkeley Packet Filter. The new
5 * internal format has been designed by PLUMgrid:
7 * Copyright (c) 2011 - 2014 PLUMgrid, http://plumgrid.com
11 * Jay Schulist <jschlst@samba.org>
12 * Alexei Starovoitov <ast@plumgrid.com>
13 * Daniel Borkmann <dborkman@redhat.com>
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * as published by the Free Software Foundation; either version
18 * 2 of the License, or (at your option) any later version.
20 * Andi Kleen - Fix a few bad bugs and races.
21 * Kris Katterjohn - Added many additional checks in bpf_check_classic()
24 #include <linux/module.h>
25 #include <linux/types.h>
27 #include <linux/fcntl.h>
28 #include <linux/socket.h>
30 #include <linux/inet.h>
31 #include <linux/netdevice.h>
32 #include <linux/if_packet.h>
33 #include <linux/gfp.h>
35 #include <net/protocol.h>
36 #include <net/netlink.h>
37 #include <linux/skbuff.h>
39 #include <net/flow_dissector.h>
40 #include <linux/errno.h>
41 #include <linux/timer.h>
42 #include <asm/uaccess.h>
43 #include <asm/unaligned.h>
44 #include <linux/filter.h>
45 #include <linux/ratelimit.h>
46 #include <linux/seccomp.h>
47 #include <linux/if_vlan.h>
48 #include <linux/bpf.h>
49 #include <net/sch_generic.h>
50 #include <net/cls_cgroup.h>
51 #include <net/dst_metadata.h>
53 #include <net/sock_reuseport.h>
56 * sk_filter_trim_cap - run a packet through a socket filter
57 * @sk: sock associated with &sk_buff
58 * @skb: buffer to filter
59 * @cap: limit on how short the eBPF program may trim the packet
61 * Run the eBPF program and then cut skb->data to correct size returned by
62 * the program. If pkt_len is 0 we toss packet. If skb->len is smaller
63 * than pkt_len we keep whole skb->data. This is the socket level
64 * wrapper to BPF_PROG_RUN. It returns 0 if the packet should
65 * be accepted or -EPERM if the packet should be tossed.
68 int sk_filter_trim_cap(struct sock *sk, struct sk_buff *skb, unsigned int cap)
71 struct sk_filter *filter;
74 * If the skb was allocated from pfmemalloc reserves, only
75 * allow SOCK_MEMALLOC sockets to use it as this socket is
78 if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
81 err = security_sock_rcv_skb(sk, skb);
86 filter = rcu_dereference(sk->sk_filter);
88 unsigned int pkt_len = bpf_prog_run_save_cb(filter->prog, skb);
89 err = pkt_len ? pskb_trim(skb, max(cap, pkt_len)) : -EPERM;
95 EXPORT_SYMBOL(sk_filter_trim_cap);
97 BPF_CALL_1(__skb_get_pay_offset, struct sk_buff *, skb)
99 return skb_get_poff(skb);
102 BPF_CALL_3(__skb_get_nlattr, struct sk_buff *, skb, u32, a, u32, x)
106 if (skb_is_nonlinear(skb))
109 if (skb->len < sizeof(struct nlattr))
112 if (a > skb->len - sizeof(struct nlattr))
115 nla = nla_find((struct nlattr *) &skb->data[a], skb->len - a, x);
117 return (void *) nla - (void *) skb->data;
122 BPF_CALL_3(__skb_get_nlattr_nest, struct sk_buff *, skb, u32, a, u32, x)
126 if (skb_is_nonlinear(skb))
129 if (skb->len < sizeof(struct nlattr))
132 if (a > skb->len - sizeof(struct nlattr))
135 nla = (struct nlattr *) &skb->data[a];
136 if (nla->nla_len > skb->len - a)
139 nla = nla_find_nested(nla, x);
141 return (void *) nla - (void *) skb->data;
146 BPF_CALL_0(__get_raw_cpu_id)
148 return raw_smp_processor_id();
151 static const struct bpf_func_proto bpf_get_raw_smp_processor_id_proto = {
152 .func = __get_raw_cpu_id,
154 .ret_type = RET_INTEGER,
157 static u32 convert_skb_access(int skb_field, int dst_reg, int src_reg,
158 struct bpf_insn *insn_buf)
160 struct bpf_insn *insn = insn_buf;
164 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, mark) != 4);
166 *insn++ = BPF_LDX_MEM(BPF_W, dst_reg, src_reg,
167 offsetof(struct sk_buff, mark));
171 *insn++ = BPF_LDX_MEM(BPF_B, dst_reg, src_reg, PKT_TYPE_OFFSET());
172 *insn++ = BPF_ALU32_IMM(BPF_AND, dst_reg, PKT_TYPE_MAX);
173 #ifdef __BIG_ENDIAN_BITFIELD
174 *insn++ = BPF_ALU32_IMM(BPF_RSH, dst_reg, 5);
179 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, queue_mapping) != 2);
181 *insn++ = BPF_LDX_MEM(BPF_H, dst_reg, src_reg,
182 offsetof(struct sk_buff, queue_mapping));
185 case SKF_AD_VLAN_TAG:
186 case SKF_AD_VLAN_TAG_PRESENT:
187 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, vlan_tci) != 2);
188 BUILD_BUG_ON(VLAN_TAG_PRESENT != 0x1000);
190 /* dst_reg = *(u16 *) (src_reg + offsetof(vlan_tci)) */
191 *insn++ = BPF_LDX_MEM(BPF_H, dst_reg, src_reg,
192 offsetof(struct sk_buff, vlan_tci));
193 if (skb_field == SKF_AD_VLAN_TAG) {
194 *insn++ = BPF_ALU32_IMM(BPF_AND, dst_reg,
198 *insn++ = BPF_ALU32_IMM(BPF_RSH, dst_reg, 12);
200 *insn++ = BPF_ALU32_IMM(BPF_AND, dst_reg, 1);
205 return insn - insn_buf;
208 static bool convert_bpf_extensions(struct sock_filter *fp,
209 struct bpf_insn **insnp)
211 struct bpf_insn *insn = *insnp;
215 case SKF_AD_OFF + SKF_AD_PROTOCOL:
216 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, protocol) != 2);
218 /* A = *(u16 *) (CTX + offsetof(protocol)) */
219 *insn++ = BPF_LDX_MEM(BPF_H, BPF_REG_A, BPF_REG_CTX,
220 offsetof(struct sk_buff, protocol));
221 /* A = ntohs(A) [emitting a nop or swap16] */
222 *insn = BPF_ENDIAN(BPF_FROM_BE, BPF_REG_A, 16);
225 case SKF_AD_OFF + SKF_AD_PKTTYPE:
226 cnt = convert_skb_access(SKF_AD_PKTTYPE, BPF_REG_A, BPF_REG_CTX, insn);
230 case SKF_AD_OFF + SKF_AD_IFINDEX:
231 case SKF_AD_OFF + SKF_AD_HATYPE:
232 BUILD_BUG_ON(FIELD_SIZEOF(struct net_device, ifindex) != 4);
233 BUILD_BUG_ON(FIELD_SIZEOF(struct net_device, type) != 2);
235 *insn++ = BPF_LDX_MEM(BPF_FIELD_SIZEOF(struct sk_buff, dev),
236 BPF_REG_TMP, BPF_REG_CTX,
237 offsetof(struct sk_buff, dev));
238 /* if (tmp != 0) goto pc + 1 */
239 *insn++ = BPF_JMP_IMM(BPF_JNE, BPF_REG_TMP, 0, 1);
240 *insn++ = BPF_EXIT_INSN();
241 if (fp->k == SKF_AD_OFF + SKF_AD_IFINDEX)
242 *insn = BPF_LDX_MEM(BPF_W, BPF_REG_A, BPF_REG_TMP,
243 offsetof(struct net_device, ifindex));
245 *insn = BPF_LDX_MEM(BPF_H, BPF_REG_A, BPF_REG_TMP,
246 offsetof(struct net_device, type));
249 case SKF_AD_OFF + SKF_AD_MARK:
250 cnt = convert_skb_access(SKF_AD_MARK, BPF_REG_A, BPF_REG_CTX, insn);
254 case SKF_AD_OFF + SKF_AD_RXHASH:
255 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, hash) != 4);
257 *insn = BPF_LDX_MEM(BPF_W, BPF_REG_A, BPF_REG_CTX,
258 offsetof(struct sk_buff, hash));
261 case SKF_AD_OFF + SKF_AD_QUEUE:
262 cnt = convert_skb_access(SKF_AD_QUEUE, BPF_REG_A, BPF_REG_CTX, insn);
266 case SKF_AD_OFF + SKF_AD_VLAN_TAG:
267 cnt = convert_skb_access(SKF_AD_VLAN_TAG,
268 BPF_REG_A, BPF_REG_CTX, insn);
272 case SKF_AD_OFF + SKF_AD_VLAN_TAG_PRESENT:
273 cnt = convert_skb_access(SKF_AD_VLAN_TAG_PRESENT,
274 BPF_REG_A, BPF_REG_CTX, insn);
278 case SKF_AD_OFF + SKF_AD_VLAN_TPID:
279 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, vlan_proto) != 2);
281 /* A = *(u16 *) (CTX + offsetof(vlan_proto)) */
282 *insn++ = BPF_LDX_MEM(BPF_H, BPF_REG_A, BPF_REG_CTX,
283 offsetof(struct sk_buff, vlan_proto));
284 /* A = ntohs(A) [emitting a nop or swap16] */
285 *insn = BPF_ENDIAN(BPF_FROM_BE, BPF_REG_A, 16);
288 case SKF_AD_OFF + SKF_AD_PAY_OFFSET:
289 case SKF_AD_OFF + SKF_AD_NLATTR:
290 case SKF_AD_OFF + SKF_AD_NLATTR_NEST:
291 case SKF_AD_OFF + SKF_AD_CPU:
292 case SKF_AD_OFF + SKF_AD_RANDOM:
294 *insn++ = BPF_MOV64_REG(BPF_REG_ARG1, BPF_REG_CTX);
296 *insn++ = BPF_MOV64_REG(BPF_REG_ARG2, BPF_REG_A);
298 *insn++ = BPF_MOV64_REG(BPF_REG_ARG3, BPF_REG_X);
299 /* Emit call(arg1=CTX, arg2=A, arg3=X) */
301 case SKF_AD_OFF + SKF_AD_PAY_OFFSET:
302 *insn = BPF_EMIT_CALL(__skb_get_pay_offset);
304 case SKF_AD_OFF + SKF_AD_NLATTR:
305 *insn = BPF_EMIT_CALL(__skb_get_nlattr);
307 case SKF_AD_OFF + SKF_AD_NLATTR_NEST:
308 *insn = BPF_EMIT_CALL(__skb_get_nlattr_nest);
310 case SKF_AD_OFF + SKF_AD_CPU:
311 *insn = BPF_EMIT_CALL(__get_raw_cpu_id);
313 case SKF_AD_OFF + SKF_AD_RANDOM:
314 *insn = BPF_EMIT_CALL(bpf_user_rnd_u32);
315 bpf_user_rnd_init_once();
320 case SKF_AD_OFF + SKF_AD_ALU_XOR_X:
322 *insn = BPF_ALU32_REG(BPF_XOR, BPF_REG_A, BPF_REG_X);
326 /* This is just a dummy call to avoid letting the compiler
327 * evict __bpf_call_base() as an optimization. Placed here
328 * where no-one bothers.
330 BUG_ON(__bpf_call_base(0, 0, 0, 0, 0) != 0);
339 * bpf_convert_filter - convert filter program
340 * @prog: the user passed filter program
341 * @len: the length of the user passed filter program
342 * @new_prog: buffer where converted program will be stored
343 * @new_len: pointer to store length of converted program
345 * Remap 'sock_filter' style BPF instruction set to 'sock_filter_ext' style.
346 * Conversion workflow:
348 * 1) First pass for calculating the new program length:
349 * bpf_convert_filter(old_prog, old_len, NULL, &new_len)
351 * 2) 2nd pass to remap in two passes: 1st pass finds new
352 * jump offsets, 2nd pass remapping:
353 * new_prog = kmalloc(sizeof(struct bpf_insn) * new_len);
354 * bpf_convert_filter(old_prog, old_len, new_prog, &new_len);
356 static int bpf_convert_filter(struct sock_filter *prog, int len,
357 struct bpf_insn *new_prog, int *new_len)
359 int new_flen = 0, pass = 0, target, i;
360 struct bpf_insn *new_insn;
361 struct sock_filter *fp;
365 BUILD_BUG_ON(BPF_MEMWORDS * sizeof(u32) > MAX_BPF_STACK);
366 BUILD_BUG_ON(BPF_REG_FP + 1 != MAX_BPF_REG);
368 if (len <= 0 || len > BPF_MAXINSNS)
372 addrs = kcalloc(len, sizeof(*addrs),
373 GFP_KERNEL | __GFP_NOWARN);
382 /* Classic BPF related prologue emission. */
384 /* Classic BPF expects A and X to be reset first. These need
385 * to be guaranteed to be the first two instructions.
387 *new_insn++ = BPF_ALU64_REG(BPF_XOR, BPF_REG_A, BPF_REG_A);
388 *new_insn++ = BPF_ALU64_REG(BPF_XOR, BPF_REG_X, BPF_REG_X);
390 /* All programs must keep CTX in callee saved BPF_REG_CTX.
391 * In eBPF case it's done by the compiler, here we need to
392 * do this ourself. Initial CTX is present in BPF_REG_ARG1.
394 *new_insn++ = BPF_MOV64_REG(BPF_REG_CTX, BPF_REG_ARG1);
399 for (i = 0; i < len; fp++, i++) {
400 struct bpf_insn tmp_insns[6] = { };
401 struct bpf_insn *insn = tmp_insns;
404 addrs[i] = new_insn - new_prog;
407 /* All arithmetic insns and skb loads map as-is. */
408 case BPF_ALU | BPF_ADD | BPF_X:
409 case BPF_ALU | BPF_ADD | BPF_K:
410 case BPF_ALU | BPF_SUB | BPF_X:
411 case BPF_ALU | BPF_SUB | BPF_K:
412 case BPF_ALU | BPF_AND | BPF_X:
413 case BPF_ALU | BPF_AND | BPF_K:
414 case BPF_ALU | BPF_OR | BPF_X:
415 case BPF_ALU | BPF_OR | BPF_K:
416 case BPF_ALU | BPF_LSH | BPF_X:
417 case BPF_ALU | BPF_LSH | BPF_K:
418 case BPF_ALU | BPF_RSH | BPF_X:
419 case BPF_ALU | BPF_RSH | BPF_K:
420 case BPF_ALU | BPF_XOR | BPF_X:
421 case BPF_ALU | BPF_XOR | BPF_K:
422 case BPF_ALU | BPF_MUL | BPF_X:
423 case BPF_ALU | BPF_MUL | BPF_K:
424 case BPF_ALU | BPF_DIV | BPF_X:
425 case BPF_ALU | BPF_DIV | BPF_K:
426 case BPF_ALU | BPF_MOD | BPF_X:
427 case BPF_ALU | BPF_MOD | BPF_K:
428 case BPF_ALU | BPF_NEG:
429 case BPF_LD | BPF_ABS | BPF_W:
430 case BPF_LD | BPF_ABS | BPF_H:
431 case BPF_LD | BPF_ABS | BPF_B:
432 case BPF_LD | BPF_IND | BPF_W:
433 case BPF_LD | BPF_IND | BPF_H:
434 case BPF_LD | BPF_IND | BPF_B:
435 /* Check for overloaded BPF extension and
436 * directly convert it if found, otherwise
437 * just move on with mapping.
439 if (BPF_CLASS(fp->code) == BPF_LD &&
440 BPF_MODE(fp->code) == BPF_ABS &&
441 convert_bpf_extensions(fp, &insn))
444 *insn = BPF_RAW_INSN(fp->code, BPF_REG_A, BPF_REG_X, 0, fp->k);
447 /* Jump transformation cannot use BPF block macros
448 * everywhere as offset calculation and target updates
449 * require a bit more work than the rest, i.e. jump
450 * opcodes map as-is, but offsets need adjustment.
453 #define BPF_EMIT_JMP \
455 if (target >= len || target < 0) \
457 insn->off = addrs ? addrs[target] - addrs[i] - 1 : 0; \
458 /* Adjust pc relative offset for 2nd or 3rd insn. */ \
459 insn->off -= insn - tmp_insns; \
462 case BPF_JMP | BPF_JA:
463 target = i + fp->k + 1;
464 insn->code = fp->code;
468 case BPF_JMP | BPF_JEQ | BPF_K:
469 case BPF_JMP | BPF_JEQ | BPF_X:
470 case BPF_JMP | BPF_JSET | BPF_K:
471 case BPF_JMP | BPF_JSET | BPF_X:
472 case BPF_JMP | BPF_JGT | BPF_K:
473 case BPF_JMP | BPF_JGT | BPF_X:
474 case BPF_JMP | BPF_JGE | BPF_K:
475 case BPF_JMP | BPF_JGE | BPF_X:
476 if (BPF_SRC(fp->code) == BPF_K && (int) fp->k < 0) {
477 /* BPF immediates are signed, zero extend
478 * immediate into tmp register and use it
481 *insn++ = BPF_MOV32_IMM(BPF_REG_TMP, fp->k);
483 insn->dst_reg = BPF_REG_A;
484 insn->src_reg = BPF_REG_TMP;
487 insn->dst_reg = BPF_REG_A;
489 bpf_src = BPF_SRC(fp->code);
490 insn->src_reg = bpf_src == BPF_X ? BPF_REG_X : 0;
493 /* Common case where 'jump_false' is next insn. */
495 insn->code = BPF_JMP | BPF_OP(fp->code) | bpf_src;
496 target = i + fp->jt + 1;
501 /* Convert JEQ into JNE when 'jump_true' is next insn. */
502 if (fp->jt == 0 && BPF_OP(fp->code) == BPF_JEQ) {
503 insn->code = BPF_JMP | BPF_JNE | bpf_src;
504 target = i + fp->jf + 1;
509 /* Other jumps are mapped into two insns: Jxx and JA. */
510 target = i + fp->jt + 1;
511 insn->code = BPF_JMP | BPF_OP(fp->code) | bpf_src;
515 insn->code = BPF_JMP | BPF_JA;
516 target = i + fp->jf + 1;
520 /* ldxb 4 * ([14] & 0xf) is remaped into 6 insns. */
521 case BPF_LDX | BPF_MSH | BPF_B:
523 *insn++ = BPF_MOV64_REG(BPF_REG_TMP, BPF_REG_A);
524 /* A = BPF_R0 = *(u8 *) (skb->data + K) */
525 *insn++ = BPF_LD_ABS(BPF_B, fp->k);
527 *insn++ = BPF_ALU32_IMM(BPF_AND, BPF_REG_A, 0xf);
529 *insn++ = BPF_ALU32_IMM(BPF_LSH, BPF_REG_A, 2);
531 *insn++ = BPF_MOV64_REG(BPF_REG_X, BPF_REG_A);
533 *insn = BPF_MOV64_REG(BPF_REG_A, BPF_REG_TMP);
536 /* RET_K is remaped into 2 insns. RET_A case doesn't need an
537 * extra mov as BPF_REG_0 is already mapped into BPF_REG_A.
539 case BPF_RET | BPF_A:
540 case BPF_RET | BPF_K:
541 if (BPF_RVAL(fp->code) == BPF_K)
542 *insn++ = BPF_MOV32_RAW(BPF_K, BPF_REG_0,
544 *insn = BPF_EXIT_INSN();
547 /* Store to stack. */
550 *insn = BPF_STX_MEM(BPF_W, BPF_REG_FP, BPF_CLASS(fp->code) ==
551 BPF_ST ? BPF_REG_A : BPF_REG_X,
552 -(BPF_MEMWORDS - fp->k) * 4);
555 /* Load from stack. */
556 case BPF_LD | BPF_MEM:
557 case BPF_LDX | BPF_MEM:
558 *insn = BPF_LDX_MEM(BPF_W, BPF_CLASS(fp->code) == BPF_LD ?
559 BPF_REG_A : BPF_REG_X, BPF_REG_FP,
560 -(BPF_MEMWORDS - fp->k) * 4);
564 case BPF_LD | BPF_IMM:
565 case BPF_LDX | BPF_IMM:
566 *insn = BPF_MOV32_IMM(BPF_CLASS(fp->code) == BPF_LD ?
567 BPF_REG_A : BPF_REG_X, fp->k);
571 case BPF_MISC | BPF_TAX:
572 *insn = BPF_MOV64_REG(BPF_REG_X, BPF_REG_A);
576 case BPF_MISC | BPF_TXA:
577 *insn = BPF_MOV64_REG(BPF_REG_A, BPF_REG_X);
580 /* A = skb->len or X = skb->len */
581 case BPF_LD | BPF_W | BPF_LEN:
582 case BPF_LDX | BPF_W | BPF_LEN:
583 *insn = BPF_LDX_MEM(BPF_W, BPF_CLASS(fp->code) == BPF_LD ?
584 BPF_REG_A : BPF_REG_X, BPF_REG_CTX,
585 offsetof(struct sk_buff, len));
588 /* Access seccomp_data fields. */
589 case BPF_LDX | BPF_ABS | BPF_W:
590 /* A = *(u32 *) (ctx + K) */
591 *insn = BPF_LDX_MEM(BPF_W, BPF_REG_A, BPF_REG_CTX, fp->k);
594 /* Unknown instruction. */
601 memcpy(new_insn, tmp_insns,
602 sizeof(*insn) * (insn - tmp_insns));
603 new_insn += insn - tmp_insns;
607 /* Only calculating new length. */
608 *new_len = new_insn - new_prog;
613 if (new_flen != new_insn - new_prog) {
614 new_flen = new_insn - new_prog;
621 BUG_ON(*new_len != new_flen);
630 * As we dont want to clear mem[] array for each packet going through
631 * __bpf_prog_run(), we check that filter loaded by user never try to read
632 * a cell if not previously written, and we check all branches to be sure
633 * a malicious user doesn't try to abuse us.
635 static int check_load_and_stores(const struct sock_filter *filter, int flen)
637 u16 *masks, memvalid = 0; /* One bit per cell, 16 cells */
640 BUILD_BUG_ON(BPF_MEMWORDS > 16);
642 masks = kmalloc_array(flen, sizeof(*masks), GFP_KERNEL);
646 memset(masks, 0xff, flen * sizeof(*masks));
648 for (pc = 0; pc < flen; pc++) {
649 memvalid &= masks[pc];
651 switch (filter[pc].code) {
654 memvalid |= (1 << filter[pc].k);
656 case BPF_LD | BPF_MEM:
657 case BPF_LDX | BPF_MEM:
658 if (!(memvalid & (1 << filter[pc].k))) {
663 case BPF_JMP | BPF_JA:
664 /* A jump must set masks on target */
665 masks[pc + 1 + filter[pc].k] &= memvalid;
668 case BPF_JMP | BPF_JEQ | BPF_K:
669 case BPF_JMP | BPF_JEQ | BPF_X:
670 case BPF_JMP | BPF_JGE | BPF_K:
671 case BPF_JMP | BPF_JGE | BPF_X:
672 case BPF_JMP | BPF_JGT | BPF_K:
673 case BPF_JMP | BPF_JGT | BPF_X:
674 case BPF_JMP | BPF_JSET | BPF_K:
675 case BPF_JMP | BPF_JSET | BPF_X:
676 /* A jump must set masks on targets */
677 masks[pc + 1 + filter[pc].jt] &= memvalid;
678 masks[pc + 1 + filter[pc].jf] &= memvalid;
688 static bool chk_code_allowed(u16 code_to_probe)
690 static const bool codes[] = {
691 /* 32 bit ALU operations */
692 [BPF_ALU | BPF_ADD | BPF_K] = true,
693 [BPF_ALU | BPF_ADD | BPF_X] = true,
694 [BPF_ALU | BPF_SUB | BPF_K] = true,
695 [BPF_ALU | BPF_SUB | BPF_X] = true,
696 [BPF_ALU | BPF_MUL | BPF_K] = true,
697 [BPF_ALU | BPF_MUL | BPF_X] = true,
698 [BPF_ALU | BPF_DIV | BPF_K] = true,
699 [BPF_ALU | BPF_DIV | BPF_X] = true,
700 [BPF_ALU | BPF_MOD | BPF_K] = true,
701 [BPF_ALU | BPF_MOD | BPF_X] = true,
702 [BPF_ALU | BPF_AND | BPF_K] = true,
703 [BPF_ALU | BPF_AND | BPF_X] = true,
704 [BPF_ALU | BPF_OR | BPF_K] = true,
705 [BPF_ALU | BPF_OR | BPF_X] = true,
706 [BPF_ALU | BPF_XOR | BPF_K] = true,
707 [BPF_ALU | BPF_XOR | BPF_X] = true,
708 [BPF_ALU | BPF_LSH | BPF_K] = true,
709 [BPF_ALU | BPF_LSH | BPF_X] = true,
710 [BPF_ALU | BPF_RSH | BPF_K] = true,
711 [BPF_ALU | BPF_RSH | BPF_X] = true,
712 [BPF_ALU | BPF_NEG] = true,
713 /* Load instructions */
714 [BPF_LD | BPF_W | BPF_ABS] = true,
715 [BPF_LD | BPF_H | BPF_ABS] = true,
716 [BPF_LD | BPF_B | BPF_ABS] = true,
717 [BPF_LD | BPF_W | BPF_LEN] = true,
718 [BPF_LD | BPF_W | BPF_IND] = true,
719 [BPF_LD | BPF_H | BPF_IND] = true,
720 [BPF_LD | BPF_B | BPF_IND] = true,
721 [BPF_LD | BPF_IMM] = true,
722 [BPF_LD | BPF_MEM] = true,
723 [BPF_LDX | BPF_W | BPF_LEN] = true,
724 [BPF_LDX | BPF_B | BPF_MSH] = true,
725 [BPF_LDX | BPF_IMM] = true,
726 [BPF_LDX | BPF_MEM] = true,
727 /* Store instructions */
730 /* Misc instructions */
731 [BPF_MISC | BPF_TAX] = true,
732 [BPF_MISC | BPF_TXA] = true,
733 /* Return instructions */
734 [BPF_RET | BPF_K] = true,
735 [BPF_RET | BPF_A] = true,
736 /* Jump instructions */
737 [BPF_JMP | BPF_JA] = true,
738 [BPF_JMP | BPF_JEQ | BPF_K] = true,
739 [BPF_JMP | BPF_JEQ | BPF_X] = true,
740 [BPF_JMP | BPF_JGE | BPF_K] = true,
741 [BPF_JMP | BPF_JGE | BPF_X] = true,
742 [BPF_JMP | BPF_JGT | BPF_K] = true,
743 [BPF_JMP | BPF_JGT | BPF_X] = true,
744 [BPF_JMP | BPF_JSET | BPF_K] = true,
745 [BPF_JMP | BPF_JSET | BPF_X] = true,
748 if (code_to_probe >= ARRAY_SIZE(codes))
751 return codes[code_to_probe];
754 static bool bpf_check_basics_ok(const struct sock_filter *filter,
759 if (flen == 0 || flen > BPF_MAXINSNS)
766 * bpf_check_classic - verify socket filter code
767 * @filter: filter to verify
768 * @flen: length of filter
770 * Check the user's filter code. If we let some ugly
771 * filter code slip through kaboom! The filter must contain
772 * no references or jumps that are out of range, no illegal
773 * instructions, and must end with a RET instruction.
775 * All jumps are forward as they are not signed.
777 * Returns 0 if the rule set is legal or -EINVAL if not.
779 static int bpf_check_classic(const struct sock_filter *filter,
785 /* Check the filter code now */
786 for (pc = 0; pc < flen; pc++) {
787 const struct sock_filter *ftest = &filter[pc];
789 /* May we actually operate on this code? */
790 if (!chk_code_allowed(ftest->code))
793 /* Some instructions need special checks */
794 switch (ftest->code) {
795 case BPF_ALU | BPF_DIV | BPF_K:
796 case BPF_ALU | BPF_MOD | BPF_K:
797 /* Check for division by zero */
801 case BPF_ALU | BPF_LSH | BPF_K:
802 case BPF_ALU | BPF_RSH | BPF_K:
806 case BPF_LD | BPF_MEM:
807 case BPF_LDX | BPF_MEM:
810 /* Check for invalid memory addresses */
811 if (ftest->k >= BPF_MEMWORDS)
814 case BPF_JMP | BPF_JA:
815 /* Note, the large ftest->k might cause loops.
816 * Compare this with conditional jumps below,
817 * where offsets are limited. --ANK (981016)
819 if (ftest->k >= (unsigned int)(flen - pc - 1))
822 case BPF_JMP | BPF_JEQ | BPF_K:
823 case BPF_JMP | BPF_JEQ | BPF_X:
824 case BPF_JMP | BPF_JGE | BPF_K:
825 case BPF_JMP | BPF_JGE | BPF_X:
826 case BPF_JMP | BPF_JGT | BPF_K:
827 case BPF_JMP | BPF_JGT | BPF_X:
828 case BPF_JMP | BPF_JSET | BPF_K:
829 case BPF_JMP | BPF_JSET | BPF_X:
830 /* Both conditionals must be safe */
831 if (pc + ftest->jt + 1 >= flen ||
832 pc + ftest->jf + 1 >= flen)
835 case BPF_LD | BPF_W | BPF_ABS:
836 case BPF_LD | BPF_H | BPF_ABS:
837 case BPF_LD | BPF_B | BPF_ABS:
839 if (bpf_anc_helper(ftest) & BPF_ANC)
841 /* Ancillary operation unknown or unsupported */
842 if (anc_found == false && ftest->k >= SKF_AD_OFF)
847 /* Last instruction must be a RET code */
848 switch (filter[flen - 1].code) {
849 case BPF_RET | BPF_K:
850 case BPF_RET | BPF_A:
851 return check_load_and_stores(filter, flen);
857 static int bpf_prog_store_orig_filter(struct bpf_prog *fp,
858 const struct sock_fprog *fprog)
860 unsigned int fsize = bpf_classic_proglen(fprog);
861 struct sock_fprog_kern *fkprog;
863 fp->orig_prog = kmalloc(sizeof(*fkprog), GFP_KERNEL);
867 fkprog = fp->orig_prog;
868 fkprog->len = fprog->len;
870 fkprog->filter = kmemdup(fp->insns, fsize,
871 GFP_KERNEL | __GFP_NOWARN);
872 if (!fkprog->filter) {
873 kfree(fp->orig_prog);
880 static void bpf_release_orig_filter(struct bpf_prog *fp)
882 struct sock_fprog_kern *fprog = fp->orig_prog;
885 kfree(fprog->filter);
890 static void __bpf_prog_release(struct bpf_prog *prog)
892 if (prog->type == BPF_PROG_TYPE_SOCKET_FILTER) {
895 bpf_release_orig_filter(prog);
900 static void __sk_filter_release(struct sk_filter *fp)
902 __bpf_prog_release(fp->prog);
907 * sk_filter_release_rcu - Release a socket filter by rcu_head
908 * @rcu: rcu_head that contains the sk_filter to free
910 static void sk_filter_release_rcu(struct rcu_head *rcu)
912 struct sk_filter *fp = container_of(rcu, struct sk_filter, rcu);
914 __sk_filter_release(fp);
918 * sk_filter_release - release a socket filter
919 * @fp: filter to remove
921 * Remove a filter from a socket and release its resources.
923 static void sk_filter_release(struct sk_filter *fp)
925 if (atomic_dec_and_test(&fp->refcnt))
926 call_rcu(&fp->rcu, sk_filter_release_rcu);
929 void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp)
931 u32 filter_size = bpf_prog_size(fp->prog->len);
933 atomic_sub(filter_size, &sk->sk_omem_alloc);
934 sk_filter_release(fp);
937 /* try to charge the socket memory if there is space available
938 * return true on success
940 bool sk_filter_charge(struct sock *sk, struct sk_filter *fp)
942 u32 filter_size = bpf_prog_size(fp->prog->len);
944 /* same check as in sock_kmalloc() */
945 if (filter_size <= sysctl_optmem_max &&
946 atomic_read(&sk->sk_omem_alloc) + filter_size < sysctl_optmem_max) {
947 atomic_inc(&fp->refcnt);
948 atomic_add(filter_size, &sk->sk_omem_alloc);
954 static struct bpf_prog *bpf_migrate_filter(struct bpf_prog *fp)
956 struct sock_filter *old_prog;
957 struct bpf_prog *old_fp;
958 int err, new_len, old_len = fp->len;
960 /* We are free to overwrite insns et al right here as it
961 * won't be used at this point in time anymore internally
962 * after the migration to the internal BPF instruction
965 BUILD_BUG_ON(sizeof(struct sock_filter) !=
966 sizeof(struct bpf_insn));
968 /* Conversion cannot happen on overlapping memory areas,
969 * so we need to keep the user BPF around until the 2nd
970 * pass. At this time, the user BPF is stored in fp->insns.
972 old_prog = kmemdup(fp->insns, old_len * sizeof(struct sock_filter),
973 GFP_KERNEL | __GFP_NOWARN);
979 /* 1st pass: calculate the new program length. */
980 err = bpf_convert_filter(old_prog, old_len, NULL, &new_len);
984 /* Expand fp for appending the new filter representation. */
986 fp = bpf_prog_realloc(old_fp, bpf_prog_size(new_len), 0);
988 /* The old_fp is still around in case we couldn't
989 * allocate new memory, so uncharge on that one.
998 /* 2nd pass: remap sock_filter insns into bpf_insn insns. */
999 err = bpf_convert_filter(old_prog, old_len, fp->insnsi, &new_len);
1001 /* 2nd bpf_convert_filter() can fail only if it fails
1002 * to allocate memory, remapping must succeed. Note,
1003 * that at this time old_fp has already been released
1008 /* We are guaranteed to never error here with cBPF to eBPF
1009 * transitions, since there's no issue with type compatibility
1010 * checks on program arrays.
1012 fp = bpf_prog_select_runtime(fp, &err);
1020 __bpf_prog_release(fp);
1021 return ERR_PTR(err);
1024 static struct bpf_prog *bpf_prepare_filter(struct bpf_prog *fp,
1025 bpf_aux_classic_check_t trans)
1029 fp->bpf_func = NULL;
1032 err = bpf_check_classic(fp->insns, fp->len);
1034 __bpf_prog_release(fp);
1035 return ERR_PTR(err);
1038 /* There might be additional checks and transformations
1039 * needed on classic filters, f.e. in case of seccomp.
1042 err = trans(fp->insns, fp->len);
1044 __bpf_prog_release(fp);
1045 return ERR_PTR(err);
1049 /* Probe if we can JIT compile the filter and if so, do
1050 * the compilation of the filter.
1052 bpf_jit_compile(fp);
1054 /* JIT compiler couldn't process this filter, so do the
1055 * internal BPF translation for the optimized interpreter.
1058 fp = bpf_migrate_filter(fp);
1064 * bpf_prog_create - create an unattached filter
1065 * @pfp: the unattached filter that is created
1066 * @fprog: the filter program
1068 * Create a filter independent of any socket. We first run some
1069 * sanity checks on it to make sure it does not explode on us later.
1070 * If an error occurs or there is insufficient memory for the filter
1071 * a negative errno code is returned. On success the return is zero.
1073 int bpf_prog_create(struct bpf_prog **pfp, struct sock_fprog_kern *fprog)
1075 unsigned int fsize = bpf_classic_proglen(fprog);
1076 struct bpf_prog *fp;
1078 /* Make sure new filter is there and in the right amounts. */
1079 if (!bpf_check_basics_ok(fprog->filter, fprog->len))
1082 fp = bpf_prog_alloc(bpf_prog_size(fprog->len), 0);
1086 memcpy(fp->insns, fprog->filter, fsize);
1088 fp->len = fprog->len;
1089 /* Since unattached filters are not copied back to user
1090 * space through sk_get_filter(), we do not need to hold
1091 * a copy here, and can spare us the work.
1093 fp->orig_prog = NULL;
1095 /* bpf_prepare_filter() already takes care of freeing
1096 * memory in case something goes wrong.
1098 fp = bpf_prepare_filter(fp, NULL);
1105 EXPORT_SYMBOL_GPL(bpf_prog_create);
1108 * bpf_prog_create_from_user - create an unattached filter from user buffer
1109 * @pfp: the unattached filter that is created
1110 * @fprog: the filter program
1111 * @trans: post-classic verifier transformation handler
1112 * @save_orig: save classic BPF program
1114 * This function effectively does the same as bpf_prog_create(), only
1115 * that it builds up its insns buffer from user space provided buffer.
1116 * It also allows for passing a bpf_aux_classic_check_t handler.
1118 int bpf_prog_create_from_user(struct bpf_prog **pfp, struct sock_fprog *fprog,
1119 bpf_aux_classic_check_t trans, bool save_orig)
1121 unsigned int fsize = bpf_classic_proglen(fprog);
1122 struct bpf_prog *fp;
1125 /* Make sure new filter is there and in the right amounts. */
1126 if (!bpf_check_basics_ok(fprog->filter, fprog->len))
1129 fp = bpf_prog_alloc(bpf_prog_size(fprog->len), 0);
1133 if (copy_from_user(fp->insns, fprog->filter, fsize)) {
1134 __bpf_prog_free(fp);
1138 fp->len = fprog->len;
1139 fp->orig_prog = NULL;
1142 err = bpf_prog_store_orig_filter(fp, fprog);
1144 __bpf_prog_free(fp);
1149 /* bpf_prepare_filter() already takes care of freeing
1150 * memory in case something goes wrong.
1152 fp = bpf_prepare_filter(fp, trans);
1159 EXPORT_SYMBOL_GPL(bpf_prog_create_from_user);
1161 void bpf_prog_destroy(struct bpf_prog *fp)
1163 __bpf_prog_release(fp);
1165 EXPORT_SYMBOL_GPL(bpf_prog_destroy);
1167 static int __sk_attach_prog(struct bpf_prog *prog, struct sock *sk)
1169 struct sk_filter *fp, *old_fp;
1171 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
1176 atomic_set(&fp->refcnt, 0);
1178 if (!sk_filter_charge(sk, fp)) {
1183 old_fp = rcu_dereference_protected(sk->sk_filter,
1184 lockdep_sock_is_held(sk));
1185 rcu_assign_pointer(sk->sk_filter, fp);
1188 sk_filter_uncharge(sk, old_fp);
1193 static int __reuseport_attach_prog(struct bpf_prog *prog, struct sock *sk)
1195 struct bpf_prog *old_prog;
1198 if (bpf_prog_size(prog->len) > sysctl_optmem_max)
1201 if (sk_unhashed(sk) && sk->sk_reuseport) {
1202 err = reuseport_alloc(sk);
1205 } else if (!rcu_access_pointer(sk->sk_reuseport_cb)) {
1206 /* The socket wasn't bound with SO_REUSEPORT */
1210 old_prog = reuseport_attach_prog(sk, prog);
1212 bpf_prog_destroy(old_prog);
1218 struct bpf_prog *__get_filter(struct sock_fprog *fprog, struct sock *sk)
1220 unsigned int fsize = bpf_classic_proglen(fprog);
1221 struct bpf_prog *prog;
1224 if (sock_flag(sk, SOCK_FILTER_LOCKED))
1225 return ERR_PTR(-EPERM);
1227 /* Make sure new filter is there and in the right amounts. */
1228 if (!bpf_check_basics_ok(fprog->filter, fprog->len))
1229 return ERR_PTR(-EINVAL);
1231 prog = bpf_prog_alloc(bpf_prog_size(fprog->len), 0);
1233 return ERR_PTR(-ENOMEM);
1235 if (copy_from_user(prog->insns, fprog->filter, fsize)) {
1236 __bpf_prog_free(prog);
1237 return ERR_PTR(-EFAULT);
1240 prog->len = fprog->len;
1242 err = bpf_prog_store_orig_filter(prog, fprog);
1244 __bpf_prog_free(prog);
1245 return ERR_PTR(-ENOMEM);
1248 /* bpf_prepare_filter() already takes care of freeing
1249 * memory in case something goes wrong.
1251 return bpf_prepare_filter(prog, NULL);
1255 * sk_attach_filter - attach a socket filter
1256 * @fprog: the filter program
1257 * @sk: the socket to use
1259 * Attach the user's filter code. We first run some sanity checks on
1260 * it to make sure it does not explode on us later. If an error
1261 * occurs or there is insufficient memory for the filter a negative
1262 * errno code is returned. On success the return is zero.
1264 int sk_attach_filter(struct sock_fprog *fprog, struct sock *sk)
1266 struct bpf_prog *prog = __get_filter(fprog, sk);
1270 return PTR_ERR(prog);
1272 err = __sk_attach_prog(prog, sk);
1274 __bpf_prog_release(prog);
1280 EXPORT_SYMBOL_GPL(sk_attach_filter);
1282 int sk_reuseport_attach_filter(struct sock_fprog *fprog, struct sock *sk)
1284 struct bpf_prog *prog = __get_filter(fprog, sk);
1288 return PTR_ERR(prog);
1290 err = __reuseport_attach_prog(prog, sk);
1292 __bpf_prog_release(prog);
1299 static struct bpf_prog *__get_bpf(u32 ufd, struct sock *sk)
1301 if (sock_flag(sk, SOCK_FILTER_LOCKED))
1302 return ERR_PTR(-EPERM);
1304 return bpf_prog_get_type(ufd, BPF_PROG_TYPE_SOCKET_FILTER);
1307 int sk_attach_bpf(u32 ufd, struct sock *sk)
1309 struct bpf_prog *prog = __get_bpf(ufd, sk);
1313 return PTR_ERR(prog);
1315 err = __sk_attach_prog(prog, sk);
1324 int sk_reuseport_attach_bpf(u32 ufd, struct sock *sk)
1326 struct bpf_prog *prog = __get_bpf(ufd, sk);
1330 return PTR_ERR(prog);
1332 err = __reuseport_attach_prog(prog, sk);
1341 struct bpf_scratchpad {
1343 __be32 diff[MAX_BPF_STACK / sizeof(__be32)];
1344 u8 buff[MAX_BPF_STACK];
1348 static DEFINE_PER_CPU(struct bpf_scratchpad, bpf_sp);
1350 static inline int __bpf_try_make_writable(struct sk_buff *skb,
1351 unsigned int write_len)
1353 return skb_ensure_writable(skb, write_len);
1356 static inline int bpf_try_make_writable(struct sk_buff *skb,
1357 unsigned int write_len)
1359 int err = __bpf_try_make_writable(skb, write_len);
1361 bpf_compute_data_end(skb);
1365 static int bpf_try_make_head_writable(struct sk_buff *skb)
1367 return bpf_try_make_writable(skb, skb_headlen(skb));
1370 static inline void bpf_push_mac_rcsum(struct sk_buff *skb)
1372 if (skb_at_tc_ingress(skb))
1373 skb_postpush_rcsum(skb, skb_mac_header(skb), skb->mac_len);
1376 static inline void bpf_pull_mac_rcsum(struct sk_buff *skb)
1378 if (skb_at_tc_ingress(skb))
1379 skb_postpull_rcsum(skb, skb_mac_header(skb), skb->mac_len);
1382 BPF_CALL_5(bpf_skb_store_bytes, struct sk_buff *, skb, u32, offset,
1383 const void *, from, u32, len, u64, flags)
1387 if (unlikely(flags & ~(BPF_F_RECOMPUTE_CSUM | BPF_F_INVALIDATE_HASH)))
1389 if (unlikely(offset > 0xffff))
1391 if (unlikely(bpf_try_make_writable(skb, offset + len)))
1394 ptr = skb->data + offset;
1395 if (flags & BPF_F_RECOMPUTE_CSUM)
1396 __skb_postpull_rcsum(skb, ptr, len, offset);
1398 memcpy(ptr, from, len);
1400 if (flags & BPF_F_RECOMPUTE_CSUM)
1401 __skb_postpush_rcsum(skb, ptr, len, offset);
1402 if (flags & BPF_F_INVALIDATE_HASH)
1403 skb_clear_hash(skb);
1408 static const struct bpf_func_proto bpf_skb_store_bytes_proto = {
1409 .func = bpf_skb_store_bytes,
1411 .ret_type = RET_INTEGER,
1412 .arg1_type = ARG_PTR_TO_CTX,
1413 .arg2_type = ARG_ANYTHING,
1414 .arg3_type = ARG_PTR_TO_STACK,
1415 .arg4_type = ARG_CONST_STACK_SIZE,
1416 .arg5_type = ARG_ANYTHING,
1419 BPF_CALL_4(bpf_skb_load_bytes, const struct sk_buff *, skb, u32, offset,
1420 void *, to, u32, len)
1424 if (unlikely(offset > 0xffff))
1427 ptr = skb_header_pointer(skb, offset, len, to);
1431 memcpy(to, ptr, len);
1439 static const struct bpf_func_proto bpf_skb_load_bytes_proto = {
1440 .func = bpf_skb_load_bytes,
1442 .ret_type = RET_INTEGER,
1443 .arg1_type = ARG_PTR_TO_CTX,
1444 .arg2_type = ARG_ANYTHING,
1445 .arg3_type = ARG_PTR_TO_RAW_STACK,
1446 .arg4_type = ARG_CONST_STACK_SIZE,
1449 BPF_CALL_2(bpf_skb_pull_data, struct sk_buff *, skb, u32, len)
1451 /* Idea is the following: should the needed direct read/write
1452 * test fail during runtime, we can pull in more data and redo
1453 * again, since implicitly, we invalidate previous checks here.
1455 * Or, since we know how much we need to make read/writeable,
1456 * this can be done once at the program beginning for direct
1457 * access case. By this we overcome limitations of only current
1458 * headroom being accessible.
1460 return bpf_try_make_writable(skb, len ? : skb_headlen(skb));
1463 static const struct bpf_func_proto bpf_skb_pull_data_proto = {
1464 .func = bpf_skb_pull_data,
1466 .ret_type = RET_INTEGER,
1467 .arg1_type = ARG_PTR_TO_CTX,
1468 .arg2_type = ARG_ANYTHING,
1471 BPF_CALL_5(bpf_l3_csum_replace, struct sk_buff *, skb, u32, offset,
1472 u64, from, u64, to, u64, flags)
1476 if (unlikely(flags & ~(BPF_F_HDR_FIELD_MASK)))
1478 if (unlikely(offset > 0xffff || offset & 1))
1480 if (unlikely(bpf_try_make_writable(skb, offset + sizeof(*ptr))))
1483 ptr = (__sum16 *)(skb->data + offset);
1484 switch (flags & BPF_F_HDR_FIELD_MASK) {
1486 if (unlikely(from != 0))
1489 csum_replace_by_diff(ptr, to);
1492 csum_replace2(ptr, from, to);
1495 csum_replace4(ptr, from, to);
1504 static const struct bpf_func_proto bpf_l3_csum_replace_proto = {
1505 .func = bpf_l3_csum_replace,
1507 .ret_type = RET_INTEGER,
1508 .arg1_type = ARG_PTR_TO_CTX,
1509 .arg2_type = ARG_ANYTHING,
1510 .arg3_type = ARG_ANYTHING,
1511 .arg4_type = ARG_ANYTHING,
1512 .arg5_type = ARG_ANYTHING,
1515 BPF_CALL_5(bpf_l4_csum_replace, struct sk_buff *, skb, u32, offset,
1516 u64, from, u64, to, u64, flags)
1518 bool is_pseudo = flags & BPF_F_PSEUDO_HDR;
1519 bool is_mmzero = flags & BPF_F_MARK_MANGLED_0;
1522 if (unlikely(flags & ~(BPF_F_MARK_MANGLED_0 | BPF_F_PSEUDO_HDR |
1523 BPF_F_HDR_FIELD_MASK)))
1525 if (unlikely(offset > 0xffff || offset & 1))
1527 if (unlikely(bpf_try_make_writable(skb, offset + sizeof(*ptr))))
1530 ptr = (__sum16 *)(skb->data + offset);
1531 if (is_mmzero && !*ptr)
1534 switch (flags & BPF_F_HDR_FIELD_MASK) {
1536 if (unlikely(from != 0))
1539 inet_proto_csum_replace_by_diff(ptr, skb, to, is_pseudo);
1542 inet_proto_csum_replace2(ptr, skb, from, to, is_pseudo);
1545 inet_proto_csum_replace4(ptr, skb, from, to, is_pseudo);
1551 if (is_mmzero && !*ptr)
1552 *ptr = CSUM_MANGLED_0;
1556 static const struct bpf_func_proto bpf_l4_csum_replace_proto = {
1557 .func = bpf_l4_csum_replace,
1559 .ret_type = RET_INTEGER,
1560 .arg1_type = ARG_PTR_TO_CTX,
1561 .arg2_type = ARG_ANYTHING,
1562 .arg3_type = ARG_ANYTHING,
1563 .arg4_type = ARG_ANYTHING,
1564 .arg5_type = ARG_ANYTHING,
1567 BPF_CALL_5(bpf_csum_diff, __be32 *, from, u32, from_size,
1568 __be32 *, to, u32, to_size, __wsum, seed)
1570 struct bpf_scratchpad *sp = this_cpu_ptr(&bpf_sp);
1571 u32 diff_size = from_size + to_size;
1574 /* This is quite flexible, some examples:
1576 * from_size == 0, to_size > 0, seed := csum --> pushing data
1577 * from_size > 0, to_size == 0, seed := csum --> pulling data
1578 * from_size > 0, to_size > 0, seed := 0 --> diffing data
1580 * Even for diffing, from_size and to_size don't need to be equal.
1582 if (unlikely(((from_size | to_size) & (sizeof(__be32) - 1)) ||
1583 diff_size > sizeof(sp->diff)))
1586 for (i = 0; i < from_size / sizeof(__be32); i++, j++)
1587 sp->diff[j] = ~from[i];
1588 for (i = 0; i < to_size / sizeof(__be32); i++, j++)
1589 sp->diff[j] = to[i];
1591 return csum_partial(sp->diff, diff_size, seed);
1594 static const struct bpf_func_proto bpf_csum_diff_proto = {
1595 .func = bpf_csum_diff,
1598 .ret_type = RET_INTEGER,
1599 .arg1_type = ARG_PTR_TO_STACK,
1600 .arg2_type = ARG_CONST_STACK_SIZE_OR_ZERO,
1601 .arg3_type = ARG_PTR_TO_STACK,
1602 .arg4_type = ARG_CONST_STACK_SIZE_OR_ZERO,
1603 .arg5_type = ARG_ANYTHING,
1606 BPF_CALL_2(bpf_csum_update, struct sk_buff *, skb, __wsum, csum)
1608 /* The interface is to be used in combination with bpf_csum_diff()
1609 * for direct packet writes. csum rotation for alignment as well
1610 * as emulating csum_sub() can be done from the eBPF program.
1612 if (skb->ip_summed == CHECKSUM_COMPLETE)
1613 return (skb->csum = csum_add(skb->csum, csum));
1618 static const struct bpf_func_proto bpf_csum_update_proto = {
1619 .func = bpf_csum_update,
1621 .ret_type = RET_INTEGER,
1622 .arg1_type = ARG_PTR_TO_CTX,
1623 .arg2_type = ARG_ANYTHING,
1626 static inline int __bpf_rx_skb(struct net_device *dev, struct sk_buff *skb)
1628 return dev_forward_skb(dev, skb);
1631 static inline int __bpf_tx_skb(struct net_device *dev, struct sk_buff *skb)
1635 if (unlikely(__this_cpu_read(xmit_recursion) > XMIT_RECURSION_LIMIT)) {
1636 net_crit_ratelimited("bpf: recursion limit reached on datapath, buggy bpf program?\n");
1643 __this_cpu_inc(xmit_recursion);
1644 ret = dev_queue_xmit(skb);
1645 __this_cpu_dec(xmit_recursion);
1650 BPF_CALL_3(bpf_clone_redirect, struct sk_buff *, skb, u32, ifindex, u64, flags)
1652 struct net_device *dev;
1653 struct sk_buff *clone;
1656 if (unlikely(flags & ~(BPF_F_INGRESS)))
1659 dev = dev_get_by_index_rcu(dev_net(skb->dev), ifindex);
1663 clone = skb_clone(skb, GFP_ATOMIC);
1664 if (unlikely(!clone))
1667 /* For direct write, we need to keep the invariant that the skbs
1668 * we're dealing with need to be uncloned. Should uncloning fail
1669 * here, we need to free the just generated clone to unclone once
1672 ret = bpf_try_make_head_writable(skb);
1673 if (unlikely(ret)) {
1678 bpf_push_mac_rcsum(clone);
1680 return flags & BPF_F_INGRESS ?
1681 __bpf_rx_skb(dev, clone) : __bpf_tx_skb(dev, clone);
1684 static const struct bpf_func_proto bpf_clone_redirect_proto = {
1685 .func = bpf_clone_redirect,
1687 .ret_type = RET_INTEGER,
1688 .arg1_type = ARG_PTR_TO_CTX,
1689 .arg2_type = ARG_ANYTHING,
1690 .arg3_type = ARG_ANYTHING,
1693 struct redirect_info {
1698 static DEFINE_PER_CPU(struct redirect_info, redirect_info);
1700 BPF_CALL_2(bpf_redirect, u32, ifindex, u64, flags)
1702 struct redirect_info *ri = this_cpu_ptr(&redirect_info);
1704 if (unlikely(flags & ~(BPF_F_INGRESS)))
1707 ri->ifindex = ifindex;
1710 return TC_ACT_REDIRECT;
1713 int skb_do_redirect(struct sk_buff *skb)
1715 struct redirect_info *ri = this_cpu_ptr(&redirect_info);
1716 struct net_device *dev;
1718 dev = dev_get_by_index_rcu(dev_net(skb->dev), ri->ifindex);
1720 if (unlikely(!dev)) {
1725 bpf_push_mac_rcsum(skb);
1727 return ri->flags & BPF_F_INGRESS ?
1728 __bpf_rx_skb(dev, skb) : __bpf_tx_skb(dev, skb);
1731 static const struct bpf_func_proto bpf_redirect_proto = {
1732 .func = bpf_redirect,
1734 .ret_type = RET_INTEGER,
1735 .arg1_type = ARG_ANYTHING,
1736 .arg2_type = ARG_ANYTHING,
1739 BPF_CALL_1(bpf_get_cgroup_classid, const struct sk_buff *, skb)
1741 return task_get_classid(skb);
1744 static const struct bpf_func_proto bpf_get_cgroup_classid_proto = {
1745 .func = bpf_get_cgroup_classid,
1747 .ret_type = RET_INTEGER,
1748 .arg1_type = ARG_PTR_TO_CTX,
1751 BPF_CALL_1(bpf_get_route_realm, const struct sk_buff *, skb)
1753 return dst_tclassid(skb);
1756 static const struct bpf_func_proto bpf_get_route_realm_proto = {
1757 .func = bpf_get_route_realm,
1759 .ret_type = RET_INTEGER,
1760 .arg1_type = ARG_PTR_TO_CTX,
1763 BPF_CALL_1(bpf_get_hash_recalc, struct sk_buff *, skb)
1765 /* If skb_clear_hash() was called due to mangling, we can
1766 * trigger SW recalculation here. Later access to hash
1767 * can then use the inline skb->hash via context directly
1768 * instead of calling this helper again.
1770 return skb_get_hash(skb);
1773 static const struct bpf_func_proto bpf_get_hash_recalc_proto = {
1774 .func = bpf_get_hash_recalc,
1776 .ret_type = RET_INTEGER,
1777 .arg1_type = ARG_PTR_TO_CTX,
1780 BPF_CALL_3(bpf_skb_vlan_push, struct sk_buff *, skb, __be16, vlan_proto,
1785 if (unlikely(vlan_proto != htons(ETH_P_8021Q) &&
1786 vlan_proto != htons(ETH_P_8021AD)))
1787 vlan_proto = htons(ETH_P_8021Q);
1789 bpf_push_mac_rcsum(skb);
1790 ret = skb_vlan_push(skb, vlan_proto, vlan_tci);
1791 bpf_pull_mac_rcsum(skb);
1793 bpf_compute_data_end(skb);
1797 const struct bpf_func_proto bpf_skb_vlan_push_proto = {
1798 .func = bpf_skb_vlan_push,
1800 .ret_type = RET_INTEGER,
1801 .arg1_type = ARG_PTR_TO_CTX,
1802 .arg2_type = ARG_ANYTHING,
1803 .arg3_type = ARG_ANYTHING,
1805 EXPORT_SYMBOL_GPL(bpf_skb_vlan_push_proto);
1807 BPF_CALL_1(bpf_skb_vlan_pop, struct sk_buff *, skb)
1811 bpf_push_mac_rcsum(skb);
1812 ret = skb_vlan_pop(skb);
1813 bpf_pull_mac_rcsum(skb);
1815 bpf_compute_data_end(skb);
1819 const struct bpf_func_proto bpf_skb_vlan_pop_proto = {
1820 .func = bpf_skb_vlan_pop,
1822 .ret_type = RET_INTEGER,
1823 .arg1_type = ARG_PTR_TO_CTX,
1825 EXPORT_SYMBOL_GPL(bpf_skb_vlan_pop_proto);
1827 static int bpf_skb_generic_push(struct sk_buff *skb, u32 off, u32 len)
1829 /* Caller already did skb_cow() with len as headroom,
1830 * so no need to do it here.
1833 memmove(skb->data, skb->data + len, off);
1834 memset(skb->data + off, 0, len);
1836 /* No skb_postpush_rcsum(skb, skb->data + off, len)
1837 * needed here as it does not change the skb->csum
1838 * result for checksum complete when summing over
1844 static int bpf_skb_generic_pop(struct sk_buff *skb, u32 off, u32 len)
1846 /* skb_ensure_writable() is not needed here, as we're
1847 * already working on an uncloned skb.
1849 if (unlikely(!pskb_may_pull(skb, off + len)))
1852 skb_postpull_rcsum(skb, skb->data + off, len);
1853 memmove(skb->data + len, skb->data, off);
1854 __skb_pull(skb, len);
1859 static int bpf_skb_net_hdr_push(struct sk_buff *skb, u32 off, u32 len)
1861 bool trans_same = skb->transport_header == skb->network_header;
1864 /* There's no need for __skb_push()/__skb_pull() pair to
1865 * get to the start of the mac header as we're guaranteed
1866 * to always start from here under eBPF.
1868 ret = bpf_skb_generic_push(skb, off, len);
1870 skb->mac_header -= len;
1871 skb->network_header -= len;
1873 skb->transport_header = skb->network_header;
1879 static int bpf_skb_net_hdr_pop(struct sk_buff *skb, u32 off, u32 len)
1881 bool trans_same = skb->transport_header == skb->network_header;
1884 /* Same here, __skb_push()/__skb_pull() pair not needed. */
1885 ret = bpf_skb_generic_pop(skb, off, len);
1887 skb->mac_header += len;
1888 skb->network_header += len;
1890 skb->transport_header = skb->network_header;
1896 static int bpf_skb_proto_4_to_6(struct sk_buff *skb)
1898 const u32 len_diff = sizeof(struct ipv6hdr) - sizeof(struct iphdr);
1899 u32 off = skb->network_header - skb->mac_header;
1902 ret = skb_cow(skb, len_diff);
1903 if (unlikely(ret < 0))
1906 ret = bpf_skb_net_hdr_push(skb, off, len_diff);
1907 if (unlikely(ret < 0))
1910 if (skb_is_gso(skb)) {
1911 /* SKB_GSO_UDP stays as is. SKB_GSO_TCPV4 needs to
1912 * be changed into SKB_GSO_TCPV6.
1914 if (skb_shinfo(skb)->gso_type & SKB_GSO_TCPV4) {
1915 skb_shinfo(skb)->gso_type &= ~SKB_GSO_TCPV4;
1916 skb_shinfo(skb)->gso_type |= SKB_GSO_TCPV6;
1919 /* Due to IPv6 header, MSS needs to be downgraded. */
1920 skb_shinfo(skb)->gso_size -= len_diff;
1921 /* Header must be checked, and gso_segs recomputed. */
1922 skb_shinfo(skb)->gso_type |= SKB_GSO_DODGY;
1923 skb_shinfo(skb)->gso_segs = 0;
1926 skb->protocol = htons(ETH_P_IPV6);
1927 skb_clear_hash(skb);
1932 static int bpf_skb_proto_6_to_4(struct sk_buff *skb)
1934 const u32 len_diff = sizeof(struct ipv6hdr) - sizeof(struct iphdr);
1935 u32 off = skb->network_header - skb->mac_header;
1938 ret = skb_unclone(skb, GFP_ATOMIC);
1939 if (unlikely(ret < 0))
1942 ret = bpf_skb_net_hdr_pop(skb, off, len_diff);
1943 if (unlikely(ret < 0))
1946 if (skb_is_gso(skb)) {
1947 /* SKB_GSO_UDP stays as is. SKB_GSO_TCPV6 needs to
1948 * be changed into SKB_GSO_TCPV4.
1950 if (skb_shinfo(skb)->gso_type & SKB_GSO_TCPV6) {
1951 skb_shinfo(skb)->gso_type &= ~SKB_GSO_TCPV6;
1952 skb_shinfo(skb)->gso_type |= SKB_GSO_TCPV4;
1955 /* Due to IPv4 header, MSS can be upgraded. */
1956 skb_shinfo(skb)->gso_size += len_diff;
1957 /* Header must be checked, and gso_segs recomputed. */
1958 skb_shinfo(skb)->gso_type |= SKB_GSO_DODGY;
1959 skb_shinfo(skb)->gso_segs = 0;
1962 skb->protocol = htons(ETH_P_IP);
1963 skb_clear_hash(skb);
1968 static int bpf_skb_proto_xlat(struct sk_buff *skb, __be16 to_proto)
1970 __be16 from_proto = skb->protocol;
1972 if (from_proto == htons(ETH_P_IP) &&
1973 to_proto == htons(ETH_P_IPV6))
1974 return bpf_skb_proto_4_to_6(skb);
1976 if (from_proto == htons(ETH_P_IPV6) &&
1977 to_proto == htons(ETH_P_IP))
1978 return bpf_skb_proto_6_to_4(skb);
1983 BPF_CALL_3(bpf_skb_change_proto, struct sk_buff *, skb, __be16, proto,
1988 if (unlikely(flags))
1991 /* General idea is that this helper does the basic groundwork
1992 * needed for changing the protocol, and eBPF program fills the
1993 * rest through bpf_skb_store_bytes(), bpf_lX_csum_replace()
1994 * and other helpers, rather than passing a raw buffer here.
1996 * The rationale is to keep this minimal and without a need to
1997 * deal with raw packet data. F.e. even if we would pass buffers
1998 * here, the program still needs to call the bpf_lX_csum_replace()
1999 * helpers anyway. Plus, this way we keep also separation of
2000 * concerns, since f.e. bpf_skb_store_bytes() should only take
2003 * Currently, additional options and extension header space are
2004 * not supported, but flags register is reserved so we can adapt
2005 * that. For offloads, we mark packet as dodgy, so that headers
2006 * need to be verified first.
2008 ret = bpf_skb_proto_xlat(skb, proto);
2009 bpf_compute_data_end(skb);
2013 static const struct bpf_func_proto bpf_skb_change_proto_proto = {
2014 .func = bpf_skb_change_proto,
2016 .ret_type = RET_INTEGER,
2017 .arg1_type = ARG_PTR_TO_CTX,
2018 .arg2_type = ARG_ANYTHING,
2019 .arg3_type = ARG_ANYTHING,
2022 BPF_CALL_2(bpf_skb_change_type, struct sk_buff *, skb, u32, pkt_type)
2024 /* We only allow a restricted subset to be changed for now. */
2025 if (unlikely(!skb_pkt_type_ok(skb->pkt_type) ||
2026 !skb_pkt_type_ok(pkt_type)))
2029 skb->pkt_type = pkt_type;
2033 static const struct bpf_func_proto bpf_skb_change_type_proto = {
2034 .func = bpf_skb_change_type,
2036 .ret_type = RET_INTEGER,
2037 .arg1_type = ARG_PTR_TO_CTX,
2038 .arg2_type = ARG_ANYTHING,
2041 static u32 __bpf_skb_min_len(const struct sk_buff *skb)
2043 u32 min_len = skb_network_offset(skb);
2045 if (skb_transport_header_was_set(skb))
2046 min_len = skb_transport_offset(skb);
2047 if (skb->ip_summed == CHECKSUM_PARTIAL)
2048 min_len = skb_checksum_start_offset(skb) +
2049 skb->csum_offset + sizeof(__sum16);
2053 static u32 __bpf_skb_max_len(const struct sk_buff *skb)
2055 return skb->dev->mtu + skb->dev->hard_header_len;
2058 static int bpf_skb_grow_rcsum(struct sk_buff *skb, unsigned int new_len)
2060 unsigned int old_len = skb->len;
2063 ret = __skb_grow_rcsum(skb, new_len);
2065 memset(skb->data + old_len, 0, new_len - old_len);
2069 static int bpf_skb_trim_rcsum(struct sk_buff *skb, unsigned int new_len)
2071 return __skb_trim_rcsum(skb, new_len);
2074 BPF_CALL_3(bpf_skb_change_tail, struct sk_buff *, skb, u32, new_len,
2077 u32 max_len = __bpf_skb_max_len(skb);
2078 u32 min_len = __bpf_skb_min_len(skb);
2081 if (unlikely(flags || new_len > max_len || new_len < min_len))
2083 if (skb->encapsulation)
2086 /* The basic idea of this helper is that it's performing the
2087 * needed work to either grow or trim an skb, and eBPF program
2088 * rewrites the rest via helpers like bpf_skb_store_bytes(),
2089 * bpf_lX_csum_replace() and others rather than passing a raw
2090 * buffer here. This one is a slow path helper and intended
2091 * for replies with control messages.
2093 * Like in bpf_skb_change_proto(), we want to keep this rather
2094 * minimal and without protocol specifics so that we are able
2095 * to separate concerns as in bpf_skb_store_bytes() should only
2096 * be the one responsible for writing buffers.
2098 * It's really expected to be a slow path operation here for
2099 * control message replies, so we're implicitly linearizing,
2100 * uncloning and drop offloads from the skb by this.
2102 ret = __bpf_try_make_writable(skb, skb->len);
2104 if (new_len > skb->len)
2105 ret = bpf_skb_grow_rcsum(skb, new_len);
2106 else if (new_len < skb->len)
2107 ret = bpf_skb_trim_rcsum(skb, new_len);
2108 if (!ret && skb_is_gso(skb))
2112 bpf_compute_data_end(skb);
2116 static const struct bpf_func_proto bpf_skb_change_tail_proto = {
2117 .func = bpf_skb_change_tail,
2119 .ret_type = RET_INTEGER,
2120 .arg1_type = ARG_PTR_TO_CTX,
2121 .arg2_type = ARG_ANYTHING,
2122 .arg3_type = ARG_ANYTHING,
2125 bool bpf_helper_changes_skb_data(void *func)
2127 if (func == bpf_skb_vlan_push ||
2128 func == bpf_skb_vlan_pop ||
2129 func == bpf_skb_store_bytes ||
2130 func == bpf_skb_change_proto ||
2131 func == bpf_skb_change_tail ||
2132 func == bpf_skb_pull_data ||
2133 func == bpf_l3_csum_replace ||
2134 func == bpf_l4_csum_replace)
2140 static unsigned long bpf_skb_copy(void *dst_buff, const void *skb,
2141 unsigned long off, unsigned long len)
2143 void *ptr = skb_header_pointer(skb, off, len, dst_buff);
2147 if (ptr != dst_buff)
2148 memcpy(dst_buff, ptr, len);
2153 BPF_CALL_5(bpf_skb_event_output, struct sk_buff *, skb, struct bpf_map *, map,
2154 u64, flags, void *, meta, u64, meta_size)
2156 u64 skb_size = (flags & BPF_F_CTXLEN_MASK) >> 32;
2158 if (unlikely(flags & ~(BPF_F_CTXLEN_MASK | BPF_F_INDEX_MASK)))
2160 if (unlikely(skb_size > skb->len))
2163 return bpf_event_output(map, flags, meta, meta_size, skb, skb_size,
2167 static const struct bpf_func_proto bpf_skb_event_output_proto = {
2168 .func = bpf_skb_event_output,
2170 .ret_type = RET_INTEGER,
2171 .arg1_type = ARG_PTR_TO_CTX,
2172 .arg2_type = ARG_CONST_MAP_PTR,
2173 .arg3_type = ARG_ANYTHING,
2174 .arg4_type = ARG_PTR_TO_STACK,
2175 .arg5_type = ARG_CONST_STACK_SIZE,
2178 static unsigned short bpf_tunnel_key_af(u64 flags)
2180 return flags & BPF_F_TUNINFO_IPV6 ? AF_INET6 : AF_INET;
2183 BPF_CALL_4(bpf_skb_get_tunnel_key, struct sk_buff *, skb, struct bpf_tunnel_key *, to,
2184 u32, size, u64, flags)
2186 const struct ip_tunnel_info *info = skb_tunnel_info(skb);
2187 u8 compat[sizeof(struct bpf_tunnel_key)];
2191 if (unlikely(!info || (flags & ~(BPF_F_TUNINFO_IPV6)))) {
2195 if (ip_tunnel_info_af(info) != bpf_tunnel_key_af(flags)) {
2199 if (unlikely(size != sizeof(struct bpf_tunnel_key))) {
2202 case offsetof(struct bpf_tunnel_key, tunnel_label):
2203 case offsetof(struct bpf_tunnel_key, tunnel_ext):
2205 case offsetof(struct bpf_tunnel_key, remote_ipv6[1]):
2206 /* Fixup deprecated structure layouts here, so we have
2207 * a common path later on.
2209 if (ip_tunnel_info_af(info) != AF_INET)
2212 to = (struct bpf_tunnel_key *)compat;
2219 to->tunnel_id = be64_to_cpu(info->key.tun_id);
2220 to->tunnel_tos = info->key.tos;
2221 to->tunnel_ttl = info->key.ttl;
2223 if (flags & BPF_F_TUNINFO_IPV6) {
2224 memcpy(to->remote_ipv6, &info->key.u.ipv6.src,
2225 sizeof(to->remote_ipv6));
2226 to->tunnel_label = be32_to_cpu(info->key.label);
2228 to->remote_ipv4 = be32_to_cpu(info->key.u.ipv4.src);
2231 if (unlikely(size != sizeof(struct bpf_tunnel_key)))
2232 memcpy(to_orig, to, size);
2236 memset(to_orig, 0, size);
2240 static const struct bpf_func_proto bpf_skb_get_tunnel_key_proto = {
2241 .func = bpf_skb_get_tunnel_key,
2243 .ret_type = RET_INTEGER,
2244 .arg1_type = ARG_PTR_TO_CTX,
2245 .arg2_type = ARG_PTR_TO_RAW_STACK,
2246 .arg3_type = ARG_CONST_STACK_SIZE,
2247 .arg4_type = ARG_ANYTHING,
2250 BPF_CALL_3(bpf_skb_get_tunnel_opt, struct sk_buff *, skb, u8 *, to, u32, size)
2252 const struct ip_tunnel_info *info = skb_tunnel_info(skb);
2255 if (unlikely(!info ||
2256 !(info->key.tun_flags & TUNNEL_OPTIONS_PRESENT))) {
2260 if (unlikely(size < info->options_len)) {
2265 ip_tunnel_info_opts_get(to, info);
2266 if (size > info->options_len)
2267 memset(to + info->options_len, 0, size - info->options_len);
2269 return info->options_len;
2271 memset(to, 0, size);
2275 static const struct bpf_func_proto bpf_skb_get_tunnel_opt_proto = {
2276 .func = bpf_skb_get_tunnel_opt,
2278 .ret_type = RET_INTEGER,
2279 .arg1_type = ARG_PTR_TO_CTX,
2280 .arg2_type = ARG_PTR_TO_RAW_STACK,
2281 .arg3_type = ARG_CONST_STACK_SIZE,
2284 static struct metadata_dst __percpu *md_dst;
2286 BPF_CALL_4(bpf_skb_set_tunnel_key, struct sk_buff *, skb,
2287 const struct bpf_tunnel_key *, from, u32, size, u64, flags)
2289 struct metadata_dst *md = this_cpu_ptr(md_dst);
2290 u8 compat[sizeof(struct bpf_tunnel_key)];
2291 struct ip_tunnel_info *info;
2293 if (unlikely(flags & ~(BPF_F_TUNINFO_IPV6 | BPF_F_ZERO_CSUM_TX |
2294 BPF_F_DONT_FRAGMENT)))
2296 if (unlikely(size != sizeof(struct bpf_tunnel_key))) {
2298 case offsetof(struct bpf_tunnel_key, tunnel_label):
2299 case offsetof(struct bpf_tunnel_key, tunnel_ext):
2300 case offsetof(struct bpf_tunnel_key, remote_ipv6[1]):
2301 /* Fixup deprecated structure layouts here, so we have
2302 * a common path later on.
2304 memcpy(compat, from, size);
2305 memset(compat + size, 0, sizeof(compat) - size);
2306 from = (const struct bpf_tunnel_key *) compat;
2312 if (unlikely((!(flags & BPF_F_TUNINFO_IPV6) && from->tunnel_label) ||
2317 dst_hold((struct dst_entry *) md);
2318 skb_dst_set(skb, (struct dst_entry *) md);
2320 info = &md->u.tun_info;
2321 info->mode = IP_TUNNEL_INFO_TX;
2323 info->key.tun_flags = TUNNEL_KEY | TUNNEL_CSUM | TUNNEL_NOCACHE;
2324 if (flags & BPF_F_DONT_FRAGMENT)
2325 info->key.tun_flags |= TUNNEL_DONT_FRAGMENT;
2327 info->key.tun_id = cpu_to_be64(from->tunnel_id);
2328 info->key.tos = from->tunnel_tos;
2329 info->key.ttl = from->tunnel_ttl;
2331 if (flags & BPF_F_TUNINFO_IPV6) {
2332 info->mode |= IP_TUNNEL_INFO_IPV6;
2333 memcpy(&info->key.u.ipv6.dst, from->remote_ipv6,
2334 sizeof(from->remote_ipv6));
2335 info->key.label = cpu_to_be32(from->tunnel_label) &
2336 IPV6_FLOWLABEL_MASK;
2338 info->key.u.ipv4.dst = cpu_to_be32(from->remote_ipv4);
2339 if (flags & BPF_F_ZERO_CSUM_TX)
2340 info->key.tun_flags &= ~TUNNEL_CSUM;
2346 static const struct bpf_func_proto bpf_skb_set_tunnel_key_proto = {
2347 .func = bpf_skb_set_tunnel_key,
2349 .ret_type = RET_INTEGER,
2350 .arg1_type = ARG_PTR_TO_CTX,
2351 .arg2_type = ARG_PTR_TO_STACK,
2352 .arg3_type = ARG_CONST_STACK_SIZE,
2353 .arg4_type = ARG_ANYTHING,
2356 BPF_CALL_3(bpf_skb_set_tunnel_opt, struct sk_buff *, skb,
2357 const u8 *, from, u32, size)
2359 struct ip_tunnel_info *info = skb_tunnel_info(skb);
2360 const struct metadata_dst *md = this_cpu_ptr(md_dst);
2362 if (unlikely(info != &md->u.tun_info || (size & (sizeof(u32) - 1))))
2364 if (unlikely(size > IP_TUNNEL_OPTS_MAX))
2367 ip_tunnel_info_opts_set(info, from, size);
2372 static const struct bpf_func_proto bpf_skb_set_tunnel_opt_proto = {
2373 .func = bpf_skb_set_tunnel_opt,
2375 .ret_type = RET_INTEGER,
2376 .arg1_type = ARG_PTR_TO_CTX,
2377 .arg2_type = ARG_PTR_TO_STACK,
2378 .arg3_type = ARG_CONST_STACK_SIZE,
2381 static const struct bpf_func_proto *
2382 bpf_get_skb_set_tunnel_proto(enum bpf_func_id which)
2385 /* Race is not possible, since it's called from verifier
2386 * that is holding verifier mutex.
2388 md_dst = metadata_dst_alloc_percpu(IP_TUNNEL_OPTS_MAX,
2395 case BPF_FUNC_skb_set_tunnel_key:
2396 return &bpf_skb_set_tunnel_key_proto;
2397 case BPF_FUNC_skb_set_tunnel_opt:
2398 return &bpf_skb_set_tunnel_opt_proto;
2404 BPF_CALL_3(bpf_skb_under_cgroup, struct sk_buff *, skb, struct bpf_map *, map,
2407 struct bpf_array *array = container_of(map, struct bpf_array, map);
2408 struct cgroup *cgrp;
2412 if (!sk || !sk_fullsock(sk))
2414 if (unlikely(idx >= array->map.max_entries))
2417 cgrp = READ_ONCE(array->ptrs[idx]);
2418 if (unlikely(!cgrp))
2421 return sk_under_cgroup_hierarchy(sk, cgrp);
2424 static const struct bpf_func_proto bpf_skb_under_cgroup_proto = {
2425 .func = bpf_skb_under_cgroup,
2427 .ret_type = RET_INTEGER,
2428 .arg1_type = ARG_PTR_TO_CTX,
2429 .arg2_type = ARG_CONST_MAP_PTR,
2430 .arg3_type = ARG_ANYTHING,
2433 static unsigned long bpf_xdp_copy(void *dst_buff, const void *src_buff,
2434 unsigned long off, unsigned long len)
2436 memcpy(dst_buff, src_buff + off, len);
2440 BPF_CALL_5(bpf_xdp_event_output, struct xdp_buff *, xdp, struct bpf_map *, map,
2441 u64, flags, void *, meta, u64, meta_size)
2443 u64 xdp_size = (flags & BPF_F_CTXLEN_MASK) >> 32;
2445 if (unlikely(flags & ~(BPF_F_CTXLEN_MASK | BPF_F_INDEX_MASK)))
2447 if (unlikely(xdp_size > (unsigned long)(xdp->data_end - xdp->data)))
2450 return bpf_event_output(map, flags, meta, meta_size, xdp, xdp_size,
2454 static const struct bpf_func_proto bpf_xdp_event_output_proto = {
2455 .func = bpf_xdp_event_output,
2457 .ret_type = RET_INTEGER,
2458 .arg1_type = ARG_PTR_TO_CTX,
2459 .arg2_type = ARG_CONST_MAP_PTR,
2460 .arg3_type = ARG_ANYTHING,
2461 .arg4_type = ARG_PTR_TO_STACK,
2462 .arg5_type = ARG_CONST_STACK_SIZE,
2465 static const struct bpf_func_proto *
2466 sk_filter_func_proto(enum bpf_func_id func_id)
2469 case BPF_FUNC_map_lookup_elem:
2470 return &bpf_map_lookup_elem_proto;
2471 case BPF_FUNC_map_update_elem:
2472 return &bpf_map_update_elem_proto;
2473 case BPF_FUNC_map_delete_elem:
2474 return &bpf_map_delete_elem_proto;
2475 case BPF_FUNC_get_prandom_u32:
2476 return &bpf_get_prandom_u32_proto;
2477 case BPF_FUNC_get_smp_processor_id:
2478 return &bpf_get_raw_smp_processor_id_proto;
2479 case BPF_FUNC_tail_call:
2480 return &bpf_tail_call_proto;
2481 case BPF_FUNC_ktime_get_ns:
2482 return &bpf_ktime_get_ns_proto;
2483 case BPF_FUNC_trace_printk:
2484 if (capable(CAP_SYS_ADMIN))
2485 return bpf_get_trace_printk_proto();
2491 static const struct bpf_func_proto *
2492 tc_cls_act_func_proto(enum bpf_func_id func_id)
2495 case BPF_FUNC_skb_store_bytes:
2496 return &bpf_skb_store_bytes_proto;
2497 case BPF_FUNC_skb_load_bytes:
2498 return &bpf_skb_load_bytes_proto;
2499 case BPF_FUNC_skb_pull_data:
2500 return &bpf_skb_pull_data_proto;
2501 case BPF_FUNC_csum_diff:
2502 return &bpf_csum_diff_proto;
2503 case BPF_FUNC_csum_update:
2504 return &bpf_csum_update_proto;
2505 case BPF_FUNC_l3_csum_replace:
2506 return &bpf_l3_csum_replace_proto;
2507 case BPF_FUNC_l4_csum_replace:
2508 return &bpf_l4_csum_replace_proto;
2509 case BPF_FUNC_clone_redirect:
2510 return &bpf_clone_redirect_proto;
2511 case BPF_FUNC_get_cgroup_classid:
2512 return &bpf_get_cgroup_classid_proto;
2513 case BPF_FUNC_skb_vlan_push:
2514 return &bpf_skb_vlan_push_proto;
2515 case BPF_FUNC_skb_vlan_pop:
2516 return &bpf_skb_vlan_pop_proto;
2517 case BPF_FUNC_skb_change_proto:
2518 return &bpf_skb_change_proto_proto;
2519 case BPF_FUNC_skb_change_type:
2520 return &bpf_skb_change_type_proto;
2521 case BPF_FUNC_skb_change_tail:
2522 return &bpf_skb_change_tail_proto;
2523 case BPF_FUNC_skb_get_tunnel_key:
2524 return &bpf_skb_get_tunnel_key_proto;
2525 case BPF_FUNC_skb_set_tunnel_key:
2526 return bpf_get_skb_set_tunnel_proto(func_id);
2527 case BPF_FUNC_skb_get_tunnel_opt:
2528 return &bpf_skb_get_tunnel_opt_proto;
2529 case BPF_FUNC_skb_set_tunnel_opt:
2530 return bpf_get_skb_set_tunnel_proto(func_id);
2531 case BPF_FUNC_redirect:
2532 return &bpf_redirect_proto;
2533 case BPF_FUNC_get_route_realm:
2534 return &bpf_get_route_realm_proto;
2535 case BPF_FUNC_get_hash_recalc:
2536 return &bpf_get_hash_recalc_proto;
2537 case BPF_FUNC_perf_event_output:
2538 return &bpf_skb_event_output_proto;
2539 case BPF_FUNC_get_smp_processor_id:
2540 return &bpf_get_smp_processor_id_proto;
2541 case BPF_FUNC_skb_under_cgroup:
2542 return &bpf_skb_under_cgroup_proto;
2544 return sk_filter_func_proto(func_id);
2548 static const struct bpf_func_proto *
2549 xdp_func_proto(enum bpf_func_id func_id)
2552 case BPF_FUNC_perf_event_output:
2553 return &bpf_xdp_event_output_proto;
2555 return sk_filter_func_proto(func_id);
2559 static bool __is_valid_access(int off, int size, enum bpf_access_type type)
2561 if (off < 0 || off >= sizeof(struct __sk_buff))
2563 /* The verifier guarantees that size > 0. */
2564 if (off % size != 0)
2566 if (size != sizeof(__u32))
2572 static bool sk_filter_is_valid_access(int off, int size,
2573 enum bpf_access_type type,
2574 enum bpf_reg_type *reg_type)
2577 case offsetof(struct __sk_buff, tc_classid):
2578 case offsetof(struct __sk_buff, data):
2579 case offsetof(struct __sk_buff, data_end):
2583 if (type == BPF_WRITE) {
2585 case offsetof(struct __sk_buff, cb[0]) ...
2586 offsetof(struct __sk_buff, cb[4]):
2593 return __is_valid_access(off, size, type);
2596 static int tc_cls_act_prologue(struct bpf_insn *insn_buf, bool direct_write,
2597 const struct bpf_prog *prog)
2599 struct bpf_insn *insn = insn_buf;
2604 /* if (!skb->cloned)
2607 * (Fast-path, otherwise approximation that we might be
2608 * a clone, do the rest in helper.)
2610 *insn++ = BPF_LDX_MEM(BPF_B, BPF_REG_6, BPF_REG_1, CLONED_OFFSET());
2611 *insn++ = BPF_ALU32_IMM(BPF_AND, BPF_REG_6, CLONED_MASK);
2612 *insn++ = BPF_JMP_IMM(BPF_JEQ, BPF_REG_6, 0, 7);
2614 /* ret = bpf_skb_pull_data(skb, 0); */
2615 *insn++ = BPF_MOV64_REG(BPF_REG_6, BPF_REG_1);
2616 *insn++ = BPF_ALU64_REG(BPF_XOR, BPF_REG_2, BPF_REG_2);
2617 *insn++ = BPF_RAW_INSN(BPF_JMP | BPF_CALL, 0, 0, 0,
2618 BPF_FUNC_skb_pull_data);
2621 * return TC_ACT_SHOT;
2623 *insn++ = BPF_JMP_IMM(BPF_JEQ, BPF_REG_0, 0, 2);
2624 *insn++ = BPF_ALU32_IMM(BPF_MOV, BPF_REG_0, TC_ACT_SHOT);
2625 *insn++ = BPF_EXIT_INSN();
2628 *insn++ = BPF_MOV64_REG(BPF_REG_1, BPF_REG_6);
2630 *insn++ = prog->insnsi[0];
2632 return insn - insn_buf;
2635 static bool tc_cls_act_is_valid_access(int off, int size,
2636 enum bpf_access_type type,
2637 enum bpf_reg_type *reg_type)
2639 if (type == BPF_WRITE) {
2641 case offsetof(struct __sk_buff, mark):
2642 case offsetof(struct __sk_buff, tc_index):
2643 case offsetof(struct __sk_buff, priority):
2644 case offsetof(struct __sk_buff, cb[0]) ...
2645 offsetof(struct __sk_buff, cb[4]):
2646 case offsetof(struct __sk_buff, tc_classid):
2654 case offsetof(struct __sk_buff, data):
2655 *reg_type = PTR_TO_PACKET;
2657 case offsetof(struct __sk_buff, data_end):
2658 *reg_type = PTR_TO_PACKET_END;
2662 return __is_valid_access(off, size, type);
2665 static bool __is_valid_xdp_access(int off, int size,
2666 enum bpf_access_type type)
2668 if (off < 0 || off >= sizeof(struct xdp_md))
2670 if (off % size != 0)
2672 if (size != sizeof(__u32))
2678 static bool xdp_is_valid_access(int off, int size,
2679 enum bpf_access_type type,
2680 enum bpf_reg_type *reg_type)
2682 if (type == BPF_WRITE)
2686 case offsetof(struct xdp_md, data):
2687 *reg_type = PTR_TO_PACKET;
2689 case offsetof(struct xdp_md, data_end):
2690 *reg_type = PTR_TO_PACKET_END;
2694 return __is_valid_xdp_access(off, size, type);
2697 void bpf_warn_invalid_xdp_action(u32 act)
2699 WARN_ONCE(1, "Illegal XDP return value %u, expect packet loss\n", act);
2701 EXPORT_SYMBOL_GPL(bpf_warn_invalid_xdp_action);
2703 static u32 sk_filter_convert_ctx_access(enum bpf_access_type type, int dst_reg,
2704 int src_reg, int ctx_off,
2705 struct bpf_insn *insn_buf,
2706 struct bpf_prog *prog)
2708 struct bpf_insn *insn = insn_buf;
2711 case offsetof(struct __sk_buff, len):
2712 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, len) != 4);
2714 *insn++ = BPF_LDX_MEM(BPF_W, dst_reg, src_reg,
2715 offsetof(struct sk_buff, len));
2718 case offsetof(struct __sk_buff, protocol):
2719 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, protocol) != 2);
2721 *insn++ = BPF_LDX_MEM(BPF_H, dst_reg, src_reg,
2722 offsetof(struct sk_buff, protocol));
2725 case offsetof(struct __sk_buff, vlan_proto):
2726 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, vlan_proto) != 2);
2728 *insn++ = BPF_LDX_MEM(BPF_H, dst_reg, src_reg,
2729 offsetof(struct sk_buff, vlan_proto));
2732 case offsetof(struct __sk_buff, priority):
2733 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, priority) != 4);
2735 if (type == BPF_WRITE)
2736 *insn++ = BPF_STX_MEM(BPF_W, dst_reg, src_reg,
2737 offsetof(struct sk_buff, priority));
2739 *insn++ = BPF_LDX_MEM(BPF_W, dst_reg, src_reg,
2740 offsetof(struct sk_buff, priority));
2743 case offsetof(struct __sk_buff, ingress_ifindex):
2744 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, skb_iif) != 4);
2746 *insn++ = BPF_LDX_MEM(BPF_W, dst_reg, src_reg,
2747 offsetof(struct sk_buff, skb_iif));
2750 case offsetof(struct __sk_buff, ifindex):
2751 BUILD_BUG_ON(FIELD_SIZEOF(struct net_device, ifindex) != 4);
2753 *insn++ = BPF_LDX_MEM(BPF_FIELD_SIZEOF(struct sk_buff, dev),
2755 offsetof(struct sk_buff, dev));
2756 *insn++ = BPF_JMP_IMM(BPF_JEQ, dst_reg, 0, 1);
2757 *insn++ = BPF_LDX_MEM(BPF_W, dst_reg, dst_reg,
2758 offsetof(struct net_device, ifindex));
2761 case offsetof(struct __sk_buff, hash):
2762 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, hash) != 4);
2764 *insn++ = BPF_LDX_MEM(BPF_W, dst_reg, src_reg,
2765 offsetof(struct sk_buff, hash));
2768 case offsetof(struct __sk_buff, mark):
2769 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, mark) != 4);
2771 if (type == BPF_WRITE)
2772 *insn++ = BPF_STX_MEM(BPF_W, dst_reg, src_reg,
2773 offsetof(struct sk_buff, mark));
2775 *insn++ = BPF_LDX_MEM(BPF_W, dst_reg, src_reg,
2776 offsetof(struct sk_buff, mark));
2779 case offsetof(struct __sk_buff, pkt_type):
2780 return convert_skb_access(SKF_AD_PKTTYPE, dst_reg, src_reg, insn);
2782 case offsetof(struct __sk_buff, queue_mapping):
2783 return convert_skb_access(SKF_AD_QUEUE, dst_reg, src_reg, insn);
2785 case offsetof(struct __sk_buff, vlan_present):
2786 return convert_skb_access(SKF_AD_VLAN_TAG_PRESENT,
2787 dst_reg, src_reg, insn);
2789 case offsetof(struct __sk_buff, vlan_tci):
2790 return convert_skb_access(SKF_AD_VLAN_TAG,
2791 dst_reg, src_reg, insn);
2793 case offsetof(struct __sk_buff, cb[0]) ...
2794 offsetof(struct __sk_buff, cb[4]):
2795 BUILD_BUG_ON(FIELD_SIZEOF(struct qdisc_skb_cb, data) < 20);
2797 prog->cb_access = 1;
2798 ctx_off -= offsetof(struct __sk_buff, cb[0]);
2799 ctx_off += offsetof(struct sk_buff, cb);
2800 ctx_off += offsetof(struct qdisc_skb_cb, data);
2801 if (type == BPF_WRITE)
2802 *insn++ = BPF_STX_MEM(BPF_W, dst_reg, src_reg, ctx_off);
2804 *insn++ = BPF_LDX_MEM(BPF_W, dst_reg, src_reg, ctx_off);
2807 case offsetof(struct __sk_buff, tc_classid):
2808 ctx_off -= offsetof(struct __sk_buff, tc_classid);
2809 ctx_off += offsetof(struct sk_buff, cb);
2810 ctx_off += offsetof(struct qdisc_skb_cb, tc_classid);
2811 if (type == BPF_WRITE)
2812 *insn++ = BPF_STX_MEM(BPF_H, dst_reg, src_reg, ctx_off);
2814 *insn++ = BPF_LDX_MEM(BPF_H, dst_reg, src_reg, ctx_off);
2817 case offsetof(struct __sk_buff, data):
2818 *insn++ = BPF_LDX_MEM(BPF_FIELD_SIZEOF(struct sk_buff, data),
2820 offsetof(struct sk_buff, data));
2823 case offsetof(struct __sk_buff, data_end):
2824 ctx_off -= offsetof(struct __sk_buff, data_end);
2825 ctx_off += offsetof(struct sk_buff, cb);
2826 ctx_off += offsetof(struct bpf_skb_data_end, data_end);
2827 *insn++ = BPF_LDX_MEM(BPF_SIZEOF(void *), dst_reg, src_reg,
2831 case offsetof(struct __sk_buff, tc_index):
2832 #ifdef CONFIG_NET_SCHED
2833 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff, tc_index) != 2);
2835 if (type == BPF_WRITE)
2836 *insn++ = BPF_STX_MEM(BPF_H, dst_reg, src_reg,
2837 offsetof(struct sk_buff, tc_index));
2839 *insn++ = BPF_LDX_MEM(BPF_H, dst_reg, src_reg,
2840 offsetof(struct sk_buff, tc_index));
2843 if (type == BPF_WRITE)
2844 *insn++ = BPF_MOV64_REG(dst_reg, dst_reg);
2846 *insn++ = BPF_MOV64_IMM(dst_reg, 0);
2851 return insn - insn_buf;
2854 static u32 tc_cls_act_convert_ctx_access(enum bpf_access_type type, int dst_reg,
2855 int src_reg, int ctx_off,
2856 struct bpf_insn *insn_buf,
2857 struct bpf_prog *prog)
2859 struct bpf_insn *insn = insn_buf;
2862 case offsetof(struct __sk_buff, ifindex):
2863 BUILD_BUG_ON(FIELD_SIZEOF(struct net_device, ifindex) != 4);
2865 *insn++ = BPF_LDX_MEM(BPF_FIELD_SIZEOF(struct sk_buff, dev),
2867 offsetof(struct sk_buff, dev));
2868 *insn++ = BPF_LDX_MEM(BPF_W, dst_reg, dst_reg,
2869 offsetof(struct net_device, ifindex));
2872 return sk_filter_convert_ctx_access(type, dst_reg, src_reg,
2873 ctx_off, insn_buf, prog);
2876 return insn - insn_buf;
2879 static u32 xdp_convert_ctx_access(enum bpf_access_type type, int dst_reg,
2880 int src_reg, int ctx_off,
2881 struct bpf_insn *insn_buf,
2882 struct bpf_prog *prog)
2884 struct bpf_insn *insn = insn_buf;
2887 case offsetof(struct xdp_md, data):
2888 *insn++ = BPF_LDX_MEM(BPF_FIELD_SIZEOF(struct xdp_buff, data),
2890 offsetof(struct xdp_buff, data));
2892 case offsetof(struct xdp_md, data_end):
2893 *insn++ = BPF_LDX_MEM(BPF_FIELD_SIZEOF(struct xdp_buff, data_end),
2895 offsetof(struct xdp_buff, data_end));
2899 return insn - insn_buf;
2902 static const struct bpf_verifier_ops sk_filter_ops = {
2903 .get_func_proto = sk_filter_func_proto,
2904 .is_valid_access = sk_filter_is_valid_access,
2905 .convert_ctx_access = sk_filter_convert_ctx_access,
2908 static const struct bpf_verifier_ops tc_cls_act_ops = {
2909 .get_func_proto = tc_cls_act_func_proto,
2910 .is_valid_access = tc_cls_act_is_valid_access,
2911 .convert_ctx_access = tc_cls_act_convert_ctx_access,
2912 .gen_prologue = tc_cls_act_prologue,
2915 static const struct bpf_verifier_ops xdp_ops = {
2916 .get_func_proto = xdp_func_proto,
2917 .is_valid_access = xdp_is_valid_access,
2918 .convert_ctx_access = xdp_convert_ctx_access,
2921 static struct bpf_prog_type_list sk_filter_type __read_mostly = {
2922 .ops = &sk_filter_ops,
2923 .type = BPF_PROG_TYPE_SOCKET_FILTER,
2926 static struct bpf_prog_type_list sched_cls_type __read_mostly = {
2927 .ops = &tc_cls_act_ops,
2928 .type = BPF_PROG_TYPE_SCHED_CLS,
2931 static struct bpf_prog_type_list sched_act_type __read_mostly = {
2932 .ops = &tc_cls_act_ops,
2933 .type = BPF_PROG_TYPE_SCHED_ACT,
2936 static struct bpf_prog_type_list xdp_type __read_mostly = {
2938 .type = BPF_PROG_TYPE_XDP,
2941 static int __init register_sk_filter_ops(void)
2943 bpf_register_prog_type(&sk_filter_type);
2944 bpf_register_prog_type(&sched_cls_type);
2945 bpf_register_prog_type(&sched_act_type);
2946 bpf_register_prog_type(&xdp_type);
2950 late_initcall(register_sk_filter_ops);
2952 int sk_detach_filter(struct sock *sk)
2955 struct sk_filter *filter;
2957 if (sock_flag(sk, SOCK_FILTER_LOCKED))
2960 filter = rcu_dereference_protected(sk->sk_filter,
2961 lockdep_sock_is_held(sk));
2963 RCU_INIT_POINTER(sk->sk_filter, NULL);
2964 sk_filter_uncharge(sk, filter);
2970 EXPORT_SYMBOL_GPL(sk_detach_filter);
2972 int sk_get_filter(struct sock *sk, struct sock_filter __user *ubuf,
2975 struct sock_fprog_kern *fprog;
2976 struct sk_filter *filter;
2980 filter = rcu_dereference_protected(sk->sk_filter,
2981 lockdep_sock_is_held(sk));
2985 /* We're copying the filter that has been originally attached,
2986 * so no conversion/decode needed anymore. eBPF programs that
2987 * have no original program cannot be dumped through this.
2990 fprog = filter->prog->orig_prog;
2996 /* User space only enquires number of filter blocks. */
3000 if (len < fprog->len)
3004 if (copy_to_user(ubuf, fprog->filter, bpf_classic_proglen(fprog)))
3007 /* Instead of bytes, the API requests to return the number