x86/fpu: Optimize fpu__save()
[firefly-linux-kernel-4.4.55.git] / 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 <linux/hardirq.h>
10
11 /*
12  * Track whether the kernel is using the FPU state
13  * currently.
14  *
15  * This flag is used:
16  *
17  *   - by IRQ context code to potentially use the FPU
18  *     if it's unused.
19  *
20  *   - to debug kernel_fpu_begin()/end() correctness
21  */
22 static DEFINE_PER_CPU(bool, in_kernel_fpu);
23
24 /*
25  * Track which context is using the FPU on the CPU:
26  */
27 DEFINE_PER_CPU(struct fpu *, fpu_fpregs_owner_ctx);
28
29 static void kernel_fpu_disable(void)
30 {
31         WARN_ON(this_cpu_read(in_kernel_fpu));
32         this_cpu_write(in_kernel_fpu, true);
33 }
34
35 static void kernel_fpu_enable(void)
36 {
37         WARN_ON_ONCE(!this_cpu_read(in_kernel_fpu));
38         this_cpu_write(in_kernel_fpu, false);
39 }
40
41 static bool kernel_fpu_disabled(void)
42 {
43         return this_cpu_read(in_kernel_fpu);
44 }
45
46 /*
47  * Were we in an interrupt that interrupted kernel mode?
48  *
49  * On others, we can do a kernel_fpu_begin/end() pair *ONLY* if that
50  * pair does nothing at all: the thread must not have fpu (so
51  * that we don't try to save the FPU state), and TS must
52  * be set (so that the clts/stts pair does nothing that is
53  * visible in the interrupted kernel thread).
54  *
55  * Except for the eagerfpu case when we return true; in the likely case
56  * the thread has FPU but we are not going to set/clear TS.
57  */
58 static bool interrupted_kernel_fpu_idle(void)
59 {
60         if (kernel_fpu_disabled())
61                 return false;
62
63         if (use_eager_fpu())
64                 return true;
65
66         return !current->thread.fpu.fpregs_active && (read_cr0() & X86_CR0_TS);
67 }
68
69 /*
70  * Were we in user mode (or vm86 mode) when we were
71  * interrupted?
72  *
73  * Doing kernel_fpu_begin/end() is ok if we are running
74  * in an interrupt context from user mode - we'll just
75  * save the FPU state as required.
76  */
77 static bool interrupted_user_mode(void)
78 {
79         struct pt_regs *regs = get_irq_regs();
80         return regs && user_mode(regs);
81 }
82
83 /*
84  * Can we use the FPU in kernel mode with the
85  * whole "kernel_fpu_begin/end()" sequence?
86  *
87  * It's always ok in process context (ie "not interrupt")
88  * but it is sometimes ok even from an irq.
89  */
90 bool irq_fpu_usable(void)
91 {
92         return !in_interrupt() ||
93                 interrupted_user_mode() ||
94                 interrupted_kernel_fpu_idle();
95 }
96 EXPORT_SYMBOL(irq_fpu_usable);
97
98 void __kernel_fpu_begin(void)
99 {
100         struct fpu *fpu = &current->thread.fpu;
101
102         kernel_fpu_disable();
103
104         if (fpu->fpregs_active) {
105                 copy_fpregs_to_fpstate(fpu);
106         } else {
107                 this_cpu_write(fpu_fpregs_owner_ctx, NULL);
108                 __fpregs_activate_hw();
109         }
110 }
111 EXPORT_SYMBOL(__kernel_fpu_begin);
112
113 void __kernel_fpu_end(void)
114 {
115         struct fpu *fpu = &current->thread.fpu;
116
117         if (fpu->fpregs_active) {
118                 if (WARN_ON(restore_fpu_checking(fpu)))
119                         fpu_reset_state(fpu);
120         } else {
121                 __fpregs_deactivate_hw();
122         }
123
124         kernel_fpu_enable();
125 }
126 EXPORT_SYMBOL(__kernel_fpu_end);
127
128 void kernel_fpu_begin(void)
129 {
130         preempt_disable();
131         WARN_ON_ONCE(!irq_fpu_usable());
132         __kernel_fpu_begin();
133 }
134 EXPORT_SYMBOL_GPL(kernel_fpu_begin);
135
136 void kernel_fpu_end(void)
137 {
138         __kernel_fpu_end();
139         preempt_enable();
140 }
141 EXPORT_SYMBOL_GPL(kernel_fpu_end);
142
143 /*
144  * CR0::TS save/restore functions:
145  */
146 int irq_ts_save(void)
147 {
148         /*
149          * If in process context and not atomic, we can take a spurious DNA fault.
150          * Otherwise, doing clts() in process context requires disabling preemption
151          * or some heavy lifting like kernel_fpu_begin()
152          */
153         if (!in_atomic())
154                 return 0;
155
156         if (read_cr0() & X86_CR0_TS) {
157                 clts();
158                 return 1;
159         }
160
161         return 0;
162 }
163 EXPORT_SYMBOL_GPL(irq_ts_save);
164
165 void irq_ts_restore(int TS_state)
166 {
167         if (TS_state)
168                 stts();
169 }
170 EXPORT_SYMBOL_GPL(irq_ts_restore);
171
172 /*
173  * Save the FPU state (mark it for reload if necessary):
174  *
175  * This only ever gets called for the current task.
176  */
177 void fpu__save(struct fpu *fpu)
178 {
179         WARN_ON(fpu != &current->thread.fpu);
180
181         preempt_disable();
182         if (fpu->fpregs_active) {
183                 if (!copy_fpregs_to_fpstate(fpu))
184                         fpregs_deactivate(fpu);
185         }
186         preempt_enable();
187 }
188 EXPORT_SYMBOL_GPL(fpu__save);
189
190 void fpstate_init(struct fpu *fpu)
191 {
192         if (!cpu_has_fpu) {
193                 finit_soft_fpu(&fpu->state.soft);
194                 return;
195         }
196
197         memset(&fpu->state, 0, xstate_size);
198
199         if (cpu_has_fxsr) {
200                 fx_finit(&fpu->state.fxsave);
201         } else {
202                 struct i387_fsave_struct *fp = &fpu->state.fsave;
203                 fp->cwd = 0xffff037fu;
204                 fp->swd = 0xffff0000u;
205                 fp->twd = 0xffffffffu;
206                 fp->fos = 0xffff0000u;
207         }
208 }
209 EXPORT_SYMBOL_GPL(fpstate_init);
210
211 /*
212  * Copy the current task's FPU state to a new task's FPU context.
213  *
214  * In the 'eager' case we just save to the destination context.
215  *
216  * In the 'lazy' case we save to the source context, mark the FPU lazy
217  * via stts() and copy the source context into the destination context.
218  */
219 static void fpu_copy(struct fpu *dst_fpu, struct fpu *src_fpu)
220 {
221         WARN_ON(src_fpu != &current->thread.fpu);
222
223         if (use_eager_fpu()) {
224                 memset(&dst_fpu->state.xsave, 0, xstate_size);
225                 copy_fpregs_to_fpstate(dst_fpu);
226         } else {
227                 fpu__save(src_fpu);
228                 memcpy(&dst_fpu->state, &src_fpu->state, xstate_size);
229         }
230 }
231
232 int fpu__copy(struct fpu *dst_fpu, struct fpu *src_fpu)
233 {
234         dst_fpu->counter = 0;
235         dst_fpu->fpregs_active = 0;
236         dst_fpu->last_cpu = -1;
237
238         if (src_fpu->fpstate_active)
239                 fpu_copy(dst_fpu, src_fpu);
240
241         return 0;
242 }
243
244 /*
245  * Activate the current task's in-memory FPU context,
246  * if it has not been used before:
247  */
248 void fpu__activate_curr(struct fpu *fpu)
249 {
250         WARN_ON_ONCE(fpu != &current->thread.fpu);
251
252         if (!fpu->fpstate_active) {
253                 fpstate_init(fpu);
254
255                 /* Safe to do for the current task: */
256                 fpu->fpstate_active = 1;
257         }
258 }
259 EXPORT_SYMBOL_GPL(fpu__activate_curr);
260
261 /*
262  * This function must be called before we modify a stopped child's
263  * fpstate.
264  *
265  * If the child has not used the FPU before then initialize its
266  * fpstate.
267  *
268  * If the child has used the FPU before then unlazy it.
269  *
270  * [ After this function call, after registers in the fpstate are
271  *   modified and the child task has woken up, the child task will
272  *   restore the modified FPU state from the modified context. If we
273  *   didn't clear its lazy status here then the lazy in-registers
274  *   state pending on its former CPU could be restored, corrupting
275  *   the modifications. ]
276  *
277  * This function is also called before we read a stopped child's
278  * FPU state - to make sure it's initialized if the child has
279  * no active FPU state.
280  *
281  * TODO: A future optimization would be to skip the unlazying in
282  *       the read-only case, it's not strictly necessary for
283  *       read-only access to the context.
284  */
285 static void fpu__activate_stopped(struct fpu *child_fpu)
286 {
287         WARN_ON_ONCE(child_fpu == &current->thread.fpu);
288
289         if (child_fpu->fpstate_active) {
290                 child_fpu->last_cpu = -1;
291         } else {
292                 fpstate_init(child_fpu);
293
294                 /* Safe to do for stopped child tasks: */
295                 child_fpu->fpstate_active = 1;
296         }
297 }
298
299 /*
300  * 'fpu__restore()' saves the current math information in the
301  * old math state array, and gets the new ones from the current task
302  *
303  * Careful.. There are problems with IBM-designed IRQ13 behaviour.
304  * Don't touch unless you *really* know how it works.
305  *
306  * Must be called with kernel preemption disabled (eg with local
307  * local interrupts as in the case of do_device_not_available).
308  */
309 void fpu__restore(void)
310 {
311         struct task_struct *tsk = current;
312         struct fpu *fpu = &tsk->thread.fpu;
313
314         fpu__activate_curr(fpu);
315
316         /* Avoid __kernel_fpu_begin() right after fpregs_activate() */
317         kernel_fpu_disable();
318         fpregs_activate(fpu);
319         if (unlikely(restore_fpu_checking(fpu))) {
320                 fpu_reset_state(fpu);
321                 force_sig_info(SIGSEGV, SEND_SIG_PRIV, tsk);
322         } else {
323                 tsk->thread.fpu.counter++;
324         }
325         kernel_fpu_enable();
326 }
327 EXPORT_SYMBOL_GPL(fpu__restore);
328
329 void fpu__clear(struct task_struct *tsk)
330 {
331         struct fpu *fpu = &tsk->thread.fpu;
332
333         WARN_ON_ONCE(tsk != current); /* Almost certainly an anomaly */
334
335         if (!use_eager_fpu()) {
336                 /* FPU state will be reallocated lazily at the first use. */
337                 drop_fpu(fpu);
338         } else {
339                 if (!fpu->fpstate_active) {
340                         fpu__activate_curr(fpu);
341                         user_fpu_begin();
342                 }
343                 restore_init_xstate();
344         }
345 }
346
347 /*
348  * The xstateregs_active() routine is the same as the regset_fpregs_active() routine,
349  * as the "regset->n" for the xstate regset will be updated based on the feature
350  * capabilites supported by the xsave.
351  */
352 int regset_fpregs_active(struct task_struct *target, const struct user_regset *regset)
353 {
354         struct fpu *target_fpu = &target->thread.fpu;
355
356         return target_fpu->fpstate_active ? regset->n : 0;
357 }
358
359 int regset_xregset_fpregs_active(struct task_struct *target, const struct user_regset *regset)
360 {
361         struct fpu *target_fpu = &target->thread.fpu;
362
363         return (cpu_has_fxsr && target_fpu->fpstate_active) ? regset->n : 0;
364 }
365
366 int xfpregs_get(struct task_struct *target, const struct user_regset *regset,
367                 unsigned int pos, unsigned int count,
368                 void *kbuf, void __user *ubuf)
369 {
370         struct fpu *fpu = &target->thread.fpu;
371
372         if (!cpu_has_fxsr)
373                 return -ENODEV;
374
375         fpu__activate_stopped(fpu);
376         sanitize_i387_state(target);
377
378         return user_regset_copyout(&pos, &count, &kbuf, &ubuf,
379                                    &fpu->state.fxsave, 0, -1);
380 }
381
382 int xfpregs_set(struct task_struct *target, const struct user_regset *regset,
383                 unsigned int pos, unsigned int count,
384                 const void *kbuf, const void __user *ubuf)
385 {
386         struct fpu *fpu = &target->thread.fpu;
387         int ret;
388
389         if (!cpu_has_fxsr)
390                 return -ENODEV;
391
392         fpu__activate_stopped(fpu);
393         sanitize_i387_state(target);
394
395         ret = user_regset_copyin(&pos, &count, &kbuf, &ubuf,
396                                  &fpu->state.fxsave, 0, -1);
397
398         /*
399          * mxcsr reserved bits must be masked to zero for security reasons.
400          */
401         fpu->state.fxsave.mxcsr &= mxcsr_feature_mask;
402
403         /*
404          * update the header bits in the xsave header, indicating the
405          * presence of FP and SSE state.
406          */
407         if (cpu_has_xsave)
408                 fpu->state.xsave.header.xfeatures |= XSTATE_FPSSE;
409
410         return ret;
411 }
412
413 int xstateregs_get(struct task_struct *target, const struct user_regset *regset,
414                 unsigned int pos, unsigned int count,
415                 void *kbuf, void __user *ubuf)
416 {
417         struct fpu *fpu = &target->thread.fpu;
418         struct xsave_struct *xsave;
419         int ret;
420
421         if (!cpu_has_xsave)
422                 return -ENODEV;
423
424         fpu__activate_stopped(fpu);
425
426         xsave = &fpu->state.xsave;
427
428         /*
429          * Copy the 48bytes defined by the software first into the xstate
430          * memory layout in the thread struct, so that we can copy the entire
431          * xstateregs to the user using one user_regset_copyout().
432          */
433         memcpy(&xsave->i387.sw_reserved,
434                 xstate_fx_sw_bytes, sizeof(xstate_fx_sw_bytes));
435         /*
436          * Copy the xstate memory layout.
437          */
438         ret = user_regset_copyout(&pos, &count, &kbuf, &ubuf, xsave, 0, -1);
439         return ret;
440 }
441
442 int xstateregs_set(struct task_struct *target, const struct user_regset *regset,
443                   unsigned int pos, unsigned int count,
444                   const void *kbuf, const void __user *ubuf)
445 {
446         struct fpu *fpu = &target->thread.fpu;
447         struct xsave_struct *xsave;
448         int ret;
449
450         if (!cpu_has_xsave)
451                 return -ENODEV;
452
453         fpu__activate_stopped(fpu);
454
455         xsave = &fpu->state.xsave;
456
457         ret = user_regset_copyin(&pos, &count, &kbuf, &ubuf, xsave, 0, -1);
458         /*
459          * mxcsr reserved bits must be masked to zero for security reasons.
460          */
461         xsave->i387.mxcsr &= mxcsr_feature_mask;
462         xsave->header.xfeatures &= xfeatures_mask;
463         /*
464          * These bits must be zero.
465          */
466         memset(&xsave->header.reserved, 0, 48);
467
468         return ret;
469 }
470
471 #if defined CONFIG_X86_32 || defined CONFIG_IA32_EMULATION
472
473 /*
474  * FPU tag word conversions.
475  */
476
477 static inline unsigned short twd_i387_to_fxsr(unsigned short twd)
478 {
479         unsigned int tmp; /* to avoid 16 bit prefixes in the code */
480
481         /* Transform each pair of bits into 01 (valid) or 00 (empty) */
482         tmp = ~twd;
483         tmp = (tmp | (tmp>>1)) & 0x5555; /* 0V0V0V0V0V0V0V0V */
484         /* and move the valid bits to the lower byte. */
485         tmp = (tmp | (tmp >> 1)) & 0x3333; /* 00VV00VV00VV00VV */
486         tmp = (tmp | (tmp >> 2)) & 0x0f0f; /* 0000VVVV0000VVVV */
487         tmp = (tmp | (tmp >> 4)) & 0x00ff; /* 00000000VVVVVVVV */
488
489         return tmp;
490 }
491
492 #define FPREG_ADDR(f, n)        ((void *)&(f)->st_space + (n) * 16)
493 #define FP_EXP_TAG_VALID        0
494 #define FP_EXP_TAG_ZERO         1
495 #define FP_EXP_TAG_SPECIAL      2
496 #define FP_EXP_TAG_EMPTY        3
497
498 static inline u32 twd_fxsr_to_i387(struct i387_fxsave_struct *fxsave)
499 {
500         struct _fpxreg *st;
501         u32 tos = (fxsave->swd >> 11) & 7;
502         u32 twd = (unsigned long) fxsave->twd;
503         u32 tag;
504         u32 ret = 0xffff0000u;
505         int i;
506
507         for (i = 0; i < 8; i++, twd >>= 1) {
508                 if (twd & 0x1) {
509                         st = FPREG_ADDR(fxsave, (i - tos) & 7);
510
511                         switch (st->exponent & 0x7fff) {
512                         case 0x7fff:
513                                 tag = FP_EXP_TAG_SPECIAL;
514                                 break;
515                         case 0x0000:
516                                 if (!st->significand[0] &&
517                                     !st->significand[1] &&
518                                     !st->significand[2] &&
519                                     !st->significand[3])
520                                         tag = FP_EXP_TAG_ZERO;
521                                 else
522                                         tag = FP_EXP_TAG_SPECIAL;
523                                 break;
524                         default:
525                                 if (st->significand[3] & 0x8000)
526                                         tag = FP_EXP_TAG_VALID;
527                                 else
528                                         tag = FP_EXP_TAG_SPECIAL;
529                                 break;
530                         }
531                 } else {
532                         tag = FP_EXP_TAG_EMPTY;
533                 }
534                 ret |= tag << (2 * i);
535         }
536         return ret;
537 }
538
539 /*
540  * FXSR floating point environment conversions.
541  */
542
543 void
544 convert_from_fxsr(struct user_i387_ia32_struct *env, struct task_struct *tsk)
545 {
546         struct i387_fxsave_struct *fxsave = &tsk->thread.fpu.state.fxsave;
547         struct _fpreg *to = (struct _fpreg *) &env->st_space[0];
548         struct _fpxreg *from = (struct _fpxreg *) &fxsave->st_space[0];
549         int i;
550
551         env->cwd = fxsave->cwd | 0xffff0000u;
552         env->swd = fxsave->swd | 0xffff0000u;
553         env->twd = twd_fxsr_to_i387(fxsave);
554
555 #ifdef CONFIG_X86_64
556         env->fip = fxsave->rip;
557         env->foo = fxsave->rdp;
558         /*
559          * should be actually ds/cs at fpu exception time, but
560          * that information is not available in 64bit mode.
561          */
562         env->fcs = task_pt_regs(tsk)->cs;
563         if (tsk == current) {
564                 savesegment(ds, env->fos);
565         } else {
566                 env->fos = tsk->thread.ds;
567         }
568         env->fos |= 0xffff0000;
569 #else
570         env->fip = fxsave->fip;
571         env->fcs = (u16) fxsave->fcs | ((u32) fxsave->fop << 16);
572         env->foo = fxsave->foo;
573         env->fos = fxsave->fos;
574 #endif
575
576         for (i = 0; i < 8; ++i)
577                 memcpy(&to[i], &from[i], sizeof(to[0]));
578 }
579
580 void convert_to_fxsr(struct task_struct *tsk,
581                      const struct user_i387_ia32_struct *env)
582
583 {
584         struct i387_fxsave_struct *fxsave = &tsk->thread.fpu.state.fxsave;
585         struct _fpreg *from = (struct _fpreg *) &env->st_space[0];
586         struct _fpxreg *to = (struct _fpxreg *) &fxsave->st_space[0];
587         int i;
588
589         fxsave->cwd = env->cwd;
590         fxsave->swd = env->swd;
591         fxsave->twd = twd_i387_to_fxsr(env->twd);
592         fxsave->fop = (u16) ((u32) env->fcs >> 16);
593 #ifdef CONFIG_X86_64
594         fxsave->rip = env->fip;
595         fxsave->rdp = env->foo;
596         /* cs and ds ignored */
597 #else
598         fxsave->fip = env->fip;
599         fxsave->fcs = (env->fcs & 0xffff);
600         fxsave->foo = env->foo;
601         fxsave->fos = env->fos;
602 #endif
603
604         for (i = 0; i < 8; ++i)
605                 memcpy(&to[i], &from[i], sizeof(from[0]));
606 }
607
608 int fpregs_get(struct task_struct *target, const struct user_regset *regset,
609                unsigned int pos, unsigned int count,
610                void *kbuf, void __user *ubuf)
611 {
612         struct fpu *fpu = &target->thread.fpu;
613         struct user_i387_ia32_struct env;
614
615         fpu__activate_stopped(fpu);
616
617         if (!static_cpu_has(X86_FEATURE_FPU))
618                 return fpregs_soft_get(target, regset, pos, count, kbuf, ubuf);
619
620         if (!cpu_has_fxsr)
621                 return user_regset_copyout(&pos, &count, &kbuf, &ubuf,
622                                            &fpu->state.fsave, 0,
623                                            -1);
624
625         sanitize_i387_state(target);
626
627         if (kbuf && pos == 0 && count == sizeof(env)) {
628                 convert_from_fxsr(kbuf, target);
629                 return 0;
630         }
631
632         convert_from_fxsr(&env, target);
633
634         return user_regset_copyout(&pos, &count, &kbuf, &ubuf, &env, 0, -1);
635 }
636
637 int fpregs_set(struct task_struct *target, const struct user_regset *regset,
638                unsigned int pos, unsigned int count,
639                const void *kbuf, const void __user *ubuf)
640 {
641         struct fpu *fpu = &target->thread.fpu;
642         struct user_i387_ia32_struct env;
643         int ret;
644
645         fpu__activate_stopped(fpu);
646
647         sanitize_i387_state(target);
648
649         if (!static_cpu_has(X86_FEATURE_FPU))
650                 return fpregs_soft_set(target, regset, pos, count, kbuf, ubuf);
651
652         if (!cpu_has_fxsr)
653                 return user_regset_copyin(&pos, &count, &kbuf, &ubuf,
654                                           &fpu->state.fsave, 0,
655                                           -1);
656
657         if (pos > 0 || count < sizeof(env))
658                 convert_from_fxsr(&env, target);
659
660         ret = user_regset_copyin(&pos, &count, &kbuf, &ubuf, &env, 0, -1);
661         if (!ret)
662                 convert_to_fxsr(target, &env);
663
664         /*
665          * update the header bit in the xsave header, indicating the
666          * presence of FP.
667          */
668         if (cpu_has_xsave)
669                 fpu->state.xsave.header.xfeatures |= XSTATE_FP;
670         return ret;
671 }
672
673 /*
674  * FPU state for core dumps.
675  * This is only used for a.out dumps now.
676  * It is declared generically using elf_fpregset_t (which is
677  * struct user_i387_struct) but is in fact only used for 32-bit
678  * dumps, so on 64-bit it is really struct user_i387_ia32_struct.
679  */
680 int dump_fpu(struct pt_regs *regs, struct user_i387_struct *ufpu)
681 {
682         struct task_struct *tsk = current;
683         struct fpu *fpu = &tsk->thread.fpu;
684         int fpvalid;
685
686         fpvalid = fpu->fpstate_active;
687         if (fpvalid)
688                 fpvalid = !fpregs_get(tsk, NULL,
689                                       0, sizeof(struct user_i387_ia32_struct),
690                                       ufpu, NULL);
691
692         return fpvalid;
693 }
694 EXPORT_SYMBOL(dump_fpu);
695
696 #endif  /* CONFIG_X86_32 || CONFIG_IA32_EMULATION */