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/MC/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/Support/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 MMIAddrLabelMap;
56 class MachineBasicBlock;
57 class MachineFunction;
62 //===----------------------------------------------------------------------===//
63 /// LandingPadInfo - This structure is used to retain landing pad info for
64 /// the current function.
66 struct LandingPadInfo {
67 MachineBasicBlock *LandingPadBlock; // Landing pad block.
68 SmallVector<MCSymbol*, 1> BeginLabels; // Labels prior to invoke.
69 SmallVector<MCSymbol*, 1> EndLabels; // Labels after invoke.
70 MCSymbol *LandingPadLabel; // Label at beginning of landing pad.
71 const Function *Personality; // Personality function.
72 std::vector<int> TypeIds; // List of type ids (filters negative)
74 explicit LandingPadInfo(MachineBasicBlock *MBB)
75 : LandingPadBlock(MBB), LandingPadLabel(0), Personality(0) {}
78 //===----------------------------------------------------------------------===//
79 /// MachineModuleInfoImpl - This class can be derived from and used by targets
80 /// to hold private target-specific information for each Module. Objects of
81 /// type are accessed/created with MMI::getInfo and destroyed when the
82 /// MachineModuleInfo is destroyed.
84 class MachineModuleInfoImpl {
86 typedef PointerIntPair<MCSymbol*, 1, bool> StubValueTy;
87 virtual ~MachineModuleInfoImpl();
88 typedef std::vector<std::pair<MCSymbol*, StubValueTy> > SymbolListTy;
90 static SymbolListTy GetSortedStubs(const DenseMap<MCSymbol*, StubValueTy>&);
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 /// TheModule - This is the LLVM Module being worked on.
103 const Module *TheModule;
105 /// ObjFileMMI - This is the object-file-format-specific implementation of
106 /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
108 MachineModuleInfoImpl *ObjFileMMI;
110 /// FrameMoves - List of moves done by a function's prolog. Used to construct
111 /// frame maps by debug and exception handling consumers.
112 std::vector<MachineMove> FrameMoves;
114 /// CompactUnwindEncoding - If the target supports it, this is the compact
115 /// unwind encoding. It replaces a function's CIE and FDE.
116 uint32_t CompactUnwindEncoding;
118 /// LandingPads - List of LandingPadInfo describing the landing pad
119 /// information in the current function.
120 std::vector<LandingPadInfo> LandingPads;
122 /// CallSiteMap - Map of invoke call site index values to associated begin
123 /// EH_LABEL for the current function.
124 DenseMap<MCSymbol*, unsigned> CallSiteMap;
126 /// CurCallSite - The current call site index being processed, if any. 0 if
128 unsigned CurCallSite;
130 /// TypeInfos - List of C++ TypeInfo used in the current function.
131 std::vector<const GlobalVariable *> TypeInfos;
133 /// FilterIds - List of typeids encoding filters used in the current function.
134 std::vector<unsigned> FilterIds;
136 /// FilterEnds - List of the indices in FilterIds corresponding to filter
138 std::vector<unsigned> FilterEnds;
140 /// Personalities - Vector of all personality functions ever seen. Used to
141 /// emit common EH frames.
142 std::vector<const Function *> Personalities;
144 /// UsedFunctions - The functions in the @llvm.used list in a more easily
145 /// searchable format. This does not include the functions in
146 /// llvm.compiler.used.
147 SmallPtrSet<const Function *, 32> UsedFunctions;
149 /// AddrLabelSymbols - This map keeps track of which symbol is being used for
150 /// the specified basic block's address of label.
151 MMIAddrLabelMap *AddrLabelSymbols;
154 bool CallsUnwindInit;
156 /// DbgInfoAvailable - True if debugging information is available
158 bool DbgInfoAvailable;
160 /// CallsExternalVAFunctionWithFloatingPointArguments - True if this module
161 /// calls VarArg function with floating point arguments. This is used to emit
162 /// an undefined reference to fltused on Windows targets.
163 bool CallsExternalVAFunctionWithFloatingPointArguments;
166 static char ID; // Pass identification, replacement for typeid
168 typedef std::pair<unsigned, DebugLoc> UnsignedDebugLocPair;
169 typedef SmallVector<std::pair<TrackingVH<MDNode>, UnsignedDebugLocPair>, 4>
170 VariableDbgInfoMapTy;
171 VariableDbgInfoMapTy VariableDbgInfo;
173 MachineModuleInfo(); // DUMMY CONSTRUCTOR, DO NOT CALL.
175 MachineModuleInfo(const MCAsmInfo &MAI, const MCRegisterInfo &MRI,
176 const MCObjectFileInfo *MOFI);
177 ~MachineModuleInfo();
179 bool doInitialization();
180 bool doFinalization();
182 /// EndFunction - Discard function meta information.
186 const MCContext &getContext() const { return Context; }
187 MCContext &getContext() { return Context; }
189 void setModule(const Module *M) { TheModule = M; }
190 const Module *getModule() const { return TheModule; }
192 /// getInfo - Keep track of various per-function pieces of information for
193 /// backends that would like to do so.
195 template<typename Ty>
196 Ty &getObjFileInfo() {
198 ObjFileMMI = new Ty(*this);
199 return *static_cast<Ty*>(ObjFileMMI);
202 template<typename Ty>
203 const Ty &getObjFileInfo() const {
204 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
207 /// AnalyzeModule - Scan the module for global debug information.
209 void AnalyzeModule(const Module &M);
211 /// hasDebugInfo - Returns true if valid debug info is present.
213 bool hasDebugInfo() const { return DbgInfoAvailable; }
214 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = avail; }
216 bool callsEHReturn() const { return CallsEHReturn; }
217 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
219 bool callsUnwindInit() const { return CallsUnwindInit; }
220 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
222 bool callsExternalVAFunctionWithFloatingPointArguments() const {
223 return CallsExternalVAFunctionWithFloatingPointArguments;
226 void setCallsExternalVAFunctionWithFloatingPointArguments(bool b) {
227 CallsExternalVAFunctionWithFloatingPointArguments = b;
230 /// getFrameMoves - Returns a reference to a list of moves done in the current
231 /// function's prologue. Used to construct frame maps for debug and exception
232 /// handling comsumers.
233 std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
235 /// getCompactUnwindEncoding - Returns the compact unwind encoding for a
236 /// function if the target supports the encoding. This encoding replaces a
237 /// function's CIE and FDE.
238 uint32_t getCompactUnwindEncoding() const { return CompactUnwindEncoding; }
240 /// setCompactUnwindEncoding - Set the compact unwind encoding for a function
241 /// if the target supports the encoding.
242 void setCompactUnwindEncoding(uint32_t Enc) { CompactUnwindEncoding = Enc; }
244 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
245 /// block when its address is taken. This cannot be its normal LBB label
246 /// because the block may be accessed outside its containing function.
247 MCSymbol *getAddrLabelSymbol(const BasicBlock *BB);
249 /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
250 /// basic block when its address is taken. If other blocks were RAUW'd to
251 /// this one, we may have to emit them as well, return the whole set.
252 std::vector<MCSymbol*> getAddrLabelSymbolToEmit(const BasicBlock *BB);
254 /// takeDeletedSymbolsForFunction - If the specified function has had any
255 /// references to address-taken blocks generated, but the block got deleted,
256 /// return the symbol now so we can emit it. This prevents emitting a
257 /// reference to a symbol that has no definition.
258 void takeDeletedSymbolsForFunction(const Function *F,
259 std::vector<MCSymbol*> &Result);
262 //===- EH ---------------------------------------------------------------===//
264 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
265 /// specified MachineBasicBlock.
266 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
268 /// addInvoke - Provide the begin and end labels of an invoke style call and
269 /// associate it with a try landing pad block.
270 void addInvoke(MachineBasicBlock *LandingPad,
271 MCSymbol *BeginLabel, MCSymbol *EndLabel);
273 /// addLandingPad - Add a new panding pad. Returns the label ID for the
274 /// landing pad entry.
275 MCSymbol *addLandingPad(MachineBasicBlock *LandingPad);
277 /// addPersonality - Provide the personality function for the exception
279 void addPersonality(MachineBasicBlock *LandingPad,
280 const Function *Personality);
282 /// getPersonalityIndex - Get index of the current personality function inside
283 /// Personalitites array
284 unsigned getPersonalityIndex() const;
286 /// getPersonalities - Return array of personality functions ever seen.
287 const std::vector<const Function *>& getPersonalities() const {
288 return Personalities;
291 /// isUsedFunction - Return true if the functions in the llvm.used list. This
292 /// does not return true for things in llvm.compiler.used unless they are also
294 bool isUsedFunction(const Function *F) {
295 return UsedFunctions.count(F);
298 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
300 void addCatchTypeInfo(MachineBasicBlock *LandingPad,
301 ArrayRef<const GlobalVariable *> TyInfo);
303 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
305 void addFilterTypeInfo(MachineBasicBlock *LandingPad,
306 ArrayRef<const GlobalVariable *> TyInfo);
308 /// addCleanup - Add a cleanup action for a landing pad.
310 void addCleanup(MachineBasicBlock *LandingPad);
312 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
314 unsigned getTypeIDFor(const GlobalVariable *TI);
316 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is
318 int getFilterIDFor(std::vector<unsigned> &TyIds);
320 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
322 void TidyLandingPads(DenseMap<MCSymbol*, uintptr_t> *LPMap = 0);
324 /// getLandingPads - Return a reference to the landing pad info for the
325 /// current function.
326 const std::vector<LandingPadInfo> &getLandingPads() const {
330 /// setCallSiteBeginLabel - Map the begin label for a call site.
331 void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) {
332 CallSiteMap[BeginLabel] = Site;
335 /// getCallSiteBeginLabel - Get the call site number for a begin label.
336 unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) {
337 assert(hasCallSiteBeginLabel(BeginLabel) &&
338 "Missing call site number for EH_LABEL!");
339 return CallSiteMap[BeginLabel];
342 /// hasCallSiteBeginLabel - Return true if the begin label has a call site
343 /// number associated with it.
344 bool hasCallSiteBeginLabel(MCSymbol *BeginLabel) {
345 return CallSiteMap[BeginLabel] != 0;
348 /// setCurrentCallSite - Set the call site currently being processed.
349 void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
351 /// getCurrentCallSite - Get the call site currently being processed, if any.
352 /// return zero if none.
353 unsigned getCurrentCallSite(void) { return CurCallSite; }
355 /// getTypeInfos - Return a reference to the C++ typeinfo for the current
357 const std::vector<const GlobalVariable *> &getTypeInfos() const {
361 /// getFilterIds - Return a reference to the typeids encoding filters used in
362 /// the current function.
363 const std::vector<unsigned> &getFilterIds() const {
367 /// getPersonality - Return a personality function if available. The presence
368 /// of one is required to emit exception handling info.
369 const Function *getPersonality() const;
371 /// setVariableDbgInfo - Collect information used to emit debugging
372 /// information of a variable.
373 void setVariableDbgInfo(MDNode *N, unsigned Slot, DebugLoc Loc) {
374 VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Loc)));
377 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfo; }
379 }; // End class MachineModuleInfo
381 } // End llvm namespace