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/MachineFunctionPass.h"
23 #include "llvm/CodeGen/MachineFrameInfo.h"
24 #include "llvm/CodeGen/MachineInstr.h"
25 #include "llvm/CodeGen/MachineJumpTableInfo.h"
26 #include "llvm/CodeGen/MachineRegisterInfo.h"
27 #include "llvm/CodeGen/Passes.h"
28 #include "llvm/Target/TargetData.h"
29 #include "llvm/Target/TargetLowering.h"
30 #include "llvm/Target/TargetMachine.h"
31 #include "llvm/Target/TargetFrameInfo.h"
32 #include "llvm/Support/Compiler.h"
33 #include "llvm/Support/GraphWriter.h"
34 #include "llvm/Support/raw_ostream.h"
40 struct VISIBILITY_HIDDEN Printer : public MachineFunctionPass {
44 const std::string Banner;
46 Printer (std::ostream *os, const std::string &banner)
47 : MachineFunctionPass(&ID), OS(os), Banner(banner) {}
49 const char *getPassName() const { return "MachineFunction Printer"; }
51 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
53 MachineFunctionPass::getAnalysisUsage(AU);
56 bool runOnMachineFunction(MachineFunction &MF) {
65 /// Returns a newly-created MachineFunction Printer pass. The default banner is
68 FunctionPass *llvm::createMachineFunctionPrinterPass(std::ostream *OS,
69 const std::string &Banner){
70 return new Printer(OS, Banner);
73 //===---------------------------------------------------------------------===//
74 // MachineFunction implementation
75 //===---------------------------------------------------------------------===//
77 void ilist_traits<MachineBasicBlock>::deleteNode(MachineBasicBlock *MBB) {
78 MBB->getParent()->DeleteMachineBasicBlock(MBB);
81 MachineFunction::MachineFunction(Function *F,
82 const TargetMachine &TM)
84 if (TM.getRegisterInfo())
85 RegInfo = new (Allocator.Allocate<MachineRegisterInfo>())
86 MachineRegisterInfo(*TM.getRegisterInfo());
90 FrameInfo = new (Allocator.Allocate<MachineFrameInfo>())
91 MachineFrameInfo(*TM.getFrameInfo());
92 ConstantPool = new (Allocator.Allocate<MachineConstantPool>())
93 MachineConstantPool(TM.getTargetData());
94 Alignment = TM.getTargetLowering()->getFunctionAlignment(F);
100 const TargetData &TD = *TM.getTargetData();
101 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
102 unsigned EntrySize = IsPic ? 4 : TD.getPointerSize();
103 unsigned TyAlignment = IsPic ? TD.getABITypeAlignment(Type::Int32Ty)
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) {
193 // Clear the instructions memoperands. This must be done manually because
194 // the instruction's parent pointer is now null, so it can't properly
195 // deallocate them on its own.
196 MI->clearMemOperands(*this);
199 InstructionRecycler.Deallocate(Allocator, MI);
202 /// CreateMachineBasicBlock - Allocate a new MachineBasicBlock. Use this
203 /// instead of `new MachineBasicBlock'.
206 MachineFunction::CreateMachineBasicBlock(const BasicBlock *bb) {
207 return new (BasicBlockRecycler.Allocate<MachineBasicBlock>(Allocator))
208 MachineBasicBlock(*this, bb);
211 /// DeleteMachineBasicBlock - Delete the given MachineBasicBlock.
214 MachineFunction::DeleteMachineBasicBlock(MachineBasicBlock *MBB) {
215 assert(MBB->getParent() == this && "MBB parent mismatch!");
216 MBB->~MachineBasicBlock();
217 BasicBlockRecycler.Deallocate(Allocator, MBB);
220 void MachineFunction::dump() const {
221 print(*cerr.stream());
224 void MachineFunction::print(std::ostream &OS,
225 const PrefixPrinter &prefix) const {
226 OS << "# Machine code for " << Fn->getNameStr () << "():\n";
228 // Print Frame Information
229 FrameInfo->print(*this, OS);
231 // Print JumpTable Information
232 JumpTableInfo->print(OS);
234 // Print Constant Pool
236 raw_os_ostream OSS(OS);
237 ConstantPool->print(OSS);
240 const TargetRegisterInfo *TRI = getTarget().getRegisterInfo();
242 if (RegInfo && !RegInfo->livein_empty()) {
244 for (MachineRegisterInfo::livein_iterator
245 I = RegInfo->livein_begin(), E = RegInfo->livein_end(); I != E; ++I) {
247 OS << " " << TRI->getName(I->first);
249 OS << " Reg #" << I->first;
252 OS << " in VR#" << I->second << " ";
256 if (RegInfo && !RegInfo->liveout_empty()) {
258 for (MachineRegisterInfo::liveout_iterator
259 I = RegInfo->liveout_begin(), E = RegInfo->liveout_end(); I != E; ++I)
261 OS << " " << TRI->getName(*I);
263 OS << " Reg #" << *I;
267 for (const_iterator BB = begin(); BB != end(); ++BB) {
269 BB->print(OS, prefix);
272 OS << "\n# End machine code for " << Fn->getNameStr () << "().\n\n";
277 struct DOTGraphTraits<const MachineFunction*> : public DefaultDOTGraphTraits {
278 static std::string getGraphName(const MachineFunction *F) {
279 return "CFG for '" + F->getFunction()->getNameStr() + "' function";
282 static std::string getNodeLabel(const MachineBasicBlock *Node,
283 const MachineFunction *Graph,
285 if (ShortNames && Node->getBasicBlock() &&
286 !Node->getBasicBlock()->getName().empty())
287 return Node->getBasicBlock()->getNameStr() + ":";
289 std::ostringstream Out;
291 Out << Node->getNumber() << ':';
297 std::string OutStr = Out.str();
298 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
300 // Process string output to make it nicer...
301 for (unsigned i = 0; i != OutStr.length(); ++i)
302 if (OutStr[i] == '\n') { // Left justify
304 OutStr.insert(OutStr.begin()+i+1, 'l');
311 void MachineFunction::viewCFG() const
314 ViewGraph(this, "mf" + getFunction()->getNameStr());
316 cerr << "SelectionDAG::viewGraph is only available in debug builds on "
317 << "systems with Graphviz or gv!\n";
321 void MachineFunction::viewCFGOnly() const
324 ViewGraph(this, "mf" + getFunction()->getNameStr(), true);
326 cerr << "SelectionDAG::viewGraph is only available in debug builds on "
327 << "systems with Graphviz or gv!\n";
331 /// addLiveIn - Add the specified physical register as a live-in value and
332 /// create a corresponding virtual register for it.
333 unsigned MachineFunction::addLiveIn(unsigned PReg,
334 const TargetRegisterClass *RC) {
335 assert(RC->contains(PReg) && "Not the correct regclass!");
336 unsigned VReg = getRegInfo().createVirtualRegister(RC);
337 getRegInfo().addLiveIn(PReg, VReg);
341 /// getOrCreateDebugLocID - Look up the DebugLocTuple index with the given
342 /// source file, line, and column. If none currently exists, create a new
343 /// DebugLocTuple, and insert it into the DebugIdMap.
344 unsigned MachineFunction::getOrCreateDebugLocID(GlobalVariable *CompileUnit,
345 unsigned Line, unsigned Col) {
346 DebugLocTuple Tuple(CompileUnit, Line, Col);
347 DenseMap<DebugLocTuple, unsigned>::iterator II
348 = DebugLocInfo.DebugIdMap.find(Tuple);
349 if (II != DebugLocInfo.DebugIdMap.end())
352 unsigned Id = DebugLocInfo.DebugLocations.size();
353 DebugLocInfo.DebugLocations.push_back(Tuple);
354 DebugLocInfo.DebugIdMap[Tuple] = Id;
358 /// getDebugLocTuple - Get the DebugLocTuple for a given DebugLoc object.
359 DebugLocTuple MachineFunction::getDebugLocTuple(DebugLoc DL) const {
360 unsigned Idx = DL.getIndex();
361 assert(Idx < DebugLocInfo.DebugLocations.size() &&
362 "Invalid index into debug locations!");
363 return DebugLocInfo.DebugLocations[Idx];
366 //===----------------------------------------------------------------------===//
367 // MachineFrameInfo implementation
368 //===----------------------------------------------------------------------===//
370 /// CreateFixedObject - Create a new object at a fixed location on the stack.
371 /// All fixed objects should be created before other objects are created for
372 /// efficiency. By default, fixed objects are immutable. This returns an
373 /// index with a negative value.
375 int MachineFrameInfo::CreateFixedObject(uint64_t Size, int64_t SPOffset,
377 assert(Size != 0 && "Cannot allocate zero size fixed stack objects!");
378 Objects.insert(Objects.begin(), StackObject(Size, 1, SPOffset, Immutable));
379 return -++NumFixedObjects;
384 MachineFrameInfo::getPristineRegs(const MachineBasicBlock *MBB) const {
385 assert(MBB && "MBB must be valid");
386 const MachineFunction *MF = MBB->getParent();
387 assert(MF && "MBB must be part of a MachineFunction");
388 const TargetMachine &TM = MF->getTarget();
389 const TargetRegisterInfo *TRI = TM.getRegisterInfo();
390 BitVector BV(TRI->getNumRegs());
392 // Before CSI is calculated, no registers are considered pristine. They can be
393 // freely used and PEI will make sure they are saved.
394 if (!isCalleeSavedInfoValid())
397 for (const unsigned *CSR = TRI->getCalleeSavedRegs(MF); CSR && *CSR; ++CSR)
400 // The entry MBB always has all CSRs pristine.
401 if (MBB == &MF->front())
404 // On other MBBs the saved CSRs are not pristine.
405 const std::vector<CalleeSavedInfo> &CSI = getCalleeSavedInfo();
406 for (std::vector<CalleeSavedInfo>::const_iterator I = CSI.begin(),
407 E = CSI.end(); I != E; ++I)
408 BV.reset(I->getReg());
414 void MachineFrameInfo::print(const MachineFunction &MF, std::ostream &OS) const{
415 const TargetFrameInfo *FI = MF.getTarget().getFrameInfo();
416 int ValOffset = (FI ? FI->getOffsetOfLocalArea() : 0);
418 for (unsigned i = 0, e = Objects.size(); i != e; ++i) {
419 const StackObject &SO = Objects[i];
420 OS << " <fi#" << (int)(i-NumFixedObjects) << ">: ";
421 if (SO.Size == ~0ULL) {
426 OS << "variable sized";
428 OS << "size is " << SO.Size << " byte" << (SO.Size != 1 ? "s," : ",");
429 OS << " alignment is " << SO.Alignment << " byte"
430 << (SO.Alignment != 1 ? "s," : ",");
432 if (i < NumFixedObjects)
434 if (i < NumFixedObjects || SO.SPOffset != -1) {
435 int64_t Off = SO.SPOffset - ValOffset;
436 OS << " at location [SP";
446 if (HasVarSizedObjects)
447 OS << " Stack frame contains variable sized objects\n";
450 void MachineFrameInfo::dump(const MachineFunction &MF) const {
451 print(MF, *cerr.stream());
454 //===----------------------------------------------------------------------===//
455 // MachineJumpTableInfo implementation
456 //===----------------------------------------------------------------------===//
458 /// getJumpTableIndex - Create a new jump table entry in the jump table info
459 /// or return an existing one.
461 unsigned MachineJumpTableInfo::getJumpTableIndex(
462 const std::vector<MachineBasicBlock*> &DestBBs) {
463 assert(!DestBBs.empty() && "Cannot create an empty jump table!");
464 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i)
465 if (JumpTables[i].MBBs == DestBBs)
468 JumpTables.push_back(MachineJumpTableEntry(DestBBs));
469 return JumpTables.size()-1;
472 /// ReplaceMBBInJumpTables - If Old is the target of any jump tables, update
473 /// the jump tables to branch to New instead.
475 MachineJumpTableInfo::ReplaceMBBInJumpTables(MachineBasicBlock *Old,
476 MachineBasicBlock *New) {
477 assert(Old != New && "Not making a change?");
478 bool MadeChange = false;
479 for (size_t i = 0, e = JumpTables.size(); i != e; ++i) {
480 MachineJumpTableEntry &JTE = JumpTables[i];
481 for (size_t j = 0, e = JTE.MBBs.size(); j != e; ++j)
482 if (JTE.MBBs[j] == Old) {
490 void MachineJumpTableInfo::print(std::ostream &OS) const {
491 // FIXME: this is lame, maybe we could print out the MBB numbers or something
492 // like {1, 2, 4, 5, 3, 0}
493 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i) {
494 OS << " <jt#" << i << "> has " << JumpTables[i].MBBs.size()
499 void MachineJumpTableInfo::dump() const { print(*cerr.stream()); }
502 //===----------------------------------------------------------------------===//
503 // MachineConstantPool implementation
504 //===----------------------------------------------------------------------===//
506 const Type *MachineConstantPoolEntry::getType() const {
507 if (isMachineConstantPoolEntry())
508 return Val.MachineCPVal->getType();
509 return Val.ConstVal->getType();
513 unsigned MachineConstantPoolEntry::getRelocationInfo() const {
514 if (isMachineConstantPoolEntry())
515 return Val.MachineCPVal->getRelocationInfo();
516 return Val.ConstVal->getRelocationInfo();
519 MachineConstantPool::~MachineConstantPool() {
520 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
521 if (Constants[i].isMachineConstantPoolEntry())
522 delete Constants[i].Val.MachineCPVal;
525 /// getConstantPoolIndex - Create a new entry in the constant pool or return
526 /// an existing one. User must specify the log2 of the minimum required
527 /// alignment for the object.
529 unsigned MachineConstantPool::getConstantPoolIndex(Constant *C,
530 unsigned Alignment) {
531 assert(Alignment && "Alignment must be specified!");
532 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
534 // Check to see if we already have this constant.
536 // FIXME, this could be made much more efficient for large constant pools.
537 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
538 if (Constants[i].Val.ConstVal == C &&
539 (Constants[i].getAlignment() & (Alignment - 1)) == 0)
542 Constants.push_back(MachineConstantPoolEntry(C, Alignment));
543 return Constants.size()-1;
546 unsigned MachineConstantPool::getConstantPoolIndex(MachineConstantPoolValue *V,
547 unsigned Alignment) {
548 assert(Alignment && "Alignment must be specified!");
549 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
551 // Check to see if we already have this constant.
553 // FIXME, this could be made much more efficient for large constant pools.
554 int Idx = V->getExistingMachineCPValue(this, Alignment);
556 return (unsigned)Idx;
558 Constants.push_back(MachineConstantPoolEntry(V, Alignment));
559 return Constants.size()-1;
562 void MachineConstantPool::print(raw_ostream &OS) const {
563 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
564 OS << " <cp#" << i << "> is";
565 if (Constants[i].isMachineConstantPoolEntry())
566 Constants[i].Val.MachineCPVal->print(OS);
568 OS << *(Value*)Constants[i].Val.ConstVal;
569 OS << " , alignment=" << Constants[i].getAlignment();
574 void MachineConstantPool::dump() const { print(errs()); }