blob: 65c412e0b03b2d519de813c2c36e625115c90434 [file] [log] [blame]
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001//===--- CGVtable.cpp - Emit LLVM Code for C++ vtables --------------------===//
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#include "CodeGenModule.h"
15#include "CodeGenFunction.h"
Anders Carlssonf942ee02009-11-27 20:47:55 +000016#include "clang/AST/CXXInheritance.h"
Anders Carlsson2bb27f52009-10-11 22:13:54 +000017#include "clang/AST/RecordLayout.h"
Anders Carlssond420a312009-11-26 19:32:45 +000018#include "llvm/ADT/DenseSet.h"
Zhongxing Xu1721ef72009-11-13 05:46:16 +000019#include <cstdio>
Anders Carlsson2bb27f52009-10-11 22:13:54 +000020
21using namespace clang;
22using namespace CodeGen;
23
Anders Carlssond59885022009-11-27 22:21:51 +000024namespace {
Benjamin Kramer337e3a52009-11-28 19:45:26 +000025class VtableBuilder {
Anders Carlsson2bb27f52009-10-11 22:13:54 +000026public:
27 /// Index_t - Vtable index type.
28 typedef uint64_t Index_t;
29private:
Anders Carlsson472404f2009-12-04 16:19:30 +000030
Anders Carlssonfe5f7d92009-12-06 01:09:21 +000031 // VtableComponents - The components of the vtable being built.
32 typedef llvm::SmallVector<llvm::Constant *, 64> VtableComponentsVectorTy;
33 VtableComponentsVectorTy VtableComponents;
34
Eli Friedman6c08ce72009-12-05 01:05:03 +000035 const bool BuildVtable;
36
Anders Carlsson2bb27f52009-10-11 22:13:54 +000037 llvm::Type *Ptr8Ty;
Anders Carlssonbad80eb2009-12-04 18:36:22 +000038
39 /// MostDerivedClass - The most derived class that this vtable is being
40 /// built for.
41 const CXXRecordDecl *MostDerivedClass;
42
Mike Stump83066c82009-11-13 01:54:23 +000043 /// LayoutClass - The most derived class used for virtual base layout
44 /// information.
45 const CXXRecordDecl *LayoutClass;
Mike Stump653d0b92009-11-13 02:13:54 +000046 /// LayoutOffset - The offset for Class in LayoutClass.
47 uint64_t LayoutOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +000048 /// BLayout - Layout for the most derived class that this vtable is being
49 /// built for.
50 const ASTRecordLayout &BLayout;
51 llvm::SmallSet<const CXXRecordDecl *, 32> IndirectPrimary;
52 llvm::SmallSet<const CXXRecordDecl *, 32> SeenVBase;
53 llvm::Constant *rtti;
54 llvm::LLVMContext &VMContext;
55 CodeGenModule &CGM; // Per-module state.
Anders Carlssonf2f31f42009-12-04 03:46:21 +000056
Anders Carlssonfb4dda42009-11-13 17:08:56 +000057 llvm::DenseMap<GlobalDecl, Index_t> VCall;
58 llvm::DenseMap<GlobalDecl, Index_t> VCallOffset;
Mike Stumpcd6f9ed2009-11-06 23:27:42 +000059 // This is the offset to the nearest virtual base
Anders Carlssonfb4dda42009-11-13 17:08:56 +000060 llvm::DenseMap<GlobalDecl, Index_t> NonVirtualOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +000061 llvm::DenseMap<const CXXRecordDecl *, Index_t> VBIndex;
Mike Stumpbb9ff052009-10-27 23:46:47 +000062
Anders Carlsson323bb042009-11-26 19:54:33 +000063 /// PureVirtualFunction - Points to __cxa_pure_virtual.
64 llvm::Constant *PureVirtualFn;
65
Anders Carlssona84b6e82009-12-04 02:01:07 +000066 /// VtableMethods - A data structure for keeping track of methods in a vtable.
67 /// Can add methods, override methods and iterate in vtable order.
68 class VtableMethods {
69 // MethodToIndexMap - Maps from a global decl to the index it has in the
70 // Methods vector.
71 llvm::DenseMap<GlobalDecl, uint64_t> MethodToIndexMap;
72
73 /// Methods - The methods, in vtable order.
74 typedef llvm::SmallVector<GlobalDecl, 16> MethodsVectorTy;
75 MethodsVectorTy Methods;
76
77 public:
78 /// AddMethod - Add a method to the vtable methods.
79 void AddMethod(GlobalDecl GD) {
80 assert(!MethodToIndexMap.count(GD) &&
81 "Method has already been added!");
82
83 MethodToIndexMap[GD] = Methods.size();
84 Methods.push_back(GD);
85 }
86
87 /// OverrideMethod - Replace a method with another.
88 void OverrideMethod(GlobalDecl OverriddenGD, GlobalDecl GD) {
89 llvm::DenseMap<GlobalDecl, uint64_t>::iterator i
90 = MethodToIndexMap.find(OverriddenGD);
91 assert(i != MethodToIndexMap.end() && "Did not find entry!");
92
93 // Get the index of the old decl.
94 uint64_t Index = i->second;
95
96 // Replace the old decl with the new decl.
97 Methods[Index] = GD;
98
Anders Carlssona84b6e82009-12-04 02:01:07 +000099 // And add the new.
100 MethodToIndexMap[GD] = Index;
101 }
102
Anders Carlsson7bb70762009-12-04 15:49:02 +0000103 /// getIndex - Gives the index of a passed in GlobalDecl. Returns false if
104 /// the index couldn't be found.
Benjamin Kramer62ab6162009-12-04 22:45:27 +0000105 bool getIndex(GlobalDecl GD, uint64_t &Index) const {
Anders Carlsson7bb70762009-12-04 15:49:02 +0000106 llvm::DenseMap<GlobalDecl, uint64_t>::const_iterator i
107 = MethodToIndexMap.find(GD);
Eli Friedman3d2e9de2009-12-04 08:34:14 +0000108
Anders Carlsson7bb70762009-12-04 15:49:02 +0000109 if (i == MethodToIndexMap.end())
110 return false;
Anders Carlssone6096362009-12-04 03:41:37 +0000111
Anders Carlsson7bb70762009-12-04 15:49:02 +0000112 Index = i->second;
113 return true;
Anders Carlssone6096362009-12-04 03:41:37 +0000114 }
115
Anders Carlssona84b6e82009-12-04 02:01:07 +0000116 MethodsVectorTy::size_type size() const {
117 return Methods.size();
118 }
119
120 void clear() {
121 MethodToIndexMap.clear();
122 Methods.clear();
123 }
124
Anders Carlssone6096362009-12-04 03:41:37 +0000125 GlobalDecl operator[](uint64_t Index) const {
Anders Carlssona84b6e82009-12-04 02:01:07 +0000126 return Methods[Index];
127 }
128 };
129
130 /// Methods - The vtable methods we're currently building.
131 VtableMethods Methods;
132
Anders Carlsson4c837d22009-12-04 02:26:15 +0000133 /// ThisAdjustments - For a given index in the vtable, contains the 'this'
134 /// pointer adjustment needed for a method.
135 typedef llvm::DenseMap<uint64_t, ThunkAdjustment> ThisAdjustmentsMapTy;
136 ThisAdjustmentsMapTy ThisAdjustments;
Anders Carlssond420a312009-11-26 19:32:45 +0000137
Anders Carlssonc521f952009-12-04 02:22:02 +0000138 /// BaseReturnTypes - Contains the base return types of methods who have been
139 /// overridden with methods whose return types require adjustment. Used for
140 /// generating covariant thunk information.
141 typedef llvm::DenseMap<uint64_t, CanQualType> BaseReturnTypesMapTy;
142 BaseReturnTypesMapTy BaseReturnTypes;
Anders Carlssond420a312009-11-26 19:32:45 +0000143
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000144 std::vector<Index_t> VCalls;
Mike Stump2cefe382009-11-12 20:47:57 +0000145
146 typedef std::pair<const CXXRecordDecl *, uint64_t> CtorVtable_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +0000147 // subAddressPoints - Used to hold the AddressPoints (offsets) into the built
148 // vtable for use in computing the initializers for the VTT.
149 llvm::DenseMap<CtorVtable_t, int64_t> &subAddressPoints;
Mike Stump2cefe382009-11-12 20:47:57 +0000150
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000151 typedef CXXRecordDecl::method_iterator method_iter;
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000152 const bool Extern;
153 const uint32_t LLVMPointerWidth;
154 Index_t extra;
Mike Stump37dbe962009-10-15 02:04:03 +0000155 typedef std::vector<std::pair<const CXXRecordDecl *, int64_t> > Path_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +0000156 static llvm::DenseMap<CtorVtable_t, int64_t>&
157 AllocAddressPoint(CodeGenModule &cgm, const CXXRecordDecl *l,
158 const CXXRecordDecl *c) {
159 CodeGenModule::AddrMap_t *&oref = cgm.AddressPoints[l];
160 if (oref == 0)
161 oref = new CodeGenModule::AddrMap_t;
162
163 llvm::DenseMap<CtorVtable_t, int64_t> *&ref = (*oref)[c];
164 if (ref == 0)
165 ref = new llvm::DenseMap<CtorVtable_t, int64_t>;
166 return *ref;
167 }
Anders Carlsson323bb042009-11-26 19:54:33 +0000168
169 /// getPureVirtualFn - Return the __cxa_pure_virtual function.
170 llvm::Constant* getPureVirtualFn() {
171 if (!PureVirtualFn) {
172 const llvm::FunctionType *Ty =
173 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext),
174 /*isVarArg=*/false);
175 PureVirtualFn = wrap(CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual"));
176 }
177
178 return PureVirtualFn;
179 }
180
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000181public:
Anders Carlssonbad80eb2009-12-04 18:36:22 +0000182 VtableBuilder(const CXXRecordDecl *MostDerivedClass,
Eli Friedman6c08ce72009-12-05 01:05:03 +0000183 const CXXRecordDecl *l, uint64_t lo, CodeGenModule &cgm,
184 bool build)
185 : BuildVtable(build), MostDerivedClass(MostDerivedClass), LayoutClass(l),
186 LayoutOffset(lo), BLayout(cgm.getContext().getASTRecordLayout(l)),
187 rtti(0), VMContext(cgm.getModule().getContext()),CGM(cgm),
188 PureVirtualFn(0),
Anders Carlssonbad80eb2009-12-04 18:36:22 +0000189 subAddressPoints(AllocAddressPoint(cgm, l, MostDerivedClass)),
Mike Stump1960b202009-11-19 00:49:05 +0000190 Extern(!l->isInAnonymousNamespace()),
Eli Friedman6c08ce72009-12-05 01:05:03 +0000191 LLVMPointerWidth(cgm.getContext().Target.getPointerWidth(0)) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000192 Ptr8Ty = llvm::PointerType::get(llvm::Type::getInt8Ty(VMContext), 0);
Eli Friedman6c08ce72009-12-05 01:05:03 +0000193 if (BuildVtable)
194 rtti = cgm.GenerateRTTIRef(MostDerivedClass);
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000195 }
196
Anders Carlssonfe5f7d92009-12-06 01:09:21 +0000197 // getVtableComponents - Returns a reference to the vtable components.
198 const VtableComponentsVectorTy &getVtableComponents() const {
199 return VtableComponents;
Anders Carlsson472404f2009-12-04 16:19:30 +0000200 }
201
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000202 llvm::DenseMap<const CXXRecordDecl *, Index_t> &getVBIndex()
203 { return VBIndex; }
204
205 llvm::Constant *wrap(Index_t i) {
206 llvm::Constant *m;
207 m = llvm::ConstantInt::get(llvm::Type::getInt64Ty(VMContext), i);
208 return llvm::ConstantExpr::getIntToPtr(m, Ptr8Ty);
209 }
210
211 llvm::Constant *wrap(llvm::Constant *m) {
212 return llvm::ConstantExpr::getBitCast(m, Ptr8Ty);
213 }
214
Mike Stump8a96d3a2009-12-02 19:50:41 +0000215#define D1(x)
216//#define D1(X) do { if (getenv("DEBUG")) { X; } } while (0)
Mike Stump75ce5732009-10-31 20:06:59 +0000217
218 void GenerateVBaseOffsets(const CXXRecordDecl *RD, uint64_t Offset,
Mike Stump28431212009-10-13 22:54:56 +0000219 bool updateVBIndex, Index_t current_vbindex) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000220 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
221 e = RD->bases_end(); i != e; ++i) {
222 const CXXRecordDecl *Base =
223 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump28431212009-10-13 22:54:56 +0000224 Index_t next_vbindex = current_vbindex;
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000225 if (i->isVirtual() && !SeenVBase.count(Base)) {
226 SeenVBase.insert(Base);
Mike Stump28431212009-10-13 22:54:56 +0000227 if (updateVBIndex) {
Mike Stump75ce5732009-10-31 20:06:59 +0000228 next_vbindex = (ssize_t)(-(VCalls.size()*LLVMPointerWidth/8)
Mike Stump28431212009-10-13 22:54:56 +0000229 - 3*LLVMPointerWidth/8);
230 VBIndex[Base] = next_vbindex;
231 }
Mike Stump75ce5732009-10-31 20:06:59 +0000232 int64_t BaseOffset = -(Offset/8) + BLayout.getVBaseClassOffset(Base)/8;
233 VCalls.push_back((0?700:0) + BaseOffset);
234 D1(printf(" vbase for %s at %d delta %d most derived %s\n",
235 Base->getNameAsCString(),
236 (int)-VCalls.size()-3, (int)BaseOffset,
237 Class->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000238 }
Mike Stump28431212009-10-13 22:54:56 +0000239 // We also record offsets for non-virtual bases to closest enclosing
240 // virtual base. We do this so that we don't have to search
241 // for the nearst virtual base class when generating thunks.
242 if (updateVBIndex && VBIndex.count(Base) == 0)
243 VBIndex[Base] = next_vbindex;
Mike Stump75ce5732009-10-31 20:06:59 +0000244 GenerateVBaseOffsets(Base, Offset, updateVBIndex, next_vbindex);
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000245 }
246 }
247
248 void StartNewTable() {
249 SeenVBase.clear();
250 }
251
Mike Stump8bccbfd2009-10-15 09:30:16 +0000252 Index_t getNVOffset_1(const CXXRecordDecl *D, const CXXRecordDecl *B,
253 Index_t Offset = 0) {
254
255 if (B == D)
256 return Offset;
257
258 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(D);
259 for (CXXRecordDecl::base_class_const_iterator i = D->bases_begin(),
260 e = D->bases_end(); i != e; ++i) {
261 const CXXRecordDecl *Base =
262 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
263 int64_t BaseOffset = 0;
264 if (!i->isVirtual())
265 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
266 int64_t o = getNVOffset_1(Base, B, BaseOffset);
267 if (o >= 0)
268 return o;
269 }
270
271 return -1;
272 }
273
274 /// getNVOffset - Returns the non-virtual offset for the given (B) base of the
275 /// derived class D.
276 Index_t getNVOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +0000277 qD = qD->getPointeeType();
278 qB = qB->getPointeeType();
Mike Stump8bccbfd2009-10-15 09:30:16 +0000279 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
280 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
281 int64_t o = getNVOffset_1(D, B);
282 if (o >= 0)
283 return o;
284
285 assert(false && "FIXME: non-virtual base not found");
286 return 0;
287 }
288
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000289 /// getVbaseOffset - Returns the index into the vtable for the virtual base
290 /// offset for the given (B) virtual base of the derived class D.
291 Index_t getVbaseOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +0000292 qD = qD->getPointeeType();
293 qB = qB->getPointeeType();
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000294 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
295 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
Anders Carlssonbad80eb2009-12-04 18:36:22 +0000296 if (D != MostDerivedClass)
Eli Friedman03aa2f12009-11-30 01:19:33 +0000297 return CGM.getVtableInfo().getVirtualBaseOffsetIndex(D, B);
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000298 llvm::DenseMap<const CXXRecordDecl *, Index_t>::iterator i;
299 i = VBIndex.find(B);
300 if (i != VBIndex.end())
301 return i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000302
Mike Stump28431212009-10-13 22:54:56 +0000303 assert(false && "FIXME: Base not found");
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000304 return 0;
305 }
306
Eli Friedman81fb0d22009-12-04 08:40:51 +0000307 bool OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
308 Index_t OverrideOffset, Index_t Offset,
309 int64_t CurrentVBaseOffset);
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000310
Anders Carlsson495634e2009-12-04 02:39:04 +0000311 /// AppendMethods - Append the current methods to the vtable.
Anders Carlssonddf42c82009-12-04 02:56:03 +0000312 void AppendMethodsToVtable();
Anders Carlsson495634e2009-12-04 02:39:04 +0000313
Anders Carlssonfb4dda42009-11-13 17:08:56 +0000314 llvm::Constant *WrapAddrOf(GlobalDecl GD) {
315 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
316
Anders Carlsson64457732009-11-24 05:08:52 +0000317 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVtable(MD);
Mike Stump18e8b472009-10-27 23:36:26 +0000318
Mike Stumpcdeb8002009-12-03 16:55:20 +0000319 return wrap(CGM.GetAddrOfFunction(GD, Ty));
Mike Stump18e8b472009-10-27 23:36:26 +0000320 }
321
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000322 void OverrideMethods(Path_t *Path, bool MorallyVirtual, int64_t Offset,
323 int64_t CurrentVBaseOffset) {
Mike Stump37dbe962009-10-15 02:04:03 +0000324 for (Path_t::reverse_iterator i = Path->rbegin(),
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000325 e = Path->rend(); i != e; ++i) {
326 const CXXRecordDecl *RD = i->first;
Mike Stump8bccbfd2009-10-15 09:30:16 +0000327 int64_t OverrideOffset = i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000328 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
329 ++mi) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +0000330 const CXXMethodDecl *MD = *mi;
331
332 if (!MD->isVirtual())
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000333 continue;
334
Anders Carlssonfb4dda42009-11-13 17:08:56 +0000335 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
336 // Override both the complete and the deleting destructor.
337 GlobalDecl CompDtor(DD, Dtor_Complete);
Eli Friedman81fb0d22009-12-04 08:40:51 +0000338 OverrideMethod(CompDtor, MorallyVirtual, OverrideOffset, Offset,
339 CurrentVBaseOffset);
340
Anders Carlssonfb4dda42009-11-13 17:08:56 +0000341 GlobalDecl DeletingDtor(DD, Dtor_Deleting);
Eli Friedman81fb0d22009-12-04 08:40:51 +0000342 OverrideMethod(DeletingDtor, MorallyVirtual, OverrideOffset, Offset,
343 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +0000344 } else {
Eli Friedman81fb0d22009-12-04 08:40:51 +0000345 OverrideMethod(MD, MorallyVirtual, OverrideOffset, Offset,
346 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +0000347 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000348 }
349 }
350 }
351
Anders Carlssonfb4dda42009-11-13 17:08:56 +0000352 void AddMethod(const GlobalDecl GD, bool MorallyVirtual, Index_t Offset,
Eli Friedman03aa2f12009-11-30 01:19:33 +0000353 int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000354 // If we can find a previously allocated slot for this, reuse it.
Eli Friedman81fb0d22009-12-04 08:40:51 +0000355 if (OverrideMethod(GD, MorallyVirtual, Offset, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000356 CurrentVBaseOffset))
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000357 return;
358
Anders Carlssoncdf18982009-12-04 02:08:24 +0000359 // We didn't find an entry in the vtable that we could use, add a new
360 // entry.
361 Methods.AddMethod(GD);
362
Mike Stumpc5a332c2009-11-13 23:45:53 +0000363 D1(printf(" vfn for %s at %d\n", MD->getNameAsString().c_str(),
364 (int)Index[GD]));
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000365 if (MorallyVirtual) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +0000366 VCallOffset[GD] = Offset/8;
367 Index_t &idx = VCall[GD];
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000368 // Allocate the first one, after that, we reuse the previous one.
369 if (idx == 0) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +0000370 NonVirtualOffset[GD] = CurrentVBaseOffset/8 - Offset/8;
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000371 idx = VCalls.size()+1;
372 VCalls.push_back(0);
Mike Stump75ce5732009-10-31 20:06:59 +0000373 D1(printf(" vcall for %s at %d with delta %d\n",
Mike Stumpc5a332c2009-11-13 23:45:53 +0000374 MD->getNameAsString().c_str(), (int)-VCalls.size()-3, 0));
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000375 }
376 }
377 }
378
379 void AddMethods(const CXXRecordDecl *RD, bool MorallyVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +0000380 Index_t Offset, int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000381 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
Anders Carlssonfb4dda42009-11-13 17:08:56 +0000382 ++mi) {
383 const CXXMethodDecl *MD = *mi;
384 if (!MD->isVirtual())
385 continue;
386
387 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
388 // For destructors, add both the complete and the deleting destructor
389 // to the vtable.
390 AddMethod(GlobalDecl(DD, Dtor_Complete), MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000391 CurrentVBaseOffset);
Eli Friedman03aa2f12009-11-30 01:19:33 +0000392 AddMethod(GlobalDecl(DD, Dtor_Deleting), MorallyVirtual, Offset,
393 CurrentVBaseOffset);
394 } else
395 AddMethod(MD, MorallyVirtual, Offset, CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +0000396 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000397 }
398
399 void NonVirtualBases(const CXXRecordDecl *RD, const ASTRecordLayout &Layout,
400 const CXXRecordDecl *PrimaryBase,
401 bool PrimaryBaseWasVirtual, bool MorallyVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000402 int64_t Offset, int64_t CurrentVBaseOffset,
403 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +0000404 Path->push_back(std::make_pair(RD, Offset));
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000405 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
406 e = RD->bases_end(); i != e; ++i) {
407 if (i->isVirtual())
408 continue;
409 const CXXRecordDecl *Base =
410 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
411 if (Base != PrimaryBase || PrimaryBaseWasVirtual) {
412 uint64_t o = Offset + Layout.getBaseClassOffset(Base);
413 StartNewTable();
Mike Stump653d0b92009-11-13 02:13:54 +0000414 GenerateVtableForBase(Base, o, MorallyVirtual, false,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000415 CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000416 }
417 }
Mike Stump37dbe962009-10-15 02:04:03 +0000418 Path->pop_back();
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000419 }
420
Mike Stumpb21c4ee2009-10-14 18:14:51 +0000421// #define D(X) do { X; } while (0)
422#define D(X)
423
424 void insertVCalls(int InsertionPoint) {
Mike Stump75ce5732009-10-31 20:06:59 +0000425 D1(printf("============= combining vbase/vcall\n"));
Mike Stumpb21c4ee2009-10-14 18:14:51 +0000426 D(VCalls.insert(VCalls.begin(), 673));
427 D(VCalls.push_back(672));
Eli Friedman6c08ce72009-12-05 01:05:03 +0000428
Anders Carlssonfe5f7d92009-12-06 01:09:21 +0000429 VtableComponents.insert(VtableComponents.begin() + InsertionPoint,
430 VCalls.size(), 0);
Eli Friedman6c08ce72009-12-05 01:05:03 +0000431 if (BuildVtable) {
432 // The vcalls come first...
433 for (std::vector<Index_t>::reverse_iterator i = VCalls.rbegin(),
434 e = VCalls.rend();
435 i != e; ++i)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +0000436 VtableComponents[InsertionPoint++] = wrap((0?600:0) + *i);
Eli Friedman6c08ce72009-12-05 01:05:03 +0000437 }
Mike Stumpb21c4ee2009-10-14 18:14:51 +0000438 VCalls.clear();
Mike Stump9f23a142009-11-10 02:30:51 +0000439 VCall.clear();
Mike Stumpb21c4ee2009-10-14 18:14:51 +0000440 }
441
Mike Stump559387f2009-11-13 23:13:20 +0000442 void AddAddressPoints(const CXXRecordDecl *RD, uint64_t Offset,
443 Index_t AddressPoint) {
444 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
445 RD->getNameAsCString(), Class->getNameAsCString(),
446 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +0000447 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +0000448
449 // Now also add the address point for all our primary bases.
450 while (1) {
451 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
452 RD = Layout.getPrimaryBase();
453 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
454 // FIXME: Double check this.
455 if (RD == 0)
456 break;
457 if (PrimaryBaseWasVirtual &&
458 BLayout.getVBaseClassOffset(RD) != Offset)
459 break;
460 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
461 RD->getNameAsCString(), Class->getNameAsCString(),
462 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +0000463 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +0000464 }
465 }
466
467
Eli Friedmanb05eb962009-12-04 03:54:56 +0000468 Index_t FinishGenerateVtable(const CXXRecordDecl *RD,
469 const ASTRecordLayout &Layout,
470 const CXXRecordDecl *PrimaryBase,
471 bool PrimaryBaseWasVirtual,
472 bool MorallyVirtual, int64_t Offset,
473 bool ForVirtualBase, int64_t CurrentVBaseOffset,
474 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +0000475 bool alloc = false;
476 if (Path == 0) {
477 alloc = true;
478 Path = new Path_t;
479 }
480
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000481 StartNewTable();
482 extra = 0;
Mike Stumpb21c4ee2009-10-14 18:14:51 +0000483 bool DeferVCalls = MorallyVirtual || ForVirtualBase;
Anders Carlssonfe5f7d92009-12-06 01:09:21 +0000484 int VCallInsertionPoint = VtableComponents.size();
Mike Stumpb21c4ee2009-10-14 18:14:51 +0000485 if (!DeferVCalls) {
486 insertVCalls(VCallInsertionPoint);
Mike Stump8bccbfd2009-10-15 09:30:16 +0000487 } else
488 // FIXME: just for extra, or for all uses of VCalls.size post this?
489 extra = -VCalls.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000490
Anders Carlsson472404f2009-12-04 16:19:30 +0000491 // Add the offset to top.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +0000492 VtableComponents.push_back(BuildVtable ? wrap(-((Offset-LayoutOffset)/8)) : 0);
Anders Carlsson472404f2009-12-04 16:19:30 +0000493
494 // Add the RTTI information.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +0000495 VtableComponents.push_back(rtti);
Anders Carlsson472404f2009-12-04 16:19:30 +0000496
Anders Carlssonfe5f7d92009-12-06 01:09:21 +0000497 Index_t AddressPoint = VtableComponents.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000498
Anders Carlssonddf42c82009-12-04 02:56:03 +0000499 AppendMethodsToVtable();
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000500
501 // and then the non-virtual bases.
502 NonVirtualBases(RD, Layout, PrimaryBase, PrimaryBaseWasVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000503 MorallyVirtual, Offset, CurrentVBaseOffset, Path);
Mike Stumpb21c4ee2009-10-14 18:14:51 +0000504
505 if (ForVirtualBase) {
Mike Stump2cefe382009-11-12 20:47:57 +0000506 // FIXME: We're adding to VCalls in callers, we need to do the overrides
507 // in the inner part, so that we know the complete set of vcalls during
508 // the build and don't have to insert into methods. Saving out the
509 // AddressPoint here, would need to be fixed, if we didn't do that. Also
510 // retroactively adding vcalls for overrides later wind up in the wrong
511 // place, the vcall slot has to be alloted during the walk of the base
512 // when the function is first introduces.
Mike Stumpb21c4ee2009-10-14 18:14:51 +0000513 AddressPoint += VCalls.size();
Mike Stump2cefe382009-11-12 20:47:57 +0000514 insertVCalls(VCallInsertionPoint);
Mike Stumpb21c4ee2009-10-14 18:14:51 +0000515 }
516
Mike Stump559387f2009-11-13 23:13:20 +0000517 AddAddressPoints(RD, Offset, AddressPoint);
Mike Stump2cefe382009-11-12 20:47:57 +0000518
Mike Stump37dbe962009-10-15 02:04:03 +0000519 if (alloc) {
520 delete Path;
521 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000522 return AddressPoint;
523 }
524
Mike Stump75ce5732009-10-31 20:06:59 +0000525 void Primaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
526 bool updateVBIndex, Index_t current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +0000527 int64_t CurrentVBaseOffset) {
Mike Stump75ce5732009-10-31 20:06:59 +0000528 if (!RD->isDynamicClass())
529 return;
530
531 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
532 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
533 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
534
535 // vtables are composed from the chain of primaries.
Eli Friedman65d87222009-12-04 08:52:11 +0000536 if (PrimaryBase && !PrimaryBaseWasVirtual) {
Mike Stump75ce5732009-10-31 20:06:59 +0000537 D1(printf(" doing primaries for %s most derived %s\n",
538 RD->getNameAsCString(), Class->getNameAsCString()));
Eli Friedman65d87222009-12-04 08:52:11 +0000539 Primaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
540 updateVBIndex, current_vbindex, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +0000541 }
542
543 D1(printf(" doing vcall entries for %s most derived %s\n",
544 RD->getNameAsCString(), Class->getNameAsCString()));
545
546 // And add the virtuals for the class to the primary vtable.
Eli Friedman03aa2f12009-11-30 01:19:33 +0000547 AddMethods(RD, MorallyVirtual, Offset, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +0000548 }
549
550 void VBPrimaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
551 bool updateVBIndex, Index_t current_vbindex,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000552 bool RDisVirtualBase, int64_t CurrentVBaseOffset,
Eli Friedman03aa2f12009-11-30 01:19:33 +0000553 bool bottom) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000554 if (!RD->isDynamicClass())
555 return;
556
557 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
558 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
559 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
560
561 // vtables are composed from the chain of primaries.
562 if (PrimaryBase) {
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000563 int BaseCurrentVBaseOffset = CurrentVBaseOffset;
564 if (PrimaryBaseWasVirtual) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000565 IndirectPrimary.insert(PrimaryBase);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000566 BaseCurrentVBaseOffset = BLayout.getVBaseClassOffset(PrimaryBase);
567 }
Mike Stump75ce5732009-10-31 20:06:59 +0000568
569 D1(printf(" doing primaries for %s most derived %s\n",
570 RD->getNameAsCString(), Class->getNameAsCString()));
571
572 VBPrimaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000573 updateVBIndex, current_vbindex, PrimaryBaseWasVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +0000574 BaseCurrentVBaseOffset, false);
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000575 }
576
Mike Stump75ce5732009-10-31 20:06:59 +0000577 D1(printf(" doing vbase entries for %s most derived %s\n",
578 RD->getNameAsCString(), Class->getNameAsCString()));
579 GenerateVBaseOffsets(RD, Offset, updateVBIndex, current_vbindex);
580
581 if (RDisVirtualBase || bottom) {
582 Primaries(RD, MorallyVirtual, Offset, updateVBIndex, current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +0000583 CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +0000584 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000585 }
586
Mike Stump653d0b92009-11-13 02:13:54 +0000587 int64_t GenerateVtableForBase(const CXXRecordDecl *RD, int64_t Offset = 0,
588 bool MorallyVirtual = false,
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000589 bool ForVirtualBase = false,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000590 int CurrentVBaseOffset = 0,
Mike Stump37dbe962009-10-15 02:04:03 +0000591 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000592 if (!RD->isDynamicClass())
593 return 0;
594
Mike Stumpfa818082009-11-13 02:35:38 +0000595 // Construction vtable don't need parts that have no virtual bases and
596 // aren't morally virtual.
Anders Carlssonbad80eb2009-12-04 18:36:22 +0000597 if ((LayoutClass != MostDerivedClass) &&
598 RD->getNumVBases() == 0 && !MorallyVirtual)
Mike Stumpfa818082009-11-13 02:35:38 +0000599 return 0;
600
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000601 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
602 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
603 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
604
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000605 extra = 0;
Mike Stump75ce5732009-10-31 20:06:59 +0000606 D1(printf("building entries for base %s most derived %s\n",
607 RD->getNameAsCString(), Class->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000608
Mike Stump75ce5732009-10-31 20:06:59 +0000609 if (ForVirtualBase)
610 extra = VCalls.size();
611
612 VBPrimaries(RD, MorallyVirtual, Offset, !ForVirtualBase, 0, ForVirtualBase,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000613 CurrentVBaseOffset, true);
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000614
615 if (Path)
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000616 OverrideMethods(Path, MorallyVirtual, Offset, CurrentVBaseOffset);
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000617
Eli Friedmanb05eb962009-12-04 03:54:56 +0000618 return FinishGenerateVtable(RD, Layout, PrimaryBase, PrimaryBaseWasVirtual,
619 MorallyVirtual, Offset, ForVirtualBase,
620 CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000621 }
622
623 void GenerateVtableForVBases(const CXXRecordDecl *RD,
624 int64_t Offset = 0,
Mike Stump37dbe962009-10-15 02:04:03 +0000625 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000626 bool alloc = false;
627 if (Path == 0) {
628 alloc = true;
Mike Stump37dbe962009-10-15 02:04:03 +0000629 Path = new Path_t;
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000630 }
631 // FIXME: We also need to override using all paths to a virtual base,
632 // right now, we just process the first path
633 Path->push_back(std::make_pair(RD, Offset));
634 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
635 e = RD->bases_end(); i != e; ++i) {
636 const CXXRecordDecl *Base =
637 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
638 if (i->isVirtual() && !IndirectPrimary.count(Base)) {
639 // Mark it so we don't output it twice.
640 IndirectPrimary.insert(Base);
641 StartNewTable();
Mike Stumpb21c4ee2009-10-14 18:14:51 +0000642 VCall.clear();
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000643 int64_t BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000644 int64_t CurrentVBaseOffset = BaseOffset;
Mike Stump75ce5732009-10-31 20:06:59 +0000645 D1(printf("vtable %s virtual base %s\n",
646 Class->getNameAsCString(), Base->getNameAsCString()));
Mike Stump653d0b92009-11-13 02:13:54 +0000647 GenerateVtableForBase(Base, BaseOffset, true, true, CurrentVBaseOffset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +0000648 Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000649 }
Mike Stump2cefe382009-11-12 20:47:57 +0000650 int64_t BaseOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000651 if (i->isVirtual())
652 BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stump2cefe382009-11-12 20:47:57 +0000653 else {
654 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
655 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
656 }
657
Mike Stump37dbe962009-10-15 02:04:03 +0000658 if (Base->getNumVBases()) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000659 GenerateVtableForVBases(Base, BaseOffset, Path);
Mike Stump37dbe962009-10-15 02:04:03 +0000660 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +0000661 }
662 Path->pop_back();
663 if (alloc)
664 delete Path;
665 }
666};
Anders Carlssonca1bf682009-12-03 01:54:02 +0000667} // end anonymous namespace
668
Anders Carlsson657f1392009-12-03 02:32:59 +0000669/// TypeConversionRequiresAdjustment - Returns whether conversion from a
670/// derived type to a base type requires adjustment.
671static bool
672TypeConversionRequiresAdjustment(ASTContext &Ctx,
673 const CXXRecordDecl *DerivedDecl,
674 const CXXRecordDecl *BaseDecl) {
675 CXXBasePaths Paths(/*FindAmbiguities=*/false,
676 /*RecordPaths=*/true, /*DetectVirtual=*/true);
677 if (!const_cast<CXXRecordDecl *>(DerivedDecl)->
678 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseDecl), Paths)) {
679 assert(false && "Class must be derived from the passed in base class!");
680 return false;
681 }
682
683 // If we found a virtual base we always want to require adjustment.
684 if (Paths.getDetectedVirtual())
685 return true;
686
687 const CXXBasePath &Path = Paths.front();
688
689 for (size_t Start = 0, End = Path.size(); Start != End; ++Start) {
690 const CXXBasePathElement &Element = Path[Start];
691
692 // Check the base class offset.
693 const ASTRecordLayout &Layout = Ctx.getASTRecordLayout(Element.Class);
694
695 const RecordType *BaseType = Element.Base->getType()->getAs<RecordType>();
696 const CXXRecordDecl *Base = cast<CXXRecordDecl>(BaseType->getDecl());
697
698 if (Layout.getBaseClassOffset(Base) != 0) {
699 // This requires an adjustment.
700 return true;
701 }
702 }
703
704 return false;
705}
706
707static bool
708TypeConversionRequiresAdjustment(ASTContext &Ctx,
709 QualType DerivedType, QualType BaseType) {
710 // Canonicalize the types.
711 QualType CanDerivedType = Ctx.getCanonicalType(DerivedType);
712 QualType CanBaseType = Ctx.getCanonicalType(BaseType);
713
714 assert(CanDerivedType->getTypeClass() == CanBaseType->getTypeClass() &&
715 "Types must have same type class!");
716
717 if (CanDerivedType == CanBaseType) {
718 // No adjustment needed.
719 return false;
720 }
721
722 if (const ReferenceType *RT = dyn_cast<ReferenceType>(CanDerivedType)) {
723 CanDerivedType = RT->getPointeeType();
724 CanBaseType = cast<ReferenceType>(CanBaseType)->getPointeeType();
725 } else if (const PointerType *PT = dyn_cast<PointerType>(CanDerivedType)) {
726 CanDerivedType = PT->getPointeeType();
727 CanBaseType = cast<PointerType>(CanBaseType)->getPointeeType();
728 } else {
729 assert(false && "Unexpected return type!");
730 }
731
732 if (CanDerivedType == CanBaseType) {
733 // No adjustment needed.
734 return false;
735 }
736
737 const CXXRecordDecl *DerivedDecl =
Anders Carlssondabfa3c2009-12-03 03:28:24 +0000738 cast<CXXRecordDecl>(cast<RecordType>(CanDerivedType)->getDecl());
Anders Carlsson657f1392009-12-03 02:32:59 +0000739
740 const CXXRecordDecl *BaseDecl =
741 cast<CXXRecordDecl>(cast<RecordType>(CanBaseType)->getDecl());
742
743 return TypeConversionRequiresAdjustment(Ctx, DerivedDecl, BaseDecl);
744}
745
Eli Friedman81fb0d22009-12-04 08:40:51 +0000746bool VtableBuilder::OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
747 Index_t OverrideOffset, Index_t Offset,
748 int64_t CurrentVBaseOffset) {
Anders Carlssonca1bf682009-12-03 01:54:02 +0000749 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
750
751 const bool isPure = MD->isPure();
Anders Carlsson21bbc1e2009-12-05 17:04:47 +0000752
Anders Carlssonca1bf682009-12-03 01:54:02 +0000753 // FIXME: Should OverrideOffset's be Offset?
754
Anders Carlsson21bbc1e2009-12-05 17:04:47 +0000755 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
756 e = MD->end_overridden_methods(); mi != e; ++mi) {
Anders Carlssonca1bf682009-12-03 01:54:02 +0000757 GlobalDecl OGD;
758
Anders Carlssonf3935b42009-12-04 05:51:56 +0000759 const CXXMethodDecl *OMD = *mi;
Anders Carlssonca1bf682009-12-03 01:54:02 +0000760 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(OMD))
761 OGD = GlobalDecl(DD, GD.getDtorType());
762 else
763 OGD = OMD;
Eli Friedman3d2e9de2009-12-04 08:34:14 +0000764
765 // FIXME: Explain why this is necessary!
Anders Carlsson7bb70762009-12-04 15:49:02 +0000766 uint64_t Index;
767 if (!Methods.getIndex(OGD, Index))
Eli Friedman3d2e9de2009-12-04 08:34:14 +0000768 continue;
769
Eli Friedman3d2e9de2009-12-04 08:34:14 +0000770 QualType ReturnType =
771 MD->getType()->getAs<FunctionType>()->getResultType();
772 QualType OverriddenReturnType =
773 OMD->getType()->getAs<FunctionType>()->getResultType();
Anders Carlssonca1bf682009-12-03 01:54:02 +0000774
Eli Friedman3d2e9de2009-12-04 08:34:14 +0000775 // Check if we need a return type adjustment.
776 if (TypeConversionRequiresAdjustment(CGM.getContext(), ReturnType,
777 OverriddenReturnType)) {
778 CanQualType &BaseReturnType = BaseReturnTypes[Index];
Anders Carlssonca1bf682009-12-03 01:54:02 +0000779
Eli Friedman3d2e9de2009-12-04 08:34:14 +0000780 // Get the canonical return type.
781 CanQualType CanReturnType =
782 CGM.getContext().getCanonicalType(ReturnType);
Anders Carlssone6096362009-12-04 03:41:37 +0000783
Eli Friedman3d2e9de2009-12-04 08:34:14 +0000784 // Insert the base return type.
785 if (BaseReturnType.isNull())
786 BaseReturnType =
787 CGM.getContext().getCanonicalType(OverriddenReturnType);
788 }
Anders Carlssona93e9802009-12-04 03:52:52 +0000789
Eli Friedman3d2e9de2009-12-04 08:34:14 +0000790 Methods.OverrideMethod(OGD, GD);
791
Eli Friedman3d2e9de2009-12-04 08:34:14 +0000792 ThisAdjustments.erase(Index);
793 if (MorallyVirtual || VCall.count(OGD)) {
794 Index_t &idx = VCall[OGD];
795 if (idx == 0) {
796 NonVirtualOffset[GD] = -OverrideOffset/8 + CurrentVBaseOffset/8;
797 VCallOffset[GD] = OverrideOffset/8;
798 idx = VCalls.size()+1;
799 VCalls.push_back(0);
800 D1(printf(" vcall for %s at %d with delta %d most derived %s\n",
801 MD->getNameAsString().c_str(), (int)-idx-3,
802 (int)VCalls[idx-1], Class->getNameAsCString()));
803 } else {
804 NonVirtualOffset[GD] = NonVirtualOffset[OGD];
805 VCallOffset[GD] = VCallOffset[OGD];
806 VCalls[idx-1] = -VCallOffset[OGD] + OverrideOffset/8;
807 D1(printf(" vcall patch for %s at %d with delta %d most derived %s\n",
808 MD->getNameAsString().c_str(), (int)-idx-3,
809 (int)VCalls[idx-1], Class->getNameAsCString()));
810 }
811 VCall[GD] = idx;
812 int64_t NonVirtualAdjustment = NonVirtualOffset[GD];
813 int64_t VirtualAdjustment =
814 -((idx + extra + 2) * LLVMPointerWidth / 8);
Anders Carlsson657f1392009-12-03 02:32:59 +0000815
Eli Friedman3d2e9de2009-12-04 08:34:14 +0000816 // Optimize out virtual adjustments of 0.
817 if (VCalls[idx-1] == 0)
818 VirtualAdjustment = 0;
Anders Carlsson657f1392009-12-03 02:32:59 +0000819
Eli Friedman3d2e9de2009-12-04 08:34:14 +0000820 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment,
821 VirtualAdjustment);
Anders Carlsson2ca285f2009-12-03 02:22:59 +0000822
Eli Friedman3d2e9de2009-12-04 08:34:14 +0000823 if (!isPure && !ThisAdjustment.isEmpty())
824 ThisAdjustments[Index] = ThisAdjustment;
Anders Carlssonca1bf682009-12-03 01:54:02 +0000825 return true;
826 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +0000827
828 // FIXME: finish off
829 int64_t NonVirtualAdjustment = VCallOffset[OGD] - OverrideOffset/8;
830
831 if (NonVirtualAdjustment) {
832 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment, 0);
833
834 if (!isPure)
835 ThisAdjustments[Index] = ThisAdjustment;
836 }
837 return true;
Anders Carlssonca1bf682009-12-03 01:54:02 +0000838 }
839
840 return false;
Anders Carlssond59885022009-11-27 22:21:51 +0000841}
842
Anders Carlssonddf42c82009-12-04 02:56:03 +0000843void VtableBuilder::AppendMethodsToVtable() {
Eli Friedman6c08ce72009-12-05 01:05:03 +0000844 if (!BuildVtable) {
Anders Carlssonfe5f7d92009-12-06 01:09:21 +0000845 VtableComponents.insert(VtableComponents.end(), Methods.size(),
846 (llvm::Constant *)0);
Eli Friedman6c08ce72009-12-05 01:05:03 +0000847 ThisAdjustments.clear();
848 BaseReturnTypes.clear();
849 Methods.clear();
850 return;
851 }
852
Anders Carlsson472404f2009-12-04 16:19:30 +0000853 // Reserve room in the vtable for our new methods.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +0000854 VtableComponents.reserve(VtableComponents.size() + Methods.size());
Anders Carlssonb07567c2009-12-04 03:07:26 +0000855
Anders Carlsson86809cd2009-12-04 02:43:50 +0000856 for (unsigned i = 0, e = Methods.size(); i != e; ++i) {
857 GlobalDecl GD = Methods[i];
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +0000858 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
859
860 // Get the 'this' pointer adjustment.
Anders Carlsson86809cd2009-12-04 02:43:50 +0000861 ThunkAdjustment ThisAdjustment = ThisAdjustments.lookup(i);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +0000862
863 // Construct the return type adjustment.
864 ThunkAdjustment ReturnAdjustment;
865
866 QualType BaseReturnType = BaseReturnTypes.lookup(i);
867 if (!BaseReturnType.isNull() && !MD->isPure()) {
868 QualType DerivedType =
869 MD->getType()->getAs<FunctionType>()->getResultType();
870
871 int64_t NonVirtualAdjustment =
872 getNVOffset(BaseReturnType, DerivedType) / 8;
873
874 int64_t VirtualAdjustment =
875 getVbaseOffset(BaseReturnType, DerivedType);
876
877 ReturnAdjustment = ThunkAdjustment(NonVirtualAdjustment,
878 VirtualAdjustment);
879 }
880
Anders Carlsson50f14742009-12-04 03:06:03 +0000881 llvm::Constant *Method = 0;
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +0000882 if (!ReturnAdjustment.isEmpty()) {
883 // Build a covariant thunk.
884 CovariantThunkAdjustment Adjustment(ThisAdjustment, ReturnAdjustment);
Anders Carlsson50f14742009-12-04 03:06:03 +0000885 Method = CGM.BuildCovariantThunk(MD, Extern, Adjustment);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +0000886 } else if (!ThisAdjustment.isEmpty()) {
887 // Build a "regular" thunk.
Anders Carlsson50f14742009-12-04 03:06:03 +0000888 Method = CGM.BuildThunk(GD, Extern, ThisAdjustment);
Anders Carlssonddf42c82009-12-04 02:56:03 +0000889 } else if (MD->isPure()) {
890 // We have a pure virtual method.
Anders Carlsson50f14742009-12-04 03:06:03 +0000891 Method = getPureVirtualFn();
892 } else {
893 // We have a good old regular method.
894 Method = WrapAddrOf(GD);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +0000895 }
Anders Carlsson50f14742009-12-04 03:06:03 +0000896
897 // Add the method to the vtable.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +0000898 VtableComponents.push_back(Method);
Anders Carlsson86809cd2009-12-04 02:43:50 +0000899 }
900
Anders Carlsson50f14742009-12-04 03:06:03 +0000901
Anders Carlsson86809cd2009-12-04 02:43:50 +0000902 ThisAdjustments.clear();
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +0000903 BaseReturnTypes.clear();
Anders Carlsson86809cd2009-12-04 02:43:50 +0000904
Anders Carlsson495634e2009-12-04 02:39:04 +0000905 Methods.clear();
Anders Carlsson495634e2009-12-04 02:39:04 +0000906}
907
Anders Carlssonf942ee02009-11-27 20:47:55 +0000908void CGVtableInfo::ComputeMethodVtableIndices(const CXXRecordDecl *RD) {
909
910 // Itanium C++ ABI 2.5.2:
911 // The order of the virtual function pointers in a virtual table is the
912 // order of declaration of the corresponding member functions in the class.
913 //
914 // There is an entry for any virtual function declared in a class,
915 // whether it is a new function or overrides a base class function,
916 // unless it overrides a function from the primary base, and conversion
917 // between their return types does not require an adjustment.
918
919 int64_t CurrentIndex = 0;
920
921 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
922 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
923
924 if (PrimaryBase) {
Anders Carlssonc920fa22009-11-30 19:43:26 +0000925 assert(PrimaryBase->isDefinition() &&
926 "Should have the definition decl of the primary base!");
Anders Carlssonf942ee02009-11-27 20:47:55 +0000927
928 // Since the record decl shares its vtable pointer with the primary base
929 // we need to start counting at the end of the primary base's vtable.
930 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
931 }
932
933 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
934
935 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
936 e = RD->method_end(); i != e; ++i) {
937 const CXXMethodDecl *MD = *i;
938
939 // We only want virtual methods.
940 if (!MD->isVirtual())
941 continue;
942
943 bool ShouldAddEntryForMethod = true;
944
945 // Check if this method overrides a method in the primary base.
946 for (CXXMethodDecl::method_iterator i = MD->begin_overridden_methods(),
947 e = MD->end_overridden_methods(); i != e; ++i) {
Anders Carlssonf3935b42009-12-04 05:51:56 +0000948 const CXXMethodDecl *OverriddenMD = *i;
Anders Carlssonf942ee02009-11-27 20:47:55 +0000949 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
950 assert(OverriddenMD->isCanonicalDecl() &&
951 "Should have the canonical decl of the overridden RD!");
952
953 if (OverriddenRD == PrimaryBase) {
954 // Check if converting from the return type of the method to the
955 // return type of the overridden method requires conversion.
956 QualType ReturnType =
957 MD->getType()->getAs<FunctionType>()->getResultType();
958 QualType OverriddenReturnType =
959 OverriddenMD->getType()->getAs<FunctionType>()->getResultType();
960
961 if (!TypeConversionRequiresAdjustment(CGM.getContext(),
962 ReturnType, OverriddenReturnType)) {
963 // This index is shared between the index in the vtable of the primary
964 // base class.
965 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
966 const CXXDestructorDecl *OverriddenDD =
967 cast<CXXDestructorDecl>(OverriddenMD);
968
969 // Add both the complete and deleting entries.
970 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] =
971 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
972 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] =
973 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
974 } else {
975 MethodVtableIndices[MD] = getMethodVtableIndex(OverriddenMD);
976 }
977
978 // We don't need to add an entry for this method.
979 ShouldAddEntryForMethod = false;
980 break;
981 }
982 }
983 }
984
985 if (!ShouldAddEntryForMethod)
986 continue;
987
988 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
989 if (MD->isImplicit()) {
990 assert(!ImplicitVirtualDtor &&
991 "Did already see an implicit virtual dtor!");
992 ImplicitVirtualDtor = DD;
993 continue;
994 }
995
996 // Add the complete dtor.
997 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
998
999 // Add the deleting dtor.
1000 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
1001 } else {
1002 // Add the entry.
1003 MethodVtableIndices[MD] = CurrentIndex++;
1004 }
1005 }
1006
1007 if (ImplicitVirtualDtor) {
1008 // Itanium C++ ABI 2.5.2:
1009 // If a class has an implicitly-defined virtual destructor,
1010 // its entries come after the declared virtual function pointers.
1011
1012 // Add the complete dtor.
1013 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
1014 CurrentIndex++;
1015
1016 // Add the deleting dtor.
1017 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
1018 CurrentIndex++;
1019 }
1020
1021 NumVirtualFunctionPointers[RD] = CurrentIndex;
1022}
1023
1024uint64_t CGVtableInfo::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
1025 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
1026 NumVirtualFunctionPointers.find(RD);
1027 if (I != NumVirtualFunctionPointers.end())
1028 return I->second;
1029
1030 ComputeMethodVtableIndices(RD);
1031
1032 I = NumVirtualFunctionPointers.find(RD);
1033 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
1034 return I->second;
1035}
1036
1037uint64_t CGVtableInfo::getMethodVtableIndex(GlobalDecl GD) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001038 MethodVtableIndicesTy::iterator I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001039 if (I != MethodVtableIndices.end())
1040 return I->second;
1041
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001042 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssonf942ee02009-11-27 20:47:55 +00001043
1044 ComputeMethodVtableIndices(RD);
1045
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001046 I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001047 assert(I != MethodVtableIndices.end() && "Did not find index!");
1048 return I->second;
1049}
1050
1051int64_t CGVtableInfo::getVirtualBaseOffsetIndex(const CXXRecordDecl *RD,
1052 const CXXRecordDecl *VBase) {
1053 ClassPairTy ClassPair(RD, VBase);
1054
1055 VirtualBaseClassIndiciesTy::iterator I =
1056 VirtualBaseClassIndicies.find(ClassPair);
1057 if (I != VirtualBaseClassIndicies.end())
1058 return I->second;
1059
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001060 // FIXME: This seems expensive. Can we do a partial job to get
1061 // just this data.
Eli Friedman6c08ce72009-12-05 01:05:03 +00001062 VtableBuilder b(RD, RD, 0, CGM, false);
Mike Stump75ce5732009-10-31 20:06:59 +00001063 D1(printf("vtable %s\n", RD->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001064 b.GenerateVtableForBase(RD);
1065 b.GenerateVtableForVBases(RD);
1066
1067 for (llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
1068 b.getVBIndex().begin(), E = b.getVBIndex().end(); I != E; ++I) {
1069 // Insert all types.
1070 ClassPairTy ClassPair(RD, I->first);
1071
1072 VirtualBaseClassIndicies.insert(std::make_pair(ClassPair, I->second));
1073 }
1074
1075 I = VirtualBaseClassIndicies.find(ClassPair);
1076 assert(I != VirtualBaseClassIndicies.end() && "Did not find index!");
1077
1078 return I->second;
1079}
1080
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00001081uint64_t CGVtableInfo::getVtableAddressPoint(const CXXRecordDecl *RD) {
1082 uint64_t AddressPoint =
1083 (*(*(CGM.AddressPoints[RD]))[RD])[std::make_pair(RD, 0)];
1084
1085 return AddressPoint;
1086}
1087
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00001088llvm::GlobalVariable *
Anders Carlsson0911ae82009-12-06 00:23:49 +00001089CGVtableInfo::GenerateVtable(llvm::GlobalVariable::LinkageTypes Linkage,
Anders Carlsson232324c2009-12-06 00:53:22 +00001090 bool GenerateDefinition,
Anders Carlsson0911ae82009-12-06 00:23:49 +00001091 const CXXRecordDecl *LayoutClass,
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00001092 const CXXRecordDecl *RD, uint64_t Offset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001093 llvm::SmallString<256> OutName;
Mike Stump2cefe382009-11-12 20:47:57 +00001094 if (LayoutClass != RD)
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00001095 CGM.getMangleContext().mangleCXXCtorVtable(LayoutClass, Offset / 8,
1096 RD, OutName);
Mike Stumpeac45592009-11-11 20:26:26 +00001097 else
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00001098 CGM.getMangleContext().mangleCXXVtable(RD, OutName);
Daniel Dunbare128dd12009-11-21 09:06:22 +00001099 llvm::StringRef Name = OutName.str();
Benjamin Kramerbb0a07b2009-10-11 22:57:54 +00001100
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001101 int64_t AddressPoint;
1102
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00001103 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
1104 if (GV && CGM.AddressPoints[LayoutClass] && !GV->isDeclaration()) {
1105 AddressPoint=(*(*(CGM.AddressPoints[LayoutClass]))[RD])[std::make_pair(RD,
Mike Stumpaa51ad62009-11-19 04:04:36 +00001106 Offset)];
Mike Stumpcd2b8212009-11-19 20:52:19 +00001107 // FIXME: We can never have 0 address point. Do this for now so gepping
1108 // retains the same structure. Later, we'll just assert.
1109 if (AddressPoint == 0)
1110 AddressPoint = 1;
1111 } else {
Anders Carlsson232324c2009-12-06 00:53:22 +00001112 VtableBuilder b(RD, LayoutClass, Offset, CGM, GenerateDefinition);
Eli Friedman6c08ce72009-12-05 01:05:03 +00001113
1114 D1(printf("vtable %s\n", RD->getNameAsCString()));
1115 // First comes the vtables for all the non-virtual bases...
1116 AddressPoint = b.GenerateVtableForBase(RD, Offset);
1117
1118 // then the vtables for all the virtual bases.
1119 b.GenerateVtableForVBases(RD, Offset);
1120
Anders Carlsson58b271d2009-12-05 22:19:10 +00001121 llvm::Constant *Init = 0;
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00001122 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson58b271d2009-12-05 22:19:10 +00001123 llvm::ArrayType *ArrayType =
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001124 llvm::ArrayType::get(Int8PtrTy, b.getVtableComponents().size());
Anders Carlssona95d4c52009-12-05 21:09:05 +00001125
Anders Carlsson232324c2009-12-06 00:53:22 +00001126 if (GenerateDefinition)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001127 Init = llvm::ConstantArray::get(ArrayType, &b.getVtableComponents()[0],
1128 b.getVtableComponents().size());
Anders Carlsson232324c2009-12-06 00:53:22 +00001129
Mike Stumpaa51ad62009-11-19 04:04:36 +00001130 llvm::GlobalVariable *OGV = GV;
Anders Carlsson232324c2009-12-06 00:53:22 +00001131
1132 GV = new llvm::GlobalVariable(CGM.getModule(), ArrayType,
1133 /*isConstant=*/true, Linkage, Init, Name);
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001134 CGM.setGlobalVisibility(GV, RD);
1135
Mike Stumpaa51ad62009-11-19 04:04:36 +00001136 if (OGV) {
1137 GV->takeName(OGV);
Anders Carlsson58b271d2009-12-05 22:19:10 +00001138 llvm::Constant *NewPtr =
1139 llvm::ConstantExpr::getBitCast(GV, OGV->getType());
Mike Stumpaa51ad62009-11-19 04:04:36 +00001140 OGV->replaceAllUsesWith(NewPtr);
1141 OGV->eraseFromParent();
1142 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00001143 }
Anders Carlssonb3f54b72009-12-05 21:28:12 +00001144
1145 return GV;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001146}
Mike Stump9f23a142009-11-10 02:30:51 +00001147
Mike Stumpae1b85d2009-12-02 19:07:44 +00001148namespace {
Mike Stump9f23a142009-11-10 02:30:51 +00001149class VTTBuilder {
1150 /// Inits - The list of values built for the VTT.
1151 std::vector<llvm::Constant *> &Inits;
1152 /// Class - The most derived class that this vtable is being built for.
1153 const CXXRecordDecl *Class;
1154 CodeGenModule &CGM; // Per-module state.
Mike Stump8b2d2d02009-11-11 00:35:07 +00001155 llvm::SmallSet<const CXXRecordDecl *, 32> SeenVBase;
Mike Stumpc7b9f5e2009-11-11 03:08:24 +00001156 /// BLayout - Layout for the most derived class that this vtable is being
1157 /// built for.
1158 const ASTRecordLayout &BLayout;
Mike Stump83066c82009-11-13 01:54:23 +00001159 CodeGenModule::AddrMap_t &AddressPoints;
Mike Stump2cefe382009-11-12 20:47:57 +00001160 // vtbl - A pointer to the vtable for Class.
1161 llvm::Constant *ClassVtbl;
1162 llvm::LLVMContext &VMContext;
Mike Stump9f23a142009-11-10 02:30:51 +00001163
Mike Stump8677bc22009-11-12 22:56:32 +00001164 /// BuildVtablePtr - Build up a referene to the given secondary vtable
Anders Carlssonb3f54b72009-12-05 21:28:12 +00001165 llvm::Constant *BuildVtablePtr(llvm::Constant *Vtable,
1166 const CXXRecordDecl *VtableClass,
Mike Stump83066c82009-11-13 01:54:23 +00001167 const CXXRecordDecl *RD,
Mike Stump8677bc22009-11-12 22:56:32 +00001168 uint64_t Offset) {
Anders Carlssonb3f54b72009-12-05 21:28:12 +00001169 int64_t AddressPoint =
1170 (*AddressPoints[VtableClass])[std::make_pair(RD, Offset)];
1171
Mike Stump2b34bc52009-11-12 23:36:21 +00001172 // FIXME: We can never have 0 address point. Do this for now so gepping
Mike Stumpcd2b8212009-11-19 20:52:19 +00001173 // retains the same structure. Later we'll just assert.
Mike Stump2b34bc52009-11-12 23:36:21 +00001174 if (AddressPoint == 0)
1175 AddressPoint = 1;
Mike Stump83066c82009-11-13 01:54:23 +00001176 D1(printf("XXX address point for %s in %s layout %s at offset %d was %d\n",
1177 RD->getNameAsCString(), VtblClass->getNameAsCString(),
1178 Class->getNameAsCString(), (int)Offset, (int)AddressPoint));
Anders Carlssonb3f54b72009-12-05 21:28:12 +00001179
1180 llvm::Value *Idxs[] = {
1181 llvm::ConstantInt::get(llvm::Type::getInt64Ty(VMContext), 0),
1182 llvm::ConstantInt::get(llvm::Type::getInt64Ty(VMContext), AddressPoint)
1183 };
1184
1185 llvm::Constant *Init =
1186 llvm::ConstantExpr::getInBoundsGetElementPtr(Vtable, Idxs, 2);
1187
1188 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(VMContext);
1189 return llvm::ConstantExpr::getBitCast(Init, Int8PtrTy);
Mike Stump8677bc22009-11-12 22:56:32 +00001190 }
1191
Mike Stump2cefe382009-11-12 20:47:57 +00001192 /// Secondary - Add the secondary vtable pointers to Inits. Offset is the
1193 /// current offset in bits to the object we're working on.
Mike Stump8677bc22009-11-12 22:56:32 +00001194 void Secondary(const CXXRecordDecl *RD, llvm::Constant *vtbl,
Mike Stump83066c82009-11-13 01:54:23 +00001195 const CXXRecordDecl *VtblClass, uint64_t Offset=0,
1196 bool MorallyVirtual=false) {
Mike Stump8b2d2d02009-11-11 00:35:07 +00001197 if (RD->getNumVBases() == 0 && ! MorallyVirtual)
1198 return;
1199
1200 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1201 e = RD->bases_end(); i != e; ++i) {
1202 const CXXRecordDecl *Base =
1203 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
1204 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
1205 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1206 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
1207 bool NonVirtualPrimaryBase;
1208 NonVirtualPrimaryBase = !PrimaryBaseWasVirtual && Base == PrimaryBase;
1209 bool BaseMorallyVirtual = MorallyVirtual | i->isVirtual();
Mike Stumpc7b9f5e2009-11-11 03:08:24 +00001210 uint64_t BaseOffset;
1211 if (!i->isVirtual()) {
1212 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
1213 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
1214 } else
1215 BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stump2b34bc52009-11-12 23:36:21 +00001216 llvm::Constant *subvtbl = vtbl;
Mike Stump83066c82009-11-13 01:54:23 +00001217 const CXXRecordDecl *subVtblClass = VtblClass;
Mike Stump8b2d2d02009-11-11 00:35:07 +00001218 if ((Base->getNumVBases() || BaseMorallyVirtual)
1219 && !NonVirtualPrimaryBase) {
1220 // FIXME: Slightly too many of these for __ZTT8test8_B2
Mike Stump8677bc22009-11-12 22:56:32 +00001221 llvm::Constant *init;
Mike Stump2b34bc52009-11-12 23:36:21 +00001222 if (BaseMorallyVirtual)
Mike Stump83066c82009-11-13 01:54:23 +00001223 init = BuildVtablePtr(vtbl, VtblClass, RD, Offset);
Mike Stump2b34bc52009-11-12 23:36:21 +00001224 else {
Mike Stump8677bc22009-11-12 22:56:32 +00001225 init = CGM.getVtableInfo().getCtorVtable(Class, Base, BaseOffset);
Anders Carlsson78c28982009-12-05 20:42:53 +00001226
1227 subvtbl = init;
Mike Stump83066c82009-11-13 01:54:23 +00001228 subVtblClass = Base;
Anders Carlsson78c28982009-12-05 20:42:53 +00001229
1230 init = BuildVtablePtr(init, Class, Base, BaseOffset);
Mike Stump2b34bc52009-11-12 23:36:21 +00001231 }
Mike Stump8677bc22009-11-12 22:56:32 +00001232 Inits.push_back(init);
Mike Stump8b2d2d02009-11-11 00:35:07 +00001233 }
Mike Stump83066c82009-11-13 01:54:23 +00001234 Secondary(Base, subvtbl, subVtblClass, BaseOffset, BaseMorallyVirtual);
Mike Stump8b2d2d02009-11-11 00:35:07 +00001235 }
1236 }
1237
Mike Stump2cefe382009-11-12 20:47:57 +00001238 /// BuiltVTT - Add the VTT to Inits. Offset is the offset in bits to the
1239 /// currnet object we're working on.
1240 void BuildVTT(const CXXRecordDecl *RD, uint64_t Offset, bool MorallyVirtual) {
Mike Stump8b2d2d02009-11-11 00:35:07 +00001241 if (RD->getNumVBases() == 0 && !MorallyVirtual)
1242 return;
1243
Anders Carlssonb694f052009-12-05 21:02:25 +00001244 llvm::Constant *Vtable;
1245 const CXXRecordDecl *VtableClass;
Mike Stump83066c82009-11-13 01:54:23 +00001246
Mike Stump8b2d2d02009-11-11 00:35:07 +00001247 // First comes the primary virtual table pointer...
Mike Stump83066c82009-11-13 01:54:23 +00001248 if (MorallyVirtual) {
Anders Carlssonb694f052009-12-05 21:02:25 +00001249 Vtable = ClassVtbl;
1250 VtableClass = Class;
Mike Stump83066c82009-11-13 01:54:23 +00001251 } else {
Anders Carlssonb694f052009-12-05 21:02:25 +00001252 Vtable = CGM.getVtableInfo().getCtorVtable(Class, RD, Offset);
1253 VtableClass = RD;
Mike Stump83066c82009-11-13 01:54:23 +00001254 }
Anders Carlssonb694f052009-12-05 21:02:25 +00001255
1256 llvm::Constant *Init = BuildVtablePtr(Vtable, VtableClass, RD, Offset);
1257 Inits.push_back(Init);
Mike Stump8b2d2d02009-11-11 00:35:07 +00001258
1259 // then the secondary VTTs....
Mike Stump2cefe382009-11-12 20:47:57 +00001260 SecondaryVTTs(RD, Offset, MorallyVirtual);
Mike Stump8b2d2d02009-11-11 00:35:07 +00001261
1262 // and last the secondary vtable pointers.
Anders Carlssonb694f052009-12-05 21:02:25 +00001263 Secondary(RD, Vtable, VtableClass, Offset, MorallyVirtual);
Mike Stump8b2d2d02009-11-11 00:35:07 +00001264 }
1265
1266 /// SecondaryVTTs - Add the secondary VTTs to Inits. The secondary VTTs are
1267 /// built from each direct non-virtual proper base that requires a VTT in
1268 /// declaration order.
Mike Stump2cefe382009-11-12 20:47:57 +00001269 void SecondaryVTTs(const CXXRecordDecl *RD, uint64_t Offset=0,
1270 bool MorallyVirtual=false) {
Mike Stump8b2d2d02009-11-11 00:35:07 +00001271 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1272 e = RD->bases_end(); i != e; ++i) {
1273 const CXXRecordDecl *Base =
1274 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
1275 if (i->isVirtual())
1276 continue;
Mike Stump2cefe382009-11-12 20:47:57 +00001277 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
1278 uint64_t BaseOffset = Offset + Layout.getBaseClassOffset(Base);
1279 BuildVTT(Base, BaseOffset, MorallyVirtual);
Mike Stump8b2d2d02009-11-11 00:35:07 +00001280 }
1281 }
1282
1283 /// VirtualVTTs - Add the VTT for each proper virtual base in inheritance
1284 /// graph preorder.
1285 void VirtualVTTs(const CXXRecordDecl *RD) {
1286 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1287 e = RD->bases_end(); i != e; ++i) {
1288 const CXXRecordDecl *Base =
1289 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
1290 if (i->isVirtual() && !SeenVBase.count(Base)) {
1291 SeenVBase.insert(Base);
Mike Stump2cefe382009-11-12 20:47:57 +00001292 uint64_t BaseOffset = BLayout.getVBaseClassOffset(Base);
1293 BuildVTT(Base, BaseOffset, true);
Mike Stump8b2d2d02009-11-11 00:35:07 +00001294 }
1295 VirtualVTTs(Base);
1296 }
1297 }
Anders Carlsson78c28982009-12-05 20:42:53 +00001298
Mike Stump9f23a142009-11-10 02:30:51 +00001299public:
1300 VTTBuilder(std::vector<llvm::Constant *> &inits, const CXXRecordDecl *c,
Mike Stumpc7b9f5e2009-11-11 03:08:24 +00001301 CodeGenModule &cgm)
1302 : Inits(inits), Class(c), CGM(cgm),
Mike Stump2cefe382009-11-12 20:47:57 +00001303 BLayout(cgm.getContext().getASTRecordLayout(c)),
Mike Stump83066c82009-11-13 01:54:23 +00001304 AddressPoints(*cgm.AddressPoints[c]),
Mike Stump2cefe382009-11-12 20:47:57 +00001305 VMContext(cgm.getModule().getContext()) {
Mike Stumpd846d082009-11-10 07:44:33 +00001306
Mike Stump8b2d2d02009-11-11 00:35:07 +00001307 // First comes the primary virtual table pointer for the complete class...
Anders Carlssonb3f54b72009-12-05 21:28:12 +00001308 ClassVtbl = CGM.getVtableInfo().getVtable(Class);
Anders Carlssonb78d0932009-12-05 20:58:49 +00001309 Inits.push_back(BuildVtablePtr(ClassVtbl, Class, Class, 0));
Mike Stump2cefe382009-11-12 20:47:57 +00001310
Mike Stump8b2d2d02009-11-11 00:35:07 +00001311 // then the secondary VTTs...
1312 SecondaryVTTs(Class);
1313
1314 // then the secondary vtable pointers...
Mike Stump83066c82009-11-13 01:54:23 +00001315 Secondary(Class, ClassVtbl, Class);
Mike Stump8b2d2d02009-11-11 00:35:07 +00001316
1317 // and last, the virtual VTTs.
1318 VirtualVTTs(Class);
Mike Stump9f23a142009-11-10 02:30:51 +00001319 }
1320};
Mike Stumpae1b85d2009-12-02 19:07:44 +00001321}
Mike Stump9f23a142009-11-10 02:30:51 +00001322
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001323llvm::GlobalVariable *
1324CGVtableInfo::GenerateVTT(llvm::GlobalVariable::LinkageTypes Linkage,
1325 const CXXRecordDecl *RD) {
Mike Stumpb4722212009-11-10 19:13:04 +00001326 // Only classes that have virtual bases need a VTT.
1327 if (RD->getNumVBases() == 0)
1328 return 0;
1329
Mike Stump9f23a142009-11-10 02:30:51 +00001330 llvm::SmallString<256> OutName;
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001331 CGM.getMangleContext().mangleCXXVTT(RD, OutName);
Daniel Dunbare128dd12009-11-21 09:06:22 +00001332 llvm::StringRef Name = OutName.str();
Mike Stump9f23a142009-11-10 02:30:51 +00001333
Mike Stump9f23a142009-11-10 02:30:51 +00001334
Mike Stump9f23a142009-11-10 02:30:51 +00001335 D1(printf("vtt %s\n", RD->getNameAsCString()));
1336
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00001337 std::vector<llvm::Constant *> inits;
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001338 VTTBuilder b(inits, RD, CGM);
Mike Stump8b2d2d02009-11-11 00:35:07 +00001339
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001340 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00001341 const llvm::ArrayType *Type = llvm::ArrayType::get(Int8PtrTy, inits.size());
1342
1343 llvm::Constant *Init = llvm::ConstantArray::get(Type, inits);
1344
1345 llvm::GlobalVariable *VTT =
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001346 new llvm::GlobalVariable(CGM.getModule(), Type, /*isConstant=*/true,
1347 Linkage, Init, Name);
1348 CGM.setGlobalVisibility(VTT, RD);
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00001349
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001350 return VTT;
Mike Stump9f23a142009-11-10 02:30:51 +00001351}
Mike Stumpd846d082009-11-10 07:44:33 +00001352
Anders Carlsson232324c2009-12-06 00:53:22 +00001353void CGVtableInfo::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
1354 const CXXRecordDecl *RD) {
1355 assert(!Vtables.count(RD) && "Vtable has already been generated!");
Anders Carlsson232324c2009-12-06 00:53:22 +00001356 Vtables[RD] = GenerateVtable(Linkage, /*GenerateDefinition=*/true, RD, RD, 0);
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001357
Mike Stumpc01c2b82009-12-02 18:57:08 +00001358 CGM.GenerateRTTI(RD);
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001359 GenerateVTT(Linkage, RD);
Mike Stump1a139f82009-11-19 01:08:19 +00001360}
1361
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00001362llvm::GlobalVariable *CGVtableInfo::getVtable(const CXXRecordDecl *RD) {
Anders Carlsson232324c2009-12-06 00:53:22 +00001363 llvm::GlobalVariable *Vtable = Vtables.lookup(RD);
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00001364
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00001365 if (!Vtable)
Anders Carlsson232324c2009-12-06 00:53:22 +00001366 Vtable = GenerateVtable(llvm::GlobalValue::ExternalLinkage,
1367 /*GenerateDefinition=*/false, RD, RD, 0);
Mike Stumpaa51ad62009-11-19 04:04:36 +00001368
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00001369 return Vtable;
Mike Stumpd846d082009-11-10 07:44:33 +00001370}
Mike Stumpeac45592009-11-11 20:26:26 +00001371
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00001372llvm::GlobalVariable *
1373CGVtableInfo::getCtorVtable(const CXXRecordDecl *LayoutClass,
1374 const CXXRecordDecl *RD, uint64_t Offset) {
Anders Carlsson0911ae82009-12-06 00:23:49 +00001375 return GenerateVtable(llvm::GlobalValue::InternalLinkage,
Anders Carlsson232324c2009-12-06 00:53:22 +00001376 /*GenerateDefinition=*/true,
Anders Carlsson0911ae82009-12-06 00:23:49 +00001377 LayoutClass, RD, Offset);
Mike Stumpeac45592009-11-11 20:26:26 +00001378}
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001379
1380void CGVtableInfo::MaybeEmitVtable(GlobalDecl GD) {
1381 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
1382 const CXXRecordDecl *RD = MD->getParent();
1383
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00001384 // If the class doesn't have a vtable we don't need to emit one.
1385 if (!RD->isDynamicClass())
1386 return;
1387
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001388 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
1389
1390 // Get the key function.
1391 const CXXMethodDecl *KeyFunction = Layout.getKeyFunction();
1392
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00001393 if (KeyFunction) {
1394 // We don't have the right key function.
1395 if (KeyFunction->getCanonicalDecl() != MD->getCanonicalDecl())
1396 return;
1397
1398 // If the key function is a destructor, we only want to emit the vtable
1399 // once, so do it for the complete destructor.
1400 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() != Dtor_Complete)
1401 return;
1402 } else {
1403 // If there is no key function, we only want to emit the vtable if we are
1404 // emitting a constructor.
1405 if (!isa<CXXConstructorDecl>(MD) || GD.getCtorType() != Ctor_Complete)
1406 return;
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001407 }
1408
Anders Carlsson232324c2009-12-06 00:53:22 +00001409 llvm::GlobalVariable::LinkageTypes Linkage;
1410 if (RD->isInAnonymousNamespace())
1411 Linkage = llvm::GlobalVariable::InternalLinkage;
1412 else if (KeyFunction)
1413 Linkage = llvm::GlobalVariable::ExternalLinkage;
1414 else
1415 Linkage = llvm::GlobalVariable::WeakODRLinkage;
1416
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001417 // Emit the data.
Anders Carlsson232324c2009-12-06 00:53:22 +00001418 GenerateClassData(Linkage, RD);
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001419}
1420