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