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 47 namespace llvm { 48 49 //===----------------------------------------------------------------------===// 50 // Forward declarations. 51 class Constant; 52 class GlobalVariable; 53 class MDNode; 54 class MMIAddrLabelMap; 55 class MachineBasicBlock; 56 class MachineFunction; 57 class Module; 58 class PointerType; 59 class StructType; 60 61 //===----------------------------------------------------------------------===// 62 /// LandingPadInfo - This structure is used to retain landing pad info for 63 /// the current function. 64 /// 65 struct 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 LandingPadInfoLandingPadInfo73 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 /// 83 class MachineModuleInfoImpl { 84 public: 85 typedef PointerIntPair<MCSymbol*, 1, bool> StubValueTy; 86 virtual ~MachineModuleInfoImpl(); 87 typedef std::vector<std::pair<MCSymbol*, StubValueTy> > SymbolListTy; 88 protected: 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 /// 97 class 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 164 /// UsesMorestackAddr - True if the module calls the __morestack function 165 /// indirectly, as is required under the large code model on x86. This is used 166 /// to emit a definition of a symbol, __morestack_addr, containing the 167 /// address. See comments in lib/Target/X86/X86FrameLowering.cpp for more 168 /// details. 169 bool UsesMorestackAddr; 170 171 public: 172 static char ID; // Pass identification, replacement for typeid 173 174 struct VariableDbgInfo { 175 TrackingMDNodeRef Var; 176 TrackingMDNodeRef Expr; 177 unsigned Slot; 178 DebugLoc Loc; 179 VariableDbgInfoVariableDbgInfo180 VariableDbgInfo(MDNode *Var, MDNode *Expr, unsigned Slot, DebugLoc Loc) 181 : Var(Var), Expr(Expr), Slot(Slot), Loc(Loc) {} 182 }; 183 typedef SmallVector<VariableDbgInfo, 4> VariableDbgInfoMapTy; 184 VariableDbgInfoMapTy VariableDbgInfos; 185 186 MachineModuleInfo(); // DUMMY CONSTRUCTOR, DO NOT CALL. 187 // Real constructor. 188 MachineModuleInfo(const MCAsmInfo &MAI, const MCRegisterInfo &MRI, 189 const MCObjectFileInfo *MOFI); 190 ~MachineModuleInfo(); 191 192 // Initialization and Finalization 193 bool doInitialization(Module &) override; 194 bool doFinalization(Module &) override; 195 196 /// EndFunction - Discard function meta information. 197 /// 198 void EndFunction(); 199 getContext()200 const MCContext &getContext() const { return Context; } getContext()201 MCContext &getContext() { return Context; } 202 setModule(const Module * M)203 void setModule(const Module *M) { TheModule = M; } getModule()204 const Module *getModule() const { return TheModule; } 205 206 /// getInfo - Keep track of various per-function pieces of information for 207 /// backends that would like to do so. 208 /// 209 template<typename Ty> getObjFileInfo()210 Ty &getObjFileInfo() { 211 if (ObjFileMMI == nullptr) 212 ObjFileMMI = new Ty(*this); 213 return *static_cast<Ty*>(ObjFileMMI); 214 } 215 216 template<typename Ty> getObjFileInfo()217 const Ty &getObjFileInfo() const { 218 return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>(); 219 } 220 221 /// AnalyzeModule - Scan the module for global debug information. 222 /// 223 void AnalyzeModule(const Module &M); 224 225 /// hasDebugInfo - Returns true if valid debug info is present. 226 /// hasDebugInfo()227 bool hasDebugInfo() const { return DbgInfoAvailable; } setDebugInfoAvailability(bool avail)228 void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = avail; } 229 callsEHReturn()230 bool callsEHReturn() const { return CallsEHReturn; } setCallsEHReturn(bool b)231 void setCallsEHReturn(bool b) { CallsEHReturn = b; } 232 callsUnwindInit()233 bool callsUnwindInit() const { return CallsUnwindInit; } setCallsUnwindInit(bool b)234 void setCallsUnwindInit(bool b) { CallsUnwindInit = b; } 235 usesVAFloatArgument()236 bool usesVAFloatArgument() const { 237 return UsesVAFloatArgument; 238 } 239 setUsesVAFloatArgument(bool b)240 void setUsesVAFloatArgument(bool b) { 241 UsesVAFloatArgument = b; 242 } 243 usesMorestackAddr()244 bool usesMorestackAddr() const { 245 return UsesMorestackAddr; 246 } 247 setUsesMorestackAddr(bool b)248 void setUsesMorestackAddr(bool b) { 249 UsesMorestackAddr = b; 250 } 251 252 /// \brief Returns a reference to a list of cfi instructions in the current 253 /// function's prologue. Used to construct frame maps for debug and exception 254 /// handling comsumers. getFrameInstructions()255 const std::vector<MCCFIInstruction> &getFrameInstructions() const { 256 return FrameInstructions; 257 } 258 259 unsigned LLVM_ATTRIBUTE_UNUSED_RESULT addFrameInst(const MCCFIInstruction & Inst)260 addFrameInst(const MCCFIInstruction &Inst) { 261 FrameInstructions.push_back(Inst); 262 return FrameInstructions.size() - 1; 263 } 264 265 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic 266 /// block when its address is taken. This cannot be its normal LBB label 267 /// because the block may be accessed outside its containing function. 268 MCSymbol *getAddrLabelSymbol(const BasicBlock *BB); 269 270 /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified 271 /// basic block when its address is taken. If other blocks were RAUW'd to 272 /// this one, we may have to emit them as well, return the whole set. 273 std::vector<MCSymbol*> getAddrLabelSymbolToEmit(const BasicBlock *BB); 274 275 /// takeDeletedSymbolsForFunction - If the specified function has had any 276 /// references to address-taken blocks generated, but the block got deleted, 277 /// return the symbol now so we can emit it. This prevents emitting a 278 /// reference to a symbol that has no definition. 279 void takeDeletedSymbolsForFunction(const Function *F, 280 std::vector<MCSymbol*> &Result); 281 282 283 //===- EH ---------------------------------------------------------------===// 284 285 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the 286 /// specified MachineBasicBlock. 287 LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad); 288 289 /// addInvoke - Provide the begin and end labels of an invoke style call and 290 /// associate it with a try landing pad block. 291 void addInvoke(MachineBasicBlock *LandingPad, 292 MCSymbol *BeginLabel, MCSymbol *EndLabel); 293 294 /// addLandingPad - Add a new panding pad. Returns the label ID for the 295 /// landing pad entry. 296 MCSymbol *addLandingPad(MachineBasicBlock *LandingPad); 297 298 /// addPersonality - Provide the personality function for the exception 299 /// information. 300 void addPersonality(MachineBasicBlock *LandingPad, 301 const Function *Personality); 302 303 /// getPersonalityIndex - Get index of the current personality function inside 304 /// Personalitites array 305 unsigned getPersonalityIndex() const; 306 307 /// getPersonalities - Return array of personality functions ever seen. getPersonalities()308 const std::vector<const Function *>& getPersonalities() const { 309 return Personalities; 310 } 311 312 /// isUsedFunction - Return true if the functions in the llvm.used list. This 313 /// does not return true for things in llvm.compiler.used unless they are also 314 /// in llvm.used. isUsedFunction(const Function * F)315 bool isUsedFunction(const Function *F) const { 316 return UsedFunctions.count(F); 317 } 318 319 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad. 320 /// 321 void addCatchTypeInfo(MachineBasicBlock *LandingPad, 322 ArrayRef<const GlobalValue *> TyInfo); 323 324 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad. 325 /// 326 void addFilterTypeInfo(MachineBasicBlock *LandingPad, 327 ArrayRef<const GlobalValue *> TyInfo); 328 329 /// addCleanup - Add a cleanup action for a landing pad. 330 /// 331 void addCleanup(MachineBasicBlock *LandingPad); 332 333 /// getTypeIDFor - Return the type id for the specified typeinfo. This is 334 /// function wide. 335 unsigned getTypeIDFor(const GlobalValue *TI); 336 337 /// getFilterIDFor - Return the id of the filter encoded by TyIds. This is 338 /// function wide. 339 int getFilterIDFor(std::vector<unsigned> &TyIds); 340 341 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing 342 /// pads. 343 void TidyLandingPads(DenseMap<MCSymbol*, uintptr_t> *LPMap = nullptr); 344 345 /// getLandingPads - Return a reference to the landing pad info for the 346 /// current function. getLandingPads()347 const std::vector<LandingPadInfo> &getLandingPads() const { 348 return LandingPads; 349 } 350 351 /// setCallSiteLandingPad - Map the landing pad's EH symbol to the call 352 /// site indexes. 353 void setCallSiteLandingPad(MCSymbol *Sym, ArrayRef<unsigned> Sites); 354 355 /// getCallSiteLandingPad - Get the call site indexes for a landing pad EH 356 /// symbol. getCallSiteLandingPad(MCSymbol * Sym)357 SmallVectorImpl<unsigned> &getCallSiteLandingPad(MCSymbol *Sym) { 358 assert(hasCallSiteLandingPad(Sym) && 359 "missing call site number for landing pad!"); 360 return LPadToCallSiteMap[Sym]; 361 } 362 363 /// hasCallSiteLandingPad - Return true if the landing pad Eh symbol has an 364 /// associated call site. hasCallSiteLandingPad(MCSymbol * Sym)365 bool hasCallSiteLandingPad(MCSymbol *Sym) { 366 return !LPadToCallSiteMap[Sym].empty(); 367 } 368 369 /// setCallSiteBeginLabel - Map the begin label for a call site. setCallSiteBeginLabel(MCSymbol * BeginLabel,unsigned Site)370 void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) { 371 CallSiteMap[BeginLabel] = Site; 372 } 373 374 /// getCallSiteBeginLabel - Get the call site number for a begin label. getCallSiteBeginLabel(MCSymbol * BeginLabel)375 unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) { 376 assert(hasCallSiteBeginLabel(BeginLabel) && 377 "Missing call site number for EH_LABEL!"); 378 return CallSiteMap[BeginLabel]; 379 } 380 381 /// hasCallSiteBeginLabel - Return true if the begin label has a call site 382 /// number associated with it. hasCallSiteBeginLabel(MCSymbol * BeginLabel)383 bool hasCallSiteBeginLabel(MCSymbol *BeginLabel) { 384 return CallSiteMap[BeginLabel] != 0; 385 } 386 387 /// setCurrentCallSite - Set the call site currently being processed. setCurrentCallSite(unsigned Site)388 void setCurrentCallSite(unsigned Site) { CurCallSite = Site; } 389 390 /// getCurrentCallSite - Get the call site currently being processed, if any. 391 /// return zero if none. getCurrentCallSite()392 unsigned getCurrentCallSite() { return CurCallSite; } 393 394 /// getTypeInfos - Return a reference to the C++ typeinfo for the current 395 /// function. getTypeInfos()396 const std::vector<const GlobalValue *> &getTypeInfos() const { 397 return TypeInfos; 398 } 399 400 /// getFilterIds - Return a reference to the typeids encoding filters used in 401 /// the current function. getFilterIds()402 const std::vector<unsigned> &getFilterIds() const { 403 return FilterIds; 404 } 405 406 /// getPersonality - Return a personality function if available. The presence 407 /// of one is required to emit exception handling info. 408 const Function *getPersonality() const; 409 410 /// setVariableDbgInfo - Collect information used to emit debugging 411 /// information of a variable. setVariableDbgInfo(MDNode * Var,MDNode * Expr,unsigned Slot,DebugLoc Loc)412 void setVariableDbgInfo(MDNode *Var, MDNode *Expr, unsigned Slot, 413 DebugLoc Loc) { 414 VariableDbgInfos.emplace_back(Var, Expr, Slot, Loc); 415 } 416 getVariableDbgInfo()417 VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfos; } 418 419 }; // End class MachineModuleInfo 420 421 } // End llvm namespace 422 423 #endif 424