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/Passes.h"
22 #include "llvm/Target/TargetMachine.h"
23 #include "llvm/Target/TargetFrameInfo.h"
24 #include "llvm/Function.h"
25 #include "llvm/Instructions.h"
26 #include "llvm/Support/LeakDetector.h"
27 #include "llvm/Support/GraphWriter.h"
34 static AnnotationID MF_AID(
35 AnnotationManager::getID("CodeGen::MachineCodeForFunction"));
39 struct Printer : public MachineFunctionPass {
41 const std::string Banner;
43 Printer (std::ostream *_OS, const std::string &_Banner) :
44 OS (_OS), Banner (_Banner) { }
46 const char *getPassName() const { return "MachineFunction Printer"; }
48 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
52 bool runOnMachineFunction(MachineFunction &MF) {
60 /// Returns a newly-created MachineFunction Printer pass. The default output
61 /// stream is std::cerr; the default banner is empty.
63 FunctionPass *llvm::createMachineFunctionPrinterPass(std::ostream *OS,
64 const std::string &Banner){
65 return new Printer(OS, Banner);
69 struct Deleter : public MachineFunctionPass {
70 const char *getPassName() const { return "Machine Code Deleter"; }
72 bool runOnMachineFunction(MachineFunction &MF) {
73 // Delete the annotation from the function now.
74 MachineFunction::destruct(MF.getFunction());
80 /// MachineCodeDeletion Pass - This pass deletes all of the machine code for
81 /// the current function, which should happen after the function has been
82 /// emitted to a .s file or to memory.
83 FunctionPass *llvm::createMachineCodeDeleter() {
89 //===---------------------------------------------------------------------===//
90 // MachineFunction implementation
91 //===---------------------------------------------------------------------===//
93 MachineBasicBlock* ilist_traits<MachineBasicBlock>::createSentinel() {
94 MachineBasicBlock* dummy = new MachineBasicBlock();
95 LeakDetector::removeGarbageObject(dummy);
99 void ilist_traits<MachineBasicBlock>::transferNodesFromList(
100 iplist<MachineBasicBlock, ilist_traits<MachineBasicBlock> >& toList,
101 ilist_iterator<MachineBasicBlock> first,
102 ilist_iterator<MachineBasicBlock> last) {
103 if (Parent != toList.Parent)
104 for (; first != last; ++first)
105 first->Parent = toList.Parent;
108 MachineFunction::MachineFunction(const Function *F,
109 const TargetMachine &TM)
110 : Annotation(MF_AID), Fn(F), Target(TM), UsedPhysRegs(0) {
111 SSARegMapping = new SSARegMap();
113 FrameInfo = new MachineFrameInfo();
114 ConstantPool = new MachineConstantPool();
115 BasicBlocks.Parent = this;
118 MachineFunction::~MachineFunction() {
120 delete SSARegMapping;
124 delete[] UsedPhysRegs;
127 void MachineFunction::dump() const { print(std::cerr); }
129 void MachineFunction::print(std::ostream &OS) const {
130 OS << "# Machine code for " << Fn->getName () << "():\n";
132 // Print Frame Information
133 getFrameInfo()->print(*this, OS);
135 // Print Constant Pool
136 getConstantPool()->print(OS);
138 const MRegisterInfo *MRI = getTarget().getRegisterInfo();
140 if (livein_begin() != livein_end()) {
142 for (livein_iterator I = livein_begin(), E = livein_end(); I != E; ++I) {
144 OS << " " << MRI->getName(I->first);
146 OS << " Reg #" << I->first;
150 if (liveout_begin() != liveout_end()) {
152 for (liveout_iterator I = liveout_begin(), E = liveout_end(); I != E; ++I)
154 OS << " " << MRI->getName(*I);
156 OS << " Reg #" << *I;
160 for (const_iterator BB = begin(); BB != end(); ++BB)
163 OS << "\n# End machine code for " << Fn->getName () << "().\n\n";
166 /// CFGOnly flag - This is used to control whether or not the CFG graph printer
167 /// prints out the contents of basic blocks or not. This is acceptable because
168 /// this code is only really used for debugging purposes.
170 static bool CFGOnly = false;
174 struct DOTGraphTraits<const MachineFunction*> : public DefaultDOTGraphTraits {
175 static std::string getGraphName(const MachineFunction *F) {
176 return "CFG for '" + F->getFunction()->getName() + "' function";
179 static std::string getNodeLabel(const MachineBasicBlock *Node,
180 const MachineFunction *Graph) {
181 if (CFGOnly && Node->getBasicBlock() &&
182 !Node->getBasicBlock()->getName().empty())
183 return Node->getBasicBlock()->getName() + ":";
185 std::ostringstream Out;
187 Out << Node->getNumber() << ':';
193 std::string OutStr = Out.str();
194 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
196 // Process string output to make it nicer...
197 for (unsigned i = 0; i != OutStr.length(); ++i)
198 if (OutStr[i] == '\n') { // Left justify
200 OutStr.insert(OutStr.begin()+i+1, 'l');
207 void MachineFunction::viewCFG() const
209 std::string Filename = "/tmp/cfg." + getFunction()->getName() + ".dot";
210 std::cerr << "Writing '" << Filename << "'... ";
211 std::ofstream F(Filename.c_str());
214 std::cerr << " error opening file for writing!\n";
222 std::cerr << "Running 'dot' program... " << std::flush;
223 if (system(("dot -Tps -Nfontname=Courier -Gsize=7.5,10 " + Filename
224 + " > /tmp/cfg.tempgraph.ps").c_str())) {
225 std::cerr << "Error running dot: 'dot' not in path?\n";
228 system("gv /tmp/cfg.tempgraph.ps");
230 system(("rm " + Filename + " /tmp/cfg.tempgraph.ps").c_str());
233 void MachineFunction::viewCFGOnly() const
240 // The next two methods are used to construct and to retrieve
241 // the MachineCodeForFunction object for the given function.
242 // construct() -- Allocates and initializes for a given function and target
243 // get() -- Returns a handle to the object.
244 // This should not be called before "construct()"
245 // for a given Function.
248 MachineFunction::construct(const Function *Fn, const TargetMachine &Tar)
250 assert(Fn->getAnnotation(MF_AID) == 0 &&
251 "Object already exists for this function!");
252 MachineFunction* mcInfo = new MachineFunction(Fn, Tar);
253 Fn->addAnnotation(mcInfo);
257 void MachineFunction::destruct(const Function *Fn) {
258 bool Deleted = Fn->deleteAnnotation(MF_AID);
259 assert(Deleted && "Machine code did not exist for function!");
262 MachineFunction& MachineFunction::get(const Function *F)
264 MachineFunction *mc = (MachineFunction*)F->getAnnotation(MF_AID);
265 assert(mc && "Call construct() method first to allocate the object");
269 void MachineFunction::clearSSARegMap() {
270 delete SSARegMapping;
274 //===----------------------------------------------------------------------===//
275 // MachineFrameInfo implementation
276 //===----------------------------------------------------------------------===//
278 /// CreateStackObject - Create a stack object for a value of the specified type.
280 int MachineFrameInfo::CreateStackObject(const Type *Ty, const TargetData &TD) {
281 return CreateStackObject((unsigned)TD.getTypeSize(Ty),
282 TD.getTypeAlignment(Ty));
286 void MachineFrameInfo::print(const MachineFunction &MF, std::ostream &OS) const{
287 int ValOffset = MF.getTarget().getFrameInfo()->getOffsetOfLocalArea();
289 for (unsigned i = 0, e = Objects.size(); i != e; ++i) {
290 const StackObject &SO = Objects[i];
291 OS << " <fi #" << (int)(i-NumFixedObjects) << ">: ";
293 OS << "variable sized";
295 OS << "size is " << SO.Size << " byte" << (SO.Size != 1 ? "s," : ",");
296 OS << " alignment is " << SO.Alignment << " byte"
297 << (SO.Alignment != 1 ? "s," : ",");
299 if (i < NumFixedObjects)
301 if (i < NumFixedObjects || SO.SPOffset != -1) {
302 int Off = SO.SPOffset - ValOffset;
303 OS << " at location [SP";
313 if (HasVarSizedObjects)
314 OS << " Stack frame contains variable sized objects\n";
317 void MachineFrameInfo::dump(const MachineFunction &MF) const {
318 print(MF, std::cerr);
322 //===----------------------------------------------------------------------===//
323 // MachineConstantPool implementation
324 //===----------------------------------------------------------------------===//
326 void MachineConstantPool::print(std::ostream &OS) const {
327 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
328 OS << " <cp #" << i << "> is" << *(Value*)Constants[i] << "\n";
331 void MachineConstantPool::dump() const { print(std::cerr); }