blob: d11cbb4b802d3d4e1c36a931d61560da6fa4855a [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 Carlssoncf5a8822010-02-13 21:07:32 +00001095 /// VtableInfo - Global vtable information.
1096 CGVtableInfo &VtableInfo;
1097
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.
1136 CGVtableInfo::AddressPointsMapTy AddressPoints;
1137
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001138 /// ReturnAdjustment - A return adjustment.
Anders Carlsson5272c252010-02-12 17:37:14 +00001139 struct ReturnAdjustment {
1140 /// NonVirtual - The non-virtual adjustment from the derived object to its
1141 /// nearest virtual base.
1142 int64_t NonVirtual;
1143
Anders Carlsson78277c72010-02-18 17:00:09 +00001144 /// VBaseOffsetOffset - The offset (in bytes), relative to the address point
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001145 /// of the virtual base class offset.
1146 int64_t VBaseOffsetOffset;
Anders Carlsson5272c252010-02-12 17:37:14 +00001147
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001148 ReturnAdjustment() : NonVirtual(0), VBaseOffsetOffset(0) { }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001149
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001150 bool isEmpty() const { return !NonVirtual && !VBaseOffsetOffset; }
Anders Carlsson56446142010-03-17 20:06:32 +00001151
1152 friend bool operator==(const ReturnAdjustment &LHS,
1153 const ReturnAdjustment &RHS) {
1154 return LHS.NonVirtual == RHS.NonVirtual &&
1155 LHS.VBaseOffsetOffset == RHS.VBaseOffsetOffset;
1156 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001157 };
1158
Anders Carlssond46ed892010-02-27 16:18:19 +00001159 /// MethodInfo - Contains information about a method in a vtable.
1160 /// (Used for computing 'this' pointer adjustment thunks.
1161 struct MethodInfo {
1162 /// BaseOffset - The base offset of this method.
1163 const uint64_t BaseOffset;
1164
Anders Carlsson423406f32010-03-10 21:25:37 +00001165 /// BaseOffsetInLayoutClass - The base offset in the layout class of this
1166 /// method.
1167 const uint64_t BaseOffsetInLayoutClass;
1168
Anders Carlssond46ed892010-02-27 16:18:19 +00001169 /// VtableIndex - The index in the vtable that this method has.
1170 /// (For destructors, this is the index of the complete destructor).
1171 const uint64_t VtableIndex;
1172
Anders Carlsson423406f32010-03-10 21:25:37 +00001173 MethodInfo(uint64_t BaseOffset, uint64_t BaseOffsetInLayoutClass,
1174 uint64_t VtableIndex)
1175 : BaseOffset(BaseOffset),
1176 BaseOffsetInLayoutClass(BaseOffsetInLayoutClass),
1177 VtableIndex(VtableIndex) { }
Anders Carlsson40687982010-02-27 16:52:49 +00001178
Anders Carlsson423406f32010-03-10 21:25:37 +00001179 MethodInfo() : BaseOffset(0), BaseOffsetInLayoutClass(0), VtableIndex(0) { }
Anders Carlssond46ed892010-02-27 16:18:19 +00001180 };
1181
1182 typedef llvm::DenseMap<const CXXMethodDecl *, MethodInfo> MethodInfoMapTy;
1183
1184 /// MethodInfoMap - The information for all methods in the vtable we're
1185 /// currently building.
1186 MethodInfoMapTy MethodInfoMap;
1187
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001188 /// ThisAdjustment - A 'this' pointer adjustment thunk.
1189 struct ThisAdjustment {
1190 /// NonVirtual - The non-virtual adjustment from the derived object to its
1191 /// nearest virtual base.
1192 int64_t NonVirtual;
1193
John McCall43c6ffb2010-02-26 20:22:44 +00001194 /// VCallOffsetOffset - The offset (in bytes), relative to the address point,
Anders Carlsson78277c72010-02-18 17:00:09 +00001195 /// of the virtual call offset.
1196 int64_t VCallOffsetOffset;
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001197
Anders Carlsson78277c72010-02-18 17:00:09 +00001198 ThisAdjustment() : NonVirtual(0), VCallOffsetOffset(0) { }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001199
Anders Carlsson78277c72010-02-18 17:00:09 +00001200 bool isEmpty() const { return !NonVirtual && !VCallOffsetOffset; }
Anders Carlsson56446142010-03-17 20:06:32 +00001201
1202 friend bool operator==(const ThisAdjustment &LHS,
1203 const ThisAdjustment &RHS) {
1204 return LHS.NonVirtual == RHS.NonVirtual &&
1205 LHS.VCallOffsetOffset == RHS.VCallOffsetOffset;
1206 }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001207 };
1208
Anders Carlsson8a240292010-03-12 04:54:20 +00001209 /// ThunkInfo - The 'this' pointer adjustment as well as an optional return
1210 /// adjustment for a thunk.
1211 struct ThunkInfo {
1212 /// This - The 'this' pointer adjustment.
1213 ThisAdjustment This;
1214
1215 /// Return - The return adjustment.
1216 ReturnAdjustment Return;
1217
1218 ThunkInfo() { }
1219
1220 ThunkInfo(const ThisAdjustment &This, const ReturnAdjustment &Return)
1221 : This(This), Return(Return) { }
Anders Carlsson56446142010-03-17 20:06:32 +00001222
1223 friend bool operator==(const ThunkInfo &LHS, const ThunkInfo &RHS) {
1224 return LHS.This == RHS.This && LHS.Return == RHS.Return;
1225 }
1226
1227 bool isEmpty() const { return This.isEmpty() && Return.isEmpty(); }
Anders Carlsson8a240292010-03-12 04:54:20 +00001228 };
1229
1230 typedef llvm::DenseMap<uint64_t, ThunkInfo> ThunksInfoMapTy;
1231
1232 /// Thunks - The thunks by vtable index in the vtable currently being built.
1233 ThunksInfoMapTy Thunks;
Anders Carlssond46ed892010-02-27 16:18:19 +00001234
Anders Carlsson56446142010-03-17 20:06:32 +00001235 typedef llvm::DenseMap<const CXXMethodDecl *,
Anders Carlsson18c582d2010-03-18 02:44:19 +00001236 llvm::SmallVector<ThunkInfo, 1> > MethodThunksMapTy;
Anders Carlsson56446142010-03-17 20:06:32 +00001237
Anders Carlsson18c582d2010-03-18 02:44:19 +00001238 /// MethodThunks - A map that contains all the thunks needed for all methods
1239 /// in the vtable currently being built.
1240 MethodThunksMapTy MethodThunks;
Anders Carlsson56446142010-03-17 20:06:32 +00001241
1242 /// AddThunk - Add a thunk for the given method.
Anders Carlsson4b2411e2010-03-21 20:27:14 +00001243 void AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk);
Anders Carlsson56446142010-03-17 20:06:32 +00001244
Anders Carlsson40687982010-02-27 16:52:49 +00001245 /// ComputeThisAdjustments - Compute the 'this' pointer adjustments for the
1246 /// part of the vtable we're currently building.
1247 void ComputeThisAdjustments();
1248
Anders Carlssondc2dba32010-02-16 04:49:44 +00001249 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1250
Anders Carlssond46ed892010-02-27 16:18:19 +00001251 /// PrimaryVirtualBases - All known virtual bases who are a primary base of
Anders Carlsson0570f712010-02-23 03:48:14 +00001252 /// some other base.
1253 VisitedVirtualBasesSetTy PrimaryVirtualBases;
1254
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001255 /// ComputeReturnAdjustment - Compute the return adjustment given a return
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001256 /// adjustment base offset.
Anders Carlsson075056a2010-02-23 01:34:28 +00001257 ReturnAdjustment ComputeReturnAdjustment(BaseOffset Offset);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001258
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001259 /// ComputeThisAdjustmentBaseOffset - Compute the base offset for adjusting
1260 /// the 'this' pointer from the base subobject to the derived subobject.
1261 BaseOffset ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
1262 BaseSubobject Derived) const;
1263
Anders Carlsson78277c72010-02-18 17:00:09 +00001264 /// ComputeThisAdjustment - Compute the 'this' pointer adjustment for the
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001265 /// given virtual member function, its offset in the layout class and its
1266 /// final overrider.
1267 ThisAdjustment
1268 ComputeThisAdjustment(const CXXMethodDecl *MD,
1269 uint64_t BaseOffsetInLayoutClass,
1270 FinalOverriders::OverriderInfo Overrider);
1271
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001272 /// AddMethod - Add a single virtual member function to the vtable
1273 /// components vector.
Anders Carlsson40687982010-02-27 16:52:49 +00001274 void AddMethod(const CXXMethodDecl *MD, ReturnAdjustment ReturnAdjustment);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001275
Anders Carlssona8796c62010-02-23 04:26:39 +00001276 /// IsOverriderUsed - Returns whether the overrider will ever be used in this
1277 /// part of the vtable.
1278 ///
1279 /// Itanium C++ ABI 2.5.2:
1280 ///
1281 /// struct A { virtual void f(); };
1282 /// struct B : virtual public A { int i; };
1283 /// struct C : virtual public A { int j; };
1284 /// struct D : public B, public C {};
1285 ///
1286 /// When B and C are declared, A is a primary base in each case, so although
1287 /// vcall offsets are allocated in the A-in-B and A-in-C vtables, no this
1288 /// adjustment is required and no thunk is generated. However, inside D
1289 /// objects, A is no longer a primary base of C, so if we allowed calls to
1290 /// C::f() to use the copy of A's vtable in the C subobject, we would need
1291 /// to adjust this from C* to B::A*, which would require a third-party
1292 /// thunk. Since we require that a call to C::f() first convert to A*,
1293 /// C-in-D's copy of A's vtable is never referenced, so this is not
1294 /// necessary.
Anders Carlsson804cf512010-03-10 06:51:42 +00001295 bool IsOverriderUsed(const CXXMethodDecl *Overrider,
1296 uint64_t BaseOffsetInLayoutClass,
1297 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1298 uint64_t FirstBaseOffsetInLayoutClass) const;
1299
Anders Carlssona8796c62010-02-23 04:26:39 +00001300
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001301 /// AddMethods - Add the methods of this base subobject and all its
1302 /// primary bases to the vtable components vector.
Anders Carlsson804cf512010-03-10 06:51:42 +00001303 void AddMethods(BaseSubobject Base, uint64_t BaseOffsetInLayoutClass,
1304 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1305 uint64_t FirstBaseOffsetInLayoutClass,
Anders Carlssond46ed892010-02-27 16:18:19 +00001306 PrimaryBasesSetVectorTy &PrimaryBases);
Anders Carlssonb716a542010-02-16 16:26:28 +00001307
Anders Carlsson62c6c722010-02-28 00:36:23 +00001308 // LayoutVtable - Layout the vtable for the given base class, including its
Anders Carlssonb716a542010-02-16 16:26:28 +00001309 // secondary vtables and any vtables for virtual bases.
1310 void LayoutVtable();
1311
Anders Carlssone3385f52010-02-28 01:43:58 +00001312 /// LayoutPrimaryAndSecondaryVtables - Layout the primary vtable for the
Anders Carlssonb716a542010-02-16 16:26:28 +00001313 /// given base subobject, as well as all its secondary vtables.
Anders Carlssone3385f52010-02-28 01:43:58 +00001314 void LayoutPrimaryAndSecondaryVtables(BaseSubobject Base,
1315 bool BaseIsVirtual,
1316 uint64_t OffsetInLayoutClass);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001317
Anders Carlsson14157932010-02-16 16:02:57 +00001318 /// LayoutSecondaryVtables - Layout the secondary vtables for the given base
1319 /// subobject.
Anders Carlsson115b4752010-03-10 19:39:11 +00001320 ///
1321 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
1322 /// or a direct or indirect base of a virtual base.
1323 void LayoutSecondaryVtables(BaseSubobject Base, bool BaseIsMorallyVirtual,
1324 uint64_t OffsetInLayoutClass);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001325
1326 /// DeterminePrimaryVirtualBases - Determine the primary virtual bases in this
1327 /// class hierarchy.
1328 void DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson02b99d62010-03-10 03:02:01 +00001329 uint64_t OffsetInLayoutClass,
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001330 VisitedVirtualBasesSetTy &VBases);
1331
Anders Carlsson13f0f662010-02-16 16:49:35 +00001332 /// LayoutVtablesForVirtualBases - Layout vtables for all virtual bases of the
1333 /// given base (excluding any primary bases).
1334 void LayoutVtablesForVirtualBases(const CXXRecordDecl *RD,
1335 VisitedVirtualBasesSetTy &VBases);
1336
Anders Carlsson31f595f2010-02-28 00:10:58 +00001337 /// isBuildingConstructionVtable - Return whether this vtable builder is
1338 /// building a construction vtable.
1339 bool isBuildingConstructorVtable() const {
1340 return MostDerivedClass != LayoutClass;
1341 }
1342
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001343public:
Anders Carlsson93913752010-02-27 20:39:05 +00001344 VtableBuilder(CGVtableInfo &VtableInfo, const CXXRecordDecl *MostDerivedClass,
Anders Carlsson62c6c722010-02-28 00:36:23 +00001345 uint64_t MostDerivedClassOffset, bool MostDerivedClassIsVirtual,
Anders Carlsson93913752010-02-27 20:39:05 +00001346 const CXXRecordDecl *LayoutClass)
1347 : VtableInfo(VtableInfo), MostDerivedClass(MostDerivedClass),
Anders Carlsson62c6c722010-02-28 00:36:23 +00001348 MostDerivedClassOffset(MostDerivedClassOffset),
1349 MostDerivedClassIsVirtual(MostDerivedClassIsVirtual),
1350 LayoutClass(LayoutClass), Context(MostDerivedClass->getASTContext()),
Anders Carlssonca82a4f2010-03-10 02:33:41 +00001351 Overriders(MostDerivedClass, MostDerivedClassOffset, LayoutClass) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001352
Anders Carlssonb716a542010-02-16 16:26:28 +00001353 LayoutVtable();
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001354 }
1355
1356 /// dumpLayout - Dump the vtable layout.
1357 void dumpLayout(llvm::raw_ostream&);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001358};
1359
Anders Carlsson4b2411e2010-03-21 20:27:14 +00001360void VtableBuilder::AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk) {
Anders Carlsson18c582d2010-03-18 02:44:19 +00001361 if (isBuildingConstructorVtable())
1362 return;
1363
1364 llvm::SmallVector<ThunkInfo, 1> &ThunksVector = MethodThunks[MD];
Anders Carlsson56446142010-03-17 20:06:32 +00001365
1366 // Check if we have this thunk already.
1367 if (std::find(ThunksVector.begin(), ThunksVector.end(), Thunk) !=
1368 ThunksVector.end())
1369 return;
1370
1371 ThunksVector.push_back(Thunk);
1372}
1373
Anders Carlssond2025412010-02-27 06:38:03 +00001374/// OverridesMethodInBases - Checks whether whether this virtual member
1375/// function overrides a member function in any of the given bases.
Anders Carlsson65b49782010-02-12 05:25:12 +00001376/// Returns the overridden member function, or null if none was found.
1377static const CXXMethodDecl *
Anders Carlssond2025412010-02-27 06:38:03 +00001378OverridesMethodInBases(const CXXMethodDecl *MD,
Anders Carlssond46ed892010-02-27 16:18:19 +00001379 VtableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001380 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1381 E = MD->end_overridden_methods(); I != E; ++I) {
1382 const CXXMethodDecl *OverriddenMD = *I;
1383 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
1384 assert(OverriddenMD->isCanonicalDecl() &&
1385 "Should have the canonical decl of the overridden RD!");
1386
Anders Carlssond2025412010-02-27 06:38:03 +00001387 if (Bases.count(OverriddenRD))
Anders Carlsson65b49782010-02-12 05:25:12 +00001388 return OverriddenMD;
1389 }
1390
1391 return 0;
1392}
1393
Anders Carlsson40687982010-02-27 16:52:49 +00001394void VtableBuilder::ComputeThisAdjustments() {
1395 // Now go through the method info map and see if any of the methods need
1396 // 'this' pointer adjustments.
1397 for (MethodInfoMapTy::const_iterator I = MethodInfoMap.begin(),
1398 E = MethodInfoMap.end(); I != E; ++I) {
1399 const CXXMethodDecl *MD = I->first;
1400 const MethodInfo &MethodInfo = I->second;
1401
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001402 // Ignore adjustments for unused function pointers.
1403 uint64_t VtableIndex = MethodInfo.VtableIndex;
1404 if (Components[VtableIndex].getKind() ==
1405 VtableComponent::CK_UnusedFunctionPointer)
1406 continue;
1407
Anders Carlsson40687982010-02-27 16:52:49 +00001408 // Get the final overrider for this method.
1409 FinalOverriders::OverriderInfo Overrider =
Anders Carlsson423406f32010-03-10 21:25:37 +00001410 Overriders.getOverrider(BaseSubobject(MD->getParent(),
1411 MethodInfo.BaseOffset), MD);
Anders Carlsson40687982010-02-27 16:52:49 +00001412
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001413 ThisAdjustment ThisAdjustment =
1414 ComputeThisAdjustment(MD, MethodInfo.BaseOffsetInLayoutClass, Overrider);
1415
1416 if (ThisAdjustment.isEmpty())
Anders Carlsson40687982010-02-27 16:52:49 +00001417 continue;
Anders Carlsson40687982010-02-27 16:52:49 +00001418
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001419 // Add it.
Anders Carlsson8a240292010-03-12 04:54:20 +00001420 Thunks[VtableIndex].This = ThisAdjustment;
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001421
Anders Carlsson40687982010-02-27 16:52:49 +00001422 if (isa<CXXDestructorDecl>(MD)) {
1423 // Add an adjustment for the deleting destructor as well.
Anders Carlsson8a240292010-03-12 04:54:20 +00001424 Thunks[VtableIndex + 1].This = ThisAdjustment;
Anders Carlsson40687982010-02-27 16:52:49 +00001425 }
Anders Carlsson18c582d2010-03-18 02:44:19 +00001426
1427 AddThunk(Overrider.Method, Thunks[VtableIndex]);
Anders Carlsson40687982010-02-27 16:52:49 +00001428 }
1429
1430 /// Clear the method info map.
1431 MethodInfoMap.clear();
1432}
1433
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001434VtableBuilder::ReturnAdjustment
Anders Carlsson075056a2010-02-23 01:34:28 +00001435VtableBuilder::ComputeReturnAdjustment(BaseOffset Offset) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001436 ReturnAdjustment Adjustment;
1437
1438 if (!Offset.isEmpty()) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001439 if (Offset.VirtualBase) {
1440 // Get the virtual base offset offset.
Anders Carlssone4424882010-03-11 07:00:45 +00001441 if (Offset.DerivedClass == MostDerivedClass) {
1442 // We can get the offset offset directly from our map.
1443 Adjustment.VBaseOffsetOffset =
1444 VBaseOffsetOffsets.lookup(Offset.VirtualBase);
1445 } else {
1446 Adjustment.VBaseOffsetOffset =
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00001447 VtableInfo.getVirtualBaseOffsetOffset(Offset.DerivedClass,
1448 Offset.VirtualBase);
Anders Carlssone4424882010-03-11 07:00:45 +00001449 }
1450
Anders Carlssondd819c92010-03-11 16:06:20 +00001451 // FIXME: Once the assert in getVirtualBaseOffsetOffset is back again,
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001452 // we can get rid of this assert.
1453 assert(Adjustment.VBaseOffsetOffset != 0 &&
Anders Carlssondd819c92010-03-11 16:06:20 +00001454 "Invalid vbase offset offset!");
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001455 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001456
1457 Adjustment.NonVirtual = Offset.NonVirtualOffset;
1458 }
1459
1460 return Adjustment;
1461}
1462
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001463BaseOffset
1464VtableBuilder::ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
1465 BaseSubobject Derived) const {
1466 const CXXRecordDecl *BaseRD = Base.getBase();
1467 const CXXRecordDecl *DerivedRD = Derived.getBase();
1468
1469 CXXBasePaths Paths(/*FindAmbiguities=*/true,
1470 /*RecordPaths=*/true, /*DetectVirtual=*/true);
1471
1472 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
1473 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
1474 assert(false && "Class must be derived from the passed in base class!");
1475 return BaseOffset();
1476 }
1477
1478 // We have to go through all the paths, and see which one leads us to the
1479 // right base subobject.
1480 for (CXXBasePaths::const_paths_iterator I = Paths.begin(), E = Paths.end();
1481 I != E; ++I) {
1482 BaseOffset Offset = ComputeBaseOffset(Context, DerivedRD, *I);
1483
1484 // FIXME: Should not use * 8 here.
1485 uint64_t OffsetToBaseSubobject = Offset.NonVirtualOffset * 8;
1486
1487 if (Offset.VirtualBase) {
1488 // If we have a virtual base class, the non-virtual offset is relative
1489 // to the virtual base class offset.
Anders Carlsson423406f32010-03-10 21:25:37 +00001490 const ASTRecordLayout &LayoutClassLayout =
1491 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001492
1493 /// Get the virtual base offset, relative to the most derived class
1494 /// layout.
1495 OffsetToBaseSubobject +=
Anders Carlsson423406f32010-03-10 21:25:37 +00001496 LayoutClassLayout.getVBaseClassOffset(Offset.VirtualBase);
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001497 } else {
1498 // Otherwise, the non-virtual offset is relative to the derived class
1499 // offset.
1500 OffsetToBaseSubobject += Derived.getBaseOffset();
1501 }
1502
1503 // Check if this path gives us the right base subobject.
1504 if (OffsetToBaseSubobject == Base.getBaseOffset()) {
1505 // Since we're going from the base class _to_ the derived class, we'll
1506 // invert the non-virtual offset here.
1507 Offset.NonVirtualOffset = -Offset.NonVirtualOffset;
1508 return Offset;
1509 }
1510 }
1511
1512 return BaseOffset();
1513}
1514
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001515VtableBuilder::ThisAdjustment
1516VtableBuilder::ComputeThisAdjustment(const CXXMethodDecl *MD,
1517 uint64_t BaseOffsetInLayoutClass,
1518 FinalOverriders::OverriderInfo Overrider) {
1519 // Check if we need an adjustment at all.
1520 if (BaseOffsetInLayoutClass == Overrider.Offset)
1521 return ThisAdjustment();
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001522
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001523 // Ignore adjustments for pure virtual member functions.
1524 if (Overrider.Method->isPure())
1525 return ThisAdjustment();
1526
1527 BaseSubobject OverriddenBaseSubobject(MD->getParent(),
1528 BaseOffsetInLayoutClass);
1529
1530 BaseSubobject OverriderBaseSubobject(Overrider.Method->getParent(),
1531 Overrider.Offset);
1532
1533 // Compute the adjustment offset.
1534 BaseOffset Offset = ComputeThisAdjustmentBaseOffset(OverriddenBaseSubobject,
1535 OverriderBaseSubobject);
1536 if (Offset.isEmpty())
1537 return ThisAdjustment();
1538
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001539 ThisAdjustment Adjustment;
1540
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001541 if (Offset.VirtualBase) {
1542 // Get the vcall offset map for this virtual base.
1543 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Offset.VirtualBase];
Anders Carlsson8847d9e2010-02-18 17:26:40 +00001544
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001545 if (VCallOffsets.empty()) {
1546 // We don't have vcall offsets for this virtual base, go ahead and
1547 // build them.
1548 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, MostDerivedClass,
1549 /*FinalOverriders=*/0,
1550 BaseSubobject(Offset.VirtualBase, 0),
1551 /*BaseIsVirtual=*/true,
1552 /*OffsetInLayoutClass=*/0);
1553
1554 VCallOffsets = Builder.getVCallOffsets();
1555 }
1556
1557 Adjustment.VCallOffsetOffset = VCallOffsets.getVCallOffsetOffset(MD);
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001558 }
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001559
1560 // Set the non-virtual part of the adjustment.
1561 Adjustment.NonVirtual = Offset.NonVirtualOffset;
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001562
1563 return Adjustment;
1564}
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001565
Anders Carlsson65b49782010-02-12 05:25:12 +00001566void
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001567VtableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlsson40687982010-02-27 16:52:49 +00001568 ReturnAdjustment ReturnAdjustment) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001569 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1570 assert(ReturnAdjustment.isEmpty() &&
1571 "Destructor can't have return adjustment!");
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001572
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001573 // Add both the complete destructor and the deleting destructor.
1574 Components.push_back(VtableComponent::MakeCompleteDtor(DD));
1575 Components.push_back(VtableComponent::MakeDeletingDtor(DD));
1576 } else {
1577 // Add the return adjustment if necessary.
1578 if (!ReturnAdjustment.isEmpty())
Anders Carlsson8a240292010-03-12 04:54:20 +00001579 Thunks[Components.size()].Return = ReturnAdjustment;
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001580
1581 // Add the function.
1582 Components.push_back(VtableComponent::MakeFunction(MD));
1583 }
1584}
1585
Anders Carlssond2025412010-02-27 06:38:03 +00001586/// OverridesIndirectMethodInBase - Return whether the given member function
1587/// overrides any methods in the set of given bases.
1588/// Unlike OverridesMethodInBase, this checks "overriders of overriders".
1589/// For example, if we have:
1590///
1591/// struct A { virtual void f(); }
1592/// struct B : A { virtual void f(); }
1593/// struct C : B { virtual void f(); }
1594///
1595/// OverridesIndirectMethodInBase will return true if given C::f as the method
1596/// and { A } as the set of bases.
1597static bool
1598OverridesIndirectMethodInBases(const CXXMethodDecl *MD,
Anders Carlssond46ed892010-02-27 16:18:19 +00001599 VtableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssond2025412010-02-27 06:38:03 +00001600 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1601 E = MD->end_overridden_methods(); I != E; ++I) {
1602 const CXXMethodDecl *OverriddenMD = *I;
1603 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
1604 assert(OverriddenMD->isCanonicalDecl() &&
1605 "Should have the canonical decl of the overridden RD!");
1606
1607 if (Bases.count(OverriddenRD))
1608 return true;
1609
1610 // Check "indirect overriders".
1611 if (OverridesIndirectMethodInBases(OverriddenMD, Bases))
1612 return true;
1613 }
1614
1615 return false;
1616}
1617
Anders Carlssona8796c62010-02-23 04:26:39 +00001618bool
Anders Carlsson804cf512010-03-10 06:51:42 +00001619VtableBuilder::IsOverriderUsed(const CXXMethodDecl *Overrider,
1620 uint64_t BaseOffsetInLayoutClass,
1621 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1622 uint64_t FirstBaseOffsetInLayoutClass) const {
Anders Carlssona8796c62010-02-23 04:26:39 +00001623 // If the base and the first base in the primary base chain have the same
1624 // offsets, then this overrider will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001625 if (BaseOffsetInLayoutClass == FirstBaseOffsetInLayoutClass)
Anders Carlsson8939e402010-02-23 06:34:44 +00001626 return true;
1627
1628 // We know now that Base (or a direct or indirect base of it) is a primary
1629 // base in part of the class hierarchy, but not a primary base in the most
1630 // derived class.
1631
1632 // If the overrider is the first base in the primary base chain, we know
1633 // that the overrider will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001634 if (Overrider->getParent() == FirstBaseInPrimaryBaseChain)
Anders Carlssona8796c62010-02-23 04:26:39 +00001635 return true;
1636
Anders Carlssond46ed892010-02-27 16:18:19 +00001637 VtableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlsson8939e402010-02-23 06:34:44 +00001638
Anders Carlsson804cf512010-03-10 06:51:42 +00001639 const CXXRecordDecl *RD = FirstBaseInPrimaryBaseChain;
Anders Carlsson8939e402010-02-23 06:34:44 +00001640 PrimaryBases.insert(RD);
1641
1642 // Now traverse the base chain, starting with the first base, until we find
1643 // the base that is no longer a primary base.
1644 while (true) {
1645 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1646 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1647
1648 if (!PrimaryBase)
1649 break;
1650
1651 if (Layout.getPrimaryBaseWasVirtual()) {
1652 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
1653 "Primary base should always be at offset 0!");
1654
Anders Carlsson7162ab92010-02-28 18:37:33 +00001655 const ASTRecordLayout &LayoutClassLayout =
1656 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson8939e402010-02-23 06:34:44 +00001657
1658 // Now check if this is the primary base that is not a primary base in the
1659 // most derived class.
Anders Carlsson7162ab92010-02-28 18:37:33 +00001660 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
Anders Carlsson804cf512010-03-10 06:51:42 +00001661 FirstBaseOffsetInLayoutClass) {
Anders Carlsson8939e402010-02-23 06:34:44 +00001662 // We found it, stop walking the chain.
1663 break;
1664 }
1665 } else {
1666 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
1667 "Primary base should always be at offset 0!");
1668 }
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001669
Anders Carlssonb26c2ab2010-02-27 19:51:04 +00001670 if (!PrimaryBases.insert(PrimaryBase))
1671 assert(false && "Found a duplicate primary base!");
1672
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001673 RD = PrimaryBase;
Anders Carlsson8939e402010-02-23 06:34:44 +00001674 }
1675
1676 // If the final overrider is an override of one of the primary bases,
1677 // then we know that it will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001678 return OverridesIndirectMethodInBases(Overrider, PrimaryBases);
Anders Carlssona8796c62010-02-23 04:26:39 +00001679}
1680
Anders Carlsson40687982010-02-27 16:52:49 +00001681/// FindNearestOverriddenMethod - Given a method, returns the overridden method
1682/// from the nearest base. Returns null if no method was found.
1683static const CXXMethodDecl *
1684FindNearestOverriddenMethod(const CXXMethodDecl *MD,
1685 VtableBuilder::PrimaryBasesSetVectorTy &Bases) {
1686 for (int I = Bases.size(), E = 0; I != E; --I) {
1687 const CXXRecordDecl *PrimaryBase = Bases[I - 1];
1688
1689 // Now check the overriden methods.
1690 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1691 E = MD->end_overridden_methods(); I != E; ++I) {
1692 const CXXMethodDecl *OverriddenMD = *I;
1693
1694 // We found our overridden method.
1695 if (OverriddenMD->getParent() == PrimaryBase)
1696 return OverriddenMD;
1697 }
1698 }
1699
1700 return 0;
1701}
1702
Anders Carlsson804cf512010-03-10 06:51:42 +00001703void
1704VtableBuilder::AddMethods(BaseSubobject Base, uint64_t BaseOffsetInLayoutClass,
1705 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1706 uint64_t FirstBaseOffsetInLayoutClass,
Anders Carlssond46ed892010-02-27 16:18:19 +00001707 PrimaryBasesSetVectorTy &PrimaryBases) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001708 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001709 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1710
1711 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson804cf512010-03-10 06:51:42 +00001712 uint64_t PrimaryBaseOffset;
1713 uint64_t PrimaryBaseOffsetInLayoutClass;
Anders Carlsson0570f712010-02-23 03:48:14 +00001714 if (Layout.getPrimaryBaseWasVirtual()) {
1715 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
1716 "Primary vbase should have a zero offset!");
1717
1718 const ASTRecordLayout &MostDerivedClassLayout =
1719 Context.getASTRecordLayout(MostDerivedClass);
1720
Anders Carlsson804cf512010-03-10 06:51:42 +00001721 PrimaryBaseOffset =
1722 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
1723
1724 const ASTRecordLayout &LayoutClassLayout =
1725 Context.getASTRecordLayout(LayoutClass);
1726
1727 PrimaryBaseOffsetInLayoutClass =
1728 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson0570f712010-02-23 03:48:14 +00001729 } else {
Anders Carlsson65b49782010-02-12 05:25:12 +00001730 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
1731 "Primary base should have a zero offset!");
Anders Carlsson0570f712010-02-23 03:48:14 +00001732
Anders Carlsson804cf512010-03-10 06:51:42 +00001733 PrimaryBaseOffset = Base.getBaseOffset();
1734 PrimaryBaseOffsetInLayoutClass = BaseOffsetInLayoutClass;
Anders Carlsson0570f712010-02-23 03:48:14 +00001735 }
Anders Carlsson7162ab92010-02-28 18:37:33 +00001736
Anders Carlsson804cf512010-03-10 06:51:42 +00001737 AddMethods(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
1738 PrimaryBaseOffsetInLayoutClass, FirstBaseInPrimaryBaseChain,
1739 FirstBaseOffsetInLayoutClass, PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001740
1741 if (!PrimaryBases.insert(PrimaryBase))
1742 assert(false && "Found a duplicate primary base!");
1743 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001744
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001745 // Now go through all virtual member functions and add them.
1746 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1747 E = RD->method_end(); I != E; ++I) {
1748 const CXXMethodDecl *MD = *I;
Anders Carlsson65b49782010-02-12 05:25:12 +00001749
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001750 if (!MD->isVirtual())
1751 continue;
Anders Carlsson65b49782010-02-12 05:25:12 +00001752
1753 // Get the final overrider.
Anders Carlsson136bd192010-02-12 16:55:34 +00001754 FinalOverriders::OverriderInfo Overrider =
1755 Overriders.getOverrider(Base, MD);
Anders Carlsson65b49782010-02-12 05:25:12 +00001756
1757 // Check if this virtual member function overrides a method in a primary
1758 // base. If this is the case, and the return type doesn't require adjustment
1759 // then we can just use the member function from the primary base.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001760 if (const CXXMethodDecl *OverriddenMD =
Anders Carlsson40687982010-02-27 16:52:49 +00001761 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +00001762 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
Anders Carlsson40687982010-02-27 16:52:49 +00001763 OverriddenMD).isEmpty()) {
1764 // Replace the method info of the overridden method with our own
1765 // method.
1766 assert(MethodInfoMap.count(OverriddenMD) &&
1767 "Did not find the overridden method!");
1768 MethodInfo &OverriddenMethodInfo = MethodInfoMap[OverriddenMD];
1769
1770 MethodInfo MethodInfo(Base.getBaseOffset(),
Anders Carlsson423406f32010-03-10 21:25:37 +00001771 BaseOffsetInLayoutClass,
Anders Carlsson40687982010-02-27 16:52:49 +00001772 OverriddenMethodInfo.VtableIndex);
1773
1774 assert(!MethodInfoMap.count(MD) &&
1775 "Should not have method info for this method yet!");
1776
1777 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
1778 MethodInfoMap.erase(OverriddenMD);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001779 continue;
Anders Carlsson40687982010-02-27 16:52:49 +00001780 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001781 }
Anders Carlssoneee53d92010-02-13 02:02:03 +00001782
Anders Carlsson40687982010-02-27 16:52:49 +00001783 // Insert the method info for this method.
Anders Carlsson423406f32010-03-10 21:25:37 +00001784 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
1785 Components.size());
Anders Carlsson40687982010-02-27 16:52:49 +00001786
1787 assert(!MethodInfoMap.count(MD) &&
1788 "Should not have method info for this method yet!");
1789 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001790
1791 // Check if this overrider is going to be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001792 const CXXMethodDecl *OverriderMD = Overrider.Method;
1793 if (!IsOverriderUsed(OverriderMD, BaseOffsetInLayoutClass,
1794 FirstBaseInPrimaryBaseChain,
1795 FirstBaseOffsetInLayoutClass)) {
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001796 Components.push_back(VtableComponent::MakeUnusedFunction(OverriderMD));
1797 continue;
1798 }
Anders Carlssona8796c62010-02-23 04:26:39 +00001799
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001800 // Check if this overrider needs a return adjustment.
Anders Carlsson075056a2010-02-23 01:34:28 +00001801 BaseOffset ReturnAdjustmentOffset =
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001802 Overriders.getReturnAdjustmentOffset(Base, MD);
1803
1804 ReturnAdjustment ReturnAdjustment =
1805 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001806
Anders Carlsson40687982010-02-27 16:52:49 +00001807 AddMethod(Overrider.Method, ReturnAdjustment);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001808 }
1809}
1810
Anders Carlssonb716a542010-02-16 16:26:28 +00001811void VtableBuilder::LayoutVtable() {
Anders Carlssone3385f52010-02-28 01:43:58 +00001812 LayoutPrimaryAndSecondaryVtables(BaseSubobject(MostDerivedClass, 0),
1813 MostDerivedClassIsVirtual,
1814 MostDerivedClassOffset);
Anders Carlssonb716a542010-02-16 16:26:28 +00001815
Anders Carlsson13f0f662010-02-16 16:49:35 +00001816 VisitedVirtualBasesSetTy VBases;
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001817
1818 // Determine the primary virtual bases.
Anders Carlsson02b99d62010-03-10 03:02:01 +00001819 DeterminePrimaryVirtualBases(MostDerivedClass, MostDerivedClassOffset,
1820 VBases);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001821 VBases.clear();
1822
Anders Carlsson13f0f662010-02-16 16:49:35 +00001823 LayoutVtablesForVirtualBases(MostDerivedClass, VBases);
Anders Carlssonb716a542010-02-16 16:26:28 +00001824}
1825
Anders Carlssone3385f52010-02-28 01:43:58 +00001826void
1827VtableBuilder::LayoutPrimaryAndSecondaryVtables(BaseSubobject Base,
1828 bool BaseIsVirtual,
1829 uint64_t OffsetInLayoutClass) {
Chris Lattnerd2408f72010-02-17 21:42:34 +00001830 assert(Base.getBase()->isDynamicClass() && "class does not have a vtable!");
Anders Carlsson033d4862010-02-14 17:05:59 +00001831
Anders Carlsson77904f12010-02-16 04:59:55 +00001832 // Add vcall and vbase offsets for this vtable.
Anders Carlssone3385f52010-02-28 01:43:58 +00001833 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, LayoutClass, &Overriders,
1834 Base, BaseIsVirtual, OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +00001835 Components.append(Builder.components_begin(), Builder.components_end());
1836
Anders Carlsson9e3b3a32010-02-25 22:23:13 +00001837 // Check if we need to add these vcall offsets.
1838 if (BaseIsVirtual && !Builder.getVCallOffsets().empty()) {
1839 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Base.getBase()];
1840
1841 if (VCallOffsets.empty())
1842 VCallOffsets = Builder.getVCallOffsets();
1843 }
1844
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001845 // If we're laying out the most derived class we want to keep track of the
1846 // virtual base class offset offsets.
1847 if (Base.getBase() == MostDerivedClass)
1848 VBaseOffsetOffsets = Builder.getVBaseOffsetOffsets();
1849
Anders Carlsson77904f12010-02-16 04:59:55 +00001850 // Add the offset to top.
Anders Carlsson258a1e32010-02-14 00:16:19 +00001851 // FIXME: We should not use / 8 here.
Anders Carlssone3385f52010-02-28 01:43:58 +00001852 int64_t OffsetToTop = -(int64_t)(OffsetInLayoutClass -
1853 MostDerivedClassOffset) / 8;
Anders Carlssone75aaa92010-02-13 22:05:23 +00001854 Components.push_back(VtableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson65b49782010-02-12 05:25:12 +00001855
1856 // Next, add the RTTI.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001857 Components.push_back(VtableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson65b49782010-02-12 05:25:12 +00001858
Anders Carlssone8a97562010-02-12 07:43:48 +00001859 uint64_t AddressPoint = Components.size();
Anders Carlsson65b49782010-02-12 05:25:12 +00001860
1861 // Now go through all virtual member functions and add them.
Anders Carlssond46ed892010-02-27 16:18:19 +00001862 PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlsson804cf512010-03-10 06:51:42 +00001863 AddMethods(Base, OffsetInLayoutClass, Base.getBase(), OffsetInLayoutClass,
1864 PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001865
Anders Carlsson40687982010-02-27 16:52:49 +00001866 // Compute 'this' pointer adjustments.
1867 ComputeThisAdjustments();
1868
Anders Carlssone8a97562010-02-12 07:43:48 +00001869 // Record the address point.
Anders Carlssone3385f52010-02-28 01:43:58 +00001870 AddressPoints.insert(std::make_pair(BaseSubobject(Base.getBase(),
1871 OffsetInLayoutClass),
1872 AddressPoint));
Anders Carlssone8a97562010-02-12 07:43:48 +00001873
1874 // Record the address points for all primary bases.
Anders Carlssond46ed892010-02-27 16:18:19 +00001875 for (PrimaryBasesSetVectorTy::const_iterator I = PrimaryBases.begin(),
Anders Carlssone8a97562010-02-12 07:43:48 +00001876 E = PrimaryBases.end(); I != E; ++I) {
1877 const CXXRecordDecl *BaseDecl = *I;
1878
1879 // We know that all the primary bases have the same offset as the base
1880 // subobject.
Anders Carlssone3385f52010-02-28 01:43:58 +00001881 BaseSubobject PrimaryBase(BaseDecl, OffsetInLayoutClass);
Anders Carlssone8a97562010-02-12 07:43:48 +00001882 AddressPoints.insert(std::make_pair(PrimaryBase, AddressPoint));
1883 }
1884
Anders Carlsson115b4752010-03-10 19:39:11 +00001885 bool BaseIsMorallyVirtual = BaseIsVirtual;
1886 if (isBuildingConstructorVtable() && Base.getBase() == MostDerivedClass)
1887 BaseIsMorallyVirtual = false;
1888
Anders Carlssona9f633b2010-02-24 16:43:12 +00001889 // Layout secondary vtables.
Anders Carlsson115b4752010-03-10 19:39:11 +00001890 LayoutSecondaryVtables(Base, BaseIsMorallyVirtual, OffsetInLayoutClass);
Anders Carlsson14157932010-02-16 16:02:57 +00001891}
1892
Anders Carlssone3385f52010-02-28 01:43:58 +00001893void VtableBuilder::LayoutSecondaryVtables(BaseSubobject Base,
Anders Carlsson115b4752010-03-10 19:39:11 +00001894 bool BaseIsMorallyVirtual,
Anders Carlssone3385f52010-02-28 01:43:58 +00001895 uint64_t OffsetInLayoutClass) {
Anders Carlsson14157932010-02-16 16:02:57 +00001896 // Itanium C++ ABI 2.5.2:
1897 // Following the primary virtual table of a derived class are secondary
1898 // virtual tables for each of its proper base classes, except any primary
1899 // base(s) with which it shares its primary virtual table.
1900
1901 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001902 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1903 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson14157932010-02-16 16:02:57 +00001904
Anders Carlsson65b49782010-02-12 05:25:12 +00001905 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1906 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson14157932010-02-16 16:02:57 +00001907 // Ignore virtual bases, we'll emit them later.
1908 if (I->isVirtual())
1909 continue;
1910
Anders Carlsson65b49782010-02-12 05:25:12 +00001911 const CXXRecordDecl *BaseDecl =
1912 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson033d4862010-02-14 17:05:59 +00001913
Anders Carlssondc2dba32010-02-16 04:49:44 +00001914 // Ignore bases that don't have a vtable.
1915 if (!BaseDecl->isDynamicClass())
1916 continue;
Anders Carlsson033d4862010-02-14 17:05:59 +00001917
Anders Carlsson703a0862010-03-10 19:15:26 +00001918 if (isBuildingConstructorVtable()) {
1919 // Itanium C++ ABI 2.6.4:
1920 // Some of the base class subobjects may not need construction virtual
1921 // tables, which will therefore not be present in the construction
1922 // virtual table group, even though the subobject virtual tables are
1923 // present in the main virtual table group for the complete object.
Anders Carlsson115b4752010-03-10 19:39:11 +00001924 if (!BaseIsMorallyVirtual && !BaseDecl->getNumVBases())
Anders Carlsson703a0862010-03-10 19:15:26 +00001925 continue;
Anders Carlsson703a0862010-03-10 19:15:26 +00001926 }
1927
Anders Carlssone75aaa92010-02-13 22:05:23 +00001928 // Get the base offset of this base.
Anders Carlssone3385f52010-02-28 01:43:58 +00001929 uint64_t RelativeBaseOffset = Layout.getBaseClassOffset(BaseDecl);
1930 uint64_t BaseOffset = Base.getBaseOffset() + RelativeBaseOffset;
1931
1932 uint64_t BaseOffsetInLayoutClass = OffsetInLayoutClass + RelativeBaseOffset;
Anders Carlsson14157932010-02-16 16:02:57 +00001933
1934 // Don't emit a secondary vtable for a primary base. We might however want
1935 // to emit secondary vtables for other bases of this base.
1936 if (BaseDecl == PrimaryBase) {
Anders Carlssone3385f52010-02-28 01:43:58 +00001937 LayoutSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset),
Anders Carlsson115b4752010-03-10 19:39:11 +00001938 BaseIsMorallyVirtual, BaseOffsetInLayoutClass);
Anders Carlsson14157932010-02-16 16:02:57 +00001939 continue;
1940 }
Anders Carlssone75aaa92010-02-13 22:05:23 +00001941
Anders Carlssonb716a542010-02-16 16:26:28 +00001942 // Layout the primary vtable (and any secondary vtables) for this base.
Anders Carlssone3385f52010-02-28 01:43:58 +00001943 LayoutPrimaryAndSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset),
1944 /*BaseIsVirtual=*/false,
1945 BaseOffsetInLayoutClass);
Anders Carlsson65b49782010-02-12 05:25:12 +00001946 }
1947}
1948
Anders Carlsson13f0f662010-02-16 16:49:35 +00001949void
Anders Carlsson02b99d62010-03-10 03:02:01 +00001950VtableBuilder::DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
1951 uint64_t OffsetInLayoutClass,
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001952 VisitedVirtualBasesSetTy &VBases) {
1953 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1954
1955 // Check if this base has a primary base.
1956 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson8b37bb72010-02-28 18:08:38 +00001957
1958 // Check if it's virtual.
1959 if (Layout.getPrimaryBaseWasVirtual()) {
1960 bool IsPrimaryVirtualBase = true;
1961
1962 if (isBuildingConstructorVtable()) {
1963 // Check if the base is actually a primary base in the class we use for
1964 // layout.
Anders Carlsson02b99d62010-03-10 03:02:01 +00001965 const ASTRecordLayout &LayoutClassLayout =
1966 Context.getASTRecordLayout(LayoutClass);
1967
1968 uint64_t PrimaryBaseOffsetInLayoutClass =
1969 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
1970
1971 // We know that the base is not a primary base in the layout class if
1972 // the base offsets are different.
1973 if (PrimaryBaseOffsetInLayoutClass != OffsetInLayoutClass)
Anders Carlsson8b37bb72010-02-28 18:08:38 +00001974 IsPrimaryVirtualBase = false;
1975 }
1976
1977 if (IsPrimaryVirtualBase)
1978 PrimaryVirtualBases.insert(PrimaryBase);
1979 }
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001980 }
1981
1982 // Traverse bases, looking for more primary virtual bases.
1983 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1984 E = RD->bases_end(); I != E; ++I) {
1985 const CXXRecordDecl *BaseDecl =
1986 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1987
Anders Carlsson02b99d62010-03-10 03:02:01 +00001988 uint64_t BaseOffsetInLayoutClass;
1989
1990 if (I->isVirtual()) {
1991 if (!VBases.insert(BaseDecl))
1992 continue;
1993
1994 const ASTRecordLayout &LayoutClassLayout =
1995 Context.getASTRecordLayout(LayoutClass);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001996
Anders Carlsson02b99d62010-03-10 03:02:01 +00001997 BaseOffsetInLayoutClass = LayoutClassLayout.getVBaseClassOffset(BaseDecl);
1998 } else {
1999 BaseOffsetInLayoutClass =
2000 OffsetInLayoutClass + Layout.getBaseClassOffset(BaseDecl);
2001 }
2002
2003 DeterminePrimaryVirtualBases(BaseDecl, BaseOffsetInLayoutClass, VBases);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00002004 }
2005}
2006
2007void
Anders Carlsson13f0f662010-02-16 16:49:35 +00002008VtableBuilder::LayoutVtablesForVirtualBases(const CXXRecordDecl *RD,
2009 VisitedVirtualBasesSetTy &VBases) {
2010 // Itanium C++ ABI 2.5.2:
2011 // Then come the virtual base virtual tables, also in inheritance graph
2012 // order, and again excluding primary bases (which share virtual tables with
2013 // the classes for which they are primary).
Anders Carlsson13f0f662010-02-16 16:49:35 +00002014 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
2015 E = RD->bases_end(); I != E; ++I) {
2016 const CXXRecordDecl *BaseDecl =
2017 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
2018
Anders Carlsson0570f712010-02-23 03:48:14 +00002019 // Check if this base needs a vtable. (If it's virtual, not a primary base
2020 // of some other class, and we haven't visited it before).
Anders Carlsson13f0f662010-02-16 16:49:35 +00002021 if (I->isVirtual() && BaseDecl->isDynamicClass() &&
Anders Carlssonb08aaa32010-02-27 04:05:52 +00002022 !PrimaryVirtualBases.count(BaseDecl) && VBases.insert(BaseDecl)) {
Anders Carlsson13f0f662010-02-16 16:49:35 +00002023 const ASTRecordLayout &MostDerivedClassLayout =
2024 Context.getASTRecordLayout(MostDerivedClass);
2025 uint64_t BaseOffset =
2026 MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
2027
Anders Carlssone3385f52010-02-28 01:43:58 +00002028 const ASTRecordLayout &LayoutClassLayout =
2029 Context.getASTRecordLayout(LayoutClass);
2030 uint64_t BaseOffsetInLayoutClass =
2031 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
2032
2033 LayoutPrimaryAndSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset),
2034 /*BaseIsVirtual=*/true,
2035 BaseOffsetInLayoutClass);
Anders Carlsson13f0f662010-02-16 16:49:35 +00002036 }
2037
2038 // We only need to check the base for virtual base vtables if it actually
2039 // has virtual bases.
2040 if (BaseDecl->getNumVBases())
2041 LayoutVtablesForVirtualBases(BaseDecl, VBases);
2042 }
2043}
2044
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002045/// dumpLayout - Dump the vtable layout.
2046void VtableBuilder::dumpLayout(llvm::raw_ostream& Out) {
Anders Carlsson93913752010-02-27 20:39:05 +00002047
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002048 if (isBuildingConstructorVtable()) {
Anders Carlsson93913752010-02-27 20:39:05 +00002049 Out << "Construction vtable for ('";
2050 Out << MostDerivedClass->getQualifiedNameAsString() << "', ";
2051 // FIXME: Don't use / 8 .
2052 Out << MostDerivedClassOffset / 8 << ") in '";
2053 Out << LayoutClass->getQualifiedNameAsString();
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002054 } else {
2055 Out << "Vtable for '";
2056 Out << MostDerivedClass->getQualifiedNameAsString();
Anders Carlsson93913752010-02-27 20:39:05 +00002057 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002058 Out << "' (" << Components.size() << " entries).\n";
2059
Anders Carlsson932c2f22010-02-11 17:18:51 +00002060 // Iterate through the address points and insert them into a new map where
2061 // they are keyed by the index and not the base object.
2062 // Since an address point can be shared by multiple subobjects, we use an
2063 // STL multimap.
2064 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
2065 for (CGVtableInfo::AddressPointsMapTy::const_iterator I =
2066 AddressPoints.begin(), E = AddressPoints.end(); I != E; ++I) {
2067 const BaseSubobject& Base = I->first;
2068 uint64_t Index = I->second;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002069
Anders Carlsson932c2f22010-02-11 17:18:51 +00002070 AddressPointsByIndex.insert(std::make_pair(Index, Base));
2071 }
2072
2073 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlssone8a97562010-02-12 07:43:48 +00002074 uint64_t Index = I;
Anders Carlsson932c2f22010-02-11 17:18:51 +00002075
2076 Out << llvm::format("%4d | ", I);
2077
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002078 const VtableComponent &Component = Components[I];
2079
2080 // Dump the component.
2081 switch (Component.getKind()) {
Anders Carlssonb0a588f2010-02-17 06:07:19 +00002082
2083 case VtableComponent::CK_VCallOffset:
2084 Out << "vcall_offset (" << Component.getVCallOffset() << ")";
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002085 break;
Anders Carlsson77904f12010-02-16 04:59:55 +00002086
2087 case VtableComponent::CK_VBaseOffset:
2088 Out << "vbase_offset (" << Component.getVBaseOffset() << ")";
2089 break;
2090
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002091 case VtableComponent::CK_OffsetToTop:
2092 Out << "offset_to_top (" << Component.getOffsetToTop() << ")";
2093 break;
2094
2095 case VtableComponent::CK_RTTI:
2096 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
2097 break;
2098
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002099 case VtableComponent::CK_FunctionPointer: {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002100 const CXXMethodDecl *MD = Component.getFunctionDecl();
2101
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002102 std::string Str =
2103 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2104 MD);
2105 Out << Str;
Anders Carlsson09da3372010-02-12 02:38:13 +00002106 if (MD->isPure())
2107 Out << " [pure]";
2108
Anders Carlsson8a240292010-03-12 04:54:20 +00002109 ThunkInfo Thunk = Thunks.lookup(I);
2110 if (!Thunk.isEmpty()) {
2111 // If this function pointer has a return adjustment, dump it.
2112 if (!Thunk.Return.isEmpty()) {
2113 Out << "\n [return adjustment: ";
2114 Out << Thunk.Return.NonVirtual << " non-virtual";
2115
2116 if (Thunk.Return.VBaseOffsetOffset) {
2117 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2118 Out << " vbase offset offset";
2119 }
Anders Carlsson78277c72010-02-18 17:00:09 +00002120
Anders Carlsson8a240292010-03-12 04:54:20 +00002121 Out << ']';
2122 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002123
Anders Carlsson8a240292010-03-12 04:54:20 +00002124 // If this function pointer has a 'this' pointer adjustment, dump it.
2125 if (!Thunk.This.isEmpty()) {
2126 Out << "\n [this adjustment: ";
2127 Out << Thunk.This.NonVirtual << " non-virtual";
2128
2129 if (Thunk.This.VCallOffsetOffset) {
2130 Out << ", " << Thunk.This.VCallOffsetOffset;
2131 Out << " vcall offset offset";
2132 }
Anders Carlsson78277c72010-02-18 17:00:09 +00002133
Anders Carlsson8a240292010-03-12 04:54:20 +00002134 Out << ']';
2135 }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00002136 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002137
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002138 break;
2139 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002140
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002141 case VtableComponent::CK_CompleteDtorPointer:
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002142 case VtableComponent::CK_DeletingDtorPointer: {
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002143 bool IsComplete =
2144 Component.getKind() == VtableComponent::CK_CompleteDtorPointer;
2145
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002146 const CXXDestructorDecl *DD = Component.getDestructorDecl();
2147
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002148 Out << DD->getQualifiedNameAsString();
2149 if (IsComplete)
2150 Out << "() [complete]";
2151 else
2152 Out << "() [deleting]";
2153
Anders Carlsson09da3372010-02-12 02:38:13 +00002154 if (DD->isPure())
2155 Out << " [pure]";
2156
Anders Carlsson8a240292010-03-12 04:54:20 +00002157 ThunkInfo Thunk = Thunks.lookup(I);
2158 if (!Thunk.isEmpty()) {
2159 // If this destructor has a 'this' pointer adjustment, dump it.
2160 if (!Thunk.This.isEmpty()) {
2161 Out << "\n [this adjustment: ";
2162 Out << Thunk.This.NonVirtual << " non-virtual";
2163
2164 if (Thunk.This.VCallOffsetOffset) {
2165 Out << ", " << Thunk.This.VCallOffsetOffset;
2166 Out << " vcall offset offset";
2167 }
2168
2169 Out << ']';
2170 }
2171 }
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002172
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002173 break;
2174 }
2175
Anders Carlsson350b56e2010-02-19 20:08:13 +00002176 case VtableComponent::CK_UnusedFunctionPointer: {
2177 const CXXMethodDecl *MD = Component.getUnusedFunctionDecl();
2178
2179 std::string Str =
2180 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2181 MD);
2182 Out << "[unused] " << Str;
2183 if (MD->isPure())
2184 Out << " [pure]";
2185 }
2186
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002187 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00002188
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002189 Out << '\n';
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002190
2191 // Dump the next address point.
2192 uint64_t NextIndex = Index + 1;
2193 if (AddressPointsByIndex.count(NextIndex)) {
2194 if (AddressPointsByIndex.count(NextIndex) == 1) {
2195 const BaseSubobject &Base =
2196 AddressPointsByIndex.find(NextIndex)->second;
2197
2198 // FIXME: Instead of dividing by 8, we should be using CharUnits.
2199 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
2200 Out << ", " << Base.getBaseOffset() / 8 << ") vtable address --\n";
2201 } else {
2202 uint64_t BaseOffset =
2203 AddressPointsByIndex.lower_bound(NextIndex)->second.getBaseOffset();
2204
2205 // We store the class names in a set to get a stable order.
2206 std::set<std::string> ClassNames;
2207 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
2208 AddressPointsByIndex.lower_bound(NextIndex), E =
2209 AddressPointsByIndex.upper_bound(NextIndex); I != E; ++I) {
2210 assert(I->second.getBaseOffset() == BaseOffset &&
2211 "Invalid base offset!");
2212 const CXXRecordDecl *RD = I->second.getBase();
2213 ClassNames.insert(RD->getQualifiedNameAsString());
2214 }
2215
2216 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
2217 E = ClassNames.end(); I != E; ++I) {
2218 // FIXME: Instead of dividing by 8, we should be using CharUnits.
2219 Out << " -- (" << *I;
2220 Out << ", " << BaseOffset / 8 << ") vtable address --\n";
2221 }
2222 }
2223 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002224 }
Anders Carlsson93913752010-02-27 20:39:05 +00002225
2226 Out << '\n';
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002227
Anders Carlsson18c582d2010-03-18 02:44:19 +00002228 if (isBuildingConstructorVtable())
2229 return;
2230
2231 if (MostDerivedClass->getNumVBases()) {
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002232 // We store the virtual base class names and their offsets in a map to get
2233 // a stable order.
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002234
Anders Carlsson18c582d2010-03-18 02:44:19 +00002235 std::map<std::string, int64_t> ClassNamesAndOffsets;
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002236 for (VBaseOffsetOffsetsMapTy::const_iterator I = VBaseOffsetOffsets.begin(),
2237 E = VBaseOffsetOffsets.end(); I != E; ++I) {
2238 std::string ClassName = I->first->getQualifiedNameAsString();
2239 int64_t OffsetOffset = I->second;
2240 ClassNamesAndOffsets.insert(std::make_pair(ClassName, OffsetOffset));
2241 }
Anders Carlsson18c582d2010-03-18 02:44:19 +00002242
2243 Out << "Virtual base offset offsets for '";
2244 Out << MostDerivedClass->getQualifiedNameAsString() << "' (";
2245 Out << ClassNamesAndOffsets.size();
2246 Out << (ClassNamesAndOffsets.size() == 1 ? " entry" : " entries") << ").\n";
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002247
2248 for (std::map<std::string, int64_t>::const_iterator I =
2249 ClassNamesAndOffsets.begin(), E = ClassNamesAndOffsets.end();
2250 I != E; ++I)
2251 Out << " " << I->first << " | " << I->second << '\n';
2252
2253 Out << "\n";
2254 }
Anders Carlsson18c582d2010-03-18 02:44:19 +00002255
2256 if (!MethodThunks.empty()) {
2257
2258 // We store the method names in a map to get a stable order.
2259 std::map<std::string, const CXXMethodDecl *> MethodNamesAndDecls;
2260
2261 for (MethodThunksMapTy::const_iterator I = MethodThunks.begin(),
2262 E = MethodThunks.end(); I != E; ++I) {
2263 const CXXMethodDecl *MD = I->first;
2264 std::string MethodName =
2265 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2266 MD);
2267
2268 MethodNamesAndDecls.insert(std::make_pair(MethodName, MD));
2269 }
2270
2271 for (std::map<std::string, const CXXMethodDecl *>::const_iterator I =
2272 MethodNamesAndDecls.begin(), E = MethodNamesAndDecls.end();
2273 I != E; ++I) {
2274 const std::string &MethodName = I->first;
2275 const CXXMethodDecl *MD = I->second;
2276 const llvm::SmallVector<ThunkInfo, 1> &ThunksVector = MethodThunks[MD];
2277
2278 Out << "Thunks for '" << MethodName << "' (" << ThunksVector.size();
2279 Out << (ThunksVector.size() == 1 ? " entry" : " entries") << ").\n";
2280
2281 for (unsigned I = 0, E = ThunksVector.size(); I != E; ++I) {
2282 const ThunkInfo &Thunk = ThunksVector[I];
2283
2284 Out << llvm::format("%4d | ", I);
2285
2286 // If this function pointer has a 'this' pointer adjustment, dump it.
2287 if (!Thunk.This.isEmpty()) {
2288 Out << "this: ";
2289 Out << Thunk.This.NonVirtual << " nv";
2290
2291 if (Thunk.This.VCallOffsetOffset) {
2292 Out << ", " << Thunk.This.VCallOffsetOffset;
2293 Out << " v";
2294 }
2295 }
2296
2297 Out << '\n';
2298 }
2299 }
2300 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002301}
2302
2303}
2304
2305namespace {
2306class OldVtableBuilder {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002307public:
2308 /// Index_t - Vtable index type.
2309 typedef uint64_t Index_t;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002310 typedef std::vector<std::pair<GlobalDecl,
2311 std::pair<GlobalDecl, ThunkAdjustment> > >
2312 SavedAdjustmentsVectorTy;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002313private:
Anders Carlsson472404f2009-12-04 16:19:30 +00002314
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002315 // VtableComponents - The components of the vtable being built.
2316 typedef llvm::SmallVector<llvm::Constant *, 64> VtableComponentsVectorTy;
2317 VtableComponentsVectorTy VtableComponents;
2318
Eli Friedman6c08ce72009-12-05 01:05:03 +00002319 const bool BuildVtable;
2320
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002321 llvm::Type *Ptr8Ty;
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002322
2323 /// MostDerivedClass - The most derived class that this vtable is being
2324 /// built for.
2325 const CXXRecordDecl *MostDerivedClass;
2326
Mike Stump83066c82009-11-13 01:54:23 +00002327 /// LayoutClass - The most derived class used for virtual base layout
2328 /// information.
2329 const CXXRecordDecl *LayoutClass;
Mike Stump653d0b92009-11-13 02:13:54 +00002330 /// LayoutOffset - The offset for Class in LayoutClass.
2331 uint64_t LayoutOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002332 /// BLayout - Layout for the most derived class that this vtable is being
2333 /// built for.
2334 const ASTRecordLayout &BLayout;
2335 llvm::SmallSet<const CXXRecordDecl *, 32> IndirectPrimary;
2336 llvm::SmallSet<const CXXRecordDecl *, 32> SeenVBase;
2337 llvm::Constant *rtti;
2338 llvm::LLVMContext &VMContext;
2339 CodeGenModule &CGM; // Per-module state.
Anders Carlssonf2f31f42009-12-04 03:46:21 +00002340
Mike Stump90181eb2010-01-26 00:05:04 +00002341 llvm::DenseMap<const CXXMethodDecl *, Index_t> VCall;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002342 llvm::DenseMap<GlobalDecl, Index_t> VCallOffset;
Mike Stump77537b12010-01-26 03:42:22 +00002343 llvm::DenseMap<GlobalDecl, Index_t> VCallOffsetForVCall;
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002344 // This is the offset to the nearest virtual base
Mike Stump90181eb2010-01-26 00:05:04 +00002345 llvm::DenseMap<const CXXMethodDecl *, Index_t> NonVirtualOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002346 llvm::DenseMap<const CXXRecordDecl *, Index_t> VBIndex;
Mike Stumpbb9ff052009-10-27 23:46:47 +00002347
Anders Carlsson323bb042009-11-26 19:54:33 +00002348 /// PureVirtualFunction - Points to __cxa_pure_virtual.
2349 llvm::Constant *PureVirtualFn;
2350
Anders Carlssona84b6e82009-12-04 02:01:07 +00002351 /// VtableMethods - A data structure for keeping track of methods in a vtable.
2352 /// Can add methods, override methods and iterate in vtable order.
2353 class VtableMethods {
2354 // MethodToIndexMap - Maps from a global decl to the index it has in the
2355 // Methods vector.
2356 llvm::DenseMap<GlobalDecl, uint64_t> MethodToIndexMap;
2357
2358 /// Methods - The methods, in vtable order.
2359 typedef llvm::SmallVector<GlobalDecl, 16> MethodsVectorTy;
2360 MethodsVectorTy Methods;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002361 MethodsVectorTy OrigMethods;
Anders Carlssona84b6e82009-12-04 02:01:07 +00002362
2363 public:
2364 /// AddMethod - Add a method to the vtable methods.
2365 void AddMethod(GlobalDecl GD) {
2366 assert(!MethodToIndexMap.count(GD) &&
2367 "Method has already been added!");
2368
2369 MethodToIndexMap[GD] = Methods.size();
2370 Methods.push_back(GD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002371 OrigMethods.push_back(GD);
Anders Carlssona84b6e82009-12-04 02:01:07 +00002372 }
2373
2374 /// OverrideMethod - Replace a method with another.
2375 void OverrideMethod(GlobalDecl OverriddenGD, GlobalDecl GD) {
2376 llvm::DenseMap<GlobalDecl, uint64_t>::iterator i
2377 = MethodToIndexMap.find(OverriddenGD);
2378 assert(i != MethodToIndexMap.end() && "Did not find entry!");
2379
2380 // Get the index of the old decl.
2381 uint64_t Index = i->second;
2382
2383 // Replace the old decl with the new decl.
2384 Methods[Index] = GD;
2385
Anders Carlssona84b6e82009-12-04 02:01:07 +00002386 // And add the new.
2387 MethodToIndexMap[GD] = Index;
2388 }
2389
Anders Carlsson7bb70762009-12-04 15:49:02 +00002390 /// getIndex - Gives the index of a passed in GlobalDecl. Returns false if
2391 /// the index couldn't be found.
Benjamin Kramer62ab6162009-12-04 22:45:27 +00002392 bool getIndex(GlobalDecl GD, uint64_t &Index) const {
Anders Carlsson7bb70762009-12-04 15:49:02 +00002393 llvm::DenseMap<GlobalDecl, uint64_t>::const_iterator i
2394 = MethodToIndexMap.find(GD);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002395
Anders Carlsson7bb70762009-12-04 15:49:02 +00002396 if (i == MethodToIndexMap.end())
2397 return false;
Anders Carlssone6096362009-12-04 03:41:37 +00002398
Anders Carlsson7bb70762009-12-04 15:49:02 +00002399 Index = i->second;
2400 return true;
Anders Carlssone6096362009-12-04 03:41:37 +00002401 }
2402
Eli Friedman8174f2c2009-12-06 22:01:30 +00002403 GlobalDecl getOrigMethod(uint64_t Index) const {
2404 return OrigMethods[Index];
2405 }
2406
Anders Carlssona84b6e82009-12-04 02:01:07 +00002407 MethodsVectorTy::size_type size() const {
2408 return Methods.size();
2409 }
2410
2411 void clear() {
2412 MethodToIndexMap.clear();
2413 Methods.clear();
Eli Friedman8174f2c2009-12-06 22:01:30 +00002414 OrigMethods.clear();
Anders Carlssona84b6e82009-12-04 02:01:07 +00002415 }
2416
Anders Carlssone6096362009-12-04 03:41:37 +00002417 GlobalDecl operator[](uint64_t Index) const {
Anders Carlssona84b6e82009-12-04 02:01:07 +00002418 return Methods[Index];
2419 }
2420 };
2421
2422 /// Methods - The vtable methods we're currently building.
2423 VtableMethods Methods;
2424
Anders Carlsson4c837d22009-12-04 02:26:15 +00002425 /// ThisAdjustments - For a given index in the vtable, contains the 'this'
2426 /// pointer adjustment needed for a method.
2427 typedef llvm::DenseMap<uint64_t, ThunkAdjustment> ThisAdjustmentsMapTy;
2428 ThisAdjustmentsMapTy ThisAdjustments;
Anders Carlssond420a312009-11-26 19:32:45 +00002429
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002430 SavedAdjustmentsVectorTy SavedAdjustments;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002431
Anders Carlssonc521f952009-12-04 02:22:02 +00002432 /// BaseReturnTypes - Contains the base return types of methods who have been
2433 /// overridden with methods whose return types require adjustment. Used for
2434 /// generating covariant thunk information.
2435 typedef llvm::DenseMap<uint64_t, CanQualType> BaseReturnTypesMapTy;
2436 BaseReturnTypesMapTy BaseReturnTypes;
Anders Carlssond420a312009-11-26 19:32:45 +00002437
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002438 std::vector<Index_t> VCalls;
Mike Stump2cefe382009-11-12 20:47:57 +00002439
2440 typedef std::pair<const CXXRecordDecl *, uint64_t> CtorVtable_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00002441 // subAddressPoints - Used to hold the AddressPoints (offsets) into the built
2442 // vtable for use in computing the initializers for the VTT.
2443 llvm::DenseMap<CtorVtable_t, int64_t> &subAddressPoints;
Mike Stump2cefe382009-11-12 20:47:57 +00002444
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002445 /// AddressPoints - Address points for this vtable.
2446 CGVtableInfo::AddressPointsMapTy& AddressPoints;
2447
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002448 typedef CXXRecordDecl::method_iterator method_iter;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002449 const uint32_t LLVMPointerWidth;
2450 Index_t extra;
Mike Stump37dbe962009-10-15 02:04:03 +00002451 typedef std::vector<std::pair<const CXXRecordDecl *, int64_t> > Path_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00002452 static llvm::DenseMap<CtorVtable_t, int64_t>&
2453 AllocAddressPoint(CodeGenModule &cgm, const CXXRecordDecl *l,
2454 const CXXRecordDecl *c) {
Anders Carlsson93a18842010-01-02 18:02:32 +00002455 CGVtableInfo::AddrMap_t *&oref = cgm.getVtableInfo().AddressPoints[l];
Mike Stumpcd2b8212009-11-19 20:52:19 +00002456 if (oref == 0)
Anders Carlsson93a18842010-01-02 18:02:32 +00002457 oref = new CGVtableInfo::AddrMap_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00002458
2459 llvm::DenseMap<CtorVtable_t, int64_t> *&ref = (*oref)[c];
2460 if (ref == 0)
2461 ref = new llvm::DenseMap<CtorVtable_t, int64_t>;
2462 return *ref;
2463 }
Anders Carlsson323bb042009-11-26 19:54:33 +00002464
Mike Stump90181eb2010-01-26 00:05:04 +00002465 bool DclIsSame(const FunctionDecl *New, const FunctionDecl *Old) {
2466 FunctionTemplateDecl *OldTemplate = Old->getDescribedFunctionTemplate();
2467 FunctionTemplateDecl *NewTemplate = New->getDescribedFunctionTemplate();
2468
2469 // C++ [temp.fct]p2:
2470 // A function template can be overloaded with other function templates
2471 // and with normal (non-template) functions.
2472 if ((OldTemplate == 0) != (NewTemplate == 0))
2473 return false;
2474
2475 // Is the function New an overload of the function Old?
2476 QualType OldQType = CGM.getContext().getCanonicalType(Old->getType());
2477 QualType NewQType = CGM.getContext().getCanonicalType(New->getType());
2478
2479 // Compare the signatures (C++ 1.3.10) of the two functions to
2480 // determine whether they are overloads. If we find any mismatch
2481 // in the signature, they are overloads.
2482
2483 // If either of these functions is a K&R-style function (no
2484 // prototype), then we consider them to have matching signatures.
2485 if (isa<FunctionNoProtoType>(OldQType.getTypePtr()) ||
2486 isa<FunctionNoProtoType>(NewQType.getTypePtr()))
2487 return true;
2488
2489 FunctionProtoType* OldType = cast<FunctionProtoType>(OldQType);
2490 FunctionProtoType* NewType = cast<FunctionProtoType>(NewQType);
2491
2492 // The signature of a function includes the types of its
2493 // parameters (C++ 1.3.10), which includes the presence or absence
2494 // of the ellipsis; see C++ DR 357).
2495 if (OldQType != NewQType &&
2496 (OldType->getNumArgs() != NewType->getNumArgs() ||
2497 OldType->isVariadic() != NewType->isVariadic() ||
2498 !std::equal(OldType->arg_type_begin(), OldType->arg_type_end(),
2499 NewType->arg_type_begin())))
2500 return false;
2501
2502#if 0
2503 // C++ [temp.over.link]p4:
2504 // The signature of a function template consists of its function
2505 // signature, its return type and its template parameter list. The names
2506 // of the template parameters are significant only for establishing the
2507 // relationship between the template parameters and the rest of the
2508 // signature.
2509 //
2510 // We check the return type and template parameter lists for function
2511 // templates first; the remaining checks follow.
2512 if (NewTemplate &&
2513 (!TemplateParameterListsAreEqual(NewTemplate->getTemplateParameters(),
2514 OldTemplate->getTemplateParameters(),
2515 TPL_TemplateMatch) ||
2516 OldType->getResultType() != NewType->getResultType()))
2517 return false;
2518#endif
2519
2520 // If the function is a class member, its signature includes the
2521 // cv-qualifiers (if any) on the function itself.
2522 //
2523 // As part of this, also check whether one of the member functions
2524 // is static, in which case they are not overloads (C++
2525 // 13.1p2). While not part of the definition of the signature,
2526 // this check is important to determine whether these functions
2527 // can be overloaded.
2528 const CXXMethodDecl* OldMethod = dyn_cast<CXXMethodDecl>(Old);
2529 const CXXMethodDecl* NewMethod = dyn_cast<CXXMethodDecl>(New);
2530 if (OldMethod && NewMethod &&
2531 !OldMethod->isStatic() && !NewMethod->isStatic() &&
2532 OldMethod->getTypeQualifiers() != NewMethod->getTypeQualifiers())
2533 return false;
2534
2535 // The signatures match; this is not an overload.
2536 return true;
2537 }
2538
2539 typedef llvm::DenseMap<const CXXMethodDecl *, const CXXMethodDecl*>
2540 ForwardUnique_t;
2541 ForwardUnique_t ForwardUnique;
2542 llvm::DenseMap<const CXXMethodDecl*, const CXXMethodDecl*> UniqueOverrider;
2543
2544 void BuildUniqueOverrider(const CXXMethodDecl *U, const CXXMethodDecl *MD) {
2545 const CXXMethodDecl *PrevU = UniqueOverrider[MD];
2546 assert(U && "no unique overrider");
2547 if (PrevU == U)
2548 return;
2549 if (PrevU != U && PrevU != 0) {
2550 // If already set, note the two sets as the same
2551 if (0)
2552 printf("%s::%s same as %s::%s\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002553 PrevU->getParent()->getNameAsString().c_str(),
2554 PrevU->getNameAsString().c_str(),
2555 U->getParent()->getNameAsString().c_str(),
2556 U->getNameAsString().c_str());
Mike Stump90181eb2010-01-26 00:05:04 +00002557 ForwardUnique[PrevU] = U;
2558 return;
2559 }
2560
2561 // Not set, set it now
2562 if (0)
2563 printf("marking %s::%s %p override as %s::%s\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002564 MD->getParent()->getNameAsString().c_str(),
2565 MD->getNameAsString().c_str(),
Mike Stump90181eb2010-01-26 00:05:04 +00002566 (void*)MD,
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002567 U->getParent()->getNameAsString().c_str(),
2568 U->getNameAsString().c_str());
Mike Stump90181eb2010-01-26 00:05:04 +00002569 UniqueOverrider[MD] = U;
2570
2571 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
2572 me = MD->end_overridden_methods(); mi != me; ++mi) {
2573 BuildUniqueOverrider(U, *mi);
2574 }
2575 }
2576
2577 void BuildUniqueOverriders(const CXXRecordDecl *RD) {
2578 if (0) printf("walking %s\n", RD->getNameAsCString());
2579 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2580 e = RD->method_end(); i != e; ++i) {
2581 const CXXMethodDecl *MD = *i;
2582 if (!MD->isVirtual())
2583 continue;
2584
2585 if (UniqueOverrider[MD] == 0) {
2586 // Only set this, if it hasn't been set yet.
2587 BuildUniqueOverrider(MD, MD);
2588 if (0)
2589 printf("top set is %s::%s %p\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002590 MD->getParent()->getNameAsString().c_str(),
2591 MD->getNameAsString().c_str(),
Mike Stump90181eb2010-01-26 00:05:04 +00002592 (void*)MD);
2593 ForwardUnique[MD] = MD;
2594 }
2595 }
2596 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2597 e = RD->bases_end(); i != e; ++i) {
2598 const CXXRecordDecl *Base =
2599 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2600 BuildUniqueOverriders(Base);
2601 }
2602 }
2603
2604 static int DclCmp(const void *p1, const void *p2) {
John McCallef3057c2010-02-13 01:04:05 +00002605 const CXXMethodDecl *MD1 = *(const CXXMethodDecl *const *)p1;
2606 const CXXMethodDecl *MD2 = *(const CXXMethodDecl *const *)p2;
2607
2608 return (DeclarationName::compare(MD1->getDeclName(), MD2->getDeclName()));
Mike Stump90181eb2010-01-26 00:05:04 +00002609 }
2610
2611 void MergeForwarding() {
2612 typedef llvm::SmallVector<const CXXMethodDecl *, 100> A_t;
2613 A_t A;
2614 for (ForwardUnique_t::iterator I = ForwardUnique.begin(),
2615 E = ForwardUnique.end(); I != E; ++I) {
2616 if (I->first == I->second)
2617 // Only add the roots of all trees
2618 A.push_back(I->first);
2619 }
2620 llvm::array_pod_sort(A.begin(), A.end(), DclCmp);
2621 for (A_t::iterator I = A.begin(),
2622 E = A.end(); I != E; ++I) {
2623 A_t::iterator J = I;
John McCallef3057c2010-02-13 01:04:05 +00002624 while (++J != E && DclCmp(I, J) == 0)
Mike Stump90181eb2010-01-26 00:05:04 +00002625 if (DclIsSame(*I, *J)) {
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002626 if (0) printf("connecting %s\n", (*I)->getNameAsString().c_str());
Mike Stump90181eb2010-01-26 00:05:04 +00002627 ForwardUnique[*J] = *I;
2628 }
2629 }
2630 }
2631
2632 const CXXMethodDecl *getUnique(const CXXMethodDecl *MD) {
2633 const CXXMethodDecl *U = UniqueOverrider[MD];
2634 assert(U && "unique overrider not found");
2635 while (ForwardUnique.count(U)) {
2636 const CXXMethodDecl *NU = ForwardUnique[U];
2637 if (NU == U) break;
2638 U = NU;
2639 }
2640 return U;
2641 }
Anders Carlsson72281172010-01-26 17:36:47 +00002642
2643 GlobalDecl getUnique(GlobalDecl GD) {
2644 const CXXMethodDecl *Unique = getUnique(cast<CXXMethodDecl>(GD.getDecl()));
2645
2646 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(Unique))
2647 return GlobalDecl(CD, GD.getCtorType());
2648
2649 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(Unique))
2650 return GlobalDecl(DD, GD.getDtorType());
2651
2652 return Unique;
Mike Stump90181eb2010-01-26 00:05:04 +00002653 }
2654
Anders Carlsson323bb042009-11-26 19:54:33 +00002655 /// getPureVirtualFn - Return the __cxa_pure_virtual function.
2656 llvm::Constant* getPureVirtualFn() {
2657 if (!PureVirtualFn) {
2658 const llvm::FunctionType *Ty =
2659 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext),
2660 /*isVarArg=*/false);
2661 PureVirtualFn = wrap(CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual"));
2662 }
2663
2664 return PureVirtualFn;
2665 }
2666
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002667public:
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002668 OldVtableBuilder(const CXXRecordDecl *MostDerivedClass,
Eli Friedman6c08ce72009-12-05 01:05:03 +00002669 const CXXRecordDecl *l, uint64_t lo, CodeGenModule &cgm,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002670 bool build, CGVtableInfo::AddressPointsMapTy& AddressPoints)
Eli Friedman6c08ce72009-12-05 01:05:03 +00002671 : BuildVtable(build), MostDerivedClass(MostDerivedClass), LayoutClass(l),
2672 LayoutOffset(lo), BLayout(cgm.getContext().getASTRecordLayout(l)),
2673 rtti(0), VMContext(cgm.getModule().getContext()),CGM(cgm),
2674 PureVirtualFn(0),
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002675 subAddressPoints(AllocAddressPoint(cgm, l, MostDerivedClass)),
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002676 AddressPoints(AddressPoints),
2677 LLVMPointerWidth(cgm.getContext().Target.getPointerWidth(0))
2678 {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002679 Ptr8Ty = llvm::PointerType::get(llvm::Type::getInt8Ty(VMContext), 0);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002680 if (BuildVtable) {
2681 QualType ClassType = CGM.getContext().getTagDeclType(MostDerivedClass);
2682 rtti = CGM.GetAddrOfRTTIDescriptor(ClassType);
2683 }
Mike Stump90181eb2010-01-26 00:05:04 +00002684 BuildUniqueOverriders(MostDerivedClass);
2685 MergeForwarding();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002686 }
2687
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002688 // getVtableComponents - Returns a reference to the vtable components.
2689 const VtableComponentsVectorTy &getVtableComponents() const {
2690 return VtableComponents;
Anders Carlsson472404f2009-12-04 16:19:30 +00002691 }
2692
Anders Carlssone36a6b32010-01-02 01:01:18 +00002693 llvm::DenseMap<const CXXRecordDecl *, uint64_t> &getVBIndex()
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002694 { return VBIndex; }
2695
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002696 SavedAdjustmentsVectorTy &getSavedAdjustments()
2697 { return SavedAdjustments; }
Eli Friedman8174f2c2009-12-06 22:01:30 +00002698
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002699 llvm::Constant *wrap(Index_t i) {
2700 llvm::Constant *m;
2701 m = llvm::ConstantInt::get(llvm::Type::getInt64Ty(VMContext), i);
2702 return llvm::ConstantExpr::getIntToPtr(m, Ptr8Ty);
2703 }
2704
2705 llvm::Constant *wrap(llvm::Constant *m) {
2706 return llvm::ConstantExpr::getBitCast(m, Ptr8Ty);
2707 }
2708
Mike Stumpd2808442010-01-22 02:51:26 +00002709//#define D1(x)
Douglas Gregorf4f2e022010-02-22 16:48:26 +00002710#define D1(X) do { if (getenv("CLANG_VTABLE_DEBUG")) { X; } } while (0)
Mike Stump75ce5732009-10-31 20:06:59 +00002711
2712 void GenerateVBaseOffsets(const CXXRecordDecl *RD, uint64_t Offset,
Mike Stump28431212009-10-13 22:54:56 +00002713 bool updateVBIndex, Index_t current_vbindex) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002714 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2715 e = RD->bases_end(); i != e; ++i) {
2716 const CXXRecordDecl *Base =
2717 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump28431212009-10-13 22:54:56 +00002718 Index_t next_vbindex = current_vbindex;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002719 if (i->isVirtual() && !SeenVBase.count(Base)) {
2720 SeenVBase.insert(Base);
Mike Stump28431212009-10-13 22:54:56 +00002721 if (updateVBIndex) {
Mike Stump75ce5732009-10-31 20:06:59 +00002722 next_vbindex = (ssize_t)(-(VCalls.size()*LLVMPointerWidth/8)
Mike Stump28431212009-10-13 22:54:56 +00002723 - 3*LLVMPointerWidth/8);
2724 VBIndex[Base] = next_vbindex;
2725 }
Mike Stump75ce5732009-10-31 20:06:59 +00002726 int64_t BaseOffset = -(Offset/8) + BLayout.getVBaseClassOffset(Base)/8;
2727 VCalls.push_back((0?700:0) + BaseOffset);
2728 D1(printf(" vbase for %s at %d delta %d most derived %s\n",
2729 Base->getNameAsCString(),
2730 (int)-VCalls.size()-3, (int)BaseOffset,
Mike Stumpd2808442010-01-22 02:51:26 +00002731 MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002732 }
Mike Stump28431212009-10-13 22:54:56 +00002733 // We also record offsets for non-virtual bases to closest enclosing
2734 // virtual base. We do this so that we don't have to search
2735 // for the nearst virtual base class when generating thunks.
2736 if (updateVBIndex && VBIndex.count(Base) == 0)
2737 VBIndex[Base] = next_vbindex;
Mike Stump75ce5732009-10-31 20:06:59 +00002738 GenerateVBaseOffsets(Base, Offset, updateVBIndex, next_vbindex);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002739 }
2740 }
2741
2742 void StartNewTable() {
2743 SeenVBase.clear();
2744 }
2745
Mike Stump8bccbfd2009-10-15 09:30:16 +00002746 Index_t getNVOffset_1(const CXXRecordDecl *D, const CXXRecordDecl *B,
2747 Index_t Offset = 0) {
2748
2749 if (B == D)
2750 return Offset;
2751
2752 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(D);
2753 for (CXXRecordDecl::base_class_const_iterator i = D->bases_begin(),
2754 e = D->bases_end(); i != e; ++i) {
2755 const CXXRecordDecl *Base =
2756 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2757 int64_t BaseOffset = 0;
2758 if (!i->isVirtual())
2759 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
2760 int64_t o = getNVOffset_1(Base, B, BaseOffset);
2761 if (o >= 0)
2762 return o;
2763 }
2764
2765 return -1;
2766 }
2767
2768 /// getNVOffset - Returns the non-virtual offset for the given (B) base of the
2769 /// derived class D.
2770 Index_t getNVOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00002771 qD = qD->getPointeeType();
2772 qB = qB->getPointeeType();
Mike Stump8bccbfd2009-10-15 09:30:16 +00002773 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
2774 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
2775 int64_t o = getNVOffset_1(D, B);
2776 if (o >= 0)
2777 return o;
2778
2779 assert(false && "FIXME: non-virtual base not found");
2780 return 0;
2781 }
2782
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002783 /// getVbaseOffset - Returns the index into the vtable for the virtual base
2784 /// offset for the given (B) virtual base of the derived class D.
2785 Index_t getVbaseOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00002786 qD = qD->getPointeeType();
2787 qB = qB->getPointeeType();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002788 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
2789 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002790 if (D != MostDerivedClass)
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00002791 return CGM.getVtableInfo().getVirtualBaseOffsetOffset(D, B);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002792 llvm::DenseMap<const CXXRecordDecl *, Index_t>::iterator i;
2793 i = VBIndex.find(B);
2794 if (i != VBIndex.end())
2795 return i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002796
Mike Stump28431212009-10-13 22:54:56 +00002797 assert(false && "FIXME: Base not found");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002798 return 0;
2799 }
2800
Eli Friedman81fb0d22009-12-04 08:40:51 +00002801 bool OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
2802 Index_t OverrideOffset, Index_t Offset,
2803 int64_t CurrentVBaseOffset);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002804
Anders Carlsson495634e2009-12-04 02:39:04 +00002805 /// AppendMethods - Append the current methods to the vtable.
Anders Carlssonddf42c82009-12-04 02:56:03 +00002806 void AppendMethodsToVtable();
Anders Carlsson495634e2009-12-04 02:39:04 +00002807
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002808 llvm::Constant *WrapAddrOf(GlobalDecl GD) {
2809 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2810
Anders Carlsson64457732009-11-24 05:08:52 +00002811 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVtable(MD);
Mike Stump18e8b472009-10-27 23:36:26 +00002812
Mike Stumpcdeb8002009-12-03 16:55:20 +00002813 return wrap(CGM.GetAddrOfFunction(GD, Ty));
Mike Stump18e8b472009-10-27 23:36:26 +00002814 }
2815
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002816 void OverrideMethods(Path_t *Path, bool MorallyVirtual, int64_t Offset,
2817 int64_t CurrentVBaseOffset) {
Mike Stump37dbe962009-10-15 02:04:03 +00002818 for (Path_t::reverse_iterator i = Path->rbegin(),
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002819 e = Path->rend(); i != e; ++i) {
2820 const CXXRecordDecl *RD = i->first;
Mike Stump8bccbfd2009-10-15 09:30:16 +00002821 int64_t OverrideOffset = i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002822 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
2823 ++mi) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002824 const CXXMethodDecl *MD = *mi;
2825
2826 if (!MD->isVirtual())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002827 continue;
2828
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002829 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2830 // Override both the complete and the deleting destructor.
2831 GlobalDecl CompDtor(DD, Dtor_Complete);
Eli Friedman81fb0d22009-12-04 08:40:51 +00002832 OverrideMethod(CompDtor, MorallyVirtual, OverrideOffset, Offset,
2833 CurrentVBaseOffset);
2834
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002835 GlobalDecl DeletingDtor(DD, Dtor_Deleting);
Eli Friedman81fb0d22009-12-04 08:40:51 +00002836 OverrideMethod(DeletingDtor, MorallyVirtual, OverrideOffset, Offset,
2837 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002838 } else {
Eli Friedman81fb0d22009-12-04 08:40:51 +00002839 OverrideMethod(MD, MorallyVirtual, OverrideOffset, Offset,
2840 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002841 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002842 }
2843 }
2844 }
2845
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002846 void AddMethod(const GlobalDecl GD, bool MorallyVirtual, Index_t Offset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002847 int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002848 // If we can find a previously allocated slot for this, reuse it.
Eli Friedman81fb0d22009-12-04 08:40:51 +00002849 if (OverrideMethod(GD, MorallyVirtual, Offset, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002850 CurrentVBaseOffset))
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002851 return;
2852
Mike Stump1f49d652010-01-22 18:48:47 +00002853 D1(printf(" vfn for %s at %d\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002854 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsString().c_str(),
Mike Stump1f49d652010-01-22 18:48:47 +00002855 (int)Methods.size()));
2856
Anders Carlssoncdf18982009-12-04 02:08:24 +00002857 // We didn't find an entry in the vtable that we could use, add a new
2858 // entry.
2859 Methods.AddMethod(GD);
2860
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002861 VCallOffset[GD] = Offset/8 - CurrentVBaseOffset/8;
2862
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002863 if (MorallyVirtual) {
Anders Carlsson72281172010-01-26 17:36:47 +00002864 GlobalDecl UGD = getUnique(GD);
2865 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
2866
Mike Stump90181eb2010-01-26 00:05:04 +00002867 assert(UMD && "final overrider not found");
2868
2869 Index_t &idx = VCall[UMD];
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002870 // Allocate the first one, after that, we reuse the previous one.
2871 if (idx == 0) {
Anders Carlsson72281172010-01-26 17:36:47 +00002872 VCallOffsetForVCall[UGD] = Offset/8;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002873 NonVirtualOffset[UMD] = Offset/8 - CurrentVBaseOffset/8;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002874 idx = VCalls.size()+1;
Mike Stump90181eb2010-01-26 00:05:04 +00002875 VCalls.push_back(Offset/8 - CurrentVBaseOffset/8);
Mike Stump75ce5732009-10-31 20:06:59 +00002876 D1(printf(" vcall for %s at %d with delta %d\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002877 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsString().c_str(),
Mike Stump90181eb2010-01-26 00:05:04 +00002878 (int)-VCalls.size()-3, (int)VCalls[idx-1]));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002879 }
2880 }
2881 }
2882
2883 void AddMethods(const CXXRecordDecl *RD, bool MorallyVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002884 Index_t Offset, int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002885 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002886 ++mi) {
2887 const CXXMethodDecl *MD = *mi;
2888 if (!MD->isVirtual())
2889 continue;
2890
2891 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2892 // For destructors, add both the complete and the deleting destructor
2893 // to the vtable.
2894 AddMethod(GlobalDecl(DD, Dtor_Complete), MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002895 CurrentVBaseOffset);
Eli Friedman03aa2f12009-11-30 01:19:33 +00002896 AddMethod(GlobalDecl(DD, Dtor_Deleting), MorallyVirtual, Offset,
2897 CurrentVBaseOffset);
2898 } else
2899 AddMethod(MD, MorallyVirtual, Offset, CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002900 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002901 }
2902
2903 void NonVirtualBases(const CXXRecordDecl *RD, const ASTRecordLayout &Layout,
2904 const CXXRecordDecl *PrimaryBase,
2905 bool PrimaryBaseWasVirtual, bool MorallyVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002906 int64_t Offset, int64_t CurrentVBaseOffset,
2907 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00002908 Path->push_back(std::make_pair(RD, Offset));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002909 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2910 e = RD->bases_end(); i != e; ++i) {
2911 if (i->isVirtual())
2912 continue;
2913 const CXXRecordDecl *Base =
2914 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump9eb76d42010-01-22 06:45:05 +00002915 uint64_t o = Offset + Layout.getBaseClassOffset(Base);
2916 StartNewTable();
2917 GenerateVtableForBase(Base, o, MorallyVirtual, false,
2918 true, Base == PrimaryBase && !PrimaryBaseWasVirtual,
2919 CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002920 }
Mike Stump37dbe962009-10-15 02:04:03 +00002921 Path->pop_back();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002922 }
2923
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002924// #define D(X) do { X; } while (0)
2925#define D(X)
2926
2927 void insertVCalls(int InsertionPoint) {
Mike Stump75ce5732009-10-31 20:06:59 +00002928 D1(printf("============= combining vbase/vcall\n"));
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002929 D(VCalls.insert(VCalls.begin(), 673));
2930 D(VCalls.push_back(672));
Eli Friedman6c08ce72009-12-05 01:05:03 +00002931
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002932 VtableComponents.insert(VtableComponents.begin() + InsertionPoint,
2933 VCalls.size(), 0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002934 if (BuildVtable) {
2935 // The vcalls come first...
2936 for (std::vector<Index_t>::reverse_iterator i = VCalls.rbegin(),
2937 e = VCalls.rend();
2938 i != e; ++i)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002939 VtableComponents[InsertionPoint++] = wrap((0?600:0) + *i);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002940 }
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002941 VCalls.clear();
Mike Stump9f23a142009-11-10 02:30:51 +00002942 VCall.clear();
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002943 VCallOffsetForVCall.clear();
2944 VCallOffset.clear();
2945 NonVirtualOffset.clear();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002946 }
2947
Mike Stump559387f2009-11-13 23:13:20 +00002948 void AddAddressPoints(const CXXRecordDecl *RD, uint64_t Offset,
2949 Index_t AddressPoint) {
2950 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002951 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00002952 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00002953 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002954 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00002955
2956 // Now also add the address point for all our primary bases.
2957 while (1) {
2958 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2959 RD = Layout.getPrimaryBase();
2960 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2961 // FIXME: Double check this.
2962 if (RD == 0)
2963 break;
2964 if (PrimaryBaseWasVirtual &&
2965 BLayout.getVBaseClassOffset(RD) != Offset)
2966 break;
2967 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002968 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00002969 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00002970 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002971 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00002972 }
2973 }
2974
2975
Mike Stumpd538a6d2009-12-24 07:29:41 +00002976 void FinishGenerateVtable(const CXXRecordDecl *RD,
2977 const ASTRecordLayout &Layout,
2978 const CXXRecordDecl *PrimaryBase,
Mike Stump9eb76d42010-01-22 06:45:05 +00002979 bool ForNPNVBases, bool WasPrimaryBase,
Mike Stumpd538a6d2009-12-24 07:29:41 +00002980 bool PrimaryBaseWasVirtual,
2981 bool MorallyVirtual, int64_t Offset,
2982 bool ForVirtualBase, int64_t CurrentVBaseOffset,
2983 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00002984 bool alloc = false;
2985 if (Path == 0) {
2986 alloc = true;
2987 Path = new Path_t;
2988 }
2989
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002990 StartNewTable();
2991 extra = 0;
Mike Stump9eb76d42010-01-22 06:45:05 +00002992 Index_t AddressPoint = 0;
2993 int VCallInsertionPoint = 0;
2994 if (!ForNPNVBases || !WasPrimaryBase) {
2995 bool DeferVCalls = MorallyVirtual || ForVirtualBase;
2996 VCallInsertionPoint = VtableComponents.size();
2997 if (!DeferVCalls) {
2998 insertVCalls(VCallInsertionPoint);
2999 } else
3000 // FIXME: just for extra, or for all uses of VCalls.size post this?
3001 extra = -VCalls.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003002
Mike Stump9eb76d42010-01-22 06:45:05 +00003003 // Add the offset to top.
3004 VtableComponents.push_back(BuildVtable ? wrap(-((Offset-LayoutOffset)/8)) : 0);
Anders Carlsson472404f2009-12-04 16:19:30 +00003005
Mike Stump9eb76d42010-01-22 06:45:05 +00003006 // Add the RTTI information.
3007 VtableComponents.push_back(rtti);
Anders Carlsson472404f2009-12-04 16:19:30 +00003008
Mike Stump9eb76d42010-01-22 06:45:05 +00003009 AddressPoint = VtableComponents.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003010
Mike Stump9eb76d42010-01-22 06:45:05 +00003011 AppendMethodsToVtable();
3012 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003013
3014 // and then the non-virtual bases.
3015 NonVirtualBases(RD, Layout, PrimaryBase, PrimaryBaseWasVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003016 MorallyVirtual, Offset, CurrentVBaseOffset, Path);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003017
3018 if (ForVirtualBase) {
Mike Stump2cefe382009-11-12 20:47:57 +00003019 // FIXME: We're adding to VCalls in callers, we need to do the overrides
3020 // in the inner part, so that we know the complete set of vcalls during
3021 // the build and don't have to insert into methods. Saving out the
3022 // AddressPoint here, would need to be fixed, if we didn't do that. Also
3023 // retroactively adding vcalls for overrides later wind up in the wrong
3024 // place, the vcall slot has to be alloted during the walk of the base
3025 // when the function is first introduces.
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003026 AddressPoint += VCalls.size();
Mike Stump2cefe382009-11-12 20:47:57 +00003027 insertVCalls(VCallInsertionPoint);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003028 }
3029
Mike Stump9eb76d42010-01-22 06:45:05 +00003030 if (!ForNPNVBases || !WasPrimaryBase)
3031 AddAddressPoints(RD, Offset, AddressPoint);
Mike Stump2cefe382009-11-12 20:47:57 +00003032
Mike Stump37dbe962009-10-15 02:04:03 +00003033 if (alloc) {
3034 delete Path;
3035 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003036 }
3037
Mike Stump75ce5732009-10-31 20:06:59 +00003038 void Primaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
3039 bool updateVBIndex, Index_t current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00003040 int64_t CurrentVBaseOffset) {
Mike Stump75ce5732009-10-31 20:06:59 +00003041 if (!RD->isDynamicClass())
3042 return;
3043
3044 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3045 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3046 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
3047
3048 // vtables are composed from the chain of primaries.
Eli Friedman65d87222009-12-04 08:52:11 +00003049 if (PrimaryBase && !PrimaryBaseWasVirtual) {
Mike Stump75ce5732009-10-31 20:06:59 +00003050 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003051 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Eli Friedman65d87222009-12-04 08:52:11 +00003052 Primaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
3053 updateVBIndex, current_vbindex, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00003054 }
3055
3056 D1(printf(" doing vcall entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003057 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00003058
3059 // And add the virtuals for the class to the primary vtable.
Eli Friedman03aa2f12009-11-30 01:19:33 +00003060 AddMethods(RD, MorallyVirtual, Offset, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00003061 }
3062
3063 void VBPrimaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
3064 bool updateVBIndex, Index_t current_vbindex,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003065 bool RDisVirtualBase, int64_t CurrentVBaseOffset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00003066 bool bottom) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003067 if (!RD->isDynamicClass())
3068 return;
3069
3070 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3071 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3072 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
3073
3074 // vtables are composed from the chain of primaries.
3075 if (PrimaryBase) {
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003076 int BaseCurrentVBaseOffset = CurrentVBaseOffset;
3077 if (PrimaryBaseWasVirtual) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003078 IndirectPrimary.insert(PrimaryBase);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003079 BaseCurrentVBaseOffset = BLayout.getVBaseClassOffset(PrimaryBase);
3080 }
Mike Stump75ce5732009-10-31 20:06:59 +00003081
3082 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003083 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00003084
3085 VBPrimaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003086 updateVBIndex, current_vbindex, PrimaryBaseWasVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00003087 BaseCurrentVBaseOffset, false);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003088 }
3089
Mike Stump75ce5732009-10-31 20:06:59 +00003090 D1(printf(" doing vbase entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003091 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00003092 GenerateVBaseOffsets(RD, Offset, updateVBIndex, current_vbindex);
3093
3094 if (RDisVirtualBase || bottom) {
3095 Primaries(RD, MorallyVirtual, Offset, updateVBIndex, current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00003096 CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00003097 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003098 }
3099
Mike Stumpd538a6d2009-12-24 07:29:41 +00003100 void GenerateVtableForBase(const CXXRecordDecl *RD, int64_t Offset = 0,
3101 bool MorallyVirtual = false,
3102 bool ForVirtualBase = false,
Mike Stump9eb76d42010-01-22 06:45:05 +00003103 bool ForNPNVBases = false,
3104 bool WasPrimaryBase = true,
Mike Stumpd538a6d2009-12-24 07:29:41 +00003105 int CurrentVBaseOffset = 0,
3106 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003107 if (!RD->isDynamicClass())
Mike Stumpd538a6d2009-12-24 07:29:41 +00003108 return;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003109
Mike Stumpfa818082009-11-13 02:35:38 +00003110 // Construction vtable don't need parts that have no virtual bases and
3111 // aren't morally virtual.
Anders Carlssonbad80eb2009-12-04 18:36:22 +00003112 if ((LayoutClass != MostDerivedClass) &&
3113 RD->getNumVBases() == 0 && !MorallyVirtual)
Mike Stumpd538a6d2009-12-24 07:29:41 +00003114 return;
Mike Stumpfa818082009-11-13 02:35:38 +00003115
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003116 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3117 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3118 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
3119
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003120 extra = 0;
Mike Stump75ce5732009-10-31 20:06:59 +00003121 D1(printf("building entries for base %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003122 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003123
Mike Stump75ce5732009-10-31 20:06:59 +00003124 if (ForVirtualBase)
3125 extra = VCalls.size();
3126
Mike Stump9eb76d42010-01-22 06:45:05 +00003127 if (!ForNPNVBases || !WasPrimaryBase) {
3128 VBPrimaries(RD, MorallyVirtual, Offset, !ForVirtualBase, 0,
3129 ForVirtualBase, CurrentVBaseOffset, true);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003130
Mike Stump9eb76d42010-01-22 06:45:05 +00003131 if (Path)
3132 OverrideMethods(Path, MorallyVirtual, Offset, CurrentVBaseOffset);
3133 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003134
Mike Stump9eb76d42010-01-22 06:45:05 +00003135 FinishGenerateVtable(RD, Layout, PrimaryBase, ForNPNVBases, WasPrimaryBase,
3136 PrimaryBaseWasVirtual, MorallyVirtual, Offset,
3137 ForVirtualBase, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003138 }
3139
3140 void GenerateVtableForVBases(const CXXRecordDecl *RD,
3141 int64_t Offset = 0,
Mike Stump37dbe962009-10-15 02:04:03 +00003142 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003143 bool alloc = false;
3144 if (Path == 0) {
3145 alloc = true;
Mike Stump37dbe962009-10-15 02:04:03 +00003146 Path = new Path_t;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003147 }
3148 // FIXME: We also need to override using all paths to a virtual base,
3149 // right now, we just process the first path
3150 Path->push_back(std::make_pair(RD, Offset));
3151 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
3152 e = RD->bases_end(); i != e; ++i) {
3153 const CXXRecordDecl *Base =
3154 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
3155 if (i->isVirtual() && !IndirectPrimary.count(Base)) {
3156 // Mark it so we don't output it twice.
3157 IndirectPrimary.insert(Base);
3158 StartNewTable();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003159 VCall.clear();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003160 int64_t BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003161 int64_t CurrentVBaseOffset = BaseOffset;
Mike Stump75ce5732009-10-31 20:06:59 +00003162 D1(printf("vtable %s virtual base %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003163 MostDerivedClass->getNameAsCString(), Base->getNameAsCString()));
Mike Stump9eb76d42010-01-22 06:45:05 +00003164 GenerateVtableForBase(Base, BaseOffset, true, true, false,
3165 true, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003166 }
Mike Stump2cefe382009-11-12 20:47:57 +00003167 int64_t BaseOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003168 if (i->isVirtual())
3169 BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stump2cefe382009-11-12 20:47:57 +00003170 else {
3171 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3172 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
3173 }
3174
Mike Stump37dbe962009-10-15 02:04:03 +00003175 if (Base->getNumVBases()) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003176 GenerateVtableForVBases(Base, BaseOffset, Path);
Mike Stump37dbe962009-10-15 02:04:03 +00003177 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003178 }
3179 Path->pop_back();
3180 if (alloc)
3181 delete Path;
3182 }
3183};
Anders Carlssonca1bf682009-12-03 01:54:02 +00003184} // end anonymous namespace
3185
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003186bool OldVtableBuilder::OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
Eli Friedman81fb0d22009-12-04 08:40:51 +00003187 Index_t OverrideOffset, Index_t Offset,
3188 int64_t CurrentVBaseOffset) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00003189 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
3190
3191 const bool isPure = MD->isPure();
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00003192
Anders Carlssonca1bf682009-12-03 01:54:02 +00003193 // FIXME: Should OverrideOffset's be Offset?
3194
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00003195 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
3196 e = MD->end_overridden_methods(); mi != e; ++mi) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00003197 GlobalDecl OGD;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003198 GlobalDecl OGD2;
Anders Carlssonca1bf682009-12-03 01:54:02 +00003199
Anders Carlssonf3935b42009-12-04 05:51:56 +00003200 const CXXMethodDecl *OMD = *mi;
Anders Carlssonca1bf682009-12-03 01:54:02 +00003201 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(OMD))
3202 OGD = GlobalDecl(DD, GD.getDtorType());
3203 else
3204 OGD = OMD;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003205
Eli Friedman8174f2c2009-12-06 22:01:30 +00003206 // Check whether this is the method being overridden in this section of
3207 // the vtable.
Anders Carlsson7bb70762009-12-04 15:49:02 +00003208 uint64_t Index;
3209 if (!Methods.getIndex(OGD, Index))
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003210 continue;
3211
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003212 OGD2 = OGD;
3213
Eli Friedman8174f2c2009-12-06 22:01:30 +00003214 // Get the original method, which we should be computing thunks, etc,
3215 // against.
3216 OGD = Methods.getOrigMethod(Index);
3217 OMD = cast<CXXMethodDecl>(OGD.getDecl());
3218
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003219 QualType ReturnType =
3220 MD->getType()->getAs<FunctionType>()->getResultType();
3221 QualType OverriddenReturnType =
3222 OMD->getType()->getAs<FunctionType>()->getResultType();
Anders Carlssonca1bf682009-12-03 01:54:02 +00003223
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003224 // Check if we need a return type adjustment.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00003225 if (!ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
3226 OMD).isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003227 CanQualType &BaseReturnType = BaseReturnTypes[Index];
Anders Carlssonca1bf682009-12-03 01:54:02 +00003228
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003229 // Insert the base return type.
3230 if (BaseReturnType.isNull())
3231 BaseReturnType =
3232 CGM.getContext().getCanonicalType(OverriddenReturnType);
3233 }
Anders Carlssona93e9802009-12-04 03:52:52 +00003234
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003235 Methods.OverrideMethod(OGD, GD);
3236
Anders Carlsson72281172010-01-26 17:36:47 +00003237 GlobalDecl UGD = getUnique(GD);
3238 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
3239 assert(UGD.getDecl() && "unique overrider not found");
3240 assert(UGD == getUnique(OGD) && "unique overrider not unique");
Mike Stump90181eb2010-01-26 00:05:04 +00003241
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003242 ThisAdjustments.erase(Index);
Mike Stump90181eb2010-01-26 00:05:04 +00003243 if (MorallyVirtual || VCall.count(UMD)) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003244
Mike Stump90181eb2010-01-26 00:05:04 +00003245 Index_t &idx = VCall[UMD];
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003246 if (idx == 0) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003247 VCallOffset[GD] = VCallOffset[OGD];
3248 // NonVirtualOffset[UMD] = CurrentVBaseOffset/8 - OverrideOffset/8;
3249 NonVirtualOffset[UMD] = VCallOffset[OGD];
Mike Stump77537b12010-01-26 03:42:22 +00003250 VCallOffsetForVCall[UMD] = OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003251 idx = VCalls.size()+1;
Mike Stump77537b12010-01-26 03:42:22 +00003252 VCalls.push_back(OverrideOffset/8 - CurrentVBaseOffset/8);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003253 D1(printf(" vcall for %s at %d with delta %d most derived %s\n",
3254 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00003255 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003256 } else {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003257 VCallOffset[GD] = NonVirtualOffset[UMD];
Anders Carlsson72281172010-01-26 17:36:47 +00003258 VCalls[idx-1] = -VCallOffsetForVCall[UGD] + OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003259 D1(printf(" vcall patch for %s at %d with delta %d most derived %s\n",
3260 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00003261 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003262 }
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003263 int64_t NonVirtualAdjustment = -VCallOffset[OGD];
Mike Stumpded0a402010-01-26 22:44:01 +00003264 QualType DerivedType = MD->getThisType(CGM.getContext());
3265 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
3266 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
3267 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
3268 NonVirtualAdjustment = NonVirtualAdjustment2;
3269 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003270 int64_t VirtualAdjustment =
3271 -((idx + extra + 2) * LLVMPointerWidth / 8);
Anders Carlsson657f1392009-12-03 02:32:59 +00003272
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003273 // Optimize out virtual adjustments of 0.
3274 if (VCalls[idx-1] == 0)
3275 VirtualAdjustment = 0;
Anders Carlsson657f1392009-12-03 02:32:59 +00003276
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003277 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment,
3278 VirtualAdjustment);
Anders Carlsson2ca285f2009-12-03 02:22:59 +00003279
Eli Friedman8174f2c2009-12-06 22:01:30 +00003280 if (!isPure && !ThisAdjustment.isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003281 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003282 SavedAdjustments.push_back(
3283 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedman8174f2c2009-12-06 22:01:30 +00003284 }
Anders Carlssonca1bf682009-12-03 01:54:02 +00003285 return true;
3286 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003287
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003288 VCallOffset[GD] = VCallOffset[OGD2] - OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003289
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003290 int64_t NonVirtualAdjustment = -VCallOffset[GD];
3291 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 }
3297
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003298 if (NonVirtualAdjustment) {
3299 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment, 0);
3300
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00003301 if (!isPure) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003302 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003303 SavedAdjustments.push_back(
3304 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00003305 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003306 }
3307 return true;
Anders Carlssonca1bf682009-12-03 01:54:02 +00003308 }
3309
3310 return false;
Anders Carlssond59885022009-11-27 22:21:51 +00003311}
3312
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003313void OldVtableBuilder::AppendMethodsToVtable() {
Eli Friedman6c08ce72009-12-05 01:05:03 +00003314 if (!BuildVtable) {
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003315 VtableComponents.insert(VtableComponents.end(), Methods.size(),
3316 (llvm::Constant *)0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00003317 ThisAdjustments.clear();
3318 BaseReturnTypes.clear();
3319 Methods.clear();
3320 return;
3321 }
3322
Anders Carlsson472404f2009-12-04 16:19:30 +00003323 // Reserve room in the vtable for our new methods.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003324 VtableComponents.reserve(VtableComponents.size() + Methods.size());
Anders Carlssonb07567c2009-12-04 03:07:26 +00003325
Anders Carlsson86809cd2009-12-04 02:43:50 +00003326 for (unsigned i = 0, e = Methods.size(); i != e; ++i) {
3327 GlobalDecl GD = Methods[i];
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003328 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
3329
3330 // Get the 'this' pointer adjustment.
Anders Carlsson86809cd2009-12-04 02:43:50 +00003331 ThunkAdjustment ThisAdjustment = ThisAdjustments.lookup(i);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003332
3333 // Construct the return type adjustment.
3334 ThunkAdjustment ReturnAdjustment;
3335
3336 QualType BaseReturnType = BaseReturnTypes.lookup(i);
3337 if (!BaseReturnType.isNull() && !MD->isPure()) {
3338 QualType DerivedType =
3339 MD->getType()->getAs<FunctionType>()->getResultType();
3340
3341 int64_t NonVirtualAdjustment =
3342 getNVOffset(BaseReturnType, DerivedType) / 8;
3343
3344 int64_t VirtualAdjustment =
3345 getVbaseOffset(BaseReturnType, DerivedType);
3346
3347 ReturnAdjustment = ThunkAdjustment(NonVirtualAdjustment,
3348 VirtualAdjustment);
3349 }
3350
Anders Carlsson50f14742009-12-04 03:06:03 +00003351 llvm::Constant *Method = 0;
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003352 if (!ReturnAdjustment.isEmpty()) {
3353 // Build a covariant thunk.
3354 CovariantThunkAdjustment Adjustment(ThisAdjustment, ReturnAdjustment);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003355 Method = wrap(CGM.GetAddrOfCovariantThunk(GD, Adjustment));
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003356 } else if (!ThisAdjustment.isEmpty()) {
3357 // Build a "regular" thunk.
Eli Friedman8174f2c2009-12-06 22:01:30 +00003358 Method = wrap(CGM.GetAddrOfThunk(GD, ThisAdjustment));
Anders Carlssonddf42c82009-12-04 02:56:03 +00003359 } else if (MD->isPure()) {
3360 // We have a pure virtual method.
Anders Carlsson50f14742009-12-04 03:06:03 +00003361 Method = getPureVirtualFn();
3362 } else {
3363 // We have a good old regular method.
3364 Method = WrapAddrOf(GD);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003365 }
Anders Carlsson50f14742009-12-04 03:06:03 +00003366
3367 // Add the method to the vtable.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003368 VtableComponents.push_back(Method);
Anders Carlsson86809cd2009-12-04 02:43:50 +00003369 }
3370
Anders Carlsson50f14742009-12-04 03:06:03 +00003371
Anders Carlsson86809cd2009-12-04 02:43:50 +00003372 ThisAdjustments.clear();
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003373 BaseReturnTypes.clear();
Anders Carlsson86809cd2009-12-04 02:43:50 +00003374
Anders Carlsson495634e2009-12-04 02:39:04 +00003375 Methods.clear();
Anders Carlsson495634e2009-12-04 02:39:04 +00003376}
3377
Anders Carlssonf942ee02009-11-27 20:47:55 +00003378void CGVtableInfo::ComputeMethodVtableIndices(const CXXRecordDecl *RD) {
3379
3380 // Itanium C++ ABI 2.5.2:
Anders Carlsson259688c2010-02-02 03:37:46 +00003381 // The order of the virtual function pointers in a virtual table is the
3382 // order of declaration of the corresponding member functions in the class.
Anders Carlssonf942ee02009-11-27 20:47:55 +00003383 //
Anders Carlsson259688c2010-02-02 03:37:46 +00003384 // There is an entry for any virtual function declared in a class,
3385 // whether it is a new function or overrides a base class function,
3386 // unless it overrides a function from the primary base, and conversion
3387 // between their return types does not require an adjustment.
Anders Carlssonf942ee02009-11-27 20:47:55 +00003388
3389 int64_t CurrentIndex = 0;
3390
3391 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3392 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3393
3394 if (PrimaryBase) {
Anders Carlssonc920fa22009-11-30 19:43:26 +00003395 assert(PrimaryBase->isDefinition() &&
3396 "Should have the definition decl of the primary base!");
Anders Carlssonf942ee02009-11-27 20:47:55 +00003397
3398 // Since the record decl shares its vtable pointer with the primary base
3399 // we need to start counting at the end of the primary base's vtable.
3400 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
3401 }
Eli Friedman21517252009-12-15 03:31:17 +00003402
3403 // Collect all the primary bases, so we can check whether methods override
3404 // a method from the base.
Anders Carlssond46ed892010-02-27 16:18:19 +00003405 VtableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Eli Friedman21517252009-12-15 03:31:17 +00003406 for (ASTRecordLayout::primary_base_info_iterator
3407 I = Layout.primary_base_begin(), E = Layout.primary_base_end();
3408 I != E; ++I)
3409 PrimaryBases.insert((*I).getBase());
3410
Anders Carlssonf942ee02009-11-27 20:47:55 +00003411 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
3412
3413 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
3414 e = RD->method_end(); i != e; ++i) {
3415 const CXXMethodDecl *MD = *i;
3416
3417 // We only want virtual methods.
3418 if (!MD->isVirtual())
3419 continue;
3420
Anders Carlssonf942ee02009-11-27 20:47:55 +00003421 // Check if this method overrides a method in the primary base.
Anders Carlsson65b49782010-02-12 05:25:12 +00003422 if (const CXXMethodDecl *OverriddenMD =
Anders Carlssond2025412010-02-27 06:38:03 +00003423 OverridesMethodInBases(MD, PrimaryBases)) {
Anders Carlsson65b49782010-02-12 05:25:12 +00003424 // Check if converting from the return type of the method to the
3425 // return type of the overridden method requires conversion.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00003426 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
3427 OverriddenMD).isEmpty()) {
Anders Carlsson65b49782010-02-12 05:25:12 +00003428 // This index is shared between the index in the vtable of the primary
3429 // base class.
3430 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
3431 const CXXDestructorDecl *OverriddenDD =
3432 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00003433
Anders Carlsson65b49782010-02-12 05:25:12 +00003434 // Add both the complete and deleting entries.
3435 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] =
3436 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
3437 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] =
3438 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
3439 } else {
3440 MethodVtableIndices[MD] = getMethodVtableIndex(OverriddenMD);
3441 }
3442
3443 // We don't need to add an entry for this method.
Anders Carlsson07604812010-02-12 18:14:46 +00003444 continue;
Anders Carlssonf942ee02009-11-27 20:47:55 +00003445 }
3446 }
3447
Anders Carlssonf942ee02009-11-27 20:47:55 +00003448 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
3449 if (MD->isImplicit()) {
3450 assert(!ImplicitVirtualDtor &&
3451 "Did already see an implicit virtual dtor!");
3452 ImplicitVirtualDtor = DD;
3453 continue;
3454 }
3455
3456 // Add the complete dtor.
3457 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
3458
3459 // Add the deleting dtor.
3460 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
3461 } else {
3462 // Add the entry.
3463 MethodVtableIndices[MD] = CurrentIndex++;
3464 }
3465 }
3466
3467 if (ImplicitVirtualDtor) {
3468 // Itanium C++ ABI 2.5.2:
Anders Carlssondc2dba32010-02-16 04:49:44 +00003469 // If a class has an implicitly-defined virtual destructor,
3470 // its entries come after the declared virtual function pointers.
Anders Carlssonf942ee02009-11-27 20:47:55 +00003471
3472 // Add the complete dtor.
3473 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
3474 CurrentIndex++;
3475
3476 // Add the deleting dtor.
3477 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
3478 CurrentIndex++;
3479 }
3480
3481 NumVirtualFunctionPointers[RD] = CurrentIndex;
3482}
3483
3484uint64_t CGVtableInfo::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
3485 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
3486 NumVirtualFunctionPointers.find(RD);
3487 if (I != NumVirtualFunctionPointers.end())
3488 return I->second;
3489
3490 ComputeMethodVtableIndices(RD);
3491
3492 I = NumVirtualFunctionPointers.find(RD);
3493 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
3494 return I->second;
3495}
3496
3497uint64_t CGVtableInfo::getMethodVtableIndex(GlobalDecl GD) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00003498 MethodVtableIndicesTy::iterator I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003499 if (I != MethodVtableIndices.end())
3500 return I->second;
3501
Anders Carlssonfb4dda42009-11-13 17:08:56 +00003502 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssonf942ee02009-11-27 20:47:55 +00003503
3504 ComputeMethodVtableIndices(RD);
3505
Anders Carlssonfb4dda42009-11-13 17:08:56 +00003506 I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003507 assert(I != MethodVtableIndices.end() && "Did not find index!");
3508 return I->second;
3509}
3510
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003511CGVtableInfo::AdjustmentVectorTy*
3512CGVtableInfo::getAdjustments(GlobalDecl GD) {
3513 SavedAdjustmentsTy::iterator I = SavedAdjustments.find(GD);
3514 if (I != SavedAdjustments.end())
3515 return &I->second;
Eli Friedman8174f2c2009-12-06 22:01:30 +00003516
3517 const CXXRecordDecl *RD = cast<CXXRecordDecl>(GD.getDecl()->getDeclContext());
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003518 if (!SavedAdjustmentRecords.insert(RD).second)
3519 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00003520
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003521 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003522 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003523 D1(printf("vtable %s\n", RD->getNameAsCString()));
3524 b.GenerateVtableForBase(RD);
3525 b.GenerateVtableForVBases(RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003526
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003527 for (OldVtableBuilder::SavedAdjustmentsVectorTy::iterator
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003528 i = b.getSavedAdjustments().begin(),
3529 e = b.getSavedAdjustments().end(); i != e; i++)
3530 SavedAdjustments[i->first].push_back(i->second);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003531
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003532 I = SavedAdjustments.find(GD);
3533 if (I != SavedAdjustments.end())
3534 return &I->second;
3535
3536 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00003537}
3538
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003539int64_t CGVtableInfo::getVirtualBaseOffsetOffset(const CXXRecordDecl *RD,
3540 const CXXRecordDecl *VBase) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003541 ClassPairTy ClassPair(RD, VBase);
3542
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003543 VirtualBaseClassOffsetOffsetsMapTy::iterator I =
3544 VirtualBaseClassOffsetOffsets.find(ClassPair);
3545 if (I != VirtualBaseClassOffsetOffsets.end())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003546 return I->second;
3547
Anders Carlssondd819c92010-03-11 16:06:20 +00003548 VCallAndVBaseOffsetBuilder Builder(RD, RD, /*FinalOverriders=*/0,
3549 BaseSubobject(RD, 0),
3550 /*BaseIsVirtual=*/false,
3551 /*OffsetInLayoutClass=*/0);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003552
Anders Carlssondd819c92010-03-11 16:06:20 +00003553
3554 for (VCallAndVBaseOffsetBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
3555 Builder.getVBaseOffsetOffsets().begin(),
3556 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003557 // Insert all types.
3558 ClassPairTy ClassPair(RD, I->first);
3559
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003560 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003561 }
3562
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003563 I = VirtualBaseClassOffsetOffsets.find(ClassPair);
Anders Carlssondd819c92010-03-11 16:06:20 +00003564
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00003565 // FIXME: The assertion below assertion currently fails with the old vtable
3566 /// layout code if there is a non-virtual thunk adjustment in a vtable.
3567 // Once the new layout is in place, this return should be removed.
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003568 if (I == VirtualBaseClassOffsetOffsets.end())
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00003569 return 0;
3570
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003571 assert(I != VirtualBaseClassOffsetOffsets.end() && "Did not find index!");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003572
3573 return I->second;
3574}
3575
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00003576uint64_t CGVtableInfo::getVtableAddressPoint(const CXXRecordDecl *RD) {
3577 uint64_t AddressPoint =
Anders Carlsson93a18842010-01-02 18:02:32 +00003578 (*(*(CGM.getVtableInfo().AddressPoints[RD]))[RD])[std::make_pair(RD, 0)];
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00003579
3580 return AddressPoint;
3581}
3582
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003583llvm::GlobalVariable *
Anders Carlsson0911ae82009-12-06 00:23:49 +00003584CGVtableInfo::GenerateVtable(llvm::GlobalVariable::LinkageTypes Linkage,
Anders Carlsson232324c2009-12-06 00:53:22 +00003585 bool GenerateDefinition,
Anders Carlsson0911ae82009-12-06 00:23:49 +00003586 const CXXRecordDecl *LayoutClass,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003587 const CXXRecordDecl *RD, uint64_t Offset,
Anders Carlsson62c6c722010-02-28 00:36:23 +00003588 bool IsVirtual,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003589 AddressPointsMapTy& AddressPoints) {
Anders Carlsson93913752010-02-27 20:39:05 +00003590 if (GenerateDefinition) {
3591 if (LayoutClass == RD) {
Anders Carlsson62c6c722010-02-28 00:36:23 +00003592 assert(!IsVirtual &&
Anders Carlssond5531e22010-03-11 05:48:21 +00003593 "Can only have a virtual base in construction vtables!");
3594 assert(!Offset &&
3595 "Can only have a base offset in construction vtables!");
Anders Carlsson93913752010-02-27 20:39:05 +00003596 }
Anders Carlssond5531e22010-03-11 05:48:21 +00003597
3598 VtableBuilder Builder(*this, RD, Offset,
Anders Carlsson9f28dbc2010-03-11 06:10:52 +00003599 /*MostDerivedClassIsVirtual=*/IsVirtual,
Anders Carlssond5531e22010-03-11 05:48:21 +00003600 LayoutClass);
3601
3602 if (CGM.getLangOptions().DumpVtableLayouts)
3603 Builder.dumpLayout(llvm::errs());
Anders Carlssoneee53d92010-02-13 02:02:03 +00003604 }
3605
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003606 llvm::SmallString<256> OutName;
Mike Stump2cefe382009-11-12 20:47:57 +00003607 if (LayoutClass != RD)
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003608 CGM.getMangleContext().mangleCXXCtorVtable(LayoutClass, Offset / 8,
3609 RD, OutName);
Mike Stumpeac45592009-11-11 20:26:26 +00003610 else
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003611 CGM.getMangleContext().mangleCXXVtable(RD, OutName);
Daniel Dunbare128dd12009-11-21 09:06:22 +00003612 llvm::StringRef Name = OutName.str();
Benjamin Kramerbb0a07b2009-10-11 22:57:54 +00003613
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003614 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
Anders Carlsson93a18842010-01-02 18:02:32 +00003615 if (GV == 0 || CGM.getVtableInfo().AddressPoints[LayoutClass] == 0 ||
3616 GV->isDeclaration()) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003617 OldVtableBuilder b(RD, LayoutClass, Offset, CGM, GenerateDefinition,
3618 AddressPoints);
Eli Friedman6c08ce72009-12-05 01:05:03 +00003619
3620 D1(printf("vtable %s\n", RD->getNameAsCString()));
3621 // First comes the vtables for all the non-virtual bases...
Mike Stumpd538a6d2009-12-24 07:29:41 +00003622 b.GenerateVtableForBase(RD, Offset);
Eli Friedman6c08ce72009-12-05 01:05:03 +00003623
3624 // then the vtables for all the virtual bases.
3625 b.GenerateVtableForVBases(RD, Offset);
3626
Anders Carlsson58b271d2009-12-05 22:19:10 +00003627 llvm::Constant *Init = 0;
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003628 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson58b271d2009-12-05 22:19:10 +00003629 llvm::ArrayType *ArrayType =
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003630 llvm::ArrayType::get(Int8PtrTy, b.getVtableComponents().size());
Anders Carlssona95d4c52009-12-05 21:09:05 +00003631
Anders Carlsson232324c2009-12-06 00:53:22 +00003632 if (GenerateDefinition)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003633 Init = llvm::ConstantArray::get(ArrayType, &b.getVtableComponents()[0],
3634 b.getVtableComponents().size());
Anders Carlsson232324c2009-12-06 00:53:22 +00003635
Mike Stumpaa51ad62009-11-19 04:04:36 +00003636 llvm::GlobalVariable *OGV = GV;
Anders Carlsson232324c2009-12-06 00:53:22 +00003637
3638 GV = new llvm::GlobalVariable(CGM.getModule(), ArrayType,
3639 /*isConstant=*/true, Linkage, Init, Name);
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003640 CGM.setGlobalVisibility(GV, RD);
3641
Mike Stumpaa51ad62009-11-19 04:04:36 +00003642 if (OGV) {
3643 GV->takeName(OGV);
Anders Carlsson58b271d2009-12-05 22:19:10 +00003644 llvm::Constant *NewPtr =
3645 llvm::ConstantExpr::getBitCast(GV, OGV->getType());
Mike Stumpaa51ad62009-11-19 04:04:36 +00003646 OGV->replaceAllUsesWith(NewPtr);
3647 OGV->eraseFromParent();
3648 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00003649 }
Anders Carlssonb3f54b72009-12-05 21:28:12 +00003650
3651 return GV;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003652}
Mike Stump9f23a142009-11-10 02:30:51 +00003653
Anders Carlsson232324c2009-12-06 00:53:22 +00003654void CGVtableInfo::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
3655 const CXXRecordDecl *RD) {
Anders Carlssone1b3e622009-12-07 07:59:52 +00003656 llvm::GlobalVariable *&Vtable = Vtables[RD];
3657 if (Vtable) {
3658 assert(Vtable->getInitializer() && "Vtable doesn't have a definition!");
3659 return;
3660 }
3661
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003662 AddressPointsMapTy AddressPoints;
3663 Vtable = GenerateVtable(Linkage, /*GenerateDefinition=*/true, RD, RD, 0,
Anders Carlsson62c6c722010-02-28 00:36:23 +00003664 /*IsVirtual=*/false,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003665 AddressPoints);
Rafael Espindolae7113ca2010-03-10 02:19:29 +00003666 GenerateVTT(Linkage, /*GenerateDefinition=*/true, RD);
3667
3668 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
3669 e = RD->method_end(); i != e; ++i) {
3670 if (!(*i)->isVirtual())
3671 continue;
3672 if(!(*i)->hasInlineBody() && !(*i)->isImplicit())
3673 continue;
3674
3675 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(*i)) {
3676 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Complete));
3677 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Deleting));
3678 } else {
3679 CGM.BuildThunksForVirtual(GlobalDecl(*i));
3680 }
3681 }
Mike Stump1a139f82009-11-19 01:08:19 +00003682}
3683
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003684llvm::GlobalVariable *CGVtableInfo::getVtable(const CXXRecordDecl *RD) {
Anders Carlsson232324c2009-12-06 00:53:22 +00003685 llvm::GlobalVariable *Vtable = Vtables.lookup(RD);
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003686
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003687 if (!Vtable) {
3688 AddressPointsMapTy AddressPoints;
Anders Carlsson232324c2009-12-06 00:53:22 +00003689 Vtable = GenerateVtable(llvm::GlobalValue::ExternalLinkage,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003690 /*GenerateDefinition=*/false, RD, RD, 0,
Anders Carlsson62c6c722010-02-28 00:36:23 +00003691 /*IsVirtual=*/false, AddressPoints);
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003692 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00003693
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00003694 return Vtable;
Mike Stumpd846d082009-11-10 07:44:33 +00003695}
Mike Stumpeac45592009-11-11 20:26:26 +00003696
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003697void CGVtableInfo::MaybeEmitVtable(GlobalDecl GD) {
3698 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
3699 const CXXRecordDecl *RD = MD->getParent();
3700
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00003701 // If the class doesn't have a vtable we don't need to emit one.
3702 if (!RD->isDynamicClass())
3703 return;
3704
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003705 // Get the key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00003706 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003707
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00003708 if (KeyFunction) {
3709 // We don't have the right key function.
3710 if (KeyFunction->getCanonicalDecl() != MD->getCanonicalDecl())
3711 return;
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003712 }
3713
Rafael Espindolae7113ca2010-03-10 02:19:29 +00003714 if (Vtables.count(RD))
3715 return;
Eli Friedman8174f2c2009-12-06 22:01:30 +00003716
Rafael Espindolae7113ca2010-03-10 02:19:29 +00003717 TemplateSpecializationKind kind = RD->getTemplateSpecializationKind();
3718 if (kind == TSK_ImplicitInstantiation)
3719 CGM.DeferredVtables.push_back(RD);
3720 else
3721 GenerateClassData(CGM.getVtableLinkage(RD), RD);
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003722}