folly/FBVector.h

   1 /*
   2  * Copyright 2016 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  * Nicholas Ormrod      (njormrod)
  19  * Andrei Alexandrescu  (aalexandre)
  20  *
  21  * FBVector is Facebook's drop-in implementation of std::vector. It has special
  22  * optimizations for use with relocatable types and jemalloc.
  23  */
  24
  25 #pragma once
  26
  27 //=============================================================================
  28 // headers
  29
  30 #include <algorithm>
  31 #include <cassert>
  32 #include <iterator>
  33 #include <memory>
  34 #include <stdexcept>
  35 #include <type_traits>
  36 #include <utility>
  37
  38 #include <folly/FormatTraits.h>
  39 #include <folly/Likely.h>
  40 #include <folly/Malloc.h>
  41 #include <folly/Traits.h>
  42
  43 #include <boost/operators.hpp>
  44
  45 //=============================================================================
  46 // forward declaration
  47
  48 namespace folly {
  49   template <class T, class Allocator = std::allocator<T>>
  50   class fbvector;
  51 }
  52
  53 //=============================================================================
  54 // unrolling
  55
  56 #define FOLLY_FBV_UNROLL_PTR(first, last, OP) do {  \
  57   for (; (last) - (first) >= 4; (first) += 4) {     \
  58     OP(((first) + 0));                              \
  59     OP(((first) + 1));                              \
  60     OP(((first) + 2));                              \
  61     OP(((first) + 3));                              \
  62   }                                                 \
  63   for (; (first) != (last); ++(first)) OP((first)); \
  64 } while(0);
  65
  66 //=============================================================================
  67 ///////////////////////////////////////////////////////////////////////////////
  68 //                                                                           //
  69 //                              fbvector class                               //
  70 //                                                                           //
  71 ///////////////////////////////////////////////////////////////////////////////
  72
  73 namespace folly {
  74
  75 template <class T, class Allocator>
  76 class fbvector : private boost::totally_ordered<fbvector<T, Allocator>> {
  77
  78   //===========================================================================
  79   //---------------------------------------------------------------------------
  80   // implementation
  81 private:
  82
  83   typedef std::allocator_traits<Allocator> A;
  84
  85   struct Impl : public Allocator {
  86     // typedefs
  87     typedef typename A::pointer pointer;
  88     typedef typename A::size_type size_type;
  89
  90     // data
  91     pointer b_, e_, z_;
  92
  93     // constructors
  94     Impl() : Allocator(), b_(nullptr), e_(nullptr), z_(nullptr) {}
  95     /* implicit */ Impl(const Allocator& a)
  96       : Allocator(a), b_(nullptr), e_(nullptr), z_(nullptr) {}
  97     /* implicit */ Impl(Allocator&& a)
  98       : Allocator(std::move(a)), b_(nullptr), e_(nullptr), z_(nullptr) {}
  99
 100     /* implicit */ Impl(size_type n, const Allocator& a = Allocator())
 101       : Allocator(a)
 102       { init(n); }
 103
 104     Impl(Impl&& other) noexcept
 105       : Allocator(std::move(other)),
 106         b_(other.b_), e_(other.e_), z_(other.z_)
 107       { other.b_ = other.e_ = other.z_ = nullptr; }
 108
 109     // destructor
 110     ~Impl() {
 111       destroy();
 112     }
 113
 114     // allocation
 115     // note that 'allocate' and 'deallocate' are inherited from Allocator
 116     T* D_allocate(size_type n) {
 117       if (usingStdAllocator::value) {
 118         return static_cast<T*>(malloc(n * sizeof(T)));
 119       } else {
 120         return std::allocator_traits<Allocator>::allocate(*this, n);
 121       }
 122     }
 123
 124     void D_deallocate(T* p, size_type n) noexcept {
 125       if (usingStdAllocator::value) {
 126         free(p);
 127       } else {
 128         std::allocator_traits<Allocator>::deallocate(*this, p, n);
 129       }
 130     }
 131
 132     // helpers
 133     void swapData(Impl& other) {
 134       std::swap(b_, other.b_);
 135       std::swap(e_, other.e_);
 136       std::swap(z_, other.z_);
 137     }
 138
 139     // data ops
 140     inline void destroy() noexcept {
 141       if (b_) {
 142         // THIS DISPATCH CODE IS DUPLICATED IN fbvector::D_destroy_range_a.
 143         // It has been inlined here for speed. It calls the static fbvector
 144         //  methods to perform the actual destruction.
 145         if (usingStdAllocator::value) {
 146           S_destroy_range(b_, e_);
 147         } else {
 148           S_destroy_range_a(*this, b_, e_);
 149         }
 150
 151         D_deallocate(b_, z_ - b_);
 152       }
 153     }
 154
 155     void init(size_type n) {
 156       if (UNLIKELY(n == 0)) {
 157         b_ = e_ = z_ = nullptr;
 158       } else {
 159         size_type sz = folly::goodMallocSize(n * sizeof(T)) / sizeof(T);
 160         b_ = D_allocate(sz);
 161         e_ = b_;
 162         z_ = b_ + sz;
 163       }
 164     }
 165
 166     void set(pointer newB, size_type newSize, size_type newCap) {
 167       z_ = newB + newCap;
 168       e_ = newB + newSize;
 169       b_ = newB;
 170     }
 171
 172     void reset(size_type newCap) {
 173       destroy();
 174       try {
 175         init(newCap);
 176       } catch (...) {
 177         init(0);
 178         throw;
 179       }
 180     }
 181     void reset() { // same as reset(0)
 182       destroy();
 183       b_ = e_ = z_ = nullptr;
 184     }
 185   } impl_;
 186
 187   static void swap(Impl& a, Impl& b) {
 188     using std::swap;
 189     if (!usingStdAllocator::value) swap<Allocator>(a, b);
 190     a.swapData(b);
 191   }
 192
 193   //===========================================================================
 194   //---------------------------------------------------------------------------
 195   // types and constants
 196 public:
 197
 198   typedef T                                           value_type;
 199   typedef value_type&                                 reference;
 200   typedef const value_type&                           const_reference;
 201   typedef T*                                          iterator;
 202   typedef const T*                                    const_iterator;
 203   typedef size_t                                      size_type;
 204   typedef typename std::make_signed<size_type>::type  difference_type;
 205   typedef Allocator                                   allocator_type;
 206   typedef typename A::pointer                         pointer;
 207   typedef typename A::const_pointer                   const_pointer;
 208   typedef std::reverse_iterator<iterator>             reverse_iterator;
 209   typedef std::reverse_iterator<const_iterator>       const_reverse_iterator;
 210
 211 private:
 212
 213   typedef std::integral_constant<bool,
 214       boost::has_trivial_copy_constructor<T>::value &&
 215       sizeof(T) <= 16 // don't force large structures to be passed by value
 216     > should_pass_by_value;
 217   typedef typename std::conditional<
 218       should_pass_by_value::value, T, const T&>::type VT;
 219   typedef typename std::conditional<
 220       should_pass_by_value::value, T, T&&>::type MT;
 221
 222   typedef std::integral_constant<bool,
 223       std::is_same<Allocator, std::allocator<T>>::value> usingStdAllocator;
 224   typedef std::integral_constant<bool,
 225       usingStdAllocator::value ||
 226       A::propagate_on_container_move_assignment::value> moveIsSwap;
 227
 228   //===========================================================================
 229   //---------------------------------------------------------------------------
 230   // allocator helpers
 231 private:
 232
 233   //---------------------------------------------------------------------------
 234   // allocate
 235
 236   T* M_allocate(size_type n) {
 237     return impl_.D_allocate(n);
 238   }
 239
 240   //---------------------------------------------------------------------------
 241   // deallocate
 242
 243   void M_deallocate(T* p, size_type n) noexcept {
 244     impl_.D_deallocate(p, n);
 245   }
 246
 247   //---------------------------------------------------------------------------
 248   // construct
 249
 250   // GCC is very sensitive to the exact way that construct is called. For
 251   //  that reason there are several different specializations of construct.
 252
 253   template <typename U, typename... Args>
 254   void M_construct(U* p, Args&&... args) {
 255     if (usingStdAllocator::value) {
 256       new (p) U(std::forward<Args>(args)...);
 257     } else {
 258       std::allocator_traits<Allocator>::construct(
 259         impl_, p, std::forward<Args>(args)...);
 260     }
 261   }
 262
 263   template <typename U, typename... Args>
 264   static void S_construct(U* p, Args&&... args) {
 265     new (p) U(std::forward<Args>(args)...);
 266   }
 267
 268   template <typename U, typename... Args>
 269   static void S_construct_a(Allocator& a, U* p, Args&&... args) {
 270     std::allocator_traits<Allocator>::construct(
 271       a, p, std::forward<Args>(args)...);
 272   }
 273
 274   // scalar optimization
 275   // TODO we can expand this optimization to: default copyable and assignable
 276   template <typename U, typename Enable = typename
 277     std::enable_if<std::is_scalar<U>::value>::type>
 278   void M_construct(U* p, U arg) {
 279     if (usingStdAllocator::value) {
 280       *p = arg;
 281     } else {
 282       std::allocator_traits<Allocator>::construct(impl_, p, arg);
 283     }
 284   }
 285
 286   template <typename U, typename Enable = typename
 287     std::enable_if<std::is_scalar<U>::value>::type>
 288   static void S_construct(U* p, U arg) {
 289     *p = arg;
 290   }
 291
 292   template <typename U, typename Enable = typename
 293     std::enable_if<std::is_scalar<U>::value>::type>
 294   static void S_construct_a(Allocator& a, U* p, U arg) {
 295     std::allocator_traits<Allocator>::construct(a, p, arg);
 296   }
 297
 298   // const& optimization
 299   template <typename U, typename Enable = typename
 300     std::enable_if<!std::is_scalar<U>::value>::type>
 301   void M_construct(U* p, const U& value) {
 302     if (usingStdAllocator::value) {
 303       new (p) U(value);
 304     } else {
 305       std::allocator_traits<Allocator>::construct(impl_, p, value);
 306     }
 307   }
 308
 309   template <typename U, typename Enable = typename
 310     std::enable_if<!std::is_scalar<U>::value>::type>
 311   static void S_construct(U* p, const U& value) {
 312     new (p) U(value);
 313   }
 314
 315   template <typename U, typename Enable = typename
 316     std::enable_if<!std::is_scalar<U>::value>::type>
 317   static void S_construct_a(Allocator& a, U* p, const U& value) {
 318     std::allocator_traits<Allocator>::construct(a, p, value);
 319   }
 320
 321   //---------------------------------------------------------------------------
 322   // destroy
 323
 324   void M_destroy(T* p) noexcept {
 325     if (usingStdAllocator::value) {
 326       if (!boost::has_trivial_destructor<T>::value) p->~T();
 327     } else {
 328       std::allocator_traits<Allocator>::destroy(impl_, p);
 329     }
 330   }
 331
 332   //===========================================================================
 333   //---------------------------------------------------------------------------
 334   // algorithmic helpers
 335 private:
 336
 337   //---------------------------------------------------------------------------
 338   // destroy_range
 339
 340   // wrappers
 341   void M_destroy_range_e(T* pos) noexcept {
 342     D_destroy_range_a(pos, impl_.e_);
 343     impl_.e_ = pos;
 344   }
 345
 346   // dispatch
 347   // THIS DISPATCH CODE IS DUPLICATED IN IMPL. SEE IMPL FOR DETAILS.
 348   void D_destroy_range_a(T* first, T* last) noexcept {
 349     if (usingStdAllocator::value) {
 350       S_destroy_range(first, last);
 351     } else {
 352       S_destroy_range_a(impl_, first, last);
 353     }
 354   }
 355
 356   // allocator
 357   static void S_destroy_range_a(Allocator& a, T* first, T* last) noexcept {
 358     for (; first != last; ++first)
 359       std::allocator_traits<Allocator>::destroy(a, first);
 360   }
 361
 362   // optimized
 363   static void S_destroy_range(T* first, T* last) noexcept {
 364     if (!boost::has_trivial_destructor<T>::value) {
 365       // EXPERIMENTAL DATA on fbvector<vector<int>> (where each vector<int> has
 366       //  size 0).
 367       // The unrolled version seems to work faster for small to medium sized
 368       //  fbvectors. It gets a 10% speedup on fbvectors of size 1024, 64, and
 369       //  16.
 370       // The simple loop version seems to work faster for large fbvectors. The
 371       //  unrolled version is about 6% slower on fbvectors on size 16384.
 372       // The two methods seem tied for very large fbvectors. The unrolled
 373       //  version is about 0.5% slower on size 262144.
 374
 375       // for (; first != last; ++first) first->~T();
 376       #define FOLLY_FBV_OP(p) (p)->~T()
 377       FOLLY_FBV_UNROLL_PTR(first, last, FOLLY_FBV_OP)
 378       #undef FOLLY_FBV_OP
 379     }
 380   }
 381
 382   //---------------------------------------------------------------------------
 383   // uninitialized_fill_n
 384
 385   // wrappers
 386   void M_uninitialized_fill_n_e(size_type sz) {
 387     D_uninitialized_fill_n_a(impl_.e_, sz);
 388     impl_.e_ += sz;
 389   }
 390
 391   void M_uninitialized_fill_n_e(size_type sz, VT value) {
 392     D_uninitialized_fill_n_a(impl_.e_, sz, value);
 393     impl_.e_ += sz;
 394   }
 395
 396   // dispatch
 397   void D_uninitialized_fill_n_a(T* dest, size_type sz) {
 398     if (usingStdAllocator::value) {
 399       S_uninitialized_fill_n(dest, sz);
 400     } else {
 401       S_uninitialized_fill_n_a(impl_, dest, sz);
 402     }
 403   }
 404
 405   void D_uninitialized_fill_n_a(T* dest, size_type sz, VT value) {
 406     if (usingStdAllocator::value) {
 407       S_uninitialized_fill_n(dest, sz, value);
 408     } else {
 409       S_uninitialized_fill_n_a(impl_, dest, sz, value);
 410     }
 411   }
 412
 413   // allocator
 414   template <typename... Args>
 415   static void S_uninitialized_fill_n_a(Allocator& a, T* dest,
 416                                        size_type sz, Args&&... args) {
 417     auto b = dest;
 418     auto e = dest + sz;
 419     try {
 420       for (; b != e; ++b)
 421         std::allocator_traits<Allocator>::construct(a, b,
 422           std::forward<Args>(args)...);
 423     } catch (...) {
 424       S_destroy_range_a(a, dest, b);
 425       throw;
 426     }
 427   }
 428
 429   // optimized
 430   static void S_uninitialized_fill_n(T* dest, size_type n) {
 431     if (folly::IsZeroInitializable<T>::value) {
 432       std::memset(dest, 0, sizeof(T) * n);
 433     } else {
 434       auto b = dest;
 435       auto e = dest + n;
 436       try {
 437         for (; b != e; ++b) S_construct(b);
 438       } catch (...) {
 439         --b;
 440         for (; b >= dest; --b) b->~T();
 441         throw;
 442       }
 443     }
 444   }
 445
 446   static void S_uninitialized_fill_n(T* dest, size_type n, const T& value) {
 447     auto b = dest;
 448     auto e = dest + n;
 449     try {
 450       for (; b != e; ++b) S_construct(b, value);
 451     } catch (...) {
 452       S_destroy_range(dest, b);
 453       throw;
 454     }
 455   }
 456
 457   //---------------------------------------------------------------------------
 458   // uninitialized_copy
 459
 460   // it is possible to add an optimization for the case where
 461   // It = move(T*) and IsRelocatable<T> and Is0Initiailizable<T>
 462
 463   // wrappers
 464   template <typename It>
 465   void M_uninitialized_copy_e(It first, It last) {
 466     D_uninitialized_copy_a(impl_.e_, first, last);
 467     impl_.e_ += std::distance(first, last);
 468   }
 469
 470   template <typename It>
 471   void M_uninitialized_move_e(It first, It last) {
 472     D_uninitialized_move_a(impl_.e_, first, last);
 473     impl_.e_ += std::distance(first, last);
 474   }
 475
 476   // dispatch
 477   template <typename It>
 478   void D_uninitialized_copy_a(T* dest, It first, It last) {
 479     if (usingStdAllocator::value) {
 480       if (folly::IsTriviallyCopyable<T>::value) {
 481         S_uninitialized_copy_bits(dest, first, last);
 482       } else {
 483         S_uninitialized_copy(dest, first, last);
 484       }
 485     } else {
 486       S_uninitialized_copy_a(impl_, dest, first, last);
 487     }
 488   }
 489
 490   template <typename It>
 491   void D_uninitialized_move_a(T* dest, It first, It last) {
 492     D_uninitialized_copy_a(dest,
 493       std::make_move_iterator(first), std::make_move_iterator(last));
 494   }
 495
 496   // allocator
 497   template <typename It>
 498   static void
 499   S_uninitialized_copy_a(Allocator& a, T* dest, It first, It last) {
 500     auto b = dest;
 501     try {
 502       for (; first != last; ++first, ++b)
 503         std::allocator_traits<Allocator>::construct(a, b, *first);
 504     } catch (...) {
 505       S_destroy_range_a(a, dest, b);
 506       throw;
 507     }
 508   }
 509
 510   // optimized
 511   template <typename It>
 512   static void S_uninitialized_copy(T* dest, It first, It last) {
 513     auto b = dest;
 514     try {
 515       for (; first != last; ++first, ++b)
 516         S_construct(b, *first);
 517     } catch (...) {
 518       S_destroy_range(dest, b);
 519       throw;
 520     }
 521   }
 522
 523   static void
 524   S_uninitialized_copy_bits(T* dest, const T* first, const T* last) {
 525     std::memcpy((void*)dest, (void*)first, (last - first) * sizeof(T));
 526   }
 527
 528   static void
 529   S_uninitialized_copy_bits(T* dest, std::move_iterator<T*> first,
 530                        std::move_iterator<T*> last) {
 531     T* bFirst = first.base();
 532     T* bLast = last.base();
 533     std::memcpy((void*)dest, (void*)bFirst, (bLast - bFirst) * sizeof(T));
 534   }
 535
 536   template <typename It>
 537   static void
 538   S_uninitialized_copy_bits(T* dest, It first, It last) {
 539     S_uninitialized_copy(dest, first, last);
 540   }
 541
 542   //---------------------------------------------------------------------------
 543   // copy_n
 544
 545   // This function is "unsafe": it assumes that the iterator can be advanced at
 546   //  least n times. However, as a private function, that unsafety is managed
 547   //  wholly by fbvector itself.
 548
 549   template <typename It>
 550   static It S_copy_n(T* dest, It first, size_type n) {
 551     auto e = dest + n;
 552     for (; dest != e; ++dest, ++first) *dest = *first;
 553     return first;
 554   }
 555
 556   static const T* S_copy_n(T* dest, const T* first, size_type n) {
 557     if (folly::IsTriviallyCopyable<T>::value) {
 558       std::memcpy((void*)dest, (void*)first, n * sizeof(T));
 559       return first + n;
 560     } else {
 561       return S_copy_n<const T*>(dest, first, n);
 562     }
 563   }
 564
 565   static std::move_iterator<T*>
 566   S_copy_n(T* dest, std::move_iterator<T*> mIt, size_type n) {
 567     if (folly::IsTriviallyCopyable<T>::value) {
 568       T* first = mIt.base();
 569       std::memcpy((void*)dest, (void*)first, n * sizeof(T));
 570       return std::make_move_iterator(first + n);
 571     } else {
 572       return S_copy_n<std::move_iterator<T*>>(dest, mIt, n);
 573     }
 574   }
 575
 576   //===========================================================================
 577   //---------------------------------------------------------------------------
 578   // relocation helpers
 579 private:
 580
 581   // Relocation is divided into three parts:
 582   //
 583   //  1: relocate_move
 584   //     Performs the actual movement of data from point a to point b.
 585   //
 586   //  2: relocate_done
 587   //     Destroys the old data.
 588   //
 589   //  3: relocate_undo
 590   //     Destoys the new data and restores the old data.
 591   //
 592   // The three steps are used because there may be an exception after part 1
 593   //  has completed. If that is the case, then relocate_undo can nullify the
 594   //  initial move. Otherwise, relocate_done performs the last bit of tidying
 595   //  up.
 596   //
 597   // The relocation trio may use either memcpy, move, or copy. It is decided
 598   //  by the following case statement:
 599   //
 600   //  IsRelocatable && usingStdAllocator    -> memcpy
 601   //  has_nothrow_move && usingStdAllocator -> move
 602   //  cannot copy                           -> move
 603   //  default                               -> copy
 604   //
 605   // If the class is non-copyable then it must be movable. However, if the
 606   //  move constructor is not noexcept, i.e. an error could be thrown, then
 607   //  relocate_undo will be unable to restore the old data, for fear of a
 608   //  second exception being thrown. This is a known and unavoidable
 609   //  deficiency. In lieu of a strong exception guarantee, relocate_undo does
 610   //  the next best thing: it provides a weak exception guarantee by
 611   //  destorying the new data, but leaving the old data in an indeterminate
 612   //  state. Note that that indeterminate state will be valid, since the
 613   //  old data has not been destroyed; it has merely been the source of a
 614   //  move, which is required to leave the source in a valid state.
 615
 616   // wrappers
 617   void M_relocate(T* newB) {
 618     relocate_move(newB, impl_.b_, impl_.e_);
 619     relocate_done(newB, impl_.b_, impl_.e_);
 620   }
 621
 622   // dispatch type trait
 623   typedef std::integral_constant<bool,
 624       folly::IsRelocatable<T>::value && usingStdAllocator::value
 625     > relocate_use_memcpy;
 626
 627   typedef std::integral_constant<bool,
 628       (std::is_nothrow_move_constructible<T>::value
 629        && usingStdAllocator::value)
 630       || !std::is_copy_constructible<T>::value
 631     > relocate_use_move;
 632
 633   // move
 634   void relocate_move(T* dest, T* first, T* last) {
 635     relocate_move_or_memcpy(dest, first, last, relocate_use_memcpy());
 636   }
 637
 638   void relocate_move_or_memcpy(T* dest, T* first, T* last, std::true_type) {
 639     std::memcpy((void*)dest, (void*)first, (last - first) * sizeof(T));
 640   }
 641
 642   void relocate_move_or_memcpy(T* dest, T* first, T* last, std::false_type) {
 643     relocate_move_or_copy(dest, first, last, relocate_use_move());
 644   }
 645
 646   void relocate_move_or_copy(T* dest, T* first, T* last, std::true_type) {
 647     D_uninitialized_move_a(dest, first, last);
 648   }
 649
 650   void relocate_move_or_copy(T* dest, T* first, T* last, std::false_type) {
 651     D_uninitialized_copy_a(dest, first, last);
 652   }
 653
 654   // done
 655   void relocate_done(T* /*dest*/, T* first, T* last) noexcept {
 656     if (folly::IsRelocatable<T>::value && usingStdAllocator::value) {
 657       // used memcpy; data has been relocated, do not call destructor
 658     } else {
 659       D_destroy_range_a(first, last);
 660     }
 661   }
 662
 663   // undo
 664   void relocate_undo(T* dest, T* first, T* last) noexcept {
 665     if (folly::IsRelocatable<T>::value && usingStdAllocator::value) {
 666       // used memcpy, old data is still valid, nothing to do
 667     } else if (std::is_nothrow_move_constructible<T>::value &&
 668                usingStdAllocator::value) {
 669       // noexcept move everything back, aka relocate_move
 670       relocate_move(first, dest, dest + (last - first));
 671     } else if (!std::is_copy_constructible<T>::value) {
 672       // weak guarantee
 673       D_destroy_range_a(dest, dest + (last - first));
 674     } else {
 675       // used copy, old data is still valid
 676       D_destroy_range_a(dest, dest + (last - first));
 677     }
 678   }
 679
 680
 681   //===========================================================================
 682   //---------------------------------------------------------------------------
 683   // construct/copy/destroy
 684 public:
 685
 686   fbvector() = default;
 687
 688   explicit fbvector(const Allocator& a) : impl_(a) {}
 689
 690   explicit fbvector(size_type n, const Allocator& a = Allocator())
 691     : impl_(n, a)
 692     { M_uninitialized_fill_n_e(n); }
 693
 694   fbvector(size_type n, VT value, const Allocator& a = Allocator())
 695     : impl_(n, a)
 696     { M_uninitialized_fill_n_e(n, value); }
 697
 698   template <class It, class Category = typename
 699             std::iterator_traits<It>::iterator_category>
 700   fbvector(It first, It last, const Allocator& a = Allocator())
 701     : fbvector(first, last, a, Category()) {}
 702
 703   fbvector(const fbvector& other)
 704     : impl_(other.size(), A::select_on_container_copy_construction(other.impl_))
 705     { M_uninitialized_copy_e(other.begin(), other.end()); }
 706
 707   fbvector(fbvector&& other) noexcept : impl_(std::move(other.impl_)) {}
 708
 709   fbvector(const fbvector& other, const Allocator& a)
 710     : fbvector(other.begin(), other.end(), a) {}
 711
 712   /* may throw */ fbvector(fbvector&& other, const Allocator& a) : impl_(a) {
 713     if (impl_ == other.impl_) {
 714       impl_.swapData(other.impl_);
 715     } else {
 716       impl_.init(other.size());
 717       M_uninitialized_move_e(other.begin(), other.end());
 718     }
 719   }
 720
 721   fbvector(std::initializer_list<T> il, const Allocator& a = Allocator())
 722     : fbvector(il.begin(), il.end(), a) {}
 723
 724   ~fbvector() = default; // the cleanup occurs in impl_
 725
 726   fbvector& operator=(const fbvector& other) {
 727     if (UNLIKELY(this == &other)) return *this;
 728
 729     if (!usingStdAllocator::value &&
 730         A::propagate_on_container_copy_assignment::value) {
 731       if (impl_ != other.impl_) {
 732         // can't use other's different allocator to clean up self
 733         impl_.reset();
 734       }
 735       (Allocator&)impl_ = (Allocator&)other.impl_;
 736     }
 737
 738     assign(other.begin(), other.end());
 739     return *this;
 740   }
 741
 742   fbvector& operator=(fbvector&& other) {
 743     if (UNLIKELY(this == &other)) return *this;
 744     moveFrom(std::move(other), moveIsSwap());
 745     return *this;
 746   }
 747
 748   fbvector& operator=(std::initializer_list<T> il) {
 749     assign(il.begin(), il.end());
 750     return *this;
 751   }
 752
 753   template <class It, class Category = typename
 754             std::iterator_traits<It>::iterator_category>
 755   void assign(It first, It last) {
 756     assign(first, last, Category());
 757   }
 758
 759   void assign(size_type n, VT value) {
 760     if (n > capacity()) {
 761       // Not enough space. Do not reserve in place, since we will
 762       // discard the old values anyways.
 763       if (dataIsInternalAndNotVT(value)) {
 764         T copy(std::move(value));
 765         impl_.reset(n);
 766         M_uninitialized_fill_n_e(n, copy);
 767       } else {
 768         impl_.reset(n);
 769         M_uninitialized_fill_n_e(n, value);
 770       }
 771     } else if (n <= size()) {
 772       auto newE = impl_.b_ + n;
 773       std::fill(impl_.b_, newE, value);
 774       M_destroy_range_e(newE);
 775     } else {
 776       std::fill(impl_.b_, impl_.e_, value);
 777       M_uninitialized_fill_n_e(n - size(), value);
 778     }
 779   }
 780
 781   void assign(std::initializer_list<T> il) {
 782     assign(il.begin(), il.end());
 783   }
 784
 785   allocator_type get_allocator() const noexcept {
 786     return impl_;
 787   }
 788
 789 private:
 790
 791   // contract dispatch for iterator types fbvector(It first, It last)
 792   template <class ForwardIterator>
 793   fbvector(ForwardIterator first, ForwardIterator last,
 794            const Allocator& a, std::forward_iterator_tag)
 795     : impl_(std::distance(first, last), a)
 796     { M_uninitialized_copy_e(first, last); }
 797
 798   template <class InputIterator>
 799   fbvector(InputIterator first, InputIterator last,
 800            const Allocator& a, std::input_iterator_tag)
 801     : impl_(a)
 802     { for (; first != last; ++first) emplace_back(*first); }
 803
 804   // contract dispatch for allocator movement in operator=(fbvector&&)
 805   void
 806   moveFrom(fbvector&& other, std::true_type) {
 807     swap(impl_, other.impl_);
 808   }
 809   void moveFrom(fbvector&& other, std::false_type) {
 810     if (impl_ == other.impl_) {
 811       impl_.swapData(other.impl_);
 812     } else {
 813       impl_.reset(other.size());
 814       M_uninitialized_move_e(other.begin(), other.end());
 815     }
 816   }
 817
 818   // contract dispatch for iterator types in assign(It first, It last)
 819   template <class ForwardIterator>
 820   void assign(ForwardIterator first, ForwardIterator last,
 821               std::forward_iterator_tag) {
 822     const size_t newSize = std::distance(first, last);
 823     if (newSize > capacity()) {
 824       impl_.reset(newSize);
 825       M_uninitialized_copy_e(first, last);
 826     } else if (newSize <= size()) {
 827       auto newEnd = std::copy(first, last, impl_.b_);
 828       M_destroy_range_e(newEnd);
 829     } else {
 830       auto mid = S_copy_n(impl_.b_, first, size());
 831       M_uninitialized_copy_e<decltype(last)>(mid, last);
 832     }
 833   }
 834
 835   template <class InputIterator>
 836   void assign(InputIterator first, InputIterator last,
 837               std::input_iterator_tag) {
 838     auto p = impl_.b_;
 839     for (; first != last && p != impl_.e_; ++first, ++p) {
 840       *p = *first;
 841     }
 842     if (p != impl_.e_) {
 843       M_destroy_range_e(p);
 844     } else {
 845       for (; first != last; ++first) emplace_back(*first);
 846     }
 847   }
 848
 849   // contract dispatch for aliasing under VT optimization
 850   bool dataIsInternalAndNotVT(const T& t) {
 851     if (should_pass_by_value::value) return false;
 852     return dataIsInternal(t);
 853   }
 854   bool dataIsInternal(const T& t) {
 855     return UNLIKELY(impl_.b_ <= std::addressof(t) &&
 856                     std::addressof(t) < impl_.e_);
 857   }
 858
 859
 860   //===========================================================================
 861   //---------------------------------------------------------------------------
 862   // iterators
 863 public:
 864
 865   iterator begin() noexcept {
 866     return impl_.b_;
 867   }
 868   const_iterator begin() const noexcept {
 869     return impl_.b_;
 870   }
 871   iterator end() noexcept {
 872     return impl_.e_;
 873   }
 874   const_iterator end() const noexcept {
 875     return impl_.e_;
 876   }
 877   reverse_iterator rbegin() noexcept {
 878     return reverse_iterator(end());
 879   }
 880   const_reverse_iterator rbegin() const noexcept {
 881     return const_reverse_iterator(end());
 882   }
 883   reverse_iterator rend() noexcept {
 884     return reverse_iterator(begin());
 885   }
 886   const_reverse_iterator rend() const noexcept {
 887     return const_reverse_iterator(begin());
 888   }
 889
 890   const_iterator cbegin() const noexcept {
 891     return impl_.b_;
 892   }
 893   const_iterator cend() const noexcept {
 894     return impl_.e_;
 895   }
 896   const_reverse_iterator crbegin() const noexcept {
 897     return const_reverse_iterator(end());
 898   }
 899   const_reverse_iterator crend() const noexcept {
 900     return const_reverse_iterator(begin());
 901   }
 902
 903   //===========================================================================
 904   //---------------------------------------------------------------------------
 905   // capacity
 906 public:
 907
 908   size_type size() const noexcept {
 909     return impl_.e_ - impl_.b_;
 910   }
 911
 912   size_type max_size() const noexcept {
 913     // good luck gettin' there
 914     return ~size_type(0);
 915   }
 916
 917   void resize(size_type n) {
 918     if (n <= size()) {
 919       M_destroy_range_e(impl_.b_ + n);
 920     } else {
 921       reserve(n);
 922       M_uninitialized_fill_n_e(n - size());
 923     }
 924   }
 925
 926   void resize(size_type n, VT t) {
 927     if (n <= size()) {
 928       M_destroy_range_e(impl_.b_ + n);
 929     } else if (dataIsInternalAndNotVT(t) && n > capacity()) {
 930       T copy(t);
 931       reserve(n);
 932       M_uninitialized_fill_n_e(n - size(), copy);
 933     } else {
 934       reserve(n);
 935       M_uninitialized_fill_n_e(n - size(), t);
 936     }
 937   }
 938
 939   size_type capacity() const noexcept {
 940     return impl_.z_ - impl_.b_;
 941   }
 942
 943   bool empty() const noexcept {
 944     return impl_.b_ == impl_.e_;
 945   }
 946
 947   void reserve(size_type n) {
 948     if (n <= capacity()) return;
 949     if (impl_.b_ && reserve_in_place(n)) return;
 950
 951     auto newCap = folly::goodMallocSize(n * sizeof(T)) / sizeof(T);
 952     auto newB = M_allocate(newCap);
 953     try {
 954       M_relocate(newB);
 955     } catch (...) {
 956       M_deallocate(newB, newCap);
 957       throw;
 958     }
 959     if (impl_.b_)
 960       M_deallocate(impl_.b_, impl_.z_ - impl_.b_);
 961     impl_.z_ = newB + newCap;
 962     impl_.e_ = newB + (impl_.e_ - impl_.b_);
 963     impl_.b_ = newB;
 964   }
 965
 966   void shrink_to_fit() noexcept {
 967     if (empty()) {
 968       impl_.reset();
 969       return;
 970     }
 971
 972     auto const newCapacityBytes = folly::goodMallocSize(size() * sizeof(T));
 973     auto const newCap = newCapacityBytes / sizeof(T);
 974     auto const oldCap = capacity();
 975
 976     if (newCap >= oldCap) return;
 977
 978     void* p = impl_.b_;
 979     // xallocx() will shrink to precisely newCapacityBytes (which was generated
 980     // by goodMallocSize()) if it successfully shrinks in place.
 981     if ((usingJEMalloc() && usingStdAllocator::value) &&
 982         newCapacityBytes >= folly::jemallocMinInPlaceExpandable &&
 983         xallocx(p, newCapacityBytes, 0, 0) == newCapacityBytes) {
 984       impl_.z_ += newCap - oldCap;
 985     } else {
 986       T* newB; // intentionally uninitialized
 987       try {
 988         newB = M_allocate(newCap);
 989         try {
 990           M_relocate(newB);
 991         } catch (...) {
 992           M_deallocate(newB, newCap);
 993           return; // swallow the error
 994         }
 995       } catch (...) {
 996         return;
 997       }
 998       if (impl_.b_)
 999         M_deallocate(impl_.b_, impl_.z_ - impl_.b_);
1000       impl_.z_ = newB + newCap;
1001       impl_.e_ = newB + (impl_.e_ - impl_.b_);
1002       impl_.b_ = newB;
1003     }
1004   }
1005
1006 private:
1007
1008   bool reserve_in_place(size_type n) {
1009     if (!usingStdAllocator::value || !usingJEMalloc()) return false;
1010
1011     // jemalloc can never grow in place blocks smaller than 4096 bytes.
1012     if ((impl_.z_ - impl_.b_) * sizeof(T) <
1013       folly::jemallocMinInPlaceExpandable) return false;
1014
1015     auto const newCapacityBytes = folly::goodMallocSize(n * sizeof(T));
1016     void* p = impl_.b_;
1017     if (xallocx(p, newCapacityBytes, 0, 0) == newCapacityBytes) {
1018       impl_.z_ = impl_.b_ + newCapacityBytes / sizeof(T);
1019       return true;
1020     }
1021     return false;
1022   }
1023
1024   //===========================================================================
1025   //---------------------------------------------------------------------------
1026   // element access
1027 public:
1028
1029   reference operator[](size_type n) {
1030     assert(n < size());
1031     return impl_.b_[n];
1032   }
1033   const_reference operator[](size_type n) const {
1034     assert(n < size());
1035     return impl_.b_[n];
1036   }
1037   const_reference at(size_type n) const {
1038     if (UNLIKELY(n >= size())) {
1039       throw std::out_of_range("fbvector: index is greater than size.");
1040     }
1041     return (*this)[n];
1042   }
1043   reference at(size_type n) {
1044     auto const& cThis = *this;
1045     return const_cast<reference>(cThis.at(n));
1046   }
1047   reference front() {
1048     assert(!empty());
1049     return *impl_.b_;
1050   }
1051   const_reference front() const {
1052     assert(!empty());
1053     return *impl_.b_;
1054   }
1055   reference back()  {
1056     assert(!empty());
1057     return impl_.e_[-1];
1058   }
1059   const_reference back() const {
1060     assert(!empty());
1061     return impl_.e_[-1];
1062   }
1063
1064   //===========================================================================
1065   //---------------------------------------------------------------------------
1066   // data access
1067 public:
1068
1069   T* data() noexcept {
1070     return impl_.b_;
1071   }
1072   const T* data() const noexcept {
1073     return impl_.b_;
1074   }
1075
1076   //===========================================================================
1077   //---------------------------------------------------------------------------
1078   // modifiers (common)
1079 public:
1080
1081   template <class... Args>
1082   void emplace_back(Args&&... args)  {
1083     if (impl_.e_ != impl_.z_) {
1084       M_construct(impl_.e_, std::forward<Args>(args)...);
1085       ++impl_.e_;
1086     } else {
1087       emplace_back_aux(std::forward<Args>(args)...);
1088     }
1089   }
1090
1091   void
1092   push_back(const T& value) {
1093     if (impl_.e_ != impl_.z_) {
1094       M_construct(impl_.e_, value);
1095       ++impl_.e_;
1096     } else {
1097       emplace_back_aux(value);
1098     }
1099   }
1100
1101   void
1102   push_back(T&& value) {
1103     if (impl_.e_ != impl_.z_) {
1104       M_construct(impl_.e_, std::move(value));
1105       ++impl_.e_;
1106     } else {
1107       emplace_back_aux(std::move(value));
1108     }
1109   }
1110
1111   void pop_back() {
1112     assert(!empty());
1113     --impl_.e_;
1114     M_destroy(impl_.e_);
1115   }
1116
1117   void swap(fbvector& other) noexcept {
1118     if (!usingStdAllocator::value &&
1119         A::propagate_on_container_swap::value)
1120       swap(impl_, other.impl_);
1121     else impl_.swapData(other.impl_);
1122   }
1123
1124   void clear() noexcept {
1125     M_destroy_range_e(impl_.b_);
1126   }
1127
1128 private:
1129
1130   // std::vector implements a similar function with a different growth
1131   //  strategy: empty() ? 1 : capacity() * 2.
1132   //
1133   // fbvector grows differently on two counts:
1134   //
1135   // (1) initial size
1136   //     Instead of grwoing to size 1 from empty, and fbvector allocates at
1137   //     least 64 bytes. You may still use reserve to reserve a lesser amount
1138   //     of memory.
1139   // (2) 1.5x
1140   //     For medium-sized vectors, the growth strategy is 1.5x. See the docs
1141   //     for details.
1142   //     This does not apply to very small or very large fbvectors. This is a
1143   //     heuristic.
1144   //     A nice addition to fbvector would be the capability of having a user-
1145   //     defined growth strategy, probably as part of the allocator.
1146   //
1147
1148   size_type computePushBackCapacity() const {
1149     if (capacity() == 0) {
1150       return std::max(64 / sizeof(T), size_type(1));
1151     }
1152     if (capacity() < folly::jemallocMinInPlaceExpandable / sizeof(T)) {
1153       return capacity() * 2;
1154     }
1155     if (capacity() > 4096 * 32 / sizeof(T)) {
1156       return capacity() * 2;
1157     }
1158     return (capacity() * 3 + 1) / 2;
1159   }
1160
1161   template <class... Args>
1162   void emplace_back_aux(Args&&... args);
1163
1164   //===========================================================================
1165   //---------------------------------------------------------------------------
1166   // modifiers (erase)
1167 public:
1168
1169   iterator erase(const_iterator position) {
1170     return erase(position, position + 1);
1171   }
1172
1173   iterator erase(const_iterator first, const_iterator last) {
1174     assert(isValid(first) && isValid(last));
1175     assert(first <= last);
1176     if (first != last) {
1177       if (last == end()) {
1178         M_destroy_range_e((iterator)first);
1179       } else {
1180         if (folly::IsRelocatable<T>::value && usingStdAllocator::value) {
1181           D_destroy_range_a((iterator)first, (iterator)last);
1182           if (last - first >= cend() - last) {
1183             std::memcpy((void*)first, (void*)last, (cend() - last) * sizeof(T));
1184           } else {
1185             std::memmove((iterator)first, last, (cend() - last) * sizeof(T));
1186           }
1187           impl_.e_ -= (last - first);
1188         } else {
1189           std::copy(std::make_move_iterator((iterator)last),
1190                     std::make_move_iterator(end()), (iterator)first);
1191           auto newEnd = impl_.e_ - std::distance(first, last);
1192           M_destroy_range_e(newEnd);
1193         }
1194       }
1195     }
1196     return (iterator)first;
1197   }
1198
1199   //===========================================================================
1200   //---------------------------------------------------------------------------
1201   // modifiers (insert)
1202 private: // we have the private section first because it defines some macros
1203
1204   bool isValid(const_iterator it) {
1205     return cbegin() <= it && it <= cend();
1206   }
1207
1208   size_type computeInsertCapacity(size_type n) {
1209     size_type nc = std::max(computePushBackCapacity(), size() + n);
1210     size_type ac = folly::goodMallocSize(nc * sizeof(T)) / sizeof(T);
1211     return ac;
1212   }
1213
1214   //---------------------------------------------------------------------------
1215   //
1216   // make_window takes an fbvector, and creates an uninitialized gap (a
1217   //  window) at the given position, of the given size. The fbvector must
1218   //  have enough capacity.
1219   //
1220   // Explanation by picture.
1221   //
1222   //    123456789______
1223   //        ^
1224   //        make_window here of size 3
1225   //
1226   //    1234___56789___
1227   //
1228   // If something goes wrong and the window must be destroyed, use
1229   //  undo_window to provide a weak exception guarantee. It destroys
1230   //  the right ledge.
1231   //
1232   //    1234___________
1233   //
1234   //---------------------------------------------------------------------------
1235   //
1236   // wrap_frame takes an inverse window and relocates an fbvector around it.
1237   //  The fbvector must have at least as many elements as the left ledge.
1238   //
1239   // Explanation by picture.
1240   //
1241   //        START
1242   //    fbvector:             inverse window:
1243   //    123456789______       _____abcde_______
1244   //                          [idx][ n ]
1245   //
1246   //        RESULT
1247   //    _______________       12345abcde6789___
1248   //
1249   //---------------------------------------------------------------------------
1250   //
1251   // insert_use_fresh_memory returns true iff the fbvector should use a fresh
1252   //  block of memory for the insertion. If the fbvector does not have enough
1253   //  spare capacity, then it must return true. Otherwise either true or false
1254   //  may be returned.
1255   //
1256   //---------------------------------------------------------------------------
1257   //
1258   // These three functions, make_window, wrap_frame, and
1259   //  insert_use_fresh_memory, can be combined into a uniform interface.
1260   // Since that interface involves a lot of case-work, it is built into
1261   //  some macros: FOLLY_FBVECTOR_INSERT_(PRE|START|TRY|END)
1262   // Macros are used in an attempt to let GCC perform better optimizations,
1263   //  especially control flow optimization.
1264   //
1265
1266   //---------------------------------------------------------------------------
1267   // window
1268
1269   void make_window(iterator position, size_type n) {
1270     // The result is guaranteed to be non-negative, so use an unsigned type:
1271     size_type tail = std::distance(position, impl_.e_);
1272
1273     if (tail <= n) {
1274       relocate_move(position + n, position, impl_.e_);
1275       relocate_done(position + n, position, impl_.e_);
1276       impl_.e_ += n;
1277     } else {
1278       if (folly::IsRelocatable<T>::value && usingStdAllocator::value) {
1279         std::memmove(position + n, position, tail * sizeof(T));
1280         impl_.e_ += n;
1281       } else {
1282         D_uninitialized_move_a(impl_.e_, impl_.e_ - n, impl_.e_);
1283         try {
1284           std::copy_backward(std::make_move_iterator(position),
1285                              std::make_move_iterator(impl_.e_ - n), impl_.e_);
1286         } catch (...) {
1287           D_destroy_range_a(impl_.e_ - n, impl_.e_ + n);
1288           impl_.e_ -= n;
1289           throw;
1290         }
1291         impl_.e_ += n;
1292         D_destroy_range_a(position, position + n);
1293       }
1294     }
1295   }
1296
1297   void undo_window(iterator position, size_type n) noexcept {
1298     D_destroy_range_a(position + n, impl_.e_);
1299     impl_.e_ = position;
1300   }
1301
1302   //---------------------------------------------------------------------------
1303   // frame
1304
1305   void wrap_frame(T* ledge, size_type idx, size_type n) {
1306     assert(size() >= idx);
1307     assert(n != 0);
1308
1309     relocate_move(ledge, impl_.b_, impl_.b_ + idx);
1310     try {
1311       relocate_move(ledge + idx + n, impl_.b_ + idx, impl_.e_);
1312     } catch (...) {
1313       relocate_undo(ledge, impl_.b_, impl_.b_ + idx);
1314       throw;
1315     }
1316     relocate_done(ledge, impl_.b_, impl_.b_ + idx);
1317     relocate_done(ledge + idx + n, impl_.b_ + idx, impl_.e_);
1318   }
1319
1320   //---------------------------------------------------------------------------
1321   // use fresh?
1322
1323   bool insert_use_fresh(bool at_end, size_type n) {
1324     if (at_end) {
1325       if (size() + n <= capacity()) return false;
1326       if (reserve_in_place(size() + n)) return false;
1327       return true;
1328     }
1329
1330     if (size() + n > capacity()) return true;
1331
1332     return false;
1333   }
1334
1335   //---------------------------------------------------------------------------
1336   // interface
1337
1338   #define FOLLY_FBVECTOR_INSERT_PRE(cpos, n)                                  \
1339     if (n == 0) return (iterator)cpos;                                        \
1340     bool at_end = cpos == cend();                                             \
1341     bool fresh = insert_use_fresh(at_end, n);                                 \
1342     if (!at_end) {                                                            \
1343       if (!fresh) {
1344
1345     // check for internal data (technically not required by the standard)
1346
1347   #define FOLLY_FBVECTOR_INSERT_START(cpos, n)                                \
1348       }                                                                       \
1349       assert(isValid(cpos));                                                  \
1350     }                                                                         \
1351     T* position = const_cast<T*>(cpos);                                       \
1352     size_type idx = std::distance(impl_.b_, position);                        \
1353     T* b;                                                                     \
1354     size_type newCap; /* intentionally uninitialized */                       \
1355                                                                               \
1356     if (fresh) {                                                              \
1357       newCap = computeInsertCapacity(n);                                      \
1358       b = M_allocate(newCap);                                                 \
1359     } else {                                                                  \
1360       if (!at_end) {                                                          \
1361         make_window(position, n);                                             \
1362       } else {                                                                \
1363         impl_.e_ += n;                                                        \
1364       }                                                                       \
1365       b = impl_.b_;                                                           \
1366     }                                                                         \
1367                                                                               \
1368     T* start = b + idx;                                                       \
1369                                                                               \
1370     try {                                                                     \
1371
1372     // construct the inserted elements
1373
1374   #define FOLLY_FBVECTOR_INSERT_TRY(cpos, n)                                  \
1375     } catch (...) {                                                           \
1376       if (fresh) {                                                            \
1377         M_deallocate(b, newCap);                                              \
1378       } else {                                                                \
1379         if (!at_end) {                                                        \
1380           undo_window(position, n);                                           \
1381         } else {                                                              \
1382           impl_.e_ -= n;                                                      \
1383         }                                                                     \
1384       }                                                                       \
1385       throw;                                                                  \
1386     }                                                                         \
1387                                                                               \
1388     if (fresh) {                                                              \
1389       try {                                                                   \
1390         wrap_frame(b, idx, n);                                                \
1391       } catch (...) {                                                         \
1392
1393
1394     // delete the inserted elements (exception has been thrown)
1395
1396   #define FOLLY_FBVECTOR_INSERT_END(cpos, n)                                  \
1397         M_deallocate(b, newCap);                                              \
1398         throw;                                                                \
1399       }                                                                       \
1400       if (impl_.b_) M_deallocate(impl_.b_, capacity());                       \
1401       impl_.set(b, size() + n, newCap);                                       \
1402       return impl_.b_ + idx;                                                  \
1403     } else {                                                                  \
1404       return position;                                                        \
1405     }                                                                         \
1406
1407   //---------------------------------------------------------------------------
1408   // insert functions
1409 public:
1410
1411   template <class... Args>
1412   iterator emplace(const_iterator cpos, Args&&... args) {
1413     FOLLY_FBVECTOR_INSERT_PRE(cpos, 1)
1414     FOLLY_FBVECTOR_INSERT_START(cpos, 1)
1415       M_construct(start, std::forward<Args>(args)...);
1416     FOLLY_FBVECTOR_INSERT_TRY(cpos, 1)
1417       M_destroy(start);
1418     FOLLY_FBVECTOR_INSERT_END(cpos, 1)
1419   }
1420
1421   iterator insert(const_iterator cpos, const T& value) {
1422     FOLLY_FBVECTOR_INSERT_PRE(cpos, 1)
1423       if (dataIsInternal(value)) return insert(cpos, T(value));
1424     FOLLY_FBVECTOR_INSERT_START(cpos, 1)
1425       M_construct(start, value);
1426     FOLLY_FBVECTOR_INSERT_TRY(cpos, 1)
1427       M_destroy(start);
1428     FOLLY_FBVECTOR_INSERT_END(cpos, 1)
1429   }
1430
1431   iterator insert(const_iterator cpos, T&& value) {
1432     FOLLY_FBVECTOR_INSERT_PRE(cpos, 1)
1433       if (dataIsInternal(value)) return insert(cpos, T(std::move(value)));
1434     FOLLY_FBVECTOR_INSERT_START(cpos, 1)
1435       M_construct(start, std::move(value));
1436     FOLLY_FBVECTOR_INSERT_TRY(cpos, 1)
1437       M_destroy(start);
1438     FOLLY_FBVECTOR_INSERT_END(cpos, 1)
1439   }
1440
1441   iterator insert(const_iterator cpos, size_type n, VT value) {
1442     FOLLY_FBVECTOR_INSERT_PRE(cpos, n)
1443       if (dataIsInternalAndNotVT(value)) return insert(cpos, n, T(value));
1444     FOLLY_FBVECTOR_INSERT_START(cpos, n)
1445       D_uninitialized_fill_n_a(start, n, value);
1446     FOLLY_FBVECTOR_INSERT_TRY(cpos, n)
1447       D_destroy_range_a(start, start + n);
1448     FOLLY_FBVECTOR_INSERT_END(cpos, n)
1449   }
1450
1451   template <class It, class Category = typename
1452             std::iterator_traits<It>::iterator_category>
1453   iterator insert(const_iterator cpos, It first, It last) {
1454     return insert(cpos, first, last, Category());
1455   }
1456
1457   iterator insert(const_iterator cpos, std::initializer_list<T> il) {
1458     return insert(cpos, il.begin(), il.end());
1459   }
1460
1461   //---------------------------------------------------------------------------
1462   // insert dispatch for iterator types
1463 private:
1464
1465   template <class FIt>
1466   iterator insert(const_iterator cpos, FIt first, FIt last,
1467                   std::forward_iterator_tag) {
1468     size_type n = std::distance(first, last);
1469     FOLLY_FBVECTOR_INSERT_PRE(cpos, n)
1470     FOLLY_FBVECTOR_INSERT_START(cpos, n)
1471       D_uninitialized_copy_a(start, first, last);
1472     FOLLY_FBVECTOR_INSERT_TRY(cpos, n)
1473       D_destroy_range_a(start, start + n);
1474     FOLLY_FBVECTOR_INSERT_END(cpos, n)
1475   }
1476
1477   template <class IIt>
1478   iterator insert(const_iterator cpos, IIt first, IIt last,
1479                   std::input_iterator_tag) {
1480     T* position = const_cast<T*>(cpos);
1481     assert(isValid(position));
1482     size_type idx = std::distance(begin(), position);
1483
1484     fbvector storage(std::make_move_iterator(position),
1485                      std::make_move_iterator(end()),
1486                      A::select_on_container_copy_construction(impl_));
1487     M_destroy_range_e(position);
1488     for (; first != last; ++first) emplace_back(*first);
1489     insert(cend(), std::make_move_iterator(storage.begin()),
1490            std::make_move_iterator(storage.end()));
1491     return impl_.b_ + idx;
1492   }
1493
1494   //===========================================================================
1495   //---------------------------------------------------------------------------
1496   // lexicographical functions (others from boost::totally_ordered superclass)
1497 public:
1498
1499   bool operator==(const fbvector& other) const {
1500     return size() == other.size() && std::equal(begin(), end(), other.begin());
1501   }
1502
1503   bool operator<(const fbvector& other) const {
1504     return std::lexicographical_compare(
1505       begin(), end(), other.begin(), other.end());
1506   }
1507
1508   //===========================================================================
1509   //---------------------------------------------------------------------------
1510   // friends
1511 private:
1512
1513   template <class _T, class _A>
1514   friend _T* relinquish(fbvector<_T, _A>&);
1515
1516   template <class _T, class _A>
1517   friend void attach(fbvector<_T, _A>&, _T* data, size_t sz, size_t cap);
1518
1519 }; // class fbvector
1520
1521
1522 //=============================================================================
1523 //-----------------------------------------------------------------------------
1524 // outlined functions (gcc, you finicky compiler you)
1525
1526 template <typename T, typename Allocator>
1527 template <class... Args>
1528 void fbvector<T, Allocator>::emplace_back_aux(Args&&... args) {
1529   size_type byte_sz = folly::goodMallocSize(
1530     computePushBackCapacity() * sizeof(T));
1531   if (usingStdAllocator::value
1532       && usingJEMalloc()
1533       && ((impl_.z_ - impl_.b_) * sizeof(T) >=
1534           folly::jemallocMinInPlaceExpandable)) {
1535     // Try to reserve in place.
1536     // Ask xallocx to allocate in place at least size()+1 and at most sz space.
1537     // xallocx will allocate as much as possible within that range, which
1538     //  is the best possible outcome: if sz space is available, take it all,
1539     //  otherwise take as much as possible. If nothing is available, then fail.
1540     // In this fashion, we never relocate if there is a possibility of
1541     //  expanding in place, and we never reallocate by less than the desired
1542     //  amount unless we cannot expand further. Hence we will not reallocate
1543     //  sub-optimally twice in a row (modulo the blocking memory being freed).
1544     size_type lower = folly::goodMallocSize(sizeof(T) + size() * sizeof(T));
1545     size_type upper = byte_sz;
1546     size_type extra = upper - lower;
1547
1548     void* p = impl_.b_;
1549     size_t actual;
1550
1551     if ((actual = xallocx(p, lower, extra, 0)) >= lower) {
1552       impl_.z_ = impl_.b_ + actual / sizeof(T);
1553       M_construct(impl_.e_, std::forward<Args>(args)...);
1554       ++impl_.e_;
1555       return;
1556     }
1557   }
1558
1559   // Reallocation failed. Perform a manual relocation.
1560   size_type sz = byte_sz / sizeof(T);
1561   auto newB = M_allocate(sz);
1562   auto newE = newB + size();
1563   try {
1564     if (folly::IsRelocatable<T>::value && usingStdAllocator::value) {
1565       // For linear memory access, relocate before construction.
1566       // By the test condition, relocate is noexcept.
1567       // Note that there is no cleanup to do if M_construct throws - that's
1568       //  one of the beauties of relocation.
1569       // Benchmarks for this code have high variance, and seem to be close.
1570       relocate_move(newB, impl_.b_, impl_.e_);
1571       M_construct(newE, std::forward<Args>(args)...);
1572       ++newE;
1573     } else {
1574       M_construct(newE, std::forward<Args>(args)...);
1575       ++newE;
1576       try {
1577         M_relocate(newB);
1578       } catch (...) {
1579         M_destroy(newE - 1);
1580         throw;
1581       }
1582     }
1583   } catch (...) {
1584     M_deallocate(newB, sz);
1585     throw;
1586   }
1587   if (impl_.b_) M_deallocate(impl_.b_, size());
1588   impl_.b_ = newB;
1589   impl_.e_ = newE;
1590   impl_.z_ = newB + sz;
1591 }
1592
1593 //=============================================================================
1594 //-----------------------------------------------------------------------------
1595 // specialized functions
1596
1597 template <class T, class A>
1598 void swap(fbvector<T, A>& lhs, fbvector<T, A>& rhs) noexcept {
1599   lhs.swap(rhs);
1600 }
1601
1602 //=============================================================================
1603 //-----------------------------------------------------------------------------
1604 // other
1605
1606 namespace detail {
1607
1608 // Format support.
1609 template <class T, class A>
1610 struct IndexableTraits<fbvector<T, A>>
1611   : public IndexableTraitsSeq<fbvector<T, A>> {
1612 };
1613
1614 }  // namespace detail
1615
1616 template <class T, class A>
1617 void compactResize(fbvector<T, A>* v, size_t sz) {
1618   v->resize(sz);
1619   v->shrink_to_fit();
1620 }
1621
1622 // DANGER
1623 //
1624 // relinquish and attach are not a members function specifically so that it is
1625 //  awkward to call them. It is very easy to shoot yourself in the foot with
1626 //  these functions.
1627 //
1628 // If you call relinquish, then it is your responsibility to free the data
1629 //  and the storage, both of which may have been generated in a non-standard
1630 //  way through the fbvector's allocator.
1631 //
1632 // If you call attach, it is your responsibility to ensure that the fbvector
1633 //  is fresh (size and capacity both zero), and that the supplied data is
1634 //  capable of being manipulated by the allocator.
1635 // It is acceptable to supply a stack pointer IF:
1636 //  (1) The vector's data does not outlive the stack pointer. This includes
1637 //      extension of the data's life through a move operation.
1638 //  (2) The pointer has enough capacity that the vector will never be
1639 //      relocated.
1640 //  (3) Insert is not called on the vector; these functions have leeway to
1641 //      relocate the vector even if there is enough capacity.
1642 //  (4) A stack pointer is compatible with the fbvector's allocator.
1643 //
1644
1645 template <class T, class A>
1646 T* relinquish(fbvector<T, A>& v) {
1647   T* ret = v.data();
1648   v.impl_.b_ = v.impl_.e_ = v.impl_.z_ = nullptr;
1649   return ret;
1650 }
1651
1652 template <class T, class A>
1653 void attach(fbvector<T, A>& v, T* data, size_t sz, size_t cap) {
1654   assert(v.data() == nullptr);
1655   v.impl_.b_ = data;
1656   v.impl_.e_ = data + sz;
1657   v.impl_.z_ = data + cap;
1658 }
1659
1660 } // namespace folly