xref: /llvm-project/llvm/lib/CodeGen/MachineInstr.cpp (revision b06015aa69b55fc5b434f34543513df74e16cb6b)
1 //===-- lib/CodeGen/MachineInstr.cpp --------------------------------------===//
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 // Methods common to all machine instructions.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm/CodeGen/MachineInstr.h"
15 #include "llvm/Constants.h"
16 #include "llvm/Function.h"
17 #include "llvm/InlineAsm.h"
18 #include "llvm/Type.h"
19 #include "llvm/Value.h"
20 #include "llvm/Assembly/Writer.h"
21 #include "llvm/CodeGen/MachineFunction.h"
22 #include "llvm/CodeGen/MachineMemOperand.h"
23 #include "llvm/CodeGen/MachineRegisterInfo.h"
24 #include "llvm/CodeGen/PseudoSourceValue.h"
25 #include "llvm/Target/TargetMachine.h"
26 #include "llvm/Target/TargetInstrInfo.h"
27 #include "llvm/Target/TargetInstrDesc.h"
28 #include "llvm/Target/TargetRegisterInfo.h"
29 #include "llvm/Analysis/AliasAnalysis.h"
30 #include "llvm/Analysis/DebugInfo.h"
31 #include "llvm/Support/Debug.h"
32 #include "llvm/Support/ErrorHandling.h"
33 #include "llvm/Support/LeakDetector.h"
34 #include "llvm/Support/MathExtras.h"
35 #include "llvm/Support/raw_ostream.h"
36 #include "llvm/ADT/FoldingSet.h"
37 #include "llvm/Metadata.h"
38 using namespace llvm;
39 
40 //===----------------------------------------------------------------------===//
41 // MachineOperand Implementation
42 //===----------------------------------------------------------------------===//
43 
44 /// AddRegOperandToRegInfo - Add this register operand to the specified
45 /// MachineRegisterInfo.  If it is null, then the next/prev fields should be
46 /// explicitly nulled out.
47 void MachineOperand::AddRegOperandToRegInfo(MachineRegisterInfo *RegInfo) {
48   assert(isReg() && "Can only add reg operand to use lists");
49 
50   // If the reginfo pointer is null, just explicitly null out or next/prev
51   // pointers, to ensure they are not garbage.
52   if (RegInfo == 0) {
53     Contents.Reg.Prev = 0;
54     Contents.Reg.Next = 0;
55     return;
56   }
57 
58   // Otherwise, add this operand to the head of the registers use/def list.
59   MachineOperand **Head = &RegInfo->getRegUseDefListHead(getReg());
60 
61   // For SSA values, we prefer to keep the definition at the start of the list.
62   // we do this by skipping over the definition if it is at the head of the
63   // list.
64   if (*Head && (*Head)->isDef())
65     Head = &(*Head)->Contents.Reg.Next;
66 
67   Contents.Reg.Next = *Head;
68   if (Contents.Reg.Next) {
69     assert(getReg() == Contents.Reg.Next->getReg() &&
70            "Different regs on the same list!");
71     Contents.Reg.Next->Contents.Reg.Prev = &Contents.Reg.Next;
72   }
73 
74   Contents.Reg.Prev = Head;
75   *Head = this;
76 }
77 
78 /// RemoveRegOperandFromRegInfo - Remove this register operand from the
79 /// MachineRegisterInfo it is linked with.
80 void MachineOperand::RemoveRegOperandFromRegInfo() {
81   assert(isOnRegUseList() && "Reg operand is not on a use list");
82   // Unlink this from the doubly linked list of operands.
83   MachineOperand *NextOp = Contents.Reg.Next;
84   *Contents.Reg.Prev = NextOp;
85   if (NextOp) {
86     assert(NextOp->getReg() == getReg() && "Corrupt reg use/def chain!");
87     NextOp->Contents.Reg.Prev = Contents.Reg.Prev;
88   }
89   Contents.Reg.Prev = 0;
90   Contents.Reg.Next = 0;
91 }
92 
93 void MachineOperand::setReg(unsigned Reg) {
94   if (getReg() == Reg) return; // No change.
95 
96   // Otherwise, we have to change the register.  If this operand is embedded
97   // into a machine function, we need to update the old and new register's
98   // use/def lists.
99   if (MachineInstr *MI = getParent())
100     if (MachineBasicBlock *MBB = MI->getParent())
101       if (MachineFunction *MF = MBB->getParent()) {
102         RemoveRegOperandFromRegInfo();
103         Contents.Reg.RegNo = Reg;
104         AddRegOperandToRegInfo(&MF->getRegInfo());
105         return;
106       }
107 
108   // Otherwise, just change the register, no problem.  :)
109   Contents.Reg.RegNo = Reg;
110 }
111 
112 /// ChangeToImmediate - Replace this operand with a new immediate operand of
113 /// the specified value.  If an operand is known to be an immediate already,
114 /// the setImm method should be used.
115 void MachineOperand::ChangeToImmediate(int64_t ImmVal) {
116   // If this operand is currently a register operand, and if this is in a
117   // function, deregister the operand from the register's use/def list.
118   if (isReg() && getParent() && getParent()->getParent() &&
119       getParent()->getParent()->getParent())
120     RemoveRegOperandFromRegInfo();
121 
122   OpKind = MO_Immediate;
123   Contents.ImmVal = ImmVal;
124 }
125 
126 /// ChangeToRegister - Replace this operand with a new register operand of
127 /// the specified value.  If an operand is known to be an register already,
128 /// the setReg method should be used.
129 void MachineOperand::ChangeToRegister(unsigned Reg, bool isDef, bool isImp,
130                                       bool isKill, bool isDead, bool isUndef) {
131   // If this operand is already a register operand, use setReg to update the
132   // register's use/def lists.
133   if (isReg()) {
134     assert(!isEarlyClobber());
135     setReg(Reg);
136   } else {
137     // Otherwise, change this to a register and set the reg#.
138     OpKind = MO_Register;
139     Contents.Reg.RegNo = Reg;
140 
141     // If this operand is embedded in a function, add the operand to the
142     // register's use/def list.
143     if (MachineInstr *MI = getParent())
144       if (MachineBasicBlock *MBB = MI->getParent())
145         if (MachineFunction *MF = MBB->getParent())
146           AddRegOperandToRegInfo(&MF->getRegInfo());
147   }
148 
149   IsDef = isDef;
150   IsImp = isImp;
151   IsKill = isKill;
152   IsDead = isDead;
153   IsUndef = isUndef;
154   IsEarlyClobber = false;
155   SubReg = 0;
156 }
157 
158 /// isIdenticalTo - Return true if this operand is identical to the specified
159 /// operand.
160 bool MachineOperand::isIdenticalTo(const MachineOperand &Other) const {
161   if (getType() != Other.getType() ||
162       getTargetFlags() != Other.getTargetFlags())
163     return false;
164 
165   switch (getType()) {
166   default: llvm_unreachable("Unrecognized operand type");
167   case MachineOperand::MO_Register:
168     return getReg() == Other.getReg() && isDef() == Other.isDef() &&
169            getSubReg() == Other.getSubReg();
170   case MachineOperand::MO_Immediate:
171     return getImm() == Other.getImm();
172   case MachineOperand::MO_FPImmediate:
173     return getFPImm() == Other.getFPImm();
174   case MachineOperand::MO_MachineBasicBlock:
175     return getMBB() == Other.getMBB();
176   case MachineOperand::MO_FrameIndex:
177     return getIndex() == Other.getIndex();
178   case MachineOperand::MO_ConstantPoolIndex:
179     return getIndex() == Other.getIndex() && getOffset() == Other.getOffset();
180   case MachineOperand::MO_JumpTableIndex:
181     return getIndex() == Other.getIndex();
182   case MachineOperand::MO_GlobalAddress:
183     return getGlobal() == Other.getGlobal() && getOffset() == Other.getOffset();
184   case MachineOperand::MO_ExternalSymbol:
185     return !strcmp(getSymbolName(), Other.getSymbolName()) &&
186            getOffset() == Other.getOffset();
187   case MachineOperand::MO_BlockAddress:
188     return getBlockAddress() == Other.getBlockAddress();
189   }
190 }
191 
192 /// print - Print the specified machine operand.
193 ///
194 void MachineOperand::print(raw_ostream &OS, const TargetMachine *TM) const {
195   // If the instruction is embedded into a basic block, we can find the
196   // target info for the instruction.
197   if (!TM)
198     if (const MachineInstr *MI = getParent())
199       if (const MachineBasicBlock *MBB = MI->getParent())
200         if (const MachineFunction *MF = MBB->getParent())
201           TM = &MF->getTarget();
202 
203   switch (getType()) {
204   case MachineOperand::MO_Register:
205     if (getReg() == 0 || TargetRegisterInfo::isVirtualRegister(getReg())) {
206       OS << "%reg" << getReg();
207     } else {
208       if (TM)
209         OS << "%" << TM->getRegisterInfo()->get(getReg()).Name;
210       else
211         OS << "%physreg" << getReg();
212     }
213 
214     if (getSubReg() != 0)
215       OS << ':' << getSubReg();
216 
217     if (isDef() || isKill() || isDead() || isImplicit() || isUndef() ||
218         isEarlyClobber()) {
219       OS << '<';
220       bool NeedComma = false;
221       if (isDef()) {
222         if (NeedComma) OS << ',';
223         if (isEarlyClobber())
224           OS << "earlyclobber,";
225         if (isImplicit())
226           OS << "imp-";
227         OS << "def";
228         NeedComma = true;
229       } else if (isImplicit()) {
230           OS << "imp-use";
231           NeedComma = true;
232       }
233 
234       if (isKill() || isDead() || isUndef()) {
235         if (NeedComma) OS << ',';
236         if (isKill())  OS << "kill";
237         if (isDead())  OS << "dead";
238         if (isUndef()) {
239           if (isKill() || isDead())
240             OS << ',';
241           OS << "undef";
242         }
243       }
244       OS << '>';
245     }
246     break;
247   case MachineOperand::MO_Immediate:
248     OS << getImm();
249     break;
250   case MachineOperand::MO_FPImmediate:
251     if (getFPImm()->getType()->isFloatTy())
252       OS << getFPImm()->getValueAPF().convertToFloat();
253     else
254       OS << getFPImm()->getValueAPF().convertToDouble();
255     break;
256   case MachineOperand::MO_MachineBasicBlock:
257     OS << "<BB#" << getMBB()->getNumber() << ">";
258     break;
259   case MachineOperand::MO_FrameIndex:
260     OS << "<fi#" << getIndex() << '>';
261     break;
262   case MachineOperand::MO_ConstantPoolIndex:
263     OS << "<cp#" << getIndex();
264     if (getOffset()) OS << "+" << getOffset();
265     OS << '>';
266     break;
267   case MachineOperand::MO_JumpTableIndex:
268     OS << "<jt#" << getIndex() << '>';
269     break;
270   case MachineOperand::MO_GlobalAddress:
271     OS << "<ga:";
272     WriteAsOperand(OS, getGlobal(), /*PrintType=*/false);
273     if (getOffset()) OS << "+" << getOffset();
274     OS << '>';
275     break;
276   case MachineOperand::MO_ExternalSymbol:
277     OS << "<es:" << getSymbolName();
278     if (getOffset()) OS << "+" << getOffset();
279     OS << '>';
280     break;
281   case MachineOperand::MO_BlockAddress:
282     OS << '<';
283     WriteAsOperand(OS, getBlockAddress(), /*PrintType=*/false);
284     OS << '>';
285     break;
286   case MachineOperand::MO_Metadata:
287     OS << '<';
288     WriteAsOperand(OS, getMetadata(), /*PrintType=*/false);
289     OS << '>';
290     break;
291   default:
292     llvm_unreachable("Unrecognized operand type");
293   }
294 
295   if (unsigned TF = getTargetFlags())
296     OS << "[TF=" << TF << ']';
297 }
298 
299 //===----------------------------------------------------------------------===//
300 // MachineMemOperand Implementation
301 //===----------------------------------------------------------------------===//
302 
303 MachineMemOperand::MachineMemOperand(const Value *v, unsigned int f,
304                                      int64_t o, uint64_t s, unsigned int a)
305   : Offset(o), Size(s), V(v),
306     Flags((f & 7) | ((Log2_32(a) + 1) << 3)) {
307   assert(getBaseAlignment() == a && "Alignment is not a power of 2!");
308   assert((isLoad() || isStore()) && "Not a load/store!");
309 }
310 
311 /// Profile - Gather unique data for the object.
312 ///
313 void MachineMemOperand::Profile(FoldingSetNodeID &ID) const {
314   ID.AddInteger(Offset);
315   ID.AddInteger(Size);
316   ID.AddPointer(V);
317   ID.AddInteger(Flags);
318 }
319 
320 void MachineMemOperand::refineAlignment(const MachineMemOperand *MMO) {
321   // The Value and Offset may differ due to CSE. But the flags and size
322   // should be the same.
323   assert(MMO->getFlags() == getFlags() && "Flags mismatch!");
324   assert(MMO->getSize() == getSize() && "Size mismatch!");
325 
326   if (MMO->getBaseAlignment() >= getBaseAlignment()) {
327     // Update the alignment value.
328     Flags = (Flags & 7) | ((Log2_32(MMO->getBaseAlignment()) + 1) << 3);
329     // Also update the base and offset, because the new alignment may
330     // not be applicable with the old ones.
331     V = MMO->getValue();
332     Offset = MMO->getOffset();
333   }
334 }
335 
336 /// getAlignment - Return the minimum known alignment in bytes of the
337 /// actual memory reference.
338 uint64_t MachineMemOperand::getAlignment() const {
339   return MinAlign(getBaseAlignment(), getOffset());
340 }
341 
342 raw_ostream &llvm::operator<<(raw_ostream &OS, const MachineMemOperand &MMO) {
343   assert((MMO.isLoad() || MMO.isStore()) &&
344          "SV has to be a load, store or both.");
345 
346   if (MMO.isVolatile())
347     OS << "Volatile ";
348 
349   if (MMO.isLoad())
350     OS << "LD";
351   if (MMO.isStore())
352     OS << "ST";
353   OS << MMO.getSize();
354 
355   // Print the address information.
356   OS << "[";
357   if (!MMO.getValue())
358     OS << "<unknown>";
359   else
360     WriteAsOperand(OS, MMO.getValue(), /*PrintType=*/false);
361 
362   // If the alignment of the memory reference itself differs from the alignment
363   // of the base pointer, print the base alignment explicitly, next to the base
364   // pointer.
365   if (MMO.getBaseAlignment() != MMO.getAlignment())
366     OS << "(align=" << MMO.getBaseAlignment() << ")";
367 
368   if (MMO.getOffset() != 0)
369     OS << "+" << MMO.getOffset();
370   OS << "]";
371 
372   // Print the alignment of the reference.
373   if (MMO.getBaseAlignment() != MMO.getAlignment() ||
374       MMO.getBaseAlignment() != MMO.getSize())
375     OS << "(align=" << MMO.getAlignment() << ")";
376 
377   return OS;
378 }
379 
380 //===----------------------------------------------------------------------===//
381 // MachineInstr Implementation
382 //===----------------------------------------------------------------------===//
383 
384 /// MachineInstr ctor - This constructor creates a dummy MachineInstr with
385 /// TID NULL and no operands.
386 MachineInstr::MachineInstr()
387   : TID(0), NumImplicitOps(0), AsmPrinterFlags(0), MemRefs(0), MemRefsEnd(0),
388     Parent(0), debugLoc(DebugLoc::getUnknownLoc()) {
389   // Make sure that we get added to a machine basicblock
390   LeakDetector::addGarbageObject(this);
391 }
392 
393 void MachineInstr::addImplicitDefUseOperands() {
394   if (TID->ImplicitDefs)
395     for (const unsigned *ImpDefs = TID->ImplicitDefs; *ImpDefs; ++ImpDefs)
396       addOperand(MachineOperand::CreateReg(*ImpDefs, true, true));
397   if (TID->ImplicitUses)
398     for (const unsigned *ImpUses = TID->ImplicitUses; *ImpUses; ++ImpUses)
399       addOperand(MachineOperand::CreateReg(*ImpUses, false, true));
400 }
401 
402 /// MachineInstr ctor - This constructor create a MachineInstr and add the
403 /// implicit operands. It reserves space for number of operands specified by
404 /// TargetInstrDesc or the numOperands if it is not zero. (for
405 /// instructions with variable number of operands).
406 MachineInstr::MachineInstr(const TargetInstrDesc &tid, bool NoImp)
407   : TID(&tid), NumImplicitOps(0), AsmPrinterFlags(0),
408     MemRefs(0), MemRefsEnd(0), Parent(0),
409     debugLoc(DebugLoc::getUnknownLoc()) {
410   if (!NoImp && TID->getImplicitDefs())
411     for (const unsigned *ImpDefs = TID->getImplicitDefs(); *ImpDefs; ++ImpDefs)
412       NumImplicitOps++;
413   if (!NoImp && TID->getImplicitUses())
414     for (const unsigned *ImpUses = TID->getImplicitUses(); *ImpUses; ++ImpUses)
415       NumImplicitOps++;
416   Operands.reserve(NumImplicitOps + TID->getNumOperands());
417   if (!NoImp)
418     addImplicitDefUseOperands();
419   // Make sure that we get added to a machine basicblock
420   LeakDetector::addGarbageObject(this);
421 }
422 
423 /// MachineInstr ctor - As above, but with a DebugLoc.
424 MachineInstr::MachineInstr(const TargetInstrDesc &tid, const DebugLoc dl,
425                            bool NoImp)
426   : TID(&tid), NumImplicitOps(0), AsmPrinterFlags(0), MemRefs(0), MemRefsEnd(0),
427     Parent(0), debugLoc(dl) {
428   if (!NoImp && TID->getImplicitDefs())
429     for (const unsigned *ImpDefs = TID->getImplicitDefs(); *ImpDefs; ++ImpDefs)
430       NumImplicitOps++;
431   if (!NoImp && TID->getImplicitUses())
432     for (const unsigned *ImpUses = TID->getImplicitUses(); *ImpUses; ++ImpUses)
433       NumImplicitOps++;
434   Operands.reserve(NumImplicitOps + TID->getNumOperands());
435   if (!NoImp)
436     addImplicitDefUseOperands();
437   // Make sure that we get added to a machine basicblock
438   LeakDetector::addGarbageObject(this);
439 }
440 
441 /// MachineInstr ctor - Work exactly the same as the ctor two above, except
442 /// that the MachineInstr is created and added to the end of the specified
443 /// basic block.
444 ///
445 MachineInstr::MachineInstr(MachineBasicBlock *MBB, const TargetInstrDesc &tid)
446   : TID(&tid), NumImplicitOps(0), AsmPrinterFlags(0),
447     MemRefs(0), MemRefsEnd(0), Parent(0),
448     debugLoc(DebugLoc::getUnknownLoc()) {
449   assert(MBB && "Cannot use inserting ctor with null basic block!");
450   if (TID->ImplicitDefs)
451     for (const unsigned *ImpDefs = TID->getImplicitDefs(); *ImpDefs; ++ImpDefs)
452       NumImplicitOps++;
453   if (TID->ImplicitUses)
454     for (const unsigned *ImpUses = TID->getImplicitUses(); *ImpUses; ++ImpUses)
455       NumImplicitOps++;
456   Operands.reserve(NumImplicitOps + TID->getNumOperands());
457   addImplicitDefUseOperands();
458   // Make sure that we get added to a machine basicblock
459   LeakDetector::addGarbageObject(this);
460   MBB->push_back(this);  // Add instruction to end of basic block!
461 }
462 
463 /// MachineInstr ctor - As above, but with a DebugLoc.
464 ///
465 MachineInstr::MachineInstr(MachineBasicBlock *MBB, const DebugLoc dl,
466                            const TargetInstrDesc &tid)
467   : TID(&tid), NumImplicitOps(0), AsmPrinterFlags(0), MemRefs(0), MemRefsEnd(0),
468     Parent(0), debugLoc(dl) {
469   assert(MBB && "Cannot use inserting ctor with null basic block!");
470   if (TID->ImplicitDefs)
471     for (const unsigned *ImpDefs = TID->getImplicitDefs(); *ImpDefs; ++ImpDefs)
472       NumImplicitOps++;
473   if (TID->ImplicitUses)
474     for (const unsigned *ImpUses = TID->getImplicitUses(); *ImpUses; ++ImpUses)
475       NumImplicitOps++;
476   Operands.reserve(NumImplicitOps + TID->getNumOperands());
477   addImplicitDefUseOperands();
478   // Make sure that we get added to a machine basicblock
479   LeakDetector::addGarbageObject(this);
480   MBB->push_back(this);  // Add instruction to end of basic block!
481 }
482 
483 /// MachineInstr ctor - Copies MachineInstr arg exactly
484 ///
485 MachineInstr::MachineInstr(MachineFunction &MF, const MachineInstr &MI)
486   : TID(&MI.getDesc()), NumImplicitOps(0), AsmPrinterFlags(0),
487     MemRefs(MI.MemRefs), MemRefsEnd(MI.MemRefsEnd),
488     Parent(0), debugLoc(MI.getDebugLoc()) {
489   Operands.reserve(MI.getNumOperands());
490 
491   // Add operands
492   for (unsigned i = 0; i != MI.getNumOperands(); ++i)
493     addOperand(MI.getOperand(i));
494   NumImplicitOps = MI.NumImplicitOps;
495 
496   // Set parent to null.
497   Parent = 0;
498 
499   LeakDetector::addGarbageObject(this);
500 }
501 
502 MachineInstr::~MachineInstr() {
503   LeakDetector::removeGarbageObject(this);
504 #ifndef NDEBUG
505   for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
506     assert(Operands[i].ParentMI == this && "ParentMI mismatch!");
507     assert((!Operands[i].isReg() || !Operands[i].isOnRegUseList()) &&
508            "Reg operand def/use list corrupted");
509   }
510 #endif
511 }
512 
513 /// getRegInfo - If this instruction is embedded into a MachineFunction,
514 /// return the MachineRegisterInfo object for the current function, otherwise
515 /// return null.
516 MachineRegisterInfo *MachineInstr::getRegInfo() {
517   if (MachineBasicBlock *MBB = getParent())
518     return &MBB->getParent()->getRegInfo();
519   return 0;
520 }
521 
522 /// RemoveRegOperandsFromUseLists - Unlink all of the register operands in
523 /// this instruction from their respective use lists.  This requires that the
524 /// operands already be on their use lists.
525 void MachineInstr::RemoveRegOperandsFromUseLists() {
526   for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
527     if (Operands[i].isReg())
528       Operands[i].RemoveRegOperandFromRegInfo();
529   }
530 }
531 
532 /// AddRegOperandsToUseLists - Add all of the register operands in
533 /// this instruction from their respective use lists.  This requires that the
534 /// operands not be on their use lists yet.
535 void MachineInstr::AddRegOperandsToUseLists(MachineRegisterInfo &RegInfo) {
536   for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
537     if (Operands[i].isReg())
538       Operands[i].AddRegOperandToRegInfo(&RegInfo);
539   }
540 }
541 
542 
543 /// addOperand - Add the specified operand to the instruction.  If it is an
544 /// implicit operand, it is added to the end of the operand list.  If it is
545 /// an explicit operand it is added at the end of the explicit operand list
546 /// (before the first implicit operand).
547 void MachineInstr::addOperand(const MachineOperand &Op) {
548   bool isImpReg = Op.isReg() && Op.isImplicit();
549   assert((isImpReg || !OperandsComplete()) &&
550          "Trying to add an operand to a machine instr that is already done!");
551 
552   MachineRegisterInfo *RegInfo = getRegInfo();
553 
554   // If we are adding the operand to the end of the list, our job is simpler.
555   // This is true most of the time, so this is a reasonable optimization.
556   if (isImpReg || NumImplicitOps == 0) {
557     // We can only do this optimization if we know that the operand list won't
558     // reallocate.
559     if (Operands.empty() || Operands.size()+1 <= Operands.capacity()) {
560       Operands.push_back(Op);
561 
562       // Set the parent of the operand.
563       Operands.back().ParentMI = this;
564 
565       // If the operand is a register, update the operand's use list.
566       if (Op.isReg()) {
567         Operands.back().AddRegOperandToRegInfo(RegInfo);
568         // If the register operand is flagged as early, mark the operand as such
569         unsigned OpNo = Operands.size() - 1;
570         if (TID->getOperandConstraint(OpNo, TOI::EARLY_CLOBBER) != -1)
571           Operands[OpNo].setIsEarlyClobber(true);
572       }
573       return;
574     }
575   }
576 
577   // Otherwise, we have to insert a real operand before any implicit ones.
578   unsigned OpNo = Operands.size()-NumImplicitOps;
579 
580   // If this instruction isn't embedded into a function, then we don't need to
581   // update any operand lists.
582   if (RegInfo == 0) {
583     // Simple insertion, no reginfo update needed for other register operands.
584     Operands.insert(Operands.begin()+OpNo, Op);
585     Operands[OpNo].ParentMI = this;
586 
587     // Do explicitly set the reginfo for this operand though, to ensure the
588     // next/prev fields are properly nulled out.
589     if (Operands[OpNo].isReg()) {
590       Operands[OpNo].AddRegOperandToRegInfo(0);
591       // If the register operand is flagged as early, mark the operand as such
592       if (TID->getOperandConstraint(OpNo, TOI::EARLY_CLOBBER) != -1)
593         Operands[OpNo].setIsEarlyClobber(true);
594     }
595 
596   } else if (Operands.size()+1 <= Operands.capacity()) {
597     // Otherwise, we have to remove register operands from their register use
598     // list, add the operand, then add the register operands back to their use
599     // list.  This also must handle the case when the operand list reallocates
600     // to somewhere else.
601 
602     // If insertion of this operand won't cause reallocation of the operand
603     // list, just remove the implicit operands, add the operand, then re-add all
604     // the rest of the operands.
605     for (unsigned i = OpNo, e = Operands.size(); i != e; ++i) {
606       assert(Operands[i].isReg() && "Should only be an implicit reg!");
607       Operands[i].RemoveRegOperandFromRegInfo();
608     }
609 
610     // Add the operand.  If it is a register, add it to the reg list.
611     Operands.insert(Operands.begin()+OpNo, Op);
612     Operands[OpNo].ParentMI = this;
613 
614     if (Operands[OpNo].isReg()) {
615       Operands[OpNo].AddRegOperandToRegInfo(RegInfo);
616       // If the register operand is flagged as early, mark the operand as such
617       if (TID->getOperandConstraint(OpNo, TOI::EARLY_CLOBBER) != -1)
618         Operands[OpNo].setIsEarlyClobber(true);
619     }
620 
621     // Re-add all the implicit ops.
622     for (unsigned i = OpNo+1, e = Operands.size(); i != e; ++i) {
623       assert(Operands[i].isReg() && "Should only be an implicit reg!");
624       Operands[i].AddRegOperandToRegInfo(RegInfo);
625     }
626   } else {
627     // Otherwise, we will be reallocating the operand list.  Remove all reg
628     // operands from their list, then readd them after the operand list is
629     // reallocated.
630     RemoveRegOperandsFromUseLists();
631 
632     Operands.insert(Operands.begin()+OpNo, Op);
633     Operands[OpNo].ParentMI = this;
634 
635     // Re-add all the operands.
636     AddRegOperandsToUseLists(*RegInfo);
637 
638       // If the register operand is flagged as early, mark the operand as such
639     if (Operands[OpNo].isReg()
640         && TID->getOperandConstraint(OpNo, TOI::EARLY_CLOBBER) != -1)
641       Operands[OpNo].setIsEarlyClobber(true);
642   }
643 }
644 
645 /// RemoveOperand - Erase an operand  from an instruction, leaving it with one
646 /// fewer operand than it started with.
647 ///
648 void MachineInstr::RemoveOperand(unsigned OpNo) {
649   assert(OpNo < Operands.size() && "Invalid operand number");
650 
651   // Special case removing the last one.
652   if (OpNo == Operands.size()-1) {
653     // If needed, remove from the reg def/use list.
654     if (Operands.back().isReg() && Operands.back().isOnRegUseList())
655       Operands.back().RemoveRegOperandFromRegInfo();
656 
657     Operands.pop_back();
658     return;
659   }
660 
661   // Otherwise, we are removing an interior operand.  If we have reginfo to
662   // update, remove all operands that will be shifted down from their reg lists,
663   // move everything down, then re-add them.
664   MachineRegisterInfo *RegInfo = getRegInfo();
665   if (RegInfo) {
666     for (unsigned i = OpNo, e = Operands.size(); i != e; ++i) {
667       if (Operands[i].isReg())
668         Operands[i].RemoveRegOperandFromRegInfo();
669     }
670   }
671 
672   Operands.erase(Operands.begin()+OpNo);
673 
674   if (RegInfo) {
675     for (unsigned i = OpNo, e = Operands.size(); i != e; ++i) {
676       if (Operands[i].isReg())
677         Operands[i].AddRegOperandToRegInfo(RegInfo);
678     }
679   }
680 }
681 
682 /// addMemOperand - Add a MachineMemOperand to the machine instruction.
683 /// This function should be used only occasionally. The setMemRefs function
684 /// is the primary method for setting up a MachineInstr's MemRefs list.
685 void MachineInstr::addMemOperand(MachineFunction &MF,
686                                  MachineMemOperand *MO) {
687   mmo_iterator OldMemRefs = MemRefs;
688   mmo_iterator OldMemRefsEnd = MemRefsEnd;
689 
690   size_t NewNum = (MemRefsEnd - MemRefs) + 1;
691   mmo_iterator NewMemRefs = MF.allocateMemRefsArray(NewNum);
692   mmo_iterator NewMemRefsEnd = NewMemRefs + NewNum;
693 
694   std::copy(OldMemRefs, OldMemRefsEnd, NewMemRefs);
695   NewMemRefs[NewNum - 1] = MO;
696 
697   MemRefs = NewMemRefs;
698   MemRefsEnd = NewMemRefsEnd;
699 }
700 
701 /// removeFromParent - This method unlinks 'this' from the containing basic
702 /// block, and returns it, but does not delete it.
703 MachineInstr *MachineInstr::removeFromParent() {
704   assert(getParent() && "Not embedded in a basic block!");
705   getParent()->remove(this);
706   return this;
707 }
708 
709 
710 /// eraseFromParent - This method unlinks 'this' from the containing basic
711 /// block, and deletes it.
712 void MachineInstr::eraseFromParent() {
713   assert(getParent() && "Not embedded in a basic block!");
714   getParent()->erase(this);
715 }
716 
717 
718 /// OperandComplete - Return true if it's illegal to add a new operand
719 ///
720 bool MachineInstr::OperandsComplete() const {
721   unsigned short NumOperands = TID->getNumOperands();
722   if (!TID->isVariadic() && getNumOperands()-NumImplicitOps >= NumOperands)
723     return true;  // Broken: we have all the operands of this instruction!
724   return false;
725 }
726 
727 /// getNumExplicitOperands - Returns the number of non-implicit operands.
728 ///
729 unsigned MachineInstr::getNumExplicitOperands() const {
730   unsigned NumOperands = TID->getNumOperands();
731   if (!TID->isVariadic())
732     return NumOperands;
733 
734   for (unsigned i = NumOperands, e = getNumOperands(); i != e; ++i) {
735     const MachineOperand &MO = getOperand(i);
736     if (!MO.isReg() || !MO.isImplicit())
737       NumOperands++;
738   }
739   return NumOperands;
740 }
741 
742 
743 /// findRegisterUseOperandIdx() - Returns the MachineOperand that is a use of
744 /// the specific register or -1 if it is not found. It further tightens
745 /// the search criteria to a use that kills the register if isKill is true.
746 int MachineInstr::findRegisterUseOperandIdx(unsigned Reg, bool isKill,
747                                           const TargetRegisterInfo *TRI) const {
748   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
749     const MachineOperand &MO = getOperand(i);
750     if (!MO.isReg() || !MO.isUse())
751       continue;
752     unsigned MOReg = MO.getReg();
753     if (!MOReg)
754       continue;
755     if (MOReg == Reg ||
756         (TRI &&
757          TargetRegisterInfo::isPhysicalRegister(MOReg) &&
758          TargetRegisterInfo::isPhysicalRegister(Reg) &&
759          TRI->isSubRegister(MOReg, Reg)))
760       if (!isKill || MO.isKill())
761         return i;
762   }
763   return -1;
764 }
765 
766 /// findRegisterDefOperandIdx() - Returns the operand index that is a def of
767 /// the specified register or -1 if it is not found. If isDead is true, defs
768 /// that are not dead are skipped. If TargetRegisterInfo is non-null, then it
769 /// also checks if there is a def of a super-register.
770 int MachineInstr::findRegisterDefOperandIdx(unsigned Reg, bool isDead,
771                                           const TargetRegisterInfo *TRI) const {
772   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
773     const MachineOperand &MO = getOperand(i);
774     if (!MO.isReg() || !MO.isDef())
775       continue;
776     unsigned MOReg = MO.getReg();
777     if (MOReg == Reg ||
778         (TRI &&
779          TargetRegisterInfo::isPhysicalRegister(MOReg) &&
780          TargetRegisterInfo::isPhysicalRegister(Reg) &&
781          TRI->isSubRegister(MOReg, Reg)))
782       if (!isDead || MO.isDead())
783         return i;
784   }
785   return -1;
786 }
787 
788 /// findFirstPredOperandIdx() - Find the index of the first operand in the
789 /// operand list that is used to represent the predicate. It returns -1 if
790 /// none is found.
791 int MachineInstr::findFirstPredOperandIdx() const {
792   const TargetInstrDesc &TID = getDesc();
793   if (TID.isPredicable()) {
794     for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
795       if (TID.OpInfo[i].isPredicate())
796         return i;
797   }
798 
799   return -1;
800 }
801 
802 /// isRegTiedToUseOperand - Given the index of a register def operand,
803 /// check if the register def is tied to a source operand, due to either
804 /// two-address elimination or inline assembly constraints. Returns the
805 /// first tied use operand index by reference is UseOpIdx is not null.
806 bool MachineInstr::
807 isRegTiedToUseOperand(unsigned DefOpIdx, unsigned *UseOpIdx) const {
808   if (isInlineAsm()) {
809     assert(DefOpIdx >= 2);
810     const MachineOperand &MO = getOperand(DefOpIdx);
811     if (!MO.isReg() || !MO.isDef() || MO.getReg() == 0)
812       return false;
813     // Determine the actual operand index that corresponds to this index.
814     unsigned DefNo = 0;
815     unsigned DefPart = 0;
816     for (unsigned i = 1, e = getNumOperands(); i < e; ) {
817       const MachineOperand &FMO = getOperand(i);
818       // After the normal asm operands there may be additional imp-def regs.
819       if (!FMO.isImm())
820         return false;
821       // Skip over this def.
822       unsigned NumOps = InlineAsm::getNumOperandRegisters(FMO.getImm());
823       unsigned PrevDef = i + 1;
824       i = PrevDef + NumOps;
825       if (i > DefOpIdx) {
826         DefPart = DefOpIdx - PrevDef;
827         break;
828       }
829       ++DefNo;
830     }
831     for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
832       const MachineOperand &FMO = getOperand(i);
833       if (!FMO.isImm())
834         continue;
835       if (i+1 >= e || !getOperand(i+1).isReg() || !getOperand(i+1).isUse())
836         continue;
837       unsigned Idx;
838       if (InlineAsm::isUseOperandTiedToDef(FMO.getImm(), Idx) &&
839           Idx == DefNo) {
840         if (UseOpIdx)
841           *UseOpIdx = (unsigned)i + 1 + DefPart;
842         return true;
843       }
844     }
845     return false;
846   }
847 
848   assert(getOperand(DefOpIdx).isDef() && "DefOpIdx is not a def!");
849   const TargetInstrDesc &TID = getDesc();
850   for (unsigned i = 0, e = TID.getNumOperands(); i != e; ++i) {
851     const MachineOperand &MO = getOperand(i);
852     if (MO.isReg() && MO.isUse() &&
853         TID.getOperandConstraint(i, TOI::TIED_TO) == (int)DefOpIdx) {
854       if (UseOpIdx)
855         *UseOpIdx = (unsigned)i;
856       return true;
857     }
858   }
859   return false;
860 }
861 
862 /// isRegTiedToDefOperand - Return true if the operand of the specified index
863 /// is a register use and it is tied to an def operand. It also returns the def
864 /// operand index by reference.
865 bool MachineInstr::
866 isRegTiedToDefOperand(unsigned UseOpIdx, unsigned *DefOpIdx) const {
867   if (isInlineAsm()) {
868     const MachineOperand &MO = getOperand(UseOpIdx);
869     if (!MO.isReg() || !MO.isUse() || MO.getReg() == 0)
870       return false;
871 
872     // Find the flag operand corresponding to UseOpIdx
873     unsigned FlagIdx, NumOps=0;
874     for (FlagIdx = 1; FlagIdx < UseOpIdx; FlagIdx += NumOps+1) {
875       const MachineOperand &UFMO = getOperand(FlagIdx);
876       // After the normal asm operands there may be additional imp-def regs.
877       if (!UFMO.isImm())
878         return false;
879       NumOps = InlineAsm::getNumOperandRegisters(UFMO.getImm());
880       assert(NumOps < getNumOperands() && "Invalid inline asm flag");
881       if (UseOpIdx < FlagIdx+NumOps+1)
882         break;
883     }
884     if (FlagIdx >= UseOpIdx)
885       return false;
886     const MachineOperand &UFMO = getOperand(FlagIdx);
887     unsigned DefNo;
888     if (InlineAsm::isUseOperandTiedToDef(UFMO.getImm(), DefNo)) {
889       if (!DefOpIdx)
890         return true;
891 
892       unsigned DefIdx = 1;
893       // Remember to adjust the index. First operand is asm string, then there
894       // is a flag for each.
895       while (DefNo) {
896         const MachineOperand &FMO = getOperand(DefIdx);
897         assert(FMO.isImm());
898         // Skip over this def.
899         DefIdx += InlineAsm::getNumOperandRegisters(FMO.getImm()) + 1;
900         --DefNo;
901       }
902       *DefOpIdx = DefIdx + UseOpIdx - FlagIdx;
903       return true;
904     }
905     return false;
906   }
907 
908   const TargetInstrDesc &TID = getDesc();
909   if (UseOpIdx >= TID.getNumOperands())
910     return false;
911   const MachineOperand &MO = getOperand(UseOpIdx);
912   if (!MO.isReg() || !MO.isUse())
913     return false;
914   int DefIdx = TID.getOperandConstraint(UseOpIdx, TOI::TIED_TO);
915   if (DefIdx == -1)
916     return false;
917   if (DefOpIdx)
918     *DefOpIdx = (unsigned)DefIdx;
919   return true;
920 }
921 
922 /// copyKillDeadInfo - Copies kill / dead operand properties from MI.
923 ///
924 void MachineInstr::copyKillDeadInfo(const MachineInstr *MI) {
925   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
926     const MachineOperand &MO = MI->getOperand(i);
927     if (!MO.isReg() || (!MO.isKill() && !MO.isDead()))
928       continue;
929     for (unsigned j = 0, ee = getNumOperands(); j != ee; ++j) {
930       MachineOperand &MOp = getOperand(j);
931       if (!MOp.isIdenticalTo(MO))
932         continue;
933       if (MO.isKill())
934         MOp.setIsKill();
935       else
936         MOp.setIsDead();
937       break;
938     }
939   }
940 }
941 
942 /// copyPredicates - Copies predicate operand(s) from MI.
943 void MachineInstr::copyPredicates(const MachineInstr *MI) {
944   const TargetInstrDesc &TID = MI->getDesc();
945   if (!TID.isPredicable())
946     return;
947   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
948     if (TID.OpInfo[i].isPredicate()) {
949       // Predicated operands must be last operands.
950       addOperand(MI->getOperand(i));
951     }
952   }
953 }
954 
955 /// isSafeToMove - Return true if it is safe to move this instruction. If
956 /// SawStore is set to true, it means that there is a store (or call) between
957 /// the instruction's location and its intended destination.
958 bool MachineInstr::isSafeToMove(const TargetInstrInfo *TII,
959                                 bool &SawStore,
960                                 AliasAnalysis *AA) const {
961   // Ignore stuff that we obviously can't move.
962   if (TID->mayStore() || TID->isCall()) {
963     SawStore = true;
964     return false;
965   }
966   if (TID->isTerminator() || TID->hasUnmodeledSideEffects())
967     return false;
968 
969   // See if this instruction does a load.  If so, we have to guarantee that the
970   // loaded value doesn't change between the load and the its intended
971   // destination. The check for isInvariantLoad gives the targe the chance to
972   // classify the load as always returning a constant, e.g. a constant pool
973   // load.
974   if (TID->mayLoad() && !isInvariantLoad(AA))
975     // Otherwise, this is a real load.  If there is a store between the load and
976     // end of block, or if the load is volatile, we can't move it.
977     return !SawStore && !hasVolatileMemoryRef();
978 
979   return true;
980 }
981 
982 /// isSafeToReMat - Return true if it's safe to rematerialize the specified
983 /// instruction which defined the specified register instead of copying it.
984 bool MachineInstr::isSafeToReMat(const TargetInstrInfo *TII,
985                                  unsigned DstReg,
986                                  AliasAnalysis *AA) const {
987   bool SawStore = false;
988   if (!TII->isTriviallyReMaterializable(this, AA) ||
989       !isSafeToMove(TII, SawStore, AA))
990     return false;
991   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
992     const MachineOperand &MO = getOperand(i);
993     if (!MO.isReg())
994       continue;
995     // FIXME: For now, do not remat any instruction with register operands.
996     // Later on, we can loosen the restriction is the register operands have
997     // not been modified between the def and use. Note, this is different from
998     // MachineSink because the code is no longer in two-address form (at least
999     // partially).
1000     if (MO.isUse())
1001       return false;
1002     else if (!MO.isDead() && MO.getReg() != DstReg)
1003       return false;
1004   }
1005   return true;
1006 }
1007 
1008 /// hasVolatileMemoryRef - Return true if this instruction may have a
1009 /// volatile memory reference, or if the information describing the
1010 /// memory reference is not available. Return false if it is known to
1011 /// have no volatile memory references.
1012 bool MachineInstr::hasVolatileMemoryRef() const {
1013   // An instruction known never to access memory won't have a volatile access.
1014   if (!TID->mayStore() &&
1015       !TID->mayLoad() &&
1016       !TID->isCall() &&
1017       !TID->hasUnmodeledSideEffects())
1018     return false;
1019 
1020   // Otherwise, if the instruction has no memory reference information,
1021   // conservatively assume it wasn't preserved.
1022   if (memoperands_empty())
1023     return true;
1024 
1025   // Check the memory reference information for volatile references.
1026   for (mmo_iterator I = memoperands_begin(), E = memoperands_end(); I != E; ++I)
1027     if ((*I)->isVolatile())
1028       return true;
1029 
1030   return false;
1031 }
1032 
1033 /// isInvariantLoad - Return true if this instruction is loading from a
1034 /// location whose value is invariant across the function.  For example,
1035 /// loading a value from the constant pool or from from the argument area
1036 /// of a function if it does not change.  This should only return true of
1037 /// *all* loads the instruction does are invariant (if it does multiple loads).
1038 bool MachineInstr::isInvariantLoad(AliasAnalysis *AA) const {
1039   // If the instruction doesn't load at all, it isn't an invariant load.
1040   if (!TID->mayLoad())
1041     return false;
1042 
1043   // If the instruction has lost its memoperands, conservatively assume that
1044   // it may not be an invariant load.
1045   if (memoperands_empty())
1046     return false;
1047 
1048   const MachineFrameInfo *MFI = getParent()->getParent()->getFrameInfo();
1049 
1050   for (mmo_iterator I = memoperands_begin(),
1051        E = memoperands_end(); I != E; ++I) {
1052     if ((*I)->isVolatile()) return false;
1053     if ((*I)->isStore()) return false;
1054 
1055     if (const Value *V = (*I)->getValue()) {
1056       // A load from a constant PseudoSourceValue is invariant.
1057       if (const PseudoSourceValue *PSV = dyn_cast<PseudoSourceValue>(V))
1058         if (PSV->isConstant(MFI))
1059           continue;
1060       // If we have an AliasAnalysis, ask it whether the memory is constant.
1061       if (AA && AA->pointsToConstantMemory(V))
1062         continue;
1063     }
1064 
1065     // Otherwise assume conservatively.
1066     return false;
1067   }
1068 
1069   // Everything checks out.
1070   return true;
1071 }
1072 
1073 /// isConstantValuePHI - If the specified instruction is a PHI that always
1074 /// merges together the same virtual register, return the register, otherwise
1075 /// return 0.
1076 unsigned MachineInstr::isConstantValuePHI() const {
1077   if (!isPHI())
1078     return 0;
1079   assert(getNumOperands() >= 3 &&
1080          "It's illegal to have a PHI without source operands");
1081 
1082   unsigned Reg = getOperand(1).getReg();
1083   for (unsigned i = 3, e = getNumOperands(); i < e; i += 2)
1084     if (getOperand(i).getReg() != Reg)
1085       return 0;
1086   return Reg;
1087 }
1088 
1089 void MachineInstr::dump() const {
1090   dbgs() << "  " << *this;
1091 }
1092 
1093 void MachineInstr::print(raw_ostream &OS, const TargetMachine *TM) const {
1094   // We can be a bit tidier if we know the TargetMachine and/or MachineFunction.
1095   const MachineFunction *MF = 0;
1096   if (const MachineBasicBlock *MBB = getParent()) {
1097     MF = MBB->getParent();
1098     if (!TM && MF)
1099       TM = &MF->getTarget();
1100   }
1101 
1102   // Print explicitly defined operands on the left of an assignment syntax.
1103   unsigned StartOp = 0, e = getNumOperands();
1104   for (; StartOp < e && getOperand(StartOp).isReg() &&
1105          getOperand(StartOp).isDef() &&
1106          !getOperand(StartOp).isImplicit();
1107        ++StartOp) {
1108     if (StartOp != 0) OS << ", ";
1109     getOperand(StartOp).print(OS, TM);
1110   }
1111 
1112   if (StartOp != 0)
1113     OS << " = ";
1114 
1115   // Print the opcode name.
1116   OS << getDesc().getName();
1117 
1118   // Print the rest of the operands.
1119   bool OmittedAnyCallClobbers = false;
1120   bool FirstOp = true;
1121   for (unsigned i = StartOp, e = getNumOperands(); i != e; ++i) {
1122     const MachineOperand &MO = getOperand(i);
1123 
1124     // Omit call-clobbered registers which aren't used anywhere. This makes
1125     // call instructions much less noisy on targets where calls clobber lots
1126     // of registers. Don't rely on MO.isDead() because we may be called before
1127     // LiveVariables is run, or we may be looking at a non-allocatable reg.
1128     if (MF && getDesc().isCall() &&
1129         MO.isReg() && MO.isImplicit() && MO.isDef()) {
1130       unsigned Reg = MO.getReg();
1131       if (Reg != 0 && TargetRegisterInfo::isPhysicalRegister(Reg)) {
1132         const MachineRegisterInfo &MRI = MF->getRegInfo();
1133         if (MRI.use_empty(Reg) && !MRI.isLiveOut(Reg)) {
1134           bool HasAliasLive = false;
1135           for (const unsigned *Alias = TM->getRegisterInfo()->getAliasSet(Reg);
1136                unsigned AliasReg = *Alias; ++Alias)
1137             if (!MRI.use_empty(AliasReg) || MRI.isLiveOut(AliasReg)) {
1138               HasAliasLive = true;
1139               break;
1140             }
1141           if (!HasAliasLive) {
1142             OmittedAnyCallClobbers = true;
1143             continue;
1144           }
1145         }
1146       }
1147     }
1148 
1149     if (FirstOp) FirstOp = false; else OS << ",";
1150     OS << " ";
1151     if (i < getDesc().NumOperands) {
1152       const TargetOperandInfo &TOI = getDesc().OpInfo[i];
1153       if (TOI.isPredicate())
1154         OS << "pred:";
1155       if (TOI.isOptionalDef())
1156         OS << "opt:";
1157     }
1158     MO.print(OS, TM);
1159   }
1160 
1161   // Briefly indicate whether any call clobbers were omitted.
1162   if (OmittedAnyCallClobbers) {
1163     if (!FirstOp) OS << ",";
1164     OS << " ...";
1165   }
1166 
1167   bool HaveSemi = false;
1168   if (!memoperands_empty()) {
1169     if (!HaveSemi) OS << ";"; HaveSemi = true;
1170 
1171     OS << " mem:";
1172     for (mmo_iterator i = memoperands_begin(), e = memoperands_end();
1173          i != e; ++i) {
1174       OS << **i;
1175       if (next(i) != e)
1176         OS << " ";
1177     }
1178   }
1179 
1180   if (!debugLoc.isUnknown() && MF) {
1181     if (!HaveSemi) OS << ";";
1182 
1183     // TODO: print InlinedAtLoc information
1184 
1185     DILocation DLT = MF->getDILocation(debugLoc);
1186     DIScope Scope = DLT.getScope();
1187     OS << " dbg:";
1188     // Omit the directory, since it's usually long and uninteresting.
1189     if (!Scope.isNull())
1190       OS << Scope.getFilename();
1191     else
1192       OS << "<unknown>";
1193     OS << ':' << DLT.getLineNumber();
1194     if (DLT.getColumnNumber() != 0)
1195       OS << ':' << DLT.getColumnNumber();
1196   }
1197 
1198   OS << "\n";
1199 }
1200 
1201 bool MachineInstr::addRegisterKilled(unsigned IncomingReg,
1202                                      const TargetRegisterInfo *RegInfo,
1203                                      bool AddIfNotFound) {
1204   bool isPhysReg = TargetRegisterInfo::isPhysicalRegister(IncomingReg);
1205   bool hasAliases = isPhysReg && RegInfo->getAliasSet(IncomingReg);
1206   bool Found = false;
1207   SmallVector<unsigned,4> DeadOps;
1208   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1209     MachineOperand &MO = getOperand(i);
1210     if (!MO.isReg() || !MO.isUse() || MO.isUndef())
1211       continue;
1212     unsigned Reg = MO.getReg();
1213     if (!Reg)
1214       continue;
1215 
1216     if (Reg == IncomingReg) {
1217       if (!Found) {
1218         if (MO.isKill())
1219           // The register is already marked kill.
1220           return true;
1221         if (isPhysReg && isRegTiedToDefOperand(i))
1222           // Two-address uses of physregs must not be marked kill.
1223           return true;
1224         MO.setIsKill();
1225         Found = true;
1226       }
1227     } else if (hasAliases && MO.isKill() &&
1228                TargetRegisterInfo::isPhysicalRegister(Reg)) {
1229       // A super-register kill already exists.
1230       if (RegInfo->isSuperRegister(IncomingReg, Reg))
1231         return true;
1232       if (RegInfo->isSubRegister(IncomingReg, Reg))
1233         DeadOps.push_back(i);
1234     }
1235   }
1236 
1237   // Trim unneeded kill operands.
1238   while (!DeadOps.empty()) {
1239     unsigned OpIdx = DeadOps.back();
1240     if (getOperand(OpIdx).isImplicit())
1241       RemoveOperand(OpIdx);
1242     else
1243       getOperand(OpIdx).setIsKill(false);
1244     DeadOps.pop_back();
1245   }
1246 
1247   // If not found, this means an alias of one of the operands is killed. Add a
1248   // new implicit operand if required.
1249   if (!Found && AddIfNotFound) {
1250     addOperand(MachineOperand::CreateReg(IncomingReg,
1251                                          false /*IsDef*/,
1252                                          true  /*IsImp*/,
1253                                          true  /*IsKill*/));
1254     return true;
1255   }
1256   return Found;
1257 }
1258 
1259 bool MachineInstr::addRegisterDead(unsigned IncomingReg,
1260                                    const TargetRegisterInfo *RegInfo,
1261                                    bool AddIfNotFound) {
1262   bool isPhysReg = TargetRegisterInfo::isPhysicalRegister(IncomingReg);
1263   bool hasAliases = isPhysReg && RegInfo->getAliasSet(IncomingReg);
1264   bool Found = false;
1265   SmallVector<unsigned,4> DeadOps;
1266   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1267     MachineOperand &MO = getOperand(i);
1268     if (!MO.isReg() || !MO.isDef())
1269       continue;
1270     unsigned Reg = MO.getReg();
1271     if (!Reg)
1272       continue;
1273 
1274     if (Reg == IncomingReg) {
1275       if (!Found) {
1276         if (MO.isDead())
1277           // The register is already marked dead.
1278           return true;
1279         MO.setIsDead();
1280         Found = true;
1281       }
1282     } else if (hasAliases && MO.isDead() &&
1283                TargetRegisterInfo::isPhysicalRegister(Reg)) {
1284       // There exists a super-register that's marked dead.
1285       if (RegInfo->isSuperRegister(IncomingReg, Reg))
1286         return true;
1287       if (RegInfo->getSubRegisters(IncomingReg) &&
1288           RegInfo->getSuperRegisters(Reg) &&
1289           RegInfo->isSubRegister(IncomingReg, Reg))
1290         DeadOps.push_back(i);
1291     }
1292   }
1293 
1294   // Trim unneeded dead operands.
1295   while (!DeadOps.empty()) {
1296     unsigned OpIdx = DeadOps.back();
1297     if (getOperand(OpIdx).isImplicit())
1298       RemoveOperand(OpIdx);
1299     else
1300       getOperand(OpIdx).setIsDead(false);
1301     DeadOps.pop_back();
1302   }
1303 
1304   // If not found, this means an alias of one of the operands is dead. Add a
1305   // new implicit operand if required.
1306   if (Found || !AddIfNotFound)
1307     return Found;
1308 
1309   addOperand(MachineOperand::CreateReg(IncomingReg,
1310                                        true  /*IsDef*/,
1311                                        true  /*IsImp*/,
1312                                        false /*IsKill*/,
1313                                        true  /*IsDead*/));
1314   return true;
1315 }
1316 
1317 void MachineInstr::addRegisterDefined(unsigned IncomingReg,
1318                                       const TargetRegisterInfo *RegInfo) {
1319   MachineOperand *MO = findRegisterDefOperand(IncomingReg, false, RegInfo);
1320   if (!MO || MO->getSubReg())
1321     addOperand(MachineOperand::CreateReg(IncomingReg,
1322                                          true  /*IsDef*/,
1323                                          true  /*IsImp*/));
1324 }
1325