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