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