1 #define pr_fmt(fmt) "SMP alternatives: " fmt
3 #include <linux/module.h>
4 #include <linux/sched.h>
5 #include <linux/mutex.h>
6 #include <linux/list.h>
7 #include <linux/stringify.h>
9 #include <linux/vmalloc.h>
10 #include <linux/memory.h>
11 #include <linux/stop_machine.h>
12 #include <linux/slab.h>
13 #include <linux/kdebug.h>
14 #include <asm/alternative.h>
15 #include <asm/sections.h>
16 #include <asm/pgtable.h>
19 #include <asm/cacheflush.h>
20 #include <asm/tlbflush.h>
22 #include <asm/fixmap.h>
24 int __read_mostly alternatives_patched
;
26 EXPORT_SYMBOL_GPL(alternatives_patched
);
28 #define MAX_PATCH_LEN (255-1)
30 static int __initdata_or_module debug_alternative
;
32 static int __init
debug_alt(char *str
)
34 debug_alternative
= 1;
37 __setup("debug-alternative", debug_alt
);
39 static int noreplace_smp
;
41 static int __init
setup_noreplace_smp(char *str
)
46 __setup("noreplace-smp", setup_noreplace_smp
);
48 #ifdef CONFIG_PARAVIRT
49 static int __initdata_or_module noreplace_paravirt
= 0;
51 static int __init
setup_noreplace_paravirt(char *str
)
53 noreplace_paravirt
= 1;
56 __setup("noreplace-paravirt", setup_noreplace_paravirt
);
59 #define DPRINTK(fmt, args...) \
61 if (debug_alternative) \
62 printk(KERN_DEBUG "%s: " fmt "\n", __func__, ##args); \
65 #define DUMP_BYTES(buf, len, fmt, args...) \
67 if (unlikely(debug_alternative)) { \
73 printk(KERN_DEBUG fmt, ##args); \
74 for (j = 0; j < (len) - 1; j++) \
75 printk(KERN_CONT "%02hhx ", buf[j]); \
76 printk(KERN_CONT "%02hhx\n", buf[j]); \
81 * Each GENERIC_NOPX is of X bytes, and defined as an array of bytes
82 * that correspond to that nop. Getting from one nop to the next, we
83 * add to the array the offset that is equal to the sum of all sizes of
84 * nops preceding the one we are after.
86 * Note: The GENERIC_NOP5_ATOMIC is at the end, as it breaks the
87 * nice symmetry of sizes of the previous nops.
89 #if defined(GENERIC_NOP1) && !defined(CONFIG_X86_64)
90 static const unsigned char intelnops
[] =
102 static const unsigned char * const intel_nops
[ASM_NOP_MAX
+2] =
108 intelnops
+ 1 + 2 + 3,
109 intelnops
+ 1 + 2 + 3 + 4,
110 intelnops
+ 1 + 2 + 3 + 4 + 5,
111 intelnops
+ 1 + 2 + 3 + 4 + 5 + 6,
112 intelnops
+ 1 + 2 + 3 + 4 + 5 + 6 + 7,
113 intelnops
+ 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8,
118 static const unsigned char k8nops
[] =
130 static const unsigned char * const k8_nops
[ASM_NOP_MAX
+2] =
137 k8nops
+ 1 + 2 + 3 + 4,
138 k8nops
+ 1 + 2 + 3 + 4 + 5,
139 k8nops
+ 1 + 2 + 3 + 4 + 5 + 6,
140 k8nops
+ 1 + 2 + 3 + 4 + 5 + 6 + 7,
141 k8nops
+ 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8,
145 #if defined(K7_NOP1) && !defined(CONFIG_X86_64)
146 static const unsigned char k7nops
[] =
158 static const unsigned char * const k7_nops
[ASM_NOP_MAX
+2] =
165 k7nops
+ 1 + 2 + 3 + 4,
166 k7nops
+ 1 + 2 + 3 + 4 + 5,
167 k7nops
+ 1 + 2 + 3 + 4 + 5 + 6,
168 k7nops
+ 1 + 2 + 3 + 4 + 5 + 6 + 7,
169 k7nops
+ 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8,
174 static const unsigned char p6nops
[] =
186 static const unsigned char * const p6_nops
[ASM_NOP_MAX
+2] =
193 p6nops
+ 1 + 2 + 3 + 4,
194 p6nops
+ 1 + 2 + 3 + 4 + 5,
195 p6nops
+ 1 + 2 + 3 + 4 + 5 + 6,
196 p6nops
+ 1 + 2 + 3 + 4 + 5 + 6 + 7,
197 p6nops
+ 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8,
201 /* Initialize these to a safe default */
203 const unsigned char * const *ideal_nops
= p6_nops
;
205 const unsigned char * const *ideal_nops
= intel_nops
;
208 void __init
arch_init_ideal_nops(void)
210 switch (boot_cpu_data
.x86_vendor
) {
211 case X86_VENDOR_INTEL
:
213 * Due to a decoder implementation quirk, some
214 * specific Intel CPUs actually perform better with
215 * the "k8_nops" than with the SDM-recommended NOPs.
217 if (boot_cpu_data
.x86
== 6 &&
218 boot_cpu_data
.x86_model
>= 0x0f &&
219 boot_cpu_data
.x86_model
!= 0x1c &&
220 boot_cpu_data
.x86_model
!= 0x26 &&
221 boot_cpu_data
.x86_model
!= 0x27 &&
222 boot_cpu_data
.x86_model
< 0x30) {
223 ideal_nops
= k8_nops
;
224 } else if (boot_cpu_has(X86_FEATURE_NOPL
)) {
225 ideal_nops
= p6_nops
;
228 ideal_nops
= k8_nops
;
230 ideal_nops
= intel_nops
;
236 if (boot_cpu_data
.x86
> 0xf) {
237 ideal_nops
= p6_nops
;
245 ideal_nops
= k8_nops
;
247 if (boot_cpu_has(X86_FEATURE_K8
))
248 ideal_nops
= k8_nops
;
249 else if (boot_cpu_has(X86_FEATURE_K7
))
250 ideal_nops
= k7_nops
;
252 ideal_nops
= intel_nops
;
257 /* Use this to add nops to a buffer, then text_poke the whole buffer. */
258 static void __init_or_module
add_nops(void *insns
, unsigned int len
)
261 unsigned int noplen
= len
;
262 if (noplen
> ASM_NOP_MAX
)
263 noplen
= ASM_NOP_MAX
;
264 memcpy(insns
, ideal_nops
[noplen
], noplen
);
270 extern struct alt_instr __alt_instructions
[], __alt_instructions_end
[];
271 extern s32 __smp_locks
[], __smp_locks_end
[];
272 void *text_poke_early(void *addr
, const void *opcode
, size_t len
);
275 * Are we looking at a near JMP with a 1 or 4-byte displacement.
277 static inline bool is_jmp(const u8 opcode
)
279 return opcode
== 0xeb || opcode
== 0xe9;
282 static void __init_or_module
283 recompute_jump(struct alt_instr
*a
, u8
*orig_insn
, u8
*repl_insn
, u8
*insnbuf
)
285 u8
*next_rip
, *tgt_rip
;
289 if (a
->replacementlen
!= 5)
292 o_dspl
= *(s32
*)(insnbuf
+ 1);
294 /* next_rip of the replacement JMP */
295 next_rip
= repl_insn
+ a
->replacementlen
;
296 /* target rip of the replacement JMP */
297 tgt_rip
= next_rip
+ o_dspl
;
298 n_dspl
= tgt_rip
- orig_insn
;
300 DPRINTK("target RIP: %p, new_displ: 0x%x", tgt_rip
, n_dspl
);
302 if (tgt_rip
- orig_insn
>= 0) {
303 if (n_dspl
- 2 <= 127)
307 /* negative offset */
309 if (((n_dspl
- 2) & 0xff) == (n_dspl
- 2))
319 insnbuf
[1] = (s8
)n_dspl
;
320 add_nops(insnbuf
+ 2, 3);
329 *(s32
*)&insnbuf
[1] = n_dspl
;
335 DPRINTK("final displ: 0x%08x, JMP 0x%lx",
336 n_dspl
, (unsigned long)orig_insn
+ n_dspl
+ repl_len
);
339 static void __init_or_module
optimize_nops(struct alt_instr
*a
, u8
*instr
)
343 if (instr
[0] != 0x90)
346 local_irq_save(flags
);
347 add_nops(instr
+ (a
->instrlen
- a
->padlen
), a
->padlen
);
349 local_irq_restore(flags
);
351 DUMP_BYTES(instr
, a
->instrlen
, "%p: [%d:%d) optimized NOPs: ",
352 instr
, a
->instrlen
- a
->padlen
, a
->padlen
);
356 * Replace instructions with better alternatives for this CPU type. This runs
357 * before SMP is initialized to avoid SMP problems with self modifying code.
358 * This implies that asymmetric systems where APs have less capabilities than
359 * the boot processor are not handled. Tough. Make sure you disable such
362 void __init_or_module
apply_alternatives(struct alt_instr
*start
,
363 struct alt_instr
*end
)
366 u8
*instr
, *replacement
;
367 u8 insnbuf
[MAX_PATCH_LEN
];
369 DPRINTK("alt table %p -> %p", start
, end
);
371 * The scan order should be from start to end. A later scanned
372 * alternative code can overwrite previously scanned alternative code.
373 * Some kernel functions (e.g. memcpy, memset, etc) use this order to
376 * So be careful if you want to change the scan order to any other
379 for (a
= start
; a
< end
; a
++) {
382 instr
= (u8
*)&a
->instr_offset
+ a
->instr_offset
;
383 replacement
= (u8
*)&a
->repl_offset
+ a
->repl_offset
;
384 BUG_ON(a
->instrlen
> sizeof(insnbuf
));
385 BUG_ON(a
->cpuid
>= (NCAPINTS
+ NBUGINTS
) * 32);
386 if (!boot_cpu_has(a
->cpuid
)) {
388 optimize_nops(a
, instr
);
393 DPRINTK("feat: %d*32+%d, old: (%p, len: %d), repl: (%p, len: %d), pad: %d",
397 replacement
, a
->replacementlen
, a
->padlen
);
399 DUMP_BYTES(instr
, a
->instrlen
, "%p: old_insn: ", instr
);
400 DUMP_BYTES(replacement
, a
->replacementlen
, "%p: rpl_insn: ", replacement
);
402 memcpy(insnbuf
, replacement
, a
->replacementlen
);
403 insnbuf_sz
= a
->replacementlen
;
405 /* 0xe8 is a relative jump; fix the offset. */
406 if (*insnbuf
== 0xe8 && a
->replacementlen
== 5) {
407 *(s32
*)(insnbuf
+ 1) += replacement
- instr
;
408 DPRINTK("Fix CALL offset: 0x%x, CALL 0x%lx",
409 *(s32
*)(insnbuf
+ 1),
410 (unsigned long)instr
+ *(s32
*)(insnbuf
+ 1) + 5);
413 if (a
->replacementlen
&& is_jmp(replacement
[0]))
414 recompute_jump(a
, instr
, replacement
, insnbuf
);
416 if (a
->instrlen
> a
->replacementlen
) {
417 add_nops(insnbuf
+ a
->replacementlen
,
418 a
->instrlen
- a
->replacementlen
);
419 insnbuf_sz
+= a
->instrlen
- a
->replacementlen
;
421 DUMP_BYTES(insnbuf
, insnbuf_sz
, "%p: final_insn: ", instr
);
423 text_poke_early(instr
, insnbuf
, insnbuf_sz
);
428 static void alternatives_smp_lock(const s32
*start
, const s32
*end
,
429 u8
*text
, u8
*text_end
)
433 mutex_lock(&text_mutex
);
434 for (poff
= start
; poff
< end
; poff
++) {
435 u8
*ptr
= (u8
*)poff
+ *poff
;
437 if (!*poff
|| ptr
< text
|| ptr
>= text_end
)
439 /* turn DS segment override prefix into lock prefix */
441 text_poke(ptr
, ((unsigned char []){0xf0}), 1);
443 mutex_unlock(&text_mutex
);
446 static void alternatives_smp_unlock(const s32
*start
, const s32
*end
,
447 u8
*text
, u8
*text_end
)
451 mutex_lock(&text_mutex
);
452 for (poff
= start
; poff
< end
; poff
++) {
453 u8
*ptr
= (u8
*)poff
+ *poff
;
455 if (!*poff
|| ptr
< text
|| ptr
>= text_end
)
457 /* turn lock prefix into DS segment override prefix */
459 text_poke(ptr
, ((unsigned char []){0x3E}), 1);
461 mutex_unlock(&text_mutex
);
464 struct smp_alt_module
{
465 /* what is this ??? */
469 /* ptrs to lock prefixes */
471 const s32
*locks_end
;
473 /* .text segment, needed to avoid patching init code ;) */
477 struct list_head next
;
479 static LIST_HEAD(smp_alt_modules
);
480 static DEFINE_MUTEX(smp_alt
);
481 static bool uniproc_patched
= false; /* protected by smp_alt */
483 void __init_or_module
alternatives_smp_module_add(struct module
*mod
,
485 void *locks
, void *locks_end
,
486 void *text
, void *text_end
)
488 struct smp_alt_module
*smp
;
490 mutex_lock(&smp_alt
);
491 if (!uniproc_patched
)
494 if (num_possible_cpus() == 1)
495 /* Don't bother remembering, we'll never have to undo it. */
498 smp
= kzalloc(sizeof(*smp
), GFP_KERNEL
);
500 /* we'll run the (safe but slow) SMP code then ... */
506 smp
->locks_end
= locks_end
;
508 smp
->text_end
= text_end
;
509 DPRINTK("locks %p -> %p, text %p -> %p, name %s\n",
510 smp
->locks
, smp
->locks_end
,
511 smp
->text
, smp
->text_end
, smp
->name
);
513 list_add_tail(&smp
->next
, &smp_alt_modules
);
515 alternatives_smp_unlock(locks
, locks_end
, text
, text_end
);
517 mutex_unlock(&smp_alt
);
520 void __init_or_module
alternatives_smp_module_del(struct module
*mod
)
522 struct smp_alt_module
*item
;
524 mutex_lock(&smp_alt
);
525 list_for_each_entry(item
, &smp_alt_modules
, next
) {
526 if (mod
!= item
->mod
)
528 list_del(&item
->next
);
532 mutex_unlock(&smp_alt
);
535 void alternatives_enable_smp(void)
537 struct smp_alt_module
*mod
;
539 /* Why bother if there are no other CPUs? */
540 BUG_ON(num_possible_cpus() == 1);
542 mutex_lock(&smp_alt
);
544 if (uniproc_patched
) {
545 pr_info("switching to SMP code\n");
546 BUG_ON(num_online_cpus() != 1);
547 clear_cpu_cap(&boot_cpu_data
, X86_FEATURE_UP
);
548 clear_cpu_cap(&cpu_data(0), X86_FEATURE_UP
);
549 list_for_each_entry(mod
, &smp_alt_modules
, next
)
550 alternatives_smp_lock(mod
->locks
, mod
->locks_end
,
551 mod
->text
, mod
->text_end
);
552 uniproc_patched
= false;
554 mutex_unlock(&smp_alt
);
557 /* Return 1 if the address range is reserved for smp-alternatives */
558 int alternatives_text_reserved(void *start
, void *end
)
560 struct smp_alt_module
*mod
;
562 u8
*text_start
= start
;
565 list_for_each_entry(mod
, &smp_alt_modules
, next
) {
566 if (mod
->text
> text_end
|| mod
->text_end
< text_start
)
568 for (poff
= mod
->locks
; poff
< mod
->locks_end
; poff
++) {
569 const u8
*ptr
= (const u8
*)poff
+ *poff
;
571 if (text_start
<= ptr
&& text_end
> ptr
)
578 #endif /* CONFIG_SMP */
580 #ifdef CONFIG_PARAVIRT
581 void __init_or_module
apply_paravirt(struct paravirt_patch_site
*start
,
582 struct paravirt_patch_site
*end
)
584 struct paravirt_patch_site
*p
;
585 char insnbuf
[MAX_PATCH_LEN
];
587 if (noreplace_paravirt
)
590 for (p
= start
; p
< end
; p
++) {
593 BUG_ON(p
->len
> MAX_PATCH_LEN
);
594 /* prep the buffer with the original instructions */
595 memcpy(insnbuf
, p
->instr
, p
->len
);
596 used
= pv_init_ops
.patch(p
->instrtype
, p
->clobbers
, insnbuf
,
597 (unsigned long)p
->instr
, p
->len
);
599 BUG_ON(used
> p
->len
);
601 /* Pad the rest with nops */
602 add_nops(insnbuf
+ used
, p
->len
- used
);
603 text_poke_early(p
->instr
, insnbuf
, p
->len
);
606 extern struct paravirt_patch_site __start_parainstructions
[],
607 __stop_parainstructions
[];
608 #endif /* CONFIG_PARAVIRT */
610 void __init
alternative_instructions(void)
612 /* The patching is not fully atomic, so try to avoid local interruptions
613 that might execute the to be patched code.
614 Other CPUs are not running. */
618 * Don't stop machine check exceptions while patching.
619 * MCEs only happen when something got corrupted and in this
620 * case we must do something about the corruption.
621 * Ignoring it is worse than a unlikely patching race.
622 * Also machine checks tend to be broadcast and if one CPU
623 * goes into machine check the others follow quickly, so we don't
624 * expect a machine check to cause undue problems during to code
628 apply_alternatives(__alt_instructions
, __alt_instructions_end
);
631 /* Patch to UP if other cpus not imminent. */
632 if (!noreplace_smp
&& (num_present_cpus() == 1 || setup_max_cpus
<= 1)) {
633 uniproc_patched
= true;
634 alternatives_smp_module_add(NULL
, "core kernel",
635 __smp_locks
, __smp_locks_end
,
639 if (!uniproc_patched
|| num_possible_cpus() == 1)
640 free_init_pages("SMP alternatives",
641 (unsigned long)__smp_locks
,
642 (unsigned long)__smp_locks_end
);
645 apply_paravirt(__parainstructions
, __parainstructions_end
);
648 alternatives_patched
= 1;
652 * text_poke_early - Update instructions on a live kernel at boot time
653 * @addr: address to modify
654 * @opcode: source of the copy
655 * @len: length to copy
657 * When you use this code to patch more than one byte of an instruction
658 * you need to make sure that other CPUs cannot execute this code in parallel.
659 * Also no thread must be currently preempted in the middle of these
660 * instructions. And on the local CPU you need to be protected again NMI or MCE
661 * handlers seeing an inconsistent instruction while you patch.
663 void *__init_or_module
text_poke_early(void *addr
, const void *opcode
,
667 local_irq_save(flags
);
668 memcpy(addr
, opcode
, len
);
670 local_irq_restore(flags
);
671 /* Could also do a CLFLUSH here to speed up CPU recovery; but
672 that causes hangs on some VIA CPUs. */
677 * text_poke - Update instructions on a live kernel
678 * @addr: address to modify
679 * @opcode: source of the copy
680 * @len: length to copy
682 * Only atomic text poke/set should be allowed when not doing early patching.
683 * It means the size must be writable atomically and the address must be aligned
684 * in a way that permits an atomic write. It also makes sure we fit on a single
687 * Note: Must be called under text_mutex.
689 void *text_poke(void *addr
, const void *opcode
, size_t len
)
693 struct page
*pages
[2];
696 if (!core_kernel_text((unsigned long)addr
)) {
697 pages
[0] = vmalloc_to_page(addr
);
698 pages
[1] = vmalloc_to_page(addr
+ PAGE_SIZE
);
700 pages
[0] = virt_to_page(addr
);
701 WARN_ON(!PageReserved(pages
[0]));
702 pages
[1] = virt_to_page(addr
+ PAGE_SIZE
);
705 local_irq_save(flags
);
706 set_fixmap(FIX_TEXT_POKE0
, page_to_phys(pages
[0]));
708 set_fixmap(FIX_TEXT_POKE1
, page_to_phys(pages
[1]));
709 vaddr
= (char *)fix_to_virt(FIX_TEXT_POKE0
);
710 memcpy(&vaddr
[(unsigned long)addr
& ~PAGE_MASK
], opcode
, len
);
711 clear_fixmap(FIX_TEXT_POKE0
);
713 clear_fixmap(FIX_TEXT_POKE1
);
716 /* Could also do a CLFLUSH here to speed up CPU recovery; but
717 that causes hangs on some VIA CPUs. */
718 for (i
= 0; i
< len
; i
++)
719 BUG_ON(((char *)addr
)[i
] != ((char *)opcode
)[i
]);
720 local_irq_restore(flags
);
724 static void do_sync_core(void *info
)
729 static bool bp_patching_in_progress
;
730 static void *bp_int3_handler
, *bp_int3_addr
;
732 int poke_int3_handler(struct pt_regs
*regs
)
734 /* bp_patching_in_progress */
737 if (likely(!bp_patching_in_progress
))
740 if (user_mode(regs
) || regs
->ip
!= (unsigned long)bp_int3_addr
)
743 /* set up the specified breakpoint handler */
744 regs
->ip
= (unsigned long) bp_int3_handler
;
751 * text_poke_bp() -- update instructions on live kernel on SMP
752 * @addr: address to patch
753 * @opcode: opcode of new instruction
754 * @len: length to copy
755 * @handler: address to jump to when the temporary breakpoint is hit
757 * Modify multi-byte instruction by using int3 breakpoint on SMP.
758 * We completely avoid stop_machine() here, and achieve the
759 * synchronization using int3 breakpoint.
761 * The way it is done:
762 * - add a int3 trap to the address that will be patched
764 * - update all but the first byte of the patched range
766 * - replace the first byte (int3) by the first byte of
770 * Note: must be called under text_mutex.
772 void *text_poke_bp(void *addr
, const void *opcode
, size_t len
, void *handler
)
774 unsigned char int3
= 0xcc;
776 bp_int3_handler
= handler
;
777 bp_int3_addr
= (u8
*)addr
+ sizeof(int3
);
778 bp_patching_in_progress
= true;
780 * Corresponding read barrier in int3 notifier for
781 * making sure the in_progress flags is correctly ordered wrt.
786 text_poke(addr
, &int3
, sizeof(int3
));
788 on_each_cpu(do_sync_core
, NULL
, 1);
790 if (len
- sizeof(int3
) > 0) {
791 /* patch all but the first byte */
792 text_poke((char *)addr
+ sizeof(int3
),
793 (const char *) opcode
+ sizeof(int3
),
796 * According to Intel, this core syncing is very likely
797 * not necessary and we'd be safe even without it. But
798 * better safe than sorry (plus there's not only Intel).
800 on_each_cpu(do_sync_core
, NULL
, 1);
803 /* patch the first byte */
804 text_poke(addr
, opcode
, sizeof(int3
));
806 on_each_cpu(do_sync_core
, NULL
, 1);
808 bp_patching_in_progress
= false;