x86: Add text_poke_smp for SMP cross modifying code
[linux-3.10.git] / arch / x86 / include / asm / alternative.h
1 #ifndef _ASM_X86_ALTERNATIVE_H
2 #define _ASM_X86_ALTERNATIVE_H
3
4 #include <linux/types.h>
5 #include <linux/stddef.h>
6 #include <linux/stringify.h>
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
31 #define LOCK_PREFIX \
32                 ".section .smp_locks,\"a\"\n"   \
33                 _ASM_ALIGN "\n"                 \
34                 _ASM_PTR "661f\n" /* address */ \
35                 ".previous\n"                   \
36                 "661:\n\tlock; "
37
38 #else /* ! CONFIG_SMP */
39 #define LOCK_PREFIX ""
40 #endif
41
42 /* This must be included *after* the definition of LOCK_PREFIX */
43 #include <asm/cpufeature.h>
44
45 struct alt_instr {
46         u8 *instr;              /* original instruction */
47         u8 *replacement;
48         u8  cpuid;              /* cpuid bit set for replacement */
49         u8  instrlen;           /* length of original instruction */
50         u8  replacementlen;     /* length of new instruction, <= instrlen */
51         u8  pad1;
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);
68 extern int alternatives_text_reserved(void *start, void *end);
69 #else
70 static inline void alternatives_smp_module_add(struct module *mod, char *name,
71                                                void *locks, void *locks_end,
72                                                void *text, void *text_end) {}
73 static inline void alternatives_smp_module_del(struct module *mod) {}
74 static inline void alternatives_smp_switch(int smp) {}
75 static inline int alternatives_text_reserved(void *start, void *end)
76 {
77         return 0;
78 }
79 #endif  /* CONFIG_SMP */
80
81 /* alternative assembly primitive: */
82 #define ALTERNATIVE(oldinstr, newinstr, feature)                        \
83                                                                         \
84       "661:\n\t" oldinstr "\n662:\n"                                    \
85       ".section .altinstructions,\"a\"\n"                               \
86       _ASM_ALIGN "\n"                                                   \
87       _ASM_PTR "661b\n"                         /* label           */   \
88       _ASM_PTR "663f\n"                         /* new instruction */   \
89       "  .byte " __stringify(feature) "\n"      /* feature bit     */   \
90       "  .byte 662b-661b\n"                     /* sourcelen       */   \
91       "  .byte 664f-663f\n"                     /* replacementlen  */   \
92       "  .byte 0xff + (664f-663f) - (662b-661b)\n" /* rlen <= slen */   \
93       ".previous\n"                                                     \
94       ".section .altinstr_replacement, \"ax\"\n"                        \
95       "663:\n\t" newinstr "\n664:\n"            /* replacement     */   \
96       ".previous"
97
98 /*
99  * Alternative instructions for different CPU types or capabilities.
100  *
101  * This allows to use optimized instructions even on generic binary
102  * kernels.
103  *
104  * length of oldinstr must be longer or equal the length of newinstr
105  * It can be padded with nops as needed.
106  *
107  * For non barrier like inlines please define new variants
108  * without volatile and memory clobber.
109  */
110 #define alternative(oldinstr, newinstr, feature)                        \
111         asm volatile (ALTERNATIVE(oldinstr, newinstr, feature) : : : "memory")
112
113 /*
114  * Alternative inline assembly with input.
115  *
116  * Pecularities:
117  * No memory clobber here.
118  * Argument numbers start with 1.
119  * Best is to use constraints that are fixed size (like (%1) ... "r")
120  * If you use variable sized constraints like "m" or "g" in the
121  * replacement make sure to pad to the worst case length.
122  * Leaving an unused argument 0 to keep API compatibility.
123  */
124 #define alternative_input(oldinstr, newinstr, feature, input...)        \
125         asm volatile (ALTERNATIVE(oldinstr, newinstr, feature)          \
126                 : : "i" (0), ## input)
127
128 /* Like alternative_input, but with a single output argument */
129 #define alternative_io(oldinstr, newinstr, feature, output, input...)   \
130         asm volatile (ALTERNATIVE(oldinstr, newinstr, feature)          \
131                 : output : "i" (0), ## input)
132
133 /*
134  * use this macro(s) if you need more than one output parameter
135  * in alternative_io
136  */
137 #define ASM_OUTPUT2(a, b) a, b
138
139 struct paravirt_patch_site;
140 #ifdef CONFIG_PARAVIRT
141 void apply_paravirt(struct paravirt_patch_site *start,
142                     struct paravirt_patch_site *end);
143 #else
144 static inline void apply_paravirt(struct paravirt_patch_site *start,
145                                   struct paravirt_patch_site *end)
146 {}
147 #define __parainstructions      NULL
148 #define __parainstructions_end  NULL
149 #endif
150
151 /*
152  * Clear and restore the kernel write-protection flag on the local CPU.
153  * Allows the kernel to edit read-only pages.
154  * Side-effect: any interrupt handler running between save and restore will have
155  * the ability to write to read-only pages.
156  *
157  * Warning:
158  * Code patching in the UP case is safe if NMIs and MCE handlers are stopped and
159  * no thread can be preempted in the instructions being modified (no iret to an
160  * invalid instruction possible) or if the instructions are changed from a
161  * consistent state to another consistent state atomically.
162  * More care must be taken when modifying code in the SMP case because of
163  * Intel's errata. text_poke_smp() takes care that errata, but still
164  * doesn't support NMI/MCE handler code modifying.
165  * On the local CPU you need to be protected again NMI or MCE handlers seeing an
166  * inconsistent instruction while you patch.
167  */
168 extern void *text_poke(void *addr, const void *opcode, size_t len);
169 extern void *text_poke_smp(void *addr, const void *opcode, size_t len);
170
171 #endif /* _ASM_X86_ALTERNATIVE_H */