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