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 const Function *getWinEHParent(const Function *F) const;
224 WinEHFuncInfo &getWinEHFuncInfo(const Function *F);
225 bool hasWinEHFuncInfo(const Function *F) const {
226 return FuncInfoMap.count(getWinEHParent(F)) > 0;
229 /// getInfo - Keep track of various per-function pieces of information for
230 /// backends that would like to do so.
232 template<typename Ty>
233 Ty &getObjFileInfo() {
234 if (ObjFileMMI == nullptr)
235 ObjFileMMI = new Ty(*this);
236 return *static_cast<Ty*>(ObjFileMMI);
239 template<typename Ty>
240 const Ty &getObjFileInfo() const {
241 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
244 /// hasDebugInfo - Returns true if valid debug info is present.
246 bool hasDebugInfo() const { return DbgInfoAvailable; }
247 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = avail; }
249 bool callsEHReturn() const { return CallsEHReturn; }
250 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
252 bool callsUnwindInit() const { return CallsUnwindInit; }
253 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
255 bool hasEHFunclets() const { return HasEHFunclets; }
256 void setHasEHFunclets(bool V) { HasEHFunclets = V; }
258 bool usesVAFloatArgument() const {
259 return UsesVAFloatArgument;
262 void setUsesVAFloatArgument(bool b) {
263 UsesVAFloatArgument = b;
266 bool usesMorestackAddr() const {
267 return UsesMorestackAddr;
270 void setUsesMorestackAddr(bool b) {
271 UsesMorestackAddr = b;
274 /// \brief Returns a reference to a list of cfi instructions in the current
275 /// function's prologue. Used to construct frame maps for debug and exception
276 /// handling comsumers.
277 const std::vector<MCCFIInstruction> &getFrameInstructions() const {
278 return FrameInstructions;
281 unsigned LLVM_ATTRIBUTE_UNUSED_RESULT
282 addFrameInst(const MCCFIInstruction &Inst) {
283 FrameInstructions.push_back(Inst);
284 return FrameInstructions.size() - 1;
287 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
288 /// block when its address is taken. This cannot be its normal LBB label
289 /// because the block may be accessed outside its containing function.
290 MCSymbol *getAddrLabelSymbol(const BasicBlock *BB) {
291 return getAddrLabelSymbolToEmit(BB).front();
294 /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
295 /// basic block when its address is taken. If other blocks were RAUW'd to
296 /// this one, we may have to emit them as well, return the whole set.
297 ArrayRef<MCSymbol *> getAddrLabelSymbolToEmit(const BasicBlock *BB);
299 /// takeDeletedSymbolsForFunction - If the specified function has had any
300 /// references to address-taken blocks generated, but the block got deleted,
301 /// return the symbol now so we can emit it. This prevents emitting a
302 /// reference to a symbol that has no definition.
303 void takeDeletedSymbolsForFunction(const Function *F,
304 std::vector<MCSymbol*> &Result);
307 //===- EH ---------------------------------------------------------------===//
309 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
310 /// specified MachineBasicBlock.
311 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
313 /// addInvoke - Provide the begin and end labels of an invoke style call and
314 /// associate it with a try landing pad block.
315 void addInvoke(MachineBasicBlock *LandingPad,
316 MCSymbol *BeginLabel, MCSymbol *EndLabel);
318 /// addLandingPad - Add a new panding pad. Returns the label ID for the
319 /// landing pad entry.
320 MCSymbol *addLandingPad(MachineBasicBlock *LandingPad);
322 /// addPersonality - Provide the personality function for the exception
324 void addPersonality(const Function *Personality);
326 void addWinEHState(MachineBasicBlock *LandingPad, int State);
328 /// getPersonalities - Return array of personality functions ever seen.
329 const std::vector<const Function *>& getPersonalities() const {
330 return Personalities;
333 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
335 void addCatchTypeInfo(MachineBasicBlock *LandingPad,
336 ArrayRef<const GlobalValue *> TyInfo);
338 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
340 void addFilterTypeInfo(MachineBasicBlock *LandingPad,
341 ArrayRef<const GlobalValue *> TyInfo);
343 /// addCleanup - Add a cleanup action for a landing pad.
345 void addCleanup(MachineBasicBlock *LandingPad);
347 void addSEHCatchHandler(MachineBasicBlock *LandingPad, const Function *Filter,
348 const BlockAddress *RecoverLabel);
350 void addSEHCleanupHandler(MachineBasicBlock *LandingPad,
351 const Function *Cleanup);
353 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
355 unsigned getTypeIDFor(const GlobalValue *TI);
357 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is
359 int getFilterIDFor(std::vector<unsigned> &TyIds);
361 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
363 void TidyLandingPads(DenseMap<MCSymbol*, uintptr_t> *LPMap = nullptr);
365 /// getLandingPads - Return a reference to the landing pad info for the
366 /// current function.
367 const std::vector<LandingPadInfo> &getLandingPads() const {
371 /// setCallSiteLandingPad - Map the landing pad's EH symbol to the call
373 void setCallSiteLandingPad(MCSymbol *Sym, ArrayRef<unsigned> Sites);
375 /// getCallSiteLandingPad - Get the call site indexes for a landing pad EH
377 SmallVectorImpl<unsigned> &getCallSiteLandingPad(MCSymbol *Sym) {
378 assert(hasCallSiteLandingPad(Sym) &&
379 "missing call site number for landing pad!");
380 return LPadToCallSiteMap[Sym];
383 /// hasCallSiteLandingPad - Return true if the landing pad Eh symbol has an
384 /// associated call site.
385 bool hasCallSiteLandingPad(MCSymbol *Sym) {
386 return !LPadToCallSiteMap[Sym].empty();
389 /// setCallSiteBeginLabel - Map the begin label for a call site.
390 void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) {
391 CallSiteMap[BeginLabel] = Site;
394 /// getCallSiteBeginLabel - Get the call site number for a begin label.
395 unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) {
396 assert(hasCallSiteBeginLabel(BeginLabel) &&
397 "Missing call site number for EH_LABEL!");
398 return CallSiteMap[BeginLabel];
401 /// hasCallSiteBeginLabel - Return true if the begin label has a call site
402 /// number associated with it.
403 bool hasCallSiteBeginLabel(MCSymbol *BeginLabel) {
404 return CallSiteMap[BeginLabel] != 0;
407 /// setCurrentCallSite - Set the call site currently being processed.
408 void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
410 /// getCurrentCallSite - Get the call site currently being processed, if any.
411 /// return zero if none.
412 unsigned getCurrentCallSite() { return CurCallSite; }
414 /// getTypeInfos - Return a reference to the C++ typeinfo for the current
416 const std::vector<const GlobalValue *> &getTypeInfos() const {
420 /// getFilterIds - Return a reference to the typeids encoding filters used in
421 /// the current function.
422 const std::vector<unsigned> &getFilterIds() const {
426 /// setVariableDbgInfo - Collect information used to emit debugging
427 /// information of a variable.
428 void setVariableDbgInfo(const DILocalVariable *Var, const DIExpression *Expr,
429 unsigned Slot, const DILocation *Loc) {
430 VariableDbgInfos.emplace_back(Var, Expr, Slot, Loc);
433 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfos; }
435 }; // End class MachineModuleInfo
437 } // End llvm namespace