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