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