MachineModuleInfo.h revision 0e6a052331f674dd70e28af41f654a7874405eab
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/Pass.h" 35#include "llvm/GlobalValue.h" 36#include "llvm/Metadata.h" 37#include "llvm/CodeGen/MachineLocation.h" 38#include "llvm/MC/MCContext.h" 39#include "llvm/Support/Dwarf.h" 40#include "llvm/Support/DebugLoc.h" 41#include "llvm/Support/ValueHandle.h" 42#include "llvm/Support/DataTypes.h" 43#include "llvm/ADT/DenseMap.h" 44#include "llvm/ADT/PointerIntPair.h" 45#include "llvm/ADT/SmallPtrSet.h" 46#include "llvm/ADT/SmallVector.h" 47 48namespace llvm { 49 50//===----------------------------------------------------------------------===// 51// Forward declarations. 52class Constant; 53class GlobalVariable; 54class MDNode; 55class MMIAddrLabelMap; 56class MachineBasicBlock; 57class MachineFunction; 58class Module; 59class PointerType; 60class StructType; 61 62//===----------------------------------------------------------------------===// 63/// LandingPadInfo - This structure is used to retain landing pad info for 64/// the current function. 65/// 66struct LandingPadInfo { 67 MachineBasicBlock *LandingPadBlock; // Landing pad block. 68 SmallVector<MCSymbol*, 1> BeginLabels; // Labels prior to invoke. 69 SmallVector<MCSymbol*, 1> EndLabels; // Labels after invoke. 70 MCSymbol *LandingPadLabel; // Label at beginning of landing pad. 71 const Function *Personality; // Personality function. 72 std::vector<int> TypeIds; // List of type ids (filters negative) 73 74 explicit LandingPadInfo(MachineBasicBlock *MBB) 75 : LandingPadBlock(MBB), LandingPadLabel(0), Personality(0) {} 76}; 77 78//===----------------------------------------------------------------------===// 79/// MachineModuleInfoImpl - This class can be derived from and used by targets 80/// to hold private target-specific information for each Module. Objects of 81/// type are accessed/created with MMI::getInfo and destroyed when the 82/// MachineModuleInfo is destroyed. 83/// 84class MachineModuleInfoImpl { 85public: 86 typedef PointerIntPair<MCSymbol*, 1, bool> StubValueTy; 87 virtual ~MachineModuleInfoImpl(); 88 typedef std::vector<std::pair<MCSymbol*, StubValueTy> > SymbolListTy; 89protected: 90 static SymbolListTy GetSortedStubs(const DenseMap<MCSymbol*, StubValueTy>&); 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 /// Context - This is the MCContext used for the entire code generator. 100 MCContext Context; 101 102 /// TheModule - This is the LLVM Module being worked on. 103 const Module *TheModule; 104 105 /// ObjFileMMI - This is the object-file-format-specific implementation of 106 /// MachineModuleInfoImpl, which lets targets accumulate whatever info they 107 /// want. 108 MachineModuleInfoImpl *ObjFileMMI; 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 // Map of invoke call site index values to associated begin EH_LABEL for 119 // the current function. 120 DenseMap<MCSymbol*, unsigned> CallSiteMap; 121 122 // The current call site index being processed, if any. 0 if none. 123 unsigned CurCallSite; 124 125 // TypeInfos - List of C++ TypeInfo used in the current function. 126 // 127 std::vector<const GlobalVariable *> TypeInfos; 128 129 // FilterIds - List of typeids encoding filters used in the current function. 130 // 131 std::vector<unsigned> FilterIds; 132 133 // FilterEnds - List of the indices in FilterIds corresponding to filter 134 // terminators. 135 // 136 std::vector<unsigned> FilterEnds; 137 138 // Personalities - Vector of all personality functions ever seen. Used to emit 139 // common EH frames. 140 std::vector<const Function *> Personalities; 141 142 /// UsedFunctions - The functions in the @llvm.used list in a more easily 143 /// searchable format. This does not include the functions in 144 /// llvm.compiler.used. 145 SmallPtrSet<const Function *, 32> UsedFunctions; 146 147 148 /// AddrLabelSymbols - This map keeps track of which symbol is being used for 149 /// the specified basic block's address of label. 150 MMIAddrLabelMap *AddrLabelSymbols; 151 152 bool CallsEHReturn; 153 bool CallsUnwindInit; 154 155 /// DbgInfoAvailable - True if debugging information is available 156 /// in this module. 157 bool DbgInfoAvailable; 158 159 /// True if this module calls VarArg function with floating point arguments. 160 /// This is used to emit an undefined reference to fltused on Windows targets. 161 bool CallsExternalVAFunctionWithFloatingPointArguments; 162 163public: 164 static char ID; // Pass identification, replacement for typeid 165 166 typedef std::pair<unsigned, DebugLoc> UnsignedDebugLocPair; 167 typedef SmallVector<std::pair<TrackingVH<MDNode>, UnsignedDebugLocPair>, 4> 168 VariableDbgInfoMapTy; 169 VariableDbgInfoMapTy VariableDbgInfo; 170 171 MachineModuleInfo(); // DUMMY CONSTRUCTOR, DO NOT CALL. 172 // Real constructor. 173 MachineModuleInfo(const MCAsmInfo &MAI, const MCRegisterInfo &MRI, 174 const TargetAsmInfo *TAI); 175 ~MachineModuleInfo(); 176 177 bool doInitialization(); 178 bool doFinalization(); 179 180 /// EndFunction - Discard function meta information. 181 /// 182 void EndFunction(); 183 184 const MCContext &getContext() const { return Context; } 185 MCContext &getContext() { return Context; } 186 187 void setModule(const Module *M) { TheModule = M; } 188 const Module *getModule() const { return TheModule; } 189 190 /// getInfo - Keep track of various per-function pieces of information for 191 /// backends that would like to do so. 192 /// 193 template<typename Ty> 194 Ty &getObjFileInfo() { 195 if (ObjFileMMI == 0) 196 ObjFileMMI = new Ty(*this); 197 return *static_cast<Ty*>(ObjFileMMI); 198 } 199 200 template<typename Ty> 201 const Ty &getObjFileInfo() const { 202 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>(); 203 } 204 205 /// AnalyzeModule - Scan the module for global debug information. 206 /// 207 void AnalyzeModule(const Module &M); 208 209 /// hasDebugInfo - Returns true if valid debug info is present. 210 /// 211 bool hasDebugInfo() const { return DbgInfoAvailable; } 212 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = avail; } 213 214 bool callsEHReturn() const { return CallsEHReturn; } 215 void setCallsEHReturn(bool b) { CallsEHReturn = b; } 216 217 bool callsUnwindInit() const { return CallsUnwindInit; } 218 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; } 219 220 bool callsExternalVAFunctionWithFloatingPointArguments() const { 221 return CallsExternalVAFunctionWithFloatingPointArguments; 222 } 223 224 void setCallsExternalVAFunctionWithFloatingPointArguments(bool b) { 225 CallsExternalVAFunctionWithFloatingPointArguments = b; 226 } 227 228 /// getFrameMoves - Returns a reference to a list of moves done in the current 229 /// function's prologue. Used to construct frame maps for debug and exception 230 /// handling comsumers. 231 std::vector<MachineMove> &getFrameMoves() { return FrameMoves; } 232 233 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic 234 /// block when its address is taken. This cannot be its normal LBB label 235 /// because the block may be accessed outside its containing function. 236 MCSymbol *getAddrLabelSymbol(const BasicBlock *BB); 237 238 /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified 239 /// basic block when its address is taken. If other blocks were RAUW'd to 240 /// this one, we may have to emit them as well, return the whole set. 241 std::vector<MCSymbol*> getAddrLabelSymbolToEmit(const BasicBlock *BB); 242 243 /// takeDeletedSymbolsForFunction - If the specified function has had any 244 /// references to address-taken blocks generated, but the block got deleted, 245 /// return the symbol now so we can emit it. This prevents emitting a 246 /// reference to a symbol that has no definition. 247 void takeDeletedSymbolsForFunction(const Function *F, 248 std::vector<MCSymbol*> &Result); 249 250 251 //===- EH ---------------------------------------------------------------===// 252 253 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the 254 /// specified MachineBasicBlock. 255 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad); 256 257 /// addInvoke - Provide the begin and end labels of an invoke style call and 258 /// associate it with a try landing pad block. 259 void addInvoke(MachineBasicBlock *LandingPad, 260 MCSymbol *BeginLabel, MCSymbol *EndLabel); 261 262 /// addLandingPad - Add a new panding pad. Returns the label ID for the 263 /// landing pad entry. 264 MCSymbol *addLandingPad(MachineBasicBlock *LandingPad); 265 266 /// addPersonality - Provide the personality function for the exception 267 /// information. 268 void addPersonality(MachineBasicBlock *LandingPad, 269 const Function *Personality); 270 271 /// getPersonalityIndex - Get index of the current personality function inside 272 /// Personalitites array 273 unsigned getPersonalityIndex() const; 274 275 /// getPersonalities - Return array of personality functions ever seen. 276 const std::vector<const Function *>& getPersonalities() const { 277 return Personalities; 278 } 279 280 /// isUsedFunction - Return true if the functions in the llvm.used list. This 281 /// does not return true for things in llvm.compiler.used unless they are also 282 /// in llvm.used. 283 bool isUsedFunction(const Function *F) { 284 return UsedFunctions.count(F); 285 } 286 287 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad. 288 /// 289 void addCatchTypeInfo(MachineBasicBlock *LandingPad, 290 std::vector<const GlobalVariable *> &TyInfo); 291 292 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad. 293 /// 294 void addFilterTypeInfo(MachineBasicBlock *LandingPad, 295 std::vector<const GlobalVariable *> &TyInfo); 296 297 /// addCleanup - Add a cleanup action for a landing pad. 298 /// 299 void addCleanup(MachineBasicBlock *LandingPad); 300 301 /// getTypeIDFor - Return the type id for the specified typeinfo. This is 302 /// function wide. 303 unsigned getTypeIDFor(const GlobalVariable *TI); 304 305 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is 306 /// function wide. 307 int getFilterIDFor(std::vector<unsigned> &TyIds); 308 309 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing 310 /// pads. 311 void TidyLandingPads(DenseMap<MCSymbol*, uintptr_t> *LPMap = 0); 312 313 /// getLandingPads - Return a reference to the landing pad info for the 314 /// current function. 315 const std::vector<LandingPadInfo> &getLandingPads() const { 316 return LandingPads; 317 } 318 319 /// setCallSiteBeginLabel - Map the begin label for a call site 320 void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) { 321 CallSiteMap[BeginLabel] = Site; 322 } 323 324 /// getCallSiteBeginLabel - Get the call site number for a begin label 325 unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) { 326 assert(CallSiteMap.count(BeginLabel) && 327 "Missing call site number for EH_LABEL!"); 328 return CallSiteMap[BeginLabel]; 329 } 330 331 /// setCurrentCallSite - Set the call site currently being processed. 332 void setCurrentCallSite(unsigned Site) { CurCallSite = Site; } 333 334 /// getCurrentCallSite - Get the call site currently being processed, if any. 335 /// return zero if none. 336 unsigned getCurrentCallSite(void) { return CurCallSite; } 337 338 /// getTypeInfos - Return a reference to the C++ typeinfo for the current 339 /// function. 340 const std::vector<const GlobalVariable *> &getTypeInfos() const { 341 return TypeInfos; 342 } 343 344 /// getFilterIds - Return a reference to the typeids encoding filters used in 345 /// the current function. 346 const std::vector<unsigned> &getFilterIds() const { 347 return FilterIds; 348 } 349 350 /// getPersonality - Return a personality function if available. The presence 351 /// of one is required to emit exception handling info. 352 const Function *getPersonality() const; 353 354 /// setVariableDbgInfo - Collect information used to emit debugging 355 /// information of a variable. 356 void setVariableDbgInfo(MDNode *N, unsigned Slot, DebugLoc Loc) { 357 VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Loc))); 358 } 359 360 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfo; } 361 362}; // End class MachineModuleInfo 363 364} // End llvm namespace 365 366#endif 367