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 void math_state_restore(void);
  33 extern int dump_fpu(struct pt_regs *, struct user_i387_struct *);
  34
  35 extern user_regset_active_fn fpregs_active, xfpregs_active;
  36 extern user_regset_get_fn fpregs_get, xfpregs_get, fpregs_soft_get,
  37                                 xstateregs_get;
  38 extern user_regset_set_fn fpregs_set, xfpregs_set, fpregs_soft_set,
  39                                  xstateregs_set;
  40
  41 /*
  42  * xstateregs_active == fpregs_active. Please refer to the comment
  43  * at the definition of fpregs_active.
  44  */
  45 #define xstateregs_active       fpregs_active
  46
  47 extern struct _fpx_sw_bytes fx_sw_reserved;
  48 #ifdef CONFIG_IA32_EMULATION
  49 extern unsigned int sig_xstate_ia32_size;
  50 extern struct _fpx_sw_bytes fx_sw_reserved_ia32;
  51 struct _fpstate_ia32;
  52 struct _xstate_ia32;
  53 extern int save_i387_xstate_ia32(void __user *buf);
  54 extern int restore_i387_xstate_ia32(void __user *buf);
  55 #endif
  56
  57 #ifdef CONFIG_MATH_EMULATION
  58 extern void finit_soft_fpu(struct i387_soft_struct *soft);
  59 #else
  60 static inline void finit_soft_fpu(struct i387_soft_struct *soft) {}
  61 #endif
  62
  63 #define X87_FSW_ES (1 << 7)     /* Exception Summary */
  64
  65 static __always_inline __pure bool use_xsaveopt(void)
  66 {
  67         return static_cpu_has(X86_FEATURE_XSAVEOPT);
  68 }
  69
  70 static __always_inline __pure bool use_xsave(void)
  71 {
  72         return static_cpu_has(X86_FEATURE_XSAVE);
  73 }
  74
  75 static __always_inline __pure bool use_fxsr(void)
  76 {
  77         return static_cpu_has(X86_FEATURE_FXSR);
  78 }
  79
  80 extern void __sanitize_i387_state(struct task_struct *);
  81
  82 static inline void sanitize_i387_state(struct task_struct *tsk)
  83 {
  84         if (!use_xsaveopt())
  85                 return;
  86         __sanitize_i387_state(tsk);
  87 }
  88
  89 #ifdef CONFIG_X86_64
  90 static inline int fxrstor_checking(struct i387_fxsave_struct *fx)
  91 {
  92         int err;
  93
  94         /* See comment in fxsave() below. */
  95 #ifdef CONFIG_AS_FXSAVEQ
  96         asm volatile("1:  fxrstorq %[fx]\n\t"
  97                      "2:\n"
  98                      ".section .fixup,\"ax\"\n"
  99                      "3:  movl $-1,%[err]\n"
 100                      "    jmp  2b\n"
 101                      ".previous\n"
 102                      _ASM_EXTABLE(1b, 3b)
 103                      : [err] "=r" (err)
 104                      : [fx] "m" (*fx), "0" (0));
 105 #else
 106         asm volatile("1:  rex64/fxrstor (%[fx])\n\t"
 107                      "2:\n"
 108                      ".section .fixup,\"ax\"\n"
 109                      "3:  movl $-1,%[err]\n"
 110                      "    jmp  2b\n"
 111                      ".previous\n"
 112                      _ASM_EXTABLE(1b, 3b)
 113                      : [err] "=r" (err)
 114                      : [fx] "R" (fx), "m" (*fx), "0" (0));
 115 #endif
 116         return err;
 117 }
 118
 119 static inline int fxsave_user(struct i387_fxsave_struct __user *fx)
 120 {
 121         int err;
 122
 123         /*
 124          * Clear the bytes not touched by the fxsave and reserved
 125          * for the SW usage.
 126          */
 127         err = __clear_user(&fx->sw_reserved,
 128                            sizeof(struct _fpx_sw_bytes));
 129         if (unlikely(err))
 130                 return -EFAULT;
 131
 132         /* See comment in fxsave() below. */
 133 #ifdef CONFIG_AS_FXSAVEQ
 134         asm volatile("1:  fxsaveq %[fx]\n\t"
 135                      "2:\n"
 136                      ".section .fixup,\"ax\"\n"
 137                      "3:  movl $-1,%[err]\n"
 138                      "    jmp  2b\n"
 139                      ".previous\n"
 140                      _ASM_EXTABLE(1b, 3b)
 141                      : [err] "=r" (err), [fx] "=m" (*fx)
 142                      : "0" (0));
 143 #else
 144         asm volatile("1:  rex64/fxsave (%[fx])\n\t"
 145                      "2:\n"
 146                      ".section .fixup,\"ax\"\n"
 147                      "3:  movl $-1,%[err]\n"
 148                      "    jmp  2b\n"
 149                      ".previous\n"
 150                      _ASM_EXTABLE(1b, 3b)
 151                      : [err] "=r" (err), "=m" (*fx)
 152                      : [fx] "R" (fx), "0" (0));
 153 #endif
 154         if (unlikely(err) &&
 155             __clear_user(fx, sizeof(struct i387_fxsave_struct)))
 156                 err = -EFAULT;
 157         /* No need to clear here because the caller clears USED_MATH */
 158         return err;
 159 }
 160
 161 static inline void fpu_fxsave(struct fpu *fpu)
 162 {
 163         /* Using "rex64; fxsave %0" is broken because, if the memory operand
 164            uses any extended registers for addressing, a second REX prefix
 165            will be generated (to the assembler, rex64 followed by semicolon
 166            is a separate instruction), and hence the 64-bitness is lost. */
 167
 168 #ifdef CONFIG_AS_FXSAVEQ
 169         /* Using "fxsaveq %0" would be the ideal choice, but is only supported
 170            starting with gas 2.16. */
 171         __asm__ __volatile__("fxsaveq %0"
 172                              : "=m" (fpu->state->fxsave));
 173 #else
 174         /* Using, as a workaround, the properly prefixed form below isn't
 175            accepted by any binutils version so far released, complaining that
 176            the same type of prefix is used twice if an extended register is
 177            needed for addressing (fix submitted to mainline 2005-11-21).
 178         asm volatile("rex64/fxsave %0"
 179                      : "=m" (fpu->state->fxsave));
 180            This, however, we can work around by forcing the compiler to select
 181            an addressing mode that doesn't require extended registers. */
 182         asm volatile("rex64/fxsave (%[fx])"
 183                      : "=m" (fpu->state->fxsave)
 184                      : [fx] "R" (&fpu->state->fxsave));
 185 #endif
 186 }
 187
 188 #else  /* CONFIG_X86_32 */
 189
 190 /* perform fxrstor iff the processor has extended states, otherwise frstor */
 191 static inline int fxrstor_checking(struct i387_fxsave_struct *fx)
 192 {
 193         /*
 194          * The "nop" is needed to make the instructions the same
 195          * length.
 196          */
 197         alternative_input(
 198                 "nop ; frstor %1",
 199                 "fxrstor %1",
 200                 X86_FEATURE_FXSR,
 201                 "m" (*fx));
 202
 203         return 0;
 204 }
 205
 206 static inline void fpu_fxsave(struct fpu *fpu)
 207 {
 208         asm volatile("fxsave %[fx]"
 209                      : [fx] "=m" (fpu->state->fxsave));
 210 }
 211
 212 #endif  /* CONFIG_X86_64 */
 213
 214 /* We need a safe address that is cheap to find and that is already
 215    in L1 during context switch. The best choices are unfortunately
 216    different for UP and SMP */
 217 #ifdef CONFIG_SMP
 218 #define safe_address (__per_cpu_offset[0])
 219 #else
 220 #define safe_address (__get_cpu_var(kernel_cpustat).cpustat[CPUTIME_USER])
 221 #endif
 222
 223 /*
 224  * These must be called with preempt disabled
 225  */
 226 static inline void fpu_save_init(struct fpu *fpu)
 227 {
 228         if (use_xsave()) {
 229                 fpu_xsave(fpu);
 230
 231                 /*
 232                  * xsave header may indicate the init state of the FP.
 233                  */
 234                 if (!(fpu->state->xsave.xsave_hdr.xstate_bv & XSTATE_FP))
 235                         return;
 236         } else if (use_fxsr()) {
 237                 fpu_fxsave(fpu);
 238         } else {
 239                 asm volatile("fnsave %[fx]; fwait"
 240                              : [fx] "=m" (fpu->state->fsave));
 241                 return;
 242         }
 243
 244         if (unlikely(fpu->state->fxsave.swd & X87_FSW_ES))
 245                 asm volatile("fnclex");
 246
 247         /* AMD K7/K8 CPUs don't save/restore FDP/FIP/FOP unless an exception
 248            is pending.  Clear the x87 state here by setting it to fixed
 249            values. safe_address is a random variable that should be in L1 */
 250         alternative_input(
 251                 ASM_NOP8 ASM_NOP2,
 252                 "emms\n\t"              /* clear stack tags */
 253                 "fildl %P[addr]",       /* set F?P to defined value */
 254                 X86_FEATURE_FXSAVE_LEAK,
 255                 [addr] "m" (safe_address));
 256 }
 257
 258 static inline void __save_init_fpu(struct task_struct *tsk)
 259 {
 260         fpu_save_init(&tsk->thread.fpu);
 261 }
 262
 263 static inline int fpu_fxrstor_checking(struct fpu *fpu)
 264 {
 265         return fxrstor_checking(&fpu->state->fxsave);
 266 }
 267
 268 static inline int fpu_restore_checking(struct fpu *fpu)
 269 {
 270         if (use_xsave())
 271                 return fpu_xrstor_checking(fpu);
 272         else
 273                 return fpu_fxrstor_checking(fpu);
 274 }
 275
 276 static inline int restore_fpu_checking(struct task_struct *tsk)
 277 {
 278         return fpu_restore_checking(&tsk->thread.fpu);
 279 }
 280
 281 /*
 282  * Software FPU state helpers. Careful: these need to
 283  * be preemption protection *and* they need to be
 284  * properly paired with the CR0.TS changes!
 285  */
 286 static inline int __thread_has_fpu(struct thread_info *ti)
 287 {
 288         return ti->status & TS_USEDFPU;
 289 }
 290
 291 /* Must be paired with an 'stts' after! */
 292 static inline void __thread_clear_has_fpu(struct thread_info *ti)
 293 {
 294         ti->status &= ~TS_USEDFPU;
 295 }
 296
 297 /* Must be paired with a 'clts' before! */
 298 static inline void __thread_set_has_fpu(struct thread_info *ti)
 299 {
 300         ti->status |= TS_USEDFPU;
 301 }
 302
 303 /*
 304  * Encapsulate the CR0.TS handling together with the
 305  * software flag.
 306  *
 307  * These generally need preemption protection to work,
 308  * do try to avoid using these on their own.
 309  */
 310 static inline void __thread_fpu_end(struct thread_info *ti)
 311 {
 312         __thread_clear_has_fpu(ti);
 313         stts();
 314 }
 315
 316 static inline void __thread_fpu_begin(struct thread_info *ti)
 317 {
 318         clts();
 319         __thread_set_has_fpu(ti);
 320 }
 321
 322 /*
 323  * Signal frame handlers...
 324  */
 325 extern int save_i387_xstate(void __user *buf);
 326 extern int restore_i387_xstate(void __user *buf);
 327
 328 static inline void __unlazy_fpu(struct task_struct *tsk)
 329 {
 330         if (__thread_has_fpu(task_thread_info(tsk))) {
 331                 __save_init_fpu(tsk);
 332                 __thread_fpu_end(task_thread_info(tsk));
 333         } else
 334                 tsk->fpu_counter = 0;
 335 }
 336
 337 static inline void __clear_fpu(struct task_struct *tsk)
 338 {
 339         if (__thread_has_fpu(task_thread_info(tsk))) {
 340                 /* Ignore delayed exceptions from user space */
 341                 asm volatile("1: fwait\n"
 342                              "2:\n"
 343                              _ASM_EXTABLE(1b, 2b));
 344                 __thread_fpu_end(task_thread_info(tsk));
 345         }
 346 }
 347
 348 /*
 349  * Were we in an interrupt that interrupted kernel mode?
 350  *
 351  * We can do a kernel_fpu_begin/end() pair *ONLY* if that
 352  * pair does nothing at all: the thread must not have fpu (so
 353  * that we don't try to save the FPU state), and TS must
 354  * be set (so that the clts/stts pair does nothing that is
 355  * visible in the interrupted kernel thread).
 356  */
 357 static inline bool interrupted_kernel_fpu_idle(void)
 358 {
 359         return !__thread_has_fpu(current_thread_info()) &&
 360                 (read_cr0() & X86_CR0_TS);
 361 }
 362
 363 /*
 364  * Were we in user mode (or vm86 mode) when we were
 365  * interrupted?
 366  *
 367  * Doing kernel_fpu_begin/end() is ok if we are running
 368  * in an interrupt context from user mode - we'll just
 369  * save the FPU state as required.
 370  */
 371 static inline bool interrupted_user_mode(void)
 372 {
 373         struct pt_regs *regs = get_irq_regs();
 374         return regs && user_mode_vm(regs);
 375 }
 376
 377 /*
 378  * Can we use the FPU in kernel mode with the
 379  * whole "kernel_fpu_begin/end()" sequence?
 380  *
 381  * It's always ok in process context (ie "not interrupt")
 382  * but it is sometimes ok even from an irq.
 383  */
 384 static inline bool irq_fpu_usable(void)
 385 {
 386         return !in_interrupt() ||
 387                 interrupted_user_mode() ||
 388                 interrupted_kernel_fpu_idle();
 389 }
 390
 391 static inline void kernel_fpu_begin(void)
 392 {
 393         struct thread_info *me = current_thread_info();
 394
 395         WARN_ON_ONCE(!irq_fpu_usable());
 396         preempt_disable();
 397         if (__thread_has_fpu(me)) {
 398                 __save_init_fpu(me->task);
 399                 __thread_clear_has_fpu(me);
 400                 /* We do 'stts()' in kernel_fpu_end() */
 401         } else
 402                 clts();
 403 }
 404
 405 static inline void kernel_fpu_end(void)
 406 {
 407         stts();
 408         preempt_enable();
 409 }
 410
 411 /*
 412  * Some instructions like VIA's padlock instructions generate a spurious
 413  * DNA fault but don't modify SSE registers. And these instructions
 414  * get used from interrupt context as well. To prevent these kernel instructions
 415  * in interrupt context interacting wrongly with other user/kernel fpu usage, we
 416  * should use them only in the context of irq_ts_save/restore()
 417  */
 418 static inline int irq_ts_save(void)
 419 {
 420         /*
 421          * If in process context and not atomic, we can take a spurious DNA fault.
 422          * Otherwise, doing clts() in process context requires disabling preemption
 423          * or some heavy lifting like kernel_fpu_begin()
 424          */
 425         if (!in_atomic())
 426                 return 0;
 427
 428         if (read_cr0() & X86_CR0_TS) {
 429                 clts();
 430                 return 1;
 431         }
 432
 433         return 0;
 434 }
 435
 436 static inline void irq_ts_restore(int TS_state)
 437 {
 438         if (TS_state)
 439                 stts();
 440 }
 441
 442 /*
 443  * The question "does this thread have fpu access?"
 444  * is slightly racy, since preemption could come in
 445  * and revoke it immediately after the test.
 446  *
 447  * However, even in that very unlikely scenario,
 448  * we can just assume we have FPU access - typically
 449  * to save the FP state - we'll just take a #NM
 450  * fault and get the FPU access back.
 451  *
 452  * The actual user_fpu_begin/end() functions
 453  * need to be preemption-safe, though.
 454  *
 455  * NOTE! user_fpu_end() must be used only after you
 456  * have saved the FP state, and user_fpu_begin() must
 457  * be used only immediately before restoring it.
 458  * These functions do not do any save/restore on
 459  * their own.
 460  */
 461 static inline int user_has_fpu(void)
 462 {
 463         return __thread_has_fpu(current_thread_info());
 464 }
 465
 466 static inline void user_fpu_end(void)
 467 {
 468         preempt_disable();
 469         __thread_fpu_end(current_thread_info());
 470         preempt_enable();
 471 }
 472
 473 static inline void user_fpu_begin(void)
 474 {
 475         preempt_disable();
 476         if (!user_has_fpu())
 477                 __thread_fpu_begin(current_thread_info());
 478         preempt_enable();
 479 }
 480
 481 /*
 482  * These disable preemption on their own and are safe
 483  */
 484 static inline void save_init_fpu(struct task_struct *tsk)
 485 {
 486         WARN_ON_ONCE(!__thread_has_fpu(task_thread_info(tsk)));
 487         preempt_disable();
 488         __save_init_fpu(tsk);
 489         __thread_fpu_end(task_thread_info(tsk));
 490         preempt_enable();
 491 }
 492
 493 static inline void unlazy_fpu(struct task_struct *tsk)
 494 {
 495         preempt_disable();
 496         __unlazy_fpu(tsk);
 497         preempt_enable();
 498 }
 499
 500 static inline void clear_fpu(struct task_struct *tsk)
 501 {
 502         preempt_disable();
 503         __clear_fpu(tsk);
 504         preempt_enable();
 505 }
 506
 507 /*
 508  * i387 state interaction
 509  */
 510 static inline unsigned short get_fpu_cwd(struct task_struct *tsk)
 511 {
 512         if (cpu_has_fxsr) {
 513                 return tsk->thread.fpu.state->fxsave.cwd;
 514         } else {
 515                 return (unsigned short)tsk->thread.fpu.state->fsave.cwd;
 516         }
 517 }
 518
 519 static inline unsigned short get_fpu_swd(struct task_struct *tsk)
 520 {
 521         if (cpu_has_fxsr) {
 522                 return tsk->thread.fpu.state->fxsave.swd;
 523         } else {
 524                 return (unsigned short)tsk->thread.fpu.state->fsave.swd;
 525         }
 526 }
 527
 528 static inline unsigned short get_fpu_mxcsr(struct task_struct *tsk)
 529 {
 530         if (cpu_has_xmm) {
 531                 return tsk->thread.fpu.state->fxsave.mxcsr;
 532         } else {
 533                 return MXCSR_DEFAULT;
 534         }
 535 }
 536
 537 static bool fpu_allocated(struct fpu *fpu)
 538 {
 539         return fpu->state != NULL;
 540 }
 541
 542 static inline int fpu_alloc(struct fpu *fpu)
 543 {
 544         if (fpu_allocated(fpu))
 545                 return 0;
 546         fpu->state = kmem_cache_alloc(task_xstate_cachep, GFP_KERNEL);
 547         if (!fpu->state)
 548                 return -ENOMEM;
 549         WARN_ON((unsigned long)fpu->state & 15);
 550         return 0;
 551 }
 552
 553 static inline void fpu_free(struct fpu *fpu)
 554 {
 555         if (fpu->state) {
 556                 kmem_cache_free(task_xstate_cachep, fpu->state);
 557                 fpu->state = NULL;
 558         }
 559 }
 560
 561 static inline void fpu_copy(struct fpu *dst, struct fpu *src)
 562 {
 563         memcpy(dst->state, src->state, xstate_size);
 564 }
 565
 566 extern void fpu_finit(struct fpu *fpu);
 567
 568 #endif /* __ASSEMBLY__ */
 569
 570 #endif /* _ASM_X86_I387_H */