1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2025-01-31 12:41:49 +01:00
llvm-mirror/unittests/ADT/IListSentinelTest.cpp
Duncan P. N. Exon Smith 2a55cf5af8 ADT: Add sentinel tracking and custom tags to ilists
This adds two declarative configuration options for intrusive lists
(available for simple_ilist, iplist, and ilist).  Both of these options
affect ilist_node interoperability and need to be passed both to the
node and the list.  Instead of adding a new traits class, they're
specified as optional template parameters (in any order).

The two options:

 1. Pass ilist_sentinel_tracking<true> or ilist_sentinel_tracking<false>
    to control whether there's a bit on ilist_node "prev" pointer
    indicating whether it's the sentinel.  The default behaviour is to
    use a bit if and only if LLVM_ENABLE_ABI_BREAKING_CHECKS.

 2. Pass ilist_tag<TagA> and ilist_tag<TagB> to allow insertion of a
    single node into two different lists (simultaneously).

I have an immediate use-case for (1) ilist_sentinel_tracking: fixing the
validation semantics of MachineBasicBlock::reverse_iterator to match
ilist::reverse_iterator (ala r280032: see the comments at the end of the
commit message there).  I'm adding (2) ilist_tag in the same commit to
validate that the options framework supports expansion.  Justin Bogner
mentioned this might enable a possible cleanup in SelectionDAG, but I'll
leave this to others to explore.  In the meantime, the unit tests and
the comments for simple_ilist and ilist_node have usage examples.

Note that there's a layer of indirection to support optional,
out-of-order, template paramaters.  Internal classes are templated on an
instantiation of the non-variadic ilist_detail::node_options.
User-facing classes use ilist_detail::compute_node_options to compute
the correct instantiation of ilist_detail::node_options.

The comments for ilist_detail::is_valid_option describe how to add new
options (e.g., ilist_packed_int<int NumBits>).

llvm-svn: 281167
2016-09-11 16:20:53 +00:00

64 lines
1.7 KiB
C++

//===- unittests/ADT/IListSentinelTest.cpp - ilist_sentinel unit tests ----===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "llvm/ADT/ilist_node.h"
#include "gtest/gtest.h"
using namespace llvm;
namespace {
template <class T, class... Options> struct PickSentinel {
typedef ilist_sentinel<
typename ilist_detail::compute_node_options<T, Options...>::type>
type;
};
class Node : public ilist_node<Node> {};
class TrackingNode : public ilist_node<Node, ilist_sentinel_tracking<true>> {};
typedef PickSentinel<Node>::type Sentinel;
typedef PickSentinel<Node, ilist_sentinel_tracking<true>>::type
TrackingSentinel;
typedef PickSentinel<Node, ilist_sentinel_tracking<false>>::type
NoTrackingSentinel;
struct LocalAccess : ilist_detail::NodeAccess {
using NodeAccess::getPrev;
using NodeAccess::getNext;
};
TEST(IListSentinelTest, DefaultConstructor) {
Sentinel S;
EXPECT_EQ(&S, LocalAccess::getPrev(S));
EXPECT_EQ(&S, LocalAccess::getNext(S));
#ifdef LLVM_ENABLE_ABI_BREAKING_CHECKS
EXPECT_TRUE(S.isKnownSentinel());
#else
EXPECT_FALSE(S.isKnownSentinel());
#endif
TrackingSentinel TS;
NoTrackingSentinel NTS;
EXPECT_TRUE(TS.isSentinel());
EXPECT_TRUE(TS.isKnownSentinel());
EXPECT_FALSE(NTS.isKnownSentinel());
}
TEST(IListSentinelTest, NormalNodeIsNotKnownSentinel) {
Node N;
EXPECT_EQ(nullptr, LocalAccess::getPrev(N));
EXPECT_EQ(nullptr, LocalAccess::getNext(N));
EXPECT_FALSE(N.isKnownSentinel());
TrackingNode TN;
EXPECT_FALSE(TN.isSentinel());
}
} // end namespace