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/IR/DebugLoc.h"
39 #include "llvm/IR/Metadata.h"
40 #include "llvm/IR/ValueHandle.h"
41 #include "llvm/MC/MCContext.h"
42 #include "llvm/MC/MachineLocation.h"
43 #include "llvm/Pass.h"
44 #include "llvm/Support/DataTypes.h"
45 #include "llvm/Support/Dwarf.h"
49 //===----------------------------------------------------------------------===//
50 // Forward declarations.
54 class MMIAddrLabelMap;
55 class MachineBasicBlock;
56 class MachineFunction;
61 //===----------------------------------------------------------------------===//
62 /// LandingPadInfo - This structure is used to retain landing pad info for
63 /// the current function.
65 struct LandingPadInfo {
66 MachineBasicBlock *LandingPadBlock; // Landing pad block.
67 SmallVector<MCSymbol*, 1> BeginLabels; // Labels prior to invoke.
68 SmallVector<MCSymbol*, 1> EndLabels; // Labels after invoke.
69 MCSymbol *LandingPadLabel; // Label at beginning of landing pad.
70 const Function *Personality; // Personality function.
71 std::vector<int> TypeIds; // List of type ids (filters negative)
73 explicit LandingPadInfo(MachineBasicBlock *MBB)
74 : LandingPadBlock(MBB), LandingPadLabel(nullptr), Personality(nullptr) {}
77 //===----------------------------------------------------------------------===//
78 /// MachineModuleInfoImpl - This class can be derived from and used by targets
79 /// to hold private target-specific information for each Module. Objects of
80 /// type are accessed/created with MMI::getInfo and destroyed when the
81 /// MachineModuleInfo is destroyed.
83 class MachineModuleInfoImpl {
85 typedef PointerIntPair<MCSymbol*, 1, bool> StubValueTy;
86 virtual ~MachineModuleInfoImpl();
87 typedef std::vector<std::pair<MCSymbol*, StubValueTy> > SymbolListTy;
89 static SymbolListTy GetSortedStubs(const DenseMap<MCSymbol*, StubValueTy>&);
92 //===----------------------------------------------------------------------===//
93 /// MachineModuleInfo - This class contains meta information specific to a
94 /// module. Queries can be made by different debugging and exception handling
95 /// schemes and reformated for specific use.
97 class MachineModuleInfo : public ImmutablePass {
98 /// Context - This is the MCContext used for the entire code generator.
101 /// TheModule - This is the LLVM Module being worked on.
102 const Module *TheModule;
104 /// ObjFileMMI - This is the object-file-format-specific implementation of
105 /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
107 MachineModuleInfoImpl *ObjFileMMI;
109 /// List of moves done by a function's prolog. Used to construct frame maps
110 /// by debug and exception handling consumers.
111 std::vector<MCCFIInstruction> FrameInstructions;
113 /// LandingPads - List of LandingPadInfo describing the landing pad
114 /// information in the current function.
115 std::vector<LandingPadInfo> LandingPads;
117 /// LPadToCallSiteMap - Map a landing pad's EH symbol to the call site
119 DenseMap<MCSymbol*, SmallVector<unsigned, 4> > LPadToCallSiteMap;
121 /// CallSiteMap - Map of invoke call site index values to associated begin
122 /// EH_LABEL for the current function.
123 DenseMap<MCSymbol*, unsigned> CallSiteMap;
125 /// CurCallSite - The current call site index being processed, if any. 0 if
127 unsigned CurCallSite;
129 /// TypeInfos - List of C++ TypeInfo used in the current function.
130 std::vector<const GlobalVariable *> TypeInfos;
132 /// FilterIds - List of typeids encoding filters used in the current function.
133 std::vector<unsigned> FilterIds;
135 /// 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
140 /// emit common EH frames.
141 std::vector<const 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;
148 /// AddrLabelSymbols - This map keeps track of which symbol is being used for
149 /// the specified basic block's address of label.
150 MMIAddrLabelMap *AddrLabelSymbols;
153 bool CallsUnwindInit;
155 /// DbgInfoAvailable - True if debugging information is available
157 bool DbgInfoAvailable;
159 /// UsesVAFloatArgument - True if this module calls VarArg function with
160 /// floating-point arguments. This is used to emit an undefined reference
161 /// to _fltused on Windows targets.
162 bool UsesVAFloatArgument;
165 static char ID; // Pass identification, replacement for typeid
167 struct VariableDbgInfo {
168 TrackingVH<MDNode> Var;
172 typedef SmallVector<VariableDbgInfo, 4> VariableDbgInfoMapTy;
173 VariableDbgInfoMapTy VariableDbgInfos;
175 MachineModuleInfo(); // DUMMY CONSTRUCTOR, DO NOT CALL.
177 MachineModuleInfo(const MCAsmInfo &MAI, const MCRegisterInfo &MRI,
178 const MCObjectFileInfo *MOFI);
179 ~MachineModuleInfo();
181 // Initialization and Finalization
182 bool doInitialization(Module &) override;
183 bool doFinalization(Module &) override;
185 /// EndFunction - Discard function meta information.
189 const MCContext &getContext() const { return Context; }
190 MCContext &getContext() { return Context; }
192 void setModule(const Module *M) { TheModule = M; }
193 const Module *getModule() const { return TheModule; }
195 /// getInfo - Keep track of various per-function pieces of information for
196 /// backends that would like to do so.
198 template<typename Ty>
199 Ty &getObjFileInfo() {
200 if (ObjFileMMI == nullptr)
201 ObjFileMMI = new Ty(*this);
202 return *static_cast<Ty*>(ObjFileMMI);
205 template<typename Ty>
206 const Ty &getObjFileInfo() const {
207 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
210 /// AnalyzeModule - Scan the module for global debug information.
212 void AnalyzeModule(const Module &M);
214 /// hasDebugInfo - Returns true if valid debug info is present.
216 bool hasDebugInfo() const { return DbgInfoAvailable; }
217 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = avail; }
219 bool callsEHReturn() const { return CallsEHReturn; }
220 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
222 bool callsUnwindInit() const { return CallsUnwindInit; }
223 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
225 bool usesVAFloatArgument() const {
226 return UsesVAFloatArgument;
229 void setUsesVAFloatArgument(bool b) {
230 UsesVAFloatArgument = b;
233 /// \brief Returns a reference to a list of cfi instructions in the current
234 /// function's prologue. Used to construct frame maps for debug and exception
235 /// handling comsumers.
236 const std::vector<MCCFIInstruction> &getFrameInstructions() const {
237 return FrameInstructions;
240 unsigned LLVM_ATTRIBUTE_UNUSED_RESULT
241 addFrameInst(const MCCFIInstruction &Inst) {
242 FrameInstructions.push_back(Inst);
243 return FrameInstructions.size() - 1;
246 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
247 /// block when its address is taken. This cannot be its normal LBB label
248 /// because the block may be accessed outside its containing function.
249 MCSymbol *getAddrLabelSymbol(const BasicBlock *BB);
251 /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
252 /// basic block when its address is taken. If other blocks were RAUW'd to
253 /// this one, we may have to emit them as well, return the whole set.
254 std::vector<MCSymbol*> getAddrLabelSymbolToEmit(const BasicBlock *BB);
256 /// takeDeletedSymbolsForFunction - If the specified function has had any
257 /// references to address-taken blocks generated, but the block got deleted,
258 /// return the symbol now so we can emit it. This prevents emitting a
259 /// reference to a symbol that has no definition.
260 void takeDeletedSymbolsForFunction(const Function *F,
261 std::vector<MCSymbol*> &Result);
264 //===- EH ---------------------------------------------------------------===//
266 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
267 /// specified MachineBasicBlock.
268 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
270 /// addInvoke - Provide the begin and end labels of an invoke style call and
271 /// associate it with a try landing pad block.
272 void addInvoke(MachineBasicBlock *LandingPad,
273 MCSymbol *BeginLabel, MCSymbol *EndLabel);
275 /// addLandingPad - Add a new panding pad. Returns the label ID for the
276 /// landing pad entry.
277 MCSymbol *addLandingPad(MachineBasicBlock *LandingPad);
279 /// addPersonality - Provide the personality function for the exception
281 void addPersonality(MachineBasicBlock *LandingPad,
282 const Function *Personality);
284 /// getPersonalityIndex - Get index of the current personality function inside
285 /// Personalitites array
286 unsigned getPersonalityIndex() const;
288 /// getPersonalities - Return array of personality functions ever seen.
289 const std::vector<const Function *>& getPersonalities() const {
290 return Personalities;
293 /// isUsedFunction - Return true if the functions in the llvm.used list. This
294 /// does not return true for things in llvm.compiler.used unless they are also
296 bool isUsedFunction(const Function *F) const {
297 return UsedFunctions.count(F);
300 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
302 void addCatchTypeInfo(MachineBasicBlock *LandingPad,
303 ArrayRef<const GlobalVariable *> TyInfo);
305 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
307 void addFilterTypeInfo(MachineBasicBlock *LandingPad,
308 ArrayRef<const GlobalVariable *> TyInfo);
310 /// addCleanup - Add a cleanup action for a landing pad.
312 void addCleanup(MachineBasicBlock *LandingPad);
314 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
316 unsigned getTypeIDFor(const GlobalVariable *TI);
318 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is
320 int getFilterIDFor(std::vector<unsigned> &TyIds);
322 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
324 void TidyLandingPads(DenseMap<MCSymbol*, uintptr_t> *LPMap = nullptr);
326 /// getLandingPads - Return a reference to the landing pad info for the
327 /// current function.
328 const std::vector<LandingPadInfo> &getLandingPads() const {
332 /// setCallSiteLandingPad - Map the landing pad's EH symbol to the call
334 void setCallSiteLandingPad(MCSymbol *Sym, ArrayRef<unsigned> Sites);
336 /// getCallSiteLandingPad - Get the call site indexes for a landing pad EH
338 SmallVectorImpl<unsigned> &getCallSiteLandingPad(MCSymbol *Sym) {
339 assert(hasCallSiteLandingPad(Sym) &&
340 "missing call site number for landing pad!");
341 return LPadToCallSiteMap[Sym];
344 /// hasCallSiteLandingPad - Return true if the landing pad Eh symbol has an
345 /// associated call site.
346 bool hasCallSiteLandingPad(MCSymbol *Sym) {
347 return !LPadToCallSiteMap[Sym].empty();
350 /// setCallSiteBeginLabel - Map the begin label for a call site.
351 void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) {
352 CallSiteMap[BeginLabel] = Site;
355 /// getCallSiteBeginLabel - Get the call site number for a begin label.
356 unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) {
357 assert(hasCallSiteBeginLabel(BeginLabel) &&
358 "Missing call site number for EH_LABEL!");
359 return CallSiteMap[BeginLabel];
362 /// hasCallSiteBeginLabel - Return true if the begin label has a call site
363 /// number associated with it.
364 bool hasCallSiteBeginLabel(MCSymbol *BeginLabel) {
365 return CallSiteMap[BeginLabel] != 0;
368 /// setCurrentCallSite - Set the call site currently being processed.
369 void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
371 /// getCurrentCallSite - Get the call site currently being processed, if any.
372 /// return zero if none.
373 unsigned getCurrentCallSite() { return CurCallSite; }
375 /// getTypeInfos - Return a reference to the C++ typeinfo for the current
377 const std::vector<const GlobalVariable *> &getTypeInfos() const {
381 /// getFilterIds - Return a reference to the typeids encoding filters used in
382 /// the current function.
383 const std::vector<unsigned> &getFilterIds() const {
387 /// getPersonality - Return a personality function if available. The presence
388 /// of one is required to emit exception handling info.
389 const Function *getPersonality() const;
391 /// setVariableDbgInfo - Collect information used to emit debugging
392 /// information of a variable.
393 void setVariableDbgInfo(MDNode *N, unsigned Slot, DebugLoc Loc) {
394 VariableDbgInfo Info = { N, Slot, Loc };
395 VariableDbgInfos.push_back(std::move(Info));
398 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfos; }
400 }; // End class MachineModuleInfo
402 } // End llvm namespace