1 //===---- ScheduleDAG.cpp - Implement the ScheduleDAG class ---------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by James M. Laskey and is distributed under the
6 // University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This implements a simple two pass scheduler. The first pass attempts to push
11 // backward any lengthy instructions and critical paths. The second pass packs
12 // instructions into semi-optimal time slots.
14 //===----------------------------------------------------------------------===//
16 #define DEBUG_TYPE "sched"
17 #include "llvm/CodeGen/MachineConstantPool.h"
18 #include "llvm/CodeGen/MachineFunction.h"
19 #include "llvm/CodeGen/ScheduleDAG.h"
20 #include "llvm/CodeGen/SSARegMap.h"
21 #include "llvm/Target/TargetMachine.h"
22 #include "llvm/Target/TargetInstrInfo.h"
23 #include "llvm/Target/TargetInstrItineraries.h"
24 #include "llvm/Target/TargetLowering.h"
25 #include "llvm/Support/Debug.h"
30 /// CountResults - The results of target nodes have register or immediate
31 /// operands first, then an optional chain, and optional flag operands (which do
32 /// not go into the machine instrs.)
33 static unsigned CountResults(SDNode *Node) {
34 unsigned N = Node->getNumValues();
35 while (N && Node->getValueType(N - 1) == MVT::Flag)
37 if (N && Node->getValueType(N - 1) == MVT::Other)
38 --N; // Skip over chain result.
42 /// CountOperands The inputs to target nodes have any actual inputs first,
43 /// followed by an optional chain operand, then flag operands. Compute the
44 /// number of actual operands that will go into the machine instr.
45 static unsigned CountOperands(SDNode *Node) {
46 unsigned N = Node->getNumOperands();
47 while (N && Node->getOperand(N - 1).getValueType() == MVT::Flag)
49 if (N && Node->getOperand(N - 1).getValueType() == MVT::Other)
50 --N; // Ignore chain if it exists.
54 /// PrepareNodeInfo - Set up the basic minimum node info for scheduling.
56 void ScheduleDAG::PrepareNodeInfo() {
57 // Allocate node information
58 Info = new NodeInfo[NodeCount];
61 for (SelectionDAG::allnodes_iterator I = DAG.allnodes_begin(),
62 E = DAG.allnodes_end(); I != E; ++I, ++i) {
63 // Fast reference to node schedule info
64 NodeInfo* NI = &Info[i];
69 // Set pending visit count
70 NI->setPending(I->use_size());
74 /// IdentifyGroups - Put flagged nodes into groups.
76 void ScheduleDAG::IdentifyGroups() {
77 for (unsigned i = 0, N = NodeCount; i < N; i++) {
78 NodeInfo* NI = &Info[i];
79 SDNode *Node = NI->Node;
81 // For each operand (in reverse to only look at flags)
82 for (unsigned N = Node->getNumOperands(); 0 < N--;) {
84 SDOperand Op = Node->getOperand(N);
85 // No more flags to walk
86 if (Op.getValueType() != MVT::Flag) break;
88 NodeGroup::Add(getNI(Op.Val), NI);
89 // Let everyone else know
95 static unsigned CreateVirtualRegisters(MachineInstr *MI,
98 const TargetInstrDescriptor &II) {
99 // Create the result registers for this node and add the result regs to
100 // the machine instruction.
101 const TargetOperandInfo *OpInfo = II.OpInfo;
102 unsigned ResultReg = RegMap->createVirtualRegister(OpInfo[0].RegClass);
103 MI->addRegOperand(ResultReg, MachineOperand::Def);
104 for (unsigned i = 1; i != NumResults; ++i) {
105 assert(OpInfo[i].RegClass && "Isn't a register operand!");
106 MI->addRegOperand(RegMap->createVirtualRegister(OpInfo[i].RegClass),
107 MachineOperand::Def);
112 /// EmitNode - Generate machine code for an node and needed dependencies.
114 void ScheduleDAG::EmitNode(NodeInfo *NI) {
115 unsigned VRBase = 0; // First virtual register for node
116 SDNode *Node = NI->Node;
118 // If machine instruction
119 if (Node->isTargetOpcode()) {
120 unsigned Opc = Node->getTargetOpcode();
121 const TargetInstrDescriptor &II = TII->get(Opc);
123 unsigned NumResults = CountResults(Node);
124 unsigned NodeOperands = CountOperands(Node);
125 unsigned NumMIOperands = NodeOperands + NumResults;
127 assert((unsigned(II.numOperands) == NumMIOperands || II.numOperands == -1)&&
128 "#operands for dag node doesn't match .td file!");
131 // Create the new machine instruction.
132 MachineInstr *MI = new MachineInstr(Opc, NumMIOperands, true, true);
134 // Add result register values for things that are defined by this
137 // If the node is only used by a CopyToReg and the dest reg is a vreg, use
138 // the CopyToReg'd destination register instead of creating a new vreg.
139 if (NumResults == 1) {
140 for (SDNode::use_iterator UI = Node->use_begin(), E = Node->use_end();
143 if (Use->getOpcode() == ISD::CopyToReg &&
144 Use->getOperand(2).Val == Node) {
145 unsigned Reg = cast<RegisterSDNode>(Use->getOperand(1))->getReg();
146 if (MRegisterInfo::isVirtualRegister(Reg)) {
148 MI->addRegOperand(Reg, MachineOperand::Def);
155 // Otherwise, create new virtual registers.
156 if (NumResults && VRBase == 0)
157 VRBase = CreateVirtualRegisters(MI, NumResults, RegMap, II);
159 // Emit all of the actual operands of this instruction, adding them to the
160 // instruction as appropriate.
161 for (unsigned i = 0; i != NodeOperands; ++i) {
162 if (Node->getOperand(i).isTargetOpcode()) {
163 // Note that this case is redundant with the final else block, but we
164 // include it because it is the most common and it makes the logic
166 assert(Node->getOperand(i).getValueType() != MVT::Other &&
167 Node->getOperand(i).getValueType() != MVT::Flag &&
168 "Chain and flag operands should occur at end of operand list!");
170 // Get/emit the operand.
171 unsigned VReg = getVR(Node->getOperand(i));
172 MI->addRegOperand(VReg, MachineOperand::Use);
174 // Verify that it is right.
175 assert(MRegisterInfo::isVirtualRegister(VReg) && "Not a vreg?");
176 assert(II.OpInfo[i+NumResults].RegClass &&
177 "Don't have operand info for this instruction!");
178 assert(RegMap->getRegClass(VReg) == II.OpInfo[i+NumResults].RegClass &&
179 "Register class of operand and regclass of use don't agree!");
180 } else if (ConstantSDNode *C =
181 dyn_cast<ConstantSDNode>(Node->getOperand(i))) {
182 MI->addZeroExtImm64Operand(C->getValue());
183 } else if (RegisterSDNode*R =
184 dyn_cast<RegisterSDNode>(Node->getOperand(i))) {
185 MI->addRegOperand(R->getReg(), MachineOperand::Use);
186 } else if (GlobalAddressSDNode *TGA =
187 dyn_cast<GlobalAddressSDNode>(Node->getOperand(i))) {
188 MI->addGlobalAddressOperand(TGA->getGlobal(), false, TGA->getOffset());
189 } else if (BasicBlockSDNode *BB =
190 dyn_cast<BasicBlockSDNode>(Node->getOperand(i))) {
191 MI->addMachineBasicBlockOperand(BB->getBasicBlock());
192 } else if (FrameIndexSDNode *FI =
193 dyn_cast<FrameIndexSDNode>(Node->getOperand(i))) {
194 MI->addFrameIndexOperand(FI->getIndex());
195 } else if (ConstantPoolSDNode *CP =
196 dyn_cast<ConstantPoolSDNode>(Node->getOperand(i))) {
197 unsigned Idx = ConstPool->getConstantPoolIndex(CP->get());
198 MI->addConstantPoolIndexOperand(Idx);
199 } else if (ExternalSymbolSDNode *ES =
200 dyn_cast<ExternalSymbolSDNode>(Node->getOperand(i))) {
201 MI->addExternalSymbolOperand(ES->getSymbol(), false);
203 assert(Node->getOperand(i).getValueType() != MVT::Other &&
204 Node->getOperand(i).getValueType() != MVT::Flag &&
205 "Chain and flag operands should occur at end of operand list!");
206 unsigned VReg = getVR(Node->getOperand(i));
207 MI->addRegOperand(VReg, MachineOperand::Use);
209 // Verify that it is right.
210 assert(MRegisterInfo::isVirtualRegister(VReg) && "Not a vreg?");
211 assert(II.OpInfo[i+NumResults].RegClass &&
212 "Don't have operand info for this instruction!");
213 assert(RegMap->getRegClass(VReg) == II.OpInfo[i+NumResults].RegClass &&
214 "Register class of operand and regclass of use don't agree!");
218 // Now that we have emitted all operands, emit this instruction itself.
219 if ((II.Flags & M_USES_CUSTOM_DAG_SCHED_INSERTION) == 0) {
220 BB->insert(BB->end(), MI);
222 // Insert this instruction into the end of the basic block, potentially
223 // taking some custom action.
224 BB = DAG.getTargetLoweringInfo().InsertAtEndOfBasicBlock(MI, BB);
227 switch (Node->getOpcode()) {
230 assert(0 && "This target-independent node should have been selected!");
231 case ISD::EntryToken: // fall thru
232 case ISD::TokenFactor:
234 case ISD::CopyToReg: {
235 unsigned InReg = getVR(Node->getOperand(2));
236 unsigned DestReg = cast<RegisterSDNode>(Node->getOperand(1))->getReg();
237 if (InReg != DestReg) // Coallesced away the copy?
238 MRI->copyRegToReg(*BB, BB->end(), DestReg, InReg,
239 RegMap->getRegClass(InReg));
242 case ISD::CopyFromReg: {
243 unsigned SrcReg = cast<RegisterSDNode>(Node->getOperand(1))->getReg();
244 if (MRegisterInfo::isVirtualRegister(SrcReg)) {
245 VRBase = SrcReg; // Just use the input register directly!
249 // If the node is only used by a CopyToReg and the dest reg is a vreg, use
250 // the CopyToReg'd destination register instead of creating a new vreg.
251 for (SDNode::use_iterator UI = Node->use_begin(), E = Node->use_end();
254 if (Use->getOpcode() == ISD::CopyToReg &&
255 Use->getOperand(2).Val == Node) {
256 unsigned DestReg = cast<RegisterSDNode>(Use->getOperand(1))->getReg();
257 if (MRegisterInfo::isVirtualRegister(DestReg)) {
264 // Figure out the register class to create for the destreg.
265 const TargetRegisterClass *TRC = 0;
267 TRC = RegMap->getRegClass(VRBase);
270 // Pick the register class of the right type that contains this physreg.
271 for (MRegisterInfo::regclass_iterator I = MRI->regclass_begin(),
272 E = MRI->regclass_end(); I != E; ++I)
273 if ((*I)->hasType(Node->getValueType(0)) &&
274 (*I)->contains(SrcReg)) {
278 assert(TRC && "Couldn't find register class for reg copy!");
280 // Create the reg, emit the copy.
281 VRBase = RegMap->createVirtualRegister(TRC);
283 MRI->copyRegToReg(*BB, BB->end(), VRBase, SrcReg, TRC);
286 case ISD::INLINEASM: {
287 unsigned NumOps = Node->getNumOperands();
288 if (Node->getOperand(NumOps-1).getValueType() == MVT::Flag)
289 --NumOps; // Ignore the flag operand.
291 // Create the inline asm machine instruction.
293 new MachineInstr(BB, TargetInstrInfo::INLINEASM, (NumOps-2)/2+1);
295 // Add the asm string as an external symbol operand.
297 cast<ExternalSymbolSDNode>(Node->getOperand(1))->getSymbol();
298 MI->addExternalSymbolOperand(AsmStr, false);
300 // Add all of the operand registers to the instruction.
301 for (unsigned i = 2; i != NumOps; i += 2) {
302 unsigned Reg = cast<RegisterSDNode>(Node->getOperand(i))->getReg();
303 unsigned Flags = cast<ConstantSDNode>(Node->getOperand(i))->getValue();
304 MachineOperand::UseType UseTy;
306 default: assert(0 && "Bad flags!");
307 case 1: UseTy = MachineOperand::Use; break;
308 case 2: UseTy = MachineOperand::Def; break;
309 case 3: UseTy = MachineOperand::UseAndDef; break;
311 MI->addMachineRegOperand(Reg, UseTy);
318 assert(NI->VRBase == 0 && "Node emitted out of order - early");
322 /// EmitAll - Emit all nodes in schedule sorted order.
324 void ScheduleDAG::EmitAll() {
325 // For each node in the ordering
326 for (unsigned i = 0, N = Ordering.size(); i < N; i++) {
327 // Get the scheduling info
328 NodeInfo *NI = Ordering[i];
329 if (NI->isInGroup()) {
330 NodeGroupIterator NGI(Ordering[i]);
331 while (NodeInfo *NI = NGI.next()) EmitNode(NI);
338 /// isFlagDefiner - Returns true if the node defines a flag result.
339 static bool isFlagDefiner(SDNode *A) {
340 unsigned N = A->getNumValues();
341 return N && A->getValueType(N - 1) == MVT::Flag;
344 /// isFlagUser - Returns true if the node uses a flag result.
346 static bool isFlagUser(SDNode *A) {
347 unsigned N = A->getNumOperands();
348 return N && A->getOperand(N - 1).getValueType() == MVT::Flag;
351 /// printNI - Print node info.
353 void ScheduleDAG::printNI(std::ostream &O, NodeInfo *NI) const {
355 SDNode *Node = NI->Node;
357 << std::hex << Node << std::dec
358 << ", Lat=" << NI->Latency
359 << ", Slot=" << NI->Slot
360 << ", ARITY=(" << Node->getNumOperands() << ","
361 << Node->getNumValues() << ")"
362 << " " << Node->getOperationName(&DAG);
363 if (isFlagDefiner(Node)) O << "<#";
364 if (isFlagUser(Node)) O << ">#";
368 /// printChanges - Hilight changes in order caused by scheduling.
370 void ScheduleDAG::printChanges(unsigned Index) const {
372 // Get the ordered node count
373 unsigned N = Ordering.size();
374 // Determine if any changes
377 NodeInfo *NI = Ordering[i];
378 if (NI->Preorder != i) break;
382 std::cerr << Index << ". New Ordering\n";
384 for (i = 0; i < N; i++) {
385 NodeInfo *NI = Ordering[i];
386 std::cerr << " " << NI->Preorder << ". ";
387 printNI(std::cerr, NI);
389 if (NI->isGroupDominator()) {
390 NodeGroup *Group = NI->Group;
391 for (NIIterator NII = Group->group_begin(), E = Group->group_end();
394 printNI(std::cerr, *NII);
400 std::cerr << Index << ". No Changes\n";
405 /// print - Print ordering to specified output stream.
407 void ScheduleDAG::print(std::ostream &O) const {
411 for (unsigned i = 0, N = Ordering.size(); i < N; i++) {
412 NodeInfo *NI = Ordering[i];
415 if (NI->isGroupDominator()) {
416 NodeGroup *Group = NI->Group;
417 for (NIIterator NII = Group->group_begin(), E = Group->group_end();
428 void ScheduleDAG::dump(const char *tag) const {
429 std::cerr << tag; dump();
432 void ScheduleDAG::dump() const {
436 /// Run - perform scheduling.
438 MachineBasicBlock *ScheduleDAG::Run() {
439 TII = TM.getInstrInfo();
440 MRI = TM.getRegisterInfo();
441 RegMap = BB->getParent()->getSSARegMap();
442 ConstPool = BB->getParent()->getConstantPool();
445 NodeCount = std::distance(DAG.allnodes_begin(), DAG.allnodes_end());
446 // Set up minimum info for scheduling
448 // Construct node groups for flagged nodes
456 /// CountInternalUses - Returns the number of edges between the two nodes.
458 static unsigned CountInternalUses(NodeInfo *D, NodeInfo *U) {
460 for (unsigned M = U->Node->getNumOperands(); 0 < M--;) {
461 SDOperand Op = U->Node->getOperand(M);
462 if (Op.Val == D->Node) N++;
468 //===----------------------------------------------------------------------===//
469 /// Add - Adds a definer and user pair to a node group.
471 void NodeGroup::Add(NodeInfo *D, NodeInfo *U) {
472 // Get current groups
473 NodeGroup *DGroup = D->Group;
474 NodeGroup *UGroup = U->Group;
475 // If both are members of groups
476 if (DGroup && UGroup) {
477 // There may have been another edge connecting
478 if (DGroup == UGroup) return;
479 // Add the pending users count
480 DGroup->addPending(UGroup->getPending());
481 // For each member of the users group
482 NodeGroupIterator UNGI(U);
483 while (NodeInfo *UNI = UNGI.next() ) {
486 // For each member of the definers group
487 NodeGroupIterator DNGI(D);
488 while (NodeInfo *DNI = DNGI.next() ) {
489 // Remove internal edges
490 DGroup->addPending(-CountInternalUses(DNI, UNI));
493 // Merge the two lists
494 DGroup->group_insert(DGroup->group_end(),
495 UGroup->group_begin(), UGroup->group_end());
497 // Make user member of definers group
499 // Add users uses to definers group pending
500 DGroup->addPending(U->Node->use_size());
501 // For each member of the definers group
502 NodeGroupIterator DNGI(D);
503 while (NodeInfo *DNI = DNGI.next() ) {
504 // Remove internal edges
505 DGroup->addPending(-CountInternalUses(DNI, U));
507 DGroup->group_push_back(U);
509 // Make definer member of users group
511 // Add definers uses to users group pending
512 UGroup->addPending(D->Node->use_size());
513 // For each member of the users group
514 NodeGroupIterator UNGI(U);
515 while (NodeInfo *UNI = UNGI.next() ) {
516 // Remove internal edges
517 UGroup->addPending(-CountInternalUses(D, UNI));
519 UGroup->group_insert(UGroup->group_begin(), D);
521 D->Group = U->Group = DGroup = new NodeGroup();
522 DGroup->addPending(D->Node->use_size() + U->Node->use_size() -
523 CountInternalUses(D, U));
524 DGroup->group_push_back(D);
525 DGroup->group_push_back(U);