arch/x86/kernel/fpu/core.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  Copyright (C) 1994 Linus Torvalds
   4  *
   5  *  Pentium III FXSR, SSE support
   6  *  General FPU state handling cleanups
   7  *      Gareth Hughes <gareth@valinux.com>, May 2000
   8  */
   9 #include <asm/fpu/internal.h>
  10 #include <asm/fpu/regset.h>
  11 #include <asm/fpu/signal.h>
  12 #include <asm/fpu/types.h>
  13 #include <asm/traps.h>
  14 #include <asm/irq_regs.h>
  15
  16 #include <linux/hardirq.h>
  17 #include <linux/pkeys.h>
  18
  19 #define CREATE_TRACE_POINTS
  20 #include <asm/trace/fpu.h>
  21
  22 /*
  23  * Represents the initial FPU state. It's mostly (but not completely) zeroes,
  24  * depending on the FPU hardware format:
  25  */
  26 union fpregs_state init_fpstate __read_mostly;
  27
  28 /*
  29  * Track whether the kernel is using the FPU state
  30  * currently.
  31  *
  32  * This flag is used:
  33  *
  34  *   - by IRQ context code to potentially use the FPU
  35  *     if it's unused.
  36  *
  37  *   - to debug kernel_fpu_begin()/end() correctness
  38  */
  39 static DEFINE_PER_CPU(bool, in_kernel_fpu);
  40
  41 /*
  42  * Track which context is using the FPU on the CPU:
  43  */
  44 DEFINE_PER_CPU(struct fpu *, fpu_fpregs_owner_ctx);
  45
  46 static bool kernel_fpu_disabled(void)
  47 {
  48         return this_cpu_read(in_kernel_fpu);
  49 }
  50
  51 static bool interrupted_kernel_fpu_idle(void)
  52 {
  53         return !kernel_fpu_disabled();
  54 }
  55
  56 /*
  57  * Were we in user mode (or vm86 mode) when we were
  58  * interrupted?
  59  *
  60  * Doing kernel_fpu_begin/end() is ok if we are running
  61  * in an interrupt context from user mode - we'll just
  62  * save the FPU state as required.
  63  */
  64 static bool interrupted_user_mode(void)
  65 {
  66         struct pt_regs *regs = get_irq_regs();
  67         return regs && user_mode(regs);
  68 }
  69
  70 /*
  71  * Can we use the FPU in kernel mode with the
  72  * whole "kernel_fpu_begin/end()" sequence?
  73  *
  74  * It's always ok in process context (ie "not interrupt")
  75  * but it is sometimes ok even from an irq.
  76  */
  77 bool irq_fpu_usable(void)
  78 {
  79         return !in_interrupt() ||
  80                 interrupted_user_mode() ||
  81                 interrupted_kernel_fpu_idle();
  82 }
  83 EXPORT_SYMBOL(irq_fpu_usable);
  84
  85 /*
  86  * Save the FPU register state in fpu->state. The register state is
  87  * preserved.
  88  *
  89  * Must be called with fpregs_lock() held.
  90  *
  91  * The legacy FNSAVE instruction clears all FPU state unconditionally, so
  92  * register state has to be reloaded. That might be a pointless exercise
  93  * when the FPU is going to be used by another task right after that. But
  94  * this only affects 20+ years old 32bit systems and avoids conditionals all
  95  * over the place.
  96  *
  97  * FXSAVE and all XSAVE variants preserve the FPU register state.
  98  */
  99 void save_fpregs_to_fpstate(struct fpu *fpu)
 100 {
 101         if (likely(use_xsave())) {
 102                 os_xsave(&fpu->state.xsave);
 103
 104                 /*
 105                  * AVX512 state is tracked here because its use is
 106                  * known to slow the max clock speed of the core.
 107                  */
 108                 if (fpu->state.xsave.header.xfeatures & XFEATURE_MASK_AVX512)
 109                         fpu->avx512_timestamp = jiffies;
 110                 return;
 111         }
 112
 113         if (likely(use_fxsr())) {
 114                 fxsave(&fpu->state.fxsave);
 115                 return;
 116         }
 117
 118         /*
 119          * Legacy FPU register saving, FNSAVE always clears FPU registers,
 120          * so we have to reload them from the memory state.
 121          */
 122         asm volatile("fnsave %[fp]; fwait" : [fp] "=m" (fpu->state.fsave));
 123         frstor(&fpu->state.fsave);
 124 }
 125 EXPORT_SYMBOL(save_fpregs_to_fpstate);
 126
 127 void kernel_fpu_begin_mask(unsigned int kfpu_mask)
 128 {
 129         preempt_disable();
 130
 131         WARN_ON_FPU(!irq_fpu_usable());
 132         WARN_ON_FPU(this_cpu_read(in_kernel_fpu));
 133
 134         this_cpu_write(in_kernel_fpu, true);
 135
 136         if (!(current->flags & PF_KTHREAD) &&
 137             !test_thread_flag(TIF_NEED_FPU_LOAD)) {
 138                 set_thread_flag(TIF_NEED_FPU_LOAD);
 139                 save_fpregs_to_fpstate(&current->thread.fpu);
 140         }
 141         __cpu_invalidate_fpregs_state();
 142
 143         /* Put sane initial values into the control registers. */
 144         if (likely(kfpu_mask & KFPU_MXCSR) && boot_cpu_has(X86_FEATURE_XMM))
 145                 ldmxcsr(MXCSR_DEFAULT);
 146
 147         if (unlikely(kfpu_mask & KFPU_387) && boot_cpu_has(X86_FEATURE_FPU))
 148                 asm volatile ("fninit");
 149 }
 150 EXPORT_SYMBOL_GPL(kernel_fpu_begin_mask);
 151
 152 void kernel_fpu_end(void)
 153 {
 154         WARN_ON_FPU(!this_cpu_read(in_kernel_fpu));
 155
 156         this_cpu_write(in_kernel_fpu, false);
 157         preempt_enable();
 158 }
 159 EXPORT_SYMBOL_GPL(kernel_fpu_end);
 160
 161 /*
 162  * Sync the FPU register state to current's memory register state when the
 163  * current task owns the FPU. The hardware register state is preserved.
 164  */
 165 void fpu_sync_fpstate(struct fpu *fpu)
 166 {
 167         WARN_ON_FPU(fpu != &current->thread.fpu);
 168
 169         fpregs_lock();
 170         trace_x86_fpu_before_save(fpu);
 171
 172         if (!test_thread_flag(TIF_NEED_FPU_LOAD))
 173                 save_fpregs_to_fpstate(fpu);
 174
 175         trace_x86_fpu_after_save(fpu);
 176         fpregs_unlock();
 177 }
 178
 179 static inline void fpstate_init_xstate(struct xregs_state *xsave)
 180 {
 181         /*
 182          * XRSTORS requires these bits set in xcomp_bv, or it will
 183          * trigger #GP:
 184          */
 185         xsave->header.xcomp_bv = XCOMP_BV_COMPACTED_FORMAT | xfeatures_mask_all;
 186 }
 187
 188 static inline void fpstate_init_fxstate(struct fxregs_state *fx)
 189 {
 190         fx->cwd = 0x37f;
 191         fx->mxcsr = MXCSR_DEFAULT;
 192 }
 193
 194 /*
 195  * Legacy x87 fpstate state init:
 196  */
 197 static inline void fpstate_init_fstate(struct fregs_state *fp)
 198 {
 199         fp->cwd = 0xffff037fu;
 200         fp->swd = 0xffff0000u;
 201         fp->twd = 0xffffffffu;
 202         fp->fos = 0xffff0000u;
 203 }
 204
 205 void fpstate_init(union fpregs_state *state)
 206 {
 207         if (!static_cpu_has(X86_FEATURE_FPU)) {
 208                 fpstate_init_soft(&state->soft);
 209                 return;
 210         }
 211
 212         memset(state, 0, fpu_kernel_xstate_size);
 213
 214         if (static_cpu_has(X86_FEATURE_XSAVES))
 215                 fpstate_init_xstate(&state->xsave);
 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 /* Clone current's FPU state on fork */
 224 int fpu_clone(struct task_struct *dst)
 225 {
 226         struct fpu *src_fpu = &current->thread.fpu;
 227         struct fpu *dst_fpu = &dst->thread.fpu;
 228
 229         /* The new task's FPU state cannot be valid in the hardware. */
 230         dst_fpu->last_cpu = -1;
 231
 232         if (!cpu_feature_enabled(X86_FEATURE_FPU))
 233                 return 0;
 234
 235         /*
 236          * Don't let 'init optimized' areas of the XSAVE area
 237          * leak into the child task:
 238          */
 239         memset(&dst_fpu->state.xsave, 0, fpu_kernel_xstate_size);
 240
 241         /*
 242          * If the FPU registers are not owned by current just memcpy() the
 243          * state.  Otherwise save the FPU registers directly into the
 244          * child's FPU context, without any memory-to-memory copying.
 245          */
 246         fpregs_lock();
 247         if (test_thread_flag(TIF_NEED_FPU_LOAD))
 248                 memcpy(&dst_fpu->state, &src_fpu->state, fpu_kernel_xstate_size);
 249
 250         else
 251                 save_fpregs_to_fpstate(dst_fpu);
 252         fpregs_unlock();
 253
 254         set_tsk_thread_flag(dst, TIF_NEED_FPU_LOAD);
 255
 256         trace_x86_fpu_copy_src(src_fpu);
 257         trace_x86_fpu_copy_dst(dst_fpu);
 258
 259         return 0;
 260 }
 261
 262 /*
 263  * Drops current FPU state: deactivates the fpregs and
 264  * the fpstate. NOTE: it still leaves previous contents
 265  * in the fpregs in the eager-FPU case.
 266  *
 267  * This function can be used in cases where we know that
 268  * a state-restore is coming: either an explicit one,
 269  * or a reschedule.
 270  */
 271 void fpu__drop(struct fpu *fpu)
 272 {
 273         preempt_disable();
 274
 275         if (fpu == &current->thread.fpu) {
 276                 /* Ignore delayed exceptions from user space */
 277                 asm volatile("1: fwait\n"
 278                              "2:\n"
 279                              _ASM_EXTABLE(1b, 2b));
 280                 fpregs_deactivate(fpu);
 281         }
 282
 283         trace_x86_fpu_dropped(fpu);
 284
 285         preempt_enable();
 286 }
 287
 288 /*
 289  * Clear FPU registers by setting them up from the init fpstate.
 290  * Caller must do fpregs_[un]lock() around it.
 291  */
 292 static inline void restore_fpregs_from_init_fpstate(u64 features_mask)
 293 {
 294         if (use_xsave())
 295                 os_xrstor(&init_fpstate.xsave, features_mask);
 296         else if (use_fxsr())
 297                 fxrstor(&init_fpstate.fxsave);
 298         else
 299                 frstor(&init_fpstate.fsave);
 300
 301         pkru_write_default();
 302 }
 303
 304 static inline unsigned int init_fpstate_copy_size(void)
 305 {
 306         if (!use_xsave())
 307                 return fpu_kernel_xstate_size;
 308
 309         /* XSAVE(S) just needs the legacy and the xstate header part */
 310         return sizeof(init_fpstate.xsave);
 311 }
 312
 313 /* Temporary workaround. Will be removed once PKRU and XSTATE are untangled. */
 314 static inline void pkru_set_default_in_xstate(struct xregs_state *xsave)
 315 {
 316         struct pkru_state *pk;
 317
 318         if (!cpu_feature_enabled(X86_FEATURE_OSPKE))
 319                 return;
 320         /*
 321          * Force XFEATURE_PKRU to be set in the header otherwise
 322          * get_xsave_addr() does not work and it also needs to be set to
 323          * make XRSTOR(S) load it.
 324          */
 325         xsave->header.xfeatures |= XFEATURE_MASK_PKRU;
 326         pk = get_xsave_addr(xsave, XFEATURE_PKRU);
 327         pk->pkru = pkru_get_init_value();
 328 }
 329
 330 /*
 331  * Reset current->fpu memory state to the init values.
 332  */
 333 static void fpu_reset_fpstate(void)
 334 {
 335         struct fpu *fpu = &current->thread.fpu;
 336
 337         fpregs_lock();
 338         fpu__drop(fpu);
 339         /*
 340          * This does not change the actual hardware registers. It just
 341          * resets the memory image and sets TIF_NEED_FPU_LOAD so a
 342          * subsequent return to usermode will reload the registers from the
 343          * task's memory image.
 344          *
 345          * Do not use fpstate_init() here. Just copy init_fpstate which has
 346          * the correct content already except for PKRU.
 347          */
 348         memcpy(&fpu->state, &init_fpstate, init_fpstate_copy_size());
 349         pkru_set_default_in_xstate(&fpu->state.xsave);
 350         set_thread_flag(TIF_NEED_FPU_LOAD);
 351         fpregs_unlock();
 352 }
 353
 354 /*
 355  * Reset current's user FPU states to the init states.  current's
 356  * supervisor states, if any, are not modified by this function.  The
 357  * caller guarantees that the XSTATE header in memory is intact.
 358  */
 359 void fpu__clear_user_states(struct fpu *fpu)
 360 {
 361         WARN_ON_FPU(fpu != &current->thread.fpu);
 362
 363         fpregs_lock();
 364         if (!cpu_feature_enabled(X86_FEATURE_FPU)) {
 365                 fpu_reset_fpstate();
 366                 fpregs_unlock();
 367                 return;
 368         }
 369
 370         /*
 371          * Ensure that current's supervisor states are loaded into their
 372          * corresponding registers.
 373          */
 374         if (xfeatures_mask_supervisor() &&
 375             !fpregs_state_valid(fpu, smp_processor_id())) {
 376                 os_xrstor(&fpu->state.xsave, xfeatures_mask_supervisor());
 377         }
 378
 379         /* Reset user states in registers. */
 380         restore_fpregs_from_init_fpstate(xfeatures_mask_user());
 381
 382         /*
 383          * Now all FPU registers have their desired values.  Inform the FPU
 384          * state machine that current's FPU registers are in the hardware
 385          * registers. The memory image does not need to be updated because
 386          * any operation relying on it has to save the registers first when
 387          * current's FPU is marked active.
 388          */
 389         fpregs_mark_activate();
 390         fpregs_unlock();
 391 }
 392
 393 void fpu_flush_thread(void)
 394 {
 395         fpu_reset_fpstate();
 396 }
 397 /*
 398  * Load FPU context before returning to userspace.
 399  */
 400 void switch_fpu_return(void)
 401 {
 402         if (!static_cpu_has(X86_FEATURE_FPU))
 403                 return;
 404
 405         fpregs_restore_userregs();
 406 }
 407 EXPORT_SYMBOL_GPL(switch_fpu_return);
 408
 409 #ifdef CONFIG_X86_DEBUG_FPU
 410 /*
 411  * If current FPU state according to its tracking (loaded FPU context on this
 412  * CPU) is not valid then we must have TIF_NEED_FPU_LOAD set so the context is
 413  * loaded on return to userland.
 414  */
 415 void fpregs_assert_state_consistent(void)
 416 {
 417         struct fpu *fpu = &current->thread.fpu;
 418
 419         if (test_thread_flag(TIF_NEED_FPU_LOAD))
 420                 return;
 421
 422         WARN_ON_FPU(!fpregs_state_valid(fpu, smp_processor_id()));
 423 }
 424 EXPORT_SYMBOL_GPL(fpregs_assert_state_consistent);
 425 #endif
 426
 427 void fpregs_mark_activate(void)
 428 {
 429         struct fpu *fpu = &current->thread.fpu;
 430
 431         fpregs_activate(fpu);
 432         fpu->last_cpu = smp_processor_id();
 433         clear_thread_flag(TIF_NEED_FPU_LOAD);
 434 }
 435 EXPORT_SYMBOL_GPL(fpregs_mark_activate);
 436
 437 /*
 438  * x87 math exception handling:
 439  */
 440
 441 int fpu__exception_code(struct fpu *fpu, int trap_nr)
 442 {
 443         int err;
 444
 445         if (trap_nr == X86_TRAP_MF) {
 446                 unsigned short cwd, swd;
 447                 /*
 448                  * (~cwd & swd) will mask out exceptions that are not set to unmasked
 449                  * status.  0x3f is the exception bits in these regs, 0x200 is the
 450                  * C1 reg you need in case of a stack fault, 0x040 is the stack
 451                  * fault bit.  We should only be taking one exception at a time,
 452                  * so if this combination doesn't produce any single exception,
 453                  * then we have a bad program that isn't synchronizing its FPU usage
 454                  * and it will suffer the consequences since we won't be able to
 455                  * fully reproduce the context of the exception.
 456                  */
 457                 if (boot_cpu_has(X86_FEATURE_FXSR)) {
 458                         cwd = fpu->state.fxsave.cwd;
 459                         swd = fpu->state.fxsave.swd;
 460                 } else {
 461                         cwd = (unsigned short)fpu->state.fsave.cwd;
 462                         swd = (unsigned short)fpu->state.fsave.swd;
 463                 }
 464
 465                 err = swd & ~cwd;
 466         } else {
 467                 /*
 468                  * The SIMD FPU exceptions are handled a little differently, as there
 469                  * is only a single status/control register.  Thus, to determine which
 470                  * unmasked exception was caught we must mask the exception mask bits
 471                  * at 0x1f80, and then use these to mask the exception bits at 0x3f.
 472                  */
 473                 unsigned short mxcsr = MXCSR_DEFAULT;
 474
 475                 if (boot_cpu_has(X86_FEATURE_XMM))
 476                         mxcsr = fpu->state.fxsave.mxcsr;
 477
 478                 err = ~(mxcsr >> 7) & mxcsr;
 479         }
 480
 481         if (err & 0x001) {      /* Invalid op */
 482                 /*
 483                  * swd & 0x240 == 0x040: Stack Underflow
 484                  * swd & 0x240 == 0x240: Stack Overflow
 485                  * User must clear the SF bit (0x40) if set
 486                  */
 487                 return FPE_FLTINV;
 488         } else if (err & 0x004) { /* Divide by Zero */
 489                 return FPE_FLTDIV;
 490         } else if (err & 0x008) { /* Overflow */
 491                 return FPE_FLTOVF;
 492         } else if (err & 0x012) { /* Denormal, Underflow */
 493                 return FPE_FLTUND;
 494         } else if (err & 0x020) { /* Precision */
 495                 return FPE_FLTRES;
 496         }
 497
 498         /*
 499          * If we're using IRQ 13, or supposedly even some trap
 500          * X86_TRAP_MF implementations, it's possible
 501          * we get a spurious trap, which is not an error.
 502          */
 503         return 0;
 504 }