db73414015176fe738672f8a99e38eb1feda7efb
[dragonfly.git] / sys / cpu / i386 / include / ieeefp.h
1 /*-
2  * Copyright (c) 2003 Peter Wemm.
3  * Copyright (c) 1990 Andrew Moore, Talke Studio
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *      This product includes software developed by the University of
17  *      California, Berkeley and its contributors.
18  * 4. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *      from: @(#) ieeefp.h     1.0 (Berkeley) 9/23/93
35  * $FreeBSD: src/sys/i386/include/ieeefp.h,v 1.14 2008/01/11 18:59:35 bde Exp $
36  */
37
38 #ifndef _CPU_IEEEFP_H_
39 #define _CPU_IEEEFP_H_
40
41 /*
42  * IEEE floating point type, constant and function definitions.
43  * XXX: FP*FLD and FP*OFF are undocumented pollution.
44  */
45
46 /*
47  * Rounding modes.
48  */
49 typedef enum {
50         FP_RN=0,        /* round to nearest */
51         FP_RM,          /* round down towards minus infinity */
52         FP_RP,          /* round up towards plus infinity */
53         FP_RZ           /* truncate */
54 } fp_rnd_t;
55
56 /*
57  * Precision (i.e., rounding precision) modes.
58  */
59 typedef enum {
60         FP_PS=0,        /* 24 bit (single-precision) */
61         FP_PRS,         /* reserved */
62         FP_PD,          /* 53 bit (double-precision) */
63         FP_PE           /* 64 bit (extended-precision) */
64 } fp_prec_t;
65
66 #define fp_except_t     int
67
68 /*
69  * Exception bit masks.
70  */
71 #define FP_X_INV        0x01    /* invalid operation */
72 #define FP_X_DNML       0x02    /* denormal */
73 #define FP_X_DZ         0x04    /* zero divide */
74 #define FP_X_OFL        0x08    /* overflow */
75 #define FP_X_UFL        0x10    /* underflow */
76 #define FP_X_IMP        0x20    /* (im)precision */
77 #define FP_X_STK        0x40    /* stack fault */
78
79 /*
80  * FPU control word bit-field masks.
81  */
82 #define FP_MSKS_FLD     0x3f    /* exception masks field */
83 #define FP_PRC_FLD      0x300   /* precision control field */
84 #define FP_RND_FLD      0xc00   /* rounding control field */
85
86 /*
87  * FPU status word bit-field masks.
88  */
89 #define FP_STKY_FLD     0x3f    /* sticky flags field */
90
91 /*
92  * FPU control word bit-field offsets (shift counts).
93  */
94 #define FP_MSKS_OFF     0       /* exception masks offset */
95 #define FP_PRC_OFF      8       /* precision control offset */
96 #define FP_RND_OFF      10      /* rounding control offset */
97
98 /*
99  * FPU status word bit-field offsets (shift counts).
100  */
101 #define FP_STKY_OFF     0       /* sticky flags offset */
102
103 #ifdef __GNUC__
104
105 #define __fldcw(addr)   __asm __volatile("fldcw %0" : : "m" (*(addr)))
106 #define __fldenv(addr)  __asm __volatile("fldenv %0" : : "m" (*(addr)))
107 #define __fnclex()      __asm __volatile("fnclex")
108 #define __fnstcw(addr)  __asm __volatile("fnstcw %0" : "=m" (*(addr)))
109 #define __fnstenv(addr) __asm __volatile("fnstenv %0" : "=m" (*(addr)))
110 #define __fnstsw(addr)  __asm __volatile("fnstsw %0" : "=m" (*(addr)))
111
112 /*
113  * Load the control word.  Be careful not to trap if there is a currently
114  * unmasked exception (ones that will become freshly unmasked are not a
115  * problem).  This case must be handled by a save/restore of the
116  * environment or even of the full x87 state.  Accessing the environment
117  * is very inefficient, so only do it when necessary.
118  */
119 static __inline void
120 __fnldcw(unsigned short _cw, unsigned short _newcw)
121 {
122         struct {
123                 unsigned _cw;
124                 unsigned _other[6];
125         } _env;
126         unsigned short _sw;
127
128         if ((_cw & FP_MSKS_FLD) != FP_MSKS_FLD) {
129                 __fnstsw(&_sw);
130                 if (((_sw & ~_cw) & FP_STKY_FLD) != 0) {
131                         __fnstenv(&_env);
132                         _env._cw = _newcw;
133                         __fldenv(&_env);
134                         return;
135                 }
136         }
137         __fldcw(&_newcw);
138 }
139
140 static __inline fp_rnd_t
141 fpgetround(void)
142 {
143         unsigned short _cw;
144
145         __fnstcw(&_cw);
146         return ((fp_rnd_t)((_cw & FP_RND_FLD) >> FP_RND_OFF));
147 }
148
149 static __inline fp_rnd_t
150 fpsetround(fp_rnd_t _m)
151 {
152         fp_rnd_t _p;
153         unsigned short _cw, _newcw;
154
155         __fnstcw(&_cw);
156         _p = (fp_rnd_t)((_cw & FP_RND_FLD) >> FP_RND_OFF);
157         _newcw = _cw & ~FP_RND_FLD;
158         _newcw |= (_m << FP_RND_OFF) & FP_RND_FLD;
159         __fnldcw(_cw, _newcw);
160         return (_p);
161 }
162
163 static __inline fp_prec_t
164 fpgetprec(void)
165 {
166         unsigned short _cw;
167
168         __fnstcw(&_cw);
169         return ((fp_prec_t)((_cw & FP_PRC_FLD) >> FP_PRC_OFF));
170 }
171
172 static __inline fp_prec_t
173 fpsetprec(fp_prec_t _m)
174 {
175         fp_prec_t _p;
176         unsigned short _cw, _newcw;
177
178         __fnstcw(&_cw);
179         _p = (fp_prec_t)((_cw & FP_PRC_FLD) >> FP_PRC_OFF);
180         _newcw = _cw & ~FP_PRC_FLD;
181         _newcw |= (_m << FP_PRC_OFF) & FP_PRC_FLD;
182         __fnldcw(_cw, _newcw);
183         return (_p);
184 }
185
186 /*
187  * Get or set the exception mask.
188  * Note that the x87 mask bits are inverted by the API -- a mask bit of 1
189  * means disable for x87 and SSE, but for fp*mask() it means enable.
190  */
191
192 static __inline fp_except_t
193 fpgetmask(void)
194 {
195         unsigned short _cw;
196
197         __fnstcw(&_cw);
198         return ((~_cw & FP_MSKS_FLD) >> FP_MSKS_OFF);
199 }
200
201 static __inline fp_except_t
202 fpsetmask(fp_except_t _m)
203 {
204         fp_except_t _p;
205         unsigned short _cw, _newcw;
206
207         __fnstcw(&_cw);
208         _p = (~_cw & FP_MSKS_FLD) >> FP_MSKS_OFF;
209         _newcw = _cw & ~FP_MSKS_FLD;
210         _newcw |= (~_m << FP_MSKS_OFF) & FP_MSKS_FLD;
211         __fnldcw(_cw, _newcw);
212         return (_p);
213 }
214
215 static __inline fp_except_t
216 fpgetsticky(void)
217 {
218         unsigned _ex;
219         unsigned short _sw;
220
221         __fnstsw(&_sw);
222         _ex = (_sw & FP_STKY_FLD) >> FP_STKY_OFF;
223         return ((fp_except_t)_ex);
224 }
225
226 static __inline fp_except_t
227 fpresetsticky(fp_except_t _m)
228 {
229         struct {
230                 unsigned _cw;
231                 unsigned _sw;
232                 unsigned _other[5];
233         } _env;
234         fp_except_t _p;
235
236         _m &= FP_STKY_FLD >> FP_STKY_OFF;
237         _p = fpgetsticky();
238         if ((_p & ~_m) == _p)
239                 return (_p);
240         if ((_p & ~_m) == 0) {
241                 __fnclex();
242                 return (_p);
243         }
244         __fnstenv(&_env);
245         _env._sw &= ~_m;
246         __fldenv(&_env);
247         return (_p);
248 }
249
250 #endif /* __GNUC__ */
251
252 /* Suppress prototypes in the MI header. */
253 #define _IEEEFP_INLINED_        1
254
255 #endif /* !_CPU_IEEEFP_H_ */