contrib/llvm/tools/clang/lib/CodeGen/CGVTables.h

   1 //===--- CGVTables.h - Emit LLVM Code for C++ vtables -----------*- 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 // This contains code dealing with C++ code generation of virtual tables.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef CLANG_CODEGEN_CGVTABLE_H
  15 #define CLANG_CODEGEN_CGVTABLE_H
  16
  17 #include "clang/AST/BaseSubobject.h"
  18 #include "clang/AST/CharUnits.h"
  19 #include "clang/AST/GlobalDecl.h"
  20 #include "clang/AST/VTableBuilder.h"
  21 #include "clang/Basic/ABI.h"
  22 #include "llvm/ADT/DenseMap.h"
  23 #include "llvm/IR/GlobalVariable.h"
  24
  25 namespace clang {
  26   class CXXRecordDecl;
  27
  28 namespace CodeGen {
  29   class CodeGenModule;
  30
  31 class CodeGenVTables {
  32   CodeGenModule &CGM;
  33
  34   VTableContext VTContext;
  35
  36   /// VTables - All the vtables which have been defined.
  37   llvm::DenseMap<const CXXRecordDecl *, llvm::GlobalVariable *> VTables;
  38
  39   /// VTableAddressPointsMapTy - Address points for a single vtable.
  40   typedef llvm::DenseMap<BaseSubobject, uint64_t> VTableAddressPointsMapTy;
  41
  42   typedef std::pair<const CXXRecordDecl *, BaseSubobject> BaseSubobjectPairTy;
  43   typedef llvm::DenseMap<BaseSubobjectPairTy, uint64_t> SubVTTIndiciesMapTy;
  44
  45   /// SubVTTIndicies - Contains indices into the various sub-VTTs.
  46   SubVTTIndiciesMapTy SubVTTIndicies;
  47
  48   typedef llvm::DenseMap<BaseSubobjectPairTy, uint64_t>
  49     SecondaryVirtualPointerIndicesMapTy;
  50
  51   /// SecondaryVirtualPointerIndices - Contains the secondary virtual pointer
  52   /// indices.
  53   SecondaryVirtualPointerIndicesMapTy SecondaryVirtualPointerIndices;
  54
  55   /// EmitThunk - Emit a single thunk.
  56   void EmitThunk(GlobalDecl GD, const ThunkInfo &Thunk,
  57                  bool UseAvailableExternallyLinkage);
  58
  59   /// MaybeEmitThunkAvailableExternally - Try to emit the given thunk with
  60   /// available_externally linkage to allow for inlining of thunks.
  61   /// This will be done iff optimizations are enabled and the member function
  62   /// doesn't contain any incomplete types.
  63   void MaybeEmitThunkAvailableExternally(GlobalDecl GD, const ThunkInfo &Thunk);
  64
  65   /// CreateVTableInitializer - Create a vtable initializer for the given record
  66   /// decl.
  67   /// \param Components - The vtable components; this is really an array of
  68   /// VTableComponents.
  69   llvm::Constant *CreateVTableInitializer(const CXXRecordDecl *RD,
  70                                           const VTableComponent *Components,
  71                                           unsigned NumComponents,
  72                                 const VTableLayout::VTableThunkTy *VTableThunks,
  73                                           unsigned NumVTableThunks);
  74
  75 public:
  76   CodeGenVTables(CodeGenModule &CGM);
  77
  78   VTableContext &getVTableContext() { return VTContext; }
  79
  80   /// needsVTTParameter - Return whether the given global decl needs a VTT
  81   /// parameter, which it does if it's a base constructor or destructor with
  82   /// virtual bases.
  83   static bool needsVTTParameter(GlobalDecl GD);
  84
  85   /// getSubVTTIndex - Return the index of the sub-VTT for the base class of the
  86   /// given record decl.
  87   uint64_t getSubVTTIndex(const CXXRecordDecl *RD, BaseSubobject Base);
  88
  89   /// getSecondaryVirtualPointerIndex - Return the index in the VTT where the
  90   /// virtual pointer for the given subobject is located.
  91   uint64_t getSecondaryVirtualPointerIndex(const CXXRecordDecl *RD,
  92                                            BaseSubobject Base);
  93
  94   /// getAddressPoint - Get the address point of the given subobject in the
  95   /// class decl.
  96   uint64_t getAddressPoint(BaseSubobject Base, const CXXRecordDecl *RD);
  97
  98   /// GetAddrOfVTable - Get the address of the vtable for the given record decl.
  99   llvm::GlobalVariable *GetAddrOfVTable(const CXXRecordDecl *RD);
 100
 101   /// EmitVTableDefinition - Emit the definition of the given vtable.
 102   void EmitVTableDefinition(llvm::GlobalVariable *VTable,
 103                             llvm::GlobalVariable::LinkageTypes Linkage,
 104                             const CXXRecordDecl *RD);
 105
 106   /// GenerateConstructionVTable - Generate a construction vtable for the given
 107   /// base subobject.
 108   llvm::GlobalVariable *
 109   GenerateConstructionVTable(const CXXRecordDecl *RD, const BaseSubobject &Base,
 110                              bool BaseIsVirtual,
 111                              llvm::GlobalVariable::LinkageTypes Linkage,
 112                              VTableAddressPointsMapTy& AddressPoints);
 113
 114
 115   /// GetAddrOfVTable - Get the address of the VTT for the given record decl.
 116   llvm::GlobalVariable *GetAddrOfVTT(const CXXRecordDecl *RD);
 117
 118   /// EmitVTTDefinition - Emit the definition of the given vtable.
 119   void EmitVTTDefinition(llvm::GlobalVariable *VTT,
 120                          llvm::GlobalVariable::LinkageTypes Linkage,
 121                          const CXXRecordDecl *RD);
 122
 123   /// EmitThunks - Emit the associated thunks for the given global decl.
 124   void EmitThunks(GlobalDecl GD);
 125
 126   /// GenerateClassData - Generate all the class data required to be
 127   /// generated upon definition of a KeyFunction.  This includes the
 128   /// vtable, the RTTI data structure (if RTTI is enabled) and the VTT
 129   /// (if the class has virtual bases).
 130   void GenerateClassData(const CXXRecordDecl *RD);
 131
 132   bool isVTableExternal(const CXXRecordDecl *RD);
 133 };
 134
 135 } // end namespace CodeGen
 136 } // end namespace clang
 137 #endif