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"
49 //===----------------------------------------------------------------------===//
50 // Forward declarations.
54 class MachineBasicBlock;
55 class MachineFunction;
61 /// MachineModuleInfoImpl - This class can be derived from and used by targets
62 /// to hold private target-specific information for each Module. Objects of
63 /// type are accessed/created with MMI::getInfo and destroyed when the
64 /// MachineModuleInfo is destroyed.
65 class MachineModuleInfoImpl {
67 virtual ~MachineModuleInfoImpl();
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<unsigned, 1> BeginLabels; // Labels prior to invoke.
79 SmallVector<unsigned, 1> EndLabels; // Labels after invoke.
80 unsigned LandingPadLabel; // Label at beginning of landing pad.
81 Function *Personality; // Personality function.
82 std::vector<int> TypeIds; // List of type ids (filters negative)
84 explicit LandingPadInfo(MachineBasicBlock *MBB)
85 : LandingPadBlock(MBB)
91 //===----------------------------------------------------------------------===//
92 /// MachineModuleInfo - This class contains meta information specific to a
93 /// module. Queries can be made by different debugging and exception handling
94 /// schemes and reformated for specific use.
96 class MachineModuleInfo : public ImmutablePass {
97 /// ObjFileMMI - This is the object-file-format-specific implementation of
98 /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
100 MachineModuleInfoImpl *ObjFileMMI;
102 // LabelIDList - One entry per assigned label. Normally the entry is equal to
103 // the list index(+1). If the entry is zero then the label has been deleted.
104 // Any other value indicates the label has been deleted by is mapped to
106 std::vector<unsigned> LabelIDList;
108 // FrameMoves - List of moves done by a function's prolog. Used to construct
109 // frame maps by debug and exception handling consumers.
110 std::vector<MachineMove> FrameMoves;
112 // LandingPads - List of LandingPadInfo describing the landing pad information
113 // in the current function.
114 std::vector<LandingPadInfo> LandingPads;
116 // TypeInfos - List of C++ TypeInfo used in the current function.
118 std::vector<GlobalVariable *> TypeInfos;
120 // FilterIds - List of typeids encoding filters used in the current function.
122 std::vector<unsigned> FilterIds;
124 // FilterEnds - List of the indices in FilterIds corresponding to filter
127 std::vector<unsigned> FilterEnds;
129 // Personalities - Vector of all personality functions ever seen. Used to emit
131 std::vector<Function *> Personalities;
133 /// UsedFunctions - The functions in the @llvm.used list in a more easily
134 /// searchable format. This does not include the functions in
135 /// llvm.compiler.used.
136 SmallPtrSet<const Function *, 32> UsedFunctions;
138 /// UsedDbgLabels - labels are used by debug info entries.
139 SmallSet<unsigned, 8> UsedDbgLabels;
142 bool CallsUnwindInit;
144 /// DbgInfoAvailable - True if debugging information is available
146 bool DbgInfoAvailable;
149 static char ID; // Pass identification, replacement for typeid
151 typedef std::pair<unsigned, TrackingVH<MDNode> > UnsignedAndMDNodePair;
152 typedef SmallVector< std::pair<TrackingVH<MDNode>, UnsignedAndMDNodePair>, 4>
153 VariableDbgInfoMapTy;
154 VariableDbgInfoMapTy VariableDbgInfo;
157 ~MachineModuleInfo();
159 bool doInitialization();
160 bool doFinalization();
162 /// BeginFunction - Begin gathering function meta information.
164 void BeginFunction(MachineFunction *) {}
166 /// EndFunction - Discard function meta information.
170 /// getInfo - Keep track of various per-function pieces of information for
171 /// backends that would like to do so.
173 template<typename Ty>
174 Ty &getObjFileInfo() {
176 ObjFileMMI = new Ty(*this);
178 assert((void*)dynamic_cast<Ty*>(ObjFileMMI) == (void*)ObjFileMMI &&
179 "Invalid concrete type or multiple inheritence for getInfo");
180 return *static_cast<Ty*>(ObjFileMMI);
183 template<typename Ty>
184 const Ty &getObjFileInfo() const {
185 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
188 /// AnalyzeModule - Scan the module for global debug information.
190 void AnalyzeModule(Module &M);
192 /// hasDebugInfo - Returns true if valid debug info is present.
194 bool hasDebugInfo() const { return DbgInfoAvailable; }
195 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
197 bool callsEHReturn() const { return CallsEHReturn; }
198 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
200 bool callsUnwindInit() const { return CallsUnwindInit; }
201 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
203 /// NextLabelID - Return the next unique label id.
205 unsigned NextLabelID() {
206 unsigned ID = (unsigned)LabelIDList.size() + 1;
207 LabelIDList.push_back(ID);
211 /// InvalidateLabel - Inhibit use of the specified label # from
212 /// MachineModuleInfo, for example because the code was deleted.
213 void InvalidateLabel(unsigned LabelID) {
214 // Remap to zero to indicate deletion.
215 RemapLabel(LabelID, 0);
218 /// RemapLabel - Indicate that a label has been merged into another.
220 void RemapLabel(unsigned OldLabelID, unsigned NewLabelID) {
221 assert(0 < OldLabelID && OldLabelID <= LabelIDList.size() &&
222 "Old label ID out of range.");
223 assert(NewLabelID <= LabelIDList.size() &&
224 "New label ID out of range.");
225 LabelIDList[OldLabelID - 1] = NewLabelID;
228 /// MappedLabel - Find out the label's final ID. Zero indicates deletion.
229 /// ID != Mapped ID indicates that the label was folded into another label.
230 unsigned MappedLabel(unsigned LabelID) const {
231 assert(LabelID <= LabelIDList.size() && "Debug label ID out of range.");
232 return LabelID ? LabelIDList[LabelID - 1] : 0;
235 /// isDbgLabelUsed - Return true if label with LabelID is used by
237 bool isDbgLabelUsed(unsigned LabelID) {
238 return UsedDbgLabels.count(LabelID);
241 /// RecordUsedDbgLabel - Mark label with LabelID as used. This is used
242 /// by DwarfWriter to inform DebugLabelFolder that certain labels are
243 /// not to be deleted.
244 void RecordUsedDbgLabel(unsigned LabelID) {
245 UsedDbgLabels.insert(LabelID);
248 /// getFrameMoves - Returns a reference to a list of moves done in the current
249 /// function's prologue. Used to construct frame maps for debug and exception
250 /// handling comsumers.
251 std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
253 //===-EH-----------------------------------------------------------------===//
255 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
256 /// specified MachineBasicBlock.
257 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
259 /// addInvoke - Provide the begin and end labels of an invoke style call and
260 /// associate it with a try landing pad block.
261 void addInvoke(MachineBasicBlock *LandingPad, unsigned BeginLabel,
264 /// addLandingPad - Add a new panding pad. Returns the label ID for the
265 /// landing pad entry.
266 unsigned addLandingPad(MachineBasicBlock *LandingPad);
268 /// addPersonality - Provide the personality function for the exception
270 void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
272 /// getPersonalityIndex - Get index of the current personality function inside
273 /// Personalitites array
274 unsigned getPersonalityIndex() const;
276 /// getPersonalities - Return array of personality functions ever seen.
277 const std::vector<Function *>& getPersonalities() const {
278 return Personalities;
281 /// isUsedFunction - Return true if the functions in the llvm.used list. This
282 /// does not return true for things in llvm.compiler.used unless they are also
284 bool isUsedFunction(const Function *F) {
285 return UsedFunctions.count(F);
288 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
290 void addCatchTypeInfo(MachineBasicBlock *LandingPad,
291 std::vector<GlobalVariable *> &TyInfo);
293 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
295 void addFilterTypeInfo(MachineBasicBlock *LandingPad,
296 std::vector<GlobalVariable *> &TyInfo);
298 /// addCleanup - Add a cleanup action for a landing pad.
300 void addCleanup(MachineBasicBlock *LandingPad);
302 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
304 unsigned getTypeIDFor(GlobalVariable *TI);
306 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is
308 int getFilterIDFor(std::vector<unsigned> &TyIds);
310 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
312 void TidyLandingPads();
314 /// getLandingPads - Return a reference to the landing pad info for the
315 /// current function.
316 const std::vector<LandingPadInfo> &getLandingPads() const {
320 /// getTypeInfos - Return a reference to the C++ typeinfo for the current
322 const std::vector<GlobalVariable *> &getTypeInfos() const {
326 /// getFilterIds - Return a reference to the typeids encoding filters used in
327 /// the current function.
328 const std::vector<unsigned> &getFilterIds() const {
332 /// getPersonality - Return a personality function if available. The presence
333 /// of one is required to emit exception handling info.
334 Function *getPersonality() const;
336 /// setVariableDbgInfo - Collect information used to emit debugging information
338 void setVariableDbgInfo(MDNode *N, unsigned Slot, MDNode *Scope) {
339 VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Scope)));
342 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfo; }
344 }; // End class MachineModuleInfo
346 } // End llvm namespace