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
  63 struct SEHHandler {
  64   // Filter or finally function. Null indicates a catch-all.
  65   const Function *FilterOrFinally;
  66
  67   // Address of block to recover at. Null for a finally handler.
  68   const BlockAddress *RecoverBA;
  69 };
  70
  71 //===----------------------------------------------------------------------===//
  72 /// LandingPadInfo - This structure is used to retain landing pad info for
  73 /// the current function.
  74 ///
  75 struct LandingPadInfo {
  76   MachineBasicBlock *LandingPadBlock;      // Landing pad block.
  77   SmallVector<MCSymbol *, 1> BeginLabels;  // Labels prior to invoke.
  78   SmallVector<MCSymbol *, 1> EndLabels;    // Labels after invoke.
  79   SmallVector<SEHHandler, 1> SEHHandlers;  // SEH handlers active at this lpad.
  80   MCSymbol *LandingPadLabel;               // Label at beginning of landing pad.
  81   std::vector<int> TypeIds;               // List of type ids (filters negative).
  82
  83   explicit LandingPadInfo(MachineBasicBlock *MBB)
  84       : LandingPadBlock(MBB), LandingPadLabel(nullptr) {}
  85 };
  86
  87 //===----------------------------------------------------------------------===//
  88 /// MachineModuleInfoImpl - This class can be derived from and used by targets
  89 /// to hold private target-specific information for each Module.  Objects of
  90 /// type are accessed/created with MMI::getInfo and destroyed when the
  91 /// MachineModuleInfo is destroyed.
  92 ///
  93 class MachineModuleInfoImpl {
  94 public:
  95   typedef PointerIntPair<MCSymbol*, 1, bool> StubValueTy;
  96   virtual ~MachineModuleInfoImpl();
  97   typedef std::vector<std::pair<MCSymbol*, StubValueTy> > SymbolListTy;
  98 protected:
  99
 100   /// Return the entries from a DenseMap in a deterministic sorted orer.
 101   /// Clears the map.
 102   static SymbolListTy getSortedStubs(DenseMap<MCSymbol*, StubValueTy>&);
 103 };
 104
 105 //===----------------------------------------------------------------------===//
 106 /// MachineModuleInfo - This class contains meta information specific to a
 107 /// module.  Queries can be made by different debugging and exception handling
 108 /// schemes and reformated for specific use.
 109 ///
 110 class MachineModuleInfo : public ImmutablePass {
 111   /// Context - This is the MCContext used for the entire code generator.
 112   MCContext Context;
 113
 114   /// TheModule - This is the LLVM Module being worked on.
 115   const Module *TheModule;
 116
 117   /// ObjFileMMI - This is the object-file-format-specific implementation of
 118   /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
 119   /// want.
 120   MachineModuleInfoImpl *ObjFileMMI;
 121
 122   /// List of moves done by a function's prolog.  Used to construct frame maps
 123   /// by debug and exception handling consumers.
 124   std::vector<MCCFIInstruction> FrameInstructions;
 125
 126   /// LandingPads - List of LandingPadInfo describing the landing pad
 127   /// information in the current function.
 128   std::vector<LandingPadInfo> LandingPads;
 129
 130   /// LPadToCallSiteMap - Map a landing pad's EH symbol to the call site
 131   /// indexes.
 132   DenseMap<MCSymbol*, SmallVector<unsigned, 4> > LPadToCallSiteMap;
 133
 134   /// CallSiteMap - Map of invoke call site index values to associated begin
 135   /// EH_LABEL for the current function.
 136   DenseMap<MCSymbol*, unsigned> CallSiteMap;
 137
 138   /// CurCallSite - The current call site index being processed, if any. 0 if
 139   /// none.
 140   unsigned CurCallSite;
 141
 142   /// TypeInfos - List of C++ TypeInfo used in the current function.
 143   std::vector<const GlobalValue *> TypeInfos;
 144
 145   /// FilterIds - List of typeids encoding filters used in the current function.
 146   std::vector<unsigned> FilterIds;
 147
 148   /// FilterEnds - List of the indices in FilterIds corresponding to filter
 149   /// terminators.
 150   std::vector<unsigned> FilterEnds;
 151
 152   /// Personalities - Vector of all personality functions ever seen. Used to
 153   /// emit common EH frames.
 154   std::vector<const Function *> Personalities;
 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   bool HasEHFunclets;
 163
 164   /// DbgInfoAvailable - True if debugging information is available
 165   /// in this module.
 166   bool DbgInfoAvailable;
 167
 168   /// UsesVAFloatArgument - True if this module calls VarArg function with
 169   /// floating-point arguments.  This is used to emit an undefined reference
 170   /// to _fltused on Windows targets.
 171   bool UsesVAFloatArgument;
 172
 173   /// UsesMorestackAddr - True if the module calls the __morestack function
 174   /// indirectly, as is required under the large code model on x86. This is used
 175   /// to emit a definition of a symbol, __morestack_addr, containing the
 176   /// address. See comments in lib/Target/X86/X86FrameLowering.cpp for more
 177   /// details.
 178   bool UsesMorestackAddr;
 179
 180   EHPersonality PersonalityTypeCache;
 181
 182 public:
 183   static char ID; // Pass identification, replacement for typeid
 184
 185   struct VariableDbgInfo {
 186     const DILocalVariable *Var;
 187     const DIExpression *Expr;
 188     unsigned Slot;
 189     const DILocation *Loc;
 190
 191     VariableDbgInfo(const DILocalVariable *Var, const DIExpression *Expr,
 192                     unsigned Slot, const DILocation *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   /// getInfo - Keep track of various per-function pieces of information for
 219   /// backends that would like to do so.
 220   ///
 221   template<typename Ty>
 222   Ty &getObjFileInfo() {
 223     if (ObjFileMMI == nullptr)
 224       ObjFileMMI = new Ty(*this);
 225     return *static_cast<Ty*>(ObjFileMMI);
 226   }
 227
 228   template<typename Ty>
 229   const Ty &getObjFileInfo() const {
 230     return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
 231   }
 232
 233   /// hasDebugInfo - Returns true if valid debug info is present.
 234   ///
 235   bool hasDebugInfo() const { return DbgInfoAvailable; }
 236   void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = avail; }
 237
 238   // Returns true if we need to generate precise CFI. Currently
 239   // this is equivalent to hasDebugInfo(), but if we ever implement
 240   // async EH, it will require precise CFI as well.
 241   bool usePreciseUnwindInfo() const { return hasDebugInfo(); }
 242
 243   bool callsEHReturn() const { return CallsEHReturn; }
 244   void setCallsEHReturn(bool b) { CallsEHReturn = b; }
 245
 246   bool callsUnwindInit() const { return CallsUnwindInit; }
 247   void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
 248
 249   bool hasEHFunclets() const { return HasEHFunclets; }
 250   void setHasEHFunclets(bool V) { HasEHFunclets = V; }
 251
 252   bool usesVAFloatArgument() const {
 253     return UsesVAFloatArgument;
 254   }
 255
 256   void setUsesVAFloatArgument(bool b) {
 257     UsesVAFloatArgument = b;
 258   }
 259
 260   bool usesMorestackAddr() const {
 261     return UsesMorestackAddr;
 262   }
 263
 264   void setUsesMorestackAddr(bool b) {
 265     UsesMorestackAddr = b;
 266   }
 267
 268   /// \brief Returns a reference to a list of cfi instructions in the current
 269   /// function's prologue.  Used to construct frame maps for debug and exception
 270   /// handling comsumers.
 271   const std::vector<MCCFIInstruction> &getFrameInstructions() const {
 272     return FrameInstructions;
 273   }
 274
 275   unsigned LLVM_ATTRIBUTE_UNUSED_RESULT
 276   addFrameInst(const MCCFIInstruction &Inst) {
 277     FrameInstructions.push_back(Inst);
 278     return FrameInstructions.size() - 1;
 279   }
 280
 281   /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
 282   /// block when its address is taken.  This cannot be its normal LBB label
 283   /// because the block may be accessed outside its containing function.
 284   MCSymbol *getAddrLabelSymbol(const BasicBlock *BB) {
 285     return getAddrLabelSymbolToEmit(BB).front();
 286   }
 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   ArrayRef<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(const Function *Personality);
 319
 320   /// getPersonalities - Return array of personality functions ever seen.
 321   const std::vector<const Function *>& getPersonalities() const {
 322     return Personalities;
 323   }
 324
 325   /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
 326   ///
 327   void addCatchTypeInfo(MachineBasicBlock *LandingPad,
 328                         ArrayRef<const GlobalValue *> TyInfo);
 329
 330   /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
 331   ///
 332   void addFilterTypeInfo(MachineBasicBlock *LandingPad,
 333                          ArrayRef<const GlobalValue *> TyInfo);
 334
 335   /// addCleanup - Add a cleanup action for a landing pad.
 336   ///
 337   void addCleanup(MachineBasicBlock *LandingPad);
 338
 339   void addSEHCatchHandler(MachineBasicBlock *LandingPad, const Function *Filter,
 340                           const BlockAddress *RecoverLabel);
 341
 342   void addSEHCleanupHandler(MachineBasicBlock *LandingPad,
 343                             const Function *Cleanup);
 344
 345   /// getTypeIDFor - Return the type id for the specified typeinfo.  This is
 346   /// function wide.
 347   unsigned getTypeIDFor(const GlobalValue *TI);
 348
 349   /// getFilterIDFor - Return the id of the filter encoded by TyIds.  This is
 350   /// function wide.
 351   int getFilterIDFor(std::vector<unsigned> &TyIds);
 352
 353   /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
 354   /// pads.
 355   void TidyLandingPads(DenseMap<MCSymbol*, uintptr_t> *LPMap = nullptr);
 356
 357   /// getLandingPads - Return a reference to the landing pad info for the
 358   /// current function.
 359   const std::vector<LandingPadInfo> &getLandingPads() const {
 360     return LandingPads;
 361   }
 362
 363   /// setCallSiteLandingPad - Map the landing pad's EH symbol to the call
 364   /// site indexes.
 365   void setCallSiteLandingPad(MCSymbol *Sym, ArrayRef<unsigned> Sites);
 366
 367   /// getCallSiteLandingPad - Get the call site indexes for a landing pad EH
 368   /// symbol.
 369   SmallVectorImpl<unsigned> &getCallSiteLandingPad(MCSymbol *Sym) {
 370     assert(hasCallSiteLandingPad(Sym) &&
 371            "missing call site number for landing pad!");
 372     return LPadToCallSiteMap[Sym];
 373   }
 374
 375   /// hasCallSiteLandingPad - Return true if the landing pad Eh symbol has an
 376   /// associated call site.
 377   bool hasCallSiteLandingPad(MCSymbol *Sym) {
 378     return !LPadToCallSiteMap[Sym].empty();
 379   }
 380
 381   /// setCallSiteBeginLabel - Map the begin label for a call site.
 382   void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) {
 383     CallSiteMap[BeginLabel] = Site;
 384   }
 385
 386   /// getCallSiteBeginLabel - Get the call site number for a begin label.
 387   unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) {
 388     assert(hasCallSiteBeginLabel(BeginLabel) &&
 389            "Missing call site number for EH_LABEL!");
 390     return CallSiteMap[BeginLabel];
 391   }
 392
 393   /// hasCallSiteBeginLabel - Return true if the begin label has a call site
 394   /// number associated with it.
 395   bool hasCallSiteBeginLabel(MCSymbol *BeginLabel) {
 396     return CallSiteMap[BeginLabel] != 0;
 397   }
 398
 399   /// setCurrentCallSite - Set the call site currently being processed.
 400   void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
 401
 402   /// getCurrentCallSite - Get the call site currently being processed, if any.
 403   /// return zero if none.
 404   unsigned getCurrentCallSite() { return CurCallSite; }
 405
 406   /// getTypeInfos - Return a reference to the C++ typeinfo for the current
 407   /// function.
 408   const std::vector<const GlobalValue *> &getTypeInfos() const {
 409     return TypeInfos;
 410   }
 411
 412   /// getFilterIds - Return a reference to the typeids encoding filters used in
 413   /// the current function.
 414   const std::vector<unsigned> &getFilterIds() const {
 415     return FilterIds;
 416   }
 417
 418   /// setVariableDbgInfo - Collect information used to emit debugging
 419   /// information of a variable.
 420   void setVariableDbgInfo(const DILocalVariable *Var, const DIExpression *Expr,
 421                           unsigned Slot, const DILocation *Loc) {
 422     VariableDbgInfos.emplace_back(Var, Expr, Slot, Loc);
 423   }
 424
 425   VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfos; }
 426
 427 }; // End class MachineModuleInfo
 428
 429 } // End llvm namespace
 430
 431 #endif