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/ADT/DenseMap.h"
  35 #include "llvm/ADT/PointerIntPair.h"
  36 #include "llvm/ADT/SmallPtrSet.h"
  37 #include "llvm/ADT/SmallVector.h"
  38 #include "llvm/IR/GlobalValue.h"
  39 #include "llvm/IR/Metadata.h"
  40 #include "llvm/MC/MCContext.h"
  41 #include "llvm/MC/MachineLocation.h"
  42 #include "llvm/Pass.h"
  43 #include "llvm/Support/DataTypes.h"
  44 #include "llvm/Support/DebugLoc.h"
  45 #include "llvm/Support/Dwarf.h"
  46 #include "llvm/Support/ValueHandle.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
 119   /// information in the current function.
 120   std::vector<LandingPadInfo> LandingPads;
 121
 122   /// LPadToCallSiteMap - Map a landing pad's EH symbol to the call site
 123   /// indexes.
 124   DenseMap<MCSymbol*, SmallVector<unsigned, 4> > LPadToCallSiteMap;
 125
 126   /// CallSiteMap - Map of invoke call site index values to associated begin
 127   /// EH_LABEL for the current function.
 128   DenseMap<MCSymbol*, unsigned> CallSiteMap;
 129
 130   /// CurCallSite - The current call site index being processed, if any. 0 if
 131   /// none.
 132   unsigned CurCallSite;
 133
 134   /// TypeInfos - List of C++ TypeInfo used in the current function.
 135   std::vector<const GlobalVariable *> TypeInfos;
 136
 137   /// FilterIds - List of typeids encoding filters used in the current function.
 138   std::vector<unsigned> FilterIds;
 139
 140   /// FilterEnds - List of the indices in FilterIds corresponding to filter
 141   /// terminators.
 142   std::vector<unsigned> FilterEnds;
 143
 144   /// Personalities - Vector of all personality functions ever seen. Used to
 145   /// emit common EH frames.
 146   std::vector<const Function *> Personalities;
 147
 148   /// UsedFunctions - The functions in the @llvm.used list in a more easily
 149   /// searchable format.  This does not include the functions in
 150   /// llvm.compiler.used.
 151   SmallPtrSet<const Function *, 32> UsedFunctions;
 152
 153   /// AddrLabelSymbols - This map keeps track of which symbol is being used for
 154   /// the specified basic block's address of label.
 155   MMIAddrLabelMap *AddrLabelSymbols;
 156
 157   bool CallsEHReturn;
 158   bool CallsUnwindInit;
 159
 160   /// DbgInfoAvailable - True if debugging information is available
 161   /// in this module.
 162   bool DbgInfoAvailable;
 163
 164   /// UsesVAFloatArgument - True if this module calls VarArg function with
 165   /// floating-point arguments.  This is used to emit an undefined reference
 166   /// to _fltused on Windows targets.
 167   bool UsesVAFloatArgument;
 168
 169 public:
 170   static char ID; // Pass identification, replacement for typeid
 171
 172   typedef std::pair<unsigned, DebugLoc> UnsignedDebugLocPair;
 173   typedef SmallVector<std::pair<TrackingVH<MDNode>, UnsignedDebugLocPair>, 4>
 174     VariableDbgInfoMapTy;
 175   VariableDbgInfoMapTy VariableDbgInfo;
 176
 177   MachineModuleInfo();  // DUMMY CONSTRUCTOR, DO NOT CALL.
 178   // Real constructor.
 179   MachineModuleInfo(const MCAsmInfo &MAI, const MCRegisterInfo &MRI,
 180                     const MCObjectFileInfo *MOFI);
 181   ~MachineModuleInfo();
 182
 183   // Initialization and Finalization
 184   virtual bool doInitialization(Module &);
 185   virtual bool doFinalization(Module &);
 186
 187   /// EndFunction - Discard function meta information.
 188   ///
 189   void EndFunction();
 190
 191   const MCContext &getContext() const { return Context; }
 192   MCContext &getContext() { return Context; }
 193
 194   void setModule(const Module *M) { TheModule = M; }
 195   const Module *getModule() const { return TheModule; }
 196
 197   /// getInfo - Keep track of various per-function pieces of information for
 198   /// backends that would like to do so.
 199   ///
 200   template<typename Ty>
 201   Ty &getObjFileInfo() {
 202     if (ObjFileMMI == 0)
 203       ObjFileMMI = new Ty(*this);
 204     return *static_cast<Ty*>(ObjFileMMI);
 205   }
 206
 207   template<typename Ty>
 208   const Ty &getObjFileInfo() const {
 209     return const_cast<MachineModuleInfo*>(this)->getObjFileInfo<Ty>();
 210   }
 211
 212   /// AnalyzeModule - Scan the module for global debug information.
 213   ///
 214   void AnalyzeModule(const Module &M);
 215
 216   /// hasDebugInfo - Returns true if valid debug info is present.
 217   ///
 218   bool hasDebugInfo() const { return DbgInfoAvailable; }
 219   void setDebugInfoAvailability(bool avail) { DbgInfoAvailable = avail; }
 220
 221   bool callsEHReturn() const { return CallsEHReturn; }
 222   void setCallsEHReturn(bool b) { CallsEHReturn = b; }
 223
 224   bool callsUnwindInit() const { return CallsUnwindInit; }
 225   void setCallsUnwindInit(bool b) { CallsUnwindInit = b; }
 226
 227   bool usesVAFloatArgument() const {
 228     return UsesVAFloatArgument;
 229   }
 230
 231   void setUsesVAFloatArgument(bool b) {
 232     UsesVAFloatArgument = b;
 233   }
 234
 235   /// getFrameMoves - Returns a reference to a list of moves done in the current
 236   /// function's prologue.  Used to construct frame maps for debug and exception
 237   /// handling comsumers.
 238   std::vector<MachineMove> &getFrameMoves() { return FrameMoves; }
 239
 240   /// getCompactUnwindEncoding - Returns the compact unwind encoding for a
 241   /// function if the target supports the encoding. This encoding replaces a
 242   /// function's CIE and FDE.
 243   uint32_t getCompactUnwindEncoding() const { return CompactUnwindEncoding; }
 244
 245   /// setCompactUnwindEncoding - Set the compact unwind encoding for a function
 246   /// if the target supports the encoding.
 247   void setCompactUnwindEncoding(uint32_t Enc) { CompactUnwindEncoding = Enc; }
 248
 249   /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
 250   /// block when its address is taken.  This cannot be its normal LBB label
 251   /// because the block may be accessed outside its containing function.
 252   MCSymbol *getAddrLabelSymbol(const BasicBlock *BB);
 253
 254   /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
 255   /// basic block when its address is taken.  If other blocks were RAUW'd to
 256   /// this one, we may have to emit them as well, return the whole set.
 257   std::vector<MCSymbol*> getAddrLabelSymbolToEmit(const BasicBlock *BB);
 258
 259   /// takeDeletedSymbolsForFunction - If the specified function has had any
 260   /// references to address-taken blocks generated, but the block got deleted,
 261   /// return the symbol now so we can emit it.  This prevents emitting a
 262   /// reference to a symbol that has no definition.
 263   void takeDeletedSymbolsForFunction(const Function *F,
 264                                      std::vector<MCSymbol*> &Result);
 265
 266
 267   //===- EH ---------------------------------------------------------------===//
 268
 269   /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
 270   /// specified MachineBasicBlock.
 271   LandingPadInfo &getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad);
 272
 273   /// addInvoke - Provide the begin and end labels of an invoke style call and
 274   /// associate it with a try landing pad block.
 275   void addInvoke(MachineBasicBlock *LandingPad,
 276                  MCSymbol *BeginLabel, MCSymbol *EndLabel);
 277
 278   /// addLandingPad - Add a new panding pad.  Returns the label ID for the
 279   /// landing pad entry.
 280   MCSymbol *addLandingPad(MachineBasicBlock *LandingPad);
 281
 282   /// addPersonality - Provide the personality function for the exception
 283   /// information.
 284   void addPersonality(MachineBasicBlock *LandingPad,
 285                       const Function *Personality);
 286
 287   /// getPersonalityIndex - Get index of the current personality function inside
 288   /// Personalitites array
 289   unsigned getPersonalityIndex() const;
 290
 291   /// getPersonalities - Return array of personality functions ever seen.
 292   const std::vector<const Function *>& getPersonalities() const {
 293     return Personalities;
 294   }
 295
 296   /// isUsedFunction - Return true if the functions in the llvm.used list.  This
 297   /// does not return true for things in llvm.compiler.used unless they are also
 298   /// in llvm.used.
 299   bool isUsedFunction(const Function *F) {
 300     return UsedFunctions.count(F);
 301   }
 302
 303   /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
 304   ///
 305   void addCatchTypeInfo(MachineBasicBlock *LandingPad,
 306                         ArrayRef<const GlobalVariable *> TyInfo);
 307
 308   /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
 309   ///
 310   void addFilterTypeInfo(MachineBasicBlock *LandingPad,
 311                          ArrayRef<const GlobalVariable *> TyInfo);
 312
 313   /// addCleanup - Add a cleanup action for a landing pad.
 314   ///
 315   void addCleanup(MachineBasicBlock *LandingPad);
 316
 317   /// getTypeIDFor - Return the type id for the specified typeinfo.  This is
 318   /// function wide.
 319   unsigned getTypeIDFor(const GlobalVariable *TI);
 320
 321   /// getFilterIDFor - Return the id of the filter encoded by TyIds.  This is
 322   /// function wide.
 323   int getFilterIDFor(std::vector<unsigned> &TyIds);
 324
 325   /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
 326   /// pads.
 327   void TidyLandingPads(DenseMap<MCSymbol*, uintptr_t> *LPMap = 0);
 328
 329   /// getLandingPads - Return a reference to the landing pad info for the
 330   /// current function.
 331   const std::vector<LandingPadInfo> &getLandingPads() const {
 332     return LandingPads;
 333   }
 334
 335   /// setCallSiteLandingPad - Map the landing pad's EH symbol to the call
 336   /// site indexes.
 337   void setCallSiteLandingPad(MCSymbol *Sym, ArrayRef<unsigned> Sites);
 338
 339   /// getCallSiteLandingPad - Get the call site indexes for a landing pad EH
 340   /// symbol.
 341   SmallVectorImpl<unsigned> &getCallSiteLandingPad(MCSymbol *Sym) {
 342     assert(hasCallSiteLandingPad(Sym) &&
 343            "missing call site number for landing pad!");
 344     return LPadToCallSiteMap[Sym];
 345   }
 346
 347   /// hasCallSiteLandingPad - Return true if the landing pad Eh symbol has an
 348   /// associated call site.
 349   bool hasCallSiteLandingPad(MCSymbol *Sym) {
 350     return !LPadToCallSiteMap[Sym].empty();
 351   }
 352
 353   /// setCallSiteBeginLabel - Map the begin label for a call site.
 354   void setCallSiteBeginLabel(MCSymbol *BeginLabel, unsigned Site) {
 355     CallSiteMap[BeginLabel] = Site;
 356   }
 357
 358   /// getCallSiteBeginLabel - Get the call site number for a begin label.
 359   unsigned getCallSiteBeginLabel(MCSymbol *BeginLabel) {
 360     assert(hasCallSiteBeginLabel(BeginLabel) &&
 361            "Missing call site number for EH_LABEL!");
 362     return CallSiteMap[BeginLabel];
 363   }
 364
 365   /// hasCallSiteBeginLabel - Return true if the begin label has a call site
 366   /// number associated with it.
 367   bool hasCallSiteBeginLabel(MCSymbol *BeginLabel) {
 368     return CallSiteMap[BeginLabel] != 0;
 369   }
 370
 371   /// setCurrentCallSite - Set the call site currently being processed.
 372   void setCurrentCallSite(unsigned Site) { CurCallSite = Site; }
 373
 374   /// getCurrentCallSite - Get the call site currently being processed, if any.
 375   /// return zero if none.
 376   unsigned getCurrentCallSite() { return CurCallSite; }
 377
 378   /// getTypeInfos - Return a reference to the C++ typeinfo for the current
 379   /// function.
 380   const std::vector<const GlobalVariable *> &getTypeInfos() const {
 381     return TypeInfos;
 382   }
 383
 384   /// getFilterIds - Return a reference to the typeids encoding filters used in
 385   /// the current function.
 386   const std::vector<unsigned> &getFilterIds() const {
 387     return FilterIds;
 388   }
 389
 390   /// getPersonality - Return a personality function if available.  The presence
 391   /// of one is required to emit exception handling info.
 392   const Function *getPersonality() const;
 393
 394   /// setVariableDbgInfo - Collect information used to emit debugging
 395   /// information of a variable.
 396   void setVariableDbgInfo(MDNode *N, unsigned Slot, DebugLoc Loc) {
 397     VariableDbgInfo.push_back(std::make_pair(N, std::make_pair(Slot, Loc)));
 398   }
 399
 400   VariableDbgInfoMapTy &getVariableDbgInfo() { return VariableDbgInfo; }
 401
 402 }; // End class MachineModuleInfo
 403
 404 } // End llvm namespace
 405
 406 #endif