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/Pass.h"
  35 #include "llvm/GlobalValue.h"
  36 #include "llvm/Metadata.h"
  37 #include "llvm/CodeGen/MachineLocation.h"
  38 #include "llvm/MC/MCContext.h"
  39 #include "llvm/Support/Dwarf.h"
  40 #include "llvm/Support/ValueHandle.h"
  41 #include "llvm/System/DataTypes.h"
  42 #include "llvm/ADT/DenseMap.h"
  43 #include "llvm/ADT/PointerIntPair.h"
  44 #include "llvm/ADT/SmallPtrSet.h"
  45 #include "llvm/ADT/SmallVector.h"
  46
  47 namespace llvm {
  48
  49 //===----------------------------------------------------------------------===//
  50 // Forward declarations.
  51 class Constant;
  52 class GlobalVariable;
  53 class MDNode;
  54 class MachineBasicBlock;
  55 class MachineFunction;
  56 class Module;
  57 class PointerType;
  58 class StructType;
  59
  60 /// MachineModuleInfoImpl - This class can be derived from and used by targets
  61 /// to hold private target-specific information for each Module.  Objects of
  62 /// type are accessed/created with MMI::getInfo and destroyed when the
  63 /// MachineModuleInfo is destroyed.
  64 class MachineModuleInfoImpl {
  65 public:
  66   typedef PointerIntPair<MCSymbol*, 1, bool> StubValueTy;
  67   virtual ~MachineModuleInfoImpl();
  68   typedef std::vector<std::pair<MCSymbol*, StubValueTy> > SymbolListTy;
  69 protected:
  70   static SymbolListTy GetSortedStubs(const DenseMap<MCSymbol*, StubValueTy>&);
  71 };
  72
  73
  74
  75 //===----------------------------------------------------------------------===//
  76 /// LandingPadInfo - This structure is used to retain landing pad info for
  77 /// the current function.
  78 ///
  79 struct LandingPadInfo {
  80   MachineBasicBlock *LandingPadBlock;    // Landing pad block.
  81   SmallVector<MCSymbol*, 1> BeginLabels; // Labels prior to invoke.
  82   SmallVector<MCSymbol*, 1> EndLabels;   // Labels after invoke.
  83   MCSymbol *LandingPadLabel;             // Label at beginning of landing pad.
  84   Function *Personality;                 // Personality function.
  85   std::vector<int> TypeIds;              // List of type ids (filters negative)
  86
  87   explicit LandingPadInfo(MachineBasicBlock *MBB)
  88     : LandingPadBlock(MBB), LandingPadLabel(0), Personality(0) {}
  89 };
  90
  91 class MMIAddrLabelMap;
  92
  93 //===----------------------------------------------------------------------===//
  94 /// MachineModuleInfo - This class contains meta information specific to a
  95 /// module.  Queries can be made by different debugging and exception handling
  96 /// schemes and reformated for specific use.
  97 ///
  98 class MachineModuleInfo : public ImmutablePass {
  99   /// Context - This is the MCContext used for the entire code generator.
 100   MCContext Context;
 101
 102   /// ObjFileMMI - This is the object-file-format-specific implementation of
 103   /// MachineModuleInfoImpl, which lets targets accumulate whatever info they
 104   /// want.
 105   MachineModuleInfoImpl *ObjFileMMI;
 106
 107   // FrameMoves - List of moves done by a function's prolog.  Used to construct
 108   // frame maps by debug and exception handling consumers.
 109   std::vector<MachineMove> FrameMoves;
 110
 111   // LandingPads - List of LandingPadInfo describing the landing pad information
 112   // in the current function.
 113   std::vector<LandingPadInfo> LandingPads;
 114
 115   // Map of invoke call site index values to associated begin EH_LABEL for
 116   // the current function.
 117   DenseMap<MCSymbol*, unsigned> CallSiteMap;
 118
 119   // The current call site index being processed, if any. 0 if none.
 120   unsigned CurCallSite;
 121
 122   // TypeInfos - List of C++ TypeInfo used in the current function.
 123   //
 124   std::vector<GlobalVariable *> TypeInfos;
 125
 126   // FilterIds - List of typeids encoding filters used in the current function.
 127   //
 128   std::vector<unsigned> FilterIds;
 129
 130   // FilterEnds - List of the indices in FilterIds corresponding to filter
 131   // terminators.
 132   //
 133   std::vector<unsigned> FilterEnds;
 134
 135   // Personalities - Vector of all personality functions ever seen. Used to emit
 136   // common EH frames.
 137   std::vector<Function *> Personalities;
 138
 139   /// UsedFunctions - The functions in the @llvm.used list in a more easily
 140   /// searchable format.  This does not include the functions in
 141   /// llvm.compiler.used.
 142   SmallPtrSet<const Function *, 32> UsedFunctions;
 143
 144
 145   /// AddrLabelSymbols - This map keeps track of which symbol is being used for
 146   /// the specified basic block's address of label.
 147   MMIAddrLabelMap *AddrLabelSymbols;
 148
 149   bool CallsEHReturn;
 150   bool CallsUnwindInit;
 151
 152   /// DbgInfoAvailable - True if debugging information is available
 153   /// in this module.
 154   bool DbgInfoAvailable;
 155
 156 public:
 157   static char ID; // Pass identification, replacement for typeid
 158
 159   typedef std::pair<unsigned, TrackingVH<MDNode> > UnsignedAndMDNodePair;
 160   typedef SmallVector< std::pair<TrackingVH<MDNode>, UnsignedAndMDNodePair>, 4>
 161     VariableDbgInfoMapTy;
 162   VariableDbgInfoMapTy VariableDbgInfo;
 163
 164   MachineModuleInfo();  // DUMMY CONSTRUCTOR, DO NOT CALL.
 165   MachineModuleInfo(const MCAsmInfo &MAI);  // Real constructor.
 166   ~MachineModuleInfo();
 167
 168   bool doInitialization();
 169   bool doFinalization();
 170
 171   /// EndFunction - Discard function meta information.
 172   ///
 173   void EndFunction();
 174
 175   const MCContext &getContext() const { return Context; }
 176   MCContext &getContext() { return Context; }
 177
 178   /// getInfo - Keep track of various per-function pieces of information for
 179   /// backends that would like to do so.
 180   ///
 181   template<typename Ty>
 182   Ty &getObjFileInfo() {
 183     if (ObjFileMMI == 0)
 184       ObjFileMMI = new Ty(*this);
 185     return *static_cast<Ty*>(ObjFileMMI);
 186   }
 187
 188   template<typename Ty>
 189   const Ty &getObjFileInfo() const {
 190     return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
 191   }
 192
 193   /// AnalyzeModule - Scan the module for global debug information.
 194   ///
 195   void AnalyzeModule(Module &M);
 196
 197   /// hasDebugInfo - Returns true if valid debug info is present.
 198   ///
 199   bool hasDebugInfo() const { return DbgInfoAvailable; }
 200   void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = true; }
 201
 202   bool callsEHReturn() const { return CallsEHReturn; }
 203   void setCallsEHReturn(bool b) { CallsEHReturn = b; }
 204
 205   bool callsUnwindInit() const { return CallsUnwindInit; }
 206   void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
 207
 208   /// getFrameMoves - Returns a reference to a list of moves done in the current
 209   /// function's prologue.  Used to construct frame maps for debug and exception
 210   /// handling comsumers.
 211   std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
 212
 213   /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
 214   /// block when its address is taken.  This cannot be its normal LBB label
 215   /// because the block may be accessed outside its containing function.
 216   MCSymbol *getAddrLabelSymbol(const BasicBlock *BB);
 217
 218   /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
 219   /// basic block when its address is taken.  If other blocks were RAUW'd to
 220   /// this one, we may have to emit them as well, return the whole set.
 221   std::vector<MCSymbol*> getAddrLabelSymbolToEmit(const BasicBlock *BB);
 222
 223   /// takeDeletedSymbolsForFunction - If the specified function has had any
 224   /// references to address-taken blocks generated, but the block got deleted,
 225   /// return the symbol now so we can emit it.  This prevents emitting a
 226   /// reference to a symbol that has no definition.
 227   void takeDeletedSymbolsForFunction(const Function *F,
 228                                      std::vector<MCSymbol*> &Result);
 229
 230
 231   //===- EH ---------------------------------------------------------------===//
 232
 233   /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
 234   /// specified MachineBasicBlock.
 235   LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
 236
 237   /// addInvoke - Provide the begin and end labels of an invoke style call and
 238   /// associate it with a try landing pad block.
 239   void addInvoke(MachineBasicBlock *LandingPad,
 240                  MCSymbol *BeginLabel, MCSymbol *EndLabel);
 241
 242   /// addLandingPad - Add a new panding pad.  Returns the label ID for the
 243   /// landing pad entry.
 244   MCSymbol *addLandingPad(MachineBasicBlock *LandingPad);
 245
 246   /// addPersonality - Provide the personality function for the exception
 247   /// information.
 248   void addPersonality(MachineBasicBlock *LandingPad, Function *Personality);
 249
 250   /// getPersonalityIndex - Get index of the current personality function inside
 251   /// Personalitites array
 252   unsigned getPersonalityIndex() const;
 253
 254   /// getPersonalities - Return array of personality functions ever seen.
 255   const std::vector<Function *>& getPersonalities() const {
 256     return Personalities;
 257   }
 258
 259   /// isUsedFunction - Return true if the functions in the llvm.used list.  This
 260   /// does not return true for things in llvm.compiler.used unless they are also
 261   /// in llvm.used.
 262   bool isUsedFunction(const Function *F) {
 263     return UsedFunctions.count(F);
 264   }
 265
 266   /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
 267   ///
 268   void addCatchTypeInfo(MachineBasicBlock *LandingPad,
 269                         std::vector<GlobalVariable *> &TyInfo);
 270
 271   /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
 272   ///
 273   void addFilterTypeInfo(MachineBasicBlock *LandingPad,
 274                          std::vector<GlobalVariable *> &TyInfo);
 275
 276   /// addCleanup - Add a cleanup action for a landing pad.
 277   ///
 278   void addCleanup(MachineBasicBlock *LandingPad);
 279
 280   /// getTypeIDFor - Return the type id for the specified typeinfo.  This is
 281   /// function wide.
 282   unsigned getTypeIDFor(GlobalVariable *TI);
 283
 284   /// getFilterIDFor - Return the id of the filter encoded by TyIds.  This is
 285   /// function wide.
 286   int getFilterIDFor(std::vector<unsigned> &TyIds);
 287
 288   /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
 289   /// pads.
 290   void TidyLandingPads();
 291
 292   /// getLandingPads - Return a reference to the landing pad info for the
 293   /// current function.
 294   const std::vector<LandingPadInfo> &getLandingPads() const {
 295     return LandingPads;
 296   }
 297
 298   /// setCallSiteBeginLabel - Map the begin label for a call site
 299   void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) {
 300     CallSiteMap[BeginLabel] = Site;
 301   }
 302
 303   /// getCallSiteBeginLabel - Get the call site number for a begin label
 304   unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) {
 305     assert(CallSiteMap.count(BeginLabel) &&
 306            "Missing call site number for EH_LABEL!");
 307     return CallSiteMap[BeginLabel];
 308   }
 309
 310   /// setCurrentCallSite - Set the call site currently being processed.
 311   void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
 312
 313   /// getCurrentCallSite - Get the call site currently being processed, if any.
 314   /// return zero if none.
 315   unsigned getCurrentCallSite(void) { return CurCallSite; }
 316
 317   /// getTypeInfos - Return a reference to the C++ typeinfo for the current
 318   /// function.
 319   const std::vector<GlobalVariable *> &getTypeInfos() const {
 320     return TypeInfos;
 321   }
 322
 323   /// getFilterIds - Return a reference to the typeids encoding filters used in
 324   /// the current function.
 325   const std::vector<unsigned> &getFilterIds() const {
 326     return FilterIds;
 327   }
 328
 329   /// getPersonality - Return a personality function if available.  The presence
 330   /// of one is required to emit exception handling info.
 331   Function *getPersonality() const;
 332
 333   /// setVariableDbgInfo - Collect information used to emit debugging information
 334   /// of a variable.
 335   void setVariableDbgInfo(MDNode *N, unsigned Slot, MDNode *Scope) {
 336     VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Scope)));
 337   }
 338
 339   VariableDbgInfoMapTy &getVariableDbgInfo() {  return VariableDbgInfo;  }
 340
 341 }; // End class MachineModuleInfo
 342
 343 } // End llvm namespace
 344
 345 #endif