2 * Copyright 2013 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/small_vector.h"
19 #include <gtest/gtest.h>
25 #include <boost/algorithm/string.hpp>
27 #include "folly/Conv.h"
29 using folly::small_vector;
30 using namespace folly::small_vector_policy;
32 #if defined(__x86_64__)
34 static_assert(sizeof(small_vector<int>) == 16,
35 "Object size is not what we expect for small_vector<int>");
36 static_assert(sizeof(small_vector<int32_t,2>) == 16,
37 "Object size is not what we expect for "
38 "small_vector<int32_t,2>");
39 static_assert(sizeof(small_vector<int,10>) ==
40 10 * sizeof(int) + sizeof(std::size_t),
41 "Object size is not what we expect for small_vector<int,10>");
43 static_assert(sizeof(small_vector<int32_t,1,uint32_t>) ==
45 "small_vector<int32_t,1,uint32_t> is wrong size");
46 static_assert(sizeof(small_vector<int32_t,1,uint16_t>) ==
48 "small_vector<int32_t,1,uint32_t> is wrong size");
49 static_assert(sizeof(small_vector<int32_t,1,uint8_t>) ==
51 "small_vector<int32_t,1,uint32_t> is wrong size");
53 static_assert(sizeof(small_vector<int32_t,1,OneBitMutex>) == 16,
54 "OneBitMutex took more space than expected");
56 static_assert(sizeof(small_vector<int16_t,4,uint16_t>) == 10,
57 "Sizeof unexpectedly large");
58 static_assert(sizeof(small_vector<int16_t,4,uint16_t,OneBitMutex>) == 10,
59 "Sizeof unexpectedly large");
60 static_assert(sizeof(small_vector<int16_t,4,NoHeap,uint16_t,
62 "Sizeof unexpectedly large");
68 struct NontrivialType {
70 explicit NontrivialType() : a(0) {}
72 /* implicit */ NontrivialType(int a) : a(a) {
76 NontrivialType(NontrivialType const& s) {
80 NontrivialType& operator=(NontrivialType const& o) {
87 static_assert(!FOLLY_IS_TRIVIALLY_COPYABLE(NontrivialType),
88 "NontrivialType is trivially copyable");
90 int NontrivialType::ctored = 0;
92 struct TestException {};
96 if (!--throwCounter) {
97 throw TestException();
101 const int kMagic = 0xdeadbeef;
105 Thrower() : magic(kMagic) {
106 EXPECT_EQ(magic, kMagic);
110 Thrower(Thrower const& other) : magic(other.magic) {
111 EXPECT_EQ(magic, kMagic);
115 ~Thrower() noexcept {
116 EXPECT_EQ(magic, kMagic);
121 Thrower& operator=(Thrower const& other) {
122 EXPECT_EQ(magic, kMagic);
127 // This is just to try to make sure we don't get our member
128 // functions called on uninitialized memory.
132 int Thrower::alive = 0;
134 // Type that counts how many exist and doesn't support copy
136 struct NoncopyableCounter {
138 NoncopyableCounter() {
141 ~NoncopyableCounter() {
144 NoncopyableCounter(NoncopyableCounter&&) { ++alive; }
145 NoncopyableCounter(NoncopyableCounter const&) = delete;
146 NoncopyableCounter& operator=(NoncopyableCounter const&) const = delete;
147 NoncopyableCounter& operator=(NoncopyableCounter&&) { return *this; }
149 int NoncopyableCounter::alive = 0;
151 static_assert(!FOLLY_IS_TRIVIALLY_COPYABLE(NoncopyableCounter),
152 "NoncopyableCounter is trivially copyable");
154 // Check that throws don't break the basic guarantee for some cases.
155 // Uses the method for testing exception safety described at
156 // http://www.boost.org/community/exception_safety.html, to force all
157 // throwing code paths to occur.
158 struct TestBasicGuarantee {
159 folly::small_vector<Thrower,3> vec;
160 int const prepopulate;
162 explicit TestBasicGuarantee(int prepopulate)
163 : prepopulate(prepopulate)
166 for (int i = 0; i < prepopulate; ++i) {
167 vec.push_back(Thrower());
171 ~TestBasicGuarantee() {
175 template<class Operation>
176 void operator()(int insertCount, Operation const& op) {
179 std::unique_ptr<folly::small_vector<Thrower,3> > workingVec;
180 for (int counter = 1; !done; ++counter) {
182 workingVec.reset(new folly::small_vector<Thrower,3>(vec));
183 throwCounter = counter;
184 EXPECT_EQ(Thrower::alive, prepopulate * 2);
189 // Note that the size of the vector can change if we were
190 // inserting somewhere other than the end (it's a basic only
191 // guarantee). All we're testing here is that we have the
192 // right amount of uninitialized vs initialized memory.
193 EXPECT_EQ(Thrower::alive, workingVec->size() + vec.size());
197 // If things succeeded.
198 EXPECT_EQ(workingVec->size(), prepopulate + insertCount);
199 EXPECT_EQ(Thrower::alive, prepopulate * 2 + insertCount);
206 TEST(small_vector, BasicGuarantee) {
207 for (int prepop = 1; prepop < 30; ++prepop) {
208 (TestBasicGuarantee(prepop))( // parens or a mildly vexing parse :(
210 [&] (folly::small_vector<Thrower,3>& v) {
211 v.push_back(Thrower());
215 EXPECT_EQ(Thrower::alive, 0);
217 (TestBasicGuarantee(prepop))(
219 [&] (folly::small_vector<Thrower,3>& v) {
220 v.insert(v.begin(), Thrower());
224 EXPECT_EQ(Thrower::alive, 0);
226 (TestBasicGuarantee(prepop))(
228 [&] (folly::small_vector<Thrower,3>& v) {
229 v.insert(v.begin() + 1, Thrower());
233 EXPECT_EQ(Thrower::alive, 0);
236 TestBasicGuarantee(4)(
238 [&] (folly::small_vector<Thrower,3>& v) {
239 std::vector<Thrower> b;
240 b.push_back(Thrower());
241 b.push_back(Thrower());
242 b.push_back(Thrower());
245 * Apparently if you do the following initializer_list instead
246 * of the above push_back's, and one of the Throwers throws,
247 * g++4.6 doesn't destruct the previous ones. Heh.
249 //b = { Thrower(), Thrower(), Thrower() };
250 v.insert(v.begin() + 1, b.begin(), b.end());
254 TestBasicGuarantee(2)(
256 [&] (folly::small_vector<Thrower,3>& v) {
257 std::vector<Thrower> b;
258 for (int i = 0; i < 6; ++i) {
259 b.push_back(Thrower());
262 v.insert(v.begin() + 1, b.begin(), b.end());
266 EXPECT_EQ(Thrower::alive, 0);
269 folly::small_vector<Thrower,1> p(14, Thrower());
272 EXPECT_EQ(Thrower::alive, 0);
276 // MALLOC_CONF=prof_leak:true
277 // LD_PRELOAD=${JEMALLOC_PATH}/lib/libjemalloc.so.1
278 // LD_PRELOAD="$LD_PRELOAD:"${UNWIND_PATH}/lib/libunwind.so.7
279 TEST(small_vector, leak_test) {
280 for (int j = 0; j < 1000; ++j) {
281 folly::small_vector<int, 10> someVec(300);
282 for (int i = 0; i < 10000; ++i) {
283 someVec.push_back(12);
288 TEST(small_vector, Insert) {
289 folly::small_vector<int> someVec(3, 3);
290 someVec.insert(someVec.begin(), 12, 12);
291 EXPECT_EQ(someVec.size(), 15);
292 for (int i = 0; i < someVec.size(); ++i) {
294 EXPECT_EQ(someVec[i], 12);
296 EXPECT_EQ(someVec[i], 3);
300 auto oldSize = someVec.size();
301 someVec.insert(someVec.begin() + 1, 12, 12);
302 EXPECT_EQ(someVec.size(), oldSize + 12);
304 folly::small_vector<std::string> v1(6, "asd"), v2(7, "wat");
305 v1.insert(v1.begin() + 1, v2.begin(), v2.end());
306 EXPECT_TRUE(v1.size() == 6 + 7);
307 EXPECT_EQ(v1.front(), "asd");
308 EXPECT_EQ(v1[1], "wat");
311 TEST(small_vector, Swap) {
312 folly::small_vector<int,10> somethingVec, emptyVec;
313 somethingVec.push_back(1);
314 somethingVec.push_back(2);
315 somethingVec.push_back(3);
316 somethingVec.push_back(4);
318 // Swapping intern'd with intern'd.
319 auto vec = somethingVec;
320 EXPECT_TRUE(vec == somethingVec);
321 EXPECT_FALSE(vec == emptyVec);
322 EXPECT_FALSE(somethingVec == emptyVec);
324 // Swapping a heap vector with an intern vector.
325 folly::small_vector<int,10> junkVec;
326 junkVec.assign(12, 12);
327 EXPECT_EQ(junkVec.size(), 12);
328 for (auto i : junkVec) {
332 EXPECT_TRUE(junkVec == somethingVec);
333 EXPECT_EQ(vec.size(), 12);
338 // Swapping two heap vectors.
339 folly::small_vector<int,10> moreJunk(15, 15);
340 EXPECT_EQ(moreJunk.size(), 15);
341 for (auto i : moreJunk) {
345 EXPECT_EQ(moreJunk.size(), 12);
346 for (auto i : moreJunk) {
349 EXPECT_EQ(vec.size(), 15);
354 // Making a vector heap, then smaller than another non-heap vector,
356 folly::small_vector<int,5> shrinker, other(4, 10);
357 shrinker = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
358 shrinker.erase(shrinker.begin() + 2, shrinker.end());
359 EXPECT_LT(shrinker.size(), other.size());
360 swap(shrinker, other);
361 EXPECT_EQ(shrinker.size(), 4);
362 EXPECT_TRUE(boost::all(shrinker, boost::is_any_of(std::vector<int>{10})));
363 EXPECT_TRUE((other == small_vector<int,5>{ 0, 1 }));
366 TEST(small_vector, Emplace) {
367 NontrivialType::ctored = 0;
369 folly::small_vector<NontrivialType> vec;
371 vec.emplace_back(12);
372 EXPECT_EQ(NontrivialType::ctored, 1);
373 EXPECT_EQ(vec.front().a, 12);
374 vec.emplace_back(13);
375 EXPECT_EQ(vec.front().a, 12);
376 EXPECT_EQ(vec.back().a, 13);
377 EXPECT_EQ(NontrivialType::ctored, 2);
379 NontrivialType::ctored = 0;
380 for (int i = 0; i < 120; ++i) {
383 EXPECT_EQ(NontrivialType::ctored, 120);
384 EXPECT_EQ(vec[0].a, 12);
385 EXPECT_EQ(vec[1].a, 13);
386 EXPECT_EQ(vec.back().a, 119);
388 // We implement emplace() with a temporary (see the implementation
389 // for a comment about why), so this should make 2 ctor calls.
390 NontrivialType::ctored = 0;
391 vec.emplace(vec.begin(), 12);
392 EXPECT_EQ(NontrivialType::ctored, 2);
395 TEST(small_vector, Erase) {
396 folly::small_vector<int,4> notherVec = { 1, 2, 3, 4, 5 };
397 EXPECT_EQ(notherVec.front(), 1);
398 EXPECT_EQ(notherVec.size(), 5);
399 notherVec.erase(notherVec.begin());
400 EXPECT_EQ(notherVec.front(), 2);
401 EXPECT_EQ(notherVec.size(), 4);
402 EXPECT_EQ(notherVec[2], 4);
403 EXPECT_EQ(notherVec[3], 5);
404 notherVec.erase(notherVec.begin() + 2);
405 EXPECT_EQ(notherVec.size(), 3);
406 EXPECT_EQ(notherVec[2], 5);
408 folly::small_vector<int,2> vec2 = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
409 vec2.erase(vec2.begin() + 1, vec2.end() - 1);
410 folly::small_vector<int,2> expected = { 1, 10 };
411 EXPECT_TRUE(vec2 == expected);
413 folly::small_vector<std::string,3> v(102, "ASD");
415 EXPECT_EQ(v.size(), 1024);
416 EXPECT_EQ(v.back(), "D");
417 EXPECT_EQ(v.front(), "ASD");
419 EXPECT_EQ(v.front(), "ASD");
420 EXPECT_EQ(v.size(), 1);
422 EXPECT_TRUE(v.empty());
425 TEST(small_vector, GrowShrinkGrow) {
426 folly::small_vector<NontrivialType,7> vec = { 1, 2, 3, 4, 5 };
427 std::generate_n(std::back_inserter(vec), 102, std::rand);
429 auto capacity = vec.capacity();
431 auto oldSize = vec.size();
432 for (int i = 0; i < oldSize; ++i) {
433 vec.erase(vec.begin() + (std::rand() % vec.size()));
434 EXPECT_EQ(vec.capacity(), capacity);
436 EXPECT_TRUE(vec.empty());
438 EXPECT_EQ(vec.capacity(), capacity);
439 std::generate_n(std::back_inserter(vec), 102, std::rand);
440 EXPECT_EQ(vec.capacity(), capacity);
442 std::generate_n(std::back_inserter(vec), 4096, std::rand);
443 EXPECT_GT(vec.capacity(), capacity);
447 EXPECT_LT(vec.capacity(), capacity);
450 EXPECT_EQ(vec.capacity(), 7); // in situ size
453 TEST(small_vector, Iteration) {
454 folly::small_vector<std::string,3> vec = { "foo", "bar" };
455 vec.push_back("blah");
456 vec.push_back("blah2");
457 vec.push_back("blah3");
458 vec.erase(vec.begin() + 2);
460 std::vector<std::string> otherVec;
461 for (auto& s : vec) {
462 otherVec.push_back(s);
464 EXPECT_EQ(otherVec.size(), vec.size());
465 if (otherVec.size() == vec.size()) {
466 EXPECT_TRUE(std::equal(otherVec.begin(), otherVec.end(), vec.begin()));
469 std::reverse(otherVec.begin(), otherVec.end());
470 auto oit = otherVec.begin();
471 auto rit = vec.crbegin();
472 for (; rit != vec.crend(); ++oit, ++rit) {
473 EXPECT_EQ(*oit, *rit);
477 TEST(small_vector, NonCopyableType) {
478 folly::small_vector<NontrivialType,2> vec;
480 for (int i = 0; i < 10; ++i) {
481 vec.emplace(vec.begin(), 13);
483 EXPECT_EQ(vec.size(), 10);
484 auto vec2 = std::move(vec);
485 EXPECT_EQ(vec.size(), 0);
486 EXPECT_EQ(vec2.size(), 10);
489 folly::small_vector<NoncopyableCounter,3> vec3;
490 for (int i = 0; i < 10; ++i) {
491 EXPECT_EQ(vec3.size(), i);
492 EXPECT_EQ(NoncopyableCounter::alive, i);
493 vec3.insert(vec3.begin(), NoncopyableCounter());
495 EXPECT_EQ(vec3.size(), 10);
496 EXPECT_EQ(NoncopyableCounter::alive, 10);
498 vec3.insert(vec3.begin() + 3, NoncopyableCounter());
499 EXPECT_EQ(NoncopyableCounter::alive, 11);
500 auto vec4 = std::move(vec3);
501 EXPECT_EQ(NoncopyableCounter::alive, 11);
503 EXPECT_EQ(NoncopyableCounter::alive, 30);
504 vec4.erase(vec4.begin(), vec4.end());
505 EXPECT_EQ(vec4.size(), 0);
506 EXPECT_EQ(NoncopyableCounter::alive, 0);
509 TEST(small_vector, MoveConstructor) {
510 folly::small_vector<std::string,10> v1;
513 auto v2 = std::move(v1);
514 EXPECT_EQ(v2.size(), 2);
515 EXPECT_EQ(v2[0], "asd");
516 EXPECT_EQ(v2[1], "bsd");
519 EXPECT_EQ(v1.size(), 2);
520 EXPECT_EQ(v1[0], "asd");
521 EXPECT_EQ(v1[1], "bsd");
524 TEST(small_vector, NoHeap) {
525 typedef folly::small_vector<std::string,10,
526 std::size_t,folly::small_vector_policy::NoHeap> Vector;
529 EXPECT_EQ(v.max_size(), 10);
531 for (int i = 0; i < 10; ++i) {
532 v.push_back(folly::to<std::string>(i));
533 EXPECT_EQ(v.size(), i + 1);
538 v.insert(v.begin(), "ha");
539 } catch (const std::length_error&) {
544 // Check max_size works right with various policy combinations.
545 folly::small_vector<std::string,32,uint32_t,NoHeap,OneBitMutex> v2;
546 EXPECT_EQ(v2.max_size(), 32);
547 folly::small_vector<std::string,32,uint32_t,OneBitMutex> v3;
548 EXPECT_EQ(v3.max_size(), (1ul << 30) - 1);
549 folly::small_vector<std::string,32,uint32_t> v4;
550 EXPECT_EQ(v4.max_size(), (1ul << 31) - 1);
553 * Test that even when we ask for a small number inlined it'll still
554 * inline at least as much as it takes to store the value_type
557 folly::small_vector<char,1,NoHeap> notsosmall;
558 EXPECT_EQ(notsosmall.max_size(), sizeof(char*));
561 notsosmall.push_back(12);
562 notsosmall.push_back(13);
563 notsosmall.push_back(14);
564 } catch (const std::length_error&) {
567 EXPECT_FALSE(caught);
570 TEST(small_vector, MaxSize) {
571 folly::small_vector<int,2,uint8_t> vec;
572 EXPECT_EQ(vec.max_size(), 127);
573 folly::small_vector<int,2,uint16_t> vec2;
574 EXPECT_EQ(vec2.max_size(), (1 << 15) - 1);
575 folly::small_vector<int,2,uint16_t,OneBitMutex> vec3;
576 EXPECT_EQ(vec3.max_size(), (1 << 14) - 1);
579 TEST(small_vector, AllHeap) {
580 // Use something bigger than the pointer so it can't get inlined.
582 double a, b, c, d, e; int val;
583 SomeObj(int val) : val(val) {}
584 bool operator==(SomeObj const& o) const {
589 folly::small_vector<SomeObj,0> vec = { 1 };
590 EXPECT_EQ(vec.size(), 1);
592 EXPECT_TRUE(vec[0] == 1);
594 vec.insert(vec.begin(), { 0, 1, 2, 3 });
595 EXPECT_EQ(vec.size(), 5);
596 EXPECT_TRUE((vec == folly::small_vector<SomeObj,0>{ 0, 1, 2, 3, 1 }));
599 TEST(small_vector, Basic) {
600 typedef folly::small_vector<int,3,uint32_t
614 EXPECT_EQ(a.front(), 12);
615 EXPECT_EQ(a.size(), 1);
617 EXPECT_EQ(a.size(), 2);
618 EXPECT_EQ(a.front(), 12);
619 EXPECT_EQ(a.back(), 13);
621 a.emplace(a.end(), 32);
622 EXPECT_EQ(a.back(), 32);
624 a.emplace(a.begin(), 12);
625 EXPECT_EQ(a.front(), 12);
626 EXPECT_EQ(a.back(), 32);
627 a.erase(a.end() - 1);
628 EXPECT_EQ(a.back(), 13);
631 EXPECT_EQ(a.back(), 12);
633 EXPECT_EQ(a.back(), 13);
636 a.push_back(s); // lvalue reference
643 EXPECT_TRUE(c != b && b != a);
645 EXPECT_GT(c.size(), 0);
647 EXPECT_EQ(c.size(), 1);
652 TEST(small_vector, Capacity) {
653 folly::small_vector<unsigned long, 1> vec;
654 EXPECT_EQ(vec.size(), 0);
655 EXPECT_EQ(vec.capacity(), 1);
658 EXPECT_EQ(vec.size(), 1);
659 EXPECT_EQ(vec.capacity(), 1);
662 EXPECT_EQ(vec.size(), 2);
663 EXPECT_GT(vec.capacity(), 1);
666 folly::small_vector<unsigned long, 2> vec2;
667 EXPECT_EQ(vec2.size(), 0);
668 EXPECT_EQ(vec2.capacity(), 2);
672 EXPECT_EQ(vec2.size(), 2);
673 EXPECT_EQ(vec2.capacity(), 2);
676 EXPECT_EQ(vec2.size(), 3);
677 EXPECT_GT(vec2.capacity(), 2);
679 // Test capacity heapifying logic
680 folly::small_vector<unsigned char, 1> vec3;
681 const size_t hc_size = 1000000;
682 for (size_t i = 0; i < hc_size; ++i) {
683 auto v = (unsigned char)i;
685 EXPECT_EQ(vec3[i], v);
686 EXPECT_EQ(vec3.size(), i + 1);
687 EXPECT_GT(vec3.capacity(), i);
689 for (auto i = hc_size; i > 0; --i) {
690 auto v = (unsigned char)(i - 1);
691 EXPECT_EQ(vec3.back(), v);
693 EXPECT_EQ(vec3.size(), i - 1);
697 TEST(small_vector, SelfPushBack) {
698 for (int i = 1; i < 33; ++i) {
699 folly::small_vector<std::string> vec;
700 for (int j = 0; j < i; ++j) {
701 vec.push_back("abc");
703 EXPECT_EQ(vec.size(), i);
704 vec.push_back(std::move(vec[0]));
705 EXPECT_EQ(vec.size(), i + 1);
707 EXPECT_EQ(vec[i], "abc");
711 TEST(small_vector, SelfEmplaceBack) {
712 for (int i = 1; i < 33; ++i) {
713 folly::small_vector<std::string> vec;
714 for (int j = 0; j < i; ++j) {
715 vec.emplace_back("abc");
717 EXPECT_EQ(vec.size(), i);
718 vec.emplace_back(std::move(vec[0]));
719 EXPECT_EQ(vec.size(), i + 1);
721 EXPECT_EQ(vec[i], "abc");
725 TEST(small_vector, SelfInsert) {
727 for (int i = 1; i < 33; ++i) {
728 folly::small_vector<std::string> vec;
729 for (int j = 0; j < i; ++j) {
730 vec.push_back("abc");
732 EXPECT_EQ(vec.size(), i);
733 vec.insert(vec.end(), std::move(vec[0]));
734 EXPECT_EQ(vec.size(), i + 1);
736 EXPECT_EQ(vec[i], "abc");
737 EXPECT_EQ(vec[vec.size() - 1], "abc");
741 for (int i = 2; i < 33; ++i) {
742 folly::small_vector<std::string> vec;
743 for (int j = 0; j < i; ++j) {
744 vec.push_back("abc");
746 EXPECT_EQ(vec.size(), i);
747 vec.insert(vec.end()-1, std::move(vec[0]));
748 EXPECT_EQ(vec.size(), i + 1);
750 EXPECT_EQ(vec[i-1], "abc");
751 EXPECT_EQ(vec[i], "abc");