2 * xsave/xrstor support.
7 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
9 #include <linux/bootmem.h>
10 #include <linux/compat.h>
11 #include <linux/cpu.h>
13 #include <asm/fpu-internal.h>
14 #include <asm/sigframe.h>
15 #include <asm/tlbflush.h>
19 * Supported feature mask by the CPU and the kernel.
24 * Represents init state for the supported extended state.
26 struct xsave_struct *init_xstate_buf;
28 static struct _fpx_sw_bytes fx_sw_reserved, fx_sw_reserved_ia32;
29 static unsigned int *xstate_offsets, *xstate_sizes;
30 static unsigned int xstate_comp_offsets[sizeof(pcntxt_mask)*8];
31 static unsigned int xstate_features;
34 * If a processor implementation discern that a processor state component is
35 * in its initialized state it may modify the corresponding bit in the
36 * xsave_hdr.xstate_bv as '0', with out modifying the corresponding memory
37 * layout in the case of xsaveopt. While presenting the xstate information to
38 * the user, we always ensure that the memory layout of a feature will be in
39 * the init state if the corresponding header bit is zero. This is to ensure
40 * that the user doesn't see some stale state in the memory layout during
41 * signal handling, debugging etc.
43 void __sanitize_i387_state(struct task_struct *tsk)
45 struct i387_fxsave_struct *fx = &tsk->thread.fpu.state->fxsave;
46 int feature_bit = 0x2;
52 xstate_bv = tsk->thread.fpu.state->xsave.xsave_hdr.xstate_bv;
55 * None of the feature bits are in init state. So nothing else
56 * to do for us, as the memory layout is up to date.
58 if ((xstate_bv & pcntxt_mask) == pcntxt_mask)
64 if (!(xstate_bv & XSTATE_FP)) {
71 memset(&fx->st_space[0], 0, 128);
75 * SSE is in init state
77 if (!(xstate_bv & XSTATE_SSE))
78 memset(&fx->xmm_space[0], 0, 256);
80 xstate_bv = (pcntxt_mask & ~xstate_bv) >> 2;
83 * Update all the other memory layouts for which the corresponding
84 * header bit is in the init state.
87 if (xstate_bv & 0x1) {
88 int offset = xstate_offsets[feature_bit];
89 int size = xstate_sizes[feature_bit];
91 memcpy(((void *) fx) + offset,
92 ((void *) init_xstate_buf) + offset,
102 * Check for the presence of extended state information in the
103 * user fpstate pointer in the sigcontext.
105 static inline int check_for_xstate(struct i387_fxsave_struct __user *buf,
106 void __user *fpstate,
107 struct _fpx_sw_bytes *fx_sw)
109 int min_xstate_size = sizeof(struct i387_fxsave_struct) +
110 sizeof(struct xsave_hdr_struct);
113 if (__copy_from_user(fx_sw, &buf->sw_reserved[0], sizeof(*fx_sw)))
116 /* Check for the first magic field and other error scenarios. */
117 if (fx_sw->magic1 != FP_XSTATE_MAGIC1 ||
118 fx_sw->xstate_size < min_xstate_size ||
119 fx_sw->xstate_size > xstate_size ||
120 fx_sw->xstate_size > fx_sw->extended_size)
124 * Check for the presence of second magic word at the end of memory
125 * layout. This detects the case where the user just copied the legacy
126 * fpstate layout with out copying the extended state information
127 * in the memory layout.
129 if (__get_user(magic2, (__u32 __user *)(fpstate + fx_sw->xstate_size))
130 || magic2 != FP_XSTATE_MAGIC2)
137 * Signal frame handlers.
139 static inline int save_fsave_header(struct task_struct *tsk, void __user *buf)
142 struct xsave_struct *xsave = &tsk->thread.fpu.state->xsave;
143 struct user_i387_ia32_struct env;
144 struct _fpstate_ia32 __user *fp = buf;
146 convert_from_fxsr(&env, tsk);
148 if (__copy_to_user(buf, &env, sizeof(env)) ||
149 __put_user(xsave->i387.swd, &fp->status) ||
150 __put_user(X86_FXSR_MAGIC, &fp->magic))
153 struct i387_fsave_struct __user *fp = buf;
155 if (__get_user(swd, &fp->swd) || __put_user(swd, &fp->status))
162 static inline int save_xstate_epilog(void __user *buf, int ia32_frame)
164 struct xsave_struct __user *x = buf;
165 struct _fpx_sw_bytes *sw_bytes;
169 /* Setup the bytes not touched by the [f]xsave and reserved for SW. */
170 sw_bytes = ia32_frame ? &fx_sw_reserved_ia32 : &fx_sw_reserved;
171 err = __copy_to_user(&x->i387.sw_reserved, sw_bytes, sizeof(*sw_bytes));
176 err |= __put_user(FP_XSTATE_MAGIC2, (__u32 *)(buf + xstate_size));
179 * Read the xstate_bv which we copied (directly from the cpu or
180 * from the state in task struct) to the user buffers.
182 err |= __get_user(xstate_bv, (__u32 *)&x->xsave_hdr.xstate_bv);
185 * For legacy compatible, we always set FP/SSE bits in the bit
186 * vector while saving the state to the user context. This will
187 * enable us capturing any changes(during sigreturn) to
188 * the FP/SSE bits by the legacy applications which don't touch
189 * xstate_bv in the xsave header.
191 * xsave aware apps can change the xstate_bv in the xsave
192 * header as well as change any contents in the memory layout.
193 * xrestore as part of sigreturn will capture all the changes.
195 xstate_bv |= XSTATE_FPSSE;
197 err |= __put_user(xstate_bv, (__u32 *)&x->xsave_hdr.xstate_bv);
202 static inline int save_user_xstate(struct xsave_struct __user *buf)
207 err = xsave_user(buf);
209 err = fxsave_user((struct i387_fxsave_struct __user *) buf);
211 err = fsave_user((struct i387_fsave_struct __user *) buf);
213 if (unlikely(err) && __clear_user(buf, xstate_size))
219 * Save the fpu, extended register state to the user signal frame.
221 * 'buf_fx' is the 64-byte aligned pointer at which the [f|fx|x]save
223 * 'buf' points to the 'buf_fx' or to the fsave header followed by 'buf_fx'.
225 * buf == buf_fx for 64-bit frames and 32-bit fsave frame.
226 * buf != buf_fx for 32-bit frames with fxstate.
228 * If the fpu, extended register state is live, save the state directly
229 * to the user frame pointed by the aligned pointer 'buf_fx'. Otherwise,
230 * copy the thread's fpu state to the user frame starting at 'buf_fx'.
232 * If this is a 32-bit frame with fxstate, put a fsave header before
233 * the aligned state at 'buf_fx'.
235 * For [f]xsave state, update the SW reserved fields in the [f]xsave frame
236 * indicating the absence/presence of the extended state to the user.
238 int save_xstate_sig(void __user *buf, void __user *buf_fx, int size)
240 struct xsave_struct *xsave = ¤t->thread.fpu.state->xsave;
241 struct task_struct *tsk = current;
242 int ia32_fxstate = (buf != buf_fx);
244 ia32_fxstate &= (config_enabled(CONFIG_X86_32) ||
245 config_enabled(CONFIG_IA32_EMULATION));
247 if (!access_ok(VERIFY_WRITE, buf, size))
250 if (!static_cpu_has(X86_FEATURE_FPU))
251 return fpregs_soft_get(current, NULL, 0,
252 sizeof(struct user_i387_ia32_struct), NULL,
253 (struct _fpstate_ia32 __user *) buf) ? -1 : 1;
255 if (user_has_fpu()) {
256 /* Save the live register state to the user directly. */
257 if (save_user_xstate(buf_fx))
259 /* Update the thread's fxstate to save the fsave header. */
261 fpu_fxsave(&tsk->thread.fpu);
263 sanitize_i387_state(tsk);
264 if (__copy_to_user(buf_fx, xsave, xstate_size))
268 /* Save the fsave header for the 32-bit frames. */
269 if ((ia32_fxstate || !use_fxsr()) && save_fsave_header(tsk, buf))
272 if (use_fxsr() && save_xstate_epilog(buf_fx, ia32_fxstate))
279 sanitize_restored_xstate(struct task_struct *tsk,
280 struct user_i387_ia32_struct *ia32_env,
281 u64 xstate_bv, int fx_only)
283 struct xsave_struct *xsave = &tsk->thread.fpu.state->xsave;
284 struct xsave_hdr_struct *xsave_hdr = &xsave->xsave_hdr;
287 /* These bits must be zero. */
288 memset(xsave_hdr->reserved, 0, 48);
291 * Init the state that is not present in the memory
292 * layout and not enabled by the OS.
295 xsave_hdr->xstate_bv = XSTATE_FPSSE;
297 xsave_hdr->xstate_bv &= (pcntxt_mask & xstate_bv);
302 * mscsr reserved bits must be masked to zero for security
305 xsave->i387.mxcsr &= mxcsr_feature_mask;
307 convert_to_fxsr(tsk, ia32_env);
312 * Restore the extended state if present. Otherwise, restore the FP/SSE state.
314 static inline int restore_user_xstate(void __user *buf, u64 xbv, int fx_only)
317 if ((unsigned long)buf % 64 || fx_only) {
318 u64 init_bv = pcntxt_mask & ~XSTATE_FPSSE;
319 xrstor_state(init_xstate_buf, init_bv);
320 return fxrstor_user(buf);
322 u64 init_bv = pcntxt_mask & ~xbv;
323 if (unlikely(init_bv))
324 xrstor_state(init_xstate_buf, init_bv);
325 return xrestore_user(buf, xbv);
327 } else if (use_fxsr()) {
328 return fxrstor_user(buf);
330 return frstor_user(buf);
333 int __restore_xstate_sig(void __user *buf, void __user *buf_fx, int size)
335 int ia32_fxstate = (buf != buf_fx);
336 struct task_struct *tsk = current;
337 int state_size = xstate_size;
341 ia32_fxstate &= (config_enabled(CONFIG_X86_32) ||
342 config_enabled(CONFIG_IA32_EMULATION));
349 if (!access_ok(VERIFY_READ, buf, size))
352 if (!used_math() && init_fpu(tsk))
355 if (!static_cpu_has(X86_FEATURE_FPU))
356 return fpregs_soft_set(current, NULL,
357 0, sizeof(struct user_i387_ia32_struct),
361 struct _fpx_sw_bytes fx_sw_user;
362 if (unlikely(check_for_xstate(buf_fx, buf_fx, &fx_sw_user))) {
364 * Couldn't find the extended state information in the
365 * memory layout. Restore just the FP/SSE and init all
366 * the other extended state.
368 state_size = sizeof(struct i387_fxsave_struct);
371 state_size = fx_sw_user.xstate_size;
372 xstate_bv = fx_sw_user.xstate_bv;
378 * For 32-bit frames with fxstate, copy the user state to the
379 * thread's fpu state, reconstruct fxstate from the fsave
380 * header. Sanitize the copied state etc.
382 struct fpu *fpu = &tsk->thread.fpu;
383 struct user_i387_ia32_struct env;
387 * Drop the current fpu which clears used_math(). This ensures
388 * that any context-switch during the copy of the new state,
389 * avoids the intermediate state from getting restored/saved.
390 * Thus avoiding the new restored state from getting corrupted.
391 * We will be ready to restore/save the state only after
392 * set_used_math() is again set.
396 if (__copy_from_user(&fpu->state->xsave, buf_fx, state_size) ||
397 __copy_from_user(&env, buf, sizeof(env))) {
401 sanitize_restored_xstate(tsk, &env, xstate_bv, fx_only);
405 if (use_eager_fpu()) {
407 math_state_restore();
414 * For 64-bit frames and 32-bit fsave frames, restore the user
415 * state to the registers directly (with exceptions handled).
418 if (restore_user_xstate(buf_fx, xstate_bv, fx_only)) {
428 * Prepare the SW reserved portion of the fxsave memory layout, indicating
429 * the presence of the extended state information in the memory layout
430 * pointed by the fpstate pointer in the sigcontext.
431 * This will be saved when ever the FP and extended state context is
432 * saved on the user stack during the signal handler delivery to the user.
434 static void prepare_fx_sw_frame(void)
436 int fsave_header_size = sizeof(struct i387_fsave_struct);
437 int size = xstate_size + FP_XSTATE_MAGIC2_SIZE;
439 if (config_enabled(CONFIG_X86_32))
440 size += fsave_header_size;
442 fx_sw_reserved.magic1 = FP_XSTATE_MAGIC1;
443 fx_sw_reserved.extended_size = size;
444 fx_sw_reserved.xstate_bv = pcntxt_mask;
445 fx_sw_reserved.xstate_size = xstate_size;
447 if (config_enabled(CONFIG_IA32_EMULATION)) {
448 fx_sw_reserved_ia32 = fx_sw_reserved;
449 fx_sw_reserved_ia32.extended_size += fsave_header_size;
454 * Enable the extended processor state save/restore feature
456 static inline void xstate_enable(void)
458 cr4_set_bits(X86_CR4_OSXSAVE);
459 xsetbv(XCR_XFEATURE_ENABLED_MASK, pcntxt_mask);
463 * Record the offsets and sizes of different state managed by the xsave
466 static void __init setup_xstate_features(void)
468 int eax, ebx, ecx, edx, leaf = 0x2;
470 xstate_features = fls64(pcntxt_mask);
471 xstate_offsets = alloc_bootmem(xstate_features * sizeof(int));
472 xstate_sizes = alloc_bootmem(xstate_features * sizeof(int));
475 cpuid_count(XSTATE_CPUID, leaf, &eax, &ebx, &ecx, &edx);
480 xstate_offsets[leaf] = ebx;
481 xstate_sizes[leaf] = eax;
488 * This function sets up offsets and sizes of all extended states in
489 * xsave area. This supports both standard format and compacted format
490 * of the xsave aread.
495 void setup_xstate_comp(void)
497 unsigned int xstate_comp_sizes[sizeof(pcntxt_mask)*8];
501 * The FP xstates and SSE xstates are legacy states. They are always
502 * in the fixed offsets in the xsave area in either compacted form
505 xstate_comp_offsets[0] = 0;
506 xstate_comp_offsets[1] = offsetof(struct i387_fxsave_struct, xmm_space);
508 if (!cpu_has_xsaves) {
509 for (i = 2; i < xstate_features; i++) {
510 if (test_bit(i, (unsigned long *)&pcntxt_mask)) {
511 xstate_comp_offsets[i] = xstate_offsets[i];
512 xstate_comp_sizes[i] = xstate_sizes[i];
518 xstate_comp_offsets[2] = FXSAVE_SIZE + XSAVE_HDR_SIZE;
520 for (i = 2; i < xstate_features; i++) {
521 if (test_bit(i, (unsigned long *)&pcntxt_mask))
522 xstate_comp_sizes[i] = xstate_sizes[i];
524 xstate_comp_sizes[i] = 0;
527 xstate_comp_offsets[i] = xstate_comp_offsets[i-1]
528 + xstate_comp_sizes[i-1];
534 * setup the xstate image representing the init state
536 static void __init setup_init_fpu_buf(void)
539 * Setup init_xstate_buf to represent the init state of
540 * all the features managed by the xsave
542 init_xstate_buf = alloc_bootmem_align(xstate_size,
543 __alignof__(struct xsave_struct));
544 fx_finit(&init_xstate_buf->i387);
549 setup_xstate_features();
551 if (cpu_has_xsaves) {
552 init_xstate_buf->xsave_hdr.xcomp_bv =
553 (u64)1 << 63 | pcntxt_mask;
554 init_xstate_buf->xsave_hdr.xstate_bv = pcntxt_mask;
558 * Init all the features state with header_bv being 0x0
560 xrstor_state_booting(init_xstate_buf, -1);
562 * Dump the init state again. This is to identify the init state
563 * of any feature which is not represented by all zero's.
565 xsave_state_booting(init_xstate_buf, -1);
568 static enum { AUTO, ENABLE, DISABLE } eagerfpu = AUTO;
569 static int __init eager_fpu_setup(char *s)
571 if (!strcmp(s, "on"))
573 else if (!strcmp(s, "off"))
575 else if (!strcmp(s, "auto"))
579 __setup("eagerfpu=", eager_fpu_setup);
583 * Calculate total size of enabled xstates in XCR0/pcntxt_mask.
585 static void __init init_xstate_size(void)
587 unsigned int eax, ebx, ecx, edx;
590 if (!cpu_has_xsaves) {
591 cpuid_count(XSTATE_CPUID, 0, &eax, &ebx, &ecx, &edx);
596 xstate_size = FXSAVE_SIZE + XSAVE_HDR_SIZE;
597 for (i = 2; i < 64; i++) {
598 if (test_bit(i, (unsigned long *)&pcntxt_mask)) {
599 cpuid_count(XSTATE_CPUID, i, &eax, &ebx, &ecx, &edx);
606 * Enable and initialize the xsave feature.
608 static void __init xstate_enable_boot_cpu(void)
610 unsigned int eax, ebx, ecx, edx;
612 if (boot_cpu_data.cpuid_level < XSTATE_CPUID) {
613 WARN(1, KERN_ERR "XSTATE_CPUID missing\n");
617 cpuid_count(XSTATE_CPUID, 0, &eax, &ebx, &ecx, &edx);
618 pcntxt_mask = eax + ((u64)edx << 32);
620 if ((pcntxt_mask & XSTATE_FPSSE) != XSTATE_FPSSE) {
621 pr_err("FP/SSE not shown under xsave features 0x%llx\n",
627 * Support only the state known to OS.
629 pcntxt_mask = pcntxt_mask & XCNTXT_MASK;
634 * Recompute the context size for enabled features
638 update_regset_xstate_info(xstate_size, pcntxt_mask);
639 prepare_fx_sw_frame();
640 setup_init_fpu_buf();
642 /* Auto enable eagerfpu for xsaveopt */
643 if (cpu_has_xsaveopt && eagerfpu != DISABLE)
646 if (pcntxt_mask & XSTATE_EAGER) {
647 if (eagerfpu == DISABLE) {
648 pr_err("eagerfpu not present, disabling some xstate features: 0x%llx\n",
649 pcntxt_mask & XSTATE_EAGER);
650 pcntxt_mask &= ~XSTATE_EAGER;
656 pr_info("enabled xstate_bv 0x%llx, cntxt size 0x%x using %s\n",
657 pcntxt_mask, xstate_size,
658 cpu_has_xsaves ? "compacted form" : "standard form");
662 * For the very first instance, this calls xstate_enable_boot_cpu();
663 * for all subsequent instances, this calls xstate_enable().
665 * This is somewhat obfuscated due to the lack of powerful enough
666 * overrides for the section checks.
668 void xsave_init(void)
670 static __refdata void (*next_func)(void) = xstate_enable_boot_cpu;
671 void (*this_func)(void);
676 this_func = next_func;
677 next_func = xstate_enable;
681 static inline void __init eager_fpu_init_bp(void)
683 current->thread.fpu.state =
684 alloc_bootmem_align(xstate_size, __alignof__(struct xsave_struct));
685 if (!init_xstate_buf)
686 setup_init_fpu_buf();
689 void eager_fpu_init(void)
691 static __refdata void (*boot_func)(void) = eager_fpu_init_bp;
694 current_thread_info()->status = 0;
696 if (eagerfpu == ENABLE)
697 setup_force_cpu_cap(X86_FEATURE_EAGER_FPU);
699 if (!cpu_has_eager_fpu) {
710 * This is same as math_state_restore(). But use_xsave() is
711 * not yet patched to use math_state_restore().
714 __thread_fpu_begin(current);
716 xrstor_state(init_xstate_buf, -1);
718 fxrstor_checking(&init_xstate_buf->i387);
722 * Given the xsave area and a state inside, this function returns the
723 * address of the state.
725 * This is the API that is called to get xstate address in either
726 * standard format or compacted format of xsave area.
729 * xsave: base address of the xsave area;
730 * xstate: state which is defined in xsave.h (e.g. XSTATE_FP, XSTATE_SSE,
733 * address of the state in the xsave area.
735 void *get_xsave_addr(struct xsave_struct *xsave, int xstate)
737 int feature = fls64(xstate) - 1;
738 if (!test_bit(feature, (unsigned long *)&pcntxt_mask))
741 return (void *)xsave + xstate_comp_offsets[feature];
743 EXPORT_SYMBOL_GPL(get_xsave_addr);