jdk-24/test/hotspot/gtest/utilities/test_linkedlist.cpp

/*
 * Copyright (c) 2011, 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 "utilities/linkedlist.hpp"

class Integer : public StackObj {
 private:
  int _value;
 public:

  Integer(int i) : _value(i) {
  }

  int value() const {
    return _value;
  }

  bool equals(const Integer& i) const {
    return _value == i.value();
  }

  static int compare(const Integer& i1, const Integer& i2) {
    return i1.value() - i2.value();
  }
};

static void check_list_values(const int* expected, const LinkedList<Integer>* list) {
  LinkedListNode<Integer>* head = list->head();
  int index = 0;
  while (head != nullptr) {
    ASSERT_EQ(expected[index], head->peek()->value())
            << "Unexpected value at index " << index;
    head = head->next();
    index++;
  }
}

const Integer one(1), two(2), three(3), four(4), five(5), six(6), notfound(404);

// Test regular linked list
TEST(LinkedList, simple) {
  LinkedListImpl<Integer, AnyObj::C_HEAP, mtTest> ll;

  ASSERT_TRUE(ll.is_empty()) << "Start with empty list";

  ll.add(six);
  ASSERT_TRUE(!ll.is_empty()) << "Should not be empty";

  Integer* i = ll.find(six);
  ASSERT_TRUE(i != nullptr) << "Should find it";
  ASSERT_EQ(six.value(), i->value()) << "Should be 6";

  i = ll.find(three);
  ASSERT_TRUE(i == nullptr) << "Not in the list";

  LinkedListNode<Integer>* node = ll.find_node(six);
  ASSERT_TRUE(node != nullptr) << "6 is in the list";

  ll.insert_after(three, node);
  ll.insert_before(one, node);
  int expected[3] = {1, 6, 3};
  check_list_values(expected, &ll);
}

TEST(LinkedList, generic) {
  LinkedListImpl<int> il;
  const int N = 100;
  for (int i=0; i<N; ++i) {
    il.add(i);
  }
  EXPECT_EQ(il.size(), (size_t)N);

  const LinkedListIterator<int> cit(il.head());
  for (int i=N-1; i>=0; --i) {
    const int* e = cit.next();
    EXPECT_EQ(*e, i);
  }
  EXPECT_TRUE(cit.is_empty());
  EXPECT_EQ(il.size(), (size_t)N);
  EXPECT_EQ(*(il.head()->peek()), N-1);

  typedef LinkedListImpl<Integer, AnyObj::C_HEAP, mtTest> list_t;
  LinkedList<Integer>* list = new (mtTest) list_t();
  list->add(Integer(1));
  list->add(Integer(2));
  EXPECT_EQ(list->size(), (size_t)2);
  list->~LinkedList<Integer>();
  EXPECT_EQ(list->size(), (size_t)0);

  // copyable
  //list_t a;
  //a.add(Integer(1));
  //list_t b(a);
  //EXPECT_EQ(b.size(), (size_t)1);
  //EXPECT_TRUE(b.head()->peek()->equals(Integer(1)));

  list_t lifo, dummy;
  const Integer* e;
  lifo.add(one);
  lifo.add(two);
  LinkedListIterator<Integer> it(lifo.head());

  EXPECT_FALSE(it.is_empty());
  // pop 2
  e = it.next();
  EXPECT_TRUE(e->equals(two));
  EXPECT_FALSE(it.is_empty());
  // pop 1
  e = it.next();
  EXPECT_TRUE(e->equals(one));
  //empty
  EXPECT_TRUE(it.is_empty());

  LinkedListIterator<Integer> it2(dummy.head());
  EXPECT_TRUE(it2.is_empty());
  EXPECT_EQ(it2.next(), (Integer* )nullptr);
}

TEST(LinkedList, algorithm) {
  LinkedListImpl<int> il;
  il.add(1);
  il.add(2);
  il.add(3);
  EXPECT_EQ(*il.find(1), 1);
  EXPECT_EQ(il.find(404), (int* )nullptr);
  EXPECT_TRUE(il.remove(1));
  EXPECT_FALSE(il.remove(404));

  LinkedListImpl<Integer, AnyObj::C_HEAP, mtTest> ll;
  ll.add(one);

  EXPECT_TRUE(ll.find(one));
  EXPECT_FALSE(ll.find(notfound));

  EXPECT_TRUE(ll.remove(one));
  EXPECT_FALSE(ll.find(one));
  EXPECT_FALSE(ll.remove(notfound));
  EXPECT_FALSE(ll.find(notfound));
}

// Test sorted linked list
TEST(SortedLinkedList, simple) {
  LinkedListImpl<Integer, AnyObj::C_HEAP, mtTest> ll;
  ll.add(one);
  ll.add(six);
  ll.add(three);
  ll.add(two);
  ll.add(four);
  ll.add(five);

  SortedLinkedList<Integer, Integer::compare, AnyObj::C_HEAP, mtTest> sl;
  ASSERT_TRUE(sl.is_empty()) << "Start with empty list";

  size_t ll_size = ll.size();
  sl.move(&ll);
  size_t sl_size = sl.size();

  ASSERT_EQ(ll_size, sl_size) << "Should be the same size";
  ASSERT_TRUE(ll.is_empty()) << "No more entries";

  // sorted result
  int sorted_result[] = {1, 2, 3, 4, 5, 6};
  check_list_values(sorted_result, &sl);
  if (HasFatalFailure()) {
    return;
  }

  LinkedListNode<Integer>* node = sl.find_node(four);
  ASSERT_TRUE(node != nullptr) << "4 is in the list";
  sl.remove_before(node);
  sl.remove_after(node);
  int remains[] = {1, 2, 4, 6};
  check_list_values(remains, &sl);
}