1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
//===-- GuardUtils.cpp - Utils for work with guards -------------*- C++ -*-===//
//
// 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
//
//===----------------------------------------------------------------------===//
// Utils that are used to perform transformations related to guards and their
// conditions.
//===----------------------------------------------------------------------===//
#include "llvm/Transforms/Utils/GuardUtils.h"
#include "llvm/Analysis/GuardUtils.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/MDBuilder.h"
#include "llvm/IR/PatternMatch.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Transforms/Utils/BasicBlockUtils.h"
using namespace llvm;
using namespace llvm::PatternMatch;
static cl::opt<uint32_t> PredicatePassBranchWeight(
"guards-predicate-pass-branch-weight", cl::Hidden, cl::init(1 << 20),
cl::desc("The probability of a guard failing is assumed to be the "
"reciprocal of this value (default = 1 << 20)"));
void llvm::makeGuardControlFlowExplicit(Function *DeoptIntrinsic,
CallInst *Guard, bool UseWC) {
OperandBundleDef DeoptOB(*Guard->getOperandBundle(LLVMContext::OB_deopt));
SmallVector<Value *, 4> Args(std::next(Guard->arg_begin()), Guard->arg_end());
auto *CheckBB = Guard->getParent();
auto *DeoptBlockTerm =
SplitBlockAndInsertIfThen(Guard->getArgOperand(0), Guard, true);
auto *CheckBI = cast<BranchInst>(CheckBB->getTerminator());
// SplitBlockAndInsertIfThen inserts control flow that branches to
// DeoptBlockTerm if the condition is true. We want the opposite.
CheckBI->swapSuccessors();
CheckBI->getSuccessor(0)->setName("guarded");
CheckBI->getSuccessor(1)->setName("deopt");
if (auto *MD = Guard->getMetadata(LLVMContext::MD_make_implicit))
CheckBI->setMetadata(LLVMContext::MD_make_implicit, MD);
MDBuilder MDB(Guard->getContext());
CheckBI->setMetadata(LLVMContext::MD_prof,
MDB.createBranchWeights(PredicatePassBranchWeight, 1));
IRBuilder<> B(DeoptBlockTerm);
auto *DeoptCall = B.CreateCall(DeoptIntrinsic, Args, {DeoptOB}, "");
if (DeoptIntrinsic->getReturnType()->isVoidTy()) {
B.CreateRetVoid();
} else {
DeoptCall->setName("deoptcall");
B.CreateRet(DeoptCall);
}
DeoptCall->setCallingConv(Guard->getCallingConv());
DeoptBlockTerm->eraseFromParent();
if (UseWC) {
// We want the guard to be expressed as explicit control flow, but still be
// widenable. For that, we add Widenable Condition intrinsic call to the
// guard's condition.
IRBuilder<> B(CheckBI);
auto *WC = B.CreateIntrinsic(Intrinsic::experimental_widenable_condition,
{}, {}, nullptr, "widenable_cond");
CheckBI->setCondition(B.CreateAnd(CheckBI->getCondition(), WC,
"exiplicit_guard_cond"));
assert(isWidenableBranch(CheckBI) && "sanity check");
}
}
void llvm::widenWidenableBranch(BranchInst *WidenableBR, Value *NewCond) {
assert(isWidenableBranch(WidenableBR) && "precondition");
// The tempting trivially option is to produce something like this:
// br (and oldcond, newcond) where oldcond is assumed to contain a widenable
// condition, but that doesn't match the pattern parseWidenableBranch expects
// so we have to be more sophisticated.
if (match(WidenableBR->getCondition(),
m_Intrinsic<Intrinsic::experimental_widenable_condition>())) {
IRBuilder<> B(WidenableBR);
WidenableBR->setCondition(B.CreateAnd(NewCond,
WidenableBR->getCondition()));
} else {
Instruction *WCAnd = cast<Instruction>(WidenableBR->getCondition());
// Condition is only guaranteed to dominate branch
WCAnd->moveBefore(WidenableBR);
IRBuilder<> B(WCAnd);
const bool Op0IsWC =
match(WCAnd->getOperand(0),
m_Intrinsic<Intrinsic::experimental_widenable_condition>());
const unsigned CondOpIdx = Op0IsWC ? 1 : 0;
Value *OldCond = WCAnd->getOperand(CondOpIdx);
NewCond = B.CreateAnd(NewCond, OldCond);
WCAnd->setOperand(CondOpIdx, NewCond);
}
assert(isWidenableBranch(WidenableBR) && "preserve widenabiliy");
}
void llvm::setWidenableBranchCond(BranchInst *WidenableBR, Value *NewCond) {
assert(isWidenableBranch(WidenableBR) && "precondition");
if (match(WidenableBR->getCondition(),
m_Intrinsic<Intrinsic::experimental_widenable_condition>())) {
IRBuilder<> B(WidenableBR);
WidenableBR->setCondition(B.CreateAnd(NewCond,
WidenableBR->getCondition()));
} else {
Instruction *WCAnd = cast<Instruction>(WidenableBR->getCondition());
// Condition is only guaranteed to dominate branch
WCAnd->moveBefore(WidenableBR);
const bool Op0IsWC =
match(WCAnd->getOperand(0),
m_Intrinsic<Intrinsic::experimental_widenable_condition>());
const unsigned CondOpIdx = Op0IsWC ? 1 : 0;
WCAnd->setOperand(CondOpIdx, NewCond);
}
assert(isWidenableBranch(WidenableBR) && "preserve widenabiliy");
}
|
