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/GlobalValue.h"
  35 #include "llvm/Pass.h"
  36 #include "llvm/Metadata.h"
  37 #include "llvm/ADT/DenseMap.h"
  38 #include "llvm/ADT/PointerIntPair.h"
  39 #include "llvm/ADT/SmallPtrSet.h"
  40 #include "llvm/ADT/SmallSet.h"
  41 #include "llvm/ADT/SmallVector.h"
  42 #include "llvm/ADT/StringMap.h"
  43 #include "llvm/ADT/UniqueVector.h"
  44 #include "llvm/CodeGen/MachineLocation.h"
  45 #include "llvm/Support/Dwarf.h"
  46 #include "llvm/Support/ValueHandle.h"
  47 #include "llvm/System/DataTypes.h"
  48
  49 namespace llvm {
  50
  51 //===----------------------------------------------------------------------===//
  52 // Forward declarations.
  53 class Constant;
  54 class GlobalVariable;
  55 class MCSymbol;
  56 class MDNode;
  57 class MachineBasicBlock;
  58 class MachineFunction;
  59 class Module;
  60 class PointerType;
  61 class StructType;
  62
  63 /// MachineModuleInfoImpl - This class can be derived from and used by targets
  64 /// to hold private target-specific information for each Module.  Objects of
  65 /// type are accessed/created with MMI::getInfo and destroyed when the
  66 /// MachineModuleInfo is destroyed.
  67 class MachineModuleInfoImpl {
  68 public:
  69   typedef PointerIntPair<MCSymbol*, 1, bool> StubValueTy;
  70   virtual ~MachineModuleInfoImpl();
  71   typedef std::vector<std::pair<MCSymbol*, StubValueTy> > SymbolListTy;
  72 protected:
  73   static SymbolListTy GetSortedStubs(const DenseMap<MCSymbol*, StubValueTy>&);
  74 };
  75
  76
  77
  78 //===----------------------------------------------------------------------===//
  79 /// LandingPadInfo - This structure is used to retain landing pad info for
  80 /// the current function.
  81 ///
  82 struct LandingPadInfo {
  83   MachineBasicBlock *LandingPadBlock;   // Landing pad block.
  84   SmallVector<unsigned, 1> BeginLabels; // Labels prior to invoke.
  85   SmallVector<unsigned, 1> EndLabels;   // Labels after invoke.
  86   unsigned LandingPadLabel;             // Label at beginning of landing pad.
  87   Function *Personality;                // Personality function.
  88   std::vector<int> TypeIds;             // List of type ids (filters negative)
  89
  90   explicit LandingPadInfo(MachineBasicBlock *MBB)
  91   : LandingPadBlock(MBB)
  92   , LandingPadLabel(0)
  93   , Personality(NULL)
  94   {}
  95 };
  96
  97 //===----------------------------------------------------------------------===//
  98 /// MachineModuleInfo - This class contains meta information specific to a
  99 /// module.  Queries can be made by different debugging and exception handling
 100 /// schemes and reformated for specific use.
 101 ///
 102 class MachineModuleInfo : public ImmutablePass {
 103   /// ObjFileMMI - This is the object-file-format-specific implementation of
 104   /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
 105   /// want.
 106   MachineModuleInfoImpl *ObjFileMMI;
 107
 108   // LabelIDList - One entry per assigned label.  Normally the entry is equal to
 109   // the list index(+1).  If the entry is zero then the label has been deleted.
 110   // Any other value indicates the label has been deleted by is mapped to
 111   // another label.
 112   std::vector<unsigned> LabelIDList;
 113
 114   // FrameMoves - List of moves done by a function's prolog.  Used to construct
 115   // frame maps by debug and exception handling consumers.
 116   std::vector<MachineMove> FrameMoves;
 117
 118   // LandingPads - List of LandingPadInfo describing the landing pad information
 119   // in the current function.
 120   std::vector<LandingPadInfo> LandingPads;
 121
 122   // Map of invoke call site index values to associated begin EH_LABEL for
 123   // the current function.
 124   DenseMap<unsigned, unsigned> CallSiteMap;
 125
 126   // The current call site index being processed, if any. 0 if none.
 127   unsigned CurCallSite;
 128
 129   // TypeInfos - List of C++ TypeInfo used in the current function.
 130   //
 131   std::vector<GlobalVariable *> TypeInfos;
 132
 133   // FilterIds - List of typeids encoding filters used in the current function.
 134   //
 135   std::vector<unsigned> FilterIds;
 136
 137   // FilterEnds - List of the indices in FilterIds corresponding to filter
 138   // terminators.
 139   //
 140   std::vector<unsigned> FilterEnds;
 141
 142   // Personalities - Vector of all personality functions ever seen. Used to emit
 143   // common EH frames.
 144   std::vector<Function *> Personalities;
 145
 146   /// UsedFunctions - The functions in the @llvm.used list in a more easily
 147   /// searchable format.  This does not include the functions in
 148   /// llvm.compiler.used.
 149   SmallPtrSet<const Function *, 32> UsedFunctions;
 150
 151   bool CallsEHReturn;
 152   bool CallsUnwindInit;
 153
 154   /// DbgInfoAvailable - True if debugging information is available
 155   /// in this module.
 156   bool DbgInfoAvailable;
 157
 158 public:
 159   static char ID; // Pass identification, replacement for typeid
 160
 161   typedef std::pair<unsigned, TrackingVH<MDNode> > UnsignedAndMDNodePair;
 162   typedef SmallVector< std::pair<TrackingVH<MDNode>, UnsignedAndMDNodePair>, 4>
 163     VariableDbgInfoMapTy;
 164   VariableDbgInfoMapTy VariableDbgInfo;
 165
 166   MachineModuleInfo();
 167   ~MachineModuleInfo();
 168
 169   bool doInitialization();
 170   bool doFinalization();
 171
 172   /// EndFunction - Discard function meta information.
 173   ///
 174   void EndFunction();
 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   /// NextLabelID - Return the next unique label id.
 207   ///
 208   unsigned NextLabelID() {
 209     unsigned ID = (unsigned)LabelIDList.size() + 1;
 210     LabelIDList.push_back(ID);
 211     return ID;
 212   }
 213
 214   /// InvalidateLabel - Inhibit use of the specified label # from
 215   /// MachineModuleInfo, for example because the code was deleted.
 216   void InvalidateLabel(unsigned LabelID) {
 217     // Remap to zero to indicate deletion.
 218     assert(0 < LabelID && LabelID <= LabelIDList.size() &&
 219            "Old label ID out of range.");
 220     LabelIDList[LabelID - 1] = 0;
 221   }
 222
 223   /// isLabelDeleted - Return true if the label was deleted.
 224   /// FIXME: This should eventually be eliminated and use the 'is emitted' bit
 225   /// on MCSymbol.
 226   bool isLabelDeleted(unsigned LabelID) const {
 227     assert(LabelID <= LabelIDList.size() && "Debug label ID out of range.");
 228     return LabelID == 0 || LabelIDList[LabelID - 1] == 0;
 229   }
 230
 231   /// getFrameMoves - Returns a reference to a list of moves done in the current
 232   /// function's prologue.  Used to construct frame maps for debug and exception
 233   /// handling comsumers.
 234   std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
 235
 236   //===-EH-----------------------------------------------------------------===//
 237
 238   /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
 239   /// specified MachineBasicBlock.
 240   LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
 241
 242   /// addInvoke - Provide the begin and end labels of an invoke style call and
 243   /// associate it with a try landing pad block.
 244   void addInvoke(MachineBasicBlock *LandingPad, unsigned BeginLabel,
 245                                                 unsigned EndLabel);
 246
 247   /// addLandingPad - Add a new panding pad.  Returns the label ID for the
 248   /// landing pad entry.
 249   unsigned addLandingPad(MachineBasicBlock *LandingPad);
 250
 251   /// addPersonality - Provide the personality function for the exception
 252   /// information.
 253   void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
 254
 255   /// getPersonalityIndex - Get index of the current personality function inside
 256   /// Personalitites array
 257   unsigned getPersonalityIndex() const;
 258
 259   /// getPersonalities - Return array of personality functions ever seen.
 260   const std::vector<Function *>& getPersonalities() const {
 261     return Personalities;
 262   }
 263
 264   /// isUsedFunction - Return true if the functions in the llvm.used list.  This
 265   /// does not return true for things in llvm.compiler.used unless they are also
 266   /// in llvm.used.
 267   bool isUsedFunction(const Function *F) {
 268     return UsedFunctions.count(F);
 269   }
 270
 271   /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
 272   ///
 273   void addCatchTypeInfo(MachineBasicBlock *LandingPad,
 274                         std::vector<GlobalVariable *> &TyInfo);
 275
 276   /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
 277   ///
 278   void addFilterTypeInfo(MachineBasicBlock *LandingPad,
 279                          std::vector<GlobalVariable *> &TyInfo);
 280
 281   /// addCleanup - Add a cleanup action for a landing pad.
 282   ///
 283   void addCleanup(MachineBasicBlock *LandingPad);
 284
 285   /// getTypeIDFor - Return the type id for the specified typeinfo.  This is
 286   /// function wide.
 287   unsigned getTypeIDFor(GlobalVariable *TI);
 288
 289   /// getFilterIDFor - Return the id of the filter encoded by TyIds.  This is
 290   /// function wide.
 291   int getFilterIDFor(std::vector<unsigned> &TyIds);
 292
 293   /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
 294   /// pads.
 295   void TidyLandingPads();
 296
 297   /// getLandingPads - Return a reference to the landing pad info for the
 298   /// current function.
 299   const std::vector<LandingPadInfo> &getLandingPads() const {
 300     return LandingPads;
 301   }
 302
 303   /// setCallSiteBeginLabel - Map the begin label for a call site
 304   void setCallSiteBeginLabel(unsigned BeginLabel, unsigned Site) {
 305     CallSiteMap[BeginLabel] = Site;
 306   }
 307
 308   /// getCallSiteBeginLabel - Get the call site number for a begin label
 309   unsigned getCallSiteBeginLabel(unsigned BeginLabel) {
 310     assert(CallSiteMap.count(BeginLabel) &&
 311            "Missing call site number for EH_LABEL!");
 312     return CallSiteMap[BeginLabel];
 313   }
 314
 315   /// setCurrentCallSite - Set the call site currently being processed.
 316   void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
 317
 318   /// getCurrentCallSite - Get the call site currently being processed, if any.
 319   /// return zero if none.
 320   unsigned getCurrentCallSite(void) { return CurCallSite; }
 321
 322   /// getTypeInfos - Return a reference to the C++ typeinfo for the current
 323   /// function.
 324   const std::vector<GlobalVariable *> &getTypeInfos() const {
 325     return TypeInfos;
 326   }
 327
 328   /// getFilterIds - Return a reference to the typeids encoding filters used in
 329   /// the current function.
 330   const std::vector<unsigned> &getFilterIds() const {
 331     return FilterIds;
 332   }
 333
 334   /// getPersonality - Return a personality function if available.  The presence
 335   /// of one is required to emit exception handling info.
 336   Function *getPersonality() const;
 337
 338   /// setVariableDbgInfo - Collect information used to emit debugging information
 339   /// of a variable.
 340   void setVariableDbgInfo(MDNode *N, unsigned Slot, MDNode *Scope) {
 341     VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Scope)));
 342   }
 343
 344   VariableDbgInfoMapTy &getVariableDbgInfo() {  return VariableDbgInfo;  }
 345
 346 }; // End class MachineModuleInfo
 347
 348 } // End llvm namespace
 349
 350 #endif