Files
llvm-project/llvm/unittests/ExecutionEngine/Orc/ExecutorAddressTest.cpp
Lang Hames f14cb494a3 [ORC] Add "wrap" and "unwrap" steps to ExecutorAddr toPtr/fromPtr.
The wrap/unwrap operations are applied to pointers after/before conversion to/from
raw addresses. They can be used to tag, untag, sign, or strip signing from
pointers. They currently default to 'rawPtr' (identity) on all platforms, but it
is expected that the default will be set based on the host architecture, e.g.
they would default to signing/stripping for arm64e.
2022-08-26 12:32:44 -07:00

106 lines
2.7 KiB
C++

//===--------- ExecutorAddrTest.cpp - Unit tests for ExecutorAddr ---------===//
//
// 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/ExecutionEngine/Orc/Shared/ExecutorAddress.h"
#include "OrcTestCommon.h"
using namespace llvm;
using namespace llvm::orc;
namespace {
TEST(ExecutorAddrTest, DefaultAndNull) {
// Check that default constructed values and isNull behave as expected.
ExecutorAddr Default;
ExecutorAddr Null(0);
ExecutorAddr NonNull(1);
EXPECT_TRUE(Null.isNull());
EXPECT_EQ(Default, Null);
EXPECT_FALSE(NonNull.isNull());
EXPECT_NE(Default, NonNull);
}
TEST(ExecutorAddrTest, Ordering) {
// Check that ordering operations.
ExecutorAddr A1(1), A2(2);
EXPECT_LE(A1, A1);
EXPECT_LT(A1, A2);
EXPECT_GT(A2, A1);
EXPECT_GE(A2, A2);
}
TEST(ExecutorAddrTest, PtrConversion) {
// Test toPtr / fromPtr round-tripping.
int X = 0;
auto XAddr = ExecutorAddr::fromPtr(&X);
int *XPtr = XAddr.toPtr<int *>();
EXPECT_EQ(XPtr, &X);
}
static void F() {}
TEST(ExecutorAddrTest, PtrConversionWithFunctionType) {
// Test that function types (as opposed to function pointer types) can be
// used with toPtr.
auto FAddr = ExecutorAddr::fromPtr(F);
void (*FPtr)() = FAddr.toPtr<void()>();
EXPECT_EQ(FPtr, &F);
}
TEST(ExecutorAddrTest, WrappingAndUnwrapping) {
constexpr uintptr_t RawAddr = 0x123456;
int *RawPtr = (int *)RawAddr;
constexpr uintptr_t TagOffset = 8 * (sizeof(uintptr_t) - 1);
uintptr_t TagVal = 0xA5;
uintptr_t TagBits = TagVal << TagOffset;
void *TaggedPtr = (void *)((uintptr_t)RawPtr | TagBits);
ExecutorAddr EA =
ExecutorAddr::fromPtr(TaggedPtr, ExecutorAddr::Untag(8, TagOffset));
EXPECT_EQ(EA.getValue(), RawAddr);
void *ReconstitutedTaggedPtr =
EA.toPtr<void *>(ExecutorAddr::Tag(TagVal, TagOffset));
EXPECT_EQ(TaggedPtr, ReconstitutedTaggedPtr);
}
TEST(ExecutorAddrTest, AddrRanges) {
ExecutorAddr A0(0), A1(1), A2(2), A3(3);
ExecutorAddrRange R0(A0, A1), R1(A1, A2), R2(A2, A3), R3(A0, A2), R4(A1, A3);
// 012
// R0: # -- Before R1
// R1: # --
// R2: # -- After R1
// R3: ## -- Overlaps R1 start
// R4: ## -- Overlaps R1 end
EXPECT_EQ(R1, ExecutorAddrRange(A1, A2));
EXPECT_EQ(R1, ExecutorAddrRange(A1, ExecutorAddrDiff(1)));
EXPECT_NE(R1, R2);
EXPECT_TRUE(R1.contains(A1));
EXPECT_FALSE(R1.contains(A0));
EXPECT_FALSE(R1.contains(A2));
EXPECT_FALSE(R1.overlaps(R0));
EXPECT_FALSE(R1.overlaps(R2));
EXPECT_TRUE(R1.overlaps(R3));
EXPECT_TRUE(R1.overlaps(R4));
}
} // namespace