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 #include "llvm/Support/ValueHandle.h"
  47
  48 namespace llvm {
  49
  50 //===----------------------------------------------------------------------===//
  51 // Forward declarations.
  52 class Constant;
  53 class MDNode;
  54 class GlobalVariable;
  55 class MachineBasicBlock;
  56 class MachineFunction;
  57 class Module;
  58 class PointerType;
  59 class StructType;
  60
  61
  62 /// MachineModuleInfoImpl - This class can be derived from and used by targets
  63 /// to hold private target-specific information for each Module.  Objects of
  64 /// type are accessed/created with MMI::getInfo and destroyed when the
  65 /// MachineModuleInfo is destroyed.
  66 class MachineModuleInfoImpl {
  67 public:
  68   virtual ~MachineModuleInfoImpl();
  69 };
  70
  71
  72
  73 //===----------------------------------------------------------------------===//
  74 /// LandingPadInfo - This structure is used to retain landing pad info for
  75 /// the current function.
  76 ///
  77 struct LandingPadInfo {
  78   MachineBasicBlock *LandingPadBlock;   // Landing pad block.
  79   SmallVector<unsigned, 1> BeginLabels; // Labels prior to invoke.
  80   SmallVector<unsigned, 1> EndLabels;   // Labels after invoke.
  81   unsigned LandingPadLabel;             // Label at beginning of landing pad.
  82   Function *Personality;                // Personality function.
  83   std::vector<int> TypeIds;             // List of type ids (filters negative)
  84
  85   explicit LandingPadInfo(MachineBasicBlock *MBB)
  86   : LandingPadBlock(MBB)
  87   , LandingPadLabel(0)
  88   , Personality(NULL)
  89   {}
  90 };
  91
  92 //===----------------------------------------------------------------------===//
  93 /// MachineModuleInfo - This class contains meta information specific to a
  94 /// module.  Queries can be made by different debugging and exception handling
  95 /// schemes and reformated for specific use.
  96 ///
  97 class MachineModuleInfo : public ImmutablePass {
  98   /// ObjFileMMI - This is the object-file-format-specific implementation of
  99   /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
 100   /// want.
 101   MachineModuleInfoImpl *ObjFileMMI;
 102
 103   // LabelIDList - One entry per assigned label.  Normally the entry is equal to
 104   // the list index(+1).  If the entry is zero then the label has been deleted.
 105   // Any other value indicates the label has been deleted by is mapped to
 106   // another label.
 107   std::vector<unsigned> LabelIDList;
 108
 109   // FrameMoves - List of moves done by a function's prolog.  Used to construct
 110   // frame maps by debug and exception handling consumers.
 111   std::vector<MachineMove> FrameMoves;
 112
 113   // LandingPads - List of LandingPadInfo describing the landing pad information
 114   // in the current function.
 115   std::vector<LandingPadInfo> LandingPads;
 116
 117   // TypeInfos - List of C++ TypeInfo used in the current function.
 118   //
 119   std::vector<GlobalVariable *> TypeInfos;
 120
 121   // FilterIds - List of typeids encoding filters used in the current function.
 122   //
 123   std::vector<unsigned> FilterIds;
 124
 125   // FilterEnds - List of the indices in FilterIds corresponding to filter
 126   // terminators.
 127   //
 128   std::vector<unsigned> FilterEnds;
 129
 130   // Personalities - Vector of all personality functions ever seen. Used to emit
 131   // common EH frames.
 132   std::vector<Function *> Personalities;
 133
 134   /// UsedFunctions - The functions in the @llvm.used list in a more easily
 135   /// searchable format.  This does not include the functions in
 136   /// llvm.compiler.used.
 137   SmallPtrSet<const Function *, 32> UsedFunctions;
 138
 139   bool CallsEHReturn;
 140   bool CallsUnwindInit;
 141
 142   /// DbgInfoAvailable - True if debugging information is available
 143   /// in this module.
 144   bool DbgInfoAvailable;
 145
 146 public:
 147   static char ID; // Pass identification, replacement for typeid
 148
 149   typedef std::pair<unsigned, TrackingVH<MDNode> > UnsignedAndMDNodePair;
 150   typedef SmallVector< std::pair<TrackingVH<MDNode>, UnsignedAndMDNodePair>, 4>
 151     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   /// getFrameMoves - Returns a reference to a list of moves done in the current
 234   /// function's prologue.  Used to construct frame maps for debug and exception
 235   /// handling comsumers.
 236   std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
 237
 238   //===-EH-----------------------------------------------------------------===//
 239
 240   /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
 241   /// specified MachineBasicBlock.
 242   LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
 243
 244   /// addInvoke - Provide the begin and end labels of an invoke style call and
 245   /// associate it with a try landing pad block.
 246   void addInvoke(MachineBasicBlock *LandingPad, unsigned BeginLabel,
 247                                                 unsigned EndLabel);
 248
 249   /// addLandingPad - Add a new panding pad.  Returns the label ID for the
 250   /// landing pad entry.
 251   unsigned addLandingPad(MachineBasicBlock *LandingPad);
 252
 253   /// addPersonality - Provide the personality function for the exception
 254   /// information.
 255   void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
 256
 257   /// getPersonalityIndex - Get index of the current personality function inside
 258   /// Personalitites array
 259   unsigned getPersonalityIndex() const;
 260
 261   /// getPersonalities - Return array of personality functions ever seen.
 262   const std::vector<Function *>& getPersonalities() const {
 263     return Personalities;
 264   }
 265
 266   /// isUsedFunction - Return true if the functions in the llvm.used list.  This
 267   /// does not return true for things in llvm.compiler.used unless they are also
 268   /// in llvm.used.
 269   bool isUsedFunction(const Function *F) {
 270     return UsedFunctions.count(F);
 271   }
 272
 273   /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
 274   ///
 275   void addCatchTypeInfo(MachineBasicBlock *LandingPad,
 276                         std::vector<GlobalVariable *> &TyInfo);
 277
 278   /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
 279   ///
 280   void addFilterTypeInfo(MachineBasicBlock *LandingPad,
 281                          std::vector<GlobalVariable *> &TyInfo);
 282
 283   /// addCleanup - Add a cleanup action for a landing pad.
 284   ///
 285   void addCleanup(MachineBasicBlock *LandingPad);
 286
 287   /// getTypeIDFor - Return the type id for the specified typeinfo.  This is
 288   /// function wide.
 289   unsigned getTypeIDFor(GlobalVariable *TI);
 290
 291   /// getFilterIDFor - Return the id of the filter encoded by TyIds.  This is
 292   /// function wide.
 293   int getFilterIDFor(std::vector<unsigned> &TyIds);
 294
 295   /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
 296   /// pads.
 297   void TidyLandingPads();
 298
 299   /// getLandingPads - Return a reference to the landing pad info for the
 300   /// current function.
 301   const std::vector<LandingPadInfo> &getLandingPads() const {
 302     return LandingPads;
 303   }
 304
 305   /// getTypeInfos - Return a reference to the C++ typeinfo for the current
 306   /// function.
 307   const std::vector<GlobalVariable *> &getTypeInfos() const {
 308     return TypeInfos;
 309   }
 310
 311   /// getFilterIds - Return a reference to the typeids encoding filters used in
 312   /// the current function.
 313   const std::vector<unsigned> &getFilterIds() const {
 314     return FilterIds;
 315   }
 316
 317   /// getPersonality - Return a personality function if available.  The presence
 318   /// of one is required to emit exception handling info.
 319   Function *getPersonality() const;
 320
 321   /// setVariableDbgInfo - Collect information used to emit debugging information
 322   /// of a variable.
 323   void setVariableDbgInfo(MDNode *N, unsigned Slot, MDNode *Scope) {
 324     VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Scope)));
 325   }
 326
 327   VariableDbgInfoMapTy &getVariableDbgInfo() {  return VariableDbgInfo;  }
 328
 329 }; // End class MachineModuleInfo
 330
 331 } // End llvm namespace
 332
 333 #endif