2 * xsave/xrstor support.
4 * Author: Suresh Siddha <suresh.b.siddha@intel.com>
7 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
9 #include <linux/bootmem.h>
10 #include <linux/compat.h>
12 #include <asm/fpu-internal.h>
13 #include <asm/sigframe.h>
17 * Supported feature mask by the CPU and the kernel.
22 * Represents init state for the supported extended state.
24 struct xsave_struct *init_xstate_buf;
26 static struct _fpx_sw_bytes fx_sw_reserved, fx_sw_reserved_ia32;
27 static unsigned int *xstate_offsets, *xstate_sizes, xstate_features;
30 * If a processor implementation discern that a processor state component is
31 * in its initialized state it may modify the corresponding bit in the
32 * xsave_hdr.xstate_bv as '0', with out modifying the corresponding memory
33 * layout in the case of xsaveopt. While presenting the xstate information to
34 * the user, we always ensure that the memory layout of a feature will be in
35 * the init state if the corresponding header bit is zero. This is to ensure
36 * that the user doesn't see some stale state in the memory layout during
37 * signal handling, debugging etc.
39 void __sanitize_i387_state(struct task_struct *tsk)
41 struct i387_fxsave_struct *fx = &tsk->thread.fpu.state->fxsave;
42 int feature_bit = 0x2;
48 xstate_bv = tsk->thread.fpu.state->xsave.xsave_hdr.xstate_bv;
51 * None of the feature bits are in init state. So nothing else
52 * to do for us, as the memory layout is up to date.
54 if ((xstate_bv & pcntxt_mask) == pcntxt_mask)
60 if (!(xstate_bv & XSTATE_FP)) {
67 memset(&fx->st_space[0], 0, 128);
71 * SSE is in init state
73 if (!(xstate_bv & XSTATE_SSE))
74 memset(&fx->xmm_space[0], 0, 256);
76 xstate_bv = (pcntxt_mask & ~xstate_bv) >> 2;
79 * Update all the other memory layouts for which the corresponding
80 * header bit is in the init state.
83 if (xstate_bv & 0x1) {
84 int offset = xstate_offsets[feature_bit];
85 int size = xstate_sizes[feature_bit];
87 memcpy(((void *) fx) + offset,
88 ((void *) init_xstate_buf) + offset,
98 * Check for the presence of extended state information in the
99 * user fpstate pointer in the sigcontext.
101 static inline int check_for_xstate(struct i387_fxsave_struct __user *buf,
102 void __user *fpstate,
103 struct _fpx_sw_bytes *fx_sw)
105 int min_xstate_size = sizeof(struct i387_fxsave_struct) +
106 sizeof(struct xsave_hdr_struct);
109 if (__copy_from_user(fx_sw, &buf->sw_reserved[0], sizeof(*fx_sw)))
112 /* Check for the first magic field and other error scenarios. */
113 if (fx_sw->magic1 != FP_XSTATE_MAGIC1 ||
114 fx_sw->xstate_size < min_xstate_size ||
115 fx_sw->xstate_size > xstate_size ||
116 fx_sw->xstate_size > fx_sw->extended_size)
120 * Check for the presence of second magic word at the end of memory
121 * layout. This detects the case where the user just copied the legacy
122 * fpstate layout with out copying the extended state information
123 * in the memory layout.
125 if (__get_user(magic2, (__u32 __user *)(fpstate + fx_sw->xstate_size))
126 || magic2 != FP_XSTATE_MAGIC2)
133 * Signal frame handlers.
135 static inline int save_fsave_header(struct task_struct *tsk, void __user *buf)
138 struct xsave_struct *xsave = &tsk->thread.fpu.state->xsave;
139 struct user_i387_ia32_struct env;
140 struct _fpstate_ia32 __user *fp = buf;
142 convert_from_fxsr(&env, tsk);
144 if (__copy_to_user(buf, &env, sizeof(env)) ||
145 __put_user(xsave->i387.swd, &fp->status) ||
146 __put_user(X86_FXSR_MAGIC, &fp->magic))
149 struct i387_fsave_struct __user *fp = buf;
151 if (__get_user(swd, &fp->swd) || __put_user(swd, &fp->status))
158 static inline int save_xstate_epilog(void __user *buf, int ia32_frame)
160 struct xsave_struct __user *x = buf;
161 struct _fpx_sw_bytes *sw_bytes;
165 /* Setup the bytes not touched by the [f]xsave and reserved for SW. */
166 sw_bytes = ia32_frame ? &fx_sw_reserved_ia32 : &fx_sw_reserved;
167 err = __copy_to_user(&x->i387.sw_reserved, sw_bytes, sizeof(*sw_bytes));
172 err |= __put_user(FP_XSTATE_MAGIC2, (__u32 *)(buf + xstate_size));
175 * Read the xstate_bv which we copied (directly from the cpu or
176 * from the state in task struct) to the user buffers.
178 err |= __get_user(xstate_bv, (__u32 *)&x->xsave_hdr.xstate_bv);
181 * For legacy compatible, we always set FP/SSE bits in the bit
182 * vector while saving the state to the user context. This will
183 * enable us capturing any changes(during sigreturn) to
184 * the FP/SSE bits by the legacy applications which don't touch
185 * xstate_bv in the xsave header.
187 * xsave aware apps can change the xstate_bv in the xsave
188 * header as well as change any contents in the memory layout.
189 * xrestore as part of sigreturn will capture all the changes.
191 xstate_bv |= XSTATE_FPSSE;
193 err |= __put_user(xstate_bv, (__u32 *)&x->xsave_hdr.xstate_bv);
198 static inline int save_user_xstate(struct xsave_struct __user *buf)
203 err = xsave_user(buf);
205 err = fxsave_user((struct i387_fxsave_struct __user *) buf);
207 err = fsave_user((struct i387_fsave_struct __user *) buf);
209 if (unlikely(err) && __clear_user(buf, xstate_size))
215 * Save the fpu, extended register state to the user signal frame.
217 * 'buf_fx' is the 64-byte aligned pointer at which the [f|fx|x]save
219 * 'buf' points to the 'buf_fx' or to the fsave header followed by 'buf_fx'.
221 * buf == buf_fx for 64-bit frames and 32-bit fsave frame.
222 * buf != buf_fx for 32-bit frames with fxstate.
224 * If the fpu, extended register state is live, save the state directly
225 * to the user frame pointed by the aligned pointer 'buf_fx'. Otherwise,
226 * copy the thread's fpu state to the user frame starting at 'buf_fx'.
228 * If this is a 32-bit frame with fxstate, put a fsave header before
229 * the aligned state at 'buf_fx'.
231 * For [f]xsave state, update the SW reserved fields in the [f]xsave frame
232 * indicating the absence/presence of the extended state to the user.
234 int save_xstate_sig(void __user *buf, void __user *buf_fx, int size)
236 struct xsave_struct *xsave = ¤t->thread.fpu.state->xsave;
237 struct task_struct *tsk = current;
238 int ia32_fxstate = (buf != buf_fx);
240 ia32_fxstate &= (config_enabled(CONFIG_X86_32) ||
241 config_enabled(CONFIG_IA32_EMULATION));
243 if (!access_ok(VERIFY_WRITE, buf, size))
247 return fpregs_soft_get(current, NULL, 0,
248 sizeof(struct user_i387_ia32_struct), NULL,
249 (struct _fpstate_ia32 __user *) buf) ? -1 : 1;
251 if (user_has_fpu()) {
252 /* Save the live register state to the user directly. */
253 if (save_user_xstate(buf_fx))
255 /* Update the thread's fxstate to save the fsave header. */
257 fpu_fxsave(&tsk->thread.fpu);
259 sanitize_i387_state(tsk);
260 if (__copy_to_user(buf_fx, xsave, xstate_size))
264 /* Save the fsave header for the 32-bit frames. */
265 if ((ia32_fxstate || !use_fxsr()) && save_fsave_header(tsk, buf))
268 if (use_fxsr() && save_xstate_epilog(buf_fx, ia32_fxstate))
275 sanitize_restored_xstate(struct task_struct *tsk,
276 struct user_i387_ia32_struct *ia32_env,
277 u64 xstate_bv, int fx_only)
279 struct xsave_struct *xsave = &tsk->thread.fpu.state->xsave;
280 struct xsave_hdr_struct *xsave_hdr = &xsave->xsave_hdr;
283 /* These bits must be zero. */
284 xsave_hdr->reserved1[0] = xsave_hdr->reserved1[1] = 0;
287 * Init the state that is not present in the memory
288 * layout and not enabled by the OS.
291 xsave_hdr->xstate_bv = XSTATE_FPSSE;
293 xsave_hdr->xstate_bv &= (pcntxt_mask & xstate_bv);
298 * mscsr reserved bits must be masked to zero for security
301 xsave->i387.mxcsr &= mxcsr_feature_mask;
303 convert_to_fxsr(tsk, ia32_env);
308 * Restore the extended state if present. Otherwise, restore the FP/SSE state.
310 static inline int restore_user_xstate(void __user *buf, u64 xbv, int fx_only)
313 if ((unsigned long)buf % 64 || fx_only) {
314 u64 init_bv = pcntxt_mask & ~XSTATE_FPSSE;
315 xrstor_state(init_xstate_buf, init_bv);
316 return fxrstor_user(buf);
318 u64 init_bv = pcntxt_mask & ~xbv;
319 if (unlikely(init_bv))
320 xrstor_state(init_xstate_buf, init_bv);
321 return xrestore_user(buf, xbv);
323 } else if (use_fxsr()) {
324 return fxrstor_user(buf);
326 return frstor_user(buf);
329 int __restore_xstate_sig(void __user *buf, void __user *buf_fx, int size)
331 int ia32_fxstate = (buf != buf_fx);
332 struct task_struct *tsk = current;
333 int state_size = xstate_size;
337 ia32_fxstate &= (config_enabled(CONFIG_X86_32) ||
338 config_enabled(CONFIG_IA32_EMULATION));
345 if (!access_ok(VERIFY_READ, buf, size))
348 if (!used_math() && init_fpu(tsk))
352 return fpregs_soft_set(current, NULL,
353 0, sizeof(struct user_i387_ia32_struct),
358 struct _fpx_sw_bytes fx_sw_user;
359 if (unlikely(check_for_xstate(buf_fx, buf_fx, &fx_sw_user))) {
361 * Couldn't find the extended state information in the
362 * memory layout. Restore just the FP/SSE and init all
363 * the other extended state.
365 state_size = sizeof(struct i387_fxsave_struct);
368 state_size = fx_sw_user.xstate_size;
369 xstate_bv = fx_sw_user.xstate_bv;
375 * For 32-bit frames with fxstate, copy the user state to the
376 * thread's fpu state, reconstruct fxstate from the fsave
377 * header. Sanitize the copied state etc.
379 struct xsave_struct *xsave = &tsk->thread.fpu.state->xsave;
380 struct user_i387_ia32_struct env;
384 * Drop the current fpu which clears used_math(). This ensures
385 * that any context-switch during the copy of the new state,
386 * avoids the intermediate state from getting restored/saved.
387 * Thus avoiding the new restored state from getting corrupted.
388 * We will be ready to restore/save the state only after
389 * set_used_math() is again set.
393 if (__copy_from_user(xsave, buf_fx, state_size) ||
394 __copy_from_user(&env, buf, sizeof(env))) {
397 sanitize_restored_xstate(tsk, &env, xstate_bv, fx_only);
401 if (use_eager_fpu()) {
403 math_state_restore();
410 * For 64-bit frames and 32-bit fsave frames, restore the user
411 * state to the registers directly (with exceptions handled).
414 if (restore_user_xstate(buf_fx, xstate_bv, fx_only)) {
424 * Prepare the SW reserved portion of the fxsave memory layout, indicating
425 * the presence of the extended state information in the memory layout
426 * pointed by the fpstate pointer in the sigcontext.
427 * This will be saved when ever the FP and extended state context is
428 * saved on the user stack during the signal handler delivery to the user.
430 static void prepare_fx_sw_frame(void)
432 int fsave_header_size = sizeof(struct i387_fsave_struct);
433 int size = xstate_size + FP_XSTATE_MAGIC2_SIZE;
435 if (config_enabled(CONFIG_X86_32))
436 size += fsave_header_size;
438 fx_sw_reserved.magic1 = FP_XSTATE_MAGIC1;
439 fx_sw_reserved.extended_size = size;
440 fx_sw_reserved.xstate_bv = pcntxt_mask;
441 fx_sw_reserved.xstate_size = xstate_size;
443 if (config_enabled(CONFIG_IA32_EMULATION)) {
444 fx_sw_reserved_ia32 = fx_sw_reserved;
445 fx_sw_reserved_ia32.extended_size += fsave_header_size;
450 * Enable the extended processor state save/restore feature
452 static inline void xstate_enable(void)
454 set_in_cr4(X86_CR4_OSXSAVE);
455 xsetbv(XCR_XFEATURE_ENABLED_MASK, pcntxt_mask);
459 * Record the offsets and sizes of different state managed by the xsave
462 static void __init setup_xstate_features(void)
464 int eax, ebx, ecx, edx, leaf = 0x2;
466 xstate_features = fls64(pcntxt_mask);
467 xstate_offsets = alloc_bootmem(xstate_features * sizeof(int));
468 xstate_sizes = alloc_bootmem(xstate_features * sizeof(int));
471 cpuid_count(XSTATE_CPUID, leaf, &eax, &ebx, &ecx, &edx);
476 xstate_offsets[leaf] = ebx;
477 xstate_sizes[leaf] = eax;
484 * setup the xstate image representing the init state
486 static void __init setup_init_fpu_buf(void)
489 * Setup init_xstate_buf to represent the init state of
490 * all the features managed by the xsave
492 init_xstate_buf = alloc_bootmem_align(xstate_size,
493 __alignof__(struct xsave_struct));
494 fx_finit(&init_xstate_buf->i387);
499 setup_xstate_features();
502 * Init all the features state with header_bv being 0x0
504 xrstor_state(init_xstate_buf, -1);
506 * Dump the init state again. This is to identify the init state
507 * of any feature which is not represented by all zero's.
509 xsave_state(init_xstate_buf, -1);
512 static enum { AUTO, ENABLE, DISABLE } eagerfpu = AUTO;
513 static int __init eager_fpu_setup(char *s)
515 if (!strcmp(s, "on"))
517 else if (!strcmp(s, "off"))
519 else if (!strcmp(s, "auto"))
523 __setup("eagerfpu=", eager_fpu_setup);
526 * Enable and initialize the xsave feature.
528 static void __init xstate_enable_boot_cpu(void)
530 unsigned int eax, ebx, ecx, edx;
532 if (boot_cpu_data.cpuid_level < XSTATE_CPUID) {
533 WARN(1, KERN_ERR "XSTATE_CPUID missing\n");
537 cpuid_count(XSTATE_CPUID, 0, &eax, &ebx, &ecx, &edx);
538 pcntxt_mask = eax + ((u64)edx << 32);
540 if ((pcntxt_mask & XSTATE_FPSSE) != XSTATE_FPSSE) {
541 pr_err("FP/SSE not shown under xsave features 0x%llx\n",
547 * Support only the state known to OS.
549 pcntxt_mask = pcntxt_mask & XCNTXT_MASK;
554 * Recompute the context size for enabled features
556 cpuid_count(XSTATE_CPUID, 0, &eax, &ebx, &ecx, &edx);
559 update_regset_xstate_info(xstate_size, pcntxt_mask);
560 prepare_fx_sw_frame();
561 setup_init_fpu_buf();
563 /* Auto enable eagerfpu for xsaveopt */
564 if (cpu_has_xsaveopt && eagerfpu != DISABLE)
567 pr_info("enabled xstate_bv 0x%llx, cntxt size 0x%x\n",
568 pcntxt_mask, xstate_size);
572 * For the very first instance, this calls xstate_enable_boot_cpu();
573 * for all subsequent instances, this calls xstate_enable().
575 * This is somewhat obfuscated due to the lack of powerful enough
576 * overrides for the section checks.
578 void __cpuinit xsave_init(void)
580 static __refdata void (*next_func)(void) = xstate_enable_boot_cpu;
581 void (*this_func)(void);
586 this_func = next_func;
587 next_func = xstate_enable;
591 static inline void __init eager_fpu_init_bp(void)
593 current->thread.fpu.state =
594 alloc_bootmem_align(xstate_size, __alignof__(struct xsave_struct));
595 if (!init_xstate_buf)
596 setup_init_fpu_buf();
599 void __cpuinit eager_fpu_init(void)
601 static __refdata void (*boot_func)(void) = eager_fpu_init_bp;
604 current_thread_info()->status = 0;
606 if (eagerfpu == ENABLE)
607 setup_force_cpu_cap(X86_FEATURE_EAGER_FPU);
609 if (!cpu_has_eager_fpu) {
620 * This is same as math_state_restore(). But use_xsave() is
621 * not yet patched to use math_state_restore().
624 __thread_fpu_begin(current);
626 xrstor_state(init_xstate_buf, -1);
628 fxrstor_checking(&init_xstate_buf->i387);