1//===- IndirectBrExpandPass.cpp - Expand indirectbr to switch -------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8/// \file
9///
10/// Implements an expansion pass to turn `indirectbr` instructions in the IR
11/// into `switch` instructions. This works by enumerating the basic blocks in
12/// a dense range of integers, replacing each `blockaddr` constant with the
13/// corresponding integer constant, and then building a switch that maps from
14/// the integers to the actual blocks. All of the indirectbr instructions in the
15/// function are redirected to this common switch.
16///
17/// While this is generically useful if a target is unable to codegen
18/// `indirectbr` natively, it is primarily useful when there is some desire to
19/// get the builtin non-jump-table lowering of a switch even when the input
20/// source contained an explicit indirect branch construct.
21///
22/// Note that it doesn't make any sense to enable this pass unless a target also
23/// disables jump-table lowering of switches. Doing that is likely to pessimize
24/// the code.
25///
26//===----------------------------------------------------------------------===//
27
28#include "llvm/ADT/STLExtras.h"
29#include "llvm/ADT/Sequence.h"
30#include "llvm/ADT/SmallVector.h"
31#include "llvm/Analysis/DomTreeUpdater.h"
32#include "llvm/CodeGen/IndirectBrExpand.h"
33#include "llvm/CodeGen/TargetPassConfig.h"
34#include "llvm/CodeGen/TargetSubtargetInfo.h"
35#include "llvm/IR/BasicBlock.h"
36#include "llvm/IR/Constants.h"
37#include "llvm/IR/Dominators.h"
38#include "llvm/IR/Function.h"
39#include "llvm/IR/Instructions.h"
40#include "llvm/InitializePasses.h"
41#include "llvm/Pass.h"
42#include "llvm/Support/ErrorHandling.h"
43#include "llvm/Target/TargetMachine.h"
44#include <optional>
45
46using namespace llvm;
47
48#define DEBUG_TYPE "indirectbr-expand"
49
50namespace {
51
52class IndirectBrExpandLegacyPass : public FunctionPass {
53public:
54 static char ID; // Pass identification, replacement for typeid
55
56 IndirectBrExpandLegacyPass() : FunctionPass(ID) {}
57
58 void getAnalysisUsage(AnalysisUsage &AU) const override {
59 AU.addPreserved<DominatorTreeWrapperPass>();
60 }
61
62 bool runOnFunction(Function &F) override;
63};
64
65} // end anonymous namespace
66
67static bool runImpl(Function &F, const TargetLowering *TLI,
68 DomTreeUpdater *DTU);
69
70PreservedAnalyses IndirectBrExpandPass::run(Function &F,
71 FunctionAnalysisManager &FAM) {
72 auto *STI = TM->getSubtargetImpl(F);
73 if (!STI->enableIndirectBrExpand())
74 return PreservedAnalyses::all();
75
76 auto *TLI = STI->getTargetLowering();
77 auto *DT = FAM.getCachedResult<DominatorTreeAnalysis>(IR&: F);
78 DomTreeUpdater DTU(DT, DomTreeUpdater::UpdateStrategy::Lazy);
79
80 bool Changed = runImpl(F, TLI, DTU: DT ? &DTU : nullptr);
81 if (!Changed)
82 return PreservedAnalyses::all();
83 PreservedAnalyses PA;
84 PA.preserve<DominatorTreeAnalysis>();
85 return PA;
86}
87
88char IndirectBrExpandLegacyPass::ID = 0;
89
90INITIALIZE_PASS_BEGIN(IndirectBrExpandLegacyPass, DEBUG_TYPE,
91 "Expand indirectbr instructions", false, false)
92INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
93INITIALIZE_PASS_END(IndirectBrExpandLegacyPass, DEBUG_TYPE,
94 "Expand indirectbr instructions", false, false)
95
96FunctionPass *llvm::createIndirectBrExpandPass() {
97 return new IndirectBrExpandLegacyPass();
98}
99
100bool runImpl(Function &F, const TargetLowering *TLI, DomTreeUpdater *DTU) {
101 auto &DL = F.getDataLayout();
102
103 SmallVector<IndirectBrInst *, 1> IndirectBrs;
104
105 // Set of all potential successors for indirectbr instructions.
106 SmallPtrSet<BasicBlock *, 4> IndirectBrSuccs;
107
108 // Build a list of indirectbrs that we want to rewrite.
109 for (BasicBlock &BB : F)
110 if (auto *IBr = dyn_cast<IndirectBrInst>(Val: BB.getTerminator())) {
111 // Handle the degenerate case of no successors by replacing the indirectbr
112 // with unreachable as there is no successor available.
113 if (IBr->getNumSuccessors() == 0) {
114 (void)new UnreachableInst(F.getContext(), IBr->getIterator());
115 IBr->eraseFromParent();
116 continue;
117 }
118
119 IndirectBrs.push_back(Elt: IBr);
120 IndirectBrSuccs.insert_range(R: IBr->successors());
121 }
122
123 if (IndirectBrs.empty())
124 return false;
125
126 // If we need to replace any indirectbrs we need to establish integer
127 // constants that will correspond to each of the basic blocks in the function
128 // whose address escapes. We do that here and rewrite all the blockaddress
129 // constants to just be those integer constants cast to a pointer type.
130 SmallVector<BasicBlock *, 4> BBs;
131
132 for (BasicBlock &BB : F) {
133 // Skip blocks that aren't successors to an indirectbr we're going to
134 // rewrite.
135 if (!IndirectBrSuccs.count(Ptr: &BB))
136 continue;
137
138 auto IsBlockAddressUse = [&](const Use &U) {
139 return isa<BlockAddress>(Val: U.getUser());
140 };
141 auto BlockAddressUseIt = llvm::find_if(Range: BB.uses(), P: IsBlockAddressUse);
142 if (BlockAddressUseIt == BB.use_end())
143 continue;
144
145 assert(std::none_of(std::next(BlockAddressUseIt), BB.use_end(),
146 IsBlockAddressUse) &&
147 "There should only ever be a single blockaddress use because it is "
148 "a constant and should be uniqued.");
149
150 auto *BA = cast<BlockAddress>(Val: BlockAddressUseIt->getUser());
151
152 // Skip if the constant was formed but ended up not being used (due to DCE
153 // or whatever).
154 if (!BA->isConstantUsed())
155 continue;
156
157 // Compute the index we want to use for this basic block. We can't use zero
158 // because null can be compared with block addresses.
159 int BBIndex = BBs.size() + 1;
160 BBs.push_back(Elt: &BB);
161
162 auto *ITy = cast<IntegerType>(Val: DL.getIntPtrType(BA->getType()));
163 ConstantInt *BBIndexC = ConstantInt::get(Ty: ITy, V: BBIndex);
164
165 // Now rewrite the blockaddress to an integer constant based on the index.
166 // FIXME: This part doesn't properly recognize other uses of blockaddress
167 // expressions, for instance, where they are used to pass labels to
168 // asm-goto. This part of the pass needs a rework.
169 BA->replaceAllUsesWith(V: ConstantExpr::getIntToPtr(C: BBIndexC, Ty: BA->getType()));
170 }
171
172 if (BBs.empty()) {
173 // There are no blocks whose address is taken, so any indirectbr instruction
174 // cannot get a valid input and we can replace all of them with unreachable.
175 SmallVector<DominatorTree::UpdateType, 8> Updates;
176 if (DTU)
177 Updates.reserve(N: IndirectBrSuccs.size());
178 for (auto *IBr : IndirectBrs) {
179 if (DTU) {
180 for (BasicBlock *SuccBB : IBr->successors())
181 Updates.push_back(Elt: {DominatorTree::Delete, IBr->getParent(), SuccBB});
182 }
183 (void)new UnreachableInst(F.getContext(), IBr->getIterator());
184 IBr->eraseFromParent();
185 }
186 if (DTU) {
187 assert(Updates.size() == IndirectBrSuccs.size() &&
188 "Got unexpected update count.");
189 DTU->applyUpdates(Updates);
190 }
191 return true;
192 }
193
194 BasicBlock *SwitchBB;
195 Value *SwitchValue;
196
197 // Compute a common integer type across all the indirectbr instructions.
198 IntegerType *CommonITy = nullptr;
199 for (auto *IBr : IndirectBrs) {
200 auto *ITy =
201 cast<IntegerType>(Val: DL.getIntPtrType(IBr->getAddress()->getType()));
202 if (!CommonITy || ITy->getBitWidth() > CommonITy->getBitWidth())
203 CommonITy = ITy;
204 }
205
206 auto GetSwitchValue = [CommonITy](IndirectBrInst *IBr) {
207 return CastInst::CreatePointerCast(S: IBr->getAddress(), Ty: CommonITy,
208 Name: Twine(IBr->getAddress()->getName()) +
209 ".switch_cast",
210 InsertBefore: IBr->getIterator());
211 };
212
213 SmallVector<DominatorTree::UpdateType, 8> Updates;
214
215 if (IndirectBrs.size() == 1) {
216 // If we only have one indirectbr, we can just directly replace it within
217 // its block.
218 IndirectBrInst *IBr = IndirectBrs[0];
219 SwitchBB = IBr->getParent();
220 SwitchValue = GetSwitchValue(IBr);
221 if (DTU) {
222 Updates.reserve(N: IndirectBrSuccs.size());
223 for (BasicBlock *SuccBB : IBr->successors())
224 Updates.push_back(Elt: {DominatorTree::Delete, IBr->getParent(), SuccBB});
225 assert(Updates.size() == IndirectBrSuccs.size() &&
226 "Got unexpected update count.");
227 }
228 IBr->eraseFromParent();
229 } else {
230 // Otherwise we need to create a new block to hold the switch across BBs,
231 // jump to that block instead of each indirectbr, and phi together the
232 // values for the switch.
233 SwitchBB = BasicBlock::Create(Context&: F.getContext(), Name: "switch_bb", Parent: &F);
234 auto *SwitchPN = PHINode::Create(Ty: CommonITy, NumReservedValues: IndirectBrs.size(),
235 NameStr: "switch_value_phi", InsertBefore: SwitchBB);
236 SwitchValue = SwitchPN;
237
238 // Now replace the indirectbr instructions with direct branches to the
239 // switch block and fill out the PHI operands.
240 if (DTU)
241 Updates.reserve(N: IndirectBrs.size() + 2 * IndirectBrSuccs.size());
242 for (auto *IBr : IndirectBrs) {
243 SwitchPN->addIncoming(V: GetSwitchValue(IBr), BB: IBr->getParent());
244 BranchInst::Create(IfTrue: SwitchBB, InsertBefore: IBr->getIterator());
245 if (DTU) {
246 Updates.push_back(Elt: {DominatorTree::Insert, IBr->getParent(), SwitchBB});
247 for (BasicBlock *SuccBB : IBr->successors())
248 Updates.push_back(Elt: {DominatorTree::Delete, IBr->getParent(), SuccBB});
249 }
250 IBr->eraseFromParent();
251 }
252 }
253
254 // Now build the switch in the block. The block will have no terminator
255 // already.
256 auto *SI = SwitchInst::Create(Value: SwitchValue, Default: BBs[0], NumCases: BBs.size(), InsertBefore: SwitchBB);
257
258 // Add a case for each block.
259 for (int i : llvm::seq<int>(Begin: 1, End: BBs.size()))
260 SI->addCase(OnVal: ConstantInt::get(Ty: CommonITy, V: i + 1), Dest: BBs[i]);
261
262 if (DTU) {
263 // If there were multiple indirectbr's, they may have common successors,
264 // but in the dominator tree, we only track unique edges.
265 SmallPtrSet<BasicBlock *, 8> UniqueSuccessors;
266 Updates.reserve(N: Updates.size() + BBs.size());
267 for (BasicBlock *BB : BBs) {
268 if (UniqueSuccessors.insert(Ptr: BB).second)
269 Updates.push_back(Elt: {DominatorTree::Insert, SwitchBB, BB});
270 }
271 DTU->applyUpdates(Updates);
272 }
273
274 return true;
275}
276
277bool IndirectBrExpandLegacyPass::runOnFunction(Function &F) {
278 auto *TPC = getAnalysisIfAvailable<TargetPassConfig>();
279 if (!TPC)
280 return false;
281
282 auto &TM = TPC->getTM<TargetMachine>();
283 auto &STI = *TM.getSubtargetImpl(F);
284 if (!STI.enableIndirectBrExpand())
285 return false;
286 auto *TLI = STI.getTargetLowering();
287
288 std::optional<DomTreeUpdater> DTU;
289 if (auto *DTWP = getAnalysisIfAvailable<DominatorTreeWrapperPass>())
290 DTU.emplace(args&: DTWP->getDomTree(), args: DomTreeUpdater::UpdateStrategy::Lazy);
291
292 return runImpl(F, TLI, DTU: DTU ? &*DTU : nullptr);
293}
294