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/GlobalValue.h"
  39 #include "llvm/MC/MCContext.h"
  40 #include "llvm/MC/MachineLocation.h"
  41 #include "llvm/Metadata.h"
  42 #include "llvm/Pass.h"
  43 #include "llvm/Support/DataTypes.h"
  44 #include "llvm/Support/DebugLoc.h"
  45 #include "llvm/Support/Dwarf.h"
  46 #include "llvm/Support/ValueHandle.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
  62 //===----------------------------------------------------------------------===//
  63 /// LandingPadInfo - This structure is used to retain landing pad info for
  64 /// the current function.
  65 ///
  66 struct LandingPadInfo {
  67   MachineBasicBlock *LandingPadBlock;    // Landing pad block.
  68   SmallVector<MCSymbol*, 1> BeginLabels; // Labels prior to invoke.
  69   SmallVector<MCSymbol*, 1> EndLabels;   // Labels after invoke.
  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(0), Personality(0) {}
  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   /// FrameMoves - List of moves done by a function's prolog.  Used to construct
 111   /// frame maps by debug and exception handling consumers.
 112   std::vector<MachineMove> FrameMoves;
 113
 114   /// CompactUnwindEncoding - If the target supports it, this is the compact
 115   /// unwind encoding. It replaces a function's CIE and FDE.
 116   uint32_t CompactUnwindEncoding;
 117
 118   /// LandingPads - List of LandingPadInfo describing the landing pad
 119   /// information in the current function.
 120   std::vector<LandingPadInfo> LandingPads;
 121
 122   /// LPadToCallSiteMap - Map a landing pad's EH symbol to the call site
 123   /// indexes.
 124   DenseMap<MCSymbol*, SmallVector<unsigned, 4> > LPadToCallSiteMap;
 125
 126   /// CallSiteMap - Map of invoke call site index values to associated begin
 127   /// EH_LABEL for the current function.
 128   DenseMap<MCSymbol*, unsigned> CallSiteMap;
 129
 130   /// CurCallSite - The current call site index being processed, if any. 0 if
 131   /// none.
 132   unsigned CurCallSite;
 133
 134   /// TypeInfos - List of C++ TypeInfo used in the current function.
 135   std::vector<const GlobalVariable *> TypeInfos;
 136
 137   /// FilterIds - List of typeids encoding filters used in the current function.
 138   std::vector<unsigned> FilterIds;
 139
 140   /// FilterEnds - List of the indices in FilterIds corresponding to filter
 141   /// terminators.
 142   std::vector<unsigned> FilterEnds;
 143
 144   /// Personalities - Vector of all personality functions ever seen. Used to
 145   /// emit common EH frames.
 146   std::vector<const Function *> Personalities;
 147
 148   /// UsedFunctions - The functions in the @llvm.used list in a more easily
 149   /// searchable format.  This does not include the functions in
 150   /// llvm.compiler.used.
 151   SmallPtrSet<const Function *, 32> UsedFunctions;
 152
 153   /// AddrLabelSymbols - This map keeps track of which symbol is being used for
 154   /// the specified basic block's address of label.
 155   MMIAddrLabelMap *AddrLabelSymbols;
 156
 157   bool CallsEHReturn;
 158   bool CallsUnwindInit;
 159
 160   /// DbgInfoAvailable - True if debugging information is available
 161   /// in this module.
 162   bool DbgInfoAvailable;
 163
 164   /// UsesVAFloatArgument - True if this module calls VarArg function with
 165   /// floating-point arguments.  This is used to emit an undefined reference
 166   /// to _fltused on Windows targets.
 167   bool UsesVAFloatArgument;
 168
 169 public:
 170   static char ID; // Pass identification, replacement for typeid
 171
 172   typedef std::pair<unsigned, DebugLoc> UnsignedDebugLocPair;
 173   typedef SmallVector<std::pair<TrackingVH<MDNode>, UnsignedDebugLocPair>, 4>
 174     VariableDbgInfoMapTy;
 175   VariableDbgInfoMapTy VariableDbgInfo;
 176
 177   MachineModuleInfo();  // DUMMY CONSTRUCTOR, DO NOT CALL.
 178   // Real constructor.
 179   MachineModuleInfo(const MCAsmInfo &MAI, const MCRegisterInfo &MRI,
 180                     const MCObjectFileInfo *MOFI);
 181   ~MachineModuleInfo();
 182
 183   using ModulePass::doInitialization;
 184   bool doInitialization();
 185
 186   using ModulePass::doFinalization;
 187   bool doFinalization();
 188
 189   /// EndFunction - Discard function meta information.
 190   ///
 191   void EndFunction();
 192
 193   const MCContext &getContext() const { return Context; }
 194   MCContext &getContext() { return Context; }
 195
 196   void setModule(const Module *M) { TheModule = M; }
 197   const Module *getModule() const { return TheModule; }
 198
 199   /// getInfo - Keep track of various per-function pieces of information for
 200   /// backends that would like to do so.
 201   ///
 202   template<typename Ty>
 203   Ty &getObjFileInfo() {
 204     if (ObjFileMMI == 0)
 205       ObjFileMMI = new Ty(*this);
 206     return *static_cast<Ty*>(ObjFileMMI);
 207   }
 208
 209   template<typename Ty>
 210   const Ty &getObjFileInfo() const {
 211     return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
 212   }
 213
 214   /// AnalyzeModule - Scan the module for global debug information.
 215   ///
 216   void AnalyzeModule(const Module &M);
 217
 218   /// hasDebugInfo - Returns true if valid debug info is present.
 219   ///
 220   bool hasDebugInfo() const { return DbgInfoAvailable; }
 221   void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = avail; }
 222
 223   bool callsEHReturn() const { return CallsEHReturn; }
 224   void setCallsEHReturn(bool b) { CallsEHReturn = b; }
 225
 226   bool callsUnwindInit() const { return CallsUnwindInit; }
 227   void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
 228
 229   bool usesVAFloatArgument() const {
 230     return UsesVAFloatArgument;
 231   }
 232
 233   void setUsesVAFloatArgument(bool b) {
 234     UsesVAFloatArgument = b;
 235   }
 236
 237   /// getFrameMoves - Returns a reference to a list of moves done in the current
 238   /// function's prologue.  Used to construct frame maps for debug and exception
 239   /// handling comsumers.
 240   std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
 241
 242   /// getCompactUnwindEncoding - Returns the compact unwind encoding for a
 243   /// function if the target supports the encoding. This encoding replaces a
 244   /// function's CIE and FDE.
 245   uint32_t getCompactUnwindEncoding() const { return CompactUnwindEncoding; }
 246
 247   /// setCompactUnwindEncoding - Set the compact unwind encoding for a function
 248   /// if the target supports the encoding.
 249   void setCompactUnwindEncoding(uint32_t Enc) { CompactUnwindEncoding = Enc; }
 250
 251   /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
 252   /// block when its address is taken.  This cannot be its normal LBB label
 253   /// because the block may be accessed outside its containing function.
 254   MCSymbol *getAddrLabelSymbol(const BasicBlock *BB);
 255
 256   /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
 257   /// basic block when its address is taken.  If other blocks were RAUW'd to
 258   /// this one, we may have to emit them as well, return the whole set.
 259   std::vector<MCSymbol*> getAddrLabelSymbolToEmit(const BasicBlock *BB);
 260
 261   /// takeDeletedSymbolsForFunction - If the specified function has had any
 262   /// references to address-taken blocks generated, but the block got deleted,
 263   /// return the symbol now so we can emit it.  This prevents emitting a
 264   /// reference to a symbol that has no definition.
 265   void takeDeletedSymbolsForFunction(const Function *F,
 266                                      std::vector<MCSymbol*> &Result);
 267
 268
 269   //===- EH ---------------------------------------------------------------===//
 270
 271   /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
 272   /// specified MachineBasicBlock.
 273   LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
 274
 275   /// addInvoke - Provide the begin and end labels of an invoke style call and
 276   /// associate it with a try landing pad block.
 277   void addInvoke(MachineBasicBlock *LandingPad,
 278                  MCSymbol *BeginLabel, MCSymbol *EndLabel);
 279
 280   /// addLandingPad - Add a new panding pad.  Returns the label ID for the
 281   /// landing pad entry.
 282   MCSymbol *addLandingPad(MachineBasicBlock *LandingPad);
 283
 284   /// addPersonality - Provide the personality function for the exception
 285   /// information.
 286   void addPersonality(MachineBasicBlock *LandingPad,
 287                       const Function *Personality);
 288
 289   /// getPersonalityIndex - Get index of the current personality function inside
 290   /// Personalitites array
 291   unsigned getPersonalityIndex() const;
 292
 293   /// getPersonalities - Return array of personality functions ever seen.
 294   const std::vector<const Function *>& getPersonalities() const {
 295     return Personalities;
 296   }
 297
 298   /// isUsedFunction - Return true if the functions in the llvm.used list.  This
 299   /// does not return true for things in llvm.compiler.used unless they are also
 300   /// in llvm.used.
 301   bool isUsedFunction(const Function *F) {
 302     return UsedFunctions.count(F);
 303   }
 304
 305   /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
 306   ///
 307   void addCatchTypeInfo(MachineBasicBlock *LandingPad,
 308                         ArrayRef<const GlobalVariable *> TyInfo);
 309
 310   /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
 311   ///
 312   void addFilterTypeInfo(MachineBasicBlock *LandingPad,
 313                          ArrayRef<const GlobalVariable *> TyInfo);
 314
 315   /// addCleanup - Add a cleanup action for a landing pad.
 316   ///
 317   void addCleanup(MachineBasicBlock *LandingPad);
 318
 319   /// getTypeIDFor - Return the type id for the specified typeinfo.  This is
 320   /// function wide.
 321   unsigned getTypeIDFor(const GlobalVariable *TI);
 322
 323   /// getFilterIDFor - Return the id of the filter encoded by TyIds.  This is
 324   /// function wide.
 325   int getFilterIDFor(std::vector<unsigned> &TyIds);
 326
 327   /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
 328   /// pads.
 329   void TidyLandingPads(DenseMap<MCSymbol*, uintptr_t> *LPMap = 0);
 330
 331   /// getLandingPads - Return a reference to the landing pad info for the
 332   /// current function.
 333   const std::vector<LandingPadInfo> &getLandingPads() const {
 334     return LandingPads;
 335   }
 336
 337   /// setCallSiteLandingPad - Map the landing pad's EH symbol to the call
 338   /// site indexes.
 339   void setCallSiteLandingPad(MCSymbol *Sym, ArrayRef<unsigned> Sites);
 340
 341   /// getCallSiteLandingPad - Get the call site indexes for a landing pad EH
 342   /// symbol.
 343   SmallVectorImpl<unsigned> &getCallSiteLandingPad(MCSymbol *Sym) {
 344     assert(hasCallSiteLandingPad(Sym) &&
 345            "missing call site number for landing pad!");
 346     return LPadToCallSiteMap[Sym];
 347   }
 348
 349   /// hasCallSiteLandingPad - Return true if the landing pad Eh symbol has an
 350   /// associated call site.
 351   bool hasCallSiteLandingPad(MCSymbol *Sym) {
 352     return !LPadToCallSiteMap[Sym].empty();
 353   }
 354
 355   /// setCallSiteBeginLabel - Map the begin label for a call site.
 356   void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) {
 357     CallSiteMap[BeginLabel] = Site;
 358   }
 359
 360   /// getCallSiteBeginLabel - Get the call site number for a begin label.
 361   unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) {
 362     assert(hasCallSiteBeginLabel(BeginLabel) &&
 363            "Missing call site number for EH_LABEL!");
 364     return CallSiteMap[BeginLabel];
 365   }
 366
 367   /// hasCallSiteBeginLabel - Return true if the begin label has a call site
 368   /// number associated with it.
 369   bool hasCallSiteBeginLabel(MCSymbol *BeginLabel) {
 370     return CallSiteMap[BeginLabel] != 0;
 371   }
 372
 373   /// setCurrentCallSite - Set the call site currently being processed.
 374   void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
 375
 376   /// getCurrentCallSite - Get the call site currently being processed, if any.
 377   /// return zero if none.
 378   unsigned getCurrentCallSite() { return CurCallSite; }
 379
 380   /// getTypeInfos - Return a reference to the C++ typeinfo for the current
 381   /// function.
 382   const std::vector<const GlobalVariable *> &getTypeInfos() const {
 383     return TypeInfos;
 384   }
 385
 386   /// getFilterIds - Return a reference to the typeids encoding filters used in
 387   /// the current function.
 388   const std::vector<unsigned> &getFilterIds() const {
 389     return FilterIds;
 390   }
 391
 392   /// getPersonality - Return a personality function if available.  The presence
 393   /// of one is required to emit exception handling info.
 394   const Function *getPersonality() const;
 395
 396   /// setVariableDbgInfo - Collect information used to emit debugging
 397   /// information of a variable.
 398   void setVariableDbgInfo(MDNode *N, unsigned Slot, DebugLoc Loc) {
 399     VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Loc)));
 400   }
 401
 402   VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfo; }
 403
 404 }; // End class MachineModuleInfo
 405
 406 } // End llvm namespace
 407
 408 #endif