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