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"
47 #define ATTACH_DEBUG_INFO_TO_AN_INSN 1
51 //===----------------------------------------------------------------------===//
52 // Forward declarations.
56 class MachineBasicBlock;
57 class MachineFunction;
63 /// MachineModuleInfoImpl - This class can be derived from and used by targets
64 /// to hold private target-specific information for each Module. Objects of
65 /// type are accessed/created with MMI::getInfo and destroyed when the
66 /// MachineModuleInfo is destroyed.
67 class MachineModuleInfoImpl {
69 virtual ~MachineModuleInfoImpl();
74 //===----------------------------------------------------------------------===//
75 /// LandingPadInfo - This structure is used to retain landing pad info for
76 /// the current function.
78 struct LandingPadInfo {
79 MachineBasicBlock *LandingPadBlock; // Landing pad block.
80 SmallVector<unsigned, 1> BeginLabels; // Labels prior to invoke.
81 SmallVector<unsigned, 1> EndLabels; // Labels after invoke.
82 unsigned LandingPadLabel; // Label at beginning of landing pad.
83 Function *Personality; // Personality function.
84 std::vector<int> TypeIds; // List of type ids (filters negative)
86 explicit LandingPadInfo(MachineBasicBlock *MBB)
87 : LandingPadBlock(MBB)
93 //===----------------------------------------------------------------------===//
94 /// MachineModuleInfo - This class contains meta information specific to a
95 /// module. Queries can be made by different debugging and exception handling
96 /// schemes and reformated for specific use.
98 class MachineModuleInfo : public ImmutablePass {
99 /// ObjFileMMI - This is the object-file-format-specific implementation of
100 /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
102 MachineModuleInfoImpl *ObjFileMMI;
104 // LabelIDList - One entry per assigned label. Normally the entry is equal to
105 // the list index(+1). If the entry is zero then the label has been deleted.
106 // Any other value indicates the label has been deleted by is mapped to
108 std::vector<unsigned> LabelIDList;
110 // FrameMoves - List of moves done by a function's prolog. Used to construct
111 // frame maps by debug and exception handling consumers.
112 std::vector<MachineMove> FrameMoves;
114 // LandingPads - List of LandingPadInfo describing the landing pad information
115 // in the current function.
116 std::vector<LandingPadInfo> LandingPads;
118 // TypeInfos - List of C++ TypeInfo used in the current function.
120 std::vector<GlobalVariable *> TypeInfos;
122 // FilterIds - List of typeids encoding filters used in the current function.
124 std::vector<unsigned> FilterIds;
126 // FilterEnds - List of the indices in FilterIds corresponding to filter
129 std::vector<unsigned> FilterEnds;
131 // Personalities - Vector of all personality functions ever seen. Used to emit
133 std::vector<Function *> Personalities;
135 /// UsedFunctions - The functions in the @llvm.used list in a more easily
136 /// searchable format. This does not include the functions in
137 /// llvm.compiler.used.
138 SmallPtrSet<const Function *, 32> UsedFunctions;
140 /// UsedDbgLabels - labels are used by debug info entries.
141 SmallSet<unsigned, 8> UsedDbgLabels;
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 SmallVector< std::pair<TrackingVH<MDNode>, unsigned>, 4 >
154 VariableDbgInfoMapTy;
155 VariableDbgInfoMapTy VariableDbgInfo;
158 ~MachineModuleInfo();
160 bool doInitialization();
161 bool doFinalization();
163 /// BeginFunction - Begin gathering function meta information.
165 void BeginFunction(MachineFunction *) {}
167 /// EndFunction - Discard function meta information.
171 /// getInfo - Keep track of various per-function pieces of information for
172 /// backends that would like to do so.
174 template<typename Ty>
175 Ty &getObjFileInfo() {
177 ObjFileMMI = new Ty(*this);
179 assert((void*)dynamic_cast<Ty*>(ObjFileMMI) == (void*)ObjFileMMI &&
180 "Invalid concrete type or multiple inheritence for getInfo");
181 return *static_cast<Ty*>(ObjFileMMI);
184 template<typename Ty>
185 const Ty &getObjFileInfo() const {
186 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
189 /// AnalyzeModule - Scan the module for global debug information.
191 void AnalyzeModule(Module &M);
193 /// hasDebugInfo - Returns true if valid debug info is present.
195 bool hasDebugInfo() const { return DbgInfoAvailable; }
196 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
198 bool callsEHReturn() const { return CallsEHReturn; }
199 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
201 bool callsUnwindInit() const { return CallsUnwindInit; }
202 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
204 /// NextLabelID - Return the next unique label id.
206 unsigned NextLabelID() {
207 unsigned ID = (unsigned)LabelIDList.size() + 1;
208 LabelIDList.push_back(ID);
212 /// InvalidateLabel - Inhibit use of the specified label # from
213 /// MachineModuleInfo, for example because the code was deleted.
214 void InvalidateLabel(unsigned LabelID) {
215 // Remap to zero to indicate deletion.
216 RemapLabel(LabelID, 0);
219 /// RemapLabel - Indicate that a label has been merged into another.
221 void RemapLabel(unsigned OldLabelID, unsigned NewLabelID) {
222 assert(0 < OldLabelID && OldLabelID <= LabelIDList.size() &&
223 "Old label ID out of range.");
224 assert(NewLabelID <= LabelIDList.size() &&
225 "New label ID out of range.");
226 LabelIDList[OldLabelID - 1] = NewLabelID;
229 /// MappedLabel - Find out the label's final ID. Zero indicates deletion.
230 /// ID != Mapped ID indicates that the label was folded into another label.
231 unsigned MappedLabel(unsigned LabelID) const {
232 assert(LabelID <= LabelIDList.size() && "Debug label ID out of range.");
233 return LabelID ? LabelIDList[LabelID - 1] : 0;
236 /// isDbgLabelUsed - Return true if label with LabelID is used by
238 bool isDbgLabelUsed(unsigned LabelID) {
239 return UsedDbgLabels.count(LabelID);
242 /// RecordUsedDbgLabel - Mark label with LabelID as used. This is used
243 /// by DwarfWriter to inform DebugLabelFolder that certain labels are
244 /// not to be deleted.
245 void RecordUsedDbgLabel(unsigned LabelID) {
246 UsedDbgLabels.insert(LabelID);
249 /// getFrameMoves - Returns a reference to a list of moves done in the current
250 /// function's prologue. Used to construct frame maps for debug and exception
251 /// handling comsumers.
252 std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
254 //===-EH-----------------------------------------------------------------===//
256 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
257 /// specified MachineBasicBlock.
258 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
260 /// addInvoke - Provide the begin and end labels of an invoke style call and
261 /// associate it with a try landing pad block.
262 void addInvoke(MachineBasicBlock *LandingPad, unsigned BeginLabel,
265 /// addLandingPad - Add a new panding pad. Returns the label ID for the
266 /// landing pad entry.
267 unsigned addLandingPad(MachineBasicBlock *LandingPad);
269 /// addPersonality - Provide the personality function for the exception
271 void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
273 /// getPersonalityIndex - Get index of the current personality function inside
274 /// Personalitites array
275 unsigned getPersonalityIndex() const;
277 /// getPersonalities - Return array of personality functions ever seen.
278 const std::vector<Function *>& getPersonalities() const {
279 return Personalities;
282 /// isUsedFunction - Return true if the functions in the llvm.used list. This
283 /// does not return true for things in llvm.compiler.used unless they are also
285 bool isUsedFunction(const Function *F) {
286 return UsedFunctions.count(F);
289 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
291 void addCatchTypeInfo(MachineBasicBlock *LandingPad,
292 std::vector<GlobalVariable *> &TyInfo);
294 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
296 void addFilterTypeInfo(MachineBasicBlock *LandingPad,
297 std::vector<GlobalVariable *> &TyInfo);
299 /// addCleanup - Add a cleanup action for a landing pad.
301 void addCleanup(MachineBasicBlock *LandingPad);
303 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
305 unsigned getTypeIDFor(GlobalVariable *TI);
307 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is
309 int getFilterIDFor(std::vector<unsigned> &TyIds);
311 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
313 void TidyLandingPads();
315 /// getLandingPads - Return a reference to the landing pad info for the
316 /// current function.
317 const std::vector<LandingPadInfo> &getLandingPads() const {
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 S) {
340 VariableDbgInfo.push_back(std::make_pair(N, S));
343 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfo; }
345 }; // End class MachineModuleInfo
347 } // End llvm namespace