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/StringMap.h"
41 #include "llvm/CodeGen/MachineLocation.h"
42 #include "llvm/GlobalValue.h"
43 #include "llvm/Pass.h"
47 //===----------------------------------------------------------------------===//
48 // Forward declarations.
51 class MachineBasicBlock;
52 class MachineFunction;
57 //===----------------------------------------------------------------------===//
58 /// LandingPadInfo - This structure is used to retain landing pad info for
59 /// the current function.
61 struct LandingPadInfo {
62 MachineBasicBlock *LandingPadBlock; // Landing pad block.
63 SmallVector<unsigned, 1> BeginLabels; // Labels prior to invoke.
64 SmallVector<unsigned, 1> EndLabels; // Labels after invoke.
65 unsigned LandingPadLabel; // Label at beginning of landing pad.
66 Function *Personality; // Personality function.
67 std::vector<int> TypeIds; // List of type ids (filters negative)
69 explicit LandingPadInfo(MachineBasicBlock *MBB)
70 : LandingPadBlock(MBB)
76 //===----------------------------------------------------------------------===//
77 /// MachineModuleInfo - This class contains meta information specific to a
78 /// module. Queries can be made by different debugging and exception handling
79 /// schemes and reformated for specific use.
81 class MachineModuleInfo : public ImmutablePass {
83 // LabelIDList - One entry per assigned label. Normally the entry is equal to
84 // the list index(+1). If the entry is zero then the label has been deleted.
85 // Any other value indicates the label has been deleted by is mapped to
87 std::vector<unsigned> LabelIDList;
89 // FrameMoves - List of moves done by a function's prolog. Used to construct
90 // frame maps by debug and exception handling consumers.
91 std::vector<MachineMove> FrameMoves;
93 // LandingPads - List of LandingPadInfo describing the landing pad information
94 // in the current function.
95 std::vector<LandingPadInfo> LandingPads;
97 // TypeInfos - List of C++ TypeInfo used in the current function.
99 std::vector<GlobalVariable *> TypeInfos;
101 // FilterIds - List of typeids encoding filters used in the current function.
103 std::vector<unsigned> FilterIds;
105 // FilterEnds - List of the indices in FilterIds corresponding to filter
108 std::vector<unsigned> FilterEnds;
110 // Personalities - Vector of all personality functions ever seen. Used to emit
112 std::vector<Function *> Personalities;
114 // UsedFunctions - the functions in the llvm.used list in a more easily
115 // searchable format.
116 SmallPtrSet<const Function *, 32> UsedFunctions;
119 bool CallsUnwindInit;
121 /// DbgInfoAvailable - True if debugging information is available
123 bool DbgInfoAvailable;
125 static char ID; // Pass identification, replacement for typeid
128 ~MachineModuleInfo();
130 /// doInitialization - Initialize the state for a new module.
132 bool doInitialization();
134 /// doFinalization - Tear down the state after completion of a module.
136 bool doFinalization();
138 /// BeginFunction - Begin gathering function meta information.
140 void BeginFunction(MachineFunction *MF);
142 /// EndFunction - Discard function meta information.
146 /// AnalyzeModule - Scan the module for global debug information.
148 void AnalyzeModule(Module &M);
150 /// hasDebugInfo - Returns true if valid debug info is present.
152 bool hasDebugInfo() const { return DbgInfoAvailable; }
153 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
155 bool callsEHReturn() const { return CallsEHReturn; }
156 void setCallsEHReturn(bool b) { CallsEHReturn = b; }
158 bool callsUnwindInit() const { return CallsUnwindInit; }
159 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
161 /// NextLabelID - Return the next unique label id.
163 unsigned NextLabelID() {
164 unsigned ID = (unsigned)LabelIDList.size() + 1;
165 LabelIDList.push_back(ID);
169 /// RecordSourceLine - Records location information and associates it with a
170 /// label. Returns a unique label ID used to generate a label and
171 /// provide correspondence to the source line list.
172 unsigned RecordSourceLine(unsigned Line, unsigned Column, unsigned Source);
174 /// InvalidateLabel - Inhibit use of the specified label # from
175 /// MachineModuleInfo, for example because the code was deleted.
176 void InvalidateLabel(unsigned LabelID) {
177 // Remap to zero to indicate deletion.
178 RemapLabel(LabelID, 0);
181 /// RemapLabel - Indicate that a label has been merged into another.
183 void RemapLabel(unsigned OldLabelID, unsigned NewLabelID) {
184 assert(0 < OldLabelID && OldLabelID <= LabelIDList.size() &&
185 "Old label ID out of range.");
186 assert(NewLabelID <= LabelIDList.size() &&
187 "New label ID out of range.");
188 LabelIDList[OldLabelID - 1] = NewLabelID;
191 /// MappedLabel - Find out the label's final ID. Zero indicates deletion.
192 /// ID != Mapped ID indicates that the label was folded into another label.
193 unsigned MappedLabel(unsigned LabelID) const {
194 assert(LabelID <= LabelIDList.size() && "Debug label ID out of range.");
195 return LabelID ? LabelIDList[LabelID - 1] : 0;
198 /// getFrameMoves - Returns a reference to a list of moves done in the current
199 /// function's prologue. Used to construct frame maps for debug and exception
200 /// handling comsumers.
201 std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
203 //===-EH-----------------------------------------------------------------===//
205 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
206 /// specified MachineBasicBlock.
207 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
209 /// addInvoke - Provide the begin and end labels of an invoke style call and
210 /// associate it with a try landing pad block.
211 void addInvoke(MachineBasicBlock *LandingPad, unsigned BeginLabel,
214 /// addLandingPad - Add a new panding pad. Returns the label ID for the
215 /// landing pad entry.
216 unsigned addLandingPad(MachineBasicBlock *LandingPad);
218 /// addPersonality - Provide the personality function for the exception
220 void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
222 /// getPersonalityIndex - Get index of the current personality function inside
223 /// Personalitites array
224 unsigned getPersonalityIndex() const;
226 /// getPersonalities - Return array of personality functions ever seen.
227 const std::vector<Function *>& getPersonalities() const {
228 return Personalities;
231 // UsedFunctions - Return set of the functions in the llvm.used list.
232 const SmallPtrSet<const Function *, 32>& getUsedFunctions() const {
233 return UsedFunctions;
236 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
238 void addCatchTypeInfo(MachineBasicBlock *LandingPad,
239 std::vector<GlobalVariable *> &TyInfo);
241 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
243 void addFilterTypeInfo(MachineBasicBlock *LandingPad,
244 std::vector<GlobalVariable *> &TyInfo);
246 /// addCleanup - Add a cleanup action for a landing pad.
248 void addCleanup(MachineBasicBlock *LandingPad);
250 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
252 unsigned getTypeIDFor(GlobalVariable *TI);
254 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is
256 int getFilterIDFor(std::vector<unsigned> &TyIds);
258 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
260 void TidyLandingPads();
262 /// getLandingPads - Return a reference to the landing pad info for the
263 /// current function.
264 const std::vector<LandingPadInfo> &getLandingPads() const {
268 /// getTypeInfos - Return a reference to the C++ typeinfo for the current
270 const std::vector<GlobalVariable *> &getTypeInfos() const {
274 /// getFilterIds - Return a reference to the typeids encoding filters used in
275 /// the current function.
276 const std::vector<unsigned> &getFilterIds() const {
280 /// getPersonality - Return a personality function if available. The presence
281 /// of one is required to emit exception handling info.
282 Function *getPersonality() const;
284 }; // End class MachineModuleInfo
286 } // End llvm namespace