MachineModuleInfo.h revision 8b67f774e9c38b7718b2b300b628388f966df4e0
1//===-- llvm/CodeGen/MachineModuleInfo.h ------------------------*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 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 12// schemes. 13// 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. 17// 18// The following information can be retrieved from the MachineModuleInfo. 19// 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. 28// 29//===----------------------------------------------------------------------===// 30 31#ifndef LLVM_CODEGEN_MACHINEMODULEINFO_H 32#define LLVM_CODEGEN_MACHINEMODULEINFO_H 33 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 47#define ATTACH_DEBUG_INFO_TO_AN_INSN 1 48 49namespace llvm { 50 51//===----------------------------------------------------------------------===// 52// Forward declarations. 53class Constant; 54class MDNode; 55class GlobalVariable; 56class MachineBasicBlock; 57class MachineFunction; 58class Module; 59class PointerType; 60class StructType; 61 62 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. 67class MachineModuleInfoImpl { 68public: 69 virtual ~MachineModuleInfoImpl(); 70}; 71 72 73 74//===----------------------------------------------------------------------===// 75/// LandingPadInfo - This structure is used to retain landing pad info for 76/// the current function. 77/// 78struct 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) 85 86 explicit LandingPadInfo(MachineBasicBlock *MBB) 87 : LandingPadBlock(MBB) 88 , LandingPadLabel(0) 89 , Personality(NULL) 90 {} 91}; 92 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. 97/// 98class MachineModuleInfo : public ImmutablePass { 99 /// ObjFileMMI - This is the object-file-format-specific implementation of 100 /// MachineModuleInfoImpl, which lets targets accumulate whatever info they 101 /// want. 102 MachineModuleInfoImpl *ObjFileMMI; 103 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 107 // another label. 108 std::vector<unsigned> LabelIDList; 109 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; 113 114 // LandingPads - List of LandingPadInfo describing the landing pad information 115 // in the current function. 116 std::vector<LandingPadInfo> LandingPads; 117 118 // TypeInfos - List of C++ TypeInfo used in the current function. 119 // 120 std::vector<GlobalVariable *> TypeInfos; 121 122 // FilterIds - List of typeids encoding filters used in the current function. 123 // 124 std::vector<unsigned> FilterIds; 125 126 // FilterEnds - List of the indices in FilterIds corresponding to filter 127 // terminators. 128 // 129 std::vector<unsigned> FilterEnds; 130 131 // Personalities - Vector of all personality functions ever seen. Used to emit 132 // common EH frames. 133 std::vector<Function *> Personalities; 134 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; 139 140 /// UsedDbgLabels - labels are used by debug info entries. 141 SmallSet<unsigned, 8> UsedDbgLabels; 142 143 bool CallsEHReturn; 144 bool CallsUnwindInit; 145 146 /// DbgInfoAvailable - True if debugging information is available 147 /// in this module. 148 bool DbgInfoAvailable; 149 150public: 151 static char ID; // Pass identification, replacement for typeid 152 153 typedef SmallVector< std::pair<TrackingVH<MDNode>, unsigned>, 4 > 154 VariableDbgInfoMapTy; 155 VariableDbgInfoMapTy VariableDbgInfo; 156 157 MachineModuleInfo(); 158 ~MachineModuleInfo(); 159 160 bool doInitialization(); 161 bool doFinalization(); 162 163 /// BeginFunction - Begin gathering function meta information. 164 /// 165 void BeginFunction(MachineFunction *) {} 166 167 /// EndFunction - Discard function meta information. 168 /// 169 void EndFunction(); 170 171 /// getInfo - Keep track of various per-function pieces of information for 172 /// backends that would like to do so. 173 /// 174 template<typename Ty> 175 Ty &getObjFileInfo() { 176 if (ObjFileMMI == 0) 177 ObjFileMMI = new Ty(*this); 178 179 assert((void*)dynamic_cast<Ty*>(ObjFileMMI) == (void*)ObjFileMMI && 180 "Invalid concrete type or multiple inheritence for getInfo"); 181 return *static_cast<Ty*>(ObjFileMMI); 182 } 183 184 template<typename Ty> 185 const Ty &getObjFileInfo() const { 186 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>(); 187 } 188 189 /// AnalyzeModule - Scan the module for global debug information. 190 /// 191 void AnalyzeModule(Module &M); 192 193 /// hasDebugInfo - Returns true if valid debug info is present. 194 /// 195 bool hasDebugInfo() const { return DbgInfoAvailable; } 196 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; } 197 198 bool callsEHReturn() const { return CallsEHReturn; } 199 void setCallsEHReturn(bool b) { CallsEHReturn = b; } 200 201 bool callsUnwindInit() const { return CallsUnwindInit; } 202 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; } 203 204 /// NextLabelID - Return the next unique label id. 205 /// 206 unsigned NextLabelID() { 207 unsigned ID = (unsigned)LabelIDList.size() + 1; 208 LabelIDList.push_back(ID); 209 return ID; 210 } 211 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); 217 } 218 219 /// RemapLabel - Indicate that a label has been merged into another. 220 /// 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; 227 } 228 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; 234 } 235 236 /// isDbgLabelUsed - Return true if label with LabelID is used by 237 /// DwarfWriter. 238 bool isDbgLabelUsed(unsigned LabelID) { 239 return UsedDbgLabels.count(LabelID); 240 } 241 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); 247 } 248 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; } 253 254 //===-EH-----------------------------------------------------------------===// 255 256 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the 257 /// specified MachineBasicBlock. 258 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad); 259 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, 263 unsigned EndLabel); 264 265 /// addLandingPad - Add a new panding pad. Returns the label ID for the 266 /// landing pad entry. 267 unsigned addLandingPad(MachineBasicBlock *LandingPad); 268 269 /// addPersonality - Provide the personality function for the exception 270 /// information. 271 void addPersonality(MachineBasicBlock *LandingPad, Function *Personality); 272 273 /// getPersonalityIndex - Get index of the current personality function inside 274 /// Personalitites array 275 unsigned getPersonalityIndex() const; 276 277 /// getPersonalities - Return array of personality functions ever seen. 278 const std::vector<Function *>& getPersonalities() const { 279 return Personalities; 280 } 281 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 284 /// in llvm.used. 285 bool isUsedFunction(const Function *F) { 286 return UsedFunctions.count(F); 287 } 288 289 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad. 290 /// 291 void addCatchTypeInfo(MachineBasicBlock *LandingPad, 292 std::vector<GlobalVariable *> &TyInfo); 293 294 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad. 295 /// 296 void addFilterTypeInfo(MachineBasicBlock *LandingPad, 297 std::vector<GlobalVariable *> &TyInfo); 298 299 /// addCleanup - Add a cleanup action for a landing pad. 300 /// 301 void addCleanup(MachineBasicBlock *LandingPad); 302 303 /// getTypeIDFor - Return the type id for the specified typeinfo. This is 304 /// function wide. 305 unsigned getTypeIDFor(GlobalVariable *TI); 306 307 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is 308 /// function wide. 309 int getFilterIDFor(std::vector<unsigned> &TyIds); 310 311 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing 312 /// pads. 313 void TidyLandingPads(); 314 315 /// getLandingPads - Return a reference to the landing pad info for the 316 /// current function. 317 const std::vector<LandingPadInfo> &getLandingPads() const { 318 return LandingPads; 319 } 320 321 /// getTypeInfos - Return a reference to the C++ typeinfo for the current 322 /// function. 323 const std::vector<GlobalVariable *> &getTypeInfos() const { 324 return TypeInfos; 325 } 326 327 /// getFilterIds - Return a reference to the typeids encoding filters used in 328 /// the current function. 329 const std::vector<unsigned> &getFilterIds() const { 330 return FilterIds; 331 } 332 333 /// getPersonality - Return a personality function if available. The presence 334 /// of one is required to emit exception handling info. 335 Function *getPersonality() const; 336 337 /// setVariableDbgInfo - Collect information used to emit debugging information 338 /// of a variable. 339 void setVariableDbgInfo(MDNode *N, unsigned S) { 340 VariableDbgInfo.push_back(std::make_pair(N, S)); 341 } 342 343 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfo; } 344 345}; // End class MachineModuleInfo 346 347} // End llvm namespace 348 349#endif 350