lib/CodeGen/MachineInstr.cpp

   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/LLVMContext.h"
  19 #include "llvm/Metadata.h"
  20 #include "llvm/Module.h"
  21 #include "llvm/Type.h"
  22 #include "llvm/Value.h"
  23 #include "llvm/Assembly/Writer.h"
  24 #include "llvm/CodeGen/MachineConstantPool.h"
  25 #include "llvm/CodeGen/MachineFunction.h"
  26 #include "llvm/CodeGen/MachineMemOperand.h"
  27 #include "llvm/CodeGen/MachineModuleInfo.h"
  28 #include "llvm/CodeGen/MachineRegisterInfo.h"
  29 #include "llvm/CodeGen/PseudoSourceValue.h"
  30 #include "llvm/MC/MCInstrDesc.h"
  31 #include "llvm/MC/MCSymbol.h"
  32 #include "llvm/Target/TargetMachine.h"
  33 #include "llvm/Target/TargetInstrInfo.h"
  34 #include "llvm/Target/TargetRegisterInfo.h"
  35 #include "llvm/Analysis/AliasAnalysis.h"
  36 #include "llvm/Analysis/DebugInfo.h"
  37 #include "llvm/Support/Debug.h"
  38 #include "llvm/Support/ErrorHandling.h"
  39 #include "llvm/Support/LeakDetector.h"
  40 #include "llvm/Support/MathExtras.h"
  41 #include "llvm/Support/raw_ostream.h"
  42 #include "llvm/ADT/FoldingSet.h"
  43 using namespace llvm;
  44
  45 //===----------------------------------------------------------------------===//
  46 // MachineOperand Implementation
  47 //===----------------------------------------------------------------------===//
  48
  49 /// AddRegOperandToRegInfo - Add this register operand to the specified
  50 /// MachineRegisterInfo.  If it is null, then the next/prev fields should be
  51 /// explicitly nulled out.
  52 void MachineOperand::AddRegOperandToRegInfo(MachineRegisterInfo *RegInfo) {
  53   assert(isReg() && "Can only add reg operand to use lists");
  54
  55   // If the reginfo pointer is null, just explicitly null out or next/prev
  56   // pointers, to ensure they are not garbage.
  57   if (RegInfo == 0) {
  58     Contents.Reg.Prev = 0;
  59     Contents.Reg.Next = 0;
  60     return;
  61   }
  62
  63   // Otherwise, add this operand to the head of the registers use/def list.
  64   MachineOperand **Head = &RegInfo->getRegUseDefListHead(getReg());
  65
  66   // For SSA values, we prefer to keep the definition at the start of the list.
  67   // we do this by skipping over the definition if it is at the head of the
  68   // list.
  69   if (*Head && (*Head)->isDef())
  70     Head = &(*Head)->Contents.Reg.Next;
  71
  72   Contents.Reg.Next = *Head;
  73   if (Contents.Reg.Next) {
  74     assert(getReg() == Contents.Reg.Next->getReg() &&
  75            "Different regs on the same list!");
  76     Contents.Reg.Next->Contents.Reg.Prev = &Contents.Reg.Next;
  77   }
  78
  79   Contents.Reg.Prev = Head;
  80   *Head = this;
  81 }
  82
  83 /// RemoveRegOperandFromRegInfo - Remove this register operand from the
  84 /// MachineRegisterInfo it is linked with.
  85 void MachineOperand::RemoveRegOperandFromRegInfo() {
  86   assert(isOnRegUseList() && "Reg operand is not on a use list");
  87   // Unlink this from the doubly linked list of operands.
  88   MachineOperand *NextOp = Contents.Reg.Next;
  89   *Contents.Reg.Prev = NextOp;
  90   if (NextOp) {
  91     assert(NextOp->getReg() == getReg() && "Corrupt reg use/def chain!");
  92     NextOp->Contents.Reg.Prev = Contents.Reg.Prev;
  93   }
  94   Contents.Reg.Prev = 0;
  95   Contents.Reg.Next = 0;
  96 }
  97
  98 void MachineOperand::setReg(unsigned Reg) {
  99   if (getReg() == Reg) return; // No change.
 100
 101   // Otherwise, we have to change the register.  If this operand is embedded
 102   // into a machine function, we need to update the old and new register's
 103   // use/def lists.
 104   if (MachineInstr *MI = getParent())
 105     if (MachineBasicBlock *MBB = MI->getParent())
 106       if (MachineFunction *MF = MBB->getParent()) {
 107         RemoveRegOperandFromRegInfo();
 108         SmallContents.RegNo = Reg;
 109         AddRegOperandToRegInfo(&MF->getRegInfo());
 110         return;
 111       }
 112
 113   // Otherwise, just change the register, no problem.  :)
 114   SmallContents.RegNo = Reg;
 115 }
 116
 117 void MachineOperand::substVirtReg(unsigned Reg, unsigned SubIdx,
 118                                   const TargetRegisterInfo &TRI) {
 119   assert(TargetRegisterInfo::isVirtualRegister(Reg));
 120   if (SubIdx && getSubReg())
 121     SubIdx = TRI.composeSubRegIndices(SubIdx, getSubReg());
 122   setReg(Reg);
 123   if (SubIdx)
 124     setSubReg(SubIdx);
 125 }
 126
 127 void MachineOperand::substPhysReg(unsigned Reg, const TargetRegisterInfo &TRI) {
 128   assert(TargetRegisterInfo::isPhysicalRegister(Reg));
 129   if (getSubReg()) {
 130     Reg = TRI.getSubReg(Reg, getSubReg());
 131     // Note that getSubReg() may return 0 if the sub-register doesn't exist.
 132     // That won't happen in legal code.
 133     setSubReg(0);
 134   }
 135   setReg(Reg);
 136 }
 137
 138 /// ChangeToImmediate - Replace this operand with a new immediate operand of
 139 /// the specified value.  If an operand is known to be an immediate already,
 140 /// the setImm method should be used.
 141 void MachineOperand::ChangeToImmediate(int64_t ImmVal) {
 142   // If this operand is currently a register operand, and if this is in a
 143   // function, deregister the operand from the register's use/def list.
 144   if (isReg() && getParent() && getParent()->getParent() &&
 145       getParent()->getParent()->getParent())
 146     RemoveRegOperandFromRegInfo();
 147
 148   OpKind = MO_Immediate;
 149   Contents.ImmVal = ImmVal;
 150 }
 151
 152 /// ChangeToRegister - Replace this operand with a new register operand of
 153 /// the specified value.  If an operand is known to be an register already,
 154 /// the setReg method should be used.
 155 void MachineOperand::ChangeToRegister(unsigned Reg, bool isDef, bool isImp,
 156                                       bool isKill, bool isDead, bool isUndef,
 157                                       bool isDebug) {
 158   // If this operand is already a register operand, use setReg to update the
 159   // register's use/def lists.
 160   if (isReg()) {
 161     assert(!isEarlyClobber());
 162     setReg(Reg);
 163   } else {
 164     // Otherwise, change this to a register and set the reg#.
 165     OpKind = MO_Register;
 166     SmallContents.RegNo = Reg;
 167
 168     // If this operand is embedded in a function, add the operand to the
 169     // register's use/def list.
 170     if (MachineInstr *MI = getParent())
 171       if (MachineBasicBlock *MBB = MI->getParent())
 172         if (MachineFunction *MF = MBB->getParent())
 173           AddRegOperandToRegInfo(&MF->getRegInfo());
 174   }
 175
 176   IsDef = isDef;
 177   IsImp = isImp;
 178   IsKill = isKill;
 179   IsDead = isDead;
 180   IsUndef = isUndef;
 181   IsEarlyClobber = false;
 182   IsDebug = isDebug;
 183   SubReg = 0;
 184 }
 185
 186 /// isIdenticalTo - Return true if this operand is identical to the specified
 187 /// operand.
 188 bool MachineOperand::isIdenticalTo(const MachineOperand &Other) const {
 189   if (getType() != Other.getType() ||
 190       getTargetFlags() != Other.getTargetFlags())
 191     return false;
 192
 193   switch (getType()) {
 194   default: llvm_unreachable("Unrecognized operand type");
 195   case MachineOperand::MO_Register:
 196     return getReg() == Other.getReg() && isDef() == Other.isDef() &&
 197            getSubReg() == Other.getSubReg();
 198   case MachineOperand::MO_Immediate:
 199     return getImm() == Other.getImm();
 200   case MachineOperand::MO_CImmediate:
 201     return getCImm() == Other.getCImm();
 202   case MachineOperand::MO_FPImmediate:
 203     return getFPImm() == Other.getFPImm();
 204   case MachineOperand::MO_MachineBasicBlock:
 205     return getMBB() == Other.getMBB();
 206   case MachineOperand::MO_FrameIndex:
 207     return getIndex() == Other.getIndex();
 208   case MachineOperand::MO_ConstantPoolIndex:
 209     return getIndex() == Other.getIndex() && getOffset() == Other.getOffset();
 210   case MachineOperand::MO_JumpTableIndex:
 211     return getIndex() == Other.getIndex();
 212   case MachineOperand::MO_GlobalAddress:
 213     return getGlobal() == Other.getGlobal() && getOffset() == Other.getOffset();
 214   case MachineOperand::MO_ExternalSymbol:
 215     return !strcmp(getSymbolName(), Other.getSymbolName()) &&
 216            getOffset() == Other.getOffset();
 217   case MachineOperand::MO_BlockAddress:
 218     return getBlockAddress() == Other.getBlockAddress();
 219   case MachineOperand::MO_MCSymbol:
 220     return getMCSymbol() == Other.getMCSymbol();
 221   case MachineOperand::MO_Metadata:
 222     return getMetadata() == Other.getMetadata();
 223   }
 224 }
 225
 226 /// print - Print the specified machine operand.
 227 ///
 228 void MachineOperand::print(raw_ostream &OS, const TargetMachine *TM) const {
 229   // If the instruction is embedded into a basic block, we can find the
 230   // target info for the instruction.
 231   if (!TM)
 232     if (const MachineInstr *MI = getParent())
 233       if (const MachineBasicBlock *MBB = MI->getParent())
 234         if (const MachineFunction *MF = MBB->getParent())
 235           TM = &MF->getTarget();
 236   const TargetRegisterInfo *TRI = TM ? TM->getRegisterInfo() : 0;
 237
 238   switch (getType()) {
 239   case MachineOperand::MO_Register:
 240     OS << PrintReg(getReg(), TRI, getSubReg());
 241
 242     if (isDef() || isKill() || isDead() || isImplicit() || isUndef() ||
 243         isEarlyClobber()) {
 244       OS << '<';
 245       bool NeedComma = false;
 246       if (isDef()) {
 247         if (NeedComma) OS << ',';
 248         if (isEarlyClobber())
 249           OS << "earlyclobber,";
 250         if (isImplicit())
 251           OS << "imp-";
 252         OS << "def";
 253         NeedComma = true;
 254       } else if (isImplicit()) {
 255           OS << "imp-use";
 256           NeedComma = true;
 257       }
 258
 259       if (isKill() || isDead() || isUndef()) {
 260         if (NeedComma) OS << ',';
 261         if (isKill())  OS << "kill";
 262         if (isDead())  OS << "dead";
 263         if (isUndef()) {
 264           if (isKill() || isDead())
 265             OS << ',';
 266           OS << "undef";
 267         }
 268       }
 269       OS << '>';
 270     }
 271     break;
 272   case MachineOperand::MO_Immediate:
 273     OS << getImm();
 274     break;
 275   case MachineOperand::MO_CImmediate:
 276     getCImm()->getValue().print(OS, false);
 277     break;
 278   case MachineOperand::MO_FPImmediate:
 279     if (getFPImm()->getType()->isFloatTy())
 280       OS << getFPImm()->getValueAPF().convertToFloat();
 281     else
 282       OS << getFPImm()->getValueAPF().convertToDouble();
 283     break;
 284   case MachineOperand::MO_MachineBasicBlock:
 285     OS << "<BB#" << getMBB()->getNumber() << ">";
 286     break;
 287   case MachineOperand::MO_FrameIndex:
 288     OS << "<fi#" << getIndex() << '>';
 289     break;
 290   case MachineOperand::MO_ConstantPoolIndex:
 291     OS << "<cp#" << getIndex();
 292     if (getOffset()) OS << "+" << getOffset();
 293     OS << '>';
 294     break;
 295   case MachineOperand::MO_JumpTableIndex:
 296     OS << "<jt#" << getIndex() << '>';
 297     break;
 298   case MachineOperand::MO_GlobalAddress:
 299     OS << "<ga:";
 300     WriteAsOperand(OS, getGlobal(), /*PrintType=*/false);
 301     if (getOffset()) OS << "+" << getOffset();
 302     OS << '>';
 303     break;
 304   case MachineOperand::MO_ExternalSymbol:
 305     OS << "<es:" << getSymbolName();
 306     if (getOffset()) OS << "+" << getOffset();
 307     OS << '>';
 308     break;
 309   case MachineOperand::MO_BlockAddress:
 310     OS << '<';
 311     WriteAsOperand(OS, getBlockAddress(), /*PrintType=*/false);
 312     OS << '>';
 313     break;
 314   case MachineOperand::MO_Metadata:
 315     OS << '<';
 316     WriteAsOperand(OS, getMetadata(), /*PrintType=*/false);
 317     OS << '>';
 318     break;
 319   case MachineOperand::MO_MCSymbol:
 320     OS << "<MCSym=" << *getMCSymbol() << '>';
 321     break;
 322   default:
 323     llvm_unreachable("Unrecognized operand type");
 324   }
 325
 326   if (unsigned TF = getTargetFlags())
 327     OS << "[TF=" << TF << ']';
 328 }
 329
 330 //===----------------------------------------------------------------------===//
 331 // MachineMemOperand Implementation
 332 //===----------------------------------------------------------------------===//
 333
 334 /// getAddrSpace - Return the LLVM IR address space number that this pointer
 335 /// points into.
 336 unsigned MachinePointerInfo::getAddrSpace() const {
 337   if (V == 0) return 0;
 338   return cast<PointerType>(V->getType())->getAddressSpace();
 339 }
 340
 341 /// getConstantPool - Return a MachinePointerInfo record that refers to the
 342 /// constant pool.
 343 MachinePointerInfo MachinePointerInfo::getConstantPool() {
 344   return MachinePointerInfo(PseudoSourceValue::getConstantPool());
 345 }
 346
 347 /// getFixedStack - Return a MachinePointerInfo record that refers to the
 348 /// the specified FrameIndex.
 349 MachinePointerInfo MachinePointerInfo::getFixedStack(int FI, int64_t offset) {
 350   return MachinePointerInfo(PseudoSourceValue::getFixedStack(FI), offset);
 351 }
 352
 353 MachinePointerInfo MachinePointerInfo::getJumpTable() {
 354   return MachinePointerInfo(PseudoSourceValue::getJumpTable());
 355 }
 356
 357 MachinePointerInfo MachinePointerInfo::getGOT() {
 358   return MachinePointerInfo(PseudoSourceValue::getGOT());
 359 }
 360
 361 MachinePointerInfo MachinePointerInfo::getStack(int64_t Offset) {
 362   return MachinePointerInfo(PseudoSourceValue::getStack(), Offset);
 363 }
 364
 365 MachineMemOperand::MachineMemOperand(MachinePointerInfo ptrinfo, unsigned f,
 366                                      uint64_t s, unsigned int a,
 367                                      const MDNode *TBAAInfo)
 368   : PtrInfo(ptrinfo), Size(s),
 369     Flags((f & ((1 << MOMaxBits) - 1)) | ((Log2_32(a) + 1) << MOMaxBits)),
 370     TBAAInfo(TBAAInfo) {
 371   assert((PtrInfo.V == 0 || isa<PointerType>(PtrInfo.V->getType())) &&
 372          "invalid pointer value");
 373   assert(getBaseAlignment() == a && "Alignment is not a power of 2!");
 374   assert((isLoad() || isStore()) && "Not a load/store!");
 375 }
 376
 377 /// Profile - Gather unique data for the object.
 378 ///
 379 void MachineMemOperand::Profile(FoldingSetNodeID &ID) const {
 380   ID.AddInteger(getOffset());
 381   ID.AddInteger(Size);
 382   ID.AddPointer(getValue());
 383   ID.AddInteger(Flags);
 384 }
 385
 386 void MachineMemOperand::refineAlignment(const MachineMemOperand *MMO) {
 387   // The Value and Offset may differ due to CSE. But the flags and size
 388   // should be the same.
 389   assert(MMO->getFlags() == getFlags() && "Flags mismatch!");
 390   assert(MMO->getSize() == getSize() && "Size mismatch!");
 391
 392   if (MMO->getBaseAlignment() >= getBaseAlignment()) {
 393     // Update the alignment value.
 394     Flags = (Flags & ((1 << MOMaxBits) - 1)) |
 395       ((Log2_32(MMO->getBaseAlignment()) + 1) << MOMaxBits);
 396     // Also update the base and offset, because the new alignment may
 397     // not be applicable with the old ones.
 398     PtrInfo = MMO->PtrInfo;
 399   }
 400 }
 401
 402 /// getAlignment - Return the minimum known alignment in bytes of the
 403 /// actual memory reference.
 404 uint64_t MachineMemOperand::getAlignment() const {
 405   return MinAlign(getBaseAlignment(), getOffset());
 406 }
 407
 408 raw_ostream &llvm::operator<<(raw_ostream &OS, const MachineMemOperand &MMO) {
 409   assert((MMO.isLoad() || MMO.isStore()) &&
 410          "SV has to be a load, store or both.");
 411
 412   if (MMO.isVolatile())
 413     OS << "Volatile ";
 414
 415   if (MMO.isLoad())
 416     OS << "LD";
 417   if (MMO.isStore())
 418     OS << "ST";
 419   OS << MMO.getSize();
 420
 421   // Print the address information.
 422   OS << "[";
 423   if (!MMO.getValue())
 424     OS << "<unknown>";
 425   else
 426     WriteAsOperand(OS, MMO.getValue(), /*PrintType=*/false);
 427
 428   // If the alignment of the memory reference itself differs from the alignment
 429   // of the base pointer, print the base alignment explicitly, next to the base
 430   // pointer.
 431   if (MMO.getBaseAlignment() != MMO.getAlignment())
 432     OS << "(align=" << MMO.getBaseAlignment() << ")";
 433
 434   if (MMO.getOffset() != 0)
 435     OS << "+" << MMO.getOffset();
 436   OS << "]";
 437
 438   // Print the alignment of the reference.
 439   if (MMO.getBaseAlignment() != MMO.getAlignment() ||
 440       MMO.getBaseAlignment() != MMO.getSize())
 441     OS << "(align=" << MMO.getAlignment() << ")";
 442
 443   // Print TBAA info.
 444   if (const MDNode *TBAAInfo = MMO.getTBAAInfo()) {
 445     OS << "(tbaa=";
 446     if (TBAAInfo->getNumOperands() > 0)
 447       WriteAsOperand(OS, TBAAInfo->getOperand(0), /*PrintType=*/false);
 448     else
 449       OS << "<unknown>";
 450     OS << ")";
 451   }
 452
 453   // Print nontemporal info.
 454   if (MMO.isNonTemporal())
 455     OS << "(nontemporal)";
 456
 457   return OS;
 458 }
 459
 460 //===----------------------------------------------------------------------===//
 461 // MachineInstr Implementation
 462 //===----------------------------------------------------------------------===//
 463
 464 /// MachineInstr ctor - This constructor creates a dummy MachineInstr with
 465 /// MCID NULL and no operands.
 466 MachineInstr::MachineInstr()
 467   : MCID(0), Flags(0), AsmPrinterFlags(0),
 468     MemRefs(0), MemRefsEnd(0),
 469     Parent(0) {
 470   // Make sure that we get added to a machine basicblock
 471   LeakDetector::addGarbageObject(this);
 472 }
 473
 474 void MachineInstr::addImplicitDefUseOperands() {
 475   if (MCID->ImplicitDefs)
 476     for (const unsigned *ImpDefs = MCID->ImplicitDefs; *ImpDefs; ++ImpDefs)
 477       addOperand(MachineOperand::CreateReg(*ImpDefs, true, true));
 478   if (MCID->ImplicitUses)
 479     for (const unsigned *ImpUses = MCID->ImplicitUses; *ImpUses; ++ImpUses)
 480       addOperand(MachineOperand::CreateReg(*ImpUses, false, true));
 481 }
 482
 483 /// MachineInstr ctor - This constructor creates a MachineInstr and adds the
 484 /// implicit operands. It reserves space for the number of operands specified by
 485 /// the MCInstrDesc.
 486 MachineInstr::MachineInstr(const MCInstrDesc &tid, bool NoImp)
 487   : MCID(&tid), Flags(0), AsmPrinterFlags(0),
 488     MemRefs(0), MemRefsEnd(0), Parent(0) {
 489   unsigned NumImplicitOps = 0;
 490   if (!NoImp)
 491     NumImplicitOps = MCID->getNumImplicitDefs() + MCID->getNumImplicitUses();
 492   Operands.reserve(NumImplicitOps + MCID->getNumOperands());
 493   if (!NoImp)
 494     addImplicitDefUseOperands();
 495   // Make sure that we get added to a machine basicblock
 496   LeakDetector::addGarbageObject(this);
 497 }
 498
 499 /// MachineInstr ctor - As above, but with a DebugLoc.
 500 MachineInstr::MachineInstr(const MCInstrDesc &tid, const DebugLoc dl,
 501                            bool NoImp)
 502   : MCID(&tid), Flags(0), AsmPrinterFlags(0),
 503     MemRefs(0), MemRefsEnd(0), Parent(0), debugLoc(dl) {
 504   unsigned NumImplicitOps = 0;
 505   if (!NoImp)
 506     NumImplicitOps = MCID->getNumImplicitDefs() + MCID->getNumImplicitUses();
 507   Operands.reserve(NumImplicitOps + MCID->getNumOperands());
 508   if (!NoImp)
 509     addImplicitDefUseOperands();
 510   // Make sure that we get added to a machine basicblock
 511   LeakDetector::addGarbageObject(this);
 512 }
 513
 514 /// MachineInstr ctor - Work exactly the same as the ctor two above, except
 515 /// that the MachineInstr is created and added to the end of the specified
 516 /// basic block.
 517 MachineInstr::MachineInstr(MachineBasicBlock *MBB, const MCInstrDesc &tid)
 518   : MCID(&tid), Flags(0), AsmPrinterFlags(0),
 519     MemRefs(0), MemRefsEnd(0), Parent(0) {
 520   assert(MBB && "Cannot use inserting ctor with null basic block!");
 521   unsigned NumImplicitOps =
 522     MCID->getNumImplicitDefs() + MCID->getNumImplicitUses();
 523   Operands.reserve(NumImplicitOps + MCID->getNumOperands());
 524   addImplicitDefUseOperands();
 525   // Make sure that we get added to a machine basicblock
 526   LeakDetector::addGarbageObject(this);
 527   MBB->push_back(this);  // Add instruction to end of basic block!
 528 }
 529
 530 /// MachineInstr ctor - As above, but with a DebugLoc.
 531 ///
 532 MachineInstr::MachineInstr(MachineBasicBlock *MBB, const DebugLoc dl,
 533                            const MCInstrDesc &tid)
 534   : MCID(&tid), Flags(0), AsmPrinterFlags(0),
 535     MemRefs(0), MemRefsEnd(0), Parent(0), debugLoc(dl) {
 536   assert(MBB && "Cannot use inserting ctor with null basic block!");
 537   unsigned NumImplicitOps =
 538     MCID->getNumImplicitDefs() + MCID->getNumImplicitUses();
 539   Operands.reserve(NumImplicitOps + MCID->getNumOperands());
 540   addImplicitDefUseOperands();
 541   // Make sure that we get added to a machine basicblock
 542   LeakDetector::addGarbageObject(this);
 543   MBB->push_back(this);  // Add instruction to end of basic block!
 544 }
 545
 546 /// MachineInstr ctor - Copies MachineInstr arg exactly
 547 ///
 548 MachineInstr::MachineInstr(MachineFunction &MF, const MachineInstr &MI)
 549   : MCID(&MI.getDesc()), Flags(0), AsmPrinterFlags(0),
 550     MemRefs(MI.MemRefs), MemRefsEnd(MI.MemRefsEnd),
 551     Parent(0), debugLoc(MI.getDebugLoc()) {
 552   Operands.reserve(MI.getNumOperands());
 553
 554   // Add operands
 555   for (unsigned i = 0; i != MI.getNumOperands(); ++i)
 556     addOperand(MI.getOperand(i));
 557
 558   // Copy all the flags.
 559   Flags = MI.Flags;
 560
 561   // Set parent to null.
 562   Parent = 0;
 563
 564   LeakDetector::addGarbageObject(this);
 565 }
 566
 567 MachineInstr::~MachineInstr() {
 568   LeakDetector::removeGarbageObject(this);
 569 #ifndef NDEBUG
 570   for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
 571     assert(Operands[i].ParentMI == this && "ParentMI mismatch!");
 572     assert((!Operands[i].isReg() || !Operands[i].isOnRegUseList()) &&
 573            "Reg operand def/use list corrupted");
 574   }
 575 #endif
 576 }
 577
 578 /// getRegInfo - If this instruction is embedded into a MachineFunction,
 579 /// return the MachineRegisterInfo object for the current function, otherwise
 580 /// return null.
 581 MachineRegisterInfo *MachineInstr::getRegInfo() {
 582   if (MachineBasicBlock *MBB = getParent())
 583     return &MBB->getParent()->getRegInfo();
 584   return 0;
 585 }
 586
 587 /// RemoveRegOperandsFromUseLists - Unlink all of the register operands in
 588 /// this instruction from their respective use lists.  This requires that the
 589 /// operands already be on their use lists.
 590 void MachineInstr::RemoveRegOperandsFromUseLists() {
 591   for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
 592     if (Operands[i].isReg())
 593       Operands[i].RemoveRegOperandFromRegInfo();
 594   }
 595 }
 596
 597 /// AddRegOperandsToUseLists - Add all of the register operands in
 598 /// this instruction from their respective use lists.  This requires that the
 599 /// operands not be on their use lists yet.
 600 void MachineInstr::AddRegOperandsToUseLists(MachineRegisterInfo &RegInfo) {
 601   for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
 602     if (Operands[i].isReg())
 603       Operands[i].AddRegOperandToRegInfo(&RegInfo);
 604   }
 605 }
 606
 607
 608 /// addOperand - Add the specified operand to the instruction.  If it is an
 609 /// implicit operand, it is added to the end of the operand list.  If it is
 610 /// an explicit operand it is added at the end of the explicit operand list
 611 /// (before the first implicit operand).
 612 void MachineInstr::addOperand(const MachineOperand &Op) {
 613   assert(MCID && "Cannot add operands before providing an instr descriptor");
 614   bool isImpReg = Op.isReg() && Op.isImplicit();
 615   MachineRegisterInfo *RegInfo = getRegInfo();
 616
 617   // If the Operands backing store is reallocated, all register operands must
 618   // be removed and re-added to RegInfo.  It is storing pointers to operands.
 619   bool Reallocate = RegInfo &&
 620     !Operands.empty() && Operands.size() == Operands.capacity();
 621
 622   // Find the insert location for the new operand.  Implicit registers go at
 623   // the end, everything goes before the implicit regs.
 624   unsigned OpNo = Operands.size();
 625
 626   // Remove all the implicit operands from RegInfo if they need to be shifted.
 627   // FIXME: Allow mixed explicit and implicit operands on inline asm.
 628   // InstrEmitter::EmitSpecialNode() is marking inline asm clobbers as
 629   // implicit-defs, but they must not be moved around.  See the FIXME in
 630   // InstrEmitter.cpp.
 631   if (!isImpReg && !isInlineAsm()) {
 632     while (OpNo && Operands[OpNo-1].isReg() && Operands[OpNo-1].isImplicit()) {
 633       --OpNo;
 634       if (RegInfo)
 635         Operands[OpNo].RemoveRegOperandFromRegInfo();
 636     }
 637   }
 638
 639   // OpNo now points as the desired insertion point.  Unless this is a variadic
 640   // instruction, only implicit regs are allowed beyond MCID->getNumOperands().
 641   assert((isImpReg || MCID->isVariadic() || OpNo < MCID->getNumOperands()) &&
 642          "Trying to add an operand to a machine instr that is already done!");
 643
 644   // All operands from OpNo have been removed from RegInfo.  If the Operands
 645   // backing store needs to be reallocated, we also need to remove any other
 646   // register operands.
 647   if (Reallocate)
 648     for (unsigned i = 0; i != OpNo; ++i)
 649       if (Operands[i].isReg())
 650         Operands[i].RemoveRegOperandFromRegInfo();
 651
 652   // Insert the new operand at OpNo.
 653   Operands.insert(Operands.begin() + OpNo, Op);
 654   Operands[OpNo].ParentMI = this;
 655
 656   // The Operands backing store has now been reallocated, so we can re-add the
 657   // operands before OpNo.
 658   if (Reallocate)
 659     for (unsigned i = 0; i != OpNo; ++i)
 660       if (Operands[i].isReg())
 661         Operands[i].AddRegOperandToRegInfo(RegInfo);
 662
 663   // When adding a register operand, tell RegInfo about it.
 664   if (Operands[OpNo].isReg()) {
 665     // Add the new operand to RegInfo, even when RegInfo is NULL.
 666     // This will initialize the linked list pointers.
 667     Operands[OpNo].AddRegOperandToRegInfo(RegInfo);
 668     // If the register operand is flagged as early, mark the operand as such.
 669     if (MCID->getOperandConstraint(OpNo, MCOI::EARLY_CLOBBER) != -1)
 670       Operands[OpNo].setIsEarlyClobber(true);
 671   }
 672
 673   // Re-add all the implicit ops.
 674   if (RegInfo) {
 675     for (unsigned i = OpNo + 1, e = Operands.size(); i != e; ++i) {
 676       assert(Operands[i].isReg() && "Should only be an implicit reg!");
 677       Operands[i].AddRegOperandToRegInfo(RegInfo);
 678     }
 679   }
 680 }
 681
 682 /// RemoveOperand - Erase an operand  from an instruction, leaving it with one
 683 /// fewer operand than it started with.
 684 ///
 685 void MachineInstr::RemoveOperand(unsigned OpNo) {
 686   assert(OpNo < Operands.size() && "Invalid operand number");
 687
 688   // Special case removing the last one.
 689   if (OpNo == Operands.size()-1) {
 690     // If needed, remove from the reg def/use list.
 691     if (Operands.back().isReg() && Operands.back().isOnRegUseList())
 692       Operands.back().RemoveRegOperandFromRegInfo();
 693
 694     Operands.pop_back();
 695     return;
 696   }
 697
 698   // Otherwise, we are removing an interior operand.  If we have reginfo to
 699   // update, remove all operands that will be shifted down from their reg lists,
 700   // move everything down, then re-add them.
 701   MachineRegisterInfo *RegInfo = getRegInfo();
 702   if (RegInfo) {
 703     for (unsigned i = OpNo, e = Operands.size(); i != e; ++i) {
 704       if (Operands[i].isReg())
 705         Operands[i].RemoveRegOperandFromRegInfo();
 706     }
 707   }
 708
 709   Operands.erase(Operands.begin()+OpNo);
 710
 711   if (RegInfo) {
 712     for (unsigned i = OpNo, e = Operands.size(); i != e; ++i) {
 713       if (Operands[i].isReg())
 714         Operands[i].AddRegOperandToRegInfo(RegInfo);
 715     }
 716   }
 717 }
 718
 719 /// addMemOperand - Add a MachineMemOperand to the machine instruction.
 720 /// This function should be used only occasionally. The setMemRefs function
 721 /// is the primary method for setting up a MachineInstr's MemRefs list.
 722 void MachineInstr::addMemOperand(MachineFunction &MF,
 723                                  MachineMemOperand *MO) {
 724   mmo_iterator OldMemRefs = MemRefs;
 725   mmo_iterator OldMemRefsEnd = MemRefsEnd;
 726
 727   size_t NewNum = (MemRefsEnd - MemRefs) + 1;
 728   mmo_iterator NewMemRefs = MF.allocateMemRefsArray(NewNum);
 729   mmo_iterator NewMemRefsEnd = NewMemRefs + NewNum;
 730
 731   std::copy(OldMemRefs, OldMemRefsEnd, NewMemRefs);
 732   NewMemRefs[NewNum - 1] = MO;
 733
 734   MemRefs = NewMemRefs;
 735   MemRefsEnd = NewMemRefsEnd;
 736 }
 737
 738 bool MachineInstr::hasProperty(unsigned short MCFlag) const {
 739   if (getOpcode() != TargetOpcode::BUNDLE)
 740     return getDesc().getFlags() & (1 << MCFlag);
 741
 742   const MachineBasicBlock *MBB = getParent();
 743   MachineBasicBlock::const_insn_iterator MII = *this; ++MII;
 744   while (MII != MBB->end() && MII->isInsideBundle()) {
 745     if (MII->getDesc().getFlags() & (1 << MCFlag))
 746       return true;
 747     ++MII;
 748   }
 749   return false;
 750 }
 751
 752 bool MachineInstr::isIdenticalTo(const MachineInstr *Other,
 753                                  MICheckType Check) const {
 754   // If opcodes or number of operands are not the same then the two
 755   // instructions are obviously not identical.
 756   if (Other->getOpcode() != getOpcode() ||
 757       Other->getNumOperands() != getNumOperands())
 758     return false;
 759
 760   // Check operands to make sure they match.
 761   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 762     const MachineOperand &MO = getOperand(i);
 763     const MachineOperand &OMO = Other->getOperand(i);
 764     if (!MO.isReg()) {
 765       if (!MO.isIdenticalTo(OMO))
 766         return false;
 767       continue;
 768     }
 769
 770     // Clients may or may not want to ignore defs when testing for equality.
 771     // For example, machine CSE pass only cares about finding common
 772     // subexpressions, so it's safe to ignore virtual register defs.
 773     if (MO.isDef()) {
 774       if (Check == IgnoreDefs)
 775         continue;
 776       else if (Check == IgnoreVRegDefs) {
 777         if (TargetRegisterInfo::isPhysicalRegister(MO.getReg()) ||
 778             TargetRegisterInfo::isPhysicalRegister(OMO.getReg()))
 779           if (MO.getReg() != OMO.getReg())
 780             return false;
 781       } else {
 782         if (!MO.isIdenticalTo(OMO))
 783           return false;
 784         if (Check == CheckKillDead && MO.isDead() != OMO.isDead())
 785           return false;
 786       }
 787     } else {
 788       if (!MO.isIdenticalTo(OMO))
 789         return false;
 790       if (Check == CheckKillDead && MO.isKill() != OMO.isKill())
 791         return false;
 792     }
 793   }
 794   // If DebugLoc does not match then two dbg.values are not identical.
 795   if (isDebugValue())
 796     if (!getDebugLoc().isUnknown() && !Other->getDebugLoc().isUnknown()
 797         && getDebugLoc() != Other->getDebugLoc())
 798       return false;
 799   return true;
 800 }
 801
 802 /// removeFromParent - This method unlinks 'this' from the containing basic
 803 /// block, and returns it, but does not delete it.
 804 MachineInstr *MachineInstr::removeFromParent() {
 805   assert(getParent() && "Not embedded in a basic block!");
 806
 807   // If it's a bundle then remove the MIs inside the bundle as well.
 808   if (getOpcode() == TargetOpcode::BUNDLE) {
 809     MachineBasicBlock *MBB = getParent();
 810     MachineBasicBlock::insn_iterator MII = *this; ++MII;
 811     while (MII != MBB->end() && MII->isInsideBundle()) {
 812       MachineInstr *MI = &*MII;
 813       ++MII;
 814       MBB->remove(MI);
 815     }
 816   }
 817   getParent()->remove(this);
 818   return this;
 819 }
 820
 821
 822 /// eraseFromParent - This method unlinks 'this' from the containing basic
 823 /// block, and deletes it.
 824 void MachineInstr::eraseFromParent() {
 825   assert(getParent() && "Not embedded in a basic block!");
 826   // If it's a bundle then remove the MIs inside the bundle as well.
 827   if (getOpcode() == TargetOpcode::BUNDLE) {
 828     MachineBasicBlock *MBB = getParent();
 829     MachineBasicBlock::insn_iterator MII = *this; ++MII;
 830     while (MII != MBB->end() && MII->isInsideBundle()) {
 831       MachineInstr *MI = &*MII;
 832       ++MII;
 833       MBB->erase(MI);
 834     }
 835   }
 836   getParent()->erase(this);
 837 }
 838
 839
 840 /// getNumExplicitOperands - Returns the number of non-implicit operands.
 841 ///
 842 unsigned MachineInstr::getNumExplicitOperands() const {
 843   unsigned NumOperands = MCID->getNumOperands();
 844   if (!MCID->isVariadic())
 845     return NumOperands;
 846
 847   for (unsigned i = NumOperands, e = getNumOperands(); i != e; ++i) {
 848     const MachineOperand &MO = getOperand(i);
 849     if (!MO.isReg() || !MO.isImplicit())
 850       NumOperands++;
 851   }
 852   return NumOperands;
 853 }
 854
 855 bool MachineInstr::isStackAligningInlineAsm() const {
 856   if (isInlineAsm()) {
 857     unsigned ExtraInfo = getOperand(InlineAsm::MIOp_ExtraInfo).getImm();
 858     if (ExtraInfo & InlineAsm::Extra_IsAlignStack)
 859       return true;
 860   }
 861   return false;
 862 }
 863
 864 int MachineInstr::findInlineAsmFlagIdx(unsigned OpIdx,
 865                                        unsigned *GroupNo) const {
 866   assert(isInlineAsm() && "Expected an inline asm instruction");
 867   assert(OpIdx < getNumOperands() && "OpIdx out of range");
 868
 869   // Ignore queries about the initial operands.
 870   if (OpIdx < InlineAsm::MIOp_FirstOperand)
 871     return -1;
 872
 873   unsigned Group = 0;
 874   unsigned NumOps;
 875   for (unsigned i = InlineAsm::MIOp_FirstOperand, e = getNumOperands(); i < e;
 876        i += NumOps) {
 877     const MachineOperand &FlagMO = getOperand(i);
 878     // If we reach the implicit register operands, stop looking.
 879     if (!FlagMO.isImm())
 880       return -1;
 881     NumOps = 1 + InlineAsm::getNumOperandRegisters(FlagMO.getImm());
 882     if (i + NumOps > OpIdx) {
 883       if (GroupNo)
 884         *GroupNo = Group;
 885       return i;
 886     }
 887     ++Group;
 888   }
 889   return -1;
 890 }
 891
 892 const TargetRegisterClass*
 893 MachineInstr::getRegClassConstraint(unsigned OpIdx,
 894                                     const TargetInstrInfo *TII,
 895                                     const TargetRegisterInfo *TRI) const {
 896   // Most opcodes have fixed constraints in their MCInstrDesc.
 897   if (!isInlineAsm())
 898     return TII->getRegClass(getDesc(), OpIdx, TRI);
 899
 900   if (!getOperand(OpIdx).isReg())
 901     return NULL;
 902
 903   // For tied uses on inline asm, get the constraint from the def.
 904   unsigned DefIdx;
 905   if (getOperand(OpIdx).isUse() && isRegTiedToDefOperand(OpIdx, &DefIdx))
 906     OpIdx = DefIdx;
 907
 908   // Inline asm stores register class constraints in the flag word.
 909   int FlagIdx = findInlineAsmFlagIdx(OpIdx);
 910   if (FlagIdx < 0)
 911     return NULL;
 912
 913   unsigned Flag = getOperand(FlagIdx).getImm();
 914   unsigned RCID;
 915   if (InlineAsm::hasRegClassConstraint(Flag, RCID))
 916     return TRI->getRegClass(RCID);
 917
 918   // Assume that all registers in a memory operand are pointers.
 919   if (InlineAsm::getKind(Flag) == InlineAsm::Kind_Mem)
 920     return TRI->getPointerRegClass();
 921
 922   return NULL;
 923 }
 924
 925 /// findRegisterUseOperandIdx() - Returns the MachineOperand that is a use of
 926 /// the specific register or -1 if it is not found. It further tightens
 927 /// the search criteria to a use that kills the register if isKill is true.
 928 int MachineInstr::findRegisterUseOperandIdx(unsigned Reg, bool isKill,
 929                                           const TargetRegisterInfo *TRI) const {
 930   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 931     const MachineOperand &MO = getOperand(i);
 932     if (!MO.isReg() || !MO.isUse())
 933       continue;
 934     unsigned MOReg = MO.getReg();
 935     if (!MOReg)
 936       continue;
 937     if (MOReg == Reg ||
 938         (TRI &&
 939          TargetRegisterInfo::isPhysicalRegister(MOReg) &&
 940          TargetRegisterInfo::isPhysicalRegister(Reg) &&
 941          TRI->isSubRegister(MOReg, Reg)))
 942       if (!isKill || MO.isKill())
 943         return i;
 944   }
 945   return -1;
 946 }
 947
 948 /// readsWritesVirtualRegister - Return a pair of bools (reads, writes)
 949 /// indicating if this instruction reads or writes Reg. This also considers
 950 /// partial defines.
 951 std::pair<bool,bool>
 952 MachineInstr::readsWritesVirtualRegister(unsigned Reg,
 953                                          SmallVectorImpl<unsigned> *Ops) const {
 954   bool PartDef = false; // Partial redefine.
 955   bool FullDef = false; // Full define.
 956   bool Use = false;
 957
 958   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 959     const MachineOperand &MO = getOperand(i);
 960     if (!MO.isReg() || MO.getReg() != Reg)
 961       continue;
 962     if (Ops)
 963       Ops->push_back(i);
 964     if (MO.isUse())
 965       Use |= !MO.isUndef();
 966     else if (MO.getSubReg() && !MO.isUndef())
 967       // A partial <def,undef> doesn't count as reading the register.
 968       PartDef = true;
 969     else
 970       FullDef = true;
 971   }
 972   // A partial redefine uses Reg unless there is also a full define.
 973   return std::make_pair(Use || (PartDef && !FullDef), PartDef || FullDef);
 974 }
 975
 976 /// findRegisterDefOperandIdx() - Returns the operand index that is a def of
 977 /// the specified register or -1 if it is not found. If isDead is true, defs
 978 /// that are not dead are skipped. If TargetRegisterInfo is non-null, then it
 979 /// also checks if there is a def of a super-register.
 980 int
 981 MachineInstr::findRegisterDefOperandIdx(unsigned Reg, bool isDead, bool Overlap,
 982                                         const TargetRegisterInfo *TRI) const {
 983   bool isPhys = TargetRegisterInfo::isPhysicalRegister(Reg);
 984   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 985     const MachineOperand &MO = getOperand(i);
 986     if (!MO.isReg() || !MO.isDef())
 987       continue;
 988     unsigned MOReg = MO.getReg();
 989     bool Found = (MOReg == Reg);
 990     if (!Found && TRI && isPhys &&
 991         TargetRegisterInfo::isPhysicalRegister(MOReg)) {
 992       if (Overlap)
 993         Found = TRI->regsOverlap(MOReg, Reg);
 994       else
 995         Found = TRI->isSubRegister(MOReg, Reg);
 996     }
 997     if (Found && (!isDead || MO.isDead()))
 998       return i;
 999   }
