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/CodeGen/MachineConstantPool.h"
18 #include "llvm/CodeGen/MachineFunctionPass.h"
19 #include "llvm/CodeGen/MachineFrameInfo.h"
20 #include "llvm/CodeGen/MachineInstr.h"
21 #include "llvm/CodeGen/MachineJumpTableInfo.h"
22 #include "llvm/CodeGen/MachineRegisterInfo.h"
23 #include "llvm/CodeGen/Passes.h"
24 #include "llvm/Target/TargetData.h"
25 #include "llvm/Target/TargetLowering.h"
26 #include "llvm/Target/TargetMachine.h"
27 #include "llvm/Target/TargetFrameInfo.h"
28 #include "llvm/Function.h"
29 #include "llvm/Instructions.h"
30 #include "llvm/Support/Compiler.h"
31 #include "llvm/Support/GraphWriter.h"
32 #include "llvm/Support/LeakDetector.h"
33 #include "llvm/ADT/STLExtras.h"
34 #include "llvm/Config/config.h"
39 static AnnotationID MF_AID(
40 AnnotationManager::getID("CodeGen::MachineCodeForFunction"));
42 // Out of line virtual function to home classes.
43 void MachineFunctionPass::virtfn() {}
46 struct VISIBILITY_HIDDEN Printer : public MachineFunctionPass {
50 const std::string Banner;
52 Printer (std::ostream *_OS, const std::string &_Banner)
53 : MachineFunctionPass((intptr_t)&ID), OS (_OS), Banner (_Banner) { }
55 const char *getPassName() const { return "MachineFunction Printer"; }
57 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
61 bool runOnMachineFunction(MachineFunction &MF) {
70 /// Returns a newly-created MachineFunction Printer pass. The default output
71 /// stream is std::cerr; the default banner is empty.
73 FunctionPass *llvm::createMachineFunctionPrinterPass(std::ostream *OS,
74 const std::string &Banner){
75 return new Printer(OS, Banner);
79 struct VISIBILITY_HIDDEN Deleter : public MachineFunctionPass {
81 Deleter() : MachineFunctionPass((intptr_t)&ID) {}
83 const char *getPassName() const { return "Machine Code Deleter"; }
85 bool runOnMachineFunction(MachineFunction &MF) {
86 // Delete the annotation from the function now.
87 MachineFunction::destruct(MF.getFunction());
94 /// MachineCodeDeletion Pass - This pass deletes all of the machine code for
95 /// the current function, which should happen after the function has been
96 /// emitted to a .s file or to memory.
97 FunctionPass *llvm::createMachineCodeDeleter() {
103 //===---------------------------------------------------------------------===//
104 // MachineFunction implementation
105 //===---------------------------------------------------------------------===//
107 MachineBasicBlock* ilist_traits<MachineBasicBlock>::createSentinel() {
108 MachineBasicBlock* dummy = new MachineBasicBlock();
109 LeakDetector::removeGarbageObject(dummy);
113 void ilist_traits<MachineBasicBlock>::transferNodesFromList(
114 iplist<MachineBasicBlock, ilist_traits<MachineBasicBlock> >& toList,
115 ilist_iterator<MachineBasicBlock> first,
116 ilist_iterator<MachineBasicBlock> last) {
117 // If splicing withing the same function, no change.
118 if (Parent == toList.Parent) return;
120 for (; first != last; ++first)
121 first->setParent(toList.Parent);
124 MachineFunction::MachineFunction(const Function *F,
125 const TargetMachine &TM)
126 : Annotation(MF_AID), Fn(F), Target(TM) {
127 RegInfo = new MachineRegisterInfo(*TM.getRegisterInfo());
129 FrameInfo = new MachineFrameInfo(*TM.getFrameInfo());
130 ConstantPool = new MachineConstantPool(TM.getTargetData());
132 // Set up jump table.
133 const TargetData &TD = *TM.getTargetData();
134 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
135 unsigned EntrySize = IsPic ? 4 : TD.getPointerSize();
136 unsigned Alignment = IsPic ? TD.getABITypeAlignment(Type::Int32Ty)
137 : TD.getPointerABIAlignment();
138 JumpTableInfo = new MachineJumpTableInfo(EntrySize, Alignment);
140 BasicBlocks.Parent = this;
143 MachineFunction::~MachineFunction() {
149 delete JumpTableInfo;
153 /// RenumberBlocks - This discards all of the MachineBasicBlock numbers and
154 /// recomputes them. This guarantees that the MBB numbers are sequential,
155 /// dense, and match the ordering of the blocks within the function. If a
156 /// specific MachineBasicBlock is specified, only that block and those after
157 /// it are renumbered.
158 void MachineFunction::RenumberBlocks(MachineBasicBlock *MBB) {
159 if (empty()) { MBBNumbering.clear(); return; }
160 MachineFunction::iterator MBBI, E = end();
166 // Figure out the block number this should have.
167 unsigned BlockNo = 0;
169 BlockNo = prior(MBBI)->getNumber()+1;
171 for (; MBBI != E; ++MBBI, ++BlockNo) {
172 if (MBBI->getNumber() != (int)BlockNo) {
173 // Remove use of the old number.
174 if (MBBI->getNumber() != -1) {
175 assert(MBBNumbering[MBBI->getNumber()] == &*MBBI &&
176 "MBB number mismatch!");
177 MBBNumbering[MBBI->getNumber()] = 0;
180 // If BlockNo is already taken, set that block's number to -1.
181 if (MBBNumbering[BlockNo])
182 MBBNumbering[BlockNo]->setNumber(-1);
184 MBBNumbering[BlockNo] = MBBI;
185 MBBI->setNumber(BlockNo);
189 // Okay, all the blocks are renumbered. If we have compactified the block
190 // numbering, shrink MBBNumbering now.
191 assert(BlockNo <= MBBNumbering.size() && "Mismatch!");
192 MBBNumbering.resize(BlockNo);
196 void MachineFunction::dump() const { print(*cerr.stream()); }
198 void MachineFunction::print(std::ostream &OS) const {
199 OS << "# Machine code for " << Fn->getName () << "():\n";
201 // Print Frame Information
202 getFrameInfo()->print(*this, OS);
204 // Print JumpTable Information
205 getJumpTableInfo()->print(OS);
207 // Print Constant Pool
208 getConstantPool()->print(OS);
210 const TargetRegisterInfo *TRI = getTarget().getRegisterInfo();
212 if (!RegInfo->livein_empty()) {
214 for (MachineRegisterInfo::livein_iterator
215 I = RegInfo->livein_begin(), E = RegInfo->livein_end(); I != E; ++I) {
217 OS << " " << TRI->getName(I->first);
219 OS << " Reg #" << I->first;
222 OS << " in VR#" << I->second << " ";
226 if (!RegInfo->liveout_empty()) {
228 for (MachineRegisterInfo::liveout_iterator
229 I = RegInfo->liveout_begin(), E = RegInfo->liveout_end(); I != E; ++I)
231 OS << " " << TRI->getName(*I);
233 OS << " Reg #" << *I;
237 for (const_iterator BB = begin(); BB != end(); ++BB)
240 OS << "\n# End machine code for " << Fn->getName () << "().\n\n";
243 /// CFGOnly flag - This is used to control whether or not the CFG graph printer
244 /// prints out the contents of basic blocks or not. This is acceptable because
245 /// this code is only really used for debugging purposes.
247 static bool CFGOnly = false;
251 struct DOTGraphTraits<const MachineFunction*> : public DefaultDOTGraphTraits {
252 static std::string getGraphName(const MachineFunction *F) {
253 return "CFG for '" + F->getFunction()->getName() + "' function";
256 static std::string getNodeLabel(const MachineBasicBlock *Node,
257 const MachineFunction *Graph) {
258 if (CFGOnly && Node->getBasicBlock() &&
259 !Node->getBasicBlock()->getName().empty())
260 return Node->getBasicBlock()->getName() + ":";
262 std::ostringstream Out;
264 Out << Node->getNumber() << ':';
270 std::string OutStr = Out.str();
271 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
273 // Process string output to make it nicer...
274 for (unsigned i = 0; i != OutStr.length(); ++i)
275 if (OutStr[i] == '\n') { // Left justify
277 OutStr.insert(OutStr.begin()+i+1, 'l');
284 void MachineFunction::viewCFG() const
287 ViewGraph(this, "mf" + getFunction()->getName());
289 cerr << "SelectionDAG::viewGraph is only available in debug builds on "
290 << "systems with Graphviz or gv!\n";
294 void MachineFunction::viewCFGOnly() const
301 // The next two methods are used to construct and to retrieve
302 // the MachineCodeForFunction object for the given function.
303 // construct() -- Allocates and initializes for a given function and target
304 // get() -- Returns a handle to the object.
305 // This should not be called before "construct()"
306 // for a given Function.
309 MachineFunction::construct(const Function *Fn, const TargetMachine &Tar)
311 assert(Fn->getAnnotation(MF_AID) == 0 &&
312 "Object already exists for this function!");
313 MachineFunction* mcInfo = new MachineFunction(Fn, Tar);
314 Fn->addAnnotation(mcInfo);
318 void MachineFunction::destruct(const Function *Fn) {
319 bool Deleted = Fn->deleteAnnotation(MF_AID);
320 assert(Deleted && "Machine code did not exist for function!");
321 Deleted = Deleted; // silence warning when no assertions.
324 MachineFunction& MachineFunction::get(const Function *F)
326 MachineFunction *mc = (MachineFunction*)F->getAnnotation(MF_AID);
327 assert(mc && "Call construct() method first to allocate the object");
331 //===----------------------------------------------------------------------===//
332 // MachineFrameInfo implementation
333 //===----------------------------------------------------------------------===//
335 /// CreateFixedObject - Create a new object at a fixed location on the stack.
336 /// All fixed objects should be created before other objects are created for
337 /// efficiency. By default, fixed objects are immutable. This returns an
338 /// index with a negative value.
340 int MachineFrameInfo::CreateFixedObject(uint64_t Size, int64_t SPOffset,
342 assert(Size != 0 && "Cannot allocate zero size fixed stack objects!");
343 Objects.insert(Objects.begin(), StackObject(Size, 1, SPOffset, Immutable));
344 return -++NumFixedObjects;
348 void MachineFrameInfo::print(const MachineFunction &MF, std::ostream &OS) const{
349 int ValOffset = MF.getTarget().getFrameInfo()->getOffsetOfLocalArea();
351 for (unsigned i = 0, e = Objects.size(); i != e; ++i) {
352 const StackObject &SO = Objects[i];
353 OS << " <fi #" << (int)(i-NumFixedObjects) << ">: ";
354 if (SO.Size == ~0ULL) {
359 OS << "variable sized";
361 OS << "size is " << SO.Size << " byte" << (SO.Size != 1 ? "s," : ",");
362 OS << " alignment is " << SO.Alignment << " byte"
363 << (SO.Alignment != 1 ? "s," : ",");
365 if (i < NumFixedObjects)
367 if (i < NumFixedObjects || SO.SPOffset != -1) {
368 int64_t Off = SO.SPOffset - ValOffset;
369 OS << " at location [SP";
379 if (HasVarSizedObjects)
380 OS << " Stack frame contains variable sized objects\n";
383 void MachineFrameInfo::dump(const MachineFunction &MF) const {
384 print(MF, *cerr.stream());
388 //===----------------------------------------------------------------------===//
389 // MachineJumpTableInfo implementation
390 //===----------------------------------------------------------------------===//
392 /// getJumpTableIndex - Create a new jump table entry in the jump table info
393 /// or return an existing one.
395 unsigned MachineJumpTableInfo::getJumpTableIndex(
396 const std::vector<MachineBasicBlock*> &DestBBs) {
397 assert(!DestBBs.empty() && "Cannot create an empty jump table!");
398 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i)
399 if (JumpTables[i].MBBs == DestBBs)
402 JumpTables.push_back(MachineJumpTableEntry(DestBBs));
403 return JumpTables.size()-1;
407 void MachineJumpTableInfo::print(std::ostream &OS) const {
408 // FIXME: this is lame, maybe we could print out the MBB numbers or something
409 // like {1, 2, 4, 5, 3, 0}
410 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i) {
411 OS << " <jt #" << i << "> has " << JumpTables[i].MBBs.size()
416 void MachineJumpTableInfo::dump() const { print(*cerr.stream()); }
419 //===----------------------------------------------------------------------===//
420 // MachineConstantPool implementation
421 //===----------------------------------------------------------------------===//
423 const Type *MachineConstantPoolEntry::getType() const {
424 if (isMachineConstantPoolEntry())
425 return Val.MachineCPVal->getType();
426 return Val.ConstVal->getType();
429 MachineConstantPool::~MachineConstantPool() {
430 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
431 if (Constants[i].isMachineConstantPoolEntry())
432 delete Constants[i].Val.MachineCPVal;
435 /// getConstantPoolIndex - Create a new entry in the constant pool or return
436 /// an existing one. User must specify an alignment in bytes for the object.
438 unsigned MachineConstantPool::getConstantPoolIndex(Constant *C,
439 unsigned Alignment) {
440 assert(Alignment && "Alignment must be specified!");
441 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
443 // Check to see if we already have this constant.
445 // FIXME, this could be made much more efficient for large constant pools.
446 unsigned AlignMask = (1 << Alignment)-1;
447 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
448 if (Constants[i].Val.ConstVal == C && (Constants[i].Offset & AlignMask)== 0)
452 if (!Constants.empty()) {
453 Offset = Constants.back().getOffset();
454 Offset += TD->getABITypeSize(Constants.back().getType());
455 Offset = (Offset+AlignMask)&~AlignMask;
458 Constants.push_back(MachineConstantPoolEntry(C, Offset));
459 return Constants.size()-1;
462 unsigned MachineConstantPool::getConstantPoolIndex(MachineConstantPoolValue *V,
463 unsigned Alignment) {
464 assert(Alignment && "Alignment must be specified!");
465 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
467 // Check to see if we already have this constant.
469 // FIXME, this could be made much more efficient for large constant pools.
470 unsigned AlignMask = (1 << Alignment)-1;
471 int Idx = V->getExistingMachineCPValue(this, Alignment);
473 return (unsigned)Idx;
476 if (!Constants.empty()) {
477 Offset = Constants.back().getOffset();
478 Offset += TD->getABITypeSize(Constants.back().getType());
479 Offset = (Offset+AlignMask)&~AlignMask;
482 Constants.push_back(MachineConstantPoolEntry(V, Offset));
483 return Constants.size()-1;
487 void MachineConstantPool::print(std::ostream &OS) const {
488 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
489 OS << " <cp #" << i << "> is";
490 if (Constants[i].isMachineConstantPoolEntry())
491 Constants[i].Val.MachineCPVal->print(OS);
493 OS << *(Value*)Constants[i].Val.ConstVal;
494 OS << " , offset=" << Constants[i].getOffset();
499 void MachineConstantPool::dump() const { print(*cerr.stream()); }