xref: /netbsd/sys/lib/libkern/softfloat.h (revision bf9ec67e)
1 /* $NetBSD: softfloat.h,v 1.1 2001/04/26 03:10:48 ross Exp $ */
2 
3 /* This is a derivative work. */
4 
5 /*-
6  * Copyright (c) 2001 The NetBSD Foundation, Inc.
7  * All rights reserved.
8  *
9  * This code is derived from software contributed to The NetBSD Foundation
10  * by Ross Harvey.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. All advertising materials mentioning features or use of this software
21  *    must display the following acknowledgement:
22  *        This product includes software developed by the NetBSD
23  *        Foundation, Inc. and its contributors.
24  * 4. Neither the name of The NetBSD Foundation nor the names of its
25  *    contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  */
40 
41 /*
42 ===============================================================================
43 
44 This C header file is part of the SoftFloat IEC/IEEE Floating-point
45 Arithmetic Package, Release 2a.
46 
47 Written by John R. Hauser.  This work was made possible in part by the
48 International Computer Science Institute, located at Suite 600, 1947 Center
49 Street, Berkeley, California 94704.  Funding was partially provided by the
50 National Science Foundation under grant MIP-9311980.  The original version
51 of this code was written as part of a project to build a fixed-point vector
52 processor in collaboration with the University of California at Berkeley,
53 overseen by Profs. Nelson Morgan and John Wawrzynek.  More information
54 is available through the Web page `http://HTTP.CS.Berkeley.EDU/~jhauser/
55 arithmetic/SoftFloat.html'.
56 
57 THIS SOFTWARE IS DISTRIBUTED AS IS, FOR FREE.  Although reasonable effort
58 has been made to avoid it, THIS SOFTWARE MAY CONTAIN FAULTS THAT WILL AT
59 TIMES RESULT IN INCORRECT BEHAVIOR.  USE OF THIS SOFTWARE IS RESTRICTED TO
60 PERSONS AND ORGANIZATIONS WHO CAN AND WILL TAKE FULL RESPONSIBILITY FOR ANY
61 AND ALL LOSSES, COSTS, OR OTHER PROBLEMS ARISING FROM ITS USE.
62 
63 Derivative works are acceptable, even for commercial purposes, so long as
64 (1) they include prominent notice that the work is derivative, and (2) they
65 include prominent notice akin to these four paragraphs for those parts of
66 this code that are retained.
67 
68 ===============================================================================
69 */
70 
71 #include <sys/types.h>
72 
73 #if !defined(_KERNEL) && !defined(_STANDALONE)
74 #include <inttypes.h>
75 #include <ieeefp.h>
76 #else
77 #include "sys/inttypes.h"
78 #include "machine/ieeefp.h"
79 #endif
80 #include <sys/endian.h>
81 
82 /*
83 -------------------------------------------------------------------------------
84 The macro `FLOATX80' must be defined to enable the extended double-precision
85 floating-point format `floatx80'.  If this macro is not defined, the
86 `floatx80' type will not be defined, and none of the functions that either
87 input or output the `floatx80' type will be defined.  The same applies to
88 the `FLOAT128' macro and the quadruple-precision format `float128'.
89 -------------------------------------------------------------------------------
90 */
91 /* #define FLOATX80 */
92 /* #define FLOAT128 */
93 
94 /*
95 -------------------------------------------------------------------------------
96 Software IEC/IEEE floating-point types.
97 -------------------------------------------------------------------------------
98 */
99 typedef u_int32_t float32;
100 typedef u_int64_t float64;
101 #ifdef FLOATX80
102 typedef struct {
103 #if BYTE_ORDER == BIG_ENDIAN
104     u_int16_t high;
105     u_int64_t low;
106 #else
107     u_int64_t low;
108     u_int16_t high;
109 #endif
110 } floatx80;
111 #endif
112 #ifdef FLOAT128
113 typedef struct {
114     u_int64_t high, low;
115 } float128;
116 #endif
117 
118 /*
119  * Some of the global variables that used to be here have been removed for
120  * fairly obvious (defopt-MULTIPROCESSOR) reasons.  The rest (which don't
121  * change dynamically) will be removed later. [ross]
122  */
123 
124 #define float_rounding_mode() fpgetround()
125 
126 /*
127 -------------------------------------------------------------------------------
128 Software IEC/IEEE floating-point underflow tininess-detection mode.
129 -------------------------------------------------------------------------------
130 */
131 
132 extern int float_detect_tininess;
133 enum {
134     float_tininess_after_rounding  = 1,
135     float_tininess_before_rounding = 0
136 };
137 
138 /*
139 -------------------------------------------------------------------------------
140 Software IEC/IEEE floating-point rounding mode.
141 -------------------------------------------------------------------------------
142 */
143 
144 enum {
145     float_round_nearest_even = FP_RN,
146     float_round_to_zero      = FP_RZ,
147     float_round_down         = FP_RM,
148     float_round_up           = FP_RP
149 };
150 
151 /*
152 -------------------------------------------------------------------------------
153 Software IEC/IEEE floating-point exception flags.
154 -------------------------------------------------------------------------------
155 */
156 
157 enum {
158     float_flag_inexact   =  FP_X_IMP,
159     float_flag_underflow =  FP_X_UFL,
160     float_flag_overflow  =  FP_X_OFL,
161     float_flag_divbyzero =  FP_X_DZ,
162     float_flag_invalid   =  FP_X_INV
163 };
164 
165 /*
166 -------------------------------------------------------------------------------
167 Software IEC/IEEE integer-to-floating-point conversion routines.
168 -------------------------------------------------------------------------------
169 */
170 float32 int32_to_float32( int );
171 float64 int32_to_float64( int );
172 #ifdef FLOATX80
173 floatx80 int32_to_floatx80( int );
174 #endif
175 #ifdef FLOAT128
176 float128 int32_to_float128( int );
177 #endif
178 #ifndef SOFTFLOAT_FOR_GCC /* __floatdi?f is in libgcc2.c */
179 float32 int64_to_float32( int64_t );
180 float64 int64_to_float64( int64_t );
181 #ifdef FLOATX80
182 floatx80 int64_to_floatx80( int64_t );
183 #endif
184 #ifdef FLOAT128
185 float128 int64_to_float128( int64_t );
186 #endif
187 #endif
188 
189 /*
190 -------------------------------------------------------------------------------
191 Software IEC/IEEE single-precision conversion routines.
192 -------------------------------------------------------------------------------
193 */
194 int float32_to_int32( float32 );
195 int float32_to_int32_round_to_zero( float32 );
196 #ifndef SOFTFLOAT_FOR_GCC /* __fix?fdi provided by libgcc2.c */
197 int64_t float32_to_int64( float32 );
198 int64_t float32_to_int64_round_to_zero( float32 );
199 #endif
200 float64 float32_to_float64( float32 );
201 #ifdef FLOATX80
202 floatx80 float32_to_floatx80( float32 );
203 #endif
204 #ifdef FLOAT128
205 float128 float32_to_float128( float32 );
206 #endif
207 
208 /*
209 -------------------------------------------------------------------------------
210 Software IEC/IEEE single-precision operations.
211 -------------------------------------------------------------------------------
212 */
213 float32 float32_round_to_int( float32 );
214 float32 float32_add( float32, float32 );
215 float32 float32_sub( float32, float32 );
216 float32 float32_mul( float32, float32 );
217 float32 float32_div( float32, float32 );
218 float32 float32_rem( float32, float32 );
219 float32 float32_sqrt( float32 );
220 int float32_eq( float32, float32 );
221 int float32_le( float32, float32 );
222 int float32_lt( float32, float32 );
223 int float32_eq_signaling( float32, float32 );
224 int float32_le_quiet( float32, float32 );
225 int float32_lt_quiet( float32, float32 );
226 #ifndef SOFTFLOAT_FOR_GCC
227 int float32_is_signaling_nan( float32 );
228 #endif
229 
230 /*
231 -------------------------------------------------------------------------------
232 Software IEC/IEEE double-precision conversion routines.
233 -------------------------------------------------------------------------------
234 */
235 int float64_to_int32( float64 );
236 int float64_to_int32_round_to_zero( float64 );
237 #ifndef SOFTFLOAT_FOR_GCC /* __fix?fdi provided by libgcc2.c */
238 int64_t float64_to_int64( float64 );
239 int64_t float64_to_int64_round_to_zero( float64 );
240 #endif
241 float32 float64_to_float32( float64 );
242 #ifdef FLOATX80
243 floatx80 float64_to_floatx80( float64 );
244 #endif
245 #ifdef FLOAT128
246 float128 float64_to_float128( float64 );
247 #endif
248 
249 /*
250 -------------------------------------------------------------------------------
251 Software IEC/IEEE double-precision operations.
252 -------------------------------------------------------------------------------
253 */
254 #define float64_default_nan 0xFFF8000000000000LL
255 
256 static __inline int
257 float64_is_nan(float64 a)
258 {
259 	return 0xFFE0000000000000LL < a << 1;
260 }
261 
262 static __inline int
263 float64_is_signaling_nan(float64 a)
264 {
265 	return (a >> 51 & 0xFFF) == 0xFFE && (a & 0x0007FFFFFFFFFFFFLL);
266 }
267 
268 float64 float64_round_to_int( float64 );
269 float64 float64_add( float64, float64 );
270 float64 float64_sub( float64, float64 );
271 float64 float64_mul( float64, float64 );
272 float64 float64_div( float64, float64 );
273 float64 float64_rem( float64, float64 );
274 float64 float64_sqrt( float64 );
275 int float64_eq( float64, float64 );
276 int float64_le( float64, float64 );
277 int float64_lt( float64, float64 );
278 int float64_eq_signaling( float64, float64 );
279 int float64_le_quiet( float64, float64 );
280 int float64_lt_quiet( float64, float64 );
281 #ifndef SOFTFLOAT_FOR_GCC
282 int float64_is_signaling_nan( float64 );
283 #endif
284 
285 #ifdef FLOATX80
286 
287 /*
288 -------------------------------------------------------------------------------
289 Software IEC/IEEE extended double-precision conversion routines.
290 -------------------------------------------------------------------------------
291 */
292 int floatx80_to_int32( floatx80 );
293 int floatx80_to_int32_round_to_zero( floatx80 );
294 int64_t floatx80_to_int64( floatx80 );
295 int64_t floatx80_to_int64_round_to_zero( floatx80 );
296 float32 floatx80_to_float32( floatx80 );
297 float64 floatx80_to_float64( floatx80 );
298 #ifdef FLOAT128
299 float128 floatx80_to_float128( floatx80 );
300 #endif
301 
302 /*
303 -------------------------------------------------------------------------------
304 Software IEC/IEEE extended double-precision rounding precision.  Valid
305 values are 32, 64, and 80.
306 -------------------------------------------------------------------------------
307 */
308 extern int floatx80_rounding_precision;
309 
310 /*
311 -------------------------------------------------------------------------------
312 Software IEC/IEEE extended double-precision operations.
313 -------------------------------------------------------------------------------
314 */
315 floatx80 floatx80_round_to_int( floatx80 );
316 floatx80 floatx80_add( floatx80, floatx80 );
317 floatx80 floatx80_sub( floatx80, floatx80 );
318 floatx80 floatx80_mul( floatx80, floatx80 );
319 floatx80 floatx80_div( floatx80, floatx80 );
320 floatx80 floatx80_rem( floatx80, floatx80 );
321 floatx80 floatx80_sqrt( floatx80 );
322 int floatx80_eq( floatx80, floatx80 );
323 int floatx80_le( floatx80, floatx80 );
324 int floatx80_lt( floatx80, floatx80 );
325 int floatx80_eq_signaling( floatx80, floatx80 );
326 int floatx80_le_quiet( floatx80, floatx80 );
327 int floatx80_lt_quiet( floatx80, floatx80 );
328 int floatx80_is_signaling_nan( floatx80 );
329 
330 #endif
331 
332 #ifdef FLOAT128
333 
334 /*
335 -------------------------------------------------------------------------------
336 Software IEC/IEEE quadruple-precision conversion routines.
337 -------------------------------------------------------------------------------
338 */
339 int float128_to_int32( float128 );
340 int float128_to_int32_round_to_zero( float128 );
341 int64_t float128_to_int64( float128 );
342 int64_t float128_to_int64_round_to_zero( float128 );
343 float32 float128_to_float32( float128 );
344 float64 float128_to_float64( float128 );
345 #ifdef FLOATX80
346 floatx80 float128_to_floatx80( float128 );
347 #endif
348 
349 /*
350 -------------------------------------------------------------------------------
351 Software IEC/IEEE quadruple-precision operations.
352 -------------------------------------------------------------------------------
353 */
354 float128 float128_round_to_int( float128 );
355 float128 float128_add( float128, float128 );
356 float128 float128_sub( float128, float128 );
357 float128 float128_mul( float128, float128 );
358 float128 float128_div( float128, float128 );
359 float128 float128_rem( float128, float128 );
360 float128 float128_sqrt( float128 );
361 int float128_eq( float128, float128 );
362 int float128_le( float128, float128 );
363 int float128_lt( float128, float128 );
364 int float128_eq_signaling( float128, float128 );
365 int float128_le_quiet( float128, float128 );
366 int float128_lt_quiet( float128, float128 );
367 int float128_is_signaling_nan( float128 );
368 
369 #endif
370 
371