folly/small_vector.h

   1 /*
   2  * Copyright 2014 Facebook, Inc.
   3  *
   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
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /*
  18  * For high-level documentation and usage examples see
  19  * folly/docs/small_vector.md
  20  *
  21  * @author Jordan DeLong <delong.j@fb.com>
  22  */
  23 #ifndef FOLLY_SMALL_VECTOR_H_
  24 #define FOLLY_SMALL_VECTOR_H_
  25
  26 #include <folly/Portability.h>
  27
  28 #include <stdexcept>
  29 #include <cstdlib>
  30 #include <type_traits>
  31 #include <algorithm>
  32 #include <iterator>
  33 #include <cassert>
  34
  35 #include <boost/operators.hpp>
  36 #include <boost/type_traits.hpp>
  37 #include <boost/mpl/if.hpp>
  38 #include <boost/mpl/eval_if.hpp>
  39 #include <boost/mpl/vector.hpp>
  40 #include <boost/mpl/front.hpp>
  41 #include <boost/mpl/filter_view.hpp>
  42 #include <boost/mpl/identity.hpp>
  43 #include <boost/mpl/placeholders.hpp>
  44 #include <boost/mpl/empty.hpp>
  45 #include <boost/mpl/size.hpp>
  46 #include <boost/mpl/count.hpp>
  47 #include <boost/mpl/max.hpp>
  48
  49 #include <folly/Malloc.h>
  50
  51 #if defined(__GNUC__) && FOLLY_X64
  52 # include <folly/SmallLocks.h>
  53 # define FB_PACK_ATTR FOLLY_PACK_ATTR
  54 # define FB_PACK_PUSH FOLLY_PACK_PUSH
  55 # define FB_PACK_POP FOLLY_PACK_POP
  56 #else
  57 # define FB_PACK_ATTR
  58 # define FB_PACK_PUSH
  59 # define FB_PACK_POP
  60 #endif
  61
  62 #if FOLLY_HAVE_MALLOC_SIZE
  63   extern "C" std::size_t malloc_size(const void*);
  64 # if !FOLLY_HAVE_MALLOC_USABLE_SIZE
  65 #  define malloc_usable_size malloc_size
  66 # endif
  67 # ifndef malloc_usable_size
  68 #  define malloc_usable_size malloc_size
  69 # endif
  70 #endif
  71
  72 // Ignore shadowing warnings within this file, so includers can use -Wshadow.
  73 #pragma GCC diagnostic push
  74 #pragma GCC diagnostic ignored "-Wshadow"
  75
  76 namespace folly {
  77
  78 //////////////////////////////////////////////////////////////////////
  79
  80 namespace small_vector_policy {
  81
  82 //////////////////////////////////////////////////////////////////////
  83
  84 /*
  85  * A flag which makes us refuse to use the heap at all.  If we
  86  * overflow the in situ capacity we throw an exception.
  87  */
  88 struct NoHeap;
  89
  90 //////////////////////////////////////////////////////////////////////
  91
  92 } // small_vector_policy
  93
  94 //////////////////////////////////////////////////////////////////////
  95
  96 template<class T, std::size_t M, class A, class B, class C>
  97 class small_vector;
  98
  99 //////////////////////////////////////////////////////////////////////
 100
 101 namespace detail {
 102
 103   /*
 104    * Move a range to a range of uninitialized memory.  Assumes the
 105    * ranges don't overlap.
 106    */
 107   template<class T>
 108   typename std::enable_if<
 109     !FOLLY_IS_TRIVIALLY_COPYABLE(T)
 110   >::type
 111   moveToUninitialized(T* first, T* last, T* out) {
 112     auto const count = last - first;
 113     std::size_t idx = 0;
 114     try {
 115       for (; idx < count; ++first, ++idx) {
 116         new (&out[idx]) T(std::move(*first));
 117       }
 118     } catch (...) {
 119       // Even for callers trying to give the strong guarantee
 120       // (e.g. push_back) it's ok to assume here that we don't have to
 121       // move things back and that it was a copy constructor that
 122       // threw: if someone throws from a move constructor the effects
 123       // are unspecified.
 124       for (std::size_t i = 0; i < idx; ++i) {
 125         out[i].~T();
 126       }
 127       throw;
 128     }
 129   }
 130
 131   // Specialization for trivially copyable types.
 132   template<class T>
 133   typename std::enable_if<
 134     FOLLY_IS_TRIVIALLY_COPYABLE(T)
 135   >::type
 136   moveToUninitialized(T* first, T* last, T* out) {
 137     std::memmove(out, first, (last - first) * sizeof *first);
 138   }
 139
 140   /*
 141    * Move objects in memory to the right into some uninitialized
 142    * memory, where the region overlaps.  This doesn't just use
 143    * std::move_backward because move_backward only works if all the
 144    * memory is initialized to type T already.
 145    */
 146   template<class T>
 147   typename std::enable_if<
 148     !FOLLY_IS_TRIVIALLY_COPYABLE(T)
 149   >::type
 150   moveObjectsRight(T* first, T* lastConstructed, T* realLast) {
 151     if (lastConstructed == realLast) {
 152       return;
 153     }
 154
 155     T* end = first - 1; // Past the end going backwards.
 156     T* out = realLast - 1;
 157     T* in = lastConstructed - 1;
 158     try {
 159       for (; in != end && out >= lastConstructed; --in, --out) {
 160         new (out) T(std::move(*in));
 161       }
 162       for (; in != end; --in, --out) {
 163         *out = std::move(*in);
 164       }
 165       for (; out >= lastConstructed; --out) {
 166         new (out) T();
 167       }
 168     } catch (...) {
 169       // We want to make sure the same stuff is uninitialized memory
 170       // if we exit via an exception (this is to make sure we provide
 171       // the basic exception safety guarantee for insert functions).
 172       if (out < lastConstructed) {
 173         out = lastConstructed - 1;
 174       }
 175       for (auto it = out + 1; it != realLast; ++it) {
 176         it->~T();
 177       }
 178       throw;
 179     }
 180   }
 181
 182   // Specialization for trivially copyable types.  The call to
 183   // std::move_backward here will just turn into a memmove.  (TODO:
 184   // change to std::is_trivially_copyable when that works.)
 185   template<class T>
 186   typename std::enable_if<
 187     FOLLY_IS_TRIVIALLY_COPYABLE(T)
 188   >::type
 189   moveObjectsRight(T* first, T* lastConstructed, T* realLast) {
 190     std::move_backward(first, lastConstructed, realLast);
 191   }
 192
 193   /*
 194    * Populate a region of memory using `op' to construct elements.  If
 195    * anything throws, undo what we did.
 196    */
 197   template<class T, class Function>
 198   void populateMemForward(T* mem, std::size_t n, Function const& op) {
 199     std::size_t idx = 0;
 200     try {
 201       for (size_t i = 0; i < n; ++i) {
 202         op(&mem[idx]);
 203         ++idx;
 204       }
 205     } catch (...) {
 206       for (std::size_t i = 0; i < idx; ++i) {
 207         mem[i].~T();
 208       }
 209       throw;
 210     }
 211   }
 212
 213   template<class SizeType, bool ShouldUseHeap>
 214   struct IntegralSizePolicy {
 215     typedef SizeType InternalSizeType;
 216
 217     IntegralSizePolicy() : size_(0) {}
 218
 219   protected:
 220     static constexpr std::size_t policyMaxSize() {
 221       return SizeType(~kExternMask);
 222     }
 223
 224     std::size_t doSize() const {
 225       return size_ & ~kExternMask;
 226     }
 227
 228     std::size_t isExtern() const {
 229       return kExternMask & size_;
 230     }
 231
 232     void setExtern(bool b) {
 233       if (b) {
 234         size_ |= kExternMask;
 235       } else {
 236         size_ &= ~kExternMask;
 237       }
 238     }
 239
 240     void setSize(std::size_t sz) {
 241       assert(sz <= policyMaxSize());
 242       size_ = (kExternMask & size_) | SizeType(sz);
 243     }
 244
 245     void swapSizePolicy(IntegralSizePolicy& o) {
 246       std::swap(size_, o.size_);
 247     }
 248
 249   protected:
 250     static bool const kShouldUseHeap = ShouldUseHeap;
 251
 252   private:
 253     static SizeType const kExternMask =
 254       kShouldUseHeap ? SizeType(1) << (sizeof(SizeType) * 8 - 1)
 255                      : 0;
 256
 257     SizeType size_;
 258   };
 259
 260   /*
 261    * If you're just trying to use this class, ignore everything about
 262    * this next small_vector_base class thing.
 263    *
 264    * The purpose of this junk is to minimize sizeof(small_vector<>)
 265    * and allow specifying the template parameters in whatever order is
 266    * convenient for the user.  There's a few extra steps here to try
 267    * to keep the error messages at least semi-reasonable.
 268    *
 269    * Apologies for all the black magic.
 270    */
 271   namespace mpl = boost::mpl;
 272   template<class Value,
 273            std::size_t RequestedMaxInline,
 274            class InPolicyA,
 275            class InPolicyB,
 276            class InPolicyC>
 277   struct small_vector_base {
 278     typedef mpl::vector<InPolicyA,InPolicyB,InPolicyC> PolicyList;
 279
 280     /*
 281      * Determine the size type
 282      */
 283     typedef typename mpl::filter_view<
 284       PolicyList,
 285       boost::is_integral<mpl::placeholders::_1>
 286     >::type Integrals;
 287     typedef typename mpl::eval_if<
 288       mpl::empty<Integrals>,
 289       mpl::identity<std::size_t>,
 290       mpl::front<Integrals>
 291     >::type SizeType;
 292
 293     static_assert(std::is_unsigned<SizeType>::value,
 294                   "Size type should be an unsigned integral type");
 295     static_assert(mpl::size<Integrals>::value == 0 ||
 296                     mpl::size<Integrals>::value == 1,
 297                   "Multiple size types specified in small_vector<>");
 298
 299     /*
 300      * Determine whether we should allow spilling to the heap or not.
 301      */
 302     typedef typename mpl::count<
 303       PolicyList,small_vector_policy::NoHeap
 304     >::type HasNoHeap;
 305
 306     static_assert(HasNoHeap::value == 0 || HasNoHeap::value == 1,
 307                   "Multiple copies of small_vector_policy::NoHeap "
 308                   "supplied; this is probably a mistake");
 309
 310     /*
 311      * Make the real policy base classes.
 312      */
 313     typedef IntegralSizePolicy<SizeType,!HasNoHeap::value>
 314       ActualSizePolicy;
 315
 316     /*
 317      * Now inherit from them all.  This is done in such a convoluted
 318      * way to make sure we get the empty base optimizaton on all these
 319      * types to keep sizeof(small_vector<>) minimal.
 320      */
 321     typedef boost::totally_ordered1<
 322       small_vector<Value,RequestedMaxInline,InPolicyA,InPolicyB,InPolicyC>,
 323       ActualSizePolicy
 324     > type;
 325   };
 326
 327   template <class T>
 328   T* pointerFlagSet(T* p) {
 329     return reinterpret_cast<T*>(reinterpret_cast<uintptr_t>(p) | 1);
 330   }
 331   template <class T>
 332   bool pointerFlagGet(T* p) {
 333     return reinterpret_cast<uintptr_t>(p) & 1;
 334   }
 335   template <class T>
 336   T* pointerFlagClear(T* p) {
 337     return reinterpret_cast<T*>(
 338       reinterpret_cast<uintptr_t>(p) & ~uintptr_t(1));
 339   }
 340   inline void* shiftPointer(void* p, size_t sizeBytes) {
 341     return static_cast<char*>(p) + sizeBytes;
 342   }
 343 }
 344
 345 //////////////////////////////////////////////////////////////////////
 346 FB_PACK_PUSH
 347 template<class Value,
 348          std::size_t RequestedMaxInline    = 1,
 349          class PolicyA                     = void,
 350          class PolicyB                     = void,
 351          class PolicyC                     = void>
 352 class small_vector
 353   : public detail::small_vector_base<
 354       Value,RequestedMaxInline,PolicyA,PolicyB,PolicyC
 355     >::type
 356 {
 357   typedef typename detail::small_vector_base<
 358     Value,RequestedMaxInline,PolicyA,PolicyB,PolicyC
 359   >::type BaseType;
 360   typedef typename BaseType::InternalSizeType InternalSizeType;
 361
 362   /*
 363    * Figure out the max number of elements we should inline.  (If
 364    * the user asks for less inlined elements than we can fit unioned
 365    * into our value_type*, we will inline more than they asked.)
 366    */
 367   enum {
 368     MaxInline = boost::mpl::max<
 369                   boost::mpl::int_<sizeof(Value*) / sizeof(Value)>,
 370                   boost::mpl::int_<RequestedMaxInline>
 371                 >::type::value
 372   };
 373
 374 public:
 375   typedef std::size_t        size_type;
 376   typedef Value              value_type;
 377   typedef value_type&        reference;
 378   typedef value_type const&  const_reference;
 379   typedef value_type*        iterator;
 380   typedef value_type const*  const_iterator;
 381   typedef std::ptrdiff_t     difference_type;
 382
 383   typedef std::reverse_iterator<iterator>       reverse_iterator;
 384   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
 385
 386   explicit small_vector() {}
 387
 388   small_vector(small_vector const& o) {
 389     auto n = o.size();
 390     makeSize(n);
 391     try {
 392       std::uninitialized_copy(o.begin(), o.end(), begin());
 393     } catch (...) {
 394       if (this->isExtern()) {
 395         u.freeHeap();
 396       }
 397       throw;
 398     }
 399     this->setSize(n);
 400   }
 401
 402   small_vector(small_vector&& o)
 403   noexcept(std::is_nothrow_move_constructible<Value>::value) {
 404     if (o.isExtern()) {
 405       swap(o);
 406     } else {
 407       std::uninitialized_copy(std::make_move_iterator(o.begin()),
 408                               std::make_move_iterator(o.end()),
 409                               begin());
 410       this->setSize(o.size());
 411     }
 412   }
 413
 414   small_vector(std::initializer_list<value_type> il) {
 415     constructImpl(il.begin(), il.end(), std::false_type());
 416   }
 417
 418   explicit small_vector(size_type n, value_type const& t = value_type()) {
 419     doConstruct(n, t);
 420   }
 421
 422   template<class Arg>
 423   explicit small_vector(Arg arg1, Arg arg2)  {
 424     // Forward using std::is_arithmetic to get to the proper
 425     // implementation; this disambiguates between the iterators and
 426     // (size_t, value_type) meaning for this constructor.
 427     constructImpl(arg1, arg2, std::is_arithmetic<Arg>());
 428   }
 429
 430   ~small_vector() {
 431     for (auto& t : *this) {
 432       (&t)->~value_type();
 433     }
 434     if (this->isExtern()) {
 435       u.freeHeap();
 436     }
 437   }
 438
 439   small_vector& operator=(small_vector const& o) {
 440     assign(o.begin(), o.end());
 441     return *this;
 442   }
 443
 444   small_vector& operator=(small_vector&& o) {
 445     // TODO: optimization:
 446     // if both are internal, use move assignment where possible
 447     if (this == &o) return *this;
 448     clear();
 449     swap(o);
 450     return *this;
 451   }
 452
 453   bool operator==(small_vector const& o) const {
 454     return size() == o.size() && std::equal(begin(), end(), o.begin());
 455   }
 456
 457   bool operator<(small_vector const& o) const {
 458     return std::lexicographical_compare(begin(), end(), o.begin(), o.end());
 459   }
 460
 461   static constexpr size_type max_size() {
 462     return !BaseType::kShouldUseHeap ? MaxInline
 463                                      : BaseType::policyMaxSize();
 464   }
 465
 466   size_type size()         const { return this->doSize(); }
 467   bool      empty()        const { return !size(); }
 468
 469   iterator       begin()         { return data(); }
 470   iterator       end()           { return data() + size(); }
 471   const_iterator begin()   const { return data(); }
 472   const_iterator end()     const { return data() + size(); }
 473   const_iterator cbegin()  const { return begin(); }
 474   const_iterator cend()    const { return end(); }
 475
 476   reverse_iterator       rbegin()        { return reverse_iterator(end()); }
 477   reverse_iterator       rend()          { return reverse_iterator(begin()); }
 478
 479   const_reverse_iterator rbegin() const {
 480     return const_reverse_iterator(end());
 481   }
 482
 483   const_reverse_iterator rend() const {
 484     return const_reverse_iterator(begin());
 485   }
 486
 487   const_reverse_iterator crbegin() const { return rbegin(); }
 488   const_reverse_iterator crend()   const { return rend(); }
 489
 490   /*
 491    * Usually one of the simplest functions in a Container-like class
 492    * but a bit more complex here.  We have to handle all combinations
 493    * of in-place vs. heap between this and o.
 494    *
 495    * Basic guarantee only.  Provides the nothrow guarantee iff our
 496    * value_type has a nothrow move or copy constructor.
 497    */
 498   void swap(small_vector& o) {
 499     using std::swap; // Allow ADL on swap for our value_type.
 500
 501     if (this->isExtern() && o.isExtern()) {
 502       this->swapSizePolicy(o);
 503
 504       auto thisCapacity = this->capacity();
 505       auto oCapacity = o.capacity();
 506
 507       std::swap(unpackHack(&u.pdata_.heap_), unpackHack(&o.u.pdata_.heap_));
 508
 509       this->setCapacity(oCapacity);
 510       o.setCapacity(thisCapacity);
 511
 512       return;
 513     }
 514
 515     if (!this->isExtern() && !o.isExtern()) {
 516       auto& oldSmall = size() < o.size() ? *this : o;
 517       auto& oldLarge = size() < o.size() ? o : *this;
 518
 519       for (size_type i = 0; i < oldSmall.size(); ++i) {
 520         swap(oldSmall[i], oldLarge[i]);
 521       }
 522
 523       size_type i = oldSmall.size();
 524       const size_type ci = i;
 525       try {
 526         for (; i < oldLarge.size(); ++i) {
 527           auto addr = oldSmall.begin() + i;
 528           new (addr) value_type(std::move(oldLarge[i]));
 529           oldLarge[i].~value_type();
 530         }
 531       } catch (...) {
 532         oldSmall.setSize(i);
 533         for (; i < oldLarge.size(); ++i) {
 534           oldLarge[i].~value_type();
 535         }
 536         oldLarge.setSize(ci);
 537         throw;
 538       }
 539       oldSmall.setSize(i);
 540       oldLarge.setSize(ci);
 541       return;
 542     }
 543
 544     // isExtern != o.isExtern()
 545     auto& oldExtern = o.isExtern() ? o : *this;
 546     auto& oldIntern = o.isExtern() ? *this : o;
 547
 548     auto oldExternCapacity = oldExtern.capacity();
 549     auto oldExternHeap     = oldExtern.u.pdata_.heap_;
 550
 551     auto buff = oldExtern.u.buffer();
 552     size_type i = 0;
 553     try {
 554       for (; i < oldIntern.size(); ++i) {
 555         new (&buff[i]) value_type(std::move(oldIntern[i]));
 556         oldIntern[i].~value_type();
 557       }
 558     } catch (...) {
 559       for (size_type kill = 0; kill < i; ++kill) {
 560         buff[kill].~value_type();
 561       }
 562       for (; i < oldIntern.size(); ++i) {
 563         oldIntern[i].~value_type();
 564       }
 565       oldIntern.setSize(0);
 566       oldExtern.u.pdata_.heap_ = oldExternHeap;
 567       oldExtern.setCapacity(oldExternCapacity);
 568       throw;
 569     }
 570     oldIntern.u.pdata_.heap_ = oldExternHeap;
 571     this->swapSizePolicy(o);
 572     oldIntern.setCapacity(oldExternCapacity);
 573   }
 574
 575   void resize(size_type sz) {
 576     if (sz < size()) {
 577       erase(begin() + sz, end());
 578       return;
 579     }
 580     makeSize(sz);
 581     detail::populateMemForward(begin() + size(), sz - size(),
 582       [&] (void* p) { new (p) value_type(); }
 583     );
 584     this->setSize(sz);
 585   }
 586
 587   void resize(size_type sz, value_type const& v) {
 588     if (sz < size()) {
 589       erase(begin() + sz, end());
 590       return;
 591     }
 592     makeSize(sz);
 593     detail::populateMemForward(begin() + size(), sz - size(),
 594       [&] (void* p) { new (p) value_type(v); }
 595     );
 596     this->setSize(sz);
 597   }
 598
 599   value_type* data() noexcept {
 600     return this->isExtern() ? u.heap() : u.buffer();
 601   }
 602
 603   value_type const* data() const noexcept {
 604     return this->isExtern() ? u.heap() : u.buffer();
 605   }
 606
 607   template<class ...Args>
 608   iterator emplace(const_iterator p, Args&&... args) {
 609     if (p == cend()) {
 610       emplace_back(std::forward<Args>(args)...);
 611       return end() - 1;
 612     }
 613
 614     /*
 615      * We implement emplace at places other than at the back with a
 616      * temporary for exception safety reasons.  It is possible to
 617      * avoid having to do this, but it becomes hard to maintain the
 618      * basic exception safety guarantee (unless you respond to a copy
 619      * constructor throwing by clearing the whole vector).
 620      *
 621      * The reason for this is that otherwise you have to destruct an
 622      * element before constructing this one in its place---if the
 623      * constructor throws, you either need a nothrow default
 624      * constructor or a nothrow copy/move to get something back in the
 625      * "gap", and the vector requirements don't guarantee we have any
 626      * of these.  Clearing the whole vector is a legal response in
 627      * this situation, but it seems like this implementation is easy
 628      * enough and probably better.
 629      */
 630     return insert(p, value_type(std::forward<Args>(args)...));
 631   }
 632
 633   void reserve(size_type sz) {
 634     makeSize(sz);
 635   }
 636
 637   size_type capacity() const {
 638     if (this->isExtern()) {
 639       if (u.hasCapacity()) {
 640         return *u.getCapacity();
 641       }
 642       return malloc_usable_size(u.pdata_.heap_) / sizeof(value_type);
 643     }
 644     return MaxInline;
 645   }
 646
 647   void shrink_to_fit() {
 648     if (!this->isExtern()) {
 649       return;
 650     }
 651
 652     small_vector tmp(begin(), end());
 653     tmp.swap(*this);
 654   }
 655
 656   template<class ...Args>
 657   void emplace_back(Args&&... args) {
 658     // call helper function for static dispatch of special cases
 659     emplaceBack(std::forward<Args>(args)...);
 660   }
 661
 662   void push_back(value_type&& t) {
 663     if (capacity() == size()) {
 664       makeSize(std::max(size_type(2), 3 * size() / 2), &t, size());
 665     } else {
 666       new (end()) value_type(std::move(t));
 667     }
 668     this->setSize(size() + 1);
 669   }
 670
 671   void push_back(value_type const& t) {
 672     // Make a copy and forward to the rvalue value_type&& overload
 673     // above.
 674     push_back(value_type(t));
 675   }
 676
 677   void pop_back() {
 678     erase(end() - 1);
 679   }
 680
 681   iterator insert(const_iterator constp, value_type&& t) {
 682     iterator p = unconst(constp);
 683
 684     if (p == end()) {
 685       push_back(std::move(t));
 686       return end() - 1;
 687     }
 688
 689     auto offset = p - begin();
 690
 691     if (capacity() == size()) {
 692       makeSize(size() + 1, &t, offset);
 693       this->setSize(this->size() + 1);
 694     } else {
 695       makeSize(size() + 1);
 696       detail::moveObjectsRight(data() + offset,
 697                                data() + size(),
 698                                data() + size() + 1);
 699       this->setSize(size() + 1);
 700       data()[offset] = std::move(t);
 701     }
 702     return begin() + offset;
 703
 704   }
 705
 706   iterator insert(const_iterator p, value_type const& t) {
 707     // Make a copy and forward to the rvalue value_type&& overload
 708     // above.
 709     return insert(p, value_type(t));
 710   }
 711
 712   iterator insert(const_iterator pos, size_type n, value_type const& val) {
 713     auto offset = pos - begin();
 714     makeSize(size() + n);
 715     detail::moveObjectsRight(data() + offset,
 716                              data() + size(),
 717                              data() + size() + n);
 718     this->setSize(size() + n);
 719     std::generate_n(begin() + offset, n, [&] { return val; });
 720     return begin() + offset;
 721   }
 722
 723   template<class Arg>
 724   iterator insert(const_iterator p, Arg arg1, Arg arg2) {
 725     // Forward using std::is_arithmetic to get to the proper
 726     // implementation; this disambiguates between the iterators and
 727     // (size_t, value_type) meaning for this function.
 728     return insertImpl(unconst(p), arg1, arg2, std::is_arithmetic<Arg>());
 729   }
 730
 731   iterator insert(const_iterator p, std::initializer_list<value_type> il) {
 732     return insert(p, il.begin(), il.end());
 733   }
 734
 735   iterator erase(const_iterator q) {
 736     std::move(unconst(q) + 1, end(), unconst(q));
 737     (data() + size() - 1)->~value_type();
 738     this->setSize(size() - 1);
 739     return unconst(q);
 740   }
 741
 742   iterator erase(const_iterator q1, const_iterator q2) {
 743     if (q1 == q2) return unconst(q1);
 744     std::move(unconst(q2), end(), unconst(q1));
 745     for (auto it = (end() - std::distance(q1, q2)); it != end(); ++it) {
 746       it->~value_type();
 747     }
 748     this->setSize(size() - (q2 - q1));
 749     return unconst(q1);
 750   }
 751
 752   void clear() {
 753     erase(begin(), end());
 754   }
 755
 756   template<class Arg>
 757   void assign(Arg first, Arg last) {
 758     clear();
 759     insert(end(), first, last);
 760   }
 761
 762   void assign(std::initializer_list<value_type> il) {
 763     assign(il.begin(), il.end());
 764   }
 765
 766   void assign(size_type n, const value_type& t) {
 767     clear();
 768     insert(end(), n, t);
 769   }
 770
 771   reference front()             { assert(!empty()); return *begin(); }
 772   reference back()              { assert(!empty()); return *(end() - 1); }
 773   const_reference front() const { assert(!empty()); return *begin(); }
 774   const_reference back() const  { assert(!empty()); return *(end() - 1); }
 775
 776   reference operator[](size_type i) {
 777     assert(i < size());
 778     return *(begin() + i);
 779   }
 780
 781   const_reference operator[](size_type i) const {
 782     assert(i < size());
 783     return *(begin() + i);
 784   }
 785
 786   reference at(size_type i) {
 787     if (i >= size()) {
 788       throw std::out_of_range("index out of range");
 789     }
 790     return (*this)[i];
 791   }
 792
 793   const_reference at(size_type i) const {
 794     if (i >= size()) {
 795       throw std::out_of_range("index out of range");
 796     }
 797     return (*this)[i];
 798   }
 799
 800 private:
 801
 802   /*
 803    * This is doing the same like emplace_back, but we need this helper
 804    * to catch the special case - see the next overload function..
 805    */
 806   template<class ...Args>
 807   void emplaceBack(Args&&... args) {
 808     makeSize(size() + 1);
 809     new (end()) value_type(std::forward<Args>(args)...);
 810     this->setSize(size() + 1);
 811   }
 812
 813   /*
 814    * Special case of emplaceBack for rvalue
 815    */
 816   void emplaceBack(value_type&& t) {
 817     push_back(std::move(t));
 818   }
 819
 820   static iterator unconst(const_iterator it) {
 821     return const_cast<iterator>(it);
 822   }
 823
 824   /*
 825    * g++ doesn't allow you to bind a non-const reference to a member
 826    * of a packed structure, presumably because it would make it too
 827    * easy to accidentally make an unaligned memory access?
 828    */
 829   template<class T> static T& unpackHack(T* p) {
 830     return *p;
 831   }
 832
 833   // The std::false_type argument is part of disambiguating the
 834   // iterator insert functions from integral types (see insert().)
 835   template<class It>
 836   iterator insertImpl(iterator pos, It first, It last, std::false_type) {
 837     typedef typename std::iterator_traits<It>::iterator_category categ;
 838     if (std::is_same<categ,std::input_iterator_tag>::value) {
 839       auto offset = pos - begin();
 840       while (first != last) {
 841         pos = insert(pos, *first++);
 842         ++pos;
 843       }
 844       return begin() + offset;
 845     }
 846
 847     auto distance = std::distance(first, last);
 848     auto offset = pos - begin();
 849     makeSize(size() + distance);
 850     detail::moveObjectsRight(data() + offset,
 851                              data() + size(),
 852                              data() + size() + distance);
 853     this->setSize(size() + distance);
 854     std::copy_n(first, distance, begin() + offset);
 855     return begin() + offset;
 856   }
 857
 858   iterator insertImpl(iterator pos, size_type n, const value_type& val,
 859       std::true_type) {
 860     // The true_type means this should call the size_t,value_type
 861     // overload.  (See insert().)
 862     return insert(pos, n, val);
 863   }
 864
 865   // The std::false_type argument came from std::is_arithmetic as part
 866   // of disambiguating an overload (see the comment in the
 867   // constructor).
 868   template<class It>
 869   void constructImpl(It first, It last, std::false_type) {
 870     typedef typename std::iterator_traits<It>::iterator_category categ;
 871     if (std::is_same<categ,std::input_iterator_tag>::value) {
 872       // With iterators that only allow a single pass, we can't really
 873       // do anything sane here.
 874       while (first != last) {
 875         push_back(*first++);
 876       }
 877       return;
 878     }
 879
 880     auto distance = std::distance(first, last);
 881     makeSize(distance);
 882     this->setSize(distance);
 883     try {
 884       detail::populateMemForward(data(), distance,
 885         [&] (void* p) { new (p) value_type(*first++); }
 886       );
 887     } catch (...) {
 888       if (this->isExtern()) {
 889         u.freeHeap();
 890       }
 891       throw;
 892     }
 893   }
 894
 895   void doConstruct(size_type n, value_type const& val) {
 896     makeSize(n);
 897     this->setSize(n);
 898     try {
 899       detail::populateMemForward(data(), n,
 900         [&] (void* p) { new (p) value_type(val); }
 901       );
 902     } catch (...) {
 903       if (this->isExtern()) {
 904         u.freeHeap();
 905       }
 906       throw;
 907     }
 908   }
 909
 910   // The true_type means we should forward to the size_t,value_type
 911   // overload.
 912   void constructImpl(size_type n, value_type const& val, std::true_type) {
 913     doConstruct(n, val);
 914   }
 915
 916   void makeSize(size_type size, value_type* v = nullptr) {
 917     makeSize(size, v, size - 1);
 918   }
 919
 920   /*
 921    * Ensure we have a large enough memory region to be size `size'.
 922    * Will move/copy elements if we are spilling to heap_ or needed to
 923    * allocate a new region, but if resized in place doesn't initialize
 924    * anything in the new region.  In any case doesn't change size().
 925    * Supports insertion of new element during reallocation by given
 926    * pointer to new element and position of new element.
 927    * NOTE: If reallocation is not needed, and new element should be
 928    * inserted in the middle of vector (not at the end), do the move
 929    * objects and insertion outside the function, otherwise exception is thrown.
 930    */
 931   void makeSize(size_type size, value_type* v, size_type pos) {
 932     if (size > this->max_size()) {
 933       throw std::length_error("max_size exceeded in small_vector");
 934     }
 935     if (size <= this->capacity()) {
 936       return;
 937     }
 938
 939     auto needBytes = size * sizeof(value_type);
 940     // If the capacity isn't explicitly stored inline, but the heap
 941     // allocation is grown to over some threshold, we should store
 942     // a capacity at the front of the heap allocation.
 943     bool heapifyCapacity =
 944       !kHasInlineCapacity && needBytes > kHeapifyCapacityThreshold;
 945     if (heapifyCapacity) {
 946       needBytes += kHeapifyCapacitySize;
 947     }
 948     auto const sizeBytes = goodMallocSize(needBytes);
 949     void* newh = checkedMalloc(sizeBytes);
 950     // We expect newh to be at least 2-aligned, because we want to
 951     // use its least significant bit as a flag.
 952     assert(!detail::pointerFlagGet(newh));
 953
 954     value_type* newp = static_cast<value_type*>(
 955       heapifyCapacity ?
 956         detail::shiftPointer(newh, kHeapifyCapacitySize) :
 957         newh);
 958
 959     if (v != nullptr) {
 960       // move new element
 961       try {
 962         new (&newp[pos]) value_type(std::move(*v));
 963       } catch (...) {
 964         free(newh);
 965         throw;
 966       }
 967
 968       // move old elements to the left of the new one
 969       try {
 970         detail::moveToUninitialized(begin(), begin() + pos, newp);
 971       } catch (...) {
 972         newp[pos].~value_type();
 973         free(newh);
 974         throw;
 975       }
 976
 977       // move old elements to the right of the new one
 978       try {
 979         if (pos < size-1) {
 980           detail::moveToUninitialized(begin() + pos, end(), newp + pos + 1);
 981         }
 982       } catch (...) {
 983         for (size_type i = 0; i <= pos; ++i) {
 984           newp[i].~value_type();
 985         }
 986         free(newh);
 987         throw;
 988       }
 989     } else {
 990       // move without inserting new element
 991       try {
 992         detail::moveToUninitialized(begin(), end(), newp);
 993       } catch (...) {
 994         free(newh);
 995         throw;
 996       }
 997     }
 998     for (auto& val : *this) {
 999       val.~value_type();
1000     }
1001
1002     if (this->isExtern()) {
1003       u.freeHeap();
1004     }
1005     auto availableSizeBytes = sizeBytes;
1006     if (heapifyCapacity) {
1007       u.pdata_.heap_ = detail::pointerFlagSet(newh);
1008       availableSizeBytes -= kHeapifyCapacitySize;
1009     } else {
1010       u.pdata_.heap_ = newh;
1011     }
1012     this->setExtern(true);
1013     this->setCapacity(availableSizeBytes / sizeof(value_type));
1014   }
1015
1016   /*
1017    * This will set the capacity field, stored inline in the storage_ field
1018    * if there is sufficient room to store it.
1019    */
1020   void setCapacity(size_type newCapacity) {
1021     assert(this->isExtern());
1022     if (u.hasCapacity()) {
1023       assert(newCapacity < std::numeric_limits<InternalSizeType>::max());
1024       *u.getCapacity() = InternalSizeType(newCapacity);
1025     }
1026   }
1027
1028 private:
1029   struct HeapPtrWithCapacity {
1030     void* heap_;
1031     InternalSizeType capacity_;
1032
1033     InternalSizeType* getCapacity() {
1034       return &capacity_;
1035     }
1036   } FB_PACK_ATTR;
1037
1038   struct HeapPtr {
1039     // Lower order bit of heap_ is used as flag to indicate whether capacity is
1040     // stored at the front of the heap allocation.
1041     void* heap_;
1042
1043     InternalSizeType* getCapacity() {
1044       assert(detail::pointerFlagGet(heap_));
1045       return static_cast<InternalSizeType*>(
1046         detail::pointerFlagClear(heap_));
1047     }
1048   } FB_PACK_ATTR;
1049
1050 #if FOLLY_X64
1051   typedef unsigned char InlineStorageType[sizeof(value_type) * MaxInline];
1052 #else
1053   typedef typename std::aligned_storage<
1054     sizeof(value_type) * MaxInline,
1055     alignof(value_type)
1056   >::type InlineStorageType;
1057 #endif
1058
1059   static bool const kHasInlineCapacity =
1060     sizeof(HeapPtrWithCapacity) < sizeof(InlineStorageType);
1061
1062   // This value should we multiple of word size.
1063   static size_t const kHeapifyCapacitySize = sizeof(
1064     typename std::aligned_storage<
1065       sizeof(InternalSizeType),
1066       alignof(value_type)
1067     >::type);
1068   // Threshold to control capacity heapifying.
1069   static size_t const kHeapifyCapacityThreshold =
1070     100 * kHeapifyCapacitySize;
1071
1072   typedef typename std::conditional<
1073     kHasInlineCapacity,
1074     HeapPtrWithCapacity,
1075     HeapPtr
1076   >::type PointerType;
1077
1078   union Data {
1079     explicit Data() { pdata_.heap_ = 0; }
1080
1081     PointerType pdata_;
1082     InlineStorageType storage_;
1083
1084     value_type* buffer() noexcept {
1085       void* vp = &storage_;
1086       return static_cast<value_type*>(vp);
1087     }
1088     value_type const* buffer() const noexcept {
1089       return const_cast<Data*>(this)->buffer();
1090     }
1091     value_type* heap() noexcept {
1092       if (kHasInlineCapacity || !detail::pointerFlagGet(pdata_.heap_)) {
1093         return static_cast<value_type*>(pdata_.heap_);
1094       }
1095       return static_cast<value_type*>(
1096         detail::shiftPointer(
1097           detail::pointerFlagClear(pdata_.heap_), kHeapifyCapacitySize));
1098     }
1099     value_type const* heap() const noexcept {
1100       return const_cast<Data*>(this)->heap();
1101     }
1102
1103     bool hasCapacity() const {
1104       return kHasInlineCapacity || detail::pointerFlagGet(pdata_.heap_);
1105     }
1106     InternalSizeType* getCapacity() {
1107       return pdata_.getCapacity();
1108     }
1109     InternalSizeType* getCapacity() const {
1110       return const_cast<Data*>(this)->getCapacity();
1111     }
1112
1113     void freeHeap() {
1114       auto vp = detail::pointerFlagClear(pdata_.heap_);
1115       free(vp);
1116     }
1117   } FB_PACK_ATTR u;
1118 } FB_PACK_ATTR;
1119 FB_PACK_POP
1120
1121 //////////////////////////////////////////////////////////////////////
1122
1123 // Basic guarantee only, or provides the nothrow guarantee iff T has a
1124 // nothrow move or copy constructor.
1125 template<class T, std::size_t MaxInline, class A, class B, class C>
1126 void swap(small_vector<T,MaxInline,A,B,C>& a,
1127           small_vector<T,MaxInline,A,B,C>& b) {
1128   a.swap(b);
1129 }
1130
1131 //////////////////////////////////////////////////////////////////////
1132
1133 }
1134
1135 #pragma GCC diagnostic pop
1136
1137 #ifdef FB_PACK_ATTR
1138 # undef FB_PACK_ATTR
1139 # undef FB_PACK_PUSH
1140 # undef FB_PACK_POP
1141 #endif
1142
1143 #endif