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