LLVM  8.0.0svn
LoopInstSimplify.cpp
Go to the documentation of this file.
1 //===- LoopInstSimplify.cpp - Loop Instruction Simplification Pass --------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This pass performs lightweight instruction simplification on loop bodies.
11 //
12 //===----------------------------------------------------------------------===//
13 
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/SmallPtrSet.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/ADT/Statistic.h"
22 #include "llvm/Analysis/LoopInfo.h"
24 #include "llvm/Analysis/LoopPass.h"
28 #include "llvm/IR/BasicBlock.h"
29 #include "llvm/IR/CFG.h"
30 #include "llvm/IR/DataLayout.h"
31 #include "llvm/IR/Dominators.h"
32 #include "llvm/IR/Instruction.h"
33 #include "llvm/IR/Instructions.h"
34 #include "llvm/IR/Module.h"
35 #include "llvm/IR/PassManager.h"
36 #include "llvm/IR/User.h"
37 #include "llvm/Pass.h"
38 #include "llvm/Support/Casting.h"
39 #include "llvm/Transforms/Scalar.h"
42 #include <algorithm>
43 #include <utility>
44 
45 using namespace llvm;
46 
47 #define DEBUG_TYPE "loop-instsimplify"
48 
49 STATISTIC(NumSimplified, "Number of redundant instructions simplified");
50 
51 static bool simplifyLoopInst(Loop &L, DominatorTree &DT, LoopInfo &LI,
52  AssumptionCache &AC, const TargetLibraryInfo &TLI,
53  MemorySSAUpdater *MSSAU) {
54  const DataLayout &DL = L.getHeader()->getModule()->getDataLayout();
55  SimplifyQuery SQ(DL, &TLI, &DT, &AC);
56 
57  // On the first pass over the loop body we try to simplify every instruction.
58  // On subsequent passes, we can restrict this to only simplifying instructions
59  // where the inputs have been updated. We end up needing two sets: one
60  // containing the instructions we are simplifying in *this* pass, and one for
61  // the instructions we will want to simplify in the *next* pass. We use
62  // pointers so we can swap between two stably allocated sets.
63  SmallPtrSet<const Instruction *, 8> S1, S2, *ToSimplify = &S1, *Next = &S2;
64 
65  // Track the PHI nodes that have already been visited during each iteration so
66  // that we can identify when it is necessary to iterate.
67  SmallPtrSet<PHINode *, 4> VisitedPHIs;
68 
69  // While simplifying we may discover dead code or cause code to become dead.
70  // Keep track of all such instructions and we will delete them at the end.
72 
73  // First we want to create an RPO traversal of the loop body. By processing in
74  // RPO we can ensure that definitions are processed prior to uses (for non PHI
75  // uses) in all cases. This ensures we maximize the simplifications in each
76  // iteration over the loop and minimizes the possible causes for continuing to
77  // iterate.
78  LoopBlocksRPO RPOT(&L);
79  RPOT.perform(&LI);
80  MemorySSA *MSSA = MSSAU ? MSSAU->getMemorySSA() : nullptr;
81 
82  bool Changed = false;
83  for (;;) {
84  if (MSSAU && VerifyMemorySSA)
85  MSSA->verifyMemorySSA();
86  for (BasicBlock *BB : RPOT) {
87  for (Instruction &I : *BB) {
88  if (auto *PI = dyn_cast<PHINode>(&I))
89  VisitedPHIs.insert(PI);
90 
91  if (I.use_empty()) {
92  if (isInstructionTriviallyDead(&I, &TLI))
93  DeadInsts.push_back(&I);
94  continue;
95  }
96 
97  // We special case the first iteration which we can detect due to the
98  // empty `ToSimplify` set.
99  bool IsFirstIteration = ToSimplify->empty();
100 
101  if (!IsFirstIteration && !ToSimplify->count(&I))
102  continue;
103 
105  if (!V || !LI.replacementPreservesLCSSAForm(&I, V))
106  continue;
107 
108  for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
109  UI != UE;) {
110  Use &U = *UI++;
111  auto *UserI = cast<Instruction>(U.getUser());
112  U.set(V);
113 
114  // If the instruction is used by a PHI node we have already processed
115  // we'll need to iterate on the loop body to converge, so add it to
116  // the next set.
117  if (auto *UserPI = dyn_cast<PHINode>(UserI))
118  if (VisitedPHIs.count(UserPI)) {
119  Next->insert(UserPI);
120  continue;
121  }
122 
123  // If we are only simplifying targeted instructions and the user is an
124  // instruction in the loop body, add it to our set of targeted
125  // instructions. Because we process defs before uses (outside of PHIs)
126  // we won't have visited it yet.
127  //
128  // We also skip any uses outside of the loop being simplified. Those
129  // should always be PHI nodes due to LCSSA form, and we don't want to
130  // try to simplify those away.
131  assert((L.contains(UserI) || isa<PHINode>(UserI)) &&
132  "Uses outside the loop should be PHI nodes due to LCSSA!");
133  if (!IsFirstIteration && L.contains(UserI))
134  ToSimplify->insert(UserI);
135  }
136 
137  if (MSSAU)
138  if (Instruction *SimpleI = dyn_cast_or_null<Instruction>(V))
139  if (MemoryAccess *MA = MSSA->getMemoryAccess(&I))
140  if (MemoryAccess *ReplacementMA = MSSA->getMemoryAccess(SimpleI))
141  MA->replaceAllUsesWith(ReplacementMA);
142 
143  assert(I.use_empty() && "Should always have replaced all uses!");
144  if (isInstructionTriviallyDead(&I, &TLI))
145  DeadInsts.push_back(&I);
146  ++NumSimplified;
147  Changed = true;
148  }
149  }
150 
151  // Delete any dead instructions found thus far now that we've finished an
152  // iteration over all instructions in all the loop blocks.
153  if (!DeadInsts.empty()) {
154  Changed = true;
155  RecursivelyDeleteTriviallyDeadInstructions(DeadInsts, &TLI, MSSAU);
156  }
157 
158  if (MSSAU && VerifyMemorySSA)
159  MSSA->verifyMemorySSA();
160 
161  // If we never found a PHI that needs to be simplified in the next
162  // iteration, we're done.
163  if (Next->empty())
164  break;
165 
166  // Otherwise, put the next set in place for the next iteration and reset it
167  // and the visited PHIs for that iteration.
168  std::swap(Next, ToSimplify);
169  Next->clear();
170  VisitedPHIs.clear();
171  DeadInsts.clear();
172  }
173 
174  return Changed;
175 }
176 
177 namespace {
178 
179 class LoopInstSimplifyLegacyPass : public LoopPass {
180 public:
181  static char ID; // Pass ID, replacement for typeid
182 
183  LoopInstSimplifyLegacyPass() : LoopPass(ID) {
185  }
186 
187  bool runOnLoop(Loop *L, LPPassManager &LPM) override {
188  if (skipLoop(L))
189  return false;
190  DominatorTree &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
191  LoopInfo &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
192  AssumptionCache &AC =
193  getAnalysis<AssumptionCacheTracker>().getAssumptionCache(
194  *L->getHeader()->getParent());
195  const TargetLibraryInfo &TLI =
196  getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
197  MemorySSA *MSSA = nullptr;
200  MSSA = &getAnalysis<MemorySSAWrapperPass>().getMSSA();
201  MSSAU = MemorySSAUpdater(MSSA);
202  }
203 
204  return simplifyLoopInst(*L, DT, LI, AC, TLI,
205  MSSAU.hasValue() ? MSSAU.getPointer() : nullptr);
206  }
207 
208  void getAnalysisUsage(AnalysisUsage &AU) const override {
212  AU.setPreservesCFG();
216  }
218  }
219 };
220 
221 } // end anonymous namespace
222 
225  LPMUpdater &) {
227  if (AR.MSSA) {
228  MSSAU = MemorySSAUpdater(AR.MSSA);
229  AR.MSSA->verifyMemorySSA();
230  }
231  if (!simplifyLoopInst(L, AR.DT, AR.LI, AR.AC, AR.TLI,
232  MSSAU.hasValue() ? MSSAU.getPointer() : nullptr))
233  return PreservedAnalyses::all();
234 
235  auto PA = getLoopPassPreservedAnalyses();
236  PA.preserveSet<CFGAnalyses>();
237  return PA;
238 }
239 
241 
242 INITIALIZE_PASS_BEGIN(LoopInstSimplifyLegacyPass, "loop-instsimplify",
243  "Simplify instructions in loops", false, false)
248 INITIALIZE_PASS_END(LoopInstSimplifyLegacyPass, "loop-instsimplify",
249  "Simplify instructions in loops", false, false)
250 
252  return new LoopInstSimplifyLegacyPass();
253 }
Pass interface - Implemented by all &#39;passes&#39;.
Definition: Pass.h:81
A parsed version of the target data layout string in and methods for querying it. ...
Definition: DataLayout.h:111
AnalysisUsage & addPreserved()
Add the specified Pass class to the set of analyses preserved by this pass.
static PassRegistry * getPassRegistry()
getPassRegistry - Access the global registry object, which is automatically initialized at applicatio...
PreservedAnalyses getLoopPassPreservedAnalyses()
Returns the minimum set of Analyses that all loop passes must preserve.
bool VerifyMemorySSA
Enables verification of MemorySSA.
Definition: MemorySSA.cpp:84
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
SimplifyQuery getWithInstruction(Instruction *I) const
An immutable pass that tracks lazily created AssumptionCache objects.
A cache of @llvm.assume calls within a function.
STATISTIC(NumFunctions, "Total number of functions")
The adaptor from a function pass to a loop pass computes these analyses and makes them available to t...
AnalysisUsage & addRequired()
const Module * getModule() const
Return the module owning the function this basic block belongs to, or nullptr if the function does no...
Definition: BasicBlock.cpp:134
#define INITIALIZE_PASS_DEPENDENCY(depName)
Definition: PassSupport.h:51
Legacy analysis pass which computes MemorySSA.
Definition: MemorySSA.h:950
MemorySSA * getMemorySSA() const
Get handle on MemorySSA.
const DataLayout & getDataLayout() const
Get the data layout for the module&#39;s target platform.
Definition: Module.cpp:364
A Use represents the edge between a Value definition and its users.
Definition: Use.h:56
Encapsulates MemorySSA, including all data associated with memory accesses.
Definition: MemorySSA.h:700
static bool simplifyLoopInst(Loop &L, DominatorTree &DT, LoopInfo &LI, AssumptionCache &AC, const TargetLibraryInfo &TLI, MemorySSAUpdater *MSSAU)
BlockT * getHeader() const
Definition: LoopInfo.h:100
User * getUser() const LLVM_READONLY
Returns the User that contains this Use.
Definition: Use.cpp:41
MemoryUseOrDef * getMemoryAccess(const Instruction *I) const
Given a memory Mod/Ref&#39;ing instruction, get the MemorySSA access associated with it.
Definition: MemorySSA.h:711
Pass * createLoopInstSimplifyPass()
Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree...
Definition: Dominators.h:145
loop instsimplify
use_iterator_impl< Use > use_iterator
Definition: Value.h:332
void initializeLoopInstSimplifyLegacyPassPass(PassRegistry &)
A set of analyses that are preserved following a run of a transformation pass.
Definition: PassManager.h:154
INITIALIZE_PASS_BEGIN(LoopInstSimplifyLegacyPass, "loop-instsimplify", "Simplify instructions in loops", false, false) INITIALIZE_PASS_END(LoopInstSimplifyLegacyPass
void set(Value *Val)
Definition: Value.h:671
LLVM Basic Block Representation.
Definition: BasicBlock.h:59
LLVM_NODISCARD bool empty() const
Definition: SmallPtrSet.h:92
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
Definition: SmallPtrSet.h:371
Represent the analysis usage information of a pass.
const T * getPointer() const
Definition: Optional.h:171
size_type count(ConstPtrType Ptr) const
count - Return 1 if the specified pointer is in the set, 0 otherwise.
Definition: SmallPtrSet.h:382
bool RecursivelyDeleteTriviallyDeadInstructions(Value *V, const TargetLibraryInfo *TLI=nullptr, MemorySSAUpdater *MSSAU=nullptr)
If the specified value is a trivially dead instruction, delete it.
Definition: Local.cpp:430
static PreservedAnalyses all()
Construct a special preserved set that preserves all passes.
Definition: PassManager.h:160
INITIALIZE_PASS_END(RegBankSelect, DEBUG_TYPE, "Assign register bank of generic virtual registers", false, false) RegBankSelect
This class provides an interface for updating the loop pass manager based on mutations to the loop ne...
bool contains(const LoopT *L) const
Return true if the specified loop is contained within in this loop.
Definition: LoopInfo.h:110
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements...
Definition: SmallPtrSet.h:418
loop Simplify instructions in loops
void verifyMemorySSA() const
Verify that MemorySSA is self consistent (IE definitions dominate all uses, uses appear in the right ...
Definition: MemorySSA.cpp:1702
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:847
Module.h This file contains the declarations for the Module class.
Provides information about what library functions are available for the current target.
void setPreservesCFG()
This function should be called by the pass, iff they do not:
Definition: Pass.cpp:286
void swap(llvm::BitVector &LHS, llvm::BitVector &RHS)
Implement std::swap in terms of BitVector swap.
Definition: BitVector.h:941
Represents analyses that only rely on functions&#39; control flow.
Definition: PassManager.h:115
This file provides various utilities for inspecting and working with the control flow graph in LLVM I...
bool hasValue() const
Definition: Optional.h:183
LLVM_NODISCARD bool empty() const
Definition: SmallVector.h:56
Represents a single loop in the control flow graph.
Definition: LoopInfo.h:459
const Function * getParent() const
Return the enclosing method, or null if none.
Definition: BasicBlock.h:108
#define I(x, y, z)
Definition: MD5.cpp:58
void getLoopAnalysisUsage(AnalysisUsage &AU)
Helper to consistently add the set of standard passes to a loop pass&#39;s AnalysisUsage.
Definition: LoopUtils.cpp:128
Wrapper class to LoopBlocksDFS that provides a standard begin()/end() interface for the DFS reverse p...
Definition: LoopIterator.h:173
PreservedAnalyses run(Loop &L, LoopAnalysisManager &AM, LoopStandardAnalysisResults &AR, LPMUpdater &U)
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
bool isInstructionTriviallyDead(Instruction *I, const TargetLibraryInfo *TLI=nullptr)
Return true if the result produced by the instruction is not used, and the instruction has no side ef...
Definition: Local.cpp:348
LLVM Value Representation.
Definition: Value.h:73
This file exposes an interface to building/using memory SSA to walk memory instructions using a use/d...
inst_range instructions(Function *F)
Definition: InstIterator.h:134
A container for analyses that lazily runs them and caches their results.
Legacy analysis pass which computes a DominatorTree.
Definition: Dominators.h:260
bool replacementPreservesLCSSAForm(Instruction *From, Value *To)
Returns true if replacing From with To everywhere is guaranteed to preserve LCSSA form...
Definition: LoopInfo.h:826
This header defines various interfaces for pass management in LLVM.
void perform(LoopInfo *LI)
Traverse the loop blocks and store the DFS result.
Definition: LoopIterator.h:181
Value * SimplifyInstruction(Instruction *I, const SimplifyQuery &Q, OptimizationRemarkEmitter *ORE=nullptr)
See if we can compute a simplified version of this instruction.
cl::opt< bool > EnableMSSALoopDependency
Enables memory ssa as a dependency for loop passes.