arch/x86/kernel/fpu/core.c

   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  */
   8 #include <asm/fpu/internal.h>
   9 #include <asm/fpu/regset.h>
  10 #include <asm/fpu/signal.h>
  11 #include <asm/fpu/types.h>
  12 #include <asm/traps.h>
  13 #include <asm/irq_regs.h>
  14
  15 #include <linux/hardirq.h>
  16 #include <linux/pkeys.h>
  17
  18 #define CREATE_TRACE_POINTS
  19 #include <asm/trace/fpu.h>
  20
  21 /*
  22  * Represents the initial FPU state. It's mostly (but not completely) zeroes,
  23  * depending on the FPU hardware format:
  24  */
  25 union fpregs_state init_fpstate __read_mostly;
  26
  27 /*
  28  * Track whether the kernel is using the FPU state
  29  * currently.
  30  *
  31  * This flag is used:
  32  *
  33  *   - by IRQ context code to potentially use the FPU
  34  *     if it's unused.
  35  *
  36  *   - to debug kernel_fpu_begin()/end() correctness
  37  */
  38 static DEFINE_PER_CPU(bool, in_kernel_fpu);
  39
  40 /*
  41  * Track which context is using the FPU on the CPU:
  42  */
  43 DEFINE_PER_CPU(struct fpu *, fpu_fpregs_owner_ctx);
  44
  45 static void kernel_fpu_disable(void)
  46 {
  47         WARN_ON_FPU(this_cpu_read(in_kernel_fpu));
  48         this_cpu_write(in_kernel_fpu, true);
  49 }
  50
  51 static void kernel_fpu_enable(void)
  52 {
  53         WARN_ON_FPU(!this_cpu_read(in_kernel_fpu));
  54         this_cpu_write(in_kernel_fpu, false);
  55 }
  56
  57 static bool kernel_fpu_disabled(void)
  58 {
  59         return this_cpu_read(in_kernel_fpu);
  60 }
  61
  62 static bool interrupted_kernel_fpu_idle(void)
  63 {
  64         return !kernel_fpu_disabled();
  65 }
  66
  67 /*
  68  * Were we in user mode (or vm86 mode) when we were
  69  * interrupted?
  70  *
  71  * Doing kernel_fpu_begin/end() is ok if we are running
  72  * in an interrupt context from user mode - we'll just
  73  * save the FPU state as required.
  74  */
  75 static bool interrupted_user_mode(void)
  76 {
  77         struct pt_regs *regs = get_irq_regs();
  78         return regs && user_mode(regs);
  79 }
  80
  81 /*
  82  * Can we use the FPU in kernel mode with the
  83  * whole "kernel_fpu_begin/end()" sequence?
  84  *
  85  * It's always ok in process context (ie "not interrupt")
  86  * but it is sometimes ok even from an irq.
  87  */
  88 bool irq_fpu_usable(void)
  89 {
  90         return !in_interrupt() ||
  91                 interrupted_user_mode() ||
  92                 interrupted_kernel_fpu_idle();
  93 }
  94 EXPORT_SYMBOL(irq_fpu_usable);
  95
  96 void __kernel_fpu_begin(void)
  97 {
  98         struct fpu *fpu = &current->thread.fpu;
  99
 100         WARN_ON_FPU(!irq_fpu_usable());
 101
 102         kernel_fpu_disable();
 103
 104         if (fpu->fpregs_active) {
 105                 /*
 106                  * Ignore return value -- we don't care if reg state
 107                  * is clobbered.
 108                  */
 109                 copy_fpregs_to_fpstate(fpu);
 110         } else {
 111                 this_cpu_write(fpu_fpregs_owner_ctx, NULL);
 112         }
 113 }
 114 EXPORT_SYMBOL(__kernel_fpu_begin);
 115
 116 void __kernel_fpu_end(void)
 117 {
 118         struct fpu *fpu = &current->thread.fpu;
 119
 120         if (fpu->fpregs_active)
 121                 copy_kernel_to_fpregs(&fpu->state);
 122
 123         kernel_fpu_enable();
 124 }
 125 EXPORT_SYMBOL(__kernel_fpu_end);
 126
 127 void kernel_fpu_begin(void)
 128 {
 129         preempt_disable();
 130         __kernel_fpu_begin();
 131 }
 132 EXPORT_SYMBOL_GPL(kernel_fpu_begin);
 133
 134 void kernel_fpu_end(void)
 135 {
 136         __kernel_fpu_end();
 137         preempt_enable();
 138 }
 139 EXPORT_SYMBOL_GPL(kernel_fpu_end);
 140
 141 /*
 142  * CR0::TS save/restore functions:
 143  */
 144 int irq_ts_save(void)
 145 {
 146         /*
 147          * If in process context and not atomic, we can take a spurious DNA fault.
 148          * Otherwise, doing clts() in process context requires disabling preemption
 149          * or some heavy lifting like kernel_fpu_begin()
 150          */
 151         if (!in_atomic())
 152                 return 0;
 153
 154         if (read_cr0() & X86_CR0_TS) {
 155                 clts();
 156                 return 1;
 157         }
 158
 159         return 0;
 160 }
 161 EXPORT_SYMBOL_GPL(irq_ts_save);
 162
 163 void irq_ts_restore(int TS_state)
 164 {
 165         if (TS_state)
 166                 stts();
 167 }
 168 EXPORT_SYMBOL_GPL(irq_ts_restore);
 169
 170 /*
 171  * Save the FPU state (mark it for reload if necessary):
 172  *
 173  * This only ever gets called for the current task.
 174  */
 175 void fpu__save(struct fpu *fpu)
 176 {
 177         WARN_ON_FPU(fpu != &current->thread.fpu);
 178
 179         preempt_disable();
 180         trace_x86_fpu_before_save(fpu);
 181         if (fpu->fpregs_active) {
 182                 if (!copy_fpregs_to_fpstate(fpu)) {
 183                         copy_kernel_to_fpregs(&fpu->state);
 184                 }
 185         }
 186         trace_x86_fpu_after_save(fpu);
 187         preempt_enable();
 188 }
 189 EXPORT_SYMBOL_GPL(fpu__save);
 190
 191 /*
 192  * Legacy x87 fpstate state init:
 193  */
 194 static inline void fpstate_init_fstate(struct fregs_state *fp)
 195 {
 196         fp->cwd = 0xffff037fu;
 197         fp->swd = 0xffff0000u;
 198         fp->twd = 0xffffffffu;
 199         fp->fos = 0xffff0000u;
 200 }
 201
 202 void fpstate_init(union fpregs_state *state)
 203 {
 204         if (!static_cpu_has(X86_FEATURE_FPU)) {
 205                 fpstate_init_soft(&state->soft);
 206                 return;
 207         }
 208
 209         memset(state, 0, fpu_kernel_xstate_size);
 210
 211         /*
 212          * XRSTORS requires that this bit is set in xcomp_bv, or
 213          * it will #GP. Make sure it is replaced after the memset().
 214          */
 215         if (static_cpu_has(X86_FEATURE_XSAVES))
 216                 state->xsave.header.xcomp_bv = XCOMP_BV_COMPACTED_FORMAT |
 217                                                xfeatures_mask;
 218
 219         if (static_cpu_has(X86_FEATURE_FXSR))
 220                 fpstate_init_fxstate(&state->fxsave);
 221         else
 222                 fpstate_init_fstate(&state->fsave);
 223 }
 224 EXPORT_SYMBOL_GPL(fpstate_init);
 225
 226 int fpu__copy(struct fpu *dst_fpu, struct fpu *src_fpu)
 227 {
 228         dst_fpu->fpregs_active = 0;
 229         dst_fpu->last_cpu = -1;
 230
 231         if (!src_fpu->fpstate_active || !static_cpu_has(X86_FEATURE_FPU))
 232                 return 0;
 233
 234         WARN_ON_FPU(src_fpu != &current->thread.fpu);
 235
 236         /*
 237          * Don't let 'init optimized' areas of the XSAVE area
 238          * leak into the child task:
 239          */
 240         memset(&dst_fpu->state.xsave, 0, fpu_kernel_xstate_size);
 241
 242         /*
 243          * Save current FPU registers directly into the child
 244          * FPU context, without any memory-to-memory copying.
 245          * In lazy mode, if the FPU context isn't loaded into
 246          * fpregs, CR0.TS will be set and do_device_not_available
 247          * will load the FPU context.
 248          *
 249          * We have to do all this with preemption disabled,
 250          * mostly because of the FNSAVE case, because in that
 251          * case we must not allow preemption in the window
 252          * between the FNSAVE and us marking the context lazy.
 253          *
 254          * It shouldn't be an issue as even FNSAVE is plenty
 255          * fast in terms of critical section length.
 256          */
 257         preempt_disable();
 258         if (!copy_fpregs_to_fpstate(dst_fpu)) {
 259                 memcpy(&src_fpu->state, &dst_fpu->state,
 260                        fpu_kernel_xstate_size);
 261
 262                 copy_kernel_to_fpregs(&src_fpu->state);
 263         }
 264         preempt_enable();
 265
 266         trace_x86_fpu_copy_src(src_fpu);
 267         trace_x86_fpu_copy_dst(dst_fpu);
 268
 269         return 0;
 270 }
 271
 272 /*
 273  * Activate the current task's in-memory FPU context,
 274  * if it has not been used before:
 275  */
 276 void fpu__activate_curr(struct fpu *fpu)
 277 {
 278         WARN_ON_FPU(fpu != &current->thread.fpu);
 279
 280         if (!fpu->fpstate_active) {
 281                 fpstate_init(&fpu->state);
 282                 trace_x86_fpu_init_state(fpu);
 283
 284                 trace_x86_fpu_activate_state(fpu);
 285                 /* Safe to do for the current task: */
 286                 fpu->fpstate_active = 1;
 287         }
 288 }
 289 EXPORT_SYMBOL_GPL(fpu__activate_curr);
 290
 291 /*
 292  * This function must be called before we read a task's fpstate.
 293  *
 294  * If the task has not used the FPU before then initialize its
 295  * fpstate.
 296  *
 297  * If the task has used the FPU before then save it.
 298  */
 299 void fpu__activate_fpstate_read(struct fpu *fpu)
 300 {
 301         /*
 302          * If fpregs are active (in the current CPU), then
 303          * copy them to the fpstate:
 304          */
 305         if (fpu->fpregs_active) {
 306                 fpu__save(fpu);
 307         } else {
 308                 if (!fpu->fpstate_active) {
 309                         fpstate_init(&fpu->state);
 310                         trace_x86_fpu_init_state(fpu);
 311
 312                         trace_x86_fpu_activate_state(fpu);
 313                         /* Safe to do for current and for stopped child tasks: */
 314                         fpu->fpstate_active = 1;
 315                 }
 316         }
 317 }
 318
 319 /*
 320  * This function must be called before we write a task's fpstate.
 321  *
 322  * If the task has used the FPU before then unlazy it.
 323  * If the task has not used the FPU before then initialize its fpstate.
 324  *
 325  * After this function call, after registers in the fpstate are
 326  * modified and the child task has woken up, the child task will
 327  * restore the modified FPU state from the modified context. If we
 328  * didn't clear its lazy status here then the lazy in-registers
 329  * state pending on its former CPU could be restored, corrupting
 330  * the modifications.
 331  */
 332 void fpu__activate_fpstate_write(struct fpu *fpu)
 333 {
 334         /*
 335          * Only stopped child tasks can be used to modify the FPU
 336          * state in the fpstate buffer:
 337          */
 338         WARN_ON_FPU(fpu == &current->thread.fpu);
 339
 340         if (fpu->fpstate_active) {
 341                 /* Invalidate any lazy state: */
 342                 fpu->last_cpu = -1;
 343         } else {
 344                 fpstate_init(&fpu->state);
 345                 trace_x86_fpu_init_state(fpu);
 346
 347                 trace_x86_fpu_activate_state(fpu);
 348                 /* Safe to do for stopped child tasks: */
 349                 fpu->fpstate_active = 1;
 350         }
 351 }
 352
 353 /*
 354  * This function must be called before we write the current
 355  * task's fpstate.
 356  *
 357  * This call gets the current FPU register state and moves
 358  * it in to the 'fpstate'.  Preemption is disabled so that
 359  * no writes to the 'fpstate' can occur from context
 360  * swiches.
 361  *
 362  * Must be followed by a fpu__current_fpstate_write_end().
 363  */
 364 void fpu__current_fpstate_write_begin(void)
 365 {
 366         struct fpu *fpu = &current->thread.fpu;
 367
 368         /*
 369          * Ensure that the context-switching code does not write
 370          * over the fpstate while we are doing our update.
 371          */
 372         preempt_disable();
 373
 374         /*
 375          * Move the fpregs in to the fpu's 'fpstate'.
 376          */
 377         fpu__activate_fpstate_read(fpu);
 378
 379         /*
 380          * The caller is about to write to 'fpu'.  Ensure that no
 381          * CPU thinks that its fpregs match the fpstate.  This
 382          * ensures we will not be lazy and skip a XRSTOR in the
 383          * future.
 384          */
 385         fpu->last_cpu = -1;
 386 }
 387
 388 /*
 389  * This function must be paired with fpu__current_fpstate_write_begin()
 390  *
 391  * This will ensure that the modified fpstate gets placed back in
 392  * the fpregs if necessary.
 393  *
 394  * Note: This function may be called whether or not an _actual_
 395  * write to the fpstate occurred.
 396  */
 397 void fpu__current_fpstate_write_end(void)
 398 {
 399         struct fpu *fpu = &current->thread.fpu;
 400
 401         /*
 402          * 'fpu' now has an updated copy of the state, but the
 403          * registers may still be out of date.  Update them with
 404          * an XRSTOR if they are active.
 405          */
 406         if (fpregs_active())
 407                 copy_kernel_to_fpregs(&fpu->state);
 408
 409         /*
 410          * Our update is done and the fpregs/fpstate are in sync
 411          * if necessary.  Context switches can happen again.
 412          */
 413         preempt_enable();
 414 }
 415
 416 /*
 417  * 'fpu__restore()' is called to copy FPU registers from
 418  * the FPU fpstate to the live hw registers and to activate
 419  * access to the hardware registers, so that FPU instructions
 420  * can be used afterwards.
 421  *
 422  * Must be called with kernel preemption disabled (for example
 423  * with local interrupts disabled, as it is in the case of
 424  * do_device_not_available()).
 425  */
 426 void fpu__restore(struct fpu *fpu)
 427 {
 428         fpu__activate_curr(fpu);
 429
 430         /* Avoid __kernel_fpu_begin() right after fpregs_activate() */
 431         kernel_fpu_disable();
 432         trace_x86_fpu_before_restore(fpu);
 433         fpregs_activate(fpu);
 434         copy_kernel_to_fpregs(&fpu->state);
 435         trace_x86_fpu_after_restore(fpu);
 436         kernel_fpu_enable();
 437 }
 438 EXPORT_SYMBOL_GPL(fpu__restore);
 439
 440 /*
 441  * Drops current FPU state: deactivates the fpregs and
 442  * the fpstate. NOTE: it still leaves previous contents
 443  * in the fpregs in the eager-FPU case.
 444  *
 445  * This function can be used in cases where we know that
 446  * a state-restore is coming: either an explicit one,
 447  * or a reschedule.
 448  */
 449 void fpu__drop(struct fpu *fpu)
 450 {
 451         preempt_disable();
 452
 453         if (fpu->fpregs_active) {
 454                 /* Ignore delayed exceptions from user space */
 455                 asm volatile("1: fwait\n"
 456                              "2:\n"
 457                              _ASM_EXTABLE(1b, 2b));
 458                 fpregs_deactivate(fpu);
 459         }
 460
 461         fpu->fpstate_active = 0;
 462
 463         trace_x86_fpu_dropped(fpu);
 464
 465         preempt_enable();
 466 }
 467
 468 /*
 469  * Clear FPU registers by setting them up from
 470  * the init fpstate:
 471  */
 472 static inline void copy_init_fpstate_to_fpregs(void)
 473 {
 474         if (use_xsave())
 475                 copy_kernel_to_xregs(&init_fpstate.xsave, -1);
 476         else if (static_cpu_has(X86_FEATURE_FXSR))
 477                 copy_kernel_to_fxregs(&init_fpstate.fxsave);
 478         else
 479                 copy_kernel_to_fregs(&init_fpstate.fsave);
 480
 481         if (boot_cpu_has(X86_FEATURE_OSPKE))
 482                 copy_init_pkru_to_fpregs();
 483 }
 484
 485 /*
 486  * Clear the FPU state back to init state.
 487  *
 488  * Called by sys_execve(), by the signal handler code and by various
 489  * error paths.
 490  */
 491 void fpu__clear(struct fpu *fpu)
 492 {
 493         WARN_ON_FPU(fpu != &current->thread.fpu); /* Almost certainly an anomaly */
 494
 495         fpu__drop(fpu);
 496
 497         /*
 498          * Make sure fpstate is cleared and initialized.
 499          */
 500         if (static_cpu_has(X86_FEATURE_FPU)) {
 501                 fpu__activate_curr(fpu);
 502                 user_fpu_begin();
 503                 copy_init_fpstate_to_fpregs();
 504         }
 505 }
 506
 507 /*
 508  * x87 math exception handling:
 509  */
 510
 511 int fpu__exception_code(struct fpu *fpu, int trap_nr)
 512 {
 513         int err;
 514
 515         if (trap_nr == X86_TRAP_MF) {
 516                 unsigned short cwd, swd;
 517                 /*
 518                  * (~cwd & swd) will mask out exceptions that are not set to unmasked
 519                  * status.  0x3f is the exception bits in these regs, 0x200 is the
 520                  * C1 reg you need in case of a stack fault, 0x040 is the stack
 521                  * fault bit.  We should only be taking one exception at a time,
 522                  * so if this combination doesn't produce any single exception,
 523                  * then we have a bad program that isn't synchronizing its FPU usage
 524                  * and it will suffer the consequences since we won't be able to
 525                  * fully reproduce the context of the exception.
 526                  */
 527                 if (boot_cpu_has(X86_FEATURE_FXSR)) {
 528                         cwd = fpu->state.fxsave.cwd;
 529                         swd = fpu->state.fxsave.swd;
 530                 } else {
 531                         cwd = (unsigned short)fpu->state.fsave.cwd;
 532                         swd = (unsigned short)fpu->state.fsave.swd;
 533                 }
 534
 535                 err = swd & ~cwd;
 536         } else {
 537                 /*
 538                  * The SIMD FPU exceptions are handled a little differently, as there
 539                  * is only a single status/control register.  Thus, to determine which
 540                  * unmasked exception was caught we must mask the exception mask bits
 541                  * at 0x1f80, and then use these to mask the exception bits at 0x3f.
 542                  */
 543                 unsigned short mxcsr = MXCSR_DEFAULT;
 544
 545                 if (boot_cpu_has(X86_FEATURE_XMM))
 546                         mxcsr = fpu->state.fxsave.mxcsr;
 547
 548                 err = ~(mxcsr >> 7) & mxcsr;
 549         }
 550
 551         if (err & 0x001) {      /* Invalid op */
 552                 /*
 553                  * swd & 0x240 == 0x040: Stack Underflow
 554                  * swd & 0x240 == 0x240: Stack Overflow
 555                  * User must clear the SF bit (0x40) if set
 556                  */
 557                 return FPE_FLTINV;
 558         } else if (err & 0x004) { /* Divide by Zero */
 559                 return FPE_FLTDIV;
 560         } else if (err & 0x008) { /* Overflow */
 561                 return FPE_FLTOVF;
 562         } else if (err & 0x012) { /* Denormal, Underflow */
 563                 return FPE_FLTUND;
 564         } else if (err & 0x020) { /* Precision */
 565                 return FPE_FLTRES;
 566         }
 567
 568         /*
 569          * If we're using IRQ 13, or supposedly even some trap
 570          * X86_TRAP_MF implementations, it's possible
 571          * we get a spurious trap, which is not an error.
 572          */
 573         return 0;
 574 }