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     if (first != nullptr) {
 640       std::memcpy((void*)dest, (void*)first, (last - first) * sizeof(T));
 641     }
 642   }
 643
 644   void relocate_move_or_memcpy(T* dest, T* first, T* last, std::false_type) {
 645     relocate_move_or_copy(dest, first, last, relocate_use_move());
 646   }
 647
 648   void relocate_move_or_copy(T* dest, T* first, T* last, std::true_type) {
 649     D_uninitialized_move_a(dest, first, last);
 650   }
 651
 652   void relocate_move_or_copy(T* dest, T* first, T* last, std::false_type) {
 653     D_uninitialized_copy_a(dest, first, last);
 654   }
 655
 656   // done
 657   void relocate_done(T* /*dest*/, T* first, T* last) noexcept {
 658     if (folly::IsRelocatable<T>::value && usingStdAllocator::value) {
 659       // used memcpy; data has been relocated, do not call destructor
 660     } else {
 661       D_destroy_range_a(first, last);
 662     }
 663   }
 664
 665   // undo
 666   void relocate_undo(T* dest, T* first, T* last) noexcept {
 667     if (folly::IsRelocatable<T>::value && usingStdAllocator::value) {
 668       // used memcpy, old data is still valid, nothing to do
 669     } else if (std::is_nothrow_move_constructible<T>::value &&
 670                usingStdAllocator::value) {
 671       // noexcept move everything back, aka relocate_move
 672       relocate_move(first, dest, dest + (last - first));
 673     } else if (!std::is_copy_constructible<T>::value) {
 674       // weak guarantee
 675       D_destroy_range_a(dest, dest + (last - first));
 676     } else {
 677       // used copy, old data is still valid
 678       D_destroy_range_a(dest, dest + (last - first));
 679     }
 680   }
 681
 682
 683   //===========================================================================
 684   //---------------------------------------------------------------------------
 685   // construct/copy/destroy
 686 public:
 687
 688   fbvector() = default;
 689
 690   explicit fbvector(const Allocator& a) : impl_(a) {}
 691
 692   explicit fbvector(size_type n, const Allocator& a = Allocator())
 693     : impl_(n, a)
 694     { M_uninitialized_fill_n_e(n); }
 695
 696   fbvector(size_type n, VT value, const Allocator& a = Allocator())
 697     : impl_(n, a)
 698     { M_uninitialized_fill_n_e(n, value); }
 699
 700   template <class It, class Category = typename
 701             std::iterator_traits<It>::iterator_category>
 702   fbvector(It first, It last, const Allocator& a = Allocator())
 703     : fbvector(first, last, a, Category()) {}
 704
 705   fbvector(const fbvector& other)
 706     : impl_(other.size(), A::select_on_container_copy_construction(other.impl_))
 707     { M_uninitialized_copy_e(other.begin(), other.end()); }
 708
 709   fbvector(fbvector&& other) noexcept : impl_(std::move(other.impl_)) {}
 710
 711   fbvector(const fbvector& other, const Allocator& a)
 712     : fbvector(other.begin(), other.end(), a) {}
 713
 714   /* may throw */ fbvector(fbvector&& other, const Allocator& a) : impl_(a) {
 715     if (impl_ == other.impl_) {
 716       impl_.swapData(other.impl_);
 717     } else {
 718       impl_.init(other.size());
 719       M_uninitialized_move_e(other.begin(), other.end());
 720     }
 721   }
 722
 723   fbvector(std::initializer_list<T> il, const Allocator& a = Allocator())
 724     : fbvector(il.begin(), il.end(), a) {}
 725
 726   ~fbvector() = default; // the cleanup occurs in impl_
 727
 728   fbvector& operator=(const fbvector& other) {
 729     if (UNLIKELY(this == &other)) return *this;
 730
 731     if (!usingStdAllocator::value &&
 732         A::propagate_on_container_copy_assignment::value) {
 733       if (impl_ != other.impl_) {
 734         // can't use other's different allocator to clean up self
 735         impl_.reset();
 736       }
 737       (Allocator&)impl_ = (Allocator&)other.impl_;
 738     }
 739
 740     assign(other.begin(), other.end());
 741     return *this;
 742   }
 743
 744   fbvector& operator=(fbvector&& other) {
 745     if (UNLIKELY(this == &other)) return *this;
 746     moveFrom(std::move(other), moveIsSwap());
 747     return *this;
 748   }
 749
 750   fbvector& operator=(std::initializer_list<T> il) {
 751     assign(il.begin(), il.end());
 752     return *this;
 753   }
 754
 755   template <class It, class Category = typename
 756             std::iterator_traits<It>::iterator_category>
 757   void assign(It first, It last) {
 758     assign(first, last, Category());
 759   }
 760
 761   void assign(size_type n, VT value) {
 762     if (n > capacity()) {
 763       // Not enough space. Do not reserve in place, since we will
 764       // discard the old values anyways.
 765       if (dataIsInternalAndNotVT(value)) {
 766         T copy(std::move(value));
 767         impl_.reset(n);
 768         M_uninitialized_fill_n_e(n, copy);
 769       } else {
 770         impl_.reset(n);
 771         M_uninitialized_fill_n_e(n, value);
 772       }
 773     } else if (n <= size()) {
 774       auto newE = impl_.b_ + n;
 775       std::fill(impl_.b_, newE, value);
 776       M_destroy_range_e(newE);
 777     } else {
 778       std::fill(impl_.b_, impl_.e_, value);
 779       M_uninitialized_fill_n_e(n - size(), value);
 780     }
 781   }
 782
 783   void assign(std::initializer_list<T> il) {
 784     assign(il.begin(), il.end());
 785   }
 786
 787   allocator_type get_allocator() const noexcept {
 788     return impl_;
 789   }
 790
 791 private:
 792
 793   // contract dispatch for iterator types fbvector(It first, It last)
 794   template <class ForwardIterator>
 795   fbvector(ForwardIterator first, ForwardIterator last,
 796            const Allocator& a, std::forward_iterator_tag)
 797     : impl_(std::distance(first, last), a)
 798     { M_uninitialized_copy_e(first, last); }
 799
 800   template <class InputIterator>
 801   fbvector(InputIterator first, InputIterator last,
 802            const Allocator& a, std::input_iterator_tag)
 803     : impl_(a)
 804     { for (; first != last; ++first) emplace_back(*first); }
 805
 806   // contract dispatch for allocator movement in operator=(fbvector&&)
 807   void
 808   moveFrom(fbvector&& other, std::true_type) {
 809     swap(impl_, other.impl_);
 810   }
 811   void moveFrom(fbvector&& other, std::false_type) {
 812     if (impl_ == other.impl_) {
 813       impl_.swapData(other.impl_);
 814     } else {
 815       impl_.reset(other.size());
 816       M_uninitialized_move_e(other.begin(), other.end());
 817     }
 818   }
 819
 820   // contract dispatch for iterator types in assign(It first, It last)
 821   template <class ForwardIterator>
 822   void assign(ForwardIterator first, ForwardIterator last,
 823               std::forward_iterator_tag) {
 824     const size_t newSize = std::distance(first, last);
 825     if (newSize > capacity()) {
 826       impl_.reset(newSize);
 827       M_uninitialized_copy_e(first, last);
 828     } else if (newSize <= size()) {
 829       auto newEnd = std::copy(first, last, impl_.b_);
 830       M_destroy_range_e(newEnd);
 831     } else {
 832       auto mid = S_copy_n(impl_.b_, first, size());
 833       M_uninitialized_copy_e<decltype(last)>(mid, last);
 834     }
 835   }
 836
 837   template <class InputIterator>
 838   void assign(InputIterator first, InputIterator last,
 839               std::input_iterator_tag) {
 840     auto p = impl_.b_;
 841     for (; first != last && p != impl_.e_; ++first, ++p) {
 842       *p = *first;
 843     }
 844     if (p != impl_.e_) {
 845       M_destroy_range_e(p);
 846     } else {
 847       for (; first != last; ++first) emplace_back(*first);
 848     }
 849   }
 850
 851   // contract dispatch for aliasing under VT optimization
 852   bool dataIsInternalAndNotVT(const T& t) {
 853     if (should_pass_by_value::value) return false;
 854     return dataIsInternal(t);
 855   }
 856   bool dataIsInternal(const T& t) {
 857     return UNLIKELY(impl_.b_ <= std::addressof(t) &&
 858                     std::addressof(t) < impl_.e_);
 859   }
 860
 861
 862   //===========================================================================
 863   //---------------------------------------------------------------------------
 864   // iterators
 865 public:
 866
 867   iterator begin() noexcept {
 868     return impl_.b_;
 869   }
 870   const_iterator begin() const noexcept {
 871     return impl_.b_;
 872   }
 873   iterator end() noexcept {
 874     return impl_.e_;
 875   }
 876   const_iterator end() const noexcept {
 877     return impl_.e_;
 878   }
 879   reverse_iterator rbegin() noexcept {
 880     return reverse_iterator(end());
 881   }
 882   const_reverse_iterator rbegin() const noexcept {
 883     return const_reverse_iterator(end());
 884   }
 885   reverse_iterator rend() noexcept {
 886     return reverse_iterator(begin());
 887   }
 888   const_reverse_iterator rend() const noexcept {
 889     return const_reverse_iterator(begin());
 890   }
 891
 892   const_iterator cbegin() const noexcept {
 893     return impl_.b_;
 894   }
 895   const_iterator cend() const noexcept {
 896     return impl_.e_;
 897   }
 898   const_reverse_iterator crbegin() const noexcept {
 899     return const_reverse_iterator(end());
 900   }
 901   const_reverse_iterator crend() const noexcept {
 902     return const_reverse_iterator(begin());
 903   }
 904
 905   //===========================================================================
 906   //---------------------------------------------------------------------------
 907   // capacity
 908 public:
 909
 910   size_type size() const noexcept {
 911     return impl_.e_ - impl_.b_;
 912   }
 913
 914   size_type max_size() const noexcept {
 915     // good luck gettin' there
 916     return ~size_type(0);
 917   }
 918
 919   void resize(size_type n) {
 920     if (n <= size()) {
 921       M_destroy_range_e(impl_.b_ + n);
 922     } else {
 923       reserve(n);
 924       M_uninitialized_fill_n_e(n - size());
 925     }
 926   }
 927
 928   void resize(size_type n, VT t) {
 929     if (n <= size()) {
 930       M_destroy_range_e(impl_.b_ + n);
 931     } else if (dataIsInternalAndNotVT(t) && n > capacity()) {
 932       T copy(t);
 933       reserve(n);
 934       M_uninitialized_fill_n_e(n - size(), copy);
 935     } else {
 936       reserve(n);
 937       M_uninitialized_fill_n_e(n - size(), t);
 938     }
 939   }
 940
 941   size_type capacity() const noexcept {
 942     return impl_.z_ - impl_.b_;
 943   }
 944
 945   bool empty() const noexcept {
 946     return impl_.b_ == impl_.e_;
 947   }
 948
 949   void reserve(size_type n) {
 950     if (n <= capacity()) return;
 951     if (impl_.b_ && reserve_in_place(n)) return;
 952
 953     auto newCap = folly::goodMallocSize(n * sizeof(T)) / sizeof(T);
 954     auto newB = M_allocate(newCap);
 955     try {
 956       M_relocate(newB);
 957     } catch (...) {
 958       M_deallocate(newB, newCap);
 959       throw;
 960     }
 961     if (impl_.b_)
 962       M_deallocate(impl_.b_, impl_.z_ - impl_.b_);
 963     impl_.z_ = newB + newCap;
 964     impl_.e_ = newB + (impl_.e_ - impl_.b_);
 965     impl_.b_ = newB;
 966   }
 967
 968   void shrink_to_fit() noexcept {
 969     if (empty()) {
 970       impl_.reset();
 971       return;
 972     }
 973
 974     auto const newCapacityBytes = folly::goodMallocSize(size() * sizeof(T));
 975     auto const newCap = newCapacityBytes / sizeof(T);
 976     auto const oldCap = capacity();
 977
 978     if (newCap >= oldCap) return;
 979
 980     void* p = impl_.b_;
 981     // xallocx() will shrink to precisely newCapacityBytes (which was generated
 982     // by goodMallocSize()) if it successfully shrinks in place.
 983     if ((usingJEMalloc() && usingStdAllocator::value) &&
 984         newCapacityBytes >= folly::jemallocMinInPlaceExpandable &&
 985         xallocx(p, newCapacityBytes, 0, 0) == newCapacityBytes) {
 986       impl_.z_ += newCap - oldCap;
 987     } else {
 988       T* newB; // intentionally uninitialized
 989       try {
 990         newB = M_allocate(newCap);
 991         try {
 992           M_relocate(newB);
 993         } catch (...) {
 994           M_deallocate(newB, newCap);
 995           return; // swallow the error
 996         }
 997       } catch (...) {
 998         return;
 999       }
1000       if (impl_.b_)
1001         M_deallocate(impl_.b_, impl_.z_ - impl_.b_);
1002       impl_.z_ = newB + newCap;
1003       impl_.e_ = newB + (impl_.e_ - impl_.b_);
1004       impl_.b_ = newB;
1005     }
1006   }
1007
1008 private:
1009
1010   bool reserve_in_place(size_type n) {
1011     if (!usingStdAllocator::value || !usingJEMalloc()) return false;
1012
1013     // jemalloc can never grow in place blocks smaller than 4096 bytes.
1014     if ((impl_.z_ - impl_.b_) * sizeof(T) <
1015       folly::jemallocMinInPlaceExpandable) return false;
1016
1017     auto const newCapacityBytes = folly::goodMallocSize(n * sizeof(T));
1018     void* p = impl_.b_;
1019     if (xallocx(p, newCapacityBytes, 0, 0) == newCapacityBytes) {
1020       impl_.z_ = impl_.b_ + newCapacityBytes / sizeof(T);
1021       return true;
1022     }
1023     return false;
1024   }
1025
1026   //===========================================================================
1027   //---------------------------------------------------------------------------
1028   // element access
1029 public:
1030
1031   reference operator[](size_type n) {
1032     assert(n < size());
1033     return impl_.b_[n];
1034   }
1035   const_reference operator[](size_type n) const {
1036     assert(n < size());
1037     return impl_.b_[n];
1038   }
1039   const_reference at(size_type n) const {
1040     if (UNLIKELY(n >= size())) {
1041       throw std::out_of_range("fbvector: index is greater than size.");
1042     }
1043     return (*this)[n];
1044   }
1045   reference at(size_type n) {
1046     auto const& cThis = *this;
1047     return const_cast<reference>(cThis.at(n));
1048   }
1049   reference front() {
1050     assert(!empty());
1051     return *impl_.b_;
1052   }
1053   const_reference front() const {
1054     assert(!empty());
1055     return *impl_.b_;
1056   }
1057   reference back()  {
1058     assert(!empty());
1059     return impl_.e_[-1];
1060   }
1061   const_reference back() const {
1062     assert(!empty());
1063     return impl_.e_[-1];
1064   }
1065
1066   //===========================================================================
1067   //---------------------------------------------------------------------------
1068   // data access
1069 public:
1070
1071   T* data() noexcept {
1072     return impl_.b_;
1073   }
1074   const T* data() const noexcept {
1075     return impl_.b_;
1076   }
1077
1078   //===========================================================================
1079   //---------------------------------------------------------------------------
1080   // modifiers (common)
1081 public:
1082
1083   template <class... Args>
1084   void emplace_back(Args&&... args)  {
1085     if (impl_.e_ != impl_.z_) {
1086       M_construct(impl_.e_, std::forward<Args>(args)...);
1087       ++impl_.e_;
1088     } else {
1089       emplace_back_aux(std::forward<Args>(args)...);
1090     }
1091   }
1092
1093   void
1094   push_back(const T& value) {
1095     if (impl_.e_ != impl_.z_) {
1096       M_construct(impl_.e_, value);
1097       ++impl_.e_;
1098     } else {
1099       emplace_back_aux(value);
1100     }
1101   }
1102
1103   void
1104   push_back(T&& value) {
1105     if (impl_.e_ != impl_.z_) {
1106       M_construct(impl_.e_, std::move(value));
1107       ++impl_.e_;
1108     } else {
1109       emplace_back_aux(std::move(value));
1110     }
1111   }
1112
1113   void pop_back() {
1114     assert(!empty());
1115     --impl_.e_;
1116     M_destroy(impl_.e_);
1117   }
1118
1119   void swap(fbvector& other) noexcept {
1120     if (!usingStdAllocator::value &&
1121         A::propagate_on_container_swap::value)
1122       swap(impl_, other.impl_);
1123     else impl_.swapData(other.impl_);
1124   }
1125
1126   void clear() noexcept {
1127     M_destroy_range_e(impl_.b_);
1128   }
1129
1130 private:
1131
1132   // std::vector implements a similar function with a different growth
1133   //  strategy: empty() ? 1 : capacity() * 2.
1134   //
1135   // fbvector grows differently on two counts:
1136   //
1137   // (1) initial size
1138   //     Instead of grwoing to size 1 from empty, and fbvector allocates at
1139   //     least 64 bytes. You may still use reserve to reserve a lesser amount
1140   //     of memory.
1141   // (2) 1.5x
1142   //     For medium-sized vectors, the growth strategy is 1.5x. See the docs
1143   //     for details.
1144   //     This does not apply to very small or very large fbvectors. This is a
1145   //     heuristic.
1146   //     A nice addition to fbvector would be the capability of having a user-
1147   //     defined growth strategy, probably as part of the allocator.
1148   //
1149
1150   size_type computePushBackCapacity() const {
1151     if (capacity() == 0) {
1152       return std::max(64 / sizeof(T), size_type(1));
1153     }
1154     if (capacity() < folly::jemallocMinInPlaceExpandable / sizeof(T)) {
1155       return capacity() * 2;
1156     }
1157     if (capacity() > 4096 * 32 / sizeof(T)) {
1158       return capacity() * 2;
1159     }
1160     return (capacity() * 3 + 1) / 2;
1161   }
1162
1163   template <class... Args>
1164   void emplace_back_aux(Args&&... args);
1165
1166   //===========================================================================
1167   //---------------------------------------------------------------------------
1168   // modifiers (erase)
1169 public:
1170
1171   iterator erase(const_iterator position) {
1172     return erase(position, position + 1);
1173   }
1174
1175   iterator erase(const_iterator first, const_iterator last) {
1176     assert(isValid(first) && isValid(last));
1177     assert(first <= last);
1178     if (first != last) {
1179       if (last == end()) {
1180         M_destroy_range_e((iterator)first);
1181       } else {
1182         if (folly::IsRelocatable<T>::value && usingStdAllocator::value) {
1183           D_destroy_range_a((iterator)first, (iterator)last);
1184           if (last - first >= cend() - last) {
1185             std::memcpy((void*)first, (void*)last, (cend() - last) * sizeof(T));
1186           } else {
1187             std::memmove((iterator)first, last, (cend() - last) * sizeof(T));
1188           }
1189           impl_.e_ -= (last - first);
1190         } else {
1191           std::copy(std::make_move_iterator((iterator)last),
1192                     std::make_move_iterator(end()), (iterator)first);
1193           auto newEnd = impl_.e_ - std::distance(first, last);
1194           M_destroy_range_e(newEnd);
1195         }
1196       }
1197     }
1198     return (iterator)first;
1199   }
1200
1201   //===========================================================================
1202   //---------------------------------------------------------------------------
1203   // modifiers (insert)
1204 private: // we have the private section first because it defines some macros
1205
1206   bool isValid(const_iterator it) {
1207     return cbegin() <= it && it <= cend();
1208   }
1209
1210   size_type computeInsertCapacity(size_type n) {
1211     size_type nc = std::max(computePushBackCapacity(), size() + n);
1212     size_type ac = folly::goodMallocSize(nc * sizeof(T)) / sizeof(T);
1213     return ac;
1214   }
1215
1216   //---------------------------------------------------------------------------
1217   //
1218   // make_window takes an fbvector, and creates an uninitialized gap (a
1219   //  window) at the given position, of the given size. The fbvector must
1220   //  have enough capacity.
1221   //
1222   // Explanation by picture.
1223   //
1224   //    123456789______
1225   //        ^
1226   //        make_window here of size 3
1227   //
1228   //    1234___56789___
1229   //
1230   // If something goes wrong and the window must be destroyed, use
1231   //  undo_window to provide a weak exception guarantee. It destroys
1232   //  the right ledge.
1233   //
1234   //    1234___________
1235   //
1236   //---------------------------------------------------------------------------
1237   //
1238   // wrap_frame takes an inverse window and relocates an fbvector around it.
1239   //  The fbvector must have at least as many elements as the left ledge.
1240   //
1241   // Explanation by picture.
1242   //
1243   //        START
1244   //    fbvector:             inverse window:
1245   //    123456789______       _____abcde_______
1246   //                          [idx][ n ]
1247   //
1248   //        RESULT
1249   //    _______________       12345abcde6789___
1250   //
1251   //---------------------------------------------------------------------------
1252   //
1253   // insert_use_fresh_memory returns true iff the fbvector should use a fresh
1254   //  block of memory for the insertion. If the fbvector does not have enough
1255   //  spare capacity, then it must return true. Otherwise either true or false
1256   //  may be returned.
1257   //
1258   //---------------------------------------------------------------------------
1259   //
1260   // These three functions, make_window, wrap_frame, and
1261   //  insert_use_fresh_memory, can be combined into a uniform interface.
1262   // Since that interface involves a lot of case-work, it is built into
1263   //  some macros: FOLLY_FBVECTOR_INSERT_(PRE|START|TRY|END)
1264   // Macros are used in an attempt to let GCC perform better optimizations,
1265   //  especially control flow optimization.
1266   //
1267
1268   //---------------------------------------------------------------------------
1269   // window
1270
1271   void make_window(iterator position, size_type n) {
1272     // The result is guaranteed to be non-negative, so use an unsigned type:
1273     size_type tail = std::distance(position, impl_.e_);
1274
1275     if (tail <= n) {
1276       relocate_move(position + n, position, impl_.e_);
1277       relocate_done(position + n, position, impl_.e_);
1278       impl_.e_ += n;
1279     } else {
1280       if (folly::IsRelocatable<T>::value && usingStdAllocator::value) {
1281         std::memmove(position + n, position, tail * sizeof(T));
1282         impl_.e_ += n;
1283       } else {
1284         D_uninitialized_move_a(impl_.e_, impl_.e_ - n, impl_.e_);
1285         try {
1286           std::copy_backward(std::make_move_iterator(position),
1287                              std::make_move_iterator(impl_.e_ - n), impl_.e_);
1288         } catch (...) {
1289           D_destroy_range_a(impl_.e_ - n, impl_.e_ + n);
1290           impl_.e_ -= n;
1291           throw;
1292         }
1293         impl_.e_ += n;
1294         D_destroy_range_a(position, position + n);
1295       }
1296     }
1297   }
1298
1299   void undo_window(iterator position, size_type n) noexcept {
1300     D_destroy_range_a(position + n, impl_.e_);
1301     impl_.e_ = position;
1302   }
1303
1304   //---------------------------------------------------------------------------
1305   // frame
1306
1307   void wrap_frame(T* ledge, size_type idx, size_type n) {
1308     assert(size() >= idx);
1309     assert(n != 0);
1310
1311     relocate_move(ledge, impl_.b_, impl_.b_ + idx);
1312     try {
1313       relocate_move(ledge + idx + n, impl_.b_ + idx, impl_.e_);
1314     } catch (...) {
1315       relocate_undo(ledge, impl_.b_, impl_.b_ + idx);
1316       throw;
1317     }
1318     relocate_done(ledge, impl_.b_, impl_.b_ + idx);
1319     relocate_done(ledge + idx + n, impl_.b_ + idx, impl_.e_);
1320   }
1321
1322   //---------------------------------------------------------------------------
1323   // use fresh?
1324
1325   bool insert_use_fresh(bool at_end, size_type n) {
1326     if (at_end) {
1327       if (size() + n <= capacity()) return false;
1328       if (reserve_in_place(size() + n)) return false;
1329       return true;
1330     }
1331
1332     if (size() + n > capacity()) return true;
1333
1334     return false;
1335   }
1336
1337   //---------------------------------------------------------------------------
1338   // interface
1339
1340   #define FOLLY_FBVECTOR_INSERT_PRE(cpos, n)                                  \
1341     if (n == 0) return (iterator)cpos;                                        \
1342     bool at_end = cpos == cend();                                             \
1343     bool fresh = insert_use_fresh(at_end, n);                                 \
1344     if (!at_end) {                                                            \
1345       if (!fresh) {
1346
1347     // check for internal data (technically not required by the standard)
1348
1349   #define FOLLY_FBVECTOR_INSERT_START(cpos, n)                                \
1350       }                                                                       \
1351       assert(isValid(cpos));                                                  \
1352     }                                                                         \
1353     T* position = const_cast<T*>(cpos);                                       \
1354     size_type idx = std::distance(impl_.b_, position);                        \
1355     T* b;                                                                     \
1356     size_type newCap; /* intentionally uninitialized */                       \
1357                                                                               \
1358     if (fresh) {                                                              \
1359       newCap = computeInsertCapacity(n);                                      \
1360       b = M_allocate(newCap);                                                 \
1361     } else {                                                                  \
1362       if (!at_end) {                                                          \
1363         make_window(position, n);                                             \
1364       } else {                                                                \
1365         impl_.e_ += n;                                                        \
1366       }                                                                       \
1367       b = impl_.b_;                                                           \
1368     }                                                                         \
1369                                                                               \
1370     T* start = b + idx;                                                       \
1371                                                                               \
1372     try {                                                                     \
1373
1374     // construct the inserted elements
1375
1376   #define FOLLY_FBVECTOR_INSERT_TRY(cpos, n)                                  \
1377     } catch (...) {                                                           \
1378       if (fresh) {                                                            \
1379         M_deallocate(b, newCap);                                              \
1380       } else {                                                                \
1381         if (!at_end) {                                                        \
1382           undo_window(position, n);                                           \
1383         } else {                                                              \
1384           impl_.e_ -= n;                                                      \
1385         }                                                                     \
1386       }                                                                       \
1387       throw;                                                                  \
1388     }                                                                         \
1389                                                                               \
1390     if (fresh) {                                                              \
1391       try {                                                                   \
1392         wrap_frame(b, idx, n);                                                \
1393       } catch (...) {                                                         \
1394
1395
1396     // delete the inserted elements (exception has been thrown)
1397
1398   #define FOLLY_FBVECTOR_INSERT_END(cpos, n)                                  \
1399         M_deallocate(b, newCap);                                              \
1400         throw;                                                                \
1401       }                                                                       \
1402       if (impl_.b_) M_deallocate(impl_.b_, capacity());                       \
1403       impl_.set(b, size() + n, newCap);                                       \
1404       return impl_.b_ + idx;                                                  \
1405     } else {                                                                  \
1406       return position;                                                        \
1407     }                                                                         \
1408
1409   //---------------------------------------------------------------------------
1410   // insert functions
1411 public:
1412
1413   template <class... Args>
1414   iterator emplace(const_iterator cpos, Args&&... args) {
1415     FOLLY_FBVECTOR_INSERT_PRE(cpos, 1)
1416     FOLLY_FBVECTOR_INSERT_START(cpos, 1)
1417       M_construct(start, std::forward<Args>(args)...);
1418     FOLLY_FBVECTOR_INSERT_TRY(cpos, 1)
1419       M_destroy(start);
1420     FOLLY_FBVECTOR_INSERT_END(cpos, 1)
1421   }
1422
1423   iterator insert(const_iterator cpos, const T& value) {
1424     FOLLY_FBVECTOR_INSERT_PRE(cpos, 1)
1425       if (dataIsInternal(value)) return insert(cpos, T(value));
1426     FOLLY_FBVECTOR_INSERT_START(cpos, 1)
1427       M_construct(start, value);
1428     FOLLY_FBVECTOR_INSERT_TRY(cpos, 1)
1429       M_destroy(start);
1430     FOLLY_FBVECTOR_INSERT_END(cpos, 1)
1431   }
1432
1433   iterator insert(const_iterator cpos, T&& value) {
1434     FOLLY_FBVECTOR_INSERT_PRE(cpos, 1)
1435       if (dataIsInternal(value)) return insert(cpos, T(std::move(value)));
1436     FOLLY_FBVECTOR_INSERT_START(cpos, 1)
1437       M_construct(start, std::move(value));
1438     FOLLY_FBVECTOR_INSERT_TRY(cpos, 1)
1439       M_destroy(start);
1440     FOLLY_FBVECTOR_INSERT_END(cpos, 1)
1441   }
1442
1443   iterator insert(const_iterator cpos, size_type n, VT value) {
1444     FOLLY_FBVECTOR_INSERT_PRE(cpos, n)
1445       if (dataIsInternalAndNotVT(value)) return insert(cpos, n, T(value));
1446     FOLLY_FBVECTOR_INSERT_START(cpos, n)
1447       D_uninitialized_fill_n_a(start, n, value);
1448     FOLLY_FBVECTOR_INSERT_TRY(cpos, n)
1449       D_destroy_range_a(start, start + n);
1450     FOLLY_FBVECTOR_INSERT_END(cpos, n)
1451   }
1452
1453   template <class It, class Category = typename
1454             std::iterator_traits<It>::iterator_category>
1455   iterator insert(const_iterator cpos, It first, It last) {
1456     return insert(cpos, first, last, Category());
1457   }
1458
1459   iterator insert(const_iterator cpos, std::initializer_list<T> il) {
1460     return insert(cpos, il.begin(), il.end());
1461   }
1462
1463   //---------------------------------------------------------------------------
1464   // insert dispatch for iterator types
1465 private:
1466
1467   template <class FIt>
1468   iterator insert(const_iterator cpos, FIt first, FIt last,
1469                   std::forward_iterator_tag) {
1470     size_type n = std::distance(first, last);
1471     FOLLY_FBVECTOR_INSERT_PRE(cpos, n)
1472     FOLLY_FBVECTOR_INSERT_START(cpos, n)
1473       D_uninitialized_copy_a(start, first, last);
1474     FOLLY_FBVECTOR_INSERT_TRY(cpos, n)
1475       D_destroy_range_a(start, start + n);
1476     FOLLY_FBVECTOR_INSERT_END(cpos, n)
1477   }
1478
1479   template <class IIt>
1480   iterator insert(const_iterator cpos, IIt first, IIt last,
1481                   std::input_iterator_tag) {
1482     T* position = const_cast<T*>(cpos);
1483     assert(isValid(position));
1484     size_type idx = std::distance(begin(), position);
1485
1486     fbvector storage(std::make_move_iterator(position),
1487                      std::make_move_iterator(end()),
1488                      A::select_on_container_copy_construction(impl_));
1489     M_destroy_range_e(position);
1490     for (; first != last; ++first) emplace_back(*first);
1491     insert(cend(), std::make_move_iterator(storage.begin()),
1492            std::make_move_iterator(storage.end()));
1493     return impl_.b_ + idx;
1494   }
1495
1496   //===========================================================================
1497   //---------------------------------------------------------------------------
1498   // lexicographical functions (others from boost::totally_ordered superclass)
1499 public:
1500
1501   bool operator==(const fbvector& other) const {
1502     return size() == other.size() && std::equal(begin(), end(), other.begin());
1503   }
1504
1505   bool operator<(const fbvector& other) const {
1506     return std::lexicographical_compare(
1507       begin(), end(), other.begin(), other.end());
1508   }
1509
1510   //===========================================================================
1511   //---------------------------------------------------------------------------
1512   // friends
1513 private:
1514
1515   template <class _T, class _A>
1516   friend _T* relinquish(fbvector<_T, _A>&);
1517
1518   template <class _T, class _A>
1519   friend void attach(fbvector<_T, _A>&, _T* data, size_t sz, size_t cap);
1520
1521 }; // class fbvector
1522
1523
1524 //=============================================================================
1525 //-----------------------------------------------------------------------------
1526 // outlined functions (gcc, you finicky compiler you)
1527
1528 template <typename T, typename Allocator>
1529 template <class... Args>
1530 void fbvector<T, Allocator>::emplace_back_aux(Args&&... args) {
1531   size_type byte_sz = folly::goodMallocSize(
1532     computePushBackCapacity() * sizeof(T));
1533   if (usingStdAllocator::value
1534       && usingJEMalloc()
1535       && ((impl_.z_ - impl_.b_) * sizeof(T) >=
1536           folly::jemallocMinInPlaceExpandable)) {
1537     // Try to reserve in place.
1538     // Ask xallocx to allocate in place at least size()+1 and at most sz space.
1539     // xallocx will allocate as much as possible within that range, which
1540     //  is the best possible outcome: if sz space is available, take it all,
1541     //  otherwise take as much as possible. If nothing is available, then fail.
1542     // In this fashion, we never relocate if there is a possibility of
1543     //  expanding in place, and we never reallocate by less than the desired
1544     //  amount unless we cannot expand further. Hence we will not reallocate
1545     //  sub-optimally twice in a row (modulo the blocking memory being freed).
1546     size_type lower = folly::goodMallocSize(sizeof(T) + size() * sizeof(T));
1547     size_type upper = byte_sz;
1548     size_type extra = upper - lower;
1549
1550     void* p = impl_.b_;
1551     size_t actual;
1552
1553     if ((actual = xallocx(p, lower, extra, 0)) >= lower) {
1554       impl_.z_ = impl_.b_ + actual / sizeof(T);
1555       M_construct(impl_.e_, std::forward<Args>(args)...);
1556       ++impl_.e_;
1557       return;
1558     }
1559   }
1560
1561   // Reallocation failed. Perform a manual relocation.
1562   size_type sz = byte_sz / sizeof(T);
1563   auto newB = M_allocate(sz);
1564   auto newE = newB + size();
1565   try {
1566     if (folly::IsRelocatable<T>::value && usingStdAllocator::value) {
1567       // For linear memory access, relocate before construction.
1568       // By the test condition, relocate is noexcept.
1569       // Note that there is no cleanup to do if M_construct throws - that's
1570       //  one of the beauties of relocation.
1571       // Benchmarks for this code have high variance, and seem to be close.
1572       relocate_move(newB, impl_.b_, impl_.e_);
1573       M_construct(newE, std::forward<Args>(args)...);
1574       ++newE;
1575     } else {
1576       M_construct(newE, std::forward<Args>(args)...);
1577       ++newE;
1578       try {
1579         M_relocate(newB);
1580       } catch (...) {
1581         M_destroy(newE - 1);
1582         throw;
1583       }
1584     }
1585   } catch (...) {
1586     M_deallocate(newB, sz);
1587     throw;
1588   }
1589   if (impl_.b_) M_deallocate(impl_.b_, size());
1590   impl_.b_ = newB;
1591   impl_.e_ = newE;
1592   impl_.z_ = newB + sz;
1593 }
1594
1595 //=============================================================================
1596 //-----------------------------------------------------------------------------
1597 // specialized functions
1598
1599 template <class T, class A>
1600 void swap(fbvector<T, A>& lhs, fbvector<T, A>& rhs) noexcept {
1601   lhs.swap(rhs);
1602 }
1603
1604 //=============================================================================
1605 //-----------------------------------------------------------------------------
1606 // other
1607
1608 namespace detail {
1609
1610 // Format support.
1611 template <class T, class A>
1612 struct IndexableTraits<fbvector<T, A>>
1613   : public IndexableTraitsSeq<fbvector<T, A>> {
1614 };
1615
1616 }  // namespace detail
1617
1618 template <class T, class A>
1619 void compactResize(fbvector<T, A>* v, size_t sz) {
1620   v->resize(sz);
1621   v->shrink_to_fit();
1622 }
1623
1624 // DANGER
1625 //
1626 // relinquish and attach are not a members function specifically so that it is
1627 //  awkward to call them. It is very easy to shoot yourself in the foot with
1628 //  these functions.
1629 //
1630 // If you call relinquish, then it is your responsibility to free the data
1631 //  and the storage, both of which may have been generated in a non-standard
1632 //  way through the fbvector's allocator.
1633 //
1634 // If you call attach, it is your responsibility to ensure that the fbvector
1635 //  is fresh (size and capacity both zero), and that the supplied data is
1636 //  capable of being manipulated by the allocator.
1637 // It is acceptable to supply a stack pointer IF:
1638 //  (1) The vector's data does not outlive the stack pointer. This includes
1639 //      extension of the data's life through a move operation.
1640 //  (2) The pointer has enough capacity that the vector will never be
1641 //      relocated.
1642 //  (3) Insert is not called on the vector; these functions have leeway to
1643 //      relocate the vector even if there is enough capacity.
1644 //  (4) A stack pointer is compatible with the fbvector's allocator.
1645 //
1646
1647 template <class T, class A>
1648 T* relinquish(fbvector<T, A>& v) {
1649   T* ret = v.data();
1650   v.impl_.b_ = v.impl_.e_ = v.impl_.z_ = nullptr;
1651   return ret;
1652 }
1653
1654 template <class T, class A>
1655 void attach(fbvector<T, A>& v, T* data, size_t sz, size_t cap) {
1656   assert(v.data() == nullptr);
1657   v.impl_.b_ = data;
1658   v.impl_.e_ = data + sz;
1659   v.impl_.z_ = data + cap;
1660 }
1661
1662 } // namespace folly