Skip to content

Commit

Permalink
[Support] Recycler: Enforce minimum allocation size
Browse files Browse the repository at this point in the history
Recycler uses reinterpret_cast to an internal structure of size 8.
Invalid write occurs if Recycler is used for objects with sizes less
than 8.
  • Loading branch information
optimisan committed Jan 1, 2025
1 parent 686d1cd commit ac8a44c
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 0 deletions.
2 changes: 2 additions & 0 deletions llvm/include/llvm/Support/Recycler.h
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ class Recycler {
"Recycler allocation alignment is less than object align!");
static_assert(sizeof(SubClass) <= Size,
"Recycler allocation size is less than object size!");
static_assert(Size >= sizeof(FreeNode) &&
"Recycler size must be atleast 8");
return FreeList ? reinterpret_cast<SubClass *>(pop_val())
: static_cast<SubClass *>(Allocator.Allocate(Size, Align));
}
Expand Down
1 change: 1 addition & 0 deletions llvm/unittests/Support/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ add_llvm_unittest(SupportTests
PerThreadBumpPtrAllocatorTest.cpp
ProcessTest.cpp
ProgramTest.cpp
RecyclerTest.cpp
RegexTest.cpp
ReverseIterationTest.cpp
ReplaceFileTest.cpp
Expand Down
46 changes: 46 additions & 0 deletions llvm/unittests/Support/RecyclerTest.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
//===--- unittest/Support/RecyclerTest.cpp --------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

#include "llvm/Support/Recycler.h"
#include "llvm/Support/AllocatorBase.h"
#include "gtest/gtest.h"

using namespace llvm;

namespace {

struct Object1 {
char Data[1];
};

class DecoratedMallocAllocator : public MallocAllocator {
public:
int DeallocCount = 0;

template <typename T> void Deallocate(T *Ptr) {
DeallocCount++;
MallocAllocator::Deallocate(Ptr);
}
};

TEST(RecyclerTest, RecycleAllocation) {
DecoratedMallocAllocator Allocator;
// Recycler needs size to be atleast 8 bytes.
Recycler<Object1, 8, 8> R;
Object1 *A1 = R.Allocate(Allocator);
Object1 *A2 = R.Allocate(Allocator);
R.Deallocate(Allocator, A2);
Object1 *A3 = R.Allocate(Allocator);
EXPECT_EQ(A2, A3); // reuse the deallocated object.
R.Deallocate(Allocator, A1);
R.Deallocate(Allocator, A3);
R.clear(Allocator); // Should deallocate A1 and A3.
EXPECT_EQ(Allocator.DeallocCount, 2);
}

} // end anonymous namespace

0 comments on commit ac8a44c

Please sign in to comment.