1 //===- SimplifyCFGPass.cpp - CFG Simplification Pass ----------------------===// 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 // 9 // This file implements dead code elimination and basic block merging, along 10 // with a collection of other peephole control flow optimizations. For example: 11 // 12 // * Removes basic blocks with no predecessors. 13 // * Merges a basic block into its predecessor if there is only one and the 14 // predecessor only has one successor. 15 // * Eliminates PHI nodes for basic blocks with a single predecessor. 16 // * Eliminates a basic block that only contains an unconditional branch. 17 // * Changes invoke instructions to nounwind functions to be calls. 18 // * Change things like "if (x) if (y)" into "if (x&y)". 19 // * etc.. 20 // 21 //===----------------------------------------------------------------------===// 22 23 #include "llvm/ADT/MapVector.h" 24 #include "llvm/ADT/SmallPtrSet.h" 25 #include "llvm/ADT/SmallVector.h" 26 #include "llvm/ADT/Statistic.h" 27 #include "llvm/Analysis/AssumptionCache.h" 28 #include "llvm/Analysis/CFG.h" 29 #include "llvm/Analysis/DomTreeUpdater.h" 30 #include "llvm/Analysis/GlobalsModRef.h" 31 #include "llvm/Analysis/TargetTransformInfo.h" 32 #include "llvm/IR/Attributes.h" 33 #include "llvm/IR/CFG.h" 34 #include "llvm/IR/Constants.h" 35 #include "llvm/IR/DataLayout.h" 36 #include "llvm/IR/Dominators.h" 37 #include "llvm/IR/Instructions.h" 38 #include "llvm/IR/IntrinsicInst.h" 39 #include "llvm/IR/Module.h" 40 #include "llvm/IR/ValueHandle.h" 41 #include "llvm/InitializePasses.h" 42 #include "llvm/Pass.h" 43 #include "llvm/Support/CommandLine.h" 44 #include "llvm/Transforms/Scalar.h" 45 #include "llvm/Transforms/Scalar/SimplifyCFG.h" 46 #include "llvm/Transforms/Utils/BasicBlockUtils.h" 47 #include "llvm/Transforms/Utils/Local.h" 48 #include "llvm/Transforms/Utils/SimplifyCFGOptions.h" 49 #include <utility> 50 using namespace llvm; 51 52 #define DEBUG_TYPE "simplifycfg" 53 54 static cl::opt<unsigned> UserBonusInstThreshold( 55 "bonus-inst-threshold", cl::Hidden, cl::init(1), 56 cl::desc("Control the number of bonus instructions (default = 1)")); 57 58 static cl::opt<bool> UserKeepLoops( 59 "keep-loops", cl::Hidden, cl::init(true), 60 cl::desc("Preserve canonical loop structure (default = true)")); 61 62 static cl::opt<bool> UserSwitchToLookup( 63 "switch-to-lookup", cl::Hidden, cl::init(false), 64 cl::desc("Convert switches to lookup tables (default = false)")); 65 66 static cl::opt<bool> UserForwardSwitchCond( 67 "forward-switch-cond", cl::Hidden, cl::init(false), 68 cl::desc("Forward switch condition to phi ops (default = false)")); 69 70 static cl::opt<bool> UserHoistCommonInsts( 71 "hoist-common-insts", cl::Hidden, cl::init(false), 72 cl::desc("hoist common instructions (default = false)")); 73 74 static cl::opt<bool> UserSinkCommonInsts( 75 "sink-common-insts", cl::Hidden, cl::init(false), 76 cl::desc("Sink common instructions (default = false)")); 77 78 79 STATISTIC(NumSimpl, "Number of blocks simplified"); 80 81 static bool 82 performBlockTailMerging(Function &F, ArrayRef<BasicBlock *> BBs, 83 std::vector<DominatorTree::UpdateType> *Updates) { 84 SmallVector<PHINode *, 1> NewOps; 85 86 // We don't want to change IR just because we can. 87 // Only do that if there are at least two blocks we'll tail-merge. 88 if (BBs.size() < 2) 89 return false; 90 91 if (Updates) 92 Updates->reserve(Updates->size() + BBs.size()); 93 94 BasicBlock *CanonicalBB; 95 Instruction *CanonicalTerm; 96 { 97 auto *Term = BBs[0]->getTerminator(); 98 99 // Create a canonical block for this function terminator type now, 100 // placing it *before* the first block that will branch to it. 101 CanonicalBB = BasicBlock::Create( 102 F.getContext(), Twine("common.") + Term->getOpcodeName(), &F, BBs[0]); 103 // We'll also need a PHI node per each operand of the terminator. 104 NewOps.resize(Term->getNumOperands()); 105 for (auto I : zip(Term->operands(), NewOps)) { 106 std::get<1>(I) = PHINode::Create(std::get<0>(I)->getType(), 107 /*NumReservedValues=*/BBs.size(), 108 CanonicalBB->getName() + ".op"); 109 CanonicalBB->getInstList().push_back(std::get<1>(I)); 110 } 111 // Make it so that this canonical block actually has the right 112 // terminator. 113 CanonicalTerm = Term->clone(); 114 CanonicalBB->getInstList().push_back(CanonicalTerm); 115 // If the canonical terminator has operands, rewrite it to take PHI's. 116 for (auto I : zip(NewOps, CanonicalTerm->operands())) 117 std::get<1>(I) = std::get<0>(I); 118 } 119 120 // Now, go through each block (with the current terminator type) 121 // we've recorded, and rewrite it to branch to the new common block. 122 const DILocation *CommonDebugLoc = nullptr; 123 for (BasicBlock *BB : BBs) { 124 auto *Term = BB->getTerminator(); 125 assert(Term->getOpcode() == CanonicalTerm->getOpcode() && 126 "All blocks to be tail-merged must be the same " 127 "(function-terminating) terminator type."); 128 129 // Aha, found a new non-canonical function terminator. If it has operands, 130 // forward them to the PHI nodes in the canonical block. 131 for (auto I : zip(Term->operands(), NewOps)) 132 std::get<1>(I)->addIncoming(std::get<0>(I), BB); 133 134 // Compute the debug location common to all the original terminators. 135 if (!CommonDebugLoc) 136 CommonDebugLoc = Term->getDebugLoc(); 137 else 138 CommonDebugLoc = 139 DILocation::getMergedLocation(CommonDebugLoc, Term->getDebugLoc()); 140 141 // And turn BB into a block that just unconditionally branches 142 // to the canonical block. 143 Term->eraseFromParent(); 144 BranchInst::Create(CanonicalBB, BB); 145 if (Updates) 146 Updates->push_back({DominatorTree::Insert, BB, CanonicalBB}); 147 } 148 149 CanonicalTerm->setDebugLoc(CommonDebugLoc); 150 151 return true; 152 } 153 154 static bool tailMergeBlocksWithSimilarFunctionTerminators(Function &F, 155 DomTreeUpdater *DTU) { 156 SmallMapVector<unsigned /*TerminatorOpcode*/, SmallVector<BasicBlock *, 2>, 4> 157 Structure; 158 159 // Scan all the blocks in the function, record the interesting-ones. 160 for (BasicBlock &BB : F) { 161 if (DTU && DTU->isBBPendingDeletion(&BB)) 162 continue; 163 164 // We are only interested in function-terminating blocks. 165 if (!succ_empty(&BB)) 166 continue; 167 168 auto *Term = BB.getTerminator(); 169 170 // Fow now only support `ret`/`resume` function terminators. 171 // FIXME: lift this restriction. 172 switch (Term->getOpcode()) { 173 case Instruction::Ret: 174 case Instruction::Resume: 175 break; 176 default: 177 continue; 178 } 179 180 // We can't tail-merge block that contains a musttail call. 181 if (BB.getTerminatingMustTailCall()) 182 continue; 183 184 // Calls to experimental_deoptimize must be followed by a return 185 // of the value computed by experimental_deoptimize. 186 // I.e., we can not change `ret` to `br` for this block. 187 if (auto *CI = 188 dyn_cast_or_null<CallInst>(Term->getPrevNonDebugInstruction())) { 189 if (Function *F = CI->getCalledFunction()) 190 if (Intrinsic::ID ID = F->getIntrinsicID()) 191 if (ID == Intrinsic::experimental_deoptimize) 192 continue; 193 } 194 195 // PHI nodes cannot have token type, so if the terminator has an operand 196 // with token type, we can not tail-merge this kind of function terminators. 197 if (any_of(Term->operands(), 198 [](Value *Op) { return Op->getType()->isTokenTy(); })) 199 continue; 200 201 // Canonical blocks are uniqued based on the terminator type (opcode). 202 Structure[Term->getOpcode()].emplace_back(&BB); 203 } 204 205 bool Changed = false; 206 207 std::vector<DominatorTree::UpdateType> Updates; 208 209 for (ArrayRef<BasicBlock *> BBs : make_second_range(Structure)) 210 Changed |= performBlockTailMerging(F, BBs, DTU ? &Updates : nullptr); 211 212 if (DTU) 213 DTU->applyUpdates(Updates); 214 215 return Changed; 216 } 217 218 /// Call SimplifyCFG on all the blocks in the function, 219 /// iterating until no more changes are made. 220 static bool iterativelySimplifyCFG(Function &F, const TargetTransformInfo &TTI, 221 DomTreeUpdater *DTU, 222 const SimplifyCFGOptions &Options) { 223 bool Changed = false; 224 bool LocalChange = true; 225 226 SmallVector<std::pair<const BasicBlock *, const BasicBlock *>, 32> Edges; 227 FindFunctionBackedges(F, Edges); 228 SmallPtrSet<BasicBlock *, 16> UniqueLoopHeaders; 229 for (unsigned i = 0, e = Edges.size(); i != e; ++i) 230 UniqueLoopHeaders.insert(const_cast<BasicBlock *>(Edges[i].second)); 231 232 SmallVector<WeakVH, 16> LoopHeaders(UniqueLoopHeaders.begin(), 233 UniqueLoopHeaders.end()); 234 235 unsigned IterCnt = 0; 236 (void)IterCnt; 237 while (LocalChange) { 238 assert(IterCnt++ < 1000 && "Iterative simplification didn't converge!"); 239 LocalChange = false; 240 241 // Loop over all of the basic blocks and remove them if they are unneeded. 242 for (Function::iterator BBIt = F.begin(); BBIt != F.end(); ) { 243 BasicBlock &BB = *BBIt++; 244 if (DTU) { 245 assert( 246 !DTU->isBBPendingDeletion(&BB) && 247 "Should not end up trying to simplify blocks marked for removal."); 248 // Make sure that the advanced iterator does not point at the blocks 249 // that are marked for removal, skip over all such blocks. 250 while (BBIt != F.end() && DTU->isBBPendingDeletion(&*BBIt)) 251 ++BBIt; 252 } 253 if (simplifyCFG(&BB, TTI, DTU, Options, LoopHeaders)) { 254 LocalChange = true; 255 ++NumSimpl; 256 } 257 } 258 Changed |= LocalChange; 259 } 260 return Changed; 261 } 262 263 static bool simplifyFunctionCFGImpl(Function &F, const TargetTransformInfo &TTI, 264 DominatorTree *DT, 265 const SimplifyCFGOptions &Options) { 266 DomTreeUpdater DTU(DT, DomTreeUpdater::UpdateStrategy::Eager); 267 268 bool EverChanged = removeUnreachableBlocks(F, DT ? &DTU : nullptr); 269 EverChanged |= 270 tailMergeBlocksWithSimilarFunctionTerminators(F, DT ? &DTU : nullptr); 271 EverChanged |= iterativelySimplifyCFG(F, TTI, DT ? &DTU : nullptr, Options); 272 273 // If neither pass changed anything, we're done. 274 if (!EverChanged) return false; 275 276 // iterativelySimplifyCFG can (rarely) make some loops dead. If this happens, 277 // removeUnreachableBlocks is needed to nuke them, which means we should 278 // iterate between the two optimizations. We structure the code like this to 279 // avoid rerunning iterativelySimplifyCFG if the second pass of 280 // removeUnreachableBlocks doesn't do anything. 281 if (!removeUnreachableBlocks(F, DT ? &DTU : nullptr)) 282 return true; 283 284 do { 285 EverChanged = iterativelySimplifyCFG(F, TTI, DT ? &DTU : nullptr, Options); 286 EverChanged |= removeUnreachableBlocks(F, DT ? &DTU : nullptr); 287 } while (EverChanged); 288 289 return true; 290 } 291 292 static bool simplifyFunctionCFG(Function &F, const TargetTransformInfo &TTI, 293 DominatorTree *DT, 294 const SimplifyCFGOptions &Options) { 295 assert((!RequireAndPreserveDomTree || 296 (DT && DT->verify(DominatorTree::VerificationLevel::Full))) && 297 "Original domtree is invalid?"); 298 299 bool Changed = simplifyFunctionCFGImpl(F, TTI, DT, Options); 300 301 assert((!RequireAndPreserveDomTree || 302 (DT && DT->verify(DominatorTree::VerificationLevel::Full))) && 303 "Failed to maintain validity of domtree!"); 304 305 return Changed; 306 } 307 308 // Command-line settings override compile-time settings. 309 static void applyCommandLineOverridesToOptions(SimplifyCFGOptions &Options) { 310 if (UserBonusInstThreshold.getNumOccurrences()) 311 Options.BonusInstThreshold = UserBonusInstThreshold; 312 if (UserForwardSwitchCond.getNumOccurrences()) 313 Options.ForwardSwitchCondToPhi = UserForwardSwitchCond; 314 if (UserSwitchToLookup.getNumOccurrences()) 315 Options.ConvertSwitchToLookupTable = UserSwitchToLookup; 316 if (UserKeepLoops.getNumOccurrences()) 317 Options.NeedCanonicalLoop = UserKeepLoops; 318 if (UserHoistCommonInsts.getNumOccurrences()) 319 Options.HoistCommonInsts = UserHoistCommonInsts; 320 if (UserSinkCommonInsts.getNumOccurrences()) 321 Options.SinkCommonInsts = UserSinkCommonInsts; 322 } 323 324 SimplifyCFGPass::SimplifyCFGPass() : Options() { 325 applyCommandLineOverridesToOptions(Options); 326 } 327 328 SimplifyCFGPass::SimplifyCFGPass(const SimplifyCFGOptions &Opts) 329 : Options(Opts) { 330 applyCommandLineOverridesToOptions(Options); 331 } 332 333 void SimplifyCFGPass::printPipeline( 334 raw_ostream &OS, function_ref<StringRef(StringRef)> MapClassName2PassName) { 335 static_cast<PassInfoMixin<SimplifyCFGPass> *>(this)->printPipeline( 336 OS, MapClassName2PassName); 337 OS << "<"; 338 OS << "bonus-inst-threshold=" << Options.BonusInstThreshold << ";"; 339 OS << (Options.ForwardSwitchCondToPhi ? "" : "no-") << "forward-switch-cond;"; 340 OS << (Options.ConvertSwitchToLookupTable ? "" : "no-") 341 << "switch-to-lookup;"; 342 OS << (Options.NeedCanonicalLoop ? "" : "no-") << "keep-loops;"; 343 OS << (Options.HoistCommonInsts ? "" : "no-") << "hoist-common-insts;"; 344 OS << (Options.SinkCommonInsts ? "" : "no-") << "sink-common-insts"; 345 OS << ">"; 346 } 347 348 PreservedAnalyses SimplifyCFGPass::run(Function &F, 349 FunctionAnalysisManager &AM) { 350 auto &TTI = AM.getResult<TargetIRAnalysis>(F); 351 Options.AC = &AM.getResult<AssumptionAnalysis>(F); 352 DominatorTree *DT = nullptr; 353 if (RequireAndPreserveDomTree) 354 DT = &AM.getResult<DominatorTreeAnalysis>(F); 355 if (F.hasFnAttribute(Attribute::OptForFuzzing)) { 356 Options.setSimplifyCondBranch(false).setFoldTwoEntryPHINode(false); 357 } else { 358 Options.setSimplifyCondBranch(true).setFoldTwoEntryPHINode(true); 359 } 360 if (!simplifyFunctionCFG(F, TTI, DT, Options)) 361 return PreservedAnalyses::all(); 362 PreservedAnalyses PA; 363 if (RequireAndPreserveDomTree) 364 PA.preserve<DominatorTreeAnalysis>(); 365 return PA; 366 } 367 368 namespace { 369 struct CFGSimplifyPass : public FunctionPass { 370 static char ID; 371 SimplifyCFGOptions Options; 372 std::function<bool(const Function &)> PredicateFtor; 373 374 CFGSimplifyPass(SimplifyCFGOptions Options_ = SimplifyCFGOptions(), 375 std::function<bool(const Function &)> Ftor = nullptr) 376 : FunctionPass(ID), Options(Options_), PredicateFtor(std::move(Ftor)) { 377 378 initializeCFGSimplifyPassPass(*PassRegistry::getPassRegistry()); 379 380 // Check for command-line overrides of options for debug/customization. 381 applyCommandLineOverridesToOptions(Options); 382 } 383 384 bool runOnFunction(Function &F) override { 385 if (skipFunction(F) || (PredicateFtor && !PredicateFtor(F))) 386 return false; 387 388 Options.AC = &getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F); 389 DominatorTree *DT = nullptr; 390 if (RequireAndPreserveDomTree) 391 DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree(); 392 if (F.hasFnAttribute(Attribute::OptForFuzzing)) { 393 Options.setSimplifyCondBranch(false) 394 .setFoldTwoEntryPHINode(false); 395 } else { 396 Options.setSimplifyCondBranch(true) 397 .setFoldTwoEntryPHINode(true); 398 } 399 400 auto &TTI = getAnalysis<TargetTransformInfoWrapperPass>().getTTI(F); 401 return simplifyFunctionCFG(F, TTI, DT, Options); 402 } 403 void getAnalysisUsage(AnalysisUsage &AU) const override { 404 AU.addRequired<AssumptionCacheTracker>(); 405 if (RequireAndPreserveDomTree) 406 AU.addRequired<DominatorTreeWrapperPass>(); 407 AU.addRequired<TargetTransformInfoWrapperPass>(); 408 if (RequireAndPreserveDomTree) 409 AU.addPreserved<DominatorTreeWrapperPass>(); 410 AU.addPreserved<GlobalsAAWrapperPass>(); 411 } 412 }; 413 } 414 415 char CFGSimplifyPass::ID = 0; 416 INITIALIZE_PASS_BEGIN(CFGSimplifyPass, "simplifycfg", "Simplify the CFG", false, 417 false) 418 INITIALIZE_PASS_DEPENDENCY(TargetTransformInfoWrapperPass) 419 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker) 420 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass) 421 INITIALIZE_PASS_END(CFGSimplifyPass, "simplifycfg", "Simplify the CFG", false, 422 false) 423 424 // Public interface to the CFGSimplification pass 425 FunctionPass * 426 llvm::createCFGSimplificationPass(SimplifyCFGOptions Options, 427 std::function<bool(const Function &)> Ftor) { 428 return new CFGSimplifyPass(Options, std::move(Ftor)); 429 } 430