1 //===--- CGVTT.cpp - Emit LLVM Code for C++ VTTs --------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This contains code dealing with C++ code generation of VTTs (vtable tables).
12 //===----------------------------------------------------------------------===//
14 #include "CodeGenModule.h"
16 #include "clang/AST/RecordLayout.h"
17 #include "clang/AST/VTTBuilder.h"
18 using namespace clang;
19 using namespace CodeGen;
21 static llvm::Constant *
22 GetAddrOfVTTVTable(CodeGenVTables &CGVT, const CXXRecordDecl *MostDerivedClass,
23 const VTTVTable &VTable,
24 llvm::GlobalVariable::LinkageTypes Linkage,
25 llvm::DenseMap<BaseSubobject, uint64_t> &AddressPoints) {
26 if (VTable.getBase() == MostDerivedClass) {
27 assert(VTable.getBaseOffset().isZero() &&
28 "Most derived class vtable must have a zero offset!");
29 // This is a regular vtable.
30 return CGVT.GetAddrOfVTable(MostDerivedClass);
33 return CGVT.GenerateConstructionVTable(MostDerivedClass,
34 VTable.getBaseSubobject(),
41 CodeGenVTables::EmitVTTDefinition(llvm::GlobalVariable *VTT,
42 llvm::GlobalVariable::LinkageTypes Linkage,
43 const CXXRecordDecl *RD) {
44 VTTBuilder Builder(CGM.getContext(), RD, /*GenerateDefinition=*/true);
46 llvm::Type *Int8PtrTy = CGM.Int8PtrTy, *Int64Ty = CGM.Int64Ty;
47 llvm::ArrayType *ArrayType =
48 llvm::ArrayType::get(Int8PtrTy, Builder.getVTTComponents().size());
50 SmallVector<llvm::Constant *, 8> VTables;
51 SmallVector<VTableAddressPointsMapTy, 8> VTableAddressPoints;
52 for (const VTTVTable *i = Builder.getVTTVTables().begin(),
53 *e = Builder.getVTTVTables().end(); i != e; ++i) {
54 VTableAddressPoints.push_back(VTableAddressPointsMapTy());
55 VTables.push_back(GetAddrOfVTTVTable(*this, RD, *i, Linkage,
56 VTableAddressPoints.back()));
59 SmallVector<llvm::Constant *, 8> VTTComponents;
60 for (const VTTComponent *i = Builder.getVTTComponents().begin(),
61 *e = Builder.getVTTComponents().end(); i != e; ++i) {
62 const VTTVTable &VTTVT = Builder.getVTTVTables()[i->VTableIndex];
63 llvm::Constant *VTable = VTables[i->VTableIndex];
64 uint64_t AddressPoint;
65 if (VTTVT.getBase() == RD) {
66 // Just get the address point for the regular vtable.
67 AddressPoint = VTContext.getVTableLayout(RD)
68 .getAddressPoint(i->VTableBase);
69 assert(AddressPoint != 0 && "Did not find vtable address point!");
71 AddressPoint = VTableAddressPoints[i->VTableIndex].lookup(i->VTableBase);
72 assert(AddressPoint != 0 && "Did not find ctor vtable address point!");
75 llvm::Value *Idxs[] = {
76 llvm::ConstantInt::get(Int64Ty, 0),
77 llvm::ConstantInt::get(Int64Ty, AddressPoint)
80 llvm::Constant *Init =
81 llvm::ConstantExpr::getInBoundsGetElementPtr(VTable, Idxs);
83 Init = llvm::ConstantExpr::getBitCast(Init, Int8PtrTy);
85 VTTComponents.push_back(Init);
88 llvm::Constant *Init = llvm::ConstantArray::get(ArrayType, VTTComponents);
90 VTT->setInitializer(Init);
92 // Set the correct linkage.
93 VTT->setLinkage(Linkage);
95 // Set the right visibility.
96 CGM.setTypeVisibility(VTT, RD, CodeGenModule::TVK_ForVTT);
99 llvm::GlobalVariable *CodeGenVTables::GetAddrOfVTT(const CXXRecordDecl *RD) {
100 assert(RD->getNumVBases() && "Only classes with virtual bases need a VTT");
102 SmallString<256> OutName;
103 llvm::raw_svector_ostream Out(OutName);
104 CGM.getCXXABI().getMangleContext().mangleCXXVTT(RD, Out);
106 StringRef Name = OutName.str();
108 // This will also defer the definition of the VTT.
109 (void) GetAddrOfVTable(RD);
111 VTTBuilder Builder(CGM.getContext(), RD, /*GenerateDefinition=*/false);
113 llvm::ArrayType *ArrayType =
114 llvm::ArrayType::get(CGM.Int8PtrTy, Builder.getVTTComponents().size());
116 llvm::GlobalVariable *GV =
117 CGM.CreateOrReplaceCXXRuntimeVariable(Name, ArrayType,
118 llvm::GlobalValue::ExternalLinkage);
119 GV->setUnnamedAddr(true);
123 bool CodeGenVTables::needsVTTParameter(GlobalDecl GD) {
124 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
126 // We don't have any virtual bases, just return early.
127 if (!MD->getParent()->getNumVBases())
130 // Check if we have a base constructor.
131 if (isa<CXXConstructorDecl>(MD) && GD.getCtorType() == Ctor_Base)
134 // Check if we have a base destructor.
135 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
141 uint64_t CodeGenVTables::getSubVTTIndex(const CXXRecordDecl *RD,
142 BaseSubobject Base) {
143 BaseSubobjectPairTy ClassSubobjectPair(RD, Base);
145 SubVTTIndiciesMapTy::iterator I = SubVTTIndicies.find(ClassSubobjectPair);
146 if (I != SubVTTIndicies.end())
149 VTTBuilder Builder(CGM.getContext(), RD, /*GenerateDefinition=*/false);
151 for (llvm::DenseMap<BaseSubobject, uint64_t>::const_iterator I =
152 Builder.getSubVTTIndicies().begin(),
153 E = Builder.getSubVTTIndicies().end(); I != E; ++I) {
154 // Insert all indices.
155 BaseSubobjectPairTy ClassSubobjectPair(RD, I->first);
157 SubVTTIndicies.insert(std::make_pair(ClassSubobjectPair, I->second));
160 I = SubVTTIndicies.find(ClassSubobjectPair);
161 assert(I != SubVTTIndicies.end() && "Did not find index!");
167 CodeGenVTables::getSecondaryVirtualPointerIndex(const CXXRecordDecl *RD,
168 BaseSubobject Base) {
169 SecondaryVirtualPointerIndicesMapTy::iterator I =
170 SecondaryVirtualPointerIndices.find(std::make_pair(RD, Base));
172 if (I != SecondaryVirtualPointerIndices.end())
175 VTTBuilder Builder(CGM.getContext(), RD, /*GenerateDefinition=*/false);
177 // Insert all secondary vpointer indices.
178 for (llvm::DenseMap<BaseSubobject, uint64_t>::const_iterator I =
179 Builder.getSecondaryVirtualPointerIndices().begin(),
180 E = Builder.getSecondaryVirtualPointerIndices().end(); I != E; ++I) {
181 std::pair<const CXXRecordDecl *, BaseSubobject> Pair =
182 std::make_pair(RD, I->first);
184 SecondaryVirtualPointerIndices.insert(std::make_pair(Pair, I->second));
187 I = SecondaryVirtualPointerIndices.find(std::make_pair(RD, Base));
188 assert(I != SecondaryVirtualPointerIndices.end() && "Did not find index!");