1 //===-- llvm/CodeGen/MachineFunction.h --------------------------*- C++ -*-===//
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 for a function. This class contains a list of
11 // MachineBasicBlock instances that make up the current compiled function.
13 // This class also contains pointers to various classes which hold
14 // target-specific information about the generated code.
16 //===----------------------------------------------------------------------===//
18 #ifndef LLVM_CODEGEN_MACHINEFUNCTION_H
19 #define LLVM_CODEGEN_MACHINEFUNCTION_H
21 #include "llvm/ADT/ilist.h"
22 #include "llvm/CodeGen/DebugLoc.h"
23 #include "llvm/CodeGen/MachineBasicBlock.h"
24 #include "llvm/Support/Annotation.h"
25 #include "llvm/Support/Allocator.h"
26 #include "llvm/Support/Recycler.h"
31 class MachineRegisterInfo;
32 class MachineFrameInfo;
33 class MachineConstantPool;
34 class MachineJumpTableInfo;
38 struct ilist_traits<MachineBasicBlock>
39 : public ilist_default_traits<MachineBasicBlock> {
40 mutable MachineBasicBlock Sentinel;
42 MachineBasicBlock *createSentinel() const { return &Sentinel; }
43 void destroySentinel(MachineBasicBlock *) const {}
45 void addNodeToList(MachineBasicBlock* MBB);
46 void removeNodeFromList(MachineBasicBlock* MBB);
47 void deleteNode(MachineBasicBlock *MBB);
49 void createNode(const MachineBasicBlock &);
52 /// MachineFunctionInfo - This class can be derived from and used by targets to
53 /// hold private target-specific information for each MachineFunction. Objects
54 /// of type are accessed/created with MF::getInfo and destroyed when the
55 /// MachineFunction is destroyed.
56 struct MachineFunctionInfo {
57 virtual ~MachineFunctionInfo() {}
60 class MachineFunction : private Annotation {
62 const TargetMachine &Target;
64 // RegInfo - Information about each register in use in the function.
65 MachineRegisterInfo *RegInfo;
67 // Used to keep track of target-specific per-machine function information for
68 // the target implementation.
69 MachineFunctionInfo *MFInfo;
71 // Keep track of objects allocated on the stack.
72 MachineFrameInfo *FrameInfo;
74 // Keep track of constants which are spilled to memory
75 MachineConstantPool *ConstantPool;
77 // Keep track of jump tables for switch instructions
78 MachineJumpTableInfo *JumpTableInfo;
80 // Function-level unique numbering for MachineBasicBlocks. When a
81 // MachineBasicBlock is inserted into a MachineFunction is it automatically
82 // numbered and this vector keeps track of the mapping from ID's to MBB's.
83 std::vector<MachineBasicBlock*> MBBNumbering;
85 // Pool-allocate MachineFunction-lifetime and IR objects.
86 BumpPtrAllocator Allocator;
88 // Allocation management for instructions in function.
89 Recycler<MachineInstr> InstructionRecycler;
91 // Allocation management for basic blocks in function.
92 Recycler<MachineBasicBlock> BasicBlockRecycler;
94 // List of machine basic blocks in function
95 typedef ilist<MachineBasicBlock> BasicBlockListType;
96 BasicBlockListType BasicBlocks;
98 // Tracks debug locations.
99 DebugLocTracker DebugLocInfo;
102 MachineFunction(const Function *Fn, const TargetMachine &TM);
105 /// getFunction - Return the LLVM function that this machine code represents
107 const Function *getFunction() const { return Fn; }
109 /// getTarget - Return the target machine this machine code is compiled with
111 const TargetMachine &getTarget() const { return Target; }
113 /// getRegInfo - Return information about the registers currently in use.
115 MachineRegisterInfo &getRegInfo() { return *RegInfo; }
116 const MachineRegisterInfo &getRegInfo() const { return *RegInfo; }
118 /// getFrameInfo - Return the frame info object for the current function.
119 /// This object contains information about objects allocated on the stack
120 /// frame of the current function in an abstract way.
122 MachineFrameInfo *getFrameInfo() { return FrameInfo; }
123 const MachineFrameInfo *getFrameInfo() const { return FrameInfo; }
125 /// getJumpTableInfo - Return the jump table info object for the current
126 /// function. This object contains information about jump tables for switch
127 /// instructions in the current function.
129 MachineJumpTableInfo *getJumpTableInfo() { return JumpTableInfo; }
130 const MachineJumpTableInfo *getJumpTableInfo() const { return JumpTableInfo; }
132 /// getConstantPool - Return the constant pool object for the current
135 MachineConstantPool *getConstantPool() { return ConstantPool; }
136 const MachineConstantPool *getConstantPool() const { return ConstantPool; }
138 /// MachineFunctionInfo - Keep track of various per-function pieces of
139 /// information for backends that would like to do so.
141 template<typename Ty>
144 // This should be just `new (Allocator.Allocate<Ty>()) Ty(*this)', but
145 // that apparently breaks GCC 3.3.
146 Ty *Loc = static_cast<Ty*>(Allocator.Allocate(sizeof(Ty),
147 AlignOf<Ty>::Alignment));
148 MFInfo = new (Loc) Ty(*this);
151 assert((void*)dynamic_cast<Ty*>(MFInfo) == (void*)MFInfo &&
152 "Invalid concrete type or multiple inheritence for getInfo");
153 return static_cast<Ty*>(MFInfo);
156 template<typename Ty>
157 const Ty *getInfo() const {
158 return const_cast<MachineFunction*>(this)->getInfo<Ty>();
161 /// getBlockNumbered - MachineBasicBlocks are automatically numbered when they
162 /// are inserted into the machine function. The block number for a machine
163 /// basic block can be found by using the MBB::getBlockNumber method, this
164 /// method provides the inverse mapping.
166 MachineBasicBlock *getBlockNumbered(unsigned N) {
167 assert(N < MBBNumbering.size() && "Illegal block number");
168 assert(MBBNumbering[N] && "Block was removed from the machine function!");
169 return MBBNumbering[N];
172 /// getNumBlockIDs - Return the number of MBB ID's allocated.
174 unsigned getNumBlockIDs() const { return (unsigned)MBBNumbering.size(); }
176 /// RenumberBlocks - This discards all of the MachineBasicBlock numbers and
177 /// recomputes them. This guarantees that the MBB numbers are sequential,
178 /// dense, and match the ordering of the blocks within the function. If a
179 /// specific MachineBasicBlock is specified, only that block and those after
180 /// it are renumbered.
181 void RenumberBlocks(MachineBasicBlock *MBBFrom = 0);
183 /// print - Print out the MachineFunction in a format suitable for debugging
184 /// to the specified stream.
186 void print(std::ostream &OS) const;
187 void print(std::ostream *OS) const { if (OS) print(*OS); }
189 /// viewCFG - This function is meant for use from the debugger. You can just
190 /// say 'call F->viewCFG()' and a ghostview window should pop up from the
191 /// program, displaying the CFG of the current function with the code for each
192 /// basic block inside. This depends on there being a 'dot' and 'gv' program
195 void viewCFG() const;
197 /// viewCFGOnly - This function is meant for use from the debugger. It works
198 /// just like viewCFG, but it does not include the contents of basic blocks
199 /// into the nodes, just the label. If you are only interested in the CFG
200 /// this can make the graph smaller.
202 void viewCFGOnly() const;
204 /// dump - Print the current MachineFunction to cerr, useful for debugger use.
208 /// construct - Allocate and initialize a MachineFunction for a given Function
211 static MachineFunction& construct(const Function *F, const TargetMachine &TM);
213 /// destruct - Destroy the MachineFunction corresponding to a given Function
215 static void destruct(const Function *F);
217 /// get - Return a handle to a MachineFunction corresponding to the given
218 /// Function. This should not be called before "construct()" for a given
221 static MachineFunction& get(const Function *F);
223 // Provide accessors for the MachineBasicBlock list...
224 typedef BasicBlockListType::iterator iterator;
225 typedef BasicBlockListType::const_iterator const_iterator;
226 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
227 typedef std::reverse_iterator<iterator> reverse_iterator;
229 //===--------------------------------------------------------------------===//
230 // BasicBlock accessor functions.
232 iterator begin() { return BasicBlocks.begin(); }
233 const_iterator begin() const { return BasicBlocks.begin(); }
234 iterator end () { return BasicBlocks.end(); }
235 const_iterator end () const { return BasicBlocks.end(); }
237 reverse_iterator rbegin() { return BasicBlocks.rbegin(); }
238 const_reverse_iterator rbegin() const { return BasicBlocks.rbegin(); }
239 reverse_iterator rend () { return BasicBlocks.rend(); }
240 const_reverse_iterator rend () const { return BasicBlocks.rend(); }
242 unsigned size() const { return (unsigned)BasicBlocks.size();}
243 bool empty() const { return BasicBlocks.empty(); }
244 const MachineBasicBlock &front() const { return BasicBlocks.front(); }
245 MachineBasicBlock &front() { return BasicBlocks.front(); }
246 const MachineBasicBlock & back() const { return BasicBlocks.back(); }
247 MachineBasicBlock & back() { return BasicBlocks.back(); }
249 void push_back (MachineBasicBlock *MBB) { BasicBlocks.push_back (MBB); }
250 void push_front(MachineBasicBlock *MBB) { BasicBlocks.push_front(MBB); }
251 void insert(iterator MBBI, MachineBasicBlock *MBB) {
252 BasicBlocks.insert(MBBI, MBB);
254 void splice(iterator InsertPt, iterator MBBI) {
255 BasicBlocks.splice(InsertPt, BasicBlocks, MBBI);
258 void remove(iterator MBBI) {
259 BasicBlocks.remove(MBBI);
261 void erase(iterator MBBI) {
262 BasicBlocks.erase(MBBI);
265 //===--------------------------------------------------------------------===//
266 // Internal functions used to automatically number MachineBasicBlocks
269 /// getNextMBBNumber - Returns the next unique number to be assigned
270 /// to a MachineBasicBlock in this MachineFunction.
272 unsigned addToMBBNumbering(MachineBasicBlock *MBB) {
273 MBBNumbering.push_back(MBB);
274 return (unsigned)MBBNumbering.size()-1;
277 /// removeFromMBBNumbering - Remove the specific machine basic block from our
278 /// tracker, this is only really to be used by the MachineBasicBlock
280 void removeFromMBBNumbering(unsigned N) {
281 assert(N < MBBNumbering.size() && "Illegal basic block #");
285 /// CreateMachineInstr - Allocate a new MachineInstr. Use this instead
286 /// of `new MachineInstr'.
288 MachineInstr *CreateMachineInstr(const TargetInstrDesc &TID,
292 /// CloneMachineInstr - Create a new MachineInstr which is a copy of the
293 /// 'Orig' instruction, identical in all ways except the the instruction
294 /// has no parent, prev, or next.
296 MachineInstr *CloneMachineInstr(const MachineInstr *Orig);
298 /// DeleteMachineInstr - Delete the given MachineInstr.
300 void DeleteMachineInstr(MachineInstr *MI);
302 /// CreateMachineBasicBlock - Allocate a new MachineBasicBlock. Use this
303 /// instead of `new MachineBasicBlock'.
305 MachineBasicBlock *CreateMachineBasicBlock(const BasicBlock *bb = 0);
307 /// DeleteMachineBasicBlock - Delete the given MachineBasicBlock.
309 void DeleteMachineBasicBlock(MachineBasicBlock *MBB);
311 //===--------------------------------------------------------------------===//
315 /// getOrCreateDebugLocID - Look up the DebugLocTuple index with the given
316 /// source file, line, and column. If none currently exists, create a new
317 /// DebugLocTuple, and insert it into the DebugIdMap.
318 unsigned getOrCreateDebugLocID(unsigned Src, unsigned Line, unsigned Col);
320 /// getDebugLocTuple - Get the DebugLocTuple for a given DebugLoc object.
321 DebugLocTuple getDebugLocTuple(DebugLoc DL) const;
324 //===--------------------------------------------------------------------===//
325 // GraphTraits specializations for function basic block graphs (CFGs)
326 //===--------------------------------------------------------------------===//
328 // Provide specializations of GraphTraits to be able to treat a
329 // machine function as a graph of machine basic blocks... these are
330 // the same as the machine basic block iterators, except that the root
331 // node is implicitly the first node of the function.
333 template <> struct GraphTraits<MachineFunction*> :
334 public GraphTraits<MachineBasicBlock*> {
335 static NodeType *getEntryNode(MachineFunction *F) {
339 // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
340 typedef MachineFunction::iterator nodes_iterator;
341 static nodes_iterator nodes_begin(MachineFunction *F) { return F->begin(); }
342 static nodes_iterator nodes_end (MachineFunction *F) { return F->end(); }
344 template <> struct GraphTraits<const MachineFunction*> :
345 public GraphTraits<const MachineBasicBlock*> {
346 static NodeType *getEntryNode(const MachineFunction *F) {
350 // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
351 typedef MachineFunction::const_iterator nodes_iterator;
352 static nodes_iterator nodes_begin(const MachineFunction *F) { return F->begin(); }
353 static nodes_iterator nodes_end (const MachineFunction *F) { return F->end(); }
357 // Provide specializations of GraphTraits to be able to treat a function as a
358 // graph of basic blocks... and to walk it in inverse order. Inverse order for
359 // a function is considered to be when traversing the predecessor edges of a BB
360 // instead of the successor edges.
362 template <> struct GraphTraits<Inverse<MachineFunction*> > :
363 public GraphTraits<Inverse<MachineBasicBlock*> > {
364 static NodeType *getEntryNode(Inverse<MachineFunction*> G) {
365 return &G.Graph->front();
368 template <> struct GraphTraits<Inverse<const MachineFunction*> > :
369 public GraphTraits<Inverse<const MachineBasicBlock*> > {
370 static NodeType *getEntryNode(Inverse<const MachineFunction *> G) {
371 return &G.Graph->front();
375 } // End llvm namespace