[deliverable/linux.git] / arch / x86 / include / asm / alternative.h

#ifndef _ASM_X86_ALTERNATIVE_H
#define _ASM_X86_ALTERNATIVE_H

#include <linux/types.h>
#include <linux/stddef.h>
#include <linux/stringify.h>
#include <linux/jump_label.h>
#include <asm/asm.h>

/*
 * Alternative inline assembly for SMP.
 *
 * The LOCK_PREFIX macro defined here replaces the LOCK and
 * LOCK_PREFIX macros used everywhere in the source tree.
 *
 * SMP alternatives use the same data structures as the other
 * alternatives and the X86_FEATURE_UP flag to indicate the case of a
 * UP system running a SMP kernel.  The existing apply_alternatives()
 * works fine for patching a SMP kernel for UP.
 *
 * The SMP alternative tables can be kept after boot and contain both
 * UP and SMP versions of the instructions to allow switching back to
 * SMP at runtime, when hotplugging in a new CPU, which is especially
 * useful in virtualized environments.
 *
 * The very common lock prefix is handled as special case in a
 * separate table which is a pure address list without replacement ptr
 * and size information.  That keeps the table sizes small.
 */

#ifdef CONFIG_SMP
#define LOCK_PREFIX_HERE \
		".section .smp_locks,\"a\"\n"	\
		".balign 4\n"			\
		".long 671f - .\n" /* offset */	\
		".previous\n"			\
		"671:"

#define LOCK_PREFIX LOCK_PREFIX_HERE "\n\tlock; "

#else /* ! CONFIG_SMP */
#define LOCK_PREFIX_HERE ""
#define LOCK_PREFIX ""
#endif

struct alt_instr {
	u8 *instr;		/* original instruction */
	u8 *replacement;
	u16 cpuid;		/* cpuid bit set for replacement */
	u8  instrlen;		/* length of original instruction */
	u8  replacementlen;	/* length of new instruction, <= instrlen */
#ifdef CONFIG_X86_64
	u32 pad2;
#endif
};

extern void alternative_instructions(void);
extern void apply_alternatives(struct alt_instr *start, struct alt_instr *end);

struct module;

#ifdef CONFIG_SMP
extern void alternatives_smp_module_add(struct module *mod, char *name,
					void *locks, void *locks_end,
					void *text, void *text_end);
extern void alternatives_smp_module_del(struct module *mod);
extern void alternatives_smp_switch(int smp);
extern int alternatives_text_reserved(void *start, void *end);
extern bool skip_smp_alternatives;
#else
static inline void alternatives_smp_module_add(struct module *mod, char *name,
					       void *locks, void *locks_end,
					       void *text, void *text_end) {}
static inline void alternatives_smp_module_del(struct module *mod) {}
static inline void alternatives_smp_switch(int smp) {}
static inline int alternatives_text_reserved(void *start, void *end)
{
	return 0;
}
#endif	/* CONFIG_SMP */

/* alternative assembly primitive: */
#define ALTERNATIVE(oldinstr, newinstr, feature)			\
									\
      "661:\n\t" oldinstr "\n662:\n"					\
      ".section .altinstructions,\"a\"\n"				\
      _ASM_ALIGN "\n"							\
      _ASM_PTR "661b\n"				/* label           */	\
      _ASM_PTR "663f\n"				/* new instruction */	\
      "	 .word " __stringify(feature) "\n"	/* feature bit     */	\
      "	 .byte 662b-661b\n"			/* sourcelen       */	\
      "	 .byte 664f-663f\n"			/* replacementlen  */	\
      ".previous\n"							\
      ".section .discard,\"aw\",@progbits\n"				\
      "	 .byte 0xff + (664f-663f) - (662b-661b)\n" /* rlen <= slen */	\
      ".previous\n"							\
      ".section .altinstr_replacement, \"ax\"\n"			\
      "663:\n\t" newinstr "\n664:\n"		/* replacement     */	\
      ".previous"

/*
 * This must be included *after* the definition of ALTERNATIVE due to
 * <asm/arch_hweight.h>
 */
#include <asm/cpufeature.h>

/*
 * Alternative instructions for different CPU types or capabilities.
 *
 * This allows to use optimized instructions even on generic binary
 * kernels.
 *
 * length of oldinstr must be longer or equal the length of newinstr
 * It can be padded with nops as needed.
 *
 * For non barrier like inlines please define new variants
 * without volatile and memory clobber.
 */
#define alternative(oldinstr, newinstr, feature)			\
	asm volatile (ALTERNATIVE(oldinstr, newinstr, feature) : : : "memory")

