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   /// NextLabelIDToReturn - Unique ID counter for labels.
 106   unsigned NextLabelIDToReturn;
 107
 108   // FrameMoves - List of moves done by a function's prolog.  Used to construct
 109   // frame maps by debug and exception handling consumers.
 110   std::vector<MachineMove> FrameMoves;
 111
 112   // LandingPads - List of LandingPadInfo describing the landing pad information
 113   // in the current function.
 114   std::vector<LandingPadInfo> LandingPads;
 115
 116   // Map of invoke call site index values to associated begin EH_LABEL for
 117   // the current function.
 118   DenseMap<MCSymbol*, unsigned> CallSiteMap;
 119
 120   // The current call site index being processed, if any. 0 if none.
 121   unsigned CurCallSite;
 122
 123   // TypeInfos - List of C++ TypeInfo used in the current function.
 124   //
 125   std::vector<GlobalVariable *> TypeInfos;
 126
 127   // FilterIds - List of typeids encoding filters used in the current function.
 128   //
 129   std::vector<unsigned> FilterIds;
 130
 131   // FilterEnds - List of the indices in FilterIds corresponding to filter
 132   // terminators.
 133   //
 134   std::vector<unsigned> FilterEnds;
 135
 136   // Personalities - Vector of all personality functions ever seen. Used to emit
 137   // common EH frames.
 138   std::vector<Function *> Personalities;
 139
 140   /// UsedFunctions - The functions in the @llvm.used list in a more easily
 141   /// searchable format.  This does not include the functions in
 142   /// llvm.compiler.used.
 143   SmallPtrSet<const Function *, 32> UsedFunctions;
 144
 145   bool CallsEHReturn;
 146   bool CallsUnwindInit;
 147
 148   /// DbgInfoAvailable - True if debugging information is available
 149   /// in this module.
 150   bool DbgInfoAvailable;
 151
 152 public:
 153   static char ID; // Pass identification, replacement for typeid
 154
 155   typedef std::pair<unsigned, TrackingVH<MDNode> > UnsignedAndMDNodePair;
 156   typedef SmallVector< std::pair<TrackingVH<MDNode>, UnsignedAndMDNodePair>, 4>
 157     VariableDbgInfoMapTy;
 158   VariableDbgInfoMapTy VariableDbgInfo;
 159
 160   MachineModuleInfo();  // DUMMY CONSTRUCTOR, DO NOT CALL.
 161   MachineModuleInfo(const MCAsmInfo &MAI);  // Real constructor.
 162   ~MachineModuleInfo();
 163
 164   bool doInitialization();
 165   bool doFinalization();
 166
 167   /// EndFunction - Discard function meta information.
 168   ///
 169   void EndFunction();
 170
 171   const MCContext &getContext() const { return Context; }
 172   MCContext &getContext() { return Context; }
 173
 174   /// getInfo - Keep track of various per-function pieces of information for
 175   /// backends that would like to do so.
 176   ///
 177   template<typename Ty>
 178   Ty &getObjFileInfo() {
 179     if (ObjFileMMI == 0)
 180       ObjFileMMI = new Ty(*this);
 181     return *static_cast<Ty*>(ObjFileMMI);
 182   }
 183
 184   template<typename Ty>
 185   const Ty &getObjFileInfo() const {
 186     return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
 187   }
 188
 189   /// AnalyzeModule - Scan the module for global debug information.
 190   ///
 191   void AnalyzeModule(Module &M);
 192
 193   /// hasDebugInfo - Returns true if valid debug info is present.
 194   ///
 195   bool hasDebugInfo() const { return DbgInfoAvailable; }
 196   void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
 197
 198   bool callsEHReturn() const { return CallsEHReturn; }
 199   void setCallsEHReturn(bool b) { CallsEHReturn = b; }
 200
 201   bool callsUnwindInit() const { return CallsUnwindInit; }
 202   void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
 203
 204   /// NextLabelID - Return the next unique label id.
 205   ///
 206   unsigned NextLabelID() {
 207     return NextLabelIDToReturn++;
 208   }
 209
 210   /// getLabelSym - Turn a label ID into a symbol.
 211   MCSymbol *getLabelSym(unsigned ID);
 212
 213   /// getFrameMoves - Returns a reference to a list of moves done in the current
 214   /// function's prologue.  Used to construct frame maps for debug and exception
 215   /// handling comsumers.
 216   std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
 217
 218   //===-EH-----------------------------------------------------------------===//
 219
 220   /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
 221   /// specified MachineBasicBlock.
 222   LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
 223
 224   /// addInvoke - Provide the begin and end labels of an invoke style call and
 225   /// associate it with a try landing pad block.
 226   void addInvoke(MachineBasicBlock *LandingPad,
 227                  MCSymbol *BeginLabel, MCSymbol *EndLabel);
 228
 229   /// addLandingPad - Add a new panding pad.  Returns the label ID for the
 230   /// landing pad entry.
 231   MCSymbol *addLandingPad(MachineBasicBlock *LandingPad);
 232
 233   /// addPersonality - Provide the personality function for the exception
 234   /// information.
 235   void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
 236
 237   /// getPersonalityIndex - Get index of the current personality function inside
 238   /// Personalitites array
 239   unsigned getPersonalityIndex() const;
 240
 241   /// getPersonalities - Return array of personality functions ever seen.
 242   const std::vector<Function *>& getPersonalities() const {
 243     return Personalities;
 244   }
 245
 246   /// isUsedFunction - Return true if the functions in the llvm.used list.  This
 247   /// does not return true for things in llvm.compiler.used unless they are also
 248   /// in llvm.used.
 249   bool isUsedFunction(const Function *F) {
 250     return UsedFunctions.count(F);
 251   }
 252
 253   /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
 254   ///
 255   void addCatchTypeInfo(MachineBasicBlock *LandingPad,
 256                         std::vector<GlobalVariable *> &TyInfo);
 257
 258   /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
 259   ///
 260   void addFilterTypeInfo(MachineBasicBlock *LandingPad,
 261                          std::vector<GlobalVariable *> &TyInfo);
 262
 263   /// addCleanup - Add a cleanup action for a landing pad.
 264   ///
 265   void addCleanup(MachineBasicBlock *LandingPad);
 266
 267   /// getTypeIDFor - Return the type id for the specified typeinfo.  This is
 268   /// function wide.
 269   unsigned getTypeIDFor(GlobalVariable *TI);
 270
 271   /// getFilterIDFor - Return the id of the filter encoded by TyIds.  This is
 272   /// function wide.
 273   int getFilterIDFor(std::vector<unsigned> &TyIds);
 274
 275   /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
 276   /// pads.
 277   void TidyLandingPads();
 278
 279   /// getLandingPads - Return a reference to the landing pad info for the
 280   /// current function.
 281   const std::vector<LandingPadInfo> &getLandingPads() const {
 282     return LandingPads;
 283   }
 284
 285   /// setCallSiteBeginLabel - Map the begin label for a call site
 286   void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) {
 287     CallSiteMap[BeginLabel] = Site;
 288   }
 289
 290   /// getCallSiteBeginLabel - Get the call site number for a begin label
 291   unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) {
 292     assert(CallSiteMap.count(BeginLabel) &&
 293            "Missing call site number for EH_LABEL!");
 294     return CallSiteMap[BeginLabel];
 295   }
 296
 297   /// setCurrentCallSite - Set the call site currently being processed.
 298   void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
 299
 300   /// getCurrentCallSite - Get the call site currently being processed, if any.
 301   /// return zero if none.
 302   unsigned getCurrentCallSite(void) { return CurCallSite; }
 303
 304   /// getTypeInfos - Return a reference to the C++ typeinfo for the current
 305   /// function.
 306   const std::vector<GlobalVariable *> &getTypeInfos() const {
 307     return TypeInfos;
 308   }
 309
 310   /// getFilterIds - Return a reference to the typeids encoding filters used in
 311   /// the current function.
 312   const std::vector<unsigned> &getFilterIds() const {
 313     return FilterIds;
 314   }
 315
 316   /// getPersonality - Return a personality function if available.  The presence
 317   /// of one is required to emit exception handling info.
 318   Function *getPersonality() const;
 319
 320   /// setVariableDbgInfo - Collect information used to emit debugging information
 321   /// of a variable.
 322   void setVariableDbgInfo(MDNode *N, unsigned Slot, MDNode *Scope) {
 323     VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Scope)));
 324   }
 325
 326   VariableDbgInfoMapTy &getVariableDbgInfo() {  return VariableDbgInfo;  }
 327
 328 }; // End class MachineModuleInfo
 329
 330 } // End llvm namespace
 331
 332 #endif