8bcf0124a8fac6208ae7d09de2eab7103a5fa29b
[oota-llvm.git] / lib / CodeGen / MachineFunction.cpp
1 //===-- MachineFunction.cpp -----------------------------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // Collect native machine code information for a function.  This allows
11 // target-specific information about the generated code to be stored with each
12 // function.
13 //
14 //===----------------------------------------------------------------------===//
15
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"
34 #include <fstream>
35 #include <sstream>
36 using namespace llvm;
37
38 bool MachineFunctionPass::runOnFunction(Function &F) {
39   // Do not codegen any 'available_externally' functions at all, they have
40   // definitions outside the translation unit.
41   if (F.hasAvailableExternallyLinkage())
42     return false;
43   
44   return runOnMachineFunction(MachineFunction::get(&F));
45 }
46
47 namespace {
48   struct VISIBILITY_HIDDEN Printer : public MachineFunctionPass {
49     static char ID;
50
51     std::ostream *OS;
52     const std::string Banner;
53
54     Printer (std::ostream *os, const std::string &banner) 
55       : MachineFunctionPass(&ID), OS(os), Banner(banner) {}
56
57     const char *getPassName() const { return "MachineFunction Printer"; }
58
59     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
60       AU.setPreservesAll();
61     }
62
63     bool runOnMachineFunction(MachineFunction &MF) {
64       (*OS) << Banner;
65       MF.print (*OS);
66       return false;
67     }
68   };
69   char Printer::ID = 0;
70 }
71
72 /// Returns a newly-created MachineFunction Printer pass. The default output
73 /// stream is std::cerr; the default banner is empty.
74 ///
75 FunctionPass *llvm::createMachineFunctionPrinterPass(std::ostream *OS,
76                                                      const std::string &Banner){
77   return new Printer(OS, Banner);
78 }
79
80 namespace {
81   struct VISIBILITY_HIDDEN Deleter : public MachineFunctionPass {
82     static char ID;
83     Deleter() : MachineFunctionPass(&ID) {}
84
85     const char *getPassName() const { return "Machine Code Deleter"; }
86
87     bool runOnMachineFunction(MachineFunction &MF) {
88       // Delete the annotation from the function now.
89       MachineFunction::destruct(MF.getFunction());
90       return true;
91     }
92   };
93   char Deleter::ID = 0;
94 }
95
96 /// MachineCodeDeletion Pass - This pass deletes all of the machine code for
97 /// the current function, which should happen after the function has been
98 /// emitted to a .s file or to memory.
99 FunctionPass *llvm::createMachineCodeDeleter() {
100   return new Deleter();
101 }
102
103
104
105 //===---------------------------------------------------------------------===//
106 // MachineFunction implementation
107 //===---------------------------------------------------------------------===//
108
109 void ilist_traits<MachineBasicBlock>::deleteNode(MachineBasicBlock *MBB) {
110   MBB->getParent()->DeleteMachineBasicBlock(MBB);
111 }
112
113 MachineFunction::MachineFunction(const Function *F,
114                                  const TargetMachine &TM)
115   : Annotation(AnnotationManager::getID("CodeGen::MachineCodeForFunction")),
116     Fn(F), Target(TM) {
117   if (TM.getRegisterInfo())
118     RegInfo = new (Allocator.Allocate<MachineRegisterInfo>())
119                   MachineRegisterInfo(*TM.getRegisterInfo());
120   else
121     RegInfo = 0;
122   MFInfo = 0;
123   FrameInfo = new (Allocator.Allocate<MachineFrameInfo>())
124                   MachineFrameInfo(*TM.getFrameInfo());
125   ConstantPool = new (Allocator.Allocate<MachineConstantPool>())
126                      MachineConstantPool(TM.getTargetData());
127   
128   // Set up jump table.
129   const TargetData &TD = *TM.getTargetData();
130   bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
131   unsigned EntrySize = IsPic ? 4 : TD.getPointerSize();
132   unsigned Alignment = IsPic ? TD.getABITypeAlignment(Type::Int32Ty)
133                              : TD.getPointerABIAlignment();
134   JumpTableInfo = new (Allocator.Allocate<MachineJumpTableInfo>())
135                       MachineJumpTableInfo(EntrySize, Alignment);
136 }
137
138 MachineFunction::~MachineFunction() {
139   BasicBlocks.clear();
140   InstructionRecycler.clear(Allocator);
141   BasicBlockRecycler.clear(Allocator);
142   if (RegInfo)
143     RegInfo->~MachineRegisterInfo();        Allocator.Deallocate(RegInfo);
144   if (MFInfo) {
145     MFInfo->~MachineFunctionInfo();       Allocator.Deallocate(MFInfo);
146   }
147   FrameInfo->~MachineFrameInfo();         Allocator.Deallocate(FrameInfo);
148   ConstantPool->~MachineConstantPool();   Allocator.Deallocate(ConstantPool);
149   JumpTableInfo->~MachineJumpTableInfo(); Allocator.Deallocate(JumpTableInfo);
150 }
151
152
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();
161   if (MBB == 0)
162     MBBI = begin();
163   else
164     MBBI = MBB;
165   
166   // Figure out the block number this should have.
167   unsigned BlockNo = 0;
168   if (MBBI != begin())
169     BlockNo = prior(MBBI)->getNumber()+1;
170   
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;
178       }
179       
180       // If BlockNo is already taken, set that block's number to -1.
181       if (MBBNumbering[BlockNo])
182         MBBNumbering[BlockNo]->setNumber(-1);
183
184       MBBNumbering[BlockNo] = MBBI;
185       MBBI->setNumber(BlockNo);
186     }
187   }    
188
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);
193 }
194
195 /// CreateMachineInstr - Allocate a new MachineInstr. Use this instead
196 /// of `new MachineInstr'.
197 ///
198 MachineInstr *
199 MachineFunction::CreateMachineInstr(const TargetInstrDesc &TID,
200                                     DebugLoc DL, bool NoImp) {
201   return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
202     MachineInstr(TID, DL, NoImp);
203 }
204
205 /// CloneMachineInstr - Create a new MachineInstr which is a copy of the
206 /// 'Orig' instruction, identical in all ways except the the instruction
207 /// has no parent, prev, or next.
208 ///
209 MachineInstr *
210 MachineFunction::CloneMachineInstr(const MachineInstr *Orig) {
211   return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
212              MachineInstr(*this, *Orig);
213 }
214
215 /// DeleteMachineInstr - Delete the given MachineInstr.
216 ///
217 void
218 MachineFunction::DeleteMachineInstr(MachineInstr *MI) {
219   // Clear the instructions memoperands. This must be done manually because
220   // the instruction's parent pointer is now null, so it can't properly
221   // deallocate them on its own.
222   MI->clearMemOperands(*this);
223
224   MI->~MachineInstr();
225   InstructionRecycler.Deallocate(Allocator, MI);
226 }
227
228 /// CreateMachineBasicBlock - Allocate a new MachineBasicBlock. Use this
229 /// instead of `new MachineBasicBlock'.
230 ///
231 MachineBasicBlock *
232 MachineFunction::CreateMachineBasicBlock(const BasicBlock *bb) {
233   return new (BasicBlockRecycler.Allocate<MachineBasicBlock>(Allocator))
234              MachineBasicBlock(*this, bb);
235 }
236
237 /// DeleteMachineBasicBlock - Delete the given MachineBasicBlock.
238 ///
239 void
240 MachineFunction::DeleteMachineBasicBlock(MachineBasicBlock *MBB) {
241   assert(MBB->getParent() == this && "MBB parent mismatch!");
242   MBB->~MachineBasicBlock();
243   BasicBlockRecycler.Deallocate(Allocator, MBB);
244 }
245
246 void MachineFunction::dump() const {
247   print(*cerr.stream());
248 }
249
250 void MachineFunction::print(std::ostream &OS) const {
251   OS << "# Machine code for " << Fn->getName () << "():\n";
252
253   // Print Frame Information
254   FrameInfo->print(*this, OS);
255   
256   // Print JumpTable Information
257   JumpTableInfo->print(OS);
258
259   // Print Constant Pool
260   {
261     raw_os_ostream OSS(OS);
262     ConstantPool->print(OSS);
263   }
264   
265   const TargetRegisterInfo *TRI = getTarget().getRegisterInfo();
266   
267   if (RegInfo && !RegInfo->livein_empty()) {
268     OS << "Live Ins:";
269     for (MachineRegisterInfo::livein_iterator
270          I = RegInfo->livein_begin(), E = RegInfo->livein_end(); I != E; ++I) {
271       if (TRI)
272         OS << " " << TRI->getName(I->first);
273       else
274         OS << " Reg #" << I->first;
275       
276       if (I->second)
277         OS << " in VR#" << I->second << " ";
278     }
279     OS << "\n";
280   }
281   if (RegInfo && !RegInfo->liveout_empty()) {
282     OS << "Live Outs:";
283     for (MachineRegisterInfo::liveout_iterator
284          I = RegInfo->liveout_begin(), E = RegInfo->liveout_end(); I != E; ++I)
285       if (TRI)
286         OS << " " << TRI->getName(*I);
287       else
288         OS << " Reg #" << *I;
289     OS << "\n";
290   }
291   
292   for (const_iterator BB = begin(); BB != end(); ++BB)
293     BB->print(OS);
294
295   OS << "\n# End machine code for " << Fn->getName () << "().\n\n";
296 }
297
298 namespace llvm {
299   template<>
300   struct DOTGraphTraits<const MachineFunction*> : public DefaultDOTGraphTraits {
301     static std::string getGraphName(const MachineFunction *F) {
302       return "CFG for '" + F->getFunction()->getName() + "' function";
303     }
304
305     static std::string getNodeLabel(const MachineBasicBlock *Node,
306                                     const MachineFunction *Graph,
307                                     bool ShortNames) {
308       if (ShortNames && Node->getBasicBlock() &&
309           !Node->getBasicBlock()->getName().empty())
310         return Node->getBasicBlock()->getName() + ":";
311
312       std::ostringstream Out;
313       if (ShortNames) {
314         Out << Node->getNumber() << ':';
315         return Out.str();
316       }
317
318       Node->print(Out);
319
320       std::string OutStr = Out.str();
321       if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
322
323       // Process string output to make it nicer...
324       for (unsigned i = 0; i != OutStr.length(); ++i)
325         if (OutStr[i] == '\n') {                            // Left justify
326           OutStr[i] = '\\';
327           OutStr.insert(OutStr.begin()+i+1, 'l');
328         }
329       return OutStr;
330     }
331   };
332 }
333
334 void MachineFunction::viewCFG() const
335 {
336 #ifndef NDEBUG
337   ViewGraph(this, "mf" + getFunction()->getName());
338 #else
339   cerr << "SelectionDAG::viewGraph is only available in debug builds on "
340        << "systems with Graphviz or gv!\n";
341 #endif // NDEBUG
342 }
343
344 void MachineFunction::viewCFGOnly() const
345 {
346 #ifndef NDEBUG
347   ViewGraph(this, "mf" + getFunction()->getName(), true);
348 #else
349   cerr << "SelectionDAG::viewGraph is only available in debug builds on "
350        << "systems with Graphviz or gv!\n";
351 #endif // NDEBUG
352 }
353
354 // The next two methods are used to construct and to retrieve
355 // the MachineCodeForFunction object for the given function.
356 // construct() -- Allocates and initializes for a given function and target
357 // get()       -- Returns a handle to the object.
358 //                This should not be called before "construct()"
359 //                for a given Function.
360 //
361 MachineFunction&
362 MachineFunction::construct(const Function *Fn, const TargetMachine &Tar)
363 {
364   AnnotationID MF_AID =
365                     AnnotationManager::getID("CodeGen::MachineCodeForFunction");
366   assert(Fn->getAnnotation(MF_AID) == 0 &&
367          "Object already exists for this function!");
368   MachineFunction* mcInfo = new MachineFunction(Fn, Tar);
369   Fn->addAnnotation(mcInfo);
370   return *mcInfo;
371 }
372
373 void MachineFunction::destruct(const Function *Fn) {
374   AnnotationID MF_AID =
375                     AnnotationManager::getID("CodeGen::MachineCodeForFunction");
376   bool Deleted = Fn->deleteAnnotation(MF_AID);
377   assert(Deleted && "Machine code did not exist for function!"); 
378   Deleted = Deleted; // silence warning when no assertions.
379 }
380
381 MachineFunction& MachineFunction::get(const Function *F)
382 {
383   AnnotationID MF_AID =
384                     AnnotationManager::getID("CodeGen::MachineCodeForFunction");
385   MachineFunction *mc = (MachineFunction*)F->getAnnotation(MF_AID);
386   assert(mc && "Call construct() method first to allocate the object");
387   return *mc;
388 }
389
390 /// addLiveIn - Add the specified physical register as a live-in value and
391 /// create a corresponding virtual register for it.
392 unsigned MachineFunction::addLiveIn(unsigned PReg,
393                                     const TargetRegisterClass *RC) {
394   assert(RC->contains(PReg) && "Not the correct regclass!");
395   unsigned VReg = getRegInfo().createVirtualRegister(RC);
396   getRegInfo().addLiveIn(PReg, VReg);
397   return VReg;
398 }
399
400 /// getOrCreateDebugLocID - Look up the DebugLocTuple index with the given
401 /// source file, line, and column. If none currently exists, create a new
402 /// DebugLocTuple, and insert it into the DebugIdMap.
403 unsigned MachineFunction::getOrCreateDebugLocID(GlobalVariable *CompileUnit,
404                                                 unsigned Line, unsigned Col) {
405   DebugLocTuple Tuple(CompileUnit, Line, Col);
406   DenseMap<DebugLocTuple, unsigned>::iterator II
407     = DebugLocInfo.DebugIdMap.find(Tuple);
408   if (II != DebugLocInfo.DebugIdMap.end())
409     return II->second;
410   // Add a new tuple.
411   unsigned Id = DebugLocInfo.DebugLocations.size();
412   DebugLocInfo.DebugLocations.push_back(Tuple);
413   DebugLocInfo.DebugIdMap[Tuple] = Id;
414   return Id;
415 }
416
417 /// getDebugLocTuple - Get the DebugLocTuple for a given DebugLoc object.
418 DebugLocTuple MachineFunction::getDebugLocTuple(DebugLoc DL) const {
419   unsigned Idx = DL.getIndex();
420   assert(Idx < DebugLocInfo.DebugLocations.size() &&
421          "Invalid index into debug locations!");
422   return DebugLocInfo.DebugLocations[Idx];
423 }
424
425 //===----------------------------------------------------------------------===//
426 //  MachineFrameInfo implementation
427 //===----------------------------------------------------------------------===//
428
429 /// CreateFixedObject - Create a new object at a fixed location on the stack.
430 /// All fixed objects should be created before other objects are created for
431 /// efficiency. By default, fixed objects are immutable. This returns an
432 /// index with a negative value.
433 ///
434 int MachineFrameInfo::CreateFixedObject(uint64_t Size, int64_t SPOffset,
435                                         bool Immutable) {
436   assert(Size != 0 && "Cannot allocate zero size fixed stack objects!");
437   Objects.insert(Objects.begin(), StackObject(Size, 1, SPOffset, Immutable));
438   return -++NumFixedObjects;
439 }
440
441
442 void MachineFrameInfo::print(const MachineFunction &MF, std::ostream &OS) const{
443   const TargetFrameInfo *FI = MF.getTarget().getFrameInfo();
444   int ValOffset = (FI ? FI->getOffsetOfLocalArea() : 0);
445
446   for (unsigned i = 0, e = Objects.size(); i != e; ++i) {
447     const StackObject &SO = Objects[i];
448     OS << "  <fi#" << (int)(i-NumFixedObjects) << ">: ";
449     if (SO.Size == ~0ULL) {
450       OS << "dead\n";
451       continue;
452     }
453     if (SO.Size == 0)
454       OS << "variable sized";
455     else
456       OS << "size is " << SO.Size << " byte" << (SO.Size != 1 ? "s," : ",");
457     OS << " alignment is " << SO.Alignment << " byte"
458        << (SO.Alignment != 1 ? "s," : ",");
459
460     if (i < NumFixedObjects)
461       OS << " fixed";
462     if (i < NumFixedObjects || SO.SPOffset != -1) {
463       int64_t Off = SO.SPOffset - ValOffset;
464       OS << " at location [SP";
465       if (Off > 0)
466         OS << "+" << Off;
467       else if (Off < 0)
468         OS << Off;
469       OS << "]";
470     }
471     OS << "\n";
472   }
473
474   if (HasVarSizedObjects)
475     OS << "  Stack frame contains variable sized objects\n";
476 }
477
478 void MachineFrameInfo::dump(const MachineFunction &MF) const {
479   print(MF, *cerr.stream());
480 }
481
482
483 //===----------------------------------------------------------------------===//
484 //  MachineJumpTableInfo implementation
485 //===----------------------------------------------------------------------===//
486
487 /// getJumpTableIndex - Create a new jump table entry in the jump table info
488 /// or return an existing one.
489 ///
490 unsigned MachineJumpTableInfo::getJumpTableIndex(
491                                const std::vector<MachineBasicBlock*> &DestBBs) {
492   assert(!DestBBs.empty() && "Cannot create an empty jump table!");
493   for (unsigned i = 0, e = JumpTables.size(); i != e; ++i)
494     if (JumpTables[i].MBBs == DestBBs)
495       return i;
496   
497   JumpTables.push_back(MachineJumpTableEntry(DestBBs));
498   return JumpTables.size()-1;
499 }
500
501 /// ReplaceMBBInJumpTables - If Old is the target of any jump tables, update
502 /// the jump tables to branch to New instead.
503 bool
504 MachineJumpTableInfo::ReplaceMBBInJumpTables(MachineBasicBlock *Old,
505                                              MachineBasicBlock *New) {
506   assert(Old != New && "Not making a change?");
507   bool MadeChange = false;
508   for (size_t i = 0, e = JumpTables.size(); i != e; ++i) {
509     MachineJumpTableEntry &JTE = JumpTables[i];
510     for (size_t j = 0, e = JTE.MBBs.size(); j != e; ++j)
511       if (JTE.MBBs[j] == Old) {
512         JTE.MBBs[j] = New;
513         MadeChange = true;
514       }
515   }
516   return MadeChange;
517 }
518
519 void MachineJumpTableInfo::print(std::ostream &OS) const {
520   // FIXME: this is lame, maybe we could print out the MBB numbers or something
521   // like {1, 2, 4, 5, 3, 0}
522   for (unsigned i = 0, e = JumpTables.size(); i != e; ++i) {
523     OS << "  <jt#" << i << "> has " << JumpTables[i].MBBs.size() 
524        << " entries\n";
525   }
526 }
527
528 void MachineJumpTableInfo::dump() const { print(*cerr.stream()); }
529
530
531 //===----------------------------------------------------------------------===//
532 //  MachineConstantPool implementation
533 //===----------------------------------------------------------------------===//
534
535 const Type *MachineConstantPoolEntry::getType() const {
536   if (isMachineConstantPoolEntry())
537       return Val.MachineCPVal->getType();
538   return Val.ConstVal->getType();
539 }
540
541 MachineConstantPool::~MachineConstantPool() {
542   for (unsigned i = 0, e = Constants.size(); i != e; ++i)
543     if (Constants[i].isMachineConstantPoolEntry())
544       delete Constants[i].Val.MachineCPVal;
545 }
546
547 /// getConstantPoolIndex - Create a new entry in the constant pool or return
548 /// an existing one.  User must specify the log2 of the minimum required
549 /// alignment for the object.
550 ///
551 unsigned MachineConstantPool::getConstantPoolIndex(Constant *C, 
552                                                    unsigned Alignment) {
553   assert(Alignment && "Alignment must be specified!");
554   if (Alignment > PoolAlignment) PoolAlignment = Alignment;
555   
556   // Check to see if we already have this constant.
557   //
558   // FIXME, this could be made much more efficient for large constant pools.
559   for (unsigned i = 0, e = Constants.size(); i != e; ++i)
560     if (Constants[i].Val.ConstVal == C &&
561         (Constants[i].getAlignment() & (Alignment - 1)) == 0)
562       return i;
563   
564   Constants.push_back(MachineConstantPoolEntry(C, Alignment));
565   return Constants.size()-1;
566 }
567
568 unsigned MachineConstantPool::getConstantPoolIndex(MachineConstantPoolValue *V,
569                                                    unsigned Alignment) {
570   assert(Alignment && "Alignment must be specified!");
571   if (Alignment > PoolAlignment) PoolAlignment = Alignment;
572   
573   // Check to see if we already have this constant.
574   //
575   // FIXME, this could be made much more efficient for large constant pools.
576   int Idx = V->getExistingMachineCPValue(this, Alignment);
577   if (Idx != -1)
578     return (unsigned)Idx;
579
580   Constants.push_back(MachineConstantPoolEntry(V, Alignment));
581   return Constants.size()-1;
582 }
583
584 void MachineConstantPool::print(raw_ostream &OS) const {
585   for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
586     OS << "  <cp#" << i << "> is";
587     if (Constants[i].isMachineConstantPoolEntry())
588       Constants[i].Val.MachineCPVal->print(OS);
589     else
590       OS << *(Value*)Constants[i].Val.ConstVal;
591     OS << " , alignment=" << Constants[i].getAlignment();
592     OS << "\n";
593   }
594 }
595
596 void MachineConstantPool::dump() const { print(errs()); }