1 //===-- llvm/CodeGen/MachineModuleInfo.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 meta information for a module. This information should be in a
11 // neutral form that can be used by different debugging and exception handling
14 // The organization of information is primarily clustered around the source
15 // compile units. The main exception is source line correspondence where
16 // inlining may interleave code from various compile units.
18 // The following information can be retrieved from the MachineModuleInfo.
20 // -- Source directories - Directories are uniqued based on their canonical
21 // string and assigned a sequential numeric ID (base 1.)
22 // -- Source files - Files are also uniqued based on their name and directory
23 // ID. A file ID is sequential number (base 1.)
24 // -- Source line correspondence - A vector of file ID, line#, column# triples.
25 // A DEBUG_LOCATION instruction is generated by the DAG Legalizer
26 // corresponding to each entry in the source line list. This allows a debug
27 // emitter to generate labels referenced by debug information tables.
29 //===----------------------------------------------------------------------===//
31 #ifndef LLVM_CODEGEN_MACHINEMODULEINFO_H
32 #define LLVM_CODEGEN_MACHINEMODULEINFO_H
34 #include "llvm/Pass.h"
35 #include "llvm/GlobalValue.h"
36 #include "llvm/Metadata.h"
37 #include "llvm/CodeGen/MachineLocation.h"
38 #include "llvm/MC/MCContext.h"
39 #include "llvm/Support/Dwarf.h"
40 #include "llvm/Support/ValueHandle.h"
41 #include "llvm/System/DataTypes.h"
42 #include "llvm/ADT/DenseMap.h"
43 #include "llvm/ADT/PointerIntPair.h"
44 #include "llvm/ADT/SmallPtrSet.h"
45 #include "llvm/ADT/SmallVector.h"
49 //===----------------------------------------------------------------------===//
50 // Forward declarations.
54 class MachineBasicBlock;
55 class MachineFunction;
60 /// MachineModuleInfoImpl - This class can be derived from and used by targets
61 /// to hold private target-specific information for each Module. Objects of
62 /// type are accessed/created with MMI::getInfo and destroyed when the
63 /// MachineModuleInfo is destroyed.
64 class MachineModuleInfoImpl {
66 typedef PointerIntPair<MCSymbol*, 1, bool> StubValueTy;
67 virtual ~MachineModuleInfoImpl();
68 typedef std::vector<std::pair<MCSymbol*, StubValueTy> > SymbolListTy;
70 static SymbolListTy GetSortedStubs(const DenseMap<MCSymbol*, StubValueTy>&);
75 //===----------------------------------------------------------------------===//
76 /// LandingPadInfo - This structure is used to retain landing pad info for
77 /// the current function.
79 struct LandingPadInfo {
80 MachineBasicBlock *LandingPadBlock; // Landing pad block.
81 SmallVector<MCSymbol*, 1> BeginLabels; // Labels prior to invoke.
82 SmallVector<MCSymbol*, 1> EndLabels; // Labels after invoke.
83 MCSymbol *LandingPadLabel; // Label at beginning of landing pad.
84 Function *Personality; // Personality function.
85 std::vector<int> TypeIds; // List of type ids (filters negative)
87 explicit LandingPadInfo(MachineBasicBlock *MBB)
88 : LandingPadBlock(MBB), LandingPadLabel(0), Personality(0) {}
91 class MMIAddrLabelMap;
93 //===----------------------------------------------------------------------===//
94 /// MachineModuleInfo - This class contains meta information specific to a
95 /// module. Queries can be made by different debugging and exception handling
96 /// schemes and reformated for specific use.
98 class MachineModuleInfo : public ImmutablePass {
99 /// Context - This is the MCContext used for the entire code generator.
102 /// ObjFileMMI - This is the object-file-format-specific implementation of
103 /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
105 MachineModuleInfoImpl *ObjFileMMI;
107 // FrameMoves - List of moves done by a function's prolog. Used to construct
108 // frame maps by debug and exception handling consumers.
109 std::vector<MachineMove> FrameMoves;
111 // LandingPads - List of LandingPadInfo describing the landing pad information
112 // in the current function.
113 std::vector<LandingPadInfo> LandingPads;
115 // Map of invoke call site index values to associated begin EH_LABEL for
116 // the current function.
117 DenseMap<MCSymbol*, unsigned> CallSiteMap;
119 // The current call site index being processed, if any. 0 if none.
120 unsigned CurCallSite;
122 // TypeInfos - List of C++ TypeInfo used in the current function.
124 std::vector<GlobalVariable *> TypeInfos;
126 // FilterIds - List of typeids encoding filters used in the current function.
128 std::vector<unsigned> FilterIds;
130 // FilterEnds - List of the indices in FilterIds corresponding to filter
133 std::vector<unsigned> FilterEnds;
135 // Personalities - Vector of all personality functions ever seen. Used to emit
137 std::vector<Function *> Personalities;
139 /// UsedFunctions - The functions in the @llvm.used list in a more easily
140 /// searchable format. This does not include the functions in
141 /// llvm.compiler.used.
142 SmallPtrSet<const Function *, 32> UsedFunctions;
145 /// AddrLabelSymbols - This map keeps track of which symbol is being used for
146 /// the specified basic block's address of label.
147 MMIAddrLabelMap *AddrLabelSymbols;
150 bool CallsUnwindInit;
152 /// DbgInfoAvailable - True if debugging information is available
154 bool DbgInfoAvailable;
157 static char ID; // Pass identification, replacement for typeid
159 typedef std::pair<unsigned, TrackingVH<MDNode> > UnsignedAndMDNodePair;
160 typedef SmallVector< std::pair<TrackingVH<MDNode>, UnsignedAndMDNodePair>, 4>
161 VariableDbgInfoMapTy;
162 VariableDbgInfoMapTy VariableDbgInfo;
164 MachineModuleInfo(); // DUMMY CONSTRUCTOR, DO NOT CALL.
165 MachineModuleInfo(const MCAsmInfo &MAI); // Real constructor.
166 ~MachineModuleInfo();
168 bool doInitialization();
169 bool doFinalization();
171 /// EndFunction - Discard function meta information.
175 const MCContext &getContext() const { return Context; }
176 MCContext &getContext() { return Context; }
178 /// getInfo - Keep track of various per-function pieces of information for
179 /// backends that would like to do so.
181 template<typename Ty>
182 Ty &getObjFileInfo() {
184 ObjFileMMI = new Ty(*this);
185 return *static_cast<Ty*>(ObjFileMMI);
188 template<typename Ty>
189 const Ty &getObjFileInfo() const {
190 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
193 /// AnalyzeModule - Scan the module for global debug information.
195 void AnalyzeModule(Module &M);
197 /// hasDebugInfo - Returns true if valid debug info is present.
199 bool hasDebugInfo() const { return DbgInfoAvailable; }
200 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
202 bool callsEHReturn() const { return CallsEHReturn; }
203 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
205 bool callsUnwindInit() const { return CallsUnwindInit; }
206 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
208 /// getFrameMoves - Returns a reference to a list of moves done in the current
209 /// function's prologue. Used to construct frame maps for debug and exception
210 /// handling comsumers.
211 std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
213 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
214 /// block when its address is taken. This cannot be its normal LBB label
215 /// because the block may be accessed outside its containing function.
216 MCSymbol *getAddrLabelSymbol(const BasicBlock *BB);
218 //===- EH ---------------------------------------------------------------===//
220 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
221 /// specified MachineBasicBlock.
222 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
224 /// addInvoke - Provide the begin and end labels of an invoke style call and
225 /// associate it with a try landing pad block.
226 void addInvoke(MachineBasicBlock *LandingPad,
227 MCSymbol *BeginLabel, MCSymbol *EndLabel);
229 /// addLandingPad - Add a new panding pad. Returns the label ID for the
230 /// landing pad entry.
231 MCSymbol *addLandingPad(MachineBasicBlock *LandingPad);
233 /// addPersonality - Provide the personality function for the exception
235 void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
237 /// getPersonalityIndex - Get index of the current personality function inside
238 /// Personalitites array
239 unsigned getPersonalityIndex() const;
241 /// getPersonalities - Return array of personality functions ever seen.
242 const std::vector<Function *>& getPersonalities() const {
243 return Personalities;
246 /// isUsedFunction - Return true if the functions in the llvm.used list. This
247 /// does not return true for things in llvm.compiler.used unless they are also
249 bool isUsedFunction(const Function *F) {
250 return UsedFunctions.count(F);
253 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
255 void addCatchTypeInfo(MachineBasicBlock *LandingPad,
256 std::vector<GlobalVariable *> &TyInfo);
258 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
260 void addFilterTypeInfo(MachineBasicBlock *LandingPad,
261 std::vector<GlobalVariable *> &TyInfo);
263 /// addCleanup - Add a cleanup action for a landing pad.
265 void addCleanup(MachineBasicBlock *LandingPad);
267 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
269 unsigned getTypeIDFor(GlobalVariable *TI);
271 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is
273 int getFilterIDFor(std::vector<unsigned> &TyIds);
275 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
277 void TidyLandingPads();
279 /// getLandingPads - Return a reference to the landing pad info for the
280 /// current function.
281 const std::vector<LandingPadInfo> &getLandingPads() const {
285 /// setCallSiteBeginLabel - Map the begin label for a call site
286 void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) {
287 CallSiteMap[BeginLabel] = Site;
290 /// getCallSiteBeginLabel - Get the call site number for a begin label
291 unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) {
292 assert(CallSiteMap.count(BeginLabel) &&
293 "Missing call site number for EH_LABEL!");
294 return CallSiteMap[BeginLabel];
297 /// setCurrentCallSite - Set the call site currently being processed.
298 void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
300 /// getCurrentCallSite - Get the call site currently being processed, if any.
301 /// return zero if none.
302 unsigned getCurrentCallSite(void) { return CurCallSite; }
304 /// getTypeInfos - Return a reference to the C++ typeinfo for the current
306 const std::vector<GlobalVariable *> &getTypeInfos() const {
310 /// getFilterIds - Return a reference to the typeids encoding filters used in
311 /// the current function.
312 const std::vector<unsigned> &getFilterIds() const {
316 /// getPersonality - Return a personality function if available. The presence
317 /// of one is required to emit exception handling info.
318 Function *getPersonality() const;
320 /// setVariableDbgInfo - Collect information used to emit debugging information
322 void setVariableDbgInfo(MDNode *N, unsigned Slot, MDNode *Scope) {
323 VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Scope)));
326 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfo; }
328 }; // End class MachineModuleInfo
330 } // End llvm namespace