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/Support/Dwarf.h"
35 #include "llvm/System/DataTypes.h"
36 #include "llvm/ADT/SmallVector.h"
37 #include "llvm/ADT/DenseMap.h"
38 #include "llvm/ADT/UniqueVector.h"
39 #include "llvm/ADT/SmallPtrSet.h"
40 #include "llvm/ADT/SmallSet.h"
41 #include "llvm/ADT/StringMap.h"
42 #include "llvm/CodeGen/MachineLocation.h"
43 #include "llvm/GlobalValue.h"
44 #include "llvm/Pass.h"
45 #include "llvm/Metadata.h"
46 #include "llvm/Support/ValueHandle.h"
50 //===----------------------------------------------------------------------===//
51 // Forward declarations.
55 class MachineBasicBlock;
56 class MachineFunction;
62 /// MachineModuleInfoImpl - This class can be derived from and used by targets
63 /// to hold private target-specific information for each Module. Objects of
64 /// type are accessed/created with MMI::getInfo and destroyed when the
65 /// MachineModuleInfo is destroyed.
66 class MachineModuleInfoImpl {
68 virtual ~MachineModuleInfoImpl();
73 //===----------------------------------------------------------------------===//
74 /// LandingPadInfo - This structure is used to retain landing pad info for
75 /// the current function.
77 struct LandingPadInfo {
78 MachineBasicBlock *LandingPadBlock; // Landing pad block.
79 SmallVector<unsigned, 1> BeginLabels; // Labels prior to invoke.
80 SmallVector<unsigned, 1> EndLabels; // Labels after invoke.
81 unsigned LandingPadLabel; // Label at beginning of landing pad.
82 Function *Personality; // Personality function.
83 std::vector<int> TypeIds; // List of type ids (filters negative)
85 explicit LandingPadInfo(MachineBasicBlock *MBB)
86 : LandingPadBlock(MBB)
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 /// ObjFileMMI - This is the object-file-format-specific implementation of
99 /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
101 MachineModuleInfoImpl *ObjFileMMI;
103 // LabelIDList - One entry per assigned label. Normally the entry is equal to
104 // the list index(+1). If the entry is zero then the label has been deleted.
105 // Any other value indicates the label has been deleted by is mapped to
107 std::vector<unsigned> LabelIDList;
109 // FrameMoves - List of moves done by a function's prolog. Used to construct
110 // frame maps by debug and exception handling consumers.
111 std::vector<MachineMove> FrameMoves;
113 // LandingPads - List of LandingPadInfo describing the landing pad information
114 // in the current function.
115 std::vector<LandingPadInfo> LandingPads;
117 // Map of invoke call site index values to associated begin EH_LABEL for
118 // the current function.
119 DenseMap<unsigned, unsigned> CallSiteMap;
121 // TypeInfos - List of C++ TypeInfo used in the current function.
123 std::vector<GlobalVariable *> TypeInfos;
125 // FilterIds - List of typeids encoding filters used in the current function.
127 std::vector<unsigned> FilterIds;
129 // FilterEnds - List of the indices in FilterIds corresponding to filter
132 std::vector<unsigned> FilterEnds;
134 // Personalities - Vector of all personality functions ever seen. Used to emit
136 std::vector<Function *> Personalities;
138 /// UsedFunctions - The functions in the @llvm.used list in a more easily
139 /// searchable format. This does not include the functions in
140 /// llvm.compiler.used.
141 SmallPtrSet<const Function *, 32> UsedFunctions;
144 bool CallsUnwindInit;
146 /// DbgInfoAvailable - True if debugging information is available
148 bool DbgInfoAvailable;
151 static char ID; // Pass identification, replacement for typeid
153 typedef std::pair<unsigned, TrackingVH<MDNode> > UnsignedAndMDNodePair;
154 typedef SmallVector< std::pair<TrackingVH<MDNode>, UnsignedAndMDNodePair>, 4>
155 VariableDbgInfoMapTy;
156 VariableDbgInfoMapTy VariableDbgInfo;
159 ~MachineModuleInfo();
161 bool doInitialization();
162 bool doFinalization();
164 /// BeginFunction - Begin gathering function meta information.
166 void BeginFunction(MachineFunction *) {}
168 /// EndFunction - Discard function meta information.
172 /// getInfo - Keep track of various per-function pieces of information for
173 /// backends that would like to do so.
175 template<typename Ty>
176 Ty &getObjFileInfo() {
178 ObjFileMMI = new Ty(*this);
180 assert((void*)dynamic_cast<Ty*>(ObjFileMMI) == (void*)ObjFileMMI &&
181 "Invalid concrete type or multiple inheritence for getInfo");
182 return *static_cast<Ty*>(ObjFileMMI);
185 template<typename Ty>
186 const Ty &getObjFileInfo() const {
187 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
190 /// AnalyzeModule - Scan the module for global debug information.
192 void AnalyzeModule(Module &M);
194 /// hasDebugInfo - Returns true if valid debug info is present.
196 bool hasDebugInfo() const { return DbgInfoAvailable; }
197 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
199 bool callsEHReturn() const { return CallsEHReturn; }
200 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
202 bool callsUnwindInit() const { return CallsUnwindInit; }
203 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
205 /// NextLabelID - Return the next unique label id.
207 unsigned NextLabelID() {
208 unsigned ID = (unsigned)LabelIDList.size() + 1;
209 LabelIDList.push_back(ID);
213 /// InvalidateLabel - Inhibit use of the specified label # from
214 /// MachineModuleInfo, for example because the code was deleted.
215 void InvalidateLabel(unsigned LabelID) {
216 // Remap to zero to indicate deletion.
217 RemapLabel(LabelID, 0);
220 /// RemapLabel - Indicate that a label has been merged into another.
222 void RemapLabel(unsigned OldLabelID, unsigned NewLabelID) {
223 assert(0 < OldLabelID && OldLabelID <= LabelIDList.size() &&
224 "Old label ID out of range.");
225 assert(NewLabelID <= LabelIDList.size() &&
226 "New label ID out of range.");
227 LabelIDList[OldLabelID - 1] = NewLabelID;
230 /// MappedLabel - Find out the label's final ID. Zero indicates deletion.
231 /// ID != Mapped ID indicates that the label was folded into another label.
232 unsigned MappedLabel(unsigned LabelID) const {
233 assert(LabelID <= LabelIDList.size() && "Debug label ID out of range.");
234 return LabelID ? LabelIDList[LabelID - 1] : 0;
237 /// getFrameMoves - Returns a reference to a list of moves done in the current
238 /// function's prologue. Used to construct frame maps for debug and exception
239 /// handling comsumers.
240 std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
242 //===-EH-----------------------------------------------------------------===//
244 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
245 /// specified MachineBasicBlock.
246 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
248 /// addInvoke - Provide the begin and end labels of an invoke style call and
249 /// associate it with a try landing pad block.
250 void addInvoke(MachineBasicBlock *LandingPad, unsigned BeginLabel,
253 /// addLandingPad - Add a new panding pad. Returns the label ID for the
254 /// landing pad entry.
255 unsigned addLandingPad(MachineBasicBlock *LandingPad);
257 /// addPersonality - Provide the personality function for the exception
259 void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
261 /// getPersonalityIndex - Get index of the current personality function inside
262 /// Personalitites array
263 unsigned getPersonalityIndex() const;
265 /// getPersonalities - Return array of personality functions ever seen.
266 const std::vector<Function *>& getPersonalities() const {
267 return Personalities;
270 /// isUsedFunction - Return true if the functions in the llvm.used list. This
271 /// does not return true for things in llvm.compiler.used unless they are also
273 bool isUsedFunction(const Function *F) {
274 return UsedFunctions.count(F);
277 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
279 void addCatchTypeInfo(MachineBasicBlock *LandingPad,
280 std::vector<GlobalVariable *> &TyInfo);
282 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
284 void addFilterTypeInfo(MachineBasicBlock *LandingPad,
285 std::vector<GlobalVariable *> &TyInfo);
287 /// addCleanup - Add a cleanup action for a landing pad.
289 void addCleanup(MachineBasicBlock *LandingPad);
291 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
293 unsigned getTypeIDFor(GlobalVariable *TI);
295 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is
297 int getFilterIDFor(std::vector<unsigned> &TyIds);
299 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
301 void TidyLandingPads();
303 /// getLandingPads - Return a reference to the landing pad info for the
304 /// current function.
305 const std::vector<LandingPadInfo> &getLandingPads() const {
309 /// setCallSiteBeginLabel - Map the begin label for a call site
310 void setCallSiteBeginLabel(unsigned BeginLabel, unsigned Site) {
311 CallSiteMap[BeginLabel] = Site;
314 /// getCallSiteBeginLabel - Get the call site number for a begin label
315 unsigned getCallSiteBeginLabel(unsigned BeginLabel) {
316 assert(CallSiteMap.count(BeginLabel) &&
317 "Missing call site number for EH_LABEL!");
318 return CallSiteMap[BeginLabel];
321 /// getTypeInfos - Return a reference to the C++ typeinfo for the current
323 const std::vector<GlobalVariable *> &getTypeInfos() const {
327 /// getFilterIds - Return a reference to the typeids encoding filters used in
328 /// the current function.
329 const std::vector<unsigned> &getFilterIds() const {
333 /// getPersonality - Return a personality function if available. The presence
334 /// of one is required to emit exception handling info.
335 Function *getPersonality() const;
337 /// setVariableDbgInfo - Collect information used to emit debugging information
339 void setVariableDbgInfo(MDNode *N, unsigned Slot, MDNode *Scope) {
340 VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Scope)));
343 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfo; }
345 }; // End class MachineModuleInfo
347 } // End llvm namespace