1 /*        $NetBSD: fpu_implode.c,v 1.15 2013/03/26 11:30:21 isaki Exp $ */
2 
3 /*
4  * Copyright (c) 1992, 1993
5  *        The Regents of the University of California.  All rights reserved.
6  *
7  * This software was developed by the Computer Systems Engineering group
8  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
9  * contributed to Berkeley.
10  *
11  * All advertising materials mentioning features or use of this software
12  * must display the following acknowledgement:
13  *        This product includes software developed by the University of
14  *        California, Lawrence Berkeley Laboratory.
15  *
16  * Redistribution and use in source and binary forms, with or without
17  * modification, are permitted provided that the following conditions
18  * are met:
19  * 1. Redistributions of source code must retain the above copyright
20  *    notice, this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the
23  *    documentation and/or other materials provided with the distribution.
24  * 3. Neither the name of the University nor the names of its contributors
25  *    may be used to endorse or promote products derived from this software
26  *    without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  *
40  *        @(#)fpu_implode.c   8.1 (Berkeley) 6/11/93
41  */
42 
43 /*
44  * FPU subroutines: `implode' internal format numbers into the machine's
45  * `packed binary' format.
46  */
47 
48 #include <sys/cdefs.h>
49 __KERNEL_RCSID(0, "$NetBSD: fpu_implode.c,v 1.15 2013/03/26 11:30:21 isaki Exp $");
50 
51 #include <sys/types.h>
52 #include <sys/systm.h>
53 
54 #include <machine/ieee.h>
55 #include <machine/reg.h>
56 
57 #include "fpu_emulate.h"
58 #include "fpu_arith.h"
59 
60 /* Conversion from internal format -- note asymmetry. */
61 static uint32_t     fpu_ftoi(struct fpemu *fe, struct fpn *fp);
62 static uint32_t     fpu_ftos(struct fpemu *fe, struct fpn *fp);
63 static uint32_t     fpu_ftod(struct fpemu *fe, struct fpn *fp, uint32_t *);
64 static uint32_t     fpu_ftox(struct fpemu *fe, struct fpn *fp, uint32_t *);
65 
66 /*
67  * Round a number (algorithm from Motorola MC68882 manual, modified for
68  * our internal format).  Set inexact exception if rounding is required.
69  * Return true iff we rounded up.
70  *
71  * After rounding, we discard the guard and round bits by shifting right
72  * 2 bits (a la fpu_shr(), but we do not bother with fp->fp_sticky).
73  * This saves effort later.
74  *
75  * Note that we may leave the value 2.0 in fp->fp_mant; it is the caller's
76  * responsibility to fix this if necessary.
77  */
78 int
fpu_round(struct fpemu * fe,struct fpn * fp)79 fpu_round(struct fpemu *fe, struct fpn *fp)
80 {
81           uint32_t m0, m1, m2;
82           int gr, s;
83 
84           m0 = fp->fp_mant[0];
85           m1 = fp->fp_mant[1];
86           m2 = fp->fp_mant[2];
87           gr = m2 & 3;
88           s = fp->fp_sticky;
89 
90           /* mant >>= FP_NG */
91           m2 = (m2 >> FP_NG) | (m1 << (32 - FP_NG));
92           m1 = (m1 >> FP_NG) | (m0 << (32 - FP_NG));
93           m0 >>= FP_NG;
94 
95           if ((gr | s) == 0)  /* result is exact: no rounding needed */
96                     goto rounddown;
97 
98           fe->fe_fpsr |= FPSR_INEX2;    /* inexact */
99 
100           /* Go to rounddown to round down; break to round up. */
101           switch (fe->fe_fpcr & FPCR_ROUND) {
102 
103           case FPCR_NEAR:
104           default:
105                     /*
106                      * Round only if guard is set (gr & 2).  If guard is set,
107                      * but round & sticky both clear, then we want to round
108                      * but have a tie, so round to even, i.e., add 1 iff odd.
109                      */
110                     if ((gr & 2) == 0)
111                               goto rounddown;
112                     if ((gr & 1) || fp->fp_sticky || (m2 & 1))
113                               break;
114                     goto rounddown;
115 
116           case FPCR_ZERO:
117                     /* Round towards zero, i.e., down. */
118                     goto rounddown;
119 
120           case FPCR_MINF:
121                     /* Round towards -Inf: up if negative, down if positive. */
122                     if (fp->fp_sign)
123                               break;
124                     goto rounddown;
125 
126           case FPCR_PINF:
127                     /* Round towards +Inf: up if positive, down otherwise. */
128                     if (!fp->fp_sign)
129                               break;
130                     goto rounddown;
131           }
132 
133           /* Bump low bit of mantissa, with carry. */
134           if (++m2 == 0 && ++m1 == 0)
135                     m0++;
136           fp->fp_sticky = 0;
137           fp->fp_mant[0] = m0;
138           fp->fp_mant[1] = m1;
139           fp->fp_mant[2] = m2;
140           return (1);
141 
142 rounddown:
143           fp->fp_sticky = 0;
144           fp->fp_mant[0] = m0;
145           fp->fp_mant[1] = m1;
146           fp->fp_mant[2] = m2;
147           return (0);
148 }
149 
150 /*
151  * For overflow: return true if overflow is to go to +/-Inf, according
152  * to the sign of the overflowing result.  If false, overflow is to go
153  * to the largest magnitude value instead.
154  */
155 static int
toinf(struct fpemu * fe,int sign)156 toinf(struct fpemu *fe, int sign)
157 {
158           int inf;
159 
160           /* look at rounding direction */
161           switch (fe->fe_fpcr & FPCR_ROUND) {
162 
163           default:
164           case FPCR_NEAR:               /* the nearest value is always Inf */
165                     inf = 1;
166                     break;
167 
168           case FPCR_ZERO:               /* toward 0 => never towards Inf */
169                     inf = 0;
170                     break;
171 
172           case FPCR_PINF:               /* toward +Inf iff positive */
173                     inf = (sign == 0);
174                     break;
175 
176           case FPCR_MINF:               /* toward -Inf iff negative */
177                     inf = sign;
178                     break;
179           }
180           return (inf);
181 }
182 
183 /*
184  * fpn -> int (int value returned as return value).
185  *
186  * N.B.: this conversion always rounds towards zero (this is a peculiarity
187  * of the SPARC instruction set).
188  */
189 static uint32_t
fpu_ftoi(struct fpemu * fe,struct fpn * fp)190 fpu_ftoi(struct fpemu *fe, struct fpn *fp)
191 {
192           uint32_t i;
193           int sign, exp;
194 
195           sign = fp->fp_sign;
196           switch (fp->fp_class) {
197           case FPC_ZERO:
198                     return (0);
199 
200           case FPC_NUM:
201                     /*
202                      * If exp >= 2^32, overflow.  Otherwise shift value right
203                      * into last mantissa word (this will not exceed 0xffffffff),
204                      * shifting any guard and round bits out into the sticky
205                      * bit.  Then ``round'' towards zero, i.e., just set an
206                      * inexact exception if sticky is set (see fpu_round()).
207                      * If the result is > 0x80000000, or is positive and equals
208                      * 0x80000000, overflow; otherwise the last fraction word
209                      * is the result.
210                      */
211                     if ((exp = fp->fp_exp) >= 32)
212                               break;
213                     /* NB: the following includes exp < 0 cases */
214                     if (fpu_shr(fp, FP_NMANT - 1 - FP_NG - exp) != 0) {
215                               /*
216                                * m68881/2 do not underflow when
217                                * converting to integer
218                                */
219                               ;
220                     }
221                     fpu_round(fe, fp);
222                     i = fp->fp_mant[2];
223                     if (i >= ((uint32_t)0x80000000 + sign))
224                               break;
225                     return (sign ? -i : i);
226 
227           default:            /* Inf, qNaN, sNaN */
228                     break;
229           }
230           /* overflow: replace any inexact exception with invalid */
231           fe->fe_fpsr = (fe->fe_fpsr & ~FPSR_INEX2) | FPSR_OPERR;
232           return (0x7fffffff + sign);
233 }
234 
235 /*
236  * fpn -> single (32 bit single returned as return value).
237  * We assume <= 29 bits in a single-precision fraction (1.f part).
238  */
239 static uint32_t
fpu_ftos(struct fpemu * fe,struct fpn * fp)240 fpu_ftos(struct fpemu *fe, struct fpn *fp)
241 {
242           uint32_t sign = fp->fp_sign << 31;
243           int exp;
244 
245 #define   SNG_EXP(e)          ((e) << SNG_FRACBITS)         /* makes e an exponent */
246 #define   SNG_MASK  (SNG_EXP(1) - 1)    /* mask for fraction */
247 
248           /* Take care of non-numbers first. */
249           if (ISNAN(fp)) {
250                     /*
251                      * Preserve upper bits of NaN, per SPARC V8 appendix N.
252                      * Note that fp->fp_mant[0] has the quiet bit set,
253                      * even if it is classified as a signalling NaN.
254                      */
255                     (void) fpu_shr(fp, FP_NMANT - 1 - SNG_FRACBITS);
256                     exp = SNG_EXP_INFNAN;
257                     goto done;
258           }
259           if (ISINF(fp))
260                     return (sign | SNG_EXP(SNG_EXP_INFNAN));
261           if (ISZERO(fp))
262                     return (sign);
263 
264           /*
265            * Normals (including subnormals).  Drop all the fraction bits
266            * (including the explicit ``implied'' 1 bit) down into the
267            * single-precision range.  If the number is subnormal, move
268            * the ``implied'' 1 into the explicit range as well, and shift
269            * right to introduce leading zeroes.  Rounding then acts
270            * differently for normals and subnormals: the largest subnormal
271            * may round to the smallest normal (1.0 x 2^minexp), or may
272            * remain subnormal.  In the latter case, signal an underflow
273            * if the result was inexact or if underflow traps are enabled.
274            *
275            * Rounding a normal, on the other hand, always produces another
276            * normal (although either way the result might be too big for
277            * single precision, and cause an overflow).  If rounding a
278            * normal produces 2.0 in the fraction, we need not adjust that
279            * fraction at all, since both 1.0 and 2.0 are zero under the
280            * fraction mask.
281            *
282            * Note that the guard and round bits vanish from the number after
283            * rounding.
284            */
285           if ((exp = fp->fp_exp + SNG_EXP_BIAS) <= 0) {     /* subnormal */
286                     fe->fe_fpsr |= FPSR_UNFL;
287                     /* -NG for g,r; -SNG_FRACBITS-exp for fraction */
288                     (void) fpu_shr(fp, FP_NMANT - FP_NG - SNG_FRACBITS - exp);
289                     if (fpu_round(fe, fp) && fp->fp_mant[2] == SNG_EXP(1))
290                               return (sign | SNG_EXP(1) | 0);
291                     if (fe->fe_fpsr & FPSR_INEX2) {
292                               /* mc68881/2 don't underflow when converting */
293                               fe->fe_fpsr |= FPSR_UNFL;
294                     }
295                     return (sign | SNG_EXP(0) | fp->fp_mant[2]);
296           }
297           /* -FP_NG for g,r; -1 for implied 1; -SNG_FRACBITS for fraction */
298           (void) fpu_shr(fp, FP_NMANT - FP_NG - 1 - SNG_FRACBITS);
299 #ifdef DIAGNOSTIC
300           if ((fp->fp_mant[2] & SNG_EXP(1 << FP_NG)) == 0)
301                     panic("fpu_ftos");
302 #endif
303           if (fpu_round(fe, fp) && fp->fp_mant[2] == SNG_EXP(2))
304                     exp++;
305           if (exp >= SNG_EXP_INFNAN) {
306                     /* overflow to inf or to max single */
307                     fe->fe_fpsr |= FPSR_OPERR | FPSR_INEX2 | FPSR_OVFL;
308                     if (toinf(fe, sign))
309                               return (sign | SNG_EXP(SNG_EXP_INFNAN));
310                     return (sign | SNG_EXP(SNG_EXP_INFNAN - 1) | SNG_MASK);
311           }
312 done:
313           /* phew, made it */
314           return (sign | SNG_EXP(exp) | (fp->fp_mant[2] & SNG_MASK));
315 }
316 
317 /*
318  * fpn -> double (32 bit high-order result returned; 32-bit low order result
319  * left in res[1]).  Assumes <= 61 bits in double precision fraction.
320  *
321  * This code mimics fpu_ftos; see it for comments.
322  */
323 static uint32_t
fpu_ftod(struct fpemu * fe,struct fpn * fp,uint32_t * res)324 fpu_ftod(struct fpemu *fe, struct fpn *fp, uint32_t *res)
325 {
326           uint32_t sign = fp->fp_sign << 31;
327           int exp;
328 
329 #define   DBL_EXP(e)          ((e) << (DBL_FRACBITS & 31))
330 #define   DBL_MASK  (DBL_EXP(1) - 1)
331 
332           if (ISNAN(fp)) {
333                     (void) fpu_shr(fp, FP_NMANT - 1 - DBL_FRACBITS);
334                     exp = DBL_EXP_INFNAN;
335                     goto done;
336           }
337           if (ISINF(fp)) {
338                     sign |= DBL_EXP(DBL_EXP_INFNAN);
339                     res[1] = 0;
340                     return (sign);
341           }
342           if (ISZERO(fp)) {
343                     res[1] = 0;
344                     return (sign);
345           }
346 
347           if ((exp = fp->fp_exp + DBL_EXP_BIAS) <= 0) {
348                     fe->fe_fpsr |= FPSR_UNFL;
349                     (void) fpu_shr(fp, FP_NMANT - FP_NG - DBL_FRACBITS - exp);
350                     if (fpu_round(fe, fp) && fp->fp_mant[1] == DBL_EXP(1)) {
351                               res[1] = 0;
352                               return (sign | DBL_EXP(1) | 0);
353                     }
354                     if (fe->fe_fpsr & FPSR_INEX2) {
355                               /* mc68881/2 don't underflow when converting */
356                               fe->fe_fpsr |= FPSR_UNFL;
357                     }
358                     exp = 0;
359                     goto done;
360           }
361           (void) fpu_shr(fp, FP_NMANT - FP_NG - 1 - DBL_FRACBITS);
362           if (fpu_round(fe, fp) && fp->fp_mant[1] == DBL_EXP(2))
363                     exp++;
364           if (exp >= DBL_EXP_INFNAN) {
365                     fe->fe_fpsr |= FPSR_OPERR | FPSR_INEX2 | FPSR_OVFL;
366                     if (toinf(fe, sign)) {
367                               res[1] = 0;
368                               return (sign | DBL_EXP(DBL_EXP_INFNAN) | 0);
369                     }
370                     res[1] = ~0;
371                     return (sign | DBL_EXP(DBL_EXP_INFNAN) | DBL_MASK);
372           }
373 done:
374           res[1] = fp->fp_mant[2];
375           return (sign | DBL_EXP(exp) | (fp->fp_mant[1] & DBL_MASK));
376 }
377 
378 /*
379  * fpn -> 68k extended (32 bit high-order result returned; two 32-bit low
380  * order result left in res[1] & res[2]).  Assumes == 64 bits in extended
381  * precision fraction.
382  *
383  * This code mimics fpu_ftos; see it for comments.
384  */
385 static uint32_t
fpu_ftox(struct fpemu * fe,struct fpn * fp,uint32_t * res)386 fpu_ftox(struct fpemu *fe, struct fpn *fp, uint32_t *res)
387 {
388           uint32_t sign = fp->fp_sign << 31;
389           int exp;
390 
391 #define   EXT_EXP(e)          ((e) << 16)
392 /*
393  * on m68k extended prec, significand does not share the same long
394  * word with exponent
395  */
396 #define   EXT_MASK  0
397 #define EXT_EXPLICIT1         (1UL << (63 & 31))
398 #define EXT_EXPLICIT2         (1UL << (64 & 31))
399 
400           if (ISNAN(fp)) {
401                     (void) fpu_shr(fp, FP_NMANT - EXT_FRACBITS);
402                     exp = EXT_EXP_INFNAN;
403                     goto done;
404           }
405           if (ISINF(fp)) {
406                     sign |= EXT_EXP(EXT_EXP_INFNAN);
407                     res[1] = res[2] = 0;
408                     return (sign);
409           }
410           if (ISZERO(fp)) {
411                     res[1] = res[2] = 0;
412                     return (sign);
413           }
414 
415           if ((exp = fp->fp_exp + EXT_EXP_BIAS) < 0) {
416                     fe->fe_fpsr |= FPSR_UNFL;
417                     /*
418                      * I'm not sure about this <=... exp==0 doesn't mean
419                      * it's a denormal in extended format
420                      */
421                     (void) fpu_shr(fp, FP_NMANT - FP_NG - EXT_FRACBITS - exp);
422                     if (fpu_round(fe, fp) && fp->fp_mant[1] == EXT_EXPLICIT1) {
423                               res[1] = res[2] = 0;
424                               return (sign | EXT_EXP(1) | 0);
425                     }
426                     if (fe->fe_fpsr & FPSR_INEX2) {
427                               /* mc68881/2 don't underflow */
428                               fe->fe_fpsr |= FPSR_UNFL;
429                     }
430                     exp = 0;
431                     goto done;
432           }
433 #if (FP_NMANT - FP_NG - EXT_FRACBITS) > 0
434           (void) fpu_shr(fp, FP_NMANT - FP_NG - EXT_FRACBITS);
435 #endif
436           if (fpu_round(fe, fp) && fp->fp_mant[0] == EXT_EXPLICIT2) {
437                     exp++;
438                     fpu_shr(fp, 1);
439           }
440           if (exp >= EXT_EXP_INFNAN) {
441                     fe->fe_fpsr |= FPSR_OPERR | FPSR_INEX2 | FPSR_OVFL;
442                     if (toinf(fe, sign)) {
443                               res[1] = res[2] = 0;
444                               return (sign | EXT_EXP(EXT_EXP_INFNAN) | 0);
445                     }
446                     res[1] = res[2] = ~0;
447                     return (sign | EXT_EXP(EXT_EXP_INFNAN) | EXT_MASK);
448           }
449 done:
450           res[1] = fp->fp_mant[1];
451           res[2] = fp->fp_mant[2];
452           return (sign | EXT_EXP(exp));
453 }
454 
455 /*
456  * Implode an fpn, writing the result into the given space.
457  */
458 void
fpu_implode(struct fpemu * fe,struct fpn * fp,int type,uint32_t * space)459 fpu_implode(struct fpemu *fe, struct fpn *fp, int type, uint32_t *space)
460 {
461           /* XXX Dont delete exceptions set here: fe->fe_fpsr &= ~FPSR_EXCP; */
462 
463           switch (type) {
464           case FTYPE_LNG:
465                     space[0] = fpu_ftoi(fe, fp);
466                     break;
467 
468           case FTYPE_SNG:
469                     space[0] = fpu_ftos(fe, fp);
470                     break;
471 
472           case FTYPE_DBL:
473                     space[0] = fpu_ftod(fe, fp, space);
474                     break;
475 
476           case FTYPE_EXT:
477                     /* funky rounding precision options ?? */
478                     space[0] = fpu_ftox(fe, fp, space);
479                     break;
480 
481           default:
482                     panic("fpu_implode");
483           }
484 }
485