kernel/npx: Add detection code for default MXCSR mask
[dragonfly.git] / sys / platform / pc64 / x86_64 / npx.c
1 /*
2  * Copyright (c) 1990 William Jolitz.
3  * Copyright (c) 1991 The Regents of the University of California.
4  * Copyright (c) 2006 The DragonFly Project.
5  * Copyright (c) 2006 Matthew Dillon.
6  * All rights reserved.
7  * 
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in
16  *    the documentation and/or other materials provided with the
17  *    distribution.
18  * 3. Neither the name of The DragonFly Project nor the names of its
19  *    contributors may be used to endorse or promote products derived
20  *    from this software without specific, prior written permission.
21  * 
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
26  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  * 
35  * from: @(#)npx.c      7.2 (Berkeley) 5/12/91
36  * $FreeBSD: src/sys/i386/isa/npx.c,v 1.80.2.3 2001/10/20 19:04:38 tegge Exp $
37  */
38
39 #include "opt_cpu.h"
40
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/bus.h>
44 #include <sys/kernel.h>
45 #include <sys/malloc.h>
46 #include <sys/module.h>
47 #include <sys/sysctl.h>
48 #include <sys/proc.h>
49 #include <sys/rman.h>
50 #include <sys/signalvar.h>
51
52 #include <sys/thread2.h>
53 #include <sys/mplock2.h>
54
55 #include <machine/cputypes.h>
56 #include <machine/frame.h>
57 #include <machine/md_var.h>
58 #include <machine/pcb.h>
59 #include <machine/psl.h>
60 #include <machine/specialreg.h>
61 #include <machine/segments.h>
62 #include <machine/globaldata.h>
63
64 #define fldcw(addr)             __asm("fldcw %0" : : "m" (*(addr)))
65 #define fnclex()                __asm("fnclex")
66 #define fninit()                __asm("fninit")
67 #define fnop()                  __asm("fnop")
68 #define fnsave(addr)            __asm __volatile("fnsave %0" : "=m" (*(addr)))
69 #define fnstcw(addr)            __asm __volatile("fnstcw %0" : "=m" (*(addr)))
70 #define fnstsw(addr)            __asm __volatile("fnstsw %0" : "=m" (*(addr)))
71 #define frstor(addr)            __asm("frstor %0" : : "m" (*(addr)))
72 #ifndef CPU_DISABLE_SSE
73 #define fxrstor(addr)           __asm("fxrstor %0" : : "m" (*(addr)))
74 #define fxsave(addr)            __asm __volatile("fxsave %0" : "=m" (*(addr)))
75 #endif
76 #ifndef  CPU_DISABLE_AVX
77 #define xrstor(eax,edx,addr)    __asm __volatile(".byte 0x0f,0xae,0x2f" : : "D" (addr), "a" (eax), "d" (edx))
78 #define xsave(eax,edx,addr)     __asm __volatile(".byte 0x0f,0xae,0x27" : : "D" (addr), "a" (eax), "d" (edx) : "memory")
79 #endif
80 #define start_emulating()       __asm("smsw %%ax; orb %0,%%al; lmsw %%ax" \
81                                       : : "n" (CR0_TS) : "ax")
82 #define stop_emulating()        __asm("clts")
83
84 typedef u_char bool_t;
85 #ifndef CPU_DISABLE_SSE
86 static  void    fpu_clean_state(void);
87 #define ldmxcsr(csr)            __asm __volatile("ldmxcsr %0" : : "m" (csr))
88 #endif
89
90 static struct krate badfprate = { 1 };
91
92 static  void    fpusave         (union savefpu *);
93 static  void    fpurstor        (union savefpu *);
94
95 uint32_t npx_mxcsr_mask = 0xFFBF;       /* this is the default */
96
97 /*
98  * Probe the npx_mxcsr_mask
99  */
100 void npxprobemask(void)
101 {
102         /*64-Byte alignment required for xsave*/
103         static union savefpu dummy __aligned(64);
104
105         crit_enter();
106         stop_emulating();
107         fxsave(&dummy);
108         npx_mxcsr_mask = ((uint32_t *)&dummy)[7];
109         start_emulating();
110         crit_exit();
111 }
112
113 /*
114  * Initialize the floating point unit.
115  */
116 void npxinit(void)
117 {
118         /*64-Byte alignment required for xsave*/
119         static union savefpu dummy __aligned(64);
120         u_short control;
121         u_int mxcsr;
122
123         /*
124          * fninit has the same h/w bugs as fnsave.  Use the detoxified
125          * fnsave to throw away any junk in the fpu.  npxsave() initializes
126          * the fpu and sets npxthread = NULL as important side effects.
127          */
128
129         npxsave(&dummy);
130         crit_enter();
131         stop_emulating();
132         control = __INITIAL_FPUCW__;
133         fldcw(&control);
134
135         mxcsr = __INITIAL_MXCSR__;
136         ldmxcsr(mxcsr);
137
138         fpusave(curthread->td_savefpu);
139         mdcpu->gd_npxthread = NULL;
140         start_emulating();
141         crit_exit();
142 }
143
144 /*
145  * Free coprocessor (if we have it).
146  */
147 void
148 npxexit(void)
149 {
150         if (curthread == mdcpu->gd_npxthread)
151                 npxsave(curthread->td_savefpu);
152 }
153
154 #if 0
155 /* 
156  * The following mechanism is used to ensure that the FPE_... value
157  * that is passed as a trapcode to the signal handler of the user
158  * process does not have more than one bit set.
159  * 
160  * Multiple bits may be set if the user process modifies the control
161  * word while a status word bit is already set.  While this is a sign
162  * of bad coding, we have no choise than to narrow them down to one
163  * bit, since we must not send a trapcode that is not exactly one of
164  * the FPE_ macros.
165  *
166  * The mechanism has a static table with 127 entries.  Each combination
167  * of the 7 FPU status word exception bits directly translates to a
168  * position in this table, where a single FPE_... value is stored.
169  * This FPE_... value stored there is considered the "most important"
170  * of the exception bits and will be sent as the signal code.  The
171  * precedence of the bits is based upon Intel Document "Numerical
172  * Applications", Chapter "Special Computational Situations".
173  *
174  * The macro to choose one of these values does these steps: 1) Throw
175  * away status word bits that cannot be masked.  2) Throw away the bits
176  * currently masked in the control word, assuming the user isn't
177  * interested in them anymore.  3) Reinsert status word bit 7 (stack
178  * fault) if it is set, which cannot be masked but must be presered.
179  * 4) Use the remaining bits to point into the trapcode table.
180  *
181  * The 6 maskable bits in order of their preference, as stated in the
182  * above referenced Intel manual:
183  * 1  Invalid operation (FP_X_INV)
184  * 1a   Stack underflow
185  * 1b   Stack overflow
186  * 1c   Operand of unsupported format
187  * 1d   SNaN operand.
188  * 2  QNaN operand (not an exception, irrelavant here)
189  * 3  Any other invalid-operation not mentioned above or zero divide
190  *      (FP_X_INV, FP_X_DZ)
191  * 4  Denormal operand (FP_X_DNML)
192  * 5  Numeric over/underflow (FP_X_OFL, FP_X_UFL)
193  * 6  Inexact result (FP_X_IMP) 
194  */
195 static char fpetable[128] = {
196         0,
197         FPE_FLTINV,     /*  1 - INV */
198         FPE_FLTUND,     /*  2 - DNML */
199         FPE_FLTINV,     /*  3 - INV | DNML */
200         FPE_FLTDIV,     /*  4 - DZ */
201         FPE_FLTINV,     /*  5 - INV | DZ */
202         FPE_FLTDIV,     /*  6 - DNML | DZ */
203         FPE_FLTINV,     /*  7 - INV | DNML | DZ */
204         FPE_FLTOVF,     /*  8 - OFL */
205         FPE_FLTINV,     /*  9 - INV | OFL */
206         FPE_FLTUND,     /*  A - DNML | OFL */
207         FPE_FLTINV,     /*  B - INV | DNML | OFL */
208         FPE_FLTDIV,     /*  C - DZ | OFL */
209         FPE_FLTINV,     /*  D - INV | DZ | OFL */
210         FPE_FLTDIV,     /*  E - DNML | DZ | OFL */
211         FPE_FLTINV,     /*  F - INV | DNML | DZ | OFL */
212         FPE_FLTUND,     /* 10 - UFL */
213         FPE_FLTINV,     /* 11 - INV | UFL */
214         FPE_FLTUND,     /* 12 - DNML | UFL */
215         FPE_FLTINV,     /* 13 - INV | DNML | UFL */
216         FPE_FLTDIV,     /* 14 - DZ | UFL */
217         FPE_FLTINV,     /* 15 - INV | DZ | UFL */
218         FPE_FLTDIV,     /* 16 - DNML | DZ | UFL */
219         FPE_FLTINV,     /* 17 - INV | DNML | DZ | UFL */
220         FPE_FLTOVF,     /* 18 - OFL | UFL */
221         FPE_FLTINV,     /* 19 - INV | OFL | UFL */
222         FPE_FLTUND,     /* 1A - DNML | OFL | UFL */
223         FPE_FLTINV,     /* 1B - INV | DNML | OFL | UFL */
224         FPE_FLTDIV,     /* 1C - DZ | OFL | UFL */
225         FPE_FLTINV,     /* 1D - INV | DZ | OFL | UFL */
226         FPE_FLTDIV,     /* 1E - DNML | DZ | OFL | UFL */
227         FPE_FLTINV,     /* 1F - INV | DNML | DZ | OFL | UFL */
228         FPE_FLTRES,     /* 20 - IMP */
229         FPE_FLTINV,     /* 21 - INV | IMP */
230         FPE_FLTUND,     /* 22 - DNML | IMP */
231         FPE_FLTINV,     /* 23 - INV | DNML | IMP */
232         FPE_FLTDIV,     /* 24 - DZ | IMP */
233         FPE_FLTINV,     /* 25 - INV | DZ | IMP */
234         FPE_FLTDIV,     /* 26 - DNML | DZ | IMP */
235         FPE_FLTINV,     /* 27 - INV | DNML | DZ | IMP */
236         FPE_FLTOVF,     /* 28 - OFL | IMP */
237         FPE_FLTINV,     /* 29 - INV | OFL | IMP */
238         FPE_FLTUND,     /* 2A - DNML | OFL | IMP */
239         FPE_FLTINV,     /* 2B - INV | DNML | OFL | IMP */
240         FPE_FLTDIV,     /* 2C - DZ | OFL | IMP */
241         FPE_FLTINV,     /* 2D - INV | DZ | OFL | IMP */
242         FPE_FLTDIV,     /* 2E - DNML | DZ | OFL | IMP */
243         FPE_FLTINV,     /* 2F - INV | DNML | DZ | OFL | IMP */
244         FPE_FLTUND,     /* 30 - UFL | IMP */
245         FPE_FLTINV,     /* 31 - INV | UFL | IMP */
246         FPE_FLTUND,     /* 32 - DNML | UFL | IMP */
247         FPE_FLTINV,     /* 33 - INV | DNML | UFL | IMP */
248         FPE_FLTDIV,     /* 34 - DZ | UFL | IMP */
249         FPE_FLTINV,     /* 35 - INV | DZ | UFL | IMP */
250         FPE_FLTDIV,     /* 36 - DNML | DZ | UFL | IMP */
251         FPE_FLTINV,     /* 37 - INV | DNML | DZ | UFL | IMP */
252         FPE_FLTOVF,     /* 38 - OFL | UFL | IMP */
253         FPE_FLTINV,     /* 39 - INV | OFL | UFL | IMP */
254         FPE_FLTUND,     /* 3A - DNML | OFL | UFL | IMP */
255         FPE_FLTINV,     /* 3B - INV | DNML | OFL | UFL | IMP */
256         FPE_FLTDIV,     /* 3C - DZ | OFL | UFL | IMP */
257         FPE_FLTINV,     /* 3D - INV | DZ | OFL | UFL | IMP */
258         FPE_FLTDIV,     /* 3E - DNML | DZ | OFL | UFL | IMP */
259         FPE_FLTINV,     /* 3F - INV | DNML | DZ | OFL | UFL | IMP */
260         FPE_FLTSUB,     /* 40 - STK */
261         FPE_FLTSUB,     /* 41 - INV | STK */
262         FPE_FLTUND,     /* 42 - DNML | STK */
263         FPE_FLTSUB,     /* 43 - INV | DNML | STK */
264         FPE_FLTDIV,     /* 44 - DZ | STK */
265         FPE_FLTSUB,     /* 45 - INV | DZ | STK */
266         FPE_FLTDIV,     /* 46 - DNML | DZ | STK */
267         FPE_FLTSUB,     /* 47 - INV | DNML | DZ | STK */
268         FPE_FLTOVF,     /* 48 - OFL | STK */
269         FPE_FLTSUB,     /* 49 - INV | OFL | STK */
270         FPE_FLTUND,     /* 4A - DNML | OFL | STK */
271         FPE_FLTSUB,     /* 4B - INV | DNML | OFL | STK */
272         FPE_FLTDIV,     /* 4C - DZ | OFL | STK */
273         FPE_FLTSUB,     /* 4D - INV | DZ | OFL | STK */
274         FPE_FLTDIV,     /* 4E - DNML | DZ | OFL | STK */
275         FPE_FLTSUB,     /* 4F - INV | DNML | DZ | OFL | STK */
276         FPE_FLTUND,     /* 50 - UFL | STK */
277         FPE_FLTSUB,     /* 51 - INV | UFL | STK */
278         FPE_FLTUND,     /* 52 - DNML | UFL | STK */
279         FPE_FLTSUB,     /* 53 - INV | DNML | UFL | STK */
280         FPE_FLTDIV,     /* 54 - DZ | UFL | STK */
281         FPE_FLTSUB,     /* 55 - INV | DZ | UFL | STK */
282         FPE_FLTDIV,     /* 56 - DNML | DZ | UFL | STK */
283         FPE_FLTSUB,     /* 57 - INV | DNML | DZ | UFL | STK */
284         FPE_FLTOVF,     /* 58 - OFL | UFL | STK */
285         FPE_FLTSUB,     /* 59 - INV | OFL | UFL | STK */
286         FPE_FLTUND,     /* 5A - DNML | OFL | UFL | STK */
287         FPE_FLTSUB,     /* 5B - INV | DNML | OFL | UFL | STK */
288         FPE_FLTDIV,     /* 5C - DZ | OFL | UFL | STK */
289         FPE_FLTSUB,     /* 5D - INV | DZ | OFL | UFL | STK */
290         FPE_FLTDIV,     /* 5E - DNML | DZ | OFL | UFL | STK */
291         FPE_FLTSUB,     /* 5F - INV | DNML | DZ | OFL | UFL | STK */
292         FPE_FLTRES,     /* 60 - IMP | STK */
293         FPE_FLTSUB,     /* 61 - INV | IMP | STK */
294         FPE_FLTUND,     /* 62 - DNML | IMP | STK */
295         FPE_FLTSUB,     /* 63 - INV | DNML | IMP | STK */
296         FPE_FLTDIV,     /* 64 - DZ | IMP | STK */
297         FPE_FLTSUB,     /* 65 - INV | DZ | IMP | STK */
298         FPE_FLTDIV,     /* 66 - DNML | DZ | IMP | STK */
299         FPE_FLTSUB,     /* 67 - INV | DNML | DZ | IMP | STK */
300         FPE_FLTOVF,     /* 68 - OFL | IMP | STK */
301         FPE_FLTSUB,     /* 69 - INV | OFL | IMP | STK */
302         FPE_FLTUND,     /* 6A - DNML | OFL | IMP | STK */
303         FPE_FLTSUB,     /* 6B - INV | DNML | OFL | IMP | STK */
304         FPE_FLTDIV,     /* 6C - DZ | OFL | IMP | STK */
305         FPE_FLTSUB,     /* 6D - INV | DZ | OFL | IMP | STK */
306         FPE_FLTDIV,     /* 6E - DNML | DZ | OFL | IMP | STK */
307         FPE_FLTSUB,     /* 6F - INV | DNML | DZ | OFL | IMP | STK */
308         FPE_FLTUND,     /* 70 - UFL | IMP | STK */
309         FPE_FLTSUB,     /* 71 - INV | UFL | IMP | STK */
310         FPE_FLTUND,     /* 72 - DNML | UFL | IMP | STK */
311         FPE_FLTSUB,     /* 73 - INV | DNML | UFL | IMP | STK */
312         FPE_FLTDIV,     /* 74 - DZ | UFL | IMP | STK */
313         FPE_FLTSUB,     /* 75 - INV | DZ | UFL | IMP | STK */
314         FPE_FLTDIV,     /* 76 - DNML | DZ | UFL | IMP | STK */
315         FPE_FLTSUB,     /* 77 - INV | DNML | DZ | UFL | IMP | STK */
316         FPE_FLTOVF,     /* 78 - OFL | UFL | IMP | STK */
317         FPE_FLTSUB,     /* 79 - INV | OFL | UFL | IMP | STK */
318         FPE_FLTUND,     /* 7A - DNML | OFL | UFL | IMP | STK */
319         FPE_FLTSUB,     /* 7B - INV | DNML | OFL | UFL | IMP | STK */
320         FPE_FLTDIV,     /* 7C - DZ | OFL | UFL | IMP | STK */
321         FPE_FLTSUB,     /* 7D - INV | DZ | OFL | UFL | IMP | STK */
322         FPE_FLTDIV,     /* 7E - DNML | DZ | OFL | UFL | IMP | STK */
323         FPE_FLTSUB,     /* 7F - INV | DNML | DZ | OFL | UFL | IMP | STK */
324 };
325
326 #endif
327
328 /*
329  * Implement the device not available (DNA) exception.  gd_npxthread had 
330  * better be NULL.  Restore the current thread's FP state and set gd_npxthread
331  * to curthread.
332  *
333  * Interrupts are enabled and preemption can occur.  Enter a critical
334  * section to stabilize the FP state.
335  */
336 int
337 npxdna(void)
338 {
339         thread_t td = curthread;
340         int didinit = 0;
341
342         if (mdcpu->gd_npxthread != NULL) {
343                 kprintf("npxdna: npxthread = %p, curthread = %p\n",
344                        mdcpu->gd_npxthread, curthread);
345                 panic("npxdna");
346         }
347
348         /*
349          * Setup the initial saved state if the thread has never before
350          * used the FP unit.  This also occurs when a thread pushes a
351          * signal handler and uses FP in the handler.
352          */
353         crit_enter();
354         if ((td->td_flags & (TDF_USINGFP | TDF_KERNELFP)) == 0) {
355                 td->td_flags |= TDF_USINGFP;
356                 npxinit();
357                 didinit = 1;
358         }
359
360         /*
361          * The setting of gd_npxthread and the call to fpurstor() must not
362          * be preempted by an interrupt thread or we will take an npxdna
363          * trap and potentially save our current fpstate (which is garbage)
364          * and then restore the garbage rather then the originally saved
365          * fpstate.
366          */
367         stop_emulating();
368         /*
369          * Record new context early in case frstor causes an IRQ13.
370          */
371         mdcpu->gd_npxthread = td;
372         /*
373          * The following frstor may cause an IRQ13 when the state being
374          * restored has a pending error.  The error will appear to have been
375          * triggered by the current (npx) user instruction even when that
376          * instruction is a no-wait instruction that should not trigger an
377          * error (e.g., fnclex).  On at least one 486 system all of the
378          * no-wait instructions are broken the same as frstor, so our
379          * treatment does not amplify the breakage.  On at least one
380          * 386/Cyrix 387 system, fnclex works correctly while frstor and
381          * fnsave are broken, so our treatment breaks fnclex if it is the
382          * first FPU instruction after a context switch.
383          */
384         if ((td->td_savefpu->sv_xmm.sv_env.en_mxcsr & ~npx_mxcsr_mask)
385 #ifndef CPU_DISABLE_SSE
386             && cpu_fxsr
387 #endif
388         ) {
389                 krateprintf(&badfprate,
390                             "%s: FXRSTR: illegal FP MXCSR %08x didinit = %d\n",
391                             td->td_comm, td->td_savefpu->sv_xmm.sv_env.en_mxcsr,
392                             didinit);
393                 td->td_savefpu->sv_xmm.sv_env.en_mxcsr &= npx_mxcsr_mask;
394                 lwpsignal(curproc, curthread->td_lwp, SIGFPE);
395         }
396         fpurstor(td->td_savefpu);
397         crit_exit();
398
399         return (1);
400 }
401
402 /*
403  * Wrapper for the fnsave instruction to handle h/w bugs.  If there is an error
404  * pending, then fnsave generates a bogus IRQ13 on some systems.  Force
405  * any IRQ13 to be handled immediately, and then ignore it.  This routine is
406  * often called at splhigh so it must not use many system services.  In
407  * particular, it's much easier to install a special handler than to
408  * guarantee that it's safe to use npxintr() and its supporting code.
409  *
410  * WARNING!  This call is made during a switch and the MP lock will be
411  * setup for the new target thread rather then the current thread, so we
412  * cannot do anything here that depends on the *_mplock() functions as
413  * we may trip over their assertions.
414  *
415  * WARNING!  When using fxsave we MUST fninit after saving the FP state.  The
416  * kernel will always assume that the FP state is 'safe' (will not cause
417  * exceptions) for mmx/xmm use if npxthread is NULL.  The kernel must still
418  * setup a custom save area before actually using the FP unit, but it will
419  * not bother calling fninit.  This greatly improves kernel performance when
420  * it wishes to use the FP unit.
421  */
422 void
423 npxsave(union savefpu *addr)
424 {
425         crit_enter();
426         stop_emulating();
427         fpusave(addr);
428         mdcpu->gd_npxthread = NULL;
429         fninit();
430         start_emulating();
431         crit_exit();
432 }
433
434 static void
435 fpusave(union savefpu *addr)
436 {
437 #ifndef CPU_DISABLE_AVX
438         if (cpu_xsave)
439                 xsave(CPU_XFEATURE_X87 | CPU_XFEATURE_SSE | CPU_XFEATURE_YMM, 0, addr);
440         else
441 #endif
442 #ifndef CPU_DISABLE_SSE
443         if (cpu_fxsr)
444                 fxsave(addr);
445         else
446 #endif
447                 fnsave(addr);
448 }
449
450 /*
451  * Save the FP state to the mcontext structure.
452  *
453  * WARNING: If you want to try to npxsave() directly to mctx->mc_fpregs,
454  * then it MUST be 16-byte aligned.  Currently this is not guarenteed.
455  */
456 void
457 npxpush(mcontext_t *mctx)
458 {
459         thread_t td = curthread;
460
461         KKASSERT((td->td_flags & TDF_KERNELFP) == 0);
462
463         if (td->td_flags & TDF_USINGFP) {
464                 if (mdcpu->gd_npxthread == td) {
465                         /*
466                          * XXX Note: This is a bit inefficient if the signal
467                          * handler uses floating point, extra faults will
468                          * occur.
469                          */
470                         mctx->mc_ownedfp = _MC_FPOWNED_FPU;
471                         npxsave(td->td_savefpu);
472                 } else {
473                         mctx->mc_ownedfp = _MC_FPOWNED_PCB;
474                 }
475                 KKASSERT(sizeof(*td->td_savefpu) <= sizeof(mctx->mc_fpregs));
476                 bcopy(td->td_savefpu, mctx->mc_fpregs, sizeof(*td->td_savefpu));
477                 td->td_flags &= ~TDF_USINGFP;
478 #ifndef CPU_DISABLE_AVX
479         if (cpu_xsave)
480                 mctx->mc_fpformat = _MC_FPFMT_YMM;
481         else
482 #endif
483 #ifndef CPU_DISABLE_SSE
484         if (cpu_fxsr)
485                 mctx->mc_fpformat = _MC_FPFMT_XMM;
486         else
487 #endif
488                 mctx->mc_fpformat = _MC_FPFMT_387;
489         } else {
490                 mctx->mc_ownedfp = _MC_FPOWNED_NONE;
491                 mctx->mc_fpformat = _MC_FPFMT_NODEV;
492         }
493 }
494
495 /*
496  * Restore the FP state from the mcontext structure.
497  */
498 void
499 npxpop(mcontext_t *mctx)
500 {
501         thread_t td = curthread;
502
503         switch(mctx->mc_ownedfp) {
504         case _MC_FPOWNED_NONE:
505                 /*
506                  * If the signal handler used the FP unit but the interrupted
507                  * code did not, release the FP unit.  Clear TDF_USINGFP will
508                  * force the FP unit to reinit so the interrupted code sees
509                  * a clean slate.
510                  */
511                 if (td->td_flags & TDF_USINGFP) {
512                         if (td == mdcpu->gd_npxthread)
513                                 npxsave(td->td_savefpu);
514                         td->td_flags &= ~TDF_USINGFP;
515                 }
516                 break;
517         case _MC_FPOWNED_FPU:
518         case _MC_FPOWNED_PCB:
519                 /*
520                  * Clear ownership of the FP unit and restore our saved state.
521                  *
522                  * NOTE: The signal handler may have set-up some FP state and
523                  * enabled the FP unit, so we have to restore no matter what.
524                  *
525                  * XXX: This is bit inefficient, if the code being returned
526                  * to is actively using the FP this results in multiple
527                  * kernel faults.
528                  *
529                  * WARNING: The saved state was exposed to userland and may
530                  * have to be sanitized to avoid a GP fault in the kernel.
531                  */
532                 if (td == mdcpu->gd_npxthread)
533                         npxsave(td->td_savefpu);
534                 KKASSERT(sizeof(*td->td_savefpu) <= sizeof(mctx->mc_fpregs));
535                 bcopy(mctx->mc_fpregs, td->td_savefpu, sizeof(*td->td_savefpu));
536                 if ((td->td_savefpu->sv_xmm.sv_env.en_mxcsr & ~npx_mxcsr_mask)
537 #ifndef CPU_DISABLE_SSE
538                     && cpu_fxsr
539 #endif
540                 ) {
541                         krateprintf(&badfprate,
542                                     "pid %d (%s) signal return from user: "
543                                     "illegal FP MXCSR %08x\n",
544                                     td->td_proc->p_pid,
545                                     td->td_proc->p_comm,
546                                     td->td_savefpu->sv_xmm.sv_env.en_mxcsr);
547                 }
548                 td->td_flags |= TDF_USINGFP;
549                 break;
550         }
551 }
552
553
554 #ifndef CPU_DISABLE_SSE
555 /*
556  * On AuthenticAMD processors, the fxrstor instruction does not restore
557  * the x87's stored last instruction pointer, last data pointer, and last
558  * opcode values, except in the rare case in which the exception summary
559  * (ES) bit in the x87 status word is set to 1.
560  *
561  * In order to avoid leaking this information across processes, we clean
562  * these values by performing a dummy load before executing fxrstor().
563  */
564 static  double  dummy_variable = 0.0;
565 static void
566 fpu_clean_state(void)
567 {
568         u_short status;
569
570         /*
571          * Clear the ES bit in the x87 status word if it is currently
572          * set, in order to avoid causing a fault in the upcoming load.
573          */
574         fnstsw(&status);
575         if (status & 0x80)
576                 fnclex();
577
578         /*
579          * Load the dummy variable into the x87 stack.  This mangles
580          * the x87 stack, but we don't care since we're about to call
581          * fxrstor() anyway.
582          */
583         __asm __volatile("ffree %%st(7); flds %0" : : "m" (dummy_variable));
584 }
585 #endif /* CPU_DISABLE_SSE */
586
587 static void
588 fpurstor(union savefpu *addr)
589 {
590 #ifndef CPU_DISABLE_AVX
591         if (cpu_xsave)
592                 xrstor(CPU_XFEATURE_X87 | CPU_XFEATURE_SSE | CPU_XFEATURE_YMM, 0, addr);
593         else
594 #endif
595 #ifndef CPU_DISABLE_SSE
596         if (cpu_fxsr) {
597                 fpu_clean_state();
598                 fxrstor(addr);
599         } else {
600                 frstor(addr);
601         }
602 #else
603         frstor(addr);
604 #endif
605 }
606