132a40564SEugene Zelenko //===- MachinePipeliner.cpp - Machine Software Pipeliner Pass -------------===//
2254f889dSBrendon Cahoon //
32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information.
52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6254f889dSBrendon Cahoon //
7254f889dSBrendon Cahoon //===----------------------------------------------------------------------===//
8254f889dSBrendon Cahoon //
9254f889dSBrendon Cahoon // An implementation of the Swing Modulo Scheduling (SMS) software pipeliner.
10254f889dSBrendon Cahoon //
11254f889dSBrendon Cahoon // This SMS implementation is a target-independent back-end pass. When enabled,
12254f889dSBrendon Cahoon // the pass runs just prior to the register allocation pass, while the machine
13254f889dSBrendon Cahoon // IR is in SSA form. If software pipelining is successful, then the original
14254f889dSBrendon Cahoon // loop is replaced by the optimized loop. The optimized loop contains one or
15254f889dSBrendon Cahoon // more prolog blocks, the pipelined kernel, and one or more epilog blocks. If
16254f889dSBrendon Cahoon // the instructions cannot be scheduled in a given MII, we increase the MII by
17254f889dSBrendon Cahoon // one and try again.
18254f889dSBrendon Cahoon //
19254f889dSBrendon Cahoon // The SMS implementation is an extension of the ScheduleDAGInstrs class. We
20254f889dSBrendon Cahoon // represent loop carried dependences in the DAG as order edges to the Phi
21254f889dSBrendon Cahoon // nodes. We also perform several passes over the DAG to eliminate unnecessary
22254f889dSBrendon Cahoon // edges that inhibit the ability to pipeline. The implementation uses the
23254f889dSBrendon Cahoon // DFAPacketizer class to compute the minimum initiation interval and the check
24254f889dSBrendon Cahoon // where an instruction may be inserted in the pipelined schedule.
25254f889dSBrendon Cahoon //
26254f889dSBrendon Cahoon // In order for the SMS pass to work, several target specific hooks need to be
27254f889dSBrendon Cahoon // implemented to get information about the loop structure and to rewrite
28254f889dSBrendon Cahoon // instructions.
29254f889dSBrendon Cahoon //
30254f889dSBrendon Cahoon //===----------------------------------------------------------------------===//
31254f889dSBrendon Cahoon 
32989f1c72Sserge-sans-paille #include "llvm/CodeGen/MachinePipeliner.h"
33cdc71612SEugene Zelenko #include "llvm/ADT/ArrayRef.h"
34cdc71612SEugene Zelenko #include "llvm/ADT/BitVector.h"
35254f889dSBrendon Cahoon #include "llvm/ADT/DenseMap.h"
36254f889dSBrendon Cahoon #include "llvm/ADT/MapVector.h"
37254f889dSBrendon Cahoon #include "llvm/ADT/PriorityQueue.h"
38d6391209SKazu Hirata #include "llvm/ADT/SetOperations.h"
39254f889dSBrendon Cahoon #include "llvm/ADT/SetVector.h"
40254f889dSBrendon Cahoon #include "llvm/ADT/SmallPtrSet.h"
41254f889dSBrendon Cahoon #include "llvm/ADT/SmallSet.h"
42cdc71612SEugene Zelenko #include "llvm/ADT/SmallVector.h"
43254f889dSBrendon Cahoon #include "llvm/ADT/Statistic.h"
446bda14b3SChandler Carruth #include "llvm/ADT/iterator_range.h"
45254f889dSBrendon Cahoon #include "llvm/Analysis/AliasAnalysis.h"
46cdc71612SEugene Zelenko #include "llvm/Analysis/MemoryLocation.h"
47989f1c72Sserge-sans-paille #include "llvm/Analysis/OptimizationRemarkEmitter.h"
48254f889dSBrendon Cahoon #include "llvm/Analysis/ValueTracking.h"
49254f889dSBrendon Cahoon #include "llvm/CodeGen/DFAPacketizer.h"
50f842297dSMatthias Braun #include "llvm/CodeGen/LiveIntervals.h"
51254f889dSBrendon Cahoon #include "llvm/CodeGen/MachineBasicBlock.h"
52254f889dSBrendon Cahoon #include "llvm/CodeGen/MachineDominators.h"
53cdc71612SEugene Zelenko #include "llvm/CodeGen/MachineFunction.h"
54cdc71612SEugene Zelenko #include "llvm/CodeGen/MachineFunctionPass.h"
55cdc71612SEugene Zelenko #include "llvm/CodeGen/MachineInstr.h"
56254f889dSBrendon Cahoon #include "llvm/CodeGen/MachineInstrBuilder.h"
57254f889dSBrendon Cahoon #include "llvm/CodeGen/MachineLoopInfo.h"
58cdc71612SEugene Zelenko #include "llvm/CodeGen/MachineMemOperand.h"
59cdc71612SEugene Zelenko #include "llvm/CodeGen/MachineOperand.h"
60254f889dSBrendon Cahoon #include "llvm/CodeGen/MachineRegisterInfo.h"
61790a779fSJames Molloy #include "llvm/CodeGen/ModuloSchedule.h"
62254f889dSBrendon Cahoon #include "llvm/CodeGen/RegisterPressure.h"
63cdc71612SEugene Zelenko #include "llvm/CodeGen/ScheduleDAG.h"
6488391248SKrzysztof Parzyszek #include "llvm/CodeGen/ScheduleDAGMutation.h"
65b3bde2eaSDavid Blaikie #include "llvm/CodeGen/TargetOpcodes.h"
66b3bde2eaSDavid Blaikie #include "llvm/CodeGen/TargetRegisterInfo.h"
67b3bde2eaSDavid Blaikie #include "llvm/CodeGen/TargetSubtargetInfo.h"
68432a3883SNico Weber #include "llvm/Config/llvm-config.h"
69cdc71612SEugene Zelenko #include "llvm/IR/Attributes.h"
7032a40564SEugene Zelenko #include "llvm/IR/Function.h"
7132a40564SEugene Zelenko #include "llvm/MC/LaneBitmask.h"
7232a40564SEugene Zelenko #include "llvm/MC/MCInstrDesc.h"
73254f889dSBrendon Cahoon #include "llvm/MC/MCInstrItineraries.h"
7432a40564SEugene Zelenko #include "llvm/MC/MCRegisterInfo.h"
7532a40564SEugene Zelenko #include "llvm/Pass.h"
76254f889dSBrendon Cahoon #include "llvm/Support/CommandLine.h"
7732a40564SEugene Zelenko #include "llvm/Support/Compiler.h"
78254f889dSBrendon Cahoon #include "llvm/Support/Debug.h"
79cdc71612SEugene Zelenko #include "llvm/Support/MathExtras.h"
80254f889dSBrendon Cahoon #include "llvm/Support/raw_ostream.h"
81cdc71612SEugene Zelenko #include <algorithm>
82cdc71612SEugene Zelenko #include <cassert>
83254f889dSBrendon Cahoon #include <climits>
84cdc71612SEugene Zelenko #include <cstdint>
85254f889dSBrendon Cahoon #include <deque>
86cdc71612SEugene Zelenko #include <functional>
87cdc71612SEugene Zelenko #include <iterator>
88254f889dSBrendon Cahoon #include <map>
8932a40564SEugene Zelenko #include <memory>
90cdc71612SEugene Zelenko #include <tuple>
91cdc71612SEugene Zelenko #include <utility>
92cdc71612SEugene Zelenko #include <vector>
93254f889dSBrendon Cahoon 
94254f889dSBrendon Cahoon using namespace llvm;
95254f889dSBrendon Cahoon 
96254f889dSBrendon Cahoon #define DEBUG_TYPE "pipeliner"
97254f889dSBrendon Cahoon 
98254f889dSBrendon Cahoon STATISTIC(NumTrytoPipeline, "Number of loops that we attempt to pipeline");
99254f889dSBrendon Cahoon STATISTIC(NumPipelined, "Number of loops software pipelined");
1004b8bcf00SRoorda, Jan-Willem STATISTIC(NumNodeOrderIssues, "Number of node order issues found");
10118e7bf5cSJinsong Ji STATISTIC(NumFailBranch, "Pipeliner abort due to unknown branch");
10218e7bf5cSJinsong Ji STATISTIC(NumFailLoop, "Pipeliner abort due to unsupported loop");
10318e7bf5cSJinsong Ji STATISTIC(NumFailPreheader, "Pipeliner abort due to missing preheader");
10418e7bf5cSJinsong Ji STATISTIC(NumFailLargeMaxMII, "Pipeliner abort due to MaxMII too large");
10518e7bf5cSJinsong Ji STATISTIC(NumFailZeroMII, "Pipeliner abort due to zero MII");
10618e7bf5cSJinsong Ji STATISTIC(NumFailNoSchedule, "Pipeliner abort due to no schedule found");
10718e7bf5cSJinsong Ji STATISTIC(NumFailZeroStage, "Pipeliner abort due to zero stage");
10818e7bf5cSJinsong Ji STATISTIC(NumFailLargeMaxStage, "Pipeliner abort due to too many stages");
109254f889dSBrendon Cahoon 
110254f889dSBrendon Cahoon /// A command line option to turn software pipelining on or off.
111b7d3311cSBenjamin Kramer static cl::opt<bool> EnableSWP("enable-pipeliner", cl::Hidden, cl::init(true),
112b7d3311cSBenjamin Kramer                                cl::ZeroOrMore,
113b7d3311cSBenjamin Kramer                                cl::desc("Enable Software Pipelining"));
114254f889dSBrendon Cahoon 
115254f889dSBrendon Cahoon /// A command line option to enable SWP at -Os.
116254f889dSBrendon Cahoon static cl::opt<bool> EnableSWPOptSize("enable-pipeliner-opt-size",
117254f889dSBrendon Cahoon                                       cl::desc("Enable SWP at Os."), cl::Hidden,
118254f889dSBrendon Cahoon                                       cl::init(false));
119254f889dSBrendon Cahoon 
120254f889dSBrendon Cahoon /// A command line argument to limit minimum initial interval for pipelining.
121254f889dSBrendon Cahoon static cl::opt<int> SwpMaxMii("pipeliner-max-mii",
1228f976ba0SHiroshi Inoue                               cl::desc("Size limit for the MII."),
123254f889dSBrendon Cahoon                               cl::Hidden, cl::init(27));
124254f889dSBrendon Cahoon 
125254f889dSBrendon Cahoon /// A command line argument to limit the number of stages in the pipeline.
126254f889dSBrendon Cahoon static cl::opt<int>
127254f889dSBrendon Cahoon     SwpMaxStages("pipeliner-max-stages",
128254f889dSBrendon Cahoon                  cl::desc("Maximum stages allowed in the generated scheduled."),
129254f889dSBrendon Cahoon                  cl::Hidden, cl::init(3));
130254f889dSBrendon Cahoon 
131254f889dSBrendon Cahoon /// A command line option to disable the pruning of chain dependences due to
132254f889dSBrendon Cahoon /// an unrelated Phi.
133254f889dSBrendon Cahoon static cl::opt<bool>
134254f889dSBrendon Cahoon     SwpPruneDeps("pipeliner-prune-deps",
135254f889dSBrendon Cahoon                  cl::desc("Prune dependences between unrelated Phi nodes."),
136254f889dSBrendon Cahoon                  cl::Hidden, cl::init(true));
137254f889dSBrendon Cahoon 
138254f889dSBrendon Cahoon /// A command line option to disable the pruning of loop carried order
139254f889dSBrendon Cahoon /// dependences.
140254f889dSBrendon Cahoon static cl::opt<bool>
141254f889dSBrendon Cahoon     SwpPruneLoopCarried("pipeliner-prune-loop-carried",
142254f889dSBrendon Cahoon                         cl::desc("Prune loop carried order dependences."),
143254f889dSBrendon Cahoon                         cl::Hidden, cl::init(true));
144254f889dSBrendon Cahoon 
145254f889dSBrendon Cahoon #ifndef NDEBUG
146254f889dSBrendon Cahoon static cl::opt<int> SwpLoopLimit("pipeliner-max", cl::Hidden, cl::init(-1));
147254f889dSBrendon Cahoon #endif
148254f889dSBrendon Cahoon 
149254f889dSBrendon Cahoon static cl::opt<bool> SwpIgnoreRecMII("pipeliner-ignore-recmii",
150254f889dSBrendon Cahoon                                      cl::ReallyHidden, cl::init(false),
151254f889dSBrendon Cahoon                                      cl::ZeroOrMore, cl::desc("Ignore RecMII"));
152254f889dSBrendon Cahoon 
153ba43840bSJinsong Ji static cl::opt<bool> SwpShowResMask("pipeliner-show-mask", cl::Hidden,
154ba43840bSJinsong Ji                                     cl::init(false));
155ba43840bSJinsong Ji static cl::opt<bool> SwpDebugResource("pipeliner-dbg-res", cl::Hidden,
156ba43840bSJinsong Ji                                       cl::init(false));
157ba43840bSJinsong Ji 
15893549957SJames Molloy static cl::opt<bool> EmitTestAnnotations(
15993549957SJames Molloy     "pipeliner-annotate-for-testing", cl::Hidden, cl::init(false),
16093549957SJames Molloy     cl::desc("Instead of emitting the pipelined code, annotate instructions "
16193549957SJames Molloy              "with the generated schedule for feeding into the "
16293549957SJames Molloy              "-modulo-schedule-test pass"));
16393549957SJames Molloy 
164fef9f590SJames Molloy static cl::opt<bool> ExperimentalCodeGen(
165fef9f590SJames Molloy     "pipeliner-experimental-cg", cl::Hidden, cl::init(false),
166fef9f590SJames Molloy     cl::desc(
167fef9f590SJames Molloy         "Use the experimental peeling code generator for software pipelining"));
168fef9f590SJames Molloy 
169fa2e3583SAdrian Prantl namespace llvm {
170fa2e3583SAdrian Prantl 
17162ac69d4SSumanth Gundapaneni // A command line option to enable the CopyToPhi DAG mutation.
172fa2e3583SAdrian Prantl cl::opt<bool>
17300d4c386SAleksandr Urakov     SwpEnableCopyToPhi("pipeliner-enable-copytophi", cl::ReallyHidden,
17462ac69d4SSumanth Gundapaneni                        cl::init(true), cl::ZeroOrMore,
17562ac69d4SSumanth Gundapaneni                        cl::desc("Enable CopyToPhi DAG Mutation"));
17662ac69d4SSumanth Gundapaneni 
177fa2e3583SAdrian Prantl } // end namespace llvm
178254f889dSBrendon Cahoon 
179254f889dSBrendon Cahoon unsigned SwingSchedulerDAG::Circuits::MaxPaths = 5;
180254f889dSBrendon Cahoon char MachinePipeliner::ID = 0;
181254f889dSBrendon Cahoon #ifndef NDEBUG
182254f889dSBrendon Cahoon int MachinePipeliner::NumTries = 0;
183254f889dSBrendon Cahoon #endif
184254f889dSBrendon Cahoon char &llvm::MachinePipelinerID = MachinePipeliner::ID;
18532a40564SEugene Zelenko 
1861527baabSMatthias Braun INITIALIZE_PASS_BEGIN(MachinePipeliner, DEBUG_TYPE,
187254f889dSBrendon Cahoon                       "Modulo Software Pipelining", false, false)
188254f889dSBrendon Cahoon INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass)
189254f889dSBrendon Cahoon INITIALIZE_PASS_DEPENDENCY(MachineLoopInfo)
190254f889dSBrendon Cahoon INITIALIZE_PASS_DEPENDENCY(MachineDominatorTree)
191254f889dSBrendon Cahoon INITIALIZE_PASS_DEPENDENCY(LiveIntervals)
1921527baabSMatthias Braun INITIALIZE_PASS_END(MachinePipeliner, DEBUG_TYPE,
193254f889dSBrendon Cahoon                     "Modulo Software Pipelining", false, false)
194254f889dSBrendon Cahoon 
195254f889dSBrendon Cahoon /// The "main" function for implementing Swing Modulo Scheduling.
196254f889dSBrendon Cahoon bool MachinePipeliner::runOnMachineFunction(MachineFunction &mf) {
197f1caa283SMatthias Braun   if (skipFunction(mf.getFunction()))
198254f889dSBrendon Cahoon     return false;
199254f889dSBrendon Cahoon 
200254f889dSBrendon Cahoon   if (!EnableSWP)
201254f889dSBrendon Cahoon     return false;
202254f889dSBrendon Cahoon 
203d7593ebaSArthur Eubanks   if (mf.getFunction().getAttributes().hasFnAttr(Attribute::OptimizeForSize) &&
204254f889dSBrendon Cahoon       !EnableSWPOptSize.getPosition())
205254f889dSBrendon Cahoon     return false;
206254f889dSBrendon Cahoon 
207ef2d6d99SJinsong Ji   if (!mf.getSubtarget().enableMachinePipeliner())
208ef2d6d99SJinsong Ji     return false;
209ef2d6d99SJinsong Ji 
210f6cb3bcbSJinsong Ji   // Cannot pipeline loops without instruction itineraries if we are using
211f6cb3bcbSJinsong Ji   // DFA for the pipeliner.
212f6cb3bcbSJinsong Ji   if (mf.getSubtarget().useDFAforSMS() &&
213f6cb3bcbSJinsong Ji       (!mf.getSubtarget().getInstrItineraryData() ||
214f6cb3bcbSJinsong Ji        mf.getSubtarget().getInstrItineraryData()->isEmpty()))
215f6cb3bcbSJinsong Ji     return false;
216f6cb3bcbSJinsong Ji 
217254f889dSBrendon Cahoon   MF = &mf;
218254f889dSBrendon Cahoon   MLI = &getAnalysis<MachineLoopInfo>();
219254f889dSBrendon Cahoon   MDT = &getAnalysis<MachineDominatorTree>();
22080b78a47SJinsong Ji   ORE = &getAnalysis<MachineOptimizationRemarkEmitterPass>().getORE();
221254f889dSBrendon Cahoon   TII = MF->getSubtarget().getInstrInfo();
222254f889dSBrendon Cahoon   RegClassInfo.runOnMachineFunction(*MF);
223254f889dSBrendon Cahoon 
224254f889dSBrendon Cahoon   for (auto &L : *MLI)
225254f889dSBrendon Cahoon     scheduleLoop(*L);
226254f889dSBrendon Cahoon 
227254f889dSBrendon Cahoon   return false;
228254f889dSBrendon Cahoon }
229254f889dSBrendon Cahoon 
230254f889dSBrendon Cahoon /// Attempt to perform the SMS algorithm on the specified loop. This function is
231254f889dSBrendon Cahoon /// the main entry point for the algorithm.  The function identifies candidate
232254f889dSBrendon Cahoon /// loops, calculates the minimum initiation interval, and attempts to schedule
233254f889dSBrendon Cahoon /// the loop.
234254f889dSBrendon Cahoon bool MachinePipeliner::scheduleLoop(MachineLoop &L) {
235254f889dSBrendon Cahoon   bool Changed = false;
236254f889dSBrendon Cahoon   for (auto &InnerLoop : L)
237254f889dSBrendon Cahoon     Changed |= scheduleLoop(*InnerLoop);
238254f889dSBrendon Cahoon 
239254f889dSBrendon Cahoon #ifndef NDEBUG
240254f889dSBrendon Cahoon   // Stop trying after reaching the limit (if any).
241254f889dSBrendon Cahoon   int Limit = SwpLoopLimit;
242254f889dSBrendon Cahoon   if (Limit >= 0) {
243254f889dSBrendon Cahoon     if (NumTries >= SwpLoopLimit)
244254f889dSBrendon Cahoon       return Changed;
245254f889dSBrendon Cahoon     NumTries++;
246254f889dSBrendon Cahoon   }
247254f889dSBrendon Cahoon #endif
248254f889dSBrendon Cahoon 
24959d99731SBrendon Cahoon   setPragmaPipelineOptions(L);
25059d99731SBrendon Cahoon   if (!canPipelineLoop(L)) {
25159d99731SBrendon Cahoon     LLVM_DEBUG(dbgs() << "\n!!! Can not pipeline loop.\n");
25280b78a47SJinsong Ji     ORE->emit([&]() {
25380b78a47SJinsong Ji       return MachineOptimizationRemarkMissed(DEBUG_TYPE, "canPipelineLoop",
25480b78a47SJinsong Ji                                              L.getStartLoc(), L.getHeader())
25580b78a47SJinsong Ji              << "Failed to pipeline loop";
25680b78a47SJinsong Ji     });
25780b78a47SJinsong Ji 
258254f889dSBrendon Cahoon     return Changed;
25959d99731SBrendon Cahoon   }
260254f889dSBrendon Cahoon 
261254f889dSBrendon Cahoon   ++NumTrytoPipeline;
262254f889dSBrendon Cahoon 
263254f889dSBrendon Cahoon   Changed = swingModuloScheduler(L);
264254f889dSBrendon Cahoon 
265254f889dSBrendon Cahoon   return Changed;
266254f889dSBrendon Cahoon }
267254f889dSBrendon Cahoon 
26859d99731SBrendon Cahoon void MachinePipeliner::setPragmaPipelineOptions(MachineLoop &L) {
269a04ab2ecSSumanth Gundapaneni   // Reset the pragma for the next loop in iteration.
270a04ab2ecSSumanth Gundapaneni   disabledByPragma = false;
271818cf30bSAlon Kom   II_setByPragma = 0;
272a04ab2ecSSumanth Gundapaneni 
27359d99731SBrendon Cahoon   MachineBasicBlock *LBLK = L.getTopBlock();
27459d99731SBrendon Cahoon 
27559d99731SBrendon Cahoon   if (LBLK == nullptr)
27659d99731SBrendon Cahoon     return;
27759d99731SBrendon Cahoon 
27859d99731SBrendon Cahoon   const BasicBlock *BBLK = LBLK->getBasicBlock();
27959d99731SBrendon Cahoon   if (BBLK == nullptr)
28059d99731SBrendon Cahoon     return;
28159d99731SBrendon Cahoon 
28259d99731SBrendon Cahoon   const Instruction *TI = BBLK->getTerminator();
28359d99731SBrendon Cahoon   if (TI == nullptr)
28459d99731SBrendon Cahoon     return;
28559d99731SBrendon Cahoon 
28659d99731SBrendon Cahoon   MDNode *LoopID = TI->getMetadata(LLVMContext::MD_loop);
28759d99731SBrendon Cahoon   if (LoopID == nullptr)
28859d99731SBrendon Cahoon     return;
28959d99731SBrendon Cahoon 
29059d99731SBrendon Cahoon   assert(LoopID->getNumOperands() > 0 && "requires atleast one operand");
29159d99731SBrendon Cahoon   assert(LoopID->getOperand(0) == LoopID && "invalid loop");
29259d99731SBrendon Cahoon 
29359d99731SBrendon Cahoon   for (unsigned i = 1, e = LoopID->getNumOperands(); i < e; ++i) {
29459d99731SBrendon Cahoon     MDNode *MD = dyn_cast<MDNode>(LoopID->getOperand(i));
29559d99731SBrendon Cahoon 
29659d99731SBrendon Cahoon     if (MD == nullptr)
29759d99731SBrendon Cahoon       continue;
29859d99731SBrendon Cahoon 
29959d99731SBrendon Cahoon     MDString *S = dyn_cast<MDString>(MD->getOperand(0));
30059d99731SBrendon Cahoon 
30159d99731SBrendon Cahoon     if (S == nullptr)
30259d99731SBrendon Cahoon       continue;
30359d99731SBrendon Cahoon 
30459d99731SBrendon Cahoon     if (S->getString() == "llvm.loop.pipeline.initiationinterval") {
30559d99731SBrendon Cahoon       assert(MD->getNumOperands() == 2 &&
30659d99731SBrendon Cahoon              "Pipeline initiation interval hint metadata should have two operands.");
30759d99731SBrendon Cahoon       II_setByPragma =
30859d99731SBrendon Cahoon           mdconst::extract<ConstantInt>(MD->getOperand(1))->getZExtValue();
30959d99731SBrendon Cahoon       assert(II_setByPragma >= 1 && "Pipeline initiation interval must be positive.");
31059d99731SBrendon Cahoon     } else if (S->getString() == "llvm.loop.pipeline.disable") {
31159d99731SBrendon Cahoon       disabledByPragma = true;
31259d99731SBrendon Cahoon     }
31359d99731SBrendon Cahoon   }
31459d99731SBrendon Cahoon }
31559d99731SBrendon Cahoon 
316254f889dSBrendon Cahoon /// Return true if the loop can be software pipelined.  The algorithm is
317254f889dSBrendon Cahoon /// restricted to loops with a single basic block.  Make sure that the
318254f889dSBrendon Cahoon /// branch in the loop can be analyzed.
319254f889dSBrendon Cahoon bool MachinePipeliner::canPipelineLoop(MachineLoop &L) {
32080b78a47SJinsong Ji   if (L.getNumBlocks() != 1) {
32180b78a47SJinsong Ji     ORE->emit([&]() {
32280b78a47SJinsong Ji       return MachineOptimizationRemarkAnalysis(DEBUG_TYPE, "canPipelineLoop",
32380b78a47SJinsong Ji                                                L.getStartLoc(), L.getHeader())
32480b78a47SJinsong Ji              << "Not a single basic block: "
32580b78a47SJinsong Ji              << ore::NV("NumBlocks", L.getNumBlocks());
32680b78a47SJinsong Ji     });
327254f889dSBrendon Cahoon     return false;
32880b78a47SJinsong Ji   }
329254f889dSBrendon Cahoon 
33080b78a47SJinsong Ji   if (disabledByPragma) {
33180b78a47SJinsong Ji     ORE->emit([&]() {
33280b78a47SJinsong Ji       return MachineOptimizationRemarkAnalysis(DEBUG_TYPE, "canPipelineLoop",
33380b78a47SJinsong Ji                                                L.getStartLoc(), L.getHeader())
33480b78a47SJinsong Ji              << "Disabled by Pragma.";
33580b78a47SJinsong Ji     });
33659d99731SBrendon Cahoon     return false;
33780b78a47SJinsong Ji   }
33859d99731SBrendon Cahoon 
339254f889dSBrendon Cahoon   // Check if the branch can't be understood because we can't do pipelining
340254f889dSBrendon Cahoon   // if that's the case.
341254f889dSBrendon Cahoon   LI.TBB = nullptr;
342254f889dSBrendon Cahoon   LI.FBB = nullptr;
343254f889dSBrendon Cahoon   LI.BrCond.clear();
34418e7bf5cSJinsong Ji   if (TII->analyzeBranch(*L.getHeader(), LI.TBB, LI.FBB, LI.BrCond)) {
34580b78a47SJinsong Ji     LLVM_DEBUG(dbgs() << "Unable to analyzeBranch, can NOT pipeline Loop\n");
34618e7bf5cSJinsong Ji     NumFailBranch++;
34780b78a47SJinsong Ji     ORE->emit([&]() {
34880b78a47SJinsong Ji       return MachineOptimizationRemarkAnalysis(DEBUG_TYPE, "canPipelineLoop",
34980b78a47SJinsong Ji                                                L.getStartLoc(), L.getHeader())
35080b78a47SJinsong Ji              << "The branch can't be understood";
35180b78a47SJinsong Ji     });
352254f889dSBrendon Cahoon     return false;
35318e7bf5cSJinsong Ji   }
354254f889dSBrendon Cahoon 
355254f889dSBrendon Cahoon   LI.LoopInductionVar = nullptr;
356254f889dSBrendon Cahoon   LI.LoopCompare = nullptr;
3578a74eca3SJames Molloy   if (!TII->analyzeLoopForPipelining(L.getTopBlock())) {
35880b78a47SJinsong Ji     LLVM_DEBUG(dbgs() << "Unable to analyzeLoop, can NOT pipeline Loop\n");
35918e7bf5cSJinsong Ji     NumFailLoop++;
36080b78a47SJinsong Ji     ORE->emit([&]() {
36180b78a47SJinsong Ji       return MachineOptimizationRemarkAnalysis(DEBUG_TYPE, "canPipelineLoop",
36280b78a47SJinsong Ji                                                L.getStartLoc(), L.getHeader())
36380b78a47SJinsong Ji              << "The loop structure is not supported";
36480b78a47SJinsong Ji     });
365254f889dSBrendon Cahoon     return false;
36618e7bf5cSJinsong Ji   }
367254f889dSBrendon Cahoon 
36818e7bf5cSJinsong Ji   if (!L.getLoopPreheader()) {
36980b78a47SJinsong Ji     LLVM_DEBUG(dbgs() << "Preheader not found, can NOT pipeline Loop\n");
37018e7bf5cSJinsong Ji     NumFailPreheader++;
37180b78a47SJinsong Ji     ORE->emit([&]() {
37280b78a47SJinsong Ji       return MachineOptimizationRemarkAnalysis(DEBUG_TYPE, "canPipelineLoop",
37380b78a47SJinsong Ji                                                L.getStartLoc(), L.getHeader())
37480b78a47SJinsong Ji              << "No loop preheader found";
37580b78a47SJinsong Ji     });
376254f889dSBrendon Cahoon     return false;
37718e7bf5cSJinsong Ji   }
378254f889dSBrendon Cahoon 
379c715a5d2SKrzysztof Parzyszek   // Remove any subregisters from inputs to phi nodes.
380c715a5d2SKrzysztof Parzyszek   preprocessPhiNodes(*L.getHeader());
381254f889dSBrendon Cahoon   return true;
382254f889dSBrendon Cahoon }
383254f889dSBrendon Cahoon 
384c715a5d2SKrzysztof Parzyszek void MachinePipeliner::preprocessPhiNodes(MachineBasicBlock &B) {
385c715a5d2SKrzysztof Parzyszek   MachineRegisterInfo &MRI = MF->getRegInfo();
386c715a5d2SKrzysztof Parzyszek   SlotIndexes &Slots = *getAnalysis<LiveIntervals>().getSlotIndexes();
387c715a5d2SKrzysztof Parzyszek 
388c3e698e2SKazu Hirata   for (MachineInstr &PI : B.phis()) {
389c715a5d2SKrzysztof Parzyszek     MachineOperand &DefOp = PI.getOperand(0);
390c715a5d2SKrzysztof Parzyszek     assert(DefOp.getSubReg() == 0);
391c715a5d2SKrzysztof Parzyszek     auto *RC = MRI.getRegClass(DefOp.getReg());
392c715a5d2SKrzysztof Parzyszek 
393c715a5d2SKrzysztof Parzyszek     for (unsigned i = 1, n = PI.getNumOperands(); i != n; i += 2) {
394c715a5d2SKrzysztof Parzyszek       MachineOperand &RegOp = PI.getOperand(i);
395c715a5d2SKrzysztof Parzyszek       if (RegOp.getSubReg() == 0)
396c715a5d2SKrzysztof Parzyszek         continue;
397c715a5d2SKrzysztof Parzyszek 
398c715a5d2SKrzysztof Parzyszek       // If the operand uses a subregister, replace it with a new register
399c715a5d2SKrzysztof Parzyszek       // without subregisters, and generate a copy to the new register.
4000c476111SDaniel Sanders       Register NewReg = MRI.createVirtualRegister(RC);
401c715a5d2SKrzysztof Parzyszek       MachineBasicBlock &PredB = *PI.getOperand(i+1).getMBB();
402c715a5d2SKrzysztof Parzyszek       MachineBasicBlock::iterator At = PredB.getFirstTerminator();
403c715a5d2SKrzysztof Parzyszek       const DebugLoc &DL = PredB.findDebugLoc(At);
404c715a5d2SKrzysztof Parzyszek       auto Copy = BuildMI(PredB, At, DL, TII->get(TargetOpcode::COPY), NewReg)
405c715a5d2SKrzysztof Parzyszek                     .addReg(RegOp.getReg(), getRegState(RegOp),
406c715a5d2SKrzysztof Parzyszek                             RegOp.getSubReg());
407c715a5d2SKrzysztof Parzyszek       Slots.insertMachineInstrInMaps(*Copy);
408c715a5d2SKrzysztof Parzyszek       RegOp.setReg(NewReg);
409c715a5d2SKrzysztof Parzyszek       RegOp.setSubReg(0);
410c715a5d2SKrzysztof Parzyszek     }
411c715a5d2SKrzysztof Parzyszek   }
412c715a5d2SKrzysztof Parzyszek }
413c715a5d2SKrzysztof Parzyszek 
414254f889dSBrendon Cahoon /// The SMS algorithm consists of the following main steps:
415254f889dSBrendon Cahoon /// 1. Computation and analysis of the dependence graph.
416254f889dSBrendon Cahoon /// 2. Ordering of the nodes (instructions).
417254f889dSBrendon Cahoon /// 3. Attempt to Schedule the loop.
418254f889dSBrendon Cahoon bool MachinePipeliner::swingModuloScheduler(MachineLoop &L) {
419254f889dSBrendon Cahoon   assert(L.getBlocks().size() == 1 && "SMS works on single blocks only.");
420254f889dSBrendon Cahoon 
42159d99731SBrendon Cahoon   SwingSchedulerDAG SMS(*this, L, getAnalysis<LiveIntervals>(), RegClassInfo,
42259d99731SBrendon Cahoon                         II_setByPragma);
423254f889dSBrendon Cahoon 
424254f889dSBrendon Cahoon   MachineBasicBlock *MBB = L.getHeader();
425254f889dSBrendon Cahoon   // The kernel should not include any terminator instructions.  These
426254f889dSBrendon Cahoon   // will be added back later.
427254f889dSBrendon Cahoon   SMS.startBlock(MBB);
428254f889dSBrendon Cahoon 
429254f889dSBrendon Cahoon   // Compute the number of 'real' instructions in the basic block by
430254f889dSBrendon Cahoon   // ignoring terminators.
431254f889dSBrendon Cahoon   unsigned size = MBB->size();
432254f889dSBrendon Cahoon   for (MachineBasicBlock::iterator I = MBB->getFirstTerminator(),
433254f889dSBrendon Cahoon                                    E = MBB->instr_end();
434254f889dSBrendon Cahoon        I != E; ++I, --size)
435254f889dSBrendon Cahoon     ;
436254f889dSBrendon Cahoon 
437254f889dSBrendon Cahoon   SMS.enterRegion(MBB, MBB->begin(), MBB->getFirstTerminator(), size);
438254f889dSBrendon Cahoon   SMS.schedule();
439254f889dSBrendon Cahoon   SMS.exitRegion();
440254f889dSBrendon Cahoon 
441254f889dSBrendon Cahoon   SMS.finishBlock();
442254f889dSBrendon Cahoon   return SMS.hasNewSchedule();
443254f889dSBrendon Cahoon }
444254f889dSBrendon Cahoon 
4452ce38b3fSdfukalov void MachinePipeliner::getAnalysisUsage(AnalysisUsage &AU) const {
4462ce38b3fSdfukalov   AU.addRequired<AAResultsWrapperPass>();
4472ce38b3fSdfukalov   AU.addPreserved<AAResultsWrapperPass>();
4482ce38b3fSdfukalov   AU.addRequired<MachineLoopInfo>();
4492ce38b3fSdfukalov   AU.addRequired<MachineDominatorTree>();
4502ce38b3fSdfukalov   AU.addRequired<LiveIntervals>();
4512ce38b3fSdfukalov   AU.addRequired<MachineOptimizationRemarkEmitterPass>();
4522ce38b3fSdfukalov   MachineFunctionPass::getAnalysisUsage(AU);
4532ce38b3fSdfukalov }
4542ce38b3fSdfukalov 
45559d99731SBrendon Cahoon void SwingSchedulerDAG::setMII(unsigned ResMII, unsigned RecMII) {
45659d99731SBrendon Cahoon   if (II_setByPragma > 0)
45759d99731SBrendon Cahoon     MII = II_setByPragma;
45859d99731SBrendon Cahoon   else
45959d99731SBrendon Cahoon     MII = std::max(ResMII, RecMII);
46059d99731SBrendon Cahoon }
46159d99731SBrendon Cahoon 
46259d99731SBrendon Cahoon void SwingSchedulerDAG::setMAX_II() {
46359d99731SBrendon Cahoon   if (II_setByPragma > 0)
46459d99731SBrendon Cahoon     MAX_II = II_setByPragma;
46559d99731SBrendon Cahoon   else
46659d99731SBrendon Cahoon     MAX_II = MII + 10;
46759d99731SBrendon Cahoon }
46859d99731SBrendon Cahoon 
469254f889dSBrendon Cahoon /// We override the schedule function in ScheduleDAGInstrs to implement the
470254f889dSBrendon Cahoon /// scheduling part of the Swing Modulo Scheduling algorithm.
471254f889dSBrendon Cahoon void SwingSchedulerDAG::schedule() {
472254f889dSBrendon Cahoon   AliasAnalysis *AA = &Pass.getAnalysis<AAResultsWrapperPass>().getAAResults();
473254f889dSBrendon Cahoon   buildSchedGraph(AA);
474254f889dSBrendon Cahoon   addLoopCarriedDependences(AA);
475254f889dSBrendon Cahoon   updatePhiDependences();
476254f889dSBrendon Cahoon   Topo.InitDAGTopologicalSorting();
477254f889dSBrendon Cahoon   changeDependences();
47862ac69d4SSumanth Gundapaneni   postprocessDAG();
479726e12cfSMatthias Braun   LLVM_DEBUG(dump());
480254f889dSBrendon Cahoon 
481254f889dSBrendon Cahoon   NodeSetType NodeSets;
482254f889dSBrendon Cahoon   findCircuits(NodeSets);
4834b8bcf00SRoorda, Jan-Willem   NodeSetType Circuits = NodeSets;
484254f889dSBrendon Cahoon 
485254f889dSBrendon Cahoon   // Calculate the MII.
486254f889dSBrendon Cahoon   unsigned ResMII = calculateResMII();
487254f889dSBrendon Cahoon   unsigned RecMII = calculateRecMII(NodeSets);
488254f889dSBrendon Cahoon 
489254f889dSBrendon Cahoon   fuseRecs(NodeSets);
490254f889dSBrendon Cahoon 
491254f889dSBrendon Cahoon   // This flag is used for testing and can cause correctness problems.
492254f889dSBrendon Cahoon   if (SwpIgnoreRecMII)
493254f889dSBrendon Cahoon     RecMII = 0;
494254f889dSBrendon Cahoon 
49559d99731SBrendon Cahoon   setMII(ResMII, RecMII);
49659d99731SBrendon Cahoon   setMAX_II();
49759d99731SBrendon Cahoon 
49859d99731SBrendon Cahoon   LLVM_DEBUG(dbgs() << "MII = " << MII << " MAX_II = " << MAX_II
49959d99731SBrendon Cahoon                     << " (rec=" << RecMII << ", res=" << ResMII << ")\n");
500254f889dSBrendon Cahoon 
501254f889dSBrendon Cahoon   // Can't schedule a loop without a valid MII.
50218e7bf5cSJinsong Ji   if (MII == 0) {
50380b78a47SJinsong Ji     LLVM_DEBUG(dbgs() << "Invalid Minimal Initiation Interval: 0\n");
50418e7bf5cSJinsong Ji     NumFailZeroMII++;
50580b78a47SJinsong Ji     Pass.ORE->emit([&]() {
50680b78a47SJinsong Ji       return MachineOptimizationRemarkAnalysis(
50780b78a47SJinsong Ji                  DEBUG_TYPE, "schedule", Loop.getStartLoc(), Loop.getHeader())
50880b78a47SJinsong Ji              << "Invalid Minimal Initiation Interval: 0";
50980b78a47SJinsong Ji     });
510254f889dSBrendon Cahoon     return;
51118e7bf5cSJinsong Ji   }
512254f889dSBrendon Cahoon 
513254f889dSBrendon Cahoon   // Don't pipeline large loops.
51418e7bf5cSJinsong Ji   if (SwpMaxMii != -1 && (int)MII > SwpMaxMii) {
51518e7bf5cSJinsong Ji     LLVM_DEBUG(dbgs() << "MII > " << SwpMaxMii
51618e7bf5cSJinsong Ji                       << ", we don't pipleline large loops\n");
51718e7bf5cSJinsong Ji     NumFailLargeMaxMII++;
51880b78a47SJinsong Ji     Pass.ORE->emit([&]() {
51980b78a47SJinsong Ji       return MachineOptimizationRemarkAnalysis(
52080b78a47SJinsong Ji                  DEBUG_TYPE, "schedule", Loop.getStartLoc(), Loop.getHeader())
52180b78a47SJinsong Ji              << "Minimal Initiation Interval too large: "
52280b78a47SJinsong Ji              << ore::NV("MII", (int)MII) << " > "
52380b78a47SJinsong Ji              << ore::NV("SwpMaxMii", SwpMaxMii) << "."
52480b78a47SJinsong Ji              << "Refer to -pipeliner-max-mii.";
52580b78a47SJinsong Ji     });
526254f889dSBrendon Cahoon     return;
52718e7bf5cSJinsong Ji   }
528254f889dSBrendon Cahoon 
529254f889dSBrendon Cahoon   computeNodeFunctions(NodeSets);
530254f889dSBrendon Cahoon 
531254f889dSBrendon Cahoon   registerPressureFilter(NodeSets);
532254f889dSBrendon Cahoon 
533254f889dSBrendon Cahoon   colocateNodeSets(NodeSets);
534254f889dSBrendon Cahoon 
535254f889dSBrendon Cahoon   checkNodeSets(NodeSets);
536254f889dSBrendon Cahoon 
537d34e60caSNicola Zaghen   LLVM_DEBUG({
538254f889dSBrendon Cahoon     for (auto &I : NodeSets) {
539254f889dSBrendon Cahoon       dbgs() << "  Rec NodeSet ";
540254f889dSBrendon Cahoon       I.dump();
541254f889dSBrendon Cahoon     }
542254f889dSBrendon Cahoon   });
543254f889dSBrendon Cahoon 
544efd94c56SFangrui Song   llvm::stable_sort(NodeSets, std::greater<NodeSet>());
545254f889dSBrendon Cahoon 
546254f889dSBrendon Cahoon   groupRemainingNodes(NodeSets);
547254f889dSBrendon Cahoon 
548254f889dSBrendon Cahoon   removeDuplicateNodes(NodeSets);
549254f889dSBrendon Cahoon 
550d34e60caSNicola Zaghen   LLVM_DEBUG({
551254f889dSBrendon Cahoon     for (auto &I : NodeSets) {
552254f889dSBrendon Cahoon       dbgs() << "  NodeSet ";
553254f889dSBrendon Cahoon       I.dump();
554254f889dSBrendon Cahoon     }
555254f889dSBrendon Cahoon   });
556254f889dSBrendon Cahoon 
557254f889dSBrendon Cahoon   computeNodeOrder(NodeSets);
558254f889dSBrendon Cahoon 
5594b8bcf00SRoorda, Jan-Willem   // check for node order issues
5604b8bcf00SRoorda, Jan-Willem   checkValidNodeOrder(Circuits);
5614b8bcf00SRoorda, Jan-Willem 
562254f889dSBrendon Cahoon   SMSchedule Schedule(Pass.MF);
563254f889dSBrendon Cahoon   Scheduled = schedulePipeline(Schedule);
564254f889dSBrendon Cahoon 
56518e7bf5cSJinsong Ji   if (!Scheduled){
56618e7bf5cSJinsong Ji     LLVM_DEBUG(dbgs() << "No schedule found, return\n");
56718e7bf5cSJinsong Ji     NumFailNoSchedule++;
56880b78a47SJinsong Ji     Pass.ORE->emit([&]() {
56980b78a47SJinsong Ji       return MachineOptimizationRemarkAnalysis(
57080b78a47SJinsong Ji                  DEBUG_TYPE, "schedule", Loop.getStartLoc(), Loop.getHeader())
57180b78a47SJinsong Ji              << "Unable to find schedule";
57280b78a47SJinsong Ji     });
573254f889dSBrendon Cahoon     return;
57418e7bf5cSJinsong Ji   }
575254f889dSBrendon Cahoon 
576254f889dSBrendon Cahoon   unsigned numStages = Schedule.getMaxStageCount();
577254f889dSBrendon Cahoon   // No need to generate pipeline if there are no overlapped iterations.
57818e7bf5cSJinsong Ji   if (numStages == 0) {
57980b78a47SJinsong Ji     LLVM_DEBUG(dbgs() << "No overlapped iterations, skip.\n");
58018e7bf5cSJinsong Ji     NumFailZeroStage++;
58180b78a47SJinsong Ji     Pass.ORE->emit([&]() {
58280b78a47SJinsong Ji       return MachineOptimizationRemarkAnalysis(
58380b78a47SJinsong Ji                  DEBUG_TYPE, "schedule", Loop.getStartLoc(), Loop.getHeader())
58480b78a47SJinsong Ji              << "No need to pipeline - no overlapped iterations in schedule.";
58580b78a47SJinsong Ji     });
586254f889dSBrendon Cahoon     return;
58718e7bf5cSJinsong Ji   }
588254f889dSBrendon Cahoon   // Check that the maximum stage count is less than user-defined limit.
58918e7bf5cSJinsong Ji   if (SwpMaxStages > -1 && (int)numStages > SwpMaxStages) {
59018e7bf5cSJinsong Ji     LLVM_DEBUG(dbgs() << "numStages:" << numStages << ">" << SwpMaxStages
59118e7bf5cSJinsong Ji                       << " : too many stages, abort\n");
59218e7bf5cSJinsong Ji     NumFailLargeMaxStage++;
59380b78a47SJinsong Ji     Pass.ORE->emit([&]() {
59480b78a47SJinsong Ji       return MachineOptimizationRemarkAnalysis(
59580b78a47SJinsong Ji                  DEBUG_TYPE, "schedule", Loop.getStartLoc(), Loop.getHeader())
59680b78a47SJinsong Ji              << "Too many stages in schedule: "
59780b78a47SJinsong Ji              << ore::NV("numStages", (int)numStages) << " > "
59880b78a47SJinsong Ji              << ore::NV("SwpMaxStages", SwpMaxStages)
59980b78a47SJinsong Ji              << ". Refer to -pipeliner-max-stages.";
60080b78a47SJinsong Ji     });
601254f889dSBrendon Cahoon     return;
60218e7bf5cSJinsong Ji   }
603254f889dSBrendon Cahoon 
60480b78a47SJinsong Ji   Pass.ORE->emit([&]() {
60580b78a47SJinsong Ji     return MachineOptimizationRemark(DEBUG_TYPE, "schedule", Loop.getStartLoc(),
60680b78a47SJinsong Ji                                      Loop.getHeader())
60780b78a47SJinsong Ji            << "Pipelined succesfully!";
60880b78a47SJinsong Ji   });
60980b78a47SJinsong Ji 
610790a779fSJames Molloy   // Generate the schedule as a ModuloSchedule.
611790a779fSJames Molloy   DenseMap<MachineInstr *, int> Cycles, Stages;
612790a779fSJames Molloy   std::vector<MachineInstr *> OrderedInsts;
613790a779fSJames Molloy   for (int Cycle = Schedule.getFirstCycle(); Cycle <= Schedule.getFinalCycle();
614790a779fSJames Molloy        ++Cycle) {
615790a779fSJames Molloy     for (SUnit *SU : Schedule.getInstructions(Cycle)) {
616790a779fSJames Molloy       OrderedInsts.push_back(SU->getInstr());
617790a779fSJames Molloy       Cycles[SU->getInstr()] = Cycle;
618790a779fSJames Molloy       Stages[SU->getInstr()] = Schedule.stageScheduled(SU);
619790a779fSJames Molloy     }
620790a779fSJames Molloy   }
621790a779fSJames Molloy   DenseMap<MachineInstr *, std::pair<unsigned, int64_t>> NewInstrChanges;
622790a779fSJames Molloy   for (auto &KV : NewMIs) {
623790a779fSJames Molloy     Cycles[KV.first] = Cycles[KV.second];
624790a779fSJames Molloy     Stages[KV.first] = Stages[KV.second];
625790a779fSJames Molloy     NewInstrChanges[KV.first] = InstrChanges[getSUnit(KV.first)];
626790a779fSJames Molloy   }
627790a779fSJames Molloy 
628790a779fSJames Molloy   ModuloSchedule MS(MF, &Loop, std::move(OrderedInsts), std::move(Cycles),
629790a779fSJames Molloy                     std::move(Stages));
63093549957SJames Molloy   if (EmitTestAnnotations) {
63193549957SJames Molloy     assert(NewInstrChanges.empty() &&
63293549957SJames Molloy            "Cannot serialize a schedule with InstrChanges!");
63393549957SJames Molloy     ModuloScheduleTestAnnotater MSTI(MF, MS);
63493549957SJames Molloy     MSTI.annotate();
63593549957SJames Molloy     return;
63693549957SJames Molloy   }
637fef9f590SJames Molloy   // The experimental code generator can't work if there are InstChanges.
638fef9f590SJames Molloy   if (ExperimentalCodeGen && NewInstrChanges.empty()) {
639fef9f590SJames Molloy     PeelingModuloScheduleExpander MSE(MF, MS, &LIS);
6409026518eSJames Molloy     MSE.expand();
641fef9f590SJames Molloy   } else {
642790a779fSJames Molloy     ModuloScheduleExpander MSE(MF, MS, LIS, std::move(NewInstrChanges));
643790a779fSJames Molloy     MSE.expand();
644fef9f590SJames Molloy     MSE.cleanup();
645fef9f590SJames Molloy   }
646254f889dSBrendon Cahoon   ++NumPipelined;
647254f889dSBrendon Cahoon }
648254f889dSBrendon Cahoon 
649254f889dSBrendon Cahoon /// Clean up after the software pipeliner runs.
650254f889dSBrendon Cahoon void SwingSchedulerDAG::finishBlock() {
651790a779fSJames Molloy   for (auto &KV : NewMIs)
652b0127424SMircea Trofin     MF.deleteMachineInstr(KV.second);
653254f889dSBrendon Cahoon   NewMIs.clear();
654254f889dSBrendon Cahoon 
655254f889dSBrendon Cahoon   // Call the superclass.
656254f889dSBrendon Cahoon   ScheduleDAGInstrs::finishBlock();
657254f889dSBrendon Cahoon }
658254f889dSBrendon Cahoon 
659254f889dSBrendon Cahoon /// Return the register values for  the operands of a Phi instruction.
660254f889dSBrendon Cahoon /// This function assume the instruction is a Phi.
661254f889dSBrendon Cahoon static void getPhiRegs(MachineInstr &Phi, MachineBasicBlock *Loop,
662254f889dSBrendon Cahoon                        unsigned &InitVal, unsigned &LoopVal) {
663254f889dSBrendon Cahoon   assert(Phi.isPHI() && "Expecting a Phi.");
664254f889dSBrendon Cahoon 
665254f889dSBrendon Cahoon   InitVal = 0;
666254f889dSBrendon Cahoon   LoopVal = 0;
667254f889dSBrendon Cahoon   for (unsigned i = 1, e = Phi.getNumOperands(); i != e; i += 2)
668254f889dSBrendon Cahoon     if (Phi.getOperand(i + 1).getMBB() != Loop)
669254f889dSBrendon Cahoon       InitVal = Phi.getOperand(i).getReg();
670fbfb19b1SSimon Pilgrim     else
671254f889dSBrendon Cahoon       LoopVal = Phi.getOperand(i).getReg();
672254f889dSBrendon Cahoon 
673254f889dSBrendon Cahoon   assert(InitVal != 0 && LoopVal != 0 && "Unexpected Phi structure.");
674254f889dSBrendon Cahoon }
675254f889dSBrendon Cahoon 
6768f976ba0SHiroshi Inoue /// Return the Phi register value that comes the loop block.
677254f889dSBrendon Cahoon static unsigned getLoopPhiReg(MachineInstr &Phi, MachineBasicBlock *LoopBB) {
678254f889dSBrendon Cahoon   for (unsigned i = 1, e = Phi.getNumOperands(); i != e; i += 2)
679254f889dSBrendon Cahoon     if (Phi.getOperand(i + 1).getMBB() == LoopBB)
680254f889dSBrendon Cahoon       return Phi.getOperand(i).getReg();
681254f889dSBrendon Cahoon   return 0;
682254f889dSBrendon Cahoon }
683254f889dSBrendon Cahoon 
684254f889dSBrendon Cahoon /// Return true if SUb can be reached from SUa following the chain edges.
685254f889dSBrendon Cahoon static bool isSuccOrder(SUnit *SUa, SUnit *SUb) {
686254f889dSBrendon Cahoon   SmallPtrSet<SUnit *, 8> Visited;
687254f889dSBrendon Cahoon   SmallVector<SUnit *, 8> Worklist;
688254f889dSBrendon Cahoon   Worklist.push_back(SUa);
689254f889dSBrendon Cahoon   while (!Worklist.empty()) {
690254f889dSBrendon Cahoon     const SUnit *SU = Worklist.pop_back_val();
691254f889dSBrendon Cahoon     for (auto &SI : SU->Succs) {
692254f889dSBrendon Cahoon       SUnit *SuccSU = SI.getSUnit();
693254f889dSBrendon Cahoon       if (SI.getKind() == SDep::Order) {
694254f889dSBrendon Cahoon         if (Visited.count(SuccSU))
695254f889dSBrendon Cahoon           continue;
696254f889dSBrendon Cahoon         if (SuccSU == SUb)
697254f889dSBrendon Cahoon           return true;
698254f889dSBrendon Cahoon         Worklist.push_back(SuccSU);
699254f889dSBrendon Cahoon         Visited.insert(SuccSU);
700254f889dSBrendon Cahoon       }
701254f889dSBrendon Cahoon     }
702254f889dSBrendon Cahoon   }
703254f889dSBrendon Cahoon   return false;
704254f889dSBrendon Cahoon }
705254f889dSBrendon Cahoon 
706254f889dSBrendon Cahoon /// Return true if the instruction causes a chain between memory
707254f889dSBrendon Cahoon /// references before and after it.
708254f889dSBrendon Cahoon static bool isDependenceBarrier(MachineInstr &MI, AliasAnalysis *AA) {
7096c5d5ce5SUlrich Weigand   return MI.isCall() || MI.mayRaiseFPException() ||
7106c5d5ce5SUlrich Weigand          MI.hasUnmodeledSideEffects() ||
711254f889dSBrendon Cahoon          (MI.hasOrderedMemoryRef() &&
712d98cf00cSJustin Lebar           (!MI.mayLoad() || !MI.isDereferenceableInvariantLoad(AA)));
713254f889dSBrendon Cahoon }
714254f889dSBrendon Cahoon 
715254f889dSBrendon Cahoon /// Return the underlying objects for the memory references of an instruction.
716254f889dSBrendon Cahoon /// This function calls the code in ValueTracking, but first checks that the
717254f889dSBrendon Cahoon /// instruction has a memory operand.
71871e8c6f2SBjorn Pettersson static void getUnderlyingObjects(const MachineInstr *MI,
719b0eb40caSVitaly Buka                                  SmallVectorImpl<const Value *> &Objs) {
720254f889dSBrendon Cahoon   if (!MI->hasOneMemOperand())
721254f889dSBrendon Cahoon     return;
722254f889dSBrendon Cahoon   MachineMemOperand *MM = *MI->memoperands_begin();
723254f889dSBrendon Cahoon   if (!MM->getValue())
724254f889dSBrendon Cahoon     return;
725b0eb40caSVitaly Buka   getUnderlyingObjects(MM->getValue(), Objs);
72671e8c6f2SBjorn Pettersson   for (const Value *V : Objs) {
7279f041b18SKrzysztof Parzyszek     if (!isIdentifiedObject(V)) {
7289f041b18SKrzysztof Parzyszek       Objs.clear();
7299f041b18SKrzysztof Parzyszek       return;
7309f041b18SKrzysztof Parzyszek     }
7319f041b18SKrzysztof Parzyszek     Objs.push_back(V);
7329f041b18SKrzysztof Parzyszek   }
733254f889dSBrendon Cahoon }
734254f889dSBrendon Cahoon 
735254f889dSBrendon Cahoon /// Add a chain edge between a load and store if the store can be an
736254f889dSBrendon Cahoon /// alias of the load on a subsequent iteration, i.e., a loop carried
737254f889dSBrendon Cahoon /// dependence. This code is very similar to the code in ScheduleDAGInstrs
738254f889dSBrendon Cahoon /// but that code doesn't create loop carried dependences.
739254f889dSBrendon Cahoon void SwingSchedulerDAG::addLoopCarriedDependences(AliasAnalysis *AA) {
74071e8c6f2SBjorn Pettersson   MapVector<const Value *, SmallVector<SUnit *, 4>> PendingLoads;
7419f041b18SKrzysztof Parzyszek   Value *UnknownValue =
7429f041b18SKrzysztof Parzyszek     UndefValue::get(Type::getVoidTy(MF.getFunction().getContext()));
743254f889dSBrendon Cahoon   for (auto &SU : SUnits) {
744254f889dSBrendon Cahoon     MachineInstr &MI = *SU.getInstr();
745254f889dSBrendon Cahoon     if (isDependenceBarrier(MI, AA))
746254f889dSBrendon Cahoon       PendingLoads.clear();
747254f889dSBrendon Cahoon     else if (MI.mayLoad()) {
74871e8c6f2SBjorn Pettersson       SmallVector<const Value *, 4> Objs;
749b0eb40caSVitaly Buka       ::getUnderlyingObjects(&MI, Objs);
7509f041b18SKrzysztof Parzyszek       if (Objs.empty())
7519f041b18SKrzysztof Parzyszek         Objs.push_back(UnknownValue);
752254f889dSBrendon Cahoon       for (auto V : Objs) {
753254f889dSBrendon Cahoon         SmallVector<SUnit *, 4> &SUs = PendingLoads[V];
754254f889dSBrendon Cahoon         SUs.push_back(&SU);
755254f889dSBrendon Cahoon       }
756254f889dSBrendon Cahoon     } else if (MI.mayStore()) {
75771e8c6f2SBjorn Pettersson       SmallVector<const Value *, 4> Objs;
758b0eb40caSVitaly Buka       ::getUnderlyingObjects(&MI, Objs);
7599f041b18SKrzysztof Parzyszek       if (Objs.empty())
7609f041b18SKrzysztof Parzyszek         Objs.push_back(UnknownValue);
761254f889dSBrendon Cahoon       for (auto V : Objs) {
76271e8c6f2SBjorn Pettersson         MapVector<const Value *, SmallVector<SUnit *, 4>>::iterator I =
763254f889dSBrendon Cahoon             PendingLoads.find(V);
764254f889dSBrendon Cahoon         if (I == PendingLoads.end())
765254f889dSBrendon Cahoon           continue;
766254f889dSBrendon Cahoon         for (auto Load : I->second) {
767254f889dSBrendon Cahoon           if (isSuccOrder(Load, &SU))
768254f889dSBrendon Cahoon             continue;
769254f889dSBrendon Cahoon           MachineInstr &LdMI = *Load->getInstr();
770254f889dSBrendon Cahoon           // First, perform the cheaper check that compares the base register.
771254f889dSBrendon Cahoon           // If they are the same and the load offset is less than the store
772254f889dSBrendon Cahoon           // offset, then mark the dependence as loop carried potentially.
773238c9d63SBjorn Pettersson           const MachineOperand *BaseOp1, *BaseOp2;
774254f889dSBrendon Cahoon           int64_t Offset1, Offset2;
7758fbc9258SSander de Smalen           bool Offset1IsScalable, Offset2IsScalable;
7768fbc9258SSander de Smalen           if (TII->getMemOperandWithOffset(LdMI, BaseOp1, Offset1,
7778fbc9258SSander de Smalen                                            Offset1IsScalable, TRI) &&
7788fbc9258SSander de Smalen               TII->getMemOperandWithOffset(MI, BaseOp2, Offset2,
7798fbc9258SSander de Smalen                                            Offset2IsScalable, TRI)) {
780d7eebd6dSFrancis Visoiu Mistrih             if (BaseOp1->isIdenticalTo(*BaseOp2) &&
7818fbc9258SSander de Smalen                 Offset1IsScalable == Offset2IsScalable &&
782d7eebd6dSFrancis Visoiu Mistrih                 (int)Offset1 < (int)Offset2) {
783f5524f04SChangpeng Fang               assert(TII->areMemAccessesTriviallyDisjoint(LdMI, MI) &&
784254f889dSBrendon Cahoon                      "What happened to the chain edge?");
785c715a5d2SKrzysztof Parzyszek               SDep Dep(Load, SDep::Barrier);
786c715a5d2SKrzysztof Parzyszek               Dep.setLatency(1);
787c715a5d2SKrzysztof Parzyszek               SU.addPred(Dep);
788254f889dSBrendon Cahoon               continue;
789254f889dSBrendon Cahoon             }
7909f041b18SKrzysztof Parzyszek           }
791254f889dSBrendon Cahoon           // Second, the more expensive check that uses alias analysis on the
792254f889dSBrendon Cahoon           // base registers. If they alias, and the load offset is less than
793254f889dSBrendon Cahoon           // the store offset, the mark the dependence as loop carried.
794254f889dSBrendon Cahoon           if (!AA) {
795c715a5d2SKrzysztof Parzyszek             SDep Dep(Load, SDep::Barrier);
796c715a5d2SKrzysztof Parzyszek             Dep.setLatency(1);
797c715a5d2SKrzysztof Parzyszek             SU.addPred(Dep);
798254f889dSBrendon Cahoon             continue;
799254f889dSBrendon Cahoon           }
800254f889dSBrendon Cahoon           MachineMemOperand *MMO1 = *LdMI.memoperands_begin();
801254f889dSBrendon Cahoon           MachineMemOperand *MMO2 = *MI.memoperands_begin();
802254f889dSBrendon Cahoon           if (!MMO1->getValue() || !MMO2->getValue()) {
803c715a5d2SKrzysztof Parzyszek             SDep Dep(Load, SDep::Barrier);
804c715a5d2SKrzysztof Parzyszek             Dep.setLatency(1);
805c715a5d2SKrzysztof Parzyszek             SU.addPred(Dep);
806254f889dSBrendon Cahoon             continue;
807254f889dSBrendon Cahoon           }
808254f889dSBrendon Cahoon           if (MMO1->getValue() == MMO2->getValue() &&
809254f889dSBrendon Cahoon               MMO1->getOffset() <= MMO2->getOffset()) {
810c715a5d2SKrzysztof Parzyszek             SDep Dep(Load, SDep::Barrier);
811c715a5d2SKrzysztof Parzyszek             Dep.setLatency(1);
812c715a5d2SKrzysztof Parzyszek             SU.addPred(Dep);
813254f889dSBrendon Cahoon             continue;
814254f889dSBrendon Cahoon           }
815d0660797Sdfukalov           if (!AA->isNoAlias(
8164df8efceSNikita Popov                   MemoryLocation::getAfter(MMO1->getValue(), MMO1->getAAInfo()),
817d0660797Sdfukalov                   MemoryLocation::getAfter(MMO2->getValue(),
818d0660797Sdfukalov                                            MMO2->getAAInfo()))) {
819c715a5d2SKrzysztof Parzyszek             SDep Dep(Load, SDep::Barrier);
820c715a5d2SKrzysztof Parzyszek             Dep.setLatency(1);
821c715a5d2SKrzysztof Parzyszek             SU.addPred(Dep);
822c715a5d2SKrzysztof Parzyszek           }
823254f889dSBrendon Cahoon         }
824254f889dSBrendon Cahoon       }
825254f889dSBrendon Cahoon     }
826254f889dSBrendon Cahoon   }
827254f889dSBrendon Cahoon }
828254f889dSBrendon Cahoon 
829254f889dSBrendon Cahoon /// Update the phi dependences to the DAG because ScheduleDAGInstrs no longer
830254f889dSBrendon Cahoon /// processes dependences for PHIs. This function adds true dependences
831254f889dSBrendon Cahoon /// from a PHI to a use, and a loop carried dependence from the use to the
832254f889dSBrendon Cahoon /// PHI. The loop carried dependence is represented as an anti dependence
833254f889dSBrendon Cahoon /// edge. This function also removes chain dependences between unrelated
834254f889dSBrendon Cahoon /// PHIs.
835254f889dSBrendon Cahoon void SwingSchedulerDAG::updatePhiDependences() {
836254f889dSBrendon Cahoon   SmallVector<SDep, 4> RemoveDeps;
837254f889dSBrendon Cahoon   const TargetSubtargetInfo &ST = MF.getSubtarget<TargetSubtargetInfo>();
838254f889dSBrendon Cahoon 
839254f889dSBrendon Cahoon   // Iterate over each DAG node.
840254f889dSBrendon Cahoon   for (SUnit &I : SUnits) {
841254f889dSBrendon Cahoon     RemoveDeps.clear();
842254f889dSBrendon Cahoon     // Set to true if the instruction has an operand defined by a Phi.
843254f889dSBrendon Cahoon     unsigned HasPhiUse = 0;
844254f889dSBrendon Cahoon     unsigned HasPhiDef = 0;
845254f889dSBrendon Cahoon     MachineInstr *MI = I.getInstr();
846254f889dSBrendon Cahoon     // Iterate over each operand, and we process the definitions.
847254f889dSBrendon Cahoon     for (MachineInstr::mop_iterator MOI = MI->operands_begin(),
848254f889dSBrendon Cahoon                                     MOE = MI->operands_end();
849254f889dSBrendon Cahoon          MOI != MOE; ++MOI) {
850254f889dSBrendon Cahoon       if (!MOI->isReg())
851254f889dSBrendon Cahoon         continue;
8520c476111SDaniel Sanders       Register Reg = MOI->getReg();
853254f889dSBrendon Cahoon       if (MOI->isDef()) {
854254f889dSBrendon Cahoon         // If the register is used by a Phi, then create an anti dependence.
855254f889dSBrendon Cahoon         for (MachineRegisterInfo::use_instr_iterator
856254f889dSBrendon Cahoon                  UI = MRI.use_instr_begin(Reg),
857254f889dSBrendon Cahoon                  UE = MRI.use_instr_end();
858254f889dSBrendon Cahoon              UI != UE; ++UI) {
859254f889dSBrendon Cahoon           MachineInstr *UseMI = &*UI;
860254f889dSBrendon Cahoon           SUnit *SU = getSUnit(UseMI);
861cdc71612SEugene Zelenko           if (SU != nullptr && UseMI->isPHI()) {
862254f889dSBrendon Cahoon             if (!MI->isPHI()) {
863254f889dSBrendon Cahoon               SDep Dep(SU, SDep::Anti, Reg);
864c715a5d2SKrzysztof Parzyszek               Dep.setLatency(1);
865254f889dSBrendon Cahoon               I.addPred(Dep);
866254f889dSBrendon Cahoon             } else {
867254f889dSBrendon Cahoon               HasPhiDef = Reg;
868254f889dSBrendon Cahoon               // Add a chain edge to a dependent Phi that isn't an existing
869254f889dSBrendon Cahoon               // predecessor.
870254f889dSBrendon Cahoon               if (SU->NodeNum < I.NodeNum && !I.isPred(SU))
871254f889dSBrendon Cahoon                 I.addPred(SDep(SU, SDep::Barrier));
872254f889dSBrendon Cahoon             }
873254f889dSBrendon Cahoon           }
874254f889dSBrendon Cahoon         }
875254f889dSBrendon Cahoon       } else if (MOI->isUse()) {
876254f889dSBrendon Cahoon         // If the register is defined by a Phi, then create a true dependence.
877254f889dSBrendon Cahoon         MachineInstr *DefMI = MRI.getUniqueVRegDef(Reg);
878cdc71612SEugene Zelenko         if (DefMI == nullptr)
879254f889dSBrendon Cahoon           continue;
880254f889dSBrendon Cahoon         SUnit *SU = getSUnit(DefMI);
881cdc71612SEugene Zelenko         if (SU != nullptr && DefMI->isPHI()) {
882254f889dSBrendon Cahoon           if (!MI->isPHI()) {
883254f889dSBrendon Cahoon             SDep Dep(SU, SDep::Data, Reg);
884254f889dSBrendon Cahoon             Dep.setLatency(0);
885c819ef96SFraser Cormack             ST.adjustSchedDependency(SU, 0, &I, MI->getOperandNo(MOI), Dep);
886254f889dSBrendon Cahoon             I.addPred(Dep);
887254f889dSBrendon Cahoon           } else {
888254f889dSBrendon Cahoon             HasPhiUse = Reg;
889254f889dSBrendon Cahoon             // Add a chain edge to a dependent Phi that isn't an existing
890254f889dSBrendon Cahoon             // predecessor.
891254f889dSBrendon Cahoon             if (SU->NodeNum < I.NodeNum && !I.isPred(SU))
892254f889dSBrendon Cahoon               I.addPred(SDep(SU, SDep::Barrier));
893254f889dSBrendon Cahoon           }
894254f889dSBrendon Cahoon         }
895254f889dSBrendon Cahoon       }
896254f889dSBrendon Cahoon     }
897254f889dSBrendon Cahoon     // Remove order dependences from an unrelated Phi.
898254f889dSBrendon Cahoon     if (!SwpPruneDeps)
899254f889dSBrendon Cahoon       continue;
900254f889dSBrendon Cahoon     for (auto &PI : I.Preds) {
901254f889dSBrendon Cahoon       MachineInstr *PMI = PI.getSUnit()->getInstr();
902254f889dSBrendon Cahoon       if (PMI->isPHI() && PI.getKind() == SDep::Order) {
903254f889dSBrendon Cahoon         if (I.getInstr()->isPHI()) {
904254f889dSBrendon Cahoon           if (PMI->getOperand(0).getReg() == HasPhiUse)
905254f889dSBrendon Cahoon             continue;
906254f889dSBrendon Cahoon           if (getLoopPhiReg(*PMI, PMI->getParent()) == HasPhiDef)
907254f889dSBrendon Cahoon             continue;
908254f889dSBrendon Cahoon         }
909254f889dSBrendon Cahoon         RemoveDeps.push_back(PI);
910254f889dSBrendon Cahoon       }
911254f889dSBrendon Cahoon     }
912254f889dSBrendon Cahoon     for (int i = 0, e = RemoveDeps.size(); i != e; ++i)
913254f889dSBrendon Cahoon       I.removePred(RemoveDeps[i]);
914254f889dSBrendon Cahoon   }
915254f889dSBrendon Cahoon }
916254f889dSBrendon Cahoon 
917254f889dSBrendon Cahoon /// Iterate over each DAG node and see if we can change any dependences
918254f889dSBrendon Cahoon /// in order to reduce the recurrence MII.
919254f889dSBrendon Cahoon void SwingSchedulerDAG::changeDependences() {
920254f889dSBrendon Cahoon   // See if an instruction can use a value from the previous iteration.
921254f889dSBrendon Cahoon   // If so, we update the base and offset of the instruction and change
922254f889dSBrendon Cahoon   // the dependences.
923254f889dSBrendon Cahoon   for (SUnit &I : SUnits) {
924254f889dSBrendon Cahoon     unsigned BasePos = 0, OffsetPos = 0, NewBase = 0;
925254f889dSBrendon Cahoon     int64_t NewOffset = 0;
926254f889dSBrendon Cahoon     if (!canUseLastOffsetValue(I.getInstr(), BasePos, OffsetPos, NewBase,
927254f889dSBrendon Cahoon                                NewOffset))
928254f889dSBrendon Cahoon       continue;
929254f889dSBrendon Cahoon 
930254f889dSBrendon Cahoon     // Get the MI and SUnit for the instruction that defines the original base.
9310c476111SDaniel Sanders     Register OrigBase = I.getInstr()->getOperand(BasePos).getReg();
932254f889dSBrendon Cahoon     MachineInstr *DefMI = MRI.getUniqueVRegDef(OrigBase);
933254f889dSBrendon Cahoon     if (!DefMI)
934254f889dSBrendon Cahoon       continue;
935254f889dSBrendon Cahoon     SUnit *DefSU = getSUnit(DefMI);
936254f889dSBrendon Cahoon     if (!DefSU)
937254f889dSBrendon Cahoon       continue;
938254f889dSBrendon Cahoon     // Get the MI and SUnit for the instruction that defins the new base.
939254f889dSBrendon Cahoon     MachineInstr *LastMI = MRI.getUniqueVRegDef(NewBase);
940254f889dSBrendon Cahoon     if (!LastMI)
941254f889dSBrendon Cahoon       continue;
942254f889dSBrendon Cahoon     SUnit *LastSU = getSUnit(LastMI);
943254f889dSBrendon Cahoon     if (!LastSU)
944254f889dSBrendon Cahoon       continue;
945254f889dSBrendon Cahoon 
946254f889dSBrendon Cahoon     if (Topo.IsReachable(&I, LastSU))
947254f889dSBrendon Cahoon       continue;
948254f889dSBrendon Cahoon 
949254f889dSBrendon Cahoon     // Remove the dependence. The value now depends on a prior iteration.
950254f889dSBrendon Cahoon     SmallVector<SDep, 4> Deps;
9513279943aSKazu Hirata     for (const SDep &P : I.Preds)
9523279943aSKazu Hirata       if (P.getSUnit() == DefSU)
9533279943aSKazu Hirata         Deps.push_back(P);
954254f889dSBrendon Cahoon     for (int i = 0, e = Deps.size(); i != e; i++) {
955254f889dSBrendon Cahoon       Topo.RemovePred(&I, Deps[i].getSUnit());
956254f889dSBrendon Cahoon       I.removePred(Deps[i]);
957254f889dSBrendon Cahoon     }
958254f889dSBrendon Cahoon     // Remove the chain dependence between the instructions.
959254f889dSBrendon Cahoon     Deps.clear();
960254f889dSBrendon Cahoon     for (auto &P : LastSU->Preds)
961254f889dSBrendon Cahoon       if (P.getSUnit() == &I && P.getKind() == SDep::Order)
962254f889dSBrendon Cahoon         Deps.push_back(P);
963254f889dSBrendon Cahoon     for (int i = 0, e = Deps.size(); i != e; i++) {
964254f889dSBrendon Cahoon       Topo.RemovePred(LastSU, Deps[i].getSUnit());
965254f889dSBrendon Cahoon       LastSU->removePred(Deps[i]);
966254f889dSBrendon Cahoon     }
967254f889dSBrendon Cahoon 
968254f889dSBrendon Cahoon     // Add a dependence between the new instruction and the instruction
969254f889dSBrendon Cahoon     // that defines the new base.
970254f889dSBrendon Cahoon     SDep Dep(&I, SDep::Anti, NewBase);
9718916e438SSumanth Gundapaneni     Topo.AddPred(LastSU, &I);
972254f889dSBrendon Cahoon     LastSU->addPred(Dep);
973254f889dSBrendon Cahoon 
974254f889dSBrendon Cahoon     // Remember the base and offset information so that we can update the
975254f889dSBrendon Cahoon     // instruction during code generation.
976254f889dSBrendon Cahoon     InstrChanges[&I] = std::make_pair(NewBase, NewOffset);
977254f889dSBrendon Cahoon   }
978254f889dSBrendon Cahoon }
979254f889dSBrendon Cahoon 
980254f889dSBrendon Cahoon namespace {
981cdc71612SEugene Zelenko 
982254f889dSBrendon Cahoon // FuncUnitSorter - Comparison operator used to sort instructions by
983254f889dSBrendon Cahoon // the number of functional unit choices.
984254f889dSBrendon Cahoon struct FuncUnitSorter {
985254f889dSBrendon Cahoon   const InstrItineraryData *InstrItins;
986f6cb3bcbSJinsong Ji   const MCSubtargetInfo *STI;
987c3f36accSBevin Hansson   DenseMap<InstrStage::FuncUnits, unsigned> Resources;
988254f889dSBrendon Cahoon 
989f6cb3bcbSJinsong Ji   FuncUnitSorter(const TargetSubtargetInfo &TSI)
990f6cb3bcbSJinsong Ji       : InstrItins(TSI.getInstrItineraryData()), STI(&TSI) {}
99132a40564SEugene Zelenko 
992254f889dSBrendon Cahoon   // Compute the number of functional unit alternatives needed
993254f889dSBrendon Cahoon   // at each stage, and take the minimum value. We prioritize the
994254f889dSBrendon Cahoon   // instructions by the least number of choices first.
995c3f36accSBevin Hansson   unsigned minFuncUnits(const MachineInstr *Inst,
996c3f36accSBevin Hansson                         InstrStage::FuncUnits &F) const {
997f6cb3bcbSJinsong Ji     unsigned SchedClass = Inst->getDesc().getSchedClass();
998254f889dSBrendon Cahoon     unsigned min = UINT_MAX;
999f6cb3bcbSJinsong Ji     if (InstrItins && !InstrItins->isEmpty()) {
1000f6cb3bcbSJinsong Ji       for (const InstrStage &IS :
1001f6cb3bcbSJinsong Ji            make_range(InstrItins->beginStage(SchedClass),
1002f6cb3bcbSJinsong Ji                       InstrItins->endStage(SchedClass))) {
1003c3f36accSBevin Hansson         InstrStage::FuncUnits funcUnits = IS.getUnits();
1004254f889dSBrendon Cahoon         unsigned numAlternatives = countPopulation(funcUnits);
1005254f889dSBrendon Cahoon         if (numAlternatives < min) {
1006254f889dSBrendon Cahoon           min = numAlternatives;
1007254f889dSBrendon Cahoon           F = funcUnits;
1008254f889dSBrendon Cahoon         }
1009254f889dSBrendon Cahoon       }
1010254f889dSBrendon Cahoon       return min;
1011254f889dSBrendon Cahoon     }
1012f6cb3bcbSJinsong Ji     if (STI && STI->getSchedModel().hasInstrSchedModel()) {
1013f6cb3bcbSJinsong Ji       const MCSchedClassDesc *SCDesc =
1014f6cb3bcbSJinsong Ji           STI->getSchedModel().getSchedClassDesc(SchedClass);
1015f6cb3bcbSJinsong Ji       if (!SCDesc->isValid())
1016f6cb3bcbSJinsong Ji         // No valid Schedule Class Desc for schedClass, should be
1017f6cb3bcbSJinsong Ji         // Pseudo/PostRAPseudo
1018f6cb3bcbSJinsong Ji         return min;
1019f6cb3bcbSJinsong Ji 
1020f6cb3bcbSJinsong Ji       for (const MCWriteProcResEntry &PRE :
1021f6cb3bcbSJinsong Ji            make_range(STI->getWriteProcResBegin(SCDesc),
1022f6cb3bcbSJinsong Ji                       STI->getWriteProcResEnd(SCDesc))) {
1023f6cb3bcbSJinsong Ji         if (!PRE.Cycles)
1024f6cb3bcbSJinsong Ji           continue;
1025f6cb3bcbSJinsong Ji         const MCProcResourceDesc *ProcResource =
1026f6cb3bcbSJinsong Ji             STI->getSchedModel().getProcResource(PRE.ProcResourceIdx);
1027f6cb3bcbSJinsong Ji         unsigned NumUnits = ProcResource->NumUnits;
1028f6cb3bcbSJinsong Ji         if (NumUnits < min) {
1029f6cb3bcbSJinsong Ji           min = NumUnits;
1030f6cb3bcbSJinsong Ji           F = PRE.ProcResourceIdx;
1031f6cb3bcbSJinsong Ji         }
1032f6cb3bcbSJinsong Ji       }
1033f6cb3bcbSJinsong Ji       return min;
1034f6cb3bcbSJinsong Ji     }
1035f6cb3bcbSJinsong Ji     llvm_unreachable("Should have non-empty InstrItins or hasInstrSchedModel!");
1036f6cb3bcbSJinsong Ji   }
1037254f889dSBrendon Cahoon 
1038254f889dSBrendon Cahoon   // Compute the critical resources needed by the instruction. This
1039254f889dSBrendon Cahoon   // function records the functional units needed by instructions that
1040254f889dSBrendon Cahoon   // must use only one functional unit. We use this as a tie breaker
1041254f889dSBrendon Cahoon   // for computing the resource MII. The instrutions that require
1042254f889dSBrendon Cahoon   // the same, highly used, functional unit have high priority.
1043254f889dSBrendon Cahoon   void calcCriticalResources(MachineInstr &MI) {
1044254f889dSBrendon Cahoon     unsigned SchedClass = MI.getDesc().getSchedClass();
1045f6cb3bcbSJinsong Ji     if (InstrItins && !InstrItins->isEmpty()) {
1046f6cb3bcbSJinsong Ji       for (const InstrStage &IS :
1047f6cb3bcbSJinsong Ji            make_range(InstrItins->beginStage(SchedClass),
1048f6cb3bcbSJinsong Ji                       InstrItins->endStage(SchedClass))) {
1049c3f36accSBevin Hansson         InstrStage::FuncUnits FuncUnits = IS.getUnits();
1050254f889dSBrendon Cahoon         if (countPopulation(FuncUnits) == 1)
1051254f889dSBrendon Cahoon           Resources[FuncUnits]++;
1052254f889dSBrendon Cahoon       }
1053f6cb3bcbSJinsong Ji       return;
1054f6cb3bcbSJinsong Ji     }
1055f6cb3bcbSJinsong Ji     if (STI && STI->getSchedModel().hasInstrSchedModel()) {
1056f6cb3bcbSJinsong Ji       const MCSchedClassDesc *SCDesc =
1057f6cb3bcbSJinsong Ji           STI->getSchedModel().getSchedClassDesc(SchedClass);
1058f6cb3bcbSJinsong Ji       if (!SCDesc->isValid())
1059f6cb3bcbSJinsong Ji         // No valid Schedule Class Desc for schedClass, should be
1060f6cb3bcbSJinsong Ji         // Pseudo/PostRAPseudo
1061f6cb3bcbSJinsong Ji         return;
1062f6cb3bcbSJinsong Ji 
1063f6cb3bcbSJinsong Ji       for (const MCWriteProcResEntry &PRE :
1064f6cb3bcbSJinsong Ji            make_range(STI->getWriteProcResBegin(SCDesc),
1065f6cb3bcbSJinsong Ji                       STI->getWriteProcResEnd(SCDesc))) {
1066f6cb3bcbSJinsong Ji         if (!PRE.Cycles)
1067f6cb3bcbSJinsong Ji           continue;
1068f6cb3bcbSJinsong Ji         Resources[PRE.ProcResourceIdx]++;
1069f6cb3bcbSJinsong Ji       }
1070f6cb3bcbSJinsong Ji       return;
1071f6cb3bcbSJinsong Ji     }
1072f6cb3bcbSJinsong Ji     llvm_unreachable("Should have non-empty InstrItins or hasInstrSchedModel!");
1073254f889dSBrendon Cahoon   }
1074254f889dSBrendon Cahoon 
1075254f889dSBrendon Cahoon   /// Return true if IS1 has less priority than IS2.
1076254f889dSBrendon Cahoon   bool operator()(const MachineInstr *IS1, const MachineInstr *IS2) const {
1077c3f36accSBevin Hansson     InstrStage::FuncUnits F1 = 0, F2 = 0;
1078254f889dSBrendon Cahoon     unsigned MFUs1 = minFuncUnits(IS1, F1);
1079254f889dSBrendon Cahoon     unsigned MFUs2 = minFuncUnits(IS2, F2);
10806349ce5cSJinsong Ji     if (MFUs1 == MFUs2)
1081254f889dSBrendon Cahoon       return Resources.lookup(F1) < Resources.lookup(F2);
1082254f889dSBrendon Cahoon     return MFUs1 > MFUs2;
1083254f889dSBrendon Cahoon   }
1084254f889dSBrendon Cahoon };
1085cdc71612SEugene Zelenko 
1086cdc71612SEugene Zelenko } // end anonymous namespace
1087254f889dSBrendon Cahoon 
1088254f889dSBrendon Cahoon /// Calculate the resource constrained minimum initiation interval for the
1089254f889dSBrendon Cahoon /// specified loop. We use the DFA to model the resources needed for
1090254f889dSBrendon Cahoon /// each instruction, and we ignore dependences. A different DFA is created
1091254f889dSBrendon Cahoon /// for each cycle that is required. When adding a new instruction, we attempt
1092254f889dSBrendon Cahoon /// to add it to each existing DFA, until a legal space is found. If the
1093254f889dSBrendon Cahoon /// instruction cannot be reserved in an existing DFA, we create a new one.
1094254f889dSBrendon Cahoon unsigned SwingSchedulerDAG::calculateResMII() {
1095f6cb3bcbSJinsong Ji 
109618e7bf5cSJinsong Ji   LLVM_DEBUG(dbgs() << "calculateResMII:\n");
1097f6cb3bcbSJinsong Ji   SmallVector<ResourceManager*, 8> Resources;
1098254f889dSBrendon Cahoon   MachineBasicBlock *MBB = Loop.getHeader();
1099f6cb3bcbSJinsong Ji   Resources.push_back(new ResourceManager(&MF.getSubtarget()));
1100254f889dSBrendon Cahoon 
1101254f889dSBrendon Cahoon   // Sort the instructions by the number of available choices for scheduling,
1102254f889dSBrendon Cahoon   // least to most. Use the number of critical resources as the tie breaker.
1103f6cb3bcbSJinsong Ji   FuncUnitSorter FUS = FuncUnitSorter(MF.getSubtarget());
1104c4a8928bSKazu Hirata   for (MachineInstr &MI :
1105c4a8928bSKazu Hirata        llvm::make_range(MBB->getFirstNonPHI(), MBB->getFirstTerminator()))
1106c4a8928bSKazu Hirata     FUS.calcCriticalResources(MI);
1107254f889dSBrendon Cahoon   PriorityQueue<MachineInstr *, std::vector<MachineInstr *>, FuncUnitSorter>
1108254f889dSBrendon Cahoon       FuncUnitOrder(FUS);
1109254f889dSBrendon Cahoon 
1110c4a8928bSKazu Hirata   for (MachineInstr &MI :
1111c4a8928bSKazu Hirata        llvm::make_range(MBB->getFirstNonPHI(), MBB->getFirstTerminator()))
1112c4a8928bSKazu Hirata     FuncUnitOrder.push(&MI);
1113254f889dSBrendon Cahoon 
1114254f889dSBrendon Cahoon   while (!FuncUnitOrder.empty()) {
1115254f889dSBrendon Cahoon     MachineInstr *MI = FuncUnitOrder.top();
1116254f889dSBrendon Cahoon     FuncUnitOrder.pop();
1117254f889dSBrendon Cahoon     if (TII->isZeroCost(MI->getOpcode()))
1118254f889dSBrendon Cahoon       continue;
1119254f889dSBrendon Cahoon     // Attempt to reserve the instruction in an existing DFA. At least one
1120254f889dSBrendon Cahoon     // DFA is needed for each cycle.
1121254f889dSBrendon Cahoon     unsigned NumCycles = getSUnit(MI)->Latency;
1122254f889dSBrendon Cahoon     unsigned ReservedCycles = 0;
1123f6cb3bcbSJinsong Ji     SmallVectorImpl<ResourceManager *>::iterator RI = Resources.begin();
1124f6cb3bcbSJinsong Ji     SmallVectorImpl<ResourceManager *>::iterator RE = Resources.end();
112518e7bf5cSJinsong Ji     LLVM_DEBUG({
112618e7bf5cSJinsong Ji       dbgs() << "Trying to reserve resource for " << NumCycles
112718e7bf5cSJinsong Ji              << " cycles for \n";
112818e7bf5cSJinsong Ji       MI->dump();
112918e7bf5cSJinsong Ji     });
1130254f889dSBrendon Cahoon     for (unsigned C = 0; C < NumCycles; ++C)
1131254f889dSBrendon Cahoon       while (RI != RE) {
1132fee855b5SJinsong Ji         if ((*RI)->canReserveResources(*MI)) {
1133fee855b5SJinsong Ji           (*RI)->reserveResources(*MI);
1134254f889dSBrendon Cahoon           ++ReservedCycles;
1135254f889dSBrendon Cahoon           break;
1136254f889dSBrendon Cahoon         }
1137fee855b5SJinsong Ji         RI++;
1138254f889dSBrendon Cahoon       }
113918e7bf5cSJinsong Ji     LLVM_DEBUG(dbgs() << "ReservedCycles:" << ReservedCycles
114018e7bf5cSJinsong Ji                       << ", NumCycles:" << NumCycles << "\n");
1141254f889dSBrendon Cahoon     // Add new DFAs, if needed, to reserve resources.
1142254f889dSBrendon Cahoon     for (unsigned C = ReservedCycles; C < NumCycles; ++C) {
1143ba43840bSJinsong Ji       LLVM_DEBUG(if (SwpDebugResource) dbgs()
1144ba43840bSJinsong Ji                  << "NewResource created to reserve resources"
114518e7bf5cSJinsong Ji                  << "\n");
1146f6cb3bcbSJinsong Ji       ResourceManager *NewResource = new ResourceManager(&MF.getSubtarget());
1147254f889dSBrendon Cahoon       assert(NewResource->canReserveResources(*MI) && "Reserve error.");
1148254f889dSBrendon Cahoon       NewResource->reserveResources(*MI);
1149254f889dSBrendon Cahoon       Resources.push_back(NewResource);
1150254f889dSBrendon Cahoon     }
1151254f889dSBrendon Cahoon   }
1152254f889dSBrendon Cahoon   int Resmii = Resources.size();
115380b78a47SJinsong Ji   LLVM_DEBUG(dbgs() << "Return Res MII:" << Resmii << "\n");
1154254f889dSBrendon Cahoon   // Delete the memory for each of the DFAs that were created earlier.
1155f6cb3bcbSJinsong Ji   for (ResourceManager *RI : Resources) {
1156f6cb3bcbSJinsong Ji     ResourceManager *D = RI;
1157254f889dSBrendon Cahoon     delete D;
1158254f889dSBrendon Cahoon   }
1159254f889dSBrendon Cahoon   Resources.clear();
1160254f889dSBrendon Cahoon   return Resmii;
1161254f889dSBrendon Cahoon }
1162254f889dSBrendon Cahoon 
1163254f889dSBrendon Cahoon /// Calculate the recurrence-constrainted minimum initiation interval.
1164254f889dSBrendon Cahoon /// Iterate over each circuit.  Compute the delay(c) and distance(c)
1165254f889dSBrendon Cahoon /// for each circuit. The II needs to satisfy the inequality
1166254f889dSBrendon Cahoon /// delay(c) - II*distance(c) <= 0. For each circuit, choose the smallest
1167c73b6d6bSHiroshi Inoue /// II that satisfies the inequality, and the RecMII is the maximum
1168254f889dSBrendon Cahoon /// of those values.
1169254f889dSBrendon Cahoon unsigned SwingSchedulerDAG::calculateRecMII(NodeSetType &NodeSets) {
1170254f889dSBrendon Cahoon   unsigned RecMII = 0;
1171254f889dSBrendon Cahoon 
1172254f889dSBrendon Cahoon   for (NodeSet &Nodes : NodeSets) {
117332a40564SEugene Zelenko     if (Nodes.empty())
1174254f889dSBrendon Cahoon       continue;
1175254f889dSBrendon Cahoon 
1176a2122044SKrzysztof Parzyszek     unsigned Delay = Nodes.getLatency();
1177254f889dSBrendon Cahoon     unsigned Distance = 1;
1178254f889dSBrendon Cahoon 
1179254f889dSBrendon Cahoon     // ii = ceil(delay / distance)
1180254f889dSBrendon Cahoon     unsigned CurMII = (Delay + Distance - 1) / Distance;
1181254f889dSBrendon Cahoon     Nodes.setRecMII(CurMII);
1182254f889dSBrendon Cahoon     if (CurMII > RecMII)
1183254f889dSBrendon Cahoon       RecMII = CurMII;
1184254f889dSBrendon Cahoon   }
1185254f889dSBrendon Cahoon 
1186254f889dSBrendon Cahoon   return RecMII;
1187254f889dSBrendon Cahoon }
1188254f889dSBrendon Cahoon 
1189254f889dSBrendon Cahoon /// Swap all the anti dependences in the DAG. That means it is no longer a DAG,
1190254f889dSBrendon Cahoon /// but we do this to find the circuits, and then change them back.
1191254f889dSBrendon Cahoon static void swapAntiDependences(std::vector<SUnit> &SUnits) {
1192254f889dSBrendon Cahoon   SmallVector<std::pair<SUnit *, SDep>, 8> DepsAdded;
1193ca2f5389SKazu Hirata   for (SUnit &SU : SUnits) {
1194ca2f5389SKazu Hirata     for (SDep &Pred : SU.Preds)
1195ca2f5389SKazu Hirata       if (Pred.getKind() == SDep::Anti)
1196ca2f5389SKazu Hirata         DepsAdded.push_back(std::make_pair(&SU, Pred));
1197254f889dSBrendon Cahoon   }
11983279943aSKazu Hirata   for (std::pair<SUnit *, SDep> &P : DepsAdded) {
1199254f889dSBrendon Cahoon     // Remove this anti dependency and add one in the reverse direction.
12003279943aSKazu Hirata     SUnit *SU = P.first;
12013279943aSKazu Hirata     SDep &D = P.second;
1202254f889dSBrendon Cahoon     SUnit *TargetSU = D.getSUnit();
1203254f889dSBrendon Cahoon     unsigned Reg = D.getReg();
1204254f889dSBrendon Cahoon     unsigned Lat = D.getLatency();
1205254f889dSBrendon Cahoon     SU->removePred(D);
1206254f889dSBrendon Cahoon     SDep Dep(SU, SDep::Anti, Reg);
1207254f889dSBrendon Cahoon     Dep.setLatency(Lat);
1208254f889dSBrendon Cahoon     TargetSU->addPred(Dep);
1209254f889dSBrendon Cahoon   }
1210254f889dSBrendon Cahoon }
1211254f889dSBrendon Cahoon 
1212254f889dSBrendon Cahoon /// Create the adjacency structure of the nodes in the graph.
1213254f889dSBrendon Cahoon void SwingSchedulerDAG::Circuits::createAdjacencyStructure(
1214254f889dSBrendon Cahoon     SwingSchedulerDAG *DAG) {
1215254f889dSBrendon Cahoon   BitVector Added(SUnits.size());
12168e1363dfSKrzysztof Parzyszek   DenseMap<int, int> OutputDeps;
1217254f889dSBrendon Cahoon   for (int i = 0, e = SUnits.size(); i != e; ++i) {
1218254f889dSBrendon Cahoon     Added.reset();
1219254f889dSBrendon Cahoon     // Add any successor to the adjacency matrix and exclude duplicates.
1220254f889dSBrendon Cahoon     for (auto &SI : SUnits[i].Succs) {
12218e1363dfSKrzysztof Parzyszek       // Only create a back-edge on the first and last nodes of a dependence
12228e1363dfSKrzysztof Parzyszek       // chain. This records any chains and adds them later.
12238e1363dfSKrzysztof Parzyszek       if (SI.getKind() == SDep::Output) {
12248e1363dfSKrzysztof Parzyszek         int N = SI.getSUnit()->NodeNum;
12258e1363dfSKrzysztof Parzyszek         int BackEdge = i;
12268e1363dfSKrzysztof Parzyszek         auto Dep = OutputDeps.find(BackEdge);
12278e1363dfSKrzysztof Parzyszek         if (Dep != OutputDeps.end()) {
12288e1363dfSKrzysztof Parzyszek           BackEdge = Dep->second;
12298e1363dfSKrzysztof Parzyszek           OutputDeps.erase(Dep);
12308e1363dfSKrzysztof Parzyszek         }
12318e1363dfSKrzysztof Parzyszek         OutputDeps[N] = BackEdge;
12328e1363dfSKrzysztof Parzyszek       }
1233ada0f511SSumanth Gundapaneni       // Do not process a boundary node, an artificial node.
1234ada0f511SSumanth Gundapaneni       // A back-edge is processed only if it goes to a Phi.
1235ada0f511SSumanth Gundapaneni       if (SI.getSUnit()->isBoundaryNode() || SI.isArtificial() ||
1236254f889dSBrendon Cahoon           (SI.getKind() == SDep::Anti && !SI.getSUnit()->getInstr()->isPHI()))
1237254f889dSBrendon Cahoon         continue;
1238254f889dSBrendon Cahoon       int N = SI.getSUnit()->NodeNum;
1239254f889dSBrendon Cahoon       if (!Added.test(N)) {
1240254f889dSBrendon Cahoon         AdjK[i].push_back(N);
1241254f889dSBrendon Cahoon         Added.set(N);
1242254f889dSBrendon Cahoon       }
1243254f889dSBrendon Cahoon     }
1244254f889dSBrendon Cahoon     // A chain edge between a store and a load is treated as a back-edge in the
1245254f889dSBrendon Cahoon     // adjacency matrix.
1246254f889dSBrendon Cahoon     for (auto &PI : SUnits[i].Preds) {
1247254f889dSBrendon Cahoon       if (!SUnits[i].getInstr()->mayStore() ||
12488e1363dfSKrzysztof Parzyszek           !DAG->isLoopCarriedDep(&SUnits[i], PI, false))
1249254f889dSBrendon Cahoon         continue;
1250254f889dSBrendon Cahoon       if (PI.getKind() == SDep::Order && PI.getSUnit()->getInstr()->mayLoad()) {
1251254f889dSBrendon Cahoon         int N = PI.getSUnit()->NodeNum;
1252254f889dSBrendon Cahoon         if (!Added.test(N)) {
1253254f889dSBrendon Cahoon           AdjK[i].push_back(N);
1254254f889dSBrendon Cahoon           Added.set(N);
1255254f889dSBrendon Cahoon         }
1256254f889dSBrendon Cahoon       }
1257254f889dSBrendon Cahoon     }
1258254f889dSBrendon Cahoon   }
1259dad8c6a1SHiroshi Inoue   // Add back-edges in the adjacency matrix for the output dependences.
12608e1363dfSKrzysztof Parzyszek   for (auto &OD : OutputDeps)
12618e1363dfSKrzysztof Parzyszek     if (!Added.test(OD.second)) {
12628e1363dfSKrzysztof Parzyszek       AdjK[OD.first].push_back(OD.second);
12638e1363dfSKrzysztof Parzyszek       Added.set(OD.second);
12648e1363dfSKrzysztof Parzyszek     }
1265254f889dSBrendon Cahoon }
1266254f889dSBrendon Cahoon 
1267254f889dSBrendon Cahoon /// Identify an elementary circuit in the dependence graph starting at the
1268254f889dSBrendon Cahoon /// specified node.
1269254f889dSBrendon Cahoon bool SwingSchedulerDAG::Circuits::circuit(int V, int S, NodeSetType &NodeSets,
1270254f889dSBrendon Cahoon                                           bool HasBackedge) {
1271254f889dSBrendon Cahoon   SUnit *SV = &SUnits[V];
1272254f889dSBrendon Cahoon   bool F = false;
1273254f889dSBrendon Cahoon   Stack.insert(SV);
1274254f889dSBrendon Cahoon   Blocked.set(V);
1275254f889dSBrendon Cahoon 
1276254f889dSBrendon Cahoon   for (auto W : AdjK[V]) {
1277254f889dSBrendon Cahoon     if (NumPaths > MaxPaths)
1278254f889dSBrendon Cahoon       break;
1279254f889dSBrendon Cahoon     if (W < S)
1280254f889dSBrendon Cahoon       continue;
1281254f889dSBrendon Cahoon     if (W == S) {
1282254f889dSBrendon Cahoon       if (!HasBackedge)
1283254f889dSBrendon Cahoon         NodeSets.push_back(NodeSet(Stack.begin(), Stack.end()));
1284254f889dSBrendon Cahoon       F = true;
1285254f889dSBrendon Cahoon       ++NumPaths;
1286254f889dSBrendon Cahoon       break;
1287254f889dSBrendon Cahoon     } else if (!Blocked.test(W)) {
128877418a37SSumanth Gundapaneni       if (circuit(W, S, NodeSets,
128977418a37SSumanth Gundapaneni                   Node2Idx->at(W) < Node2Idx->at(V) ? true : HasBackedge))
1290254f889dSBrendon Cahoon         F = true;
1291254f889dSBrendon Cahoon     }
1292254f889dSBrendon Cahoon   }
1293254f889dSBrendon Cahoon 
1294254f889dSBrendon Cahoon   if (F)
1295254f889dSBrendon Cahoon     unblock(V);
1296254f889dSBrendon Cahoon   else {
1297254f889dSBrendon Cahoon     for (auto W : AdjK[V]) {
1298254f889dSBrendon Cahoon       if (W < S)
1299254f889dSBrendon Cahoon         continue;
1300254f889dSBrendon Cahoon       if (B[W].count(SV) == 0)
1301254f889dSBrendon Cahoon         B[W].insert(SV);
1302254f889dSBrendon Cahoon     }
1303254f889dSBrendon Cahoon   }
1304254f889dSBrendon Cahoon   Stack.pop_back();
1305254f889dSBrendon Cahoon   return F;
1306254f889dSBrendon Cahoon }
1307254f889dSBrendon Cahoon 
1308254f889dSBrendon Cahoon /// Unblock a node in the circuit finding algorithm.
1309254f889dSBrendon Cahoon void SwingSchedulerDAG::Circuits::unblock(int U) {
1310254f889dSBrendon Cahoon   Blocked.reset(U);
1311254f889dSBrendon Cahoon   SmallPtrSet<SUnit *, 4> &BU = B[U];
1312254f889dSBrendon Cahoon   while (!BU.empty()) {
1313254f889dSBrendon Cahoon     SmallPtrSet<SUnit *, 4>::iterator SI = BU.begin();
1314254f889dSBrendon Cahoon     assert(SI != BU.end() && "Invalid B set.");
1315254f889dSBrendon Cahoon     SUnit *W = *SI;
1316254f889dSBrendon Cahoon     BU.erase(W);
1317254f889dSBrendon Cahoon     if (Blocked.test(W->NodeNum))
1318254f889dSBrendon Cahoon       unblock(W->NodeNum);
1319254f889dSBrendon Cahoon   }
1320254f889dSBrendon Cahoon }
1321254f889dSBrendon Cahoon 
1322254f889dSBrendon Cahoon /// Identify all the elementary circuits in the dependence graph using
1323254f889dSBrendon Cahoon /// Johnson's circuit algorithm.
1324254f889dSBrendon Cahoon void SwingSchedulerDAG::findCircuits(NodeSetType &NodeSets) {
1325254f889dSBrendon Cahoon   // Swap all the anti dependences in the DAG. That means it is no longer a DAG,
1326254f889dSBrendon Cahoon   // but we do this to find the circuits, and then change them back.
1327254f889dSBrendon Cahoon   swapAntiDependences(SUnits);
1328254f889dSBrendon Cahoon 
132977418a37SSumanth Gundapaneni   Circuits Cir(SUnits, Topo);
1330254f889dSBrendon Cahoon   // Create the adjacency structure.
1331254f889dSBrendon Cahoon   Cir.createAdjacencyStructure(this);
1332254f889dSBrendon Cahoon   for (int i = 0, e = SUnits.size(); i != e; ++i) {
1333254f889dSBrendon Cahoon     Cir.reset();
1334254f889dSBrendon Cahoon     Cir.circuit(i, i, NodeSets);
1335254f889dSBrendon Cahoon   }
1336254f889dSBrendon Cahoon 
1337254f889dSBrendon Cahoon   // Change the dependences back so that we've created a DAG again.
1338254f889dSBrendon Cahoon   swapAntiDependences(SUnits);
1339254f889dSBrendon Cahoon }
1340254f889dSBrendon Cahoon 
134162ac69d4SSumanth Gundapaneni // Create artificial dependencies between the source of COPY/REG_SEQUENCE that
134262ac69d4SSumanth Gundapaneni // is loop-carried to the USE in next iteration. This will help pipeliner avoid
134362ac69d4SSumanth Gundapaneni // additional copies that are needed across iterations. An artificial dependence
134462ac69d4SSumanth Gundapaneni // edge is added from USE to SOURCE of COPY/REG_SEQUENCE.
134562ac69d4SSumanth Gundapaneni 
134662ac69d4SSumanth Gundapaneni // PHI-------Anti-Dep-----> COPY/REG_SEQUENCE (loop-carried)
134762ac69d4SSumanth Gundapaneni // SRCOfCopY------True-Dep---> COPY/REG_SEQUENCE
134862ac69d4SSumanth Gundapaneni // PHI-------True-Dep------> USEOfPhi
134962ac69d4SSumanth Gundapaneni 
135062ac69d4SSumanth Gundapaneni // The mutation creates
135162ac69d4SSumanth Gundapaneni // USEOfPHI -------Artificial-Dep---> SRCOfCopy
135262ac69d4SSumanth Gundapaneni 
135362ac69d4SSumanth Gundapaneni // This overall will ensure, the USEOfPHI is scheduled before SRCOfCopy
135462ac69d4SSumanth Gundapaneni // (since USE is a predecessor), implies, the COPY/ REG_SEQUENCE is scheduled
135562ac69d4SSumanth Gundapaneni // late  to avoid additional copies across iterations. The possible scheduling
135662ac69d4SSumanth Gundapaneni // order would be
135762ac69d4SSumanth Gundapaneni // USEOfPHI --- SRCOfCopy---  COPY/REG_SEQUENCE.
135862ac69d4SSumanth Gundapaneni 
135962ac69d4SSumanth Gundapaneni void SwingSchedulerDAG::CopyToPhiMutation::apply(ScheduleDAGInstrs *DAG) {
136062ac69d4SSumanth Gundapaneni   for (SUnit &SU : DAG->SUnits) {
136162ac69d4SSumanth Gundapaneni     // Find the COPY/REG_SEQUENCE instruction.
136262ac69d4SSumanth Gundapaneni     if (!SU.getInstr()->isCopy() && !SU.getInstr()->isRegSequence())
136362ac69d4SSumanth Gundapaneni       continue;
136462ac69d4SSumanth Gundapaneni 
136562ac69d4SSumanth Gundapaneni     // Record the loop carried PHIs.
136662ac69d4SSumanth Gundapaneni     SmallVector<SUnit *, 4> PHISUs;
136762ac69d4SSumanth Gundapaneni     // Record the SrcSUs that feed the COPY/REG_SEQUENCE instructions.
136862ac69d4SSumanth Gundapaneni     SmallVector<SUnit *, 4> SrcSUs;
136962ac69d4SSumanth Gundapaneni 
137062ac69d4SSumanth Gundapaneni     for (auto &Dep : SU.Preds) {
137162ac69d4SSumanth Gundapaneni       SUnit *TmpSU = Dep.getSUnit();
137262ac69d4SSumanth Gundapaneni       MachineInstr *TmpMI = TmpSU->getInstr();
137362ac69d4SSumanth Gundapaneni       SDep::Kind DepKind = Dep.getKind();
137462ac69d4SSumanth Gundapaneni       // Save the loop carried PHI.
137562ac69d4SSumanth Gundapaneni       if (DepKind == SDep::Anti && TmpMI->isPHI())
137662ac69d4SSumanth Gundapaneni         PHISUs.push_back(TmpSU);
137762ac69d4SSumanth Gundapaneni       // Save the source of COPY/REG_SEQUENCE.
137862ac69d4SSumanth Gundapaneni       // If the source has no pre-decessors, we will end up creating cycles.
137962ac69d4SSumanth Gundapaneni       else if (DepKind == SDep::Data && !TmpMI->isPHI() && TmpSU->NumPreds > 0)
138062ac69d4SSumanth Gundapaneni         SrcSUs.push_back(TmpSU);
138162ac69d4SSumanth Gundapaneni     }
138262ac69d4SSumanth Gundapaneni 
138362ac69d4SSumanth Gundapaneni     if (PHISUs.size() == 0 || SrcSUs.size() == 0)
138462ac69d4SSumanth Gundapaneni       continue;
138562ac69d4SSumanth Gundapaneni 
138662ac69d4SSumanth Gundapaneni     // Find the USEs of PHI. If the use is a PHI or REG_SEQUENCE, push back this
138762ac69d4SSumanth Gundapaneni     // SUnit to the container.
138862ac69d4SSumanth Gundapaneni     SmallVector<SUnit *, 8> UseSUs;
13897c7e368aSSumanth Gundapaneni     // Do not use iterator based loop here as we are updating the container.
13907c7e368aSSumanth Gundapaneni     for (size_t Index = 0; Index < PHISUs.size(); ++Index) {
13917c7e368aSSumanth Gundapaneni       for (auto &Dep : PHISUs[Index]->Succs) {
139262ac69d4SSumanth Gundapaneni         if (Dep.getKind() != SDep::Data)
139362ac69d4SSumanth Gundapaneni           continue;
139462ac69d4SSumanth Gundapaneni 
139562ac69d4SSumanth Gundapaneni         SUnit *TmpSU = Dep.getSUnit();
139662ac69d4SSumanth Gundapaneni         MachineInstr *TmpMI = TmpSU->getInstr();
139762ac69d4SSumanth Gundapaneni         if (TmpMI->isPHI() || TmpMI->isRegSequence()) {
139862ac69d4SSumanth Gundapaneni           PHISUs.push_back(TmpSU);
139962ac69d4SSumanth Gundapaneni           continue;
140062ac69d4SSumanth Gundapaneni         }
140162ac69d4SSumanth Gundapaneni         UseSUs.push_back(TmpSU);
140262ac69d4SSumanth Gundapaneni       }
140362ac69d4SSumanth Gundapaneni     }
140462ac69d4SSumanth Gundapaneni 
140562ac69d4SSumanth Gundapaneni     if (UseSUs.size() == 0)
140662ac69d4SSumanth Gundapaneni       continue;
140762ac69d4SSumanth Gundapaneni 
140862ac69d4SSumanth Gundapaneni     SwingSchedulerDAG *SDAG = cast<SwingSchedulerDAG>(DAG);
140962ac69d4SSumanth Gundapaneni     // Add the artificial dependencies if it does not form a cycle.
141062ac69d4SSumanth Gundapaneni     for (auto I : UseSUs) {
141162ac69d4SSumanth Gundapaneni       for (auto Src : SrcSUs) {
141262ac69d4SSumanth Gundapaneni         if (!SDAG->Topo.IsReachable(I, Src) && Src != I) {
141362ac69d4SSumanth Gundapaneni           Src->addPred(SDep(I, SDep::Artificial));
141462ac69d4SSumanth Gundapaneni           SDAG->Topo.AddPred(Src, I);
141562ac69d4SSumanth Gundapaneni         }
141662ac69d4SSumanth Gundapaneni       }
141762ac69d4SSumanth Gundapaneni     }
141862ac69d4SSumanth Gundapaneni   }
141962ac69d4SSumanth Gundapaneni }
142062ac69d4SSumanth Gundapaneni 
1421254f889dSBrendon Cahoon /// Return true for DAG nodes that we ignore when computing the cost functions.
1422c73b6d6bSHiroshi Inoue /// We ignore the back-edge recurrence in order to avoid unbounded recursion
1423254f889dSBrendon Cahoon /// in the calculation of the ASAP, ALAP, etc functions.
1424254f889dSBrendon Cahoon static bool ignoreDependence(const SDep &D, bool isPred) {
1425254f889dSBrendon Cahoon   if (D.isArtificial())
1426254f889dSBrendon Cahoon     return true;
1427254f889dSBrendon Cahoon   return D.getKind() == SDep::Anti && isPred;
1428254f889dSBrendon Cahoon }
1429254f889dSBrendon Cahoon 
1430254f889dSBrendon Cahoon /// Compute several functions need to order the nodes for scheduling.
1431254f889dSBrendon Cahoon ///  ASAP - Earliest time to schedule a node.
1432254f889dSBrendon Cahoon ///  ALAP - Latest time to schedule a node.
1433254f889dSBrendon Cahoon ///  MOV - Mobility function, difference between ALAP and ASAP.
1434254f889dSBrendon Cahoon ///  D - Depth of each node.
1435254f889dSBrendon Cahoon ///  H - Height of each node.
1436254f889dSBrendon Cahoon void SwingSchedulerDAG::computeNodeFunctions(NodeSetType &NodeSets) {
1437254f889dSBrendon Cahoon   ScheduleInfo.resize(SUnits.size());
1438254f889dSBrendon Cahoon 
1439d34e60caSNicola Zaghen   LLVM_DEBUG({
14403279943aSKazu Hirata     for (int I : Topo) {
14413279943aSKazu Hirata       const SUnit &SU = SUnits[I];
1442726e12cfSMatthias Braun       dumpNode(SU);
1443254f889dSBrendon Cahoon     }
1444254f889dSBrendon Cahoon   });
1445254f889dSBrendon Cahoon 
1446254f889dSBrendon Cahoon   int maxASAP = 0;
14474b8bcf00SRoorda, Jan-Willem   // Compute ASAP and ZeroLatencyDepth.
14483279943aSKazu Hirata   for (int I : Topo) {
1449254f889dSBrendon Cahoon     int asap = 0;
14504b8bcf00SRoorda, Jan-Willem     int zeroLatencyDepth = 0;
14513279943aSKazu Hirata     SUnit *SU = &SUnits[I];
1452fd7d4064SKazu Hirata     for (const SDep &P : SU->Preds) {
1453fd7d4064SKazu Hirata       SUnit *pred = P.getSUnit();
1454fd7d4064SKazu Hirata       if (P.getLatency() == 0)
14554b8bcf00SRoorda, Jan-Willem         zeroLatencyDepth =
14564b8bcf00SRoorda, Jan-Willem             std::max(zeroLatencyDepth, getZeroLatencyDepth(pred) + 1);
1457fd7d4064SKazu Hirata       if (ignoreDependence(P, true))
1458254f889dSBrendon Cahoon         continue;
1459fd7d4064SKazu Hirata       asap = std::max(asap, (int)(getASAP(pred) + P.getLatency() -
1460fd7d4064SKazu Hirata                                   getDistance(pred, SU, P) * MII));
1461254f889dSBrendon Cahoon     }
1462254f889dSBrendon Cahoon     maxASAP = std::max(maxASAP, asap);
14633279943aSKazu Hirata     ScheduleInfo[I].ASAP = asap;
14643279943aSKazu Hirata     ScheduleInfo[I].ZeroLatencyDepth = zeroLatencyDepth;
1465254f889dSBrendon Cahoon   }
1466254f889dSBrendon Cahoon 
14674b8bcf00SRoorda, Jan-Willem   // Compute ALAP, ZeroLatencyHeight, and MOV.
1468ca2f5389SKazu Hirata   for (int I : llvm::reverse(Topo)) {
1469254f889dSBrendon Cahoon     int alap = maxASAP;
14704b8bcf00SRoorda, Jan-Willem     int zeroLatencyHeight = 0;
1471ca2f5389SKazu Hirata     SUnit *SU = &SUnits[I];
1472ca2f5389SKazu Hirata     for (const SDep &S : SU->Succs) {
1473ca2f5389SKazu Hirata       SUnit *succ = S.getSUnit();
1474ca2f5389SKazu Hirata       if (S.getLatency() == 0)
14754b8bcf00SRoorda, Jan-Willem         zeroLatencyHeight =
14764b8bcf00SRoorda, Jan-Willem             std::max(zeroLatencyHeight, getZeroLatencyHeight(succ) + 1);
1477ca2f5389SKazu Hirata       if (ignoreDependence(S, true))
1478254f889dSBrendon Cahoon         continue;
1479ca2f5389SKazu Hirata       alap = std::min(alap, (int)(getALAP(succ) - S.getLatency() +
1480ca2f5389SKazu Hirata                                   getDistance(SU, succ, S) * MII));
1481254f889dSBrendon Cahoon     }
1482254f889dSBrendon Cahoon 
1483ca2f5389SKazu Hirata     ScheduleInfo[I].ALAP = alap;
1484ca2f5389SKazu Hirata     ScheduleInfo[I].ZeroLatencyHeight = zeroLatencyHeight;
1485254f889dSBrendon Cahoon   }
1486254f889dSBrendon Cahoon 
1487254f889dSBrendon Cahoon   // After computing the node functions, compute the summary for each node set.
1488254f889dSBrendon Cahoon   for (NodeSet &I : NodeSets)
1489254f889dSBrendon Cahoon     I.computeNodeSetInfo(this);
1490254f889dSBrendon Cahoon 
1491d34e60caSNicola Zaghen   LLVM_DEBUG({
1492254f889dSBrendon Cahoon     for (unsigned i = 0; i < SUnits.size(); i++) {
1493254f889dSBrendon Cahoon       dbgs() << "\tNode " << i << ":\n";
1494254f889dSBrendon Cahoon       dbgs() << "\t   ASAP = " << getASAP(&SUnits[i]) << "\n";
1495254f889dSBrendon Cahoon       dbgs() << "\t   ALAP = " << getALAP(&SUnits[i]) << "\n";
1496254f889dSBrendon Cahoon       dbgs() << "\t   MOV  = " << getMOV(&SUnits[i]) << "\n";
1497254f889dSBrendon Cahoon       dbgs() << "\t   D    = " << getDepth(&SUnits[i]) << "\n";
1498254f889dSBrendon Cahoon       dbgs() << "\t   H    = " << getHeight(&SUnits[i]) << "\n";
14994b8bcf00SRoorda, Jan-Willem       dbgs() << "\t   ZLD  = " << getZeroLatencyDepth(&SUnits[i]) << "\n";
15004b8bcf00SRoorda, Jan-Willem       dbgs() << "\t   ZLH  = " << getZeroLatencyHeight(&SUnits[i]) << "\n";
1501254f889dSBrendon Cahoon     }
1502254f889dSBrendon Cahoon   });
1503254f889dSBrendon Cahoon }
1504254f889dSBrendon Cahoon 
1505254f889dSBrendon Cahoon /// Compute the Pred_L(O) set, as defined in the paper. The set is defined
1506254f889dSBrendon Cahoon /// as the predecessors of the elements of NodeOrder that are not also in
1507254f889dSBrendon Cahoon /// NodeOrder.
1508254f889dSBrendon Cahoon static bool pred_L(SetVector<SUnit *> &NodeOrder,
1509254f889dSBrendon Cahoon                    SmallSetVector<SUnit *, 8> &Preds,
1510254f889dSBrendon Cahoon                    const NodeSet *S = nullptr) {
1511254f889dSBrendon Cahoon   Preds.clear();
1512f240e528SKazu Hirata   for (const SUnit *SU : NodeOrder) {
1513f240e528SKazu Hirata     for (const SDep &Pred : SU->Preds) {
15143279943aSKazu Hirata       if (S && S->count(Pred.getSUnit()) == 0)
1515254f889dSBrendon Cahoon         continue;
15163279943aSKazu Hirata       if (ignoreDependence(Pred, true))
1517254f889dSBrendon Cahoon         continue;
15183279943aSKazu Hirata       if (NodeOrder.count(Pred.getSUnit()) == 0)
15193279943aSKazu Hirata         Preds.insert(Pred.getSUnit());
1520254f889dSBrendon Cahoon     }
1521254f889dSBrendon Cahoon     // Back-edges are predecessors with an anti-dependence.
1522f240e528SKazu Hirata     for (const SDep &Succ : SU->Succs) {
15233279943aSKazu Hirata       if (Succ.getKind() != SDep::Anti)
1524254f889dSBrendon Cahoon         continue;
15253279943aSKazu Hirata       if (S && S->count(Succ.getSUnit()) == 0)
1526254f889dSBrendon Cahoon         continue;
15273279943aSKazu Hirata       if (NodeOrder.count(Succ.getSUnit()) == 0)
15283279943aSKazu Hirata         Preds.insert(Succ.getSUnit());
1529254f889dSBrendon Cahoon     }
1530254f889dSBrendon Cahoon   }
153132a40564SEugene Zelenko   return !Preds.empty();
1532254f889dSBrendon Cahoon }
1533254f889dSBrendon Cahoon 
1534254f889dSBrendon Cahoon /// Compute the Succ_L(O) set, as defined in the paper. The set is defined
1535254f889dSBrendon Cahoon /// as the successors of the elements of NodeOrder that are not also in
1536254f889dSBrendon Cahoon /// NodeOrder.
1537254f889dSBrendon Cahoon static bool succ_L(SetVector<SUnit *> &NodeOrder,
1538254f889dSBrendon Cahoon                    SmallSetVector<SUnit *, 8> &Succs,
1539254f889dSBrendon Cahoon                    const NodeSet *S = nullptr) {
1540254f889dSBrendon Cahoon   Succs.clear();
1541ca2f5389SKazu Hirata   for (const SUnit *SU : NodeOrder) {
1542ca2f5389SKazu Hirata     for (const SDep &Succ : SU->Succs) {
15433279943aSKazu Hirata       if (S && S->count(Succ.getSUnit()) == 0)
1544254f889dSBrendon Cahoon         continue;
15453279943aSKazu Hirata       if (ignoreDependence(Succ, false))
1546254f889dSBrendon Cahoon         continue;
15473279943aSKazu Hirata       if (NodeOrder.count(Succ.getSUnit()) == 0)
15483279943aSKazu Hirata         Succs.insert(Succ.getSUnit());
1549254f889dSBrendon Cahoon     }
1550ca2f5389SKazu Hirata     for (const SDep &Pred : SU->Preds) {
15513279943aSKazu Hirata       if (Pred.getKind() != SDep::Anti)
1552254f889dSBrendon Cahoon         continue;
15533279943aSKazu Hirata       if (S && S->count(Pred.getSUnit()) == 0)
1554254f889dSBrendon Cahoon         continue;
15553279943aSKazu Hirata       if (NodeOrder.count(Pred.getSUnit()) == 0)
15563279943aSKazu Hirata         Succs.insert(Pred.getSUnit());
1557254f889dSBrendon Cahoon     }
1558254f889dSBrendon Cahoon   }
155932a40564SEugene Zelenko   return !Succs.empty();
1560254f889dSBrendon Cahoon }
1561254f889dSBrendon Cahoon 
1562254f889dSBrendon Cahoon /// Return true if there is a path from the specified node to any of the nodes
1563254f889dSBrendon Cahoon /// in DestNodes. Keep track and return the nodes in any path.
1564254f889dSBrendon Cahoon static bool computePath(SUnit *Cur, SetVector<SUnit *> &Path,
1565254f889dSBrendon Cahoon                         SetVector<SUnit *> &DestNodes,
1566254f889dSBrendon Cahoon                         SetVector<SUnit *> &Exclude,
1567254f889dSBrendon Cahoon                         SmallPtrSet<SUnit *, 8> &Visited) {
1568254f889dSBrendon Cahoon   if (Cur->isBoundaryNode())
1569254f889dSBrendon Cahoon     return false;
1570b7c5e0b0SKazu Hirata   if (Exclude.contains(Cur))
1571254f889dSBrendon Cahoon     return false;
1572b7c5e0b0SKazu Hirata   if (DestNodes.contains(Cur))
1573254f889dSBrendon Cahoon     return true;
1574254f889dSBrendon Cahoon   if (!Visited.insert(Cur).second)
1575b7c5e0b0SKazu Hirata     return Path.contains(Cur);
1576254f889dSBrendon Cahoon   bool FoundPath = false;
1577254f889dSBrendon Cahoon   for (auto &SI : Cur->Succs)
1578254f889dSBrendon Cahoon     FoundPath |= computePath(SI.getSUnit(), Path, DestNodes, Exclude, Visited);
1579254f889dSBrendon Cahoon   for (auto &PI : Cur->Preds)
1580254f889dSBrendon Cahoon     if (PI.getKind() == SDep::Anti)
1581254f889dSBrendon Cahoon       FoundPath |=
1582254f889dSBrendon Cahoon           computePath(PI.getSUnit(), Path, DestNodes, Exclude, Visited);
1583254f889dSBrendon Cahoon   if (FoundPath)
1584254f889dSBrendon Cahoon     Path.insert(Cur);
1585254f889dSBrendon Cahoon   return FoundPath;
1586254f889dSBrendon Cahoon }
1587254f889dSBrendon Cahoon 
1588254f889dSBrendon Cahoon /// Compute the live-out registers for the instructions in a node-set.
1589254f889dSBrendon Cahoon /// The live-out registers are those that are defined in the node-set,
1590254f889dSBrendon Cahoon /// but not used. Except for use operands of Phis.
1591254f889dSBrendon Cahoon static void computeLiveOuts(MachineFunction &MF, RegPressureTracker &RPTracker,
1592254f889dSBrendon Cahoon                             NodeSet &NS) {
1593254f889dSBrendon Cahoon   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
1594254f889dSBrendon Cahoon   MachineRegisterInfo &MRI = MF.getRegInfo();
1595254f889dSBrendon Cahoon   SmallVector<RegisterMaskPair, 8> LiveOutRegs;
1596254f889dSBrendon Cahoon   SmallSet<unsigned, 4> Uses;
1597254f889dSBrendon Cahoon   for (SUnit *SU : NS) {
1598254f889dSBrendon Cahoon     const MachineInstr *MI = SU->getInstr();
1599254f889dSBrendon Cahoon     if (MI->isPHI())
1600254f889dSBrendon Cahoon       continue;
1601fc371558SMatthias Braun     for (const MachineOperand &MO : MI->operands())
1602fc371558SMatthias Braun       if (MO.isReg() && MO.isUse()) {
16030c476111SDaniel Sanders         Register Reg = MO.getReg();
16042bea69bfSDaniel Sanders         if (Register::isVirtualRegister(Reg))
1605254f889dSBrendon Cahoon           Uses.insert(Reg);
1606254f889dSBrendon Cahoon         else if (MRI.isAllocatable(Reg))
1607c8fcffe7SMircea Trofin           for (MCRegUnitIterator Units(Reg.asMCReg(), TRI); Units.isValid();
1608c8fcffe7SMircea Trofin                ++Units)
1609254f889dSBrendon Cahoon             Uses.insert(*Units);
1610254f889dSBrendon Cahoon       }
1611254f889dSBrendon Cahoon   }
1612254f889dSBrendon Cahoon   for (SUnit *SU : NS)
1613fc371558SMatthias Braun     for (const MachineOperand &MO : SU->getInstr()->operands())
1614fc371558SMatthias Braun       if (MO.isReg() && MO.isDef() && !MO.isDead()) {
16150c476111SDaniel Sanders         Register Reg = MO.getReg();
16162bea69bfSDaniel Sanders         if (Register::isVirtualRegister(Reg)) {
1617254f889dSBrendon Cahoon           if (!Uses.count(Reg))
161891b5cf84SKrzysztof Parzyszek             LiveOutRegs.push_back(RegisterMaskPair(Reg,
161991b5cf84SKrzysztof Parzyszek                                                    LaneBitmask::getNone()));
1620254f889dSBrendon Cahoon         } else if (MRI.isAllocatable(Reg)) {
1621c8fcffe7SMircea Trofin           for (MCRegUnitIterator Units(Reg.asMCReg(), TRI); Units.isValid();
1622c8fcffe7SMircea Trofin                ++Units)
1623254f889dSBrendon Cahoon             if (!Uses.count(*Units))
162491b5cf84SKrzysztof Parzyszek               LiveOutRegs.push_back(RegisterMaskPair(*Units,
162591b5cf84SKrzysztof Parzyszek                                                      LaneBitmask::getNone()));
1626254f889dSBrendon Cahoon         }
1627254f889dSBrendon Cahoon       }
1628254f889dSBrendon Cahoon   RPTracker.addLiveRegs(LiveOutRegs);
1629254f889dSBrendon Cahoon }
1630254f889dSBrendon Cahoon 
1631254f889dSBrendon Cahoon /// A heuristic to filter nodes in recurrent node-sets if the register
1632254f889dSBrendon Cahoon /// pressure of a set is too high.
1633254f889dSBrendon Cahoon void SwingSchedulerDAG::registerPressureFilter(NodeSetType &NodeSets) {
1634254f889dSBrendon Cahoon   for (auto &NS : NodeSets) {
1635254f889dSBrendon Cahoon     // Skip small node-sets since they won't cause register pressure problems.
1636254f889dSBrendon Cahoon     if (NS.size() <= 2)
1637254f889dSBrendon Cahoon       continue;
1638254f889dSBrendon Cahoon     IntervalPressure RecRegPressure;
1639254f889dSBrendon Cahoon     RegPressureTracker RecRPTracker(RecRegPressure);
1640254f889dSBrendon Cahoon     RecRPTracker.init(&MF, &RegClassInfo, &LIS, BB, BB->end(), false, true);
1641254f889dSBrendon Cahoon     computeLiveOuts(MF, RecRPTracker, NS);
1642254f889dSBrendon Cahoon     RecRPTracker.closeBottom();
1643254f889dSBrendon Cahoon 
1644254f889dSBrendon Cahoon     std::vector<SUnit *> SUnits(NS.begin(), NS.end());
16450cac726aSFangrui Song     llvm::sort(SUnits, [](const SUnit *A, const SUnit *B) {
1646254f889dSBrendon Cahoon       return A->NodeNum > B->NodeNum;
1647254f889dSBrendon Cahoon     });
1648254f889dSBrendon Cahoon 
1649254f889dSBrendon Cahoon     for (auto &SU : SUnits) {
1650254f889dSBrendon Cahoon       // Since we're computing the register pressure for a subset of the
1651254f889dSBrendon Cahoon       // instructions in a block, we need to set the tracker for each
1652254f889dSBrendon Cahoon       // instruction in the node-set. The tracker is set to the instruction
1653254f889dSBrendon Cahoon       // just after the one we're interested in.
1654254f889dSBrendon Cahoon       MachineBasicBlock::const_iterator CurInstI = SU->getInstr();
1655254f889dSBrendon Cahoon       RecRPTracker.setPos(std::next(CurInstI));
1656254f889dSBrendon Cahoon 
1657254f889dSBrendon Cahoon       RegPressureDelta RPDelta;
1658254f889dSBrendon Cahoon       ArrayRef<PressureChange> CriticalPSets;
1659254f889dSBrendon Cahoon       RecRPTracker.getMaxUpwardPressureDelta(SU->getInstr(), nullptr, RPDelta,
1660254f889dSBrendon Cahoon                                              CriticalPSets,
1661254f889dSBrendon Cahoon                                              RecRegPressure.MaxSetPressure);
1662254f889dSBrendon Cahoon       if (RPDelta.Excess.isValid()) {
1663d34e60caSNicola Zaghen         LLVM_DEBUG(
1664d34e60caSNicola Zaghen             dbgs() << "Excess register pressure: SU(" << SU->NodeNum << ") "
1665254f889dSBrendon Cahoon                    << TRI->getRegPressureSetName(RPDelta.Excess.getPSet())
1666254f889dSBrendon Cahoon                    << ":" << RPDelta.Excess.getUnitInc());
1667254f889dSBrendon Cahoon         NS.setExceedPressure(SU);
1668254f889dSBrendon Cahoon         break;
1669254f889dSBrendon Cahoon       }
1670254f889dSBrendon Cahoon       RecRPTracker.recede();
1671254f889dSBrendon Cahoon     }
1672254f889dSBrendon Cahoon   }
1673254f889dSBrendon Cahoon }
1674254f889dSBrendon Cahoon 
1675254f889dSBrendon Cahoon /// A heuristic to colocate node sets that have the same set of
1676254f889dSBrendon Cahoon /// successors.
1677254f889dSBrendon Cahoon void SwingSchedulerDAG::colocateNodeSets(NodeSetType &NodeSets) {
1678254f889dSBrendon Cahoon   unsigned Colocate = 0;
1679254f889dSBrendon Cahoon   for (int i = 0, e = NodeSets.size(); i < e; ++i) {
1680254f889dSBrendon Cahoon     NodeSet &N1 = NodeSets[i];
1681254f889dSBrendon Cahoon     SmallSetVector<SUnit *, 8> S1;
1682254f889dSBrendon Cahoon     if (N1.empty() || !succ_L(N1, S1))
1683254f889dSBrendon Cahoon       continue;
1684254f889dSBrendon Cahoon     for (int j = i + 1; j < e; ++j) {
1685254f889dSBrendon Cahoon       NodeSet &N2 = NodeSets[j];
1686254f889dSBrendon Cahoon       if (N1.compareRecMII(N2) != 0)
1687254f889dSBrendon Cahoon         continue;
1688254f889dSBrendon Cahoon       SmallSetVector<SUnit *, 8> S2;
1689254f889dSBrendon Cahoon       if (N2.empty() || !succ_L(N2, S2))
1690254f889dSBrendon Cahoon         continue;
1691d6391209SKazu Hirata       if (llvm::set_is_subset(S1, S2) && S1.size() == S2.size()) {
1692254f889dSBrendon Cahoon         N1.setColocate(++Colocate);
1693254f889dSBrendon Cahoon         N2.setColocate(Colocate);
1694254f889dSBrendon Cahoon         break;
1695254f889dSBrendon Cahoon       }
1696254f889dSBrendon Cahoon     }
1697254f889dSBrendon Cahoon   }
1698254f889dSBrendon Cahoon }
1699254f889dSBrendon Cahoon 
1700254f889dSBrendon Cahoon /// Check if the existing node-sets are profitable. If not, then ignore the
1701254f889dSBrendon Cahoon /// recurrent node-sets, and attempt to schedule all nodes together. This is
17023ca23341SKrzysztof Parzyszek /// a heuristic. If the MII is large and all the recurrent node-sets are small,
17033ca23341SKrzysztof Parzyszek /// then it's best to try to schedule all instructions together instead of
17043ca23341SKrzysztof Parzyszek /// starting with the recurrent node-sets.
1705254f889dSBrendon Cahoon void SwingSchedulerDAG::checkNodeSets(NodeSetType &NodeSets) {
1706254f889dSBrendon Cahoon   // Look for loops with a large MII.
17073ca23341SKrzysztof Parzyszek   if (MII < 17)
1708254f889dSBrendon Cahoon     return;
1709254f889dSBrendon Cahoon   // Check if the node-set contains only a simple add recurrence.
17103ca23341SKrzysztof Parzyszek   for (auto &NS : NodeSets) {
17113ca23341SKrzysztof Parzyszek     if (NS.getRecMII() > 2)
1712254f889dSBrendon Cahoon       return;
17133ca23341SKrzysztof Parzyszek     if (NS.getMaxDepth() > MII)
17143ca23341SKrzysztof Parzyszek       return;
17153ca23341SKrzysztof Parzyszek   }
1716254f889dSBrendon Cahoon   NodeSets.clear();
1717d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "Clear recurrence node-sets\n");
1718254f889dSBrendon Cahoon }
1719254f889dSBrendon Cahoon 
1720254f889dSBrendon Cahoon /// Add the nodes that do not belong to a recurrence set into groups
1721*449ef2fcSThomas Preud'homme /// based upon connected components.
1722254f889dSBrendon Cahoon void SwingSchedulerDAG::groupRemainingNodes(NodeSetType &NodeSets) {
1723254f889dSBrendon Cahoon   SetVector<SUnit *> NodesAdded;
1724254f889dSBrendon Cahoon   SmallPtrSet<SUnit *, 8> Visited;
1725254f889dSBrendon Cahoon   // Add the nodes that are on a path between the previous node sets and
1726254f889dSBrendon Cahoon   // the current node set.
1727254f889dSBrendon Cahoon   for (NodeSet &I : NodeSets) {
1728254f889dSBrendon Cahoon     SmallSetVector<SUnit *, 8> N;
1729254f889dSBrendon Cahoon     // Add the nodes from the current node set to the previous node set.
1730254f889dSBrendon Cahoon     if (succ_L(I, N)) {
1731254f889dSBrendon Cahoon       SetVector<SUnit *> Path;
1732254f889dSBrendon Cahoon       for (SUnit *NI : N) {
1733254f889dSBrendon Cahoon         Visited.clear();
1734254f889dSBrendon Cahoon         computePath(NI, Path, NodesAdded, I, Visited);
1735254f889dSBrendon Cahoon       }
173632a40564SEugene Zelenko       if (!Path.empty())
1737254f889dSBrendon Cahoon         I.insert(Path.begin(), Path.end());
1738254f889dSBrendon Cahoon     }
1739254f889dSBrendon Cahoon     // Add the nodes from the previous node set to the current node set.
1740254f889dSBrendon Cahoon     N.clear();
1741254f889dSBrendon Cahoon     if (succ_L(NodesAdded, N)) {
1742254f889dSBrendon Cahoon       SetVector<SUnit *> Path;
1743254f889dSBrendon Cahoon       for (SUnit *NI : N) {
1744254f889dSBrendon Cahoon         Visited.clear();
1745254f889dSBrendon Cahoon         computePath(NI, Path, I, NodesAdded, Visited);
1746254f889dSBrendon Cahoon       }
174732a40564SEugene Zelenko       if (!Path.empty())
1748254f889dSBrendon Cahoon         I.insert(Path.begin(), Path.end());
1749254f889dSBrendon Cahoon     }
1750254f889dSBrendon Cahoon     NodesAdded.insert(I.begin(), I.end());
1751254f889dSBrendon Cahoon   }
1752254f889dSBrendon Cahoon 
1753254f889dSBrendon Cahoon   // Create a new node set with the connected nodes of any successor of a node
1754254f889dSBrendon Cahoon   // in a recurrent set.
1755254f889dSBrendon Cahoon   NodeSet NewSet;
1756254f889dSBrendon Cahoon   SmallSetVector<SUnit *, 8> N;
1757254f889dSBrendon Cahoon   if (succ_L(NodesAdded, N))
1758254f889dSBrendon Cahoon     for (SUnit *I : N)
1759254f889dSBrendon Cahoon       addConnectedNodes(I, NewSet, NodesAdded);
176032a40564SEugene Zelenko   if (!NewSet.empty())
1761254f889dSBrendon Cahoon     NodeSets.push_back(NewSet);
1762254f889dSBrendon Cahoon 
1763254f889dSBrendon Cahoon   // Create a new node set with the connected nodes of any predecessor of a node
1764254f889dSBrendon Cahoon   // in a recurrent set.
1765254f889dSBrendon Cahoon   NewSet.clear();
1766254f889dSBrendon Cahoon   if (pred_L(NodesAdded, N))
1767254f889dSBrendon Cahoon     for (SUnit *I : N)
1768254f889dSBrendon Cahoon       addConnectedNodes(I, NewSet, NodesAdded);
176932a40564SEugene Zelenko   if (!NewSet.empty())
1770254f889dSBrendon Cahoon     NodeSets.push_back(NewSet);
1771254f889dSBrendon Cahoon 
1772372ffa15SHiroshi Inoue   // Create new nodes sets with the connected nodes any remaining node that
1773254f889dSBrendon Cahoon   // has no predecessor.
17743279943aSKazu Hirata   for (SUnit &SU : SUnits) {
17753279943aSKazu Hirata     if (NodesAdded.count(&SU) == 0) {
1776254f889dSBrendon Cahoon       NewSet.clear();
17773279943aSKazu Hirata       addConnectedNodes(&SU, NewSet, NodesAdded);
177832a40564SEugene Zelenko       if (!NewSet.empty())
1779254f889dSBrendon Cahoon         NodeSets.push_back(NewSet);
1780254f889dSBrendon Cahoon     }
1781254f889dSBrendon Cahoon   }
1782254f889dSBrendon Cahoon }
1783254f889dSBrendon Cahoon 
178431f47b81SAlexey Lapshin /// Add the node to the set, and add all of its connected nodes to the set.
1785254f889dSBrendon Cahoon void SwingSchedulerDAG::addConnectedNodes(SUnit *SU, NodeSet &NewSet,
1786254f889dSBrendon Cahoon                                           SetVector<SUnit *> &NodesAdded) {
1787254f889dSBrendon Cahoon   NewSet.insert(SU);
1788254f889dSBrendon Cahoon   NodesAdded.insert(SU);
1789254f889dSBrendon Cahoon   for (auto &SI : SU->Succs) {
1790254f889dSBrendon Cahoon     SUnit *Successor = SI.getSUnit();
1791254f889dSBrendon Cahoon     if (!SI.isArtificial() && NodesAdded.count(Successor) == 0)
1792254f889dSBrendon Cahoon       addConnectedNodes(Successor, NewSet, NodesAdded);
1793254f889dSBrendon Cahoon   }
1794254f889dSBrendon Cahoon   for (auto &PI : SU->Preds) {
1795254f889dSBrendon Cahoon     SUnit *Predecessor = PI.getSUnit();
1796254f889dSBrendon Cahoon     if (!PI.isArtificial() && NodesAdded.count(Predecessor) == 0)
1797254f889dSBrendon Cahoon       addConnectedNodes(Predecessor, NewSet, NodesAdded);
1798254f889dSBrendon Cahoon   }
1799254f889dSBrendon Cahoon }
1800254f889dSBrendon Cahoon 
1801254f889dSBrendon Cahoon /// Return true if Set1 contains elements in Set2. The elements in common
1802254f889dSBrendon Cahoon /// are returned in a different container.
1803254f889dSBrendon Cahoon static bool isIntersect(SmallSetVector<SUnit *, 8> &Set1, const NodeSet &Set2,
1804254f889dSBrendon Cahoon                         SmallSetVector<SUnit *, 8> &Result) {
1805254f889dSBrendon Cahoon   Result.clear();
1806254f889dSBrendon Cahoon   for (unsigned i = 0, e = Set1.size(); i != e; ++i) {
1807254f889dSBrendon Cahoon     SUnit *SU = Set1[i];
1808254f889dSBrendon Cahoon     if (Set2.count(SU) != 0)
1809254f889dSBrendon Cahoon       Result.insert(SU);
1810254f889dSBrendon Cahoon   }
1811254f889dSBrendon Cahoon   return !Result.empty();
1812254f889dSBrendon Cahoon }
1813254f889dSBrendon Cahoon 
1814254f889dSBrendon Cahoon /// Merge the recurrence node sets that have the same initial node.
1815254f889dSBrendon Cahoon void SwingSchedulerDAG::fuseRecs(NodeSetType &NodeSets) {
1816254f889dSBrendon Cahoon   for (NodeSetType::iterator I = NodeSets.begin(), E = NodeSets.end(); I != E;
1817254f889dSBrendon Cahoon        ++I) {
1818254f889dSBrendon Cahoon     NodeSet &NI = *I;
1819254f889dSBrendon Cahoon     for (NodeSetType::iterator J = I + 1; J != E;) {
1820254f889dSBrendon Cahoon       NodeSet &NJ = *J;
1821254f889dSBrendon Cahoon       if (NI.getNode(0)->NodeNum == NJ.getNode(0)->NodeNum) {
1822254f889dSBrendon Cahoon         if (NJ.compareRecMII(NI) > 0)
1823254f889dSBrendon Cahoon           NI.setRecMII(NJ.getRecMII());
18243279943aSKazu Hirata         for (SUnit *SU : *J)
18253279943aSKazu Hirata           I->insert(SU);
1826254f889dSBrendon Cahoon         NodeSets.erase(J);
1827254f889dSBrendon Cahoon         E = NodeSets.end();
1828254f889dSBrendon Cahoon       } else {
1829254f889dSBrendon Cahoon         ++J;
1830254f889dSBrendon Cahoon       }
1831254f889dSBrendon Cahoon     }
1832254f889dSBrendon Cahoon   }
1833254f889dSBrendon Cahoon }
1834254f889dSBrendon Cahoon 
1835254f889dSBrendon Cahoon /// Remove nodes that have been scheduled in previous NodeSets.
1836254f889dSBrendon Cahoon void SwingSchedulerDAG::removeDuplicateNodes(NodeSetType &NodeSets) {
1837254f889dSBrendon Cahoon   for (NodeSetType::iterator I = NodeSets.begin(), E = NodeSets.end(); I != E;
1838254f889dSBrendon Cahoon        ++I)
1839254f889dSBrendon Cahoon     for (NodeSetType::iterator J = I + 1; J != E;) {
1840254f889dSBrendon Cahoon       J->remove_if([&](SUnit *SUJ) { return I->count(SUJ); });
1841254f889dSBrendon Cahoon 
184232a40564SEugene Zelenko       if (J->empty()) {
1843254f889dSBrendon Cahoon         NodeSets.erase(J);
1844254f889dSBrendon Cahoon         E = NodeSets.end();
1845254f889dSBrendon Cahoon       } else {
1846254f889dSBrendon Cahoon         ++J;
1847254f889dSBrendon Cahoon       }
1848254f889dSBrendon Cahoon     }
1849254f889dSBrendon Cahoon }
1850254f889dSBrendon Cahoon 
1851254f889dSBrendon Cahoon /// Compute an ordered list of the dependence graph nodes, which
1852254f889dSBrendon Cahoon /// indicates the order that the nodes will be scheduled.  This is a
1853254f889dSBrendon Cahoon /// two-level algorithm. First, a partial order is created, which
1854254f889dSBrendon Cahoon /// consists of a list of sets ordered from highest to lowest priority.
1855254f889dSBrendon Cahoon void SwingSchedulerDAG::computeNodeOrder(NodeSetType &NodeSets) {
1856254f889dSBrendon Cahoon   SmallSetVector<SUnit *, 8> R;
1857254f889dSBrendon Cahoon   NodeOrder.clear();
1858254f889dSBrendon Cahoon 
1859254f889dSBrendon Cahoon   for (auto &Nodes : NodeSets) {
1860d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << "NodeSet size " << Nodes.size() << "\n");
1861254f889dSBrendon Cahoon     OrderKind Order;
1862254f889dSBrendon Cahoon     SmallSetVector<SUnit *, 8> N;
1863d6391209SKazu Hirata     if (pred_L(NodeOrder, N) && llvm::set_is_subset(N, Nodes)) {
1864254f889dSBrendon Cahoon       R.insert(N.begin(), N.end());
1865254f889dSBrendon Cahoon       Order = BottomUp;
1866d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  Bottom up (preds) ");
1867d6391209SKazu Hirata     } else if (succ_L(NodeOrder, N) && llvm::set_is_subset(N, Nodes)) {
1868254f889dSBrendon Cahoon       R.insert(N.begin(), N.end());
1869254f889dSBrendon Cahoon       Order = TopDown;
1870d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  Top down (succs) ");
1871254f889dSBrendon Cahoon     } else if (isIntersect(N, Nodes, R)) {
1872254f889dSBrendon Cahoon       // If some of the successors are in the existing node-set, then use the
1873254f889dSBrendon Cahoon       // top-down ordering.
1874254f889dSBrendon Cahoon       Order = TopDown;
1875d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  Top down (intersect) ");
1876254f889dSBrendon Cahoon     } else if (NodeSets.size() == 1) {
1877254f889dSBrendon Cahoon       for (auto &N : Nodes)
1878254f889dSBrendon Cahoon         if (N->Succs.size() == 0)
1879254f889dSBrendon Cahoon           R.insert(N);
1880254f889dSBrendon Cahoon       Order = BottomUp;
1881d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  Bottom up (all) ");
1882254f889dSBrendon Cahoon     } else {
1883254f889dSBrendon Cahoon       // Find the node with the highest ASAP.
1884254f889dSBrendon Cahoon       SUnit *maxASAP = nullptr;
1885254f889dSBrendon Cahoon       for (SUnit *SU : Nodes) {
1886a2122044SKrzysztof Parzyszek         if (maxASAP == nullptr || getASAP(SU) > getASAP(maxASAP) ||
1887a2122044SKrzysztof Parzyszek             (getASAP(SU) == getASAP(maxASAP) && SU->NodeNum > maxASAP->NodeNum))
1888254f889dSBrendon Cahoon           maxASAP = SU;
1889254f889dSBrendon Cahoon       }
1890254f889dSBrendon Cahoon       R.insert(maxASAP);
1891254f889dSBrendon Cahoon       Order = BottomUp;
1892d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  Bottom up (default) ");
1893254f889dSBrendon Cahoon     }
1894254f889dSBrendon Cahoon 
1895254f889dSBrendon Cahoon     while (!R.empty()) {
1896254f889dSBrendon Cahoon       if (Order == TopDown) {
1897254f889dSBrendon Cahoon         // Choose the node with the maximum height.  If more than one, choose
1898a2122044SKrzysztof Parzyszek         // the node wiTH the maximum ZeroLatencyHeight. If still more than one,
18994b8bcf00SRoorda, Jan-Willem         // choose the node with the lowest MOV.
1900254f889dSBrendon Cahoon         while (!R.empty()) {
1901254f889dSBrendon Cahoon           SUnit *maxHeight = nullptr;
1902254f889dSBrendon Cahoon           for (SUnit *I : R) {
1903cdc71612SEugene Zelenko             if (maxHeight == nullptr || getHeight(I) > getHeight(maxHeight))
1904254f889dSBrendon Cahoon               maxHeight = I;
1905254f889dSBrendon Cahoon             else if (getHeight(I) == getHeight(maxHeight) &&
19064b8bcf00SRoorda, Jan-Willem                      getZeroLatencyHeight(I) > getZeroLatencyHeight(maxHeight))
1907254f889dSBrendon Cahoon               maxHeight = I;
19084b8bcf00SRoorda, Jan-Willem             else if (getHeight(I) == getHeight(maxHeight) &&
19094b8bcf00SRoorda, Jan-Willem                      getZeroLatencyHeight(I) ==
19104b8bcf00SRoorda, Jan-Willem                          getZeroLatencyHeight(maxHeight) &&
19114b8bcf00SRoorda, Jan-Willem                      getMOV(I) < getMOV(maxHeight))
1912254f889dSBrendon Cahoon               maxHeight = I;
1913254f889dSBrendon Cahoon           }
1914254f889dSBrendon Cahoon           NodeOrder.insert(maxHeight);
1915d34e60caSNicola Zaghen           LLVM_DEBUG(dbgs() << maxHeight->NodeNum << " ");
1916254f889dSBrendon Cahoon           R.remove(maxHeight);
1917254f889dSBrendon Cahoon           for (const auto &I : maxHeight->Succs) {
1918254f889dSBrendon Cahoon             if (Nodes.count(I.getSUnit()) == 0)
1919254f889dSBrendon Cahoon               continue;
1920b7c5e0b0SKazu Hirata             if (NodeOrder.contains(I.getSUnit()))
1921254f889dSBrendon Cahoon               continue;
1922254f889dSBrendon Cahoon             if (ignoreDependence(I, false))
1923254f889dSBrendon Cahoon               continue;
1924254f889dSBrendon Cahoon             R.insert(I.getSUnit());
1925254f889dSBrendon Cahoon           }
1926254f889dSBrendon Cahoon           // Back-edges are predecessors with an anti-dependence.
1927254f889dSBrendon Cahoon           for (const auto &I : maxHeight->Preds) {
1928254f889dSBrendon Cahoon             if (I.getKind() != SDep::Anti)
1929254f889dSBrendon Cahoon               continue;
1930254f889dSBrendon Cahoon             if (Nodes.count(I.getSUnit()) == 0)
1931254f889dSBrendon Cahoon               continue;
1932b7c5e0b0SKazu Hirata             if (NodeOrder.contains(I.getSUnit()))
1933254f889dSBrendon Cahoon               continue;
1934254f889dSBrendon Cahoon             R.insert(I.getSUnit());
1935254f889dSBrendon Cahoon           }
1936254f889dSBrendon Cahoon         }
1937254f889dSBrendon Cahoon         Order = BottomUp;
1938d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "\n   Switching order to bottom up ");
1939254f889dSBrendon Cahoon         SmallSetVector<SUnit *, 8> N;
1940254f889dSBrendon Cahoon         if (pred_L(NodeOrder, N, &Nodes))
1941254f889dSBrendon Cahoon           R.insert(N.begin(), N.end());
1942254f889dSBrendon Cahoon       } else {
1943254f889dSBrendon Cahoon         // Choose the node with the maximum depth.  If more than one, choose
19444b8bcf00SRoorda, Jan-Willem         // the node with the maximum ZeroLatencyDepth. If still more than one,
19454b8bcf00SRoorda, Jan-Willem         // choose the node with the lowest MOV.
1946254f889dSBrendon Cahoon         while (!R.empty()) {
1947254f889dSBrendon Cahoon           SUnit *maxDepth = nullptr;
1948254f889dSBrendon Cahoon           for (SUnit *I : R) {
1949cdc71612SEugene Zelenko             if (maxDepth == nullptr || getDepth(I) > getDepth(maxDepth))
1950254f889dSBrendon Cahoon               maxDepth = I;
1951254f889dSBrendon Cahoon             else if (getDepth(I) == getDepth(maxDepth) &&
19524b8bcf00SRoorda, Jan-Willem                      getZeroLatencyDepth(I) > getZeroLatencyDepth(maxDepth))
1953254f889dSBrendon Cahoon               maxDepth = I;
19544b8bcf00SRoorda, Jan-Willem             else if (getDepth(I) == getDepth(maxDepth) &&
19554b8bcf00SRoorda, Jan-Willem                      getZeroLatencyDepth(I) == getZeroLatencyDepth(maxDepth) &&
19564b8bcf00SRoorda, Jan-Willem                      getMOV(I) < getMOV(maxDepth))
1957254f889dSBrendon Cahoon               maxDepth = I;
1958254f889dSBrendon Cahoon           }
1959254f889dSBrendon Cahoon           NodeOrder.insert(maxDepth);
1960d34e60caSNicola Zaghen           LLVM_DEBUG(dbgs() << maxDepth->NodeNum << " ");
1961254f889dSBrendon Cahoon           R.remove(maxDepth);
1962254f889dSBrendon Cahoon           if (Nodes.isExceedSU(maxDepth)) {
1963254f889dSBrendon Cahoon             Order = TopDown;
1964254f889dSBrendon Cahoon             R.clear();
1965254f889dSBrendon Cahoon             R.insert(Nodes.getNode(0));
1966254f889dSBrendon Cahoon             break;
1967254f889dSBrendon Cahoon           }
1968254f889dSBrendon Cahoon           for (const auto &I : maxDepth->Preds) {
1969254f889dSBrendon Cahoon             if (Nodes.count(I.getSUnit()) == 0)
1970254f889dSBrendon Cahoon               continue;
1971b7c5e0b0SKazu Hirata             if (NodeOrder.contains(I.getSUnit()))
1972254f889dSBrendon Cahoon               continue;
1973254f889dSBrendon Cahoon             R.insert(I.getSUnit());
1974254f889dSBrendon Cahoon           }
1975254f889dSBrendon Cahoon           // Back-edges are predecessors with an anti-dependence.
1976254f889dSBrendon Cahoon           for (const auto &I : maxDepth->Succs) {
1977254f889dSBrendon Cahoon             if (I.getKind() != SDep::Anti)
1978254f889dSBrendon Cahoon               continue;
1979254f889dSBrendon Cahoon             if (Nodes.count(I.getSUnit()) == 0)
1980254f889dSBrendon Cahoon               continue;
1981b7c5e0b0SKazu Hirata             if (NodeOrder.contains(I.getSUnit()))
1982254f889dSBrendon Cahoon               continue;
1983254f889dSBrendon Cahoon             R.insert(I.getSUnit());
1984254f889dSBrendon Cahoon           }
1985254f889dSBrendon Cahoon         }
1986254f889dSBrendon Cahoon         Order = TopDown;
1987d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "\n   Switching order to top down ");
1988254f889dSBrendon Cahoon         SmallSetVector<SUnit *, 8> N;
1989254f889dSBrendon Cahoon         if (succ_L(NodeOrder, N, &Nodes))
1990254f889dSBrendon Cahoon           R.insert(N.begin(), N.end());
1991254f889dSBrendon Cahoon       }
1992254f889dSBrendon Cahoon     }
1993d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << "\nDone with Nodeset\n");
1994254f889dSBrendon Cahoon   }
1995254f889dSBrendon Cahoon 
1996d34e60caSNicola Zaghen   LLVM_DEBUG({
1997254f889dSBrendon Cahoon     dbgs() << "Node order: ";
1998254f889dSBrendon Cahoon     for (SUnit *I : NodeOrder)
1999254f889dSBrendon Cahoon       dbgs() << " " << I->NodeNum << " ";
2000254f889dSBrendon Cahoon     dbgs() << "\n";
2001254f889dSBrendon Cahoon   });
2002254f889dSBrendon Cahoon }
2003254f889dSBrendon Cahoon 
2004254f889dSBrendon Cahoon /// Process the nodes in the computed order and create the pipelined schedule
2005254f889dSBrendon Cahoon /// of the instructions, if possible. Return true if a schedule is found.
2006254f889dSBrendon Cahoon bool SwingSchedulerDAG::schedulePipeline(SMSchedule &Schedule) {
200718e7bf5cSJinsong Ji 
200818e7bf5cSJinsong Ji   if (NodeOrder.empty()){
200918e7bf5cSJinsong Ji     LLVM_DEBUG(dbgs() << "NodeOrder is empty! abort scheduling\n" );
2010254f889dSBrendon Cahoon     return false;
201118e7bf5cSJinsong Ji   }
2012254f889dSBrendon Cahoon 
2013254f889dSBrendon Cahoon   bool scheduleFound = false;
2014254f889dSBrendon Cahoon   // Keep increasing II until a valid schedule is found.
2015f0ec9f1bSMarianne Mailhot-Sarrasin   for (unsigned II = MII; II <= MAX_II && !scheduleFound; ++II) {
2016254f889dSBrendon Cahoon     Schedule.reset();
2017254f889dSBrendon Cahoon     Schedule.setInitiationInterval(II);
2018d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << "Try to schedule with " << II << "\n");
2019254f889dSBrendon Cahoon 
2020254f889dSBrendon Cahoon     SetVector<SUnit *>::iterator NI = NodeOrder.begin();
2021254f889dSBrendon Cahoon     SetVector<SUnit *>::iterator NE = NodeOrder.end();
2022254f889dSBrendon Cahoon     do {
2023254f889dSBrendon Cahoon       SUnit *SU = *NI;
2024254f889dSBrendon Cahoon 
2025254f889dSBrendon Cahoon       // Compute the schedule time for the instruction, which is based
2026254f889dSBrendon Cahoon       // upon the scheduled time for any predecessors/successors.
2027254f889dSBrendon Cahoon       int EarlyStart = INT_MIN;
2028254f889dSBrendon Cahoon       int LateStart = INT_MAX;
2029254f889dSBrendon Cahoon       // These values are set when the size of the schedule window is limited
2030254f889dSBrendon Cahoon       // due to chain dependences.
2031254f889dSBrendon Cahoon       int SchedEnd = INT_MAX;
2032254f889dSBrendon Cahoon       int SchedStart = INT_MIN;
2033254f889dSBrendon Cahoon       Schedule.computeStart(SU, &EarlyStart, &LateStart, &SchedEnd, &SchedStart,
2034254f889dSBrendon Cahoon                             II, this);
2035d34e60caSNicola Zaghen       LLVM_DEBUG({
203618e7bf5cSJinsong Ji         dbgs() << "\n";
2037254f889dSBrendon Cahoon         dbgs() << "Inst (" << SU->NodeNum << ") ";
2038254f889dSBrendon Cahoon         SU->getInstr()->dump();
2039254f889dSBrendon Cahoon         dbgs() << "\n";
2040254f889dSBrendon Cahoon       });
2041d34e60caSNicola Zaghen       LLVM_DEBUG({
204218e7bf5cSJinsong Ji         dbgs() << format("\tes: %8x ls: %8x me: %8x ms: %8x\n", EarlyStart,
204318e7bf5cSJinsong Ji                          LateStart, SchedEnd, SchedStart);
2044254f889dSBrendon Cahoon       });
2045254f889dSBrendon Cahoon 
2046254f889dSBrendon Cahoon       if (EarlyStart > LateStart || SchedEnd < EarlyStart ||
2047254f889dSBrendon Cahoon           SchedStart > LateStart)
2048254f889dSBrendon Cahoon         scheduleFound = false;
2049254f889dSBrendon Cahoon       else if (EarlyStart != INT_MIN && LateStart == INT_MAX) {
2050254f889dSBrendon Cahoon         SchedEnd = std::min(SchedEnd, EarlyStart + (int)II - 1);
2051254f889dSBrendon Cahoon         scheduleFound = Schedule.insert(SU, EarlyStart, SchedEnd, II);
2052254f889dSBrendon Cahoon       } else if (EarlyStart == INT_MIN && LateStart != INT_MAX) {
2053254f889dSBrendon Cahoon         SchedStart = std::max(SchedStart, LateStart - (int)II + 1);
2054254f889dSBrendon Cahoon         scheduleFound = Schedule.insert(SU, LateStart, SchedStart, II);
2055254f889dSBrendon Cahoon       } else if (EarlyStart != INT_MIN && LateStart != INT_MAX) {
2056254f889dSBrendon Cahoon         SchedEnd =
2057254f889dSBrendon Cahoon             std::min(SchedEnd, std::min(LateStart, EarlyStart + (int)II - 1));
2058254f889dSBrendon Cahoon         // When scheduling a Phi it is better to start at the late cycle and go
2059254f889dSBrendon Cahoon         // backwards. The default order may insert the Phi too far away from
2060254f889dSBrendon Cahoon         // its first dependence.
2061254f889dSBrendon Cahoon         if (SU->getInstr()->isPHI())
2062254f889dSBrendon Cahoon           scheduleFound = Schedule.insert(SU, SchedEnd, EarlyStart, II);
2063254f889dSBrendon Cahoon         else
2064254f889dSBrendon Cahoon           scheduleFound = Schedule.insert(SU, EarlyStart, SchedEnd, II);
2065254f889dSBrendon Cahoon       } else {
2066254f889dSBrendon Cahoon         int FirstCycle = Schedule.getFirstCycle();
2067254f889dSBrendon Cahoon         scheduleFound = Schedule.insert(SU, FirstCycle + getASAP(SU),
2068254f889dSBrendon Cahoon                                         FirstCycle + getASAP(SU) + II - 1, II);
2069254f889dSBrendon Cahoon       }
2070254f889dSBrendon Cahoon       // Even if we find a schedule, make sure the schedule doesn't exceed the
2071254f889dSBrendon Cahoon       // allowable number of stages. We keep trying if this happens.
2072254f889dSBrendon Cahoon       if (scheduleFound)
2073254f889dSBrendon Cahoon         if (SwpMaxStages > -1 &&
2074254f889dSBrendon Cahoon             Schedule.getMaxStageCount() > (unsigned)SwpMaxStages)
2075254f889dSBrendon Cahoon           scheduleFound = false;
2076254f889dSBrendon Cahoon 
2077d34e60caSNicola Zaghen       LLVM_DEBUG({
2078254f889dSBrendon Cahoon         if (!scheduleFound)
2079254f889dSBrendon Cahoon           dbgs() << "\tCan't schedule\n";
2080254f889dSBrendon Cahoon       });
2081254f889dSBrendon Cahoon     } while (++NI != NE && scheduleFound);
2082254f889dSBrendon Cahoon 
2083254f889dSBrendon Cahoon     // If a schedule is found, check if it is a valid schedule too.
2084254f889dSBrendon Cahoon     if (scheduleFound)
2085254f889dSBrendon Cahoon       scheduleFound = Schedule.isValidSchedule(this);
2086254f889dSBrendon Cahoon   }
2087254f889dSBrendon Cahoon 
2088f0ec9f1bSMarianne Mailhot-Sarrasin   LLVM_DEBUG(dbgs() << "Schedule Found? " << scheduleFound
2089f0ec9f1bSMarianne Mailhot-Sarrasin                     << " (II=" << Schedule.getInitiationInterval()
209059d99731SBrendon Cahoon                     << ")\n");
2091254f889dSBrendon Cahoon 
209280b78a47SJinsong Ji   if (scheduleFound) {
2093254f889dSBrendon Cahoon     Schedule.finalizeSchedule(this);
209480b78a47SJinsong Ji     Pass.ORE->emit([&]() {
209580b78a47SJinsong Ji       return MachineOptimizationRemarkAnalysis(
209680b78a47SJinsong Ji                  DEBUG_TYPE, "schedule", Loop.getStartLoc(), Loop.getHeader())
2097f0ec9f1bSMarianne Mailhot-Sarrasin              << "Schedule found with Initiation Interval: "
2098f0ec9f1bSMarianne Mailhot-Sarrasin              << ore::NV("II", Schedule.getInitiationInterval())
209980b78a47SJinsong Ji              << ", MaxStageCount: "
210080b78a47SJinsong Ji              << ore::NV("MaxStageCount", Schedule.getMaxStageCount());
210180b78a47SJinsong Ji     });
210280b78a47SJinsong Ji   } else
2103254f889dSBrendon Cahoon     Schedule.reset();
2104254f889dSBrendon Cahoon 
2105254f889dSBrendon Cahoon   return scheduleFound && Schedule.getMaxStageCount() > 0;
2106254f889dSBrendon Cahoon }
2107254f889dSBrendon Cahoon 
2108254f889dSBrendon Cahoon /// Return true if we can compute the amount the instruction changes
2109254f889dSBrendon Cahoon /// during each iteration. Set Delta to the amount of the change.
2110254f889dSBrendon Cahoon bool SwingSchedulerDAG::computeDelta(MachineInstr &MI, unsigned &Delta) {
2111254f889dSBrendon Cahoon   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
2112238c9d63SBjorn Pettersson   const MachineOperand *BaseOp;
2113254f889dSBrendon Cahoon   int64_t Offset;
21148fbc9258SSander de Smalen   bool OffsetIsScalable;
21158fbc9258SSander de Smalen   if (!TII->getMemOperandWithOffset(MI, BaseOp, Offset, OffsetIsScalable, TRI))
21168fbc9258SSander de Smalen     return false;
21178fbc9258SSander de Smalen 
21188fbc9258SSander de Smalen   // FIXME: This algorithm assumes instructions have fixed-size offsets.
21198fbc9258SSander de Smalen   if (OffsetIsScalable)
2120254f889dSBrendon Cahoon     return false;
2121254f889dSBrendon Cahoon 
2122d7eebd6dSFrancis Visoiu Mistrih   if (!BaseOp->isReg())
2123d7eebd6dSFrancis Visoiu Mistrih     return false;
2124d7eebd6dSFrancis Visoiu Mistrih 
21250c476111SDaniel Sanders   Register BaseReg = BaseOp->getReg();
2126d7eebd6dSFrancis Visoiu Mistrih 
2127254f889dSBrendon Cahoon   MachineRegisterInfo &MRI = MF.getRegInfo();
2128254f889dSBrendon Cahoon   // Check if there is a Phi. If so, get the definition in the loop.
2129254f889dSBrendon Cahoon   MachineInstr *BaseDef = MRI.getVRegDef(BaseReg);
2130254f889dSBrendon Cahoon   if (BaseDef && BaseDef->isPHI()) {
2131254f889dSBrendon Cahoon     BaseReg = getLoopPhiReg(*BaseDef, MI.getParent());
2132254f889dSBrendon Cahoon     BaseDef = MRI.getVRegDef(BaseReg);
2133254f889dSBrendon Cahoon   }
2134254f889dSBrendon Cahoon   if (!BaseDef)
2135254f889dSBrendon Cahoon     return false;
2136254f889dSBrendon Cahoon 
2137254f889dSBrendon Cahoon   int D = 0;
21388fb181caSKrzysztof Parzyszek   if (!TII->getIncrementValue(*BaseDef, D) && D >= 0)
2139254f889dSBrendon Cahoon     return false;
2140254f889dSBrendon Cahoon 
2141254f889dSBrendon Cahoon   Delta = D;
2142254f889dSBrendon Cahoon   return true;
2143254f889dSBrendon Cahoon }
2144254f889dSBrendon Cahoon 
2145254f889dSBrendon Cahoon /// Check if we can change the instruction to use an offset value from the
2146254f889dSBrendon Cahoon /// previous iteration. If so, return true and set the base and offset values
2147254f889dSBrendon Cahoon /// so that we can rewrite the load, if necessary.
2148254f889dSBrendon Cahoon ///   v1 = Phi(v0, v3)
2149254f889dSBrendon Cahoon ///   v2 = load v1, 0
2150254f889dSBrendon Cahoon ///   v3 = post_store v1, 4, x
2151254f889dSBrendon Cahoon /// This function enables the load to be rewritten as v2 = load v3, 4.
2152254f889dSBrendon Cahoon bool SwingSchedulerDAG::canUseLastOffsetValue(MachineInstr *MI,
2153254f889dSBrendon Cahoon                                               unsigned &BasePos,
2154254f889dSBrendon Cahoon                                               unsigned &OffsetPos,
2155254f889dSBrendon Cahoon                                               unsigned &NewBase,
2156254f889dSBrendon Cahoon                                               int64_t &Offset) {
2157254f889dSBrendon Cahoon   // Get the load instruction.
21588fb181caSKrzysztof Parzyszek   if (TII->isPostIncrement(*MI))
2159254f889dSBrendon Cahoon     return false;
2160254f889dSBrendon Cahoon   unsigned BasePosLd, OffsetPosLd;
21618fb181caSKrzysztof Parzyszek   if (!TII->getBaseAndOffsetPosition(*MI, BasePosLd, OffsetPosLd))
2162254f889dSBrendon Cahoon     return false;
21630c476111SDaniel Sanders   Register BaseReg = MI->getOperand(BasePosLd).getReg();
2164254f889dSBrendon Cahoon 
2165254f889dSBrendon Cahoon   // Look for the Phi instruction.
2166fdf9bf4fSJustin Bogner   MachineRegisterInfo &MRI = MI->getMF()->getRegInfo();
2167254f889dSBrendon Cahoon   MachineInstr *Phi = MRI.getVRegDef(BaseReg);
2168254f889dSBrendon Cahoon   if (!Phi || !Phi->isPHI())
2169254f889dSBrendon Cahoon     return false;
2170254f889dSBrendon Cahoon   // Get the register defined in the loop block.
2171254f889dSBrendon Cahoon   unsigned PrevReg = getLoopPhiReg(*Phi, MI->getParent());
2172254f889dSBrendon Cahoon   if (!PrevReg)
2173254f889dSBrendon Cahoon     return false;
2174254f889dSBrendon Cahoon 
2175254f889dSBrendon Cahoon   // Check for the post-increment load/store instruction.
2176254f889dSBrendon Cahoon   MachineInstr *PrevDef = MRI.getVRegDef(PrevReg);
2177254f889dSBrendon Cahoon   if (!PrevDef || PrevDef == MI)
2178254f889dSBrendon Cahoon     return false;
2179254f889dSBrendon Cahoon 
21808fb181caSKrzysztof Parzyszek   if (!TII->isPostIncrement(*PrevDef))
2181254f889dSBrendon Cahoon     return false;
2182254f889dSBrendon Cahoon 
2183254f889dSBrendon Cahoon   unsigned BasePos1 = 0, OffsetPos1 = 0;
21848fb181caSKrzysztof Parzyszek   if (!TII->getBaseAndOffsetPosition(*PrevDef, BasePos1, OffsetPos1))
2185254f889dSBrendon Cahoon     return false;
2186254f889dSBrendon Cahoon 
218740df8a2bSKrzysztof Parzyszek   // Make sure that the instructions do not access the same memory location in
218840df8a2bSKrzysztof Parzyszek   // the next iteration.
2189254f889dSBrendon Cahoon   int64_t LoadOffset = MI->getOperand(OffsetPosLd).getImm();
2190254f889dSBrendon Cahoon   int64_t StoreOffset = PrevDef->getOperand(OffsetPos1).getImm();
219140df8a2bSKrzysztof Parzyszek   MachineInstr *NewMI = MF.CloneMachineInstr(MI);
219240df8a2bSKrzysztof Parzyszek   NewMI->getOperand(OffsetPosLd).setImm(LoadOffset + StoreOffset);
219340df8a2bSKrzysztof Parzyszek   bool Disjoint = TII->areMemAccessesTriviallyDisjoint(*NewMI, *PrevDef);
2194b0127424SMircea Trofin   MF.deleteMachineInstr(NewMI);
219540df8a2bSKrzysztof Parzyszek   if (!Disjoint)
2196254f889dSBrendon Cahoon     return false;
2197254f889dSBrendon Cahoon 
2198254f889dSBrendon Cahoon   // Set the return value once we determine that we return true.
2199254f889dSBrendon Cahoon   BasePos = BasePosLd;
2200254f889dSBrendon Cahoon   OffsetPos = OffsetPosLd;
2201254f889dSBrendon Cahoon   NewBase = PrevReg;
2202254f889dSBrendon Cahoon   Offset = StoreOffset;
2203254f889dSBrendon Cahoon   return true;
2204254f889dSBrendon Cahoon }
2205254f889dSBrendon Cahoon 
2206254f889dSBrendon Cahoon /// Apply changes to the instruction if needed. The changes are need
2207254f889dSBrendon Cahoon /// to improve the scheduling and depend up on the final schedule.
22088f174ddeSKrzysztof Parzyszek void SwingSchedulerDAG::applyInstrChange(MachineInstr *MI,
22098f174ddeSKrzysztof Parzyszek                                          SMSchedule &Schedule) {
2210254f889dSBrendon Cahoon   SUnit *SU = getSUnit(MI);
2211254f889dSBrendon Cahoon   DenseMap<SUnit *, std::pair<unsigned, int64_t>>::iterator It =
2212254f889dSBrendon Cahoon       InstrChanges.find(SU);
2213254f889dSBrendon Cahoon   if (It != InstrChanges.end()) {
2214254f889dSBrendon Cahoon     std::pair<unsigned, int64_t> RegAndOffset = It->second;
2215254f889dSBrendon Cahoon     unsigned BasePos, OffsetPos;
22168fb181caSKrzysztof Parzyszek     if (!TII->getBaseAndOffsetPosition(*MI, BasePos, OffsetPos))
22178f174ddeSKrzysztof Parzyszek       return;
22180c476111SDaniel Sanders     Register BaseReg = MI->getOperand(BasePos).getReg();
2219254f889dSBrendon Cahoon     MachineInstr *LoopDef = findDefInLoop(BaseReg);
2220254f889dSBrendon Cahoon     int DefStageNum = Schedule.stageScheduled(getSUnit(LoopDef));
2221254f889dSBrendon Cahoon     int DefCycleNum = Schedule.cycleScheduled(getSUnit(LoopDef));
2222254f889dSBrendon Cahoon     int BaseStageNum = Schedule.stageScheduled(SU);
2223254f889dSBrendon Cahoon     int BaseCycleNum = Schedule.cycleScheduled(SU);
2224254f889dSBrendon Cahoon     if (BaseStageNum < DefStageNum) {
2225254f889dSBrendon Cahoon       MachineInstr *NewMI = MF.CloneMachineInstr(MI);
2226254f889dSBrendon Cahoon       int OffsetDiff = DefStageNum - BaseStageNum;
2227254f889dSBrendon Cahoon       if (DefCycleNum < BaseCycleNum) {
2228254f889dSBrendon Cahoon         NewMI->getOperand(BasePos).setReg(RegAndOffset.first);
2229254f889dSBrendon Cahoon         if (OffsetDiff > 0)
2230254f889dSBrendon Cahoon           --OffsetDiff;
2231254f889dSBrendon Cahoon       }
2232254f889dSBrendon Cahoon       int64_t NewOffset =
2233254f889dSBrendon Cahoon           MI->getOperand(OffsetPos).getImm() + RegAndOffset.second * OffsetDiff;
2234254f889dSBrendon Cahoon       NewMI->getOperand(OffsetPos).setImm(NewOffset);
2235254f889dSBrendon Cahoon       SU->setInstr(NewMI);
2236254f889dSBrendon Cahoon       MISUnitMap[NewMI] = SU;
2237790a779fSJames Molloy       NewMIs[MI] = NewMI;
2238254f889dSBrendon Cahoon     }
2239254f889dSBrendon Cahoon   }
2240254f889dSBrendon Cahoon }
2241254f889dSBrendon Cahoon 
2242790a779fSJames Molloy /// Return the instruction in the loop that defines the register.
2243790a779fSJames Molloy /// If the definition is a Phi, then follow the Phi operand to
2244790a779fSJames Molloy /// the instruction in the loop.
2245c8fcffe7SMircea Trofin MachineInstr *SwingSchedulerDAG::findDefInLoop(Register Reg) {
2246790a779fSJames Molloy   SmallPtrSet<MachineInstr *, 8> Visited;
2247790a779fSJames Molloy   MachineInstr *Def = MRI.getVRegDef(Reg);
2248790a779fSJames Molloy   while (Def->isPHI()) {
2249790a779fSJames Molloy     if (!Visited.insert(Def).second)
2250790a779fSJames Molloy       break;
2251790a779fSJames Molloy     for (unsigned i = 1, e = Def->getNumOperands(); i < e; i += 2)
2252790a779fSJames Molloy       if (Def->getOperand(i + 1).getMBB() == BB) {
2253790a779fSJames Molloy         Def = MRI.getVRegDef(Def->getOperand(i).getReg());
2254790a779fSJames Molloy         break;
2255790a779fSJames Molloy       }
2256790a779fSJames Molloy   }
2257790a779fSJames Molloy   return Def;
2258790a779fSJames Molloy }
2259790a779fSJames Molloy 
22608e1363dfSKrzysztof Parzyszek /// Return true for an order or output dependence that is loop carried
22618e1363dfSKrzysztof Parzyszek /// potentially. A dependence is loop carried if the destination defines a valu
22628e1363dfSKrzysztof Parzyszek /// that may be used or defined by the source in a subsequent iteration.
22638e1363dfSKrzysztof Parzyszek bool SwingSchedulerDAG::isLoopCarriedDep(SUnit *Source, const SDep &Dep,
2264254f889dSBrendon Cahoon                                          bool isSucc) {
22658e1363dfSKrzysztof Parzyszek   if ((Dep.getKind() != SDep::Order && Dep.getKind() != SDep::Output) ||
22668e1363dfSKrzysztof Parzyszek       Dep.isArtificial())
2267254f889dSBrendon Cahoon     return false;
2268254f889dSBrendon Cahoon 
2269254f889dSBrendon Cahoon   if (!SwpPruneLoopCarried)
2270254f889dSBrendon Cahoon     return true;
2271254f889dSBrendon Cahoon 
22728e1363dfSKrzysztof Parzyszek   if (Dep.getKind() == SDep::Output)
22738e1363dfSKrzysztof Parzyszek     return true;
22748e1363dfSKrzysztof Parzyszek 
2275254f889dSBrendon Cahoon   MachineInstr *SI = Source->getInstr();
2276254f889dSBrendon Cahoon   MachineInstr *DI = Dep.getSUnit()->getInstr();
2277254f889dSBrendon Cahoon   if (!isSucc)
2278254f889dSBrendon Cahoon     std::swap(SI, DI);
2279254f889dSBrendon Cahoon   assert(SI != nullptr && DI != nullptr && "Expecting SUnit with an MI.");
2280254f889dSBrendon Cahoon 
2281254f889dSBrendon Cahoon   // Assume ordered loads and stores may have a loop carried dependence.
2282254f889dSBrendon Cahoon   if (SI->hasUnmodeledSideEffects() || DI->hasUnmodeledSideEffects() ||
22836c5d5ce5SUlrich Weigand       SI->mayRaiseFPException() || DI->mayRaiseFPException() ||
2284254f889dSBrendon Cahoon       SI->hasOrderedMemoryRef() || DI->hasOrderedMemoryRef())
2285254f889dSBrendon Cahoon     return true;
2286254f889dSBrendon Cahoon 
2287254f889dSBrendon Cahoon   // Only chain dependences between a load and store can be loop carried.
2288254f889dSBrendon Cahoon   if (!DI->mayStore() || !SI->mayLoad())
2289254f889dSBrendon Cahoon     return false;
2290254f889dSBrendon Cahoon 
2291254f889dSBrendon Cahoon   unsigned DeltaS, DeltaD;
2292254f889dSBrendon Cahoon   if (!computeDelta(*SI, DeltaS) || !computeDelta(*DI, DeltaD))
2293254f889dSBrendon Cahoon     return true;
2294254f889dSBrendon Cahoon 
2295238c9d63SBjorn Pettersson   const MachineOperand *BaseOpS, *BaseOpD;
2296254f889dSBrendon Cahoon   int64_t OffsetS, OffsetD;
22978fbc9258SSander de Smalen   bool OffsetSIsScalable, OffsetDIsScalable;
2298254f889dSBrendon Cahoon   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
22998fbc9258SSander de Smalen   if (!TII->getMemOperandWithOffset(*SI, BaseOpS, OffsetS, OffsetSIsScalable,
23008fbc9258SSander de Smalen                                     TRI) ||
23018fbc9258SSander de Smalen       !TII->getMemOperandWithOffset(*DI, BaseOpD, OffsetD, OffsetDIsScalable,
23028fbc9258SSander de Smalen                                     TRI))
2303254f889dSBrendon Cahoon     return true;
2304254f889dSBrendon Cahoon 
23058fbc9258SSander de Smalen   assert(!OffsetSIsScalable && !OffsetDIsScalable &&
23068fbc9258SSander de Smalen          "Expected offsets to be byte offsets");
23078fbc9258SSander de Smalen 
2308d7eebd6dSFrancis Visoiu Mistrih   if (!BaseOpS->isIdenticalTo(*BaseOpD))
2309254f889dSBrendon Cahoon     return true;
2310254f889dSBrendon Cahoon 
23118c07d0c4SKrzysztof Parzyszek   // Check that the base register is incremented by a constant value for each
23128c07d0c4SKrzysztof Parzyszek   // iteration.
2313d7eebd6dSFrancis Visoiu Mistrih   MachineInstr *Def = MRI.getVRegDef(BaseOpS->getReg());
23148c07d0c4SKrzysztof Parzyszek   if (!Def || !Def->isPHI())
23158c07d0c4SKrzysztof Parzyszek     return true;
23168c07d0c4SKrzysztof Parzyszek   unsigned InitVal = 0;
23178c07d0c4SKrzysztof Parzyszek   unsigned LoopVal = 0;
23188c07d0c4SKrzysztof Parzyszek   getPhiRegs(*Def, BB, InitVal, LoopVal);
23198c07d0c4SKrzysztof Parzyszek   MachineInstr *LoopDef = MRI.getVRegDef(LoopVal);
23208c07d0c4SKrzysztof Parzyszek   int D = 0;
23218c07d0c4SKrzysztof Parzyszek   if (!LoopDef || !TII->getIncrementValue(*LoopDef, D))
23228c07d0c4SKrzysztof Parzyszek     return true;
23238c07d0c4SKrzysztof Parzyszek 
2324254f889dSBrendon Cahoon   uint64_t AccessSizeS = (*SI->memoperands_begin())->getSize();
2325254f889dSBrendon Cahoon   uint64_t AccessSizeD = (*DI->memoperands_begin())->getSize();
2326254f889dSBrendon Cahoon 
2327254f889dSBrendon Cahoon   // This is the main test, which checks the offset values and the loop
2328254f889dSBrendon Cahoon   // increment value to determine if the accesses may be loop carried.
232957c3d4beSBrendon Cahoon   if (AccessSizeS == MemoryLocation::UnknownSize ||
233057c3d4beSBrendon Cahoon       AccessSizeD == MemoryLocation::UnknownSize)
2331254f889dSBrendon Cahoon     return true;
233257c3d4beSBrendon Cahoon 
233357c3d4beSBrendon Cahoon   if (DeltaS != DeltaD || DeltaS < AccessSizeS || DeltaD < AccessSizeD)
233457c3d4beSBrendon Cahoon     return true;
233557c3d4beSBrendon Cahoon 
233657c3d4beSBrendon Cahoon   return (OffsetS + (int64_t)AccessSizeS < OffsetD + (int64_t)AccessSizeD);
2337254f889dSBrendon Cahoon }
2338254f889dSBrendon Cahoon 
233988391248SKrzysztof Parzyszek void SwingSchedulerDAG::postprocessDAG() {
234088391248SKrzysztof Parzyszek   for (auto &M : Mutations)
234188391248SKrzysztof Parzyszek     M->apply(this);
234288391248SKrzysztof Parzyszek }
234388391248SKrzysztof Parzyszek 
2344254f889dSBrendon Cahoon /// Try to schedule the node at the specified StartCycle and continue
2345254f889dSBrendon Cahoon /// until the node is schedule or the EndCycle is reached.  This function
2346254f889dSBrendon Cahoon /// returns true if the node is scheduled.  This routine may search either
2347254f889dSBrendon Cahoon /// forward or backward for a place to insert the instruction based upon
2348254f889dSBrendon Cahoon /// the relative values of StartCycle and EndCycle.
2349254f889dSBrendon Cahoon bool SMSchedule::insert(SUnit *SU, int StartCycle, int EndCycle, int II) {
2350254f889dSBrendon Cahoon   bool forward = true;
235118e7bf5cSJinsong Ji   LLVM_DEBUG({
235218e7bf5cSJinsong Ji     dbgs() << "Trying to insert node between " << StartCycle << " and "
235318e7bf5cSJinsong Ji            << EndCycle << " II: " << II << "\n";
235418e7bf5cSJinsong Ji   });
2355254f889dSBrendon Cahoon   if (StartCycle > EndCycle)
2356254f889dSBrendon Cahoon     forward = false;
2357254f889dSBrendon Cahoon 
2358254f889dSBrendon Cahoon   // The terminating condition depends on the direction.
2359254f889dSBrendon Cahoon   int termCycle = forward ? EndCycle + 1 : EndCycle - 1;
2360254f889dSBrendon Cahoon   for (int curCycle = StartCycle; curCycle != termCycle;
2361254f889dSBrendon Cahoon        forward ? ++curCycle : --curCycle) {
2362254f889dSBrendon Cahoon 
2363f6cb3bcbSJinsong Ji     // Add the already scheduled instructions at the specified cycle to the
2364f6cb3bcbSJinsong Ji     // DFA.
2365f6cb3bcbSJinsong Ji     ProcItinResources.clearResources();
2366254f889dSBrendon Cahoon     for (int checkCycle = FirstCycle + ((curCycle - FirstCycle) % II);
2367254f889dSBrendon Cahoon          checkCycle <= LastCycle; checkCycle += II) {
2368254f889dSBrendon Cahoon       std::deque<SUnit *> &cycleInstrs = ScheduledInstrs[checkCycle];
2369254f889dSBrendon Cahoon 
23703279943aSKazu Hirata       for (SUnit *CI : cycleInstrs) {
23713279943aSKazu Hirata         if (ST.getInstrInfo()->isZeroCost(CI->getInstr()->getOpcode()))
2372254f889dSBrendon Cahoon           continue;
23733279943aSKazu Hirata         assert(ProcItinResources.canReserveResources(*CI->getInstr()) &&
2374254f889dSBrendon Cahoon                "These instructions have already been scheduled.");
23753279943aSKazu Hirata         ProcItinResources.reserveResources(*CI->getInstr());
2376254f889dSBrendon Cahoon       }
2377254f889dSBrendon Cahoon     }
2378254f889dSBrendon Cahoon     if (ST.getInstrInfo()->isZeroCost(SU->getInstr()->getOpcode()) ||
2379f6cb3bcbSJinsong Ji         ProcItinResources.canReserveResources(*SU->getInstr())) {
2380d34e60caSNicola Zaghen       LLVM_DEBUG({
2381254f889dSBrendon Cahoon         dbgs() << "\tinsert at cycle " << curCycle << " ";
2382254f889dSBrendon Cahoon         SU->getInstr()->dump();
2383254f889dSBrendon Cahoon       });
2384254f889dSBrendon Cahoon 
2385254f889dSBrendon Cahoon       ScheduledInstrs[curCycle].push_back(SU);
2386254f889dSBrendon Cahoon       InstrToCycle.insert(std::make_pair(SU, curCycle));
2387254f889dSBrendon Cahoon       if (curCycle > LastCycle)
2388254f889dSBrendon Cahoon         LastCycle = curCycle;
2389254f889dSBrendon Cahoon       if (curCycle < FirstCycle)
2390254f889dSBrendon Cahoon         FirstCycle = curCycle;
2391254f889dSBrendon Cahoon       return true;
2392254f889dSBrendon Cahoon     }
2393d34e60caSNicola Zaghen     LLVM_DEBUG({
2394254f889dSBrendon Cahoon       dbgs() << "\tfailed to insert at cycle " << curCycle << " ";
2395254f889dSBrendon Cahoon       SU->getInstr()->dump();
2396254f889dSBrendon Cahoon     });
2397254f889dSBrendon Cahoon   }
2398254f889dSBrendon Cahoon   return false;
2399254f889dSBrendon Cahoon }
2400254f889dSBrendon Cahoon 
2401254f889dSBrendon Cahoon // Return the cycle of the earliest scheduled instruction in the chain.
2402254f889dSBrendon Cahoon int SMSchedule::earliestCycleInChain(const SDep &Dep) {
2403254f889dSBrendon Cahoon   SmallPtrSet<SUnit *, 8> Visited;
2404254f889dSBrendon Cahoon   SmallVector<SDep, 8> Worklist;
2405254f889dSBrendon Cahoon   Worklist.push_back(Dep);
2406254f889dSBrendon Cahoon   int EarlyCycle = INT_MAX;
2407254f889dSBrendon Cahoon   while (!Worklist.empty()) {
2408254f889dSBrendon Cahoon     const SDep &Cur = Worklist.pop_back_val();
2409254f889dSBrendon Cahoon     SUnit *PrevSU = Cur.getSUnit();
2410254f889dSBrendon Cahoon     if (Visited.count(PrevSU))
2411254f889dSBrendon Cahoon       continue;
2412254f889dSBrendon Cahoon     std::map<SUnit *, int>::const_iterator it = InstrToCycle.find(PrevSU);
2413254f889dSBrendon Cahoon     if (it == InstrToCycle.end())
2414254f889dSBrendon Cahoon       continue;
2415254f889dSBrendon Cahoon     EarlyCycle = std::min(EarlyCycle, it->second);
2416254f889dSBrendon Cahoon     for (const auto &PI : PrevSU->Preds)
24174a6ebc03SLama       if (PI.getKind() == SDep::Order || PI.getKind() == SDep::Output)
2418254f889dSBrendon Cahoon         Worklist.push_back(PI);
2419254f889dSBrendon Cahoon     Visited.insert(PrevSU);
2420254f889dSBrendon Cahoon   }
2421254f889dSBrendon Cahoon   return EarlyCycle;
2422254f889dSBrendon Cahoon }
2423254f889dSBrendon Cahoon 
2424254f889dSBrendon Cahoon // Return the cycle of the latest scheduled instruction in the chain.
2425254f889dSBrendon Cahoon int SMSchedule::latestCycleInChain(const SDep &Dep) {
2426254f889dSBrendon Cahoon   SmallPtrSet<SUnit *, 8> Visited;
2427254f889dSBrendon Cahoon   SmallVector<SDep, 8> Worklist;
2428254f889dSBrendon Cahoon   Worklist.push_back(Dep);
2429254f889dSBrendon Cahoon   int LateCycle = INT_MIN;
2430254f889dSBrendon Cahoon   while (!Worklist.empty()) {
2431254f889dSBrendon Cahoon     const SDep &Cur = Worklist.pop_back_val();
2432254f889dSBrendon Cahoon     SUnit *SuccSU = Cur.getSUnit();
2433254f889dSBrendon Cahoon     if (Visited.count(SuccSU))
2434254f889dSBrendon Cahoon       continue;
2435254f889dSBrendon Cahoon     std::map<SUnit *, int>::const_iterator it = InstrToCycle.find(SuccSU);
2436254f889dSBrendon Cahoon     if (it == InstrToCycle.end())
2437254f889dSBrendon Cahoon       continue;
2438254f889dSBrendon Cahoon     LateCycle = std::max(LateCycle, it->second);
2439254f889dSBrendon Cahoon     for (const auto &SI : SuccSU->Succs)
24404a6ebc03SLama       if (SI.getKind() == SDep::Order || SI.getKind() == SDep::Output)
2441254f889dSBrendon Cahoon         Worklist.push_back(SI);
2442254f889dSBrendon Cahoon     Visited.insert(SuccSU);
2443254f889dSBrendon Cahoon   }
2444254f889dSBrendon Cahoon   return LateCycle;
2445254f889dSBrendon Cahoon }
2446254f889dSBrendon Cahoon 
2447254f889dSBrendon Cahoon /// If an instruction has a use that spans multiple iterations, then
2448254f889dSBrendon Cahoon /// return true. These instructions are characterized by having a back-ege
2449254f889dSBrendon Cahoon /// to a Phi, which contains a reference to another Phi.
2450254f889dSBrendon Cahoon static SUnit *multipleIterations(SUnit *SU, SwingSchedulerDAG *DAG) {
2451254f889dSBrendon Cahoon   for (auto &P : SU->Preds)
2452254f889dSBrendon Cahoon     if (DAG->isBackedge(SU, P) && P.getSUnit()->getInstr()->isPHI())
2453254f889dSBrendon Cahoon       for (auto &S : P.getSUnit()->Succs)
2454b9b75b8cSKrzysztof Parzyszek         if (S.getKind() == SDep::Data && S.getSUnit()->getInstr()->isPHI())
2455254f889dSBrendon Cahoon           return P.getSUnit();
2456254f889dSBrendon Cahoon   return nullptr;
2457254f889dSBrendon Cahoon }
2458254f889dSBrendon Cahoon 
2459254f889dSBrendon Cahoon /// Compute the scheduling start slot for the instruction.  The start slot
2460254f889dSBrendon Cahoon /// depends on any predecessor or successor nodes scheduled already.
2461254f889dSBrendon Cahoon void SMSchedule::computeStart(SUnit *SU, int *MaxEarlyStart, int *MinLateStart,
2462254f889dSBrendon Cahoon                               int *MinEnd, int *MaxStart, int II,
2463254f889dSBrendon Cahoon                               SwingSchedulerDAG *DAG) {
2464254f889dSBrendon Cahoon   // Iterate over each instruction that has been scheduled already.  The start
2465c73b6d6bSHiroshi Inoue   // slot computation depends on whether the previously scheduled instruction
2466254f889dSBrendon Cahoon   // is a predecessor or successor of the specified instruction.
2467254f889dSBrendon Cahoon   for (int cycle = getFirstCycle(); cycle <= LastCycle; ++cycle) {
2468254f889dSBrendon Cahoon 
2469254f889dSBrendon Cahoon     // Iterate over each instruction in the current cycle.
2470254f889dSBrendon Cahoon     for (SUnit *I : getInstructions(cycle)) {
2471254f889dSBrendon Cahoon       // Because we're processing a DAG for the dependences, we recognize
2472254f889dSBrendon Cahoon       // the back-edge in recurrences by anti dependences.
2473254f889dSBrendon Cahoon       for (unsigned i = 0, e = (unsigned)SU->Preds.size(); i != e; ++i) {
2474254f889dSBrendon Cahoon         const SDep &Dep = SU->Preds[i];
2475254f889dSBrendon Cahoon         if (Dep.getSUnit() == I) {
2476254f889dSBrendon Cahoon           if (!DAG->isBackedge(SU, Dep)) {
2477c715a5d2SKrzysztof Parzyszek             int EarlyStart = cycle + Dep.getLatency() -
2478254f889dSBrendon Cahoon                              DAG->getDistance(Dep.getSUnit(), SU, Dep) * II;
2479254f889dSBrendon Cahoon             *MaxEarlyStart = std::max(*MaxEarlyStart, EarlyStart);
24808e1363dfSKrzysztof Parzyszek             if (DAG->isLoopCarriedDep(SU, Dep, false)) {
2481254f889dSBrendon Cahoon               int End = earliestCycleInChain(Dep) + (II - 1);
2482254f889dSBrendon Cahoon               *MinEnd = std::min(*MinEnd, End);
2483254f889dSBrendon Cahoon             }
2484254f889dSBrendon Cahoon           } else {
2485c715a5d2SKrzysztof Parzyszek             int LateStart = cycle - Dep.getLatency() +
2486254f889dSBrendon Cahoon                             DAG->getDistance(SU, Dep.getSUnit(), Dep) * II;
2487254f889dSBrendon Cahoon             *MinLateStart = std::min(*MinLateStart, LateStart);
2488254f889dSBrendon Cahoon           }
2489254f889dSBrendon Cahoon         }
2490254f889dSBrendon Cahoon         // For instruction that requires multiple iterations, make sure that
2491254f889dSBrendon Cahoon         // the dependent instruction is not scheduled past the definition.
2492254f889dSBrendon Cahoon         SUnit *BE = multipleIterations(I, DAG);
2493254f889dSBrendon Cahoon         if (BE && Dep.getSUnit() == BE && !SU->getInstr()->isPHI() &&
2494254f889dSBrendon Cahoon             !SU->isPred(I))
2495254f889dSBrendon Cahoon           *MinLateStart = std::min(*MinLateStart, cycle);
2496254f889dSBrendon Cahoon       }
2497a2122044SKrzysztof Parzyszek       for (unsigned i = 0, e = (unsigned)SU->Succs.size(); i != e; ++i) {
2498254f889dSBrendon Cahoon         if (SU->Succs[i].getSUnit() == I) {
2499254f889dSBrendon Cahoon           const SDep &Dep = SU->Succs[i];
2500254f889dSBrendon Cahoon           if (!DAG->isBackedge(SU, Dep)) {
2501c715a5d2SKrzysztof Parzyszek             int LateStart = cycle - Dep.getLatency() +
2502254f889dSBrendon Cahoon                             DAG->getDistance(SU, Dep.getSUnit(), Dep) * II;
2503254f889dSBrendon Cahoon             *MinLateStart = std::min(*MinLateStart, LateStart);
25048e1363dfSKrzysztof Parzyszek             if (DAG->isLoopCarriedDep(SU, Dep)) {
2505254f889dSBrendon Cahoon               int Start = latestCycleInChain(Dep) + 1 - II;
2506254f889dSBrendon Cahoon               *MaxStart = std::max(*MaxStart, Start);
2507254f889dSBrendon Cahoon             }
2508254f889dSBrendon Cahoon           } else {
2509c715a5d2SKrzysztof Parzyszek             int EarlyStart = cycle + Dep.getLatency() -
2510254f889dSBrendon Cahoon                              DAG->getDistance(Dep.getSUnit(), SU, Dep) * II;
2511254f889dSBrendon Cahoon             *MaxEarlyStart = std::max(*MaxEarlyStart, EarlyStart);
2512254f889dSBrendon Cahoon           }
2513254f889dSBrendon Cahoon         }
2514254f889dSBrendon Cahoon       }
2515254f889dSBrendon Cahoon     }
2516254f889dSBrendon Cahoon   }
2517a2122044SKrzysztof Parzyszek }
2518254f889dSBrendon Cahoon 
2519254f889dSBrendon Cahoon /// Order the instructions within a cycle so that the definitions occur
2520254f889dSBrendon Cahoon /// before the uses. Returns true if the instruction is added to the start
2521254f889dSBrendon Cahoon /// of the list, or false if added to the end.
2522f13bbf1dSKrzysztof Parzyszek void SMSchedule::orderDependence(SwingSchedulerDAG *SSD, SUnit *SU,
2523254f889dSBrendon Cahoon                                  std::deque<SUnit *> &Insts) {
2524254f889dSBrendon Cahoon   MachineInstr *MI = SU->getInstr();
2525254f889dSBrendon Cahoon   bool OrderBeforeUse = false;
2526254f889dSBrendon Cahoon   bool OrderAfterDef = false;
2527254f889dSBrendon Cahoon   bool OrderBeforeDef = false;
2528254f889dSBrendon Cahoon   unsigned MoveDef = 0;
2529254f889dSBrendon Cahoon   unsigned MoveUse = 0;
2530254f889dSBrendon Cahoon   int StageInst1 = stageScheduled(SU);
2531254f889dSBrendon Cahoon 
2532254f889dSBrendon Cahoon   unsigned Pos = 0;
2533254f889dSBrendon Cahoon   for (std::deque<SUnit *>::iterator I = Insts.begin(), E = Insts.end(); I != E;
2534254f889dSBrendon Cahoon        ++I, ++Pos) {
2535c73fc74cSKazu Hirata     for (MachineOperand &MO : MI->operands()) {
25362bea69bfSDaniel Sanders       if (!MO.isReg() || !Register::isVirtualRegister(MO.getReg()))
2537254f889dSBrendon Cahoon         continue;
2538f13bbf1dSKrzysztof Parzyszek 
25390c476111SDaniel Sanders       Register Reg = MO.getReg();
2540254f889dSBrendon Cahoon       unsigned BasePos, OffsetPos;
25418fb181caSKrzysztof Parzyszek       if (ST.getInstrInfo()->getBaseAndOffsetPosition(*MI, BasePos, OffsetPos))
2542254f889dSBrendon Cahoon         if (MI->getOperand(BasePos).getReg() == Reg)
2543254f889dSBrendon Cahoon           if (unsigned NewReg = SSD->getInstrBaseReg(SU))
2544254f889dSBrendon Cahoon             Reg = NewReg;
2545254f889dSBrendon Cahoon       bool Reads, Writes;
2546254f889dSBrendon Cahoon       std::tie(Reads, Writes) =
2547254f889dSBrendon Cahoon           (*I)->getInstr()->readsWritesVirtualRegister(Reg);
2548254f889dSBrendon Cahoon       if (MO.isDef() && Reads && stageScheduled(*I) <= StageInst1) {
2549254f889dSBrendon Cahoon         OrderBeforeUse = true;
2550f13bbf1dSKrzysztof Parzyszek         if (MoveUse == 0)
2551254f889dSBrendon Cahoon           MoveUse = Pos;
2552254f889dSBrendon Cahoon       } else if (MO.isDef() && Reads && stageScheduled(*I) > StageInst1) {
2553254f889dSBrendon Cahoon         // Add the instruction after the scheduled instruction.
2554254f889dSBrendon Cahoon         OrderAfterDef = true;
2555254f889dSBrendon Cahoon         MoveDef = Pos;
2556254f889dSBrendon Cahoon       } else if (MO.isUse() && Writes && stageScheduled(*I) == StageInst1) {
2557254f889dSBrendon Cahoon         if (cycleScheduled(*I) == cycleScheduled(SU) && !(*I)->isSucc(SU)) {
2558254f889dSBrendon Cahoon           OrderBeforeUse = true;
2559f13bbf1dSKrzysztof Parzyszek           if (MoveUse == 0)
2560254f889dSBrendon Cahoon             MoveUse = Pos;
2561254f889dSBrendon Cahoon         } else {
2562254f889dSBrendon Cahoon           OrderAfterDef = true;
2563254f889dSBrendon Cahoon           MoveDef = Pos;
2564254f889dSBrendon Cahoon         }
2565254f889dSBrendon Cahoon       } else if (MO.isUse() && Writes && stageScheduled(*I) > StageInst1) {
2566254f889dSBrendon Cahoon         OrderBeforeUse = true;
2567f13bbf1dSKrzysztof Parzyszek         if (MoveUse == 0)
2568254f889dSBrendon Cahoon           MoveUse = Pos;
2569254f889dSBrendon Cahoon         if (MoveUse != 0) {
2570254f889dSBrendon Cahoon           OrderAfterDef = true;
2571254f889dSBrendon Cahoon           MoveDef = Pos - 1;
2572254f889dSBrendon Cahoon         }
2573254f889dSBrendon Cahoon       } else if (MO.isUse() && Writes && stageScheduled(*I) < StageInst1) {
2574254f889dSBrendon Cahoon         // Add the instruction before the scheduled instruction.
2575254f889dSBrendon Cahoon         OrderBeforeUse = true;
2576f13bbf1dSKrzysztof Parzyszek         if (MoveUse == 0)
2577254f889dSBrendon Cahoon           MoveUse = Pos;
2578254f889dSBrendon Cahoon       } else if (MO.isUse() && stageScheduled(*I) == StageInst1 &&
2579254f889dSBrendon Cahoon                  isLoopCarriedDefOfUse(SSD, (*I)->getInstr(), MO)) {
2580f13bbf1dSKrzysztof Parzyszek         if (MoveUse == 0) {
2581254f889dSBrendon Cahoon           OrderBeforeDef = true;
2582254f889dSBrendon Cahoon           MoveUse = Pos;
2583254f889dSBrendon Cahoon         }
2584254f889dSBrendon Cahoon       }
2585f13bbf1dSKrzysztof Parzyszek     }
2586254f889dSBrendon Cahoon     // Check for order dependences between instructions. Make sure the source
2587254f889dSBrendon Cahoon     // is ordered before the destination.
25888e1363dfSKrzysztof Parzyszek     for (auto &S : SU->Succs) {
25898e1363dfSKrzysztof Parzyszek       if (S.getSUnit() != *I)
25908e1363dfSKrzysztof Parzyszek         continue;
25918e1363dfSKrzysztof Parzyszek       if (S.getKind() == SDep::Order && stageScheduled(*I) == StageInst1) {
2592254f889dSBrendon Cahoon         OrderBeforeUse = true;
25938e1363dfSKrzysztof Parzyszek         if (Pos < MoveUse)
2594254f889dSBrendon Cahoon           MoveUse = Pos;
2595254f889dSBrendon Cahoon       }
259695770866SJinsong Ji       // We did not handle HW dependences in previous for loop,
259795770866SJinsong Ji       // and we normally set Latency = 0 for Anti deps,
259895770866SJinsong Ji       // so may have nodes in same cycle with Anti denpendent on HW regs.
259995770866SJinsong Ji       else if (S.getKind() == SDep::Anti && stageScheduled(*I) == StageInst1) {
260095770866SJinsong Ji         OrderBeforeUse = true;
260195770866SJinsong Ji         if ((MoveUse == 0) || (Pos < MoveUse))
260295770866SJinsong Ji           MoveUse = Pos;
260395770866SJinsong Ji       }
2604254f889dSBrendon Cahoon     }
26058e1363dfSKrzysztof Parzyszek     for (auto &P : SU->Preds) {
26068e1363dfSKrzysztof Parzyszek       if (P.getSUnit() != *I)
26078e1363dfSKrzysztof Parzyszek         continue;
26088e1363dfSKrzysztof Parzyszek       if (P.getKind() == SDep::Order && stageScheduled(*I) == StageInst1) {
2609254f889dSBrendon Cahoon         OrderAfterDef = true;
2610254f889dSBrendon Cahoon         MoveDef = Pos;
2611254f889dSBrendon Cahoon       }
2612254f889dSBrendon Cahoon     }
2613254f889dSBrendon Cahoon   }
2614254f889dSBrendon Cahoon 
2615254f889dSBrendon Cahoon   // A circular dependence.
2616254f889dSBrendon Cahoon   if (OrderAfterDef && OrderBeforeUse && MoveUse == MoveDef)
2617254f889dSBrendon Cahoon     OrderBeforeUse = false;
2618254f889dSBrendon Cahoon 
2619254f889dSBrendon Cahoon   // OrderAfterDef takes precedences over OrderBeforeDef. The latter is due
2620254f889dSBrendon Cahoon   // to a loop-carried dependence.
2621254f889dSBrendon Cahoon   if (OrderBeforeDef)
2622254f889dSBrendon Cahoon     OrderBeforeUse = !OrderAfterDef || (MoveUse > MoveDef);
2623254f889dSBrendon Cahoon 
2624254f889dSBrendon Cahoon   // The uncommon case when the instruction order needs to be updated because
2625254f889dSBrendon Cahoon   // there is both a use and def.
2626254f889dSBrendon Cahoon   if (OrderBeforeUse && OrderAfterDef) {
2627254f889dSBrendon Cahoon     SUnit *UseSU = Insts.at(MoveUse);
2628254f889dSBrendon Cahoon     SUnit *DefSU = Insts.at(MoveDef);
2629254f889dSBrendon Cahoon     if (MoveUse > MoveDef) {
2630254f889dSBrendon Cahoon       Insts.erase(Insts.begin() + MoveUse);
2631254f889dSBrendon Cahoon       Insts.erase(Insts.begin() + MoveDef);
2632254f889dSBrendon Cahoon     } else {
2633254f889dSBrendon Cahoon       Insts.erase(Insts.begin() + MoveDef);
2634254f889dSBrendon Cahoon       Insts.erase(Insts.begin() + MoveUse);
2635254f889dSBrendon Cahoon     }
2636f13bbf1dSKrzysztof Parzyszek     orderDependence(SSD, UseSU, Insts);
2637f13bbf1dSKrzysztof Parzyszek     orderDependence(SSD, SU, Insts);
2638254f889dSBrendon Cahoon     orderDependence(SSD, DefSU, Insts);
2639f13bbf1dSKrzysztof Parzyszek     return;
2640254f889dSBrendon Cahoon   }
2641254f889dSBrendon Cahoon   // Put the new instruction first if there is a use in the list. Otherwise,
2642254f889dSBrendon Cahoon   // put it at the end of the list.
2643254f889dSBrendon Cahoon   if (OrderBeforeUse)
2644254f889dSBrendon Cahoon     Insts.push_front(SU);
2645254f889dSBrendon Cahoon   else
2646254f889dSBrendon Cahoon     Insts.push_back(SU);
2647254f889dSBrendon Cahoon }
2648254f889dSBrendon Cahoon 
2649254f889dSBrendon Cahoon /// Return true if the scheduled Phi has a loop carried operand.
2650254f889dSBrendon Cahoon bool SMSchedule::isLoopCarried(SwingSchedulerDAG *SSD, MachineInstr &Phi) {
2651254f889dSBrendon Cahoon   if (!Phi.isPHI())
2652254f889dSBrendon Cahoon     return false;
2653c73b6d6bSHiroshi Inoue   assert(Phi.isPHI() && "Expecting a Phi.");
2654254f889dSBrendon Cahoon   SUnit *DefSU = SSD->getSUnit(&Phi);
2655254f889dSBrendon Cahoon   unsigned DefCycle = cycleScheduled(DefSU);
2656254f889dSBrendon Cahoon   int DefStage = stageScheduled(DefSU);
2657254f889dSBrendon Cahoon 
2658254f889dSBrendon Cahoon   unsigned InitVal = 0;
2659254f889dSBrendon Cahoon   unsigned LoopVal = 0;
2660254f889dSBrendon Cahoon   getPhiRegs(Phi, Phi.getParent(), InitVal, LoopVal);
2661254f889dSBrendon Cahoon   SUnit *UseSU = SSD->getSUnit(MRI.getVRegDef(LoopVal));
2662254f889dSBrendon Cahoon   if (!UseSU)
2663254f889dSBrendon Cahoon     return true;
2664254f889dSBrendon Cahoon   if (UseSU->getInstr()->isPHI())
2665254f889dSBrendon Cahoon     return true;
2666254f889dSBrendon Cahoon   unsigned LoopCycle = cycleScheduled(UseSU);
2667254f889dSBrendon Cahoon   int LoopStage = stageScheduled(UseSU);
26683d8482a8SSimon Pilgrim   return (LoopCycle > DefCycle) || (LoopStage <= DefStage);
2669254f889dSBrendon Cahoon }
2670254f889dSBrendon Cahoon 
2671254f889dSBrendon Cahoon /// Return true if the instruction is a definition that is loop carried
2672254f889dSBrendon Cahoon /// and defines the use on the next iteration.
2673254f889dSBrendon Cahoon ///        v1 = phi(v2, v3)
2674254f889dSBrendon Cahoon ///  (Def) v3 = op v1
2675254f889dSBrendon Cahoon ///  (MO)   = v1
2676254f889dSBrendon Cahoon /// If MO appears before Def, then then v1 and v3 may get assigned to the same
2677254f889dSBrendon Cahoon /// register.
2678254f889dSBrendon Cahoon bool SMSchedule::isLoopCarriedDefOfUse(SwingSchedulerDAG *SSD,
2679254f889dSBrendon Cahoon                                        MachineInstr *Def, MachineOperand &MO) {
2680254f889dSBrendon Cahoon   if (!MO.isReg())
2681254f889dSBrendon Cahoon     return false;
2682254f889dSBrendon Cahoon   if (Def->isPHI())
2683254f889dSBrendon Cahoon     return false;
2684254f889dSBrendon Cahoon   MachineInstr *Phi = MRI.getVRegDef(MO.getReg());
2685254f889dSBrendon Cahoon   if (!Phi || !Phi->isPHI() || Phi->getParent() != Def->getParent())
2686254f889dSBrendon Cahoon     return false;
2687254f889dSBrendon Cahoon   if (!isLoopCarried(SSD, *Phi))
2688254f889dSBrendon Cahoon     return false;
2689254f889dSBrendon Cahoon   unsigned LoopReg = getLoopPhiReg(*Phi, Phi->getParent());
2690254f889dSBrendon Cahoon   for (unsigned i = 0, e = Def->getNumOperands(); i != e; ++i) {
2691254f889dSBrendon Cahoon     MachineOperand &DMO = Def->getOperand(i);
2692254f889dSBrendon Cahoon     if (!DMO.isReg() || !DMO.isDef())
2693254f889dSBrendon Cahoon       continue;
2694254f889dSBrendon Cahoon     if (DMO.getReg() == LoopReg)
2695254f889dSBrendon Cahoon       return true;
2696254f889dSBrendon Cahoon   }
2697254f889dSBrendon Cahoon   return false;
2698254f889dSBrendon Cahoon }
2699254f889dSBrendon Cahoon 
2700254f889dSBrendon Cahoon // Check if the generated schedule is valid. This function checks if
2701254f889dSBrendon Cahoon // an instruction that uses a physical register is scheduled in a
2702254f889dSBrendon Cahoon // different stage than the definition. The pipeliner does not handle
2703254f889dSBrendon Cahoon // physical register values that may cross a basic block boundary.
2704254f889dSBrendon Cahoon bool SMSchedule::isValidSchedule(SwingSchedulerDAG *SSD) {
27053279943aSKazu Hirata   for (SUnit &SU : SSD->SUnits) {
2706254f889dSBrendon Cahoon     if (!SU.hasPhysRegDefs)
2707254f889dSBrendon Cahoon       continue;
2708254f889dSBrendon Cahoon     int StageDef = stageScheduled(&SU);
2709254f889dSBrendon Cahoon     assert(StageDef != -1 && "Instruction should have been scheduled.");
2710254f889dSBrendon Cahoon     for (auto &SI : SU.Succs)
2711254f889dSBrendon Cahoon       if (SI.isAssignedRegDep())
27122bea69bfSDaniel Sanders         if (Register::isPhysicalRegister(SI.getReg()))
2713254f889dSBrendon Cahoon           if (stageScheduled(SI.getSUnit()) != StageDef)
2714254f889dSBrendon Cahoon             return false;
2715254f889dSBrendon Cahoon   }
2716254f889dSBrendon Cahoon   return true;
2717254f889dSBrendon Cahoon }
2718254f889dSBrendon Cahoon 
27194b8bcf00SRoorda, Jan-Willem /// A property of the node order in swing-modulo-scheduling is
27204b8bcf00SRoorda, Jan-Willem /// that for nodes outside circuits the following holds:
27214b8bcf00SRoorda, Jan-Willem /// none of them is scheduled after both a successor and a
27224b8bcf00SRoorda, Jan-Willem /// predecessor.
27234b8bcf00SRoorda, Jan-Willem /// The method below checks whether the property is met.
27244b8bcf00SRoorda, Jan-Willem /// If not, debug information is printed and statistics information updated.
27254b8bcf00SRoorda, Jan-Willem /// Note that we do not use an assert statement.
27264b8bcf00SRoorda, Jan-Willem /// The reason is that although an invalid node oder may prevent
27274b8bcf00SRoorda, Jan-Willem /// the pipeliner from finding a pipelined schedule for arbitrary II,
27284b8bcf00SRoorda, Jan-Willem /// it does not lead to the generation of incorrect code.
27294b8bcf00SRoorda, Jan-Willem void SwingSchedulerDAG::checkValidNodeOrder(const NodeSetType &Circuits) const {
27304b8bcf00SRoorda, Jan-Willem 
27314b8bcf00SRoorda, Jan-Willem   // a sorted vector that maps each SUnit to its index in the NodeOrder
27324b8bcf00SRoorda, Jan-Willem   typedef std::pair<SUnit *, unsigned> UnitIndex;
27334b8bcf00SRoorda, Jan-Willem   std::vector<UnitIndex> Indices(NodeOrder.size(), std::make_pair(nullptr, 0));
27344b8bcf00SRoorda, Jan-Willem 
27354b8bcf00SRoorda, Jan-Willem   for (unsigned i = 0, s = NodeOrder.size(); i < s; ++i)
27364b8bcf00SRoorda, Jan-Willem     Indices.push_back(std::make_pair(NodeOrder[i], i));
27374b8bcf00SRoorda, Jan-Willem 
27384b8bcf00SRoorda, Jan-Willem   auto CompareKey = [](UnitIndex i1, UnitIndex i2) {
27394b8bcf00SRoorda, Jan-Willem     return std::get<0>(i1) < std::get<0>(i2);
27404b8bcf00SRoorda, Jan-Willem   };
27414b8bcf00SRoorda, Jan-Willem 
27424b8bcf00SRoorda, Jan-Willem   // sort, so that we can perform a binary search
27430cac726aSFangrui Song   llvm::sort(Indices, CompareKey);
27444b8bcf00SRoorda, Jan-Willem 
27454b8bcf00SRoorda, Jan-Willem   bool Valid = true;
2746febf70a9SDavid L Kreitzer   (void)Valid;
27474b8bcf00SRoorda, Jan-Willem   // for each SUnit in the NodeOrder, check whether
27484b8bcf00SRoorda, Jan-Willem   // it appears after both a successor and a predecessor
27494b8bcf00SRoorda, Jan-Willem   // of the SUnit. If this is the case, and the SUnit
27504b8bcf00SRoorda, Jan-Willem   // is not part of circuit, then the NodeOrder is not
27514b8bcf00SRoorda, Jan-Willem   // valid.
27524b8bcf00SRoorda, Jan-Willem   for (unsigned i = 0, s = NodeOrder.size(); i < s; ++i) {
27534b8bcf00SRoorda, Jan-Willem     SUnit *SU = NodeOrder[i];
27544b8bcf00SRoorda, Jan-Willem     unsigned Index = i;
27554b8bcf00SRoorda, Jan-Willem 
27564b8bcf00SRoorda, Jan-Willem     bool PredBefore = false;
27574b8bcf00SRoorda, Jan-Willem     bool SuccBefore = false;
27584b8bcf00SRoorda, Jan-Willem 
27594b8bcf00SRoorda, Jan-Willem     SUnit *Succ;
27604b8bcf00SRoorda, Jan-Willem     SUnit *Pred;
2761febf70a9SDavid L Kreitzer     (void)Succ;
2762febf70a9SDavid L Kreitzer     (void)Pred;
27634b8bcf00SRoorda, Jan-Willem 
27644b8bcf00SRoorda, Jan-Willem     for (SDep &PredEdge : SU->Preds) {
27654b8bcf00SRoorda, Jan-Willem       SUnit *PredSU = PredEdge.getSUnit();
2766dc8de603SFangrui Song       unsigned PredIndex = std::get<1>(
2767dc8de603SFangrui Song           *llvm::lower_bound(Indices, std::make_pair(PredSU, 0), CompareKey));
27684b8bcf00SRoorda, Jan-Willem       if (!PredSU->getInstr()->isPHI() && PredIndex < Index) {
27694b8bcf00SRoorda, Jan-Willem         PredBefore = true;
27704b8bcf00SRoorda, Jan-Willem         Pred = PredSU;
27714b8bcf00SRoorda, Jan-Willem         break;
27724b8bcf00SRoorda, Jan-Willem       }
27734b8bcf00SRoorda, Jan-Willem     }
27744b8bcf00SRoorda, Jan-Willem 
27754b8bcf00SRoorda, Jan-Willem     for (SDep &SuccEdge : SU->Succs) {
27764b8bcf00SRoorda, Jan-Willem       SUnit *SuccSU = SuccEdge.getSUnit();
27771c884458SJinsong Ji       // Do not process a boundary node, it was not included in NodeOrder,
27781c884458SJinsong Ji       // hence not in Indices either, call to std::lower_bound() below will
27791c884458SJinsong Ji       // return Indices.end().
27801c884458SJinsong Ji       if (SuccSU->isBoundaryNode())
27811c884458SJinsong Ji         continue;
2782dc8de603SFangrui Song       unsigned SuccIndex = std::get<1>(
2783dc8de603SFangrui Song           *llvm::lower_bound(Indices, std::make_pair(SuccSU, 0), CompareKey));
27844b8bcf00SRoorda, Jan-Willem       if (!SuccSU->getInstr()->isPHI() && SuccIndex < Index) {
27854b8bcf00SRoorda, Jan-Willem         SuccBefore = true;
27864b8bcf00SRoorda, Jan-Willem         Succ = SuccSU;
27874b8bcf00SRoorda, Jan-Willem         break;
27884b8bcf00SRoorda, Jan-Willem       }
27894b8bcf00SRoorda, Jan-Willem     }
27904b8bcf00SRoorda, Jan-Willem 
27914b8bcf00SRoorda, Jan-Willem     if (PredBefore && SuccBefore && !SU->getInstr()->isPHI()) {
27924b8bcf00SRoorda, Jan-Willem       // instructions in circuits are allowed to be scheduled
27934b8bcf00SRoorda, Jan-Willem       // after both a successor and predecessor.
2794dc8de603SFangrui Song       bool InCircuit = llvm::any_of(
2795dc8de603SFangrui Song           Circuits, [SU](const NodeSet &Circuit) { return Circuit.count(SU); });
27964b8bcf00SRoorda, Jan-Willem       if (InCircuit)
2797d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "In a circuit, predecessor ";);
27984b8bcf00SRoorda, Jan-Willem       else {
27994b8bcf00SRoorda, Jan-Willem         Valid = false;
28004b8bcf00SRoorda, Jan-Willem         NumNodeOrderIssues++;
2801d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "Predecessor ";);
28024b8bcf00SRoorda, Jan-Willem       }
2803d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << Pred->NodeNum << " and successor " << Succ->NodeNum
2804d34e60caSNicola Zaghen                         << " are scheduled before node " << SU->NodeNum
2805d34e60caSNicola Zaghen                         << "\n";);
28064b8bcf00SRoorda, Jan-Willem     }
28074b8bcf00SRoorda, Jan-Willem   }
28084b8bcf00SRoorda, Jan-Willem 
2809d34e60caSNicola Zaghen   LLVM_DEBUG({
28104b8bcf00SRoorda, Jan-Willem     if (!Valid)
28114b8bcf00SRoorda, Jan-Willem       dbgs() << "Invalid node order found!\n";
28124b8bcf00SRoorda, Jan-Willem   });
28134b8bcf00SRoorda, Jan-Willem }
28144b8bcf00SRoorda, Jan-Willem 
28158f174ddeSKrzysztof Parzyszek /// Attempt to fix the degenerate cases when the instruction serialization
28168f174ddeSKrzysztof Parzyszek /// causes the register lifetimes to overlap. For example,
28178f174ddeSKrzysztof Parzyszek ///   p' = store_pi(p, b)
28188f174ddeSKrzysztof Parzyszek ///      = load p, offset
28198f174ddeSKrzysztof Parzyszek /// In this case p and p' overlap, which means that two registers are needed.
28208f174ddeSKrzysztof Parzyszek /// Instead, this function changes the load to use p' and updates the offset.
28218f174ddeSKrzysztof Parzyszek void SwingSchedulerDAG::fixupRegisterOverlaps(std::deque<SUnit *> &Instrs) {
28228f174ddeSKrzysztof Parzyszek   unsigned OverlapReg = 0;
28238f174ddeSKrzysztof Parzyszek   unsigned NewBaseReg = 0;
28248f174ddeSKrzysztof Parzyszek   for (SUnit *SU : Instrs) {
28258f174ddeSKrzysztof Parzyszek     MachineInstr *MI = SU->getInstr();
28268f174ddeSKrzysztof Parzyszek     for (unsigned i = 0, e = MI->getNumOperands(); i < e; ++i) {
28278f174ddeSKrzysztof Parzyszek       const MachineOperand &MO = MI->getOperand(i);
28288f174ddeSKrzysztof Parzyszek       // Look for an instruction that uses p. The instruction occurs in the
28298f174ddeSKrzysztof Parzyszek       // same cycle but occurs later in the serialized order.
28308f174ddeSKrzysztof Parzyszek       if (MO.isReg() && MO.isUse() && MO.getReg() == OverlapReg) {
28318f174ddeSKrzysztof Parzyszek         // Check that the instruction appears in the InstrChanges structure,
28328f174ddeSKrzysztof Parzyszek         // which contains instructions that can have the offset updated.
28338f174ddeSKrzysztof Parzyszek         DenseMap<SUnit *, std::pair<unsigned, int64_t>>::iterator It =
28348f174ddeSKrzysztof Parzyszek           InstrChanges.find(SU);
28358f174ddeSKrzysztof Parzyszek         if (It != InstrChanges.end()) {
28368f174ddeSKrzysztof Parzyszek           unsigned BasePos, OffsetPos;
28378f174ddeSKrzysztof Parzyszek           // Update the base register and adjust the offset.
28388f174ddeSKrzysztof Parzyszek           if (TII->getBaseAndOffsetPosition(*MI, BasePos, OffsetPos)) {
283912bdcab5SKrzysztof Parzyszek             MachineInstr *NewMI = MF.CloneMachineInstr(MI);
284012bdcab5SKrzysztof Parzyszek             NewMI->getOperand(BasePos).setReg(NewBaseReg);
284112bdcab5SKrzysztof Parzyszek             int64_t NewOffset =
284212bdcab5SKrzysztof Parzyszek                 MI->getOperand(OffsetPos).getImm() - It->second.second;
284312bdcab5SKrzysztof Parzyszek             NewMI->getOperand(OffsetPos).setImm(NewOffset);
284412bdcab5SKrzysztof Parzyszek             SU->setInstr(NewMI);
284512bdcab5SKrzysztof Parzyszek             MISUnitMap[NewMI] = SU;
2846790a779fSJames Molloy             NewMIs[MI] = NewMI;
28478f174ddeSKrzysztof Parzyszek           }
28488f174ddeSKrzysztof Parzyszek         }
28498f174ddeSKrzysztof Parzyszek         OverlapReg = 0;
28508f174ddeSKrzysztof Parzyszek         NewBaseReg = 0;
28518f174ddeSKrzysztof Parzyszek         break;
28528f174ddeSKrzysztof Parzyszek       }
28538f174ddeSKrzysztof Parzyszek       // Look for an instruction of the form p' = op(p), which uses and defines
28548f174ddeSKrzysztof Parzyszek       // two virtual registers that get allocated to the same physical register.
28558f174ddeSKrzysztof Parzyszek       unsigned TiedUseIdx = 0;
28568f174ddeSKrzysztof Parzyszek       if (MI->isRegTiedToUseOperand(i, &TiedUseIdx)) {
28578f174ddeSKrzysztof Parzyszek         // OverlapReg is p in the example above.
28588f174ddeSKrzysztof Parzyszek         OverlapReg = MI->getOperand(TiedUseIdx).getReg();
28598f174ddeSKrzysztof Parzyszek         // NewBaseReg is p' in the example above.
28608f174ddeSKrzysztof Parzyszek         NewBaseReg = MI->getOperand(i).getReg();
28618f174ddeSKrzysztof Parzyszek         break;
28628f174ddeSKrzysztof Parzyszek       }
28638f174ddeSKrzysztof Parzyszek     }
28648f174ddeSKrzysztof Parzyszek   }
28658f174ddeSKrzysztof Parzyszek }
28668f174ddeSKrzysztof Parzyszek 
2867254f889dSBrendon Cahoon /// After the schedule has been formed, call this function to combine
2868254f889dSBrendon Cahoon /// the instructions from the different stages/cycles.  That is, this
2869254f889dSBrendon Cahoon /// function creates a schedule that represents a single iteration.
2870254f889dSBrendon Cahoon void SMSchedule::finalizeSchedule(SwingSchedulerDAG *SSD) {
2871254f889dSBrendon Cahoon   // Move all instructions to the first stage from later stages.
2872254f889dSBrendon Cahoon   for (int cycle = getFirstCycle(); cycle <= getFinalCycle(); ++cycle) {
2873254f889dSBrendon Cahoon     for (int stage = 1, lastStage = getMaxStageCount(); stage <= lastStage;
2874254f889dSBrendon Cahoon          ++stage) {
2875254f889dSBrendon Cahoon       std::deque<SUnit *> &cycleInstrs =
2876254f889dSBrendon Cahoon           ScheduledInstrs[cycle + (stage * InitiationInterval)];
2877bb6447a7SKazu Hirata       for (SUnit *SU : llvm::reverse(cycleInstrs))
2878bb6447a7SKazu Hirata         ScheduledInstrs[cycle].push_front(SU);
2879254f889dSBrendon Cahoon     }
2880254f889dSBrendon Cahoon   }
2881254f889dSBrendon Cahoon 
2882254f889dSBrendon Cahoon   // Erase all the elements in the later stages. Only one iteration should
2883254f889dSBrendon Cahoon   // remain in the scheduled list, and it contains all the instructions.
2884254f889dSBrendon Cahoon   for (int cycle = getFinalCycle() + 1; cycle <= LastCycle; ++cycle)
2885254f889dSBrendon Cahoon     ScheduledInstrs.erase(cycle);
2886254f889dSBrendon Cahoon 
2887254f889dSBrendon Cahoon   // Change the registers in instruction as specified in the InstrChanges
2888254f889dSBrendon Cahoon   // map. We need to use the new registers to create the correct order.
2889ca2f5389SKazu Hirata   for (const SUnit &SU : SSD->SUnits)
2890ca2f5389SKazu Hirata     SSD->applyInstrChange(SU.getInstr(), *this);
2891254f889dSBrendon Cahoon 
2892254f889dSBrendon Cahoon   // Reorder the instructions in each cycle to fix and improve the
2893254f889dSBrendon Cahoon   // generated code.
2894254f889dSBrendon Cahoon   for (int Cycle = getFirstCycle(), E = getFinalCycle(); Cycle <= E; ++Cycle) {
2895254f889dSBrendon Cahoon     std::deque<SUnit *> &cycleInstrs = ScheduledInstrs[Cycle];
2896f13bbf1dSKrzysztof Parzyszek     std::deque<SUnit *> newOrderPhi;
28973279943aSKazu Hirata     for (SUnit *SU : cycleInstrs) {
2898f13bbf1dSKrzysztof Parzyszek       if (SU->getInstr()->isPHI())
2899f13bbf1dSKrzysztof Parzyszek         newOrderPhi.push_back(SU);
2900254f889dSBrendon Cahoon     }
2901254f889dSBrendon Cahoon     std::deque<SUnit *> newOrderI;
29023279943aSKazu Hirata     for (SUnit *SU : cycleInstrs) {
2903f13bbf1dSKrzysztof Parzyszek       if (!SU->getInstr()->isPHI())
2904254f889dSBrendon Cahoon         orderDependence(SSD, SU, newOrderI);
2905254f889dSBrendon Cahoon     }
2906254f889dSBrendon Cahoon     // Replace the old order with the new order.
2907f13bbf1dSKrzysztof Parzyszek     cycleInstrs.swap(newOrderPhi);
29081e3ed091SKazu Hirata     llvm::append_range(cycleInstrs, newOrderI);
29098f174ddeSKrzysztof Parzyszek     SSD->fixupRegisterOverlaps(cycleInstrs);
2910254f889dSBrendon Cahoon   }
2911254f889dSBrendon Cahoon 
2912d34e60caSNicola Zaghen   LLVM_DEBUG(dump(););
2913254f889dSBrendon Cahoon }
2914254f889dSBrendon Cahoon 
2915fa2e3583SAdrian Prantl void NodeSet::print(raw_ostream &os) const {
2916fa2e3583SAdrian Prantl   os << "Num nodes " << size() << " rec " << RecMII << " mov " << MaxMOV
2917fa2e3583SAdrian Prantl      << " depth " << MaxDepth << " col " << Colocate << "\n";
2918fa2e3583SAdrian Prantl   for (const auto &I : Nodes)
2919fa2e3583SAdrian Prantl     os << "   SU(" << I->NodeNum << ") " << *(I->getInstr());
2920fa2e3583SAdrian Prantl   os << "\n";
2921fa2e3583SAdrian Prantl }
2922fa2e3583SAdrian Prantl 
2923615eb470SAaron Ballman #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
2924254f889dSBrendon Cahoon /// Print the schedule information to the given output.
2925254f889dSBrendon Cahoon void SMSchedule::print(raw_ostream &os) const {
2926254f889dSBrendon Cahoon   // Iterate over each cycle.
2927254f889dSBrendon Cahoon   for (int cycle = getFirstCycle(); cycle <= getFinalCycle(); ++cycle) {
2928254f889dSBrendon Cahoon     // Iterate over each instruction in the cycle.
2929254f889dSBrendon Cahoon     const_sched_iterator cycleInstrs = ScheduledInstrs.find(cycle);
2930254f889dSBrendon Cahoon     for (SUnit *CI : cycleInstrs->second) {
2931254f889dSBrendon Cahoon       os << "cycle " << cycle << " (" << stageScheduled(CI) << ") ";
2932254f889dSBrendon Cahoon       os << "(" << CI->NodeNum << ") ";
2933254f889dSBrendon Cahoon       CI->getInstr()->print(os);
2934254f889dSBrendon Cahoon       os << "\n";
2935254f889dSBrendon Cahoon     }
2936254f889dSBrendon Cahoon   }
2937254f889dSBrendon Cahoon }
2938254f889dSBrendon Cahoon 
2939254f889dSBrendon Cahoon /// Utility function used for debugging to print the schedule.
29408c209aa8SMatthias Braun LLVM_DUMP_METHOD void SMSchedule::dump() const { print(dbgs()); }
2941fa2e3583SAdrian Prantl LLVM_DUMP_METHOD void NodeSet::dump() const { print(dbgs()); }
2942fa2e3583SAdrian Prantl 
29438c209aa8SMatthias Braun #endif
2944fa2e3583SAdrian Prantl 
2945f6cb3bcbSJinsong Ji void ResourceManager::initProcResourceVectors(
2946f6cb3bcbSJinsong Ji     const MCSchedModel &SM, SmallVectorImpl<uint64_t> &Masks) {
2947f6cb3bcbSJinsong Ji   unsigned ProcResourceID = 0;
2948fa2e3583SAdrian Prantl 
2949f6cb3bcbSJinsong Ji   // We currently limit the resource kinds to 64 and below so that we can use
2950f6cb3bcbSJinsong Ji   // uint64_t for Masks
2951f6cb3bcbSJinsong Ji   assert(SM.getNumProcResourceKinds() < 64 &&
2952f6cb3bcbSJinsong Ji          "Too many kinds of resources, unsupported");
2953f6cb3bcbSJinsong Ji   // Create a unique bitmask for every processor resource unit.
2954f6cb3bcbSJinsong Ji   // Skip resource at index 0, since it always references 'InvalidUnit'.
2955f6cb3bcbSJinsong Ji   Masks.resize(SM.getNumProcResourceKinds());
2956f6cb3bcbSJinsong Ji   for (unsigned I = 1, E = SM.getNumProcResourceKinds(); I < E; ++I) {
2957f6cb3bcbSJinsong Ji     const MCProcResourceDesc &Desc = *SM.getProcResource(I);
2958f6cb3bcbSJinsong Ji     if (Desc.SubUnitsIdxBegin)
2959f6cb3bcbSJinsong Ji       continue;
2960f6cb3bcbSJinsong Ji     Masks[I] = 1ULL << ProcResourceID;
2961f6cb3bcbSJinsong Ji     ProcResourceID++;
2962f6cb3bcbSJinsong Ji   }
2963f6cb3bcbSJinsong Ji   // Create a unique bitmask for every processor resource group.
2964f6cb3bcbSJinsong Ji   for (unsigned I = 1, E = SM.getNumProcResourceKinds(); I < E; ++I) {
2965f6cb3bcbSJinsong Ji     const MCProcResourceDesc &Desc = *SM.getProcResource(I);
2966f6cb3bcbSJinsong Ji     if (!Desc.SubUnitsIdxBegin)
2967f6cb3bcbSJinsong Ji       continue;
2968f6cb3bcbSJinsong Ji     Masks[I] = 1ULL << ProcResourceID;
2969f6cb3bcbSJinsong Ji     for (unsigned U = 0; U < Desc.NumUnits; ++U)
2970f6cb3bcbSJinsong Ji       Masks[I] |= Masks[Desc.SubUnitsIdxBegin[U]];
2971f6cb3bcbSJinsong Ji     ProcResourceID++;
2972f6cb3bcbSJinsong Ji   }
2973f6cb3bcbSJinsong Ji   LLVM_DEBUG({
2974ba43840bSJinsong Ji     if (SwpShowResMask) {
2975f6cb3bcbSJinsong Ji       dbgs() << "ProcResourceDesc:\n";
2976f6cb3bcbSJinsong Ji       for (unsigned I = 1, E = SM.getNumProcResourceKinds(); I < E; ++I) {
2977f6cb3bcbSJinsong Ji         const MCProcResourceDesc *ProcResource = SM.getProcResource(I);
2978f6cb3bcbSJinsong Ji         dbgs() << format(" %16s(%2d): Mask: 0x%08x, NumUnits:%2d\n",
2979ba43840bSJinsong Ji                          ProcResource->Name, I, Masks[I],
2980ba43840bSJinsong Ji                          ProcResource->NumUnits);
2981f6cb3bcbSJinsong Ji       }
2982f6cb3bcbSJinsong Ji       dbgs() << " -----------------\n";
2983ba43840bSJinsong Ji     }
2984f6cb3bcbSJinsong Ji   });
2985f6cb3bcbSJinsong Ji }
2986f6cb3bcbSJinsong Ji 
2987f6cb3bcbSJinsong Ji bool ResourceManager::canReserveResources(const MCInstrDesc *MID) const {
2988f6cb3bcbSJinsong Ji 
2989ba43840bSJinsong Ji   LLVM_DEBUG({
2990ba43840bSJinsong Ji     if (SwpDebugResource)
2991ba43840bSJinsong Ji       dbgs() << "canReserveResources:\n";
2992ba43840bSJinsong Ji   });
2993f6cb3bcbSJinsong Ji   if (UseDFA)
2994f6cb3bcbSJinsong Ji     return DFAResources->canReserveResources(MID);
2995f6cb3bcbSJinsong Ji 
2996f6cb3bcbSJinsong Ji   unsigned InsnClass = MID->getSchedClass();
2997f6cb3bcbSJinsong Ji   const MCSchedClassDesc *SCDesc = SM.getSchedClassDesc(InsnClass);
2998f6cb3bcbSJinsong Ji   if (!SCDesc->isValid()) {
2999f6cb3bcbSJinsong Ji     LLVM_DEBUG({
3000f6cb3bcbSJinsong Ji       dbgs() << "No valid Schedule Class Desc for schedClass!\n";
300167c14d5cSThomas Preud'homme       dbgs() << "isPseudo:" << MID->isPseudo() << "\n";
3002f6cb3bcbSJinsong Ji     });
3003f6cb3bcbSJinsong Ji     return true;
3004f6cb3bcbSJinsong Ji   }
3005f6cb3bcbSJinsong Ji 
3006f6cb3bcbSJinsong Ji   const MCWriteProcResEntry *I = STI->getWriteProcResBegin(SCDesc);
3007f6cb3bcbSJinsong Ji   const MCWriteProcResEntry *E = STI->getWriteProcResEnd(SCDesc);
3008f6cb3bcbSJinsong Ji   for (; I != E; ++I) {
3009f6cb3bcbSJinsong Ji     if (!I->Cycles)
3010f6cb3bcbSJinsong Ji       continue;
3011f6cb3bcbSJinsong Ji     const MCProcResourceDesc *ProcResource =
3012f6cb3bcbSJinsong Ji         SM.getProcResource(I->ProcResourceIdx);
3013f6cb3bcbSJinsong Ji     unsigned NumUnits = ProcResource->NumUnits;
3014f6cb3bcbSJinsong Ji     LLVM_DEBUG({
3015ba43840bSJinsong Ji       if (SwpDebugResource)
3016f6cb3bcbSJinsong Ji         dbgs() << format(" %16s(%2d): Count: %2d, NumUnits:%2d, Cycles:%2d\n",
3017f6cb3bcbSJinsong Ji                          ProcResource->Name, I->ProcResourceIdx,
3018f6cb3bcbSJinsong Ji                          ProcResourceCount[I->ProcResourceIdx], NumUnits,
3019f6cb3bcbSJinsong Ji                          I->Cycles);
3020f6cb3bcbSJinsong Ji     });
3021f6cb3bcbSJinsong Ji     if (ProcResourceCount[I->ProcResourceIdx] >= NumUnits)
3022f6cb3bcbSJinsong Ji       return false;
3023f6cb3bcbSJinsong Ji   }
3024ba43840bSJinsong Ji   LLVM_DEBUG(if (SwpDebugResource) dbgs() << "return true\n\n";);
3025f6cb3bcbSJinsong Ji   return true;
3026f6cb3bcbSJinsong Ji }
3027f6cb3bcbSJinsong Ji 
3028f6cb3bcbSJinsong Ji void ResourceManager::reserveResources(const MCInstrDesc *MID) {
3029ba43840bSJinsong Ji   LLVM_DEBUG({
3030ba43840bSJinsong Ji     if (SwpDebugResource)
3031ba43840bSJinsong Ji       dbgs() << "reserveResources:\n";
3032ba43840bSJinsong Ji   });
3033f6cb3bcbSJinsong Ji   if (UseDFA)
3034f6cb3bcbSJinsong Ji     return DFAResources->reserveResources(MID);
3035f6cb3bcbSJinsong Ji 
3036f6cb3bcbSJinsong Ji   unsigned InsnClass = MID->getSchedClass();
3037f6cb3bcbSJinsong Ji   const MCSchedClassDesc *SCDesc = SM.getSchedClassDesc(InsnClass);
3038f6cb3bcbSJinsong Ji   if (!SCDesc->isValid()) {
3039f6cb3bcbSJinsong Ji     LLVM_DEBUG({
3040f6cb3bcbSJinsong Ji       dbgs() << "No valid Schedule Class Desc for schedClass!\n";
304167c14d5cSThomas Preud'homme       dbgs() << "isPseudo:" << MID->isPseudo() << "\n";
3042f6cb3bcbSJinsong Ji     });
3043f6cb3bcbSJinsong Ji     return;
3044f6cb3bcbSJinsong Ji   }
3045f6cb3bcbSJinsong Ji   for (const MCWriteProcResEntry &PRE :
3046f6cb3bcbSJinsong Ji        make_range(STI->getWriteProcResBegin(SCDesc),
3047f6cb3bcbSJinsong Ji                   STI->getWriteProcResEnd(SCDesc))) {
3048f6cb3bcbSJinsong Ji     if (!PRE.Cycles)
3049f6cb3bcbSJinsong Ji       continue;
3050f6cb3bcbSJinsong Ji     ++ProcResourceCount[PRE.ProcResourceIdx];
3051f6cb3bcbSJinsong Ji     LLVM_DEBUG({
3052ba43840bSJinsong Ji       if (SwpDebugResource) {
3053c77aff7eSRichard Trieu         const MCProcResourceDesc *ProcResource =
3054c77aff7eSRichard Trieu             SM.getProcResource(PRE.ProcResourceIdx);
3055f6cb3bcbSJinsong Ji         dbgs() << format(" %16s(%2d): Count: %2d, NumUnits:%2d, Cycles:%2d\n",
3056f6cb3bcbSJinsong Ji                          ProcResource->Name, PRE.ProcResourceIdx,
3057e8698eadSRichard Trieu                          ProcResourceCount[PRE.ProcResourceIdx],
3058e8698eadSRichard Trieu                          ProcResource->NumUnits, PRE.Cycles);
3059ba43840bSJinsong Ji       }
3060f6cb3bcbSJinsong Ji     });
3061f6cb3bcbSJinsong Ji   }
3062ba43840bSJinsong Ji   LLVM_DEBUG({
3063ba43840bSJinsong Ji     if (SwpDebugResource)
3064ba43840bSJinsong Ji       dbgs() << "reserveResources: done!\n\n";
3065ba43840bSJinsong Ji   });
3066f6cb3bcbSJinsong Ji }
3067f6cb3bcbSJinsong Ji 
3068f6cb3bcbSJinsong Ji bool ResourceManager::canReserveResources(const MachineInstr &MI) const {
3069f6cb3bcbSJinsong Ji   return canReserveResources(&MI.getDesc());
3070f6cb3bcbSJinsong Ji }
3071f6cb3bcbSJinsong Ji 
3072f6cb3bcbSJinsong Ji void ResourceManager::reserveResources(const MachineInstr &MI) {
3073f6cb3bcbSJinsong Ji   return reserveResources(&MI.getDesc());
3074f6cb3bcbSJinsong Ji }
3075f6cb3bcbSJinsong Ji 
3076f6cb3bcbSJinsong Ji void ResourceManager::clearResources() {
3077f6cb3bcbSJinsong Ji   if (UseDFA)
3078f6cb3bcbSJinsong Ji     return DFAResources->clearResources();
3079f6cb3bcbSJinsong Ji   std::fill(ProcResourceCount.begin(), ProcResourceCount.end(), 0);
3080f6cb3bcbSJinsong Ji }
3081