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/Compiler.h"
34 #include "llvm/Support/GraphWriter.h"
35 #include "llvm/Support/raw_ostream.h"
39 struct VISIBILITY_HIDDEN Printer : public MachineFunctionPass {
43 const std::string Banner;
45 Printer(raw_ostream &os, const std::string &banner)
46 : MachineFunctionPass(&ID), OS(os), Banner(banner) {}
48 const char *getPassName() const { return "MachineFunction Printer"; }
50 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
52 MachineFunctionPass::getAnalysisUsage(AU);
55 bool runOnMachineFunction(MachineFunction &MF) {
64 /// Returns a newly-created MachineFunction Printer pass. The default banner is
67 FunctionPass *llvm::createMachineFunctionPrinterPass(raw_ostream &OS,
68 const std::string &Banner){
69 return new Printer(OS, Banner);
72 //===---------------------------------------------------------------------===//
73 // MachineFunction implementation
74 //===---------------------------------------------------------------------===//
76 // Out of line virtual method.
77 MachineFunctionInfo::~MachineFunctionInfo() {}
79 void ilist_traits<MachineBasicBlock>::deleteNode(MachineBasicBlock *MBB) {
80 MBB->getParent()->DeleteMachineBasicBlock(MBB);
83 MachineFunction::MachineFunction(Function *F,
84 const TargetMachine &TM)
86 if (TM.getRegisterInfo())
87 RegInfo = new (Allocator.Allocate<MachineRegisterInfo>())
88 MachineRegisterInfo(*TM.getRegisterInfo());
92 FrameInfo = new (Allocator.Allocate<MachineFrameInfo>())
93 MachineFrameInfo(*TM.getFrameInfo());
94 ConstantPool = new (Allocator.Allocate<MachineConstantPool>())
95 MachineConstantPool(TM.getTargetData());
96 Alignment = TM.getTargetLowering()->getFunctionAlignment(F);
99 const TargetData &TD = *TM.getTargetData();
100 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
101 unsigned EntrySize = IsPic ? 4 : TD.getPointerSize();
102 unsigned TyAlignment = IsPic ?
103 TD.getABITypeAlignment(Type::getInt32Ty(F->getContext()))
104 : TD.getPointerABIAlignment();
105 JumpTableInfo = new (Allocator.Allocate<MachineJumpTableInfo>())
106 MachineJumpTableInfo(EntrySize, TyAlignment);
109 MachineFunction::~MachineFunction() {
111 InstructionRecycler.clear(Allocator);
112 BasicBlockRecycler.clear(Allocator);
114 RegInfo->~MachineRegisterInfo();
115 Allocator.Deallocate(RegInfo);
118 MFInfo->~MachineFunctionInfo();
119 Allocator.Deallocate(MFInfo);
121 FrameInfo->~MachineFrameInfo(); Allocator.Deallocate(FrameInfo);
122 ConstantPool->~MachineConstantPool(); Allocator.Deallocate(ConstantPool);
123 JumpTableInfo->~MachineJumpTableInfo(); Allocator.Deallocate(JumpTableInfo);
127 /// RenumberBlocks - This discards all of the MachineBasicBlock numbers and
128 /// recomputes them. This guarantees that the MBB numbers are sequential,
129 /// dense, and match the ordering of the blocks within the function. If a
130 /// specific MachineBasicBlock is specified, only that block and those after
131 /// it are renumbered.
132 void MachineFunction::RenumberBlocks(MachineBasicBlock *MBB) {
133 if (empty()) { MBBNumbering.clear(); return; }
134 MachineFunction::iterator MBBI, E = end();
140 // Figure out the block number this should have.
141 unsigned BlockNo = 0;
143 BlockNo = prior(MBBI)->getNumber()+1;
145 for (; MBBI != E; ++MBBI, ++BlockNo) {
146 if (MBBI->getNumber() != (int)BlockNo) {
147 // Remove use of the old number.
148 if (MBBI->getNumber() != -1) {
149 assert(MBBNumbering[MBBI->getNumber()] == &*MBBI &&
150 "MBB number mismatch!");
151 MBBNumbering[MBBI->getNumber()] = 0;
154 // If BlockNo is already taken, set that block's number to -1.
155 if (MBBNumbering[BlockNo])
156 MBBNumbering[BlockNo]->setNumber(-1);
158 MBBNumbering[BlockNo] = MBBI;
159 MBBI->setNumber(BlockNo);
163 // Okay, all the blocks are renumbered. If we have compactified the block
164 // numbering, shrink MBBNumbering now.
165 assert(BlockNo <= MBBNumbering.size() && "Mismatch!");
166 MBBNumbering.resize(BlockNo);
169 /// CreateMachineInstr - Allocate a new MachineInstr. Use this instead
170 /// of `new MachineInstr'.
173 MachineFunction::CreateMachineInstr(const TargetInstrDesc &TID,
174 DebugLoc DL, bool NoImp) {
175 return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
176 MachineInstr(TID, DL, NoImp);
179 /// CloneMachineInstr - Create a new MachineInstr which is a copy of the
180 /// 'Orig' instruction, identical in all ways except the the instruction
181 /// has no parent, prev, or next.
184 MachineFunction::CloneMachineInstr(const MachineInstr *Orig) {
185 return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
186 MachineInstr(*this, *Orig);
189 /// DeleteMachineInstr - Delete the given MachineInstr.
192 MachineFunction::DeleteMachineInstr(MachineInstr *MI) {
194 InstructionRecycler.Deallocate(Allocator, MI);
197 /// CreateMachineBasicBlock - Allocate a new MachineBasicBlock. Use this
198 /// instead of `new MachineBasicBlock'.
201 MachineFunction::CreateMachineBasicBlock(const BasicBlock *bb) {
202 return new (BasicBlockRecycler.Allocate<MachineBasicBlock>(Allocator))
203 MachineBasicBlock(*this, bb);
206 /// DeleteMachineBasicBlock - Delete the given MachineBasicBlock.
209 MachineFunction::DeleteMachineBasicBlock(MachineBasicBlock *MBB) {
210 assert(MBB->getParent() == this && "MBB parent mismatch!");
211 MBB->~MachineBasicBlock();
212 BasicBlockRecycler.Deallocate(Allocator, MBB);
216 MachineFunction::getMachineMemOperand(const Value *v, unsigned f,
217 int64_t o, uint64_t s,
218 unsigned base_alignment) {
219 return new (Allocator.Allocate<MachineMemOperand>())
220 MachineMemOperand(v, f, o, s, base_alignment);
224 MachineFunction::getMachineMemOperand(const MachineMemOperand *MMO,
225 int64_t Offset, uint64_t Size) {
226 return new (Allocator.Allocate<MachineMemOperand>())
227 MachineMemOperand(MMO->getValue(), MMO->getFlags(),
228 int64_t(uint64_t(MMO->getOffset()) +
230 Size, MMO->getBaseAlignment());
233 MachineInstr::mmo_iterator
234 MachineFunction::allocateMemRefsArray(unsigned long Num) {
235 return Allocator.Allocate<MachineMemOperand *>(Num);
238 std::pair<MachineInstr::mmo_iterator, MachineInstr::mmo_iterator>
239 MachineFunction::extractLoadMemRefs(MachineInstr::mmo_iterator Begin,
240 MachineInstr::mmo_iterator End) {
241 // Count the number of load mem refs.
243 for (MachineInstr::mmo_iterator I = Begin; I != End; ++I)
247 // Allocate a new array and populate it with the load information.
248 MachineInstr::mmo_iterator Result = allocateMemRefsArray(Num);
250 for (MachineInstr::mmo_iterator I = Begin; I != End; ++I) {
251 if ((*I)->isLoad()) {
252 if (!(*I)->isStore())
256 // Clone the MMO and unset the store flag.
257 MachineMemOperand *JustLoad =
258 getMachineMemOperand((*I)->getValue(),
259 (*I)->getFlags() & ~MachineMemOperand::MOStore,
260 (*I)->getOffset(), (*I)->getSize(),
261 (*I)->getBaseAlignment());
262 Result[Index] = JustLoad;
267 return std::make_pair(Result, Result + Num);
270 std::pair<MachineInstr::mmo_iterator, MachineInstr::mmo_iterator>
271 MachineFunction::extractStoreMemRefs(MachineInstr::mmo_iterator Begin,
272 MachineInstr::mmo_iterator End) {
273 // Count the number of load mem refs.
275 for (MachineInstr::mmo_iterator I = Begin; I != End; ++I)
279 // Allocate a new array and populate it with the store information.
280 MachineInstr::mmo_iterator Result = allocateMemRefsArray(Num);
282 for (MachineInstr::mmo_iterator I = Begin; I != End; ++I) {
283 if ((*I)->isStore()) {
288 // Clone the MMO and unset the load flag.
289 MachineMemOperand *JustStore =
290 getMachineMemOperand((*I)->getValue(),
291 (*I)->getFlags() & ~MachineMemOperand::MOLoad,
292 (*I)->getOffset(), (*I)->getSize(),
293 (*I)->getBaseAlignment());
294 Result[Index] = JustStore;
299 return std::make_pair(Result, Result + Num);
302 void MachineFunction::dump() const {
306 void MachineFunction::print(raw_ostream &OS) const {
307 OS << "# Machine code for " << Fn->getName() << "():\n";
309 // Print Frame Information
310 FrameInfo->print(*this, OS);
312 // Print JumpTable Information
313 JumpTableInfo->print(OS);
315 // Print Constant Pool
316 ConstantPool->print(OS);
318 const TargetRegisterInfo *TRI = getTarget().getRegisterInfo();
320 if (RegInfo && !RegInfo->livein_empty()) {
322 for (MachineRegisterInfo::livein_iterator
323 I = RegInfo->livein_begin(), E = RegInfo->livein_end(); I != E; ++I) {
325 OS << " " << TRI->getName(I->first);
327 OS << " Reg #" << I->first;
330 OS << " in VR#" << I->second << ' ';
334 if (RegInfo && !RegInfo->liveout_empty()) {
336 for (MachineRegisterInfo::liveout_iterator
337 I = RegInfo->liveout_begin(), E = RegInfo->liveout_end(); I != E; ++I)
339 OS << ' ' << TRI->getName(*I);
341 OS << " Reg #" << *I;
345 for (const_iterator BB = begin(), E = end(); BB != E; ++BB)
348 OS << "\n# End machine code for " << Fn->getName() << "().\n\n";
353 struct DOTGraphTraits<const MachineFunction*> : public DefaultDOTGraphTraits {
354 static std::string getGraphName(const MachineFunction *F) {
355 return "CFG for '" + F->getFunction()->getNameStr() + "' function";
358 static std::string getNodeLabel(const MachineBasicBlock *Node,
359 const MachineFunction *Graph,
361 if (ShortNames && Node->getBasicBlock() &&
362 !Node->getBasicBlock()->getName().empty())
363 return Node->getBasicBlock()->getNameStr() + ":";
367 raw_string_ostream OSS(OutStr);
370 OSS << Node->getNumber() << ':';
375 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
377 // Process string output to make it nicer...
378 for (unsigned i = 0; i != OutStr.length(); ++i)
379 if (OutStr[i] == '\n') { // Left justify
381 OutStr.insert(OutStr.begin()+i+1, 'l');
388 void MachineFunction::viewCFG() const
391 ViewGraph(this, "mf" + getFunction()->getNameStr());
393 errs() << "SelectionDAG::viewGraph is only available in debug builds on "
394 << "systems with Graphviz or gv!\n";
398 void MachineFunction::viewCFGOnly() const
401 ViewGraph(this, "mf" + getFunction()->getNameStr(), true);
403 errs() << "SelectionDAG::viewGraph is only available in debug builds on "
404 << "systems with Graphviz or gv!\n";
408 /// addLiveIn - Add the specified physical register as a live-in value and
409 /// create a corresponding virtual register for it.
410 unsigned MachineFunction::addLiveIn(unsigned PReg,
411 const TargetRegisterClass *RC) {
412 assert(RC->contains(PReg) && "Not the correct regclass!");
413 unsigned VReg = getRegInfo().createVirtualRegister(RC);
414 getRegInfo().addLiveIn(PReg, VReg);
418 /// getDebugLocTuple - Get the DebugLocTuple for a given DebugLoc object.
419 DebugLocTuple MachineFunction::getDebugLocTuple(DebugLoc DL) const {
420 unsigned Idx = DL.getIndex();
421 assert(Idx < DebugLocInfo.DebugLocations.size() &&
422 "Invalid index into debug locations!");
423 return DebugLocInfo.DebugLocations[Idx];
426 //===----------------------------------------------------------------------===//
427 // MachineFrameInfo implementation
428 //===----------------------------------------------------------------------===//
430 /// CreateFixedObject - Create a new object at a fixed location on the stack.
431 /// All fixed objects should be created before other objects are created for
432 /// efficiency. By default, fixed objects are immutable. This returns an
433 /// index with a negative value.
435 int MachineFrameInfo::CreateFixedObject(uint64_t Size, int64_t SPOffset,
437 assert(Size != 0 && "Cannot allocate zero size fixed stack objects!");
438 Objects.insert(Objects.begin(), StackObject(Size, 1, SPOffset, Immutable));
439 return -++NumFixedObjects;
444 MachineFrameInfo::getPristineRegs(const MachineBasicBlock *MBB) const {
445 assert(MBB && "MBB must be valid");
446 const MachineFunction *MF = MBB->getParent();
447 assert(MF && "MBB must be part of a MachineFunction");
448 const TargetMachine &TM = MF->getTarget();
449 const TargetRegisterInfo *TRI = TM.getRegisterInfo();
450 BitVector BV(TRI->getNumRegs());
452 // Before CSI is calculated, no registers are considered pristine. They can be
453 // freely used and PEI will make sure they are saved.
454 if (!isCalleeSavedInfoValid())
457 for (const unsigned *CSR = TRI->getCalleeSavedRegs(MF); CSR && *CSR; ++CSR)
460 // The entry MBB always has all CSRs pristine.
461 if (MBB == &MF->front())
464 // On other MBBs the saved CSRs are not pristine.
465 const std::vector<CalleeSavedInfo> &CSI = getCalleeSavedInfo();
466 for (std::vector<CalleeSavedInfo>::const_iterator I = CSI.begin(),
467 E = CSI.end(); I != E; ++I)
468 BV.reset(I->getReg());
474 void MachineFrameInfo::print(const MachineFunction &MF, raw_ostream &OS) const{
475 const TargetFrameInfo *FI = MF.getTarget().getFrameInfo();
476 int ValOffset = (FI ? FI->getOffsetOfLocalArea() : 0);
478 for (unsigned i = 0, e = Objects.size(); i != e; ++i) {
479 const StackObject &SO = Objects[i];
480 OS << " <fi#" << (int)(i-NumFixedObjects) << ">: ";
481 if (SO.Size == ~0ULL) {
486 OS << "variable sized";
488 OS << "size is " << SO.Size << " byte" << (SO.Size != 1 ? "s," : ",");
489 OS << " alignment is " << SO.Alignment << " byte"
490 << (SO.Alignment != 1 ? "s," : ",");
492 if (i < NumFixedObjects)
494 if (i < NumFixedObjects || SO.SPOffset != -1) {
495 int64_t Off = SO.SPOffset - ValOffset;
496 OS << " at location [SP";
506 if (HasVarSizedObjects)
507 OS << " Stack frame contains variable sized objects\n";
510 void MachineFrameInfo::dump(const MachineFunction &MF) const {
514 //===----------------------------------------------------------------------===//
515 // MachineJumpTableInfo implementation
516 //===----------------------------------------------------------------------===//
518 /// getJumpTableIndex - Create a new jump table entry in the jump table info
519 /// or return an existing one.
521 unsigned MachineJumpTableInfo::getJumpTableIndex(
522 const std::vector<MachineBasicBlock*> &DestBBs) {
523 assert(!DestBBs.empty() && "Cannot create an empty jump table!");
524 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i)
525 if (JumpTables[i].MBBs == DestBBs)
528 JumpTables.push_back(MachineJumpTableEntry(DestBBs));
529 return JumpTables.size()-1;
532 /// ReplaceMBBInJumpTables - If Old is the target of any jump tables, update
533 /// the jump tables to branch to New instead.
535 MachineJumpTableInfo::ReplaceMBBInJumpTables(MachineBasicBlock *Old,
536 MachineBasicBlock *New) {
537 assert(Old != New && "Not making a change?");
538 bool MadeChange = false;
539 for (size_t i = 0, e = JumpTables.size(); i != e; ++i) {
540 MachineJumpTableEntry &JTE = JumpTables[i];
541 for (size_t j = 0, e = JTE.MBBs.size(); j != e; ++j)
542 if (JTE.MBBs[j] == Old) {
550 void MachineJumpTableInfo::print(raw_ostream &OS) const {
551 // FIXME: this is lame, maybe we could print out the MBB numbers or something
552 // like {1, 2, 4, 5, 3, 0}
553 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i) {
554 OS << " <jt#" << i << "> has " << JumpTables[i].MBBs.size()
559 void MachineJumpTableInfo::dump() const { print(errs()); }
562 //===----------------------------------------------------------------------===//
563 // MachineConstantPool implementation
564 //===----------------------------------------------------------------------===//
566 const Type *MachineConstantPoolEntry::getType() const {
567 if (isMachineConstantPoolEntry())
568 return Val.MachineCPVal->getType();
569 return Val.ConstVal->getType();
573 unsigned MachineConstantPoolEntry::getRelocationInfo() const {
574 if (isMachineConstantPoolEntry())
575 return Val.MachineCPVal->getRelocationInfo();
576 return Val.ConstVal->getRelocationInfo();
579 MachineConstantPool::~MachineConstantPool() {
580 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
581 if (Constants[i].isMachineConstantPoolEntry())
582 delete Constants[i].Val.MachineCPVal;
585 /// getConstantPoolIndex - Create a new entry in the constant pool or return
586 /// an existing one. User must specify the log2 of the minimum required
587 /// alignment for the object.
589 unsigned MachineConstantPool::getConstantPoolIndex(Constant *C,
590 unsigned Alignment) {
591 assert(Alignment && "Alignment must be specified!");
592 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
594 // Check to see if we already have this constant.
596 // FIXME, this could be made much more efficient for large constant pools.
597 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
598 if (Constants[i].Val.ConstVal == C &&
599 (Constants[i].getAlignment() & (Alignment - 1)) == 0)
602 Constants.push_back(MachineConstantPoolEntry(C, Alignment));
603 return Constants.size()-1;
606 unsigned MachineConstantPool::getConstantPoolIndex(MachineConstantPoolValue *V,
607 unsigned Alignment) {
608 assert(Alignment && "Alignment must be specified!");
609 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
611 // Check to see if we already have this constant.
613 // FIXME, this could be made much more efficient for large constant pools.
614 int Idx = V->getExistingMachineCPValue(this, Alignment);
616 return (unsigned)Idx;
618 Constants.push_back(MachineConstantPoolEntry(V, Alignment));
619 return Constants.size()-1;
622 void MachineConstantPool::print(raw_ostream &OS) const {
623 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
624 OS << " <cp#" << i << "> is";
625 if (Constants[i].isMachineConstantPoolEntry())
626 Constants[i].Val.MachineCPVal->print(OS);
628 OS << *(Value*)Constants[i].Val.ConstVal;
629 OS << " , alignment=" << Constants[i].getAlignment();
634 void MachineConstantPool::dump() const { print(errs()); }