include/llvm/CodeGen/MachineModuleInfo.h

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