LLVM  11.0.0git
UnrollLoop.h
Go to the documentation of this file.
1 //===- llvm/Transforms/Utils/UnrollLoop.h - Unrolling utilities -*- C++ -*-===//
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 defines some loop unrolling utilities. It does not define any
10 // actual pass or policy, but provides a single function to perform loop
11 // unrolling.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_TRANSFORMS_UTILS_UNROLLLOOP_H
16 #define LLVM_TRANSFORMS_UTILS_UNROLLLOOP_H
17 
18 #include "llvm/ADT/DenseMap.h"
20 
21 namespace llvm {
22 
23 class AssumptionCache;
24 class BasicBlock;
25 class BlockFrequencyInfo;
26 class DependenceInfo;
27 class DominatorTree;
28 class Loop;
29 class LoopInfo;
30 class MDNode;
31 class ProfileSummaryInfo;
32 class OptimizationRemarkEmitter;
33 class ScalarEvolution;
34 class StringRef;
35 class Value;
36 
38 
39 /// @{
40 /// Metadata attribute names
41 const char *const LLVMLoopUnrollFollowupAll = "llvm.loop.unroll.followup_all";
42 const char *const LLVMLoopUnrollFollowupUnrolled =
43  "llvm.loop.unroll.followup_unrolled";
45  "llvm.loop.unroll.followup_remainder";
46 /// @}
47 
48 const Loop* addClonedBlockToLoopInfo(BasicBlock *OriginalBB,
49  BasicBlock *ClonedBB, LoopInfo *LI,
50  NewLoopsMap &NewLoops);
51 
52 /// Represents the result of a \c UnrollLoop invocation.
53 enum class LoopUnrollResult {
54  /// The loop was not modified.
55  Unmodified,
56 
57  /// The loop was partially unrolled -- we still have a loop, but with a
58  /// smaller trip count. We may also have emitted epilogue loop if the loop
59  /// had a non-constant trip count.
61 
62  /// The loop was fully unrolled into straight-line code. We no longer have
63  /// any back-edges.
65 };
66 
68  unsigned Count;
69  unsigned TripCount;
70  bool Force;
75  unsigned TripMultiple;
76  unsigned PeelCount;
79 };
80 
83  AssumptionCache *AC,
85  OptimizationRemarkEmitter *ORE, bool PreserveLCSSA,
86  Loop **RemainderLoop = nullptr);
87 
89  Loop *L, unsigned Count, bool AllowExpensiveTripCount,
90  bool UseEpilogRemainder, bool UnrollRemainder, bool ForgetAllSCEV,
92  const TargetTransformInfo *TTI, bool PreserveLCSSA,
93  Loop **ResultLoop = nullptr);
94 
95 void computePeelCount(Loop *L, unsigned LoopSize,
98  unsigned &TripCount, ScalarEvolution &SE);
99 
100 bool canPeel(Loop *L);
101 
102 bool peelLoop(Loop *L, unsigned PeelCount, LoopInfo *LI, ScalarEvolution *SE,
103  DominatorTree *DT, AssumptionCache *AC, bool PreserveLCSSA);
104 
105 LoopUnrollResult UnrollAndJamLoop(Loop *L, unsigned Count, unsigned TripCount,
106  unsigned TripMultiple, bool UnrollRemainder,
107  LoopInfo *LI, ScalarEvolution *SE,
109  const TargetTransformInfo *TTI,
111  Loop **EpilogueLoop = nullptr);
112 
114  DependenceInfo &DI, LoopInfo &LI);
115 
117  DominatorTree &DT, LoopInfo *LI, ScalarEvolution &SE,
118  const SmallPtrSetImpl<const Value *> &EphValues,
119  OptimizationRemarkEmitter *ORE, unsigned &TripCount,
120  unsigned MaxTripCount, bool MaxOrZero,
121  unsigned &TripMultiple, unsigned LoopSize,
124 
125  bool &UseUpperBound);
126 
127 void simplifyLoopAfterUnroll(Loop *L, bool SimplifyIVs, LoopInfo *LI,
129  AssumptionCache *AC,
130  const TargetTransformInfo *TTI);
131 
133 
136  BlockFrequencyInfo *BFI, ProfileSummaryInfo *PSI, int OptLevel,
137  Optional<unsigned> UserThreshold, Optional<unsigned> UserCount,
138  Optional<bool> UserAllowPartial, Optional<bool> UserRuntime,
139  Optional<bool> UserUpperBound, Optional<unsigned> UserFullUnrollMaxCount);
140 
143  const TargetTransformInfo &TTI,
144  Optional<bool> UserAllowPeeling,
145  Optional<bool> UserAllowProfileBasedPeeling);
146 
147 unsigned ApproximateLoopSize(const Loop *L, unsigned &NumCalls,
148  bool &NotDuplicatable, bool &Convergent,
149  const TargetTransformInfo &TTI,
150  const SmallPtrSetImpl<const Value *> &EphValues,
151  unsigned BEInsns);
152 
153 } // end namespace llvm
154 
155 #endif // LLVM_TRANSFORMS_UTILS_UNROLLLOOP_H
This class represents lattice values for constants.
Definition: AllocatorList.h:23
Various leaf nodes.
Definition: ISDOpcodes.h:64
bool UnrollRuntimeLoopRemainder(Loop *L, unsigned Count, bool AllowExpensiveTripCount, bool UseEpilogRemainder, bool UnrollRemainder, bool ForgetAllSCEV, LoopInfo *LI, ScalarEvolution *SE, DominatorTree *DT, AssumptionCache *AC, const TargetTransformInfo *TTI, bool PreserveLCSSA, Loop **ResultLoop=nullptr)
Insert code in the prolog/epilog code when unrolling a loop with a run-time trip-count.
amdgpu Simplify well known AMD library false FunctionCallee Value const Twine & Name
Analysis providing profile information.
The main scalar evolution driver.
A cache of @llvm.assume calls within a function.
Metadata node.
Definition: Metadata.h:870
DependenceInfo - This class is the main dependence-analysis driver.
const char *const LLVMLoopUnrollFollowupUnrolled
Definition: UnrollLoop.h:42
TargetTransformInfo::UnrollingPreferences gatherUnrollingPreferences(Loop *L, ScalarEvolution &SE, const TargetTransformInfo &TTI, BlockFrequencyInfo *BFI, ProfileSummaryInfo *PSI, int OptLevel, Optional< unsigned > UserThreshold, Optional< unsigned > UserCount, Optional< bool > UserAllowPartial, Optional< bool > UserRuntime, Optional< bool > UserUpperBound, Optional< unsigned > UserFullUnrollMaxCount)
Gather the various unrolling parameters based on the defaults, compiler flags, TTI overrides and user...
const char *const LLVMLoopUnrollFollowupRemainder
Definition: UnrollLoop.h:44
Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree...
Definition: Dominators.h:144
bool computeUnrollCount(Loop *L, const TargetTransformInfo &TTI, DominatorTree &DT, LoopInfo *LI, ScalarEvolution &SE, const SmallPtrSetImpl< const Value *> &EphValues, OptimizationRemarkEmitter *ORE, unsigned &TripCount, unsigned MaxTripCount, bool MaxOrZero, unsigned &TripMultiple, unsigned LoopSize, TargetTransformInfo::UnrollingPreferences &UP, TargetTransformInfo::PeelingPreferences &PP, bool &UseUpperBound)
The loop was fully unrolled into straight-line code.
BlockFrequencyInfo pass uses BlockFrequencyInfoImpl implementation to estimate IR basic block frequen...
LLVM Basic Block Representation.
Definition: BasicBlock.h:58
bool peelLoop(Loop *L, unsigned PeelCount, LoopInfo *LI, ScalarEvolution *SE, DominatorTree *DT, AssumptionCache *AC, bool PreserveLCSSA)
Peel off the first PeelCount iterations of loop L.
bool isSafeToUnrollAndJam(Loop *L, ScalarEvolution &SE, DominatorTree &DT, DependenceInfo &DI, LoopInfo &LI)
The loop was partially unrolled – we still have a loop, but with a smaller trip count.
const char *const LLVMLoopUnrollFollowupAll
Definition: UnrollLoop.h:41
unsigned ApproximateLoopSize(const Loop *L, unsigned &NumCalls, bool &NotDuplicatable, bool &Convergent, const TargetTransformInfo &TTI, const SmallPtrSetImpl< const Value *> &EphValues, unsigned BEInsns)
ApproximateLoopSize - Approximate the size of the loop.
This pass provides access to the codegen interfaces that are needed for IR-level transformations.
void computePeelCount(Loop *L, unsigned LoopSize, TargetTransformInfo::UnrollingPreferences &UP, TargetTransformInfo::PeelingPreferences &PP, unsigned &TripCount, ScalarEvolution &SE)
bool canPeel(Loop *L)
const Loop * addClonedBlockToLoopInfo(BasicBlock *OriginalBB, BasicBlock *ClonedBB, LoopInfo *LI, NewLoopsMap &NewLoops)
Adds ClonedBB to LoopInfo, creates a new loop for ClonedBB if necessary and adds a mapping from the o...
Definition: LoopUnroll.cpp:135
LoopUnrollResult UnrollLoop(Loop *L, UnrollLoopOptions ULO, LoopInfo *LI, ScalarEvolution *SE, DominatorTree *DT, AssumptionCache *AC, const llvm::TargetTransformInfo *TTI, OptimizationRemarkEmitter *ORE, bool PreserveLCSSA, Loop **RemainderLoop=nullptr)
Unroll the given loop by Count.
Definition: LoopUnroll.cpp:282
MDNode * GetUnrollMetadata(MDNode *LoopID, StringRef Name)
Given an llvm.loop loop id metadata node, returns the loop hint metadata node with the given name (fo...
Definition: LoopUnroll.cpp:941
Represents a single loop in the control flow graph.
Definition: LoopInfo.h:516
Parameters that control the generic loop unrolling transformation.
TargetTransformInfo::PeelingPreferences gatherPeelingPreferences(Loop *L, ScalarEvolution &SE, const TargetTransformInfo &TTI, Optional< bool > UserAllowPeeling, Optional< bool > UserAllowProfileBasedPeeling)
void simplifyLoopAfterUnroll(Loop *L, bool SimplifyIVs, LoopInfo *LI, ScalarEvolution *SE, DominatorTree *DT, AssumptionCache *AC, const TargetTransformInfo *TTI)
Perform some cleanup and simplifications on loops after unrolling.
Definition: LoopUnroll.cpp:203
The loop was not modified.
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:57
This pass exposes codegen information to IR-level passes.
The optimization diagnostic interface.
LoopUnrollResult UnrollAndJamLoop(Loop *L, unsigned Count, unsigned TripCount, unsigned TripMultiple, bool UnrollRemainder, LoopInfo *LI, ScalarEvolution *SE, DominatorTree *DT, AssumptionCache *AC, const TargetTransformInfo *TTI, OptimizationRemarkEmitter *ORE, Loop **EpilogueLoop=nullptr)
LoopUnrollResult
Represents the result of a UnrollLoop invocation.
Definition: UnrollLoop.h:53