2 * Copyright 2015 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include <folly/experimental/Bits.h>
19 #include <glog/logging.h>
20 #include <gtest/gtest.h>
22 using namespace folly;
25 void runSimpleTest8() {
26 auto load = detail::BitsTraits<T>::load;
28 EXPECT_EQ(0, Bits<T>::blockCount(0));
29 EXPECT_EQ(1, Bits<T>::blockCount(1));
30 EXPECT_EQ(1, Bits<T>::blockCount(8));
31 EXPECT_EQ(2, Bits<T>::blockCount(9));
32 EXPECT_EQ(256, Bits<T>::blockCount(2048));
33 EXPECT_EQ(257, Bits<T>::blockCount(2049));
35 EXPECT_EQ(4, Bits<T>::blockIndex(39));
36 EXPECT_EQ(7, Bits<T>::bitOffset(39));
37 EXPECT_EQ(5, Bits<T>::blockIndex(40));
38 EXPECT_EQ(0, Bits<T>::bitOffset(40));
41 std::fill(buf, buf + 256, T(0));
43 Bits<T>::set(buf, 36);
44 Bits<T>::set(buf, 39);
45 EXPECT_EQ((1 << 7) | (1 << 4), load(buf[4]));
46 EXPECT_EQ(0, load(buf[5]));
47 Bits<T>::clear(buf, 39);
48 EXPECT_EQ(1 << 4, load(buf[4]));
49 EXPECT_EQ(0, load(buf[5]));
50 Bits<T>::set(buf, 40);
51 EXPECT_EQ(1 << 4, load(buf[4]));
52 EXPECT_EQ(1, load(buf[5]));
54 EXPECT_EQ(2, Bits<T>::count(buf, buf + 256));
58 runSimpleTest8<uint8_t>();
61 TEST(Bits, SimpleUnaligned8) {
62 runSimpleTest8<Unaligned<uint8_t>>();
66 void runSimpleTest64() {
67 auto load = detail::BitsTraits<T>::load;
69 EXPECT_EQ(0, Bits<T>::blockCount(0));
70 EXPECT_EQ(1, Bits<T>::blockCount(1));
71 EXPECT_EQ(1, Bits<T>::blockCount(8));
72 EXPECT_EQ(1, Bits<T>::blockCount(9));
73 EXPECT_EQ(1, Bits<T>::blockCount(64));
74 EXPECT_EQ(2, Bits<T>::blockCount(65));
75 EXPECT_EQ(32, Bits<T>::blockCount(2048));
76 EXPECT_EQ(33, Bits<T>::blockCount(2049));
78 EXPECT_EQ(0, Bits<T>::blockIndex(39));
79 EXPECT_EQ(39, Bits<T>::bitOffset(39));
80 EXPECT_EQ(4, Bits<T>::blockIndex(319));
81 EXPECT_EQ(63, Bits<T>::bitOffset(319));
82 EXPECT_EQ(5, Bits<T>::blockIndex(320));
83 EXPECT_EQ(0, Bits<T>::bitOffset(320));
86 std::fill(buf, buf + 256, T(0));
88 Bits<T>::set(buf, 300);
89 Bits<T>::set(buf, 319);
90 EXPECT_EQ((uint64_t(1) << 44) | (uint64_t(1) << 63), load(buf[4]));
91 EXPECT_EQ(0, load(buf[5]));
92 Bits<T>::clear(buf, 319);
93 EXPECT_EQ(uint64_t(1) << 44, load(buf[4]));
94 EXPECT_EQ(0, load(buf[5]));
95 Bits<T>::set(buf, 320);
96 EXPECT_EQ(uint64_t(1) << 44, load(buf[4]));
97 EXPECT_EQ(1, load(buf[5]));
99 EXPECT_EQ(2, Bits<T>::count(buf, buf + 256));
102 TEST(Bits, Simple64) {
103 runSimpleTest64<uint64_t>();
106 TEST(Bits, SimpleUnaligned64) {
107 runSimpleTest64<Unaligned<uint64_t>>();
111 void runMultiBitTest8() {
112 auto load = detail::BitsTraits<T>::load;
113 T buf[] = {0x12, 0x34, 0x56, 0x78};
115 EXPECT_EQ(0x02, load(Bits<T>::get(buf, 0, 4)));
116 EXPECT_EQ(0x1a, load(Bits<T>::get(buf, 9, 5)));
117 EXPECT_EQ(0xb1, load(Bits<T>::get(buf, 13, 8)));
119 Bits<T>::set(buf, 0, 4, 0x0b);
120 EXPECT_EQ(0x1b, load(buf[0]));
121 EXPECT_EQ(0x34, load(buf[1]));
122 EXPECT_EQ(0x56, load(buf[2]));
123 EXPECT_EQ(0x78, load(buf[3]));
125 Bits<T>::set(buf, 9, 5, 0x0e);
126 EXPECT_EQ(0x1b, load(buf[0]));
127 EXPECT_EQ(0x1c, load(buf[1]));
128 EXPECT_EQ(0x56, load(buf[2]));
129 EXPECT_EQ(0x78, load(buf[3]));
131 Bits<T>::set(buf, 13, 8, 0xaa);
132 EXPECT_EQ(0x1b, load(buf[0]));
133 EXPECT_EQ(0x5c, load(buf[1]));
134 EXPECT_EQ(0x55, load(buf[2]));
135 EXPECT_EQ(0x78, load(buf[3]));
138 TEST(Bits, MultiBit8) {
139 runMultiBitTest8<uint8_t>();
142 TEST(Bits, MultiBitUnaligned8) {
143 runMultiBitTest8<Unaligned<uint8_t>>();
147 void runSignedMultiBitTest8() {
148 auto load = detail::BitsTraits<T>::load;
149 T buf[] = {0x12, 0x34, 0x56, 0x78};
151 EXPECT_EQ(0x02, load(Bits<T>::get(buf, 0, 4)));
152 EXPECT_EQ(0x1a-32, load(Bits<T>::get(buf, 9, 5)));
153 EXPECT_EQ(0xb1-256, load(Bits<T>::get(buf, 13, 8)));
155 Bits<T>::set(buf, 0, 4, 0x0b - 0x10);
156 EXPECT_EQ(0x1b, load(buf[0]));
157 EXPECT_EQ(0x34, load(buf[1]));
158 EXPECT_EQ(0x56, load(buf[2]));
159 EXPECT_EQ(0x78, load(buf[3]));
161 Bits<T>::set(buf, 9, 5, 0x0e);
162 EXPECT_EQ(0x1b, load(buf[0]));
163 EXPECT_EQ(0x1c, load(buf[1]));
164 EXPECT_EQ(0x56, load(buf[2]));
165 EXPECT_EQ(0x78, load(buf[3]));
167 Bits<T>::set(buf, 13, 8, 0xaa - 0x100);
168 EXPECT_EQ(0x1b, load(buf[0]));
169 EXPECT_EQ(0x5c, load(buf[1]));
170 EXPECT_EQ(0x55, load(buf[2]));
171 EXPECT_EQ(0x78, load(buf[3]));
175 TEST(Bits, SignedMultiBit8) {
176 runSignedMultiBitTest8<int8_t>();
179 template <class T, class R = T>
180 void runMultiBitTest64() {
181 auto load = detail::BitsTraits<T>::load;
182 T buf[] = {0x123456789abcdef0, 0x13579bdf2468ace0};
184 EXPECT_EQ(0x123456789abcdef0, load(Bits<T>::get(buf, 0, 64)));
185 EXPECT_EQ(0xf0, load(Bits<T>::get(buf, 0, 8)));
186 EXPECT_EQ(0x89abcdef, load(Bits<T>::get(buf, 4, 32)));
187 EXPECT_EQ(0x189abcdef, load(Bits<T>::get(buf, 4, 33)));
189 Bits<T>::set(buf, 4, 31, 0x55555555);
190 EXPECT_EQ(0xd5555555, load(Bits<T>::get(buf, 4, 32)));
191 EXPECT_EQ(0x1d5555555, load(Bits<T>::get(buf, 4, 33)));
192 EXPECT_EQ(0xd55555550, load(Bits<T>::get(buf, 0, 36)));
194 Bits<T>::set(buf, 0, 64, 0x23456789abcdef01);
195 EXPECT_EQ(0x23456789abcdef01, load(Bits<T>::get(buf, 0, 64)));
198 TEST(Bits, MultiBit64) {
199 runMultiBitTest64<uint64_t>();
202 TEST(Bits, MultiBitSigned64) {
203 //runMultiBitTest64<int64_t>();
206 TEST(Bits, MultiBitUnaligned64) {
207 runMultiBitTest64<Unaligned<uint64_t>, uint64_t>();
211 template <bool aligned, class T>
212 typename std::enable_if<!aligned>::type testSet(uint8_t *buf,
216 Bits<Unaligned<T>>::set(
217 reinterpret_cast<Unaligned<T> *>(buf), start, bits, value);
220 template <bool aligned, class T>
221 typename std::enable_if<aligned>::type testSet(uint8_t *buf,
225 Bits<T>::set(reinterpret_cast<T *>(buf), start, bits, value);
228 template <bool aligned, class T>
229 typename std::enable_if<!aligned, T>::type testGet(uint8_t *buf,
232 return Bits<Unaligned<T>>::get(
233 reinterpret_cast<Unaligned<T> *>(buf), start, bits);
236 template <bool aligned, class T>
237 typename std::enable_if<aligned, T>::type testGet(uint8_t *buf,
240 return Bits<T>::get(reinterpret_cast<T *>(buf), start, bits);
243 template <class T, bool negate = false>
244 T testValue(int bits) {
245 if (std::is_signed<T>::value) {
248 auto value = pow(2, bits) * (negate ? -2.0 : 2.0) / 3.0;
249 CHECK_GE(value, std::numeric_limits<T>::min());
250 CHECK_LE(value, std::numeric_limits<T>::max());
251 return static_cast<T>(value);
255 template <bool aligned>
256 void testConcatenation() {
257 // concatenate fields of length 1, 2, 3, ... 64, all unsigned, storing 2/3s
258 // the maximum value in each.
259 #define EACH_UNSIGNED_SIZE(MACRO, ARG) \
260 MACRO(8, uint8_t, ARG) \
261 MACRO(16, uint16_t, ARG) \
262 MACRO(32, uint32_t, ARG) \
263 MACRO(64, uint64_t, ARG)
264 #define EACH_SIGNED_SIZE(MACRO, ARG) \
265 MACRO(7, int8_t, ARG) \
266 MACRO(15, int16_t, ARG) \
267 MACRO(31, int32_t, ARG) \
268 MACRO(63, int64_t, ARG)
269 // calculate how much buffer size we need
273 #define SIZE_TEST(N, T, NEG) \
274 for (size_t s = 0; s <= N; ++s) { \
277 EACH_UNSIGNED_SIZE(SIZE_TEST, false)
278 EACH_SIGNED_SIZE(SIZE_TEST, false)
279 EACH_SIGNED_SIZE(SIZE_TEST, true)
283 // bits->bytes, rounding up
284 bufSize = (bufSize + 7) / 8;
285 // round up to next multiple of 8
286 bufSize = (bufSize + 7) / 8 * 8;
287 std::vector<uint8_t> buffer(bufSize);
288 uint8_t *buf = buffer.data();
291 #define WRITE_TEST(N, T, NEG) \
292 for (size_t s = 0; s <= N; ++s) { \
293 CHECK_LE(s + w, 8 * bufSize); \
294 testSet<aligned>(buf, w, s, testValue<T, NEG>(s)); \
295 EXPECT_EQ((testValue<T, NEG>(s)), (testGet<aligned, T>(buf, w, s))) << s; \
298 EACH_UNSIGNED_SIZE(WRITE_TEST, false)
299 EACH_SIGNED_SIZE(WRITE_TEST, false)
300 EACH_SIGNED_SIZE(WRITE_TEST, true)
305 #define READ_TEST(N, T, NEG) \
306 for (size_t s = 0; s <= N; ++s) { \
307 CHECK_LE(s + r, 8 * bufSize); \
308 EXPECT_EQ((testValue<T, NEG>(s)), (testGet<aligned, T>(buf, r, s))) << s; \
311 EACH_UNSIGNED_SIZE(READ_TEST, false)
312 EACH_SIGNED_SIZE(READ_TEST, false)
313 EACH_SIGNED_SIZE(READ_TEST, true)
316 #undef EACH_UNSIGNED_SIZE
319 TEST(Bits, ConcatenationUnalignedUnsigned) { testConcatenation<false>(); }
321 TEST(Bits, ConcatenationAligned) { testConcatenation<true>(); }
323 int main(int argc, char *argv[]) {
324 testing::InitGoogleTest(&argc, argv);
325 gflags::ParseCommandLineFlags(&argc, &argv, true);
326 return RUN_ALL_TESTS();