xref: /haiku/src/system/libroot/os/arch/sparc/fpu_div.c (revision 6a44d4c52765e4fd5ccf6a4a7c69486c9531431d)
1 /*
2  * Copyright (c) 1992, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This software was developed by the Computer Systems Engineering group
6  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
7  * contributed to Berkeley.
8  *
9  * All advertising materials mentioning features or use of this software
10  * must display the following acknowledgement:
11  *	This product includes software developed by the University of
12  *	California, Lawrence Berkeley Laboratory.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  * 2. Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the distribution.
22  * 3. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *	@(#)fpu_div.c	8.1 (Berkeley) 6/11/93
39  *	$NetBSD: fpu_div.c,v 1.2 1994/11/20 20:52:38 deraadt Exp $
40  */
41 
42 #include <sys/cdefs.h>
43 
44 /*
45  * Perform an FPU divide (return x / y).
46  */
47 
48 #include <sys/types.h>
49 
50 #include "fsr.h"
51 
52 #include "fpu_arith.h"
53 #include "fpu_emu.h"
54 #include "fpu_extern.h"
55 
56 /*
57  * Division of normal numbers is done as follows:
58  *
59  * x and y are floating point numbers, i.e., in the form 1.bbbb * 2^e.
60  * If X and Y are the mantissas (1.bbbb's), the quotient is then:
61  *
62  *	q = (X / Y) * 2^((x exponent) - (y exponent))
63  *
64  * Since X and Y are both in [1.0,2.0), the quotient's mantissa (X / Y)
65  * will be in [0.5,2.0).  Moreover, it will be less than 1.0 if and only
66  * if X < Y.  In that case, it will have to be shifted left one bit to
67  * become a normal number, and the exponent decremented.  Thus, the
68  * desired exponent is:
69  *
70  *	left_shift = x->fp_mant < y->fp_mant;
71  *	result_exp = x->fp_exp - y->fp_exp - left_shift;
72  *
73  * The quotient mantissa X/Y can then be computed one bit at a time
74  * using the following algorithm:
75  *
76  *	Q = 0;			-- Initial quotient.
77  *	R = X;			-- Initial remainder,
78  *	if (left_shift)		--   but fixed up in advance.
79  *		R *= 2;
80  *	for (bit = FP_NMANT; --bit >= 0; R *= 2) {
81  *		if (R >= Y) {
82  *			Q |= 1 << bit;
83  *			R -= Y;
84  *		}
85  *	}
86  *
87  * The subtraction R -= Y always removes the uppermost bit from R (and
88  * can sometimes remove additional lower-order 1 bits); this proof is
89  * left to the reader.
90  *
91  * This loop correctly calculates the guard and round bits since they are
92  * included in the expanded internal representation.  The sticky bit
93  * is to be set if and only if any other bits beyond guard and round
94  * would be set.  From the above it is obvious that this is true if and
95  * only if the remainder R is nonzero when the loop terminates.
96  *
97  * Examining the loop above, we can see that the quotient Q is built
98  * one bit at a time ``from the top down''.  This means that we can
99  * dispense with the multi-word arithmetic and just build it one word
100  * at a time, writing each result word when it is done.
101  *
102  * Furthermore, since X and Y are both in [1.0,2.0), we know that,
103  * initially, R >= Y.  (Recall that, if X < Y, R is set to X * 2 and
104  * is therefore at in [2.0,4.0).)  Thus Q is sure to have bit FP_NMANT-1
105  * set, and R can be set initially to either X - Y (when X >= Y) or
106  * 2X - Y (when X < Y).  In addition, comparing R and Y is difficult,
107  * so we will simply calculate R - Y and see if that underflows.
108  * This leads to the following revised version of the algorithm:
109  *
110  *	R = X;
111  *	bit = FP_1;
112  *	D = R - Y;
113  *	if (D >= 0) {
114  *		result_exp = x->fp_exp - y->fp_exp;
115  *		R = D;
116  *		q = bit;
117  *		bit >>= 1;
118  *	} else {
119  *		result_exp = x->fp_exp - y->fp_exp - 1;
120  *		q = 0;
121  *	}
122  *	R <<= 1;
123  *	do  {
124  *		D = R - Y;
125  *		if (D >= 0) {
126  *			q |= bit;
127  *			R = D;
128  *		}
129  *		R <<= 1;
130  *	} while ((bit >>= 1) != 0);
131  *	Q[0] = q;
132  *	for (i = 1; i < 4; i++) {
133  *		q = 0, bit = 1 << 31;
134  *		do {
135  *			D = R - Y;
136  *			if (D >= 0) {
137  *				q |= bit;
138  *				R = D;
139  *			}
140  *			R <<= 1;
141  *		} while ((bit >>= 1) != 0);
142  *		Q[i] = q;
143  *	}
144  *
145  * This can be refined just a bit further by moving the `R <<= 1'
146  * calculations to the front of the do-loops and eliding the first one.
147  * The process can be terminated immediately whenever R becomes 0, but
148  * this is relatively rare, and we do not bother.
149  */
150 
151 struct fpn *
152 __fpu_div(fe)
153 	struct fpemu *fe;
154 {
155 	struct fpn *x = &fe->fe_f1, *y = &fe->fe_f2;
156 	u_int q, bit;
157 	u_int r0, r1, r2, r3, d0, d1, d2, d3, y0, y1, y2, y3;
158 	FPU_DECL_CARRY
159 
160 	/*
161 	 * Since divide is not commutative, we cannot just use ORDER.
162 	 * Check either operand for NaN first; if there is at least one,
163 	 * order the signalling one (if only one) onto the right, then
164 	 * return it.  Otherwise we have the following cases:
165 	 *
166 	 *	Inf / Inf = NaN, plus NV exception
167 	 *	Inf / num = Inf [i.e., return x #]
168 	 *	Inf / 0   = Inf [i.e., return x #]
169 	 *	0 / Inf = 0 [i.e., return x #]
170 	 *	0 / num = 0 [i.e., return x #]
171 	 *	0 / 0   = NaN, plus NV exception
172 	 *	num / Inf = 0 #
173 	 *	num / num = num (do the divide)
174 	 *	num / 0   = Inf #, plus DZ exception
175 	 *
176 	 * # Sign of result is XOR of operand signs.
177 	 */
178 	if (ISNAN(x) || ISNAN(y)) {
179 		ORDER(x, y);
180 		return (y);
181 	}
182 	if (ISINF(x) || ISZERO(x)) {
183 		if (x->fp_class == y->fp_class)
184 			return (__fpu_newnan(fe));
185 		x->fp_sign ^= y->fp_sign;
186 		return (x);
187 	}
188 
189 	x->fp_sign ^= y->fp_sign;
190 	if (ISINF(y)) {
191 		x->fp_class = FPC_ZERO;
192 		return (x);
193 	}
194 	if (ISZERO(y)) {
195 		fe->fe_cx = FSR_DZ;
196 		x->fp_class = FPC_INF;
197 		return (x);
198 	}
199 
200 	/*
201 	 * Macros for the divide.  See comments at top for algorithm.
202 	 * Note that we expand R, D, and Y here.
203 	 */
204 
205 #define	SUBTRACT		/* D = R - Y */ \
206 	FPU_SUBS(d3, r3, y3); FPU_SUBCS(d2, r2, y2); \
207 	FPU_SUBCS(d1, r1, y1); FPU_SUBC(d0, r0, y0)
208 
209 #define	NONNEGATIVE		/* D >= 0 */ \
210 	((int)d0 >= 0)
211 
212 #ifdef FPU_SHL1_BY_ADD
213 #define	SHL1			/* R <<= 1 */ \
214 	FPU_ADDS(r3, r3, r3); FPU_ADDCS(r2, r2, r2); \
215 	FPU_ADDCS(r1, r1, r1); FPU_ADDC(r0, r0, r0)
216 #else
217 #define	SHL1 \
218 	r0 = (r0 << 1) | (r1 >> 31), r1 = (r1 << 1) | (r2 >> 31), \
219 	r2 = (r2 << 1) | (r3 >> 31), r3 <<= 1
220 #endif
221 
222 #define	LOOP			/* do ... while (bit >>= 1) */ \
223 	do { \
224 		SHL1; \
225 		SUBTRACT; \
226 		if (NONNEGATIVE) { \
227 			q |= bit; \
228 			r0 = d0, r1 = d1, r2 = d2, r3 = d3; \
229 		} \
230 	} while ((bit >>= 1) != 0)
231 
232 #define	WORD(r, i)			/* calculate r->fp_mant[i] */ \
233 	q = 0; \
234 	bit = 1 << 31; \
235 	LOOP; \
236 	(x)->fp_mant[i] = q
237 
238 	/* Setup.  Note that we put our result in x. */
239 	r0 = x->fp_mant[0];
240 	r1 = x->fp_mant[1];
241 	r2 = x->fp_mant[2];
242 	r3 = x->fp_mant[3];
243 	y0 = y->fp_mant[0];
244 	y1 = y->fp_mant[1];
245 	y2 = y->fp_mant[2];
246 	y3 = y->fp_mant[3];
247 
248 	bit = FP_1;
249 	SUBTRACT;
250 	if (NONNEGATIVE) {
251 		x->fp_exp -= y->fp_exp;
252 		r0 = d0, r1 = d1, r2 = d2, r3 = d3;
253 		q = bit;
254 		bit >>= 1;
255 	} else {
256 		x->fp_exp -= y->fp_exp + 1;
257 		q = 0;
258 	}
259 	LOOP;
260 	x->fp_mant[0] = q;
261 	WORD(x, 1);
262 	WORD(x, 2);
263 	WORD(x, 3);
264 	x->fp_sticky = r0 | r1 | r2 | r3;
265 
266 	return (x);
267 }
268