xref: /openbsd-src/sys/lib/libkern/qdivrem.c (revision 33b4f39fbeffad07bc3206f173cff9f3c9901cd1)
1 /*	$OpenBSD: qdivrem.c,v 1.5 2003/06/02 23:28:08 millert Exp $	*/
2 /*	$NetBSD: qdivrem.c,v 1.5 1995/10/07 09:26:40 mycroft Exp $	*/
3 
4 /*-
5  * Copyright (c) 1992, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * This software was developed by the Computer Systems Engineering group
9  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
10  * contributed to Berkeley.
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. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  */
36 
37 #if defined(LIBC_SCCS) && !defined(lint)
38 #ifdef notdef
39 static char sccsid[] = "@(#)qdivrem.c	8.1 (Berkeley) 6/4/93";
40 #endif
41 static char rcsid[] = "$OpenBSD: qdivrem.c,v 1.5 2003/06/02 23:28:08 millert Exp $";
42 #endif /* LIBC_SCCS and not lint */
43 
44 /*
45  * Multiprecision divide.  This algorithm is from Knuth vol. 2 (2nd ed),
46  * section 4.3.1, pp. 257--259.
47  */
48 
49 #include "quad.h"
50 
51 #define	B	((long)1 << HALF_BITS)	/* digit base */
52 
53 /* Combine two `digits' to make a single two-digit number. */
54 #define	COMBINE(a, b) (((u_long)(a) << HALF_BITS) | (b))
55 
56 /* select a type for digits in base B: use unsigned short if they fit */
57 #if ULONG_MAX == 0xffffffff && USHRT_MAX >= 0xffff
58 typedef unsigned short digit;
59 #else
60 typedef u_long digit;
61 #endif
62 
63 static void shl(digit *p, int len, int sh);
64 
65 /*
66  * __qdivrem(u, v, rem) returns u/v and, optionally, sets *rem to u%v.
67  *
68  * We do this in base 2-sup-HALF_BITS, so that all intermediate products
69  * fit within u_long.  As a consequence, the maximum length dividend and
70  * divisor are 4 `digits' in this base (they are shorter if they have
71  * leading zeros).
72  */
73 u_quad_t
74 __qdivrem(uq, vq, arq)
75 	u_quad_t uq, vq, *arq;
76 {
77 	union uu tmp;
78 	digit *u, *v, *q;
79 	register digit v1, v2;
80 	u_long qhat, rhat, t;
81 	int m, n, d, j, i;
82 	digit uspace[5], vspace[5], qspace[5];
83 
84 	/*
85 	 * Take care of special cases: divide by zero, and u < v.
86 	 */
87 	if (vq == 0) {
88 		/* divide by zero. */
89 		static volatile const unsigned int zero = 0;
90 
91 		tmp.ul[H] = tmp.ul[L] = 1 / zero;
92 		if (arq)
93 			*arq = uq;
94 		return (tmp.q);
95 	}
96 	if (uq < vq) {
97 		if (arq)
98 			*arq = uq;
99 		return (0);
100 	}
101 	u = &uspace[0];
102 	v = &vspace[0];
103 	q = &qspace[0];
104 
105 	/*
106 	 * Break dividend and divisor into digits in base B, then
107 	 * count leading zeros to determine m and n.  When done, we
108 	 * will have:
109 	 *	u = (u[1]u[2]...u[m+n]) sub B
110 	 *	v = (v[1]v[2]...v[n]) sub B
111 	 *	v[1] != 0
112 	 *	1 < n <= 4 (if n = 1, we use a different division algorithm)
113 	 *	m >= 0 (otherwise u < v, which we already checked)
114 	 *	m + n = 4
115 	 * and thus
116 	 *	m = 4 - n <= 2
117 	 */
118 	tmp.uq = uq;
119 	u[0] = 0;
120 	u[1] = HHALF(tmp.ul[H]);
121 	u[2] = LHALF(tmp.ul[H]);
122 	u[3] = HHALF(tmp.ul[L]);
123 	u[4] = LHALF(tmp.ul[L]);
124 	tmp.uq = vq;
125 	v[1] = HHALF(tmp.ul[H]);
126 	v[2] = LHALF(tmp.ul[H]);
127 	v[3] = HHALF(tmp.ul[L]);
128 	v[4] = LHALF(tmp.ul[L]);
129 	for (n = 4; v[1] == 0; v++) {
130 		if (--n == 1) {
131 			u_long rbj;	/* r*B+u[j] (not root boy jim) */
132 			digit q1, q2, q3, q4;
133 
134 			/*
135 			 * Change of plan, per exercise 16.
136 			 *	r = 0;
137 			 *	for j = 1..4:
138 			 *		q[j] = floor((r*B + u[j]) / v),
139 			 *		r = (r*B + u[j]) % v;
140 			 * We unroll this completely here.
141 			 */
142 			t = v[2];	/* nonzero, by definition */
143 			q1 = u[1] / t;
144 			rbj = COMBINE(u[1] % t, u[2]);
145 			q2 = rbj / t;
146 			rbj = COMBINE(rbj % t, u[3]);
147 			q3 = rbj / t;
148 			rbj = COMBINE(rbj % t, u[4]);
149 			q4 = rbj / t;
150 			if (arq)
151 				*arq = rbj % t;
152 			tmp.ul[H] = COMBINE(q1, q2);
153 			tmp.ul[L] = COMBINE(q3, q4);
154 			return (tmp.q);
155 		}
156 	}
157 
158 	/*
159 	 * By adjusting q once we determine m, we can guarantee that
160 	 * there is a complete four-digit quotient at &qspace[1] when
161 	 * we finally stop.
162 	 */
163 	for (m = 4 - n; u[1] == 0; u++)
164 		m--;
165 	for (i = 4 - m; --i >= 0;)
166 		q[i] = 0;
167 	q += 4 - m;
168 
169 	/*
170 	 * Here we run Program D, translated from MIX to C and acquiring
171 	 * a few minor changes.
172 	 *
173 	 * D1: choose multiplier 1 << d to ensure v[1] >= B/2.
174 	 */
175 	d = 0;
176 	for (t = v[1]; t < B / 2; t <<= 1)
177 		d++;
178 	if (d > 0) {
179 		shl(&u[0], m + n, d);		/* u <<= d */
180 		shl(&v[1], n - 1, d);		/* v <<= d */
181 	}
182 	/*
183 	 * D2: j = 0.
184 	 */
185 	j = 0;
186 	v1 = v[1];	/* for D3 -- note that v[1..n] are constant */
187 	v2 = v[2];	/* for D3 */
188 	do {
189 		register digit uj0, uj1, uj2;
190 
191 		/*
192 		 * D3: Calculate qhat (\^q, in TeX notation).
193 		 * Let qhat = min((u[j]*B + u[j+1])/v[1], B-1), and
194 		 * let rhat = (u[j]*B + u[j+1]) mod v[1].
195 		 * While rhat < B and v[2]*qhat > rhat*B+u[j+2],
196 		 * decrement qhat and increase rhat correspondingly.
197 		 * Note that if rhat >= B, v[2]*qhat < rhat*B.
198 		 */
199 		uj0 = u[j + 0];	/* for D3 only -- note that u[j+...] change */
200 		uj1 = u[j + 1];	/* for D3 only */
201 		uj2 = u[j + 2];	/* for D3 only */
202 		if (uj0 == v1) {
203 			qhat = B;
204 			rhat = uj1;
205 			goto qhat_too_big;
206 		} else {
207 			u_long n = COMBINE(uj0, uj1);
208 			qhat = n / v1;
209 			rhat = n % v1;
210 		}
211 		while (v2 * qhat > COMBINE(rhat, uj2)) {
212 	qhat_too_big:
213 			qhat--;
214 			if ((rhat += v1) >= B)
215 				break;
216 		}
217 		/*
218 		 * D4: Multiply and subtract.
219 		 * The variable `t' holds any borrows across the loop.
220 		 * We split this up so that we do not require v[0] = 0,
221 		 * and to eliminate a final special case.
222 		 */
223 		for (t = 0, i = n; i > 0; i--) {
224 			t = u[i + j] - v[i] * qhat - t;
225 			u[i + j] = LHALF(t);
226 			t = (B - HHALF(t)) & (B - 1);
227 		}
228 		t = u[j] - t;
229 		u[j] = LHALF(t);
230 		/*
231 		 * D5: test remainder.
232 		 * There is a borrow if and only if HHALF(t) is nonzero;
233 		 * in that (rare) case, qhat was too large (by exactly 1).
234 		 * Fix it by adding v[1..n] to u[j..j+n].
235 		 */
236 		if (HHALF(t)) {
237 			qhat--;
238 			for (t = 0, i = n; i > 0; i--) { /* D6: add back. */
239 				t += u[i + j] + v[i];
240 				u[i + j] = LHALF(t);
241 				t = HHALF(t);
242 			}
243 			u[j] = LHALF(u[j] + t);
244 		}
245 		q[j] = qhat;
246 	} while (++j <= m);		/* D7: loop on j. */
247 
248 	/*
249 	 * If caller wants the remainder, we have to calculate it as
250 	 * u[m..m+n] >> d (this is at most n digits and thus fits in
251 	 * u[m+1..m+n], but we may need more source digits).
252 	 */
253 	if (arq) {
254 		if (d) {
255 			for (i = m + n; i > m; --i)
256 				u[i] = (u[i] >> d) |
257 				    LHALF(u[i - 1] << (HALF_BITS - d));
258 			u[i] = 0;
259 		}
260 		tmp.ul[H] = COMBINE(uspace[1], uspace[2]);
261 		tmp.ul[L] = COMBINE(uspace[3], uspace[4]);
262 		*arq = tmp.q;
263 	}
264 
265 	tmp.ul[H] = COMBINE(qspace[1], qspace[2]);
266 	tmp.ul[L] = COMBINE(qspace[3], qspace[4]);
267 	return (tmp.q);
268 }
269 
270 /*
271  * Shift p[0]..p[len] left `sh' bits, ignoring any bits that
272  * `fall out' the left (there never will be any such anyway).
273  * We may assume len >= 0.  NOTE THAT THIS WRITES len+1 DIGITS.
274  */
275 static void
276 shl(p, len, sh)
277 	register digit *p;
278 	register int len;
279 	register int sh;
280 {
281 	register int i;
282 
283 	for (i = 0; i < len; i++)
284 		p[i] = LHALF(p[i] << sh) | (p[i + 1] >> (HALF_BITS - sh));
285 	p[i] = LHALF(p[i] << sh);
286 }
287