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/InlineAsm.h"
  17 #include "llvm/Value.h"
  18 #include "llvm/CodeGen/MachineFunction.h"
  19 #include "llvm/CodeGen/MachineRegisterInfo.h"
  20 #include "llvm/CodeGen/PseudoSourceValue.h"
  21 #include "llvm/Target/TargetMachine.h"
  22 #include "llvm/Target/TargetInstrInfo.h"
  23 #include "llvm/Target/TargetInstrDesc.h"
  24 #include "llvm/Target/TargetRegisterInfo.h"
  25 #include "llvm/Support/LeakDetector.h"
  26 #include "llvm/Support/MathExtras.h"
  27 #include "llvm/Support/Streams.h"
  28 #include "llvm/Support/raw_ostream.h"
  29 #include "llvm/ADT/FoldingSet.h"
  30 #include <ostream>
  31 using namespace llvm;
  32
  33 //===----------------------------------------------------------------------===//
  34 // MachineOperand Implementation
  35 //===----------------------------------------------------------------------===//
  36
  37 /// AddRegOperandToRegInfo - Add this register operand to the specified
  38 /// MachineRegisterInfo.  If it is null, then the next/prev fields should be
  39 /// explicitly nulled out.
  40 void MachineOperand::AddRegOperandToRegInfo(MachineRegisterInfo *RegInfo) {
  41   assert(isReg() && "Can only add reg operand to use lists");
  42
  43   // If the reginfo pointer is null, just explicitly null out or next/prev
  44   // pointers, to ensure they are not garbage.
  45   if (RegInfo == 0) {
  46     Contents.Reg.Prev = 0;
  47     Contents.Reg.Next = 0;
  48     return;
  49   }
  50
  51   // Otherwise, add this operand to the head of the registers use/def list.
  52   MachineOperand **Head = &RegInfo->getRegUseDefListHead(getReg());
  53
  54   // For SSA values, we prefer to keep the definition at the start of the list.
  55   // we do this by skipping over the definition if it is at the head of the
  56   // list.
  57   if (*Head && (*Head)->isDef())
  58     Head = &(*Head)->Contents.Reg.Next;
  59
  60   Contents.Reg.Next = *Head;
  61   if (Contents.Reg.Next) {
  62     assert(getReg() == Contents.Reg.Next->getReg() &&
  63            "Different regs on the same list!");
  64     Contents.Reg.Next->Contents.Reg.Prev = &Contents.Reg.Next;
  65   }
  66
  67   Contents.Reg.Prev = Head;
  68   *Head = this;
  69 }
  70
  71 void MachineOperand::setReg(unsigned Reg) {
  72   if (getReg() == Reg) return; // No change.
  73
  74   // Otherwise, we have to change the register.  If this operand is embedded
  75   // into a machine function, we need to update the old and new register's
  76   // use/def lists.
  77   if (MachineInstr *MI = getParent())
  78     if (MachineBasicBlock *MBB = MI->getParent())
  79       if (MachineFunction *MF = MBB->getParent()) {
  80         RemoveRegOperandFromRegInfo();
  81         Contents.Reg.RegNo = Reg;
  82         AddRegOperandToRegInfo(&MF->getRegInfo());
  83         return;
  84       }
  85
  86   // Otherwise, just change the register, no problem.  :)
  87   Contents.Reg.RegNo = Reg;
  88 }
  89
  90 /// ChangeToImmediate - Replace this operand with a new immediate operand of
  91 /// the specified value.  If an operand is known to be an immediate already,
  92 /// the setImm method should be used.
  93 void MachineOperand::ChangeToImmediate(int64_t ImmVal) {
  94   // If this operand is currently a register operand, and if this is in a
  95   // function, deregister the operand from the register's use/def list.
  96   if (isReg() && getParent() && getParent()->getParent() &&
  97       getParent()->getParent()->getParent())
  98     RemoveRegOperandFromRegInfo();
  99
 100   OpKind = MO_Immediate;
 101   Contents.ImmVal = ImmVal;
 102 }
 103
 104 /// ChangeToRegister - Replace this operand with a new register operand of
 105 /// the specified value.  If an operand is known to be an register already,
 106 /// the setReg method should be used.
 107 void MachineOperand::ChangeToRegister(unsigned Reg, bool isDef, bool isImp,
 108                                       bool isKill, bool isDead) {
 109   // If this operand is already a register operand, use setReg to update the
 110   // register's use/def lists.
 111   if (isReg()) {
 112     assert(!isEarlyClobber());
 113     setReg(Reg);
 114   } else {
 115     // Otherwise, change this to a register and set the reg#.
 116     OpKind = MO_Register;
 117     Contents.Reg.RegNo = Reg;
 118
 119     // If this operand is embedded in a function, add the operand to the
 120     // register's use/def list.
 121     if (MachineInstr *MI = getParent())
 122       if (MachineBasicBlock *MBB = MI->getParent())
 123         if (MachineFunction *MF = MBB->getParent())
 124           AddRegOperandToRegInfo(&MF->getRegInfo());
 125   }
 126
 127   IsDef = isDef;
 128   IsImp = isImp;
 129   IsKill = isKill;
 130   IsDead = isDead;
 131   IsEarlyClobber = false;
 132   SubReg = 0;
 133 }
 134
 135 /// isIdenticalTo - Return true if this operand is identical to the specified
 136 /// operand.
 137 bool MachineOperand::isIdenticalTo(const MachineOperand &Other) const {
 138   if (getType() != Other.getType()) return false;
 139
 140   switch (getType()) {
 141   default: assert(0 && "Unrecognized operand type");
 142   case MachineOperand::MO_Register:
 143     return getReg() == Other.getReg() && isDef() == Other.isDef() &&
 144            getSubReg() == Other.getSubReg();
 145   case MachineOperand::MO_Immediate:
 146     return getImm() == Other.getImm();
 147   case MachineOperand::MO_FPImmediate:
 148     return getFPImm() == Other.getFPImm();
 149   case MachineOperand::MO_MachineBasicBlock:
 150     return getMBB() == Other.getMBB();
 151   case MachineOperand::MO_FrameIndex:
 152     return getIndex() == Other.getIndex();
 153   case MachineOperand::MO_ConstantPoolIndex:
 154     return getIndex() == Other.getIndex() && getOffset() == Other.getOffset();
 155   case MachineOperand::MO_JumpTableIndex:
 156     return getIndex() == Other.getIndex();
 157   case MachineOperand::MO_GlobalAddress:
 158     return getGlobal() == Other.getGlobal() && getOffset() == Other.getOffset();
 159   case MachineOperand::MO_ExternalSymbol:
 160     return !strcmp(getSymbolName(), Other.getSymbolName()) &&
 161            getOffset() == Other.getOffset();
 162   }
 163 }
 164
 165 /// print - Print the specified machine operand.
 166 ///
 167 void MachineOperand::print(std::ostream &OS, const TargetMachine *TM) const {
 168   raw_os_ostream RawOS(OS);
 169   print(RawOS, TM);
 170 }
 171
 172 void MachineOperand::print(raw_ostream &OS, const TargetMachine *TM) const {
 173   switch (getType()) {
 174   case MachineOperand::MO_Register:
 175     if (getReg() == 0 || TargetRegisterInfo::isVirtualRegister(getReg())) {
 176       OS << "%reg" << getReg();
 177     } else {
 178       // If the instruction is embedded into a basic block, we can find the
 179       // target info for the instruction.
 180       if (TM == 0)
 181         if (const MachineInstr *MI = getParent())
 182           if (const MachineBasicBlock *MBB = MI->getParent())
 183             if (const MachineFunction *MF = MBB->getParent())
 184               TM = &MF->getTarget();
 185
 186       if (TM)
 187         OS << "%" << TM->getRegisterInfo()->get(getReg()).Name;
 188       else
 189         OS << "%mreg" << getReg();
 190     }
 191
 192     if (getSubReg() != 0) {
 193       OS << ":" << getSubReg();
 194     }
 195
 196     if (isDef() || isKill() || isDead() || isImplicit() || isEarlyClobber()) {
 197       OS << "<";
 198       bool NeedComma = false;
 199       if (isImplicit()) {
 200         if (NeedComma) OS << ",";
 201         OS << (isDef() ? "imp-def" : "imp-use");
 202         NeedComma = true;
 203       } else if (isDef()) {
 204         if (NeedComma) OS << ",";
 205         if (isEarlyClobber())
 206           OS << "earlyclobber,";
 207         OS << "def";
 208         NeedComma = true;
 209       }
 210       if (isKill() || isDead()) {
 211         if (NeedComma) OS << ",";
 212         if (isKill())  OS << "kill";
 213         if (isDead())  OS << "dead";
 214       }
 215       OS << ">";
 216     }
 217     break;
 218   case MachineOperand::MO_Immediate:
 219     OS << getImm();
 220     break;
 221   case MachineOperand::MO_FPImmediate:
 222     if (getFPImm()->getType() == Type::FloatTy) {
 223       OS << getFPImm()->getValueAPF().convertToFloat();
 224     } else {
 225       OS << getFPImm()->getValueAPF().convertToDouble();
 226     }
 227     break;
 228   case MachineOperand::MO_MachineBasicBlock:
 229     OS << "mbb<"
 230        << ((Value*)getMBB()->getBasicBlock())->getName()
 231        << "," << (void*)getMBB() << ">";
 232     break;
 233   case MachineOperand::MO_FrameIndex:
 234     OS << "<fi#" << getIndex() << ">";
 235     break;
 236   case MachineOperand::MO_ConstantPoolIndex:
 237     OS << "<cp#" << getIndex();
 238     if (getOffset()) OS << "+" << getOffset();
 239     OS << ">";
 240     break;
 241   case MachineOperand::MO_JumpTableIndex:
 242     OS << "<jt#" << getIndex() << ">";
 243     break;
 244   case MachineOperand::MO_GlobalAddress:
 245     OS << "<ga:" << ((Value*)getGlobal())->getName();
 246     if (getOffset()) OS << "+" << getOffset();
 247     OS << ">";
 248     break;
 249   case MachineOperand::MO_ExternalSymbol:
 250     OS << "<es:" << getSymbolName();
 251     if (getOffset()) OS << "+" << getOffset();
 252     OS << ">";
 253     break;
 254   default:
 255     assert(0 && "Unrecognized operand type");
 256   }
 257 }
 258
 259 //===----------------------------------------------------------------------===//
 260 // MachineMemOperand Implementation
 261 //===----------------------------------------------------------------------===//
 262
 263 MachineMemOperand::MachineMemOperand(const Value *v, unsigned int f,
 264                                      int64_t o, uint64_t s, unsigned int a)
 265   : Offset(o), Size(s), V(v),
 266     Flags((f & 7) | ((Log2_32(a) + 1) << 3)) {
 267   assert(isPowerOf2_32(a) && "Alignment is not a power of 2!");
 268   assert((isLoad() || isStore()) && "Not a load/store!");
 269 }
 270
 271 /// Profile - Gather unique data for the object.
 272 ///
 273 void MachineMemOperand::Profile(FoldingSetNodeID &ID) const {
 274   ID.AddInteger(Offset);
 275   ID.AddInteger(Size);
 276   ID.AddPointer(V);
 277   ID.AddInteger(Flags);
 278 }
 279
 280 //===----------------------------------------------------------------------===//
 281 // MachineInstr Implementation
 282 //===----------------------------------------------------------------------===//
 283
 284 /// MachineInstr ctor - This constructor creates a dummy MachineInstr with
 285 /// TID NULL and no operands.
 286 MachineInstr::MachineInstr()
 287   : TID(0), NumImplicitOps(0), Parent(0), debugLoc(DebugLoc::getUnknownLoc()) {
 288   // Make sure that we get added to a machine basicblock
 289   LeakDetector::addGarbageObject(this);
 290 }
 291
 292 void MachineInstr::addImplicitDefUseOperands() {
 293   if (TID->ImplicitDefs)
 294     for (const unsigned *ImpDefs = TID->ImplicitDefs; *ImpDefs; ++ImpDefs)
 295       addOperand(MachineOperand::CreateReg(*ImpDefs, true, true));
 296   if (TID->ImplicitUses)
 297     for (const unsigned *ImpUses = TID->ImplicitUses; *ImpUses; ++ImpUses)
 298       addOperand(MachineOperand::CreateReg(*ImpUses, false, true));
 299 }
 300
 301 /// MachineInstr ctor - This constructor create a MachineInstr and add the
 302 /// implicit operands. It reserves space for number of operands specified by
 303 /// TargetInstrDesc or the numOperands if it is not zero. (for
 304 /// instructions with variable number of operands).
 305 MachineInstr::MachineInstr(const TargetInstrDesc &tid, bool NoImp)
 306   : TID(&tid), NumImplicitOps(0), Parent(0),
 307     debugLoc(DebugLoc::getUnknownLoc()) {
 308   if (!NoImp && TID->getImplicitDefs())
 309     for (const unsigned *ImpDefs = TID->getImplicitDefs(); *ImpDefs; ++ImpDefs)
 310       NumImplicitOps++;
 311   if (!NoImp && TID->getImplicitUses())
 312     for (const unsigned *ImpUses = TID->getImplicitUses(); *ImpUses; ++ImpUses)
 313       NumImplicitOps++;
 314   Operands.reserve(NumImplicitOps + TID->getNumOperands());
 315   if (!NoImp)
 316     addImplicitDefUseOperands();
 317   // Make sure that we get added to a machine basicblock
 318   LeakDetector::addGarbageObject(this);
 319 }
 320
 321 /// MachineInstr ctor - As above, but with a DebugLoc.
 322 MachineInstr::MachineInstr(const TargetInstrDesc &tid, const DebugLoc dl,
 323                            bool NoImp)
 324   : TID(&tid), NumImplicitOps(0), Parent(0), debugLoc(dl) {
 325   if (!NoImp && TID->getImplicitDefs())
 326     for (const unsigned *ImpDefs = TID->getImplicitDefs(); *ImpDefs; ++ImpDefs)
 327       NumImplicitOps++;
 328   if (!NoImp && TID->getImplicitUses())
 329     for (const unsigned *ImpUses = TID->getImplicitUses(); *ImpUses; ++ImpUses)
 330       NumImplicitOps++;
 331   Operands.reserve(NumImplicitOps + TID->getNumOperands());
 332   if (!NoImp)
 333     addImplicitDefUseOperands();
 334   // Make sure that we get added to a machine basicblock
 335   LeakDetector::addGarbageObject(this);
 336 }
 337
 338 /// MachineInstr ctor - Work exactly the same as the ctor two above, except
 339 /// that the MachineInstr is created and added to the end of the specified
 340 /// basic block.
 341 ///
 342 MachineInstr::MachineInstr(MachineBasicBlock *MBB, const TargetInstrDesc &tid)
 343   : TID(&tid), NumImplicitOps(0), Parent(0),
 344     debugLoc(DebugLoc::getUnknownLoc()) {
 345   assert(MBB && "Cannot use inserting ctor with null basic block!");
 346   if (TID->ImplicitDefs)
 347     for (const unsigned *ImpDefs = TID->getImplicitDefs(); *ImpDefs; ++ImpDefs)
 348       NumImplicitOps++;
 349   if (TID->ImplicitUses)
 350     for (const unsigned *ImpUses = TID->getImplicitUses(); *ImpUses; ++ImpUses)
 351       NumImplicitOps++;
 352   Operands.reserve(NumImplicitOps + TID->getNumOperands());
 353   addImplicitDefUseOperands();
 354   // Make sure that we get added to a machine basicblock
 355   LeakDetector::addGarbageObject(this);
 356   MBB->push_back(this);  // Add instruction to end of basic block!
 357 }
 358
 359 /// MachineInstr ctor - As above, but with a DebugLoc.
 360 ///
 361 MachineInstr::MachineInstr(MachineBasicBlock *MBB, const DebugLoc dl,
 362                            const TargetInstrDesc &tid)
 363   : TID(&tid), NumImplicitOps(0), Parent(0), debugLoc(dl) {
 364   assert(MBB && "Cannot use inserting ctor with null basic block!");
 365   if (TID->ImplicitDefs)
 366     for (const unsigned *ImpDefs = TID->getImplicitDefs(); *ImpDefs; ++ImpDefs)
 367       NumImplicitOps++;
 368   if (TID->ImplicitUses)
 369     for (const unsigned *ImpUses = TID->getImplicitUses(); *ImpUses; ++ImpUses)
 370       NumImplicitOps++;
 371   Operands.reserve(NumImplicitOps + TID->getNumOperands());
 372   addImplicitDefUseOperands();
 373   // Make sure that we get added to a machine basicblock
 374   LeakDetector::addGarbageObject(this);
 375   MBB->push_back(this);  // Add instruction to end of basic block!
 376 }
 377
 378 /// MachineInstr ctor - Copies MachineInstr arg exactly
 379 ///
 380 MachineInstr::MachineInstr(MachineFunction &MF, const MachineInstr &MI)
 381   : TID(&MI.getDesc()), NumImplicitOps(0), Parent(0),
 382         debugLoc(MI.getDebugLoc()) {
 383   Operands.reserve(MI.getNumOperands());
 384
 385   // Add operands
 386   for (unsigned i = 0; i != MI.getNumOperands(); ++i)
 387     addOperand(MI.getOperand(i));
 388   NumImplicitOps = MI.NumImplicitOps;
 389
 390   // Add memory operands.
 391   for (std::list<MachineMemOperand>::const_iterator i = MI.memoperands_begin(),
 392        j = MI.memoperands_end(); i != j; ++i)
 393     addMemOperand(MF, *i);
 394
 395   // Set parent to null.
 396   Parent = 0;
 397
 398   LeakDetector::addGarbageObject(this);
 399 }
 400
 401 MachineInstr::~MachineInstr() {
 402   LeakDetector::removeGarbageObject(this);
 403   assert(MemOperands.empty() &&
 404          "MachineInstr being deleted with live memoperands!");
 405 #ifndef NDEBUG
 406   for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
 407     assert(Operands[i].ParentMI == this && "ParentMI mismatch!");
 408     assert((!Operands[i].isReg() || !Operands[i].isOnRegUseList()) &&
 409            "Reg operand def/use list corrupted");
 410   }
 411 #endif
 412 }
 413
 414 /// getRegInfo - If this instruction is embedded into a MachineFunction,
 415 /// return the MachineRegisterInfo object for the current function, otherwise
 416 /// return null.
 417 MachineRegisterInfo *MachineInstr::getRegInfo() {
 418   if (MachineBasicBlock *MBB = getParent())
 419     return &MBB->getParent()->getRegInfo();
 420   return 0;
 421 }
 422
 423 /// RemoveRegOperandsFromUseLists - Unlink all of the register operands in
 424 /// this instruction from their respective use lists.  This requires that the
 425 /// operands already be on their use lists.
 426 void MachineInstr::RemoveRegOperandsFromUseLists() {
 427   for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
 428     if (Operands[i].isReg())
 429       Operands[i].RemoveRegOperandFromRegInfo();
 430   }
 431 }
 432
 433 /// AddRegOperandsToUseLists - Add all of the register operands in
 434 /// this instruction from their respective use lists.  This requires that the
 435 /// operands not be on their use lists yet.
 436 void MachineInstr::AddRegOperandsToUseLists(MachineRegisterInfo &RegInfo) {
 437   for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
 438     if (Operands[i].isReg())
 439       Operands[i].AddRegOperandToRegInfo(&RegInfo);
 440   }
 441 }
 442
 443
 444 /// addOperand - Add the specified operand to the instruction.  If it is an
 445 /// implicit operand, it is added to the end of the operand list.  If it is
 446 /// an explicit operand it is added at the end of the explicit operand list
 447 /// (before the first implicit operand).
 448 void MachineInstr::addOperand(const MachineOperand &Op) {
 449   bool isImpReg = Op.isReg() && Op.isImplicit();
 450   assert((isImpReg || !OperandsComplete()) &&
 451          "Trying to add an operand to a machine instr that is already done!");
 452
 453   MachineRegisterInfo *RegInfo = getRegInfo();
 454
 455   // If we are adding the operand to the end of the list, our job is simpler.
 456   // This is true most of the time, so this is a reasonable optimization.
 457   if (isImpReg || NumImplicitOps == 0) {
 458     // We can only do this optimization if we know that the operand list won't
 459     // reallocate.
 460     if (Operands.empty() || Operands.size()+1 <= Operands.capacity()) {
 461       Operands.push_back(Op);
 462
 463       // Set the parent of the operand.
 464       Operands.back().ParentMI = this;
 465
 466       // If the operand is a register, update the operand's use list.
 467       if (Op.isReg())
 468         Operands.back().AddRegOperandToRegInfo(RegInfo);
 469       return;
 470     }
 471   }
 472
 473   // Otherwise, we have to insert a real operand before any implicit ones.
 474   unsigned OpNo = Operands.size()-NumImplicitOps;
 475
 476   // If this instruction isn't embedded into a function, then we don't need to
 477   // update any operand lists.
 478   if (RegInfo == 0) {
 479     // Simple insertion, no reginfo update needed for other register operands.
 480     Operands.insert(Operands.begin()+OpNo, Op);
 481     Operands[OpNo].ParentMI = this;
 482
 483     // Do explicitly set the reginfo for this operand though, to ensure the
 484     // next/prev fields are properly nulled out.
 485     if (Operands[OpNo].isReg())
 486       Operands[OpNo].AddRegOperandToRegInfo(0);
 487
 488   } else if (Operands.size()+1 <= Operands.capacity()) {
 489     // Otherwise, we have to remove register operands from their register use
 490     // list, add the operand, then add the register operands back to their use
 491     // list.  This also must handle the case when the operand list reallocates
 492     // to somewhere else.
 493
 494     // If insertion of this operand won't cause reallocation of the operand
 495     // list, just remove the implicit operands, add the operand, then re-add all
 496     // the rest of the operands.
 497     for (unsigned i = OpNo, e = Operands.size(); i != e; ++i) {
 498       assert(Operands[i].isReg() && "Should only be an implicit reg!");
 499       Operands[i].RemoveRegOperandFromRegInfo();
 500     }
 501
 502     // Add the operand.  If it is a register, add it to the reg list.
 503     Operands.insert(Operands.begin()+OpNo, Op);
 504     Operands[OpNo].ParentMI = this;
 505
 506     if (Operands[OpNo].isReg())
 507       Operands[OpNo].AddRegOperandToRegInfo(RegInfo);
 508
 509     // Re-add all the implicit ops.
 510     for (unsigned i = OpNo+1, e = Operands.size(); i != e; ++i) {
 511       assert(Operands[i].isReg() && "Should only be an implicit reg!");
 512       Operands[i].AddRegOperandToRegInfo(RegInfo);
 513     }
 514   } else {
 515     // Otherwise, we will be reallocating the operand list.  Remove all reg
 516     // operands from their list, then readd them after the operand list is
 517     // reallocated.
 518     RemoveRegOperandsFromUseLists();
 519
 520     Operands.insert(Operands.begin()+OpNo, Op);
 521     Operands[OpNo].ParentMI = this;
 522
 523     // Re-add all the operands.
 524     AddRegOperandsToUseLists(*RegInfo);
 525   }
 526 }
 527
 528 /// RemoveOperand - Erase an operand  from an instruction, leaving it with one
 529 /// fewer operand than it started with.
 530 ///
 531 void MachineInstr::RemoveOperand(unsigned OpNo) {
 532   assert(OpNo < Operands.size() && "Invalid operand number");
 533
 534   // Special case removing the last one.
 535   if (OpNo == Operands.size()-1) {
 536     // If needed, remove from the reg def/use list.
 537     if (Operands.back().isReg() && Operands.back().isOnRegUseList())
 538       Operands.back().RemoveRegOperandFromRegInfo();
 539
 540     Operands.pop_back();
 541     return;
 542   }
 543
 544   // Otherwise, we are removing an interior operand.  If we have reginfo to
 545   // update, remove all operands that will be shifted down from their reg lists,
 546   // move everything down, then re-add them.
 547   MachineRegisterInfo *RegInfo = getRegInfo();
 548   if (RegInfo) {
 549     for (unsigned i = OpNo, e = Operands.size(); i != e; ++i) {
 550       if (Operands[i].isReg())
 551         Operands[i].RemoveRegOperandFromRegInfo();
 552     }
 553   }
 554
 555   Operands.erase(Operands.begin()+OpNo);
 556
 557   if (RegInfo) {
 558     for (unsigned i = OpNo, e = Operands.size(); i != e; ++i) {
 559       if (Operands[i].isReg())
 560         Operands[i].AddRegOperandToRegInfo(RegInfo);
 561     }
 562   }
 563 }
 564
 565 /// addMemOperand - Add a MachineMemOperand to the machine instruction,
 566 /// referencing arbitrary storage.
 567 void MachineInstr::addMemOperand(MachineFunction &MF,
 568                                  const MachineMemOperand &MO) {
 569   MemOperands.push_back(MO);
 570 }
 571
 572 /// clearMemOperands - Erase all of this MachineInstr's MachineMemOperands.
 573 void MachineInstr::clearMemOperands(MachineFunction &MF) {
 574   MemOperands.clear();
 575 }
 576
 577
 578 /// removeFromParent - This method unlinks 'this' from the containing basic
 579 /// block, and returns it, but does not delete it.
 580 MachineInstr *MachineInstr::removeFromParent() {
 581   assert(getParent() && "Not embedded in a basic block!");
 582   getParent()->remove(this);
 583   return this;
 584 }
 585
 586
 587 /// eraseFromParent - This method unlinks 'this' from the containing basic
 588 /// block, and deletes it.
 589 void MachineInstr::eraseFromParent() {
 590   assert(getParent() && "Not embedded in a basic block!");
 591   getParent()->erase(this);
 592 }
 593
 594
 595 /// OperandComplete - Return true if it's illegal to add a new operand
 596 ///
 597 bool MachineInstr::OperandsComplete() const {
 598   unsigned short NumOperands = TID->getNumOperands();
 599   if (!TID->isVariadic() && getNumOperands()-NumImplicitOps >= NumOperands)
 600     return true;  // Broken: we have all the operands of this instruction!
 601   return false;
 602 }
 603
 604 /// getNumExplicitOperands - Returns the number of non-implicit operands.
 605 ///
 606 unsigned MachineInstr::getNumExplicitOperands() const {
 607   unsigned NumOperands = TID->getNumOperands();
 608   if (!TID->isVariadic())
 609     return NumOperands;
 610
 611   for (unsigned e = getNumOperands(); NumOperands != e; ++NumOperands) {
 612     const MachineOperand &MO = getOperand(NumOperands);
 613     if (!MO.isReg() || !MO.isImplicit())
 614       NumOperands++;
 615   }
 616   return NumOperands;
 617 }
 618
 619
 620 /// isLabel - Returns true if the MachineInstr represents a label.
 621 ///
 622 bool MachineInstr::isLabel() const {
 623   return getOpcode() == TargetInstrInfo::DBG_LABEL ||
 624          getOpcode() == TargetInstrInfo::EH_LABEL ||
 625          getOpcode() == TargetInstrInfo::GC_LABEL;
 626 }
 627
 628 /// isDebugLabel - Returns true if the MachineInstr represents a debug label.
 629 ///
 630 bool MachineInstr::isDebugLabel() const {
 631   return getOpcode() == TargetInstrInfo::DBG_LABEL;
 632 }
 633
 634 /// findRegisterUseOperandIdx() - Returns the MachineOperand that is a use of
 635 /// the specific register or -1 if it is not found. It further tightening
 636 /// the search criteria to a use that kills the register if isKill is true.
 637 int MachineInstr::findRegisterUseOperandIdx(unsigned Reg, bool isKill,
 638                                           const TargetRegisterInfo *TRI) const {
 639   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 640     const MachineOperand &MO = getOperand(i);
 641     if (!MO.isReg() || !MO.isUse())
 642       continue;
 643     unsigned MOReg = MO.getReg();
 644     if (!MOReg)
 645       continue;
 646     if (MOReg == Reg ||
 647         (TRI &&
 648          TargetRegisterInfo::isPhysicalRegister(MOReg) &&
 649          TargetRegisterInfo::isPhysicalRegister(Reg) &&
 650          TRI->isSubRegister(MOReg, Reg)))
 651       if (!isKill || MO.isKill())
 652         return i;
 653   }
 654   return -1;
 655 }
 656
 657 /// findRegisterDefOperandIdx() - Returns the operand index that is a def of
 658 /// the specified register or -1 if it is not found. If isDead is true, defs
 659 /// that are not dead are skipped. If TargetRegisterInfo is non-null, then it
 660 /// also checks if there is a def of a super-register.
 661 int MachineInstr::findRegisterDefOperandIdx(unsigned Reg, bool isDead,
 662                                           const TargetRegisterInfo *TRI) const {
 663   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 664     const MachineOperand &MO = getOperand(i);
 665     if (!MO.isReg() || !MO.isDef())
 666       continue;
 667     unsigned MOReg = MO.getReg();
 668     if (MOReg == Reg ||
 669         (TRI &&
 670          TargetRegisterInfo::isPhysicalRegister(MOReg) &&
 671          TargetRegisterInfo::isPhysicalRegister(Reg) &&
 672          TRI->isSubRegister(MOReg, Reg)))
 673       if (!isDead || MO.isDead())
 674         return i;
 675   }
 676   return -1;
 677 }
 678
 679 /// findFirstPredOperandIdx() - Find the index of the first operand in the
 680 /// operand list that is used to represent the predicate. It returns -1 if
 681 /// none is found.
 682 int MachineInstr::findFirstPredOperandIdx() const {
 683   const TargetInstrDesc &TID = getDesc();
 684   if (TID.isPredicable()) {
 685     for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 686       if (TID.OpInfo[i].isPredicate())
 687         return i;
 688   }
 689
 690   return -1;
 691 }
 692
 693 /// isRegReDefinedByTwoAddr - Given the index of a register operand,
 694 /// check if the register def is a re-definition due to two addr elimination.
 695 bool MachineInstr::isRegReDefinedByTwoAddr(unsigned DefIdx) const{
 696   if (getOpcode() == TargetInstrInfo::INLINEASM) {
 697     assert(DefIdx >= 2);
 698     const MachineOperand &MO = getOperand(DefIdx);
 699     if (!MO.isReg() || !MO.isDef())
 700       return false;
 701     // Determine the actual operand no corresponding to this index.
 702     unsigned DefNo = 0;
 703     for (unsigned i = 1, e = getNumOperands(); i < e; ) {
 704       const MachineOperand &FMO = getOperand(i);
 705       assert(FMO.isImm());
 706       // Skip over this def.
 707       i += InlineAsm::getNumOperandRegisters(FMO.getImm()) + 1;
 708       if (i > DefIdx)
 709         break;
 710       ++DefNo;
 711     }
 712     for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 713       const MachineOperand &FMO = getOperand(i);
 714       if (!FMO.isImm())
 715         continue;
 716       if (i+1 >= e || !getOperand(i+1).isReg() || !getOperand(i+1).isUse())
 717         continue;
 718       unsigned Idx;
 719       if (InlineAsm::isUseOperandTiedToDef(FMO.getImm(), Idx) &&
 720           Idx == DefNo)
 721         return true;
 722     }
 723   }
 724
 725   assert(getOperand(DefIdx).isDef() && "DefIdx is not a def!");
 726   const TargetInstrDesc &TID = getDesc();
 727   for (unsigned i = 0, e = TID.getNumOperands(); i != e; ++i) {
 728     const MachineOperand &MO = getOperand(i);
 729     if (MO.isReg() && MO.isUse() &&
 730         TID.getOperandConstraint(i, TOI::TIED_TO) == (int)DefIdx)
 731       return true;
 732   }
 733   return false;
 734 }
 735
 736 /// isRegTiedToDefOperand - Return true if the operand of the specified index
 737 /// is a register use and it is tied to an def operand. It also returns the def
 738 /// operand index by reference.
 739 bool MachineInstr::isRegTiedToDefOperand(unsigned UseOpIdx, unsigned *DefOpIdx){
 740   if (getOpcode() == TargetInstrInfo::INLINEASM) {
 741     const MachineOperand &MO = getOperand(UseOpIdx);
 742     if (!MO.isReg() || !MO.isUse())
 743       return false;
 744     assert(UseOpIdx > 0);
 745     const MachineOperand &UFMO = getOperand(UseOpIdx-1);
 746     if (!UFMO.isImm())
 747       return false;  // Must be physreg uses.
 748     unsigned DefNo;
 749     if (InlineAsm::isUseOperandTiedToDef(UFMO.getImm(), DefNo)) {
 750       if (!DefOpIdx)
 751         return true;
 752
 753       unsigned DefIdx = 1;
 754       // Remember to adjust the index. First operand is asm string, then there
 755       // is a flag for each.
 756       while (DefNo) {
 757         const MachineOperand &FMO = getOperand(DefIdx);
 758         assert(FMO.isImm());
 759         // Skip over this def.
 760         DefIdx += InlineAsm::getNumOperandRegisters(FMO.getImm()) + 1;
 761         --DefNo;
 762       }
 763       *DefOpIdx = DefIdx+1;
 764       return true;
 765     }
 766     return false;
 767   }
 768
 769   const TargetInstrDesc &TID = getDesc();
 770   if (UseOpIdx >= TID.getNumOperands())
 771     return false;
 772   const MachineOperand &MO = getOperand(UseOpIdx);
 773   if (!MO.isReg() || !MO.isUse())
 774     return false;
 775   int DefIdx = TID.getOperandConstraint(UseOpIdx, TOI::TIED_TO);
 776   if (DefIdx == -1)
 777     return false;
 778   if (DefOpIdx)
 779     *DefOpIdx = (unsigned)DefIdx;
 780   return true;
 781 }
 782
 783 /// copyKillDeadInfo - Copies kill / dead operand properties from MI.
 784 ///
 785 void MachineInstr::copyKillDeadInfo(const MachineInstr *MI) {
 786   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 787     const MachineOperand &MO = MI->getOperand(i);
 788     if (!MO.isReg() || (!MO.isKill() && !MO.isDead()))
 789       continue;
 790     for (unsigned j = 0, ee = getNumOperands(); j != ee; ++j) {
 791       MachineOperand &MOp = getOperand(j);
 792       if (!MOp.isIdenticalTo(MO))
 793         continue;
 794       if (MO.isKill())
 795         MOp.setIsKill();
 796       else
 797         MOp.setIsDead();
 798       break;
 799     }
 800   }
 801 }
 802
 803 /// copyPredicates - Copies predicate operand(s) from MI.
 804 void MachineInstr::copyPredicates(const MachineInstr *MI) {
 805   const TargetInstrDesc &TID = MI->getDesc();
 806   if (!TID.isPredicable())
 807     return;
 808   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 809     if (TID.OpInfo[i].isPredicate()) {
 810       // Predicated operands must be last operands.
 811       addOperand(MI->getOperand(i));
 812     }
 813   }
 814 }
 815
 816 /// isSafeToMove - Return true if it is safe to move this instruction. If
 817 /// SawStore is set to true, it means that there is a store (or call) between
 818 /// the instruction's location and its intended destination.
 819 bool MachineInstr::isSafeToMove(const TargetInstrInfo *TII,
 820                                 bool &SawStore) const {
 821   // Ignore stuff that we obviously can't move.
 822   if (TID->mayStore() || TID->isCall()) {
 823     SawStore = true;
 824     return false;
 825   }
 826   if (TID->isTerminator() || TID->hasUnmodeledSideEffects())
 827     return false;
 828
 829   // See if this instruction does a load.  If so, we have to guarantee that the
 830   // loaded value doesn't change between the load and the its intended
 831   // destination. The check for isInvariantLoad gives the targe the chance to
 832   // classify the load as always returning a constant, e.g. a constant pool
 833   // load.
 834   if (TID->mayLoad() && !TII->isInvariantLoad(this))
 835     // Otherwise, this is a real load.  If there is a store between the load and
 836     // end of block, or if the laod is volatile, we can't move it.
 837     return !SawStore && !hasVolatileMemoryRef();
 838
 839   return true;
 840 }
 841
 842 /// isSafeToReMat - Return true if it's safe to rematerialize the specified
 843 /// instruction which defined the specified register instead of copying it.
 844 bool MachineInstr::isSafeToReMat(const TargetInstrInfo *TII,
 845                                  unsigned DstReg) const {
 846   bool SawStore = false;
 847   if (!getDesc().isRematerializable() ||
 848       !TII->isTriviallyReMaterializable(this) ||
 849       !isSafeToMove(TII, SawStore))
 850     return false;
 851   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 852     const MachineOperand &MO = getOperand(i);
 853     if (!MO.isReg())
 854       continue;
 855     // FIXME: For now, do not remat any instruction with register operands.
 856     // Later on, we can loosen the restriction is the register operands have
 857     // not been modified between the def and use. Note, this is different from
 858     // MachineSink because the code is no longer in two-address form (at least
 859     // partially).
 860     if (MO.isUse())
 861       return false;
 862     else if (!MO.isDead() && MO.getReg() != DstReg)
 863       return false;
 864   }
 865   return true;
 866 }
 867
 868 /// hasVolatileMemoryRef - Return true if this instruction may have a
 869 /// volatile memory reference, or if the information describing the
 870 /// memory reference is not available. Return false if it is known to
 871 /// have no volatile memory references.
 872 bool MachineInstr::hasVolatileMemoryRef() const {
 873   // An instruction known never to access memory won't have a volatile access.
 874   if (!TID->mayStore() &&
 875       !TID->mayLoad() &&
 876       !TID->isCall() &&
 877       !TID->hasUnmodeledSideEffects())
 878     return false;
 879
 880   // Otherwise, if the instruction has no memory reference information,
 881   // conservatively assume it wasn't preserved.
 882   if (memoperands_empty())
 883     return true;
 884
 885   // Check the memory reference information for volatile references.
 886   for (std::list<MachineMemOperand>::const_iterator I = memoperands_begin(),
 887        E = memoperands_end(); I != E; ++I)
 888     if (I->isVolatile())
 889       return true;
 890
 891   return false;
 892 }
 893
 894 void MachineInstr::dump() const {
 895   cerr << "  " << *this;
 896 }
 897
 898 void MachineInstr::print(std::ostream &OS, const TargetMachine *TM) const {
 899   raw_os_ostream RawOS(OS);
 900   print(RawOS, TM);
 901 }
 902
 903 void MachineInstr::print(raw_ostream &OS, const TargetMachine *TM) const {
 904   // Specialize printing if op#0 is definition
 905   unsigned StartOp = 0;
 906   if (getNumOperands() && getOperand(0).isReg() && getOperand(0).isDef()) {
 907     getOperand(0).print(OS, TM);
 908     OS << " = ";
 909     ++StartOp;   // Don't print this operand again!
 910   }
 911
 912   OS << getDesc().getName();
 913
 914   for (unsigned i = StartOp, e = getNumOperands(); i != e; ++i) {
 915     if (i != StartOp)
 916       OS << ",";
 917     OS << " ";
 918     getOperand(i).print(OS, TM);
 919   }
 920
 921   if (!memoperands_empty()) {
 922     OS << ", Mem:";
 923     for (std::list<MachineMemOperand>::const_iterator i = memoperands_begin(),
 924          e = memoperands_end(); i != e; ++i) {
 925       const MachineMemOperand &MRO = *i;
 926       const Value *V = MRO.getValue();
 927
 928       assert((MRO.isLoad() || MRO.isStore()) &&
 929              "SV has to be a load, store or both.");
 930
 931       if (MRO.isVolatile())
 932         OS << "Volatile ";
 933
 934       if (MRO.isLoad())
 935         OS << "LD";
 936       if (MRO.isStore())
 937         OS << "ST";
 938
 939       OS << "(" << MRO.getSize() << "," << MRO.getAlignment() << ") [";
 940
 941       if (!V)
 942         OS << "<unknown>";
 943       else if (!V->getName().empty())
 944         OS << V->getName();
 945       else if (const PseudoSourceValue *PSV = dyn_cast<PseudoSourceValue>(V)) {
 946         PSV->print(OS);
 947       } else
 948         OS << V;
 949
 950       OS << " + " << MRO.getOffset() << "]";
 951     }
 952   }
 953
 954   if (!debugLoc.isUnknown()) {
 955     const MachineFunction *MF = getParent()->getParent();
 956     DebugLocTuple DLT = MF->getDebugLocTuple(debugLoc);
 957     OS << " [dbg: "
 958        << DLT.Src  << ","
 959        << DLT.Line << ","
 960        << DLT.Col  << "]";
 961   }
 962
 963   OS << "\n";
 964 }
 965
 966 bool MachineInstr::addRegisterKilled(unsigned IncomingReg,
 967                                      const TargetRegisterInfo *RegInfo,
 968                                      bool AddIfNotFound) {
 969   bool isPhysReg = TargetRegisterInfo::isPhysicalRegister(IncomingReg);
 970   bool hasAliases = isPhysReg && RegInfo->getAliasSet(IncomingReg);
 971   bool Found = false;
 972   SmallVector<unsigned,4> DeadOps;
 973   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 974     MachineOperand &MO = getOperand(i);
 975     if (!MO.isReg() || !MO.isUse())
 976       continue;
 977     unsigned Reg = MO.getReg();
 978     if (!Reg)
 979       continue;
 980
 981     if (Reg == IncomingReg) {
 982       if (!Found) {
 983         if (MO.isKill())
 984           // The register is already marked kill.
 985           return true;
 986         MO.setIsKill();
 987         Found = true;
 988       }
 989     } else if (hasAliases && MO.isKill() &&
 990                TargetRegisterInfo::isPhysicalRegister(Reg)) {
 991       // A super-register kill already exists.
 992       if (RegInfo->isSuperRegister(IncomingReg, Reg))
 993         return true;
 994       if (RegInfo->isSubRegister(IncomingReg, Reg))
 995         DeadOps.push_back(i);
 996     }
 997   }
 998
 999   // Trim unneeded kill operands.
