c3c6a366dab2dcc35b080ff2eb182e996e3739ce
[lldb.git] / llvm / include / llvm / ADT / SmallVector.h
1 //===- llvm/ADT/SmallVector.h - 'Normally small' vectors --------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines the SmallVector class.
10 //
11 //===----------------------------------------------------------------------===//
12
13 #ifndef LLVM_ADT_SMALLVECTOR_H
14 #define LLVM_ADT_SMALLVECTOR_H
15
16 #include "llvm/ADT/iterator_range.h"
17 #include "llvm/Support/AlignOf.h"
18 #include "llvm/Support/Compiler.h"
19 #include "llvm/Support/ErrorHandling.h"
20 #include "llvm/Support/MathExtras.h"
21 #include "llvm/Support/MemAlloc.h"
22 #include "llvm/Support/type_traits.h"
23 #include <algorithm>
24 #include <cassert>
25 #include <cstddef>
26 #include <cstdlib>
27 #include <cstring>
28 #include <initializer_list>
29 #include <iterator>
30 #include <limits>
31 #include <memory>
32 #include <new>
33 #include <type_traits>
34 #include <utility>
35
36 namespace llvm {
37
38 /// This is all the stuff common to all SmallVectors.
39 ///
40 /// The template parameter specifies the type which should be used to hold the
41 /// Size and Capacity of the SmallVector, so it can be adjusted.
42 /// Using 32 bit size is desirable to shrink the size of the SmallVector.
43 /// Using 64 bit size is desirable for cases like SmallVector<char>, where a
44 /// 32 bit size would limit the vector to ~4GB. SmallVectors are used for
45 /// buffering bitcode output - which can exceed 4GB.
46 template <class Size_T> class SmallVectorBase {
47 protected:
48   void *BeginX;
49   Size_T Size = 0, Capacity;
50
51   /// The maximum value of the Size_T used.
52   static constexpr size_t SizeTypeMax() {
53     return std::numeric_limits<Size_T>::max();
54   }
55
56   SmallVectorBase() = delete;
57   SmallVectorBase(void *FirstEl, size_t TotalCapacity)
58       : BeginX(FirstEl), Capacity(TotalCapacity) {}
59
60   /// This is an implementation of the grow() method which only works
61   /// on POD-like data types and is out of line to reduce code duplication.
62   /// This function will report a fatal error if it cannot increase capacity.
63   void grow_pod(void *FirstEl, size_t MinSize, size_t TSize);
64
65   /// Report that MinSize doesn't fit into this vector's size type. Throws
66   /// std::length_error or calls report_fatal_error.
67   LLVM_ATTRIBUTE_NORETURN static void report_size_overflow(size_t MinSize);
68   /// Report that this vector is already at maximum capacity. Throws
69   /// std::length_error or calls report_fatal_error.
70   LLVM_ATTRIBUTE_NORETURN static void report_at_maximum_capacity();
71
72 public:
73   size_t size() const { return Size; }
74   size_t capacity() const { return Capacity; }
75
76   LLVM_NODISCARD bool empty() const { return !Size; }
77
78   /// Set the array size to \p N, which the current array must have enough
79   /// capacity for.
80   ///
81   /// This does not construct or destroy any elements in the vector.
82   ///
83   /// Clients can use this in conjunction with capacity() to write past the end
84   /// of the buffer when they know that more elements are available, and only
85   /// update the size later. This avoids the cost of value initializing elements
86   /// which will only be overwritten.
87   void set_size(size_t N) {
88     assert(N <= capacity());
89     Size = N;
90   }
91 };
92
93 template <class T>
94 using SmallVectorSizeType =
95     typename std::conditional<sizeof(T) < 4 && sizeof(void *) >= 8, uint64_t,
96                               uint32_t>::type;
97
98 /// Figure out the offset of the first element.
99 template <class T, typename = void> struct SmallVectorAlignmentAndSize {
100   AlignedCharArrayUnion<SmallVectorBase<SmallVectorSizeType<T>>> Base;
101   AlignedCharArrayUnion<T> FirstEl;
102 };
103
104 /// This is the part of SmallVectorTemplateBase which does not depend on whether
105 /// the type T is a POD. The extra dummy template argument is used by ArrayRef
106 /// to avoid unnecessarily requiring T to be complete.
107 template <typename T, typename = void>
108 class SmallVectorTemplateCommon
109     : public SmallVectorBase<SmallVectorSizeType<T>> {
110   using Base = SmallVectorBase<SmallVectorSizeType<T>>;
111
112   /// Find the address of the first element.  For this pointer math to be valid
113   /// with small-size of 0 for T with lots of alignment, it's important that
114   /// SmallVectorStorage is properly-aligned even for small-size of 0.
115   void *getFirstEl() const {
116     return const_cast<void *>(reinterpret_cast<const void *>(
117         reinterpret_cast<const char *>(this) +
118         offsetof(SmallVectorAlignmentAndSize<T>, FirstEl)));
119   }
120   // Space after 'FirstEl' is clobbered, do not add any instance vars after it.
121
122 protected:
123   SmallVectorTemplateCommon(size_t Size) : Base(getFirstEl(), Size) {}
124
125   void grow_pod(size_t MinSize, size_t TSize) {
126     Base::grow_pod(getFirstEl(), MinSize, TSize);
127   }
128
129   /// Return true if this is a smallvector which has not had dynamic
130   /// memory allocated for it.
131   bool isSmall() const { return this->BeginX == getFirstEl(); }
132
133   /// Put this vector in a state of being small.
134   void resetToSmall() {
135     this->BeginX = getFirstEl();
136     this->Size = this->Capacity = 0; // FIXME: Setting Capacity to 0 is suspect.
137   }
138
139 public:
140   using size_type = size_t;
141   using difference_type = ptrdiff_t;
142   using value_type = T;
143   using iterator = T *;
144   using const_iterator = const T *;
145
146   using const_reverse_iterator = std::reverse_iterator<const_iterator>;
147   using reverse_iterator = std::reverse_iterator<iterator>;
148
149   using reference = T &;
150   using const_reference = const T &;
151   using pointer = T *;
152   using const_pointer = const T *;
153
154   using Base::capacity;
155   using Base::empty;
156   using Base::size;
157
158   // forward iterator creation methods.
159   iterator begin() { return (iterator)this->BeginX; }
160   const_iterator begin() const { return (const_iterator)this->BeginX; }
161   iterator end() { return begin() + size(); }
162   const_iterator end() const { return begin() + size(); }
163
164   // reverse iterator creation methods.
165   reverse_iterator rbegin()            { return reverse_iterator(end()); }
166   const_reverse_iterator rbegin() const{ return const_reverse_iterator(end()); }
167   reverse_iterator rend()              { return reverse_iterator(begin()); }
168   const_reverse_iterator rend() const { return const_reverse_iterator(begin());}
169
170   size_type size_in_bytes() const { return size() * sizeof(T); }
171   size_type max_size() const {
172     return std::min(this->SizeTypeMax(), size_type(-1) / sizeof(T));
173   }
174
175   size_t capacity_in_bytes() const { return capacity() * sizeof(T); }
176
177   /// Return a pointer to the vector's buffer, even if empty().
178   pointer data() { return pointer(begin()); }
179   /// Return a pointer to the vector's buffer, even if empty().
180   const_pointer data() const { return const_pointer(begin()); }
181
182   reference operator[](size_type idx) {
183     assert(idx < size());
184     return begin()[idx];
185   }
186   const_reference operator[](size_type idx) const {
187     assert(idx < size());
188     return begin()[idx];
189   }
190
191   reference front() {
192     assert(!empty());
193     return begin()[0];
194   }
195   const_reference front() const {
196     assert(!empty());
197     return begin()[0];
198   }
199
200   reference back() {
201     assert(!empty());
202     return end()[-1];
203   }
204   const_reference back() const {
205     assert(!empty());
206     return end()[-1];
207   }
208 };
209
210 /// SmallVectorTemplateBase<TriviallyCopyable = false> - This is where we put
211 /// method implementations that are designed to work with non-trivial T's.
212 ///
213 /// We approximate is_trivially_copyable with trivial move/copy construction and
214 /// trivial destruction. While the standard doesn't specify that you're allowed
215 /// copy these types with memcpy, there is no way for the type to observe this.
216 /// This catches the important case of std::pair<POD, POD>, which is not
217 /// trivially assignable.
218 template <typename T, bool = (is_trivially_copy_constructible<T>::value) &&
219                              (is_trivially_move_constructible<T>::value) &&
220                              std::is_trivially_destructible<T>::value>
221 class SmallVectorTemplateBase : public SmallVectorTemplateCommon<T> {
222 protected:
223   SmallVectorTemplateBase(size_t Size) : SmallVectorTemplateCommon<T>(Size) {}
224
225   static void destroy_range(T *S, T *E) {
226     while (S != E) {
227       --E;
228       E->~T();
229     }
230   }
231
232   /// Move the range [I, E) into the uninitialized memory starting with "Dest",
233   /// constructing elements as needed.
234   template<typename It1, typename It2>
235   static void uninitialized_move(It1 I, It1 E, It2 Dest) {
236     std::uninitialized_copy(std::make_move_iterator(I),
237                             std::make_move_iterator(E), Dest);
238   }
239
240   /// Copy the range [I, E) onto the uninitialized memory starting with "Dest",
241   /// constructing elements as needed.
242   template<typename It1, typename It2>
243   static void uninitialized_copy(It1 I, It1 E, It2 Dest) {
244     std::uninitialized_copy(I, E, Dest);
245   }
246
247   /// Grow the allocated memory (without initializing new elements), doubling
248   /// the size of the allocated memory. Guarantees space for at least one more
249   /// element, or MinSize more elements if specified.
250   void grow(size_t MinSize = 0);
251
252 public:
253   void push_back(const T &Elt) {
254     if (LLVM_UNLIKELY(this->size() >= this->capacity()))
255       this->grow();
256     ::new ((void*) this->end()) T(Elt);
257     this->set_size(this->size() + 1);
258   }
259
260   void push_back(T &&Elt) {
261     if (LLVM_UNLIKELY(this->size() >= this->capacity()))
262       this->grow();
263     ::new ((void*) this->end()) T(::std::move(Elt));
264     this->set_size(this->size() + 1);
265   }
266
267   void pop_back() {
268     this->set_size(this->size() - 1);
269     this->end()->~T();
270   }
271 };
272
273 // Define this out-of-line to dissuade the C++ compiler from inlining it.
274 template <typename T, bool TriviallyCopyable>
275 void SmallVectorTemplateBase<T, TriviallyCopyable>::grow(size_t MinSize) {
276   // Ensure we can fit the new capacity.
277   // This is only going to be applicable when the capacity is 32 bit.
278   if (MinSize > this->SizeTypeMax())
279     this->report_size_overflow(MinSize);
280
281   // Ensure we can meet the guarantee of space for at least one more element.
282   // The above check alone will not catch the case where grow is called with a
283   // default MinSize of 0, but the current capacity cannot be increased.
284   // This is only going to be applicable when the capacity is 32 bit.
285   if (this->capacity() == this->SizeTypeMax())
286     this->report_at_maximum_capacity();
287
288   // Always grow, even from zero.
289   size_t NewCapacity = size_t(NextPowerOf2(this->capacity() + 2));
290   NewCapacity = std::min(std::max(NewCapacity, MinSize), this->SizeTypeMax());
291   T *NewElts = static_cast<T*>(llvm::safe_malloc(NewCapacity*sizeof(T)));
292
293   // Move the elements over.
294   this->uninitialized_move(this->begin(), this->end(), NewElts);
295
296   // Destroy the original elements.
297   destroy_range(this->begin(), this->end());
298
299   // If this wasn't grown from the inline copy, deallocate the old space.
300   if (!this->isSmall())
301     free(this->begin());
302
303   this->BeginX = NewElts;
304   this->Capacity = NewCapacity;
305 }
306
307 /// SmallVectorTemplateBase<TriviallyCopyable = true> - This is where we put
308 /// method implementations that are designed to work with trivially copyable
309 /// T's. This allows using memcpy in place of copy/move construction and
310 /// skipping destruction.
311 template <typename T>
312 class SmallVectorTemplateBase<T, true> : public SmallVectorTemplateCommon<T> {
313 protected:
314   SmallVectorTemplateBase(size_t Size) : SmallVectorTemplateCommon<T>(Size) {}
315
316   // No need to do a destroy loop for POD's.
317   static void destroy_range(T *, T *) {}
318
319   /// Move the range [I, E) onto the uninitialized memory
320   /// starting with "Dest", constructing elements into it as needed.
321   template<typename It1, typename It2>
322   static void uninitialized_move(It1 I, It1 E, It2 Dest) {
323     // Just do a copy.
324     uninitialized_copy(I, E, Dest);
325   }
326
327   /// Copy the range [I, E) onto the uninitialized memory
328   /// starting with "Dest", constructing elements into it as needed.
329   template<typename It1, typename It2>
330   static void uninitialized_copy(It1 I, It1 E, It2 Dest) {
331     // Arbitrary iterator types; just use the basic implementation.
332     std::uninitialized_copy(I, E, Dest);
333   }
334
335   /// Copy the range [I, E) onto the uninitialized memory
336   /// starting with "Dest", constructing elements into it as needed.
337   template <typename T1, typename T2>
338   static void uninitialized_copy(
339       T1 *I, T1 *E, T2 *Dest,
340       std::enable_if_t<std::is_same<typename std::remove_const<T1>::type,
341                                     T2>::value> * = nullptr) {
342     // Use memcpy for PODs iterated by pointers (which includes SmallVector
343     // iterators): std::uninitialized_copy optimizes to memmove, but we can
344     // use memcpy here. Note that I and E are iterators and thus might be
345     // invalid for memcpy if they are equal.
346     if (I != E)
347       memcpy(reinterpret_cast<void *>(Dest), I, (E - I) * sizeof(T));
348   }
349
350   /// Double the size of the allocated memory, guaranteeing space for at
351   /// least one more element or MinSize if specified.
352   void grow(size_t MinSize = 0) { this->grow_pod(MinSize, sizeof(T)); }
353
354 public:
355   void push_back(const T &Elt) {
356     if (LLVM_UNLIKELY(this->size() >= this->capacity()))
357       this->grow();
358     memcpy(reinterpret_cast<void *>(this->end()), &Elt, sizeof(T));
359     this->set_size(this->size() + 1);
360   }
361
362   void pop_back() { this->set_size(this->size() - 1); }
363 };
364
365 /// This class consists of common code factored out of the SmallVector class to
366 /// reduce code duplication based on the SmallVector 'N' template parameter.
367 template <typename T>
368 class SmallVectorImpl : public SmallVectorTemplateBase<T> {
369   using SuperClass = SmallVectorTemplateBase<T>;
370
371 public:
372   using iterator = typename SuperClass::iterator;
373   using const_iterator = typename SuperClass::const_iterator;
374   using reference = typename SuperClass::reference;
375   using size_type = typename SuperClass::size_type;
376
377 protected:
378   // Default ctor - Initialize to empty.
379   explicit SmallVectorImpl(unsigned N)
380       : SmallVectorTemplateBase<T>(N) {}
381
382 public:
383   SmallVectorImpl(const SmallVectorImpl &) = delete;
384
385   ~SmallVectorImpl() {
386     // Subclass has already destructed this vector's elements.
387     // If this wasn't grown from the inline copy, deallocate the old space.
388     if (!this->isSmall())
389       free(this->begin());
390   }
391
392   void clear() {
393     this->destroy_range(this->begin(), this->end());
394     this->Size = 0;
395   }
396
397   void resize(size_type N) {
398     if (N < this->size()) {
399       this->destroy_range(this->begin()+N, this->end());
400       this->set_size(N);
401     } else if (N > this->size()) {
402       if (this->capacity() < N)
403         this->grow(N);
404       for (auto I = this->end(), E = this->begin() + N; I != E; ++I)
405         new (&*I) T();
406       this->set_size(N);
407     }
408   }
409
410   void resize(size_type N, const T &NV) {
411     if (N < this->size()) {
412       this->destroy_range(this->begin()+N, this->end());
413       this->set_size(N);
414     } else if (N > this->size()) {
415       if (this->capacity() < N)
416         this->grow(N);
417       std::uninitialized_fill(this->end(), this->begin()+N, NV);
418       this->set_size(N);
419     }
420   }
421
422   void reserve(size_type N) {
423     if (this->capacity() < N)
424       this->grow(N);
425   }
426
427   LLVM_NODISCARD T pop_back_val() {
428     T Result = ::std::move(this->back());
429     this->pop_back();
430     return Result;
431   }
432
433   void swap(SmallVectorImpl &RHS);
434
435   /// Add the specified range to the end of the SmallVector.
436   template <typename in_iter,
437             typename = std::enable_if_t<std::is_convertible<
438                 typename std::iterator_traits<in_iter>::iterator_category,
439                 std::input_iterator_tag>::value>>
440   void append(in_iter in_start, in_iter in_end) {
441     size_type NumInputs = std::distance(in_start, in_end);
442     if (NumInputs > this->capacity() - this->size())
443       this->grow(this->size()+NumInputs);
444
445     this->uninitialized_copy(in_start, in_end, this->end());
446     this->set_size(this->size() + NumInputs);
447   }
448
449   /// Append \p NumInputs copies of \p Elt to the end.
450   void append(size_type NumInputs, const T &Elt) {
451     if (NumInputs > this->capacity() - this->size())
452       this->grow(this->size()+NumInputs);
453
454     std::uninitialized_fill_n(this->end(), NumInputs, Elt);
455     this->set_size(this->size() + NumInputs);
456   }
457
458   void append(std::initializer_list<T> IL) {
459     append(IL.begin(), IL.end());
460   }
461
462   // FIXME: Consider assigning over existing elements, rather than clearing &
463   // re-initializing them - for all assign(...) variants.
464
465   void assign(size_type NumElts, const T &Elt) {
466     clear();
467     if (this->capacity() < NumElts)
468       this->grow(NumElts);
469     this->set_size(NumElts);
470     std::uninitialized_fill(this->begin(), this->end(), Elt);
471   }
472
473   template <typename in_iter,
474             typename = std::enable_if_t<std::is_convertible<
475                 typename std::iterator_traits<in_iter>::iterator_category,
476                 std::input_iterator_tag>::value>>
477   void assign(in_iter in_start, in_iter in_end) {
478     clear();
479     append(in_start, in_end);
480   }
481
482   void assign(std::initializer_list<T> IL) {
483     clear();
484     append(IL);
485   }
486
487   iterator erase(const_iterator CI) {
488     // Just cast away constness because this is a non-const member function.
489     iterator I = const_cast<iterator>(CI);
490
491     assert(I >= this->begin() && "Iterator to erase is out of bounds.");
492     assert(I < this->end() && "Erasing at past-the-end iterator.");
493
494     iterator N = I;
495     // Shift all elts down one.
496     std::move(I+1, this->end(), I);
497     // Drop the last elt.
498     this->pop_back();
499     return(N);
500   }
501
502   iterator erase(const_iterator CS, const_iterator CE) {
503     // Just cast away constness because this is a non-const member function.
504     iterator S = const_cast<iterator>(CS);
505     iterator E = const_cast<iterator>(CE);
506
507     assert(S >= this->begin() && "Range to erase is out of bounds.");
508     assert(S <= E && "Trying to erase invalid range.");
509     assert(E <= this->end() && "Trying to erase past the end.");
510
511     iterator N = S;
512     // Shift all elts down.
513     iterator I = std::move(E, this->end(), S);
514     // Drop the last elts.
515     this->destroy_range(I, this->end());
516     this->set_size(I - this->begin());
517     return(N);
518   }
519
520   iterator insert(iterator I, T &&Elt) {
521     if (I == this->end()) {  // Important special case for empty vector.
522       this->push_back(::std::move(Elt));
523       return this->end()-1;
524     }
525
526     assert(I >= this->begin() && "Insertion iterator is out of bounds.");
527     assert(I <= this->end() && "Inserting past the end of the vector.");
528
529     if (this->size() >= this->capacity()) {
530       size_t EltNo = I-this->begin();
531       this->grow();
532       I = this->begin()+EltNo;
533     }
534
535     ::new ((void*) this->end()) T(::std::move(this->back()));
536     // Push everything else over.
537     std::move_backward(I, this->end()-1, this->end());
538     this->set_size(this->size() + 1);
539
540     // If we just moved the element we're inserting, be sure to update
541     // the reference.
542     T *EltPtr = &Elt;
543     if (I <= EltPtr && EltPtr < this->end())
544       ++EltPtr;
545
546     *I = ::std::move(*EltPtr);
547     return I;
548   }
549
550   iterator insert(iterator I, const T &Elt) {
551     if (I == this->end()) {  // Important special case for empty vector.
552       this->push_back(Elt);
553       return this->end()-1;
554     }
555
556     assert(I >= this->begin() && "Insertion iterator is out of bounds.");
557     assert(I <= this->end() && "Inserting past the end of the vector.");
558
559     if (this->size() >= this->capacity()) {
560       size_t EltNo = I-this->begin();
561       this->grow();
562       I = this->begin()+EltNo;
563     }
564     ::new ((void*) this->end()) T(std::move(this->back()));
565     // Push everything else over.
566     std::move_backward(I, this->end()-1, this->end());
567     this->set_size(this->size() + 1);
568
569     // If we just moved the element we're inserting, be sure to update
570     // the reference.
571     const T *EltPtr = &Elt;
572     if (I <= EltPtr && EltPtr < this->end())
573       ++EltPtr;
574
575     *I = *EltPtr;
576     return I;
577   }
578
579   iterator insert(iterator I, size_type NumToInsert, const T &Elt) {
580     // Convert iterator to elt# to avoid invalidating iterator when we reserve()
581     size_t InsertElt = I - this->begin();
582
583     if (I == this->end()) {  // Important special case for empty vector.
584       append(NumToInsert, Elt);
585       return this->begin()+InsertElt;
586     }
587
588     assert(I >= this->begin() && "Insertion iterator is out of bounds.");
589     assert(I <= this->end() && "Inserting past the end of the vector.");
590
591     // Ensure there is enough space.
592     reserve(this->size() + NumToInsert);
593
594     // Uninvalidate the iterator.
595     I = this->begin()+InsertElt;
596
597     // If there are more elements between the insertion point and the end of the
598     // range than there are being inserted, we can use a simple approach to
599     // insertion.  Since we already reserved space, we know that this won't
600     // reallocate the vector.
601     if (size_t(this->end()-I) >= NumToInsert) {
602       T *OldEnd = this->end();
603       append(std::move_iterator<iterator>(this->end() - NumToInsert),
604              std::move_iterator<iterator>(this->end()));
605
606       // Copy the existing elements that get replaced.
607       std::move_backward(I, OldEnd-NumToInsert, OldEnd);
608
609       std::fill_n(I, NumToInsert, Elt);
610       return I;
611     }
612
613     // Otherwise, we're inserting more elements than exist already, and we're
614     // not inserting at the end.
615
616     // Move over the elements that we're about to overwrite.
617     T *OldEnd = this->end();
618     this->set_size(this->size() + NumToInsert);
619     size_t NumOverwritten = OldEnd-I;
620     this->uninitialized_move(I, OldEnd, this->end()-NumOverwritten);
621
622     // Replace the overwritten part.
623     std::fill_n(I, NumOverwritten, Elt);
624
625     // Insert the non-overwritten middle part.
626     std::uninitialized_fill_n(OldEnd, NumToInsert-NumOverwritten, Elt);
627     return I;
628   }
629
630   template <typename ItTy,
631             typename = std::enable_if_t<std::is_convertible<
632                 typename std::iterator_traits<ItTy>::iterator_category,
633                 std::input_iterator_tag>::value>>
634   iterator insert(iterator I, ItTy From, ItTy To) {
635     // Convert iterator to elt# to avoid invalidating iterator when we reserve()
636     size_t InsertElt = I - this->begin();
637
638     if (I == this->end()) {  // Important special case for empty vector.
639       append(From, To);
640       return this->begin()+InsertElt;
641     }
642
643     assert(I >= this->begin() && "Insertion iterator is out of bounds.");
644     assert(I <= this->end() && "Inserting past the end of the vector.");
645
646     size_t NumToInsert = std::distance(From, To);
647
648     // Ensure there is enough space.
649     reserve(this->size() + NumToInsert);
650
651     // Uninvalidate the iterator.
652     I = this->begin()+InsertElt;
653
654     // If there are more elements between the insertion point and the end of the
655     // range than there are being inserted, we can use a simple approach to
656     // insertion.  Since we already reserved space, we know that this won't
657     // reallocate the vector.
658     if (size_t(this->end()-I) >= NumToInsert) {
659       T *OldEnd = this->end();
660       append(std::move_iterator<iterator>(this->end() - NumToInsert),
661              std::move_iterator<iterator>(this->end()));
662
663       // Copy the existing elements that get replaced.
664       std::move_backward(I, OldEnd-NumToInsert, OldEnd);
665
666       std::copy(From, To, I);
667       return I;
668     }
669
670     // Otherwise, we're inserting more elements than exist already, and we're
671     // not inserting at the end.
672
673     // Move over the elements that we're about to overwrite.
674     T *OldEnd = this->end();
675     this->set_size(this->size() + NumToInsert);
676     size_t NumOverwritten = OldEnd-I;
677     this->uninitialized_move(I, OldEnd, this->end()-NumOverwritten);
678
679     // Replace the overwritten part.
680     for (T *J = I; NumOverwritten > 0; --NumOverwritten) {
681       *J = *From;
682       ++J; ++From;
683     }
684
685     // Insert the non-overwritten middle part.
686     this->uninitialized_copy(From, To, OldEnd);
687     return I;
688   }
689
690   void insert(iterator I, std::initializer_list<T> IL) {
691     insert(I, IL.begin(), IL.end());
692   }
693
694   template <typename... ArgTypes> reference emplace_back(ArgTypes &&... Args) {
695     if (LLVM_UNLIKELY(this->size() >= this->capacity()))
696       this->grow();
697     ::new ((void *)this->end()) T(std::forward<ArgTypes>(Args)...);
698     this->set_size(this->size() + 1);
699     return this->back();
700   }
701
702   SmallVectorImpl &operator=(const SmallVectorImpl &RHS);
703
704   SmallVectorImpl &operator=(SmallVectorImpl &&RHS);
705
706   bool operator==(const SmallVectorImpl &RHS) const {
707     if (this->size() != RHS.size()) return false;
708     return std::equal(this->begin(), this->end(), RHS.begin());
709   }
710   bool operator!=(const SmallVectorImpl &RHS) const {
711     return !(*this == RHS);
712   }
713
714   bool operator<(const SmallVectorImpl &RHS) const {
715     return std::lexicographical_compare(this->begin(), this->end(),
716                                         RHS.begin(), RHS.end());
717   }
718 };
719
720 template <typename T>
721 void SmallVectorImpl<T>::swap(SmallVectorImpl<T> &RHS) {
722   if (this == &RHS) return;
723
724   // We can only avoid copying elements if neither vector is small.
725   if (!this->isSmall() && !RHS.isSmall()) {
726     std::swap(this->BeginX, RHS.BeginX);
727     std::swap(this->Size, RHS.Size);
728     std::swap(this->Capacity, RHS.Capacity);
729     return;
730   }
731   if (RHS.size() > this->capacity())
732     this->grow(RHS.size());
733   if (this->size() > RHS.capacity())
734     RHS.grow(this->size());
735
736   // Swap the shared elements.
737   size_t NumShared = this->size();
738   if (NumShared > RHS.size()) NumShared = RHS.size();
739   for (size_type i = 0; i != NumShared; ++i)
740     std::swap((*this)[i], RHS[i]);
741
742   // Copy over the extra elts.
743   if (this->size() > RHS.size()) {
744     size_t EltDiff = this->size() - RHS.size();
745     this->uninitialized_copy(this->begin()+NumShared, this->end(), RHS.end());
746     RHS.set_size(RHS.size() + EltDiff);
747     this->destroy_range(this->begin()+NumShared, this->end());
748     this->set_size(NumShared);
749   } else if (RHS.size() > this->size()) {
750     size_t EltDiff = RHS.size() - this->size();
751     this->uninitialized_copy(RHS.begin()+NumShared, RHS.end(), this->end());
752     this->set_size(this->size() + EltDiff);
753     this->destroy_range(RHS.begin()+NumShared, RHS.end());
754     RHS.set_size(NumShared);
755   }
756 }
757
758 template <typename T>
759 SmallVectorImpl<T> &SmallVectorImpl<T>::
760   operator=(const SmallVectorImpl<T> &RHS) {
761   // Avoid self-assignment.
762   if (this == &RHS) return *this;
763
764   // If we already have sufficient space, assign the common elements, then
765   // destroy any excess.
766   size_t RHSSize = RHS.size();
767   size_t CurSize = this->size();
768   if (CurSize >= RHSSize) {
769     // Assign common elements.
770     iterator NewEnd;
771     if (RHSSize)
772       NewEnd = std::copy(RHS.begin(), RHS.begin()+RHSSize, this->begin());
773     else
774       NewEnd = this->begin();
775
776     // Destroy excess elements.
777     this->destroy_range(NewEnd, this->end());
778
779     // Trim.
780     this->set_size(RHSSize);
781     return *this;
782   }
783
784   // If we have to grow to have enough elements, destroy the current elements.
785   // This allows us to avoid copying them during the grow.
786   // FIXME: don't do this if they're efficiently moveable.
787   if (this->capacity() < RHSSize) {
788     // Destroy current elements.
789     this->destroy_range(this->begin(), this->end());
790     this->set_size(0);
791     CurSize = 0;
792     this->grow(RHSSize);
793   } else if (CurSize) {
794     // Otherwise, use assignment for the already-constructed elements.
795     std::copy(RHS.begin(), RHS.begin()+CurSize, this->begin());
796   }
797
798   // Copy construct the new elements in place.
799   this->uninitialized_copy(RHS.begin()+CurSize, RHS.end(),
800                            this->begin()+CurSize);
801
802   // Set end.
803   this->set_size(RHSSize);
804   return *this;
805 }
806
807 template <typename T>
808 SmallVectorImpl<T> &SmallVectorImpl<T>::operator=(SmallVectorImpl<T> &&RHS) {
809   // Avoid self-assignment.
810   if (this == &RHS) return *this;
811
812   // If the RHS isn't small, clear this vector and then steal its buffer.
813   if (!RHS.isSmall()) {
814     this->destroy_range(this->begin(), this->end());
815     if (!this->isSmall()) free(this->begin());
816     this->BeginX = RHS.BeginX;
817     this->Size = RHS.Size;
818     this->Capacity = RHS.Capacity;
819     RHS.resetToSmall();
820     return *this;
821   }
822
823   // If we already have sufficient space, assign the common elements, then
824   // destroy any excess.
825   size_t RHSSize = RHS.size();
826   size_t CurSize = this->size();
827   if (CurSize >= RHSSize) {
828     // Assign common elements.
829     iterator NewEnd = this->begin();
830     if (RHSSize)
831       NewEnd = std::move(RHS.begin(), RHS.end(), NewEnd);
832
833     // Destroy excess elements and trim the bounds.
834     this->destroy_range(NewEnd, this->end());
835     this->set_size(RHSSize);
836
837     // Clear the RHS.
838     RHS.clear();
839
840     return *this;
841   }
842
843   // If we have to grow to have enough elements, destroy the current elements.
844   // This allows us to avoid copying them during the grow.
845   // FIXME: this may not actually make any sense if we can efficiently move
846   // elements.
847   if (this->capacity() < RHSSize) {
848     // Destroy current elements.
849     this->destroy_range(this->begin(), this->end());
850     this->set_size(0);
851     CurSize = 0;
852     this->grow(RHSSize);
853   } else if (CurSize) {
854     // Otherwise, use assignment for the already-constructed elements.
855     std::move(RHS.begin(), RHS.begin()+CurSize, this->begin());
856   }
857
858   // Move-construct the new elements in place.
859   this->uninitialized_move(RHS.begin()+CurSize, RHS.end(),
860                            this->begin()+CurSize);
861
862   // Set end.
863   this->set_size(RHSSize);
864
865   RHS.clear();
866   return *this;
867 }
868
869 /// Storage for the SmallVector elements.  This is specialized for the N=0 case
870 /// to avoid allocating unnecessary storage.
871 template <typename T, unsigned N>
872 struct SmallVectorStorage {
873   AlignedCharArrayUnion<T> InlineElts[N];
874 };
875
876 /// We need the storage to be properly aligned even for small-size of 0 so that
877 /// the pointer math in \a SmallVectorTemplateCommon::getFirstEl() is
878 /// well-defined.
879 template <typename T> struct alignas(alignof(T)) SmallVectorStorage<T, 0> {};
880
881 /// This is a 'vector' (really, a variable-sized array), optimized
882 /// for the case when the array is small.  It contains some number of elements
883 /// in-place, which allows it to avoid heap allocation when the actual number of
884 /// elements is below that threshold.  This allows normal "small" cases to be
885 /// fast without losing generality for large inputs.
886 ///
887 /// Note that this does not attempt to be exception safe.
888 ///
889 template <typename T, unsigned N>
890 class LLVM_GSL_OWNER SmallVector : public SmallVectorImpl<T>,
891                                    SmallVectorStorage<T, N> {
892 public:
893   SmallVector() : SmallVectorImpl<T>(N) {}
894
895   ~SmallVector() {
896     // Destroy the constructed elements in the vector.
897     this->destroy_range(this->begin(), this->end());
898   }
899
900   explicit SmallVector(size_t Size, const T &Value = T())
901     : SmallVectorImpl<T>(N) {
902     this->assign(Size, Value);
903   }
904
905   template <typename ItTy,
906             typename = std::enable_if_t<std::is_convertible<
907                 typename std::iterator_traits<ItTy>::iterator_category,
908                 std::input_iterator_tag>::value>>
909   SmallVector(ItTy S, ItTy E) : SmallVectorImpl<T>(N) {
910     this->append(S, E);
911   }
912
913   template <typename RangeTy>
914   explicit SmallVector(const iterator_range<RangeTy> &R)
915       : SmallVectorImpl<T>(N) {
916     this->append(R.begin(), R.end());
917   }
918
919   SmallVector(std::initializer_list<T> IL) : SmallVectorImpl<T>(N) {
920     this->assign(IL);
921   }
922
923   SmallVector(const SmallVector &RHS) : SmallVectorImpl<T>(N) {
924     if (!RHS.empty())
925       SmallVectorImpl<T>::operator=(RHS);
926   }
927
928   const SmallVector &operator=(const SmallVector &RHS) {
929     SmallVectorImpl<T>::operator=(RHS);
930     return *this;
931   }
932
933   SmallVector(SmallVector &&RHS) : SmallVectorImpl<T>(N) {
934     if (!RHS.empty())
935       SmallVectorImpl<T>::operator=(::std::move(RHS));
936   }
937
938   SmallVector(SmallVectorImpl<T> &&RHS) : SmallVectorImpl<T>(N) {
939     if (!RHS.empty())
940       SmallVectorImpl<T>::operator=(::std::move(RHS));
941   }
942
943   const SmallVector &operator=(SmallVector &&RHS) {
944     SmallVectorImpl<T>::operator=(::std::move(RHS));
945     return *this;
946   }
947
948   const SmallVector &operator=(SmallVectorImpl<T> &&RHS) {
949     SmallVectorImpl<T>::operator=(::std::move(RHS));
950     return *this;
951   }
952
953   const SmallVector &operator=(std::initializer_list<T> IL) {
954     this->assign(IL);
955     return *this;
956   }
957 };
958
959 template <typename T, unsigned N>
960 inline size_t capacity_in_bytes(const SmallVector<T, N> &X) {
961   return X.capacity_in_bytes();
962 }
963
964 /// Given a range of type R, iterate the entire range and return a
965 /// SmallVector with elements of the vector.  This is useful, for example,
966 /// when you want to iterate a range and then sort the results.
967 template <unsigned Size, typename R>
968 SmallVector<typename std::remove_const<typename std::remove_reference<
969                 decltype(*std::begin(std::declval<R &>()))>::type>::type,
970             Size>
971 to_vector(R &&Range) {
972   return {std::begin(Range), std::end(Range)};
973 }
974
975 } // end namespace llvm
976
977 namespace std {
978
979   /// Implement std::swap in terms of SmallVector swap.
980   template<typename T>
981   inline void
982   swap(llvm::SmallVectorImpl<T> &LHS, llvm::SmallVectorImpl<T> &RHS) {
983     LHS.swap(RHS);
984   }
985
986   /// Implement std::swap in terms of SmallVector swap.
987   template<typename T, unsigned N>
988   inline void
989   swap(llvm::SmallVector<T, N> &LHS, llvm::SmallVector<T, N> &RHS) {
990     LHS.swap(RHS);
991   }
992
993 } // end namespace std
994
995 #endif // LLVM_ADT_SMALLVECTOR_H