x86, xsave: save/restore the extended state context in sigframe
[linux-2.6.git] / include / asm-x86 / i387.h
1 /*
2  * Copyright (C) 1994 Linus Torvalds
3  *
4  * Pentium III FXSR, SSE support
5  * General FPU state handling cleanups
6  *      Gareth Hughes <gareth@valinux.com>, May 2000
7  * x86-64 work by Andi Kleen 2002
8  */
9
10 #ifndef ASM_X86__I387_H
11 #define ASM_X86__I387_H
12
13 #include <linux/sched.h>
14 #include <linux/kernel_stat.h>
15 #include <linux/regset.h>
16 #include <asm/asm.h>
17 #include <asm/processor.h>
18 #include <asm/sigcontext.h>
19 #include <asm/user.h>
20 #include <asm/uaccess.h>
21 #include <asm/xsave.h>
22
23 extern unsigned int sig_xstate_size;
24 extern void fpu_init(void);
25 extern void mxcsr_feature_mask_init(void);
26 extern int init_fpu(struct task_struct *child);
27 extern asmlinkage void math_state_restore(void);
28 extern void init_thread_xstate(void);
29
30 extern user_regset_active_fn fpregs_active, xfpregs_active;
31 extern user_regset_get_fn fpregs_get, xfpregs_get, fpregs_soft_get;
32 extern user_regset_set_fn fpregs_set, xfpregs_set, fpregs_soft_set;
33
34 extern struct _fpx_sw_bytes fx_sw_reserved;
35 #ifdef CONFIG_IA32_EMULATION
36 extern unsigned int sig_xstate_ia32_size;
37 extern struct _fpx_sw_bytes fx_sw_reserved_ia32;
38 struct _fpstate_ia32;
39 struct _xstate_ia32;
40 extern int save_i387_xstate_ia32(void __user *buf);
41 extern int restore_i387_xstate_ia32(void __user *buf);
42 #endif
43
44 #define X87_FSW_ES (1 << 7)     /* Exception Summary */
45
46 #ifdef CONFIG_X86_64
47
48 /* Ignore delayed exceptions from user space */
49 static inline void tolerant_fwait(void)
50 {
51         asm volatile("1: fwait\n"
52                      "2:\n"
53                      _ASM_EXTABLE(1b, 2b));
54 }
55
56 static inline int fxrstor_checking(struct i387_fxsave_struct *fx)
57 {
58         int err;
59
60         asm volatile("1:  rex64/fxrstor (%[fx])\n\t"
61                      "2:\n"
62                      ".section .fixup,\"ax\"\n"
63                      "3:  movl $-1,%[err]\n"
64                      "    jmp  2b\n"
65                      ".previous\n"
66                      _ASM_EXTABLE(1b, 3b)
67                      : [err] "=r" (err)
68 #if 0 /* See comment in __save_init_fpu() below. */
69                      : [fx] "r" (fx), "m" (*fx), "0" (0));
70 #else
71                      : [fx] "cdaSDb" (fx), "m" (*fx), "0" (0));
72 #endif
73         return err;
74 }
75
76 static inline int restore_fpu_checking(struct task_struct *tsk)
77 {
78         if (task_thread_info(tsk)->status & TS_XSAVE)
79                 return xrstor_checking(&tsk->thread.xstate->xsave);
80         else
81                 return fxrstor_checking(&tsk->thread.xstate->fxsave);
82 }
83
84 /* AMD CPUs don't save/restore FDP/FIP/FOP unless an exception
85    is pending. Clear the x87 state here by setting it to fixed
86    values. The kernel data segment can be sometimes 0 and sometimes
87    new user value. Both should be ok.
88    Use the PDA as safe address because it should be already in L1. */
89 static inline void clear_fpu_state(struct task_struct *tsk)
90 {
91         struct xsave_struct *xstate = &tsk->thread.xstate->xsave;
92         struct i387_fxsave_struct *fx = &tsk->thread.xstate->fxsave;
93
94         /*
95          * xsave header may indicate the init state of the FP.
96          */
97         if ((task_thread_info(tsk)->status & TS_XSAVE) &&
98             !(xstate->xsave_hdr.xstate_bv & XSTATE_FP))
99                 return;
100
101         if (unlikely(fx->swd & X87_FSW_ES))
102                 asm volatile("fnclex");
103         alternative_input(ASM_NOP8 ASM_NOP2,
104                           "    emms\n"          /* clear stack tags */
105                           "    fildl %%gs:0",   /* load to clear state */
106                           X86_FEATURE_FXSAVE_LEAK);
107 }
108
109 static inline int fxsave_user(struct i387_fxsave_struct __user *fx)
110 {
111         int err;
112
113         asm volatile("1:  rex64/fxsave (%[fx])\n\t"
114                      "2:\n"
115                      ".section .fixup,\"ax\"\n"
116                      "3:  movl $-1,%[err]\n"
117                      "    jmp  2b\n"
118                      ".previous\n"
119                      _ASM_EXTABLE(1b, 3b)
120                      : [err] "=r" (err), "=m" (*fx)
121 #if 0 /* See comment in __fxsave_clear() below. */
122                      : [fx] "r" (fx), "0" (0));
123 #else
124                      : [fx] "cdaSDb" (fx), "0" (0));
125 #endif
126         if (unlikely(err) &&
127             __clear_user(fx, sizeof(struct i387_fxsave_struct)))
128                 err = -EFAULT;
129         /* No need to clear here because the caller clears USED_MATH */
130         return err;
131 }
132
133 static inline void fxsave(struct task_struct *tsk)
134 {
135         /* Using "rex64; fxsave %0" is broken because, if the memory operand
136            uses any extended registers for addressing, a second REX prefix
137            will be generated (to the assembler, rex64 followed by semicolon
138            is a separate instruction), and hence the 64-bitness is lost. */
139 #if 0
140         /* Using "fxsaveq %0" would be the ideal choice, but is only supported
141            starting with gas 2.16. */
142         __asm__ __volatile__("fxsaveq %0"
143                              : "=m" (tsk->thread.xstate->fxsave));
144 #elif 0
145         /* Using, as a workaround, the properly prefixed form below isn't
146            accepted by any binutils version so far released, complaining that
147            the same type of prefix is used twice if an extended register is
148            needed for addressing (fix submitted to mainline 2005-11-21). */
149         __asm__ __volatile__("rex64/fxsave %0"
150                              : "=m" (tsk->thread.xstate->fxsave));
151 #else
152         /* This, however, we can work around by forcing the compiler to select
153            an addressing mode that doesn't require extended registers. */
154         __asm__ __volatile__("rex64/fxsave (%1)"
155                              : "=m" (tsk->thread.xstate->fxsave)
156                              : "cdaSDb" (&tsk->thread.xstate->fxsave));
157 #endif
158 }
159
160 static inline void __save_init_fpu(struct task_struct *tsk)
161 {
162         if (task_thread_info(tsk)->status & TS_XSAVE)
163                 xsave(tsk);
164         else
165                 fxsave(tsk);
166
167         clear_fpu_state(tsk);
168         task_thread_info(tsk)->status &= ~TS_USEDFPU;
169 }
170
171 #else  /* CONFIG_X86_32 */
172
173 extern void finit(void);
174
175 static inline void tolerant_fwait(void)
176 {
177         asm volatile("fnclex ; fwait");
178 }
179
180 static inline void restore_fpu(struct task_struct *tsk)
181 {
182         if (task_thread_info(tsk)->status & TS_XSAVE) {
183                 xrstor_checking(&tsk->thread.xstate->xsave);
184                 return;
185         }
186         /*
187          * The "nop" is needed to make the instructions the same
188          * length.
189          */
190         alternative_input(
191                 "nop ; frstor %1",
192                 "fxrstor %1",
193                 X86_FEATURE_FXSR,
194                 "m" (tsk->thread.xstate->fxsave));
195 }
196
197 /* We need a safe address that is cheap to find and that is already
198    in L1 during context switch. The best choices are unfortunately
199    different for UP and SMP */
200 #ifdef CONFIG_SMP
201 #define safe_address (__per_cpu_offset[0])
202 #else
203 #define safe_address (kstat_cpu(0).cpustat.user)
204 #endif
205
206 /*
207  * These must be called with preempt disabled
208  */
209 static inline void __save_init_fpu(struct task_struct *tsk)
210 {
211         if (task_thread_info(tsk)->status & TS_XSAVE) {
212                 struct xsave_struct *xstate = &tsk->thread.xstate->xsave;
213                 struct i387_fxsave_struct *fx = &tsk->thread.xstate->fxsave;
214
215                 xsave(tsk);
216
217                 /*
218                  * xsave header may indicate the init state of the FP.
219                  */
220                 if (!(xstate->xsave_hdr.xstate_bv & XSTATE_FP))
221                         goto end;
222
223                 if (unlikely(fx->swd & X87_FSW_ES))
224                         asm volatile("fnclex");
225
226                 /*
227                  * we can do a simple return here or be paranoid :)
228                  */
229                 goto clear_state;
230         }
231
232         /* Use more nops than strictly needed in case the compiler
233            varies code */
234         alternative_input(
235                 "fnsave %[fx] ;fwait;" GENERIC_NOP8 GENERIC_NOP4,
236                 "fxsave %[fx]\n"
237                 "bt $7,%[fsw] ; jnc 1f ; fnclex\n1:",
238                 X86_FEATURE_FXSR,
239                 [fx] "m" (tsk->thread.xstate->fxsave),
240                 [fsw] "m" (tsk->thread.xstate->fxsave.swd) : "memory");
241 clear_state:
242         /* AMD K7/K8 CPUs don't save/restore FDP/FIP/FOP unless an exception
243            is pending.  Clear the x87 state here by setting it to fixed
244            values. safe_address is a random variable that should be in L1 */
245         alternative_input(
246                 GENERIC_NOP8 GENERIC_NOP2,
247                 "emms\n\t"              /* clear stack tags */
248                 "fildl %[addr]",        /* set F?P to defined value */
249                 X86_FEATURE_FXSAVE_LEAK,
250                 [addr] "m" (safe_address));
251 end:
252         task_thread_info(tsk)->status &= ~TS_USEDFPU;
253 }
254
255 #endif  /* CONFIG_X86_64 */
256
257 /*
258  * Signal frame handlers...
259  */
260 extern int save_i387_xstate(void __user *buf);
261 extern int restore_i387_xstate(void __user *buf);
262
263 static inline void __unlazy_fpu(struct task_struct *tsk)
264 {
265         if (task_thread_info(tsk)->status & TS_USEDFPU) {
266                 __save_init_fpu(tsk);
267                 stts();
268         } else
269                 tsk->fpu_counter = 0;
270 }
271
272 static inline void __clear_fpu(struct task_struct *tsk)
273 {
274         if (task_thread_info(tsk)->status & TS_USEDFPU) {
275                 tolerant_fwait();
276                 task_thread_info(tsk)->status &= ~TS_USEDFPU;
277                 stts();
278         }
279 }
280
281 static inline void kernel_fpu_begin(void)
282 {
283         struct thread_info *me = current_thread_info();
284         preempt_disable();
285         if (me->status & TS_USEDFPU)
286                 __save_init_fpu(me->task);
287         else
288                 clts();
289 }
290
291 static inline void kernel_fpu_end(void)
292 {
293         stts();
294         preempt_enable();
295 }
296
297 #ifdef CONFIG_X86_64
298
299 static inline void save_init_fpu(struct task_struct *tsk)
300 {
301         __save_init_fpu(tsk);
302         stts();
303 }
304
305 #define unlazy_fpu      __unlazy_fpu
306 #define clear_fpu       __clear_fpu
307
308 #else  /* CONFIG_X86_32 */
309
310 /*
311  * These disable preemption on their own and are safe
312  */
313 static inline void save_init_fpu(struct task_struct *tsk)
314 {
315         preempt_disable();
316         __save_init_fpu(tsk);
317         stts();
318         preempt_enable();
319 }
320
321 static inline void unlazy_fpu(struct task_struct *tsk)
322 {
323         preempt_disable();
324         __unlazy_fpu(tsk);
325         preempt_enable();
326 }
327
328 static inline void clear_fpu(struct task_struct *tsk)
329 {
330         preempt_disable();
331         __clear_fpu(tsk);
332         preempt_enable();
333 }
334
335 #endif  /* CONFIG_X86_64 */
336
337 /*
338  * i387 state interaction
339  */
340 static inline unsigned short get_fpu_cwd(struct task_struct *tsk)
341 {
342         if (cpu_has_fxsr) {
343                 return tsk->thread.xstate->fxsave.cwd;
344         } else {
345                 return (unsigned short)tsk->thread.xstate->fsave.cwd;
346         }
347 }
348
349 static inline unsigned short get_fpu_swd(struct task_struct *tsk)
350 {
351         if (cpu_has_fxsr) {
352                 return tsk->thread.xstate->fxsave.swd;
353         } else {
354                 return (unsigned short)tsk->thread.xstate->fsave.swd;
355         }
356 }
357
358 static inline unsigned short get_fpu_mxcsr(struct task_struct *tsk)
359 {
360         if (cpu_has_xmm) {
361                 return tsk->thread.xstate->fxsave.mxcsr;
362         } else {
363                 return MXCSR_DEFAULT;
364         }
365 }
366
367 #endif /* ASM_X86__I387_H */