1 //===- MachinePipeliner.cpp - Machine Software Pipeliner Pass -------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // An implementation of the Swing Modulo Scheduling (SMS) software pipeliner.
10 //
11 // This SMS implementation is a target-independent back-end pass. When enabled,
12 // the pass runs just prior to the register allocation pass, while the machine
13 // IR is in SSA form. If software pipelining is successful, then the original
14 // loop is replaced by the optimized loop. The optimized loop contains one or
15 // more prolog blocks, the pipelined kernel, and one or more epilog blocks. If
16 // the instructions cannot be scheduled in a given MII, we increase the MII by
17 // one and try again.
18 //
19 // The SMS implementation is an extension of the ScheduleDAGInstrs class. We
20 // represent loop carried dependences in the DAG as order edges to the Phi
21 // nodes. We also perform several passes over the DAG to eliminate unnecessary
22 // edges that inhibit the ability to pipeline. The implementation uses the
23 // DFAPacketizer class to compute the minimum initiation interval and the check
24 // where an instruction may be inserted in the pipelined schedule.
25 //
26 // In order for the SMS pass to work, several target specific hooks need to be
27 // implemented to get information about the loop structure and to rewrite
28 // instructions.
29 //
30 //===----------------------------------------------------------------------===//
31 
32 #include "llvm/ADT/ArrayRef.h"
33 #include "llvm/ADT/BitVector.h"
34 #include "llvm/ADT/DenseMap.h"
35 #include "llvm/ADT/MapVector.h"
36 #include "llvm/ADT/PriorityQueue.h"
37 #include "llvm/ADT/SetOperations.h"
38 #include "llvm/ADT/SetVector.h"
39 #include "llvm/ADT/SmallPtrSet.h"
40 #include "llvm/ADT/SmallSet.h"
41 #include "llvm/ADT/SmallVector.h"
42 #include "llvm/ADT/Statistic.h"
43 #include "llvm/ADT/iterator_range.h"
44 #include "llvm/Analysis/AliasAnalysis.h"
45 #include "llvm/Analysis/MemoryLocation.h"
46 #include "llvm/Analysis/ValueTracking.h"
47 #include "llvm/CodeGen/DFAPacketizer.h"
48 #include "llvm/CodeGen/LiveIntervals.h"
49 #include "llvm/CodeGen/MachineBasicBlock.h"
50 #include "llvm/CodeGen/MachineDominators.h"
51 #include "llvm/CodeGen/MachineFunction.h"
52 #include "llvm/CodeGen/MachineFunctionPass.h"
53 #include "llvm/CodeGen/MachineInstr.h"
54 #include "llvm/CodeGen/MachineInstrBuilder.h"
55 #include "llvm/CodeGen/MachineLoopInfo.h"
56 #include "llvm/CodeGen/MachineMemOperand.h"
57 #include "llvm/CodeGen/MachineOperand.h"
58 #include "llvm/CodeGen/MachinePipeliner.h"
59 #include "llvm/CodeGen/MachineRegisterInfo.h"
60 #include "llvm/CodeGen/ModuloSchedule.h"
61 #include "llvm/CodeGen/RegisterPressure.h"
62 #include "llvm/CodeGen/ScheduleDAG.h"
63 #include "llvm/CodeGen/ScheduleDAGMutation.h"
64 #include "llvm/CodeGen/TargetOpcodes.h"
65 #include "llvm/CodeGen/TargetRegisterInfo.h"
66 #include "llvm/CodeGen/TargetSubtargetInfo.h"
67 #include "llvm/Config/llvm-config.h"
68 #include "llvm/IR/Attributes.h"
69 #include "llvm/IR/DebugLoc.h"
70 #include "llvm/IR/Function.h"
71 #include "llvm/MC/LaneBitmask.h"
72 #include "llvm/MC/MCInstrDesc.h"
73 #include "llvm/MC/MCInstrItineraries.h"
74 #include "llvm/MC/MCRegisterInfo.h"
75 #include "llvm/Pass.h"
76 #include "llvm/Support/CommandLine.h"
77 #include "llvm/Support/Compiler.h"
78 #include "llvm/Support/Debug.h"
79 #include "llvm/Support/MathExtras.h"
80 #include "llvm/Support/raw_ostream.h"
81 #include <algorithm>
82 #include <cassert>
83 #include <climits>
84 #include <cstdint>
85 #include <deque>
86 #include <functional>
87 #include <iterator>
88 #include <map>
89 #include <memory>
90 #include <tuple>
91 #include <utility>
92 #include <vector>
93 
94 using namespace llvm;
95 
96 #define DEBUG_TYPE "pipeliner"
97 
98 STATISTIC(NumTrytoPipeline, "Number of loops that we attempt to pipeline");
99 STATISTIC(NumPipelined, "Number of loops software pipelined");
100 STATISTIC(NumNodeOrderIssues, "Number of node order issues found");
101 STATISTIC(NumFailBranch, "Pipeliner abort due to unknown branch");
102 STATISTIC(NumFailLoop, "Pipeliner abort due to unsupported loop");
103 STATISTIC(NumFailPreheader, "Pipeliner abort due to missing preheader");
104 STATISTIC(NumFailLargeMaxMII, "Pipeliner abort due to MaxMII too large");
105 STATISTIC(NumFailZeroMII, "Pipeliner abort due to zero MII");
106 STATISTIC(NumFailNoSchedule, "Pipeliner abort due to no schedule found");
107 STATISTIC(NumFailZeroStage, "Pipeliner abort due to zero stage");
108 STATISTIC(NumFailLargeMaxStage, "Pipeliner abort due to too many stages");
109 
110 /// A command line option to turn software pipelining on or off.
111 static cl::opt<bool> EnableSWP("enable-pipeliner", cl::Hidden, cl::init(true),
112                                cl::ZeroOrMore,
113                                cl::desc("Enable Software Pipelining"));
114 
115 /// A command line option to enable SWP at -Os.
116 static cl::opt<bool> EnableSWPOptSize("enable-pipeliner-opt-size",
117                                       cl::desc("Enable SWP at Os."), cl::Hidden,
118                                       cl::init(false));
119 
120 /// A command line argument to limit minimum initial interval for pipelining.
121 static cl::opt<int> SwpMaxMii("pipeliner-max-mii",
122                               cl::desc("Size limit for the MII."),
123                               cl::Hidden, cl::init(27));
124 
125 /// A command line argument to limit the number of stages in the pipeline.
126 static cl::opt<int>
127     SwpMaxStages("pipeliner-max-stages",
128                  cl::desc("Maximum stages allowed in the generated scheduled."),
129                  cl::Hidden, cl::init(3));
130 
131 /// A command line option to disable the pruning of chain dependences due to
132 /// an unrelated Phi.
133 static cl::opt<bool>
134     SwpPruneDeps("pipeliner-prune-deps",
135                  cl::desc("Prune dependences between unrelated Phi nodes."),
136                  cl::Hidden, cl::init(true));
137 
138 /// A command line option to disable the pruning of loop carried order
139 /// dependences.
140 static cl::opt<bool>
141     SwpPruneLoopCarried("pipeliner-prune-loop-carried",
142                         cl::desc("Prune loop carried order dependences."),
143                         cl::Hidden, cl::init(true));
144 
145 #ifndef NDEBUG
146 static cl::opt<int> SwpLoopLimit("pipeliner-max", cl::Hidden, cl::init(-1));
147 #endif
148 
149 static cl::opt<bool> SwpIgnoreRecMII("pipeliner-ignore-recmii",
150                                      cl::ReallyHidden, cl::init(false),
151                                      cl::ZeroOrMore, cl::desc("Ignore RecMII"));
152 
153 static cl::opt<bool> SwpShowResMask("pipeliner-show-mask", cl::Hidden,
154                                     cl::init(false));
155 static cl::opt<bool> SwpDebugResource("pipeliner-dbg-res", cl::Hidden,
156                                       cl::init(false));
157 
158 static cl::opt<bool> EmitTestAnnotations(
159     "pipeliner-annotate-for-testing", cl::Hidden, cl::init(false),
160     cl::desc("Instead of emitting the pipelined code, annotate instructions "
161              "with the generated schedule for feeding into the "
162              "-modulo-schedule-test pass"));
163 
164 static cl::opt<bool> ExperimentalCodeGen(
165     "pipeliner-experimental-cg", cl::Hidden, cl::init(false),
166     cl::desc(
167         "Use the experimental peeling code generator for software pipelining"));
168 
169 namespace llvm {
170 
171 // A command line option to enable the CopyToPhi DAG mutation.
172 cl::opt<bool>
173     SwpEnableCopyToPhi("pipeliner-enable-copytophi", cl::ReallyHidden,
174                        cl::init(true), cl::ZeroOrMore,
175                        cl::desc("Enable CopyToPhi DAG Mutation"));
176 
177 } // end namespace llvm
178 
179 unsigned SwingSchedulerDAG::Circuits::MaxPaths = 5;
180 char MachinePipeliner::ID = 0;
181 #ifndef NDEBUG
182 int MachinePipeliner::NumTries = 0;
183 #endif
184 char &llvm::MachinePipelinerID = MachinePipeliner::ID;
185 
186 INITIALIZE_PASS_BEGIN(MachinePipeliner, DEBUG_TYPE,
187                       "Modulo Software Pipelining", false, false)
188 INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass)
189 INITIALIZE_PASS_DEPENDENCY(MachineLoopInfo)
190 INITIALIZE_PASS_DEPENDENCY(MachineDominatorTree)
191 INITIALIZE_PASS_DEPENDENCY(LiveIntervals)
192 INITIALIZE_PASS_END(MachinePipeliner, DEBUG_TYPE,
193                     "Modulo Software Pipelining", false, false)
194 
195 /// The "main" function for implementing Swing Modulo Scheduling.
196 bool MachinePipeliner::runOnMachineFunction(MachineFunction &mf) {
197   if (skipFunction(mf.getFunction()))
198     return false;
199 
200   if (!EnableSWP)
201     return false;
202 
203   if (mf.getFunction().getAttributes().hasFnAttr(Attribute::OptimizeForSize) &&
204       !EnableSWPOptSize.getPosition())
205     return false;
206 
207   if (!mf.getSubtarget().enableMachinePipeliner())
208     return false;
209 
210   // Cannot pipeline loops without instruction itineraries if we are using
211   // DFA for the pipeliner.
212   if (mf.getSubtarget().useDFAforSMS() &&
213       (!mf.getSubtarget().getInstrItineraryData() ||
214        mf.getSubtarget().getInstrItineraryData()->isEmpty()))
215     return false;
216 
217   MF = &mf;
218   MLI = &getAnalysis<MachineLoopInfo>();
219   MDT = &getAnalysis<MachineDominatorTree>();
220   ORE = &getAnalysis<MachineOptimizationRemarkEmitterPass>().getORE();
221   TII = MF->getSubtarget().getInstrInfo();
222   RegClassInfo.runOnMachineFunction(*MF);
223 
224   for (auto &L : *MLI)
225     scheduleLoop(*L);
226 
227   return false;
228 }
229 
230 /// Attempt to perform the SMS algorithm on the specified loop. This function is
231 /// the main entry point for the algorithm.  The function identifies candidate
232 /// loops, calculates the minimum initiation interval, and attempts to schedule
233 /// the loop.
234 bool MachinePipeliner::scheduleLoop(MachineLoop &L) {
235   bool Changed = false;
236   for (auto &InnerLoop : L)
237     Changed |= scheduleLoop(*InnerLoop);
238 
239 #ifndef NDEBUG
240   // Stop trying after reaching the limit (if any).
241   int Limit = SwpLoopLimit;
242   if (Limit >= 0) {
243     if (NumTries >= SwpLoopLimit)
244       return Changed;
245     NumTries++;
246   }
247 #endif
248 
249   setPragmaPipelineOptions(L);
250   if (!canPipelineLoop(L)) {
251     LLVM_DEBUG(dbgs() << "\n!!! Can not pipeline loop.\n");
252     ORE->emit([&]() {
253       return MachineOptimizationRemarkMissed(DEBUG_TYPE, "canPipelineLoop",
254                                              L.getStartLoc(), L.getHeader())
255              << "Failed to pipeline loop";
256     });
257 
258     return Changed;
259   }
260 
261   ++NumTrytoPipeline;
262 
263   Changed = swingModuloScheduler(L);
264 
265   return Changed;
266 }
267 
268 void MachinePipeliner::setPragmaPipelineOptions(MachineLoop &L) {
269   // Reset the pragma for the next loop in iteration.
270   disabledByPragma = false;
271   II_setByPragma = 0;
272 
273   MachineBasicBlock *LBLK = L.getTopBlock();
274 
275   if (LBLK == nullptr)
276     return;
277 
278   const BasicBlock *BBLK = LBLK->getBasicBlock();
279   if (BBLK == nullptr)
280     return;
281 
282   const Instruction *TI = BBLK->getTerminator();
283   if (TI == nullptr)
284     return;
285 
286   MDNode *LoopID = TI->getMetadata(LLVMContext::MD_loop);
287   if (LoopID == nullptr)
288     return;
289 
290   assert(LoopID->getNumOperands() > 0 && "requires atleast one operand");
291   assert(LoopID->getOperand(0) == LoopID && "invalid loop");
292 
293   for (unsigned i = 1, e = LoopID->getNumOperands(); i < e; ++i) {
294     MDNode *MD = dyn_cast<MDNode>(LoopID->getOperand(i));
295 
296     if (MD == nullptr)
297       continue;
298 
299     MDString *S = dyn_cast<MDString>(MD->getOperand(0));
300 
301     if (S == nullptr)
302       continue;
303 
304     if (S->getString() == "llvm.loop.pipeline.initiationinterval") {
305       assert(MD->getNumOperands() == 2 &&
306              "Pipeline initiation interval hint metadata should have two operands.");
307       II_setByPragma =
308           mdconst::extract<ConstantInt>(MD->getOperand(1))->getZExtValue();
309       assert(II_setByPragma >= 1 && "Pipeline initiation interval must be positive.");
310     } else if (S->getString() == "llvm.loop.pipeline.disable") {
311       disabledByPragma = true;
312     }
313   }
314 }
315 
316 /// Return true if the loop can be software pipelined.  The algorithm is
317 /// restricted to loops with a single basic block.  Make sure that the
318 /// branch in the loop can be analyzed.
319 bool MachinePipeliner::canPipelineLoop(MachineLoop &L) {
320   if (L.getNumBlocks() != 1) {
321     ORE->emit([&]() {
322       return MachineOptimizationRemarkAnalysis(DEBUG_TYPE, "canPipelineLoop",
323                                                L.getStartLoc(), L.getHeader())
324              << "Not a single basic block: "
325              << ore::NV("NumBlocks", L.getNumBlocks());
326     });
327     return false;
328   }
329 
330   if (disabledByPragma) {
331     ORE->emit([&]() {
332       return MachineOptimizationRemarkAnalysis(DEBUG_TYPE, "canPipelineLoop",
333                                                L.getStartLoc(), L.getHeader())
334              << "Disabled by Pragma.";
335     });
336     return false;
337   }
338 
339   // Check if the branch can't be understood because we can't do pipelining
340   // if that's the case.
341   LI.TBB = nullptr;
342   LI.FBB = nullptr;
343   LI.BrCond.clear();
344   if (TII->analyzeBranch(*L.getHeader(), LI.TBB, LI.FBB, LI.BrCond)) {
345     LLVM_DEBUG(dbgs() << "Unable to analyzeBranch, can NOT pipeline Loop\n");
346     NumFailBranch++;
347     ORE->emit([&]() {
348       return MachineOptimizationRemarkAnalysis(DEBUG_TYPE, "canPipelineLoop",
349                                                L.getStartLoc(), L.getHeader())
350              << "The branch can't be understood";
351     });
352     return false;
353   }
354 
355   LI.LoopInductionVar = nullptr;
356   LI.LoopCompare = nullptr;
357   if (!TII->analyzeLoopForPipelining(L.getTopBlock())) {
358     LLVM_DEBUG(dbgs() << "Unable to analyzeLoop, can NOT pipeline Loop\n");
359     NumFailLoop++;
360     ORE->emit([&]() {
361       return MachineOptimizationRemarkAnalysis(DEBUG_TYPE, "canPipelineLoop",
362                                                L.getStartLoc(), L.getHeader())
363              << "The loop structure is not supported";
364     });
365     return false;
366   }
367 
368   if (!L.getLoopPreheader()) {
369     LLVM_DEBUG(dbgs() << "Preheader not found, can NOT pipeline Loop\n");
370     NumFailPreheader++;
371     ORE->emit([&]() {
372       return MachineOptimizationRemarkAnalysis(DEBUG_TYPE, "canPipelineLoop",
373                                                L.getStartLoc(), L.getHeader())
374              << "No loop preheader found";
375     });
376     return false;
377   }
378 
379   // Remove any subregisters from inputs to phi nodes.
380   preprocessPhiNodes(*L.getHeader());
381   return true;
382 }
383 
384 void MachinePipeliner::preprocessPhiNodes(MachineBasicBlock &B) {
385   MachineRegisterInfo &MRI = MF->getRegInfo();
386   SlotIndexes &Slots = *getAnalysis<LiveIntervals>().getSlotIndexes();
387 
388   for (MachineInstr &PI : B.phis()) {
389     MachineOperand &DefOp = PI.getOperand(0);
390     assert(DefOp.getSubReg() == 0);
391     auto *RC = MRI.getRegClass(DefOp.getReg());
392 
393     for (unsigned i = 1, n = PI.getNumOperands(); i != n; i += 2) {
394       MachineOperand &RegOp = PI.getOperand(i);
395       if (RegOp.getSubReg() == 0)
396         continue;
397 
398       // If the operand uses a subregister, replace it with a new register
399       // without subregisters, and generate a copy to the new register.
400       Register NewReg = MRI.createVirtualRegister(RC);
401       MachineBasicBlock &PredB = *PI.getOperand(i+1).getMBB();
402       MachineBasicBlock::iterator At = PredB.getFirstTerminator();
403       const DebugLoc &DL = PredB.findDebugLoc(At);
404       auto Copy = BuildMI(PredB, At, DL, TII->get(TargetOpcode::COPY), NewReg)
405                     .addReg(RegOp.getReg(), getRegState(RegOp),
406                             RegOp.getSubReg());
407       Slots.insertMachineInstrInMaps(*Copy);
408       RegOp.setReg(NewReg);
409       RegOp.setSubReg(0);
410     }
411   }
412 }
413 
414 /// The SMS algorithm consists of the following main steps:
415 /// 1. Computation and analysis of the dependence graph.
416 /// 2. Ordering of the nodes (instructions).
417 /// 3. Attempt to Schedule the loop.
418 bool MachinePipeliner::swingModuloScheduler(MachineLoop &L) {
419   assert(L.getBlocks().size() == 1 && "SMS works on single blocks only.");
420 
421   SwingSchedulerDAG SMS(*this, L, getAnalysis<LiveIntervals>(), RegClassInfo,
422                         II_setByPragma);
423 
424   MachineBasicBlock *MBB = L.getHeader();
425   // The kernel should not include any terminator instructions.  These
426   // will be added back later.
427   SMS.startBlock(MBB);
428 
429   // Compute the number of 'real' instructions in the basic block by
430   // ignoring terminators.
431   unsigned size = MBB->size();
432   for (MachineBasicBlock::iterator I = MBB->getFirstTerminator(),
433                                    E = MBB->instr_end();
434        I != E; ++I, --size)
435     ;
436 
437   SMS.enterRegion(MBB, MBB->begin(), MBB->getFirstTerminator(), size);
438   SMS.schedule();
439   SMS.exitRegion();
440 
441   SMS.finishBlock();
442   return SMS.hasNewSchedule();
443 }
444 
445 void MachinePipeliner::getAnalysisUsage(AnalysisUsage &AU) const {
446   AU.addRequired<AAResultsWrapperPass>();
447   AU.addPreserved<AAResultsWrapperPass>();
448   AU.addRequired<MachineLoopInfo>();
449   AU.addRequired<MachineDominatorTree>();
450   AU.addRequired<LiveIntervals>();
451   AU.addRequired<MachineOptimizationRemarkEmitterPass>();
452   MachineFunctionPass::getAnalysisUsage(AU);
453 }
454 
455 void SwingSchedulerDAG::setMII(unsigned ResMII, unsigned RecMII) {
456   if (II_setByPragma > 0)
457     MII = II_setByPragma;
458   else
459     MII = std::max(ResMII, RecMII);
460 }
461 
462 void SwingSchedulerDAG::setMAX_II() {
463   if (II_setByPragma > 0)
464     MAX_II = II_setByPragma;
465   else
466     MAX_II = MII + 10;
467 }
468 
469 /// We override the schedule function in ScheduleDAGInstrs to implement the
470 /// scheduling part of the Swing Modulo Scheduling algorithm.
471 void SwingSchedulerDAG::schedule() {
472   AliasAnalysis *AA = &Pass.getAnalysis<AAResultsWrapperPass>().getAAResults();
473   buildSchedGraph(AA);
474   addLoopCarriedDependences(AA);
475   updatePhiDependences();
476   Topo.InitDAGTopologicalSorting();
477   changeDependences();
478   postprocessDAG();
479   LLVM_DEBUG(dump());
480 
481   NodeSetType NodeSets;
482   findCircuits(NodeSets);
483   NodeSetType Circuits = NodeSets;
484 
485   // Calculate the MII.
486   unsigned ResMII = calculateResMII();
487   unsigned RecMII = calculateRecMII(NodeSets);
488 
489   fuseRecs(NodeSets);
490 
491   // This flag is used for testing and can cause correctness problems.
492   if (SwpIgnoreRecMII)
493     RecMII = 0;
494 
495   setMII(ResMII, RecMII);
496   setMAX_II();
497 
498   LLVM_DEBUG(dbgs() << "MII = " << MII << " MAX_II = " << MAX_II
499                     << " (rec=" << RecMII << ", res=" << ResMII << ")\n");
500 
501   // Can't schedule a loop without a valid MII.
502   if (MII == 0) {
503     LLVM_DEBUG(dbgs() << "Invalid Minimal Initiation Interval: 0\n");
504     NumFailZeroMII++;
505     Pass.ORE->emit([&]() {
506       return MachineOptimizationRemarkAnalysis(
507                  DEBUG_TYPE, "schedule", Loop.getStartLoc(), Loop.getHeader())
508              << "Invalid Minimal Initiation Interval: 0";
509     });
510     return;
511   }
512 
513   // Don't pipeline large loops.
514   if (SwpMaxMii != -1 && (int)MII > SwpMaxMii) {
515     LLVM_DEBUG(dbgs() << "MII > " << SwpMaxMii
516                       << ", we don't pipleline large loops\n");
517     NumFailLargeMaxMII++;
518     Pass.ORE->emit([&]() {
519       return MachineOptimizationRemarkAnalysis(
520                  DEBUG_TYPE, "schedule", Loop.getStartLoc(), Loop.getHeader())
521              << "Minimal Initiation Interval too large: "
522              << ore::NV("MII", (int)MII) << " > "
523              << ore::NV("SwpMaxMii", SwpMaxMii) << "."
524              << "Refer to -pipeliner-max-mii.";
525     });
526     return;
527   }
528 
529   computeNodeFunctions(NodeSets);
530 
531   registerPressureFilter(NodeSets);
532 
533   colocateNodeSets(NodeSets);
534 
535   checkNodeSets(NodeSets);
536 
537   LLVM_DEBUG({
538     for (auto &I : NodeSets) {
539       dbgs() << "  Rec NodeSet ";
540       I.dump();
541     }
542   });
543 
544   llvm::stable_sort(NodeSets, std::greater<NodeSet>());
545 
546   groupRemainingNodes(NodeSets);
547 
548   removeDuplicateNodes(NodeSets);
549 
550   LLVM_DEBUG({
551     for (auto &I : NodeSets) {
552       dbgs() << "  NodeSet ";
553       I.dump();
554     }
555   });
556 
557   computeNodeOrder(NodeSets);
558 
559   // check for node order issues
560   checkValidNodeOrder(Circuits);
561 
562   SMSchedule Schedule(Pass.MF);
563   Scheduled = schedulePipeline(Schedule);
564 
565   if (!Scheduled){
566     LLVM_DEBUG(dbgs() << "No schedule found, return\n");
567     NumFailNoSchedule++;
568     Pass.ORE->emit([&]() {
569       return MachineOptimizationRemarkAnalysis(
570                  DEBUG_TYPE, "schedule", Loop.getStartLoc(), Loop.getHeader())
571              << "Unable to find schedule";
572     });
573     return;
574   }
575 
576   unsigned numStages = Schedule.getMaxStageCount();
577   // No need to generate pipeline if there are no overlapped iterations.
578   if (numStages == 0) {
579     LLVM_DEBUG(dbgs() << "No overlapped iterations, skip.\n");
580     NumFailZeroStage++;
581     Pass.ORE->emit([&]() {
582       return MachineOptimizationRemarkAnalysis(
583                  DEBUG_TYPE, "schedule", Loop.getStartLoc(), Loop.getHeader())
584              << "No need to pipeline - no overlapped iterations in schedule.";
585     });
586     return;
587   }
588   // Check that the maximum stage count is less than user-defined limit.
589   if (SwpMaxStages > -1 && (int)numStages > SwpMaxStages) {
590     LLVM_DEBUG(dbgs() << "numStages:" << numStages << ">" << SwpMaxStages
591                       << " : too many stages, abort\n");
592     NumFailLargeMaxStage++;
593     Pass.ORE->emit([&]() {
594       return MachineOptimizationRemarkAnalysis(
595                  DEBUG_TYPE, "schedule", Loop.getStartLoc(), Loop.getHeader())
596              << "Too many stages in schedule: "
597              << ore::NV("numStages", (int)numStages) << " > "
598              << ore::NV("SwpMaxStages", SwpMaxStages)
599              << ". Refer to -pipeliner-max-stages.";
600     });
601     return;
602   }
603 
604   Pass.ORE->emit([&]() {
605     return MachineOptimizationRemark(DEBUG_TYPE, "schedule", Loop.getStartLoc(),
606                                      Loop.getHeader())
607            << "Pipelined succesfully!";
608   });
609 
610   // Generate the schedule as a ModuloSchedule.
611   DenseMap<MachineInstr *, int> Cycles, Stages;
612   std::vector<MachineInstr *> OrderedInsts;
613   for (int Cycle = Schedule.getFirstCycle(); Cycle <= Schedule.getFinalCycle();
614        ++Cycle) {
615     for (SUnit *SU : Schedule.getInstructions(Cycle)) {
616       OrderedInsts.push_back(SU->getInstr());
617       Cycles[SU->getInstr()] = Cycle;
618       Stages[SU->getInstr()] = Schedule.stageScheduled(SU);
619     }
620   }
621   DenseMap<MachineInstr *, std::pair<unsigned, int64_t>> NewInstrChanges;
622   for (auto &KV : NewMIs) {
623     Cycles[KV.first] = Cycles[KV.second];
624     Stages[KV.first] = Stages[KV.second];
625     NewInstrChanges[KV.first] = InstrChanges[getSUnit(KV.first)];
626   }
627 
628   ModuloSchedule MS(MF, &Loop, std::move(OrderedInsts), std::move(Cycles),
629                     std::move(Stages));
630   if (EmitTestAnnotations) {
631     assert(NewInstrChanges.empty() &&
632            "Cannot serialize a schedule with InstrChanges!");
633     ModuloScheduleTestAnnotater MSTI(MF, MS);
634     MSTI.annotate();
635     return;
636   }
637   // The experimental code generator can't work if there are InstChanges.
638   if (ExperimentalCodeGen && NewInstrChanges.empty()) {
639     PeelingModuloScheduleExpander MSE(MF, MS, &LIS);
640     MSE.expand();
641   } else {
642     ModuloScheduleExpander MSE(MF, MS, LIS, std::move(NewInstrChanges));
643     MSE.expand();
644     MSE.cleanup();
645   }
646   ++NumPipelined;
647 }
648 
649 /// Clean up after the software pipeliner runs.
650 void SwingSchedulerDAG::finishBlock() {
651   for (auto &KV : NewMIs)
652     MF.DeleteMachineInstr(KV.second);
653   NewMIs.clear();
654 
655   // Call the superclass.
656   ScheduleDAGInstrs::finishBlock();
657 }
658 
659 /// Return the register values for  the operands of a Phi instruction.
660 /// This function assume the instruction is a Phi.
661 static void getPhiRegs(MachineInstr &Phi, MachineBasicBlock *Loop,
662                        unsigned &InitVal, unsigned &LoopVal) {
663   assert(Phi.isPHI() && "Expecting a Phi.");
664 
665   InitVal = 0;
666   LoopVal = 0;
667   for (unsigned i = 1, e = Phi.getNumOperands(); i != e; i += 2)
668     if (Phi.getOperand(i + 1).getMBB() != Loop)
669       InitVal = Phi.getOperand(i).getReg();
670     else
671       LoopVal = Phi.getOperand(i).getReg();
672 
673   assert(InitVal != 0 && LoopVal != 0 && "Unexpected Phi structure.");
674 }
675 
676 /// Return the Phi register value that comes the loop block.
677 static unsigned getLoopPhiReg(MachineInstr &Phi, MachineBasicBlock *LoopBB) {
678   for (unsigned i = 1, e = Phi.getNumOperands(); i != e; i += 2)
679     if (Phi.getOperand(i + 1).getMBB() == LoopBB)
680       return Phi.getOperand(i).getReg();
681   return 0;
682 }
683 
684 /// Return true if SUb can be reached from SUa following the chain edges.
685 static bool isSuccOrder(SUnit *SUa, SUnit *SUb) {
686   SmallPtrSet<SUnit *, 8> Visited;
687   SmallVector<SUnit *, 8> Worklist;
688   Worklist.push_back(SUa);
689   while (!Worklist.empty()) {
690     const SUnit *SU = Worklist.pop_back_val();
691     for (auto &SI : SU->Succs) {
692       SUnit *SuccSU = SI.getSUnit();
693       if (SI.getKind() == SDep::Order) {
694         if (Visited.count(SuccSU))
695           continue;
696         if (SuccSU == SUb)
697           return true;
698         Worklist.push_back(SuccSU);
699         Visited.insert(SuccSU);
700       }
701     }
702   }
703   return false;
704 }
705 
706 /// Return true if the instruction causes a chain between memory
707 /// references before and after it.
708 static bool isDependenceBarrier(MachineInstr &MI, AliasAnalysis *AA) {
709   return MI.isCall() || MI.mayRaiseFPException() ||
710          MI.hasUnmodeledSideEffects() ||
711          (MI.hasOrderedMemoryRef() &&
712           (!MI.mayLoad() || !MI.isDereferenceableInvariantLoad(AA)));
713 }
714 
715 /// Return the underlying objects for the memory references of an instruction.
716 /// This function calls the code in ValueTracking, but first checks that the
717 /// instruction has a memory operand.
718 static void getUnderlyingObjects(const MachineInstr *MI,
719                                  SmallVectorImpl<const Value *> &Objs) {
720   if (!MI->hasOneMemOperand())
721     return;
722   MachineMemOperand *MM = *MI->memoperands_begin();
723   if (!MM->getValue())
724     return;
725   getUnderlyingObjects(MM->getValue(), Objs);
726   for (const Value *V : Objs) {
727     if (!isIdentifiedObject(V)) {
728       Objs.clear();
729       return;
730     }
731     Objs.push_back(V);
732   }
733 }
734 
735 /// Add a chain edge between a load and store if the store can be an
736 /// alias of the load on a subsequent iteration, i.e., a loop carried
737 /// dependence. This code is very similar to the code in ScheduleDAGInstrs
738 /// but that code doesn't create loop carried dependences.
739 void SwingSchedulerDAG::addLoopCarriedDependences(AliasAnalysis *AA) {
740   MapVector<const Value *, SmallVector<SUnit *, 4>> PendingLoads;
741   Value *UnknownValue =
742     UndefValue::get(Type::getVoidTy(MF.getFunction().getContext()));
743   for (auto &SU : SUnits) {
744     MachineInstr &MI = *SU.getInstr();
745     if (isDependenceBarrier(MI, AA))
746       PendingLoads.clear();
747     else if (MI.mayLoad()) {
748       SmallVector<const Value *, 4> Objs;
749       ::getUnderlyingObjects(&MI, Objs);
750       if (Objs.empty())
751         Objs.push_back(UnknownValue);
752       for (auto V : Objs) {
753         SmallVector<SUnit *, 4> &SUs = PendingLoads[V];
754         SUs.push_back(&SU);
755       }
756     } else if (MI.mayStore()) {
757       SmallVector<const Value *, 4> Objs;
758       ::getUnderlyingObjects(&MI, Objs);
759       if (Objs.empty())
760         Objs.push_back(UnknownValue);
761       for (auto V : Objs) {
762         MapVector<const Value *, SmallVector<SUnit *, 4>>::iterator I =
763             PendingLoads.find(V);
764         if (I == PendingLoads.end())
765           continue;
766         for (auto Load : I->second) {
767           if (isSuccOrder(Load, &SU))
768             continue;
769           MachineInstr &LdMI = *Load->getInstr();
770           // First, perform the cheaper check that compares the base register.
771           // If they are the same and the load offset is less than the store
772           // offset, then mark the dependence as loop carried potentially.
773           const MachineOperand *BaseOp1, *BaseOp2;
774           int64_t Offset1, Offset2;
775           bool Offset1IsScalable, Offset2IsScalable;
776           if (TII->getMemOperandWithOffset(LdMI, BaseOp1, Offset1,
777                                            Offset1IsScalable, TRI) &&
778               TII->getMemOperandWithOffset(MI, BaseOp2, Offset2,
779                                            Offset2IsScalable, TRI)) {
780             if (BaseOp1->isIdenticalTo(*BaseOp2) &&
781                 Offset1IsScalable == Offset2IsScalable &&
782                 (int)Offset1 < (int)Offset2) {
783               assert(TII->areMemAccessesTriviallyDisjoint(LdMI, MI) &&
784                      "What happened to the chain edge?");
785               SDep Dep(Load, SDep::Barrier);
786               Dep.setLatency(1);
787               SU.addPred(Dep);
788               continue;
789             }
790           }
791           // Second, the more expensive check that uses alias analysis on the
792           // base registers. If they alias, and the load offset is less than
793           // the store offset, the mark the dependence as loop carried.
794           if (!AA) {
795             SDep Dep(Load, SDep::Barrier);
796             Dep.setLatency(1);
797             SU.addPred(Dep);
798             continue;
799           }
800           MachineMemOperand *MMO1 = *LdMI.memoperands_begin();
801           MachineMemOperand *MMO2 = *MI.memoperands_begin();
802           if (!MMO1->getValue() || !MMO2->getValue()) {
803             SDep Dep(Load, SDep::Barrier);
804             Dep.setLatency(1);
805             SU.addPred(Dep);
806             continue;
807           }
808           if (MMO1->getValue() == MMO2->getValue() &&
809               MMO1->getOffset() <= MMO2->getOffset()) {
810             SDep Dep(Load, SDep::Barrier);
811             Dep.setLatency(1);
812             SU.addPred(Dep);
813             continue;
814           }
815           if (!AA->isNoAlias(
816                   MemoryLocation::getAfter(MMO1->getValue(), MMO1->getAAInfo()),
817                   MemoryLocation::getAfter(MMO2->getValue(),
818                                            MMO2->getAAInfo()))) {
819             SDep Dep(Load, SDep::Barrier);
820             Dep.setLatency(1);
821             SU.addPred(Dep);
822           }
823         }
824       }
825     }
826   }
827 }
828 
829 /// Update the phi dependences to the DAG because ScheduleDAGInstrs no longer
830 /// processes dependences for PHIs. This function adds true dependences
831 /// from a PHI to a use, and a loop carried dependence from the use to the
832 /// PHI. The loop carried dependence is represented as an anti dependence
833 /// edge. This function also removes chain dependences between unrelated
834 /// PHIs.
835 void SwingSchedulerDAG::updatePhiDependences() {
836   SmallVector<SDep, 4> RemoveDeps;
837   const TargetSubtargetInfo &ST = MF.getSubtarget<TargetSubtargetInfo>();
838 
839   // Iterate over each DAG node.
840   for (SUnit &I : SUnits) {
841     RemoveDeps.clear();
842     // Set to true if the instruction has an operand defined by a Phi.
843     unsigned HasPhiUse = 0;
844     unsigned HasPhiDef = 0;
845     MachineInstr *MI = I.getInstr();
846     // Iterate over each operand, and we process the definitions.
847     for (MachineInstr::mop_iterator MOI = MI->operands_begin(),
848                                     MOE = MI->operands_end();
849          MOI != MOE; ++MOI) {
850       if (!MOI->isReg())
851         continue;
852       Register Reg = MOI->getReg();
853       if (MOI->isDef()) {
854         // If the register is used by a Phi, then create an anti dependence.
855         for (MachineRegisterInfo::use_instr_iterator
856                  UI = MRI.use_instr_begin(Reg),
857                  UE = MRI.use_instr_end();
858              UI != UE; ++UI) {
859           MachineInstr *UseMI = &*UI;
860           SUnit *SU = getSUnit(UseMI);
861           if (SU != nullptr && UseMI->isPHI()) {
862             if (!MI->isPHI()) {
863               SDep Dep(SU, SDep::Anti, Reg);
864               Dep.setLatency(1);
865               I.addPred(Dep);
866             } else {
867               HasPhiDef = Reg;
868               // Add a chain edge to a dependent Phi that isn't an existing
869               // predecessor.
870               if (SU->NodeNum < I.NodeNum && !I.isPred(SU))
871                 I.addPred(SDep(SU, SDep::Barrier));
872             }
873           }
874         }
875       } else if (MOI->isUse()) {
876         // If the register is defined by a Phi, then create a true dependence.
877         MachineInstr *DefMI = MRI.getUniqueVRegDef(Reg);
878         if (DefMI == nullptr)
879           continue;
880         SUnit *SU = getSUnit(DefMI);
881         if (SU != nullptr && DefMI->isPHI()) {
882           if (!MI->isPHI()) {
883             SDep Dep(SU, SDep::Data, Reg);
884             Dep.setLatency(0);
885             ST.adjustSchedDependency(SU, 0, &I, MI->getOperandNo(MOI), Dep);
886             I.addPred(Dep);
887           } else {
888             HasPhiUse = Reg;
889             // Add a chain edge to a dependent Phi that isn't an existing
890             // predecessor.
891             if (SU->NodeNum < I.NodeNum && !I.isPred(SU))
892               I.addPred(SDep(SU, SDep::Barrier));
893           }
894         }
895       }
896     }
897     // Remove order dependences from an unrelated Phi.
898     if (!SwpPruneDeps)
899       continue;
900     for (auto &PI : I.Preds) {
901       MachineInstr *PMI = PI.getSUnit()->getInstr();
902       if (PMI->isPHI() && PI.getKind() == SDep::Order) {
903         if (I.getInstr()->isPHI()) {
904           if (PMI->getOperand(0).getReg() == HasPhiUse)
905             continue;
906           if (getLoopPhiReg(*PMI, PMI->getParent()) == HasPhiDef)
907             continue;
908         }
909         RemoveDeps.push_back(PI);
910       }
911     }
912     for (int i = 0, e = RemoveDeps.size(); i != e; ++i)
913       I.removePred(RemoveDeps[i]);
914   }
915 }
916 
917 /// Iterate over each DAG node and see if we can change any dependences
918 /// in order to reduce the recurrence MII.
919 void SwingSchedulerDAG::changeDependences() {
920   // See if an instruction can use a value from the previous iteration.
921   // If so, we update the base and offset of the instruction and change
922   // the dependences.
923   for (SUnit &I : SUnits) {
924     unsigned BasePos = 0, OffsetPos = 0, NewBase = 0;
925     int64_t NewOffset = 0;
926     if (!canUseLastOffsetValue(I.getInstr(), BasePos, OffsetPos, NewBase,
927                                NewOffset))
928       continue;
929 
930     // Get the MI and SUnit for the instruction that defines the original base.
931     Register OrigBase = I.getInstr()->getOperand(BasePos).getReg();
932     MachineInstr *DefMI = MRI.getUniqueVRegDef(OrigBase);
933     if (!DefMI)
934       continue;
935     SUnit *DefSU = getSUnit(DefMI);
936     if (!DefSU)
937       continue;
938     // Get the MI and SUnit for the instruction that defins the new base.
939     MachineInstr *LastMI = MRI.getUniqueVRegDef(NewBase);
940     if (!LastMI)
941       continue;
942     SUnit *LastSU = getSUnit(LastMI);
943     if (!LastSU)
944       continue;
945 
946     if (Topo.IsReachable(&I, LastSU))
947       continue;
948 
949     // Remove the dependence. The value now depends on a prior iteration.
950     SmallVector<SDep, 4> Deps;
951     for (const SDep &P : I.Preds)
952       if (P.getSUnit() == DefSU)
953         Deps.push_back(P);
954     for (int i = 0, e = Deps.size(); i != e; i++) {
955       Topo.RemovePred(&I, Deps[i].getSUnit());
956       I.removePred(Deps[i]);
957     }
958     // Remove the chain dependence between the instructions.
959     Deps.clear();
960     for (auto &P : LastSU->Preds)
961       if (P.getSUnit() == &I && P.getKind() == SDep::Order)
962         Deps.push_back(P);
963     for (int i = 0, e = Deps.size(); i != e; i++) {
964       Topo.RemovePred(LastSU, Deps[i].getSUnit());
965       LastSU->removePred(Deps[i]);
966     }
967 
968     // Add a dependence between the new instruction and the instruction
969     // that defines the new base.
970     SDep Dep(&I, SDep::Anti, NewBase);
971     Topo.AddPred(LastSU, &I);
972     LastSU->addPred(Dep);
973 
974     // Remember the base and offset information so that we can update the
975     // instruction during code generation.
976     InstrChanges[&I] = std::make_pair(NewBase, NewOffset);
977   }
978 }
979 
980 namespace {
981 
982 // FuncUnitSorter - Comparison operator used to sort instructions by
983 // the number of functional unit choices.
984 struct FuncUnitSorter {
985   const InstrItineraryData *InstrItins;
986   const MCSubtargetInfo *STI;
987   DenseMap<InstrStage::FuncUnits, unsigned> Resources;
988 
989   FuncUnitSorter(const TargetSubtargetInfo &TSI)
990       : InstrItins(TSI.getInstrItineraryData()), STI(&TSI) {}
991 
992   // Compute the number of functional unit alternatives needed
993   // at each stage, and take the minimum value. We prioritize the
994   // instructions by the least number of choices first.
995   unsigned minFuncUnits(const MachineInstr *Inst,
996                         InstrStage::FuncUnits &F) const {
997     unsigned SchedClass = Inst->getDesc().getSchedClass();
998     unsigned min = UINT_MAX;
999     if (InstrItins && !InstrItins->isEmpty()) {
1000       for (const InstrStage &IS :
1001            make_range(InstrItins->beginStage(SchedClass),
1002                       InstrItins->endStage(SchedClass))) {
1003         InstrStage::FuncUnits funcUnits = IS.getUnits();
1004         unsigned numAlternatives = countPopulation(funcUnits);
1005         if (numAlternatives < min) {
1006           min = numAlternatives;
1007           F = funcUnits;
1008         }
1009       }
1010       return min;
1011     }
1012     if (STI && STI->getSchedModel().hasInstrSchedModel()) {
1013       const MCSchedClassDesc *SCDesc =
1014           STI->getSchedModel().getSchedClassDesc(SchedClass);
1015       if (!SCDesc->isValid())
1016         // No valid Schedule Class Desc for schedClass, should be
1017         // Pseudo/PostRAPseudo
1018         return min;
1019 
1020       for (const MCWriteProcResEntry &PRE :
1021            make_range(STI->getWriteProcResBegin(SCDesc),
1022                       STI->getWriteProcResEnd(SCDesc))) {
1023         if (!PRE.Cycles)
1024           continue;
1025         const MCProcResourceDesc *ProcResource =
1026             STI->getSchedModel().getProcResource(PRE.ProcResourceIdx);
1027         unsigned NumUnits = ProcResource->NumUnits;
1028         if (NumUnits < min) {
1029           min = NumUnits;
1030           F = PRE.ProcResourceIdx;
1031         }
1032       }
1033       return min;
1034     }
1035     llvm_unreachable("Should have non-empty InstrItins or hasInstrSchedModel!");
1036   }
1037 
1038   // Compute the critical resources needed by the instruction. This
1039   // function records the functional units needed by instructions that
1040   // must use only one functional unit. We use this as a tie breaker
1041   // for computing the resource MII. The instrutions that require
1042   // the same, highly used, functional unit have high priority.
1043   void calcCriticalResources(MachineInstr &MI) {
1044     unsigned SchedClass = MI.getDesc().getSchedClass();
1045     if (InstrItins && !InstrItins->isEmpty()) {
1046       for (const InstrStage &IS :
1047            make_range(InstrItins->beginStage(SchedClass),
1048                       InstrItins->endStage(SchedClass))) {
1049         InstrStage::FuncUnits FuncUnits = IS.getUnits();
1050         if (countPopulation(FuncUnits) == 1)
1051           Resources[FuncUnits]++;
1052       }
1053       return;
1054     }
1055     if (STI && STI->getSchedModel().hasInstrSchedModel()) {
1056       const MCSchedClassDesc *SCDesc =
1057           STI->getSchedModel().getSchedClassDesc(SchedClass);
1058       if (!SCDesc->isValid())
1059         // No valid Schedule Class Desc for schedClass, should be
1060         // Pseudo/PostRAPseudo
1061         return;
1062 
1063       for (const MCWriteProcResEntry &PRE :
1064            make_range(STI->getWriteProcResBegin(SCDesc),
1065                       STI->getWriteProcResEnd(SCDesc))) {
1066         if (!PRE.Cycles)
1067           continue;
1068         Resources[PRE.ProcResourceIdx]++;
1069       }
1070       return;
1071     }
1072     llvm_unreachable("Should have non-empty InstrItins or hasInstrSchedModel!");
1073   }
1074 
1075   /// Return true if IS1 has less priority than IS2.
1076   bool operator()(const MachineInstr *IS1, const MachineInstr *IS2) const {
1077     InstrStage::FuncUnits F1 = 0, F2 = 0;
1078     unsigned MFUs1 = minFuncUnits(IS1, F1);
1079     unsigned MFUs2 = minFuncUnits(IS2, F2);
1080     if (MFUs1 == MFUs2)
1081       return Resources.lookup(F1) < Resources.lookup(F2);
1082     return MFUs1 > MFUs2;
1083   }
1084 };
1085 
1086 } // end anonymous namespace
1087 
1088 /// Calculate the resource constrained minimum initiation interval for the
1089 /// specified loop. We use the DFA to model the resources needed for
1090 /// each instruction, and we ignore dependences. A different DFA is created
1091 /// for each cycle that is required. When adding a new instruction, we attempt
1092 /// to add it to each existing DFA, until a legal space is found. If the
1093 /// instruction cannot be reserved in an existing DFA, we create a new one.
1094 unsigned SwingSchedulerDAG::calculateResMII() {
1095 
1096   LLVM_DEBUG(dbgs() << "calculateResMII:\n");
1097   SmallVector<ResourceManager*, 8> Resources;
1098   MachineBasicBlock *MBB = Loop.getHeader();
1099   Resources.push_back(new ResourceManager(&MF.getSubtarget()));
1100 
1101   // Sort the instructions by the number of available choices for scheduling,
1102   // least to most. Use the number of critical resources as the tie breaker.
1103   FuncUnitSorter FUS = FuncUnitSorter(MF.getSubtarget());
1104   for (MachineBasicBlock::iterator I = MBB->getFirstNonPHI(),
1105                                    E = MBB->getFirstTerminator();
1106        I != E; ++I)
1107     FUS.calcCriticalResources(*I);
1108   PriorityQueue<MachineInstr *, std::vector<MachineInstr *>, FuncUnitSorter>
1109       FuncUnitOrder(FUS);
1110 
1111   for (MachineBasicBlock::iterator I = MBB->getFirstNonPHI(),
1112                                    E = MBB->getFirstTerminator();
1113        I != E; ++I)
1114     FuncUnitOrder.push(&*I);
1115 
1116   while (!FuncUnitOrder.empty()) {
1117     MachineInstr *MI = FuncUnitOrder.top();
1118     FuncUnitOrder.pop();
1119     if (TII->isZeroCost(MI->getOpcode()))
1120       continue;
1121     // Attempt to reserve the instruction in an existing DFA. At least one
1122     // DFA is needed for each cycle.
1123     unsigned NumCycles = getSUnit(MI)->Latency;
1124     unsigned ReservedCycles = 0;
1125     SmallVectorImpl<ResourceManager *>::iterator RI = Resources.begin();
1126     SmallVectorImpl<ResourceManager *>::iterator RE = Resources.end();
1127     LLVM_DEBUG({
1128       dbgs() << "Trying to reserve resource for " << NumCycles
1129              << " cycles for \n";
1130       MI->dump();
1131     });
1132     for (unsigned C = 0; C < NumCycles; ++C)
1133       while (RI != RE) {
1134         if ((*RI)->canReserveResources(*MI)) {
1135           (*RI)->reserveResources(*MI);
1136           ++ReservedCycles;
1137           break;
1138         }
1139         RI++;
1140       }
1141     LLVM_DEBUG(dbgs() << "ReservedCycles:" << ReservedCycles
1142                       << ", NumCycles:" << NumCycles << "\n");
1143     // Add new DFAs, if needed, to reserve resources.
1144     for (unsigned C = ReservedCycles; C < NumCycles; ++C) {
1145       LLVM_DEBUG(if (SwpDebugResource) dbgs()
1146                  << "NewResource created to reserve resources"
1147                  << "\n");
1148       ResourceManager *NewResource = new ResourceManager(&MF.getSubtarget());
1149       assert(NewResource->canReserveResources(*MI) && "Reserve error.");
1150       NewResource->reserveResources(*MI);
1151       Resources.push_back(NewResource);
1152     }
1153   }
1154   int Resmii = Resources.size();
1155   LLVM_DEBUG(dbgs() << "Return Res MII:" << Resmii << "\n");
1156   // Delete the memory for each of the DFAs that were created earlier.
1157   for (ResourceManager *RI : Resources) {
1158     ResourceManager *D = RI;
1159     delete D;
1160   }
1161   Resources.clear();
1162   return Resmii;
1163 }
1164 
1165 /// Calculate the recurrence-constrainted minimum initiation interval.
1166 /// Iterate over each circuit.  Compute the delay(c) and distance(c)
1167 /// for each circuit. The II needs to satisfy the inequality
1168 /// delay(c) - II*distance(c) <= 0. For each circuit, choose the smallest
1169 /// II that satisfies the inequality, and the RecMII is the maximum
1170 /// of those values.
1171 unsigned SwingSchedulerDAG::calculateRecMII(NodeSetType &NodeSets) {
1172   unsigned RecMII = 0;
1173 
1174   for (NodeSet &Nodes : NodeSets) {
1175     if (Nodes.empty())
1176       continue;
1177 
1178     unsigned Delay = Nodes.getLatency();
1179     unsigned Distance = 1;
1180 
1181     // ii = ceil(delay / distance)
1182     unsigned CurMII = (Delay + Distance - 1) / Distance;
1183     Nodes.setRecMII(CurMII);
1184     if (CurMII > RecMII)
1185       RecMII = CurMII;
1186   }
1187 
1188   return RecMII;
1189 }
1190 
1191 /// Swap all the anti dependences in the DAG. That means it is no longer a DAG,
1192 /// but we do this to find the circuits, and then change them back.
1193 static void swapAntiDependences(std::vector<SUnit> &SUnits) {
1194   SmallVector<std::pair<SUnit *, SDep>, 8> DepsAdded;
1195   for (SUnit &SU : SUnits) {
1196     for (SDep &Pred : SU.Preds)
1197       if (Pred.getKind() == SDep::Anti)
1198         DepsAdded.push_back(std::make_pair(&SU, Pred));
1199   }
1200   for (std::pair<SUnit *, SDep> &P : DepsAdded) {
1201     // Remove this anti dependency and add one in the reverse direction.
1202     SUnit *SU = P.first;
1203     SDep &D = P.second;
1204     SUnit *TargetSU = D.getSUnit();
1205     unsigned Reg = D.getReg();
1206     unsigned Lat = D.getLatency();
1207     SU->removePred(D);
1208     SDep Dep(SU, SDep::Anti, Reg);
1209     Dep.setLatency(Lat);
1210     TargetSU->addPred(Dep);
1211   }
1212 }
1213 
1214 /// Create the adjacency structure of the nodes in the graph.
1215 void SwingSchedulerDAG::Circuits::createAdjacencyStructure(
1216     SwingSchedulerDAG *DAG) {
1217   BitVector Added(SUnits.size());
1218   DenseMap<int, int> OutputDeps;
1219   for (int i = 0, e = SUnits.size(); i != e; ++i) {
1220     Added.reset();
1221     // Add any successor to the adjacency matrix and exclude duplicates.
1222     for (auto &SI : SUnits[i].Succs) {
1223       // Only create a back-edge on the first and last nodes of a dependence
1224       // chain. This records any chains and adds them later.
1225       if (SI.getKind() == SDep::Output) {
1226         int N = SI.getSUnit()->NodeNum;
1227         int BackEdge = i;
1228         auto Dep = OutputDeps.find(BackEdge);
1229         if (Dep != OutputDeps.end()) {
1230           BackEdge = Dep->second;
1231           OutputDeps.erase(Dep);
1232         }
1233         OutputDeps[N] = BackEdge;
1234       }
1235       // Do not process a boundary node, an artificial node.
1236       // A back-edge is processed only if it goes to a Phi.
1237       if (SI.getSUnit()->isBoundaryNode() || SI.isArtificial() ||
1238           (SI.getKind() == SDep::Anti && !SI.getSUnit()->getInstr()->isPHI()))
1239         continue;
1240       int N = SI.getSUnit()->NodeNum;
1241       if (!Added.test(N)) {
1242         AdjK[i].push_back(N);
1243         Added.set(N);
1244       }
1245     }
1246     // A chain edge between a store and a load is treated as a back-edge in the
1247     // adjacency matrix.
1248     for (auto &PI : SUnits[i].Preds) {
1249       if (!SUnits[i].getInstr()->mayStore() ||
1250           !DAG->isLoopCarriedDep(&SUnits[i], PI, false))
1251         continue;
1252       if (PI.getKind() == SDep::Order && PI.getSUnit()->getInstr()->mayLoad()) {
1253         int N = PI.getSUnit()->NodeNum;
1254         if (!Added.test(N)) {
1255           AdjK[i].push_back(N);
1256           Added.set(N);
1257         }
1258       }
1259     }
1260   }
1261   // Add back-edges in the adjacency matrix for the output dependences.
1262   for (auto &OD : OutputDeps)
1263     if (!Added.test(OD.second)) {
1264       AdjK[OD.first].push_back(OD.second);
1265       Added.set(OD.second);
1266     }
1267 }
1268 
1269 /// Identify an elementary circuit in the dependence graph starting at the
1270 /// specified node.
1271 bool SwingSchedulerDAG::Circuits::circuit(int V, int S, NodeSetType &NodeSets,
1272                                           bool HasBackedge) {
1273   SUnit *SV = &SUnits[V];
1274   bool F = false;
1275   Stack.insert(SV);
1276   Blocked.set(V);
1277 
1278   for (auto W : AdjK[V]) {
1279     if (NumPaths > MaxPaths)
1280       break;
1281     if (W < S)
1282       continue;
1283     if (W == S) {
1284       if (!HasBackedge)
1285         NodeSets.push_back(NodeSet(Stack.begin(), Stack.end()));
1286       F = true;
1287       ++NumPaths;
1288       break;
1289     } else if (!Blocked.test(W)) {
1290       if (circuit(W, S, NodeSets,
1291                   Node2Idx->at(W) < Node2Idx->at(V) ? true : HasBackedge))
1292         F = true;
1293     }
1294   }
1295 
1296   if (F)
1297     unblock(V);
1298   else {
1299     for (auto W : AdjK[V]) {
1300       if (W < S)
1301         continue;
1302       if (B[W].count(SV) == 0)
1303         B[W].insert(SV);
1304     }
1305   }
1306   Stack.pop_back();
1307   return F;
1308 }
1309 
1310 /// Unblock a node in the circuit finding algorithm.
1311 void SwingSchedulerDAG::Circuits::unblock(int U) {
1312   Blocked.reset(U);
1313   SmallPtrSet<SUnit *, 4> &BU = B[U];
1314   while (!BU.empty()) {
1315     SmallPtrSet<SUnit *, 4>::iterator SI = BU.begin();
1316     assert(SI != BU.end() && "Invalid B set.");
1317     SUnit *W = *SI;
1318     BU.erase(W);
1319     if (Blocked.test(W->NodeNum))
1320       unblock(W->NodeNum);
1321   }
1322 }
1323 
1324 /// Identify all the elementary circuits in the dependence graph using
1325 /// Johnson's circuit algorithm.
1326 void SwingSchedulerDAG::findCircuits(NodeSetType &NodeSets) {
1327   // Swap all the anti dependences in the DAG. That means it is no longer a DAG,
1328   // but we do this to find the circuits, and then change them back.
1329   swapAntiDependences(SUnits);
1330 
1331   Circuits Cir(SUnits, Topo);
1332   // Create the adjacency structure.
1333   Cir.createAdjacencyStructure(this);
1334   for (int i = 0, e = SUnits.size(); i != e; ++i) {
1335     Cir.reset();
1336     Cir.circuit(i, i, NodeSets);
1337   }
1338 
1339   // Change the dependences back so that we've created a DAG again.
1340   swapAntiDependences(SUnits);
1341 }
1342 
1343 // Create artificial dependencies between the source of COPY/REG_SEQUENCE that
1344 // is loop-carried to the USE in next iteration. This will help pipeliner avoid
1345 // additional copies that are needed across iterations. An artificial dependence
1346 // edge is added from USE to SOURCE of COPY/REG_SEQUENCE.
1347 
1348 // PHI-------Anti-Dep-----> COPY/REG_SEQUENCE (loop-carried)
1349 // SRCOfCopY------True-Dep---> COPY/REG_SEQUENCE
1350 // PHI-------True-Dep------> USEOfPhi
1351 
1352 // The mutation creates
1353 // USEOfPHI -------Artificial-Dep---> SRCOfCopy
1354 
1355 // This overall will ensure, the USEOfPHI is scheduled before SRCOfCopy
1356 // (since USE is a predecessor), implies, the COPY/ REG_SEQUENCE is scheduled
1357 // late  to avoid additional copies across iterations. The possible scheduling
1358 // order would be
1359 // USEOfPHI --- SRCOfCopy---  COPY/REG_SEQUENCE.
1360 
1361 void SwingSchedulerDAG::CopyToPhiMutation::apply(ScheduleDAGInstrs *DAG) {
1362   for (SUnit &SU : DAG->SUnits) {
1363     // Find the COPY/REG_SEQUENCE instruction.
1364     if (!SU.getInstr()->isCopy() && !SU.getInstr()->isRegSequence())
1365       continue;
1366 
1367     // Record the loop carried PHIs.
1368     SmallVector<SUnit *, 4> PHISUs;
1369     // Record the SrcSUs that feed the COPY/REG_SEQUENCE instructions.
1370     SmallVector<SUnit *, 4> SrcSUs;
1371 
1372     for (auto &Dep : SU.Preds) {
1373       SUnit *TmpSU = Dep.getSUnit();
1374       MachineInstr *TmpMI = TmpSU->getInstr();
1375       SDep::Kind DepKind = Dep.getKind();
1376       // Save the loop carried PHI.
1377       if (DepKind == SDep::Anti && TmpMI->isPHI())
1378         PHISUs.push_back(TmpSU);
1379       // Save the source of COPY/REG_SEQUENCE.
1380       // If the source has no pre-decessors, we will end up creating cycles.
1381       else if (DepKind == SDep::Data && !TmpMI->isPHI() && TmpSU->NumPreds > 0)
1382         SrcSUs.push_back(TmpSU);
1383     }
1384 
1385     if (PHISUs.size() == 0 || SrcSUs.size() == 0)
1386       continue;
1387 
1388     // Find the USEs of PHI. If the use is a PHI or REG_SEQUENCE, push back this
1389     // SUnit to the container.
1390     SmallVector<SUnit *, 8> UseSUs;
1391     // Do not use iterator based loop here as we are updating the container.
1392     for (size_t Index = 0; Index < PHISUs.size(); ++Index) {
1393       for (auto &Dep : PHISUs[Index]->Succs) {
1394         if (Dep.getKind() != SDep::Data)
1395           continue;
1396 
1397         SUnit *TmpSU = Dep.getSUnit();
1398         MachineInstr *TmpMI = TmpSU->getInstr();
1399         if (TmpMI->isPHI() || TmpMI->isRegSequence()) {
1400           PHISUs.push_back(TmpSU);
1401           continue;
1402         }
1403         UseSUs.push_back(TmpSU);
1404       }
1405     }
1406 
1407     if (UseSUs.size() == 0)
1408       continue;
1409 
1410     SwingSchedulerDAG *SDAG = cast<SwingSchedulerDAG>(DAG);
1411     // Add the artificial dependencies if it does not form a cycle.
1412     for (auto I : UseSUs) {
1413       for (auto Src : SrcSUs) {
1414         if (!SDAG->Topo.IsReachable(I, Src) && Src != I) {
1415           Src->addPred(SDep(I, SDep::Artificial));
1416           SDAG->Topo.AddPred(Src, I);
1417         }
1418       }
1419     }
1420   }
1421 }
1422 
1423 /// Return true for DAG nodes that we ignore when computing the cost functions.
1424 /// We ignore the back-edge recurrence in order to avoid unbounded recursion
1425 /// in the calculation of the ASAP, ALAP, etc functions.
1426 static bool ignoreDependence(const SDep &D, bool isPred) {
1427   if (D.isArtificial())
1428     return true;
1429   return D.getKind() == SDep::Anti && isPred;
1430 }
1431 
1432 /// Compute several functions need to order the nodes for scheduling.
1433 ///  ASAP - Earliest time to schedule a node.
1434 ///  ALAP - Latest time to schedule a node.
1435 ///  MOV - Mobility function, difference between ALAP and ASAP.
1436 ///  D - Depth of each node.
1437 ///  H - Height of each node.
1438 void SwingSchedulerDAG::computeNodeFunctions(NodeSetType &NodeSets) {
1439   ScheduleInfo.resize(SUnits.size());
1440 
1441   LLVM_DEBUG({
1442     for (int I : Topo) {
1443       const SUnit &SU = SUnits[I];
1444       dumpNode(SU);
1445     }
1446   });
1447 
1448   int maxASAP = 0;
1449   // Compute ASAP and ZeroLatencyDepth.
1450   for (int I : Topo) {
1451     int asap = 0;
1452     int zeroLatencyDepth = 0;
1453     SUnit *SU = &SUnits[I];
1454     for (const SDep &P : SU->Preds) {
1455       SUnit *pred = P.getSUnit();
1456       if (P.getLatency() == 0)
1457         zeroLatencyDepth =
1458             std::max(zeroLatencyDepth, getZeroLatencyDepth(pred) + 1);
1459       if (ignoreDependence(P, true))
1460         continue;
1461       asap = std::max(asap, (int)(getASAP(pred) + P.getLatency() -
1462                                   getDistance(pred, SU, P) * MII));
1463     }
1464     maxASAP = std::max(maxASAP, asap);
1465     ScheduleInfo[I].ASAP = asap;
1466     ScheduleInfo[I].ZeroLatencyDepth = zeroLatencyDepth;
1467   }
1468 
1469   // Compute ALAP, ZeroLatencyHeight, and MOV.
1470   for (int I : llvm::reverse(Topo)) {
1471     int alap = maxASAP;
1472     int zeroLatencyHeight = 0;
1473     SUnit *SU = &SUnits[I];
1474     for (const SDep &S : SU->Succs) {
1475       SUnit *succ = S.getSUnit();
1476       if (S.getLatency() == 0)
1477         zeroLatencyHeight =
1478             std::max(zeroLatencyHeight, getZeroLatencyHeight(succ) + 1);
1479       if (ignoreDependence(S, true))
1480         continue;
1481       alap = std::min(alap, (int)(getALAP(succ) - S.getLatency() +
1482                                   getDistance(SU, succ, S) * MII));
1483     }
1484 
1485     ScheduleInfo[I].ALAP = alap;
1486     ScheduleInfo[I].ZeroLatencyHeight = zeroLatencyHeight;
1487   }
1488 
1489   // After computing the node functions, compute the summary for each node set.
1490   for (NodeSet &I : NodeSets)
1491     I.computeNodeSetInfo(this);
1492 
1493   LLVM_DEBUG({
1494     for (unsigned i = 0; i < SUnits.size(); i++) {
1495       dbgs() << "\tNode " << i << ":\n";
1496       dbgs() << "\t   ASAP = " << getASAP(&SUnits[i]) << "\n";
1497       dbgs() << "\t   ALAP = " << getALAP(&SUnits[i]) << "\n";
1498       dbgs() << "\t   MOV  = " << getMOV(&SUnits[i]) << "\n";
1499       dbgs() << "\t   D    = " << getDepth(&SUnits[i]) << "\n";
1500       dbgs() << "\t   H    = " << getHeight(&SUnits[i]) << "\n";
1501       dbgs() << "\t   ZLD  = " << getZeroLatencyDepth(&SUnits[i]) << "\n";
1502       dbgs() << "\t   ZLH  = " << getZeroLatencyHeight(&SUnits[i]) << "\n";
1503     }
1504   });
1505 }
1506 
1507 /// Compute the Pred_L(O) set, as defined in the paper. The set is defined
1508 /// as the predecessors of the elements of NodeOrder that are not also in
1509 /// NodeOrder.
1510 static bool pred_L(SetVector<SUnit *> &NodeOrder,
1511                    SmallSetVector<SUnit *, 8> &Preds,
1512                    const NodeSet *S = nullptr) {
1513   Preds.clear();
1514   for (const SUnit *SU : NodeOrder) {
1515     for (const SDep &Pred : SU->Preds) {
1516       if (S && S->count(Pred.getSUnit()) == 0)
1517         continue;
1518       if (ignoreDependence(Pred, true))
1519         continue;
1520       if (NodeOrder.count(Pred.getSUnit()) == 0)
1521         Preds.insert(Pred.getSUnit());
1522     }
1523     // Back-edges are predecessors with an anti-dependence.
1524     for (const SDep &Succ : SU->Succs) {
1525       if (Succ.getKind() != SDep::Anti)
1526         continue;
1527       if (S && S->count(Succ.getSUnit()) == 0)
1528         continue;
1529       if (NodeOrder.count(Succ.getSUnit()) == 0)
1530         Preds.insert(Succ.getSUnit());
1531     }
1532   }
1533   return !Preds.empty();
1534 }
1535 
1536 /// Compute the Succ_L(O) set, as defined in the paper. The set is defined
1537 /// as the successors of the elements of NodeOrder that are not also in
1538 /// NodeOrder.
1539 static bool succ_L(SetVector<SUnit *> &NodeOrder,
1540                    SmallSetVector<SUnit *, 8> &Succs,
1541                    const NodeSet *S = nullptr) {
1542   Succs.clear();
1543   for (const SUnit *SU : NodeOrder) {
1544     for (const SDep &Succ : SU->Succs) {
1545       if (S && S->count(Succ.getSUnit()) == 0)
1546         continue;
1547       if (ignoreDependence(Succ, false))
1548         continue;
1549       if (NodeOrder.count(Succ.getSUnit()) == 0)
1550         Succs.insert(Succ.getSUnit());
1551     }
1552     for (const SDep &Pred : SU->Preds) {
1553       if (Pred.getKind() != SDep::Anti)
1554         continue;
1555       if (S && S->count(Pred.getSUnit()) == 0)
1556         continue;
1557       if (NodeOrder.count(Pred.getSUnit()) == 0)
1558         Succs.insert(Pred.getSUnit());
1559     }
1560   }
1561   return !Succs.empty();
1562 }
1563 
1564 /// Return true if there is a path from the specified node to any of the nodes
1565 /// in DestNodes. Keep track and return the nodes in any path.
1566 static bool computePath(SUnit *Cur, SetVector<SUnit *> &Path,
1567                         SetVector<SUnit *> &DestNodes,
1568                         SetVector<SUnit *> &Exclude,
1569                         SmallPtrSet<SUnit *, 8> &Visited) {
1570   if (Cur->isBoundaryNode())
1571     return false;
1572   if (Exclude.contains(Cur))
1573     return false;
1574   if (DestNodes.contains(Cur))
1575     return true;
1576   if (!Visited.insert(Cur).second)
1577     return Path.contains(Cur);
1578   bool FoundPath = false;
1579   for (auto &SI : Cur->Succs)
1580     FoundPath |= computePath(SI.getSUnit(), Path, DestNodes, Exclude, Visited);
1581   for (auto &PI : Cur->Preds)
1582     if (PI.getKind() == SDep::Anti)
1583       FoundPath |=
1584           computePath(PI.getSUnit(), Path, DestNodes, Exclude, Visited);
1585   if (FoundPath)
1586     Path.insert(Cur);
1587   return FoundPath;
1588 }
1589 
1590 /// Compute the live-out registers for the instructions in a node-set.
1591 /// The live-out registers are those that are defined in the node-set,
1592 /// but not used. Except for use operands of Phis.
1593 static void computeLiveOuts(MachineFunction &MF, RegPressureTracker &RPTracker,
1594                             NodeSet &NS) {
1595   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
1596   MachineRegisterInfo &MRI = MF.getRegInfo();
1597   SmallVector<RegisterMaskPair, 8> LiveOutRegs;
1598   SmallSet<unsigned, 4> Uses;
1599   for (SUnit *SU : NS) {
1600     const MachineInstr *MI = SU->getInstr();
1601     if (MI->isPHI())
1602       continue;
1603     for (const MachineOperand &MO : MI->operands())
1604       if (MO.isReg() && MO.isUse()) {
1605         Register Reg = MO.getReg();
1606         if (Register::isVirtualRegister(Reg))
1607           Uses.insert(Reg);
1608         else if (MRI.isAllocatable(Reg))
1609           for (MCRegUnitIterator Units(Reg.asMCReg(), TRI); Units.isValid();
1610                ++Units)
1611             Uses.insert(*Units);
1612       }
1613   }
1614   for (SUnit *SU : NS)
1615     for (const MachineOperand &MO : SU->getInstr()->operands())
1616       if (MO.isReg() && MO.isDef() && !MO.isDead()) {
1617         Register Reg = MO.getReg();
1618         if (Register::isVirtualRegister(Reg)) {
1619           if (!Uses.count(Reg))
1620             LiveOutRegs.push_back(RegisterMaskPair(Reg,
1621                                                    LaneBitmask::getNone()));
1622         } else if (MRI.isAllocatable(Reg)) {
1623           for (MCRegUnitIterator Units(Reg.asMCReg(), TRI); Units.isValid();
1624                ++Units)
1625             if (!Uses.count(*Units))
1626               LiveOutRegs.push_back(RegisterMaskPair(*Units,
1627                                                      LaneBitmask::getNone()));
1628         }
1629       }
1630   RPTracker.addLiveRegs(LiveOutRegs);
1631 }
1632 
1633 /// A heuristic to filter nodes in recurrent node-sets if the register
1634 /// pressure of a set is too high.
1635 void SwingSchedulerDAG::registerPressureFilter(NodeSetType &NodeSets) {
1636   for (auto &NS : NodeSets) {
1637     // Skip small node-sets since they won't cause register pressure problems.
1638     if (NS.size() <= 2)
1639       continue;
1640     IntervalPressure RecRegPressure;
1641     RegPressureTracker RecRPTracker(RecRegPressure);
1642     RecRPTracker.init(&MF, &RegClassInfo, &LIS, BB, BB->end(), false, true);
1643     computeLiveOuts(MF, RecRPTracker, NS);
1644     RecRPTracker.closeBottom();
1645 
1646     std::vector<SUnit *> SUnits(NS.begin(), NS.end());
1647     llvm::sort(SUnits, [](const SUnit *A, const SUnit *B) {
1648       return A->NodeNum > B->NodeNum;
1649     });
1650 
1651     for (auto &SU : SUnits) {
1652       // Since we're computing the register pressure for a subset of the
1653       // instructions in a block, we need to set the tracker for each
1654       // instruction in the node-set. The tracker is set to the instruction
1655       // just after the one we're interested in.
1656       MachineBasicBlock::const_iterator CurInstI = SU->getInstr();
1657       RecRPTracker.setPos(std::next(CurInstI));
1658 
1659       RegPressureDelta RPDelta;
1660       ArrayRef<PressureChange> CriticalPSets;
1661       RecRPTracker.getMaxUpwardPressureDelta(SU->getInstr(), nullptr, RPDelta,
1662                                              CriticalPSets,
1663                                              RecRegPressure.MaxSetPressure);
1664       if (RPDelta.Excess.isValid()) {
1665         LLVM_DEBUG(
1666             dbgs() << "Excess register pressure: SU(" << SU->NodeNum << ") "
1667                    << TRI->getRegPressureSetName(RPDelta.Excess.getPSet())
1668                    << ":" << RPDelta.Excess.getUnitInc());
1669         NS.setExceedPressure(SU);
1670         break;
1671       }
1672       RecRPTracker.recede();
1673     }
1674   }
1675 }
1676 
1677 /// A heuristic to colocate node sets that have the same set of
1678 /// successors.
1679 void SwingSchedulerDAG::colocateNodeSets(NodeSetType &NodeSets) {
1680   unsigned Colocate = 0;
1681   for (int i = 0, e = NodeSets.size(); i < e; ++i) {
1682     NodeSet &N1 = NodeSets[i];
1683     SmallSetVector<SUnit *, 8> S1;
1684     if (N1.empty() || !succ_L(N1, S1))
1685       continue;
1686     for (int j = i + 1; j < e; ++j) {
1687       NodeSet &N2 = NodeSets[j];
1688       if (N1.compareRecMII(N2) != 0)
1689         continue;
1690       SmallSetVector<SUnit *, 8> S2;
1691       if (N2.empty() || !succ_L(N2, S2))
1692         continue;
1693       if (llvm::set_is_subset(S1, S2) && S1.size() == S2.size()) {
1694         N1.setColocate(++Colocate);
1695         N2.setColocate(Colocate);
1696         break;
1697       }
1698     }
1699   }
1700 }
1701 
1702 /// Check if the existing node-sets are profitable. If not, then ignore the
1703 /// recurrent node-sets, and attempt to schedule all nodes together. This is
1704 /// a heuristic. If the MII is large and all the recurrent node-sets are small,
1705 /// then it's best to try to schedule all instructions together instead of
1706 /// starting with the recurrent node-sets.
1707 void SwingSchedulerDAG::checkNodeSets(NodeSetType &NodeSets) {
1708   // Look for loops with a large MII.
1709   if (MII < 17)
1710     return;
1711   // Check if the node-set contains only a simple add recurrence.
1712   for (auto &NS : NodeSets) {
1713     if (NS.getRecMII() > 2)
1714       return;
1715     if (NS.getMaxDepth() > MII)
1716       return;
1717   }
1718   NodeSets.clear();
1719   LLVM_DEBUG(dbgs() << "Clear recurrence node-sets\n");
1720 }
1721 
1722 /// Add the nodes that do not belong to a recurrence set into groups
1723 /// based upon connected componenets.
1724 void SwingSchedulerDAG::groupRemainingNodes(NodeSetType &NodeSets) {
1725   SetVector<SUnit *> NodesAdded;
1726   SmallPtrSet<SUnit *, 8> Visited;
1727   // Add the nodes that are on a path between the previous node sets and
1728   // the current node set.
1729   for (NodeSet &I : NodeSets) {
1730     SmallSetVector<SUnit *, 8> N;
1731     // Add the nodes from the current node set to the previous node set.
1732     if (succ_L(I, N)) {
1733       SetVector<SUnit *> Path;
1734       for (SUnit *NI : N) {
1735         Visited.clear();
1736         computePath(NI, Path, NodesAdded, I, Visited);
1737       }
1738       if (!Path.empty())
1739         I.insert(Path.begin(), Path.end());
1740     }
1741     // Add the nodes from the previous node set to the current node set.
1742     N.clear();
1743     if (succ_L(NodesAdded, N)) {
1744       SetVector<SUnit *> Path;
1745       for (SUnit *NI : N) {
1746         Visited.clear();
1747         computePath(NI, Path, I, NodesAdded, Visited);
1748       }
1749       if (!Path.empty())
1750         I.insert(Path.begin(), Path.end());
1751     }
1752     NodesAdded.insert(I.begin(), I.end());
1753   }
1754 
1755   // Create a new node set with the connected nodes of any successor of a node
1756   // in a recurrent set.
1757   NodeSet NewSet;
1758   SmallSetVector<SUnit *, 8> N;
1759   if (succ_L(NodesAdded, N))
1760     for (SUnit *I : N)
1761       addConnectedNodes(I, NewSet, NodesAdded);
1762   if (!NewSet.empty())
1763     NodeSets.push_back(NewSet);
1764 
1765   // Create a new node set with the connected nodes of any predecessor of a node
1766   // in a recurrent set.
1767   NewSet.clear();
1768   if (pred_L(NodesAdded, N))
1769     for (SUnit *I : N)
1770       addConnectedNodes(I, NewSet, NodesAdded);
1771   if (!NewSet.empty())
1772     NodeSets.push_back(NewSet);
1773 
1774   // Create new nodes sets with the connected nodes any remaining node that
1775   // has no predecessor.
1776   for (SUnit &SU : SUnits) {
1777     if (NodesAdded.count(&SU) == 0) {
1778       NewSet.clear();
1779       addConnectedNodes(&SU, NewSet, NodesAdded);
1780       if (!NewSet.empty())
1781         NodeSets.push_back(NewSet);
1782     }
1783   }
1784 }
1785 
1786 /// Add the node to the set, and add all of its connected nodes to the set.
1787 void SwingSchedulerDAG::addConnectedNodes(SUnit *SU, NodeSet &NewSet,
1788                                           SetVector<SUnit *> &NodesAdded) {
1789   NewSet.insert(SU);
1790   NodesAdded.insert(SU);
1791   for (auto &SI : SU->Succs) {
1792     SUnit *Successor = SI.getSUnit();
1793     if (!SI.isArtificial() && NodesAdded.count(Successor) == 0)
1794       addConnectedNodes(Successor, NewSet, NodesAdded);
1795   }
1796   for (auto &PI : SU->Preds) {
1797     SUnit *Predecessor = PI.getSUnit();
1798     if (!PI.isArtificial() && NodesAdded.count(Predecessor) == 0)
1799       addConnectedNodes(Predecessor, NewSet, NodesAdded);
1800   }
1801 }
1802 
1803 /// Return true if Set1 contains elements in Set2. The elements in common
1804 /// are returned in a different container.
1805 static bool isIntersect(SmallSetVector<SUnit *, 8> &Set1, const NodeSet &Set2,
1806                         SmallSetVector<SUnit *, 8> &Result) {
1807   Result.clear();
1808   for (unsigned i = 0, e = Set1.size(); i != e; ++i) {
1809     SUnit *SU = Set1[i];
1810     if (Set2.count(SU) != 0)
1811       Result.insert(SU);
1812   }
1813   return !Result.empty();
1814 }
1815 
1816 /// Merge the recurrence node sets that have the same initial node.
1817 void SwingSchedulerDAG::fuseRecs(NodeSetType &NodeSets) {
1818   for (NodeSetType::iterator I = NodeSets.begin(), E = NodeSets.end(); I != E;
1819        ++I) {
1820     NodeSet &NI = *I;
1821     for (NodeSetType::iterator J = I + 1; J != E;) {
1822       NodeSet &NJ = *J;
1823       if (NI.getNode(0)->NodeNum == NJ.getNode(0)->NodeNum) {
1824         if (NJ.compareRecMII(NI) > 0)
1825           NI.setRecMII(NJ.getRecMII());
1826         for (SUnit *SU : *J)
1827           I->insert(SU);
1828         NodeSets.erase(J);
1829         E = NodeSets.end();
1830       } else {
1831         ++J;
1832       }
1833     }
1834   }
1835 }
1836 
1837 /// Remove nodes that have been scheduled in previous NodeSets.
1838 void SwingSchedulerDAG::removeDuplicateNodes(NodeSetType &NodeSets) {
1839   for (NodeSetType::iterator I = NodeSets.begin(), E = NodeSets.end(); I != E;
1840        ++I)
1841     for (NodeSetType::iterator J = I + 1; J != E;) {
1842       J->remove_if([&](SUnit *SUJ) { return I->count(SUJ); });
1843 
1844       if (J->empty()) {
1845         NodeSets.erase(J);
1846         E = NodeSets.end();
1847       } else {
1848         ++J;
1849       }
1850     }
1851 }
1852 
1853 /// Compute an ordered list of the dependence graph nodes, which
1854 /// indicates the order that the nodes will be scheduled.  This is a
1855 /// two-level algorithm. First, a partial order is created, which
1856 /// consists of a list of sets ordered from highest to lowest priority.
1857 void SwingSchedulerDAG::computeNodeOrder(NodeSetType &NodeSets) {
1858   SmallSetVector<SUnit *, 8> R;
1859   NodeOrder.clear();
1860 
1861   for (auto &Nodes : NodeSets) {
1862     LLVM_DEBUG(dbgs() << "NodeSet size " << Nodes.size() << "\n");
1863     OrderKind Order;
1864     SmallSetVector<SUnit *, 8> N;
1865     if (pred_L(NodeOrder, N) && llvm::set_is_subset(N, Nodes)) {
1866       R.insert(N.begin(), N.end());
1867       Order = BottomUp;
1868       LLVM_DEBUG(dbgs() << "  Bottom up (preds) ");
1869     } else if (succ_L(NodeOrder, N) && llvm::set_is_subset(N, Nodes)) {
1870       R.insert(N.begin(), N.end());
1871       Order = TopDown;
1872       LLVM_DEBUG(dbgs() << "  Top down (succs) ");
1873     } else if (isIntersect(N, Nodes, R)) {
1874       // If some of the successors are in the existing node-set, then use the
1875       // top-down ordering.
1876       Order = TopDown;
1877       LLVM_DEBUG(dbgs() << "  Top down (intersect) ");
1878     } else if (NodeSets.size() == 1) {
1879       for (auto &N : Nodes)
1880         if (N->Succs.size() == 0)
1881           R.insert(N);
1882       Order = BottomUp;
1883       LLVM_DEBUG(dbgs() << "  Bottom up (all) ");
1884     } else {
1885       // Find the node with the highest ASAP.
1886       SUnit *maxASAP = nullptr;
1887       for (SUnit *SU : Nodes) {
1888         if (maxASAP == nullptr || getASAP(SU) > getASAP(maxASAP) ||
1889             (getASAP(SU) == getASAP(maxASAP) && SU->NodeNum > maxASAP->NodeNum))
1890           maxASAP = SU;
1891       }
1892       R.insert(maxASAP);
1893       Order = BottomUp;
1894       LLVM_DEBUG(dbgs() << "  Bottom up (default) ");
1895     }
1896 
1897     while (!R.empty()) {
1898       if (Order == TopDown) {
1899         // Choose the node with the maximum height.  If more than one, choose
1900         // the node wiTH the maximum ZeroLatencyHeight. If still more than one,
1901         // choose the node with the lowest MOV.
1902         while (!R.empty()) {
1903           SUnit *maxHeight = nullptr;
1904           for (SUnit *I : R) {
1905             if (maxHeight == nullptr || getHeight(I) > getHeight(maxHeight))
1906               maxHeight = I;
1907             else if (getHeight(I) == getHeight(maxHeight) &&
1908                      getZeroLatencyHeight(I) > getZeroLatencyHeight(maxHeight))
1909               maxHeight = I;
1910             else if (getHeight(I) == getHeight(maxHeight) &&
1911                      getZeroLatencyHeight(I) ==
1912                          getZeroLatencyHeight(maxHeight) &&
1913                      getMOV(I) < getMOV(maxHeight))
1914               maxHeight = I;
1915           }
1916           NodeOrder.insert(maxHeight);
1917           LLVM_DEBUG(dbgs() << maxHeight->NodeNum << " ");
1918           R.remove(maxHeight);
1919           for (const auto &I : maxHeight->Succs) {
1920             if (Nodes.count(I.getSUnit()) == 0)
1921               continue;
1922             if (NodeOrder.contains(I.getSUnit()))
1923               continue;
1924             if (ignoreDependence(I, false))
1925               continue;
1926             R.insert(I.getSUnit());
1927           }
1928           // Back-edges are predecessors with an anti-dependence.
1929           for (const auto &I : maxHeight->Preds) {
1930             if (I.getKind() != SDep::Anti)
1931               continue;
1932             if (Nodes.count(I.getSUnit()) == 0)
1933               continue;
1934             if (NodeOrder.contains(I.getSUnit()))
1935               continue;
1936             R.insert(I.getSUnit());
1937           }
1938         }
1939         Order = BottomUp;
1940         LLVM_DEBUG(dbgs() << "\n   Switching order to bottom up ");
1941         SmallSetVector<SUnit *, 8> N;
1942         if (pred_L(NodeOrder, N, &Nodes))
1943           R.insert(N.begin(), N.end());
1944       } else {
1945         // Choose the node with the maximum depth.  If more than one, choose
1946         // the node with the maximum ZeroLatencyDepth. If still more than one,
1947         // choose the node with the lowest MOV.
1948         while (!R.empty()) {
1949           SUnit *maxDepth = nullptr;
1950           for (SUnit *I : R) {
1951             if (maxDepth == nullptr || getDepth(I) > getDepth(maxDepth))
1952               maxDepth = I;
1953             else if (getDepth(I) == getDepth(maxDepth) &&
1954                      getZeroLatencyDepth(I) > getZeroLatencyDepth(maxDepth))
1955               maxDepth = I;
1956             else if (getDepth(I) == getDepth(maxDepth) &&
1957                      getZeroLatencyDepth(I) == getZeroLatencyDepth(maxDepth) &&
1958                      getMOV(I) < getMOV(maxDepth))
1959               maxDepth = I;
1960           }
1961           NodeOrder.insert(maxDepth);
1962           LLVM_DEBUG(dbgs() << maxDepth->NodeNum << " ");
1963           R.remove(maxDepth);
1964           if (Nodes.isExceedSU(maxDepth)) {
1965             Order = TopDown;
1966             R.clear();
1967             R.insert(Nodes.getNode(0));
1968             break;
1969           }
1970           for (const auto &I : maxDepth->Preds) {
1971             if (Nodes.count(I.getSUnit()) == 0)
1972               continue;
1973             if (NodeOrder.contains(I.getSUnit()))
1974               continue;
1975             R.insert(I.getSUnit());
1976           }
1977           // Back-edges are predecessors with an anti-dependence.
1978           for (const auto &I : maxDepth->Succs) {
1979             if (I.getKind() != SDep::Anti)
1980               continue;
1981             if (Nodes.count(I.getSUnit()) == 0)
1982               continue;
1983             if (NodeOrder.contains(I.getSUnit()))
1984               continue;
1985             R.insert(I.getSUnit());
1986           }
1987         }
1988         Order = TopDown;
1989         LLVM_DEBUG(dbgs() << "\n   Switching order to top down ");
1990         SmallSetVector<SUnit *, 8> N;
1991         if (succ_L(NodeOrder, N, &Nodes))
1992           R.insert(N.begin(), N.end());
1993       }
1994     }
1995     LLVM_DEBUG(dbgs() << "\nDone with Nodeset\n");
1996   }
1997 
1998   LLVM_DEBUG({
1999     dbgs() << "Node order: ";
2000     for (SUnit *I : NodeOrder)
2001       dbgs() << " " << I->NodeNum << " ";
2002     dbgs() << "\n";
2003   });
2004 }
2005 
2006 /// Process the nodes in the computed order and create the pipelined schedule
2007 /// of the instructions, if possible. Return true if a schedule is found.
2008 bool SwingSchedulerDAG::schedulePipeline(SMSchedule &Schedule) {
2009 
2010   if (NodeOrder.empty()){
2011     LLVM_DEBUG(dbgs() << "NodeOrder is empty! abort scheduling\n" );
2012     return false;
2013   }
2014 
2015   bool scheduleFound = false;
2016   // Keep increasing II until a valid schedule is found.
2017   for (unsigned II = MII; II <= MAX_II && !scheduleFound; ++II) {
2018     Schedule.reset();
2019     Schedule.setInitiationInterval(II);
2020     LLVM_DEBUG(dbgs() << "Try to schedule with " << II << "\n");
2021 
2022     SetVector<SUnit *>::iterator NI = NodeOrder.begin();
2023     SetVector<SUnit *>::iterator NE = NodeOrder.end();
2024     do {
2025       SUnit *SU = *NI;
2026 
2027       // Compute the schedule time for the instruction, which is based
2028       // upon the scheduled time for any predecessors/successors.
2029       int EarlyStart = INT_MIN;
2030       int LateStart = INT_MAX;
2031       // These values are set when the size of the schedule window is limited
2032       // due to chain dependences.
2033       int SchedEnd = INT_MAX;
2034       int SchedStart = INT_MIN;
2035       Schedule.computeStart(SU, &EarlyStart, &LateStart, &SchedEnd, &SchedStart,
2036                             II, this);
2037       LLVM_DEBUG({
2038         dbgs() << "\n";
2039         dbgs() << "Inst (" << SU->NodeNum << ") ";
2040         SU->getInstr()->dump();
2041         dbgs() << "\n";
2042       });
2043       LLVM_DEBUG({
2044         dbgs() << format("\tes: %8x ls: %8x me: %8x ms: %8x\n", EarlyStart,
2045                          LateStart, SchedEnd, SchedStart);
2046       });
2047 
2048       if (EarlyStart > LateStart || SchedEnd < EarlyStart ||
2049           SchedStart > LateStart)
2050         scheduleFound = false;
2051       else if (EarlyStart != INT_MIN && LateStart == INT_MAX) {
2052         SchedEnd = std::min(SchedEnd, EarlyStart + (int)II - 1);
2053         scheduleFound = Schedule.insert(SU, EarlyStart, SchedEnd, II);
2054       } else if (EarlyStart == INT_MIN && LateStart != INT_MAX) {
2055         SchedStart = std::max(SchedStart, LateStart - (int)II + 1);
2056         scheduleFound = Schedule.insert(SU, LateStart, SchedStart, II);
2057       } else if (EarlyStart != INT_MIN && LateStart != INT_MAX) {
2058         SchedEnd =
2059             std::min(SchedEnd, std::min(LateStart, EarlyStart + (int)II - 1));
2060         // When scheduling a Phi it is better to start at the late cycle and go
2061         // backwards. The default order may insert the Phi too far away from
2062         // its first dependence.
2063         if (SU->getInstr()->isPHI())
2064           scheduleFound = Schedule.insert(SU, SchedEnd, EarlyStart, II);
2065         else
2066           scheduleFound = Schedule.insert(SU, EarlyStart, SchedEnd, II);
2067       } else {
2068         int FirstCycle = Schedule.getFirstCycle();
2069         scheduleFound = Schedule.insert(SU, FirstCycle + getASAP(SU),
2070                                         FirstCycle + getASAP(SU) + II - 1, II);
2071       }
2072       // Even if we find a schedule, make sure the schedule doesn't exceed the
2073       // allowable number of stages. We keep trying if this happens.
2074       if (scheduleFound)
2075         if (SwpMaxStages > -1 &&
2076             Schedule.getMaxStageCount() > (unsigned)SwpMaxStages)
2077           scheduleFound = false;
2078 
2079       LLVM_DEBUG({
2080         if (!scheduleFound)
2081           dbgs() << "\tCan't schedule\n";
2082       });
2083     } while (++NI != NE && scheduleFound);
2084 
2085     // If a schedule is found, check if it is a valid schedule too.
2086     if (scheduleFound)
2087       scheduleFound = Schedule.isValidSchedule(this);
2088   }
2089 
2090   LLVM_DEBUG(dbgs() << "Schedule Found? " << scheduleFound
2091                     << " (II=" << Schedule.getInitiationInterval()
2092                     << ")\n");
2093 
2094   if (scheduleFound) {
2095     Schedule.finalizeSchedule(this);
2096     Pass.ORE->emit([&]() {
2097       return MachineOptimizationRemarkAnalysis(
2098                  DEBUG_TYPE, "schedule", Loop.getStartLoc(), Loop.getHeader())
2099              << "Schedule found with Initiation Interval: "
2100              << ore::NV("II", Schedule.getInitiationInterval())
2101              << ", MaxStageCount: "
2102              << ore::NV("MaxStageCount", Schedule.getMaxStageCount());
2103     });
2104   } else
2105     Schedule.reset();
2106 
2107   return scheduleFound && Schedule.getMaxStageCount() > 0;
2108 }
2109 
2110 /// Return true if we can compute the amount the instruction changes
2111 /// during each iteration. Set Delta to the amount of the change.
2112 bool SwingSchedulerDAG::computeDelta(MachineInstr &MI, unsigned &Delta) {
2113   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
2114   const MachineOperand *BaseOp;
2115   int64_t Offset;
2116   bool OffsetIsScalable;
2117   if (!TII->getMemOperandWithOffset(MI, BaseOp, Offset, OffsetIsScalable, TRI))
2118     return false;
2119 
2120   // FIXME: This algorithm assumes instructions have fixed-size offsets.
2121   if (OffsetIsScalable)
2122     return false;
2123 
2124   if (!BaseOp->isReg())
2125     return false;
2126 
2127   Register BaseReg = BaseOp->getReg();
2128 
2129   MachineRegisterInfo &MRI = MF.getRegInfo();
2130   // Check if there is a Phi. If so, get the definition in the loop.
2131   MachineInstr *BaseDef = MRI.getVRegDef(BaseReg);
2132   if (BaseDef && BaseDef->isPHI()) {
2133     BaseReg = getLoopPhiReg(*BaseDef, MI.getParent());
2134     BaseDef = MRI.getVRegDef(BaseReg);
2135   }
2136   if (!BaseDef)
2137     return false;
2138 
2139   int D = 0;
2140   if (!TII->getIncrementValue(*BaseDef, D) && D >= 0)
2141     return false;
2142 
2143   Delta = D;
2144   return true;
2145 }
2146 
2147 /// Check if we can change the instruction to use an offset value from the
2148 /// previous iteration. If so, return true and set the base and offset values
2149 /// so that we can rewrite the load, if necessary.
2150 ///   v1 = Phi(v0, v3)
2151 ///   v2 = load v1, 0
2152 ///   v3 = post_store v1, 4, x
2153 /// This function enables the load to be rewritten as v2 = load v3, 4.
2154 bool SwingSchedulerDAG::canUseLastOffsetValue(MachineInstr *MI,
2155                                               unsigned &BasePos,
2156                                               unsigned &OffsetPos,
2157                                               unsigned &NewBase,
2158                                               int64_t &Offset) {
2159   // Get the load instruction.
2160   if (TII->isPostIncrement(*MI))
2161     return false;
2162   unsigned BasePosLd, OffsetPosLd;
2163   if (!TII->getBaseAndOffsetPosition(*MI, BasePosLd, OffsetPosLd))
2164     return false;
2165   Register BaseReg = MI->getOperand(BasePosLd).getReg();
2166 
2167   // Look for the Phi instruction.
2168   MachineRegisterInfo &MRI = MI->getMF()->getRegInfo();
2169   MachineInstr *Phi = MRI.getVRegDef(BaseReg);
2170   if (!Phi || !Phi->isPHI())
2171     return false;
2172   // Get the register defined in the loop block.
2173   unsigned PrevReg = getLoopPhiReg(*Phi, MI->getParent());
2174   if (!PrevReg)
2175     return false;
2176 
2177   // Check for the post-increment load/store instruction.
2178   MachineInstr *PrevDef = MRI.getVRegDef(PrevReg);
2179   if (!PrevDef || PrevDef == MI)
2180     return false;
2181 
2182   if (!TII->isPostIncrement(*PrevDef))
2183     return false;
2184 
2185   unsigned BasePos1 = 0, OffsetPos1 = 0;
2186   if (!TII->getBaseAndOffsetPosition(*PrevDef, BasePos1, OffsetPos1))
2187     return false;
2188 
2189   // Make sure that the instructions do not access the same memory location in
2190   // the next iteration.
2191   int64_t LoadOffset = MI->getOperand(OffsetPosLd).getImm();
2192   int64_t StoreOffset = PrevDef->getOperand(OffsetPos1).getImm();
2193   MachineInstr *NewMI = MF.CloneMachineInstr(MI);
2194   NewMI->getOperand(OffsetPosLd).setImm(LoadOffset + StoreOffset);
2195   bool Disjoint = TII->areMemAccessesTriviallyDisjoint(*NewMI, *PrevDef);
2196   MF.DeleteMachineInstr(NewMI);
2197   if (!Disjoint)
2198     return false;
2199 
2200   // Set the return value once we determine that we return true.
2201   BasePos = BasePosLd;
2202   OffsetPos = OffsetPosLd;
2203   NewBase = PrevReg;
2204   Offset = StoreOffset;
2205   return true;
2206 }
2207 
2208 /// Apply changes to the instruction if needed. The changes are need
2209 /// to improve the scheduling and depend up on the final schedule.
2210 void SwingSchedulerDAG::applyInstrChange(MachineInstr *MI,
2211                                          SMSchedule &Schedule) {
2212   SUnit *SU = getSUnit(MI);
2213   DenseMap<SUnit *, std::pair<unsigned, int64_t>>::iterator It =
2214       InstrChanges.find(SU);
2215   if (It != InstrChanges.end()) {
2216     std::pair<unsigned, int64_t> RegAndOffset = It->second;
2217     unsigned BasePos, OffsetPos;
2218     if (!TII->getBaseAndOffsetPosition(*MI, BasePos, OffsetPos))
2219       return;
2220     Register BaseReg = MI->getOperand(BasePos).getReg();
2221     MachineInstr *LoopDef = findDefInLoop(BaseReg);
2222     int DefStageNum = Schedule.stageScheduled(getSUnit(LoopDef));
2223     int DefCycleNum = Schedule.cycleScheduled(getSUnit(LoopDef));
2224     int BaseStageNum = Schedule.stageScheduled(SU);
2225     int BaseCycleNum = Schedule.cycleScheduled(SU);
2226     if (BaseStageNum < DefStageNum) {
2227       MachineInstr *NewMI = MF.CloneMachineInstr(MI);
2228       int OffsetDiff = DefStageNum - BaseStageNum;
2229       if (DefCycleNum < BaseCycleNum) {
2230         NewMI->getOperand(BasePos).setReg(RegAndOffset.first);
2231         if (OffsetDiff > 0)
2232           --OffsetDiff;
2233       }
2234       int64_t NewOffset =
2235           MI->getOperand(OffsetPos).getImm() + RegAndOffset.second * OffsetDiff;
2236       NewMI->getOperand(OffsetPos).setImm(NewOffset);
2237       SU->setInstr(NewMI);
2238       MISUnitMap[NewMI] = SU;
2239       NewMIs[MI] = NewMI;
2240     }
2241   }
2242 }
2243 
2244 /// Return the instruction in the loop that defines the register.
2245 /// If the definition is a Phi, then follow the Phi operand to
2246 /// the instruction in the loop.
2247 MachineInstr *SwingSchedulerDAG::findDefInLoop(Register Reg) {
2248   SmallPtrSet<MachineInstr *, 8> Visited;
2249   MachineInstr *Def = MRI.getVRegDef(Reg);
2250   while (Def->isPHI()) {
2251     if (!Visited.insert(Def).second)
2252       break;
2253     for (unsigned i = 1, e = Def->getNumOperands(); i < e; i += 2)
2254       if (Def->getOperand(i + 1).getMBB() == BB) {
2255         Def = MRI.getVRegDef(Def->getOperand(i).getReg());
2256         break;
2257       }
2258   }
2259   return Def;
2260 }
2261 
2262 /// Return true for an order or output dependence that is loop carried
2263 /// potentially. A dependence is loop carried if the destination defines a valu
2264 /// that may be used or defined by the source in a subsequent iteration.
2265 bool SwingSchedulerDAG::isLoopCarriedDep(SUnit *Source, const SDep &Dep,
2266                                          bool isSucc) {
2267   if ((Dep.getKind() != SDep::Order && Dep.getKind() != SDep::Output) ||
2268       Dep.isArtificial())
2269     return false;
2270 
2271   if (!SwpPruneLoopCarried)
2272     return true;
2273 
2274   if (Dep.getKind() == SDep::Output)
2275     return true;
2276 
2277   MachineInstr *SI = Source->getInstr();
2278   MachineInstr *DI = Dep.getSUnit()->getInstr();
2279   if (!isSucc)
2280     std::swap(SI, DI);
2281   assert(SI != nullptr && DI != nullptr && "Expecting SUnit with an MI.");
2282 
2283   // Assume ordered loads and stores may have a loop carried dependence.
2284   if (SI->hasUnmodeledSideEffects() || DI->hasUnmodeledSideEffects() ||
2285       SI->mayRaiseFPException() || DI->mayRaiseFPException() ||
2286       SI->hasOrderedMemoryRef() || DI->hasOrderedMemoryRef())
2287     return true;
2288 
2289   // Only chain dependences between a load and store can be loop carried.
2290   if (!DI->mayStore() || !SI->mayLoad())
2291     return false;
2292 
2293   unsigned DeltaS, DeltaD;
2294   if (!computeDelta(*SI, DeltaS) || !computeDelta(*DI, DeltaD))
2295     return true;
2296 
2297   const MachineOperand *BaseOpS, *BaseOpD;
2298   int64_t OffsetS, OffsetD;
2299   bool OffsetSIsScalable, OffsetDIsScalable;
2300   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
2301   if (!TII->getMemOperandWithOffset(*SI, BaseOpS, OffsetS, OffsetSIsScalable,
2302                                     TRI) ||
2303       !TII->getMemOperandWithOffset(*DI, BaseOpD, OffsetD, OffsetDIsScalable,
2304                                     TRI))
2305     return true;
2306 
2307   assert(!OffsetSIsScalable && !OffsetDIsScalable &&
2308          "Expected offsets to be byte offsets");
2309 
2310   if (!BaseOpS->isIdenticalTo(*BaseOpD))
2311     return true;
2312 
2313   // Check that the base register is incremented by a constant value for each
2314   // iteration.
2315   MachineInstr *Def = MRI.getVRegDef(BaseOpS->getReg());
2316   if (!Def || !Def->isPHI())
2317     return true;
2318   unsigned InitVal = 0;
2319   unsigned LoopVal = 0;
2320   getPhiRegs(*Def, BB, InitVal, LoopVal);
2321   MachineInstr *LoopDef = MRI.getVRegDef(LoopVal);
2322   int D = 0;
2323   if (!LoopDef || !TII->getIncrementValue(*LoopDef, D))
2324     return true;
2325 
2326   uint64_t AccessSizeS = (*SI->memoperands_begin())->getSize();
2327   uint64_t AccessSizeD = (*DI->memoperands_begin())->getSize();
2328 
2329   // This is the main test, which checks the offset values and the loop
2330   // increment value to determine if the accesses may be loop carried.
2331   if (AccessSizeS == MemoryLocation::UnknownSize ||
2332       AccessSizeD == MemoryLocation::UnknownSize)
2333     return true;
2334 
2335   if (DeltaS != DeltaD || DeltaS < AccessSizeS || DeltaD < AccessSizeD)
2336     return true;
2337 
2338   return (OffsetS + (int64_t)AccessSizeS < OffsetD + (int64_t)AccessSizeD);
2339 }
2340 
2341 void SwingSchedulerDAG::postprocessDAG() {
2342   for (auto &M : Mutations)
2343     M->apply(this);
2344 }
2345 
2346 /// Try to schedule the node at the specified StartCycle and continue
2347 /// until the node is schedule or the EndCycle is reached.  This function
2348 /// returns true if the node is scheduled.  This routine may search either
2349 /// forward or backward for a place to insert the instruction based upon
2350 /// the relative values of StartCycle and EndCycle.
2351 bool SMSchedule::insert(SUnit *SU, int StartCycle, int EndCycle, int II) {
2352   bool forward = true;
2353   LLVM_DEBUG({
2354     dbgs() << "Trying to insert node between " << StartCycle << " and "
2355            << EndCycle << " II: " << II << "\n";
2356   });
2357   if (StartCycle > EndCycle)
2358     forward = false;
2359 
2360   // The terminating condition depends on the direction.
2361   int termCycle = forward ? EndCycle + 1 : EndCycle - 1;
2362   for (int curCycle = StartCycle; curCycle != termCycle;
2363        forward ? ++curCycle : --curCycle) {
2364 
2365     // Add the already scheduled instructions at the specified cycle to the
2366     // DFA.
2367     ProcItinResources.clearResources();
2368     for (int checkCycle = FirstCycle + ((curCycle - FirstCycle) % II);
2369          checkCycle <= LastCycle; checkCycle += II) {
2370       std::deque<SUnit *> &cycleInstrs = ScheduledInstrs[checkCycle];
2371 
2372       for (SUnit *CI : cycleInstrs) {
2373         if (ST.getInstrInfo()->isZeroCost(CI->getInstr()->getOpcode()))
2374           continue;
2375         assert(ProcItinResources.canReserveResources(*CI->getInstr()) &&
2376                "These instructions have already been scheduled.");
2377         ProcItinResources.reserveResources(*CI->getInstr());
2378       }
2379     }
2380     if (ST.getInstrInfo()->isZeroCost(SU->getInstr()->getOpcode()) ||
2381         ProcItinResources.canReserveResources(*SU->getInstr())) {
2382       LLVM_DEBUG({
2383         dbgs() << "\tinsert at cycle " << curCycle << " ";
2384         SU->getInstr()->dump();
2385       });
2386 
2387       ScheduledInstrs[curCycle].push_back(SU);
2388       InstrToCycle.insert(std::make_pair(SU, curCycle));
2389       if (curCycle > LastCycle)
2390         LastCycle = curCycle;
2391       if (curCycle < FirstCycle)
2392         FirstCycle = curCycle;
2393       return true;
2394     }
2395     LLVM_DEBUG({
2396       dbgs() << "\tfailed to insert at cycle " << curCycle << " ";
2397       SU->getInstr()->dump();
2398     });
2399   }
2400   return false;
2401 }
2402 
2403 // Return the cycle of the earliest scheduled instruction in the chain.
2404 int SMSchedule::earliestCycleInChain(const SDep &Dep) {
2405   SmallPtrSet<SUnit *, 8> Visited;
2406   SmallVector<SDep, 8> Worklist;
2407   Worklist.push_back(Dep);
2408   int EarlyCycle = INT_MAX;
2409   while (!Worklist.empty()) {
2410     const SDep &Cur = Worklist.pop_back_val();
2411     SUnit *PrevSU = Cur.getSUnit();
2412     if (Visited.count(PrevSU))
2413       continue;
2414     std::map<SUnit *, int>::const_iterator it = InstrToCycle.find(PrevSU);
2415     if (it == InstrToCycle.end())
2416       continue;
2417     EarlyCycle = std::min(EarlyCycle, it->second);
2418     for (const auto &PI : PrevSU->Preds)
2419       if (PI.getKind() == SDep::Order || PI.getKind() == SDep::Output)
2420         Worklist.push_back(PI);
2421     Visited.insert(PrevSU);
2422   }
2423   return EarlyCycle;
2424 }
2425 
2426 // Return the cycle of the latest scheduled instruction in the chain.
2427 int SMSchedule::latestCycleInChain(const SDep &Dep) {
2428   SmallPtrSet<SUnit *, 8> Visited;
2429   SmallVector<SDep, 8> Worklist;
2430   Worklist.push_back(Dep);
2431   int LateCycle = INT_MIN;
2432   while (!Worklist.empty()) {
2433     const SDep &Cur = Worklist.pop_back_val();
2434     SUnit *SuccSU = Cur.getSUnit();
2435     if (Visited.count(SuccSU))
2436       continue;
2437     std::map<SUnit *, int>::const_iterator it = InstrToCycle.find(SuccSU);
2438     if (it == InstrToCycle.end())
2439       continue;
2440     LateCycle = std::max(LateCycle, it->second);
2441     for (const auto &SI : SuccSU->Succs)
2442       if (SI.getKind() == SDep::Order || SI.getKind() == SDep::Output)
2443         Worklist.push_back(SI);
2444     Visited.insert(SuccSU);
2445   }
2446   return LateCycle;
2447 }
2448 
2449 /// If an instruction has a use that spans multiple iterations, then
2450 /// return true. These instructions are characterized by having a back-ege
2451 /// to a Phi, which contains a reference to another Phi.
2452 static SUnit *multipleIterations(SUnit *SU, SwingSchedulerDAG *DAG) {
2453   for (auto &P : SU->Preds)
2454     if (DAG->isBackedge(SU, P) && P.getSUnit()->getInstr()->isPHI())
2455       for (auto &S : P.getSUnit()->Succs)
2456         if (S.getKind() == SDep::Data && S.getSUnit()->getInstr()->isPHI())
2457           return P.getSUnit();
2458   return nullptr;
2459 }
2460 
2461 /// Compute the scheduling start slot for the instruction.  The start slot
2462 /// depends on any predecessor or successor nodes scheduled already.
2463 void SMSchedule::computeStart(SUnit *SU, int *MaxEarlyStart, int *MinLateStart,
2464                               int *MinEnd, int *MaxStart, int II,
2465                               SwingSchedulerDAG *DAG) {
2466   // Iterate over each instruction that has been scheduled already.  The start
2467   // slot computation depends on whether the previously scheduled instruction
2468   // is a predecessor or successor of the specified instruction.
2469   for (int cycle = getFirstCycle(); cycle <= LastCycle; ++cycle) {
2470 
2471     // Iterate over each instruction in the current cycle.
2472     for (SUnit *I : getInstructions(cycle)) {
2473       // Because we're processing a DAG for the dependences, we recognize
2474       // the back-edge in recurrences by anti dependences.
2475       for (unsigned i = 0, e = (unsigned)SU->Preds.size(); i != e; ++i) {
2476         const SDep &Dep = SU->Preds[i];
2477         if (Dep.getSUnit() == I) {
2478           if (!DAG->isBackedge(SU, Dep)) {
2479             int EarlyStart = cycle + Dep.getLatency() -
2480                              DAG->getDistance(Dep.getSUnit(), SU, Dep) * II;
2481             *MaxEarlyStart = std::max(*MaxEarlyStart, EarlyStart);
2482             if (DAG->isLoopCarriedDep(SU, Dep, false)) {
2483               int End = earliestCycleInChain(Dep) + (II - 1);
2484               *MinEnd = std::min(*MinEnd, End);
2485             }
2486           } else {
2487             int LateStart = cycle - Dep.getLatency() +
2488                             DAG->getDistance(SU, Dep.getSUnit(), Dep) * II;
2489             *MinLateStart = std::min(*MinLateStart, LateStart);
2490           }
2491         }
2492         // For instruction that requires multiple iterations, make sure that
2493         // the dependent instruction is not scheduled past the definition.
2494         SUnit *BE = multipleIterations(I, DAG);
2495         if (BE && Dep.getSUnit() == BE && !SU->getInstr()->isPHI() &&
2496             !SU->isPred(I))
2497           *MinLateStart = std::min(*MinLateStart, cycle);
2498       }
2499       for (unsigned i = 0, e = (unsigned)SU->Succs.size(); i != e; ++i) {
2500         if (SU->Succs[i].getSUnit() == I) {
2501           const SDep &Dep = SU->Succs[i];
2502           if (!DAG->isBackedge(SU, Dep)) {
2503             int LateStart = cycle - Dep.getLatency() +
2504                             DAG->getDistance(SU, Dep.getSUnit(), Dep) * II;
2505             *MinLateStart = std::min(*MinLateStart, LateStart);
2506             if (DAG->isLoopCarriedDep(SU, Dep)) {
2507               int Start = latestCycleInChain(Dep) + 1 - II;
2508               *MaxStart = std::max(*MaxStart, Start);
2509             }
2510           } else {
2511             int EarlyStart = cycle + Dep.getLatency() -
2512                              DAG->getDistance(Dep.getSUnit(), SU, Dep) * II;
2513             *MaxEarlyStart = std::max(*MaxEarlyStart, EarlyStart);
2514           }
2515         }
2516       }
2517     }
2518   }
2519 }
2520 
2521 /// Order the instructions within a cycle so that the definitions occur
2522 /// before the uses. Returns true if the instruction is added to the start
2523 /// of the list, or false if added to the end.
2524 void SMSchedule::orderDependence(SwingSchedulerDAG *SSD, SUnit *SU,
2525                                  std::deque<SUnit *> &Insts) {
2526   MachineInstr *MI = SU->getInstr();
2527   bool OrderBeforeUse = false;
2528   bool OrderAfterDef = false;
2529   bool OrderBeforeDef = false;
2530   unsigned MoveDef = 0;
2531   unsigned MoveUse = 0;
2532   int StageInst1 = stageScheduled(SU);
2533 
2534   unsigned Pos = 0;
2535   for (std::deque<SUnit *>::iterator I = Insts.begin(), E = Insts.end(); I != E;
2536        ++I, ++Pos) {
2537     for (MachineOperand &MO : MI->operands()) {
2538       if (!MO.isReg() || !Register::isVirtualRegister(MO.getReg()))
2539         continue;
2540 
2541       Register Reg = MO.getReg();
2542       unsigned BasePos, OffsetPos;
2543       if (ST.getInstrInfo()->getBaseAndOffsetPosition(*MI, BasePos, OffsetPos))
2544         if (MI->getOperand(BasePos).getReg() == Reg)
2545           if (unsigned NewReg = SSD->getInstrBaseReg(SU))
2546             Reg = NewReg;
2547       bool Reads, Writes;
2548       std::tie(Reads, Writes) =
2549           (*I)->getInstr()->readsWritesVirtualRegister(Reg);
2550       if (MO.isDef() && Reads && stageScheduled(*I) <= StageInst1) {
2551         OrderBeforeUse = true;
2552         if (MoveUse == 0)
2553           MoveUse = Pos;
2554       } else if (MO.isDef() && Reads && stageScheduled(*I) > StageInst1) {
2555         // Add the instruction after the scheduled instruction.
2556         OrderAfterDef = true;
2557         MoveDef = Pos;
2558       } else if (MO.isUse() && Writes && stageScheduled(*I) == StageInst1) {
2559         if (cycleScheduled(*I) == cycleScheduled(SU) && !(*I)->isSucc(SU)) {
2560           OrderBeforeUse = true;
2561           if (MoveUse == 0)
2562             MoveUse = Pos;
2563         } else {
2564           OrderAfterDef = true;
2565           MoveDef = Pos;
2566         }
2567       } else if (MO.isUse() && Writes && stageScheduled(*I) > StageInst1) {
2568         OrderBeforeUse = true;
2569         if (MoveUse == 0)
2570           MoveUse = Pos;
2571         if (MoveUse != 0) {
2572           OrderAfterDef = true;
2573           MoveDef = Pos - 1;
2574         }
2575       } else if (MO.isUse() && Writes && stageScheduled(*I) < StageInst1) {
2576         // Add the instruction before the scheduled instruction.
2577         OrderBeforeUse = true;
2578         if (MoveUse == 0)
2579           MoveUse = Pos;
2580       } else if (MO.isUse() && stageScheduled(*I) == StageInst1 &&
2581                  isLoopCarriedDefOfUse(SSD, (*I)->getInstr(), MO)) {
2582         if (MoveUse == 0) {
2583           OrderBeforeDef = true;
2584           MoveUse = Pos;
2585         }
2586       }
2587     }
2588     // Check for order dependences between instructions. Make sure the source
2589     // is ordered before the destination.
2590     for (auto &S : SU->Succs) {
2591       if (S.getSUnit() != *I)
2592         continue;
2593       if (S.getKind() == SDep::Order && stageScheduled(*I) == StageInst1) {
2594         OrderBeforeUse = true;
2595         if (Pos < MoveUse)
2596           MoveUse = Pos;
2597       }
2598       // We did not handle HW dependences in previous for loop,
2599       // and we normally set Latency = 0 for Anti deps,
2600       // so may have nodes in same cycle with Anti denpendent on HW regs.
2601       else if (S.getKind() == SDep::Anti && stageScheduled(*I) == StageInst1) {
2602         OrderBeforeUse = true;
2603         if ((MoveUse == 0) || (Pos < MoveUse))
2604           MoveUse = Pos;
2605       }
2606     }
2607     for (auto &P : SU->Preds) {
2608       if (P.getSUnit() != *I)
2609         continue;
2610       if (P.getKind() == SDep::Order && stageScheduled(*I) == StageInst1) {
2611         OrderAfterDef = true;
2612         MoveDef = Pos;
2613       }
2614     }
2615   }
2616 
2617   // A circular dependence.
2618   if (OrderAfterDef && OrderBeforeUse && MoveUse == MoveDef)
2619     OrderBeforeUse = false;
2620 
2621   // OrderAfterDef takes precedences over OrderBeforeDef. The latter is due
2622   // to a loop-carried dependence.
2623   if (OrderBeforeDef)
2624     OrderBeforeUse = !OrderAfterDef || (MoveUse > MoveDef);
2625 
2626   // The uncommon case when the instruction order needs to be updated because
2627   // there is both a use and def.
2628   if (OrderBeforeUse && OrderAfterDef) {
2629     SUnit *UseSU = Insts.at(MoveUse);
2630     SUnit *DefSU = Insts.at(MoveDef);
2631     if (MoveUse > MoveDef) {
2632       Insts.erase(Insts.begin() + MoveUse);
2633       Insts.erase(Insts.begin() + MoveDef);
2634     } else {
2635       Insts.erase(Insts.begin() + MoveDef);
2636       Insts.erase(Insts.begin() + MoveUse);
2637     }
2638     orderDependence(SSD, UseSU, Insts);
2639     orderDependence(SSD, SU, Insts);
2640     orderDependence(SSD, DefSU, Insts);
2641     return;
2642   }
2643   // Put the new instruction first if there is a use in the list. Otherwise,
2644   // put it at the end of the list.
2645   if (OrderBeforeUse)
2646     Insts.push_front(SU);
2647   else
2648     Insts.push_back(SU);
2649 }
2650 
2651 /// Return true if the scheduled Phi has a loop carried operand.
2652 bool SMSchedule::isLoopCarried(SwingSchedulerDAG *SSD, MachineInstr &Phi) {
2653   if (!Phi.isPHI())
2654     return false;
2655   assert(Phi.isPHI() && "Expecting a Phi.");
2656   SUnit *DefSU = SSD->getSUnit(&Phi);
2657   unsigned DefCycle = cycleScheduled(DefSU);
2658   int DefStage = stageScheduled(DefSU);
2659 
2660   unsigned InitVal = 0;
2661   unsigned LoopVal = 0;
2662   getPhiRegs(Phi, Phi.getParent(), InitVal, LoopVal);
2663   SUnit *UseSU = SSD->getSUnit(MRI.getVRegDef(LoopVal));
2664   if (!UseSU)
2665     return true;
2666   if (UseSU->getInstr()->isPHI())
2667     return true;
2668   unsigned LoopCycle = cycleScheduled(UseSU);
2669   int LoopStage = stageScheduled(UseSU);
2670   return (LoopCycle > DefCycle) || (LoopStage <= DefStage);
2671 }
2672 
2673 /// Return true if the instruction is a definition that is loop carried
2674 /// and defines the use on the next iteration.
2675 ///        v1 = phi(v2, v3)
2676 ///  (Def) v3 = op v1
2677 ///  (MO)   = v1
2678 /// If MO appears before Def, then then v1 and v3 may get assigned to the same
2679 /// register.
2680 bool SMSchedule::isLoopCarriedDefOfUse(SwingSchedulerDAG *SSD,
2681                                        MachineInstr *Def, MachineOperand &MO) {
2682   if (!MO.isReg())
2683     return false;
2684   if (Def->isPHI())
2685     return false;
2686   MachineInstr *Phi = MRI.getVRegDef(MO.getReg());
2687   if (!Phi || !Phi->isPHI() || Phi->getParent() != Def->getParent())
2688     return false;
2689   if (!isLoopCarried(SSD, *Phi))
2690     return false;
2691   unsigned LoopReg = getLoopPhiReg(*Phi, Phi->getParent());
2692   for (unsigned i = 0, e = Def->getNumOperands(); i != e; ++i) {
2693     MachineOperand &DMO = Def->getOperand(i);
2694     if (!DMO.isReg() || !DMO.isDef())
2695       continue;
2696     if (DMO.getReg() == LoopReg)
2697       return true;
2698   }
2699   return false;
2700 }
2701 
2702 // Check if the generated schedule is valid. This function checks if
2703 // an instruction that uses a physical register is scheduled in a
2704 // different stage than the definition. The pipeliner does not handle
2705 // physical register values that may cross a basic block boundary.
2706 bool SMSchedule::isValidSchedule(SwingSchedulerDAG *SSD) {
2707   for (SUnit &SU : SSD->SUnits) {
2708     if (!SU.hasPhysRegDefs)
2709       continue;
2710     int StageDef = stageScheduled(&SU);
2711     assert(StageDef != -1 && "Instruction should have been scheduled.");
2712     for (auto &SI : SU.Succs)
2713       if (SI.isAssignedRegDep())
2714         if (Register::isPhysicalRegister(SI.getReg()))
2715           if (stageScheduled(SI.getSUnit()) != StageDef)
2716             return false;
2717   }
2718   return true;
2719 }
2720 
2721 /// A property of the node order in swing-modulo-scheduling is
2722 /// that for nodes outside circuits the following holds:
2723 /// none of them is scheduled after both a successor and a
2724 /// predecessor.
2725 /// The method below checks whether the property is met.
2726 /// If not, debug information is printed and statistics information updated.
2727 /// Note that we do not use an assert statement.
2728 /// The reason is that although an invalid node oder may prevent
2729 /// the pipeliner from finding a pipelined schedule for arbitrary II,
2730 /// it does not lead to the generation of incorrect code.
2731 void SwingSchedulerDAG::checkValidNodeOrder(const NodeSetType &Circuits) const {
2732 
2733   // a sorted vector that maps each SUnit to its index in the NodeOrder
2734   typedef std::pair<SUnit *, unsigned> UnitIndex;
2735   std::vector<UnitIndex> Indices(NodeOrder.size(), std::make_pair(nullptr, 0));
2736 
2737   for (unsigned i = 0, s = NodeOrder.size(); i < s; ++i)
2738     Indices.push_back(std::make_pair(NodeOrder[i], i));
2739 
2740   auto CompareKey = [](UnitIndex i1, UnitIndex i2) {
2741     return std::get<0>(i1) < std::get<0>(i2);
2742   };
2743 
2744   // sort, so that we can perform a binary search
2745   llvm::sort(Indices, CompareKey);
2746 
2747   bool Valid = true;
2748   (void)Valid;
2749   // for each SUnit in the NodeOrder, check whether
2750   // it appears after both a successor and a predecessor
2751   // of the SUnit. If this is the case, and the SUnit
2752   // is not part of circuit, then the NodeOrder is not
2753   // valid.
2754   for (unsigned i = 0, s = NodeOrder.size(); i < s; ++i) {
2755     SUnit *SU = NodeOrder[i];
2756     unsigned Index = i;
2757 
2758     bool PredBefore = false;
2759     bool SuccBefore = false;
2760 
2761     SUnit *Succ;
2762     SUnit *Pred;
2763     (void)Succ;
2764     (void)Pred;
2765 
2766     for (SDep &PredEdge : SU->Preds) {
2767       SUnit *PredSU = PredEdge.getSUnit();
2768       unsigned PredIndex = std::get<1>(
2769           *llvm::lower_bound(Indices, std::make_pair(PredSU, 0), CompareKey));
2770       if (!PredSU->getInstr()->isPHI() && PredIndex < Index) {
2771         PredBefore = true;
2772         Pred = PredSU;
2773         break;
2774       }
2775     }
2776 
2777     for (SDep &SuccEdge : SU->Succs) {
2778       SUnit *SuccSU = SuccEdge.getSUnit();
2779       // Do not process a boundary node, it was not included in NodeOrder,
2780       // hence not in Indices either, call to std::lower_bound() below will
2781       // return Indices.end().
2782       if (SuccSU->isBoundaryNode())
2783         continue;
2784       unsigned SuccIndex = std::get<1>(
2785           *llvm::lower_bound(Indices, std::make_pair(SuccSU, 0), CompareKey));
2786       if (!SuccSU->getInstr()->isPHI() && SuccIndex < Index) {
2787         SuccBefore = true;
2788         Succ = SuccSU;
2789         break;
2790       }
2791     }
2792 
2793     if (PredBefore && SuccBefore && !SU->getInstr()->isPHI()) {
2794       // instructions in circuits are allowed to be scheduled
2795       // after both a successor and predecessor.
2796       bool InCircuit = llvm::any_of(
2797           Circuits, [SU](const NodeSet &Circuit) { return Circuit.count(SU); });
2798       if (InCircuit)
2799         LLVM_DEBUG(dbgs() << "In a circuit, predecessor ";);
2800       else {
2801         Valid = false;
2802         NumNodeOrderIssues++;
2803         LLVM_DEBUG(dbgs() << "Predecessor ";);
2804       }
2805       LLVM_DEBUG(dbgs() << Pred->NodeNum << " and successor " << Succ->NodeNum
2806                         << " are scheduled before node " << SU->NodeNum
2807                         << "\n";);
2808     }
2809   }
2810 
2811   LLVM_DEBUG({
2812     if (!Valid)
2813       dbgs() << "Invalid node order found!\n";
2814   });
2815 }
2816 
2817 /// Attempt to fix the degenerate cases when the instruction serialization
2818 /// causes the register lifetimes to overlap. For example,
2819 ///   p' = store_pi(p, b)
2820 ///      = load p, offset
2821 /// In this case p and p' overlap, which means that two registers are needed.
2822 /// Instead, this function changes the load to use p' and updates the offset.
2823 void SwingSchedulerDAG::fixupRegisterOverlaps(std::deque<SUnit *> &Instrs) {
2824   unsigned OverlapReg = 0;
2825   unsigned NewBaseReg = 0;
2826   for (SUnit *SU : Instrs) {
2827     MachineInstr *MI = SU->getInstr();
2828     for (unsigned i = 0, e = MI->getNumOperands(); i < e; ++i) {
2829       const MachineOperand &MO = MI->getOperand(i);
2830       // Look for an instruction that uses p. The instruction occurs in the
2831       // same cycle but occurs later in the serialized order.
2832       if (MO.isReg() && MO.isUse() && MO.getReg() == OverlapReg) {
2833         // Check that the instruction appears in the InstrChanges structure,
2834         // which contains instructions that can have the offset updated.
2835         DenseMap<SUnit *, std::pair<unsigned, int64_t>>::iterator It =
2836           InstrChanges.find(SU);
2837         if (It != InstrChanges.end()) {
2838           unsigned BasePos, OffsetPos;
2839           // Update the base register and adjust the offset.
2840           if (TII->getBaseAndOffsetPosition(*MI, BasePos, OffsetPos)) {
2841             MachineInstr *NewMI = MF.CloneMachineInstr(MI);
2842             NewMI->getOperand(BasePos).setReg(NewBaseReg);
2843             int64_t NewOffset =
2844                 MI->getOperand(OffsetPos).getImm() - It->second.second;
2845             NewMI->getOperand(OffsetPos).setImm(NewOffset);
2846             SU->setInstr(NewMI);
2847             MISUnitMap[NewMI] = SU;
2848             NewMIs[MI] = NewMI;
2849           }
2850         }
2851         OverlapReg = 0;
2852         NewBaseReg = 0;
2853         break;
2854       }
2855       // Look for an instruction of the form p' = op(p), which uses and defines
2856       // two virtual registers that get allocated to the same physical register.
2857       unsigned TiedUseIdx = 0;
2858       if (MI->isRegTiedToUseOperand(i, &TiedUseIdx)) {
2859         // OverlapReg is p in the example above.
2860         OverlapReg = MI->getOperand(TiedUseIdx).getReg();
2861         // NewBaseReg is p' in the example above.
2862         NewBaseReg = MI->getOperand(i).getReg();
2863         break;
2864       }
2865     }
2866   }
2867 }
2868 
2869 /// After the schedule has been formed, call this function to combine
2870 /// the instructions from the different stages/cycles.  That is, this
2871 /// function creates a schedule that represents a single iteration.
2872 void SMSchedule::finalizeSchedule(SwingSchedulerDAG *SSD) {
2873   // Move all instructions to the first stage from later stages.
2874   for (int cycle = getFirstCycle(); cycle <= getFinalCycle(); ++cycle) {
2875     for (int stage = 1, lastStage = getMaxStageCount(); stage <= lastStage;
2876          ++stage) {
2877       std::deque<SUnit *> &cycleInstrs =
2878           ScheduledInstrs[cycle + (stage * InitiationInterval)];
2879       for (std::deque<SUnit *>::reverse_iterator I = cycleInstrs.rbegin(),
2880                                                  E = cycleInstrs.rend();
2881            I != E; ++I)
2882         ScheduledInstrs[cycle].push_front(*I);
2883     }
2884   }
2885 
2886   // Erase all the elements in the later stages. Only one iteration should
2887   // remain in the scheduled list, and it contains all the instructions.
2888   for (int cycle = getFinalCycle() + 1; cycle <= LastCycle; ++cycle)
2889     ScheduledInstrs.erase(cycle);
2890 
2891   // Change the registers in instruction as specified in the InstrChanges
2892   // map. We need to use the new registers to create the correct order.
2893   for (const SUnit &SU : SSD->SUnits)
2894     SSD->applyInstrChange(SU.getInstr(), *this);
2895 
2896   // Reorder the instructions in each cycle to fix and improve the
2897   // generated code.
2898   for (int Cycle = getFirstCycle(), E = getFinalCycle(); Cycle <= E; ++Cycle) {
2899     std::deque<SUnit *> &cycleInstrs = ScheduledInstrs[Cycle];
2900     std::deque<SUnit *> newOrderPhi;
2901     for (SUnit *SU : cycleInstrs) {
2902       if (SU->getInstr()->isPHI())
2903         newOrderPhi.push_back(SU);
2904     }
2905     std::deque<SUnit *> newOrderI;
2906     for (SUnit *SU : cycleInstrs) {
2907       if (!SU->getInstr()->isPHI())
2908         orderDependence(SSD, SU, newOrderI);
2909     }
2910     // Replace the old order with the new order.
2911     cycleInstrs.swap(newOrderPhi);
2912     llvm::append_range(cycleInstrs, newOrderI);
2913     SSD->fixupRegisterOverlaps(cycleInstrs);
2914   }
2915 
2916   LLVM_DEBUG(dump(););
2917 }
2918 
2919 void NodeSet::print(raw_ostream &os) const {
2920   os << "Num nodes " << size() << " rec " << RecMII << " mov " << MaxMOV
2921      << " depth " << MaxDepth << " col " << Colocate << "\n";
2922   for (const auto &I : Nodes)
2923     os << "   SU(" << I->NodeNum << ") " << *(I->getInstr());
2924   os << "\n";
2925 }
2926 
2927 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
2928 /// Print the schedule information to the given output.
2929 void SMSchedule::print(raw_ostream &os) const {
2930   // Iterate over each cycle.
2931   for (int cycle = getFirstCycle(); cycle <= getFinalCycle(); ++cycle) {
2932     // Iterate over each instruction in the cycle.
2933     const_sched_iterator cycleInstrs = ScheduledInstrs.find(cycle);
2934     for (SUnit *CI : cycleInstrs->second) {
2935       os << "cycle " << cycle << " (" << stageScheduled(CI) << ") ";
2936       os << "(" << CI->NodeNum << ") ";
2937       CI->getInstr()->print(os);
2938       os << "\n";
2939     }
2940   }
2941 }
2942 
2943 /// Utility function used for debugging to print the schedule.
2944 LLVM_DUMP_METHOD void SMSchedule::dump() const { print(dbgs()); }
2945 LLVM_DUMP_METHOD void NodeSet::dump() const { print(dbgs()); }
2946 
2947 #endif
2948 
2949 void ResourceManager::initProcResourceVectors(
2950     const MCSchedModel &SM, SmallVectorImpl<uint64_t> &Masks) {
2951   unsigned ProcResourceID = 0;
2952 
2953   // We currently limit the resource kinds to 64 and below so that we can use
2954   // uint64_t for Masks
2955   assert(SM.getNumProcResourceKinds() < 64 &&
2956          "Too many kinds of resources, unsupported");
2957   // Create a unique bitmask for every processor resource unit.
2958   // Skip resource at index 0, since it always references 'InvalidUnit'.
2959   Masks.resize(SM.getNumProcResourceKinds());
2960   for (unsigned I = 1, E = SM.getNumProcResourceKinds(); I < E; ++I) {
2961     const MCProcResourceDesc &Desc = *SM.getProcResource(I);
2962     if (Desc.SubUnitsIdxBegin)
2963       continue;
2964     Masks[I] = 1ULL << ProcResourceID;
2965     ProcResourceID++;
2966   }
2967   // Create a unique bitmask for every processor resource group.
2968   for (unsigned I = 1, E = SM.getNumProcResourceKinds(); I < E; ++I) {
2969     const MCProcResourceDesc &Desc = *SM.getProcResource(I);
2970     if (!Desc.SubUnitsIdxBegin)
2971       continue;
2972     Masks[I] = 1ULL << ProcResourceID;
2973     for (unsigned U = 0; U < Desc.NumUnits; ++U)
2974       Masks[I] |= Masks[Desc.SubUnitsIdxBegin[U]];
2975     ProcResourceID++;
2976   }
2977   LLVM_DEBUG({
2978     if (SwpShowResMask) {
2979       dbgs() << "ProcResourceDesc:\n";
2980       for (unsigned I = 1, E = SM.getNumProcResourceKinds(); I < E; ++I) {
2981         const MCProcResourceDesc *ProcResource = SM.getProcResource(I);
2982         dbgs() << format(" %16s(%2d): Mask: 0x%08x, NumUnits:%2d\n",
2983                          ProcResource->Name, I, Masks[I],
2984                          ProcResource->NumUnits);
2985       }
2986       dbgs() << " -----------------\n";
2987     }
2988   });
2989 }
2990 
2991 bool ResourceManager::canReserveResources(const MCInstrDesc *MID) const {
2992 
2993   LLVM_DEBUG({
2994     if (SwpDebugResource)
2995       dbgs() << "canReserveResources:\n";
2996   });
2997   if (UseDFA)
2998     return DFAResources->canReserveResources(MID);
2999 
3000   unsigned InsnClass = MID->getSchedClass();
3001   const MCSchedClassDesc *SCDesc = SM.getSchedClassDesc(InsnClass);
3002   if (!SCDesc->isValid()) {
3003     LLVM_DEBUG({
3004       dbgs() << "No valid Schedule Class Desc for schedClass!\n";
3005       dbgs() << "isPseduo:" << MID->isPseudo() << "\n";
3006     });
3007     return true;
3008   }
3009 
3010   const MCWriteProcResEntry *I = STI->getWriteProcResBegin(SCDesc);
3011   const MCWriteProcResEntry *E = STI->getWriteProcResEnd(SCDesc);
3012   for (; I != E; ++I) {
3013     if (!I->Cycles)
3014       continue;
3015     const MCProcResourceDesc *ProcResource =
3016         SM.getProcResource(I->ProcResourceIdx);
3017     unsigned NumUnits = ProcResource->NumUnits;
3018     LLVM_DEBUG({
3019       if (SwpDebugResource)
3020         dbgs() << format(" %16s(%2d): Count: %2d, NumUnits:%2d, Cycles:%2d\n",
3021                          ProcResource->Name, I->ProcResourceIdx,
3022                          ProcResourceCount[I->ProcResourceIdx], NumUnits,
3023                          I->Cycles);
3024     });
3025     if (ProcResourceCount[I->ProcResourceIdx] >= NumUnits)
3026       return false;
3027   }
3028   LLVM_DEBUG(if (SwpDebugResource) dbgs() << "return true\n\n";);
3029   return true;
3030 }
3031 
3032 void ResourceManager::reserveResources(const MCInstrDesc *MID) {
3033   LLVM_DEBUG({
3034     if (SwpDebugResource)
3035       dbgs() << "reserveResources:\n";
3036   });
3037   if (UseDFA)
3038     return DFAResources->reserveResources(MID);
3039 
3040   unsigned InsnClass = MID->getSchedClass();
3041   const MCSchedClassDesc *SCDesc = SM.getSchedClassDesc(InsnClass);
3042   if (!SCDesc->isValid()) {
3043     LLVM_DEBUG({
3044       dbgs() << "No valid Schedule Class Desc for schedClass!\n";
3045       dbgs() << "isPseduo:" << MID->isPseudo() << "\n";
3046     });
3047     return;
3048   }
3049   for (const MCWriteProcResEntry &PRE :
3050        make_range(STI->getWriteProcResBegin(SCDesc),
3051                   STI->getWriteProcResEnd(SCDesc))) {
3052     if (!PRE.Cycles)
3053       continue;
3054     ++ProcResourceCount[PRE.ProcResourceIdx];
3055     LLVM_DEBUG({
3056       if (SwpDebugResource) {
3057         const MCProcResourceDesc *ProcResource =
3058             SM.getProcResource(PRE.ProcResourceIdx);
3059         dbgs() << format(" %16s(%2d): Count: %2d, NumUnits:%2d, Cycles:%2d\n",
3060                          ProcResource->Name, PRE.ProcResourceIdx,
3061                          ProcResourceCount[PRE.ProcResourceIdx],
3062                          ProcResource->NumUnits, PRE.Cycles);
3063       }
3064     });
3065   }
3066   LLVM_DEBUG({
3067     if (SwpDebugResource)
3068       dbgs() << "reserveResources: done!\n\n";
3069   });
3070 }
3071 
3072 bool ResourceManager::canReserveResources(const MachineInstr &MI) const {
3073   return canReserveResources(&MI.getDesc());
3074 }
3075 
3076 void ResourceManager::reserveResources(const MachineInstr &MI) {
3077   return reserveResources(&MI.getDesc());
3078 }
3079 
3080 void ResourceManager::clearResources() {
3081   if (UseDFA)
3082     return DFAResources->clearResources();
3083   std::fill(ProcResourceCount.begin(), ProcResourceCount.end(), 0);
3084 }
3085