x86/xsaves: Enable xsaves/xrstors
[linux-2.6-microblaze.git] / arch / x86 / kernel / xsave.c
1 /*
2  * xsave/xrstor support.
3  *
4  * Author: Suresh Siddha <suresh.b.siddha@intel.com>
5  */
6
7 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
8
9 #include <linux/bootmem.h>
10 #include <linux/compat.h>
11 #include <linux/cpu.h>
12 #include <asm/i387.h>
13 #include <asm/fpu-internal.h>
14 #include <asm/sigframe.h>
15 #include <asm/xcr.h>
16
17 /*
18  * Supported feature mask by the CPU and the kernel.
19  */
20 u64 pcntxt_mask;
21
22 /*
23  * Represents init state for the supported extended state.
24  */
25 struct xsave_struct *init_xstate_buf;
26
27 static struct _fpx_sw_bytes fx_sw_reserved, fx_sw_reserved_ia32;
28 static unsigned int *xstate_offsets, *xstate_sizes;
29 static unsigned int *xstate_comp_offsets, *xstate_comp_sizes;
30 static unsigned int xstate_features;
31
32 /*
33  * If a processor implementation discern that a processor state component is
34  * in its initialized state it may modify the corresponding bit in the
35  * xsave_hdr.xstate_bv as '0', with out modifying the corresponding memory
36  * layout in the case of xsaveopt. While presenting the xstate information to
37  * the user, we always ensure that the memory layout of a feature will be in
38  * the init state if the corresponding header bit is zero. This is to ensure
39  * that the user doesn't see some stale state in the memory layout during
40  * signal handling, debugging etc.
41  */
42 void __sanitize_i387_state(struct task_struct *tsk)
43 {
44         struct i387_fxsave_struct *fx = &tsk->thread.fpu.state->fxsave;
45         int feature_bit = 0x2;
46         u64 xstate_bv;
47
48         if (!fx)
49                 return;
50
51         xstate_bv = tsk->thread.fpu.state->xsave.xsave_hdr.xstate_bv;
52
53         /*
54          * None of the feature bits are in init state. So nothing else
55          * to do for us, as the memory layout is up to date.
56          */
57         if ((xstate_bv & pcntxt_mask) == pcntxt_mask)
58                 return;
59
60         /*
61          * FP is in init state
62          */
63         if (!(xstate_bv & XSTATE_FP)) {
64                 fx->cwd = 0x37f;
65                 fx->swd = 0;
66                 fx->twd = 0;
67                 fx->fop = 0;
68                 fx->rip = 0;
69                 fx->rdp = 0;
70                 memset(&fx->st_space[0], 0, 128);
71         }
72
73         /*
74          * SSE is in init state
75          */
76         if (!(xstate_bv & XSTATE_SSE))
77                 memset(&fx->xmm_space[0], 0, 256);
78
79         xstate_bv = (pcntxt_mask & ~xstate_bv) >> 2;
80
81         /*
82          * Update all the other memory layouts for which the corresponding
83          * header bit is in the init state.
84          */
85         while (xstate_bv) {
86                 if (xstate_bv & 0x1) {
87                         int offset = xstate_offsets[feature_bit];
88                         int size = xstate_sizes[feature_bit];
89
90                         memcpy(((void *) fx) + offset,
91                                ((void *) init_xstate_buf) + offset,
92                                size);
93                 }
94
95                 xstate_bv >>= 1;
96                 feature_bit++;
97         }
98 }
99
100 /*
101  * Check for the presence of extended state information in the
102  * user fpstate pointer in the sigcontext.
103  */
104 static inline int check_for_xstate(struct i387_fxsave_struct __user *buf,
105                                    void __user *fpstate,
106                                    struct _fpx_sw_bytes *fx_sw)
107 {
108         int min_xstate_size = sizeof(struct i387_fxsave_struct) +
109                               sizeof(struct xsave_hdr_struct);
110         unsigned int magic2;
111
112         if (__copy_from_user(fx_sw, &buf->sw_reserved[0], sizeof(*fx_sw)))
113                 return -1;
114
115         /* Check for the first magic field and other error scenarios. */
116         if (fx_sw->magic1 != FP_XSTATE_MAGIC1 ||
117             fx_sw->xstate_size < min_xstate_size ||
118             fx_sw->xstate_size > xstate_size ||
119             fx_sw->xstate_size > fx_sw->extended_size)
120                 return -1;
121
122         /*
123          * Check for the presence of second magic word at the end of memory
124          * layout. This detects the case where the user just copied the legacy
125          * fpstate layout with out copying the extended state information
126          * in the memory layout.
127          */
128         if (__get_user(magic2, (__u32 __user *)(fpstate + fx_sw->xstate_size))
129             || magic2 != FP_XSTATE_MAGIC2)
130                 return -1;
131
132         return 0;
133 }
134
135 /*
136  * Signal frame handlers.
137  */
138 static inline int save_fsave_header(struct task_struct *tsk, void __user *buf)
139 {
140         if (use_fxsr()) {
141                 struct xsave_struct *xsave = &tsk->thread.fpu.state->xsave;
142                 struct user_i387_ia32_struct env;
143                 struct _fpstate_ia32 __user *fp = buf;
144
145                 convert_from_fxsr(&env, tsk);
146
147                 if (__copy_to_user(buf, &env, sizeof(env)) ||
148                     __put_user(xsave->i387.swd, &fp->status) ||
149                     __put_user(X86_FXSR_MAGIC, &fp->magic))
150                         return -1;
151         } else {
152                 struct i387_fsave_struct __user *fp = buf;
153                 u32 swd;
154                 if (__get_user(swd, &fp->swd) || __put_user(swd, &fp->status))
155                         return -1;
156         }
157
158         return 0;
159 }
160
161 static inline int save_xstate_epilog(void __user *buf, int ia32_frame)
162 {
163         struct xsave_struct __user *x = buf;
164         struct _fpx_sw_bytes *sw_bytes;
165         u32 xstate_bv;
166         int err;
167
168         /* Setup the bytes not touched by the [f]xsave and reserved for SW. */
169         sw_bytes = ia32_frame ? &fx_sw_reserved_ia32 : &fx_sw_reserved;
170         err = __copy_to_user(&x->i387.sw_reserved, sw_bytes, sizeof(*sw_bytes));
171
172         if (!use_xsave())
173                 return err;
174
175         err |= __put_user(FP_XSTATE_MAGIC2, (__u32 *)(buf + xstate_size));
176
177         /*
178          * Read the xstate_bv which we copied (directly from the cpu or
179          * from the state in task struct) to the user buffers.
180          */
181         err |= __get_user(xstate_bv, (__u32 *)&x->xsave_hdr.xstate_bv);
182
183         /*
184          * For legacy compatible, we always set FP/SSE bits in the bit
185          * vector while saving the state to the user context. This will
186          * enable us capturing any changes(during sigreturn) to
187          * the FP/SSE bits by the legacy applications which don't touch
188          * xstate_bv in the xsave header.
189          *
190          * xsave aware apps can change the xstate_bv in the xsave
191          * header as well as change any contents in the memory layout.
192          * xrestore as part of sigreturn will capture all the changes.
193          */
194         xstate_bv |= XSTATE_FPSSE;
195
196         err |= __put_user(xstate_bv, (__u32 *)&x->xsave_hdr.xstate_bv);
197
198         return err;
199 }
200
201 static inline int save_user_xstate(struct xsave_struct __user *buf)
202 {
203         int err;
204
205         if (use_xsave())
206                 err = xsave_user(buf);
207         else if (use_fxsr())
208                 err = fxsave_user((struct i387_fxsave_struct __user *) buf);
209         else
210                 err = fsave_user((struct i387_fsave_struct __user *) buf);
211
212         if (unlikely(err) && __clear_user(buf, xstate_size))
213                 err = -EFAULT;
214         return err;
215 }
216
217 /*
218  * Save the fpu, extended register state to the user signal frame.
219  *
220  * 'buf_fx' is the 64-byte aligned pointer at which the [f|fx|x]save
221  *  state is copied.
222  *  'buf' points to the 'buf_fx' or to the fsave header followed by 'buf_fx'.
223  *
224  *      buf == buf_fx for 64-bit frames and 32-bit fsave frame.
225  *      buf != buf_fx for 32-bit frames with fxstate.
226  *
227  * If the fpu, extended register state is live, save the state directly
228  * to the user frame pointed by the aligned pointer 'buf_fx'. Otherwise,
229  * copy the thread's fpu state to the user frame starting at 'buf_fx'.
230  *
231  * If this is a 32-bit frame with fxstate, put a fsave header before
232  * the aligned state at 'buf_fx'.
233  *
234  * For [f]xsave state, update the SW reserved fields in the [f]xsave frame
235  * indicating the absence/presence of the extended state to the user.
236  */
237 int save_xstate_sig(void __user *buf, void __user *buf_fx, int size)
238 {
239         struct xsave_struct *xsave = &current->thread.fpu.state->xsave;
240         struct task_struct *tsk = current;
241         int ia32_fxstate = (buf != buf_fx);
242
243         ia32_fxstate &= (config_enabled(CONFIG_X86_32) ||
244                          config_enabled(CONFIG_IA32_EMULATION));
245
246         if (!access_ok(VERIFY_WRITE, buf, size))
247                 return -EACCES;
248
249         if (!static_cpu_has(X86_FEATURE_FPU))
250                 return fpregs_soft_get(current, NULL, 0,
251                         sizeof(struct user_i387_ia32_struct), NULL,
252                         (struct _fpstate_ia32 __user *) buf) ? -1 : 1;
253
254         if (user_has_fpu()) {
255                 /* Save the live register state to the user directly. */
256                 if (save_user_xstate(buf_fx))
257                         return -1;
258                 /* Update the thread's fxstate to save the fsave header. */
259                 if (ia32_fxstate)
260                         fpu_fxsave(&tsk->thread.fpu);
261         } else {
262                 sanitize_i387_state(tsk);
263                 if (__copy_to_user(buf_fx, xsave, xstate_size))
264                         return -1;
265         }
266
267         /* Save the fsave header for the 32-bit frames. */
268         if ((ia32_fxstate || !use_fxsr()) && save_fsave_header(tsk, buf))
269                 return -1;
270
271         if (use_fxsr() && save_xstate_epilog(buf_fx, ia32_fxstate))
272                 return -1;
273
274         drop_init_fpu(tsk);     /* trigger finit */
275
276         return 0;
277 }
278
279 static inline void
280 sanitize_restored_xstate(struct task_struct *tsk,
281                          struct user_i387_ia32_struct *ia32_env,
282                          u64 xstate_bv, int fx_only)
283 {
284         struct xsave_struct *xsave = &tsk->thread.fpu.state->xsave;
285         struct xsave_hdr_struct *xsave_hdr = &xsave->xsave_hdr;
286
287         if (use_xsave()) {
288                 /* These bits must be zero. */
289                 memset(xsave_hdr->reserved, 0, 48);
290
291                 /*
292                  * Init the state that is not present in the memory
293                  * layout and not enabled by the OS.
294                  */
295                 if (fx_only)
296                         xsave_hdr->xstate_bv = XSTATE_FPSSE;
297                 else
298                         xsave_hdr->xstate_bv &= (pcntxt_mask & xstate_bv);
299         }
300
301         if (use_fxsr()) {
302                 /*
303                  * mscsr reserved bits must be masked to zero for security
304                  * reasons.
305                  */
306                 xsave->i387.mxcsr &= mxcsr_feature_mask;
307
308                 convert_to_fxsr(tsk, ia32_env);
309         }
310 }
311
312 /*
313  * Restore the extended state if present. Otherwise, restore the FP/SSE state.
314  */
315 static inline int restore_user_xstate(void __user *buf, u64 xbv, int fx_only)
316 {
317         if (use_xsave()) {
318                 if ((unsigned long)buf % 64 || fx_only) {
319                         u64 init_bv = pcntxt_mask & ~XSTATE_FPSSE;
320                         xrstor_state(init_xstate_buf, init_bv);
321                         return fxrstor_user(buf);
322                 } else {
323                         u64 init_bv = pcntxt_mask & ~xbv;
324                         if (unlikely(init_bv))
325                                 xrstor_state(init_xstate_buf, init_bv);
326                         return xrestore_user(buf, xbv);
327                 }
328         } else if (use_fxsr()) {
329                 return fxrstor_user(buf);
330         } else
331                 return frstor_user(buf);
332 }
333
334 int __restore_xstate_sig(void __user *buf, void __user *buf_fx, int size)
335 {
336         int ia32_fxstate = (buf != buf_fx);
337         struct task_struct *tsk = current;
338         int state_size = xstate_size;
339         u64 xstate_bv = 0;
340         int fx_only = 0;
341
342         ia32_fxstate &= (config_enabled(CONFIG_X86_32) ||
343                          config_enabled(CONFIG_IA32_EMULATION));
344
345         if (!buf) {
346                 drop_init_fpu(tsk);
347                 return 0;
348         }
349
350         if (!access_ok(VERIFY_READ, buf, size))
351                 return -EACCES;
352
353         if (!used_math() && init_fpu(tsk))
354                 return -1;
355
356         if (!static_cpu_has(X86_FEATURE_FPU))
357                 return fpregs_soft_set(current, NULL,
358                                        0, sizeof(struct user_i387_ia32_struct),
359                                        NULL, buf) != 0;
360
361         if (use_xsave()) {
362                 struct _fpx_sw_bytes fx_sw_user;
363                 if (unlikely(check_for_xstate(buf_fx, buf_fx, &fx_sw_user))) {
364                         /*
365                          * Couldn't find the extended state information in the
366                          * memory layout. Restore just the FP/SSE and init all
367                          * the other extended state.
368                          */
369                         state_size = sizeof(struct i387_fxsave_struct);
370                         fx_only = 1;
371                 } else {
372                         state_size = fx_sw_user.xstate_size;
373                         xstate_bv = fx_sw_user.xstate_bv;
374                 }
375         }
376
377         if (ia32_fxstate) {
378                 /*
379                  * For 32-bit frames with fxstate, copy the user state to the
380                  * thread's fpu state, reconstruct fxstate from the fsave
381                  * header. Sanitize the copied state etc.
382                  */
383                 struct xsave_struct *xsave = &tsk->thread.fpu.state->xsave;
384                 struct user_i387_ia32_struct env;
385                 int err = 0;
386
387                 /*
388                  * Drop the current fpu which clears used_math(). This ensures
389                  * that any context-switch during the copy of the new state,
390                  * avoids the intermediate state from getting restored/saved.
391                  * Thus avoiding the new restored state from getting corrupted.
392                  * We will be ready to restore/save the state only after
393                  * set_used_math() is again set.
394                  */
395                 drop_fpu(tsk);
396
397                 if (__copy_from_user(xsave, buf_fx, state_size) ||
398                     __copy_from_user(&env, buf, sizeof(env))) {
399                         err = -1;
400                 } else {
401                         sanitize_restored_xstate(tsk, &env, xstate_bv, fx_only);
402                         set_used_math();
403                 }
404
405                 if (use_eager_fpu())
406                         math_state_restore();
407
408                 return err;
409         } else {
410                 /*
411                  * For 64-bit frames and 32-bit fsave frames, restore the user
412                  * state to the registers directly (with exceptions handled).
413                  */
414                 user_fpu_begin();
415                 if (restore_user_xstate(buf_fx, xstate_bv, fx_only)) {
416                         drop_init_fpu(tsk);
417                         return -1;
418                 }
419         }
420
421         return 0;
422 }
423
424 /*
425  * Prepare the SW reserved portion of the fxsave memory layout, indicating
426  * the presence of the extended state information in the memory layout
427  * pointed by the fpstate pointer in the sigcontext.
428  * This will be saved when ever the FP and extended state context is
429  * saved on the user stack during the signal handler delivery to the user.
430  */
431 static void prepare_fx_sw_frame(void)
432 {
433         int fsave_header_size = sizeof(struct i387_fsave_struct);
434         int size = xstate_size + FP_XSTATE_MAGIC2_SIZE;
435
436         if (config_enabled(CONFIG_X86_32))
437                 size += fsave_header_size;
438
439         fx_sw_reserved.magic1 = FP_XSTATE_MAGIC1;
440         fx_sw_reserved.extended_size = size;
441         fx_sw_reserved.xstate_bv = pcntxt_mask;
442         fx_sw_reserved.xstate_size = xstate_size;
443
444         if (config_enabled(CONFIG_IA32_EMULATION)) {
445                 fx_sw_reserved_ia32 = fx_sw_reserved;
446                 fx_sw_reserved_ia32.extended_size += fsave_header_size;
447         }
448 }
449
450 /*
451  * Enable the extended processor state save/restore feature
452  */
453 static inline void xstate_enable(void)
454 {
455         set_in_cr4(X86_CR4_OSXSAVE);
456         xsetbv(XCR_XFEATURE_ENABLED_MASK, pcntxt_mask);
457 }
458
459 /*
460  * Record the offsets and sizes of different state managed by the xsave
461  * memory layout.
462  */
463 static void __init setup_xstate_features(void)
464 {
465         int eax, ebx, ecx, edx, leaf = 0x2;
466
467         xstate_features = fls64(pcntxt_mask);
468         xstate_offsets = alloc_bootmem(xstate_features * sizeof(int));
469         xstate_sizes = alloc_bootmem(xstate_features * sizeof(int));
470
471         do {
472                 cpuid_count(XSTATE_CPUID, leaf, &eax, &ebx, &ecx, &edx);
473
474                 if (eax == 0)
475                         break;
476
477                 xstate_offsets[leaf] = ebx;
478                 xstate_sizes[leaf] = eax;
479
480                 leaf++;
481         } while (1);
482 }
483
484 /*
485  * setup the xstate image representing the init state
486  */
487 static void __init setup_init_fpu_buf(void)
488 {
489         /*
490          * Setup init_xstate_buf to represent the init state of
491          * all the features managed by the xsave
492          */
493         init_xstate_buf = alloc_bootmem_align(xstate_size,
494                                               __alignof__(struct xsave_struct));
495         fx_finit(&init_xstate_buf->i387);
496
497         if (!cpu_has_xsave)
498                 return;
499
500         setup_xstate_features();
501
502         if (cpu_has_xsaves) {
503                 init_xstate_buf->xsave_hdr.xcomp_bv =
504                                                 (u64)1 << 63 | pcntxt_mask;
505                 init_xstate_buf->xsave_hdr.xstate_bv = pcntxt_mask;
506         }
507
508         /*
509          * Init all the features state with header_bv being 0x0
510          */
511         xrstor_state_booting(init_xstate_buf, -1);
512         /*
513          * Dump the init state again. This is to identify the init state
514          * of any feature which is not represented by all zero's.
515          */
516         xsave_state_booting(init_xstate_buf, -1);
517 }
518
519 static enum { AUTO, ENABLE, DISABLE } eagerfpu = AUTO;
520 static int __init eager_fpu_setup(char *s)
521 {
522         if (!strcmp(s, "on"))
523                 eagerfpu = ENABLE;
524         else if (!strcmp(s, "off"))
525                 eagerfpu = DISABLE;
526         else if (!strcmp(s, "auto"))
527                 eagerfpu = AUTO;
528         return 1;
529 }
530 __setup("eagerfpu=", eager_fpu_setup);
531
532
533 /*
534  * Calculate total size of enabled xstates in XCR0/pcntxt_mask.
535  */
536 static void __init init_xstate_size(void)
537 {
538         unsigned int eax, ebx, ecx, edx;
539         int i;
540
541         if (!cpu_has_xsaves) {
542                 cpuid_count(XSTATE_CPUID, 0, &eax, &ebx, &ecx, &edx);
543                 xstate_size = ebx;
544                 return;
545         }
546
547         xstate_size = FXSAVE_SIZE + XSAVE_HDR_SIZE;
548         for (i = 2; i < 64; i++) {
549                 if (test_bit(i, (unsigned long *)&pcntxt_mask)) {
550                         cpuid_count(XSTATE_CPUID, i, &eax, &ebx, &ecx, &edx);
551                         xstate_size += eax;
552                 }
553         }
554 }
555
556 /*
557  * Enable and initialize the xsave feature.
558  */
559 static void __init xstate_enable_boot_cpu(void)
560 {
561         unsigned int eax, ebx, ecx, edx;
562
563         if (boot_cpu_data.cpuid_level < XSTATE_CPUID) {
564                 WARN(1, KERN_ERR "XSTATE_CPUID missing\n");
565                 return;
566         }
567
568         cpuid_count(XSTATE_CPUID, 0, &eax, &ebx, &ecx, &edx);
569         pcntxt_mask = eax + ((u64)edx << 32);
570
571         if ((pcntxt_mask & XSTATE_FPSSE) != XSTATE_FPSSE) {
572                 pr_err("FP/SSE not shown under xsave features 0x%llx\n",
573                        pcntxt_mask);
574                 BUG();
575         }
576
577         /*
578          * Support only the state known to OS.
579          */
580         pcntxt_mask = pcntxt_mask & XCNTXT_MASK;
581
582         xstate_enable();
583
584         /*
585          * Recompute the context size for enabled features
586          */
587         init_xstate_size();
588
589         update_regset_xstate_info(xstate_size, pcntxt_mask);
590         prepare_fx_sw_frame();
591         setup_init_fpu_buf();
592
593         /* Auto enable eagerfpu for xsaveopt */
594         if (cpu_has_xsaveopt && eagerfpu != DISABLE)
595                 eagerfpu = ENABLE;
596
597         if (pcntxt_mask & XSTATE_EAGER) {
598                 if (eagerfpu == DISABLE) {
599                         pr_err("eagerfpu not present, disabling some xstate features: 0x%llx\n",
600                                         pcntxt_mask & XSTATE_EAGER);
601                         pcntxt_mask &= ~XSTATE_EAGER;
602                 } else {
603                         eagerfpu = ENABLE;
604                 }
605         }
606
607         pr_info("enabled xstate_bv 0x%llx, cntxt size 0x%x using %s\n",
608                 pcntxt_mask, xstate_size,
609                 cpu_has_xsaves ? "compacted form" : "standard form");
610 }
611
612 /*
613  * For the very first instance, this calls xstate_enable_boot_cpu();
614  * for all subsequent instances, this calls xstate_enable().
615  *
616  * This is somewhat obfuscated due to the lack of powerful enough
617  * overrides for the section checks.
618  */
619 void xsave_init(void)
620 {
621         static __refdata void (*next_func)(void) = xstate_enable_boot_cpu;
622         void (*this_func)(void);
623
624         if (!cpu_has_xsave)
625                 return;
626
627         this_func = next_func;
628         next_func = xstate_enable;
629         this_func();
630 }
631
632 static inline void __init eager_fpu_init_bp(void)
633 {
634         current->thread.fpu.state =
635             alloc_bootmem_align(xstate_size, __alignof__(struct xsave_struct));
636         if (!init_xstate_buf)
637                 setup_init_fpu_buf();
638 }
639
640 void eager_fpu_init(void)
641 {
642         static __refdata void (*boot_func)(void) = eager_fpu_init_bp;
643
644         clear_used_math();
645         current_thread_info()->status = 0;
646
647         if (eagerfpu == ENABLE)
648                 setup_force_cpu_cap(X86_FEATURE_EAGER_FPU);
649
650         if (!cpu_has_eager_fpu) {
651                 stts();
652                 return;
653         }
654
655         if (boot_func) {
656                 boot_func();
657                 boot_func = NULL;
658         }
659
660         /*
661          * This is same as math_state_restore(). But use_xsave() is
662          * not yet patched to use math_state_restore().
663          */
664         init_fpu(current);
665         __thread_fpu_begin(current);
666         if (cpu_has_xsave)
667                 xrstor_state(init_xstate_buf, -1);
668         else
669                 fxrstor_checking(&init_xstate_buf->i387);
670 }