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/Pass.h"
  35 #include "llvm/GlobalValue.h"
  36 #include "llvm/Metadata.h"
  37 #include "llvm/CodeGen/MachineLocation.h"
  38 #include "llvm/MC/MCContext.h"
  39 #include "llvm/Support/Dwarf.h"
  40 #include "llvm/Support/ValueHandle.h"
  41 #include "llvm/System/DataTypes.h"
  42 #include "llvm/ADT/DenseMap.h"
  43 #include "llvm/ADT/PointerIntPair.h"
  44 #include "llvm/ADT/SmallPtrSet.h"
  45 #include "llvm/ADT/SmallVector.h"
  46
  47 namespace llvm {
  48
  49 //===----------------------------------------------------------------------===//
  50 // Forward declarations.
  51 class Constant;
  52 class GlobalVariable;
  53 class MDNode;
  54 class MachineBasicBlock;
  55 class MachineFunction;
  56 class Module;
  57 class PointerType;
  58 class StructType;
  59
  60 /// MachineModuleInfoImpl - This class can be derived from and used by targets
  61 /// to hold private target-specific information for each Module.  Objects of
  62 /// type are accessed/created with MMI::getInfo and destroyed when the
  63 /// MachineModuleInfo is destroyed.
  64 class MachineModuleInfoImpl {
  65 public:
  66   typedef PointerIntPair<MCSymbol*, 1, bool> StubValueTy;
  67   virtual ~MachineModuleInfoImpl();
  68   typedef std::vector<std::pair<MCSymbol*, StubValueTy> > SymbolListTy;
  69 protected:
  70   static SymbolListTy GetSortedStubs(const DenseMap<MCSymbol*, StubValueTy>&);
  71 };
  72
  73
  74
  75 //===----------------------------------------------------------------------===//
  76 /// LandingPadInfo - This structure is used to retain landing pad info for
  77 /// the current function.
  78 ///
  79 struct LandingPadInfo {
  80   MachineBasicBlock *LandingPadBlock;    // Landing pad block.
  81   SmallVector<MCSymbol*, 1> BeginLabels; // Labels prior to invoke.
  82   SmallVector<MCSymbol*, 1> EndLabels;   // Labels after invoke.
  83   MCSymbol *LandingPadLabel;             // Label at beginning of landing pad.
  84   Function *Personality;                 // Personality function.
  85   std::vector<int> TypeIds;              // List of type ids (filters negative)
  86
  87   explicit LandingPadInfo(MachineBasicBlock *MBB)
  88     : LandingPadBlock(MBB), LandingPadLabel(0), Personality(0) {}
  89 };
  90
  91 //===----------------------------------------------------------------------===//
  92 /// MachineModuleInfo - This class contains meta information specific to a
  93 /// module.  Queries can be made by different debugging and exception handling
  94 /// schemes and reformated for specific use.
  95 ///
  96 class MachineModuleInfo : public ImmutablePass {
  97   /// Context - This is the MCContext used for the entire code generator.
  98   MCContext Context;
  99
 100   /// ObjFileMMI - This is the object-file-format-specific implementation of
 101   /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
 102   /// want.
 103   MachineModuleInfoImpl *ObjFileMMI;
 104
 105   // FrameMoves - List of moves done by a function's prolog.  Used to construct
 106   // frame maps by debug and exception handling consumers.
 107   std::vector<MachineMove> FrameMoves;
 108
 109   // LandingPads - List of LandingPadInfo describing the landing pad information
 110   // in the current function.
 111   std::vector<LandingPadInfo> LandingPads;
 112
 113   // Map of invoke call site index values to associated begin EH_LABEL for
 114   // the current function.
 115   DenseMap<MCSymbol*, unsigned> CallSiteMap;
 116
 117   // The current call site index being processed, if any. 0 if none.
 118   unsigned CurCallSite;
 119
 120   // TypeInfos - List of C++ TypeInfo used in the current function.
 121   //
 122   std::vector<GlobalVariable *> TypeInfos;
 123
 124   // FilterIds - List of typeids encoding filters used in the current function.
 125   //
 126   std::vector<unsigned> FilterIds;
 127
 128   // FilterEnds - List of the indices in FilterIds corresponding to filter
 129   // terminators.
 130   //
 131   std::vector<unsigned> FilterEnds;
 132
 133   // Personalities - Vector of all personality functions ever seen. Used to emit
 134   // common EH frames.
 135   std::vector<Function *> Personalities;
 136
 137   /// UsedFunctions - The functions in the @llvm.used list in a more easily
 138   /// searchable format.  This does not include the functions in
 139   /// llvm.compiler.used.
 140   SmallPtrSet<const Function *, 32> UsedFunctions;
 141
 142
 143   /// AddrLabelSymbols - This map keeps track of which symbol is being used for
 144   /// the specified basic block's address of label.
 145   DenseMap<AssertingVH<BasicBlock>, MCSymbol*> AddrLabelSymbols;
 146
 147   bool CallsEHReturn;
 148   bool CallsUnwindInit;
 149
 150   /// DbgInfoAvailable - True if debugging information is available
 151   /// in this module.
 152   bool DbgInfoAvailable;
 153
 154 public:
 155   static char ID; // Pass identification, replacement for typeid
 156
 157   typedef std::pair<unsigned, TrackingVH<MDNode> > UnsignedAndMDNodePair;
 158   typedef SmallVector< std::pair<TrackingVH<MDNode>, UnsignedAndMDNodePair>, 4>
 159     VariableDbgInfoMapTy;
 160   VariableDbgInfoMapTy VariableDbgInfo;
 161
 162   MachineModuleInfo();  // DUMMY CONSTRUCTOR, DO NOT CALL.
 163   MachineModuleInfo(const MCAsmInfo &MAI);  // Real constructor.
 164   ~MachineModuleInfo();
 165
 166   bool doInitialization();
 167   bool doFinalization();
 168
 169   /// EndFunction - Discard function meta information.
 170   ///
 171   void EndFunction();
 172
 173   const MCContext &getContext() const { return Context; }
 174   MCContext &getContext() { return Context; }
 175
 176   /// getInfo - Keep track of various per-function pieces of information for
 177   /// backends that would like to do so.
 178   ///
 179   template<typename Ty>
 180   Ty &getObjFileInfo() {
 181     if (ObjFileMMI == 0)
 182       ObjFileMMI = new Ty(*this);
 183     return *static_cast<Ty*>(ObjFileMMI);
 184   }
 185
 186   template<typename Ty>
 187   const Ty &getObjFileInfo() const {
 188     return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
 189   }
 190
 191   /// AnalyzeModule - Scan the module for global debug information.
 192   ///
 193   void AnalyzeModule(Module &M);
 194
 195   /// hasDebugInfo - Returns true if valid debug info is present.
 196   ///
 197   bool hasDebugInfo() const { return DbgInfoAvailable; }
 198   void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
 199
 200   bool callsEHReturn() const { return CallsEHReturn; }
 201   void setCallsEHReturn(bool b) { CallsEHReturn = b; }
 202
 203   bool callsUnwindInit() const { return CallsUnwindInit; }
 204   void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
 205
 206   /// getFrameMoves - Returns a reference to a list of moves done in the current
 207   /// function's prologue.  Used to construct frame maps for debug and exception
 208   /// handling comsumers.
 209   std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
 210
 211   /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
 212   /// block when its address is taken.  This cannot be its normal LBB label
 213   /// because the block may be accessed outside its containing function.
 214   MCSymbol *getAddrLabelSymbol(const BasicBlock *BB);
 215
 216   //===- EH ---------------------------------------------------------------===//
 217
 218   /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
 219   /// specified MachineBasicBlock.
 220   LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
 221
 222   /// addInvoke - Provide the begin and end labels of an invoke style call and
 223   /// associate it with a try landing pad block.
 224   void addInvoke(MachineBasicBlock *LandingPad,
 225                  MCSymbol *BeginLabel, MCSymbol *EndLabel);
 226
 227   /// addLandingPad - Add a new panding pad.  Returns the label ID for the
 228   /// landing pad entry.
 229   MCSymbol *addLandingPad(MachineBasicBlock *LandingPad);
 230
 231   /// addPersonality - Provide the personality function for the exception
 232   /// information.
 233   void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
 234
 235   /// getPersonalityIndex - Get index of the current personality function inside
 236   /// Personalitites array
 237   unsigned getPersonalityIndex() const;
 238
 239   /// getPersonalities - Return array of personality functions ever seen.
 240   const std::vector<Function *>& getPersonalities() const {
 241     return Personalities;
 242   }
 243
 244   /// isUsedFunction - Return true if the functions in the llvm.used list.  This
 245   /// does not return true for things in llvm.compiler.used unless they are also
 246   /// in llvm.used.
 247   bool isUsedFunction(const Function *F) {
 248     return UsedFunctions.count(F);
 249   }
 250
 251   /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
 252   ///
 253   void addCatchTypeInfo(MachineBasicBlock *LandingPad,
 254                         std::vector<GlobalVariable *> &TyInfo);
 255
 256   /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
 257   ///
 258   void addFilterTypeInfo(MachineBasicBlock *LandingPad,
 259                          std::vector<GlobalVariable *> &TyInfo);
 260
 261   /// addCleanup - Add a cleanup action for a landing pad.
 262   ///
 263   void addCleanup(MachineBasicBlock *LandingPad);
 264
 265   /// getTypeIDFor - Return the type id for the specified typeinfo.  This is
 266   /// function wide.
 267   unsigned getTypeIDFor(GlobalVariable *TI);
 268
 269   /// getFilterIDFor - Return the id of the filter encoded by TyIds.  This is
 270   /// function wide.
 271   int getFilterIDFor(std::vector<unsigned> &TyIds);
 272
 273   /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
 274   /// pads.
 275   void TidyLandingPads();
 276
 277   /// getLandingPads - Return a reference to the landing pad info for the
 278   /// current function.
 279   const std::vector<LandingPadInfo> &getLandingPads() const {
 280     return LandingPads;
 281   }
 282
 283   /// setCallSiteBeginLabel - Map the begin label for a call site
 284   void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) {
 285     CallSiteMap[BeginLabel] = Site;
 286   }
 287
 288   /// getCallSiteBeginLabel - Get the call site number for a begin label
 289   unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) {
 290     assert(CallSiteMap.count(BeginLabel) &&
 291            "Missing call site number for EH_LABEL!");
 292     return CallSiteMap[BeginLabel];
 293   }
 294
 295   /// setCurrentCallSite - Set the call site currently being processed.
 296   void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
 297
 298   /// getCurrentCallSite - Get the call site currently being processed, if any.
 299   /// return zero if none.
 300   unsigned getCurrentCallSite(void) { return CurCallSite; }
 301
 302   /// getTypeInfos - Return a reference to the C++ typeinfo for the current
 303   /// function.
 304   const std::vector<GlobalVariable *> &getTypeInfos() const {
 305     return TypeInfos;
 306   }
 307
 308   /// getFilterIds - Return a reference to the typeids encoding filters used in
 309   /// the current function.
 310   const std::vector<unsigned> &getFilterIds() const {
 311     return FilterIds;
 312   }
 313
 314   /// getPersonality - Return a personality function if available.  The presence
 315   /// of one is required to emit exception handling info.
 316   Function *getPersonality() const;
 317
 318   /// setVariableDbgInfo - Collect information used to emit debugging information
 319   /// of a variable.
 320   void setVariableDbgInfo(MDNode *N, unsigned Slot, MDNode *Scope) {
 321     VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Scope)));
 322   }
 323
 324   VariableDbgInfoMapTy &getVariableDbgInfo() {  return VariableDbgInfo;  }
 325
 326 }; // End class MachineModuleInfo
 327
 328 } // End llvm namespace
 329
 330 #endif