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