xref: /netbsd-src/tests/include/sys/t_bitops.c (revision 88fcb00c0357f2d7c1774f86a352637bfda96184)
1 /*	$NetBSD: t_bitops.c,v 1.7 2011/03/30 08:34:20 jruoho Exp $ */
2 
3 /*-
4  * Copyright (c) 2011 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jukka Ruohonen.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 #include <sys/cdefs.h>
32 __RCSID("$NetBSD: t_bitops.c,v 1.7 2011/03/30 08:34:20 jruoho Exp $");
33 
34 #include <atf-c.h>
35 
36 #include <sys/cdefs.h>
37 #include <sys/bitops.h>
38 
39 #include <math.h>
40 #include <stdlib.h>
41 
42 static const struct {
43 	uint32_t	val;
44 	int		ffs;
45 	int		fls;
46 } bits[] = {
47 
48 	{ 0x00, 0, 0 }, { 0x01, 1, 1 },	{ 0x02, 2, 2 },	{ 0x03, 1, 2 },
49 	{ 0x04, 3, 3 }, { 0x05, 1, 3 },	{ 0x06, 2, 3 },	{ 0x07, 1, 3 },
50 	{ 0x08, 4, 4 }, { 0x09, 1, 4 },	{ 0x0A, 2, 4 },	{ 0x0B, 1, 4 },
51 	{ 0x0C, 3, 4 }, { 0x0D, 1, 4 },	{ 0x0E, 2, 4 },	{ 0x0F, 1, 4 },
52 
53 	{ 0x10, 5, 5 },	{ 0x11, 1, 5 },	{ 0x12, 2, 5 },	{ 0x13, 1, 5 },
54 	{ 0x14, 3, 5 },	{ 0x15, 1, 5 },	{ 0x16, 2, 5 },	{ 0x17, 1, 5 },
55 	{ 0x18, 4, 5 },	{ 0x19, 1, 5 },	{ 0x1A, 2, 5 },	{ 0x1B, 1, 5 },
56 	{ 0x1C, 3, 5 },	{ 0x1D, 1, 5 },	{ 0x1E, 2, 5 },	{ 0x1F, 1, 5 },
57 
58 	{ 0xF0, 5, 8 },	{ 0xF1, 1, 8 },	{ 0xF2, 2, 8 },	{ 0xF3, 1, 8 },
59 	{ 0xF4, 3, 8 },	{ 0xF5, 1, 8 },	{ 0xF6, 2, 8 },	{ 0xF7, 1, 8 },
60 	{ 0xF8, 4, 8 },	{ 0xF9, 1, 8 },	{ 0xFA, 2, 8 },	{ 0xFB, 1, 8 },
61 	{ 0xFC, 3, 8 },	{ 0xFD, 1, 8 },	{ 0xFE, 2, 8 },	{ 0xFF, 1, 8 },
62 
63 };
64 
65 ATF_TC(fast_divide32);
66 ATF_TC_HEAD(fast_divide32, tc)
67 {
68 	atf_tc_set_md_var(tc, "descr", "A basic test of fast_divide32(3)");
69 }
70 
71 ATF_TC_BODY(fast_divide32, tc)
72 {
73 	uint32_t a, b, q, r, m;
74 	uint8_t i, s1, s2;
75 
76 	a = 0xFFFF;
77 	b = 0x000F;
78 
79 	fast_divide32_prepare(b, &m, &s1, &s2);
80 
81 	q = fast_divide32(a, b, m, s1, s2);
82 	r = fast_remainder32(a, b, m, s1, s2);
83 
84 	ATF_REQUIRE(q == 0x1111 && r == 0);
85 
86 	for (i = 1; i < __arraycount(bits); i++) {
87 
88 		a = bits[i].val;
89 		b = bits[i].ffs;
90 
91 		fast_divide32_prepare(b, &m, &s1, &s2);
92 
93 		q = fast_divide32(a, b, m, s1, s2);
94 		r = fast_remainder32(a, b, m, s1, s2);
95 
96 		ATF_REQUIRE(q == a / b);
97 		ATF_REQUIRE(r == a % b);
98 	}
99 }
100 
101 ATF_TC(ffsfls);
102 ATF_TC_HEAD(ffsfls, tc)
103 {
104 	atf_tc_set_md_var(tc, "descr", "Test ffs32(3)-family for correctness");
105 }
106 
107 ATF_TC_BODY(ffsfls, tc)
108 {
109 	uint8_t i;
110 
111 	ATF_REQUIRE(ffs32(0) == 0x00);
112 	ATF_REQUIRE(fls32(0) == 0x00);
113 	ATF_REQUIRE(ffs64(0) == 0x00);
114 	ATF_REQUIRE(fls64(0) == 0x00);
115 
116 	ATF_REQUIRE(ffs32(UINT32_MAX) == 0x01);
117 	ATF_REQUIRE(fls32(UINT32_MAX) == 0x20);
118 	ATF_REQUIRE(ffs64(UINT64_MAX) == 0x01);
119 	ATF_REQUIRE(fls64(UINT64_MAX) == 0x40);
120 
121 	for (i = 1; i < __arraycount(bits); i++) {
122 
123 		ATF_REQUIRE(ffs32(bits[i].val) == bits[i].ffs);
124 		ATF_REQUIRE(fls32(bits[i].val) == bits[i].fls);
125 		ATF_REQUIRE(ffs64(bits[i].val) == bits[i].ffs);
126 		ATF_REQUIRE(fls64(bits[i].val) == bits[i].fls);
127 
128 		ATF_REQUIRE(ffs32(bits[i].val << 1) == bits[i].ffs + 1);
129 		ATF_REQUIRE(fls32(bits[i].val << 1) == bits[i].fls + 1);
130 		ATF_REQUIRE(ffs64(bits[i].val << 1) == bits[i].ffs + 1);
131 		ATF_REQUIRE(fls64(bits[i].val << 1) == bits[i].fls + 1);
132 
133 		ATF_REQUIRE(ffs32(bits[i].val << 9) == bits[i].ffs + 9);
134 		ATF_REQUIRE(fls32(bits[i].val << 9) == bits[i].fls + 9);
135 		ATF_REQUIRE(ffs64(bits[i].val << 9) == bits[i].ffs + 9);
136 		ATF_REQUIRE(fls64(bits[i].val << 9) == bits[i].fls + 9);
137 	}
138 }
139 
140 ATF_TC(ilog2_1);
141 ATF_TC_HEAD(ilog2_1, tc)
142 {
143 	atf_tc_set_md_var(tc, "descr", "Test ilog2(3) for correctness");
144 }
145 
146 ATF_TC_BODY(ilog2_1, tc)
147 {
148 	uint64_t i, x;
149 
150 	for (i = x = 0; i < 64; i++) {
151 
152 		x = (uint64_t)1 << i;
153 
154 		ATF_REQUIRE(i == (uint64_t)ilog2(x));
155 	}
156 }
157 
158 ATF_TC(ilog2_2);
159 ATF_TC_HEAD(ilog2_2, tc)
160 {
161 	atf_tc_set_md_var(tc, "descr", "Test log2(3) vs. ilog2(3)");
162 }
163 
164 ATF_TC_BODY(ilog2_2, tc)
165 {
166 	double  x, y;
167 	uint64_t i;
168 
169 	/*
170 	 * This may fail under QEMU; see PR misc/44767.
171 	 */
172 	if (system("cpuctl identify 0 | grep -q QEMU") == 0)
173 		atf_tc_expect_fail("PR misc/44767");
174 
175 	for (i = 1; i < UINT32_MAX; i += UINT16_MAX) {
176 
177 		x = log2(i);
178 		y = (double)(ilog2(i));
179 
180 		ATF_REQUIRE(ceil(x) >= y);
181 		ATF_REQUIRE(fabs(floor(x) - y) < 1.0e-40);
182 	}
183 }
184 
185 ATF_TP_ADD_TCS(tp)
186 {
187 
188 	ATF_TP_ADD_TC(tp, fast_divide32);
189 	ATF_TP_ADD_TC(tp, ffsfls);
190 	ATF_TP_ADD_TC(tp, ilog2_1);
191 	ATF_TP_ADD_TC(tp, ilog2_2);
192 
193 	return atf_no_error();
194 }
195