]> asedeno.scripts.mit.edu Git - linux.git/blob - arch/x86/include/asm/fpu/internal.h
PM / QoS: Remove global notifiers
[linux.git] / arch / x86 / include / asm / fpu / internal.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_FPU_INTERNAL_H
11 #define _ASM_X86_FPU_INTERNAL_H
12
13 #include <linux/compat.h>
14 #include <linux/sched.h>
15 #include <linux/slab.h>
16
17 #include <asm/user.h>
18 #include <asm/fpu/api.h>
19 #include <asm/fpu/xstate.h>
20 #include <asm/cpufeature.h>
21 #include <asm/trace/fpu.h>
22
23 /*
24  * High level FPU state handling functions:
25  */
26 extern void fpu__activate_curr(struct fpu *fpu);
27 extern void fpu__activate_fpstate_read(struct fpu *fpu);
28 extern void fpu__activate_fpstate_write(struct fpu *fpu);
29 extern void fpu__current_fpstate_write_begin(void);
30 extern void fpu__current_fpstate_write_end(void);
31 extern void fpu__save(struct fpu *fpu);
32 extern void fpu__restore(struct fpu *fpu);
33 extern int  fpu__restore_sig(void __user *buf, int ia32_frame);
34 extern void fpu__drop(struct fpu *fpu);
35 extern int  fpu__copy(struct fpu *dst_fpu, struct fpu *src_fpu);
36 extern void fpu__clear(struct fpu *fpu);
37 extern int  fpu__exception_code(struct fpu *fpu, int trap_nr);
38 extern int  dump_fpu(struct pt_regs *ptregs, struct user_i387_struct *fpstate);
39
40 /*
41  * Boot time FPU initialization functions:
42  */
43 extern void fpu__init_cpu(void);
44 extern void fpu__init_system_xstate(void);
45 extern void fpu__init_cpu_xstate(void);
46 extern void fpu__init_system(struct cpuinfo_x86 *c);
47 extern void fpu__init_check_bugs(void);
48 extern void fpu__resume_cpu(void);
49 extern u64 fpu__get_supported_xfeatures_mask(void);
50
51 /*
52  * Debugging facility:
53  */
54 #ifdef CONFIG_X86_DEBUG_FPU
55 # define WARN_ON_FPU(x) WARN_ON_ONCE(x)
56 #else
57 # define WARN_ON_FPU(x) ({ (void)(x); 0; })
58 #endif
59
60 /*
61  * FPU related CPU feature flag helper routines:
62  */
63 static __always_inline __pure bool use_xsaveopt(void)
64 {
65         return static_cpu_has(X86_FEATURE_XSAVEOPT);
66 }
67
68 static __always_inline __pure bool use_xsave(void)
69 {
70         return static_cpu_has(X86_FEATURE_XSAVE);
71 }
72
73 static __always_inline __pure bool use_fxsr(void)
74 {
75         return static_cpu_has(X86_FEATURE_FXSR);
76 }
77
78 /*
79  * fpstate handling functions:
80  */
81
82 extern union fpregs_state init_fpstate;
83
84 extern void fpstate_init(union fpregs_state *state);
85 #ifdef CONFIG_MATH_EMULATION
86 extern void fpstate_init_soft(struct swregs_state *soft);
87 #else
88 static inline void fpstate_init_soft(struct swregs_state *soft) {}
89 #endif
90 static inline void fpstate_init_fxstate(struct fxregs_state *fx)
91 {
92         fx->cwd = 0x37f;
93         fx->mxcsr = MXCSR_DEFAULT;
94 }
95 extern void fpstate_sanitize_xstate(struct fpu *fpu);
96
97 #define user_insn(insn, output, input...)                               \
98 ({                                                                      \
99         int err;                                                        \
100         asm volatile(ASM_STAC "\n"                                      \
101                      "1:" #insn "\n\t"                                  \
102                      "2: " ASM_CLAC "\n"                                \
103                      ".section .fixup,\"ax\"\n"                         \
104                      "3:  movl $-1,%[err]\n"                            \
105                      "    jmp  2b\n"                                    \
106                      ".previous\n"                                      \
107                      _ASM_EXTABLE(1b, 3b)                               \
108                      : [err] "=r" (err), output                         \
109                      : "0"(0), input);                                  \
110         err;                                                            \
111 })
112
113 #define check_insn(insn, output, input...)                              \
114 ({                                                                      \
115         int err;                                                        \
116         asm volatile("1:" #insn "\n\t"                                  \
117                      "2:\n"                                             \
118                      ".section .fixup,\"ax\"\n"                         \
119                      "3:  movl $-1,%[err]\n"                            \
120                      "    jmp  2b\n"                                    \
121                      ".previous\n"                                      \
122                      _ASM_EXTABLE(1b, 3b)                               \
123                      : [err] "=r" (err), output                         \
124                      : "0"(0), input);                                  \
125         err;                                                            \
126 })
127
128 static inline int copy_fregs_to_user(struct fregs_state __user *fx)
129 {
130         return user_insn(fnsave %[fx]; fwait,  [fx] "=m" (*fx), "m" (*fx));
131 }
132
133 static inline int copy_fxregs_to_user(struct fxregs_state __user *fx)
134 {
135         if (IS_ENABLED(CONFIG_X86_32))
136                 return user_insn(fxsave %[fx], [fx] "=m" (*fx), "m" (*fx));
137         else if (IS_ENABLED(CONFIG_AS_FXSAVEQ))
138                 return user_insn(fxsaveq %[fx], [fx] "=m" (*fx), "m" (*fx));
139
140         /* See comment in copy_fxregs_to_kernel() below. */
141         return user_insn(rex64/fxsave (%[fx]), "=m" (*fx), [fx] "R" (fx));
142 }
143
144 static inline void copy_kernel_to_fxregs(struct fxregs_state *fx)
145 {
146         int err;
147
148         if (IS_ENABLED(CONFIG_X86_32)) {
149                 err = check_insn(fxrstor %[fx], "=m" (*fx), [fx] "m" (*fx));
150         } else {
151                 if (IS_ENABLED(CONFIG_AS_FXSAVEQ)) {
152                         err = check_insn(fxrstorq %[fx], "=m" (*fx), [fx] "m" (*fx));
153                 } else {
154                         /* See comment in copy_fxregs_to_kernel() below. */
155                         err = check_insn(rex64/fxrstor (%[fx]), "=m" (*fx), [fx] "R" (fx), "m" (*fx));
156                 }
157         }
158         /* Copying from a kernel buffer to FPU registers should never fail: */
159         WARN_ON_FPU(err);
160 }
161
162 static inline int copy_user_to_fxregs(struct fxregs_state __user *fx)
163 {
164         if (IS_ENABLED(CONFIG_X86_32))
165                 return user_insn(fxrstor %[fx], "=m" (*fx), [fx] "m" (*fx));
166         else if (IS_ENABLED(CONFIG_AS_FXSAVEQ))
167                 return user_insn(fxrstorq %[fx], "=m" (*fx), [fx] "m" (*fx));
168
169         /* See comment in copy_fxregs_to_kernel() below. */
170         return user_insn(rex64/fxrstor (%[fx]), "=m" (*fx), [fx] "R" (fx),
171                           "m" (*fx));
172 }
173
174 static inline void copy_kernel_to_fregs(struct fregs_state *fx)
175 {
176         int err = check_insn(frstor %[fx], "=m" (*fx), [fx] "m" (*fx));
177
178         WARN_ON_FPU(err);
179 }
180
181 static inline int copy_user_to_fregs(struct fregs_state __user *fx)
182 {
183         return user_insn(frstor %[fx], "=m" (*fx), [fx] "m" (*fx));
184 }
185
186 static inline void copy_fxregs_to_kernel(struct fpu *fpu)
187 {
188         if (IS_ENABLED(CONFIG_X86_32))
189                 asm volatile( "fxsave %[fx]" : [fx] "=m" (fpu->state.fxsave));
190         else if (IS_ENABLED(CONFIG_AS_FXSAVEQ))
191                 asm volatile("fxsaveq %[fx]" : [fx] "=m" (fpu->state.fxsave));
192         else {
193                 /* Using "rex64; fxsave %0" is broken because, if the memory
194                  * operand uses any extended registers for addressing, a second
195                  * REX prefix will be generated (to the assembler, rex64
196                  * followed by semicolon is a separate instruction), and hence
197                  * the 64-bitness is lost.
198                  *
199                  * Using "fxsaveq %0" would be the ideal choice, but is only
200                  * supported starting with gas 2.16.
201                  *
202                  * Using, as a workaround, the properly prefixed form below
203                  * isn't accepted by any binutils version so far released,
204                  * complaining that the same type of prefix is used twice if
205                  * an extended register is needed for addressing (fix submitted
206                  * to mainline 2005-11-21).
207                  *
208                  *  asm volatile("rex64/fxsave %0" : "=m" (fpu->state.fxsave));
209                  *
210                  * This, however, we can work around by forcing the compiler to
211                  * select an addressing mode that doesn't require extended
212                  * registers.
213                  */
214                 asm volatile( "rex64/fxsave (%[fx])"
215                              : "=m" (fpu->state.fxsave)
216                              : [fx] "R" (&fpu->state.fxsave));
217         }
218 }
219
220 /* These macros all use (%edi)/(%rdi) as the single memory argument. */
221 #define XSAVE           ".byte " REX_PREFIX "0x0f,0xae,0x27"
222 #define XSAVEOPT        ".byte " REX_PREFIX "0x0f,0xae,0x37"
223 #define XSAVES          ".byte " REX_PREFIX "0x0f,0xc7,0x2f"
224 #define XRSTOR          ".byte " REX_PREFIX "0x0f,0xae,0x2f"
225 #define XRSTORS         ".byte " REX_PREFIX "0x0f,0xc7,0x1f"
226
227 #define XSTATE_OP(op, st, lmask, hmask, err)                            \
228         asm volatile("1:" op "\n\t"                                     \
229                      "xor %[err], %[err]\n"                             \
230                      "2:\n\t"                                           \
231                      ".pushsection .fixup,\"ax\"\n\t"                   \
232                      "3: movl $-2,%[err]\n\t"                           \
233                      "jmp 2b\n\t"                                       \
234                      ".popsection\n\t"                                  \
235                      _ASM_EXTABLE(1b, 3b)                               \
236                      : [err] "=r" (err)                                 \
237                      : "D" (st), "m" (*st), "a" (lmask), "d" (hmask)    \
238                      : "memory")
239
240 /*
241  * If XSAVES is enabled, it replaces XSAVEOPT because it supports a compact
242  * format and supervisor states in addition to modified optimization in
243  * XSAVEOPT.
244  *
245  * Otherwise, if XSAVEOPT is enabled, XSAVEOPT replaces XSAVE because XSAVEOPT
246  * supports modified optimization which is not supported by XSAVE.
247  *
248  * We use XSAVE as a fallback.
249  *
250  * The 661 label is defined in the ALTERNATIVE* macros as the address of the
251  * original instruction which gets replaced. We need to use it here as the
252  * address of the instruction where we might get an exception at.
253  */
254 #define XSTATE_XSAVE(st, lmask, hmask, err)                             \
255         asm volatile(ALTERNATIVE_2(XSAVE,                               \
256                                    XSAVEOPT, X86_FEATURE_XSAVEOPT,      \
257                                    XSAVES,   X86_FEATURE_XSAVES)        \
258                      "\n"                                               \
259                      "xor %[err], %[err]\n"                             \
260                      "3:\n"                                             \
261                      ".pushsection .fixup,\"ax\"\n"                     \
262                      "4: movl $-2, %[err]\n"                            \
263                      "jmp 3b\n"                                         \
264                      ".popsection\n"                                    \
265                      _ASM_EXTABLE(661b, 4b)                             \
266                      : [err] "=r" (err)                                 \
267                      : "D" (st), "m" (*st), "a" (lmask), "d" (hmask)    \
268                      : "memory")
269
270 /*
271  * Use XRSTORS to restore context if it is enabled. XRSTORS supports compact
272  * XSAVE area format.
273  */
274 #define XSTATE_XRESTORE(st, lmask, hmask, err)                          \
275         asm volatile(ALTERNATIVE(XRSTOR,                                \
276                                  XRSTORS, X86_FEATURE_XSAVES)           \
277                      "\n"                                               \
278                      "xor %[err], %[err]\n"                             \
279                      "3:\n"                                             \
280                      ".pushsection .fixup,\"ax\"\n"                     \
281                      "4: movl $-2, %[err]\n"                            \
282                      "jmp 3b\n"                                         \
283                      ".popsection\n"                                    \
284                      _ASM_EXTABLE(661b, 4b)                             \
285                      : [err] "=r" (err)                                 \
286                      : "D" (st), "m" (*st), "a" (lmask), "d" (hmask)    \
287                      : "memory")
288
289 /*
290  * This function is called only during boot time when x86 caps are not set
291  * up and alternative can not be used yet.
292  */
293 static inline void copy_xregs_to_kernel_booting(struct xregs_state *xstate)
294 {
295         u64 mask = -1;
296         u32 lmask = mask;
297         u32 hmask = mask >> 32;
298         int err;
299
300         WARN_ON(system_state != SYSTEM_BOOTING);
301
302         if (static_cpu_has(X86_FEATURE_XSAVES))
303                 XSTATE_OP(XSAVES, xstate, lmask, hmask, err);
304         else
305                 XSTATE_OP(XSAVE, xstate, lmask, hmask, err);
306
307         /* We should never fault when copying to a kernel buffer: */
308         WARN_ON_FPU(err);
309 }
310
311 /*
312  * This function is called only during boot time when x86 caps are not set
313  * up and alternative can not be used yet.
314  */
315 static inline void copy_kernel_to_xregs_booting(struct xregs_state *xstate)
316 {
317         u64 mask = -1;
318         u32 lmask = mask;
319         u32 hmask = mask >> 32;
320         int err;
321
322         WARN_ON(system_state != SYSTEM_BOOTING);
323
324         if (static_cpu_has(X86_FEATURE_XSAVES))
325                 XSTATE_OP(XRSTORS, xstate, lmask, hmask, err);
326         else
327                 XSTATE_OP(XRSTOR, xstate, lmask, hmask, err);
328
329         /* We should never fault when copying from a kernel buffer: */
330         WARN_ON_FPU(err);
331 }
332
333 /*
334  * Save processor xstate to xsave area.
335  */
336 static inline void copy_xregs_to_kernel(struct xregs_state *xstate)
337 {
338         u64 mask = -1;
339         u32 lmask = mask;
340         u32 hmask = mask >> 32;
341         int err;
342
343         WARN_ON(!alternatives_patched);
344
345         XSTATE_XSAVE(xstate, lmask, hmask, err);
346
347         /* We should never fault when copying to a kernel buffer: */
348         WARN_ON_FPU(err);
349 }
350
351 /*
352  * Restore processor xstate from xsave area.
353  */
354 static inline void copy_kernel_to_xregs(struct xregs_state *xstate, u64 mask)
355 {
356         u32 lmask = mask;
357         u32 hmask = mask >> 32;
358         int err;
359
360         XSTATE_XRESTORE(xstate, lmask, hmask, err);
361
362         /* We should never fault when copying from a kernel buffer: */
363         WARN_ON_FPU(err);
364 }
365
366 /*
367  * Save xstate to user space xsave area.
368  *
369  * We don't use modified optimization because xrstor/xrstors might track
370  * a different application.
371  *
372  * We don't use compacted format xsave area for
373  * backward compatibility for old applications which don't understand
374  * compacted format of xsave area.
375  */
376 static inline int copy_xregs_to_user(struct xregs_state __user *buf)
377 {
378         int err;
379
380         /*
381          * Clear the xsave header first, so that reserved fields are
382          * initialized to zero.
383          */
384         err = __clear_user(&buf->header, sizeof(buf->header));
385         if (unlikely(err))
386                 return -EFAULT;
387
388         stac();
389         XSTATE_OP(XSAVE, buf, -1, -1, err);
390         clac();
391
392         return err;
393 }
394
395 /*
396  * Restore xstate from user space xsave area.
397  */
398 static inline int copy_user_to_xregs(struct xregs_state __user *buf, u64 mask)
399 {
400         struct xregs_state *xstate = ((__force struct xregs_state *)buf);
401         u32 lmask = mask;
402         u32 hmask = mask >> 32;
403         int err;
404
405         stac();
406         XSTATE_OP(XRSTOR, xstate, lmask, hmask, err);
407         clac();
408
409         return err;
410 }
411
412 /*
413  * These must be called with preempt disabled. Returns
414  * 'true' if the FPU state is still intact and we can
415  * keep registers active.
416  *
417  * The legacy FNSAVE instruction cleared all FPU state
418  * unconditionally, so registers are essentially destroyed.
419  * Modern FPU state can be kept in registers, if there are
420  * no pending FP exceptions.
421  */
422 static inline int copy_fpregs_to_fpstate(struct fpu *fpu)
423 {
424         if (likely(use_xsave())) {
425                 copy_xregs_to_kernel(&fpu->state.xsave);
426                 return 1;
427         }
428
429         if (likely(use_fxsr())) {
430                 copy_fxregs_to_kernel(fpu);
431                 return 1;
432         }
433
434         /*
435          * Legacy FPU register saving, FNSAVE always clears FPU registers,
436          * so we have to mark them inactive:
437          */
438         asm volatile("fnsave %[fp]; fwait" : [fp] "=m" (fpu->state.fsave));
439
440         return 0;
441 }
442
443 static inline void __copy_kernel_to_fpregs(union fpregs_state *fpstate)
444 {
445         if (use_xsave()) {
446                 copy_kernel_to_xregs(&fpstate->xsave, -1);
447         } else {
448                 if (use_fxsr())
449                         copy_kernel_to_fxregs(&fpstate->fxsave);
450                 else
451                         copy_kernel_to_fregs(&fpstate->fsave);
452         }
453 }
454
455 static inline void copy_kernel_to_fpregs(union fpregs_state *fpstate)
456 {
457         /*
458          * AMD K7/K8 CPUs don't save/restore FDP/FIP/FOP unless an exception is
459          * pending. Clear the x87 state here by setting it to fixed values.
460          * "m" is a random variable that should be in L1.
461          */
462         if (unlikely(static_cpu_has_bug(X86_BUG_FXSAVE_LEAK))) {
463                 asm volatile(
464                         "fnclex\n\t"
465                         "emms\n\t"
466                         "fildl %P[addr]"        /* set F?P to defined value */
467                         : : [addr] "m" (fpstate));
468         }
469
470         __copy_kernel_to_fpregs(fpstate);
471 }
472
473 extern int copy_fpstate_to_sigframe(void __user *buf, void __user *fp, int size);
474
475 /*
476  * FPU context switch related helper methods:
477  */
478
479 DECLARE_PER_CPU(struct fpu *, fpu_fpregs_owner_ctx);
480
481 /*
482  * The in-register FPU state for an FPU context on a CPU is assumed to be
483  * valid if the fpu->last_cpu matches the CPU, and the fpu_fpregs_owner_ctx
484  * matches the FPU.
485  *
486  * If the FPU register state is valid, the kernel can skip restoring the
487  * FPU state from memory.
488  *
489  * Any code that clobbers the FPU registers or updates the in-memory
490  * FPU state for a task MUST let the rest of the kernel know that the
491  * FPU registers are no longer valid for this task.
492  *
493  * Either one of these invalidation functions is enough. Invalidate
494  * a resource you control: CPU if using the CPU for something else
495  * (with preemption disabled), FPU for the current task, or a task that
496  * is prevented from running by the current task.
497  */
498 static inline void __cpu_invalidate_fpregs_state(void)
499 {
500         __this_cpu_write(fpu_fpregs_owner_ctx, NULL);
501 }
502
503 static inline void __fpu_invalidate_fpregs_state(struct fpu *fpu)
504 {
505         fpu->last_cpu = -1;
506 }
507
508 static inline int fpregs_state_valid(struct fpu *fpu, unsigned int cpu)
509 {
510         return fpu == this_cpu_read_stable(fpu_fpregs_owner_ctx) && cpu == fpu->last_cpu;
511 }
512
513 /*
514  * These generally need preemption protection to work,
515  * do try to avoid using these on their own:
516  */
517 static inline void fpregs_deactivate(struct fpu *fpu)
518 {
519         WARN_ON_FPU(!fpu->fpregs_active);
520
521         fpu->fpregs_active = 0;
522         this_cpu_write(fpu_fpregs_owner_ctx, NULL);
523         trace_x86_fpu_regs_deactivated(fpu);
524 }
525
526 static inline void fpregs_activate(struct fpu *fpu)
527 {
528         WARN_ON_FPU(fpu->fpregs_active);
529
530         fpu->fpregs_active = 1;
531         this_cpu_write(fpu_fpregs_owner_ctx, fpu);
532         trace_x86_fpu_regs_activated(fpu);
533 }
534
535 /*
536  * The question "does this thread have fpu access?"
537  * is slightly racy, since preemption could come in
538  * and revoke it immediately after the test.
539  *
540  * However, even in that very unlikely scenario,
541  * we can just assume we have FPU access - typically
542  * to save the FP state - we'll just take a #NM
543  * fault and get the FPU access back.
544  */
545 static inline int fpregs_active(void)
546 {
547         return current->thread.fpu.fpregs_active;
548 }
549
550 /*
551  * FPU state switching for scheduling.
552  *
553  * This is a two-stage process:
554  *
555  *  - switch_fpu_prepare() saves the old state.
556  *    This is done within the context of the old process.
557  *
558  *  - switch_fpu_finish() restores the new state as
559  *    necessary.
560  */
561 static inline void
562 switch_fpu_prepare(struct fpu *old_fpu, int cpu)
563 {
564         if (old_fpu->fpregs_active) {
565                 if (!copy_fpregs_to_fpstate(old_fpu))
566                         old_fpu->last_cpu = -1;
567                 else
568                         old_fpu->last_cpu = cpu;
569
570                 /* But leave fpu_fpregs_owner_ctx! */
571                 old_fpu->fpregs_active = 0;
572                 trace_x86_fpu_regs_deactivated(old_fpu);
573         } else
574                 old_fpu->last_cpu = -1;
575 }
576
577 /*
578  * Misc helper functions:
579  */
580
581 /*
582  * Set up the userspace FPU context for the new task, if the task
583  * has used the FPU.
584  */
585 static inline void switch_fpu_finish(struct fpu *new_fpu, int cpu)
586 {
587         bool preload = static_cpu_has(X86_FEATURE_FPU) &&
588                        new_fpu->fpstate_active;
589
590         if (preload) {
591                 if (!fpregs_state_valid(new_fpu, cpu))
592                         copy_kernel_to_fpregs(&new_fpu->state);
593                 fpregs_activate(new_fpu);
594         }
595 }
596
597 /*
598  * Needs to be preemption-safe.
599  *
600  * NOTE! user_fpu_begin() must be used only immediately before restoring
601  * the save state. It does not do any saving/restoring on its own. In
602  * lazy FPU mode, it is just an optimization to avoid a #NM exception,
603  * the task can lose the FPU right after preempt_enable().
604  */
605 static inline void user_fpu_begin(void)
606 {
607         struct fpu *fpu = &current->thread.fpu;
608
609         preempt_disable();
610         if (!fpregs_active())
611                 fpregs_activate(fpu);
612         preempt_enable();
613 }
614
615 /*
616  * MXCSR and XCR definitions:
617  */
618
619 extern unsigned int mxcsr_feature_mask;
620
621 #define XCR_XFEATURE_ENABLED_MASK       0x00000000
622
623 static inline u64 xgetbv(u32 index)
624 {
625         u32 eax, edx;
626
627         asm volatile(".byte 0x0f,0x01,0xd0" /* xgetbv */
628                      : "=a" (eax), "=d" (edx)
629                      : "c" (index));
630         return eax + ((u64)edx << 32);
631 }
632
633 static inline void xsetbv(u32 index, u64 value)
634 {
635         u32 eax = value;
636         u32 edx = value >> 32;
637
638         asm volatile(".byte 0x0f,0x01,0xd1" /* xsetbv */
639                      : : "a" (eax), "d" (edx), "c" (index));
640 }
641
642 #endif /* _ASM_X86_FPU_INTERNAL_H */