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/Support/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   /// UsedDbgLabels - labels are used by debug info entries.
 139   SmallSet<unsigned, 8> UsedDbgLabels;
 140
 141   bool CallsEHReturn;
 142   bool CallsUnwindInit;
 143
 144   /// DbgInfoAvailable - True if debugging information is available
 145   /// in this module.
 146   bool DbgInfoAvailable;
 147
 148 public:
 149   static char ID; // Pass identification, replacement for typeid
 150
 151   typedef SmallVector< std::pair< WeakMetadataVH, unsigned>, 4 > VariableDbgInfoMapTy;
 152   VariableDbgInfoMapTy VariableDbgInfo;
 153
 154   MachineModuleInfo();
 155   ~MachineModuleInfo();
 156
 157   bool doInitialization();
 158   bool doFinalization();
 159
 160   /// BeginFunction - Begin gathering function meta information.
 161   ///
 162   void BeginFunction(MachineFunction *) {}
 163
 164   /// EndFunction - Discard function meta information.
 165   ///
 166   void EndFunction();
 167
 168   /// getInfo - Keep track of various per-function pieces of information for
 169   /// backends that would like to do so.
 170   ///
 171   template<typename Ty>
 172   Ty &getObjFileInfo() {
 173     if (ObjFileMMI == 0)
 174       ObjFileMMI = new Ty(*this);
 175
 176     assert((void*)dynamic_cast<Ty*>(ObjFileMMI) == (void*)ObjFileMMI &&
 177            "Invalid concrete type or multiple inheritence for getInfo");
 178     return *static_cast<Ty*>(ObjFileMMI);
 179   }
 180
 181   template<typename Ty>
 182   const Ty &getObjFileInfo() const {
 183     return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
 184   }
 185
 186   /// AnalyzeModule - Scan the module for global debug information.
 187   ///
 188   void AnalyzeModule(Module &M);
 189
 190   /// hasDebugInfo - Returns true if valid debug info is present.
 191   ///
 192   bool hasDebugInfo() const { return DbgInfoAvailable; }
 193   void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
 194
 195   bool callsEHReturn() const { return CallsEHReturn; }
 196   void setCallsEHReturn(bool b) { CallsEHReturn = b; }
 197
 198   bool callsUnwindInit() const { return CallsUnwindInit; }
 199   void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
 200
 201   /// NextLabelID - Return the next unique label id.
 202   ///
 203   unsigned NextLabelID() {
 204     unsigned ID = (unsigned)LabelIDList.size() + 1;
 205     LabelIDList.push_back(ID);
 206     return ID;
 207   }
 208
 209   /// InvalidateLabel - Inhibit use of the specified label # from
 210   /// MachineModuleInfo, for example because the code was deleted.
 211   void InvalidateLabel(unsigned LabelID) {
 212     // Remap to zero to indicate deletion.
 213     RemapLabel(LabelID, 0);
 214   }
 215
 216   /// RemapLabel - Indicate that a label has been merged into another.
 217   ///
 218   void RemapLabel(unsigned OldLabelID, unsigned NewLabelID) {
 219     assert(0 < OldLabelID && OldLabelID <= LabelIDList.size() &&
 220           "Old label ID out of range.");
 221     assert(NewLabelID <= LabelIDList.size() &&
 222           "New label ID out of range.");
 223     LabelIDList[OldLabelID - 1] = NewLabelID;
 224   }
 225
 226   /// MappedLabel - Find out the label's final ID.  Zero indicates deletion.
 227   /// ID != Mapped ID indicates that the label was folded into another label.
 228   unsigned MappedLabel(unsigned LabelID) const {
 229     assert(LabelID <= LabelIDList.size() && "Debug label ID out of range.");
 230     return LabelID ? LabelIDList[LabelID - 1] : 0;
 231   }
 232
 233   /// isDbgLabelUsed - Return true if label with LabelID is used by
 234   /// DwarfWriter.
 235   bool isDbgLabelUsed(unsigned LabelID) {
 236     return UsedDbgLabels.count(LabelID);
 237   }
 238
 239   /// RecordUsedDbgLabel - Mark label with LabelID as used. This is used
 240   /// by DwarfWriter to inform DebugLabelFolder that certain labels are
 241   /// not to be deleted.
 242   void RecordUsedDbgLabel(unsigned LabelID) {
 243     UsedDbgLabels.insert(LabelID);
 244   }
 245
 246   /// getFrameMoves - Returns a reference to a list of moves done in the current
 247   /// function's prologue.  Used to construct frame maps for debug and exception
 248   /// handling comsumers.
 249   std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
 250
 251   //===-EH-----------------------------------------------------------------===//
 252
 253   /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
 254   /// specified MachineBasicBlock.
 255   LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
 256
 257   /// addInvoke - Provide the begin and end labels of an invoke style call and
 258   /// associate it with a try landing pad block.
 259   void addInvoke(MachineBasicBlock *LandingPad, unsigned BeginLabel,
 260                                                 unsigned EndLabel);
 261
 262   /// addLandingPad - Add a new panding pad.  Returns the label ID for the
 263   /// landing pad entry.
 264   unsigned addLandingPad(MachineBasicBlock *LandingPad);
 265
 266   /// addPersonality - Provide the personality function for the exception
 267   /// information.
 268   void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
 269
 270   /// getPersonalityIndex - Get index of the current personality function inside
 271   /// Personalitites array
 272   unsigned getPersonalityIndex() const;
 273
 274   /// getPersonalities - Return array of personality functions ever seen.
 275   const std::vector<Function *>& getPersonalities() const {
 276     return Personalities;
 277   }
 278
 279   /// isUsedFunction - Return true if the functions in the llvm.used list.  This
 280   /// does not return true for things in llvm.compiler.used unless they are also
 281   /// in llvm.used.
 282   bool isUsedFunction(const Function *F) {
 283     return UsedFunctions.count(F);
 284   }
 285
 286   /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
 287   ///
 288   void addCatchTypeInfo(MachineBasicBlock *LandingPad,
 289                         std::vector<GlobalVariable *> &TyInfo);
 290
 291   /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
 292   ///
 293   void addFilterTypeInfo(MachineBasicBlock *LandingPad,
 294                          std::vector<GlobalVariable *> &TyInfo);
 295
 296   /// addCleanup - Add a cleanup action for a landing pad.
 297   ///
 298   void addCleanup(MachineBasicBlock *LandingPad);
 299
 300   /// getTypeIDFor - Return the type id for the specified typeinfo.  This is
 301   /// function wide.
 302   unsigned getTypeIDFor(GlobalVariable *TI);
 303
 304   /// getFilterIDFor - Return the id of the filter encoded by TyIds.  This is
 305   /// function wide.
 306   int getFilterIDFor(std::vector<unsigned> &TyIds);
 307
 308   /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
 309   /// pads.
 310   void TidyLandingPads();
 311
 312   /// getLandingPads - Return a reference to the landing pad info for the
 313   /// current function.
 314   const std::vector<LandingPadInfo> &getLandingPads() const {
 315     return LandingPads;
 316   }
 317
 318   /// getTypeInfos - Return a reference to the C++ typeinfo for the current
 319   /// function.
 320   const std::vector<GlobalVariable *> &getTypeInfos() const {
 321     return TypeInfos;
 322   }
 323
 324   /// getFilterIds - Return a reference to the typeids encoding filters used in
 325   /// the current function.
 326   const std::vector<unsigned> &getFilterIds() const {
 327     return FilterIds;
 328   }
 329
 330   /// getPersonality - Return a personality function if available.  The presence
 331   /// of one is required to emit exception handling info.
 332   Function *getPersonality() const;
 333
 334   /// setVariableDbgInfo - Collect information used to emit debugging information
 335   /// of a variable.
 336   void setVariableDbgInfo(MDNode *N, unsigned S) {
 337     VariableDbgInfo.push_back(std::make_pair(N, S));
 338   }
 339
 340   VariableDbgInfoMapTy &getVariableDbgInfo() {  return VariableDbgInfo;  }
 341
 342 }; // End class MachineModuleInfo
 343
 344 } // End llvm namespace
 345
 346 #endif