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