8359511c62
During extraction, stale llvm.assume handles may be retained in the original function. The setup is: 1) CodeExtractor unregisters assumptions in the blocks that are to be extracted. 2) Extraction happens. There are now two functions: f1 and f1.extracted. 3) Leftover assumptions in f1 (/not/ removed as they were not in the set of blocks to be extracted) now have affected-value llvm.assume handles in f1.extracted. When assumptions for a value used in f1 are looked up, ValueTracking can assert as some of the handles are in the wrong function. To fix this, simply erase the llvm.assume calls in the extracted function. Alternatives include flushing the assumption cache in the original function, or walking all values used in the original function to prune stale affected-value handles. Both seem more expensive. Testing: check-llvm, LNT run with -mllvm -hot-cold-split enabled rdar://58460728
286 lines
8.6 KiB
C++
286 lines
8.6 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/AsmParser/Parser.h"
|
|
#include "llvm/Analysis/AssumptionCache.h"
|
|
#include "llvm/IR/BasicBlock.h"
|
|
#include "llvm/IR/Dominators.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;
|
|
}
|
|
|
|
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, 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 i8* null {
|
|
entry:
|
|
%call = invoke i8 @hoge()
|
|
to label %invoke.cont unwind label %lpad
|
|
|
|
invoke.cont: ; preds = %entry
|
|
unreachable
|
|
|
|
lpad: ; preds = %entry
|
|
%0 = landingpad { i8*, i32 }
|
|
catch i8* 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 i8* [ undef, %invoke.cont2 ], [ null, %catch ]
|
|
%1 = landingpad { i8*, i32 }
|
|
catch i8* null
|
|
br label %finally.catchall
|
|
|
|
finally.catchall: ; preds = %lpad33, %lpad
|
|
%ex.2 = phi i8* [ %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 i8* null {
|
|
entry:
|
|
%0 = invoke i32 @bar() to label %exit unwind label %lpad
|
|
|
|
exit:
|
|
ret i32 %0
|
|
|
|
lpad:
|
|
%1 = landingpad { i8*, i32 }
|
|
cleanup
|
|
resume { i8*, 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(i8*)
|
|
|
|
declare void @llvm.assume(i1) #0
|
|
|
|
define void @test() {
|
|
entry:
|
|
br label %label
|
|
|
|
label:
|
|
%0 = load %b*, %b** inttoptr (i64 8 to %b**), align 8
|
|
%1 = getelementptr inbounds %b, %b* %0, i64 undef, i32 0
|
|
%2 = load i64, i64* %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(i8* undef)
|
|
store i64 undef, i64* 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));
|
|
}
|
|
} // end anonymous namespace
|