xref: /llvm-project/llvm/lib/Support/SmallVector.cpp (revision 848b0e244c9ff5413c2eee6357d5faab1402d619)
1 //===- llvm/ADT/SmallVector.cpp - 'Normally small' vectors ----------------===//
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 implements the SmallVector class.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "llvm/ADT/SmallVector.h"
14 #include <cstdint>
15 using namespace llvm;
16 
17 // Check that no bytes are wasted and everything is well-aligned.
18 namespace {
19 struct Struct16B {
20   alignas(16) void *X;
21 };
22 struct Struct32B {
23   alignas(32) void *X;
24 };
25 }
26 static_assert(sizeof(SmallVector<void *, 0>) ==
27                   sizeof(unsigned) * 2 + sizeof(void *),
28               "wasted space in SmallVector size 0");
29 static_assert(alignof(SmallVector<Struct16B, 0>) >= alignof(Struct16B),
30               "wrong alignment for 16-byte aligned T");
31 static_assert(alignof(SmallVector<Struct32B, 0>) >= alignof(Struct32B),
32               "wrong alignment for 32-byte aligned T");
33 static_assert(sizeof(SmallVector<Struct16B, 0>) >= alignof(Struct16B),
34               "missing padding for 16-byte aligned T");
35 static_assert(sizeof(SmallVector<Struct32B, 0>) >= alignof(Struct32B),
36               "missing padding for 32-byte aligned T");
37 static_assert(sizeof(SmallVector<void *, 1>) ==
38                   sizeof(unsigned) * 2 + sizeof(void *) * 2,
39               "wasted space in SmallVector size 1");
40 
41 static_assert(sizeof(SmallVector<char, 0>) ==
42                   sizeof(void *) * 2 + sizeof(void *),
43               "1 byte elements have word-sized type for size and capacity");
44 
45 // Note: Moving this function into the header may cause performance regression.
46 template <class Size_T>
47 void SmallVectorBase<Size_T>::grow_pod(void *FirstEl, size_t MinSize,
48                                        size_t TSize) {
49   // Ensure we can fit the new capacity.
50   // This is only going to be applicable when the capacity is 32 bit.
51   if (MinSize > SizeTypeMax()) {
52     std::string Reason = "SmallVector unable to grow. Requested capacity (" +
53                          std::to_string(MinSize) +
54                          ") is larger than maximum value for size type (" +
55                          std::to_string(SizeTypeMax()) + ")";
56 #ifdef LLVM_ENABLE_EXCEPTIONS
57     throw std::length_error(Reason);
58 #else
59     report_fatal_error(Reason);
60 #endif
61   }
62 
63   // Ensure we can meet the guarantee of space for at least one more element.
64   // The above check alone will not catch the case where grow is called with a
65   // default MinSize of 0, but the current capacity cannot be increased.
66   // This is only going to be applicable when the capacity is 32 bit.
67   if (capacity() == SizeTypeMax()) {
68     std::string Reason =
69         "SmallVector capacity unable to grow. Already at maximum size " +
70         std::to_string(SizeTypeMax());
71 #ifdef LLVM_ENABLE_EXCEPTIONS
72     throw std::length_error(Reason);
73 #endif
74     report_fatal_error(Reason);
75   }
76 
77   // In theory 2*capacity can overflow if the capacity is 64 bit, but the
78   // original capacity would never be large enough for this to be a problem.
79   size_t NewCapacity = 2 * capacity() + 1; // Always grow.
80   NewCapacity = std::min(std::max(NewCapacity, MinSize), SizeTypeMax());
81 
82   void *NewElts;
83   if (BeginX == FirstEl) {
84     NewElts = safe_malloc(NewCapacity * TSize);
85 
86     // Copy the elements over.  No need to run dtors on PODs.
87     memcpy(NewElts, this->BeginX, size() * TSize);
88   } else {
89     // If this wasn't grown from the inline copy, grow the allocated space.
90     NewElts = safe_realloc(this->BeginX, NewCapacity * TSize);
91   }
92 
93   this->BeginX = NewElts;
94   this->Capacity = NewCapacity;
95 }
96 
97 template class llvm::SmallVectorBase<uint32_t>;
98 
99 // Disable the uint64_t instantiation for 32-bit builds.
100 // Both uint32_t and uint64_t instantations are needed for 64-bit builds.
101 // This instantiation will never be used in 32-bit builds, and will cause
102 // warnings when sizeof(Size_T) > sizeof(size_t).
103 #if SIZE_MAX > UINT32_MAX
104 template class llvm::SmallVectorBase<uint64_t>;
105 
106 // Assertions to ensure this #if stays in sync with SmallVectorSizeType.
107 static_assert(sizeof(SmallVectorSizeType<char>) == sizeof(uint64_t),
108               "Expected SmallVectorBase<uint64_t> variant to be in use.");
109 #else
110 static_assert(sizeof(SmallVectorSizeType<char>) == sizeof(uint32_t),
111               "Expected SmallVectorBase<uint32_t> variant to be in use.");
112 #endif
113