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