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/TargetMachine.h"
26 #include "llvm/Target/TargetFrameInfo.h"
27 #include "llvm/Function.h"
28 #include "llvm/Instructions.h"
29 #include "llvm/Support/Compiler.h"
30 #include "llvm/Support/GraphWriter.h"
31 #include "llvm/Support/raw_ostream.h"
32 #include "llvm/ADT/STLExtras.h"
33 #include "llvm/Config/config.h"
38 static AnnotationID MF_AID(
39 AnnotationManager::getID("CodeGen::MachineCodeForFunction"));
41 // Out of line virtual function to home classes.
42 void MachineFunctionPass::virtfn() {}
45 struct VISIBILITY_HIDDEN Printer : public MachineFunctionPass {
49 const std::string Banner;
51 Printer (std::ostream *os, const std::string &banner)
52 : MachineFunctionPass(&ID), OS(os), Banner(banner) {}
54 const char *getPassName() const { return "MachineFunction Printer"; }
56 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
60 bool runOnMachineFunction(MachineFunction &MF) {
69 /// Returns a newly-created MachineFunction Printer pass. The default output
70 /// stream is std::cerr; the default banner is empty.
72 FunctionPass *llvm::createMachineFunctionPrinterPass(std::ostream *OS,
73 const std::string &Banner){
74 return new Printer(OS, Banner);
78 struct VISIBILITY_HIDDEN Deleter : public MachineFunctionPass {
80 Deleter() : MachineFunctionPass(&ID) {}
82 const char *getPassName() const { return "Machine Code Deleter"; }
84 bool runOnMachineFunction(MachineFunction &MF) {
85 // Delete the annotation from the function now.
86 MachineFunction::destruct(MF.getFunction());
93 /// MachineCodeDeletion Pass - This pass deletes all of the machine code for
94 /// the current function, which should happen after the function has been
95 /// emitted to a .s file or to memory.
96 FunctionPass *llvm::createMachineCodeDeleter() {
102 //===---------------------------------------------------------------------===//
103 // MachineFunction implementation
104 //===---------------------------------------------------------------------===//
106 void ilist_traits<MachineBasicBlock>::deleteNode(MachineBasicBlock *MBB) {
107 MBB->getParent()->DeleteMachineBasicBlock(MBB);
110 MachineFunction::MachineFunction(const Function *F,
111 const TargetMachine &TM)
112 : Annotation(MF_AID), Fn(F), Target(TM) {
113 if (TM.getRegisterInfo())
114 RegInfo = new (Allocator.Allocate<MachineRegisterInfo>())
115 MachineRegisterInfo(*TM.getRegisterInfo());
119 FrameInfo = new (Allocator.Allocate<MachineFrameInfo>())
120 MachineFrameInfo(*TM.getFrameInfo());
121 ConstantPool = new (Allocator.Allocate<MachineConstantPool>())
122 MachineConstantPool(TM.getTargetData());
124 // Set up jump table.
125 const TargetData &TD = *TM.getTargetData();
126 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
127 unsigned EntrySize = IsPic ? 4 : TD.getPointerSize();
128 unsigned Alignment = IsPic ? TD.getABITypeAlignment(Type::Int32Ty)
129 : TD.getPointerABIAlignment();
130 JumpTableInfo = new (Allocator.Allocate<MachineJumpTableInfo>())
131 MachineJumpTableInfo(EntrySize, Alignment);
134 MachineFunction::~MachineFunction() {
136 InstructionRecycler.clear(Allocator);
137 BasicBlockRecycler.clear(Allocator);
139 RegInfo->~MachineRegisterInfo(); Allocator.Deallocate(RegInfo);
141 MFInfo->~MachineFunctionInfo(); Allocator.Deallocate(MFInfo);
143 FrameInfo->~MachineFrameInfo(); Allocator.Deallocate(FrameInfo);
144 ConstantPool->~MachineConstantPool(); Allocator.Deallocate(ConstantPool);
145 JumpTableInfo->~MachineJumpTableInfo(); Allocator.Deallocate(JumpTableInfo);
149 /// RenumberBlocks - This discards all of the MachineBasicBlock numbers and
150 /// recomputes them. This guarantees that the MBB numbers are sequential,
151 /// dense, and match the ordering of the blocks within the function. If a
152 /// specific MachineBasicBlock is specified, only that block and those after
153 /// it are renumbered.
154 void MachineFunction::RenumberBlocks(MachineBasicBlock *MBB) {
155 if (empty()) { MBBNumbering.clear(); return; }
156 MachineFunction::iterator MBBI, E = end();
162 // Figure out the block number this should have.
163 unsigned BlockNo = 0;
165 BlockNo = prior(MBBI)->getNumber()+1;
167 for (; MBBI != E; ++MBBI, ++BlockNo) {
168 if (MBBI->getNumber() != (int)BlockNo) {
169 // Remove use of the old number.
170 if (MBBI->getNumber() != -1) {
171 assert(MBBNumbering[MBBI->getNumber()] == &*MBBI &&
172 "MBB number mismatch!");
173 MBBNumbering[MBBI->getNumber()] = 0;
176 // If BlockNo is already taken, set that block's number to -1.
177 if (MBBNumbering[BlockNo])
178 MBBNumbering[BlockNo]->setNumber(-1);
180 MBBNumbering[BlockNo] = MBBI;
181 MBBI->setNumber(BlockNo);
185 // Okay, all the blocks are renumbered. If we have compactified the block
186 // numbering, shrink MBBNumbering now.
187 assert(BlockNo <= MBBNumbering.size() && "Mismatch!");
188 MBBNumbering.resize(BlockNo);
191 /// CreateMachineInstr - Allocate a new MachineInstr. Use this instead
192 /// of `new MachineInstr'.
195 MachineFunction::CreateMachineInstr(const TargetInstrDesc &TID, bool NoImp) {
196 return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
197 MachineInstr(TID, NoImp);
200 /// CloneMachineInstr - Create a new MachineInstr which is a copy of the
201 /// 'Orig' instruction, identical in all ways except the the instruction
202 /// has no parent, prev, or next.
205 MachineFunction::CloneMachineInstr(const MachineInstr *Orig) {
206 return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
207 MachineInstr(*this, *Orig);
210 /// DeleteMachineInstr - Delete the given MachineInstr.
213 MachineFunction::DeleteMachineInstr(MachineInstr *MI) {
214 // Clear the instructions memoperands. This must be done manually because
215 // the instruction's parent pointer is now null, so it can't properly
216 // deallocate them on its own.
217 MI->clearMemOperands(*this);
220 InstructionRecycler.Deallocate(Allocator, MI);
223 /// CreateMachineBasicBlock - Allocate a new MachineBasicBlock. Use this
224 /// instead of `new MachineBasicBlock'.
227 MachineFunction::CreateMachineBasicBlock(const BasicBlock *bb) {
228 return new (BasicBlockRecycler.Allocate<MachineBasicBlock>(Allocator))
229 MachineBasicBlock(*this, bb);
232 /// DeleteMachineBasicBlock - Delete the given MachineBasicBlock.
235 MachineFunction::DeleteMachineBasicBlock(MachineBasicBlock *MBB) {
236 assert(MBB->getParent() == this && "MBB parent mismatch!");
237 MBB->~MachineBasicBlock();
238 BasicBlockRecycler.Deallocate(Allocator, MBB);
241 void MachineFunction::dump() const {
242 print(*cerr.stream());
245 void MachineFunction::print(std::ostream &OS) const {
246 OS << "# Machine code for " << Fn->getName () << "():\n";
248 // Print Frame Information
249 FrameInfo->print(*this, OS);
251 // Print JumpTable Information
252 JumpTableInfo->print(OS);
254 // Print Constant Pool
256 raw_os_ostream OSS(OS);
257 ConstantPool->print(OSS);
260 const TargetRegisterInfo *TRI = getTarget().getRegisterInfo();
262 if (RegInfo && !RegInfo->livein_empty()) {
264 for (MachineRegisterInfo::livein_iterator
265 I = RegInfo->livein_begin(), E = RegInfo->livein_end(); I != E; ++I) {
267 OS << " " << TRI->getName(I->first);
269 OS << " Reg #" << I->first;
272 OS << " in VR#" << I->second << " ";
276 if (RegInfo && !RegInfo->liveout_empty()) {
278 for (MachineRegisterInfo::liveout_iterator
279 I = RegInfo->liveout_begin(), E = RegInfo->liveout_end(); I != E; ++I)
281 OS << " " << TRI->getName(*I);
283 OS << " Reg #" << *I;
287 for (const_iterator BB = begin(); BB != end(); ++BB)
290 OS << "\n# End machine code for " << Fn->getName () << "().\n\n";
293 /// CFGOnly flag - This is used to control whether or not the CFG graph printer
294 /// prints out the contents of basic blocks or not. This is acceptable because
295 /// this code is only really used for debugging purposes.
297 static bool CFGOnly = false;
301 struct DOTGraphTraits<const MachineFunction*> : public DefaultDOTGraphTraits {
302 static std::string getGraphName(const MachineFunction *F) {
303 return "CFG for '" + F->getFunction()->getName() + "' function";
306 static std::string getNodeLabel(const MachineBasicBlock *Node,
307 const MachineFunction *Graph) {
308 if (CFGOnly && Node->getBasicBlock() &&
309 !Node->getBasicBlock()->getName().empty())
310 return Node->getBasicBlock()->getName() + ":";
312 std::ostringstream Out;
314 Out << Node->getNumber() << ':';
320 std::string OutStr = Out.str();
321 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
323 // Process string output to make it nicer...
324 for (unsigned i = 0; i != OutStr.length(); ++i)
325 if (OutStr[i] == '\n') { // Left justify
327 OutStr.insert(OutStr.begin()+i+1, 'l');
334 void MachineFunction::viewCFG() const
337 ViewGraph(this, "mf" + getFunction()->getName());
339 cerr << "SelectionDAG::viewGraph is only available in debug builds on "
340 << "systems with Graphviz or gv!\n";
344 void MachineFunction::viewCFGOnly() const
351 // The next two methods are used to construct and to retrieve
352 // the MachineCodeForFunction object for the given function.
353 // construct() -- Allocates and initializes for a given function and target
354 // get() -- Returns a handle to the object.
355 // This should not be called before "construct()"
356 // for a given Function.
359 MachineFunction::construct(const Function *Fn, const TargetMachine &Tar)
361 assert(Fn->getAnnotation(MF_AID) == 0 &&
362 "Object already exists for this function!");
363 MachineFunction* mcInfo = new MachineFunction(Fn, Tar);
364 Fn->addAnnotation(mcInfo);
368 void MachineFunction::destruct(const Function *Fn) {
369 bool Deleted = Fn->deleteAnnotation(MF_AID);
370 assert(Deleted && "Machine code did not exist for function!");
371 Deleted = Deleted; // silence warning when no assertions.
374 MachineFunction& MachineFunction::get(const Function *F)
376 MachineFunction *mc = (MachineFunction*)F->getAnnotation(MF_AID);
377 assert(mc && "Call construct() method first to allocate the object");
381 //===----------------------------------------------------------------------===//
382 // MachineFrameInfo implementation
383 //===----------------------------------------------------------------------===//
385 /// CreateFixedObject - Create a new object at a fixed location on the stack.
386 /// All fixed objects should be created before other objects are created for
387 /// efficiency. By default, fixed objects are immutable. This returns an
388 /// index with a negative value.
390 int MachineFrameInfo::CreateFixedObject(uint64_t Size, int64_t SPOffset,
392 assert(Size != 0 && "Cannot allocate zero size fixed stack objects!");
393 Objects.insert(Objects.begin(), StackObject(Size, 1, SPOffset, Immutable));
394 return -++NumFixedObjects;
398 void MachineFrameInfo::print(const MachineFunction &MF, std::ostream &OS) const{
399 int ValOffset = MF.getTarget().getFrameInfo()->getOffsetOfLocalArea();
401 for (unsigned i = 0, e = Objects.size(); i != e; ++i) {
402 const StackObject &SO = Objects[i];
403 OS << " <fi#" << (int)(i-NumFixedObjects) << ">: ";
404 if (SO.Size == ~0ULL) {
409 OS << "variable sized";
411 OS << "size is " << SO.Size << " byte" << (SO.Size != 1 ? "s," : ",");
412 OS << " alignment is " << SO.Alignment << " byte"
413 << (SO.Alignment != 1 ? "s," : ",");
415 if (i < NumFixedObjects)
417 if (i < NumFixedObjects || SO.SPOffset != -1) {
418 int64_t Off = SO.SPOffset - ValOffset;
419 OS << " at location [SP";
429 if (HasVarSizedObjects)
430 OS << " Stack frame contains variable sized objects\n";
433 void MachineFrameInfo::dump(const MachineFunction &MF) const {
434 print(MF, *cerr.stream());
438 //===----------------------------------------------------------------------===//
439 // MachineJumpTableInfo implementation
440 //===----------------------------------------------------------------------===//
442 /// getJumpTableIndex - Create a new jump table entry in the jump table info
443 /// or return an existing one.
445 unsigned MachineJumpTableInfo::getJumpTableIndex(
446 const std::vector<MachineBasicBlock*> &DestBBs) {
447 assert(!DestBBs.empty() && "Cannot create an empty jump table!");
448 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i)
449 if (JumpTables[i].MBBs == DestBBs)
452 JumpTables.push_back(MachineJumpTableEntry(DestBBs));
453 return JumpTables.size()-1;
457 void MachineJumpTableInfo::print(std::ostream &OS) const {
458 // FIXME: this is lame, maybe we could print out the MBB numbers or something
459 // like {1, 2, 4, 5, 3, 0}
460 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i) {
461 OS << " <jt#" << i << "> has " << JumpTables[i].MBBs.size()
466 void MachineJumpTableInfo::dump() const { print(*cerr.stream()); }
469 //===----------------------------------------------------------------------===//
470 // MachineConstantPool implementation
471 //===----------------------------------------------------------------------===//
473 const Type *MachineConstantPoolEntry::getType() const {
474 if (isMachineConstantPoolEntry())
475 return Val.MachineCPVal->getType();
476 return Val.ConstVal->getType();
479 MachineConstantPool::~MachineConstantPool() {
480 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
481 if (Constants[i].isMachineConstantPoolEntry())
482 delete Constants[i].Val.MachineCPVal;
485 /// getConstantPoolIndex - Create a new entry in the constant pool or return
486 /// an existing one. User must specify the log2 of the minimum required
487 /// alignment for the object.
489 unsigned MachineConstantPool::getConstantPoolIndex(Constant *C,
490 unsigned Alignment) {
491 assert(Alignment && "Alignment must be specified!");
492 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
494 // Check to see if we already have this constant.
496 // FIXME, this could be made much more efficient for large constant pools.
497 unsigned AlignMask = (1 << Alignment)-1;
498 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
499 if (Constants[i].Val.ConstVal == C && (Constants[i].Offset & AlignMask)== 0)
503 if (!Constants.empty()) {
504 Offset = Constants.back().getOffset();
505 Offset += TD->getABITypeSize(Constants.back().getType());
506 Offset = (Offset+AlignMask)&~AlignMask;
509 Constants.push_back(MachineConstantPoolEntry(C, Offset));
510 return Constants.size()-1;
513 unsigned MachineConstantPool::getConstantPoolIndex(MachineConstantPoolValue *V,
514 unsigned Alignment) {
515 assert(Alignment && "Alignment must be specified!");
516 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
518 // Check to see if we already have this constant.
520 // FIXME, this could be made much more efficient for large constant pools.
521 unsigned AlignMask = (1 << Alignment)-1;
522 int Idx = V->getExistingMachineCPValue(this, Alignment);
524 return (unsigned)Idx;
527 if (!Constants.empty()) {
528 Offset = Constants.back().getOffset();
529 Offset += TD->getABITypeSize(Constants.back().getType());
530 Offset = (Offset+AlignMask)&~AlignMask;
533 Constants.push_back(MachineConstantPoolEntry(V, Offset));
534 return Constants.size()-1;
537 void MachineConstantPool::print(raw_ostream &OS) const {
538 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
539 OS << " <cp#" << i << "> is";
540 if (Constants[i].isMachineConstantPoolEntry())
541 Constants[i].Val.MachineCPVal->print(OS);
543 OS << *(Value*)Constants[i].Val.ConstVal;
544 OS << " , offset=" << Constants[i].getOffset();
549 void MachineConstantPool::dump() const { print(errs()); errs().flush(); }