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/Support/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"
48 //===----------------------------------------------------------------------===//
49 // Forward declarations.
52 class MachineBasicBlock;
53 class MachineFunction;
59 /// MachineModuleInfoImpl - This class can be derived from and used by targets
60 /// to hold private target-specific information for each Module. Objects of
61 /// type are accessed/created with MMI::getInfo and destroyed when the
62 /// MachineModuleInfo is destroyed.
63 class MachineModuleInfoImpl {
65 virtual ~MachineModuleInfoImpl();
70 //===----------------------------------------------------------------------===//
71 /// LandingPadInfo - This structure is used to retain landing pad info for
72 /// the current function.
74 struct LandingPadInfo {
75 MachineBasicBlock *LandingPadBlock; // Landing pad block.
76 SmallVector<unsigned, 1> BeginLabels; // Labels prior to invoke.
77 SmallVector<unsigned, 1> EndLabels; // Labels after invoke.
78 unsigned LandingPadLabel; // Label at beginning of landing pad.
79 Function *Personality; // Personality function.
80 std::vector<int> TypeIds; // List of type ids (filters negative)
82 explicit LandingPadInfo(MachineBasicBlock *MBB)
83 : LandingPadBlock(MBB)
89 //===----------------------------------------------------------------------===//
90 /// MachineModuleInfo - This class contains meta information specific to a
91 /// module. Queries can be made by different debugging and exception handling
92 /// schemes and reformated for specific use.
94 class MachineModuleInfo : public ImmutablePass {
95 /// ObjFileMMI - This is the object-file-format-specific implementation of
96 /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
98 MachineModuleInfoImpl *ObjFileMMI;
100 // LabelIDList - One entry per assigned label. Normally the entry is equal to
101 // the list index(+1). If the entry is zero then the label has been deleted.
102 // Any other value indicates the label has been deleted by is mapped to
104 std::vector<unsigned> LabelIDList;
106 // FrameMoves - List of moves done by a function's prolog. Used to construct
107 // frame maps by debug and exception handling consumers.
108 std::vector<MachineMove> FrameMoves;
110 // LandingPads - List of LandingPadInfo describing the landing pad information
111 // in the current function.
112 std::vector<LandingPadInfo> LandingPads;
114 // TypeInfos - List of C++ TypeInfo used in the current function.
116 std::vector<GlobalVariable *> TypeInfos;
118 // FilterIds - List of typeids encoding filters used in the current function.
120 std::vector<unsigned> FilterIds;
122 // FilterEnds - List of the indices in FilterIds corresponding to filter
125 std::vector<unsigned> FilterEnds;
127 // Personalities - Vector of all personality functions ever seen. Used to emit
129 std::vector<Function *> Personalities;
131 /// UsedFunctions - The functions in the @llvm.used list in a more easily
132 /// searchable format. This does not include the functions in
133 /// llvm.compiler.used.
134 SmallPtrSet<const Function *, 32> UsedFunctions;
136 /// UsedDbgLabels - labels are used by debug info entries.
137 SmallSet<unsigned, 8> UsedDbgLabels;
140 bool CallsUnwindInit;
142 /// DbgInfoAvailable - True if debugging information is available
144 bool DbgInfoAvailable;
146 static char ID; // Pass identification, replacement for typeid
149 ~MachineModuleInfo();
151 bool doInitialization();
152 bool doFinalization();
154 /// BeginFunction - Begin gathering function meta information.
156 void BeginFunction(MachineFunction *MF) {}
158 /// EndFunction - Discard function meta information.
162 /// getInfo - Keep track of various per-function pieces of information for
163 /// backends that would like to do so.
165 template<typename Ty>
166 Ty &getObjFileInfo() {
168 ObjFileMMI = new Ty(*this);
170 assert((void*)dynamic_cast<Ty*>(ObjFileMMI) == (void*)ObjFileMMI &&
171 "Invalid concrete type or multiple inheritence for getInfo");
172 return *static_cast<Ty*>(ObjFileMMI);
175 template<typename Ty>
176 const Ty &getObjFileInfo() const {
177 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
180 /// AnalyzeModule - Scan the module for global debug information.
182 void AnalyzeModule(Module &M);
184 /// hasDebugInfo - Returns true if valid debug info is present.
186 bool hasDebugInfo() const { return DbgInfoAvailable; }
187 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
189 bool callsEHReturn() const { return CallsEHReturn; }
190 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
192 bool callsUnwindInit() const { return CallsUnwindInit; }
193 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
195 /// NextLabelID - Return the next unique label id.
197 unsigned NextLabelID() {
198 unsigned ID = (unsigned)LabelIDList.size() + 1;
199 LabelIDList.push_back(ID);
203 /// InvalidateLabel - Inhibit use of the specified label # from
204 /// MachineModuleInfo, for example because the code was deleted.
205 void InvalidateLabel(unsigned LabelID) {
206 // Remap to zero to indicate deletion.
207 RemapLabel(LabelID, 0);
210 /// RemapLabel - Indicate that a label has been merged into another.
212 void RemapLabel(unsigned OldLabelID, unsigned NewLabelID) {
213 assert(0 < OldLabelID && OldLabelID <= LabelIDList.size() &&
214 "Old label ID out of range.");
215 assert(NewLabelID <= LabelIDList.size() &&
216 "New label ID out of range.");
217 LabelIDList[OldLabelID - 1] = NewLabelID;
220 /// MappedLabel - Find out the label's final ID. Zero indicates deletion.
221 /// ID != Mapped ID indicates that the label was folded into another label.
222 unsigned MappedLabel(unsigned LabelID) const {
223 assert(LabelID <= LabelIDList.size() && "Debug label ID out of range.");
224 return LabelID ? LabelIDList[LabelID - 1] : 0;
227 /// isDbgLabelUsed - Return true if label with LabelID is used by
229 bool isDbgLabelUsed(unsigned LabelID) {
230 return UsedDbgLabels.count(LabelID);
233 /// RecordUsedDbgLabel - Mark label with LabelID as used. This is used
234 /// by DwarfWriter to inform DebugLabelFolder that certain labels are
235 /// not to be deleted.
236 void RecordUsedDbgLabel(unsigned LabelID) {
237 UsedDbgLabels.insert(LabelID);
240 /// getFrameMoves - Returns a reference to a list of moves done in the current
241 /// function's prologue. Used to construct frame maps for debug and exception
242 /// handling comsumers.
243 std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
245 //===-EH-----------------------------------------------------------------===//
247 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
248 /// specified MachineBasicBlock.
249 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
251 /// addInvoke - Provide the begin and end labels of an invoke style call and
252 /// associate it with a try landing pad block.
253 void addInvoke(MachineBasicBlock *LandingPad, unsigned BeginLabel,
256 /// addLandingPad - Add a new panding pad. Returns the label ID for the
257 /// landing pad entry.
258 unsigned addLandingPad(MachineBasicBlock *LandingPad);
260 /// addPersonality - Provide the personality function for the exception
262 void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
264 /// getPersonalityIndex - Get index of the current personality function inside
265 /// Personalitites array
266 unsigned getPersonalityIndex() const;
268 /// getPersonalities - Return array of personality functions ever seen.
269 const std::vector<Function *>& getPersonalities() const {
270 return Personalities;
273 /// isUsedFunction - Return true if the functions in the llvm.used list. This
274 /// does not return true for things in llvm.compiler.used unless they are also
276 bool isUsedFunction(const Function *F) {
277 return UsedFunctions.count(F);
280 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
282 void addCatchTypeInfo(MachineBasicBlock *LandingPad,
283 std::vector<GlobalVariable *> &TyInfo);
285 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
287 void addFilterTypeInfo(MachineBasicBlock *LandingPad,
288 std::vector<GlobalVariable *> &TyInfo);
290 /// addCleanup - Add a cleanup action for a landing pad.
292 void addCleanup(MachineBasicBlock *LandingPad);
294 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
296 unsigned getTypeIDFor(GlobalVariable *TI);
298 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is
300 int getFilterIDFor(std::vector<unsigned> &TyIds);
302 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
304 void TidyLandingPads();
306 /// getLandingPads - Return a reference to the landing pad info for the
307 /// current function.
308 const std::vector<LandingPadInfo> &getLandingPads() const {
312 /// getTypeInfos - Return a reference to the C++ typeinfo for the current
314 const std::vector<GlobalVariable *> &getTypeInfos() const {
318 /// getFilterIds - Return a reference to the typeids encoding filters used in
319 /// the current function.
320 const std::vector<unsigned> &getFilterIds() const {
324 /// getPersonality - Return a personality function if available. The presence
325 /// of one is required to emit exception handling info.
326 Function *getPersonality() const;
328 }; // End class MachineModuleInfo
330 } // End llvm namespace