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