1 //===-- MachineFunction.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 // Collect native machine code information for a function. This allows
11 // target-specific information about the generated code to be stored with each
14 //===----------------------------------------------------------------------===//
16 #include "llvm/DerivedTypes.h"
17 #include "llvm/Function.h"
18 #include "llvm/Instructions.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/Config/config.h"
21 #include "llvm/CodeGen/MachineConstantPool.h"
22 #include "llvm/CodeGen/MachineFunction.h"
23 #include "llvm/CodeGen/MachineFunctionPass.h"
24 #include "llvm/CodeGen/MachineFrameInfo.h"
25 #include "llvm/CodeGen/MachineInstr.h"
26 #include "llvm/CodeGen/MachineJumpTableInfo.h"
27 #include "llvm/CodeGen/MachineRegisterInfo.h"
28 #include "llvm/CodeGen/Passes.h"
29 #include "llvm/Target/TargetData.h"
30 #include "llvm/Target/TargetLowering.h"
31 #include "llvm/Target/TargetMachine.h"
32 #include "llvm/Target/TargetFrameInfo.h"
33 #include "llvm/Support/GraphWriter.h"
34 #include "llvm/Support/raw_ostream.h"
38 struct Printer : public MachineFunctionPass {
42 const std::string Banner;
44 Printer(raw_ostream &os, const std::string &banner)
45 : MachineFunctionPass(&ID), OS(os), Banner(banner) {}
47 const char *getPassName() const { return "MachineFunction Printer"; }
49 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
51 MachineFunctionPass::getAnalysisUsage(AU);
54 bool runOnMachineFunction(MachineFunction &MF) {
63 /// Returns a newly-created MachineFunction Printer pass. The default banner is
66 FunctionPass *llvm::createMachineFunctionPrinterPass(raw_ostream &OS,
67 const std::string &Banner){
68 return new Printer(OS, Banner);
71 //===---------------------------------------------------------------------===//
72 // MachineFunction implementation
73 //===---------------------------------------------------------------------===//
75 // Out of line virtual method.
76 MachineFunctionInfo::~MachineFunctionInfo() {}
78 void ilist_traits<MachineBasicBlock>::deleteNode(MachineBasicBlock *MBB) {
79 MBB->getParent()->DeleteMachineBasicBlock(MBB);
82 MachineFunction::MachineFunction(Function *F,
83 const TargetMachine &TM)
85 if (TM.getRegisterInfo())
86 RegInfo = new (Allocator.Allocate<MachineRegisterInfo>())
87 MachineRegisterInfo(*TM.getRegisterInfo());
91 FrameInfo = new (Allocator.Allocate<MachineFrameInfo>())
92 MachineFrameInfo(*TM.getFrameInfo());
93 ConstantPool = new (Allocator.Allocate<MachineConstantPool>())
94 MachineConstantPool(TM.getTargetData());
95 Alignment = TM.getTargetLowering()->getFunctionAlignment(F);
98 const TargetData &TD = *TM.getTargetData();
99 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
100 unsigned EntrySize = IsPic ? 4 : TD.getPointerSize();
101 unsigned TyAlignment = IsPic ?
102 TD.getABITypeAlignment(Type::getInt32Ty(F->getContext()))
103 : TD.getPointerABIAlignment();
104 JumpTableInfo = new (Allocator.Allocate<MachineJumpTableInfo>())
105 MachineJumpTableInfo(EntrySize, TyAlignment);
108 MachineFunction::~MachineFunction() {
110 InstructionRecycler.clear(Allocator);
111 BasicBlockRecycler.clear(Allocator);
113 RegInfo->~MachineRegisterInfo();
114 Allocator.Deallocate(RegInfo);
117 MFInfo->~MachineFunctionInfo();
118 Allocator.Deallocate(MFInfo);
120 FrameInfo->~MachineFrameInfo(); Allocator.Deallocate(FrameInfo);
121 ConstantPool->~MachineConstantPool(); Allocator.Deallocate(ConstantPool);
122 JumpTableInfo->~MachineJumpTableInfo(); Allocator.Deallocate(JumpTableInfo);
126 /// RenumberBlocks - This discards all of the MachineBasicBlock numbers and
127 /// recomputes them. This guarantees that the MBB numbers are sequential,
128 /// dense, and match the ordering of the blocks within the function. If a
129 /// specific MachineBasicBlock is specified, only that block and those after
130 /// it are renumbered.
131 void MachineFunction::RenumberBlocks(MachineBasicBlock *MBB) {
132 if (empty()) { MBBNumbering.clear(); return; }
133 MachineFunction::iterator MBBI, E = end();
139 // Figure out the block number this should have.
140 unsigned BlockNo = 0;
142 BlockNo = prior(MBBI)->getNumber()+1;
144 for (; MBBI != E; ++MBBI, ++BlockNo) {
145 if (MBBI->getNumber() != (int)BlockNo) {
146 // Remove use of the old number.
147 if (MBBI->getNumber() != -1) {
148 assert(MBBNumbering[MBBI->getNumber()] == &*MBBI &&
149 "MBB number mismatch!");
150 MBBNumbering[MBBI->getNumber()] = 0;
153 // If BlockNo is already taken, set that block's number to -1.
154 if (MBBNumbering[BlockNo])
155 MBBNumbering[BlockNo]->setNumber(-1);
157 MBBNumbering[BlockNo] = MBBI;
158 MBBI->setNumber(BlockNo);
162 // Okay, all the blocks are renumbered. If we have compactified the block
163 // numbering, shrink MBBNumbering now.
164 assert(BlockNo <= MBBNumbering.size() && "Mismatch!");
165 MBBNumbering.resize(BlockNo);
168 /// CreateMachineInstr - Allocate a new MachineInstr. Use this instead
169 /// of `new MachineInstr'.
172 MachineFunction::CreateMachineInstr(const TargetInstrDesc &TID,
173 DebugLoc DL, bool NoImp) {
174 return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
175 MachineInstr(TID, DL, NoImp);
178 /// CloneMachineInstr - Create a new MachineInstr which is a copy of the
179 /// 'Orig' instruction, identical in all ways except the the instruction
180 /// has no parent, prev, or next.
183 MachineFunction::CloneMachineInstr(const MachineInstr *Orig) {
184 return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
185 MachineInstr(*this, *Orig);
188 /// DeleteMachineInstr - Delete the given MachineInstr.
191 MachineFunction::DeleteMachineInstr(MachineInstr *MI) {
193 InstructionRecycler.Deallocate(Allocator, MI);
196 /// CreateMachineBasicBlock - Allocate a new MachineBasicBlock. Use this
197 /// instead of `new MachineBasicBlock'.
200 MachineFunction::CreateMachineBasicBlock(const BasicBlock *bb) {
201 return new (BasicBlockRecycler.Allocate<MachineBasicBlock>(Allocator))
202 MachineBasicBlock(*this, bb);
205 /// DeleteMachineBasicBlock - Delete the given MachineBasicBlock.
208 MachineFunction::DeleteMachineBasicBlock(MachineBasicBlock *MBB) {
209 assert(MBB->getParent() == this && "MBB parent mismatch!");
210 MBB->~MachineBasicBlock();
211 BasicBlockRecycler.Deallocate(Allocator, MBB);
215 MachineFunction::getMachineMemOperand(const Value *v, unsigned f,
216 int64_t o, uint64_t s,
217 unsigned base_alignment) {
218 return new (Allocator.Allocate<MachineMemOperand>())
219 MachineMemOperand(v, f, o, s, base_alignment);
223 MachineFunction::getMachineMemOperand(const MachineMemOperand *MMO,
224 int64_t Offset, uint64_t Size) {
225 return new (Allocator.Allocate<MachineMemOperand>())
226 MachineMemOperand(MMO->getValue(), MMO->getFlags(),
227 int64_t(uint64_t(MMO->getOffset()) +
229 Size, MMO->getBaseAlignment());
232 MachineInstr::mmo_iterator
233 MachineFunction::allocateMemRefsArray(unsigned long Num) {
234 return Allocator.Allocate<MachineMemOperand *>(Num);
237 std::pair<MachineInstr::mmo_iterator, MachineInstr::mmo_iterator>
238 MachineFunction::extractLoadMemRefs(MachineInstr::mmo_iterator Begin,
239 MachineInstr::mmo_iterator End) {
240 // Count the number of load mem refs.
242 for (MachineInstr::mmo_iterator I = Begin; I != End; ++I)
246 // Allocate a new array and populate it with the load information.
247 MachineInstr::mmo_iterator Result = allocateMemRefsArray(Num);
249 for (MachineInstr::mmo_iterator I = Begin; I != End; ++I) {
250 if ((*I)->isLoad()) {
251 if (!(*I)->isStore())
255 // Clone the MMO and unset the store flag.
256 MachineMemOperand *JustLoad =
257 getMachineMemOperand((*I)->getValue(),
258 (*I)->getFlags() & ~MachineMemOperand::MOStore,
259 (*I)->getOffset(), (*I)->getSize(),
260 (*I)->getBaseAlignment());
261 Result[Index] = JustLoad;
266 return std::make_pair(Result, Result + Num);
269 std::pair<MachineInstr::mmo_iterator, MachineInstr::mmo_iterator>
270 MachineFunction::extractStoreMemRefs(MachineInstr::mmo_iterator Begin,
271 MachineInstr::mmo_iterator End) {
272 // Count the number of load mem refs.
274 for (MachineInstr::mmo_iterator I = Begin; I != End; ++I)
278 // Allocate a new array and populate it with the store information.
279 MachineInstr::mmo_iterator Result = allocateMemRefsArray(Num);
281 for (MachineInstr::mmo_iterator I = Begin; I != End; ++I) {
282 if ((*I)->isStore()) {
287 // Clone the MMO and unset the load flag.
288 MachineMemOperand *JustStore =
289 getMachineMemOperand((*I)->getValue(),
290 (*I)->getFlags() & ~MachineMemOperand::MOLoad,
291 (*I)->getOffset(), (*I)->getSize(),
292 (*I)->getBaseAlignment());
293 Result[Index] = JustStore;
298 return std::make_pair(Result, Result + Num);
301 void MachineFunction::dump() const {
305 void MachineFunction::print(raw_ostream &OS) const {
306 OS << "# Machine code for " << Fn->getName() << "():\n";
308 // Print Frame Information
309 FrameInfo->print(*this, OS);
311 // Print JumpTable Information
312 JumpTableInfo->print(OS);
314 // Print Constant Pool
315 ConstantPool->print(OS);
317 const TargetRegisterInfo *TRI = getTarget().getRegisterInfo();
319 if (RegInfo && !RegInfo->livein_empty()) {
321 for (MachineRegisterInfo::livein_iterator
322 I = RegInfo->livein_begin(), E = RegInfo->livein_end(); I != E; ++I) {
324 OS << " " << TRI->getName(I->first);
326 OS << " Reg #" << I->first;
329 OS << " in VR#" << I->second << ' ';
333 if (RegInfo && !RegInfo->liveout_empty()) {
335 for (MachineRegisterInfo::liveout_iterator
336 I = RegInfo->liveout_begin(), E = RegInfo->liveout_end(); I != E; ++I)
338 OS << ' ' << TRI->getName(*I);
340 OS << " Reg #" << *I;
344 for (const_iterator BB = begin(), E = end(); BB != E; ++BB)
347 OS << "\n# End machine code for " << Fn->getName() << "().\n\n";
352 struct DOTGraphTraits<const MachineFunction*> : public DefaultDOTGraphTraits {
353 static std::string getGraphName(const MachineFunction *F) {
354 return "CFG for '" + F->getFunction()->getNameStr() + "' function";
357 static std::string getNodeLabel(const MachineBasicBlock *Node,
358 const MachineFunction *Graph,
360 if (ShortNames && Node->getBasicBlock() &&
361 !Node->getBasicBlock()->getName().empty())
362 return Node->getBasicBlock()->getNameStr() + ":";
366 raw_string_ostream OSS(OutStr);
369 OSS << Node->getNumber() << ':';
374 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
376 // Process string output to make it nicer...
377 for (unsigned i = 0; i != OutStr.length(); ++i)
378 if (OutStr[i] == '\n') { // Left justify
380 OutStr.insert(OutStr.begin()+i+1, 'l');
387 void MachineFunction::viewCFG() const
390 ViewGraph(this, "mf" + getFunction()->getNameStr());
392 errs() << "SelectionDAG::viewGraph is only available in debug builds on "
393 << "systems with Graphviz or gv!\n";
397 void MachineFunction::viewCFGOnly() const
400 ViewGraph(this, "mf" + getFunction()->getNameStr(), true);
402 errs() << "SelectionDAG::viewGraph is only available in debug builds on "
403 << "systems with Graphviz or gv!\n";
407 /// addLiveIn - Add the specified physical register as a live-in value and
408 /// create a corresponding virtual register for it.
409 unsigned MachineFunction::addLiveIn(unsigned PReg,
410 const TargetRegisterClass *RC) {
411 assert(RC->contains(PReg) && "Not the correct regclass!");
412 unsigned VReg = getRegInfo().createVirtualRegister(RC);
413 getRegInfo().addLiveIn(PReg, VReg);
417 /// getDebugLocTuple - Get the DebugLocTuple for a given DebugLoc object.
418 DebugLocTuple MachineFunction::getDebugLocTuple(DebugLoc DL) const {
419 unsigned Idx = DL.getIndex();
420 assert(Idx < DebugLocInfo.DebugLocations.size() &&
421 "Invalid index into debug locations!");
422 return DebugLocInfo.DebugLocations[Idx];
425 //===----------------------------------------------------------------------===//
426 // MachineFrameInfo implementation
427 //===----------------------------------------------------------------------===//
429 /// CreateFixedObject - Create a new object at a fixed location on the stack.
430 /// All fixed objects should be created before other objects are created for
431 /// efficiency. By default, fixed objects are immutable. This returns an
432 /// index with a negative value.
434 int MachineFrameInfo::CreateFixedObject(uint64_t Size, int64_t SPOffset,
436 assert(Size != 0 && "Cannot allocate zero size fixed stack objects!");
437 Objects.insert(Objects.begin(), StackObject(Size, 1, SPOffset, Immutable));
438 return -++NumFixedObjects;
443 MachineFrameInfo::getPristineRegs(const MachineBasicBlock *MBB) const {
444 assert(MBB && "MBB must be valid");
445 const MachineFunction *MF = MBB->getParent();
446 assert(MF && "MBB must be part of a MachineFunction");
447 const TargetMachine &TM = MF->getTarget();
448 const TargetRegisterInfo *TRI = TM.getRegisterInfo();
449 BitVector BV(TRI->getNumRegs());
451 // Before CSI is calculated, no registers are considered pristine. They can be
452 // freely used and PEI will make sure they are saved.
453 if (!isCalleeSavedInfoValid())
456 for (const unsigned *CSR = TRI->getCalleeSavedRegs(MF); CSR && *CSR; ++CSR)
459 // The entry MBB always has all CSRs pristine.
460 if (MBB == &MF->front())
463 // On other MBBs the saved CSRs are not pristine.
464 const std::vector<CalleeSavedInfo> &CSI = getCalleeSavedInfo();
465 for (std::vector<CalleeSavedInfo>::const_iterator I = CSI.begin(),
466 E = CSI.end(); I != E; ++I)
467 BV.reset(I->getReg());
473 void MachineFrameInfo::print(const MachineFunction &MF, raw_ostream &OS) const{
474 const TargetFrameInfo *FI = MF.getTarget().getFrameInfo();
475 int ValOffset = (FI ? FI->getOffsetOfLocalArea() : 0);
477 for (unsigned i = 0, e = Objects.size(); i != e; ++i) {
478 const StackObject &SO = Objects[i];
479 OS << " <fi#" << (int)(i-NumFixedObjects) << ">: ";
480 if (SO.Size == ~0ULL) {
485 OS << "variable sized";
487 OS << "size is " << SO.Size << " byte" << (SO.Size != 1 ? "s," : ",");
488 OS << " alignment is " << SO.Alignment << " byte"
489 << (SO.Alignment != 1 ? "s," : ",");
491 if (i < NumFixedObjects)
493 if (i < NumFixedObjects || SO.SPOffset != -1) {
494 int64_t Off = SO.SPOffset - ValOffset;
495 OS << " at location [SP";
505 if (HasVarSizedObjects)
506 OS << " Stack frame contains variable sized objects\n";
509 void MachineFrameInfo::dump(const MachineFunction &MF) const {
513 //===----------------------------------------------------------------------===//
514 // MachineJumpTableInfo implementation
515 //===----------------------------------------------------------------------===//
517 /// getJumpTableIndex - Create a new jump table entry in the jump table info
518 /// or return an existing one.
520 unsigned MachineJumpTableInfo::getJumpTableIndex(
521 const std::vector<MachineBasicBlock*> &DestBBs) {
522 assert(!DestBBs.empty() && "Cannot create an empty jump table!");
523 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i)
524 if (JumpTables[i].MBBs == DestBBs)
527 JumpTables.push_back(MachineJumpTableEntry(DestBBs));
528 return JumpTables.size()-1;
531 /// ReplaceMBBInJumpTables - If Old is the target of any jump tables, update
532 /// the jump tables to branch to New instead.
534 MachineJumpTableInfo::ReplaceMBBInJumpTables(MachineBasicBlock *Old,
535 MachineBasicBlock *New) {
536 assert(Old != New && "Not making a change?");
537 bool MadeChange = false;
538 for (size_t i = 0, e = JumpTables.size(); i != e; ++i) {
539 MachineJumpTableEntry &JTE = JumpTables[i];
540 for (size_t j = 0, e = JTE.MBBs.size(); j != e; ++j)
541 if (JTE.MBBs[j] == Old) {
549 void MachineJumpTableInfo::print(raw_ostream &OS) const {
550 // FIXME: this is lame, maybe we could print out the MBB numbers or something
551 // like {1, 2, 4, 5, 3, 0}
552 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i) {
553 OS << " <jt#" << i << "> has " << JumpTables[i].MBBs.size()
558 void MachineJumpTableInfo::dump() const { print(errs()); }
561 //===----------------------------------------------------------------------===//
562 // MachineConstantPool implementation
563 //===----------------------------------------------------------------------===//
565 const Type *MachineConstantPoolEntry::getType() const {
566 if (isMachineConstantPoolEntry())
567 return Val.MachineCPVal->getType();
568 return Val.ConstVal->getType();
572 unsigned MachineConstantPoolEntry::getRelocationInfo() const {
573 if (isMachineConstantPoolEntry())
574 return Val.MachineCPVal->getRelocationInfo();
575 return Val.ConstVal->getRelocationInfo();
578 MachineConstantPool::~MachineConstantPool() {
579 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
580 if (Constants[i].isMachineConstantPoolEntry())
581 delete Constants[i].Val.MachineCPVal;
584 /// CanShareConstantPoolEntry - Test whether the given two constants
585 /// can be allocated the same constant pool entry.
586 static bool CanShareConstantPoolEntry(Constant *A, Constant *B,
587 const TargetData *TD) {
588 // Handle the trivial case quickly.
589 if (A == B) return true;
591 // If they have the same type but weren't the same constant, quickly
593 if (A->getType() == B->getType()) return false;
595 // For now, only support constants with the same size.
596 if (TD->getTypeStoreSize(A->getType()) != TD->getTypeStoreSize(B->getType()))
599 // If a floating-point value and an integer value have the same encoding,
600 // they can share a constant-pool entry.
601 if (ConstantFP *AFP = dyn_cast<ConstantFP>(A))
602 if (ConstantInt *BI = dyn_cast<ConstantInt>(B))
603 return AFP->getValueAPF().bitcastToAPInt() == BI->getValue();
604 if (ConstantFP *BFP = dyn_cast<ConstantFP>(B))
605 if (ConstantInt *AI = dyn_cast<ConstantInt>(A))
606 return BFP->getValueAPF().bitcastToAPInt() == AI->getValue();
608 // Two vectors can share an entry if each pair of corresponding
610 if (ConstantVector *AV = dyn_cast<ConstantVector>(A))
611 if (ConstantVector *BV = dyn_cast<ConstantVector>(B)) {
612 if (AV->getType()->getNumElements() != BV->getType()->getNumElements())
614 for (unsigned i = 0, e = AV->getType()->getNumElements(); i != e; ++i)
615 if (!CanShareConstantPoolEntry(AV->getOperand(i),
616 BV->getOperand(i), TD))
621 // TODO: Handle other cases.
626 /// getConstantPoolIndex - Create a new entry in the constant pool or return
627 /// an existing one. User must specify the log2 of the minimum required
628 /// alignment for the object.
630 unsigned MachineConstantPool::getConstantPoolIndex(Constant *C,
631 unsigned Alignment) {
632 assert(Alignment && "Alignment must be specified!");
633 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
635 // Check to see if we already have this constant.
637 // FIXME, this could be made much more efficient for large constant pools.
638 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
639 if (!Constants[i].isMachineConstantPoolEntry() &&
640 CanShareConstantPoolEntry(Constants[i].Val.ConstVal, C, TD)) {
641 if ((unsigned)Constants[i].getAlignment() < Alignment)
642 Constants[i].Alignment = Alignment;
646 Constants.push_back(MachineConstantPoolEntry(C, Alignment));
647 return Constants.size()-1;
650 unsigned MachineConstantPool::getConstantPoolIndex(MachineConstantPoolValue *V,
651 unsigned Alignment) {
652 assert(Alignment && "Alignment must be specified!");
653 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
655 // Check to see if we already have this constant.
657 // FIXME, this could be made much more efficient for large constant pools.
658 int Idx = V->getExistingMachineCPValue(this, Alignment);
660 return (unsigned)Idx;
662 Constants.push_back(MachineConstantPoolEntry(V, Alignment));
663 return Constants.size()-1;
666 void MachineConstantPool::print(raw_ostream &OS) const {
667 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
668 OS << " <cp#" << i << "> is";
669 if (Constants[i].isMachineConstantPoolEntry())
670 Constants[i].Val.MachineCPVal->print(OS);
672 OS << *(Value*)Constants[i].Val.ConstVal;
673 OS << " , alignment=" << Constants[i].getAlignment();
678 void MachineConstantPool::dump() const { print(errs()); }