Skip to content

[Support] Recycler: Enforce minimum allocation size #121425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 at least sizeof(FreeNode)");
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);
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to test the static_assert fails in the < 8 case?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't think we have any infrastructure in LLVM for "this should fail to compile". If it were SFINAE'd then we could static_assert that something fails to compile, but static_asserts aren't themselves SFINAE, so it'd mean adding more metaprogramming infrastructure that's presumably not otherwise needed (& wouldn't test the static_assert itself, but the SFINAE trap)

} // end anonymous namespace
Loading