1000   while (!DeadOps.empty()) {
1001     unsigned OpIdx = DeadOps.back();
1002     if (getOperand(OpIdx).isImplicit())
1003       RemoveOperand(OpIdx);
1004     else
1005       getOperand(OpIdx).setIsKill(false);
1006     DeadOps.pop_back();
1007   }
1008
1009   // If not found, this means an alias of one of the operands is killed. Add a
1010   // new implicit operand if required.
1011   if (!Found && AddIfNotFound) {
1012     addOperand(MachineOperand::CreateReg(IncomingReg,
1013                                          false /*IsDef*/,
1014                                          true  /*IsImp*/,
1015                                          true  /*IsKill*/));
1016     return true;
1017   }
1018   return Found;
1019 }
1020
1021 bool MachineInstr::addRegisterDead(unsigned IncomingReg,
1022                                    const TargetRegisterInfo *RegInfo,
1023                                    bool AddIfNotFound) {
1024   bool isPhysReg = TargetRegisterInfo::isPhysicalRegister(IncomingReg);
1025   bool hasAliases = isPhysReg && RegInfo->getAliasSet(IncomingReg);
1026   bool Found = false;
1027   SmallVector<unsigned,4> DeadOps;
1028   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1029     MachineOperand &MO = getOperand(i);
1030     if (!MO.isReg() || !MO.isDef())
1031       continue;
1032     unsigned Reg = MO.getReg();
1033     if (!Reg)
1034       continue;
1035
1036     if (Reg == IncomingReg) {
1037       if (!Found) {
1038         if (MO.isDead())
1039           // The register is already marked dead.
1040           return true;
1041         MO.setIsDead();
1042         Found = true;
1043       }
1044     } else if (hasAliases && MO.isDead() &&
1045                TargetRegisterInfo::isPhysicalRegister(Reg)) {
1046       // There exists a super-register that's marked dead.
1047       if (RegInfo->isSuperRegister(IncomingReg, Reg))
1048         return true;
1049       if (RegInfo->getSubRegisters(IncomingReg) &&
1050           RegInfo->getSuperRegisters(Reg) &&
1051           RegInfo->isSubRegister(IncomingReg, Reg))
1052         DeadOps.push_back(i);
1053     }
1054   }
1055
1056   // Trim unneeded dead operands.
1057   while (!DeadOps.empty()) {
1058     unsigned OpIdx = DeadOps.back();
1059     if (getOperand(OpIdx).isImplicit())
1060       RemoveOperand(OpIdx);
1061     else
1062       getOperand(OpIdx).setIsDead(false);
1063     DeadOps.pop_back();
1064   }
1065
1066   // If not found, this means an alias of one of the operands is dead. Add a
1067   // new implicit operand if required.
1068   if (!Found && AddIfNotFound) {
1069     addOperand(MachineOperand::CreateReg(IncomingReg,
1070                                          true  /*IsDef*/,
1071                                          true  /*IsImp*/,
1072                                          false /*IsKill*/,
1073                                          true  /*IsDead*/));
1074     return true;
1075   }
1076   return Found;
1077 }