[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 <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 \
		".pushsection .smp_locks,\"a\"\n"	\
		".balign 4\n"				\
		".long 671f - .\n" /* offset */		\
		".popsection\n"				\
		"671:"

#define LOCK_PREFIX LOCK_PREFIX_HERE "\n\tlock; "

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

struct alt_instr {
	s32 instr_offset;	/* original instruction */
	s32 repl_offset;	/* offset to replacement instruction */
	u16 cpuid;		/* cpuid bit set for replacement */
	u8  instrlen;		/* length of original instruction */
	u8  replacementlen;	/* length of new instruction, <= instrlen */
};

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_enable_smp(void);
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_enable_smp(void) {}
static inline int alternatives_text_reserved(void *start, void *end)
{
	return 0;
}
#endif	/* CONFIG_SMP */

#define OLDINSTR(oldinstr)	"661:\n\t" oldinstr "\n662:\n"

#define b_replacement(number)	"663"#number
#define e_replacement(number)	"664"#number

#define alt_slen "662b-661b"
#define alt_rlen(number) e_replacement(number)"f-"b_replacement(number)"f"

#define ALTINSTR_ENTRY(feature, number)					      \
	" .long 661b - .\n"				/* label           */ \
	" .long " b_replacement(number)"f - .\n"	/* new instruction */ \
	" .word " __stringify(feature) "\n"		/* feature bit     */ \
	" .byte " alt_slen "\n"				/* source len      */ \
	" .byte " alt_rlen(number) "\n"			/* replacement len */

#define DISCARD_ENTRY(number)				/* rlen <= slen */    \
	" .byte 0xff + (" alt_rlen(number) ") - (" alt_slen ")\n"

#define ALTINSTR_REPLACEMENT(newinstr, feature, number)	/* replacement */     \
	b_replacement(number)":\n\t" newinstr "\n" e_replacement(number) ":\n\t"

/* alternative assembly primitive: */
#define ALTERNATIVE(oldinstr, newinstr, feature)			\
	OLDINSTR(oldinstr)						\
	".pushsection .altinstructions,\"a\"\n"				\
	ALTINSTR_ENTRY(feature, 1)					\
	".popsection\n"							\
	".pushsection .discard,\"aw\",@progbits\n"			\
	DISCARD_ENTRY(1)						\
	".popsection\n"							\
	".pushsection .altinstr_replacement, \"ax\"\n"			\
	ALTINSTR_REPLACEMENT(newinstr, feature, 1)			\
	".popsection"

#define ALTERNATIVE_2(oldinstr, newinstr1, feature1, newinstr2, feature2)\
	OLDINSTR(oldinstr)						\
	".pushsection .altinstructions,\"a\"\n"				\
	ALTINSTR_ENTRY(feature1, 1)					\
	ALTINSTR_ENTRY(feature2, 2)					\
	".popsection\n"							\
	".pushsection .discard,\"aw\",@progbits\n"			\
	DISCARD_ENTRY(1)						\
	DISCARD_ENTRY(2)						\
	".popsection\n"							\
	".pushsection .altinstr_replacement, \"ax\"\n"			\
	ALTINSTR_REPLACEMENT(newinstr1, feature1, 1)			\
	ALTINSTR_REPLACEMENT(newinstr2, feature2, 2)			\
	".popsection"

/*
 * 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)

/*
 * Like alternative_call, but there are two features and respective functions.
 * If CPU has feature2, function2 is used.
 * Otherwise, if CPU has feature1, function1 is used.
 * Otherwise, old function is used.
 */
#define alternative_call_2(oldfunc, newfunc1, feature1, newfunc2, feature2,   \
			   output, input...)				      \
	asm volatile (ALTERNATIVE_2("call %P[old]", "call %P[new1]", feature1,\
		"call %P[new2]", feature2)				      \
		: output : [old] "i" (oldfunc), [new1] "i" (newfunc1),	      \
		[new2] "i" (newfunc2), ## input)

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

/*
 * use this macro if you need clobbers but no inputs in
 * alternative_{input,io,call}()
 */
#define ASM_NO_INPUT_CLOBBER(clbr...) "i" (0) : clbr

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);

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