MachineInstr.cpp revision 8d3af5e7d082dbd029c3987ceadbdcf9e49af6d7 
1//===-- MachineInstr.cpp --------------------------------------------------===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file was developed by the LLVM research group and is distributed under
6// the University of Illinois Open Source License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Methods common to all machine instructions.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/CodeGen/MachineInstr.h"
15#include "llvm/CodeGen/MachineFunction.h"
16#include "llvm/Target/TargetMachine.h"
17#include "llvm/Target/TargetInstrInfo.h"
18#include "llvm/Target/MRegisterInfo.h"
19#include "llvm/Support/LeakDetector.h"
20#include <iostream>
21
22using namespace llvm;
23
24// Global variable holding an array of descriptors for machine instructions.
25// The actual object needs to be created separately for each target machine.
26// This variable is initialized and reset by class TargetInstrInfo.
27//
28// FIXME: This should be a property of the target so that more than one target
29// at a time can be active...
30//
31namespace llvm {
32  extern const TargetInstrDescriptor *TargetInstrDescriptors;
33}
34
35/// MachineInstr ctor - This constructor only does a _reserve_ of the operands,
36/// not a resize for them.  It is expected that if you use this that you call
37/// add* methods below to fill up the operands, instead of the Set methods.
38/// Eventually, the "resizing" ctors will be phased out.
39///
40MachineInstr::MachineInstr(short opcode, unsigned numOperands)
41  : Opcode(opcode), parent(0) {
42  Operands.reserve(numOperands);
43  // Make sure that we get added to a machine basicblock
44  LeakDetector::addGarbageObject(this);
45}
46
47/// MachineInstr ctor - Work exactly the same as the ctor above, except that the
48/// MachineInstr is created and added to the end of the specified basic block.
49///
50MachineInstr::MachineInstr(MachineBasicBlock *MBB, short opcode,
51                           unsigned numOperands)
52  : Opcode(opcode), parent(0) {
53  assert(MBB && "Cannot use inserting ctor with null basic block!");
54  Operands.reserve(numOperands);
55  // Make sure that we get added to a machine basicblock
56  LeakDetector::addGarbageObject(this);
57  MBB->push_back(this);  // Add instruction to end of basic block!
58}
59
60/// MachineInstr ctor - Copies MachineInstr arg exactly
61///
62MachineInstr::MachineInstr(const MachineInstr &MI) {
63  Opcode = MI.getOpcode();
64  Operands.reserve(MI.getNumOperands());
65
66  // Add operands
67  for (unsigned i = 0; i != MI.getNumOperands(); ++i)
68    Operands.push_back(MI.getOperand(i));
69
70  // Set parent, next, and prev to null
71  parent = 0;
72  prev = 0;
73  next = 0;
74}
75
76
77MachineInstr::~MachineInstr() {
78  LeakDetector::removeGarbageObject(this);
79}
80
81/// removeFromParent - This method unlinks 'this' from the containing basic
82/// block, and returns it, but does not delete it.
83MachineInstr *MachineInstr::removeFromParent() {
84  assert(getParent() && "Not embedded in a basic block!");
85  getParent()->remove(this);
86  return this;
87}
88
89
90/// OperandComplete - Return true if it's illegal to add a new operand
91///
92bool MachineInstr::OperandsComplete() const {
93  int NumOperands = TargetInstrDescriptors[Opcode].numOperands;
94  if ((TargetInstrDescriptors[Opcode].Flags & M_VARIABLE_OPS) == 0 &&
95      getNumOperands() >= (unsigned)NumOperands)
96    return true;  // Broken: we have all the operands of this instruction!
97  return false;
98}
99
100void MachineInstr::dump() const {
101  std::cerr << "  " << *this;
102}
103
104static inline void OutputReg(std::ostream &os, unsigned RegNo,
105                             const MRegisterInfo *MRI = 0) {
106  if (!RegNo || MRegisterInfo::isPhysicalRegister(RegNo)) {
107    if (MRI)
108      os << "%" << MRI->get(RegNo).Name;
109    else
110      os << "%mreg(" << RegNo << ")";
111  } else
112    os << "%reg" << RegNo;
113}
114
115static void print(const MachineOperand &MO, std::ostream &OS,
116                  const TargetMachine *TM) {
117  const MRegisterInfo *MRI = 0;
118
119  if (TM) MRI = TM->getRegisterInfo();
120
121  switch (MO.getType()) {
122  case MachineOperand::MO_Register:
123    OutputReg(OS, MO.getReg(), MRI);
124    break;
125  case MachineOperand::MO_Immediate:
126    OS << MO.getImmedValue();
127    break;
128  case MachineOperand::MO_MachineBasicBlock:
129    OS << "mbb<"
130       << ((Value*)MO.getMachineBasicBlock()->getBasicBlock())->getName()
131       << "," << (void*)MO.getMachineBasicBlock() << ">";
132    break;
133  case MachineOperand::MO_FrameIndex:
134    OS << "<fi#" << MO.getFrameIndex() << ">";
135    break;
136  case MachineOperand::MO_ConstantPoolIndex:
137    OS << "<cp#" << MO.getConstantPoolIndex() << ">";
138    break;
139  case MachineOperand::MO_JumpTableIndex:
140    OS << "<jt#" << MO.getJumpTableIndex() << ">";
141    break;
142  case MachineOperand::MO_GlobalAddress:
143    OS << "<ga:" << ((Value*)MO.getGlobal())->getName();
144    if (MO.getOffset()) OS << "+" << MO.getOffset();
145    OS << ">";
146    break;
147  case MachineOperand::MO_ExternalSymbol:
148    OS << "<es:" << MO.getSymbolName();
149    if (MO.getOffset()) OS << "+" << MO.getOffset();
150    OS << ">";
151    break;
152  default:
153    assert(0 && "Unrecognized operand type");
154  }
155}
156
157void MachineInstr::print(std::ostream &OS, const TargetMachine *TM) const {
158  unsigned StartOp = 0;
159
160   // Specialize printing if op#0 is definition
161  if (getNumOperands() && getOperand(0).isDef() && !getOperand(0).isUse()) {
162    ::print(getOperand(0), OS, TM);
163    OS << " = ";
164    ++StartOp;   // Don't print this operand again!
165  }
166
167  // Must check if Target machine is not null because machine BB could not
168  // be attached to a Machine function yet
169  if (TM)
170    OS << TM->getInstrInfo()->getName(getOpcode());
171
172  for (unsigned i = StartOp, e = getNumOperands(); i != e; ++i) {
173    const MachineOperand& mop = getOperand(i);
174    if (i != StartOp)
175      OS << ",";
176    OS << " ";
177    ::print(mop, OS, TM);
178
179    if (mop.isDef())
180      if (mop.isUse())
181        OS << "<def&use>";
182      else
183        OS << "<def>";
184  }
185
186  OS << "\n";
187}
188
189std::ostream &llvm::operator<<(std::ostream &os, const MachineInstr &MI) {
190  // If the instruction is embedded into a basic block, we can find the target
191  // info for the instruction.
192  if (const MachineBasicBlock *MBB = MI.getParent()) {
193    const MachineFunction *MF = MBB->getParent();
194    if (MF)
195      MI.print(os, &MF->getTarget());
196    else
197      MI.print(os, 0);
198    return os;
199  }
200
201  // Otherwise, print it out in the "raw" format without symbolic register names
202  // and such.
203  os << TargetInstrDescriptors[MI.getOpcode()].Name;
204
205  for (unsigned i = 0, N = MI.getNumOperands(); i < N; i++) {
206    os << "\t" << MI.getOperand(i);
207    if (MI.getOperand(i).isDef())
208      if (MI.getOperand(i).isUse())
209        os << "<d&u>";
210      else
211        os << "<d>";
212  }
213
214  return os << "\n";
215}
216
217std::ostream &llvm::operator<<(std::ostream &OS, const MachineOperand &MO) {
218  switch (MO.getType()) {
219  case MachineOperand::MO_Register:
220    OutputReg(OS, MO.getReg());
221    break;
222  case MachineOperand::MO_Immediate:
223    OS << (long)MO.getImmedValue();
224    break;
225  case MachineOperand::MO_MachineBasicBlock:
226    OS << "<mbb:"
227       << ((Value*)MO.getMachineBasicBlock()->getBasicBlock())->getName()
228       << "@" << (void*)MO.getMachineBasicBlock() << ">";
229    break;
230  case MachineOperand::MO_FrameIndex:
231    OS << "<fi#" << MO.getFrameIndex() << ">";
232    break;
233  case MachineOperand::MO_ConstantPoolIndex:
234    OS << "<cp#" << MO.getConstantPoolIndex() << ">";
235    break;
236  case MachineOperand::MO_JumpTableIndex:
237    OS << "<jt#" << MO.getJumpTableIndex() << ">";
238    break;
239  case MachineOperand::MO_GlobalAddress:
240    OS << "<ga:" << ((Value*)MO.getGlobal())->getName() << ">";
241    break;
242  case MachineOperand::MO_ExternalSymbol:
243    OS << "<es:" << MO.getSymbolName() << ">";
244    break;
245  default:
246    assert(0 && "Unrecognized operand type");
247    break;
248  }
249
250  return OS;
251}
252