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 //===----------------------------------------------------------------------===//
92 /// MachineModuleInfo - This class contains meta information specific to a
93 /// module. Queries can be made by different debugging and exception handling
94 /// schemes and reformated for specific use.
96 class MachineModuleInfo : public ImmutablePass {
97 /// Context - This is the MCContext used for the entire code generator.
100 /// ObjFileMMI - This is the object-file-format-specific implementation of
101 /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
103 MachineModuleInfoImpl *ObjFileMMI;
105 // LabelIDList - One entry per assigned label. Normally the entry is equal to
106 // the list index(+1). If the entry is zero then the label has been deleted.
107 // Any other value indicates the label has been deleted by is mapped to
109 std::vector<unsigned> LabelIDList;
111 // FrameMoves - List of moves done by a function's prolog. Used to construct
112 // frame maps by debug and exception handling consumers.
113 std::vector<MachineMove> FrameMoves;
115 // LandingPads - List of LandingPadInfo describing the landing pad information
116 // in the current function.
117 std::vector<LandingPadInfo> LandingPads;
119 // Map of invoke call site index values to associated begin EH_LABEL for
120 // the current function.
121 DenseMap<MCSymbol*, unsigned> CallSiteMap;
123 // The current call site index being processed, if any. 0 if none.
124 unsigned CurCallSite;
126 // TypeInfos - List of C++ TypeInfo used in the current function.
128 std::vector<GlobalVariable *> TypeInfos;
130 // FilterIds - List of typeids encoding filters used in the current function.
132 std::vector<unsigned> FilterIds;
134 // FilterEnds - List of the indices in FilterIds corresponding to filter
137 std::vector<unsigned> FilterEnds;
139 // Personalities - Vector of all personality functions ever seen. Used to emit
141 std::vector<Function *> Personalities;
143 /// UsedFunctions - The functions in the @llvm.used list in a more easily
144 /// searchable format. This does not include the functions in
145 /// llvm.compiler.used.
146 SmallPtrSet<const Function *, 32> UsedFunctions;
149 bool CallsUnwindInit;
151 /// DbgInfoAvailable - True if debugging information is available
153 bool DbgInfoAvailable;
156 static char ID; // Pass identification, replacement for typeid
158 typedef std::pair<unsigned, TrackingVH<MDNode> > UnsignedAndMDNodePair;
159 typedef SmallVector< std::pair<TrackingVH<MDNode>, UnsignedAndMDNodePair>, 4>
160 VariableDbgInfoMapTy;
161 VariableDbgInfoMapTy VariableDbgInfo;
163 MachineModuleInfo(); // DUMMY CONSTRUCTOR, DO NOT CALL.
164 MachineModuleInfo(const MCAsmInfo &MAI); // Real constructor.
165 ~MachineModuleInfo();
167 bool doInitialization();
168 bool doFinalization();
170 /// EndFunction - Discard function meta information.
174 const MCContext &getContext() const { return Context; }
175 MCContext &getContext() { return Context; }
177 /// getInfo - Keep track of various per-function pieces of information for
178 /// backends that would like to do so.
180 template<typename Ty>
181 Ty &getObjFileInfo() {
183 ObjFileMMI = new Ty(*this);
184 return *static_cast<Ty*>(ObjFileMMI);
187 template<typename Ty>
188 const Ty &getObjFileInfo() const {
189 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
192 /// AnalyzeModule - Scan the module for global debug information.
194 void AnalyzeModule(Module &M);
196 /// hasDebugInfo - Returns true if valid debug info is present.
198 bool hasDebugInfo() const { return DbgInfoAvailable; }
199 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
201 bool callsEHReturn() const { return CallsEHReturn; }
202 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
204 bool callsUnwindInit() const { return CallsUnwindInit; }
205 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
207 /// NextLabelID - Return the next unique label id.
209 unsigned NextLabelID() {
210 unsigned ID = (unsigned)LabelIDList.size() + 1;
211 LabelIDList.push_back(ID);
215 /// getLabelSym - Turn a label ID into a symbol.
216 MCSymbol *getLabelSym(unsigned ID);
218 /// InvalidateLabel - Inhibit use of the specified label # from
219 /// MachineModuleInfo, for example because the code was deleted.
220 void InvalidateLabel(unsigned LabelID) {
221 // Remap to zero to indicate deletion.
222 assert(0 < LabelID && LabelID <= LabelIDList.size() &&
223 "Old label ID out of range.");
224 LabelIDList[LabelID - 1] = 0;
227 /// getFrameMoves - Returns a reference to a list of moves done in the current
228 /// function's prologue. Used to construct frame maps for debug and exception
229 /// handling comsumers.
230 std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
232 //===-EH-----------------------------------------------------------------===//
234 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
235 /// specified MachineBasicBlock.
236 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
238 /// addInvoke - Provide the begin and end labels of an invoke style call and
239 /// associate it with a try landing pad block.
240 void addInvoke(MachineBasicBlock *LandingPad,
241 MCSymbol *BeginLabel, MCSymbol *EndLabel);
243 /// addLandingPad - Add a new panding pad. Returns the label ID for the
244 /// landing pad entry.
245 unsigned addLandingPad(MachineBasicBlock *LandingPad);
247 /// addPersonality - Provide the personality function for the exception
249 void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
251 /// getPersonalityIndex - Get index of the current personality function inside
252 /// Personalitites array
253 unsigned getPersonalityIndex() const;
255 /// getPersonalities - Return array of personality functions ever seen.
256 const std::vector<Function *>& getPersonalities() const {
257 return Personalities;
260 /// isUsedFunction - Return true if the functions in the llvm.used list. This
261 /// does not return true for things in llvm.compiler.used unless they are also
263 bool isUsedFunction(const Function *F) {
264 return UsedFunctions.count(F);
267 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
269 void addCatchTypeInfo(MachineBasicBlock *LandingPad,
270 std::vector<GlobalVariable *> &TyInfo);
272 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
274 void addFilterTypeInfo(MachineBasicBlock *LandingPad,
275 std::vector<GlobalVariable *> &TyInfo);
277 /// addCleanup - Add a cleanup action for a landing pad.
279 void addCleanup(MachineBasicBlock *LandingPad);
281 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
283 unsigned getTypeIDFor(GlobalVariable *TI);
285 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is
287 int getFilterIDFor(std::vector<unsigned> &TyIds);
289 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
291 void TidyLandingPads();
293 /// getLandingPads - Return a reference to the landing pad info for the
294 /// current function.
295 const std::vector<LandingPadInfo> &getLandingPads() const {
299 /// setCallSiteBeginLabel - Map the begin label for a call site
300 void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) {
301 CallSiteMap[BeginLabel] = Site;
304 /// getCallSiteBeginLabel - Get the call site number for a begin label
305 unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) {
306 assert(CallSiteMap.count(BeginLabel) &&
307 "Missing call site number for EH_LABEL!");
308 return CallSiteMap[BeginLabel];
311 /// setCurrentCallSite - Set the call site currently being processed.
312 void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
314 /// getCurrentCallSite - Get the call site currently being processed, if any.
315 /// return zero if none.
316 unsigned getCurrentCallSite(void) { return CurCallSite; }
318 /// getTypeInfos - Return a reference to the C++ typeinfo for the current
320 const std::vector<GlobalVariable *> &getTypeInfos() const {
324 /// getFilterIds - Return a reference to the typeids encoding filters used in
325 /// the current function.
326 const std::vector<unsigned> &getFilterIds() const {
330 /// getPersonality - Return a personality function if available. The presence
331 /// of one is required to emit exception handling info.
332 Function *getPersonality() const;
334 /// setVariableDbgInfo - Collect information used to emit debugging information
336 void setVariableDbgInfo(MDNode *N, unsigned Slot, MDNode *Scope) {
337 VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Scope)));
340 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfo; }
342 }; // End class MachineModuleInfo
344 } // End llvm namespace