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.
56 class MMIAddrLabelMap;
57 class MachineBasicBlock;
58 class MachineFunction;
65 // Filter or finally function. Null indicates a catch-all.
66 const Function *FilterOrFinally;
68 // Address of block to recover at. Null for a finally handler.
69 const BlockAddress *RecoverBA;
72 //===----------------------------------------------------------------------===//
73 /// LandingPadInfo - This structure is used to retain landing pad info for
74 /// the current function.
76 struct LandingPadInfo {
77 MachineBasicBlock *LandingPadBlock; // Landing pad block.
78 SmallVector<MCSymbol *, 1> BeginLabels; // Labels prior to invoke.
79 SmallVector<MCSymbol *, 1> EndLabels; // Labels after invoke.
80 SmallVector<SEHHandler, 1> SEHHandlers; // SEH handlers active at this lpad.
81 MCSymbol *LandingPadLabel; // Label at beginning of landing pad.
82 std::vector<int> TypeIds; // List of type ids (filters negative).
83 int WinEHState; // WinEH specific state number.
85 explicit LandingPadInfo(MachineBasicBlock *MBB)
86 : LandingPadBlock(MBB), LandingPadLabel(nullptr),
90 //===----------------------------------------------------------------------===//
91 /// MachineModuleInfoImpl - This class can be derived from and used by targets
92 /// to hold private target-specific information for each Module. Objects of
93 /// type are accessed/created with MMI::getInfo and destroyed when the
94 /// MachineModuleInfo is destroyed.
96 class MachineModuleInfoImpl {
98 typedef PointerIntPair<MCSymbol*, 1, bool> StubValueTy;
99 virtual ~MachineModuleInfoImpl();
100 typedef std::vector<std::pair<MCSymbol*, StubValueTy> > SymbolListTy;
103 /// Return the entries from a DenseMap in a deterministic sorted orer.
105 static SymbolListTy getSortedStubs(DenseMap<MCSymbol*, StubValueTy>&);
108 //===----------------------------------------------------------------------===//
109 /// MachineModuleInfo - This class contains meta information specific to a
110 /// module. Queries can be made by different debugging and exception handling
111 /// schemes and reformated for specific use.
113 class MachineModuleInfo : public ImmutablePass {
114 /// Context - This is the MCContext used for the entire code generator.
117 /// TheModule - This is the LLVM Module being worked on.
118 const Module *TheModule;
120 /// ObjFileMMI - This is the object-file-format-specific implementation of
121 /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
123 MachineModuleInfoImpl *ObjFileMMI;
125 /// List of moves done by a function's prolog. Used to construct frame maps
126 /// by debug and exception handling consumers.
127 std::vector<MCCFIInstruction> FrameInstructions;
129 /// LandingPads - List of LandingPadInfo describing the landing pad
130 /// information in the current function.
131 std::vector<LandingPadInfo> LandingPads;
133 /// LPadToCallSiteMap - Map a landing pad's EH symbol to the call site
135 DenseMap<MCSymbol*, SmallVector<unsigned, 4> > LPadToCallSiteMap;
137 /// CallSiteMap - Map of invoke call site index values to associated begin
138 /// EH_LABEL for the current function.
139 DenseMap<MCSymbol*, unsigned> CallSiteMap;
141 /// CurCallSite - The current call site index being processed, if any. 0 if
143 unsigned CurCallSite;
145 /// TypeInfos - List of C++ TypeInfo used in the current function.
146 std::vector<const GlobalValue *> TypeInfos;
148 /// FilterIds - List of typeids encoding filters used in the current function.
149 std::vector<unsigned> FilterIds;
151 /// FilterEnds - List of the indices in FilterIds corresponding to filter
153 std::vector<unsigned> FilterEnds;
155 /// Personalities - Vector of all personality functions ever seen. Used to
156 /// emit common EH frames.
157 std::vector<const Function *> Personalities;
159 /// AddrLabelSymbols - This map keeps track of which symbol is being used for
160 /// the specified basic block's address of label.
161 MMIAddrLabelMap *AddrLabelSymbols;
164 bool CallsUnwindInit;
167 /// DbgInfoAvailable - True if debugging information is available
169 bool DbgInfoAvailable;
171 /// UsesVAFloatArgument - True if this module calls VarArg function with
172 /// floating-point arguments. This is used to emit an undefined reference
173 /// to _fltused on Windows targets.
174 bool UsesVAFloatArgument;
176 /// UsesMorestackAddr - True if the module calls the __morestack function
177 /// indirectly, as is required under the large code model on x86. This is used
178 /// to emit a definition of a symbol, __morestack_addr, containing the
179 /// address. See comments in lib/Target/X86/X86FrameLowering.cpp for more
181 bool UsesMorestackAddr;
183 EHPersonality PersonalityTypeCache;
185 DenseMap<const Function *, std::unique_ptr<WinEHFuncInfo>> FuncInfoMap;
188 static char ID; // Pass identification, replacement for typeid
190 struct VariableDbgInfo {
191 const DILocalVariable *Var;
192 const DIExpression *Expr;
194 const DILocation *Loc;
196 VariableDbgInfo(const DILocalVariable *Var, const DIExpression *Expr,
197 unsigned Slot, const DILocation *Loc)
198 : Var(Var), Expr(Expr), Slot(Slot), Loc(Loc) {}
200 typedef SmallVector<VariableDbgInfo, 4> VariableDbgInfoMapTy;
201 VariableDbgInfoMapTy VariableDbgInfos;
203 MachineModuleInfo(); // DUMMY CONSTRUCTOR, DO NOT CALL.
205 MachineModuleInfo(const MCAsmInfo &MAI, const MCRegisterInfo &MRI,
206 const MCObjectFileInfo *MOFI);
207 ~MachineModuleInfo() override;
209 // Initialization and Finalization
210 bool doInitialization(Module &) override;
211 bool doFinalization(Module &) override;
213 /// EndFunction - Discard function meta information.
217 const MCContext &getContext() const { return Context; }
218 MCContext &getContext() { return Context; }
220 void setModule(const Module *M) { TheModule = M; }
221 const Module *getModule() const { return TheModule; }
223 WinEHFuncInfo &getWinEHFuncInfo(const Function *F);
224 bool hasWinEHFuncInfo(const Function *F) const {
225 return FuncInfoMap.count(F) > 0;
228 /// getInfo - Keep track of various per-function pieces of information for
229 /// backends that would like to do so.
231 template<typename Ty>
232 Ty &getObjFileInfo() {
233 if (ObjFileMMI == nullptr)
234 ObjFileMMI = new Ty(*this);
235 return *static_cast<Ty*>(ObjFileMMI);
238 template<typename Ty>
239 const Ty &getObjFileInfo() const {
240 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
243 /// hasDebugInfo - Returns true if valid debug info is present.
245 bool hasDebugInfo() const { return DbgInfoAvailable; }
246 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = avail; }
248 // Returns true if we need to generate precise CFI. Currently
249 // this is equivalent to hasDebugInfo(), but if we ever implement
250 // async EH, it will require precise CFI as well.
251 bool usePreciseUnwindInfo() const { return hasDebugInfo(); }
253 bool callsEHReturn() const { return CallsEHReturn; }
254 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
256 bool callsUnwindInit() const { return CallsUnwindInit; }
257 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
259 bool hasEHFunclets() const { return HasEHFunclets; }
260 void setHasEHFunclets(bool V) { HasEHFunclets = V; }
262 bool usesVAFloatArgument() const {
263 return UsesVAFloatArgument;
266 void setUsesVAFloatArgument(bool b) {
267 UsesVAFloatArgument = b;
270 bool usesMorestackAddr() const {
271 return UsesMorestackAddr;
274 void setUsesMorestackAddr(bool b) {
275 UsesMorestackAddr = b;
278 /// \brief Returns a reference to a list of cfi instructions in the current
279 /// function's prologue. Used to construct frame maps for debug and exception
280 /// handling comsumers.
281 const std::vector<MCCFIInstruction> &getFrameInstructions() const {
282 return FrameInstructions;
285 unsigned LLVM_ATTRIBUTE_UNUSED_RESULT
286 addFrameInst(const MCCFIInstruction &Inst) {
287 FrameInstructions.push_back(Inst);
288 return FrameInstructions.size() - 1;
291 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
292 /// block when its address is taken. This cannot be its normal LBB label
293 /// because the block may be accessed outside its containing function.
294 MCSymbol *getAddrLabelSymbol(const BasicBlock *BB) {
295 return getAddrLabelSymbolToEmit(BB).front();
298 /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
299 /// basic block when its address is taken. If other blocks were RAUW'd to
300 /// this one, we may have to emit them as well, return the whole set.
301 ArrayRef<MCSymbol *> getAddrLabelSymbolToEmit(const BasicBlock *BB);
303 /// takeDeletedSymbolsForFunction - If the specified function has had any
304 /// references to address-taken blocks generated, but the block got deleted,
305 /// return the symbol now so we can emit it. This prevents emitting a
306 /// reference to a symbol that has no definition.
307 void takeDeletedSymbolsForFunction(const Function *F,
308 std::vector<MCSymbol*> &Result);
311 //===- EH ---------------------------------------------------------------===//
313 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
314 /// specified MachineBasicBlock.
315 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
317 /// addInvoke - Provide the begin and end labels of an invoke style call and
318 /// associate it with a try landing pad block.
319 void addInvoke(MachineBasicBlock *LandingPad,
320 MCSymbol *BeginLabel, MCSymbol *EndLabel);
322 /// addLandingPad - Add a new panding pad. Returns the label ID for the
323 /// landing pad entry.
324 MCSymbol *addLandingPad(MachineBasicBlock *LandingPad);
326 /// addPersonality - Provide the personality function for the exception
328 void addPersonality(const Function *Personality);
330 void addWinEHState(MachineBasicBlock *LandingPad, int State);
332 /// getPersonalities - Return array of personality functions ever seen.
333 const std::vector<const Function *>& getPersonalities() const {
334 return Personalities;
337 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
339 void addCatchTypeInfo(MachineBasicBlock *LandingPad,
340 ArrayRef<const GlobalValue *> TyInfo);
342 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
344 void addFilterTypeInfo(MachineBasicBlock *LandingPad,
345 ArrayRef<const GlobalValue *> TyInfo);
347 /// addCleanup - Add a cleanup action for a landing pad.
349 void addCleanup(MachineBasicBlock *LandingPad);
351 void addSEHCatchHandler(MachineBasicBlock *LandingPad, const Function *Filter,
352 const BlockAddress *RecoverLabel);
354 void addSEHCleanupHandler(MachineBasicBlock *LandingPad,
355 const Function *Cleanup);
357 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
359 unsigned getTypeIDFor(const GlobalValue *TI);
361 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is
363 int getFilterIDFor(std::vector<unsigned> &TyIds);
365 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
367 void TidyLandingPads(DenseMap<MCSymbol*, uintptr_t> *LPMap = nullptr);
369 /// getLandingPads - Return a reference to the landing pad info for the
370 /// current function.
371 const std::vector<LandingPadInfo> &getLandingPads() const {
375 /// setCallSiteLandingPad - Map the landing pad's EH symbol to the call
377 void setCallSiteLandingPad(MCSymbol *Sym, ArrayRef<unsigned> Sites);
379 /// getCallSiteLandingPad - Get the call site indexes for a landing pad EH
381 SmallVectorImpl<unsigned> &getCallSiteLandingPad(MCSymbol *Sym) {
382 assert(hasCallSiteLandingPad(Sym) &&
383 "missing call site number for landing pad!");
384 return LPadToCallSiteMap[Sym];
387 /// hasCallSiteLandingPad - Return true if the landing pad Eh symbol has an
388 /// associated call site.
389 bool hasCallSiteLandingPad(MCSymbol *Sym) {
390 return !LPadToCallSiteMap[Sym].empty();
393 /// setCallSiteBeginLabel - Map the begin label for a call site.
394 void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) {
395 CallSiteMap[BeginLabel] = Site;
398 /// getCallSiteBeginLabel - Get the call site number for a begin label.
399 unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) {
400 assert(hasCallSiteBeginLabel(BeginLabel) &&
401 "Missing call site number for EH_LABEL!");
402 return CallSiteMap[BeginLabel];
405 /// hasCallSiteBeginLabel - Return true if the begin label has a call site
406 /// number associated with it.
407 bool hasCallSiteBeginLabel(MCSymbol *BeginLabel) {
408 return CallSiteMap[BeginLabel] != 0;
411 /// setCurrentCallSite - Set the call site currently being processed.
412 void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
414 /// getCurrentCallSite - Get the call site currently being processed, if any.
415 /// return zero if none.
416 unsigned getCurrentCallSite() { return CurCallSite; }
418 /// getTypeInfos - Return a reference to the C++ typeinfo for the current
420 const std::vector<const GlobalValue *> &getTypeInfos() const {
424 /// getFilterIds - Return a reference to the typeids encoding filters used in
425 /// the current function.
426 const std::vector<unsigned> &getFilterIds() const {
430 /// setVariableDbgInfo - Collect information used to emit debugging
431 /// information of a variable.
432 void setVariableDbgInfo(const DILocalVariable *Var, const DIExpression *Expr,
433 unsigned Slot, const DILocation *Loc) {
434 VariableDbgInfos.emplace_back(Var, Expr, Slot, Loc);
437 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfos; }
439 }; // End class MachineModuleInfo
441 } // End llvm namespace