[llvm] Introduce paged vector (PR #66430)
Vassil Vassilev via llvm-commits
llvm-commits at lists.llvm.org
Fri Sep 29 02:30:19 PDT 2023
================
@@ -0,0 +1,267 @@
+//===- llvm/ADT/PagedVector.h - 'Lazyly allocated' vectors --------*- C++
+//-*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines the PagedVector class.
+//
+//===----------------------------------------------------------------------===//
+#ifndef LLVM_ADT_PAGEDVECTOR_H
+#define LLVM_ADT_PAGEDVECTOR_H
+
+#include "llvm/ADT/PointerIntPair.h"
+#include "llvm/ADT/SmallVector.h"
+#include "llvm/ADT/iterator_range.h"
+#include "llvm/Support/Allocator.h"
+#include <cassert>
+#include <vector>
+
+namespace llvm {
+/// A vector that allocates memory in pages.
+///
+/// Order is kept, but memory is allocated only when one element of the page is
+/// accessed. This introduces a level of indirection, but it is useful when you
+/// have a sparsely initialised vector where the full size is allocated upfront.
+///
+/// As a side effect the elements are initialised later than in a normal vector.
+/// On the first access to one of the elements of a given page, all the elements
+/// of the page are initialised. This also means that the elements of the page
+/// are initialised beyond the size of the vector.
+///
+/// Similarly on destruction the elements are destroyed only when the page is
+/// not needed anymore, delaying invoking the destructor of the elements.
+///
+/// Notice that this has iterators only on materialized elements. This
+/// is deliberately done under the assumption you would dereference the elements
+/// while iterating, therefore materialising them and losing the gains in terms
+/// of memory usage this container provides. If you have such a use case, you
+/// probably want to use a normal std::vector or a llvm::SmallVector.
+template <typename T, size_t PageSize = 1024 / sizeof(T)> class PagedVector {
+ static_assert(PageSize > 1, "PageSize must be greater than 0. Most likely "
+ "you want it to be greater than 16.");
+ /// The actual number of elements in the vector which can be accessed.
+ size_t Size = 0;
+
+ /// The position of the initial element of the page in the Data vector.
+ /// Pages are allocated contiguously in the Data vector.
+ mutable SmallVector<T *, 0> PageToDataPtrs;
+ /// Actual page data. All the page elements are allocated on the
+ /// first access of any of the elements of the page. Elements are default
+ /// constructed and elements of the page are stored contiguously.
+ PointerIntPair<BumpPtrAllocator *, 1, bool> Allocator;
+
+public:
+ using value_type = T;
+
+ /// Default constructor. We build our own allocator and mark it as such with
+ /// `true` in the second pair element.
+ PagedVector() : Allocator(new BumpPtrAllocator, true) {}
+ explicit PagedVector(BumpPtrAllocator *A) : Allocator(A, false) {
+ assert(A != nullptr && "Allocator cannot be nullptr");
----------------
vgvassilev wrote:
```suggestion
assert(!A && "Allocator cannot be nullptr");
```
https://github.com/llvm/llvm-project/pull/66430
More information about the llvm-commits
mailing list