1000   return -1;
1001 }
1002
1003 /// findFirstPredOperandIdx() - Find the index of the first operand in the
1004 /// operand list that is used to represent the predicate. It returns -1 if
1005 /// none is found.
1006 int MachineInstr::findFirstPredOperandIdx() const {
1007   // Don't call MCID.findFirstPredOperandIdx() because this variant
1008   // is sometimes called on an instruction that's not yet complete, and
1009   // so the number of operands is less than the MCID indicates. In
1010   // particular, the PTX target does this.
1011   const MCInstrDesc &MCID = getDesc();
1012   if (MCID.isPredicable()) {
1013     for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1014       if (MCID.OpInfo[i].isPredicate())
1015         return i;
1016   }
1017
1018   return -1;
1019 }
1020
1021 /// isRegTiedToUseOperand - Given the index of a register def operand,
1022 /// check if the register def is tied to a source operand, due to either
1023 /// two-address elimination or inline assembly constraints. Returns the
1024 /// first tied use operand index by reference is UseOpIdx is not null.
1025 bool MachineInstr::
1026 isRegTiedToUseOperand(unsigned DefOpIdx, unsigned *UseOpIdx) const {
1027   if (isInlineAsm()) {
1028     assert(DefOpIdx > InlineAsm::MIOp_FirstOperand);
1029     const MachineOperand &MO = getOperand(DefOpIdx);
1030     if (!MO.isReg() || !MO.isDef() || MO.getReg() == 0)
1031       return false;
1032     // Determine the actual operand index that corresponds to this index.
1033     unsigned DefNo = 0;
1034     int FlagIdx = findInlineAsmFlagIdx(DefOpIdx, &DefNo);
1035     if (FlagIdx < 0)
1036       return false;
1037
1038     // Which part of the group is DefOpIdx?
1039     unsigned DefPart = DefOpIdx - (FlagIdx + 1);
1040
1041     for (unsigned i = InlineAsm::MIOp_FirstOperand, e = getNumOperands();
1042          i != e; ++i) {
1043       const MachineOperand &FMO = getOperand(i);
1044       if (!FMO.isImm())
1045         continue;
1046       if (i+1 >= e || !getOperand(i+1).isReg() || !getOperand(i+1).isUse())
1047         continue;
1048       unsigned Idx;
1049       if (InlineAsm::isUseOperandTiedToDef(FMO.getImm(), Idx) &&
1050           Idx == DefNo) {
1051         if (UseOpIdx)
1052           *UseOpIdx = (unsigned)i + 1 + DefPart;
1053         return true;
1054       }
1055     }
1056     return false;
1057   }
1058
1059   assert(getOperand(DefOpIdx).isDef() && "DefOpIdx is not a def!");
1060   const MCInstrDesc &MCID = getDesc();
1061   for (unsigned i = 0, e = MCID.getNumOperands(); i != e; ++i) {
1062     const MachineOperand &MO = getOperand(i);
1063     if (MO.isReg() && MO.isUse() &&
1064         MCID.getOperandConstraint(i, MCOI::TIED_TO) == (int)DefOpIdx) {
1065       if (UseOpIdx)
1066         *UseOpIdx = (unsigned)i;
1067       return true;
1068     }
1069   }
1070   return false;
1071 }
1072
1073 /// isRegTiedToDefOperand - Return true if the operand of the specified index
1074 /// is a register use and it is tied to an def operand. It also returns the def
1075 /// operand index by reference.
1076 bool MachineInstr::
1077 isRegTiedToDefOperand(unsigned UseOpIdx, unsigned *DefOpIdx) const {
1078   if (isInlineAsm()) {
1079     const MachineOperand &MO = getOperand(UseOpIdx);
1080     if (!MO.isReg() || !MO.isUse() || MO.getReg() == 0)
1081       return false;
1082
1083     // Find the flag operand corresponding to UseOpIdx
1084     int FlagIdx = findInlineAsmFlagIdx(UseOpIdx);
1085     if (FlagIdx < 0)
1086       return false;
1087
1088     const MachineOperand &UFMO = getOperand(FlagIdx);
1089     unsigned DefNo;
1090     if (InlineAsm::isUseOperandTiedToDef(UFMO.getImm(), DefNo)) {
1091       if (!DefOpIdx)
1092         return true;
1093
1094       unsigned DefIdx = InlineAsm::MIOp_FirstOperand;
1095       // Remember to adjust the index. First operand is asm string, second is
1096       // the HasSideEffects and AlignStack bits, then there is a flag for each.
1097       while (DefNo) {
1098         const MachineOperand &FMO = getOperand(DefIdx);
1099         assert(FMO.isImm());
1100         // Skip over this def.
1101         DefIdx += InlineAsm::getNumOperandRegisters(FMO.getImm()) + 1;
1102         --DefNo;
1103       }
1104       *DefOpIdx = DefIdx + UseOpIdx - FlagIdx;
1105       return true;
1106     }
1107     return false;
1108   }
1109
1110   const MCInstrDesc &MCID = getDesc();
1111   if (UseOpIdx >= MCID.getNumOperands())
1112     return false;
1113   const MachineOperand &MO = getOperand(UseOpIdx);
1114   if (!MO.isReg() || !MO.isUse())
1115     return false;
1116   int DefIdx = MCID.getOperandConstraint(UseOpIdx, MCOI::TIED_TO);
1117   if (DefIdx == -1)
1118     return false;
1119   if (DefOpIdx)
1120     *DefOpIdx = (unsigned)DefIdx;
1121   return true;
1122 }
1123
1124 /// clearKillInfo - Clears kill flags on all operands.
1125 ///
1126 void MachineInstr::clearKillInfo() {
1127   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1128     MachineOperand &MO = getOperand(i);
1129     if (MO.isReg() && MO.isUse())
1130       MO.setIsKill(false);
1131   }
1132 }
1133
1134 /// copyKillDeadInfo - Copies kill / dead operand properties from MI.
1135 ///
1136 void MachineInstr::copyKillDeadInfo(const MachineInstr *MI) {
1137   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1138     const MachineOperand &MO = MI->getOperand(i);
1139     if (!MO.isReg() || (!MO.isKill() && !MO.isDead()))
1140       continue;
1141     for (unsigned j = 0, ee = getNumOperands(); j != ee; ++j) {
1142       MachineOperand &MOp = getOperand(j);
1143       if (!MOp.isIdenticalTo(MO))
1144         continue;
1145       if (MO.isKill())
1146         MOp.setIsKill();
1147       else
1148         MOp.setIsDead();
1149       break;
1150     }
1151   }
1152 }
1153
1154 /// copyPredicates - Copies predicate operand(s) from MI.
1155 void MachineInstr::copyPredicates(const MachineInstr *MI) {
1156   const MCInstrDesc &MCID = MI->getDesc();
1157   if (!MCID.isPredicable())
1158     return;
1159   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1160     if (MCID.OpInfo[i].isPredicate()) {
1161       // Predicated operands must be last operands.
1162       addOperand(MI->getOperand(i));
1163     }
1164   }
1165 }
1166
1167 void MachineInstr::substituteRegister(unsigned FromReg,
1168                                       unsigned ToReg,
1169                                       unsigned SubIdx,
1170                                       const TargetRegisterInfo &RegInfo) {
1171   if (TargetRegisterInfo::isPhysicalRegister(ToReg)) {
1172     if (SubIdx)
1173       ToReg = RegInfo.getSubReg(ToReg, SubIdx);
1174     for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1175       MachineOperand &MO = getOperand(i);
1176       if (!MO.isReg() || MO.getReg() != FromReg)
1177         continue;
1178       MO.substPhysReg(ToReg, RegInfo);
1179     }
1180   } else {
1181     for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1182       MachineOperand &MO = getOperand(i);
1183       if (!MO.isReg() || MO.getReg() != FromReg)
1184         continue;
1185       MO.substVirtReg(ToReg, SubIdx, RegInfo);
1186     }
1187   }
1188 }
1189
1190 /// isSafeToMove - Return true if it is safe to move this instruction. If
1191 /// SawStore is set to true, it means that there is a store (or call) between
1192 /// the instruction's location and its intended destination.
1193 bool MachineInstr::isSafeToMove(const TargetInstrInfo *TII,
1194                                 AliasAnalysis *AA,
1195                                 bool &SawStore) const {
1196   // Ignore stuff that we obviously can't move.
1197   if (MCID->mayStore() || MCID->isCall()) {
1198     SawStore = true;
1199     return false;
1200   }
1201
1202   if (isLabel() || isDebugValue() ||
1203       MCID->isTerminator() || hasUnmodeledSideEffects())
1204     return false;
1205
1206   // See if this instruction does a load.  If so, we have to guarantee that the
1207   // loaded value doesn't change between the load and the its intended
1208   // destination. The check for isInvariantLoad gives the targe the chance to
1209   // classify the load as always returning a constant, e.g. a constant pool
1210   // load.
1211   if (MCID->mayLoad() && !isInvariantLoad(AA))
1212     // Otherwise, this is a real load.  If there is a store between the load and
1213     // end of block, or if the load is volatile, we can't move it.
1214     return !SawStore && !hasVolatileMemoryRef();
1215
1216   return true;
1217 }
1218
1219 /// isSafeToReMat - Return true if it's safe to rematerialize the specified
1220 /// instruction which defined the specified register instead of copying it.
1221 bool MachineInstr::isSafeToReMat(const TargetInstrInfo *TII,
1222                                  AliasAnalysis *AA,
1223                                  unsigned DstReg) const {
1224   bool SawStore = false;
1225   if (!TII->isTriviallyReMaterializable(this, AA) ||
1226       !isSafeToMove(TII, AA, SawStore))
1227     return false;
1228   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1229     const MachineOperand &MO = getOperand(i);
1230     if (!MO.isReg())
1231       continue;
1232     // FIXME: For now, do not remat any instruction with register operands.
1233     // Later on, we can loosen the restriction is the register operands have
1234     // not been modified between the def and use. Note, this is different from
1235     // MachineSink because the code is no longer in two-address form (at least
1236     // partially).
1237     if (MO.isUse())
1238       return false;
1239     else if (!MO.isDead() && MO.getReg() != DstReg)
1240       return false;
1241   }
1242   return true;
1243 }
1244
1245 /// hasVolatileMemoryRef - Return true if this instruction may have a
1246 /// volatile memory reference, or if the information describing the
1247 /// memory reference is not available. Return false if it is known to
1248 /// have no volatile memory references.
1249 bool MachineInstr::hasVolatileMemoryRef() const {
1250   // An instruction known never to access memory won't have a volatile access.
1251   if (!MCID->mayStore() &&
1252       !MCID->mayLoad() &&
1253       !MCID->isCall() &&
1254       !hasUnmodeledSideEffects())
1255     return false;
1256
1257   // Otherwise, if the instruction has no memory reference information,
1258   // conservatively assume it wasn't preserved.
1259   if (memoperands_empty())
1260     return true;
1261
1262   // Check the memory reference information for volatile references.
1263   for (mmo_iterator I = memoperands_begin(), E = memoperands_end(); I != E; ++I)
1264     if ((*I)->isVolatile())
1265       return true;
1266
1267   return false;
1268 }
1269
1270 /// isInvariantLoad - Return true if this instruction is loading from a
1271 /// location whose value is invariant across the function.  For example,
1272 /// loading a value from the constant pool or from the argument area
1273 /// of a function if it does not change.  This should only return true of
1274 /// *all* loads the instruction does are invariant (if it does multiple loads).
1275 bool MachineInstr::isInvariantLoad(AliasAnalysis *AA) const {
1276   // If the instruction doesn't load at all, it isn't an invariant load.
1277   if (!MCID->mayLoad())
1278     return false;
1279
1280   // If the instruction has lost its memoperands, conservatively assume that
1281   // it may not be an invariant load.
1282   if (memoperands_empty())
1283     return false;
1284
1285   const MachineFrameInfo *MFI = getParent()->getParent()->getFrameInfo();
1286
1287   for (mmo_iterator I = memoperands_begin(),
1288        E = memoperands_end(); I != E; ++I) {
1289     if ((*I)->isVolatile()) return false;
1290     if ((*I)->isStore()) return false;
1291     if ((*I)->isInvariant()) return true;
1292
1293     if (const Value *V = (*I)->getValue()) {
1294       // A load from a constant PseudoSourceValue is invariant.
1295       if (const PseudoSourceValue *PSV = dyn_cast<PseudoSourceValue>(V))
1296         if (PSV->isConstant(MFI))
1297           continue;
1298       // If we have an AliasAnalysis, ask it whether the memory is constant.
1299       if (AA && AA->pointsToConstantMemory(
1300                       AliasAnalysis::Location(V, (*I)->getSize(),
1301                                               (*I)->getTBAAInfo())))
1302         continue;
1303     }
1304
1305     // Otherwise assume conservatively.
1306     return false;
1307   }
1308
1309   // Everything checks out.
1310   return true;
1311 }
1312
1313 /// isConstantValuePHI - If the specified instruction is a PHI that always
1314 /// merges together the same virtual register, return the register, otherwise
1315 /// return 0.
1316 unsigned MachineInstr::isConstantValuePHI() const {
1317   if (!isPHI())
1318     return 0;
1319   assert(getNumOperands() >= 3 &&
1320          "It's illegal to have a PHI without source operands");
1321
1322   unsigned Reg = getOperand(1).getReg();
1323   for (unsigned i = 3, e = getNumOperands(); i < e; i += 2)
1324     if (getOperand(i).getReg() != Reg)
1325       return 0;
1326   return Reg;
1327 }
1328
1329 bool MachineInstr::hasUnmodeledSideEffects() const {
1330   if (getDesc().hasUnmodeledSideEffects())
1331     return true;
1332   if (isInlineAsm()) {
1333     unsigned ExtraInfo = getOperand(InlineAsm::MIOp_ExtraInfo).getImm();
1334     if (ExtraInfo & InlineAsm::Extra_HasSideEffects)
1335       return true;
1336   }
1337
1338   return false;
1339 }
1340
1341 /// allDefsAreDead - Return true if all the defs of this instruction are dead.
1342 ///
1343 bool MachineInstr::allDefsAreDead() const {
1344   for (unsigned i = 0, e = getNumOperands(); i < e; ++i) {
1345     const MachineOperand &MO = getOperand(i);
1346     if (!MO.isReg() || MO.isUse())
1347       continue;
1348     if (!MO.isDead())
1349       return false;
1350   }
1351   return true;
1352 }
1353
1354 /// copyImplicitOps - Copy implicit register operands from specified
1355 /// instruction to this instruction.
1356 void MachineInstr::copyImplicitOps(const MachineInstr *MI) {
1357   for (unsigned i = MI->getDesc().getNumOperands(), e = MI->getNumOperands();
1358        i != e; ++i) {
1359     const MachineOperand &MO = MI->getOperand(i);
1360     if (MO.isReg() && MO.isImplicit())
1361       addOperand(MO);
1362   }
1363 }
1364
1365 void MachineInstr::dump() const {
1366   dbgs() << "  " << *this;
1367 }
1368
1369 static void printDebugLoc(DebugLoc DL, const MachineFunction *MF,
1370                          raw_ostream &CommentOS) {
1371   const LLVMContext &Ctx = MF->getFunction()->getContext();
1372   if (!DL.isUnknown()) {          // Print source line info.
1373     DIScope Scope(DL.getScope(Ctx));
1374     // Omit the directory, because it's likely to be long and uninteresting.
1375     if (Scope.Verify())
1376       CommentOS << Scope.getFilename();
1377     else
1378       CommentOS << "<unknown>";
1379     CommentOS << ':' << DL.getLine();
1380     if (DL.getCol() != 0)
1381       CommentOS << ':' << DL.getCol();
1382     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1383     if (!InlinedAtDL.isUnknown()) {
1384       CommentOS << " @[ ";
1385       printDebugLoc(InlinedAtDL, MF, CommentOS);
1386       CommentOS << " ]";
1387     }
1388   }
1389 }
1390
1391 void MachineInstr::print(raw_ostream &OS, const TargetMachine *TM) const {
1392   // We can be a bit tidier if we know the TargetMachine and/or MachineFunction.
1393   const MachineFunction *MF = 0;
1394   const MachineRegisterInfo *MRI = 0;
1395   if (const MachineBasicBlock *MBB = getParent()) {
1396     MF = MBB->getParent();
1397     if (!TM && MF)
1398       TM = &MF->getTarget();
1399     if (MF)
1400       MRI = &MF->getRegInfo();
1401   }
1402
1403   // Save a list of virtual registers.
1404   SmallVector<unsigned, 8> VirtRegs;
1405
1406   // Print explicitly defined operands on the left of an assignment syntax.
1407   unsigned StartOp = 0, e = getNumOperands();
1408   for (; StartOp < e && getOperand(StartOp).isReg() &&
1409          getOperand(StartOp).isDef() &&
1410          !getOperand(StartOp).isImplicit();
1411        ++StartOp) {
1412     if (StartOp != 0) OS << ", ";
1413     getOperand(StartOp).print(OS, TM);
1414     unsigned Reg = getOperand(StartOp).getReg();
1415     if (TargetRegisterInfo::isVirtualRegister(Reg))
1416       VirtRegs.push_back(Reg);
1417   }
1418
1419   if (StartOp != 0)
1420     OS << " = ";
1421
1422   // Print the opcode name.
1423   OS << getDesc().getName();
1424
1425   // Print the rest of the operands.
1426   bool OmittedAnyCallClobbers = false;
1427   bool FirstOp = true;
1428   unsigned AsmDescOp = ~0u;
1429   unsigned AsmOpCount = 0;
1430
1431   if (isInlineAsm() && e >= InlineAsm::MIOp_FirstOperand) {
1432     // Print asm string.
1433     OS << " ";
1434     getOperand(InlineAsm::MIOp_AsmString).print(OS, TM);
1435
1436     // Print HasSideEffects, IsAlignStack
1437     unsigned ExtraInfo = getOperand(InlineAsm::MIOp_ExtraInfo).getImm();
1438     if (ExtraInfo & InlineAsm::Extra_HasSideEffects)
1439       OS << " [sideeffect]";
1440     if (ExtraInfo & InlineAsm::Extra_IsAlignStack)
1441       OS << " [alignstack]";
1442
1443     StartOp = AsmDescOp = InlineAsm::MIOp_FirstOperand;
1444     FirstOp = false;
1445   }
1446
1447
1448   for (unsigned i = StartOp, e = getNumOperands(); i != e; ++i) {
1449     const MachineOperand &MO = getOperand(i);
1450
1451     if (MO.isReg() && TargetRegisterInfo::isVirtualRegister(MO.getReg()))
1452       VirtRegs.push_back(MO.getReg());
1453
1454     // Omit call-clobbered registers which aren't used anywhere. This makes
1455     // call instructions much less noisy on targets where calls clobber lots
1456     // of registers. Don't rely on MO.isDead() because we may be called before
1457     // LiveVariables is run, or we may be looking at a non-allocatable reg.
1458     if (MF && getDesc().isCall() &&
1459         MO.isReg() && MO.isImplicit() && MO.isDef()) {
1460       unsigned Reg = MO.getReg();
1461       if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
1462         const MachineRegisterInfo &MRI = MF->getRegInfo();
1463         if (MRI.use_empty(Reg) && !MRI.isLiveOut(Reg)) {
1464           bool HasAliasLive = false;
1465           for (const unsigned *Alias = TM->getRegisterInfo()->getAliasSet(Reg);
1466                unsigned AliasReg = *Alias; ++Alias)
1467             if (!MRI.use_empty(AliasReg) || MRI.isLiveOut(AliasReg)) {
1468               HasAliasLive = true;
1469               break;
1470             }
1471           if (!HasAliasLive) {
1472             OmittedAnyCallClobbers = true;
1473             continue;
1474           }
1475         }
1476       }
1477     }
1478
1479     if (FirstOp) FirstOp = false; else OS << ",";
1480     OS << " ";
1481     if (i < getDesc().NumOperands) {
1482       const MCOperandInfo &MCOI = getDesc().OpInfo[i];
1483       if (MCOI.isPredicate())
1484         OS << "pred:";
1485       if (MCOI.isOptionalDef())
1486         OS << "opt:";
1487     }
1488     if (isDebugValue() && MO.isMetadata()) {
1489       // Pretty print DBG_VALUE instructions.
1490       const MDNode *MD = MO.getMetadata();
1491       if (const MDString *MDS = dyn_cast<MDString>(MD->getOperand(2)))
1492         OS << "!\"" << MDS->getString() << '\"';
1493       else
1494         MO.print(OS, TM);
1495     } else if (TM && (isInsertSubreg() || isRegSequence()) && MO.isImm()) {
1496       OS << TM->getRegisterInfo()->getSubRegIndexName(MO.getImm());
1497     } else if (i == AsmDescOp && MO.isImm()) {
1498       // Pretty print the inline asm operand descriptor.
1499       OS << '$' << AsmOpCount++;
1500       unsigned Flag = MO.getImm();
1501       switch (InlineAsm::getKind(Flag)) {
1502       case InlineAsm::Kind_RegUse:             OS << ":[reguse"; break;
1503       case InlineAsm::Kind_RegDef:             OS << ":[regdef"; break;
1504       case InlineAsm::Kind_RegDefEarlyClobber: OS << ":[regdef-ec"; break;
1505       case InlineAsm::Kind_Clobber:            OS << ":[clobber"; break;
1506       case InlineAsm::Kind_Imm:                OS << ":[imm"; break;
1507       case InlineAsm::Kind_Mem:                OS << ":[mem"; break;
1508       default: OS << ":[??" << InlineAsm::getKind(Flag); break;
1509       }
1510
1511       unsigned RCID = 0;
1512       if (InlineAsm::hasRegClassConstraint(Flag, RCID)) {
1513         if (TM)
1514           OS << ':' << TM->getRegisterInfo()->getRegClass(RCID)->getName();
1515         else
1516           OS << ":RC" << RCID;
1517       }
1518
1519       unsigned TiedTo = 0;
1520       if (InlineAsm::isUseOperandTiedToDef(Flag, TiedTo))
1521         OS << " tiedto:$" << TiedTo;
1522
1523       OS << ']';
1524
1525       // Compute the index of the next operand descriptor.
1526       AsmDescOp += 1 + InlineAsm::getNumOperandRegisters(Flag);
1527     } else
1528       MO.print(OS, TM);
1529   }
1530
1531   // Briefly indicate whether any call clobbers were omitted.
1532   if (OmittedAnyCallClobbers) {
1533     if (!FirstOp) OS << ",";
1534     OS << " ...";
1535   }
1536
1537   bool HaveSemi = false;
1538   if (Flags) {
1539     if (!HaveSemi) OS << ";"; HaveSemi = true;
1540     OS << " flags: ";
1541
1542     if (Flags & FrameSetup)
1543       OS << "FrameSetup";
1544   }
1545
1546   if (!memoperands_empty()) {
1547     if (!HaveSemi) OS << ";"; HaveSemi = true;
1548
1549     OS << " mem:";
1550     for (mmo_iterator i = memoperands_begin(), e = memoperands_end();
1551          i != e; ++i) {
1552       OS << **i;
1553       if (llvm::next(i) != e)
1554         OS << " ";
1555     }
1556   }
1557
1558   // Print the regclass of any virtual registers encountered.
1559   if (MRI && !VirtRegs.empty()) {
1560     if (!HaveSemi) OS << ";"; HaveSemi = true;
1561     for (unsigned i = 0; i != VirtRegs.size(); ++i) {
1562       const TargetRegisterClass *RC = MRI->getRegClass(VirtRegs[i]);
1563       OS << " " << RC->getName() << ':' << PrintReg(VirtRegs[i]);
1564       for (unsigned j = i+1; j != VirtRegs.size();) {
1565         if (MRI->getRegClass(VirtRegs[j]) != RC) {
1566           ++j;
1567           continue;
1568         }
1569         if (VirtRegs[i] != VirtRegs[j])
1570           OS << "," << PrintReg(VirtRegs[j]);
1571         VirtRegs.erase(VirtRegs.begin()+j);
1572       }
1573     }
1574   }
1575
1576   // Print debug location information.
1577   if (isDebugValue() && getOperand(e - 1).isMetadata()) {
1578     if (!HaveSemi) OS << ";"; HaveSemi = true;
1579     DIVariable DV(getOperand(e - 1).getMetadata());
1580     OS << " line no:" <<  DV.getLineNumber();
1581     if (MDNode *InlinedAt = DV.getInlinedAt()) {
1582       DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1583       if (!InlinedAtDL.isUnknown()) {
1584         OS << " inlined @[ ";
1585         printDebugLoc(InlinedAtDL, MF, OS);
1586         OS << " ]";
1587       }
1588     }
1589   } else if (!debugLoc.isUnknown() && MF) {
1590     if (!HaveSemi) OS << ";"; HaveSemi = true;
1591     OS << " dbg:";
1592     printDebugLoc(debugLoc, MF, OS);
1593   }
1594
1595   OS << '\n';
1596 }
1597
1598 bool MachineInstr::addRegisterKilled(unsigned IncomingReg,
1599                                      const TargetRegisterInfo *RegInfo,
1600                                      bool AddIfNotFound) {
1601   bool isPhysReg = TargetRegisterInfo::isPhysicalRegister(IncomingReg);
1602   bool hasAliases = isPhysReg && RegInfo->getAliasSet(IncomingReg);
1603   bool Found = false;
1604   SmallVector<unsigned,4> DeadOps;
1605   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1606     MachineOperand &MO = getOperand(i);
1607     if (!MO.isReg() || !MO.isUse() || MO.isUndef())
1608       continue;
1609     unsigned Reg = MO.getReg();
1610     if (!Reg)
1611       continue;
1612
1613     if (Reg == IncomingReg) {
1614       if (!Found) {
1615         if (MO.isKill())
1616           // The register is already marked kill.
1617           return true;
1618         if (isPhysReg && isRegTiedToDefOperand(i))
1619           // Two-address uses of physregs must not be marked kill.
1620           return true;
1621         MO.setIsKill();
1622         Found = true;
1623       }
1624     } else if (hasAliases && MO.isKill() &&
1625                TargetRegisterInfo::isPhysicalRegister(Reg)) {
1626       // A super-register kill already exists.
1627       if (RegInfo->isSuperRegister(IncomingReg, Reg))
1628         return true;
1629       if (RegInfo->isSubRegister(IncomingReg, Reg))
1630         DeadOps.push_back(i);
1631     }
1632   }
1633
1634   // Trim unneeded kill operands.
1635   while (!DeadOps.empty()) {
1636     unsigned OpIdx = DeadOps.back();
1637     if (getOperand(OpIdx).isImplicit())
1638       RemoveOperand(OpIdx);
1639     else
1640       getOperand(OpIdx).setIsKill(false);
1641     DeadOps.pop_back();
1642   }
1643
1644   // If not found, this means an alias of one of the operands is killed. Add a
1645   // new implicit operand if required.
1646   if (!Found && AddIfNotFound) {
1647     addOperand(MachineOperand::CreateReg(IncomingReg,
1648                                          false /*IsDef*/,
1649                                          true  /*IsImp*/,
1650                                          true  /*IsKill*/));
1651     return true;
1652   }
1653   return Found;
1654 }
1655
1656 bool MachineInstr::addRegisterDead(unsigned IncomingReg,
1657                                    const TargetRegisterInfo *RegInfo,
1658                                    bool AddIfNotFound) {
1659   bool isPhysReg = TargetRegisterInfo::isPhysicalRegister(IncomingReg);
1660   bool hasAliases = isPhysReg && RegInfo->getAliasSet(IncomingReg);
1661   bool Found = false;
1662   SmallVector<unsigned,4> DeadOps;
1663   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1664     MachineOperand &MO = getOperand(i);
1665     if (!MO.isReg() || !MO.isDef())
1666       continue;
1667     unsigned Reg = MO.getReg();
1668     if (!Reg)
1669       continue;
1670
1671     if (Reg == IncomingReg) {
1672       MO.setIsDead();
1673       Found = true;
1674     } else if (hasAliases && MO.isDead() &&
1675                TargetRegisterInfo::isPhysicalRegister(Reg)) {
1676       // There exists a super-register that's marked dead.
1677       if (RegInfo->isSuperRegister(IncomingReg, Reg))
1678         return true;
1679       if (RegInfo->getSubRegisters(IncomingReg) &&
1680           RegInfo->getSuperRegisters(Reg) &&
1681           RegInfo->isSubRegister(IncomingReg, Reg))
1682         DeadOps.push_back(i);
1683     }
1684   }
1685
1686   // Trim unneeded dead operands.
1687   while (!DeadOps.empty()) {
1688     unsigned OpIdx = DeadOps.back();
1689     if (getOperand(OpIdx).isImplicit())
1690       RemoveOperand(OpIdx);
1691     else
1692       getOperand(OpIdx).setIsDead(false);
1693     DeadOps.pop_back();
1694   }
1695
1696   // If not found, this means an alias of one of the operands is dead. Add a
1697   // new implicit operand if required.
1698   if (Found || !AddIfNotFound)
1699     return Found;
1700
1701   addOperand(MachineOperand::CreateReg(IncomingReg,
1702                                        true  /*IsDef*/,
1703                                        true  /*IsImp*/,
1704                                        false /*IsKill*/,
1705                                        true  /*IsDead*/));
1706   return true;
1707 }
1708
1709 void MachineInstr::addRegisterDefined(unsigned IncomingReg,
1710                                       const TargetRegisterInfo *RegInfo) {
1711   if (TargetRegisterInfo::isPhysicalRegister(IncomingReg)) {
1712     MachineOperand *MO = findRegisterDefOperand(IncomingReg, false, RegInfo);
1713     if (MO)
1714       return;
1715   } else {
1716     for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1717       const MachineOperand &MO = getOperand(i);
1718       if (MO.isReg() && MO.getReg() == IncomingReg && MO.isDef() &&
1719           MO.getSubReg() == 0)
1720         return;
1721     }
1722   }
1723   addOperand(MachineOperand::CreateReg(IncomingReg,
1724                                        true  /*IsDef*/,
1725                                        true  /*IsImp*/));
1726 }
1727
1728 void MachineInstr::setPhysRegsDeadExcept(const SmallVectorImpl<unsigned> &UsedRegs,
1729                                          const TargetRegisterInfo &TRI) {
1730   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1731     MachineOperand &MO = getOperand(i);
1732     if (!MO.isReg() || !MO.isDef()) continue;
1733     unsigned Reg = MO.getReg();
1734     if (Reg == 0) continue;
1735     bool Dead = true;
1736     for (SmallVectorImpl<unsigned>::const_iterator I = UsedRegs.begin(),
1737          E = UsedRegs.end(); I != E; ++I)
1738       if (TRI.regsOverlap(*I, Reg)) {
1739         Dead = false;
1740         break;
1741       }
1742     // If there are no uses, including partial uses, the def is dead.
1743     if (Dead) MO.setIsDead();
1744   }
1745 }
1746
1747 unsigned
1748 MachineInstrExpressionTrait::getHashValue(const MachineInstr* const &MI) {
1749   unsigned Hash = MI->getOpcode() * 37;
1750   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1751     const MachineOperand &MO = MI->getOperand(i);
1752     uint64_t Key = (uint64_t)MO.getType() << 32;
1753     switch (MO.getType()) {
1754     default: break;
1755     case MachineOperand::MO_Register:
1756       if (MO.isDef() && TargetRegisterInfo::isVirtualRegister(MO.getReg()))
1757         continue;  // Skip virtual register defs.
1758       Key |= MO.getReg();
1759       break;
1760     case MachineOperand::MO_Immediate:
1761       Key |= MO.getImm();
1762       break;
1763     case MachineOperand::MO_FrameIndex:
1764     case MachineOperand::MO_ConstantPoolIndex:
1765     case MachineOperand::MO_JumpTableIndex:
1766       Key |= MO.getIndex();
1767       break;
1768     case MachineOperand::MO_MachineBasicBlock:
1769       Key |= DenseMapInfo<void*>::getHashValue(MO.getMBB());
1770       break;
1771     case MachineOperand::MO_GlobalAddress:
1772       Key |= DenseMapInfo<void*>::getHashValue(MO.getGlobal());
1773       break;
1774     case MachineOperand::MO_BlockAddress:
1775       Key |= DenseMapInfo<void*>::getHashValue(MO.getBlockAddress());
1776       break;
1777     case MachineOperand::MO_MCSymbol:
1778       Key |= DenseMapInfo<void*>::getHashValue(MO.getMCSymbol());
1779       break;
1780     }
1781     Key += ~(Key << 32);
1782     Key ^= (Key >> 22);
1783     Key += ~(Key << 13);
1784     Key ^= (Key >> 8);
1785     Key += (Key << 3);
1786     Key ^= (Key >> 15);
1787     Key += ~(Key << 27);
1788     Key ^= (Key >> 31);
1789     Hash = (unsigned)Key + Hash * 37;
1790   }
1791   return Hash;
1792 }
1793
1794 void MachineInstr::emitError(StringRef Msg) const {
1795   // Find the source location cookie.
1796   unsigned LocCookie = 0;
1797   const MDNode *LocMD = 0;
1798   for (unsigned i = getNumOperands(); i != 0; --i) {
1799     if (getOperand(i-1).isMetadata() &&
1800         (LocMD = getOperand(i-1).getMetadata()) &&
1801         LocMD->getNumOperands() != 0) {
1802       if (const ConstantInt *CI = dyn_cast<ConstantInt>(LocMD->getOperand(0))) {
1803         LocCookie = CI->getZExtValue();
1804         break;
1805       }
1806     }
1807   }
1808
1809   if (const MachineBasicBlock *MBB = getParent())
1810     if (const MachineFunction *MF = MBB->getParent())
1811       return MF->getMMI().getModule()->getContext().emitError(LocCookie, Msg);
1812   report_fatal_error(Msg);
1813 }