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