1 //===-- MachineFunction.cpp -----------------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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/CodeGen/MachineFunctionPass.h"
17 #include "llvm/CodeGen/MachineInstr.h"
18 #include "llvm/CodeGen/SSARegMap.h"
19 #include "llvm/CodeGen/MachineFrameInfo.h"
20 #include "llvm/CodeGen/MachineConstantPool.h"
21 #include "llvm/CodeGen/MachineJumpTableInfo.h"
22 #include "llvm/CodeGen/Passes.h"
23 #include "llvm/Target/TargetData.h"
24 #include "llvm/Target/TargetMachine.h"
25 #include "llvm/Target/TargetFrameInfo.h"
26 #include "llvm/Function.h"
27 #include "llvm/Instructions.h"
28 #include "llvm/Support/LeakDetector.h"
29 #include "llvm/Support/GraphWriter.h"
30 #include "llvm/Support/Compiler.h"
31 #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 {
47 const std::string Banner;
49 Printer (std::ostream *_OS, const std::string &_Banner) :
50 OS (_OS), Banner (_Banner) { }
52 const char *getPassName() const { return "MachineFunction Printer"; }
54 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
58 bool runOnMachineFunction(MachineFunction &MF) {
66 /// Returns a newly-created MachineFunction Printer pass. The default output
67 /// stream is std::cerr; the default banner is empty.
69 FunctionPass *llvm::createMachineFunctionPrinterPass(std::ostream *OS,
70 const std::string &Banner){
71 return new Printer(OS, Banner);
75 struct VISIBILITY_HIDDEN Deleter : public MachineFunctionPass {
76 const char *getPassName() const { return "Machine Code Deleter"; }
78 bool runOnMachineFunction(MachineFunction &MF) {
79 // Delete the annotation from the function now.
80 MachineFunction::destruct(MF.getFunction());
86 /// MachineCodeDeletion Pass - This pass deletes all of the machine code for
87 /// the current function, which should happen after the function has been
88 /// emitted to a .s file or to memory.
89 FunctionPass *llvm::createMachineCodeDeleter() {
95 //===---------------------------------------------------------------------===//
96 // MachineFunction implementation
97 //===---------------------------------------------------------------------===//
99 MachineBasicBlock* ilist_traits<MachineBasicBlock>::createSentinel() {
100 MachineBasicBlock* dummy = new MachineBasicBlock();
101 LeakDetector::removeGarbageObject(dummy);
105 void ilist_traits<MachineBasicBlock>::transferNodesFromList(
106 iplist<MachineBasicBlock, ilist_traits<MachineBasicBlock> >& toList,
107 ilist_iterator<MachineBasicBlock> first,
108 ilist_iterator<MachineBasicBlock> last) {
109 if (Parent != toList.Parent)
110 for (; first != last; ++first)
111 first->Parent = toList.Parent;
114 MachineFunction::MachineFunction(const Function *F,
115 const TargetMachine &TM)
116 : Annotation(MF_AID), Fn(F), Target(TM), UsedPhysRegs(0) {
117 SSARegMapping = new SSARegMap();
119 FrameInfo = new MachineFrameInfo();
120 ConstantPool = new MachineConstantPool(TM.getTargetData());
121 JumpTableInfo = new MachineJumpTableInfo(TM.getTargetData());
122 BasicBlocks.Parent = this;
125 MachineFunction::~MachineFunction() {
127 delete SSARegMapping;
131 delete JumpTableInfo;
132 delete[] UsedPhysRegs;
135 void MachineFunction::dump() const { print(std::cerr); }
137 void MachineFunction::print(std::ostream &OS) const {
138 OS << "# Machine code for " << Fn->getName () << "():\n";
140 // Print Frame Information
141 getFrameInfo()->print(*this, OS);
143 // Print JumpTable Information
144 getJumpTableInfo()->print(OS);
146 // Print Constant Pool
147 getConstantPool()->print(OS);
149 const MRegisterInfo *MRI = getTarget().getRegisterInfo();
151 if (livein_begin() != livein_end()) {
153 for (livein_iterator I = livein_begin(), E = livein_end(); I != E; ++I) {
155 OS << " " << MRI->getName(I->first);
157 OS << " Reg #" << I->first;
160 OS << " in VR#" << I->second << " ";
164 if (liveout_begin() != liveout_end()) {
166 for (liveout_iterator I = liveout_begin(), E = liveout_end(); I != E; ++I)
168 OS << " " << MRI->getName(*I);
170 OS << " Reg #" << *I;
174 for (const_iterator BB = begin(); BB != end(); ++BB)
177 OS << "\n# End machine code for " << Fn->getName () << "().\n\n";
180 /// CFGOnly flag - This is used to control whether or not the CFG graph printer
181 /// prints out the contents of basic blocks or not. This is acceptable because
182 /// this code is only really used for debugging purposes.
184 static bool CFGOnly = false;
188 struct DOTGraphTraits<const MachineFunction*> : public DefaultDOTGraphTraits {
189 static std::string getGraphName(const MachineFunction *F) {
190 return "CFG for '" + F->getFunction()->getName() + "' function";
193 static std::string getNodeLabel(const MachineBasicBlock *Node,
194 const MachineFunction *Graph) {
195 if (CFGOnly && Node->getBasicBlock() &&
196 !Node->getBasicBlock()->getName().empty())
197 return Node->getBasicBlock()->getName() + ":";
199 std::ostringstream Out;
201 Out << Node->getNumber() << ':';
207 std::string OutStr = Out.str();
208 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
210 // Process string output to make it nicer...
211 for (unsigned i = 0; i != OutStr.length(); ++i)
212 if (OutStr[i] == '\n') { // Left justify
214 OutStr.insert(OutStr.begin()+i+1, 'l');
221 void MachineFunction::viewCFG() const
224 ViewGraph(this, "mf" + getFunction()->getName());
226 std::cerr << "SelectionDAG::viewGraph is only available in debug builds on "
227 << "systems with Graphviz or gv!\n";
231 void MachineFunction::viewCFGOnly() const
238 // The next two methods are used to construct and to retrieve
239 // the MachineCodeForFunction object for the given function.
240 // construct() -- Allocates and initializes for a given function and target
241 // get() -- Returns a handle to the object.
242 // This should not be called before "construct()"
243 // for a given Function.
246 MachineFunction::construct(const Function *Fn, const TargetMachine &Tar)
248 assert(Fn->getAnnotation(MF_AID) == 0 &&
249 "Object already exists for this function!");
250 MachineFunction* mcInfo = new MachineFunction(Fn, Tar);
251 Fn->addAnnotation(mcInfo);
255 void MachineFunction::destruct(const Function *Fn) {
256 bool Deleted = Fn->deleteAnnotation(MF_AID);
257 assert(Deleted && "Machine code did not exist for function!");
260 MachineFunction& MachineFunction::get(const Function *F)
262 MachineFunction *mc = (MachineFunction*)F->getAnnotation(MF_AID);
263 assert(mc && "Call construct() method first to allocate the object");
267 void MachineFunction::clearSSARegMap() {
268 delete SSARegMapping;
272 //===----------------------------------------------------------------------===//
273 // MachineFrameInfo implementation
274 //===----------------------------------------------------------------------===//
276 void MachineFrameInfo::print(const MachineFunction &MF, std::ostream &OS) const{
277 int ValOffset = MF.getTarget().getFrameInfo()->getOffsetOfLocalArea();
279 for (unsigned i = 0, e = Objects.size(); i != e; ++i) {
280 const StackObject &SO = Objects[i];
281 OS << " <fi #" << (int)(i-NumFixedObjects) << ">: ";
283 OS << "variable sized";
285 OS << "size is " << SO.Size << " byte" << (SO.Size != 1 ? "s," : ",");
286 OS << " alignment is " << SO.Alignment << " byte"
287 << (SO.Alignment != 1 ? "s," : ",");
289 if (i < NumFixedObjects)
291 if (i < NumFixedObjects || SO.SPOffset != -1) {
292 int Off = SO.SPOffset - ValOffset;
293 OS << " at location [SP";
303 if (HasVarSizedObjects)
304 OS << " Stack frame contains variable sized objects\n";
307 void MachineFrameInfo::dump(const MachineFunction &MF) const {
308 print(MF, std::cerr);
312 //===----------------------------------------------------------------------===//
313 // MachineJumpTableInfo implementation
314 //===----------------------------------------------------------------------===//
316 /// getJumpTableIndex - Create a new jump table entry in the jump table info
317 /// or return an existing one.
319 unsigned MachineJumpTableInfo::getJumpTableIndex(
320 std::vector<MachineBasicBlock*> &DestBBs) {
321 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i)
322 if (JumpTables[i].MBBs == DestBBs)
325 JumpTables.push_back(MachineJumpTableEntry(DestBBs));
326 return JumpTables.size()-1;
330 void MachineJumpTableInfo::print(std::ostream &OS) const {
331 // FIXME: this is lame, maybe we could print out the MBB numbers or something
332 // like {1, 2, 4, 5, 3, 0}
333 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i) {
334 OS << " <jt #" << i << "> has " << JumpTables[i].MBBs.size()
339 unsigned MachineJumpTableInfo::getEntrySize() const {
340 return TD->getPointerSize();
343 unsigned MachineJumpTableInfo::getAlignment() const {
344 return TD->getPointerAlignment();
347 void MachineJumpTableInfo::dump() const { print(std::cerr); }
350 //===----------------------------------------------------------------------===//
351 // MachineConstantPool implementation
352 //===----------------------------------------------------------------------===//
354 /// getConstantPoolIndex - Create a new entry in the constant pool or return
355 /// an existing one. User must specify an alignment in bytes for the object.
357 unsigned MachineConstantPool::getConstantPoolIndex(Constant *C,
358 unsigned Alignment) {
359 assert(Alignment && "Alignment must be specified!");
360 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
362 // Check to see if we already have this constant.
364 // FIXME, this could be made much more efficient for large constant pools.
365 unsigned AlignMask = (1 << Alignment)-1;
366 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
367 if (Constants[i].Val == C && (Constants[i].Offset & AlignMask) == 0)
371 if (!Constants.empty()) {
372 Offset = Constants.back().Offset;
373 Offset += TD->getTypeSize(Constants.back().Val->getType());
374 Offset = (Offset+AlignMask)&~AlignMask;
377 Constants.push_back(MachineConstantPoolEntry(C, Offset));
378 return Constants.size()-1;
382 void MachineConstantPool::print(std::ostream &OS) const {
383 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
384 OS << " <cp #" << i << "> is" << *(Value*)Constants[i].Val;
385 OS << " , offset=" << Constants[i].Offset;
390 void MachineConstantPool::dump() const { print(std::cerr); }