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/DebugLoc.h"
41 #include "llvm/Support/ValueHandle.h"
42 #include "llvm/System/DataTypes.h"
43 #include "llvm/ADT/DenseMap.h"
44 #include "llvm/ADT/PointerIntPair.h"
45 #include "llvm/ADT/SmallPtrSet.h"
46 #include "llvm/ADT/SmallVector.h"
50 //===----------------------------------------------------------------------===//
51 // Forward declarations.
55 class MachineBasicBlock;
56 class MachineFunction;
61 /// MachineModuleInfoImpl - This class can be derived from and used by targets
62 /// to hold private target-specific information for each Module. Objects of
63 /// type are accessed/created with MMI::getInfo and destroyed when the
64 /// MachineModuleInfo is destroyed.
65 class MachineModuleInfoImpl {
67 typedef PointerIntPair<MCSymbol*, 1, bool> StubValueTy;
68 virtual ~MachineModuleInfoImpl();
69 typedef std::vector<std::pair<MCSymbol*, StubValueTy> > SymbolListTy;
71 static SymbolListTy GetSortedStubs(const DenseMap<MCSymbol*, StubValueTy>&);
76 //===----------------------------------------------------------------------===//
77 /// LandingPadInfo - This structure is used to retain landing pad info for
78 /// the current function.
80 struct LandingPadInfo {
81 MachineBasicBlock *LandingPadBlock; // Landing pad block.
82 SmallVector<MCSymbol*, 1> BeginLabels; // Labels prior to invoke.
83 SmallVector<MCSymbol*, 1> EndLabels; // Labels after invoke.
84 MCSymbol *LandingPadLabel; // Label at beginning of landing pad.
85 Function *Personality; // Personality function.
86 std::vector<int> TypeIds; // List of type ids (filters negative)
88 explicit LandingPadInfo(MachineBasicBlock *MBB)
89 : LandingPadBlock(MBB), LandingPadLabel(0), Personality(0) {}
92 class MMIAddrLabelMap;
94 //===----------------------------------------------------------------------===//
95 /// MachineModuleInfo - This class contains meta information specific to a
96 /// module. Queries can be made by different debugging and exception handling
97 /// schemes and reformated for specific use.
99 class MachineModuleInfo : public ImmutablePass {
100 /// Context - This is the MCContext used for the entire code generator.
103 /// ObjFileMMI - This is the object-file-format-specific implementation of
104 /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
106 MachineModuleInfoImpl *ObjFileMMI;
108 // FrameMoves - List of moves done by a function's prolog. Used to construct
109 // frame maps by debug and exception handling consumers.
110 std::vector<MachineMove> FrameMoves;
112 // LandingPads - List of LandingPadInfo describing the landing pad information
113 // in the current function.
114 std::vector<LandingPadInfo> LandingPads;
116 // Map of invoke call site index values to associated begin EH_LABEL for
117 // the current function.
118 DenseMap<MCSymbol*, unsigned> CallSiteMap;
120 // The current call site index being processed, if any. 0 if none.
121 unsigned CurCallSite;
123 // TypeInfos - List of C++ TypeInfo used in the current function.
125 std::vector<GlobalVariable *> TypeInfos;
127 // FilterIds - List of typeids encoding filters used in the current function.
129 std::vector<unsigned> FilterIds;
131 // FilterEnds - List of the indices in FilterIds corresponding to filter
134 std::vector<unsigned> FilterEnds;
136 // Personalities - Vector of all personality functions ever seen. Used to emit
138 std::vector<Function *> Personalities;
140 /// UsedFunctions - The functions in the @llvm.used list in a more easily
141 /// searchable format. This does not include the functions in
142 /// llvm.compiler.used.
143 SmallPtrSet<const Function *, 32> UsedFunctions;
146 /// AddrLabelSymbols - This map keeps track of which symbol is being used for
147 /// the specified basic block's address of label.
148 MMIAddrLabelMap *AddrLabelSymbols;
151 bool CallsUnwindInit;
153 /// DbgInfoAvailable - True if debugging information is available
155 bool DbgInfoAvailable;
158 static char ID; // Pass identification, replacement for typeid
160 typedef std::pair<unsigned, DebugLoc> UnsignedDebugLocPair;
161 typedef SmallVector<std::pair<TrackingVH<MDNode>, UnsignedDebugLocPair>, 4>
162 VariableDbgInfoMapTy;
163 VariableDbgInfoMapTy VariableDbgInfo;
165 MachineModuleInfo(); // DUMMY CONSTRUCTOR, DO NOT CALL.
166 MachineModuleInfo(const MCAsmInfo &MAI); // Real constructor.
167 ~MachineModuleInfo();
169 bool doInitialization();
170 bool doFinalization();
172 /// EndFunction - Discard function meta information.
176 const MCContext &getContext() const { return Context; }
177 MCContext &getContext() { return Context; }
179 /// getInfo - Keep track of various per-function pieces of information for
180 /// backends that would like to do so.
182 template<typename Ty>
183 Ty &getObjFileInfo() {
185 ObjFileMMI = new Ty(*this);
186 return *static_cast<Ty*>(ObjFileMMI);
189 template<typename Ty>
190 const Ty &getObjFileInfo() const {
191 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
194 /// AnalyzeModule - Scan the module for global debug information.
196 void AnalyzeModule(Module &M);
198 /// hasDebugInfo - Returns true if valid debug info is present.
200 bool hasDebugInfo() const { return DbgInfoAvailable; }
201 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
203 bool callsEHReturn() const { return CallsEHReturn; }
204 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
206 bool callsUnwindInit() const { return CallsUnwindInit; }
207 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
209 /// getFrameMoves - Returns a reference to a list of moves done in the current
210 /// function's prologue. Used to construct frame maps for debug and exception
211 /// handling comsumers.
212 std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
214 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
215 /// block when its address is taken. This cannot be its normal LBB label
216 /// because the block may be accessed outside its containing function.
217 MCSymbol *getAddrLabelSymbol(const BasicBlock *BB);
219 /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
220 /// basic block when its address is taken. If other blocks were RAUW'd to
221 /// this one, we may have to emit them as well, return the whole set.
222 std::vector<MCSymbol*> getAddrLabelSymbolToEmit(const BasicBlock *BB);
224 /// takeDeletedSymbolsForFunction - If the specified function has had any
225 /// references to address-taken blocks generated, but the block got deleted,
226 /// return the symbol now so we can emit it. This prevents emitting a
227 /// reference to a symbol that has no definition.
228 void takeDeletedSymbolsForFunction(const Function *F,
229 std::vector<MCSymbol*> &Result);
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 MCSymbol *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
335 /// information of a variable.
336 void setVariableDbgInfo(MDNode *N, unsigned Slot, DebugLoc Loc) {
337 VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Loc)));
340 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfo; }
342 }; // End class MachineModuleInfo
344 } // End llvm namespace