jdk-24/test/hotspot/gtest/nmt/test_arrayWithFreeList.cpp
Gerard Ziemski eabfc6e4d9 8337563: NMT: rename MEMFLAGS to MemTag
Reviewed-by: dholmes, coleenp, jsjolen
2024-09-17 19:59:06 +00:00

154 lines
4.1 KiB
C++

/*
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
#include "precompiled.hpp"
#include "unittest.hpp"
#include "nmt/arrayWithFreeList.hpp"
using A = ArrayWithFreeList<int, mtTest>;
class ArrayWithFreeListTest : public testing::Test {
};
// A linked list which sets the allocator itself
template<typename E>
struct LL {
struct Node;
using NodeAllocator = ArrayWithFreeList<Node, mtTest>;
using NodePtr = typename NodeAllocator::I;
NodeAllocator alloc;
struct Node {
E e;
NodePtr next;
};
NodePtr start;
LL()
: start{NodeAllocator::nil} {
}
void push(E e) {
NodePtr new_element = alloc.allocate(e, NodeAllocator::nil);
NodePtr& current = start;
if (current == NodeAllocator::nil) {
current = new_element;
return;
}
alloc.at(new_element).next = current;
current = new_element;
};
E pop() {
assert(start != NodeAllocator::nil, "must be");
Node& n = alloc.at(start);
E e = n.e;
NodePtr next_start = n.next;
alloc.deallocate(start);
start = next_start;
return e;
}
};
// A linked list which is capable of having multiple different allocators. This is done through higher-kinded types.
// That's a very fancy word that means that a templated type like Foo<E> can be passed around like only Foo at first
// and then be 'applied' to some E. Think of it like passing around a lambda or function pointer, but on a template level,
// where Foo is a function that can be called on some type with the return type being Foo<E>.
template<typename E, template<typename, MemTag> class Allocator>
struct LL2 {
struct Node;
using NodeAllocator = Allocator<Node, mtTest>;
using NodePtr = typename NodeAllocator::I;
NodeAllocator alloc;
struct Node {
E e;
NodePtr next;
};
NodePtr start;
LL2()
: start(NodeAllocator::nil) {
}
void push(E e) {
NodePtr new_element = alloc.allocate(e, NodeAllocator::nil);
NodePtr& current = start;
if (current == NodeAllocator::nil) {
current = new_element;
return;
}
alloc.at(new_element).next = current;
current = new_element;
};
E pop() {
assert(start != NodeAllocator::nil, "must be");
Node& n = alloc.at(start);
E e = n.e;
NodePtr next_start = n.next;
alloc.deallocate(start);
start = next_start;
return e;
}
};
template<typename List>
void test_with_list(List& list) {
list.push(1);
list.push(2);
EXPECT_EQ(2, list.pop());
EXPECT_EQ(1, list.pop());
}
TEST_VM_F(ArrayWithFreeListTest, TestLinkedLists) {
{
LL<int> list;
test_with_list(list);
}
{
LL2<int, ArrayWithFreeList> list;
test_with_list(list);
}
}
TEST_VM_F(ArrayWithFreeListTest, FreeingShouldReuseMemory) {
A alloc;
A::I i = alloc.allocate(1);
int* x = &alloc.at(i);
alloc.deallocate(i);
i = alloc.allocate(1);
int* y = &alloc.at(i);
EXPECT_EQ(x, y);
}
TEST_VM_F(ArrayWithFreeListTest, FreeingInTheMiddleWorks) {
A alloc;
A::I i0 = alloc.allocate(0);
A::I i1 = alloc.allocate(0);
A::I i2 = alloc.allocate(0);
int* p1 = &alloc.at(i1);
alloc.deallocate(i1);
A::I i3 = alloc.allocate(0);
EXPECT_EQ(p1, &alloc.at(i3));
}