SmallVector.cpp 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  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. #include "llvm/ADT/SmallVector.h"
  13. #include "llvm/ADT/Twine.h"
  14. #include "llvm/Support/MemAlloc.h"
  15. #include <cstdint>
  16. #ifdef LLVM_ENABLE_EXCEPTIONS
  17. #include <stdexcept>
  18. #endif
  19. using namespace llvm;
  20. // Check that no bytes are wasted and everything is well-aligned.
  21. namespace {
  22. // These structures may cause binary compat warnings on AIX. Suppress the
  23. // warning since we are only using these types for the static assertions below.
  24. #if defined(_AIX)
  25. #pragma GCC diagnostic push
  26. #pragma GCC diagnostic ignored "-Waix-compat"
  27. #endif
  28. struct Struct16B {
  29. alignas(16) void *X;
  30. };
  31. struct Struct32B {
  32. alignas(32) void *X;
  33. };
  34. #if defined(_AIX)
  35. #pragma GCC diagnostic pop
  36. #endif
  37. }
  38. static_assert(sizeof(SmallVector<void *, 0>) ==
  39. sizeof(unsigned) * 2 + sizeof(void *),
  40. "wasted space in SmallVector size 0");
  41. static_assert(alignof(SmallVector<Struct16B, 0>) >= alignof(Struct16B),
  42. "wrong alignment for 16-byte aligned T");
  43. static_assert(alignof(SmallVector<Struct32B, 0>) >= alignof(Struct32B),
  44. "wrong alignment for 32-byte aligned T");
  45. static_assert(sizeof(SmallVector<Struct16B, 0>) >= alignof(Struct16B),
  46. "missing padding for 16-byte aligned T");
  47. static_assert(sizeof(SmallVector<Struct32B, 0>) >= alignof(Struct32B),
  48. "missing padding for 32-byte aligned T");
  49. static_assert(sizeof(SmallVector<void *, 1>) ==
  50. sizeof(unsigned) * 2 + sizeof(void *) * 2,
  51. "wasted space in SmallVector size 1");
  52. static_assert(sizeof(SmallVector<char, 0>) ==
  53. sizeof(void *) * 2 + sizeof(void *),
  54. "1 byte elements have word-sized type for size and capacity");
  55. /// Report that MinSize doesn't fit into this vector's size type. Throws
  56. /// std::length_error or calls report_fatal_error.
  57. [[noreturn]] static void report_size_overflow(size_t MinSize, size_t MaxSize);
  58. static void report_size_overflow(size_t MinSize, size_t MaxSize) {
  59. std::string Reason = "SmallVector unable to grow. Requested capacity (" +
  60. std::to_string(MinSize) +
  61. ") is larger than maximum value for size type (" +
  62. std::to_string(MaxSize) + ")";
  63. #ifdef LLVM_ENABLE_EXCEPTIONS
  64. throw std::length_error(Reason);
  65. #else
  66. report_fatal_error(Twine(Reason));
  67. #endif
  68. }
  69. /// Report that this vector is already at maximum capacity. Throws
  70. /// std::length_error or calls report_fatal_error.
  71. [[noreturn]] static void report_at_maximum_capacity(size_t MaxSize);
  72. static void report_at_maximum_capacity(size_t MaxSize) {
  73. std::string Reason =
  74. "SmallVector capacity unable to grow. Already at maximum size " +
  75. std::to_string(MaxSize);
  76. #ifdef LLVM_ENABLE_EXCEPTIONS
  77. throw std::length_error(Reason);
  78. #else
  79. report_fatal_error(Twine(Reason));
  80. #endif
  81. }
  82. // Note: Moving this function into the header may cause performance regression.
  83. template <class Size_T>
  84. static size_t getNewCapacity(size_t MinSize, size_t TSize, size_t OldCapacity) {
  85. constexpr size_t MaxSize = std::numeric_limits<Size_T>::max();
  86. // Ensure we can fit the new capacity.
  87. // This is only going to be applicable when the capacity is 32 bit.
  88. if (MinSize > MaxSize)
  89. report_size_overflow(MinSize, MaxSize);
  90. // Ensure we can meet the guarantee of space for at least one more element.
  91. // The above check alone will not catch the case where grow is called with a
  92. // default MinSize of 0, but the current capacity cannot be increased.
  93. // This is only going to be applicable when the capacity is 32 bit.
  94. if (OldCapacity == MaxSize)
  95. report_at_maximum_capacity(MaxSize);
  96. // In theory 2*capacity can overflow if the capacity is 64 bit, but the
  97. // original capacity would never be large enough for this to be a problem.
  98. size_t NewCapacity = 2 * OldCapacity + 1; // Always grow.
  99. return std::min(std::max(NewCapacity, MinSize), MaxSize);
  100. }
  101. // Note: Moving this function into the header may cause performance regression.
  102. template <class Size_T>
  103. void *SmallVectorBase<Size_T>::mallocForGrow(size_t MinSize, size_t TSize,
  104. size_t &NewCapacity) {
  105. NewCapacity = getNewCapacity<Size_T>(MinSize, TSize, this->capacity());
  106. return llvm::safe_malloc(NewCapacity * TSize);
  107. }
  108. // Note: Moving this function into the header may cause performance regression.
  109. template <class Size_T>
  110. void SmallVectorBase<Size_T>::grow_pod(void *FirstEl, size_t MinSize,
  111. size_t TSize) {
  112. size_t NewCapacity = getNewCapacity<Size_T>(MinSize, TSize, this->capacity());
  113. void *NewElts;
  114. if (BeginX == FirstEl) {
  115. NewElts = safe_malloc(NewCapacity * TSize);
  116. // Copy the elements over. No need to run dtors on PODs.
  117. memcpy(NewElts, this->BeginX, size() * TSize);
  118. } else {
  119. // If this wasn't grown from the inline copy, grow the allocated space.
  120. NewElts = safe_realloc(this->BeginX, NewCapacity * TSize);
  121. }
  122. this->BeginX = NewElts;
  123. this->Capacity = NewCapacity;
  124. }
  125. template class llvm::SmallVectorBase<uint32_t>;
  126. // Disable the uint64_t instantiation for 32-bit builds.
  127. // Both uint32_t and uint64_t instantiations are needed for 64-bit builds.
  128. // This instantiation will never be used in 32-bit builds, and will cause
  129. // warnings when sizeof(Size_T) > sizeof(size_t).
  130. #if SIZE_MAX > UINT32_MAX
  131. template class llvm::SmallVectorBase<uint64_t>;
  132. // Assertions to ensure this #if stays in sync with SmallVectorSizeType.
  133. static_assert(sizeof(SmallVectorSizeType<char>) == sizeof(uint64_t),
  134. "Expected SmallVectorBase<uint64_t> variant to be in use.");
  135. #else
  136. static_assert(sizeof(SmallVectorSizeType<char>) == sizeof(uint32_t),
  137. "Expected SmallVectorBase<uint32_t> variant to be in use.");
  138. #endif