arch/x86/include/asm/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 #ifndef __ASSEMBLY__
  14
  15 #include <linux/sched.h>
  16 #include <linux/kernel_stat.h>
  17 #include <linux/regset.h>
  18 #include <linux/hardirq.h>
  19 #include <linux/slab.h>
  20 #include <asm/asm.h>
  21 #include <asm/cpufeature.h>
  22 #include <asm/processor.h>
  23 #include <asm/sigcontext.h>
  24 #include <asm/user.h>
  25 #include <asm/uaccess.h>
  26 #include <asm/xsave.h>
  27
  28 extern unsigned int sig_xstate_size;
  29 extern void fpu_init(void);
  30 extern void mxcsr_feature_mask_init(void);
  31 extern int init_fpu(struct task_struct *child);
  32 extern asmlinkage void math_state_restore(void);
  33 extern void __math_state_restore(void);
  34 extern int dump_fpu(struct pt_regs *, struct user_i387_struct *);
  35
  36 extern user_regset_active_fn fpregs_active, xfpregs_active;
  37 extern user_regset_get_fn fpregs_get, xfpregs_get, fpregs_soft_get,
  38                                 xstateregs_get;
  39 extern user_regset_set_fn fpregs_set, xfpregs_set, fpregs_soft_set,
  40                                  xstateregs_set;
  41
  42 /*
  43  * xstateregs_active == fpregs_active. Please refer to the comment
  44  * at the definition of fpregs_active.
  45  */
  46 #define xstateregs_active       fpregs_active
  47
  48 extern struct _fpx_sw_bytes fx_sw_reserved;
  49 #ifdef CONFIG_IA32_EMULATION
  50 extern unsigned int sig_xstate_ia32_size;
  51 extern struct _fpx_sw_bytes fx_sw_reserved_ia32;
  52 struct _fpstate_ia32;
  53 struct _xstate_ia32;
  54 extern int save_i387_xstate_ia32(void __user *buf);
  55 extern int restore_i387_xstate_ia32(void __user *buf);
  56 #endif
  57
  58 #define X87_FSW_ES (1 << 7)     /* Exception Summary */
  59
  60 static __always_inline __pure bool use_xsaveopt(void)
  61 {
  62         return static_cpu_has(X86_FEATURE_XSAVEOPT);
  63 }
  64
  65 static __always_inline __pure bool use_xsave(void)
  66 {
  67         return static_cpu_has(X86_FEATURE_XSAVE);
  68 }
  69
  70 extern void __sanitize_i387_state(struct task_struct *);
  71
  72 static inline void sanitize_i387_state(struct task_struct *tsk)
  73 {
  74         if (!use_xsaveopt())
  75                 return;
  76         __sanitize_i387_state(tsk);
  77 }
  78
  79 #ifdef CONFIG_X86_64
  80 static inline int fxrstor_checking(struct i387_fxsave_struct *fx)
  81 {
  82         int err;
  83
  84         asm volatile("1:  rex64/fxrstor (%[fx])\n\t"
  85                      "2:\n"
  86                      ".section .fixup,\"ax\"\n"
  87                      "3:  movl $-1,%[err]\n"
  88                      "    jmp  2b\n"
  89                      ".previous\n"
  90                      _ASM_EXTABLE(1b, 3b)
  91                      : [err] "=r" (err)
  92 #if 0 /* See comment in fxsave() below. */
  93                      : [fx] "r" (fx), "m" (*fx), "0" (0));
  94 #else
  95                      : [fx] "cdaSDb" (fx), "m" (*fx), "0" (0));
  96 #endif
  97         return err;
  98 }
  99
 100 /* AMD CPUs don't save/restore FDP/FIP/FOP unless an exception
 101    is pending. Clear the x87 state here by setting it to fixed
 102    values. The kernel data segment can be sometimes 0 and sometimes
 103    new user value. Both should be ok.
 104    Use the PDA as safe address because it should be already in L1. */
 105 static inline void fpu_clear(struct fpu *fpu)
 106 {
 107         struct xsave_struct *xstate = &fpu->state->xsave;
 108         struct i387_fxsave_struct *fx = &fpu->state->fxsave;
 109
 110         /*
 111          * xsave header may indicate the init state of the FP.
 112          */
 113         if (use_xsave() &&
 114             !(xstate->xsave_hdr.xstate_bv & XSTATE_FP))
 115                 return;
 116
 117         if (unlikely(fx->swd & X87_FSW_ES))
 118                 asm volatile("fnclex");
 119         alternative_input(ASM_NOP8 ASM_NOP2,
 120                           "    emms\n"          /* clear stack tags */
 121                           "    fildl %%gs:0",   /* load to clear state */
 122                           X86_FEATURE_FXSAVE_LEAK);
 123 }
 124
 125 static inline void clear_fpu_state(struct task_struct *tsk)
 126 {
 127         fpu_clear(&tsk->thread.fpu);
 128 }
 129
 130 static inline int fxsave_user(struct i387_fxsave_struct __user *fx)
 131 {
 132         int err;
 133
 134         /*
 135          * Clear the bytes not touched by the fxsave and reserved
 136          * for the SW usage.
 137          */
 138         err = __clear_user(&fx->sw_reserved,
 139                            sizeof(struct _fpx_sw_bytes));
 140         if (unlikely(err))
 141                 return -EFAULT;
 142
 143         asm volatile("1:  rex64/fxsave (%[fx])\n\t"
 144                      "2:\n"
 145                      ".section .fixup,\"ax\"\n"
 146                      "3:  movl $-1,%[err]\n"
 147                      "    jmp  2b\n"
 148                      ".previous\n"
 149                      _ASM_EXTABLE(1b, 3b)
 150                      : [err] "=r" (err), "=m" (*fx)
 151 #if 0 /* See comment in fxsave() below. */
 152                      : [fx] "r" (fx), "0" (0));
 153 #else
 154                      : [fx] "cdaSDb" (fx), "0" (0));
 155 #endif
 156         if (unlikely(err) &&
 157             __clear_user(fx, sizeof(struct i387_fxsave_struct)))
 158                 err = -EFAULT;
 159         /* No need to clear here because the caller clears USED_MATH */
 160         return err;
 161 }
 162
 163 static inline void fpu_fxsave(struct fpu *fpu)
 164 {
 165         /* Using "rex64; fxsave %0" is broken because, if the memory operand
 166            uses any extended registers for addressing, a second REX prefix
 167            will be generated (to the assembler, rex64 followed by semicolon
 168            is a separate instruction), and hence the 64-bitness is lost. */
 169 #if 0
 170         /* Using "fxsaveq %0" would be the ideal choice, but is only supported
 171            starting with gas 2.16. */
 172         __asm__ __volatile__("fxsaveq %0"
 173                              : "=m" (fpu->state->fxsave));
 174 #elif 0
 175         /* Using, as a workaround, the properly prefixed form below isn't
 176            accepted by any binutils version so far released, complaining that
 177            the same type of prefix is used twice if an extended register is
 178            needed for addressing (fix submitted to mainline 2005-11-21). */
 179         __asm__ __volatile__("rex64/fxsave %0"
 180                              : "=m" (fpu->state->fxsave));
 181 #else
 182         /* This, however, we can work around by forcing the compiler to select
 183            an addressing mode that doesn't require extended registers. */
 184         __asm__ __volatile__("rex64/fxsave (%1)"
 185                              : "=m" (fpu->state->fxsave)
 186                              : "cdaSDb" (&fpu->state->fxsave));
 187 #endif
 188 }
 189
 190 static inline void fpu_save_init(struct fpu *fpu)
 191 {
 192         if (use_xsave())
 193                 fpu_xsave(fpu);
 194         else
 195                 fpu_fxsave(fpu);
 196
 197         fpu_clear(fpu);
 198 }
 199
 200 #else  /* CONFIG_X86_32 */
 201
 202 #ifdef CONFIG_MATH_EMULATION
 203 extern void finit_soft_fpu(struct i387_soft_struct *soft);
 204 #else
 205 static inline void finit_soft_fpu(struct i387_soft_struct *soft) {}
 206 #endif
 207
 208 /* perform fxrstor iff the processor has extended states, otherwise frstor */
 209 static inline int fxrstor_checking(struct i387_fxsave_struct *fx)
 210 {
 211         /*
 212          * The "nop" is needed to make the instructions the same
 213          * length.
 214          */
 215         alternative_input(
 216                 "nop ; frstor %1",
 217                 "fxrstor %1",
 218                 X86_FEATURE_FXSR,
 219                 "m" (*fx));
 220
 221         return 0;
 222 }
 223
 224 /* We need a safe address that is cheap to find and that is already
 225    in L1 during context switch. The best choices are unfortunately
 226    different for UP and SMP */
 227 #ifdef CONFIG_SMP
 228 #define safe_address (__per_cpu_offset[0])
 229 #else
 230 #define safe_address (kstat_cpu(0).cpustat.user)
 231 #endif
 232
 233 /*
 234  * These must be called with preempt disabled
 235  */
 236 static inline void fpu_save_init(struct fpu *fpu)
 237 {
 238         if (use_xsave()) {
 239                 struct xsave_struct *xstate = &fpu->state->xsave;
 240                 struct i387_fxsave_struct *fx = &fpu->state->fxsave;
 241
 242                 fpu_xsave(fpu);
 243
 244                 /*
 245                  * xsave header may indicate the init state of the FP.
 246                  */
 247                 if (!(xstate->xsave_hdr.xstate_bv & XSTATE_FP))
 248                         goto end;
 249
 250                 if (unlikely(fx->swd & X87_FSW_ES))
 251                         asm volatile("fnclex");
 252
 253                 /*
 254                  * we can do a simple return here or be paranoid :)
 255                  */
 256                 goto clear_state;
 257         }
 258
 259         /* Use more nops than strictly needed in case the compiler
 260            varies code */
 261         alternative_input(
 262                 "fnsave %[fx] ;fwait;" GENERIC_NOP8 GENERIC_NOP4,
 263                 "fxsave %[fx]\n"
 264                 "bt $7,%[fsw] ; jnc 1f ; fnclex\n1:",
 265                 X86_FEATURE_FXSR,
 266                 [fx] "m" (fpu->state->fxsave),
 267                 [fsw] "m" (fpu->state->fxsave.swd) : "memory");
 268 clear_state:
 269         /* AMD K7/K8 CPUs don't save/restore FDP/FIP/FOP unless an exception
 270            is pending.  Clear the x87 state here by setting it to fixed
 271            values. safe_address is a random variable that should be in L1 */
 272         alternative_input(
 273                 GENERIC_NOP8 GENERIC_NOP2,
 274                 "emms\n\t"              /* clear stack tags */
 275                 "fildl %[addr]",        /* set F?P to defined value */
 276                 X86_FEATURE_FXSAVE_LEAK,
 277                 [addr] "m" (safe_address));
 278 end:
 279         ;
 280 }
 281
 282 #endif  /* CONFIG_X86_64 */
 283
 284 static inline void __save_init_fpu(struct task_struct *tsk)
 285 {
 286         fpu_save_init(&tsk->thread.fpu);
 287         task_thread_info(tsk)->status &= ~TS_USEDFPU;
 288 }
 289
 290 static inline int fpu_fxrstor_checking(struct fpu *fpu)
 291 {
 292         return fxrstor_checking(&fpu->state->fxsave);
 293 }
 294
 295 static inline int fpu_restore_checking(struct fpu *fpu)
 296 {
 297         if (use_xsave())
 298                 return fpu_xrstor_checking(fpu);
 299         else
 300                 return fpu_fxrstor_checking(fpu);
 301 }
 302
 303 static inline int restore_fpu_checking(struct task_struct *tsk)
 304 {
 305         return fpu_restore_checking(&tsk->thread.fpu);
 306 }
 307
 308 /*
 309  * Signal frame handlers...
 310  */
 311 extern int save_i387_xstate(void __user *buf);
 312 extern int restore_i387_xstate(void __user *buf);
 313
 314 static inline void __unlazy_fpu(struct task_struct *tsk)
 315 {
 316         if (task_thread_info(tsk)->status & TS_USEDFPU) {
 317                 __save_init_fpu(tsk);
 318                 stts();
 319         } else
 320                 tsk->fpu_counter = 0;
 321 }
 322
 323 static inline void __clear_fpu(struct task_struct *tsk)
 324 {
 325         if (task_thread_info(tsk)->status & TS_USEDFPU) {
 326                 /* Ignore delayed exceptions from user space */
 327                 asm volatile("1: fwait\n"
 328                              "2:\n"
 329                              _ASM_EXTABLE(1b, 2b));
 330                 task_thread_info(tsk)->status &= ~TS_USEDFPU;
 331                 stts();
 332         }
 333 }
 334
 335 static inline void kernel_fpu_begin(void)
 336 {
 337         struct thread_info *me = current_thread_info();
 338         preempt_disable();
 339         if (me->status & TS_USEDFPU)
 340                 __save_init_fpu(me->task);
 341         else
 342                 clts();
 343 }
 344
 345 static inline void kernel_fpu_end(void)
 346 {
 347         stts();
 348         preempt_enable();
 349 }
 350
 351 static inline bool irq_fpu_usable(void)
 352 {
 353         struct pt_regs *regs;
 354
 355         return !in_interrupt() || !(regs = get_irq_regs()) || \
 356                 user_mode(regs) || (read_cr0() & X86_CR0_TS);
 357 }
 358
 359 /*
 360  * Some instructions like VIA's padlock instructions generate a spurious
 361  * DNA fault but don't modify SSE registers. And these instructions
 362  * get used from interrupt context as well. To prevent these kernel instructions
 363  * in interrupt context interacting wrongly with other user/kernel fpu usage, we
 364  * should use them only in the context of irq_ts_save/restore()
 365  */
 366 static inline int irq_ts_save(void)
 367 {
 368         /*
 369          * If in process context and not atomic, we can take a spurious DNA fault.
 370          * Otherwise, doing clts() in process context requires disabling preemption
 371          * or some heavy lifting like kernel_fpu_begin()
 372          */
 373         if (!in_atomic())
 374                 return 0;
 375
 376         if (read_cr0() & X86_CR0_TS) {
 377                 clts();
 378                 return 1;
 379         }
 380
 381         return 0;
 382 }
 383
 384 static inline void irq_ts_restore(int TS_state)
 385 {
 386         if (TS_state)
 387                 stts();
 388 }
 389
 390 /*
 391  * These disable preemption on their own and are safe
 392  */
 393 static inline void save_init_fpu(struct task_struct *tsk)
 394 {
 395         preempt_disable();
 396         __save_init_fpu(tsk);
 397         stts();
 398         preempt_enable();
 399 }
 400
 401 static inline void unlazy_fpu(struct task_struct *tsk)
 402 {
 403         preempt_disable();
 404         __unlazy_fpu(tsk);
 405         preempt_enable();
 406 }
 407
 408 static inline void clear_fpu(struct task_struct *tsk)
 409 {
 410         preempt_disable();
 411         __clear_fpu(tsk);
 412         preempt_enable();
 413 }
 414
 415 /*
 416  * i387 state interaction
 417  */
 418 static inline unsigned short get_fpu_cwd(struct task_struct *tsk)
 419 {
 420         if (cpu_has_fxsr) {
 421                 return tsk->thread.fpu.state->fxsave.cwd;
 422         } else {
 423                 return (unsigned short)tsk->thread.fpu.state->fsave.cwd;
 424         }
 425 }
 426
 427 static inline unsigned short get_fpu_swd(struct task_struct *tsk)
 428 {
 429         if (cpu_has_fxsr) {
 430                 return tsk->thread.fpu.state->fxsave.swd;
 431         } else {
 432                 return (unsigned short)tsk->thread.fpu.state->fsave.swd;
 433         }
 434 }
 435
 436 static inline unsigned short get_fpu_mxcsr(struct task_struct *tsk)
 437 {
 438         if (cpu_has_xmm) {
 439                 return tsk->thread.fpu.state->fxsave.mxcsr;
 440         } else {
 441                 return MXCSR_DEFAULT;
 442         }
 443 }
 444
 445 static bool fpu_allocated(struct fpu *fpu)
 446 {
 447         return fpu->state != NULL;
 448 }
 449
 450 static inline int fpu_alloc(struct fpu *fpu)
 451 {
 452         if (fpu_allocated(fpu))
 453                 return 0;
 454         fpu->state = kmem_cache_alloc(task_xstate_cachep, GFP_KERNEL);
 455         if (!fpu->state)
 456                 return -ENOMEM;
 457         WARN_ON((unsigned long)fpu->state & 15);
 458         return 0;
 459 }
 460
 461 static inline void fpu_free(struct fpu *fpu)
 462 {
 463         if (fpu->state) {
 464                 kmem_cache_free(task_xstate_cachep, fpu->state);
 465                 fpu->state = NULL;
 466         }
 467 }
 468
 469 static inline void fpu_copy(struct fpu *dst, struct fpu *src)
 470 {
 471         memcpy(dst->state, src->state, xstate_size);
 472 }
 473
 474 extern void fpu_finit(struct fpu *fpu);
 475
 476 #endif /* __ASSEMBLY__ */
 477
 478 #define PSHUFB_XMM5_XMM0 .byte 0x66, 0x0f, 0x38, 0x00, 0xc5
 479 #define PSHUFB_XMM5_XMM6 .byte 0x66, 0x0f, 0x38, 0x00, 0xf5
 480
 481 #endif /* _ASM_X86_I387_H */