Files
llvm-project/llvm/unittests/Transforms/Utils/CodeExtractorTest.cpp
Sergio Afonso b5c755144d [OMPIRBuilder] Add support for explicit deallocation points (#154752)
In this patch, some OMPIRBuilder codegen functions and callbacks are
updated to work with arrays of deallocation insertion points. The
purpose of this is to enable the replacement of `alloca`s with other
types of allocations that require explicit deallocations in a way that
makes it possible for `CodeExtractor` instances created during
OMPIRBuilder finalization to also use them.

The OpenMP to LLVM IR MLIR translation pass is updated to properly store
and forward deallocation points together with their matching allocation
point to the OMPIRBuilder.

Currently, only the `DeviceSharedMemCodeExtractor` uses this feature to
get the `CodeExtractor` to use device shared memory for intermediate
allocations when outlining a parallel region inside of a Generic kernel
(code path that is only used by Flang via MLIR, currently). However,
long term this might also be useful to refactor finalization of
variables with destructors, potentially reducing the use of callbacks
and simplifying privatization and reductions.

Instead of a single deallocation point, lists of those are used. This is
to cover cases where there are multiple exit blocks originating from a
single entry. If an allocation needing explicit deallocation is placed
in the entry block of such cases, it would need to be deallocated before
each of the exits.
2026-04-27 13:12:07 +01:00

887 lines
29 KiB
C++

//===- CodeExtractor.cpp - Unit tests for CodeExtractor -------------------===//
//
// 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/Transforms/Utils/CodeExtractor.h"
#include "llvm/Analysis/AssumptionCache.h"
#include "llvm/AsmParser/Parser.h"
#include "llvm/IR/BasicBlock.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/DebugInfoMetadata.h"
#include "llvm/IR/Dominators.h"
#include "llvm/IR/InstIterator.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Verifier.h"
#include "llvm/IRReader/IRReader.h"
#include "llvm/Support/SourceMgr.h"
#include "gtest/gtest.h"
using namespace llvm;
namespace {
BasicBlock *getBlockByName(Function *F, StringRef name) {
for (auto &BB : *F)
if (BB.getName() == name)
return &BB;
return nullptr;
}
Instruction *getInstByName(Function *F, StringRef Name) {
for (Instruction &I : instructions(F))
if (I.getName() == Name)
return &I;
return nullptr;
}
TEST(CodeExtractor, ExitStub) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"invalid(
define i32 @foo(i32 %x, i32 %y, i32 %z) {
header:
%0 = icmp ugt i32 %x, %y
br i1 %0, label %body1, label %body2
body1:
%1 = add i32 %z, 2
br label %notExtracted
body2:
%2 = mul i32 %z, 7
br label %notExtracted
notExtracted:
%3 = phi i32 [ %1, %body1 ], [ %2, %body2 ]
%4 = add i32 %3, %x
ret i32 %4
}
)invalid",
Err, Ctx));
Function *Func = M->getFunction("foo");
SmallVector<BasicBlock *, 3> Candidates{ getBlockByName(Func, "header"),
getBlockByName(Func, "body1"),
getBlockByName(Func, "body2") };
CodeExtractor CE(Candidates);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
Function *Outlined = CE.extractCodeRegion(CEAC);
EXPECT_TRUE(Outlined);
BasicBlock *Exit = getBlockByName(Func, "notExtracted");
BasicBlock *ExitSplit = getBlockByName(Outlined, "notExtracted.split");
// Ensure that PHI in exit block has only one incoming value (from code
// replacer block).
EXPECT_TRUE(Exit && cast<PHINode>(Exit->front()).getNumIncomingValues() == 1);
// Ensure that there is a PHI in outlined function with 2 incoming values.
EXPECT_TRUE(ExitSplit &&
cast<PHINode>(ExitSplit->front()).getNumIncomingValues() == 2);
EXPECT_FALSE(verifyFunction(*Outlined));
EXPECT_FALSE(verifyFunction(*Func));
}
TEST(CodeExtractor, InputOutputMonitoring) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"invalid(
define i32 @foo(i32 %x, i32 %y, i32 %z) {
header:
%0 = icmp ugt i32 %x, %y
br i1 %0, label %body1, label %body2
body1:
%1 = add i32 %z, 2
br label %notExtracted
body2:
%2 = mul i32 %z, 7
br label %notExtracted
notExtracted:
%3 = phi i32 [ %1, %body1 ], [ %2, %body2 ]
%4 = add i32 %3, %x
ret i32 %4
}
)invalid",
Err, Ctx));
Function *Func = M->getFunction("foo");
SmallVector<BasicBlock *, 3> Candidates{getBlockByName(Func, "header"),
getBlockByName(Func, "body1"),
getBlockByName(Func, "body2")};
CodeExtractor CE(Candidates);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
SetVector<Value *> Inputs, Outputs;
Function *Outlined = CE.extractCodeRegion(CEAC, Inputs, Outputs);
EXPECT_TRUE(Outlined);
EXPECT_EQ(Inputs.size(), 3u);
EXPECT_EQ(Inputs[0], Func->getArg(2));
EXPECT_EQ(Inputs[1], Func->getArg(0));
EXPECT_EQ(Inputs[2], Func->getArg(1));
EXPECT_EQ(Outputs.size(), 1u);
StoreInst *SI = cast<StoreInst>(Outlined->getArg(3)->user_back());
Value *OutputVal = SI->getValueOperand();
EXPECT_EQ(Outputs[0], OutputVal);
BasicBlock *Exit = getBlockByName(Func, "notExtracted");
BasicBlock *ExitSplit = getBlockByName(Outlined, "notExtracted.split");
// Ensure that PHI in exit block has only one incoming value (from code
// replacer block).
EXPECT_TRUE(Exit && cast<PHINode>(Exit->front()).getNumIncomingValues() == 1);
// Ensure that there is a PHI in outlined function with 2 incoming values.
EXPECT_TRUE(ExitSplit &&
cast<PHINode>(ExitSplit->front()).getNumIncomingValues() == 2);
EXPECT_FALSE(verifyFunction(*Outlined));
EXPECT_FALSE(verifyFunction(*Func));
}
TEST(CodeExtractor, InputOutputReturnMonitoring) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"invalid(
define i32 @foo(i32 %x, i32 %y, i32 %z) {
header:
%0 = icmp ugt i32 %x, %y
br i1 %0, label %body1, label %body2
body1:
%1 = add i32 %z, 2
br label %notExtracted
body2:
%2 = mul i32 %z, 7
br label %notExtracted
notExtracted:
%3 = phi i32 [ %1, %body1 ], [ %2, %body2 ]
%4 = add i32 %3, %x
ret i32 %4
}
)invalid",
Err, Ctx));
Function *Func = M->getFunction("foo");
SmallVector<BasicBlock *, 3> Candidates{getBlockByName(Func, "header"),
getBlockByName(Func, "body1"),
getBlockByName(Func, "body2")};
CodeExtractor CE(Candidates, /* DT */ nullptr, /* AggregateArgs */ false,
/* BFI */ nullptr, /* BPI */ nullptr, /* AC */ nullptr,
/* AllowVarargs */ false, /* AllowAlloca */ false,
/* AllocaBlock */ nullptr, /* DeallocationBlocks */ {},
/* Suffix */ "", /* ArgsInZeroAddressSpace */ false,
/* VoidReturnWithSingleOutput */ false);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
SetVector<Value *> Inputs, Outputs;
Function *Outlined = CE.extractCodeRegion(CEAC, Inputs, Outputs);
EXPECT_TRUE(Outlined);
EXPECT_EQ(Inputs.size(), 3u);
EXPECT_EQ(Inputs[0], Func->getArg(2));
EXPECT_EQ(Inputs[1], Func->getArg(0));
EXPECT_EQ(Inputs[2], Func->getArg(1));
EXPECT_EQ(Outputs.size(), 0u);
BasicBlock *Exit = getBlockByName(Func, "notExtracted");
BasicBlock *ExitSplit = getBlockByName(Outlined, "notExtracted.split");
// Ensure that PHI in exit block has only one incoming value (from code
// replacer block).
EXPECT_TRUE(Exit && cast<PHINode>(Exit->front()).getNumIncomingValues() == 1);
// Ensure that there is a PHI in outlined function with 2 incoming values.
EXPECT_TRUE(ExitSplit &&
cast<PHINode>(ExitSplit->front()).getNumIncomingValues() == 2);
BasicBlock *ExitStub = getBlockByName(Outlined, "notExtracted.exitStub");
Instruction *ExitTerm = ExitStub->getTerminator();
ReturnInst *ExitReturn = dyn_cast<ReturnInst>(ExitTerm);
EXPECT_TRUE(ExitReturn);
Value *RetVal = ExitReturn->getReturnValue();
EXPECT_TRUE(RetVal);
EXPECT_FALSE(verifyFunction(*Outlined));
EXPECT_FALSE(verifyFunction(*Func));
}
TEST(CodeExtractor, ExitBlockOrderingPhis) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"invalid(
define void @foo(i32 %a, i32 %b) {
entry:
%0 = alloca i32, align 4
br label %test0
test0:
%c = load i32, ptr %0, align 4
br label %test1
test1:
%e = load i32, ptr %0, align 4
br i1 true, label %first, label %test
test:
%d = load i32, ptr %0, align 4
br i1 true, label %first, label %next
first:
%1 = phi i32 [ %c, %test ], [ %e, %test1 ]
ret void
next:
%2 = add i32 %d, 1
%3 = add i32 %e, 1
ret void
}
)invalid",
Err, Ctx));
Function *Func = M->getFunction("foo");
SmallVector<BasicBlock *, 3> Candidates{ getBlockByName(Func, "test0"),
getBlockByName(Func, "test1"),
getBlockByName(Func, "test") };
CodeExtractor CE(Candidates);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
Function *Outlined = CE.extractCodeRegion(CEAC);
EXPECT_TRUE(Outlined);
BasicBlock *FirstExitStub = getBlockByName(Outlined, "first.exitStub");
BasicBlock *NextExitStub = getBlockByName(Outlined, "next.exitStub");
Instruction *FirstTerm = FirstExitStub->getTerminator();
ReturnInst *FirstReturn = dyn_cast<ReturnInst>(FirstTerm);
EXPECT_TRUE(FirstReturn);
ConstantInt *CIFirst = dyn_cast<ConstantInt>(FirstReturn->getReturnValue());
EXPECT_TRUE(CIFirst->getLimitedValue() == 1u);
Instruction *NextTerm = NextExitStub->getTerminator();
ReturnInst *NextReturn = dyn_cast<ReturnInst>(NextTerm);
EXPECT_TRUE(NextReturn);
ConstantInt *CINext = dyn_cast<ConstantInt>(NextReturn->getReturnValue());
EXPECT_TRUE(CINext->getLimitedValue() == 0u);
EXPECT_FALSE(verifyFunction(*Outlined));
EXPECT_FALSE(verifyFunction(*Func));
}
TEST(CodeExtractor, ExitBlockOrdering) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"invalid(
define void @foo(i32 %a, i32 %b) {
entry:
%0 = alloca i32, align 4
br label %test0
test0:
%c = load i32, ptr %0, align 4
br label %test1
test1:
%e = load i32, ptr %0, align 4
br i1 true, label %first, label %test
test:
%d = load i32, ptr %0, align 4
br i1 true, label %first, label %next
first:
ret void
next:
%1 = add i32 %d, 1
%2 = add i32 %e, 1
ret void
}
)invalid",
Err, Ctx));
Function *Func = M->getFunction("foo");
SmallVector<BasicBlock *, 3> Candidates{ getBlockByName(Func, "test0"),
getBlockByName(Func, "test1"),
getBlockByName(Func, "test") };
CodeExtractor CE(Candidates);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
Function *Outlined = CE.extractCodeRegion(CEAC);
EXPECT_TRUE(Outlined);
BasicBlock *FirstExitStub = getBlockByName(Outlined, "first.exitStub");
BasicBlock *NextExitStub = getBlockByName(Outlined, "next.exitStub");
Instruction *FirstTerm = FirstExitStub->getTerminator();
ReturnInst *FirstReturn = dyn_cast<ReturnInst>(FirstTerm);
EXPECT_TRUE(FirstReturn);
ConstantInt *CIFirst = dyn_cast<ConstantInt>(FirstReturn->getReturnValue());
EXPECT_TRUE(CIFirst->getLimitedValue() == 1u);
Instruction *NextTerm = NextExitStub->getTerminator();
ReturnInst *NextReturn = dyn_cast<ReturnInst>(NextTerm);
EXPECT_TRUE(NextReturn);
ConstantInt *CINext = dyn_cast<ConstantInt>(NextReturn->getReturnValue());
EXPECT_TRUE(CINext->getLimitedValue() == 0u);
EXPECT_FALSE(verifyFunction(*Outlined));
EXPECT_FALSE(verifyFunction(*Func));
}
TEST(CodeExtractor, ExitPHIOnePredFromRegion) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"invalid(
define i32 @foo() {
header:
br i1 undef, label %extracted1, label %pred
pred:
br i1 undef, label %exit1, label %exit2
extracted1:
br i1 undef, label %extracted2, label %exit1
extracted2:
br label %exit2
exit1:
%0 = phi i32 [ 1, %extracted1 ], [ 2, %pred ]
ret i32 %0
exit2:
%1 = phi i32 [ 3, %extracted2 ], [ 4, %pred ]
ret i32 %1
}
)invalid", Err, Ctx));
Function *Func = M->getFunction("foo");
SmallVector<BasicBlock *, 2> ExtractedBlocks{
getBlockByName(Func, "extracted1"),
getBlockByName(Func, "extracted2")
};
CodeExtractor CE(ExtractedBlocks);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
Function *Outlined = CE.extractCodeRegion(CEAC);
EXPECT_TRUE(Outlined);
BasicBlock *Exit1 = getBlockByName(Func, "exit1");
BasicBlock *Exit2 = getBlockByName(Func, "exit2");
// Ensure that PHIs in exits are not splitted (since that they have only one
// incoming value from extracted region).
EXPECT_TRUE(Exit1 &&
cast<PHINode>(Exit1->front()).getNumIncomingValues() == 2);
EXPECT_TRUE(Exit2 &&
cast<PHINode>(Exit2->front()).getNumIncomingValues() == 2);
EXPECT_FALSE(verifyFunction(*Outlined));
EXPECT_FALSE(verifyFunction(*Func));
}
TEST(CodeExtractor, StoreOutputInvokeResultAfterEHPad) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"invalid(
declare i8 @hoge()
define i32 @foo() personality ptr null {
entry:
%call = invoke i8 @hoge()
to label %invoke.cont unwind label %lpad
invoke.cont: ; preds = %entry
unreachable
lpad: ; preds = %entry
%0 = landingpad { ptr, i32 }
catch ptr null
br i1 undef, label %catch, label %finally.catchall
catch: ; preds = %lpad
%call2 = invoke i8 @hoge()
to label %invoke.cont2 unwind label %lpad2
invoke.cont2: ; preds = %catch
%call3 = invoke i8 @hoge()
to label %invoke.cont3 unwind label %lpad2
invoke.cont3: ; preds = %invoke.cont2
unreachable
lpad2: ; preds = %invoke.cont2, %catch
%ex.1 = phi ptr [ undef, %invoke.cont2 ], [ null, %catch ]
%1 = landingpad { ptr, i32 }
catch ptr null
br label %finally.catchall
finally.catchall: ; preds = %lpad33, %lpad
%ex.2 = phi ptr [ %ex.1, %lpad2 ], [ null, %lpad ]
unreachable
}
)invalid", Err, Ctx));
if (!M) {
Err.print("unit", errs());
exit(1);
}
Function *Func = M->getFunction("foo");
EXPECT_FALSE(verifyFunction(*Func, &errs()));
SmallVector<BasicBlock *, 2> ExtractedBlocks{
getBlockByName(Func, "catch"),
getBlockByName(Func, "invoke.cont2"),
getBlockByName(Func, "invoke.cont3"),
getBlockByName(Func, "lpad2")
};
CodeExtractor CE(ExtractedBlocks);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
Function *Outlined = CE.extractCodeRegion(CEAC);
EXPECT_TRUE(Outlined);
EXPECT_FALSE(verifyFunction(*Outlined, &errs()));
EXPECT_FALSE(verifyFunction(*Func, &errs()));
}
TEST(CodeExtractor, StoreOutputInvokeResultInExitStub) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"invalid(
declare i32 @bar()
define i32 @foo() personality ptr null {
entry:
%0 = invoke i32 @bar() to label %exit unwind label %lpad
exit:
ret i32 %0
lpad:
%1 = landingpad { ptr, i32 }
cleanup
resume { ptr, i32 } %1
}
)invalid",
Err, Ctx));
Function *Func = M->getFunction("foo");
SmallVector<BasicBlock *, 1> Blocks{ getBlockByName(Func, "entry"),
getBlockByName(Func, "lpad") };
CodeExtractor CE(Blocks);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
Function *Outlined = CE.extractCodeRegion(CEAC);
EXPECT_TRUE(Outlined);
EXPECT_FALSE(verifyFunction(*Outlined));
EXPECT_FALSE(verifyFunction(*Func));
}
TEST(CodeExtractor, ExtractAndInvalidateAssumptionCache) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"ir(
target datalayout = "e-m:e-i8:8:32-i16:16:32-i64:64-i128:128-n32:64-S128"
target triple = "aarch64"
%b = type { i64 }
declare void @g(ptr)
declare void @llvm.assume(i1) #0
define void @test() {
entry:
br label %label
label:
%0 = load ptr, ptr inttoptr (i64 8 to ptr), align 8
%1 = getelementptr inbounds %b, ptr %0, i64 undef, i32 0
%2 = load i64, ptr %1, align 8
%3 = icmp ugt i64 %2, 1
br i1 %3, label %if.then, label %if.else
if.then:
unreachable
if.else:
call void @g(ptr undef)
store i64 undef, ptr null, align 536870912
%4 = icmp eq i64 %2, 0
call void @llvm.assume(i1 %4)
unreachable
}
attributes #0 = { nounwind willreturn }
)ir",
Err, Ctx));
assert(M && "Could not parse module?");
Function *Func = M->getFunction("test");
SmallVector<BasicBlock *, 1> Blocks{ getBlockByName(Func, "if.else") };
AssumptionCache AC(*Func);
CodeExtractor CE(Blocks, nullptr, false, nullptr, nullptr, &AC);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
Function *Outlined = CE.extractCodeRegion(CEAC);
EXPECT_TRUE(Outlined);
EXPECT_FALSE(verifyFunction(*Outlined));
EXPECT_FALSE(verifyFunction(*Func));
EXPECT_FALSE(CE.verifyAssumptionCache(*Func, *Outlined, &AC));
}
TEST(CodeExtractor, RemoveBitcastUsesFromOuterLifetimeMarkers) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"ir(
target datalayout = "e-m:e-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128"
target triple = "x86_64-unknown-linux-gnu"
declare void @use(ptr)
declare void @llvm.lifetime.start.p0i8(i64, ptr)
declare void @llvm.lifetime.end.p0i8(i64, ptr)
define void @foo() {
entry:
%0 = alloca i32
br label %extract
extract:
%1 = bitcast ptr %0 to ptr
call void @llvm.lifetime.start.p0i8(i64 4, ptr %1)
call void @use(ptr %0)
br label %exit
exit:
call void @use(ptr %0)
call void @llvm.lifetime.end.p0i8(i64 4, ptr %1)
ret void
}
)ir",
Err, Ctx));
Function *Func = M->getFunction("foo");
SmallVector<BasicBlock *, 1> Blocks{getBlockByName(Func, "extract")};
CodeExtractor CE(Blocks);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
SetVector<Value *> Inputs, Outputs, SinkingCands, HoistingCands;
BasicBlock *CommonExit = nullptr;
CE.findAllocas(CEAC, SinkingCands, HoistingCands, CommonExit);
CE.findInputsOutputs(Inputs, Outputs, SinkingCands);
EXPECT_EQ(Outputs.size(), 0U);
Function *Outlined = CE.extractCodeRegion(CEAC);
EXPECT_TRUE(Outlined);
EXPECT_FALSE(verifyFunction(*Outlined));
EXPECT_FALSE(verifyFunction(*Func));
}
TEST(CodeExtractor, PartialAggregateArgs) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"ir(
target datalayout = "e-m:e-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128"
target triple = "x86_64-unknown-linux-gnu"
; use different types such that an index mismatch will result in a type mismatch during verification.
declare void @use16(i16)
declare void @use32(i32)
declare void @use64(i64)
define void @foo(i16 %a, i32 %b, i64 %c) {
entry:
br label %extract
extract:
call void @use16(i16 %a)
call void @use32(i32 %b)
call void @use64(i64 %c)
%d = add i16 21, 21
%e = add i32 21, 21
%f = add i64 21, 21
br label %exit
exit:
call void @use16(i16 %d)
call void @use32(i32 %e)
call void @use64(i64 %f)
ret void
}
)ir",
Err, Ctx));
Function *Func = M->getFunction("foo");
SmallVector<BasicBlock *, 1> Blocks{getBlockByName(Func, "extract")};
// Create the CodeExtractor with arguments aggregation enabled.
CodeExtractor CE(Blocks, /* DominatorTree */ nullptr,
/* AggregateArgs */ true);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
SetVector<Value *> Inputs, Outputs, SinkingCands, HoistingCands;
BasicBlock *CommonExit = nullptr;
CE.findAllocas(CEAC, SinkingCands, HoistingCands, CommonExit);
CE.findInputsOutputs(Inputs, Outputs, SinkingCands);
// Exclude the middle input and output from the argument aggregate.
CE.excludeArgFromAggregate(Inputs[1]);
CE.excludeArgFromAggregate(Outputs[1]);
Function *Outlined = CE.extractCodeRegion(CEAC, Inputs, Outputs);
EXPECT_TRUE(Outlined);
// Expect 3 arguments in the outlined function: the excluded input, the
// excluded output, and the struct aggregate for the remaining inputs.
EXPECT_EQ(Outlined->arg_size(), 3U);
EXPECT_FALSE(verifyFunction(*Outlined));
EXPECT_FALSE(verifyFunction(*Func));
}
TEST(CodeExtractor, AllocaBlock) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"invalid(
define i32 @foo(i32 %x, i32 %y, i32 %z) {
entry:
br label %allocas
allocas:
br label %body
body:
%w = add i32 %x, %y
br label %notExtracted
notExtracted:
%r = add i32 %w, %x
ret i32 %r
}
)invalid",
Err, Ctx));
Function *Func = M->getFunction("foo");
SmallVector<BasicBlock *, 3> Candidates{getBlockByName(Func, "body")};
BasicBlock *AllocaBlock = getBlockByName(Func, "allocas");
CodeExtractor CE(Candidates, nullptr, true, nullptr, nullptr, nullptr, false,
false, AllocaBlock);
CE.excludeArgFromAggregate(Func->getArg(0));
CE.excludeArgFromAggregate(getInstByName(Func, "w"));
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
SetVector<Value *> Inputs, Outputs;
Function *Outlined = CE.extractCodeRegion(CEAC, Inputs, Outputs);
EXPECT_TRUE(Outlined);
EXPECT_FALSE(verifyFunction(*Outlined));
EXPECT_FALSE(verifyFunction(*Func));
// The only added allocas may be in the dedicated alloca block. There should
// be one alloca for the struct, and another one for the reload value.
int NumAllocas = 0;
for (Instruction &I : instructions(Func)) {
if (!isa<AllocaInst>(I))
continue;
EXPECT_EQ(I.getParent(), AllocaBlock);
NumAllocas += 1;
}
EXPECT_EQ(NumAllocas, 2);
}
/// Regression test to ensure we don't crash trying to set the name of the ptr
/// argument
TEST(CodeExtractor, PartialAggregateArgs2) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"ir(
declare void @usei(i32)
declare void @usep(ptr)
define void @foo(i32 %a, i32 %b, ptr %p) {
entry:
br label %extract
extract:
call void @usei(i32 %a)
call void @usei(i32 %b)
call void @usep(ptr %p)
br label %exit
exit:
ret void
}
)ir",
Err, Ctx));
Function *Func = M->getFunction("foo");
SmallVector<BasicBlock *, 1> Blocks{getBlockByName(Func, "extract")};
// Create the CodeExtractor with arguments aggregation enabled.
CodeExtractor CE(Blocks, /* DominatorTree */ nullptr,
/* AggregateArgs */ true);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
SetVector<Value *> Inputs, Outputs, SinkingCands, HoistingCands;
BasicBlock *CommonExit = nullptr;
CE.findAllocas(CEAC, SinkingCands, HoistingCands, CommonExit);
CE.findInputsOutputs(Inputs, Outputs, SinkingCands);
// Exclude the last input from the argument aggregate.
CE.excludeArgFromAggregate(Inputs[2]);
Function *Outlined = CE.extractCodeRegion(CEAC, Inputs, Outputs);
EXPECT_TRUE(Outlined);
EXPECT_FALSE(verifyFunction(*Outlined));
EXPECT_FALSE(verifyFunction(*Func));
}
TEST(CodeExtractor, OpenMPAggregateArgs) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"ir(
target datalayout = "e-p:64:64-p1:64:64-p2:32:32-p3:32:32-p4:64:64-p5:32:32-p6:32:32-p7:160:256:256:32-p8:128:128:128:48-i64:64-v16:16-v24:32-v32:32-v48:64-v96:128-v192:256-v256:256-v512:512-v1024:1024-v2048:2048-n32:64-S32-A5-G1-ni:7:8:9"
target triple = "amdgcn-amd-amdhsa"
define void @foo(ptr %0) {
%2= alloca ptr, align 8, addrspace(5)
%3 = addrspacecast ptr addrspace(5) %2 to ptr
store ptr %0, ptr %3, align 8
%4 = load ptr, ptr %3, align 8
br label %entry
entry:
br label %extract
extract:
store i64 10, ptr %4, align 4
br label %exit
exit:
ret void
}
)ir",
Err, Ctx));
Function *Func = M->getFunction("foo");
SmallVector<BasicBlock *, 1> Blocks{getBlockByName(Func, "extract")};
// Create the CodeExtractor with arguments aggregation enabled.
// Outlined function argument should be declared in 0 address space
// even if the default alloca address space is 5.
CodeExtractor CE(Blocks, /* DominatorTree */ nullptr,
/* AggregateArgs */ true, /* BlockFrequencyInfo */ nullptr,
/* BranchProbabilityInfo */ nullptr,
/* AssumptionCache */ nullptr,
/* AllowVarArgs */ true,
/* AllowAlloca */ true,
/* AllocationBlock*/ &Func->getEntryBlock(),
/* DeallocationBlocks */ {},
/* Suffix */ ".outlined",
/* ArgsInZeroAddressSpace */ true);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
SetVector<Value *> Inputs, Outputs, SinkingCands, HoistingCands;
BasicBlock *CommonExit = nullptr;
CE.findAllocas(CEAC, SinkingCands, HoistingCands, CommonExit);
CE.findInputsOutputs(Inputs, Outputs, SinkingCands);
Function *Outlined = CE.extractCodeRegion(CEAC, Inputs, Outputs);
EXPECT_TRUE(Outlined);
EXPECT_EQ(Outlined->arg_size(), 1U);
// Check address space of outlined argument is ptr in address space 0
EXPECT_EQ(Outlined->getArg(0)->getType(),
PointerType::get(M->getContext(), 0));
EXPECT_FALSE(verifyFunction(*Outlined));
EXPECT_FALSE(verifyFunction(*Func));
}
TEST(CodeExtractor, ArgsDebugInfo) {
LLVMContext Ctx;
SMDiagnostic Err;
std::unique_ptr<Module> M(parseAssemblyString(R"ir(
target datalayout = "e-m:e-p270:32:32-p271:32:32-p272:64:64-i64:64-i128:128-f80:128-n8:16:32:64-S128"
target triple = "x86_64-unknown-linux-gnu"
define void @foo(i32 %a, i32 %b) !dbg !2 {
%1 = alloca i32, i64 1, align 4, !dbg !1
store i32 %a, ptr %1, align 4, !dbg !1
#dbg_declare(ptr %1, !8, !DIExpression(), !1)
#dbg_value(i32 %b, !9, !DIExpression(), !1)
br label %entry
entry:
br label %extract
extract:
store i32 10, ptr %1, align 4, !dbg !1
%2 = add i32 %b, 1, !dbg !1
br label %exit
exit:
ret void
}
!llvm.dbg.cu = !{!6}
!llvm.module.flags = !{!0}
!0 = !{i32 2, !"Debug Info Version", i32 3}
!1 = !DILocation(line: 11, column: 7, scope: !2)
!2 = distinct !DISubprogram(name: "foo", scope: !3, file: !3, type: !4, spFlags: DISPFlagDefinition, unit: !6)
!3 = !DIFile(filename: "test.f90", directory: "")
!4 = !DISubroutineType(cc: DW_CC_program, types: !5)
!5 = !{null}
!6 = distinct !DICompileUnit(language: DW_LANG_Fortran95, file: !3)
!7 = !DIBasicType(name: "integer", size: 32, encoding: DW_ATE_signed)
!8 = !DILocalVariable(name: "a", scope: !2, file: !3, type: !7)
!9 = !DILocalVariable(name: "b", scope: !2, file: !3, type: !7)
)ir",
Err, Ctx));
Function *Func = M->getFunction("foo");
SmallVector<BasicBlock *, 1> Blocks{getBlockByName(Func, "extract")};
auto TestExtracted = [&](bool AggregateArgs) {
CodeExtractor CE(Blocks, /* DominatorTree */ nullptr, AggregateArgs);
EXPECT_TRUE(CE.isEligible());
CodeExtractorAnalysisCache CEAC(*Func);
SetVector<Value *> Inputs, Outputs, SinkingCands, HoistingCands;
BasicBlock *CommonExit = nullptr;
CE.findAllocas(CEAC, SinkingCands, HoistingCands, CommonExit);
CE.findInputsOutputs(Inputs, Outputs, SinkingCands);
Function *Outlined = CE.extractCodeRegion(CEAC, Inputs, Outputs);
EXPECT_TRUE(Outlined);
BasicBlock &EB = Outlined->getEntryBlock();
Instruction *Term = EB.getTerminator();
EXPECT_TRUE(Term);
EXPECT_TRUE(Term->hasDbgRecords());
for (DbgVariableRecord &DVR : filterDbgVars(Term->getDbgRecordRange())) {
DILocalVariable *Var = DVR.getVariable();
EXPECT_TRUE(Var);
if (DVR.isDbgDeclare())
EXPECT_TRUE(Var->getName() == "a");
else
EXPECT_TRUE(Var->getName() == "b");
for (Value *Loc : DVR.location_ops()) {
if (Instruction *I = dyn_cast<Instruction>(Loc))
EXPECT_TRUE(I->getParent() == &EB);
else if (Argument *A = dyn_cast<Argument>(Loc))
EXPECT_TRUE(A->getParent() == Outlined);
}
}
EXPECT_FALSE(verifyFunction(*Outlined));
};
// Test with both true and false for AggregateArgs.
TestExtracted(true);
TestExtracted(false);
EXPECT_FALSE(verifyFunction(*Func));
}
} // end anonymous namespace