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