blob: b34e72953373cd2a734a139ccece3a5658ba260d [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"
Anders Carlssond46ed892010-02-27 16:18:19 +000019#include "llvm/ADT/SetVector.h"
Chandler Carruth94eab4a2010-02-13 10:38:52 +000020#include "llvm/Support/Compiler.h"
Anders Carlsson5d40c6f2010-02-11 08:02:13 +000021#include "llvm/Support/Format.h"
Anders Carlsson56446142010-03-17 20:06:32 +000022#include <algorithm>
Zhongxing Xu1721ef72009-11-13 05:46:16 +000023#include <cstdio>
Anders Carlsson2bb27f52009-10-11 22:13:54 +000024
25using namespace clang;
26using namespace CodeGen;
27
Anders Carlssond59885022009-11-27 22:21:51 +000028namespace {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +000029
Anders Carlsson075056a2010-02-23 01:34:28 +000030/// BaseOffset - Represents an offset from a derived class to a direct or
31/// indirect base class.
32struct BaseOffset {
33 /// DerivedClass - The derived class.
34 const CXXRecordDecl *DerivedClass;
35
36 /// VirtualBase - If the path from the derived class to the base class
37 /// involves a virtual base class, this holds its declaration.
38 const CXXRecordDecl *VirtualBase;
39
40 /// NonVirtualOffset - The offset from the derived class to the base class.
41 /// (Or the offset from the virtual base class to the base class, if the
42 /// path from the derived class to the base class involves a virtual base
43 /// class.
44 int64_t NonVirtualOffset;
45
46 BaseOffset() : DerivedClass(0), VirtualBase(0), NonVirtualOffset(0) { }
47 BaseOffset(const CXXRecordDecl *DerivedClass,
48 const CXXRecordDecl *VirtualBase, int64_t NonVirtualOffset)
49 : DerivedClass(DerivedClass), VirtualBase(VirtualBase),
50 NonVirtualOffset(NonVirtualOffset) { }
51
52 bool isEmpty() const { return !NonVirtualOffset && !VirtualBase; }
53};
54
Anders Carlssone8ac42a2010-02-11 21:24:32 +000055/// FinalOverriders - Contains the final overrider member functions for all
56/// member functions in the base subobjects of a class.
57class FinalOverriders {
Anders Carlsson136bd192010-02-12 16:55:34 +000058public:
59 /// OverriderInfo - Information about a final overrider.
60 struct OverriderInfo {
61 /// Method - The method decl of the overrider.
62 const CXXMethodDecl *Method;
Anders Carlsson5a7654a2010-02-18 16:29:24 +000063
Anders Carlssonca82a4f2010-03-10 02:33:41 +000064 /// Offset - the base offset of the overrider in the layout class.
65 uint64_t Offset;
Anders Carlsson136bd192010-02-12 16:55:34 +000066
Anders Carlsson3c289672010-03-12 05:02:01 +000067 OverriderInfo() : Method(0), Offset(0) { }
Anders Carlsson136bd192010-02-12 16:55:34 +000068 };
69
70private:
Anders Carlssone8ac42a2010-02-11 21:24:32 +000071 /// MostDerivedClass - The most derived class for which the final overriders
72 /// are stored.
73 const CXXRecordDecl *MostDerivedClass;
74
Anders Carlssonca82a4f2010-03-10 02:33:41 +000075 /// MostDerivedClassOffset - If we're building final overriders for a
76 /// construction vtable, this holds the offset from the layout class to the
77 /// most derived class.
78 const uint64_t MostDerivedClassOffset;
79
80 /// LayoutClass - The class we're using for layout information. Will be
81 /// different than the most derived class if the final overriders are for a
82 /// construction vtable.
83 const CXXRecordDecl *LayoutClass;
84
Anders Carlssone8ac42a2010-02-11 21:24:32 +000085 ASTContext &Context;
86
87 /// MostDerivedClassLayout - the AST record layout of the most derived class.
88 const ASTRecordLayout &MostDerivedClassLayout;
89
Anders Carlssoneee53d92010-02-13 02:02:03 +000090 /// BaseSubobjectMethodPairTy - Uniquely identifies a member function
91 /// in a base subobject.
92 typedef std::pair<BaseSubobject, const CXXMethodDecl *>
93 BaseSubobjectMethodPairTy;
94
95 typedef llvm::DenseMap<BaseSubobjectMethodPairTy,
Anders Carlsson136bd192010-02-12 16:55:34 +000096 OverriderInfo> OverridersMapTy;
Anders Carlssone8ac42a2010-02-11 21:24:32 +000097
98 /// OverridersMap - The final overriders for all virtual member functions of
99 /// all the base subobjects of the most derived class.
100 OverridersMapTy OverridersMap;
101
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000102 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
103 /// avoid visiting virtual bases more than once.
104 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
105
Anders Carlssoneee53d92010-02-13 02:02:03 +0000106 typedef llvm::DenseMap<BaseSubobjectMethodPairTy, BaseOffset>
107 AdjustmentOffsetsMapTy;
108
109 /// ReturnAdjustments - Holds return adjustments for all the overriders that
110 /// need to perform return value adjustments.
111 AdjustmentOffsetsMapTy ReturnAdjustments;
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000112
Anders Carlsson5b0057c2010-03-03 04:58:02 +0000113 // FIXME: We might be able to get away with making this a SmallSet.
114 typedef llvm::SmallSetVector<uint64_t, 2> OffsetSetVectorTy;
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000115
116 /// SubobjectOffsetsMapTy - This map is used for keeping track of all the
117 /// base subobject offsets that a single class declaration might refer to.
118 ///
119 /// For example, in:
120 ///
121 /// struct A { virtual void f(); };
122 /// struct B1 : A { };
123 /// struct B2 : A { };
124 /// struct C : B1, B2 { virtual void f(); };
125 ///
126 /// when we determine that C::f() overrides A::f(), we need to update the
127 /// overriders map for both A-in-B1 and A-in-B2 and the subobject offsets map
128 /// will have the subobject offsets for both A copies.
Anders Carlsson5b0057c2010-03-03 04:58:02 +0000129 typedef llvm::DenseMap<const CXXRecordDecl *, OffsetSetVectorTy>
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000130 SubobjectOffsetsMapTy;
131
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000132 /// ComputeFinalOverriders - Compute the final overriders for a given base
133 /// subobject (and all its direct and indirect bases).
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000134 void ComputeFinalOverriders(BaseSubobject Base,
Anders Carlsson231461f2010-02-17 17:48:25 +0000135 bool BaseSubobjectIsVisitedVBase,
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000136 uint64_t OffsetInLayoutClass,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000137 SubobjectOffsetsMapTy &Offsets);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000138
139 /// AddOverriders - Add the final overriders for this base subobject to the
140 /// map of final overriders.
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000141 void AddOverriders(BaseSubobject Base,uint64_t OffsetInLayoutClass,
142 SubobjectOffsetsMapTy &Offsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000143
144 /// PropagateOverrider - Propagate the NewMD overrider to all the functions
145 /// that OldMD overrides. For example, if we have:
146 ///
147 /// struct A { virtual void f(); };
148 /// struct B : A { virtual void f(); };
149 /// struct C : B { virtual void f(); };
150 ///
151 /// and we want to override B::f with C::f, we also need to override A::f with
152 /// C::f.
153 void PropagateOverrider(const CXXMethodDecl *OldMD,
Anders Carlssona678aa12010-02-13 22:23:31 +0000154 BaseSubobject NewBase,
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000155 uint64_t OverriderOffsetInLayoutClass,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000156 const CXXMethodDecl *NewMD,
157 SubobjectOffsetsMapTy &Offsets);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000158
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000159 static void MergeSubobjectOffsets(const SubobjectOffsetsMapTy &NewOffsets,
160 SubobjectOffsetsMapTy &Offsets);
161
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000162public:
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000163 FinalOverriders(const CXXRecordDecl *MostDerivedClass,
164 uint64_t MostDerivedClassOffset,
165 const CXXRecordDecl *LayoutClass);
Anders Carlsson8025e7b2010-02-24 22:18:01 +0000166
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000167 /// getOverrider - Get the final overrider for the given method declaration in
168 /// the given base subobject.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000169 OverriderInfo getOverrider(BaseSubobject Base,
170 const CXXMethodDecl *MD) const {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000171 assert(OverridersMap.count(std::make_pair(Base, MD)) &&
172 "Did not find overrider!");
173
174 return OverridersMap.lookup(std::make_pair(Base, MD));
175 }
176
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000177 /// getReturnAdjustmentOffset - Get the return adjustment offset for the
178 /// method decl in the given base subobject. Returns an empty base offset if
179 /// no adjustment is needed.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000180 BaseOffset getReturnAdjustmentOffset(BaseSubobject Base,
181 const CXXMethodDecl *MD) const {
182 return ReturnAdjustments.lookup(std::make_pair(Base, MD));
183 }
184
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000185 /// dump - dump the final overriders.
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000186 void dump() {
187 assert(VisitedVirtualBases.empty() &&
188 "Visited virtual bases aren't empty!");
189 dump(llvm::errs(), BaseSubobject(MostDerivedClass, 0));
190 VisitedVirtualBases.clear();
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000191 }
192
193 /// dump - dump the final overriders for a base subobject, and all its direct
194 /// and indirect base subobjects.
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000195 void dump(llvm::raw_ostream &Out, BaseSubobject Base);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000196};
Anders Carlssoneee53d92010-02-13 02:02:03 +0000197
Anders Carlsson603d7d12010-02-27 20:02:53 +0000198#define DUMP_OVERRIDERS 0
199
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000200FinalOverriders::FinalOverriders(const CXXRecordDecl *MostDerivedClass,
201 uint64_t MostDerivedClassOffset,
202 const CXXRecordDecl *LayoutClass)
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000203 : MostDerivedClass(MostDerivedClass),
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000204 MostDerivedClassOffset(MostDerivedClassOffset), LayoutClass(LayoutClass),
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000205 Context(MostDerivedClass->getASTContext()),
206 MostDerivedClassLayout(Context.getASTRecordLayout(MostDerivedClass)) {
207
208 // Compute the final overriders.
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000209 SubobjectOffsetsMapTy Offsets;
Anders Carlsson231461f2010-02-17 17:48:25 +0000210 ComputeFinalOverriders(BaseSubobject(MostDerivedClass, 0),
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000211 /*BaseSubobjectIsVisitedVBase=*/false,
212 MostDerivedClassOffset, Offsets);
Anders Carlsson231461f2010-02-17 17:48:25 +0000213 VisitedVirtualBases.clear();
Anders Carlsson603d7d12010-02-27 20:02:53 +0000214
215#if DUMP_OVERRIDERS
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000216 // And dump them (for now).
217 dump();
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000218
219 // Also dump the base offsets (for now).
220 for (SubobjectOffsetsMapTy::const_iterator I = Offsets.begin(),
221 E = Offsets.end(); I != E; ++I) {
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000222 const OffsetSetVectorTy& OffsetSetVector = I->second;
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000223
224 llvm::errs() << "Base offsets for ";
225 llvm::errs() << I->first->getQualifiedNameAsString() << '\n';
226
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000227 for (unsigned I = 0, E = OffsetSetVector.size(); I != E; ++I)
228 llvm::errs() << " " << I << " - " << OffsetSetVector[I] / 8 << '\n';
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000229 }
Anders Carlsson603d7d12010-02-27 20:02:53 +0000230#endif
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000231}
232
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000233void FinalOverriders::AddOverriders(BaseSubobject Base,
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000234 uint64_t OffsetInLayoutClass,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000235 SubobjectOffsetsMapTy &Offsets) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000236 const CXXRecordDecl *RD = Base.getBase();
237
238 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
239 E = RD->method_end(); I != E; ++I) {
240 const CXXMethodDecl *MD = *I;
241
242 if (!MD->isVirtual())
243 continue;
244
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000245 // First, propagate the overrider.
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000246 PropagateOverrider(MD, Base, OffsetInLayoutClass, MD, Offsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000247
248 // Add the overrider as the final overrider of itself.
Anders Carlsson136bd192010-02-12 16:55:34 +0000249 OverriderInfo& Overrider = OverridersMap[std::make_pair(Base, MD)];
250 assert(!Overrider.Method && "Overrider should not exist yet!");
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000251
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000252 Overrider.Offset = OffsetInLayoutClass;
Anders Carlsson136bd192010-02-12 16:55:34 +0000253 Overrider.Method = MD;
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000254 }
255}
256
Anders Carlsson075056a2010-02-23 01:34:28 +0000257static BaseOffset ComputeBaseOffset(ASTContext &Context,
258 const CXXRecordDecl *DerivedRD,
259 const CXXBasePath &Path) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000260 int64_t NonVirtualOffset = 0;
Anders Carlssoneee53d92010-02-13 02:02:03 +0000261
Anders Carlssonf3f67842010-02-13 20:41:15 +0000262 unsigned NonVirtualStart = 0;
263 const CXXRecordDecl *VirtualBase = 0;
264
265 // First, look for the virtual base class.
266 for (unsigned I = 0, E = Path.size(); I != E; ++I) {
267 const CXXBasePathElement &Element = Path[I];
268
269 if (Element.Base->isVirtual()) {
270 // FIXME: Can we break when we find the first virtual base?
271 // (If we can't, can't we just iterate over the path in reverse order?)
272 NonVirtualStart = I + 1;
273 QualType VBaseType = Element.Base->getType();
274 VirtualBase =
275 cast<CXXRecordDecl>(VBaseType->getAs<RecordType>()->getDecl());
276 }
277 }
278
279 // Now compute the non-virtual offset.
280 for (unsigned I = NonVirtualStart, E = Path.size(); I != E; ++I) {
281 const CXXBasePathElement &Element = Path[I];
Anders Carlssoneee53d92010-02-13 02:02:03 +0000282
283 // Check the base class offset.
284 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Element.Class);
Anders Carlssoned7d0e82010-02-25 22:18:35 +0000285
Anders Carlssoneee53d92010-02-13 02:02:03 +0000286 const RecordType *BaseType = Element.Base->getType()->getAs<RecordType>();
287 const CXXRecordDecl *Base = cast<CXXRecordDecl>(BaseType->getDecl());
Anders Carlssoned7d0e82010-02-25 22:18:35 +0000288
Anders Carlssoneee53d92010-02-13 02:02:03 +0000289 NonVirtualOffset += Layout.getBaseClassOffset(Base);
290 }
291
292 // FIXME: This should probably use CharUnits or something. Maybe we should
293 // even change the base offsets in ASTRecordLayout to be specified in
294 // CharUnits.
Anders Carlsson075056a2010-02-23 01:34:28 +0000295 return BaseOffset(DerivedRD, VirtualBase, NonVirtualOffset / 8);
Anders Carlsson258a1e32010-02-14 00:16:19 +0000296
297}
298
Anders Carlsson075056a2010-02-23 01:34:28 +0000299static BaseOffset ComputeBaseOffset(ASTContext &Context,
300 const CXXRecordDecl *BaseRD,
301 const CXXRecordDecl *DerivedRD) {
Anders Carlsson258a1e32010-02-14 00:16:19 +0000302 CXXBasePaths Paths(/*FindAmbiguities=*/false,
303 /*RecordPaths=*/true, /*DetectVirtual=*/false);
304
305 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
306 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
307 assert(false && "Class must be derived from the passed in base class!");
Anders Carlsson075056a2010-02-23 01:34:28 +0000308 return BaseOffset();
Anders Carlsson258a1e32010-02-14 00:16:19 +0000309 }
310
311 return ComputeBaseOffset(Context, DerivedRD, Paths.front());
Anders Carlssoneee53d92010-02-13 02:02:03 +0000312}
313
Anders Carlsson075056a2010-02-23 01:34:28 +0000314static BaseOffset
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000315ComputeReturnAdjustmentBaseOffset(ASTContext &Context,
316 const CXXMethodDecl *DerivedMD,
317 const CXXMethodDecl *BaseMD) {
Anders Carlssoneee53d92010-02-13 02:02:03 +0000318 const FunctionType *BaseFT = BaseMD->getType()->getAs<FunctionType>();
319 const FunctionType *DerivedFT = DerivedMD->getType()->getAs<FunctionType>();
320
321 // Canonicalize the return types.
322 CanQualType CanDerivedReturnType =
323 Context.getCanonicalType(DerivedFT->getResultType());
324 CanQualType CanBaseReturnType =
325 Context.getCanonicalType(BaseFT->getResultType());
326
327 assert(CanDerivedReturnType->getTypeClass() ==
328 CanBaseReturnType->getTypeClass() &&
329 "Types must have same type class!");
330
331 if (CanDerivedReturnType == CanBaseReturnType) {
332 // No adjustment needed.
Anders Carlsson075056a2010-02-23 01:34:28 +0000333 return BaseOffset();
Anders Carlssoneee53d92010-02-13 02:02:03 +0000334 }
335
336 if (isa<ReferenceType>(CanDerivedReturnType)) {
337 CanDerivedReturnType =
338 CanDerivedReturnType->getAs<ReferenceType>()->getPointeeType();
339 CanBaseReturnType =
340 CanBaseReturnType->getAs<ReferenceType>()->getPointeeType();
341 } else if (isa<PointerType>(CanDerivedReturnType)) {
342 CanDerivedReturnType =
343 CanDerivedReturnType->getAs<PointerType>()->getPointeeType();
344 CanBaseReturnType =
345 CanBaseReturnType->getAs<PointerType>()->getPointeeType();
346 } else {
347 assert(false && "Unexpected return type!");
348 }
349
350 // We need to compare unqualified types here; consider
351 // const T *Base::foo();
352 // T *Derived::foo();
353 if (CanDerivedReturnType.getUnqualifiedType() ==
354 CanBaseReturnType.getUnqualifiedType()) {
355 // No adjustment needed.
Anders Carlsson075056a2010-02-23 01:34:28 +0000356 return BaseOffset();
Anders Carlssoneee53d92010-02-13 02:02:03 +0000357 }
358
359 const CXXRecordDecl *DerivedRD =
360 cast<CXXRecordDecl>(cast<RecordType>(CanDerivedReturnType)->getDecl());
361
362 const CXXRecordDecl *BaseRD =
363 cast<CXXRecordDecl>(cast<RecordType>(CanBaseReturnType)->getDecl());
364
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000365 return ComputeBaseOffset(Context, BaseRD, DerivedRD);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000366}
367
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000368void FinalOverriders::PropagateOverrider(const CXXMethodDecl *OldMD,
Anders Carlssona678aa12010-02-13 22:23:31 +0000369 BaseSubobject NewBase,
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000370 uint64_t OverriderOffsetInLayoutClass,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000371 const CXXMethodDecl *NewMD,
372 SubobjectOffsetsMapTy &Offsets) {
373 for (CXXMethodDecl::method_iterator I = OldMD->begin_overridden_methods(),
374 E = OldMD->end_overridden_methods(); I != E; ++I) {
375 const CXXMethodDecl *OverriddenMD = *I;
376 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
377
378 // We want to override OverriddenMD in all subobjects, for example:
379 //
380 /// struct A { virtual void f(); };
381 /// struct B1 : A { };
382 /// struct B2 : A { };
383 /// struct C : B1, B2 { virtual void f(); };
384 ///
385 /// When overriding A::f with C::f we need to do so in both A subobjects.
Anders Carlsson5b0057c2010-03-03 04:58:02 +0000386 const OffsetSetVectorTy &OffsetVector = Offsets[OverriddenRD];
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000387
388 // Go through all the subobjects.
389 for (unsigned I = 0, E = OffsetVector.size(); I != E; ++I) {
390 uint64_t Offset = OffsetVector[I];
391
Anders Carlsson258a1e32010-02-14 00:16:19 +0000392 BaseSubobject OverriddenSubobject = BaseSubobject(OverriddenRD, Offset);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000393 BaseSubobjectMethodPairTy SubobjectAndMethod =
Anders Carlsson258a1e32010-02-14 00:16:19 +0000394 std::make_pair(OverriddenSubobject, OverriddenMD);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000395
396 OverriderInfo &Overrider = OverridersMap[SubobjectAndMethod];
397
Anders Carlsson136bd192010-02-12 16:55:34 +0000398 assert(Overrider.Method && "Did not find existing overrider!");
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000399
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000400 // Check if we need return adjustments or base adjustments.
Anders Carlssonc1290ad2010-02-13 21:16:54 +0000401 // (We don't want to do this for pure virtual member functions).
402 if (!NewMD->isPure()) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000403 // Get the return adjustment base offset.
Anders Carlssonc1290ad2010-02-13 21:16:54 +0000404 BaseOffset ReturnBaseOffset =
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000405 ComputeReturnAdjustmentBaseOffset(Context, NewMD, OverriddenMD);
406
Anders Carlssonc1290ad2010-02-13 21:16:54 +0000407 if (!ReturnBaseOffset.isEmpty()) {
408 // Store the return adjustment base offset.
409 ReturnAdjustments[SubobjectAndMethod] = ReturnBaseOffset;
410 }
Anders Carlsson8e661e12010-02-12 17:13:23 +0000411 }
412
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000413 // Set the new overrider.
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000414 Overrider.Offset = OverriderOffsetInLayoutClass;
Anders Carlsson136bd192010-02-12 16:55:34 +0000415 Overrider.Method = NewMD;
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000416
417 // And propagate it further.
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000418 PropagateOverrider(OverriddenMD, NewBase, OverriderOffsetInLayoutClass,
419 NewMD, Offsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000420 }
421 }
422}
423
424void
425FinalOverriders::MergeSubobjectOffsets(const SubobjectOffsetsMapTy &NewOffsets,
426 SubobjectOffsetsMapTy &Offsets) {
427 // Iterate over the new offsets.
428 for (SubobjectOffsetsMapTy::const_iterator I = NewOffsets.begin(),
429 E = NewOffsets.end(); I != E; ++I) {
430 const CXXRecordDecl *NewRD = I->first;
Anders Carlsson5b0057c2010-03-03 04:58:02 +0000431 const OffsetSetVectorTy& NewOffsetVector = I->second;
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000432
Anders Carlsson5b0057c2010-03-03 04:58:02 +0000433 OffsetSetVectorTy &OffsetVector = Offsets[NewRD];
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000434
Anders Carlsson5b0057c2010-03-03 04:58:02 +0000435 // Merge the new offsets set vector into the old.
436 OffsetVector.insert(NewOffsetVector.begin(), NewOffsetVector.end());
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000437 }
438}
439
440void FinalOverriders::ComputeFinalOverriders(BaseSubobject Base,
Anders Carlsson231461f2010-02-17 17:48:25 +0000441 bool BaseSubobjectIsVisitedVBase,
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000442 uint64_t OffsetInLayoutClass,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000443 SubobjectOffsetsMapTy &Offsets) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000444 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000445 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000446
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000447 SubobjectOffsetsMapTy NewOffsets;
448
449 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
450 E = RD->bases_end(); I != E; ++I) {
451 const CXXRecordDecl *BaseDecl =
452 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
453
Anders Carlsson033d4862010-02-14 17:05:59 +0000454 // Ignore bases that don't have any virtual member functions.
455 if (!BaseDecl->isPolymorphic())
456 continue;
457
Anders Carlssoned7d0e82010-02-25 22:18:35 +0000458 bool IsVisitedVirtualBase = BaseSubobjectIsVisitedVBase;
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000459 uint64_t BaseOffset;
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000460 uint64_t BaseOffsetInLayoutClass;
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000461 if (I->isVirtual()) {
Anders Carlsson231461f2010-02-17 17:48:25 +0000462 if (!VisitedVirtualBases.insert(BaseDecl))
463 IsVisitedVirtualBase = true;
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000464 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000465
466 const ASTRecordLayout &LayoutClassLayout =
467 Context.getASTRecordLayout(LayoutClass);
468 BaseOffsetInLayoutClass =
469 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000470 } else {
471 BaseOffset = Layout.getBaseClassOffset(BaseDecl) + Base.getBaseOffset();
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000472 BaseOffsetInLayoutClass = Layout.getBaseClassOffset(BaseDecl) +
473 OffsetInLayoutClass;
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000474 }
475
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000476 // Compute the final overriders for this base.
Anders Carlsson231461f2010-02-17 17:48:25 +0000477 // We always want to compute the final overriders, even if the base is a
478 // visited virtual base. Consider:
479 //
480 // struct A {
481 // virtual void f();
482 // virtual void g();
483 // };
484 //
485 // struct B : virtual A {
486 // void f();
487 // };
488 //
489 // struct C : virtual A {
490 // void g ();
491 // };
492 //
493 // struct D : B, C { };
494 //
495 // Here, we still want to compute the overriders for A as a base of C,
496 // because otherwise we'll miss that C::g overrides A::f.
497 ComputeFinalOverriders(BaseSubobject(BaseDecl, BaseOffset),
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000498 IsVisitedVirtualBase, BaseOffsetInLayoutClass,
499 NewOffsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000500 }
501
502 /// Now add the overriders for this particular subobject.
Anders Carlsson231461f2010-02-17 17:48:25 +0000503 /// (We don't want to do this more than once for a virtual base).
504 if (!BaseSubobjectIsVisitedVBase)
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000505 AddOverriders(Base, OffsetInLayoutClass, NewOffsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000506
507 // And merge the newly discovered subobject offsets.
508 MergeSubobjectOffsets(NewOffsets, Offsets);
509
510 /// Finally, add the offset for our own subobject.
Anders Carlsson5b0057c2010-03-03 04:58:02 +0000511 Offsets[RD].insert(Base.getBaseOffset());
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000512}
513
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000514void FinalOverriders::dump(llvm::raw_ostream &Out, BaseSubobject Base) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000515 const CXXRecordDecl *RD = Base.getBase();
516 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
517
518 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
519 E = RD->bases_end(); I != E; ++I) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000520 const CXXRecordDecl *BaseDecl =
521 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
522
Anders Carlsson033d4862010-02-14 17:05:59 +0000523 // Ignore bases that don't have any virtual member functions.
524 if (!BaseDecl->isPolymorphic())
525 continue;
526
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000527 uint64_t BaseOffset;
528 if (I->isVirtual()) {
529 if (!VisitedVirtualBases.insert(BaseDecl)) {
530 // We've visited this base before.
531 continue;
532 }
533
534 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
535 } else {
536 BaseOffset = Layout.getBaseClassOffset(BaseDecl) +
537 Base.getBaseOffset();
538 }
539
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000540 dump(Out, BaseSubobject(BaseDecl, BaseOffset));
541 }
542
543 Out << "Final overriders for (" << RD->getQualifiedNameAsString() << ", ";
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000544 Out << Base.getBaseOffset() / 8 << ")\n";
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000545
546 // Now dump the overriders for this base subobject.
547 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
548 E = RD->method_end(); I != E; ++I) {
549 const CXXMethodDecl *MD = *I;
550
551 if (!MD->isVirtual())
552 continue;
553
Anders Carlsson136bd192010-02-12 16:55:34 +0000554 OverriderInfo Overrider = getOverrider(Base, MD);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000555
Anders Carlsson6f1f0022010-03-02 03:44:06 +0000556 Out << " " << MD->getQualifiedNameAsString() << " - (";
Anders Carlsson8e661e12010-02-12 17:13:23 +0000557 Out << Overrider.Method->getQualifiedNameAsString();
Anders Carlsson3c289672010-03-12 05:02:01 +0000558 Out << ", " << ", " << Overrider.Offset / 8 << ')';
Anders Carlsson6f1f0022010-03-02 03:44:06 +0000559
Benjamin Kramer02c67372010-02-13 09:11:28 +0000560 AdjustmentOffsetsMapTy::const_iterator AI =
Anders Carlssoneee53d92010-02-13 02:02:03 +0000561 ReturnAdjustments.find(std::make_pair(Base, MD));
Benjamin Kramer02c67372010-02-13 09:11:28 +0000562 if (AI != ReturnAdjustments.end()) {
563 const BaseOffset &Offset = AI->second;
Anders Carlssonf3f67842010-02-13 20:41:15 +0000564
565 Out << " [ret-adj: ";
566 if (Offset.VirtualBase)
567 Out << Offset.VirtualBase->getQualifiedNameAsString() << " vbase, ";
Anders Carlssoneee53d92010-02-13 02:02:03 +0000568
Anders Carlssonf3f67842010-02-13 20:41:15 +0000569 Out << Offset.NonVirtualOffset << " nv]";
Anders Carlssoneee53d92010-02-13 02:02:03 +0000570 }
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000571
Anders Carlsson8e661e12010-02-12 17:13:23 +0000572 Out << "\n";
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000573 }
574}
575
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000576/// VtableComponent - Represents a single component in a vtable.
577class VtableComponent {
578public:
579 enum Kind {
580 CK_VCallOffset,
581 CK_VBaseOffset,
582 CK_OffsetToTop,
583 CK_RTTI,
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000584 CK_FunctionPointer,
585
586 /// CK_CompleteDtorPointer - A pointer to the complete destructor.
587 CK_CompleteDtorPointer,
588
589 /// CK_DeletingDtorPointer - A pointer to the deleting destructor.
Anders Carlsson350b56e2010-02-19 20:08:13 +0000590 CK_DeletingDtorPointer,
591
592 /// CK_UnusedFunctionPointer - In some cases, a vtable function pointer
593 /// will end up never being called. Such vtable function pointers are
594 /// represented as a CK_UnusedFunctionPointer.
595 CK_UnusedFunctionPointer
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000596 };
597
Anders Carlssonb0a588f2010-02-17 06:07:19 +0000598 static VtableComponent MakeVCallOffset(int64_t Offset) {
599 return VtableComponent(CK_VCallOffset, Offset);
600 }
601
Anders Carlssondc2dba32010-02-16 04:49:44 +0000602 static VtableComponent MakeVBaseOffset(int64_t Offset) {
603 return VtableComponent(CK_VBaseOffset, Offset);
604 }
605
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000606 static VtableComponent MakeOffsetToTop(int64_t Offset) {
607 return VtableComponent(CK_OffsetToTop, Offset);
608 }
609
610 static VtableComponent MakeRTTI(const CXXRecordDecl *RD) {
611 return VtableComponent(CK_RTTI, reinterpret_cast<uintptr_t>(RD));
612 }
613
614 static VtableComponent MakeFunction(const CXXMethodDecl *MD) {
615 assert(!isa<CXXDestructorDecl>(MD) &&
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000616 "Don't use MakeFunction with destructors!");
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000617
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000618 return VtableComponent(CK_FunctionPointer,
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000619 reinterpret_cast<uintptr_t>(MD));
620 }
621
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000622 static VtableComponent MakeCompleteDtor(const CXXDestructorDecl *DD) {
623 return VtableComponent(CK_CompleteDtorPointer,
624 reinterpret_cast<uintptr_t>(DD));
625 }
626
627 static VtableComponent MakeDeletingDtor(const CXXDestructorDecl *DD) {
628 return VtableComponent(CK_DeletingDtorPointer,
629 reinterpret_cast<uintptr_t>(DD));
630 }
631
Anders Carlsson350b56e2010-02-19 20:08:13 +0000632 static VtableComponent MakeUnusedFunction(const CXXMethodDecl *MD) {
633 assert(!isa<CXXDestructorDecl>(MD) &&
634 "Don't use MakeUnusedFunction with destructors!");
635 return VtableComponent(CK_UnusedFunctionPointer,
636 reinterpret_cast<uintptr_t>(MD));
637 }
638
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000639 /// getKind - Get the kind of this vtable component.
640 Kind getKind() const {
641 return (Kind)(Value & 0x7);
642 }
643
Anders Carlssonb0a588f2010-02-17 06:07:19 +0000644 int64_t getVCallOffset() const {
645 assert(getKind() == CK_VCallOffset && "Invalid component kind!");
646
647 return getOffset();
648 }
649
Anders Carlssondc2dba32010-02-16 04:49:44 +0000650 int64_t getVBaseOffset() const {
651 assert(getKind() == CK_VBaseOffset && "Invalid component kind!");
652
653 return getOffset();
654 }
655
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000656 int64_t getOffsetToTop() const {
657 assert(getKind() == CK_OffsetToTop && "Invalid component kind!");
658
659 return getOffset();
660 }
661
662 const CXXRecordDecl *getRTTIDecl() const {
663 assert(getKind() == CK_RTTI && "Invalid component kind!");
664
665 return reinterpret_cast<CXXRecordDecl *>(getPointer());
666 }
667
668 const CXXMethodDecl *getFunctionDecl() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000669 assert(getKind() == CK_FunctionPointer);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000670
671 return reinterpret_cast<CXXMethodDecl *>(getPointer());
672 }
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000673
674 const CXXDestructorDecl *getDestructorDecl() const {
675 assert((getKind() == CK_CompleteDtorPointer ||
676 getKind() == CK_DeletingDtorPointer) && "Invalid component kind!");
677
678 return reinterpret_cast<CXXDestructorDecl *>(getPointer());
679 }
680
Anders Carlsson350b56e2010-02-19 20:08:13 +0000681 const CXXMethodDecl *getUnusedFunctionDecl() const {
682 assert(getKind() == CK_UnusedFunctionPointer);
683
684 return reinterpret_cast<CXXMethodDecl *>(getPointer());
685 }
686
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000687private:
688 VtableComponent(Kind ComponentKind, int64_t Offset) {
689 assert((ComponentKind == CK_VCallOffset ||
690 ComponentKind == CK_VBaseOffset ||
691 ComponentKind == CK_OffsetToTop) && "Invalid component kind!");
692 assert(Offset <= ((1LL << 56) - 1) && "Offset is too big!");
693
694 Value = ((Offset << 3) | ComponentKind);
695 }
696
697 VtableComponent(Kind ComponentKind, uintptr_t Ptr) {
698 assert((ComponentKind == CK_RTTI ||
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000699 ComponentKind == CK_FunctionPointer ||
700 ComponentKind == CK_CompleteDtorPointer ||
Anders Carlsson350b56e2010-02-19 20:08:13 +0000701 ComponentKind == CK_DeletingDtorPointer ||
702 ComponentKind == CK_UnusedFunctionPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000703 "Invalid component kind!");
704
705 assert((Ptr & 7) == 0 && "Pointer not sufficiently aligned!");
706
707 Value = Ptr | ComponentKind;
708 }
709
710 int64_t getOffset() const {
711 assert((getKind() == CK_VCallOffset || getKind() == CK_VBaseOffset ||
712 getKind() == CK_OffsetToTop) && "Invalid component kind!");
713
714 return Value >> 3;
715 }
716
717 uintptr_t getPointer() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000718 assert((getKind() == CK_RTTI ||
719 getKind() == CK_FunctionPointer ||
720 getKind() == CK_CompleteDtorPointer ||
Anders Carlsson350b56e2010-02-19 20:08:13 +0000721 getKind() == CK_DeletingDtorPointer ||
722 getKind() == CK_UnusedFunctionPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000723 "Invalid component kind!");
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000724
725 return static_cast<uintptr_t>(Value & ~7ULL);
726 }
727
728 /// The kind is stored in the lower 3 bits of the value. For offsets, we
729 /// make use of the facts that classes can't be larger than 2^55 bytes,
730 /// so we store the offset in the lower part of the 61 bytes that remain.
731 /// (The reason that we're not simply using a PointerIntPair here is that we
732 /// need the offsets to be 64-bit, even when on a 32-bit machine).
733 int64_t Value;
734};
735
Anders Carlsson78277c72010-02-18 17:00:09 +0000736/// VCallOffsetMap - Keeps track of vcall offsets when building a vtable.
737struct VCallOffsetMap {
738
739 typedef std::pair<const CXXMethodDecl *, int64_t> MethodAndOffsetPairTy;
740
741 /// Offsets - Keeps track of methods and their offsets.
742 // FIXME: This should be a real map and not a vector.
743 llvm::SmallVector<MethodAndOffsetPairTy, 16> Offsets;
744
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000745 /// MethodsCanShareVCallOffset - Returns whether two virtual member functions
746 /// can share the same vcall offset.
747 static bool MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
748 const CXXMethodDecl *RHS);
749
Anders Carlsson78277c72010-02-18 17:00:09 +0000750public:
751 /// AddVCallOffset - Adds a vcall offset to the map. Returns true if the
752 /// add was successful, or false if there was already a member function with
753 /// the same signature in the map.
754 bool AddVCallOffset(const CXXMethodDecl *MD, int64_t OffsetOffset);
755
756 /// getVCallOffsetOffset - Returns the vcall offset offset (relative to the
757 /// vtable address point) for the given virtual member function.
758 int64_t getVCallOffsetOffset(const CXXMethodDecl *MD);
759
Anders Carlsson9e3b3a32010-02-25 22:23:13 +0000760 // empty - Return whether the offset map is empty or not.
761 bool empty() const { return Offsets.empty(); }
Anders Carlsson78277c72010-02-18 17:00:09 +0000762};
763
John McCall43c6ffb2010-02-26 20:22:44 +0000764static bool HasSameVirtualSignature(const CXXMethodDecl *LHS,
765 const CXXMethodDecl *RHS) {
766 ASTContext &C = LHS->getASTContext(); // TODO: thread this down
767 CanQual<FunctionProtoType>
768 LT = C.getCanonicalType(LHS->getType()).getAs<FunctionProtoType>(),
769 RT = C.getCanonicalType(RHS->getType()).getAs<FunctionProtoType>();
770
771 // Fast-path matches in the canonical types.
772 if (LT == RT) return true;
773
774 // Force the signatures to match. We can't rely on the overrides
775 // list here because there isn't necessarily an inheritance
776 // relationship between the two methods.
777 if (LT.getQualifiers() != RT.getQualifiers() ||
778 LT->getNumArgs() != RT->getNumArgs())
779 return false;
780 for (unsigned I = 0, E = LT->getNumArgs(); I != E; ++I)
781 if (LT->getArgType(I) != RT->getArgType(I))
782 return false;
783 return true;
784}
785
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000786bool VCallOffsetMap::MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
787 const CXXMethodDecl *RHS) {
788 assert(LHS->isVirtual() && "LHS must be virtual!");
789 assert(RHS->isVirtual() && "LHS must be virtual!");
790
Anders Carlssond69b2f92010-02-27 04:12:52 +0000791 // A destructor can share a vcall offset with another destructor.
792 if (isa<CXXDestructorDecl>(LHS))
793 return isa<CXXDestructorDecl>(RHS);
794
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000795 // FIXME: We need to check more things here.
796
Anders Carlssond69b2f92010-02-27 04:12:52 +0000797 // The methods must have the same name.
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000798 DeclarationName LHSName = LHS->getDeclName();
799 DeclarationName RHSName = RHS->getDeclName();
John McCall43c6ffb2010-02-26 20:22:44 +0000800 if (LHSName != RHSName)
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000801 return false;
John McCall43c6ffb2010-02-26 20:22:44 +0000802
Anders Carlssond69b2f92010-02-27 04:12:52 +0000803 // And the same signatures.
804 return HasSameVirtualSignature(LHS, RHS);
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000805}
806
Anders Carlsson78277c72010-02-18 17:00:09 +0000807bool VCallOffsetMap::AddVCallOffset(const CXXMethodDecl *MD,
808 int64_t OffsetOffset) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000809 // Check if we can reuse an offset.
810 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
811 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
812 return false;
813 }
814
815 // Add the offset.
816 Offsets.push_back(MethodAndOffsetPairTy(MD, OffsetOffset));
Anders Carlsson78277c72010-02-18 17:00:09 +0000817 return true;
818}
819
820int64_t VCallOffsetMap::getVCallOffsetOffset(const CXXMethodDecl *MD) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000821 // Look for an offset.
822 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
823 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
824 return Offsets[I].second;
825 }
826
827 assert(false && "Should always find a vcall offset offset!");
Anders Carlsson78277c72010-02-18 17:00:09 +0000828 return 0;
829}
830
Anders Carlsson422f7782010-02-25 03:45:56 +0000831/// VCallAndVBaseOffsetBuilder - Class for building vcall and vbase offsets.
832class VCallAndVBaseOffsetBuilder {
Anders Carlssondd819c92010-03-11 16:06:20 +0000833public:
834 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
835 VBaseOffsetOffsetsMapTy;
836
837private:
Anders Carlssone3385f52010-02-28 01:43:58 +0000838 /// MostDerivedClass - The most derived class for which we're building vcall
839 /// and vbase offsets.
Anders Carlsson422f7782010-02-25 03:45:56 +0000840 const CXXRecordDecl *MostDerivedClass;
841
Anders Carlssonc3f92a12010-02-27 21:09:00 +0000842 /// LayoutClass - The class we're using for layout information. Will be
843 /// different than the most derived class if we're building a construction
844 /// vtable.
845 const CXXRecordDecl *LayoutClass;
846
Anders Carlsson422f7782010-02-25 03:45:56 +0000847 /// Context - The ASTContext which we will use for layout information.
848 ASTContext &Context;
849
850 /// Components - vcall and vbase offset components
851 typedef llvm::SmallVector<VtableComponent, 64> VtableComponentVectorTy;
852 VtableComponentVectorTy Components;
853
854 /// VisitedVirtualBases - Visited virtual bases.
855 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
856
857 /// VCallOffsets - Keeps track of vcall offsets.
858 VCallOffsetMap VCallOffsets;
859
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000860
861 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets,
862 /// relative to the address point.
863 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
864
Anders Carlsson422f7782010-02-25 03:45:56 +0000865 /// FinalOverriders - The final overriders of the most derived class.
866 /// (Can be null when we're not building a vtable of the most derived class).
867 const FinalOverriders *Overriders;
868
869 /// AddVCallAndVBaseOffsets - Add vcall offsets and vbase offsets for the
870 /// given base subobject.
871 void AddVCallAndVBaseOffsets(BaseSubobject Base, bool BaseIsVirtual,
872 uint64_t RealBaseOffset);
873
874 /// AddVCallOffsets - Add vcall offsets for the given base subobject.
875 void AddVCallOffsets(BaseSubobject Base, uint64_t VBaseOffset);
876
877 /// AddVBaseOffsets - Add vbase offsets for the given class.
Anders Carlsson93b1b492010-03-02 05:40:45 +0000878 void AddVBaseOffsets(const CXXRecordDecl *Base, uint64_t OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +0000879
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000880 /// getCurrentOffsetOffset - Get the current vcall or vbase offset offset in
881 /// bytes, relative to the vtable address point.
882 int64_t getCurrentOffsetOffset() const;
883
Anders Carlsson422f7782010-02-25 03:45:56 +0000884public:
885 VCallAndVBaseOffsetBuilder(const CXXRecordDecl *MostDerivedClass,
Anders Carlssonc3f92a12010-02-27 21:09:00 +0000886 const CXXRecordDecl *LayoutClass,
Anders Carlsson422f7782010-02-25 03:45:56 +0000887 const FinalOverriders *Overriders,
Anders Carlssone3385f52010-02-28 01:43:58 +0000888 BaseSubobject Base, bool BaseIsVirtual,
889 uint64_t OffsetInLayoutClass)
890 : MostDerivedClass(MostDerivedClass), LayoutClass(LayoutClass),
Anders Carlsson422f7782010-02-25 03:45:56 +0000891 Context(MostDerivedClass->getASTContext()), Overriders(Overriders) {
892
893 // Add vcall and vbase offsets.
Anders Carlssone3385f52010-02-28 01:43:58 +0000894 AddVCallAndVBaseOffsets(Base, BaseIsVirtual, OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +0000895 }
896
897 /// Methods for iterating over the components.
898 typedef VtableComponentVectorTy::const_reverse_iterator const_iterator;
899 const_iterator components_begin() const { return Components.rbegin(); }
900 const_iterator components_end() const { return Components.rend(); }
901
Anders Carlssondd819c92010-03-11 16:06:20 +0000902 const VCallOffsetMap &getVCallOffsets() const { return VCallOffsets; }
903 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000904 return VBaseOffsetOffsets;
905 }
Anders Carlsson422f7782010-02-25 03:45:56 +0000906};
907
908void
909VCallAndVBaseOffsetBuilder::AddVCallAndVBaseOffsets(BaseSubobject Base,
910 bool BaseIsVirtual,
911 uint64_t RealBaseOffset) {
912 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base.getBase());
913
914 // Itanium C++ ABI 2.5.2:
915 // ..in classes sharing a virtual table with a primary base class, the vcall
916 // and vbase offsets added by the derived class all come before the vcall
917 // and vbase offsets required by the base class, so that the latter may be
918 // laid out as required by the base class without regard to additions from
919 // the derived class(es).
920
921 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
922 // emit them for the primary base first).
923 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
924 bool PrimaryBaseIsVirtual = Layout.getPrimaryBaseWasVirtual();
925
926 uint64_t PrimaryBaseOffset;
927
928 // Get the base offset of the primary base.
929 if (PrimaryBaseIsVirtual) {
930 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
931 "Primary vbase should have a zero offset!");
932
933 const ASTRecordLayout &MostDerivedClassLayout =
934 Context.getASTRecordLayout(MostDerivedClass);
935
936 PrimaryBaseOffset =
937 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
938 } else {
939 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
940 "Primary base should have a zero offset!");
941
942 PrimaryBaseOffset = Base.getBaseOffset();
943 }
944
945 AddVCallAndVBaseOffsets(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
946 PrimaryBaseIsVirtual, RealBaseOffset);
947 }
948
Anders Carlsson93b1b492010-03-02 05:40:45 +0000949 AddVBaseOffsets(Base.getBase(), RealBaseOffset);
Anders Carlsson422f7782010-02-25 03:45:56 +0000950
951 // We only want to add vcall offsets for virtual bases.
952 if (BaseIsVirtual)
953 AddVCallOffsets(Base, RealBaseOffset);
954}
955
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000956int64_t VCallAndVBaseOffsetBuilder::getCurrentOffsetOffset() const {
957 // OffsetIndex is the index of this vcall or vbase offset, relative to the
958 // vtable address point. (We subtract 3 to account for the information just
959 // above the address point, the RTTI info, the offset to top, and the
960 // vcall offset itself).
961 int64_t OffsetIndex = -(int64_t)(3 + Components.size());
962
963 // FIXME: We shouldn't use / 8 here.
964 int64_t OffsetOffset = OffsetIndex *
965 (int64_t)Context.Target.getPointerWidth(0) / 8;
966
967 return OffsetOffset;
968}
969
Anders Carlsson422f7782010-02-25 03:45:56 +0000970void VCallAndVBaseOffsetBuilder::AddVCallOffsets(BaseSubobject Base,
971 uint64_t VBaseOffset) {
972 const CXXRecordDecl *RD = Base.getBase();
973 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
974
John McCall43c6ffb2010-02-26 20:22:44 +0000975 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
976
Anders Carlsson422f7782010-02-25 03:45:56 +0000977 // Handle the primary base first.
John McCall43c6ffb2010-02-26 20:22:44 +0000978 if (PrimaryBase) {
Anders Carlsson422f7782010-02-25 03:45:56 +0000979 uint64_t PrimaryBaseOffset;
980
981 // Get the base offset of the primary base.
982 if (Layout.getPrimaryBaseWasVirtual()) {
983 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
984 "Primary vbase should have a zero offset!");
985
986 const ASTRecordLayout &MostDerivedClassLayout =
987 Context.getASTRecordLayout(MostDerivedClass);
988
989 PrimaryBaseOffset =
990 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
991 } else {
992 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
993 "Primary base should have a zero offset!");
994
995 PrimaryBaseOffset = Base.getBaseOffset();
996 }
997
998 AddVCallOffsets(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
999 VBaseOffset);
1000 }
1001
1002 // Add the vcall offsets.
1003 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1004 E = RD->method_end(); I != E; ++I) {
1005 const CXXMethodDecl *MD = *I;
1006
1007 if (!MD->isVirtual())
1008 continue;
1009
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001010 int64_t OffsetOffset = getCurrentOffsetOffset();
Anders Carlsson422f7782010-02-25 03:45:56 +00001011
1012 // Don't add a vcall offset if we already have one for this member function
1013 // signature.
1014 if (!VCallOffsets.AddVCallOffset(MD, OffsetOffset))
1015 continue;
1016
1017 int64_t Offset = 0;
1018
1019 if (Overriders) {
1020 // Get the final overrider.
1021 FinalOverriders::OverriderInfo Overrider =
1022 Overriders->getOverrider(Base, MD);
1023
Anders Carlsson31f595f2010-02-28 00:10:58 +00001024 /// The vcall offset is the offset from the virtual base to the object
1025 /// where the function was overridden.
Anders Carlsson422f7782010-02-25 03:45:56 +00001026 // FIXME: We should not use / 8 here.
Anders Carlsson6f1f0022010-03-02 03:44:06 +00001027 Offset = (int64_t)(Overrider.Offset - VBaseOffset) / 8;
Anders Carlsson422f7782010-02-25 03:45:56 +00001028 }
1029
1030 Components.push_back(VtableComponent::MakeVCallOffset(Offset));
1031 }
1032
1033 // And iterate over all non-virtual bases (ignoring the primary base).
1034 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1035 E = RD->bases_end(); I != E; ++I) {
1036
1037 if (I->isVirtual())
1038 continue;
1039
1040 const CXXRecordDecl *BaseDecl =
1041 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
John McCall43c6ffb2010-02-26 20:22:44 +00001042 if (BaseDecl == PrimaryBase)
1043 continue;
Anders Carlsson422f7782010-02-25 03:45:56 +00001044
1045 // Get the base offset of this base.
1046 uint64_t BaseOffset = Base.getBaseOffset() +
1047 Layout.getBaseClassOffset(BaseDecl);
1048
1049 AddVCallOffsets(BaseSubobject(BaseDecl, BaseOffset), VBaseOffset);
1050 }
1051}
1052
Anders Carlsson422f7782010-02-25 03:45:56 +00001053void VCallAndVBaseOffsetBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
Anders Carlsson93b1b492010-03-02 05:40:45 +00001054 uint64_t OffsetInLayoutClass) {
Anders Carlssonc3f92a12010-02-27 21:09:00 +00001055 const ASTRecordLayout &LayoutClassLayout =
1056 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +00001057
1058 // Add vbase offsets.
1059 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1060 E = RD->bases_end(); I != E; ++I) {
1061 const CXXRecordDecl *BaseDecl =
1062 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1063
1064 // Check if this is a virtual base that we haven't visited before.
1065 if (I->isVirtual() && VisitedVirtualBases.insert(BaseDecl)) {
1066 // FIXME: We shouldn't use / 8 here.
Anders Carlsson93b1b492010-03-02 05:40:45 +00001067 int64_t Offset =
1068 (int64_t)(LayoutClassLayout.getVBaseClassOffset(BaseDecl) -
1069 OffsetInLayoutClass) / 8;
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001070
1071 // Add the vbase offset offset.
1072 assert(!VBaseOffsetOffsets.count(BaseDecl) &&
1073 "vbase offset offset already exists!");
1074
1075 int64_t VBaseOffsetOffset = getCurrentOffsetOffset();
1076 VBaseOffsetOffsets.insert(std::make_pair(BaseDecl, VBaseOffsetOffset));
1077
Anders Carlsson422f7782010-02-25 03:45:56 +00001078 Components.push_back(VtableComponent::MakeVBaseOffset(Offset));
1079 }
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001080
Anders Carlsson422f7782010-02-25 03:45:56 +00001081 // Check the base class looking for more vbase offsets.
Anders Carlsson93b1b492010-03-02 05:40:45 +00001082 AddVBaseOffsets(BaseDecl, OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +00001083 }
1084}
1085
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001086/// VtableBuilder - Class for building vtable layout information.
Benjamin Kramer337e3a52009-11-28 19:45:26 +00001087class VtableBuilder {
Anders Carlsson65b49782010-02-12 05:25:12 +00001088public:
Anders Carlssond46ed892010-02-27 16:18:19 +00001089 /// PrimaryBasesSetVectorTy - A set vector of direct and indirect
1090 /// primary bases.
1091 typedef llvm::SmallSetVector<const CXXRecordDecl *, 8>
1092 PrimaryBasesSetVectorTy;
1093
Anders Carlsson65b49782010-02-12 05:25:12 +00001094private:
Anders Carlssona864caf2010-03-23 04:11:45 +00001095 /// VTables - Global vtable information.
1096 CodeGenVTables &VTables;
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001097
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001098 /// MostDerivedClass - The most derived class for which we're building this
1099 /// vtable.
1100 const CXXRecordDecl *MostDerivedClass;
1101
Anders Carlsson93913752010-02-27 20:39:05 +00001102 /// MostDerivedClassOffset - If we're building a construction vtable, this
1103 /// holds the offset from the layout class to the most derived class.
1104 const uint64_t MostDerivedClassOffset;
1105
Anders Carlsson62c6c722010-02-28 00:36:23 +00001106 /// MostDerivedClassIsVirtual - Whether the most derived class is a virtual
1107 /// base. (This only makes sense when building a construction vtable).
1108 bool MostDerivedClassIsVirtual;
1109
Anders Carlsson93913752010-02-27 20:39:05 +00001110 /// LayoutClass - The class we're using for layout information. Will be
1111 /// different than the most derived class if we're building a construction
1112 /// vtable.
1113 const CXXRecordDecl *LayoutClass;
1114
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001115 /// Context - The ASTContext which we will use for layout information.
Anders Carlsson65b49782010-02-12 05:25:12 +00001116 ASTContext &Context;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001117
Anders Carlssone8ac42a2010-02-11 21:24:32 +00001118 /// FinalOverriders - The final overriders of the most derived class.
Anders Carlsson422f7782010-02-25 03:45:56 +00001119 const FinalOverriders Overriders;
Anders Carlssone8ac42a2010-02-11 21:24:32 +00001120
Anders Carlsson9e3b3a32010-02-25 22:23:13 +00001121 /// VCallOffsetsForVBases - Keeps track of vcall offsets for the virtual
1122 /// bases in this vtable.
1123 llvm::DenseMap<const CXXRecordDecl *, VCallOffsetMap> VCallOffsetsForVBases;
Anders Carlsson78277c72010-02-18 17:00:09 +00001124
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001125 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
1126 VBaseOffsetOffsetsMapTy;
1127
1128 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets for
1129 /// the most derived class.
1130 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
1131
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001132 /// Components - The components of the vtable being built.
1133 llvm::SmallVector<VtableComponent, 64> Components;
1134
Anders Carlsson932c2f22010-02-11 17:18:51 +00001135 /// AddressPoints - Address points for the vtable being built.
Anders Carlssona864caf2010-03-23 04:11:45 +00001136 CodeGenVTables::AddressPointsMapTy AddressPoints;
Anders Carlsson932c2f22010-02-11 17:18:51 +00001137
Anders Carlssond46ed892010-02-27 16:18:19 +00001138 /// MethodInfo - Contains information about a method in a vtable.
1139 /// (Used for computing 'this' pointer adjustment thunks.
1140 struct MethodInfo {
1141 /// BaseOffset - The base offset of this method.
1142 const uint64_t BaseOffset;
1143
Anders Carlsson423406f32010-03-10 21:25:37 +00001144 /// BaseOffsetInLayoutClass - The base offset in the layout class of this
1145 /// method.
1146 const uint64_t BaseOffsetInLayoutClass;
1147
Anders Carlssond46ed892010-02-27 16:18:19 +00001148 /// VtableIndex - The index in the vtable that this method has.
1149 /// (For destructors, this is the index of the complete destructor).
1150 const uint64_t VtableIndex;
1151
Anders Carlsson423406f32010-03-10 21:25:37 +00001152 MethodInfo(uint64_t BaseOffset, uint64_t BaseOffsetInLayoutClass,
1153 uint64_t VtableIndex)
1154 : BaseOffset(BaseOffset),
1155 BaseOffsetInLayoutClass(BaseOffsetInLayoutClass),
1156 VtableIndex(VtableIndex) { }
Anders Carlsson40687982010-02-27 16:52:49 +00001157
Anders Carlsson423406f32010-03-10 21:25:37 +00001158 MethodInfo() : BaseOffset(0), BaseOffsetInLayoutClass(0), VtableIndex(0) { }
Anders Carlssond46ed892010-02-27 16:18:19 +00001159 };
1160
1161 typedef llvm::DenseMap<const CXXMethodDecl *, MethodInfo> MethodInfoMapTy;
1162
1163 /// MethodInfoMap - The information for all methods in the vtable we're
1164 /// currently building.
1165 MethodInfoMapTy MethodInfoMap;
1166
Anders Carlsson8a240292010-03-12 04:54:20 +00001167 /// ThunkInfo - The 'this' pointer adjustment as well as an optional return
1168 /// adjustment for a thunk.
1169 struct ThunkInfo {
1170 /// This - The 'this' pointer adjustment.
1171 ThisAdjustment This;
1172
1173 /// Return - The return adjustment.
1174 ReturnAdjustment Return;
1175
1176 ThunkInfo() { }
1177
1178 ThunkInfo(const ThisAdjustment &This, const ReturnAdjustment &Return)
1179 : This(This), Return(Return) { }
Anders Carlsson56446142010-03-17 20:06:32 +00001180
1181 friend bool operator==(const ThunkInfo &LHS, const ThunkInfo &RHS) {
1182 return LHS.This == RHS.This && LHS.Return == RHS.Return;
1183 }
1184
Anders Carlsson7eb99a62010-03-22 16:30:44 +00001185 friend bool operator<(const ThunkInfo &LHS, const ThunkInfo &RHS) {
1186 if (LHS.This < RHS.This)
1187 return true;
1188
1189 return LHS.This == RHS.This && LHS.Return < RHS.Return;
1190 }
1191
Anders Carlsson56446142010-03-17 20:06:32 +00001192 bool isEmpty() const { return This.isEmpty() && Return.isEmpty(); }
Anders Carlsson8a240292010-03-12 04:54:20 +00001193 };
1194
Anders Carlsson917229c2010-03-23 04:59:02 +00001195 typedef llvm::DenseMap<uint64_t, ThunkInfo> VtableThunksMapTy;
Anders Carlsson8a240292010-03-12 04:54:20 +00001196
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001197 /// VTableThunks - The thunks by vtable index in the vtable currently being
1198 /// built.
Anders Carlsson917229c2010-03-23 04:59:02 +00001199 VtableThunksMapTy VTableThunks;
Anders Carlssond46ed892010-02-27 16:18:19 +00001200
Anders Carlsson917229c2010-03-23 04:59:02 +00001201 typedef llvm::SmallVector<ThunkInfo, 1> ThunkInfoVectorTy;
1202 typedef llvm::DenseMap<const CXXMethodDecl *, ThunkInfoVectorTy> ThunksMapTy;
Anders Carlsson56446142010-03-17 20:06:32 +00001203
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001204 /// Thunks - A map that contains all the thunks needed for all methods in the
1205 /// most derived class for which the vtable is currently being built.
Anders Carlsson917229c2010-03-23 04:59:02 +00001206 ThunksMapTy Thunks;
Anders Carlsson56446142010-03-17 20:06:32 +00001207
1208 /// AddThunk - Add a thunk for the given method.
Anders Carlsson4b2411e2010-03-21 20:27:14 +00001209 void AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk);
Anders Carlsson56446142010-03-17 20:06:32 +00001210
Anders Carlsson40687982010-02-27 16:52:49 +00001211 /// ComputeThisAdjustments - Compute the 'this' pointer adjustments for the
1212 /// part of the vtable we're currently building.
1213 void ComputeThisAdjustments();
1214
Anders Carlssondc2dba32010-02-16 04:49:44 +00001215 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1216
Anders Carlssond46ed892010-02-27 16:18:19 +00001217 /// PrimaryVirtualBases - All known virtual bases who are a primary base of
Anders Carlsson0570f712010-02-23 03:48:14 +00001218 /// some other base.
1219 VisitedVirtualBasesSetTy PrimaryVirtualBases;
1220
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001221 /// ComputeReturnAdjustment - Compute the return adjustment given a return
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001222 /// adjustment base offset.
Anders Carlsson075056a2010-02-23 01:34:28 +00001223 ReturnAdjustment ComputeReturnAdjustment(BaseOffset Offset);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001224
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001225 /// ComputeThisAdjustmentBaseOffset - Compute the base offset for adjusting
1226 /// the 'this' pointer from the base subobject to the derived subobject.
1227 BaseOffset ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
1228 BaseSubobject Derived) const;
1229
Anders Carlsson78277c72010-02-18 17:00:09 +00001230 /// ComputeThisAdjustment - Compute the 'this' pointer adjustment for the
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001231 /// given virtual member function, its offset in the layout class and its
1232 /// final overrider.
1233 ThisAdjustment
1234 ComputeThisAdjustment(const CXXMethodDecl *MD,
1235 uint64_t BaseOffsetInLayoutClass,
1236 FinalOverriders::OverriderInfo Overrider);
1237
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001238 /// AddMethod - Add a single virtual member function to the vtable
1239 /// components vector.
Anders Carlsson40687982010-02-27 16:52:49 +00001240 void AddMethod(const CXXMethodDecl *MD, ReturnAdjustment ReturnAdjustment);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001241
Anders Carlssona8796c62010-02-23 04:26:39 +00001242 /// IsOverriderUsed - Returns whether the overrider will ever be used in this
1243 /// part of the vtable.
1244 ///
1245 /// Itanium C++ ABI 2.5.2:
1246 ///
1247 /// struct A { virtual void f(); };
1248 /// struct B : virtual public A { int i; };
1249 /// struct C : virtual public A { int j; };
1250 /// struct D : public B, public C {};
1251 ///
1252 /// When B and C are declared, A is a primary base in each case, so although
1253 /// vcall offsets are allocated in the A-in-B and A-in-C vtables, no this
1254 /// adjustment is required and no thunk is generated. However, inside D
1255 /// objects, A is no longer a primary base of C, so if we allowed calls to
1256 /// C::f() to use the copy of A's vtable in the C subobject, we would need
1257 /// to adjust this from C* to B::A*, which would require a third-party
1258 /// thunk. Since we require that a call to C::f() first convert to A*,
1259 /// C-in-D's copy of A's vtable is never referenced, so this is not
1260 /// necessary.
Anders Carlsson804cf512010-03-10 06:51:42 +00001261 bool IsOverriderUsed(const CXXMethodDecl *Overrider,
1262 uint64_t BaseOffsetInLayoutClass,
1263 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1264 uint64_t FirstBaseOffsetInLayoutClass) const;
1265
Anders Carlssona8796c62010-02-23 04:26:39 +00001266
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001267 /// AddMethods - Add the methods of this base subobject and all its
1268 /// primary bases to the vtable components vector.
Anders Carlsson804cf512010-03-10 06:51:42 +00001269 void AddMethods(BaseSubobject Base, uint64_t BaseOffsetInLayoutClass,
1270 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1271 uint64_t FirstBaseOffsetInLayoutClass,
Anders Carlssond46ed892010-02-27 16:18:19 +00001272 PrimaryBasesSetVectorTy &PrimaryBases);
Anders Carlssonb716a542010-02-16 16:26:28 +00001273
Anders Carlsson62c6c722010-02-28 00:36:23 +00001274 // LayoutVtable - Layout the vtable for the given base class, including its
Anders Carlssonb716a542010-02-16 16:26:28 +00001275 // secondary vtables and any vtables for virtual bases.
1276 void LayoutVtable();
1277
Anders Carlssone3385f52010-02-28 01:43:58 +00001278 /// LayoutPrimaryAndSecondaryVtables - Layout the primary vtable for the
Anders Carlssonb716a542010-02-16 16:26:28 +00001279 /// given base subobject, as well as all its secondary vtables.
Anders Carlssone3385f52010-02-28 01:43:58 +00001280 void LayoutPrimaryAndSecondaryVtables(BaseSubobject Base,
1281 bool BaseIsVirtual,
1282 uint64_t OffsetInLayoutClass);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001283
Anders Carlsson14157932010-02-16 16:02:57 +00001284 /// LayoutSecondaryVtables - Layout the secondary vtables for the given base
1285 /// subobject.
Anders Carlsson115b4752010-03-10 19:39:11 +00001286 ///
1287 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
1288 /// or a direct or indirect base of a virtual base.
1289 void LayoutSecondaryVtables(BaseSubobject Base, bool BaseIsMorallyVirtual,
1290 uint64_t OffsetInLayoutClass);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001291
1292 /// DeterminePrimaryVirtualBases - Determine the primary virtual bases in this
1293 /// class hierarchy.
1294 void DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson02b99d62010-03-10 03:02:01 +00001295 uint64_t OffsetInLayoutClass,
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001296 VisitedVirtualBasesSetTy &VBases);
1297
Anders Carlsson13f0f662010-02-16 16:49:35 +00001298 /// LayoutVtablesForVirtualBases - Layout vtables for all virtual bases of the
1299 /// given base (excluding any primary bases).
1300 void LayoutVtablesForVirtualBases(const CXXRecordDecl *RD,
1301 VisitedVirtualBasesSetTy &VBases);
1302
Anders Carlsson31f595f2010-02-28 00:10:58 +00001303 /// isBuildingConstructionVtable - Return whether this vtable builder is
1304 /// building a construction vtable.
1305 bool isBuildingConstructorVtable() const {
1306 return MostDerivedClass != LayoutClass;
1307 }
1308
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001309public:
Anders Carlssona864caf2010-03-23 04:11:45 +00001310 VtableBuilder(CodeGenVTables &VTables, const CXXRecordDecl *MostDerivedClass,
Anders Carlsson62c6c722010-02-28 00:36:23 +00001311 uint64_t MostDerivedClassOffset, bool MostDerivedClassIsVirtual,
Anders Carlsson93913752010-02-27 20:39:05 +00001312 const CXXRecordDecl *LayoutClass)
Anders Carlssona864caf2010-03-23 04:11:45 +00001313 : VTables(VTables), MostDerivedClass(MostDerivedClass),
Anders Carlsson62c6c722010-02-28 00:36:23 +00001314 MostDerivedClassOffset(MostDerivedClassOffset),
1315 MostDerivedClassIsVirtual(MostDerivedClassIsVirtual),
1316 LayoutClass(LayoutClass), Context(MostDerivedClass->getASTContext()),
Anders Carlssonca82a4f2010-03-10 02:33:41 +00001317 Overriders(MostDerivedClass, MostDerivedClassOffset, LayoutClass) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001318
Anders Carlssonb716a542010-02-16 16:26:28 +00001319 LayoutVtable();
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001320 }
1321
1322 /// dumpLayout - Dump the vtable layout.
1323 void dumpLayout(llvm::raw_ostream&);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001324};
1325
Anders Carlsson4b2411e2010-03-21 20:27:14 +00001326void VtableBuilder::AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk) {
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001327 assert(!isBuildingConstructorVtable() &&
1328 "Can't add thunks for construction vtable");
Anders Carlsson18c582d2010-03-18 02:44:19 +00001329
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001330 llvm::SmallVector<ThunkInfo, 1> &ThunksVector = Thunks[MD];
Anders Carlsson56446142010-03-17 20:06:32 +00001331
1332 // Check if we have this thunk already.
1333 if (std::find(ThunksVector.begin(), ThunksVector.end(), Thunk) !=
1334 ThunksVector.end())
1335 return;
1336
1337 ThunksVector.push_back(Thunk);
1338}
1339
Anders Carlssond2025412010-02-27 06:38:03 +00001340/// OverridesMethodInBases - Checks whether whether this virtual member
1341/// function overrides a member function in any of the given bases.
Anders Carlsson65b49782010-02-12 05:25:12 +00001342/// Returns the overridden member function, or null if none was found.
1343static const CXXMethodDecl *
Anders Carlssond2025412010-02-27 06:38:03 +00001344OverridesMethodInBases(const CXXMethodDecl *MD,
Anders Carlssond46ed892010-02-27 16:18:19 +00001345 VtableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001346 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1347 E = MD->end_overridden_methods(); I != E; ++I) {
1348 const CXXMethodDecl *OverriddenMD = *I;
1349 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
1350 assert(OverriddenMD->isCanonicalDecl() &&
1351 "Should have the canonical decl of the overridden RD!");
1352
Anders Carlssond2025412010-02-27 06:38:03 +00001353 if (Bases.count(OverriddenRD))
Anders Carlsson65b49782010-02-12 05:25:12 +00001354 return OverriddenMD;
1355 }
1356
1357 return 0;
1358}
1359
Anders Carlsson40687982010-02-27 16:52:49 +00001360void VtableBuilder::ComputeThisAdjustments() {
1361 // Now go through the method info map and see if any of the methods need
1362 // 'this' pointer adjustments.
1363 for (MethodInfoMapTy::const_iterator I = MethodInfoMap.begin(),
1364 E = MethodInfoMap.end(); I != E; ++I) {
1365 const CXXMethodDecl *MD = I->first;
1366 const MethodInfo &MethodInfo = I->second;
1367
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001368 // Ignore adjustments for unused function pointers.
1369 uint64_t VtableIndex = MethodInfo.VtableIndex;
1370 if (Components[VtableIndex].getKind() ==
1371 VtableComponent::CK_UnusedFunctionPointer)
1372 continue;
1373
Anders Carlsson40687982010-02-27 16:52:49 +00001374 // Get the final overrider for this method.
1375 FinalOverriders::OverriderInfo Overrider =
Anders Carlsson423406f32010-03-10 21:25:37 +00001376 Overriders.getOverrider(BaseSubobject(MD->getParent(),
1377 MethodInfo.BaseOffset), MD);
Anders Carlsson40687982010-02-27 16:52:49 +00001378
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001379 // Check if we need an adjustment at all.
1380 if (MethodInfo.BaseOffsetInLayoutClass == Overrider.Offset)
1381 continue;
1382
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001383 ThisAdjustment ThisAdjustment =
1384 ComputeThisAdjustment(MD, MethodInfo.BaseOffsetInLayoutClass, Overrider);
1385
1386 if (ThisAdjustment.isEmpty())
Anders Carlsson40687982010-02-27 16:52:49 +00001387 continue;
Anders Carlsson40687982010-02-27 16:52:49 +00001388
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001389 // Add it.
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001390 VTableThunks[VtableIndex].This = ThisAdjustment;
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001391
Anders Carlsson40687982010-02-27 16:52:49 +00001392 if (isa<CXXDestructorDecl>(MD)) {
1393 // Add an adjustment for the deleting destructor as well.
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001394 VTableThunks[VtableIndex + 1].This = ThisAdjustment;
Anders Carlsson40687982010-02-27 16:52:49 +00001395 }
1396 }
1397
1398 /// Clear the method info map.
1399 MethodInfoMap.clear();
Anders Carlsson64decd32010-03-22 15:47:01 +00001400
1401 if (isBuildingConstructorVtable()) {
1402 // We don't need to store thunk information for construction vtables.
1403 return;
1404 }
1405
Anders Carlsson917229c2010-03-23 04:59:02 +00001406 for (VtableThunksMapTy::const_iterator I = VTableThunks.begin(),
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001407 E = VTableThunks.end(); I != E; ++I) {
Anders Carlsson64decd32010-03-22 15:47:01 +00001408 const VtableComponent &Component = Components[I->first];
1409 const ThunkInfo &Thunk = I->second;
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001410 const CXXMethodDecl *MD;
Anders Carlsson64decd32010-03-22 15:47:01 +00001411
1412 switch (Component.getKind()) {
1413 default:
1414 llvm_unreachable("Unexpected vtable component kind!");
1415 case VtableComponent::CK_FunctionPointer:
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001416 MD = Component.getFunctionDecl();
Anders Carlsson64decd32010-03-22 15:47:01 +00001417 break;
1418 case VtableComponent::CK_CompleteDtorPointer:
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001419 MD = Component.getDestructorDecl();
Anders Carlsson64decd32010-03-22 15:47:01 +00001420 break;
1421 case VtableComponent::CK_DeletingDtorPointer:
1422 // We've already added the thunk when we saw the complete dtor pointer.
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001423 continue;
Anders Carlsson64decd32010-03-22 15:47:01 +00001424 }
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001425
1426 if (MD->getParent() == MostDerivedClass)
1427 AddThunk(MD, Thunk);
Anders Carlsson64decd32010-03-22 15:47:01 +00001428 }
Anders Carlsson40687982010-02-27 16:52:49 +00001429}
1430
Anders Carlsson67fd3a50d2010-03-23 15:13:06 +00001431ReturnAdjustment VtableBuilder::ComputeReturnAdjustment(BaseOffset Offset) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001432 ReturnAdjustment Adjustment;
1433
1434 if (!Offset.isEmpty()) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001435 if (Offset.VirtualBase) {
1436 // Get the virtual base offset offset.
Anders Carlssone4424882010-03-11 07:00:45 +00001437 if (Offset.DerivedClass == MostDerivedClass) {
1438 // We can get the offset offset directly from our map.
1439 Adjustment.VBaseOffsetOffset =
1440 VBaseOffsetOffsets.lookup(Offset.VirtualBase);
1441 } else {
1442 Adjustment.VBaseOffsetOffset =
Anders Carlssona864caf2010-03-23 04:11:45 +00001443 VTables.getVirtualBaseOffsetOffset(Offset.DerivedClass,
1444 Offset.VirtualBase);
Anders Carlssone4424882010-03-11 07:00:45 +00001445 }
1446
Anders Carlssondd819c92010-03-11 16:06:20 +00001447 // FIXME: Once the assert in getVirtualBaseOffsetOffset is back again,
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001448 // we can get rid of this assert.
1449 assert(Adjustment.VBaseOffsetOffset != 0 &&
Anders Carlssondd819c92010-03-11 16:06:20 +00001450 "Invalid vbase offset offset!");
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001451 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001452
1453 Adjustment.NonVirtual = Offset.NonVirtualOffset;
1454 }
1455
1456 return Adjustment;
1457}
1458
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001459BaseOffset
1460VtableBuilder::ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
1461 BaseSubobject Derived) const {
1462 const CXXRecordDecl *BaseRD = Base.getBase();
1463 const CXXRecordDecl *DerivedRD = Derived.getBase();
1464
1465 CXXBasePaths Paths(/*FindAmbiguities=*/true,
1466 /*RecordPaths=*/true, /*DetectVirtual=*/true);
1467
1468 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
1469 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
1470 assert(false && "Class must be derived from the passed in base class!");
1471 return BaseOffset();
1472 }
1473
1474 // We have to go through all the paths, and see which one leads us to the
1475 // right base subobject.
1476 for (CXXBasePaths::const_paths_iterator I = Paths.begin(), E = Paths.end();
1477 I != E; ++I) {
1478 BaseOffset Offset = ComputeBaseOffset(Context, DerivedRD, *I);
1479
1480 // FIXME: Should not use * 8 here.
1481 uint64_t OffsetToBaseSubobject = Offset.NonVirtualOffset * 8;
1482
1483 if (Offset.VirtualBase) {
1484 // If we have a virtual base class, the non-virtual offset is relative
1485 // to the virtual base class offset.
Anders Carlsson423406f32010-03-10 21:25:37 +00001486 const ASTRecordLayout &LayoutClassLayout =
1487 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001488
1489 /// Get the virtual base offset, relative to the most derived class
1490 /// layout.
1491 OffsetToBaseSubobject +=
Anders Carlsson423406f32010-03-10 21:25:37 +00001492 LayoutClassLayout.getVBaseClassOffset(Offset.VirtualBase);
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001493 } else {
1494 // Otherwise, the non-virtual offset is relative to the derived class
1495 // offset.
1496 OffsetToBaseSubobject += Derived.getBaseOffset();
1497 }
1498
1499 // Check if this path gives us the right base subobject.
1500 if (OffsetToBaseSubobject == Base.getBaseOffset()) {
1501 // Since we're going from the base class _to_ the derived class, we'll
1502 // invert the non-virtual offset here.
1503 Offset.NonVirtualOffset = -Offset.NonVirtualOffset;
1504 return Offset;
1505 }
1506 }
1507
1508 return BaseOffset();
1509}
1510
Anders Carlsson67fd3a50d2010-03-23 15:13:06 +00001511ThisAdjustment
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001512VtableBuilder::ComputeThisAdjustment(const CXXMethodDecl *MD,
1513 uint64_t BaseOffsetInLayoutClass,
1514 FinalOverriders::OverriderInfo Overrider) {
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001515 // Ignore adjustments for pure virtual member functions.
1516 if (Overrider.Method->isPure())
1517 return ThisAdjustment();
1518
1519 BaseSubobject OverriddenBaseSubobject(MD->getParent(),
1520 BaseOffsetInLayoutClass);
1521
1522 BaseSubobject OverriderBaseSubobject(Overrider.Method->getParent(),
1523 Overrider.Offset);
1524
1525 // Compute the adjustment offset.
1526 BaseOffset Offset = ComputeThisAdjustmentBaseOffset(OverriddenBaseSubobject,
1527 OverriderBaseSubobject);
1528 if (Offset.isEmpty())
1529 return ThisAdjustment();
1530
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001531 ThisAdjustment Adjustment;
1532
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001533 if (Offset.VirtualBase) {
1534 // Get the vcall offset map for this virtual base.
1535 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Offset.VirtualBase];
Anders Carlsson8847d9e2010-02-18 17:26:40 +00001536
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001537 if (VCallOffsets.empty()) {
1538 // We don't have vcall offsets for this virtual base, go ahead and
1539 // build them.
1540 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, MostDerivedClass,
1541 /*FinalOverriders=*/0,
1542 BaseSubobject(Offset.VirtualBase, 0),
1543 /*BaseIsVirtual=*/true,
1544 /*OffsetInLayoutClass=*/0);
1545
1546 VCallOffsets = Builder.getVCallOffsets();
1547 }
1548
1549 Adjustment.VCallOffsetOffset = VCallOffsets.getVCallOffsetOffset(MD);
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001550 }
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001551
1552 // Set the non-virtual part of the adjustment.
1553 Adjustment.NonVirtual = Offset.NonVirtualOffset;
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001554
1555 return Adjustment;
1556}
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001557
Anders Carlsson65b49782010-02-12 05:25:12 +00001558void
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001559VtableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlsson40687982010-02-27 16:52:49 +00001560 ReturnAdjustment ReturnAdjustment) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001561 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1562 assert(ReturnAdjustment.isEmpty() &&
1563 "Destructor can't have return adjustment!");
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001564
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001565 // Add both the complete destructor and the deleting destructor.
1566 Components.push_back(VtableComponent::MakeCompleteDtor(DD));
1567 Components.push_back(VtableComponent::MakeDeletingDtor(DD));
1568 } else {
1569 // Add the return adjustment if necessary.
1570 if (!ReturnAdjustment.isEmpty())
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001571 VTableThunks[Components.size()].Return = ReturnAdjustment;
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001572
1573 // Add the function.
1574 Components.push_back(VtableComponent::MakeFunction(MD));
1575 }
1576}
1577
Anders Carlssond2025412010-02-27 06:38:03 +00001578/// OverridesIndirectMethodInBase - Return whether the given member function
1579/// overrides any methods in the set of given bases.
1580/// Unlike OverridesMethodInBase, this checks "overriders of overriders".
1581/// For example, if we have:
1582///
1583/// struct A { virtual void f(); }
1584/// struct B : A { virtual void f(); }
1585/// struct C : B { virtual void f(); }
1586///
1587/// OverridesIndirectMethodInBase will return true if given C::f as the method
1588/// and { A } as the set of bases.
1589static bool
1590OverridesIndirectMethodInBases(const CXXMethodDecl *MD,
Anders Carlssond46ed892010-02-27 16:18:19 +00001591 VtableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssond2025412010-02-27 06:38:03 +00001592 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1593 E = MD->end_overridden_methods(); I != E; ++I) {
1594 const CXXMethodDecl *OverriddenMD = *I;
1595 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
1596 assert(OverriddenMD->isCanonicalDecl() &&
1597 "Should have the canonical decl of the overridden RD!");
1598
1599 if (Bases.count(OverriddenRD))
1600 return true;
1601
1602 // Check "indirect overriders".
1603 if (OverridesIndirectMethodInBases(OverriddenMD, Bases))
1604 return true;
1605 }
1606
1607 return false;
1608}
1609
Anders Carlssona8796c62010-02-23 04:26:39 +00001610bool
Anders Carlsson804cf512010-03-10 06:51:42 +00001611VtableBuilder::IsOverriderUsed(const CXXMethodDecl *Overrider,
1612 uint64_t BaseOffsetInLayoutClass,
1613 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1614 uint64_t FirstBaseOffsetInLayoutClass) const {
Anders Carlssona8796c62010-02-23 04:26:39 +00001615 // If the base and the first base in the primary base chain have the same
1616 // offsets, then this overrider will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001617 if (BaseOffsetInLayoutClass == FirstBaseOffsetInLayoutClass)
Anders Carlsson8939e402010-02-23 06:34:44 +00001618 return true;
1619
1620 // We know now that Base (or a direct or indirect base of it) is a primary
1621 // base in part of the class hierarchy, but not a primary base in the most
1622 // derived class.
1623
1624 // If the overrider is the first base in the primary base chain, we know
1625 // that the overrider will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001626 if (Overrider->getParent() == FirstBaseInPrimaryBaseChain)
Anders Carlssona8796c62010-02-23 04:26:39 +00001627 return true;
1628
Anders Carlssond46ed892010-02-27 16:18:19 +00001629 VtableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlsson8939e402010-02-23 06:34:44 +00001630
Anders Carlsson804cf512010-03-10 06:51:42 +00001631 const CXXRecordDecl *RD = FirstBaseInPrimaryBaseChain;
Anders Carlsson8939e402010-02-23 06:34:44 +00001632 PrimaryBases.insert(RD);
1633
1634 // Now traverse the base chain, starting with the first base, until we find
1635 // the base that is no longer a primary base.
1636 while (true) {
1637 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1638 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1639
1640 if (!PrimaryBase)
1641 break;
1642
1643 if (Layout.getPrimaryBaseWasVirtual()) {
1644 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
1645 "Primary base should always be at offset 0!");
1646
Anders Carlsson7162ab92010-02-28 18:37:33 +00001647 const ASTRecordLayout &LayoutClassLayout =
1648 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson8939e402010-02-23 06:34:44 +00001649
1650 // Now check if this is the primary base that is not a primary base in the
1651 // most derived class.
Anders Carlsson7162ab92010-02-28 18:37:33 +00001652 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
Anders Carlsson804cf512010-03-10 06:51:42 +00001653 FirstBaseOffsetInLayoutClass) {
Anders Carlsson8939e402010-02-23 06:34:44 +00001654 // We found it, stop walking the chain.
1655 break;
1656 }
1657 } else {
1658 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
1659 "Primary base should always be at offset 0!");
1660 }
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001661
Anders Carlssonb26c2ab2010-02-27 19:51:04 +00001662 if (!PrimaryBases.insert(PrimaryBase))
1663 assert(false && "Found a duplicate primary base!");
1664
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001665 RD = PrimaryBase;
Anders Carlsson8939e402010-02-23 06:34:44 +00001666 }
1667
1668 // If the final overrider is an override of one of the primary bases,
1669 // then we know that it will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001670 return OverridesIndirectMethodInBases(Overrider, PrimaryBases);
Anders Carlssona8796c62010-02-23 04:26:39 +00001671}
1672
Anders Carlsson40687982010-02-27 16:52:49 +00001673/// FindNearestOverriddenMethod - Given a method, returns the overridden method
1674/// from the nearest base. Returns null if no method was found.
1675static const CXXMethodDecl *
1676FindNearestOverriddenMethod(const CXXMethodDecl *MD,
1677 VtableBuilder::PrimaryBasesSetVectorTy &Bases) {
1678 for (int I = Bases.size(), E = 0; I != E; --I) {
1679 const CXXRecordDecl *PrimaryBase = Bases[I - 1];
1680
1681 // Now check the overriden methods.
1682 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1683 E = MD->end_overridden_methods(); I != E; ++I) {
1684 const CXXMethodDecl *OverriddenMD = *I;
1685
1686 // We found our overridden method.
1687 if (OverriddenMD->getParent() == PrimaryBase)
1688 return OverriddenMD;
1689 }
1690 }
1691
1692 return 0;
1693}
1694
Anders Carlsson804cf512010-03-10 06:51:42 +00001695void
1696VtableBuilder::AddMethods(BaseSubobject Base, uint64_t BaseOffsetInLayoutClass,
1697 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1698 uint64_t FirstBaseOffsetInLayoutClass,
Anders Carlssond46ed892010-02-27 16:18:19 +00001699 PrimaryBasesSetVectorTy &PrimaryBases) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001700 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001701 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1702
1703 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson804cf512010-03-10 06:51:42 +00001704 uint64_t PrimaryBaseOffset;
1705 uint64_t PrimaryBaseOffsetInLayoutClass;
Anders Carlsson0570f712010-02-23 03:48:14 +00001706 if (Layout.getPrimaryBaseWasVirtual()) {
1707 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
1708 "Primary vbase should have a zero offset!");
1709
1710 const ASTRecordLayout &MostDerivedClassLayout =
1711 Context.getASTRecordLayout(MostDerivedClass);
1712
Anders Carlsson804cf512010-03-10 06:51:42 +00001713 PrimaryBaseOffset =
1714 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
1715
1716 const ASTRecordLayout &LayoutClassLayout =
1717 Context.getASTRecordLayout(LayoutClass);
1718
1719 PrimaryBaseOffsetInLayoutClass =
1720 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson0570f712010-02-23 03:48:14 +00001721 } else {
Anders Carlsson65b49782010-02-12 05:25:12 +00001722 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
1723 "Primary base should have a zero offset!");
Anders Carlsson0570f712010-02-23 03:48:14 +00001724
Anders Carlsson804cf512010-03-10 06:51:42 +00001725 PrimaryBaseOffset = Base.getBaseOffset();
1726 PrimaryBaseOffsetInLayoutClass = BaseOffsetInLayoutClass;
Anders Carlsson0570f712010-02-23 03:48:14 +00001727 }
Anders Carlsson7162ab92010-02-28 18:37:33 +00001728
Anders Carlsson804cf512010-03-10 06:51:42 +00001729 AddMethods(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
1730 PrimaryBaseOffsetInLayoutClass, FirstBaseInPrimaryBaseChain,
1731 FirstBaseOffsetInLayoutClass, PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001732
1733 if (!PrimaryBases.insert(PrimaryBase))
1734 assert(false && "Found a duplicate primary base!");
1735 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001736
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001737 // Now go through all virtual member functions and add them.
1738 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1739 E = RD->method_end(); I != E; ++I) {
1740 const CXXMethodDecl *MD = *I;
Anders Carlsson65b49782010-02-12 05:25:12 +00001741
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001742 if (!MD->isVirtual())
1743 continue;
Anders Carlsson65b49782010-02-12 05:25:12 +00001744
1745 // Get the final overrider.
Anders Carlsson136bd192010-02-12 16:55:34 +00001746 FinalOverriders::OverriderInfo Overrider =
1747 Overriders.getOverrider(Base, MD);
Anders Carlsson65b49782010-02-12 05:25:12 +00001748
1749 // Check if this virtual member function overrides a method in a primary
1750 // base. If this is the case, and the return type doesn't require adjustment
1751 // then we can just use the member function from the primary base.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001752 if (const CXXMethodDecl *OverriddenMD =
Anders Carlsson40687982010-02-27 16:52:49 +00001753 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +00001754 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
Anders Carlsson40687982010-02-27 16:52:49 +00001755 OverriddenMD).isEmpty()) {
1756 // Replace the method info of the overridden method with our own
1757 // method.
1758 assert(MethodInfoMap.count(OverriddenMD) &&
1759 "Did not find the overridden method!");
1760 MethodInfo &OverriddenMethodInfo = MethodInfoMap[OverriddenMD];
1761
1762 MethodInfo MethodInfo(Base.getBaseOffset(),
Anders Carlsson423406f32010-03-10 21:25:37 +00001763 BaseOffsetInLayoutClass,
Anders Carlsson40687982010-02-27 16:52:49 +00001764 OverriddenMethodInfo.VtableIndex);
1765
1766 assert(!MethodInfoMap.count(MD) &&
1767 "Should not have method info for this method yet!");
1768
1769 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
1770 MethodInfoMap.erase(OverriddenMD);
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001771
1772 // If the overridden method exists in a virtual base class or a direct
1773 // or indirect base class of a virtual base class, we need to emit a
1774 // thunk if we ever have a class hierarchy where the base class is not
1775 // a primary base in the complete object.
1776 if (!isBuildingConstructorVtable() && OverriddenMD != MD) {
1777 // Compute the this adjustment.
1778 ThisAdjustment ThisAdjustment =
1779 ComputeThisAdjustment(OverriddenMD, BaseOffsetInLayoutClass,
1780 Overrider);
1781
1782 if (ThisAdjustment.VCallOffsetOffset) {
1783 // This is a virtual thunk, add it.
1784 AddThunk(Overrider.Method,
1785 ThunkInfo(ThisAdjustment, ReturnAdjustment()));
1786 }
1787 }
1788
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001789 continue;
Anders Carlsson40687982010-02-27 16:52:49 +00001790 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001791 }
Anders Carlssoneee53d92010-02-13 02:02:03 +00001792
Anders Carlsson40687982010-02-27 16:52:49 +00001793 // Insert the method info for this method.
Anders Carlsson423406f32010-03-10 21:25:37 +00001794 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
1795 Components.size());
Anders Carlsson40687982010-02-27 16:52:49 +00001796
1797 assert(!MethodInfoMap.count(MD) &&
1798 "Should not have method info for this method yet!");
1799 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001800
1801 // Check if this overrider is going to be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001802 const CXXMethodDecl *OverriderMD = Overrider.Method;
1803 if (!IsOverriderUsed(OverriderMD, BaseOffsetInLayoutClass,
1804 FirstBaseInPrimaryBaseChain,
1805 FirstBaseOffsetInLayoutClass)) {
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001806 Components.push_back(VtableComponent::MakeUnusedFunction(OverriderMD));
1807 continue;
1808 }
Anders Carlssona8796c62010-02-23 04:26:39 +00001809
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001810 // Check if this overrider needs a return adjustment.
Anders Carlsson075056a2010-02-23 01:34:28 +00001811 BaseOffset ReturnAdjustmentOffset =
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001812 Overriders.getReturnAdjustmentOffset(Base, MD);
1813
1814 ReturnAdjustment ReturnAdjustment =
1815 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001816
Anders Carlsson40687982010-02-27 16:52:49 +00001817 AddMethod(Overrider.Method, ReturnAdjustment);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001818 }
1819}
1820
Anders Carlssonb716a542010-02-16 16:26:28 +00001821void VtableBuilder::LayoutVtable() {
Anders Carlssone3385f52010-02-28 01:43:58 +00001822 LayoutPrimaryAndSecondaryVtables(BaseSubobject(MostDerivedClass, 0),
1823 MostDerivedClassIsVirtual,
1824 MostDerivedClassOffset);
Anders Carlssonb716a542010-02-16 16:26:28 +00001825
Anders Carlsson13f0f662010-02-16 16:49:35 +00001826 VisitedVirtualBasesSetTy VBases;
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001827
1828 // Determine the primary virtual bases.
Anders Carlsson02b99d62010-03-10 03:02:01 +00001829 DeterminePrimaryVirtualBases(MostDerivedClass, MostDerivedClassOffset,
1830 VBases);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001831 VBases.clear();
1832
Anders Carlsson13f0f662010-02-16 16:49:35 +00001833 LayoutVtablesForVirtualBases(MostDerivedClass, VBases);
Anders Carlssonb716a542010-02-16 16:26:28 +00001834}
1835
Anders Carlssone3385f52010-02-28 01:43:58 +00001836void
1837VtableBuilder::LayoutPrimaryAndSecondaryVtables(BaseSubobject Base,
1838 bool BaseIsVirtual,
1839 uint64_t OffsetInLayoutClass) {
Chris Lattnerd2408f72010-02-17 21:42:34 +00001840 assert(Base.getBase()->isDynamicClass() && "class does not have a vtable!");
Anders Carlsson033d4862010-02-14 17:05:59 +00001841
Anders Carlsson77904f12010-02-16 04:59:55 +00001842 // Add vcall and vbase offsets for this vtable.
Anders Carlssone3385f52010-02-28 01:43:58 +00001843 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, LayoutClass, &Overriders,
1844 Base, BaseIsVirtual, OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +00001845 Components.append(Builder.components_begin(), Builder.components_end());
1846
Anders Carlsson9e3b3a32010-02-25 22:23:13 +00001847 // Check if we need to add these vcall offsets.
1848 if (BaseIsVirtual && !Builder.getVCallOffsets().empty()) {
1849 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Base.getBase()];
1850
1851 if (VCallOffsets.empty())
1852 VCallOffsets = Builder.getVCallOffsets();
1853 }
1854
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001855 // If we're laying out the most derived class we want to keep track of the
1856 // virtual base class offset offsets.
1857 if (Base.getBase() == MostDerivedClass)
1858 VBaseOffsetOffsets = Builder.getVBaseOffsetOffsets();
1859
Anders Carlsson77904f12010-02-16 04:59:55 +00001860 // Add the offset to top.
Anders Carlsson258a1e32010-02-14 00:16:19 +00001861 // FIXME: We should not use / 8 here.
Anders Carlssone3385f52010-02-28 01:43:58 +00001862 int64_t OffsetToTop = -(int64_t)(OffsetInLayoutClass -
1863 MostDerivedClassOffset) / 8;
Anders Carlssone75aaa92010-02-13 22:05:23 +00001864 Components.push_back(VtableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson65b49782010-02-12 05:25:12 +00001865
1866 // Next, add the RTTI.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001867 Components.push_back(VtableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson65b49782010-02-12 05:25:12 +00001868
Anders Carlssone8a97562010-02-12 07:43:48 +00001869 uint64_t AddressPoint = Components.size();
Anders Carlsson65b49782010-02-12 05:25:12 +00001870
1871 // Now go through all virtual member functions and add them.
Anders Carlssond46ed892010-02-27 16:18:19 +00001872 PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlsson804cf512010-03-10 06:51:42 +00001873 AddMethods(Base, OffsetInLayoutClass, Base.getBase(), OffsetInLayoutClass,
1874 PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001875
Anders Carlsson40687982010-02-27 16:52:49 +00001876 // Compute 'this' pointer adjustments.
1877 ComputeThisAdjustments();
1878
Anders Carlssone8a97562010-02-12 07:43:48 +00001879 // Record the address point.
Anders Carlssone3385f52010-02-28 01:43:58 +00001880 AddressPoints.insert(std::make_pair(BaseSubobject(Base.getBase(),
1881 OffsetInLayoutClass),
1882 AddressPoint));
Anders Carlssone8a97562010-02-12 07:43:48 +00001883
1884 // Record the address points for all primary bases.
Anders Carlssond46ed892010-02-27 16:18:19 +00001885 for (PrimaryBasesSetVectorTy::const_iterator I = PrimaryBases.begin(),
Anders Carlssone8a97562010-02-12 07:43:48 +00001886 E = PrimaryBases.end(); I != E; ++I) {
1887 const CXXRecordDecl *BaseDecl = *I;
1888
1889 // We know that all the primary bases have the same offset as the base
1890 // subobject.
Anders Carlssone3385f52010-02-28 01:43:58 +00001891 BaseSubobject PrimaryBase(BaseDecl, OffsetInLayoutClass);
Anders Carlssone8a97562010-02-12 07:43:48 +00001892 AddressPoints.insert(std::make_pair(PrimaryBase, AddressPoint));
1893 }
1894
Anders Carlsson115b4752010-03-10 19:39:11 +00001895 bool BaseIsMorallyVirtual = BaseIsVirtual;
1896 if (isBuildingConstructorVtable() && Base.getBase() == MostDerivedClass)
1897 BaseIsMorallyVirtual = false;
1898
Anders Carlssona9f633b2010-02-24 16:43:12 +00001899 // Layout secondary vtables.
Anders Carlsson115b4752010-03-10 19:39:11 +00001900 LayoutSecondaryVtables(Base, BaseIsMorallyVirtual, OffsetInLayoutClass);
Anders Carlsson14157932010-02-16 16:02:57 +00001901}
1902
Anders Carlssone3385f52010-02-28 01:43:58 +00001903void VtableBuilder::LayoutSecondaryVtables(BaseSubobject Base,
Anders Carlsson115b4752010-03-10 19:39:11 +00001904 bool BaseIsMorallyVirtual,
Anders Carlssone3385f52010-02-28 01:43:58 +00001905 uint64_t OffsetInLayoutClass) {
Anders Carlsson14157932010-02-16 16:02:57 +00001906 // Itanium C++ ABI 2.5.2:
1907 // Following the primary virtual table of a derived class are secondary
1908 // virtual tables for each of its proper base classes, except any primary
1909 // base(s) with which it shares its primary virtual table.
1910
1911 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001912 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1913 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson14157932010-02-16 16:02:57 +00001914
Anders Carlsson65b49782010-02-12 05:25:12 +00001915 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1916 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson14157932010-02-16 16:02:57 +00001917 // Ignore virtual bases, we'll emit them later.
1918 if (I->isVirtual())
1919 continue;
1920
Anders Carlsson65b49782010-02-12 05:25:12 +00001921 const CXXRecordDecl *BaseDecl =
1922 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson033d4862010-02-14 17:05:59 +00001923
Anders Carlssondc2dba32010-02-16 04:49:44 +00001924 // Ignore bases that don't have a vtable.
1925 if (!BaseDecl->isDynamicClass())
1926 continue;
Anders Carlsson033d4862010-02-14 17:05:59 +00001927
Anders Carlsson703a0862010-03-10 19:15:26 +00001928 if (isBuildingConstructorVtable()) {
1929 // Itanium C++ ABI 2.6.4:
1930 // Some of the base class subobjects may not need construction virtual
1931 // tables, which will therefore not be present in the construction
1932 // virtual table group, even though the subobject virtual tables are
1933 // present in the main virtual table group for the complete object.
Anders Carlsson115b4752010-03-10 19:39:11 +00001934 if (!BaseIsMorallyVirtual && !BaseDecl->getNumVBases())
Anders Carlsson703a0862010-03-10 19:15:26 +00001935 continue;
Anders Carlsson703a0862010-03-10 19:15:26 +00001936 }
1937
Anders Carlssone75aaa92010-02-13 22:05:23 +00001938 // Get the base offset of this base.
Anders Carlssone3385f52010-02-28 01:43:58 +00001939 uint64_t RelativeBaseOffset = Layout.getBaseClassOffset(BaseDecl);
1940 uint64_t BaseOffset = Base.getBaseOffset() + RelativeBaseOffset;
1941
1942 uint64_t BaseOffsetInLayoutClass = OffsetInLayoutClass + RelativeBaseOffset;
Anders Carlsson14157932010-02-16 16:02:57 +00001943
1944 // Don't emit a secondary vtable for a primary base. We might however want
1945 // to emit secondary vtables for other bases of this base.
1946 if (BaseDecl == PrimaryBase) {
Anders Carlssone3385f52010-02-28 01:43:58 +00001947 LayoutSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset),
Anders Carlsson115b4752010-03-10 19:39:11 +00001948 BaseIsMorallyVirtual, BaseOffsetInLayoutClass);
Anders Carlsson14157932010-02-16 16:02:57 +00001949 continue;
1950 }
Anders Carlssone75aaa92010-02-13 22:05:23 +00001951
Anders Carlssonb716a542010-02-16 16:26:28 +00001952 // Layout the primary vtable (and any secondary vtables) for this base.
Anders Carlssone3385f52010-02-28 01:43:58 +00001953 LayoutPrimaryAndSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset),
1954 /*BaseIsVirtual=*/false,
1955 BaseOffsetInLayoutClass);
Anders Carlsson65b49782010-02-12 05:25:12 +00001956 }
1957}
1958
Anders Carlsson13f0f662010-02-16 16:49:35 +00001959void
Anders Carlsson02b99d62010-03-10 03:02:01 +00001960VtableBuilder::DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
1961 uint64_t OffsetInLayoutClass,
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001962 VisitedVirtualBasesSetTy &VBases) {
1963 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1964
1965 // Check if this base has a primary base.
1966 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson8b37bb72010-02-28 18:08:38 +00001967
1968 // Check if it's virtual.
1969 if (Layout.getPrimaryBaseWasVirtual()) {
1970 bool IsPrimaryVirtualBase = true;
1971
1972 if (isBuildingConstructorVtable()) {
1973 // Check if the base is actually a primary base in the class we use for
1974 // layout.
Anders Carlsson02b99d62010-03-10 03:02:01 +00001975 const ASTRecordLayout &LayoutClassLayout =
1976 Context.getASTRecordLayout(LayoutClass);
1977
1978 uint64_t PrimaryBaseOffsetInLayoutClass =
1979 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
1980
1981 // We know that the base is not a primary base in the layout class if
1982 // the base offsets are different.
1983 if (PrimaryBaseOffsetInLayoutClass != OffsetInLayoutClass)
Anders Carlsson8b37bb72010-02-28 18:08:38 +00001984 IsPrimaryVirtualBase = false;
1985 }
1986
1987 if (IsPrimaryVirtualBase)
1988 PrimaryVirtualBases.insert(PrimaryBase);
1989 }
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001990 }
1991
1992 // Traverse bases, looking for more primary virtual bases.
1993 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1994 E = RD->bases_end(); I != E; ++I) {
1995 const CXXRecordDecl *BaseDecl =
1996 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1997
Anders Carlsson02b99d62010-03-10 03:02:01 +00001998 uint64_t BaseOffsetInLayoutClass;
1999
2000 if (I->isVirtual()) {
2001 if (!VBases.insert(BaseDecl))
2002 continue;
2003
2004 const ASTRecordLayout &LayoutClassLayout =
2005 Context.getASTRecordLayout(LayoutClass);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00002006
Anders Carlsson02b99d62010-03-10 03:02:01 +00002007 BaseOffsetInLayoutClass = LayoutClassLayout.getVBaseClassOffset(BaseDecl);
2008 } else {
2009 BaseOffsetInLayoutClass =
2010 OffsetInLayoutClass + Layout.getBaseClassOffset(BaseDecl);
2011 }
2012
2013 DeterminePrimaryVirtualBases(BaseDecl, BaseOffsetInLayoutClass, VBases);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00002014 }
2015}
2016
2017void
Anders Carlsson13f0f662010-02-16 16:49:35 +00002018VtableBuilder::LayoutVtablesForVirtualBases(const CXXRecordDecl *RD,
2019 VisitedVirtualBasesSetTy &VBases) {
2020 // Itanium C++ ABI 2.5.2:
2021 // Then come the virtual base virtual tables, also in inheritance graph
2022 // order, and again excluding primary bases (which share virtual tables with
2023 // the classes for which they are primary).
Anders Carlsson13f0f662010-02-16 16:49:35 +00002024 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
2025 E = RD->bases_end(); I != E; ++I) {
2026 const CXXRecordDecl *BaseDecl =
2027 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
2028
Anders Carlsson0570f712010-02-23 03:48:14 +00002029 // Check if this base needs a vtable. (If it's virtual, not a primary base
2030 // of some other class, and we haven't visited it before).
Anders Carlsson13f0f662010-02-16 16:49:35 +00002031 if (I->isVirtual() && BaseDecl->isDynamicClass() &&
Anders Carlssonb08aaa32010-02-27 04:05:52 +00002032 !PrimaryVirtualBases.count(BaseDecl) && VBases.insert(BaseDecl)) {
Anders Carlsson13f0f662010-02-16 16:49:35 +00002033 const ASTRecordLayout &MostDerivedClassLayout =
2034 Context.getASTRecordLayout(MostDerivedClass);
2035 uint64_t BaseOffset =
2036 MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
2037
Anders Carlssone3385f52010-02-28 01:43:58 +00002038 const ASTRecordLayout &LayoutClassLayout =
2039 Context.getASTRecordLayout(LayoutClass);
2040 uint64_t BaseOffsetInLayoutClass =
2041 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
2042
2043 LayoutPrimaryAndSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset),
2044 /*BaseIsVirtual=*/true,
2045 BaseOffsetInLayoutClass);
Anders Carlsson13f0f662010-02-16 16:49:35 +00002046 }
2047
2048 // We only need to check the base for virtual base vtables if it actually
2049 // has virtual bases.
2050 if (BaseDecl->getNumVBases())
2051 LayoutVtablesForVirtualBases(BaseDecl, VBases);
2052 }
2053}
2054
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002055/// dumpLayout - Dump the vtable layout.
2056void VtableBuilder::dumpLayout(llvm::raw_ostream& Out) {
Anders Carlsson93913752010-02-27 20:39:05 +00002057
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002058 if (isBuildingConstructorVtable()) {
Anders Carlsson93913752010-02-27 20:39:05 +00002059 Out << "Construction vtable for ('";
2060 Out << MostDerivedClass->getQualifiedNameAsString() << "', ";
2061 // FIXME: Don't use / 8 .
2062 Out << MostDerivedClassOffset / 8 << ") in '";
2063 Out << LayoutClass->getQualifiedNameAsString();
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002064 } else {
2065 Out << "Vtable for '";
2066 Out << MostDerivedClass->getQualifiedNameAsString();
Anders Carlsson93913752010-02-27 20:39:05 +00002067 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002068 Out << "' (" << Components.size() << " entries).\n";
2069
Anders Carlsson932c2f22010-02-11 17:18:51 +00002070 // Iterate through the address points and insert them into a new map where
2071 // they are keyed by the index and not the base object.
2072 // Since an address point can be shared by multiple subobjects, we use an
2073 // STL multimap.
2074 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
Anders Carlssona864caf2010-03-23 04:11:45 +00002075 for (CodeGenVTables::AddressPointsMapTy::const_iterator I =
Anders Carlsson932c2f22010-02-11 17:18:51 +00002076 AddressPoints.begin(), E = AddressPoints.end(); I != E; ++I) {
2077 const BaseSubobject& Base = I->first;
2078 uint64_t Index = I->second;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002079
Anders Carlsson932c2f22010-02-11 17:18:51 +00002080 AddressPointsByIndex.insert(std::make_pair(Index, Base));
2081 }
2082
2083 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlssone8a97562010-02-12 07:43:48 +00002084 uint64_t Index = I;
Anders Carlsson932c2f22010-02-11 17:18:51 +00002085
2086 Out << llvm::format("%4d | ", I);
2087
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002088 const VtableComponent &Component = Components[I];
2089
2090 // Dump the component.
2091 switch (Component.getKind()) {
Anders Carlssonb0a588f2010-02-17 06:07:19 +00002092
2093 case VtableComponent::CK_VCallOffset:
2094 Out << "vcall_offset (" << Component.getVCallOffset() << ")";
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002095 break;
Anders Carlsson77904f12010-02-16 04:59:55 +00002096
2097 case VtableComponent::CK_VBaseOffset:
2098 Out << "vbase_offset (" << Component.getVBaseOffset() << ")";
2099 break;
2100
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002101 case VtableComponent::CK_OffsetToTop:
2102 Out << "offset_to_top (" << Component.getOffsetToTop() << ")";
2103 break;
2104
2105 case VtableComponent::CK_RTTI:
2106 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
2107 break;
2108
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002109 case VtableComponent::CK_FunctionPointer: {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002110 const CXXMethodDecl *MD = Component.getFunctionDecl();
2111
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002112 std::string Str =
2113 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2114 MD);
2115 Out << Str;
Anders Carlsson09da3372010-02-12 02:38:13 +00002116 if (MD->isPure())
2117 Out << " [pure]";
2118
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002119 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlsson8a240292010-03-12 04:54:20 +00002120 if (!Thunk.isEmpty()) {
2121 // If this function pointer has a return adjustment, dump it.
2122 if (!Thunk.Return.isEmpty()) {
2123 Out << "\n [return adjustment: ";
2124 Out << Thunk.Return.NonVirtual << " non-virtual";
2125
2126 if (Thunk.Return.VBaseOffsetOffset) {
2127 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2128 Out << " vbase offset offset";
2129 }
Anders Carlsson78277c72010-02-18 17:00:09 +00002130
Anders Carlsson8a240292010-03-12 04:54:20 +00002131 Out << ']';
2132 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002133
Anders Carlsson8a240292010-03-12 04:54:20 +00002134 // If this function pointer has a 'this' pointer adjustment, dump it.
2135 if (!Thunk.This.isEmpty()) {
2136 Out << "\n [this adjustment: ";
2137 Out << Thunk.This.NonVirtual << " non-virtual";
2138
2139 if (Thunk.This.VCallOffsetOffset) {
2140 Out << ", " << Thunk.This.VCallOffsetOffset;
2141 Out << " vcall offset offset";
2142 }
Anders Carlsson78277c72010-02-18 17:00:09 +00002143
Anders Carlsson8a240292010-03-12 04:54:20 +00002144 Out << ']';
2145 }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00002146 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002147
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002148 break;
2149 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002150
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002151 case VtableComponent::CK_CompleteDtorPointer:
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002152 case VtableComponent::CK_DeletingDtorPointer: {
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002153 bool IsComplete =
2154 Component.getKind() == VtableComponent::CK_CompleteDtorPointer;
2155
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002156 const CXXDestructorDecl *DD = Component.getDestructorDecl();
2157
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002158 Out << DD->getQualifiedNameAsString();
2159 if (IsComplete)
2160 Out << "() [complete]";
2161 else
2162 Out << "() [deleting]";
2163
Anders Carlsson09da3372010-02-12 02:38:13 +00002164 if (DD->isPure())
2165 Out << " [pure]";
2166
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002167 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlsson8a240292010-03-12 04:54:20 +00002168 if (!Thunk.isEmpty()) {
2169 // If this destructor has a 'this' pointer adjustment, dump it.
2170 if (!Thunk.This.isEmpty()) {
2171 Out << "\n [this adjustment: ";
2172 Out << Thunk.This.NonVirtual << " non-virtual";
2173
2174 if (Thunk.This.VCallOffsetOffset) {
2175 Out << ", " << Thunk.This.VCallOffsetOffset;
2176 Out << " vcall offset offset";
2177 }
2178
2179 Out << ']';
2180 }
2181 }
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002182
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002183 break;
2184 }
2185
Anders Carlsson350b56e2010-02-19 20:08:13 +00002186 case VtableComponent::CK_UnusedFunctionPointer: {
2187 const CXXMethodDecl *MD = Component.getUnusedFunctionDecl();
2188
2189 std::string Str =
2190 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2191 MD);
2192 Out << "[unused] " << Str;
2193 if (MD->isPure())
2194 Out << " [pure]";
2195 }
2196
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002197 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00002198
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002199 Out << '\n';
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002200
2201 // Dump the next address point.
2202 uint64_t NextIndex = Index + 1;
2203 if (AddressPointsByIndex.count(NextIndex)) {
2204 if (AddressPointsByIndex.count(NextIndex) == 1) {
2205 const BaseSubobject &Base =
2206 AddressPointsByIndex.find(NextIndex)->second;
2207
2208 // FIXME: Instead of dividing by 8, we should be using CharUnits.
2209 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
2210 Out << ", " << Base.getBaseOffset() / 8 << ") vtable address --\n";
2211 } else {
2212 uint64_t BaseOffset =
2213 AddressPointsByIndex.lower_bound(NextIndex)->second.getBaseOffset();
2214
2215 // We store the class names in a set to get a stable order.
2216 std::set<std::string> ClassNames;
2217 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
2218 AddressPointsByIndex.lower_bound(NextIndex), E =
2219 AddressPointsByIndex.upper_bound(NextIndex); I != E; ++I) {
2220 assert(I->second.getBaseOffset() == BaseOffset &&
2221 "Invalid base offset!");
2222 const CXXRecordDecl *RD = I->second.getBase();
2223 ClassNames.insert(RD->getQualifiedNameAsString());
2224 }
2225
2226 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
2227 E = ClassNames.end(); I != E; ++I) {
2228 // FIXME: Instead of dividing by 8, we should be using CharUnits.
2229 Out << " -- (" << *I;
2230 Out << ", " << BaseOffset / 8 << ") vtable address --\n";
2231 }
2232 }
2233 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002234 }
Anders Carlsson93913752010-02-27 20:39:05 +00002235
2236 Out << '\n';
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002237
Anders Carlsson18c582d2010-03-18 02:44:19 +00002238 if (isBuildingConstructorVtable())
2239 return;
2240
2241 if (MostDerivedClass->getNumVBases()) {
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002242 // We store the virtual base class names and their offsets in a map to get
2243 // a stable order.
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002244
Anders Carlsson18c582d2010-03-18 02:44:19 +00002245 std::map<std::string, int64_t> ClassNamesAndOffsets;
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002246 for (VBaseOffsetOffsetsMapTy::const_iterator I = VBaseOffsetOffsets.begin(),
2247 E = VBaseOffsetOffsets.end(); I != E; ++I) {
2248 std::string ClassName = I->first->getQualifiedNameAsString();
2249 int64_t OffsetOffset = I->second;
2250 ClassNamesAndOffsets.insert(std::make_pair(ClassName, OffsetOffset));
2251 }
Anders Carlsson18c582d2010-03-18 02:44:19 +00002252
2253 Out << "Virtual base offset offsets for '";
2254 Out << MostDerivedClass->getQualifiedNameAsString() << "' (";
2255 Out << ClassNamesAndOffsets.size();
2256 Out << (ClassNamesAndOffsets.size() == 1 ? " entry" : " entries") << ").\n";
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002257
2258 for (std::map<std::string, int64_t>::const_iterator I =
2259 ClassNamesAndOffsets.begin(), E = ClassNamesAndOffsets.end();
2260 I != E; ++I)
2261 Out << " " << I->first << " | " << I->second << '\n';
2262
2263 Out << "\n";
2264 }
Anders Carlsson18c582d2010-03-18 02:44:19 +00002265
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002266 if (!Thunks.empty()) {
Anders Carlsson18c582d2010-03-18 02:44:19 +00002267 // We store the method names in a map to get a stable order.
2268 std::map<std::string, const CXXMethodDecl *> MethodNamesAndDecls;
2269
Anders Carlsson917229c2010-03-23 04:59:02 +00002270 for (ThunksMapTy::const_iterator I = Thunks.begin(), E = Thunks.end();
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002271 I != E; ++I) {
Anders Carlsson18c582d2010-03-18 02:44:19 +00002272 const CXXMethodDecl *MD = I->first;
2273 std::string MethodName =
2274 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2275 MD);
2276
2277 MethodNamesAndDecls.insert(std::make_pair(MethodName, MD));
2278 }
2279
2280 for (std::map<std::string, const CXXMethodDecl *>::const_iterator I =
2281 MethodNamesAndDecls.begin(), E = MethodNamesAndDecls.end();
2282 I != E; ++I) {
2283 const std::string &MethodName = I->first;
2284 const CXXMethodDecl *MD = I->second;
Anders Carlsson7eb99a62010-03-22 16:30:44 +00002285
Anders Carlsson917229c2010-03-23 04:59:02 +00002286 ThunkInfoVectorTy ThunksVector = Thunks[MD];
Anders Carlsson7eb99a62010-03-22 16:30:44 +00002287 std::sort(ThunksVector.begin(), ThunksVector.end());
Anders Carlsson18c582d2010-03-18 02:44:19 +00002288
2289 Out << "Thunks for '" << MethodName << "' (" << ThunksVector.size();
2290 Out << (ThunksVector.size() == 1 ? " entry" : " entries") << ").\n";
2291
2292 for (unsigned I = 0, E = ThunksVector.size(); I != E; ++I) {
2293 const ThunkInfo &Thunk = ThunksVector[I];
2294
2295 Out << llvm::format("%4d | ", I);
2296
Anders Carlsson53a47bf2010-03-22 16:10:59 +00002297 // If this function pointer has a return pointer adjustment, dump it.
2298 if (!Thunk.Return.isEmpty()) {
2299 Out << "return adjustment: " << Thunk.This.NonVirtual;
2300 Out << " non-virtual";
2301 if (Thunk.Return.VBaseOffsetOffset) {
2302 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2303 Out << " vbase offset offset";
2304 }
2305
2306 if (!Thunk.This.isEmpty())
2307 Out << "\n ";
2308 }
2309
Anders Carlsson18c582d2010-03-18 02:44:19 +00002310 // If this function pointer has a 'this' pointer adjustment, dump it.
2311 if (!Thunk.This.isEmpty()) {
Anders Carlsson53a47bf2010-03-22 16:10:59 +00002312 Out << "this adjustment: ";
2313 Out << Thunk.This.NonVirtual << " non-virtual";
Anders Carlsson18c582d2010-03-18 02:44:19 +00002314
2315 if (Thunk.This.VCallOffsetOffset) {
2316 Out << ", " << Thunk.This.VCallOffsetOffset;
Anders Carlsson53a47bf2010-03-22 16:10:59 +00002317 Out << " vcall offset offset";
Anders Carlsson18c582d2010-03-18 02:44:19 +00002318 }
2319 }
2320
2321 Out << '\n';
2322 }
Anders Carlsson290c6ed2010-03-22 20:06:40 +00002323
2324 Out << '\n';
2325
Anders Carlsson18c582d2010-03-18 02:44:19 +00002326 }
2327 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002328}
2329
2330}
2331
2332namespace {
2333class OldVtableBuilder {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002334public:
2335 /// Index_t - Vtable index type.
2336 typedef uint64_t Index_t;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002337 typedef std::vector<std::pair<GlobalDecl,
2338 std::pair<GlobalDecl, ThunkAdjustment> > >
2339 SavedAdjustmentsVectorTy;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002340private:
Anders Carlsson472404f2009-12-04 16:19:30 +00002341
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002342 // VtableComponents - The components of the vtable being built.
2343 typedef llvm::SmallVector<llvm::Constant *, 64> VtableComponentsVectorTy;
2344 VtableComponentsVectorTy VtableComponents;
2345
Eli Friedman6c08ce72009-12-05 01:05:03 +00002346 const bool BuildVtable;
2347
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002348 llvm::Type *Ptr8Ty;
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002349
2350 /// MostDerivedClass - The most derived class that this vtable is being
2351 /// built for.
2352 const CXXRecordDecl *MostDerivedClass;
2353
Mike Stump83066c82009-11-13 01:54:23 +00002354 /// LayoutClass - The most derived class used for virtual base layout
2355 /// information.
2356 const CXXRecordDecl *LayoutClass;
Mike Stump653d0b92009-11-13 02:13:54 +00002357 /// LayoutOffset - The offset for Class in LayoutClass.
2358 uint64_t LayoutOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002359 /// BLayout - Layout for the most derived class that this vtable is being
2360 /// built for.
2361 const ASTRecordLayout &BLayout;
2362 llvm::SmallSet<const CXXRecordDecl *, 32> IndirectPrimary;
2363 llvm::SmallSet<const CXXRecordDecl *, 32> SeenVBase;
2364 llvm::Constant *rtti;
2365 llvm::LLVMContext &VMContext;
2366 CodeGenModule &CGM; // Per-module state.
Anders Carlssonf2f31f42009-12-04 03:46:21 +00002367
Mike Stump90181eb2010-01-26 00:05:04 +00002368 llvm::DenseMap<const CXXMethodDecl *, Index_t> VCall;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002369 llvm::DenseMap<GlobalDecl, Index_t> VCallOffset;
Mike Stump77537b12010-01-26 03:42:22 +00002370 llvm::DenseMap<GlobalDecl, Index_t> VCallOffsetForVCall;
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002371 // This is the offset to the nearest virtual base
Mike Stump90181eb2010-01-26 00:05:04 +00002372 llvm::DenseMap<const CXXMethodDecl *, Index_t> NonVirtualOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002373 llvm::DenseMap<const CXXRecordDecl *, Index_t> VBIndex;
Mike Stumpbb9ff052009-10-27 23:46:47 +00002374
Anders Carlsson323bb042009-11-26 19:54:33 +00002375 /// PureVirtualFunction - Points to __cxa_pure_virtual.
2376 llvm::Constant *PureVirtualFn;
2377
Anders Carlssona84b6e82009-12-04 02:01:07 +00002378 /// VtableMethods - A data structure for keeping track of methods in a vtable.
2379 /// Can add methods, override methods and iterate in vtable order.
2380 class VtableMethods {
2381 // MethodToIndexMap - Maps from a global decl to the index it has in the
2382 // Methods vector.
2383 llvm::DenseMap<GlobalDecl, uint64_t> MethodToIndexMap;
2384
2385 /// Methods - The methods, in vtable order.
2386 typedef llvm::SmallVector<GlobalDecl, 16> MethodsVectorTy;
2387 MethodsVectorTy Methods;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002388 MethodsVectorTy OrigMethods;
Anders Carlssona84b6e82009-12-04 02:01:07 +00002389
2390 public:
2391 /// AddMethod - Add a method to the vtable methods.
2392 void AddMethod(GlobalDecl GD) {
2393 assert(!MethodToIndexMap.count(GD) &&
2394 "Method has already been added!");
2395
2396 MethodToIndexMap[GD] = Methods.size();
2397 Methods.push_back(GD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002398 OrigMethods.push_back(GD);
Anders Carlssona84b6e82009-12-04 02:01:07 +00002399 }
2400
2401 /// OverrideMethod - Replace a method with another.
2402 void OverrideMethod(GlobalDecl OverriddenGD, GlobalDecl GD) {
2403 llvm::DenseMap<GlobalDecl, uint64_t>::iterator i
2404 = MethodToIndexMap.find(OverriddenGD);
2405 assert(i != MethodToIndexMap.end() && "Did not find entry!");
2406
2407 // Get the index of the old decl.
2408 uint64_t Index = i->second;
2409
2410 // Replace the old decl with the new decl.
2411 Methods[Index] = GD;
2412
Anders Carlssona84b6e82009-12-04 02:01:07 +00002413 // And add the new.
2414 MethodToIndexMap[GD] = Index;
2415 }
2416
Anders Carlsson7bb70762009-12-04 15:49:02 +00002417 /// getIndex - Gives the index of a passed in GlobalDecl. Returns false if
2418 /// the index couldn't be found.
Benjamin Kramer62ab6162009-12-04 22:45:27 +00002419 bool getIndex(GlobalDecl GD, uint64_t &Index) const {
Anders Carlsson7bb70762009-12-04 15:49:02 +00002420 llvm::DenseMap<GlobalDecl, uint64_t>::const_iterator i
2421 = MethodToIndexMap.find(GD);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002422
Anders Carlsson7bb70762009-12-04 15:49:02 +00002423 if (i == MethodToIndexMap.end())
2424 return false;
Anders Carlssone6096362009-12-04 03:41:37 +00002425
Anders Carlsson7bb70762009-12-04 15:49:02 +00002426 Index = i->second;
2427 return true;
Anders Carlssone6096362009-12-04 03:41:37 +00002428 }
2429
Eli Friedman8174f2c2009-12-06 22:01:30 +00002430 GlobalDecl getOrigMethod(uint64_t Index) const {
2431 return OrigMethods[Index];
2432 }
2433
Anders Carlssona84b6e82009-12-04 02:01:07 +00002434 MethodsVectorTy::size_type size() const {
2435 return Methods.size();
2436 }
2437
2438 void clear() {
2439 MethodToIndexMap.clear();
2440 Methods.clear();
Eli Friedman8174f2c2009-12-06 22:01:30 +00002441 OrigMethods.clear();
Anders Carlssona84b6e82009-12-04 02:01:07 +00002442 }
2443
Anders Carlssone6096362009-12-04 03:41:37 +00002444 GlobalDecl operator[](uint64_t Index) const {
Anders Carlssona84b6e82009-12-04 02:01:07 +00002445 return Methods[Index];
2446 }
2447 };
2448
2449 /// Methods - The vtable methods we're currently building.
2450 VtableMethods Methods;
2451
Anders Carlsson4c837d22009-12-04 02:26:15 +00002452 /// ThisAdjustments - For a given index in the vtable, contains the 'this'
2453 /// pointer adjustment needed for a method.
2454 typedef llvm::DenseMap<uint64_t, ThunkAdjustment> ThisAdjustmentsMapTy;
2455 ThisAdjustmentsMapTy ThisAdjustments;
Anders Carlssond420a312009-11-26 19:32:45 +00002456
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002457 SavedAdjustmentsVectorTy SavedAdjustments;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002458
Anders Carlssonc521f952009-12-04 02:22:02 +00002459 /// BaseReturnTypes - Contains the base return types of methods who have been
2460 /// overridden with methods whose return types require adjustment. Used for
2461 /// generating covariant thunk information.
2462 typedef llvm::DenseMap<uint64_t, CanQualType> BaseReturnTypesMapTy;
2463 BaseReturnTypesMapTy BaseReturnTypes;
Anders Carlssond420a312009-11-26 19:32:45 +00002464
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002465 std::vector<Index_t> VCalls;
Mike Stump2cefe382009-11-12 20:47:57 +00002466
2467 typedef std::pair<const CXXRecordDecl *, uint64_t> CtorVtable_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00002468 // subAddressPoints - Used to hold the AddressPoints (offsets) into the built
2469 // vtable for use in computing the initializers for the VTT.
2470 llvm::DenseMap<CtorVtable_t, int64_t> &subAddressPoints;
Mike Stump2cefe382009-11-12 20:47:57 +00002471
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002472 /// AddressPoints - Address points for this vtable.
Anders Carlssona864caf2010-03-23 04:11:45 +00002473 CodeGenVTables::AddressPointsMapTy& AddressPoints;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002474
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002475 typedef CXXRecordDecl::method_iterator method_iter;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002476 const uint32_t LLVMPointerWidth;
2477 Index_t extra;
Mike Stump37dbe962009-10-15 02:04:03 +00002478 typedef std::vector<std::pair<const CXXRecordDecl *, int64_t> > Path_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00002479 static llvm::DenseMap<CtorVtable_t, int64_t>&
2480 AllocAddressPoint(CodeGenModule &cgm, const CXXRecordDecl *l,
2481 const CXXRecordDecl *c) {
Anders Carlssona864caf2010-03-23 04:11:45 +00002482 CodeGenVTables::AddrMap_t *&oref = cgm.getVTables().AddressPoints[l];
Mike Stumpcd2b8212009-11-19 20:52:19 +00002483 if (oref == 0)
Anders Carlssona864caf2010-03-23 04:11:45 +00002484 oref = new CodeGenVTables::AddrMap_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00002485
2486 llvm::DenseMap<CtorVtable_t, int64_t> *&ref = (*oref)[c];
2487 if (ref == 0)
2488 ref = new llvm::DenseMap<CtorVtable_t, int64_t>;
2489 return *ref;
2490 }
Anders Carlsson323bb042009-11-26 19:54:33 +00002491
Mike Stump90181eb2010-01-26 00:05:04 +00002492 bool DclIsSame(const FunctionDecl *New, const FunctionDecl *Old) {
2493 FunctionTemplateDecl *OldTemplate = Old->getDescribedFunctionTemplate();
2494 FunctionTemplateDecl *NewTemplate = New->getDescribedFunctionTemplate();
2495
2496 // C++ [temp.fct]p2:
2497 // A function template can be overloaded with other function templates
2498 // and with normal (non-template) functions.
2499 if ((OldTemplate == 0) != (NewTemplate == 0))
2500 return false;
2501
2502 // Is the function New an overload of the function Old?
2503 QualType OldQType = CGM.getContext().getCanonicalType(Old->getType());
2504 QualType NewQType = CGM.getContext().getCanonicalType(New->getType());
2505
2506 // Compare the signatures (C++ 1.3.10) of the two functions to
2507 // determine whether they are overloads. If we find any mismatch
2508 // in the signature, they are overloads.
2509
2510 // If either of these functions is a K&R-style function (no
2511 // prototype), then we consider them to have matching signatures.
2512 if (isa<FunctionNoProtoType>(OldQType.getTypePtr()) ||
2513 isa<FunctionNoProtoType>(NewQType.getTypePtr()))
2514 return true;
2515
2516 FunctionProtoType* OldType = cast<FunctionProtoType>(OldQType);
2517 FunctionProtoType* NewType = cast<FunctionProtoType>(NewQType);
2518
2519 // The signature of a function includes the types of its
2520 // parameters (C++ 1.3.10), which includes the presence or absence
2521 // of the ellipsis; see C++ DR 357).
2522 if (OldQType != NewQType &&
2523 (OldType->getNumArgs() != NewType->getNumArgs() ||
2524 OldType->isVariadic() != NewType->isVariadic() ||
2525 !std::equal(OldType->arg_type_begin(), OldType->arg_type_end(),
2526 NewType->arg_type_begin())))
2527 return false;
2528
2529#if 0
2530 // C++ [temp.over.link]p4:
2531 // The signature of a function template consists of its function
2532 // signature, its return type and its template parameter list. The names
2533 // of the template parameters are significant only for establishing the
2534 // relationship between the template parameters and the rest of the
2535 // signature.
2536 //
2537 // We check the return type and template parameter lists for function
2538 // templates first; the remaining checks follow.
2539 if (NewTemplate &&
2540 (!TemplateParameterListsAreEqual(NewTemplate->getTemplateParameters(),
2541 OldTemplate->getTemplateParameters(),
2542 TPL_TemplateMatch) ||
2543 OldType->getResultType() != NewType->getResultType()))
2544 return false;
2545#endif
2546
2547 // If the function is a class member, its signature includes the
2548 // cv-qualifiers (if any) on the function itself.
2549 //
2550 // As part of this, also check whether one of the member functions
2551 // is static, in which case they are not overloads (C++
2552 // 13.1p2). While not part of the definition of the signature,
2553 // this check is important to determine whether these functions
2554 // can be overloaded.
2555 const CXXMethodDecl* OldMethod = dyn_cast<CXXMethodDecl>(Old);
2556 const CXXMethodDecl* NewMethod = dyn_cast<CXXMethodDecl>(New);
2557 if (OldMethod && NewMethod &&
2558 !OldMethod->isStatic() && !NewMethod->isStatic() &&
2559 OldMethod->getTypeQualifiers() != NewMethod->getTypeQualifiers())
2560 return false;
2561
2562 // The signatures match; this is not an overload.
2563 return true;
2564 }
2565
2566 typedef llvm::DenseMap<const CXXMethodDecl *, const CXXMethodDecl*>
2567 ForwardUnique_t;
2568 ForwardUnique_t ForwardUnique;
2569 llvm::DenseMap<const CXXMethodDecl*, const CXXMethodDecl*> UniqueOverrider;
2570
2571 void BuildUniqueOverrider(const CXXMethodDecl *U, const CXXMethodDecl *MD) {
2572 const CXXMethodDecl *PrevU = UniqueOverrider[MD];
2573 assert(U && "no unique overrider");
2574 if (PrevU == U)
2575 return;
2576 if (PrevU != U && PrevU != 0) {
2577 // If already set, note the two sets as the same
2578 if (0)
2579 printf("%s::%s same as %s::%s\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002580 PrevU->getParent()->getNameAsString().c_str(),
2581 PrevU->getNameAsString().c_str(),
2582 U->getParent()->getNameAsString().c_str(),
2583 U->getNameAsString().c_str());
Mike Stump90181eb2010-01-26 00:05:04 +00002584 ForwardUnique[PrevU] = U;
2585 return;
2586 }
2587
2588 // Not set, set it now
2589 if (0)
2590 printf("marking %s::%s %p override as %s::%s\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002591 MD->getParent()->getNameAsString().c_str(),
2592 MD->getNameAsString().c_str(),
Mike Stump90181eb2010-01-26 00:05:04 +00002593 (void*)MD,
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002594 U->getParent()->getNameAsString().c_str(),
2595 U->getNameAsString().c_str());
Mike Stump90181eb2010-01-26 00:05:04 +00002596 UniqueOverrider[MD] = U;
2597
2598 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
2599 me = MD->end_overridden_methods(); mi != me; ++mi) {
2600 BuildUniqueOverrider(U, *mi);
2601 }
2602 }
2603
2604 void BuildUniqueOverriders(const CXXRecordDecl *RD) {
2605 if (0) printf("walking %s\n", RD->getNameAsCString());
2606 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2607 e = RD->method_end(); i != e; ++i) {
2608 const CXXMethodDecl *MD = *i;
2609 if (!MD->isVirtual())
2610 continue;
2611
2612 if (UniqueOverrider[MD] == 0) {
2613 // Only set this, if it hasn't been set yet.
2614 BuildUniqueOverrider(MD, MD);
2615 if (0)
2616 printf("top set is %s::%s %p\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002617 MD->getParent()->getNameAsString().c_str(),
2618 MD->getNameAsString().c_str(),
Mike Stump90181eb2010-01-26 00:05:04 +00002619 (void*)MD);
2620 ForwardUnique[MD] = MD;
2621 }
2622 }
2623 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2624 e = RD->bases_end(); i != e; ++i) {
2625 const CXXRecordDecl *Base =
2626 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2627 BuildUniqueOverriders(Base);
2628 }
2629 }
2630
2631 static int DclCmp(const void *p1, const void *p2) {
John McCallef3057c2010-02-13 01:04:05 +00002632 const CXXMethodDecl *MD1 = *(const CXXMethodDecl *const *)p1;
2633 const CXXMethodDecl *MD2 = *(const CXXMethodDecl *const *)p2;
2634
2635 return (DeclarationName::compare(MD1->getDeclName(), MD2->getDeclName()));
Mike Stump90181eb2010-01-26 00:05:04 +00002636 }
2637
2638 void MergeForwarding() {
2639 typedef llvm::SmallVector<const CXXMethodDecl *, 100> A_t;
2640 A_t A;
2641 for (ForwardUnique_t::iterator I = ForwardUnique.begin(),
2642 E = ForwardUnique.end(); I != E; ++I) {
2643 if (I->first == I->second)
2644 // Only add the roots of all trees
2645 A.push_back(I->first);
2646 }
2647 llvm::array_pod_sort(A.begin(), A.end(), DclCmp);
2648 for (A_t::iterator I = A.begin(),
2649 E = A.end(); I != E; ++I) {
2650 A_t::iterator J = I;
John McCallef3057c2010-02-13 01:04:05 +00002651 while (++J != E && DclCmp(I, J) == 0)
Mike Stump90181eb2010-01-26 00:05:04 +00002652 if (DclIsSame(*I, *J)) {
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002653 if (0) printf("connecting %s\n", (*I)->getNameAsString().c_str());
Mike Stump90181eb2010-01-26 00:05:04 +00002654 ForwardUnique[*J] = *I;
2655 }
2656 }
2657 }
2658
2659 const CXXMethodDecl *getUnique(const CXXMethodDecl *MD) {
2660 const CXXMethodDecl *U = UniqueOverrider[MD];
2661 assert(U && "unique overrider not found");
2662 while (ForwardUnique.count(U)) {
2663 const CXXMethodDecl *NU = ForwardUnique[U];
2664 if (NU == U) break;
2665 U = NU;
2666 }
2667 return U;
2668 }
Anders Carlsson72281172010-01-26 17:36:47 +00002669
2670 GlobalDecl getUnique(GlobalDecl GD) {
2671 const CXXMethodDecl *Unique = getUnique(cast<CXXMethodDecl>(GD.getDecl()));
2672
2673 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(Unique))
2674 return GlobalDecl(CD, GD.getCtorType());
2675
2676 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(Unique))
2677 return GlobalDecl(DD, GD.getDtorType());
2678
2679 return Unique;
Mike Stump90181eb2010-01-26 00:05:04 +00002680 }
2681
Anders Carlsson323bb042009-11-26 19:54:33 +00002682 /// getPureVirtualFn - Return the __cxa_pure_virtual function.
2683 llvm::Constant* getPureVirtualFn() {
2684 if (!PureVirtualFn) {
2685 const llvm::FunctionType *Ty =
2686 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext),
2687 /*isVarArg=*/false);
2688 PureVirtualFn = wrap(CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual"));
2689 }
2690
2691 return PureVirtualFn;
2692 }
2693
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002694public:
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002695 OldVtableBuilder(const CXXRecordDecl *MostDerivedClass,
Eli Friedman6c08ce72009-12-05 01:05:03 +00002696 const CXXRecordDecl *l, uint64_t lo, CodeGenModule &cgm,
Anders Carlssona864caf2010-03-23 04:11:45 +00002697 bool build, CodeGenVTables::AddressPointsMapTy& AddressPoints)
Eli Friedman6c08ce72009-12-05 01:05:03 +00002698 : BuildVtable(build), MostDerivedClass(MostDerivedClass), LayoutClass(l),
2699 LayoutOffset(lo), BLayout(cgm.getContext().getASTRecordLayout(l)),
2700 rtti(0), VMContext(cgm.getModule().getContext()),CGM(cgm),
2701 PureVirtualFn(0),
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002702 subAddressPoints(AllocAddressPoint(cgm, l, MostDerivedClass)),
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002703 AddressPoints(AddressPoints),
2704 LLVMPointerWidth(cgm.getContext().Target.getPointerWidth(0))
2705 {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002706 Ptr8Ty = llvm::PointerType::get(llvm::Type::getInt8Ty(VMContext), 0);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002707 if (BuildVtable) {
2708 QualType ClassType = CGM.getContext().getTagDeclType(MostDerivedClass);
2709 rtti = CGM.GetAddrOfRTTIDescriptor(ClassType);
2710 }
Mike Stump90181eb2010-01-26 00:05:04 +00002711 BuildUniqueOverriders(MostDerivedClass);
2712 MergeForwarding();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002713 }
2714
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002715 // getVtableComponents - Returns a reference to the vtable components.
2716 const VtableComponentsVectorTy &getVtableComponents() const {
2717 return VtableComponents;
Anders Carlsson472404f2009-12-04 16:19:30 +00002718 }
2719
Anders Carlssone36a6b32010-01-02 01:01:18 +00002720 llvm::DenseMap<const CXXRecordDecl *, uint64_t> &getVBIndex()
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002721 { return VBIndex; }
2722
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002723 SavedAdjustmentsVectorTy &getSavedAdjustments()
2724 { return SavedAdjustments; }
Eli Friedman8174f2c2009-12-06 22:01:30 +00002725
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002726 llvm::Constant *wrap(Index_t i) {
2727 llvm::Constant *m;
2728 m = llvm::ConstantInt::get(llvm::Type::getInt64Ty(VMContext), i);
2729 return llvm::ConstantExpr::getIntToPtr(m, Ptr8Ty);
2730 }
2731
2732 llvm::Constant *wrap(llvm::Constant *m) {
2733 return llvm::ConstantExpr::getBitCast(m, Ptr8Ty);
2734 }
2735
Mike Stumpd2808442010-01-22 02:51:26 +00002736//#define D1(x)
Douglas Gregorf4f2e022010-02-22 16:48:26 +00002737#define D1(X) do { if (getenv("CLANG_VTABLE_DEBUG")) { X; } } while (0)
Mike Stump75ce5732009-10-31 20:06:59 +00002738
2739 void GenerateVBaseOffsets(const CXXRecordDecl *RD, uint64_t Offset,
Mike Stump28431212009-10-13 22:54:56 +00002740 bool updateVBIndex, Index_t current_vbindex) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002741 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2742 e = RD->bases_end(); i != e; ++i) {
2743 const CXXRecordDecl *Base =
2744 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump28431212009-10-13 22:54:56 +00002745 Index_t next_vbindex = current_vbindex;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002746 if (i->isVirtual() && !SeenVBase.count(Base)) {
2747 SeenVBase.insert(Base);
Mike Stump28431212009-10-13 22:54:56 +00002748 if (updateVBIndex) {
Mike Stump75ce5732009-10-31 20:06:59 +00002749 next_vbindex = (ssize_t)(-(VCalls.size()*LLVMPointerWidth/8)
Mike Stump28431212009-10-13 22:54:56 +00002750 - 3*LLVMPointerWidth/8);
2751 VBIndex[Base] = next_vbindex;
2752 }
Mike Stump75ce5732009-10-31 20:06:59 +00002753 int64_t BaseOffset = -(Offset/8) + BLayout.getVBaseClassOffset(Base)/8;
2754 VCalls.push_back((0?700:0) + BaseOffset);
2755 D1(printf(" vbase for %s at %d delta %d most derived %s\n",
2756 Base->getNameAsCString(),
2757 (int)-VCalls.size()-3, (int)BaseOffset,
Mike Stumpd2808442010-01-22 02:51:26 +00002758 MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002759 }
Mike Stump28431212009-10-13 22:54:56 +00002760 // We also record offsets for non-virtual bases to closest enclosing
2761 // virtual base. We do this so that we don't have to search
2762 // for the nearst virtual base class when generating thunks.
2763 if (updateVBIndex && VBIndex.count(Base) == 0)
2764 VBIndex[Base] = next_vbindex;
Mike Stump75ce5732009-10-31 20:06:59 +00002765 GenerateVBaseOffsets(Base, Offset, updateVBIndex, next_vbindex);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002766 }
2767 }
2768
2769 void StartNewTable() {
2770 SeenVBase.clear();
2771 }
2772
Mike Stump8bccbfd2009-10-15 09:30:16 +00002773 Index_t getNVOffset_1(const CXXRecordDecl *D, const CXXRecordDecl *B,
2774 Index_t Offset = 0) {
2775
2776 if (B == D)
2777 return Offset;
2778
2779 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(D);
2780 for (CXXRecordDecl::base_class_const_iterator i = D->bases_begin(),
2781 e = D->bases_end(); i != e; ++i) {
2782 const CXXRecordDecl *Base =
2783 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2784 int64_t BaseOffset = 0;
2785 if (!i->isVirtual())
2786 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
2787 int64_t o = getNVOffset_1(Base, B, BaseOffset);
2788 if (o >= 0)
2789 return o;
2790 }
2791
2792 return -1;
2793 }
2794
2795 /// getNVOffset - Returns the non-virtual offset for the given (B) base of the
2796 /// derived class D.
2797 Index_t getNVOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00002798 qD = qD->getPointeeType();
2799 qB = qB->getPointeeType();
Mike Stump8bccbfd2009-10-15 09:30:16 +00002800 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
2801 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
2802 int64_t o = getNVOffset_1(D, B);
2803 if (o >= 0)
2804 return o;
2805
2806 assert(false && "FIXME: non-virtual base not found");
2807 return 0;
2808 }
2809
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002810 /// getVbaseOffset - Returns the index into the vtable for the virtual base
2811 /// offset for the given (B) virtual base of the derived class D.
2812 Index_t getVbaseOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00002813 qD = qD->getPointeeType();
2814 qB = qB->getPointeeType();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002815 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
2816 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002817 if (D != MostDerivedClass)
Anders Carlssona864caf2010-03-23 04:11:45 +00002818 return CGM.getVTables().getVirtualBaseOffsetOffset(D, B);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002819 llvm::DenseMap<const CXXRecordDecl *, Index_t>::iterator i;
2820 i = VBIndex.find(B);
2821 if (i != VBIndex.end())
2822 return i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002823
Mike Stump28431212009-10-13 22:54:56 +00002824 assert(false && "FIXME: Base not found");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002825 return 0;
2826 }
2827
Eli Friedman81fb0d22009-12-04 08:40:51 +00002828 bool OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
2829 Index_t OverrideOffset, Index_t Offset,
2830 int64_t CurrentVBaseOffset);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002831
Anders Carlsson495634e2009-12-04 02:39:04 +00002832 /// AppendMethods - Append the current methods to the vtable.
Anders Carlssonddf42c82009-12-04 02:56:03 +00002833 void AppendMethodsToVtable();
Anders Carlsson495634e2009-12-04 02:39:04 +00002834
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002835 llvm::Constant *WrapAddrOf(GlobalDecl GD) {
2836 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2837
Anders Carlsson64457732009-11-24 05:08:52 +00002838 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVtable(MD);
Mike Stump18e8b472009-10-27 23:36:26 +00002839
Mike Stumpcdeb8002009-12-03 16:55:20 +00002840 return wrap(CGM.GetAddrOfFunction(GD, Ty));
Mike Stump18e8b472009-10-27 23:36:26 +00002841 }
2842
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002843 void OverrideMethods(Path_t *Path, bool MorallyVirtual, int64_t Offset,
2844 int64_t CurrentVBaseOffset) {
Mike Stump37dbe962009-10-15 02:04:03 +00002845 for (Path_t::reverse_iterator i = Path->rbegin(),
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002846 e = Path->rend(); i != e; ++i) {
2847 const CXXRecordDecl *RD = i->first;
Mike Stump8bccbfd2009-10-15 09:30:16 +00002848 int64_t OverrideOffset = i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002849 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
2850 ++mi) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002851 const CXXMethodDecl *MD = *mi;
2852
2853 if (!MD->isVirtual())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002854 continue;
2855
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002856 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2857 // Override both the complete and the deleting destructor.
2858 GlobalDecl CompDtor(DD, Dtor_Complete);
Eli Friedman81fb0d22009-12-04 08:40:51 +00002859 OverrideMethod(CompDtor, MorallyVirtual, OverrideOffset, Offset,
2860 CurrentVBaseOffset);
2861
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002862 GlobalDecl DeletingDtor(DD, Dtor_Deleting);
Eli Friedman81fb0d22009-12-04 08:40:51 +00002863 OverrideMethod(DeletingDtor, MorallyVirtual, OverrideOffset, Offset,
2864 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002865 } else {
Eli Friedman81fb0d22009-12-04 08:40:51 +00002866 OverrideMethod(MD, MorallyVirtual, OverrideOffset, Offset,
2867 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002868 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002869 }
2870 }
2871 }
2872
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002873 void AddMethod(const GlobalDecl GD, bool MorallyVirtual, Index_t Offset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002874 int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002875 // If we can find a previously allocated slot for this, reuse it.
Eli Friedman81fb0d22009-12-04 08:40:51 +00002876 if (OverrideMethod(GD, MorallyVirtual, Offset, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002877 CurrentVBaseOffset))
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002878 return;
2879
Mike Stump1f49d652010-01-22 18:48:47 +00002880 D1(printf(" vfn for %s at %d\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002881 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsString().c_str(),
Mike Stump1f49d652010-01-22 18:48:47 +00002882 (int)Methods.size()));
2883
Anders Carlssoncdf18982009-12-04 02:08:24 +00002884 // We didn't find an entry in the vtable that we could use, add a new
2885 // entry.
2886 Methods.AddMethod(GD);
2887
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002888 VCallOffset[GD] = Offset/8 - CurrentVBaseOffset/8;
2889
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002890 if (MorallyVirtual) {
Anders Carlsson72281172010-01-26 17:36:47 +00002891 GlobalDecl UGD = getUnique(GD);
2892 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
2893
Mike Stump90181eb2010-01-26 00:05:04 +00002894 assert(UMD && "final overrider not found");
2895
2896 Index_t &idx = VCall[UMD];
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002897 // Allocate the first one, after that, we reuse the previous one.
2898 if (idx == 0) {
Anders Carlsson72281172010-01-26 17:36:47 +00002899 VCallOffsetForVCall[UGD] = Offset/8;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002900 NonVirtualOffset[UMD] = Offset/8 - CurrentVBaseOffset/8;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002901 idx = VCalls.size()+1;
Mike Stump90181eb2010-01-26 00:05:04 +00002902 VCalls.push_back(Offset/8 - CurrentVBaseOffset/8);
Mike Stump75ce5732009-10-31 20:06:59 +00002903 D1(printf(" vcall for %s at %d with delta %d\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002904 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsString().c_str(),
Mike Stump90181eb2010-01-26 00:05:04 +00002905 (int)-VCalls.size()-3, (int)VCalls[idx-1]));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002906 }
2907 }
2908 }
2909
2910 void AddMethods(const CXXRecordDecl *RD, bool MorallyVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002911 Index_t Offset, int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002912 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002913 ++mi) {
2914 const CXXMethodDecl *MD = *mi;
2915 if (!MD->isVirtual())
2916 continue;
2917
2918 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2919 // For destructors, add both the complete and the deleting destructor
2920 // to the vtable.
2921 AddMethod(GlobalDecl(DD, Dtor_Complete), MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002922 CurrentVBaseOffset);
Eli Friedman03aa2f12009-11-30 01:19:33 +00002923 AddMethod(GlobalDecl(DD, Dtor_Deleting), MorallyVirtual, Offset,
2924 CurrentVBaseOffset);
2925 } else
2926 AddMethod(MD, MorallyVirtual, Offset, CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002927 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002928 }
2929
2930 void NonVirtualBases(const CXXRecordDecl *RD, const ASTRecordLayout &Layout,
2931 const CXXRecordDecl *PrimaryBase,
2932 bool PrimaryBaseWasVirtual, bool MorallyVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002933 int64_t Offset, int64_t CurrentVBaseOffset,
2934 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00002935 Path->push_back(std::make_pair(RD, Offset));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002936 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2937 e = RD->bases_end(); i != e; ++i) {
2938 if (i->isVirtual())
2939 continue;
2940 const CXXRecordDecl *Base =
2941 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump9eb76d42010-01-22 06:45:05 +00002942 uint64_t o = Offset + Layout.getBaseClassOffset(Base);
2943 StartNewTable();
2944 GenerateVtableForBase(Base, o, MorallyVirtual, false,
2945 true, Base == PrimaryBase && !PrimaryBaseWasVirtual,
2946 CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002947 }
Mike Stump37dbe962009-10-15 02:04:03 +00002948 Path->pop_back();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002949 }
2950
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002951// #define D(X) do { X; } while (0)
2952#define D(X)
2953
2954 void insertVCalls(int InsertionPoint) {
Mike Stump75ce5732009-10-31 20:06:59 +00002955 D1(printf("============= combining vbase/vcall\n"));
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002956 D(VCalls.insert(VCalls.begin(), 673));
2957 D(VCalls.push_back(672));
Eli Friedman6c08ce72009-12-05 01:05:03 +00002958
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002959 VtableComponents.insert(VtableComponents.begin() + InsertionPoint,
2960 VCalls.size(), 0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002961 if (BuildVtable) {
2962 // The vcalls come first...
2963 for (std::vector<Index_t>::reverse_iterator i = VCalls.rbegin(),
2964 e = VCalls.rend();
2965 i != e; ++i)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002966 VtableComponents[InsertionPoint++] = wrap((0?600:0) + *i);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002967 }
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002968 VCalls.clear();
Mike Stump9f23a142009-11-10 02:30:51 +00002969 VCall.clear();
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002970 VCallOffsetForVCall.clear();
2971 VCallOffset.clear();
2972 NonVirtualOffset.clear();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002973 }
2974
Mike Stump559387f2009-11-13 23:13:20 +00002975 void AddAddressPoints(const CXXRecordDecl *RD, uint64_t Offset,
2976 Index_t AddressPoint) {
2977 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002978 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00002979 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00002980 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002981 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00002982
2983 // Now also add the address point for all our primary bases.
2984 while (1) {
2985 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2986 RD = Layout.getPrimaryBase();
2987 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2988 // FIXME: Double check this.
2989 if (RD == 0)
2990 break;
2991 if (PrimaryBaseWasVirtual &&
2992 BLayout.getVBaseClassOffset(RD) != Offset)
2993 break;
2994 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002995 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00002996 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00002997 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002998 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00002999 }
3000 }
3001
3002
Mike Stumpd538a6d2009-12-24 07:29:41 +00003003 void FinishGenerateVtable(const CXXRecordDecl *RD,
3004 const ASTRecordLayout &Layout,
3005 const CXXRecordDecl *PrimaryBase,
Mike Stump9eb76d42010-01-22 06:45:05 +00003006 bool ForNPNVBases, bool WasPrimaryBase,
Mike Stumpd538a6d2009-12-24 07:29:41 +00003007 bool PrimaryBaseWasVirtual,
3008 bool MorallyVirtual, int64_t Offset,
3009 bool ForVirtualBase, int64_t CurrentVBaseOffset,
3010 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00003011 bool alloc = false;
3012 if (Path == 0) {
3013 alloc = true;
3014 Path = new Path_t;
3015 }
3016
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003017 StartNewTable();
3018 extra = 0;
Mike Stump9eb76d42010-01-22 06:45:05 +00003019 Index_t AddressPoint = 0;
3020 int VCallInsertionPoint = 0;
3021 if (!ForNPNVBases || !WasPrimaryBase) {
3022 bool DeferVCalls = MorallyVirtual || ForVirtualBase;
3023 VCallInsertionPoint = VtableComponents.size();
3024 if (!DeferVCalls) {
3025 insertVCalls(VCallInsertionPoint);
3026 } else
3027 // FIXME: just for extra, or for all uses of VCalls.size post this?
3028 extra = -VCalls.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003029
Mike Stump9eb76d42010-01-22 06:45:05 +00003030 // Add the offset to top.
3031 VtableComponents.push_back(BuildVtable ? wrap(-((Offset-LayoutOffset)/8)) : 0);
Anders Carlsson472404f2009-12-04 16:19:30 +00003032
Mike Stump9eb76d42010-01-22 06:45:05 +00003033 // Add the RTTI information.
3034 VtableComponents.push_back(rtti);
Anders Carlsson472404f2009-12-04 16:19:30 +00003035
Mike Stump9eb76d42010-01-22 06:45:05 +00003036 AddressPoint = VtableComponents.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003037
Mike Stump9eb76d42010-01-22 06:45:05 +00003038 AppendMethodsToVtable();
3039 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003040
3041 // and then the non-virtual bases.
3042 NonVirtualBases(RD, Layout, PrimaryBase, PrimaryBaseWasVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003043 MorallyVirtual, Offset, CurrentVBaseOffset, Path);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003044
3045 if (ForVirtualBase) {
Mike Stump2cefe382009-11-12 20:47:57 +00003046 // FIXME: We're adding to VCalls in callers, we need to do the overrides
3047 // in the inner part, so that we know the complete set of vcalls during
3048 // the build and don't have to insert into methods. Saving out the
3049 // AddressPoint here, would need to be fixed, if we didn't do that. Also
3050 // retroactively adding vcalls for overrides later wind up in the wrong
3051 // place, the vcall slot has to be alloted during the walk of the base
3052 // when the function is first introduces.
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003053 AddressPoint += VCalls.size();
Mike Stump2cefe382009-11-12 20:47:57 +00003054 insertVCalls(VCallInsertionPoint);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003055 }
3056
Mike Stump9eb76d42010-01-22 06:45:05 +00003057 if (!ForNPNVBases || !WasPrimaryBase)
3058 AddAddressPoints(RD, Offset, AddressPoint);
Mike Stump2cefe382009-11-12 20:47:57 +00003059
Mike Stump37dbe962009-10-15 02:04:03 +00003060 if (alloc) {
3061 delete Path;
3062 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003063 }
3064
Mike Stump75ce5732009-10-31 20:06:59 +00003065 void Primaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
3066 bool updateVBIndex, Index_t current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00003067 int64_t CurrentVBaseOffset) {
Mike Stump75ce5732009-10-31 20:06:59 +00003068 if (!RD->isDynamicClass())
3069 return;
3070
3071 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3072 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3073 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
3074
3075 // vtables are composed from the chain of primaries.
Eli Friedman65d87222009-12-04 08:52:11 +00003076 if (PrimaryBase && !PrimaryBaseWasVirtual) {
Mike Stump75ce5732009-10-31 20:06:59 +00003077 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003078 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Eli Friedman65d87222009-12-04 08:52:11 +00003079 Primaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
3080 updateVBIndex, current_vbindex, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00003081 }
3082
3083 D1(printf(" doing vcall entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003084 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00003085
3086 // And add the virtuals for the class to the primary vtable.
Eli Friedman03aa2f12009-11-30 01:19:33 +00003087 AddMethods(RD, MorallyVirtual, Offset, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00003088 }
3089
3090 void VBPrimaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
3091 bool updateVBIndex, Index_t current_vbindex,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003092 bool RDisVirtualBase, int64_t CurrentVBaseOffset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00003093 bool bottom) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003094 if (!RD->isDynamicClass())
3095 return;
3096
3097 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3098 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3099 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
3100
3101 // vtables are composed from the chain of primaries.
3102 if (PrimaryBase) {
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003103 int BaseCurrentVBaseOffset = CurrentVBaseOffset;
3104 if (PrimaryBaseWasVirtual) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003105 IndirectPrimary.insert(PrimaryBase);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003106 BaseCurrentVBaseOffset = BLayout.getVBaseClassOffset(PrimaryBase);
3107 }
Mike Stump75ce5732009-10-31 20:06:59 +00003108
3109 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003110 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00003111
3112 VBPrimaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003113 updateVBIndex, current_vbindex, PrimaryBaseWasVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00003114 BaseCurrentVBaseOffset, false);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003115 }
3116
Mike Stump75ce5732009-10-31 20:06:59 +00003117 D1(printf(" doing vbase entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003118 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00003119 GenerateVBaseOffsets(RD, Offset, updateVBIndex, current_vbindex);
3120
3121 if (RDisVirtualBase || bottom) {
3122 Primaries(RD, MorallyVirtual, Offset, updateVBIndex, current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00003123 CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00003124 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003125 }
3126
Mike Stumpd538a6d2009-12-24 07:29:41 +00003127 void GenerateVtableForBase(const CXXRecordDecl *RD, int64_t Offset = 0,
3128 bool MorallyVirtual = false,
3129 bool ForVirtualBase = false,
Mike Stump9eb76d42010-01-22 06:45:05 +00003130 bool ForNPNVBases = false,
3131 bool WasPrimaryBase = true,
Mike Stumpd538a6d2009-12-24 07:29:41 +00003132 int CurrentVBaseOffset = 0,
3133 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003134 if (!RD->isDynamicClass())
Mike Stumpd538a6d2009-12-24 07:29:41 +00003135 return;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003136
Mike Stumpfa818082009-11-13 02:35:38 +00003137 // Construction vtable don't need parts that have no virtual bases and
3138 // aren't morally virtual.
Anders Carlssonbad80eb2009-12-04 18:36:22 +00003139 if ((LayoutClass != MostDerivedClass) &&
3140 RD->getNumVBases() == 0 && !MorallyVirtual)
Mike Stumpd538a6d2009-12-24 07:29:41 +00003141 return;
Mike Stumpfa818082009-11-13 02:35:38 +00003142
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003143 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3144 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3145 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
3146
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003147 extra = 0;
Mike Stump75ce5732009-10-31 20:06:59 +00003148 D1(printf("building entries for base %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003149 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003150
Mike Stump75ce5732009-10-31 20:06:59 +00003151 if (ForVirtualBase)
3152 extra = VCalls.size();
3153
Mike Stump9eb76d42010-01-22 06:45:05 +00003154 if (!ForNPNVBases || !WasPrimaryBase) {
3155 VBPrimaries(RD, MorallyVirtual, Offset, !ForVirtualBase, 0,
3156 ForVirtualBase, CurrentVBaseOffset, true);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003157
Mike Stump9eb76d42010-01-22 06:45:05 +00003158 if (Path)
3159 OverrideMethods(Path, MorallyVirtual, Offset, CurrentVBaseOffset);
3160 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003161
Mike Stump9eb76d42010-01-22 06:45:05 +00003162 FinishGenerateVtable(RD, Layout, PrimaryBase, ForNPNVBases, WasPrimaryBase,
3163 PrimaryBaseWasVirtual, MorallyVirtual, Offset,
3164 ForVirtualBase, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003165 }
3166
3167 void GenerateVtableForVBases(const CXXRecordDecl *RD,
3168 int64_t Offset = 0,
Mike Stump37dbe962009-10-15 02:04:03 +00003169 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003170 bool alloc = false;
3171 if (Path == 0) {
3172 alloc = true;
Mike Stump37dbe962009-10-15 02:04:03 +00003173 Path = new Path_t;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003174 }
3175 // FIXME: We also need to override using all paths to a virtual base,
3176 // right now, we just process the first path
3177 Path->push_back(std::make_pair(RD, Offset));
3178 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
3179 e = RD->bases_end(); i != e; ++i) {
3180 const CXXRecordDecl *Base =
3181 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
3182 if (i->isVirtual() && !IndirectPrimary.count(Base)) {
3183 // Mark it so we don't output it twice.
3184 IndirectPrimary.insert(Base);
3185 StartNewTable();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003186 VCall.clear();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003187 int64_t BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003188 int64_t CurrentVBaseOffset = BaseOffset;
Mike Stump75ce5732009-10-31 20:06:59 +00003189 D1(printf("vtable %s virtual base %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003190 MostDerivedClass->getNameAsCString(), Base->getNameAsCString()));
Mike Stump9eb76d42010-01-22 06:45:05 +00003191 GenerateVtableForBase(Base, BaseOffset, true, true, false,
3192 true, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003193 }
Mike Stump2cefe382009-11-12 20:47:57 +00003194 int64_t BaseOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003195 if (i->isVirtual())
3196 BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stump2cefe382009-11-12 20:47:57 +00003197 else {
3198 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3199 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
3200 }
3201
Mike Stump37dbe962009-10-15 02:04:03 +00003202 if (Base->getNumVBases()) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003203 GenerateVtableForVBases(Base, BaseOffset, Path);
Mike Stump37dbe962009-10-15 02:04:03 +00003204 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003205 }
3206 Path->pop_back();
3207 if (alloc)
3208 delete Path;
3209 }
3210};
Anders Carlssonca1bf682009-12-03 01:54:02 +00003211} // end anonymous namespace
3212
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003213bool OldVtableBuilder::OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
Eli Friedman81fb0d22009-12-04 08:40:51 +00003214 Index_t OverrideOffset, Index_t Offset,
3215 int64_t CurrentVBaseOffset) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00003216 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
3217
3218 const bool isPure = MD->isPure();
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00003219
Anders Carlssonca1bf682009-12-03 01:54:02 +00003220 // FIXME: Should OverrideOffset's be Offset?
3221
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00003222 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
3223 e = MD->end_overridden_methods(); mi != e; ++mi) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00003224 GlobalDecl OGD;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003225 GlobalDecl OGD2;
Anders Carlssonca1bf682009-12-03 01:54:02 +00003226
Anders Carlssonf3935b42009-12-04 05:51:56 +00003227 const CXXMethodDecl *OMD = *mi;
Anders Carlssonca1bf682009-12-03 01:54:02 +00003228 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(OMD))
3229 OGD = GlobalDecl(DD, GD.getDtorType());
3230 else
3231 OGD = OMD;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003232
Eli Friedman8174f2c2009-12-06 22:01:30 +00003233 // Check whether this is the method being overridden in this section of
3234 // the vtable.
Anders Carlsson7bb70762009-12-04 15:49:02 +00003235 uint64_t Index;
3236 if (!Methods.getIndex(OGD, Index))
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003237 continue;
3238
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003239 OGD2 = OGD;
3240
Eli Friedman8174f2c2009-12-06 22:01:30 +00003241 // Get the original method, which we should be computing thunks, etc,
3242 // against.
3243 OGD = Methods.getOrigMethod(Index);
3244 OMD = cast<CXXMethodDecl>(OGD.getDecl());
3245
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003246 QualType ReturnType =
3247 MD->getType()->getAs<FunctionType>()->getResultType();
3248 QualType OverriddenReturnType =
3249 OMD->getType()->getAs<FunctionType>()->getResultType();
Anders Carlssonca1bf682009-12-03 01:54:02 +00003250
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003251 // Check if we need a return type adjustment.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00003252 if (!ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
3253 OMD).isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003254 CanQualType &BaseReturnType = BaseReturnTypes[Index];
Anders Carlssonca1bf682009-12-03 01:54:02 +00003255
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003256 // Insert the base return type.
3257 if (BaseReturnType.isNull())
3258 BaseReturnType =
3259 CGM.getContext().getCanonicalType(OverriddenReturnType);
3260 }
Anders Carlssona93e9802009-12-04 03:52:52 +00003261
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003262 Methods.OverrideMethod(OGD, GD);
3263
Anders Carlsson72281172010-01-26 17:36:47 +00003264 GlobalDecl UGD = getUnique(GD);
3265 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
3266 assert(UGD.getDecl() && "unique overrider not found");
3267 assert(UGD == getUnique(OGD) && "unique overrider not unique");
Mike Stump90181eb2010-01-26 00:05:04 +00003268
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003269 ThisAdjustments.erase(Index);
Mike Stump90181eb2010-01-26 00:05:04 +00003270 if (MorallyVirtual || VCall.count(UMD)) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003271
Mike Stump90181eb2010-01-26 00:05:04 +00003272 Index_t &idx = VCall[UMD];
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003273 if (idx == 0) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003274 VCallOffset[GD] = VCallOffset[OGD];
3275 // NonVirtualOffset[UMD] = CurrentVBaseOffset/8 - OverrideOffset/8;
3276 NonVirtualOffset[UMD] = VCallOffset[OGD];
Mike Stump77537b12010-01-26 03:42:22 +00003277 VCallOffsetForVCall[UMD] = OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003278 idx = VCalls.size()+1;
Mike Stump77537b12010-01-26 03:42:22 +00003279 VCalls.push_back(OverrideOffset/8 - CurrentVBaseOffset/8);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003280 D1(printf(" vcall for %s at %d with delta %d most derived %s\n",
3281 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00003282 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003283 } else {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003284 VCallOffset[GD] = NonVirtualOffset[UMD];
Anders Carlsson72281172010-01-26 17:36:47 +00003285 VCalls[idx-1] = -VCallOffsetForVCall[UGD] + OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003286 D1(printf(" vcall patch for %s at %d with delta %d most derived %s\n",
3287 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00003288 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003289 }
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003290 int64_t NonVirtualAdjustment = -VCallOffset[OGD];
Mike Stumpded0a402010-01-26 22:44:01 +00003291 QualType DerivedType = MD->getThisType(CGM.getContext());
3292 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
3293 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
3294 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
3295 NonVirtualAdjustment = NonVirtualAdjustment2;
3296 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003297 int64_t VirtualAdjustment =
3298 -((idx + extra + 2) * LLVMPointerWidth / 8);
Anders Carlsson657f1392009-12-03 02:32:59 +00003299
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003300 // Optimize out virtual adjustments of 0.
3301 if (VCalls[idx-1] == 0)
3302 VirtualAdjustment = 0;
Anders Carlsson657f1392009-12-03 02:32:59 +00003303
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003304 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment,
3305 VirtualAdjustment);
Anders Carlsson2ca285f2009-12-03 02:22:59 +00003306
Eli Friedman8174f2c2009-12-06 22:01:30 +00003307 if (!isPure && !ThisAdjustment.isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003308 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003309 SavedAdjustments.push_back(
3310 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedman8174f2c2009-12-06 22:01:30 +00003311 }
Anders Carlssonca1bf682009-12-03 01:54:02 +00003312 return true;
3313 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003314
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003315 VCallOffset[GD] = VCallOffset[OGD2] - OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003316
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003317 int64_t NonVirtualAdjustment = -VCallOffset[GD];
3318 QualType DerivedType = MD->getThisType(CGM.getContext());
3319 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
3320 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
3321 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
3322 NonVirtualAdjustment = NonVirtualAdjustment2;
3323 }
3324
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003325 if (NonVirtualAdjustment) {
3326 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment, 0);
3327
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00003328 if (!isPure) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003329 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003330 SavedAdjustments.push_back(
3331 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00003332 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003333 }
3334 return true;
Anders Carlssonca1bf682009-12-03 01:54:02 +00003335 }
3336
3337 return false;
Anders Carlssond59885022009-11-27 22:21:51 +00003338}
3339
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003340void OldVtableBuilder::AppendMethodsToVtable() {
Eli Friedman6c08ce72009-12-05 01:05:03 +00003341 if (!BuildVtable) {
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003342 VtableComponents.insert(VtableComponents.end(), Methods.size(),
3343 (llvm::Constant *)0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00003344 ThisAdjustments.clear();
3345 BaseReturnTypes.clear();
3346 Methods.clear();
3347 return;
3348 }
3349
Anders Carlsson472404f2009-12-04 16:19:30 +00003350 // Reserve room in the vtable for our new methods.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003351 VtableComponents.reserve(VtableComponents.size() + Methods.size());
Anders Carlssonb07567c2009-12-04 03:07:26 +00003352
Anders Carlsson86809cd2009-12-04 02:43:50 +00003353 for (unsigned i = 0, e = Methods.size(); i != e; ++i) {
3354 GlobalDecl GD = Methods[i];
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003355 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
3356
3357 // Get the 'this' pointer adjustment.
Anders Carlsson86809cd2009-12-04 02:43:50 +00003358 ThunkAdjustment ThisAdjustment = ThisAdjustments.lookup(i);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003359
3360 // Construct the return type adjustment.
3361 ThunkAdjustment ReturnAdjustment;
3362
3363 QualType BaseReturnType = BaseReturnTypes.lookup(i);
3364 if (!BaseReturnType.isNull() && !MD->isPure()) {
3365 QualType DerivedType =
3366 MD->getType()->getAs<FunctionType>()->getResultType();
3367
3368 int64_t NonVirtualAdjustment =
3369 getNVOffset(BaseReturnType, DerivedType) / 8;
3370
3371 int64_t VirtualAdjustment =
3372 getVbaseOffset(BaseReturnType, DerivedType);
3373
3374 ReturnAdjustment = ThunkAdjustment(NonVirtualAdjustment,
3375 VirtualAdjustment);
3376 }
3377
Anders Carlsson50f14742009-12-04 03:06:03 +00003378 llvm::Constant *Method = 0;
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003379 if (!ReturnAdjustment.isEmpty()) {
3380 // Build a covariant thunk.
3381 CovariantThunkAdjustment Adjustment(ThisAdjustment, ReturnAdjustment);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003382 Method = wrap(CGM.GetAddrOfCovariantThunk(GD, Adjustment));
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003383 } else if (!ThisAdjustment.isEmpty()) {
3384 // Build a "regular" thunk.
Eli Friedman8174f2c2009-12-06 22:01:30 +00003385 Method = wrap(CGM.GetAddrOfThunk(GD, ThisAdjustment));
Anders Carlssonddf42c82009-12-04 02:56:03 +00003386 } else if (MD->isPure()) {
3387 // We have a pure virtual method.
Anders Carlsson50f14742009-12-04 03:06:03 +00003388 Method = getPureVirtualFn();
3389 } else {
3390 // We have a good old regular method.
3391 Method = WrapAddrOf(GD);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003392 }
Anders Carlsson50f14742009-12-04 03:06:03 +00003393
3394 // Add the method to the vtable.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003395 VtableComponents.push_back(Method);
Anders Carlsson86809cd2009-12-04 02:43:50 +00003396 }
3397
Anders Carlsson50f14742009-12-04 03:06:03 +00003398
Anders Carlsson86809cd2009-12-04 02:43:50 +00003399 ThisAdjustments.clear();
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003400 BaseReturnTypes.clear();
Anders Carlsson86809cd2009-12-04 02:43:50 +00003401
Anders Carlsson495634e2009-12-04 02:39:04 +00003402 Methods.clear();
Anders Carlsson495634e2009-12-04 02:39:04 +00003403}
3404
Anders Carlssona864caf2010-03-23 04:11:45 +00003405void CodeGenVTables::ComputeMethodVtableIndices(const CXXRecordDecl *RD) {
Anders Carlssonf942ee02009-11-27 20:47:55 +00003406
3407 // Itanium C++ ABI 2.5.2:
Anders Carlsson259688c2010-02-02 03:37:46 +00003408 // The order of the virtual function pointers in a virtual table is the
3409 // order of declaration of the corresponding member functions in the class.
Anders Carlssonf942ee02009-11-27 20:47:55 +00003410 //
Anders Carlsson259688c2010-02-02 03:37:46 +00003411 // There is an entry for any virtual function declared in a class,
3412 // whether it is a new function or overrides a base class function,
3413 // unless it overrides a function from the primary base, and conversion
3414 // between their return types does not require an adjustment.
Anders Carlssonf942ee02009-11-27 20:47:55 +00003415
3416 int64_t CurrentIndex = 0;
3417
3418 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3419 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3420
3421 if (PrimaryBase) {
Anders Carlssonc920fa22009-11-30 19:43:26 +00003422 assert(PrimaryBase->isDefinition() &&
3423 "Should have the definition decl of the primary base!");
Anders Carlssonf942ee02009-11-27 20:47:55 +00003424
3425 // Since the record decl shares its vtable pointer with the primary base
3426 // we need to start counting at the end of the primary base's vtable.
3427 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
3428 }
Eli Friedman21517252009-12-15 03:31:17 +00003429
3430 // Collect all the primary bases, so we can check whether methods override
3431 // a method from the base.
Anders Carlssond46ed892010-02-27 16:18:19 +00003432 VtableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Eli Friedman21517252009-12-15 03:31:17 +00003433 for (ASTRecordLayout::primary_base_info_iterator
3434 I = Layout.primary_base_begin(), E = Layout.primary_base_end();
3435 I != E; ++I)
3436 PrimaryBases.insert((*I).getBase());
3437
Anders Carlssonf942ee02009-11-27 20:47:55 +00003438 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
3439
3440 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
3441 e = RD->method_end(); i != e; ++i) {
3442 const CXXMethodDecl *MD = *i;
3443
3444 // We only want virtual methods.
3445 if (!MD->isVirtual())
3446 continue;
3447
Anders Carlssonf942ee02009-11-27 20:47:55 +00003448 // Check if this method overrides a method in the primary base.
Anders Carlsson65b49782010-02-12 05:25:12 +00003449 if (const CXXMethodDecl *OverriddenMD =
Anders Carlssond2025412010-02-27 06:38:03 +00003450 OverridesMethodInBases(MD, PrimaryBases)) {
Anders Carlsson65b49782010-02-12 05:25:12 +00003451 // Check if converting from the return type of the method to the
3452 // return type of the overridden method requires conversion.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00003453 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
3454 OverriddenMD).isEmpty()) {
Anders Carlsson65b49782010-02-12 05:25:12 +00003455 // This index is shared between the index in the vtable of the primary
3456 // base class.
3457 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
3458 const CXXDestructorDecl *OverriddenDD =
3459 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00003460
Anders Carlsson65b49782010-02-12 05:25:12 +00003461 // Add both the complete and deleting entries.
3462 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] =
3463 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
3464 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] =
3465 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
3466 } else {
3467 MethodVtableIndices[MD] = getMethodVtableIndex(OverriddenMD);
3468 }
3469
3470 // We don't need to add an entry for this method.
Anders Carlsson07604812010-02-12 18:14:46 +00003471 continue;
Anders Carlssonf942ee02009-11-27 20:47:55 +00003472 }
3473 }
3474
Anders Carlssonf942ee02009-11-27 20:47:55 +00003475 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
3476 if (MD->isImplicit()) {
3477 assert(!ImplicitVirtualDtor &&
3478 "Did already see an implicit virtual dtor!");
3479 ImplicitVirtualDtor = DD;
3480 continue;
3481 }
3482
3483 // Add the complete dtor.
3484 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
3485
3486 // Add the deleting dtor.
3487 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
3488 } else {
3489 // Add the entry.
3490 MethodVtableIndices[MD] = CurrentIndex++;
3491 }
3492 }
3493
3494 if (ImplicitVirtualDtor) {
3495 // Itanium C++ ABI 2.5.2:
Anders Carlssondc2dba32010-02-16 04:49:44 +00003496 // If a class has an implicitly-defined virtual destructor,
3497 // its entries come after the declared virtual function pointers.
Anders Carlssonf942ee02009-11-27 20:47:55 +00003498
3499 // Add the complete dtor.
3500 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
3501 CurrentIndex++;
3502
3503 // Add the deleting dtor.
3504 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
3505 CurrentIndex++;
3506 }
3507
3508 NumVirtualFunctionPointers[RD] = CurrentIndex;
3509}
3510
Anders Carlssona864caf2010-03-23 04:11:45 +00003511uint64_t CodeGenVTables::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
Anders Carlssonf942ee02009-11-27 20:47:55 +00003512 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
3513 NumVirtualFunctionPointers.find(RD);
3514 if (I != NumVirtualFunctionPointers.end())
3515 return I->second;
3516
3517 ComputeMethodVtableIndices(RD);
3518
3519 I = NumVirtualFunctionPointers.find(RD);
3520 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
3521 return I->second;
3522}
3523
Anders Carlssona864caf2010-03-23 04:11:45 +00003524uint64_t CodeGenVTables::getMethodVtableIndex(GlobalDecl GD) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00003525 MethodVtableIndicesTy::iterator I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003526 if (I != MethodVtableIndices.end())
3527 return I->second;
3528
Anders Carlssonfb4dda42009-11-13 17:08:56 +00003529 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssonf942ee02009-11-27 20:47:55 +00003530
3531 ComputeMethodVtableIndices(RD);
3532
Anders Carlssonfb4dda42009-11-13 17:08:56 +00003533 I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003534 assert(I != MethodVtableIndices.end() && "Did not find index!");
3535 return I->second;
3536}
3537
Anders Carlssona864caf2010-03-23 04:11:45 +00003538CodeGenVTables::AdjustmentVectorTy*
3539CodeGenVTables::getAdjustments(GlobalDecl GD) {
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003540 SavedAdjustmentsTy::iterator I = SavedAdjustments.find(GD);
3541 if (I != SavedAdjustments.end())
3542 return &I->second;
Eli Friedman8174f2c2009-12-06 22:01:30 +00003543
3544 const CXXRecordDecl *RD = cast<CXXRecordDecl>(GD.getDecl()->getDeclContext());
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003545 if (!SavedAdjustmentRecords.insert(RD).second)
3546 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00003547
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003548 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003549 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003550 D1(printf("vtable %s\n", RD->getNameAsCString()));
3551 b.GenerateVtableForBase(RD);
3552 b.GenerateVtableForVBases(RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003553
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003554 for (OldVtableBuilder::SavedAdjustmentsVectorTy::iterator
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003555 i = b.getSavedAdjustments().begin(),
3556 e = b.getSavedAdjustments().end(); i != e; i++)
3557 SavedAdjustments[i->first].push_back(i->second);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003558
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003559 I = SavedAdjustments.find(GD);
3560 if (I != SavedAdjustments.end())
3561 return &I->second;
3562
3563 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00003564}
3565
Anders Carlssona864caf2010-03-23 04:11:45 +00003566int64_t CodeGenVTables::getVirtualBaseOffsetOffset(const CXXRecordDecl *RD,
3567 const CXXRecordDecl *VBase) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003568 ClassPairTy ClassPair(RD, VBase);
3569
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003570 VirtualBaseClassOffsetOffsetsMapTy::iterator I =
3571 VirtualBaseClassOffsetOffsets.find(ClassPair);
3572 if (I != VirtualBaseClassOffsetOffsets.end())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003573 return I->second;
3574
Anders Carlssondd819c92010-03-11 16:06:20 +00003575 VCallAndVBaseOffsetBuilder Builder(RD, RD, /*FinalOverriders=*/0,
3576 BaseSubobject(RD, 0),
3577 /*BaseIsVirtual=*/false,
3578 /*OffsetInLayoutClass=*/0);
Anders Carlssondd819c92010-03-11 16:06:20 +00003579
3580 for (VCallAndVBaseOffsetBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
3581 Builder.getVBaseOffsetOffsets().begin(),
3582 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003583 // Insert all types.
3584 ClassPairTy ClassPair(RD, I->first);
3585
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003586 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003587 }
3588
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003589 I = VirtualBaseClassOffsetOffsets.find(ClassPair);
Anders Carlssondd819c92010-03-11 16:06:20 +00003590
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00003591 // FIXME: The assertion below assertion currently fails with the old vtable
3592 /// layout code if there is a non-virtual thunk adjustment in a vtable.
3593 // Once the new layout is in place, this return should be removed.
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003594 if (I == VirtualBaseClassOffsetOffsets.end())
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00003595 return 0;
3596
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003597 assert(I != VirtualBaseClassOffsetOffsets.end() && "Did not find index!");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003598
3599 return I->second;
3600}
3601
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003602llvm::GlobalVariable *
Anders Carlssona864caf2010-03-23 04:11:45 +00003603CodeGenVTables::GenerateVtable(llvm::GlobalVariable::LinkageTypes Linkage,
3604 bool GenerateDefinition,
3605 const CXXRecordDecl *LayoutClass,
3606 const CXXRecordDecl *RD, uint64_t Offset,
3607 bool IsVirtual,
3608 AddressPointsMapTy& AddressPoints) {
Anders Carlsson93913752010-02-27 20:39:05 +00003609 if (GenerateDefinition) {
3610 if (LayoutClass == RD) {
Anders Carlsson62c6c722010-02-28 00:36:23 +00003611 assert(!IsVirtual &&
Anders Carlssond5531e22010-03-11 05:48:21 +00003612 "Can only have a virtual base in construction vtables!");
3613 assert(!Offset &&
3614 "Can only have a base offset in construction vtables!");
Anders Carlsson93913752010-02-27 20:39:05 +00003615 }
Anders Carlssond5531e22010-03-11 05:48:21 +00003616
3617 VtableBuilder Builder(*this, RD, Offset,
Anders Carlsson9f28dbc2010-03-11 06:10:52 +00003618 /*MostDerivedClassIsVirtual=*/IsVirtual,
Anders Carlssond5531e22010-03-11 05:48:21 +00003619 LayoutClass);
3620
3621 if (CGM.getLangOptions().DumpVtableLayouts)
3622 Builder.dumpLayout(llvm::errs());
Anders Carlssoneee53d92010-02-13 02:02:03 +00003623 }
3624
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003625 llvm::SmallString<256> OutName;
Mike Stump2cefe382009-11-12 20:47:57 +00003626 if (LayoutClass != RD)
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003627 CGM.getMangleContext().mangleCXXCtorVtable(LayoutClass, Offset / 8,
3628 RD, OutName);
Mike Stumpeac45592009-11-11 20:26:26 +00003629 else
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003630 CGM.getMangleContext().mangleCXXVtable(RD, OutName);
Daniel Dunbare128dd12009-11-21 09:06:22 +00003631 llvm::StringRef Name = OutName.str();
Benjamin Kramerbb0a07b2009-10-11 22:57:54 +00003632
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003633 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
Anders Carlssona864caf2010-03-23 04:11:45 +00003634 if (GV == 0 || CGM.getVTables().AddressPoints[LayoutClass] == 0 ||
Anders Carlsson93a18842010-01-02 18:02:32 +00003635 GV->isDeclaration()) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003636 OldVtableBuilder b(RD, LayoutClass, Offset, CGM, GenerateDefinition,
3637 AddressPoints);
Eli Friedman6c08ce72009-12-05 01:05:03 +00003638
3639 D1(printf("vtable %s\n", RD->getNameAsCString()));
3640 // First comes the vtables for all the non-virtual bases...
Mike Stumpd538a6d2009-12-24 07:29:41 +00003641 b.GenerateVtableForBase(RD, Offset);
Eli Friedman6c08ce72009-12-05 01:05:03 +00003642
3643 // then the vtables for all the virtual bases.
3644 b.GenerateVtableForVBases(RD, Offset);
3645
Anders Carlsson58b271d2009-12-05 22:19:10 +00003646 llvm::Constant *Init = 0;
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003647 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson58b271d2009-12-05 22:19:10 +00003648 llvm::ArrayType *ArrayType =
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003649 llvm::ArrayType::get(Int8PtrTy, b.getVtableComponents().size());
Anders Carlssona95d4c52009-12-05 21:09:05 +00003650
Anders Carlsson232324c2009-12-06 00:53:22 +00003651 if (GenerateDefinition)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003652 Init = llvm::ConstantArray::get(ArrayType, &b.getVtableComponents()[0],
3653 b.getVtableComponents().size());
Anders Carlsson232324c2009-12-06 00:53:22 +00003654
Mike Stumpaa51ad62009-11-19 04:04:36 +00003655 llvm::GlobalVariable *OGV = GV;
Anders Carlsson232324c2009-12-06 00:53:22 +00003656
3657 GV = new llvm::GlobalVariable(CGM.getModule(), ArrayType,
3658 /*isConstant=*/true, Linkage, Init, Name);
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003659 CGM.setGlobalVisibility(GV, RD);
3660
Mike Stumpaa51ad62009-11-19 04:04:36 +00003661 if (OGV) {
3662 GV->takeName(OGV);
Anders Carlsson58b271d2009-12-05 22:19:10 +00003663 llvm::Constant *NewPtr =
3664 llvm::ConstantExpr::getBitCast(GV, OGV->getType());
Mike Stumpaa51ad62009-11-19 04:04:36 +00003665 OGV->replaceAllUsesWith(NewPtr);
3666 OGV->eraseFromParent();
3667 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00003668 }
Anders Carlssonb3f54b72009-12-05 21:28:12 +00003669
3670 return GV;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003671}
Mike Stump9f23a142009-11-10 02:30:51 +00003672
Anders Carlsson917229c2010-03-23 04:59:02 +00003673void CodeGenVTables::EmitThunks(GlobalDecl GD)
3674{
3675 CGM.BuildThunksForVirtual(GD);
3676}
3677
Anders Carlssona864caf2010-03-23 04:11:45 +00003678void
3679CodeGenVTables::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
3680 const CXXRecordDecl *RD) {
Anders Carlssone1b3e622009-12-07 07:59:52 +00003681 llvm::GlobalVariable *&Vtable = Vtables[RD];
3682 if (Vtable) {
3683 assert(Vtable->getInitializer() && "Vtable doesn't have a definition!");
3684 return;
3685 }
3686
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003687 AddressPointsMapTy AddressPoints;
3688 Vtable = GenerateVtable(Linkage, /*GenerateDefinition=*/true, RD, RD, 0,
Anders Carlsson62c6c722010-02-28 00:36:23 +00003689 /*IsVirtual=*/false,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003690 AddressPoints);
Rafael Espindolae7113ca2010-03-10 02:19:29 +00003691 GenerateVTT(Linkage, /*GenerateDefinition=*/true, RD);
Mike Stump1a139f82009-11-19 01:08:19 +00003692}
3693
Anders Carlssona864caf2010-03-23 04:11:45 +00003694llvm::GlobalVariable *CodeGenVTables::getVtable(const CXXRecordDecl *RD) {
Anders Carlsson232324c2009-12-06 00:53:22 +00003695 llvm::GlobalVariable *Vtable = Vtables.lookup(RD);
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003696
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003697 if (!Vtable) {
3698 AddressPointsMapTy AddressPoints;
Anders Carlsson232324c2009-12-06 00:53:22 +00003699 Vtable = GenerateVtable(llvm::GlobalValue::ExternalLinkage,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003700 /*GenerateDefinition=*/false, RD, RD, 0,
Anders Carlsson62c6c722010-02-28 00:36:23 +00003701 /*IsVirtual=*/false, AddressPoints);
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003702 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00003703
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00003704 return Vtable;
Mike Stumpd846d082009-11-10 07:44:33 +00003705}
Mike Stumpeac45592009-11-11 20:26:26 +00003706
Anders Carlsson88410242010-03-23 04:15:00 +00003707void CodeGenVTables::EmitVTableRelatedData(GlobalDecl GD) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003708 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
3709 const CXXRecordDecl *RD = MD->getParent();
3710
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00003711 // If the class doesn't have a vtable we don't need to emit one.
3712 if (!RD->isDynamicClass())
3713 return;
3714
Anders Carlssonaf82f632010-03-23 04:31:31 +00003715 // Check if we need to emit thunks for this function.
3716 if (MD->isVirtual())
Anders Carlsson917229c2010-03-23 04:59:02 +00003717 EmitThunks(GD);
Anders Carlssonaf82f632010-03-23 04:31:31 +00003718
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003719 // Get the key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00003720 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003721
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00003722 if (KeyFunction) {
3723 // We don't have the right key function.
3724 if (KeyFunction->getCanonicalDecl() != MD->getCanonicalDecl())
3725 return;
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003726 }
3727
Rafael Espindolae7113ca2010-03-10 02:19:29 +00003728 if (Vtables.count(RD))
3729 return;
Eli Friedman8174f2c2009-12-06 22:01:30 +00003730
Rafael Espindolae7113ca2010-03-10 02:19:29 +00003731 TemplateSpecializationKind kind = RD->getTemplateSpecializationKind();
3732 if (kind == TSK_ImplicitInstantiation)
3733 CGM.DeferredVtables.push_back(RD);
3734 else
3735 GenerateClassData(CGM.getVtableLinkage(RD), RD);
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003736}
Anders Carlsson917229c2010-03-23 04:59:02 +00003737