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/ADT/DenseMap.h"
35 #include "llvm/ADT/PointerIntPair.h"
36 #include "llvm/ADT/SmallPtrSet.h"
37 #include "llvm/ADT/SmallVector.h"
38 #include "llvm/Analysis/LibCallSemantics.h"
39 #include "llvm/IR/DebugLoc.h"
40 #include "llvm/IR/Metadata.h"
41 #include "llvm/IR/ValueHandle.h"
42 #include "llvm/MC/MCContext.h"
43 #include "llvm/MC/MachineLocation.h"
44 #include "llvm/Pass.h"
45 #include "llvm/Support/DataTypes.h"
46 #include "llvm/Support/Dwarf.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 SmallVector<MCSymbol*, 1> ClauseLabels; // Labels for each clause.
71 MCSymbol *LandingPadLabel; // Label at beginning of landing pad.
72 const Function *Personality; // Personality function.
73 std::vector<int> TypeIds; // List of type ids (filters negative)
75 explicit LandingPadInfo(MachineBasicBlock *MBB)
76 : LandingPadBlock(MBB), LandingPadLabel(nullptr), Personality(nullptr) {}
79 //===----------------------------------------------------------------------===//
80 /// MachineModuleInfoImpl - This class can be derived from and used by targets
81 /// to hold private target-specific information for each Module. Objects of
82 /// type are accessed/created with MMI::getInfo and destroyed when the
83 /// MachineModuleInfo is destroyed.
85 class MachineModuleInfoImpl {
87 typedef PointerIntPair<MCSymbol*, 1, bool> StubValueTy;
88 virtual ~MachineModuleInfoImpl();
89 typedef std::vector<std::pair<MCSymbol*, StubValueTy> > SymbolListTy;
91 static SymbolListTy GetSortedStubs(const DenseMap<MCSymbol*, StubValueTy>&);
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 /// TheModule - This is the LLVM Module being worked on.
104 const Module *TheModule;
106 /// ObjFileMMI - This is the object-file-format-specific implementation of
107 /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
109 MachineModuleInfoImpl *ObjFileMMI;
111 /// List of moves done by a function's prolog. Used to construct frame maps
112 /// by debug and exception handling consumers.
113 std::vector<MCCFIInstruction> FrameInstructions;
115 /// LandingPads - List of LandingPadInfo describing the landing pad
116 /// information in the current function.
117 std::vector<LandingPadInfo> LandingPads;
119 /// LPadToCallSiteMap - Map a landing pad's EH symbol to the call site
121 DenseMap<MCSymbol*, SmallVector<unsigned, 4> > LPadToCallSiteMap;
123 /// CallSiteMap - Map of invoke call site index values to associated begin
124 /// EH_LABEL for the current function.
125 DenseMap<MCSymbol*, unsigned> CallSiteMap;
127 /// CurCallSite - The current call site index being processed, if any. 0 if
129 unsigned CurCallSite;
131 /// TypeInfos - List of C++ TypeInfo used in the current function.
132 std::vector<const GlobalValue *> TypeInfos;
134 /// FilterIds - List of typeids encoding filters used in the current function.
135 std::vector<unsigned> FilterIds;
137 /// FilterEnds - List of the indices in FilterIds corresponding to filter
139 std::vector<unsigned> FilterEnds;
141 /// Personalities - Vector of all personality functions ever seen. Used to
142 /// emit common EH frames.
143 std::vector<const Function *> Personalities;
145 /// UsedFunctions - The functions in the @llvm.used list in a more easily
146 /// searchable format. This does not include the functions in
147 /// llvm.compiler.used.
148 SmallPtrSet<const Function *, 32> UsedFunctions;
150 /// AddrLabelSymbols - This map keeps track of which symbol is being used for
151 /// the specified basic block's address of label.
152 MMIAddrLabelMap *AddrLabelSymbols;
155 bool CallsUnwindInit;
157 /// DbgInfoAvailable - True if debugging information is available
159 bool DbgInfoAvailable;
161 /// UsesVAFloatArgument - True if this module calls VarArg function with
162 /// floating-point arguments. This is used to emit an undefined reference
163 /// to _fltused on Windows targets.
164 bool UsesVAFloatArgument;
166 /// UsesMorestackAddr - True if the module calls the __morestack function
167 /// indirectly, as is required under the large code model on x86. This is used
168 /// to emit a definition of a symbol, __morestack_addr, containing the
169 /// address. See comments in lib/Target/X86/X86FrameLowering.cpp for more
171 bool UsesMorestackAddr;
173 EHPersonality PersonalityTypeCache;
176 static char ID; // Pass identification, replacement for typeid
178 struct VariableDbgInfo {
179 TrackingMDNodeRef Var;
180 TrackingMDNodeRef Expr;
184 VariableDbgInfo(MDNode *Var, MDNode *Expr, unsigned Slot, DebugLoc Loc)
185 : Var(Var), Expr(Expr), Slot(Slot), Loc(Loc) {}
187 typedef SmallVector<VariableDbgInfo, 4> VariableDbgInfoMapTy;
188 VariableDbgInfoMapTy VariableDbgInfos;
190 MachineModuleInfo(); // DUMMY CONSTRUCTOR, DO NOT CALL.
192 MachineModuleInfo(const MCAsmInfo &MAI, const MCRegisterInfo &MRI,
193 const MCObjectFileInfo *MOFI);
194 ~MachineModuleInfo();
196 // Initialization and Finalization
197 bool doInitialization(Module &) override;
198 bool doFinalization(Module &) override;
200 /// EndFunction - Discard function meta information.
204 const MCContext &getContext() const { return Context; }
205 MCContext &getContext() { return Context; }
207 void setModule(const Module *M) { TheModule = M; }
208 const Module *getModule() const { return TheModule; }
210 /// getInfo - Keep track of various per-function pieces of information for
211 /// backends that would like to do so.
213 template<typename Ty>
214 Ty &getObjFileInfo() {
215 if (ObjFileMMI == nullptr)
216 ObjFileMMI = new Ty(*this);
217 return *static_cast<Ty*>(ObjFileMMI);
220 template<typename Ty>
221 const Ty &getObjFileInfo() const {
222 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
225 /// AnalyzeModule - Scan the module for global debug information.
227 void AnalyzeModule(const Module &M);
229 /// hasDebugInfo - Returns true if valid debug info is present.
231 bool hasDebugInfo() const { return DbgInfoAvailable; }
232 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = avail; }
234 bool callsEHReturn() const { return CallsEHReturn; }
235 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
237 bool callsUnwindInit() const { return CallsUnwindInit; }
238 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
240 bool usesVAFloatArgument() const {
241 return UsesVAFloatArgument;
244 void setUsesVAFloatArgument(bool b) {
245 UsesVAFloatArgument = b;
248 bool usesMorestackAddr() const {
249 return UsesMorestackAddr;
252 void setUsesMorestackAddr(bool b) {
253 UsesMorestackAddr = b;
256 /// \brief Returns a reference to a list of cfi instructions in the current
257 /// function's prologue. Used to construct frame maps for debug and exception
258 /// handling comsumers.
259 const std::vector<MCCFIInstruction> &getFrameInstructions() const {
260 return FrameInstructions;
263 unsigned LLVM_ATTRIBUTE_UNUSED_RESULT
264 addFrameInst(const MCCFIInstruction &Inst) {
265 FrameInstructions.push_back(Inst);
266 return FrameInstructions.size() - 1;
269 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
270 /// block when its address is taken. This cannot be its normal LBB label
271 /// because the block may be accessed outside its containing function.
272 MCSymbol *getAddrLabelSymbol(const BasicBlock *BB);
274 /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
275 /// basic block when its address is taken. If other blocks were RAUW'd to
276 /// this one, we may have to emit them as well, return the whole set.
277 std::vector<MCSymbol*> getAddrLabelSymbolToEmit(const BasicBlock *BB);
279 /// takeDeletedSymbolsForFunction - If the specified function has had any
280 /// references to address-taken blocks generated, but the block got deleted,
281 /// return the symbol now so we can emit it. This prevents emitting a
282 /// reference to a symbol that has no definition.
283 void takeDeletedSymbolsForFunction(const Function *F,
284 std::vector<MCSymbol*> &Result);
287 //===- EH ---------------------------------------------------------------===//
289 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
290 /// specified MachineBasicBlock.
291 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
293 /// addInvoke - Provide the begin and end labels of an invoke style call and
294 /// associate it with a try landing pad block.
295 void addInvoke(MachineBasicBlock *LandingPad,
296 MCSymbol *BeginLabel, MCSymbol *EndLabel);
298 /// addLandingPad - Add a new panding pad. Returns the label ID for the
299 /// landing pad entry.
300 MCSymbol *addLandingPad(MachineBasicBlock *LandingPad);
302 /// addPersonality - Provide the personality function for the exception
304 void addPersonality(MachineBasicBlock *LandingPad,
305 const Function *Personality);
307 /// getPersonalityIndex - Get index of the current personality function inside
308 /// Personalitites array
309 unsigned getPersonalityIndex() const;
311 /// getPersonalities - Return array of personality functions ever seen.
312 const std::vector<const Function *>& getPersonalities() const {
313 return Personalities;
316 /// isUsedFunction - Return true if the functions in the llvm.used list. This
317 /// does not return true for things in llvm.compiler.used unless they are also
319 bool isUsedFunction(const Function *F) const {
320 return UsedFunctions.count(F);
323 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
325 void addCatchTypeInfo(MachineBasicBlock *LandingPad,
326 ArrayRef<const GlobalValue *> TyInfo);
328 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
330 void addFilterTypeInfo(MachineBasicBlock *LandingPad,
331 ArrayRef<const GlobalValue *> TyInfo);
333 /// addCleanup - Add a cleanup action for a landing pad.
335 void addCleanup(MachineBasicBlock *LandingPad);
337 /// Add a clause for a landing pad. Returns a new label for the clause. This
338 /// is used by EH schemes that have more than one landing pad. In this case,
339 /// each clause gets its own basic block.
340 MCSymbol *addClauseForLandingPad(MachineBasicBlock *LandingPad);
342 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
344 unsigned getTypeIDFor(const GlobalValue *TI);
346 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is
348 int getFilterIDFor(std::vector<unsigned> &TyIds);
350 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
352 void TidyLandingPads(DenseMap<MCSymbol*, uintptr_t> *LPMap = nullptr);
354 /// getLandingPads - Return a reference to the landing pad info for the
355 /// current function.
356 const std::vector<LandingPadInfo> &getLandingPads() const {
360 /// setCallSiteLandingPad - Map the landing pad's EH symbol to the call
362 void setCallSiteLandingPad(MCSymbol *Sym, ArrayRef<unsigned> Sites);
364 /// getCallSiteLandingPad - Get the call site indexes for a landing pad EH
366 SmallVectorImpl<unsigned> &getCallSiteLandingPad(MCSymbol *Sym) {
367 assert(hasCallSiteLandingPad(Sym) &&
368 "missing call site number for landing pad!");
369 return LPadToCallSiteMap[Sym];
372 /// hasCallSiteLandingPad - Return true if the landing pad Eh symbol has an
373 /// associated call site.
374 bool hasCallSiteLandingPad(MCSymbol *Sym) {
375 return !LPadToCallSiteMap[Sym].empty();
378 /// setCallSiteBeginLabel - Map the begin label for a call site.
379 void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) {
380 CallSiteMap[BeginLabel] = Site;
383 /// getCallSiteBeginLabel - Get the call site number for a begin label.
384 unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) {
385 assert(hasCallSiteBeginLabel(BeginLabel) &&
386 "Missing call site number for EH_LABEL!");
387 return CallSiteMap[BeginLabel];
390 /// hasCallSiteBeginLabel - Return true if the begin label has a call site
391 /// number associated with it.
392 bool hasCallSiteBeginLabel(MCSymbol *BeginLabel) {
393 return CallSiteMap[BeginLabel] != 0;
396 /// setCurrentCallSite - Set the call site currently being processed.
397 void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
399 /// getCurrentCallSite - Get the call site currently being processed, if any.
400 /// return zero if none.
401 unsigned getCurrentCallSite() { return CurCallSite; }
403 /// getTypeInfos - Return a reference to the C++ typeinfo for the current
405 const std::vector<const GlobalValue *> &getTypeInfos() const {
409 /// getFilterIds - Return a reference to the typeids encoding filters used in
410 /// the current function.
411 const std::vector<unsigned> &getFilterIds() const {
415 /// getPersonality - Return a personality function if available. The presence
416 /// of one is required to emit exception handling info.
417 const Function *getPersonality() const;
419 /// Classify the personality function amongst known EH styles.
420 EHPersonality getPersonalityType();
422 /// setVariableDbgInfo - Collect information used to emit debugging
423 /// information of a variable.
424 void setVariableDbgInfo(MDNode *Var, MDNode *Expr, unsigned Slot,
426 VariableDbgInfos.emplace_back(Var, Expr, Slot, Loc);
429 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfos; }
431 }; // End class MachineModuleInfo
433 } // End llvm namespace