blob: afbfeabeb8e227d6fdb3defd8bb6be3870991c55 [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 Carlssone67698b2010-03-26 00:35:45 +0000141 void AddOverriders(BaseSubobject Base, uint64_t OffsetInLayoutClass,
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000142 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 Carlssona5736bd2010-03-25 16:49:53 +0000639 static VtableComponent getFromOpaqueInteger(uint64_t I) {
640 return VtableComponent(I);
641 }
642
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000643 /// getKind - Get the kind of this vtable component.
644 Kind getKind() const {
645 return (Kind)(Value & 0x7);
646 }
647
Anders Carlssonb0a588f2010-02-17 06:07:19 +0000648 int64_t getVCallOffset() const {
649 assert(getKind() == CK_VCallOffset && "Invalid component kind!");
650
651 return getOffset();
652 }
653
Anders Carlssondc2dba32010-02-16 04:49:44 +0000654 int64_t getVBaseOffset() const {
655 assert(getKind() == CK_VBaseOffset && "Invalid component kind!");
656
657 return getOffset();
658 }
659
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000660 int64_t getOffsetToTop() const {
661 assert(getKind() == CK_OffsetToTop && "Invalid component kind!");
662
663 return getOffset();
664 }
665
666 const CXXRecordDecl *getRTTIDecl() const {
667 assert(getKind() == CK_RTTI && "Invalid component kind!");
668
669 return reinterpret_cast<CXXRecordDecl *>(getPointer());
670 }
671
672 const CXXMethodDecl *getFunctionDecl() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000673 assert(getKind() == CK_FunctionPointer);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000674
675 return reinterpret_cast<CXXMethodDecl *>(getPointer());
676 }
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000677
678 const CXXDestructorDecl *getDestructorDecl() const {
679 assert((getKind() == CK_CompleteDtorPointer ||
680 getKind() == CK_DeletingDtorPointer) && "Invalid component kind!");
681
682 return reinterpret_cast<CXXDestructorDecl *>(getPointer());
683 }
684
Anders Carlsson350b56e2010-02-19 20:08:13 +0000685 const CXXMethodDecl *getUnusedFunctionDecl() const {
686 assert(getKind() == CK_UnusedFunctionPointer);
687
688 return reinterpret_cast<CXXMethodDecl *>(getPointer());
689 }
690
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000691private:
692 VtableComponent(Kind ComponentKind, int64_t Offset) {
693 assert((ComponentKind == CK_VCallOffset ||
694 ComponentKind == CK_VBaseOffset ||
695 ComponentKind == CK_OffsetToTop) && "Invalid component kind!");
696 assert(Offset <= ((1LL << 56) - 1) && "Offset is too big!");
697
698 Value = ((Offset << 3) | ComponentKind);
699 }
700
701 VtableComponent(Kind ComponentKind, uintptr_t Ptr) {
702 assert((ComponentKind == CK_RTTI ||
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000703 ComponentKind == CK_FunctionPointer ||
704 ComponentKind == CK_CompleteDtorPointer ||
Anders Carlsson350b56e2010-02-19 20:08:13 +0000705 ComponentKind == CK_DeletingDtorPointer ||
706 ComponentKind == CK_UnusedFunctionPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000707 "Invalid component kind!");
708
709 assert((Ptr & 7) == 0 && "Pointer not sufficiently aligned!");
710
711 Value = Ptr | ComponentKind;
712 }
713
714 int64_t getOffset() const {
715 assert((getKind() == CK_VCallOffset || getKind() == CK_VBaseOffset ||
716 getKind() == CK_OffsetToTop) && "Invalid component kind!");
717
718 return Value >> 3;
719 }
720
721 uintptr_t getPointer() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000722 assert((getKind() == CK_RTTI ||
723 getKind() == CK_FunctionPointer ||
724 getKind() == CK_CompleteDtorPointer ||
Anders Carlsson350b56e2010-02-19 20:08:13 +0000725 getKind() == CK_DeletingDtorPointer ||
726 getKind() == CK_UnusedFunctionPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000727 "Invalid component kind!");
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000728
729 return static_cast<uintptr_t>(Value & ~7ULL);
730 }
731
Anders Carlssona5736bd2010-03-25 16:49:53 +0000732 explicit VtableComponent(uint64_t Value)
733 : Value(Value) { }
734
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000735 /// The kind is stored in the lower 3 bits of the value. For offsets, we
736 /// make use of the facts that classes can't be larger than 2^55 bytes,
737 /// so we store the offset in the lower part of the 61 bytes that remain.
738 /// (The reason that we're not simply using a PointerIntPair here is that we
739 /// need the offsets to be 64-bit, even when on a 32-bit machine).
740 int64_t Value;
741};
742
Anders Carlsson78277c72010-02-18 17:00:09 +0000743/// VCallOffsetMap - Keeps track of vcall offsets when building a vtable.
744struct VCallOffsetMap {
745
746 typedef std::pair<const CXXMethodDecl *, int64_t> MethodAndOffsetPairTy;
747
748 /// Offsets - Keeps track of methods and their offsets.
749 // FIXME: This should be a real map and not a vector.
750 llvm::SmallVector<MethodAndOffsetPairTy, 16> Offsets;
751
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000752 /// MethodsCanShareVCallOffset - Returns whether two virtual member functions
753 /// can share the same vcall offset.
754 static bool MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
755 const CXXMethodDecl *RHS);
756
Anders Carlsson78277c72010-02-18 17:00:09 +0000757public:
758 /// AddVCallOffset - Adds a vcall offset to the map. Returns true if the
759 /// add was successful, or false if there was already a member function with
760 /// the same signature in the map.
761 bool AddVCallOffset(const CXXMethodDecl *MD, int64_t OffsetOffset);
762
763 /// getVCallOffsetOffset - Returns the vcall offset offset (relative to the
764 /// vtable address point) for the given virtual member function.
765 int64_t getVCallOffsetOffset(const CXXMethodDecl *MD);
766
Anders Carlsson9e3b3a32010-02-25 22:23:13 +0000767 // empty - Return whether the offset map is empty or not.
768 bool empty() const { return Offsets.empty(); }
Anders Carlsson78277c72010-02-18 17:00:09 +0000769};
770
John McCall43c6ffb2010-02-26 20:22:44 +0000771static bool HasSameVirtualSignature(const CXXMethodDecl *LHS,
772 const CXXMethodDecl *RHS) {
773 ASTContext &C = LHS->getASTContext(); // TODO: thread this down
774 CanQual<FunctionProtoType>
775 LT = C.getCanonicalType(LHS->getType()).getAs<FunctionProtoType>(),
776 RT = C.getCanonicalType(RHS->getType()).getAs<FunctionProtoType>();
777
778 // Fast-path matches in the canonical types.
779 if (LT == RT) return true;
780
781 // Force the signatures to match. We can't rely on the overrides
782 // list here because there isn't necessarily an inheritance
783 // relationship between the two methods.
784 if (LT.getQualifiers() != RT.getQualifiers() ||
785 LT->getNumArgs() != RT->getNumArgs())
786 return false;
787 for (unsigned I = 0, E = LT->getNumArgs(); I != E; ++I)
788 if (LT->getArgType(I) != RT->getArgType(I))
789 return false;
790 return true;
791}
792
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000793bool VCallOffsetMap::MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
794 const CXXMethodDecl *RHS) {
795 assert(LHS->isVirtual() && "LHS must be virtual!");
796 assert(RHS->isVirtual() && "LHS must be virtual!");
797
Anders Carlssond69b2f92010-02-27 04:12:52 +0000798 // A destructor can share a vcall offset with another destructor.
799 if (isa<CXXDestructorDecl>(LHS))
800 return isa<CXXDestructorDecl>(RHS);
801
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000802 // FIXME: We need to check more things here.
803
Anders Carlssond69b2f92010-02-27 04:12:52 +0000804 // The methods must have the same name.
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000805 DeclarationName LHSName = LHS->getDeclName();
806 DeclarationName RHSName = RHS->getDeclName();
John McCall43c6ffb2010-02-26 20:22:44 +0000807 if (LHSName != RHSName)
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000808 return false;
John McCall43c6ffb2010-02-26 20:22:44 +0000809
Anders Carlssond69b2f92010-02-27 04:12:52 +0000810 // And the same signatures.
811 return HasSameVirtualSignature(LHS, RHS);
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000812}
813
Anders Carlsson78277c72010-02-18 17:00:09 +0000814bool VCallOffsetMap::AddVCallOffset(const CXXMethodDecl *MD,
815 int64_t OffsetOffset) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000816 // Check if we can reuse an offset.
817 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
818 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
819 return false;
820 }
821
822 // Add the offset.
823 Offsets.push_back(MethodAndOffsetPairTy(MD, OffsetOffset));
Anders Carlsson78277c72010-02-18 17:00:09 +0000824 return true;
825}
826
827int64_t VCallOffsetMap::getVCallOffsetOffset(const CXXMethodDecl *MD) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000828 // Look for an offset.
829 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
830 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
831 return Offsets[I].second;
832 }
833
834 assert(false && "Should always find a vcall offset offset!");
Anders Carlsson78277c72010-02-18 17:00:09 +0000835 return 0;
836}
837
Anders Carlsson422f7782010-02-25 03:45:56 +0000838/// VCallAndVBaseOffsetBuilder - Class for building vcall and vbase offsets.
839class VCallAndVBaseOffsetBuilder {
Anders Carlssondd819c92010-03-11 16:06:20 +0000840public:
841 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
842 VBaseOffsetOffsetsMapTy;
843
844private:
Anders Carlssone3385f52010-02-28 01:43:58 +0000845 /// MostDerivedClass - The most derived class for which we're building vcall
846 /// and vbase offsets.
Anders Carlsson422f7782010-02-25 03:45:56 +0000847 const CXXRecordDecl *MostDerivedClass;
848
Anders Carlssonc3f92a12010-02-27 21:09:00 +0000849 /// LayoutClass - The class we're using for layout information. Will be
850 /// different than the most derived class if we're building a construction
851 /// vtable.
852 const CXXRecordDecl *LayoutClass;
853
Anders Carlsson422f7782010-02-25 03:45:56 +0000854 /// Context - The ASTContext which we will use for layout information.
855 ASTContext &Context;
856
857 /// Components - vcall and vbase offset components
858 typedef llvm::SmallVector<VtableComponent, 64> VtableComponentVectorTy;
859 VtableComponentVectorTy Components;
860
861 /// VisitedVirtualBases - Visited virtual bases.
862 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
863
864 /// VCallOffsets - Keeps track of vcall offsets.
865 VCallOffsetMap VCallOffsets;
866
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000867
868 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets,
869 /// relative to the address point.
870 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
871
Anders Carlsson422f7782010-02-25 03:45:56 +0000872 /// FinalOverriders - The final overriders of the most derived class.
873 /// (Can be null when we're not building a vtable of the most derived class).
874 const FinalOverriders *Overriders;
875
876 /// AddVCallAndVBaseOffsets - Add vcall offsets and vbase offsets for the
877 /// given base subobject.
878 void AddVCallAndVBaseOffsets(BaseSubobject Base, bool BaseIsVirtual,
879 uint64_t RealBaseOffset);
880
881 /// AddVCallOffsets - Add vcall offsets for the given base subobject.
882 void AddVCallOffsets(BaseSubobject Base, uint64_t VBaseOffset);
883
884 /// AddVBaseOffsets - Add vbase offsets for the given class.
Anders Carlsson93b1b492010-03-02 05:40:45 +0000885 void AddVBaseOffsets(const CXXRecordDecl *Base, uint64_t OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +0000886
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000887 /// getCurrentOffsetOffset - Get the current vcall or vbase offset offset in
888 /// bytes, relative to the vtable address point.
889 int64_t getCurrentOffsetOffset() const;
890
Anders Carlsson422f7782010-02-25 03:45:56 +0000891public:
892 VCallAndVBaseOffsetBuilder(const CXXRecordDecl *MostDerivedClass,
Anders Carlssonc3f92a12010-02-27 21:09:00 +0000893 const CXXRecordDecl *LayoutClass,
Anders Carlsson422f7782010-02-25 03:45:56 +0000894 const FinalOverriders *Overriders,
Anders Carlssone3385f52010-02-28 01:43:58 +0000895 BaseSubobject Base, bool BaseIsVirtual,
896 uint64_t OffsetInLayoutClass)
897 : MostDerivedClass(MostDerivedClass), LayoutClass(LayoutClass),
Anders Carlsson422f7782010-02-25 03:45:56 +0000898 Context(MostDerivedClass->getASTContext()), Overriders(Overriders) {
899
900 // Add vcall and vbase offsets.
Anders Carlssone3385f52010-02-28 01:43:58 +0000901 AddVCallAndVBaseOffsets(Base, BaseIsVirtual, OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +0000902 }
903
904 /// Methods for iterating over the components.
905 typedef VtableComponentVectorTy::const_reverse_iterator const_iterator;
906 const_iterator components_begin() const { return Components.rbegin(); }
907 const_iterator components_end() const { return Components.rend(); }
908
Anders Carlssondd819c92010-03-11 16:06:20 +0000909 const VCallOffsetMap &getVCallOffsets() const { return VCallOffsets; }
910 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000911 return VBaseOffsetOffsets;
912 }
Anders Carlsson422f7782010-02-25 03:45:56 +0000913};
914
915void
916VCallAndVBaseOffsetBuilder::AddVCallAndVBaseOffsets(BaseSubobject Base,
917 bool BaseIsVirtual,
918 uint64_t RealBaseOffset) {
919 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base.getBase());
920
921 // Itanium C++ ABI 2.5.2:
922 // ..in classes sharing a virtual table with a primary base class, the vcall
923 // and vbase offsets added by the derived class all come before the vcall
924 // and vbase offsets required by the base class, so that the latter may be
925 // laid out as required by the base class without regard to additions from
926 // the derived class(es).
927
928 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
929 // emit them for the primary base first).
930 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
931 bool PrimaryBaseIsVirtual = Layout.getPrimaryBaseWasVirtual();
932
933 uint64_t PrimaryBaseOffset;
934
935 // Get the base offset of the primary base.
936 if (PrimaryBaseIsVirtual) {
937 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
938 "Primary vbase should have a zero offset!");
939
940 const ASTRecordLayout &MostDerivedClassLayout =
941 Context.getASTRecordLayout(MostDerivedClass);
942
943 PrimaryBaseOffset =
944 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
945 } else {
946 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
947 "Primary base should have a zero offset!");
948
949 PrimaryBaseOffset = Base.getBaseOffset();
950 }
951
952 AddVCallAndVBaseOffsets(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
953 PrimaryBaseIsVirtual, RealBaseOffset);
954 }
955
Anders Carlsson93b1b492010-03-02 05:40:45 +0000956 AddVBaseOffsets(Base.getBase(), RealBaseOffset);
Anders Carlsson422f7782010-02-25 03:45:56 +0000957
958 // We only want to add vcall offsets for virtual bases.
959 if (BaseIsVirtual)
960 AddVCallOffsets(Base, RealBaseOffset);
961}
962
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000963int64_t VCallAndVBaseOffsetBuilder::getCurrentOffsetOffset() const {
964 // OffsetIndex is the index of this vcall or vbase offset, relative to the
965 // vtable address point. (We subtract 3 to account for the information just
966 // above the address point, the RTTI info, the offset to top, and the
967 // vcall offset itself).
968 int64_t OffsetIndex = -(int64_t)(3 + Components.size());
969
970 // FIXME: We shouldn't use / 8 here.
971 int64_t OffsetOffset = OffsetIndex *
972 (int64_t)Context.Target.getPointerWidth(0) / 8;
973
974 return OffsetOffset;
975}
976
Anders Carlsson422f7782010-02-25 03:45:56 +0000977void VCallAndVBaseOffsetBuilder::AddVCallOffsets(BaseSubobject Base,
978 uint64_t VBaseOffset) {
979 const CXXRecordDecl *RD = Base.getBase();
980 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
981
John McCall43c6ffb2010-02-26 20:22:44 +0000982 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
983
Anders Carlsson422f7782010-02-25 03:45:56 +0000984 // Handle the primary base first.
John McCall43c6ffb2010-02-26 20:22:44 +0000985 if (PrimaryBase) {
Anders Carlsson422f7782010-02-25 03:45:56 +0000986 uint64_t PrimaryBaseOffset;
987
988 // Get the base offset of the primary base.
989 if (Layout.getPrimaryBaseWasVirtual()) {
990 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
991 "Primary vbase should have a zero offset!");
992
993 const ASTRecordLayout &MostDerivedClassLayout =
994 Context.getASTRecordLayout(MostDerivedClass);
995
996 PrimaryBaseOffset =
997 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
998 } else {
999 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
1000 "Primary base should have a zero offset!");
1001
1002 PrimaryBaseOffset = Base.getBaseOffset();
1003 }
1004
1005 AddVCallOffsets(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
1006 VBaseOffset);
1007 }
1008
1009 // Add the vcall offsets.
1010 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1011 E = RD->method_end(); I != E; ++I) {
1012 const CXXMethodDecl *MD = *I;
1013
1014 if (!MD->isVirtual())
1015 continue;
1016
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001017 int64_t OffsetOffset = getCurrentOffsetOffset();
Anders Carlsson422f7782010-02-25 03:45:56 +00001018
1019 // Don't add a vcall offset if we already have one for this member function
1020 // signature.
1021 if (!VCallOffsets.AddVCallOffset(MD, OffsetOffset))
1022 continue;
1023
1024 int64_t Offset = 0;
1025
1026 if (Overriders) {
1027 // Get the final overrider.
1028 FinalOverriders::OverriderInfo Overrider =
1029 Overriders->getOverrider(Base, MD);
1030
Anders Carlsson31f595f2010-02-28 00:10:58 +00001031 /// The vcall offset is the offset from the virtual base to the object
1032 /// where the function was overridden.
Anders Carlsson422f7782010-02-25 03:45:56 +00001033 // FIXME: We should not use / 8 here.
Anders Carlsson6f1f0022010-03-02 03:44:06 +00001034 Offset = (int64_t)(Overrider.Offset - VBaseOffset) / 8;
Anders Carlsson422f7782010-02-25 03:45:56 +00001035 }
1036
1037 Components.push_back(VtableComponent::MakeVCallOffset(Offset));
1038 }
1039
1040 // And iterate over all non-virtual bases (ignoring the primary base).
1041 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1042 E = RD->bases_end(); I != E; ++I) {
1043
1044 if (I->isVirtual())
1045 continue;
1046
1047 const CXXRecordDecl *BaseDecl =
1048 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
John McCall43c6ffb2010-02-26 20:22:44 +00001049 if (BaseDecl == PrimaryBase)
1050 continue;
Anders Carlsson422f7782010-02-25 03:45:56 +00001051
1052 // Get the base offset of this base.
1053 uint64_t BaseOffset = Base.getBaseOffset() +
1054 Layout.getBaseClassOffset(BaseDecl);
1055
1056 AddVCallOffsets(BaseSubobject(BaseDecl, BaseOffset), VBaseOffset);
1057 }
1058}
1059
Anders Carlsson422f7782010-02-25 03:45:56 +00001060void VCallAndVBaseOffsetBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
Anders Carlsson93b1b492010-03-02 05:40:45 +00001061 uint64_t OffsetInLayoutClass) {
Anders Carlssonc3f92a12010-02-27 21:09:00 +00001062 const ASTRecordLayout &LayoutClassLayout =
1063 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +00001064
1065 // Add vbase offsets.
1066 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1067 E = RD->bases_end(); I != E; ++I) {
1068 const CXXRecordDecl *BaseDecl =
1069 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1070
1071 // Check if this is a virtual base that we haven't visited before.
1072 if (I->isVirtual() && VisitedVirtualBases.insert(BaseDecl)) {
1073 // FIXME: We shouldn't use / 8 here.
Anders Carlsson93b1b492010-03-02 05:40:45 +00001074 int64_t Offset =
1075 (int64_t)(LayoutClassLayout.getVBaseClassOffset(BaseDecl) -
1076 OffsetInLayoutClass) / 8;
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001077
1078 // Add the vbase offset offset.
1079 assert(!VBaseOffsetOffsets.count(BaseDecl) &&
1080 "vbase offset offset already exists!");
1081
1082 int64_t VBaseOffsetOffset = getCurrentOffsetOffset();
1083 VBaseOffsetOffsets.insert(std::make_pair(BaseDecl, VBaseOffsetOffset));
1084
Anders Carlsson422f7782010-02-25 03:45:56 +00001085 Components.push_back(VtableComponent::MakeVBaseOffset(Offset));
1086 }
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001087
Anders Carlsson422f7782010-02-25 03:45:56 +00001088 // Check the base class looking for more vbase offsets.
Anders Carlsson93b1b492010-03-02 05:40:45 +00001089 AddVBaseOffsets(BaseDecl, OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +00001090 }
1091}
1092
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001093/// VtableBuilder - Class for building vtable layout information.
Benjamin Kramer337e3a52009-11-28 19:45:26 +00001094class VtableBuilder {
Anders Carlsson65b49782010-02-12 05:25:12 +00001095public:
Anders Carlssond46ed892010-02-27 16:18:19 +00001096 /// PrimaryBasesSetVectorTy - A set vector of direct and indirect
1097 /// primary bases.
1098 typedef llvm::SmallSetVector<const CXXRecordDecl *, 8>
1099 PrimaryBasesSetVectorTy;
1100
Anders Carlssone90954d2010-03-24 16:42:11 +00001101 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
1102 VBaseOffsetOffsetsMapTy;
Anders Carlssond03325c2010-03-25 00:51:13 +00001103
1104 typedef llvm::DenseMap<BaseSubobject, uint64_t>
1105 AddressPointsMapTy;
Anders Carlssone90954d2010-03-24 16:42:11 +00001106
Anders Carlsson65b49782010-02-12 05:25:12 +00001107private:
Anders Carlssona864caf2010-03-23 04:11:45 +00001108 /// VTables - Global vtable information.
1109 CodeGenVTables &VTables;
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001110
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001111 /// MostDerivedClass - The most derived class for which we're building this
1112 /// vtable.
1113 const CXXRecordDecl *MostDerivedClass;
1114
Anders Carlsson93913752010-02-27 20:39:05 +00001115 /// MostDerivedClassOffset - If we're building a construction vtable, this
1116 /// holds the offset from the layout class to the most derived class.
1117 const uint64_t MostDerivedClassOffset;
1118
Anders Carlsson62c6c722010-02-28 00:36:23 +00001119 /// MostDerivedClassIsVirtual - Whether the most derived class is a virtual
1120 /// base. (This only makes sense when building a construction vtable).
1121 bool MostDerivedClassIsVirtual;
1122
Anders Carlsson93913752010-02-27 20:39:05 +00001123 /// LayoutClass - The class we're using for layout information. Will be
1124 /// different than the most derived class if we're building a construction
1125 /// vtable.
1126 const CXXRecordDecl *LayoutClass;
1127
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001128 /// Context - The ASTContext which we will use for layout information.
Anders Carlsson65b49782010-02-12 05:25:12 +00001129 ASTContext &Context;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001130
Anders Carlssone8ac42a2010-02-11 21:24:32 +00001131 /// FinalOverriders - The final overriders of the most derived class.
Anders Carlsson422f7782010-02-25 03:45:56 +00001132 const FinalOverriders Overriders;
Anders Carlssone8ac42a2010-02-11 21:24:32 +00001133
Anders Carlsson9e3b3a32010-02-25 22:23:13 +00001134 /// VCallOffsetsForVBases - Keeps track of vcall offsets for the virtual
1135 /// bases in this vtable.
1136 llvm::DenseMap<const CXXRecordDecl *, VCallOffsetMap> VCallOffsetsForVBases;
Anders Carlsson78277c72010-02-18 17:00:09 +00001137
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001138 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets for
1139 /// the most derived class.
1140 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
1141
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001142 /// Components - The components of the vtable being built.
1143 llvm::SmallVector<VtableComponent, 64> Components;
1144
Anders Carlsson932c2f22010-02-11 17:18:51 +00001145 /// AddressPoints - Address points for the vtable being built.
Anders Carlsson0534b022010-03-25 00:35:49 +00001146 AddressPointsMapTy AddressPoints;
Anders Carlsson932c2f22010-02-11 17:18:51 +00001147
Anders Carlssond46ed892010-02-27 16:18:19 +00001148 /// MethodInfo - Contains information about a method in a vtable.
1149 /// (Used for computing 'this' pointer adjustment thunks.
1150 struct MethodInfo {
1151 /// BaseOffset - The base offset of this method.
1152 const uint64_t BaseOffset;
1153
Anders Carlsson423406f32010-03-10 21:25:37 +00001154 /// BaseOffsetInLayoutClass - The base offset in the layout class of this
1155 /// method.
1156 const uint64_t BaseOffsetInLayoutClass;
1157
Anders Carlssond46ed892010-02-27 16:18:19 +00001158 /// VtableIndex - The index in the vtable that this method has.
1159 /// (For destructors, this is the index of the complete destructor).
1160 const uint64_t VtableIndex;
1161
Anders Carlsson423406f32010-03-10 21:25:37 +00001162 MethodInfo(uint64_t BaseOffset, uint64_t BaseOffsetInLayoutClass,
1163 uint64_t VtableIndex)
1164 : BaseOffset(BaseOffset),
1165 BaseOffsetInLayoutClass(BaseOffsetInLayoutClass),
1166 VtableIndex(VtableIndex) { }
Anders Carlsson40687982010-02-27 16:52:49 +00001167
Anders Carlsson423406f32010-03-10 21:25:37 +00001168 MethodInfo() : BaseOffset(0), BaseOffsetInLayoutClass(0), VtableIndex(0) { }
Anders Carlssond46ed892010-02-27 16:18:19 +00001169 };
1170
1171 typedef llvm::DenseMap<const CXXMethodDecl *, MethodInfo> MethodInfoMapTy;
1172
1173 /// MethodInfoMap - The information for all methods in the vtable we're
1174 /// currently building.
1175 MethodInfoMapTy MethodInfoMap;
1176
Anders Carlsson917229c2010-03-23 04:59:02 +00001177 typedef llvm::DenseMap<uint64_t, ThunkInfo> VtableThunksMapTy;
Anders Carlsson8a240292010-03-12 04:54:20 +00001178
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001179 /// VTableThunks - The thunks by vtable index in the vtable currently being
1180 /// built.
Anders Carlsson917229c2010-03-23 04:59:02 +00001181 VtableThunksMapTy VTableThunks;
Anders Carlssond46ed892010-02-27 16:18:19 +00001182
Anders Carlsson917229c2010-03-23 04:59:02 +00001183 typedef llvm::SmallVector<ThunkInfo, 1> ThunkInfoVectorTy;
1184 typedef llvm::DenseMap<const CXXMethodDecl *, ThunkInfoVectorTy> ThunksMapTy;
Anders Carlsson56446142010-03-17 20:06:32 +00001185
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001186 /// Thunks - A map that contains all the thunks needed for all methods in the
1187 /// most derived class for which the vtable is currently being built.
Anders Carlsson917229c2010-03-23 04:59:02 +00001188 ThunksMapTy Thunks;
Anders Carlsson56446142010-03-17 20:06:32 +00001189
1190 /// AddThunk - Add a thunk for the given method.
Anders Carlsson4b2411e2010-03-21 20:27:14 +00001191 void AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk);
Anders Carlsson56446142010-03-17 20:06:32 +00001192
Anders Carlsson40687982010-02-27 16:52:49 +00001193 /// ComputeThisAdjustments - Compute the 'this' pointer adjustments for the
1194 /// part of the vtable we're currently building.
1195 void ComputeThisAdjustments();
1196
Anders Carlssondc2dba32010-02-16 04:49:44 +00001197 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1198
Anders Carlssond46ed892010-02-27 16:18:19 +00001199 /// PrimaryVirtualBases - All known virtual bases who are a primary base of
Anders Carlsson0570f712010-02-23 03:48:14 +00001200 /// some other base.
1201 VisitedVirtualBasesSetTy PrimaryVirtualBases;
1202
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001203 /// ComputeReturnAdjustment - Compute the return adjustment given a return
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001204 /// adjustment base offset.
Anders Carlsson075056a2010-02-23 01:34:28 +00001205 ReturnAdjustment ComputeReturnAdjustment(BaseOffset Offset);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001206
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001207 /// ComputeThisAdjustmentBaseOffset - Compute the base offset for adjusting
1208 /// the 'this' pointer from the base subobject to the derived subobject.
1209 BaseOffset ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
1210 BaseSubobject Derived) const;
1211
Anders Carlsson78277c72010-02-18 17:00:09 +00001212 /// ComputeThisAdjustment - Compute the 'this' pointer adjustment for the
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001213 /// given virtual member function, its offset in the layout class and its
1214 /// final overrider.
1215 ThisAdjustment
1216 ComputeThisAdjustment(const CXXMethodDecl *MD,
1217 uint64_t BaseOffsetInLayoutClass,
1218 FinalOverriders::OverriderInfo Overrider);
1219
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001220 /// AddMethod - Add a single virtual member function to the vtable
1221 /// components vector.
Anders Carlsson40687982010-02-27 16:52:49 +00001222 void AddMethod(const CXXMethodDecl *MD, ReturnAdjustment ReturnAdjustment);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001223
Anders Carlssona8796c62010-02-23 04:26:39 +00001224 /// IsOverriderUsed - Returns whether the overrider will ever be used in this
1225 /// part of the vtable.
1226 ///
1227 /// Itanium C++ ABI 2.5.2:
1228 ///
1229 /// struct A { virtual void f(); };
1230 /// struct B : virtual public A { int i; };
1231 /// struct C : virtual public A { int j; };
1232 /// struct D : public B, public C {};
1233 ///
1234 /// When B and C are declared, A is a primary base in each case, so although
1235 /// vcall offsets are allocated in the A-in-B and A-in-C vtables, no this
1236 /// adjustment is required and no thunk is generated. However, inside D
1237 /// objects, A is no longer a primary base of C, so if we allowed calls to
1238 /// C::f() to use the copy of A's vtable in the C subobject, we would need
1239 /// to adjust this from C* to B::A*, which would require a third-party
1240 /// thunk. Since we require that a call to C::f() first convert to A*,
1241 /// C-in-D's copy of A's vtable is never referenced, so this is not
1242 /// necessary.
Anders Carlsson804cf512010-03-10 06:51:42 +00001243 bool IsOverriderUsed(const CXXMethodDecl *Overrider,
1244 uint64_t BaseOffsetInLayoutClass,
1245 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1246 uint64_t FirstBaseOffsetInLayoutClass) const;
1247
Anders Carlssona8796c62010-02-23 04:26:39 +00001248
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001249 /// AddMethods - Add the methods of this base subobject and all its
1250 /// primary bases to the vtable components vector.
Anders Carlsson804cf512010-03-10 06:51:42 +00001251 void AddMethods(BaseSubobject Base, uint64_t BaseOffsetInLayoutClass,
1252 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1253 uint64_t FirstBaseOffsetInLayoutClass,
Anders Carlssond46ed892010-02-27 16:18:19 +00001254 PrimaryBasesSetVectorTy &PrimaryBases);
Anders Carlssonb716a542010-02-16 16:26:28 +00001255
Anders Carlsson62c6c722010-02-28 00:36:23 +00001256 // LayoutVtable - Layout the vtable for the given base class, including its
Anders Carlssonb716a542010-02-16 16:26:28 +00001257 // secondary vtables and any vtables for virtual bases.
1258 void LayoutVtable();
1259
Anders Carlssone3385f52010-02-28 01:43:58 +00001260 /// LayoutPrimaryAndSecondaryVtables - Layout the primary vtable for the
Anders Carlssonb716a542010-02-16 16:26:28 +00001261 /// given base subobject, as well as all its secondary vtables.
Anders Carlssone3385f52010-02-28 01:43:58 +00001262 void LayoutPrimaryAndSecondaryVtables(BaseSubobject Base,
1263 bool BaseIsVirtual,
1264 uint64_t OffsetInLayoutClass);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001265
Anders Carlsson14157932010-02-16 16:02:57 +00001266 /// LayoutSecondaryVtables - Layout the secondary vtables for the given base
1267 /// subobject.
Anders Carlsson115b4752010-03-10 19:39:11 +00001268 ///
1269 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
1270 /// or a direct or indirect base of a virtual base.
1271 void LayoutSecondaryVtables(BaseSubobject Base, bool BaseIsMorallyVirtual,
1272 uint64_t OffsetInLayoutClass);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001273
1274 /// DeterminePrimaryVirtualBases - Determine the primary virtual bases in this
1275 /// class hierarchy.
1276 void DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson02b99d62010-03-10 03:02:01 +00001277 uint64_t OffsetInLayoutClass,
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001278 VisitedVirtualBasesSetTy &VBases);
1279
Anders Carlsson13f0f662010-02-16 16:49:35 +00001280 /// LayoutVtablesForVirtualBases - Layout vtables for all virtual bases of the
1281 /// given base (excluding any primary bases).
1282 void LayoutVtablesForVirtualBases(const CXXRecordDecl *RD,
1283 VisitedVirtualBasesSetTy &VBases);
1284
Anders Carlsson31f595f2010-02-28 00:10:58 +00001285 /// isBuildingConstructionVtable - Return whether this vtable builder is
1286 /// building a construction vtable.
1287 bool isBuildingConstructorVtable() const {
1288 return MostDerivedClass != LayoutClass;
1289 }
1290
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001291public:
Anders Carlssona864caf2010-03-23 04:11:45 +00001292 VtableBuilder(CodeGenVTables &VTables, const CXXRecordDecl *MostDerivedClass,
Anders Carlsson62c6c722010-02-28 00:36:23 +00001293 uint64_t MostDerivedClassOffset, bool MostDerivedClassIsVirtual,
Anders Carlsson93913752010-02-27 20:39:05 +00001294 const CXXRecordDecl *LayoutClass)
Anders Carlssona864caf2010-03-23 04:11:45 +00001295 : VTables(VTables), MostDerivedClass(MostDerivedClass),
Anders Carlsson62c6c722010-02-28 00:36:23 +00001296 MostDerivedClassOffset(MostDerivedClassOffset),
1297 MostDerivedClassIsVirtual(MostDerivedClassIsVirtual),
1298 LayoutClass(LayoutClass), Context(MostDerivedClass->getASTContext()),
Anders Carlssonca82a4f2010-03-10 02:33:41 +00001299 Overriders(MostDerivedClass, MostDerivedClassOffset, LayoutClass) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001300
Anders Carlssonb716a542010-02-16 16:26:28 +00001301 LayoutVtable();
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001302 }
1303
Anders Carlsson5c5abad2010-03-23 16:36:50 +00001304 ThunksMapTy::const_iterator thunks_begin() const {
1305 return Thunks.begin();
1306 }
1307
1308 ThunksMapTy::const_iterator thunks_end() const {
1309 return Thunks.end();
1310 }
1311
Anders Carlssone90954d2010-03-24 16:42:11 +00001312 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
1313 return VBaseOffsetOffsets;
1314 }
1315
1316 /// getNumVTableComponents - Return the number of components in the vtable
1317 /// currently built.
1318 uint64_t getNumVTableComponents() const {
1319 return Components.size();
1320 }
1321
Anders Carlssond03325c2010-03-25 00:51:13 +00001322 const uint64_t *vtable_components_data_begin() const {
Anders Carlssone90954d2010-03-24 16:42:11 +00001323 return reinterpret_cast<const uint64_t *>(Components.begin());
1324 }
1325
Anders Carlssond03325c2010-03-25 00:51:13 +00001326 const uint64_t *vtable_components_data_end() const {
Anders Carlssone90954d2010-03-24 16:42:11 +00001327 return reinterpret_cast<const uint64_t *>(Components.end());
1328 }
1329
Anders Carlssond03325c2010-03-25 00:51:13 +00001330 AddressPointsMapTy::const_iterator address_points_begin() const {
1331 return AddressPoints.begin();
1332 }
1333
1334 AddressPointsMapTy::const_iterator address_points_end() const {
1335 return AddressPoints.end();
1336 }
1337
Anders Carlssona4147142010-03-25 15:26:28 +00001338 VtableThunksMapTy::const_iterator vtable_thunks_begin() const {
1339 return VTableThunks.begin();
1340 }
1341
1342 VtableThunksMapTy::const_iterator vtable_thunks_end() const {
1343 return VTableThunks.end();
1344 }
1345
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001346 /// dumpLayout - Dump the vtable layout.
1347 void dumpLayout(llvm::raw_ostream&);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001348};
1349
Anders Carlsson4b2411e2010-03-21 20:27:14 +00001350void VtableBuilder::AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk) {
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001351 assert(!isBuildingConstructorVtable() &&
1352 "Can't add thunks for construction vtable");
Anders Carlsson18c582d2010-03-18 02:44:19 +00001353
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001354 llvm::SmallVector<ThunkInfo, 1> &ThunksVector = Thunks[MD];
Anders Carlsson56446142010-03-17 20:06:32 +00001355
1356 // Check if we have this thunk already.
1357 if (std::find(ThunksVector.begin(), ThunksVector.end(), Thunk) !=
1358 ThunksVector.end())
1359 return;
1360
1361 ThunksVector.push_back(Thunk);
1362}
1363
Anders Carlssond2025412010-02-27 06:38:03 +00001364/// OverridesMethodInBases - Checks whether whether this virtual member
1365/// function overrides a member function in any of the given bases.
Anders Carlsson65b49782010-02-12 05:25:12 +00001366/// Returns the overridden member function, or null if none was found.
1367static const CXXMethodDecl *
Anders Carlssond2025412010-02-27 06:38:03 +00001368OverridesMethodInBases(const CXXMethodDecl *MD,
Anders Carlssond46ed892010-02-27 16:18:19 +00001369 VtableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001370 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1371 E = MD->end_overridden_methods(); I != E; ++I) {
1372 const CXXMethodDecl *OverriddenMD = *I;
1373 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
1374 assert(OverriddenMD->isCanonicalDecl() &&
1375 "Should have the canonical decl of the overridden RD!");
1376
Anders Carlssond2025412010-02-27 06:38:03 +00001377 if (Bases.count(OverriddenRD))
Anders Carlsson65b49782010-02-12 05:25:12 +00001378 return OverriddenMD;
1379 }
1380
1381 return 0;
1382}
1383
Anders Carlsson40687982010-02-27 16:52:49 +00001384void VtableBuilder::ComputeThisAdjustments() {
1385 // Now go through the method info map and see if any of the methods need
1386 // 'this' pointer adjustments.
1387 for (MethodInfoMapTy::const_iterator I = MethodInfoMap.begin(),
1388 E = MethodInfoMap.end(); I != E; ++I) {
1389 const CXXMethodDecl *MD = I->first;
1390 const MethodInfo &MethodInfo = I->second;
1391
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001392 // Ignore adjustments for unused function pointers.
1393 uint64_t VtableIndex = MethodInfo.VtableIndex;
1394 if (Components[VtableIndex].getKind() ==
1395 VtableComponent::CK_UnusedFunctionPointer)
1396 continue;
1397
Anders Carlsson40687982010-02-27 16:52:49 +00001398 // Get the final overrider for this method.
1399 FinalOverriders::OverriderInfo Overrider =
Anders Carlsson423406f32010-03-10 21:25:37 +00001400 Overriders.getOverrider(BaseSubobject(MD->getParent(),
1401 MethodInfo.BaseOffset), MD);
Anders Carlsson40687982010-02-27 16:52:49 +00001402
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001403 // Check if we need an adjustment at all.
Anders Carlssoneba1a602010-03-29 15:08:41 +00001404 if (MethodInfo.BaseOffsetInLayoutClass == Overrider.Offset) {
1405 // When a return thunk is needed by a derived class that overrides a
1406 // virtual base, gcc uses a virtual 'this' adjustment as well.
1407 // While the thunk itself might be needed by vtables in subclasses or
1408 // in construction vtables, there doesn't seem to be a reason for using
1409 // the thunk in this vtable. Still, we do so to match gcc.
1410 if (VTableThunks.lookup(VtableIndex).Return.isEmpty())
1411 continue;
1412 }
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001413
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001414 ThisAdjustment ThisAdjustment =
1415 ComputeThisAdjustment(MD, MethodInfo.BaseOffsetInLayoutClass, Overrider);
1416
1417 if (ThisAdjustment.isEmpty())
Anders Carlsson40687982010-02-27 16:52:49 +00001418 continue;
Anders Carlsson40687982010-02-27 16:52:49 +00001419
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001420 // Add it.
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001421 VTableThunks[VtableIndex].This = ThisAdjustment;
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001422
Anders Carlsson40687982010-02-27 16:52:49 +00001423 if (isa<CXXDestructorDecl>(MD)) {
1424 // Add an adjustment for the deleting destructor as well.
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001425 VTableThunks[VtableIndex + 1].This = ThisAdjustment;
Anders Carlsson40687982010-02-27 16:52:49 +00001426 }
1427 }
1428
1429 /// Clear the method info map.
1430 MethodInfoMap.clear();
Anders Carlsson64decd32010-03-22 15:47:01 +00001431
1432 if (isBuildingConstructorVtable()) {
1433 // We don't need to store thunk information for construction vtables.
1434 return;
1435 }
1436
Anders Carlsson917229c2010-03-23 04:59:02 +00001437 for (VtableThunksMapTy::const_iterator I = VTableThunks.begin(),
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001438 E = VTableThunks.end(); I != E; ++I) {
Anders Carlsson64decd32010-03-22 15:47:01 +00001439 const VtableComponent &Component = Components[I->first];
1440 const ThunkInfo &Thunk = I->second;
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001441 const CXXMethodDecl *MD;
Anders Carlsson64decd32010-03-22 15:47:01 +00001442
1443 switch (Component.getKind()) {
1444 default:
1445 llvm_unreachable("Unexpected vtable component kind!");
1446 case VtableComponent::CK_FunctionPointer:
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001447 MD = Component.getFunctionDecl();
Anders Carlsson64decd32010-03-22 15:47:01 +00001448 break;
1449 case VtableComponent::CK_CompleteDtorPointer:
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001450 MD = Component.getDestructorDecl();
Anders Carlsson64decd32010-03-22 15:47:01 +00001451 break;
1452 case VtableComponent::CK_DeletingDtorPointer:
1453 // We've already added the thunk when we saw the complete dtor pointer.
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001454 continue;
Anders Carlsson64decd32010-03-22 15:47:01 +00001455 }
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001456
1457 if (MD->getParent() == MostDerivedClass)
1458 AddThunk(MD, Thunk);
Anders Carlsson64decd32010-03-22 15:47:01 +00001459 }
Anders Carlsson40687982010-02-27 16:52:49 +00001460}
1461
Anders Carlsson67fd3a50d2010-03-23 15:13:06 +00001462ReturnAdjustment VtableBuilder::ComputeReturnAdjustment(BaseOffset Offset) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001463 ReturnAdjustment Adjustment;
1464
1465 if (!Offset.isEmpty()) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001466 if (Offset.VirtualBase) {
1467 // Get the virtual base offset offset.
Anders Carlssone4424882010-03-11 07:00:45 +00001468 if (Offset.DerivedClass == MostDerivedClass) {
1469 // We can get the offset offset directly from our map.
1470 Adjustment.VBaseOffsetOffset =
1471 VBaseOffsetOffsets.lookup(Offset.VirtualBase);
1472 } else {
1473 Adjustment.VBaseOffsetOffset =
Anders Carlssona864caf2010-03-23 04:11:45 +00001474 VTables.getVirtualBaseOffsetOffset(Offset.DerivedClass,
1475 Offset.VirtualBase);
Anders Carlssone4424882010-03-11 07:00:45 +00001476 }
1477
Anders Carlssondd819c92010-03-11 16:06:20 +00001478 // FIXME: Once the assert in getVirtualBaseOffsetOffset is back again,
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001479 // we can get rid of this assert.
1480 assert(Adjustment.VBaseOffsetOffset != 0 &&
Anders Carlssondd819c92010-03-11 16:06:20 +00001481 "Invalid vbase offset offset!");
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001482 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001483
1484 Adjustment.NonVirtual = Offset.NonVirtualOffset;
1485 }
1486
1487 return Adjustment;
1488}
1489
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001490BaseOffset
1491VtableBuilder::ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
1492 BaseSubobject Derived) const {
1493 const CXXRecordDecl *BaseRD = Base.getBase();
1494 const CXXRecordDecl *DerivedRD = Derived.getBase();
1495
1496 CXXBasePaths Paths(/*FindAmbiguities=*/true,
1497 /*RecordPaths=*/true, /*DetectVirtual=*/true);
1498
1499 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
1500 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
1501 assert(false && "Class must be derived from the passed in base class!");
1502 return BaseOffset();
1503 }
1504
1505 // We have to go through all the paths, and see which one leads us to the
1506 // right base subobject.
1507 for (CXXBasePaths::const_paths_iterator I = Paths.begin(), E = Paths.end();
1508 I != E; ++I) {
1509 BaseOffset Offset = ComputeBaseOffset(Context, DerivedRD, *I);
1510
1511 // FIXME: Should not use * 8 here.
1512 uint64_t OffsetToBaseSubobject = Offset.NonVirtualOffset * 8;
1513
1514 if (Offset.VirtualBase) {
1515 // If we have a virtual base class, the non-virtual offset is relative
1516 // to the virtual base class offset.
Anders Carlsson423406f32010-03-10 21:25:37 +00001517 const ASTRecordLayout &LayoutClassLayout =
1518 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001519
1520 /// Get the virtual base offset, relative to the most derived class
1521 /// layout.
1522 OffsetToBaseSubobject +=
Anders Carlsson423406f32010-03-10 21:25:37 +00001523 LayoutClassLayout.getVBaseClassOffset(Offset.VirtualBase);
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001524 } else {
1525 // Otherwise, the non-virtual offset is relative to the derived class
1526 // offset.
1527 OffsetToBaseSubobject += Derived.getBaseOffset();
1528 }
1529
1530 // Check if this path gives us the right base subobject.
1531 if (OffsetToBaseSubobject == Base.getBaseOffset()) {
1532 // Since we're going from the base class _to_ the derived class, we'll
1533 // invert the non-virtual offset here.
1534 Offset.NonVirtualOffset = -Offset.NonVirtualOffset;
1535 return Offset;
1536 }
1537 }
1538
1539 return BaseOffset();
1540}
1541
Anders Carlsson67fd3a50d2010-03-23 15:13:06 +00001542ThisAdjustment
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001543VtableBuilder::ComputeThisAdjustment(const CXXMethodDecl *MD,
1544 uint64_t BaseOffsetInLayoutClass,
1545 FinalOverriders::OverriderInfo Overrider) {
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001546 // Ignore adjustments for pure virtual member functions.
1547 if (Overrider.Method->isPure())
1548 return ThisAdjustment();
1549
1550 BaseSubobject OverriddenBaseSubobject(MD->getParent(),
1551 BaseOffsetInLayoutClass);
1552
1553 BaseSubobject OverriderBaseSubobject(Overrider.Method->getParent(),
1554 Overrider.Offset);
1555
1556 // Compute the adjustment offset.
1557 BaseOffset Offset = ComputeThisAdjustmentBaseOffset(OverriddenBaseSubobject,
1558 OverriderBaseSubobject);
1559 if (Offset.isEmpty())
1560 return ThisAdjustment();
1561
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001562 ThisAdjustment Adjustment;
1563
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001564 if (Offset.VirtualBase) {
1565 // Get the vcall offset map for this virtual base.
1566 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Offset.VirtualBase];
Anders Carlsson8847d9e2010-02-18 17:26:40 +00001567
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001568 if (VCallOffsets.empty()) {
1569 // We don't have vcall offsets for this virtual base, go ahead and
1570 // build them.
1571 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, MostDerivedClass,
1572 /*FinalOverriders=*/0,
1573 BaseSubobject(Offset.VirtualBase, 0),
1574 /*BaseIsVirtual=*/true,
1575 /*OffsetInLayoutClass=*/0);
1576
1577 VCallOffsets = Builder.getVCallOffsets();
1578 }
1579
1580 Adjustment.VCallOffsetOffset = VCallOffsets.getVCallOffsetOffset(MD);
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001581 }
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001582
1583 // Set the non-virtual part of the adjustment.
1584 Adjustment.NonVirtual = Offset.NonVirtualOffset;
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001585
1586 return Adjustment;
1587}
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001588
Anders Carlsson65b49782010-02-12 05:25:12 +00001589void
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001590VtableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlsson40687982010-02-27 16:52:49 +00001591 ReturnAdjustment ReturnAdjustment) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001592 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1593 assert(ReturnAdjustment.isEmpty() &&
1594 "Destructor can't have return adjustment!");
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001595
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001596 // Add both the complete destructor and the deleting destructor.
1597 Components.push_back(VtableComponent::MakeCompleteDtor(DD));
1598 Components.push_back(VtableComponent::MakeDeletingDtor(DD));
1599 } else {
1600 // Add the return adjustment if necessary.
1601 if (!ReturnAdjustment.isEmpty())
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001602 VTableThunks[Components.size()].Return = ReturnAdjustment;
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001603
1604 // Add the function.
1605 Components.push_back(VtableComponent::MakeFunction(MD));
1606 }
1607}
1608
Anders Carlssond2025412010-02-27 06:38:03 +00001609/// OverridesIndirectMethodInBase - Return whether the given member function
1610/// overrides any methods in the set of given bases.
1611/// Unlike OverridesMethodInBase, this checks "overriders of overriders".
1612/// For example, if we have:
1613///
1614/// struct A { virtual void f(); }
1615/// struct B : A { virtual void f(); }
1616/// struct C : B { virtual void f(); }
1617///
1618/// OverridesIndirectMethodInBase will return true if given C::f as the method
1619/// and { A } as the set of bases.
1620static bool
1621OverridesIndirectMethodInBases(const CXXMethodDecl *MD,
Anders Carlssond46ed892010-02-27 16:18:19 +00001622 VtableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssond2025412010-02-27 06:38:03 +00001623 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1624 E = MD->end_overridden_methods(); I != E; ++I) {
1625 const CXXMethodDecl *OverriddenMD = *I;
1626 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
1627 assert(OverriddenMD->isCanonicalDecl() &&
1628 "Should have the canonical decl of the overridden RD!");
1629
1630 if (Bases.count(OverriddenRD))
1631 return true;
1632
1633 // Check "indirect overriders".
1634 if (OverridesIndirectMethodInBases(OverriddenMD, Bases))
1635 return true;
1636 }
1637
1638 return false;
1639}
1640
Anders Carlssona8796c62010-02-23 04:26:39 +00001641bool
Anders Carlsson804cf512010-03-10 06:51:42 +00001642VtableBuilder::IsOverriderUsed(const CXXMethodDecl *Overrider,
1643 uint64_t BaseOffsetInLayoutClass,
1644 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1645 uint64_t FirstBaseOffsetInLayoutClass) const {
Anders Carlssona8796c62010-02-23 04:26:39 +00001646 // If the base and the first base in the primary base chain have the same
1647 // offsets, then this overrider will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001648 if (BaseOffsetInLayoutClass == FirstBaseOffsetInLayoutClass)
Anders Carlsson8939e402010-02-23 06:34:44 +00001649 return true;
1650
1651 // We know now that Base (or a direct or indirect base of it) is a primary
1652 // base in part of the class hierarchy, but not a primary base in the most
1653 // derived class.
1654
1655 // If the overrider is the first base in the primary base chain, we know
1656 // that the overrider will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001657 if (Overrider->getParent() == FirstBaseInPrimaryBaseChain)
Anders Carlssona8796c62010-02-23 04:26:39 +00001658 return true;
1659
Anders Carlssond46ed892010-02-27 16:18:19 +00001660 VtableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlsson8939e402010-02-23 06:34:44 +00001661
Anders Carlsson804cf512010-03-10 06:51:42 +00001662 const CXXRecordDecl *RD = FirstBaseInPrimaryBaseChain;
Anders Carlsson8939e402010-02-23 06:34:44 +00001663 PrimaryBases.insert(RD);
1664
1665 // Now traverse the base chain, starting with the first base, until we find
1666 // the base that is no longer a primary base.
1667 while (true) {
1668 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1669 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1670
1671 if (!PrimaryBase)
1672 break;
1673
1674 if (Layout.getPrimaryBaseWasVirtual()) {
1675 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
1676 "Primary base should always be at offset 0!");
1677
Anders Carlsson7162ab92010-02-28 18:37:33 +00001678 const ASTRecordLayout &LayoutClassLayout =
1679 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson8939e402010-02-23 06:34:44 +00001680
1681 // Now check if this is the primary base that is not a primary base in the
1682 // most derived class.
Anders Carlsson7162ab92010-02-28 18:37:33 +00001683 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
Anders Carlsson804cf512010-03-10 06:51:42 +00001684 FirstBaseOffsetInLayoutClass) {
Anders Carlsson8939e402010-02-23 06:34:44 +00001685 // We found it, stop walking the chain.
1686 break;
1687 }
1688 } else {
1689 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
1690 "Primary base should always be at offset 0!");
1691 }
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001692
Anders Carlssonb26c2ab2010-02-27 19:51:04 +00001693 if (!PrimaryBases.insert(PrimaryBase))
1694 assert(false && "Found a duplicate primary base!");
1695
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001696 RD = PrimaryBase;
Anders Carlsson8939e402010-02-23 06:34:44 +00001697 }
1698
1699 // If the final overrider is an override of one of the primary bases,
1700 // then we know that it will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001701 return OverridesIndirectMethodInBases(Overrider, PrimaryBases);
Anders Carlssona8796c62010-02-23 04:26:39 +00001702}
1703
Anders Carlsson40687982010-02-27 16:52:49 +00001704/// FindNearestOverriddenMethod - Given a method, returns the overridden method
1705/// from the nearest base. Returns null if no method was found.
1706static const CXXMethodDecl *
1707FindNearestOverriddenMethod(const CXXMethodDecl *MD,
1708 VtableBuilder::PrimaryBasesSetVectorTy &Bases) {
1709 for (int I = Bases.size(), E = 0; I != E; --I) {
1710 const CXXRecordDecl *PrimaryBase = Bases[I - 1];
1711
1712 // Now check the overriden methods.
1713 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1714 E = MD->end_overridden_methods(); I != E; ++I) {
1715 const CXXMethodDecl *OverriddenMD = *I;
1716
1717 // We found our overridden method.
1718 if (OverriddenMD->getParent() == PrimaryBase)
1719 return OverriddenMD;
1720 }
1721 }
1722
1723 return 0;
1724}
1725
Anders Carlsson804cf512010-03-10 06:51:42 +00001726void
1727VtableBuilder::AddMethods(BaseSubobject Base, uint64_t BaseOffsetInLayoutClass,
1728 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1729 uint64_t FirstBaseOffsetInLayoutClass,
Anders Carlssond46ed892010-02-27 16:18:19 +00001730 PrimaryBasesSetVectorTy &PrimaryBases) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001731 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001732 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1733
1734 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson804cf512010-03-10 06:51:42 +00001735 uint64_t PrimaryBaseOffset;
1736 uint64_t PrimaryBaseOffsetInLayoutClass;
Anders Carlsson0570f712010-02-23 03:48:14 +00001737 if (Layout.getPrimaryBaseWasVirtual()) {
1738 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
1739 "Primary vbase should have a zero offset!");
1740
1741 const ASTRecordLayout &MostDerivedClassLayout =
1742 Context.getASTRecordLayout(MostDerivedClass);
1743
Anders Carlsson804cf512010-03-10 06:51:42 +00001744 PrimaryBaseOffset =
1745 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
1746
1747 const ASTRecordLayout &LayoutClassLayout =
1748 Context.getASTRecordLayout(LayoutClass);
1749
1750 PrimaryBaseOffsetInLayoutClass =
1751 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson0570f712010-02-23 03:48:14 +00001752 } else {
Anders Carlsson65b49782010-02-12 05:25:12 +00001753 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
1754 "Primary base should have a zero offset!");
Anders Carlsson0570f712010-02-23 03:48:14 +00001755
Anders Carlsson804cf512010-03-10 06:51:42 +00001756 PrimaryBaseOffset = Base.getBaseOffset();
1757 PrimaryBaseOffsetInLayoutClass = BaseOffsetInLayoutClass;
Anders Carlsson0570f712010-02-23 03:48:14 +00001758 }
Anders Carlsson7162ab92010-02-28 18:37:33 +00001759
Anders Carlsson804cf512010-03-10 06:51:42 +00001760 AddMethods(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
1761 PrimaryBaseOffsetInLayoutClass, FirstBaseInPrimaryBaseChain,
1762 FirstBaseOffsetInLayoutClass, PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001763
1764 if (!PrimaryBases.insert(PrimaryBase))
1765 assert(false && "Found a duplicate primary base!");
1766 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001767
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001768 // Now go through all virtual member functions and add them.
1769 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1770 E = RD->method_end(); I != E; ++I) {
1771 const CXXMethodDecl *MD = *I;
Anders Carlsson65b49782010-02-12 05:25:12 +00001772
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001773 if (!MD->isVirtual())
1774 continue;
Anders Carlsson65b49782010-02-12 05:25:12 +00001775
1776 // Get the final overrider.
Anders Carlsson136bd192010-02-12 16:55:34 +00001777 FinalOverriders::OverriderInfo Overrider =
1778 Overriders.getOverrider(Base, MD);
Anders Carlsson65b49782010-02-12 05:25:12 +00001779
1780 // Check if this virtual member function overrides a method in a primary
1781 // base. If this is the case, and the return type doesn't require adjustment
1782 // then we can just use the member function from the primary base.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001783 if (const CXXMethodDecl *OverriddenMD =
Anders Carlsson40687982010-02-27 16:52:49 +00001784 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +00001785 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
Anders Carlsson40687982010-02-27 16:52:49 +00001786 OverriddenMD).isEmpty()) {
1787 // Replace the method info of the overridden method with our own
1788 // method.
1789 assert(MethodInfoMap.count(OverriddenMD) &&
1790 "Did not find the overridden method!");
1791 MethodInfo &OverriddenMethodInfo = MethodInfoMap[OverriddenMD];
1792
1793 MethodInfo MethodInfo(Base.getBaseOffset(),
Anders Carlsson423406f32010-03-10 21:25:37 +00001794 BaseOffsetInLayoutClass,
Anders Carlsson40687982010-02-27 16:52:49 +00001795 OverriddenMethodInfo.VtableIndex);
1796
1797 assert(!MethodInfoMap.count(MD) &&
1798 "Should not have method info for this method yet!");
1799
1800 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
1801 MethodInfoMap.erase(OverriddenMD);
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001802
1803 // If the overridden method exists in a virtual base class or a direct
1804 // or indirect base class of a virtual base class, we need to emit a
1805 // thunk if we ever have a class hierarchy where the base class is not
1806 // a primary base in the complete object.
1807 if (!isBuildingConstructorVtable() && OverriddenMD != MD) {
1808 // Compute the this adjustment.
1809 ThisAdjustment ThisAdjustment =
1810 ComputeThisAdjustment(OverriddenMD, BaseOffsetInLayoutClass,
1811 Overrider);
1812
Anders Carlsson800ded62010-03-29 02:53:58 +00001813 if (ThisAdjustment.VCallOffsetOffset &&
1814 Overrider.Method->getParent() == MostDerivedClass) {
1815 // This is a virtual thunk for the most derived class, add it.
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001816 AddThunk(Overrider.Method,
1817 ThunkInfo(ThisAdjustment, ReturnAdjustment()));
1818 }
1819 }
1820
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001821 continue;
Anders Carlsson40687982010-02-27 16:52:49 +00001822 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001823 }
Anders Carlssoneee53d92010-02-13 02:02:03 +00001824
Anders Carlsson40687982010-02-27 16:52:49 +00001825 // Insert the method info for this method.
Anders Carlsson423406f32010-03-10 21:25:37 +00001826 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
1827 Components.size());
Anders Carlsson40687982010-02-27 16:52:49 +00001828
1829 assert(!MethodInfoMap.count(MD) &&
1830 "Should not have method info for this method yet!");
1831 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001832
1833 // Check if this overrider is going to be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001834 const CXXMethodDecl *OverriderMD = Overrider.Method;
1835 if (!IsOverriderUsed(OverriderMD, BaseOffsetInLayoutClass,
1836 FirstBaseInPrimaryBaseChain,
1837 FirstBaseOffsetInLayoutClass)) {
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001838 Components.push_back(VtableComponent::MakeUnusedFunction(OverriderMD));
1839 continue;
1840 }
Anders Carlssona8796c62010-02-23 04:26:39 +00001841
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001842 // Check if this overrider needs a return adjustment.
Anders Carlsson075056a2010-02-23 01:34:28 +00001843 BaseOffset ReturnAdjustmentOffset =
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001844 Overriders.getReturnAdjustmentOffset(Base, MD);
1845
1846 ReturnAdjustment ReturnAdjustment =
1847 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001848
Anders Carlsson40687982010-02-27 16:52:49 +00001849 AddMethod(Overrider.Method, ReturnAdjustment);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001850 }
1851}
1852
Anders Carlssonb716a542010-02-16 16:26:28 +00001853void VtableBuilder::LayoutVtable() {
Anders Carlssone3385f52010-02-28 01:43:58 +00001854 LayoutPrimaryAndSecondaryVtables(BaseSubobject(MostDerivedClass, 0),
1855 MostDerivedClassIsVirtual,
1856 MostDerivedClassOffset);
Anders Carlssonb716a542010-02-16 16:26:28 +00001857
Anders Carlsson13f0f662010-02-16 16:49:35 +00001858 VisitedVirtualBasesSetTy VBases;
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001859
1860 // Determine the primary virtual bases.
Anders Carlsson02b99d62010-03-10 03:02:01 +00001861 DeterminePrimaryVirtualBases(MostDerivedClass, MostDerivedClassOffset,
1862 VBases);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001863 VBases.clear();
1864
Anders Carlsson13f0f662010-02-16 16:49:35 +00001865 LayoutVtablesForVirtualBases(MostDerivedClass, VBases);
Anders Carlssonb716a542010-02-16 16:26:28 +00001866}
1867
Anders Carlssone3385f52010-02-28 01:43:58 +00001868void
1869VtableBuilder::LayoutPrimaryAndSecondaryVtables(BaseSubobject Base,
1870 bool BaseIsVirtual,
1871 uint64_t OffsetInLayoutClass) {
Chris Lattnerd2408f72010-02-17 21:42:34 +00001872 assert(Base.getBase()->isDynamicClass() && "class does not have a vtable!");
Anders Carlsson033d4862010-02-14 17:05:59 +00001873
Anders Carlsson77904f12010-02-16 04:59:55 +00001874 // Add vcall and vbase offsets for this vtable.
Anders Carlssone3385f52010-02-28 01:43:58 +00001875 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, LayoutClass, &Overriders,
1876 Base, BaseIsVirtual, OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +00001877 Components.append(Builder.components_begin(), Builder.components_end());
1878
Anders Carlsson9e3b3a32010-02-25 22:23:13 +00001879 // Check if we need to add these vcall offsets.
1880 if (BaseIsVirtual && !Builder.getVCallOffsets().empty()) {
1881 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Base.getBase()];
1882
1883 if (VCallOffsets.empty())
1884 VCallOffsets = Builder.getVCallOffsets();
1885 }
1886
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001887 // If we're laying out the most derived class we want to keep track of the
1888 // virtual base class offset offsets.
1889 if (Base.getBase() == MostDerivedClass)
1890 VBaseOffsetOffsets = Builder.getVBaseOffsetOffsets();
1891
Anders Carlsson77904f12010-02-16 04:59:55 +00001892 // Add the offset to top.
Anders Carlsson258a1e32010-02-14 00:16:19 +00001893 // FIXME: We should not use / 8 here.
Anders Carlssone3385f52010-02-28 01:43:58 +00001894 int64_t OffsetToTop = -(int64_t)(OffsetInLayoutClass -
1895 MostDerivedClassOffset) / 8;
Anders Carlssone75aaa92010-02-13 22:05:23 +00001896 Components.push_back(VtableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson65b49782010-02-12 05:25:12 +00001897
1898 // Next, add the RTTI.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001899 Components.push_back(VtableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson65b49782010-02-12 05:25:12 +00001900
Anders Carlssone8a97562010-02-12 07:43:48 +00001901 uint64_t AddressPoint = Components.size();
Anders Carlsson65b49782010-02-12 05:25:12 +00001902
1903 // Now go through all virtual member functions and add them.
Anders Carlssond46ed892010-02-27 16:18:19 +00001904 PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlsson804cf512010-03-10 06:51:42 +00001905 AddMethods(Base, OffsetInLayoutClass, Base.getBase(), OffsetInLayoutClass,
1906 PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001907
Anders Carlsson40687982010-02-27 16:52:49 +00001908 // Compute 'this' pointer adjustments.
1909 ComputeThisAdjustments();
1910
Anders Carlsson151b0622010-03-25 21:45:14 +00001911 // Add all address points.
1912 const CXXRecordDecl *RD = Base.getBase();
1913 while (true) {
1914 AddressPoints.insert(std::make_pair(BaseSubobject(RD, OffsetInLayoutClass),
1915 AddressPoint));
1916
1917 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1918 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlssone8a97562010-02-12 07:43:48 +00001919
Anders Carlsson151b0622010-03-25 21:45:14 +00001920 if (!PrimaryBase)
1921 break;
1922
1923 if (Layout.getPrimaryBaseWasVirtual()) {
1924 // Check if this virtual primary base is a primary base in the layout
1925 // class. If it's not, we don't want to add it.
1926 const ASTRecordLayout &LayoutClassLayout =
1927 Context.getASTRecordLayout(LayoutClass);
1928
1929 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
1930 OffsetInLayoutClass) {
1931 // We don't want to add this class (or any of its primary bases).
1932 break;
1933 }
1934 }
1935
1936 RD = PrimaryBase;
Anders Carlssone8a97562010-02-12 07:43:48 +00001937 }
1938
Anders Carlsson115b4752010-03-10 19:39:11 +00001939 bool BaseIsMorallyVirtual = BaseIsVirtual;
1940 if (isBuildingConstructorVtable() && Base.getBase() == MostDerivedClass)
1941 BaseIsMorallyVirtual = false;
1942
Anders Carlssona9f633b2010-02-24 16:43:12 +00001943 // Layout secondary vtables.
Anders Carlsson115b4752010-03-10 19:39:11 +00001944 LayoutSecondaryVtables(Base, BaseIsMorallyVirtual, OffsetInLayoutClass);
Anders Carlsson14157932010-02-16 16:02:57 +00001945}
1946
Anders Carlssone3385f52010-02-28 01:43:58 +00001947void VtableBuilder::LayoutSecondaryVtables(BaseSubobject Base,
Anders Carlsson115b4752010-03-10 19:39:11 +00001948 bool BaseIsMorallyVirtual,
Anders Carlssone3385f52010-02-28 01:43:58 +00001949 uint64_t OffsetInLayoutClass) {
Anders Carlsson14157932010-02-16 16:02:57 +00001950 // Itanium C++ ABI 2.5.2:
1951 // Following the primary virtual table of a derived class are secondary
1952 // virtual tables for each of its proper base classes, except any primary
1953 // base(s) with which it shares its primary virtual table.
1954
1955 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001956 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1957 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson14157932010-02-16 16:02:57 +00001958
Anders Carlsson65b49782010-02-12 05:25:12 +00001959 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1960 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson14157932010-02-16 16:02:57 +00001961 // Ignore virtual bases, we'll emit them later.
1962 if (I->isVirtual())
1963 continue;
1964
Anders Carlsson65b49782010-02-12 05:25:12 +00001965 const CXXRecordDecl *BaseDecl =
1966 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson033d4862010-02-14 17:05:59 +00001967
Anders Carlssondc2dba32010-02-16 04:49:44 +00001968 // Ignore bases that don't have a vtable.
1969 if (!BaseDecl->isDynamicClass())
1970 continue;
Anders Carlsson033d4862010-02-14 17:05:59 +00001971
Anders Carlsson703a0862010-03-10 19:15:26 +00001972 if (isBuildingConstructorVtable()) {
1973 // Itanium C++ ABI 2.6.4:
1974 // Some of the base class subobjects may not need construction virtual
1975 // tables, which will therefore not be present in the construction
1976 // virtual table group, even though the subobject virtual tables are
1977 // present in the main virtual table group for the complete object.
Anders Carlsson115b4752010-03-10 19:39:11 +00001978 if (!BaseIsMorallyVirtual && !BaseDecl->getNumVBases())
Anders Carlsson703a0862010-03-10 19:15:26 +00001979 continue;
Anders Carlsson703a0862010-03-10 19:15:26 +00001980 }
1981
Anders Carlssone75aaa92010-02-13 22:05:23 +00001982 // Get the base offset of this base.
Anders Carlssone3385f52010-02-28 01:43:58 +00001983 uint64_t RelativeBaseOffset = Layout.getBaseClassOffset(BaseDecl);
1984 uint64_t BaseOffset = Base.getBaseOffset() + RelativeBaseOffset;
1985
1986 uint64_t BaseOffsetInLayoutClass = OffsetInLayoutClass + RelativeBaseOffset;
Anders Carlsson14157932010-02-16 16:02:57 +00001987
1988 // Don't emit a secondary vtable for a primary base. We might however want
1989 // to emit secondary vtables for other bases of this base.
1990 if (BaseDecl == PrimaryBase) {
Anders Carlssone3385f52010-02-28 01:43:58 +00001991 LayoutSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset),
Anders Carlsson115b4752010-03-10 19:39:11 +00001992 BaseIsMorallyVirtual, BaseOffsetInLayoutClass);
Anders Carlsson14157932010-02-16 16:02:57 +00001993 continue;
1994 }
Anders Carlssone75aaa92010-02-13 22:05:23 +00001995
Anders Carlssonb716a542010-02-16 16:26:28 +00001996 // Layout the primary vtable (and any secondary vtables) for this base.
Anders Carlssone3385f52010-02-28 01:43:58 +00001997 LayoutPrimaryAndSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset),
1998 /*BaseIsVirtual=*/false,
1999 BaseOffsetInLayoutClass);
Anders Carlsson65b49782010-02-12 05:25:12 +00002000 }
2001}
2002
Anders Carlsson13f0f662010-02-16 16:49:35 +00002003void
Anders Carlsson02b99d62010-03-10 03:02:01 +00002004VtableBuilder::DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
2005 uint64_t OffsetInLayoutClass,
Anders Carlssonb08aaa32010-02-27 04:05:52 +00002006 VisitedVirtualBasesSetTy &VBases) {
2007 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
2008
2009 // Check if this base has a primary base.
2010 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson8b37bb72010-02-28 18:08:38 +00002011
2012 // Check if it's virtual.
2013 if (Layout.getPrimaryBaseWasVirtual()) {
2014 bool IsPrimaryVirtualBase = true;
2015
2016 if (isBuildingConstructorVtable()) {
2017 // Check if the base is actually a primary base in the class we use for
2018 // layout.
Anders Carlsson02b99d62010-03-10 03:02:01 +00002019 const ASTRecordLayout &LayoutClassLayout =
2020 Context.getASTRecordLayout(LayoutClass);
2021
2022 uint64_t PrimaryBaseOffsetInLayoutClass =
2023 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
2024
2025 // We know that the base is not a primary base in the layout class if
2026 // the base offsets are different.
2027 if (PrimaryBaseOffsetInLayoutClass != OffsetInLayoutClass)
Anders Carlsson8b37bb72010-02-28 18:08:38 +00002028 IsPrimaryVirtualBase = false;
2029 }
2030
2031 if (IsPrimaryVirtualBase)
2032 PrimaryVirtualBases.insert(PrimaryBase);
2033 }
Anders Carlssonb08aaa32010-02-27 04:05:52 +00002034 }
2035
2036 // Traverse bases, looking for more primary virtual bases.
2037 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
2038 E = RD->bases_end(); I != E; ++I) {
2039 const CXXRecordDecl *BaseDecl =
2040 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
2041
Anders Carlsson02b99d62010-03-10 03:02:01 +00002042 uint64_t BaseOffsetInLayoutClass;
2043
2044 if (I->isVirtual()) {
2045 if (!VBases.insert(BaseDecl))
2046 continue;
2047
2048 const ASTRecordLayout &LayoutClassLayout =
2049 Context.getASTRecordLayout(LayoutClass);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00002050
Anders Carlsson02b99d62010-03-10 03:02:01 +00002051 BaseOffsetInLayoutClass = LayoutClassLayout.getVBaseClassOffset(BaseDecl);
2052 } else {
2053 BaseOffsetInLayoutClass =
2054 OffsetInLayoutClass + Layout.getBaseClassOffset(BaseDecl);
2055 }
2056
2057 DeterminePrimaryVirtualBases(BaseDecl, BaseOffsetInLayoutClass, VBases);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00002058 }
2059}
2060
2061void
Anders Carlsson13f0f662010-02-16 16:49:35 +00002062VtableBuilder::LayoutVtablesForVirtualBases(const CXXRecordDecl *RD,
2063 VisitedVirtualBasesSetTy &VBases) {
2064 // Itanium C++ ABI 2.5.2:
2065 // Then come the virtual base virtual tables, also in inheritance graph
2066 // order, and again excluding primary bases (which share virtual tables with
2067 // the classes for which they are primary).
Anders Carlsson13f0f662010-02-16 16:49:35 +00002068 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
2069 E = RD->bases_end(); I != E; ++I) {
2070 const CXXRecordDecl *BaseDecl =
2071 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
2072
Anders Carlsson0570f712010-02-23 03:48:14 +00002073 // Check if this base needs a vtable. (If it's virtual, not a primary base
2074 // of some other class, and we haven't visited it before).
Anders Carlsson13f0f662010-02-16 16:49:35 +00002075 if (I->isVirtual() && BaseDecl->isDynamicClass() &&
Anders Carlssonb08aaa32010-02-27 04:05:52 +00002076 !PrimaryVirtualBases.count(BaseDecl) && VBases.insert(BaseDecl)) {
Anders Carlsson13f0f662010-02-16 16:49:35 +00002077 const ASTRecordLayout &MostDerivedClassLayout =
2078 Context.getASTRecordLayout(MostDerivedClass);
2079 uint64_t BaseOffset =
2080 MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
2081
Anders Carlssone3385f52010-02-28 01:43:58 +00002082 const ASTRecordLayout &LayoutClassLayout =
2083 Context.getASTRecordLayout(LayoutClass);
2084 uint64_t BaseOffsetInLayoutClass =
2085 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
2086
2087 LayoutPrimaryAndSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset),
2088 /*BaseIsVirtual=*/true,
2089 BaseOffsetInLayoutClass);
Anders Carlsson13f0f662010-02-16 16:49:35 +00002090 }
2091
2092 // We only need to check the base for virtual base vtables if it actually
2093 // has virtual bases.
2094 if (BaseDecl->getNumVBases())
2095 LayoutVtablesForVirtualBases(BaseDecl, VBases);
2096 }
2097}
2098
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002099/// dumpLayout - Dump the vtable layout.
2100void VtableBuilder::dumpLayout(llvm::raw_ostream& Out) {
Anders Carlsson93913752010-02-27 20:39:05 +00002101
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002102 if (isBuildingConstructorVtable()) {
Anders Carlsson93913752010-02-27 20:39:05 +00002103 Out << "Construction vtable for ('";
2104 Out << MostDerivedClass->getQualifiedNameAsString() << "', ";
2105 // FIXME: Don't use / 8 .
2106 Out << MostDerivedClassOffset / 8 << ") in '";
2107 Out << LayoutClass->getQualifiedNameAsString();
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002108 } else {
2109 Out << "Vtable for '";
2110 Out << MostDerivedClass->getQualifiedNameAsString();
Anders Carlsson93913752010-02-27 20:39:05 +00002111 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002112 Out << "' (" << Components.size() << " entries).\n";
2113
Anders Carlsson932c2f22010-02-11 17:18:51 +00002114 // Iterate through the address points and insert them into a new map where
2115 // they are keyed by the index and not the base object.
2116 // Since an address point can be shared by multiple subobjects, we use an
2117 // STL multimap.
2118 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
Anders Carlsson0534b022010-03-25 00:35:49 +00002119 for (AddressPointsMapTy::const_iterator I = AddressPoints.begin(),
2120 E = AddressPoints.end(); I != E; ++I) {
Anders Carlsson932c2f22010-02-11 17:18:51 +00002121 const BaseSubobject& Base = I->first;
2122 uint64_t Index = I->second;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002123
Anders Carlsson932c2f22010-02-11 17:18:51 +00002124 AddressPointsByIndex.insert(std::make_pair(Index, Base));
2125 }
2126
2127 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlssone8a97562010-02-12 07:43:48 +00002128 uint64_t Index = I;
Anders Carlsson932c2f22010-02-11 17:18:51 +00002129
2130 Out << llvm::format("%4d | ", I);
2131
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002132 const VtableComponent &Component = Components[I];
2133
2134 // Dump the component.
2135 switch (Component.getKind()) {
Anders Carlssonb0a588f2010-02-17 06:07:19 +00002136
2137 case VtableComponent::CK_VCallOffset:
2138 Out << "vcall_offset (" << Component.getVCallOffset() << ")";
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002139 break;
Anders Carlsson77904f12010-02-16 04:59:55 +00002140
2141 case VtableComponent::CK_VBaseOffset:
2142 Out << "vbase_offset (" << Component.getVBaseOffset() << ")";
2143 break;
2144
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002145 case VtableComponent::CK_OffsetToTop:
2146 Out << "offset_to_top (" << Component.getOffsetToTop() << ")";
2147 break;
2148
2149 case VtableComponent::CK_RTTI:
2150 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
2151 break;
2152
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002153 case VtableComponent::CK_FunctionPointer: {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002154 const CXXMethodDecl *MD = Component.getFunctionDecl();
2155
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002156 std::string Str =
2157 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2158 MD);
2159 Out << Str;
Anders Carlsson09da3372010-02-12 02:38:13 +00002160 if (MD->isPure())
2161 Out << " [pure]";
2162
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002163 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlsson8a240292010-03-12 04:54:20 +00002164 if (!Thunk.isEmpty()) {
2165 // If this function pointer has a return adjustment, dump it.
2166 if (!Thunk.Return.isEmpty()) {
2167 Out << "\n [return adjustment: ";
2168 Out << Thunk.Return.NonVirtual << " non-virtual";
2169
2170 if (Thunk.Return.VBaseOffsetOffset) {
2171 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2172 Out << " vbase offset offset";
2173 }
Anders Carlsson78277c72010-02-18 17:00:09 +00002174
Anders Carlsson8a240292010-03-12 04:54:20 +00002175 Out << ']';
2176 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002177
Anders Carlsson8a240292010-03-12 04:54:20 +00002178 // If this function pointer has a 'this' pointer adjustment, dump it.
2179 if (!Thunk.This.isEmpty()) {
2180 Out << "\n [this adjustment: ";
2181 Out << Thunk.This.NonVirtual << " non-virtual";
2182
2183 if (Thunk.This.VCallOffsetOffset) {
2184 Out << ", " << Thunk.This.VCallOffsetOffset;
2185 Out << " vcall offset offset";
2186 }
Anders Carlsson78277c72010-02-18 17:00:09 +00002187
Anders Carlsson8a240292010-03-12 04:54:20 +00002188 Out << ']';
2189 }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00002190 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002191
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002192 break;
2193 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002194
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002195 case VtableComponent::CK_CompleteDtorPointer:
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002196 case VtableComponent::CK_DeletingDtorPointer: {
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002197 bool IsComplete =
2198 Component.getKind() == VtableComponent::CK_CompleteDtorPointer;
2199
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002200 const CXXDestructorDecl *DD = Component.getDestructorDecl();
2201
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002202 Out << DD->getQualifiedNameAsString();
2203 if (IsComplete)
2204 Out << "() [complete]";
2205 else
2206 Out << "() [deleting]";
2207
Anders Carlsson09da3372010-02-12 02:38:13 +00002208 if (DD->isPure())
2209 Out << " [pure]";
2210
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002211 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlsson8a240292010-03-12 04:54:20 +00002212 if (!Thunk.isEmpty()) {
2213 // If this destructor has a 'this' pointer adjustment, dump it.
2214 if (!Thunk.This.isEmpty()) {
2215 Out << "\n [this adjustment: ";
2216 Out << Thunk.This.NonVirtual << " non-virtual";
2217
2218 if (Thunk.This.VCallOffsetOffset) {
2219 Out << ", " << Thunk.This.VCallOffsetOffset;
2220 Out << " vcall offset offset";
2221 }
2222
2223 Out << ']';
2224 }
2225 }
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002226
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002227 break;
2228 }
2229
Anders Carlsson350b56e2010-02-19 20:08:13 +00002230 case VtableComponent::CK_UnusedFunctionPointer: {
2231 const CXXMethodDecl *MD = Component.getUnusedFunctionDecl();
2232
2233 std::string Str =
2234 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2235 MD);
2236 Out << "[unused] " << Str;
2237 if (MD->isPure())
2238 Out << " [pure]";
2239 }
2240
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002241 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00002242
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002243 Out << '\n';
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002244
2245 // Dump the next address point.
2246 uint64_t NextIndex = Index + 1;
2247 if (AddressPointsByIndex.count(NextIndex)) {
2248 if (AddressPointsByIndex.count(NextIndex) == 1) {
2249 const BaseSubobject &Base =
2250 AddressPointsByIndex.find(NextIndex)->second;
2251
2252 // FIXME: Instead of dividing by 8, we should be using CharUnits.
2253 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
2254 Out << ", " << Base.getBaseOffset() / 8 << ") vtable address --\n";
2255 } else {
2256 uint64_t BaseOffset =
2257 AddressPointsByIndex.lower_bound(NextIndex)->second.getBaseOffset();
2258
2259 // We store the class names in a set to get a stable order.
2260 std::set<std::string> ClassNames;
2261 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
2262 AddressPointsByIndex.lower_bound(NextIndex), E =
2263 AddressPointsByIndex.upper_bound(NextIndex); I != E; ++I) {
2264 assert(I->second.getBaseOffset() == BaseOffset &&
2265 "Invalid base offset!");
2266 const CXXRecordDecl *RD = I->second.getBase();
2267 ClassNames.insert(RD->getQualifiedNameAsString());
2268 }
2269
2270 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
2271 E = ClassNames.end(); I != E; ++I) {
2272 // FIXME: Instead of dividing by 8, we should be using CharUnits.
2273 Out << " -- (" << *I;
2274 Out << ", " << BaseOffset / 8 << ") vtable address --\n";
2275 }
2276 }
2277 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002278 }
Anders Carlsson93913752010-02-27 20:39:05 +00002279
2280 Out << '\n';
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002281
Anders Carlsson18c582d2010-03-18 02:44:19 +00002282 if (isBuildingConstructorVtable())
2283 return;
2284
2285 if (MostDerivedClass->getNumVBases()) {
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002286 // We store the virtual base class names and their offsets in a map to get
2287 // a stable order.
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002288
Anders Carlsson18c582d2010-03-18 02:44:19 +00002289 std::map<std::string, int64_t> ClassNamesAndOffsets;
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002290 for (VBaseOffsetOffsetsMapTy::const_iterator I = VBaseOffsetOffsets.begin(),
2291 E = VBaseOffsetOffsets.end(); I != E; ++I) {
2292 std::string ClassName = I->first->getQualifiedNameAsString();
2293 int64_t OffsetOffset = I->second;
2294 ClassNamesAndOffsets.insert(std::make_pair(ClassName, OffsetOffset));
2295 }
Anders Carlsson18c582d2010-03-18 02:44:19 +00002296
2297 Out << "Virtual base offset offsets for '";
2298 Out << MostDerivedClass->getQualifiedNameAsString() << "' (";
2299 Out << ClassNamesAndOffsets.size();
2300 Out << (ClassNamesAndOffsets.size() == 1 ? " entry" : " entries") << ").\n";
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002301
2302 for (std::map<std::string, int64_t>::const_iterator I =
2303 ClassNamesAndOffsets.begin(), E = ClassNamesAndOffsets.end();
2304 I != E; ++I)
2305 Out << " " << I->first << " | " << I->second << '\n';
2306
2307 Out << "\n";
2308 }
Anders Carlsson18c582d2010-03-18 02:44:19 +00002309
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002310 if (!Thunks.empty()) {
Anders Carlsson18c582d2010-03-18 02:44:19 +00002311 // We store the method names in a map to get a stable order.
2312 std::map<std::string, const CXXMethodDecl *> MethodNamesAndDecls;
2313
Anders Carlsson917229c2010-03-23 04:59:02 +00002314 for (ThunksMapTy::const_iterator I = Thunks.begin(), E = Thunks.end();
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002315 I != E; ++I) {
Anders Carlsson18c582d2010-03-18 02:44:19 +00002316 const CXXMethodDecl *MD = I->first;
2317 std::string MethodName =
2318 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2319 MD);
2320
2321 MethodNamesAndDecls.insert(std::make_pair(MethodName, MD));
2322 }
2323
2324 for (std::map<std::string, const CXXMethodDecl *>::const_iterator I =
2325 MethodNamesAndDecls.begin(), E = MethodNamesAndDecls.end();
2326 I != E; ++I) {
2327 const std::string &MethodName = I->first;
2328 const CXXMethodDecl *MD = I->second;
Anders Carlsson7eb99a62010-03-22 16:30:44 +00002329
Anders Carlsson917229c2010-03-23 04:59:02 +00002330 ThunkInfoVectorTy ThunksVector = Thunks[MD];
Anders Carlsson7eb99a62010-03-22 16:30:44 +00002331 std::sort(ThunksVector.begin(), ThunksVector.end());
Anders Carlsson18c582d2010-03-18 02:44:19 +00002332
2333 Out << "Thunks for '" << MethodName << "' (" << ThunksVector.size();
2334 Out << (ThunksVector.size() == 1 ? " entry" : " entries") << ").\n";
2335
2336 for (unsigned I = 0, E = ThunksVector.size(); I != E; ++I) {
2337 const ThunkInfo &Thunk = ThunksVector[I];
2338
2339 Out << llvm::format("%4d | ", I);
2340
Anders Carlsson53a47bf2010-03-22 16:10:59 +00002341 // If this function pointer has a return pointer adjustment, dump it.
2342 if (!Thunk.Return.isEmpty()) {
2343 Out << "return adjustment: " << Thunk.This.NonVirtual;
2344 Out << " non-virtual";
2345 if (Thunk.Return.VBaseOffsetOffset) {
2346 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2347 Out << " vbase offset offset";
2348 }
2349
2350 if (!Thunk.This.isEmpty())
2351 Out << "\n ";
2352 }
2353
Anders Carlsson18c582d2010-03-18 02:44:19 +00002354 // If this function pointer has a 'this' pointer adjustment, dump it.
2355 if (!Thunk.This.isEmpty()) {
Anders Carlsson53a47bf2010-03-22 16:10:59 +00002356 Out << "this adjustment: ";
2357 Out << Thunk.This.NonVirtual << " non-virtual";
Anders Carlsson18c582d2010-03-18 02:44:19 +00002358
2359 if (Thunk.This.VCallOffsetOffset) {
2360 Out << ", " << Thunk.This.VCallOffsetOffset;
Anders Carlsson53a47bf2010-03-22 16:10:59 +00002361 Out << " vcall offset offset";
Anders Carlsson18c582d2010-03-18 02:44:19 +00002362 }
2363 }
2364
2365 Out << '\n';
2366 }
Anders Carlsson290c6ed2010-03-22 20:06:40 +00002367
2368 Out << '\n';
2369
Anders Carlsson18c582d2010-03-18 02:44:19 +00002370 }
2371 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002372}
2373
2374}
2375
2376namespace {
2377class OldVtableBuilder {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002378public:
2379 /// Index_t - Vtable index type.
2380 typedef uint64_t Index_t;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002381 typedef std::vector<std::pair<GlobalDecl,
2382 std::pair<GlobalDecl, ThunkAdjustment> > >
2383 SavedAdjustmentsVectorTy;
Anders Carlsson0534b022010-03-25 00:35:49 +00002384 typedef llvm::DenseMap<BaseSubobject, uint64_t> AddressPointsMapTy;
2385
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002386private:
Anders Carlsson472404f2009-12-04 16:19:30 +00002387
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002388 // VtableComponents - The components of the vtable being built.
2389 typedef llvm::SmallVector<llvm::Constant *, 64> VtableComponentsVectorTy;
2390 VtableComponentsVectorTy VtableComponents;
2391
Eli Friedman6c08ce72009-12-05 01:05:03 +00002392 const bool BuildVtable;
2393
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002394 llvm::Type *Ptr8Ty;
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002395
2396 /// MostDerivedClass - The most derived class that this vtable is being
2397 /// built for.
2398 const CXXRecordDecl *MostDerivedClass;
2399
Mike Stump83066c82009-11-13 01:54:23 +00002400 /// LayoutClass - The most derived class used for virtual base layout
2401 /// information.
2402 const CXXRecordDecl *LayoutClass;
Mike Stump653d0b92009-11-13 02:13:54 +00002403 /// LayoutOffset - The offset for Class in LayoutClass.
2404 uint64_t LayoutOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002405 /// BLayout - Layout for the most derived class that this vtable is being
2406 /// built for.
2407 const ASTRecordLayout &BLayout;
2408 llvm::SmallSet<const CXXRecordDecl *, 32> IndirectPrimary;
2409 llvm::SmallSet<const CXXRecordDecl *, 32> SeenVBase;
2410 llvm::Constant *rtti;
2411 llvm::LLVMContext &VMContext;
2412 CodeGenModule &CGM; // Per-module state.
Anders Carlssonf2f31f42009-12-04 03:46:21 +00002413
Mike Stump90181eb2010-01-26 00:05:04 +00002414 llvm::DenseMap<const CXXMethodDecl *, Index_t> VCall;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002415 llvm::DenseMap<GlobalDecl, Index_t> VCallOffset;
Mike Stump77537b12010-01-26 03:42:22 +00002416 llvm::DenseMap<GlobalDecl, Index_t> VCallOffsetForVCall;
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002417 // This is the offset to the nearest virtual base
Mike Stump90181eb2010-01-26 00:05:04 +00002418 llvm::DenseMap<const CXXMethodDecl *, Index_t> NonVirtualOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002419 llvm::DenseMap<const CXXRecordDecl *, Index_t> VBIndex;
Mike Stumpbb9ff052009-10-27 23:46:47 +00002420
Anders Carlsson323bb042009-11-26 19:54:33 +00002421 /// PureVirtualFunction - Points to __cxa_pure_virtual.
2422 llvm::Constant *PureVirtualFn;
2423
Anders Carlssona84b6e82009-12-04 02:01:07 +00002424 /// VtableMethods - A data structure for keeping track of methods in a vtable.
2425 /// Can add methods, override methods and iterate in vtable order.
2426 class VtableMethods {
2427 // MethodToIndexMap - Maps from a global decl to the index it has in the
2428 // Methods vector.
2429 llvm::DenseMap<GlobalDecl, uint64_t> MethodToIndexMap;
2430
2431 /// Methods - The methods, in vtable order.
2432 typedef llvm::SmallVector<GlobalDecl, 16> MethodsVectorTy;
2433 MethodsVectorTy Methods;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002434 MethodsVectorTy OrigMethods;
Anders Carlssona84b6e82009-12-04 02:01:07 +00002435
2436 public:
2437 /// AddMethod - Add a method to the vtable methods.
2438 void AddMethod(GlobalDecl GD) {
2439 assert(!MethodToIndexMap.count(GD) &&
2440 "Method has already been added!");
2441
2442 MethodToIndexMap[GD] = Methods.size();
2443 Methods.push_back(GD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002444 OrigMethods.push_back(GD);
Anders Carlssona84b6e82009-12-04 02:01:07 +00002445 }
2446
2447 /// OverrideMethod - Replace a method with another.
2448 void OverrideMethod(GlobalDecl OverriddenGD, GlobalDecl GD) {
2449 llvm::DenseMap<GlobalDecl, uint64_t>::iterator i
2450 = MethodToIndexMap.find(OverriddenGD);
2451 assert(i != MethodToIndexMap.end() && "Did not find entry!");
2452
2453 // Get the index of the old decl.
2454 uint64_t Index = i->second;
2455
2456 // Replace the old decl with the new decl.
2457 Methods[Index] = GD;
2458
Anders Carlssona84b6e82009-12-04 02:01:07 +00002459 // And add the new.
2460 MethodToIndexMap[GD] = Index;
2461 }
2462
Anders Carlsson7bb70762009-12-04 15:49:02 +00002463 /// getIndex - Gives the index of a passed in GlobalDecl. Returns false if
2464 /// the index couldn't be found.
Benjamin Kramer62ab6162009-12-04 22:45:27 +00002465 bool getIndex(GlobalDecl GD, uint64_t &Index) const {
Anders Carlsson7bb70762009-12-04 15:49:02 +00002466 llvm::DenseMap<GlobalDecl, uint64_t>::const_iterator i
2467 = MethodToIndexMap.find(GD);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002468
Anders Carlsson7bb70762009-12-04 15:49:02 +00002469 if (i == MethodToIndexMap.end())
2470 return false;
Anders Carlssone6096362009-12-04 03:41:37 +00002471
Anders Carlsson7bb70762009-12-04 15:49:02 +00002472 Index = i->second;
2473 return true;
Anders Carlssone6096362009-12-04 03:41:37 +00002474 }
2475
Eli Friedman8174f2c2009-12-06 22:01:30 +00002476 GlobalDecl getOrigMethod(uint64_t Index) const {
2477 return OrigMethods[Index];
2478 }
2479
Anders Carlssona84b6e82009-12-04 02:01:07 +00002480 MethodsVectorTy::size_type size() const {
2481 return Methods.size();
2482 }
2483
2484 void clear() {
2485 MethodToIndexMap.clear();
2486 Methods.clear();
Eli Friedman8174f2c2009-12-06 22:01:30 +00002487 OrigMethods.clear();
Anders Carlssona84b6e82009-12-04 02:01:07 +00002488 }
2489
Anders Carlssone6096362009-12-04 03:41:37 +00002490 GlobalDecl operator[](uint64_t Index) const {
Anders Carlssona84b6e82009-12-04 02:01:07 +00002491 return Methods[Index];
2492 }
2493 };
2494
2495 /// Methods - The vtable methods we're currently building.
2496 VtableMethods Methods;
2497
Anders Carlsson4c837d22009-12-04 02:26:15 +00002498 /// ThisAdjustments - For a given index in the vtable, contains the 'this'
2499 /// pointer adjustment needed for a method.
2500 typedef llvm::DenseMap<uint64_t, ThunkAdjustment> ThisAdjustmentsMapTy;
2501 ThisAdjustmentsMapTy ThisAdjustments;
Anders Carlssond420a312009-11-26 19:32:45 +00002502
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002503 SavedAdjustmentsVectorTy SavedAdjustments;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002504
Anders Carlssonc521f952009-12-04 02:22:02 +00002505 /// BaseReturnTypes - Contains the base return types of methods who have been
2506 /// overridden with methods whose return types require adjustment. Used for
2507 /// generating covariant thunk information.
2508 typedef llvm::DenseMap<uint64_t, CanQualType> BaseReturnTypesMapTy;
2509 BaseReturnTypesMapTy BaseReturnTypes;
Anders Carlssond420a312009-11-26 19:32:45 +00002510
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002511 std::vector<Index_t> VCalls;
Mike Stump2cefe382009-11-12 20:47:57 +00002512
2513 typedef std::pair<const CXXRecordDecl *, uint64_t> CtorVtable_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00002514 // subAddressPoints - Used to hold the AddressPoints (offsets) into the built
2515 // vtable for use in computing the initializers for the VTT.
2516 llvm::DenseMap<CtorVtable_t, int64_t> &subAddressPoints;
Mike Stump2cefe382009-11-12 20:47:57 +00002517
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002518 /// AddressPoints - Address points for this vtable.
Anders Carlsson0534b022010-03-25 00:35:49 +00002519 AddressPointsMapTy& AddressPoints;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002520
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002521 typedef CXXRecordDecl::method_iterator method_iter;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002522 const uint32_t LLVMPointerWidth;
2523 Index_t extra;
Mike Stump37dbe962009-10-15 02:04:03 +00002524 typedef std::vector<std::pair<const CXXRecordDecl *, int64_t> > Path_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00002525 static llvm::DenseMap<CtorVtable_t, int64_t>&
2526 AllocAddressPoint(CodeGenModule &cgm, const CXXRecordDecl *l,
2527 const CXXRecordDecl *c) {
Anders Carlssond03325c2010-03-25 00:51:13 +00002528 CodeGenVTables::AddrMap_t *&oref = cgm.getVTables().OldAddressPoints[l];
Mike Stumpcd2b8212009-11-19 20:52:19 +00002529 if (oref == 0)
Anders Carlssona864caf2010-03-23 04:11:45 +00002530 oref = new CodeGenVTables::AddrMap_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00002531
2532 llvm::DenseMap<CtorVtable_t, int64_t> *&ref = (*oref)[c];
2533 if (ref == 0)
2534 ref = new llvm::DenseMap<CtorVtable_t, int64_t>;
2535 return *ref;
2536 }
Anders Carlsson323bb042009-11-26 19:54:33 +00002537
Mike Stump90181eb2010-01-26 00:05:04 +00002538 bool DclIsSame(const FunctionDecl *New, const FunctionDecl *Old) {
2539 FunctionTemplateDecl *OldTemplate = Old->getDescribedFunctionTemplate();
2540 FunctionTemplateDecl *NewTemplate = New->getDescribedFunctionTemplate();
2541
2542 // C++ [temp.fct]p2:
2543 // A function template can be overloaded with other function templates
2544 // and with normal (non-template) functions.
2545 if ((OldTemplate == 0) != (NewTemplate == 0))
2546 return false;
2547
2548 // Is the function New an overload of the function Old?
2549 QualType OldQType = CGM.getContext().getCanonicalType(Old->getType());
2550 QualType NewQType = CGM.getContext().getCanonicalType(New->getType());
2551
2552 // Compare the signatures (C++ 1.3.10) of the two functions to
2553 // determine whether they are overloads. If we find any mismatch
2554 // in the signature, they are overloads.
2555
2556 // If either of these functions is a K&R-style function (no
2557 // prototype), then we consider them to have matching signatures.
2558 if (isa<FunctionNoProtoType>(OldQType.getTypePtr()) ||
2559 isa<FunctionNoProtoType>(NewQType.getTypePtr()))
2560 return true;
2561
2562 FunctionProtoType* OldType = cast<FunctionProtoType>(OldQType);
2563 FunctionProtoType* NewType = cast<FunctionProtoType>(NewQType);
2564
2565 // The signature of a function includes the types of its
2566 // parameters (C++ 1.3.10), which includes the presence or absence
2567 // of the ellipsis; see C++ DR 357).
2568 if (OldQType != NewQType &&
2569 (OldType->getNumArgs() != NewType->getNumArgs() ||
2570 OldType->isVariadic() != NewType->isVariadic() ||
2571 !std::equal(OldType->arg_type_begin(), OldType->arg_type_end(),
2572 NewType->arg_type_begin())))
2573 return false;
2574
2575#if 0
2576 // C++ [temp.over.link]p4:
2577 // The signature of a function template consists of its function
2578 // signature, its return type and its template parameter list. The names
2579 // of the template parameters are significant only for establishing the
2580 // relationship between the template parameters and the rest of the
2581 // signature.
2582 //
2583 // We check the return type and template parameter lists for function
2584 // templates first; the remaining checks follow.
2585 if (NewTemplate &&
2586 (!TemplateParameterListsAreEqual(NewTemplate->getTemplateParameters(),
2587 OldTemplate->getTemplateParameters(),
2588 TPL_TemplateMatch) ||
2589 OldType->getResultType() != NewType->getResultType()))
2590 return false;
2591#endif
2592
2593 // If the function is a class member, its signature includes the
2594 // cv-qualifiers (if any) on the function itself.
2595 //
2596 // As part of this, also check whether one of the member functions
2597 // is static, in which case they are not overloads (C++
2598 // 13.1p2). While not part of the definition of the signature,
2599 // this check is important to determine whether these functions
2600 // can be overloaded.
2601 const CXXMethodDecl* OldMethod = dyn_cast<CXXMethodDecl>(Old);
2602 const CXXMethodDecl* NewMethod = dyn_cast<CXXMethodDecl>(New);
2603 if (OldMethod && NewMethod &&
2604 !OldMethod->isStatic() && !NewMethod->isStatic() &&
2605 OldMethod->getTypeQualifiers() != NewMethod->getTypeQualifiers())
2606 return false;
2607
2608 // The signatures match; this is not an overload.
2609 return true;
2610 }
2611
2612 typedef llvm::DenseMap<const CXXMethodDecl *, const CXXMethodDecl*>
2613 ForwardUnique_t;
2614 ForwardUnique_t ForwardUnique;
2615 llvm::DenseMap<const CXXMethodDecl*, const CXXMethodDecl*> UniqueOverrider;
2616
2617 void BuildUniqueOverrider(const CXXMethodDecl *U, const CXXMethodDecl *MD) {
2618 const CXXMethodDecl *PrevU = UniqueOverrider[MD];
2619 assert(U && "no unique overrider");
2620 if (PrevU == U)
2621 return;
2622 if (PrevU != U && PrevU != 0) {
2623 // If already set, note the two sets as the same
2624 if (0)
2625 printf("%s::%s same as %s::%s\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002626 PrevU->getParent()->getNameAsString().c_str(),
2627 PrevU->getNameAsString().c_str(),
2628 U->getParent()->getNameAsString().c_str(),
2629 U->getNameAsString().c_str());
Mike Stump90181eb2010-01-26 00:05:04 +00002630 ForwardUnique[PrevU] = U;
2631 return;
2632 }
2633
2634 // Not set, set it now
2635 if (0)
2636 printf("marking %s::%s %p override as %s::%s\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002637 MD->getParent()->getNameAsString().c_str(),
2638 MD->getNameAsString().c_str(),
Mike Stump90181eb2010-01-26 00:05:04 +00002639 (void*)MD,
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002640 U->getParent()->getNameAsString().c_str(),
2641 U->getNameAsString().c_str());
Mike Stump90181eb2010-01-26 00:05:04 +00002642 UniqueOverrider[MD] = U;
2643
2644 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
2645 me = MD->end_overridden_methods(); mi != me; ++mi) {
2646 BuildUniqueOverrider(U, *mi);
2647 }
2648 }
2649
2650 void BuildUniqueOverriders(const CXXRecordDecl *RD) {
2651 if (0) printf("walking %s\n", RD->getNameAsCString());
2652 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2653 e = RD->method_end(); i != e; ++i) {
2654 const CXXMethodDecl *MD = *i;
2655 if (!MD->isVirtual())
2656 continue;
2657
2658 if (UniqueOverrider[MD] == 0) {
2659 // Only set this, if it hasn't been set yet.
2660 BuildUniqueOverrider(MD, MD);
2661 if (0)
2662 printf("top set is %s::%s %p\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002663 MD->getParent()->getNameAsString().c_str(),
2664 MD->getNameAsString().c_str(),
Mike Stump90181eb2010-01-26 00:05:04 +00002665 (void*)MD);
2666 ForwardUnique[MD] = MD;
2667 }
2668 }
2669 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2670 e = RD->bases_end(); i != e; ++i) {
2671 const CXXRecordDecl *Base =
2672 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2673 BuildUniqueOverriders(Base);
2674 }
2675 }
2676
2677 static int DclCmp(const void *p1, const void *p2) {
John McCallef3057c2010-02-13 01:04:05 +00002678 const CXXMethodDecl *MD1 = *(const CXXMethodDecl *const *)p1;
2679 const CXXMethodDecl *MD2 = *(const CXXMethodDecl *const *)p2;
2680
2681 return (DeclarationName::compare(MD1->getDeclName(), MD2->getDeclName()));
Mike Stump90181eb2010-01-26 00:05:04 +00002682 }
2683
2684 void MergeForwarding() {
2685 typedef llvm::SmallVector<const CXXMethodDecl *, 100> A_t;
2686 A_t A;
2687 for (ForwardUnique_t::iterator I = ForwardUnique.begin(),
2688 E = ForwardUnique.end(); I != E; ++I) {
2689 if (I->first == I->second)
2690 // Only add the roots of all trees
2691 A.push_back(I->first);
2692 }
2693 llvm::array_pod_sort(A.begin(), A.end(), DclCmp);
2694 for (A_t::iterator I = A.begin(),
2695 E = A.end(); I != E; ++I) {
2696 A_t::iterator J = I;
John McCallef3057c2010-02-13 01:04:05 +00002697 while (++J != E && DclCmp(I, J) == 0)
Mike Stump90181eb2010-01-26 00:05:04 +00002698 if (DclIsSame(*I, *J)) {
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002699 if (0) printf("connecting %s\n", (*I)->getNameAsString().c_str());
Mike Stump90181eb2010-01-26 00:05:04 +00002700 ForwardUnique[*J] = *I;
2701 }
2702 }
2703 }
2704
2705 const CXXMethodDecl *getUnique(const CXXMethodDecl *MD) {
2706 const CXXMethodDecl *U = UniqueOverrider[MD];
2707 assert(U && "unique overrider not found");
2708 while (ForwardUnique.count(U)) {
2709 const CXXMethodDecl *NU = ForwardUnique[U];
2710 if (NU == U) break;
2711 U = NU;
2712 }
2713 return U;
2714 }
Anders Carlsson72281172010-01-26 17:36:47 +00002715
2716 GlobalDecl getUnique(GlobalDecl GD) {
2717 const CXXMethodDecl *Unique = getUnique(cast<CXXMethodDecl>(GD.getDecl()));
2718
2719 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(Unique))
2720 return GlobalDecl(CD, GD.getCtorType());
2721
2722 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(Unique))
2723 return GlobalDecl(DD, GD.getDtorType());
2724
2725 return Unique;
Mike Stump90181eb2010-01-26 00:05:04 +00002726 }
2727
Anders Carlsson323bb042009-11-26 19:54:33 +00002728 /// getPureVirtualFn - Return the __cxa_pure_virtual function.
2729 llvm::Constant* getPureVirtualFn() {
2730 if (!PureVirtualFn) {
2731 const llvm::FunctionType *Ty =
2732 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext),
2733 /*isVarArg=*/false);
2734 PureVirtualFn = wrap(CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual"));
2735 }
2736
2737 return PureVirtualFn;
2738 }
2739
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002740public:
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002741 OldVtableBuilder(const CXXRecordDecl *MostDerivedClass,
Eli Friedman6c08ce72009-12-05 01:05:03 +00002742 const CXXRecordDecl *l, uint64_t lo, CodeGenModule &cgm,
Anders Carlsson0534b022010-03-25 00:35:49 +00002743 bool build, AddressPointsMapTy& AddressPoints)
Eli Friedman6c08ce72009-12-05 01:05:03 +00002744 : BuildVtable(build), MostDerivedClass(MostDerivedClass), LayoutClass(l),
2745 LayoutOffset(lo), BLayout(cgm.getContext().getASTRecordLayout(l)),
2746 rtti(0), VMContext(cgm.getModule().getContext()),CGM(cgm),
2747 PureVirtualFn(0),
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002748 subAddressPoints(AllocAddressPoint(cgm, l, MostDerivedClass)),
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002749 AddressPoints(AddressPoints),
2750 LLVMPointerWidth(cgm.getContext().Target.getPointerWidth(0))
2751 {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002752 Ptr8Ty = llvm::PointerType::get(llvm::Type::getInt8Ty(VMContext), 0);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002753 if (BuildVtable) {
2754 QualType ClassType = CGM.getContext().getTagDeclType(MostDerivedClass);
2755 rtti = CGM.GetAddrOfRTTIDescriptor(ClassType);
2756 }
Mike Stump90181eb2010-01-26 00:05:04 +00002757 BuildUniqueOverriders(MostDerivedClass);
2758 MergeForwarding();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002759 }
2760
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002761 // getVtableComponents - Returns a reference to the vtable components.
2762 const VtableComponentsVectorTy &getVtableComponents() const {
2763 return VtableComponents;
Anders Carlsson472404f2009-12-04 16:19:30 +00002764 }
2765
Anders Carlssone36a6b32010-01-02 01:01:18 +00002766 llvm::DenseMap<const CXXRecordDecl *, uint64_t> &getVBIndex()
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002767 { return VBIndex; }
2768
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002769 SavedAdjustmentsVectorTy &getSavedAdjustments()
2770 { return SavedAdjustments; }
Eli Friedman8174f2c2009-12-06 22:01:30 +00002771
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002772 llvm::Constant *wrap(Index_t i) {
2773 llvm::Constant *m;
2774 m = llvm::ConstantInt::get(llvm::Type::getInt64Ty(VMContext), i);
2775 return llvm::ConstantExpr::getIntToPtr(m, Ptr8Ty);
2776 }
2777
2778 llvm::Constant *wrap(llvm::Constant *m) {
2779 return llvm::ConstantExpr::getBitCast(m, Ptr8Ty);
2780 }
2781
Mike Stumpd2808442010-01-22 02:51:26 +00002782//#define D1(x)
Douglas Gregorf4f2e022010-02-22 16:48:26 +00002783#define D1(X) do { if (getenv("CLANG_VTABLE_DEBUG")) { X; } } while (0)
Mike Stump75ce5732009-10-31 20:06:59 +00002784
2785 void GenerateVBaseOffsets(const CXXRecordDecl *RD, uint64_t Offset,
Mike Stump28431212009-10-13 22:54:56 +00002786 bool updateVBIndex, Index_t current_vbindex) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002787 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2788 e = RD->bases_end(); i != e; ++i) {
2789 const CXXRecordDecl *Base =
2790 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump28431212009-10-13 22:54:56 +00002791 Index_t next_vbindex = current_vbindex;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002792 if (i->isVirtual() && !SeenVBase.count(Base)) {
2793 SeenVBase.insert(Base);
Mike Stump28431212009-10-13 22:54:56 +00002794 if (updateVBIndex) {
Mike Stump75ce5732009-10-31 20:06:59 +00002795 next_vbindex = (ssize_t)(-(VCalls.size()*LLVMPointerWidth/8)
Mike Stump28431212009-10-13 22:54:56 +00002796 - 3*LLVMPointerWidth/8);
2797 VBIndex[Base] = next_vbindex;
2798 }
Mike Stump75ce5732009-10-31 20:06:59 +00002799 int64_t BaseOffset = -(Offset/8) + BLayout.getVBaseClassOffset(Base)/8;
2800 VCalls.push_back((0?700:0) + BaseOffset);
2801 D1(printf(" vbase for %s at %d delta %d most derived %s\n",
2802 Base->getNameAsCString(),
2803 (int)-VCalls.size()-3, (int)BaseOffset,
Mike Stumpd2808442010-01-22 02:51:26 +00002804 MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002805 }
Mike Stump28431212009-10-13 22:54:56 +00002806 // We also record offsets for non-virtual bases to closest enclosing
2807 // virtual base. We do this so that we don't have to search
2808 // for the nearst virtual base class when generating thunks.
2809 if (updateVBIndex && VBIndex.count(Base) == 0)
2810 VBIndex[Base] = next_vbindex;
Mike Stump75ce5732009-10-31 20:06:59 +00002811 GenerateVBaseOffsets(Base, Offset, updateVBIndex, next_vbindex);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002812 }
2813 }
2814
2815 void StartNewTable() {
2816 SeenVBase.clear();
2817 }
2818
Mike Stump8bccbfd2009-10-15 09:30:16 +00002819 Index_t getNVOffset_1(const CXXRecordDecl *D, const CXXRecordDecl *B,
2820 Index_t Offset = 0) {
2821
2822 if (B == D)
2823 return Offset;
2824
2825 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(D);
2826 for (CXXRecordDecl::base_class_const_iterator i = D->bases_begin(),
2827 e = D->bases_end(); i != e; ++i) {
2828 const CXXRecordDecl *Base =
2829 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2830 int64_t BaseOffset = 0;
2831 if (!i->isVirtual())
2832 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
2833 int64_t o = getNVOffset_1(Base, B, BaseOffset);
2834 if (o >= 0)
2835 return o;
2836 }
2837
2838 return -1;
2839 }
2840
2841 /// getNVOffset - Returns the non-virtual offset for the given (B) base of the
2842 /// derived class D.
2843 Index_t getNVOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00002844 qD = qD->getPointeeType();
2845 qB = qB->getPointeeType();
Mike Stump8bccbfd2009-10-15 09:30:16 +00002846 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
2847 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
2848 int64_t o = getNVOffset_1(D, B);
2849 if (o >= 0)
2850 return o;
2851
2852 assert(false && "FIXME: non-virtual base not found");
2853 return 0;
2854 }
2855
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002856 /// getVbaseOffset - Returns the index into the vtable for the virtual base
2857 /// offset for the given (B) virtual base of the derived class D.
2858 Index_t getVbaseOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00002859 qD = qD->getPointeeType();
2860 qB = qB->getPointeeType();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002861 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
2862 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002863 if (D != MostDerivedClass)
Anders Carlssona864caf2010-03-23 04:11:45 +00002864 return CGM.getVTables().getVirtualBaseOffsetOffset(D, B);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002865 llvm::DenseMap<const CXXRecordDecl *, Index_t>::iterator i;
2866 i = VBIndex.find(B);
2867 if (i != VBIndex.end())
2868 return i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002869
Mike Stump28431212009-10-13 22:54:56 +00002870 assert(false && "FIXME: Base not found");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002871 return 0;
2872 }
2873
Eli Friedman81fb0d22009-12-04 08:40:51 +00002874 bool OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
2875 Index_t OverrideOffset, Index_t Offset,
2876 int64_t CurrentVBaseOffset);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002877
Anders Carlsson495634e2009-12-04 02:39:04 +00002878 /// AppendMethods - Append the current methods to the vtable.
Anders Carlssonddf42c82009-12-04 02:56:03 +00002879 void AppendMethodsToVtable();
Anders Carlsson495634e2009-12-04 02:39:04 +00002880
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002881 llvm::Constant *WrapAddrOf(GlobalDecl GD) {
2882 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2883
Anders Carlsson64457732009-11-24 05:08:52 +00002884 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVtable(MD);
Mike Stump18e8b472009-10-27 23:36:26 +00002885
Mike Stumpcdeb8002009-12-03 16:55:20 +00002886 return wrap(CGM.GetAddrOfFunction(GD, Ty));
Mike Stump18e8b472009-10-27 23:36:26 +00002887 }
2888
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002889 void OverrideMethods(Path_t *Path, bool MorallyVirtual, int64_t Offset,
2890 int64_t CurrentVBaseOffset) {
Mike Stump37dbe962009-10-15 02:04:03 +00002891 for (Path_t::reverse_iterator i = Path->rbegin(),
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002892 e = Path->rend(); i != e; ++i) {
2893 const CXXRecordDecl *RD = i->first;
Mike Stump8bccbfd2009-10-15 09:30:16 +00002894 int64_t OverrideOffset = i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002895 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
2896 ++mi) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002897 const CXXMethodDecl *MD = *mi;
2898
2899 if (!MD->isVirtual())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002900 continue;
2901
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002902 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2903 // Override both the complete and the deleting destructor.
2904 GlobalDecl CompDtor(DD, Dtor_Complete);
Eli Friedman81fb0d22009-12-04 08:40:51 +00002905 OverrideMethod(CompDtor, MorallyVirtual, OverrideOffset, Offset,
2906 CurrentVBaseOffset);
2907
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002908 GlobalDecl DeletingDtor(DD, Dtor_Deleting);
Eli Friedman81fb0d22009-12-04 08:40:51 +00002909 OverrideMethod(DeletingDtor, MorallyVirtual, OverrideOffset, Offset,
2910 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002911 } else {
Eli Friedman81fb0d22009-12-04 08:40:51 +00002912 OverrideMethod(MD, MorallyVirtual, OverrideOffset, Offset,
2913 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002914 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002915 }
2916 }
2917 }
2918
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002919 void AddMethod(const GlobalDecl GD, bool MorallyVirtual, Index_t Offset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002920 int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002921 // If we can find a previously allocated slot for this, reuse it.
Eli Friedman81fb0d22009-12-04 08:40:51 +00002922 if (OverrideMethod(GD, MorallyVirtual, Offset, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002923 CurrentVBaseOffset))
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002924 return;
2925
Mike Stump1f49d652010-01-22 18:48:47 +00002926 D1(printf(" vfn for %s at %d\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002927 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsString().c_str(),
Mike Stump1f49d652010-01-22 18:48:47 +00002928 (int)Methods.size()));
2929
Anders Carlssoncdf18982009-12-04 02:08:24 +00002930 // We didn't find an entry in the vtable that we could use, add a new
2931 // entry.
2932 Methods.AddMethod(GD);
2933
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002934 VCallOffset[GD] = Offset/8 - CurrentVBaseOffset/8;
2935
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002936 if (MorallyVirtual) {
Anders Carlsson72281172010-01-26 17:36:47 +00002937 GlobalDecl UGD = getUnique(GD);
2938 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
2939
Mike Stump90181eb2010-01-26 00:05:04 +00002940 assert(UMD && "final overrider not found");
2941
2942 Index_t &idx = VCall[UMD];
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002943 // Allocate the first one, after that, we reuse the previous one.
2944 if (idx == 0) {
Anders Carlsson72281172010-01-26 17:36:47 +00002945 VCallOffsetForVCall[UGD] = Offset/8;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002946 NonVirtualOffset[UMD] = Offset/8 - CurrentVBaseOffset/8;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002947 idx = VCalls.size()+1;
Mike Stump90181eb2010-01-26 00:05:04 +00002948 VCalls.push_back(Offset/8 - CurrentVBaseOffset/8);
Mike Stump75ce5732009-10-31 20:06:59 +00002949 D1(printf(" vcall for %s at %d with delta %d\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002950 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsString().c_str(),
Mike Stump90181eb2010-01-26 00:05:04 +00002951 (int)-VCalls.size()-3, (int)VCalls[idx-1]));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002952 }
2953 }
2954 }
2955
2956 void AddMethods(const CXXRecordDecl *RD, bool MorallyVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002957 Index_t Offset, int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002958 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002959 ++mi) {
2960 const CXXMethodDecl *MD = *mi;
2961 if (!MD->isVirtual())
2962 continue;
2963
2964 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2965 // For destructors, add both the complete and the deleting destructor
2966 // to the vtable.
2967 AddMethod(GlobalDecl(DD, Dtor_Complete), MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002968 CurrentVBaseOffset);
Eli Friedman03aa2f12009-11-30 01:19:33 +00002969 AddMethod(GlobalDecl(DD, Dtor_Deleting), MorallyVirtual, Offset,
2970 CurrentVBaseOffset);
2971 } else
2972 AddMethod(MD, MorallyVirtual, Offset, CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002973 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002974 }
2975
2976 void NonVirtualBases(const CXXRecordDecl *RD, const ASTRecordLayout &Layout,
2977 const CXXRecordDecl *PrimaryBase,
2978 bool PrimaryBaseWasVirtual, bool MorallyVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002979 int64_t Offset, int64_t CurrentVBaseOffset,
2980 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00002981 Path->push_back(std::make_pair(RD, Offset));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002982 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2983 e = RD->bases_end(); i != e; ++i) {
2984 if (i->isVirtual())
2985 continue;
2986 const CXXRecordDecl *Base =
2987 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump9eb76d42010-01-22 06:45:05 +00002988 uint64_t o = Offset + Layout.getBaseClassOffset(Base);
2989 StartNewTable();
2990 GenerateVtableForBase(Base, o, MorallyVirtual, false,
2991 true, Base == PrimaryBase && !PrimaryBaseWasVirtual,
2992 CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002993 }
Mike Stump37dbe962009-10-15 02:04:03 +00002994 Path->pop_back();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002995 }
2996
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002997// #define D(X) do { X; } while (0)
2998#define D(X)
2999
3000 void insertVCalls(int InsertionPoint) {
Mike Stump75ce5732009-10-31 20:06:59 +00003001 D1(printf("============= combining vbase/vcall\n"));
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003002 D(VCalls.insert(VCalls.begin(), 673));
3003 D(VCalls.push_back(672));
Eli Friedman6c08ce72009-12-05 01:05:03 +00003004
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003005 VtableComponents.insert(VtableComponents.begin() + InsertionPoint,
3006 VCalls.size(), 0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00003007 if (BuildVtable) {
3008 // The vcalls come first...
3009 for (std::vector<Index_t>::reverse_iterator i = VCalls.rbegin(),
3010 e = VCalls.rend();
3011 i != e; ++i)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003012 VtableComponents[InsertionPoint++] = wrap((0?600:0) + *i);
Eli Friedman6c08ce72009-12-05 01:05:03 +00003013 }
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003014 VCalls.clear();
Mike Stump9f23a142009-11-10 02:30:51 +00003015 VCall.clear();
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003016 VCallOffsetForVCall.clear();
3017 VCallOffset.clear();
3018 NonVirtualOffset.clear();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003019 }
3020
Mike Stump559387f2009-11-13 23:13:20 +00003021 void AddAddressPoints(const CXXRecordDecl *RD, uint64_t Offset,
3022 Index_t AddressPoint) {
3023 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003024 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00003025 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00003026 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003027 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00003028
3029 // Now also add the address point for all our primary bases.
3030 while (1) {
3031 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3032 RD = Layout.getPrimaryBase();
3033 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
3034 // FIXME: Double check this.
3035 if (RD == 0)
3036 break;
3037 if (PrimaryBaseWasVirtual &&
3038 BLayout.getVBaseClassOffset(RD) != Offset)
3039 break;
3040 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003041 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00003042 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00003043 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003044 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00003045 }
3046 }
3047
3048
Mike Stumpd538a6d2009-12-24 07:29:41 +00003049 void FinishGenerateVtable(const CXXRecordDecl *RD,
3050 const ASTRecordLayout &Layout,
3051 const CXXRecordDecl *PrimaryBase,
Mike Stump9eb76d42010-01-22 06:45:05 +00003052 bool ForNPNVBases, bool WasPrimaryBase,
Mike Stumpd538a6d2009-12-24 07:29:41 +00003053 bool PrimaryBaseWasVirtual,
3054 bool MorallyVirtual, int64_t Offset,
3055 bool ForVirtualBase, int64_t CurrentVBaseOffset,
3056 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00003057 bool alloc = false;
3058 if (Path == 0) {
3059 alloc = true;
3060 Path = new Path_t;
3061 }
3062
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003063 StartNewTable();
3064 extra = 0;
Mike Stump9eb76d42010-01-22 06:45:05 +00003065 Index_t AddressPoint = 0;
3066 int VCallInsertionPoint = 0;
3067 if (!ForNPNVBases || !WasPrimaryBase) {
3068 bool DeferVCalls = MorallyVirtual || ForVirtualBase;
3069 VCallInsertionPoint = VtableComponents.size();
3070 if (!DeferVCalls) {
3071 insertVCalls(VCallInsertionPoint);
3072 } else
3073 // FIXME: just for extra, or for all uses of VCalls.size post this?
3074 extra = -VCalls.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003075
Mike Stump9eb76d42010-01-22 06:45:05 +00003076 // Add the offset to top.
3077 VtableComponents.push_back(BuildVtable ? wrap(-((Offset-LayoutOffset)/8)) : 0);
Anders Carlsson472404f2009-12-04 16:19:30 +00003078
Mike Stump9eb76d42010-01-22 06:45:05 +00003079 // Add the RTTI information.
3080 VtableComponents.push_back(rtti);
Anders Carlsson472404f2009-12-04 16:19:30 +00003081
Mike Stump9eb76d42010-01-22 06:45:05 +00003082 AddressPoint = VtableComponents.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003083
Mike Stump9eb76d42010-01-22 06:45:05 +00003084 AppendMethodsToVtable();
3085 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003086
3087 // and then the non-virtual bases.
3088 NonVirtualBases(RD, Layout, PrimaryBase, PrimaryBaseWasVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003089 MorallyVirtual, Offset, CurrentVBaseOffset, Path);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003090
3091 if (ForVirtualBase) {
Mike Stump2cefe382009-11-12 20:47:57 +00003092 // FIXME: We're adding to VCalls in callers, we need to do the overrides
3093 // in the inner part, so that we know the complete set of vcalls during
3094 // the build and don't have to insert into methods. Saving out the
3095 // AddressPoint here, would need to be fixed, if we didn't do that. Also
3096 // retroactively adding vcalls for overrides later wind up in the wrong
3097 // place, the vcall slot has to be alloted during the walk of the base
3098 // when the function is first introduces.
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003099 AddressPoint += VCalls.size();
Mike Stump2cefe382009-11-12 20:47:57 +00003100 insertVCalls(VCallInsertionPoint);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003101 }
3102
Mike Stump9eb76d42010-01-22 06:45:05 +00003103 if (!ForNPNVBases || !WasPrimaryBase)
3104 AddAddressPoints(RD, Offset, AddressPoint);
Mike Stump2cefe382009-11-12 20:47:57 +00003105
Mike Stump37dbe962009-10-15 02:04:03 +00003106 if (alloc) {
3107 delete Path;
3108 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003109 }
3110
Mike Stump75ce5732009-10-31 20:06:59 +00003111 void Primaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
3112 bool updateVBIndex, Index_t current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00003113 int64_t CurrentVBaseOffset) {
Mike Stump75ce5732009-10-31 20:06:59 +00003114 if (!RD->isDynamicClass())
3115 return;
3116
3117 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3118 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3119 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
3120
3121 // vtables are composed from the chain of primaries.
Eli Friedman65d87222009-12-04 08:52:11 +00003122 if (PrimaryBase && !PrimaryBaseWasVirtual) {
Mike Stump75ce5732009-10-31 20:06:59 +00003123 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003124 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Eli Friedman65d87222009-12-04 08:52:11 +00003125 Primaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
3126 updateVBIndex, current_vbindex, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00003127 }
3128
3129 D1(printf(" doing vcall entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003130 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00003131
3132 // And add the virtuals for the class to the primary vtable.
Eli Friedman03aa2f12009-11-30 01:19:33 +00003133 AddMethods(RD, MorallyVirtual, Offset, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00003134 }
3135
3136 void VBPrimaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
3137 bool updateVBIndex, Index_t current_vbindex,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003138 bool RDisVirtualBase, int64_t CurrentVBaseOffset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00003139 bool bottom) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003140 if (!RD->isDynamicClass())
3141 return;
3142
3143 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3144 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3145 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
3146
3147 // vtables are composed from the chain of primaries.
3148 if (PrimaryBase) {
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003149 int BaseCurrentVBaseOffset = CurrentVBaseOffset;
3150 if (PrimaryBaseWasVirtual) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003151 IndirectPrimary.insert(PrimaryBase);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003152 BaseCurrentVBaseOffset = BLayout.getVBaseClassOffset(PrimaryBase);
3153 }
Mike Stump75ce5732009-10-31 20:06:59 +00003154
3155 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003156 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00003157
3158 VBPrimaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003159 updateVBIndex, current_vbindex, PrimaryBaseWasVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00003160 BaseCurrentVBaseOffset, false);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003161 }
3162
Mike Stump75ce5732009-10-31 20:06:59 +00003163 D1(printf(" doing vbase entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003164 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00003165 GenerateVBaseOffsets(RD, Offset, updateVBIndex, current_vbindex);
3166
3167 if (RDisVirtualBase || bottom) {
3168 Primaries(RD, MorallyVirtual, Offset, updateVBIndex, current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00003169 CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00003170 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003171 }
3172
Mike Stumpd538a6d2009-12-24 07:29:41 +00003173 void GenerateVtableForBase(const CXXRecordDecl *RD, int64_t Offset = 0,
3174 bool MorallyVirtual = false,
3175 bool ForVirtualBase = false,
Mike Stump9eb76d42010-01-22 06:45:05 +00003176 bool ForNPNVBases = false,
3177 bool WasPrimaryBase = true,
Mike Stumpd538a6d2009-12-24 07:29:41 +00003178 int CurrentVBaseOffset = 0,
3179 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003180 if (!RD->isDynamicClass())
Mike Stumpd538a6d2009-12-24 07:29:41 +00003181 return;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003182
Mike Stumpfa818082009-11-13 02:35:38 +00003183 // Construction vtable don't need parts that have no virtual bases and
3184 // aren't morally virtual.
Anders Carlssonbad80eb2009-12-04 18:36:22 +00003185 if ((LayoutClass != MostDerivedClass) &&
3186 RD->getNumVBases() == 0 && !MorallyVirtual)
Mike Stumpd538a6d2009-12-24 07:29:41 +00003187 return;
Mike Stumpfa818082009-11-13 02:35:38 +00003188
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003189 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3190 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3191 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
3192
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003193 extra = 0;
Mike Stump75ce5732009-10-31 20:06:59 +00003194 D1(printf("building entries for base %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003195 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003196
Mike Stump75ce5732009-10-31 20:06:59 +00003197 if (ForVirtualBase)
3198 extra = VCalls.size();
3199
Mike Stump9eb76d42010-01-22 06:45:05 +00003200 if (!ForNPNVBases || !WasPrimaryBase) {
3201 VBPrimaries(RD, MorallyVirtual, Offset, !ForVirtualBase, 0,
3202 ForVirtualBase, CurrentVBaseOffset, true);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003203
Mike Stump9eb76d42010-01-22 06:45:05 +00003204 if (Path)
3205 OverrideMethods(Path, MorallyVirtual, Offset, CurrentVBaseOffset);
3206 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003207
Mike Stump9eb76d42010-01-22 06:45:05 +00003208 FinishGenerateVtable(RD, Layout, PrimaryBase, ForNPNVBases, WasPrimaryBase,
3209 PrimaryBaseWasVirtual, MorallyVirtual, Offset,
3210 ForVirtualBase, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003211 }
3212
3213 void GenerateVtableForVBases(const CXXRecordDecl *RD,
3214 int64_t Offset = 0,
Mike Stump37dbe962009-10-15 02:04:03 +00003215 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003216 bool alloc = false;
3217 if (Path == 0) {
3218 alloc = true;
Mike Stump37dbe962009-10-15 02:04:03 +00003219 Path = new Path_t;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003220 }
3221 // FIXME: We also need to override using all paths to a virtual base,
3222 // right now, we just process the first path
3223 Path->push_back(std::make_pair(RD, Offset));
3224 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
3225 e = RD->bases_end(); i != e; ++i) {
3226 const CXXRecordDecl *Base =
3227 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
3228 if (i->isVirtual() && !IndirectPrimary.count(Base)) {
3229 // Mark it so we don't output it twice.
3230 IndirectPrimary.insert(Base);
3231 StartNewTable();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00003232 VCall.clear();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003233 int64_t BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00003234 int64_t CurrentVBaseOffset = BaseOffset;
Mike Stump75ce5732009-10-31 20:06:59 +00003235 D1(printf("vtable %s virtual base %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00003236 MostDerivedClass->getNameAsCString(), Base->getNameAsCString()));
Mike Stump9eb76d42010-01-22 06:45:05 +00003237 GenerateVtableForBase(Base, BaseOffset, true, true, false,
3238 true, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003239 }
Mike Stump2cefe382009-11-12 20:47:57 +00003240 int64_t BaseOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003241 if (i->isVirtual())
3242 BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stump2cefe382009-11-12 20:47:57 +00003243 else {
3244 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3245 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
3246 }
3247
Mike Stump37dbe962009-10-15 02:04:03 +00003248 if (Base->getNumVBases()) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003249 GenerateVtableForVBases(Base, BaseOffset, Path);
Mike Stump37dbe962009-10-15 02:04:03 +00003250 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003251 }
3252 Path->pop_back();
3253 if (alloc)
3254 delete Path;
3255 }
3256};
Anders Carlssonca1bf682009-12-03 01:54:02 +00003257} // end anonymous namespace
3258
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003259bool OldVtableBuilder::OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
Eli Friedman81fb0d22009-12-04 08:40:51 +00003260 Index_t OverrideOffset, Index_t Offset,
3261 int64_t CurrentVBaseOffset) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00003262 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
3263
3264 const bool isPure = MD->isPure();
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00003265
Anders Carlssonca1bf682009-12-03 01:54:02 +00003266 // FIXME: Should OverrideOffset's be Offset?
3267
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00003268 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
3269 e = MD->end_overridden_methods(); mi != e; ++mi) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00003270 GlobalDecl OGD;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003271 GlobalDecl OGD2;
Anders Carlssonca1bf682009-12-03 01:54:02 +00003272
Anders Carlssonf3935b42009-12-04 05:51:56 +00003273 const CXXMethodDecl *OMD = *mi;
Anders Carlssonca1bf682009-12-03 01:54:02 +00003274 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(OMD))
3275 OGD = GlobalDecl(DD, GD.getDtorType());
3276 else
3277 OGD = OMD;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003278
Eli Friedman8174f2c2009-12-06 22:01:30 +00003279 // Check whether this is the method being overridden in this section of
3280 // the vtable.
Anders Carlsson7bb70762009-12-04 15:49:02 +00003281 uint64_t Index;
3282 if (!Methods.getIndex(OGD, Index))
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003283 continue;
3284
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003285 OGD2 = OGD;
3286
Eli Friedman8174f2c2009-12-06 22:01:30 +00003287 // Get the original method, which we should be computing thunks, etc,
3288 // against.
3289 OGD = Methods.getOrigMethod(Index);
3290 OMD = cast<CXXMethodDecl>(OGD.getDecl());
3291
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003292 QualType ReturnType =
3293 MD->getType()->getAs<FunctionType>()->getResultType();
3294 QualType OverriddenReturnType =
3295 OMD->getType()->getAs<FunctionType>()->getResultType();
Anders Carlssonca1bf682009-12-03 01:54:02 +00003296
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003297 // Check if we need a return type adjustment.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00003298 if (!ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
3299 OMD).isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003300 CanQualType &BaseReturnType = BaseReturnTypes[Index];
Anders Carlssonca1bf682009-12-03 01:54:02 +00003301
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003302 // Insert the base return type.
3303 if (BaseReturnType.isNull())
3304 BaseReturnType =
3305 CGM.getContext().getCanonicalType(OverriddenReturnType);
3306 }
Anders Carlssona93e9802009-12-04 03:52:52 +00003307
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003308 Methods.OverrideMethod(OGD, GD);
3309
Anders Carlsson72281172010-01-26 17:36:47 +00003310 GlobalDecl UGD = getUnique(GD);
3311 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
3312 assert(UGD.getDecl() && "unique overrider not found");
3313 assert(UGD == getUnique(OGD) && "unique overrider not unique");
Mike Stump90181eb2010-01-26 00:05:04 +00003314
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003315 ThisAdjustments.erase(Index);
Mike Stump90181eb2010-01-26 00:05:04 +00003316 if (MorallyVirtual || VCall.count(UMD)) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003317
Mike Stump90181eb2010-01-26 00:05:04 +00003318 Index_t &idx = VCall[UMD];
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003319 if (idx == 0) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003320 VCallOffset[GD] = VCallOffset[OGD];
3321 // NonVirtualOffset[UMD] = CurrentVBaseOffset/8 - OverrideOffset/8;
3322 NonVirtualOffset[UMD] = VCallOffset[OGD];
Mike Stump77537b12010-01-26 03:42:22 +00003323 VCallOffsetForVCall[UMD] = OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003324 idx = VCalls.size()+1;
Mike Stump77537b12010-01-26 03:42:22 +00003325 VCalls.push_back(OverrideOffset/8 - CurrentVBaseOffset/8);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003326 D1(printf(" vcall for %s at %d with delta %d most derived %s\n",
3327 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00003328 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003329 } else {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003330 VCallOffset[GD] = NonVirtualOffset[UMD];
Anders Carlsson72281172010-01-26 17:36:47 +00003331 VCalls[idx-1] = -VCallOffsetForVCall[UGD] + OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003332 D1(printf(" vcall patch for %s at %d with delta %d most derived %s\n",
3333 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00003334 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003335 }
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003336 int64_t NonVirtualAdjustment = -VCallOffset[OGD];
Mike Stumpded0a402010-01-26 22:44:01 +00003337 QualType DerivedType = MD->getThisType(CGM.getContext());
3338 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
3339 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
3340 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
3341 NonVirtualAdjustment = NonVirtualAdjustment2;
3342 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003343 int64_t VirtualAdjustment =
3344 -((idx + extra + 2) * LLVMPointerWidth / 8);
Anders Carlsson657f1392009-12-03 02:32:59 +00003345
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003346 // Optimize out virtual adjustments of 0.
3347 if (VCalls[idx-1] == 0)
3348 VirtualAdjustment = 0;
Anders Carlsson657f1392009-12-03 02:32:59 +00003349
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003350 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment,
3351 VirtualAdjustment);
Anders Carlsson2ca285f2009-12-03 02:22:59 +00003352
Eli Friedman8174f2c2009-12-06 22:01:30 +00003353 if (!isPure && !ThisAdjustment.isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003354 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003355 SavedAdjustments.push_back(
3356 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedman8174f2c2009-12-06 22:01:30 +00003357 }
Anders Carlssonca1bf682009-12-03 01:54:02 +00003358 return true;
3359 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003360
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003361 VCallOffset[GD] = VCallOffset[OGD2] - OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003362
Mike Stumpa04ecfb2010-01-26 21:35:27 +00003363 int64_t NonVirtualAdjustment = -VCallOffset[GD];
3364 QualType DerivedType = MD->getThisType(CGM.getContext());
3365 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
3366 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
3367 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
3368 NonVirtualAdjustment = NonVirtualAdjustment2;
3369 }
3370
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003371 if (NonVirtualAdjustment) {
3372 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment, 0);
3373
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00003374 if (!isPure) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003375 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003376 SavedAdjustments.push_back(
3377 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00003378 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00003379 }
3380 return true;
Anders Carlssonca1bf682009-12-03 01:54:02 +00003381 }
3382
3383 return false;
Anders Carlssond59885022009-11-27 22:21:51 +00003384}
3385
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003386void OldVtableBuilder::AppendMethodsToVtable() {
Eli Friedman6c08ce72009-12-05 01:05:03 +00003387 if (!BuildVtable) {
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003388 VtableComponents.insert(VtableComponents.end(), Methods.size(),
3389 (llvm::Constant *)0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00003390 ThisAdjustments.clear();
3391 BaseReturnTypes.clear();
3392 Methods.clear();
3393 return;
3394 }
3395
Anders Carlsson472404f2009-12-04 16:19:30 +00003396 // Reserve room in the vtable for our new methods.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003397 VtableComponents.reserve(VtableComponents.size() + Methods.size());
Anders Carlssonb07567c2009-12-04 03:07:26 +00003398
Anders Carlsson86809cd2009-12-04 02:43:50 +00003399 for (unsigned i = 0, e = Methods.size(); i != e; ++i) {
3400 GlobalDecl GD = Methods[i];
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003401 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
3402
3403 // Get the 'this' pointer adjustment.
Anders Carlsson86809cd2009-12-04 02:43:50 +00003404 ThunkAdjustment ThisAdjustment = ThisAdjustments.lookup(i);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003405
3406 // Construct the return type adjustment.
3407 ThunkAdjustment ReturnAdjustment;
3408
3409 QualType BaseReturnType = BaseReturnTypes.lookup(i);
3410 if (!BaseReturnType.isNull() && !MD->isPure()) {
3411 QualType DerivedType =
3412 MD->getType()->getAs<FunctionType>()->getResultType();
3413
3414 int64_t NonVirtualAdjustment =
3415 getNVOffset(BaseReturnType, DerivedType) / 8;
3416
3417 int64_t VirtualAdjustment =
3418 getVbaseOffset(BaseReturnType, DerivedType);
3419
3420 ReturnAdjustment = ThunkAdjustment(NonVirtualAdjustment,
3421 VirtualAdjustment);
3422 }
3423
Anders Carlsson50f14742009-12-04 03:06:03 +00003424 llvm::Constant *Method = 0;
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003425 if (!ReturnAdjustment.isEmpty()) {
3426 // Build a covariant thunk.
3427 CovariantThunkAdjustment Adjustment(ThisAdjustment, ReturnAdjustment);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003428 Method = wrap(CGM.GetAddrOfCovariantThunk(GD, Adjustment));
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003429 } else if (!ThisAdjustment.isEmpty()) {
3430 // Build a "regular" thunk.
Eli Friedman8174f2c2009-12-06 22:01:30 +00003431 Method = wrap(CGM.GetAddrOfThunk(GD, ThisAdjustment));
Anders Carlssonddf42c82009-12-04 02:56:03 +00003432 } else if (MD->isPure()) {
3433 // We have a pure virtual method.
Anders Carlsson50f14742009-12-04 03:06:03 +00003434 Method = getPureVirtualFn();
3435 } else {
3436 // We have a good old regular method.
3437 Method = WrapAddrOf(GD);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003438 }
Anders Carlsson50f14742009-12-04 03:06:03 +00003439
3440 // Add the method to the vtable.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003441 VtableComponents.push_back(Method);
Anders Carlsson86809cd2009-12-04 02:43:50 +00003442 }
3443
Anders Carlsson50f14742009-12-04 03:06:03 +00003444
Anders Carlsson86809cd2009-12-04 02:43:50 +00003445 ThisAdjustments.clear();
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003446 BaseReturnTypes.clear();
Anders Carlsson86809cd2009-12-04 02:43:50 +00003447
Anders Carlsson495634e2009-12-04 02:39:04 +00003448 Methods.clear();
Anders Carlsson495634e2009-12-04 02:39:04 +00003449}
3450
Anders Carlssona864caf2010-03-23 04:11:45 +00003451void CodeGenVTables::ComputeMethodVtableIndices(const CXXRecordDecl *RD) {
Anders Carlssonf942ee02009-11-27 20:47:55 +00003452
3453 // Itanium C++ ABI 2.5.2:
Anders Carlsson259688c2010-02-02 03:37:46 +00003454 // The order of the virtual function pointers in a virtual table is the
3455 // order of declaration of the corresponding member functions in the class.
Anders Carlssonf942ee02009-11-27 20:47:55 +00003456 //
Anders Carlsson259688c2010-02-02 03:37:46 +00003457 // There is an entry for any virtual function declared in a class,
3458 // whether it is a new function or overrides a base class function,
3459 // unless it overrides a function from the primary base, and conversion
3460 // between their return types does not require an adjustment.
Anders Carlssonf942ee02009-11-27 20:47:55 +00003461
3462 int64_t CurrentIndex = 0;
3463
3464 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3465 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3466
3467 if (PrimaryBase) {
Anders Carlssonc920fa22009-11-30 19:43:26 +00003468 assert(PrimaryBase->isDefinition() &&
3469 "Should have the definition decl of the primary base!");
Anders Carlssonf942ee02009-11-27 20:47:55 +00003470
3471 // Since the record decl shares its vtable pointer with the primary base
3472 // we need to start counting at the end of the primary base's vtable.
3473 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
3474 }
Eli Friedman21517252009-12-15 03:31:17 +00003475
3476 // Collect all the primary bases, so we can check whether methods override
3477 // a method from the base.
Anders Carlssond46ed892010-02-27 16:18:19 +00003478 VtableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Eli Friedman21517252009-12-15 03:31:17 +00003479 for (ASTRecordLayout::primary_base_info_iterator
3480 I = Layout.primary_base_begin(), E = Layout.primary_base_end();
3481 I != E; ++I)
3482 PrimaryBases.insert((*I).getBase());
3483
Anders Carlssonf942ee02009-11-27 20:47:55 +00003484 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
3485
3486 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
3487 e = RD->method_end(); i != e; ++i) {
3488 const CXXMethodDecl *MD = *i;
3489
3490 // We only want virtual methods.
3491 if (!MD->isVirtual())
3492 continue;
3493
Anders Carlssonf942ee02009-11-27 20:47:55 +00003494 // Check if this method overrides a method in the primary base.
Anders Carlsson65b49782010-02-12 05:25:12 +00003495 if (const CXXMethodDecl *OverriddenMD =
Anders Carlssond2025412010-02-27 06:38:03 +00003496 OverridesMethodInBases(MD, PrimaryBases)) {
Anders Carlsson65b49782010-02-12 05:25:12 +00003497 // Check if converting from the return type of the method to the
3498 // return type of the overridden method requires conversion.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00003499 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
3500 OverriddenMD).isEmpty()) {
Anders Carlsson65b49782010-02-12 05:25:12 +00003501 // This index is shared between the index in the vtable of the primary
3502 // base class.
3503 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
3504 const CXXDestructorDecl *OverriddenDD =
3505 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00003506
Anders Carlsson65b49782010-02-12 05:25:12 +00003507 // Add both the complete and deleting entries.
3508 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] =
3509 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
3510 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] =
3511 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
3512 } else {
3513 MethodVtableIndices[MD] = getMethodVtableIndex(OverriddenMD);
3514 }
3515
3516 // We don't need to add an entry for this method.
Anders Carlsson07604812010-02-12 18:14:46 +00003517 continue;
Anders Carlssonf942ee02009-11-27 20:47:55 +00003518 }
3519 }
3520
Anders Carlssonf942ee02009-11-27 20:47:55 +00003521 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
3522 if (MD->isImplicit()) {
3523 assert(!ImplicitVirtualDtor &&
3524 "Did already see an implicit virtual dtor!");
3525 ImplicitVirtualDtor = DD;
3526 continue;
3527 }
3528
3529 // Add the complete dtor.
3530 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
3531
3532 // Add the deleting dtor.
3533 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
3534 } else {
3535 // Add the entry.
3536 MethodVtableIndices[MD] = CurrentIndex++;
3537 }
3538 }
3539
3540 if (ImplicitVirtualDtor) {
3541 // Itanium C++ ABI 2.5.2:
Anders Carlssondc2dba32010-02-16 04:49:44 +00003542 // If a class has an implicitly-defined virtual destructor,
3543 // its entries come after the declared virtual function pointers.
Anders Carlssonf942ee02009-11-27 20:47:55 +00003544
3545 // Add the complete dtor.
3546 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
3547 CurrentIndex++;
3548
3549 // Add the deleting dtor.
3550 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
3551 CurrentIndex++;
3552 }
3553
3554 NumVirtualFunctionPointers[RD] = CurrentIndex;
3555}
3556
Anders Carlssona864caf2010-03-23 04:11:45 +00003557uint64_t CodeGenVTables::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
Anders Carlssonf942ee02009-11-27 20:47:55 +00003558 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
3559 NumVirtualFunctionPointers.find(RD);
3560 if (I != NumVirtualFunctionPointers.end())
3561 return I->second;
3562
3563 ComputeMethodVtableIndices(RD);
3564
3565 I = NumVirtualFunctionPointers.find(RD);
3566 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
3567 return I->second;
3568}
3569
Anders Carlssona864caf2010-03-23 04:11:45 +00003570uint64_t CodeGenVTables::getMethodVtableIndex(GlobalDecl GD) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00003571 MethodVtableIndicesTy::iterator I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003572 if (I != MethodVtableIndices.end())
3573 return I->second;
3574
Anders Carlssonfb4dda42009-11-13 17:08:56 +00003575 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssonf942ee02009-11-27 20:47:55 +00003576
3577 ComputeMethodVtableIndices(RD);
3578
Anders Carlssonfb4dda42009-11-13 17:08:56 +00003579 I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003580 assert(I != MethodVtableIndices.end() && "Did not find index!");
3581 return I->second;
3582}
3583
Anders Carlssona864caf2010-03-23 04:11:45 +00003584int64_t CodeGenVTables::getVirtualBaseOffsetOffset(const CXXRecordDecl *RD,
3585 const CXXRecordDecl *VBase) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003586 ClassPairTy ClassPair(RD, VBase);
3587
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003588 VirtualBaseClassOffsetOffsetsMapTy::iterator I =
3589 VirtualBaseClassOffsetOffsets.find(ClassPair);
3590 if (I != VirtualBaseClassOffsetOffsets.end())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003591 return I->second;
3592
Anders Carlssondd819c92010-03-11 16:06:20 +00003593 VCallAndVBaseOffsetBuilder Builder(RD, RD, /*FinalOverriders=*/0,
3594 BaseSubobject(RD, 0),
3595 /*BaseIsVirtual=*/false,
3596 /*OffsetInLayoutClass=*/0);
Anders Carlssondd819c92010-03-11 16:06:20 +00003597
3598 for (VCallAndVBaseOffsetBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
3599 Builder.getVBaseOffsetOffsets().begin(),
3600 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003601 // Insert all types.
3602 ClassPairTy ClassPair(RD, I->first);
3603
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003604 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003605 }
3606
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003607 I = VirtualBaseClassOffsetOffsets.find(ClassPair);
Anders Carlssondd819c92010-03-11 16:06:20 +00003608
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00003609 // FIXME: The assertion below assertion currently fails with the old vtable
3610 /// layout code if there is a non-virtual thunk adjustment in a vtable.
3611 // Once the new layout is in place, this return should be removed.
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003612 if (I == VirtualBaseClassOffsetOffsets.end())
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00003613 return 0;
3614
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00003615 assert(I != VirtualBaseClassOffsetOffsets.end() && "Did not find index!");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003616
3617 return I->second;
3618}
3619
Anders Carlsson85e64352010-03-30 02:21:54 +00003620static bool UseNewVTableCode = true;
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003621
Anders Carlssonf6f24c62010-03-29 02:08:26 +00003622uint64_t
3623CodeGenVTables::getAddressPoint(BaseSubobject Base, const CXXRecordDecl *RD) {
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003624 // FIXME: Always use the new vtable code once we know it works.
3625 if (!UseNewVTableCode) {
3626 const CodeGenVTables::AddrSubMap_t& AddressPoints = getAddressPoints(RD);
Anders Carlssonf6f24c62010-03-29 02:08:26 +00003627
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003628 uint64_t AddressPoint =
3629 AddressPoints.lookup(std::make_pair(Base.getBase(),
3630 Base.getBaseOffset()));
Anders Carlssonf6f24c62010-03-29 02:08:26 +00003631
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003632 assert(AddressPoint && "Address point must not be zero!");
3633 }
3634
3635 uint64_t AddressPoint = AddressPoints.lookup(std::make_pair(RD, Base));
Anders Carlssonf6f24c62010-03-29 02:08:26 +00003636 assert(AddressPoint && "Address point must not be zero!");
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003637
Anders Carlssonf6f24c62010-03-29 02:08:26 +00003638 return AddressPoint;
3639}
3640
Anders Carlssonb35ea552010-03-24 03:57:14 +00003641const CodeGenVTables::AddrSubMap_t &
3642CodeGenVTables::getAddressPoints(const CXXRecordDecl *RD) {
Anders Carlssond03325c2010-03-25 00:51:13 +00003643 if (!OldAddressPoints[RD]) {
Anders Carlsson0534b022010-03-25 00:35:49 +00003644 OldVtableBuilder::AddressPointsMapTy AddressPoints;
Anders Carlssonb35ea552010-03-24 03:57:14 +00003645 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
3646
3647 b.GenerateVtableForBase(RD, 0);
3648 b.GenerateVtableForVBases(RD, 0);
3649 }
3650
Anders Carlssond03325c2010-03-25 00:51:13 +00003651 return *(*OldAddressPoints[RD])[RD];
Anders Carlssonb35ea552010-03-24 03:57:14 +00003652}
3653
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003654llvm::GlobalVariable *
Anders Carlssona864caf2010-03-23 04:11:45 +00003655CodeGenVTables::GenerateVtable(llvm::GlobalVariable::LinkageTypes Linkage,
3656 bool GenerateDefinition,
3657 const CXXRecordDecl *LayoutClass,
3658 const CXXRecordDecl *RD, uint64_t Offset,
3659 bool IsVirtual,
Anders Carlsson0534b022010-03-25 00:35:49 +00003660 llvm::DenseMap<BaseSubobject, uint64_t> &AddressPoints) {
Anders Carlsson93913752010-02-27 20:39:05 +00003661 if (GenerateDefinition) {
3662 if (LayoutClass == RD) {
Anders Carlsson62c6c722010-02-28 00:36:23 +00003663 assert(!IsVirtual &&
Anders Carlssond5531e22010-03-11 05:48:21 +00003664 "Can only have a virtual base in construction vtables!");
3665 assert(!Offset &&
3666 "Can only have a base offset in construction vtables!");
Anders Carlsson93913752010-02-27 20:39:05 +00003667 }
Anders Carlssond5531e22010-03-11 05:48:21 +00003668
3669 VtableBuilder Builder(*this, RD, Offset,
Anders Carlsson9f28dbc2010-03-11 06:10:52 +00003670 /*MostDerivedClassIsVirtual=*/IsVirtual,
Anders Carlssond5531e22010-03-11 05:48:21 +00003671 LayoutClass);
3672
3673 if (CGM.getLangOptions().DumpVtableLayouts)
3674 Builder.dumpLayout(llvm::errs());
Anders Carlssoneee53d92010-02-13 02:02:03 +00003675 }
3676
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003677 llvm::SmallString<256> OutName;
Mike Stump2cefe382009-11-12 20:47:57 +00003678 if (LayoutClass != RD)
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003679 CGM.getMangleContext().mangleCXXCtorVtable(LayoutClass, Offset / 8,
3680 RD, OutName);
Mike Stumpeac45592009-11-11 20:26:26 +00003681 else
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003682 CGM.getMangleContext().mangleCXXVtable(RD, OutName);
Daniel Dunbare128dd12009-11-21 09:06:22 +00003683 llvm::StringRef Name = OutName.str();
Benjamin Kramerbb0a07b2009-10-11 22:57:54 +00003684
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003685 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
Anders Carlssonb35ea552010-03-24 03:57:14 +00003686 if (GV == 0 || GV->isDeclaration()) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003687 OldVtableBuilder b(RD, LayoutClass, Offset, CGM, GenerateDefinition,
3688 AddressPoints);
Eli Friedman6c08ce72009-12-05 01:05:03 +00003689
3690 D1(printf("vtable %s\n", RD->getNameAsCString()));
3691 // First comes the vtables for all the non-virtual bases...
Mike Stumpd538a6d2009-12-24 07:29:41 +00003692 b.GenerateVtableForBase(RD, Offset);
Eli Friedman6c08ce72009-12-05 01:05:03 +00003693
3694 // then the vtables for all the virtual bases.
3695 b.GenerateVtableForVBases(RD, Offset);
3696
Anders Carlsson58b271d2009-12-05 22:19:10 +00003697 llvm::Constant *Init = 0;
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003698 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson58b271d2009-12-05 22:19:10 +00003699 llvm::ArrayType *ArrayType =
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003700 llvm::ArrayType::get(Int8PtrTy, b.getVtableComponents().size());
Anders Carlssona95d4c52009-12-05 21:09:05 +00003701
Anders Carlsson232324c2009-12-06 00:53:22 +00003702 if (GenerateDefinition)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003703 Init = llvm::ConstantArray::get(ArrayType, &b.getVtableComponents()[0],
3704 b.getVtableComponents().size());
Anders Carlsson232324c2009-12-06 00:53:22 +00003705
Mike Stumpaa51ad62009-11-19 04:04:36 +00003706 llvm::GlobalVariable *OGV = GV;
Anders Carlsson232324c2009-12-06 00:53:22 +00003707
3708 GV = new llvm::GlobalVariable(CGM.getModule(), ArrayType,
3709 /*isConstant=*/true, Linkage, Init, Name);
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003710 CGM.setGlobalVisibility(GV, RD);
3711
Mike Stumpaa51ad62009-11-19 04:04:36 +00003712 if (OGV) {
3713 GV->takeName(OGV);
Anders Carlsson58b271d2009-12-05 22:19:10 +00003714 llvm::Constant *NewPtr =
3715 llvm::ConstantExpr::getBitCast(GV, OGV->getType());
Mike Stumpaa51ad62009-11-19 04:04:36 +00003716 OGV->replaceAllUsesWith(NewPtr);
3717 OGV->eraseFromParent();
3718 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00003719 }
Anders Carlssonb3f54b72009-12-05 21:28:12 +00003720
3721 return GV;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003722}
Mike Stump9f23a142009-11-10 02:30:51 +00003723
Anders Carlssoncd836f02010-03-23 17:17:29 +00003724llvm::Constant *CodeGenModule::GetAddrOfThunk(GlobalDecl GD,
3725 const ThunkInfo &Thunk) {
3726 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
3727
3728 // Compute the mangled name.
3729 llvm::SmallString<256> Name;
3730 if (const CXXDestructorDecl* DD = dyn_cast<CXXDestructorDecl>(MD))
3731 getMangleContext().mangleCXXDtorThunk(DD, GD.getDtorType(), Thunk.This,
3732 Name);
3733 else
3734 getMangleContext().mangleThunk(MD, Thunk, Name);
3735
3736 const llvm::Type *Ty = getTypes().GetFunctionTypeForVtable(MD);
3737 return GetOrCreateLLVMFunction(Name, Ty, GlobalDecl());
3738}
3739
Anders Carlssonbad991d2010-03-24 00:39:18 +00003740static llvm::Value *PerformTypeAdjustment(CodeGenFunction &CGF,
3741 llvm::Value *Ptr,
3742 int64_t NonVirtualAdjustment,
3743 int64_t VirtualAdjustment) {
3744 if (!NonVirtualAdjustment && !VirtualAdjustment)
3745 return Ptr;
3746
3747 const llvm::Type *Int8PtrTy =
3748 llvm::Type::getInt8PtrTy(CGF.getLLVMContext());
3749
3750 llvm::Value *V = CGF.Builder.CreateBitCast(Ptr, Int8PtrTy);
3751
3752 if (NonVirtualAdjustment) {
3753 // Do the non-virtual adjustment.
3754 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
3755 }
3756
3757 if (VirtualAdjustment) {
3758 const llvm::Type *PtrDiffTy =
3759 CGF.ConvertType(CGF.getContext().getPointerDiffType());
3760
3761 // Do the virtual adjustment.
3762 llvm::Value *VTablePtrPtr =
3763 CGF.Builder.CreateBitCast(V, Int8PtrTy->getPointerTo());
3764
3765 llvm::Value *VTablePtr = CGF.Builder.CreateLoad(VTablePtrPtr);
3766
3767 llvm::Value *OffsetPtr =
3768 CGF.Builder.CreateConstInBoundsGEP1_64(VTablePtr, VirtualAdjustment);
3769
3770 OffsetPtr = CGF.Builder.CreateBitCast(OffsetPtr, PtrDiffTy->getPointerTo());
3771
3772 // Load the adjustment offset from the vtable.
3773 llvm::Value *Offset = CGF.Builder.CreateLoad(OffsetPtr);
3774
3775 // Adjust our pointer.
3776 V = CGF.Builder.CreateInBoundsGEP(V, Offset);
3777 }
3778
3779 // Cast back to the original type.
3780 return CGF.Builder.CreateBitCast(V, Ptr->getType());
3781}
3782
3783void CodeGenFunction::GenerateThunk(llvm::Function *Fn, GlobalDecl GD,
3784 const ThunkInfo &Thunk) {
3785 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
3786 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
3787 QualType ResultType = FPT->getResultType();
3788 QualType ThisType = MD->getThisType(getContext());
3789
3790 FunctionArgList FunctionArgs;
3791
3792 // FIXME: It would be nice if more of this code could be shared with
3793 // CodeGenFunction::GenerateCode.
3794
3795 // Create the implicit 'this' parameter declaration.
3796 CXXThisDecl = ImplicitParamDecl::Create(getContext(), 0,
3797 MD->getLocation(),
3798 &getContext().Idents.get("this"),
3799 ThisType);
3800
3801 // Add the 'this' parameter.
3802 FunctionArgs.push_back(std::make_pair(CXXThisDecl, CXXThisDecl->getType()));
3803
3804 // Add the rest of the parameters.
3805 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
3806 E = MD->param_end(); I != E; ++I) {
3807 ParmVarDecl *Param = *I;
3808
3809 FunctionArgs.push_back(std::make_pair(Param, Param->getType()));
3810 }
3811
3812 StartFunction(GlobalDecl(), ResultType, Fn, FunctionArgs, SourceLocation());
3813
3814 // Adjust the 'this' pointer if necessary.
3815 llvm::Value *AdjustedThisPtr =
3816 PerformTypeAdjustment(*this, LoadCXXThis(),
3817 Thunk.This.NonVirtual,
3818 Thunk.This.VCallOffsetOffset);
3819
3820 CallArgList CallArgs;
3821
3822 // Add our adjusted 'this' pointer.
3823 CallArgs.push_back(std::make_pair(RValue::get(AdjustedThisPtr), ThisType));
3824
3825 // Add the rest of the parameters.
3826 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
3827 E = MD->param_end(); I != E; ++I) {
3828 ParmVarDecl *Param = *I;
3829 QualType ArgType = Param->getType();
3830
3831 // FIXME: Declaring a DeclRefExpr on the stack is kinda icky.
3832 DeclRefExpr ArgExpr(Param, ArgType.getNonReferenceType(), SourceLocation());
3833 CallArgs.push_back(std::make_pair(EmitCallArg(&ArgExpr, ArgType), ArgType));
3834 }
3835
3836 // Get our callee.
3837 const llvm::Type *Ty =
3838 CGM.getTypes().GetFunctionType(CGM.getTypes().getFunctionInfo(MD),
3839 FPT->isVariadic());
3840 llvm::Value *Callee = CGM.GetAddrOfFunction(GD, Ty);
3841
3842 const CGFunctionInfo &FnInfo =
3843 CGM.getTypes().getFunctionInfo(ResultType, CallArgs, FPT->getCallConv(),
3844 FPT->getNoReturnAttr());
3845
3846 // Now emit our call.
3847 RValue RV = EmitCall(FnInfo, Callee, ReturnValueSlot(), CallArgs, MD);
3848
3849 if (!Thunk.Return.isEmpty()) {
3850 // Emit the return adjustment.
3851 bool NullCheckValue = !ResultType->isReferenceType();
3852
3853 llvm::BasicBlock *AdjustNull = 0;
3854 llvm::BasicBlock *AdjustNotNull = 0;
3855 llvm::BasicBlock *AdjustEnd = 0;
3856
3857 llvm::Value *ReturnValue = RV.getScalarVal();
3858
3859 if (NullCheckValue) {
3860 AdjustNull = createBasicBlock("adjust.null");
3861 AdjustNotNull = createBasicBlock("adjust.notnull");
3862 AdjustEnd = createBasicBlock("adjust.end");
3863
3864 llvm::Value *IsNull = Builder.CreateIsNull(ReturnValue);
3865 Builder.CreateCondBr(IsNull, AdjustNull, AdjustNotNull);
3866 EmitBlock(AdjustNotNull);
3867 }
3868
3869 ReturnValue = PerformTypeAdjustment(*this, ReturnValue,
3870 Thunk.Return.NonVirtual,
3871 Thunk.Return.VBaseOffsetOffset);
3872
3873 if (NullCheckValue) {
3874 Builder.CreateBr(AdjustEnd);
3875 EmitBlock(AdjustNull);
3876 Builder.CreateBr(AdjustEnd);
3877 EmitBlock(AdjustEnd);
3878
3879 llvm::PHINode *PHI = Builder.CreatePHI(ReturnValue->getType());
3880 PHI->reserveOperandSpace(2);
3881 PHI->addIncoming(ReturnValue, AdjustNotNull);
3882 PHI->addIncoming(llvm::Constant::getNullValue(ReturnValue->getType()),
3883 AdjustNull);
3884 ReturnValue = PHI;
3885 }
3886
3887 RV = RValue::get(ReturnValue);
3888 }
3889
3890 if (!ResultType->isVoidType())
3891 EmitReturnOfRValue(RV, ResultType);
3892
3893 FinishFunction();
3894
3895 // Destroy the 'this' declaration.
3896 CXXThisDecl->Destroy(getContext());
3897
3898 // Set the right linkage.
Anders Carlsson17437662010-03-27 20:50:27 +00003899 Fn->setLinkage(CGM.getFunctionLinkage(MD));
Anders Carlssonbad991d2010-03-24 00:39:18 +00003900
3901 // Set the right visibility.
3902 CGM.setGlobalVisibility(Fn, MD);
3903}
3904
Anders Carlsson5c5abad2010-03-23 16:36:50 +00003905void CodeGenVTables::EmitThunk(GlobalDecl GD, const ThunkInfo &Thunk)
3906{
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00003907 llvm::Constant *Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson55e89f82010-03-23 18:18:41 +00003908 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Anders Carlssoncd836f02010-03-23 17:17:29 +00003909
Anders Carlsson55e89f82010-03-23 18:18:41 +00003910 // Strip off a bitcast if we got one back.
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00003911 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Entry)) {
Anders Carlsson55e89f82010-03-23 18:18:41 +00003912 assert(CE->getOpcode() == llvm::Instruction::BitCast);
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00003913 Entry = CE->getOperand(0);
Anders Carlsson55e89f82010-03-23 18:18:41 +00003914 }
3915
Anders Carlsson55e89f82010-03-23 18:18:41 +00003916 // There's already a declaration with the same name, check if it has the same
3917 // type or if we need to replace it.
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00003918 if (cast<llvm::GlobalValue>(Entry)->getType()->getElementType() !=
3919 CGM.getTypes().GetFunctionTypeForVtable(MD)) {
3920 llvm::GlobalValue *OldThunkFn = cast<llvm::GlobalValue>(Entry);
Anders Carlsson55e89f82010-03-23 18:18:41 +00003921
3922 // If the types mismatch then we have to rewrite the definition.
3923 assert(OldThunkFn->isDeclaration() &&
3924 "Shouldn't replace non-declaration");
3925
3926 // Remove the name from the old thunk function and get a new thunk.
3927 OldThunkFn->setName(llvm::StringRef());
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00003928 Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson55e89f82010-03-23 18:18:41 +00003929
3930 // If needed, replace the old thunk with a bitcast.
3931 if (!OldThunkFn->use_empty()) {
3932 llvm::Constant *NewPtrForOldDecl =
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00003933 llvm::ConstantExpr::getBitCast(Entry, OldThunkFn->getType());
Anders Carlsson55e89f82010-03-23 18:18:41 +00003934 OldThunkFn->replaceAllUsesWith(NewPtrForOldDecl);
3935 }
3936
3937 // Remove the old thunk.
3938 OldThunkFn->eraseFromParent();
3939 }
Anders Carlssonbad991d2010-03-24 00:39:18 +00003940
3941 // Actually generate the thunk body.
3942 llvm::Function *ThunkFn = cast<llvm::Function>(Entry);
3943 CodeGenFunction(CGM).GenerateThunk(ThunkFn, GD, Thunk);
Anders Carlsson5c5abad2010-03-23 16:36:50 +00003944}
3945
Anders Carlsson917229c2010-03-23 04:59:02 +00003946void CodeGenVTables::EmitThunks(GlobalDecl GD)
3947{
Anders Carlsson5c5abad2010-03-23 16:36:50 +00003948 const CXXMethodDecl *MD =
3949 cast<CXXMethodDecl>(GD.getDecl())->getCanonicalDecl();
3950
3951 // We don't need to generate thunks for the base destructor.
3952 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
3953 return;
3954
3955 const CXXRecordDecl *RD = MD->getParent();
3956
Anders Carlssone90954d2010-03-24 16:42:11 +00003957 // Compute VTable related info for this class.
3958 ComputeVTableRelatedInformation(RD);
3959
Anders Carlsson5c5abad2010-03-23 16:36:50 +00003960 ThunksMapTy::const_iterator I = Thunks.find(MD);
3961 if (I == Thunks.end()) {
Anders Carlssone90954d2010-03-24 16:42:11 +00003962 // We did not find a thunk for this method.
3963 return;
Anders Carlsson5c5abad2010-03-23 16:36:50 +00003964 }
Anders Carlssone90954d2010-03-24 16:42:11 +00003965
Anders Carlsson5c5abad2010-03-23 16:36:50 +00003966 const ThunkInfoVectorTy &ThunkInfoVector = I->second;
3967 for (unsigned I = 0, E = ThunkInfoVector.size(); I != E; ++I)
3968 EmitThunk(GD, ThunkInfoVector[I]);
Anders Carlsson917229c2010-03-23 04:59:02 +00003969}
3970
Anders Carlssone90954d2010-03-24 16:42:11 +00003971void CodeGenVTables::ComputeVTableRelatedInformation(const CXXRecordDecl *RD) {
3972 uint64_t *&LayoutData = VTableLayoutMap[RD];
3973
3974 // Check if we've computed this information before.
3975 if (LayoutData)
3976 return;
3977
3978 VtableBuilder Builder(*this, RD, 0, /*MostDerivedClassIsVirtual=*/0, RD);
3979
3980 // Add the VTable layout.
3981 uint64_t NumVTableComponents = Builder.getNumVTableComponents();
3982 LayoutData = new uint64_t[NumVTableComponents + 1];
3983
3984 // Store the number of components.
3985 LayoutData[0] = NumVTableComponents;
3986
3987 // Store the components.
3988 std::copy(Builder.vtable_components_data_begin(),
3989 Builder.vtable_components_data_end(),
3990 &LayoutData[1]);
3991
3992 // Add the known thunks.
3993 Thunks.insert(Builder.thunks_begin(), Builder.thunks_end());
3994
Anders Carlsson9a97e2e2010-03-29 01:38:05 +00003995 // Add the thunks needed in this vtable.
3996 assert(!VTableThunksMap.count(RD) &&
3997 "Thunks already exists for this vtable!");
3998
3999 VTableThunksTy &VTableThunks = VTableThunksMap[RD];
4000 VTableThunks.append(Builder.vtable_thunks_begin(),
4001 Builder.vtable_thunks_end());
4002
4003 // Sort them.
4004 std::sort(VTableThunks.begin(), VTableThunks.end());
4005
Anders Carlssond03325c2010-03-25 00:51:13 +00004006 // Add the address points.
4007 for (VtableBuilder::AddressPointsMapTy::const_iterator I =
4008 Builder.address_points_begin(), E = Builder.address_points_end();
4009 I != E; ++I) {
4010
4011 uint64_t &AddressPoint = AddressPoints[std::make_pair(RD, I->first)];
4012
4013 // Check if we already have the address points for this base.
4014 assert(!AddressPoint && "Address point already exists for this base!");
4015
4016 AddressPoint = I->second;
4017 }
4018
Anders Carlssone90954d2010-03-24 16:42:11 +00004019 // If we don't have the vbase information for this class, insert it.
4020 // getVirtualBaseOffsetOffset will compute it separately without computing
4021 // the rest of the vtable related information.
4022 if (!RD->getNumVBases())
4023 return;
4024
4025 const RecordType *VBaseRT =
4026 RD->vbases_begin()->getType()->getAs<RecordType>();
4027 const CXXRecordDecl *VBase = cast<CXXRecordDecl>(VBaseRT->getDecl());
4028
4029 if (VirtualBaseClassOffsetOffsets.count(std::make_pair(RD, VBase)))
4030 return;
4031
4032 for (VtableBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
4033 Builder.getVBaseOffsetOffsets().begin(),
4034 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
4035 // Insert all types.
4036 ClassPairTy ClassPair(RD, I->first);
4037
4038 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
4039 }
4040}
4041
Anders Carlssona4147142010-03-25 15:26:28 +00004042llvm::Constant *
4043CodeGenVTables::CreateVTableInitializer(const CXXRecordDecl *RD,
4044 const uint64_t *Components,
4045 unsigned NumComponents,
4046 const VTableThunksTy &VTableThunks) {
4047 llvm::SmallVector<llvm::Constant *, 64> Inits;
4048
4049 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
4050
Anders Carlssona5736bd2010-03-25 16:49:53 +00004051 const llvm::Type *PtrDiffTy =
4052 CGM.getTypes().ConvertType(CGM.getContext().getPointerDiffType());
4053
4054 QualType ClassType = CGM.getContext().getTagDeclType(RD);
4055 llvm::Constant *RTTI = CGM.GetAddrOfRTTIDescriptor(ClassType);
4056
4057 unsigned NextVTableThunkIndex = 0;
4058
Anders Carlssoncb6207f2010-03-29 05:40:50 +00004059 llvm::Constant* PureVirtualFn = 0;
4060
Anders Carlssona4147142010-03-25 15:26:28 +00004061 for (unsigned I = 0; I != NumComponents; ++I) {
Anders Carlssona5736bd2010-03-25 16:49:53 +00004062 VtableComponent Component =
4063 VtableComponent::getFromOpaqueInteger(Components[I]);
4064
4065 llvm::Constant *Init = 0;
4066
4067 switch (Component.getKind()) {
4068 case VtableComponent::CK_VCallOffset:
4069 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getVCallOffset());
4070 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
4071 break;
4072 case VtableComponent::CK_VBaseOffset:
4073 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getVBaseOffset());
4074 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
4075 break;
4076 case VtableComponent::CK_OffsetToTop:
4077 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getOffsetToTop());
4078 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
4079 break;
4080 case VtableComponent::CK_RTTI:
4081 Init = llvm::ConstantExpr::getBitCast(RTTI, Int8PtrTy);
4082 break;
4083 case VtableComponent::CK_FunctionPointer:
4084 case VtableComponent::CK_CompleteDtorPointer:
4085 case VtableComponent::CK_DeletingDtorPointer: {
4086 GlobalDecl GD;
4087
4088 // Get the right global decl.
4089 switch (Component.getKind()) {
4090 default:
4091 llvm_unreachable("Unexpected vtable component kind");
4092 case VtableComponent::CK_FunctionPointer:
4093 GD = Component.getFunctionDecl();
4094 break;
4095 case VtableComponent::CK_CompleteDtorPointer:
4096 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Complete);
4097 break;
4098 case VtableComponent::CK_DeletingDtorPointer:
4099 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Deleting);
4100 break;
4101 }
4102
Anders Carlssoncb6207f2010-03-29 05:40:50 +00004103 if (cast<CXXMethodDecl>(GD.getDecl())->isPure()) {
4104 // We have a pure virtual member function.
4105 if (!PureVirtualFn) {
4106 const llvm::FunctionType *Ty =
4107 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
4108 /*isVarArg=*/false);
4109 PureVirtualFn =
4110 CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual");
4111 PureVirtualFn = llvm::ConstantExpr::getBitCast(PureVirtualFn,
4112 Int8PtrTy);
4113 }
Anders Carlssona5736bd2010-03-25 16:49:53 +00004114
Anders Carlssoncb6207f2010-03-29 05:40:50 +00004115 Init = PureVirtualFn;
Anders Carlssona5736bd2010-03-25 16:49:53 +00004116 } else {
Anders Carlssoncb6207f2010-03-29 05:40:50 +00004117 // Check if we should use a thunk.
4118 if (NextVTableThunkIndex < VTableThunks.size() &&
4119 VTableThunks[NextVTableThunkIndex].first == I) {
4120 const ThunkInfo &Thunk = VTableThunks[NextVTableThunkIndex].second;
Anders Carlssona5736bd2010-03-25 16:49:53 +00004121
Anders Carlssoncb6207f2010-03-29 05:40:50 +00004122 Init = CGM.GetAddrOfThunk(GD, Thunk);
4123
4124 NextVTableThunkIndex++;
4125 } else {
4126 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
4127 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVtable(MD);
4128
4129 Init = CGM.GetAddrOfFunction(GD, Ty);
4130 }
4131
4132 Init = llvm::ConstantExpr::getBitCast(Init, Int8PtrTy);
Anders Carlssona5736bd2010-03-25 16:49:53 +00004133 }
Anders Carlssona5736bd2010-03-25 16:49:53 +00004134 break;
4135 }
4136
4137 case VtableComponent::CK_UnusedFunctionPointer:
4138 Init = llvm::ConstantExpr::getNullValue(Int8PtrTy);
4139 break;
4140 };
Anders Carlssona4147142010-03-25 15:26:28 +00004141
4142 Inits.push_back(Init);
4143 }
4144
4145 llvm::ArrayType *ArrayType = llvm::ArrayType::get(Int8PtrTy, NumComponents);
4146 return llvm::ConstantArray::get(ArrayType, Inits.data(), Inits.size());
4147}
4148
4149/// GetGlobalVariable - Will return a global variable of the given type.
4150/// If a variable with a different type already exists then a new variable
4151/// with the right type will be created.
4152/// FIXME: We should move this to CodeGenModule and rename it to something
4153/// better and then use it in CGVTT and CGRTTI.
4154static llvm::GlobalVariable *
4155GetGlobalVariable(llvm::Module &Module, llvm::StringRef Name,
4156 const llvm::Type *Ty,
4157 llvm::GlobalValue::LinkageTypes Linkage) {
4158
4159 llvm::GlobalVariable *GV = Module.getNamedGlobal(Name);
4160 llvm::GlobalVariable *OldGV = 0;
4161
4162 if (GV) {
4163 // Check if the variable has the right type.
Anders Carlssoncb6207f2010-03-29 05:40:50 +00004164 if (GV->getType()->getElementType() == Ty)
Anders Carlssona4147142010-03-25 15:26:28 +00004165 return GV;
Anders Carlssona4147142010-03-25 15:26:28 +00004166
4167 assert(GV->isDeclaration() && "Declaration has wrong type!");
4168
4169 OldGV = GV;
4170 }
4171
4172 // Create a new variable.
4173 GV = new llvm::GlobalVariable(Module, Ty, /*isConstant=*/true,
4174 Linkage, 0, Name);
4175
4176 if (OldGV) {
4177 // Replace occurrences of the old variable if needed.
4178 GV->takeName(OldGV);
4179
4180 if (!OldGV->use_empty()) {
4181 llvm::Constant *NewPtrForOldDecl =
4182 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
4183 OldGV->replaceAllUsesWith(NewPtrForOldDecl);
4184 }
4185
4186 OldGV->eraseFromParent();
4187 }
4188
4189 return GV;
4190}
4191
Anders Carlssona627ac7e2010-03-29 03:38:52 +00004192// FIXME: When the new code is in place, we can change this to return a
4193// GlobalVariable.
Anders Carlsson67fbf982010-03-24 05:32:05 +00004194llvm::Constant *CodeGenVTables::GetAddrOfVTable(const CXXRecordDecl *RD) {
Anders Carlssonb35ea552010-03-24 03:57:14 +00004195 llvm::SmallString<256> OutName;
4196 CGM.getMangleContext().mangleCXXVtable(RD, OutName);
4197 llvm::StringRef Name = OutName.str();
Mike Stumpaa51ad62009-11-19 04:04:36 +00004198
Anders Carlssone90954d2010-03-24 16:42:11 +00004199 ComputeVTableRelatedInformation(RD);
4200
Anders Carlssonb35ea552010-03-24 03:57:14 +00004201 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlssone90954d2010-03-24 16:42:11 +00004202 llvm::ArrayType *ArrayType =
4203 llvm::ArrayType::get(Int8PtrTy, getNumVTableComponents(RD));
Anders Carlssona627ac7e2010-03-29 03:38:52 +00004204
4205 // FIXME: Always use the new vtable code once we know it works.
4206 if (UseNewVTableCode)
4207 return GetGlobalVariable(CGM.getModule(), Name, ArrayType,
4208 llvm::GlobalValue::ExternalLinkage);
4209
Anders Carlsson67fbf982010-03-24 05:32:05 +00004210 llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name);
Anders Carlssonb35ea552010-03-24 03:57:14 +00004211 if (GV) {
4212 if (!GV->isDeclaration() || GV->getType()->getElementType() == ArrayType)
4213 return GV;
4214
4215 return llvm::ConstantExpr::getBitCast(GV, ArrayType->getPointerTo());
4216 }
4217
4218 GV = new llvm::GlobalVariable(CGM.getModule(), ArrayType, /*isConstant=*/true,
4219 llvm::GlobalValue::ExternalLinkage, 0, Name);
4220
4221 return GV;
Mike Stumpd846d082009-11-10 07:44:33 +00004222}
Mike Stumpeac45592009-11-11 20:26:26 +00004223
Anders Carlssona627ac7e2010-03-29 03:38:52 +00004224void
4225CodeGenVTables::EmitVTableDefinition(llvm::GlobalVariable *VTable,
4226 llvm::GlobalVariable::LinkageTypes Linkage,
4227 const CXXRecordDecl *RD) {
4228 // Dump the vtable layout if necessary.
4229 if (CGM.getLangOptions().DumpVtableLayouts) {
4230 VtableBuilder Builder(*this, RD, 0, /*MostDerivedClassIsVirtual=*/0, RD);
4231
4232 Builder.dumpLayout(llvm::errs());
4233 }
4234
4235 assert(VTableThunksMap.count(RD) &&
4236 "No thunk status for this record decl!");
4237
4238 const VTableThunksTy& Thunks = VTableThunksMap[RD];
4239
4240 // Create and set the initializer.
4241 llvm::Constant *Init =
4242 CreateVTableInitializer(RD, getVTableComponentsData(RD),
4243 getNumVTableComponents(RD), Thunks);
4244 VTable->setInitializer(Init);
Anders Carlssoncb6207f2010-03-29 05:40:50 +00004245
4246 // Set the correct linkage.
4247 VTable->setLinkage(Linkage);
Anders Carlssona627ac7e2010-03-29 03:38:52 +00004248}
4249
Anders Carlsson0534b022010-03-25 00:35:49 +00004250llvm::GlobalVariable *
4251CodeGenVTables::GenerateConstructionVTable(const CXXRecordDecl *RD,
Anders Carlssona208b392010-03-26 03:56:54 +00004252 const BaseSubobject &Base,
4253 bool BaseIsVirtual,
4254 VTableAddressPointsMapTy& AddressPoints) {
Anders Carlssona4147142010-03-25 15:26:28 +00004255 VtableBuilder Builder(*this, Base.getBase(), Base.getBaseOffset(),
4256 /*MostDerivedClassIsVirtual=*/BaseIsVirtual, RD);
4257
Anders Carlssona5736bd2010-03-25 16:49:53 +00004258 // Dump the vtable layout if necessary.
4259 if (CGM.getLangOptions().DumpVtableLayouts)
4260 Builder.dumpLayout(llvm::errs());
4261
4262 // Add the address points.
Anders Carlssona208b392010-03-26 03:56:54 +00004263 AddressPoints.insert(Builder.address_points_begin(),
4264 Builder.address_points_end());
Anders Carlssona4147142010-03-25 15:26:28 +00004265
4266 // Get the mangled construction vtable name.
4267 llvm::SmallString<256> OutName;
4268 CGM.getMangleContext().mangleCXXCtorVtable(RD, Base.getBaseOffset() / 8,
4269 Base.getBase(), OutName);
4270 llvm::StringRef Name = OutName.str();
4271
4272 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
4273 llvm::ArrayType *ArrayType =
4274 llvm::ArrayType::get(Int8PtrTy, Builder.getNumVTableComponents());
4275
4276 // Create the variable that will hold the construction vtable.
4277 llvm::GlobalVariable *VTable =
4278 GetGlobalVariable(CGM.getModule(), Name, ArrayType,
4279 llvm::GlobalValue::InternalLinkage);
4280
4281 // Add the thunks.
4282 VTableThunksTy VTableThunks;
4283 VTableThunks.append(Builder.vtable_thunks_begin(),
4284 Builder.vtable_thunks_end());
4285
Anders Carlsson848d86e2010-03-29 01:28:05 +00004286 // Sort them.
4287 std::sort(VTableThunks.begin(), VTableThunks.end());
4288
Anders Carlssona4147142010-03-25 15:26:28 +00004289 // Create and set the initializer.
4290 llvm::Constant *Init =
4291 CreateVTableInitializer(Base.getBase(),
4292 Builder.vtable_components_data_begin(),
4293 Builder.getNumVTableComponents(), VTableThunks);
4294 VTable->setInitializer(Init);
4295
Anders Carlsson0534b022010-03-25 00:35:49 +00004296 return VTable;
4297}
4298
Anders Carlssona627ac7e2010-03-29 03:38:52 +00004299void
4300CodeGenVTables::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
4301 const CXXRecordDecl *RD) {
4302 llvm::GlobalVariable *&VTable = Vtables[RD];
4303 if (VTable) {
4304 assert(VTable->getInitializer() && "Vtable doesn't have a definition!");
4305 return;
4306 }
4307
4308 // FIXME: Always use the new vtable code once we know it works.
4309 if (UseNewVTableCode) {
4310 VTable = cast<llvm::GlobalVariable>(GetAddrOfVTable(RD));
4311 EmitVTableDefinition(VTable, Linkage, RD);
4312 } else {
4313 llvm::DenseMap<BaseSubobject, uint64_t> AddressPoints;
4314 VTable = GenerateVtable(Linkage, /*GenerateDefinition=*/true, RD, RD, 0,
4315 /*IsVirtual=*/false,
4316 AddressPoints);
4317 }
4318 GenerateVTT(Linkage, /*GenerateDefinition=*/true, RD);
4319}
4320
Anders Carlsson88410242010-03-23 04:15:00 +00004321void CodeGenVTables::EmitVTableRelatedData(GlobalDecl GD) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00004322 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
4323 const CXXRecordDecl *RD = MD->getParent();
4324
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00004325 // If the class doesn't have a vtable we don't need to emit one.
4326 if (!RD->isDynamicClass())
4327 return;
4328
Anders Carlssonaf82f632010-03-23 04:31:31 +00004329 // Check if we need to emit thunks for this function.
4330 if (MD->isVirtual())
Anders Carlsson917229c2010-03-23 04:59:02 +00004331 EmitThunks(GD);
Anders Carlssonaf82f632010-03-23 04:31:31 +00004332
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00004333 // Get the key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00004334 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00004335
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00004336 if (KeyFunction) {
4337 // We don't have the right key function.
4338 if (KeyFunction->getCanonicalDecl() != MD->getCanonicalDecl())
4339 return;
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00004340 }
4341
Rafael Espindolae7113ca2010-03-10 02:19:29 +00004342 if (Vtables.count(RD))
4343 return;
Eli Friedman8174f2c2009-12-06 22:01:30 +00004344
Rafael Espindolae7113ca2010-03-10 02:19:29 +00004345 TemplateSpecializationKind kind = RD->getTemplateSpecializationKind();
Rafael Espindolafa1708fd2010-03-23 19:55:22 +00004346 if (kind == TSK_ImplicitInstantiation)
Rafael Espindolae7113ca2010-03-10 02:19:29 +00004347 CGM.DeferredVtables.push_back(RD);
4348 else
4349 GenerateClassData(CGM.getVtableLinkage(RD), RD);
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00004350}
Anders Carlsson917229c2010-03-23 04:59:02 +00004351