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/Support/Dwarf.h"
  35 #include "llvm/System/DataTypes.h"
  36 #include "llvm/ADT/SmallVector.h"
  37 #include "llvm/ADT/DenseMap.h"
  38 #include "llvm/ADT/UniqueVector.h"
  39 #include "llvm/ADT/SmallPtrSet.h"
  40 #include "llvm/ADT/SmallSet.h"
  41 #include "llvm/ADT/StringMap.h"
  42 #include "llvm/CodeGen/MachineLocation.h"
  43 #include "llvm/GlobalValue.h"
  44 #include "llvm/Pass.h"
  45 #include "llvm/Metadata.h"
  46
  47 #define ATTACH_DEBUG_INFO_TO_AN_INSN 1
  48
  49 namespace llvm {
  50
  51 //===----------------------------------------------------------------------===//
  52 // Forward declarations.
  53 class Constant;
  54 class MDNode;
  55 class GlobalVariable;
  56 class MachineBasicBlock;
  57 class MachineFunction;
  58 class Module;
  59 class PointerType;
  60 class StructType;
  61
  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   virtual ~MachineModuleInfoImpl();
  70 };
  71
  72
  73
  74 //===----------------------------------------------------------------------===//
  75 /// LandingPadInfo - This structure is used to retain landing pad info for
  76 /// the current function.
  77 ///
  78 struct LandingPadInfo {
  79   MachineBasicBlock *LandingPadBlock;   // Landing pad block.
  80   SmallVector<unsigned, 1> BeginLabels; // Labels prior to invoke.
  81   SmallVector<unsigned, 1> EndLabels;   // Labels after invoke.
  82   unsigned LandingPadLabel;             // Label at beginning of landing pad.
  83   Function *Personality;                // Personality function.
  84   std::vector<int> TypeIds;             // List of type ids (filters negative)
  85
  86   explicit LandingPadInfo(MachineBasicBlock *MBB)
  87   : LandingPadBlock(MBB)
  88   , LandingPadLabel(0)
  89   , Personality(NULL)
  90   {}
  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   /// ObjFileMMI - This is the object-file-format-specific implementation of
 100   /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
 101   /// want.
 102   MachineModuleInfoImpl *ObjFileMMI;
 103
 104   // LabelIDList - One entry per assigned label.  Normally the entry is equal to
 105   // the list index(+1).  If the entry is zero then the label has been deleted.
 106   // Any other value indicates the label has been deleted by is mapped to
 107   // another label.
 108   std::vector<unsigned> LabelIDList;
 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   // LandingPads - List of LandingPadInfo describing the landing pad information
 115   // in the current function.
 116   std::vector<LandingPadInfo> LandingPads;
 117
 118   // TypeInfos - List of C++ TypeInfo used in the current function.
 119   //
 120   std::vector<GlobalVariable *> TypeInfos;
 121
 122   // FilterIds - List of typeids encoding filters used in the current function.
 123   //
 124   std::vector<unsigned> FilterIds;
 125
 126   // FilterEnds - List of the indices in FilterIds corresponding to filter
 127   // terminators.
 128   //
 129   std::vector<unsigned> FilterEnds;
 130
 131   // Personalities - Vector of all personality functions ever seen. Used to emit
 132   // common EH frames.
 133   std::vector<Function *> Personalities;
 134
 135   /// UsedFunctions - The functions in the @llvm.used list in a more easily
 136   /// searchable format.  This does not include the functions in
 137   /// llvm.compiler.used.
 138   SmallPtrSet<const Function *, 32> UsedFunctions;
 139
 140   /// UsedDbgLabels - labels are used by debug info entries.
 141   SmallSet<unsigned, 8> UsedDbgLabels;
 142
 143   bool CallsEHReturn;
 144   bool CallsUnwindInit;
 145
 146   /// DbgInfoAvailable - True if debugging information is available
 147   /// in this module.
 148   bool DbgInfoAvailable;
 149
 150 public:
 151   static char ID; // Pass identification, replacement for typeid
 152
 153   typedef std::pair<unsigned, TrackingVH<MDNode> > UnsignedAndMDNodePair;
 154   typedef SmallVector< std::pair<TrackingVH<MDNode>, UnsignedAndMDNodePair>, 4>
 155     VariableDbgInfoMapTy;
 156   VariableDbgInfoMapTy VariableDbgInfo;
 157
 158   MachineModuleInfo();
 159   ~MachineModuleInfo();
 160
 161   bool doInitialization();
 162   bool doFinalization();
 163
 164   /// BeginFunction - Begin gathering function meta information.
 165   ///
 166   void BeginFunction(MachineFunction *) {}
 167
 168   /// EndFunction - Discard function meta information.
 169   ///
 170   void EndFunction();
 171
 172   /// getInfo - Keep track of various per-function pieces of information for
 173   /// backends that would like to do so.
 174   ///
 175   template<typename Ty>
 176   Ty &getObjFileInfo() {
 177     if (ObjFileMMI == 0)
 178       ObjFileMMI = new Ty(*this);
 179
 180     assert((void*)dynamic_cast<Ty*>(ObjFileMMI) == (void*)ObjFileMMI &&
 181            "Invalid concrete type or multiple inheritence for getInfo");
 182     return *static_cast<Ty*>(ObjFileMMI);
 183   }
 184
 185   template<typename Ty>
 186   const Ty &getObjFileInfo() const {
 187     return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
 188   }
 189
 190   /// AnalyzeModule - Scan the module for global debug information.
 191   ///
 192   void AnalyzeModule(Module &M);
 193
 194   /// hasDebugInfo - Returns true if valid debug info is present.
 195   ///
 196   bool hasDebugInfo() const { return DbgInfoAvailable; }
 197   void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
 198
 199   bool callsEHReturn() const { return CallsEHReturn; }
 200   void setCallsEHReturn(bool b) { CallsEHReturn = b; }
 201
 202   bool callsUnwindInit() const { return CallsUnwindInit; }
 203   void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
 204
 205   /// NextLabelID - Return the next unique label id.
 206   ///
 207   unsigned NextLabelID() {
 208     unsigned ID = (unsigned)LabelIDList.size() + 1;
 209     LabelIDList.push_back(ID);
 210     return ID;
 211   }
 212
 213   /// InvalidateLabel - Inhibit use of the specified label # from
 214   /// MachineModuleInfo, for example because the code was deleted.
 215   void InvalidateLabel(unsigned LabelID) {
 216     // Remap to zero to indicate deletion.
 217     RemapLabel(LabelID, 0);
 218   }
 219
 220   /// RemapLabel - Indicate that a label has been merged into another.
 221   ///
 222   void RemapLabel(unsigned OldLabelID, unsigned NewLabelID) {
 223     assert(0 < OldLabelID && OldLabelID <= LabelIDList.size() &&
 224           "Old label ID out of range.");
 225     assert(NewLabelID <= LabelIDList.size() &&
 226           "New label ID out of range.");
 227     LabelIDList[OldLabelID - 1] = NewLabelID;
 228   }
 229
 230   /// MappedLabel - Find out the label's final ID.  Zero indicates deletion.
 231   /// ID != Mapped ID indicates that the label was folded into another label.
 232   unsigned MappedLabel(unsigned LabelID) const {
 233     assert(LabelID <= LabelIDList.size() && "Debug label ID out of range.");
 234     return LabelID ? LabelIDList[LabelID - 1] : 0;
 235   }
 236
 237   /// isDbgLabelUsed - Return true if label with LabelID is used by
 238   /// DwarfWriter.
 239   bool isDbgLabelUsed(unsigned LabelID) {
 240     return UsedDbgLabels.count(LabelID);
 241   }
 242
 243   /// RecordUsedDbgLabel - Mark label with LabelID as used. This is used
 244   /// by DwarfWriter to inform DebugLabelFolder that certain labels are
 245   /// not to be deleted.
 246   void RecordUsedDbgLabel(unsigned LabelID) {
 247     UsedDbgLabels.insert(LabelID);
 248   }
 249
 250   /// getFrameMoves - Returns a reference to a list of moves done in the current
 251   /// function's prologue.  Used to construct frame maps for debug and exception
 252   /// handling comsumers.
 253   std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
 254
 255   //===-EH-----------------------------------------------------------------===//
 256
 257   /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
 258   /// specified MachineBasicBlock.
 259   LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
 260
 261   /// addInvoke - Provide the begin and end labels of an invoke style call and
 262   /// associate it with a try landing pad block.
 263   void addInvoke(MachineBasicBlock *LandingPad, unsigned BeginLabel,
 264                                                 unsigned EndLabel);
 265
 266   /// addLandingPad - Add a new panding pad.  Returns the label ID for the
 267   /// landing pad entry.
 268   unsigned addLandingPad(MachineBasicBlock *LandingPad);
 269
 270   /// addPersonality - Provide the personality function for the exception
 271   /// information.
 272   void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
 273
 274   /// getPersonalityIndex - Get index of the current personality function inside
 275   /// Personalitites array
 276   unsigned getPersonalityIndex() const;
 277
 278   /// getPersonalities - Return array of personality functions ever seen.
 279   const std::vector<Function *>& getPersonalities() const {
 280     return Personalities;
 281   }
 282
 283   /// isUsedFunction - Return true if the functions in the llvm.used list.  This
 284   /// does not return true for things in llvm.compiler.used unless they are also
 285   /// in llvm.used.
 286   bool isUsedFunction(const Function *F) {
 287     return UsedFunctions.count(F);
 288   }
 289
 290   /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
 291   ///
 292   void addCatchTypeInfo(MachineBasicBlock *LandingPad,
 293                         std::vector<GlobalVariable *> &TyInfo);
 294
 295   /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
 296   ///
 297   void addFilterTypeInfo(MachineBasicBlock *LandingPad,
 298                          std::vector<GlobalVariable *> &TyInfo);
 299
 300   /// addCleanup - Add a cleanup action for a landing pad.
 301   ///
 302   void addCleanup(MachineBasicBlock *LandingPad);
 303
 304   /// getTypeIDFor - Return the type id for the specified typeinfo.  This is
 305   /// function wide.
 306   unsigned getTypeIDFor(GlobalVariable *TI);
 307
 308   /// getFilterIDFor - Return the id of the filter encoded by TyIds.  This is
 309   /// function wide.
 310   int getFilterIDFor(std::vector<unsigned> &TyIds);
 311
 312   /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
 313   /// pads.
 314   void TidyLandingPads();
 315
 316   /// getLandingPads - Return a reference to the landing pad info for the
 317   /// current function.
 318   const std::vector<LandingPadInfo> &getLandingPads() const {
 319     return LandingPads;
 320   }
 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