InstrEmitter.cpp revision f59514152511694d46ca8b8d2db466d256ab5759
1//==--- InstrEmitter.cpp - Emit MachineInstrs for the SelectionDAG class ---==//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This implements the Emit routines for the SelectionDAG class, which creates
11// MachineInstrs based on the decisions of the SelectionDAG instruction
12// selection.
13//
14//===----------------------------------------------------------------------===//
15
16#define DEBUG_TYPE "instr-emitter"
17#include "InstrEmitter.h"
18#include "SDNodeDbgValue.h"
19#include "llvm/CodeGen/MachineConstantPool.h"
20#include "llvm/CodeGen/MachineFunction.h"
21#include "llvm/CodeGen/MachineInstrBuilder.h"
22#include "llvm/CodeGen/MachineRegisterInfo.h"
23#include "llvm/Target/TargetData.h"
24#include "llvm/Target/TargetMachine.h"
25#include "llvm/Target/TargetInstrInfo.h"
26#include "llvm/Target/TargetLowering.h"
27#include "llvm/ADT/Statistic.h"
28#include "llvm/Support/Debug.h"
29#include "llvm/Support/ErrorHandling.h"
30#include "llvm/Support/MathExtras.h"
31using namespace llvm;
32
33/// CountResults - The results of target nodes have register or immediate
34/// operands first, then an optional chain, and optional flag operands (which do
35/// not go into the resulting MachineInstr).
36unsigned InstrEmitter::CountResults(SDNode *Node) {
37  unsigned N = Node->getNumValues();
38  while (N && Node->getValueType(N - 1) == MVT::Flag)
39    --N;
40  if (N && Node->getValueType(N - 1) == MVT::Other)
41    --N;    // Skip over chain result.
42  return N;
43}
44
45/// CountOperands - The inputs to target nodes have any actual inputs first,
46/// followed by an optional chain operand, then an optional flag operand.
47/// Compute the number of actual operands that will go into the resulting
48/// MachineInstr.
49unsigned InstrEmitter::CountOperands(SDNode *Node) {
50  unsigned N = Node->getNumOperands();
51  while (N && Node->getOperand(N - 1).getValueType() == MVT::Flag)
52    --N;
53  if (N && Node->getOperand(N - 1).getValueType() == MVT::Other)
54    --N; // Ignore chain if it exists.
55  return N;
56}
57
58/// EmitCopyFromReg - Generate machine code for an CopyFromReg node or an
59/// implicit physical register output.
60void InstrEmitter::
61EmitCopyFromReg(SDNode *Node, unsigned ResNo, bool IsClone, bool IsCloned,
62                unsigned SrcReg, DenseMap<SDValue, unsigned> &VRBaseMap) {
63  unsigned VRBase = 0;
64  if (TargetRegisterInfo::isVirtualRegister(SrcReg)) {
65    // Just use the input register directly!
66    SDValue Op(Node, ResNo);
67    if (IsClone)
68      VRBaseMap.erase(Op);
69    bool isNew = VRBaseMap.insert(std::make_pair(Op, SrcReg)).second;
70    isNew = isNew; // Silence compiler warning.
71    assert(isNew && "Node emitted out of order - early");
72    return;
73  }
74
75  // If the node is only used by a CopyToReg and the dest reg is a vreg, use
76  // the CopyToReg'd destination register instead of creating a new vreg.
77  bool MatchReg = true;
78  const TargetRegisterClass *UseRC = NULL;
79  if (!IsClone && !IsCloned)
80    for (SDNode::use_iterator UI = Node->use_begin(), E = Node->use_end();
81         UI != E; ++UI) {
82      SDNode *User = *UI;
83      bool Match = true;
84      if (User->getOpcode() == ISD::CopyToReg &&
85          User->getOperand(2).getNode() == Node &&
86          User->getOperand(2).getResNo() == ResNo) {
87        unsigned DestReg = cast<RegisterSDNode>(User->getOperand(1))->getReg();
88        if (TargetRegisterInfo::isVirtualRegister(DestReg)) {
89          VRBase = DestReg;
90          Match = false;
91        } else if (DestReg != SrcReg)
92          Match = false;
93      } else {
94        for (unsigned i = 0, e = User->getNumOperands(); i != e; ++i) {
95          SDValue Op = User->getOperand(i);
96          if (Op.getNode() != Node || Op.getResNo() != ResNo)
97            continue;
98          EVT VT = Node->getValueType(Op.getResNo());
99          if (VT == MVT::Other || VT == MVT::Flag)
100            continue;
101          Match = false;
102          if (User->isMachineOpcode()) {
103            const TargetInstrDesc &II = TII->get(User->getMachineOpcode());
104            const TargetRegisterClass *RC = 0;
105            if (i+II.getNumDefs() < II.getNumOperands())
106              RC = II.OpInfo[i+II.getNumDefs()].getRegClass(TRI);
107            if (!UseRC)
108              UseRC = RC;
109            else if (RC) {
110              const TargetRegisterClass *ComRC = getCommonSubClass(UseRC, RC);
111              // If multiple uses expect disjoint register classes, we emit
112              // copies in AddRegisterOperand.
113              if (ComRC)
114                UseRC = ComRC;
115            }
116          }
117        }
118      }
119      MatchReg &= Match;
120      if (VRBase)
121        break;
122    }
123
124  EVT VT = Node->getValueType(ResNo);
125  const TargetRegisterClass *SrcRC = 0, *DstRC = 0;
126  SrcRC = TRI->getMinimalPhysRegClass(SrcReg, VT);
127
128  // Figure out the register class to create for the destreg.
129  if (VRBase) {
130    DstRC = MRI->getRegClass(VRBase);
131  } else if (UseRC) {
132    assert(UseRC->hasType(VT) && "Incompatible phys register def and uses!");
133    DstRC = UseRC;
134  } else {
135    DstRC = TLI->getRegClassFor(VT);
136  }
137
138  // If all uses are reading from the src physical register and copying the
139  // register is either impossible or very expensive, then don't create a copy.
140  if (MatchReg && SrcRC->getCopyCost() < 0) {
141    VRBase = SrcReg;
142  } else {
143    // Create the reg, emit the copy.
144    VRBase = MRI->createVirtualRegister(DstRC);
145    bool Emitted = TII->copyRegToReg(*MBB, InsertPos, VRBase, SrcReg,
146                                     DstRC, SrcRC, Node->getDebugLoc());
147
148    assert(Emitted && "Unable to issue a copy instruction!\n");
149    (void) Emitted;
150  }
151
152  SDValue Op(Node, ResNo);
153  if (IsClone)
154    VRBaseMap.erase(Op);
155  bool isNew = VRBaseMap.insert(std::make_pair(Op, VRBase)).second;
156  isNew = isNew; // Silence compiler warning.
157  assert(isNew && "Node emitted out of order - early");
158}
159
160/// getDstOfCopyToRegUse - If the only use of the specified result number of
161/// node is a CopyToReg, return its destination register. Return 0 otherwise.
162unsigned InstrEmitter::getDstOfOnlyCopyToRegUse(SDNode *Node,
163                                                unsigned ResNo) const {
164  if (!Node->hasOneUse())
165    return 0;
166
167  SDNode *User = *Node->use_begin();
168  if (User->getOpcode() == ISD::CopyToReg &&
169      User->getOperand(2).getNode() == Node &&
170      User->getOperand(2).getResNo() == ResNo) {
171    unsigned Reg = cast<RegisterSDNode>(User->getOperand(1))->getReg();
172    if (TargetRegisterInfo::isVirtualRegister(Reg))
173      return Reg;
174  }
175  return 0;
176}
177
178void InstrEmitter::CreateVirtualRegisters(SDNode *Node, MachineInstr *MI,
179                                       const TargetInstrDesc &II,
180                                       bool IsClone, bool IsCloned,
181                                       DenseMap<SDValue, unsigned> &VRBaseMap) {
182  assert(Node->getMachineOpcode() != TargetOpcode::IMPLICIT_DEF &&
183         "IMPLICIT_DEF should have been handled as a special case elsewhere!");
184
185  for (unsigned i = 0; i < II.getNumDefs(); ++i) {
186    // If the specific node value is only used by a CopyToReg and the dest reg
187    // is a vreg in the same register class, use the CopyToReg'd destination
188    // register instead of creating a new vreg.
189    unsigned VRBase = 0;
190    const TargetRegisterClass *RC = II.OpInfo[i].getRegClass(TRI);
191    if (II.OpInfo[i].isOptionalDef()) {
192      // Optional def must be a physical register.
193      unsigned NumResults = CountResults(Node);
194      VRBase = cast<RegisterSDNode>(Node->getOperand(i-NumResults))->getReg();
195      assert(TargetRegisterInfo::isPhysicalRegister(VRBase));
196      MI->addOperand(MachineOperand::CreateReg(VRBase, true));
197    }
198
199    if (!VRBase && !IsClone && !IsCloned)
200      for (SDNode::use_iterator UI = Node->use_begin(), E = Node->use_end();
201           UI != E; ++UI) {
202        SDNode *User = *UI;
203        if (User->getOpcode() == ISD::CopyToReg &&
204            User->getOperand(2).getNode() == Node &&
205            User->getOperand(2).getResNo() == i) {
206          unsigned Reg = cast<RegisterSDNode>(User->getOperand(1))->getReg();
207          if (TargetRegisterInfo::isVirtualRegister(Reg)) {
208            const TargetRegisterClass *RegRC = MRI->getRegClass(Reg);
209            if (RegRC == RC) {
210              VRBase = Reg;
211              MI->addOperand(MachineOperand::CreateReg(Reg, true));
212              break;
213            }
214          }
215        }
216      }
217
218    // Create the result registers for this node and add the result regs to
219    // the machine instruction.
220    if (VRBase == 0) {
221      assert(RC && "Isn't a register operand!");
222      VRBase = MRI->createVirtualRegister(RC);
223      MI->addOperand(MachineOperand::CreateReg(VRBase, true));
224    }
225
226    SDValue Op(Node, i);
227    if (IsClone)
228      VRBaseMap.erase(Op);
229    bool isNew = VRBaseMap.insert(std::make_pair(Op, VRBase)).second;
230    isNew = isNew; // Silence compiler warning.
231    assert(isNew && "Node emitted out of order - early");
232  }
233}
234
235/// getVR - Return the virtual register corresponding to the specified result
236/// of the specified node.
237unsigned InstrEmitter::getVR(SDValue Op,
238                             DenseMap<SDValue, unsigned> &VRBaseMap) {
239  if (Op.isMachineOpcode() &&
240      Op.getMachineOpcode() == TargetOpcode::IMPLICIT_DEF) {
241    // Add an IMPLICIT_DEF instruction before every use.
242    unsigned VReg = getDstOfOnlyCopyToRegUse(Op.getNode(), Op.getResNo());
243    // IMPLICIT_DEF can produce any type of result so its TargetInstrDesc
244    // does not include operand register class info.
245    if (!VReg) {
246      const TargetRegisterClass *RC = TLI->getRegClassFor(Op.getValueType());
247      VReg = MRI->createVirtualRegister(RC);
248    }
249    BuildMI(MBB, Op.getDebugLoc(),
250            TII->get(TargetOpcode::IMPLICIT_DEF), VReg);
251    return VReg;
252  }
253
254  DenseMap<SDValue, unsigned>::iterator I = VRBaseMap.find(Op);
255  assert(I != VRBaseMap.end() && "Node emitted out of order - late");
256  return I->second;
257}
258
259
260/// AddRegisterOperand - Add the specified register as an operand to the
261/// specified machine instr. Insert register copies if the register is
262/// not in the required register class.
263void
264InstrEmitter::AddRegisterOperand(MachineInstr *MI, SDValue Op,
265                                 unsigned IIOpNum,
266                                 const TargetInstrDesc *II,
267                                 DenseMap<SDValue, unsigned> &VRBaseMap,
268                                 bool IsDebug, bool IsClone, bool IsCloned) {
269  assert(Op.getValueType() != MVT::Other &&
270         Op.getValueType() != MVT::Flag &&
271         "Chain and flag operands should occur at end of operand list!");
272  // Get/emit the operand.
273  unsigned VReg = getVR(Op, VRBaseMap);
274  assert(TargetRegisterInfo::isVirtualRegister(VReg) && "Not a vreg?");
275
276  const TargetInstrDesc &TID = MI->getDesc();
277  bool isOptDef = IIOpNum < TID.getNumOperands() &&
278    TID.OpInfo[IIOpNum].isOptionalDef();
279
280  // If the instruction requires a register in a different class, create
281  // a new virtual register and copy the value into it.
282  if (II) {
283    const TargetRegisterClass *SrcRC = MRI->getRegClass(VReg);
284    const TargetRegisterClass *DstRC = 0;
285    if (IIOpNum < II->getNumOperands())
286      DstRC = II->OpInfo[IIOpNum].getRegClass(TRI);
287    assert((DstRC || (TID.isVariadic() && IIOpNum >= TID.getNumOperands())) &&
288           "Don't have operand info for this instruction!");
289    if (DstRC && SrcRC != DstRC && !SrcRC->hasSuperClass(DstRC)) {
290      unsigned NewVReg = MRI->createVirtualRegister(DstRC);
291      bool Emitted = TII->copyRegToReg(*MBB, InsertPos, NewVReg, VReg,
292                                       DstRC, SrcRC, Op.getNode()->getDebugLoc());
293      assert(Emitted && "Unable to issue a copy instruction!\n");
294      (void) Emitted;
295      VReg = NewVReg;
296    }
297  }
298
299  // If this value has only one use, that use is a kill. This is a
300  // conservative approximation. InstrEmitter does trivial coalescing
301  // with CopyFromReg nodes, so don't emit kill flags for them.
302  // Avoid kill flags on Schedule cloned nodes, since there will be
303  // multiple uses.
304  // Tied operands are never killed, so we need to check that. And that
305  // means we need to determine the index of the operand.
306  bool isKill = Op.hasOneUse() &&
307                Op.getNode()->getOpcode() != ISD::CopyFromReg &&
308                !IsDebug &&
309                !(IsClone || IsCloned);
310  if (isKill) {
311    unsigned Idx = MI->getNumOperands();
312    while (Idx > 0 &&
313           MI->getOperand(Idx-1).isReg() && MI->getOperand(Idx-1).isImplicit())
314      --Idx;
315    bool isTied = MI->getDesc().getOperandConstraint(Idx, TOI::TIED_TO) != -1;
316    if (isTied)
317      isKill = false;
318  }
319
320  MI->addOperand(MachineOperand::CreateReg(VReg, isOptDef,
321                                           false/*isImp*/, isKill,
322                                           false/*isDead*/, false/*isUndef*/,
323                                           false/*isEarlyClobber*/,
324                                           0/*SubReg*/, IsDebug));
325}
326
327/// AddOperand - Add the specified operand to the specified machine instr.  II
328/// specifies the instruction information for the node, and IIOpNum is the
329/// operand number (in the II) that we are adding. IIOpNum and II are used for
330/// assertions only.
331void InstrEmitter::AddOperand(MachineInstr *MI, SDValue Op,
332                              unsigned IIOpNum,
333                              const TargetInstrDesc *II,
334                              DenseMap<SDValue, unsigned> &VRBaseMap,
335                              bool IsDebug, bool IsClone, bool IsCloned) {
336  if (Op.isMachineOpcode()) {
337    AddRegisterOperand(MI, Op, IIOpNum, II, VRBaseMap,
338                       IsDebug, IsClone, IsCloned);
339  } else if (ConstantSDNode *C = dyn_cast<ConstantSDNode>(Op)) {
340    MI->addOperand(MachineOperand::CreateImm(C->getSExtValue()));
341  } else if (ConstantFPSDNode *F = dyn_cast<ConstantFPSDNode>(Op)) {
342    const ConstantFP *CFP = F->getConstantFPValue();
343    MI->addOperand(MachineOperand::CreateFPImm(CFP));
344  } else if (RegisterSDNode *R = dyn_cast<RegisterSDNode>(Op)) {
345    MI->addOperand(MachineOperand::CreateReg(R->getReg(), false));
346  } else if (GlobalAddressSDNode *TGA = dyn_cast<GlobalAddressSDNode>(Op)) {
347    MI->addOperand(MachineOperand::CreateGA(TGA->getGlobal(), TGA->getOffset(),
348                                            TGA->getTargetFlags()));
349  } else if (BasicBlockSDNode *BBNode = dyn_cast<BasicBlockSDNode>(Op)) {
350    MI->addOperand(MachineOperand::CreateMBB(BBNode->getBasicBlock()));
351  } else if (FrameIndexSDNode *FI = dyn_cast<FrameIndexSDNode>(Op)) {
352    MI->addOperand(MachineOperand::CreateFI(FI->getIndex()));
353  } else if (JumpTableSDNode *JT = dyn_cast<JumpTableSDNode>(Op)) {
354    MI->addOperand(MachineOperand::CreateJTI(JT->getIndex(),
355                                             JT->getTargetFlags()));
356  } else if (ConstantPoolSDNode *CP = dyn_cast<ConstantPoolSDNode>(Op)) {
357    int Offset = CP->getOffset();
358    unsigned Align = CP->getAlignment();
359    const Type *Type = CP->getType();
360    // MachineConstantPool wants an explicit alignment.
361    if (Align == 0) {
362      Align = TM->getTargetData()->getPrefTypeAlignment(Type);
363      if (Align == 0) {
364        // Alignment of vector types.  FIXME!
365        Align = TM->getTargetData()->getTypeAllocSize(Type);
366      }
367    }
368
369    unsigned Idx;
370    MachineConstantPool *MCP = MF->getConstantPool();
371    if (CP->isMachineConstantPoolEntry())
372      Idx = MCP->getConstantPoolIndex(CP->getMachineCPVal(), Align);
373    else
374      Idx = MCP->getConstantPoolIndex(CP->getConstVal(), Align);
375    MI->addOperand(MachineOperand::CreateCPI(Idx, Offset,
376                                             CP->getTargetFlags()));
377  } else if (ExternalSymbolSDNode *ES = dyn_cast<ExternalSymbolSDNode>(Op)) {
378    MI->addOperand(MachineOperand::CreateES(ES->getSymbol(),
379                                            ES->getTargetFlags()));
380  } else if (BlockAddressSDNode *BA = dyn_cast<BlockAddressSDNode>(Op)) {
381    MI->addOperand(MachineOperand::CreateBA(BA->getBlockAddress(),
382                                            BA->getTargetFlags()));
383  } else {
384    assert(Op.getValueType() != MVT::Other &&
385           Op.getValueType() != MVT::Flag &&
386           "Chain and flag operands should occur at end of operand list!");
387    AddRegisterOperand(MI, Op, IIOpNum, II, VRBaseMap,
388                       IsDebug, IsClone, IsCloned);
389  }
390}
391
392/// getSuperRegisterRegClass - Returns the register class of a superreg A whose
393/// "SubIdx"'th sub-register class is the specified register class and whose
394/// type matches the specified type.
395static const TargetRegisterClass*
396getSuperRegisterRegClass(const TargetRegisterClass *TRC,
397                         unsigned SubIdx, EVT VT) {
398  // Pick the register class of the superegister for this type
399  for (TargetRegisterInfo::regclass_iterator I = TRC->superregclasses_begin(),
400         E = TRC->superregclasses_end(); I != E; ++I)
401    if ((*I)->hasType(VT) && (*I)->getSubRegisterRegClass(SubIdx) == TRC)
402      return *I;
403  assert(false && "Couldn't find the register class");
404  return 0;
405}
406
407/// EmitSubregNode - Generate machine code for subreg nodes.
408///
409void InstrEmitter::EmitSubregNode(SDNode *Node,
410                                  DenseMap<SDValue, unsigned> &VRBaseMap,
411                                  bool IsClone, bool IsCloned) {
412  unsigned VRBase = 0;
413  unsigned Opc = Node->getMachineOpcode();
414
415  // If the node is only used by a CopyToReg and the dest reg is a vreg, use
416  // the CopyToReg'd destination register instead of creating a new vreg.
417  for (SDNode::use_iterator UI = Node->use_begin(), E = Node->use_end();
418       UI != E; ++UI) {
419    SDNode *User = *UI;
420    if (User->getOpcode() == ISD::CopyToReg &&
421        User->getOperand(2).getNode() == Node) {
422      unsigned DestReg = cast<RegisterSDNode>(User->getOperand(1))->getReg();
423      if (TargetRegisterInfo::isVirtualRegister(DestReg)) {
424        VRBase = DestReg;
425        break;
426      }
427    }
428  }
429
430  if (Opc == TargetOpcode::EXTRACT_SUBREG) {
431    unsigned SubIdx = cast<ConstantSDNode>(Node->getOperand(1))->getZExtValue();
432
433    // Create the extract_subreg machine instruction.
434    MachineInstr *MI = BuildMI(*MF, Node->getDebugLoc(),
435                               TII->get(TargetOpcode::EXTRACT_SUBREG));
436
437    // Figure out the register class to create for the destreg.
438    unsigned VReg = getVR(Node->getOperand(0), VRBaseMap);
439    const TargetRegisterClass *TRC = MRI->getRegClass(VReg);
440    const TargetRegisterClass *SRC = TRC->getSubRegisterRegClass(SubIdx);
441    assert(SRC && "Invalid subregister index in EXTRACT_SUBREG");
442
443    // Figure out the register class to create for the destreg.
444    // Note that if we're going to directly use an existing register,
445    // it must be precisely the required class, and not a subclass
446    // thereof.
447    if (VRBase == 0 || SRC != MRI->getRegClass(VRBase)) {
448      // Create the reg
449      assert(SRC && "Couldn't find source register class");
450      VRBase = MRI->createVirtualRegister(SRC);
451    }
452
453    // Add def, source, and subreg index
454    MI->addOperand(MachineOperand::CreateReg(VRBase, true));
455    AddOperand(MI, Node->getOperand(0), 0, 0, VRBaseMap, /*IsDebug=*/false,
456               IsClone, IsCloned);
457    MI->addOperand(MachineOperand::CreateImm(SubIdx));
458    MBB->insert(InsertPos, MI);
459  } else if (Opc == TargetOpcode::INSERT_SUBREG ||
460             Opc == TargetOpcode::SUBREG_TO_REG) {
461    SDValue N0 = Node->getOperand(0);
462    SDValue N1 = Node->getOperand(1);
463    SDValue N2 = Node->getOperand(2);
464    unsigned SubReg = getVR(N1, VRBaseMap);
465    unsigned SubIdx = cast<ConstantSDNode>(N2)->getZExtValue();
466    const TargetRegisterClass *TRC = MRI->getRegClass(SubReg);
467    const TargetRegisterClass *SRC =
468      getSuperRegisterRegClass(TRC, SubIdx, Node->getValueType(0));
469
470    // Figure out the register class to create for the destreg.
471    // Note that if we're going to directly use an existing register,
472    // it must be precisely the required class, and not a subclass
473    // thereof.
474    if (VRBase == 0 || SRC != MRI->getRegClass(VRBase)) {
475      // Create the reg
476      assert(SRC && "Couldn't find source register class");
477      VRBase = MRI->createVirtualRegister(SRC);
478    }
479
480    // Create the insert_subreg or subreg_to_reg machine instruction.
481    MachineInstr *MI = BuildMI(*MF, Node->getDebugLoc(), TII->get(Opc));
482    MI->addOperand(MachineOperand::CreateReg(VRBase, true));
483
484    // If creating a subreg_to_reg, then the first input operand
485    // is an implicit value immediate, otherwise it's a register
486    if (Opc == TargetOpcode::SUBREG_TO_REG) {
487      const ConstantSDNode *SD = cast<ConstantSDNode>(N0);
488      MI->addOperand(MachineOperand::CreateImm(SD->getZExtValue()));
489    } else
490      AddOperand(MI, N0, 0, 0, VRBaseMap, /*IsDebug=*/false,
491                 IsClone, IsCloned);
492    // Add the subregster being inserted
493    AddOperand(MI, N1, 0, 0, VRBaseMap, /*IsDebug=*/false,
494               IsClone, IsCloned);
495    MI->addOperand(MachineOperand::CreateImm(SubIdx));
496    MBB->insert(InsertPos, MI);
497  } else
498    llvm_unreachable("Node is not insert_subreg, extract_subreg, or subreg_to_reg");
499
500  SDValue Op(Node, 0);
501  bool isNew = VRBaseMap.insert(std::make_pair(Op, VRBase)).second;
502  isNew = isNew; // Silence compiler warning.
503  assert(isNew && "Node emitted out of order - early");
504}
505
506/// EmitCopyToRegClassNode - Generate machine code for COPY_TO_REGCLASS nodes.
507/// COPY_TO_REGCLASS is just a normal copy, except that the destination
508/// register is constrained to be in a particular register class.
509///
510void
511InstrEmitter::EmitCopyToRegClassNode(SDNode *Node,
512                                     DenseMap<SDValue, unsigned> &VRBaseMap) {
513  unsigned VReg = getVR(Node->getOperand(0), VRBaseMap);
514  const TargetRegisterClass *SrcRC = MRI->getRegClass(VReg);
515
516  unsigned DstRCIdx = cast<ConstantSDNode>(Node->getOperand(1))->getZExtValue();
517  const TargetRegisterClass *DstRC = TRI->getRegClass(DstRCIdx);
518
519  // Create the new VReg in the destination class and emit a copy.
520  unsigned NewVReg = MRI->createVirtualRegister(DstRC);
521  bool Emitted = TII->copyRegToReg(*MBB, InsertPos, NewVReg, VReg,
522                                   DstRC, SrcRC, Node->getDebugLoc());
523  assert(Emitted &&
524         "Unable to issue a copy instruction for a COPY_TO_REGCLASS node!\n");
525  (void) Emitted;
526
527  SDValue Op(Node, 0);
528  bool isNew = VRBaseMap.insert(std::make_pair(Op, NewVReg)).second;
529  isNew = isNew; // Silence compiler warning.
530  assert(isNew && "Node emitted out of order - early");
531}
532
533/// EmitRegSequence - Generate machine code for REG_SEQUENCE nodes.
534///
535void InstrEmitter::EmitRegSequence(SDNode *Node,
536                                  DenseMap<SDValue, unsigned> &VRBaseMap,
537                                  bool IsClone, bool IsCloned) {
538  const TargetRegisterClass *RC = TLI->getRegClassFor(Node->getValueType(0));
539  unsigned NewVReg = MRI->createVirtualRegister(RC);
540  MachineInstr *MI = BuildMI(*MF, Node->getDebugLoc(),
541                             TII->get(TargetOpcode::REG_SEQUENCE), NewVReg);
542  unsigned NumOps = Node->getNumOperands();
543  assert((NumOps & 1) == 0 &&
544         "REG_SEQUENCE must have an even number of operands!");
545  const TargetInstrDesc &II = TII->get(TargetOpcode::REG_SEQUENCE);
546  for (unsigned i = 0; i != NumOps; ++i) {
547    SDValue Op = Node->getOperand(i);
548    if (i & 1) {
549      unsigned SubIdx = cast<ConstantSDNode>(Op)->getZExtValue();
550      unsigned SubReg = getVR(Node->getOperand(i-1), VRBaseMap);
551      const TargetRegisterClass *TRC = MRI->getRegClass(SubReg);
552      const TargetRegisterClass *SRC =
553        TRI->getMatchingSuperRegClass(RC, TRC, SubIdx);
554      if (!SRC)
555        llvm_unreachable("Invalid subregister index in REG_SEQUENCE");
556      if (SRC != RC) {
557        MRI->setRegClass(NewVReg, SRC);
558        RC = SRC;
559      }
560    }
561    AddOperand(MI, Op, i+1, &II, VRBaseMap, /*IsDebug=*/false,
562               IsClone, IsCloned);
563  }
564
565  MBB->insert(InsertPos, MI);
566  SDValue Op(Node, 0);
567  bool isNew = VRBaseMap.insert(std::make_pair(Op, NewVReg)).second;
568  isNew = isNew; // Silence compiler warning.
569  assert(isNew && "Node emitted out of order - early");
570}
571
572/// EmitDbgValue - Generate machine instruction for a dbg_value node.
573///
574MachineInstr *
575InstrEmitter::EmitDbgValue(SDDbgValue *SD,
576                           DenseMap<SDValue, unsigned> &VRBaseMap) {
577  uint64_t Offset = SD->getOffset();
578  MDNode* MDPtr = SD->getMDPtr();
579  DebugLoc DL = SD->getDebugLoc();
580
581  if (SD->getKind() == SDDbgValue::FRAMEIX) {
582    // Stack address; this needs to be lowered in target-dependent fashion.
583    // EmitTargetCodeForFrameDebugValue is responsible for allocation.
584    unsigned FrameIx = SD->getFrameIx();
585    return TII->emitFrameIndexDebugValue(*MF, FrameIx, Offset, MDPtr, DL);
586  }
587  // Otherwise, we're going to create an instruction here.
588  const TargetInstrDesc &II = TII->get(TargetOpcode::DBG_VALUE);
589  MachineInstrBuilder MIB = BuildMI(*MF, DL, II);
590  if (SD->getKind() == SDDbgValue::SDNODE) {
591    SDNode *Node = SD->getSDNode();
592    SDValue Op = SDValue(Node, SD->getResNo());
593    // It's possible we replaced this SDNode with other(s) and therefore
594    // didn't generate code for it.  It's better to catch these cases where
595    // they happen and transfer the debug info, but trying to guarantee that
596    // in all cases would be very fragile; this is a safeguard for any
597    // that were missed.
598    DenseMap<SDValue, unsigned>::iterator I = VRBaseMap.find(Op);
599    if (I==VRBaseMap.end())
600      MIB.addReg(0U);       // undef
601    else
602      AddOperand(&*MIB, Op, (*MIB).getNumOperands(), &II, VRBaseMap,
603                 /*IsDebug=*/true, /*IsClone=*/false, /*IsCloned=*/false);
604  } else if (SD->getKind() == SDDbgValue::CONST) {
605    const Value *V = SD->getConst();
606    if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
607      // FIXME: SDDbgValue constants aren't updated with legalization, so it's
608      // possible to have i128 constants in them at this point. Dwarf writer
609      // does not handle i128 constants at the moment so, as a crude workaround,
610      // just drop the debug info if this happens.
611      if (!CI->getValue().isSignedIntN(64))
612        MIB.addReg(0U);
613      else
614        MIB.addImm(CI->getSExtValue());
615    } else if (const ConstantFP *CF = dyn_cast<ConstantFP>(V)) {
616      MIB.addFPImm(CF);
617    } else {
618      // Could be an Undef.  In any case insert an Undef so we can see what we
619      // dropped.
620      MIB.addReg(0U);
621    }
622  } else {
623    // Insert an Undef so we can see what we dropped.
624    MIB.addReg(0U);
625  }
626
627  MIB.addImm(Offset).addMetadata(MDPtr);
628  return &*MIB;
629}
630
631/// EmitMachineNode - Generate machine code for a target-specific node and
632/// needed dependencies.
633///
634void InstrEmitter::
635EmitMachineNode(SDNode *Node, bool IsClone, bool IsCloned,
636                DenseMap<SDValue, unsigned> &VRBaseMap) {
637  unsigned Opc = Node->getMachineOpcode();
638
639  // Handle subreg insert/extract specially
640  if (Opc == TargetOpcode::EXTRACT_SUBREG ||
641      Opc == TargetOpcode::INSERT_SUBREG ||
642      Opc == TargetOpcode::SUBREG_TO_REG) {
643    EmitSubregNode(Node, VRBaseMap, IsClone, IsCloned);
644    return;
645  }
646
647  // Handle COPY_TO_REGCLASS specially.
648  if (Opc == TargetOpcode::COPY_TO_REGCLASS) {
649    EmitCopyToRegClassNode(Node, VRBaseMap);
650    return;
651  }
652
653  // Handle REG_SEQUENCE specially.
654  if (Opc == TargetOpcode::REG_SEQUENCE) {
655    EmitRegSequence(Node, VRBaseMap, IsClone, IsCloned);
656    return;
657  }
658
659  if (Opc == TargetOpcode::IMPLICIT_DEF)
660    // We want a unique VR for each IMPLICIT_DEF use.
661    return;
662
663  const TargetInstrDesc &II = TII->get(Opc);
664  unsigned NumResults = CountResults(Node);
665  unsigned NodeOperands = CountOperands(Node);
666  bool HasPhysRegOuts = NumResults > II.getNumDefs() && II.getImplicitDefs()!=0;
667#ifndef NDEBUG
668  unsigned NumMIOperands = NodeOperands + NumResults;
669  if (II.isVariadic())
670    assert(NumMIOperands >= II.getNumOperands() &&
671           "Too few operands for a variadic node!");
672  else
673    assert(NumMIOperands >= II.getNumOperands() &&
674           NumMIOperands <= II.getNumOperands()+II.getNumImplicitDefs() &&
675           "#operands for dag node doesn't match .td file!");
676#endif
677
678  // Create the new machine instruction.
679  MachineInstr *MI = BuildMI(*MF, Node->getDebugLoc(), II);
680
681  // The MachineInstr constructor adds implicit-def operands. Scan through
682  // these to determine which are dead.
683  if (MI->getNumOperands() != 0 &&
684      Node->getValueType(Node->getNumValues()-1) == MVT::Flag) {
685    // First, collect all used registers.
686    SmallVector<unsigned, 8> UsedRegs;
687    for (SDNode *F = Node->getFlaggedUser(); F; F = F->getFlaggedUser())
688      if (F->getOpcode() == ISD::CopyFromReg)
689        UsedRegs.push_back(cast<RegisterSDNode>(F->getOperand(1))->getReg());
690      else {
691        // Collect declared implicit uses.
692        const TargetInstrDesc &TID = TII->get(F->getMachineOpcode());
693        UsedRegs.append(TID.getImplicitUses(),
694                        TID.getImplicitUses() + TID.getNumImplicitUses());
695        // In addition to declared implicit uses, we must also check for
696        // direct RegisterSDNode operands.
697        for (unsigned i = 0, e = F->getNumOperands(); i != e; ++i)
698          if (RegisterSDNode *R = dyn_cast<RegisterSDNode>(F->getOperand(i))) {
699            unsigned Reg = R->getReg();
700            if (Reg != 0 && TargetRegisterInfo::isPhysicalRegister(Reg))
701              UsedRegs.push_back(Reg);
702          }
703      }
704    // Then mark unused registers as dead.
705    MI->setPhysRegsDeadExcept(UsedRegs, *TRI);
706  }
707
708  // Add result register values for things that are defined by this
709  // instruction.
710  if (NumResults)
711    CreateVirtualRegisters(Node, MI, II, IsClone, IsCloned, VRBaseMap);
712
713  // Emit all of the actual operands of this instruction, adding them to the
714  // instruction as appropriate.
715  bool HasOptPRefs = II.getNumDefs() > NumResults;
716  assert((!HasOptPRefs || !HasPhysRegOuts) &&
717         "Unable to cope with optional defs and phys regs defs!");
718  unsigned NumSkip = HasOptPRefs ? II.getNumDefs() - NumResults : 0;
719  for (unsigned i = NumSkip; i != NodeOperands; ++i)
720    AddOperand(MI, Node->getOperand(i), i-NumSkip+II.getNumDefs(), &II,
721               VRBaseMap, /*IsDebug=*/false, IsClone, IsCloned);
722
723  // Transfer all of the memory reference descriptions of this instruction.
724  MI->setMemRefs(cast<MachineSDNode>(Node)->memoperands_begin(),
725                 cast<MachineSDNode>(Node)->memoperands_end());
726
727  // Insert the instruction into position in the block. This needs to
728  // happen before any custom inserter hook is called so that the
729  // hook knows where in the block to insert the replacement code.
730  MBB->insert(InsertPos, MI);
731
732  if (II.usesCustomInsertionHook()) {
733    // Insert this instruction into the basic block using a target
734    // specific inserter which may returns a new basic block.
735    MBB = TLI->EmitInstrWithCustomInserter(MI, MBB);
736    InsertPos = MBB->end();
737    return;
738  }
739
740  // Additional results must be an physical register def.
741  if (HasPhysRegOuts) {
742    for (unsigned i = II.getNumDefs(); i < NumResults; ++i) {
743      unsigned Reg = II.getImplicitDefs()[i - II.getNumDefs()];
744      if (Node->hasAnyUseOfValue(i))
745        EmitCopyFromReg(Node, i, IsClone, IsCloned, Reg, VRBaseMap);
746      // If there are no uses, mark the register as dead now, so that
747      // MachineLICM/Sink can see that it's dead. Don't do this if the
748      // node has a Flag value, for the benefit of targets still using
749      // Flag for values in physregs.
750      else if (Node->getValueType(Node->getNumValues()-1) != MVT::Flag)
751        MI->addRegisterDead(Reg, TRI);
752    }
753  }
754
755  // If the instruction has implicit defs and the node doesn't, mark the
756  // implicit def as dead.  If the node has any flag outputs, we don't do this
757  // because we don't know what implicit defs are being used by flagged nodes.
758  if (Node->getValueType(Node->getNumValues()-1) != MVT::Flag)
759    if (const unsigned *IDList = II.getImplicitDefs()) {
760      for (unsigned i = NumResults, e = II.getNumDefs()+II.getNumImplicitDefs();
761           i != e; ++i)
762        MI->addRegisterDead(IDList[i-II.getNumDefs()], TRI);
763    }
764}
765
766/// EmitSpecialNode - Generate machine code for a target-independent node and
767/// needed dependencies.
768void InstrEmitter::
769EmitSpecialNode(SDNode *Node, bool IsClone, bool IsCloned,
770                DenseMap<SDValue, unsigned> &VRBaseMap) {
771  switch (Node->getOpcode()) {
772  default:
773#ifndef NDEBUG
774    Node->dump();
775#endif
776    llvm_unreachable("This target-independent node should have been selected!");
777    break;
778  case ISD::EntryToken:
779    llvm_unreachable("EntryToken should have been excluded from the schedule!");
780    break;
781  case ISD::MERGE_VALUES:
782  case ISD::TokenFactor: // fall thru
783    break;
784  case ISD::CopyToReg: {
785    unsigned SrcReg;
786    SDValue SrcVal = Node->getOperand(2);
787    if (RegisterSDNode *R = dyn_cast<RegisterSDNode>(SrcVal))
788      SrcReg = R->getReg();
789    else
790      SrcReg = getVR(SrcVal, VRBaseMap);
791
792    unsigned DestReg = cast<RegisterSDNode>(Node->getOperand(1))->getReg();
793    if (SrcReg == DestReg) // Coalesced away the copy? Ignore.
794      break;
795
796    const TargetRegisterClass *SrcTRC = 0, *DstTRC = 0;
797    // Get the register classes of the src/dst.
798    if (TargetRegisterInfo::isVirtualRegister(SrcReg))
799      SrcTRC = MRI->getRegClass(SrcReg);
800    else
801      SrcTRC = TRI->getMinimalPhysRegClass(SrcReg,SrcVal.getValueType());
802
803    if (TargetRegisterInfo::isVirtualRegister(DestReg))
804      DstTRC = MRI->getRegClass(DestReg);
805    else
806      DstTRC = TRI->getMinimalPhysRegClass(DestReg,
807                                           Node->getOperand(1).getValueType());
808
809    bool Emitted = TII->copyRegToReg(*MBB, InsertPos, DestReg, SrcReg,
810                                     DstTRC, SrcTRC, Node->getDebugLoc());
811    assert(Emitted && "Unable to issue a copy instruction!\n");
812    (void) Emitted;
813    break;
814  }
815  case ISD::CopyFromReg: {
816    unsigned SrcReg = cast<RegisterSDNode>(Node->getOperand(1))->getReg();
817    EmitCopyFromReg(Node, 0, IsClone, IsCloned, SrcReg, VRBaseMap);
818    break;
819  }
820  case ISD::EH_LABEL: {
821    MCSymbol *S = cast<EHLabelSDNode>(Node)->getLabel();
822    BuildMI(*MBB, InsertPos, Node->getDebugLoc(),
823            TII->get(TargetOpcode::EH_LABEL)).addSym(S);
824    break;
825  }
826
827  case ISD::INLINEASM: {
828    unsigned NumOps = Node->getNumOperands();
829    if (Node->getOperand(NumOps-1).getValueType() == MVT::Flag)
830      --NumOps;  // Ignore the flag operand.
831
832    // Create the inline asm machine instruction.
833    MachineInstr *MI = BuildMI(*MF, Node->getDebugLoc(),
834                               TII->get(TargetOpcode::INLINEASM));
835
836    // Add the asm string as an external symbol operand.
837    SDValue AsmStrV = Node->getOperand(InlineAsm::Op_AsmString);
838    const char *AsmStr = cast<ExternalSymbolSDNode>(AsmStrV)->getSymbol();
839    MI->addOperand(MachineOperand::CreateES(AsmStr));
840
841    // Add the isAlignStack bit.
842    int64_t isAlignStack =
843      cast<ConstantSDNode>(Node->getOperand(InlineAsm::Op_IsAlignStack))->
844                          getZExtValue();
845    MI->addOperand(MachineOperand::CreateImm(isAlignStack));
846
847    // Add all of the operand registers to the instruction.
848    for (unsigned i = InlineAsm::Op_FirstOperand; i != NumOps;) {
849      unsigned Flags =
850        cast<ConstantSDNode>(Node->getOperand(i))->getZExtValue();
851      unsigned NumVals = InlineAsm::getNumOperandRegisters(Flags);
852
853      MI->addOperand(MachineOperand::CreateImm(Flags));
854      ++i;  // Skip the ID value.
855
856      switch (InlineAsm::getKind(Flags)) {
857      default: llvm_unreachable("Bad flags!");
858        case InlineAsm::Kind_RegDef:
859        for (; NumVals; --NumVals, ++i) {
860          unsigned Reg = cast<RegisterSDNode>(Node->getOperand(i))->getReg();
861          // FIXME: Add dead flags for physical and virtual registers defined.
862          // For now, mark physical register defs as implicit to help fast
863          // regalloc. This makes inline asm look a lot like calls.
864          MI->addOperand(MachineOperand::CreateReg(Reg, true,
865                       /*isImp=*/ TargetRegisterInfo::isPhysicalRegister(Reg)));
866        }
867        break;
868      case InlineAsm::Kind_RegDefEarlyClobber:
869        for (; NumVals; --NumVals, ++i) {
870          unsigned Reg = cast<RegisterSDNode>(Node->getOperand(i))->getReg();
871          MI->addOperand(MachineOperand::CreateReg(Reg, /*isDef=*/ true,
872                         /*isImp=*/ TargetRegisterInfo::isPhysicalRegister(Reg),
873                                                   /*isKill=*/ false,
874                                                   /*isDead=*/ false,
875                                                   /*isUndef=*/false,
876                                                   /*isEarlyClobber=*/ true));
877        }
878        break;
879      case InlineAsm::Kind_RegUse:  // Use of register.
880      case InlineAsm::Kind_Imm:  // Immediate.
881      case InlineAsm::Kind_Mem:  // Addressing mode.
882        // The addressing mode has been selected, just add all of the
883        // operands to the machine instruction.
884        for (; NumVals; --NumVals, ++i)
885          AddOperand(MI, Node->getOperand(i), 0, 0, VRBaseMap,
886                     /*IsDebug=*/false, IsClone, IsCloned);
887        break;
888      }
889    }
890
891    // Get the mdnode from the asm if it exists and add it to the instruction.
892    SDValue MDV = Node->getOperand(InlineAsm::Op_MDNode);
893    const MDNode *MD = cast<MDNodeSDNode>(MDV)->getMD();
894    if (MD)
895      MI->addOperand(MachineOperand::CreateMetadata(MD));
896
897    MBB->insert(InsertPos, MI);
898    break;
899  }
900  }
901}
902
903/// InstrEmitter - Construct an InstrEmitter and set it to start inserting
904/// at the given position in the given block.
905InstrEmitter::InstrEmitter(MachineBasicBlock *mbb,
906                           MachineBasicBlock::iterator insertpos)
907  : MF(mbb->getParent()),
908    MRI(&MF->getRegInfo()),
909    TM(&MF->getTarget()),
910    TII(TM->getInstrInfo()),
911    TRI(TM->getRegisterInfo()),
912    TLI(TM->getTargetLowering()),
913    MBB(mbb), InsertPos(insertpos) {
914}
915