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