1 /* bpf_jit_comp.c : BPF JIT compiler
3 * Copyright (C) 2011 Eric Dumazet (eric.dumazet@gmail.com)
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; version 2
10 #include <linux/moduleloader.h>
11 #include <asm/cacheflush.h>
12 #include <linux/netdevice.h>
13 #include <linux/filter.h>
17 * EAX : BPF A accumulator
18 * EBX : BPF X accumulator
19 * RDI : pointer to skb (first argument given to JIT function)
20 * RBP : frame pointer (even if CONFIG_FRAME_POINTER=n)
21 * ECX,EDX,ESI : scratch registers
22 * r9d : skb->len - skb->data_len (headlen)
24 * -8(RBP) : saved RBX value
25 * -16(RBP)..-80(RBP) : BPF_MEMWORDS values
27 int bpf_jit_enable __read_mostly
;
30 * assembly code in arch/x86/net/bpf_jit.S
32 extern u8 sk_load_word
[], sk_load_half
[], sk_load_byte
[], sk_load_byte_msh
[];
33 extern u8 sk_load_word_positive_offset
[], sk_load_half_positive_offset
[];
34 extern u8 sk_load_byte_positive_offset
[], sk_load_byte_msh_positive_offset
[];
35 extern u8 sk_load_word_negative_offset
[], sk_load_half_negative_offset
[];
36 extern u8 sk_load_byte_negative_offset
[], sk_load_byte_msh_negative_offset
[];
38 static inline u8
*emit_code(u8
*ptr
, u32 bytes
, unsigned int len
)
51 #define EMIT(bytes, len) do { prog = emit_code(prog, bytes, len); } while (0)
53 #define EMIT1(b1) EMIT(b1, 1)
54 #define EMIT2(b1, b2) EMIT((b1) + ((b2) << 8), 2)
55 #define EMIT3(b1, b2, b3) EMIT((b1) + ((b2) << 8) + ((b3) << 16), 3)
56 #define EMIT4(b1, b2, b3, b4) EMIT((b1) + ((b2) << 8) + ((b3) << 16) + ((b4) << 24), 4)
57 #define EMIT1_off32(b1, off) do { EMIT1(b1); EMIT(off, 4);} while (0)
59 #define CLEAR_A() EMIT2(0x31, 0xc0) /* xor %eax,%eax */
60 #define CLEAR_X() EMIT2(0x31, 0xdb) /* xor %ebx,%ebx */
62 static inline bool is_imm8(int value
)
64 return value
<= 127 && value
>= -128;
67 static inline bool is_near(int offset
)
69 return offset
<= 127 && offset
>= -128;
72 #define EMIT_JMP(offset) \
75 if (is_near(offset)) \
76 EMIT2(0xeb, offset); /* jmp .+off8 */ \
78 EMIT1_off32(0xe9, offset); /* jmp .+off32 */ \
82 /* list of x86 cond jumps opcodes (. + s8)
83 * Add 0x10 (and an extra 0x0f) to generate far jumps (. + s32)
92 #define EMIT_COND_JMP(op, offset) \
94 if (is_near(offset)) \
95 EMIT2(op, offset); /* jxx .+off8 */ \
97 EMIT2(0x0f, op + 0x10); \
98 EMIT(offset, 4); /* jxx .+off32 */ \
102 #define COND_SEL(CODE, TOP, FOP) \
109 #define SEEN_DATAREF 1 /* might call external helpers */
110 #define SEEN_XREG 2 /* ebx is used */
111 #define SEEN_MEM 4 /* use mem[] for temporary storage */
113 static inline void bpf_flush_icache(void *start
, void *end
)
115 mm_segment_t old_fs
= get_fs();
119 flush_icache_range((unsigned long)start
, (unsigned long)end
);
123 #define CHOOSE_LOAD_FUNC(K, func) \
124 ((int)K < 0 ? ((int)K >= SKF_LL_OFF ? func##_negative_offset : func) : func##_positive_offset)
126 void bpf_jit_compile(struct sk_filter
*fp
)
130 unsigned int proglen
, oldproglen
= 0;
132 int t_offset
, f_offset
;
133 u8 t_op
, f_op
, seen
= 0, pass
;
136 int pc_ret0
= -1; /* bpf index of first RET #0 instruction (if any) */
137 unsigned int cleanup_addr
; /* epilogue code offset */
139 const struct sock_filter
*filter
= fp
->insns
;
145 addrs
= kmalloc(flen
* sizeof(*addrs
), GFP_KERNEL
);
149 /* Before first pass, make a rough estimation of addrs[]
150 * each bpf instruction is translated to less than 64 bytes
152 for (proglen
= 0, i
= 0; i
< flen
; i
++) {
156 cleanup_addr
= proglen
; /* epilogue address */
158 for (pass
= 0; pass
< 10; pass
++) {
159 u8 seen_or_pass0
= (pass
== 0) ? (SEEN_XREG
| SEEN_DATAREF
| SEEN_MEM
) : seen
;
160 /* no prologue/epilogue for trivial filters (RET something) */
165 EMIT4(0x55, 0x48, 0x89, 0xe5); /* push %rbp; mov %rsp,%rbp */
166 EMIT4(0x48, 0x83, 0xec, 96); /* subq $96,%rsp */
167 /* note : must save %rbx in case bpf_error is hit */
168 if (seen_or_pass0
& (SEEN_XREG
| SEEN_DATAREF
))
169 EMIT4(0x48, 0x89, 0x5d, 0xf8); /* mov %rbx, -8(%rbp) */
170 if (seen_or_pass0
& SEEN_XREG
)
171 CLEAR_X(); /* make sure we dont leek kernel memory */
174 * If this filter needs to access skb data,
175 * loads r9 and r8 with :
176 * r9 = skb->len - skb->data_len
179 if (seen_or_pass0
& SEEN_DATAREF
) {
180 if (offsetof(struct sk_buff
, len
) <= 127)
181 /* mov off8(%rdi),%r9d */
182 EMIT4(0x44, 0x8b, 0x4f, offsetof(struct sk_buff
, len
));
184 /* mov off32(%rdi),%r9d */
185 EMIT3(0x44, 0x8b, 0x8f);
186 EMIT(offsetof(struct sk_buff
, len
), 4);
188 if (is_imm8(offsetof(struct sk_buff
, data_len
)))
189 /* sub off8(%rdi),%r9d */
190 EMIT4(0x44, 0x2b, 0x4f, offsetof(struct sk_buff
, data_len
));
192 EMIT3(0x44, 0x2b, 0x8f);
193 EMIT(offsetof(struct sk_buff
, data_len
), 4);
196 if (is_imm8(offsetof(struct sk_buff
, data
)))
197 /* mov off8(%rdi),%r8 */
198 EMIT4(0x4c, 0x8b, 0x47, offsetof(struct sk_buff
, data
));
200 /* mov off32(%rdi),%r8 */
201 EMIT3(0x4c, 0x8b, 0x87);
202 EMIT(offsetof(struct sk_buff
, data
), 4);
207 switch (filter
[0].code
) {
210 case BPF_S_ANC_PROTOCOL
:
211 case BPF_S_ANC_IFINDEX
:
213 case BPF_S_ANC_RXHASH
:
215 case BPF_S_ANC_QUEUE
:
219 /* first instruction sets A register (or is RET 'constant') */
222 /* make sure we dont leak kernel information to user */
223 CLEAR_A(); /* A = 0 */
226 for (i
= 0; i
< flen
; i
++) {
227 unsigned int K
= filter
[i
].k
;
229 switch (filter
[i
].code
) {
230 case BPF_S_ALU_ADD_X
: /* A += X; */
232 EMIT2(0x01, 0xd8); /* add %ebx,%eax */
234 case BPF_S_ALU_ADD_K
: /* A += K; */
238 EMIT3(0x83, 0xc0, K
); /* add imm8,%eax */
240 EMIT1_off32(0x05, K
); /* add imm32,%eax */
242 case BPF_S_ALU_SUB_X
: /* A -= X; */
244 EMIT2(0x29, 0xd8); /* sub %ebx,%eax */
246 case BPF_S_ALU_SUB_K
: /* A -= K */
250 EMIT3(0x83, 0xe8, K
); /* sub imm8,%eax */
252 EMIT1_off32(0x2d, K
); /* sub imm32,%eax */
254 case BPF_S_ALU_MUL_X
: /* A *= X; */
256 EMIT3(0x0f, 0xaf, 0xc3); /* imul %ebx,%eax */
258 case BPF_S_ALU_MUL_K
: /* A *= K */
260 EMIT3(0x6b, 0xc0, K
); /* imul imm8,%eax,%eax */
262 EMIT2(0x69, 0xc0); /* imul imm32,%eax */
266 case BPF_S_ALU_DIV_X
: /* A /= X; */
268 EMIT2(0x85, 0xdb); /* test %ebx,%ebx */
270 /* addrs[pc_ret0 - 1] is start address of target
271 * (addrs[i] - 4) is the address following this jmp
272 * ("xor %edx,%edx; div %ebx" being 4 bytes long)
274 EMIT_COND_JMP(X86_JE
, addrs
[pc_ret0
- 1] -
277 EMIT_COND_JMP(X86_JNE
, 2 + 5);
279 EMIT1_off32(0xe9, cleanup_addr
- (addrs
[i
] - 4)); /* jmp .+off32 */
281 EMIT4(0x31, 0xd2, 0xf7, 0xf3); /* xor %edx,%edx; div %ebx */
283 case BPF_S_ALU_DIV_K
: /* A = reciprocal_divide(A, K); */
284 EMIT3(0x48, 0x69, 0xc0); /* imul imm32,%rax,%rax */
286 EMIT4(0x48, 0xc1, 0xe8, 0x20); /* shr $0x20,%rax */
288 case BPF_S_ALU_AND_X
:
290 EMIT2(0x21, 0xd8); /* and %ebx,%eax */
292 case BPF_S_ALU_AND_K
:
293 if (K
>= 0xFFFFFF00) {
294 EMIT2(0x24, K
& 0xFF); /* and imm8,%al */
295 } else if (K
>= 0xFFFF0000) {
296 EMIT2(0x66, 0x25); /* and imm16,%ax */
299 EMIT1_off32(0x25, K
); /* and imm32,%eax */
304 EMIT2(0x09, 0xd8); /* or %ebx,%eax */
308 EMIT3(0x83, 0xc8, K
); /* or imm8,%eax */
310 EMIT1_off32(0x0d, K
); /* or imm32,%eax */
312 case BPF_S_ALU_LSH_X
: /* A <<= X; */
314 EMIT4(0x89, 0xd9, 0xd3, 0xe0); /* mov %ebx,%ecx; shl %cl,%eax */
316 case BPF_S_ALU_LSH_K
:
320 EMIT2(0xd1, 0xe0); /* shl %eax */
322 EMIT3(0xc1, 0xe0, K
);
324 case BPF_S_ALU_RSH_X
: /* A >>= X; */
326 EMIT4(0x89, 0xd9, 0xd3, 0xe8); /* mov %ebx,%ecx; shr %cl,%eax */
328 case BPF_S_ALU_RSH_K
: /* A >>= K; */
332 EMIT2(0xd1, 0xe8); /* shr %eax */
334 EMIT3(0xc1, 0xe8, K
);
337 EMIT2(0xf7, 0xd8); /* neg %eax */
345 EMIT1_off32(0xb8, K
); /* mov $imm32,%eax */
351 EMIT_JMP(cleanup_addr
- addrs
[i
]);
354 if (seen_or_pass0
& SEEN_XREG
)
355 EMIT4(0x48, 0x8b, 0x5d, 0xf8); /* mov -8(%rbp),%rbx */
356 EMIT1(0xc9); /* leaveq */
358 EMIT1(0xc3); /* ret */
360 case BPF_S_MISC_TAX
: /* X = A */
362 EMIT2(0x89, 0xc3); /* mov %eax,%ebx */
364 case BPF_S_MISC_TXA
: /* A = X */
366 EMIT2(0x89, 0xd8); /* mov %ebx,%eax */
368 case BPF_S_LD_IMM
: /* A = K */
372 EMIT1_off32(0xb8, K
); /* mov $imm32,%eax */
374 case BPF_S_LDX_IMM
: /* X = K */
379 EMIT1_off32(0xbb, K
); /* mov $imm32,%ebx */
381 case BPF_S_LD_MEM
: /* A = mem[K] : mov off8(%rbp),%eax */
383 EMIT3(0x8b, 0x45, 0xf0 - K
*4);
385 case BPF_S_LDX_MEM
: /* X = mem[K] : mov off8(%rbp),%ebx */
386 seen
|= SEEN_XREG
| SEEN_MEM
;
387 EMIT3(0x8b, 0x5d, 0xf0 - K
*4);
389 case BPF_S_ST
: /* mem[K] = A : mov %eax,off8(%rbp) */
391 EMIT3(0x89, 0x45, 0xf0 - K
*4);
393 case BPF_S_STX
: /* mem[K] = X : mov %ebx,off8(%rbp) */
394 seen
|= SEEN_XREG
| SEEN_MEM
;
395 EMIT3(0x89, 0x5d, 0xf0 - K
*4);
397 case BPF_S_LD_W_LEN
: /* A = skb->len; */
398 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff
, len
) != 4);
399 if (is_imm8(offsetof(struct sk_buff
, len
)))
400 /* mov off8(%rdi),%eax */
401 EMIT3(0x8b, 0x47, offsetof(struct sk_buff
, len
));
404 EMIT(offsetof(struct sk_buff
, len
), 4);
407 case BPF_S_LDX_W_LEN
: /* X = skb->len; */
409 if (is_imm8(offsetof(struct sk_buff
, len
)))
410 /* mov off8(%rdi),%ebx */
411 EMIT3(0x8b, 0x5f, offsetof(struct sk_buff
, len
));
414 EMIT(offsetof(struct sk_buff
, len
), 4);
417 case BPF_S_ANC_PROTOCOL
: /* A = ntohs(skb->protocol); */
418 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff
, protocol
) != 2);
419 if (is_imm8(offsetof(struct sk_buff
, protocol
))) {
420 /* movzwl off8(%rdi),%eax */
421 EMIT4(0x0f, 0xb7, 0x47, offsetof(struct sk_buff
, protocol
));
423 EMIT3(0x0f, 0xb7, 0x87); /* movzwl off32(%rdi),%eax */
424 EMIT(offsetof(struct sk_buff
, protocol
), 4);
426 EMIT2(0x86, 0xc4); /* ntohs() : xchg %al,%ah */
428 case BPF_S_ANC_IFINDEX
:
429 if (is_imm8(offsetof(struct sk_buff
, dev
))) {
430 /* movq off8(%rdi),%rax */
431 EMIT4(0x48, 0x8b, 0x47, offsetof(struct sk_buff
, dev
));
433 EMIT3(0x48, 0x8b, 0x87); /* movq off32(%rdi),%rax */
434 EMIT(offsetof(struct sk_buff
, dev
), 4);
436 EMIT3(0x48, 0x85, 0xc0); /* test %rax,%rax */
437 EMIT_COND_JMP(X86_JE
, cleanup_addr
- (addrs
[i
] - 6));
438 BUILD_BUG_ON(FIELD_SIZEOF(struct net_device
, ifindex
) != 4);
439 EMIT2(0x8b, 0x80); /* mov off32(%rax),%eax */
440 EMIT(offsetof(struct net_device
, ifindex
), 4);
443 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff
, mark
) != 4);
444 if (is_imm8(offsetof(struct sk_buff
, mark
))) {
445 /* mov off8(%rdi),%eax */
446 EMIT3(0x8b, 0x47, offsetof(struct sk_buff
, mark
));
449 EMIT(offsetof(struct sk_buff
, mark
), 4);
452 case BPF_S_ANC_RXHASH
:
453 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff
, rxhash
) != 4);
454 if (is_imm8(offsetof(struct sk_buff
, rxhash
))) {
455 /* mov off8(%rdi),%eax */
456 EMIT3(0x8b, 0x47, offsetof(struct sk_buff
, rxhash
));
459 EMIT(offsetof(struct sk_buff
, rxhash
), 4);
462 case BPF_S_ANC_QUEUE
:
463 BUILD_BUG_ON(FIELD_SIZEOF(struct sk_buff
, queue_mapping
) != 2);
464 if (is_imm8(offsetof(struct sk_buff
, queue_mapping
))) {
465 /* movzwl off8(%rdi),%eax */
466 EMIT4(0x0f, 0xb7, 0x47, offsetof(struct sk_buff
, queue_mapping
));
468 EMIT3(0x0f, 0xb7, 0x87); /* movzwl off32(%rdi),%eax */
469 EMIT(offsetof(struct sk_buff
, queue_mapping
), 4);
474 EMIT4(0x65, 0x8b, 0x04, 0x25); /* mov %gs:off32,%eax */
475 EMIT((u32
)(unsigned long)&cpu_number
, 4); /* A = smp_processor_id(); */
481 func
= CHOOSE_LOAD_FUNC(K
, sk_load_word
);
482 common_load
: seen
|= SEEN_DATAREF
;
483 t_offset
= func
- (image
+ addrs
[i
]);
484 EMIT1_off32(0xbe, K
); /* mov imm32,%esi */
485 EMIT1_off32(0xe8, t_offset
); /* call */
488 func
= CHOOSE_LOAD_FUNC(K
, sk_load_half
);
491 func
= CHOOSE_LOAD_FUNC(K
, sk_load_byte
);
493 case BPF_S_LDX_B_MSH
:
494 func
= CHOOSE_LOAD_FUNC(K
, sk_load_byte_msh
);
495 seen
|= SEEN_DATAREF
| SEEN_XREG
;
496 t_offset
= func
- (image
+ addrs
[i
]);
497 EMIT1_off32(0xbe, K
); /* mov imm32,%esi */
498 EMIT1_off32(0xe8, t_offset
); /* call sk_load_byte_msh */
502 common_load_ind
: seen
|= SEEN_DATAREF
| SEEN_XREG
;
503 t_offset
= func
- (image
+ addrs
[i
]);
506 EMIT3(0x8d, 0x73, K
); /* lea imm8(%rbx), %esi */
508 EMIT2(0x8d, 0xb3); /* lea imm32(%rbx),%esi */
512 EMIT2(0x89,0xde); /* mov %ebx,%esi */
514 EMIT1_off32(0xe8, t_offset
); /* call sk_load_xxx_ind */
518 goto common_load_ind
;
521 goto common_load_ind
;
523 t_offset
= addrs
[i
+ K
] - addrs
[i
];
526 COND_SEL(BPF_S_JMP_JGT_K
, X86_JA
, X86_JBE
);
527 COND_SEL(BPF_S_JMP_JGE_K
, X86_JAE
, X86_JB
);
528 COND_SEL(BPF_S_JMP_JEQ_K
, X86_JE
, X86_JNE
);
529 COND_SEL(BPF_S_JMP_JSET_K
,X86_JNE
, X86_JE
);
530 COND_SEL(BPF_S_JMP_JGT_X
, X86_JA
, X86_JBE
);
531 COND_SEL(BPF_S_JMP_JGE_X
, X86_JAE
, X86_JB
);
532 COND_SEL(BPF_S_JMP_JEQ_X
, X86_JE
, X86_JNE
);
533 COND_SEL(BPF_S_JMP_JSET_X
,X86_JNE
, X86_JE
);
535 cond_branch
: f_offset
= addrs
[i
+ filter
[i
].jf
] - addrs
[i
];
536 t_offset
= addrs
[i
+ filter
[i
].jt
] - addrs
[i
];
538 /* same targets, can avoid doing the test :) */
539 if (filter
[i
].jt
== filter
[i
].jf
) {
544 switch (filter
[i
].code
) {
545 case BPF_S_JMP_JGT_X
:
546 case BPF_S_JMP_JGE_X
:
547 case BPF_S_JMP_JEQ_X
:
549 EMIT2(0x39, 0xd8); /* cmp %ebx,%eax */
551 case BPF_S_JMP_JSET_X
:
553 EMIT2(0x85, 0xd8); /* test %ebx,%eax */
555 case BPF_S_JMP_JEQ_K
:
557 EMIT2(0x85, 0xc0); /* test %eax,%eax */
560 case BPF_S_JMP_JGT_K
:
561 case BPF_S_JMP_JGE_K
:
563 EMIT3(0x83, 0xf8, K
); /* cmp imm8,%eax */
565 EMIT1_off32(0x3d, K
); /* cmp imm32,%eax */
567 case BPF_S_JMP_JSET_K
:
569 EMIT2(0xa8, K
); /* test imm8,%al */
570 else if (!(K
& 0xFFFF00FF))
571 EMIT3(0xf6, 0xc4, K
>> 8); /* test imm8,%ah */
572 else if (K
<= 0xFFFF) {
573 EMIT2(0x66, 0xa9); /* test imm16,%ax */
576 EMIT1_off32(0xa9, K
); /* test imm32,%eax */
580 if (filter
[i
].jt
!= 0) {
581 if (filter
[i
].jf
&& f_offset
)
582 t_offset
+= is_near(f_offset
) ? 2 : 5;
583 EMIT_COND_JMP(t_op
, t_offset
);
588 EMIT_COND_JMP(f_op
, f_offset
);
591 /* hmm, too complex filter, give up with jit compiler */
596 if (unlikely(proglen
+ ilen
> oldproglen
)) {
597 pr_err("bpb_jit_compile fatal error\n");
599 module_free(NULL
, image
);
602 memcpy(image
+ proglen
, temp
, ilen
);
608 /* last bpf instruction is always a RET :
609 * use it to give the cleanup instruction(s) addr
611 cleanup_addr
= proglen
- 1; /* ret */
613 cleanup_addr
-= 1; /* leaveq */
614 if (seen_or_pass0
& SEEN_XREG
)
615 cleanup_addr
-= 4; /* mov -8(%rbp),%rbx */
618 if (proglen
!= oldproglen
)
619 pr_err("bpb_jit_compile proglen=%u != oldproglen=%u\n", proglen
, oldproglen
);
622 if (proglen
== oldproglen
) {
623 image
= module_alloc(max_t(unsigned int,
625 sizeof(struct work_struct
)));
629 oldproglen
= proglen
;
631 if (bpf_jit_enable
> 1)
632 pr_err("flen=%d proglen=%u pass=%d image=%p\n",
633 flen
, proglen
, pass
, image
);
636 if (bpf_jit_enable
> 1)
637 print_hex_dump(KERN_ERR
, "JIT code: ", DUMP_PREFIX_ADDRESS
,
638 16, 1, image
, proglen
, false);
640 bpf_flush_icache(image
, image
+ proglen
);
642 fp
->bpf_func
= (void *)image
;
649 static void jit_free_defer(struct work_struct
*arg
)
651 module_free(NULL
, arg
);
654 /* run from softirq, we must use a work_struct to call
655 * module_free() from process context
657 void bpf_jit_free(struct sk_filter
*fp
)
659 if (fp
->bpf_func
!= sk_run_filter
) {
660 struct work_struct
*work
= (struct work_struct
*)fp
->bpf_func
;
662 INIT_WORK(work
, jit_free_defer
);