/*
 * Alternative inline assembly with input.
 *
 * Pecularities:
 * No memory clobber here.
 * Argument numbers start with 1.
 * Best is to use constraints that are fixed size (like (%1) ... "r")
 * If you use variable sized constraints like "m" or "g" in the
 * replacement make sure to pad to the worst case length.
 * Leaving an unused argument 0 to keep API compatibility.
 */
#define alternative_input(oldinstr, newinstr, feature, input...)	\
	asm volatile (ALTERNATIVE(oldinstr, newinstr, feature)		\
		: : "i" (0), ## input)

/* Like alternative_input, but with a single output argument */
#define alternative_io(oldinstr, newinstr, feature, output, input...)	\
	asm volatile (ALTERNATIVE(oldinstr, newinstr, feature)		\
		: output : "i" (0), ## input)

/* Like alternative_io, but for replacing a direct call with another one. */
#define alternative_call(oldfunc, newfunc, feature, output, input...)	\
	asm volatile (ALTERNATIVE("call %P[old]", "call %P[new]", feature) \
		: output : [old] "i" (oldfunc), [new] "i" (newfunc), ## input)

/*
 * use this macro(s) if you need more than one output parameter
 * in alternative_io
 */
#define ASM_OUTPUT2(a...) a

struct paravirt_patch_site;
#ifdef CONFIG_PARAVIRT
void apply_paravirt(struct paravirt_patch_site *start,
		    struct paravirt_patch_site *end);
#else
static inline void apply_paravirt(struct paravirt_patch_site *start,
				  struct paravirt_patch_site *end)
{}
#define __parainstructions	NULL
#define __parainstructions_end	NULL
#endif

extern void *text_poke_early(void *addr, const void *opcode, size_t len);

/*
 * Clear and restore the kernel write-protection flag on the local CPU.
 * Allows the kernel to edit read-only pages.
 * Side-effect: any interrupt handler running between save and restore will have
 * the ability to write to read-only pages.
 *
 * Warning:
 * Code patching in the UP case is safe if NMIs and MCE handlers are stopped and
 * no thread can be preempted in the instructions being modified (no iret to an
 * invalid instruction possible) or if the instructions are changed from a
 * consistent state to another consistent state atomically.
 * More care must be taken when modifying code in the SMP case because of
 * Intel's errata. text_poke_smp() takes care that errata, but still
 * doesn't support NMI/MCE handler code modifying.
 * On the local CPU you need to be protected again NMI or MCE handlers seeing an
 * inconsistent instruction while you patch.
 */
struct text_poke_param {
	void *addr;
	const void *opcode;
	size_t len;
};

extern void *text_poke(void *addr, const void *opcode, size_t len);
extern void *text_poke_smp(void *addr, const void *opcode, size_t len);
extern void text_poke_smp_batch(struct text_poke_param *params, int n);

#if defined(CONFIG_DYNAMIC_FTRACE) || defined(HAVE_JUMP_LABEL)
#define IDEAL_NOP_SIZE_5 5
extern unsigned char ideal_nop5[IDEAL_NOP_SIZE_5];
extern void arch_init_ideal_nop5(void);
#else
static inline void arch_init_ideal_nop5(void) {}
#endif

#endif /* _ASM_X86_ALTERNATIVE_H */
Commit	Line	Data
1965aae3 PA	1	#ifndef _ASM_X86_ALTERNATIVE_H
1965aae3 PA	2	#define _ASM_X86_ALTERNATIVE_H
6b592570 PA	3
	4	#include <linux/types.h>
	5	#include <linux/stddef.h>
edc953fa	6	#include <linux/stringify.h>
bf5438fc	7	#include <linux/jump_label.h>
6b592570 PA	8	#include <asm/asm.h>
	9
	10	/*
	11	* Alternative inline assembly for SMP.
	12	*
	13	* The LOCK_PREFIX macro defined here replaces the LOCK and
	14	* LOCK_PREFIX macros used everywhere in the source tree.
	15	*
	16	* SMP alternatives use the same data structures as the other
	17	* alternatives and the X86_FEATURE_UP flag to indicate the case of a
	18	* UP system running a SMP kernel. The existing apply_alternatives()
	19	* works fine for patching a SMP kernel for UP.
	20	*
	21	* The SMP alternative tables can be kept after boot and contain both
	22	* UP and SMP versions of the instructions to allow switching back to
	23	* SMP at runtime, when hotplugging in a new CPU, which is especially
	24	* useful in virtualized environments.
	25	*
	26	* The very common lock prefix is handled as special case in a
	27	* separate table which is a pure address list without replacement ptr
	28	* and size information. That keeps the table sizes small.
	29	*/
	30
	31	#ifdef CONFIG_SMP
b3ac891b	32	#define LOCK_PREFIX_HERE \
6b592570	33	".section .smp_locks,\"a\"\n" \
5967ed87	34	".balign 4\n" \
d9c5841e	35	".long 671f - .\n" /* offset */ \
6b592570	36	".previous\n" \
b3ac891b LB	37	"671:"
	38
	39	#define LOCK_PREFIX LOCK_PREFIX_HERE "\n\tlock; "
6b592570 PA	40
6b592570 PA	41	#else /* ! CONFIG_SMP */
b701a47b	42	#define LOCK_PREFIX_HERE ""
6b592570 PA	43	#define LOCK_PREFIX ""
	44	#endif
	45
6b592570 PA	46	struct alt_instr {
	47	u8 instr; / original instruction */
	48	u8 *replacement;
83a7a2ad	49	u16 cpuid; /* cpuid bit set for replacement */
6b592570 PA	50	u8 instrlen; /* length of original instruction */
6b592570 PA	51	u8 replacementlen; /* length of new instruction, <= instrlen */
6b592570 PA	52	#ifdef CONFIG_X86_64
	53	u32 pad2;
	54	#endif
	55	};
	56
	57	extern void alternative_instructions(void);
	58	extern void apply_alternatives(struct alt_instr start, struct alt_instr end);
	59
	60	struct module;
	61
	62	#ifdef CONFIG_SMP
	63	extern void alternatives_smp_module_add(struct module mod, char name,
	64	void locks, void locks_end,
	65	void text, void text_end);
	66	extern void alternatives_smp_module_del(struct module *mod);
	67	extern void alternatives_smp_switch(int smp);
2cfa1978	68	extern int alternatives_text_reserved(void start, void end);
3fb82d56	69	extern bool skip_smp_alternatives;
6b592570 PA	70	#else
6b592570 PA	71	static inline void alternatives_smp_module_add(struct module mod, char name,
2ac1ea7c JP	72	void locks, void locks_end,
2ac1ea7c JP	73	void text, void text_end) {}
6b592570 PA	74	static inline void alternatives_smp_module_del(struct module *mod) {}
6b592570 PA	75	static inline void alternatives_smp_switch(int smp) {}
2cfa1978 MH	76	static inline int alternatives_text_reserved(void start, void end)
	77	{
	78	return 0;
	79	}
6b592570 PA	80	#endif /* CONFIG_SMP */
6b592570 PA	81
edc953fa MD	82	/* alternative assembly primitive: */
	83	#define ALTERNATIVE(oldinstr, newinstr, feature) \
	84	\
	85	"661:\n\t" oldinstr "\n662:\n" \
	86	".section .altinstructions,\"a\"\n" \
	87	_ASM_ALIGN "\n" \
	88	_ASM_PTR "661b\n" /* label */ \
	89	_ASM_PTR "663f\n" /* new instruction */ \
83a7a2ad	90	" .word " __stringify(feature) "\n" /* feature bit */ \
edc953fa MD	91	" .byte 662b-661b\n" /* sourcelen */ \
edc953fa MD	92	" .byte 664f-663f\n" /* replacementlen */ \
83a7a2ad PA	93	".previous\n" \
83a7a2ad PA	94	".section .discard,\"aw\",@progbits\n" \
01be50a3	95	" .byte 0xff + (664f-663f) - (662b-661b)\n" /* rlen <= slen */ \
edc953fa MD	96	".previous\n" \
	97	".section .altinstr_replacement, \"ax\"\n" \
	98	"663:\n\t" newinstr "\n664:\n" /* replacement */ \
	99	".previous"
	100
d61931d8 BP	101	/*
	102	* This must be included after the definition of ALTERNATIVE due to
	103	* <asm/arch_hweight.h>
	104	*/
	105	#include <asm/cpufeature.h>
	106
6b592570 PA	107	/*
	108	* Alternative instructions for different CPU types or capabilities.
	109	*
	110	* This allows to use optimized instructions even on generic binary
	111	* kernels.
	112	*
	113	* length of oldinstr must be longer or equal the length of newinstr
	114	* It can be padded with nops as needed.
	115	*
	116	* For non barrier like inlines please define new variants
	117	* without volatile and memory clobber.
	118	*/
	119	#define alternative(oldinstr, newinstr, feature) \
edc953fa	120	asm volatile (ALTERNATIVE(oldinstr, newinstr, feature) : : : "memory")
6b592570 PA	121
	122	/*
	123	* Alternative inline assembly with input.
	124	*
	125	* Pecularities:
	126	* No memory clobber here.
	127	* Argument numbers start with 1.
	128	* Best is to use constraints that are fixed size (like (%1) ... "r")
	129	* If you use variable sized constraints like "m" or "g" in the
	130	* replacement make sure to pad to the worst case length.
edc953fa	131	* Leaving an unused argument 0 to keep API compatibility.
6b592570 PA	132	*/
6b592570 PA	133	#define alternative_input(oldinstr, newinstr, feature, input...) \
edc953fa MD	134	asm volatile (ALTERNATIVE(oldinstr, newinstr, feature) \
edc953fa MD	135	: : "i" (0), ## input)
6b592570 PA	136
	137	/* Like alternative_input, but with a single output argument */
	138	#define alternative_io(oldinstr, newinstr, feature, output, input...) \
edc953fa MD	139	asm volatile (ALTERNATIVE(oldinstr, newinstr, feature) \
edc953fa MD	140	: output : "i" (0), ## input)
6b592570	141
1b1d9258 JB	142	/* Like alternative_io, but for replacing a direct call with another one. */
	143	#define alternative_call(oldfunc, newfunc, feature, output, input...) \
	144	asm volatile (ALTERNATIVE("call %P[old]", "call %P[new]", feature) \
	145	: output : [old] "i" (oldfunc), [new] "i" (newfunc), ## input)
	146
6b592570 PA	147	/*
	148	* use this macro(s) if you need more than one output parameter
	149	* in alternative_io
	150	*/
1b1d9258	151	#define ASM_OUTPUT2(a...) a
6b592570 PA	152
	153	struct paravirt_patch_site;
	154	#ifdef CONFIG_PARAVIRT
	155	void apply_paravirt(struct paravirt_patch_site *start,
	156	struct paravirt_patch_site *end);
96a388de	157	#else
2ac1ea7c JP	158	static inline void apply_paravirt(struct paravirt_patch_site *start,
2ac1ea7c JP	159	struct paravirt_patch_site *end)
6b592570 PA	160	{}
	161	#define __parainstructions NULL
	162	#define __parainstructions_end NULL
96a388de	163	#endif
6b592570	164
fa6f2cc7 JB	165	extern void text_poke_early(void addr, const void *opcode, size_t len);
fa6f2cc7 JB	166
e587cadd MD	167	/*
	168	* Clear and restore the kernel write-protection flag on the local CPU.
	169	* Allows the kernel to edit read-only pages.
	170	* Side-effect: any interrupt handler running between save and restore will have
	171	* the ability to write to read-only pages.
	172	*
	173	* Warning:
	174	* Code patching in the UP case is safe if NMIs and MCE handlers are stopped and
	175	* no thread can be preempted in the instructions being modified (no iret to an
	176	* invalid instruction possible) or if the instructions are changed from a
	177	* consistent state to another consistent state atomically.
	178	* More care must be taken when modifying code in the SMP case because of
3d55cc8a MH	179	* Intel's errata. text_poke_smp() takes care that errata, but still
3d55cc8a MH	180	* doesn't support NMI/MCE handler code modifying.
e587cadd MD	181	* On the local CPU you need to be protected again NMI or MCE handlers seeing an
e587cadd MD	182	* inconsistent instruction while you patch.
e587cadd	183	*/
7deb18dc MH	184	struct text_poke_param {
	185	void *addr;
	186	const void *opcode;
	187	size_t len;
	188	};
	189
e587cadd	190	extern void text_poke(void addr, const void *opcode, size_t len);
3d55cc8a	191	extern void text_poke_smp(void addr, const void *opcode, size_t len);
7deb18dc	192	extern void text_poke_smp_batch(struct text_poke_param *params, int n);
6b592570	193
bf5438fc	194	#if defined(CONFIG_DYNAMIC_FTRACE) \|\| defined(HAVE_JUMP_LABEL)
f49aa448 JB	195	#define IDEAL_NOP_SIZE_5 5
	196	extern unsigned char ideal_nop5[IDEAL_NOP_SIZE_5];
	197	extern void arch_init_ideal_nop5(void);
	198	#else
	199	static inline void arch_init_ideal_nop5(void) {}
	200	#endif
	201
1965aae3	202	#endif /* _ASM_X86_ALTERNATIVE_H */