blob: db4b68965a5312b8e2e059906b2a93e52140f74a [file] [log] [blame]
Anders Carlsson11e51402010-04-17 20:15:18 +00001//===--- CGVTables.cpp - Emit LLVM Code for C++ vtables -------------------===//
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002//
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"
John McCall5d865c322010-08-31 07:33:07 +000016#include "CGCXXABI.h"
Anders Carlssonf942ee02009-11-27 20:47:55 +000017#include "clang/AST/CXXInheritance.h"
Anders Carlsson2bb27f52009-10-11 22:13:54 +000018#include "clang/AST/RecordLayout.h"
John McCall5513fce92010-08-05 20:39:18 +000019#include "clang/Frontend/CodeGenOptions.h"
Anders Carlssond420a312009-11-26 19:32:45 +000020#include "llvm/ADT/DenseSet.h"
Anders Carlssond46ed892010-02-27 16:18:19 +000021#include "llvm/ADT/SetVector.h"
Chandler Carruth94eab4a2010-02-13 10:38:52 +000022#include "llvm/Support/Compiler.h"
Anders Carlsson5d40c6f2010-02-11 08:02:13 +000023#include "llvm/Support/Format.h"
Anders Carlsson56446142010-03-17 20:06:32 +000024#include <algorithm>
Zhongxing Xu1721ef72009-11-13 05:46:16 +000025#include <cstdio>
Anders Carlsson2bb27f52009-10-11 22:13:54 +000026
27using namespace clang;
28using namespace CodeGen;
29
Anders Carlssond59885022009-11-27 22:21:51 +000030namespace {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +000031
Anders Carlsson075056a2010-02-23 01:34:28 +000032/// BaseOffset - Represents an offset from a derived class to a direct or
33/// indirect base class.
34struct BaseOffset {
35 /// DerivedClass - The derived class.
36 const CXXRecordDecl *DerivedClass;
37
38 /// VirtualBase - If the path from the derived class to the base class
39 /// involves a virtual base class, this holds its declaration.
40 const CXXRecordDecl *VirtualBase;
41
42 /// NonVirtualOffset - The offset from the derived class to the base class.
43 /// (Or the offset from the virtual base class to the base class, if the
44 /// path from the derived class to the base class involves a virtual base
45 /// class.
46 int64_t NonVirtualOffset;
47
48 BaseOffset() : DerivedClass(0), VirtualBase(0), NonVirtualOffset(0) { }
49 BaseOffset(const CXXRecordDecl *DerivedClass,
50 const CXXRecordDecl *VirtualBase, int64_t NonVirtualOffset)
51 : DerivedClass(DerivedClass), VirtualBase(VirtualBase),
52 NonVirtualOffset(NonVirtualOffset) { }
53
54 bool isEmpty() const { return !NonVirtualOffset && !VirtualBase; }
55};
56
Anders Carlssone8ac42a2010-02-11 21:24:32 +000057/// FinalOverriders - Contains the final overrider member functions for all
58/// member functions in the base subobjects of a class.
59class FinalOverriders {
Anders Carlsson136bd192010-02-12 16:55:34 +000060public:
61 /// OverriderInfo - Information about a final overrider.
62 struct OverriderInfo {
63 /// Method - The method decl of the overrider.
64 const CXXMethodDecl *Method;
Anders Carlsson5a7654a2010-02-18 16:29:24 +000065
Anders Carlssonca82a4f2010-03-10 02:33:41 +000066 /// Offset - the base offset of the overrider in the layout class.
Ken Dyck785cbdb2011-03-26 01:29:16 +000067 CharUnits Offset;
Anders Carlsson136bd192010-02-12 16:55:34 +000068
Ken Dyck785cbdb2011-03-26 01:29:16 +000069 OverriderInfo() : Method(0), Offset(CharUnits::Zero()) { }
Anders Carlsson136bd192010-02-12 16:55:34 +000070 };
71
72private:
Anders Carlssone8ac42a2010-02-11 21:24:32 +000073 /// MostDerivedClass - The most derived class for which the final overriders
74 /// are stored.
75 const CXXRecordDecl *MostDerivedClass;
76
Anders Carlssonca82a4f2010-03-10 02:33:41 +000077 /// MostDerivedClassOffset - If we're building final overriders for a
78 /// construction vtable, this holds the offset from the layout class to the
79 /// most derived class.
Ken Dyck0d5804a2011-03-27 20:10:29 +000080 const CharUnits MostDerivedClassOffset;
Anders Carlssonca82a4f2010-03-10 02:33:41 +000081
82 /// LayoutClass - The class we're using for layout information. Will be
83 /// different than the most derived class if the final overriders are for a
84 /// construction vtable.
85 const CXXRecordDecl *LayoutClass;
86
Anders Carlssone8ac42a2010-02-11 21:24:32 +000087 ASTContext &Context;
88
89 /// MostDerivedClassLayout - the AST record layout of the most derived class.
90 const ASTRecordLayout &MostDerivedClassLayout;
91
Anders Carlsson04e51cc2010-06-01 23:52:26 +000092 /// MethodBaseOffsetPairTy - Uniquely identifies a member function
Anders Carlssoneee53d92010-02-13 02:02:03 +000093 /// in a base subobject.
Ken Dyck808457c2011-03-26 01:18:17 +000094 typedef std::pair<const CXXMethodDecl *, CharUnits> MethodBaseOffsetPairTy;
Anders Carlsson04e51cc2010-06-01 23:52:26 +000095
96 typedef llvm::DenseMap<MethodBaseOffsetPairTy,
Anders Carlsson136bd192010-02-12 16:55:34 +000097 OverriderInfo> OverridersMapTy;
Anders Carlssone8ac42a2010-02-11 21:24:32 +000098
99 /// OverridersMap - The final overriders for all virtual member functions of
100 /// all the base subobjects of the most derived class.
101 OverridersMapTy OverridersMap;
102
Anders Carlsson27860db2010-06-04 00:54:04 +0000103 /// SubobjectsToOffsetsMapTy - A mapping from a base subobject (represented
104 /// as a record decl and a subobject number) and its offsets in the most
105 /// derived class as well as the layout class.
106 typedef llvm::DenseMap<std::pair<const CXXRecordDecl *, unsigned>,
Ken Dyck70b47e02011-03-26 01:09:13 +0000107 CharUnits> SubobjectOffsetMapTy;
Anders Carlsson27860db2010-06-04 00:54:04 +0000108
109 typedef llvm::DenseMap<const CXXRecordDecl *, unsigned> SubobjectCountMapTy;
110
111 /// ComputeBaseOffsets - Compute the offsets for all base subobjects of the
112 /// given base.
113 void ComputeBaseOffsets(BaseSubobject Base, bool IsVirtual,
Ken Dyck58863dc2011-03-26 01:36:26 +0000114 CharUnits OffsetInLayoutClass,
Anders Carlsson27860db2010-06-04 00:54:04 +0000115 SubobjectOffsetMapTy &SubobjectOffsets,
116 SubobjectOffsetMapTy &SubobjectLayoutClassOffsets,
117 SubobjectCountMapTy &SubobjectCounts);
118
Anders Carlssonfd788402010-06-04 00:59:37 +0000119 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
120
121 /// dump - dump the final overriders for a base subobject, and all its direct
122 /// and indirect base subobjects.
123 void dump(llvm::raw_ostream &Out, BaseSubobject Base,
124 VisitedVirtualBasesSetTy& VisitedVirtualBases);
125
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000126public:
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000127 FinalOverriders(const CXXRecordDecl *MostDerivedClass,
Ken Dyck0d5804a2011-03-27 20:10:29 +0000128 CharUnits MostDerivedClassOffset,
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000129 const CXXRecordDecl *LayoutClass);
Anders Carlsson8025e7b2010-02-24 22:18:01 +0000130
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000131 /// getOverrider - Get the final overrider for the given method declaration in
Anders Carlsson79547c32010-06-01 23:17:37 +0000132 /// the subobject with the given base offset.
133 OverriderInfo getOverrider(const CXXMethodDecl *MD,
Ken Dyck808457c2011-03-26 01:18:17 +0000134 CharUnits BaseOffset) const {
Anders Carlsson04e51cc2010-06-01 23:52:26 +0000135 assert(OverridersMap.count(std::make_pair(MD, BaseOffset)) &&
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000136 "Did not find overrider!");
137
Anders Carlsson04e51cc2010-06-01 23:52:26 +0000138 return OverridersMap.lookup(std::make_pair(MD, BaseOffset));
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000139 }
140
141 /// dump - dump the final overriders.
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000142 void dump() {
Anders Carlssonfd788402010-06-04 00:59:37 +0000143 VisitedVirtualBasesSetTy VisitedVirtualBases;
Ken Dyck16ffcac2011-03-24 01:21:01 +0000144 dump(llvm::errs(), BaseSubobject(MostDerivedClass, CharUnits::Zero()),
145 VisitedVirtualBases);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000146 }
147
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000148};
Anders Carlssoneee53d92010-02-13 02:02:03 +0000149
Anders Carlsson603d7d12010-02-27 20:02:53 +0000150#define DUMP_OVERRIDERS 0
151
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000152FinalOverriders::FinalOverriders(const CXXRecordDecl *MostDerivedClass,
Ken Dyck0d5804a2011-03-27 20:10:29 +0000153 CharUnits MostDerivedClassOffset,
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000154 const CXXRecordDecl *LayoutClass)
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000155 : MostDerivedClass(MostDerivedClass),
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000156 MostDerivedClassOffset(MostDerivedClassOffset), LayoutClass(LayoutClass),
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000157 Context(MostDerivedClass->getASTContext()),
158 MostDerivedClassLayout(Context.getASTRecordLayout(MostDerivedClass)) {
Anders Carlssonfd788402010-06-04 00:59:37 +0000159
Anders Carlsson27860db2010-06-04 00:54:04 +0000160 // Compute base offsets.
161 SubobjectOffsetMapTy SubobjectOffsets;
162 SubobjectOffsetMapTy SubobjectLayoutClassOffsets;
163 SubobjectCountMapTy SubobjectCounts;
Ken Dyck16ffcac2011-03-24 01:21:01 +0000164 ComputeBaseOffsets(BaseSubobject(MostDerivedClass, CharUnits::Zero()),
165 /*IsVirtual=*/false,
Ken Dyck0d5804a2011-03-27 20:10:29 +0000166 MostDerivedClassOffset,
Ken Dyck58863dc2011-03-26 01:36:26 +0000167 SubobjectOffsets, SubobjectLayoutClassOffsets,
168 SubobjectCounts);
Anders Carlsson27860db2010-06-04 00:54:04 +0000169
170 // Get the the final overriders.
171 CXXFinalOverriderMap FinalOverriders;
172 MostDerivedClass->getFinalOverriders(FinalOverriders);
173
174 for (CXXFinalOverriderMap::const_iterator I = FinalOverriders.begin(),
175 E = FinalOverriders.end(); I != E; ++I) {
176 const CXXMethodDecl *MD = I->first;
177 const OverridingMethods& Methods = I->second;
178
179 for (OverridingMethods::const_iterator I = Methods.begin(),
180 E = Methods.end(); I != E; ++I) {
181 unsigned SubobjectNumber = I->first;
182 assert(SubobjectOffsets.count(std::make_pair(MD->getParent(),
183 SubobjectNumber)) &&
184 "Did not find subobject offset!");
185
Ken Dyck70b47e02011-03-26 01:09:13 +0000186 CharUnits BaseOffset = SubobjectOffsets[std::make_pair(MD->getParent(),
Anders Carlsson27860db2010-06-04 00:54:04 +0000187 SubobjectNumber)];
188
189 assert(I->second.size() == 1 && "Final overrider is not unique!");
190 const UniqueVirtualMethod &Method = I->second.front();
191
192 const CXXRecordDecl *OverriderRD = Method.Method->getParent();
193 assert(SubobjectLayoutClassOffsets.count(
194 std::make_pair(OverriderRD, Method.Subobject))
195 && "Did not find subobject offset!");
Ken Dyck70b47e02011-03-26 01:09:13 +0000196 CharUnits OverriderOffset =
Anders Carlsson27860db2010-06-04 00:54:04 +0000197 SubobjectLayoutClassOffsets[std::make_pair(OverriderRD,
198 Method.Subobject)];
199
Ken Dyck808457c2011-03-26 01:18:17 +0000200 OverriderInfo& Overrider = OverridersMap[std::make_pair(MD, BaseOffset)];
Anders Carlsson27860db2010-06-04 00:54:04 +0000201 assert(!Overrider.Method && "Overrider should not exist yet!");
202
Ken Dyck785cbdb2011-03-26 01:29:16 +0000203 Overrider.Offset = OverriderOffset;
Anders Carlsson27860db2010-06-04 00:54:04 +0000204 Overrider.Method = Method.Method;
205 }
206 }
Anders Carlsson603d7d12010-02-27 20:02:53 +0000207
208#if DUMP_OVERRIDERS
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000209 // And dump them (for now).
210 dump();
Anders Carlsson603d7d12010-02-27 20:02:53 +0000211#endif
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000212}
213
Anders Carlsson075056a2010-02-23 01:34:28 +0000214static BaseOffset ComputeBaseOffset(ASTContext &Context,
215 const CXXRecordDecl *DerivedRD,
216 const CXXBasePath &Path) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000217 int64_t NonVirtualOffset = 0;
Anders Carlssoneee53d92010-02-13 02:02:03 +0000218
Anders Carlssonf3f67842010-02-13 20:41:15 +0000219 unsigned NonVirtualStart = 0;
220 const CXXRecordDecl *VirtualBase = 0;
221
222 // First, look for the virtual base class.
223 for (unsigned I = 0, E = Path.size(); I != E; ++I) {
224 const CXXBasePathElement &Element = Path[I];
225
226 if (Element.Base->isVirtual()) {
227 // FIXME: Can we break when we find the first virtual base?
228 // (If we can't, can't we just iterate over the path in reverse order?)
229 NonVirtualStart = I + 1;
230 QualType VBaseType = Element.Base->getType();
231 VirtualBase =
232 cast<CXXRecordDecl>(VBaseType->getAs<RecordType>()->getDecl());
233 }
234 }
235
236 // Now compute the non-virtual offset.
237 for (unsigned I = NonVirtualStart, E = Path.size(); I != E; ++I) {
238 const CXXBasePathElement &Element = Path[I];
Anders Carlssoneee53d92010-02-13 02:02:03 +0000239
240 // Check the base class offset.
241 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Element.Class);
Anders Carlssoned7d0e82010-02-25 22:18:35 +0000242
Anders Carlssoneee53d92010-02-13 02:02:03 +0000243 const RecordType *BaseType = Element.Base->getType()->getAs<RecordType>();
244 const CXXRecordDecl *Base = cast<CXXRecordDecl>(BaseType->getDecl());
Anders Carlssoned7d0e82010-02-25 22:18:35 +0000245
Anders Carlssonfd88a612010-10-31 23:22:37 +0000246 NonVirtualOffset += Layout.getBaseClassOffsetInBits(Base);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000247 }
248
249 // FIXME: This should probably use CharUnits or something. Maybe we should
250 // even change the base offsets in ASTRecordLayout to be specified in
251 // CharUnits.
Anders Carlsson075056a2010-02-23 01:34:28 +0000252 return BaseOffset(DerivedRD, VirtualBase, NonVirtualOffset / 8);
Anders Carlsson258a1e32010-02-14 00:16:19 +0000253
254}
255
Anders Carlsson075056a2010-02-23 01:34:28 +0000256static BaseOffset ComputeBaseOffset(ASTContext &Context,
257 const CXXRecordDecl *BaseRD,
258 const CXXRecordDecl *DerivedRD) {
Anders Carlsson258a1e32010-02-14 00:16:19 +0000259 CXXBasePaths Paths(/*FindAmbiguities=*/false,
260 /*RecordPaths=*/true, /*DetectVirtual=*/false);
261
262 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
263 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
264 assert(false && "Class must be derived from the passed in base class!");
Anders Carlsson075056a2010-02-23 01:34:28 +0000265 return BaseOffset();
Anders Carlsson258a1e32010-02-14 00:16:19 +0000266 }
267
268 return ComputeBaseOffset(Context, DerivedRD, Paths.front());
Anders Carlssoneee53d92010-02-13 02:02:03 +0000269}
270
Anders Carlsson075056a2010-02-23 01:34:28 +0000271static BaseOffset
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000272ComputeReturnAdjustmentBaseOffset(ASTContext &Context,
273 const CXXMethodDecl *DerivedMD,
274 const CXXMethodDecl *BaseMD) {
Anders Carlssoneee53d92010-02-13 02:02:03 +0000275 const FunctionType *BaseFT = BaseMD->getType()->getAs<FunctionType>();
276 const FunctionType *DerivedFT = DerivedMD->getType()->getAs<FunctionType>();
277
278 // Canonicalize the return types.
279 CanQualType CanDerivedReturnType =
280 Context.getCanonicalType(DerivedFT->getResultType());
281 CanQualType CanBaseReturnType =
282 Context.getCanonicalType(BaseFT->getResultType());
283
284 assert(CanDerivedReturnType->getTypeClass() ==
285 CanBaseReturnType->getTypeClass() &&
286 "Types must have same type class!");
287
288 if (CanDerivedReturnType == CanBaseReturnType) {
289 // No adjustment needed.
Anders Carlsson075056a2010-02-23 01:34:28 +0000290 return BaseOffset();
Anders Carlssoneee53d92010-02-13 02:02:03 +0000291 }
292
293 if (isa<ReferenceType>(CanDerivedReturnType)) {
294 CanDerivedReturnType =
295 CanDerivedReturnType->getAs<ReferenceType>()->getPointeeType();
296 CanBaseReturnType =
297 CanBaseReturnType->getAs<ReferenceType>()->getPointeeType();
298 } else if (isa<PointerType>(CanDerivedReturnType)) {
299 CanDerivedReturnType =
300 CanDerivedReturnType->getAs<PointerType>()->getPointeeType();
301 CanBaseReturnType =
302 CanBaseReturnType->getAs<PointerType>()->getPointeeType();
303 } else {
304 assert(false && "Unexpected return type!");
305 }
306
307 // We need to compare unqualified types here; consider
308 // const T *Base::foo();
309 // T *Derived::foo();
310 if (CanDerivedReturnType.getUnqualifiedType() ==
311 CanBaseReturnType.getUnqualifiedType()) {
312 // No adjustment needed.
Anders Carlsson075056a2010-02-23 01:34:28 +0000313 return BaseOffset();
Anders Carlssoneee53d92010-02-13 02:02:03 +0000314 }
315
316 const CXXRecordDecl *DerivedRD =
317 cast<CXXRecordDecl>(cast<RecordType>(CanDerivedReturnType)->getDecl());
318
319 const CXXRecordDecl *BaseRD =
320 cast<CXXRecordDecl>(cast<RecordType>(CanBaseReturnType)->getDecl());
321
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000322 return ComputeBaseOffset(Context, BaseRD, DerivedRD);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000323}
324
Anders Carlsson27860db2010-06-04 00:54:04 +0000325void
326FinalOverriders::ComputeBaseOffsets(BaseSubobject Base, bool IsVirtual,
Ken Dyck58863dc2011-03-26 01:36:26 +0000327 CharUnits OffsetInLayoutClass,
Anders Carlsson27860db2010-06-04 00:54:04 +0000328 SubobjectOffsetMapTy &SubobjectOffsets,
329 SubobjectOffsetMapTy &SubobjectLayoutClassOffsets,
330 SubobjectCountMapTy &SubobjectCounts) {
331 const CXXRecordDecl *RD = Base.getBase();
332
333 unsigned SubobjectNumber = 0;
334 if (!IsVirtual)
335 SubobjectNumber = ++SubobjectCounts[RD];
336
337 // Set up the subobject to offset mapping.
338 assert(!SubobjectOffsets.count(std::make_pair(RD, SubobjectNumber))
339 && "Subobject offset already exists!");
340 assert(!SubobjectLayoutClassOffsets.count(std::make_pair(RD, SubobjectNumber))
341 && "Subobject offset already exists!");
342
Ken Dyck70b47e02011-03-26 01:09:13 +0000343 SubobjectOffsets[std::make_pair(RD, SubobjectNumber)] = Base.getBaseOffset();
Anders Carlsson27860db2010-06-04 00:54:04 +0000344 SubobjectLayoutClassOffsets[std::make_pair(RD, SubobjectNumber)] =
Ken Dyck58863dc2011-03-26 01:36:26 +0000345 OffsetInLayoutClass;
Anders Carlsson27860db2010-06-04 00:54:04 +0000346
347 // Traverse our bases.
348 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
349 E = RD->bases_end(); I != E; ++I) {
350 const CXXRecordDecl *BaseDecl =
351 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
352
Ken Dyckce812032011-03-26 00:51:24 +0000353 CharUnits BaseOffset;
354 CharUnits BaseOffsetInLayoutClass;
Anders Carlsson27860db2010-06-04 00:54:04 +0000355 if (I->isVirtual()) {
356 // Check if we've visited this virtual base before.
357 if (SubobjectOffsets.count(std::make_pair(BaseDecl, 0)))
358 continue;
359
360 const ASTRecordLayout &LayoutClassLayout =
361 Context.getASTRecordLayout(LayoutClass);
362
Ken Dyckce812032011-03-26 00:51:24 +0000363 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson27860db2010-06-04 00:54:04 +0000364 BaseOffsetInLayoutClass =
Ken Dyckce812032011-03-26 00:51:24 +0000365 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson27860db2010-06-04 00:54:04 +0000366 } else {
367 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Ken Dyckce812032011-03-26 00:51:24 +0000368 CharUnits Offset = Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson27860db2010-06-04 00:54:04 +0000369
Ken Dyckce812032011-03-26 00:51:24 +0000370 BaseOffset = Base.getBaseOffset() + Offset;
Ken Dyck58863dc2011-03-26 01:36:26 +0000371 BaseOffsetInLayoutClass = OffsetInLayoutClass + Offset;
Anders Carlsson27860db2010-06-04 00:54:04 +0000372 }
373
Ken Dyckce812032011-03-26 00:51:24 +0000374 ComputeBaseOffsets(BaseSubobject(BaseDecl, BaseOffset),
Ken Dyck58863dc2011-03-26 01:36:26 +0000375 I->isVirtual(), BaseOffsetInLayoutClass,
Ken Dyck16ffcac2011-03-24 01:21:01 +0000376 SubobjectOffsets, SubobjectLayoutClassOffsets,
377 SubobjectCounts);
Anders Carlsson27860db2010-06-04 00:54:04 +0000378 }
379}
380
Anders Carlssonfd788402010-06-04 00:59:37 +0000381void FinalOverriders::dump(llvm::raw_ostream &Out, BaseSubobject Base,
382 VisitedVirtualBasesSetTy &VisitedVirtualBases) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000383 const CXXRecordDecl *RD = Base.getBase();
384 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
385
386 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
387 E = RD->bases_end(); I != E; ++I) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000388 const CXXRecordDecl *BaseDecl =
389 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
390
Anders Carlsson033d4862010-02-14 17:05:59 +0000391 // Ignore bases that don't have any virtual member functions.
392 if (!BaseDecl->isPolymorphic())
393 continue;
394
Ken Dyck16ffcac2011-03-24 01:21:01 +0000395 CharUnits BaseOffset;
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000396 if (I->isVirtual()) {
397 if (!VisitedVirtualBases.insert(BaseDecl)) {
398 // We've visited this base before.
399 continue;
400 }
401
Ken Dyck16ffcac2011-03-24 01:21:01 +0000402 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000403 } else {
Ken Dyck16ffcac2011-03-24 01:21:01 +0000404 BaseOffset = Layout.getBaseClassOffset(BaseDecl) + Base.getBaseOffset();
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000405 }
406
Anders Carlssonfd788402010-06-04 00:59:37 +0000407 dump(Out, BaseSubobject(BaseDecl, BaseOffset), VisitedVirtualBases);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000408 }
409
410 Out << "Final overriders for (" << RD->getQualifiedNameAsString() << ", ";
Ken Dyck16ffcac2011-03-24 01:21:01 +0000411 Out << Base.getBaseOffset().getQuantity() << ")\n";
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000412
413 // Now dump the overriders for this base subobject.
414 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
415 E = RD->method_end(); I != E; ++I) {
416 const CXXMethodDecl *MD = *I;
417
418 if (!MD->isVirtual())
419 continue;
420
Ken Dyck808457c2011-03-26 01:18:17 +0000421 OverriderInfo Overrider = getOverrider(MD, Base.getBaseOffset());
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000422
Anders Carlsson6f1f0022010-03-02 03:44:06 +0000423 Out << " " << MD->getQualifiedNameAsString() << " - (";
Anders Carlsson8e661e12010-02-12 17:13:23 +0000424 Out << Overrider.Method->getQualifiedNameAsString();
Ken Dyck785cbdb2011-03-26 01:29:16 +0000425 Out << ", " << ", " << Overrider.Offset.getQuantity() << ')';
Anders Carlsson6f1f0022010-03-02 03:44:06 +0000426
Anders Carlsson042ce2d82010-06-01 23:47:05 +0000427 BaseOffset Offset;
428 if (!Overrider.Method->isPure())
429 Offset = ComputeReturnAdjustmentBaseOffset(Context, Overrider.Method, MD);
Anders Carlssonf3f67842010-02-13 20:41:15 +0000430
Anders Carlsson042ce2d82010-06-01 23:47:05 +0000431 if (!Offset.isEmpty()) {
Anders Carlssonf3f67842010-02-13 20:41:15 +0000432 Out << " [ret-adj: ";
433 if (Offset.VirtualBase)
434 Out << Offset.VirtualBase->getQualifiedNameAsString() << " vbase, ";
Anders Carlssoneee53d92010-02-13 02:02:03 +0000435
Anders Carlssonf3f67842010-02-13 20:41:15 +0000436 Out << Offset.NonVirtualOffset << " nv]";
Anders Carlssoneee53d92010-02-13 02:02:03 +0000437 }
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000438
Anders Carlsson8e661e12010-02-12 17:13:23 +0000439 Out << "\n";
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000440 }
441}
442
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000443/// VTableComponent - Represents a single component in a vtable.
444class VTableComponent {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000445public:
446 enum Kind {
447 CK_VCallOffset,
448 CK_VBaseOffset,
449 CK_OffsetToTop,
450 CK_RTTI,
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000451 CK_FunctionPointer,
452
453 /// CK_CompleteDtorPointer - A pointer to the complete destructor.
454 CK_CompleteDtorPointer,
455
456 /// CK_DeletingDtorPointer - A pointer to the deleting destructor.
Anders Carlsson350b56e2010-02-19 20:08:13 +0000457 CK_DeletingDtorPointer,
458
459 /// CK_UnusedFunctionPointer - In some cases, a vtable function pointer
460 /// will end up never being called. Such vtable function pointers are
461 /// represented as a CK_UnusedFunctionPointer.
462 CK_UnusedFunctionPointer
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000463 };
464
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000465 static VTableComponent MakeVCallOffset(int64_t Offset) {
466 return VTableComponent(CK_VCallOffset, Offset);
Anders Carlssonb0a588f2010-02-17 06:07:19 +0000467 }
468
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000469 static VTableComponent MakeVBaseOffset(int64_t Offset) {
470 return VTableComponent(CK_VBaseOffset, Offset);
Anders Carlssondc2dba32010-02-16 04:49:44 +0000471 }
472
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000473 static VTableComponent MakeOffsetToTop(int64_t Offset) {
474 return VTableComponent(CK_OffsetToTop, Offset);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000475 }
476
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000477 static VTableComponent MakeRTTI(const CXXRecordDecl *RD) {
478 return VTableComponent(CK_RTTI, reinterpret_cast<uintptr_t>(RD));
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000479 }
480
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000481 static VTableComponent MakeFunction(const CXXMethodDecl *MD) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000482 assert(!isa<CXXDestructorDecl>(MD) &&
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000483 "Don't use MakeFunction with destructors!");
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000484
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000485 return VTableComponent(CK_FunctionPointer,
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000486 reinterpret_cast<uintptr_t>(MD));
487 }
488
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000489 static VTableComponent MakeCompleteDtor(const CXXDestructorDecl *DD) {
490 return VTableComponent(CK_CompleteDtorPointer,
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000491 reinterpret_cast<uintptr_t>(DD));
492 }
493
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000494 static VTableComponent MakeDeletingDtor(const CXXDestructorDecl *DD) {
495 return VTableComponent(CK_DeletingDtorPointer,
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000496 reinterpret_cast<uintptr_t>(DD));
497 }
498
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000499 static VTableComponent MakeUnusedFunction(const CXXMethodDecl *MD) {
Anders Carlsson350b56e2010-02-19 20:08:13 +0000500 assert(!isa<CXXDestructorDecl>(MD) &&
501 "Don't use MakeUnusedFunction with destructors!");
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000502 return VTableComponent(CK_UnusedFunctionPointer,
Anders Carlsson350b56e2010-02-19 20:08:13 +0000503 reinterpret_cast<uintptr_t>(MD));
504 }
505
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000506 static VTableComponent getFromOpaqueInteger(uint64_t I) {
507 return VTableComponent(I);
Anders Carlssona5736bd2010-03-25 16:49:53 +0000508 }
509
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000510 /// getKind - Get the kind of this vtable component.
511 Kind getKind() const {
512 return (Kind)(Value & 0x7);
513 }
514
Anders Carlssonb0a588f2010-02-17 06:07:19 +0000515 int64_t getVCallOffset() const {
516 assert(getKind() == CK_VCallOffset && "Invalid component kind!");
517
518 return getOffset();
519 }
520
Anders Carlssondc2dba32010-02-16 04:49:44 +0000521 int64_t getVBaseOffset() const {
522 assert(getKind() == CK_VBaseOffset && "Invalid component kind!");
523
524 return getOffset();
525 }
526
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000527 int64_t getOffsetToTop() const {
528 assert(getKind() == CK_OffsetToTop && "Invalid component kind!");
529
530 return getOffset();
531 }
532
533 const CXXRecordDecl *getRTTIDecl() const {
534 assert(getKind() == CK_RTTI && "Invalid component kind!");
535
536 return reinterpret_cast<CXXRecordDecl *>(getPointer());
537 }
538
539 const CXXMethodDecl *getFunctionDecl() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000540 assert(getKind() == CK_FunctionPointer);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000541
542 return reinterpret_cast<CXXMethodDecl *>(getPointer());
543 }
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000544
545 const CXXDestructorDecl *getDestructorDecl() const {
546 assert((getKind() == CK_CompleteDtorPointer ||
547 getKind() == CK_DeletingDtorPointer) && "Invalid component kind!");
548
549 return reinterpret_cast<CXXDestructorDecl *>(getPointer());
550 }
551
Anders Carlsson350b56e2010-02-19 20:08:13 +0000552 const CXXMethodDecl *getUnusedFunctionDecl() const {
553 assert(getKind() == CK_UnusedFunctionPointer);
554
555 return reinterpret_cast<CXXMethodDecl *>(getPointer());
556 }
557
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000558private:
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000559 VTableComponent(Kind ComponentKind, int64_t Offset) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000560 assert((ComponentKind == CK_VCallOffset ||
561 ComponentKind == CK_VBaseOffset ||
562 ComponentKind == CK_OffsetToTop) && "Invalid component kind!");
563 assert(Offset <= ((1LL << 56) - 1) && "Offset is too big!");
564
565 Value = ((Offset << 3) | ComponentKind);
566 }
567
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000568 VTableComponent(Kind ComponentKind, uintptr_t Ptr) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000569 assert((ComponentKind == CK_RTTI ||
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000570 ComponentKind == CK_FunctionPointer ||
571 ComponentKind == CK_CompleteDtorPointer ||
Anders Carlsson350b56e2010-02-19 20:08:13 +0000572 ComponentKind == CK_DeletingDtorPointer ||
573 ComponentKind == CK_UnusedFunctionPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000574 "Invalid component kind!");
575
576 assert((Ptr & 7) == 0 && "Pointer not sufficiently aligned!");
577
578 Value = Ptr | ComponentKind;
579 }
580
581 int64_t getOffset() const {
582 assert((getKind() == CK_VCallOffset || getKind() == CK_VBaseOffset ||
583 getKind() == CK_OffsetToTop) && "Invalid component kind!");
584
585 return Value >> 3;
586 }
587
588 uintptr_t getPointer() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000589 assert((getKind() == CK_RTTI ||
590 getKind() == CK_FunctionPointer ||
591 getKind() == CK_CompleteDtorPointer ||
Anders Carlsson350b56e2010-02-19 20:08:13 +0000592 getKind() == CK_DeletingDtorPointer ||
593 getKind() == CK_UnusedFunctionPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000594 "Invalid component kind!");
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000595
596 return static_cast<uintptr_t>(Value & ~7ULL);
597 }
598
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000599 explicit VTableComponent(uint64_t Value)
Anders Carlssona5736bd2010-03-25 16:49:53 +0000600 : Value(Value) { }
601
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000602 /// The kind is stored in the lower 3 bits of the value. For offsets, we
603 /// make use of the facts that classes can't be larger than 2^55 bytes,
604 /// so we store the offset in the lower part of the 61 bytes that remain.
605 /// (The reason that we're not simply using a PointerIntPair here is that we
606 /// need the offsets to be 64-bit, even when on a 32-bit machine).
607 int64_t Value;
608};
609
Anders Carlsson78277c72010-02-18 17:00:09 +0000610/// VCallOffsetMap - Keeps track of vcall offsets when building a vtable.
611struct VCallOffsetMap {
612
613 typedef std::pair<const CXXMethodDecl *, int64_t> MethodAndOffsetPairTy;
614
615 /// Offsets - Keeps track of methods and their offsets.
616 // FIXME: This should be a real map and not a vector.
617 llvm::SmallVector<MethodAndOffsetPairTy, 16> Offsets;
618
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000619 /// MethodsCanShareVCallOffset - Returns whether two virtual member functions
620 /// can share the same vcall offset.
621 static bool MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
622 const CXXMethodDecl *RHS);
623
Anders Carlsson78277c72010-02-18 17:00:09 +0000624public:
625 /// AddVCallOffset - Adds a vcall offset to the map. Returns true if the
626 /// add was successful, or false if there was already a member function with
627 /// the same signature in the map.
628 bool AddVCallOffset(const CXXMethodDecl *MD, int64_t OffsetOffset);
629
630 /// getVCallOffsetOffset - Returns the vcall offset offset (relative to the
631 /// vtable address point) for the given virtual member function.
632 int64_t getVCallOffsetOffset(const CXXMethodDecl *MD);
633
Anders Carlsson9e3b3a32010-02-25 22:23:13 +0000634 // empty - Return whether the offset map is empty or not.
635 bool empty() const { return Offsets.empty(); }
Anders Carlsson78277c72010-02-18 17:00:09 +0000636};
637
John McCall43c6ffb2010-02-26 20:22:44 +0000638static bool HasSameVirtualSignature(const CXXMethodDecl *LHS,
639 const CXXMethodDecl *RHS) {
640 ASTContext &C = LHS->getASTContext(); // TODO: thread this down
641 CanQual<FunctionProtoType>
642 LT = C.getCanonicalType(LHS->getType()).getAs<FunctionProtoType>(),
643 RT = C.getCanonicalType(RHS->getType()).getAs<FunctionProtoType>();
644
645 // Fast-path matches in the canonical types.
646 if (LT == RT) return true;
647
648 // Force the signatures to match. We can't rely on the overrides
649 // list here because there isn't necessarily an inheritance
650 // relationship between the two methods.
651 if (LT.getQualifiers() != RT.getQualifiers() ||
652 LT->getNumArgs() != RT->getNumArgs())
653 return false;
654 for (unsigned I = 0, E = LT->getNumArgs(); I != E; ++I)
655 if (LT->getArgType(I) != RT->getArgType(I))
656 return false;
657 return true;
658}
659
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000660bool VCallOffsetMap::MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
661 const CXXMethodDecl *RHS) {
662 assert(LHS->isVirtual() && "LHS must be virtual!");
663 assert(RHS->isVirtual() && "LHS must be virtual!");
664
Anders Carlssond69b2f92010-02-27 04:12:52 +0000665 // A destructor can share a vcall offset with another destructor.
666 if (isa<CXXDestructorDecl>(LHS))
667 return isa<CXXDestructorDecl>(RHS);
668
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000669 // FIXME: We need to check more things here.
670
Anders Carlssond69b2f92010-02-27 04:12:52 +0000671 // The methods must have the same name.
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000672 DeclarationName LHSName = LHS->getDeclName();
673 DeclarationName RHSName = RHS->getDeclName();
John McCall43c6ffb2010-02-26 20:22:44 +0000674 if (LHSName != RHSName)
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000675 return false;
John McCall43c6ffb2010-02-26 20:22:44 +0000676
Anders Carlssond69b2f92010-02-27 04:12:52 +0000677 // And the same signatures.
678 return HasSameVirtualSignature(LHS, RHS);
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000679}
680
Anders Carlsson78277c72010-02-18 17:00:09 +0000681bool VCallOffsetMap::AddVCallOffset(const CXXMethodDecl *MD,
682 int64_t OffsetOffset) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000683 // Check if we can reuse an offset.
684 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
685 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
686 return false;
687 }
688
689 // Add the offset.
690 Offsets.push_back(MethodAndOffsetPairTy(MD, OffsetOffset));
Anders Carlsson78277c72010-02-18 17:00:09 +0000691 return true;
692}
693
694int64_t VCallOffsetMap::getVCallOffsetOffset(const CXXMethodDecl *MD) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000695 // Look for an offset.
696 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
697 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
698 return Offsets[I].second;
699 }
700
701 assert(false && "Should always find a vcall offset offset!");
Anders Carlsson78277c72010-02-18 17:00:09 +0000702 return 0;
703}
704
Anders Carlsson422f7782010-02-25 03:45:56 +0000705/// VCallAndVBaseOffsetBuilder - Class for building vcall and vbase offsets.
706class VCallAndVBaseOffsetBuilder {
Anders Carlssondd819c92010-03-11 16:06:20 +0000707public:
708 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
709 VBaseOffsetOffsetsMapTy;
710
711private:
Anders Carlssone3385f52010-02-28 01:43:58 +0000712 /// MostDerivedClass - The most derived class for which we're building vcall
713 /// and vbase offsets.
Anders Carlsson422f7782010-02-25 03:45:56 +0000714 const CXXRecordDecl *MostDerivedClass;
715
Anders Carlssonc3f92a12010-02-27 21:09:00 +0000716 /// LayoutClass - The class we're using for layout information. Will be
717 /// different than the most derived class if we're building a construction
718 /// vtable.
719 const CXXRecordDecl *LayoutClass;
720
Anders Carlsson422f7782010-02-25 03:45:56 +0000721 /// Context - The ASTContext which we will use for layout information.
722 ASTContext &Context;
723
724 /// Components - vcall and vbase offset components
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000725 typedef llvm::SmallVector<VTableComponent, 64> VTableComponentVectorTy;
726 VTableComponentVectorTy Components;
Anders Carlsson422f7782010-02-25 03:45:56 +0000727
728 /// VisitedVirtualBases - Visited virtual bases.
729 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
730
731 /// VCallOffsets - Keeps track of vcall offsets.
732 VCallOffsetMap VCallOffsets;
733
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000734
735 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets,
736 /// relative to the address point.
737 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
738
Anders Carlsson422f7782010-02-25 03:45:56 +0000739 /// FinalOverriders - The final overriders of the most derived class.
740 /// (Can be null when we're not building a vtable of the most derived class).
741 const FinalOverriders *Overriders;
742
743 /// AddVCallAndVBaseOffsets - Add vcall offsets and vbase offsets for the
744 /// given base subobject.
745 void AddVCallAndVBaseOffsets(BaseSubobject Base, bool BaseIsVirtual,
Ken Dyck9b32ee12011-03-31 00:37:24 +0000746 CharUnits RealBaseOffset);
Anders Carlsson422f7782010-02-25 03:45:56 +0000747
748 /// AddVCallOffsets - Add vcall offsets for the given base subobject.
Ken Dyckb3ba7752011-03-30 10:11:40 +0000749 void AddVCallOffsets(BaseSubobject Base, CharUnits VBaseOffset);
Anders Carlsson422f7782010-02-25 03:45:56 +0000750
751 /// AddVBaseOffsets - Add vbase offsets for the given class.
Anders Carlsson93b1b492010-03-02 05:40:45 +0000752 void AddVBaseOffsets(const CXXRecordDecl *Base, uint64_t OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +0000753
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000754 /// getCurrentOffsetOffset - Get the current vcall or vbase offset offset in
755 /// bytes, relative to the vtable address point.
756 int64_t getCurrentOffsetOffset() const;
757
Anders Carlsson422f7782010-02-25 03:45:56 +0000758public:
759 VCallAndVBaseOffsetBuilder(const CXXRecordDecl *MostDerivedClass,
Anders Carlssonc3f92a12010-02-27 21:09:00 +0000760 const CXXRecordDecl *LayoutClass,
Anders Carlsson422f7782010-02-25 03:45:56 +0000761 const FinalOverriders *Overriders,
Anders Carlssone3385f52010-02-28 01:43:58 +0000762 BaseSubobject Base, bool BaseIsVirtual,
Ken Dyck1a93b3b2011-03-31 00:48:04 +0000763 CharUnits OffsetInLayoutClass)
Anders Carlssone3385f52010-02-28 01:43:58 +0000764 : MostDerivedClass(MostDerivedClass), LayoutClass(LayoutClass),
Anders Carlsson422f7782010-02-25 03:45:56 +0000765 Context(MostDerivedClass->getASTContext()), Overriders(Overriders) {
766
767 // Add vcall and vbase offsets.
Ken Dyck1a93b3b2011-03-31 00:48:04 +0000768 AddVCallAndVBaseOffsets(Base, BaseIsVirtual, OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +0000769 }
770
771 /// Methods for iterating over the components.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000772 typedef VTableComponentVectorTy::const_reverse_iterator const_iterator;
Anders Carlsson422f7782010-02-25 03:45:56 +0000773 const_iterator components_begin() const { return Components.rbegin(); }
774 const_iterator components_end() const { return Components.rend(); }
775
Anders Carlssondd819c92010-03-11 16:06:20 +0000776 const VCallOffsetMap &getVCallOffsets() const { return VCallOffsets; }
777 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000778 return VBaseOffsetOffsets;
779 }
Anders Carlsson422f7782010-02-25 03:45:56 +0000780};
781
782void
783VCallAndVBaseOffsetBuilder::AddVCallAndVBaseOffsets(BaseSubobject Base,
784 bool BaseIsVirtual,
Ken Dyck9b32ee12011-03-31 00:37:24 +0000785 CharUnits RealBaseOffset) {
Anders Carlsson422f7782010-02-25 03:45:56 +0000786 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base.getBase());
787
788 // Itanium C++ ABI 2.5.2:
789 // ..in classes sharing a virtual table with a primary base class, the vcall
790 // and vbase offsets added by the derived class all come before the vcall
791 // and vbase offsets required by the base class, so that the latter may be
792 // laid out as required by the base class without regard to additions from
793 // the derived class(es).
794
795 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
796 // emit them for the primary base first).
797 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson7f95cd12010-11-24 23:12:57 +0000798 bool PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlsson422f7782010-02-25 03:45:56 +0000799
Ken Dyckce812032011-03-26 00:51:24 +0000800 CharUnits PrimaryBaseOffset;
Anders Carlsson422f7782010-02-25 03:45:56 +0000801
802 // Get the base offset of the primary base.
803 if (PrimaryBaseIsVirtual) {
Anders Carlssonfd88a612010-10-31 23:22:37 +0000804 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson422f7782010-02-25 03:45:56 +0000805 "Primary vbase should have a zero offset!");
806
807 const ASTRecordLayout &MostDerivedClassLayout =
808 Context.getASTRecordLayout(MostDerivedClass);
809
810 PrimaryBaseOffset =
Ken Dyckce812032011-03-26 00:51:24 +0000811 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson422f7782010-02-25 03:45:56 +0000812 } else {
Anders Carlssonfd88a612010-10-31 23:22:37 +0000813 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson422f7782010-02-25 03:45:56 +0000814 "Primary base should have a zero offset!");
815
Ken Dyckce812032011-03-26 00:51:24 +0000816 PrimaryBaseOffset = Base.getBaseOffset();
Anders Carlsson422f7782010-02-25 03:45:56 +0000817 }
818
Ken Dyck16ffcac2011-03-24 01:21:01 +0000819 AddVCallAndVBaseOffsets(
Ken Dyckce812032011-03-26 00:51:24 +0000820 BaseSubobject(PrimaryBase,PrimaryBaseOffset),
Ken Dyck16ffcac2011-03-24 01:21:01 +0000821 PrimaryBaseIsVirtual, RealBaseOffset);
Anders Carlsson422f7782010-02-25 03:45:56 +0000822 }
823
Ken Dyck9b32ee12011-03-31 00:37:24 +0000824 AddVBaseOffsets(Base.getBase(), Context.toBits(RealBaseOffset));
Anders Carlsson422f7782010-02-25 03:45:56 +0000825
826 // We only want to add vcall offsets for virtual bases.
827 if (BaseIsVirtual)
Ken Dyck9b32ee12011-03-31 00:37:24 +0000828 AddVCallOffsets(Base, RealBaseOffset);
Anders Carlsson422f7782010-02-25 03:45:56 +0000829}
830
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000831int64_t VCallAndVBaseOffsetBuilder::getCurrentOffsetOffset() const {
832 // OffsetIndex is the index of this vcall or vbase offset, relative to the
833 // vtable address point. (We subtract 3 to account for the information just
834 // above the address point, the RTTI info, the offset to top, and the
835 // vcall offset itself).
836 int64_t OffsetIndex = -(int64_t)(3 + Components.size());
837
838 // FIXME: We shouldn't use / 8 here.
839 int64_t OffsetOffset = OffsetIndex *
840 (int64_t)Context.Target.getPointerWidth(0) / 8;
841
842 return OffsetOffset;
843}
844
Anders Carlsson422f7782010-02-25 03:45:56 +0000845void VCallAndVBaseOffsetBuilder::AddVCallOffsets(BaseSubobject Base,
Ken Dyckb3ba7752011-03-30 10:11:40 +0000846 CharUnits VBaseOffset) {
Anders Carlsson422f7782010-02-25 03:45:56 +0000847 const CXXRecordDecl *RD = Base.getBase();
848 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
849
John McCall43c6ffb2010-02-26 20:22:44 +0000850 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
851
Anders Carlsson422f7782010-02-25 03:45:56 +0000852 // Handle the primary base first.
Anders Carlsson343a26b2010-04-11 20:04:11 +0000853 // We only want to add vcall offsets if the base is non-virtual; a virtual
854 // primary base will have its vcall and vbase offsets emitted already.
Anders Carlsson7f95cd12010-11-24 23:12:57 +0000855 if (PrimaryBase && !Layout.isPrimaryBaseVirtual()) {
Anders Carlsson422f7782010-02-25 03:45:56 +0000856 // Get the base offset of the primary base.
Anders Carlssonfd88a612010-10-31 23:22:37 +0000857 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson343a26b2010-04-11 20:04:11 +0000858 "Primary base should have a zero offset!");
Anders Carlsson422f7782010-02-25 03:45:56 +0000859
Anders Carlsson343a26b2010-04-11 20:04:11 +0000860 AddVCallOffsets(BaseSubobject(PrimaryBase, Base.getBaseOffset()),
Anders Carlsson422f7782010-02-25 03:45:56 +0000861 VBaseOffset);
862 }
Anders Carlsson343a26b2010-04-11 20:04:11 +0000863
Anders Carlsson422f7782010-02-25 03:45:56 +0000864 // Add the vcall offsets.
865 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
866 E = RD->method_end(); I != E; ++I) {
867 const CXXMethodDecl *MD = *I;
868
869 if (!MD->isVirtual())
870 continue;
871
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000872 int64_t OffsetOffset = getCurrentOffsetOffset();
Anders Carlsson422f7782010-02-25 03:45:56 +0000873
874 // Don't add a vcall offset if we already have one for this member function
875 // signature.
876 if (!VCallOffsets.AddVCallOffset(MD, OffsetOffset))
877 continue;
878
Ken Dyck075de162011-03-30 01:21:33 +0000879 CharUnits Offset = CharUnits::Zero();
Anders Carlsson422f7782010-02-25 03:45:56 +0000880
881 if (Overriders) {
882 // Get the final overrider.
883 FinalOverriders::OverriderInfo Overrider =
Ken Dyck808457c2011-03-26 01:18:17 +0000884 Overriders->getOverrider(MD, Base.getBaseOffset());
Anders Carlsson422f7782010-02-25 03:45:56 +0000885
Anders Carlsson31f595f2010-02-28 00:10:58 +0000886 /// The vcall offset is the offset from the virtual base to the object
887 /// where the function was overridden.
Ken Dyckb3ba7752011-03-30 10:11:40 +0000888 Offset = Overrider.Offset - VBaseOffset;
Anders Carlsson422f7782010-02-25 03:45:56 +0000889 }
890
Ken Dyck075de162011-03-30 01:21:33 +0000891 Components.push_back(
892 VTableComponent::MakeVCallOffset(Offset.getQuantity()));
Anders Carlsson422f7782010-02-25 03:45:56 +0000893 }
894
895 // And iterate over all non-virtual bases (ignoring the primary base).
896 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
897 E = RD->bases_end(); I != E; ++I) {
898
899 if (I->isVirtual())
900 continue;
901
902 const CXXRecordDecl *BaseDecl =
903 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
John McCall43c6ffb2010-02-26 20:22:44 +0000904 if (BaseDecl == PrimaryBase)
905 continue;
Anders Carlsson422f7782010-02-25 03:45:56 +0000906
907 // Get the base offset of this base.
Ken Dyckce812032011-03-26 00:51:24 +0000908 CharUnits BaseOffset = Base.getBaseOffset() +
909 Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson422f7782010-02-25 03:45:56 +0000910
Ken Dyckce812032011-03-26 00:51:24 +0000911 AddVCallOffsets(BaseSubobject(BaseDecl, BaseOffset),
912 VBaseOffset);
Anders Carlsson422f7782010-02-25 03:45:56 +0000913 }
914}
915
Anders Carlsson422f7782010-02-25 03:45:56 +0000916void VCallAndVBaseOffsetBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
Anders Carlsson93b1b492010-03-02 05:40:45 +0000917 uint64_t OffsetInLayoutClass) {
Anders Carlssonc3f92a12010-02-27 21:09:00 +0000918 const ASTRecordLayout &LayoutClassLayout =
919 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +0000920
921 // Add vbase offsets.
922 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
923 E = RD->bases_end(); I != E; ++I) {
924 const CXXRecordDecl *BaseDecl =
925 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
926
927 // Check if this is a virtual base that we haven't visited before.
928 if (I->isVirtual() && VisitedVirtualBases.insert(BaseDecl)) {
929 // FIXME: We shouldn't use / 8 here.
Anders Carlsson93b1b492010-03-02 05:40:45 +0000930 int64_t Offset =
Anders Carlssonfd88a612010-10-31 23:22:37 +0000931 (int64_t)(LayoutClassLayout.getVBaseClassOffsetInBits(BaseDecl) -
Anders Carlsson93b1b492010-03-02 05:40:45 +0000932 OffsetInLayoutClass) / 8;
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000933
934 // Add the vbase offset offset.
935 assert(!VBaseOffsetOffsets.count(BaseDecl) &&
936 "vbase offset offset already exists!");
937
938 int64_t VBaseOffsetOffset = getCurrentOffsetOffset();
939 VBaseOffsetOffsets.insert(std::make_pair(BaseDecl, VBaseOffsetOffset));
940
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000941 Components.push_back(VTableComponent::MakeVBaseOffset(Offset));
Anders Carlsson422f7782010-02-25 03:45:56 +0000942 }
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000943
Anders Carlsson422f7782010-02-25 03:45:56 +0000944 // Check the base class looking for more vbase offsets.
Anders Carlsson93b1b492010-03-02 05:40:45 +0000945 AddVBaseOffsets(BaseDecl, OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +0000946 }
947}
948
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000949/// VTableBuilder - Class for building vtable layout information.
950class VTableBuilder {
Anders Carlsson65b49782010-02-12 05:25:12 +0000951public:
Anders Carlssond46ed892010-02-27 16:18:19 +0000952 /// PrimaryBasesSetVectorTy - A set vector of direct and indirect
953 /// primary bases.
954 typedef llvm::SmallSetVector<const CXXRecordDecl *, 8>
955 PrimaryBasesSetVectorTy;
956
Anders Carlssone90954d2010-03-24 16:42:11 +0000957 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
958 VBaseOffsetOffsetsMapTy;
Anders Carlssond03325c2010-03-25 00:51:13 +0000959
960 typedef llvm::DenseMap<BaseSubobject, uint64_t>
961 AddressPointsMapTy;
Anders Carlssone90954d2010-03-24 16:42:11 +0000962
Anders Carlsson65b49782010-02-12 05:25:12 +0000963private:
Anders Carlssona864caf2010-03-23 04:11:45 +0000964 /// VTables - Global vtable information.
965 CodeGenVTables &VTables;
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000966
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000967 /// MostDerivedClass - The most derived class for which we're building this
968 /// vtable.
969 const CXXRecordDecl *MostDerivedClass;
970
Anders Carlsson93913752010-02-27 20:39:05 +0000971 /// MostDerivedClassOffset - If we're building a construction vtable, this
972 /// holds the offset from the layout class to the most derived class.
Ken Dyck9a7e5322011-03-27 20:20:28 +0000973 const CharUnits MostDerivedClassOffset;
Anders Carlsson93913752010-02-27 20:39:05 +0000974
Anders Carlsson62c6c722010-02-28 00:36:23 +0000975 /// MostDerivedClassIsVirtual - Whether the most derived class is a virtual
976 /// base. (This only makes sense when building a construction vtable).
977 bool MostDerivedClassIsVirtual;
978
Anders Carlsson93913752010-02-27 20:39:05 +0000979 /// LayoutClass - The class we're using for layout information. Will be
980 /// different than the most derived class if we're building a construction
981 /// vtable.
982 const CXXRecordDecl *LayoutClass;
983
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000984 /// Context - The ASTContext which we will use for layout information.
Anders Carlsson65b49782010-02-12 05:25:12 +0000985 ASTContext &Context;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000986
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000987 /// FinalOverriders - The final overriders of the most derived class.
Anders Carlsson422f7782010-02-25 03:45:56 +0000988 const FinalOverriders Overriders;
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000989
Anders Carlsson9e3b3a32010-02-25 22:23:13 +0000990 /// VCallOffsetsForVBases - Keeps track of vcall offsets for the virtual
991 /// bases in this vtable.
992 llvm::DenseMap<const CXXRecordDecl *, VCallOffsetMap> VCallOffsetsForVBases;
Anders Carlsson78277c72010-02-18 17:00:09 +0000993
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000994 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets for
995 /// the most derived class.
996 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
997
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000998 /// Components - The components of the vtable being built.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000999 llvm::SmallVector<VTableComponent, 64> Components;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001000
Anders Carlsson932c2f22010-02-11 17:18:51 +00001001 /// AddressPoints - Address points for the vtable being built.
Anders Carlsson0534b022010-03-25 00:35:49 +00001002 AddressPointsMapTy AddressPoints;
Anders Carlsson932c2f22010-02-11 17:18:51 +00001003
Anders Carlssond46ed892010-02-27 16:18:19 +00001004 /// MethodInfo - Contains information about a method in a vtable.
1005 /// (Used for computing 'this' pointer adjustment thunks.
1006 struct MethodInfo {
1007 /// BaseOffset - The base offset of this method.
Ken Dyck7d876f32011-03-27 18:57:53 +00001008 const CharUnits BaseOffset;
Anders Carlssond46ed892010-02-27 16:18:19 +00001009
Anders Carlsson423406f32010-03-10 21:25:37 +00001010 /// BaseOffsetInLayoutClass - The base offset in the layout class of this
1011 /// method.
Ken Dyck7d876f32011-03-27 18:57:53 +00001012 const CharUnits BaseOffsetInLayoutClass;
Anders Carlsson423406f32010-03-10 21:25:37 +00001013
Anders Carlssond78b2242010-04-11 22:07:06 +00001014 /// VTableIndex - The index in the vtable that this method has.
Anders Carlssond46ed892010-02-27 16:18:19 +00001015 /// (For destructors, this is the index of the complete destructor).
Anders Carlssond78b2242010-04-11 22:07:06 +00001016 const uint64_t VTableIndex;
Anders Carlssond46ed892010-02-27 16:18:19 +00001017
Ken Dyck7d876f32011-03-27 18:57:53 +00001018 MethodInfo(CharUnits BaseOffset, CharUnits BaseOffsetInLayoutClass,
Anders Carlssond78b2242010-04-11 22:07:06 +00001019 uint64_t VTableIndex)
Anders Carlsson423406f32010-03-10 21:25:37 +00001020 : BaseOffset(BaseOffset),
1021 BaseOffsetInLayoutClass(BaseOffsetInLayoutClass),
Anders Carlssond78b2242010-04-11 22:07:06 +00001022 VTableIndex(VTableIndex) { }
Anders Carlsson40687982010-02-27 16:52:49 +00001023
Ken Dyck7d876f32011-03-27 18:57:53 +00001024 MethodInfo()
1025 : BaseOffset(CharUnits::Zero()),
1026 BaseOffsetInLayoutClass(CharUnits::Zero()),
1027 VTableIndex(0) { }
Anders Carlssond46ed892010-02-27 16:18:19 +00001028 };
1029
1030 typedef llvm::DenseMap<const CXXMethodDecl *, MethodInfo> MethodInfoMapTy;
1031
1032 /// MethodInfoMap - The information for all methods in the vtable we're
1033 /// currently building.
1034 MethodInfoMapTy MethodInfoMap;
1035
Anders Carlssond78b2242010-04-11 22:07:06 +00001036 typedef llvm::DenseMap<uint64_t, ThunkInfo> VTableThunksMapTy;
Anders Carlsson8a240292010-03-12 04:54:20 +00001037
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001038 /// VTableThunks - The thunks by vtable index in the vtable currently being
1039 /// built.
Anders Carlssond78b2242010-04-11 22:07:06 +00001040 VTableThunksMapTy VTableThunks;
Anders Carlssond46ed892010-02-27 16:18:19 +00001041
Anders Carlsson917229c2010-03-23 04:59:02 +00001042 typedef llvm::SmallVector<ThunkInfo, 1> ThunkInfoVectorTy;
1043 typedef llvm::DenseMap<const CXXMethodDecl *, ThunkInfoVectorTy> ThunksMapTy;
Anders Carlsson56446142010-03-17 20:06:32 +00001044
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001045 /// Thunks - A map that contains all the thunks needed for all methods in the
1046 /// most derived class for which the vtable is currently being built.
Anders Carlsson917229c2010-03-23 04:59:02 +00001047 ThunksMapTy Thunks;
Anders Carlsson56446142010-03-17 20:06:32 +00001048
1049 /// AddThunk - Add a thunk for the given method.
Anders Carlsson4b2411e2010-03-21 20:27:14 +00001050 void AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk);
Anders Carlsson56446142010-03-17 20:06:32 +00001051
Anders Carlsson40687982010-02-27 16:52:49 +00001052 /// ComputeThisAdjustments - Compute the 'this' pointer adjustments for the
1053 /// part of the vtable we're currently building.
1054 void ComputeThisAdjustments();
1055
Anders Carlssondc2dba32010-02-16 04:49:44 +00001056 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1057
Anders Carlssond46ed892010-02-27 16:18:19 +00001058 /// PrimaryVirtualBases - All known virtual bases who are a primary base of
Anders Carlsson0570f712010-02-23 03:48:14 +00001059 /// some other base.
1060 VisitedVirtualBasesSetTy PrimaryVirtualBases;
1061
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001062 /// ComputeReturnAdjustment - Compute the return adjustment given a return
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001063 /// adjustment base offset.
Anders Carlsson075056a2010-02-23 01:34:28 +00001064 ReturnAdjustment ComputeReturnAdjustment(BaseOffset Offset);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001065
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001066 /// ComputeThisAdjustmentBaseOffset - Compute the base offset for adjusting
1067 /// the 'this' pointer from the base subobject to the derived subobject.
1068 BaseOffset ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
1069 BaseSubobject Derived) const;
1070
Anders Carlsson78277c72010-02-18 17:00:09 +00001071 /// ComputeThisAdjustment - Compute the 'this' pointer adjustment for the
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001072 /// given virtual member function, its offset in the layout class and its
1073 /// final overrider.
1074 ThisAdjustment
1075 ComputeThisAdjustment(const CXXMethodDecl *MD,
Ken Dyckf736d9c2011-03-27 19:03:44 +00001076 CharUnits BaseOffsetInLayoutClass,
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001077 FinalOverriders::OverriderInfo Overrider);
1078
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001079 /// AddMethod - Add a single virtual member function to the vtable
1080 /// components vector.
Anders Carlsson40687982010-02-27 16:52:49 +00001081 void AddMethod(const CXXMethodDecl *MD, ReturnAdjustment ReturnAdjustment);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001082
Anders Carlssona8796c62010-02-23 04:26:39 +00001083 /// IsOverriderUsed - Returns whether the overrider will ever be used in this
1084 /// part of the vtable.
1085 ///
1086 /// Itanium C++ ABI 2.5.2:
1087 ///
1088 /// struct A { virtual void f(); };
1089 /// struct B : virtual public A { int i; };
1090 /// struct C : virtual public A { int j; };
1091 /// struct D : public B, public C {};
1092 ///
1093 /// When B and C are declared, A is a primary base in each case, so although
1094 /// vcall offsets are allocated in the A-in-B and A-in-C vtables, no this
1095 /// adjustment is required and no thunk is generated. However, inside D
1096 /// objects, A is no longer a primary base of C, so if we allowed calls to
1097 /// C::f() to use the copy of A's vtable in the C subobject, we would need
1098 /// to adjust this from C* to B::A*, which would require a third-party
1099 /// thunk. Since we require that a call to C::f() first convert to A*,
1100 /// C-in-D's copy of A's vtable is never referenced, so this is not
1101 /// necessary.
Anders Carlsson804cf512010-03-10 06:51:42 +00001102 bool IsOverriderUsed(const CXXMethodDecl *Overrider,
1103 uint64_t BaseOffsetInLayoutClass,
1104 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1105 uint64_t FirstBaseOffsetInLayoutClass) const;
1106
Anders Carlssona8796c62010-02-23 04:26:39 +00001107
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001108 /// AddMethods - Add the methods of this base subobject and all its
1109 /// primary bases to the vtable components vector.
Ken Dyckf4be03a2011-03-27 19:15:11 +00001110 void AddMethods(BaseSubobject Base, CharUnits BaseOffsetInLayoutClass,
Anders Carlsson804cf512010-03-10 06:51:42 +00001111 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
Ken Dyckf4be03a2011-03-27 19:15:11 +00001112 CharUnits FirstBaseOffsetInLayoutClass,
Anders Carlssond46ed892010-02-27 16:18:19 +00001113 PrimaryBasesSetVectorTy &PrimaryBases);
Anders Carlssonb716a542010-02-16 16:26:28 +00001114
Anders Carlssond78b2242010-04-11 22:07:06 +00001115 // LayoutVTable - Layout the vtable for the given base class, including its
Anders Carlssonb716a542010-02-16 16:26:28 +00001116 // secondary vtables and any vtables for virtual bases.
Anders Carlssond78b2242010-04-11 22:07:06 +00001117 void LayoutVTable();
Anders Carlssonb716a542010-02-16 16:26:28 +00001118
Anders Carlssond78b2242010-04-11 22:07:06 +00001119 /// LayoutPrimaryAndSecondaryVTables - Layout the primary vtable for the
Anders Carlssonb716a542010-02-16 16:26:28 +00001120 /// given base subobject, as well as all its secondary vtables.
Anders Carlssonb41c6332010-04-11 22:03:57 +00001121 ///
Anders Carlsson3383e2a2010-04-11 22:20:36 +00001122 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
1123 /// or a direct or indirect base of a virtual base.
1124 ///
Anders Carlssonb41c6332010-04-11 22:03:57 +00001125 /// \param BaseIsVirtualInLayoutClass - Whether the base subobject is virtual
1126 /// in the layout class.
Anders Carlssond78b2242010-04-11 22:07:06 +00001127 void LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
Anders Carlsson3383e2a2010-04-11 22:20:36 +00001128 bool BaseIsMorallyVirtual,
Anders Carlssonb41c6332010-04-11 22:03:57 +00001129 bool BaseIsVirtualInLayoutClass,
Ken Dyckf9742cc2011-03-27 20:33:38 +00001130 CharUnits OffsetInLayoutClass);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001131
Anders Carlssond78b2242010-04-11 22:07:06 +00001132 /// LayoutSecondaryVTables - Layout the secondary vtables for the given base
Anders Carlsson14157932010-02-16 16:02:57 +00001133 /// subobject.
Anders Carlsson115b4752010-03-10 19:39:11 +00001134 ///
1135 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
1136 /// or a direct or indirect base of a virtual base.
Anders Carlssond78b2242010-04-11 22:07:06 +00001137 void LayoutSecondaryVTables(BaseSubobject Base, bool BaseIsMorallyVirtual,
Ken Dyck45956a42011-03-30 00:50:28 +00001138 CharUnits OffsetInLayoutClass);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001139
1140 /// DeterminePrimaryVirtualBases - Determine the primary virtual bases in this
1141 /// class hierarchy.
1142 void DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Ken Dyck032a9032011-03-30 01:10:23 +00001143 CharUnits OffsetInLayoutClass,
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001144 VisitedVirtualBasesSetTy &VBases);
1145
Anders Carlssond78b2242010-04-11 22:07:06 +00001146 /// LayoutVTablesForVirtualBases - Layout vtables for all virtual bases of the
Anders Carlsson13f0f662010-02-16 16:49:35 +00001147 /// given base (excluding any primary bases).
Anders Carlssond78b2242010-04-11 22:07:06 +00001148 void LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson13f0f662010-02-16 16:49:35 +00001149 VisitedVirtualBasesSetTy &VBases);
1150
Anders Carlssond78b2242010-04-11 22:07:06 +00001151 /// isBuildingConstructionVTable - Return whether this vtable builder is
Anders Carlsson31f595f2010-02-28 00:10:58 +00001152 /// building a construction vtable.
Anders Carlssond78b2242010-04-11 22:07:06 +00001153 bool isBuildingConstructorVTable() const {
Anders Carlsson31f595f2010-02-28 00:10:58 +00001154 return MostDerivedClass != LayoutClass;
1155 }
1156
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001157public:
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001158 VTableBuilder(CodeGenVTables &VTables, const CXXRecordDecl *MostDerivedClass,
Ken Dyck9a7e5322011-03-27 20:20:28 +00001159 CharUnits MostDerivedClassOffset,
1160 bool MostDerivedClassIsVirtual, const
1161 CXXRecordDecl *LayoutClass)
Anders Carlssona864caf2010-03-23 04:11:45 +00001162 : VTables(VTables), MostDerivedClass(MostDerivedClass),
Anders Carlsson62c6c722010-02-28 00:36:23 +00001163 MostDerivedClassOffset(MostDerivedClassOffset),
1164 MostDerivedClassIsVirtual(MostDerivedClassIsVirtual),
1165 LayoutClass(LayoutClass), Context(MostDerivedClass->getASTContext()),
Ken Dyck9a7e5322011-03-27 20:20:28 +00001166 Overriders(MostDerivedClass, MostDerivedClassOffset, LayoutClass) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001167
Anders Carlssond78b2242010-04-11 22:07:06 +00001168 LayoutVTable();
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001169 }
1170
Anders Carlsson5c5abad2010-03-23 16:36:50 +00001171 ThunksMapTy::const_iterator thunks_begin() const {
1172 return Thunks.begin();
1173 }
1174
1175 ThunksMapTy::const_iterator thunks_end() const {
1176 return Thunks.end();
1177 }
1178
Anders Carlssone90954d2010-03-24 16:42:11 +00001179 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
1180 return VBaseOffsetOffsets;
1181 }
1182
1183 /// getNumVTableComponents - Return the number of components in the vtable
1184 /// currently built.
1185 uint64_t getNumVTableComponents() const {
1186 return Components.size();
1187 }
1188
Anders Carlssond03325c2010-03-25 00:51:13 +00001189 const uint64_t *vtable_components_data_begin() const {
Anders Carlssone90954d2010-03-24 16:42:11 +00001190 return reinterpret_cast<const uint64_t *>(Components.begin());
1191 }
1192
Anders Carlssond03325c2010-03-25 00:51:13 +00001193 const uint64_t *vtable_components_data_end() const {
Anders Carlssone90954d2010-03-24 16:42:11 +00001194 return reinterpret_cast<const uint64_t *>(Components.end());
1195 }
1196
Anders Carlssond03325c2010-03-25 00:51:13 +00001197 AddressPointsMapTy::const_iterator address_points_begin() const {
1198 return AddressPoints.begin();
1199 }
1200
1201 AddressPointsMapTy::const_iterator address_points_end() const {
1202 return AddressPoints.end();
1203 }
1204
Anders Carlssond78b2242010-04-11 22:07:06 +00001205 VTableThunksMapTy::const_iterator vtable_thunks_begin() const {
Anders Carlssona4147142010-03-25 15:26:28 +00001206 return VTableThunks.begin();
1207 }
1208
Anders Carlssond78b2242010-04-11 22:07:06 +00001209 VTableThunksMapTy::const_iterator vtable_thunks_end() const {
Anders Carlssona4147142010-03-25 15:26:28 +00001210 return VTableThunks.end();
1211 }
1212
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001213 /// dumpLayout - Dump the vtable layout.
1214 void dumpLayout(llvm::raw_ostream&);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001215};
1216
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001217void VTableBuilder::AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk) {
Anders Carlssond78b2242010-04-11 22:07:06 +00001218 assert(!isBuildingConstructorVTable() &&
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001219 "Can't add thunks for construction vtable");
Anders Carlsson18c582d2010-03-18 02:44:19 +00001220
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001221 llvm::SmallVector<ThunkInfo, 1> &ThunksVector = Thunks[MD];
Anders Carlsson56446142010-03-17 20:06:32 +00001222
1223 // Check if we have this thunk already.
1224 if (std::find(ThunksVector.begin(), ThunksVector.end(), Thunk) !=
1225 ThunksVector.end())
1226 return;
1227
1228 ThunksVector.push_back(Thunk);
1229}
1230
Anders Carlsson88cf34f2010-04-10 20:39:29 +00001231typedef llvm::SmallPtrSet<const CXXMethodDecl *, 8> OverriddenMethodsSetTy;
1232
1233/// ComputeAllOverriddenMethods - Given a method decl, will return a set of all
1234/// the overridden methods that the function decl overrides.
1235static void
1236ComputeAllOverriddenMethods(const CXXMethodDecl *MD,
1237 OverriddenMethodsSetTy& OverriddenMethods) {
1238 assert(MD->isVirtual() && "Method is not virtual!");
1239
Anders Carlsson65b49782010-02-12 05:25:12 +00001240 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1241 E = MD->end_overridden_methods(); I != E; ++I) {
1242 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlsson65b49782010-02-12 05:25:12 +00001243
Anders Carlsson88cf34f2010-04-10 20:39:29 +00001244 OverriddenMethods.insert(OverriddenMD);
1245
1246 ComputeAllOverriddenMethods(OverriddenMD, OverriddenMethods);
Anders Carlsson65b49782010-02-12 05:25:12 +00001247 }
Anders Carlsson65b49782010-02-12 05:25:12 +00001248}
1249
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001250void VTableBuilder::ComputeThisAdjustments() {
Anders Carlsson40687982010-02-27 16:52:49 +00001251 // Now go through the method info map and see if any of the methods need
1252 // 'this' pointer adjustments.
1253 for (MethodInfoMapTy::const_iterator I = MethodInfoMap.begin(),
1254 E = MethodInfoMap.end(); I != E; ++I) {
1255 const CXXMethodDecl *MD = I->first;
1256 const MethodInfo &MethodInfo = I->second;
1257
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001258 // Ignore adjustments for unused function pointers.
Anders Carlssond78b2242010-04-11 22:07:06 +00001259 uint64_t VTableIndex = MethodInfo.VTableIndex;
1260 if (Components[VTableIndex].getKind() ==
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001261 VTableComponent::CK_UnusedFunctionPointer)
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001262 continue;
1263
Anders Carlsson40687982010-02-27 16:52:49 +00001264 // Get the final overrider for this method.
1265 FinalOverriders::OverriderInfo Overrider =
Ken Dyck7d876f32011-03-27 18:57:53 +00001266 Overriders.getOverrider(MD, MethodInfo.BaseOffset);
Anders Carlsson40687982010-02-27 16:52:49 +00001267
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001268 // Check if we need an adjustment at all.
Ken Dyck7d876f32011-03-27 18:57:53 +00001269 if (MethodInfo.BaseOffsetInLayoutClass == Overrider.Offset) {
Anders Carlssoneba1a602010-03-29 15:08:41 +00001270 // When a return thunk is needed by a derived class that overrides a
1271 // virtual base, gcc uses a virtual 'this' adjustment as well.
1272 // While the thunk itself might be needed by vtables in subclasses or
1273 // in construction vtables, there doesn't seem to be a reason for using
1274 // the thunk in this vtable. Still, we do so to match gcc.
Anders Carlssond78b2242010-04-11 22:07:06 +00001275 if (VTableThunks.lookup(VTableIndex).Return.isEmpty())
Anders Carlssoneba1a602010-03-29 15:08:41 +00001276 continue;
1277 }
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001278
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001279 ThisAdjustment ThisAdjustment =
Ken Dyckf736d9c2011-03-27 19:03:44 +00001280 ComputeThisAdjustment(MD, MethodInfo.BaseOffsetInLayoutClass, Overrider);
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001281
1282 if (ThisAdjustment.isEmpty())
Anders Carlsson40687982010-02-27 16:52:49 +00001283 continue;
Anders Carlsson40687982010-02-27 16:52:49 +00001284
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001285 // Add it.
Anders Carlssond78b2242010-04-11 22:07:06 +00001286 VTableThunks[VTableIndex].This = ThisAdjustment;
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001287
Anders Carlsson40687982010-02-27 16:52:49 +00001288 if (isa<CXXDestructorDecl>(MD)) {
1289 // Add an adjustment for the deleting destructor as well.
Anders Carlssond78b2242010-04-11 22:07:06 +00001290 VTableThunks[VTableIndex + 1].This = ThisAdjustment;
Anders Carlsson40687982010-02-27 16:52:49 +00001291 }
1292 }
1293
1294 /// Clear the method info map.
1295 MethodInfoMap.clear();
Anders Carlsson64decd32010-03-22 15:47:01 +00001296
Anders Carlssond78b2242010-04-11 22:07:06 +00001297 if (isBuildingConstructorVTable()) {
Anders Carlsson64decd32010-03-22 15:47:01 +00001298 // We don't need to store thunk information for construction vtables.
1299 return;
1300 }
1301
Anders Carlssond78b2242010-04-11 22:07:06 +00001302 for (VTableThunksMapTy::const_iterator I = VTableThunks.begin(),
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001303 E = VTableThunks.end(); I != E; ++I) {
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001304 const VTableComponent &Component = Components[I->first];
Anders Carlsson64decd32010-03-22 15:47:01 +00001305 const ThunkInfo &Thunk = I->second;
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001306 const CXXMethodDecl *MD;
Anders Carlsson64decd32010-03-22 15:47:01 +00001307
1308 switch (Component.getKind()) {
1309 default:
1310 llvm_unreachable("Unexpected vtable component kind!");
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001311 case VTableComponent::CK_FunctionPointer:
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001312 MD = Component.getFunctionDecl();
Anders Carlsson64decd32010-03-22 15:47:01 +00001313 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001314 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001315 MD = Component.getDestructorDecl();
Anders Carlsson64decd32010-03-22 15:47:01 +00001316 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001317 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlsson64decd32010-03-22 15:47:01 +00001318 // We've already added the thunk when we saw the complete dtor pointer.
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001319 continue;
Anders Carlsson64decd32010-03-22 15:47:01 +00001320 }
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001321
1322 if (MD->getParent() == MostDerivedClass)
1323 AddThunk(MD, Thunk);
Anders Carlsson64decd32010-03-22 15:47:01 +00001324 }
Anders Carlsson40687982010-02-27 16:52:49 +00001325}
1326
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001327ReturnAdjustment VTableBuilder::ComputeReturnAdjustment(BaseOffset Offset) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001328 ReturnAdjustment Adjustment;
1329
1330 if (!Offset.isEmpty()) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001331 if (Offset.VirtualBase) {
1332 // Get the virtual base offset offset.
Anders Carlssone4424882010-03-11 07:00:45 +00001333 if (Offset.DerivedClass == MostDerivedClass) {
1334 // We can get the offset offset directly from our map.
1335 Adjustment.VBaseOffsetOffset =
1336 VBaseOffsetOffsets.lookup(Offset.VirtualBase);
1337 } else {
1338 Adjustment.VBaseOffsetOffset =
Anders Carlssona864caf2010-03-23 04:11:45 +00001339 VTables.getVirtualBaseOffsetOffset(Offset.DerivedClass,
1340 Offset.VirtualBase);
Anders Carlssone4424882010-03-11 07:00:45 +00001341 }
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001342 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001343
1344 Adjustment.NonVirtual = Offset.NonVirtualOffset;
1345 }
1346
1347 return Adjustment;
1348}
1349
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001350BaseOffset
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001351VTableBuilder::ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001352 BaseSubobject Derived) const {
1353 const CXXRecordDecl *BaseRD = Base.getBase();
1354 const CXXRecordDecl *DerivedRD = Derived.getBase();
1355
1356 CXXBasePaths Paths(/*FindAmbiguities=*/true,
1357 /*RecordPaths=*/true, /*DetectVirtual=*/true);
1358
1359 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
1360 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
1361 assert(false && "Class must be derived from the passed in base class!");
1362 return BaseOffset();
1363 }
1364
1365 // We have to go through all the paths, and see which one leads us to the
1366 // right base subobject.
1367 for (CXXBasePaths::const_paths_iterator I = Paths.begin(), E = Paths.end();
1368 I != E; ++I) {
1369 BaseOffset Offset = ComputeBaseOffset(Context, DerivedRD, *I);
1370
Ken Dyckce812032011-03-26 00:51:24 +00001371 CharUnits OffsetToBaseSubobject =
1372 CharUnits::fromQuantity(Offset.NonVirtualOffset);
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001373
1374 if (Offset.VirtualBase) {
1375 // If we have a virtual base class, the non-virtual offset is relative
1376 // to the virtual base class offset.
Anders Carlsson423406f32010-03-10 21:25:37 +00001377 const ASTRecordLayout &LayoutClassLayout =
1378 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001379
1380 /// Get the virtual base offset, relative to the most derived class
1381 /// layout.
1382 OffsetToBaseSubobject +=
Ken Dyckce812032011-03-26 00:51:24 +00001383 LayoutClassLayout.getVBaseClassOffset(Offset.VirtualBase);
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001384 } else {
1385 // Otherwise, the non-virtual offset is relative to the derived class
1386 // offset.
Ken Dyckce812032011-03-26 00:51:24 +00001387 OffsetToBaseSubobject += Derived.getBaseOffset();
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001388 }
1389
1390 // Check if this path gives us the right base subobject.
Ken Dyckce812032011-03-26 00:51:24 +00001391 if (OffsetToBaseSubobject == Base.getBaseOffset()) {
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001392 // Since we're going from the base class _to_ the derived class, we'll
1393 // invert the non-virtual offset here.
1394 Offset.NonVirtualOffset = -Offset.NonVirtualOffset;
1395 return Offset;
1396 }
1397 }
1398
1399 return BaseOffset();
1400}
1401
Anders Carlsson67fd3a50d2010-03-23 15:13:06 +00001402ThisAdjustment
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001403VTableBuilder::ComputeThisAdjustment(const CXXMethodDecl *MD,
Ken Dyckf736d9c2011-03-27 19:03:44 +00001404 CharUnits BaseOffsetInLayoutClass,
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001405 FinalOverriders::OverriderInfo Overrider) {
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001406 // Ignore adjustments for pure virtual member functions.
1407 if (Overrider.Method->isPure())
1408 return ThisAdjustment();
1409
Ken Dyckf736d9c2011-03-27 19:03:44 +00001410 BaseSubobject OverriddenBaseSubobject(MD->getParent(),
1411 BaseOffsetInLayoutClass);
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001412
1413 BaseSubobject OverriderBaseSubobject(Overrider.Method->getParent(),
Ken Dyck785cbdb2011-03-26 01:29:16 +00001414 Overrider.Offset);
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001415
1416 // Compute the adjustment offset.
1417 BaseOffset Offset = ComputeThisAdjustmentBaseOffset(OverriddenBaseSubobject,
1418 OverriderBaseSubobject);
1419 if (Offset.isEmpty())
1420 return ThisAdjustment();
1421
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001422 ThisAdjustment Adjustment;
1423
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001424 if (Offset.VirtualBase) {
1425 // Get the vcall offset map for this virtual base.
1426 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Offset.VirtualBase];
Anders Carlsson8847d9e2010-02-18 17:26:40 +00001427
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001428 if (VCallOffsets.empty()) {
1429 // We don't have vcall offsets for this virtual base, go ahead and
1430 // build them.
1431 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, MostDerivedClass,
1432 /*FinalOverriders=*/0,
Ken Dyck16ffcac2011-03-24 01:21:01 +00001433 BaseSubobject(Offset.VirtualBase,
1434 CharUnits::Zero()),
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001435 /*BaseIsVirtual=*/true,
Ken Dyck1a93b3b2011-03-31 00:48:04 +00001436 /*OffsetInLayoutClass=*/
1437 CharUnits::Zero());
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001438
1439 VCallOffsets = Builder.getVCallOffsets();
1440 }
1441
1442 Adjustment.VCallOffsetOffset = VCallOffsets.getVCallOffsetOffset(MD);
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001443 }
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001444
1445 // Set the non-virtual part of the adjustment.
1446 Adjustment.NonVirtual = Offset.NonVirtualOffset;
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001447
1448 return Adjustment;
1449}
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001450
Anders Carlsson65b49782010-02-12 05:25:12 +00001451void
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001452VTableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlsson40687982010-02-27 16:52:49 +00001453 ReturnAdjustment ReturnAdjustment) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001454 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1455 assert(ReturnAdjustment.isEmpty() &&
1456 "Destructor can't have return adjustment!");
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001457
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001458 // Add both the complete destructor and the deleting destructor.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001459 Components.push_back(VTableComponent::MakeCompleteDtor(DD));
1460 Components.push_back(VTableComponent::MakeDeletingDtor(DD));
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001461 } else {
1462 // Add the return adjustment if necessary.
1463 if (!ReturnAdjustment.isEmpty())
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001464 VTableThunks[Components.size()].Return = ReturnAdjustment;
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001465
1466 // Add the function.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001467 Components.push_back(VTableComponent::MakeFunction(MD));
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001468 }
1469}
1470
Anders Carlssond2025412010-02-27 06:38:03 +00001471/// OverridesIndirectMethodInBase - Return whether the given member function
1472/// overrides any methods in the set of given bases.
1473/// Unlike OverridesMethodInBase, this checks "overriders of overriders".
1474/// For example, if we have:
1475///
1476/// struct A { virtual void f(); }
1477/// struct B : A { virtual void f(); }
1478/// struct C : B { virtual void f(); }
1479///
1480/// OverridesIndirectMethodInBase will return true if given C::f as the method
Anders Carlsson88cf34f2010-04-10 20:39:29 +00001481/// and { A } as the set of bases.
Anders Carlssond2025412010-02-27 06:38:03 +00001482static bool
1483OverridesIndirectMethodInBases(const CXXMethodDecl *MD,
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001484 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssonc6db5ab2010-04-17 17:24:33 +00001485 if (Bases.count(MD->getParent()))
1486 return true;
1487
Anders Carlssond2025412010-02-27 06:38:03 +00001488 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1489 E = MD->end_overridden_methods(); I != E; ++I) {
1490 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlssond2025412010-02-27 06:38:03 +00001491
1492 // Check "indirect overriders".
1493 if (OverridesIndirectMethodInBases(OverriddenMD, Bases))
1494 return true;
1495 }
1496
1497 return false;
1498}
1499
Anders Carlssona8796c62010-02-23 04:26:39 +00001500bool
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001501VTableBuilder::IsOverriderUsed(const CXXMethodDecl *Overrider,
Anders Carlsson804cf512010-03-10 06:51:42 +00001502 uint64_t BaseOffsetInLayoutClass,
1503 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1504 uint64_t FirstBaseOffsetInLayoutClass) const {
Anders Carlssona8796c62010-02-23 04:26:39 +00001505 // If the base and the first base in the primary base chain have the same
1506 // offsets, then this overrider will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001507 if (BaseOffsetInLayoutClass == FirstBaseOffsetInLayoutClass)
Anders Carlsson8939e402010-02-23 06:34:44 +00001508 return true;
1509
1510 // We know now that Base (or a direct or indirect base of it) is a primary
1511 // base in part of the class hierarchy, but not a primary base in the most
1512 // derived class.
1513
1514 // If the overrider is the first base in the primary base chain, we know
1515 // that the overrider will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001516 if (Overrider->getParent() == FirstBaseInPrimaryBaseChain)
Anders Carlssona8796c62010-02-23 04:26:39 +00001517 return true;
1518
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001519 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlsson8939e402010-02-23 06:34:44 +00001520
Anders Carlsson804cf512010-03-10 06:51:42 +00001521 const CXXRecordDecl *RD = FirstBaseInPrimaryBaseChain;
Anders Carlsson8939e402010-02-23 06:34:44 +00001522 PrimaryBases.insert(RD);
1523
1524 // Now traverse the base chain, starting with the first base, until we find
1525 // the base that is no longer a primary base.
1526 while (true) {
1527 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1528 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1529
1530 if (!PrimaryBase)
1531 break;
1532
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001533 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssonfd88a612010-10-31 23:22:37 +00001534 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson8939e402010-02-23 06:34:44 +00001535 "Primary base should always be at offset 0!");
1536
Anders Carlsson7162ab92010-02-28 18:37:33 +00001537 const ASTRecordLayout &LayoutClassLayout =
1538 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson8939e402010-02-23 06:34:44 +00001539
1540 // Now check if this is the primary base that is not a primary base in the
1541 // most derived class.
Anders Carlssonfd88a612010-10-31 23:22:37 +00001542 if (LayoutClassLayout.getVBaseClassOffsetInBits(PrimaryBase) !=
Anders Carlsson804cf512010-03-10 06:51:42 +00001543 FirstBaseOffsetInLayoutClass) {
Anders Carlsson8939e402010-02-23 06:34:44 +00001544 // We found it, stop walking the chain.
1545 break;
1546 }
1547 } else {
Anders Carlssonfd88a612010-10-31 23:22:37 +00001548 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson8939e402010-02-23 06:34:44 +00001549 "Primary base should always be at offset 0!");
1550 }
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001551
Anders Carlssonb26c2ab2010-02-27 19:51:04 +00001552 if (!PrimaryBases.insert(PrimaryBase))
1553 assert(false && "Found a duplicate primary base!");
1554
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001555 RD = PrimaryBase;
Anders Carlsson8939e402010-02-23 06:34:44 +00001556 }
1557
1558 // If the final overrider is an override of one of the primary bases,
1559 // then we know that it will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001560 return OverridesIndirectMethodInBases(Overrider, PrimaryBases);
Anders Carlssona8796c62010-02-23 04:26:39 +00001561}
1562
Anders Carlsson40687982010-02-27 16:52:49 +00001563/// FindNearestOverriddenMethod - Given a method, returns the overridden method
1564/// from the nearest base. Returns null if no method was found.
1565static const CXXMethodDecl *
1566FindNearestOverriddenMethod(const CXXMethodDecl *MD,
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001567 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlsson88cf34f2010-04-10 20:39:29 +00001568 OverriddenMethodsSetTy OverriddenMethods;
1569 ComputeAllOverriddenMethods(MD, OverriddenMethods);
1570
Anders Carlsson40687982010-02-27 16:52:49 +00001571 for (int I = Bases.size(), E = 0; I != E; --I) {
1572 const CXXRecordDecl *PrimaryBase = Bases[I - 1];
1573
1574 // Now check the overriden methods.
Anders Carlsson88cf34f2010-04-10 20:39:29 +00001575 for (OverriddenMethodsSetTy::const_iterator I = OverriddenMethods.begin(),
1576 E = OverriddenMethods.end(); I != E; ++I) {
Anders Carlsson40687982010-02-27 16:52:49 +00001577 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlsson88cf34f2010-04-10 20:39:29 +00001578
Anders Carlsson40687982010-02-27 16:52:49 +00001579 // We found our overridden method.
1580 if (OverriddenMD->getParent() == PrimaryBase)
1581 return OverriddenMD;
1582 }
1583 }
1584
1585 return 0;
1586}
1587
Anders Carlsson804cf512010-03-10 06:51:42 +00001588void
Ken Dyckf4be03a2011-03-27 19:15:11 +00001589VTableBuilder::AddMethods(BaseSubobject Base, CharUnits BaseOffsetInLayoutClass,
Anders Carlsson804cf512010-03-10 06:51:42 +00001590 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
Ken Dyckf4be03a2011-03-27 19:15:11 +00001591 CharUnits FirstBaseOffsetInLayoutClass,
Anders Carlssond46ed892010-02-27 16:18:19 +00001592 PrimaryBasesSetVectorTy &PrimaryBases) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001593 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001594 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1595
1596 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Ken Dyckce812032011-03-26 00:51:24 +00001597 CharUnits PrimaryBaseOffset;
Ken Dyckf4be03a2011-03-27 19:15:11 +00001598 CharUnits PrimaryBaseOffsetInLayoutClass;
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001599 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssonfd88a612010-10-31 23:22:37 +00001600 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson0570f712010-02-23 03:48:14 +00001601 "Primary vbase should have a zero offset!");
1602
1603 const ASTRecordLayout &MostDerivedClassLayout =
1604 Context.getASTRecordLayout(MostDerivedClass);
1605
Anders Carlsson804cf512010-03-10 06:51:42 +00001606 PrimaryBaseOffset =
Ken Dyckce812032011-03-26 00:51:24 +00001607 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson804cf512010-03-10 06:51:42 +00001608
1609 const ASTRecordLayout &LayoutClassLayout =
1610 Context.getASTRecordLayout(LayoutClass);
1611
1612 PrimaryBaseOffsetInLayoutClass =
Ken Dyckf4be03a2011-03-27 19:15:11 +00001613 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson0570f712010-02-23 03:48:14 +00001614 } else {
Anders Carlssonfd88a612010-10-31 23:22:37 +00001615 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson65b49782010-02-12 05:25:12 +00001616 "Primary base should have a zero offset!");
Anders Carlsson0570f712010-02-23 03:48:14 +00001617
Ken Dyckce812032011-03-26 00:51:24 +00001618 PrimaryBaseOffset = Base.getBaseOffset();
Anders Carlsson804cf512010-03-10 06:51:42 +00001619 PrimaryBaseOffsetInLayoutClass = BaseOffsetInLayoutClass;
Anders Carlsson0570f712010-02-23 03:48:14 +00001620 }
Anders Carlsson7162ab92010-02-28 18:37:33 +00001621
Ken Dyckce812032011-03-26 00:51:24 +00001622 AddMethods(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
Anders Carlsson804cf512010-03-10 06:51:42 +00001623 PrimaryBaseOffsetInLayoutClass, FirstBaseInPrimaryBaseChain,
1624 FirstBaseOffsetInLayoutClass, PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001625
1626 if (!PrimaryBases.insert(PrimaryBase))
1627 assert(false && "Found a duplicate primary base!");
1628 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001629
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001630 // Now go through all virtual member functions and add them.
1631 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1632 E = RD->method_end(); I != E; ++I) {
1633 const CXXMethodDecl *MD = *I;
Anders Carlsson65b49782010-02-12 05:25:12 +00001634
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001635 if (!MD->isVirtual())
1636 continue;
Anders Carlsson65b49782010-02-12 05:25:12 +00001637
1638 // Get the final overrider.
Anders Carlsson136bd192010-02-12 16:55:34 +00001639 FinalOverriders::OverriderInfo Overrider =
Ken Dyck808457c2011-03-26 01:18:17 +00001640 Overriders.getOverrider(MD, Base.getBaseOffset());
Anders Carlsson65b49782010-02-12 05:25:12 +00001641
1642 // Check if this virtual member function overrides a method in a primary
1643 // base. If this is the case, and the return type doesn't require adjustment
1644 // then we can just use the member function from the primary base.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001645 if (const CXXMethodDecl *OverriddenMD =
Anders Carlsson40687982010-02-27 16:52:49 +00001646 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +00001647 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
Anders Carlsson40687982010-02-27 16:52:49 +00001648 OverriddenMD).isEmpty()) {
1649 // Replace the method info of the overridden method with our own
1650 // method.
1651 assert(MethodInfoMap.count(OverriddenMD) &&
1652 "Did not find the overridden method!");
1653 MethodInfo &OverriddenMethodInfo = MethodInfoMap[OverriddenMD];
1654
Ken Dyckf4be03a2011-03-27 19:15:11 +00001655 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
1656 OverriddenMethodInfo.VTableIndex);
Anders Carlsson40687982010-02-27 16:52:49 +00001657
1658 assert(!MethodInfoMap.count(MD) &&
1659 "Should not have method info for this method yet!");
1660
1661 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
1662 MethodInfoMap.erase(OverriddenMD);
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001663
1664 // If the overridden method exists in a virtual base class or a direct
1665 // or indirect base class of a virtual base class, we need to emit a
1666 // thunk if we ever have a class hierarchy where the base class is not
1667 // a primary base in the complete object.
Anders Carlssond78b2242010-04-11 22:07:06 +00001668 if (!isBuildingConstructorVTable() && OverriddenMD != MD) {
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001669 // Compute the this adjustment.
1670 ThisAdjustment ThisAdjustment =
Ken Dyckf4be03a2011-03-27 19:15:11 +00001671 ComputeThisAdjustment(OverriddenMD, BaseOffsetInLayoutClass,
1672 Overrider);
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001673
Anders Carlsson800ded62010-03-29 02:53:58 +00001674 if (ThisAdjustment.VCallOffsetOffset &&
1675 Overrider.Method->getParent() == MostDerivedClass) {
John McCall47838252010-11-09 01:18:05 +00001676
1677 // There's no return adjustment from OverriddenMD and MD,
1678 // but that doesn't mean there isn't one between MD and
1679 // the final overrider.
1680 BaseOffset ReturnAdjustmentOffset =
1681 ComputeReturnAdjustmentBaseOffset(Context, Overrider.Method, MD);
1682 ReturnAdjustment ReturnAdjustment =
1683 ComputeReturnAdjustment(ReturnAdjustmentOffset);
1684
Anders Carlsson800ded62010-03-29 02:53:58 +00001685 // This is a virtual thunk for the most derived class, add it.
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001686 AddThunk(Overrider.Method,
John McCall47838252010-11-09 01:18:05 +00001687 ThunkInfo(ThisAdjustment, ReturnAdjustment));
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001688 }
1689 }
1690
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001691 continue;
Anders Carlsson40687982010-02-27 16:52:49 +00001692 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001693 }
Anders Carlssoneee53d92010-02-13 02:02:03 +00001694
Anders Carlsson40687982010-02-27 16:52:49 +00001695 // Insert the method info for this method.
Ken Dyckf4be03a2011-03-27 19:15:11 +00001696 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
Ken Dyck7d876f32011-03-27 18:57:53 +00001697 Components.size());
Anders Carlsson40687982010-02-27 16:52:49 +00001698
1699 assert(!MethodInfoMap.count(MD) &&
1700 "Should not have method info for this method yet!");
1701 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001702
1703 // Check if this overrider is going to be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001704 const CXXMethodDecl *OverriderMD = Overrider.Method;
Ken Dyckf4be03a2011-03-27 19:15:11 +00001705 if (!IsOverriderUsed(OverriderMD, Context.toBits(BaseOffsetInLayoutClass),
Anders Carlsson804cf512010-03-10 06:51:42 +00001706 FirstBaseInPrimaryBaseChain,
Ken Dyckf4be03a2011-03-27 19:15:11 +00001707 Context.toBits(FirstBaseOffsetInLayoutClass))) {
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001708 Components.push_back(VTableComponent::MakeUnusedFunction(OverriderMD));
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001709 continue;
1710 }
Anders Carlssona8796c62010-02-23 04:26:39 +00001711
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001712 // Check if this overrider needs a return adjustment.
Anders Carlsson042ce2d82010-06-01 23:47:05 +00001713 // We don't want to do this for pure virtual member functions.
1714 BaseOffset ReturnAdjustmentOffset;
1715 if (!OverriderMD->isPure()) {
1716 ReturnAdjustmentOffset =
1717 ComputeReturnAdjustmentBaseOffset(Context, OverriderMD, MD);
1718 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001719
1720 ReturnAdjustment ReturnAdjustment =
1721 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001722
Anders Carlsson40687982010-02-27 16:52:49 +00001723 AddMethod(Overrider.Method, ReturnAdjustment);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001724 }
1725}
1726
Anders Carlssond78b2242010-04-11 22:07:06 +00001727void VTableBuilder::LayoutVTable() {
Ken Dyck16ffcac2011-03-24 01:21:01 +00001728 LayoutPrimaryAndSecondaryVTables(BaseSubobject(MostDerivedClass,
1729 CharUnits::Zero()),
Anders Carlsson3383e2a2010-04-11 22:20:36 +00001730 /*BaseIsMorallyVirtual=*/false,
Anders Carlssone3385f52010-02-28 01:43:58 +00001731 MostDerivedClassIsVirtual,
Ken Dyckf9742cc2011-03-27 20:33:38 +00001732 MostDerivedClassOffset);
Anders Carlssonb716a542010-02-16 16:26:28 +00001733
Anders Carlsson13f0f662010-02-16 16:49:35 +00001734 VisitedVirtualBasesSetTy VBases;
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001735
1736 // Determine the primary virtual bases.
Ken Dyck032a9032011-03-30 01:10:23 +00001737 DeterminePrimaryVirtualBases(MostDerivedClass, MostDerivedClassOffset,
1738 VBases);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001739 VBases.clear();
1740
Anders Carlssond78b2242010-04-11 22:07:06 +00001741 LayoutVTablesForVirtualBases(MostDerivedClass, VBases);
Anders Carlssonb716a542010-02-16 16:26:28 +00001742}
1743
Anders Carlssone3385f52010-02-28 01:43:58 +00001744void
Anders Carlssond78b2242010-04-11 22:07:06 +00001745VTableBuilder::LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
Anders Carlsson3383e2a2010-04-11 22:20:36 +00001746 bool BaseIsMorallyVirtual,
Anders Carlssonb41c6332010-04-11 22:03:57 +00001747 bool BaseIsVirtualInLayoutClass,
Ken Dyckf9742cc2011-03-27 20:33:38 +00001748 CharUnits OffsetInLayoutClass) {
Chris Lattnerd2408f72010-02-17 21:42:34 +00001749 assert(Base.getBase()->isDynamicClass() && "class does not have a vtable!");
Anders Carlsson033d4862010-02-14 17:05:59 +00001750
Anders Carlsson77904f12010-02-16 04:59:55 +00001751 // Add vcall and vbase offsets for this vtable.
Anders Carlssone3385f52010-02-28 01:43:58 +00001752 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, LayoutClass, &Overriders,
Anders Carlssonb41c6332010-04-11 22:03:57 +00001753 Base, BaseIsVirtualInLayoutClass,
Ken Dyck1a93b3b2011-03-31 00:48:04 +00001754 OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +00001755 Components.append(Builder.components_begin(), Builder.components_end());
1756
Anders Carlsson9e3b3a32010-02-25 22:23:13 +00001757 // Check if we need to add these vcall offsets.
Anders Carlssonb41c6332010-04-11 22:03:57 +00001758 if (BaseIsVirtualInLayoutClass && !Builder.getVCallOffsets().empty()) {
Anders Carlsson9e3b3a32010-02-25 22:23:13 +00001759 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Base.getBase()];
1760
1761 if (VCallOffsets.empty())
1762 VCallOffsets = Builder.getVCallOffsets();
1763 }
1764
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001765 // If we're laying out the most derived class we want to keep track of the
1766 // virtual base class offset offsets.
1767 if (Base.getBase() == MostDerivedClass)
1768 VBaseOffsetOffsets = Builder.getVBaseOffsetOffsets();
1769
Anders Carlsson77904f12010-02-16 04:59:55 +00001770 // Add the offset to top.
Ken Dyckf9742cc2011-03-27 20:33:38 +00001771 CharUnits OffsetToTop = MostDerivedClassOffset - OffsetInLayoutClass;
1772 Components.push_back(
1773 VTableComponent::MakeOffsetToTop(OffsetToTop.getQuantity()));
Anders Carlsson65b49782010-02-12 05:25:12 +00001774
1775 // Next, add the RTTI.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001776 Components.push_back(VTableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson65b49782010-02-12 05:25:12 +00001777
Anders Carlssone8a97562010-02-12 07:43:48 +00001778 uint64_t AddressPoint = Components.size();
Anders Carlsson65b49782010-02-12 05:25:12 +00001779
1780 // Now go through all virtual member functions and add them.
Anders Carlssond46ed892010-02-27 16:18:19 +00001781 PrimaryBasesSetVectorTy PrimaryBases;
Ken Dyckf9742cc2011-03-27 20:33:38 +00001782 AddMethods(Base, OffsetInLayoutClass,
1783 Base.getBase(), OffsetInLayoutClass,
Anders Carlsson804cf512010-03-10 06:51:42 +00001784 PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001785
Anders Carlsson40687982010-02-27 16:52:49 +00001786 // Compute 'this' pointer adjustments.
1787 ComputeThisAdjustments();
1788
Anders Carlsson151b0622010-03-25 21:45:14 +00001789 // Add all address points.
1790 const CXXRecordDecl *RD = Base.getBase();
1791 while (true) {
Ken Dyck16ffcac2011-03-24 01:21:01 +00001792 AddressPoints.insert(std::make_pair(
Ken Dyckf9742cc2011-03-27 20:33:38 +00001793 BaseSubobject(RD, OffsetInLayoutClass),
Ken Dyck16ffcac2011-03-24 01:21:01 +00001794 AddressPoint));
Anders Carlsson151b0622010-03-25 21:45:14 +00001795
1796 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1797 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlssone8a97562010-02-12 07:43:48 +00001798
Anders Carlsson151b0622010-03-25 21:45:14 +00001799 if (!PrimaryBase)
1800 break;
1801
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001802 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlsson151b0622010-03-25 21:45:14 +00001803 // Check if this virtual primary base is a primary base in the layout
1804 // class. If it's not, we don't want to add it.
1805 const ASTRecordLayout &LayoutClassLayout =
1806 Context.getASTRecordLayout(LayoutClass);
1807
Ken Dyckf9742cc2011-03-27 20:33:38 +00001808 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
Anders Carlsson151b0622010-03-25 21:45:14 +00001809 OffsetInLayoutClass) {
1810 // We don't want to add this class (or any of its primary bases).
1811 break;
1812 }
1813 }
1814
1815 RD = PrimaryBase;
Anders Carlssone8a97562010-02-12 07:43:48 +00001816 }
1817
Anders Carlssona9f633b2010-02-24 16:43:12 +00001818 // Layout secondary vtables.
Ken Dyck45956a42011-03-30 00:50:28 +00001819 LayoutSecondaryVTables(Base, BaseIsMorallyVirtual, OffsetInLayoutClass);
Anders Carlsson14157932010-02-16 16:02:57 +00001820}
1821
Anders Carlssond78b2242010-04-11 22:07:06 +00001822void VTableBuilder::LayoutSecondaryVTables(BaseSubobject Base,
Anders Carlsson115b4752010-03-10 19:39:11 +00001823 bool BaseIsMorallyVirtual,
Ken Dyck45956a42011-03-30 00:50:28 +00001824 CharUnits OffsetInLayoutClass) {
Anders Carlsson14157932010-02-16 16:02:57 +00001825 // Itanium C++ ABI 2.5.2:
1826 // Following the primary virtual table of a derived class are secondary
1827 // virtual tables for each of its proper base classes, except any primary
1828 // base(s) with which it shares its primary virtual table.
1829
1830 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001831 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1832 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson14157932010-02-16 16:02:57 +00001833
Anders Carlsson65b49782010-02-12 05:25:12 +00001834 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1835 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson14157932010-02-16 16:02:57 +00001836 // Ignore virtual bases, we'll emit them later.
1837 if (I->isVirtual())
1838 continue;
1839
Anders Carlsson65b49782010-02-12 05:25:12 +00001840 const CXXRecordDecl *BaseDecl =
1841 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson033d4862010-02-14 17:05:59 +00001842
Anders Carlssondc2dba32010-02-16 04:49:44 +00001843 // Ignore bases that don't have a vtable.
1844 if (!BaseDecl->isDynamicClass())
1845 continue;
Anders Carlsson033d4862010-02-14 17:05:59 +00001846
Anders Carlssond78b2242010-04-11 22:07:06 +00001847 if (isBuildingConstructorVTable()) {
Anders Carlsson703a0862010-03-10 19:15:26 +00001848 // Itanium C++ ABI 2.6.4:
1849 // Some of the base class subobjects may not need construction virtual
1850 // tables, which will therefore not be present in the construction
1851 // virtual table group, even though the subobject virtual tables are
1852 // present in the main virtual table group for the complete object.
Anders Carlsson115b4752010-03-10 19:39:11 +00001853 if (!BaseIsMorallyVirtual && !BaseDecl->getNumVBases())
Anders Carlsson703a0862010-03-10 19:15:26 +00001854 continue;
Anders Carlsson703a0862010-03-10 19:15:26 +00001855 }
1856
Anders Carlssone75aaa92010-02-13 22:05:23 +00001857 // Get the base offset of this base.
Ken Dyckce812032011-03-26 00:51:24 +00001858 CharUnits RelativeBaseOffset = Layout.getBaseClassOffset(BaseDecl);
1859 CharUnits BaseOffset = Base.getBaseOffset() + RelativeBaseOffset;
Anders Carlssone3385f52010-02-28 01:43:58 +00001860
Ken Dyckce812032011-03-26 00:51:24 +00001861 CharUnits BaseOffsetInLayoutClass =
Ken Dyck45956a42011-03-30 00:50:28 +00001862 OffsetInLayoutClass + RelativeBaseOffset;
Anders Carlsson14157932010-02-16 16:02:57 +00001863
1864 // Don't emit a secondary vtable for a primary base. We might however want
1865 // to emit secondary vtables for other bases of this base.
1866 if (BaseDecl == PrimaryBase) {
Ken Dyck45956a42011-03-30 00:50:28 +00001867 LayoutSecondaryVTables(BaseSubobject(BaseDecl, BaseOffset),
1868 BaseIsMorallyVirtual, BaseOffsetInLayoutClass);
Anders Carlsson14157932010-02-16 16:02:57 +00001869 continue;
1870 }
Anders Carlssone75aaa92010-02-13 22:05:23 +00001871
Anders Carlssonb716a542010-02-16 16:26:28 +00001872 // Layout the primary vtable (and any secondary vtables) for this base.
Ken Dyck16ffcac2011-03-24 01:21:01 +00001873 LayoutPrimaryAndSecondaryVTables(
Ken Dyckce812032011-03-26 00:51:24 +00001874 BaseSubobject(BaseDecl, BaseOffset),
Ken Dyck16ffcac2011-03-24 01:21:01 +00001875 BaseIsMorallyVirtual,
1876 /*BaseIsVirtualInLayoutClass=*/false,
Ken Dyckf9742cc2011-03-27 20:33:38 +00001877 BaseOffsetInLayoutClass);
Anders Carlsson65b49782010-02-12 05:25:12 +00001878 }
1879}
1880
Anders Carlsson13f0f662010-02-16 16:49:35 +00001881void
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001882VTableBuilder::DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Ken Dyck032a9032011-03-30 01:10:23 +00001883 CharUnits OffsetInLayoutClass,
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001884 VisitedVirtualBasesSetTy &VBases) {
1885 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1886
1887 // Check if this base has a primary base.
1888 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson8b37bb72010-02-28 18:08:38 +00001889
1890 // Check if it's virtual.
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001891 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlsson8b37bb72010-02-28 18:08:38 +00001892 bool IsPrimaryVirtualBase = true;
1893
Anders Carlssond78b2242010-04-11 22:07:06 +00001894 if (isBuildingConstructorVTable()) {
Anders Carlsson8b37bb72010-02-28 18:08:38 +00001895 // Check if the base is actually a primary base in the class we use for
1896 // layout.
Anders Carlsson02b99d62010-03-10 03:02:01 +00001897 const ASTRecordLayout &LayoutClassLayout =
1898 Context.getASTRecordLayout(LayoutClass);
1899
Ken Dyck032a9032011-03-30 01:10:23 +00001900 CharUnits PrimaryBaseOffsetInLayoutClass =
1901 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson02b99d62010-03-10 03:02:01 +00001902
1903 // We know that the base is not a primary base in the layout class if
1904 // the base offsets are different.
1905 if (PrimaryBaseOffsetInLayoutClass != OffsetInLayoutClass)
Anders Carlsson8b37bb72010-02-28 18:08:38 +00001906 IsPrimaryVirtualBase = false;
1907 }
1908
1909 if (IsPrimaryVirtualBase)
1910 PrimaryVirtualBases.insert(PrimaryBase);
1911 }
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001912 }
1913
1914 // Traverse bases, looking for more primary virtual bases.
1915 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1916 E = RD->bases_end(); I != E; ++I) {
1917 const CXXRecordDecl *BaseDecl =
1918 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1919
Ken Dyck032a9032011-03-30 01:10:23 +00001920 CharUnits BaseOffsetInLayoutClass;
Anders Carlsson02b99d62010-03-10 03:02:01 +00001921
1922 if (I->isVirtual()) {
1923 if (!VBases.insert(BaseDecl))
1924 continue;
1925
1926 const ASTRecordLayout &LayoutClassLayout =
1927 Context.getASTRecordLayout(LayoutClass);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001928
Anders Carlssonfd88a612010-10-31 23:22:37 +00001929 BaseOffsetInLayoutClass =
Ken Dyck032a9032011-03-30 01:10:23 +00001930 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson02b99d62010-03-10 03:02:01 +00001931 } else {
1932 BaseOffsetInLayoutClass =
Ken Dyck032a9032011-03-30 01:10:23 +00001933 OffsetInLayoutClass + Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson02b99d62010-03-10 03:02:01 +00001934 }
1935
1936 DeterminePrimaryVirtualBases(BaseDecl, BaseOffsetInLayoutClass, VBases);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001937 }
1938}
1939
1940void
Anders Carlssond78b2242010-04-11 22:07:06 +00001941VTableBuilder::LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson13f0f662010-02-16 16:49:35 +00001942 VisitedVirtualBasesSetTy &VBases) {
1943 // Itanium C++ ABI 2.5.2:
1944 // Then come the virtual base virtual tables, also in inheritance graph
1945 // order, and again excluding primary bases (which share virtual tables with
1946 // the classes for which they are primary).
Anders Carlsson13f0f662010-02-16 16:49:35 +00001947 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1948 E = RD->bases_end(); I != E; ++I) {
1949 const CXXRecordDecl *BaseDecl =
1950 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1951
Anders Carlsson0570f712010-02-23 03:48:14 +00001952 // Check if this base needs a vtable. (If it's virtual, not a primary base
1953 // of some other class, and we haven't visited it before).
Anders Carlsson13f0f662010-02-16 16:49:35 +00001954 if (I->isVirtual() && BaseDecl->isDynamicClass() &&
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001955 !PrimaryVirtualBases.count(BaseDecl) && VBases.insert(BaseDecl)) {
Anders Carlsson13f0f662010-02-16 16:49:35 +00001956 const ASTRecordLayout &MostDerivedClassLayout =
1957 Context.getASTRecordLayout(MostDerivedClass);
Ken Dyck078f3e62011-03-30 01:14:22 +00001958 CharUnits BaseOffset =
1959 MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson13f0f662010-02-16 16:49:35 +00001960
Anders Carlssone3385f52010-02-28 01:43:58 +00001961 const ASTRecordLayout &LayoutClassLayout =
1962 Context.getASTRecordLayout(LayoutClass);
Ken Dyckf9742cc2011-03-27 20:33:38 +00001963 CharUnits BaseOffsetInLayoutClass =
1964 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlssone3385f52010-02-28 01:43:58 +00001965
Ken Dyck16ffcac2011-03-24 01:21:01 +00001966 LayoutPrimaryAndSecondaryVTables(
Ken Dyck078f3e62011-03-30 01:14:22 +00001967 BaseSubobject(BaseDecl, BaseOffset),
Ken Dyck16ffcac2011-03-24 01:21:01 +00001968 /*BaseIsMorallyVirtual=*/true,
1969 /*BaseIsVirtualInLayoutClass=*/true,
1970 BaseOffsetInLayoutClass);
Anders Carlsson13f0f662010-02-16 16:49:35 +00001971 }
1972
1973 // We only need to check the base for virtual base vtables if it actually
1974 // has virtual bases.
1975 if (BaseDecl->getNumVBases())
Anders Carlssond78b2242010-04-11 22:07:06 +00001976 LayoutVTablesForVirtualBases(BaseDecl, VBases);
Anders Carlsson13f0f662010-02-16 16:49:35 +00001977 }
1978}
1979
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001980/// dumpLayout - Dump the vtable layout.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001981void VTableBuilder::dumpLayout(llvm::raw_ostream& Out) {
Anders Carlsson93913752010-02-27 20:39:05 +00001982
Anders Carlssond78b2242010-04-11 22:07:06 +00001983 if (isBuildingConstructorVTable()) {
Anders Carlsson93913752010-02-27 20:39:05 +00001984 Out << "Construction vtable for ('";
1985 Out << MostDerivedClass->getQualifiedNameAsString() << "', ";
Ken Dyck9a7e5322011-03-27 20:20:28 +00001986 Out << MostDerivedClassOffset.getQuantity() << ") in '";
Anders Carlsson93913752010-02-27 20:39:05 +00001987 Out << LayoutClass->getQualifiedNameAsString();
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001988 } else {
1989 Out << "Vtable for '";
1990 Out << MostDerivedClass->getQualifiedNameAsString();
Anders Carlsson93913752010-02-27 20:39:05 +00001991 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001992 Out << "' (" << Components.size() << " entries).\n";
1993
Anders Carlsson932c2f22010-02-11 17:18:51 +00001994 // Iterate through the address points and insert them into a new map where
1995 // they are keyed by the index and not the base object.
1996 // Since an address point can be shared by multiple subobjects, we use an
1997 // STL multimap.
1998 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
Anders Carlsson0534b022010-03-25 00:35:49 +00001999 for (AddressPointsMapTy::const_iterator I = AddressPoints.begin(),
2000 E = AddressPoints.end(); I != E; ++I) {
Anders Carlsson932c2f22010-02-11 17:18:51 +00002001 const BaseSubobject& Base = I->first;
2002 uint64_t Index = I->second;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002003
Anders Carlsson932c2f22010-02-11 17:18:51 +00002004 AddressPointsByIndex.insert(std::make_pair(Index, Base));
2005 }
2006
2007 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlssone8a97562010-02-12 07:43:48 +00002008 uint64_t Index = I;
Anders Carlsson932c2f22010-02-11 17:18:51 +00002009
2010 Out << llvm::format("%4d | ", I);
2011
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002012 const VTableComponent &Component = Components[I];
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002013
2014 // Dump the component.
2015 switch (Component.getKind()) {
Anders Carlssonb0a588f2010-02-17 06:07:19 +00002016
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002017 case VTableComponent::CK_VCallOffset:
Anders Carlssonb0a588f2010-02-17 06:07:19 +00002018 Out << "vcall_offset (" << Component.getVCallOffset() << ")";
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002019 break;
Anders Carlsson77904f12010-02-16 04:59:55 +00002020
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002021 case VTableComponent::CK_VBaseOffset:
Anders Carlsson77904f12010-02-16 04:59:55 +00002022 Out << "vbase_offset (" << Component.getVBaseOffset() << ")";
2023 break;
2024
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002025 case VTableComponent::CK_OffsetToTop:
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002026 Out << "offset_to_top (" << Component.getOffsetToTop() << ")";
2027 break;
2028
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002029 case VTableComponent::CK_RTTI:
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002030 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
2031 break;
2032
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002033 case VTableComponent::CK_FunctionPointer: {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002034 const CXXMethodDecl *MD = Component.getFunctionDecl();
2035
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002036 std::string Str =
2037 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2038 MD);
2039 Out << Str;
Anders Carlsson09da3372010-02-12 02:38:13 +00002040 if (MD->isPure())
2041 Out << " [pure]";
2042
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002043 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlsson8a240292010-03-12 04:54:20 +00002044 if (!Thunk.isEmpty()) {
2045 // If this function pointer has a return adjustment, dump it.
2046 if (!Thunk.Return.isEmpty()) {
2047 Out << "\n [return adjustment: ";
2048 Out << Thunk.Return.NonVirtual << " non-virtual";
2049
2050 if (Thunk.Return.VBaseOffsetOffset) {
2051 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2052 Out << " vbase offset offset";
2053 }
Anders Carlsson78277c72010-02-18 17:00:09 +00002054
Anders Carlsson8a240292010-03-12 04:54:20 +00002055 Out << ']';
2056 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002057
Anders Carlsson8a240292010-03-12 04:54:20 +00002058 // If this function pointer has a 'this' pointer adjustment, dump it.
2059 if (!Thunk.This.isEmpty()) {
2060 Out << "\n [this adjustment: ";
2061 Out << Thunk.This.NonVirtual << " non-virtual";
2062
2063 if (Thunk.This.VCallOffsetOffset) {
2064 Out << ", " << Thunk.This.VCallOffsetOffset;
2065 Out << " vcall offset offset";
2066 }
Anders Carlsson78277c72010-02-18 17:00:09 +00002067
Anders Carlsson8a240292010-03-12 04:54:20 +00002068 Out << ']';
2069 }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00002070 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002071
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002072 break;
2073 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002074
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002075 case VTableComponent::CK_CompleteDtorPointer:
2076 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002077 bool IsComplete =
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002078 Component.getKind() == VTableComponent::CK_CompleteDtorPointer;
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002079
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002080 const CXXDestructorDecl *DD = Component.getDestructorDecl();
2081
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002082 Out << DD->getQualifiedNameAsString();
2083 if (IsComplete)
2084 Out << "() [complete]";
2085 else
2086 Out << "() [deleting]";
2087
Anders Carlsson09da3372010-02-12 02:38:13 +00002088 if (DD->isPure())
2089 Out << " [pure]";
2090
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002091 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlsson8a240292010-03-12 04:54:20 +00002092 if (!Thunk.isEmpty()) {
2093 // If this destructor has a 'this' pointer adjustment, dump it.
2094 if (!Thunk.This.isEmpty()) {
2095 Out << "\n [this adjustment: ";
2096 Out << Thunk.This.NonVirtual << " non-virtual";
2097
2098 if (Thunk.This.VCallOffsetOffset) {
2099 Out << ", " << Thunk.This.VCallOffsetOffset;
2100 Out << " vcall offset offset";
2101 }
2102
2103 Out << ']';
2104 }
2105 }
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002106
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002107 break;
2108 }
2109
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002110 case VTableComponent::CK_UnusedFunctionPointer: {
Anders Carlsson350b56e2010-02-19 20:08:13 +00002111 const CXXMethodDecl *MD = Component.getUnusedFunctionDecl();
2112
2113 std::string Str =
2114 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2115 MD);
2116 Out << "[unused] " << Str;
2117 if (MD->isPure())
2118 Out << " [pure]";
2119 }
2120
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002121 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00002122
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002123 Out << '\n';
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002124
2125 // Dump the next address point.
2126 uint64_t NextIndex = Index + 1;
2127 if (AddressPointsByIndex.count(NextIndex)) {
2128 if (AddressPointsByIndex.count(NextIndex) == 1) {
2129 const BaseSubobject &Base =
2130 AddressPointsByIndex.find(NextIndex)->second;
2131
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002132 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
Ken Dyck16ffcac2011-03-24 01:21:01 +00002133 Out << ", " << Base.getBaseOffset().getQuantity();
2134 Out << ") vtable address --\n";
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002135 } else {
Ken Dyckce812032011-03-26 00:51:24 +00002136 CharUnits BaseOffset =
2137 AddressPointsByIndex.lower_bound(NextIndex)->second.getBaseOffset();
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002138
2139 // We store the class names in a set to get a stable order.
2140 std::set<std::string> ClassNames;
2141 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
2142 AddressPointsByIndex.lower_bound(NextIndex), E =
2143 AddressPointsByIndex.upper_bound(NextIndex); I != E; ++I) {
Ken Dyckce812032011-03-26 00:51:24 +00002144 assert(I->second.getBaseOffset() == BaseOffset &&
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002145 "Invalid base offset!");
2146 const CXXRecordDecl *RD = I->second.getBase();
2147 ClassNames.insert(RD->getQualifiedNameAsString());
2148 }
2149
2150 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
2151 E = ClassNames.end(); I != E; ++I) {
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002152 Out << " -- (" << *I;
Ken Dyckce812032011-03-26 00:51:24 +00002153 Out << ", " << BaseOffset.getQuantity() << ") vtable address --\n";
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002154 }
2155 }
2156 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002157 }
Anders Carlsson93913752010-02-27 20:39:05 +00002158
2159 Out << '\n';
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002160
Anders Carlssond78b2242010-04-11 22:07:06 +00002161 if (isBuildingConstructorVTable())
Anders Carlsson18c582d2010-03-18 02:44:19 +00002162 return;
2163
2164 if (MostDerivedClass->getNumVBases()) {
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002165 // We store the virtual base class names and their offsets in a map to get
2166 // a stable order.
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002167
Anders Carlsson18c582d2010-03-18 02:44:19 +00002168 std::map<std::string, int64_t> ClassNamesAndOffsets;
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002169 for (VBaseOffsetOffsetsMapTy::const_iterator I = VBaseOffsetOffsets.begin(),
2170 E = VBaseOffsetOffsets.end(); I != E; ++I) {
2171 std::string ClassName = I->first->getQualifiedNameAsString();
2172 int64_t OffsetOffset = I->second;
2173 ClassNamesAndOffsets.insert(std::make_pair(ClassName, OffsetOffset));
2174 }
Anders Carlsson18c582d2010-03-18 02:44:19 +00002175
2176 Out << "Virtual base offset offsets for '";
2177 Out << MostDerivedClass->getQualifiedNameAsString() << "' (";
2178 Out << ClassNamesAndOffsets.size();
2179 Out << (ClassNamesAndOffsets.size() == 1 ? " entry" : " entries") << ").\n";
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002180
2181 for (std::map<std::string, int64_t>::const_iterator I =
2182 ClassNamesAndOffsets.begin(), E = ClassNamesAndOffsets.end();
2183 I != E; ++I)
2184 Out << " " << I->first << " | " << I->second << '\n';
2185
2186 Out << "\n";
2187 }
Anders Carlsson18c582d2010-03-18 02:44:19 +00002188
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002189 if (!Thunks.empty()) {
Anders Carlsson18c582d2010-03-18 02:44:19 +00002190 // We store the method names in a map to get a stable order.
2191 std::map<std::string, const CXXMethodDecl *> MethodNamesAndDecls;
2192
Anders Carlsson917229c2010-03-23 04:59:02 +00002193 for (ThunksMapTy::const_iterator I = Thunks.begin(), E = Thunks.end();
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002194 I != E; ++I) {
Anders Carlsson18c582d2010-03-18 02:44:19 +00002195 const CXXMethodDecl *MD = I->first;
2196 std::string MethodName =
2197 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2198 MD);
2199
2200 MethodNamesAndDecls.insert(std::make_pair(MethodName, MD));
2201 }
2202
2203 for (std::map<std::string, const CXXMethodDecl *>::const_iterator I =
2204 MethodNamesAndDecls.begin(), E = MethodNamesAndDecls.end();
2205 I != E; ++I) {
2206 const std::string &MethodName = I->first;
2207 const CXXMethodDecl *MD = I->second;
Anders Carlsson7eb99a62010-03-22 16:30:44 +00002208
Anders Carlsson917229c2010-03-23 04:59:02 +00002209 ThunkInfoVectorTy ThunksVector = Thunks[MD];
Anders Carlsson7eb99a62010-03-22 16:30:44 +00002210 std::sort(ThunksVector.begin(), ThunksVector.end());
Anders Carlsson18c582d2010-03-18 02:44:19 +00002211
2212 Out << "Thunks for '" << MethodName << "' (" << ThunksVector.size();
2213 Out << (ThunksVector.size() == 1 ? " entry" : " entries") << ").\n";
2214
2215 for (unsigned I = 0, E = ThunksVector.size(); I != E; ++I) {
2216 const ThunkInfo &Thunk = ThunksVector[I];
2217
2218 Out << llvm::format("%4d | ", I);
2219
Anders Carlsson53a47bf2010-03-22 16:10:59 +00002220 // If this function pointer has a return pointer adjustment, dump it.
2221 if (!Thunk.Return.isEmpty()) {
2222 Out << "return adjustment: " << Thunk.This.NonVirtual;
2223 Out << " non-virtual";
2224 if (Thunk.Return.VBaseOffsetOffset) {
2225 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2226 Out << " vbase offset offset";
2227 }
2228
2229 if (!Thunk.This.isEmpty())
2230 Out << "\n ";
2231 }
2232
Anders Carlsson18c582d2010-03-18 02:44:19 +00002233 // If this function pointer has a 'this' pointer adjustment, dump it.
2234 if (!Thunk.This.isEmpty()) {
Anders Carlsson53a47bf2010-03-22 16:10:59 +00002235 Out << "this adjustment: ";
2236 Out << Thunk.This.NonVirtual << " non-virtual";
Anders Carlsson18c582d2010-03-18 02:44:19 +00002237
2238 if (Thunk.This.VCallOffsetOffset) {
2239 Out << ", " << Thunk.This.VCallOffsetOffset;
Anders Carlsson53a47bf2010-03-22 16:10:59 +00002240 Out << " vcall offset offset";
Anders Carlsson18c582d2010-03-18 02:44:19 +00002241 }
2242 }
2243
2244 Out << '\n';
2245 }
Anders Carlsson290c6ed2010-03-22 20:06:40 +00002246
2247 Out << '\n';
2248
Anders Carlsson18c582d2010-03-18 02:44:19 +00002249 }
2250 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002251}
2252
2253}
2254
Anders Carlssoncadbc462010-11-24 23:04:03 +00002255static void
2256CollectPrimaryBases(const CXXRecordDecl *RD, ASTContext &Context,
2257 VTableBuilder::PrimaryBasesSetVectorTy &PrimaryBases) {
2258 while (RD) {
2259 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
2260 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2261 if (PrimaryBase)
2262 PrimaryBases.insert(PrimaryBase);
2263
2264 RD = PrimaryBase;
2265 }
2266}
2267
Anders Carlsson11e51402010-04-17 20:15:18 +00002268void CodeGenVTables::ComputeMethodVTableIndices(const CXXRecordDecl *RD) {
Anders Carlssonf942ee02009-11-27 20:47:55 +00002269
2270 // Itanium C++ ABI 2.5.2:
Anders Carlsson259688c2010-02-02 03:37:46 +00002271 // The order of the virtual function pointers in a virtual table is the
2272 // order of declaration of the corresponding member functions in the class.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002273 //
Anders Carlsson259688c2010-02-02 03:37:46 +00002274 // There is an entry for any virtual function declared in a class,
2275 // whether it is a new function or overrides a base class function,
2276 // unless it overrides a function from the primary base, and conversion
2277 // between their return types does not require an adjustment.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002278
2279 int64_t CurrentIndex = 0;
2280
2281 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2282 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2283
2284 if (PrimaryBase) {
Anders Carlssonc920fa22009-11-30 19:43:26 +00002285 assert(PrimaryBase->isDefinition() &&
2286 "Should have the definition decl of the primary base!");
Anders Carlssonf942ee02009-11-27 20:47:55 +00002287
2288 // Since the record decl shares its vtable pointer with the primary base
2289 // we need to start counting at the end of the primary base's vtable.
2290 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
2291 }
Eli Friedman21517252009-12-15 03:31:17 +00002292
2293 // Collect all the primary bases, so we can check whether methods override
2294 // a method from the base.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002295 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlssoncadbc462010-11-24 23:04:03 +00002296 CollectPrimaryBases(RD, CGM.getContext(), PrimaryBases);
Eli Friedman21517252009-12-15 03:31:17 +00002297
Anders Carlssonf942ee02009-11-27 20:47:55 +00002298 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
2299
2300 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2301 e = RD->method_end(); i != e; ++i) {
2302 const CXXMethodDecl *MD = *i;
2303
2304 // We only want virtual methods.
2305 if (!MD->isVirtual())
2306 continue;
2307
Anders Carlssonf942ee02009-11-27 20:47:55 +00002308 // Check if this method overrides a method in the primary base.
Anders Carlsson65b49782010-02-12 05:25:12 +00002309 if (const CXXMethodDecl *OverriddenMD =
Anders Carlsson88cf34f2010-04-10 20:39:29 +00002310 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlsson65b49782010-02-12 05:25:12 +00002311 // Check if converting from the return type of the method to the
2312 // return type of the overridden method requires conversion.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00002313 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2314 OverriddenMD).isEmpty()) {
Anders Carlsson65b49782010-02-12 05:25:12 +00002315 // This index is shared between the index in the vtable of the primary
2316 // base class.
2317 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2318 const CXXDestructorDecl *OverriddenDD =
2319 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00002320
Anders Carlsson65b49782010-02-12 05:25:12 +00002321 // Add both the complete and deleting entries.
Anders Carlsson11e51402010-04-17 20:15:18 +00002322 MethodVTableIndices[GlobalDecl(DD, Dtor_Complete)] =
2323 getMethodVTableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
2324 MethodVTableIndices[GlobalDecl(DD, Dtor_Deleting)] =
2325 getMethodVTableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
Anders Carlsson65b49782010-02-12 05:25:12 +00002326 } else {
Anders Carlsson11e51402010-04-17 20:15:18 +00002327 MethodVTableIndices[MD] = getMethodVTableIndex(OverriddenMD);
Anders Carlsson65b49782010-02-12 05:25:12 +00002328 }
2329
2330 // We don't need to add an entry for this method.
Anders Carlsson07604812010-02-12 18:14:46 +00002331 continue;
Anders Carlssonf942ee02009-11-27 20:47:55 +00002332 }
2333 }
2334
Anders Carlssonf942ee02009-11-27 20:47:55 +00002335 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2336 if (MD->isImplicit()) {
2337 assert(!ImplicitVirtualDtor &&
2338 "Did already see an implicit virtual dtor!");
2339 ImplicitVirtualDtor = DD;
2340 continue;
2341 }
Tilmann Schellere60baf72011-03-02 20:40:50 +00002342
Anders Carlssonf942ee02009-11-27 20:47:55 +00002343 // Add the complete dtor.
Anders Carlsson11e51402010-04-17 20:15:18 +00002344 MethodVTableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
Anders Carlssonf942ee02009-11-27 20:47:55 +00002345
2346 // Add the deleting dtor.
Anders Carlsson11e51402010-04-17 20:15:18 +00002347 MethodVTableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
Anders Carlssonf942ee02009-11-27 20:47:55 +00002348 } else {
2349 // Add the entry.
Tilmann Schellere60baf72011-03-02 20:40:50 +00002350 MethodVTableIndices[MD] = CurrentIndex++;
Anders Carlssonf942ee02009-11-27 20:47:55 +00002351 }
2352 }
2353
2354 if (ImplicitVirtualDtor) {
2355 // Itanium C++ ABI 2.5.2:
Anders Carlssondc2dba32010-02-16 04:49:44 +00002356 // If a class has an implicitly-defined virtual destructor,
2357 // its entries come after the declared virtual function pointers.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002358
2359 // Add the complete dtor.
Anders Carlsson11e51402010-04-17 20:15:18 +00002360 MethodVTableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
Anders Carlssonf942ee02009-11-27 20:47:55 +00002361 CurrentIndex++;
2362
2363 // Add the deleting dtor.
Anders Carlsson11e51402010-04-17 20:15:18 +00002364 MethodVTableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
Anders Carlssonf942ee02009-11-27 20:47:55 +00002365 CurrentIndex++;
2366 }
2367
2368 NumVirtualFunctionPointers[RD] = CurrentIndex;
2369}
2370
Argyrios Kyrtzidis0c34b132010-10-11 03:25:57 +00002371bool CodeGenVTables::ShouldEmitVTableInThisTU(const CXXRecordDecl *RD) {
2372 assert(RD->isDynamicClass() && "Non dynamic classes have no VTable.");
2373
2374 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
2375 if (TSK == TSK_ExplicitInstantiationDeclaration)
2376 return false;
2377
2378 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
2379 if (!KeyFunction)
2380 return true;
2381
2382 // Itanium C++ ABI, 5.2.6 Instantiated Templates:
2383 // An instantiation of a class template requires:
2384 // - In the object where instantiated, the virtual table...
2385 if (TSK == TSK_ImplicitInstantiation ||
2386 TSK == TSK_ExplicitInstantiationDefinition)
2387 return true;
2388
Anders Carlssona03f3a82011-01-30 20:45:54 +00002389 // If we're building with optimization, we always emit VTables since that
2390 // allows for virtual function calls to be devirtualized.
2391 // (We don't want to do this in -fapple-kext mode however).
2392 if (CGM.getCodeGenOpts().OptimizationLevel && !CGM.getLangOptions().AppleKext)
2393 return true;
2394
Argyrios Kyrtzidis0c34b132010-10-11 03:25:57 +00002395 return KeyFunction->hasBody();
2396}
2397
Anders Carlssona864caf2010-03-23 04:11:45 +00002398uint64_t CodeGenVTables::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
Anders Carlssonf942ee02009-11-27 20:47:55 +00002399 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2400 NumVirtualFunctionPointers.find(RD);
2401 if (I != NumVirtualFunctionPointers.end())
2402 return I->second;
2403
Anders Carlsson11e51402010-04-17 20:15:18 +00002404 ComputeMethodVTableIndices(RD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00002405
2406 I = NumVirtualFunctionPointers.find(RD);
2407 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
2408 return I->second;
2409}
2410
Anders Carlsson11e51402010-04-17 20:15:18 +00002411uint64_t CodeGenVTables::getMethodVTableIndex(GlobalDecl GD) {
2412 MethodVTableIndicesTy::iterator I = MethodVTableIndices.find(GD);
2413 if (I != MethodVTableIndices.end())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002414 return I->second;
2415
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002416 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssonf942ee02009-11-27 20:47:55 +00002417
Anders Carlsson11e51402010-04-17 20:15:18 +00002418 ComputeMethodVTableIndices(RD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00002419
Anders Carlsson11e51402010-04-17 20:15:18 +00002420 I = MethodVTableIndices.find(GD);
2421 assert(I != MethodVTableIndices.end() && "Did not find index!");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002422 return I->second;
2423}
2424
Anders Carlssona864caf2010-03-23 04:11:45 +00002425int64_t CodeGenVTables::getVirtualBaseOffsetOffset(const CXXRecordDecl *RD,
2426 const CXXRecordDecl *VBase) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002427 ClassPairTy ClassPair(RD, VBase);
2428
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00002429 VirtualBaseClassOffsetOffsetsMapTy::iterator I =
2430 VirtualBaseClassOffsetOffsets.find(ClassPair);
2431 if (I != VirtualBaseClassOffsetOffsets.end())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002432 return I->second;
2433
Anders Carlssondd819c92010-03-11 16:06:20 +00002434 VCallAndVBaseOffsetBuilder Builder(RD, RD, /*FinalOverriders=*/0,
Ken Dyck16ffcac2011-03-24 01:21:01 +00002435 BaseSubobject(RD, CharUnits::Zero()),
Anders Carlssondd819c92010-03-11 16:06:20 +00002436 /*BaseIsVirtual=*/false,
Ken Dyck1a93b3b2011-03-31 00:48:04 +00002437 /*OffsetInLayoutClass=*/CharUnits::Zero());
Anders Carlssondd819c92010-03-11 16:06:20 +00002438
2439 for (VCallAndVBaseOffsetBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
2440 Builder.getVBaseOffsetOffsets().begin(),
2441 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002442 // Insert all types.
2443 ClassPairTy ClassPair(RD, I->first);
2444
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00002445 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002446 }
2447
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00002448 I = VirtualBaseClassOffsetOffsets.find(ClassPair);
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00002449 assert(I != VirtualBaseClassOffsetOffsets.end() && "Did not find index!");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002450
2451 return I->second;
2452}
2453
Anders Carlssonf6f24c62010-03-29 02:08:26 +00002454uint64_t
2455CodeGenVTables::getAddressPoint(BaseSubobject Base, const CXXRecordDecl *RD) {
Anders Carlssonae9e9a62010-04-08 16:18:36 +00002456 assert(AddressPoints.count(std::make_pair(RD, Base)) &&
2457 "Did not find address point!");
2458
Anders Carlssona627ac7e2010-03-29 03:38:52 +00002459 uint64_t AddressPoint = AddressPoints.lookup(std::make_pair(RD, Base));
Anders Carlssonf6f24c62010-03-29 02:08:26 +00002460 assert(AddressPoint && "Address point must not be zero!");
Anders Carlssona627ac7e2010-03-29 03:38:52 +00002461
Anders Carlssonf6f24c62010-03-29 02:08:26 +00002462 return AddressPoint;
2463}
2464
Anders Carlssoncd836f02010-03-23 17:17:29 +00002465llvm::Constant *CodeGenModule::GetAddrOfThunk(GlobalDecl GD,
Anders Carlssonfe8a9932011-02-06 17:15:43 +00002466 const ThunkInfo &Thunk) {
Anders Carlssoncd836f02010-03-23 17:17:29 +00002467 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2468
2469 // Compute the mangled name.
2470 llvm::SmallString<256> Name;
Rafael Espindola3968cd02011-02-11 02:52:17 +00002471 llvm::raw_svector_ostream Out(Name);
Anders Carlssoncd836f02010-03-23 17:17:29 +00002472 if (const CXXDestructorDecl* DD = dyn_cast<CXXDestructorDecl>(MD))
John McCall5d865c322010-08-31 07:33:07 +00002473 getCXXABI().getMangleContext().mangleCXXDtorThunk(DD, GD.getDtorType(),
Rafael Espindola3968cd02011-02-11 02:52:17 +00002474 Thunk.This, Out);
Anders Carlssoncd836f02010-03-23 17:17:29 +00002475 else
Rafael Espindola3968cd02011-02-11 02:52:17 +00002476 getCXXABI().getMangleContext().mangleThunk(MD, Thunk, Out);
2477 Out.flush();
2478
John McCall5d865c322010-08-31 07:33:07 +00002479 const llvm::Type *Ty = getTypes().GetFunctionTypeForVTable(GD);
Anders Carlssonfe8a9932011-02-06 17:15:43 +00002480 return GetOrCreateLLVMFunction(Name, Ty, GD, /*ForVTable=*/true);
Anders Carlssoncd836f02010-03-23 17:17:29 +00002481}
2482
Anders Carlssonbad991d2010-03-24 00:39:18 +00002483static llvm::Value *PerformTypeAdjustment(CodeGenFunction &CGF,
2484 llvm::Value *Ptr,
2485 int64_t NonVirtualAdjustment,
2486 int64_t VirtualAdjustment) {
2487 if (!NonVirtualAdjustment && !VirtualAdjustment)
2488 return Ptr;
2489
2490 const llvm::Type *Int8PtrTy =
2491 llvm::Type::getInt8PtrTy(CGF.getLLVMContext());
2492
2493 llvm::Value *V = CGF.Builder.CreateBitCast(Ptr, Int8PtrTy);
2494
2495 if (NonVirtualAdjustment) {
2496 // Do the non-virtual adjustment.
2497 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
2498 }
2499
2500 if (VirtualAdjustment) {
2501 const llvm::Type *PtrDiffTy =
2502 CGF.ConvertType(CGF.getContext().getPointerDiffType());
2503
2504 // Do the virtual adjustment.
2505 llvm::Value *VTablePtrPtr =
2506 CGF.Builder.CreateBitCast(V, Int8PtrTy->getPointerTo());
2507
2508 llvm::Value *VTablePtr = CGF.Builder.CreateLoad(VTablePtrPtr);
2509
2510 llvm::Value *OffsetPtr =
2511 CGF.Builder.CreateConstInBoundsGEP1_64(VTablePtr, VirtualAdjustment);
2512
2513 OffsetPtr = CGF.Builder.CreateBitCast(OffsetPtr, PtrDiffTy->getPointerTo());
2514
2515 // Load the adjustment offset from the vtable.
2516 llvm::Value *Offset = CGF.Builder.CreateLoad(OffsetPtr);
2517
2518 // Adjust our pointer.
2519 V = CGF.Builder.CreateInBoundsGEP(V, Offset);
2520 }
2521
2522 // Cast back to the original type.
2523 return CGF.Builder.CreateBitCast(V, Ptr->getType());
2524}
2525
John McCallc8bd9c22010-08-04 23:46:35 +00002526static void setThunkVisibility(CodeGenModule &CGM, const CXXMethodDecl *MD,
2527 const ThunkInfo &Thunk, llvm::Function *Fn) {
Anders Carlssonc6a47892011-01-29 19:39:23 +00002528 CGM.setGlobalVisibility(Fn, MD);
John McCallc8bd9c22010-08-04 23:46:35 +00002529
John McCallb3732bb2010-08-12 23:36:15 +00002530 if (!CGM.getCodeGenOpts().HiddenWeakVTables)
2531 return;
2532
John McCallc8bd9c22010-08-04 23:46:35 +00002533 // If the thunk has weak/linkonce linkage, but the function must be
2534 // emitted in every translation unit that references it, then we can
2535 // emit its thunks with hidden visibility, since its thunks must be
2536 // emitted when the function is.
2537
John McCall5513fce92010-08-05 20:39:18 +00002538 // This follows CodeGenModule::setTypeVisibility; see the comments
2539 // there for explanation.
John McCallc8bd9c22010-08-04 23:46:35 +00002540
2541 if ((Fn->getLinkage() != llvm::GlobalVariable::LinkOnceODRLinkage &&
2542 Fn->getLinkage() != llvm::GlobalVariable::WeakODRLinkage) ||
2543 Fn->getVisibility() != llvm::GlobalVariable::DefaultVisibility)
2544 return;
2545
Douglas Gregor1baf38f2011-03-26 12:10:19 +00002546 if (MD->getExplicitVisibility())
John McCallc8bd9c22010-08-04 23:46:35 +00002547 return;
2548
2549 switch (MD->getTemplateSpecializationKind()) {
John McCallc8bd9c22010-08-04 23:46:35 +00002550 case TSK_ExplicitInstantiationDefinition:
2551 case TSK_ExplicitInstantiationDeclaration:
2552 return;
2553
John McCallc8bd9c22010-08-04 23:46:35 +00002554 case TSK_Undeclared:
2555 break;
2556
John McCall5513fce92010-08-05 20:39:18 +00002557 case TSK_ExplicitSpecialization:
John McCallc8bd9c22010-08-04 23:46:35 +00002558 case TSK_ImplicitInstantiation:
John McCallb3732bb2010-08-12 23:36:15 +00002559 if (!CGM.getCodeGenOpts().HiddenWeakTemplateVTables)
John McCall5513fce92010-08-05 20:39:18 +00002560 return;
John McCallc8bd9c22010-08-04 23:46:35 +00002561 break;
2562 }
2563
2564 // If there's an explicit definition, and that definition is
2565 // out-of-line, then we can't assume that all users will have a
2566 // definition to emit.
2567 const FunctionDecl *Def = 0;
2568 if (MD->hasBody(Def) && Def->isOutOfLine())
2569 return;
2570
2571 Fn->setVisibility(llvm::GlobalValue::HiddenVisibility);
2572}
2573
John McCall5fe00962011-03-09 07:12:35 +00002574#ifndef NDEBUG
2575static bool similar(const ABIArgInfo &infoL, CanQualType typeL,
2576 const ABIArgInfo &infoR, CanQualType typeR) {
2577 return (infoL.getKind() == infoR.getKind() &&
2578 (typeL == typeR ||
2579 (isa<PointerType>(typeL) && isa<PointerType>(typeR)) ||
2580 (isa<ReferenceType>(typeL) && isa<ReferenceType>(typeR))));
2581}
2582#endif
2583
John McCalla738c252011-03-09 04:27:21 +00002584void CodeGenFunction::GenerateThunk(llvm::Function *Fn,
2585 const CGFunctionInfo &FnInfo,
2586 GlobalDecl GD, const ThunkInfo &Thunk) {
Anders Carlssonbad991d2010-03-24 00:39:18 +00002587 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2588 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
2589 QualType ResultType = FPT->getResultType();
2590 QualType ThisType = MD->getThisType(getContext());
2591
2592 FunctionArgList FunctionArgs;
2593
2594 // FIXME: It would be nice if more of this code could be shared with
2595 // CodeGenFunction::GenerateCode.
2596
2597 // Create the implicit 'this' parameter declaration.
John McCall5d865c322010-08-31 07:33:07 +00002598 CurGD = GD;
2599 CGM.getCXXABI().BuildInstanceFunctionParams(*this, ResultType, FunctionArgs);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002600
2601 // Add the rest of the parameters.
2602 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2603 E = MD->param_end(); I != E; ++I) {
2604 ParmVarDecl *Param = *I;
2605
John McCalla738c252011-03-09 04:27:21 +00002606 FunctionArgs.push_back(Param);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002607 }
Tilmann Scheller99cc30c2011-03-02 21:36:49 +00002608
John McCalla738c252011-03-09 04:27:21 +00002609 StartFunction(GlobalDecl(), ResultType, Fn, FnInfo, FunctionArgs,
2610 SourceLocation());
Anders Carlssonbad991d2010-03-24 00:39:18 +00002611
John McCall5d865c322010-08-31 07:33:07 +00002612 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
2613
Anders Carlssonbad991d2010-03-24 00:39:18 +00002614 // Adjust the 'this' pointer if necessary.
2615 llvm::Value *AdjustedThisPtr =
2616 PerformTypeAdjustment(*this, LoadCXXThis(),
2617 Thunk.This.NonVirtual,
2618 Thunk.This.VCallOffsetOffset);
2619
2620 CallArgList CallArgs;
2621
2622 // Add our adjusted 'this' pointer.
2623 CallArgs.push_back(std::make_pair(RValue::get(AdjustedThisPtr), ThisType));
2624
2625 // Add the rest of the parameters.
2626 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2627 E = MD->param_end(); I != E; ++I) {
John McCall32ea9692011-03-11 20:59:21 +00002628 ParmVarDecl *param = *I;
2629 EmitDelegateCallArg(CallArgs, param);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002630 }
2631
2632 // Get our callee.
2633 const llvm::Type *Ty =
John McCall5d865c322010-08-31 07:33:07 +00002634 CGM.getTypes().GetFunctionType(CGM.getTypes().getFunctionInfo(GD),
Anders Carlssonbad991d2010-03-24 00:39:18 +00002635 FPT->isVariadic());
Anders Carlssonfe8a9932011-02-06 17:15:43 +00002636 llvm::Value *Callee = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002637
John McCalla738c252011-03-09 04:27:21 +00002638#ifndef NDEBUG
2639 const CGFunctionInfo &CallFnInfo =
2640 CGM.getTypes().getFunctionInfo(ResultType, CallArgs, FPT->getExtInfo());
John McCall5fe00962011-03-09 07:12:35 +00002641 assert(CallFnInfo.getRegParm() == FnInfo.getRegParm() &&
2642 CallFnInfo.isNoReturn() == FnInfo.isNoReturn() &&
2643 CallFnInfo.getCallingConvention() == FnInfo.getCallingConvention());
2644 assert(similar(CallFnInfo.getReturnInfo(), CallFnInfo.getReturnType(),
2645 FnInfo.getReturnInfo(), FnInfo.getReturnType()));
2646 assert(CallFnInfo.arg_size() == FnInfo.arg_size());
2647 for (unsigned i = 0, e = FnInfo.arg_size(); i != e; ++i)
2648 assert(similar(CallFnInfo.arg_begin()[i].info,
2649 CallFnInfo.arg_begin()[i].type,
2650 FnInfo.arg_begin()[i].info, FnInfo.arg_begin()[i].type));
John McCalla738c252011-03-09 04:27:21 +00002651#endif
Anders Carlssonbad991d2010-03-24 00:39:18 +00002652
Douglas Gregoraa2ac802010-05-20 05:54:35 +00002653 // Determine whether we have a return value slot to use.
2654 ReturnValueSlot Slot;
2655 if (!ResultType->isVoidType() &&
2656 FnInfo.getReturnInfo().getKind() == ABIArgInfo::Indirect &&
2657 hasAggregateLLVMType(CurFnInfo->getReturnType()))
2658 Slot = ReturnValueSlot(ReturnValue, ResultType.isVolatileQualified());
2659
Anders Carlssonbad991d2010-03-24 00:39:18 +00002660 // Now emit our call.
Douglas Gregoraa2ac802010-05-20 05:54:35 +00002661 RValue RV = EmitCall(FnInfo, Callee, Slot, CallArgs, MD);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002662
2663 if (!Thunk.Return.isEmpty()) {
2664 // Emit the return adjustment.
2665 bool NullCheckValue = !ResultType->isReferenceType();
2666
2667 llvm::BasicBlock *AdjustNull = 0;
2668 llvm::BasicBlock *AdjustNotNull = 0;
2669 llvm::BasicBlock *AdjustEnd = 0;
2670
2671 llvm::Value *ReturnValue = RV.getScalarVal();
2672
2673 if (NullCheckValue) {
2674 AdjustNull = createBasicBlock("adjust.null");
2675 AdjustNotNull = createBasicBlock("adjust.notnull");
2676 AdjustEnd = createBasicBlock("adjust.end");
2677
2678 llvm::Value *IsNull = Builder.CreateIsNull(ReturnValue);
2679 Builder.CreateCondBr(IsNull, AdjustNull, AdjustNotNull);
2680 EmitBlock(AdjustNotNull);
2681 }
2682
2683 ReturnValue = PerformTypeAdjustment(*this, ReturnValue,
2684 Thunk.Return.NonVirtual,
2685 Thunk.Return.VBaseOffsetOffset);
2686
2687 if (NullCheckValue) {
2688 Builder.CreateBr(AdjustEnd);
2689 EmitBlock(AdjustNull);
2690 Builder.CreateBr(AdjustEnd);
2691 EmitBlock(AdjustEnd);
2692
Jay Foad20c0f022011-03-30 11:28:58 +00002693 llvm::PHINode *PHI = Builder.CreatePHI(ReturnValue->getType(), 2);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002694 PHI->addIncoming(ReturnValue, AdjustNotNull);
2695 PHI->addIncoming(llvm::Constant::getNullValue(ReturnValue->getType()),
2696 AdjustNull);
2697 ReturnValue = PHI;
2698 }
2699
2700 RV = RValue::get(ReturnValue);
2701 }
2702
Douglas Gregoraa2ac802010-05-20 05:54:35 +00002703 if (!ResultType->isVoidType() && Slot.isNull())
John McCallad7c5c12011-02-08 08:22:06 +00002704 CGM.getCXXABI().EmitReturnFromThunk(*this, RV, ResultType);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002705
2706 FinishFunction();
2707
Anders Carlssonbad991d2010-03-24 00:39:18 +00002708 // Set the right linkage.
John McCall7cb02202010-05-25 04:30:21 +00002709 CGM.setFunctionLinkage(MD, Fn);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002710
2711 // Set the right visibility.
John McCallc8bd9c22010-08-04 23:46:35 +00002712 setThunkVisibility(CGM, MD, Thunk, Fn);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002713}
2714
Anders Carlsson8b021832011-02-06 18:31:40 +00002715void CodeGenVTables::EmitThunk(GlobalDecl GD, const ThunkInfo &Thunk,
2716 bool UseAvailableExternallyLinkage)
Anders Carlsson5c5abad2010-03-23 16:36:50 +00002717{
John McCalla738c252011-03-09 04:27:21 +00002718 const CGFunctionInfo &FnInfo = CGM.getTypes().getFunctionInfo(GD);
2719
2720 // FIXME: re-use FnInfo in this computation.
Anders Carlssonfe8a9932011-02-06 17:15:43 +00002721 llvm::Constant *Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlssoncd836f02010-03-23 17:17:29 +00002722
Anders Carlsson55e89f82010-03-23 18:18:41 +00002723 // Strip off a bitcast if we got one back.
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00002724 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Entry)) {
Anders Carlsson55e89f82010-03-23 18:18:41 +00002725 assert(CE->getOpcode() == llvm::Instruction::BitCast);
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00002726 Entry = CE->getOperand(0);
Anders Carlsson55e89f82010-03-23 18:18:41 +00002727 }
2728
Anders Carlsson55e89f82010-03-23 18:18:41 +00002729 // There's already a declaration with the same name, check if it has the same
2730 // type or if we need to replace it.
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00002731 if (cast<llvm::GlobalValue>(Entry)->getType()->getElementType() !=
John McCall5d865c322010-08-31 07:33:07 +00002732 CGM.getTypes().GetFunctionTypeForVTable(GD)) {
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00002733 llvm::GlobalValue *OldThunkFn = cast<llvm::GlobalValue>(Entry);
Anders Carlsson55e89f82010-03-23 18:18:41 +00002734
2735 // If the types mismatch then we have to rewrite the definition.
2736 assert(OldThunkFn->isDeclaration() &&
2737 "Shouldn't replace non-declaration");
2738
2739 // Remove the name from the old thunk function and get a new thunk.
2740 OldThunkFn->setName(llvm::StringRef());
Anders Carlssonfe8a9932011-02-06 17:15:43 +00002741 Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson55e89f82010-03-23 18:18:41 +00002742
2743 // If needed, replace the old thunk with a bitcast.
2744 if (!OldThunkFn->use_empty()) {
2745 llvm::Constant *NewPtrForOldDecl =
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00002746 llvm::ConstantExpr::getBitCast(Entry, OldThunkFn->getType());
Anders Carlsson55e89f82010-03-23 18:18:41 +00002747 OldThunkFn->replaceAllUsesWith(NewPtrForOldDecl);
2748 }
2749
2750 // Remove the old thunk.
2751 OldThunkFn->eraseFromParent();
2752 }
Anders Carlssonbad991d2010-03-24 00:39:18 +00002753
Anders Carlssonbad991d2010-03-24 00:39:18 +00002754 llvm::Function *ThunkFn = cast<llvm::Function>(Entry);
Anders Carlsson8b021832011-02-06 18:31:40 +00002755
2756 if (!ThunkFn->isDeclaration()) {
2757 if (UseAvailableExternallyLinkage) {
2758 // There is already a thunk emitted for this function, do nothing.
2759 return;
2760 }
2761
Anders Carlssone866d442011-02-06 20:09:44 +00002762 // If a function has a body, it should have available_externally linkage.
2763 assert(ThunkFn->hasAvailableExternallyLinkage() &&
2764 "Function should have available_externally linkage!");
2765
2766 // Change the linkage.
2767 CGM.setFunctionLinkage(cast<CXXMethodDecl>(GD.getDecl()), ThunkFn);
2768 return;
Anders Carlsson8b021832011-02-06 18:31:40 +00002769 }
2770
2771 // Actually generate the thunk body.
John McCalla738c252011-03-09 04:27:21 +00002772 CodeGenFunction(CGM).GenerateThunk(ThunkFn, FnInfo, GD, Thunk);
Anders Carlsson8b021832011-02-06 18:31:40 +00002773
2774 if (UseAvailableExternallyLinkage)
2775 ThunkFn->setLinkage(llvm::GlobalValue::AvailableExternallyLinkage);
2776}
2777
2778void CodeGenVTables::MaybeEmitThunkAvailableExternally(GlobalDecl GD,
2779 const ThunkInfo &Thunk) {
2780 // We only want to do this when building with optimizations.
2781 if (!CGM.getCodeGenOpts().OptimizationLevel)
2782 return;
2783
2784 // We can't emit thunks for member functions with incomplete types.
2785 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2786 if (CGM.getTypes().VerifyFuncTypeComplete(MD->getType().getTypePtr()))
2787 return;
2788
2789 EmitThunk(GD, Thunk, /*UseAvailableExternallyLinkage=*/true);
Anders Carlsson5c5abad2010-03-23 16:36:50 +00002790}
2791
Anders Carlsson917229c2010-03-23 04:59:02 +00002792void CodeGenVTables::EmitThunks(GlobalDecl GD)
2793{
Anders Carlsson5c5abad2010-03-23 16:36:50 +00002794 const CXXMethodDecl *MD =
2795 cast<CXXMethodDecl>(GD.getDecl())->getCanonicalDecl();
2796
2797 // We don't need to generate thunks for the base destructor.
2798 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
2799 return;
2800
2801 const CXXRecordDecl *RD = MD->getParent();
2802
Anders Carlssone90954d2010-03-24 16:42:11 +00002803 // Compute VTable related info for this class.
John McCall6a7f9f52010-06-02 21:22:02 +00002804 ComputeVTableRelatedInformation(RD, false);
Anders Carlssone90954d2010-03-24 16:42:11 +00002805
Anders Carlsson5c5abad2010-03-23 16:36:50 +00002806 ThunksMapTy::const_iterator I = Thunks.find(MD);
2807 if (I == Thunks.end()) {
Anders Carlssone90954d2010-03-24 16:42:11 +00002808 // We did not find a thunk for this method.
2809 return;
Anders Carlsson5c5abad2010-03-23 16:36:50 +00002810 }
Anders Carlssone90954d2010-03-24 16:42:11 +00002811
Anders Carlsson5c5abad2010-03-23 16:36:50 +00002812 const ThunkInfoVectorTy &ThunkInfoVector = I->second;
2813 for (unsigned I = 0, E = ThunkInfoVector.size(); I != E; ++I)
Anders Carlsson8b021832011-02-06 18:31:40 +00002814 EmitThunk(GD, ThunkInfoVector[I], /*UseAvailableExternallyLinkage=*/false);
Anders Carlsson917229c2010-03-23 04:59:02 +00002815}
2816
John McCall6a7f9f52010-06-02 21:22:02 +00002817void CodeGenVTables::ComputeVTableRelatedInformation(const CXXRecordDecl *RD,
2818 bool RequireVTable) {
2819 VTableLayoutData &Entry = VTableLayoutMap[RD];
Douglas Gregor88d292c2010-05-13 16:44:06 +00002820
2821 // We may need to generate a definition for this vtable.
John McCall6a7f9f52010-06-02 21:22:02 +00002822 if (RequireVTable && !Entry.getInt()) {
Argyrios Kyrtzidis0c34b132010-10-11 03:25:57 +00002823 if (ShouldEmitVTableInThisTU(RD))
John McCall6a7f9f52010-06-02 21:22:02 +00002824 CGM.DeferredVTables.push_back(RD);
2825
2826 Entry.setInt(true);
2827 }
2828
2829 // Check if we've computed this information before.
2830 if (Entry.getPointer())
2831 return;
Douglas Gregor88d292c2010-05-13 16:44:06 +00002832
Ken Dyck9a7e5322011-03-27 20:20:28 +00002833 VTableBuilder Builder(*this, RD, CharUnits::Zero(),
2834 /*MostDerivedClassIsVirtual=*/0, RD);
Anders Carlssone90954d2010-03-24 16:42:11 +00002835
2836 // Add the VTable layout.
2837 uint64_t NumVTableComponents = Builder.getNumVTableComponents();
Fariborz Jahanian9f9438b2011-01-28 23:42:29 +00002838 // -fapple-kext adds an extra entry at end of vtbl.
2839 bool IsAppleKext = CGM.getContext().getLangOptions().AppleKext;
2840 if (IsAppleKext)
2841 NumVTableComponents += 1;
2842
John McCall6a7f9f52010-06-02 21:22:02 +00002843 uint64_t *LayoutData = new uint64_t[NumVTableComponents + 1];
Fariborz Jahanian9f9438b2011-01-28 23:42:29 +00002844 if (IsAppleKext)
2845 LayoutData[NumVTableComponents] = 0;
John McCall6a7f9f52010-06-02 21:22:02 +00002846 Entry.setPointer(LayoutData);
Anders Carlssone90954d2010-03-24 16:42:11 +00002847
2848 // Store the number of components.
2849 LayoutData[0] = NumVTableComponents;
2850
2851 // Store the components.
2852 std::copy(Builder.vtable_components_data_begin(),
2853 Builder.vtable_components_data_end(),
2854 &LayoutData[1]);
2855
2856 // Add the known thunks.
2857 Thunks.insert(Builder.thunks_begin(), Builder.thunks_end());
2858
Anders Carlsson9a97e2e2010-03-29 01:38:05 +00002859 // Add the thunks needed in this vtable.
2860 assert(!VTableThunksMap.count(RD) &&
2861 "Thunks already exists for this vtable!");
2862
2863 VTableThunksTy &VTableThunks = VTableThunksMap[RD];
2864 VTableThunks.append(Builder.vtable_thunks_begin(),
2865 Builder.vtable_thunks_end());
2866
2867 // Sort them.
2868 std::sort(VTableThunks.begin(), VTableThunks.end());
2869
Anders Carlssond03325c2010-03-25 00:51:13 +00002870 // Add the address points.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002871 for (VTableBuilder::AddressPointsMapTy::const_iterator I =
Anders Carlssond03325c2010-03-25 00:51:13 +00002872 Builder.address_points_begin(), E = Builder.address_points_end();
2873 I != E; ++I) {
2874
2875 uint64_t &AddressPoint = AddressPoints[std::make_pair(RD, I->first)];
2876
2877 // Check if we already have the address points for this base.
2878 assert(!AddressPoint && "Address point already exists for this base!");
2879
2880 AddressPoint = I->second;
2881 }
2882
Anders Carlssone90954d2010-03-24 16:42:11 +00002883 // If we don't have the vbase information for this class, insert it.
2884 // getVirtualBaseOffsetOffset will compute it separately without computing
2885 // the rest of the vtable related information.
2886 if (!RD->getNumVBases())
2887 return;
2888
2889 const RecordType *VBaseRT =
2890 RD->vbases_begin()->getType()->getAs<RecordType>();
2891 const CXXRecordDecl *VBase = cast<CXXRecordDecl>(VBaseRT->getDecl());
2892
2893 if (VirtualBaseClassOffsetOffsets.count(std::make_pair(RD, VBase)))
2894 return;
2895
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002896 for (VTableBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
Anders Carlssone90954d2010-03-24 16:42:11 +00002897 Builder.getVBaseOffsetOffsets().begin(),
2898 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
2899 // Insert all types.
2900 ClassPairTy ClassPair(RD, I->first);
2901
2902 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
2903 }
2904}
2905
Anders Carlssona4147142010-03-25 15:26:28 +00002906llvm::Constant *
2907CodeGenVTables::CreateVTableInitializer(const CXXRecordDecl *RD,
2908 const uint64_t *Components,
2909 unsigned NumComponents,
2910 const VTableThunksTy &VTableThunks) {
2911 llvm::SmallVector<llvm::Constant *, 64> Inits;
2912
2913 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
2914
Anders Carlssona5736bd2010-03-25 16:49:53 +00002915 const llvm::Type *PtrDiffTy =
2916 CGM.getTypes().ConvertType(CGM.getContext().getPointerDiffType());
2917
2918 QualType ClassType = CGM.getContext().getTagDeclType(RD);
2919 llvm::Constant *RTTI = CGM.GetAddrOfRTTIDescriptor(ClassType);
2920
2921 unsigned NextVTableThunkIndex = 0;
2922
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002923 llvm::Constant* PureVirtualFn = 0;
2924
Anders Carlssona4147142010-03-25 15:26:28 +00002925 for (unsigned I = 0; I != NumComponents; ++I) {
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002926 VTableComponent Component =
2927 VTableComponent::getFromOpaqueInteger(Components[I]);
Anders Carlssona5736bd2010-03-25 16:49:53 +00002928
2929 llvm::Constant *Init = 0;
2930
2931 switch (Component.getKind()) {
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002932 case VTableComponent::CK_VCallOffset:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002933 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getVCallOffset());
2934 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2935 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002936 case VTableComponent::CK_VBaseOffset:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002937 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getVBaseOffset());
2938 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2939 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002940 case VTableComponent::CK_OffsetToTop:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002941 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getOffsetToTop());
2942 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2943 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002944 case VTableComponent::CK_RTTI:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002945 Init = llvm::ConstantExpr::getBitCast(RTTI, Int8PtrTy);
2946 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002947 case VTableComponent::CK_FunctionPointer:
2948 case VTableComponent::CK_CompleteDtorPointer:
2949 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlssona5736bd2010-03-25 16:49:53 +00002950 GlobalDecl GD;
2951
2952 // Get the right global decl.
2953 switch (Component.getKind()) {
2954 default:
2955 llvm_unreachable("Unexpected vtable component kind");
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002956 case VTableComponent::CK_FunctionPointer:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002957 GD = Component.getFunctionDecl();
2958 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002959 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002960 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Complete);
2961 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002962 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002963 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Deleting);
2964 break;
2965 }
2966
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002967 if (cast<CXXMethodDecl>(GD.getDecl())->isPure()) {
2968 // We have a pure virtual member function.
2969 if (!PureVirtualFn) {
2970 const llvm::FunctionType *Ty =
2971 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2972 /*isVarArg=*/false);
2973 PureVirtualFn =
2974 CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual");
2975 PureVirtualFn = llvm::ConstantExpr::getBitCast(PureVirtualFn,
2976 Int8PtrTy);
2977 }
Anders Carlssona5736bd2010-03-25 16:49:53 +00002978
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002979 Init = PureVirtualFn;
Anders Carlssona5736bd2010-03-25 16:49:53 +00002980 } else {
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002981 // Check if we should use a thunk.
2982 if (NextVTableThunkIndex < VTableThunks.size() &&
2983 VTableThunks[NextVTableThunkIndex].first == I) {
2984 const ThunkInfo &Thunk = VTableThunks[NextVTableThunkIndex].second;
Anders Carlssona5736bd2010-03-25 16:49:53 +00002985
Anders Carlssonfe8a9932011-02-06 17:15:43 +00002986 Init = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson8b021832011-02-06 18:31:40 +00002987 MaybeEmitThunkAvailableExternally(GD, Thunk);
2988
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002989 NextVTableThunkIndex++;
2990 } else {
John McCall5d865c322010-08-31 07:33:07 +00002991 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVTable(GD);
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002992
Anders Carlsson3c239482011-02-05 04:35:53 +00002993 Init = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002994 }
2995
2996 Init = llvm::ConstantExpr::getBitCast(Init, Int8PtrTy);
Anders Carlssona5736bd2010-03-25 16:49:53 +00002997 }
Anders Carlssona5736bd2010-03-25 16:49:53 +00002998 break;
2999 }
3000
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00003001 case VTableComponent::CK_UnusedFunctionPointer:
Anders Carlssona5736bd2010-03-25 16:49:53 +00003002 Init = llvm::ConstantExpr::getNullValue(Int8PtrTy);
3003 break;
3004 };
Anders Carlssona4147142010-03-25 15:26:28 +00003005
3006 Inits.push_back(Init);
3007 }
3008
3009 llvm::ArrayType *ArrayType = llvm::ArrayType::get(Int8PtrTy, NumComponents);
3010 return llvm::ConstantArray::get(ArrayType, Inits.data(), Inits.size());
3011}
3012
Anders Carlssona086edc2010-03-30 03:35:35 +00003013llvm::GlobalVariable *CodeGenVTables::GetAddrOfVTable(const CXXRecordDecl *RD) {
Anders Carlssonb35ea552010-03-24 03:57:14 +00003014 llvm::SmallString<256> OutName;
Rafael Espindola3968cd02011-02-11 02:52:17 +00003015 llvm::raw_svector_ostream Out(OutName);
3016 CGM.getCXXABI().getMangleContext().mangleCXXVTable(RD, Out);
3017 Out.flush();
Anders Carlssonb35ea552010-03-24 03:57:14 +00003018 llvm::StringRef Name = OutName.str();
Mike Stumpaa51ad62009-11-19 04:04:36 +00003019
John McCall6a7f9f52010-06-02 21:22:02 +00003020 ComputeVTableRelatedInformation(RD, true);
Anders Carlssone90954d2010-03-24 16:42:11 +00003021
Anders Carlssonb35ea552010-03-24 03:57:14 +00003022 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlssone90954d2010-03-24 16:42:11 +00003023 llvm::ArrayType *ArrayType =
3024 llvm::ArrayType::get(Int8PtrTy, getNumVTableComponents(RD));
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003025
Rafael Espindola5674c642011-01-11 21:10:26 +00003026 llvm::GlobalVariable *GV =
Anders Carlsson93be9a92011-01-29 18:25:07 +00003027 CGM.CreateOrReplaceCXXRuntimeVariable(Name, ArrayType,
3028 llvm::GlobalValue::ExternalLinkage);
Rafael Espindolafacb7d02011-01-15 08:23:14 +00003029 GV->setUnnamedAddr(true);
Rafael Espindola5674c642011-01-11 21:10:26 +00003030 return GV;
Mike Stumpd846d082009-11-10 07:44:33 +00003031}
Mike Stumpeac45592009-11-11 20:26:26 +00003032
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003033void
3034CodeGenVTables::EmitVTableDefinition(llvm::GlobalVariable *VTable,
3035 llvm::GlobalVariable::LinkageTypes Linkage,
3036 const CXXRecordDecl *RD) {
3037 // Dump the vtable layout if necessary.
Anders Carlsson11e51402010-04-17 20:15:18 +00003038 if (CGM.getLangOptions().DumpVTableLayouts) {
Ken Dyck9a7e5322011-03-27 20:20:28 +00003039 VTableBuilder Builder(*this, RD, CharUnits::Zero(),
3040 /*MostDerivedClassIsVirtual=*/0, RD);
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003041
3042 Builder.dumpLayout(llvm::errs());
3043 }
3044
3045 assert(VTableThunksMap.count(RD) &&
3046 "No thunk status for this record decl!");
3047
3048 const VTableThunksTy& Thunks = VTableThunksMap[RD];
3049
3050 // Create and set the initializer.
3051 llvm::Constant *Init =
3052 CreateVTableInitializer(RD, getVTableComponentsData(RD),
3053 getNumVTableComponents(RD), Thunks);
3054 VTable->setInitializer(Init);
Anders Carlssoncb6207f2010-03-29 05:40:50 +00003055
3056 // Set the correct linkage.
3057 VTable->setLinkage(Linkage);
Douglas Gregor4f6e8de2010-06-14 23:41:45 +00003058
3059 // Set the right visibility.
Anders Carlsson265aa7c2011-01-29 20:24:48 +00003060 CGM.setTypeVisibility(VTable, RD, CodeGenModule::TVK_ForVTable);
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003061}
3062
Anders Carlsson0534b022010-03-25 00:35:49 +00003063llvm::GlobalVariable *
3064CodeGenVTables::GenerateConstructionVTable(const CXXRecordDecl *RD,
Anders Carlssona208b392010-03-26 03:56:54 +00003065 const BaseSubobject &Base,
3066 bool BaseIsVirtual,
John McCall358d0562011-03-27 09:00:25 +00003067 llvm::GlobalVariable::LinkageTypes Linkage,
Anders Carlssona208b392010-03-26 03:56:54 +00003068 VTableAddressPointsMapTy& AddressPoints) {
Ken Dyck16ffcac2011-03-24 01:21:01 +00003069 VTableBuilder Builder(*this, Base.getBase(),
Ken Dyck9a7e5322011-03-27 20:20:28 +00003070 Base.getBaseOffset(),
Anders Carlssona4147142010-03-25 15:26:28 +00003071 /*MostDerivedClassIsVirtual=*/BaseIsVirtual, RD);
3072
Anders Carlssona5736bd2010-03-25 16:49:53 +00003073 // Dump the vtable layout if necessary.
Anders Carlsson11e51402010-04-17 20:15:18 +00003074 if (CGM.getLangOptions().DumpVTableLayouts)
Anders Carlssona5736bd2010-03-25 16:49:53 +00003075 Builder.dumpLayout(llvm::errs());
3076
3077 // Add the address points.
Anders Carlssona208b392010-03-26 03:56:54 +00003078 AddressPoints.insert(Builder.address_points_begin(),
3079 Builder.address_points_end());
Anders Carlssona4147142010-03-25 15:26:28 +00003080
3081 // Get the mangled construction vtable name.
3082 llvm::SmallString<256> OutName;
Rafael Espindola3968cd02011-02-11 02:52:17 +00003083 llvm::raw_svector_ostream Out(OutName);
John McCall5d865c322010-08-31 07:33:07 +00003084 CGM.getCXXABI().getMangleContext().
Ken Dyck16ffcac2011-03-24 01:21:01 +00003085 mangleCXXCtorVTable(RD, Base.getBaseOffset().getQuantity(), Base.getBase(),
3086 Out);
Rafael Espindola3968cd02011-02-11 02:52:17 +00003087 Out.flush();
Anders Carlssona4147142010-03-25 15:26:28 +00003088 llvm::StringRef Name = OutName.str();
3089
3090 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
3091 llvm::ArrayType *ArrayType =
3092 llvm::ArrayType::get(Int8PtrTy, Builder.getNumVTableComponents());
3093
3094 // Create the variable that will hold the construction vtable.
3095 llvm::GlobalVariable *VTable =
John McCall358d0562011-03-27 09:00:25 +00003096 CGM.CreateOrReplaceCXXRuntimeVariable(Name, ArrayType, Linkage);
3097 CGM.setTypeVisibility(VTable, RD, CodeGenModule::TVK_ForConstructionVTable);
3098
3099 // V-tables are always unnamed_addr.
3100 VTable->setUnnamedAddr(true);
Anders Carlssona4147142010-03-25 15:26:28 +00003101
3102 // Add the thunks.
3103 VTableThunksTy VTableThunks;
3104 VTableThunks.append(Builder.vtable_thunks_begin(),
3105 Builder.vtable_thunks_end());
3106
Anders Carlsson848d86e2010-03-29 01:28:05 +00003107 // Sort them.
3108 std::sort(VTableThunks.begin(), VTableThunks.end());
3109
Anders Carlssona4147142010-03-25 15:26:28 +00003110 // Create and set the initializer.
3111 llvm::Constant *Init =
3112 CreateVTableInitializer(Base.getBase(),
3113 Builder.vtable_components_data_begin(),
3114 Builder.getNumVTableComponents(), VTableThunks);
3115 VTable->setInitializer(Init);
3116
Anders Carlsson0534b022010-03-25 00:35:49 +00003117 return VTable;
3118}
3119
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003120void
3121CodeGenVTables::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
3122 const CXXRecordDecl *RD) {
Anders Carlsson11e51402010-04-17 20:15:18 +00003123 llvm::GlobalVariable *&VTable = VTables[RD];
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003124 if (VTable) {
Anders Carlsson11e51402010-04-17 20:15:18 +00003125 assert(VTable->getInitializer() && "VTable doesn't have a definition!");
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003126 return;
3127 }
3128
Anders Carlssona086edc2010-03-30 03:35:35 +00003129 VTable = GetAddrOfVTable(RD);
3130 EmitVTableDefinition(VTable, Linkage, RD);
3131
Anders Carlsson883fc722011-01-29 19:16:51 +00003132 if (RD->getNumVBases()) {
3133 llvm::GlobalVariable *VTT = GetAddrOfVTT(RD);
3134 EmitVTTDefinition(VTT, Linkage, RD);
3135 }
Douglas Gregoreadd3ca2010-04-08 15:52:03 +00003136
3137 // If this is the magic class __cxxabiv1::__fundamental_type_info,
3138 // we will emit the typeinfo for the fundamental types. This is the
3139 // same behaviour as GCC.
3140 const DeclContext *DC = RD->getDeclContext();
3141 if (RD->getIdentifier() &&
3142 RD->getIdentifier()->isStr("__fundamental_type_info") &&
3143 isa<NamespaceDecl>(DC) &&
3144 cast<NamespaceDecl>(DC)->getIdentifier() &&
3145 cast<NamespaceDecl>(DC)->getIdentifier()->isStr("__cxxabiv1") &&
3146 DC->getParent()->isTranslationUnit())
3147 CGM.EmitFundamentalRTTIDescriptors();
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003148}