2 * Copyright 2008 Michael Ellerman, IBM Corporation.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version
7 * 2 of the License, or (at your option) any later version.
10 #include <linux/kernel.h>
11 #include <linux/kprobes.h>
12 #include <linux/vmalloc.h>
13 #include <linux/init.h>
15 #include <linux/cpuhotplug.h>
16 #include <linux/slab.h>
17 #include <linux/uaccess.h>
18 #include <linux/kprobes.h>
20 #include <asm/pgtable.h>
21 #include <asm/tlbflush.h>
23 #include <asm/code-patching.h>
24 #include <asm/sections.h>
25 #include <asm/setup.h>
27 static int __patch_instruction(unsigned int *exec_addr
, unsigned int instr
,
28 unsigned int *patch_addr
)
32 /* Make sure we aren't patching a freed init section */
33 if (init_mem_is_free
&& init_section_contains(exec_addr
, 4)) {
34 pr_debug("Skipping init section patching addr: 0x%px\n", exec_addr
);
38 __put_user_size(instr
, patch_addr
, 4, err
);
42 asm ("dcbst 0, %0; sync; icbi 0,%1; sync; isync" :: "r" (patch_addr
),
48 int raw_patch_instruction(unsigned int *addr
, unsigned int instr
)
50 return __patch_instruction(addr
, instr
, addr
);
53 #ifdef CONFIG_STRICT_KERNEL_RWX
54 static DEFINE_PER_CPU(struct vm_struct
*, text_poke_area
);
56 static int text_area_cpu_up(unsigned int cpu
)
58 struct vm_struct
*area
;
60 area
= get_vm_area(PAGE_SIZE
, VM_ALLOC
);
62 WARN_ONCE(1, "Failed to create text area for cpu %d\n",
66 this_cpu_write(text_poke_area
, area
);
71 static int text_area_cpu_down(unsigned int cpu
)
73 free_vm_area(this_cpu_read(text_poke_area
));
78 * Run as a late init call. This allows all the boot time patching to be done
79 * simply by patching the code, and then we're called here prior to
80 * mark_rodata_ro(), which happens after all init calls are run. Although
81 * BUG_ON() is rude, in this case it should only happen if ENOMEM, and we judge
82 * it as being preferable to a kernel that will crash later when someone tries
83 * to use patch_instruction().
85 static int __init
setup_text_poke_area(void)
87 BUG_ON(!cpuhp_setup_state(CPUHP_AP_ONLINE_DYN
,
88 "powerpc/text_poke:online", text_area_cpu_up
,
93 late_initcall(setup_text_poke_area
);
96 * This can be called for kernel text or a module.
98 static int map_patch_area(void *addr
, unsigned long text_poke_addr
)
103 if (is_vmalloc_addr(addr
))
104 pfn
= vmalloc_to_pfn(addr
);
106 pfn
= __pa_symbol(addr
) >> PAGE_SHIFT
;
108 err
= map_kernel_page(text_poke_addr
, (pfn
<< PAGE_SHIFT
),
109 pgprot_val(PAGE_KERNEL
));
111 pr_devel("Mapped addr %lx with pfn %lx:%d\n", text_poke_addr
, pfn
, err
);
118 static inline int unmap_patch_area(unsigned long addr
)
125 pgdp
= pgd_offset_k(addr
);
129 pudp
= pud_offset(pgdp
, addr
);
133 pmdp
= pmd_offset(pudp
, addr
);
137 ptep
= pte_offset_kernel(pmdp
, addr
);
141 pr_devel("clearing mm %p, pte %p, addr %lx\n", &init_mm
, ptep
, addr
);
144 * In hash, pte_clear flushes the tlb, in radix, we have to
146 pte_clear(&init_mm
, addr
, ptep
);
147 flush_tlb_kernel_range(addr
, addr
+ PAGE_SIZE
);
152 int patch_instruction(unsigned int *addr
, unsigned int instr
)
155 unsigned int *patch_addr
= NULL
;
157 unsigned long text_poke_addr
;
158 unsigned long kaddr
= (unsigned long)addr
;
161 * During early early boot patch_instruction is called
162 * when text_poke_area is not ready, but we still need
163 * to allow patching. We just do the plain old patching
165 if (!this_cpu_read(text_poke_area
))
166 return raw_patch_instruction(addr
, instr
);
168 local_irq_save(flags
);
170 text_poke_addr
= (unsigned long)__this_cpu_read(text_poke_area
)->addr
;
171 if (map_patch_area(addr
, text_poke_addr
)) {
176 patch_addr
= (unsigned int *)(text_poke_addr
) +
177 ((kaddr
& ~PAGE_MASK
) / sizeof(unsigned int));
179 __patch_instruction(addr
, instr
, patch_addr
);
181 err
= unmap_patch_area(text_poke_addr
);
183 pr_warn("failed to unmap %lx\n", text_poke_addr
);
186 local_irq_restore(flags
);
190 #else /* !CONFIG_STRICT_KERNEL_RWX */
192 int patch_instruction(unsigned int *addr
, unsigned int instr
)
194 return raw_patch_instruction(addr
, instr
);
197 #endif /* CONFIG_STRICT_KERNEL_RWX */
198 NOKPROBE_SYMBOL(patch_instruction
);
200 int patch_branch(unsigned int *addr
, unsigned long target
, int flags
)
202 return patch_instruction(addr
, create_branch(addr
, target
, flags
));
205 int patch_branch_site(s32
*site
, unsigned long target
, int flags
)
209 addr
= (unsigned int *)((unsigned long)site
+ *site
);
210 return patch_instruction(addr
, create_branch(addr
, target
, flags
));
213 int patch_instruction_site(s32
*site
, unsigned int instr
)
217 addr
= (unsigned int *)((unsigned long)site
+ *site
);
218 return patch_instruction(addr
, instr
);
221 bool is_offset_in_branch_range(long offset
)
224 * Powerpc branch instruction is :
227 * +---------+----------------+---+---+
228 * | opcode | LI |AA |LK |
229 * +---------+----------------+---+---+
230 * Where AA = 0 and LK = 0
232 * LI is a signed 24 bits integer. The real branch offset is computed
233 * by: imm32 = SignExtend(LI:'0b00', 32);
235 * So the maximum forward branch should be:
236 * (0x007fffff << 2) = 0x01fffffc = 0x1fffffc
237 * The maximum backward branch should be:
238 * (0xff800000 << 2) = 0xfe000000 = -0x2000000
240 return (offset
>= -0x2000000 && offset
<= 0x1fffffc && !(offset
& 0x3));
244 * Helper to check if a given instruction is a conditional branch
245 * Derived from the conditional checks in analyse_instr()
247 bool is_conditional_branch(unsigned int instr
)
249 unsigned int opcode
= instr
>> 26;
251 if (opcode
== 16) /* bc, bca, bcl, bcla */
254 switch ((instr
>> 1) & 0x3ff) {
255 case 16: /* bclr, bclrl */
256 case 528: /* bcctr, bcctrl */
257 case 560: /* bctar, bctarl */
263 NOKPROBE_SYMBOL(is_conditional_branch
);
265 unsigned int create_branch(const unsigned int *addr
,
266 unsigned long target
, int flags
)
268 unsigned int instruction
;
272 if (! (flags
& BRANCH_ABSOLUTE
))
273 offset
= offset
- (unsigned long)addr
;
275 /* Check we can represent the target in the instruction format */
276 if (!is_offset_in_branch_range(offset
))
279 /* Mask out the flags and target, so they don't step on each other. */
280 instruction
= 0x48000000 | (flags
& 0x3) | (offset
& 0x03FFFFFC);
285 unsigned int create_cond_branch(const unsigned int *addr
,
286 unsigned long target
, int flags
)
288 unsigned int instruction
;
292 if (! (flags
& BRANCH_ABSOLUTE
))
293 offset
= offset
- (unsigned long)addr
;
295 /* Check we can represent the target in the instruction format */
296 if (offset
< -0x8000 || offset
> 0x7FFF || offset
& 0x3)
299 /* Mask out the flags and target, so they don't step on each other. */
300 instruction
= 0x40000000 | (flags
& 0x3FF0003) | (offset
& 0xFFFC);
305 static unsigned int branch_opcode(unsigned int instr
)
307 return (instr
>> 26) & 0x3F;
310 static int instr_is_branch_iform(unsigned int instr
)
312 return branch_opcode(instr
) == 18;
315 static int instr_is_branch_bform(unsigned int instr
)
317 return branch_opcode(instr
) == 16;
320 int instr_is_relative_branch(unsigned int instr
)
322 if (instr
& BRANCH_ABSOLUTE
)
325 return instr_is_branch_iform(instr
) || instr_is_branch_bform(instr
);
328 int instr_is_relative_link_branch(unsigned int instr
)
330 return instr_is_relative_branch(instr
) && (instr
& BRANCH_SET_LINK
);
333 static unsigned long branch_iform_target(const unsigned int *instr
)
337 imm
= *instr
& 0x3FFFFFC;
339 /* If the top bit of the immediate value is set this is negative */
343 if ((*instr
& BRANCH_ABSOLUTE
) == 0)
344 imm
+= (unsigned long)instr
;
346 return (unsigned long)imm
;
349 static unsigned long branch_bform_target(const unsigned int *instr
)
353 imm
= *instr
& 0xFFFC;
355 /* If the top bit of the immediate value is set this is negative */
359 if ((*instr
& BRANCH_ABSOLUTE
) == 0)
360 imm
+= (unsigned long)instr
;
362 return (unsigned long)imm
;
365 unsigned long branch_target(const unsigned int *instr
)
367 if (instr_is_branch_iform(*instr
))
368 return branch_iform_target(instr
);
369 else if (instr_is_branch_bform(*instr
))
370 return branch_bform_target(instr
);
375 int instr_is_branch_to_addr(const unsigned int *instr
, unsigned long addr
)
377 if (instr_is_branch_iform(*instr
) || instr_is_branch_bform(*instr
))
378 return branch_target(instr
) == addr
;
383 unsigned int translate_branch(const unsigned int *dest
, const unsigned int *src
)
385 unsigned long target
;
387 target
= branch_target(src
);
389 if (instr_is_branch_iform(*src
))
390 return create_branch(dest
, target
, *src
);
391 else if (instr_is_branch_bform(*src
))
392 return create_cond_branch(dest
, target
, *src
);
397 #ifdef CONFIG_PPC_BOOK3E_64
398 void __patch_exception(int exc
, unsigned long addr
)
400 extern unsigned int interrupt_base_book3e
;
401 unsigned int *ibase
= &interrupt_base_book3e
;
403 /* Our exceptions vectors start with a NOP and -then- a branch
404 * to deal with single stepping from userspace which stops on
405 * the second instruction. Thus we need to patch the second
406 * instruction of the exception, not the first one
409 patch_branch(ibase
+ (exc
/ 4) + 1, addr
, 0);
413 #ifdef CONFIG_CODE_PATCHING_SELFTEST
415 static void __init
test_trampoline(void)
421 if (!(x)) printk("code-patching: test failed at line %d\n", __LINE__);
423 static void __init
test_branch_iform(void)
428 addr
= (unsigned long)&instr
;
430 /* The simplest case, branch to self, no flags */
431 check(instr_is_branch_iform(0x48000000));
432 /* All bits of target set, and flags */
433 check(instr_is_branch_iform(0x4bffffff));
434 /* High bit of opcode set, which is wrong */
435 check(!instr_is_branch_iform(0xcbffffff));
436 /* Middle bits of opcode set, which is wrong */
437 check(!instr_is_branch_iform(0x7bffffff));
439 /* Simplest case, branch to self with link */
440 check(instr_is_branch_iform(0x48000001));
441 /* All bits of targets set */
442 check(instr_is_branch_iform(0x4bfffffd));
443 /* Some bits of targets set */
444 check(instr_is_branch_iform(0x4bff00fd));
445 /* Must be a valid branch to start with */
446 check(!instr_is_branch_iform(0x7bfffffd));
448 /* Absolute branch to 0x100 */
450 check(instr_is_branch_to_addr(&instr
, 0x100));
451 /* Absolute branch to 0x420fc */
453 check(instr_is_branch_to_addr(&instr
, 0x420fc));
454 /* Maximum positive relative branch, + 20MB - 4B */
456 check(instr_is_branch_to_addr(&instr
, addr
+ 0x1FFFFFC));
457 /* Smallest negative relative branch, - 4B */
459 check(instr_is_branch_to_addr(&instr
, addr
- 4));
460 /* Largest negative relative branch, - 32 MB */
462 check(instr_is_branch_to_addr(&instr
, addr
- 0x2000000));
464 /* Branch to self, with link */
465 instr
= create_branch(&instr
, addr
, BRANCH_SET_LINK
);
466 check(instr_is_branch_to_addr(&instr
, addr
));
468 /* Branch to self - 0x100, with link */
469 instr
= create_branch(&instr
, addr
- 0x100, BRANCH_SET_LINK
);
470 check(instr_is_branch_to_addr(&instr
, addr
- 0x100));
472 /* Branch to self + 0x100, no link */
473 instr
= create_branch(&instr
, addr
+ 0x100, 0);
474 check(instr_is_branch_to_addr(&instr
, addr
+ 0x100));
476 /* Maximum relative negative offset, - 32 MB */
477 instr
= create_branch(&instr
, addr
- 0x2000000, BRANCH_SET_LINK
);
478 check(instr_is_branch_to_addr(&instr
, addr
- 0x2000000));
480 /* Out of range relative negative offset, - 32 MB + 4*/
481 instr
= create_branch(&instr
, addr
- 0x2000004, BRANCH_SET_LINK
);
484 /* Out of range relative positive offset, + 32 MB */
485 instr
= create_branch(&instr
, addr
+ 0x2000000, BRANCH_SET_LINK
);
488 /* Unaligned target */
489 instr
= create_branch(&instr
, addr
+ 3, BRANCH_SET_LINK
);
492 /* Check flags are masked correctly */
493 instr
= create_branch(&instr
, addr
, 0xFFFFFFFC);
494 check(instr_is_branch_to_addr(&instr
, addr
));
495 check(instr
== 0x48000000);
498 static void __init
test_create_function_call(void)
503 /* Check we can create a function call */
504 iptr
= (unsigned int *)ppc_function_entry(test_trampoline
);
505 dest
= ppc_function_entry(test_create_function_call
);
506 patch_instruction(iptr
, create_branch(iptr
, dest
, BRANCH_SET_LINK
));
507 check(instr_is_branch_to_addr(iptr
, dest
));
510 static void __init
test_branch_bform(void)
513 unsigned int *iptr
, instr
, flags
;
516 addr
= (unsigned long)iptr
;
518 /* The simplest case, branch to self, no flags */
519 check(instr_is_branch_bform(0x40000000));
520 /* All bits of target set, and flags */
521 check(instr_is_branch_bform(0x43ffffff));
522 /* High bit of opcode set, which is wrong */
523 check(!instr_is_branch_bform(0xc3ffffff));
524 /* Middle bits of opcode set, which is wrong */
525 check(!instr_is_branch_bform(0x7bffffff));
527 /* Absolute conditional branch to 0x100 */
529 check(instr_is_branch_to_addr(&instr
, 0x100));
530 /* Absolute conditional branch to 0x20fc */
532 check(instr_is_branch_to_addr(&instr
, 0x20fc));
533 /* Maximum positive relative conditional branch, + 32 KB - 4B */
535 check(instr_is_branch_to_addr(&instr
, addr
+ 0x7FFC));
536 /* Smallest negative relative conditional branch, - 4B */
538 check(instr_is_branch_to_addr(&instr
, addr
- 4));
539 /* Largest negative relative conditional branch, - 32 KB */
541 check(instr_is_branch_to_addr(&instr
, addr
- 0x8000));
543 /* All condition code bits set & link */
544 flags
= 0x3ff000 | BRANCH_SET_LINK
;
547 instr
= create_cond_branch(iptr
, addr
, flags
);
548 check(instr_is_branch_to_addr(&instr
, addr
));
550 /* Branch to self - 0x100 */
551 instr
= create_cond_branch(iptr
, addr
- 0x100, flags
);
552 check(instr_is_branch_to_addr(&instr
, addr
- 0x100));
554 /* Branch to self + 0x100 */
555 instr
= create_cond_branch(iptr
, addr
+ 0x100, flags
);
556 check(instr_is_branch_to_addr(&instr
, addr
+ 0x100));
558 /* Maximum relative negative offset, - 32 KB */
559 instr
= create_cond_branch(iptr
, addr
- 0x8000, flags
);
560 check(instr_is_branch_to_addr(&instr
, addr
- 0x8000));
562 /* Out of range relative negative offset, - 32 KB + 4*/
563 instr
= create_cond_branch(iptr
, addr
- 0x8004, flags
);
566 /* Out of range relative positive offset, + 32 KB */
567 instr
= create_cond_branch(iptr
, addr
+ 0x8000, flags
);
570 /* Unaligned target */
571 instr
= create_cond_branch(iptr
, addr
+ 3, flags
);
574 /* Check flags are masked correctly */
575 instr
= create_cond_branch(iptr
, addr
, 0xFFFFFFFC);
576 check(instr_is_branch_to_addr(&instr
, addr
));
577 check(instr
== 0x43FF0000);
580 static void __init
test_translate_branch(void)
586 buf
= vmalloc(PAGE_ALIGN(0x2000000 + 1));
591 /* Simple case, branch to self moved a little */
593 addr
= (unsigned long)p
;
594 patch_branch(p
, addr
, 0);
595 check(instr_is_branch_to_addr(p
, addr
));
597 patch_instruction(q
, translate_branch(q
, p
));
598 check(instr_is_branch_to_addr(q
, addr
));
600 /* Maximum negative case, move b . to addr + 32 MB */
602 addr
= (unsigned long)p
;
603 patch_branch(p
, addr
, 0);
605 patch_instruction(q
, translate_branch(q
, p
));
606 check(instr_is_branch_to_addr(p
, addr
));
607 check(instr_is_branch_to_addr(q
, addr
));
608 check(*q
== 0x4a000000);
610 /* Maximum positive case, move x to x - 32 MB + 4 */
612 addr
= (unsigned long)p
;
613 patch_branch(p
, addr
, 0);
615 patch_instruction(q
, translate_branch(q
, p
));
616 check(instr_is_branch_to_addr(p
, addr
));
617 check(instr_is_branch_to_addr(q
, addr
));
618 check(*q
== 0x49fffffc);
620 /* Jump to x + 16 MB moved to x + 20 MB */
622 addr
= 0x1000000 + (unsigned long)buf
;
623 patch_branch(p
, addr
, BRANCH_SET_LINK
);
625 patch_instruction(q
, translate_branch(q
, p
));
626 check(instr_is_branch_to_addr(p
, addr
));
627 check(instr_is_branch_to_addr(q
, addr
));
629 /* Jump to x + 16 MB moved to x - 16 MB + 4 */
631 addr
= 0x2000000 + (unsigned long)buf
;
632 patch_branch(p
, addr
, 0);
634 patch_instruction(q
, translate_branch(q
, p
));
635 check(instr_is_branch_to_addr(p
, addr
));
636 check(instr_is_branch_to_addr(q
, addr
));
639 /* Conditional branch tests */
641 /* Simple case, branch to self moved a little */
643 addr
= (unsigned long)p
;
644 patch_instruction(p
, create_cond_branch(p
, addr
, 0));
645 check(instr_is_branch_to_addr(p
, addr
));
647 patch_instruction(q
, translate_branch(q
, p
));
648 check(instr_is_branch_to_addr(q
, addr
));
650 /* Maximum negative case, move b . to addr + 32 KB */
652 addr
= (unsigned long)p
;
653 patch_instruction(p
, create_cond_branch(p
, addr
, 0xFFFFFFFC));
655 patch_instruction(q
, translate_branch(q
, p
));
656 check(instr_is_branch_to_addr(p
, addr
));
657 check(instr_is_branch_to_addr(q
, addr
));
658 check(*q
== 0x43ff8000);
660 /* Maximum positive case, move x to x - 32 KB + 4 */
662 addr
= (unsigned long)p
;
663 patch_instruction(p
, create_cond_branch(p
, addr
, 0xFFFFFFFC));
665 patch_instruction(q
, translate_branch(q
, p
));
666 check(instr_is_branch_to_addr(p
, addr
));
667 check(instr_is_branch_to_addr(q
, addr
));
668 check(*q
== 0x43ff7ffc);
670 /* Jump to x + 12 KB moved to x + 20 KB */
672 addr
= 0x3000 + (unsigned long)buf
;
673 patch_instruction(p
, create_cond_branch(p
, addr
, BRANCH_SET_LINK
));
675 patch_instruction(q
, translate_branch(q
, p
));
676 check(instr_is_branch_to_addr(p
, addr
));
677 check(instr_is_branch_to_addr(q
, addr
));
679 /* Jump to x + 8 KB moved to x - 8 KB + 4 */
681 addr
= 0x4000 + (unsigned long)buf
;
682 patch_instruction(p
, create_cond_branch(p
, addr
, 0));
684 patch_instruction(q
, translate_branch(q
, p
));
685 check(instr_is_branch_to_addr(p
, addr
));
686 check(instr_is_branch_to_addr(q
, addr
));
688 /* Free the buffer we were using */
692 static int __init
test_code_patching(void)
694 printk(KERN_DEBUG
"Running code patching self-tests ...\n");
698 test_create_function_call();
699 test_translate_branch();
703 late_initcall(test_code_patching
);
705 #endif /* CONFIG_CODE_PATCHING_SELFTEST */