1 //===-- lib/CodeGen/MachineInstr.cpp --------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Methods common to all machine instructions.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/CodeGen/MachineInstr.h"
15 #include "llvm/Constants.h"
16 #include "llvm/Function.h"
17 #include "llvm/InlineAsm.h"
18 #include "llvm/Metadata.h"
19 #include "llvm/Type.h"
20 #include "llvm/Value.h"
21 #include "llvm/Assembly/Writer.h"
22 #include "llvm/CodeGen/MachineConstantPool.h"
23 #include "llvm/CodeGen/MachineFunction.h"
24 #include "llvm/CodeGen/MachineMemOperand.h"
25 #include "llvm/CodeGen/MachineRegisterInfo.h"
26 #include "llvm/CodeGen/PseudoSourceValue.h"
27 #include "llvm/MC/MCSymbol.h"
28 #include "llvm/Target/TargetMachine.h"
29 #include "llvm/Target/TargetInstrInfo.h"
30 #include "llvm/Target/TargetInstrDesc.h"
31 #include "llvm/Target/TargetRegisterInfo.h"
32 #include "llvm/Analysis/AliasAnalysis.h"
33 #include "llvm/Analysis/DebugInfo.h"
34 #include "llvm/Support/Debug.h"
35 #include "llvm/Support/ErrorHandling.h"
36 #include "llvm/Support/LeakDetector.h"
37 #include "llvm/Support/MathExtras.h"
38 #include "llvm/Support/raw_ostream.h"
39 #include "llvm/ADT/FoldingSet.h"
42 //===----------------------------------------------------------------------===//
43 // MachineOperand Implementation
44 //===----------------------------------------------------------------------===//
46 /// AddRegOperandToRegInfo - Add this register operand to the specified
47 /// MachineRegisterInfo. If it is null, then the next/prev fields should be
48 /// explicitly nulled out.
49 void MachineOperand::AddRegOperandToRegInfo(MachineRegisterInfo *RegInfo) {
50 assert(isReg() && "Can only add reg operand to use lists");
52 // If the reginfo pointer is null, just explicitly null out or next/prev
53 // pointers, to ensure they are not garbage.
55 Contents.Reg.Prev = 0;
56 Contents.Reg.Next = 0;
60 // Otherwise, add this operand to the head of the registers use/def list.
61 MachineOperand **Head = &RegInfo->getRegUseDefListHead(getReg());
63 // For SSA values, we prefer to keep the definition at the start of the list.
64 // we do this by skipping over the definition if it is at the head of the
66 if (*Head && (*Head)->isDef())
67 Head = &(*Head)->Contents.Reg.Next;
69 Contents.Reg.Next = *Head;
70 if (Contents.Reg.Next) {
71 assert(getReg() == Contents.Reg.Next->getReg() &&
72 "Different regs on the same list!");
73 Contents.Reg.Next->Contents.Reg.Prev = &Contents.Reg.Next;
76 Contents.Reg.Prev = Head;
80 /// RemoveRegOperandFromRegInfo - Remove this register operand from the
81 /// MachineRegisterInfo it is linked with.
82 void MachineOperand::RemoveRegOperandFromRegInfo() {
83 assert(isOnRegUseList() && "Reg operand is not on a use list");
84 // Unlink this from the doubly linked list of operands.
85 MachineOperand *NextOp = Contents.Reg.Next;
86 *Contents.Reg.Prev = NextOp;
88 assert(NextOp->getReg() == getReg() && "Corrupt reg use/def chain!");
89 NextOp->Contents.Reg.Prev = Contents.Reg.Prev;
91 Contents.Reg.Prev = 0;
92 Contents.Reg.Next = 0;
95 void MachineOperand::setReg(unsigned Reg) {
96 if (getReg() == Reg) return; // No change.
98 // Otherwise, we have to change the register. If this operand is embedded
99 // into a machine function, we need to update the old and new register's
101 if (MachineInstr *MI = getParent())
102 if (MachineBasicBlock *MBB = MI->getParent())
103 if (MachineFunction *MF = MBB->getParent()) {
104 RemoveRegOperandFromRegInfo();
105 Contents.Reg.RegNo = Reg;
106 AddRegOperandToRegInfo(&MF->getRegInfo());
110 // Otherwise, just change the register, no problem. :)
111 Contents.Reg.RegNo = Reg;
114 /// ChangeToImmediate - Replace this operand with a new immediate operand of
115 /// the specified value. If an operand is known to be an immediate already,
116 /// the setImm method should be used.
117 void MachineOperand::ChangeToImmediate(int64_t ImmVal) {
118 // If this operand is currently a register operand, and if this is in a
119 // function, deregister the operand from the register's use/def list.
120 if (isReg() && getParent() && getParent()->getParent() &&
121 getParent()->getParent()->getParent())
122 RemoveRegOperandFromRegInfo();
124 OpKind = MO_Immediate;
125 Contents.ImmVal = ImmVal;
128 /// ChangeToRegister - Replace this operand with a new register operand of
129 /// the specified value. If an operand is known to be an register already,
130 /// the setReg method should be used.
131 void MachineOperand::ChangeToRegister(unsigned Reg, bool isDef, bool isImp,
132 bool isKill, bool isDead, bool isUndef,
134 // If this operand is already a register operand, use setReg to update the
135 // register's use/def lists.
137 assert(!isEarlyClobber());
140 // Otherwise, change this to a register and set the reg#.
141 OpKind = MO_Register;
142 Contents.Reg.RegNo = Reg;
144 // If this operand is embedded in a function, add the operand to the
145 // register's use/def list.
146 if (MachineInstr *MI = getParent())
147 if (MachineBasicBlock *MBB = MI->getParent())
148 if (MachineFunction *MF = MBB->getParent())
149 AddRegOperandToRegInfo(&MF->getRegInfo());
157 IsEarlyClobber = false;
162 /// isIdenticalTo - Return true if this operand is identical to the specified
164 bool MachineOperand::isIdenticalTo(const MachineOperand &Other) const {
165 if (getType() != Other.getType() ||
166 getTargetFlags() != Other.getTargetFlags())
170 default: llvm_unreachable("Unrecognized operand type");
171 case MachineOperand::MO_Register:
172 return getReg() == Other.getReg() && isDef() == Other.isDef() &&
173 getSubReg() == Other.getSubReg();
174 case MachineOperand::MO_Immediate:
175 return getImm() == Other.getImm();
176 case MachineOperand::MO_FPImmediate:
177 return getFPImm() == Other.getFPImm();
178 case MachineOperand::MO_MachineBasicBlock:
179 return getMBB() == Other.getMBB();
180 case MachineOperand::MO_FrameIndex:
181 return getIndex() == Other.getIndex();
182 case MachineOperand::MO_ConstantPoolIndex:
183 return getIndex() == Other.getIndex() && getOffset() == Other.getOffset();
184 case MachineOperand::MO_JumpTableIndex:
185 return getIndex() == Other.getIndex();
186 case MachineOperand::MO_GlobalAddress:
187 return getGlobal() == Other.getGlobal() && getOffset() == Other.getOffset();
188 case MachineOperand::MO_ExternalSymbol:
189 return !strcmp(getSymbolName(), Other.getSymbolName()) &&
190 getOffset() == Other.getOffset();
191 case MachineOperand::MO_BlockAddress:
192 return getBlockAddress() == Other.getBlockAddress();
193 case MachineOperand::MO_MCSymbol:
194 return getMCSymbol() == Other.getMCSymbol();
195 case MachineOperand::MO_Metadata:
196 return getMetadata() == Other.getMetadata();
200 /// print - Print the specified machine operand.
202 void MachineOperand::print(raw_ostream &OS, const TargetMachine *TM) const {
203 // If the instruction is embedded into a basic block, we can find the
204 // target info for the instruction.
206 if (const MachineInstr *MI = getParent())
207 if (const MachineBasicBlock *MBB = MI->getParent())
208 if (const MachineFunction *MF = MBB->getParent())
209 TM = &MF->getTarget();
212 case MachineOperand::MO_Register:
213 if (getReg() == 0 || TargetRegisterInfo::isVirtualRegister(getReg())) {
214 OS << "%reg" << getReg();
217 OS << "%" << TM->getRegisterInfo()->get(getReg()).Name;
219 OS << "%physreg" << getReg();
222 if (getSubReg() != 0)
223 OS << ':' << getSubReg();
225 if (isDef() || isKill() || isDead() || isImplicit() || isUndef() ||
228 bool NeedComma = false;
230 if (NeedComma) OS << ',';
231 if (isEarlyClobber())
232 OS << "earlyclobber,";
237 } else if (isImplicit()) {
242 if (isKill() || isDead() || isUndef()) {
243 if (NeedComma) OS << ',';
244 if (isKill()) OS << "kill";
245 if (isDead()) OS << "dead";
247 if (isKill() || isDead())
255 case MachineOperand::MO_Immediate:
258 case MachineOperand::MO_FPImmediate:
259 if (getFPImm()->getType()->isFloatTy())
260 OS << getFPImm()->getValueAPF().convertToFloat();
262 OS << getFPImm()->getValueAPF().convertToDouble();
264 case MachineOperand::MO_MachineBasicBlock:
265 OS << "<BB#" << getMBB()->getNumber() << ">";
267 case MachineOperand::MO_FrameIndex:
268 OS << "<fi#" << getIndex() << '>';
270 case MachineOperand::MO_ConstantPoolIndex:
271 OS << "<cp#" << getIndex();
272 if (getOffset()) OS << "+" << getOffset();
275 case MachineOperand::MO_JumpTableIndex:
276 OS << "<jt#" << getIndex() << '>';
278 case MachineOperand::MO_GlobalAddress:
280 WriteAsOperand(OS, getGlobal(), /*PrintType=*/false);
281 if (getOffset()) OS << "+" << getOffset();
284 case MachineOperand::MO_ExternalSymbol:
285 OS << "<es:" << getSymbolName();
286 if (getOffset()) OS << "+" << getOffset();
289 case MachineOperand::MO_BlockAddress:
291 WriteAsOperand(OS, getBlockAddress(), /*PrintType=*/false);
294 case MachineOperand::MO_Metadata:
296 WriteAsOperand(OS, getMetadata(), /*PrintType=*/false);
299 case MachineOperand::MO_MCSymbol:
300 OS << "<MCSym=" << *getMCSymbol() << '>';
303 llvm_unreachable("Unrecognized operand type");
306 if (unsigned TF = getTargetFlags())
307 OS << "[TF=" << TF << ']';
310 //===----------------------------------------------------------------------===//
311 // MachineMemOperand Implementation
312 //===----------------------------------------------------------------------===//
314 MachineMemOperand::MachineMemOperand(const Value *v, unsigned int f,
315 int64_t o, uint64_t s, unsigned int a)
316 : Offset(o), Size(s), V(v),
317 Flags((f & ((1 << MOMaxBits) - 1)) | ((Log2_32(a) + 1) << MOMaxBits)) {
318 assert(getBaseAlignment() == a && "Alignment is not a power of 2!");
319 assert((isLoad() || isStore()) && "Not a load/store!");
322 /// Profile - Gather unique data for the object.
324 void MachineMemOperand::Profile(FoldingSetNodeID &ID) const {
325 ID.AddInteger(Offset);
328 ID.AddInteger(Flags);
331 void MachineMemOperand::refineAlignment(const MachineMemOperand *MMO) {
332 // The Value and Offset may differ due to CSE. But the flags and size
333 // should be the same.
334 assert(MMO->getFlags() == getFlags() && "Flags mismatch!");
335 assert(MMO->getSize() == getSize() && "Size mismatch!");
337 if (MMO->getBaseAlignment() >= getBaseAlignment()) {
338 // Update the alignment value.
339 Flags = (Flags & ((1 << MOMaxBits) - 1)) |
340 ((Log2_32(MMO->getBaseAlignment()) + 1) << MOMaxBits);
341 // Also update the base and offset, because the new alignment may
342 // not be applicable with the old ones.
344 Offset = MMO->getOffset();
348 /// getAlignment - Return the minimum known alignment in bytes of the
349 /// actual memory reference.
350 uint64_t MachineMemOperand::getAlignment() const {
351 return MinAlign(getBaseAlignment(), getOffset());
354 raw_ostream &llvm::operator<<(raw_ostream &OS, const MachineMemOperand &MMO) {
355 assert((MMO.isLoad() || MMO.isStore()) &&
356 "SV has to be a load, store or both.");
358 if (MMO.isVolatile())
367 // Print the address information.
372 WriteAsOperand(OS, MMO.getValue(), /*PrintType=*/false);
374 // If the alignment of the memory reference itself differs from the alignment
375 // of the base pointer, print the base alignment explicitly, next to the base
377 if (MMO.getBaseAlignment() != MMO.getAlignment())
378 OS << "(align=" << MMO.getBaseAlignment() << ")";
380 if (MMO.getOffset() != 0)
381 OS << "+" << MMO.getOffset();
384 // Print the alignment of the reference.
385 if (MMO.getBaseAlignment() != MMO.getAlignment() ||
386 MMO.getBaseAlignment() != MMO.getSize())
387 OS << "(align=" << MMO.getAlignment() << ")";
392 //===----------------------------------------------------------------------===//
393 // MachineInstr Implementation
394 //===----------------------------------------------------------------------===//
396 /// MachineInstr ctor - This constructor creates a dummy MachineInstr with
397 /// TID NULL and no operands.
398 MachineInstr::MachineInstr()
399 : TID(0), NumImplicitOps(0), AsmPrinterFlags(0), MemRefs(0), MemRefsEnd(0),
401 // Make sure that we get added to a machine basicblock
402 LeakDetector::addGarbageObject(this);
405 void MachineInstr::addImplicitDefUseOperands() {
406 if (TID->ImplicitDefs)
407 for (const unsigned *ImpDefs = TID->ImplicitDefs; *ImpDefs; ++ImpDefs)
408 addOperand(MachineOperand::CreateReg(*ImpDefs, true, true));
409 if (TID->ImplicitUses)
410 for (const unsigned *ImpUses = TID->ImplicitUses; *ImpUses; ++ImpUses)
411 addOperand(MachineOperand::CreateReg(*ImpUses, false, true));
414 /// MachineInstr ctor - This constructor creates a MachineInstr and adds the
415 /// implicit operands. It reserves space for the number of operands specified by
416 /// the TargetInstrDesc.
417 MachineInstr::MachineInstr(const TargetInstrDesc &tid, bool NoImp)
418 : TID(&tid), NumImplicitOps(0), AsmPrinterFlags(0),
419 MemRefs(0), MemRefsEnd(0), Parent(0) {
421 NumImplicitOps = TID->getNumImplicitDefs() + TID->getNumImplicitUses();
422 Operands.reserve(NumImplicitOps + TID->getNumOperands());
424 addImplicitDefUseOperands();
425 // Make sure that we get added to a machine basicblock
426 LeakDetector::addGarbageObject(this);
429 /// MachineInstr ctor - As above, but with a DebugLoc.
430 MachineInstr::MachineInstr(const TargetInstrDesc &tid, const DebugLoc dl,
432 : TID(&tid), NumImplicitOps(0), AsmPrinterFlags(0), MemRefs(0), MemRefsEnd(0),
433 Parent(0), debugLoc(dl) {
435 NumImplicitOps = TID->getNumImplicitDefs() + TID->getNumImplicitUses();
436 Operands.reserve(NumImplicitOps + TID->getNumOperands());
438 addImplicitDefUseOperands();
439 // Make sure that we get added to a machine basicblock
440 LeakDetector::addGarbageObject(this);
443 /// MachineInstr ctor - Work exactly the same as the ctor two above, except
444 /// that the MachineInstr is created and added to the end of the specified
446 MachineInstr::MachineInstr(MachineBasicBlock *MBB, const TargetInstrDesc &tid)
447 : TID(&tid), NumImplicitOps(0), AsmPrinterFlags(0),
448 MemRefs(0), MemRefsEnd(0), Parent(0) {
449 assert(MBB && "Cannot use inserting ctor with null basic block!");
450 NumImplicitOps = TID->getNumImplicitDefs() + TID->getNumImplicitUses();
451 Operands.reserve(NumImplicitOps + TID->getNumOperands());
452 addImplicitDefUseOperands();
453 // Make sure that we get added to a machine basicblock
454 LeakDetector::addGarbageObject(this);
455 MBB->push_back(this); // Add instruction to end of basic block!
458 /// MachineInstr ctor - As above, but with a DebugLoc.
460 MachineInstr::MachineInstr(MachineBasicBlock *MBB, const DebugLoc dl,
461 const TargetInstrDesc &tid)
462 : TID(&tid), NumImplicitOps(0), AsmPrinterFlags(0), MemRefs(0), MemRefsEnd(0),
463 Parent(0), debugLoc(dl) {
464 assert(MBB && "Cannot use inserting ctor with null basic block!");
465 NumImplicitOps = TID->getNumImplicitDefs() + TID->getNumImplicitUses();
466 Operands.reserve(NumImplicitOps + TID->getNumOperands());
467 addImplicitDefUseOperands();
468 // Make sure that we get added to a machine basicblock
469 LeakDetector::addGarbageObject(this);
470 MBB->push_back(this); // Add instruction to end of basic block!
473 /// MachineInstr ctor - Copies MachineInstr arg exactly
475 MachineInstr::MachineInstr(MachineFunction &MF, const MachineInstr &MI)
476 : TID(&MI.getDesc()), NumImplicitOps(0), AsmPrinterFlags(0),
477 MemRefs(MI.MemRefs), MemRefsEnd(MI.MemRefsEnd),
478 Parent(0), debugLoc(MI.getDebugLoc()) {
479 Operands.reserve(MI.getNumOperands());
482 for (unsigned i = 0; i != MI.getNumOperands(); ++i)
483 addOperand(MI.getOperand(i));
484 NumImplicitOps = MI.NumImplicitOps;
486 // Set parent to null.
489 LeakDetector::addGarbageObject(this);
492 MachineInstr::~MachineInstr() {
493 LeakDetector::removeGarbageObject(this);
495 for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
496 assert(Operands[i].ParentMI == this && "ParentMI mismatch!");
497 assert((!Operands[i].isReg() || !Operands[i].isOnRegUseList()) &&
498 "Reg operand def/use list corrupted");
503 /// getRegInfo - If this instruction is embedded into a MachineFunction,
504 /// return the MachineRegisterInfo object for the current function, otherwise
506 MachineRegisterInfo *MachineInstr::getRegInfo() {
507 if (MachineBasicBlock *MBB = getParent())
508 return &MBB->getParent()->getRegInfo();
512 /// RemoveRegOperandsFromUseLists - Unlink all of the register operands in
513 /// this instruction from their respective use lists. This requires that the
514 /// operands already be on their use lists.
515 void MachineInstr::RemoveRegOperandsFromUseLists() {
516 for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
517 if (Operands[i].isReg())
518 Operands[i].RemoveRegOperandFromRegInfo();
522 /// AddRegOperandsToUseLists - Add all of the register operands in
523 /// this instruction from their respective use lists. This requires that the
524 /// operands not be on their use lists yet.
525 void MachineInstr::AddRegOperandsToUseLists(MachineRegisterInfo &RegInfo) {
526 for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
527 if (Operands[i].isReg())
528 Operands[i].AddRegOperandToRegInfo(&RegInfo);
533 /// addOperand - Add the specified operand to the instruction. If it is an
534 /// implicit operand, it is added to the end of the operand list. If it is
535 /// an explicit operand it is added at the end of the explicit operand list
536 /// (before the first implicit operand).
537 void MachineInstr::addOperand(const MachineOperand &Op) {
538 bool isImpReg = Op.isReg() && Op.isImplicit();
539 assert((isImpReg || !OperandsComplete()) &&
540 "Trying to add an operand to a machine instr that is already done!");
542 MachineRegisterInfo *RegInfo = getRegInfo();
544 // If we are adding the operand to the end of the list, our job is simpler.
545 // This is true most of the time, so this is a reasonable optimization.
546 if (isImpReg || NumImplicitOps == 0) {
547 // We can only do this optimization if we know that the operand list won't
549 if (Operands.empty() || Operands.size()+1 <= Operands.capacity()) {
550 Operands.push_back(Op);
552 // Set the parent of the operand.
553 Operands.back().ParentMI = this;
555 // If the operand is a register, update the operand's use list.
557 Operands.back().AddRegOperandToRegInfo(RegInfo);
558 // If the register operand is flagged as early, mark the operand as such
559 unsigned OpNo = Operands.size() - 1;
560 if (TID->getOperandConstraint(OpNo, TOI::EARLY_CLOBBER) != -1)
561 Operands[OpNo].setIsEarlyClobber(true);
567 // Otherwise, we have to insert a real operand before any implicit ones.
568 unsigned OpNo = Operands.size()-NumImplicitOps;
570 // If this instruction isn't embedded into a function, then we don't need to
571 // update any operand lists.
573 // Simple insertion, no reginfo update needed for other register operands.
574 Operands.insert(Operands.begin()+OpNo, Op);
575 Operands[OpNo].ParentMI = this;
577 // Do explicitly set the reginfo for this operand though, to ensure the
578 // next/prev fields are properly nulled out.
579 if (Operands[OpNo].isReg()) {
580 Operands[OpNo].AddRegOperandToRegInfo(0);
581 // If the register operand is flagged as early, mark the operand as such
582 if (TID->getOperandConstraint(OpNo, TOI::EARLY_CLOBBER) != -1)
583 Operands[OpNo].setIsEarlyClobber(true);
586 } else if (Operands.size()+1 <= Operands.capacity()) {
587 // Otherwise, we have to remove register operands from their register use
588 // list, add the operand, then add the register operands back to their use
589 // list. This also must handle the case when the operand list reallocates
590 // to somewhere else.
592 // If insertion of this operand won't cause reallocation of the operand
593 // list, just remove the implicit operands, add the operand, then re-add all
594 // the rest of the operands.
595 for (unsigned i = OpNo, e = Operands.size(); i != e; ++i) {
596 assert(Operands[i].isReg() && "Should only be an implicit reg!");
597 Operands[i].RemoveRegOperandFromRegInfo();
600 // Add the operand. If it is a register, add it to the reg list.
601 Operands.insert(Operands.begin()+OpNo, Op);
602 Operands[OpNo].ParentMI = this;
604 if (Operands[OpNo].isReg()) {
605 Operands[OpNo].AddRegOperandToRegInfo(RegInfo);
606 // If the register operand is flagged as early, mark the operand as such
607 if (TID->getOperandConstraint(OpNo, TOI::EARLY_CLOBBER) != -1)
608 Operands[OpNo].setIsEarlyClobber(true);
611 // Re-add all the implicit ops.
612 for (unsigned i = OpNo+1, e = Operands.size(); i != e; ++i) {
613 assert(Operands[i].isReg() && "Should only be an implicit reg!");
614 Operands[i].AddRegOperandToRegInfo(RegInfo);
617 // Otherwise, we will be reallocating the operand list. Remove all reg
618 // operands from their list, then readd them after the operand list is
620 RemoveRegOperandsFromUseLists();
622 Operands.insert(Operands.begin()+OpNo, Op);
623 Operands[OpNo].ParentMI = this;
625 // Re-add all the operands.
626 AddRegOperandsToUseLists(*RegInfo);
628 // If the register operand is flagged as early, mark the operand as such
629 if (Operands[OpNo].isReg()
630 && TID->getOperandConstraint(OpNo, TOI::EARLY_CLOBBER) != -1)
631 Operands[OpNo].setIsEarlyClobber(true);
635 /// RemoveOperand - Erase an operand from an instruction, leaving it with one
636 /// fewer operand than it started with.
638 void MachineInstr::RemoveOperand(unsigned OpNo) {
639 assert(OpNo < Operands.size() && "Invalid operand number");
641 // Special case removing the last one.
642 if (OpNo == Operands.size()-1) {
643 // If needed, remove from the reg def/use list.
644 if (Operands.back().isReg() && Operands.back().isOnRegUseList())
645 Operands.back().RemoveRegOperandFromRegInfo();
651 // Otherwise, we are removing an interior operand. If we have reginfo to
652 // update, remove all operands that will be shifted down from their reg lists,
653 // move everything down, then re-add them.
654 MachineRegisterInfo *RegInfo = getRegInfo();
656 for (unsigned i = OpNo, e = Operands.size(); i != e; ++i) {
657 if (Operands[i].isReg())
658 Operands[i].RemoveRegOperandFromRegInfo();
662 Operands.erase(Operands.begin()+OpNo);
665 for (unsigned i = OpNo, e = Operands.size(); i != e; ++i) {
666 if (Operands[i].isReg())
667 Operands[i].AddRegOperandToRegInfo(RegInfo);
672 /// addMemOperand - Add a MachineMemOperand to the machine instruction.
673 /// This function should be used only occasionally. The setMemRefs function
674 /// is the primary method for setting up a MachineInstr's MemRefs list.
675 void MachineInstr::addMemOperand(MachineFunction &MF,
676 MachineMemOperand *MO) {
677 mmo_iterator OldMemRefs = MemRefs;
678 mmo_iterator OldMemRefsEnd = MemRefsEnd;
680 size_t NewNum = (MemRefsEnd - MemRefs) + 1;
681 mmo_iterator NewMemRefs = MF.allocateMemRefsArray(NewNum);
682 mmo_iterator NewMemRefsEnd = NewMemRefs + NewNum;
684 std::copy(OldMemRefs, OldMemRefsEnd, NewMemRefs);
685 NewMemRefs[NewNum - 1] = MO;
687 MemRefs = NewMemRefs;
688 MemRefsEnd = NewMemRefsEnd;
691 bool MachineInstr::isIdenticalTo(const MachineInstr *Other,
692 MICheckType Check) const {
693 // If opcodes or number of operands are not the same then the two
694 // instructions are obviously not identical.
695 if (Other->getOpcode() != getOpcode() ||
696 Other->getNumOperands() != getNumOperands())
699 // Check operands to make sure they match.
700 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
701 const MachineOperand &MO = getOperand(i);
702 const MachineOperand &OMO = Other->getOperand(i);
703 // Clients may or may not want to ignore defs when testing for equality.
704 // For example, machine CSE pass only cares about finding common
705 // subexpressions, so it's safe to ignore virtual register defs.
706 if (Check != CheckDefs && MO.isReg() && MO.isDef()) {
707 if (Check == IgnoreDefs)
709 // Check == IgnoreVRegDefs
710 if (TargetRegisterInfo::isPhysicalRegister(MO.getReg()) ||
711 TargetRegisterInfo::isPhysicalRegister(OMO.getReg()))
712 if (MO.getReg() != OMO.getReg())
714 } else if (!MO.isIdenticalTo(OMO))
720 /// removeFromParent - This method unlinks 'this' from the containing basic
721 /// block, and returns it, but does not delete it.
722 MachineInstr *MachineInstr::removeFromParent() {
723 assert(getParent() && "Not embedded in a basic block!");
724 getParent()->remove(this);
729 /// eraseFromParent - This method unlinks 'this' from the containing basic
730 /// block, and deletes it.
731 void MachineInstr::eraseFromParent() {
732 assert(getParent() && "Not embedded in a basic block!");
733 getParent()->erase(this);
737 /// OperandComplete - Return true if it's illegal to add a new operand
739 bool MachineInstr::OperandsComplete() const {
740 unsigned short NumOperands = TID->getNumOperands();
741 if (!TID->isVariadic() && getNumOperands()-NumImplicitOps >= NumOperands)
742 return true; // Broken: we have all the operands of this instruction!
746 /// getNumExplicitOperands - Returns the number of non-implicit operands.
748 unsigned MachineInstr::getNumExplicitOperands() const {
749 unsigned NumOperands = TID->getNumOperands();
750 if (!TID->isVariadic())
753 for (unsigned i = NumOperands, e = getNumOperands(); i != e; ++i) {
754 const MachineOperand &MO = getOperand(i);
755 if (!MO.isReg() || !MO.isImplicit())
762 /// findRegisterUseOperandIdx() - Returns the MachineOperand that is a use of
763 /// the specific register or -1 if it is not found. It further tightens
764 /// the search criteria to a use that kills the register if isKill is true.
765 int MachineInstr::findRegisterUseOperandIdx(unsigned Reg, bool isKill,
766 const TargetRegisterInfo *TRI) const {
767 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
768 const MachineOperand &MO = getOperand(i);
769 if (!MO.isReg() || !MO.isUse())
771 unsigned MOReg = MO.getReg();
776 TargetRegisterInfo::isPhysicalRegister(MOReg) &&
777 TargetRegisterInfo::isPhysicalRegister(Reg) &&
778 TRI->isSubRegister(MOReg, Reg)))
779 if (!isKill || MO.isKill())
785 /// findRegisterDefOperandIdx() - Returns the operand index that is a def of
786 /// the specified register or -1 if it is not found. If isDead is true, defs
787 /// that are not dead are skipped. If TargetRegisterInfo is non-null, then it
788 /// also checks if there is a def of a super-register.
789 int MachineInstr::findRegisterDefOperandIdx(unsigned Reg, bool isDead,
790 const TargetRegisterInfo *TRI) const {
791 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
792 const MachineOperand &MO = getOperand(i);
793 if (!MO.isReg() || !MO.isDef())
795 unsigned MOReg = MO.getReg();
798 TargetRegisterInfo::isPhysicalRegister(MOReg) &&
799 TargetRegisterInfo::isPhysicalRegister(Reg) &&
800 TRI->isSubRegister(MOReg, Reg)))
801 if (!isDead || MO.isDead())
807 /// findFirstPredOperandIdx() - Find the index of the first operand in the
808 /// operand list that is used to represent the predicate. It returns -1 if
810 int MachineInstr::findFirstPredOperandIdx() const {
811 const TargetInstrDesc &TID = getDesc();
812 if (TID.isPredicable()) {
813 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
814 if (TID.OpInfo[i].isPredicate())
821 /// isRegTiedToUseOperand - Given the index of a register def operand,
822 /// check if the register def is tied to a source operand, due to either
823 /// two-address elimination or inline assembly constraints. Returns the
824 /// first tied use operand index by reference is UseOpIdx is not null.
826 isRegTiedToUseOperand(unsigned DefOpIdx, unsigned *UseOpIdx) const {
828 assert(DefOpIdx >= 2);
829 const MachineOperand &MO = getOperand(DefOpIdx);
830 if (!MO.isReg() || !MO.isDef() || MO.getReg() == 0)
832 // Determine the actual operand index that corresponds to this index.
834 unsigned DefPart = 0;
835 for (unsigned i = 1, e = getNumOperands(); i < e; ) {
836 const MachineOperand &FMO = getOperand(i);
837 // After the normal asm operands there may be additional imp-def regs.
840 // Skip over this def.
841 unsigned NumOps = InlineAsm::getNumOperandRegisters(FMO.getImm());
842 unsigned PrevDef = i + 1;
843 i = PrevDef + NumOps;
845 DefPart = DefOpIdx - PrevDef;
850 for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
851 const MachineOperand &FMO = getOperand(i);
854 if (i+1 >= e || !getOperand(i+1).isReg() || !getOperand(i+1).isUse())
857 if (InlineAsm::isUseOperandTiedToDef(FMO.getImm(), Idx) &&
860 *UseOpIdx = (unsigned)i + 1 + DefPart;
867 assert(getOperand(DefOpIdx).isDef() && "DefOpIdx is not a def!");
868 const TargetInstrDesc &TID = getDesc();
869 for (unsigned i = 0, e = TID.getNumOperands(); i != e; ++i) {
870 const MachineOperand &MO = getOperand(i);
871 if (MO.isReg() && MO.isUse() &&
872 TID.getOperandConstraint(i, TOI::TIED_TO) == (int)DefOpIdx) {
874 *UseOpIdx = (unsigned)i;
881 /// isRegTiedToDefOperand - Return true if the operand of the specified index
882 /// is a register use and it is tied to an def operand. It also returns the def
883 /// operand index by reference.
885 isRegTiedToDefOperand(unsigned UseOpIdx, unsigned *DefOpIdx) const {
887 const MachineOperand &MO = getOperand(UseOpIdx);
888 if (!MO.isReg() || !MO.isUse() || MO.getReg() == 0)
891 // Find the flag operand corresponding to UseOpIdx
892 unsigned FlagIdx, NumOps=0;
893 for (FlagIdx = 1; FlagIdx < UseOpIdx; FlagIdx += NumOps+1) {
894 const MachineOperand &UFMO = getOperand(FlagIdx);
895 // After the normal asm operands there may be additional imp-def regs.
898 NumOps = InlineAsm::getNumOperandRegisters(UFMO.getImm());
899 assert(NumOps < getNumOperands() && "Invalid inline asm flag");
900 if (UseOpIdx < FlagIdx+NumOps+1)
903 if (FlagIdx >= UseOpIdx)
905 const MachineOperand &UFMO = getOperand(FlagIdx);
907 if (InlineAsm::isUseOperandTiedToDef(UFMO.getImm(), DefNo)) {
912 // Remember to adjust the index. First operand is asm string, then there
913 // is a flag for each.
915 const MachineOperand &FMO = getOperand(DefIdx);
917 // Skip over this def.
918 DefIdx += InlineAsm::getNumOperandRegisters(FMO.getImm()) + 1;
921 *DefOpIdx = DefIdx + UseOpIdx - FlagIdx;
927 const TargetInstrDesc &TID = getDesc();
928 if (UseOpIdx >= TID.getNumOperands())
930 const MachineOperand &MO = getOperand(UseOpIdx);
931 if (!MO.isReg() || !MO.isUse())
933 int DefIdx = TID.getOperandConstraint(UseOpIdx, TOI::TIED_TO);
937 *DefOpIdx = (unsigned)DefIdx;
941 /// copyKillDeadInfo - Copies kill / dead operand properties from MI.
943 void MachineInstr::copyKillDeadInfo(const MachineInstr *MI) {
944 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
945 const MachineOperand &MO = MI->getOperand(i);
946 if (!MO.isReg() || (!MO.isKill() && !MO.isDead()))
948 for (unsigned j = 0, ee = getNumOperands(); j != ee; ++j) {
949 MachineOperand &MOp = getOperand(j);
950 if (!MOp.isIdenticalTo(MO))
961 /// copyPredicates - Copies predicate operand(s) from MI.
962 void MachineInstr::copyPredicates(const MachineInstr *MI) {
963 const TargetInstrDesc &TID = MI->getDesc();
964 if (!TID.isPredicable())
966 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
967 if (TID.OpInfo[i].isPredicate()) {
968 // Predicated operands must be last operands.
969 addOperand(MI->getOperand(i));
974 /// isSafeToMove - Return true if it is safe to move this instruction. If
975 /// SawStore is set to true, it means that there is a store (or call) between
976 /// the instruction's location and its intended destination.
977 bool MachineInstr::isSafeToMove(const TargetInstrInfo *TII,
979 bool &SawStore) const {
980 // Ignore stuff that we obviously can't move.
981 if (TID->mayStore() || TID->isCall()) {
985 if (TID->isTerminator() || TID->hasUnmodeledSideEffects())
988 // See if this instruction does a load. If so, we have to guarantee that the
989 // loaded value doesn't change between the load and the its intended
990 // destination. The check for isInvariantLoad gives the targe the chance to
991 // classify the load as always returning a constant, e.g. a constant pool
993 if (TID->mayLoad() && !isInvariantLoad(AA))
994 // Otherwise, this is a real load. If there is a store between the load and
995 // end of block, or if the load is volatile, we can't move it.
996 return !SawStore && !hasVolatileMemoryRef();
1001 /// isSafeToReMat - Return true if it's safe to rematerialize the specified
1002 /// instruction which defined the specified register instead of copying it.
1003 bool MachineInstr::isSafeToReMat(const TargetInstrInfo *TII,
1005 unsigned DstReg) const {
1006 bool SawStore = false;
1007 if (!TII->isTriviallyReMaterializable(this, AA) ||
1008 !isSafeToMove(TII, AA, SawStore))
1010 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1011 const MachineOperand &MO = getOperand(i);
1014 // FIXME: For now, do not remat any instruction with register operands.
1015 // Later on, we can loosen the restriction is the register operands have
1016 // not been modified between the def and use. Note, this is different from
1017 // MachineSink because the code is no longer in two-address form (at least
1021 else if (!MO.isDead() && MO.getReg() != DstReg)
1027 /// hasVolatileMemoryRef - Return true if this instruction may have a
1028 /// volatile memory reference, or if the information describing the
1029 /// memory reference is not available. Return false if it is known to
1030 /// have no volatile memory references.
1031 bool MachineInstr::hasVolatileMemoryRef() const {
1032 // An instruction known never to access memory won't have a volatile access.
1033 if (!TID->mayStore() &&
1036 !TID->hasUnmodeledSideEffects())
1039 // Otherwise, if the instruction has no memory reference information,
1040 // conservatively assume it wasn't preserved.
1041 if (memoperands_empty())
1044 // Check the memory reference information for volatile references.
1045 for (mmo_iterator I = memoperands_begin(), E = memoperands_end(); I != E; ++I)
1046 if ((*I)->isVolatile())
1052 /// isInvariantLoad - Return true if this instruction is loading from a
1053 /// location whose value is invariant across the function. For example,
1054 /// loading a value from the constant pool or from the argument area
1055 /// of a function if it does not change. This should only return true of
1056 /// *all* loads the instruction does are invariant (if it does multiple loads).
1057 bool MachineInstr::isInvariantLoad(AliasAnalysis *AA) const {
1058 // If the instruction doesn't load at all, it isn't an invariant load.
1059 if (!TID->mayLoad())
1062 // If the instruction has lost its memoperands, conservatively assume that
1063 // it may not be an invariant load.
1064 if (memoperands_empty())
1067 const MachineFrameInfo *MFI = getParent()->getParent()->getFrameInfo();
1069 for (mmo_iterator I = memoperands_begin(),
1070 E = memoperands_end(); I != E; ++I) {
1071 if ((*I)->isVolatile()) return false;
1072 if ((*I)->isStore()) return false;
1074 if (const Value *V = (*I)->getValue()) {
1075 // A load from a constant PseudoSourceValue is invariant.
1076 if (const PseudoSourceValue *PSV = dyn_cast<PseudoSourceValue>(V))
1077 if (PSV->isConstant(MFI))
1079 // If we have an AliasAnalysis, ask it whether the memory is constant.
1080 if (AA && AA->pointsToConstantMemory(V))
1084 // Otherwise assume conservatively.
1088 // Everything checks out.
1092 /// isConstantValuePHI - If the specified instruction is a PHI that always
1093 /// merges together the same virtual register, return the register, otherwise
1095 unsigned MachineInstr::isConstantValuePHI() const {
1098 assert(getNumOperands() >= 3 &&
1099 "It's illegal to have a PHI without source operands");
1101 unsigned Reg = getOperand(1).getReg();
1102 for (unsigned i = 3, e = getNumOperands(); i < e; i += 2)
1103 if (getOperand(i).getReg() != Reg)
1108 /// allDefsAreDead - Return true if all the defs of this instruction are dead.
1110 bool MachineInstr::allDefsAreDead() const {
1111 for (unsigned i = 0, e = getNumOperands(); i < e; ++i) {
1112 const MachineOperand &MO = getOperand(i);
1113 if (!MO.isReg() || MO.isUse())
1121 void MachineInstr::dump() const {
1122 dbgs() << " " << *this;
1125 void MachineInstr::print(raw_ostream &OS, const TargetMachine *TM) const {
1126 // We can be a bit tidier if we know the TargetMachine and/or MachineFunction.
1127 const MachineFunction *MF = 0;
1128 if (const MachineBasicBlock *MBB = getParent()) {
1129 MF = MBB->getParent();
1131 TM = &MF->getTarget();
1134 // Print explicitly defined operands on the left of an assignment syntax.
1135 unsigned StartOp = 0, e = getNumOperands();
1136 for (; StartOp < e && getOperand(StartOp).isReg() &&
1137 getOperand(StartOp).isDef() &&
1138 !getOperand(StartOp).isImplicit();
1140 if (StartOp != 0) OS << ", ";
1141 getOperand(StartOp).print(OS, TM);
1147 // Print the opcode name.
1148 OS << getDesc().getName();
1150 // Print the rest of the operands.
1151 bool OmittedAnyCallClobbers = false;
1152 bool FirstOp = true;
1153 for (unsigned i = StartOp, e = getNumOperands(); i != e; ++i) {
1154 const MachineOperand &MO = getOperand(i);
1156 // Omit call-clobbered registers which aren't used anywhere. This makes
1157 // call instructions much less noisy on targets where calls clobber lots
1158 // of registers. Don't rely on MO.isDead() because we may be called before
1159 // LiveVariables is run, or we may be looking at a non-allocatable reg.
1160 if (MF && getDesc().isCall() &&
1161 MO.isReg() && MO.isImplicit() && MO.isDef()) {
1162 unsigned Reg = MO.getReg();
1163 if (Reg != 0 && TargetRegisterInfo::isPhysicalRegister(Reg)) {
1164 const MachineRegisterInfo &MRI = MF->getRegInfo();
1165 if (MRI.use_empty(Reg) && !MRI.isLiveOut(Reg)) {
1166 bool HasAliasLive = false;
1167 for (const unsigned *Alias = TM->getRegisterInfo()->getAliasSet(Reg);
1168 unsigned AliasReg = *Alias; ++Alias)
1169 if (!MRI.use_empty(AliasReg) || MRI.isLiveOut(AliasReg)) {
1170 HasAliasLive = true;
1173 if (!HasAliasLive) {
1174 OmittedAnyCallClobbers = true;
1181 if (FirstOp) FirstOp = false; else OS << ",";
1183 if (i < getDesc().NumOperands) {
1184 const TargetOperandInfo &TOI = getDesc().OpInfo[i];
1185 if (TOI.isPredicate())
1187 if (TOI.isOptionalDef())
1190 if (isDebugValue() && MO.isMetadata()) {
1191 // Pretty print DBG_VALUE instructions.
1192 const MDNode *MD = MO.getMetadata();
1193 if (const MDString *MDS = dyn_cast<MDString>(MD->getOperand(2)))
1194 OS << "!\"" << MDS->getString() << '\"';
1201 // Briefly indicate whether any call clobbers were omitted.
1202 if (OmittedAnyCallClobbers) {
1203 if (!FirstOp) OS << ",";
1207 bool HaveSemi = false;
1208 if (!memoperands_empty()) {
1209 if (!HaveSemi) OS << ";"; HaveSemi = true;
1212 for (mmo_iterator i = memoperands_begin(), e = memoperands_end();
1220 if (!debugLoc.isUnknown() && MF) {
1221 if (!HaveSemi) OS << ";";
1223 // TODO: print InlinedAtLoc information
1225 DIScope Scope(debugLoc.getScope(MF->getFunction()->getContext()));
1227 // Omit the directory, since it's usually long and uninteresting.
1229 OS << Scope.getFilename();
1232 OS << ':' << debugLoc.getLine();
1233 if (debugLoc.getCol() != 0)
1234 OS << ':' << debugLoc.getCol();
1240 bool MachineInstr::addRegisterKilled(unsigned IncomingReg,
1241 const TargetRegisterInfo *RegInfo,
1242 bool AddIfNotFound) {
1243 bool isPhysReg = TargetRegisterInfo::isPhysicalRegister(IncomingReg);
1244 bool hasAliases = isPhysReg && RegInfo->getAliasSet(IncomingReg);
1246 SmallVector<unsigned,4> DeadOps;
1247 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1248 MachineOperand &MO = getOperand(i);
1249 if (!MO.isReg() || !MO.isUse() || MO.isUndef())
1251 unsigned Reg = MO.getReg();
1255 if (Reg == IncomingReg) {
1258 // The register is already marked kill.
1260 if (isPhysReg && isRegTiedToDefOperand(i))
1261 // Two-address uses of physregs must not be marked kill.
1266 } else if (hasAliases && MO.isKill() &&
1267 TargetRegisterInfo::isPhysicalRegister(Reg)) {
1268 // A super-register kill already exists.
1269 if (RegInfo->isSuperRegister(IncomingReg, Reg))
1271 if (RegInfo->isSubRegister(IncomingReg, Reg))
1272 DeadOps.push_back(i);
1276 // Trim unneeded kill operands.
1277 while (!DeadOps.empty()) {
1278 unsigned OpIdx = DeadOps.back();
1279 if (getOperand(OpIdx).isImplicit())
1280 RemoveOperand(OpIdx);
1282 getOperand(OpIdx).setIsKill(false);
1286 // If not found, this means an alias of one of the operands is killed. Add a
1287 // new implicit operand if required.
1288 if (!Found && AddIfNotFound) {
1289 addOperand(MachineOperand::CreateReg(IncomingReg,
1298 bool MachineInstr::addRegisterDead(unsigned IncomingReg,
1299 const TargetRegisterInfo *RegInfo,
1300 bool AddIfNotFound) {
1301 bool isPhysReg = TargetRegisterInfo::isPhysicalRegister(IncomingReg);
1302 bool hasAliases = isPhysReg && RegInfo->getAliasSet(IncomingReg);
1304 SmallVector<unsigned,4> DeadOps;
1305 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1306 MachineOperand &MO = getOperand(i);
1307 if (!MO.isReg() || !MO.isDef())
1309 unsigned Reg = MO.getReg();
1313 if (Reg == IncomingReg) {
1316 // The register is already marked dead.
1321 } else if (hasAliases && MO.isDead() &&
1322 TargetRegisterInfo::isPhysicalRegister(Reg)) {
1323 // There exists a super-register that's marked dead.
1324 if (RegInfo->isSuperRegister(IncomingReg, Reg))
1326 if (RegInfo->getSubRegisters(IncomingReg) &&
1327 RegInfo->getSuperRegisters(Reg) &&
1328 RegInfo->isSubRegister(IncomingReg, Reg))
1329 DeadOps.push_back(i);
1333 // Trim unneeded dead operands.
1334 while (!DeadOps.empty()) {
1335 unsigned OpIdx = DeadOps.back();
1336 if (getOperand(OpIdx).isImplicit())
1337 RemoveOperand(OpIdx);
1339 getOperand(OpIdx).setIsDead(false);
1343 // If not found, this means an alias of one of the operands is dead. Add a
1344 // new implicit operand if required.
1345 if (Found || !AddIfNotFound)
1348 addOperand(MachineOperand::CreateReg(IncomingReg,
1356 void MachineInstr::addRegisterDefined(unsigned IncomingReg,
1357 const TargetRegisterInfo *RegInfo) {
1358 MachineOperand *MO = findRegisterDefOperand(IncomingReg, false, RegInfo);
1359 if (!MO || MO->getSubReg())
1360 addOperand(MachineOperand::CreateReg(IncomingReg,
1366 MachineInstrExpressionTrait::getHashValue(const MachineInstr* const &MI) {
1367 unsigned Hash = MI->getOpcode() * 37;
1368 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1369 const MachineOperand &MO = MI->getOperand(i);
1370 uint64_t Key = (uint64_t)MO.getType() << 32;
1371 switch (MO.getType()) {
1373 case MachineOperand::MO_Register:
1374 if (MO.isDef() && MO.getReg() &&
1375 TargetRegisterInfo::isVirtualRegister(MO.getReg()))
1376 continue; // Skip virtual register defs.
1379 case MachineOperand::MO_Immediate:
1382 case MachineOperand::MO_FrameIndex:
1383 case MachineOperand::MO_ConstantPoolIndex:
1384 case MachineOperand::MO_JumpTableIndex:
1385 Key |= MO.getIndex();
1387 case MachineOperand::MO_MachineBasicBlock:
1388 Key |= DenseMapInfo<void*>::getHashValue(MO.getMBB());
1390 case MachineOperand::MO_GlobalAddress:
1391 Key |= DenseMapInfo<void*>::getHashValue(MO.getGlobal());
1393 case MachineOperand::MO_BlockAddress:
1394 Key |= DenseMapInfo<void*>::getHashValue(MO.getBlockAddress());
1396 case MachineOperand::MO_MCSymbol:
1397 Key |= DenseMapInfo<void*>::getHashValue(MO.getMCSymbol());
1400 Key += ~(Key << 32);
1402 Key += ~(Key << 13);
1406 Key += ~(Key << 27);
1408 Hash = (unsigned)Key + Hash * 37;