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 // TypeInfos - List of C++ TypeInfo used in the current function.
119 std::vector<GlobalVariable *> TypeInfos;
121 // FilterIds - List of typeids encoding filters used in the current function.
123 std::vector<unsigned> FilterIds;
125 // FilterEnds - List of the indices in FilterIds corresponding to filter
128 std::vector<unsigned> FilterEnds;
130 // Personalities - Vector of all personality functions ever seen. Used to emit
132 std::vector<Function *> Personalities;
134 /// UsedFunctions - The functions in the @llvm.used list in a more easily
135 /// searchable format. This does not include the functions in
136 /// llvm.compiler.used.
137 SmallPtrSet<const Function *, 32> UsedFunctions;
140 bool CallsUnwindInit;
142 /// DbgInfoAvailable - True if debugging information is available
144 bool DbgInfoAvailable;
147 static char ID; // Pass identification, replacement for typeid
149 typedef std::pair<unsigned, TrackingVH<MDNode> > UnsignedAndMDNodePair;
150 typedef SmallVector< std::pair<TrackingVH<MDNode>, UnsignedAndMDNodePair>, 4>
151 VariableDbgInfoMapTy;
152 VariableDbgInfoMapTy VariableDbgInfo;
155 ~MachineModuleInfo();
157 bool doInitialization();
158 bool doFinalization();
160 /// BeginFunction - Begin gathering function meta information.
162 void BeginFunction(MachineFunction *) {}
164 /// EndFunction - Discard function meta information.
168 /// getInfo - Keep track of various per-function pieces of information for
169 /// backends that would like to do so.
171 template<typename Ty>
172 Ty &getObjFileInfo() {
174 ObjFileMMI = new Ty(*this);
175 return *static_cast<Ty*>(ObjFileMMI);
178 template<typename Ty>
179 const Ty &getObjFileInfo() const {
180 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
183 /// AnalyzeModule - Scan the module for global debug information.
185 void AnalyzeModule(Module &M);
187 /// hasDebugInfo - Returns true if valid debug info is present.
189 bool hasDebugInfo() const { return DbgInfoAvailable; }
190 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
192 bool callsEHReturn() const { return CallsEHReturn; }
193 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
195 bool callsUnwindInit() const { return CallsUnwindInit; }
196 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
198 /// NextLabelID - Return the next unique label id.
200 unsigned NextLabelID() {
201 unsigned ID = (unsigned)LabelIDList.size() + 1;
202 LabelIDList.push_back(ID);
206 /// InvalidateLabel - Inhibit use of the specified label # from
207 /// MachineModuleInfo, for example because the code was deleted.
208 void InvalidateLabel(unsigned LabelID) {
209 // Remap to zero to indicate deletion.
210 RemapLabel(LabelID, 0);
213 /// RemapLabel - Indicate that a label has been merged into another.
215 void RemapLabel(unsigned OldLabelID, unsigned NewLabelID) {
216 assert(0 < OldLabelID && OldLabelID <= LabelIDList.size() &&
217 "Old label ID out of range.");
218 assert(NewLabelID <= LabelIDList.size() &&
219 "New label ID out of range.");
220 LabelIDList[OldLabelID - 1] = NewLabelID;
223 /// MappedLabel - Find out the label's final ID. Zero indicates deletion.
224 /// ID != Mapped ID indicates that the label was folded into another label.
225 unsigned MappedLabel(unsigned LabelID) const {
226 assert(LabelID <= LabelIDList.size() && "Debug label ID out of range.");
227 return LabelID ? LabelIDList[LabelID - 1] : 0;
230 /// getFrameMoves - Returns a reference to a list of moves done in the current
231 /// function's prologue. Used to construct frame maps for debug and exception
232 /// handling comsumers.
233 std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
235 //===-EH-----------------------------------------------------------------===//
237 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
238 /// specified MachineBasicBlock.
239 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
241 /// addInvoke - Provide the begin and end labels of an invoke style call and
242 /// associate it with a try landing pad block.
243 void addInvoke(MachineBasicBlock *LandingPad, unsigned BeginLabel,
246 /// addLandingPad - Add a new panding pad. Returns the label ID for the
247 /// landing pad entry.
248 unsigned addLandingPad(MachineBasicBlock *LandingPad);
250 /// addPersonality - Provide the personality function for the exception
252 void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
254 /// getPersonalityIndex - Get index of the current personality function inside
255 /// Personalitites array
256 unsigned getPersonalityIndex() const;
258 /// getPersonalities - Return array of personality functions ever seen.
259 const std::vector<Function *>& getPersonalities() const {
260 return Personalities;
263 /// isUsedFunction - Return true if the functions in the llvm.used list. This
264 /// does not return true for things in llvm.compiler.used unless they are also
266 bool isUsedFunction(const Function *F) {
267 return UsedFunctions.count(F);
270 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
272 void addCatchTypeInfo(MachineBasicBlock *LandingPad,
273 std::vector<GlobalVariable *> &TyInfo);
275 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
277 void addFilterTypeInfo(MachineBasicBlock *LandingPad,
278 std::vector<GlobalVariable *> &TyInfo);
280 /// addCleanup - Add a cleanup action for a landing pad.
282 void addCleanup(MachineBasicBlock *LandingPad);
284 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
286 unsigned getTypeIDFor(GlobalVariable *TI);
288 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is
290 int getFilterIDFor(std::vector<unsigned> &TyIds);
292 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
294 void TidyLandingPads();
296 /// getLandingPads - Return a reference to the landing pad info for the
297 /// current function.
298 const std::vector<LandingPadInfo> &getLandingPads() const {
302 /// getTypeInfos - Return a reference to the C++ typeinfo for the current
304 const std::vector<GlobalVariable *> &getTypeInfos() const {
308 /// getFilterIds - Return a reference to the typeids encoding filters used in
309 /// the current function.
310 const std::vector<unsigned> &getFilterIds() const {
314 /// getPersonality - Return a personality function if available. The presence
315 /// of one is required to emit exception handling info.
316 Function *getPersonality() const;
318 /// setVariableDbgInfo - Collect information used to emit debugging information
320 void setVariableDbgInfo(MDNode *N, unsigned Slot, MDNode *Scope) {
321 VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Scope)));
324 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfo; }
326 }; // End class MachineModuleInfo
328 } // End llvm namespace