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